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