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