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