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