codec: bitpacked: add decoder
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
23
24 /**
25  * @file
26  * @ingroup libavc
27  * Libavcodec external API header
28  */
29
30 #include <errno.h>
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
42
43 #include "version.h"
44
45 /**
46  * @defgroup libavc libavcodec
47  * Encoding/Decoding Library
48  *
49  * @{
50  *
51  * @defgroup lavc_decoding Decoding
52  * @{
53  * @}
54  *
55  * @defgroup lavc_encoding Encoding
56  * @{
57  * @}
58  *
59  * @defgroup lavc_codec Codecs
60  * @{
61  * @defgroup lavc_codec_native Native Codecs
62  * @{
63  * @}
64  * @defgroup lavc_codec_wrappers External library wrappers
65  * @{
66  * @}
67  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68  * @{
69  * @}
70  * @}
71  * @defgroup lavc_internal Internal
72  * @{
73  * @}
74  * @}
75  */
76
77 /**
78  * @ingroup libavc
79  * @defgroup lavc_encdec send/receive encoding and decoding API overview
80  * @{
81  *
82  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83  * avcodec_receive_packet() functions provide an encode/decode API, which
84  * decouples input and output.
85  *
86  * The API is very similar for encoding/decoding and audio/video, and works as
87  * follows:
88  * - Set up and open the AVCodecContext as usual.
89  * - Send valid input:
90  *   - For decoding, call avcodec_send_packet() to give the decoder raw
91  *     compressed data in an AVPacket.
92  *   - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93  *     containing uncompressed audio or video.
94  *   In both cases, it is recommended that AVPackets and AVFrames are
95  *   refcounted, or libavcodec might have to copy the input data. (libavformat
96  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97  *   refcounted AVFrames.)
98  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99  *   functions and process their output:
100  *   - For decoding, call avcodec_receive_frame(). On success, it will return
101  *     an AVFrame containing uncompressed audio or video data.
102  *   - For encoding, call avcodec_receive_packet(). On success, it will return
103  *     an AVPacket with a compressed frame.
104  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105  *   AVERROR(EAGAIN) return value means that new input data is required to
106  *   return new output. In this case, continue with sending input. For each
107  *   input frame/packet, the codec will typically return 1 output frame/packet,
108  *   but it can also be 0 or more than 1.
109  *
110  * At the beginning of decoding or encoding, the codec might accept multiple
111  * input frames/packets without returning a frame, until its internal buffers
112  * are filled. This situation is handled transparently if you follow the steps
113  * outlined above.
114  *
115  * In theory, sending input can result in EAGAIN - this should happen only if
116  * not all output was received. You can use this to structure alternative decode
117  * or encode loops other than the one suggested above. For example, you could
118  * try sending new input on each iteration, and try to receive output if that
119  * returns EAGAIN.
120  *
121  * End of stream situations. These require "flushing" (aka draining) the codec,
122  * as the codec might buffer multiple frames or packets internally for
123  * performance or out of necessity (consider B-frames).
124  * This is handled as follows:
125  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126  *   or avcodec_send_frame() (encoding) functions. This will enter draining
127  *   mode.
128  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
130  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131  * - Before decoding can be resumed again, the codec has to be reset with
132  *   avcodec_flush_buffers().
133  *
134  * Using the API as outlined above is highly recommended. But it is also
135  * possible to call functions outside of this rigid schema. For example, you can
136  * call avcodec_send_packet() repeatedly without calling
137  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138  * until the codec's internal buffer has been filled up (which is typically of
139  * size 1 per output frame, after initial input), and then reject input with
140  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141  * read at least some output.
142  *
143  * Not all codecs will follow a rigid and predictable dataflow; the only
144  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145  * one end implies that a receive/send call on the other end will succeed, or
146  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147  * permit unlimited buffering of input or output.
148  *
149  * This API replaces the following legacy functions:
150  * - avcodec_decode_video2() and avcodec_decode_audio4():
151  *   Use avcodec_send_packet() to feed input to the decoder, then use
152  *   avcodec_receive_frame() to receive decoded frames after each packet.
153  *   Unlike with the old video decoding API, multiple frames might result from
154  *   a packet. For audio, splitting the input packet into frames by partially
155  *   decoding packets becomes transparent to the API user. You never need to
156  *   feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157  *   no data was read from the packet).
158  *   Additionally, sending a flush/draining packet is required only once.
159  * - avcodec_encode_video2()/avcodec_encode_audio2():
160  *   Use avcodec_send_frame() to feed input to the encoder, then use
161  *   avcodec_receive_packet() to receive encoded packets.
162  *   Providing user-allocated buffers for avcodec_receive_packet() is not
163  *   possible.
164  * - The new API does not handle subtitles yet.
165  *
166  * Mixing new and old function calls on the same AVCodecContext is not allowed,
167  * and will result in undefined behavior.
168  *
169  * Some codecs might require using the new API; using the old API will return
170  * an error when calling it. All codecs support the new API.
171  *
172  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173  * would be an invalid state, which could put the codec user into an endless
174  * loop. The API has no concept of time either: it cannot happen that trying to
175  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176  * later accepts the packet (with no other receive/flush API calls involved).
177  * The API is a strict state machine, and the passage of time is not supposed
178  * to influence it. Some timing-dependent behavior might still be deemed
179  * acceptable in certain cases. But it must never result in both send/receive
180  * returning EAGAIN at the same time at any point. It must also absolutely be
181  * avoided that the current state is "unstable" and can "flip-flop" between
182  * the send/receive APIs allowing progress. For example, it's not allowed that
183  * the codec randomly decides that it actually wants to consume a packet now
184  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185  * avcodec_send_packet() call.
186  * @}
187  */
188
189 /**
190  * @defgroup lavc_core Core functions/structures.
191  * @ingroup libavc
192  *
193  * Basic definitions, functions for querying libavcodec capabilities,
194  * allocating core structures, etc.
195  * @{
196  */
197
198
199 /**
200  * Identify the syntax and semantics of the bitstream.
201  * The principle is roughly:
202  * Two decoders with the same ID can decode the same streams.
203  * Two encoders with the same ID can encode compatible streams.
204  * There may be slight deviations from the principle due to implementation
205  * details.
206  *
207  * If you add a codec ID to this list, add it so that
208  * 1. no value of an existing codec ID changes (that would break ABI),
209  * 2. it is as close as possible to similar codecs
210  *
211  * After adding new codec IDs, do not forget to add an entry to the codec
212  * descriptor list and bump libavcodec minor version.
213  */
214 enum AVCodecID {
215     AV_CODEC_ID_NONE,
216
217     /* video codecs */
218     AV_CODEC_ID_MPEG1VIDEO,
219     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220 #if FF_API_XVMC
221     AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
223     AV_CODEC_ID_H261,
224     AV_CODEC_ID_H263,
225     AV_CODEC_ID_RV10,
226     AV_CODEC_ID_RV20,
227     AV_CODEC_ID_MJPEG,
228     AV_CODEC_ID_MJPEGB,
229     AV_CODEC_ID_LJPEG,
230     AV_CODEC_ID_SP5X,
231     AV_CODEC_ID_JPEGLS,
232     AV_CODEC_ID_MPEG4,
233     AV_CODEC_ID_RAWVIDEO,
234     AV_CODEC_ID_MSMPEG4V1,
235     AV_CODEC_ID_MSMPEG4V2,
236     AV_CODEC_ID_MSMPEG4V3,
237     AV_CODEC_ID_WMV1,
238     AV_CODEC_ID_WMV2,
239     AV_CODEC_ID_H263P,
240     AV_CODEC_ID_H263I,
241     AV_CODEC_ID_FLV1,
242     AV_CODEC_ID_SVQ1,
243     AV_CODEC_ID_SVQ3,
244     AV_CODEC_ID_DVVIDEO,
245     AV_CODEC_ID_HUFFYUV,
246     AV_CODEC_ID_CYUV,
247     AV_CODEC_ID_H264,
248     AV_CODEC_ID_INDEO3,
249     AV_CODEC_ID_VP3,
250     AV_CODEC_ID_THEORA,
251     AV_CODEC_ID_ASV1,
252     AV_CODEC_ID_ASV2,
253     AV_CODEC_ID_FFV1,
254     AV_CODEC_ID_4XM,
255     AV_CODEC_ID_VCR1,
256     AV_CODEC_ID_CLJR,
257     AV_CODEC_ID_MDEC,
258     AV_CODEC_ID_ROQ,
259     AV_CODEC_ID_INTERPLAY_VIDEO,
260     AV_CODEC_ID_XAN_WC3,
261     AV_CODEC_ID_XAN_WC4,
262     AV_CODEC_ID_RPZA,
263     AV_CODEC_ID_CINEPAK,
264     AV_CODEC_ID_WS_VQA,
265     AV_CODEC_ID_MSRLE,
266     AV_CODEC_ID_MSVIDEO1,
267     AV_CODEC_ID_IDCIN,
268     AV_CODEC_ID_8BPS,
269     AV_CODEC_ID_SMC,
270     AV_CODEC_ID_FLIC,
271     AV_CODEC_ID_TRUEMOTION1,
272     AV_CODEC_ID_VMDVIDEO,
273     AV_CODEC_ID_MSZH,
274     AV_CODEC_ID_ZLIB,
275     AV_CODEC_ID_QTRLE,
276     AV_CODEC_ID_TSCC,
277     AV_CODEC_ID_ULTI,
278     AV_CODEC_ID_QDRAW,
279     AV_CODEC_ID_VIXL,
280     AV_CODEC_ID_QPEG,
281     AV_CODEC_ID_PNG,
282     AV_CODEC_ID_PPM,
283     AV_CODEC_ID_PBM,
284     AV_CODEC_ID_PGM,
285     AV_CODEC_ID_PGMYUV,
286     AV_CODEC_ID_PAM,
287     AV_CODEC_ID_FFVHUFF,
288     AV_CODEC_ID_RV30,
289     AV_CODEC_ID_RV40,
290     AV_CODEC_ID_VC1,
291     AV_CODEC_ID_WMV3,
292     AV_CODEC_ID_LOCO,
293     AV_CODEC_ID_WNV1,
294     AV_CODEC_ID_AASC,
295     AV_CODEC_ID_INDEO2,
296     AV_CODEC_ID_FRAPS,
297     AV_CODEC_ID_TRUEMOTION2,
298     AV_CODEC_ID_BMP,
299     AV_CODEC_ID_CSCD,
300     AV_CODEC_ID_MMVIDEO,
301     AV_CODEC_ID_ZMBV,
302     AV_CODEC_ID_AVS,
303     AV_CODEC_ID_SMACKVIDEO,
304     AV_CODEC_ID_NUV,
305     AV_CODEC_ID_KMVC,
306     AV_CODEC_ID_FLASHSV,
307     AV_CODEC_ID_CAVS,
308     AV_CODEC_ID_JPEG2000,
309     AV_CODEC_ID_VMNC,
310     AV_CODEC_ID_VP5,
311     AV_CODEC_ID_VP6,
312     AV_CODEC_ID_VP6F,
313     AV_CODEC_ID_TARGA,
314     AV_CODEC_ID_DSICINVIDEO,
315     AV_CODEC_ID_TIERTEXSEQVIDEO,
316     AV_CODEC_ID_TIFF,
317     AV_CODEC_ID_GIF,
318     AV_CODEC_ID_DXA,
319     AV_CODEC_ID_DNXHD,
320     AV_CODEC_ID_THP,
321     AV_CODEC_ID_SGI,
322     AV_CODEC_ID_C93,
323     AV_CODEC_ID_BETHSOFTVID,
324     AV_CODEC_ID_PTX,
325     AV_CODEC_ID_TXD,
326     AV_CODEC_ID_VP6A,
327     AV_CODEC_ID_AMV,
328     AV_CODEC_ID_VB,
329     AV_CODEC_ID_PCX,
330     AV_CODEC_ID_SUNRAST,
331     AV_CODEC_ID_INDEO4,
332     AV_CODEC_ID_INDEO5,
333     AV_CODEC_ID_MIMIC,
334     AV_CODEC_ID_RL2,
335     AV_CODEC_ID_ESCAPE124,
336     AV_CODEC_ID_DIRAC,
337     AV_CODEC_ID_BFI,
338     AV_CODEC_ID_CMV,
339     AV_CODEC_ID_MOTIONPIXELS,
340     AV_CODEC_ID_TGV,
341     AV_CODEC_ID_TGQ,
342     AV_CODEC_ID_TQI,
343     AV_CODEC_ID_AURA,
344     AV_CODEC_ID_AURA2,
345     AV_CODEC_ID_V210X,
346     AV_CODEC_ID_TMV,
347     AV_CODEC_ID_V210,
348     AV_CODEC_ID_DPX,
349     AV_CODEC_ID_MAD,
350     AV_CODEC_ID_FRWU,
351     AV_CODEC_ID_FLASHSV2,
352     AV_CODEC_ID_CDGRAPHICS,
353     AV_CODEC_ID_R210,
354     AV_CODEC_ID_ANM,
355     AV_CODEC_ID_BINKVIDEO,
356     AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
358     AV_CODEC_ID_KGV1,
359     AV_CODEC_ID_YOP,
360     AV_CODEC_ID_VP8,
361     AV_CODEC_ID_PICTOR,
362     AV_CODEC_ID_ANSI,
363     AV_CODEC_ID_A64_MULTI,
364     AV_CODEC_ID_A64_MULTI5,
365     AV_CODEC_ID_R10K,
366     AV_CODEC_ID_MXPEG,
367     AV_CODEC_ID_LAGARITH,
368     AV_CODEC_ID_PRORES,
369     AV_CODEC_ID_JV,
370     AV_CODEC_ID_DFA,
371     AV_CODEC_ID_WMV3IMAGE,
372     AV_CODEC_ID_VC1IMAGE,
373     AV_CODEC_ID_UTVIDEO,
374     AV_CODEC_ID_BMV_VIDEO,
375     AV_CODEC_ID_VBLE,
376     AV_CODEC_ID_DXTORY,
377     AV_CODEC_ID_V410,
378     AV_CODEC_ID_XWD,
379     AV_CODEC_ID_CDXL,
380     AV_CODEC_ID_XBM,
381     AV_CODEC_ID_ZEROCODEC,
382     AV_CODEC_ID_MSS1,
383     AV_CODEC_ID_MSA1,
384     AV_CODEC_ID_TSCC2,
385     AV_CODEC_ID_MTS2,
386     AV_CODEC_ID_CLLC,
387     AV_CODEC_ID_MSS2,
388     AV_CODEC_ID_VP9,
389     AV_CODEC_ID_AIC,
390     AV_CODEC_ID_ESCAPE130,
391     AV_CODEC_ID_G2M,
392     AV_CODEC_ID_WEBP,
393     AV_CODEC_ID_HNM4_VIDEO,
394     AV_CODEC_ID_HEVC,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396     AV_CODEC_ID_FIC,
397     AV_CODEC_ID_ALIAS_PIX,
398     AV_CODEC_ID_BRENDER_PIX,
399     AV_CODEC_ID_PAF_VIDEO,
400     AV_CODEC_ID_EXR,
401     AV_CODEC_ID_VP7,
402     AV_CODEC_ID_SANM,
403     AV_CODEC_ID_SGIRLE,
404     AV_CODEC_ID_MVC1,
405     AV_CODEC_ID_MVC2,
406     AV_CODEC_ID_HQX,
407     AV_CODEC_ID_TDSC,
408     AV_CODEC_ID_HQ_HQA,
409     AV_CODEC_ID_HAP,
410     AV_CODEC_ID_DDS,
411     AV_CODEC_ID_DXV,
412     AV_CODEC_ID_SCREENPRESSO,
413     AV_CODEC_ID_RSCC,
414
415     AV_CODEC_ID_Y41P = 0x8000,
416     AV_CODEC_ID_AVRP,
417     AV_CODEC_ID_012V,
418     AV_CODEC_ID_AVUI,
419     AV_CODEC_ID_AYUV,
420     AV_CODEC_ID_TARGA_Y216,
421     AV_CODEC_ID_V308,
422     AV_CODEC_ID_V408,
423     AV_CODEC_ID_YUV4,
424     AV_CODEC_ID_AVRN,
425     AV_CODEC_ID_CPIA,
426     AV_CODEC_ID_XFACE,
427     AV_CODEC_ID_SNOW,
428     AV_CODEC_ID_SMVJPEG,
429     AV_CODEC_ID_APNG,
430     AV_CODEC_ID_DAALA,
431     AV_CODEC_ID_CFHD,
432     AV_CODEC_ID_TRUEMOTION2RT,
433     AV_CODEC_ID_M101,
434     AV_CODEC_ID_MAGICYUV,
435     AV_CODEC_ID_SHEERVIDEO,
436     AV_CODEC_ID_YLC,
437     AV_CODEC_ID_PSD,
438     AV_CODEC_ID_PIXLET,
439     AV_CODEC_ID_SPEEDHQ,
440     AV_CODEC_ID_FMVC,
441     AV_CODEC_ID_SCPR,
442     AV_CODEC_ID_CLEARVIDEO,
443     AV_CODEC_ID_XPM,
444     AV_CODEC_ID_AV1,
445     AV_CODEC_ID_BITPACKED,
446
447     /* various PCM "codecs" */
448     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
449     AV_CODEC_ID_PCM_S16LE = 0x10000,
450     AV_CODEC_ID_PCM_S16BE,
451     AV_CODEC_ID_PCM_U16LE,
452     AV_CODEC_ID_PCM_U16BE,
453     AV_CODEC_ID_PCM_S8,
454     AV_CODEC_ID_PCM_U8,
455     AV_CODEC_ID_PCM_MULAW,
456     AV_CODEC_ID_PCM_ALAW,
457     AV_CODEC_ID_PCM_S32LE,
458     AV_CODEC_ID_PCM_S32BE,
459     AV_CODEC_ID_PCM_U32LE,
460     AV_CODEC_ID_PCM_U32BE,
461     AV_CODEC_ID_PCM_S24LE,
462     AV_CODEC_ID_PCM_S24BE,
463     AV_CODEC_ID_PCM_U24LE,
464     AV_CODEC_ID_PCM_U24BE,
465     AV_CODEC_ID_PCM_S24DAUD,
466     AV_CODEC_ID_PCM_ZORK,
467     AV_CODEC_ID_PCM_S16LE_PLANAR,
468     AV_CODEC_ID_PCM_DVD,
469     AV_CODEC_ID_PCM_F32BE,
470     AV_CODEC_ID_PCM_F32LE,
471     AV_CODEC_ID_PCM_F64BE,
472     AV_CODEC_ID_PCM_F64LE,
473     AV_CODEC_ID_PCM_BLURAY,
474     AV_CODEC_ID_PCM_LXF,
475     AV_CODEC_ID_S302M,
476     AV_CODEC_ID_PCM_S8_PLANAR,
477     AV_CODEC_ID_PCM_S24LE_PLANAR,
478     AV_CODEC_ID_PCM_S32LE_PLANAR,
479     AV_CODEC_ID_PCM_S16BE_PLANAR,
480
481     AV_CODEC_ID_PCM_S64LE = 0x10800,
482     AV_CODEC_ID_PCM_S64BE,
483     AV_CODEC_ID_PCM_F16LE,
484     AV_CODEC_ID_PCM_F24LE,
485
486     /* various ADPCM codecs */
487     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
488     AV_CODEC_ID_ADPCM_IMA_WAV,
489     AV_CODEC_ID_ADPCM_IMA_DK3,
490     AV_CODEC_ID_ADPCM_IMA_DK4,
491     AV_CODEC_ID_ADPCM_IMA_WS,
492     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
493     AV_CODEC_ID_ADPCM_MS,
494     AV_CODEC_ID_ADPCM_4XM,
495     AV_CODEC_ID_ADPCM_XA,
496     AV_CODEC_ID_ADPCM_ADX,
497     AV_CODEC_ID_ADPCM_EA,
498     AV_CODEC_ID_ADPCM_G726,
499     AV_CODEC_ID_ADPCM_CT,
500     AV_CODEC_ID_ADPCM_SWF,
501     AV_CODEC_ID_ADPCM_YAMAHA,
502     AV_CODEC_ID_ADPCM_SBPRO_4,
503     AV_CODEC_ID_ADPCM_SBPRO_3,
504     AV_CODEC_ID_ADPCM_SBPRO_2,
505     AV_CODEC_ID_ADPCM_THP,
506     AV_CODEC_ID_ADPCM_IMA_AMV,
507     AV_CODEC_ID_ADPCM_EA_R1,
508     AV_CODEC_ID_ADPCM_EA_R3,
509     AV_CODEC_ID_ADPCM_EA_R2,
510     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
511     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
512     AV_CODEC_ID_ADPCM_EA_XAS,
513     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
514     AV_CODEC_ID_ADPCM_IMA_ISS,
515     AV_CODEC_ID_ADPCM_G722,
516     AV_CODEC_ID_ADPCM_IMA_APC,
517     AV_CODEC_ID_ADPCM_VIMA,
518 #if FF_API_VIMA_DECODER
519     AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
520 #endif
521
522     AV_CODEC_ID_ADPCM_AFC = 0x11800,
523     AV_CODEC_ID_ADPCM_IMA_OKI,
524     AV_CODEC_ID_ADPCM_DTK,
525     AV_CODEC_ID_ADPCM_IMA_RAD,
526     AV_CODEC_ID_ADPCM_G726LE,
527     AV_CODEC_ID_ADPCM_THP_LE,
528     AV_CODEC_ID_ADPCM_PSX,
529     AV_CODEC_ID_ADPCM_AICA,
530     AV_CODEC_ID_ADPCM_IMA_DAT4,
531     AV_CODEC_ID_ADPCM_MTAF,
532
533     /* AMR */
534     AV_CODEC_ID_AMR_NB = 0x12000,
535     AV_CODEC_ID_AMR_WB,
536
537     /* RealAudio codecs*/
538     AV_CODEC_ID_RA_144 = 0x13000,
539     AV_CODEC_ID_RA_288,
540
541     /* various DPCM codecs */
542     AV_CODEC_ID_ROQ_DPCM = 0x14000,
543     AV_CODEC_ID_INTERPLAY_DPCM,
544     AV_CODEC_ID_XAN_DPCM,
545     AV_CODEC_ID_SOL_DPCM,
546
547     AV_CODEC_ID_SDX2_DPCM = 0x14800,
548
549     /* audio codecs */
550     AV_CODEC_ID_MP2 = 0x15000,
551     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
552     AV_CODEC_ID_AAC,
553     AV_CODEC_ID_AC3,
554     AV_CODEC_ID_DTS,
555     AV_CODEC_ID_VORBIS,
556     AV_CODEC_ID_DVAUDIO,
557     AV_CODEC_ID_WMAV1,
558     AV_CODEC_ID_WMAV2,
559     AV_CODEC_ID_MACE3,
560     AV_CODEC_ID_MACE6,
561     AV_CODEC_ID_VMDAUDIO,
562     AV_CODEC_ID_FLAC,
563     AV_CODEC_ID_MP3ADU,
564     AV_CODEC_ID_MP3ON4,
565     AV_CODEC_ID_SHORTEN,
566     AV_CODEC_ID_ALAC,
567     AV_CODEC_ID_WESTWOOD_SND1,
568     AV_CODEC_ID_GSM, ///< as in Berlin toast format
569     AV_CODEC_ID_QDM2,
570     AV_CODEC_ID_COOK,
571     AV_CODEC_ID_TRUESPEECH,
572     AV_CODEC_ID_TTA,
573     AV_CODEC_ID_SMACKAUDIO,
574     AV_CODEC_ID_QCELP,
575     AV_CODEC_ID_WAVPACK,
576     AV_CODEC_ID_DSICINAUDIO,
577     AV_CODEC_ID_IMC,
578     AV_CODEC_ID_MUSEPACK7,
579     AV_CODEC_ID_MLP,
580     AV_CODEC_ID_GSM_MS, /* as found in WAV */
581     AV_CODEC_ID_ATRAC3,
582 #if FF_API_VOXWARE
583     AV_CODEC_ID_VOXWARE,
584 #endif
585     AV_CODEC_ID_APE,
586     AV_CODEC_ID_NELLYMOSER,
587     AV_CODEC_ID_MUSEPACK8,
588     AV_CODEC_ID_SPEEX,
589     AV_CODEC_ID_WMAVOICE,
590     AV_CODEC_ID_WMAPRO,
591     AV_CODEC_ID_WMALOSSLESS,
592     AV_CODEC_ID_ATRAC3P,
593     AV_CODEC_ID_EAC3,
594     AV_CODEC_ID_SIPR,
595     AV_CODEC_ID_MP1,
596     AV_CODEC_ID_TWINVQ,
597     AV_CODEC_ID_TRUEHD,
598     AV_CODEC_ID_MP4ALS,
599     AV_CODEC_ID_ATRAC1,
600     AV_CODEC_ID_BINKAUDIO_RDFT,
601     AV_CODEC_ID_BINKAUDIO_DCT,
602     AV_CODEC_ID_AAC_LATM,
603     AV_CODEC_ID_QDMC,
604     AV_CODEC_ID_CELT,
605     AV_CODEC_ID_G723_1,
606     AV_CODEC_ID_G729,
607     AV_CODEC_ID_8SVX_EXP,
608     AV_CODEC_ID_8SVX_FIB,
609     AV_CODEC_ID_BMV_AUDIO,
610     AV_CODEC_ID_RALF,
611     AV_CODEC_ID_IAC,
612     AV_CODEC_ID_ILBC,
613     AV_CODEC_ID_OPUS,
614     AV_CODEC_ID_COMFORT_NOISE,
615     AV_CODEC_ID_TAK,
616     AV_CODEC_ID_METASOUND,
617     AV_CODEC_ID_PAF_AUDIO,
618     AV_CODEC_ID_ON2AVC,
619     AV_CODEC_ID_DSS_SP,
620
621     AV_CODEC_ID_FFWAVESYNTH = 0x15800,
622     AV_CODEC_ID_SONIC,
623     AV_CODEC_ID_SONIC_LS,
624     AV_CODEC_ID_EVRC,
625     AV_CODEC_ID_SMV,
626     AV_CODEC_ID_DSD_LSBF,
627     AV_CODEC_ID_DSD_MSBF,
628     AV_CODEC_ID_DSD_LSBF_PLANAR,
629     AV_CODEC_ID_DSD_MSBF_PLANAR,
630     AV_CODEC_ID_4GV,
631     AV_CODEC_ID_INTERPLAY_ACM,
632     AV_CODEC_ID_XMA1,
633     AV_CODEC_ID_XMA2,
634     AV_CODEC_ID_DST,
635     AV_CODEC_ID_ATRAC3AL,
636     AV_CODEC_ID_ATRAC3PAL,
637
638     /* subtitle codecs */
639     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
640     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
641     AV_CODEC_ID_DVB_SUBTITLE,
642     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
643     AV_CODEC_ID_XSUB,
644     AV_CODEC_ID_SSA,
645     AV_CODEC_ID_MOV_TEXT,
646     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
647     AV_CODEC_ID_DVB_TELETEXT,
648     AV_CODEC_ID_SRT,
649
650     AV_CODEC_ID_MICRODVD   = 0x17800,
651     AV_CODEC_ID_EIA_608,
652     AV_CODEC_ID_JACOSUB,
653     AV_CODEC_ID_SAMI,
654     AV_CODEC_ID_REALTEXT,
655     AV_CODEC_ID_STL,
656     AV_CODEC_ID_SUBVIEWER1,
657     AV_CODEC_ID_SUBVIEWER,
658     AV_CODEC_ID_SUBRIP,
659     AV_CODEC_ID_WEBVTT,
660     AV_CODEC_ID_MPL2,
661     AV_CODEC_ID_VPLAYER,
662     AV_CODEC_ID_PJS,
663     AV_CODEC_ID_ASS,
664     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
665
666     /* other specific kind of codecs (generally used for attachments) */
667     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
668     AV_CODEC_ID_TTF = 0x18000,
669
670     AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
671     AV_CODEC_ID_BINTEXT    = 0x18800,
672     AV_CODEC_ID_XBIN,
673     AV_CODEC_ID_IDF,
674     AV_CODEC_ID_OTF,
675     AV_CODEC_ID_SMPTE_KLV,
676     AV_CODEC_ID_DVD_NAV,
677     AV_CODEC_ID_TIMED_ID3,
678     AV_CODEC_ID_BIN_DATA,
679
680
681     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
682
683     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
684                                 * stream (only used by libavformat) */
685     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
686                                 * stream (only used by libavformat) */
687     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
688     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
689 };
690
691 /**
692  * This struct describes the properties of a single codec described by an
693  * AVCodecID.
694  * @see avcodec_descriptor_get()
695  */
696 typedef struct AVCodecDescriptor {
697     enum AVCodecID     id;
698     enum AVMediaType type;
699     /**
700      * Name of the codec described by this descriptor. It is non-empty and
701      * unique for each codec descriptor. It should contain alphanumeric
702      * characters and '_' only.
703      */
704     const char      *name;
705     /**
706      * A more descriptive name for this codec. May be NULL.
707      */
708     const char *long_name;
709     /**
710      * Codec properties, a combination of AV_CODEC_PROP_* flags.
711      */
712     int             props;
713     /**
714      * MIME type(s) associated with the codec.
715      * May be NULL; if not, a NULL-terminated array of MIME types.
716      * The first item is always non-NULL and is the preferred MIME type.
717      */
718     const char *const *mime_types;
719     /**
720      * If non-NULL, an array of profiles recognized for this codec.
721      * Terminated with FF_PROFILE_UNKNOWN.
722      */
723     const struct AVProfile *profiles;
724 } AVCodecDescriptor;
725
726 /**
727  * Codec uses only intra compression.
728  * Video and audio codecs only.
729  */
730 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
731 /**
732  * Codec supports lossy compression. Audio and video codecs only.
733  * @note a codec may support both lossy and lossless
734  * compression modes
735  */
736 #define AV_CODEC_PROP_LOSSY         (1 << 1)
737 /**
738  * Codec supports lossless compression. Audio and video codecs only.
739  */
740 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
741 /**
742  * Codec supports frame reordering. That is, the coded order (the order in which
743  * the encoded packets are output by the encoders / stored / input to the
744  * decoders) may be different from the presentation order of the corresponding
745  * frames.
746  *
747  * For codecs that do not have this property set, PTS and DTS should always be
748  * equal.
749  */
750 #define AV_CODEC_PROP_REORDER       (1 << 3)
751 /**
752  * Subtitle codec is bitmap based
753  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
754  */
755 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
756 /**
757  * Subtitle codec is text based.
758  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
759  */
760 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
761
762 /**
763  * @ingroup lavc_decoding
764  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
765  * This is mainly needed because some optimized bitstream readers read
766  * 32 or 64 bit at once and could read over the end.<br>
767  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
768  * MPEG bitstreams could cause overread and segfault.
769  */
770 #define AV_INPUT_BUFFER_PADDING_SIZE 32
771
772 /**
773  * @ingroup lavc_encoding
774  * minimum encoding buffer size
775  * Used to avoid some checks during header writing.
776  */
777 #define AV_INPUT_BUFFER_MIN_SIZE 16384
778
779 #if FF_API_WITHOUT_PREFIX
780 /**
781  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
782  */
783 #define FF_INPUT_BUFFER_PADDING_SIZE 32
784
785 /**
786  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
787  */
788 #define FF_MIN_BUFFER_SIZE 16384
789 #endif /* FF_API_WITHOUT_PREFIX */
790
791 /**
792  * @ingroup lavc_encoding
793  * motion estimation type.
794  * @deprecated use codec private option instead
795  */
796 #if FF_API_MOTION_EST
797 enum Motion_Est_ID {
798     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
799     ME_FULL,
800     ME_LOG,
801     ME_PHODS,
802     ME_EPZS,        ///< enhanced predictive zonal search
803     ME_X1,          ///< reserved for experiments
804     ME_HEX,         ///< hexagon based search
805     ME_UMH,         ///< uneven multi-hexagon search
806     ME_TESA,        ///< transformed exhaustive search algorithm
807     ME_ITER=50,     ///< iterative search
808 };
809 #endif
810
811 /**
812  * @ingroup lavc_decoding
813  */
814 enum AVDiscard{
815     /* We leave some space between them for extensions (drop some
816      * keyframes for intra-only or drop just some bidir frames). */
817     AVDISCARD_NONE    =-16, ///< discard nothing
818     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
819     AVDISCARD_NONREF  =  8, ///< discard all non reference
820     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
821     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
822     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
823     AVDISCARD_ALL     = 48, ///< discard all
824 };
825
826 enum AVAudioServiceType {
827     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
828     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
829     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
830     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
831     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
832     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
833     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
834     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
835     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
836     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
837 };
838
839 /**
840  * @ingroup lavc_encoding
841  */
842 typedef struct RcOverride{
843     int start_frame;
844     int end_frame;
845     int qscale; // If this is 0 then quality_factor will be used instead.
846     float quality_factor;
847 } RcOverride;
848
849 #if FF_API_MAX_BFRAMES
850 /**
851  * @deprecated there is no libavcodec-wide limit on the number of B-frames
852  */
853 #define FF_MAX_B_FRAMES 16
854 #endif
855
856 /* encoding support
857    These flags can be passed in AVCodecContext.flags before initialization.
858    Note: Not everything is supported yet.
859 */
860
861 /**
862  * Allow decoders to produce frames with data planes that are not aligned
863  * to CPU requirements (e.g. due to cropping).
864  */
865 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
866 /**
867  * Use fixed qscale.
868  */
869 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
870 /**
871  * 4 MV per MB allowed / advanced prediction for H.263.
872  */
873 #define AV_CODEC_FLAG_4MV             (1 <<  2)
874 /**
875  * Output even those frames that might be corrupted.
876  */
877 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
878 /**
879  * Use qpel MC.
880  */
881 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
882 /**
883  * Use internal 2pass ratecontrol in first pass mode.
884  */
885 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
886 /**
887  * Use internal 2pass ratecontrol in second pass mode.
888  */
889 #define AV_CODEC_FLAG_PASS2           (1 << 10)
890 /**
891  * loop filter.
892  */
893 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
894 /**
895  * Only decode/encode grayscale.
896  */
897 #define AV_CODEC_FLAG_GRAY            (1 << 13)
898 /**
899  * error[?] variables will be set during encoding.
900  */
901 #define AV_CODEC_FLAG_PSNR            (1 << 15)
902 /**
903  * Input bitstream might be truncated at a random location
904  * instead of only at frame boundaries.
905  */
906 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
907 /**
908  * Use interlaced DCT.
909  */
910 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
911 /**
912  * Force low delay.
913  */
914 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
915 /**
916  * Place global headers in extradata instead of every keyframe.
917  */
918 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
919 /**
920  * Use only bitexact stuff (except (I)DCT).
921  */
922 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
923 /* Fx : Flag for H.263+ extra options */
924 /**
925  * H.263 advanced intra coding / MPEG-4 AC prediction
926  */
927 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
928 /**
929  * interlaced motion estimation
930  */
931 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
932 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
933
934 /**
935  * Allow non spec compliant speedup tricks.
936  */
937 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
938 /**
939  * Skip bitstream encoding.
940  */
941 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
942 /**
943  * Place global headers at every keyframe instead of in extradata.
944  */
945 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
946
947 /**
948  * timecode is in drop frame format. DEPRECATED!!!!
949  */
950 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
951
952 /**
953  * Input bitstream might be truncated at a packet boundaries
954  * instead of only at frame boundaries.
955  */
956 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
957 /**
958  * Discard cropping information from SPS.
959  */
960 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
961
962 /**
963  * Show all frames before the first keyframe
964  */
965 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
966 /**
967  * Export motion vectors through frame side data
968  */
969 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
970 /**
971  * Do not skip samples and export skip information as frame side data
972  */
973 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
974 /**
975  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
976  */
977 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
978
979 /* Unsupported options :
980  *              Syntax Arithmetic coding (SAC)
981  *              Reference Picture Selection
982  *              Independent Segment Decoding */
983 /* /Fx */
984 /* codec capabilities */
985
986 /**
987  * Decoder can use draw_horiz_band callback.
988  */
989 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
990 /**
991  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
992  * If not set, it might not use get_buffer() at all or use operations that
993  * assume the buffer was allocated by avcodec_default_get_buffer.
994  */
995 #define AV_CODEC_CAP_DR1                 (1 <<  1)
996 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
997 /**
998  * Encoder or decoder requires flushing with NULL input at the end in order to
999  * give the complete and correct output.
1000  *
1001  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1002  *       with NULL data. The user can still send NULL data to the public encode
1003  *       or decode function, but libavcodec will not pass it along to the codec
1004  *       unless this flag is set.
1005  *
1006  * Decoders:
1007  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1008  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1009  * returns frames.
1010  *
1011  * Encoders:
1012  * The encoder needs to be fed with NULL data at the end of encoding until the
1013  * encoder no longer returns data.
1014  *
1015  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1016  *       flag also means that the encoder must set the pts and duration for
1017  *       each output packet. If this flag is not set, the pts and duration will
1018  *       be determined by libavcodec from the input frame.
1019  */
1020 #define AV_CODEC_CAP_DELAY               (1 <<  5)
1021 /**
1022  * Codec can be fed a final frame with a smaller size.
1023  * This can be used to prevent truncation of the last audio samples.
1024  */
1025 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
1026
1027 #if FF_API_CAP_VDPAU
1028 /**
1029  * Codec can export data for HW decoding (VDPAU).
1030  */
1031 #define AV_CODEC_CAP_HWACCEL_VDPAU       (1 <<  7)
1032 #endif
1033
1034 /**
1035  * Codec can output multiple frames per AVPacket
1036  * Normally demuxers return one frame at a time, demuxers which do not do
1037  * are connected to a parser to split what they return into proper frames.
1038  * This flag is reserved to the very rare category of codecs which have a
1039  * bitstream that cannot be split into frames without timeconsuming
1040  * operations like full decoding. Demuxers carrying such bitstreams thus
1041  * may return multiple frames in a packet. This has many disadvantages like
1042  * prohibiting stream copy in many cases thus it should only be considered
1043  * as a last resort.
1044  */
1045 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1046 /**
1047  * Codec is experimental and is thus avoided in favor of non experimental
1048  * encoders
1049  */
1050 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1051 /**
1052  * Codec should fill in channel configuration and samplerate instead of container
1053  */
1054 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1055 /**
1056  * Codec supports frame-level multithreading.
1057  */
1058 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1059 /**
1060  * Codec supports slice-based (or partition-based) multithreading.
1061  */
1062 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1063 /**
1064  * Codec supports changed parameters at any point.
1065  */
1066 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1067 /**
1068  * Codec supports avctx->thread_count == 0 (auto).
1069  */
1070 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1071 /**
1072  * Audio encoder supports receiving a different number of samples in each call.
1073  */
1074 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1075 /**
1076  * Decoder is not a preferred choice for probing.
1077  * This indicates that the decoder is not a good choice for probing.
1078  * It could for example be an expensive to spin up hardware decoder,
1079  * or it could simply not provide a lot of useful information about
1080  * the stream.
1081  * A decoder marked with this flag should only be used as last resort
1082  * choice for probing.
1083  */
1084 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
1085 /**
1086  * Codec is intra only.
1087  */
1088 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1089 /**
1090  * Codec is lossless.
1091  */
1092 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1093
1094
1095 #if FF_API_WITHOUT_PREFIX
1096 /**
1097  * Allow decoders to produce frames with data planes that are not aligned
1098  * to CPU requirements (e.g. due to cropping).
1099  */
1100 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1101 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1102 #define CODEC_FLAG_4MV    AV_CODEC_FLAG_4MV
1103 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1104 #define CODEC_FLAG_QPEL   AV_CODEC_FLAG_QPEL
1105 #if FF_API_GMC
1106 /**
1107  * @deprecated use the "gmc" private option of the libxvid encoder
1108  */
1109 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
1110 #endif
1111 #if FF_API_MV0
1112 /**
1113  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1114  * mpegvideo encoders
1115  */
1116 #define CODEC_FLAG_MV0    0x0040
1117 #endif
1118 #if FF_API_INPUT_PRESERVED
1119 /**
1120  * @deprecated passing reference-counted frames to the encoders replaces this
1121  * flag
1122  */
1123 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1124 #endif
1125 #define CODEC_FLAG_PASS1           AV_CODEC_FLAG_PASS1
1126 #define CODEC_FLAG_PASS2           AV_CODEC_FLAG_PASS2
1127 #define CODEC_FLAG_GRAY            AV_CODEC_FLAG_GRAY
1128 #if FF_API_EMU_EDGE
1129 /**
1130  * @deprecated edges are not used/required anymore. I.e. this flag is now always
1131  * set.
1132  */
1133 #define CODEC_FLAG_EMU_EDGE        0x4000
1134 #endif
1135 #define CODEC_FLAG_PSNR            AV_CODEC_FLAG_PSNR
1136 #define CODEC_FLAG_TRUNCATED       AV_CODEC_FLAG_TRUNCATED
1137
1138 #if FF_API_NORMALIZE_AQP
1139 /**
1140  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1141  * mpegvideo encoders
1142  */
1143 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
1144 #endif
1145 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1146 #define CODEC_FLAG_LOW_DELAY      AV_CODEC_FLAG_LOW_DELAY
1147 #define CODEC_FLAG_GLOBAL_HEADER  AV_CODEC_FLAG_GLOBAL_HEADER
1148 #define CODEC_FLAG_BITEXACT       AV_CODEC_FLAG_BITEXACT
1149 #define CODEC_FLAG_AC_PRED        AV_CODEC_FLAG_AC_PRED
1150 #define CODEC_FLAG_LOOP_FILTER    AV_CODEC_FLAG_LOOP_FILTER
1151 #define CODEC_FLAG_INTERLACED_ME  AV_CODEC_FLAG_INTERLACED_ME
1152 #define CODEC_FLAG_CLOSED_GOP     AV_CODEC_FLAG_CLOSED_GOP
1153 #define CODEC_FLAG2_FAST          AV_CODEC_FLAG2_FAST
1154 #define CODEC_FLAG2_NO_OUTPUT     AV_CODEC_FLAG2_NO_OUTPUT
1155 #define CODEC_FLAG2_LOCAL_HEADER  AV_CODEC_FLAG2_LOCAL_HEADER
1156 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1157 #define CODEC_FLAG2_IGNORE_CROP   AV_CODEC_FLAG2_IGNORE_CROP
1158
1159 #define CODEC_FLAG2_CHUNKS        AV_CODEC_FLAG2_CHUNKS
1160 #define CODEC_FLAG2_SHOW_ALL      AV_CODEC_FLAG2_SHOW_ALL
1161 #define CODEC_FLAG2_EXPORT_MVS    AV_CODEC_FLAG2_EXPORT_MVS
1162 #define CODEC_FLAG2_SKIP_MANUAL   AV_CODEC_FLAG2_SKIP_MANUAL
1163
1164 /* Unsupported options :
1165  *              Syntax Arithmetic coding (SAC)
1166  *              Reference Picture Selection
1167  *              Independent Segment Decoding */
1168 /* /Fx */
1169 /* codec capabilities */
1170
1171 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1172 /**
1173  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1174  * If not set, it might not use get_buffer() at all or use operations that
1175  * assume the buffer was allocated by avcodec_default_get_buffer.
1176  */
1177 #define CODEC_CAP_DR1             AV_CODEC_CAP_DR1
1178 #define CODEC_CAP_TRUNCATED       AV_CODEC_CAP_TRUNCATED
1179 #if FF_API_XVMC
1180 /* Codec can export data for HW decoding. This flag indicates that
1181  * the codec would call get_format() with list that might contain HW accelerated
1182  * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1183  * including raw image format.
1184  * The application can use the passed context to determine bitstream version,
1185  * chroma format, resolution etc.
1186  */
1187 #define CODEC_CAP_HWACCEL         0x0010
1188 #endif /* FF_API_XVMC */
1189 /**
1190  * Encoder or decoder requires flushing with NULL input at the end in order to
1191  * give the complete and correct output.
1192  *
1193  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1194  *       with NULL data. The user can still send NULL data to the public encode
1195  *       or decode function, but libavcodec will not pass it along to the codec
1196  *       unless this flag is set.
1197  *
1198  * Decoders:
1199  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1200  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1201  * returns frames.
1202  *
1203  * Encoders:
1204  * The encoder needs to be fed with NULL data at the end of encoding until the
1205  * encoder no longer returns data.
1206  *
1207  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1208  *       flag also means that the encoder must set the pts and duration for
1209  *       each output packet. If this flag is not set, the pts and duration will
1210  *       be determined by libavcodec from the input frame.
1211  */
1212 #define CODEC_CAP_DELAY           AV_CODEC_CAP_DELAY
1213 /**
1214  * Codec can be fed a final frame with a smaller size.
1215  * This can be used to prevent truncation of the last audio samples.
1216  */
1217 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1218 #if FF_API_CAP_VDPAU
1219 /**
1220  * Codec can export data for HW decoding (VDPAU).
1221  */
1222 #define CODEC_CAP_HWACCEL_VDPAU    AV_CODEC_CAP_HWACCEL_VDPAU
1223 #endif
1224 /**
1225  * Codec can output multiple frames per AVPacket
1226  * Normally demuxers return one frame at a time, demuxers which do not do
1227  * are connected to a parser to split what they return into proper frames.
1228  * This flag is reserved to the very rare category of codecs which have a
1229  * bitstream that cannot be split into frames without timeconsuming
1230  * operations like full decoding. Demuxers carrying such bitstreams thus
1231  * may return multiple frames in a packet. This has many disadvantages like
1232  * prohibiting stream copy in many cases thus it should only be considered
1233  * as a last resort.
1234  */
1235 #define CODEC_CAP_SUBFRAMES        AV_CODEC_CAP_SUBFRAMES
1236 /**
1237  * Codec is experimental and is thus avoided in favor of non experimental
1238  * encoders
1239  */
1240 #define CODEC_CAP_EXPERIMENTAL     AV_CODEC_CAP_EXPERIMENTAL
1241 /**
1242  * Codec should fill in channel configuration and samplerate instead of container
1243  */
1244 #define CODEC_CAP_CHANNEL_CONF     AV_CODEC_CAP_CHANNEL_CONF
1245 #if FF_API_NEG_LINESIZES
1246 /**
1247  * @deprecated no codecs use this capability
1248  */
1249 #define CODEC_CAP_NEG_LINESIZES    0x0800
1250 #endif
1251 /**
1252  * Codec supports frame-level multithreading.
1253  */
1254 #define CODEC_CAP_FRAME_THREADS    AV_CODEC_CAP_FRAME_THREADS
1255 /**
1256  * Codec supports slice-based (or partition-based) multithreading.
1257  */
1258 #define CODEC_CAP_SLICE_THREADS    AV_CODEC_CAP_SLICE_THREADS
1259 /**
1260  * Codec supports changed parameters at any point.
1261  */
1262 #define CODEC_CAP_PARAM_CHANGE     AV_CODEC_CAP_PARAM_CHANGE
1263 /**
1264  * Codec supports avctx->thread_count == 0 (auto).
1265  */
1266 #define CODEC_CAP_AUTO_THREADS     AV_CODEC_CAP_AUTO_THREADS
1267 /**
1268  * Audio encoder supports receiving a different number of samples in each call.
1269  */
1270 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1271 /**
1272  * Codec is intra only.
1273  */
1274 #define CODEC_CAP_INTRA_ONLY       AV_CODEC_CAP_INTRA_ONLY
1275 /**
1276  * Codec is lossless.
1277  */
1278 #define CODEC_CAP_LOSSLESS         AV_CODEC_CAP_LOSSLESS
1279
1280 /**
1281  * HWAccel is experimental and is thus avoided in favor of non experimental
1282  * codecs
1283  */
1284 #define HWACCEL_CODEC_CAP_EXPERIMENTAL     0x0200
1285 #endif /* FF_API_WITHOUT_PREFIX */
1286
1287 #if FF_API_MB_TYPE
1288 //The following defines may change, don't expect compatibility if you use them.
1289 #define MB_TYPE_INTRA4x4   0x0001
1290 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1291 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1292 #define MB_TYPE_16x16      0x0008
1293 #define MB_TYPE_16x8       0x0010
1294 #define MB_TYPE_8x16       0x0020
1295 #define MB_TYPE_8x8        0x0040
1296 #define MB_TYPE_INTERLACED 0x0080
1297 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1298 #define MB_TYPE_ACPRED     0x0200
1299 #define MB_TYPE_GMC        0x0400
1300 #define MB_TYPE_SKIP       0x0800
1301 #define MB_TYPE_P0L0       0x1000
1302 #define MB_TYPE_P1L0       0x2000
1303 #define MB_TYPE_P0L1       0x4000
1304 #define MB_TYPE_P1L1       0x8000
1305 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1306 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1307 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1308 #define MB_TYPE_QUANT      0x00010000
1309 #define MB_TYPE_CBP        0x00020000
1310 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1311 #endif
1312
1313 /**
1314  * Pan Scan area.
1315  * This specifies the area which should be displayed.
1316  * Note there may be multiple such areas for one frame.
1317  */
1318 typedef struct AVPanScan{
1319     /**
1320      * id
1321      * - encoding: Set by user.
1322      * - decoding: Set by libavcodec.
1323      */
1324     int id;
1325
1326     /**
1327      * width and height in 1/16 pel
1328      * - encoding: Set by user.
1329      * - decoding: Set by libavcodec.
1330      */
1331     int width;
1332     int height;
1333
1334     /**
1335      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1336      * - encoding: Set by user.
1337      * - decoding: Set by libavcodec.
1338      */
1339     int16_t position[3][2];
1340 }AVPanScan;
1341
1342 /**
1343  * This structure describes the bitrate properties of an encoded bitstream. It
1344  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1345  * parameters for H.264/HEVC.
1346  */
1347 typedef struct AVCPBProperties {
1348     /**
1349      * Maximum bitrate of the stream, in bits per second.
1350      * Zero if unknown or unspecified.
1351      */
1352     int max_bitrate;
1353     /**
1354      * Minimum bitrate of the stream, in bits per second.
1355      * Zero if unknown or unspecified.
1356      */
1357     int min_bitrate;
1358     /**
1359      * Average bitrate of the stream, in bits per second.
1360      * Zero if unknown or unspecified.
1361      */
1362     int avg_bitrate;
1363
1364     /**
1365      * The size of the buffer to which the ratecontrol is applied, in bits.
1366      * Zero if unknown or unspecified.
1367      */
1368     int buffer_size;
1369
1370     /**
1371      * The delay between the time the packet this structure is associated with
1372      * is received and the time when it should be decoded, in periods of a 27MHz
1373      * clock.
1374      *
1375      * UINT64_MAX when unknown or unspecified.
1376      */
1377     uint64_t vbv_delay;
1378 } AVCPBProperties;
1379
1380 #if FF_API_QSCALE_TYPE
1381 #define FF_QSCALE_TYPE_MPEG1 0
1382 #define FF_QSCALE_TYPE_MPEG2 1
1383 #define FF_QSCALE_TYPE_H264  2
1384 #define FF_QSCALE_TYPE_VP56  3
1385 #endif
1386
1387 /**
1388  * The decoder will keep a reference to the frame and may reuse it later.
1389  */
1390 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1391
1392 /**
1393  * @defgroup lavc_packet AVPacket
1394  *
1395  * Types and functions for working with AVPacket.
1396  * @{
1397  */
1398 enum AVPacketSideDataType {
1399     /**
1400      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1401      * bytes worth of palette. This side data signals that a new palette is
1402      * present.
1403      */
1404     AV_PKT_DATA_PALETTE,
1405
1406     /**
1407      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1408      * that the extradata buffer was changed and the receiving side should
1409      * act upon it appropriately. The new extradata is embedded in the side
1410      * data buffer and should be immediately used for processing the current
1411      * frame or packet.
1412      */
1413     AV_PKT_DATA_NEW_EXTRADATA,
1414
1415     /**
1416      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1417      * @code
1418      * u32le param_flags
1419      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1420      *     s32le channel_count
1421      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1422      *     u64le channel_layout
1423      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1424      *     s32le sample_rate
1425      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1426      *     s32le width
1427      *     s32le height
1428      * @endcode
1429      */
1430     AV_PKT_DATA_PARAM_CHANGE,
1431
1432     /**
1433      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1434      * structures with info about macroblocks relevant to splitting the
1435      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1436      * That is, it does not necessarily contain info about all macroblocks,
1437      * as long as the distance between macroblocks in the info is smaller
1438      * than the target payload size.
1439      * Each MB info structure is 12 bytes, and is laid out as follows:
1440      * @code
1441      * u32le bit offset from the start of the packet
1442      * u8    current quantizer at the start of the macroblock
1443      * u8    GOB number
1444      * u16le macroblock address within the GOB
1445      * u8    horizontal MV predictor
1446      * u8    vertical MV predictor
1447      * u8    horizontal MV predictor for block number 3
1448      * u8    vertical MV predictor for block number 3
1449      * @endcode
1450      */
1451     AV_PKT_DATA_H263_MB_INFO,
1452
1453     /**
1454      * This side data should be associated with an audio stream and contains
1455      * ReplayGain information in form of the AVReplayGain struct.
1456      */
1457     AV_PKT_DATA_REPLAYGAIN,
1458
1459     /**
1460      * This side data contains a 3x3 transformation matrix describing an affine
1461      * transformation that needs to be applied to the decoded video frames for
1462      * correct presentation.
1463      *
1464      * See libavutil/display.h for a detailed description of the data.
1465      */
1466     AV_PKT_DATA_DISPLAYMATRIX,
1467
1468     /**
1469      * This side data should be associated with a video stream and contains
1470      * Stereoscopic 3D information in form of the AVStereo3D struct.
1471      */
1472     AV_PKT_DATA_STEREO3D,
1473
1474     /**
1475      * This side data should be associated with an audio stream and corresponds
1476      * to enum AVAudioServiceType.
1477      */
1478     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1479
1480     /**
1481      * This side data contains quality related information from the encoder.
1482      * @code
1483      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1484      * u8    picture type
1485      * u8    error count
1486      * u16   reserved
1487      * u64le[error count] sum of squared differences between encoder in and output
1488      * @endcode
1489      */
1490     AV_PKT_DATA_QUALITY_STATS,
1491
1492     /**
1493      * This side data contains an integer value representing the stream index
1494      * of a "fallback" track.  A fallback track indicates an alternate
1495      * track to use when the current track can not be decoded for some reason.
1496      * e.g. no decoder available for codec.
1497      */
1498     AV_PKT_DATA_FALLBACK_TRACK,
1499
1500     /**
1501      * This side data corresponds to the AVCPBProperties struct.
1502      */
1503     AV_PKT_DATA_CPB_PROPERTIES,
1504
1505     /**
1506      * Recommmends skipping the specified number of samples
1507      * @code
1508      * u32le number of samples to skip from start of this packet
1509      * u32le number of samples to skip from end of this packet
1510      * u8    reason for start skip
1511      * u8    reason for end   skip (0=padding silence, 1=convergence)
1512      * @endcode
1513      */
1514     AV_PKT_DATA_SKIP_SAMPLES=70,
1515
1516     /**
1517      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1518      * the packet may contain "dual mono" audio specific to Japanese DTV
1519      * and if it is true, recommends only the selected channel to be used.
1520      * @code
1521      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1522      * @endcode
1523      */
1524     AV_PKT_DATA_JP_DUALMONO,
1525
1526     /**
1527      * A list of zero terminated key/value strings. There is no end marker for
1528      * the list, so it is required to rely on the side data size to stop.
1529      */
1530     AV_PKT_DATA_STRINGS_METADATA,
1531
1532     /**
1533      * Subtitle event position
1534      * @code
1535      * u32le x1
1536      * u32le y1
1537      * u32le x2
1538      * u32le y2
1539      * @endcode
1540      */
1541     AV_PKT_DATA_SUBTITLE_POSITION,
1542
1543     /**
1544      * Data found in BlockAdditional element of matroska container. There is
1545      * no end marker for the data, so it is required to rely on the side data
1546      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1547      * by data.
1548      */
1549     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1550
1551     /**
1552      * The optional first identifier line of a WebVTT cue.
1553      */
1554     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1555
1556     /**
1557      * The optional settings (rendering instructions) that immediately
1558      * follow the timestamp specifier of a WebVTT cue.
1559      */
1560     AV_PKT_DATA_WEBVTT_SETTINGS,
1561
1562     /**
1563      * A list of zero terminated key/value strings. There is no end marker for
1564      * the list, so it is required to rely on the side data size to stop. This
1565      * side data includes updated metadata which appeared in the stream.
1566      */
1567     AV_PKT_DATA_METADATA_UPDATE,
1568
1569     /**
1570      * MPEGTS stream ID, this is required to pass the stream ID
1571      * information from the demuxer to the corresponding muxer.
1572      */
1573     AV_PKT_DATA_MPEGTS_STREAM_ID,
1574
1575     /**
1576      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1577      * should be associated with a video stream and containts data in the form
1578      * of the AVMasteringDisplayMetadata struct.
1579      */
1580     AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1581
1582     /**
1583      * This side data should be associated with a video stream and corresponds
1584      * to the AVSphericalMapping structure.
1585      */
1586     AV_PKT_DATA_SPHERICAL,
1587 };
1588
1589 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1590
1591 typedef struct AVPacketSideData {
1592     uint8_t *data;
1593     int      size;
1594     enum AVPacketSideDataType type;
1595 } AVPacketSideData;
1596
1597 /**
1598  * This structure stores compressed data. It is typically exported by demuxers
1599  * and then passed as input to decoders, or received as output from encoders and
1600  * then passed to muxers.
1601  *
1602  * For video, it should typically contain one compressed frame. For audio it may
1603  * contain several compressed frames. Encoders are allowed to output empty
1604  * packets, with no compressed data, containing only side data
1605  * (e.g. to update some stream parameters at the end of encoding).
1606  *
1607  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1608  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1609  * without libavcodec and libavformat major bump.
1610  *
1611  * The semantics of data ownership depends on the buf field.
1612  * If it is set, the packet data is dynamically allocated and is
1613  * valid indefinitely until a call to av_packet_unref() reduces the
1614  * reference count to 0.
1615  *
1616  * If the buf field is not set av_packet_ref() would make a copy instead
1617  * of increasing the reference count.
1618  *
1619  * The side data is always allocated with av_malloc(), copied by
1620  * av_packet_ref() and freed by av_packet_unref().
1621  *
1622  * @see av_packet_ref
1623  * @see av_packet_unref
1624  */
1625 typedef struct AVPacket {
1626     /**
1627      * A reference to the reference-counted buffer where the packet data is
1628      * stored.
1629      * May be NULL, then the packet data is not reference-counted.
1630      */
1631     AVBufferRef *buf;
1632     /**
1633      * Presentation timestamp in AVStream->time_base units; the time at which
1634      * the decompressed packet will be presented to the user.
1635      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1636      * pts MUST be larger or equal to dts as presentation cannot happen before
1637      * decompression, unless one wants to view hex dumps. Some formats misuse
1638      * the terms dts and pts/cts to mean something different. Such timestamps
1639      * must be converted to true pts/dts before they are stored in AVPacket.
1640      */
1641     int64_t pts;
1642     /**
1643      * Decompression timestamp in AVStream->time_base units; the time at which
1644      * the packet is decompressed.
1645      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1646      */
1647     int64_t dts;
1648     uint8_t *data;
1649     int   size;
1650     int   stream_index;
1651     /**
1652      * A combination of AV_PKT_FLAG values
1653      */
1654     int   flags;
1655     /**
1656      * Additional packet data that can be provided by the container.
1657      * Packet can contain several types of side information.
1658      */
1659     AVPacketSideData *side_data;
1660     int side_data_elems;
1661
1662     /**
1663      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1664      * Equals next_pts - this_pts in presentation order.
1665      */
1666     int64_t duration;
1667
1668     int64_t pos;                            ///< byte position in stream, -1 if unknown
1669
1670 #if FF_API_CONVERGENCE_DURATION
1671     /**
1672      * @deprecated Same as the duration field, but as int64_t. This was required
1673      * for Matroska subtitles, whose duration values could overflow when the
1674      * duration field was still an int.
1675      */
1676     attribute_deprecated
1677     int64_t convergence_duration;
1678 #endif
1679 } AVPacket;
1680 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1681 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1682 /**
1683  * Flag is used to discard packets which are required to maintain valid
1684  * decoder state but are not required for output and should be dropped
1685  * after decoding.
1686  **/
1687 #define AV_PKT_FLAG_DISCARD   0x0004
1688
1689 enum AVSideDataParamChangeFlags {
1690     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1691     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1692     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1693     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1694 };
1695 /**
1696  * @}
1697  */
1698
1699 struct AVCodecInternal;
1700
1701 enum AVFieldOrder {
1702     AV_FIELD_UNKNOWN,
1703     AV_FIELD_PROGRESSIVE,
1704     AV_FIELD_TT,          //< Top coded_first, top displayed first
1705     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1706     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1707     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1708 };
1709
1710 /**
1711  * main external API structure.
1712  * New fields can be added to the end with minor version bumps.
1713  * Removal, reordering and changes to existing fields require a major
1714  * version bump.
1715  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1716  * applications.
1717  * The name string for AVOptions options matches the associated command line
1718  * parameter name and can be found in libavcodec/options_table.h
1719  * The AVOption/command line parameter names differ in some cases from the C
1720  * structure field names for historic reasons or brevity.
1721  * sizeof(AVCodecContext) must not be used outside libav*.
1722  */
1723 typedef struct AVCodecContext {
1724     /**
1725      * information on struct for av_log
1726      * - set by avcodec_alloc_context3
1727      */
1728     const AVClass *av_class;
1729     int log_level_offset;
1730
1731     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1732     const struct AVCodec  *codec;
1733 #if FF_API_CODEC_NAME
1734     /**
1735      * @deprecated this field is not used for anything in libavcodec
1736      */
1737     attribute_deprecated
1738     char             codec_name[32];
1739 #endif
1740     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1741
1742     /**
1743      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1744      * This is used to work around some encoder bugs.
1745      * A demuxer should set this to what is stored in the field used to identify the codec.
1746      * If there are multiple such fields in a container then the demuxer should choose the one
1747      * which maximizes the information about the used codec.
1748      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1749      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1750      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1751      * first.
1752      * - encoding: Set by user, if not then the default based on codec_id will be used.
1753      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1754      */
1755     unsigned int codec_tag;
1756
1757 #if FF_API_STREAM_CODEC_TAG
1758     /**
1759      * @deprecated this field is unused
1760      */
1761     attribute_deprecated
1762     unsigned int stream_codec_tag;
1763 #endif
1764
1765     void *priv_data;
1766
1767     /**
1768      * Private context used for internal data.
1769      *
1770      * Unlike priv_data, this is not codec-specific. It is used in general
1771      * libavcodec functions.
1772      */
1773     struct AVCodecInternal *internal;
1774
1775     /**
1776      * Private data of the user, can be used to carry app specific stuff.
1777      * - encoding: Set by user.
1778      * - decoding: Set by user.
1779      */
1780     void *opaque;
1781
1782     /**
1783      * the average bitrate
1784      * - encoding: Set by user; unused for constant quantizer encoding.
1785      * - decoding: Set by user, may be overwritten by libavcodec
1786      *             if this info is available in the stream
1787      */
1788     int64_t bit_rate;
1789
1790     /**
1791      * number of bits the bitstream is allowed to diverge from the reference.
1792      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1793      * - encoding: Set by user; unused for constant quantizer encoding.
1794      * - decoding: unused
1795      */
1796     int bit_rate_tolerance;
1797
1798     /**
1799      * Global quality for codecs which cannot change it per frame.
1800      * This should be proportional to MPEG-1/2/4 qscale.
1801      * - encoding: Set by user.
1802      * - decoding: unused
1803      */
1804     int global_quality;
1805
1806     /**
1807      * - encoding: Set by user.
1808      * - decoding: unused
1809      */
1810     int compression_level;
1811 #define FF_COMPRESSION_DEFAULT -1
1812
1813     /**
1814      * AV_CODEC_FLAG_*.
1815      * - encoding: Set by user.
1816      * - decoding: Set by user.
1817      */
1818     int flags;
1819
1820     /**
1821      * AV_CODEC_FLAG2_*
1822      * - encoding: Set by user.
1823      * - decoding: Set by user.
1824      */
1825     int flags2;
1826
1827     /**
1828      * some codecs need / can use extradata like Huffman tables.
1829      * MJPEG: Huffman tables
1830      * rv10: additional flags
1831      * MPEG-4: global headers (they can be in the bitstream or here)
1832      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1833      * than extradata_size to avoid problems if it is read with the bitstream reader.
1834      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1835      * - encoding: Set/allocated/freed by libavcodec.
1836      * - decoding: Set/allocated/freed by user.
1837      */
1838     uint8_t *extradata;
1839     int extradata_size;
1840
1841     /**
1842      * This is the fundamental unit of time (in seconds) in terms
1843      * of which frame timestamps are represented. For fixed-fps content,
1844      * timebase should be 1/framerate and timestamp increments should be
1845      * identically 1.
1846      * This often, but not always is the inverse of the frame rate or field rate
1847      * for video. 1/time_base is not the average frame rate if the frame rate is not
1848      * constant.
1849      *
1850      * Like containers, elementary streams also can store timestamps, 1/time_base
1851      * is the unit in which these timestamps are specified.
1852      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1853      * vop_time_increment_resolution and fixed_vop_rate
1854      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1855      *
1856      * - encoding: MUST be set by user.
1857      * - decoding: the use of this field for decoding is deprecated.
1858      *             Use framerate instead.
1859      */
1860     AVRational time_base;
1861
1862     /**
1863      * For some codecs, the time base is closer to the field rate than the frame rate.
1864      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1865      * if no telecine is used ...
1866      *
1867      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1868      */
1869     int ticks_per_frame;
1870
1871     /**
1872      * Codec delay.
1873      *
1874      * Encoding: Number of frames delay there will be from the encoder input to
1875      *           the decoder output. (we assume the decoder matches the spec)
1876      * Decoding: Number of frames delay in addition to what a standard decoder
1877      *           as specified in the spec would produce.
1878      *
1879      * Video:
1880      *   Number of frames the decoded output will be delayed relative to the
1881      *   encoded input.
1882      *
1883      * Audio:
1884      *   For encoding, this field is unused (see initial_padding).
1885      *
1886      *   For decoding, this is the number of samples the decoder needs to
1887      *   output before the decoder's output is valid. When seeking, you should
1888      *   start decoding this many samples prior to your desired seek point.
1889      *
1890      * - encoding: Set by libavcodec.
1891      * - decoding: Set by libavcodec.
1892      */
1893     int delay;
1894
1895
1896     /* video only */
1897     /**
1898      * picture width / height.
1899      *
1900      * @note Those fields may not match the values of the last
1901      * AVFrame output by avcodec_decode_video2 due frame
1902      * reordering.
1903      *
1904      * - encoding: MUST be set by user.
1905      * - decoding: May be set by the user before opening the decoder if known e.g.
1906      *             from the container. Some decoders will require the dimensions
1907      *             to be set by the caller. During decoding, the decoder may
1908      *             overwrite those values as required while parsing the data.
1909      */
1910     int width, height;
1911
1912     /**
1913      * Bitstream width / height, may be different from width/height e.g. when
1914      * the decoded frame is cropped before being output or lowres is enabled.
1915      *
1916      * @note Those field may not match the value of the last
1917      * AVFrame output by avcodec_receive_frame() due frame
1918      * reordering.
1919      *
1920      * - encoding: unused
1921      * - decoding: May be set by the user before opening the decoder if known
1922      *             e.g. from the container. During decoding, the decoder may
1923      *             overwrite those values as required while parsing the data.
1924      */
1925     int coded_width, coded_height;
1926
1927 #if FF_API_ASPECT_EXTENDED
1928 #define FF_ASPECT_EXTENDED 15
1929 #endif
1930
1931     /**
1932      * the number of pictures in a group of pictures, or 0 for intra_only
1933      * - encoding: Set by user.
1934      * - decoding: unused
1935      */
1936     int gop_size;
1937
1938     /**
1939      * Pixel format, see AV_PIX_FMT_xxx.
1940      * May be set by the demuxer if known from headers.
1941      * May be overridden by the decoder if it knows better.
1942      *
1943      * @note This field may not match the value of the last
1944      * AVFrame output by avcodec_receive_frame() due frame
1945      * reordering.
1946      *
1947      * - encoding: Set by user.
1948      * - decoding: Set by user if known, overridden by libavcodec while
1949      *             parsing the data.
1950      */
1951     enum AVPixelFormat pix_fmt;
1952
1953 #if FF_API_MOTION_EST
1954     /**
1955      * This option does nothing
1956      * @deprecated use codec private options instead
1957      */
1958     attribute_deprecated int me_method;
1959 #endif
1960
1961     /**
1962      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1963      * decoder to draw a horizontal band. It improves cache usage. Not
1964      * all codecs can do that. You must check the codec capabilities
1965      * beforehand.
1966      * When multithreading is used, it may be called from multiple threads
1967      * at the same time; threads might draw different parts of the same AVFrame,
1968      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1969      * in order.
1970      * The function is also used by hardware acceleration APIs.
1971      * It is called at least once during frame decoding to pass
1972      * the data needed for hardware render.
1973      * In that mode instead of pixel data, AVFrame points to
1974      * a structure specific to the acceleration API. The application
1975      * reads the structure and can change some fields to indicate progress
1976      * or mark state.
1977      * - encoding: unused
1978      * - decoding: Set by user.
1979      * @param height the height of the slice
1980      * @param y the y position of the slice
1981      * @param type 1->top field, 2->bottom field, 3->frame
1982      * @param offset offset into the AVFrame.data from which the slice should be read
1983      */
1984     void (*draw_horiz_band)(struct AVCodecContext *s,
1985                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1986                             int y, int type, int height);
1987
1988     /**
1989      * callback to negotiate the pixelFormat
1990      * @param fmt is the list of formats which are supported by the codec,
1991      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1992      * The first is always the native one.
1993      * @note The callback may be called again immediately if initialization for
1994      * the selected (hardware-accelerated) pixel format failed.
1995      * @warning Behavior is undefined if the callback returns a value not
1996      * in the fmt list of formats.
1997      * @return the chosen format
1998      * - encoding: unused
1999      * - decoding: Set by user, if not set the native format will be chosen.
2000      */
2001     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2002
2003     /**
2004      * maximum number of B-frames between non-B-frames
2005      * Note: The output will be delayed by max_b_frames+1 relative to the input.
2006      * - encoding: Set by user.
2007      * - decoding: unused
2008      */
2009     int max_b_frames;
2010
2011     /**
2012      * qscale factor between IP and B-frames
2013      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2014      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2015      * - encoding: Set by user.
2016      * - decoding: unused
2017      */
2018     float b_quant_factor;
2019
2020 #if FF_API_RC_STRATEGY
2021     /** @deprecated use codec private option instead */
2022     attribute_deprecated int rc_strategy;
2023 #define FF_RC_STRATEGY_XVID 1
2024 #endif
2025
2026 #if FF_API_PRIVATE_OPT
2027     /** @deprecated use encoder private options instead */
2028     attribute_deprecated
2029     int b_frame_strategy;
2030 #endif
2031
2032     /**
2033      * qscale offset between IP and B-frames
2034      * - encoding: Set by user.
2035      * - decoding: unused
2036      */
2037     float b_quant_offset;
2038
2039     /**
2040      * Size of the frame reordering buffer in the decoder.
2041      * For MPEG-2 it is 1 IPB or 0 low delay IP.
2042      * - encoding: Set by libavcodec.
2043      * - decoding: Set by libavcodec.
2044      */
2045     int has_b_frames;
2046
2047 #if FF_API_PRIVATE_OPT
2048     /** @deprecated use encoder private options instead */
2049     attribute_deprecated
2050     int mpeg_quant;
2051 #endif
2052
2053     /**
2054      * qscale factor between P- and I-frames
2055      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2056      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2057      * - encoding: Set by user.
2058      * - decoding: unused
2059      */
2060     float i_quant_factor;
2061
2062     /**
2063      * qscale offset between P and I-frames
2064      * - encoding: Set by user.
2065      * - decoding: unused
2066      */
2067     float i_quant_offset;
2068
2069     /**
2070      * luminance masking (0-> disabled)
2071      * - encoding: Set by user.
2072      * - decoding: unused
2073      */
2074     float lumi_masking;
2075
2076     /**
2077      * temporary complexity masking (0-> disabled)
2078      * - encoding: Set by user.
2079      * - decoding: unused
2080      */
2081     float temporal_cplx_masking;
2082
2083     /**
2084      * spatial complexity masking (0-> disabled)
2085      * - encoding: Set by user.
2086      * - decoding: unused
2087      */
2088     float spatial_cplx_masking;
2089
2090     /**
2091      * p block masking (0-> disabled)
2092      * - encoding: Set by user.
2093      * - decoding: unused
2094      */
2095     float p_masking;
2096
2097     /**
2098      * darkness masking (0-> disabled)
2099      * - encoding: Set by user.
2100      * - decoding: unused
2101      */
2102     float dark_masking;
2103
2104     /**
2105      * slice count
2106      * - encoding: Set by libavcodec.
2107      * - decoding: Set by user (or 0).
2108      */
2109     int slice_count;
2110
2111 #if FF_API_PRIVATE_OPT
2112     /** @deprecated use encoder private options instead */
2113     attribute_deprecated
2114      int prediction_method;
2115 #define FF_PRED_LEFT   0
2116 #define FF_PRED_PLANE  1
2117 #define FF_PRED_MEDIAN 2
2118 #endif
2119
2120     /**
2121      * slice offsets in the frame in bytes
2122      * - encoding: Set/allocated by libavcodec.
2123      * - decoding: Set/allocated by user (or NULL).
2124      */
2125     int *slice_offset;
2126
2127     /**
2128      * sample aspect ratio (0 if unknown)
2129      * That is the width of a pixel divided by the height of the pixel.
2130      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2131      * - encoding: Set by user.
2132      * - decoding: Set by libavcodec.
2133      */
2134     AVRational sample_aspect_ratio;
2135
2136     /**
2137      * motion estimation comparison function
2138      * - encoding: Set by user.
2139      * - decoding: unused
2140      */
2141     int me_cmp;
2142     /**
2143      * subpixel motion estimation comparison function
2144      * - encoding: Set by user.
2145      * - decoding: unused
2146      */
2147     int me_sub_cmp;
2148     /**
2149      * macroblock comparison function (not supported yet)
2150      * - encoding: Set by user.
2151      * - decoding: unused
2152      */
2153     int mb_cmp;
2154     /**
2155      * interlaced DCT comparison function
2156      * - encoding: Set by user.
2157      * - decoding: unused
2158      */
2159     int ildct_cmp;
2160 #define FF_CMP_SAD          0
2161 #define FF_CMP_SSE          1
2162 #define FF_CMP_SATD         2
2163 #define FF_CMP_DCT          3
2164 #define FF_CMP_PSNR         4
2165 #define FF_CMP_BIT          5
2166 #define FF_CMP_RD           6
2167 #define FF_CMP_ZERO         7
2168 #define FF_CMP_VSAD         8
2169 #define FF_CMP_VSSE         9
2170 #define FF_CMP_NSSE         10
2171 #define FF_CMP_W53          11
2172 #define FF_CMP_W97          12
2173 #define FF_CMP_DCTMAX       13
2174 #define FF_CMP_DCT264       14
2175 #define FF_CMP_MEDIAN_SAD   15
2176 #define FF_CMP_CHROMA       256
2177
2178     /**
2179      * ME diamond size & shape
2180      * - encoding: Set by user.
2181      * - decoding: unused
2182      */
2183     int dia_size;
2184
2185     /**
2186      * amount of previous MV predictors (2a+1 x 2a+1 square)
2187      * - encoding: Set by user.
2188      * - decoding: unused
2189      */
2190     int last_predictor_count;
2191
2192 #if FF_API_PRIVATE_OPT
2193     /** @deprecated use encoder private options instead */
2194     attribute_deprecated
2195     int pre_me;
2196 #endif
2197
2198     /**
2199      * motion estimation prepass comparison function
2200      * - encoding: Set by user.
2201      * - decoding: unused
2202      */
2203     int me_pre_cmp;
2204
2205     /**
2206      * ME prepass diamond size & shape
2207      * - encoding: Set by user.
2208      * - decoding: unused
2209      */
2210     int pre_dia_size;
2211
2212     /**
2213      * subpel ME quality
2214      * - encoding: Set by user.
2215      * - decoding: unused
2216      */
2217     int me_subpel_quality;
2218
2219 #if FF_API_AFD
2220     /**
2221      * DTG active format information (additional aspect ratio
2222      * information only used in DVB MPEG-2 transport streams)
2223      * 0 if not set.
2224      *
2225      * - encoding: unused
2226      * - decoding: Set by decoder.
2227      * @deprecated Deprecated in favor of AVSideData
2228      */
2229     attribute_deprecated int dtg_active_format;
2230 #define FF_DTG_AFD_SAME         8
2231 #define FF_DTG_AFD_4_3          9
2232 #define FF_DTG_AFD_16_9         10
2233 #define FF_DTG_AFD_14_9         11
2234 #define FF_DTG_AFD_4_3_SP_14_9  13
2235 #define FF_DTG_AFD_16_9_SP_14_9 14
2236 #define FF_DTG_AFD_SP_4_3       15
2237 #endif /* FF_API_AFD */
2238
2239     /**
2240      * maximum motion estimation search range in subpel units
2241      * If 0 then no limit.
2242      *
2243      * - encoding: Set by user.
2244      * - decoding: unused
2245      */
2246     int me_range;
2247
2248 #if FF_API_QUANT_BIAS
2249     /**
2250      * @deprecated use encoder private option instead
2251      */
2252     attribute_deprecated int intra_quant_bias;
2253 #define FF_DEFAULT_QUANT_BIAS 999999
2254
2255     /**
2256      * @deprecated use encoder private option instead
2257      */
2258     attribute_deprecated int inter_quant_bias;
2259 #endif
2260
2261     /**
2262      * slice flags
2263      * - encoding: unused
2264      * - decoding: Set by user.
2265      */
2266     int slice_flags;
2267 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2268 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2269 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2270
2271 #if FF_API_XVMC
2272     /**
2273      * XVideo Motion Acceleration
2274      * - encoding: forbidden
2275      * - decoding: set by decoder
2276      * @deprecated XvMC doesn't need it anymore.
2277      */
2278     attribute_deprecated int xvmc_acceleration;
2279 #endif /* FF_API_XVMC */
2280
2281     /**
2282      * macroblock decision mode
2283      * - encoding: Set by user.
2284      * - decoding: unused
2285      */
2286     int mb_decision;
2287 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2288 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2289 #define FF_MB_DECISION_RD     2        ///< rate distortion
2290
2291     /**
2292      * custom intra quantization matrix
2293      * - encoding: Set by user, can be NULL.
2294      * - decoding: Set by libavcodec.
2295      */
2296     uint16_t *intra_matrix;
2297
2298     /**
2299      * custom inter quantization matrix
2300      * - encoding: Set by user, can be NULL.
2301      * - decoding: Set by libavcodec.
2302      */
2303     uint16_t *inter_matrix;
2304
2305 #if FF_API_PRIVATE_OPT
2306     /** @deprecated use encoder private options instead */
2307     attribute_deprecated
2308     int scenechange_threshold;
2309
2310     /** @deprecated use encoder private options instead */
2311     attribute_deprecated
2312     int noise_reduction;
2313 #endif
2314
2315 #if FF_API_MPV_OPT
2316     /**
2317      * @deprecated this field is unused
2318      */
2319     attribute_deprecated
2320     int me_threshold;
2321
2322     /**
2323      * @deprecated this field is unused
2324      */
2325     attribute_deprecated
2326     int mb_threshold;
2327 #endif
2328
2329     /**
2330      * precision of the intra DC coefficient - 8
2331      * - encoding: Set by user.
2332      * - decoding: Set by libavcodec
2333      */
2334     int intra_dc_precision;
2335
2336     /**
2337      * Number of macroblock rows at the top which are skipped.
2338      * - encoding: unused
2339      * - decoding: Set by user.
2340      */
2341     int skip_top;
2342
2343     /**
2344      * Number of macroblock rows at the bottom which are skipped.
2345      * - encoding: unused
2346      * - decoding: Set by user.
2347      */
2348     int skip_bottom;
2349
2350 #if FF_API_MPV_OPT
2351     /**
2352      * @deprecated use encoder private options instead
2353      */
2354     attribute_deprecated
2355     float border_masking;
2356 #endif
2357
2358     /**
2359      * minimum MB Lagrange multiplier
2360      * - encoding: Set by user.
2361      * - decoding: unused
2362      */
2363     int mb_lmin;
2364
2365     /**
2366      * maximum MB Lagrange multiplier
2367      * - encoding: Set by user.
2368      * - decoding: unused
2369      */
2370     int mb_lmax;
2371
2372 #if FF_API_PRIVATE_OPT
2373     /**
2374      * @deprecated use encoder private options instead
2375      */
2376     attribute_deprecated
2377     int me_penalty_compensation;
2378 #endif
2379
2380     /**
2381      * - encoding: Set by user.
2382      * - decoding: unused
2383      */
2384     int bidir_refine;
2385
2386 #if FF_API_PRIVATE_OPT
2387     /** @deprecated use encoder private options instead */
2388     attribute_deprecated
2389     int brd_scale;
2390 #endif
2391
2392     /**
2393      * minimum GOP size
2394      * - encoding: Set by user.
2395      * - decoding: unused
2396      */
2397     int keyint_min;
2398
2399     /**
2400      * number of reference frames
2401      * - encoding: Set by user.
2402      * - decoding: Set by lavc.
2403      */
2404     int refs;
2405
2406 #if FF_API_PRIVATE_OPT
2407     /** @deprecated use encoder private options instead */
2408     attribute_deprecated
2409     int chromaoffset;
2410 #endif
2411
2412 #if FF_API_UNUSED_MEMBERS
2413     /**
2414      * Multiplied by qscale for each frame and added to scene_change_score.
2415      * - encoding: Set by user.
2416      * - decoding: unused
2417      */
2418     attribute_deprecated int scenechange_factor;
2419 #endif
2420
2421     /**
2422      * Note: Value depends upon the compare function used for fullpel ME.
2423      * - encoding: Set by user.
2424      * - decoding: unused
2425      */
2426     int mv0_threshold;
2427
2428 #if FF_API_PRIVATE_OPT
2429     /** @deprecated use encoder private options instead */
2430     attribute_deprecated
2431     int b_sensitivity;
2432 #endif
2433
2434     /**
2435      * Chromaticity coordinates of the source primaries.
2436      * - encoding: Set by user
2437      * - decoding: Set by libavcodec
2438      */
2439     enum AVColorPrimaries color_primaries;
2440
2441     /**
2442      * Color Transfer Characteristic.
2443      * - encoding: Set by user
2444      * - decoding: Set by libavcodec
2445      */
2446     enum AVColorTransferCharacteristic color_trc;
2447
2448     /**
2449      * YUV colorspace type.
2450      * - encoding: Set by user
2451      * - decoding: Set by libavcodec
2452      */
2453     enum AVColorSpace colorspace;
2454
2455     /**
2456      * MPEG vs JPEG YUV range.
2457      * - encoding: Set by user
2458      * - decoding: Set by libavcodec
2459      */
2460     enum AVColorRange color_range;
2461
2462     /**
2463      * This defines the location of chroma samples.
2464      * - encoding: Set by user
2465      * - decoding: Set by libavcodec
2466      */
2467     enum AVChromaLocation chroma_sample_location;
2468
2469     /**
2470      * Number of slices.
2471      * Indicates number of picture subdivisions. Used for parallelized
2472      * decoding.
2473      * - encoding: Set by user
2474      * - decoding: unused
2475      */
2476     int slices;
2477
2478     /** Field order
2479      * - encoding: set by libavcodec
2480      * - decoding: Set by user.
2481      */
2482     enum AVFieldOrder field_order;
2483
2484     /* audio only */
2485     int sample_rate; ///< samples per second
2486     int channels;    ///< number of audio channels
2487
2488     /**
2489      * audio sample format
2490      * - encoding: Set by user.
2491      * - decoding: Set by libavcodec.
2492      */
2493     enum AVSampleFormat sample_fmt;  ///< sample format
2494
2495     /* The following data should not be initialized. */
2496     /**
2497      * Number of samples per channel in an audio frame.
2498      *
2499      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2500      *   except the last must contain exactly frame_size samples per channel.
2501      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2502      *   frame size is not restricted.
2503      * - decoding: may be set by some decoders to indicate constant frame size
2504      */
2505     int frame_size;
2506
2507     /**
2508      * Frame counter, set by libavcodec.
2509      *
2510      * - decoding: total number of frames returned from the decoder so far.
2511      * - encoding: total number of frames passed to the encoder so far.
2512      *
2513      *   @note the counter is not incremented if encoding/decoding resulted in
2514      *   an error.
2515      */
2516     int frame_number;
2517
2518     /**
2519      * number of bytes per packet if constant and known or 0
2520      * Used by some WAV based audio codecs.
2521      */
2522     int block_align;
2523
2524     /**
2525      * Audio cutoff bandwidth (0 means "automatic")
2526      * - encoding: Set by user.
2527      * - decoding: unused
2528      */
2529     int cutoff;
2530
2531     /**
2532      * Audio channel layout.
2533      * - encoding: set by user.
2534      * - decoding: set by user, may be overwritten by libavcodec.
2535      */
2536     uint64_t channel_layout;
2537
2538     /**
2539      * Request decoder to use this channel layout if it can (0 for default)
2540      * - encoding: unused
2541      * - decoding: Set by user.
2542      */
2543     uint64_t request_channel_layout;
2544
2545     /**
2546      * Type of service that the audio stream conveys.
2547      * - encoding: Set by user.
2548      * - decoding: Set by libavcodec.
2549      */
2550     enum AVAudioServiceType audio_service_type;
2551
2552     /**
2553      * desired sample format
2554      * - encoding: Not used.
2555      * - decoding: Set by user.
2556      * Decoder will decode to this format if it can.
2557      */
2558     enum AVSampleFormat request_sample_fmt;
2559
2560     /**
2561      * This callback is called at the beginning of each frame to get data
2562      * buffer(s) for it. There may be one contiguous buffer for all the data or
2563      * there may be a buffer per each data plane or anything in between. What
2564      * this means is, you may set however many entries in buf[] you feel necessary.
2565      * Each buffer must be reference-counted using the AVBuffer API (see description
2566      * of buf[] below).
2567      *
2568      * The following fields will be set in the frame before this callback is
2569      * called:
2570      * - format
2571      * - width, height (video only)
2572      * - sample_rate, channel_layout, nb_samples (audio only)
2573      * Their values may differ from the corresponding values in
2574      * AVCodecContext. This callback must use the frame values, not the codec
2575      * context values, to calculate the required buffer size.
2576      *
2577      * This callback must fill the following fields in the frame:
2578      * - data[]
2579      * - linesize[]
2580      * - extended_data:
2581      *   * if the data is planar audio with more than 8 channels, then this
2582      *     callback must allocate and fill extended_data to contain all pointers
2583      *     to all data planes. data[] must hold as many pointers as it can.
2584      *     extended_data must be allocated with av_malloc() and will be freed in
2585      *     av_frame_unref().
2586      *   * otherwise extended_data must point to data
2587      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2588      *   the frame's data and extended_data pointers must be contained in these. That
2589      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2590      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2591      *   and av_buffer_ref().
2592      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2593      *   this callback and filled with the extra buffers if there are more
2594      *   buffers than buf[] can hold. extended_buf will be freed in
2595      *   av_frame_unref().
2596      *
2597      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2598      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2599      * some other means.
2600      *
2601      * Each data plane must be aligned to the maximum required by the target
2602      * CPU.
2603      *
2604      * @see avcodec_default_get_buffer2()
2605      *
2606      * Video:
2607      *
2608      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2609      * (read and/or written to if it is writable) later by libavcodec.
2610      *
2611      * avcodec_align_dimensions2() should be used to find the required width and
2612      * height, as they normally need to be rounded up to the next multiple of 16.
2613      *
2614      * Some decoders do not support linesizes changing between frames.
2615      *
2616      * If frame multithreading is used and thread_safe_callbacks is set,
2617      * this callback may be called from a different thread, but not from more
2618      * than one at once. Does not need to be reentrant.
2619      *
2620      * @see avcodec_align_dimensions2()
2621      *
2622      * Audio:
2623      *
2624      * Decoders request a buffer of a particular size by setting
2625      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2626      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2627      * to a smaller value in the output frame.
2628      *
2629      * As a convenience, av_samples_get_buffer_size() and
2630      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2631      * functions to find the required data size and to fill data pointers and
2632      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2633      * since all planes must be the same size.
2634      *
2635      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2636      *
2637      * - encoding: unused
2638      * - decoding: Set by libavcodec, user can override.
2639      */
2640     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2641
2642     /**
2643      * If non-zero, the decoded audio and video frames returned from
2644      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2645      * and are valid indefinitely. The caller must free them with
2646      * av_frame_unref() when they are not needed anymore.
2647      * Otherwise, the decoded frames must not be freed by the caller and are
2648      * only valid until the next decode call.
2649      *
2650      * This is always automatically enabled if avcodec_receive_frame() is used.
2651      *
2652      * - encoding: unused
2653      * - decoding: set by the caller before avcodec_open2().
2654      */
2655     int refcounted_frames;
2656
2657     /* - encoding parameters */
2658     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2659     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2660
2661     /**
2662      * minimum quantizer
2663      * - encoding: Set by user.
2664      * - decoding: unused
2665      */
2666     int qmin;
2667
2668     /**
2669      * maximum quantizer
2670      * - encoding: Set by user.
2671      * - decoding: unused
2672      */
2673     int qmax;
2674
2675     /**
2676      * maximum quantizer difference between frames
2677      * - encoding: Set by user.
2678      * - decoding: unused
2679      */
2680     int max_qdiff;
2681
2682 #if FF_API_MPV_OPT
2683     /**
2684      * @deprecated use encoder private options instead
2685      */
2686     attribute_deprecated
2687     float rc_qsquish;
2688
2689     attribute_deprecated
2690     float rc_qmod_amp;
2691     attribute_deprecated
2692     int rc_qmod_freq;
2693 #endif
2694
2695     /**
2696      * decoder bitstream buffer size
2697      * - encoding: Set by user.
2698      * - decoding: unused
2699      */
2700     int rc_buffer_size;
2701
2702     /**
2703      * ratecontrol override, see RcOverride
2704      * - encoding: Allocated/set/freed by user.
2705      * - decoding: unused
2706      */
2707     int rc_override_count;
2708     RcOverride *rc_override;
2709
2710 #if FF_API_MPV_OPT
2711     /**
2712      * @deprecated use encoder private options instead
2713      */
2714     attribute_deprecated
2715     const char *rc_eq;
2716 #endif
2717
2718     /**
2719      * maximum bitrate
2720      * - encoding: Set by user.
2721      * - decoding: Set by user, may be overwritten by libavcodec.
2722      */
2723     int64_t rc_max_rate;
2724
2725     /**
2726      * minimum bitrate
2727      * - encoding: Set by user.
2728      * - decoding: unused
2729      */
2730     int64_t rc_min_rate;
2731
2732 #if FF_API_MPV_OPT
2733     /**
2734      * @deprecated use encoder private options instead
2735      */
2736     attribute_deprecated
2737     float rc_buffer_aggressivity;
2738
2739     attribute_deprecated
2740     float rc_initial_cplx;
2741 #endif
2742
2743     /**
2744      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2745      * - encoding: Set by user.
2746      * - decoding: unused.
2747      */
2748     float rc_max_available_vbv_use;
2749
2750     /**
2751      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2752      * - encoding: Set by user.
2753      * - decoding: unused.
2754      */
2755     float rc_min_vbv_overflow_use;
2756
2757     /**
2758      * Number of bits which should be loaded into the rc buffer before decoding starts.
2759      * - encoding: Set by user.
2760      * - decoding: unused
2761      */
2762     int rc_initial_buffer_occupancy;
2763
2764 #if FF_API_CODER_TYPE
2765 #define FF_CODER_TYPE_VLC       0
2766 #define FF_CODER_TYPE_AC        1
2767 #define FF_CODER_TYPE_RAW       2
2768 #define FF_CODER_TYPE_RLE       3
2769 #if FF_API_UNUSED_MEMBERS
2770 #define FF_CODER_TYPE_DEFLATE   4
2771 #endif /* FF_API_UNUSED_MEMBERS */
2772     /**
2773      * @deprecated use encoder private options instead
2774      */
2775     attribute_deprecated
2776     int coder_type;
2777 #endif /* FF_API_CODER_TYPE */
2778
2779 #if FF_API_PRIVATE_OPT
2780     /** @deprecated use encoder private options instead */
2781     attribute_deprecated
2782     int context_model;
2783 #endif
2784
2785 #if FF_API_MPV_OPT
2786     /**
2787      * @deprecated use encoder private options instead
2788      */
2789     attribute_deprecated
2790     int lmin;
2791
2792     /**
2793      * @deprecated use encoder private options instead
2794      */
2795     attribute_deprecated
2796     int lmax;
2797 #endif
2798
2799 #if FF_API_PRIVATE_OPT
2800     /** @deprecated use encoder private options instead */
2801     attribute_deprecated
2802     int frame_skip_threshold;
2803
2804     /** @deprecated use encoder private options instead */
2805     attribute_deprecated
2806     int frame_skip_factor;
2807
2808     /** @deprecated use encoder private options instead */
2809     attribute_deprecated
2810     int frame_skip_exp;
2811
2812     /** @deprecated use encoder private options instead */
2813     attribute_deprecated
2814     int frame_skip_cmp;
2815 #endif /* FF_API_PRIVATE_OPT */
2816
2817     /**
2818      * trellis RD quantization
2819      * - encoding: Set by user.
2820      * - decoding: unused
2821      */
2822     int trellis;
2823
2824 #if FF_API_PRIVATE_OPT
2825     /** @deprecated use encoder private options instead */
2826     attribute_deprecated
2827     int min_prediction_order;
2828
2829     /** @deprecated use encoder private options instead */
2830     attribute_deprecated
2831     int max_prediction_order;
2832
2833     /** @deprecated use encoder private options instead */
2834     attribute_deprecated
2835     int64_t timecode_frame_start;
2836 #endif
2837
2838 #if FF_API_RTP_CALLBACK
2839     /**
2840      * @deprecated unused
2841      */
2842     /* The RTP callback: This function is called    */
2843     /* every time the encoder has a packet to send. */
2844     /* It depends on the encoder if the data starts */
2845     /* with a Start Code (it should). H.263 does.   */
2846     /* mb_nb contains the number of macroblocks     */
2847     /* encoded in the RTP payload.                  */
2848     attribute_deprecated
2849     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2850 #endif
2851
2852 #if FF_API_PRIVATE_OPT
2853     /** @deprecated use encoder private options instead */
2854     attribute_deprecated
2855     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2856                             /* do its best to deliver a chunk with size     */
2857                             /* below rtp_payload_size, the chunk will start */
2858                             /* with a start code on some codecs like H.263. */
2859                             /* This doesn't take account of any particular  */
2860                             /* headers inside the transmitted RTP payload.  */
2861 #endif
2862
2863 #if FF_API_STAT_BITS
2864     /* statistics, used for 2-pass encoding */
2865     attribute_deprecated
2866     int mv_bits;
2867     attribute_deprecated
2868     int header_bits;
2869     attribute_deprecated
2870     int i_tex_bits;
2871     attribute_deprecated
2872     int p_tex_bits;
2873     attribute_deprecated
2874     int i_count;
2875     attribute_deprecated
2876     int p_count;
2877     attribute_deprecated
2878     int skip_count;
2879     attribute_deprecated
2880     int misc_bits;
2881
2882     /** @deprecated this field is unused */
2883     attribute_deprecated
2884     int frame_bits;
2885 #endif
2886
2887     /**
2888      * pass1 encoding statistics output buffer
2889      * - encoding: Set by libavcodec.
2890      * - decoding: unused
2891      */
2892     char *stats_out;
2893
2894     /**
2895      * pass2 encoding statistics input buffer
2896      * Concatenated stuff from stats_out of pass1 should be placed here.
2897      * - encoding: Allocated/set/freed by user.
2898      * - decoding: unused
2899      */
2900     char *stats_in;
2901
2902     /**
2903      * Work around bugs in encoders which sometimes cannot be detected automatically.
2904      * - encoding: Set by user
2905      * - decoding: Set by user
2906      */
2907     int workaround_bugs;
2908 #define FF_BUG_AUTODETECT       1  ///< autodetection
2909 #if FF_API_OLD_MSMPEG4
2910 #define FF_BUG_OLD_MSMPEG4      2
2911 #endif
2912 #define FF_BUG_XVID_ILACE       4
2913 #define FF_BUG_UMP4             8
2914 #define FF_BUG_NO_PADDING       16
2915 #define FF_BUG_AMV              32
2916 #if FF_API_AC_VLC
2917 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2918 #endif
2919 #define FF_BUG_QPEL_CHROMA      64
2920 #define FF_BUG_STD_QPEL         128
2921 #define FF_BUG_QPEL_CHROMA2     256
2922 #define FF_BUG_DIRECT_BLOCKSIZE 512
2923 #define FF_BUG_EDGE             1024
2924 #define FF_BUG_HPEL_CHROMA      2048
2925 #define FF_BUG_DC_CLIP          4096
2926 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2927 #define FF_BUG_TRUNCATED       16384
2928 #define FF_BUG_IEDGE           32768
2929
2930     /**
2931      * strictly follow the standard (MPEG-4, ...).
2932      * - encoding: Set by user.
2933      * - decoding: Set by user.
2934      * Setting this to STRICT or higher means the encoder and decoder will
2935      * generally do stupid things, whereas setting it to unofficial or lower
2936      * will mean the encoder might produce output that is not supported by all
2937      * spec-compliant decoders. Decoders don't differentiate between normal,
2938      * unofficial and experimental (that is, they always try to decode things
2939      * when they can) unless they are explicitly asked to behave stupidly
2940      * (=strictly conform to the specs)
2941      */
2942     int strict_std_compliance;
2943 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2944 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2945 #define FF_COMPLIANCE_NORMAL        0
2946 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2947 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2948
2949     /**
2950      * error concealment flags
2951      * - encoding: unused
2952      * - decoding: Set by user.
2953      */
2954     int error_concealment;
2955 #define FF_EC_GUESS_MVS   1
2956 #define FF_EC_DEBLOCK     2
2957 #define FF_EC_FAVOR_INTER 256
2958
2959     /**
2960      * debug
2961      * - encoding: Set by user.
2962      * - decoding: Set by user.
2963      */
2964     int debug;
2965 #define FF_DEBUG_PICT_INFO   1
2966 #define FF_DEBUG_RC          2
2967 #define FF_DEBUG_BITSTREAM   4
2968 #define FF_DEBUG_MB_TYPE     8
2969 #define FF_DEBUG_QP          16
2970 #if FF_API_DEBUG_MV
2971 /**
2972  * @deprecated this option does nothing
2973  */
2974 #define FF_DEBUG_MV          32
2975 #endif
2976 #define FF_DEBUG_DCT_COEFF   0x00000040
2977 #define FF_DEBUG_SKIP        0x00000080
2978 #define FF_DEBUG_STARTCODE   0x00000100
2979 #if FF_API_UNUSED_MEMBERS
2980 #define FF_DEBUG_PTS         0x00000200
2981 #endif /* FF_API_UNUSED_MEMBERS */
2982 #define FF_DEBUG_ER          0x00000400
2983 #define FF_DEBUG_MMCO        0x00000800
2984 #define FF_DEBUG_BUGS        0x00001000
2985 #if FF_API_DEBUG_MV
2986 #define FF_DEBUG_VIS_QP      0x00002000
2987 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2988 #endif
2989 #define FF_DEBUG_BUFFERS     0x00008000
2990 #define FF_DEBUG_THREADS     0x00010000
2991 #define FF_DEBUG_GREEN_MD    0x00800000
2992 #define FF_DEBUG_NOMC        0x01000000
2993
2994 #if FF_API_DEBUG_MV
2995     /**
2996      * debug
2997      * - encoding: Set by user.
2998      * - decoding: Set by user.
2999      */
3000     int debug_mv;
3001 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
3002 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
3003 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3004 #endif
3005
3006     /**
3007      * Error recognition; may misdetect some more or less valid parts as errors.
3008      * - encoding: unused
3009      * - decoding: Set by user.
3010      */
3011     int err_recognition;
3012
3013 /**
3014  * Verify checksums embedded in the bitstream (could be of either encoded or
3015  * decoded data, depending on the codec) and print an error message on mismatch.
3016  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3017  * decoder returning an error.
3018  */
3019 #define AV_EF_CRCCHECK  (1<<0)
3020 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
3021 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
3022 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
3023
3024 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
3025 #define AV_EF_CAREFUL    (1<<16)        ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
3026 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
3027 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
3028
3029
3030     /**
3031      * opaque 64-bit number (generally a PTS) that will be reordered and
3032      * output in AVFrame.reordered_opaque
3033      * - encoding: unused
3034      * - decoding: Set by user.
3035      */
3036     int64_t reordered_opaque;
3037
3038     /**
3039      * Hardware accelerator in use
3040      * - encoding: unused.
3041      * - decoding: Set by libavcodec
3042      */
3043     struct AVHWAccel *hwaccel;
3044
3045     /**
3046      * Hardware accelerator context.
3047      * For some hardware accelerators, a global context needs to be
3048      * provided by the user. In that case, this holds display-dependent
3049      * data FFmpeg cannot instantiate itself. Please refer to the
3050      * FFmpeg HW accelerator documentation to know how to fill this
3051      * is. e.g. for VA API, this is a struct vaapi_context.
3052      * - encoding: unused
3053      * - decoding: Set by user
3054      */
3055     void *hwaccel_context;
3056
3057     /**
3058      * error
3059      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3060      * - decoding: unused
3061      */
3062     uint64_t error[AV_NUM_DATA_POINTERS];
3063
3064     /**
3065      * DCT algorithm, see FF_DCT_* below
3066      * - encoding: Set by user.
3067      * - decoding: unused
3068      */
3069     int dct_algo;
3070 #define FF_DCT_AUTO    0
3071 #define FF_DCT_FASTINT 1
3072 #define FF_DCT_INT     2
3073 #define FF_DCT_MMX     3
3074 #define FF_DCT_ALTIVEC 5
3075 #define FF_DCT_FAAN    6
3076
3077     /**
3078      * IDCT algorithm, see FF_IDCT_* below.
3079      * - encoding: Set by user.
3080      * - decoding: Set by user.
3081      */
3082     int idct_algo;
3083 #define FF_IDCT_AUTO          0
3084 #define FF_IDCT_INT           1
3085 #define FF_IDCT_SIMPLE        2
3086 #define FF_IDCT_SIMPLEMMX     3
3087 #define FF_IDCT_ARM           7
3088 #define FF_IDCT_ALTIVEC       8
3089 #if FF_API_ARCH_SH4
3090 #define FF_IDCT_SH4           9
3091 #endif
3092 #define FF_IDCT_SIMPLEARM     10
3093 #if FF_API_UNUSED_MEMBERS
3094 #define FF_IDCT_IPP           13
3095 #endif /* FF_API_UNUSED_MEMBERS */
3096 #define FF_IDCT_XVID          14
3097 #if FF_API_IDCT_XVIDMMX
3098 #define FF_IDCT_XVIDMMX       14
3099 #endif /* FF_API_IDCT_XVIDMMX */
3100 #define FF_IDCT_SIMPLEARMV5TE 16
3101 #define FF_IDCT_SIMPLEARMV6   17
3102 #if FF_API_ARCH_SPARC
3103 #define FF_IDCT_SIMPLEVIS     18
3104 #endif
3105 #define FF_IDCT_FAAN          20
3106 #define FF_IDCT_SIMPLENEON    22
3107 #if FF_API_ARCH_ALPHA
3108 #define FF_IDCT_SIMPLEALPHA   23
3109 #endif
3110 #define FF_IDCT_SIMPLEAUTO    128
3111
3112     /**
3113      * bits per sample/pixel from the demuxer (needed for huffyuv).
3114      * - encoding: Set by libavcodec.
3115      * - decoding: Set by user.
3116      */
3117      int bits_per_coded_sample;
3118
3119     /**
3120      * Bits per sample/pixel of internal libavcodec pixel/sample format.
3121      * - encoding: set by user.
3122      * - decoding: set by libavcodec.
3123      */
3124     int bits_per_raw_sample;
3125
3126 #if FF_API_LOWRES
3127     /**
3128      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3129      * - encoding: unused
3130      * - decoding: Set by user.
3131      */
3132      int lowres;
3133 #endif
3134
3135 #if FF_API_CODED_FRAME
3136     /**
3137      * the picture in the bitstream
3138      * - encoding: Set by libavcodec.
3139      * - decoding: unused
3140      *
3141      * @deprecated use the quality factor packet side data instead
3142      */
3143     attribute_deprecated AVFrame *coded_frame;
3144 #endif
3145
3146     /**
3147      * thread count
3148      * is used to decide how many independent tasks should be passed to execute()
3149      * - encoding: Set by user.
3150      * - decoding: Set by user.
3151      */
3152     int thread_count;
3153
3154     /**
3155      * Which multithreading methods to use.
3156      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3157      * so clients which cannot provide future frames should not use it.
3158      *
3159      * - encoding: Set by user, otherwise the default is used.
3160      * - decoding: Set by user, otherwise the default is used.
3161      */
3162     int thread_type;
3163 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
3164 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
3165
3166     /**
3167      * Which multithreading methods are in use by the codec.
3168      * - encoding: Set by libavcodec.
3169      * - decoding: Set by libavcodec.
3170      */
3171     int active_thread_type;
3172
3173     /**
3174      * Set by the client if its custom get_buffer() callback can be called
3175      * synchronously from another thread, which allows faster multithreaded decoding.
3176      * draw_horiz_band() will be called from other threads regardless of this setting.
3177      * Ignored if the default get_buffer() is used.
3178      * - encoding: Set by user.
3179      * - decoding: Set by user.
3180      */
3181     int thread_safe_callbacks;
3182
3183     /**
3184      * The codec may call this to execute several independent things.
3185      * It will return only after finishing all tasks.
3186      * The user may replace this with some multithreaded implementation,
3187      * the default implementation will execute the parts serially.
3188      * @param count the number of things to execute
3189      * - encoding: Set by libavcodec, user can override.
3190      * - decoding: Set by libavcodec, user can override.
3191      */
3192     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3193
3194     /**
3195      * The codec may call this to execute several independent things.
3196      * It will return only after finishing all tasks.
3197      * The user may replace this with some multithreaded implementation,
3198      * the default implementation will execute the parts serially.
3199      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3200      * @param c context passed also to func
3201      * @param count the number of things to execute
3202      * @param arg2 argument passed unchanged to func
3203      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3204      * @param func function that will be called count times, with jobnr from 0 to count-1.
3205      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3206      *             two instances of func executing at the same time will have the same threadnr.
3207      * @return always 0 currently, but code should handle a future improvement where when any call to func
3208      *         returns < 0 no further calls to func may be done and < 0 is returned.
3209      * - encoding: Set by libavcodec, user can override.
3210      * - decoding: Set by libavcodec, user can override.
3211      */
3212     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3213
3214     /**
3215      * noise vs. sse weight for the nsse comparison function
3216      * - encoding: Set by user.
3217      * - decoding: unused
3218      */
3219      int nsse_weight;
3220
3221     /**
3222      * profile
3223      * - encoding: Set by user.
3224      * - decoding: Set by libavcodec.
3225      */
3226      int profile;
3227 #define FF_PROFILE_UNKNOWN -99
3228 #define FF_PROFILE_RESERVED -100
3229
3230 #define FF_PROFILE_AAC_MAIN 0
3231 #define FF_PROFILE_AAC_LOW  1
3232 #define FF_PROFILE_AAC_SSR  2
3233 #define FF_PROFILE_AAC_LTP  3
3234 #define FF_PROFILE_AAC_HE   4
3235 #define FF_PROFILE_AAC_HE_V2 28
3236 #define FF_PROFILE_AAC_LD   22
3237 #define FF_PROFILE_AAC_ELD  38
3238 #define FF_PROFILE_MPEG2_AAC_LOW 128
3239 #define FF_PROFILE_MPEG2_AAC_HE  131
3240
3241 #define FF_PROFILE_DNXHD         0
3242 #define FF_PROFILE_DNXHR_LB      1
3243 #define FF_PROFILE_DNXHR_SQ      2
3244 #define FF_PROFILE_DNXHR_HQ      3
3245 #define FF_PROFILE_DNXHR_HQX     4
3246 #define FF_PROFILE_DNXHR_444     5
3247
3248 #define FF_PROFILE_DTS         20
3249 #define FF_PROFILE_DTS_ES      30
3250 #define FF_PROFILE_DTS_96_24   40
3251 #define FF_PROFILE_DTS_HD_HRA  50
3252 #define FF_PROFILE_DTS_HD_MA   60
3253 #define FF_PROFILE_DTS_EXPRESS 70
3254
3255 #define FF_PROFILE_MPEG2_422    0
3256 #define FF_PROFILE_MPEG2_HIGH   1
3257 #define FF_PROFILE_MPEG2_SS     2
3258 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3259 #define FF_PROFILE_MPEG2_MAIN   4
3260 #define FF_PROFILE_MPEG2_SIMPLE 5
3261
3262 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3263 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3264
3265 #define FF_PROFILE_H264_BASELINE             66
3266 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3267 #define FF_PROFILE_H264_MAIN                 77
3268 #define FF_PROFILE_H264_EXTENDED             88
3269 #define FF_PROFILE_H264_HIGH                 100
3270 #define FF_PROFILE_H264_HIGH_10              110
3271 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3272 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
3273 #define FF_PROFILE_H264_HIGH_422             122
3274 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3275 #define FF_PROFILE_H264_STEREO_HIGH          128
3276 #define FF_PROFILE_H264_HIGH_444             144
3277 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3278 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3279 #define FF_PROFILE_H264_CAVLC_444            44
3280
3281 #define FF_PROFILE_VC1_SIMPLE   0
3282 #define FF_PROFILE_VC1_MAIN     1
3283 #define FF_PROFILE_VC1_COMPLEX  2
3284 #define FF_PROFILE_VC1_ADVANCED 3
3285
3286 #define FF_PROFILE_MPEG4_SIMPLE                     0
3287 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3288 #define FF_PROFILE_MPEG4_CORE                       2
3289 #define FF_PROFILE_MPEG4_MAIN                       3
3290 #define FF_PROFILE_MPEG4_N_BIT                      4
3291 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3292 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3293 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3294 #define FF_PROFILE_MPEG4_HYBRID                     8
3295 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3296 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3297 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3298 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3299 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3300 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3301 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3302
3303 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
3304 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
3305 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
3306 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3307 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3308
3309 #define FF_PROFILE_VP9_0                            0
3310 #define FF_PROFILE_VP9_1                            1
3311 #define FF_PROFILE_VP9_2                            2
3312 #define FF_PROFILE_VP9_3                            3
3313
3314 #define FF_PROFILE_HEVC_MAIN                        1
3315 #define FF_PROFILE_HEVC_MAIN_10                     2
3316 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3317 #define FF_PROFILE_HEVC_REXT                        4
3318
3319     /**
3320      * level
3321      * - encoding: Set by user.
3322      * - decoding: Set by libavcodec.
3323      */
3324      int level;
3325 #define FF_LEVEL_UNKNOWN -99
3326
3327     /**
3328      * Skip loop filtering for selected frames.
3329      * - encoding: unused
3330      * - decoding: Set by user.
3331      */
3332     enum AVDiscard skip_loop_filter;
3333
3334     /**
3335      * Skip IDCT/dequantization for selected frames.
3336      * - encoding: unused
3337      * - decoding: Set by user.
3338      */
3339     enum AVDiscard skip_idct;
3340
3341     /**
3342      * Skip decoding for selected frames.
3343      * - encoding: unused
3344      * - decoding: Set by user.
3345      */
3346     enum AVDiscard skip_frame;
3347
3348     /**
3349      * Header containing style information for text subtitles.
3350      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3351      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3352      * the Format line following. It shouldn't include any Dialogue line.
3353      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3354      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3355      */
3356     uint8_t *subtitle_header;
3357     int subtitle_header_size;
3358
3359 #if FF_API_ERROR_RATE
3360     /**
3361      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3362      * encoders
3363      */
3364     attribute_deprecated
3365     int error_rate;
3366 #endif
3367
3368 #if FF_API_VBV_DELAY
3369     /**
3370      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3371      * Used for compliant TS muxing.
3372      * - encoding: Set by libavcodec.
3373      * - decoding: unused.
3374      * @deprecated this value is now exported as a part of
3375      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3376      */
3377     attribute_deprecated
3378     uint64_t vbv_delay;
3379 #endif
3380
3381 #if FF_API_SIDEDATA_ONLY_PKT
3382     /**
3383      * Encoding only and set by default. Allow encoders to output packets
3384      * that do not contain any encoded data, only side data.
3385      *
3386      * Some encoders need to output such packets, e.g. to update some stream
3387      * parameters at the end of encoding.
3388      *
3389      * @deprecated this field disables the default behaviour and
3390      *             it is kept only for compatibility.
3391      */
3392     attribute_deprecated
3393     int side_data_only_packets;
3394 #endif
3395
3396     /**
3397      * Audio only. The number of "priming" samples (padding) inserted by the
3398      * encoder at the beginning of the audio. I.e. this number of leading
3399      * decoded samples must be discarded by the caller to get the original audio
3400      * without leading padding.
3401      *
3402      * - decoding: unused
3403      * - encoding: Set by libavcodec. The timestamps on the output packets are
3404      *             adjusted by the encoder so that they always refer to the
3405      *             first sample of the data actually contained in the packet,
3406      *             including any added padding.  E.g. if the timebase is
3407      *             1/samplerate and the timestamp of the first input sample is
3408      *             0, the timestamp of the first output packet will be
3409      *             -initial_padding.
3410      */
3411     int initial_padding;
3412
3413     /**
3414      * - decoding: For codecs that store a framerate value in the compressed
3415      *             bitstream, the decoder may export it here. { 0, 1} when
3416      *             unknown.
3417      * - encoding: May be used to signal the framerate of CFR content to an
3418      *             encoder.
3419      */
3420     AVRational framerate;
3421
3422     /**
3423      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3424      * - encoding: unused.
3425      * - decoding: Set by libavcodec before calling get_format()
3426      */
3427     enum AVPixelFormat sw_pix_fmt;
3428
3429     /**
3430      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3431      * - encoding unused.
3432      * - decoding set by user.
3433      */
3434     AVRational pkt_timebase;
3435
3436     /**
3437      * AVCodecDescriptor
3438      * - encoding: unused.
3439      * - decoding: set by libavcodec.
3440      */
3441     const AVCodecDescriptor *codec_descriptor;
3442
3443 #if !FF_API_LOWRES
3444     /**
3445      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3446      * - encoding: unused
3447      * - decoding: Set by user.
3448      */
3449      int lowres;
3450 #endif
3451
3452     /**
3453      * Current statistics for PTS correction.
3454      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3455      * - encoding: unused
3456      */
3457     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3458     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3459     int64_t pts_correction_last_pts;       /// PTS of the last frame
3460     int64_t pts_correction_last_dts;       /// DTS of the last frame
3461
3462     /**
3463      * Character encoding of the input subtitles file.
3464      * - decoding: set by user
3465      * - encoding: unused
3466      */
3467     char *sub_charenc;
3468
3469     /**
3470      * Subtitles character encoding mode. Formats or codecs might be adjusting
3471      * this setting (if they are doing the conversion themselves for instance).
3472      * - decoding: set by libavcodec
3473      * - encoding: unused
3474      */
3475     int sub_charenc_mode;
3476 #define FF_SUB_CHARENC_MODE_DO_NOTHING  -1  ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3477 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3478 #define FF_SUB_CHARENC_MODE_PRE_DECODER  1  ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3479
3480     /**
3481      * Skip processing alpha if supported by codec.
3482      * Note that if the format uses pre-multiplied alpha (common with VP6,
3483      * and recommended due to better video quality/compression)
3484      * the image will look as if alpha-blended onto a black background.
3485      * However for formats that do not use pre-multiplied alpha
3486      * there might be serious artefacts (though e.g. libswscale currently
3487      * assumes pre-multiplied alpha anyway).
3488      *
3489      * - decoding: set by user
3490      * - encoding: unused
3491      */
3492     int skip_alpha;
3493
3494     /**
3495      * Number of samples to skip after a discontinuity
3496      * - decoding: unused
3497      * - encoding: set by libavcodec
3498      */
3499     int seek_preroll;
3500
3501 #if !FF_API_DEBUG_MV
3502     /**
3503      * debug motion vectors
3504      * - encoding: Set by user.
3505      * - decoding: Set by user.
3506      */
3507     int debug_mv;
3508 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3509 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3510 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3511 #endif
3512
3513     /**
3514      * custom intra quantization matrix
3515      * - encoding: Set by user, can be NULL.
3516      * - decoding: unused.
3517      */
3518     uint16_t *chroma_intra_matrix;
3519
3520     /**
3521      * dump format separator.
3522      * can be ", " or "\n      " or anything else
3523      * - encoding: Set by user.
3524      * - decoding: Set by user.
3525      */
3526     uint8_t *dump_separator;
3527
3528     /**
3529      * ',' separated list of allowed decoders.
3530      * If NULL then all are allowed
3531      * - encoding: unused
3532      * - decoding: set by user
3533      */
3534     char *codec_whitelist;
3535
3536     /*
3537      * Properties of the stream that gets decoded
3538      * - encoding: unused
3539      * - decoding: set by libavcodec
3540      */
3541     unsigned properties;
3542 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3543 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3544
3545     /**
3546      * Additional data associated with the entire coded stream.
3547      *
3548      * - decoding: unused
3549      * - encoding: may be set by libavcodec after avcodec_open2().
3550      */
3551     AVPacketSideData *coded_side_data;
3552     int            nb_coded_side_data;
3553
3554     /**
3555      * A reference to the AVHWFramesContext describing the input (for encoding)
3556      * or output (decoding) frames. The reference is set by the caller and
3557      * afterwards owned (and freed) by libavcodec - it should never be read by
3558      * the caller after being set.
3559      *
3560      * - decoding: This field should be set by the caller from the get_format()
3561      *             callback. The previous reference (if any) will always be
3562      *             unreffed by libavcodec before the get_format() call.
3563      *
3564      *             If the default get_buffer2() is used with a hwaccel pixel
3565      *             format, then this AVHWFramesContext will be used for
3566      *             allocating the frame buffers.
3567      *
3568      * - encoding: For hardware encoders configured to use a hwaccel pixel
3569      *             format, this field should be set by the caller to a reference
3570      *             to the AVHWFramesContext describing input frames.
3571      *             AVHWFramesContext.format must be equal to
3572      *             AVCodecContext.pix_fmt.
3573      *
3574      *             This field should be set before avcodec_open2() is called.
3575      */
3576     AVBufferRef *hw_frames_ctx;
3577
3578     /**
3579      * Control the form of AVSubtitle.rects[N]->ass
3580      * - decoding: set by user
3581      * - encoding: unused
3582      */
3583     int sub_text_format;
3584 #define FF_SUB_TEXT_FMT_ASS              0
3585 #if FF_API_ASS_TIMING
3586 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3587 #endif
3588
3589     /**
3590      * Audio only. The amount of padding (in samples) appended by the encoder to
3591      * the end of the audio. I.e. this number of decoded samples must be
3592      * discarded by the caller from the end of the stream to get the original
3593      * audio without any trailing padding.
3594      *
3595      * - decoding: unused
3596      * - encoding: unused
3597      */
3598     int trailing_padding;
3599
3600     /**
3601      * The number of pixels per image to maximally accept.
3602      *
3603      * - decoding: set by user
3604      * - encoding: set by user
3605      */
3606     int64_t max_pixels;
3607
3608     /**
3609      * A reference to the AVHWDeviceContext describing the device which will
3610      * be used by a hardware encoder/decoder.  The reference is set by the
3611      * caller and afterwards owned (and freed) by libavcodec.
3612      *
3613      * This should be used if either the codec device does not require
3614      * hardware frames or any that are used are to be allocated internally by
3615      * libavcodec.  If the user wishes to supply any of the frames used as
3616      * encoder input or decoder output then hw_frames_ctx should be used
3617      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3618      * field will be ignored while decoding the associated stream segment, but
3619      * may again be used on a following one after another get_format() call.
3620      *
3621      * For both encoders and decoders this field should be set before
3622      * avcodec_open2() is called and must not be written to thereafter.
3623      *
3624      * Note that some decoders may require this field to be set initially in
3625      * order to support hw_frames_ctx at all - in that case, all frames
3626      * contexts used must be created on the same device.
3627      */
3628     AVBufferRef *hw_device_ctx;
3629
3630     /**
3631      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3632      * decoding (if active).
3633      * - encoding: unused
3634      * - decoding: Set by user (either before avcodec_open2(), or in the
3635      *             AVCodecContext.get_format callback)
3636      */
3637     int hwaccel_flags;
3638 } AVCodecContext;
3639
3640 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3641 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3642
3643 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3644 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3645
3646 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3647
3648 int  av_codec_get_lowres(const AVCodecContext *avctx);
3649 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3650
3651 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3652 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3653
3654 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3655 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3656
3657 /**
3658  * AVProfile.
3659  */
3660 typedef struct AVProfile {
3661     int profile;
3662     const char *name; ///< short name for the profile
3663 } AVProfile;
3664
3665 typedef struct AVCodecDefault AVCodecDefault;
3666
3667 struct AVSubtitle;
3668
3669 /**
3670  * AVCodec.
3671  */
3672 typedef struct AVCodec {
3673     /**
3674      * Name of the codec implementation.
3675      * The name is globally unique among encoders and among decoders (but an
3676      * encoder and a decoder can share the same name).
3677      * This is the primary way to find a codec from the user perspective.
3678      */
3679     const char *name;
3680     /**
3681      * Descriptive name for the codec, meant to be more human readable than name.
3682      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3683      */
3684     const char *long_name;
3685     enum AVMediaType type;
3686     enum AVCodecID id;
3687     /**
3688      * Codec capabilities.
3689      * see AV_CODEC_CAP_*
3690      */
3691     int capabilities;
3692     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3693     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3694     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3695     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3696     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3697     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3698     const AVClass *priv_class;              ///< AVClass for the private context
3699     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3700
3701     /*****************************************************************
3702      * No fields below this line are part of the public API. They
3703      * may not be used outside of libavcodec and can be changed and
3704      * removed at will.
3705      * New public fields should be added right above.
3706      *****************************************************************
3707      */
3708     int priv_data_size;
3709     struct AVCodec *next;
3710     /**
3711      * @name Frame-level threading support functions
3712      * @{
3713      */
3714     /**
3715      * If defined, called on thread contexts when they are created.
3716      * If the codec allocates writable tables in init(), re-allocate them here.
3717      * priv_data will be set to a copy of the original.
3718      */
3719     int (*init_thread_copy)(AVCodecContext *);
3720     /**
3721      * Copy necessary context variables from a previous thread context to the current one.
3722      * If not defined, the next thread will start automatically; otherwise, the codec
3723      * must call ff_thread_finish_setup().
3724      *
3725      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3726      */
3727     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3728     /** @} */
3729
3730     /**
3731      * Private codec-specific defaults.
3732      */
3733     const AVCodecDefault *defaults;
3734
3735     /**
3736      * Initialize codec static data, called from avcodec_register().
3737      */
3738     void (*init_static_data)(struct AVCodec *codec);
3739
3740     int (*init)(AVCodecContext *);
3741     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3742                       const struct AVSubtitle *sub);
3743     /**
3744      * Encode data to an AVPacket.
3745      *
3746      * @param      avctx          codec context
3747      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3748      * @param[in]  frame          AVFrame containing the raw data to be encoded
3749      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3750      *                            non-empty packet was returned in avpkt.
3751      * @return 0 on success, negative error code on failure
3752      */
3753     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3754                    int *got_packet_ptr);
3755     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3756     int (*close)(AVCodecContext *);
3757     /**
3758      * Decode/encode API with decoupled packet/frame dataflow. The API is the
3759      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3760      * that:
3761      * - never called if the codec is closed or the wrong type,
3762      * - AVPacket parameter change side data is applied right before calling
3763      *   AVCodec->send_packet,
3764      * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3765      * - only one drain packet is ever passed down (until the next flush()),
3766      * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3767      */
3768     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3769     int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3770     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3771     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3772     /**
3773      * Flush buffers.
3774      * Will be called when seeking
3775      */
3776     void (*flush)(AVCodecContext *);
3777     /**
3778      * Internal codec capabilities.
3779      * See FF_CODEC_CAP_* in internal.h
3780      */
3781     int caps_internal;
3782 } AVCodec;
3783
3784 int av_codec_get_max_lowres(const AVCodec *codec);
3785
3786 struct MpegEncContext;
3787
3788 /**
3789  * @defgroup lavc_hwaccel AVHWAccel
3790  * @{
3791  */
3792 typedef struct AVHWAccel {
3793     /**
3794      * Name of the hardware accelerated codec.
3795      * The name is globally unique among encoders and among decoders (but an
3796      * encoder and a decoder can share the same name).
3797      */
3798     const char *name;
3799
3800     /**
3801      * Type of codec implemented by the hardware accelerator.
3802      *
3803      * See AVMEDIA_TYPE_xxx
3804      */
3805     enum AVMediaType type;
3806
3807     /**
3808      * Codec implemented by the hardware accelerator.
3809      *
3810      * See AV_CODEC_ID_xxx
3811      */
3812     enum AVCodecID id;
3813
3814     /**
3815      * Supported pixel format.
3816      *
3817      * Only hardware accelerated formats are supported here.
3818      */
3819     enum AVPixelFormat pix_fmt;
3820
3821     /**
3822      * Hardware accelerated codec capabilities.
3823      * see HWACCEL_CODEC_CAP_*
3824      */
3825     int capabilities;
3826
3827     /*****************************************************************
3828      * No fields below this line are part of the public API. They
3829      * may not be used outside of libavcodec and can be changed and
3830      * removed at will.
3831      * New public fields should be added right above.
3832      *****************************************************************
3833      */
3834     struct AVHWAccel *next;
3835
3836     /**
3837      * Allocate a custom buffer
3838      */
3839     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3840
3841     /**
3842      * Called at the beginning of each frame or field picture.
3843      *
3844      * Meaningful frame information (codec specific) is guaranteed to
3845      * be parsed at this point. This function is mandatory.
3846      *
3847      * Note that buf can be NULL along with buf_size set to 0.
3848      * Otherwise, this means the whole frame is available at this point.
3849      *
3850      * @param avctx the codec context
3851      * @param buf the frame data buffer base
3852      * @param buf_size the size of the frame in bytes
3853      * @return zero if successful, a negative value otherwise
3854      */
3855     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3856
3857     /**
3858      * Callback for each slice.
3859      *
3860      * Meaningful slice information (codec specific) is guaranteed to
3861      * be parsed at this point. This function is mandatory.
3862      * The only exception is XvMC, that works on MB level.
3863      *
3864      * @param avctx the codec context
3865      * @param buf the slice data buffer base
3866      * @param buf_size the size of the slice in bytes
3867      * @return zero if successful, a negative value otherwise
3868      */
3869     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3870
3871     /**
3872      * Called at the end of each frame or field picture.
3873      *
3874      * The whole picture is parsed at this point and can now be sent
3875      * to the hardware accelerator. This function is mandatory.
3876      *
3877      * @param avctx the codec context
3878      * @return zero if successful, a negative value otherwise
3879      */
3880     int (*end_frame)(AVCodecContext *avctx);
3881
3882     /**
3883      * Size of per-frame hardware accelerator private data.
3884      *
3885      * Private data is allocated with av_mallocz() before
3886      * AVCodecContext.get_buffer() and deallocated after
3887      * AVCodecContext.release_buffer().
3888      */
3889     int frame_priv_data_size;
3890
3891     /**
3892      * Called for every Macroblock in a slice.
3893      *
3894      * XvMC uses it to replace the ff_mpv_decode_mb().
3895      * Instead of decoding to raw picture, MB parameters are
3896      * stored in an array provided by the video driver.
3897      *
3898      * @param s the mpeg context
3899      */
3900     void (*decode_mb)(struct MpegEncContext *s);
3901
3902     /**
3903      * Initialize the hwaccel private data.
3904      *
3905      * This will be called from ff_get_format(), after hwaccel and
3906      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3907      * is allocated.
3908      */
3909     int (*init)(AVCodecContext *avctx);
3910
3911     /**
3912      * Uninitialize the hwaccel private data.
3913      *
3914      * This will be called from get_format() or avcodec_close(), after hwaccel
3915      * and hwaccel_context are already uninitialized.
3916      */
3917     int (*uninit)(AVCodecContext *avctx);
3918
3919     /**
3920      * Size of the private data to allocate in
3921      * AVCodecInternal.hwaccel_priv_data.
3922      */
3923     int priv_data_size;
3924
3925     /**
3926      * Internal hwaccel capabilities.
3927      */
3928     int caps_internal;
3929 } AVHWAccel;
3930
3931 /**
3932  * Hardware acceleration should be used for decoding even if the codec level
3933  * used is unknown or higher than the maximum supported level reported by the
3934  * hardware driver.
3935  *
3936  * It's generally a good idea to pass this flag unless you have a specific
3937  * reason not to, as hardware tends to under-report supported levels.
3938  */
3939 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3940
3941 /**
3942  * Hardware acceleration can output YUV pixel formats with a different chroma
3943  * sampling than 4:2:0 and/or other than 8 bits per component.
3944  */
3945 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3946
3947 /**
3948  * @}
3949  */
3950
3951 #if FF_API_AVPICTURE
3952 /**
3953  * @defgroup lavc_picture AVPicture
3954  *
3955  * Functions for working with AVPicture
3956  * @{
3957  */
3958
3959 /**
3960  * Picture data structure.
3961  *
3962  * Up to four components can be stored into it, the last component is
3963  * alpha.
3964  * @deprecated use AVFrame or imgutils functions instead
3965  */
3966 typedef struct AVPicture {
3967     attribute_deprecated
3968     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
3969     attribute_deprecated
3970     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3971 } AVPicture;
3972
3973 /**
3974  * @}
3975  */
3976 #endif
3977
3978 enum AVSubtitleType {
3979     SUBTITLE_NONE,
3980
3981     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3982
3983     /**
3984      * Plain text, the text field must be set by the decoder and is
3985      * authoritative. ass and pict fields may contain approximations.
3986      */
3987     SUBTITLE_TEXT,
3988
3989     /**
3990      * Formatted text, the ass field must be set by the decoder and is
3991      * authoritative. pict and text fields may contain approximations.
3992      */
3993     SUBTITLE_ASS,
3994 };
3995
3996 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3997
3998 typedef struct AVSubtitleRect {
3999     int x;         ///< top left corner  of pict, undefined when pict is not set
4000     int y;         ///< top left corner  of pict, undefined when pict is not set
4001     int w;         ///< width            of pict, undefined when pict is not set
4002     int h;         ///< height           of pict, undefined when pict is not set
4003     int nb_colors; ///< number of colors in pict, undefined when pict is not set
4004
4005 #if FF_API_AVPICTURE
4006     /**
4007      * @deprecated unused
4008      */
4009     attribute_deprecated
4010     AVPicture pict;
4011 #endif
4012     /**
4013      * data+linesize for the bitmap of this subtitle.
4014      * Can be set for text/ass as well once they are rendered.
4015      */
4016     uint8_t *data[4];
4017     int linesize[4];
4018
4019     enum AVSubtitleType type;
4020
4021     char *text;                     ///< 0 terminated plain UTF-8 text
4022
4023     /**
4024      * 0 terminated ASS/SSA compatible event line.
4025      * The presentation of this is unaffected by the other values in this
4026      * struct.
4027      */
4028     char *ass;
4029
4030     int flags;
4031 } AVSubtitleRect;
4032
4033 typedef struct AVSubtitle {
4034     uint16_t format; /* 0 = graphics */
4035     uint32_t start_display_time; /* relative to packet pts, in ms */
4036     uint32_t end_display_time; /* relative to packet pts, in ms */
4037     unsigned num_rects;
4038     AVSubtitleRect **rects;
4039     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
4040 } AVSubtitle;
4041
4042 /**
4043  * This struct describes the properties of an encoded stream.
4044  *
4045  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4046  * be allocated with avcodec_parameters_alloc() and freed with
4047  * avcodec_parameters_free().
4048  */
4049 typedef struct AVCodecParameters {
4050     /**
4051      * General type of the encoded data.
4052      */
4053     enum AVMediaType codec_type;
4054     /**
4055      * Specific type of the encoded data (the codec used).
4056      */
4057     enum AVCodecID   codec_id;
4058     /**
4059      * Additional information about the codec (corresponds to the AVI FOURCC).
4060      */
4061     uint32_t         codec_tag;
4062
4063     /**
4064      * Extra binary data needed for initializing the decoder, codec-dependent.
4065      *
4066      * Must be allocated with av_malloc() and will be freed by
4067      * avcodec_parameters_free(). The allocated size of extradata must be at
4068      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4069      * bytes zeroed.
4070      */
4071     uint8_t *extradata;
4072     /**
4073      * Size of the extradata content in bytes.
4074      */
4075     int      extradata_size;
4076
4077     /**
4078      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4079      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4080      */
4081     int format;
4082
4083     /**
4084      * The average bitrate of the encoded data (in bits per second).
4085      */
4086     int64_t bit_rate;
4087
4088     /**
4089      * The number of bits per sample in the codedwords.
4090      *
4091      * This is basically the bitrate per sample. It is mandatory for a bunch of
4092      * formats to actually decode them. It's the number of bits for one sample in
4093      * the actual coded bitstream.
4094      *
4095      * This could be for example 4 for ADPCM
4096      * For PCM formats this matches bits_per_raw_sample
4097      * Can be 0
4098      */
4099     int bits_per_coded_sample;
4100
4101     /**
4102      * This is the number of valid bits in each output sample. If the
4103      * sample format has more bits, the least significant bits are additional
4104      * padding bits, which are always 0. Use right shifts to reduce the sample
4105      * to its actual size. For example, audio formats with 24 bit samples will
4106      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4107      * To get the original sample use "(int32_t)sample >> 8"."
4108      *
4109      * For ADPCM this might be 12 or 16 or similar
4110      * Can be 0
4111      */
4112     int bits_per_raw_sample;
4113
4114     /**
4115      * Codec-specific bitstream restrictions that the stream conforms to.
4116      */
4117     int profile;
4118     int level;
4119
4120     /**
4121      * Video only. The dimensions of the video frame in pixels.
4122      */
4123     int width;
4124     int height;
4125
4126     /**
4127      * Video only. The aspect ratio (width / height) which a single pixel
4128      * should have when displayed.
4129      *
4130      * When the aspect ratio is unknown / undefined, the numerator should be
4131      * set to 0 (the denominator may have any value).
4132      */
4133     AVRational sample_aspect_ratio;
4134
4135     /**
4136      * Video only. The order of the fields in interlaced video.
4137      */
4138     enum AVFieldOrder                  field_order;
4139
4140     /**
4141      * Video only. Additional colorspace characteristics.
4142      */
4143     enum AVColorRange                  color_range;
4144     enum AVColorPrimaries              color_primaries;
4145     enum AVColorTransferCharacteristic color_trc;
4146     enum AVColorSpace                  color_space;
4147     enum AVChromaLocation              chroma_location;
4148
4149     /**
4150      * Video only. Number of delayed frames.
4151      */
4152     int video_delay;
4153
4154     /**
4155      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4156      * unknown or unspecified, otherwise the number of bits set must be equal to
4157      * the channels field.
4158      */
4159     uint64_t channel_layout;
4160     /**
4161      * Audio only. The number of audio channels.
4162      */
4163     int      channels;
4164     /**
4165      * Audio only. The number of audio samples per second.
4166      */
4167     int      sample_rate;
4168     /**
4169      * Audio only. The number of bytes per coded audio frame, required by some
4170      * formats.
4171      *
4172      * Corresponds to nBlockAlign in WAVEFORMATEX.
4173      */
4174     int      block_align;
4175     /**
4176      * Audio only. Audio frame size, if known. Required by some formats to be static.
4177      */
4178     int      frame_size;
4179
4180     /**
4181      * Audio only. The amount of padding (in samples) inserted by the encoder at
4182      * the beginning of the audio. I.e. this number of leading decoded samples
4183      * must be discarded by the caller to get the original audio without leading
4184      * padding.
4185      */
4186     int initial_padding;
4187     /**
4188      * Audio only. The amount of padding (in samples) appended by the encoder to
4189      * the end of the audio. I.e. this number of decoded samples must be
4190      * discarded by the caller from the end of the stream to get the original
4191      * audio without any trailing padding.
4192      */
4193     int trailing_padding;
4194     /**
4195      * Audio only. Number of samples to skip after a discontinuity.
4196      */
4197     int seek_preroll;
4198 } AVCodecParameters;
4199
4200 /**
4201  * If c is NULL, returns the first registered codec,
4202  * if c is non-NULL, returns the next registered codec after c,
4203  * or NULL if c is the last one.
4204  */
4205 AVCodec *av_codec_next(const AVCodec *c);
4206
4207 /**
4208  * Return the LIBAVCODEC_VERSION_INT constant.
4209  */
4210 unsigned avcodec_version(void);
4211
4212 /**
4213  * Return the libavcodec build-time configuration.
4214  */
4215 const char *avcodec_configuration(void);
4216
4217 /**
4218  * Return the libavcodec license.
4219  */
4220 const char *avcodec_license(void);
4221
4222 /**
4223  * Register the codec codec and initialize libavcodec.
4224  *
4225  * @warning either this function or avcodec_register_all() must be called
4226  * before any other libavcodec functions.
4227  *
4228  * @see avcodec_register_all()
4229  */
4230 void avcodec_register(AVCodec *codec);
4231
4232 /**
4233  * Register all the codecs, parsers and bitstream filters which were enabled at
4234  * configuration time. If you do not call this function you can select exactly
4235  * which formats you want to support, by using the individual registration
4236  * functions.
4237  *
4238  * @see avcodec_register
4239  * @see av_register_codec_parser
4240  * @see av_register_bitstream_filter
4241  */
4242 void avcodec_register_all(void);
4243
4244 /**
4245  * Allocate an AVCodecContext and set its fields to default values. The
4246  * resulting struct should be freed with avcodec_free_context().
4247  *
4248  * @param codec if non-NULL, allocate private data and initialize defaults
4249  *              for the given codec. It is illegal to then call avcodec_open2()
4250  *              with a different codec.
4251  *              If NULL, then the codec-specific defaults won't be initialized,
4252  *              which may result in suboptimal default settings (this is
4253  *              important mainly for encoders, e.g. libx264).
4254  *
4255  * @return An AVCodecContext filled with default values or NULL on failure.
4256  */
4257 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4258
4259 /**
4260  * Free the codec context and everything associated with it and write NULL to
4261  * the provided pointer.
4262  */
4263 void avcodec_free_context(AVCodecContext **avctx);
4264
4265 #if FF_API_GET_CONTEXT_DEFAULTS
4266 /**
4267  * @deprecated This function should not be used, as closing and opening a codec
4268  * context multiple time is not supported. A new codec context should be
4269  * allocated for each new use.
4270  */
4271 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4272 #endif
4273
4274 /**
4275  * Get the AVClass for AVCodecContext. It can be used in combination with
4276  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4277  *
4278  * @see av_opt_find().
4279  */
4280 const AVClass *avcodec_get_class(void);
4281
4282 #if FF_API_COPY_CONTEXT
4283 /**
4284  * Get the AVClass for AVFrame. It can be used in combination with
4285  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4286  *
4287  * @see av_opt_find().
4288  */
4289 const AVClass *avcodec_get_frame_class(void);
4290
4291 /**
4292  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4293  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4294  *
4295  * @see av_opt_find().
4296  */
4297 const AVClass *avcodec_get_subtitle_rect_class(void);
4298
4299 /**
4300  * Copy the settings of the source AVCodecContext into the destination
4301  * AVCodecContext. The resulting destination codec context will be
4302  * unopened, i.e. you are required to call avcodec_open2() before you
4303  * can use this AVCodecContext to decode/encode video/audio data.
4304  *
4305  * @param dest target codec context, should be initialized with
4306  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
4307  * @param src source codec context
4308  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4309  *
4310  * @deprecated The semantics of this function are ill-defined and it should not
4311  * be used. If you need to transfer the stream parameters from one codec context
4312  * to another, use an intermediate AVCodecParameters instance and the
4313  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4314  * functions.
4315  */
4316 attribute_deprecated
4317 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4318 #endif
4319
4320 /**
4321  * Allocate a new AVCodecParameters and set its fields to default values
4322  * (unknown/invalid/0). The returned struct must be freed with
4323  * avcodec_parameters_free().
4324  */
4325 AVCodecParameters *avcodec_parameters_alloc(void);
4326
4327 /**
4328  * Free an AVCodecParameters instance and everything associated with it and
4329  * write NULL to the supplied pointer.
4330  */
4331 void avcodec_parameters_free(AVCodecParameters **par);
4332
4333 /**
4334  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4335  * replaced with newly allocated duplicates of the corresponding fields in src.
4336  *
4337  * @return >= 0 on success, a negative AVERROR code on failure.
4338  */
4339 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4340
4341 /**
4342  * Fill the parameters struct based on the values from the supplied codec
4343  * context. Any allocated fields in par are freed and replaced with duplicates
4344  * of the corresponding fields in codec.
4345  *
4346  * @return >= 0 on success, a negative AVERROR code on failure
4347  */
4348 int avcodec_parameters_from_context(AVCodecParameters *par,
4349                                     const AVCodecContext *codec);
4350
4351 /**
4352  * Fill the codec context based on the values from the supplied codec
4353  * parameters. Any allocated fields in codec that have a corresponding field in
4354  * par are freed and replaced with duplicates of the corresponding field in par.
4355  * Fields in codec that do not have a counterpart in par are not touched.
4356  *
4357  * @return >= 0 on success, a negative AVERROR code on failure.
4358  */
4359 int avcodec_parameters_to_context(AVCodecContext *codec,
4360                                   const AVCodecParameters *par);
4361
4362 /**
4363  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4364  * function the context has to be allocated with avcodec_alloc_context3().
4365  *
4366  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4367  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4368  * retrieving a codec.
4369  *
4370  * @warning This function is not thread safe!
4371  *
4372  * @note Always call this function before using decoding routines (such as
4373  * @ref avcodec_receive_frame()).
4374  *
4375  * @code
4376  * avcodec_register_all();
4377  * av_dict_set(&opts, "b", "2.5M", 0);
4378  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4379  * if (!codec)
4380  *     exit(1);
4381  *
4382  * context = avcodec_alloc_context3(codec);
4383  *
4384  * if (avcodec_open2(context, codec, opts) < 0)
4385  *     exit(1);
4386  * @endcode
4387  *
4388  * @param avctx The context to initialize.
4389  * @param codec The codec to open this context for. If a non-NULL codec has been
4390  *              previously passed to avcodec_alloc_context3() or
4391  *              for this context, then this parameter MUST be either NULL or
4392  *              equal to the previously passed codec.
4393  * @param options A dictionary filled with AVCodecContext and codec-private options.
4394  *                On return this object will be filled with options that were not found.
4395  *
4396  * @return zero on success, a negative value on error
4397  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4398  *      av_dict_set(), av_opt_find().
4399  */
4400 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4401
4402 /**
4403  * Close a given AVCodecContext and free all the data associated with it
4404  * (but not the AVCodecContext itself).
4405  *
4406  * Calling this function on an AVCodecContext that hasn't been opened will free
4407  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4408  * codec. Subsequent calls will do nothing.
4409  *
4410  * @note Do not use this function. Use avcodec_free_context() to destroy a
4411  * codec context (either open or closed). Opening and closing a codec context
4412  * multiple times is not supported anymore -- use multiple codec contexts
4413  * instead.
4414  */
4415 int avcodec_close(AVCodecContext *avctx);
4416
4417 /**
4418  * Free all allocated data in the given subtitle struct.
4419  *
4420  * @param sub AVSubtitle to free.
4421  */
4422 void avsubtitle_free(AVSubtitle *sub);
4423
4424 /**
4425  * @}
4426  */
4427
4428 /**
4429  * @addtogroup lavc_packet
4430  * @{
4431  */
4432
4433 /**
4434  * Allocate an AVPacket and set its fields to default values.  The resulting
4435  * struct must be freed using av_packet_free().
4436  *
4437  * @return An AVPacket filled with default values or NULL on failure.
4438  *
4439  * @note this only allocates the AVPacket itself, not the data buffers. Those
4440  * must be allocated through other means such as av_new_packet.
4441  *
4442  * @see av_new_packet
4443  */
4444 AVPacket *av_packet_alloc(void);
4445
4446 /**
4447  * Create a new packet that references the same data as src.
4448  *
4449  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4450  *
4451  * @return newly created AVPacket on success, NULL on error.
4452  *
4453  * @see av_packet_alloc
4454  * @see av_packet_ref
4455  */
4456 AVPacket *av_packet_clone(const AVPacket *src);
4457
4458 /**
4459  * Free the packet, if the packet is reference counted, it will be
4460  * unreferenced first.
4461  *
4462  * @param pkt packet to be freed. The pointer will be set to NULL.
4463  * @note passing NULL is a no-op.
4464  */
4465 void av_packet_free(AVPacket **pkt);
4466
4467 /**
4468  * Initialize optional fields of a packet with default values.
4469  *
4470  * Note, this does not touch the data and size members, which have to be
4471  * initialized separately.
4472  *
4473  * @param pkt packet
4474  */
4475 void av_init_packet(AVPacket *pkt);
4476
4477 /**
4478  * Allocate the payload of a packet and initialize its fields with
4479  * default values.
4480  *
4481  * @param pkt packet
4482  * @param size wanted payload size
4483  * @return 0 if OK, AVERROR_xxx otherwise
4484  */
4485 int av_new_packet(AVPacket *pkt, int size);
4486
4487 /**
4488  * Reduce packet size, correctly zeroing padding
4489  *
4490  * @param pkt packet
4491  * @param size new size
4492  */
4493 void av_shrink_packet(AVPacket *pkt, int size);
4494
4495 /**
4496  * Increase packet size, correctly zeroing padding
4497  *
4498  * @param pkt packet
4499  * @param grow_by number of bytes by which to increase the size of the packet
4500  */
4501 int av_grow_packet(AVPacket *pkt, int grow_by);
4502
4503 /**
4504  * Initialize a reference-counted packet from av_malloc()ed data.
4505  *
4506  * @param pkt packet to be initialized. This function will set the data, size,
4507  *        buf and destruct fields, all others are left untouched.
4508  * @param data Data allocated by av_malloc() to be used as packet data. If this
4509  *        function returns successfully, the data is owned by the underlying AVBuffer.
4510  *        The caller may not access the data through other means.
4511  * @param size size of data in bytes, without the padding. I.e. the full buffer
4512  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4513  *
4514  * @return 0 on success, a negative AVERROR on error
4515  */
4516 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4517
4518 #if FF_API_AVPACKET_OLD_API
4519 /**
4520  * @warning This is a hack - the packet memory allocation stuff is broken. The
4521  * packet is allocated if it was not really allocated.
4522  *
4523  * @deprecated Use av_packet_ref
4524  */
4525 attribute_deprecated
4526 int av_dup_packet(AVPacket *pkt);
4527 /**
4528  * Copy packet, including contents
4529  *
4530  * @return 0 on success, negative AVERROR on fail
4531  */
4532 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4533
4534 /**
4535  * Copy packet side data
4536  *
4537  * @return 0 on success, negative AVERROR on fail
4538  */
4539 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4540
4541 /**
4542  * Free a packet.
4543  *
4544  * @deprecated Use av_packet_unref
4545  *
4546  * @param pkt packet to free
4547  */
4548 attribute_deprecated
4549 void av_free_packet(AVPacket *pkt);
4550 #endif
4551 /**
4552  * Allocate new information of a packet.
4553  *
4554  * @param pkt packet
4555  * @param type side information type
4556  * @param size side information size
4557  * @return pointer to fresh allocated data&