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