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