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