c08aaa6aca9341f010f53a1e352a4bbc0a879dd8
[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 RTSP_H
22 #define RTSP_H
23
24 /* RTSP handling */
25 enum RTSPStatusCode {
26 #define DEF(n, c, s) c = n,
27 #include "rtspcodes.h"
28 #undef DEF
29 };
30
31 enum RTSPProtocol {
32     RTSP_PROTOCOL_RTP_UDP = 0,
33     RTSP_PROTOCOL_RTP_TCP = 1,
34     RTSP_PROTOCOL_RTP_UDP_MULTICAST = 2,
35 };
36
37 #define RTSP_DEFAULT_PORT   554
38 #define RTSP_MAX_TRANSPORTS 8
39 #define RTSP_TCP_MAX_PACKET_SIZE 1472
40 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
41 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
42 #define RTSP_RTP_PORT_MIN 5000
43 #define RTSP_RTP_PORT_MAX 10000
44
45 typedef struct RTSPTransportField {
46     int interleaved_min, interleaved_max;  /* interleave ids, if TCP transport */
47     int port_min, port_max; /* RTP ports */
48     int client_port_min, client_port_max; /* RTP ports */
49     int server_port_min, server_port_max; /* RTP ports */
50     int ttl; /* ttl value */
51     uint32_t destination; /* destination IP address */
52     enum RTSPProtocol protocol;
53 } RTSPTransportField;
54
55 typedef struct RTSPHeader {
56     int content_length;
57     enum RTSPStatusCode status_code; /* response code from server */
58     int nb_transports;
59     /* in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
60     int64_t range_start, range_end;
61     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
62     int seq; /* sequence number */
63     char session_id[512];
64 } RTSPHeader;
65
66 /* the callback can be used to extend the connection setup/teardown step */
67 enum RTSPCallbackAction {
68     RTSP_ACTION_SERVER_SETUP,
69     RTSP_ACTION_SERVER_TEARDOWN,
70     RTSP_ACTION_CLIENT_SETUP,
71     RTSP_ACTION_CLIENT_TEARDOWN,
72 };
73
74 typedef struct RTSPActionServerSetup {
75     uint32_t ipaddr;
76     char transport_option[512];
77 } RTSPActionServerSetup;
78
79 typedef int FFRTSPCallback(enum RTSPCallbackAction action,
80                            const char *session_id,
81                            char *buf, int buf_size,
82                            void *arg);
83
84 void rtsp_set_callback(FFRTSPCallback *rtsp_cb);
85
86 int rtsp_init(void);
87 void rtsp_parse_line(RTSPHeader *reply, const char *buf);
88
89 extern int rtsp_default_protocols;
90 extern int rtsp_rtp_port_min;
91 extern int rtsp_rtp_port_max;
92 extern FFRTSPCallback *ff_rtsp_callback;
93 extern AVInputFormat rtsp_demuxer;
94
95 int rtsp_pause(AVFormatContext *s);
96 int rtsp_resume(AVFormatContext *s);
97
98 #endif /* RTSP_H */