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