rtsp.h 19.6 KB
Newer Older
1 2
/*
 * RTSP definitions
3
 * Copyright (c) 2002 Fabrice Bellard
4
 *
5
 * This file is part of Libav.
6
 *
7
 * Libav 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
 * Libav 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 Libav; if not, write to the Free Software
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20
 */
21 22
#ifndef AVFORMAT_RTSP_H
#define AVFORMAT_RTSP_H
23

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

31
#include "libavutil/log.h"
32
#include "libavutil/opt.h"
33

34 35 36
/**
 * Network layer over which RTP/etc packet data will be transported.
 */
37
enum RTSPLowerTransport {
38 39 40
    RTSP_LOWER_TRANSPORT_UDP = 0,           /**< UDP/unicast */
    RTSP_LOWER_TRANSPORT_TCP = 1,           /**< TCP; interleaved in RTSP */
    RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2, /**< UDP/multicast */
41 42 43 44
    RTSP_LOWER_TRANSPORT_NB,
    RTSP_LOWER_TRANSPORT_HTTP = 8,          /**< HTTP tunneled - not a proper
                                                 transport mode as such,
                                                 only for use via AVOptions */
45 46
};

47 48 49 50 51
/**
 * 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.
 */
52
enum RTSPTransport {
53 54
    RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
    RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
55
    RTSP_TRANSPORT_NB
56 57
};

58 59 60 61 62 63 64 65 66
/**
 * Transport mode for the RTSP data. This may be plain, or
 * tunneled, which is done over HTTP.
 */
enum RTSPControlTransport {
    RTSP_MODE_PLAIN,   /**< Normal RTSP */
    RTSP_MODE_TUNNEL   /**< RTSP over HTTP (tunneling) */
};

67 68
#define RTSP_DEFAULT_PORT   554
#define RTSP_MAX_TRANSPORTS 8
69
#define RTSP_TCP_MAX_PACKET_SIZE 1472
70
#define RTSP_DEFAULT_NB_AUDIO_CHANNELS 1
71 72 73
#define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
#define RTSP_RTP_PORT_MIN 5000
#define RTSP_RTP_PORT_MAX 10000
74

75 76 77 78 79 80 81
/**
 * 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.
 */
82
typedef struct RTSPTransportField {
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    /** 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;

105
    struct sockaddr_storage destination; /**< destination IP address */
106
    char source[INET6_ADDRSTRLEN + 1]; /**< source IP address */
107 108

    /** data/packet transport protocol; e.g. RTP or RDT */
109
    enum RTSPTransport transport;
110 111

    /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
112
    enum RTSPLowerTransport lower_transport;
113 114
} RTSPTransportField;

115 116 117
/**
 * This describes the server response to each RTSP command.
 */
118
typedef struct RTSPMessageHeader {
119
    /** length of the data following this header */
120
    int content_length;
121

122
    enum RTSPStatusCode status_code; /**< response code from server */
123 124

    /** number of items in the 'transports' variable below */
125
    int nb_transports;
126 127 128

    /** Time range of the streams that the server will stream. In
     * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
129
    int64_t range_start, range_end;
130 131 132

    /** describes the complete "Transport:" line of the server in response
     * to a SETUP RTSP command by the client */
133
    RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
134 135 136 137 138

    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. */
139
    char session_id[512];
140

141 142 143 144
    /** the "Location:" field. This value is used to handle redirection.
     */
    char location[4096];

145 146 147 148 149 150 151 152 153 154
    /** 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'. */
155
    char server[64];
156 157 158 159 160 161 162 163

    /** 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;
164 165 166 167 168

    /** The "Notice" or "X-Notice" field value. See
     * http://tools.ietf.org/html/draft-stiemerling-rtsp-announce-00
     * for a complete list of supported values. */
    int notice;
Luca Barbato's avatar
Luca Barbato committed
169 170 171 172 173

    /** The "reason" is meant to specify better the meaning of the error code
     * returned
     */
    char reason[256];
174
} RTSPMessageHeader;
175

