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