FFmpeg
Loading...
Searching...
No Matches
rtsp.h
Go to the documentation of this file.
1/*
2 * RTSP definitions
3 * Copyright (c) 2002 Fabrice Bellard
4 *
5 * This file is part of FFmpeg.
6 *
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.
11 *
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.
16 *
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
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#include "internal.h"
31#include "os_support.h"
32
33#include "libavutil/log.h"
34#include "libavutil/opt.h"
35
36/**
37 * Network layer over which RTP/etc packet data will be transported.
38 */
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 */
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
51 on a flag. */
52};
53
54/**
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.
58 */
60 RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
61 RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
62 RTSP_TRANSPORT_RAW, /**< Raw data (over UDP) */
64};
65
66/**
67 * Transport mode for the RTSP data. This may be plain, or
68 * tunneled, which is done over HTTP.
69 */
71 RTSP_MODE_PLAIN, /**< Normal RTSP */
72 RTSP_MODE_TUNNEL /**< RTSP over HTTP (tunneling) */
73};
74
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
82
83/**
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.
89 */
90typedef 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
94 * this stream. */
96
97 /** UDP multicast port range; the ports to which we should connect to
98 * receive multicast UDP data. */
100
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. */
104
105 /** UDP unicast server port range; the ports to which we should connect
106 * to receive unicast UDP RTP/RTCP data. */
108
109 /** time-to-live value (required for multicast); the amount of HOPs that
110 * packets will be allowed to make before being discarded. */
111 int ttl;
112
113 /** transport set to record data */
115
116 struct sockaddr_storage destination; /**< destination IP address */
117 char source[INET6_ADDRSTRLEN + 1]; /**< source IP address */
118
119 /** data/packet transport protocol; e.g. RTP or RDT */
121
122 /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
125
126/**
127 * This describes the server response to each RTSP command.
128 */
129typedef struct RTSPMessageHeader {
130 /** length of the data following this header */
132
133 enum RTSPStatusCode status_code; /**< response code from server */
134
135 /** number of items in the 'transports' variable below */
137
138 /** Time range of the streams that the server will stream. In
139 * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
141
142 /** describes the complete "Transport:" line of the server in response
143 * to a SETUP RTSP command by the client */
145
146 int seq; /**< sequence number */
147
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];
151
152 /** the "Location:" field. This value is used to handle redirection.
153 */
154 char location[4096];
155
156 /** the "RealChallenge1:" field from the server */
158
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'. */
166 char server[64];
167
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. */
175
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. */
180
181 /** The "reason" is meant to specify better the meaning of the error code
182 * returned
183 */
184 char reason[256];
185
186 /**
187 * Content type header
188 */
189 char content_type[64];
190
191 /**
192 * SAT>IP com.ses.streamID header
193 */
194 char stream_id[64];
196
197/**
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().
201 */
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 */
207};
208
209/**
210 * Identify particular servers that require special handling, such as
211 * standards-incompliant "Transport:" lines in the SETUP request.
212 */
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 */
219};
220
221/**
222 * Private data for the RTSP demuxer.
223 *
224 * @todo Use AVIOContext instead of URLContext
225 */
226typedef struct RTSPState {
227 const AVClass *class; /**< Class for private options. */
228 URLContext *rtsp_hd; /* RTSP TCP connection handle */
229
230 /** number of items in the 'rtsp_streams' variable */
232
233 struct RTSPStream **rtsp_streams; /**< streams in this session */
234
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. */
240
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(). */
248
249 int seq; /**< RTSP command sequence number */
250
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];
254
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. */
259
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. */
264
265 /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
267
268 /** the negotiated network layer transport protocol; e.g. TCP or UDP
269 * uni-/multicast */
271
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 */
276
277 /** the "RealChallenge1:" field from the server */
279
280 /** plaintext authorization line (username:password) */
281 char auth[128];
282
283 /** authentication state */
285
286 /** The last reply of the server to a RTSP command */
287 char last_reply[2048]; /* XXX: allocate ? */
288
289 /**
290 * Stored message context
291 * This is used to store the last reply marked to be
292 * stored with ::ff_rtsp_send_cmd_with_content_async_stored
293 * as well as accompanying state to know when to store
294 * a reply and if a reply has been stored yet.
295 */
296 struct {
297 /**
298 * Sequence number of the reply to be stored
299 * -1 if we are not waiting to store any message
300 */
302 /** Last stored reply message from the RTSP server */
304 /** Last stored reply message body from the RTSP server */
305 unsigned char *body;
307
308 /** Indicates if a packet is pending to be read (useful for interleaved reads) */
310
311 /** RTSPStream->transport_priv of the last stream that we read a
312 * packet from */
314
315 /** The following are used for Real stream selection */
316 //@{
317 /** whether we need to send a "SET_PARAMETER Subscribe:" command */
319
320 /** stream setup during the last frame read. This is used to detect if
321 * we need to subscribe or unsubscribe to any new streams. */
323
324 /** current stream setup. This is a temporary buffer used to compare
325 * current setup to previous frame setup. */
327
328 /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
329 * this is used to send the same "Unsubscribe:" if stream setup changed,
330 * before sending a new "Subscribe:" command. */
332 //@}
333
334 /** The following are used for RTP/ASF streams */
335 //@{
336 /** ASF demuxer context for the embedded ASF stream from WMS servers */
338
339 /** cache for position of the asf demuxer, since we load a new
340 * data packet in the bytecontext for each incoming RTSP packet. */
341 uint64_t asf_pb_pos;
342 //@}
343
344 /** some MS RTSP streams contain a URL in the SDP that we need to use
345 * for all subsequent RTSP requests, rather than the input URI; in
346 * other cases, this is a copy of AVFormatContext->filename. */
348
349 /** The following are used for parsing raw mpegts in udp */
350 //@{
354 //@}
355
356 /** Additional output handle, used when input and output are done
357 * separately, eg for HTTP tunneling. */
359
360 /** RTSP transport mode, such as plain or tunneled. */
362
363 /* Number of RTCP BYE packets the RTSP session has received.
364 * An EOF is propagated back if nb_byes == nb_streams.
365 * This is reset after a seek. */
367
368 /** Reusable buffer for receiving packets */
369 uint8_t* recvbuf;
370
371 /**
372 * A mask with all requested transport methods
373 */
375
376 /**
377 * The number of returned packets
378 */
379 uint64_t packets;
380
381 /**
382 * Polling array for udp
383 */
384 struct pollfd *p;
385 int max_p;
386
387 /**
388 * Whether the server supports the GET_PARAMETER method.
389 */
391
392 /**
393 * Do not begin to play the stream immediately.
394 */
396
397 /**
398 * Option flags for the chained RTP muxer.
399 */
401
402 /** Whether the server accepts the x-Dynamic-Rate header */
404
405 /**
406 * Various option flags for the RTSP muxer/demuxer.
407 */
409
410 /**
411 * Mask of all requested media types
412 */
414
415 /**
416 * Minimum and maximum local UDP ports.
417 */
419
420 /**
421 * Timeout to wait for incoming connections.
422 */
424
425 /**
426 * timeout of socket i/o operations.
427 */
429
430 /**
431 * Size of RTP packet reordering queue.
432 */
434
435 /**
436 * User-Agent string
437 */
439
444
445 /**
446 * Options used for TLS based RTSP streams.
447 */
448 struct {
449 char *ca_file;
452 char *key_file;
453 char *host;
455} RTSPState;
456
457#define RTSP_FLAG_FILTER_SRC 0x1 /**< Filter incoming UDP packets -
458 receive packets only from the right
459 source address and port. */
460#define RTSP_FLAG_LISTEN 0x2 /**< Wait for incoming connections. */
461#define RTSP_FLAG_CUSTOM_IO 0x4 /**< Do all IO via the AVIOContext. */
462#define RTSP_FLAG_RTCP_TO_SOURCE 0x8 /**< Send RTCP packets to the source
463 address of received packets. */
464#define RTSP_FLAG_PREFER_TCP 0x10 /**< Try RTP via TCP first if possible. */
465#define RTSP_FLAG_SATIP_RAW 0x20 /**< Export SAT>IP stream as raw MPEG-TS */
466
467typedef struct RTSPSource {
468 char addr[128]; /**< Source-specific multicast include source IP address (from SDP content) */
469} RTSPSource;
470
471/**
472 * Describe a single stream, as identified by a single m= line block in the
473 * SDP content. In the case of RDT, one RTSPStream can represent multiple
474 * AVStreams. In this case, each AVStream in this set has similar content
475 * (but different codec/bitrate).
476 */
477typedef struct RTSPStream {
478 URLContext *rtp_handle; /**< RTP stream handle (if UDP) */
479 void *transport_priv; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
480
481 /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
483
484 /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
485 * for the selected transport. Only used for TCP. */
487
488 char control_url[MAX_URL_SIZE]; /**< url for this stream (from SDP) */
489
490 /** The following are used only in SDP, not RTSP */
491 //@{
492 int sdp_port; /**< port (from SDP content) */
493 struct sockaddr_storage sdp_ip; /**< IP address (from SDP content) */
494 int nb_include_source_addrs; /**< Number of source-specific multicast include source IP addresses (from SDP content) */
495 struct RTSPSource **include_source_addrs; /**< Source-specific multicast include source IP addresses (from SDP content) */
496 int nb_exclude_source_addrs; /**< Number of source-specific multicast exclude source IP addresses (from SDP content) */
497 struct RTSPSource **exclude_source_addrs; /**< Source-specific multicast exclude source IP addresses (from SDP content) */
498 int sdp_ttl; /**< IP Time-To-Live (from SDP content) */
499 int sdp_payload_type; /**< payload type */
500 //@}
501
502 /** The following are used for dynamic protocols (rtpdec_*.c/rdt.c) */
503 //@{
504 /** handler structure */
506
507 /** private data associated with the dynamic protocol */
509 //@}
510
511 /** Enable sending RTCP feedback messages according to RFC 4585 */
513
514 /** SSRC for this stream, to allow identifying RTCP packets before the first RTP packet */
515 uint32_t ssrc;
516
517 char crypto_suite[40];
518 char crypto_params[100];
519} RTSPStream;
520
522 RTSPMessageHeader *reply, const char *buf,
523 RTSPState *rt, const char *method);
524
525/**
526 * Send a command to the RTSP server without waiting for the reply.
527 *
528 * @see rtsp_send_cmd_with_content_async
529 */
530int ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method,
531 const char *url, const char *headers);
532
533/**
534 * Send a command to the RTSP server without waiting for the reply.
535 *
536 * @param s RTSP (de)muxer context
537 * @param method the method for the request
538 * @param url the target url for the request
539 * @param headers extra header lines to include in the request
540 * @param send_content if non-null, the data to send as request body content
541 * @param send_content_length the length of the send_content data, or 0 if
542 * send_content is null
543 *
544 * @return zero if success, nonzero otherwise
545 */
547 const char *method, const char *url,
548 const char *headers,
549 const unsigned char *send_content,
550 int send_content_length);
551
552/**
553 * Send a command to the RTSP server, storing the reply on future reads
554 *
555 * Sends a command to the server, without waiting for the reply and
556 * marking the request as awaiting a response, which will be stored
557 * when it is encountered during future read operations and should
558 * be retrieved with ::ff_rtsp_read_reply_async_stored.
559 *
560 * @param s RTSP (de)muxer context
561 * @param method the method for the request
562 * @param url the target url for the request
563 * @param headers extra header lines to include in the request
564 * @param send_content if non-null, the data to send as request body content
565 * @param send_content_length the length of the send_content data, or 0 if
566 * send_content is null
567 *
568 * @return zero if success, nonzero otherwise
569 */
571 const char *method, const char *url,
572 const char *headers,
573 const unsigned char *send_content,
574 int send_content_length);
575
576/**
577 * Send a command to the RTSP server and wait for the reply.
578 *
579 * @param s RTSP (de)muxer context
580 * @param method the method for the request
581 * @param url the target url for the request
582 * @param headers extra header lines to include in the request
583 * @param reply pointer where the RTSP message header will be stored
584 * @param content_ptr pointer where the RTSP message body, if any, will
585 * be stored (length is in reply)
586 * @param send_content if non-null, the data to send as request body content
587 * @param send_content_length the length of the send_content data, or 0 if
588 * send_content is null
589 *
590 * @return zero if success, nonzero otherwise
591 */
593 const char *method, const char *url,
594 const char *headers,
595 RTSPMessageHeader *reply,
596 unsigned char **content_ptr,
597 const unsigned char *send_content,
598 int send_content_length);
599
600/**
601 * Send a command to the RTSP server and wait for the reply.
602 *
603 * @see rtsp_send_cmd_with_content
604 */
605int ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
606 const char *url, const char *headers,
607 RTSPMessageHeader *reply, unsigned char **content_ptr);
608
609/**
610 * Read a RTSP message from the server, or prepare to read data
611 * packets if we're reading data interleaved over the TCP/RTSP
612 * connection as well.
613 *
614 * @param s RTSP (de)muxer context
615 * @param reply pointer where the RTSP message header will be stored
616 * @param content_ptr pointer where the RTSP message body, if any, will
617 * be stored (length is in reply)
618 * @param return_on_interleaved_data whether the function may return if we
619 * encounter a data marker ('$'), which precedes data
620 * packets over interleaved TCP/RTSP connections. If this
621 * is set, this function will return 1 after encountering
622 * a '$'. If it is not set, the function will skip any
623 * data packets (if they are encountered), until a reply
624 * has been fully parsed. If no more data is available
625 * without parsing a reply, it will return an error.
626 * @param method the RTSP method this is a reply to. This affects how
627 * some response headers are acted upon. May be NULL.
628 *
629 * @return 1 if a data packets is ready to be received, -1 on error,
630 * and 0 on success.
631 */
633 unsigned char **content_ptr,
634 int return_on_interleaved_data, const char *method);
635
636/**
637 * Retrieve a previously stored RTSP reply message from the server.
638 *
639 * Retrieves a reply for a message sent with
640 * ::ff_rtsp_send_cmd_with_content_async_stored previously.
641 * If more than one message was received, this function will only
642 * return the last one and intermediate messages are discarded.
643 *
644 * Both reply and content must be ::av_free'd by the caller.
645 *
646 * @param s RTSP (de)muxer context
647 * @param reply Pointer where the RTSP message header will be stored
648 * @param content_ptr Pointer where the RTSP message body, if any, will
649 * be stored (length is in reply)
650 *
651 * @return 0 on success, AVERROR(EAGAIN) if no reply was received yet,
652 * other AVERROR for any other errors.
653 */
655 unsigned char **content_ptr);
656
657
658/**
659 * Skip a RTP/TCP interleaved packet.
660 *
661 * @return 0 on success, < 0 on failure.
662 */
664
665/**
666 * Connect to the RTSP server and set up the individual media streams.
667 * This can be used for both muxers and demuxers.
668 *
669 * @param s RTSP (de)muxer context
670 *
671 * @return 0 on success, < 0 on error. Cleans up all allocations done
672 * within the function on error.
673 */
675
676/**
677 * Close and free all streams within the RTSP (de)muxer
678 *
679 * @param s RTSP (de)muxer context
680 */
682
683/**
684 * Close all connection handles within the RTSP (de)muxer
685 *
686 * @param s RTSP (de)muxer context
687 */
689
690/**
691 * Get the description of the stream and set up the RTSPStream child
692 * objects.
693 */
695
696/**
697 * Announce the stream to the server and set up the RTSPStream child
698 * objects for each media stream.
699 */
701
702/**
703 * Parse RTSP commands (OPTIONS, PAUSE and TEARDOWN) during streaming in
704 * listen mode.
705 */
707
708/**
709 * Parse an SDP description of streams by populating an RTSPState struct
710 * within the AVFormatContext; also allocate the RTP streams and the
711 * pollfd array used for UDP streams.
712 */
713int ff_sdp_parse(AVFormatContext *s, const char *content);
714
715/**
716 * Receive one RTP packet from an TCP interleaved RTSP stream.
717 */
719 uint8_t *buf, int buf_size);
720
721/**
722 * Send buffered packets over TCP.
723 */
725
726/**
727 * Receive one packet from the RTSPStreams set up in the AVFormatContext
728 * (which should contain a RTSPState struct as priv_data).
729 */
731
732/**
733 * Do the SETUP requests for each stream for the chosen
734 * lower transport mode.
735 * @return 0 on success, <0 on error, 1 if protocol is unavailable
736 */
737int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port,
738 int lower_transport, const char *real_challenge);
739
740/**
741 * Undo the effect of ff_rtsp_make_setup_request, close the
742 * transport_priv and rtp_handle fields.
743 */
744void ff_rtsp_undo_setup(AVFormatContext *s, int send_packets);
745
746/**
747 * Open RTSP transport context.
748 */
750
751extern const AVOption ff_rtsp_options[];
752
753#endif /* AVFORMAT_RTSP_H */
Main libavformat public API header.
#define s(width, name)
Definition cbs_vp9.c:198
long long int64_t
Definition coverity.c:34
static AVPacket * pkt
AVDiscard
Definition defs.h:223
#define MAX_URL_SIZE
Definition internal.h:30
#define INET6_ADDRSTRLEN
Definition network.h:237
AVOptions.
miscellaneous OS support macros and functions.
const AVOption ff_rtsp_options[]
Definition rtsp.c:87
int ff_sdp_parse(AVFormatContext *s, const char *content)
Parse an SDP description of streams by populating an RTSPState struct within the AVFormatContext; als...
RTSPServerType
Identify particular servers that require special handling, such as standards-incompliant "Transport:"...
Definition rtsp.h:213
@ RTSP_SERVER_NB
Definition rtsp.h:218
@ RTSP_SERVER_SATIP
SAT>IP server.
Definition rtsp.h:217
@ RTSP_SERVER_WMS
Windows Media server.
Definition rtsp.h:216
@ RTSP_SERVER_RTP
Standards-compliant RTP-server.
Definition rtsp.h:214
@ RTSP_SERVER_REAL
Realmedia-style server.
Definition rtsp.h:215
int ff_rtsp_send_cmd(AVFormatContext *s, const char *method, const char *url, const char *headers, RTSPMessageHeader *reply, unsigned char **content_ptr)
Send a command to the RTSP server and wait for the reply.
int ff_rtsp_send_cmd_with_content_async_stored(AVFormatContext *s, const char *method, const char *url, const char *headers, const unsigned char *send_content, int send_content_length)
Send a command to the RTSP server, storing the reply on future reads.
int ff_rtsp_setup_input_streams(AVFormatContext *s, RTSPMessageHeader *reply)
Get the description of the stream and set up the RTSPStream child objects.
Definition rtspdec.c:721
int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply, unsigned char **content_ptr, int return_on_interleaved_data, const char *method)
Read a RTSP message from the server, or prepare to read data packets if we're reading data interleave...
int ff_rtsp_make_setup_request(AVFormatContext *s, const char *host, int port, int lower_transport, const char *real_challenge)
Do the SETUP requests for each stream for the chosen lower transport mode.
int ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method, const char *url, const char *headers)
Send a command to the RTSP server without waiting for the reply.
int ff_rtsp_skip_packet(AVFormatContext *s)
Skip a RTP/TCP interleaved packet.
int ff_rtsp_open_transport_ctx(AVFormatContext *s, RTSPStream *rtsp_st)
Open RTSP transport context.
Definition rtsp.c:869
int ff_rtsp_fetch_packet(AVFormatContext *s, AVPacket *pkt)
Receive one packet from the RTSPStreams set up in the AVFormatContext (which should contain a RTSPSta...
#define RTSP_MAX_TRANSPORTS
Definition rtsp.h:77
void ff_rtsp_parse_line(AVFormatContext *s, RTSPMessageHeader *reply, const char *buf, RTSPState *rt, const char *method)
int ff_rtsp_send_cmd_with_content_async(AVFormatContext *s, const char *method, const char *url, const char *headers, const unsigned char *send_content, int send_content_length)
Send a command to the RTSP server without waiting for the reply.
RTSPLowerTransport
Network layer over which RTP/etc packet data will be transported.
Definition rtsp.h:39
@ RTSP_LOWER_TRANSPORT_TCP
TCP; interleaved in RTSP.
Definition rtsp.h:41
@ RTSP_LOWER_TRANSPORT_HTTP
HTTP tunneled - not a proper transport mode as such, only for use via AVOptions.
Definition rtsp.h:44
@ RTSP_LOWER_TRANSPORT_NB
Definition rtsp.h:43
@ RTSP_LOWER_TRANSPORT_UDP_MULTICAST
UDP/multicast.
Definition rtsp.h:42
@ RTSP_LOWER_TRANSPORT_CUSTOM
Custom IO - not a public option for lower_transport_mask, but set in the SDP demuxer based on a flag.
Definition rtsp.h:48
@ RTSP_LOWER_TRANSPORT_UDP
UDP/unicast.
Definition rtsp.h:40
@ RTSP_LOWER_TRANSPORT_HTTPS
HTTPS tunneled.
Definition rtsp.h:47
int ff_rtsp_parse_streaming_commands(AVFormatContext *s)
Parse RTSP commands (OPTIONS, PAUSE and TEARDOWN) during streaming in listen mode.
Definition rtspdec.c:486
RTSPControlTransport
Transport mode for the RTSP data.
Definition rtsp.h:70
@ RTSP_MODE_PLAIN
Normal RTSP.
Definition rtsp.h:71
@ RTSP_MODE_TUNNEL
RTSP over HTTP (tunneling)
Definition rtsp.h:72
int ff_rtsp_read_reply_async_stored(AVFormatContext *s, RTSPMessageHeader **reply, unsigned char **content_ptr)
Retrieve a previously stored RTSP reply message from the server.
void ff_rtsp_close_connections(AVFormatContext *s)
Close all connection handles within the RTSP (de)muxer.
RTSPClientState
Client state, i.e.
Definition rtsp.h:202
@ RTSP_STATE_SEEKING
initialized, requesting a seek
Definition rtsp.h:206
@ RTSP_STATE_STREAMING
initialized and sending/receiving data
Definition rtsp.h:204
@ RTSP_STATE_PAUSED
initialized, but not receiving data
Definition rtsp.h:205
@ RTSP_STATE_IDLE
not initialized
Definition rtsp.h:203
int ff_rtsp_send_cmd_with_content(AVFormatContext *s, const char *method, const char *url, const char *headers, RTSPMessageHeader *reply, unsigned char **content_ptr, const unsigned char *send_content, int send_content_length)
Send a command to the RTSP server and wait for the reply.
int ff_rtsp_tcp_write_packet(AVFormatContext *s, RTSPStream *rtsp_st)
Send buffered packets over TCP.
Definition rtspenc.c:143
void ff_rtsp_close_streams(AVFormatContext *s)
Close and free all streams within the RTSP (de)muxer.
Definition rtsp.c:833
int ff_rtsp_tcp_read_packet(AVFormatContext *s, RTSPStream **prtsp_st, uint8_t *buf, int buf_size)
Receive one RTP packet from an TCP interleaved RTSP stream.
Definition rtspdec.c:892
void ff_rtsp_undo_setup(AVFormatContext *s, int send_packets)
Undo the effect of ff_rtsp_make_setup_request, close the transport_priv and rtp_handle fields.
Definition rtsp.c:800
int ff_rtsp_connect(AVFormatContext *s)
Connect to the RTSP server and set up the individual media streams.
RTSPTransport
Packet profile of the data that we will be receiving.
Definition rtsp.h:59
@ RTSP_TRANSPORT_RTP
Standards-compliant RTP.
Definition rtsp.h:60
@ RTSP_TRANSPORT_RAW
Raw data (over UDP)
Definition rtsp.h:62
@ RTSP_TRANSPORT_NB
Definition rtsp.h:63
@ RTSP_TRANSPORT_RDT
Realmedia Data Transport.
Definition rtsp.h:61
int ff_rtsp_setup_output_streams(AVFormatContext *s, const char *addr)
Announce the stream to the server and set up the RTSPStream child objects for each media stream.
Definition rtspenc.c:47
RTSPStatusCode
RTSP handling.
Definition rtspcodes.h:31
Describe the class of an AVClass context structure.
Definition log.h:76
Format I/O context.
Definition avformat.h:1333
AVOption.
Definition opt.h:428
This structure stores compressed data.
Definition packet.h:580
HTTP Authentication state structure.
Definition httpauth.h:55
RTP/AV1 specific private data.
Definition rdt.c:85
This describes the server response to each RTSP command.
Definition rtsp.h:129
char reason[256]
The "reason" is meant to specify better the meaning of the error code returned.
Definition rtsp.h:184
char real_challenge[64]
the "RealChallenge1:" field from the server
Definition rtsp.h:157
char location[4096]
the "Location:" field.
Definition rtsp.h:154
int notice
The "Notice" or "X-Notice" field value.
Definition rtsp.h:179
int64_t range_start
Time range of the streams that the server will stream.
Definition rtsp.h:140
int timeout
The "timeout" comes as part of the server response to the "SETUP" command, in the "Session: <xyz>[;ti...
Definition rtsp.h:174
char session_id[512]
the "Session:" field.
Definition rtsp.h:150
char server[64]
the "Server: field, which can be used to identify some special-case servers that are not 100% standar...
Definition rtsp.h:166
enum RTSPStatusCode status_code
response code from server
Definition rtsp.h:133
int seq
sequence number
Definition rtsp.h:146
char content_type[64]
Content type header.
Definition rtsp.h:189
RTSPTransportField transports[RTSP_MAX_TRANSPORTS]
describes the complete "Transport:" line of the server in response to a SETUP RTSP command by the cli...
Definition rtsp.h:144
int64_t range_end
Definition rtsp.h:140
char stream_id[64]
SAT>IP com.ses.streamID header.
Definition rtsp.h:194
int nb_transports
number of items in the 'transports' variable below
Definition rtsp.h:136
int content_length
length of the data following this header
Definition rtsp.h:131
char addr[128]
Source-specific multicast include source IP address (from SDP content)
Definition rtsp.h:468
Private data for the RTSP demuxer.
Definition rtsp.h:226
RTSPMessageHeader * header
Last stored reply message from the RTSP server.
Definition rtsp.h:303
char real_challenge[64]
the "RealChallenge1:" field from the server
Definition rtsp.h:278
int recvbuf_len
Definition rtsp.h:353
int rtp_muxer_flags
Option flags for the chained RTP muxer.
Definition rtsp.h:400
int nb_rtsp_streams
number of items in the 'rtsp_streams' variable
Definition rtsp.h:231
enum RTSPTransport transport
the negotiated data/packet transport protocol; e.g.
Definition rtsp.h:266
int rtp_port_max
Definition rtsp.h:418
AVFormatContext * asf_ctx
The following are used for RTP/ASF streams.
Definition rtsp.h:337
char last_subscription[1024]
the last value of the "SET_PARAMETER Subscribe:" RTSP command.
Definition rtsp.h:331
int timeout
copy of RTSPMessageHeader->timeout, i.e.
Definition rtsp.h:258
struct RTSPState::@252032344213367267171314033051017303322026071151 tls_opts
Options used for TLS based RTSP streams.
int accept_dynamic_rate
Whether the server accepts the x-Dynamic-Rate header.
Definition rtsp.h:403
HTTPAuthState auth_state
authentication state
Definition rtsp.h:284
int64_t stimeout
timeout of socket i/o operations.
Definition rtsp.h:428
int initial_timeout
Timeout to wait for incoming connections.
Definition rtsp.h:423
URLContext * rtsp_hd_out
Additional output handle, used when input and output are done separately, eg for HTTP tunneling.
Definition rtsp.h:358
int lower_transport_mask
A mask with all requested transport methods.
Definition rtsp.h:374
enum AVDiscard * real_setup
current stream setup.
Definition rtsp.h:326
enum RTSPLowerTransport lower_transport
the negotiated network layer transport protocol; e.g.
Definition rtsp.h:270
int max_p
Definition rtsp.h:385
struct RTSPState::@211246031337226306262152230103102050134060150124 stored_msg
Stored message context This is used to store the last reply marked to be stored with ff_rtsp_send_cmd...
char * localaddr
Definition rtsp.h:443
uint64_t asf_pb_pos
cache for position of the asf demuxer, since we load a new data packet in the bytecontext for each in...
Definition rtsp.h:341
int64_t last_cmd_time
timestamp of the last RTSP command that we sent to the RTSP server.
Definition rtsp.h:263
int need_subscription
The following are used for Real stream selection.
Definition rtsp.h:318
char session_id[512]
copy of RTSPMessageHeader->session_id, i.e.
Definition rtsp.h:253
int media_type_mask
Mask of all requested media types.
Definition rtsp.h:413
int pending_packet
Indicates if a packet is pending to be read (useful for interleaved reads)
Definition rtsp.h:309
char * ca_file
Definition rtsp.h:449
struct MpegTSContext * ts
The following are used for parsing raw mpegts in udp.
Definition rtsp.h:351
enum RTSPServerType server_type
brand of server that we're talking to; e.g.
Definition rtsp.h:275
uint8_t * recvbuf
Reusable buffer for receiving packets.
Definition rtsp.h:369
char * user_agent
User-Agent string.
Definition rtsp.h:438
unsigned char * body
Last stored reply message body from the RTSP server.
Definition rtsp.h:305
int rtsp_flags
Various option flags for the RTSP muxer/demuxer.
Definition rtsp.h:408
int expected_seq
Sequence number of the reply to be stored -1 if we are not waiting to store any message.
Definition rtsp.h:301
int64_t seek_timestamp
the seek value requested when calling av_seek_frame().
Definition rtsp.h:247
char control_uri[MAX_URL_SIZE]
some MS RTSP streams contain a URL in the SDP that we need to use for all subsequent RTSP requests,...
Definition rtsp.h:347
char * cert_file
Definition rtsp.h:451
enum RTSPControlTransport control_transport
RTSP transport mode, such as plain or tunneled.
Definition rtsp.h:361
void * cur_transport_priv
RTSPStream->transport_priv of the last stream that we read a packet from.
Definition rtsp.h:313
int buffer_size
Definition rtsp.h:441
int reordering_queue_size
Size of RTP packet reordering queue.
Definition rtsp.h:433
char * host
Definition rtsp.h:453
char auth[128]
plaintext authorization line (username:password)
Definition rtsp.h:281
URLContext * rtsp_hd
Definition rtsp.h:228
int rtp_port_min
Minimum and maximum local UDP ports.
Definition rtsp.h:418
uint64_t packets
The number of returned packets.
Definition rtsp.h:379
enum RTSPClientState state
indicator of whether we are currently receiving data from the server.
Definition rtsp.h:239
int recvbuf_pos
Definition rtsp.h:352
enum AVDiscard * real_setup_cache
stream setup during the last frame read.
Definition rtsp.h:322
char * key_file
Definition rtsp.h:452
int initial_pause
Do not begin to play the stream immediately.
Definition rtsp.h:395
int seq
RTSP command sequence number.
Definition rtsp.h:249
int verify
Definition rtsp.h:450
int pkt_size
Definition rtsp.h:442
int nb_byes
Definition rtsp.h:366
struct RTSPStream ** rtsp_streams
streams in this session
Definition rtsp.h:233
char default_lang[4]
Definition rtsp.h:440
struct pollfd * p
Polling array for udp.
Definition rtsp.h:384
int get_parameter_supported
Whether the server supports the GET_PARAMETER method.
Definition rtsp.h:390
char last_reply[2048]
The last reply of the server to a RTSP command.
Definition rtsp.h:287
Describe a single stream, as identified by a single m= line block in the SDP content.
Definition rtsp.h:477
struct RTSPSource ** exclude_source_addrs
Source-specific multicast exclude source IP addresses (from SDP content)
Definition rtsp.h:497
char crypto_suite[40]
Definition rtsp.h:517
int sdp_ttl
IP Time-To-Live (from SDP content)
Definition rtsp.h:498
const RTPDynamicProtocolHandler * dynamic_handler
The following are used for dynamic protocols (rtpdec_*.c/rdt.c)
Definition rtsp.h:505
int sdp_port
The following are used only in SDP, not RTSP.
Definition rtsp.h:492
int nb_include_source_addrs
Number of source-specific multicast include source IP addresses (from SDP content)
Definition rtsp.h:494
char crypto_params[100]
Definition rtsp.h:518
int interleaved_min
interleave IDs; copies of RTSPTransportField->interleaved_min/max for the selected transport.
Definition rtsp.h:486
char control_url[MAX_URL_SIZE]
url for this stream (from SDP)
Definition rtsp.h:488
int sdp_payload_type
payload type
Definition rtsp.h:499
URLContext * rtp_handle
RTP stream handle (if UDP)
Definition rtsp.h:478
int interleaved_max
Definition rtsp.h:486
int stream_index
corresponding stream index, if any.
Definition rtsp.h:482
struct RTSPSource ** include_source_addrs
Source-specific multicast include source IP addresses (from SDP content)
Definition rtsp.h:495
int feedback
Enable sending RTCP feedback messages according to RFC 4585.
Definition rtsp.h:512
PayloadContext * dynamic_protocol_context
private data associated with the dynamic protocol
Definition rtsp.h:508
void * transport_priv
RTP/RDT parse context if input, RTP AVFormatContext if output.
Definition rtsp.h:479
uint32_t ssrc
SSRC for this stream, to allow identifying RTCP packets before the first RTP packet.
Definition rtsp.h:515
int nb_exclude_source_addrs
Number of source-specific multicast exclude source IP addresses (from SDP content)
Definition rtsp.h:496
struct sockaddr_storage sdp_ip
IP address (from SDP content)
Definition rtsp.h:493
This describes a single item in the "Transport:" line of one stream as negotiated by the SETUP RTSP c...
Definition rtsp.h:90
int server_port_min
UDP unicast server port range; the ports to which we should connect to receive unicast UDP RTP/RTCP d...
Definition rtsp.h:107
int interleaved_max
Definition rtsp.h:95
int client_port_min
UDP client ports; these should be the local ports of the UDP RTP (and RTCP) sockets over which we rec...
Definition rtsp.h:103
char source[INET6_ADDRSTRLEN+1]
source IP address
Definition rtsp.h:117
enum RTSPTransport transport
data/packet transport protocol; e.g.
Definition rtsp.h:120
int mode_record
transport set to record data
Definition rtsp.h:114
struct sockaddr_storage destination
destination IP address
Definition rtsp.h:116
int ttl
time-to-live value (required for multicast); the amount of HOPs that packets will be allowed to make ...
Definition rtsp.h:111
int client_port_max
Definition rtsp.h:103
enum RTSPLowerTransport lower_transport
network layer transport protocol; e.g.
Definition rtsp.h:123
int port_min
UDP multicast port range; the ports to which we should connect to receive multicast UDP data.
Definition rtsp.h:99
int interleaved_min
interleave ids, if TCP transport; each TCP/RTSP data packet starts with a '$', stream length and stre...
Definition rtsp.h:95
int server_port_max
Definition rtsp.h:107