COSMETICS: Remove all trailing whitespace.
[ffmpeg.git] / libavformat / rtsp.h
1 /*
2  * RTSP definitions
3  * Copyright (c) 2002 Fabrice Bellard.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  */
19 #ifndef RTSP_H
20 #define RTSP_H
21
22 /* RTSP handling */
23 enum RTSPStatusCode {
24 #define DEF(n, c, s) c = n,
25 #include "rtspcodes.h"
26 #undef DEF
27 };
28
29 enum RTSPProtocol {
30     RTSP_PROTOCOL_RTP_UDP = 0,
31     RTSP_PROTOCOL_RTP_TCP = 1,
32     RTSP_PROTOCOL_RTP_UDP_MULTICAST = 2,
33 };
34
35 #define RTSP_DEFAULT_PORT   554
36 #define RTSP_MAX_TRANSPORTS 8
37 #define RTSP_TCP_MAX_PACKET_SIZE 1472
38 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
39 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
40 #define RTSP_RTP_PORT_MIN 5000
41 #define RTSP_RTP_PORT_MAX 10000
42
43 typedef struct RTSPTransportField {
44     int interleaved_min, interleaved_max;  /* interleave ids, if TCP transport */
45     int port_min, port_max; /* RTP ports */
46     int client_port_min, client_port_max; /* RTP ports */
47     int server_port_min, server_port_max; /* RTP ports */
48     int ttl; /* ttl value */
49     uint32_t destination; /* destination IP address */
50     enum RTSPProtocol protocol;
51 } RTSPTransportField;
52
53 typedef struct RTSPHeader {
54     int content_length;
55     enum RTSPStatusCode status_code; /* response code from server */
56     int nb_transports;
57     /* in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
58     int64_t range_start, range_end;
59     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
60     int seq; /* sequence number */
61     char session_id[512];
62 } RTSPHeader;
63
64 /* the callback can be used to extend the connection setup/teardown step */
65 enum RTSPCallbackAction {
66     RTSP_ACTION_SERVER_SETUP,
67     RTSP_ACTION_SERVER_TEARDOWN,
68     RTSP_ACTION_CLIENT_SETUP,
69     RTSP_ACTION_CLIENT_TEARDOWN,
70 };
71
72 typedef struct RTSPActionServerSetup {
73     uint32_t ipaddr;
74     char transport_option[512];
75 } RTSPActionServerSetup;
76
77 typedef int FFRTSPCallback(enum RTSPCallbackAction action,
78                            const char *session_id,
79                            char *buf, int buf_size,
80                            void *arg);
81
82 void rtsp_set_callback(FFRTSPCallback *rtsp_cb);
83
84 int rtsp_init(void);
85 void rtsp_parse_line(RTSPHeader *reply, const char *buf);
86
87 extern int rtsp_default_protocols;
88 extern int rtsp_rtp_port_min;
89 extern int rtsp_rtp_port_max;
90 extern FFRTSPCallback *ff_rtsp_callback;
91 extern AVInputFormat rtsp_demux;
92
93 int rtsp_pause(AVFormatContext *s);
94 int rtsp_resume(AVFormatContext *s);
95
96 #endif /* RTSP_H */