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