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