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