vda: Check the correct pointer for buffer allocation
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
41
42 #include "version.h"
43
44 #if FF_API_FAST_MALLOC
45 // to provide fast_*alloc
46 #include "libavutil/mem.h"
47 #endif
48
49 /**
50  * @defgroup libavc Encoding/Decoding Library
51  * @{
52  *
53  * @defgroup lavc_decoding Decoding
54  * @{
55  * @}
56  *
57  * @defgroup lavc_encoding Encoding
58  * @{
59  * @}
60  *
61  * @defgroup lavc_codec Codecs
62  * @{
63  * @defgroup lavc_codec_native Native Codecs
64  * @{
65  * @}
66  * @defgroup lavc_codec_wrappers External library wrappers
67  * @{
68  * @}
69  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
70  * @{
71  * @}
72  * @}
73  * @defgroup lavc_internal Internal
74  * @{
75  * @}
76  * @}
77  *
78  */
79
80 /**
81  * @defgroup lavc_core Core functions/structures.
82  * @ingroup libavc
83  *
84  * Basic definitions, functions for querying libavcodec capabilities,
85  * allocating core structures, etc.
86  * @{
87  */
88
89
90 /**
91  * Identify the syntax and semantics of the bitstream.
92  * The principle is roughly:
93  * Two decoders with the same ID can decode the same streams.
94  * Two encoders with the same ID can encode compatible streams.
95  * There may be slight deviations from the principle due to implementation
96  * details.
97  *
98  * If you add a codec ID to this list, add it so that
99  * 1. no value of a existing codec ID changes (that would break ABI),
100  * 2. it is as close as possible to similar codecs.
101  *
102  * After adding new codec IDs, do not forget to add an entry to the codec
103  * descriptor list and bump libavcodec minor version.
104  */
105 enum AVCodecID {
106     AV_CODEC_ID_NONE,
107
108     /* video codecs */
109     AV_CODEC_ID_MPEG1VIDEO,
110     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
111 #if FF_API_XVMC
112     AV_CODEC_ID_MPEG2VIDEO_XVMC,
113 #endif /* FF_API_XVMC */
114     AV_CODEC_ID_H261,
115     AV_CODEC_ID_H263,
116     AV_CODEC_ID_RV10,
117     AV_CODEC_ID_RV20,
118     AV_CODEC_ID_MJPEG,
119     AV_CODEC_ID_MJPEGB,
120     AV_CODEC_ID_LJPEG,
121     AV_CODEC_ID_SP5X,
122     AV_CODEC_ID_JPEGLS,
123     AV_CODEC_ID_MPEG4,
124     AV_CODEC_ID_RAWVIDEO,
125     AV_CODEC_ID_MSMPEG4V1,
126     AV_CODEC_ID_MSMPEG4V2,
127     AV_CODEC_ID_MSMPEG4V3,
128     AV_CODEC_ID_WMV1,
129     AV_CODEC_ID_WMV2,
130     AV_CODEC_ID_H263P,
131     AV_CODEC_ID_H263I,
132     AV_CODEC_ID_FLV1,
133     AV_CODEC_ID_SVQ1,
134     AV_CODEC_ID_SVQ3,
135     AV_CODEC_ID_DVVIDEO,
136     AV_CODEC_ID_HUFFYUV,
137     AV_CODEC_ID_CYUV,
138     AV_CODEC_ID_H264,
139     AV_CODEC_ID_INDEO3,
140     AV_CODEC_ID_VP3,
141     AV_CODEC_ID_THEORA,
142     AV_CODEC_ID_ASV1,
143     AV_CODEC_ID_ASV2,
144     AV_CODEC_ID_FFV1,
145     AV_CODEC_ID_4XM,
146     AV_CODEC_ID_VCR1,
147     AV_CODEC_ID_CLJR,
148     AV_CODEC_ID_MDEC,
149     AV_CODEC_ID_ROQ,
150     AV_CODEC_ID_INTERPLAY_VIDEO,
151     AV_CODEC_ID_XAN_WC3,
152     AV_CODEC_ID_XAN_WC4,
153     AV_CODEC_ID_RPZA,
154     AV_CODEC_ID_CINEPAK,
155     AV_CODEC_ID_WS_VQA,
156     AV_CODEC_ID_MSRLE,
157     AV_CODEC_ID_MSVIDEO1,
158     AV_CODEC_ID_IDCIN,
159     AV_CODEC_ID_8BPS,
160     AV_CODEC_ID_SMC,
161     AV_CODEC_ID_FLIC,
162     AV_CODEC_ID_TRUEMOTION1,
163     AV_CODEC_ID_VMDVIDEO,
164     AV_CODEC_ID_MSZH,
165     AV_CODEC_ID_ZLIB,
166     AV_CODEC_ID_QTRLE,
167     AV_CODEC_ID_TSCC,
168     AV_CODEC_ID_ULTI,
169     AV_CODEC_ID_QDRAW,
170     AV_CODEC_ID_VIXL,
171     AV_CODEC_ID_QPEG,
172     AV_CODEC_ID_PNG,
173     AV_CODEC_ID_PPM,
174     AV_CODEC_ID_PBM,
175     AV_CODEC_ID_PGM,
176     AV_CODEC_ID_PGMYUV,
177     AV_CODEC_ID_PAM,
178     AV_CODEC_ID_FFVHUFF,
179     AV_CODEC_ID_RV30,
180     AV_CODEC_ID_RV40,
181     AV_CODEC_ID_VC1,
182     AV_CODEC_ID_WMV3,
183     AV_CODEC_ID_LOCO,
184     AV_CODEC_ID_WNV1,
185     AV_CODEC_ID_AASC,
186     AV_CODEC_ID_INDEO2,
187     AV_CODEC_ID_FRAPS,
188     AV_CODEC_ID_TRUEMOTION2,
189     AV_CODEC_ID_BMP,
190     AV_CODEC_ID_CSCD,
191     AV_CODEC_ID_MMVIDEO,
192     AV_CODEC_ID_ZMBV,
193     AV_CODEC_ID_AVS,
194     AV_CODEC_ID_SMACKVIDEO,
195     AV_CODEC_ID_NUV,
196     AV_CODEC_ID_KMVC,
197     AV_CODEC_ID_FLASHSV,
198     AV_CODEC_ID_CAVS,
199     AV_CODEC_ID_JPEG2000,
200     AV_CODEC_ID_VMNC,
201     AV_CODEC_ID_VP5,
202     AV_CODEC_ID_VP6,
203     AV_CODEC_ID_VP6F,
204     AV_CODEC_ID_TARGA,
205     AV_CODEC_ID_DSICINVIDEO,
206     AV_CODEC_ID_TIERTEXSEQVIDEO,
207     AV_CODEC_ID_TIFF,
208     AV_CODEC_ID_GIF,
209     AV_CODEC_ID_DXA,
210     AV_CODEC_ID_DNXHD,
211     AV_CODEC_ID_THP,
212     AV_CODEC_ID_SGI,
213     AV_CODEC_ID_C93,
214     AV_CODEC_ID_BETHSOFTVID,
215     AV_CODEC_ID_PTX,
216     AV_CODEC_ID_TXD,
217     AV_CODEC_ID_VP6A,
218     AV_CODEC_ID_AMV,
219     AV_CODEC_ID_VB,
220     AV_CODEC_ID_PCX,
221     AV_CODEC_ID_SUNRAST,
222     AV_CODEC_ID_INDEO4,
223     AV_CODEC_ID_INDEO5,
224     AV_CODEC_ID_MIMIC,
225     AV_CODEC_ID_RL2,
226     AV_CODEC_ID_ESCAPE124,
227     AV_CODEC_ID_DIRAC,
228     AV_CODEC_ID_BFI,
229     AV_CODEC_ID_CMV,
230     AV_CODEC_ID_MOTIONPIXELS,
231     AV_CODEC_ID_TGV,
232     AV_CODEC_ID_TGQ,
233     AV_CODEC_ID_TQI,
234     AV_CODEC_ID_AURA,
235     AV_CODEC_ID_AURA2,
236     AV_CODEC_ID_V210X,
237     AV_CODEC_ID_TMV,
238     AV_CODEC_ID_V210,
239     AV_CODEC_ID_DPX,
240     AV_CODEC_ID_MAD,
241     AV_CODEC_ID_FRWU,
242     AV_CODEC_ID_FLASHSV2,
243     AV_CODEC_ID_CDGRAPHICS,
244     AV_CODEC_ID_R210,
245     AV_CODEC_ID_ANM,
246     AV_CODEC_ID_BINKVIDEO,
247     AV_CODEC_ID_IFF_ILBM,
248     AV_CODEC_ID_IFF_BYTERUN1,
249     AV_CODEC_ID_KGV1,
250     AV_CODEC_ID_YOP,
251     AV_CODEC_ID_VP8,
252     AV_CODEC_ID_PICTOR,
253     AV_CODEC_ID_ANSI,
254     AV_CODEC_ID_A64_MULTI,
255     AV_CODEC_ID_A64_MULTI5,
256     AV_CODEC_ID_R10K,
257     AV_CODEC_ID_MXPEG,
258     AV_CODEC_ID_LAGARITH,
259     AV_CODEC_ID_PRORES,
260     AV_CODEC_ID_JV,
261     AV_CODEC_ID_DFA,
262     AV_CODEC_ID_WMV3IMAGE,
263     AV_CODEC_ID_VC1IMAGE,
264     AV_CODEC_ID_UTVIDEO,
265     AV_CODEC_ID_BMV_VIDEO,
266     AV_CODEC_ID_VBLE,
267     AV_CODEC_ID_DXTORY,
268     AV_CODEC_ID_V410,
269     AV_CODEC_ID_XWD,
270     AV_CODEC_ID_CDXL,
271     AV_CODEC_ID_XBM,
272     AV_CODEC_ID_ZEROCODEC,
273     AV_CODEC_ID_MSS1,
274     AV_CODEC_ID_MSA1,
275     AV_CODEC_ID_TSCC2,
276     AV_CODEC_ID_MTS2,
277     AV_CODEC_ID_CLLC,
278     AV_CODEC_ID_MSS2,
279     AV_CODEC_ID_VP9,
280     AV_CODEC_ID_AIC,
281     AV_CODEC_ID_ESCAPE130,
282     AV_CODEC_ID_G2M,
283     AV_CODEC_ID_WEBP,
284     AV_CODEC_ID_HNM4_VIDEO,
285     AV_CODEC_ID_HEVC,
286     AV_CODEC_ID_FIC,
287     AV_CODEC_ID_ALIAS_PIX,
288     AV_CODEC_ID_BRENDER_PIX,
289     AV_CODEC_ID_PAF_VIDEO,
290     AV_CODEC_ID_EXR,
291     AV_CODEC_ID_VP7,
292     AV_CODEC_ID_SANM,
293     AV_CODEC_ID_SGIRLE,
294     AV_CODEC_ID_MVC1,
295     AV_CODEC_ID_MVC2,
296     AV_CODEC_ID_HQX,
297     AV_CODEC_ID_TDSC,
298     AV_CODEC_ID_HQ_HQA,
299     AV_CODEC_ID_HAP,
300     AV_CODEC_ID_DDS,
301
302     /* various PCM "codecs" */
303     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
304     AV_CODEC_ID_PCM_S16LE = 0x10000,
305     AV_CODEC_ID_PCM_S16BE,
306     AV_CODEC_ID_PCM_U16LE,
307     AV_CODEC_ID_PCM_U16BE,
308     AV_CODEC_ID_PCM_S8,
309     AV_CODEC_ID_PCM_U8,
310     AV_CODEC_ID_PCM_MULAW,
311     AV_CODEC_ID_PCM_ALAW,
312     AV_CODEC_ID_PCM_S32LE,
313     AV_CODEC_ID_PCM_S32BE,
314     AV_CODEC_ID_PCM_U32LE,
315     AV_CODEC_ID_PCM_U32BE,
316     AV_CODEC_ID_PCM_S24LE,
317     AV_CODEC_ID_PCM_S24BE,
318     AV_CODEC_ID_PCM_U24LE,
319     AV_CODEC_ID_PCM_U24BE,
320     AV_CODEC_ID_PCM_S24DAUD,
321     AV_CODEC_ID_PCM_ZORK,
322     AV_CODEC_ID_PCM_S16LE_PLANAR,
323     AV_CODEC_ID_PCM_DVD,
324     AV_CODEC_ID_PCM_F32BE,
325     AV_CODEC_ID_PCM_F32LE,
326     AV_CODEC_ID_PCM_F64BE,
327     AV_CODEC_ID_PCM_F64LE,
328     AV_CODEC_ID_PCM_BLURAY,
329     AV_CODEC_ID_PCM_LXF,
330     AV_CODEC_ID_S302M,
331     AV_CODEC_ID_PCM_S8_PLANAR,
332     AV_CODEC_ID_PCM_S24LE_PLANAR,
333     AV_CODEC_ID_PCM_S32LE_PLANAR,
334     AV_CODEC_ID_PCM_S16BE_PLANAR,
335
336     /* various ADPCM codecs */
337     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
338     AV_CODEC_ID_ADPCM_IMA_WAV,
339     AV_CODEC_ID_ADPCM_IMA_DK3,
340     AV_CODEC_ID_ADPCM_IMA_DK4,
341     AV_CODEC_ID_ADPCM_IMA_WS,
342     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
343     AV_CODEC_ID_ADPCM_MS,
344     AV_CODEC_ID_ADPCM_4XM,
345     AV_CODEC_ID_ADPCM_XA,
346     AV_CODEC_ID_ADPCM_ADX,
347     AV_CODEC_ID_ADPCM_EA,
348     AV_CODEC_ID_ADPCM_G726,
349     AV_CODEC_ID_ADPCM_CT,
350     AV_CODEC_ID_ADPCM_SWF,
351     AV_CODEC_ID_ADPCM_YAMAHA,
352     AV_CODEC_ID_ADPCM_SBPRO_4,
353     AV_CODEC_ID_ADPCM_SBPRO_3,
354     AV_CODEC_ID_ADPCM_SBPRO_2,
355     AV_CODEC_ID_ADPCM_THP,
356     AV_CODEC_ID_ADPCM_IMA_AMV,
357     AV_CODEC_ID_ADPCM_EA_R1,
358     AV_CODEC_ID_ADPCM_EA_R3,
359     AV_CODEC_ID_ADPCM_EA_R2,
360     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
361     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
362     AV_CODEC_ID_ADPCM_EA_XAS,
363     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
364     AV_CODEC_ID_ADPCM_IMA_ISS,
365     AV_CODEC_ID_ADPCM_G722,
366     AV_CODEC_ID_ADPCM_IMA_APC,
367     AV_CODEC_ID_ADPCM_VIMA,
368
369     /* AMR */
370     AV_CODEC_ID_AMR_NB = 0x12000,
371     AV_CODEC_ID_AMR_WB,
372
373     /* RealAudio codecs*/
374     AV_CODEC_ID_RA_144 = 0x13000,
375     AV_CODEC_ID_RA_288,
376
377     /* various DPCM codecs */
378     AV_CODEC_ID_ROQ_DPCM = 0x14000,
379     AV_CODEC_ID_INTERPLAY_DPCM,
380     AV_CODEC_ID_XAN_DPCM,
381     AV_CODEC_ID_SOL_DPCM,
382
383     /* audio codecs */
384     AV_CODEC_ID_MP2 = 0x15000,
385     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
386     AV_CODEC_ID_AAC,
387     AV_CODEC_ID_AC3,
388     AV_CODEC_ID_DTS,
389     AV_CODEC_ID_VORBIS,
390     AV_CODEC_ID_DVAUDIO,
391     AV_CODEC_ID_WMAV1,
392     AV_CODEC_ID_WMAV2,
393     AV_CODEC_ID_MACE3,
394     AV_CODEC_ID_MACE6,
395     AV_CODEC_ID_VMDAUDIO,
396     AV_CODEC_ID_FLAC,
397     AV_CODEC_ID_MP3ADU,
398     AV_CODEC_ID_MP3ON4,
399     AV_CODEC_ID_SHORTEN,
400     AV_CODEC_ID_ALAC,
401     AV_CODEC_ID_WESTWOOD_SND1,
402     AV_CODEC_ID_GSM, ///< as in Berlin toast format
403     AV_CODEC_ID_QDM2,
404     AV_CODEC_ID_COOK,
405     AV_CODEC_ID_TRUESPEECH,
406     AV_CODEC_ID_TTA,
407     AV_CODEC_ID_SMACKAUDIO,
408     AV_CODEC_ID_QCELP,
409     AV_CODEC_ID_WAVPACK,
410     AV_CODEC_ID_DSICINAUDIO,
411     AV_CODEC_ID_IMC,
412     AV_CODEC_ID_MUSEPACK7,
413     AV_CODEC_ID_MLP,
414     AV_CODEC_ID_GSM_MS, /* as found in WAV */
415     AV_CODEC_ID_ATRAC3,
416 #if FF_API_VOXWARE
417     AV_CODEC_ID_VOXWARE,
418 #endif
419     AV_CODEC_ID_APE,
420     AV_CODEC_ID_NELLYMOSER,
421     AV_CODEC_ID_MUSEPACK8,
422     AV_CODEC_ID_SPEEX,
423     AV_CODEC_ID_WMAVOICE,
424     AV_CODEC_ID_WMAPRO,
425     AV_CODEC_ID_WMALOSSLESS,
426     AV_CODEC_ID_ATRAC3P,
427     AV_CODEC_ID_EAC3,
428     AV_CODEC_ID_SIPR,
429     AV_CODEC_ID_MP1,
430     AV_CODEC_ID_TWINVQ,
431     AV_CODEC_ID_TRUEHD,
432     AV_CODEC_ID_MP4ALS,
433     AV_CODEC_ID_ATRAC1,
434     AV_CODEC_ID_BINKAUDIO_RDFT,
435     AV_CODEC_ID_BINKAUDIO_DCT,
436     AV_CODEC_ID_AAC_LATM,
437     AV_CODEC_ID_QDMC,
438     AV_CODEC_ID_CELT,
439     AV_CODEC_ID_G723_1,
440     AV_CODEC_ID_G729,
441     AV_CODEC_ID_8SVX_EXP,
442     AV_CODEC_ID_8SVX_FIB,
443     AV_CODEC_ID_BMV_AUDIO,
444     AV_CODEC_ID_RALF,
445     AV_CODEC_ID_IAC,
446     AV_CODEC_ID_ILBC,
447     AV_CODEC_ID_OPUS,
448     AV_CODEC_ID_COMFORT_NOISE,
449     AV_CODEC_ID_TAK,
450     AV_CODEC_ID_METASOUND,
451     AV_CODEC_ID_PAF_AUDIO,
452     AV_CODEC_ID_ON2AVC,
453     AV_CODEC_ID_DSS_SP,
454
455     /* subtitle codecs */
456     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
457     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
458     AV_CODEC_ID_DVB_SUBTITLE,
459     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
460     AV_CODEC_ID_XSUB,
461     AV_CODEC_ID_SSA,
462     AV_CODEC_ID_MOV_TEXT,
463     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
464     AV_CODEC_ID_DVB_TELETEXT,
465     AV_CODEC_ID_SRT,
466
467     /* other specific kind of codecs (generally used for attachments) */
468     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
469     AV_CODEC_ID_TTF = 0x18000,
470
471     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
472
473     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
474                                 * stream (only used by libavformat) */
475     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
476                                 * stream (only used by libavformat) */
477     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
478 };
479
480 /**
481  * This struct describes the properties of a single codec described by an
482  * AVCodecID.
483  * @see avcodec_descriptor_get()
484  */
485 typedef struct AVCodecDescriptor {
486     enum AVCodecID     id;
487     enum AVMediaType type;
488     /**
489      * Name of the codec described by this descriptor. It is non-empty and
490      * unique for each codec descriptor. It should contain alphanumeric
491      * characters and '_' only.
492      */
493     const char      *name;
494     /**
495      * A more descriptive name for this codec. May be NULL.
496      */
497     const char *long_name;
498     /**
499      * Codec properties, a combination of AV_CODEC_PROP_* flags.
500      */
501     int             props;
502 } AVCodecDescriptor;
503
504 /**
505  * Codec uses only intra compression.
506  * Video codecs only.
507  */
508 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
509 /**
510  * Codec supports lossy compression. Audio and video codecs only.
511  * @note a codec may support both lossy and lossless
512  * compression modes
513  */
514 #define AV_CODEC_PROP_LOSSY         (1 << 1)
515 /**
516  * Codec supports lossless compression. Audio and video codecs only.
517  */
518 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
519 /**
520  * Codec supports frame reordering. That is, the coded order (the order in which
521  * the encoded packets are output by the encoders / stored / input to the
522  * decoders) may be different from the presentation order of the corresponding
523  * frames.
524  *
525  * For codecs that do not have this property set, PTS and DTS should always be
526  * equal.
527  */
528 #define AV_CODEC_PROP_REORDER       (1 << 3)
529
530 /**
531  * @ingroup lavc_decoding
532  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
533  * This is mainly needed because some optimized bitstream readers read
534  * 32 or 64 bit at once and could read over the end.<br>
535  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
536  * MPEG bitstreams could cause overread and segfault.
537  */
538 #define FF_INPUT_BUFFER_PADDING_SIZE 8
539
540 /**
541  * @ingroup lavc_encoding
542  * minimum encoding buffer size
543  * Used to avoid some checks during header writing.
544  */
545 #define FF_MIN_BUFFER_SIZE 16384
546
547
548 /**
549  * @ingroup lavc_encoding
550  * motion estimation type.
551  */
552 enum Motion_Est_ID {
553     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
554     ME_FULL,
555     ME_LOG,
556     ME_PHODS,
557     ME_EPZS,        ///< enhanced predictive zonal search
558     ME_X1,          ///< reserved for experiments
559     ME_HEX,         ///< hexagon based search
560     ME_UMH,         ///< uneven multi-hexagon search
561     ME_TESA,        ///< transformed exhaustive search algorithm
562 };
563
564 /**
565  * @ingroup lavc_decoding
566  */
567 enum AVDiscard{
568     /* We leave some space between them for extensions (drop some
569      * keyframes for intra-only or drop just some bidir frames). */
570     AVDISCARD_NONE    =-16, ///< discard nothing
571     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
572     AVDISCARD_NONREF  =  8, ///< discard all non reference
573     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
574     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
575     AVDISCARD_ALL     = 48, ///< discard all
576 };
577
578 enum AVAudioServiceType {
579     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
580     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
581     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
582     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
583     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
584     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
585     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
586     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
587     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
588     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
589 };
590
591 /**
592  * @ingroup lavc_encoding
593  */
594 typedef struct RcOverride{
595     int start_frame;
596     int end_frame;
597     int qscale; // If this is 0 then quality_factor will be used instead.
598     float quality_factor;
599 } RcOverride;
600
601 #if FF_API_MAX_BFRAMES
602 /**
603  * @deprecated there is no libavcodec-wide limit on the number of B-frames
604  */
605 #define FF_MAX_B_FRAMES 16
606 #endif
607
608 /* encoding support
609    These flags can be passed in AVCodecContext.flags before initialization.
610    Note: Not everything is supported yet.
611 */
612
613 /**
614  * Allow decoders to produce frames with data planes that are not aligned
615  * to CPU requirements (e.g. due to cropping).
616  */
617 #define CODEC_FLAG_UNALIGNED 0x0001
618 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
619 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
620 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
621 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
622 #if FF_API_GMC
623 /**
624  * @deprecated use the "gmc" private option of the libxvid encoder
625  */
626 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
627 #endif
628 #if FF_API_MV0
629 /**
630  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
631  * mpegvideo encoders
632  */
633 #define CODEC_FLAG_MV0    0x0040
634 #endif
635 #if FF_API_INPUT_PRESERVED
636 /**
637  * @deprecated passing reference-counted frames to the encoders replaces this
638  * flag
639  */
640 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
641 #endif
642 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
643 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
644 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
645 #if FF_API_EMU_EDGE
646 /**
647  * @deprecated edges are not used/required anymore. I.e. this flag is now always
648  * set.
649  */
650 #define CODEC_FLAG_EMU_EDGE        0x4000
651 #endif
652 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
653 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
654                                                   location instead of only at frame boundaries. */
655 #if FF_API_NORMALIZE_AQP
656 /**
657  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
658  * mpegvideo encoders
659  */
660 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
661 #endif
662 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
663 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
664 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
665 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
666 /* Fx : Flag for h263+ extra options */
667 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
668 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
669 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
670 #define CODEC_FLAG_CLOSED_GOP     0x80000000
671 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
672 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
673 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
674 #define CODEC_FLAG2_IGNORE_CROP   0x00010000 ///< Discard cropping information from SPS.
675
676 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
677
678 /* Unsupported options :
679  *              Syntax Arithmetic coding (SAC)
680  *              Reference Picture Selection
681  *              Independent Segment Decoding */
682 /* /Fx */
683 /* codec capabilities */
684
685 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
686 /**
687  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
688  * If not set, it might not use get_buffer() at all or use operations that
689  * assume the buffer was allocated by avcodec_default_get_buffer.
690  */
691 #define CODEC_CAP_DR1             0x0002
692 #define CODEC_CAP_TRUNCATED       0x0008
693 #if FF_API_XVMC
694 /* Codec can export data for HW decoding (XvMC). */
695 #define CODEC_CAP_HWACCEL         0x0010
696 #endif /* FF_API_XVMC */
697 /**
698  * Encoder or decoder requires flushing with NULL input at the end in order to
699  * give the complete and correct output.
700  *
701  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
702  *       with NULL data. The user can still send NULL data to the public encode
703  *       or decode function, but libavcodec will not pass it along to the codec
704  *       unless this flag is set.
705  *
706  * Decoders:
707  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
708  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
709  * returns frames.
710  *
711  * Encoders:
712  * The encoder needs to be fed with NULL data at the end of encoding until the
713  * encoder no longer returns data.
714  *
715  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
716  *       flag also means that the encoder must set the pts and duration for
717  *       each output packet. If this flag is not set, the pts and duration will
718  *       be determined by libavcodec from the input frame.
719  */
720 #define CODEC_CAP_DELAY           0x0020
721 /**
722  * Codec can be fed a final frame with a smaller size.
723  * This can be used to prevent truncation of the last audio samples.
724  */
725 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
726 #if FF_API_CAP_VDPAU
727 /**
728  * Codec can export data for HW decoding (VDPAU).
729  */
730 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
731 #endif
732 /**
733  * Codec can output multiple frames per AVPacket
734  * Normally demuxers return one frame at a time, demuxers which do not do
735  * are connected to a parser to split what they return into proper frames.
736  * This flag is reserved to the very rare category of codecs which have a
737  * bitstream that cannot be split into frames without timeconsuming
738  * operations like full decoding. Demuxers carring such bitstreams thus
739  * may return multiple frames in a packet. This has many disadvantages like
740  * prohibiting stream copy in many cases thus it should only be considered
741  * as a last resort.
742  */
743 #define CODEC_CAP_SUBFRAMES        0x0100
744 /**
745  * Codec is experimental and is thus avoided in favor of non experimental
746  * encoders
747  */
748 #define CODEC_CAP_EXPERIMENTAL     0x0200
749 /**
750  * Codec should fill in channel configuration and samplerate instead of container
751  */
752 #define CODEC_CAP_CHANNEL_CONF     0x0400
753 #if FF_API_NEG_LINESIZES
754 /**
755  * @deprecated no codecs use this capability
756  */
757 #define CODEC_CAP_NEG_LINESIZES    0x0800
758 #endif
759 /**
760  * Codec supports frame-level multithreading.
761  */
762 #define CODEC_CAP_FRAME_THREADS    0x1000
763 /**
764  * Codec supports slice-based (or partition-based) multithreading.
765  */
766 #define CODEC_CAP_SLICE_THREADS    0x2000
767 /**
768  * Codec supports changed parameters at any point.
769  */
770 #define CODEC_CAP_PARAM_CHANGE     0x4000
771 /**
772  * Codec supports avctx->thread_count == 0 (auto).
773  */
774 #define CODEC_CAP_AUTO_THREADS     0x8000
775 /**
776  * Audio encoder supports receiving a different number of samples in each call.
777  */
778 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
779
780 #if FF_API_MB_TYPE
781 //The following defines may change, don't expect compatibility if you use them.
782 #define MB_TYPE_INTRA4x4   0x0001
783 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
784 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
785 #define MB_TYPE_16x16      0x0008
786 #define MB_TYPE_16x8       0x0010
787 #define MB_TYPE_8x16       0x0020
788 #define MB_TYPE_8x8        0x0040
789 #define MB_TYPE_INTERLACED 0x0080
790 #define MB_TYPE_DIRECT2    0x0100 //FIXME
791 #define MB_TYPE_ACPRED     0x0200
792 #define MB_TYPE_GMC        0x0400
793 #define MB_TYPE_SKIP       0x0800
794 #define MB_TYPE_P0L0       0x1000
795 #define MB_TYPE_P1L0       0x2000
796 #define MB_TYPE_P0L1       0x4000
797 #define MB_TYPE_P1L1       0x8000
798 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
799 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
800 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
801 #define MB_TYPE_QUANT      0x00010000
802 #define MB_TYPE_CBP        0x00020000
803 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
804 #endif
805
806 /**
807  * Pan Scan area.
808  * This specifies the area which should be displayed.
809  * Note there may be multiple such areas for one frame.
810  */
811 typedef struct AVPanScan{
812     /**
813      * id
814      * - encoding: Set by user.
815      * - decoding: Set by libavcodec.
816      */
817     int id;
818
819     /**
820      * width and height in 1/16 pel
821      * - encoding: Set by user.
822      * - decoding: Set by libavcodec.
823      */
824     int width;
825     int height;
826
827     /**
828      * position of the top left corner in 1/16 pel for up to 3 fields/frames
829      * - encoding: Set by user.
830      * - decoding: Set by libavcodec.
831      */
832     int16_t position[3][2];
833 }AVPanScan;
834
835 #if FF_API_QSCALE_TYPE
836 #define FF_QSCALE_TYPE_MPEG1 0
837 #define FF_QSCALE_TYPE_MPEG2 1
838 #define FF_QSCALE_TYPE_H264  2
839 #define FF_QSCALE_TYPE_VP56  3
840 #endif
841
842 #if FF_API_GET_BUFFER
843 #define FF_BUFFER_TYPE_INTERNAL 1
844 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
845 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
846 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
847
848 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
849 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
850 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
851 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
852 #endif
853
854 /**
855  * The decoder will keep a reference to the frame and may reuse it later.
856  */
857 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
858
859 /**
860  * @defgroup lavc_packet AVPacket
861  *
862  * Types and functions for working with AVPacket.
863  * @{
864  */
865 enum AVPacketSideDataType {
866     AV_PKT_DATA_PALETTE,
867     AV_PKT_DATA_NEW_EXTRADATA,
868
869     /**
870      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
871      * @code
872      * u32le param_flags
873      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
874      *     s32le channel_count
875      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
876      *     u64le channel_layout
877      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
878      *     s32le sample_rate
879      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
880      *     s32le width
881      *     s32le height
882      * @endcode
883      */
884     AV_PKT_DATA_PARAM_CHANGE,
885
886     /**
887      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
888      * structures with info about macroblocks relevant to splitting the
889      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
890      * That is, it does not necessarily contain info about all macroblocks,
891      * as long as the distance between macroblocks in the info is smaller
892      * than the target payload size.
893      * Each MB info structure is 12 bytes, and is laid out as follows:
894      * @code
895      * u32le bit offset from the start of the packet
896      * u8    current quantizer at the start of the macroblock
897      * u8    GOB number
898      * u16le macroblock address within the GOB
899      * u8    horizontal MV predictor
900      * u8    vertical MV predictor
901      * u8    horizontal MV predictor for block number 3
902      * u8    vertical MV predictor for block number 3
903      * @endcode
904      */
905     AV_PKT_DATA_H263_MB_INFO,
906
907     /**
908      * This side data should be associated with an audio stream and contains
909      * ReplayGain information in form of the AVReplayGain struct.
910      */
911     AV_PKT_DATA_REPLAYGAIN,
912
913     /**
914      * This side data contains a 3x3 transformation matrix describing an affine
915      * transformation that needs to be applied to the decoded video frames for
916      * correct presentation.
917      *
918      * See libavutil/display.h for a detailed description of the data.
919      */
920     AV_PKT_DATA_DISPLAYMATRIX,
921
922     /**
923      * This side data should be associated with a video stream and contains
924      * Stereoscopic 3D information in form of the AVStereo3D struct.
925      */
926     AV_PKT_DATA_STEREO3D,
927
928     /**
929      * This side data should be associated with an audio stream and corresponds
930      * to enum AVAudioServiceType.
931      */
932     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
933 };
934
935 typedef struct AVPacketSideData {
936     uint8_t *data;
937     int      size;
938     enum AVPacketSideDataType type;
939 } AVPacketSideData;
940
941 /**
942  * This structure stores compressed data. It is typically exported by demuxers
943  * and then passed as input to decoders, or received as output from encoders and
944  * then passed to muxers.
945  *
946  * For video, it should typically contain one compressed frame. For audio it may
947  * contain several compressed frames.
948  *
949  * AVPacket is one of the few structs in Libav, whose size is a part of public
950  * ABI. Thus it may be allocated on stack and no new fields can be added to it
951  * without libavcodec and libavformat major bump.
952  *
953  * The semantics of data ownership depends on the buf or destruct (deprecated)
954  * fields. If either is set, the packet data is dynamically allocated and is
955  * valid indefinitely until av_free_packet() is called (which in turn calls
956  * av_buffer_unref()/the destruct callback to free the data). If neither is set,
957  * the packet data is typically backed by some static buffer somewhere and is
958  * only valid for a limited time (e.g. until the next read call when demuxing).
959  *
960  * The side data is always allocated with av_malloc() and is freed in
961  * av_free_packet().
962  */
963 typedef struct AVPacket {
964     /**
965      * A reference to the reference-counted buffer where the packet data is
966      * stored.
967      * May be NULL, then the packet data is not reference-counted.
968      */
969     AVBufferRef *buf;
970     /**
971      * Presentation timestamp in AVStream->time_base units; the time at which
972      * the decompressed packet will be presented to the user.
973      * Can be AV_NOPTS_VALUE if it is not stored in the file.
974      * pts MUST be larger or equal to dts as presentation cannot happen before
975      * decompression, unless one wants to view hex dumps. Some formats misuse
976      * the terms dts and pts/cts to mean something different. Such timestamps
977      * must be converted to true pts/dts before they are stored in AVPacket.
978      */
979     int64_t pts;
980     /**
981      * Decompression timestamp in AVStream->time_base units; the time at which
982      * the packet is decompressed.
983      * Can be AV_NOPTS_VALUE if it is not stored in the file.
984      */
985     int64_t dts;
986     uint8_t *data;
987     int   size;
988     int   stream_index;
989     /**
990      * A combination of AV_PKT_FLAG values
991      */
992     int   flags;
993     /**
994      * Additional packet data that can be provided by the container.
995      * Packet can contain several types of side information.
996      */
997     AVPacketSideData *side_data;
998     int side_data_elems;
999
1000     /**
1001      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1002      * Equals next_pts - this_pts in presentation order.
1003      */
1004     int   duration;
1005 #if FF_API_DESTRUCT_PACKET
1006     attribute_deprecated
1007     void  (*destruct)(struct AVPacket *);
1008     attribute_deprecated
1009     void  *priv;
1010 #endif
1011     int64_t pos;                            ///< byte position in stream, -1 if unknown
1012
1013     /**
1014      * Time difference in AVStream->time_base units from the pts of this
1015      * packet to the point at which the output from the decoder has converged
1016      * independent from the availability of previous frames. That is, the
1017      * frames are virtually identical no matter if decoding started from
1018      * the very first frame or from this keyframe.
1019      * Is AV_NOPTS_VALUE if unknown.
1020      * This field is not the display duration of the current packet.
1021      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1022      * set.
1023      *
1024      * The purpose of this field is to allow seeking in streams that have no
1025      * keyframes in the conventional sense. It corresponds to the
1026      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1027      * essential for some types of subtitle streams to ensure that all
1028      * subtitles are correctly displayed after seeking.
1029      */
1030     int64_t convergence_duration;
1031 } AVPacket;
1032 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1033 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1034
1035 enum AVSideDataParamChangeFlags {
1036     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1037     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1038     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1039     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1040 };
1041 /**
1042  * @}
1043  */
1044
1045 struct AVCodecInternal;
1046
1047 enum AVFieldOrder {
1048     AV_FIELD_UNKNOWN,
1049     AV_FIELD_PROGRESSIVE,
1050     AV_FIELD_TT,          //< Top coded_first, top displayed first
1051     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1052     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1053     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1054 };
1055
1056 /**
1057  * main external API structure.
1058  * New fields can be added to the end with minor version bumps.
1059  * Removal, reordering and changes to existing fields require a major
1060  * version bump.
1061  * sizeof(AVCodecContext) must not be used outside libav*.
1062  */
1063 typedef struct AVCodecContext {
1064     /**
1065      * information on struct for av_log
1066      * - set by avcodec_alloc_context3
1067      */
1068     const AVClass *av_class;
1069     int log_level_offset;
1070
1071     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1072     const struct AVCodec  *codec;
1073 #if FF_API_CODEC_NAME
1074     /**
1075      * @deprecated this field is not used for anything in libavcodec
1076      */
1077     attribute_deprecated
1078     char             codec_name[32];
1079 #endif
1080     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1081
1082     /**
1083      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1084      * This is used to work around some encoder bugs.
1085      * A demuxer should set this to what is stored in the field used to identify the codec.
1086      * If there are multiple such fields in a container then the demuxer should choose the one
1087      * which maximizes the information about the used codec.
1088      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1089      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1090      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1091      * first.
1092      * - encoding: Set by user, if not then the default based on codec_id will be used.
1093      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1094      */
1095     unsigned int codec_tag;
1096
1097 #if FF_API_STREAM_CODEC_TAG
1098     /**
1099      * @deprecated this field is unused
1100      */
1101     attribute_deprecated
1102     unsigned int stream_codec_tag;
1103 #endif
1104
1105     void *priv_data;
1106
1107     /**
1108      * Private context used for internal data.
1109      *
1110      * Unlike priv_data, this is not codec-specific. It is used in general
1111      * libavcodec functions.
1112      */
1113     struct AVCodecInternal *internal;
1114
1115     /**
1116      * Private data of the user, can be used to carry app specific stuff.
1117      * - encoding: Set by user.
1118      * - decoding: Set by user.
1119      */
1120     void *opaque;
1121
1122     /**
1123      * the average bitrate
1124      * - encoding: Set by user; unused for constant quantizer encoding.
1125      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1126      */
1127     int bit_rate;
1128
1129     /**
1130      * number of bits the bitstream is allowed to diverge from the reference.
1131      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1132      * - encoding: Set by user; unused for constant quantizer encoding.
1133      * - decoding: unused
1134      */
1135     int bit_rate_tolerance;
1136
1137     /**
1138      * Global quality for codecs which cannot change it per frame.
1139      * This should be proportional to MPEG-1/2/4 qscale.
1140      * - encoding: Set by user.
1141      * - decoding: unused
1142      */
1143     int global_quality;
1144
1145     /**
1146      * - encoding: Set by user.
1147      * - decoding: unused
1148      */
1149     int compression_level;
1150 #define FF_COMPRESSION_DEFAULT -1
1151
1152     /**
1153      * CODEC_FLAG_*.
1154      * - encoding: Set by user.
1155      * - decoding: Set by user.
1156      */
1157     int flags;
1158
1159     /**
1160      * CODEC_FLAG2_*
1161      * - encoding: Set by user.
1162      * - decoding: Set by user.
1163      */
1164     int flags2;
1165
1166     /**
1167      * some codecs need / can use extradata like Huffman tables.
1168      * mjpeg: Huffman tables
1169      * rv10: additional flags
1170      * mpeg4: global headers (they can be in the bitstream or here)
1171      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1172      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1173      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1174      * - encoding: Set/allocated/freed by libavcodec.
1175      * - decoding: Set/allocated/freed by user.
1176      */
1177     uint8_t *extradata;
1178     int extradata_size;
1179
1180     /**
1181      * This is the fundamental unit of time (in seconds) in terms
1182      * of which frame timestamps are represented. For fixed-fps content,
1183      * timebase should be 1/framerate and timestamp increments should be
1184      * identically 1.
1185      * - encoding: MUST be set by user.
1186      * - decoding: the use of this field for decoding is deprecated.
1187      *             Use framerate instead.
1188      */
1189     AVRational time_base;
1190
1191     /**
1192      * For some codecs, the time base is closer to the field rate than the frame rate.
1193      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1194      * if no telecine is used ...
1195      *
1196      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1197      */
1198     int ticks_per_frame;
1199
1200     /**
1201      * Codec delay.
1202      *
1203      * Video:
1204      *   Number of frames the decoded output will be delayed relative to the
1205      *   encoded input.
1206      *
1207      * Audio:
1208      *   For encoding, this field is unused (see initial_padding).
1209      *
1210      *   For decoding, this is the number of samples the decoder needs to
1211      *   output before the decoder's output is valid. When seeking, you should
1212      *   start decoding this many samples prior to your desired seek point.
1213      *
1214      * - encoding: Set by libavcodec.
1215      * - decoding: Set by libavcodec.
1216      */
1217     int delay;
1218
1219
1220     /* video only */
1221     /**
1222      * picture width / height.
1223      *
1224      * @note Those fields may not match the values of the last
1225      * AVFrame outputted by avcodec_decode_video2 due frame
1226      * reordering.
1227      *
1228      * - encoding: MUST be set by user.
1229      * - decoding: May be set by the user before opening the decoder if known e.g.
1230      *             from the container. Some decoders will require the dimensions
1231      *             to be set by the caller. During decoding, the decoder may
1232      *             overwrite those values as required while parsing the data.
1233      */
1234     int width, height;
1235
1236     /**
1237      * Bitstream width / height, may be different from width/height e.g. when
1238      * the decoded frame is cropped before being output.
1239      *
1240      * @note Those field may not match the value of the last
1241      * AVFrame outputted by avcodec_decode_video2 due frame
1242      * reordering.
1243      *
1244      * - encoding: unused
1245      * - decoding: May be set by the user before opening the decoder if known
1246      *             e.g. from the container. During decoding, the decoder may
1247      *             overwrite those values as required while parsing the data.
1248      */
1249     int coded_width, coded_height;
1250
1251 #if FF_API_ASPECT_EXTENDED
1252 #define FF_ASPECT_EXTENDED 15
1253 #endif
1254
1255     /**
1256      * the number of pictures in a group of pictures, or 0 for intra_only
1257      * - encoding: Set by user.
1258      * - decoding: unused
1259      */
1260     int gop_size;
1261
1262     /**
1263      * Pixel format, see AV_PIX_FMT_xxx.
1264      * May be set by the demuxer if known from headers.
1265      * May be overriden by the decoder if it knows better.
1266      *
1267      * @note This field may not match the value of the last
1268      * AVFrame outputted by avcodec_decode_video2 due frame
1269      * reordering.
1270      *
1271      * - encoding: Set by user.
1272      * - decoding: Set by user if known, overridden by libavcodec while
1273      *             parsing the data.
1274      */
1275     enum AVPixelFormat pix_fmt;
1276
1277     /**
1278      * Motion estimation algorithm used for video coding.
1279      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1280      * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1281      * - encoding: MUST be set by user.
1282      * - decoding: unused
1283      */
1284     int me_method;
1285
1286     /**
1287      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1288      * decoder to draw a horizontal band. It improves cache usage. Not
1289      * all codecs can do that. You must check the codec capabilities
1290      * beforehand.
1291      * When multithreading is used, it may be called from multiple threads
1292      * at the same time; threads might draw different parts of the same AVFrame,
1293      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1294      * in order.
1295      * The function is also used by hardware acceleration APIs.
1296      * It is called at least once during frame decoding to pass
1297      * the data needed for hardware render.
1298      * In that mode instead of pixel data, AVFrame points to
1299      * a structure specific to the acceleration API. The application
1300      * reads the structure and can change some fields to indicate progress
1301      * or mark state.
1302      * - encoding: unused
1303      * - decoding: Set by user.
1304      * @param height the height of the slice
1305      * @param y the y position of the slice
1306      * @param type 1->top field, 2->bottom field, 3->frame
1307      * @param offset offset into the AVFrame.data from which the slice should be read
1308      */
1309     void (*draw_horiz_band)(struct AVCodecContext *s,
1310                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1311                             int y, int type, int height);
1312
1313     /**
1314      * callback to negotiate the pixelFormat
1315      * @param fmt is the list of formats which are supported by the codec,
1316      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1317      * The first is always the native one.
1318      * @note The callback may be called again immediately if initialization for
1319      * the selected (hardware-accelerated) pixel format failed.
1320      * @warning Behavior is undefined if the callback returns a value not
1321      * in the fmt list of formats.
1322      * @return the chosen format
1323      * - encoding: unused
1324      * - decoding: Set by user, if not set the native format will be chosen.
1325      */
1326     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1327
1328     /**
1329      * maximum number of B-frames between non-B-frames
1330      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1331      * - encoding: Set by user.
1332      * - decoding: unused
1333      */
1334     int max_b_frames;
1335
1336     /**
1337      * qscale factor between IP and B-frames
1338      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1339      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1340      * - encoding: Set by user.
1341      * - decoding: unused
1342      */
1343     float b_quant_factor;
1344
1345     /** obsolete FIXME remove */
1346     int rc_strategy;
1347 #define FF_RC_STRATEGY_XVID 1
1348
1349     int b_frame_strategy;
1350
1351     /**
1352      * qscale offset between IP and B-frames
1353      * - encoding: Set by user.
1354      * - decoding: unused
1355      */
1356     float b_quant_offset;
1357
1358     /**
1359      * Size of the frame reordering buffer in the decoder.
1360      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1361      * - encoding: Set by libavcodec.
1362      * - decoding: Set by libavcodec.
1363      */
1364     int has_b_frames;
1365
1366     /**
1367      * 0-> h263 quant 1-> mpeg quant
1368      * - encoding: Set by user.
1369      * - decoding: unused
1370      */
1371     int mpeg_quant;
1372
1373     /**
1374      * qscale factor between P and I-frames
1375      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1376      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1377      * - encoding: Set by user.
1378      * - decoding: unused
1379      */
1380     float i_quant_factor;
1381
1382     /**
1383      * qscale offset between P and I-frames
1384      * - encoding: Set by user.
1385      * - decoding: unused
1386      */
1387     float i_quant_offset;
1388
1389     /**
1390      * luminance masking (0-> disabled)
1391      * - encoding: Set by user.
1392      * - decoding: unused
1393      */
1394     float lumi_masking;
1395
1396     /**
1397      * temporary complexity masking (0-> disabled)
1398      * - encoding: Set by user.
1399      * - decoding: unused
1400      */
1401     float temporal_cplx_masking;
1402
1403     /**
1404      * spatial complexity masking (0-> disabled)
1405      * - encoding: Set by user.
1406      * - decoding: unused
1407      */
1408     float spatial_cplx_masking;
1409
1410     /**
1411      * p block masking (0-> disabled)
1412      * - encoding: Set by user.
1413      * - decoding: unused
1414      */
1415     float p_masking;
1416
1417     /**
1418      * darkness masking (0-> disabled)
1419      * - encoding: Set by user.
1420      * - decoding: unused
1421      */
1422     float dark_masking;
1423
1424     /**
1425      * slice count
1426      * - encoding: Set by libavcodec.
1427      * - decoding: Set by user (or 0).
1428      */
1429     int slice_count;
1430     /**
1431      * prediction method (needed for huffyuv)
1432      * - encoding: Set by user.
1433      * - decoding: unused
1434      */
1435      int prediction_method;
1436 #define FF_PRED_LEFT   0
1437 #define FF_PRED_PLANE  1
1438 #define FF_PRED_MEDIAN 2
1439
1440     /**
1441      * slice offsets in the frame in bytes
1442      * - encoding: Set/allocated by libavcodec.
1443      * - decoding: Set/allocated by user (or NULL).
1444      */
1445     int *slice_offset;
1446
1447     /**
1448      * sample aspect ratio (0 if unknown)
1449      * That is the width of a pixel divided by the height of the pixel.
1450      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1451      * - encoding: Set by user.
1452      * - decoding: Set by libavcodec.
1453      */
1454     AVRational sample_aspect_ratio;
1455
1456     /**
1457      * motion estimation comparison function
1458      * - encoding: Set by user.
1459      * - decoding: unused
1460      */
1461     int me_cmp;
1462     /**
1463      * subpixel motion estimation comparison function
1464      * - encoding: Set by user.
1465      * - decoding: unused
1466      */
1467     int me_sub_cmp;
1468     /**
1469      * macroblock comparison function (not supported yet)
1470      * - encoding: Set by user.
1471      * - decoding: unused
1472      */
1473     int mb_cmp;
1474     /**
1475      * interlaced DCT comparison function
1476      * - encoding: Set by user.
1477      * - decoding: unused
1478      */
1479     int ildct_cmp;
1480 #define FF_CMP_SAD    0
1481 #define FF_CMP_SSE    1
1482 #define FF_CMP_SATD   2
1483 #define FF_CMP_DCT    3
1484 #define FF_CMP_PSNR   4
1485 #define FF_CMP_BIT    5
1486 #define FF_CMP_RD     6
1487 #define FF_CMP_ZERO   7
1488 #define FF_CMP_VSAD   8
1489 #define FF_CMP_VSSE   9
1490 #define FF_CMP_NSSE   10
1491 #define FF_CMP_DCTMAX 13
1492 #define FF_CMP_DCT264 14
1493 #define FF_CMP_CHROMA 256
1494
1495     /**
1496      * ME diamond size & shape
1497      * - encoding: Set by user.
1498      * - decoding: unused
1499      */
1500     int dia_size;
1501
1502     /**
1503      * amount of previous MV predictors (2a+1 x 2a+1 square)
1504      * - encoding: Set by user.
1505      * - decoding: unused
1506      */
1507     int last_predictor_count;
1508
1509     /**
1510      * prepass for motion estimation
1511      * - encoding: Set by user.
1512      * - decoding: unused
1513      */
1514     int pre_me;
1515
1516     /**
1517      * motion estimation prepass comparison function
1518      * - encoding: Set by user.
1519      * - decoding: unused
1520      */
1521     int me_pre_cmp;
1522
1523     /**
1524      * ME prepass diamond size & shape
1525      * - encoding: Set by user.
1526      * - decoding: unused
1527      */
1528     int pre_dia_size;
1529
1530     /**
1531      * subpel ME quality
1532      * - encoding: Set by user.
1533      * - decoding: unused
1534      */
1535     int me_subpel_quality;
1536
1537 #if FF_API_AFD
1538     /**
1539      * DTG active format information (additional aspect ratio
1540      * information only used in DVB MPEG-2 transport streams)
1541      * 0 if not set.
1542      *
1543      * - encoding: unused
1544      * - decoding: Set by decoder.
1545      * @deprecated Deprecated in favor of AVSideData
1546      */
1547     attribute_deprecated int dtg_active_format;
1548 #define FF_DTG_AFD_SAME         8
1549 #define FF_DTG_AFD_4_3          9
1550 #define FF_DTG_AFD_16_9         10
1551 #define FF_DTG_AFD_14_9         11
1552 #define FF_DTG_AFD_4_3_SP_14_9  13
1553 #define FF_DTG_AFD_16_9_SP_14_9 14
1554 #define FF_DTG_AFD_SP_4_3       15
1555 #endif /* FF_API_AFD */
1556
1557     /**
1558      * maximum motion estimation search range in subpel units
1559      * If 0 then no limit.
1560      *
1561      * - encoding: Set by user.
1562      * - decoding: unused
1563      */
1564     int me_range;
1565
1566 #if FF_API_QUANT_BIAS
1567     /**
1568      * @deprecated use encoder private option instead
1569      */
1570     attribute_deprecated int intra_quant_bias;
1571 #define FF_DEFAULT_QUANT_BIAS 999999
1572
1573     /**
1574      * @deprecated use encoder private option instead
1575      */
1576     attribute_deprecated int inter_quant_bias;
1577 #endif
1578
1579     /**
1580      * slice flags
1581      * - encoding: unused
1582      * - decoding: Set by user.
1583      */
1584     int slice_flags;
1585 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1586 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1587 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1588
1589 #if FF_API_XVMC
1590     /**
1591      * XVideo Motion Acceleration
1592      * - encoding: forbidden
1593      * - decoding: set by decoder
1594      * @deprecated XvMC support is slated for removal.
1595      */
1596     attribute_deprecated int xvmc_acceleration;
1597 #endif /* FF_API_XVMC */
1598
1599     /**
1600      * macroblock decision mode
1601      * - encoding: Set by user.
1602      * - decoding: unused
1603      */
1604     int mb_decision;
1605 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1606 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1607 #define FF_MB_DECISION_RD     2        ///< rate distortion
1608
1609     /**
1610      * custom intra quantization matrix
1611      * - encoding: Set by user, can be NULL.
1612      * - decoding: Set by libavcodec.
1613      */
1614     uint16_t *intra_matrix;
1615
1616     /**
1617      * custom inter quantization matrix
1618      * - encoding: Set by user, can be NULL.
1619      * - decoding: Set by libavcodec.
1620      */
1621     uint16_t *inter_matrix;
1622
1623     /**
1624      * scene change detection threshold
1625      * 0 is default, larger means fewer detected scene changes.
1626      * - encoding: Set by user.
1627      * - decoding: unused
1628      */
1629     int scenechange_threshold;
1630
1631     /**
1632      * noise reduction strength
1633      * - encoding: Set by user.
1634      * - decoding: unused
1635      */
1636     int noise_reduction;
1637
1638 #if FF_API_MPV_OPT
1639     /**
1640      * @deprecated this field is unused
1641      */
1642     attribute_deprecated
1643     int me_threshold;
1644
1645     /**
1646      * @deprecated this field is unused
1647      */
1648     attribute_deprecated
1649     int mb_threshold;
1650 #endif
1651
1652     /**
1653      * precision of the intra DC coefficient - 8
1654      * - encoding: Set by user.
1655      * - decoding: unused
1656      */
1657     int intra_dc_precision;
1658
1659     /**
1660      * Number of macroblock rows at the top which are skipped.
1661      * - encoding: unused
1662      * - decoding: Set by user.
1663      */
1664     int skip_top;
1665
1666     /**
1667      * Number of macroblock rows at the bottom which are skipped.
1668      * - encoding: unused
1669      * - decoding: Set by user.
1670      */
1671     int skip_bottom;
1672
1673 #if FF_API_MPV_OPT
1674     /**
1675      * @deprecated use encoder private options instead
1676      */
1677     attribute_deprecated
1678     float border_masking;
1679 #endif
1680
1681     /**
1682      * minimum MB lagrange multipler
1683      * - encoding: Set by user.
1684      * - decoding: unused
1685      */
1686     int mb_lmin;
1687
1688     /**
1689      * maximum MB lagrange multipler
1690      * - encoding: Set by user.
1691      * - decoding: unused
1692      */
1693     int mb_lmax;
1694
1695     /**
1696      *
1697      * - encoding: Set by user.
1698      * - decoding: unused
1699      */
1700     int me_penalty_compensation;
1701
1702     /**
1703      *
1704      * - encoding: Set by user.
1705      * - decoding: unused
1706      */
1707     int bidir_refine;
1708
1709     /**
1710      *
1711      * - encoding: Set by user.
1712      * - decoding: unused
1713      */
1714     int brd_scale;
1715
1716     /**
1717      * minimum GOP size
1718      * - encoding: Set by user.
1719      * - decoding: unused
1720      */
1721     int keyint_min;
1722
1723     /**
1724      * number of reference frames
1725      * - encoding: Set by user.
1726      * - decoding: Set by lavc.
1727      */
1728     int refs;
1729
1730     /**
1731      * chroma qp offset from luma
1732      * - encoding: Set by user.
1733      * - decoding: unused
1734      */
1735     int chromaoffset;
1736
1737 #if FF_API_UNUSED_MEMBERS
1738     /**
1739      * Multiplied by qscale for each frame and added to scene_change_score.
1740      * - encoding: Set by user.
1741      * - decoding: unused
1742      */
1743     attribute_deprecated int scenechange_factor;
1744 #endif
1745
1746     /**
1747      *
1748      * Note: Value depends upon the compare function used for fullpel ME.
1749      * - encoding: Set by user.
1750      * - decoding: unused
1751      */
1752     int mv0_threshold;
1753
1754     /**
1755      * Adjust sensitivity of b_frame_strategy 1.
1756      * - encoding: Set by user.
1757      * - decoding: unused
1758      */
1759     int b_sensitivity;
1760
1761     /**
1762      * Chromaticity coordinates of the source primaries.
1763      * - encoding: Set by user
1764      * - decoding: Set by libavcodec
1765      */
1766     enum AVColorPrimaries color_primaries;
1767
1768     /**
1769      * Color Transfer Characteristic.
1770      * - encoding: Set by user
1771      * - decoding: Set by libavcodec
1772      */
1773     enum AVColorTransferCharacteristic color_trc;
1774
1775     /**
1776      * YUV colorspace type.
1777      * - encoding: Set by user
1778      * - decoding: Set by libavcodec
1779      */
1780     enum AVColorSpace colorspace;
1781
1782     /**
1783      * MPEG vs JPEG YUV range.
1784      * - encoding: Set by user
1785      * - decoding: Set by libavcodec
1786      */
1787     enum AVColorRange color_range;
1788
1789     /**
1790      * This defines the location of chroma samples.
1791      * - encoding: Set by user
1792      * - decoding: Set by libavcodec
1793      */
1794     enum AVChromaLocation chroma_sample_location;
1795
1796     /**
1797      * Number of slices.
1798      * Indicates number of picture subdivisions. Used for parallelized
1799      * decoding.
1800      * - encoding: Set by user
1801      * - decoding: unused
1802      */
1803     int slices;
1804
1805     /** Field order
1806      * - encoding: set by libavcodec
1807      * - decoding: Set by libavcodec
1808      */
1809     enum AVFieldOrder field_order;
1810
1811     /* audio only */
1812     int sample_rate; ///< samples per second
1813     int channels;    ///< number of audio channels
1814
1815     /**
1816      * audio sample format
1817      * - encoding: Set by user.
1818      * - decoding: Set by libavcodec.
1819      */
1820     enum AVSampleFormat sample_fmt;  ///< sample format
1821
1822     /* The following data should not be initialized. */
1823     /**
1824      * Number of samples per channel in an audio frame.
1825      *
1826      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1827      *   except the last must contain exactly frame_size samples per channel.
1828      *   May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1829      *   frame size is not restricted.
1830      * - decoding: may be set by some decoders to indicate constant frame size
1831      */
1832     int frame_size;
1833
1834     /**
1835      * Frame counter, set by libavcodec.
1836      *
1837      * - decoding: total number of frames returned from the decoder so far.
1838      * - encoding: total number of frames passed to the encoder so far.
1839      *
1840      *   @note the counter is not incremented if encoding/decoding resulted in
1841      *   an error.
1842      */
1843     int frame_number;
1844
1845     /**
1846      * number of bytes per packet if constant and known or 0
1847      * Used by some WAV based audio codecs.
1848      */
1849     int block_align;
1850
1851     /**
1852      * Audio cutoff bandwidth (0 means "automatic")
1853      * - encoding: Set by user.
1854      * - decoding: unused
1855      */
1856     int cutoff;
1857
1858 #if FF_API_REQUEST_CHANNELS
1859     /**
1860      * Decoder should decode to this many channels if it can (0 for default)
1861      * - encoding: unused
1862      * - decoding: Set by user.
1863      * @deprecated Deprecated in favor of request_channel_layout.
1864      */
1865     attribute_deprecated int request_channels;
1866 #endif
1867
1868     /**
1869      * Audio channel layout.
1870      * - encoding: set by user.
1871      * - decoding: set by libavcodec.
1872      */
1873     uint64_t channel_layout;
1874
1875     /**
1876      * Request decoder to use this channel layout if it can (0 for default)
1877      * - encoding: unused
1878      * - decoding: Set by user.
1879      */
1880     uint64_t request_channel_layout;
1881
1882     /**
1883      * Type of service that the audio stream conveys.
1884      * - encoding: Set by user.
1885      * - decoding: Set by libavcodec.
1886      */
1887     enum AVAudioServiceType audio_service_type;
1888
1889     /**
1890      * Used to request a sample format from the decoder.
1891      * - encoding: unused.
1892      * - decoding: Set by user.
1893      */
1894     enum AVSampleFormat request_sample_fmt;
1895
1896 #if FF_API_GET_BUFFER
1897     /**
1898      * Called at the beginning of each frame to get a buffer for it.
1899      *
1900      * The function will set AVFrame.data[], AVFrame.linesize[].
1901      * AVFrame.extended_data[] must also be set, but it should be the same as
1902      * AVFrame.data[] except for planar audio with more channels than can fit
1903      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1904      * many data pointers as it can hold.
1905      *
1906      * if CODEC_CAP_DR1 is not set then get_buffer() must call
1907      * avcodec_default_get_buffer() instead of providing buffers allocated by
1908      * some other means.
1909      *
1910      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1911      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1912      * but if get_buffer() is overridden then alignment considerations should
1913      * be taken into account.
1914      *
1915      * @see avcodec_default_get_buffer()
1916      *
1917      * Video:
1918      *
1919      * If pic.reference is set then the frame will be read later by libavcodec.
1920      * avcodec_align_dimensions2() should be used to find the required width and
1921      * height, as they normally need to be rounded up to the next multiple of 16.
1922      *
1923      * If frame multithreading is used and thread_safe_callbacks is set,
1924      * it may be called from a different thread, but not from more than one at
1925      * once. Does not need to be reentrant.
1926      *
1927      * @see release_buffer(), reget_buffer()
1928      * @see avcodec_align_dimensions2()
1929      *
1930      * Audio:
1931      *
1932      * Decoders request a buffer of a particular size by setting
1933      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1934      * however, utilize only part of the buffer by setting AVFrame.nb_samples
1935      * to a smaller value in the output frame.
1936      *
1937      * Decoders cannot use the buffer after returning from
1938      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1939      * is assumed to be released immediately upon return. In some rare cases,
1940      * a decoder may need to call get_buffer() more than once in a single
1941      * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1942      * called again after it has already been called once, the previously
1943      * acquired buffer is assumed to be released at that time and may not be
1944      * reused by the decoder.
1945      *
1946      * As a convenience, av_samples_get_buffer_size() and
1947      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1948      * functions to find the required data size and to fill data pointers and
1949      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1950      * since all planes must be the same size.
1951      *
1952      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1953      *
1954      * - encoding: unused
1955      * - decoding: Set by libavcodec, user can override.
1956      *
1957      * @deprecated use get_buffer2()
1958      */
1959     attribute_deprecated
1960     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1961
1962     /**
1963      * Called to release buffers which were allocated with get_buffer.
1964      * A released buffer can be reused in get_buffer().
1965      * pic.data[*] must be set to NULL.
1966      * May be called from a different thread if frame multithreading is used,
1967      * but not by more than one thread at once, so does not need to be reentrant.
1968      * - encoding: unused
1969      * - decoding: Set by libavcodec, user can override.
1970      *
1971      * @deprecated custom freeing callbacks should be set from get_buffer2()
1972      */
1973     attribute_deprecated
1974     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1975
1976     /**
1977      * Called at the beginning of a frame to get cr buffer for it.
1978      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1979      * libavcodec will pass previous buffer in pic, function should return
1980      * same buffer or new buffer with old frame "painted" into it.
1981      * If pic.data[0] == NULL must behave like get_buffer().
1982      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1983      * avcodec_default_reget_buffer() instead of providing buffers allocated by
1984      * some other means.
1985      * - encoding: unused
1986      * - decoding: Set by libavcodec, user can override.
1987      */
1988     attribute_deprecated
1989     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1990 #endif
1991
1992     /**
1993      * This callback is called at the beginning of each frame to get data
1994      * buffer(s) for it. There may be one contiguous buffer for all the data or
1995      * there may be a buffer per each data plane or anything in between. What
1996      * this means is, you may set however many entries in buf[] you feel necessary.
1997      * Each buffer must be reference-counted using the AVBuffer API (see description
1998      * of buf[] below).
1999      *
2000      * The following fields will be set in the frame before this callback is
2001      * called:
2002      * - format
2003      * - width, height (video only)
2004      * - sample_rate, channel_layout, nb_samples (audio only)
2005      * Their values may differ from the corresponding values in
2006      * AVCodecContext. This callback must use the frame values, not the codec
2007      * context values, to calculate the required buffer size.
2008      *
2009      * This callback must fill the following fields in the frame:
2010      * - data[]
2011      * - linesize[]
2012      * - extended_data:
2013      *   * if the data is planar audio with more than 8 channels, then this
2014      *     callback must allocate and fill extended_data to contain all pointers
2015      *     to all data planes. data[] must hold as many pointers as it can.
2016      *     extended_data must be allocated with av_malloc() and will be freed in
2017      *     av_frame_unref().
2018      *   * otherwise exended_data must point to data
2019      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2020      *   the frame's data and extended_data pointers must be contained in these. That
2021      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2022      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2023      *   and av_buffer_ref().
2024      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2025      *   this callback and filled with the extra buffers if there are more
2026      *   buffers than buf[] can hold. extended_buf will be freed in
2027      *   av_frame_unref().
2028      *
2029      * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2030      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2031      * some other means.
2032      *
2033      * Each data plane must be aligned to the maximum required by the target
2034      * CPU.
2035      *
2036      * @see avcodec_default_get_buffer2()
2037      *
2038      * Video:
2039      *
2040      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2041      * (read and/or written to if it is writable) later by libavcodec.
2042      *
2043      * avcodec_align_dimensions2() should be used to find the required width and
2044      * height, as they normally need to be rounded up to the next multiple of 16.
2045      *
2046      * If frame multithreading is used and thread_safe_callbacks is set,
2047      * this callback may be called from a different thread, but not from more
2048      * than one at once. Does not need to be reentrant.
2049      *
2050      * @see avcodec_align_dimensions2()
2051      *
2052      * Audio:
2053      *
2054      * Decoders request a buffer of a particular size by setting
2055      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2056      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2057      * to a smaller value in the output frame.
2058      *
2059      * As a convenience, av_samples_get_buffer_size() and
2060      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2061      * functions to find the required data size and to fill data pointers and
2062      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2063      * since all planes must be the same size.
2064      *
2065      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2066      *
2067      * - encoding: unused
2068      * - decoding: Set by libavcodec, user can override.
2069      */
2070     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2071
2072     /**
2073      * If non-zero, the decoded audio and video frames returned from
2074      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2075      * and are valid indefinitely. The caller must free them with
2076      * av_frame_unref() when they are not needed anymore.
2077      * Otherwise, the decoded frames must not be freed by the caller and are
2078      * only valid until the next decode call.
2079      *
2080      * - encoding: unused
2081      * - decoding: set by the caller before avcodec_open2().
2082      */
2083     int refcounted_frames;
2084
2085     /* - encoding parameters */
2086     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2087     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2088
2089     /**
2090      * minimum quantizer
2091      * - encoding: Set by user.
2092      * - decoding: unused
2093      */
2094     int qmin;
2095
2096     /**
2097      * maximum quantizer
2098      * - encoding: Set by user.
2099      * - decoding: unused
2100      */
2101     int qmax;
2102
2103     /**
2104      * maximum quantizer difference between frames
2105      * - encoding: Set by user.
2106      * - decoding: unused
2107      */
2108     int max_qdiff;
2109
2110 #if FF_API_MPV_OPT
2111     /**
2112      * @deprecated use encoder private options instead
2113      */
2114     attribute_deprecated
2115     float rc_qsquish;
2116
2117     attribute_deprecated
2118     float rc_qmod_amp;
2119     attribute_deprecated
2120     int rc_qmod_freq;
2121 #endif
2122
2123     /**
2124      * decoder bitstream buffer size
2125      * - encoding: Set by user.
2126      * - decoding: unused
2127      */
2128     int rc_buffer_size;
2129
2130     /**
2131      * ratecontrol override, see RcOverride
2132      * - encoding: Allocated/set/freed by user.
2133      * - decoding: unused
2134      */
2135     int rc_override_count;
2136     RcOverride *rc_override;
2137
2138 #if FF_API_MPV_OPT
2139     /**
2140      * @deprecated use encoder private options instead
2141      */
2142     attribute_deprecated
2143     const char *rc_eq;
2144 #endif
2145
2146     /**
2147      * maximum bitrate
2148      * - encoding: Set by user.
2149      * - decoding: unused
2150      */
2151     int rc_max_rate;
2152
2153     /**
2154      * minimum bitrate
2155      * - encoding: Set by user.
2156      * - decoding: unused
2157      */
2158     int rc_min_rate;
2159
2160 #if FF_API_MPV_OPT
2161     /**
2162      * @deprecated use encoder private options instead
2163      */
2164     attribute_deprecated
2165     float rc_buffer_aggressivity;
2166
2167     attribute_deprecated
2168     float rc_initial_cplx;
2169 #endif
2170
2171     /**
2172      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2173      * - encoding: Set by user.
2174      * - decoding: unused.
2175      */
2176     float rc_max_available_vbv_use;
2177
2178     /**
2179      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2180      * - encoding: Set by user.
2181      * - decoding: unused.
2182      */
2183     float rc_min_vbv_overflow_use;
2184
2185     /**
2186      * Number of bits which should be loaded into the rc buffer before decoding starts.
2187      * - encoding: Set by user.
2188      * - decoding: unused
2189      */
2190     int rc_initial_buffer_occupancy;
2191
2192 #define FF_CODER_TYPE_VLC       0
2193 #define FF_CODER_TYPE_AC        1
2194 #define FF_CODER_TYPE_RAW       2
2195 #define FF_CODER_TYPE_RLE       3
2196 #if FF_API_UNUSED_MEMBERS
2197 #define FF_CODER_TYPE_DEFLATE   4
2198 #endif /* FF_API_UNUSED_MEMBERS */
2199     /**
2200      * coder type
2201      * - encoding: Set by user.
2202      * - decoding: unused
2203      */
2204     int coder_type;
2205
2206     /**
2207      * context model
2208      * - encoding: Set by user.
2209      * - decoding: unused
2210      */
2211     int context_model;
2212
2213 #if FF_API_MPV_OPT
2214     /**
2215      * @deprecated use encoder private options instead
2216      */
2217     attribute_deprecated
2218     int lmin;
2219
2220     /**
2221      * @deprecated use encoder private options instead
2222      */
2223     attribute_deprecated
2224     int lmax;
2225 #endif
2226
2227     /**
2228      * frame skip threshold
2229      * - encoding: Set by user.
2230      * - decoding: unused
2231      */
2232     int frame_skip_threshold;
2233
2234     /**
2235      * frame skip factor
2236      * - encoding: Set by user.
2237      * - decoding: unused
2238      */
2239     int frame_skip_factor;
2240
2241     /**
2242      * frame skip exponent
2243      * - encoding: Set by user.
2244      * - decoding: unused
2245      */
2246     int frame_skip_exp;
2247
2248     /**
2249      * frame skip comparison function
2250      * - encoding: Set by user.
2251      * - decoding: unused
2252      */
2253     int frame_skip_cmp;
2254
2255     /**
2256      * trellis RD quantization
2257      * - encoding: Set by user.
2258      * - decoding: unused
2259      */
2260     int trellis;
2261
2262     /**
2263      * - encoding: Set by user.
2264      * - decoding: unused
2265      */
2266     int min_prediction_order;
2267
2268     /**
2269      * - encoding: Set by user.
2270      * - decoding: unused
2271      */
2272     int max_prediction_order;
2273
2274     /**
2275      * GOP timecode frame start number, in non drop frame format
2276      * - encoding: Set by user.
2277      * - decoding: unused
2278      */
2279     int64_t timecode_frame_start;
2280
2281     /* The RTP callback: This function is called    */
2282     /* every time the encoder has a packet to send. */
2283     /* It depends on the encoder if the data starts */
2284     /* with a Start Code (it should). H.263 does.   */
2285     /* mb_nb contains the number of macroblocks     */
2286     /* encoded in the RTP payload.                  */
2287     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2288
2289     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2290                             /* do its best to deliver a chunk with size     */
2291                             /* below rtp_payload_size, the chunk will start */
2292                             /* with a start code on some codecs like H.263. */
2293                             /* This doesn't take account of any particular  */
2294                             /* headers inside the transmitted RTP payload.  */
2295
2296     /* statistics, used for 2-pass encoding */
2297     int mv_bits;
2298     int header_bits;
2299     int i_tex_bits;
2300     int p_tex_bits;
2301     int i_count;
2302     int p_count;
2303     int skip_count;
2304     int misc_bits;
2305
2306     /**
2307      * number of bits used for the previously encoded frame
2308      * - encoding: Set by libavcodec.
2309      * - decoding: unused
2310      */
2311     int frame_bits;
2312
2313     /**
2314      * pass1 encoding statistics output buffer
2315      * - encoding: Set by libavcodec.
2316      * - decoding: unused
2317      */
2318     char *stats_out;
2319
2320     /**
2321      * pass2 encoding statistics input buffer
2322      * Concatenated stuff from stats_out of pass1 should be placed here.
2323      * - encoding: Allocated/set/freed by user.
2324      * - decoding: unused
2325      */
2326     char *stats_in;
2327
2328     /**
2329      * Work around bugs in encoders which sometimes cannot be detected automatically.
2330      * - encoding: Set by user
2331      * - decoding: Set by user
2332      */
2333     int workaround_bugs;
2334 #define FF_BUG_AUTODETECT       1  ///< autodetection
2335 #if FF_API_OLD_MSMPEG4
2336 #define FF_BUG_OLD_MSMPEG4      2
2337 #endif
2338 #define FF_BUG_XVID_ILACE       4
2339 #define FF_BUG_UMP4             8
2340 #define FF_BUG_NO_PADDING       16
2341 #define FF_BUG_AMV              32
2342 #if FF_API_AC_VLC
2343 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2344 #endif
2345 #define FF_BUG_QPEL_CHROMA      64
2346 #define FF_BUG_STD_QPEL         128
2347 #define FF_BUG_QPEL_CHROMA2     256
2348 #define FF_BUG_DIRECT_BLOCKSIZE 512
2349 #define FF_BUG_EDGE             1024
2350 #define FF_BUG_HPEL_CHROMA      2048
2351 #define FF_BUG_DC_CLIP          4096
2352 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2353 #define FF_BUG_TRUNCATED       16384
2354
2355     /**
2356      * strictly follow the standard (MPEG4, ...).
2357      * - encoding: Set by user.
2358      * - decoding: Set by user.
2359      * Setting this to STRICT or higher means the encoder and decoder will
2360      * generally do stupid things, whereas setting it to unofficial or lower
2361      * will mean the encoder might produce output that is not supported by all
2362      * spec-compliant decoders. Decoders don't differentiate between normal,
2363      * unofficial and experimental (that is, they always try to decode things
2364      * when they can) unless they are explicitly asked to behave stupidly
2365      * (=strictly conform to the specs)
2366      */
2367     int strict_std_compliance;
2368 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2369 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2370 #define FF_COMPLIANCE_NORMAL        0
2371 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2372 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2373
2374     /**
2375      * error concealment flags
2376      * - encoding: unused
2377      * - decoding: Set by user.
2378      */
2379     int error_concealment;
2380 #define FF_EC_GUESS_MVS   1
2381 #define FF_EC_DEBLOCK     2
2382
2383     /**
2384      * debug
2385      * - encoding: Set by user.
2386      * - decoding: Set by user.
2387      */
2388     int debug;
2389 #define FF_DEBUG_PICT_INFO   1
2390 #define FF_DEBUG_RC          2
2391 #define FF_DEBUG_BITSTREAM   4
2392 #define FF_DEBUG_MB_TYPE     8
2393 #define FF_DEBUG_QP          16
2394 #if FF_API_DEBUG_MV
2395 /**
2396  * @deprecated this option does nothing
2397  */
2398 #define FF_DEBUG_MV          32
2399 #endif
2400 #define FF_DEBUG_DCT_COEFF   0x00000040
2401 #define FF_DEBUG_SKIP        0x00000080
2402 #define FF_DEBUG_STARTCODE   0x00000100
2403 #if FF_API_UNUSED_MEMBERS
2404 #define FF_DEBUG_PTS         0x00000200
2405 #endif /* FF_API_UNUSED_MEMBERS */
2406 #define FF_DEBUG_ER          0x00000400
2407 #define FF_DEBUG_MMCO        0x00000800
2408 #define FF_DEBUG_BUGS        0x00001000
2409 #if FF_API_DEBUG_MV
2410 #define FF_DEBUG_VIS_QP      0x00002000
2411 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2412 #endif
2413 #define FF_DEBUG_BUFFERS     0x00008000
2414 #define FF_DEBUG_THREADS     0x00010000
2415
2416 #if FF_API_DEBUG_MV
2417     /**
2418      * @deprecated this option does not have any effect
2419      */
2420     attribute_deprecated
2421     int debug_mv;
2422 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2423 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2424 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2425 #endif
2426
2427     /**
2428      * Error recognition; may misdetect some more or less valid parts as errors.
2429      * - encoding: unused
2430      * - decoding: Set by user.
2431      */
2432     int err_recognition;
2433
2434 /**
2435  * Verify checksums embedded in the bitstream (could be of either encoded or
2436  * decoded data, depending on the codec) and print an error message on mismatch.
2437  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2438  * decoder returning an error.
2439  */
2440 #define AV_EF_CRCCHECK  (1<<0)
2441 #define AV_EF_BITSTREAM (1<<1)
2442 #define AV_EF_BUFFER    (1<<2)
2443 #define AV_EF_EXPLODE   (1<<3)
2444
2445     /**
2446      * opaque 64bit number (generally a PTS) that will be reordered and
2447      * output in AVFrame.reordered_opaque
2448      * - encoding: unused
2449      * - decoding: Set by user.
2450      */
2451     int64_t reordered_opaque;
2452
2453     /**
2454      * Hardware accelerator in use
2455      * - encoding: unused.
2456      * - decoding: Set by libavcodec
2457      */
2458     struct AVHWAccel *hwaccel;
2459
2460     /**
2461      * Hardware accelerator context.
2462      * For some hardware accelerators, a global context needs to be
2463      * provided by the user. In that case, this holds display-dependent
2464      * data Libav cannot instantiate itself. Please refer to the
2465      * Libav HW accelerator documentation to know how to fill this
2466      * is. e.g. for VA API, this is a struct vaapi_context.
2467      * - encoding: unused
2468      * - decoding: Set by user
2469      */
2470     void *hwaccel_context;
2471
2472     /**
2473      * error
2474      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2475      * - decoding: unused
2476      */
2477     uint64_t error[AV_NUM_DATA_POINTERS];
2478
2479     /**
2480      * DCT algorithm, see FF_DCT_* below
2481      * - encoding: Set by user.
2482      * - decoding: unused
2483      */
2484     int dct_algo;
2485 #define FF_DCT_AUTO    0
2486 #define FF_DCT_FASTINT 1
2487 #if FF_API_UNUSED_MEMBERS
2488 #define FF_DCT_INT     2
2489 #endif /* FF_API_UNUSED_MEMBERS */
2490 #define FF_DCT_MMX     3
2491 #define FF_DCT_ALTIVEC 5
2492 #define FF_DCT_FAAN    6
2493
2494     /**
2495      * IDCT algorithm, see FF_IDCT_* below.
2496      * - encoding: Set by user.
2497      * - decoding: Set by user.
2498      */
2499     int idct_algo;
2500 #define FF_IDCT_AUTO          0
2501 #define FF_IDCT_INT           1
2502 #define FF_IDCT_SIMPLE        2
2503 #define FF_IDCT_SIMPLEMMX     3
2504 #define FF_IDCT_ARM           7
2505 #define FF_IDCT_ALTIVEC       8
2506 #if FF_API_ARCH_SH4
2507 #define FF_IDCT_SH4           9
2508 #endif
2509 #define FF_IDCT_SIMPLEARM     10
2510 #if FF_API_UNUSED_MEMBERS
2511 #define FF_IDCT_IPP           13
2512 #endif /* FF_API_UNUSED_MEMBERS */
2513 #define FF_IDCT_XVID          14
2514 #if FF_API_IDCT_XVIDMMX
2515 #define FF_IDCT_XVIDMMX       14
2516 #endif /* FF_API_IDCT_XVIDMMX */
2517 #define FF_IDCT_SIMPLEARMV5TE 16
2518 #define FF_IDCT_SIMPLEARMV6   17
2519 #if FF_API_ARCH_SPARC
2520 #define FF_IDCT_SIMPLEVIS     18
2521 #endif
2522 #define FF_IDCT_FAAN          20
2523 #define FF_IDCT_SIMPLENEON    22
2524 #if FF_API_ARCH_ALPHA
2525 #define FF_IDCT_SIMPLEALPHA   23
2526 #endif
2527
2528     /**
2529      * bits per sample/pixel from the demuxer (needed for huffyuv).
2530      * - encoding: Set by libavcodec.
2531      * - decoding: Set by user.
2532      */
2533      int bits_per_coded_sample;
2534
2535     /**
2536      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2537      * - encoding: set by user.
2538      * - decoding: set by libavcodec.
2539      */
2540     int bits_per_raw_sample;
2541
2542 #if FF_API_LOWRES
2543     /**
2544      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2545      * - encoding: unused
2546      * - decoding: Set by user.
2547      *
2548      * @deprecated use decoder private options instead
2549      */
2550     attribute_deprecated int lowres;
2551 #endif
2552
2553     /**
2554      * the picture in the bitstream
2555      * - encoding: Set by libavcodec.
2556      * - decoding: unused
2557      */
2558     AVFrame *coded_frame;
2559
2560     /**
2561      * thread count
2562      * is used to decide how many independent tasks should be passed to execute()
2563      * - encoding: Set by user.
2564      * - decoding: Set by user.
2565      */
2566     int thread_count;
2567
2568     /**
2569      * Which multithreading methods to use.
2570      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2571      * so clients which cannot provide future frames should not use it.
2572      *
2573      * - encoding: Set by user, otherwise the default is used.
2574      * - decoding: Set by user, otherwise the default is used.
2575      */
2576     int thread_type;
2577 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2578 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2579
2580     /**
2581      * Which multithreading methods are in use by the codec.
2582      * - encoding: Set by libavcodec.
2583      * - decoding: Set by libavcodec.
2584      */
2585     int active_thread_type;
2586
2587     /**
2588      * Set by the client if its custom get_buffer() callback can be called
2589      * synchronously from another thread, which allows faster multithreaded decoding.
2590      * draw_horiz_band() will be called from other threads regardless of this setting.
2591      * Ignored if the default get_buffer() is used.
2592      * - encoding: Set by user.
2593      * - decoding: Set by user.
2594      */
2595     int thread_safe_callbacks;
2596
2597     /**
2598      * The codec may call this to execute several independent things.
2599      * It will return only after finishing all tasks.
2600      * The user may replace this with some multithreaded implementation,
2601      * the default implementation will execute the parts serially.
2602      * @param count the number of things to execute
2603      * - encoding: Set by libavcodec, user can override.
2604      * - decoding: Set by libavcodec, user can override.
2605      */
2606     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2607
2608     /**
2609      * The codec may call this to execute several independent things.
2610      * It will return only after finishing all tasks.
2611      * The user may replace this with some multithreaded implementation,
2612      * the default implementation will execute the parts serially.
2613      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2614      * @param c context passed also to func
2615      * @param count the number of things to execute
2616      * @param arg2 argument passed unchanged to func
2617      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2618      * @param func function that will be called count times, with jobnr from 0 to count-1.
2619      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2620      *             two instances of func executing at the same time will have the same threadnr.
2621      * @return always 0 currently, but code should handle a future improvement where when any call to func
2622      *         returns < 0 no further calls to func may be done and < 0 is returned.
2623      * - encoding: Set by libavcodec, user can override.
2624      * - decoding: Set by libavcodec, user can override.
2625      */
2626     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2627
2628 #if FF_API_THREAD_OPAQUE
2629     /**
2630      * @deprecated this field should not be used from outside of lavc
2631      */
2632     attribute_deprecated
2633     void *thread_opaque;
2634 #endif
2635
2636     /**
2637      * noise vs. sse weight for the nsse comparsion function
2638      * - encoding: Set by user.
2639      * - decoding: unused
2640      */
2641      int nsse_weight;
2642
2643     /**
2644      * profile
2645      * - encoding: Set by user.
2646      * - decoding: Set by libavcodec.
2647      */
2648      int profile;
2649 #define FF_PROFILE_UNKNOWN -99
2650 #define FF_PROFILE_RESERVED -100
2651
2652 #define FF_PROFILE_AAC_MAIN 0
2653 #define FF_PROFILE_AAC_LOW  1
2654 #define FF_PROFILE_AAC_SSR  2
2655 #define FF_PROFILE_AAC_LTP  3
2656 #define FF_PROFILE_AAC_HE   4
2657 #define FF_PROFILE_AAC_HE_V2 28
2658 #define FF_PROFILE_AAC_LD   22
2659 #define FF_PROFILE_AAC_ELD  38
2660 #define FF_PROFILE_MPEG2_AAC_LOW 128
2661 #define FF_PROFILE_MPEG2_AAC_HE  131
2662
2663 #define FF_PROFILE_DTS         20
2664 #define FF_PROFILE_DTS_ES      30
2665 #define FF_PROFILE_DTS_96_24   40
2666 #define FF_PROFILE_DTS_HD_HRA  50
2667 #define FF_PROFILE_DTS_HD_MA   60
2668 #define FF_PROFILE_DTS_EXPRESS 70
2669
2670 #define FF_PROFILE_MPEG2_422    0
2671 #define FF_PROFILE_MPEG2_HIGH   1
2672 #define FF_PROFILE_MPEG2_SS     2
2673 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2674 #define FF_PROFILE_MPEG2_MAIN   4
2675 #define FF_PROFILE_MPEG2_SIMPLE 5
2676
2677 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2678 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2679
2680 #define FF_PROFILE_H264_BASELINE             66
2681 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2682 #define FF_PROFILE_H264_MAIN                 77
2683 #define FF_PROFILE_H264_EXTENDED             88
2684 #define FF_PROFILE_H264_HIGH                 100
2685 #define FF_PROFILE_H264_HIGH_10              110
2686 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2687 #define FF_PROFILE_H264_HIGH_422             122
2688 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2689 #define FF_PROFILE_H264_HIGH_444             144
2690 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2691 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2692 #define FF_PROFILE_H264_CAVLC_444            44
2693
2694 #define FF_PROFILE_VC1_SIMPLE   0
2695 #define FF_PROFILE_VC1_MAIN     1
2696 #define FF_PROFILE_VC1_COMPLEX  2
2697 #define FF_PROFILE_VC1_ADVANCED 3
2698
2699 #define FF_PROFILE_MPEG4_SIMPLE                     0
2700 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2701 #define FF_PROFILE_MPEG4_CORE                       2
2702 #define FF_PROFILE_MPEG4_MAIN                       3
2703 #define FF_PROFILE_MPEG4_N_BIT                      4
2704 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2705 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2706 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2707 #define FF_PROFILE_MPEG4_HYBRID                     8
2708 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2709 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2710 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2711 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2712 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2713 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2714 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2715
2716 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   0
2717 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   1
2718 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  2
2719 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2720 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2721
2722 #define FF_PROFILE_VP9_0                            0
2723 #define FF_PROFILE_VP9_1                            1
2724 #define FF_PROFILE_VP9_2                            2
2725 #define FF_PROFILE_VP9_3                            3
2726
2727 #define FF_PROFILE_HEVC_MAIN                        1
2728 #define FF_PROFILE_HEVC_MAIN_10                     2
2729 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2730
2731     /**
2732      * level
2733      * - encoding: Set by user.
2734      * - decoding: Set by libavcodec.
2735      */
2736      int level;
2737 #define FF_LEVEL_UNKNOWN -99
2738
2739     /**
2740      *
2741      * - encoding: unused
2742      * - decoding: Set by user.
2743      */
2744     enum AVDiscard skip_loop_filter;
2745
2746     /**
2747      *
2748      * - encoding: unused
2749      * - decoding: Set by user.
2750      */
2751     enum AVDiscard skip_idct;
2752
2753     /**
2754      *
2755      * - encoding: unused
2756      * - decoding: Set by user.
2757      */
2758     enum AVDiscard skip_frame;
2759
2760     /**
2761      * Header containing style information for text subtitles.
2762      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2763      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2764      * the Format line following. It shouldn't include any Dialogue line.
2765      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2766      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2767      */
2768     uint8_t *subtitle_header;
2769     int subtitle_header_size;
2770
2771 #if FF_API_ERROR_RATE
2772     /**
2773      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2774      * encoders
2775      */
2776     attribute_deprecated
2777     int error_rate;
2778 #endif
2779
2780 #if FF_API_CODEC_PKT
2781     /**
2782      * @deprecated this field is not supposed to be accessed from outside lavc
2783      */
2784     attribute_deprecated
2785     AVPacket *pkt;
2786 #endif
2787
2788     /**
2789      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2790      * Used for compliant TS muxing.
2791      * - encoding: Set by libavcodec.
2792      * - decoding: unused.
2793      */
2794     uint64_t vbv_delay;
2795
2796     /**
2797      * Encoding only. Allow encoders to output packets that do not contain any
2798      * encoded data, only side data.
2799      *
2800      * Some encoders need to output such packets, e.g. to update some stream
2801      * parameters at the end of encoding.
2802      *
2803      * All callers are strongly recommended to set this option to 1 and update
2804      * their code to deal with such packets, since this behaviour may become
2805      * always enabled in the future (then this option will be deprecated and
2806      * later removed). To avoid ABI issues when this happens, the callers should
2807      * use AVOptions to set this field.
2808      */
2809     int side_data_only_packets;
2810
2811     /**
2812      * Audio only. The number of "priming" samples (padding) inserted by the
2813      * encoder at the beginning of the audio. I.e. this number of leading
2814      * decoded samples must be discarded by the caller to get the original audio
2815      * without leading padding.
2816      *
2817      * - decoding: unused
2818      * - encoding: Set by libavcodec. The timestamps on the output packets are
2819      *             adjusted by the encoder so that they always refer to the
2820      *             first sample of the data actually contained in the packet,
2821      *             including any added padding.  E.g. if the timebase is
2822      *             1/samplerate and the timestamp of the first input sample is
2823      *             0, the timestamp of the first output packet will be
2824      *             -initial_padding.
2825      */
2826     int initial_padding;
2827
2828     /*
2829      * - decoding: For codecs that store a framerate value in the compressed
2830      *             bitstream, the decoder may export it here. { 0, 1} when
2831      *             unknown.
2832      * - encoding: unused
2833      */
2834     AVRational framerate;
2835
2836     /**
2837      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2838      * - encoding: unused.
2839      * - decoding: Set by libavcodec before calling get_format()
2840      */
2841     enum AVPixelFormat sw_pix_fmt;
2842 } AVCodecContext;
2843
2844 /**
2845  * AVProfile.
2846  */
2847 typedef struct AVProfile {
2848     int profile;
2849     const char *name; ///< short name for the profile
2850 } AVProfile;
2851
2852 typedef struct AVCodecDefault AVCodecDefault;
2853
2854 struct AVSubtitle;
2855
2856 /**
2857  * AVCodec.
2858  */
2859 typedef struct AVCodec {
2860     /**
2861      * Name of the codec implementation.
2862      * The name is globally unique among encoders and among decoders (but an
2863      * encoder and a decoder can share the same name).
2864      * This is the primary way to find a codec from the user perspective.
2865      */
2866     const char *name;
2867     /**
2868      * Descriptive name for the codec, meant to be more human readable than name.
2869      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2870      */
2871     const char *long_name;
2872     enum AVMediaType type;
2873     enum AVCodecID id;
2874     /**
2875      * Codec capabilities.
2876      * see CODEC_CAP_*
2877      */
2878     int capabilities;
2879     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2880     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2881     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2882     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2883     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2884 #if FF_API_LOWRES
2885     attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2886 #endif
2887     const AVClass *priv_class;              ///< AVClass for the private context
2888     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2889
2890     /*****************************************************************
2891      * No fields below this line are part of the public API. They
2892      * may not be used outside of libavcodec and can be changed and
2893      * removed at will.
2894      * New public fields should be added right above.
2895      *****************************************************************
2896      */
2897     int priv_data_size;
2898     struct AVCodec *next;
2899     /**
2900      * @name Frame-level threading support functions
2901      * @{
2902      */
2903     /**
2904      * If defined, called on thread contexts when they are created.
2905      * If the codec allocates writable tables in init(), re-allocate them here.
2906      * priv_data will be set to a copy of the original.
2907      */
2908     int (*init_thread_copy)(AVCodecContext *);
2909     /**
2910      * Copy necessary context variables from a previous thread context to the current one.
2911      * If not defined, the next thread will start automatically; otherwise, the codec
2912      * must call ff_thread_finish_setup().
2913      *
2914      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2915      */
2916     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2917     /** @} */
2918
2919     /**
2920      * Private codec-specific defaults.
2921      */
2922     const AVCodecDefault *defaults;
2923
2924     /**
2925      * Initialize codec static data, called from avcodec_register().
2926      */
2927     void (*init_static_data)(struct AVCodec *codec);
2928
2929     int (*init)(AVCodecContext *);
2930     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2931                       const struct AVSubtitle *sub);
2932     /**
2933      * Encode data to an AVPacket.
2934      *
2935      * @param      avctx          codec context
2936      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2937      * @param[in]  frame          AVFrame containing the raw data to be encoded
2938      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2939      *                            non-empty packet was returned in avpkt.
2940      * @return 0 on success, negative error code on failure
2941      */
2942     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2943                    int *got_packet_ptr);
2944     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2945     int (*close)(AVCodecContext *);
2946     /**
2947      * Flush buffers.
2948      * Will be called when seeking
2949      */
2950     void (*flush)(AVCodecContext *);
2951     /**
2952      * Internal codec capabilities.
2953      * See FF_CODEC_CAP_* in internal.h
2954      */
2955     int caps_internal;
2956 } AVCodec;
2957
2958 /**
2959  * @defgroup lavc_hwaccel AVHWAccel
2960  * @{
2961  */
2962 typedef struct AVHWAccel {
2963     /**
2964      * Name of the hardware accelerated codec.
2965      * The name is globally unique among encoders and among decoders (but an
2966      * encoder and a decoder can share the same name).
2967      */
2968     const char *name;
2969
2970     /**
2971      * Type of codec implemented by the hardware accelerator.
2972      *
2973      * See AVMEDIA_TYPE_xxx
2974      */
2975     enum AVMediaType type;
2976
2977     /**
2978      * Codec implemented by the hardware accelerator.
2979      *
2980      * See AV_CODEC_ID_xxx
2981      */
2982     enum AVCodecID id;
2983
2984     /**
2985      * Supported pixel format.
2986      *
2987      * Only hardware accelerated formats are supported here.
2988      */
2989     enum AVPixelFormat pix_fmt;
2990
2991     /**
2992      * Hardware accelerated codec capabilities.
2993      * see FF_HWACCEL_CODEC_CAP_*
2994      */
2995     int capabilities;
2996
2997     /*****************************************************************
2998      * No fields below this line are part of the public API. They
2999      * may not be used outside of libavcodec and can be changed and
3000      * removed at will.
3001      * New public fields should be added right above.
3002      *****************************************************************
3003      */
3004     struct AVHWAccel *next;
3005
3006     /**
3007      * Allocate a custom buffer
3008      */
3009     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3010
3011     /**
3012      * Called at the beginning of each frame or field picture.
3013      *
3014      * Meaningful frame information (codec specific) is guaranteed to
3015      * be parsed at this point. This function is mandatory.
3016      *
3017      * Note that buf can be NULL along with buf_size set to 0.
3018      * Otherwise, this means the whole frame is available at this point.
3019      *
3020      * @param avctx the codec context
3021      * @param buf the frame data buffer base
3022      * @param buf_size the size of the frame in bytes
3023      * @return zero if successful, a negative value otherwise
3024      */
3025     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3026
3027     /**
3028      * Callback for each slice.
3029      *
3030      * Meaningful slice information (codec specific) is guaranteed to
3031      * be parsed at this point. This function is mandatory.
3032      *
3033      * @param avctx the codec context
3034      * @param buf the slice data buffer base
3035      * @param buf_size the size of the slice in bytes
3036      * @return zero if successful, a negative value otherwise
3037      */
3038     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3039
3040     /**
3041      * Called at the end of each frame or field picture.
3042      *
3043      * The whole picture is parsed at this point and can now be sent
3044      * to the hardware accelerator. This function is mandatory.
3045      *
3046      * @param avctx the codec context
3047      * @return zero if successful, a negative value otherwise
3048      */
3049     int (*end_frame)(AVCodecContext *avctx);
3050
3051     /**
3052      * Size of per-frame hardware accelerator private data.
3053      *
3054      * Private data is allocated with av_mallocz() before
3055      * AVCodecContext.get_buffer() and deallocated after
3056      * AVCodecContext.release_buffer().
3057      */
3058     int frame_priv_data_size;
3059
3060     /**
3061      * Initialize the hwaccel private data.
3062      *
3063      * This will be called from ff_get_format(), after hwaccel and
3064      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3065      * is allocated.
3066      */
3067     int (*init)(AVCodecContext *avctx);
3068
3069     /**
3070      * Uninitialize the hwaccel private data.
3071      *
3072      * This will be called from get_format() or avcodec_close(), after hwaccel
3073      * and hwaccel_context are already uninitialized.
3074      */
3075     int (*uninit)(AVCodecContext *avctx);
3076
3077     /**
3078      * Size of the private data to allocate in
3079      * AVCodecInternal.hwaccel_priv_data.
3080      */
3081     int priv_data_size;
3082 } AVHWAccel;
3083
3084 /**
3085  * Hardware acceleration should be used for decoding even if the codec level
3086  * used is unknown or higher than the maximum supported level reported by the
3087  * hardware driver.
3088  */
3089 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3090
3091 /**
3092  * Hardware acceleration can output YUV pixel formats with a different chroma
3093  * sampling than 4:2:0 and/or other than 8 bits per component.
3094  */
3095 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3096
3097 /**
3098  * @}
3099  */
3100
3101 /**
3102  * @defgroup lavc_picture AVPicture
3103  *
3104  * Functions for working with AVPicture
3105  * @{
3106  */
3107
3108 /**
3109  * four components are given, that's all.
3110  * the last component is alpha
3111  */
3112 typedef struct AVPicture {
3113     uint8_t *data[AV_NUM_DATA_POINTERS];
3114     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3115 } AVPicture;
3116
3117 /**
3118  * @}
3119  */
3120
3121 #define AVPALETTE_SIZE 1024
3122 #define AVPALETTE_COUNT 256
3123
3124 enum AVSubtitleType {
3125     SUBTITLE_NONE,
3126
3127     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3128
3129     /**
3130      * Plain text, the text field must be set by the decoder and is
3131      * authoritative. ass and pict fields may contain approximations.
3132      */
3133     SUBTITLE_TEXT,
3134
3135     /**
3136      * Formatted text, the ass field must be set by the decoder and is
3137      * authoritative. pict and text fields may contain approximations.
3138      */
3139     SUBTITLE_ASS,
3140 };
3141
3142 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3143
3144 typedef struct AVSubtitleRect {
3145     int x;         ///< top left corner  of pict, undefined when pict is not set
3146     int y;         ///< top left corner  of pict, undefined when pict is not set
3147     int w;         ///< width            of pict, undefined when pict is not set
3148     int h;         ///< height           of pict, undefined when pict is not set
3149     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3150
3151     /**
3152      * data+linesize for the bitmap of this subtitle.
3153      * can be set for text/ass as well once they where rendered
3154      */
3155     AVPicture pict;
3156     enum AVSubtitleType type;
3157
3158     char *text;                     ///< 0 terminated plain UTF-8 text
3159
3160     /**
3161      * 0 terminated ASS/SSA compatible event line.
3162      * The pressentation of this is unaffected by the other values in this
3163      * struct.
3164      */
3165     char *ass;
3166     int flags;
3167 } AVSubtitleRect;
3168
3169 typedef struct AVSubtitle {
3170     uint16_t format; /* 0 = graphics */
3171     uint32_t start_display_time; /* relative to packet pts, in ms */
3172     uint32_t end_display_time; /* relative to packet pts, in ms */
3173     unsigned num_rects;
3174     AVSubtitleRect **rects;
3175     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3176 } AVSubtitle;
3177
3178 /**
3179  * If c is NULL, returns the first registered codec,
3180  * if c is non-NULL, returns the next registered codec after c,
3181  * or NULL if c is the last one.
3182  */
3183 AVCodec *av_codec_next(const AVCodec *c);
3184
3185 /**
3186  * Return the LIBAVCODEC_VERSION_INT constant.
3187  */
3188 unsigned avcodec_version(void);
3189
3190 /**
3191  * Return the libavcodec build-time configuration.
3192  */
3193 const char *avcodec_configuration(void);
3194
3195 /**
3196  * Return the libavcodec license.
3197  */
3198 const char *avcodec_license(void);
3199
3200 /**
3201  * Register the codec codec and initialize libavcodec.
3202  *
3203  * @warning either this function or avcodec_register_all() must be called
3204  * before any other libavcodec functions.
3205  *
3206  * @see avcodec_register_all()
3207  */
3208 void avcodec_register(AVCodec *codec);
3209
3210 /**
3211  * Register all the codecs, parsers and bitstream filters which were enabled at
3212  * configuration time. If you do not call this function you can select exactly
3213  * which formats you want to support, by using the individual registration
3214  * functions.
3215  *
3216  * @see avcodec_register
3217  * @see av_register_codec_parser
3218  * @see av_register_bitstream_filter
3219  */
3220 void avcodec_register_all(void);
3221
3222 /**
3223  * Allocate an AVCodecContext and set its fields to default values. The
3224  * resulting struct should be freed with avcodec_free_context().
3225  *
3226  * @param codec if non-NULL, allocate private data and initialize defaults
3227  *              for the given codec. It is illegal to then call avcodec_open2()
3228  *              with a different codec.
3229  *              If NULL, then the codec-specific defaults won't be initialized,
3230  *              which may result in suboptimal default settings (this is
3231  *              important mainly for encoders, e.g. libx264).
3232  *
3233  * @return An AVCodecContext filled with default values or NULL on failure.
3234  * @see avcodec_get_context_defaults
3235  */
3236 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3237
3238 /**
3239  * Free the codec context and everything associated with it and write NULL to
3240  * the provided pointer.
3241  */
3242 void avcodec_free_context(AVCodecContext **avctx);
3243
3244 /**
3245  * Set the fields of the given AVCodecContext to default values corresponding
3246  * to the given codec (defaults may be codec-dependent).
3247  *
3248  * Do not call this function if a non-NULL codec has been passed
3249  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3250  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3251  * different codec on this AVCodecContext.
3252  */
3253 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3254
3255 /**
3256  * Get the AVClass for AVCodecContext. It can be used in combination with
3257  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3258  *
3259  * @see av_opt_find().
3260  */
3261 const AVClass *avcodec_get_class(void);
3262
3263 /**
3264  * Copy the settings of the source AVCodecContext into the destination
3265  * AVCodecContext. The resulting destination codec context will be
3266  * unopened, i.e. you are required to call avcodec_open2() before you
3267  * can use this AVCodecContext to decode/encode video/audio data.
3268  *
3269  * @param dest target codec context, should be initialized with
3270  *             avcodec_alloc_context3(), but otherwise uninitialized
3271  * @param src source codec context
3272  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3273  */
3274 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3275
3276 #if FF_API_AVFRAME_LAVC
3277 /**
3278  * @deprecated use av_frame_alloc()
3279  */
3280 attribute_deprecated
3281 AVFrame *avcodec_alloc_frame(void);
3282
3283 /**
3284  * Set the fields of the given AVFrame to default values.
3285  *
3286  * @param frame The AVFrame of which the fields should be set to default values.
3287  *
3288  * @deprecated use av_frame_unref()
3289  */
3290 attribute_deprecated
3291 void avcodec_get_frame_defaults(AVFrame *frame);
3292
3293 /**
3294  * Free the frame and any dynamically allocated objects in it,
3295  * e.g. extended_data.
3296  *
3297  * @param frame frame to be freed. The pointer will be set to NULL.
3298  *
3299  * @warning this function does NOT free the data buffers themselves
3300  * (it does not know how, since they might have been allocated with
3301  *  a custom get_buffer()).
3302  *
3303  * @deprecated use av_frame_free()
3304  */
3305 attribute_deprecated
3306 void avcodec_free_frame(AVFrame **frame);
3307 #endif
3308
3309 /**
3310  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3311  * function the context has to be allocated with avcodec_alloc_context3().
3312  *
3313  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3314  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3315  * retrieving a codec.
3316  *
3317  * @warning This function is not thread safe!
3318  *
3319  * @note Always call this function before using decoding routines (such as
3320  * @ref avcodec_decode_video2()).
3321  *
3322  * @code
3323  * avcodec_register_all();
3324  * av_dict_set(&opts, "b", "2.5M", 0);
3325  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3326  * if (!codec)
3327  *     exit(1);
3328  *
3329  * context = avcodec_alloc_context3(codec);
3330  *
3331  * if (avcodec_open2(context, codec, opts) < 0)
3332  *     exit(1);
3333  * @endcode
3334  *
3335  * @param avctx The context to initialize.
3336  * @param codec The codec to open this context for. If a non-NULL codec has been
3337  *              previously passed to avcodec_alloc_context3() or
3338  *              avcodec_get_context_defaults3() for this context, then this
3339  *              parameter MUST be either NULL or equal to the previously passed
3340  *              codec.
3341  * @param options A dictionary filled with AVCodecContext and codec-private options.
3342  *                On return this object will be filled with options that were not found.
3343  *
3344  * @return zero on success, a negative value on error
3345  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3346  *      av_dict_set(), av_opt_find().
3347  */
3348 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3349
3350 /**
3351  * Close a given AVCodecContext and free all the data associated with it
3352  * (but not the AVCodecContext itself).
3353  *
3354  * Calling this function on an AVCodecContext that hasn't been opened will free
3355  * the codec-specific data allocated in avcodec_alloc_context3() /
3356  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3357  * do nothing.
3358  */
3359 int avcodec_close(AVCodecContext *avctx);
3360
3361 /**
3362  * Free all allocated data in the given subtitle struct.
3363  *
3364  * @param sub AVSubtitle to free.
3365  */
3366 void avsubtitle_free(AVSubtitle *sub);
3367
3368 /**
3369  * @}
3370  */
3371
3372 /**
3373  * @addtogroup lavc_packet
3374  * @{
3375  */
3376
3377 #if FF_API_DESTRUCT_PACKET
3378 /**
3379  * Default packet destructor.
3380  * @deprecated use the AVBuffer API instead
3381  */
3382 attribute_deprecated
3383 void av_destruct_packet(AVPacket *pkt);
3384 #endif
3385
3386 /**
3387  * Initialize optional fields of a packet with default values.
3388  *
3389  * Note, this does not touch the data and size members, which have to be
3390  * initialized separately.
3391  *
3392  * @param pkt packet
3393  */
3394 void av_init_packet(AVPacket *pkt);
3395
3396 /**
3397  * Allocate the payload of a packet and initialize its fields with
3398  * default values.
3399  *
3400  * @param pkt packet
3401  * @param size wanted payload size
3402  * @return 0 if OK, AVERROR_xxx otherwise
3403  */
3404 int av_new_packet(AVPacket *pkt, int size);
3405
3406 /**
3407  * Reduce packet size, correctly zeroing padding
3408  *
3409  * @param pkt packet
3410  * @param size new size
3411  */
3412 void av_shrink_packet(AVPacket *pkt, int size);
3413
3414 /**
3415  * Increase packet size, correctly zeroing padding
3416  *
3417  * @param pkt packet
3418  * @param grow_by number of bytes by which to increase the size of the packet
3419  */
3420 int av_grow_packet(AVPacket *pkt, int grow_by);
3421
3422 /**
3423  * Initialize a reference-counted packet from av_malloc()ed data.
3424  *
3425  * @param pkt packet to be initialized. This function will set the data, size,
3426  *        buf and destruct fields, all others are left untouched.
3427  * @param data Data allocated by av_malloc() to be used as packet data. If this
3428  *        function returns successfully, the data is owned by the underlying AVBuffer.
3429  *        The caller may not access the data through other means.
3430  * @param size size of data in bytes, without the padding. I.e. the full buffer
3431  *        size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3432  *
3433  * @return 0 on success, a negative AVERROR on error
3434  */
3435 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3436
3437 /**
3438  * @warning This is a hack - the packet memory allocation stuff is broken. The
3439  * packet is allocated if it was not really allocated.
3440  */
3441 int av_dup_packet(AVPacket *pkt);
3442
3443 /**
3444  * Free a packet.
3445  *
3446  * @param pkt packet to free
3447  */
3448 void av_free_packet(AVPacket *pkt);
3449
3450 /**
3451  * Allocate new information of a packet.
3452  *
3453  * @param pkt packet
3454  * @param type side information type
3455  * @param size side information size
3456  * @return pointer to fresh allocated data or NULL otherwise
3457  */
3458 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3459                                  int size);
3460
3461 /**
3462  * Shrink the already allocated side data buffer
3463  *
3464  * @param pkt packet
3465  * @param type side information type
3466  * @param size new side information size
3467  * @return 0 on success, < 0 on failure
3468  */
3469 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3470                                int size);
3471
3472 /**
3473  * Get side information from packet.
3474  *
3475  * @param pkt packet
3476  * @param type desired side information type
3477  * @param size pointer for side information size to store (optional)
3478  * @return pointer to data if present or NULL otherwise
3479  */
3480 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3481                                  int *size);
3482
3483 /**
3484  * Convenience function to free all the side data stored.
3485  * All the other fields stay untouched.
3486  *
3487  * @param pkt packet
3488  */
3489 void av_packet_free_side_data(AVPacket *pkt);
3490
3491 /**
3492  * Setup a new reference to the data described by a given packet
3493  *
3494  * If src is reference-counted, setup dst as a new reference to the
3495  * buffer in src. Otherwise allocate a new buffer in dst and copy the
3496  * data from src into it.
3497  *
3498  * All the other fields are copied from src.
3499  *
3500  * @see av_packet_unref
3501  *
3502  * @param dst Destination packet
3503  * @param src Source packet
3504  *
3505  * @return 0 on success, a negative AVERROR on error.
3506  */
3507 int av_packet_ref(AVPacket *dst, AVPacket *src);
3508
3509 /**
3510  * Wipe the packet.
3511  *
3512  * Unreference the buffer referenced by the packet and reset the
3513  * remaining packet fields to their default values.
3514  *
3515  * @param pkt The packet to be unreferenced.
3516  */
3517 void av_packet_unref(AVPacket *pkt);
3518
3519 /**
3520  * Move every field in src to dst and reset src.
3521  *
3522  * @see av_packet_unref
3523  *
3524  * @param src Source packet, will be reset
3525  * @param dst Destination packet
3526  */
3527 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3528
3529 /**
3530  * Copy only "properties" fields from src to dst.
3531  *
3532  * Properties for the purpose of this function are all the fields
3533  * beside those related to the packet data (buf, data, size)
3534  *
3535  * @param dst Destination packet
3536  * @param src Source packet
3537  *
3538  * @return 0 on success AVERROR on failure.
3539  *
3540  */
3541 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3542
3543 /**
3544  * Convert valid timing fields (timestamps / durations) in a packet from one
3545  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3546  * ignored.
3547  *
3548  * @param pkt packet on which the conversion will be performed
3549  * @param tb_src source timebase, in which the timing fields in pkt are
3550  *               expressed
3551  * @param tb_dst destination timebase, to which the timing fields will be
3552  *               converted
3553  */
3554 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3555
3556 /**
3557  * @}
3558  */
3559
3560 /**
3561  * @addtogroup lavc_decoding
3562  * @{
3563  */
3564
3565 /**
3566  * Find a registered decoder with a matching codec ID.
3567  *
3568  * @param id AVCodecID of the requested decoder
3569  * @return A decoder if one was found, NULL otherwise.
3570  */
3571 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3572
3573 /**
3574  * Find a registered decoder with the specified name.
3575  *
3576  * @param name name of the requested decoder
3577  * @return A decoder if one was found, NULL otherwise.
3578  */
3579 AVCodec *avcodec_find_decoder_by_name(const char *name);
3580
3581 #if FF_API_GET_BUFFER
3582 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3583 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3584 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3585 #endif
3586
3587 /**
3588  * The default callback for AVCodecContext.get_buffer2(). It is made public so
3589  * it can be called by custom get_buffer2() implementations for decoders without
3590  * CODEC_CAP_DR1 set.
3591  */
3592 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3593
3594 #if FF_API_EMU_EDGE
3595 /**
3596  * Return the amount of padding in pixels which the get_buffer callback must
3597  * provide around the edge of the image for codecs which do not have the
3598  * CODEC_FLAG_EMU_EDGE flag.
3599  *
3600  * @return Required padding in pixels.
3601  *
3602  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3603  * needed
3604  */
3605 attribute_deprecated
3606 unsigned avcodec_get_edge_width(void);
3607 #endif
3608
3609 /**
3610  * Modify width and height values so that they will result in a memory
3611  * buffer that is acceptable for the codec if you do not use any horizontal
3612  * padding.
3613  *
3614  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3615  */
3616 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3617
3618 /**
3619  * Modify width and height values so that they will result in a memory
3620  * buffer that is acceptable for the codec if you also ensure that all
3621  * line sizes are a multiple of the respective linesize_align[i].
3622  *
3623  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3624  */
3625 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3626                                int linesize_align[AV_NUM_DATA_POINTERS]);
3627
3628 /**
3629  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3630  *
3631  * Some decoders may support multiple frames in a single AVPacket. Such
3632  * decoders would then just decode the first frame and the return value would be
3633  * less than the packet size. In this case, avcodec_decode_audio4 has to be
3634  * called again with an AVPacket containing the remaining data in order to
3635  * decode the second frame, etc...  Even if no frames are returned, the packet
3636  * needs to be fed to the decoder with remaining data until it is completely
3637  * consumed or an error occurs.
3638  *
3639  * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3640  * and output. This means that for some packets they will not immediately
3641  * produce decoded output and need to be flushed at the end of decoding to get
3642  * all the decoded data. Flushing is done by calling this function with packets
3643  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3644  * returning samples. It is safe to flush even those decoders that are not
3645  * marked with CODEC_CAP_DELAY, then no samples will be returned.
3646  *
3647  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3648  *          larger than the actual read bytes because some optimized bitstream
3649  *          readers read 32 or 64 bits at once and could read over the end.
3650  *
3651  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3652  * before packets may be fed to the decoder.
3653  *
3654  * @param      avctx the codec context
3655  * @param[out] frame The AVFrame in which to store decoded audio samples.
3656  *                   The decoder will allocate a buffer for the decoded frame by
3657  *                   calling the AVCodecContext.get_buffer2() callback.
3658  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
3659  *                   reference counted and the returned reference belongs to the
3660  *                   caller. The caller must release the frame using av_frame_unref()
3661  *                   when the frame is no longer needed. The caller may safely write
3662  *                   to the frame if av_frame_is_writable() returns 1.
3663  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
3664  *                   reference belongs to the decoder and is valid only until the
3665  *                   next call to this function or until closing or flushing the
3666  *                   decoder. The caller may not write to it.
3667  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3668  *                           non-zero. Note that this field being set to zero
3669  *                           does not mean that an error has occurred. For
3670  *                           decoders with CODEC_CAP_DELAY set, no given decode
3671  *                           call is guaranteed to produce a frame.
3672  * @param[in]  avpkt The input AVPacket containing the input buffer.
3673  *                   At least avpkt->data and avpkt->size should be set. Some
3674  *                   decoders might also require additional fields to be set.
3675  * @return A negative error code is returned if an error occurred during
3676  *         decoding, otherwise the number of bytes consumed from the input
3677  *         AVPacket is returned.
3678  */
3679 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3680                           int *got_frame_ptr, AVPacket *avpkt);
3681
3682 /**
3683  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3684  * Some decoders may support multiple frames in a single AVPacket, such
3685  * decoders would then just decode the first frame.
3686  *
3687  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3688  * the actual read bytes because some optimized bitstream readers read 32 or 64
3689  * bits at once and could read over the end.
3690  *
3691  * @warning The end of the input buffer buf should be set to 0 to ensure that
3692  * no overreading happens for damaged MPEG streams.
3693  *
3694  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3695  * between input and output, these need to be fed with avpkt->data=NULL,
3696  * avpkt->size=0 at the end to return the remaining frames.
3697  *
3698  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3699  * before packets may be fed to the decoder.
3700  *
3701  * @param avctx the codec context
3702  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3703  *             Use av_frame_alloc() to get an AVFrame. The codec will
3704  *             allocate memory for the actual bitmap by calling the
3705  *             AVCodecContext.get_buffer2() callback.
3706  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
3707  *             reference counted and the returned reference belongs to the
3708  *             caller. The caller must release the frame using av_frame_unref()
3709  *             when the frame is no longer needed. The caller may safely write
3710  *             to the frame if av_frame_is_writable() returns 1.
3711  *             When AVCodecContext.refcounted_frames is set to 0, the returned
3712  *             reference belongs to the decoder and is valid only until the
3713  *             next call to this function or until closing or flushing the
3714  *             decoder. The caller may not write to it.
3715  *
3716  * @param[in] avpkt The input AVpacket containing the input buffer.
3717  *            You can create such packet with av_init_packet() and by then setting
3718  *            data and size, some decoders might in addition need other fields like
3719  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3720  *            fields possible.
3721  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3722  * @return On error a negative value is returned, otherwise the number of bytes
3723  * used or zero if no frame could be decompressed.
3724  */
3725 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3726                          int *got_picture_ptr,
3727                          AVPacket *avpkt);
3728
3729 /**
3730  * Decode a subtitle message.
3731  * Return a negative value on error, otherwise return the number of bytes used.
3732  * If no subtitle could be decompressed, got_sub_ptr is zero.
3733  * Otherwise, the subtitle is stored in *sub.
3734  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3735  * simplicity, because the performance difference is expect to be negligible
3736  * and reusing a get_buffer written for video codecs would probably perform badly
3737  * due to a potentially very different allocation pattern.
3738  *
3739  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3740  * before packets may be fed to the decoder.
3741  *
3742  * @param avctx the codec context
3743  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3744                    freed with avsubtitle_free if *got_sub_ptr is set.
3745  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3746  * @param[in] avpkt The input AVPacket containing the input buffer.
3747  */
3748 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3749                             int *got_sub_ptr,
3750                             AVPacket *avpkt);
3751
3752 /**
3753  * @defgroup lavc_parsing Frame parsing
3754  * @{
3755  */
3756
3757 enum AVPictureStructure {
3758     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
3759     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
3760     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3761     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
3762 };
3763
3764 typedef struct AVCodecParserContext {
3765     void *priv_data;
3766     struct AVCodecParser *parser;
3767     int64_t frame_offset; /* offset of the current frame */
3768     int64_t cur_offset; /* current offset
3769                            (incremented by each av_parser_parse()) */
3770     int64_t next_frame_offset; /* offset of the next frame */
3771     /* video info */
3772     int pict_type; /* XXX: Put it back in AVCodecContext. */
3773     /**
3774      * This field is used for proper frame duration computation in lavf.
3775      * It signals, how much longer the frame duration of the current frame
3776      * is compared to normal frame duration.
3777      *
3778      * frame_duration = (1 + repeat_pict) * time_base
3779      *
3780      * It is used by codecs like H.264 to display telecined material.
3781      */
3782     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3783     int64_t pts;     /* pts of the current frame */
3784     int64_t dts;     /* dts of the current frame */
3785
3786     /* private data */
3787     int64_t last_pts;
3788     int64_t last_dts;
3789     int fetch_timestamp;
3790
3791 #define AV_PARSER_PTS_NB 4
3792     int cur_frame_start_index;
3793     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3794     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3795     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3796
3797     int flags;
3798 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3799 #define PARSER_FLAG_ONCE                      0x0002
3800 /// Set if the parser has a valid file offset
3801 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
3802
3803     int64_t offset;      ///< byte offset from starting packet start
3804     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3805
3806     /**
3807      * Set by parser to 1 for key frames and 0 for non-key frames.
3808      * It is initialized to -1, so if the parser doesn't set this flag,
3809      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3810      * will be used.
3811      */
3812     int key_frame;
3813
3814     /**
3815      * Time difference in stream time base units from the pts of this
3816      * packet to the point at which the output from the decoder has converged
3817      * independent from the availability of previous frames. That is, the
3818      * frames are virtually identical no matter if decoding started from
3819      * the very first frame or from this keyframe.
3820      * Is AV_NOPTS_VALUE if unknown.
3821   &