176 177 178 179 180
/**
 * 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().
 */
181
enum RTSPClientState {
182
    RTSP_STATE_IDLE,    /**< not initialized */
183
    RTSP_STATE_STREAMING, /**< initialized and sending/receiving data */
184
    RTSP_STATE_PAUSED,  /**< initialized, but not receiving data */
185
    RTSP_STATE_SEEKING, /**< initialized, requesting a seek */
186 187
};

188 189 190 191
/**
 * Identifies particular servers that require special handling, such as
 * standards-incompliant "Transport:" lines in the SETUP request.
 */
192
enum RTSPServerType {
193
    RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
194 195
    RTSP_SERVER_REAL, /**< Realmedia-style server */
    RTSP_SERVER_WMS,  /**< Windows Media server */
196
    RTSP_SERVER_NB
197 198
};

199 200
/**
 * Private data for the RTSP demuxer.
201
 *
202
 * @todo Use AVIOContext instead of URLContext
203
 */
204
typedef struct RTSPState {
205
    const AVClass *class;             /**< Class for private options. */
206
    URLContext *rtsp_hd; /* RTSP TCP connection handle */
207 208

    /** number of items in the 'rtsp_streams' variable */
209 210
    int nb_rtsp_streams;

211 212 213 214 215 216
    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. */
217
    enum RTSPClientState state;
218 219 220 221 222 223 224

    /** 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(). */
225 226
    int64_t seek_timestamp;

227 228 229 230
    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 */
231
    char session_id[512];
232

233 234 235 236 237 238 239
    /** 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
240
     * connection alive, in conjunction with timeout. */
241 242
    int64_t last_cmd_time;

243
    /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
244
    enum RTSPTransport transport;
245 246 247

    /** the negotiated network layer transport protocol; e.g. TCP or UDP
     * uni-/multicast */
248
    enum RTSPLowerTransport lower_transport;
249 250 251 252

    /** 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 */
253
    enum RTSPServerType server_type;
254

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

258 259 260 261 262
    /** plaintext authorization line (username:password) */
    char auth[128];

    /** authentication state */
    HTTPAuthState auth_state;
263

264
    /** The last reply of the server to a RTSP command */
265
    char last_reply[2048]; /* XXX: allocate ? */
266 267 268

    /** RTSPStream->transport_priv of the last stream that we read a
     * packet from */
269
    void *cur_transport_priv;
270 271 272 273

    /** The following are used for Real stream selection */
    //@{
    /** whether we need to send a "SET_PARAMETER Subscribe:" command */
274
    int need_subscription;
275 276 277

    /** stream setup during the last frame read. This is used to detect if
     * we need to subscribe or unsubscribe to any new streams. */
278 279 280 281 282
    enum AVDiscard *real_setup_cache;

    /** current stream setup. This is a temporary buffer used to compare
     * current setup to previous frame setup. */
    enum AVDiscard *real_setup;
283 284 285 286

    /** 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. */
287
    char last_subscription[1024];
288
    //@}
289 290 291 292 293

    /** The following are used for RTP/ASF streams */
    //@{
    /** ASF demuxer context for the embedded ASF stream from WMS servers */
    AVFormatContext *asf_ctx;
294 295 296 297

    /** cache for position of the asf demuxer, since we load a new
     * data packet in the bytecontext for each incoming RTSP packet. */
    uint64_t asf_pb_pos;
298
    //@}
299 300 301 302 303

    /** some MS RTSP streams contain a URL in the SDP that we need to use
     * for all subsequent RTSP requests, rather than the input URI; in
     * other cases, this is a copy of AVFormatContext->filename. */
    char control_uri[1024];
304

305 306 307
    /** Additional output handle, used when input and output are done
     * separately, eg for HTTP tunneling. */
    URLContext *rtsp_hd_out;
308 309 310

    /** RTSP transport mode, such as plain or tunneled. */
    enum RTSPControlTransport control_transport;
311 312 313 314 315

    /* Number of RTCP BYE packets the RTSP session has received.
     * An EOF is propagated back if nb_byes == nb_streams.
     * This is reset after a seek. */
    int nb_byes;
316 317 318

    /** Reusable buffer for receiving packets */
    uint8_t* recvbuf;
319

320 321 322 323 324 325 326 327 328
    /**
     * A mask with all requested transport methods
     */
    int lower_transport_mask;

    /**
     * The number of returned packets
     */
    uint64_t packets;
329 330 331 332 333

    /**
     * Polling array for udp
     */
    struct pollfd *p;
334 335 336 337 338

    /**
     * Whether the server supports the GET_PARAMETER method.
     */
    int get_parameter_supported;
339 340 341 342 343

    /**
     * Do not begin to play the stream immediately.
     */
    int initial_pause;
344 345 346 347 348

    /**
     * Option flags for the chained RTP muxer.
     */
    int rtp_muxer_flags;
349 350 351

    /** Whether the server accepts the x-Dynamic-Rate header */
    int accept_dynamic_rate;
352 353 354 355 356

    /**
     * Various option flags for the RTSP muxer/demuxer.
     */
    int rtsp_flags;
357 358 359 360 361

    /**
     * Mask of all requested media types
     */
    int media_type_mask;
362 363
} RTSPState;

