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