Add rtp_get_rtcp_file_handle function
[ffmpeg.git] / libavformat / rtpdec.h
1 /*
2  * RTP demuxer definitions
3  * Copyright (c) 2002 Fabrice Bellard
4  * Copyright (c) 2006 Ryan Martell <rdm4@martellventures.com>
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 #ifndef AVFORMAT_RTPDEC_H
23 #define AVFORMAT_RTPDEC_H
24
25 #include "libavcodec/avcodec.h"
26 #include "avformat.h"
27 #include "rtp.h"
28
29 typedef struct PayloadContext PayloadContext;
30 typedef struct RTPDynamicProtocolHandler_s RTPDynamicProtocolHandler;
31
32 #define RTP_MIN_PACKET_LENGTH 12
33 #define RTP_MAX_PACKET_LENGTH 1500 /* XXX: suppress this define */
34
35 #define RTP_NOTS_VALUE ((uint32_t)-1)
36
37 typedef struct RTPDemuxContext RTPDemuxContext;
38 RTPDemuxContext *rtp_parse_open(AVFormatContext *s1, AVStream *st, URLContext *rtpc, int payload_type);
39 void rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
40                                     RTPDynamicProtocolHandler *handler);
41 int rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
42                      const uint8_t *buf, int len);
43 void rtp_parse_close(RTPDemuxContext *s);
44 #if (LIBAVFORMAT_VERSION_MAJOR <= 53)
45 int rtp_get_local_port(URLContext *h);
46 #endif
47 int rtp_get_local_rtp_port(URLContext *h);
48 int rtp_get_local_rtcp_port(URLContext *h);
49
50 int rtp_set_remote_url(URLContext *h, const char *uri);
51 #if (LIBAVFORMAT_VERSION_MAJOR <= 52)
52 void rtp_get_file_handles(URLContext *h, int *prtp_fd, int *prtcp_fd);
53 #endif
54
55 /**
56  * Send a dummy packet on both port pairs to set up the connection
57  * state in potential NAT routers, so that we're able to receive
58  * packets.
59  *
60  * Note, this only works if the NAT router doesn't remap ports. This
61  * isn't a standardized procedure, but it works in many cases in practice.
62  *
63  * The same routine is used with RDT too, even if RDT doesn't use normal
64  * RTP packets otherwise.
65  */
66 void rtp_send_punch_packets(URLContext* rtp_handle);
67
68 /**
69  * some rtp servers assume client is dead if they don't hear from them...
70  * so we send a Receiver Report to the provided ByteIO context
71  * (we don't have access to the rtcp handle from here)
72  */
73 int rtp_check_and_send_back_rr(RTPDemuxContext *s, int count);
74
75 /**
76  * Get the file handle for the RTCP socket.
77  */
78 int rtp_get_rtcp_file_handle(URLContext *h);
79
80 // these statistics are used for rtcp receiver reports...
81 typedef struct {
82     uint16_t max_seq;           ///< highest sequence number seen
83     uint32_t cycles;            ///< shifted count of sequence number cycles
84     uint32_t base_seq;          ///< base sequence number
85     uint32_t bad_seq;           ///< last bad sequence number + 1
86     int probation;              ///< sequence packets till source is valid
87     int received;               ///< packets received
88     int expected_prior;         ///< packets expected in last interval
89     int received_prior;         ///< packets received in last interval
90     uint32_t transit;           ///< relative transit time for previous packet
91     uint32_t jitter;            ///< estimated jitter.
92 } RTPStatistics;
93
94 #define RTP_FLAG_KEY    0x1 ///< RTP packet contains a keyframe
95 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
96 /**
97  * Packet parsing for "private" payloads in the RTP specs.
98  *
99  * @param ctx RTSP demuxer context
100  * @param s stream context
101  * @param st stream that this packet belongs to
102  * @param pkt packet in which to write the parsed data
103  * @param timestamp pointer in which to write the timestamp of this RTP packet
104  * @param buf pointer to raw RTP packet data
105  * @param len length of buf
106  * @param flags flags from the RTP packet header (RTP_FLAG_*)
107  */
108 typedef int (*DynamicPayloadPacketHandlerProc) (AVFormatContext *ctx,
109                                                 PayloadContext *s,
110                                                 AVStream *st,
111                                                 AVPacket * pkt,
112                                                 uint32_t *timestamp,
113                                                 const uint8_t * buf,
114                                                 int len, int flags);
115
116 struct RTPDynamicProtocolHandler_s {
117     // fields from AVRtpDynamicPayloadType_s
118     const char enc_name[50];    /* XXX: still why 50 ? ;-) */
119     enum AVMediaType codec_type;
120     enum CodecID codec_id;
121
122     // may be null
123     int (*parse_sdp_a_line) (AVFormatContext *s,
124                              int st_index,
125                              PayloadContext *priv_data,
126                              const char *line); ///< Parse the a= line from the sdp field
127     PayloadContext *(*open) (void); ///< allocate any data needed by the rtp parsing for this dynamic data.
128     void (*close)(PayloadContext *protocol_data); ///< free any data needed by the rtp parsing for this dynamic data.
129     DynamicPayloadPacketHandlerProc parse_packet; ///< parse handler for this dynamic packet.
130
131     struct RTPDynamicProtocolHandler_s *next;
132 };
133
134 // moved out of rtp.c, because the h264 decoder needs to know about this structure..
135 struct RTPDemuxContext {
136     AVFormatContext *ic;
137     AVStream *st;
138     int payload_type;
139     uint32_t ssrc;
140     uint16_t seq;
141     uint32_t timestamp;
142     uint32_t base_timestamp;
143     uint32_t cur_timestamp;
144     int64_t  range_start_offset;
145     int max_payload_size;
146     struct MpegTSContext *ts;   /* only used for MP2T payloads */
147     int read_buf_index;
148     int read_buf_size;
149     /* used to send back RTCP RR */
150     URLContext *rtp_ctx;
151     char hostname[256];
152
153     RTPStatistics statistics; ///< Statistics for this stream (used by RTCP receiver reports)
154
155     /* rtcp sender statistics receive */
156     int64_t last_rtcp_ntp_time;    // TODO: move into statistics
157     int64_t first_rtcp_ntp_time;   // TODO: move into statistics
158     uint32_t last_rtcp_timestamp;  // TODO: move into statistics
159
160     /* rtcp sender statistics */
161     unsigned int packet_count;     // TODO: move into statistics (outgoing)
162     unsigned int octet_count;      // TODO: move into statistics (outgoing)
163     unsigned int last_octet_count; // TODO: move into statistics (outgoing)
164     int first_packet;
165     /* buffer for output */
166     uint8_t buf[RTP_MAX_PACKET_LENGTH];
167     uint8_t *buf_ptr;
168
169     /* dynamic payload stuff */
170     DynamicPayloadPacketHandlerProc parse_packet;     ///< This is also copied from the dynamic protocol handler structure
171     PayloadContext *dynamic_protocol_context;        ///< This is a copy from the values setup from the sdp parsing, in rtsp.c don't free me.
172     int max_frames_per_packet;
173 };
174
175 extern RTPDynamicProtocolHandler *RTPFirstDynamicPayloadHandler;
176 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
177
178 int ff_rtsp_next_attr_and_value(const char **p, char *attr, int attr_size, char *value, int value_size); ///< from rtsp.c, but used by rtp dynamic protocol handlers.
179
180 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
181                   int (*parse_fmtp)(AVStream *stream,
182                                     PayloadContext *data,
183                                     char *attr, char *value));
184
185 void av_register_rtp_dynamic_payload_handlers(void);
186
187 #endif /* AVFORMAT_RTPDEC_H */