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