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