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