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 "os_support.h"
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
37 * Network layer over which RTP/etc packet data will be transported.
39 enum RTSPLowerTransport
{
40 RTSP_LOWER_TRANSPORT_UDP
= 0, /**< UDP/unicast */
41 RTSP_LOWER_TRANSPORT_TCP
= 1, /**< TCP; interleaved in RTSP */
42 RTSP_LOWER_TRANSPORT_UDP_MULTICAST
= 2, /**< UDP/multicast */
43 RTSP_LOWER_TRANSPORT_NB
,
44 RTSP_LOWER_TRANSPORT_HTTP
= 8, /**< HTTP tunneled - not a proper
45 transport mode as such,
46 only for use via AVOptions */
47 RTSP_LOWER_TRANSPORT_HTTPS
, /**< HTTPS tunneled */
48 RTSP_LOWER_TRANSPORT_CUSTOM
= 16, /**< Custom IO - not a public
49 option for lower_transport_mask,
50 but set in the SDP demuxer based
55 * Packet profile of the data that we will be receiving. Real servers
56 * commonly send RDT (although they can sometimes send RTP as well),
57 * whereas most others will send RTP.
60 RTSP_TRANSPORT_RTP
, /**< Standards-compliant RTP */
61 RTSP_TRANSPORT_RDT
, /**< Realmedia Data Transport */
62 RTSP_TRANSPORT_RAW
, /**< Raw data (over UDP) */
67 * Transport mode for the RTSP data. This may be plain, or
68 * tunneled, which is done over HTTP.
70 enum RTSPControlTransport
{
71 RTSP_MODE_PLAIN
, /**< Normal RTSP */
72 RTSP_MODE_TUNNEL
/**< RTSP over HTTP (tunneling) */
75 #define RTSP_DEFAULT_PORT 554
76 #define RTSPS_DEFAULT_PORT 322
77 #define RTSP_MAX_TRANSPORTS 8
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];
192 * SAT>IP com.ses.streamID header
198 * Client state, i.e. whether we are currently receiving data (PLAYING) or
199 * setup-but-not-receiving (PAUSED). State can be changed in applications
200 * by calling av_read_play/pause().
202 enum RTSPClientState
{
203 RTSP_STATE_IDLE
, /**< not initialized */
204 RTSP_STATE_STREAMING
, /**< initialized and sending/receiving data */
205 RTSP_STATE_PAUSED
, /**< initialized, but not receiving data */
206 RTSP_STATE_SEEKING
, /**< initialized, requesting a seek */
210 * Identify particular servers that require special handling, such as
211 * standards-incompliant "Transport:" lines in the SETUP request.
213 enum RTSPServerType
{
214 RTSP_SERVER_RTP
, /**< Standards-compliant RTP-server */
215 RTSP_SERVER_REAL
, /**< Realmedia-style server */
216 RTSP_SERVER_WMS
, /**< Windows Media server */
217 RTSP_SERVER_SATIP
,/**< SAT>IP server */
222 * Private data for the RTSP demuxer.
224 * @todo Use AVIOContext instead of URLContext
226 typedef struct RTSPState
{
227 const AVClass
*class; /**< Class for private options. */
228 URLContext
*rtsp_hd
; /* RTSP TCP connection handle */
230 /** number of items in the 'rtsp_streams' variable */
233 struct RTSPStream
**rtsp_streams
; /**< streams in this session */
235 /** indicator of whether we are currently receiving data from the
236 * server. Basically this isn't more than a simple cache of the
237 * last PLAY/PAUSE command sent to the server, to make sure we don't
238 * send 2x the same unexpectedly or commands in the wrong state. */
239 enum RTSPClientState state
;
241 /** the seek value requested when calling av_seek_frame(). This value
242 * is subsequently used as part of the "Range" parameter when emitting
243 * the RTSP PLAY command. If we are currently playing, this command is
244 * called instantly. If we are currently paused, this command is called
245 * whenever we resume playback. Either way, the value is only used once,
246 * see rtsp_read_play() and rtsp_read_seek(). */
247 int64_t seek_timestamp
;
249 int seq
; /**< RTSP command sequence number */
251 /** copy of RTSPMessageHeader->session_id, i.e. the server-provided session
252 * identifier that the client should re-transmit in each RTSP command */
253 char session_id
[512];
255 /** copy of RTSPMessageHeader->timeout, i.e. the time (in seconds) that
256 * the server will go without traffic on the RTSP/TCP line before it
257 * closes the connection. */
260 /** timestamp of the last RTSP command that we sent to the RTSP server.
261 * This is used to calculate when to send dummy commands to keep the
262 * connection alive, in conjunction with timeout. */
263 int64_t last_cmd_time
;
265 /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
266 enum RTSPTransport transport
;
268 /** the negotiated network layer transport protocol; e.g. TCP or UDP
270 enum RTSPLowerTransport lower_transport
;
272 /** brand of server that we're talking to; e.g. WMS, REAL or other.
273 * Detected based on the value of RTSPMessageHeader->server or the presence
274 * of RTSPMessageHeader->real_challenge */
275 enum RTSPServerType server_type
;
277 /** the "RealChallenge1:" field from the server */
278 char real_challenge
[64];
280 /** plaintext authorization line (username:password) */
283 /** authentication state */
284 HTTPAuthState auth_state
;
286 /** The last reply of the server to a RTSP command */
287 char last_reply
[2048]; /* XXX: allocate ? */
289 /** RTSPStream->transport_priv of the last stream that we read a
291 void *cur_transport_priv
;
293 /** The following are used for Real stream selection */
295 /** whether we need to send a "SET_PARAMETER Subscribe:" command */
296 int need_subscription
;
298 /** stream setup during the last frame read. This is used to detect if
299 * we need to subscribe or unsubscribe to any new streams. */
300 enum AVDiscard
*real_setup_cache
;
302 /** current stream setup. This is a temporary buffer used to compare
303 * current setup to previous frame setup. */
304 enum AVDiscard
*real_setup
;
306 /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
307 * this is used to send the same "Unsubscribe:" if stream setup changed,
308 * before sending a new "Subscribe:" command. */
309 char last_subscription
[1024];
312 /** The following are used for RTP/ASF streams */
314 /** ASF demuxer context for the embedded ASF stream from WMS servers */
315 AVFormatContext
*asf_ctx
;
317 /** cache for position of the asf demuxer, since we load a new
318 * data packet in the bytecontext for each incoming RTSP packet. */
322 /** some MS RTSP streams contain a URL in the SDP that we need to use
323 * for all subsequent RTSP requests, rather than the input URI; in
324 * other cases, this is a copy of AVFormatContext->filename. */
325 char control_uri
[MAX_URL_SIZE
];
327 /** The following are used for parsing raw mpegts in udp */
329 struct MpegTSContext
*ts
;
334 /** Additional output handle, used when input and output are done
335 * separately, eg for HTTP tunneling. */
336 URLContext
*rtsp_hd_out
;
338 /** RTSP transport mode, such as plain or tunneled. */
339 enum RTSPControlTransport control_transport
;
341 /* Number of RTCP BYE packets the RTSP session has received.
342 * An EOF is propagated back if nb_byes == nb_streams.
343 * This is reset after a seek. */
346 /** Reusable buffer for receiving packets */
350 * A mask with all requested transport methods
352 int lower_transport_mask
;
355 * The number of returned packets
360 * Polling array for udp
366 * Whether the server supports the GET_PARAMETER method.
368 int get_parameter_supported
;
371 * Do not begin to play the stream immediately.
376 * Option flags for the chained RTP muxer.
380 /** Whether the server accepts the x-Dynamic-Rate header */
381 int accept_dynamic_rate
;
384 * Various option flags for the RTSP muxer/demuxer.
389 * Mask of all requested media types
394 * Minimum and maximum local UDP ports.
396 int rtp_port_min
, rtp_port_max
;
399 * Timeout to wait for incoming connections.
404 * timeout of socket i/o operations.
409 * Size of RTP packet reordering queue.
411 int reordering_queue_size
;
418 char default_lang
[4];
424 * Options used for TLS based RTSP streams.
435 #define RTSP_FLAG_FILTER_SRC 0x1 /**< Filter incoming UDP packets -
436 receive packets only from the right
437 source address and port. */
438 #define RTSP_FLAG_LISTEN 0x2 /**< Wait for incoming connections. */
439 #define RTSP_FLAG_CUSTOM_IO 0x4 /**< Do all IO via the AVIOContext. */
440 #define RTSP_FLAG_RTCP_TO_SOURCE 0x8 /**< Send RTCP packets to the source
441 address of received packets. */
442 #define RTSP_FLAG_PREFER_TCP 0x10 /**< Try RTP via TCP first if possible. */
443 #define RTSP_FLAG_SATIP_RAW 0x20 /**< Export SAT>IP stream as raw MPEG-TS */
445 typedef struct RTSPSource
{
446 char addr
[128]; /**< Source-specific multicast include source IP address (from SDP content) */
450 * Describe a single stream, as identified by a single m= line block in the
451 * SDP content. In the case of RDT, one RTSPStream can represent multiple
452 * AVStreams. In this case, each AVStream in this set has similar content
453 * (but different codec/bitrate).
455 typedef struct RTSPStream
{
456 URLContext
*rtp_handle
; /**< RTP stream handle (if UDP) */
457 void *transport_priv
; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
459 /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
462 /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
463 * for the selected transport. Only used for TCP. */
464 int interleaved_min
, interleaved_max
;
466 char control_url
[MAX_URL_SIZE
]; /**< url for this stream (from SDP) */
468 /** The following are used only in SDP, not RTSP */
470 int sdp_port
; /**< port (from SDP content) */
471 struct sockaddr_storage sdp_ip
; /**< IP address (from SDP content) */
472 int nb_include_source_addrs
; /**< Number of source-specific multicast include source IP addresses (from SDP content) */
473 struct RTSPSource
**include_source_addrs
; /**< Source-specific multicast include source IP addresses (from SDP content) */
474 int nb_exclude_source_addrs
; /**< Number of source-specific multicast exclude source IP addresses (from SDP content) */
475 struct RTSPSource
**exclude_source_addrs
; /**< Source-specific multicast exclude source IP addresses (from SDP content) */
476 int sdp_ttl
; /**< IP Time-To-Live (from SDP content) */
477 int sdp_payload_type
; /**< payload type */
480 /** The following are used for dynamic protocols (rtpdec_*.c/rdt.c) */
482 /** handler structure */
483 const RTPDynamicProtocolHandler
*dynamic_handler
;
485 /** private data associated with the dynamic protocol */
486 PayloadContext
*dynamic_protocol_context
;
489 /** Enable sending RTCP feedback messages according to RFC 4585 */
492 /** SSRC for this stream, to allow identifying RTCP packets before the first RTP packet */
495 char crypto_suite
[40];
496 char crypto_params
[100];
499 void ff_rtsp_parse_line(AVFormatContext
*s
,
500 RTSPMessageHeader
*reply
, const char *buf
,
501 RTSPState
*rt
, const char *method
);
504 * Send a command to the RTSP server without waiting for the reply.
506 * @see rtsp_send_cmd_with_content_async
508 int ff_rtsp_send_cmd_async(AVFormatContext
*s
, const char *method
,
509 const char *url
, const char *headers
);
512 * Send a command to the RTSP server and wait for the reply.
514 * @param s RTSP (de)muxer context
515 * @param method the method for the request
516 * @param url the target url for the request
517 * @param headers extra header lines to include in the request
518 * @param reply pointer where the RTSP message header will be stored
519 * @param content_ptr pointer where the RTSP message body, if any, will
520 * be stored (length is in reply)
521 * @param send_content if non-null, the data to send as request body content
522 * @param send_content_length the length of the send_content data, or 0 if
523 * send_content is null
525 * @return zero if success, nonzero otherwise
527 int ff_rtsp_send_cmd_with_content(AVFormatContext
*s
,
528 const char *method
, const char *url
,
530 RTSPMessageHeader
*reply
,
531 unsigned char **content_ptr
,
532 const unsigned char *send_content
,
533 int send_content_length
);
536 * Send a command to the RTSP server and wait for the reply.
538 * @see rtsp_send_cmd_with_content
540 int ff_rtsp_send_cmd(AVFormatContext
*s
, const char *method
,
541 const char *url
, const char *headers
,
542 RTSPMessageHeader
*reply
, unsigned char **content_ptr
);
545 * Read a RTSP message from the server, or prepare to read data
546 * packets if we're reading data interleaved over the TCP/RTSP
547 * connection as well.
549 * @param s RTSP (de)muxer context
550 * @param reply pointer where the RTSP message header will be stored
551 * @param content_ptr pointer where the RTSP message body, if any, will
552 * be stored (length is in reply)
553 * @param return_on_interleaved_data whether the function may return if we
554 * encounter a data marker ('$'), which precedes data
555 * packets over interleaved TCP/RTSP connections. If this
556 * is set, this function will return 1 after encountering
557 * a '$'. If it is not set, the function will skip any
558 * data packets (if they are encountered), until a reply
559 * has been fully parsed. If no more data is available
560 * without parsing a reply, it will return an error.
561 * @param method the RTSP method this is a reply to. This affects how
562 * some response headers are acted upon. May be NULL.
564 * @return 1 if a data packets is ready to be received, -1 on error,
567 int ff_rtsp_read_reply(AVFormatContext
*s
, RTSPMessageHeader
*reply
,
568 unsigned char **content_ptr
,
569 int return_on_interleaved_data
, const char *method
);
572 * Skip a RTP/TCP interleaved packet.
574 * @return 0 on success, < 0 on failure.
576 int ff_rtsp_skip_packet(AVFormatContext
*s
);
579 * Connect to the RTSP server and set up the individual media streams.
580 * This can be used for both muxers and demuxers.
582 * @param s RTSP (de)muxer context
584 * @return 0 on success, < 0 on error. Cleans up all allocations done
585 * within the function on error.
587 int ff_rtsp_connect(AVFormatContext
*s
);
590 * Close and free all streams within the RTSP (de)muxer
592 * @param s RTSP (de)muxer context
594 void ff_rtsp_close_streams(AVFormatContext
*s
);
597 * Close all connection handles within the RTSP (de)muxer
599 * @param s RTSP (de)muxer context
601 void ff_rtsp_close_connections(AVFormatContext
*s
);
604 * Get the description of the stream and set up the RTSPStream child
607 int ff_rtsp_setup_input_streams(AVFormatContext
*s
, RTSPMessageHeader
*reply
);
610 * Announce the stream to the server and set up the RTSPStream child
611 * objects for each media stream.
613 int ff_rtsp_setup_output_streams(AVFormatContext
*s
, const char *addr
);
616 * Parse RTSP commands (OPTIONS, PAUSE and TEARDOWN) during streaming in
619 int ff_rtsp_parse_streaming_commands(AVFormatContext
*s
);
622 * Parse an SDP description of streams by populating an RTSPState struct
623 * within the AVFormatContext; also allocate the RTP streams and the
624 * pollfd array used for UDP streams.
626 int ff_sdp_parse(AVFormatContext
*s
, const char *content
);
629 * Receive one RTP packet from an TCP interleaved RTSP stream.
631 int ff_rtsp_tcp_read_packet(AVFormatContext
*s
, RTSPStream
**prtsp_st
,
632 uint8_t *buf
, int buf_size
);
635 * Send buffered packets over TCP.
637 int ff_rtsp_tcp_write_packet(AVFormatContext
*s
, RTSPStream
*rtsp_st
);
640 * Receive one packet from the RTSPStreams set up in the AVFormatContext
641 * (which should contain a RTSPState struct as priv_data).
643 int ff_rtsp_fetch_packet(AVFormatContext
*s
, AVPacket
*pkt
);
646 * Do the SETUP requests for each stream for the chosen
647 * lower transport mode.
648 * @return 0 on success, <0 on error, 1 if protocol is unavailable
650 int ff_rtsp_make_setup_request(AVFormatContext
*s
, const char *host
, int port
,
651 int lower_transport
, const char *real_challenge
);
654 * Undo the effect of ff_rtsp_make_setup_request, close the
655 * transport_priv and rtp_handle fields.
657 void ff_rtsp_undo_setup(AVFormatContext
*s
, int send_packets
);
660 * Open RTSP transport context.
662 int ff_rtsp_open_transport_ctx(AVFormatContext
*s
, RTSPStream
*rtsp_st
);
664 extern const AVOption ff_rtsp_options
[];
666 #endif /* AVFORMAT_RTSP_H */