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