364 365 366 367
#define RTSP_FLAG_FILTER_SRC  0x1    /**< Filter incoming UDP packets -
                                          receive packets only from the right
                                          source address and port. */

368 369 370 371 372 373
/**
 * 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).
 */
374
typedef struct RTSPStream {
375
    URLContext *rtp_handle;   /**< RTP stream handle (if UDP) */
376
    void *transport_priv; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
377 378 379 380 381 382 383 384 385 386 387 388 389

    /** 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) */
390
    struct sockaddr_storage sdp_ip; /**< IP address (from SDP content) */
391 392 393
    int sdp_ttl;              /**< IP Time-To-Live (from SDP content) */
    int sdp_payload_type;     /**< payload type */
    //@}
394

395 396 397 398
    /** The following are used for dynamic protocols (rtp_*.c/rdt.c) */
    //@{
    /** handler structure */
    RTPDynamicProtocolHandler *dynamic_handler;
399

400 401 402
    /** private data associated with the dynamic protocol */
    PayloadContext *dynamic_protocol_context;
    //@}
403 404
} RTSPStream;

405
void ff_rtsp_parse_line(RTSPMessageHeader *reply, const char *buf,
406
                        RTSPState *rt, const char *method);
407

408 409
extern int rtsp_rtp_port_min;
extern int rtsp_rtp_port_max;
410

411 412 413 414 415
/**
 * Send a command to the RTSP server without waiting for the reply.
 *
 * @see rtsp_send_cmd_with_content_async
 */
416
int ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method,
417
                           const char *url, const char *headers);
418 419 420 421 422

/**
 * Send a command to the RTSP server and wait for the reply.
 *
 * @param s RTSP (de)muxer context
423 424 425
 * @param method the method for the request
 * @param url the target url for the request
 * @param headers extra header lines to include in the request
426 427 428 429 430 431
 * @param reply pointer where the RTSP message header will be stored
 * @param content_ptr pointer where the RTSP message body, if any, will
 *                    be stored (length is in reply)
 * @param send_content if non-null, the data to send as request body content
 * @param send_content_length the length of the send_content data, or 0 if
 *                            send_content is null
432 433
 *
 * @return zero if success, nonzero otherwise
434
 */
435
int ff_rtsp_send_cmd_with_content(AVFormatContext *s,
436 437 438 439 440 441
                                  const char *method, const char *url,
                                  const char *headers,
                                  RTSPMessageHeader *reply,
                                  unsigned char **content_ptr,
                                  const unsigned char *send_content,
                                  int send_content_length);
442 443 444 445 446 447

