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