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