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