libavformat/rtsp.h

   1 /*
   2  * RTSP definitions
   3  * Copyright (c) 2002 Fabrice Bellard
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21 #ifndef FFMPEG_RTSP_H
  22 #define FFMPEG_RTSP_H
  23
  24 #include <stdint.h>
  25 #include "avformat.h"
  26 #include "rtspcodes.h"
  27 #include "rtp.h"
  28 #include "network.h"
  29
  30 enum RTSPLowerTransport {
  31     RTSP_LOWER_TRANSPORT_UDP = 0,
  32     RTSP_LOWER_TRANSPORT_TCP = 1,
  33     RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2,
  34     /**
  35      * This is not part of public API and shouldn't be used outside of ffmpeg.
  36      */
  37     RTSP_LOWER_TRANSPORT_LAST
  38 };
  39
  40 enum RTSPTransport {
  41     RTSP_TRANSPORT_RTP,
  42     RTSP_TRANSPORT_RDT,
  43     RTSP_TRANSPORT_LAST
  44 };
  45
  46 #define RTSP_DEFAULT_PORT   554
  47 #define RTSP_MAX_TRANSPORTS 8
  48 #define RTSP_TCP_MAX_PACKET_SIZE 1472
  49 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
  50 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
  51 #define RTSP_RTP_PORT_MIN 5000
  52 #define RTSP_RTP_PORT_MAX 10000
  53
  54 typedef struct RTSPTransportField {
  55     int interleaved_min, interleaved_max;  /**< interleave ids, if TCP transport */
  56     int port_min, port_max; /**< RTP ports */
  57     int client_port_min, client_port_max; /**< RTP ports */
  58     int server_port_min, server_port_max; /**< RTP ports */
  59     int ttl; /**< ttl value */
  60     uint32_t destination; /**< destination IP address */
  61     enum RTSPTransport transport;
  62     enum RTSPLowerTransport lower_transport;
  63 } RTSPTransportField;
  64
  65 typedef struct RTSPHeader {
  66     int content_length;
  67     enum RTSPStatusCode status_code; /**< response code from server */
  68     int nb_transports;
  69     /** in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
  70     int64_t range_start, range_end;
  71     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
  72     int seq; /**< sequence number */
  73     char session_id[512];
  74     char real_challenge[64]; /**< the RealChallenge1 field from the server */
  75     char server[64];
  76 } RTSPHeader;
  77
  78 enum RTSPClientState {
  79     RTSP_STATE_IDLE,
  80     RTSP_STATE_PLAYING,
  81     RTSP_STATE_PAUSED,
  82 };
  83
  84 enum RTSPServerType {
  85     RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
  86     RTSP_SERVER_REAL, /**< Realmedia-style server */
  87     RTSP_SERVER_WMS,  /**< Windows Media server */
  88     RTSP_SERVER_LAST
  89 };
  90
  91 typedef struct RTSPState {
  92     URLContext *rtsp_hd; /* RTSP TCP connexion handle */
  93     int nb_rtsp_streams;
  94     struct RTSPStream **rtsp_streams;
  95
  96     enum RTSPClientState state;
  97     int64_t seek_timestamp;
  98
  99     /* XXX: currently we use unbuffered input */
 100     //    ByteIOContext rtsp_gb;
 101     int seq;        /* RTSP command sequence number */
 102     char session_id[512];
 103     enum RTSPTransport transport;
 104     enum RTSPLowerTransport lower_transport;
 105     enum RTSPServerType server_type;
 106     char last_reply[2048]; /* XXX: allocate ? */
 107     void *cur_tx;
 108     int need_subscription;
 109     enum AVDiscard real_setup_cache[MAX_STREAMS];
 110     char last_subscription[1024];
 111 } RTSPState;
 112
 113 typedef struct RTSPStream {
 114     URLContext *rtp_handle; /* RTP stream handle */
 115     void *tx_ctx; /* RTP/RDT parse context */
 116
 117     int stream_index; /* corresponding stream index, if any. -1 if none (MPEG2TS case) */
 118     int interleaved_min, interleaved_max;  /* interleave ids, if TCP transport */
 119     char control_url[1024]; /* url for this stream (from SDP) */
 120
 121     int sdp_port; /* port (from SDP content - not used in RTSP) */
 122     struct in_addr sdp_ip; /* IP address  (from SDP content - not used in RTSP) */
 123     int sdp_ttl;  /* IP TTL (from SDP content - not used in RTSP) */
 124     int sdp_payload_type; /* payload type - only used in SDP */
 125     RTPPayloadData rtp_payload_data; /* rtp payload parsing infos from SDP */
 126
 127     RTPDynamicProtocolHandler *dynamic_handler; ///< Only valid if it's a dynamic protocol. (This is the handler structure)
 128     PayloadContext *dynamic_protocol_context; ///< Only valid if it's a dynamic protocol. (This is any private data associated with the dynamic protocol)
 129 } RTSPStream;
 130
 131 int rtsp_init(void);
 132 void rtsp_parse_line(RTSPHeader *reply, const char *buf);
 133
 134 #if LIBAVFORMAT_VERSION_INT < (53 << 16)
 135 extern int rtsp_default_protocols;
 136 #endif
 137 extern int rtsp_rtp_port_min;
 138 extern int rtsp_rtp_port_max;
 139
 140 int rtsp_pause(AVFormatContext *s);
 141 int rtsp_resume(AVFormatContext *s);
 142
 143 #endif /* FFMPEG_RTSP_H */