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