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