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