3 * Copyright (c) 2002 Fabrice Bellard
5 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVFORMAT_RTSP_H
22 #define AVFORMAT_RTSP_H
26 #include "rtspcodes.h"
31 #include "libavutil/log.h"
32 #include "libavutil/opt.h"
35 * Network layer over which RTP/etc packet data will be transported.
37 enum RTSPLowerTransport {
38 RTSP_LOWER_TRANSPORT_UDP = 0, /**< UDP/unicast */
39 RTSP_LOWER_TRANSPORT_TCP = 1, /**< TCP; interleaved in RTSP */
40 RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2, /**< UDP/multicast */
41 RTSP_LOWER_TRANSPORT_NB,
42 RTSP_LOWER_TRANSPORT_HTTP = 8, /**< HTTP tunneled - not a proper
43 transport mode as such,
44 only for use via AVOptions */
45 RTSP_LOWER_TRANSPORT_HTTPS, /**< HTTPS tunneled */
46 RTSP_LOWER_TRANSPORT_CUSTOM = 16, /**< Custom IO - not a public
47 option for lower_transport_mask,
48 but set in the SDP demuxer based
53 * Packet profile of the data that we will be receiving. Real servers
54 * commonly send RDT (although they can sometimes send RTP as well),
55 * whereas most others will send RTP.
58 RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
59 RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
60 RTSP_TRANSPORT_RAW, /**< Raw data (over UDP) */
65 * Transport mode for the RTSP data. This may be plain, or
66 * tunneled, which is done over HTTP.
68 enum RTSPControlTransport {
69 RTSP_MODE_PLAIN, /**< Normal RTSP */
70 RTSP_MODE_TUNNEL /**< RTSP over HTTP (tunneling) */
73 #define RTSP_DEFAULT_PORT 554
74 #define RTSPS_DEFAULT_PORT 322
75 #define RTSP_MAX_TRANSPORTS 8
76 #define RTSP_TCP_MAX_PACKET_SIZE 1472
77 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 1
78 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
79 #define RTSP_RTP_PORT_MIN 5000
80 #define RTSP_RTP_PORT_MAX 65000
81 #define SDP_MAX_SIZE 16384
84 * This describes a single item in the "Transport:" line of one stream as
85 * negotiated by the SETUP RTSP command. Multiple transports are comma-
86 * separated ("Transport: x-read-rdt/tcp;interleaved=0-1,rtp/avp/udp;
87 * client_port=1000-1001;server_port=1800-1801") and described in separate
88 * RTSPTransportFields.
90 typedef struct RTSPTransportField {
91 /** interleave ids, if TCP transport; each TCP/RTSP data packet starts
92 * with a '$', stream length and stream ID. If the stream ID is within
93 * the range of this interleaved_min-max, then the packet belongs to
95 int interleaved_min, interleaved_max;
97 /** UDP multicast port range; the ports to which we should connect to
98 * receive multicast UDP data. */
99 int port_min, port_max;
101 /** UDP client ports; these should be the local ports of the UDP RTP
102 * (and RTCP) sockets over which we receive RTP/RTCP data. */
103 int client_port_min, client_port_max;
105 /** UDP unicast server port range; the ports to which we should connect
106 * to receive unicast UDP RTP/RTCP data. */
107 int server_port_min, server_port_max;
109 /** time-to-live value (required for multicast); the amount of HOPs that
110 * packets will be allowed to make before being discarded. */
113 /** transport set to record data */
116 struct sockaddr_storage destination; /**< destination IP address */
117 char source[INET6_ADDRSTRLEN + 1]; /**< source IP address */
119 /** data/packet transport protocol; e.g. RTP or RDT */
120 enum RTSPTransport transport;
122 /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
123 enum RTSPLowerTransport lower_transport;
124 } RTSPTransportField;
127 * This describes the server response to each RTSP command.
129 typedef struct RTSPMessageHeader {
130 /** length of the data following this header */
133 enum RTSPStatusCode status_code; /**< response code from server */
135 /** number of items in the 'transports' variable below */
138 /** Time range of the streams that the server will stream. In
139 * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
140 int64_t range_start, range_end;
142 /** describes the complete "Transport:" line of the server in response
143 * to a SETUP RTSP command by the client */
144 RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
146 int seq; /**< sequence number */
148 /** the "Session:" field. This value is initially set by the server and
149 * should be re-transmitted by the client in every RTSP command. */
150 char session_id[512];
152 /** the "Location:" field. This value is used to handle redirection.
156 /** the "RealChallenge1:" field from the server */
157 char real_challenge[64];
159 /** the "Server: field, which can be used to identify some special-case
160 * servers that are not 100% standards-compliant. We use this to identify
161 * Windows Media Server, which has a value "WMServer/v.e.r.sion", where
162 * version is a sequence of digits (e.g. 9.0.0.3372). Helix/Real servers
163 * use something like "Helix [..] Server Version v.e.r.sion (platform)
164 * (RealServer compatible)" or "RealServer Version v.e.r.sion (platform)",
165 * where platform is the output of $uname -msr | sed 's/ /-/g'. */
168 /** The "timeout" comes as part of the server response to the "SETUP"
169 * command, in the "Session: <xyz>[;timeout=<value>]" line. It is the
170 * time, in seconds, that the server will go without traffic over the
171 * RTSP/TCP connection before it closes the connection. To prevent
172 * this, sent dummy requests (e.g. OPTIONS) with intervals smaller
173 * than this value. */
176 /** The "Notice" or "X-Notice" field value. See
177 * http://tools.ietf.org/html/draft-stiemerling-rtsp-announce-00
178 * for a complete list of supported values. */
181 /** The "reason" is meant to specify better the meaning of the error code
187 * Content type header
189 char content_type[64];
193 * Client state, i.e. whether we are currently receiving data (PLAYING) or
194 * setup-but-not-receiving (PAUSED). State can be changed in applications
195 * by calling av_read_play/pause().
197 enum RTSPClientState {
198 RTSP_STATE_IDLE, /**< not initialized */
199 RTSP_STATE_STREAMING, /**< initialized and sending/receiving data */
200 RTSP_STATE_PAUSED, /**< initialized, but not receiving data */
201 RTSP_STATE_SEEKING, /**< initialized, requesting a seek */
205 * Identify particular servers that require special handling, such as
206 * standards-incompliant "Transport:" lines in the SETUP request.
208 enum RTSPServerType {
209 RTSP_SERVER_RTP, /**< Standards-compliant RTP-server */
210 RTSP_SERVER_REAL, /**< Realmedia-style server */
211 RTSP_SERVER_WMS, /**< Windows Media server */
216 * Private data for the RTSP demuxer.
218 * @todo Use AVIOContext instead of URLContext
220 typedef struct RTSPState {
221 const AVClass *class; /**< Class for private options. */
222 URLContext *rtsp_hd; /* RTSP TCP connection handle */
224 /** number of items in the 'rtsp_streams' variable */
227 struct RTSPStream **rtsp_streams; /**< streams in this session */
229 /** indicator of whether we are currently receiving data from the
230 * server. Basically this isn't more than a simple cache of the
231 * last PLAY/PAUSE command sent to the server, to make sure we don't
232 * send 2x the same unexpectedly or commands in the wrong state. */
233 enum RTSPClientState state;
235 /** the seek value requested when calling av_seek_frame(). This value
236 * is subsequently used as part of the "Range" parameter when emitting
237 * the RTSP PLAY command. If we are currently playing, this command is
238 * called instantly. If we are currently paused, this command is called
239 * whenever we resume playback. Either way, the value is only used once,
240 * see rtsp_read_play() and rtsp_read_seek(). */
241 int64_t seek_timestamp;
243 int seq; /**< RTSP command sequence number */
245 /** copy of RTSPMessageHeader->session_id, i.e. the server-provided session
246 * identifier that the client should re-transmit in each RTSP command */
247 char session_id[512];
249 /** copy of RTSPMessageHeader->timeout, i.e. the time (in seconds) that
250 * the server will go without traffic on the RTSP/TCP line before it
251 * closes the connection. */
254 /** timestamp of the last RTSP command that we sent to the RTSP server.
255 * This is used to calculate when to send dummy commands to keep the
256 * connection alive, in conjunction with timeout. */
257 int64_t last_cmd_time;
259 /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
260 enum RTSPTransport transport;
262 /** the negotiated network layer transport protocol; e.g. TCP or UDP
264 enum RTSPLowerTransport lower_transport;
266 /** brand of server that we're talking to; e.g. WMS, REAL or other.
267 * Detected based on the value of RTSPMessageHeader->server or the presence
268 * of RTSPMessageHeader->real_challenge */
269 enum RTSPServerType server_type;
271 /** the "RealChallenge1:" field from the server */
272 char real_challenge[64];
274 /** plaintext authorization line (username:password) */
277 /** authentication state */
278 HTTPAuthState auth_state;
280 /** The last reply of the server to a RTSP command */
281 char last_reply[2048]; /* XXX: allocate ? */
283 /** RTSPStream->transport_priv of the last stream that we read a
285 void *cur_transport_priv;
287 /** The following are used for Real stream selection */
289 /** whether we need to send a "SET_PARAMETER Subscribe:" command */
290 int need_subscription;
292 /** stream setup during the last frame read. This is used to detect if
293 * we need to subscribe or unsubscribe to any new streams. */
294 enum AVDiscard *real_setup_cache;
296 /** current stream setup. This is a temporary buffer used to compare
297 * current setup to previous frame setup. */
298 enum AVDiscard *real_setup;
300 /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
301 * this is used to send the same "Unsubscribe:" if stream setup changed,
302 * before sending a new "Subscribe:" command. */
303 char last_subscription[1024];
306 /** The following are used for RTP/ASF streams */
308 /** ASF demuxer context for the embedded ASF stream from WMS servers */
309 AVFormatContext *asf_ctx;
311 /** cache for position of the asf demuxer, since we load a new
312 * data packet in the bytecontext for each incoming RTSP packet. */
316 /** some MS RTSP streams contain a URL in the SDP that we need to use
317 * for all subsequent RTSP requests, rather than the input URI; in
318 * other cases, this is a copy of AVFormatContext->filename. */
319 char control_uri[2048];
321 /** The following are used for parsing raw mpegts in udp */
323 struct MpegTSContext *ts;
328 /** Additional output handle, used when input and output are done
329 * separately, eg for HTTP tunneling. */
330 URLContext *rtsp_hd_out;
332 /** RTSP transport mode, such as plain or tunneled. */
333 enum RTSPControlTransport control_transport;
335 /* Number of RTCP BYE packets the RTSP session has received.
336 * An EOF is propagated back if nb_byes == nb_streams.
337 * This is reset after a seek. */
340 /** Reusable buffer for receiving packets */
344 * A mask with all requested transport methods
346 int lower_transport_mask;
349 * The number of returned packets
354 * Polling array for udp
360 * Whether the server supports the GET_PARAMETER method.
362 int get_parameter_supported;
365 * Do not begin to play the stream immediately.
370 * Option flags for the chained RTP muxer.
374 /** Whether the server accepts the x-Dynamic-Rate header */
375 int accept_dynamic_rate;
378 * Various option flags for the RTSP muxer/demuxer.
383 * Mask of all requested media types
388 * Minimum and maximum local UDP ports.
390 int rtp_port_min, rtp_port_max;
393 * Timeout to wait for incoming connections.
398 * timeout of socket i/o operations.
403 * Size of RTP packet reordering queue.
405 int reordering_queue_size;
412 char default_lang[4];
417 #define RTSP_FLAG_FILTER_SRC 0x1 /**< Filter incoming UDP packets -
418 receive packets only from the right
419 source address and port. */
420 #define RTSP_FLAG_LISTEN 0x2 /**< Wait for incoming connections. */
421 #define RTSP_FLAG_CUSTOM_IO 0x4 /**< Do all IO via the AVIOContext. */
422 #define RTSP_FLAG_RTCP_TO_SOURCE 0x8 /**< Send RTCP packets to the source
423 address of received packets. */
424 #define RTSP_FLAG_PREFER_TCP 0x10 /**< Try RTP via TCP first if possible. */
426 typedef struct RTSPSource {
427 char addr[128]; /**< Source-specific multicast include source IP address (from SDP content) */
431 * Describe a single stream, as identified by a single m= line block in the
432 * SDP content. In the case of RDT, one RTSPStream can represent multiple
433 * AVStreams. In this case, each AVStream in this set has similar content
434 * (but different codec/bitrate).
436 typedef struct RTSPStream {
437 URLContext *rtp_handle; /**< RTP stream handle (if UDP) */
438 void *transport_priv; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
440 /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
443 /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
444 * for the selected transport. Only used for TCP. */
445 int interleaved_min, interleaved_max;
447 char control_url[1024]; /**< url for this stream (from SDP) */
449 /** The following are used only in SDP, not RTSP */
451 int sdp_port; /**< port (from SDP content) */
452 struct sockaddr_storage sdp_ip; /**< IP address (from SDP content) */
453 int nb_include_source_addrs; /**< Number of source-specific multicast include source IP addresses (from SDP content) */
454 struct RTSPSource **include_source_addrs; /**< Source-specific multicast include source IP addresses (from SDP content) */
455 int nb_exclude_source_addrs; /**< Number of source-specific multicast exclude source IP addresses (from SDP content) */
456 struct RTSPSource **exclude_source_addrs; /**< Source-specific multicast exclude source IP addresses (from SDP content) */
457 int sdp_ttl; /**< IP Time-To-Live (from SDP content) */
458 int sdp_payload_type; /**< payload type */
461 /** The following are used for dynamic protocols (rtpdec_*.c/rdt.c) */
463 /** handler structure */
464 const RTPDynamicProtocolHandler *dynamic_handler;
466 /** private data associated with the dynamic protocol */
467 PayloadContext *dynamic_protocol_context;
470 /** Enable sending RTCP feedback messages according to RFC 4585 */
473 /** SSRC for this stream, to allow identifying RTCP packets before the first RTP packet */
476 char crypto_suite[40];
477 char crypto_params[100];
480 void ff_rtsp_parse_line(AVFormatContext *s,
481 RTSPMessageHeader *reply, const char *buf,
482 RTSPState *rt, const char *method);
485 * Send a command to the RTSP server without waiting for the reply.
487 * @see rtsp_send_cmd_with_content_async
489 int ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method,
490 const char *url, const char *headers);
493 * Send a command to the RTSP server and wait for the reply.
495 * @param s RTSP (de)muxer context
496 * @param method the method for the request
497 * @param url the target url for the request
498 * @param headers extra header lines to include in the request
499 * @param reply pointer where the RTSP message header will be stored
500 * @param content_ptr pointer where the RTSP message body, if any, will
501 * be stored (length is in reply)
502 * @param send_content if non-null, the data to send as request body content
503 * @param send_content_length the length of the send_content data, or 0 if
504 * send_content is null
506 * @return zero if success, nonzero otherwise
508 int ff_rtsp_send_cmd_with_content(AVFormatContext *s,
509 const char *method, const char *url,
511 RTSPMessageHeader *reply,
512 unsigned char **content_ptr,
513 const unsigned char *send_content,
514 int send_content_length);
517 * Send a command to the RTSP server and wait for the reply.
519 * @see rtsp_send_cmd_with_content
521 int ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
522 const char *url, const char *headers,
523 RTSPMessageHeader *reply, unsigned char **content_ptr);
526 * Read a RTSP message from the server, or prepare to read data
527 * packets if we're reading data interleaved over the TCP/RTSP
528 * connection as well.
530 * @param s RTSP (de)muxer context
531 * @param reply pointer where the RTSP message header will be stored
532 * @param content_ptr pointer where the RTSP message body, if any, will
533 * be stored (length is in reply)
534 * @param return_on_interleaved_data whether the function may return if we
535 * encounter a data marker ('$'), which precedes data
536 * packets over interleaved TCP/RTSP connections. If this
537 * is set, this function will return 1 after encountering
538 * a '$'. If it is not set, the function will skip any
539 * data packets (if they are encountered), until a reply
540 * has been fully parsed. If no more data is available
541 * without parsing a reply, it will return an error.
542 * @param method the RTSP method this is a reply to. This affects how
543 * some response headers are acted upon. May be NULL.
545 * @return 1 if a data packets is ready to be received, -1 on error,
548 int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
549 unsigned char **content_ptr,
550 int return_on_interleaved_data, const char *method);
553 * Skip a RTP/TCP interleaved packet.
555 void ff_rtsp_skip_packet(AVFormatContext *s);
558 * Connect to the RTSP server and set up the individual media streams.
559 * This can be used for both muxers and demuxers.
561 * @param s RTSP (de)muxer context
563 * @return 0 on success, < 0 on error. Cleans up all allocations done
564 * within the function on error.
566 int ff_rtsp_connect(AVFormatContext *s);
569 * Close and free all streams within the RTSP (de)muxer
571 * @param s RTSP (de)muxer context
573 void ff_rtsp_close_streams(AVFormatContext *s);
576 * Close all connection handles within the RTSP (de)muxer
578 * @param s RTSP (de)muxer context
580 void ff_rtsp_close_connections(AVFormatContext *s);
583 * Get the description of the stream and set up the RTSPStream child
586 int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply);
589 * Announce the stream to the server and set up the RTSPStream child
590 * objects for each media stream.
592 int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr);
595 * Parse RTSP commands (OPTIONS, PAUSE and TEARDOWN) during streaming in
598 int ff_rtsp_parse_streaming_commands(AVFormatContext *s);
601 * Parse an SDP description of streams by populating an RTSPState struct
602 * within the AVFormatContext; also allocate the RTP streams and the
603 * pollfd array used for UDP streams.
605 int ff_sdp_parse(AVFormatContext *s, const char *content);
608 * Receive one RTP packet from an TCP interleaved RTSP stream.
610 int ff_rtsp_tcp_read_packet(AVFormatContext *s, RTSPStream **prtsp_st,
611 uint8_t *buf, int buf_size);
614 * Send buffered packets over TCP.
616 int ff_rtsp_tcp_write_packet(AVFormatContext *s, RTSPStream *rtsp_st);
619 * Receive one packet from the RTSPStreams set up in the AVFormatContext
620 * (which should contain a RTSPState struct as priv_data).
622 int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt);
625 * Do the SETUP requests for each stream for the chosen
626 * lower transport mode.
627 * @return 0 on success, <0 on error, 1 if protocol is unavailable
629 int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
630 int lower_transport, const char *real_challenge);
633 * Undo the effect of ff_rtsp_make_setup_request, close the
634 * transport_priv and rtp_handle fields.
636 void ff_rtsp_undo_setup(AVFormatContext *s, int send_packets);
639 * Open RTSP transport context.
641 int ff_rtsp_open_transport_ctx(AVFormatContext *s, RTSPStream *rtsp_st);
643 extern const AVOption ff_rtsp_options[];
645 #endif /* AVFORMAT_RTSP_H */