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