/**
 * Send a command to the RTSP server and wait for the reply.
 *
 * @see rtsp_send_cmd_with_content
 */
448
int ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
449 450
                     const char *url, const char *headers,
                     RTSPMessageHeader *reply, unsigned char **content_ptr);
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468

/**
 * Read a RTSP message from the server, or prepare to read data
 * packets if we're reading data interleaved over the TCP/RTSP
 * connection as well.
 *
 * @param s RTSP (de)muxer context
 * @param reply pointer where the RTSP message header will be stored
 * @param content_ptr pointer where the RTSP message body, if any, will
 *                    be stored (length is in reply)
 * @param return_on_interleaved_data whether the function may return if we
 *                   encounter a data marker ('$'), which precedes data
 *                   packets over interleaved TCP/RTSP connections. If this
 *                   is set, this function will return 1 after encountering
 *                   a '$'. If it is not set, the function will skip any
 *                   data packets (if they are encountered), until a reply
 *                   has been fully parsed. If no more data is available
 *                   without parsing a reply, it will return an error.
469 470
 * @param method the RTSP method this is a reply to. This affects how
 *               some response headers are acted upon. May be NULL.
471
 *
472
 * @return 1 if a data packets is ready to be received, -1 on error,
473 474
 *          and 0 on success.
 */
475
int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
Martin Storsjö's avatar
Martin Storsjö committed
476
                       unsigned char **content_ptr,
477
                       int return_on_interleaved_data, const char *method);
478

479 480 481 482 483
/**
 * Skip a RTP/TCP interleaved packet.
 */
void ff_rtsp_skip_packet(AVFormatContext *s);

484 485 486 487 488 489
/**
 * Connect to the RTSP server and set up the individual media streams.
 * This can be used for both muxers and demuxers.
 *
 * @param s RTSP (de)muxer context
 *
490
 * @return 0 on success, < 0 on error. Cleans up all allocations done
491 492
 *          within the function on error.
 */
493
int ff_rtsp_connect(AVFormatContext *s);
494 495 496 497 498 499

/**
 * Close and free all streams within the RTSP (de)muxer
 *
 * @param s RTSP (de)muxer context
 */
500
void ff_rtsp_close_streams(AVFormatContext *s);
501

502 503 504
/**
 * Close all connection handles within the RTSP (de)muxer
 *
505
 * @param s RTSP (de)muxer context
506
 */
507
void ff_rtsp_close_connections(AVFormatContext *s);
508

509 510 511 512 513 514
/**
 * Get the description of the stream and set up the RTSPStream child
 * objects.
 */
int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);

515 516 517 518 519 520
/**
 * Announce the stream to the server and set up the RTSPStream child
 * objects for each media stream.
 */
int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);

521
/**
522 523 524
 * Parse an SDP description of streams by populating an RTSPState struct
 * within the AVFormatContext; also allocate the RTP streams and the
 * pollfd array used for UDP streams.
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
 */
int ff_sdp_parse(AVFormatContext *s, const char *content);

/**
 * Receive one RTP packet from an TCP interleaved RTSP stream.
 */
int ff_rtsp_tcp_read_packet(AVFormatContext *s, RTSPStream **prtsp_st,
                            uint8_t *buf, int buf_size);

/**
 * Receive one packet from the RTSPStreams set up in the AVFormatContext
 * (which should contain a RTSPState struct as priv_data).
 */
int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);

540 541 542
/**
 * Do the SETUP requests for each stream for the chosen
 * lower transport mode.
543
 * @return 0 on success, <0 on error, 1 if protocol is unavailable
544 545 546 547
 */
int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
                               int lower_transport, const char *real_challenge);

548 549 550 551 552 553
/**
 * Undo the effect of ff_rtsp_make_setup_request, close the
 * transport_priv and rtp_handle fields.
 */
void ff_rtsp_undo_setup(AVFormatContext *s);

554 555
extern const AVOption ff_rtsp_options[];

556
#endif /* AVFORMAT_RTSP_H */