rtpdec_jpeg: Store and reuse old qtables for q values 128-254
[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 Libav.
7  *
8  * Libav 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  * Libav 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 Libav; 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 #include "url.h"
29
30 typedef struct PayloadContext PayloadContext;
31 typedef struct RTPDynamicProtocolHandler_s RTPDynamicProtocolHandler;
32
33 #define RTP_MIN_PACKET_LENGTH 12
34 #define RTP_MAX_PACKET_LENGTH 1500 /* XXX: suppress this define */
35
36 #define RTP_REORDER_QUEUE_DEFAULT_SIZE 10
37
38 #define RTP_NOTS_VALUE ((uint32_t)-1)
39
40 typedef struct RTPDemuxContext RTPDemuxContext;
41 RTPDemuxContext *ff_rtp_parse_open(AVFormatContext *s1, AVStream *st, URLContext *rtpc, int payload_type, int queue_size);
42 void ff_rtp_parse_set_dynamic_protocol(RTPDemuxContext *s, PayloadContext *ctx,
43                                        RTPDynamicProtocolHandler *handler);
44 int ff_rtp_parse_packet(RTPDemuxContext *s, AVPacket *pkt,
45                         uint8_t **buf, int len);
46 void ff_rtp_parse_close(RTPDemuxContext *s);
47 int64_t ff_rtp_queued_packet_time(RTPDemuxContext *s);
48 void ff_rtp_reset_packet_queue(RTPDemuxContext *s);
49 int ff_rtp_get_local_rtp_port(URLContext *h);
50 int ff_rtp_get_local_rtcp_port(URLContext *h);
51
52 int ff_rtp_set_remote_url(URLContext *h, const char *uri);
53
54 /**
55  * Send a dummy packet on both port pairs to set up the connection
56  * state in potential NAT routers, so that we're able to receive
57  * packets.
58  *
59  * Note, this only works if the NAT router doesn't remap ports. This
60  * isn't a standardized procedure, but it works in many cases in practice.
61  *
62  * The same routine is used with RDT too, even if RDT doesn't use normal
63  * RTP packets otherwise.
64  */
65 void ff_rtp_send_punch_packets(URLContext* rtp_handle);
66
67 /**
68  * some rtp servers assume client is dead if they don't hear from them...
69  * so we send a Receiver Report to the provided ByteIO context
70  * (we don't have access to the rtcp handle from here)
71  */
72 int ff_rtp_check_and_send_back_rr(RTPDemuxContext *s, int count);
73
74 // these statistics are used for rtcp receiver reports...
75 typedef struct {
76     uint16_t max_seq;           ///< highest sequence number seen
77     uint32_t cycles;            ///< shifted count of sequence number cycles
78     uint32_t base_seq;          ///< base sequence number
79     uint32_t bad_seq;           ///< last bad sequence number + 1
80     int probation;              ///< sequence packets till source is valid
81     int received;               ///< packets received
82     int expected_prior;         ///< packets expected in last interval
83     int received_prior;         ///< packets received in last interval
84     uint32_t transit;           ///< relative transit time for previous packet
85     uint32_t jitter;            ///< estimated jitter.
86 } RTPStatistics;
87
88 #define RTP_FLAG_KEY    0x1 ///< RTP packet contains a keyframe
89 #define RTP_FLAG_MARKER 0x2 ///< RTP marker bit was set for this packet
90 /**
91  * Packet parsing for "private" payloads in the RTP specs.
92  *
93  * @param ctx RTSP demuxer context
94  * @param s stream context
95  * @param st stream that this packet belongs to
96  * @param pkt packet in which to write the parsed data
97  * @param timestamp pointer in which to write the timestamp of this RTP packet
98  * @param buf pointer to raw RTP packet data
99  * @param len length of buf
100  * @param flags flags from the RTP packet header (RTP_FLAG_*)
101  */
102 typedef int (*DynamicPayloadPacketHandlerProc) (AVFormatContext *ctx,
103                                                 PayloadContext *s,
104                                                 AVStream *st,
105                                                 AVPacket * pkt,
106                                                 uint32_t *timestamp,
107                                                 const uint8_t * buf,
108                                                 int len, int flags);
109
110 struct RTPDynamicProtocolHandler_s {
111     // fields from AVRtpDynamicPayloadType_s
112     const char enc_name[50];    /* XXX: still why 50 ? ;-) */
113     enum AVMediaType codec_type;
114     enum AVCodecID codec_id;
115     int static_payload_id; /* 0 means no payload id is set. 0 is a valid
116                             * payload ID (PCMU), too, but that format doesn't
117                             * require any custom depacketization code. */
118
119     // may be null
120     int (*init)(AVFormatContext *s, int st_index, PayloadContext *priv_data); ///< Initialize dynamic protocol handler, called after the full rtpmap line is parsed
121     int (*parse_sdp_a_line) (AVFormatContext *s,
122                              int st_index,
123                              PayloadContext *priv_data,
124                              const char *line); ///< Parse the a= line from the sdp field
125     PayloadContext *(*alloc) (void); ///< allocate any data needed by the rtp parsing for this dynamic data.
126     void (*free)(PayloadContext *protocol_data); ///< free any data needed by the rtp parsing for this dynamic data.
127     DynamicPayloadPacketHandlerProc parse_packet; ///< parse handler for this dynamic packet.
128
129     struct RTPDynamicProtocolHandler_s *next;
130 };
131
132 typedef struct RTPPacket {
133     uint16_t seq;
134     uint8_t *buf;
135     int len;
136     int64_t recvtime;
137     struct RTPPacket *next;
138 } RTPPacket;
139
140 // moved out of rtp.c, because the h264 decoder needs to know about this structure..
141 struct RTPDemuxContext {
142     AVFormatContext *ic;
143     AVStream *st;
144     int payload_type;
145     uint32_t ssrc;
146     uint16_t seq;
147     uint32_t timestamp;
148     uint32_t base_timestamp;
149     uint32_t cur_timestamp;
150     int64_t  unwrapped_timestamp;
151     int64_t  range_start_offset;
152     int max_payload_size;
153     struct MpegTSContext *ts;   /* only used for MP2T payloads */
154     int read_buf_index;
155     int read_buf_size;
156     /* used to send back RTCP RR */
157     URLContext *rtp_ctx;
158     char hostname[256];
159
160     RTPStatistics statistics; ///< Statistics for this stream (used by RTCP receiver reports)
161
162     /** Fields for packet reordering @{ */
163     int prev_ret;     ///< The return value of the actual parsing of the previous packet
164     RTPPacket* queue; ///< A sorted queue of buffered packets not yet returned
165     int queue_len;    ///< The number of packets in queue
166     int queue_size;   ///< The size of queue, or 0 if reordering is disabled
167     /*@}*/
168
169     /* rtcp sender statistics receive */
170     int64_t last_rtcp_ntp_time;    // TODO: move into statistics
171     int64_t first_rtcp_ntp_time;   // TODO: move into statistics
172     uint32_t last_rtcp_timestamp;  // TODO: move into statistics
173     int64_t rtcp_ts_offset;
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     /* dynamic payload stuff */
185     DynamicPayloadPacketHandlerProc parse_packet;     ///< This is also copied from the dynamic protocol handler structure
186     PayloadContext *dynamic_protocol_context;        ///< This is a copy from the values setup from the sdp parsing, in rtsp.c don't free me.
187     int max_frames_per_packet;
188 };
189
190 void ff_register_dynamic_payload_handler(RTPDynamicProtocolHandler *handler);
191 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_name(const char *name,
192                                                   enum AVMediaType codec_type);
193 RTPDynamicProtocolHandler *ff_rtp_handler_find_by_id(int id,
194                                                 enum AVMediaType codec_type);
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 int ff_parse_fmtp(AVStream *stream, PayloadContext *data, const char *p,
199                   int (*parse_fmtp)(AVStream *stream,
200                                     PayloadContext *data,
201                                     char *attr, char *value));
202
203 void av_register_rtp_dynamic_payload_handlers(void);
204
205 #endif /* AVFORMAT_RTPDEC_H */