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