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