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