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