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