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