rtsp.h 11.3 KB
Newer Older
1 2
/*
 * RTSP definitions
3
 * Copyright (c) 2002 Fabrice Bellard
4
 *
5 6 7
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * 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 14 15 16 17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 22
#ifndef FFMPEG_RTSP_H
#define FFMPEG_RTSP_H
23

24 25
#include <stdint.h>
#include "avformat.h"
26
#include "rtspcodes.h"
27
#include "rtpdec.h"
28
#include "network.h"
29

30 31 32
/**
 * Network layer over which RTP/etc packet data will be transported.
 */
33
enum RTSPLowerTransport {
34 35 36
    RTSP_LOWER_TRANSPORT_UDP = 0,           /**< UDP/unicast */
    RTSP_LOWER_TRANSPORT_TCP = 1,           /**< TCP; interleaved in RTSP */
    RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2, /**< UDP/multicast */
37
    RTSP_LOWER_TRANSPORT_NB
38 39
};

40 41 42 43 44
/**
 * Packet profile of the data that we will be receiving. Real servers
 * commonly send RDT (although they can sometimes send RTP as well),
 * whereas most others will send RTP.
 */
45
enum RTSPTransport {
46 47
    RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
    RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
48
    RTSP_TRANSPORT_NB
49 50
};

51 52
#define RTSP_DEFAULT_PORT   554
#define RTSP_MAX_TRANSPORTS 8
53
#define RTSP_TCP_MAX_PACKET_SIZE 1472
Romain Degez's avatar
Romain Degez committed
54 55 56 57
#define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
#define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
#define RTSP_RTP_PORT_MIN 5000
#define RTSP_RTP_PORT_MAX 10000
58

59 60 61 62 63 64 65
/**
 * This describes a single item in the "Transport:" line of one stream as
 * negotiated by the SETUP RTSP command. Multiple transports are comma-
 * separated ("Transport: x-read-rdt/tcp;interleaved=0-1,rtp/avp/udp;
 * client_port=1000-1001;server_port=1800-1801") and described in separate
 * RTSPTransportFields.
 */
66
typedef struct RTSPTransportField {
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
    /** interleave ids, if TCP transport; each TCP/RTSP data packet starts
     * with a '$', stream length and stream ID. If the stream ID is within
     * the range of this interleaved_min-max, then the packet belongs to
     * this stream. */
    int interleaved_min, interleaved_max;

    /** UDP multicast port range; the ports to which we should connect to
     * receive multicast UDP data. */
    int port_min, port_max;

    /** UDP client ports; these should be the local ports of the UDP RTP
     * (and RTCP) sockets over which we receive RTP/RTCP data. */
    int client_port_min, client_port_max;

    /** UDP unicast server port range; the ports to which we should connect
     * to receive unicast UDP RTP/RTCP data. */
    int server_port_min, server_port_max;

    /** time-to-live value (required for multicast); the amount of HOPs that
     * packets will be allowed to make before being discarded. */
    int ttl;

89
    uint32_t destination; /**< destination IP address */
90 91

    /** data/packet transport protocol; e.g. RTP or RDT */
92
    enum RTSPTransport transport;
93 94

    /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
95
    enum RTSPLowerTransport lower_transport;
96 97
} RTSPTransportField;

98 99 100
/**
 * This describes the server response to each RTSP command.
 */
