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