Merge commit 'ca411fc1d34329cd17b28627f697e391ae52073f'
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 #include "libavutil/audioconvert.h"
38
39 #include "libavcodec/version.h"
40 /**
41  * @defgroup libavc Encoding/Decoding Library
42  * @{
43  *
44  * @defgroup lavc_decoding Decoding
45  * @{
46  * @}
47  *
48  * @defgroup lavc_encoding Encoding
49  * @{
50  * @}
51  *
52  * @defgroup lavc_codec Codecs
53  * @{
54  * @defgroup lavc_codec_native Native Codecs
55  * @{
56  * @}
57  * @defgroup lavc_codec_wrappers External library wrappers
58  * @{
59  * @}
60  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
61  * @{
62  * @}
63  * @}
64  * @defgroup lavc_internal Internal
65  * @{
66  * @}
67  * @}
68  *
69  */
70
71 /**
72  * @defgroup lavc_core Core functions/structures.
73  * @ingroup libavc
74  *
75  * Basic definitions, functions for querying libavcodec capabilities,
76  * allocating core structures, etc.
77  * @{
78  */
79
80
81 /**
82  * Identify the syntax and semantics of the bitstream.
83  * The principle is roughly:
84  * Two decoders with the same ID can decode the same streams.
85  * Two encoders with the same ID can encode compatible streams.
86  * There may be slight deviations from the principle due to implementation
87  * details.
88  *
89  * If you add a codec ID to this list, add it so that
90  * 1. no value of a existing codec ID changes (that would break ABI),
91  * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
92  *    This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
93  *
94  * After adding new codec IDs, do not forget to add an entry to the codec
95  * descriptor list and bump libavcodec minor version.
96  */
97 enum AVCodecID {
98     AV_CODEC_ID_NONE,
99
100     /* video codecs */
101     AV_CODEC_ID_MPEG1VIDEO,
102     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103     AV_CODEC_ID_MPEG2VIDEO_XVMC,
104     AV_CODEC_ID_H261,
105     AV_CODEC_ID_H263,
106     AV_CODEC_ID_RV10,
107     AV_CODEC_ID_RV20,
108     AV_CODEC_ID_MJPEG,
109     AV_CODEC_ID_MJPEGB,
110     AV_CODEC_ID_LJPEG,
111     AV_CODEC_ID_SP5X,
112     AV_CODEC_ID_JPEGLS,
113     AV_CODEC_ID_MPEG4,
114     AV_CODEC_ID_RAWVIDEO,
115     AV_CODEC_ID_MSMPEG4V1,
116     AV_CODEC_ID_MSMPEG4V2,
117     AV_CODEC_ID_MSMPEG4V3,
118     AV_CODEC_ID_WMV1,
119     AV_CODEC_ID_WMV2,
120     AV_CODEC_ID_H263P,
121     AV_CODEC_ID_H263I,
122     AV_CODEC_ID_FLV1,
123     AV_CODEC_ID_SVQ1,
124     AV_CODEC_ID_SVQ3,
125     AV_CODEC_ID_DVVIDEO,
126     AV_CODEC_ID_HUFFYUV,
127     AV_CODEC_ID_CYUV,
128     AV_CODEC_ID_H264,
129     AV_CODEC_ID_INDEO3,
130     AV_CODEC_ID_VP3,
131     AV_CODEC_ID_THEORA,
132     AV_CODEC_ID_ASV1,
133     AV_CODEC_ID_ASV2,
134     AV_CODEC_ID_FFV1,
135     AV_CODEC_ID_4XM,
136     AV_CODEC_ID_VCR1,
137     AV_CODEC_ID_CLJR,
138     AV_CODEC_ID_MDEC,
139     AV_CODEC_ID_ROQ,
140     AV_CODEC_ID_INTERPLAY_VIDEO,
141     AV_CODEC_ID_XAN_WC3,
142     AV_CODEC_ID_XAN_WC4,
143     AV_CODEC_ID_RPZA,
144     AV_CODEC_ID_CINEPAK,
145     AV_CODEC_ID_WS_VQA,
146     AV_CODEC_ID_MSRLE,
147     AV_CODEC_ID_MSVIDEO1,
148     AV_CODEC_ID_IDCIN,
149     AV_CODEC_ID_8BPS,
150     AV_CODEC_ID_SMC,
151     AV_CODEC_ID_FLIC,
152     AV_CODEC_ID_TRUEMOTION1,
153     AV_CODEC_ID_VMDVIDEO,
154     AV_CODEC_ID_MSZH,
155     AV_CODEC_ID_ZLIB,
156     AV_CODEC_ID_QTRLE,
157     AV_CODEC_ID_SNOW,
158     AV_CODEC_ID_TSCC,
159     AV_CODEC_ID_ULTI,
160     AV_CODEC_ID_QDRAW,
161     AV_CODEC_ID_VIXL,
162     AV_CODEC_ID_QPEG,
163     AV_CODEC_ID_PNG,
164     AV_CODEC_ID_PPM,
165     AV_CODEC_ID_PBM,
166     AV_CODEC_ID_PGM,
167     AV_CODEC_ID_PGMYUV,
168     AV_CODEC_ID_PAM,
169     AV_CODEC_ID_FFVHUFF,
170     AV_CODEC_ID_RV30,
171     AV_CODEC_ID_RV40,
172     AV_CODEC_ID_VC1,
173     AV_CODEC_ID_WMV3,
174     AV_CODEC_ID_LOCO,
175     AV_CODEC_ID_WNV1,
176     AV_CODEC_ID_AASC,
177     AV_CODEC_ID_INDEO2,
178     AV_CODEC_ID_FRAPS,
179     AV_CODEC_ID_TRUEMOTION2,
180     AV_CODEC_ID_BMP,
181     AV_CODEC_ID_CSCD,
182     AV_CODEC_ID_MMVIDEO,
183     AV_CODEC_ID_ZMBV,
184     AV_CODEC_ID_AVS,
185     AV_CODEC_ID_SMACKVIDEO,
186     AV_CODEC_ID_NUV,
187     AV_CODEC_ID_KMVC,
188     AV_CODEC_ID_FLASHSV,
189     AV_CODEC_ID_CAVS,
190     AV_CODEC_ID_JPEG2000,
191     AV_CODEC_ID_VMNC,
192     AV_CODEC_ID_VP5,
193     AV_CODEC_ID_VP6,
194     AV_CODEC_ID_VP6F,
195     AV_CODEC_ID_TARGA,
196     AV_CODEC_ID_DSICINVIDEO,
197     AV_CODEC_ID_TIERTEXSEQVIDEO,
198     AV_CODEC_ID_TIFF,
199     AV_CODEC_ID_GIF,
200     AV_CODEC_ID_DXA,
201     AV_CODEC_ID_DNXHD,
202     AV_CODEC_ID_THP,
203     AV_CODEC_ID_SGI,
204     AV_CODEC_ID_C93,
205     AV_CODEC_ID_BETHSOFTVID,
206     AV_CODEC_ID_PTX,
207     AV_CODEC_ID_TXD,
208     AV_CODEC_ID_VP6A,
209     AV_CODEC_ID_AMV,
210     AV_CODEC_ID_VB,
211     AV_CODEC_ID_PCX,
212     AV_CODEC_ID_SUNRAST,
213     AV_CODEC_ID_INDEO4,
214     AV_CODEC_ID_INDEO5,
215     AV_CODEC_ID_MIMIC,
216     AV_CODEC_ID_RL2,
217     AV_CODEC_ID_ESCAPE124,
218     AV_CODEC_ID_DIRAC,
219     AV_CODEC_ID_BFI,
220     AV_CODEC_ID_CMV,
221     AV_CODEC_ID_MOTIONPIXELS,
222     AV_CODEC_ID_TGV,
223     AV_CODEC_ID_TGQ,
224     AV_CODEC_ID_TQI,
225     AV_CODEC_ID_AURA,
226     AV_CODEC_ID_AURA2,
227     AV_CODEC_ID_V210X,
228     AV_CODEC_ID_TMV,
229     AV_CODEC_ID_V210,
230     AV_CODEC_ID_DPX,
231     AV_CODEC_ID_MAD,
232     AV_CODEC_ID_FRWU,
233     AV_CODEC_ID_FLASHSV2,
234     AV_CODEC_ID_CDGRAPHICS,
235     AV_CODEC_ID_R210,
236     AV_CODEC_ID_ANM,
237     AV_CODEC_ID_BINKVIDEO,
238     AV_CODEC_ID_IFF_ILBM,
239     AV_CODEC_ID_IFF_BYTERUN1,
240     AV_CODEC_ID_KGV1,
241     AV_CODEC_ID_YOP,
242     AV_CODEC_ID_VP8,
243     AV_CODEC_ID_PICTOR,
244     AV_CODEC_ID_ANSI,
245     AV_CODEC_ID_A64_MULTI,
246     AV_CODEC_ID_A64_MULTI5,
247     AV_CODEC_ID_R10K,
248     AV_CODEC_ID_MXPEG,
249     AV_CODEC_ID_LAGARITH,
250     AV_CODEC_ID_PRORES,
251     AV_CODEC_ID_JV,
252     AV_CODEC_ID_DFA,
253     AV_CODEC_ID_WMV3IMAGE,
254     AV_CODEC_ID_VC1IMAGE,
255     AV_CODEC_ID_UTVIDEO,
256     AV_CODEC_ID_BMV_VIDEO,
257     AV_CODEC_ID_VBLE,
258     AV_CODEC_ID_DXTORY,
259     AV_CODEC_ID_V410,
260     AV_CODEC_ID_XWD,
261     AV_CODEC_ID_CDXL,
262     AV_CODEC_ID_XBM,
263     AV_CODEC_ID_ZEROCODEC,
264     AV_CODEC_ID_MSS1,
265     AV_CODEC_ID_MSA1,
266     AV_CODEC_ID_TSCC2,
267     AV_CODEC_ID_MTS2,
268     AV_CODEC_ID_CLLC,
269     AV_CODEC_ID_MSS2,
270     AV_CODEC_ID_Y41P       = MKBETAG('Y','4','1','P'),
271     AV_CODEC_ID_ESCAPE130  = MKBETAG('E','1','3','0'),
272     AV_CODEC_ID_EXR        = MKBETAG('0','E','X','R'),
273     AV_CODEC_ID_AVRP       = MKBETAG('A','V','R','P'),
274
275     AV_CODEC_ID_G2M        = MKBETAG( 0 ,'G','2','M'),
276     AV_CODEC_ID_AVUI       = MKBETAG('A','V','U','I'),
277     AV_CODEC_ID_AYUV       = MKBETAG('A','Y','U','V'),
278     AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
279     AV_CODEC_ID_V308       = MKBETAG('V','3','0','8'),
280     AV_CODEC_ID_V408       = MKBETAG('V','4','0','8'),
281     AV_CODEC_ID_YUV4       = MKBETAG('Y','U','V','4'),
282     AV_CODEC_ID_SANM       = MKBETAG('S','A','N','M'),
283     AV_CODEC_ID_PAF_VIDEO  = MKBETAG('P','A','F','V'),
284     AV_CODEC_ID_AVRN       = MKBETAG('A','V','R','n'),
285     AV_CODEC_ID_CPIA       = MKBETAG('C','P','I','A'),
286
287     /* various PCM "codecs" */
288     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
289     AV_CODEC_ID_PCM_S16LE = 0x10000,
290     AV_CODEC_ID_PCM_S16BE,
291     AV_CODEC_ID_PCM_U16LE,
292     AV_CODEC_ID_PCM_U16BE,
293     AV_CODEC_ID_PCM_S8,
294     AV_CODEC_ID_PCM_U8,
295     AV_CODEC_ID_PCM_MULAW,
296     AV_CODEC_ID_PCM_ALAW,
297     AV_CODEC_ID_PCM_S32LE,
298     AV_CODEC_ID_PCM_S32BE,
299     AV_CODEC_ID_PCM_U32LE,
300     AV_CODEC_ID_PCM_U32BE,
301     AV_CODEC_ID_PCM_S24LE,
302     AV_CODEC_ID_PCM_S24BE,
303     AV_CODEC_ID_PCM_U24LE,
304     AV_CODEC_ID_PCM_U24BE,
305     AV_CODEC_ID_PCM_S24DAUD,
306     AV_CODEC_ID_PCM_ZORK,
307     AV_CODEC_ID_PCM_S16LE_PLANAR,
308     AV_CODEC_ID_PCM_DVD,
309     AV_CODEC_ID_PCM_F32BE,
310     AV_CODEC_ID_PCM_F32LE,
311     AV_CODEC_ID_PCM_F64BE,
312     AV_CODEC_ID_PCM_F64LE,
313     AV_CODEC_ID_PCM_BLURAY,
314     AV_CODEC_ID_PCM_LXF,
315     AV_CODEC_ID_S302M,
316     AV_CODEC_ID_PCM_S8_PLANAR,
317
318     /* various ADPCM codecs */
319     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
320     AV_CODEC_ID_ADPCM_IMA_WAV,
321     AV_CODEC_ID_ADPCM_IMA_DK3,
322     AV_CODEC_ID_ADPCM_IMA_DK4,
323     AV_CODEC_ID_ADPCM_IMA_WS,
324     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
325     AV_CODEC_ID_ADPCM_MS,
326     AV_CODEC_ID_ADPCM_4XM,
327     AV_CODEC_ID_ADPCM_XA,
328     AV_CODEC_ID_ADPCM_ADX,
329     AV_CODEC_ID_ADPCM_EA,
330     AV_CODEC_ID_ADPCM_G726,
331     AV_CODEC_ID_ADPCM_CT,
332     AV_CODEC_ID_ADPCM_SWF,
333     AV_CODEC_ID_ADPCM_YAMAHA,
334     AV_CODEC_ID_ADPCM_SBPRO_4,
335     AV_CODEC_ID_ADPCM_SBPRO_3,
336     AV_CODEC_ID_ADPCM_SBPRO_2,
337     AV_CODEC_ID_ADPCM_THP,
338     AV_CODEC_ID_ADPCM_IMA_AMV,
339     AV_CODEC_ID_ADPCM_EA_R1,
340     AV_CODEC_ID_ADPCM_EA_R3,
341     AV_CODEC_ID_ADPCM_EA_R2,
342     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
343     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
344     AV_CODEC_ID_ADPCM_EA_XAS,
345     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
346     AV_CODEC_ID_ADPCM_IMA_ISS,
347     AV_CODEC_ID_ADPCM_G722,
348     AV_CODEC_ID_ADPCM_IMA_APC,
349     AV_CODEC_ID_VIMA       = MKBETAG('V','I','M','A'),
350
351     /* AMR */
352     AV_CODEC_ID_AMR_NB = 0x12000,
353     AV_CODEC_ID_AMR_WB,
354
355     /* RealAudio codecs*/
356     AV_CODEC_ID_RA_144 = 0x13000,
357     AV_CODEC_ID_RA_288,
358
359     /* various DPCM codecs */
360     AV_CODEC_ID_ROQ_DPCM = 0x14000,
361     AV_CODEC_ID_INTERPLAY_DPCM,
362     AV_CODEC_ID_XAN_DPCM,
363     AV_CODEC_ID_SOL_DPCM,
364
365     /* audio codecs */
366     AV_CODEC_ID_MP2 = 0x15000,
367     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
368     AV_CODEC_ID_AAC,
369     AV_CODEC_ID_AC3,
370     AV_CODEC_ID_DTS,
371     AV_CODEC_ID_VORBIS,
372     AV_CODEC_ID_DVAUDIO,
373     AV_CODEC_ID_WMAV1,
374     AV_CODEC_ID_WMAV2,
375     AV_CODEC_ID_MACE3,
376     AV_CODEC_ID_MACE6,
377     AV_CODEC_ID_VMDAUDIO,
378     AV_CODEC_ID_FLAC,
379     AV_CODEC_ID_MP3ADU,
380     AV_CODEC_ID_MP3ON4,
381     AV_CODEC_ID_SHORTEN,
382     AV_CODEC_ID_ALAC,
383     AV_CODEC_ID_WESTWOOD_SND1,
384     AV_CODEC_ID_GSM, ///< as in Berlin toast format
385     AV_CODEC_ID_QDM2,
386     AV_CODEC_ID_COOK,
387     AV_CODEC_ID_TRUESPEECH,
388     AV_CODEC_ID_TTA,
389     AV_CODEC_ID_SMACKAUDIO,
390     AV_CODEC_ID_QCELP,
391     AV_CODEC_ID_WAVPACK,
392     AV_CODEC_ID_DSICINAUDIO,
393     AV_CODEC_ID_IMC,
394     AV_CODEC_ID_MUSEPACK7,
395     AV_CODEC_ID_MLP,
396     AV_CODEC_ID_GSM_MS, /* as found in WAV */
397     AV_CODEC_ID_ATRAC3,
398     AV_CODEC_ID_VOXWARE,
399     AV_CODEC_ID_APE,
400     AV_CODEC_ID_NELLYMOSER,
401     AV_CODEC_ID_MUSEPACK8,
402     AV_CODEC_ID_SPEEX,
403     AV_CODEC_ID_WMAVOICE,
404     AV_CODEC_ID_WMAPRO,
405     AV_CODEC_ID_WMALOSSLESS,
406     AV_CODEC_ID_ATRAC3P,
407     AV_CODEC_ID_EAC3,
408     AV_CODEC_ID_SIPR,
409     AV_CODEC_ID_MP1,
410     AV_CODEC_ID_TWINVQ,
411     AV_CODEC_ID_TRUEHD,
412     AV_CODEC_ID_MP4ALS,
413     AV_CODEC_ID_ATRAC1,
414     AV_CODEC_ID_BINKAUDIO_RDFT,
415     AV_CODEC_ID_BINKAUDIO_DCT,
416     AV_CODEC_ID_AAC_LATM,
417     AV_CODEC_ID_QDMC,
418     AV_CODEC_ID_CELT,
419     AV_CODEC_ID_G723_1,
420     AV_CODEC_ID_G729,
421     AV_CODEC_ID_8SVX_EXP,
422     AV_CODEC_ID_8SVX_FIB,
423     AV_CODEC_ID_BMV_AUDIO,
424     AV_CODEC_ID_RALF,
425     AV_CODEC_ID_IAC,
426     AV_CODEC_ID_ILBC,
427     AV_CODEC_ID_OPUS_DEPRECATED,
428     AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
429     AV_CODEC_ID_8SVX_RAW    = MKBETAG('8','S','V','X'),
430     AV_CODEC_ID_SONIC       = MKBETAG('S','O','N','C'),
431     AV_CODEC_ID_SONIC_LS    = MKBETAG('S','O','N','L'),
432     AV_CODEC_ID_PAF_AUDIO   = MKBETAG('P','A','F','A'),
433     AV_CODEC_ID_OPUS        = MKBETAG('O','P','U','S'),
434     AV_CODEC_ID_TAK         = MKBETAG('t','B','a','K'),
435
436     /* subtitle codecs */
437     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
438     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
439     AV_CODEC_ID_DVB_SUBTITLE,
440     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
441     AV_CODEC_ID_XSUB,
442     AV_CODEC_ID_SSA,
443     AV_CODEC_ID_MOV_TEXT,
444     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
445     AV_CODEC_ID_DVB_TELETEXT,
446     AV_CODEC_ID_SRT,
447     AV_CODEC_ID_MICRODVD   = MKBETAG('m','D','V','D'),
448     AV_CODEC_ID_EIA_608    = MKBETAG('c','6','0','8'),
449     AV_CODEC_ID_JACOSUB    = MKBETAG('J','S','U','B'),
450     AV_CODEC_ID_SAMI       = MKBETAG('S','A','M','I'),
451     AV_CODEC_ID_REALTEXT   = MKBETAG('R','T','X','T'),
452     AV_CODEC_ID_SUBVIEWER  = MKBETAG('S','u','b','V'),
453     AV_CODEC_ID_SUBRIP     = MKBETAG('S','R','i','p'),
454     AV_CODEC_ID_WEBVTT     = MKBETAG('W','V','T','T'),
455
456     /* other specific kind of codecs (generally used for attachments) */
457     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
458     AV_CODEC_ID_TTF = 0x18000,
459     AV_CODEC_ID_BINTEXT    = MKBETAG('B','T','X','T'),
460     AV_CODEC_ID_XBIN       = MKBETAG('X','B','I','N'),
461     AV_CODEC_ID_IDF        = MKBETAG( 0 ,'I','D','F'),
462     AV_CODEC_ID_OTF        = MKBETAG( 0 ,'O','T','F'),
463
464     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
465
466     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
467                                 * stream (only used by libavformat) */
468     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
469                                 * stream (only used by libavformat) */
470     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
471
472 #if FF_API_CODEC_ID
473 #include "old_codec_ids.h"
474 #endif
475 };
476
477 #if FF_API_CODEC_ID
478 #define CodecID AVCodecID
479 #endif
480
481 /**
482  * This struct describes the properties of a single codec described by an
483  * AVCodecID.
484  * @see avcodec_get_descriptor()
485  */
486 typedef struct AVCodecDescriptor {
487     enum AVCodecID     id;
488     enum AVMediaType type;
489     /**
490      * Name of the codec described by this descriptor. It is non-empty and
491      * unique for each codec descriptor. It should contain alphanumeric
492      * characters and '_' only.
493      */
494     const char      *name;
495     /**
496      * A more descriptive name for this codec. May be NULL.
497      */
498     const char *long_name;
499     /**
500      * Codec properties, a combination of AV_CODEC_PROP_* flags.
501      */
502     int             props;
503 } AVCodecDescriptor;
504
505 /**
506  * Codec uses only intra compression.
507  * Video codecs only.
508  */
509 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
510 /**
511  * Codec supports lossy compression. Audio and video codecs only.
512  * @note a codec may support both lossy and lossless
513  * compression modes
514  */
515 #define AV_CODEC_PROP_LOSSY         (1 << 1)
516 /**
517  * Codec supports lossless compression. Audio and video codecs only.
518  */
519 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
520
521 #if FF_API_OLD_DECODE_AUDIO
522 /* in bytes */
523 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
524 #endif
525
526 /**
527  * @ingroup lavc_decoding
528  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
529  * This is mainly needed because some optimized bitstream readers read
530  * 32 or 64 bit at once and could read over the end.<br>
531  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
532  * MPEG bitstreams could cause overread and segfault.
533  */
534 #define FF_INPUT_BUFFER_PADDING_SIZE 16
535
536 /**
537  * @ingroup lavc_encoding
538  * minimum encoding buffer size
539  * Used to avoid some checks during header writing.
540  */
541 #define FF_MIN_BUFFER_SIZE 16384
542
543
544 /**
545  * @ingroup lavc_encoding
546  * motion estimation type.
547  */
548 enum Motion_Est_ID {
549     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
550     ME_FULL,
551     ME_LOG,
552     ME_PHODS,
553     ME_EPZS,        ///< enhanced predictive zonal search
554     ME_X1,          ///< reserved for experiments
555     ME_HEX,         ///< hexagon based search
556     ME_UMH,         ///< uneven multi-hexagon search
557     ME_ITER,        ///< iterative search
558     ME_TESA,        ///< transformed exhaustive search algorithm
559 };
560
561 /**
562  * @ingroup lavc_decoding
563  */
564 enum AVDiscard{
565     /* We leave some space between them for extensions (drop some
566      * keyframes for intra-only or drop just some bidir frames). */
567     AVDISCARD_NONE    =-16, ///< discard nothing
568     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
569     AVDISCARD_NONREF  =  8, ///< discard all non reference
570     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
571     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
572     AVDISCARD_ALL     = 48, ///< discard all
573 };
574
575 enum AVColorPrimaries{
576     AVCOL_PRI_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
577     AVCOL_PRI_UNSPECIFIED = 2,
578     AVCOL_PRI_BT470M      = 4,
579     AVCOL_PRI_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
580     AVCOL_PRI_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
581     AVCOL_PRI_SMPTE240M   = 7, ///< functionally identical to above
582     AVCOL_PRI_FILM        = 8,
583     AVCOL_PRI_NB             , ///< Not part of ABI
584 };
585
586 enum AVColorTransferCharacteristic{
587     AVCOL_TRC_BT709       = 1, ///< also ITU-R BT1361
588     AVCOL_TRC_UNSPECIFIED = 2,
589     AVCOL_TRC_GAMMA22     = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
590     AVCOL_TRC_GAMMA28     = 5, ///< also ITU-R BT470BG
591     AVCOL_TRC_SMPTE240M   = 7,
592     AVCOL_TRC_NB             , ///< Not part of ABI
593 };
594
595 enum AVColorSpace{
596     AVCOL_SPC_RGB         = 0,
597     AVCOL_SPC_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
598     AVCOL_SPC_UNSPECIFIED = 2,
599     AVCOL_SPC_FCC         = 4,
600     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
601     AVCOL_SPC_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
602     AVCOL_SPC_SMPTE240M   = 7,
603     AVCOL_SPC_YCOCG       = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
604     AVCOL_SPC_NB             , ///< Not part of ABI
605 };
606 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
607
608 enum AVColorRange{
609     AVCOL_RANGE_UNSPECIFIED = 0,
610     AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
611     AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
612     AVCOL_RANGE_NB             , ///< Not part of ABI
613 };
614
615 /**
616  *  X   X      3 4 X      X are luma samples,
617  *             1 2        1-6 are possible chroma positions
618  *  X   X      5 6 X      0 is undefined/unknown position
619  */
620 enum AVChromaLocation{
621     AVCHROMA_LOC_UNSPECIFIED = 0,
622     AVCHROMA_LOC_LEFT        = 1, ///< mpeg2/4, h264 default
623     AVCHROMA_LOC_CENTER      = 2, ///< mpeg1, jpeg, h263
624     AVCHROMA_LOC_TOPLEFT     = 3, ///< DV
625     AVCHROMA_LOC_TOP         = 4,
626     AVCHROMA_LOC_BOTTOMLEFT  = 5,
627     AVCHROMA_LOC_BOTTOM      = 6,
628     AVCHROMA_LOC_NB             , ///< Not part of ABI
629 };
630
631 enum AVAudioServiceType {
632     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
633     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
634     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
635     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
636     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
637     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
638     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
639     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
640     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
641     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
642 };
643
644 /**
645  * @ingroup lavc_encoding
646  */
647 typedef struct RcOverride{
648     int start_frame;
649     int end_frame;
650     int qscale; // If this is 0 then quality_factor will be used instead.
651     float quality_factor;
652 } RcOverride;
653
654 #define FF_MAX_B_FRAMES 16
655
656 /* encoding support
657    These flags can be passed in AVCodecContext.flags before initialization.
658    Note: Not everything is supported yet.
659 */
660
661 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
662 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
663 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
664 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
665 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
666 /**
667  * The parent program guarantees that the input for B-frames containing
668  * streams is not written to for at least s->max_b_frames+1 frames, if
669  * this is not set the input will be copied.
670  */
671 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
672 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
673 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
674 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
675 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
676 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
677 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
678                                                   location instead of only at frame boundaries. */
679 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
680 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
681 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
682 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
683 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
684 /* Fx : Flag for h263+ extra options */
685 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
686 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
687 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
688 #define CODEC_FLAG_CLOSED_GOP     0x80000000
689 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
690 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
691 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
692 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
693 #if FF_API_MPV_GLOBAL_OPTS
694 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
695 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
696 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
697 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
698 #endif
699 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
700 #define CODEC_FLAG2_SHOW_ALL      0x00400000 ///< Show all frames before the first keyframe
701
702 /* Unsupported options :
703  *              Syntax Arithmetic coding (SAC)
704  *              Reference Picture Selection
705  *              Independent Segment Decoding */
706 /* /Fx */
707 /* codec capabilities */
708
709 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
710 /**
711  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
712  * If not set, it might not use get_buffer() at all or use operations that
713  * assume the buffer was allocated by avcodec_default_get_buffer.
714  */
715 #define CODEC_CAP_DR1             0x0002
716 #define CODEC_CAP_TRUNCATED       0x0008
717 /* Codec can export data for HW decoding (XvMC). */
718 #define CODEC_CAP_HWACCEL         0x0010
719 /**
720  * Encoder or decoder requires flushing with NULL input at the end in order to
721  * give the complete and correct output.
722  *
723  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
724  *       with NULL data. The user can still send NULL data to the public encode
725  *       or decode function, but libavcodec will not pass it along to the codec
726  *       unless this flag is set.
727  *
728  * Decoders:
729  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
730  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
731  * returns frames.
732  *
733  * Encoders:
734  * The encoder needs to be fed with NULL data at the end of encoding until the
735  * encoder no longer returns data.
736  *
737  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
738  *       flag also means that the encoder must set the pts and duration for
739  *       each output packet. If this flag is not set, the pts and duration will
740  *       be determined by libavcodec from the input frame.
741  */
742 #define CODEC_CAP_DELAY           0x0020
743 /**
744  * Codec can be fed a final frame with a smaller size.
745  * This can be used to prevent truncation of the last audio samples.
746  */
747 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
748 /**
749  * Codec can export data for HW decoding (VDPAU).
750  */
751 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
752 /**
753  * Codec can output multiple frames per AVPacket
754  * Normally demuxers return one frame at a time, demuxers which do not do
755  * are connected to a parser to split what they return into proper frames.
756  * This flag is reserved to the very rare category of codecs which have a
757  * bitstream that cannot be split into frames without timeconsuming
758  * operations like full decoding. Demuxers carring such bitstreams thus
759  * may return multiple frames in a packet. This has many disadvantages like
760  * prohibiting stream copy in many cases thus it should only be considered
761  * as a last resort.
762  */
763 #define CODEC_CAP_SUBFRAMES        0x0100
764 /**
765  * Codec is experimental and is thus avoided in favor of non experimental
766  * encoders
767  */
768 #define CODEC_CAP_EXPERIMENTAL     0x0200
769 /**
770  * Codec should fill in channel configuration and samplerate instead of container
771  */
772 #define CODEC_CAP_CHANNEL_CONF     0x0400
773
774 /**
775  * Codec is able to deal with negative linesizes
776  */
777 #define CODEC_CAP_NEG_LINESIZES    0x0800
778
779 /**
780  * Codec supports frame-level multithreading.
781  */
782 #define CODEC_CAP_FRAME_THREADS    0x1000
783 /**
784  * Codec supports slice-based (or partition-based) multithreading.
785  */
786 #define CODEC_CAP_SLICE_THREADS    0x2000
787 /**
788  * Codec supports changed parameters at any point.
789  */
790 #define CODEC_CAP_PARAM_CHANGE     0x4000
791 /**
792  * Codec supports avctx->thread_count == 0 (auto).
793  */
794 #define CODEC_CAP_AUTO_THREADS     0x8000
795 /**
796  * Audio encoder supports receiving a different number of samples in each call.
797  */
798 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
799 /**
800  * Codec is intra only.
801  */
802 #define CODEC_CAP_INTRA_ONLY       0x40000000
803 /**
804  * Codec is lossless.
805  */
806 #define CODEC_CAP_LOSSLESS         0x80000000
807
808 //The following defines may change, don't expect compatibility if you use them.
809 #define MB_TYPE_INTRA4x4   0x0001
810 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
811 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
812 #define MB_TYPE_16x16      0x0008
813 #define MB_TYPE_16x8       0x0010
814 #define MB_TYPE_8x16       0x0020
815 #define MB_TYPE_8x8        0x0040
816 #define MB_TYPE_INTERLACED 0x0080
817 #define MB_TYPE_DIRECT2    0x0100 //FIXME
818 #define MB_TYPE_ACPRED     0x0200
819 #define MB_TYPE_GMC        0x0400
820 #define MB_TYPE_SKIP       0x0800
821 #define MB_TYPE_P0L0       0x1000
822 #define MB_TYPE_P1L0       0x2000
823 #define MB_TYPE_P0L1       0x4000
824 #define MB_TYPE_P1L1       0x8000
825 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
826 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
827 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
828 #define MB_TYPE_QUANT      0x00010000
829 #define MB_TYPE_CBP        0x00020000
830 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
831
832 /**
833  * Pan Scan area.
834  * This specifies the area which should be displayed.
835  * Note there may be multiple such areas for one frame.
836  */
837 typedef struct AVPanScan{
838     /**
839      * id
840      * - encoding: Set by user.
841      * - decoding: Set by libavcodec.
842      */
843     int id;
844
845     /**
846      * width and height in 1/16 pel
847      * - encoding: Set by user.
848      * - decoding: Set by libavcodec.
849      */
850     int width;
851     int height;
852
853     /**
854      * position of the top left corner in 1/16 pel for up to 3 fields/frames
855      * - encoding: Set by user.
856      * - decoding: Set by libavcodec.
857      */
858     int16_t position[3][2];
859 }AVPanScan;
860
861 #define FF_QSCALE_TYPE_MPEG1 0
862 #define FF_QSCALE_TYPE_MPEG2 1
863 #define FF_QSCALE_TYPE_H264  2
864 #define FF_QSCALE_TYPE_VP56  3
865
866 #define FF_BUFFER_TYPE_INTERNAL 1
867 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
868 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
869 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
870
871 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
872 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
873 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
874 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
875
876 /**
877  * @defgroup lavc_packet AVPacket
878  *
879  * Types and functions for working with AVPacket.
880  * @{
881  */
882 enum AVPacketSideDataType {
883     AV_PKT_DATA_PALETTE,
884     AV_PKT_DATA_NEW_EXTRADATA,
885
886     /**
887      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
888      * @code
889      * u32le param_flags
890      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
891      *     s32le channel_count
892      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
893      *     u64le channel_layout
894      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
895      *     s32le sample_rate
896      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
897      *     s32le width
898      *     s32le height
899      * @endcode
900      */
901     AV_PKT_DATA_PARAM_CHANGE,
902
903     /**
904      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
905      * structures with info about macroblocks relevant to splitting the
906      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
907      * That is, it does not necessarily contain info about all macroblocks,
908      * as long as the distance between macroblocks in the info is smaller
909      * than the target payload size.
910      * Each MB info structure is 12 bytes, and is laid out as follows:
911      * @code
912      * u32le bit offset from the start of the packet
913      * u8    current quantizer at the start of the macroblock
914      * u8    GOB number
915      * u16le macroblock address within the GOB
916      * u8    horizontal MV predictor
917      * u8    vertical MV predictor
918      * u8    horizontal MV predictor for block number 3
919      * u8    vertical MV predictor for block number 3
920      * @endcode
921      */
922     AV_PKT_DATA_H263_MB_INFO,
923
924     /**
925      * Recommmends skipping the specified number of samples
926      * @code
927      * u32le number of samples to skip from start of this packet
928      * u32le number of samples to skip from end of this packet
929      * u8    reason for start skip
930      * u8    reason for end   skip (0=padding silence, 1=convergence)
931      * @endcode
932      */
933     AV_PKT_DATA_SKIP_SAMPLES=70,
934
935     /**
936      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
937      * the packet may contain "dual mono" audio specific to Japanese DTV
938      * and if it is true, recommends only the selected channel to be used.
939      * @code
940      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
941      * @endcode
942      */
943     AV_PKT_DATA_JP_DUALMONO,
944 };
945
946 typedef struct AVPacket {
947     /**
948      * Presentation timestamp in AVStream->time_base units; the time at which
949      * the decompressed packet will be presented to the user.
950      * Can be AV_NOPTS_VALUE if it is not stored in the file.
951      * pts MUST be larger or equal to dts as presentation cannot happen before
952      * decompression, unless one wants to view hex dumps. Some formats misuse
953      * the terms dts and pts/cts to mean something different. Such timestamps
954      * must be converted to true pts/dts before they are stored in AVPacket.
955      */
956     int64_t pts;
957     /**
958      * Decompression timestamp in AVStream->time_base units; the time at which
959      * the packet is decompressed.
960      * Can be AV_NOPTS_VALUE if it is not stored in the file.
961      */
962     int64_t dts;
963     uint8_t *data;
964     int   size;
965     int   stream_index;
966     /**
967      * A combination of AV_PKT_FLAG values
968      */
969     int   flags;
970     /**
971      * Additional packet data that can be provided by the container.
972      * Packet can contain several types of side information.
973      */
974     struct {
975         uint8_t *data;
976         int      size;
977         enum AVPacketSideDataType type;
978     } *side_data;
979     int side_data_elems;
980
981     /**
982      * Duration of this packet in AVStream->time_base units, 0 if unknown.
983      * Equals next_pts - this_pts in presentation order.
984      */
985     int   duration;
986     void  (*destruct)(struct AVPacket *);
987     void  *priv;
988     int64_t pos;                            ///< byte position in stream, -1 if unknown
989
990     /**
991      * Time difference in AVStream->time_base units from the pts of this
992      * packet to the point at which the output from the decoder has converged
993      * independent from the availability of previous frames. That is, the
994      * frames are virtually identical no matter if decoding started from
995      * the very first frame or from this keyframe.
996      * Is AV_NOPTS_VALUE if unknown.
997      * This field is not the display duration of the current packet.
998      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
999      * set.
1000      *
1001      * The purpose of this field is to allow seeking in streams that have no
1002      * keyframes in the conventional sense. It corresponds to the
1003      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1004      * essential for some types of subtitle streams to ensure that all
1005      * subtitles are correctly displayed after seeking.
1006      */
1007     int64_t convergence_duration;
1008 } AVPacket;
1009 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1010 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1011
1012 enum AVSideDataParamChangeFlags {
1013     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1014     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1015     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1016     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1017 };
1018 /**
1019  * @}
1020  */
1021
1022 /**
1023  * Audio Video Frame.
1024  * New fields can be added to the end of AVFRAME with minor version
1025  * bumps. Similarly fields that are marked as to be only accessed by
1026  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1027  * without breaking compatibility with each other.
1028  * Removal, reordering and changes in the remaining cases require
1029  * a major version bump.
1030  * sizeof(AVFrame) must not be used outside libavcodec.
1031  */
1032 typedef struct AVFrame {
1033 #define AV_NUM_DATA_POINTERS 8
1034     /**
1035      * pointer to the picture/channel planes.
1036      * This might be different from the first allocated byte
1037      * - encoding: Set by user
1038      * - decoding: set by AVCodecContext.get_buffer()
1039      */
1040     uint8_t *data[AV_NUM_DATA_POINTERS];
1041
1042     /**
1043      * Size, in bytes, of the data for each picture/channel plane.
1044      *
1045      * For audio, only linesize[0] may be set. For planar audio, each channel
1046      * plane must be the same size.
1047      *
1048      * - encoding: Set by user
1049      * - decoding: set by AVCodecContext.get_buffer()
1050      */
1051     int linesize[AV_NUM_DATA_POINTERS];
1052
1053     /**
1054      * pointers to the data planes/channels.
1055      *
1056      * For video, this should simply point to data[].
1057      *
1058      * For planar audio, each channel has a separate data pointer, and
1059      * linesize[0] contains the size of each channel buffer.
1060      * For packed audio, there is just one data pointer, and linesize[0]
1061      * contains the total size of the buffer for all channels.
1062      *
1063      * Note: Both data and extended_data will always be set by get_buffer(),
1064      * but for planar audio with more channels that can fit in data,
1065      * extended_data must be used by the decoder in order to access all
1066      * channels.
1067      *
1068      * encoding: unused
1069      * decoding: set by AVCodecContext.get_buffer()
1070      */
1071     uint8_t **extended_data;
1072
1073     /**
1074      * width and height of the video frame
1075      * - encoding: unused
1076      * - decoding: Read by user.
1077      */
1078     int width, height;
1079
1080     /**
1081      * number of audio samples (per channel) described by this frame
1082      * - encoding: Set by user
1083      * - decoding: Set by libavcodec
1084      */
1085     int nb_samples;
1086
1087     /**
1088      * format of the frame, -1 if unknown or unset
1089      * Values correspond to enum AVPixelFormat for video frames,
1090      * enum AVSampleFormat for audio)
1091      * - encoding: unused
1092      * - decoding: Read by user.
1093      */
1094     int format;
1095
1096     /**
1097      * 1 -> keyframe, 0-> not
1098      * - encoding: Set by libavcodec.
1099      * - decoding: Set by libavcodec.
1100      */
1101     int key_frame;
1102
1103     /**
1104      * Picture type of the frame, see ?_TYPE below.
1105      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1106      * - decoding: Set by libavcodec.
1107      */
1108     enum AVPictureType pict_type;
1109
1110     /**
1111      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1112      * This isn't used by libavcodec unless the default get/release_buffer() is used.
1113      * - encoding:
1114      * - decoding:
1115      */
1116     uint8_t *base[AV_NUM_DATA_POINTERS];
1117
1118     /**
1119      * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1120      * - encoding: unused
1121      * - decoding: Read by user.
1122      */
1123     AVRational sample_aspect_ratio;
1124
1125     /**
1126      * presentation timestamp in time_base units (time when frame should be shown to user)
1127      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1128      * - encoding: MUST be set by user.
1129      * - decoding: Set by libavcodec.
1130      */
1131     int64_t pts;
1132
1133     /**
1134      * reordered pts from the last AVPacket that has been input into the decoder
1135      * - encoding: unused
1136      * - decoding: Read by user.
1137      */
1138     int64_t pkt_pts;
1139
1140     /**
1141      * dts from the last AVPacket that has been input into the decoder
1142      * - encoding: unused
1143      * - decoding: Read by user.
1144      */
1145     int64_t pkt_dts;
1146
1147     /**
1148      * picture number in bitstream order
1149      * - encoding: set by
1150      * - decoding: Set by libavcodec.
1151      */
1152     int coded_picture_number;
1153     /**
1154      * picture number in display order
1155      * - encoding: set by
1156      * - decoding: Set by libavcodec.
1157      */
1158     int display_picture_number;
1159
1160     /**
1161      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1162      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1163      * - decoding: Set by libavcodec.
1164      */
1165     int quality;
1166
1167     /**
1168      * is this picture used as reference
1169      * The values for this are the same as the MpegEncContext.picture_structure
1170      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1171      * Set to 4 for delayed, non-reference frames.
1172      * - encoding: unused
1173      * - decoding: Set by libavcodec. (before get_buffer() call)).
1174      */
1175     int reference;
1176
1177     /**
1178      * QP table
1179      * - encoding: unused
1180      * - decoding: Set by libavcodec.
1181      */
1182     int8_t *qscale_table;
1183     /**
1184      * QP store stride
1185      * - encoding: unused
1186      * - decoding: Set by libavcodec.
1187      */
1188     int qstride;
1189
1190     /**
1191      *
1192      */
1193     int qscale_type;
1194
1195     /**
1196      * mbskip_table[mb]>=1 if MB didn't change
1197      * stride= mb_width = (width+15)>>4
1198      * - encoding: unused
1199      * - decoding: Set by libavcodec.
1200      */
1201     uint8_t *mbskip_table;
1202
1203     /**
1204      * motion vector table
1205      * @code
1206      * example:
1207      * int mv_sample_log2= 4 - motion_subsample_log2;
1208      * int mb_width= (width+15)>>4;
1209      * int mv_stride= (mb_width << mv_sample_log2) + 1;
1210      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1211      * @endcode
1212      * - encoding: Set by user.
1213      * - decoding: Set by libavcodec.
1214      */
1215     int16_t (*motion_val[2])[2];
1216
1217     /**
1218      * macroblock type table
1219      * mb_type_base + mb_width + 2
1220      * - encoding: Set by user.
1221      * - decoding: Set by libavcodec.
1222      */
1223     uint32_t *mb_type;
1224
1225     /**
1226      * DCT coefficients
1227      * - encoding: unused
1228      * - decoding: Set by libavcodec.
1229      */
1230     short *dct_coeff;
1231
1232     /**
1233      * motion reference frame index
1234      * the order in which these are stored can depend on the codec.
1235      * - encoding: Set by user.
1236      * - decoding: Set by libavcodec.
1237      */
1238     int8_t *ref_index[2];
1239
1240     /**
1241      * for some private data of the user
1242      * - encoding: unused
1243      * - decoding: Set by user.
1244      */
1245     void *opaque;
1246
1247     /**
1248      * error
1249      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1250      * - decoding: unused
1251      */
1252     uint64_t error[AV_NUM_DATA_POINTERS];
1253
1254     /**
1255      * type of the buffer (to keep track of who has to deallocate data[*])
1256      * - encoding: Set by the one who allocates it.
1257      * - decoding: Set by the one who allocates it.
1258      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1259      */
1260     int type;
1261
1262     /**
1263      * When decoding, this signals how much the picture must be delayed.
1264      * extra_delay = repeat_pict / (2*fps)
1265      * - encoding: unused
1266      * - decoding: Set by libavcodec.
1267      */
1268     int repeat_pict;
1269
1270     /**
1271      * The content of the picture is interlaced.
1272      * - encoding: Set by user.
1273      * - decoding: Set by libavcodec. (default 0)
1274      */
1275     int interlaced_frame;
1276
1277     /**
1278      * If the content is interlaced, is top field displayed first.
1279      * - encoding: Set by user.
1280      * - decoding: Set by libavcodec.
1281      */
1282     int top_field_first;
1283
1284     /**
1285      * Tell user application that palette has changed from previous frame.
1286      * - encoding: ??? (no palette-enabled encoder yet)
1287      * - decoding: Set by libavcodec. (default 0).
1288      */
1289     int palette_has_changed;
1290
1291     /**
1292      * codec suggestion on buffer type if != 0
1293      * - encoding: unused
1294      * - decoding: Set by libavcodec. (before get_buffer() call)).
1295      */
1296     int buffer_hints;
1297
1298     /**
1299      * Pan scan.
1300      * - encoding: Set by user.
1301      * - decoding: Set by libavcodec.
1302      */
1303     AVPanScan *pan_scan;
1304
1305     /**
1306      * reordered opaque 64bit (generally an integer or a double precision float
1307      * PTS but can be anything).
1308      * The user sets AVCodecContext.reordered_opaque to represent the input at
1309      * that time,
1310      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1311      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1312      * @deprecated in favor of pkt_pts
1313      * - encoding: unused
1314      * - decoding: Read by user.
1315      */
1316     int64_t reordered_opaque;
1317
1318     /**
1319      * hardware accelerator private data (FFmpeg-allocated)
1320      * - encoding: unused
1321      * - decoding: Set by libavcodec
1322      */
1323     void *hwaccel_picture_private;
1324
1325     /**
1326      * the AVCodecContext which ff_thread_get_buffer() was last called on
1327      * - encoding: Set by libavcodec.
1328      * - decoding: Set by libavcodec.
1329      */
1330     struct AVCodecContext *owner;
1331
1332     /**
1333      * used by multithreading to store frame-specific info
1334      * - encoding: Set by libavcodec.
1335      * - decoding: Set by libavcodec.
1336      */
1337     void *thread_opaque;
1338
1339     /**
1340      * log2 of the size of the block which a single vector in motion_val represents:
1341      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1342      * - encoding: unused
1343      * - decoding: Set by libavcodec.
1344      */
1345     uint8_t motion_subsample_log2;
1346
1347     /**
1348      * Sample rate of the audio data.
1349      *
1350      * - encoding: unused
1351      * - decoding: read by user
1352      */
1353     int sample_rate;
1354
1355     /**
1356      * Channel layout of the audio data.
1357      *
1358      * - encoding: unused
1359      * - decoding: read by user.
1360      */
1361     uint64_t channel_layout;
1362
1363     /**
1364      * frame timestamp estimated using various heuristics, in stream time base
1365      * Code outside libavcodec should access this field using:
1366      * av_frame_get_best_effort_timestamp(frame)
1367      * - encoding: unused
1368      * - decoding: set by libavcodec, read by user.
1369      */
1370     int64_t best_effort_timestamp;
1371
1372     /**
1373      * reordered pos from the last AVPacket that has been input into the decoder
1374      * Code outside libavcodec should access this field using:
1375      * av_frame_get_pkt_pos(frame)
1376      * - encoding: unused
1377      * - decoding: Read by user.
1378      */
1379     int64_t pkt_pos;
1380
1381     /**
1382      * duration of the corresponding packet, expressed in
1383      * AVStream->time_base units, 0 if unknown.
1384      * Code outside libavcodec should access this field using:
1385      * av_frame_get_pkt_duration(frame)
1386      * - encoding: unused
1387      * - decoding: Read by user.
1388      */
1389     int64_t pkt_duration;
1390
1391     /**
1392      * metadata.
1393      * Code outside libavcodec should access this field using:
1394      * av_frame_get_metadata(frame)
1395      * - encoding: Set by user.
1396      * - decoding: Set by libavcodec.
1397      */
1398     AVDictionary *metadata;
1399
1400     /**
1401      * decode error flags of the frame, set to a combination of
1402      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1403      * were errors during the decoding.
1404      * Code outside libavcodec should access this field using:
1405      * av_frame_get_decode_error_flags(frame)
1406      * - encoding: unused
1407      * - decoding: set by libavcodec, read by user.
1408      */
1409     int decode_error_flags;
1410 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
1411 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
1412
1413     /**
1414      * number of audio channels, only used for audio.
1415      * Code outside libavcodec should access this field using:
1416      * av_frame_get_channels(frame)
1417      * - encoding: unused
1418      * - decoding: Read by user.
1419      */
1420     int64_t channels;
1421 } AVFrame;
1422
1423 /**
1424  * Accessors for some AVFrame fields.
1425  * The position of these field in the structure is not part of the ABI,
1426  * they should not be accessed directly outside libavcodec.
1427  */
1428 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1429 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1430 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
1431 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
1432 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
1433 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
1434 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
1435 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
1436 int     av_frame_get_channels             (const AVFrame *frame);
1437 void    av_frame_set_channels             (AVFrame *frame, int     val);
1438 int     av_frame_get_sample_rate          (const AVFrame *frame);
1439 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
1440 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
1441 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
1442 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
1443 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
1444
1445 struct AVCodecInternal;
1446
1447 enum AVFieldOrder {
1448     AV_FIELD_UNKNOWN,
1449     AV_FIELD_PROGRESSIVE,
1450     AV_FIELD_TT,          //< Top coded_first, top displayed first
1451     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1452     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1453     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1454 };
1455
1456 /**
1457  * main external API structure.
1458  * New fields can be added to the end with minor version bumps.
1459  * Removal, reordering and changes to existing fields require a major
1460  * version bump.
1461  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1462  * applications.
1463  * sizeof(AVCodecContext) must not be used outside libav*.
1464  */
1465 typedef struct AVCodecContext {
1466     /**
1467      * information on struct for av_log
1468      * - set by avcodec_alloc_context3
1469      */
1470     const AVClass *av_class;
1471     int log_level_offset;
1472
1473     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1474     const struct AVCodec  *codec;
1475     char             codec_name[32];
1476     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1477
1478     /**
1479      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1480      * This is used to work around some encoder bugs.
1481      * A demuxer should set this to what is stored in the field used to identify the codec.
1482      * If there are multiple such fields in a container then the demuxer should choose the one
1483      * which maximizes the information about the used codec.
1484      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1485      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1486      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1487      * first.
1488      * - encoding: Set by user, if not then the default based on codec_id will be used.
1489      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1490      */
1491     unsigned int codec_tag;
1492
1493     /**
1494      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1495      * This is used to work around some encoder bugs.
1496      * - encoding: unused
1497      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1498      */
1499     unsigned int stream_codec_tag;
1500
1501 #if FF_API_SUB_ID
1502     /**
1503      * @deprecated this field is unused
1504      */
1505     attribute_deprecated int sub_id;
1506 #endif
1507
1508     void *priv_data;
1509
1510     /**
1511      * Private context used for internal data.
1512      *
1513      * Unlike priv_data, this is not codec-specific. It is used in general
1514      * libavcodec functions.
1515      */
1516     struct AVCodecInternal *internal;
1517
1518     /**
1519      * Private data of the user, can be used to carry app specific stuff.
1520      * - encoding: Set by user.
1521      * - decoding: Set by user.
1522      */
1523     void *opaque;
1524
1525     /**
1526      * the average bitrate
1527      * - encoding: Set by user; unused for constant quantizer encoding.
1528      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1529      */
1530     int bit_rate;
1531
1532     /**
1533      * number of bits the bitstream is allowed to diverge from the reference.
1534      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1535      * - encoding: Set by user; unused for constant quantizer encoding.
1536      * - decoding: unused
1537      */
1538     int bit_rate_tolerance;
1539
1540     /**
1541      * Global quality for codecs which cannot change it per frame.
1542      * This should be proportional to MPEG-1/2/4 qscale.
1543      * - encoding: Set by user.
1544      * - decoding: unused
1545      */
1546     int global_quality;
1547
1548     /**
1549      * - encoding: Set by user.
1550      * - decoding: unused
1551      */
1552     int compression_level;
1553 #define FF_COMPRESSION_DEFAULT -1
1554
1555     /**
1556      * CODEC_FLAG_*.
1557      * - encoding: Set by user.
1558      * - decoding: Set by user.
1559      */
1560     int flags;
1561
1562     /**
1563      * CODEC_FLAG2_*
1564      * - encoding: Set by user.
1565      * - decoding: Set by user.
1566      */
1567     int flags2;
1568
1569     /**
1570      * some codecs need / can use extradata like Huffman tables.
1571      * mjpeg: Huffman tables
1572      * rv10: additional flags
1573      * mpeg4: global headers (they can be in the bitstream or here)
1574      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1575      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1576      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1577      * - encoding: Set/allocated/freed by libavcodec.
1578      * - decoding: Set/allocated/freed by user.
1579      */
1580     uint8_t *extradata;
1581     int extradata_size;
1582
1583     /**
1584      * This is the fundamental unit of time (in seconds) in terms
1585      * of which frame timestamps are represented. For fixed-fps content,
1586      * timebase should be 1/framerate and timestamp increments should be
1587      * identically 1.
1588      * - encoding: MUST be set by user.
1589      * - decoding: Set by libavcodec.
1590      */
1591     AVRational time_base;
1592
1593     /**
1594      * For some codecs, the time base is closer to the field rate than the frame rate.
1595      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1596      * if no telecine is used ...
1597      *
1598      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1599      */
1600     int ticks_per_frame;
1601
1602     /**
1603      * Encoding: Number of frames delay there will be from the encoder input to
1604      *           the decoder output. (we assume the decoder matches the spec)
1605      * Decoding: Number of frames delay in addition to what a standard decoder
1606      *           as specified in the spec would produce.
1607      *
1608      * Video:
1609      *   Number of frames the decoded output will be delayed relative to the
1610      *   encoded input.
1611      *
1612      * Audio:
1613      *   For encoding, this is the number of "priming" samples added to the
1614      *   beginning of the stream. The decoded output will be delayed by this
1615      *   many samples relative to the input to the encoder. Note that this
1616      *   field is purely informational and does not directly affect the pts
1617      *   output by the encoder, which should always be based on the actual
1618      *   presentation time, including any delay.
1619      *   For decoding, this is the number of samples the decoder needs to
1620      *   output before the decoder's output is valid. When seeking, you should
1621      *   start decoding this many samples prior to your desired seek point.
1622      *
1623      * - encoding: Set by libavcodec.
1624      * - decoding: Set by libavcodec.
1625      */
1626     int delay;
1627
1628
1629     /* video only */
1630     /**
1631      * picture width / height.
1632      * - encoding: MUST be set by user.
1633      * - decoding: Set by libavcodec.
1634      * Note: For compatibility it is possible to set this instead of
1635      * coded_width/height before decoding.
1636      */
1637     int width, height;
1638
1639     /**
1640      * Bitstream width / height, may be different from width/height if lowres enabled.
1641      * - encoding: unused
1642      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1643      */
1644     int coded_width, coded_height;
1645
1646 #define FF_ASPECT_EXTENDED 15
1647
1648     /**
1649      * the number of pictures in a group of pictures, or 0 for intra_only
1650      * - encoding: Set by user.
1651      * - decoding: unused
1652      */
1653     int gop_size;
1654
1655     /**
1656      * Pixel format, see AV_PIX_FMT_xxx.
1657      * May be set by the demuxer if known from headers.
1658      * May be overridden by the decoder if it knows better.
1659      * - encoding: Set by user.
1660      * - decoding: Set by user if known, overridden by libavcodec if known
1661      */
1662     enum AVPixelFormat pix_fmt;
1663
1664     /**
1665      * Motion estimation algorithm used for video coding.
1666      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1667      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1668      * - encoding: MUST be set by user.
1669      * - decoding: unused
1670      */
1671     int me_method;
1672
1673     /**
1674      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1675      * decoder to draw a horizontal band. It improves cache usage. Not
1676      * all codecs can do that. You must check the codec capabilities
1677      * beforehand.
1678      * When multithreading is used, it may be called from multiple threads
1679      * at the same time; threads might draw different parts of the same AVFrame,
1680      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1681      * in order.
1682      * The function is also used by hardware acceleration APIs.
1683      * It is called at least once during frame decoding to pass
1684      * the data needed for hardware render.
1685      * In that mode instead of pixel data, AVFrame points to
1686      * a structure specific to the acceleration API. The application
1687      * reads the structure and can change some fields to indicate progress
1688      * or mark state.
1689      * - encoding: unused
1690      * - decoding: Set by user.
1691      * @param height the height of the slice
1692      * @param y the y position of the slice
1693      * @param type 1->top field, 2->bottom field, 3->frame
1694      * @param offset offset into the AVFrame.data from which the slice should be read
1695      */
1696     void (*draw_horiz_band)(struct AVCodecContext *s,
1697                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1698                             int y, int type, int height);
1699
1700     /**
1701      * callback to negotiate the pixelFormat
1702      * @param fmt is the list of formats which are supported by the codec,
1703      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1704      * The first is always the native one.
1705      * @return the chosen format
1706      * - encoding: unused
1707      * - decoding: Set by user, if not set the native format will be chosen.
1708      */
1709     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1710
1711     /**
1712      * maximum number of B-frames between non-B-frames
1713      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1714      * - encoding: Set by user.
1715      * - decoding: unused
1716      */
1717     int max_b_frames;
1718
1719     /**
1720      * qscale factor between IP and B-frames
1721      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1722      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1723      * - encoding: Set by user.
1724      * - decoding: unused
1725      */
1726     float b_quant_factor;
1727
1728     /** obsolete FIXME remove */
1729     int rc_strategy;
1730 #define FF_RC_STRATEGY_XVID 1
1731
1732     int b_frame_strategy;
1733
1734 #if FF_API_MPV_GLOBAL_OPTS
1735     /**
1736      * luma single coefficient elimination threshold
1737      * - encoding: Set by user.
1738      * - decoding: unused
1739      */
1740     attribute_deprecated int luma_elim_threshold;
1741
1742     /**
1743      * chroma single coeff elimination threshold
1744      * - encoding: Set by user.
1745      * - decoding: unused
1746      */
1747     attribute_deprecated int chroma_elim_threshold;
1748 #endif
1749
1750     /**
1751      * qscale offset between IP and B-frames
1752      * - encoding: Set by user.
1753      * - decoding: unused
1754      */
1755     float b_quant_offset;
1756
1757     /**
1758      * Size of the frame reordering buffer in the decoder.
1759      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1760      * - encoding: Set by libavcodec.
1761      * - decoding: Set by libavcodec.
1762      */
1763     int has_b_frames;
1764
1765     /**
1766      * 0-> h263 quant 1-> mpeg quant
1767      * - encoding: Set by user.
1768      * - decoding: unused
1769      */
1770     int mpeg_quant;
1771
1772     /**
1773      * qscale factor between P and I-frames
1774      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1775      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1776      * - encoding: Set by user.
1777      * - decoding: unused
1778      */
1779     float i_quant_factor;
1780
1781     /**
1782      * qscale offset between P and I-frames
1783      * - encoding: Set by user.
1784      * - decoding: unused
1785      */
1786     float i_quant_offset;
1787
1788     /**
1789      * luminance masking (0-> disabled)
1790      * - encoding: Set by user.
1791      * - decoding: unused
1792      */
1793     float lumi_masking;
1794
1795     /**
1796      * temporary complexity masking (0-> disabled)
1797      * - encoding: Set by user.
1798      * - decoding: unused
1799      */
1800     float temporal_cplx_masking;
1801
1802     /**
1803      * spatial complexity masking (0-> disabled)
1804      * - encoding: Set by user.
1805      * - decoding: unused
1806      */
1807     float spatial_cplx_masking;
1808
1809     /**
1810      * p block masking (0-> disabled)
1811      * - encoding: Set by user.
1812      * - decoding: unused
1813      */
1814     float p_masking;
1815
1816     /**
1817      * darkness masking (0-> disabled)
1818      * - encoding: Set by user.
1819      * - decoding: unused
1820      */
1821     float dark_masking;
1822
1823     /**
1824      * slice count
1825      * - encoding: Set by libavcodec.
1826      * - decoding: Set by user (or 0).
1827      */
1828     int slice_count;
1829     /**
1830      * prediction method (needed for huffyuv)
1831      * - encoding: Set by user.
1832      * - decoding: unused
1833      */
1834      int prediction_method;
1835 #define FF_PRED_LEFT   0
1836 #define FF_PRED_PLANE  1
1837 #define FF_PRED_MEDIAN 2
1838
1839     /**
1840      * slice offsets in the frame in bytes
1841      * - encoding: Set/allocated by libavcodec.
1842      * - decoding: Set/allocated by user (or NULL).
1843      */
1844     int *slice_offset;
1845
1846     /**
1847      * sample aspect ratio (0 if unknown)
1848      * That is the width of a pixel divided by the height of the pixel.
1849      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1850      * - encoding: Set by user.
1851      * - decoding: Set by libavcodec.
1852      */
1853     AVRational sample_aspect_ratio;
1854
1855     /**
1856      * motion estimation comparison function
1857      * - encoding: Set by user.
1858      * - decoding: unused
1859      */
1860     int me_cmp;
1861     /**
1862      * subpixel motion estimation comparison function
1863      * - encoding: Set by user.
1864      * - decoding: unused
1865      */
1866     int me_sub_cmp;
1867     /**
1868      * macroblock comparison function (not supported yet)
1869      * - encoding: Set by user.
1870      * - decoding: unused
1871      */
1872     int mb_cmp;
1873     /**
1874      * interlaced DCT comparison function
1875      * - encoding: Set by user.
1876      * - decoding: unused
1877      */
1878     int ildct_cmp;
1879 #define FF_CMP_SAD    0
1880 #define FF_CMP_SSE    1
1881 #define FF_CMP_SATD   2
1882 #define FF_CMP_DCT    3
1883 #define FF_CMP_PSNR   4
1884 #define FF_CMP_BIT    5
1885 #define FF_CMP_RD     6
1886 #define FF_CMP_ZERO   7
1887 #define FF_CMP_VSAD   8
1888 #define FF_CMP_VSSE   9
1889 #define FF_CMP_NSSE   10
1890 #define FF_CMP_W53    11
1891 #define FF_CMP_W97    12
1892 #define FF_CMP_DCTMAX 13
1893 #define FF_CMP_DCT264 14
1894 #define FF_CMP_CHROMA 256
1895
1896     /**
1897      * ME diamond size & shape
1898      * - encoding: Set by user.
1899      * - decoding: unused
1900      */
1901     int dia_size;
1902
1903     /**
1904      * amount of previous MV predictors (2a+1 x 2a+1 square)
1905      * - encoding: Set by user.
1906      * - decoding: unused
1907      */
1908     int last_predictor_count;
1909
1910     /**
1911      * prepass for motion estimation
1912      * - encoding: Set by user.
1913      * - decoding: unused
1914      */
1915     int pre_me;
1916
1917     /**
1918      * motion estimation prepass comparison function
1919      * - encoding: Set by user.
1920      * - decoding: unused
1921      */
1922     int me_pre_cmp;
1923
1924     /**
1925      * ME prepass diamond size & shape
1926      * - encoding: Set by user.
1927      * - decoding: unused
1928      */
1929     int pre_dia_size;
1930
1931     /**
1932      * subpel ME quality
1933      * - encoding: Set by user.
1934      * - decoding: unused
1935      */
1936     int me_subpel_quality;
1937
1938     /**
1939      * DTG active format information (additional aspect ratio
1940      * information only used in DVB MPEG-2 transport streams)
1941      * 0 if not set.
1942      *
1943      * - encoding: unused
1944      * - decoding: Set by decoder.
1945      */
1946     int dtg_active_format;
1947 #define FF_DTG_AFD_SAME         8
1948 #define FF_DTG_AFD_4_3          9
1949 #define FF_DTG_AFD_16_9         10
1950 #define FF_DTG_AFD_14_9         11
1951 #define FF_DTG_AFD_4_3_SP_14_9  13
1952 #define FF_DTG_AFD_16_9_SP_14_9 14
1953 #define FF_DTG_AFD_SP_4_3       15
1954
1955     /**
1956      * maximum motion estimation search range in subpel units
1957      * If 0 then no limit.
1958      *
1959      * - encoding: Set by user.
1960      * - decoding: unused
1961      */
1962     int me_range;
1963
1964     /**
1965      * intra quantizer bias
1966      * - encoding: Set by user.
1967      * - decoding: unused
1968      */
1969     int intra_quant_bias;
1970 #define FF_DEFAULT_QUANT_BIAS 999999
1971
1972     /**
1973      * inter quantizer bias
1974      * - encoding: Set by user.
1975      * - decoding: unused
1976      */
1977     int inter_quant_bias;
1978
1979 #if FF_API_COLOR_TABLE_ID
1980     /**
1981      * color table ID
1982      * - encoding: unused
1983      * - decoding: Which clrtable should be used for 8bit RGB images.
1984      *             Tables have to be stored somewhere. FIXME
1985      */
1986     attribute_deprecated int color_table_id;
1987 #endif
1988
1989     /**
1990      * slice flags
1991      * - encoding: unused
1992      * - decoding: Set by user.
1993      */
1994     int slice_flags;
1995 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1996 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1997 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1998
1999     /**
2000      * XVideo Motion Acceleration
2001      * - encoding: forbidden
2002      * - decoding: set by decoder
2003      */
2004     int xvmc_acceleration;
2005
2006     /**
2007      * macroblock decision mode
2008      * - encoding: Set by user.
2009      * - decoding: unused
2010      */
2011     int mb_decision;
2012 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2013 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2014 #define FF_MB_DECISION_RD     2        ///< rate distortion
2015
2016     /**
2017      * custom intra quantization matrix
2018      * - encoding: Set by user, can be NULL.
2019      * - decoding: Set by libavcodec.
2020      */
2021     uint16_t *intra_matrix;
2022
2023     /**
2024      * custom inter quantization matrix
2025      * - encoding: Set by user, can be NULL.
2026      * - decoding: Set by libavcodec.
2027      */
2028     uint16_t *inter_matrix;
2029
2030     /**
2031      * scene change detection threshold
2032      * 0 is default, larger means fewer detected scene changes.
2033      * - encoding: Set by user.
2034      * - decoding: unused
2035      */
2036     int scenechange_threshold;
2037
2038     /**
2039      * noise reduction strength
2040      * - encoding: Set by user.
2041      * - decoding: unused
2042      */
2043     int noise_reduction;
2044
2045 #if FF_API_INTER_THRESHOLD
2046     /**
2047      * @deprecated this field is unused
2048      */
2049     attribute_deprecated int inter_threshold;
2050 #endif
2051
2052 #if FF_API_MPV_GLOBAL_OPTS
2053     /**
2054      * @deprecated use mpegvideo private options instead
2055      */
2056     attribute_deprecated int quantizer_noise_shaping;
2057 #endif
2058
2059     /**
2060      * Motion estimation threshold below which no motion estimation is
2061      * performed, but instead the user specified motion vectors are used.
2062      *
2063      * - encoding: Set by user.
2064      * - decoding: unused
2065      */
2066     int me_threshold;
2067
2068     /**
2069      * Macroblock threshold below which the user specified macroblock types will be used.
2070      * - encoding: Set by user.
2071      * - decoding: unused
2072      */
2073     int mb_threshold;
2074
2075     /**
2076      * precision of the intra DC coefficient - 8
2077      * - encoding: Set by user.
2078      * - decoding: unused
2079      */
2080     int intra_dc_precision;
2081
2082     /**
2083      * Number of macroblock rows at the top which are skipped.
2084      * - encoding: unused
2085      * - decoding: Set by user.
2086      */
2087     int skip_top;
2088
2089     /**
2090      * Number of macroblock rows at the bottom which are skipped.
2091      * - encoding: unused
2092      * - decoding: Set by user.
2093      */
2094     int skip_bottom;
2095
2096     /**
2097      * Border processing masking, raises the quantizer for mbs on the borders
2098      * of the picture.
2099      * - encoding: Set by user.
2100      * - decoding: unused
2101      */
2102     float border_masking;
2103
2104     /**
2105      * minimum MB lagrange multipler
2106      * - encoding: Set by user.
2107      * - decoding: unused
2108      */
2109     int mb_lmin;
2110
2111     /**
2112      * maximum MB lagrange multipler
2113      * - encoding: Set by user.
2114      * - decoding: unused
2115      */
2116     int mb_lmax;
2117
2118     /**
2119      *
2120      * - encoding: Set by user.
2121      * - decoding: unused
2122      */
2123     int me_penalty_compensation;
2124
2125     /**
2126      *
2127      * - encoding: Set by user.
2128      * - decoding: unused
2129      */
2130     int bidir_refine;
2131
2132     /**
2133      *
2134      * - encoding: Set by user.
2135      * - decoding: unused
2136      */
2137     int brd_scale;
2138
2139     /**
2140      * minimum GOP size
2141      * - encoding: Set by user.
2142      * - decoding: unused
2143      */
2144     int keyint_min;
2145
2146     /**
2147      * number of reference frames
2148      * - encoding: Set by user.
2149      * - decoding: Set by lavc.
2150      */
2151     int refs;
2152
2153     /**
2154      * chroma qp offset from luma
2155      * - encoding: Set by user.
2156      * - decoding: unused
2157      */
2158     int chromaoffset;
2159
2160     /**
2161      * Multiplied by qscale for each frame and added to scene_change_score.
2162      * - encoding: Set by user.
2163      * - decoding: unused
2164      */
2165     int scenechange_factor;
2166
2167     /**
2168      *
2169      * Note: Value depends upon the compare function used for fullpel ME.
2170      * - encoding: Set by user.
2171      * - decoding: unused
2172      */
2173     int mv0_threshold;
2174
2175     /**
2176      * Adjust sensitivity of b_frame_strategy 1.
2177      * - encoding: Set by user.
2178      * - decoding: unused
2179      */
2180     int b_sensitivity;
2181
2182     /**
2183      * Chromaticity coordinates of the source primaries.
2184      * - encoding: Set by user
2185      * - decoding: Set by libavcodec
2186      */
2187     enum AVColorPrimaries color_primaries;
2188
2189     /**
2190      * Color Transfer Characteristic.
2191      * - encoding: Set by user
2192      * - decoding: Set by libavcodec
2193      */
2194     enum AVColorTransferCharacteristic color_trc;
2195
2196     /**
2197      * YUV colorspace type.
2198      * - encoding: Set by user
2199      * - decoding: Set by libavcodec
2200      */
2201     enum AVColorSpace colorspace;
2202
2203     /**
2204      * MPEG vs JPEG YUV range.
2205      * - encoding: Set by user
2206      * - decoding: Set by libavcodec
2207      */
2208     enum AVColorRange color_range;
2209
2210     /**
2211      * This defines the location of chroma samples.
2212      * - encoding: Set by user
2213      * - decoding: Set by libavcodec
2214      */
2215     enum AVChromaLocation chroma_sample_location;
2216
2217     /**
2218      * Number of slices.
2219      * Indicates number of picture subdivisions. Used for parallelized
2220      * decoding.
2221      * - encoding: Set by user
2222      * - decoding: unused
2223      */
2224     int slices;
2225
2226     /** Field order
2227      * - encoding: set by libavcodec
2228      * - decoding: Set by user.
2229      */
2230     enum AVFieldOrder field_order;
2231
2232     /* audio only */
2233     int sample_rate; ///< samples per second
2234     int channels;    ///< number of audio channels
2235
2236     /**
2237      * audio sample format
2238      * - encoding: Set by user.
2239      * - decoding: Set by libavcodec.
2240      */
2241     enum AVSampleFormat sample_fmt;  ///< sample format
2242
2243     /* The following data should not be initialized. */
2244     /**
2245      * Samples per packet, initialized when calling 'init'.
2246      */
2247     int frame_size;
2248
2249     /**
2250      * Frame counter, set by libavcodec.
2251      *
2252      * - decoding: total number of frames returned from the decoder so far.
2253      * - encoding: total number of frames passed to the encoder so far.
2254      *
2255      *   @note the counter is not incremented if encoding/decoding resulted in
2256      *   an error.
2257      */
2258     int frame_number;
2259
2260     /**
2261      * number of bytes per packet if constant and known or 0
2262      * Used by some WAV based audio codecs.
2263      */
2264     int block_align;
2265
2266     /**
2267      * Audio cutoff bandwidth (0 means "automatic")
2268      * - encoding: Set by user.
2269      * - decoding: unused
2270      */
2271     int cutoff;
2272
2273 #if FF_API_REQUEST_CHANNELS
2274     /**
2275      * Decoder should decode to this many channels if it can (0 for default)
2276      * - encoding: unused
2277      * - decoding: Set by user.
2278      * @deprecated Deprecated in favor of request_channel_layout.
2279      */
2280     int request_channels;
2281 #endif
2282
2283     /**
2284      * Audio channel layout.
2285      * - encoding: set by user.
2286      * - decoding: set by user, may be overwritten by libavcodec.
2287      */
2288     uint64_t channel_layout;
2289
2290     /**
2291      * Request decoder to use this channel layout if it can (0 for default)
2292      * - encoding: unused
2293      * - decoding: Set by user.
2294      */
2295     uint64_t request_channel_layout;
2296
2297     /**
2298      * Type of service that the audio stream conveys.
2299      * - encoding: Set by user.
2300      * - decoding: Set by libavcodec.
2301      */
2302     enum AVAudioServiceType audio_service_type;
2303
2304     /**
2305      * desired sample format
2306      * - encoding: Not used.
2307      * - decoding: Set by user.
2308      * Decoder will decode to this format if it can.
2309      */
2310     enum AVSampleFormat request_sample_fmt;
2311
2312     /**
2313      * Called at the beginning of each frame to get a buffer for it.
2314      *
2315      * The function will set AVFrame.data[], AVFrame.linesize[].
2316      * AVFrame.extended_data[] must also be set, but it should be the same as
2317      * AVFrame.data[] except for planar audio with more channels than can fit
2318      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2319      * many data pointers as it can hold.
2320      *
2321      * if CODEC_CAP_DR1 is not set then get_buffer() must call
2322      * avcodec_default_get_buffer() instead of providing buffers allocated by
2323      * some other means.
2324      *
2325      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2326      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2327      * but if get_buffer() is overridden then alignment considerations should
2328      * be taken into account.
2329      *
2330      * @see avcodec_default_get_buffer()
2331      *
2332      * Video:
2333      *
2334      * If pic.reference is set then the frame will be read later by libavcodec.
2335      * avcodec_align_dimensions2() should be used to find the required width and
2336      * height, as they normally need to be rounded up to the next multiple of 16.
2337      *
2338      * If frame multithreading is used and thread_safe_callbacks is set,
2339      * it may be called from a different thread, but not from more than one at
2340      * once. Does not need to be reentrant.
2341      *
2342      * @see release_buffer(), reget_buffer()
2343      * @see avcodec_align_dimensions2()
2344      *
2345      * Audio:
2346      *
2347      * Decoders request a buffer of a particular size by setting
2348      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2349      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2350      * to a smaller value in the output frame.
2351      *
2352      * Decoders cannot use the buffer after returning from
2353      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2354      * is assumed to be released immediately upon return.
2355      *
2356      * As a convenience, av_samples_get_buffer_size() and
2357      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2358      * functions to find the required data size and to fill data pointers and
2359      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2360      * since all planes must be the same size.
2361      *
2362      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2363      *
2364      * - encoding: unused
2365      * - decoding: Set by libavcodec, user can override.
2366      */
2367     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2368
2369     /**
2370      * Called to release buffers which were allocated with get_buffer.
2371      * A released buffer can be reused in get_buffer().
2372      * pic.data[*] must be set to NULL.
2373      * May be called from a different thread if frame multithreading is used,
2374      * but not by more than one thread at once, so does not need to be reentrant.
2375      * - encoding: unused
2376      * - decoding: Set by libavcodec, user can override.
2377      */
2378     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2379
2380     /**
2381      * Called at the beginning of a frame to get cr buffer for it.
2382      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2383      * libavcodec will pass previous buffer in pic, function should return
2384      * same buffer or new buffer with old frame "painted" into it.
2385      * If pic.data[0] == NULL must behave like get_buffer().
2386      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2387      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2388      * some other means.
2389      * - encoding: unused
2390      * - decoding: Set by libavcodec, user can override.
2391      */
2392     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2393
2394
2395     /* - encoding parameters */
2396     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2397     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2398
2399     /**
2400      * minimum quantizer
2401      * - encoding: Set by user.
2402      * - decoding: unused
2403      */
2404     int qmin;
2405
2406     /**
2407      * maximum quantizer
2408      * - encoding: Set by user.
2409      * - decoding: unused
2410      */
2411     int qmax;
2412
2413     /**
2414      * maximum quantizer difference between frames
2415      * - encoding: Set by user.
2416      * - decoding: unused
2417      */
2418     int max_qdiff;
2419
2420     /**
2421      * ratecontrol qmin qmax limiting method
2422      * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2423      * - encoding: Set by user.
2424      * - decoding: unused
2425      */
2426     float rc_qsquish;
2427
2428     float rc_qmod_amp;
2429     int rc_qmod_freq;
2430
2431     /**
2432      * decoder bitstream buffer size
2433      * - encoding: Set by user.
2434      * - decoding: unused
2435      */
2436     int rc_buffer_size;
2437
2438     /**
2439      * ratecontrol override, see RcOverride
2440      * - encoding: Allocated/set/freed by user.
2441      * - decoding: unused
2442      */
2443     int rc_override_count;
2444     RcOverride *rc_override;
2445
2446     /**
2447      * rate control equation
2448      * - encoding: Set by user
2449      * - decoding: unused
2450      */
2451     const char *rc_eq;
2452
2453     /**
2454      * maximum bitrate
2455      * - encoding: Set by user.
2456      * - decoding: unused
2457      */
2458     int rc_max_rate;
2459
2460     /**
2461      * minimum bitrate
2462      * - encoding: Set by user.
2463      * - decoding: unused
2464      */
2465     int rc_min_rate;
2466
2467     float rc_buffer_aggressivity;
2468
2469     /**
2470      * initial complexity for pass1 ratecontrol
2471      * - encoding: Set by user.
2472      * - decoding: unused
2473      */
2474     float rc_initial_cplx;
2475
2476     /**
2477      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2478      * - encoding: Set by user.
2479      * - decoding: unused.
2480      */
2481     float rc_max_available_vbv_use;
2482
2483     /**
2484      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2485      * - encoding: Set by user.
2486      * - decoding: unused.
2487      */
2488     float rc_min_vbv_overflow_use;
2489
2490     /**
2491      * Number of bits which should be loaded into the rc buffer before decoding starts.
2492      * - encoding: Set by user.
2493      * - decoding: unused
2494      */
2495     int rc_initial_buffer_occupancy;
2496
2497 #define FF_CODER_TYPE_VLC       0
2498 #define FF_CODER_TYPE_AC        1
2499 #define FF_CODER_TYPE_RAW       2
2500 #define FF_CODER_TYPE_RLE       3
2501 #define FF_CODER_TYPE_DEFLATE   4
2502     /**
2503      * coder type
2504      * - encoding: Set by user.
2505      * - decoding: unused
2506      */
2507     int coder_type;
2508
2509     /**
2510      * context model
2511      * - encoding: Set by user.
2512      * - decoding: unused
2513      */
2514     int context_model;
2515
2516     /**
2517      * minimum Lagrange multipler
2518      * - encoding: Set by user.
2519      * - decoding: unused
2520      */
2521     int lmin;
2522
2523     /**
2524      * maximum Lagrange multipler
2525      * - encoding: Set by user.
2526      * - decoding: unused
2527      */
2528     int lmax;
2529
2530     /**
2531      * frame skip threshold
2532      * - encoding: Set by user.
2533      * - decoding: unused
2534      */
2535     int frame_skip_threshold;
2536
2537     /**
2538      * frame skip factor
2539      * - encoding: Set by user.
2540      * - decoding: unused
2541      */
2542     int frame_skip_factor;
2543
2544     /**
2545      * frame skip exponent
2546      * - encoding: Set by user.
2547      * - decoding: unused
2548      */
2549     int frame_skip_exp;
2550
2551     /**
2552      * frame skip comparison function
2553      * - encoding: Set by user.
2554      * - decoding: unused
2555      */
2556     int frame_skip_cmp;
2557
2558     /**
2559      * trellis RD quantization
2560      * - encoding: Set by user.
2561      * - decoding: unused
2562      */
2563     int trellis;
2564
2565     /**
2566      * - encoding: Set by user.
2567      * - decoding: unused
2568      */
2569     int min_prediction_order;
2570
2571     /**
2572      * - encoding: Set by user.
2573      * - decoding: unused
2574      */
2575     int max_prediction_order;
2576
2577     /**
2578      * GOP timecode frame start number
2579      * - encoding: Set by user, in non drop frame format
2580      * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2581      */
2582     int64_t timecode_frame_start;
2583
2584     /* The RTP callback: This function is called    */
2585     /* every time the encoder has a packet to send. */
2586     /* It depends on the encoder if the data starts */
2587     /* with a Start Code (it should). H.263 does.   */
2588     /* mb_nb contains the number of macroblocks     */
2589     /* encoded in the RTP payload.                  */
2590     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2591
2592     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2593                             /* do its best to deliver a chunk with size     */
2594                             /* below rtp_payload_size, the chunk will start */
2595                             /* with a start code on some codecs like H.263. */
2596                             /* This doesn't take account of any particular  */
2597                             /* headers inside the transmitted RTP payload.  */
2598
2599     /* statistics, used for 2-pass encoding */
2600     int mv_bits;
2601     int header_bits;
2602     int i_tex_bits;
2603     int p_tex_bits;
2604     int i_count;
2605     int p_count;
2606     int skip_count;
2607     int misc_bits;
2608
2609     /**
2610      * number of bits used for the previously encoded frame
2611      * - encoding: Set by libavcodec.
2612      * - decoding: unused
2613      */
2614     int frame_bits;
2615
2616     /**
2617      * pass1 encoding statistics output buffer
2618      * - encoding: Set by libavcodec.
2619      * - decoding: unused
2620      */
2621     char *stats_out;
2622
2623     /**
2624      * pass2 encoding statistics input buffer
2625      * Concatenated stuff from stats_out of pass1 should be placed here.
2626      * - encoding: Allocated/set/freed by user.
2627      * - decoding: unused
2628      */
2629     char *stats_in;
2630
2631     /**
2632      * Work around bugs in encoders which sometimes cannot be detected automatically.
2633      * - encoding: Set by user
2634      * - decoding: Set by user
2635      */
2636     int workaround_bugs;
2637 #define FF_BUG_AUTODETECT       1  ///< autodetection
2638 #define FF_BUG_OLD_MSMPEG4      2
2639 #define FF_BUG_XVID_ILACE       4
2640 #define FF_BUG_UMP4             8
2641 #define FF_BUG_NO_PADDING       16
2642 #define FF_BUG_AMV              32
2643 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2644 #define FF_BUG_QPEL_CHROMA      64
2645 #define FF_BUG_STD_QPEL         128
2646 #define FF_BUG_QPEL_CHROMA2     256
2647 #define FF_BUG_DIRECT_BLOCKSIZE 512
2648 #define FF_BUG_EDGE             1024
2649 #define FF_BUG_HPEL_CHROMA      2048
2650 #define FF_BUG_DC_CLIP          4096
2651 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2652 #define FF_BUG_TRUNCATED       16384
2653
2654     /**
2655      * strictly follow the standard (MPEG4, ...).
2656      * - encoding: Set by user.
2657      * - decoding: Set by user.
2658      * Setting this to STRICT or higher means the encoder and decoder will
2659      * generally do stupid things, whereas setting it to unofficial or lower
2660      * will mean the encoder might produce output that is not supported by all
2661      * spec-compliant decoders. Decoders don't differentiate between normal,
2662      * unofficial and experimental (that is, they always try to decode things
2663      * when they can) unless they are explicitly asked to behave stupidly
2664      * (=strictly conform to the specs)
2665      */
2666     int strict_std_compliance;
2667 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2668 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2669 #define FF_COMPLIANCE_NORMAL        0
2670 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2671 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2672
2673     /**
2674      * error concealment flags
2675      * - encoding: unused
2676      * - decoding: Set by user.
2677      */
2678     int error_concealment;
2679 #define FF_EC_GUESS_MVS   1
2680 #define FF_EC_DEBLOCK     2
2681
2682     /**
2683      * debug
2684      * - encoding: Set by user.
2685      * - decoding: Set by user.
2686      */
2687     int debug;
2688 #define FF_DEBUG_PICT_INFO   1
2689 #define FF_DEBUG_RC          2
2690 #define FF_DEBUG_BITSTREAM   4
2691 #define FF_DEBUG_MB_TYPE     8
2692 #define FF_DEBUG_QP          16
2693 #define FF_DEBUG_MV          32
2694 #define FF_DEBUG_DCT_COEFF   0x00000040
2695 #define FF_DEBUG_SKIP        0x00000080
2696 #define FF_DEBUG_STARTCODE   0x00000100
2697 #define FF_DEBUG_PTS         0x00000200
2698 #define FF_DEBUG_ER          0x00000400
2699 #define FF_DEBUG_MMCO        0x00000800
2700 #define FF_DEBUG_BUGS        0x00001000
2701 #define FF_DEBUG_VIS_QP      0x00002000
2702 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2703 #define FF_DEBUG_BUFFERS     0x00008000
2704 #define FF_DEBUG_THREADS     0x00010000
2705
2706     /**
2707      * debug
2708      * - encoding: Set by user.
2709      * - decoding: Set by user.
2710      */
2711     int debug_mv;
2712 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2713 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2714 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2715
2716     /**
2717      * Error recognition; may misdetect some more or less valid parts as errors.
2718      * - encoding: unused
2719      * - decoding: Set by user.
2720      */
2721     int err_recognition;
2722 #define AV_EF_CRCCHECK  (1<<0)
2723 #define AV_EF_BITSTREAM (1<<1)
2724 #define AV_EF_BUFFER    (1<<2)
2725 #define AV_EF_EXPLODE   (1<<3)
2726
2727 #define AV_EF_CAREFUL    (1<<16)
2728 #define AV_EF_COMPLIANT  (1<<17)
2729 #define AV_EF_AGGRESSIVE (1<<18)
2730
2731
2732     /**
2733      * opaque 64bit number (generally a PTS) that will be reordered and
2734      * output in AVFrame.reordered_opaque
2735      * @deprecated in favor of pkt_pts
2736      * - encoding: unused
2737      * - decoding: Set by user.
2738      */
2739     int64_t reordered_opaque;
2740
2741     /**
2742      * Hardware accelerator in use
2743      * - encoding: unused.
2744      * - decoding: Set by libavcodec
2745      */
2746     struct AVHWAccel *hwaccel;
2747
2748     /**
2749      * Hardware accelerator context.
2750      * For some hardware accelerators, a global context needs to be
2751      * provided by the user. In that case, this holds display-dependent
2752      * data FFmpeg cannot instantiate itself. Please refer to the
2753      * FFmpeg HW accelerator documentation to know how to fill this
2754      * is. e.g. for VA API, this is a struct vaapi_context.
2755      * - encoding: unused
2756      * - decoding: Set by user
2757      */
2758     void *hwaccel_context;
2759
2760     /**
2761      * error
2762      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2763      * - decoding: unused
2764      */
2765     uint64_t error[AV_NUM_DATA_POINTERS];
2766
2767     /**
2768      * DCT algorithm, see FF_DCT_* below
2769      * - encoding: Set by user.
2770      * - decoding: unused
2771      */
2772     int dct_algo;
2773 #define FF_DCT_AUTO    0
2774 #define FF_DCT_FASTINT 1
2775 #define FF_DCT_INT     2
2776 #define FF_DCT_MMX     3
2777 #define FF_DCT_ALTIVEC 5
2778 #define FF_DCT_FAAN    6
2779
2780     /**
2781      * IDCT algorithm, see FF_IDCT_* below.
2782      * - encoding: Set by user.
2783      * - decoding: Set by user.
2784      */
2785     int idct_algo;
2786 #define FF_IDCT_AUTO          0
2787 #define FF_IDCT_INT           1
2788 #define FF_IDCT_SIMPLE        2
2789 #define FF_IDCT_SIMPLEMMX     3
2790 #define FF_IDCT_LIBMPEG2MMX   4
2791 #if FF_API_MMI
2792 #define FF_IDCT_MMI           5
2793 #endif
2794 #define FF_IDCT_ARM           7
2795 #define FF_IDCT_ALTIVEC       8
2796 #define FF_IDCT_SH4           9
2797 #define FF_IDCT_SIMPLEARM     10
2798 #define FF_IDCT_H264          11
2799 #define FF_IDCT_VP3           12
2800 #define FF_IDCT_IPP           13
2801 #define FF_IDCT_XVIDMMX       14
2802 #define FF_IDCT_CAVS          15
2803 #define FF_IDCT_SIMPLEARMV5TE 16
2804 #define FF_IDCT_SIMPLEARMV6   17
2805 #define FF_IDCT_SIMPLEVIS     18
2806 #define FF_IDCT_WMV2          19
2807 #define FF_IDCT_FAAN          20
2808 #define FF_IDCT_EA            21
2809 #define FF_IDCT_SIMPLENEON    22
2810 #define FF_IDCT_SIMPLEALPHA   23
2811 #define FF_IDCT_BINK          24
2812
2813 #if FF_API_DSP_MASK
2814     /**
2815      * Unused.
2816      * @deprecated use av_set_cpu_flags_mask() instead.
2817      */
2818     attribute_deprecated unsigned dsp_mask;
2819 #endif
2820
2821     /**
2822      * bits per sample/pixel from the demuxer (needed for huffyuv).
2823      * - encoding: Set by libavcodec.
2824      * - decoding: Set by user.
2825      */
2826      int bits_per_coded_sample;
2827
2828     /**
2829      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2830      * - encoding: set by user.
2831      * - decoding: set by libavcodec.
2832      */
2833     int bits_per_raw_sample;
2834
2835     /**
2836      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2837      * - encoding: unused
2838      * - decoding: Set by user.
2839      */
2840      int lowres;
2841
2842     /**
2843      * the picture in the bitstream
2844      * - encoding: Set by libavcodec.
2845      * - decoding: Set by libavcodec.
2846      */
2847     AVFrame *coded_frame;
2848
2849     /**
2850      * thread count
2851      * is used to decide how many independent tasks should be passed to execute()
2852      * - encoding: Set by user.
2853      * - decoding: Set by user.
2854      */
2855     int thread_count;
2856
2857     /**
2858      * Which multithreading methods to use.
2859      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2860      * so clients which cannot provide future frames should not use it.
2861      *
2862      * - encoding: Set by user, otherwise the default is used.
2863      * - decoding: Set by user, otherwise the default is used.
2864      */
2865     int thread_type;
2866 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2867 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2868
2869     /**
2870      * Which multithreading methods are in use by the codec.
2871      * - encoding: Set by libavcodec.
2872      * - decoding: Set by libavcodec.
2873      */
2874     int active_thread_type;
2875
2876     /**
2877      * Set by the client if its custom get_buffer() callback can be called
2878      * synchronously from another thread, which allows faster multithreaded decoding.
2879      * draw_horiz_band() will be called from other threads regardless of this setting.
2880      * Ignored if the default get_buffer() is used.
2881      * - encoding: Set by user.
2882      * - decoding: Set by user.
2883      */
2884     int thread_safe_callbacks;
2885
2886     /**
2887      * The codec may call this to execute several independent things.
2888      * It will return only after finishing all tasks.
2889      * The user may replace this with some multithreaded implementation,
2890      * the default implementation will execute the parts serially.
2891      * @param count the number of things to execute
2892      * - encoding: Set by libavcodec, user can override.
2893      * - decoding: Set by libavcodec, user can override.
2894      */
2895     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2896
2897     /**
2898      * The codec may call this to execute several independent things.
2899      * It will return only after finishing all tasks.
2900      * The user may replace this with some multithreaded implementation,
2901      * the default implementation will execute the parts serially.
2902      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2903      * @param c context passed also to func
2904      * @param count the number of things to execute
2905      * @param arg2 argument passed unchanged to func
2906      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2907      * @param func function that will be called count times, with jobnr from 0 to count-1.
2908      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2909      *             two instances of func executing at the same time will have the same threadnr.
2910      * @return always 0 currently, but code should handle a future improvement where when any call to func
2911      *         returns < 0 no further calls to func may be done and < 0 is returned.
2912      * - encoding: Set by libavcodec, user can override.
2913      * - decoding: Set by libavcodec, user can override.
2914      */
2915     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2916
2917     /**
2918      * thread opaque
2919      * Can be used by execute() to store some per AVCodecContext stuff.
2920      * - encoding: set by execute()
2921      * - decoding: set by execute()
2922      */
2923     void *thread_opaque;
2924
2925     /**
2926      * noise vs. sse weight for the nsse comparsion function
2927      * - encoding: Set by user.
2928      * - decoding: unused
2929      */
2930      int nsse_weight;
2931
2932     /**
2933      * profile
2934      * - encoding: Set by user.
2935      * - decoding: Set by libavcodec.
2936      */
2937      int profile;
2938 #define FF_PROFILE_UNKNOWN -99
2939 #define FF_PROFILE_RESERVED -100
2940
2941 #define FF_PROFILE_AAC_MAIN 0
2942 #define FF_PROFILE_AAC_LOW  1
2943 #define FF_PROFILE_AAC_SSR  2
2944 #define FF_PROFILE_AAC_LTP  3
2945 #define FF_PROFILE_AAC_HE   4
2946 #define FF_PROFILE_AAC_HE_V2 28
2947 #define FF_PROFILE_AAC_LD   22
2948 #define FF_PROFILE_AAC_ELD  38
2949
2950 #define FF_PROFILE_DTS         20
2951 #define FF_PROFILE_DTS_ES      30
2952 #define FF_PROFILE_DTS_96_24   40
2953 #define FF_PROFILE_DTS_HD_HRA  50
2954 #define FF_PROFILE_DTS_HD_MA   60
2955
2956 #define FF_PROFILE_MPEG2_422    0
2957 #define FF_PROFILE_MPEG2_HIGH   1
2958 #define FF_PROFILE_MPEG2_SS     2
2959 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2960 #define FF_PROFILE_MPEG2_MAIN   4
2961 #define FF_PROFILE_MPEG2_SIMPLE 5
2962
2963 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2964 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2965
2966 #define FF_PROFILE_H264_BASELINE             66
2967 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2968 #define FF_PROFILE_H264_MAIN                 77
2969 #define FF_PROFILE_H264_EXTENDED             88
2970 #define FF_PROFILE_H264_HIGH                 100
2971 #define FF_PROFILE_H264_HIGH_10              110
2972 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2973 #define FF_PROFILE_H264_HIGH_422             122
2974 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2975 #define FF_PROFILE_H264_HIGH_444             144
2976 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2977 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2978 #define FF_PROFILE_H264_CAVLC_444            44
2979
2980 #define FF_PROFILE_VC1_SIMPLE   0
2981 #define FF_PROFILE_VC1_MAIN     1
2982 #define FF_PROFILE_VC1_COMPLEX  2
2983 #define FF_PROFILE_VC1_ADVANCED 3
2984
2985 #define FF_PROFILE_MPEG4_SIMPLE                     0
2986 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2987 #define FF_PROFILE_MPEG4_CORE                       2
2988 #define FF_PROFILE_MPEG4_MAIN                       3
2989 #define FF_PROFILE_MPEG4_N_BIT                      4
2990 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2991 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2992 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2993 #define FF_PROFILE_MPEG4_HYBRID                     8
2994 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2995 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2996 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2997 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2998 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2999 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3000 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3001
3002     /**
3003      * level
3004      * - encoding: Set by user.
3005      * - decoding: Set by libavcodec.
3006      */
3007      int level;
3008 #define FF_LEVEL_UNKNOWN -99
3009
3010     /**
3011      *
3012      * - encoding: unused
3013      * - decoding: Set by user.
3014      */
3015     enum AVDiscard skip_loop_filter;
3016
3017     /**
3018      *
3019      * - encoding: unused
3020      * - decoding: Set by user.
3021      */
3022     enum AVDiscard skip_idct;
3023
3024     /**
3025      *
3026      * - encoding: unused
3027      * - decoding: Set by user.
3028      */
3029     enum AVDiscard skip_frame;
3030
3031     /**
3032      * Header containing style information for text subtitles.
3033      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3034      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3035      * the Format line following. It shouldn't include any Dialogue line.
3036      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3037      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3038      */
3039     uint8_t *subtitle_header;
3040     int subtitle_header_size;
3041
3042     /**
3043      * Simulates errors in the bitstream to test error concealment.
3044      * - encoding: Set by user.
3045      * - decoding: unused
3046      */
3047     int error_rate;
3048
3049     /**
3050      * Current packet as passed into the decoder, to avoid having
3051      * to pass the packet into every function. Currently only valid
3052      * inside lavc and get/release_buffer callbacks.
3053      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3054      * - encoding: unused
3055      */
3056     AVPacket *pkt;
3057
3058     /**
3059      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3060      * Used for compliant TS muxing.
3061      * - encoding: Set by libavcodec.
3062      * - decoding: unused.
3063      */
3064     uint64_t vbv_delay;
3065
3066     /**
3067      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3068      * Code outside libavcodec should access this field using:
3069      * avcodec_set_pkt_timebase(avctx)
3070      * - encoding unused.
3071      * - decodimg set by user
3072      */
3073     AVRational pkt_timebase;
3074
3075     /**
3076      * AVCodecDescriptor
3077      * Code outside libavcodec should access this field using:
3078      * avcodec_get_codec_descriptior(avctx)
3079      * - encoding: unused.
3080      * - decoding: set by libavcodec.
3081      */
3082     const AVCodecDescriptor *codec_descriptor;
3083
3084     /**
3085      * Current statistics for PTS correction.
3086      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3087      * - encoding: unused
3088      */
3089     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3090     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3091     int64_t pts_correction_last_pts;       /// PTS of the last frame
3092     int64_t pts_correction_last_dts;       /// DTS of the last frame
3093 } AVCodecContext;
3094
3095 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3096 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3097
3098 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3099 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3100
3101 /**
3102  * AVProfile.
3103  */
3104 typedef struct AVProfile {
3105     int profile;
3106     const char *name; ///< short name for the profile
3107 } AVProfile;
3108
3109 typedef struct AVCodecDefault AVCodecDefault;
3110
3111 struct AVSubtitle;
3112
3113 /**
3114  * AVCodec.
3115  */
3116 typedef struct AVCodec {
3117     /**
3118      * Name of the codec implementation.
3119      * The name is globally unique among encoders and among decoders (but an
3120      * encoder and a decoder can share the same name).
3121      * This is the primary way to find a codec from the user perspective.
3122      */
3123     const char *name;
3124     /**
3125      * Descriptive name for the codec, meant to be more human readable than name.
3126      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3127      */
3128     const char *long_name;
3129     enum AVMediaType type;
3130     enum AVCodecID id;
3131     /**
3132      * Codec capabilities.
3133      * see CODEC_CAP_*
3134      */
3135     int capabilities;
3136     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3137     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3138     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3139     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3140     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3141     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3142     const AVClass *priv_class;              ///< AVClass for the private context
3143     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3144
3145     /*****************************************************************
3146      * No fields below this line are part of the public API. They
3147      * may not be used outside of libavcodec and can be changed and
3148      * removed at will.
3149      * New public fields should be added right above.
3150      *****************************************************************
3151      */
3152     int priv_data_size;
3153     struct AVCodec *next;
3154     /**
3155      * @name Frame-level threading support functions
3156      * @{
3157      */
3158     /**
3159      * If defined, called on thread contexts when they are created.
3160      * If the codec allocates writable tables in init(), re-allocate them here.
3161      * priv_data will be set to a copy of the original.
3162      */
3163     int (*init_thread_copy)(AVCodecContext *);
3164     /**
3165      * Copy necessary context variables from a previous thread context to the current one.
3166      * If not defined, the next thread will start automatically; otherwise, the codec
3167      * must call ff_thread_finish_setup().
3168      *
3169      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3170      */
3171     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3172     /** @} */
3173
3174     /**
3175      * Private codec-specific defaults.
3176      */
3177     const AVCodecDefault *defaults;
3178
3179     /**
3180      * Initialize codec static data, called from avcodec_register().
3181      */
3182     void (*init_static_data)(struct AVCodec *codec);
3183
3184     int (*init)(AVCodecContext *);
3185     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3186                       const struct AVSubtitle *sub);
3187     /**
3188      * Encode data to an AVPacket.
3189      *
3190      * @param      avctx          codec context
3191      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3192      * @param[in]  frame          AVFrame containing the raw data to be encoded
3193      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3194      *                            non-empty packet was returned in avpkt.
3195      * @return 0 on success, negative error code on failure
3196      */
3197     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3198                    int *got_packet_ptr);
3199     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3200     int (*close)(AVCodecContext *);
3201     /**
3202      * Flush buffers.
3203      * Will be called when seeking
3204      */
3205     void (*flush)(AVCodecContext *);
3206 } AVCodec;
3207
3208 /**
3209  * AVHWAccel.
3210  */
3211 typedef struct AVHWAccel {
3212     /**
3213      * Name of the hardware accelerated codec.
3214      * The name is globally unique among encoders and among decoders (but an
3215      * encoder and a decoder can share the same name).
3216      */
3217     const char *name;
3218
3219     /**
3220      * Type of codec implemented by the hardware accelerator.
3221      *
3222      * See AVMEDIA_TYPE_xxx
3223      */
3224     enum AVMediaType type;
3225
3226     /**
3227      * Codec implemented by the hardware accelerator.
3228      *
3229      * See AV_CODEC_ID_xxx
3230      */
3231     enum AVCodecID id;
3232
3233     /**
3234      * Supported pixel format.
3235      *
3236      * Only hardware accelerated formats are supported here.
3237      */
3238     enum AVPixelFormat pix_fmt;
3239
3240     /**
3241      * Hardware accelerated codec capabilities.
3242      * see FF_HWACCEL_CODEC_CAP_*
3243      */
3244     int capabilities;
3245
3246     struct AVHWAccel *next;
3247
3248     /**
3249      * Called at the beginning of each frame or field picture.
3250      *
3251      * Meaningful frame information (codec specific) is guaranteed to
3252      * be parsed at this point. This function is mandatory.
3253      *
3254      * Note that buf can be NULL along with buf_size set to 0.
3255      * Otherwise, this means the whole frame is available at this point.
3256      *
3257      * @param avctx the codec context
3258      * @param buf the frame data buffer base
3259      * @param buf_size the size of the frame in bytes
3260      * @return zero if successful, a negative value otherwise
3261      */
3262     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3263
3264     /**
3265      * Callback for each slice.
3266      *
3267      * Meaningful slice information (codec specific) is guaranteed to
3268      * be parsed at this point. This function is mandatory.
3269      *
3270      * @param avctx the codec context
3271      * @param buf the slice data buffer base
3272      * @param buf_size the size of the slice in bytes
3273      * @return zero if successful, a negative value otherwise
3274      */
3275     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3276
3277     /**
3278      * Called at the end of each frame or field picture.
3279      *
3280      * The whole picture is parsed at this point and can now be sent
3281      * to the hardware accelerator. This function is mandatory.
3282      *
3283      * @param avctx the codec context
3284      * @return zero if successful, a negative value otherwise
3285      */
3286     int (*end_frame)(AVCodecContext *avctx);
3287
3288     /**
3289      * Size of HW accelerator private data.
3290      *
3291      * Private data is allocated with av_mallocz() before
3292      * AVCodecContext.get_buffer() and deallocated after
3293      * AVCodecContext.release_buffer().
3294      */
3295     int priv_data_size;
3296 } AVHWAccel;
3297
3298 /**
3299  * @defgroup lavc_picture AVPicture
3300  *
3301  * Functions for working with AVPicture
3302  * @{
3303  */
3304
3305 /**
3306  * four components are given, that's all.
3307  * the last component is alpha
3308  */
3309 typedef struct AVPicture {
3310     uint8_t *data[AV_NUM_DATA_POINTERS];
3311     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3312 } AVPicture;
3313
3314 /**
3315  * @}
3316  */
3317
3318 enum AVSubtitleType {
3319     SUBTITLE_NONE,
3320
3321     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3322
3323     /**
3324      * Plain text, the text field must be set by the decoder and is
3325      * authoritative. ass and pict fields may contain approximations.
3326      */
3327     SUBTITLE_TEXT,
3328
3329     /**
3330      * Formatted text, the ass field must be set by the decoder and is
3331      * authoritative. pict and text fields may contain approximations.
3332      */
3333     SUBTITLE_ASS,
3334 };
3335
3336 typedef struct AVSubtitleRect {
3337     int x;         ///< top left corner  of pict, undefined when pict is not set
3338     int y;         ///< top left corner  of pict, undefined when pict is not set
3339     int w;         ///< width            of pict, undefined when pict is not set
3340     int h;         ///< height           of pict, undefined when pict is not set
3341     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3342
3343     /**
3344      * data+linesize for the bitmap of this subtitle.
3345      * can be set for text/ass as well once they where rendered
3346      */
3347     AVPicture pict;
3348     enum AVSubtitleType type;
3349
3350     char *text;                     ///< 0 terminated plain UTF-8 text
3351
3352     /**
3353      * 0 terminated ASS/SSA compatible event line.
3354      * The presentation of this is unaffected by the other values in this
3355      * struct.
3356      */
3357     char *ass;
3358
3359     /**
3360      * 1 indicates this subtitle is a forced subtitle.
3361      * A forced subtitle should be displayed even when subtitles are hidden.
3362      */
3363     int forced;
3364 } AVSubtitleRect;
3365
3366 typedef struct AVSubtitle {
3367     uint16_t format; /* 0 = graphics */
3368     uint32_t start_display_time; /* relative to packet pts, in ms */
3369     uint32_t end_display_time; /* relative to packet pts, in ms */
3370     unsigned num_rects;
3371     AVSubtitleRect **rects;
3372     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3373 } AVSubtitle;
3374
3375 /**
3376  * If c is NULL, returns the first registered codec,
3377  * if c is non-NULL, returns the next registered codec after c,
3378  * or NULL if c is the last one.
3379  */
3380 AVCodec *av_codec_next(const AVCodec *c);
3381
3382 /**
3383  * Return the LIBAVCODEC_VERSION_INT constant.
3384  */
3385 unsigned avcodec_version(void);
3386
3387 /**
3388  * Return the libavcodec build-time configuration.
3389  */
3390 const char *avcodec_configuration(void);
3391
3392 /**
3393  * Return the libavcodec license.
3394  */
3395 const char *avcodec_license(void);
3396
3397 /**
3398  * Register the codec codec and initialize libavcodec.
3399  *
3400  * @warning either this function or avcodec_register_all() must be called
3401  * before any other libavcodec functions.
3402  *
3403  * @see avcodec_register_all()
3404  */
3405 void avcodec_register(AVCodec *codec);
3406
3407 /**
3408  * Register all the codecs, parsers and bitstream filters which were enabled at
3409  * configuration time. If you do not call this function you can select exactly
3410  * which formats you want to support, by using the individual registration
3411  * functions.
3412  *
3413  * @see avcodec_register
3414  * @see av_register_codec_parser
3415  * @see av_register_bitstream_filter
3416  */
3417 void avcodec_register_all(void);
3418
3419
3420 #if FF_API_ALLOC_CONTEXT
3421 /**
3422  * Allocate an AVCodecContext and set its fields to default values.  The
3423  * resulting struct can be deallocated by simply calling av_free().
3424  *
3425  * @return An AVCodecContext filled with default values or NULL on failure.
3426  * @see avcodec_get_context_defaults
3427  *
3428  * @deprecated use avcodec_alloc_context3()
3429  */
3430 attribute_deprecated
3431 AVCodecContext *avcodec_alloc_context(void);
3432
3433 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3434  *  we WILL change its arguments and name a few times! */
3435 attribute_deprecated
3436 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3437
3438 /**
3439  * Set the fields of the given AVCodecContext to default values.
3440  *
3441  * @param s The AVCodecContext of which the fields should be set to default values.
3442  * @deprecated use avcodec_get_context_defaults3
3443  */
3444 attribute_deprecated
3445 void avcodec_get_context_defaults(AVCodecContext *s);
3446
3447 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3448  *  we WILL change its arguments and name a few times! */
3449 attribute_deprecated
3450 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3451 #endif
3452
3453 /**
3454  * Allocate an AVCodecContext and set its fields to default values.  The
3455  * resulting struct can be deallocated by calling avcodec_close() on it followed
3456  * by av_free().
3457  *
3458  * @param codec if non-NULL, allocate private data and initialize defaults
3459  *              for the given codec. It is illegal to then call avcodec_open2()
3460  *              with a different codec.
3461  *              If NULL, then the codec-specific defaults won't be initialized,
3462  *              which may result in suboptimal default settings (this is
3463  *              important mainly for encoders, e.g. libx264).
3464  *
3465  * @return An AVCodecContext filled with default values or NULL on failure.
3466  * @see avcodec_get_context_defaults
3467  */
3468 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3469
3470 /**
3471  * Set the fields of the given AVCodecContext to default values corresponding
3472  * to the given codec (defaults may be codec-dependent).
3473  *
3474  * Do not call this function if a non-NULL codec has been passed
3475  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3476  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3477  * different codec on this AVCodecContext.
3478  */
3479 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3480
3481 /**
3482  * Get the AVClass for AVCodecContext. It can be used in combination with
3483  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3484  *
3485  * @see av_opt_find().
3486  */
3487 const AVClass *avcodec_get_class(void);
3488
3489 /**
3490  * Get the AVClass for AVFrame. It can be used in combination with
3491  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3492  *
3493  * @see av_opt_find().
3494  */
3495 const AVClass *avcodec_get_frame_class(void);
3496
3497 /**
3498  * Get the AVClass for AVSubtitleRect. It can be used in combination with
3499  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3500  *
3501  * @see av_opt_find().
3502  */
3503 const AVClass *avcodec_get_subtitle_rect_class(void);
3504
3505 /**
3506  * Copy the settings of the source AVCodecContext into the destination
3507  * AVCodecContext. The resulting destination codec context will be
3508  * unopened, i.e. you are required to call avcodec_open2() before you
3509  * can use this AVCodecContext to decode/encode video/audio data.
3510  *
3511  * @param dest target codec context, should be initialized with
3512  *             avcodec_alloc_context3(), but otherwise uninitialized
3513  * @param src source codec context
3514  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3515  */
3516 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3517
3518 /**
3519  * Allocate an AVFrame and set its fields to default values.  The resulting
3520  * struct must be freed using avcodec_free_frame().
3521  *
3522  * @return An AVFrame filled with default values or NULL on failure.
3523  * @see avcodec_get_frame_defaults
3524  */
3525 AVFrame *avcodec_alloc_frame(void);
3526
3527 /**
3528  * Set the fields of the given AVFrame to default values.
3529  *
3530  * @param frame The AVFrame of which the fields should be set to default values.
3531  */
3532 void avcodec_get_frame_defaults(AVFrame *frame);
3533
3534 /**
3535  * Free the frame and any dynamically allocated objects in it,
3536  * e.g. extended_data.
3537  *
3538  * @param frame frame to be freed. The pointer will be set to NULL.
3539  *
3540  * @warning this function does NOT free the data buffers themselves
3541  * (it does not know how, since they might have been allocated with
3542  *  a custom get_buffer()).
3543  */
3544 void avcodec_free_frame(AVFrame **frame);
3545
3546 #if FF_API_AVCODEC_OPEN
3547 /**
3548  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3549  * function the context has to be allocated.
3550  *
3551  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3552  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3553  * retrieving a codec.
3554  *
3555  * @warning This function is not thread safe!
3556  *
3557  * @code
3558  * avcodec_register_all();
3559  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3560  * if (!codec)
3561  *     exit(1);
3562  *
3563  * context = avcodec_alloc_context3(codec);
3564  *
3565  * if (avcodec_open(context, codec) < 0)
3566  *     exit(1);
3567  * @endcode
3568  *
3569  * @param avctx The context which will be set up to use the given codec.
3570  * @param codec The codec to use within the context.
3571  * @return zero on success, a negative value on error
3572  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3573  *
3574  * @deprecated use avcodec_open2
3575  */
3576 attribute_deprecated
3577 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3578 #endif
3579
3580 /**
3581  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3582  * function the context has to be allocated with avcodec_alloc_context3().
3583  *
3584  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3585  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3586  * retrieving a codec.
3587  *
3588  * @warning This function is not thread safe!
3589  *
3590  * @code
3591  * avcodec_register_all();
3592  * av_dict_set(&opts, "b", "2.5M", 0);
3593  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3594  * if (!codec)
3595  *     exit(1);
3596  *
3597  * context = avcodec_alloc_context3(codec);
3598  *
3599  * if (avcodec_open2(context, codec, opts) < 0)
3600  *     exit(1);
3601  * @endcode
3602  *
3603  * @param avctx The context to initialize.
3604  * @param codec The codec to open this context for. If a non-NULL codec has been
3605  *              previously passed to avcodec_alloc_context3() or
3606  *              avcodec_get_context_defaults3() for this context, then this
3607  *              parameter MUST be either NULL or equal to the previously passed
3608  *              codec.
3609  * @param options A dictionary filled with AVCodecContext and codec-private options.
3610  *                On return this object will be filled with options that were not found.
3611  *
3612  * @return zero on success, a negative value on error
3613  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3614  *      av_dict_set(), av_opt_find().
3615  */
3616 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3617
3618 /**
3619  * Close a given AVCodecContext and free all the data associated with it
3620  * (but not the AVCodecContext itself).
3621  *
3622  * Calling this function on an AVCodecContext that hasn't been opened will free
3623  * the codec-specific data allocated in avcodec_alloc_context3() /
3624  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3625  * do nothing.
3626  */
3627 int avcodec_close(AVCodecContext *avctx);
3628
3629 /**
3630  * Free all allocated data in the given subtitle struct.
3631  *
3632  * @param sub AVSubtitle to free.
3633  */
3634 void avsubtitle_free(AVSubtitle *sub);
3635
3636 /**
3637  * @}
3638  */
3639
3640 /**
3641  * @addtogroup lavc_packet
3642  * @{
3643  */
3644
3645 /**
3646  * Default packet destructor.
3647  */
3648 void av_destruct_packet(AVPacket *pkt);
3649
3650 /**
3651  * Initialize optional fields of a packet with default values.
3652  *
3653  * Note, this does not touch the data and size members, which have to be
3654  * initialized separately.
3655  *
3656  * @param pkt packet
3657  */
3658 void av_init_packet(AVPacket *pkt);
3659
3660 /**
3661  * Allocate the payload of a packet and initialize its fields with
3662  * default values.
3663  *
3664  * @param pkt packet
3665  * @param size wanted payload size
3666  * @return 0 if OK, AVERROR_xxx otherwise
3667  */
3668 int av_new_packet(AVPacket *pkt, int size);
3669
3670 /**
3671  * Reduce packet size, correctly zeroing padding
3672  *
3673  * @param pkt packet
3674  * @param size new size
3675  */
3676 void av_shrink_packet(AVPacket *pkt, int size);
3677
3678 /**
3679  * Increase packet size, correctly zeroing padding
3680  *
3681  * @param pkt packet
3682  * @param grow_by number of bytes by which to increase the size of the packet
3683  */
3684 int av_grow_packet(AVPacket *pkt, int grow_by);
3685
3686 /**
3687  * @warning This is a hack - the packet memory allocation stuff is broken. The
3688  * packet is allocated if it was not really allocated.
3689  */
3690 int av_dup_packet(AVPacket *pkt);
3691
3692 /**
3693  * Copy packet, including contents
3694  *
3695  * @return 0 on success, negative AVERROR on fail
3696  */
3697 int av_copy_packet(AVPacket *dst, AVPacket *src);
3698
3699 /**
3700  * Free a packet.
3701  *
3702  * @param pkt packet to free
3703  */
3704 void av_free_packet(AVPacket *pkt);
3705
3706 /**
3707  * Allocate new information of a packet.
3708  *
3709  * @param pkt packet
3710  * @param type side information type
3711  * @param size side information size
3712  * @return pointer to fresh allocated data or NULL otherwise
3713  */
3714 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3715                                  int size);
3716
3717 /**
3718  * Shrink the already allocated side data buffer
3719  *
3720  * @param pkt packet
3721  * @param type side information type
3722  * @param size new side information size
3723  * @return 0 on success, < 0 on failure
3724  */
3725 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3726                                int size);
3727
3728 /**
3729  * Get side information from packet.
3730  *
3731  * @param pkt packet
3732  * @param type desired side information type
3733  * @param size pointer for side information size to store (optional)
3734  * @return pointer to data if present or NULL otherwise
3735  */
3736 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3737                                  int *size);
3738
3739 int av_packet_merge_side_data(AVPacket *pkt);
3740
3741 int av_packet_split_side_data(AVPacket *pkt);
3742
3743
3744 /**
3745  * @}
3746  */
3747
3748 /**
3749  * @addtogroup lavc_decoding
3750  * @{
3751  */
3752
3753 /**
3754  * Find a registered decoder with a matching codec ID.
3755  *
3756  * @param id AVCodecID of the requested decoder
3757  * @return A decoder if one was found, NULL otherwise.
3758  */
3759 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3760
3761 /**
3762  * Find a registered decoder with the specified name.
3763  *
3764  * @param name name of the requested decoder
3765  * @return A decoder if one was found, NULL otherwise.
3766  */
3767 AVCodec *avcodec_find_decoder_by_name(const char *name);
3768
3769 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3770 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3771 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3772
3773 /**
3774  * Return the amount of padding in pixels which the get_buffer callback must
3775  * provide around the edge of the image for codecs which do not have the
3776  * CODEC_FLAG_EMU_EDGE flag.
3777  *
3778  * @return Required padding in pixels.
3779  */
3780 unsigned avcodec_get_edge_width(void);
3781
3782 /**
3783  * Modify width and height values so that they will result in a memory
3784  * buffer that is acceptable for the codec if you do not use any horizontal
3785  * padding.
3786  *
3787  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3788  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3789  * according to avcodec_get_edge_width() before.
3790  */
3791 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3792
3793 /**
3794  * Modify width and height values so that they will result in a memory
3795  * buffer that is acceptable for the codec if you also ensure that all
3796  * line sizes are a multiple of the respective linesize_align[i].
3797  *
3798  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3799  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3800  * according to avcodec_get_edge_width() before.
3801  */
3802 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3803                                int linesize_align[AV_NUM_DATA_POINTERS]);
3804
3805 #if FF_API_OLD_DECODE_AUDIO
3806 /**
3807  * Wrapper function which calls avcodec_decode_audio4.
3808  *
3809  * @deprecated Use avcodec_decode_audio4 instead.
3810  *
3811  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3812  * Some decoders may support multiple frames in a single AVPacket, such
3813  * decoders would then just decode the first frame. In this case,
3814  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3815  * the remaining data in order to decode the second frame etc.
3816  * If no frame
3817  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3818  * decompressed frame size in bytes.
3819  *
3820  * @warning You must set frame_size_ptr to the allocated size of the
3821  * output buffer before calling avcodec_decode_audio3().
3822  *
3823  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3824  * the actual read bytes because some optimized bitstream readers read 32 or 64
3825  * bits at once and could read over the end.
3826  *
3827  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3828  * no overreading happens for damaged MPEG streams.
3829  *
3830  * @warning You must not provide a custom get_buffer() when using
3831  * avcodec_decode_audio3().  Doing so will override it with
3832  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,