101
typedef struct RTSPMessageHeader {
102
    /** length of the data following this header */
103
    int content_length;
104

105
    enum RTSPStatusCode status_code; /**< response code from server */
106 107

    /** number of items in the 'transports' variable below */
108
    int nb_transports;
109 110 111

    /** Time range of the streams that the server will stream. In
     * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
112
    int64_t range_start, range_end;
113 114 115

    /** describes the complete "Transport:" line of the server in response
     * to a SETUP RTSP command by the client */
116
    RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
117 118 119 120 121

    int seq;                         /**< sequence number */

    /** the "Session:" field. This value is initially set by the server and
     * should be re-transmitted by the client in every RTSP command. */
122
    char session_id[512];
123 124 125 126 127 128 129 130 131 132 133

    /** the "RealChallenge1:" field from the server */
    char real_challenge[64];

    /** the "Server: field, which can be used to identify some special-case
     * servers that are not 100% standards-compliant. We use this to identify
     * Windows Media Server, which has a value "WMServer/v.e.r.sion", where
     * version is a sequence of digits (e.g. 9.0.0.3372). Helix/Real servers
     * use something like "Helix [..] Server Version v.e.r.sion (platform)
     * (RealServer compatible)" or "RealServer Version v.e.r.sion (platform)",
     * where platform is the output of $uname -msr | sed 's/ /-/g'. */
134
    char server[64];
135 136 137 138 139 140 141 142

    /** The "timeout" comes as part of the server response to the "SETUP"
     * command, in the "Session: <xyz>[;timeout=<value>]" line. It is the
     * time, in seconds, that the server will go without traffic over the
     * RTSP/TCP connection before it closes the connection. To prevent
     * this, sent dummy requests (e.g. OPTIONS) with intervals smaller
     * than this value. */
    int timeout;
143
} RTSPMessageHeader;
144

145 146 147 148 149
/**
 * Client state, i.e. whether we are currently receiving data (PLAYING) or
 * setup-but-not-receiving (PAUSED). State can be changed in applications
 * by calling av_read_play/pause().
 */
150
enum RTSPClientState {
151 152 153
    RTSP_STATE_IDLE,    /**< not initialized */
    RTSP_STATE_PLAYING, /**< initialized and receiving data */
    RTSP_STATE_PAUSED,  /**< initialized, but not receiving data */
154 155
};

156 157 158 159
/**
 * Identifies particular servers that require special handling, such as
 * standards-incompliant "Transport:" lines in the SETUP request.
 */
160
enum RTSPServerType {
161
    RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
162 163
    RTSP_SERVER_REAL, /**< Realmedia-style server */
    RTSP_SERVER_WMS,  /**< Windows Media server */
164
    RTSP_SERVER_NB
165 166
};

167 168
/**
 * Private data for the RTSP demuxer.
169 170
 *
 * @todo Use ByteIOContext instead of URLContext
171
 */
172 173
typedef struct RTSPState {
    URLContext *rtsp_hd; /* RTSP TCP connexion handle */
174 175

    /** number of items in the 'rtsp_streams' variable */
176 177
    int nb_rtsp_streams;

178 179 180 181 182 183
    struct RTSPStream **rtsp_streams; /**< streams in this session */

    /** indicator of whether we are currently receiving data from the
     * server. Basically this isn't more than a simple cache of the
     * last PLAY/PAUSE command sent to the server, to make sure we don't
     * send 2x the same unexpectedly or commands in the wrong state. */
184
    enum RTSPClientState state;
185 186 187 188 189 190 191

    /** the seek value requested when calling av_seek_frame(). This value
     * is subsequently used as part of the "Range" parameter when emitting
     * the RTSP PLAY command. If we are currently playing, this command is
     * called instantly. If we are currently paused, this command is called
     * whenever we resume playback. Either way, the value is only used once,
     * see rtsp_read_play() and rtsp_read_seek(). */
192 193 194 195
    int64_t seek_timestamp;

    /* XXX: currently we use unbuffered input */
    //    ByteIOContext rtsp_gb;
196 197 198 199 200

    int seq;                          /**< RTSP command sequence number */

    /** copy of RTSPMessageHeader->session_id, i.e. the server-provided session
     * identifier that the client should re-transmit in each RTSP command */
201
    char session_id[512];
202

203 204 205 206 207 208 209
    /** copy of RTSPMessageHeader->timeout, i.e. the time (in seconds) that
     * the server will go without traffic on the RTSP/TCP line before it
     * closes the connection. */
    int timeout;

    /** timestamp of the last RTSP command that we sent to the RTSP server.
     * This is used to calculate when to send dummy commands to keep the
210
     * connection alive, in conjunction with timeout. */
211 212
    int64_t last_cmd_time;

213
    /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
214
    enum RTSPTransport transport;
215 216 217

    /** the negotiated network layer transport protocol; e.g. TCP or UDP
     * uni-/multicast */
218
    enum RTSPLowerTransport lower_transport;
219 220 221 222

    /** brand of server that we're talking to; e.g. WMS, REAL or other.
     * Detected based on the value of RTSPMessageHeader->server or the presence
     * of RTSPMessageHeader->real_challenge */
223
    enum RTSPServerType server_type;
224 225

    /** The last reply of the server to a RTSP command */
226
    char last_reply[2048]; /* XXX: allocate ? */
227 228 229

    /** RTSPStream->transport_priv of the last stream that we read a
     * packet from */
230
    void *cur_transport_priv;
231 232 233 234

    /** The following are used for Real stream selection */
    //@{
    /** whether we need to send a "SET_PARAMETER Subscribe:" command */
235
    int need_subscription;
236 237 238

    /** stream setup during the last frame read. This is used to detect if
     * we need to subscribe or unsubscribe to any new streams. */
239
    enum AVDiscard real_setup_cache[MAX_STREAMS];
240 241 242 243

    /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
     * this is used to send the same "Unsubscribe:" if stream setup changed,
     * before sending a new "Subscribe:" command. */
244
    char last_subscription[1024];
245
    //@}
246 247 248 249 250 251

    /** The following are used for RTP/ASF streams */
    //@{
    /** ASF demuxer context for the embedded ASF stream from WMS servers */
    AVFormatContext *asf_ctx;
    //@}
252 253
} RTSPState;

