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