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