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