add OTF support for attachments
[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 typedef struct AVPacket {
933     /**
934      * Presentation timestamp in AVStream->time_base units; the time at which
935      * the decompressed packet will be presented to the user.
936      * Can be AV_NOPTS_VALUE if it is not stored in the file.
937      * pts MUST be larger or equal to dts as presentation cannot happen before
938      * decompression, unless one wants to view hex dumps. Some formats misuse
939      * the terms dts and pts/cts to mean something different. Such timestamps
940      * must be converted to true pts/dts before they are stored in AVPacket.
941      */
942     int64_t pts;
943     /**
944      * Decompression timestamp in AVStream->time_base units; the time at which
945      * the packet is decompressed.
946      * Can be AV_NOPTS_VALUE if it is not stored in the file.
947      */
948     int64_t dts;
949     uint8_t *data;
950     int   size;
951     int   stream_index;
952     /**
953      * A combination of AV_PKT_FLAG values
954      */
955     int   flags;
956     /**
957      * Additional packet data that can be provided by the container.
958      * Packet can contain several types of side information.
959      */
960     struct {
961         uint8_t *data;
962         int      size;
963         enum AVPacketSideDataType type;
964     } *side_data;
965     int side_data_elems;
966
967     /**
968      * Duration of this packet in AVStream->time_base units, 0 if unknown.
969      * Equals next_pts - this_pts in presentation order.
970      */
971     int   duration;
972     void  (*destruct)(struct AVPacket *);
973     void  *priv;
974     int64_t pos;                            ///< byte position in stream, -1 if unknown
975
976     /**
977      * Time difference in AVStream->time_base units from the pts of this
978      * packet to the point at which the output from the decoder has converged
979      * independent from the availability of previous frames. That is, the
980      * frames are virtually identical no matter if decoding started from
981      * the very first frame or from this keyframe.
982      * Is AV_NOPTS_VALUE if unknown.
983      * This field is not the display duration of the current packet.
984      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
985      * set.
986      *
987      * The purpose of this field is to allow seeking in streams that have no
988      * keyframes in the conventional sense. It corresponds to the
989      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
990      * essential for some types of subtitle streams to ensure that all
991      * subtitles are correctly displayed after seeking.
992      */
993     int64_t convergence_duration;
994 } AVPacket;
995 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
996 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
997
998 enum AVSideDataParamChangeFlags {
999     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1000     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1001     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1002     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1003 };
1004 /**
1005  * @}
1006  */
1007
1008 /**
1009  * Audio Video Frame.
1010  * New fields can be added to the end of AVFRAME with minor version
1011  * bumps. Similarly fields that are marked as to be only accessed by
1012  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1013  * without breaking compatibility with each other.
1014  * Removal, reordering and changes in the remaining cases require
1015  * a major version bump.
1016  * sizeof(AVFrame) must not be used outside libavcodec.
1017  */
1018 typedef struct AVFrame {
1019 #define AV_NUM_DATA_POINTERS 8
1020     /**
1021      * pointer to the picture/channel planes.
1022      * This might be different from the first allocated byte
1023      * - encoding: Set by user
1024      * - decoding: set by AVCodecContext.get_buffer()
1025      */
1026     uint8_t *data[AV_NUM_DATA_POINTERS];
1027
1028     /**
1029      * Size, in bytes, of the data for each picture/channel plane.
1030      *
1031      * For audio, only linesize[0] may be set. For planar audio, each channel
1032      * plane must be the same size.
1033      *
1034      * - encoding: Set by user
1035      * - decoding: set by AVCodecContext.get_buffer()
1036      */
1037     int linesize[AV_NUM_DATA_POINTERS];
1038
1039     /**
1040      * pointers to the data planes/channels.
1041      *
1042      * For video, this should simply point to data[].
1043      *
1044      * For planar audio, each channel has a separate data pointer, and
1045      * linesize[0] contains the size of each channel buffer.
1046      * For packed audio, there is just one data pointer, and linesize[0]
1047      * contains the total size of the buffer for all channels.
1048      *
1049      * Note: Both data and extended_data will always be set by get_buffer(),
1050      * but for planar audio with more channels that can fit in data,
1051      * extended_data must be used by the decoder in order to access all
1052      * channels.
1053      *
1054      * encoding: unused
1055      * decoding: set by AVCodecContext.get_buffer()
1056      */
1057     uint8_t **extended_data;
1058
1059     /**
1060      * width and height of the video frame
1061      * - encoding: unused
1062      * - decoding: Read by user.
1063      */
1064     int width, height;
1065
1066     /**
1067      * number of audio samples (per channel) described by this frame
1068      * - encoding: Set by user
1069      * - decoding: Set by libavcodec
1070      */
1071     int nb_samples;
1072
1073     /**
1074      * format of the frame, -1 if unknown or unset
1075      * Values correspond to enum PixelFormat for video frames,
1076      * enum AVSampleFormat for audio)
1077      * - encoding: unused
1078      * - decoding: Read by user.
1079      */
1080     int format;
1081
1082     /**
1083      * 1 -> keyframe, 0-> not
1084      * - encoding: Set by libavcodec.
1085      * - decoding: Set by libavcodec.
1086      */
1087     int key_frame;
1088
1089     /**
1090      * Picture type of the frame, see ?_TYPE below.
1091      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1092      * - decoding: Set by libavcodec.
1093      */
1094     enum AVPictureType pict_type;
1095
1096     /**
1097      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1098      * This isn't used by libavcodec unless the default get/release_buffer() is used.
1099      * - encoding:
1100      * - decoding:
1101      */
1102     uint8_t *base[AV_NUM_DATA_POINTERS];
1103
1104     /**
1105      * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1106      * - encoding: unused
1107      * - decoding: Read by user.
1108      */
1109     AVRational sample_aspect_ratio;
1110
1111     /**
1112      * presentation timestamp in time_base units (time when frame should be shown to user)
1113      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1114      * - encoding: MUST be set by user.
1115      * - decoding: Set by libavcodec.
1116      */
1117     int64_t pts;
1118
1119     /**
1120      * reordered pts from the last AVPacket that has been input into the decoder
1121      * - encoding: unused
1122      * - decoding: Read by user.
1123      */
1124     int64_t pkt_pts;
1125
1126     /**
1127      * dts from the last AVPacket that has been input into the decoder
1128      * - encoding: unused
1129      * - decoding: Read by user.
1130      */
1131     int64_t pkt_dts;
1132
1133     /**
1134      * picture number in bitstream order
1135      * - encoding: set by
1136      * - decoding: Set by libavcodec.
1137      */
1138     int coded_picture_number;
1139     /**
1140      * picture number in display order
1141      * - encoding: set by
1142      * - decoding: Set by libavcodec.
1143      */
1144     int display_picture_number;
1145
1146     /**
1147      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1148      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1149      * - decoding: Set by libavcodec.
1150      */
1151     int quality;
1152
1153     /**
1154      * is this picture used as reference
1155      * The values for this are the same as the MpegEncContext.picture_structure
1156      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1157      * Set to 4 for delayed, non-reference frames.
1158      * - encoding: unused
1159      * - decoding: Set by libavcodec. (before get_buffer() call)).
1160      */
1161     int reference;
1162
1163     /**
1164      * QP table
1165      * - encoding: unused
1166      * - decoding: Set by libavcodec.
1167      */
1168     int8_t *qscale_table;
1169     /**
1170      * QP store stride
1171      * - encoding: unused
1172      * - decoding: Set by libavcodec.
1173      */
1174     int qstride;
1175
1176     /**
1177      *
1178      */
1179     int qscale_type;
1180
1181     /**
1182      * mbskip_table[mb]>=1 if MB didn't change
1183      * stride= mb_width = (width+15)>>4
1184      * - encoding: unused
1185      * - decoding: Set by libavcodec.
1186      */
1187     uint8_t *mbskip_table;
1188
1189     /**
1190      * motion vector table
1191      * @code
1192      * example:
1193      * int mv_sample_log2= 4 - motion_subsample_log2;
1194      * int mb_width= (width+15)>>4;
1195      * int mv_stride= (mb_width << mv_sample_log2) + 1;
1196      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1197      * @endcode
1198      * - encoding: Set by user.
1199      * - decoding: Set by libavcodec.
1200      */
1201     int16_t (*motion_val[2])[2];
1202
1203     /**
1204      * macroblock type table
1205      * mb_type_base + mb_width + 2
1206      * - encoding: Set by user.
1207      * - decoding: Set by libavcodec.
1208      */
1209     uint32_t *mb_type;
1210
1211     /**
1212      * DCT coefficients
1213      * - encoding: unused
1214      * - decoding: Set by libavcodec.
1215      */
1216     short *dct_coeff;
1217
1218     /**
1219      * motion reference frame index
1220      * the order in which these are stored can depend on the codec.
1221      * - encoding: Set by user.
1222      * - decoding: Set by libavcodec.
1223      */
1224     int8_t *ref_index[2];
1225
1226     /**
1227      * for some private data of the user
1228      * - encoding: unused
1229      * - decoding: Set by user.
1230      */
1231     void *opaque;
1232
1233     /**
1234      * error
1235      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1236      * - decoding: unused
1237      */
1238     uint64_t error[AV_NUM_DATA_POINTERS];
1239
1240     /**
1241      * type of the buffer (to keep track of who has to deallocate data[*])
1242      * - encoding: Set by the one who allocates it.
1243      * - decoding: Set by the one who allocates it.
1244      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1245      */
1246     int type;
1247
1248     /**
1249      * When decoding, this signals how much the picture must be delayed.
1250      * extra_delay = repeat_pict / (2*fps)
1251      * - encoding: unused
1252      * - decoding: Set by libavcodec.
1253      */
1254     int repeat_pict;
1255
1256     /**
1257      * The content of the picture is interlaced.
1258      * - encoding: Set by user.
1259      * - decoding: Set by libavcodec. (default 0)
1260      */
1261     int interlaced_frame;
1262
1263     /**
1264      * If the content is interlaced, is top field displayed first.
1265      * - encoding: Set by user.
1266      * - decoding: Set by libavcodec.
1267      */
1268     int top_field_first;
1269
1270     /**
1271      * Tell user application that palette has changed from previous frame.
1272      * - encoding: ??? (no palette-enabled encoder yet)
1273      * - decoding: Set by libavcodec. (default 0).
1274      */
1275     int palette_has_changed;
1276
1277     /**
1278      * codec suggestion on buffer type if != 0
1279      * - encoding: unused
1280      * - decoding: Set by libavcodec. (before get_buffer() call)).
1281      */
1282     int buffer_hints;
1283
1284     /**
1285      * Pan scan.
1286      * - encoding: Set by user.
1287      * - decoding: Set by libavcodec.
1288      */
1289     AVPanScan *pan_scan;
1290
1291     /**
1292      * reordered opaque 64bit (generally an integer or a double precision float
1293      * PTS but can be anything).
1294      * The user sets AVCodecContext.reordered_opaque to represent the input at
1295      * that time,
1296      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1297      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1298      * @deprecated in favor of pkt_pts
1299      * - encoding: unused
1300      * - decoding: Read by user.
1301      */
1302     int64_t reordered_opaque;
1303
1304     /**
1305      * hardware accelerator private data (FFmpeg-allocated)
1306      * - encoding: unused
1307      * - decoding: Set by libavcodec
1308      */
1309     void *hwaccel_picture_private;
1310
1311     /**
1312      * the AVCodecContext which ff_thread_get_buffer() was last called on
1313      * - encoding: Set by libavcodec.
1314      * - decoding: Set by libavcodec.
1315      */
1316     struct AVCodecContext *owner;
1317
1318     /**
1319      * used by multithreading to store frame-specific info
1320      * - encoding: Set by libavcodec.
1321      * - decoding: Set by libavcodec.
1322      */
1323     void *thread_opaque;
1324
1325     /**
1326      * log2 of the size of the block which a single vector in motion_val represents:
1327      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1328      * - encoding: unused
1329      * - decoding: Set by libavcodec.
1330      */
1331     uint8_t motion_subsample_log2;
1332
1333     /**
1334      * Sample rate of the audio data.
1335      *
1336      * - encoding: unused
1337      * - decoding: read by user
1338      */
1339     int sample_rate;
1340
1341     /**
1342      * Channel layout of the audio data.
1343      *
1344      * - encoding: unused
1345      * - decoding: read by user.
1346      */
1347     uint64_t channel_layout;
1348
1349     /**
1350      * frame timestamp estimated using various heuristics, in stream time base
1351      * Code outside libavcodec should access this field using:
1352      * av_frame_get_best_effort_timestamp(frame)
1353      * - encoding: unused
1354      * - decoding: set by libavcodec, read by user.
1355      */
1356     int64_t best_effort_timestamp;
1357
1358     /**
1359      * reordered pos from the last AVPacket that has been input into the decoder
1360      * Code outside libavcodec should access this field using:
1361      * av_frame_get_pkt_pos(frame)
1362      * - encoding: unused
1363      * - decoding: Read by user.
1364      */
1365     int64_t pkt_pos;
1366
1367     /**
1368      * duration of the corresponding packet, expressed in
1369      * AVStream->time_base units, 0 if unknown.
1370      * Code outside libavcodec should access this field using:
1371      * av_frame_get_pkt_duration(frame)
1372      * - encoding: unused
1373      * - decoding: Read by user.
1374      */
1375     int64_t pkt_duration;
1376
1377     /**
1378      * metadata.
1379      * Code outside libavcodec should access this field using:
1380      * av_frame_get_metadata(frame)
1381      * - encoding: Set by user.
1382      * - decoding: Set by libavcodec.
1383      */
1384     AVDictionary *metadata;
1385
1386     /**
1387      * decode error flags of the frame, set to a combination of
1388      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1389      * were errors during the decoding.
1390      * Code outside libavcodec should access this field using:
1391      * av_frame_get_decode_error_flags(frame)
1392      * - encoding: unused
1393      * - decoding: set by libavcodec, read by user.
1394      */
1395     int decode_error_flags;
1396 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
1397 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
1398
1399     /**
1400      * number of audio channels, only used for audio.
1401      * Code outside libavcodec should access this field using:
1402      * av_frame_get_channels(frame)
1403      * - encoding: unused
1404      * - decoding: Read by user.
1405      */
1406     int64_t channels;
1407 } AVFrame;
1408
1409 /**
1410  * Accessors for some AVFrame fields.
1411  * The position of these field in the structure is not part of the ABI,
1412  * they should not be accessed directly outside libavcodec.
1413  */
1414 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1415 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1416 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
1417 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
1418 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
1419 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
1420 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
1421 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
1422 int     av_frame_get_channels             (const AVFrame *frame);
1423 void    av_frame_set_channels             (AVFrame *frame, int     val);
1424 int     av_frame_get_sample_rate          (const AVFrame *frame);
1425 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
1426 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
1427 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
1428 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
1429 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
1430
1431 struct AVCodecInternal;
1432
1433 enum AVFieldOrder {
1434     AV_FIELD_UNKNOWN,
1435     AV_FIELD_PROGRESSIVE,
1436     AV_FIELD_TT,          //< Top coded_first, top displayed first
1437     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1438     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1439     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1440 };
1441
1442 /**
1443  * main external API structure.
1444  * New fields can be added to the end with minor version bumps.
1445  * Removal, reordering and changes to existing fields require a major
1446  * version bump.
1447  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1448  * applications.
1449  * sizeof(AVCodecContext) must not be used outside libav*.
1450  */
1451 typedef struct AVCodecContext {
1452     /**
1453      * information on struct for av_log
1454      * - set by avcodec_alloc_context3
1455      */
1456     const AVClass *av_class;
1457     int log_level_offset;
1458
1459     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1460     const struct AVCodec  *codec;
1461     char             codec_name[32];
1462     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1463
1464     /**
1465      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1466      * This is used to work around some encoder bugs.
1467      * A demuxer should set this to what is stored in the field used to identify the codec.
1468      * If there are multiple such fields in a container then the demuxer should choose the one
1469      * which maximizes the information about the used codec.
1470      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1471      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1472      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1473      * first.
1474      * - encoding: Set by user, if not then the default based on codec_id will be used.
1475      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1476      */
1477     unsigned int codec_tag;
1478
1479     /**
1480      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1481      * This is used to work around some encoder bugs.
1482      * - encoding: unused
1483      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1484      */
1485     unsigned int stream_codec_tag;
1486
1487 #if FF_API_SUB_ID
1488     /**
1489      * @deprecated this field is unused
1490      */
1491     attribute_deprecated int sub_id;
1492 #endif
1493
1494     void *priv_data;
1495
1496     /**
1497      * Private context used for internal data.
1498      *
1499      * Unlike priv_data, this is not codec-specific. It is used in general
1500      * libavcodec functions.
1501      */
1502     struct AVCodecInternal *internal;
1503
1504     /**
1505      * Private data of the user, can be used to carry app specific stuff.
1506      * - encoding: Set by user.
1507      * - decoding: Set by user.
1508      */
1509     void *opaque;
1510
1511     /**
1512      * the average bitrate
1513      * - encoding: Set by user; unused for constant quantizer encoding.
1514      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1515      */
1516     int bit_rate;
1517
1518     /**
1519      * number of bits the bitstream is allowed to diverge from the reference.
1520      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1521      * - encoding: Set by user; unused for constant quantizer encoding.
1522      * - decoding: unused
1523      */
1524     int bit_rate_tolerance;
1525
1526     /**
1527      * Global quality for codecs which cannot change it per frame.
1528      * This should be proportional to MPEG-1/2/4 qscale.
1529      * - encoding: Set by user.
1530      * - decoding: unused
1531      */
1532     int global_quality;
1533
1534     /**
1535      * - encoding: Set by user.
1536      * - decoding: unused
1537      */
1538     int compression_level;
1539 #define FF_COMPRESSION_DEFAULT -1
1540
1541     /**
1542      * CODEC_FLAG_*.
1543      * - encoding: Set by user.
1544      * - decoding: Set by user.
1545      */
1546     int flags;
1547
1548     /**
1549      * CODEC_FLAG2_*
1550      * - encoding: Set by user.
1551      * - decoding: Set by user.
1552      */
1553     int flags2;
1554
1555     /**
1556      * some codecs need / can use extradata like Huffman tables.
1557      * mjpeg: Huffman tables
1558      * rv10: additional flags
1559      * mpeg4: global headers (they can be in the bitstream or here)
1560      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1561      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1562      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1563      * - encoding: Set/allocated/freed by libavcodec.
1564      * - decoding: Set/allocated/freed by user.
1565      */
1566     uint8_t *extradata;
1567     int extradata_size;
1568
1569     /**
1570      * This is the fundamental unit of time (in seconds) in terms
1571      * of which frame timestamps are represented. For fixed-fps content,
1572      * timebase should be 1/framerate and timestamp increments should be
1573      * identically 1.
1574      * - encoding: MUST be set by user.
1575      * - decoding: Set by libavcodec.
1576      */
1577     AVRational time_base;
1578
1579     /**
1580      * For some codecs, the time base is closer to the field rate than the frame rate.
1581      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1582      * if no telecine is used ...
1583      *
1584      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1585      */
1586     int ticks_per_frame;
1587
1588     /**
1589      * Encoding: Number of frames delay there will be from the encoder input to
1590      *           the decoder output. (we assume the decoder matches the spec)
1591      * Decoding: Number of frames delay in addition to what a standard decoder
1592      *           as specified in the spec would produce.
1593      *
1594      * Video:
1595      *   Number of frames the decoded output will be delayed relative to the
1596      *   encoded input.
1597      *
1598      * Audio:
1599      *   Number of "priming" samples added to the beginning of the stream
1600      *   during encoding. The decoded output will be delayed by this many
1601      *   samples relative to the input to the encoder. Note that this field is
1602      *   purely informational and does not directly affect the pts output by
1603      *   the encoder, which should always be based on the actual presentation
1604      *   time, including any delay.
1605      *
1606      * - encoding: Set by libavcodec.
1607      * - decoding: Set by libavcodec.
1608      */
1609     int delay;
1610
1611
1612     /* video only */
1613     /**
1614      * picture width / height.
1615      * - encoding: MUST be set by user.
1616      * - decoding: Set by libavcodec.
1617      * Note: For compatibility it is possible to set this instead of
1618      * coded_width/height before decoding.
1619      */
1620     int width, height;
1621
1622     /**
1623      * Bitstream width / height, may be different from width/height if lowres enabled.
1624      * - encoding: unused
1625      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1626      */
1627     int coded_width, coded_height;
1628
1629 #define FF_ASPECT_EXTENDED 15
1630
1631     /**
1632      * the number of pictures in a group of pictures, or 0 for intra_only
1633      * - encoding: Set by user.
1634      * - decoding: unused
1635      */
1636     int gop_size;
1637
1638     /**
1639      * Pixel format, see PIX_FMT_xxx.
1640      * May be set by the demuxer if known from headers.
1641      * May be overridden by the decoder if it knows better.
1642      * - encoding: Set by user.
1643      * - decoding: Set by user if known, overridden by libavcodec if known
1644      */
1645     enum PixelFormat pix_fmt;
1646
1647     /**
1648      * Motion estimation algorithm used for video coding.
1649      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1650      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1651      * - encoding: MUST be set by user.
1652      * - decoding: unused
1653      */
1654     int me_method;
1655
1656     /**
1657      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1658      * decoder to draw a horizontal band. It improves cache usage. Not
1659      * all codecs can do that. You must check the codec capabilities
1660      * beforehand.
1661      * When multithreading is used, it may be called from multiple threads
1662      * at the same time; threads might draw different parts of the same AVFrame,
1663      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1664      * in order.
1665      * The function is also used by hardware acceleration APIs.
1666      * It is called at least once during frame decoding to pass
1667      * the data needed for hardware render.
1668      * In that mode instead of pixel data, AVFrame points to
1669      * a structure specific to the acceleration API. The application
1670      * reads the structure and can change some fields to indicate progress
1671      * or mark state.
1672      * - encoding: unused
1673      * - decoding: Set by user.
1674      * @param height the height of the slice
1675      * @param y the y position of the slice
1676      * @param type 1->top field, 2->bottom field, 3->frame
1677      * @param offset offset into the AVFrame.data from which the slice should be read
1678      */
1679     void (*draw_horiz_band)(struct AVCodecContext *s,
1680                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1681                             int y, int type, int height);
1682
1683     /**
1684      * callback to negotiate the pixelFormat
1685      * @param fmt is the list of formats which are supported by the codec,
1686      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1687      * The first is always the native one.
1688      * @return the chosen format
1689      * - encoding: unused
1690      * - decoding: Set by user, if not set the native format will be chosen.
1691      */
1692     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1693
1694     /**
1695      * maximum number of B-frames between non-B-frames
1696      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1697      * - encoding: Set by user.
1698      * - decoding: unused
1699      */
1700     int max_b_frames;
1701
1702     /**
1703      * qscale factor between IP and B-frames
1704      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1705      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1706      * - encoding: Set by user.
1707      * - decoding: unused
1708      */
1709     float b_quant_factor;
1710
1711     /** obsolete FIXME remove */
1712     int rc_strategy;
1713 #define FF_RC_STRATEGY_XVID 1
1714
1715     int b_frame_strategy;
1716
1717 #if FF_API_MPV_GLOBAL_OPTS
1718     /**
1719      * luma single coefficient elimination threshold
1720      * - encoding: Set by user.
1721      * - decoding: unused
1722      */
1723     attribute_deprecated int luma_elim_threshold;
1724
1725     /**
1726      * chroma single coeff elimination threshold
1727      * - encoding: Set by user.
1728      * - decoding: unused
1729      */
1730     attribute_deprecated int chroma_elim_threshold;
1731 #endif
1732
1733     /**
1734      * qscale offset between IP and B-frames
1735      * - encoding: Set by user.
1736      * - decoding: unused
1737      */
1738     float b_quant_offset;
1739
1740     /**
1741      * Size of the frame reordering buffer in the decoder.
1742      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1743      * - encoding: Set by libavcodec.
1744      * - decoding: Set by libavcodec.
1745      */
1746     int has_b_frames;
1747
1748     /**
1749      * 0-> h263 quant 1-> mpeg quant
1750      * - encoding: Set by user.
1751      * - decoding: unused
1752      */
1753     int mpeg_quant;
1754
1755     /**
1756      * qscale factor between P and I-frames
1757      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1758      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1759      * - encoding: Set by user.
1760      * - decoding: unused
1761      */
1762     float i_quant_factor;
1763
1764     /**
1765      * qscale offset between P and I-frames
1766      * - encoding: Set by user.
1767      * - decoding: unused
1768      */
1769     float i_quant_offset;
1770
1771     /**
1772      * luminance masking (0-> disabled)
1773      * - encoding: Set by user.
1774      * - decoding: unused
1775      */
1776     float lumi_masking;
1777
1778     /**
1779      * temporary complexity masking (0-> disabled)
1780      * - encoding: Set by user.
1781      * - decoding: unused
1782      */
1783     float temporal_cplx_masking;
1784
1785     /**
1786      * spatial complexity masking (0-> disabled)
1787      * - encoding: Set by user.
1788      * - decoding: unused
1789      */
1790     float spatial_cplx_masking;
1791
1792     /**
1793      * p block masking (0-> disabled)
1794      * - encoding: Set by user.
1795      * - decoding: unused
1796      */
1797     float p_masking;
1798
1799     /**
1800      * darkness masking (0-> disabled)
1801      * - encoding: Set by user.
1802      * - decoding: unused
1803      */
1804     float dark_masking;
1805
1806     /**
1807      * slice count
1808      * - encoding: Set by libavcodec.
1809      * - decoding: Set by user (or 0).
1810      */
1811     int slice_count;
1812     /**
1813      * prediction method (needed for huffyuv)
1814      * - encoding: Set by user.
1815      * - decoding: unused
1816      */
1817      int prediction_method;
1818 #define FF_PRED_LEFT   0
1819 #define FF_PRED_PLANE  1
1820 #define FF_PRED_MEDIAN 2
1821
1822     /**
1823      * slice offsets in the frame in bytes
1824      * - encoding: Set/allocated by libavcodec.
1825      * - decoding: Set/allocated by user (or NULL).
1826      */
1827     int *slice_offset;
1828
1829     /**
1830      * sample aspect ratio (0 if unknown)
1831      * That is the width of a pixel divided by the height of the pixel.
1832      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1833      * - encoding: Set by user.
1834      * - decoding: Set by libavcodec.
1835      */
1836     AVRational sample_aspect_ratio;
1837
1838     /**
1839      * motion estimation comparison function
1840      * - encoding: Set by user.
1841      * - decoding: unused
1842      */
1843     int me_cmp;
1844     /**
1845      * subpixel motion estimation comparison function
1846      * - encoding: Set by user.
1847      * - decoding: unused
1848      */
1849     int me_sub_cmp;
1850     /**
1851      * macroblock comparison function (not supported yet)
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855     int mb_cmp;
1856     /**
1857      * interlaced DCT comparison function
1858      * - encoding: Set by user.
1859      * - decoding: unused
1860      */
1861     int ildct_cmp;
1862 #define FF_CMP_SAD    0
1863 #define FF_CMP_SSE    1
1864 #define FF_CMP_SATD   2
1865 #define FF_CMP_DCT    3
1866 #define FF_CMP_PSNR   4
1867 #define FF_CMP_BIT    5
1868 #define FF_CMP_RD     6
1869 #define FF_CMP_ZERO   7
1870 #define FF_CMP_VSAD   8
1871 #define FF_CMP_VSSE   9
1872 #define FF_CMP_NSSE   10
1873 #define FF_CMP_W53    11
1874 #define FF_CMP_W97    12
1875 #define FF_CMP_DCTMAX 13
1876 #define FF_CMP_DCT264 14
1877 #define FF_CMP_CHROMA 256
1878
1879     /**
1880      * ME diamond size & shape
1881      * - encoding: Set by user.
1882      * - decoding: unused
1883      */
1884     int dia_size;
1885
1886     /**
1887      * amount of previous MV predictors (2a+1 x 2a+1 square)
1888      * - encoding: Set by user.
1889      * - decoding: unused
1890      */
1891     int last_predictor_count;
1892
1893     /**
1894      * prepass for motion estimation
1895      * - encoding: Set by user.
1896      * - decoding: unused
1897      */
1898     int pre_me;
1899
1900     /**
1901      * motion estimation prepass comparison function
1902      * - encoding: Set by user.
1903      * - decoding: unused
1904      */
1905     int me_pre_cmp;
1906
1907     /**
1908      * ME prepass diamond size & shape
1909      * - encoding: Set by user.
1910      * - decoding: unused
1911      */
1912     int pre_dia_size;
1913
1914     /**
1915      * subpel ME quality
1916      * - encoding: Set by user.
1917      * - decoding: unused
1918      */
1919     int me_subpel_quality;
1920
1921     /**
1922      * DTG active format information (additional aspect ratio
1923      * information only used in DVB MPEG-2 transport streams)
1924      * 0 if not set.
1925      *
1926      * - encoding: unused
1927      * - decoding: Set by decoder.
1928      */
1929     int dtg_active_format;
1930 #define FF_DTG_AFD_SAME         8
1931 #define FF_DTG_AFD_4_3          9
1932 #define FF_DTG_AFD_16_9         10
1933 #define FF_DTG_AFD_14_9         11
1934 #define FF_DTG_AFD_4_3_SP_14_9  13
1935 #define FF_DTG_AFD_16_9_SP_14_9 14
1936 #define FF_DTG_AFD_SP_4_3       15
1937
1938     /**
1939      * maximum motion estimation search range in subpel units
1940      * If 0 then no limit.
1941      *
1942      * - encoding: Set by user.
1943      * - decoding: unused
1944      */
1945     int me_range;
1946
1947     /**
1948      * intra quantizer bias
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     int intra_quant_bias;
1953 #define FF_DEFAULT_QUANT_BIAS 999999
1954
1955     /**
1956      * inter quantizer bias
1957      * - encoding: Set by user.
1958      * - decoding: unused
1959      */
1960     int inter_quant_bias;
1961
1962 #if FF_API_COLOR_TABLE_ID
1963     /**
1964      * color table ID
1965      * - encoding: unused
1966      * - decoding: Which clrtable should be used for 8bit RGB images.
1967      *             Tables have to be stored somewhere. FIXME
1968      */
1969     attribute_deprecated int color_table_id;
1970 #endif
1971
1972     /**
1973      * slice flags
1974      * - encoding: unused
1975      * - decoding: Set by user.
1976      */
1977     int slice_flags;
1978 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1979 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1980 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1981
1982     /**
1983      * XVideo Motion Acceleration
1984      * - encoding: forbidden
1985      * - decoding: set by decoder
1986      */
1987     int xvmc_acceleration;
1988
1989     /**
1990      * macroblock decision mode
1991      * - encoding: Set by user.
1992      * - decoding: unused
1993      */
1994     int mb_decision;
1995 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1996 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1997 #define FF_MB_DECISION_RD     2        ///< rate distortion
1998
1999     /**
2000      * custom intra quantization matrix
2001      * - encoding: Set by user, can be NULL.
2002      * - decoding: Set by libavcodec.
2003      */
2004     uint16_t *intra_matrix;
2005
2006     /**
2007      * custom inter quantization matrix
2008      * - encoding: Set by user, can be NULL.
2009      * - decoding: Set by libavcodec.
2010      */
2011     uint16_t *inter_matrix;
2012
2013     /**
2014      * scene change detection threshold
2015      * 0 is default, larger means fewer detected scene changes.
2016      * - encoding: Set by user.
2017      * - decoding: unused
2018      */
2019     int scenechange_threshold;
2020
2021     /**
2022      * noise reduction strength
2023      * - encoding: Set by user.
2024      * - decoding: unused
2025      */
2026     int noise_reduction;
2027
2028 #if FF_API_INTER_THRESHOLD
2029     /**
2030      * @deprecated this field is unused
2031      */
2032     attribute_deprecated int inter_threshold;
2033 #endif
2034
2035 #if FF_API_MPV_GLOBAL_OPTS
2036     /**
2037      * @deprecated use mpegvideo private options instead
2038      */
2039     attribute_deprecated int quantizer_noise_shaping;
2040 #endif
2041
2042     /**
2043      * Motion estimation threshold below which no motion estimation is
2044      * performed, but instead the user specified motion vectors are used.
2045      *
2046      * - encoding: Set by user.
2047      * - decoding: unused
2048      */
2049     int me_threshold;
2050
2051     /**
2052      * Macroblock threshold below which the user specified macroblock types will be used.
2053      * - encoding: Set by user.
2054      * - decoding: unused
2055      */
2056     int mb_threshold;
2057
2058     /**
2059      * precision of the intra DC coefficient - 8
2060      * - encoding: Set by user.
2061      * - decoding: unused
2062      */
2063     int intra_dc_precision;
2064
2065     /**
2066      * Number of macroblock rows at the top which are skipped.
2067      * - encoding: unused
2068      * - decoding: Set by user.
2069      */
2070     int skip_top;
2071
2072     /**
2073      * Number of macroblock rows at the bottom which are skipped.
2074      * - encoding: unused
2075      * - decoding: Set by user.
2076      */
2077     int skip_bottom;
2078
2079     /**
2080      * Border processing masking, raises the quantizer for mbs on the borders
2081      * of the picture.
2082      * - encoding: Set by user.
2083      * - decoding: unused
2084      */
2085     float border_masking;
2086
2087     /**
2088      * minimum MB lagrange multipler
2089      * - encoding: Set by user.
2090      * - decoding: unused
2091      */
2092     int mb_lmin;
2093
2094     /**
2095      * maximum MB lagrange multipler
2096      * - encoding: Set by user.
2097      * - decoding: unused
2098      */
2099     int mb_lmax;
2100
2101     /**
2102      *
2103      * - encoding: Set by user.
2104      * - decoding: unused
2105      */
2106     int me_penalty_compensation;
2107
2108     /**
2109      *
2110      * - encoding: Set by user.
2111      * - decoding: unused
2112      */
2113     int bidir_refine;
2114
2115     /**
2116      *
2117      * - encoding: Set by user.
2118      * - decoding: unused
2119      */
2120     int brd_scale;
2121
2122     /**
2123      * minimum GOP size
2124      * - encoding: Set by user.
2125      * - decoding: unused
2126      */
2127     int keyint_min;
2128
2129     /**
2130      * number of reference frames
2131      * - encoding: Set by user.
2132      * - decoding: Set by lavc.
2133      */
2134     int refs;
2135
2136     /**
2137      * chroma qp offset from luma
2138      * - encoding: Set by user.
2139      * - decoding: unused
2140      */
2141     int chromaoffset;
2142
2143     /**
2144      * Multiplied by qscale for each frame and added to scene_change_score.
2145      * - encoding: Set by user.
2146      * - decoding: unused
2147      */
2148     int scenechange_factor;
2149
2150     /**
2151      *
2152      * Note: Value depends upon the compare function used for fullpel ME.
2153      * - encoding: Set by user.
2154      * - decoding: unused
2155      */
2156     int mv0_threshold;
2157
2158     /**
2159      * Adjust sensitivity of b_frame_strategy 1.
2160      * - encoding: Set by user.
2161      * - decoding: unused
2162      */
2163     int b_sensitivity;
2164
2165     /**
2166      * Chromaticity coordinates of the source primaries.
2167      * - encoding: Set by user
2168      * - decoding: Set by libavcodec
2169      */
2170     enum AVColorPrimaries color_primaries;
2171
2172     /**
2173      * Color Transfer Characteristic.
2174      * - encoding: Set by user
2175      * - decoding: Set by libavcodec
2176      */
2177     enum AVColorTransferCharacteristic color_trc;
2178
2179     /**
2180      * YUV colorspace type.
2181      * - encoding: Set by user
2182      * - decoding: Set by libavcodec
2183      */
2184     enum AVColorSpace colorspace;
2185
2186     /**
2187      * MPEG vs JPEG YUV range.
2188      * - encoding: Set by user
2189      * - decoding: Set by libavcodec
2190      */
2191     enum AVColorRange color_range;
2192
2193     /**
2194      * This defines the location of chroma samples.
2195      * - encoding: Set by user
2196      * - decoding: Set by libavcodec
2197      */
2198     enum AVChromaLocation chroma_sample_location;
2199
2200     /**
2201      * Number of slices.
2202      * Indicates number of picture subdivisions. Used for parallelized
2203      * decoding.
2204      * - encoding: Set by user
2205      * - decoding: unused
2206      */
2207     int slices;
2208
2209     /** Field order
2210      * - encoding: set by libavcodec
2211      * - decoding: Set by libavcodec
2212      */
2213     enum AVFieldOrder field_order;
2214
2215     /* audio only */
2216     int sample_rate; ///< samples per second
2217     int channels;    ///< number of audio channels
2218
2219     /**
2220      * audio sample format
2221      * - encoding: Set by user.
2222      * - decoding: Set by libavcodec.
2223      */
2224     enum AVSampleFormat sample_fmt;  ///< sample format
2225
2226     /* The following data should not be initialized. */
2227     /**
2228      * Samples per packet, initialized when calling 'init'.
2229      */
2230     int frame_size;
2231
2232     /**
2233      * Frame counter, set by libavcodec.
2234      *
2235      * - decoding: total number of frames returned from the decoder so far.
2236      * - encoding: total number of frames passed to the encoder so far.
2237      *
2238      *   @note the counter is not incremented if encoding/decoding resulted in
2239      *   an error.
2240      */
2241     int frame_number;
2242
2243     /**
2244      * number of bytes per packet if constant and known or 0
2245      * Used by some WAV based audio codecs.
2246      */
2247     int block_align;
2248
2249     /**
2250      * Audio cutoff bandwidth (0 means "automatic")
2251      * - encoding: Set by user.
2252      * - decoding: unused
2253      */
2254     int cutoff;
2255
2256 #if FF_API_REQUEST_CHANNELS
2257     /**
2258      * Decoder should decode to this many channels if it can (0 for default)
2259      * - encoding: unused
2260      * - decoding: Set by user.
2261      * @deprecated Deprecated in favor of request_channel_layout.
2262      */
2263     int request_channels;
2264 #endif
2265
2266     /**
2267      * Audio channel layout.
2268      * - encoding: set by user.
2269      * - decoding: set by user, may be overwritten by libavcodec.
2270      */
2271     uint64_t channel_layout;
2272
2273     /**
2274      * Request decoder to use this channel layout if it can (0 for default)
2275      * - encoding: unused
2276      * - decoding: Set by user.
2277      */
2278     uint64_t request_channel_layout;
2279
2280     /**
2281      * Type of service that the audio stream conveys.
2282      * - encoding: Set by user.
2283      * - decoding: Set by libavcodec.
2284      */
2285     enum AVAudioServiceType audio_service_type;
2286
2287     /**
2288      * desired sample format
2289      * - encoding: Not used.
2290      * - decoding: Set by user.
2291      * Decoder will decode to this format if it can.
2292      */
2293     enum AVSampleFormat request_sample_fmt;
2294
2295     /**
2296      * Called at the beginning of each frame to get a buffer for it.
2297      *
2298      * The function will set AVFrame.data[], AVFrame.linesize[].
2299      * AVFrame.extended_data[] must also be set, but it should be the same as
2300      * AVFrame.data[] except for planar audio with more channels than can fit
2301      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2302      * many data pointers as it can hold.
2303      *
2304      * if CODEC_CAP_DR1 is not set then get_buffer() must call
2305      * avcodec_default_get_buffer() instead of providing buffers allocated by
2306      * some other means.
2307      *
2308      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2309      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2310      * but if get_buffer() is overridden then alignment considerations should
2311      * be taken into account.
2312      *
2313      * @see avcodec_default_get_buffer()
2314      *
2315      * Video:
2316      *
2317      * If pic.reference is set then the frame will be read later by libavcodec.
2318      * avcodec_align_dimensions2() should be used to find the required width and
2319      * height, as they normally need to be rounded up to the next multiple of 16.
2320      *
2321      * If frame multithreading is used and thread_safe_callbacks is set,
2322      * it may be called from a different thread, but not from more than one at
2323      * once. Does not need to be reentrant.
2324      *
2325      * @see release_buffer(), reget_buffer()
2326      * @see avcodec_align_dimensions2()
2327      *
2328      * Audio:
2329      *
2330      * Decoders request a buffer of a particular size by setting
2331      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2332      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2333      * to a smaller value in the output frame.
2334      *
2335      * Decoders cannot use the buffer after returning from
2336      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2337      * is assumed to be released immediately upon return.
2338      *
2339      * As a convenience, av_samples_get_buffer_size() and
2340      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2341      * functions to find the required data size and to fill data pointers and
2342      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2343      * since all planes must be the same size.
2344      *
2345      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2346      *
2347      * - encoding: unused
2348      * - decoding: Set by libavcodec, user can override.
2349      */
2350     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2351
2352     /**
2353      * Called to release buffers which were allocated with get_buffer.
2354      * A released buffer can be reused in get_buffer().
2355      * pic.data[*] must be set to NULL.
2356      * May be called from a different thread if frame multithreading is used,
2357      * but not by more than one thread at once, so does not need to be reentrant.
2358      * - encoding: unused
2359      * - decoding: Set by libavcodec, user can override.
2360      */
2361     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2362
2363     /**
2364      * Called at the beginning of a frame to get cr buffer for it.
2365      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2366      * libavcodec will pass previous buffer in pic, function should return
2367      * same buffer or new buffer with old frame "painted" into it.
2368      * If pic.data[0] == NULL must behave like get_buffer().
2369      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2370      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2371      * some other means.
2372      * - encoding: unused
2373      * - decoding: Set by libavcodec, user can override.
2374      */
2375     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2376
2377
2378     /* - encoding parameters */
2379     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2380     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2381
2382     /**
2383      * minimum quantizer
2384      * - encoding: Set by user.
2385      * - decoding: unused
2386      */
2387     int qmin;
2388
2389     /**
2390      * maximum quantizer
2391      * - encoding: Set by user.
2392      * - decoding: unused
2393      */
2394     int qmax;
2395
2396     /**
2397      * maximum quantizer difference between frames
2398      * - encoding: Set by user.
2399      * - decoding: unused
2400      */
2401     int max_qdiff;
2402
2403     /**
2404      * ratecontrol qmin qmax limiting method
2405      * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2406      * - encoding: Set by user.
2407      * - decoding: unused
2408      */
2409     float rc_qsquish;
2410
2411     float rc_qmod_amp;
2412     int rc_qmod_freq;
2413
2414     /**
2415      * decoder bitstream buffer size
2416      * - encoding: Set by user.
2417      * - decoding: unused
2418      */
2419     int rc_buffer_size;
2420
2421     /**
2422      * ratecontrol override, see RcOverride
2423      * - encoding: Allocated/set/freed by user.
2424      * - decoding: unused
2425      */
2426     int rc_override_count;
2427     RcOverride *rc_override;
2428
2429     /**
2430      * rate control equation
2431      * - encoding: Set by user
2432      * - decoding: unused
2433      */
2434     const char *rc_eq;
2435
2436     /**
2437      * maximum bitrate
2438      * - encoding: Set by user.
2439      * - decoding: unused
2440      */
2441     int rc_max_rate;
2442
2443     /**
2444      * minimum bitrate
2445      * - encoding: Set by user.
2446      * - decoding: unused
2447      */
2448     int rc_min_rate;
2449
2450     float rc_buffer_aggressivity;
2451
2452     /**
2453      * initial complexity for pass1 ratecontrol
2454      * - encoding: Set by user.
2455      * - decoding: unused
2456      */
2457     float rc_initial_cplx;
2458
2459     /**
2460      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2461      * - encoding: Set by user.
2462      * - decoding: unused.
2463      */
2464     float rc_max_available_vbv_use;
2465
2466     /**
2467      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2468      * - encoding: Set by user.
2469      * - decoding: unused.
2470      */
2471     float rc_min_vbv_overflow_use;
2472
2473     /**
2474      * Number of bits which should be loaded into the rc buffer before decoding starts.
2475      * - encoding: Set by user.
2476      * - decoding: unused
2477      */
2478     int rc_initial_buffer_occupancy;
2479
2480 #define FF_CODER_TYPE_VLC       0
2481 #define FF_CODER_TYPE_AC        1
2482 #define FF_CODER_TYPE_RAW       2
2483 #define FF_CODER_TYPE_RLE       3
2484 #define FF_CODER_TYPE_DEFLATE   4
2485     /**
2486      * coder type
2487      * - encoding: Set by user.
2488      * - decoding: unused
2489      */
2490     int coder_type;
2491
2492     /**
2493      * context model
2494      * - encoding: Set by user.
2495      * - decoding: unused
2496      */
2497     int context_model;
2498
2499     /**
2500      * minimum Lagrange multipler
2501      * - encoding: Set by user.
2502      * - decoding: unused
2503      */
2504     int lmin;
2505
2506     /**
2507      * maximum Lagrange multipler
2508      * - encoding: Set by user.
2509      * - decoding: unused
2510      */
2511     int lmax;
2512
2513     /**
2514      * frame skip threshold
2515      * - encoding: Set by user.
2516      * - decoding: unused
2517      */
2518     int frame_skip_threshold;
2519
2520     /**
2521      * frame skip factor
2522      * - encoding: Set by user.
2523      * - decoding: unused
2524      */
2525     int frame_skip_factor;
2526
2527     /**
2528      * frame skip exponent
2529      * - encoding: Set by user.
2530      * - decoding: unused
2531      */
2532     int frame_skip_exp;
2533
2534     /**
2535      * frame skip comparison function
2536      * - encoding: Set by user.
2537      * - decoding: unused
2538      */
2539     int frame_skip_cmp;
2540
2541     /**
2542      * trellis RD quantization
2543      * - encoding: Set by user.
2544      * - decoding: unused
2545      */
2546     int trellis;
2547
2548     /**
2549      * - encoding: Set by user.
2550      * - decoding: unused
2551      */
2552     int min_prediction_order;
2553
2554     /**
2555      * - encoding: Set by user.
2556      * - decoding: unused
2557      */
2558     int max_prediction_order;
2559
2560     /**
2561      * GOP timecode frame start number
2562      * - encoding: Set by user, in non drop frame format
2563      * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2564      */
2565     int64_t timecode_frame_start;
2566
2567     /* The RTP callback: This function is called    */
2568     /* every time the encoder has a packet to send. */
2569     /* It depends on the encoder if the data starts */
2570     /* with a Start Code (it should). H.263 does.   */
2571     /* mb_nb contains the number of macroblocks     */
2572     /* encoded in the RTP payload.                  */
2573     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2574
2575     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2576                             /* do its best to deliver a chunk with size     */
2577                             /* below rtp_payload_size, the chunk will start */
2578                             /* with a start code on some codecs like H.263. */
2579                             /* This doesn't take account of any particular  */
2580                             /* headers inside the transmitted RTP payload.  */
2581
2582     /* statistics, used for 2-pass encoding */
2583     int mv_bits;
2584     int header_bits;
2585     int i_tex_bits;
2586     int p_tex_bits;
2587     int i_count;
2588     int p_count;
2589     int skip_count;
2590     int misc_bits;
2591
2592     /**
2593      * number of bits used for the previously encoded frame
2594      * - encoding: Set by libavcodec.
2595      * - decoding: unused
2596      */
2597     int frame_bits;
2598
2599     /**
2600      * pass1 encoding statistics output buffer
2601      * - encoding: Set by libavcodec.
2602      * - decoding: unused
2603      */
2604     char *stats_out;
2605
2606     /**
2607      * pass2 encoding statistics input buffer
2608      * Concatenated stuff from stats_out of pass1 should be placed here.
2609      * - encoding: Allocated/set/freed by user.
2610      * - decoding: unused
2611      */
2612     char *stats_in;
2613
2614     /**
2615      * Work around bugs in encoders which sometimes cannot be detected automatically.
2616      * - encoding: Set by user
2617      * - decoding: Set by user
2618      */
2619     int workaround_bugs;
2620 #define FF_BUG_AUTODETECT       1  ///< autodetection
2621 #define FF_BUG_OLD_MSMPEG4      2
2622 #define FF_BUG_XVID_ILACE       4
2623 #define FF_BUG_UMP4             8
2624 #define FF_BUG_NO_PADDING       16
2625 #define FF_BUG_AMV              32
2626 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2627 #define FF_BUG_QPEL_CHROMA      64
2628 #define FF_BUG_STD_QPEL         128
2629 #define FF_BUG_QPEL_CHROMA2     256
2630 #define FF_BUG_DIRECT_BLOCKSIZE 512
2631 #define FF_BUG_EDGE             1024
2632 #define FF_BUG_HPEL_CHROMA      2048
2633 #define FF_BUG_DC_CLIP          4096
2634 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2635 #define FF_BUG_TRUNCATED       16384
2636
2637     /**
2638      * strictly follow the standard (MPEG4, ...).
2639      * - encoding: Set by user.
2640      * - decoding: Set by user.
2641      * Setting this to STRICT or higher means the encoder and decoder will
2642      * generally do stupid things, whereas setting it to unofficial or lower
2643      * will mean the encoder might produce output that is not supported by all
2644      * spec-compliant decoders. Decoders don't differentiate between normal,
2645      * unofficial and experimental (that is, they always try to decode things
2646      * when they can) unless they are explicitly asked to behave stupidly
2647      * (=strictly conform to the specs)
2648      */
2649     int strict_std_compliance;
2650 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2651 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2652 #define FF_COMPLIANCE_NORMAL        0
2653 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2654 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2655
2656     /**
2657      * error concealment flags
2658      * - encoding: unused
2659      * - decoding: Set by user.
2660      */
2661     int error_concealment;
2662 #define FF_EC_GUESS_MVS   1
2663 #define FF_EC_DEBLOCK     2
2664
2665     /**
2666      * debug
2667      * - encoding: Set by user.
2668      * - decoding: Set by user.
2669      */
2670     int debug;
2671 #define FF_DEBUG_PICT_INFO   1
2672 #define FF_DEBUG_RC          2
2673 #define FF_DEBUG_BITSTREAM   4
2674 #define FF_DEBUG_MB_TYPE     8
2675 #define FF_DEBUG_QP          16
2676 #define FF_DEBUG_MV          32
2677 #define FF_DEBUG_DCT_COEFF   0x00000040
2678 #define FF_DEBUG_SKIP        0x00000080
2679 #define FF_DEBUG_STARTCODE   0x00000100
2680 #define FF_DEBUG_PTS         0x00000200
2681 #define FF_DEBUG_ER          0x00000400
2682 #define FF_DEBUG_MMCO        0x00000800
2683 #define FF_DEBUG_BUGS        0x00001000
2684 #define FF_DEBUG_VIS_QP      0x00002000
2685 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2686 #define FF_DEBUG_BUFFERS     0x00008000
2687 #define FF_DEBUG_THREADS     0x00010000
2688
2689     /**
2690      * debug
2691      * - encoding: Set by user.
2692      * - decoding: Set by user.
2693      */
2694     int debug_mv;
2695 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2696 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2697 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2698
2699     /**
2700      * Error recognition; may misdetect some more or less valid parts as errors.
2701      * - encoding: unused
2702      * - decoding: Set by user.
2703      */
2704     int err_recognition;
2705 #define AV_EF_CRCCHECK  (1<<0)
2706 #define AV_EF_BITSTREAM (1<<1)
2707 #define AV_EF_BUFFER    (1<<2)
2708 #define AV_EF_EXPLODE   (1<<3)
2709
2710 #define AV_EF_CAREFUL    (1<<16)
2711 #define AV_EF_COMPLIANT  (1<<17)
2712 #define AV_EF_AGGRESSIVE (1<<18)
2713
2714
2715     /**
2716      * opaque 64bit number (generally a PTS) that will be reordered and
2717      * output in AVFrame.reordered_opaque
2718      * @deprecated in favor of pkt_pts
2719      * - encoding: unused
2720      * - decoding: Set by user.
2721      */
2722     int64_t reordered_opaque;
2723
2724     /**
2725      * Hardware accelerator in use
2726      * - encoding: unused.
2727      * - decoding: Set by libavcodec
2728      */
2729     struct AVHWAccel *hwaccel;
2730
2731     /**
2732      * Hardware accelerator context.
2733      * For some hardware accelerators, a global context needs to be
2734      * provided by the user. In that case, this holds display-dependent
2735      * data FFmpeg cannot instantiate itself. Please refer to the
2736      * FFmpeg HW accelerator documentation to know how to fill this
2737      * is. e.g. for VA API, this is a struct vaapi_context.
2738      * - encoding: unused
2739      * - decoding: Set by user
2740      */
2741     void *hwaccel_context;
2742
2743     /**
2744      * error
2745      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2746      * - decoding: unused
2747      */
2748     uint64_t error[AV_NUM_DATA_POINTERS];
2749
2750     /**
2751      * DCT algorithm, see FF_DCT_* below
2752      * - encoding: Set by user.
2753      * - decoding: unused
2754      */
2755     int dct_algo;
2756 #define FF_DCT_AUTO    0
2757 #define FF_DCT_FASTINT 1
2758 #define FF_DCT_INT     2
2759 #define FF_DCT_MMX     3
2760 #define FF_DCT_ALTIVEC 5
2761 #define FF_DCT_FAAN    6
2762
2763     /**
2764      * IDCT algorithm, see FF_IDCT_* below.
2765      * - encoding: Set by user.
2766      * - decoding: Set by user.
2767      */
2768     int idct_algo;
2769 #define FF_IDCT_AUTO          0
2770 #define FF_IDCT_INT           1
2771 #define FF_IDCT_SIMPLE        2
2772 #define FF_IDCT_SIMPLEMMX     3
2773 #define FF_IDCT_LIBMPEG2MMX   4
2774 #define FF_IDCT_MMI           5
2775 #define FF_IDCT_ARM           7
2776 #define FF_IDCT_ALTIVEC       8
2777 #define FF_IDCT_SH4           9
2778 #define FF_IDCT_SIMPLEARM     10
2779 #define FF_IDCT_H264          11
2780 #define FF_IDCT_VP3           12
2781 #define FF_IDCT_IPP           13
2782 #define FF_IDCT_XVIDMMX       14
2783 #define FF_IDCT_CAVS          15
2784 #define FF_IDCT_SIMPLEARMV5TE 16
2785 #define FF_IDCT_SIMPLEARMV6   17
2786 #define FF_IDCT_SIMPLEVIS     18
2787 #define FF_IDCT_WMV2          19
2788 #define FF_IDCT_FAAN          20
2789 #define FF_IDCT_EA            21
2790 #define FF_IDCT_SIMPLENEON    22
2791 #define FF_IDCT_SIMPLEALPHA   23
2792 #define FF_IDCT_BINK          24
2793
2794 #if FF_API_DSP_MASK
2795     /**
2796      * Unused.
2797      * @deprecated use av_set_cpu_flags_mask() instead.
2798      */
2799     attribute_deprecated unsigned dsp_mask;
2800 #endif
2801
2802     /**
2803      * bits per sample/pixel from the demuxer (needed for huffyuv).
2804      * - encoding: Set by libavcodec.
2805      * - decoding: Set by user.
2806      */
2807      int bits_per_coded_sample;
2808
2809     /**
2810      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2811      * - encoding: set by user.
2812      * - decoding: set by libavcodec.
2813      */
2814     int bits_per_raw_sample;
2815
2816     /**
2817      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2818      * - encoding: unused
2819      * - decoding: Set by user.
2820      */
2821      int lowres;
2822
2823     /**
2824      * the picture in the bitstream
2825      * - encoding: Set by libavcodec.
2826      * - decoding: Set by libavcodec.
2827      */
2828     AVFrame *coded_frame;
2829
2830     /**
2831      * thread count
2832      * is used to decide how many independent tasks should be passed to execute()
2833      * - encoding: Set by user.
2834      * - decoding: Set by user.
2835      */
2836     int thread_count;
2837
2838     /**
2839      * Which multithreading methods to use.
2840      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2841      * so clients which cannot provide future frames should not use it.
2842      *
2843      * - encoding: Set by user, otherwise the default is used.
2844      * - decoding: Set by user, otherwise the default is used.
2845      */
2846     int thread_type;
2847 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2848 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2849
2850     /**
2851      * Which multithreading methods are in use by the codec.
2852      * - encoding: Set by libavcodec.
2853      * - decoding: Set by libavcodec.
2854      */
2855     int active_thread_type;
2856
2857     /**
2858      * Set by the client if its custom get_buffer() callback can be called
2859      * synchronously from another thread, which allows faster multithreaded decoding.
2860      * draw_horiz_band() will be called from other threads regardless of this setting.
2861      * Ignored if the default get_buffer() is used.
2862      * - encoding: Set by user.
2863      * - decoding: Set by user.
2864      */
2865     int thread_safe_callbacks;
2866
2867     /**
2868      * The codec may call this to execute several independent things.
2869      * It will return only after finishing all tasks.
2870      * The user may replace this with some multithreaded implementation,
2871      * the default implementation will execute the parts serially.
2872      * @param count the number of things to execute
2873      * - encoding: Set by libavcodec, user can override.
2874      * - decoding: Set by libavcodec, user can override.
2875      */
2876     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2877
2878     /**
2879      * The codec may call this to execute several independent things.
2880      * It will return only after finishing all tasks.
2881      * The user may replace this with some multithreaded implementation,
2882      * the default implementation will execute the parts serially.
2883      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2884      * @param c context passed also to func
2885      * @param count the number of things to execute
2886      * @param arg2 argument passed unchanged to func
2887      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2888      * @param func function that will be called count times, with jobnr from 0 to count-1.
2889      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2890      *             two instances of func executing at the same time will have the same threadnr.
2891      * @return always 0 currently, but code should handle a future improvement where when any call to func
2892      *         returns < 0 no further calls to func may be done and < 0 is returned.
2893      * - encoding: Set by libavcodec, user can override.
2894      * - decoding: Set by libavcodec, user can override.
2895      */
2896     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2897
2898     /**
2899      * thread opaque
2900      * Can be used by execute() to store some per AVCodecContext stuff.
2901      * - encoding: set by execute()
2902      * - decoding: set by execute()
2903      */
2904     void *thread_opaque;
2905
2906     /**
2907      * noise vs. sse weight for the nsse comparsion function
2908      * - encoding: Set by user.
2909      * - decoding: unused
2910      */
2911      int nsse_weight;
2912
2913     /**
2914      * profile
2915      * - encoding: Set by user.
2916      * - decoding: Set by libavcodec.
2917      */
2918      int profile;
2919 #define FF_PROFILE_UNKNOWN -99
2920 #define FF_PROFILE_RESERVED -100
2921
2922 #define FF_PROFILE_AAC_MAIN 0
2923 #define FF_PROFILE_AAC_LOW  1
2924 #define FF_PROFILE_AAC_SSR  2
2925 #define FF_PROFILE_AAC_LTP  3
2926 #define FF_PROFILE_AAC_HE   4
2927 #define FF_PROFILE_AAC_HE_V2 28
2928 #define FF_PROFILE_AAC_LD   22
2929 #define FF_PROFILE_AAC_ELD  38
2930
2931 #define FF_PROFILE_DTS         20
2932 #define FF_PROFILE_DTS_ES      30
2933 #define FF_PROFILE_DTS_96_24   40
2934 #define FF_PROFILE_DTS_HD_HRA  50
2935 #define FF_PROFILE_DTS_HD_MA   60
2936
2937 #define FF_PROFILE_MPEG2_422    0
2938 #define FF_PROFILE_MPEG2_HIGH   1
2939 #define FF_PROFILE_MPEG2_SS     2
2940 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2941 #define FF_PROFILE_MPEG2_MAIN   4
2942 #define FF_PROFILE_MPEG2_SIMPLE 5
2943
2944 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2945 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2946
2947 #define FF_PROFILE_H264_BASELINE             66
2948 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2949 #define FF_PROFILE_H264_MAIN                 77
2950 #define FF_PROFILE_H264_EXTENDED             88
2951 #define FF_PROFILE_H264_HIGH                 100
2952 #define FF_PROFILE_H264_HIGH_10              110
2953 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2954 #define FF_PROFILE_H264_HIGH_422             122
2955 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2956 #define FF_PROFILE_H264_HIGH_444             144
2957 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2958 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2959 #define FF_PROFILE_H264_CAVLC_444            44
2960
2961 #define FF_PROFILE_VC1_SIMPLE   0
2962 #define FF_PROFILE_VC1_MAIN     1
2963 #define FF_PROFILE_VC1_COMPLEX  2
2964 #define FF_PROFILE_VC1_ADVANCED 3
2965
2966 #define FF_PROFILE_MPEG4_SIMPLE                     0
2967 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2968 #define FF_PROFILE_MPEG4_CORE                       2
2969 #define FF_PROFILE_MPEG4_MAIN                       3
2970 #define FF_PROFILE_MPEG4_N_BIT                      4
2971 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2972 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2973 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2974 #define FF_PROFILE_MPEG4_HYBRID                     8
2975 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2976 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2977 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2978 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2979 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2980 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2981 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2982
2983     /**
2984      * level
2985      * - encoding: Set by user.
2986      * - decoding: Set by libavcodec.
2987      */
2988      int level;
2989 #define FF_LEVEL_UNKNOWN -99
2990
2991     /**
2992      *
2993      * - encoding: unused
2994      * - decoding: Set by user.
2995      */
2996     enum AVDiscard skip_loop_filter;
2997
2998     /**
2999      *
3000      * - encoding: unused
3001      * - decoding: Set by user.
3002      */
3003     enum AVDiscard skip_idct;
3004
3005     /**
3006      *
3007      * - encoding: unused
3008      * - decoding: Set by user.
3009      */
3010     enum AVDiscard skip_frame;
3011
3012     /**
3013      * Header containing style information for text subtitles.
3014      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3015      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3016      * the Format line following. It shouldn't include any Dialogue line.
3017      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3018      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3019      */
3020     uint8_t *subtitle_header;
3021     int subtitle_header_size;
3022
3023     /**
3024      * Simulates errors in the bitstream to test error concealment.
3025      * - encoding: Set by user.
3026      * - decoding: unused
3027      */
3028     int error_rate;
3029
3030     /**
3031      * Current packet as passed into the decoder, to avoid having
3032      * to pass the packet into every function. Currently only valid
3033      * inside lavc and get/release_buffer callbacks.
3034      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3035      * - encoding: unused
3036      */
3037     AVPacket *pkt;
3038
3039     /**
3040      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3041      * Used for compliant TS muxing.
3042      * - encoding: Set by libavcodec.
3043      * - decoding: unused.
3044      */
3045     uint64_t vbv_delay;
3046
3047     /**
3048      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3049      * Code outside libavcodec should access this field using:
3050      * avcodec_set_pkt_timebase(avctx)
3051      * - encoding unused.
3052      * - decodimg set by user
3053      */
3054     AVRational pkt_timebase;
3055
3056     /**
3057      * AVCodecDescriptor
3058      * Code outside libavcodec should access this field using:
3059      * avcodec_get_codec_descriptior(avctx)
3060      * - encoding: unused.
3061      * - decoding: set by libavcodec.
3062      */
3063     const AVCodecDescriptor *codec_descriptor;
3064
3065     /**
3066      * Current statistics for PTS correction.
3067      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3068      * - encoding: unused
3069      */
3070     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3071     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3072     int64_t pts_correction_last_pts;       /// PTS of the last frame
3073     int64_t pts_correction_last_dts;       /// DTS of the last frame
3074 } AVCodecContext;
3075
3076 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3077 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3078
3079 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3080 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3081
3082 /**
3083  * AVProfile.
3084  */
3085 typedef struct AVProfile {
3086     int profile;
3087     const char *name; ///< short name for the profile
3088 } AVProfile;
3089
3090 typedef struct AVCodecDefault AVCodecDefault;
3091
3092 /**
3093  * AVCodec.
3094  */
3095 typedef struct AVCodec {
3096     /**
3097      * Name of the codec implementation.
3098      * The name is globally unique among encoders and among decoders (but an
3099      * encoder and a decoder can share the same name).
3100      * This is the primary way to find a codec from the user perspective.
3101      */
3102     const char *name;
3103     /**
3104      * Descriptive name for the codec, meant to be more human readable than name.
3105      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3106      */
3107     const char *long_name;
3108     enum AVMediaType type;
3109     enum AVCodecID id;
3110     /**
3111      * Codec capabilities.
3112      * see CODEC_CAP_*
3113      */
3114     int capabilities;
3115     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3116     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3117     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3118     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3119     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3120     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3121     const AVClass *priv_class;              ///< AVClass for the private context
3122     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3123
3124     /*****************************************************************
3125      * No fields below this line are part of the public API. They
3126      * may not be used outside of libavcodec and can be changed and
3127      * removed at will.
3128      * New public fields should be added right above.
3129      *****************************************************************
3130      */
3131     int priv_data_size;
3132     struct AVCodec *next;
3133     /**
3134      * @name Frame-level threading support functions
3135      * @{
3136      */
3137     /**
3138      * If defined, called on thread contexts when they are created.
3139      * If the codec allocates writable tables in init(), re-allocate them here.
3140      * priv_data will be set to a copy of the original.
3141      */
3142     int (*init_thread_copy)(AVCodecContext *);
3143     /**
3144      * Copy necessary context variables from a previous thread context to the current one.
3145      * If not defined, the next thread will start automatically; otherwise, the codec
3146      * must call ff_thread_finish_setup().
3147      *
3148      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3149      */
3150     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3151     /** @} */
3152
3153     /**
3154      * Private codec-specific defaults.
3155      */
3156     const AVCodecDefault *defaults;
3157
3158     /**
3159      * Initialize codec static data, called from avcodec_register().
3160      */
3161     void (*init_static_data)(struct AVCodec *codec);
3162
3163     int (*init)(AVCodecContext *);
3164     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3165     /**
3166      * Encode data to an AVPacket.
3167      *
3168      * @param      avctx          codec context
3169      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3170      * @param[in]  frame          AVFrame containing the raw data to be encoded
3171      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3172      *                            non-empty packet was returned in avpkt.
3173      * @return 0 on success, negative error code on failure
3174      */
3175     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3176                    int *got_packet_ptr);
3177     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3178     int (*close)(AVCodecContext *);
3179     /**
3180      * Flush buffers.
3181      * Will be called when seeking
3182      */
3183     void (*flush)(AVCodecContext *);
3184 } AVCodec;
3185
3186 /**
3187  * AVHWAccel.
3188  */
3189 typedef struct AVHWAccel {
3190     /**
3191      * Name of the hardware accelerated codec.
3192      * The name is globally unique among encoders and among decoders (but an
3193      * encoder and a decoder can share the same name).
3194      */
3195     const char *name;
3196
3197     /**
3198      * Type of codec implemented by the hardware accelerator.
3199      *
3200      * See AVMEDIA_TYPE_xxx
3201      */
3202     enum AVMediaType type;
3203
3204     /**
3205      * Codec implemented by the hardware accelerator.
3206      *
3207      * See AV_CODEC_ID_xxx
3208      */
3209     enum AVCodecID id;
3210
3211     /**
3212      * Supported pixel format.
3213      *
3214      * Only hardware accelerated formats are supported here.
3215      */
3216     enum PixelFormat pix_fmt;
3217
3218     /**
3219      * Hardware accelerated codec capabilities.
3220      * see FF_HWACCEL_CODEC_CAP_*
3221      */
3222     int capabilities;
3223
3224     struct AVHWAccel *next;
3225
3226     /**
3227      * Called at the beginning of each frame or field picture.
3228      *
3229      * Meaningful frame information (codec specific) is guaranteed to
3230      * be parsed at this point. This function is mandatory.
3231      *
3232      * Note that buf can be NULL along with buf_size set to 0.
3233      * Otherwise, this means the whole frame is available at this point.
3234      *
3235      * @param avctx the codec context
3236      * @param buf the frame data buffer base
3237      * @param buf_size the size of the frame in bytes
3238      * @return zero if successful, a negative value otherwise
3239      */
3240     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3241
3242     /**
3243      * Callback for each slice.
3244      *
3245      * Meaningful slice information (codec specific) is guaranteed to
3246      * be parsed at this point. This function is mandatory.
3247      *
3248      * @param avctx the codec context
3249      * @param buf the slice data buffer base
3250      * @param buf_size the size of the slice in bytes
3251      * @return zero if successful, a negative value otherwise
3252      */
3253     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3254
3255     /**
3256      * Called at the end of each frame or field picture.
3257      *
3258      * The whole picture is parsed at this point and can now be sent
3259      * to the hardware accelerator. This function is mandatory.
3260      *
3261      * @param avctx the codec context
3262      * @return zero if successful, a negative value otherwise
3263      */
3264     int (*end_frame)(AVCodecContext *avctx);
3265
3266     /**
3267      * Size of HW accelerator private data.
3268      *
3269      * Private data is allocated with av_mallocz() before
3270      * AVCodecContext.get_buffer() and deallocated after
3271      * AVCodecContext.release_buffer().
3272      */
3273     int priv_data_size;
3274 } AVHWAccel;
3275
3276 /**
3277  * @defgroup lavc_picture AVPicture
3278  *
3279  * Functions for working with AVPicture
3280  * @{
3281  */
3282
3283 /**
3284  * four components are given, that's all.
3285  * the last component is alpha
3286  */
3287 typedef struct AVPicture {
3288     uint8_t *data[AV_NUM_DATA_POINTERS];
3289     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3290 } AVPicture;
3291
3292 /**
3293  * @}
3294  */
3295
3296 enum AVSubtitleType {
3297     SUBTITLE_NONE,
3298
3299     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3300
3301     /**
3302      * Plain text, the text field must be set by the decoder and is
3303      * authoritative. ass and pict fields may contain approximations.
3304      */
3305     SUBTITLE_TEXT,
3306
3307     /**
3308      * Formatted text, the ass field must be set by the decoder and is
3309      * authoritative. pict and text fields may contain approximations.
3310      */
3311     SUBTITLE_ASS,
3312 };
3313
3314 typedef struct AVSubtitleRect {
3315     int x;         ///< top left corner  of pict, undefined when pict is not set
3316     int y;         ///< top left corner  of pict, undefined when pict is not set
3317     int w;         ///< width            of pict, undefined when pict is not set
3318     int h;         ///< height           of pict, undefined when pict is not set
3319     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3320
3321     /**
3322      * data+linesize for the bitmap of this subtitle.
3323      * can be set for text/ass as well once they where rendered
3324      */
3325     AVPicture pict;
3326     enum AVSubtitleType type;
3327
3328     char *text;                     ///< 0 terminated plain UTF-8 text
3329
3330     /**
3331      * 0 terminated ASS/SSA compatible event line.
3332      * The presentation of this is unaffected by the other values in this
3333      * struct.
3334      */
3335     char *ass;
3336
3337     /**
3338      * 1 indicates this subtitle is a forced subtitle.
3339      * A forced subtitle should be displayed even when subtitles are hidden.
3340      */
3341     int forced;
3342 } AVSubtitleRect;
3343
3344 typedef struct AVSubtitle {
3345     uint16_t format; /* 0 = graphics */
3346     uint32_t start_display_time; /* relative to packet pts, in ms */
3347     uint32_t end_display_time; /* relative to packet pts, in ms */
3348     unsigned num_rects;
3349     AVSubtitleRect **rects;
3350     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3351 } AVSubtitle;
3352
3353 /**
3354  * If c is NULL, returns the first registered codec,
3355  * if c is non-NULL, returns the next registered codec after c,
3356  * or NULL if c is the last one.
3357  */
3358 AVCodec *av_codec_next(const AVCodec *c);
3359
3360 /**
3361  * Return the LIBAVCODEC_VERSION_INT constant.
3362  */
3363 unsigned avcodec_version(void);
3364
3365 /**
3366  * Return the libavcodec build-time configuration.
3367  */
3368 const char *avcodec_configuration(void);
3369
3370 /**
3371  * Return the libavcodec license.
3372  */
3373 const char *avcodec_license(void);
3374
3375 /**
3376  * Register the codec codec and initialize libavcodec.
3377  *
3378  * @warning either this function or avcodec_register_all() must be called
3379  * before any other libavcodec functions.
3380  *
3381  * @see avcodec_register_all()
3382  */
3383 void avcodec_register(AVCodec *codec);
3384
3385 /**
3386  * Register all the codecs, parsers and bitstream filters which were enabled at
3387  * configuration time. If you do not call this function you can select exactly
3388  * which formats you want to support, by using the individual registration
3389  * functions.
3390  *
3391  * @see avcodec_register
3392  * @see av_register_codec_parser
3393  * @see av_register_bitstream_filter
3394  */
3395 void avcodec_register_all(void);
3396
3397
3398 #if FF_API_ALLOC_CONTEXT
3399 /**
3400  * Allocate an AVCodecContext and set its fields to default values.  The
3401  * resulting struct can be deallocated by simply calling av_free().
3402  *
3403  * @return An AVCodecContext filled with default values or NULL on failure.
3404  * @see avcodec_get_context_defaults
3405  *
3406  * @deprecated use avcodec_alloc_context3()
3407  */
3408 attribute_deprecated
3409 AVCodecContext *avcodec_alloc_context(void);
3410
3411 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3412  *  we WILL change its arguments and name a few times! */
3413 attribute_deprecated
3414 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3415
3416 /**
3417  * Set the fields of the given AVCodecContext to default values.
3418  *
3419  * @param s The AVCodecContext of which the fields should be set to default values.
3420  * @deprecated use avcodec_get_context_defaults3
3421  */
3422 attribute_deprecated
3423 void avcodec_get_context_defaults(AVCodecContext *s);
3424
3425 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3426  *  we WILL change its arguments and name a few times! */
3427 attribute_deprecated
3428 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3429 #endif
3430
3431 /**
3432  * Allocate an AVCodecContext and set its fields to default values.  The
3433  * resulting struct can be deallocated by calling avcodec_close() on it followed
3434  * by av_free().
3435  *
3436  * @param codec if non-NULL, allocate private data and initialize defaults
3437  *              for the given codec. It is illegal to then call avcodec_open2()
3438  *              with a different codec.
3439  *              If NULL, then the codec-specific defaults won't be initialized,
3440  *              which may result in suboptimal default settings (this is
3441  *              important mainly for encoders, e.g. libx264).
3442  *
3443  * @return An AVCodecContext filled with default values or NULL on failure.
3444  * @see avcodec_get_context_defaults
3445  */
3446 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3447
3448 /**
3449  * Set the fields of the given AVCodecContext to default values corresponding
3450  * to the given codec (defaults may be codec-dependent).
3451  *
3452  * Do not call this function if a non-NULL codec has been passed
3453  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3454  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3455  * different codec on this AVCodecContext.
3456  */
3457 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3458
3459 /**
3460  * Get the AVClass for AVCodecContext. It can be used in combination with
3461  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3462  *
3463  * @see av_opt_find().
3464  */
3465 const AVClass *avcodec_get_class(void);
3466
3467 /**
3468  * Get the AVClass for AVFrame. It can be used in combination with
3469  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3470  *
3471  * @see av_opt_find().
3472  */
3473 const AVClass *avcodec_get_frame_class(void);
3474
3475 /**
3476  * Get the AVClass for AVSubtitleRect. It can be used in combination with
3477  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3478  *
3479  * @see av_opt_find().
3480  */
3481 const AVClass *avcodec_get_subtitle_rect_class(void);
3482
3483 /**
3484  * Copy the settings of the source AVCodecContext into the destination
3485  * AVCodecContext. The resulting destination codec context will be
3486  * unopened, i.e. you are required to call avcodec_open2() before you
3487  * can use this AVCodecContext to decode/encode video/audio data.
3488  *
3489  * @param dest target codec context, should be initialized with
3490  *             avcodec_alloc_context3(), but otherwise uninitialized
3491  * @param src source codec context
3492  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3493  */
3494 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3495
3496 /**
3497  * Allocate an AVFrame and set its fields to default values.  The resulting
3498  * struct can be deallocated by simply calling av_free().
3499  *
3500  * @return An AVFrame filled with default values or NULL on failure.
3501  * @see avcodec_get_frame_defaults
3502  */
3503 AVFrame *avcodec_alloc_frame(void);
3504
3505 /**
3506  * Set the fields of the given AVFrame to default values.
3507  *
3508  * @param pic The AVFrame of which the fields should be set to default values.
3509  */
3510 void avcodec_get_frame_defaults(AVFrame *pic);
3511
3512 #if FF_API_AVCODEC_OPEN
3513 /**
3514  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3515  * function the context has to be allocated.
3516  *
3517  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3518  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3519  * retrieving a codec.
3520  *
3521  * @warning This function is not thread safe!
3522  *
3523  * @code
3524  * avcodec_register_all();
3525  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3526  * if (!codec)
3527  *     exit(1);
3528  *
3529  * context = avcodec_alloc_context3(codec);
3530  *
3531  * if (avcodec_open(context, codec) < 0)
3532  *     exit(1);
3533  * @endcode
3534  *
3535  * @param avctx The context which will be set up to use the given codec.
3536  * @param codec The codec to use within the context.
3537  * @return zero on success, a negative value on error
3538  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3539  *
3540  * @deprecated use avcodec_open2
3541  */
3542 attribute_deprecated
3543 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3544 #endif
3545
3546 /**
3547  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3548  * function the context has to be allocated with avcodec_alloc_context3().
3549  *
3550  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3551  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3552  * retrieving a codec.
3553  *
3554  * @warning This function is not thread safe!
3555  *
3556  * @code
3557  * avcodec_register_all();
3558  * av_dict_set(&opts, "b", "2.5M", 0);
3559  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3560  * if (!codec)
3561  *     exit(1);
3562  *
3563  * context = avcodec_alloc_context3(codec);
3564  *
3565  * if (avcodec_open2(context, codec, opts) < 0)
3566  *     exit(1);
3567  * @endcode
3568  *
3569  * @param avctx The context to initialize.
3570  * @param codec The codec to open this context for. If a non-NULL codec has been
3571  *              previously passed to avcodec_alloc_context3() or
3572  *              avcodec_get_context_defaults3() for this context, then this
3573  *              parameter MUST be either NULL or equal to the previously passed
3574  *              codec.
3575  * @param options A dictionary filled with AVCodecContext and codec-private options.
3576  *                On return this object will be filled with options that were not found.
3577  *
3578  * @return zero on success, a negative value on error
3579  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3580  *      av_dict_set(), av_opt_find().
3581  */
3582 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3583
3584 /**
3585  * Close a given AVCodecContext and free all the data associated with it
3586  * (but not the AVCodecContext itself).
3587  *
3588  * Calling this function on an AVCodecContext that hasn't been opened will free
3589  * the codec-specific data allocated in avcodec_alloc_context3() /
3590  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3591  * do nothing.
3592  */
3593 int avcodec_close(AVCodecContext *avctx);
3594
3595 /**
3596  * Free all allocated data in the given subtitle struct.
3597  *
3598  * @param sub AVSubtitle to free.
3599  */
3600 void avsubtitle_free(AVSubtitle *sub);
3601
3602 /**
3603  * @}
3604  */
3605
3606 /**
3607  * @addtogroup lavc_packet
3608  * @{
3609  */
3610
3611 /**
3612  * @deprecated use NULL instead
3613  */
3614 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3615
3616 /**
3617  * Default packet destructor.
3618  */
3619 void av_destruct_packet(AVPacket *pkt);
3620
3621 /**
3622  * Initialize optional fields of a packet with default values.
3623  *
3624  * Note, this does not touch the data and size members, which have to be
3625  * initialized separately.
3626  *
3627  * @param pkt packet
3628  */
3629 void av_init_packet(AVPacket *pkt);
3630
3631 /**
3632  * Allocate the payload of a packet and initialize its fields with
3633  * default values.
3634  *
3635  * @param pkt packet
3636  * @param size wanted payload size
3637  * @return 0 if OK, AVERROR_xxx otherwise
3638  */
3639 int av_new_packet(AVPacket *pkt, int size);
3640
3641 /**
3642  * Reduce packet size, correctly zeroing padding
3643  *
3644  * @param pkt packet
3645  * @param size new size
3646  */
3647 void av_shrink_packet(AVPacket *pkt, int size);
3648
3649 /**
3650  * Increase packet size, correctly zeroing padding
3651  *
3652  * @param pkt packet
3653  * @param grow_by number of bytes by which to increase the size of the packet
3654  */
3655 int av_grow_packet(AVPacket *pkt, int grow_by);
3656
3657 /**
3658  * @warning This is a hack - the packet memory allocation stuff is broken. The
3659  * packet is allocated if it was not really allocated.
3660  */
3661 int av_dup_packet(AVPacket *pkt);
3662
3663 /**
3664  * Free a packet.
3665  *
3666  * @param pkt packet to free
3667  */
3668 void av_free_packet(AVPacket *pkt);
3669
3670 /**
3671  * Allocate new information of a packet.
3672  *
3673  * @param pkt packet
3674  * @param type side information type
3675  * @param size side information size
3676  * @return pointer to fresh allocated data or NULL otherwise
3677  */
3678 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3679                                  int size);
3680
3681 /**
3682  * Shrink the already allocated side data buffer
3683  *
3684  * @param pkt packet
3685  * @param type side information type
3686  * @param size new side information size
3687  * @return 0 on success, < 0 on failure
3688  */
3689 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3690                                int size);
3691
3692 /**
3693  * Get side information from packet.
3694  *
3695  * @param pkt packet
3696  * @param type desired side information type
3697  * @param size pointer for side information size to store (optional)
3698  * @return pointer to data if present or NULL otherwise
3699  */
3700 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3701                                  int *size);
3702
3703 int av_packet_merge_side_data(AVPacket *pkt);
3704
3705 int av_packet_split_side_data(AVPacket *pkt);
3706
3707
3708 /**
3709  * @}
3710  */
3711
3712 /**
3713  * @addtogroup lavc_decoding
3714  * @{
3715  */
3716
3717 /**
3718  * Find a registered decoder with a matching codec ID.
3719  *
3720  * @param id AVCodecID of the requested decoder
3721  * @return A decoder if one was found, NULL otherwise.
3722  */
3723 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3724
3725 /**
3726  * Find a registered decoder with the specified name.
3727  *
3728  * @param name name of the requested decoder
3729  * @return A decoder if one was found, NULL otherwise.
3730  */
3731 AVCodec *avcodec_find_decoder_by_name(const char *name);
3732
3733 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3734 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3735 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3736
3737 /**
3738  * Return the amount of padding in pixels which the get_buffer callback must
3739  * provide around the edge of the image for codecs which do not have the
3740  * CODEC_FLAG_EMU_EDGE flag.
3741  *
3742  * @return Required padding in pixels.
3743  */
3744 unsigned avcodec_get_edge_width(void);
3745
3746 /**
3747  * Modify width and height values so that they will result in a memory
3748  * buffer that is acceptable for the codec if you do not use any horizontal
3749  * padding.
3750  *
3751  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3752  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3753  * according to avcodec_get_edge_width() before.
3754  */
3755 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3756
3757 /**
3758  * Modify width and height values so that they will result in a memory
3759  * buffer that is acceptable for the codec if you also ensure that all
3760  * line sizes are a multiple of the respective linesize_align[i].
3761  *
3762  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3763  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3764  * according to avcodec_get_edge_width() before.
3765  */
3766 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3767                                int linesize_align[AV_NUM_DATA_POINTERS]);
3768
3769 #if FF_API_OLD_DECODE_AUDIO
3770 /**
3771  * Wrapper function which calls avcodec_decode_audio4.
3772  *
3773  * @deprecated Use avcodec_decode_audio4 instead.
3774  *
3775  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3776  * Some decoders may support multiple frames in a single AVPacket, such
3777  * decoders would then just decode the first frame. In this case,
3778  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3779  * the remaining data in order to decode the second frame etc.
3780  * If no frame
3781  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3782  * decompressed frame size in bytes.
3783  *
3784  * @warning You must set frame_size_ptr to the allocated size of the
3785  * output buffer before calling avcodec_decode_audio3().
3786  *
3787  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3788  * the actual read bytes because some optimized bitstream readers read 32 or 64
3789  * bits at once and could read over the end.
3790  *
3791  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3792  * no overreading happens for damaged MPEG streams.
3793  *
3794  * @warning You must not provide a custom get_buffer() when using
3795  * avcodec_decode_audio3().  Doing so will override it with
3796  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,
3797  * which does allow the application to provide a custom get_buffer().
3798  *
3799  * @note You might have to align the input buffer avpkt->data and output buffer
3800  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3801  * necessary at all, on others it won't work at all if not aligned and on others
3802  * it will work but it will have an impact on performance.
3803  *
3804  * In practice, avpkt->data should have 4 byte alignment at minimum and
3805  * samples should be 16 byte aligned unless the CPU doesn't need it
3806  * (AltiVec and SSE do).
3807  *
3808  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3809  * between input and output, these need to be fed with avpkt->data=NULL,
3810  * avpkt->size=0 at the end to return the remaining frames.
3811  *
3812  * @param avctx the codec context
3813  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3814  *                     If the sample format is planar, each channel plane will
3815  *                     be the same size, with no padding between channels.
3816  * @param[in,out] frame_size_ptr the output buffer size in bytes
3817  * @param[in] avpkt The input AVPacket containing the input buffer.
3818  *            You can create such packet with av_init_packet() and by then setting
3819  *            data and size, some decoders might in addition need other fields.
3820  *            All decoders are designed to use the least fields possible though.
3821  * @return On error a negative value is returned, otherwise the number of bytes
3822  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3823  */
3824 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3825                          int *frame_size_ptr,
3826                          AVPacket *avpkt);
3827 #endif