rtpdec: Reorder received RTP packets according to the seq number
[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_REORDER_QUEUE_DEFAULT_SIZE 10
36
37 #define RTP_NOTS_VALUE ((uint32_t)-1)
38
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 #if (LIBAVFORMAT_VERSION_MAJOR <= 53)
49 int rtp_get_local_port(URLContext *h);
50 #endif
51 int rtp_get_local_rtp_port(URLContext *h);
52 int rtp_get_local_rtcp_port(URLContext *h);
53
54 int rtp_set_remote_url(URLContext *h, const char *uri);
55 #if (LIBAVFORMAT_VERSION_MAJOR <= 52)
56 void rtp_get_file_handles(URLContext *h, int *prtp_fd, int *prtcp_fd);
57 #endif
58
59 /**
60  * Send a dummy packet on both port pairs to set up the connection
61  * state in potential NAT routers, so that we're able to receive
62  * packets.
63  *
64  * Note, this only works if the NAT router doesn't remap ports. This
65  * isn't a standardized procedure, but it works in many cases in practice.
66  *
67  * The same routine is used with RDT too, even if RDT doesn't use normal
68  * RTP packets otherwise.
69  */
70 void rtp_send_punch_packets(URLContext* rtp_handle);
71
72 /**
73  * some rtp servers assume client is dead if they don't hear from them...
74  * so we send a Receiver Report to the provided ByteIO context
75  * (we don't have access to the rtcp handle from here)
76  */
77 int rtp_check_and_send_back_rr(RTPDemuxContext *s, int count);
78
79 /**
80  * Get the file handle for the RTCP socket.
81  */
82 int rtp_get_rtcp_file_handle(URLContext *h);
83
84 // these statistics are used for rtcp receiver reports...
85 typedef struct {
86     uint16_t max_seq;           ///< highest sequence number seen
87     uint32_t cycles;            ///< shifted count of sequence number cycles
88     uint32_t base_seq;          ///< base sequence number
89     uint32_t bad_seq;           ///< last bad sequence number + 1
90     int probation;              ///< sequence packets till source is valid
91     int received;               ///< packets received
92     int expected_prior;         ///< packets expected in last interval
93     int received_prior;         ///< packets received in last interval
94     uint32_t transit;           ///< relative transit time for previous packet
95     uint32_t jitter;            ///< estimated jitter.
96 } RTPStatistics;
97
98 #define RTP_FLAG_KEY    0x1 ///< RTP packet contains a keyframe
99 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
100 /**
101  * Packet parsing for "private" payloads in the RTP specs.
102  *
103  * @param ctx RTSP demuxer context
104  * @param s stream context
105  * @param st stream that this packet belongs to
106  * @param pkt packet in which to write the parsed data
107  * @param timestamp pointer in which to write the timestamp of this RTP packet
108  * @param buf pointer to raw RTP packet data
109  * @param len length of buf
110  * @param flags flags from the RTP packet header (RTP_FLAG_*)
111  */
112 typedef int (*DynamicPayloadPacketHandlerProc) (AVFormatContext *ctx,
113                                                 PayloadContext *s,
114                                                 AVStream *st,
115                                                 AVPacket * pkt,
116                                                 uint32_t *timestamp,
117                                                 const uint8_t * buf,
118                                                 int len, int flags);
119
120 struct RTPDynamicProtocolHandler_s {
121     // fields from AVRtpDynamicPayloadType_s
122     const char enc_name[50];    /* XXX: still why 50 ? ;-) */
123     enum AVMediaType codec_type;
124     enum CodecID codec_id;
125
126     // may be null
127     int (*parse_sdp_a_line) (AVFormatContext *s,
128                              int st_index,
129                              PayloadContext *priv_data,
130                              const char *line); ///< Parse the a= line from the sdp field
131     PayloadContext *(*open) (void); ///< allocate any data needed by the rtp parsing for this dynamic data.
132     void (*close)(PayloadContext *protocol_data); ///< free any data needed by the rtp parsing for this dynamic data.
133     DynamicPayloadPacketHandlerProc parse_packet; ///< parse handler for this dynamic packet.
134
135     struct RTPDynamicProtocolHandler_s *next;
136 };
137
138 typedef struct RTPPacket {
139     uint16_t seq;
140     uint8_t *buf;
141     int len;
142     int64_t recvtime;
143     struct RTPPacket *next;
144 } RTPPacket;
145
146 // moved out of rtp.c, because the h264 decoder needs to know about this structure..
147 struct RTPDemuxContext {
148     AVFormatContext *ic;
149     AVStream *st;
150     int payload_type;
151     uint32_t ssrc;
152     uint16_t seq;
153     uint32_t timestamp;
154     uint32_t base_timestamp;
155     uint32_t cur_timestamp;
156     int64_t  range_start_offset;
157     int max_payload_size;
158     struct MpegTSContext *ts;   /* only used for MP2T payloads */
159     int read_buf_index;
160     int read_buf_size;
161     /* used to send back RTCP RR */
162     URLContext *rtp_ctx;
163     char hostname[256];
164
165     RTPStatistics statistics; ///< Statistics for this stream (used by RTCP receiver reports)
166
167     /** Fields for packet reordering @{ */
168     int prev_ret;     ///< The return value of the actual parsing of the previous packet
169     RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
170     int queue_len;    ///< The number of packets in queue
171     int queue_size;   ///< The size of queue, or 0 if reordering is disabled
172     /*@}*/
173
174     /* rtcp sender statistics receive */
175     int64_t last_rtcp_ntp_time;    // TODO: move into statistics
176     int64_t first_rtcp_ntp_time;   // TODO: move into statistics
177     uint32_t last_rtcp_timestamp;  // TODO: move into statistics
178
179     /* rtcp sender statistics */
180     unsigned int packet_count;     // TODO: move into statistics (outgoing)
181     unsigned int octet_count;      // TODO: move into statistics (outgoing)
182     unsigned int last_octet_count; // TODO: move into statistics (outgoing)
183     int first_packet;
184     /* buffer for output */
185     uint8_t buf[RTP_MAX_PACKET_LENGTH];
186     uint8_t *buf_ptr;
187
188     /* dynamic payload stuff */
189     DynamicPayloadPacketHandlerProc parse_packet;     ///< This is also copied from the dynamic protocol handler structure
190     PayloadContext *dynamic_protocol_context;        ///< This is a copy from the values setup from the sdp parsing, in rtsp.c don't free me.
191     int max_frames_per_packet;
192 };
193
194 extern RTPDynamicProtocolHandler *RTPFirstDynamicPayloadHandler;
195 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
196
197 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.
198
199 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
200                   int (*parse_fmtp)(AVStream *stream,
201                                     PayloadContext *data,
202                                     char *attr, char *value));
203
204 void av_register_rtp_dynamic_payload_handlers(void);
205
206 #endif /* AVFORMAT_RTPDEC_H */