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