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