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