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