Add separate method/url parameters to the rtsp_send_cmd functions
[ffmpeg.git] / libavformat / rtsp.h
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
30 /**
31  * Network layer over which RTP/etc packet data will be transported.
32  */
33 enum RTSPLowerTransport {
34     RTSP_LOWER_TRANSPORT_UDP = 0,           /**< UDP/unicast */
35     RTSP_LOWER_TRANSPORT_TCP = 1,           /**< TCP; interleaved in RTSP */
36     RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2, /**< UDP/multicast */
37     RTSP_LOWER_TRANSPORT_NB
38 };
39
40 /**
41  * Packet profile of the data that we will be receiving. Real servers
42  * commonly send RDT (although they can sometimes send RTP as well),
43  * whereas most others will send RTP.
44  */
45 enum RTSPTransport {
46     RTSP_TRANSPORT_RTP, /**< Standards-compliant RTP */
47     RTSP_TRANSPORT_RDT, /**< Realmedia Data Transport */
48     RTSP_TRANSPORT_NB
49 };
50
51 #define RTSP_DEFAULT_PORT   554
52 #define RTSP_MAX_TRANSPORTS 8
53 #define RTSP_TCP_MAX_PACKET_SIZE 1472
54 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
55 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
56 #define RTSP_RTP_PORT_MIN 5000
57 #define RTSP_RTP_PORT_MAX 10000
58
59 /**
60  * This describes a single item in the "Transport:" line of one stream as
61  * negotiated by the SETUP RTSP command. Multiple transports are comma-
62  * separated ("Transport: x-read-rdt/tcp;interleaved=0-1,rtp/avp/udp;
63  * client_port=1000-1001;server_port=1800-1801") and described in separate
64  * RTSPTransportFields.
65  */
66 typedef struct RTSPTransportField {
67     /** interleave ids, if TCP transport; each TCP/RTSP data packet starts
68      * with a '$', stream length and stream ID. If the stream ID is within
69      * the range of this interleaved_min-max, then the packet belongs to
70      * this stream. */
71     int interleaved_min, interleaved_max;
72
73     /** UDP multicast port range; the ports to which we should connect to
74      * receive multicast UDP data. */
75     int port_min, port_max;
76
77     /** UDP client ports; these should be the local ports of the UDP RTP
78      * (and RTCP) sockets over which we receive RTP/RTCP data. */
79     int client_port_min, client_port_max;
80
81     /** UDP unicast server port range; the ports to which we should connect
82      * to receive unicast UDP RTP/RTCP data. */
83     int server_port_min, server_port_max;
84
85     /** time-to-live value (required for multicast); the amount of HOPs that
86      * packets will be allowed to make before being discarded. */
87     int ttl;
88
89     uint32_t destination; /**< destination IP address */
90
91     /** data/packet transport protocol; e.g. RTP or RDT */
92     enum RTSPTransport transport;
93
94     /** network layer transport protocol; e.g. TCP or UDP uni-/multicast */
95     enum RTSPLowerTransport lower_transport;
96 } RTSPTransportField;
97
98 /**
99  * This describes the server response to each RTSP command.
100  */
101 typedef struct RTSPMessageHeader {
102     /** length of the data following this header */
103     int content_length;
104
105     enum RTSPStatusCode status_code; /**< response code from server */
106
107     /** number of items in the 'transports' variable below */
108     int nb_transports;
109
110     /** Time range of the streams that the server will stream. In
111      * AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
112     int64_t range_start, range_end;
113
114     /** describes the complete "Transport:" line of the server in response
115      * to a SETUP RTSP command by the client */
116     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
117
118     int seq;                         /**< sequence number */
119
120     /** the "Session:" field. This value is initially set by the server and
121      * should be re-transmitted by the client in every RTSP command. */
122     char session_id[512];
123
124     /** the "Location:" field. This value is used to handle redirection.
125      */
126     char location[4096];
127
128     /** the "RealChallenge1:" field from the server */
129     char real_challenge[64];
130
131     /** the "Server: field, which can be used to identify some special-case
132      * servers that are not 100% standards-compliant. We use this to identify
133      * Windows Media Server, which has a value "WMServer/v.e.r.sion", where
134      * version is a sequence of digits (e.g. 9.0.0.3372). Helix/Real servers
135      * use something like "Helix [..] Server Version v.e.r.sion (platform)
136      * (RealServer compatible)" or "RealServer Version v.e.r.sion (platform)",
137      * where platform is the output of $uname -msr | sed 's/ /-/g'. */
138     char server[64];
139
140     /** The "timeout" comes as part of the server response to the "SETUP"
141      * command, in the "Session: <xyz>[;timeout=<value>]" line. It is the
142      * time, in seconds, that the server will go without traffic over the
143      * RTSP/TCP connection before it closes the connection. To prevent
144      * this, sent dummy requests (e.g. OPTIONS) with intervals smaller
145      * than this value. */
146     int timeout;
147
148     /** The "Notice" or "X-Notice" field value. See
149      * http://tools.ietf.org/html/draft-stiemerling-rtsp-announce-00
150      * for a complete list of supported values. */
151     int notice;
152 } RTSPMessageHeader;
153
154 /**
155  * Client state, i.e. whether we are currently receiving data (PLAYING) or
156  * setup-but-not-receiving (PAUSED). State can be changed in applications
157  * by calling av_read_play/pause().
158  */
159 enum RTSPClientState {
160     RTSP_STATE_IDLE,    /**< not initialized */
161     RTSP_STATE_STREAMING, /**< initialized and sending/receiving data */
162     RTSP_STATE_PAUSED,  /**< initialized, but not receiving data */
163     RTSP_STATE_SEEKING, /**< initialized, requesting a seek */
164 };
165
166 /**
167  * Identifies particular servers that require special handling, such as
168  * standards-incompliant "Transport:" lines in the SETUP request.
169  */
170 enum RTSPServerType {
171     RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
172     RTSP_SERVER_REAL, /**< Realmedia-style server */
173     RTSP_SERVER_WMS,  /**< Windows Media server */
174     RTSP_SERVER_NB
175 };
176
177 /**
178  * Private data for the RTSP demuxer.
179  *
180  * @todo Use ByteIOContext instead of URLContext
181  */
182 typedef struct RTSPState {
183     URLContext *rtsp_hd; /* RTSP TCP connexion handle */
184
185     /** number of items in the 'rtsp_streams' variable */
186     int nb_rtsp_streams;
187
188     struct RTSPStream **rtsp_streams; /**< streams in this session */
189
190     /** indicator of whether we are currently receiving data from the
191      * server. Basically this isn't more than a simple cache of the
192      * last PLAY/PAUSE command sent to the server, to make sure we don't
193      * send 2x the same unexpectedly or commands in the wrong state. */
194     enum RTSPClientState state;
195
196     /** the seek value requested when calling av_seek_frame(). This value
197      * is subsequently used as part of the "Range" parameter when emitting
198      * the RTSP PLAY command. If we are currently playing, this command is
199      * called instantly. If we are currently paused, this command is called
200      * whenever we resume playback. Either way, the value is only used once,
201      * see rtsp_read_play() and rtsp_read_seek(). */
202     int64_t seek_timestamp;
203
204     /* XXX: currently we use unbuffered input */
205     //    ByteIOContext rtsp_gb;
206
207     int seq;                          /**< RTSP command sequence number */
208
209     /** copy of RTSPMessageHeader->session_id, i.e. the server-provided session
210      * identifier that the client should re-transmit in each RTSP command */
211     char session_id[512];
212
213     /** copy of RTSPMessageHeader->timeout, i.e. the time (in seconds) that
214      * the server will go without traffic on the RTSP/TCP line before it
215      * closes the connection. */
216     int timeout;
217
218     /** timestamp of the last RTSP command that we sent to the RTSP server.
219      * This is used to calculate when to send dummy commands to keep the
220      * connection alive, in conjunction with timeout. */
221     int64_t last_cmd_time;
222
223     /** the negotiated data/packet transport protocol; e.g. RTP or RDT */
224     enum RTSPTransport transport;
225
226     /** the negotiated network layer transport protocol; e.g. TCP or UDP
227      * uni-/multicast */
228     enum RTSPLowerTransport lower_transport;
229
230     /** brand of server that we're talking to; e.g. WMS, REAL or other.
231      * Detected based on the value of RTSPMessageHeader->server or the presence
232      * of RTSPMessageHeader->real_challenge */
233     enum RTSPServerType server_type;
234
235     /** base64-encoded authorization lines (username:password) */
236     char *auth_b64;
237
238     /** The last reply of the server to a RTSP command */
239     char last_reply[2048]; /* XXX: allocate ? */
240
241     /** RTSPStream->transport_priv of the last stream that we read a
242      * packet from */
243     void *cur_transport_priv;
244
245     /** The following are used for Real stream selection */
246     //@{
247     /** whether we need to send a "SET_PARAMETER Subscribe:" command */
248     int need_subscription;
249
250     /** stream setup during the last frame read. This is used to detect if
251      * we need to subscribe or unsubscribe to any new streams. */
252     enum AVDiscard real_setup_cache[MAX_STREAMS];
253
254     /** the last value of the "SET_PARAMETER Subscribe:" RTSP command.
255      * this is used to send the same "Unsubscribe:" if stream setup changed,
256      * before sending a new "Subscribe:" command. */
257     char last_subscription[1024];
258     //@}
259
260     /** The following are used for RTP/ASF streams */
261     //@{
262     /** ASF demuxer context for the embedded ASF stream from WMS servers */
263     AVFormatContext *asf_ctx;
264
265     /** cache for position of the asf demuxer, since we load a new
266      * data packet in the bytecontext for each incoming RTSP packet. */
267     uint64_t asf_pb_pos;
268     //@}
269
270     /** some MS RTSP streams contain a URL in the SDP that we need to use
271      * for all subsequent RTSP requests, rather than the input URI; in
272      * other cases, this is a copy of AVFormatContext->filename. */
273     char control_uri[1024];
274
275     /** The synchronized start time of the output streams. */
276     int64_t start_time;
277 } RTSPState;
278
279 /**
280  * Describes a single stream, as identified by a single m= line block in the
281  * SDP content. In the case of RDT, one RTSPStream can represent multiple
282  * AVStreams. In this case, each AVStream in this set has similar content
283  * (but different codec/bitrate).
284  */
285 typedef struct RTSPStream {
286     URLContext *rtp_handle;   /**< RTP stream handle (if UDP) */
287     void *transport_priv; /**< RTP/RDT parse context if input, RTP AVFormatContext if output */
288
289     /** corresponding stream index, if any. -1 if none (MPEG2TS case) */
290     int stream_index;
291
292     /** interleave IDs; copies of RTSPTransportField->interleaved_min/max
293      * for the selected transport. Only used for TCP. */
294     int interleaved_min, interleaved_max;
295
296     char control_url[1024];   /**< url for this stream (from SDP) */
297
298     /** The following are used only in SDP, not RTSP */
299     //@{
300     int sdp_port;             /**< port (from SDP content) */
301     struct in_addr sdp_ip;    /**< IP address (from SDP content) */
302     int sdp_ttl;              /**< IP Time-To-Live (from SDP content) */
303     int sdp_payload_type;     /**< payload type */
304     //@}
305
306     /** rtp payload parsing infos from SDP (i.e. mapping between private
307      * payload IDs and media-types (string), so that we can derive what
308      * type of payload we're dealing with (and how to parse it). */
309     RTPPayloadData rtp_payload_data;
310
311     /** The following are used for dynamic protocols (rtp_*.c/rdt.c) */
312     //@{
313     /** handler structure */
314     RTPDynamicProtocolHandler *dynamic_handler;
315
316     /** private data associated with the dynamic protocol */
317     PayloadContext *dynamic_protocol_context;
318     //@}
319 } RTSPStream;
320
321 void ff_rtsp_parse_line(RTSPMessageHeader *reply, const char *buf);
322
323 #if LIBAVFORMAT_VERSION_INT < (53 << 16)
324 extern int rtsp_default_protocols;
325 #endif
326 extern int rtsp_rtp_port_min;
327 extern int rtsp_rtp_port_max;
328
329 /**
330  * Send a command to the RTSP server without waiting for the reply.
331  *
332  * @param s RTSP (de)muxer context
333  * @param method the method for the request
334  * @param url the target url for the request
335  * @param headers extra header lines to include in the request
336  * @param send_content if non-null, the data to send as request body content
337  * @param send_content_length the length of the send_content data, or 0 if
338  *                            send_content is null
339  */
340 void ff_rtsp_send_cmd_with_content_async(AVFormatContext *s,
341                                          const char *method, const char *url,
342                                          const char *headers,
343                                          const unsigned char *send_content,
344                                          int send_content_length);
345 /**
346  * Send a command to the RTSP server without waiting for the reply.
347  *
348  * @see rtsp_send_cmd_with_content_async
349  */
350 void ff_rtsp_send_cmd_async(AVFormatContext *s, const char *method,
351                             const char *url, const char *headers);
352
353 /**
354  * Send a command to the RTSP server and wait for the reply.
355  *
356  * @param s RTSP (de)muxer context
357  * @param method the method for the request
358  * @param url the target url for the request
359  * @param headers extra header lines to include in the request
360  * @param reply pointer where the RTSP message header will be stored
361  * @param content_ptr pointer where the RTSP message body, if any, will
362  *                    be stored (length is in reply)
363  * @param send_content if non-null, the data to send as request body content
364  * @param send_content_length the length of the send_content data, or 0 if
365  *                            send_content is null
366  */
367 void ff_rtsp_send_cmd_with_content(AVFormatContext *s,
368                                    const char *method, const char *url,
369                                    const char *headers,
370                                    RTSPMessageHeader *reply,
371                                    unsigned char **content_ptr,
372                                    const unsigned char *send_content,
373                                    int send_content_length);
374
375 /**
376  * Send a command to the RTSP server and wait for the reply.
377  *
378  * @see rtsp_send_cmd_with_content
379  */
380 void ff_rtsp_send_cmd(AVFormatContext *s, const char *method,
381                       const char *url, const char *headers,
382                       RTSPMessageHeader *reply, unsigned char **content_ptr);
383
384 /**
385  * Read a RTSP message from the server, or prepare to read data
386  * packets if we're reading data interleaved over the TCP/RTSP
387  * connection as well.
388  *
389  * @param s RTSP (de)muxer context
390  * @param reply pointer where the RTSP message header will be stored
391  * @param content_ptr pointer where the RTSP message body, if any, will
392  *                    be stored (length is in reply)
393  * @param return_on_interleaved_data whether the function may return if we
394  *                   encounter a data marker ('$'), which precedes data
395  *                   packets over interleaved TCP/RTSP connections. If this
396  *                   is set, this function will return 1 after encountering
397  *                   a '$'. If it is not set, the function will skip any
398  *                   data packets (if they are encountered), until a reply
399  *                   has been fully parsed. If no more data is available
400  *                   without parsing a reply, it will return an error.
401  *
402  * @returns 1 if a data packets is ready to be received, -1 on error,
403  *          and 0 on success.
404  */
405 int ff_rtsp_read_reply(AVFormatContext *s, RTSPMessageHeader *reply,
406                        unsigned char **content_ptr,
407                        int return_on_interleaved_data);
408
409 /**
410  * Skip a RTP/TCP interleaved packet.
411  */
412 void ff_rtsp_skip_packet(AVFormatContext *s);
413
414 /**
415  * Connect to the RTSP server and set up the individual media streams.
416  * This can be used for both muxers and demuxers.
417  *
418  * @param s RTSP (de)muxer context
419  *
420  * @returns 0 on success, < 0 on error. Cleans up all allocations done
421  *          within the function on error.
422  */
423 int ff_rtsp_connect(AVFormatContext *s);
424
425 /**
426  * Close and free all streams within the RTSP (de)muxer
427  *
428  * @param s RTSP (de)muxer context
429  */
430 void ff_rtsp_close_streams(AVFormatContext *s);
431
432 #endif /* AVFORMAT_RTSP_H */