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