254 255 256 257 258 259
/**
 * Describes a single stream, as identified by a single m= line block in the
 * SDP content. In the case of RDT, one RTSPStream can represent multiple
 * AVStreams. In this case, each AVStream in this set has similar content
 * (but different codec/bitrate).
 */
260
typedef struct RTSPStream {
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    URLContext *rtp_handle;   /**< RTP stream handle (if UDP) */
    void *transport_priv; /**< RTP/RDT parse context */

    /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
    int stream_index;

    /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
     * for the selected transport. Only used for TCP. */
    int interleaved_min, interleaved_max;

    char control_url[1024];   /**< url for this stream (from SDP) */

    /** The following are used only in SDP, not RTSP */
    //@{
    int sdp_port;             /**< port (from SDP content) */
    struct in_addr sdp_ip;    /**< IP address (from SDP content) */
    int sdp_ttl;              /**< IP Time-To-Live (from SDP content) */
    int sdp_payload_type;     /**< payload type */
    //@}
280

281 282 283 284
    /** rtp payload parsing infos from SDP (i.e. mapping between private
     * payload IDs and media-types (string), so that we can derive what
     * type of payload we're dealing with (and how to parse it). */
    RTPPayloadData rtp_payload_data;
285

286 287 288 289
    /** The following are used for dynamic protocols (rtp_*.c/rdt.c) */
    //@{
    /** handler structure */
    RTPDynamicProtocolHandler *dynamic_handler;
290

291 292 293
    /** private data associated with the dynamic protocol */
    PayloadContext *dynamic_protocol_context;
    //@}
294 295
} RTSPStream;

296
int rtsp_init(void);
297
void rtsp_parse_line(RTSPMessageHeader *reply, const char *buf);
298

Ronald S. Bultje's avatar
Ronald S. Bultje committed
299
#if LIBAVFORMAT_VERSION_INT < (53 << 16)
300
extern int rtsp_default_protocols;
Ronald S. Bultje's avatar
Ronald S. Bultje committed
301
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
302 303
extern int rtsp_rtp_port_min;
extern int rtsp_rtp_port_max;
304 305 306

int rtsp_pause(AVFormatContext *s);
int rtsp_resume(AVFormatContext *s);
307

308
#endif /* FFMPEG_RTSP_H */