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