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