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