48df0feac8e066b074528141ede41d8c59adf24a
[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 #include "rtpdec.h"
28 #include "network.h"
29
30 enum RTSPLowerTransport {
31     RTSP_LOWER_TRANSPORT_UDP = 0,
32     RTSP_LOWER_TRANSPORT_TCP = 1,
33     RTSP_LOWER_TRANSPORT_UDP_MULTICAST = 2,
34     RTSP_LOWER_TRANSPORT_NB
35 };
36
37 enum RTSPTransport {
38     RTSP_TRANSPORT_RTP,
39     RTSP_TRANSPORT_RDT,
40     RTSP_TRANSPORT_NB
41 };
42
43 #define RTSP_DEFAULT_PORT   554
44 #define RTSP_MAX_TRANSPORTS 8
45 #define RTSP_TCP_MAX_PACKET_SIZE 1472
46 #define RTSP_DEFAULT_NB_AUDIO_CHANNELS 2
47 #define RTSP_DEFAULT_AUDIO_SAMPLERATE 44100
48 #define RTSP_RTP_PORT_MIN 5000
49 #define RTSP_RTP_PORT_MAX 10000
50
51 typedef struct RTSPTransportField {
52     int interleaved_min, interleaved_max;  /**< interleave ids, if TCP transport */
53     int port_min, port_max; /**< RTP ports */
54     int client_port_min, client_port_max; /**< RTP ports */
55     int server_port_min, server_port_max; /**< RTP ports */
56     int ttl; /**< ttl value */
57     uint32_t destination; /**< destination IP address */
58     enum RTSPTransport transport;
59     enum RTSPLowerTransport lower_transport;
60 } RTSPTransportField;
61
62 typedef struct RTSPHeader {
63     int content_length;
64     enum RTSPStatusCode status_code; /**< response code from server */
65     int nb_transports;
66     /** in AV_TIME_BASE unit, AV_NOPTS_VALUE if not used */
67     int64_t range_start, range_end;
68     RTSPTransportField transports[RTSP_MAX_TRANSPORTS];
69     int seq; /**< sequence number */
70     char session_id[512];
71     char real_challenge[64]; /**< the RealChallenge1 field from the server */
72     char server[64];
73 } RTSPHeader;
74
75 enum RTSPClientState {
76     RTSP_STATE_IDLE,
77     RTSP_STATE_PLAYING,
78     RTSP_STATE_PAUSED,
79 };
80
81 enum RTSPServerType {
82     RTSP_SERVER_RTP,  /**< Standards-compliant RTP-server */
83     RTSP_SERVER_REAL, /**< Realmedia-style server */
84     RTSP_SERVER_WMS,  /**< Windows Media server */
85     RTSP_SERVER_NB
86 };
87
88 typedef struct RTSPState {
89     URLContext *rtsp_hd; /* RTSP TCP connexion handle */
90     int nb_rtsp_streams;
91     struct RTSPStream **rtsp_streams;
92
93     enum RTSPClientState state;
94     int64_t seek_timestamp;
95
96     /* XXX: currently we use unbuffered input */
97     //    ByteIOContext rtsp_gb;
98     int seq;        /* RTSP command sequence number */
99     char session_id[512];
100     enum RTSPTransport transport;
101     enum RTSPLowerTransport lower_transport;
102     enum RTSPServerType server_type;
103     char last_reply[2048]; /* XXX: allocate ? */
104     void *cur_transport_priv;
105     int need_subscription;
106     enum AVDiscard real_setup_cache[MAX_STREAMS];
107     char last_subscription[1024];
108 } RTSPState;
109
110 typedef struct RTSPStream {
111     URLContext *rtp_handle; /* RTP stream handle */
112     void *transport_priv; /* RTP/RDT parse context */
113
114     int stream_index; /* corresponding stream index, if any. -1 if none (MPEG2TS case) */
115     int interleaved_min, interleaved_max;  /* interleave ids, if TCP transport */
116     char control_url[1024]; /* url for this stream (from SDP) */
117
118     int sdp_port; /* port (from SDP content - not used in RTSP) */
119     struct in_addr sdp_ip; /* IP address  (from SDP content - not used in RTSP) */
120     int sdp_ttl;  /* IP TTL (from SDP content - not used in RTSP) */
121     int sdp_payload_type; /* payload type - only used in SDP */
122     RTPPayloadData rtp_payload_data; /* rtp payload parsing infos from SDP */
123
124     RTPDynamicProtocolHandler *dynamic_handler; ///< Only valid if it's a dynamic protocol. (This is the handler structure)
125     PayloadContext *dynamic_protocol_context; ///< Only valid if it's a dynamic protocol. (This is any private data associated with the dynamic protocol)
126 } RTSPStream;
127
128 int rtsp_init(void);
129 void rtsp_parse_line(RTSPHeader *reply, const char *buf);
130
131 #if LIBAVFORMAT_VERSION_INT < (53 << 16)
132 extern int rtsp_default_protocols;
133 #endif
134 extern int rtsp_rtp_port_min;
135 extern int rtsp_rtp_port_max;
136
137 int rtsp_pause(AVFormatContext *s);
138 int rtsp_resume(AVFormatContext *s);
139
140 #endif /* FFMPEG_RTSP_H */