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