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