2 * RTP demuxer definitions
3 * Copyright (c) 2002 Fabrice Bellard
4 * Copyright (c) 2006 Ryan Martell <rdm4@martellventures.com>
6 * This file is part of FFmpeg.
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.
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.
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
22 #ifndef AVFORMAT_RTPDEC_H
23 #define AVFORMAT_RTPDEC_H
25 #include "libavcodec/avcodec.h"
29 typedef struct PayloadContext PayloadContext;
30 typedef struct RTPDynamicProtocolHandler_s RTPDynamicProtocolHandler;
32 #define RTP_MIN_PACKET_LENGTH 12
33 #define RTP_MAX_PACKET_LENGTH 1500 /* XXX: suppress this define */
35 #define RTP_REORDER_QUEUE_DEFAULT_SIZE 10
37 #define RTP_NOTS_VALUE ((uint32_t)-1)
39 typedef struct RTPDemuxContext RTPDemuxContext;
40 RTPDemuxContext *rtp_parse_open(AVFormatContext *s1, AVStream *st, URLContext *rtpc, int payload_type, int queue_size);
41 void rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
42 RTPDynamicProtocolHandler *handler);
43 int rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
44 uint8_t **buf, int len);
45 void rtp_parse_close(RTPDemuxContext *s);
46 int64_t ff_rtp_queued_packet_time(RTPDemuxContext *s);
47 void ff_rtp_reset_packet_queue(RTPDemuxContext *s);
48 int rtp_get_local_rtp_port(URLContext *h);
49 int rtp_get_local_rtcp_port(URLContext *h);
51 int rtp_set_remote_url(URLContext *h, const char *uri);
54 * Send a dummy packet on both port pairs to set up the connection
55 * state in potential NAT routers, so that we're able to receive
58 * Note, this only works if the NAT router doesn't remap ports. This
59 * isn't a standardized procedure, but it works in many cases in practice.
61 * The same routine is used with RDT too, even if RDT doesn't use normal
62 * RTP packets otherwise.
64 void rtp_send_punch_packets(URLContext* rtp_handle);
67 * some rtp servers assume client is dead if they don't hear from them...
68 * so we send a Receiver Report to the provided ByteIO context
69 * (we don't have access to the rtcp handle from here)
71 int rtp_check_and_send_back_rr(RTPDemuxContext *s, int count);
74 * Get the file handle for the RTCP socket.
76 int rtp_get_rtcp_file_handle(URLContext *h);
78 // these statistics are used for rtcp receiver reports...
80 uint16_t max_seq; ///< highest sequence number seen
81 uint32_t cycles; ///< shifted count of sequence number cycles
82 uint32_t base_seq; ///< base sequence number
83 uint32_t bad_seq; ///< last bad sequence number + 1
84 int probation; ///< sequence packets till source is valid
85 int received; ///< packets received
86 int expected_prior; ///< packets expected in last interval
87 int received_prior; ///< packets received in last interval
88 uint32_t transit; ///< relative transit time for previous packet
89 uint32_t jitter; ///< estimated jitter.
92 #define RTP_FLAG_KEY 0x1 ///< RTP packet contains a keyframe
93 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
95 * Packet parsing for "private" payloads in the RTP specs.
97 * @param ctx RTSP demuxer context
98 * @param s stream context
99 * @param st stream that this packet belongs to
100 * @param pkt packet in which to write the parsed data
101 * @param timestamp pointer in which to write the timestamp of this RTP packet
102 * @param buf pointer to raw RTP packet data
103 * @param len length of buf
104 * @param flags flags from the RTP packet header (RTP_FLAG_*)
106 typedef int (*DynamicPayloadPacketHandlerProc) (AVFormatContext *ctx,
114 struct RTPDynamicProtocolHandler_s {
115 // fields from AVRtpDynamicPayloadType_s
116 const char enc_name[50]; /* XXX: still why 50 ? ;-) */
117 enum AVMediaType codec_type;
118 enum CodecID codec_id;
119 int static_payload_id; /* 0 means no payload id is set. 0 is a valid
120 * payload ID (PCMU), too, but that format doesn't
121 * require any custom depacketization code. */
124 int (*parse_sdp_a_line) (AVFormatContext *s,
126 PayloadContext *priv_data,
127 const char *line); ///< Parse the a= line from the sdp field
128 PayloadContext *(*open) (void); ///< allocate any data needed by the rtp parsing for this dynamic data.
129 void (*close)(PayloadContext *protocol_data); ///< free any data needed by the rtp parsing for this dynamic data.
130 DynamicPayloadPacketHandlerProc parse_packet; ///< parse handler for this dynamic packet.
132 struct RTPDynamicProtocolHandler_s *next;
135 typedef struct RTPPacket {
140 struct RTPPacket *next;
143 // moved out of rtp.c, because the h264 decoder needs to know about this structure..
144 struct RTPDemuxContext {
151 uint32_t base_timestamp;
152 uint32_t cur_timestamp;
153 int64_t range_start_offset;
154 int max_payload_size;
155 struct MpegTSContext *ts; /* only used for MP2T payloads */
158 /* used to send back RTCP RR */
162 RTPStatistics statistics; ///< Statistics for this stream (used by RTCP receiver reports)
164 /** Fields for packet reordering @{ */
165 int prev_ret; ///< The return value of the actual parsing of the previous packet
166 RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
167 int queue_len; ///< The number of packets in queue
168 int queue_size; ///< The size of queue, or 0 if reordering is disabled
171 /* rtcp sender statistics receive */
172 int64_t last_rtcp_ntp_time; // TODO: move into statistics
173 int64_t first_rtcp_ntp_time; // TODO: move into statistics
174 uint32_t last_rtcp_timestamp; // TODO: move into statistics
175 int64_t rtcp_ts_offset;
177 /* rtcp sender statistics */
178 unsigned int packet_count; // TODO: move into statistics (outgoing)
179 unsigned int octet_count; // TODO: move into statistics (outgoing)
180 unsigned int last_octet_count; // TODO: move into statistics (outgoing)
182 /* buffer for output */
183 uint8_t buf[RTP_MAX_PACKET_LENGTH];
186 /* dynamic payload stuff */
187 DynamicPayloadPacketHandlerProc parse_packet; ///< This is also copied from the dynamic protocol handler structure
188 PayloadContext *dynamic_protocol_context; ///< This is a copy from the values setup from the sdp parsing, in rtsp.c don't free me.
189 int max_frames_per_packet;
192 extern RTPDynamicProtocolHandler *RTPFirstDynamicPayloadHandler;
193 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
194 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_name(const char *name,
195 enum AVMediaType codec_type);
196 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_id(int id,
197 enum AVMediaType codec_type);
199 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.
201 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
202 int (*parse_fmtp)(AVStream *stream,
203 PayloadContext *data,
204 char *attr, char *value));
206 void av_register_rtp_dynamic_payload_handlers(void);
208 #endif /* AVFORMAT_RTPDEC_H */