libavformat/rtsp.h

   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  * 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  * Libav 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 Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21 #ifndef AVFORMAT_RTSP_H
  22 #define AVFORMAT_RTSP_H
  23
  24 #include <stdint.h>
  25 #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
  33 /**
  34  * Network layer over which RTP/etc packet data will be transported.
  35  */
  36 enum RTSPLowerTransport {
  37     RTSP_LOWER_TRANSPORT_UDP = 0,           /**< UDP/unicast */
  38     RTSP_LOWER_TRANSPORT_TCP = 1,           /**< TCP; interleaved in RTSP */
  39     RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2, /**< UDP/multicast */
  40     RTSP_LOWER_TRANSPORT_NB
  41 };
  42
  43 /**
  44  * Packet profile of the data that we will be receiving. Real servers
  45  * commonly send RDT (although they can sometimes send RTP as well),
  46  * whereas most others will send RTP.
  47  */
  48 enum RTSPTransport {
  49     RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
  50     RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
  51     RTSP_TRANSPORT_NB
  52 };
  53
  54 /**
  55  * Transport mode for the RTSP data. This may be plain, or
  56  * tunneled, which is done over HTTP.
  57  */
  58 enum RTSPControlTransport {
  59     RTSP_MODE_PLAIN,   /**< Normal RTSP */
  60     RTSP_MODE_TUNNEL   /**< RTSP over HTTP (tunneling) */
  61 };
  62
  63 #define RTSP_DEFAULT_PORT   554
  64 #define RTSP_MAX_TRANSPORTS 8
  65 #define RTSP_TCP_MAX_PACKET_SIZE 1472
  66 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 1
  67 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
  68 #define RTSP_RTP_PORT_MIN 5000
  69 #define RTSP_RTP_PORT_MAX 10000
  70
  71 /**
  72  * This describes a single item in the "Transport:" line of one stream as
  73  * negotiated by the SETUP RTSP command. Multiple transports are comma-
  74  * separated ("Transport: x-read-rdt/tcp;interleaved=0-1,rtp/avp/udp;
  75  * client_port=1000-1001;server_port=1800-1801") and described in separate
  76  * RTSPTransportFields.
  77  */
  78 typedef struct RTSPTransportField {
  79     /** interleave ids, if TCP transport; each TCP/RTSP data packet starts
  80      * with a '$', stream length and stream ID. If the stream ID is within
  81      * the range of this interleaved_min-max, then the packet belongs to
  82      * this stream. */
  83     int interleaved_min, interleaved_max;
  84
  85     /** UDP multicast port range; the ports to which we should connect to
  86      * receive multicast UDP data. */
  87     int port_min, port_max;
  88
  89     /** UDP client ports; these should be the local ports of the UDP RTP
  90      * (and RTCP) sockets over which we receive RTP/RTCP data. */
  91     int client_port_min, client_port_max;
  92
  93     /** UDP unicast server port range; the ports to which we should connect
  94      * to receive unicast UDP RTP/RTCP data. */
  95     int server_port_min, server_port_max;
  96
  97     /** time-to-live value (required for multicast); the amount of HOPs that
  98      * packets will be allowed to make before being discarded. */
  99     int ttl;
 100
 101     struct sockaddr_storage destination; /**< destination IP address */
 102     char source[INET6_ADDRSTRLEN + 1]; /**< source IP address */
 103
 104     /** data/packet transport protocol; e.g. RTP or RDT */
 105     enum RTSPTransport transport;
 106
 107     /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
 108     enum RTSPLowerTransport lower_transport;
 109 } RTSPTransportField;
 110
 111 /**
 112  * This describes the server response to each RTSP command.
 113  */
 114 typedef struct RTSPMessageHeader {
 115     /** length of the data following this header */
 116     int content_length;
 117
 118     enum RTSPStatusCode status_code; /**< response code from server */
 119
 120     /** number of items in the 'transports' variable below */
 121     int nb_transports;
 122
 123     /** Time range of the streams that the server will stream. In
 124      * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
 125     int64_t range_start, range_end;
 126
 127     /** describes the complete "Transport:" line of the server in response
 128      * to a SETUP RTSP command by the client */
 129     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
 130
 131     int seq;                         /**< sequence number */
 132
 133     /** the "Session:" field. This value is initially set by the server and
 134      * should be re-transmitted by the client in every RTSP command. */
 135     char session_id[512];
 136
 137     /** the "Location:" field. This value is used to handle redirection.
 138      */
 139     char location[4096];
 140
 141     /** the "RealChallenge1:" field from the server */
 142     char real_challenge[64];
 143
 144     /** the "Server: field, which can be used to identify some special-case
 145      * servers that are not 100% standards-compliant. We use this to identify
 146      * Windows Media Server, which has a value "WMServer/v.e.r.sion", where
 147      * version is a sequence of digits (e.g. 9.0.0.3372). Helix/Real servers
 148      * use something like "Helix [..] Server Version v.e.r.sion (platform)
 149      * (RealServer compatible)" or "RealServer Version v.e.r.sion (platform)",
 150      * where platform is the output of $uname -msr | sed 's/ /-/g'. */
 151     char server[64];
 152
 153     /** The "timeout" comes as part of the server response to the "SETUP"
 154      * command, in the "Session: <xyz>[;timeout=<value>]" line. It is the
 155      * time, in seconds, that the server will go without traffic over the
 156      * RTSP/TCP connection before it closes the connection. To prevent
 157      * this, sent dummy requests (e.g. OPTIONS) with intervals smaller
 158      * than this value. */
 159     int timeout;
 160
 161     /** The "Notice" or "X-Notice" field value. See
 162      * http://tools.ietf.org/html/draft-stiemerling-rtsp-announce-00
 163      * for a complete list of supported values. */
 164     int notice;
 165
 166     /** The "reason" is meant to specify better the meaning of the error code
 167      * returned
 168      */
 169     char reason[256];
 170 } RTSPMessageHeader;
 171
 172 /**
 173  * Client state, i.e. whether we are currently receiving data (PLAYING) or
 174  * setup-but-not-receiving (PAUSED). State can be changed in applications
 175  * by calling av_read_play/pause().
 176  */
 177 enum RTSPClientState {
 178     RTSP_STATE_IDLE,    /**< not initialized */
 179     RTSP_STATE_STREAMING, /**< initialized and sending/receiving data */
 180     RTSP_STATE_PAUSED,  /**< initialized, but not receiving data */
 181     RTSP_STATE_SEEKING, /**< initialized, requesting a seek */
 182 };
 183
 184 /**
 185  * Identifies particular servers that require special handling, such as
 186  * standards-incompliant "Transport:" lines in the SETUP request.
 187  */
 188 enum RTSPServerType {
 189     RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
 190     RTSP_SERVER_REAL, /**< Realmedia-style server */
 191     RTSP_SERVER_WMS,  /**< Windows Media server */
 192     RTSP_SERVER_NB
 193 };
 194
 195 /**
 196  * Private data for the RTSP demuxer.
 197  *
 198  * @todo Use AVIOContext instead of URLContext
 199  */
 200 typedef struct RTSPState {
 201     const AVClass *class;             /**< Class for private options. */
 202     URLContext *rtsp_hd; /* RTSP TCP connection handle */
 203
 204     /** number of items in the 'rtsp_streams' variable */
 205     int nb_rtsp_streams;
 206
 207     struct RTSPStream **rtsp_streams; /**< streams in this session */
 208
 209     /** indicator of whether we are currently receiving data from the
 210      * server. Basically this isn't more than a simple cache of the
 211      * last PLAY/PAUSE command sent to the server, to make sure we don't
 212      * send 2x the same unexpectedly or commands in the wrong state. */
 213     enum RTSPClientState state;
 214
 215     /** the seek value requested when calling av_seek_frame(). This value
 216      * is subsequently used as part of the "Range" parameter when emitting
 217      * the RTSP PLAY command. If we are currently playing, this command is
 218      * called instantly. If we are currently paused, this command is called
 219      * whenever we resume playback. Either way, the value is only used once,
 220      * see rtsp_read_play() and rtsp_read_seek(). */
 221     int64_t seek_timestamp;
 222
 223     int seq;                          /**< RTSP command sequence number */
 224
 225     /** copy of RTSPMessageHeader->session_id, i.e. the server-provided session
 226      * identifier that the client should re-transmit in each RTSP command */
 227     char session_id[512];
 228
 229     /** copy of RTSPMessageHeader->timeout, i.e. the time (in seconds) that
 230      * the server will go without traffic on the RTSP/TCP line before it
 231      * closes the connection. */
 232     int timeout;
 233
 234     /** timestamp of the last RTSP command that we sent to the RTSP server.
 235      * This is used to calculate when to send dummy commands to keep the
 236      * connection alive, in conjunction with timeout. */
 237     int64_t last_cmd_time;
 238
 239     /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
 240     enum RTSPTransport transport;
 241
 242     /** the negotiated network layer transport protocol; e.g. TCP or UDP
 243      * uni-/multicast */
 244     enum RTSPLowerTransport lower_transport;
 245
 246     /** brand of server that we're talking to; e.g. WMS, REAL or other.
 247      * Detected based on the value of RTSPMessageHeader->server or the presence
 248      * of RTSPMessageHeader->real_challenge */
 249     enum RTSPServerType server_type;
 250
 251     /** the "RealChallenge1:" field from the server */
 252     char real_challenge[64];
 253
 254     /** plaintext authorization line (username:password) */
 255     char auth[128];
 256
 257     /** authentication state */
 258     HTTPAuthState auth_state;
 259
 260     /** The last reply of the server to a RTSP command */
 261     char last_reply[2048]; /* XXX: allocate ? */
 262
 263     /** RTSPStream->transport_priv of the last stream that we read a
 264      * packet from */
 265     void *cur_transport_priv;
 266
 267     /** The following are used for Real stream selection */
 268     //@{
 269     /** whether we need to send a "SET_PARAMETER Subscribe:" command */
 270     int need_subscription;
 271
 272     /** stream setup during the last frame read. This is used to detect if
 273      * we need to subscribe or unsubscribe to any new streams. */
 274     enum AVDiscard *real_setup_cache;
 275
 276     /** current stream setup. This is a temporary buffer used to compare
 277      * current setup to previous frame setup. */
 278     enum AVDiscard *real_setup;
 279
 280     /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
 281      * this is used to send the same "Unsubscribe:" if stream setup changed,
 282      * before sending a new "Subscribe:" command. */
 283     char last_subscription[1024];
 284     //@}
 285
 286     /** The following are used for RTP/ASF streams */
 287     //@{
 288     /** ASF demuxer context for the embedded ASF stream from WMS servers */
 289     AVFormatContext *asf_ctx;
 290
 291     /** cache for position of the asf demuxer, since we load a new
 292      * data packet in the bytecontext for each incoming RTSP packet. */
 293     uint64_t asf_pb_pos;
 294     //@}
 295
 296     /** some MS RTSP streams contain a URL in the SDP that we need to use
 297      * for all subsequent RTSP requests, rather than the input URI; in
 298      * other cases, this is a copy of AVFormatContext->filename. */
 299     char control_uri[1024];
 300
 301     /** Additional output handle, used when input and output are done
 302      * separately, eg for HTTP tunneling. */
 303     URLContext *rtsp_hd_out;
 304
 305     /** RTSP transport mode, such as plain or tunneled. */
 306     enum RTSPControlTransport control_transport;
 307
 308     /* Number of RTCP BYE packets the RTSP session has received.
 309      * An EOF is propagated back if nb_byes == nb_streams.
 310      * This is reset after a seek. */
 311     int nb_byes;
 312
 313     /** Reusable buffer for receiving packets */
 314     uint8_t* recvbuf;
 315
 316     /** Filter incoming UDP packets - receive packets only from the right
 317      * source address and port. */
 318     int filter_source;
 319
 320     /**
 321      * A mask with all requested transport methods
 322      */
 323     int lower_transport_mask;
 324
 325     /**
 326      * The number of returned packets
 327      */
 328     uint64_t packets;
 329
 330     /**
 331      * Polling array for udp
 332      */
 333     struct pollfd *p;
 334
 335     /**
 336      * Whether the server supports the GET_PARAMETER method.
 337      */
 338     int get_parameter_supported;
 339
 340     /**
 341      * Do not begin to play the stream immediately.
 342      */
 343     int initial_pause;
 344
 345     /**
 346      * Option flags for the chained RTP muxer.
 347      */
 348     int rtp_muxer_flags;
 349 } RTSPState;
 350
 351 /**
 352  * Describes a single stream, as identified by a single m= line block in the
 353  * SDP content. In the case of RDT, one RTSPStream can represent multiple
 354  * AVStreams. In this case, each AVStream in this set has similar content
 355  * (but different codec/bitrate).
 356  */
 357 typedef struct RTSPStream {
 358     URLContext *rtp_handle;   /**< RTP stream handle (if UDP) */
 359     void *transport_priv; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
 360
 361     /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
 362     int stream_index;
 363
 364     /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
 365      * for the selected transport. Only used for TCP. */
 366     int interleaved_min, interleaved_max;
 367
 368     char control_url[1024];   /**< url for this stream (from SDP) */
 369
 370     /** The following are used only in SDP, not RTSP */
 371     //@{
 372     int sdp_port;             /**< port (from SDP content) */
 373     struct sockaddr_storage sdp_ip; /**< IP address (from SDP content) */
 374     int sdp_ttl;              /**< IP Time-To-Live (from SDP content) */
 375     int sdp_payload_type;     /**< payload type */
 376     //@}
 377
 378     /** The following are used for dynamic protocols (rtp_*.c/rdt.c) */
 379     //@{
 380     /** handler structure */
 381     RTPDynamicProtocolHandler *dynamic_handler;
 382
 383     /** private data associated with the dynamic protocol */
 384     PayloadContext *dynamic_protocol_context;
 385     //@}
 386 } RTSPStream;
 387
 388 void ff_rtsp_parse_line(RTSPMessageHeader *reply, const char *buf,
 389                         RTSPState *rt, const char *method);
 390
 391 extern int rtsp_rtp_port_min;
 392 extern int rtsp_rtp_port_max;
 393
 394 /**
 395  * Send a command to the RTSP server without waiting for the reply.
 396  *
 397  * @see rtsp_send_cmd_with_content_async
 398  */
 399 int ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method,
 400                            const char *url, const char *headers);
 401
 402 /**
 403  * Send a command to the RTSP server and wait for the reply.
 404  *
 405  * @param s RTSP (de)muxer context
 406  * @param method the method for the request
 407  * @param url the target url for the request
 408  * @param headers extra header lines to include in the request
 409  * @param reply pointer where the RTSP message header will be stored
 410  * @param content_ptr pointer where the RTSP message body, if any, will
 411  *                    be stored (length is in reply)
 412  * @param send_content if non-null, the data to send as request body content
 413  * @param send_content_length the length of the send_content data, or 0 if
 414  *                            send_content is null
 415  *
 416  * @return zero if success, nonzero otherwise
 417  */
 418 int ff_rtsp_send_cmd_with_content(AVFormatContext *s,
 419                                   const char *method, const char *url,
 420                                   const char *headers,
 421                                   RTSPMessageHeader *reply,
 422                                   unsigned char **content_ptr,
 423                                   const unsigned char *send_content,
 424                                   int send_content_length);
 425
 426 /**
 427  * Send a command to the RTSP server and wait for the reply.
 428  *
 429  * @see rtsp_send_cmd_with_content
 430  */
 431 int ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
 432                      const char *url, const char *headers,
 433                      RTSPMessageHeader *reply, unsigned char **content_ptr);
 434
 435 /**
 436  * Read a RTSP message from the server, or prepare to read data
 437  * packets if we're reading data interleaved over the TCP/RTSP
 438  * connection as well.
 439  *
 440  * @param s RTSP (de)muxer context
 441  * @param reply pointer where the RTSP message header will be stored
 442  * @param content_ptr pointer where the RTSP message body, if any, will
 443  *                    be stored (length is in reply)
 444  * @param return_on_interleaved_data whether the function may return if we
 445  *                   encounter a data marker ('$'), which precedes data
 446  *                   packets over interleaved TCP/RTSP connections. If this
 447  *                   is set, this function will return 1 after encountering
 448  *                   a '$'. If it is not set, the function will skip any
 449  *                   data packets (if they are encountered), until a reply
 450  *                   has been fully parsed. If no more data is available
 451  *                   without parsing a reply, it will return an error.
 452  * @param method the RTSP method this is a reply to. This affects how
 453  *               some response headers are acted upon. May be NULL.
 454  *
 455  * @return 1 if a data packets is ready to be received, -1 on error,
 456  *          and 0 on success.
 457  */
 458 int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
 459                        unsigned char **content_ptr,
 460                        int return_on_interleaved_data, const char *method);
 461
 462 /**
 463  * Skip a RTP/TCP interleaved packet.
 464  */
 465 void ff_rtsp_skip_packet(AVFormatContext *s);
 466
 467 /**
 468  * Connect to the RTSP server and set up the individual media streams.
 469  * This can be used for both muxers and demuxers.
 470  *
 471  * @param s RTSP (de)muxer context
 472  *
 473  * @return 0 on success, < 0 on error. Cleans up all allocations done
 474  *          within the function on error.
 475  */
 476 int ff_rtsp_connect(AVFormatContext *s);
 477
 478 /**
 479  * Close and free all streams within the RTSP (de)muxer
 480  *
 481  * @param s RTSP (de)muxer context
 482  */
 483 void ff_rtsp_close_streams(AVFormatContext *s);
 484
 485 /**
 486  * Close all connection handles within the RTSP (de)muxer
 487  *
 488  * @param s RTSP (de)muxer context
 489  */
 490 void ff_rtsp_close_connections(AVFormatContext *s);
 491
 492 /**
 493  * Get the description of the stream and set up the RTSPStream child
 494  * objects.
 495  */
 496 int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);
 497
 498 /**
 499  * Announce the stream to the server and set up the RTSPStream child
 500  * objects for each media stream.
 501  */
 502 int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);
 503
 504 /**
 505  * Parse an SDP description of streams by populating an RTSPState struct
 506  * within the AVFormatContext; also allocate the RTP streams and the
 507  * pollfd array used for UDP streams.
 508  */
 509 int ff_sdp_parse(AVFormatContext *s, const char *content);
 510
 511 /**
 512  * Receive one RTP packet from an TCP interleaved RTSP stream.
 513  */
 514 int ff_rtsp_tcp_read_packet(AVFormatContext *s, RTSPStream **prtsp_st,
 515                             uint8_t *buf, int buf_size);
 516
 517 /**
 518  * Receive one packet from the RTSPStreams set up in the AVFormatContext
 519  * (which should contain a RTSPState struct as priv_data).
 520  */
 521 int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);
 522
 523 /**
 524  * Do the SETUP requests for each stream for the chosen
 525  * lower transport mode.
 526  * @return 0 on success, <0 on error, 1 if protocol is unavailable
 527  */
 528 int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
 529                                int lower_transport, const char *real_challenge);
 530
 531 /**
 532  * Undo the effect of ff_rtsp_make_setup_request, close the
 533  * transport_priv and rtp_handle fields.
 534  */
 535 void ff_rtsp_undo_setup(AVFormatContext *s);
 536
 537 #endif /* AVFORMAT_RTSP_H */