]> git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h
782b46b6ce065bdbc44511d374c896b0ba328c69
[ffmpeg] / 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/cpu.h"
33 #include "libavutil/channel_layout.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/log.h"
36 #include "libavutil/pixfmt.h"
37 #include "libavutil/rational.h"
38
39 #include "libavcodec/version.h"
40 /**
41  * @defgroup libavc Encoding/Decoding Library
42  * @{
43  *
44  * @defgroup lavc_decoding Decoding
45  * @{
46  * @}
47  *
48  * @defgroup lavc_encoding Encoding
49  * @{
50  * @}
51  *
52  * @defgroup lavc_codec Codecs
53  * @{
54  * @defgroup lavc_codec_native Native Codecs
55  * @{
56  * @}
57  * @defgroup lavc_codec_wrappers External library wrappers
58  * @{
59  * @}
60  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
61  * @{
62  * @}
63  * @}
64  * @defgroup lavc_internal Internal
65  * @{
66  * @}
67  * @}
68  *
69  */
70
71 /**
72  * @defgroup lavc_core Core functions/structures.
73  * @ingroup libavc
74  *
75  * Basic definitions, functions for querying libavcodec capabilities,
76  * allocating core structures, etc.
77  * @{
78  */
79
80
81 /**
82  * Identify the syntax and semantics of the bitstream.
83  * The principle is roughly:
84  * Two decoders with the same ID can decode the same streams.
85  * Two encoders with the same ID can encode compatible streams.
86  * There may be slight deviations from the principle due to implementation
87  * details.
88  *
89  * If you add a codec ID to this list, add it so that
90  * 1. no value of a existing codec ID changes (that would break ABI),
91  * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
92  *    This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
93  *
94  * After adding new codec IDs, do not forget to add an entry to the codec
95  * descriptor list and bump libavcodec minor version.
96  */
97 enum AVCodecID {
98     AV_CODEC_ID_NONE,
99
100     /* video codecs */
101     AV_CODEC_ID_MPEG1VIDEO,
102     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103     AV_CODEC_ID_MPEG2VIDEO_XVMC,
104     AV_CODEC_ID_H261,
105     AV_CODEC_ID_H263,
106     AV_CODEC_ID_RV10,
107     AV_CODEC_ID_RV20,
108     AV_CODEC_ID_MJPEG,
109     AV_CODEC_ID_MJPEGB,
110     AV_CODEC_ID_LJPEG,
111     AV_CODEC_ID_SP5X,
112     AV_CODEC_ID_JPEGLS,
113     AV_CODEC_ID_MPEG4,
114     AV_CODEC_ID_RAWVIDEO,
115     AV_CODEC_ID_MSMPEG4V1,
116     AV_CODEC_ID_MSMPEG4V2,
117     AV_CODEC_ID_MSMPEG4V3,
118     AV_CODEC_ID_WMV1,
119     AV_CODEC_ID_WMV2,
120     AV_CODEC_ID_H263P,
121     AV_CODEC_ID_H263I,
122     AV_CODEC_ID_FLV1,
123     AV_CODEC_ID_SVQ1,
124     AV_CODEC_ID_SVQ3,
125     AV_CODEC_ID_DVVIDEO,
126     AV_CODEC_ID_HUFFYUV,
127     AV_CODEC_ID_CYUV,
128     AV_CODEC_ID_H264,
129     AV_CODEC_ID_INDEO3,
130     AV_CODEC_ID_VP3,
131     AV_CODEC_ID_THEORA,
132     AV_CODEC_ID_ASV1,
133     AV_CODEC_ID_ASV2,
134     AV_CODEC_ID_FFV1,
135     AV_CODEC_ID_4XM,
136     AV_CODEC_ID_VCR1,
137     AV_CODEC_ID_CLJR,
138     AV_CODEC_ID_MDEC,
139     AV_CODEC_ID_ROQ,
140     AV_CODEC_ID_INTERPLAY_VIDEO,
141     AV_CODEC_ID_XAN_WC3,
142     AV_CODEC_ID_XAN_WC4,
143     AV_CODEC_ID_RPZA,
144     AV_CODEC_ID_CINEPAK,
145     AV_CODEC_ID_WS_VQA,
146     AV_CODEC_ID_MSRLE,
147     AV_CODEC_ID_MSVIDEO1,
148     AV_CODEC_ID_IDCIN,
149     AV_CODEC_ID_8BPS,
150     AV_CODEC_ID_SMC,
151     AV_CODEC_ID_FLIC,
152     AV_CODEC_ID_TRUEMOTION1,
153     AV_CODEC_ID_VMDVIDEO,
154     AV_CODEC_ID_MSZH,
155     AV_CODEC_ID_ZLIB,
156     AV_CODEC_ID_QTRLE,
157     AV_CODEC_ID_SNOW,
158     AV_CODEC_ID_TSCC,
159     AV_CODEC_ID_ULTI,
160     AV_CODEC_ID_QDRAW,
161     AV_CODEC_ID_VIXL,
162     AV_CODEC_ID_QPEG,
163     AV_CODEC_ID_PNG,
164     AV_CODEC_ID_PPM,
165     AV_CODEC_ID_PBM,
166     AV_CODEC_ID_PGM,
167     AV_CODEC_ID_PGMYUV,
168     AV_CODEC_ID_PAM,
169     AV_CODEC_ID_FFVHUFF,
170     AV_CODEC_ID_RV30,
171     AV_CODEC_ID_RV40,
172     AV_CODEC_ID_VC1,
173     AV_CODEC_ID_WMV3,
174     AV_CODEC_ID_LOCO,
175     AV_CODEC_ID_WNV1,
176     AV_CODEC_ID_AASC,
177     AV_CODEC_ID_INDEO2,
178     AV_CODEC_ID_FRAPS,
179     AV_CODEC_ID_TRUEMOTION2,
180     AV_CODEC_ID_BMP,
181     AV_CODEC_ID_CSCD,
182     AV_CODEC_ID_MMVIDEO,
183     AV_CODEC_ID_ZMBV,
184     AV_CODEC_ID_AVS,
185     AV_CODEC_ID_SMACKVIDEO,
186     AV_CODEC_ID_NUV,
187     AV_CODEC_ID_KMVC,
188     AV_CODEC_ID_FLASHSV,
189     AV_CODEC_ID_CAVS,
190     AV_CODEC_ID_JPEG2000,
191     AV_CODEC_ID_VMNC,
192     AV_CODEC_ID_VP5,
193     AV_CODEC_ID_VP6,
194     AV_CODEC_ID_VP6F,
195     AV_CODEC_ID_TARGA,
196     AV_CODEC_ID_DSICINVIDEO,
197     AV_CODEC_ID_TIERTEXSEQVIDEO,
198     AV_CODEC_ID_TIFF,
199     AV_CODEC_ID_GIF,
200     AV_CODEC_ID_DXA,
201     AV_CODEC_ID_DNXHD,
202     AV_CODEC_ID_THP,
203     AV_CODEC_ID_SGI,
204     AV_CODEC_ID_C93,
205     AV_CODEC_ID_BETHSOFTVID,
206     AV_CODEC_ID_PTX,
207     AV_CODEC_ID_TXD,
208     AV_CODEC_ID_VP6A,
209     AV_CODEC_ID_AMV,
210     AV_CODEC_ID_VB,
211     AV_CODEC_ID_PCX,
212     AV_CODEC_ID_SUNRAST,
213     AV_CODEC_ID_INDEO4,
214     AV_CODEC_ID_INDEO5,
215     AV_CODEC_ID_MIMIC,
216     AV_CODEC_ID_RL2,
217     AV_CODEC_ID_ESCAPE124,
218     AV_CODEC_ID_DIRAC,
219     AV_CODEC_ID_BFI,
220     AV_CODEC_ID_CMV,
221     AV_CODEC_ID_MOTIONPIXELS,
222     AV_CODEC_ID_TGV,
223     AV_CODEC_ID_TGQ,
224     AV_CODEC_ID_TQI,
225     AV_CODEC_ID_AURA,
226     AV_CODEC_ID_AURA2,
227     AV_CODEC_ID_V210X,
228     AV_CODEC_ID_TMV,
229     AV_CODEC_ID_V210,
230     AV_CODEC_ID_DPX,
231     AV_CODEC_ID_MAD,
232     AV_CODEC_ID_FRWU,
233     AV_CODEC_ID_FLASHSV2,
234     AV_CODEC_ID_CDGRAPHICS,
235     AV_CODEC_ID_R210,
236     AV_CODEC_ID_ANM,
237     AV_CODEC_ID_BINKVIDEO,
238     AV_CODEC_ID_IFF_ILBM,
239     AV_CODEC_ID_IFF_BYTERUN1,
240     AV_CODEC_ID_KGV1,
241     AV_CODEC_ID_YOP,
242     AV_CODEC_ID_VP8,
243     AV_CODEC_ID_PICTOR,
244     AV_CODEC_ID_ANSI,
245     AV_CODEC_ID_A64_MULTI,
246     AV_CODEC_ID_A64_MULTI5,
247     AV_CODEC_ID_R10K,
248     AV_CODEC_ID_MXPEG,
249     AV_CODEC_ID_LAGARITH,
250     AV_CODEC_ID_PRORES,
251     AV_CODEC_ID_JV,
252     AV_CODEC_ID_DFA,
253     AV_CODEC_ID_WMV3IMAGE,
254     AV_CODEC_ID_VC1IMAGE,
255     AV_CODEC_ID_UTVIDEO,
256     AV_CODEC_ID_BMV_VIDEO,
257     AV_CODEC_ID_VBLE,
258     AV_CODEC_ID_DXTORY,
259     AV_CODEC_ID_V410,
260     AV_CODEC_ID_XWD,
261     AV_CODEC_ID_CDXL,
262     AV_CODEC_ID_XBM,
263     AV_CODEC_ID_ZEROCODEC,
264     AV_CODEC_ID_MSS1,
265     AV_CODEC_ID_MSA1,
266     AV_CODEC_ID_TSCC2,
267     AV_CODEC_ID_MTS2,
268     AV_CODEC_ID_CLLC,
269     AV_CODEC_ID_MSS2,
270     AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
271     AV_CODEC_ID_Y41P       = MKBETAG('Y','4','1','P'),
272     AV_CODEC_ID_ESCAPE130  = MKBETAG('E','1','3','0'),
273     AV_CODEC_ID_EXR        = MKBETAG('0','E','X','R'),
274     AV_CODEC_ID_AVRP       = MKBETAG('A','V','R','P'),
275
276     AV_CODEC_ID_G2M        = MKBETAG( 0 ,'G','2','M'),
277     AV_CODEC_ID_AVUI       = MKBETAG('A','V','U','I'),
278     AV_CODEC_ID_AYUV       = MKBETAG('A','Y','U','V'),
279     AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
280     AV_CODEC_ID_V308       = MKBETAG('V','3','0','8'),
281     AV_CODEC_ID_V408       = MKBETAG('V','4','0','8'),
282     AV_CODEC_ID_YUV4       = MKBETAG('Y','U','V','4'),
283     AV_CODEC_ID_SANM       = MKBETAG('S','A','N','M'),
284     AV_CODEC_ID_PAF_VIDEO  = MKBETAG('P','A','F','V'),
285     AV_CODEC_ID_AVRN       = MKBETAG('A','V','R','n'),
286     AV_CODEC_ID_CPIA       = MKBETAG('C','P','I','A'),
287     AV_CODEC_ID_XFACE      = MKBETAG('X','F','A','C'),
288     AV_CODEC_ID_SGIRLE     = MKBETAG('S','G','I','R'),
289     AV_CODEC_ID_MVC1       = MKBETAG('M','V','C','1'),
290     AV_CODEC_ID_MVC2       = MKBETAG('M','V','C','2'),
291
292     /* various PCM "codecs" */
293     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
294     AV_CODEC_ID_PCM_S16LE = 0x10000,
295     AV_CODEC_ID_PCM_S16BE,
296     AV_CODEC_ID_PCM_U16LE,
297     AV_CODEC_ID_PCM_U16BE,
298     AV_CODEC_ID_PCM_S8,
299     AV_CODEC_ID_PCM_U8,
300     AV_CODEC_ID_PCM_MULAW,
301     AV_CODEC_ID_PCM_ALAW,
302     AV_CODEC_ID_PCM_S32LE,
303     AV_CODEC_ID_PCM_S32BE,
304     AV_CODEC_ID_PCM_U32LE,
305     AV_CODEC_ID_PCM_U32BE,
306     AV_CODEC_ID_PCM_S24LE,
307     AV_CODEC_ID_PCM_S24BE,
308     AV_CODEC_ID_PCM_U24LE,
309     AV_CODEC_ID_PCM_U24BE,
310     AV_CODEC_ID_PCM_S24DAUD,
311     AV_CODEC_ID_PCM_ZORK,
312     AV_CODEC_ID_PCM_S16LE_PLANAR,
313     AV_CODEC_ID_PCM_DVD,
314     AV_CODEC_ID_PCM_F32BE,
315     AV_CODEC_ID_PCM_F32LE,
316     AV_CODEC_ID_PCM_F64BE,
317     AV_CODEC_ID_PCM_F64LE,
318     AV_CODEC_ID_PCM_BLURAY,
319     AV_CODEC_ID_PCM_LXF,
320     AV_CODEC_ID_S302M,
321     AV_CODEC_ID_PCM_S8_PLANAR,
322     AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
323     AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
324     AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
325
326     /* various ADPCM codecs */
327     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
328     AV_CODEC_ID_ADPCM_IMA_WAV,
329     AV_CODEC_ID_ADPCM_IMA_DK3,
330     AV_CODEC_ID_ADPCM_IMA_DK4,
331     AV_CODEC_ID_ADPCM_IMA_WS,
332     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
333     AV_CODEC_ID_ADPCM_MS,
334     AV_CODEC_ID_ADPCM_4XM,
335     AV_CODEC_ID_ADPCM_XA,
336     AV_CODEC_ID_ADPCM_ADX,
337     AV_CODEC_ID_ADPCM_EA,
338     AV_CODEC_ID_ADPCM_G726,
339     AV_CODEC_ID_ADPCM_CT,
340     AV_CODEC_ID_ADPCM_SWF,
341     AV_CODEC_ID_ADPCM_YAMAHA,
342     AV_CODEC_ID_ADPCM_SBPRO_4,
343     AV_CODEC_ID_ADPCM_SBPRO_3,
344     AV_CODEC_ID_ADPCM_SBPRO_2,
345     AV_CODEC_ID_ADPCM_THP,
346     AV_CODEC_ID_ADPCM_IMA_AMV,
347     AV_CODEC_ID_ADPCM_EA_R1,
348     AV_CODEC_ID_ADPCM_EA_R3,
349     AV_CODEC_ID_ADPCM_EA_R2,
350     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
351     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
352     AV_CODEC_ID_ADPCM_EA_XAS,
353     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
354     AV_CODEC_ID_ADPCM_IMA_ISS,
355     AV_CODEC_ID_ADPCM_G722,
356     AV_CODEC_ID_ADPCM_IMA_APC,
357     AV_CODEC_ID_VIMA       = MKBETAG('V','I','M','A'),
358     AV_CODEC_ID_ADPCM_AFC  = MKBETAG('A','F','C',' '),
359     AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
360
361     /* AMR */
362     AV_CODEC_ID_AMR_NB = 0x12000,
363     AV_CODEC_ID_AMR_WB,
364
365     /* RealAudio codecs*/
366     AV_CODEC_ID_RA_144 = 0x13000,
367     AV_CODEC_ID_RA_288,
368
369     /* various DPCM codecs */
370     AV_CODEC_ID_ROQ_DPCM = 0x14000,
371     AV_CODEC_ID_INTERPLAY_DPCM,
372     AV_CODEC_ID_XAN_DPCM,
373     AV_CODEC_ID_SOL_DPCM,
374
375     /* audio codecs */
376     AV_CODEC_ID_MP2 = 0x15000,
377     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
378     AV_CODEC_ID_AAC,
379     AV_CODEC_ID_AC3,
380     AV_CODEC_ID_DTS,
381     AV_CODEC_ID_VORBIS,
382     AV_CODEC_ID_DVAUDIO,
383     AV_CODEC_ID_WMAV1,
384     AV_CODEC_ID_WMAV2,
385     AV_CODEC_ID_MACE3,
386     AV_CODEC_ID_MACE6,
387     AV_CODEC_ID_VMDAUDIO,
388     AV_CODEC_ID_FLAC,
389     AV_CODEC_ID_MP3ADU,
390     AV_CODEC_ID_MP3ON4,
391     AV_CODEC_ID_SHORTEN,
392     AV_CODEC_ID_ALAC,
393     AV_CODEC_ID_WESTWOOD_SND1,
394     AV_CODEC_ID_GSM, ///< as in Berlin toast format
395     AV_CODEC_ID_QDM2,
396     AV_CODEC_ID_COOK,
397     AV_CODEC_ID_TRUESPEECH,
398     AV_CODEC_ID_TTA,
399     AV_CODEC_ID_SMACKAUDIO,
400     AV_CODEC_ID_QCELP,
401     AV_CODEC_ID_WAVPACK,
402     AV_CODEC_ID_DSICINAUDIO,
403     AV_CODEC_ID_IMC,
404     AV_CODEC_ID_MUSEPACK7,
405     AV_CODEC_ID_MLP,
406     AV_CODEC_ID_GSM_MS, /* as found in WAV */
407     AV_CODEC_ID_ATRAC3,
408     AV_CODEC_ID_VOXWARE,
409     AV_CODEC_ID_APE,
410     AV_CODEC_ID_NELLYMOSER,
411     AV_CODEC_ID_MUSEPACK8,
412     AV_CODEC_ID_SPEEX,
413     AV_CODEC_ID_WMAVOICE,
414     AV_CODEC_ID_WMAPRO,
415     AV_CODEC_ID_WMALOSSLESS,
416     AV_CODEC_ID_ATRAC3P,
417     AV_CODEC_ID_EAC3,
418     AV_CODEC_ID_SIPR,
419     AV_CODEC_ID_MP1,
420     AV_CODEC_ID_TWINVQ,
421     AV_CODEC_ID_TRUEHD,
422     AV_CODEC_ID_MP4ALS,
423     AV_CODEC_ID_ATRAC1,
424     AV_CODEC_ID_BINKAUDIO_RDFT,
425     AV_CODEC_ID_BINKAUDIO_DCT,
426     AV_CODEC_ID_AAC_LATM,
427     AV_CODEC_ID_QDMC,
428     AV_CODEC_ID_CELT,
429     AV_CODEC_ID_G723_1,
430     AV_CODEC_ID_G729,
431     AV_CODEC_ID_8SVX_EXP,
432     AV_CODEC_ID_8SVX_FIB,
433     AV_CODEC_ID_BMV_AUDIO,
434     AV_CODEC_ID_RALF,
435     AV_CODEC_ID_IAC,
436     AV_CODEC_ID_ILBC,
437     AV_CODEC_ID_OPUS_DEPRECATED,
438     AV_CODEC_ID_COMFORT_NOISE,
439     AV_CODEC_ID_TAK_DEPRECATED,
440     AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
441 #if LIBAVCODEC_VERSION_MAJOR <= 54
442     AV_CODEC_ID_8SVX_RAW    = MKBETAG('8','S','V','X'),
443 #endif
444     AV_CODEC_ID_SONIC       = MKBETAG('S','O','N','C'),
445     AV_CODEC_ID_SONIC_LS    = MKBETAG('S','O','N','L'),
446     AV_CODEC_ID_PAF_AUDIO   = MKBETAG('P','A','F','A'),
447     AV_CODEC_ID_OPUS        = MKBETAG('O','P','U','S'),
448     AV_CODEC_ID_TAK         = MKBETAG('t','B','a','K'),
449
450     /* subtitle codecs */
451     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
452     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
453     AV_CODEC_ID_DVB_SUBTITLE,
454     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
455     AV_CODEC_ID_XSUB,
456     AV_CODEC_ID_SSA,
457     AV_CODEC_ID_MOV_TEXT,
458     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
459     AV_CODEC_ID_DVB_TELETEXT,
460     AV_CODEC_ID_SRT,
461     AV_CODEC_ID_MICRODVD   = MKBETAG('m','D','V','D'),
462     AV_CODEC_ID_EIA_608    = MKBETAG('c','6','0','8'),
463     AV_CODEC_ID_JACOSUB    = MKBETAG('J','S','U','B'),
464     AV_CODEC_ID_SAMI       = MKBETAG('S','A','M','I'),
465     AV_CODEC_ID_REALTEXT   = MKBETAG('R','T','X','T'),
466     AV_CODEC_ID_SUBVIEWER  = MKBETAG('S','u','b','V'),
467     AV_CODEC_ID_SUBRIP     = MKBETAG('S','R','i','p'),
468     AV_CODEC_ID_WEBVTT     = MKBETAG('W','V','T','T'),
469     AV_CODEC_ID_MPL2       = MKBETAG('M','P','L','2'),
470     AV_CODEC_ID_VPLAYER    = MKBETAG('V','P','l','r'),
471     AV_CODEC_ID_PJS        = MKBETAG('P','h','J','S'),
472
473     /* other specific kind of codecs (generally used for attachments) */
474     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
475     AV_CODEC_ID_TTF = 0x18000,
476     AV_CODEC_ID_BINTEXT    = MKBETAG('B','T','X','T'),
477     AV_CODEC_ID_XBIN       = MKBETAG('X','B','I','N'),
478     AV_CODEC_ID_IDF        = MKBETAG( 0 ,'I','D','F'),
479     AV_CODEC_ID_OTF        = MKBETAG( 0 ,'O','T','F'),
480     AV_CODEC_ID_SMPTE_KLV  = MKBETAG('K','L','V','A'),
481
482     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
483
484     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
485                                 * stream (only used by libavformat) */
486     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
487                                 * stream (only used by libavformat) */
488     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
489
490 #if FF_API_CODEC_ID
491 #include "old_codec_ids.h"
492 #endif
493 };
494
495 #if FF_API_CODEC_ID
496 #define CodecID AVCodecID
497 #endif
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 #if FF_API_OLD_DECODE_AUDIO
540 /* in bytes */
541 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
542 #endif
543
544 /**
545  * @ingroup lavc_decoding
546  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
547  * This is mainly needed because some optimized bitstream readers read
548  * 32 or 64 bit at once and could read over the end.<br>
549  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
550  * MPEG bitstreams could cause overread and segfault.
551  */
552 #define FF_INPUT_BUFFER_PADDING_SIZE 16
553
554 /**
555  * @ingroup lavc_encoding
556  * minimum encoding buffer size
557  * Used to avoid some checks during header writing.
558  */
559 #define FF_MIN_BUFFER_SIZE 16384
560
561
562 /**
563  * @ingroup lavc_encoding
564  * motion estimation type.
565  */
566 enum Motion_Est_ID {
567     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
568     ME_FULL,
569     ME_LOG,
570     ME_PHODS,
571     ME_EPZS,        ///< enhanced predictive zonal search
572     ME_X1,          ///< reserved for experiments
573     ME_HEX,         ///< hexagon based search
574     ME_UMH,         ///< uneven multi-hexagon search
575     ME_ITER,        ///< iterative search
576     ME_TESA,        ///< transformed exhaustive search algorithm
577 };
578
579 /**
580  * @ingroup lavc_decoding
581  */
582 enum AVDiscard{
583     /* We leave some space between them for extensions (drop some
584      * keyframes for intra-only or drop just some bidir frames). */
585     AVDISCARD_NONE    =-16, ///< discard nothing
586     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
587     AVDISCARD_NONREF  =  8, ///< discard all non reference
588     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
589     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
590     AVDISCARD_ALL     = 48, ///< discard all
591 };
592
593 enum AVColorPrimaries{
594     AVCOL_PRI_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
595     AVCOL_PRI_UNSPECIFIED = 2,
596     AVCOL_PRI_BT470M      = 4,
597     AVCOL_PRI_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
598     AVCOL_PRI_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
599     AVCOL_PRI_SMPTE240M   = 7, ///< functionally identical to above
600     AVCOL_PRI_FILM        = 8,
601     AVCOL_PRI_NB             , ///< Not part of ABI
602 };
603
604 enum AVColorTransferCharacteristic{
605     AVCOL_TRC_BT709       = 1, ///< also ITU-R BT1361
606     AVCOL_TRC_UNSPECIFIED = 2,
607     AVCOL_TRC_GAMMA22     = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
608     AVCOL_TRC_GAMMA28     = 5, ///< also ITU-R BT470BG
609     AVCOL_TRC_SMPTE240M   = 7,
610     AVCOL_TRC_NB             , ///< Not part of ABI
611 };
612
613 enum AVColorSpace{
614     AVCOL_SPC_RGB         = 0,
615     AVCOL_SPC_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
616     AVCOL_SPC_UNSPECIFIED = 2,
617     AVCOL_SPC_FCC         = 4,
618     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
619     AVCOL_SPC_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
620     AVCOL_SPC_SMPTE240M   = 7,
621     AVCOL_SPC_YCOCG       = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
622     AVCOL_SPC_NB             , ///< Not part of ABI
623 };
624 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
625
626 enum AVColorRange{
627     AVCOL_RANGE_UNSPECIFIED = 0,
628     AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
629     AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
630     AVCOL_RANGE_NB             , ///< Not part of ABI
631 };
632
633 /**
634  *  X   X      3 4 X      X are luma samples,
635  *             1 2        1-6 are possible chroma positions
636  *  X   X      5 6 X      0 is undefined/unknown position
637  */
638 enum AVChromaLocation{
639     AVCHROMA_LOC_UNSPECIFIED = 0,
640     AVCHROMA_LOC_LEFT        = 1, ///< mpeg2/4, h264 default
641     AVCHROMA_LOC_CENTER      = 2, ///< mpeg1, jpeg, h263
642     AVCHROMA_LOC_TOPLEFT     = 3, ///< DV
643     AVCHROMA_LOC_TOP         = 4,
644     AVCHROMA_LOC_BOTTOMLEFT  = 5,
645     AVCHROMA_LOC_BOTTOM      = 6,
646     AVCHROMA_LOC_NB             , ///< Not part of ABI
647 };
648
649 enum AVAudioServiceType {
650     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
651     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
652     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
653     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
654     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
655     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
656     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
657     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
658     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
659     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
660 };
661
662 /**
663  * @ingroup lavc_encoding
664  */
665 typedef struct RcOverride{
666     int start_frame;
667     int end_frame;
668     int qscale; // If this is 0 then quality_factor will be used instead.
669     float quality_factor;
670 } RcOverride;
671
672 #define FF_MAX_B_FRAMES 16
673
674 /* encoding support
675    These flags can be passed in AVCodecContext.flags before initialization.
676    Note: Not everything is supported yet.
677 */
678
679 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
680 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
681 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
682 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
683 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
684 /**
685  * The parent program guarantees that the input for B-frames containing
686  * streams is not written to for at least s->max_b_frames+1 frames, if
687  * this is not set the input will be copied.
688  */
689 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
690 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
691 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
692 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
693 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
694 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
695 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
696                                                   location instead of only at frame boundaries. */
697 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
698 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
699 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
700 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
701 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
702 /* Fx : Flag for h263+ extra options */
703 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
704 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
705 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
706 #define CODEC_FLAG_CLOSED_GOP     0x80000000
707 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
708 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
709 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
710 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
711 #if FF_API_MPV_GLOBAL_OPTS
712 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
713 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
714 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
715 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
716 #endif
717 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
718 #define CODEC_FLAG2_SHOW_ALL      0x00400000 ///< Show all frames before the first keyframe
719
720 /* Unsupported options :
721  *              Syntax Arithmetic coding (SAC)
722  *              Reference Picture Selection
723  *              Independent Segment Decoding */
724 /* /Fx */
725 /* codec capabilities */
726
727 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
728 /**
729  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
730  * If not set, it might not use get_buffer() at all or use operations that
731  * assume the buffer was allocated by avcodec_default_get_buffer.
732  */
733 #define CODEC_CAP_DR1             0x0002
734 #define CODEC_CAP_TRUNCATED       0x0008
735 /* Codec can export data for HW decoding (XvMC). */
736 #define CODEC_CAP_HWACCEL         0x0010
737 /**
738  * Encoder or decoder requires flushing with NULL input at the end in order to
739  * give the complete and correct output.
740  *
741  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
742  *       with NULL data. The user can still send NULL data to the public encode
743  *       or decode function, but libavcodec will not pass it along to the codec
744  *       unless this flag is set.
745  *
746  * Decoders:
747  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
748  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
749  * returns frames.
750  *
751  * Encoders:
752  * The encoder needs to be fed with NULL data at the end of encoding until the
753  * encoder no longer returns data.
754  *
755  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
756  *       flag also means that the encoder must set the pts and duration for
757  *       each output packet. If this flag is not set, the pts and duration will
758  *       be determined by libavcodec from the input frame.
759  */
760 #define CODEC_CAP_DELAY           0x0020
761 /**
762  * Codec can be fed a final frame with a smaller size.
763  * This can be used to prevent truncation of the last audio samples.
764  */
765 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
766 /**
767  * Codec can export data for HW decoding (VDPAU).
768  */
769 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
770 /**
771  * Codec can output multiple frames per AVPacket
772  * Normally demuxers return one frame at a time, demuxers which do not do
773  * are connected to a parser to split what they return into proper frames.
774  * This flag is reserved to the very rare category of codecs which have a
775  * bitstream that cannot be split into frames without timeconsuming
776  * operations like full decoding. Demuxers carring such bitstreams thus
777  * may return multiple frames in a packet. This has many disadvantages like
778  * prohibiting stream copy in many cases thus it should only be considered
779  * as a last resort.
780  */
781 #define CODEC_CAP_SUBFRAMES        0x0100
782 /**
783  * Codec is experimental and is thus avoided in favor of non experimental
784  * encoders
785  */
786 #define CODEC_CAP_EXPERIMENTAL     0x0200
787 /**
788  * Codec should fill in channel configuration and samplerate instead of container
789  */
790 #define CODEC_CAP_CHANNEL_CONF     0x0400
791
792 /**
793  * Codec is able to deal with negative linesizes
794  */
795 #define CODEC_CAP_NEG_LINESIZES    0x0800
796
797 /**
798  * Codec supports frame-level multithreading.
799  */
800 #define CODEC_CAP_FRAME_THREADS    0x1000
801 /**
802  * Codec supports slice-based (or partition-based) multithreading.
803  */
804 #define CODEC_CAP_SLICE_THREADS    0x2000
805 /**
806  * Codec supports changed parameters at any point.
807  */
808 #define CODEC_CAP_PARAM_CHANGE     0x4000
809 /**
810  * Codec supports avctx->thread_count == 0 (auto).
811  */
812 #define CODEC_CAP_AUTO_THREADS     0x8000
813 /**
814  * Audio encoder supports receiving a different number of samples in each call.
815  */
816 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
817 /**
818  * Codec is intra only.
819  */
820 #define CODEC_CAP_INTRA_ONLY       0x40000000
821 /**
822  * Codec is lossless.
823  */
824 #define CODEC_CAP_LOSSLESS         0x80000000
825
826 //The following defines may change, don't expect compatibility if you use them.
827 #define MB_TYPE_INTRA4x4   0x0001
828 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
829 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
830 #define MB_TYPE_16x16      0x0008
831 #define MB_TYPE_16x8       0x0010
832 #define MB_TYPE_8x16       0x0020
833 #define MB_TYPE_8x8        0x0040
834 #define MB_TYPE_INTERLACED 0x0080
835 #define MB_TYPE_DIRECT2    0x0100 //FIXME
836 #define MB_TYPE_ACPRED     0x0200
837 #define MB_TYPE_GMC        0x0400
838 #define MB_TYPE_SKIP       0x0800
839 #define MB_TYPE_P0L0       0x1000
840 #define MB_TYPE_P1L0       0x2000
841 #define MB_TYPE_P0L1       0x4000
842 #define MB_TYPE_P1L1       0x8000
843 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
844 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
845 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
846 #define MB_TYPE_QUANT      0x00010000
847 #define MB_TYPE_CBP        0x00020000
848 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
849
850 /**
851  * Pan Scan area.
852  * This specifies the area which should be displayed.
853  * Note there may be multiple such areas for one frame.
854  */
855 typedef struct AVPanScan{
856     /**
857      * id
858      * - encoding: Set by user.
859      * - decoding: Set by libavcodec.
860      */
861     int id;
862
863     /**
864      * width and height in 1/16 pel
865      * - encoding: Set by user.
866      * - decoding: Set by libavcodec.
867      */
868     int width;
869     int height;
870
871     /**
872      * position of the top left corner in 1/16 pel for up to 3 fields/frames
873      * - encoding: Set by user.
874      * - decoding: Set by libavcodec.
875      */
876     int16_t position[3][2];
877 }AVPanScan;
878
879 #define FF_QSCALE_TYPE_MPEG1 0
880 #define FF_QSCALE_TYPE_MPEG2 1
881 #define FF_QSCALE_TYPE_H264  2
882 #define FF_QSCALE_TYPE_VP56  3
883
884 #define FF_BUFFER_TYPE_INTERNAL 1
885 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
886 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
887 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
888
889 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
890 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
891 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
892 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
893
894 /**
895  * @defgroup lavc_packet AVPacket
896  *
897  * Types and functions for working with AVPacket.
898  * @{
899  */
900 enum AVPacketSideDataType {
901     AV_PKT_DATA_PALETTE,
902     AV_PKT_DATA_NEW_EXTRADATA,
903
904     /**
905      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
906      * @code
907      * u32le param_flags
908      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
909      *     s32le channel_count
910      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
911      *     u64le channel_layout
912      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
913      *     s32le sample_rate
914      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
915      *     s32le width
916      *     s32le height
917      * @endcode
918      */
919     AV_PKT_DATA_PARAM_CHANGE,
920
921     /**
922      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
923      * structures with info about macroblocks relevant to splitting the
924      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
925      * That is, it does not necessarily contain info about all macroblocks,
926      * as long as the distance between macroblocks in the info is smaller
927      * than the target payload size.
928      * Each MB info structure is 12 bytes, and is laid out as follows:
929      * @code
930      * u32le bit offset from the start of the packet
931      * u8    current quantizer at the start of the macroblock
932      * u8    GOB number
933      * u16le macroblock address within the GOB
934      * u8    horizontal MV predictor
935      * u8    vertical MV predictor
936      * u8    horizontal MV predictor for block number 3
937      * u8    vertical MV predictor for block number 3
938      * @endcode
939      */
940     AV_PKT_DATA_H263_MB_INFO,
941
942     /**
943      * Recommmends skipping the specified number of samples
944      * @code
945      * u32le number of samples to skip from start of this packet
946      * u32le number of samples to skip from end of this packet
947      * u8    reason for start skip
948      * u8    reason for end   skip (0=padding silence, 1=convergence)
949      * @endcode
950      */
951     AV_PKT_DATA_SKIP_SAMPLES=70,
952
953     /**
954      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
955      * the packet may contain "dual mono" audio specific to Japanese DTV
956      * and if it is true, recommends only the selected channel to be used.
957      * @code
958      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
959      * @endcode
960      */
961     AV_PKT_DATA_JP_DUALMONO,
962
963     /**
964      * A list of zero terminated key/value strings. There is no end marker for
965      * the list, so it is required to rely on the side data size to stop.
966      */
967     AV_PKT_DATA_STRINGS_METADATA,
968
969     /**
970      * Subtitle event position
971      * @code
972      * u32le x1
973      * u32le y1
974      * u32le x2
975      * u32le y2
976      * @endcode
977      */
978     AV_PKT_DATA_SUBTITLE_POSITION,
979 };
980
981 /**
982  * This structure stores compressed data. It is typically exported by demuxers
983  * and then passed as input to decoders, or received as output from encoders and
984  * then passed to muxers.
985  *
986  * For video, it should typically contain one compressed frame. For audio it may
987  * contain several compressed frames.
988  *
989  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
990  * ABI. Thus it may be allocated on stack and no new fields can be added to it
991  * without libavcodec and libavformat major bump.
992  *
993  * The semantics of data ownership depends on the destruct field.
994  * If it is set, the packet data is dynamically allocated and is valid
995  * indefinitely until av_free_packet() is called (which in turn calls the
996  * destruct callback to free the data). If destruct is not set, the packet data
997  * is typically backed by some static buffer somewhere and is only valid for a
998  * limited time (e.g. until the next read call when demuxing).
999  *
1000  * The side data is always allocated with av_malloc() and is freed in
1001  * av_free_packet().
1002  */
1003 typedef struct AVPacket {
1004     /**
1005      * Presentation timestamp in AVStream->time_base units; the time at which
1006      * the decompressed packet will be presented to the user.
1007      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1008      * pts MUST be larger or equal to dts as presentation cannot happen before
1009      * decompression, unless one wants to view hex dumps. Some formats misuse
1010      * the terms dts and pts/cts to mean something different. Such timestamps
1011      * must be converted to true pts/dts before they are stored in AVPacket.
1012      */
1013     int64_t pts;
1014     /**
1015      * Decompression timestamp in AVStream->time_base units; the time at which
1016      * the packet is decompressed.
1017      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1018      */
1019     int64_t dts;
1020     uint8_t *data;
1021     int   size;
1022     int   stream_index;
1023     /**
1024      * A combination of AV_PKT_FLAG values
1025      */
1026     int   flags;
1027     /**
1028      * Additional packet data that can be provided by the container.
1029      * Packet can contain several types of side information.
1030      */
1031     struct {
1032         uint8_t *data;
1033         int      size;
1034         enum AVPacketSideDataType type;
1035     } *side_data;
1036     int side_data_elems;
1037
1038     /**
1039      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1040      * Equals next_pts - this_pts in presentation order.
1041      */
1042     int   duration;
1043     void  (*destruct)(struct AVPacket *);
1044     void  *priv;
1045     int64_t pos;                            ///< byte position in stream, -1 if unknown
1046
1047     /**
1048      * Time difference in AVStream->time_base units from the pts of this
1049      * packet to the point at which the output from the decoder has converged
1050      * independent from the availability of previous frames. That is, the
1051      * frames are virtually identical no matter if decoding started from
1052      * the very first frame or from this keyframe.
1053      * Is AV_NOPTS_VALUE if unknown.
1054      * This field is not the display duration of the current packet.
1055      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1056      * set.
1057      *
1058      * The purpose of this field is to allow seeking in streams that have no
1059      * keyframes in the conventional sense. It corresponds to the
1060      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1061      * essential for some types of subtitle streams to ensure that all
1062      * subtitles are correctly displayed after seeking.
1063      */
1064     int64_t convergence_duration;
1065 } AVPacket;
1066 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1067 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1068
1069 enum AVSideDataParamChangeFlags {
1070     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1071     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1072     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1073     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1074 };
1075 /**
1076  * @}
1077  */
1078
1079 /**
1080  * This structure describes decoded (raw) audio or video data.
1081  *
1082  * AVFrame must be allocated using avcodec_alloc_frame() and freed with
1083  * avcodec_free_frame(). Note that this allocates only the AVFrame itself. The
1084  * buffers for the data must be managed through other means.
1085  *
1086  * AVFrame is typically allocated once and then reused multiple times to hold
1087  * different data (e.g. a single AVFrame to hold frames received from a
1088  * decoder). In such a case, avcodec_get_frame_defaults() should be used to
1089  * reset the frame to its original clean state before it is reused again.
1090  *
1091  * sizeof(AVFrame) is not a part of the public ABI, so new fields may be added
1092  * to the end with a minor bump.
1093  * Similarly fields that are marked as to be only accessed by
1094  * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1095  * without breaking compatibility with each other.
1096  */
1097 typedef struct AVFrame {
1098 #define AV_NUM_DATA_POINTERS 8
1099     /**
1100      * pointer to the picture/channel planes.
1101      * This might be different from the first allocated byte
1102      * - encoding: Set by user
1103      * - decoding: set by AVCodecContext.get_buffer()
1104      */
1105     uint8_t *data[AV_NUM_DATA_POINTERS];
1106
1107     /**
1108      * Size, in bytes, of the data for each picture/channel plane.
1109      *
1110      * For audio, only linesize[0] may be set. For planar audio, each channel
1111      * plane must be the same size.
1112      *
1113      * - encoding: Set by user
1114      * - decoding: set by AVCodecContext.get_buffer()
1115      */
1116     int linesize[AV_NUM_DATA_POINTERS];
1117
1118     /**
1119      * pointers to the data planes/channels.
1120      *
1121      * For video, this should simply point to data[].
1122      *
1123      * For planar audio, each channel has a separate data pointer, and
1124      * linesize[0] contains the size of each channel buffer.
1125      * For packed audio, there is just one data pointer, and linesize[0]
1126      * contains the total size of the buffer for all channels.
1127      *
1128      * Note: Both data and extended_data will always be set by get_buffer(),
1129      * but for planar audio with more channels that can fit in data,
1130      * extended_data must be used by the decoder in order to access all
1131      * channels.
1132      *
1133      * encoding: set by user
1134      * decoding: set by AVCodecContext.get_buffer()
1135      */
1136     uint8_t **extended_data;
1137
1138     /**
1139      * width and height of the video frame
1140      * - encoding: unused
1141      * - decoding: Read by user.
1142      */
1143     int width, height;
1144
1145     /**
1146      * number of audio samples (per channel) described by this frame
1147      * - encoding: Set by user
1148      * - decoding: Set by libavcodec
1149      */
1150     int nb_samples;
1151
1152     /**
1153      * format of the frame, -1 if unknown or unset
1154      * Values correspond to enum AVPixelFormat for video frames,
1155      * enum AVSampleFormat for audio)
1156      * - encoding: unused
1157      * - decoding: Read by user.
1158      */
1159     int format;
1160
1161     /**
1162      * 1 -> keyframe, 0-> not
1163      * - encoding: Set by libavcodec.
1164      * - decoding: Set by libavcodec.
1165      */
1166     int key_frame;
1167
1168     /**
1169      * Picture type of the frame, see ?_TYPE below.
1170      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1171      * - decoding: Set by libavcodec.
1172      */
1173     enum AVPictureType pict_type;
1174
1175     /**
1176      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1177      * This isn't used by libavcodec unless the default get/release_buffer() is used.
1178      * - encoding:
1179      * - decoding:
1180      */
1181     uint8_t *base[AV_NUM_DATA_POINTERS];
1182
1183     /**
1184      * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1185      * - encoding: unused
1186      * - decoding: Read by user.
1187      */
1188     AVRational sample_aspect_ratio;
1189
1190     /**
1191      * presentation timestamp in time_base units (time when frame should be shown to user)
1192      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1193      * - encoding: MUST be set by user.
1194      * - decoding: Set by libavcodec.
1195      */
1196     int64_t pts;
1197
1198     /**
1199      * pts copied from the AVPacket that was decoded to produce this frame
1200      * - encoding: unused
1201      * - decoding: Read by user.
1202      */
1203     int64_t pkt_pts;
1204
1205     /**
1206      * dts copied from the AVPacket that triggered returning this frame
1207      * - encoding: unused
1208      * - decoding: Read by user.
1209      */
1210     int64_t pkt_dts;
1211
1212     /**
1213      * picture number in bitstream order
1214      * - encoding: set by
1215      * - decoding: Set by libavcodec.
1216      */
1217     int coded_picture_number;
1218     /**
1219      * picture number in display order
1220      * - encoding: set by
1221      * - decoding: Set by libavcodec.
1222      */
1223     int display_picture_number;
1224
1225     /**
1226      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1227      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1228      * - decoding: Set by libavcodec.
1229      */
1230     int quality;
1231
1232     /**
1233      * is this picture used as reference
1234      * The values for this are the same as the MpegEncContext.picture_structure
1235      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1236      * Set to 4 for delayed, non-reference frames.
1237      * - encoding: unused
1238      * - decoding: Set by libavcodec. (before get_buffer() call)).
1239      */
1240     int reference;
1241
1242     /**
1243      * QP table
1244      * - encoding: unused
1245      * - decoding: Set by libavcodec.
1246      */
1247     int8_t *qscale_table;
1248     /**
1249      * QP store stride
1250      * - encoding: unused
1251      * - decoding: Set by libavcodec.
1252      */
1253     int qstride;
1254
1255     /**
1256      *
1257      */
1258     int qscale_type;
1259
1260     /**
1261      * mbskip_table[mb]>=1 if MB didn't change
1262      * stride= mb_width = (width+15)>>4
1263      * - encoding: unused
1264      * - decoding: Set by libavcodec.
1265      */
1266     uint8_t *mbskip_table;
1267
1268     /**
1269      * motion vector table
1270      * @code
1271      * example:
1272      * int mv_sample_log2= 4 - motion_subsample_log2;
1273      * int mb_width= (width+15)>>4;
1274      * int mv_stride= (mb_width << mv_sample_log2) + 1;
1275      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1276      * @endcode
1277      * - encoding: Set by user.
1278      * - decoding: Set by libavcodec.
1279      */
1280     int16_t (*motion_val[2])[2];
1281
1282     /**
1283      * macroblock type table
1284      * mb_type_base + mb_width + 2
1285      * - encoding: Set by user.
1286      * - decoding: Set by libavcodec.
1287      */
1288     uint32_t *mb_type;
1289
1290     /**
1291      * DCT coefficients
1292      * - encoding: unused
1293      * - decoding: Set by libavcodec.
1294      */
1295     short *dct_coeff;
1296
1297     /**
1298      * motion reference frame index
1299      * the order in which these are stored can depend on the codec.
1300      * - encoding: Set by user.
1301      * - decoding: Set by libavcodec.
1302      */
1303     int8_t *ref_index[2];
1304
1305     /**
1306      * for some private data of the user
1307      * - encoding: unused
1308      * - decoding: Set by user.
1309      */
1310     void *opaque;
1311
1312     /**
1313      * error
1314      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1315      * - decoding: unused
1316      */
1317     uint64_t error[AV_NUM_DATA_POINTERS];
1318
1319     /**
1320      * type of the buffer (to keep track of who has to deallocate data[*])
1321      * - encoding: Set by the one who allocates it.
1322      * - decoding: Set by the one who allocates it.
1323      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1324      */
1325     int type;
1326
1327     /**
1328      * When decoding, this signals how much the picture must be delayed.
1329      * extra_delay = repeat_pict / (2*fps)
1330      * - encoding: unused
1331      * - decoding: Set by libavcodec.
1332      */
1333     int repeat_pict;
1334
1335     /**
1336      * The content of the picture is interlaced.
1337      * - encoding: Set by user.
1338      * - decoding: Set by libavcodec. (default 0)
1339      */
1340     int interlaced_frame;
1341
1342     /**
1343      * If the content is interlaced, is top field displayed first.
1344      * - encoding: Set by user.
1345      * - decoding: Set by libavcodec.
1346      */
1347     int top_field_first;
1348
1349     /**
1350      * Tell user application that palette has changed from previous frame.
1351      * - encoding: ??? (no palette-enabled encoder yet)
1352      * - decoding: Set by libavcodec. (default 0).
1353      */
1354     int palette_has_changed;
1355
1356     /**
1357      * codec suggestion on buffer type if != 0
1358      * - encoding: unused
1359      * - decoding: Set by libavcodec. (before get_buffer() call)).
1360      */
1361     int buffer_hints;
1362
1363     /**
1364      * Pan scan.
1365      * - encoding: Set by user.
1366      * - decoding: Set by libavcodec.
1367      */
1368     AVPanScan *pan_scan;
1369
1370     /**
1371      * reordered opaque 64bit (generally an integer or a double precision float
1372      * PTS but can be anything).
1373      * The user sets AVCodecContext.reordered_opaque to represent the input at
1374      * that time,
1375      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1376      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1377      * @deprecated in favor of pkt_pts
1378      * - encoding: unused
1379      * - decoding: Read by user.
1380      */
1381     int64_t reordered_opaque;
1382
1383     /**
1384      * hardware accelerator private data (FFmpeg-allocated)
1385      * - encoding: unused
1386      * - decoding: Set by libavcodec
1387      */
1388     void *hwaccel_picture_private;
1389
1390     /**
1391      * the AVCodecContext which ff_thread_get_buffer() was last called on
1392      * - encoding: Set by libavcodec.
1393      * - decoding: Set by libavcodec.
1394      */
1395     struct AVCodecContext *owner;
1396
1397     /**
1398      * used by multithreading to store frame-specific info
1399      * - encoding: Set by libavcodec.
1400      * - decoding: Set by libavcodec.
1401      */
1402     void *thread_opaque;
1403
1404     /**
1405      * log2 of the size of the block which a single vector in motion_val represents:
1406      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1407      * - encoding: unused
1408      * - decoding: Set by libavcodec.
1409      */
1410     uint8_t motion_subsample_log2;
1411
1412     /**
1413      * Sample rate of the audio data.
1414      *
1415      * - encoding: unused
1416      * - decoding: read by user
1417      */
1418     int sample_rate;
1419
1420     /**
1421      * Channel layout of the audio data.
1422      *
1423      * - encoding: unused
1424      * - decoding: read by user.
1425      */
1426     uint64_t channel_layout;
1427
1428     /**
1429      * frame timestamp estimated using various heuristics, in stream time base
1430      * Code outside libavcodec should access this field using:
1431      * av_frame_get_best_effort_timestamp(frame)
1432      * - encoding: unused
1433      * - decoding: set by libavcodec, read by user.
1434      */
1435     int64_t best_effort_timestamp;
1436
1437     /**
1438      * reordered pos from the last AVPacket that has been input into the decoder
1439      * Code outside libavcodec should access this field using:
1440      * av_frame_get_pkt_pos(frame)
1441      * - encoding: unused
1442      * - decoding: Read by user.
1443      */
1444     int64_t pkt_pos;
1445
1446     /**
1447      * duration of the corresponding packet, expressed in
1448      * AVStream->time_base units, 0 if unknown.
1449      * Code outside libavcodec should access this field using:
1450      * av_frame_get_pkt_duration(frame)
1451      * - encoding: unused
1452      * - decoding: Read by user.
1453      */
1454     int64_t pkt_duration;
1455
1456     /**
1457      * metadata.
1458      * Code outside libavcodec should access this field using:
1459      * av_frame_get_metadata(frame)
1460      * - encoding: Set by user.
1461      * - decoding: Set by libavcodec.
1462      */
1463     AVDictionary *metadata;
1464
1465     /**
1466      * decode error flags of the frame, set to a combination of
1467      * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1468      * were errors during the decoding.
1469      * Code outside libavcodec should access this field using:
1470      * av_frame_get_decode_error_flags(frame)
1471      * - encoding: unused
1472      * - decoding: set by libavcodec, read by user.
1473      */
1474     int decode_error_flags;
1475 #define FF_DECODE_ERROR_INVALID_BITSTREAM   1
1476 #define FF_DECODE_ERROR_MISSING_REFERENCE   2
1477
1478     /**
1479      * number of audio channels, only used for audio.
1480      * Code outside libavcodec should access this field using:
1481      * av_frame_get_channels(frame)
1482      * - encoding: unused
1483      * - decoding: Read by user.
1484      */
1485     int64_t channels;
1486
1487     /**
1488      * size of the corresponding packet containing the compressed
1489      * frame. It must be accessed using av_frame_get_pkt_size() and
1490      * av_frame_set_pkt_size().
1491      * It is set to a negative value if unknown.
1492      * - encoding: unused
1493      * - decoding: set by libavcodec, read by user.
1494      */
1495     int pkt_size;
1496 } AVFrame;
1497
1498 /**
1499  * Accessors for some AVFrame fields.
1500  * The position of these field in the structure is not part of the ABI,
1501  * they should not be accessed directly outside libavcodec.
1502  */
1503 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1504 void    av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1505 int64_t av_frame_get_pkt_duration         (const AVFrame *frame);
1506 void    av_frame_set_pkt_duration         (AVFrame *frame, int64_t val);
1507 int64_t av_frame_get_pkt_pos              (const AVFrame *frame);
1508 void    av_frame_set_pkt_pos              (AVFrame *frame, int64_t val);
1509 int64_t av_frame_get_channel_layout       (const AVFrame *frame);
1510 void    av_frame_set_channel_layout       (AVFrame *frame, int64_t val);
1511 int     av_frame_get_channels             (const AVFrame *frame);
1512 void    av_frame_set_channels             (AVFrame *frame, int     val);
1513 int     av_frame_get_sample_rate          (const AVFrame *frame);
1514 void    av_frame_set_sample_rate          (AVFrame *frame, int     val);
1515 AVDictionary *av_frame_get_metadata       (const AVFrame *frame);
1516 void          av_frame_set_metadata       (AVFrame *frame, AVDictionary *val);
1517 int     av_frame_get_decode_error_flags   (const AVFrame *frame);
1518 void    av_frame_set_decode_error_flags   (AVFrame *frame, int     val);
1519 int     av_frame_get_pkt_size(const AVFrame *frame);
1520 void    av_frame_set_pkt_size(AVFrame *frame, int val);
1521
1522 struct AVCodecInternal;
1523
1524 enum AVFieldOrder {
1525     AV_FIELD_UNKNOWN,
1526     AV_FIELD_PROGRESSIVE,
1527     AV_FIELD_TT,          //< Top coded_first, top displayed first
1528     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1529     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1530     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1531 };
1532
1533 /**
1534  * main external API structure.
1535  * New fields can be added to the end with minor version bumps.
1536  * Removal, reordering and changes to existing fields require a major
1537  * version bump.
1538  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1539  * applications.
1540  * sizeof(AVCodecContext) must not be used outside libav*.
1541  */
1542 typedef struct AVCodecContext {
1543     /**
1544      * information on struct for av_log
1545      * - set by avcodec_alloc_context3
1546      */
1547     const AVClass *av_class;
1548     int log_level_offset;
1549
1550     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1551     const struct AVCodec  *codec;
1552     char             codec_name[32];
1553     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1554
1555     /**
1556      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1557      * This is used to work around some encoder bugs.
1558      * A demuxer should set this to what is stored in the field used to identify the codec.
1559      * If there are multiple such fields in a container then the demuxer should choose the one
1560      * which maximizes the information about the used codec.
1561      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1562      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1563      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1564      * first.
1565      * - encoding: Set by user, if not then the default based on codec_id will be used.
1566      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1567      */
1568     unsigned int codec_tag;
1569
1570     /**
1571      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1572      * This is used to work around some encoder bugs.
1573      * - encoding: unused
1574      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1575      */
1576     unsigned int stream_codec_tag;
1577
1578 #if FF_API_SUB_ID
1579     /**
1580      * @deprecated this field is unused
1581      */
1582     attribute_deprecated int sub_id;
1583 #endif
1584
1585     void *priv_data;
1586
1587     /**
1588      * Private context used for internal data.
1589      *
1590      * Unlike priv_data, this is not codec-specific. It is used in general
1591      * libavcodec functions.
1592      */
1593     struct AVCodecInternal *internal;
1594
1595     /**
1596      * Private data of the user, can be used to carry app specific stuff.
1597      * - encoding: Set by user.
1598      * - decoding: Set by user.
1599      */
1600     void *opaque;
1601
1602     /**
1603      * the average bitrate
1604      * - encoding: Set by user; unused for constant quantizer encoding.
1605      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1606      */
1607     int bit_rate;
1608
1609     /**
1610      * number of bits the bitstream is allowed to diverge from the reference.
1611      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1612      * - encoding: Set by user; unused for constant quantizer encoding.
1613      * - decoding: unused
1614      */
1615     int bit_rate_tolerance;
1616
1617     /**
1618      * Global quality for codecs which cannot change it per frame.
1619      * This should be proportional to MPEG-1/2/4 qscale.
1620      * - encoding: Set by user.
1621      * - decoding: unused
1622      */
1623     int global_quality;
1624
1625     /**
1626      * - encoding: Set by user.
1627      * - decoding: unused
1628      */
1629     int compression_level;
1630 #define FF_COMPRESSION_DEFAULT -1
1631
1632     /**
1633      * CODEC_FLAG_*.
1634      * - encoding: Set by user.
1635      * - decoding: Set by user.
1636      */
1637     int flags;
1638
1639     /**
1640      * CODEC_FLAG2_*
1641      * - encoding: Set by user.
1642      * - decoding: Set by user.
1643      */
1644     int flags2;
1645
1646     /**
1647      * some codecs need / can use extradata like Huffman tables.
1648      * mjpeg: Huffman tables
1649      * rv10: additional flags
1650      * mpeg4: global headers (they can be in the bitstream or here)
1651      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1652      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1653      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1654      * - encoding: Set/allocated/freed by libavcodec.
1655      * - decoding: Set/allocated/freed by user.
1656      */
1657     uint8_t *extradata;
1658     int extradata_size;
1659
1660     /**
1661      * This is the fundamental unit of time (in seconds) in terms
1662      * of which frame timestamps are represented. For fixed-fps content,
1663      * timebase should be 1/framerate and timestamp increments should be
1664      * identically 1.
1665      * - encoding: MUST be set by user.
1666      * - decoding: Set by libavcodec.
1667      */
1668     AVRational time_base;
1669
1670     /**
1671      * For some codecs, the time base is closer to the field rate than the frame rate.
1672      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1673      * if no telecine is used ...
1674      *
1675      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1676      */
1677     int ticks_per_frame;
1678
1679     /**
1680      * Codec delay.
1681      *
1682      * Encoding: Number of frames delay there will be from the encoder input to
1683      *           the decoder output. (we assume the decoder matches the spec)
1684      * Decoding: Number of frames delay in addition to what a standard decoder
1685      *           as specified in the spec would produce.
1686      *
1687      * Video:
1688      *   Number of frames the decoded output will be delayed relative to the
1689      *   encoded input.
1690      *
1691      * Audio:
1692      *   For encoding, this is the number of "priming" samples added to the
1693      *   beginning of the stream. The decoded output will be delayed by this
1694      *   many samples relative to the input to the encoder. Note that this
1695      *   field is purely informational and does not directly affect the pts
1696      *   output by the encoder, which should always be based on the actual
1697      *   presentation time, including any delay.
1698      *   For decoding, this is the number of samples the decoder needs to
1699      *   output before the decoder's output is valid. When seeking, you should
1700      *   start decoding this many samples prior to your desired seek point.
1701      *
1702      * - encoding: Set by libavcodec.
1703      * - decoding: Set by libavcodec.
1704      */
1705     int delay;
1706
1707
1708     /* video only */
1709     /**
1710      * picture width / height.
1711      * - encoding: MUST be set by user.
1712      * - decoding: Set by libavcodec.
1713      * Note: For compatibility it is possible to set this instead of
1714      * coded_width/height before decoding.
1715      */
1716     int width, height;
1717
1718     /**
1719      * Bitstream width / height, may be different from width/height if lowres enabled.
1720      * - encoding: unused
1721      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1722      */
1723     int coded_width, coded_height;
1724
1725 #define FF_ASPECT_EXTENDED 15
1726
1727     /**
1728      * the number of pictures in a group of pictures, or 0 for intra_only
1729      * - encoding: Set by user.
1730      * - decoding: unused
1731      */
1732     int gop_size;
1733
1734     /**
1735      * Pixel format, see AV_PIX_FMT_xxx.
1736      * May be set by the demuxer if known from headers.
1737      * May be overridden by the decoder if it knows better.
1738      * - encoding: Set by user.
1739      * - decoding: Set by user if known, overridden by libavcodec if known
1740      */
1741     enum AVPixelFormat pix_fmt;
1742
1743     /**
1744      * Motion estimation algorithm used for video coding.
1745      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1746      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1747      * - encoding: MUST be set by user.
1748      * - decoding: unused
1749      */
1750     int me_method;
1751
1752     /**
1753      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1754      * decoder to draw a horizontal band. It improves cache usage. Not
1755      * all codecs can do that. You must check the codec capabilities
1756      * beforehand.
1757      * When multithreading is used, it may be called from multiple threads
1758      * at the same time; threads might draw different parts of the same AVFrame,
1759      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1760      * in order.
1761      * The function is also used by hardware acceleration APIs.
1762      * It is called at least once during frame decoding to pass
1763      * the data needed for hardware render.
1764      * In that mode instead of pixel data, AVFrame points to
1765      * a structure specific to the acceleration API. The application
1766      * reads the structure and can change some fields to indicate progress
1767      * or mark state.
1768      * - encoding: unused
1769      * - decoding: Set by user.
1770      * @param height the height of the slice
1771      * @param y the y position of the slice
1772      * @param type 1->top field, 2->bottom field, 3->frame
1773      * @param offset offset into the AVFrame.data from which the slice should be read
1774      */
1775     void (*draw_horiz_band)(struct AVCodecContext *s,
1776                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1777                             int y, int type, int height);
1778
1779     /**
1780      * callback to negotiate the pixelFormat
1781      * @param fmt is the list of formats which are supported by the codec,
1782      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1783      * The first is always the native one.
1784      * @return the chosen format
1785      * - encoding: unused
1786      * - decoding: Set by user, if not set the native format will be chosen.
1787      */
1788     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1789
1790     /**
1791      * maximum number of B-frames between non-B-frames
1792      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1793      * - encoding: Set by user.
1794      * - decoding: unused
1795      */
1796     int max_b_frames;
1797
1798     /**
1799      * qscale factor between IP and B-frames
1800      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1801      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1802      * - encoding: Set by user.
1803      * - decoding: unused
1804      */
1805     float b_quant_factor;
1806
1807     /** obsolete FIXME remove */
1808     int rc_strategy;
1809 #define FF_RC_STRATEGY_XVID 1
1810
1811     int b_frame_strategy;
1812
1813 #if FF_API_MPV_GLOBAL_OPTS
1814     /**
1815      * luma single coefficient elimination threshold
1816      * - encoding: Set by user.
1817      * - decoding: unused
1818      */
1819     attribute_deprecated int luma_elim_threshold;
1820
1821     /**
1822      * chroma single coeff elimination threshold
1823      * - encoding: Set by user.
1824      * - decoding: unused
1825      */
1826     attribute_deprecated int chroma_elim_threshold;
1827 #endif
1828
1829     /**
1830      * qscale offset between IP and B-frames
1831      * - encoding: Set by user.
1832      * - decoding: unused
1833      */
1834     float b_quant_offset;
1835
1836     /**
1837      * Size of the frame reordering buffer in the decoder.
1838      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1839      * - encoding: Set by libavcodec.
1840      * - decoding: Set by libavcodec.
1841      */
1842     int has_b_frames;
1843
1844     /**
1845      * 0-> h263 quant 1-> mpeg quant
1846      * - encoding: Set by user.
1847      * - decoding: unused
1848      */
1849     int mpeg_quant;
1850
1851     /**
1852      * qscale factor between P and I-frames
1853      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1854      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1855      * - encoding: Set by user.
1856      * - decoding: unused
1857      */
1858     float i_quant_factor;
1859
1860     /**
1861      * qscale offset between P and I-frames
1862      * - encoding: Set by user.
1863      * - decoding: unused
1864      */
1865     float i_quant_offset;
1866
1867     /**
1868      * luminance masking (0-> disabled)
1869      * - encoding: Set by user.
1870      * - decoding: unused
1871      */
1872     float lumi_masking;
1873
1874     /**
1875      * temporary complexity masking (0-> disabled)
1876      * - encoding: Set by user.
1877      * - decoding: unused
1878      */
1879     float temporal_cplx_masking;
1880
1881     /**
1882      * spatial complexity masking (0-> disabled)
1883      * - encoding: Set by user.
1884      * - decoding: unused
1885      */
1886     float spatial_cplx_masking;
1887
1888     /**
1889      * p block masking (0-> disabled)
1890      * - encoding: Set by user.
1891      * - decoding: unused
1892      */
1893     float p_masking;
1894
1895     /**
1896      * darkness masking (0-> disabled)
1897      * - encoding: Set by user.
1898      * - decoding: unused
1899      */
1900     float dark_masking;
1901
1902     /**
1903      * slice count
1904      * - encoding: Set by libavcodec.
1905      * - decoding: Set by user (or 0).
1906      */
1907     int slice_count;
1908     /**
1909      * prediction method (needed for huffyuv)
1910      * - encoding: Set by user.
1911      * - decoding: unused
1912      */
1913      int prediction_method;
1914 #define FF_PRED_LEFT   0
1915 #define FF_PRED_PLANE  1
1916 #define FF_PRED_MEDIAN 2
1917
1918     /**
1919      * slice offsets in the frame in bytes
1920      * - encoding: Set/allocated by libavcodec.
1921      * - decoding: Set/allocated by user (or NULL).
1922      */
1923     int *slice_offset;
1924
1925     /**
1926      * sample aspect ratio (0 if unknown)
1927      * That is the width of a pixel divided by the height of the pixel.
1928      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1929      * - encoding: Set by user.
1930      * - decoding: Set by libavcodec.
1931      */
1932     AVRational sample_aspect_ratio;
1933
1934     /**
1935      * motion estimation comparison function
1936      * - encoding: Set by user.
1937      * - decoding: unused
1938      */
1939     int me_cmp;
1940     /**
1941      * subpixel motion estimation comparison function
1942      * - encoding: Set by user.
1943      * - decoding: unused
1944      */
1945     int me_sub_cmp;
1946     /**
1947      * macroblock comparison function (not supported yet)
1948      * - encoding: Set by user.
1949      * - decoding: unused
1950      */
1951     int mb_cmp;
1952     /**
1953      * interlaced DCT comparison function
1954      * - encoding: Set by user.
1955      * - decoding: unused
1956      */
1957     int ildct_cmp;
1958 #define FF_CMP_SAD    0
1959 #define FF_CMP_SSE    1
1960 #define FF_CMP_SATD   2
1961 #define FF_CMP_DCT    3
1962 #define FF_CMP_PSNR   4
1963 #define FF_CMP_BIT    5
1964 #define FF_CMP_RD     6
1965 #define FF_CMP_ZERO   7
1966 #define FF_CMP_VSAD   8
1967 #define FF_CMP_VSSE   9
1968 #define FF_CMP_NSSE   10
1969 #define FF_CMP_W53    11
1970 #define FF_CMP_W97    12
1971 #define FF_CMP_DCTMAX 13
1972 #define FF_CMP_DCT264 14
1973 #define FF_CMP_CHROMA 256
1974
1975     /**
1976      * ME diamond size & shape
1977      * - encoding: Set by user.
1978      * - decoding: unused
1979      */
1980     int dia_size;
1981
1982     /**
1983      * amount of previous MV predictors (2a+1 x 2a+1 square)
1984      * - encoding: Set by user.
1985      * - decoding: unused
1986      */
1987     int last_predictor_count;
1988
1989     /**
1990      * prepass for motion estimation
1991      * - encoding: Set by user.
1992      * - decoding: unused
1993      */
1994     int pre_me;
1995
1996     /**
1997      * motion estimation prepass comparison function
1998      * - encoding: Set by user.
1999      * - decoding: unused
2000      */
2001     int me_pre_cmp;
2002
2003     /**
2004      * ME prepass diamond size & shape
2005      * - encoding: Set by user.
2006      * - decoding: unused
2007      */
2008     int pre_dia_size;
2009
2010     /**
2011      * subpel ME quality
2012      * - encoding: Set by user.
2013      * - decoding: unused
2014      */
2015     int me_subpel_quality;
2016
2017     /**
2018      * DTG active format information (additional aspect ratio
2019      * information only used in DVB MPEG-2 transport streams)
2020      * 0 if not set.
2021      *
2022      * - encoding: unused
2023      * - decoding: Set by decoder.
2024      */
2025     int dtg_active_format;
2026 #define FF_DTG_AFD_SAME         8
2027 #define FF_DTG_AFD_4_3          9
2028 #define FF_DTG_AFD_16_9         10
2029 #define FF_DTG_AFD_14_9         11
2030 #define FF_DTG_AFD_4_3_SP_14_9  13
2031 #define FF_DTG_AFD_16_9_SP_14_9 14
2032 #define FF_DTG_AFD_SP_4_3       15
2033
2034     /**
2035      * maximum motion estimation search range in subpel units
2036      * If 0 then no limit.
2037      *
2038      * - encoding: Set by user.
2039      * - decoding: unused
2040      */
2041     int me_range;
2042
2043     /**
2044      * intra quantizer bias
2045      * - encoding: Set by user.
2046      * - decoding: unused
2047      */
2048     int intra_quant_bias;
2049 #define FF_DEFAULT_QUANT_BIAS 999999
2050
2051     /**
2052      * inter quantizer bias
2053      * - encoding: Set by user.
2054      * - decoding: unused
2055      */
2056     int inter_quant_bias;
2057
2058 #if FF_API_COLOR_TABLE_ID
2059     /**
2060      * color table ID
2061      * - encoding: unused
2062      * - decoding: Which clrtable should be used for 8bit RGB images.
2063      *             Tables have to be stored somewhere. FIXME
2064      */
2065     attribute_deprecated int color_table_id;
2066 #endif
2067
2068     /**
2069      * slice flags
2070      * - encoding: unused
2071      * - decoding: Set by user.
2072      */
2073     int slice_flags;
2074 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2075 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2076 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2077
2078     /**
2079      * XVideo Motion Acceleration
2080      * - encoding: forbidden
2081      * - decoding: set by decoder
2082      */
2083     int xvmc_acceleration;
2084
2085     /**
2086      * macroblock decision mode
2087      * - encoding: Set by user.
2088      * - decoding: unused
2089      */
2090     int mb_decision;
2091 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2092 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2093 #define FF_MB_DECISION_RD     2        ///< rate distortion
2094
2095     /**
2096      * custom intra quantization matrix
2097      * - encoding: Set by user, can be NULL.
2098      * - decoding: Set by libavcodec.
2099      */
2100     uint16_t *intra_matrix;
2101
2102     /**
2103      * custom inter quantization matrix
2104      * - encoding: Set by user, can be NULL.
2105      * - decoding: Set by libavcodec.
2106      */
2107     uint16_t *inter_matrix;
2108
2109     /**
2110      * scene change detection threshold
2111      * 0 is default, larger means fewer detected scene changes.
2112      * - encoding: Set by user.
2113      * - decoding: unused
2114      */
2115     int scenechange_threshold;
2116
2117     /**
2118      * noise reduction strength
2119      * - encoding: Set by user.
2120      * - decoding: unused
2121      */
2122     int noise_reduction;
2123
2124 #if FF_API_INTER_THRESHOLD
2125     /**
2126      * @deprecated this field is unused
2127      */
2128     attribute_deprecated int inter_threshold;
2129 #endif
2130
2131 #if FF_API_MPV_GLOBAL_OPTS
2132     /**
2133      * @deprecated use mpegvideo private options instead
2134      */
2135     attribute_deprecated int quantizer_noise_shaping;
2136 #endif
2137
2138     /**
2139      * Motion estimation threshold below which no motion estimation is
2140      * performed, but instead the user specified motion vectors are used.
2141      *
2142      * - encoding: Set by user.
2143      * - decoding: unused
2144      */
2145     int me_threshold;
2146
2147     /**
2148      * Macroblock threshold below which the user specified macroblock types will be used.
2149      * - encoding: Set by user.
2150      * - decoding: unused
2151      */
2152     int mb_threshold;
2153
2154     /**
2155      * precision of the intra DC coefficient - 8
2156      * - encoding: Set by user.
2157      * - decoding: unused
2158      */
2159     int intra_dc_precision;
2160
2161     /**
2162      * Number of macroblock rows at the top which are skipped.
2163      * - encoding: unused
2164      * - decoding: Set by user.
2165      */
2166     int skip_top;
2167
2168     /**
2169      * Number of macroblock rows at the bottom which are skipped.
2170      * - encoding: unused
2171      * - decoding: Set by user.
2172      */
2173     int skip_bottom;
2174
2175     /**
2176      * Border processing masking, raises the quantizer for mbs on the borders
2177      * of the picture.
2178      * - encoding: Set by user.
2179      * - decoding: unused
2180      */
2181     float border_masking;
2182
2183     /**
2184      * minimum MB lagrange multipler
2185      * - encoding: Set by user.
2186      * - decoding: unused
2187      */
2188     int mb_lmin;
2189
2190     /**
2191      * maximum MB lagrange multipler
2192      * - encoding: Set by user.
2193      * - decoding: unused
2194      */
2195     int mb_lmax;
2196
2197     /**
2198      *
2199      * - encoding: Set by user.
2200      * - decoding: unused
2201      */
2202     int me_penalty_compensation;
2203
2204     /**
2205      *
2206      * - encoding: Set by user.
2207      * - decoding: unused
2208      */
2209     int bidir_refine;
2210
2211     /**
2212      *
2213      * - encoding: Set by user.
2214      * - decoding: unused
2215      */
2216     int brd_scale;
2217
2218     /**
2219      * minimum GOP size
2220      * - encoding: Set by user.
2221      * - decoding: unused
2222      */
2223     int keyint_min;
2224
2225     /**
2226      * number of reference frames
2227      * - encoding: Set by user.
2228      * - decoding: Set by lavc.
2229      */
2230     int refs;
2231
2232     /**
2233      * chroma qp offset from luma
2234      * - encoding: Set by user.
2235      * - decoding: unused
2236      */
2237     int chromaoffset;
2238
2239     /**
2240      * Multiplied by qscale for each frame and added to scene_change_score.
2241      * - encoding: Set by user.
2242      * - decoding: unused
2243      */
2244     int scenechange_factor;
2245
2246     /**
2247      *
2248      * Note: Value depends upon the compare function used for fullpel ME.
2249      * - encoding: Set by user.
2250      * - decoding: unused
2251      */
2252     int mv0_threshold;
2253
2254     /**
2255      * Adjust sensitivity of b_frame_strategy 1.
2256      * - encoding: Set by user.
2257      * - decoding: unused
2258      */
2259     int b_sensitivity;
2260
2261     /**
2262      * Chromaticity coordinates of the source primaries.
2263      * - encoding: Set by user
2264      * - decoding: Set by libavcodec
2265      */
2266     enum AVColorPrimaries color_primaries;
2267
2268     /**
2269      * Color Transfer Characteristic.
2270      * - encoding: Set by user
2271      * - decoding: Set by libavcodec
2272      */
2273     enum AVColorTransferCharacteristic color_trc;
2274
2275     /**
2276      * YUV colorspace type.
2277      * - encoding: Set by user
2278      * - decoding: Set by libavcodec
2279      */
2280     enum AVColorSpace colorspace;
2281
2282     /**
2283      * MPEG vs JPEG YUV range.
2284      * - encoding: Set by user
2285      * - decoding: Set by libavcodec
2286      */
2287     enum AVColorRange color_range;
2288
2289     /**
2290      * This defines the location of chroma samples.
2291      * - encoding: Set by user
2292      * - decoding: Set by libavcodec
2293      */
2294     enum AVChromaLocation chroma_sample_location;
2295
2296     /**
2297      * Number of slices.
2298      * Indicates number of picture subdivisions. Used for parallelized
2299      * decoding.
2300      * - encoding: Set by user
2301      * - decoding: unused
2302      */
2303     int slices;
2304
2305     /** Field order
2306      * - encoding: set by libavcodec
2307      * - decoding: Set by user.
2308      */
2309     enum AVFieldOrder field_order;
2310
2311     /* audio only */
2312     int sample_rate; ///< samples per second
2313     int channels;    ///< number of audio channels
2314
2315     /**
2316      * audio sample format
2317      * - encoding: Set by user.
2318      * - decoding: Set by libavcodec.
2319      */
2320     enum AVSampleFormat sample_fmt;  ///< sample format
2321
2322     /* The following data should not be initialized. */
2323     /**
2324      * Number of samples per channel in an audio frame.
2325      *
2326      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2327      *   except the last must contain exactly frame_size samples per channel.
2328      *   May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2329      *   frame size is not restricted.
2330      * - decoding: may be set by some decoders to indicate constant frame size
2331      */
2332     int frame_size;
2333
2334     /**
2335      * Frame counter, set by libavcodec.
2336      *
2337      * - decoding: total number of frames returned from the decoder so far.
2338      * - encoding: total number of frames passed to the encoder so far.
2339      *
2340      *   @note the counter is not incremented if encoding/decoding resulted in
2341      *   an error.
2342      */
2343     int frame_number;
2344
2345     /**
2346      * number of bytes per packet if constant and known or 0
2347      * Used by some WAV based audio codecs.
2348      */
2349     int block_align;
2350
2351     /**
2352      * Audio cutoff bandwidth (0 means "automatic")
2353      * - encoding: Set by user.
2354      * - decoding: unused
2355      */
2356     int cutoff;
2357
2358 #if FF_API_REQUEST_CHANNELS
2359     /**
2360      * Decoder should decode to this many channels if it can (0 for default)
2361      * - encoding: unused
2362      * - decoding: Set by user.
2363      * @deprecated Deprecated in favor of request_channel_layout.
2364      */
2365     int request_channels;
2366 #endif
2367
2368     /**
2369      * Audio channel layout.
2370      * - encoding: set by user.
2371      * - decoding: set by user, may be overwritten by libavcodec.
2372      */
2373     uint64_t channel_layout;
2374
2375     /**
2376      * Request decoder to use this channel layout if it can (0 for default)
2377      * - encoding: unused
2378      * - decoding: Set by user.
2379      */
2380     uint64_t request_channel_layout;
2381
2382     /**
2383      * Type of service that the audio stream conveys.
2384      * - encoding: Set by user.
2385      * - decoding: Set by libavcodec.
2386      */
2387     enum AVAudioServiceType audio_service_type;
2388
2389     /**
2390      * desired sample format
2391      * - encoding: Not used.
2392      * - decoding: Set by user.
2393      * Decoder will decode to this format if it can.
2394      */
2395     enum AVSampleFormat request_sample_fmt;
2396
2397     /**
2398      * Called at the beginning of each frame to get a buffer for it.
2399      *
2400      * The function will set AVFrame.data[], AVFrame.linesize[].
2401      * AVFrame.extended_data[] must also be set, but it should be the same as
2402      * AVFrame.data[] except for planar audio with more channels than can fit
2403      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2404      * many data pointers as it can hold.
2405      *
2406      * if CODEC_CAP_DR1 is not set then get_buffer() must call
2407      * avcodec_default_get_buffer() instead of providing buffers allocated by
2408      * some other means.
2409      *
2410      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2411      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2412      * but if get_buffer() is overridden then alignment considerations should
2413      * be taken into account.
2414      *
2415      * @see avcodec_default_get_buffer()
2416      *
2417      * Video:
2418      *
2419      * If pic.reference is set then the frame will be read later by libavcodec.
2420      * avcodec_align_dimensions2() should be used to find the required width and
2421      * height, as they normally need to be rounded up to the next multiple of 16.
2422      *
2423      * If frame multithreading is used and thread_safe_callbacks is set,
2424      * it may be called from a different thread, but not from more than one at
2425      * once. Does not need to be reentrant.
2426      *
2427      * @see release_buffer(), reget_buffer()
2428      * @see avcodec_align_dimensions2()
2429      *
2430      * Audio:
2431      *
2432      * Decoders request a buffer of a particular size by setting
2433      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2434      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2435      * to a smaller value in the output frame.
2436      *
2437      * Decoders cannot use the buffer after returning from
2438      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2439      * is assumed to be released immediately upon return. In some rare cases,
2440      * a decoder may need to call get_buffer() more than once in a single
2441      * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2442      * called again after it has already been called once, the previously
2443      * acquired buffer is assumed to be released at that time and may not be
2444      * reused by the decoder.
2445      *
2446      * As a convenience, av_samples_get_buffer_size() and
2447      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2448      * functions to find the required data size and to fill data pointers and
2449      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2450      * since all planes must be the same size.
2451      *
2452      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2453      *
2454      * - encoding: unused
2455      * - decoding: Set by libavcodec, user can override.
2456      */
2457     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2458
2459     /**
2460      * Called to release buffers which were allocated with get_buffer.
2461      * A released buffer can be reused in get_buffer().
2462      * pic.data[*] must be set to NULL.
2463      * May be called from a different thread if frame multithreading is used,
2464      * but not by more than one thread at once, so does not need to be reentrant.
2465      * - encoding: unused
2466      * - decoding: Set by libavcodec, user can override.
2467      */
2468     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2469
2470     /**
2471      * Called at the beginning of a frame to get cr buffer for it.
2472      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2473      * libavcodec will pass previous buffer in pic, function should return
2474      * same buffer or new buffer with old frame "painted" into it.
2475      * If pic.data[0] == NULL must behave like get_buffer().
2476      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2477      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2478      * some other means.
2479      * - encoding: unused
2480      * - decoding: Set by libavcodec, user can override.
2481      */
2482     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2483
2484
2485     /* - encoding parameters */
2486     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2487     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2488
2489     /**
2490      * minimum quantizer
2491      * - encoding: Set by user.
2492      * - decoding: unused
2493      */
2494     int qmin;
2495
2496     /**
2497      * maximum quantizer
2498      * - encoding: Set by user.
2499      * - decoding: unused
2500      */
2501     int qmax;
2502
2503     /**
2504      * maximum quantizer difference between frames
2505      * - encoding: Set by user.
2506      * - decoding: unused
2507      */
2508     int max_qdiff;
2509
2510     /**
2511      * ratecontrol qmin qmax limiting method
2512      * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2513      * - encoding: Set by user.
2514      * - decoding: unused
2515      */
2516     float rc_qsquish;
2517
2518     float rc_qmod_amp;
2519     int rc_qmod_freq;
2520
2521     /**
2522      * decoder bitstream buffer size
2523      * - encoding: Set by user.
2524      * - decoding: unused
2525      */
2526     int rc_buffer_size;
2527
2528     /**
2529      * ratecontrol override, see RcOverride
2530      * - encoding: Allocated/set/freed by user.
2531      * - decoding: unused
2532      */
2533     int rc_override_count;
2534     RcOverride *rc_override;
2535
2536     /**
2537      * rate control equation
2538      * - encoding: Set by user
2539      * - decoding: unused
2540      */
2541     const char *rc_eq;
2542
2543     /**
2544      * maximum bitrate
2545      * - encoding: Set by user.
2546      * - decoding: unused
2547      */
2548     int rc_max_rate;
2549
2550     /**
2551      * minimum bitrate
2552      * - encoding: Set by user.
2553      * - decoding: unused
2554      */
2555     int rc_min_rate;
2556
2557     float rc_buffer_aggressivity;
2558
2559     /**
2560      * initial complexity for pass1 ratecontrol
2561      * - encoding: Set by user.
2562      * - decoding: unused
2563      */
2564     float rc_initial_cplx;
2565
2566     /**
2567      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2568      * - encoding: Set by user.
2569      * - decoding: unused.
2570      */
2571     float rc_max_available_vbv_use;
2572
2573     /**
2574      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2575      * - encoding: Set by user.
2576      * - decoding: unused.
2577      */
2578     float rc_min_vbv_overflow_use;
2579
2580     /**
2581      * Number of bits which should be loaded into the rc buffer before decoding starts.
2582      * - encoding: Set by user.
2583      * - decoding: unused
2584      */
2585     int rc_initial_buffer_occupancy;
2586
2587 #define FF_CODER_TYPE_VLC       0
2588 #define FF_CODER_TYPE_AC        1
2589 #define FF_CODER_TYPE_RAW       2
2590 #define FF_CODER_TYPE_RLE       3
2591 #define FF_CODER_TYPE_DEFLATE   4
2592     /**
2593      * coder type
2594      * - encoding: Set by user.
2595      * - decoding: unused
2596      */
2597     int coder_type;
2598
2599     /**
2600      * context model
2601      * - encoding: Set by user.
2602      * - decoding: unused
2603      */
2604     int context_model;
2605
2606     /**
2607      * minimum Lagrange multipler
2608      * - encoding: Set by user.
2609      * - decoding: unused
2610      */
2611     int lmin;
2612
2613     /**
2614      * maximum Lagrange multipler
2615      * - encoding: Set by user.
2616      * - decoding: unused
2617      */
2618     int lmax;
2619
2620     /**
2621      * frame skip threshold
2622      * - encoding: Set by user.
2623      * - decoding: unused
2624      */
2625     int frame_skip_threshold;
2626
2627     /**
2628      * frame skip factor
2629      * - encoding: Set by user.
2630      * - decoding: unused
2631      */
2632     int frame_skip_factor;
2633
2634     /**
2635      * frame skip exponent
2636      * - encoding: Set by user.
2637      * - decoding: unused
2638      */
2639     int frame_skip_exp;
2640
2641     /**
2642      * frame skip comparison function
2643      * - encoding: Set by user.
2644      * - decoding: unused
2645      */
2646     int frame_skip_cmp;
2647
2648     /**
2649      * trellis RD quantization
2650      * - encoding: Set by user.
2651      * - decoding: unused
2652      */
2653     int trellis;
2654
2655     /**
2656      * - encoding: Set by user.
2657      * - decoding: unused
2658      */
2659     int min_prediction_order;
2660
2661     /**
2662      * - encoding: Set by user.
2663      * - decoding: unused
2664      */
2665     int max_prediction_order;
2666
2667     /**
2668      * GOP timecode frame start number
2669      * - encoding: Set by user, in non drop frame format
2670      * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2671      */
2672     int64_t timecode_frame_start;
2673
2674     /* The RTP callback: This function is called    */
2675     /* every time the encoder has a packet to send. */
2676     /* It depends on the encoder if the data starts */
2677     /* with a Start Code (it should). H.263 does.   */
2678     /* mb_nb contains the number of macroblocks     */
2679     /* encoded in the RTP payload.                  */
2680     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2681
2682     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2683                             /* do its best to deliver a chunk with size     */
2684                             /* below rtp_payload_size, the chunk will start */
2685                             /* with a start code on some codecs like H.263. */
2686                             /* This doesn't take account of any particular  */
2687                             /* headers inside the transmitted RTP payload.  */
2688
2689     /* statistics, used for 2-pass encoding */
2690     int mv_bits;
2691     int header_bits;
2692     int i_tex_bits;
2693     int p_tex_bits;
2694     int i_count;
2695     int p_count;
2696     int skip_count;
2697     int misc_bits;
2698
2699     /**
2700      * number of bits used for the previously encoded frame
2701      * - encoding: Set by libavcodec.
2702      * - decoding: unused
2703      */
2704     int frame_bits;
2705
2706     /**
2707      * pass1 encoding statistics output buffer
2708      * - encoding: Set by libavcodec.
2709      * - decoding: unused
2710      */
2711     char *stats_out;
2712
2713     /**
2714      * pass2 encoding statistics input buffer
2715      * Concatenated stuff from stats_out of pass1 should be placed here.
2716      * - encoding: Allocated/set/freed by user.
2717      * - decoding: unused
2718      */
2719     char *stats_in;
2720
2721     /**
2722      * Work around bugs in encoders which sometimes cannot be detected automatically.
2723      * - encoding: Set by user
2724      * - decoding: Set by user
2725      */
2726     int workaround_bugs;
2727 #define FF_BUG_AUTODETECT       1  ///< autodetection
2728 #define FF_BUG_OLD_MSMPEG4      2
2729 #define FF_BUG_XVID_ILACE       4
2730 #define FF_BUG_UMP4             8
2731 #define FF_BUG_NO_PADDING       16
2732 #define FF_BUG_AMV              32
2733 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2734 #define FF_BUG_QPEL_CHROMA      64
2735 #define FF_BUG_STD_QPEL         128
2736 #define FF_BUG_QPEL_CHROMA2     256
2737 #define FF_BUG_DIRECT_BLOCKSIZE 512
2738 #define FF_BUG_EDGE             1024
2739 #define FF_BUG_HPEL_CHROMA      2048
2740 #define FF_BUG_DC_CLIP          4096
2741 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2742 #define FF_BUG_TRUNCATED       16384
2743
2744     /**
2745      * strictly follow the standard (MPEG4, ...).
2746      * - encoding: Set by user.
2747      * - decoding: Set by user.
2748      * Setting this to STRICT or higher means the encoder and decoder will
2749      * generally do stupid things, whereas setting it to unofficial or lower
2750      * will mean the encoder might produce output that is not supported by all
2751      * spec-compliant decoders. Decoders don't differentiate between normal,
2752      * unofficial and experimental (that is, they always try to decode things
2753      * when they can) unless they are explicitly asked to behave stupidly
2754      * (=strictly conform to the specs)
2755      */
2756     int strict_std_compliance;
2757 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2758 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2759 #define FF_COMPLIANCE_NORMAL        0
2760 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2761 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2762
2763     /**
2764      * error concealment flags
2765      * - encoding: unused
2766      * - decoding: Set by user.
2767      */
2768     int error_concealment;
2769 #define FF_EC_GUESS_MVS   1
2770 #define FF_EC_DEBLOCK     2
2771
2772     /**
2773      * debug
2774      * - encoding: Set by user.
2775      * - decoding: Set by user.
2776      */
2777     int debug;
2778 #define FF_DEBUG_PICT_INFO   1
2779 #define FF_DEBUG_RC          2
2780 #define FF_DEBUG_BITSTREAM   4
2781 #define FF_DEBUG_MB_TYPE     8
2782 #define FF_DEBUG_QP          16
2783 #define FF_DEBUG_MV          32
2784 #define FF_DEBUG_DCT_COEFF   0x00000040
2785 #define FF_DEBUG_SKIP        0x00000080
2786 #define FF_DEBUG_STARTCODE   0x00000100
2787 #define FF_DEBUG_PTS         0x00000200
2788 #define FF_DEBUG_ER          0x00000400
2789 #define FF_DEBUG_MMCO        0x00000800
2790 #define FF_DEBUG_BUGS        0x00001000
2791 #define FF_DEBUG_VIS_QP      0x00002000
2792 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2793 #define FF_DEBUG_BUFFERS     0x00008000
2794 #define FF_DEBUG_THREADS     0x00010000
2795
2796     /**
2797      * debug
2798      * - encoding: Set by user.
2799      * - decoding: Set by user.
2800      */
2801     int debug_mv;
2802 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2803 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2804 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2805
2806     /**
2807      * Error recognition; may misdetect some more or less valid parts as errors.
2808      * - encoding: unused
2809      * - decoding: Set by user.
2810      */
2811     int err_recognition;
2812 #define AV_EF_CRCCHECK  (1<<0)
2813 #define AV_EF_BITSTREAM (1<<1)
2814 #define AV_EF_BUFFER    (1<<2)
2815 #define AV_EF_EXPLODE   (1<<3)
2816
2817 #define AV_EF_CAREFUL    (1<<16)
2818 #define AV_EF_COMPLIANT  (1<<17)
2819 #define AV_EF_AGGRESSIVE (1<<18)
2820
2821
2822     /**
2823      * opaque 64bit number (generally a PTS) that will be reordered and
2824      * output in AVFrame.reordered_opaque
2825      * @deprecated in favor of pkt_pts
2826      * - encoding: unused
2827      * - decoding: Set by user.
2828      */
2829     int64_t reordered_opaque;
2830
2831     /**
2832      * Hardware accelerator in use
2833      * - encoding: unused.
2834      * - decoding: Set by libavcodec
2835      */
2836     struct AVHWAccel *hwaccel;
2837
2838     /**
2839      * Hardware accelerator context.
2840      * For some hardware accelerators, a global context needs to be
2841      * provided by the user. In that case, this holds display-dependent
2842      * data FFmpeg cannot instantiate itself. Please refer to the
2843      * FFmpeg HW accelerator documentation to know how to fill this
2844      * is. e.g. for VA API, this is a struct vaapi_context.
2845      * - encoding: unused
2846      * - decoding: Set by user
2847      */
2848     void *hwaccel_context;
2849
2850     /**
2851      * error
2852      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2853      * - decoding: unused
2854      */
2855     uint64_t error[AV_NUM_DATA_POINTERS];
2856
2857     /**
2858      * DCT algorithm, see FF_DCT_* below
2859      * - encoding: Set by user.
2860      * - decoding: unused
2861      */
2862     int dct_algo;
2863 #define FF_DCT_AUTO    0
2864 #define FF_DCT_FASTINT 1
2865 #define FF_DCT_INT     2
2866 #define FF_DCT_MMX     3
2867 #define FF_DCT_ALTIVEC 5
2868 #define FF_DCT_FAAN    6
2869
2870     /**
2871      * IDCT algorithm, see FF_IDCT_* below.
2872      * - encoding: Set by user.
2873      * - decoding: Set by user.
2874      */
2875     int idct_algo;
2876 #define FF_IDCT_AUTO          0
2877 #define FF_IDCT_INT           1
2878 #define FF_IDCT_SIMPLE        2
2879 #define FF_IDCT_SIMPLEMMX     3
2880 #define FF_IDCT_LIBMPEG2MMX   4
2881 #if FF_API_MMI
2882 #define FF_IDCT_MMI           5
2883 #endif
2884 #define FF_IDCT_ARM           7
2885 #define FF_IDCT_ALTIVEC       8
2886 #define FF_IDCT_SH4           9
2887 #define FF_IDCT_SIMPLEARM     10
2888 #define FF_IDCT_H264          11
2889 #define FF_IDCT_VP3           12
2890 #define FF_IDCT_IPP           13
2891 #define FF_IDCT_XVIDMMX       14
2892 #define FF_IDCT_CAVS          15
2893 #define FF_IDCT_SIMPLEARMV5TE 16
2894 #define FF_IDCT_SIMPLEARMV6   17
2895 #define FF_IDCT_SIMPLEVIS     18
2896 #define FF_IDCT_WMV2          19
2897 #define FF_IDCT_FAAN          20
2898 #define FF_IDCT_EA            21
2899 #define FF_IDCT_SIMPLENEON    22
2900 #define FF_IDCT_SIMPLEALPHA   23
2901 #define FF_IDCT_BINK          24
2902
2903 #if FF_API_DSP_MASK
2904     /**
2905      * Unused.
2906      * @deprecated use av_set_cpu_flags_mask() instead.
2907      */
2908     attribute_deprecated unsigned dsp_mask;
2909 #endif
2910
2911     /**
2912      * bits per sample/pixel from the demuxer (needed for huffyuv).
2913      * - encoding: Set by libavcodec.
2914      * - decoding: Set by user.
2915      */
2916      int bits_per_coded_sample;
2917
2918     /**
2919      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2920      * - encoding: set by user.
2921      * - decoding: set by libavcodec.
2922      */
2923     int bits_per_raw_sample;
2924
2925     /**
2926      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2927      * - encoding: unused
2928      * - decoding: Set by user.
2929      */
2930      int lowres;
2931
2932     /**
2933      * the picture in the bitstream
2934      * - encoding: Set by libavcodec.
2935      * - decoding: Set by libavcodec.
2936      */
2937     AVFrame *coded_frame;
2938
2939     /**
2940      * thread count
2941      * is used to decide how many independent tasks should be passed to execute()
2942      * - encoding: Set by user.
2943      * - decoding: Set by user.
2944      */
2945     int thread_count;
2946
2947     /**
2948      * Which multithreading methods to use.
2949      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2950      * so clients which cannot provide future frames should not use it.
2951      *
2952      * - encoding: Set by user, otherwise the default is used.
2953      * - decoding: Set by user, otherwise the default is used.
2954      */
2955     int thread_type;
2956 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2957 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2958
2959     /**
2960      * Which multithreading methods are in use by the codec.
2961      * - encoding: Set by libavcodec.
2962      * - decoding: Set by libavcodec.
2963      */
2964     int active_thread_type;
2965
2966     /**
2967      * Set by the client if its custom get_buffer() callback can be called
2968      * synchronously from another thread, which allows faster multithreaded decoding.
2969      * draw_horiz_band() will be called from other threads regardless of this setting.
2970      * Ignored if the default get_buffer() is used.
2971      * - encoding: Set by user.
2972      * - decoding: Set by user.
2973      */
2974     int thread_safe_callbacks;
2975
2976     /**
2977      * The codec may call this to execute several independent things.
2978      * It will return only after finishing all tasks.
2979      * The user may replace this with some multithreaded implementation,
2980      * the default implementation will execute the parts serially.
2981      * @param count the number of things to execute
2982      * - encoding: Set by libavcodec, user can override.
2983      * - decoding: Set by libavcodec, user can override.
2984      */
2985     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2986
2987     /**
2988      * The codec may call this to execute several independent things.
2989      * It will return only after finishing all tasks.
2990      * The user may replace this with some multithreaded implementation,
2991      * the default implementation will execute the parts serially.
2992      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2993      * @param c context passed also to func
2994      * @param count the number of things to execute
2995      * @param arg2 argument passed unchanged to func
2996      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2997      * @param func function that will be called count times, with jobnr from 0 to count-1.
2998      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2999      *             two instances of func executing at the same time will have the same threadnr.
3000      * @return always 0 currently, but code should handle a future improvement where when any call to func
3001      *         returns < 0 no further calls to func may be done and < 0 is returned.
3002      * - encoding: Set by libavcodec, user can override.
3003      * - decoding: Set by libavcodec, user can override.
3004      */
3005     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3006
3007     /**
3008      * thread opaque
3009      * Can be used by execute() to store some per AVCodecContext stuff.
3010      * - encoding: set by execute()
3011      * - decoding: set by execute()
3012      */
3013     void *thread_opaque;
3014
3015     /**
3016      * noise vs. sse weight for the nsse comparsion function
3017      * - encoding: Set by user.
3018      * - decoding: unused
3019      */
3020      int nsse_weight;
3021
3022     /**
3023      * profile
3024      * - encoding: Set by user.
3025      * - decoding: Set by libavcodec.
3026      */
3027      int profile;
3028 #define FF_PROFILE_UNKNOWN -99
3029 #define FF_PROFILE_RESERVED -100
3030
3031 #define FF_PROFILE_AAC_MAIN 0
3032 #define FF_PROFILE_AAC_LOW  1
3033 #define FF_PROFILE_AAC_SSR  2
3034 #define FF_PROFILE_AAC_LTP  3
3035 #define FF_PROFILE_AAC_HE   4
3036 #define FF_PROFILE_AAC_HE_V2 28
3037 #define FF_PROFILE_AAC_LD   22
3038 #define FF_PROFILE_AAC_ELD  38
3039
3040 #define FF_PROFILE_DTS         20
3041 #define FF_PROFILE_DTS_ES      30
3042 #define FF_PROFILE_DTS_96_24   40
3043 #define FF_PROFILE_DTS_HD_HRA  50
3044 #define FF_PROFILE_DTS_HD_MA   60
3045
3046 #define FF_PROFILE_MPEG2_422    0
3047 #define FF_PROFILE_MPEG2_HIGH   1
3048 #define FF_PROFILE_MPEG2_SS     2
3049 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3050 #define FF_PROFILE_MPEG2_MAIN   4
3051 #define FF_PROFILE_MPEG2_SIMPLE 5
3052
3053 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3054 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3055
3056 #define FF_PROFILE_H264_BASELINE             66
3057 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3058 #define FF_PROFILE_H264_MAIN                 77
3059 #define FF_PROFILE_H264_EXTENDED             88
3060 #define FF_PROFILE_H264_HIGH                 100
3061 #define FF_PROFILE_H264_HIGH_10              110
3062 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3063 #define FF_PROFILE_H264_HIGH_422             122
3064 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3065 #define FF_PROFILE_H264_HIGH_444             144
3066 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3067 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3068 #define FF_PROFILE_H264_CAVLC_444            44
3069
3070 #define FF_PROFILE_VC1_SIMPLE   0
3071 #define FF_PROFILE_VC1_MAIN     1
3072 #define FF_PROFILE_VC1_COMPLEX  2
3073 #define FF_PROFILE_VC1_ADVANCED 3
3074
3075 #define FF_PROFILE_MPEG4_SIMPLE                     0
3076 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3077 #define FF_PROFILE_MPEG4_CORE                       2
3078 #define FF_PROFILE_MPEG4_MAIN                       3
3079 #define FF_PROFILE_MPEG4_N_BIT                      4
3080 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3081 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3082 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3083 #define FF_PROFILE_MPEG4_HYBRID                     8
3084 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3085 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3086 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3087 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3088 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3089 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3090 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3091
3092     /**
3093      * level
3094      * - encoding: Set by user.
3095      * - decoding: Set by libavcodec.
3096      */
3097      int level;
3098 #define FF_LEVEL_UNKNOWN -99
3099
3100     /**
3101      *
3102      * - encoding: unused
3103      * - decoding: Set by user.
3104      */
3105     enum AVDiscard skip_loop_filter;
3106
3107     /**
3108      *
3109      * - encoding: unused
3110      * - decoding: Set by user.
3111      */
3112     enum AVDiscard skip_idct;
3113
3114     /**
3115      *
3116      * - encoding: unused
3117      * - decoding: Set by user.
3118      */
3119     enum AVDiscard skip_frame;
3120
3121     /**
3122      * Header containing style information for text subtitles.
3123      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3124      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3125      * the Format line following. It shouldn't include any Dialogue line.
3126      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3127      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3128      */
3129     uint8_t *subtitle_header;
3130     int subtitle_header_size;
3131
3132     /**
3133      * Simulates errors in the bitstream to test error concealment.
3134      * - encoding: Set by user.
3135      * - decoding: unused
3136      */
3137     int error_rate;
3138
3139     /**
3140      * Current packet as passed into the decoder, to avoid having
3141      * to pass the packet into every function. Currently only valid
3142      * inside lavc and get/release_buffer callbacks.
3143      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3144      * - encoding: unused
3145      */
3146     AVPacket *pkt;
3147
3148     /**
3149      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3150      * Used for compliant TS muxing.
3151      * - encoding: Set by libavcodec.
3152      * - decoding: unused.
3153      */
3154     uint64_t vbv_delay;
3155
3156     /**
3157      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3158      * Code outside libavcodec should access this field using:
3159      * avcodec_set_pkt_timebase(avctx)
3160      * - encoding unused.
3161      * - decodimg set by user
3162      */
3163     AVRational pkt_timebase;
3164
3165     /**
3166      * AVCodecDescriptor
3167      * Code outside libavcodec should access this field using:
3168      * avcodec_get_codec_descriptior(avctx)
3169      * - encoding: unused.
3170      * - decoding: set by libavcodec.
3171      */
3172     const AVCodecDescriptor *codec_descriptor;
3173
3174     /**
3175      * Current statistics for PTS correction.
3176      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3177      * - encoding: unused
3178      */
3179     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3180     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3181     int64_t pts_correction_last_pts;       /// PTS of the last frame
3182     int64_t pts_correction_last_dts;       /// DTS of the last frame
3183
3184     /**
3185      * Current frame metadata.
3186      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3187      * - encoding: unused
3188      */
3189     AVDictionary *metadata;
3190 } AVCodecContext;
3191
3192 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3193 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3194
3195 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3196 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3197
3198 /**
3199  * AVProfile.
3200  */
3201 typedef struct AVProfile {
3202     int profile;
3203     const char *name; ///< short name for the profile
3204 } AVProfile;
3205
3206 typedef struct AVCodecDefault AVCodecDefault;
3207
3208 struct AVSubtitle;
3209
3210 /**
3211  * AVCodec.
3212  */
3213 typedef struct AVCodec {
3214     /**
3215      * Name of the codec implementation.
3216      * The name is globally unique among encoders and among decoders (but an
3217      * encoder and a decoder can share the same name).
3218      * This is the primary way to find a codec from the user perspective.
3219      */
3220     const char *name;
3221     /**
3222      * Descriptive name for the codec, meant to be more human readable than name.
3223      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3224      */
3225     const char *long_name;
3226     enum AVMediaType type;
3227     enum AVCodecID id;
3228     /**
3229      * Codec capabilities.
3230      * see CODEC_CAP_*
3231      */
3232     int capabilities;
3233     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3234     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3235     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3236     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3237     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3238     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3239     const AVClass *priv_class;              ///< AVClass for the private context
3240     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3241
3242     /*****************************************************************
3243      * No fields below this line are part of the public API. They
3244      * may not be used outside of libavcodec and can be changed and
3245      * removed at will.
3246      * New public fields should be added right above.
3247      *****************************************************************
3248      */
3249     int priv_data_size;
3250     struct AVCodec *next;
3251     /**
3252      * @name Frame-level threading support functions
3253      * @{
3254      */
3255     /**
3256      * If defined, called on thread contexts when they are created.
3257      * If the codec allocates writable tables in init(), re-allocate them here.
3258      * priv_data will be set to a copy of the original.
3259      */
3260     int (*init_thread_copy)(AVCodecContext *);
3261     /**
3262      * Copy necessary context variables from a previous thread context to the current one.
3263      * If not defined, the next thread will start automatically; otherwise, the codec
3264      * must call ff_thread_finish_setup().
3265      *
3266      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3267      */
3268     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3269     /** @} */
3270
3271     /**
3272      * Private codec-specific defaults.
3273      */
3274     const AVCodecDefault *defaults;
3275
3276     /**
3277      * Initialize codec static data, called from avcodec_register().
3278      */
3279     void (*init_static_data)(struct AVCodec *codec);
3280
3281     int (*init)(AVCodecContext *);
3282     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3283                       const struct AVSubtitle *sub);
3284     /**
3285      * Encode data to an AVPacket.
3286      *
3287      * @param      avctx          codec context
3288      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3289      * @param[in]  frame          AVFrame containing the raw data to be encoded
3290      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3291      *                            non-empty packet was returned in avpkt.
3292      * @return 0 on success, negative error code on failure
3293      */
3294     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3295                    int *got_packet_ptr);
3296     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3297     int (*close)(AVCodecContext *);
3298     /**
3299      * Flush buffers.
3300      * Will be called when seeking
3301      */
3302     void (*flush)(AVCodecContext *);
3303 } AVCodec;
3304
3305 /**
3306  * AVHWAccel.
3307  */
3308 typedef struct AVHWAccel {
3309     /**
3310      * Name of the hardware accelerated codec.
3311      * The name is globally unique among encoders and among decoders (but an
3312      * encoder and a decoder can share the same name).
3313      */
3314     const char *name;
3315
3316     /**
3317      * Type of codec implemented by the hardware accelerator.
3318      *
3319      * See AVMEDIA_TYPE_xxx
3320      */
3321     enum AVMediaType type;
3322
3323     /**
3324      * Codec implemented by the hardware accelerator.
3325      *
3326      * See AV_CODEC_ID_xxx
3327      */
3328     enum AVCodecID id;
3329
3330     /**
3331      * Supported pixel format.
3332      *
3333      * Only hardware accelerated formats are supported here.
3334      */
3335     enum AVPixelFormat pix_fmt;
3336
3337     /**
3338      * Hardware accelerated codec capabilities.
3339      * see FF_HWACCEL_CODEC_CAP_*
3340      */
3341     int capabilities;
3342
3343     struct AVHWAccel *next;
3344
3345     /**
3346      * Called at the beginning of each frame or field picture.
3347      *
3348      * Meaningful frame information (codec specific) is guaranteed to
3349      * be parsed at this point. This function is mandatory.
3350      *
3351      * Note that buf can be NULL along with buf_size set to 0.
3352      * Otherwise, this means the whole frame is available at this point.
3353      *
3354      * @param avctx the codec context
3355      * @param buf the frame data buffer base
3356      * @param buf_size the size of the frame in bytes
3357      * @return zero if successful, a negative value otherwise
3358      */
3359     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3360
3361     /**
3362      * Callback for each slice.
3363      *
3364      * Meaningful slice information (codec specific) is guaranteed to
3365      * be parsed at this point. This function is mandatory.
3366      *
3367      * @param avctx the codec context
3368      * @param buf the slice data buffer base
3369      * @param buf_size the size of the slice in bytes
3370      * @return zero if successful, a negative value otherwise
3371      */
3372     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3373
3374     /**
3375      * Called at the end of each frame or field picture.
3376      *
3377      * The whole picture is parsed at this point and can now be sent
3378      * to the hardware accelerator. This function is mandatory.
3379      *
3380      * @param avctx the codec context
3381      * @return zero if successful, a negative value otherwise
3382      */
3383     int (*end_frame)(AVCodecContext *avctx);
3384
3385     /**
3386      * Size of HW accelerator private data.
3387      *
3388      * Private data is allocated with av_mallocz() before
3389      * AVCodecContext.get_buffer() and deallocated after
3390      * AVCodecContext.release_buffer().
3391      */
3392     int priv_data_size;
3393 } AVHWAccel;
3394
3395 /**
3396  * @defgroup lavc_picture AVPicture
3397  *
3398  * Functions for working with AVPicture
3399  * @{
3400  */
3401
3402 /**
3403  * four components are given, that's all.
3404  * the last component is alpha
3405  */
3406 typedef struct AVPicture {
3407     uint8_t *data[AV_NUM_DATA_POINTERS];
3408     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3409 } AVPicture;
3410
3411 /**
3412  * @}
3413  */
3414
3415 enum AVSubtitleType {
3416     SUBTITLE_NONE,
3417
3418     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3419
3420     /**
3421      * Plain text, the text field must be set by the decoder and is
3422      * authoritative. ass and pict fields may contain approximations.
3423      */
3424     SUBTITLE_TEXT,
3425
3426     /**
3427      * Formatted text, the ass field must be set by the decoder and is
3428      * authoritative. pict and text fields may contain approximations.
3429      */
3430     SUBTITLE_ASS,
3431 };
3432
3433 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3434
3435 typedef struct AVSubtitleRect {
3436     int x;         ///< top left corner  of pict, undefined when pict is not set
3437     int y;         ///< top left corner  of pict, undefined when pict is not set
3438     int w;         ///< width            of pict, undefined when pict is not set
3439     int h;         ///< height           of pict, undefined when pict is not set
3440     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3441
3442     /**
3443      * data+linesize for the bitmap of this subtitle.
3444      * can be set for text/ass as well once they where rendered
3445      */
3446     AVPicture pict;
3447     enum AVSubtitleType type;
3448
3449     char *text;                     ///< 0 terminated plain UTF-8 text
3450
3451     /**
3452      * 0 terminated ASS/SSA compatible event line.
3453      * The presentation of this is unaffected by the other values in this
3454      * struct.
3455      */
3456     char *ass;
3457
3458     int flags;
3459 } AVSubtitleRect;
3460
3461 typedef struct AVSubtitle {
3462     uint16_t format; /* 0 = graphics */
3463     uint32_t start_display_time; /* relative to packet pts, in ms */
3464     uint32_t end_display_time; /* relative to packet pts, in ms */
3465     unsigned num_rects;
3466     AVSubtitleRect **rects;
3467     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3468 } AVSubtitle;
3469
3470 /**
3471  * If c is NULL, returns the first registered codec,
3472  * if c is non-NULL, returns the next registered codec after c,
3473  * or NULL if c is the last one.
3474  */
3475 AVCodec *av_codec_next(const AVCodec *c);
3476
3477 /**
3478  * Return the LIBAVCODEC_VERSION_INT constant.
3479  */
3480 unsigned avcodec_version(void);
3481
3482 /**
3483  * Return the libavcodec build-time configuration.
3484  */
3485 const char *avcodec_configuration(void);
3486
3487 /**
3488  * Return the libavcodec license.
3489  */
3490 const char *avcodec_license(void);
3491
3492 /**
3493  * Register the codec codec and initialize libavcodec.
3494  *
3495  * @warning either this function or avcodec_register_all() must be called
3496  * before any other libavcodec functions.
3497  *
3498  * @see avcodec_register_all()
3499  */
3500 void avcodec_register(AVCodec *codec);
3501
3502 /**
3503  * Register all the codecs, parsers and bitstream filters which were enabled at
3504  * configuration time. If you do not call this function you can select exactly
3505  * which formats you want to support, by using the individual registration
3506  * functions.
3507  *
3508  * @see avcodec_register
3509  * @see av_register_codec_parser
3510  * @see av_register_bitstream_filter
3511  */
3512 void avcodec_register_all(void);
3513
3514
3515 #if FF_API_ALLOC_CONTEXT
3516 /**
3517  * Allocate an AVCodecContext and set its fields to default values.  The
3518  * resulting struct can be deallocated by simply calling av_free().
3519  *
3520  * @return An AVCodecContext filled with default values or NULL on failure.
3521  * @see avcodec_get_context_defaults
3522  *
3523  * @deprecated use avcodec_alloc_context3()
3524  */
3525 attribute_deprecated
3526 AVCodecContext *avcodec_alloc_context(void);
3527
3528 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3529  *  we WILL change its arguments and name a few times! */
3530 attribute_deprecated
3531 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3532
3533 /**
3534  * Set the fields of the given AVCodecContext to default values.
3535  *
3536  * @param s The AVCodecContext of which the fields should be set to default values.
3537  * @deprecated use avcodec_get_context_defaults3
3538  */
3539 attribute_deprecated
3540 void avcodec_get_context_defaults(AVCodecContext *s);
3541
3542 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3543  *  we WILL change its arguments and name a few times! */
3544 attribute_deprecated
3545 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3546 #endif
3547
3548 /**
3549  * Allocate an AVCodecContext and set its fields to default values.  The
3550  * resulting struct can be deallocated by calling avcodec_close() on it followed
3551  * by av_free().
3552  *
3553  * @param codec if non-NULL, allocate private data and initialize defaults
3554  *              for the given codec. It is illegal to then call avcodec_open2()
3555  *              with a different codec.
3556  *              If NULL, then the codec-specific defaults won't be initialized,
3557  *              which may result in suboptimal default settings (this is
3558  *              important mainly for encoders, e.g. libx264).
3559  *
3560  * @return An AVCodecContext filled with default values or NULL on failure.
3561  * @see avcodec_get_context_defaults
3562  */
3563 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3564
3565 /**
3566  * Set the fields of the given AVCodecContext to default values corresponding
3567  * to the given codec (defaults may be codec-dependent).
3568  *
3569  * Do not call this function if a non-NULL codec has been passed
3570  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3571  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3572  * different codec on this AVCodecContext.
3573  */
3574 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3575
3576 /**
3577  * Get the AVClass for AVCodecContext. It can be used in combination with
3578  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3579  *
3580  * @see av_opt_find().
3581  */
3582 const AVClass *avcodec_get_class(void);
3583
3584 /**
3585  * Get the AVClass for AVFrame. It can be used in combination with
3586  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3587  *
3588  * @see av_opt_find().
3589  */
3590 const AVClass *avcodec_get_frame_class(void);
3591
3592 /**
3593  * Get the AVClass for AVSubtitleRect. It can be used in combination with
3594  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3595  *
3596  * @see av_opt_find().
3597  */
3598 const AVClass *avcodec_get_subtitle_rect_class(void);
3599
3600 /**
3601  * Copy the settings of the source AVCodecContext into the destination
3602  * AVCodecContext. The resulting destination codec context will be
3603  * unopened, i.e. you are required to call avcodec_open2() before you
3604  * can use this AVCodecContext to decode/encode video/audio data.
3605  *
3606  * @param dest target codec context, should be initialized with
3607  *             avcodec_alloc_context3(), but otherwise uninitialized
3608  * @param src source codec context
3609  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3610  */
3611 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3612
3613 /**
3614  * Allocate an AVFrame and set its fields to default values.  The resulting
3615  * struct must be freed using avcodec_free_frame().
3616  *
3617  * @return An AVFrame filled with default values or NULL on failure.
3618  * @see avcodec_get_frame_defaults
3619  */
3620 AVFrame *avcodec_alloc_frame(void);
3621
3622 /**
3623  * Set the fields of the given AVFrame to default values.
3624  *
3625  * @param frame The AVFrame of which the fields should be set to default values.
3626  */
3627 void avcodec_get_frame_defaults(AVFrame *frame);
3628
3629 /**
3630  * Free the frame and any dynamically allocated objects in it,
3631  * e.g. extended_data.
3632  *
3633  * @param frame frame to be freed. The pointer will be set to NULL.
3634  *
3635  * @warning this function does NOT free the data buffers themselves
3636  * (it does not know how, since they might have been allocated with
3637  *  a custom get_buffer()).
3638  */
3639 void avcodec_free_frame(AVFrame **frame);
3640
3641 #if FF_API_AVCODEC_OPEN
3642 /**
3643  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3644  * function the context has to be allocated.
3645  *
3646  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3647  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3648  * retrieving a codec.
3649  *
3650  * @warning This function is not thread safe!
3651  *
3652  * @code
3653  * avcodec_register_all();
3654  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3655  * if (!codec)
3656  *     exit(1);
3657  *
3658  * context = avcodec_alloc_context3(codec);
3659  *
3660  * if (avcodec_open(context, codec) < 0)
3661  *     exit(1);
3662  * @endcode
3663  *
3664  * @param avctx The context which will be set up to use the given codec.
3665  * @param codec The codec to use within the context.
3666  * @return zero on success, a negative value on error
3667  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3668  *
3669  * @deprecated use avcodec_open2
3670  */
3671 attribute_deprecated
3672 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3673 #endif
3674
3675 /**
3676  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3677  * function the context has to be allocated with avcodec_alloc_context3().
3678  *
3679  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3680  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3681  * retrieving a codec.
3682  *
3683  * @warning This function is not thread safe!
3684  *
3685  * @code
3686  * avcodec_register_all();
3687  * av_dict_set(&opts, "b", "2.5M", 0);
3688  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3689  * if (!codec)
3690  *     exit(1);
3691  *
3692  * context = avcodec_alloc_context3(codec);
3693  *
3694  * if (avcodec_open2(context, codec, opts) < 0)
3695  *     exit(1);
3696  * @endcode
3697  *
3698  * @param avctx The context to initialize.
3699  * @param codec The codec to open this context for. If a non-NULL codec has been
3700  *              previously passed to avcodec_alloc_context3() or
3701  *              avcodec_get_context_defaults3() for this context, then this
3702  *              parameter MUST be either NULL or equal to the previously passed
3703  *              codec.
3704  * @param options A dictionary filled with AVCodecContext and codec-private options.
3705  *                On return this object will be filled with options that were not found.
3706  *
3707  * @return zero on success, a negative value on error
3708  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3709  *      av_dict_set(), av_opt_find().
3710  */
3711 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3712
3713 /**
3714  * Close a given AVCodecContext and free all the data associated with it
3715  * (but not the AVCodecContext itself).
3716  *
3717  * Calling this function on an AVCodecContext that hasn't been opened will free
3718  * the codec-specific data allocated in avcodec_alloc_context3() /
3719  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3720  * do nothing.
3721  */
3722 int avcodec_close(AVCodecContext *avctx);
3723
3724 /**
3725  * Free all allocated data in the given subtitle struct.
3726  *
3727  * @param sub AVSubtitle to free.
3728  */
3729 void avsubtitle_free(AVSubtitle *sub);
3730
3731 /**
3732  * @}
3733  */
3734
3735 /**
3736  * @addtogroup lavc_packet
3737  * @{
3738  */
3739
3740 /**
3741  * Default packet destructor.
3742  */
3743 void av_destruct_packet(AVPacket *pkt);
3744
3745 /**
3746  * Initialize optional fields of a packet with default values.
3747  *
3748  * Note, this does not touch the data and size members, which have to be
3749  * initialized separately.
3750  *
3751  * @param pkt packet
3752  */
3753 void av_init_packet(AVPacket *pkt);
3754
3755 /**
3756  * Allocate the payload of a packet and initialize its fields with
3757  * default values.
3758  *
3759  * @param pkt packet
3760  * @param size wanted payload size
3761  * @return 0 if OK, AVERROR_xxx otherwise
3762  */
3763 int av_new_packet(AVPacket *pkt, int size);
3764
3765 /**
3766  * Reduce packet size, correctly zeroing padding
3767  *
3768  * @param pkt packet
3769  * @param size new size
3770  */
3771 void av_shrink_packet(AVPacket *pkt, int size);
3772
3773 /**
3774  * Increase packet size, correctly zeroing padding
3775  *
3776  * @param pkt packet
3777  * @param grow_by number of bytes by which to increase the size of the packet
3778  */
3779 int av_grow_packet(AVPacket *pkt, int grow_by);
3780
3781 /**
3782  * @warning This is a hack - the packet memory allocation stuff is broken. The
3783  * packet is allocated if it was not really allocated.
3784  */
3785 int av_dup_packet(AVPacket *pkt);
3786
3787 /**
3788  * Copy packet, including contents
3789  *
3790  * @return 0 on success, negative AVERROR on fail
3791  */
3792 int av_copy_packet(AVPacket *dst, AVPacket *src);
3793
3794 /**
3795  * Free a packet.
3796  *
3797  * @param pkt packet to free
3798  */
3799 void av_free_packet(AVPacket *pkt);
3800
3801 /**
3802  * Allocate new information of a packet.
3803  *
3804  * @param pkt packet
3805  * @param type side information type
3806  * @param size side information size
3807  * @return pointer to fresh allocated data or NULL otherwise
3808  */
3809 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3810                                  int size);
3811
3812 /**
3813  * Shrink the already allocated side data buffer
3814  *
3815  * @param pkt packet
3816  * @param type side information type
3817  * @param size new side information size
3818  * @return 0 on success, < 0 on failure
3819  */
3820 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3821                                int size);
3822
3823 /**
3824  * Get side information from packet.
3825  *
3826  * @param pkt packet
3827  * @param type desired side information type
3828  * @param size pointer for side information size to store (optional)
3829  * @return pointer to data if present or NULL otherwise
3830  */
3831 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3832                                  int *size);
3833
3834 int av_packet_merge_side_data(AVPacket *pkt);
3835
3836 int av_packet_split_side_data(AVPacket *pkt);
3837
3838
3839 /**
3840  * @}
3841  */
3842
3843 /**
3844  * @addtogroup lavc_decoding
3845  * @{
3846  */
3847
3848 /**
3849  * Find a registered decoder with a matching codec ID.
3850  *
3851  * @param id AVCodecID of the requested decoder
3852  * @return A decoder if one was found, NULL otherwise.
3853  */
3854 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3855
3856 /**
3857  * Find a registered decoder with the specified name.
3858  *
3859  * @param name name of the requested decoder
3860  * @return A decoder if one was found, NULL otherwise.
3861  */
3862 AVCodec *avcodec_find_decoder_by_name(const char *name);
3863
3864 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3865 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3866 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3867
3868 /**
3869  * Return the amount of padding in pixels which the get_buffer callback must
3870  * provide around the edge of the image for codecs which do not have the
3871  * CODEC_FLAG_EMU_EDGE flag.
3872  *
3873  * @return Required padding in pixels.
3874  */
3875 unsigned avcodec_get_edge_width(void);
3876
3877 /**
3878  * Modify width and height values so that they will result in a memory
3879  * buffer that is acceptable for the codec if you do not use any horizontal
3880  * padding.
3881  *
3882  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3883  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3884  * according to avcodec_get_edge_width() before.
3885  */
3886 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3887
3888 /**
3889  * Modify width and height values so that they will result in a memory
3890  * buffer that is acceptable for the codec if you also ensure that all
3891  * line sizes are a multiple of the respective linesize_align[i].
3892  *
3893  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3894  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3895  * according to avcodec_get_edge_width() before.
3896  */
3897 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3898                                int linesize_align[AV_NUM_DATA_POINTERS]);
3899
3900 #if FF_API_OLD_DECODE_AUDIO
3901 /**
3902  * Wrapper function which calls avcodec_decode_audio4.
3903  *
3904  * @deprecated Use avcodec_decode_audio4 instead.
3905  *
3906  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3907  * Some decoders may support multiple frames in a single AVPacket, such
3908  * decoders would then just decode the first frame. In this case,
3909  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3910  * the remaining data in order to decode the second frame etc.
3911  * If no frame
3912  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3913  * decompressed frame size in bytes.
3914  *
3915  * @warning You must set frame_size_ptr to the allocated size of the
3916  * output buffer before calling avcodec_decode_audio3().
3917  *
3918  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3919  * the actual read bytes because some optimized bitstream readers read 32 or 64
3920  * bits at once and could read over the end.
3921  *
3922  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3923  * no overreading happens for damaged MPEG streams.
3924  *
3925  * @warning You must not provide a custom get_buffer() when using
3926  * avcodec_decode_audio3().  Doing so will override it with
3927  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,
3928  * which does allow the application to provide a custom get_buffer().
3929  *
3930  * @note You might have to align the input buffer avpkt->data and output buffer
3931  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3932  * necessary at all, on others it won't work at all if not aligned and on others
3933  * it will work but it will have an impact on performance.
3934  *
3935  * In practice, avpkt->data should have 4 byte alignment at minimum and
3936  * samples should be 16 byte aligned unless the CPU doesn't need it
3937  * (AltiVec and SSE do).
3938  *
3939  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3940  * between input and output, these need to be fed with avpkt->data=NULL,
3941  * avpkt->size=0 at the end to return the remaining frames.
3942  *
3943  * @param avctx the codec context
3944  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3945  *                     If the sample format is planar, each channel plane will
3946  *                     be the same size, with no padding between channels.
3947  * @param[in,out] frame_size_ptr the output buffer size in bytes
3948  * @param[in] avpkt The input AVPacket containing the input buffer.
3949  *            You can create such packet with av_init_packet() and by then setting
3950  *            data and size, some decoders might in addition need other fields.
3951  *            All decoders are designed to use the least fields possible though.
3952  * @return On error a negative value is returned, otherwise the number of bytes
3953  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3954  */
3955 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3956                          int *frame_size_ptr,
3957                          AVPacket *avpkt);
3958 #endif
3959
3960 /**
3961  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3962  *
3963  * Some decoders may support multiple frames in a single AVPacket. Such
3964  * decoders would then just decode the first frame. In this case,
3965  * avcodec_decode_audio4 has to be called again with an AVPacket containing
3966  * the remaining data in order to decode the second frame, etc...
3967  * Even if no frames are returned, the packet needs to be fed to the decoder
3968  * with remaining data until it is completely consumed or an error occurs.
3969  *
3970  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3971  *          larger than the actual read bytes because some optimized bitstream
3972  *          readers read 32 or 64 bits at once and could read over the end.
3973  *
3974  * @note You might have to align the input buffer. The alignment requirements
3975  *       depend on the CPU and the decoder.
3976  *
3977  * @param      avctx the codec context
3978  * @param[out] frame The AVFrame in which to store decoded audio samples.
3979  *                   Decoders request a buffer of a particular size by setting
3980  *                   AVFrame.nb_samples prior to calling get_buffer(). The
3981  *                   decoder may, however, only utilize part of the buffer by
3982  *                   setting AVFrame.nb_samples to a smaller value in the
3983  *                   output frame.
3984  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3985  *                           non-zero.
3986  * @param[in]  avpkt The input AVPacket containing the input buffer.
3987  *                   At least avpkt->data and avpkt->size should be set. Some
3988  *                   decoders might also require additional fields to be set.
3989  * @return A negative error code is returned if an error occurred during
3990  *         decoding, otherwise the number of bytes consumed from the input
3991  *         AVPacket is returned.
3992  */
3993 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3994                           int *got_frame_ptr, const AVPacket *avpkt);
3995
3996 /**
3997  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3998  * Some decoders may support multiple frames in a single AVPacket, such
3999  * decoders would then just decode the first frame.
4000  *
4001  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4002  * the actual read bytes because some optimized bitstream readers read 32 or 64
4003  * bits at once and could read over the end.
4004  *
4005  * @warning The end of the input buffer buf should be set to 0 to ensure that
4006  * no overreading happens for damaged MPEG streams.
4007  *
4008  * @note You might have to align the input buffer avpkt->data.
4009  * The alignment requirements depend on the CPU: on some CPUs it isn't
4010  * necessary at all, on others it won't work at all if not aligned and on others
4011  * it will work but it will have an impact on performance.
4012  *
4013  * In practice, avpkt->data should have 4 byte alignment at minimum.
4014  *
4015  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4016  * between input and output, these need to be fed with avpkt->data=NULL,
4017  * avpkt->size=0 at the end to return the remaining frames.
4018  *
4019  * @param avctx the codec context
4020  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4021  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
4022  *             allocate memory for the actual bitmap.
4023  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4024  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4025  *                   decodes and the decoder tells the user once it does not need the data anymore,
4026  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
4027  *
4028  * @param[in] avpkt The input AVpacket containing the input buffer.
4029  *            You can create such packet with av_init_packet() and by then setting
4030  *            data and size, some decoders might in addition need other fields like
4031  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4032  *            fields possible.
4033  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4034  * @return On error a negative value is returned, otherwise the number of bytes
4035  * used or zero if no frame could be decompressed.
4036  */
4037 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4038                          int *got_picture_ptr,
4039                          const AVPacket *avpkt);
4040
4041 /**
4042  * Decode a subtitle message.
4043  * Return a negative value on error, otherwise return the number of bytes used.
4044  * If no subtitle could be decompressed, got_sub_ptr is zero.
4045  * Otherwise, the subtitle is stored in *sub.
4046  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4047  * simplicity, because the performance difference is expect to be negligible
4048  * and reusing a get_buffer written for video codecs would probably perform badly
4049  * due to a potentially very different allocation pattern.
4050  *
4051  * @param avctx the codec context
4052  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4053                    freed with avsubtitle_free if *got_sub_ptr is set.
4054  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4055  * @param[in] avpkt The input AVPacket containing the input buffer.
4056  */
4057 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4058                             int *got_sub_ptr,
4059                             AVPacket *avpkt);
4060
4061 /**
4062  * @defgroup lavc_parsing Frame parsing
4063  * @{
4064  */
4065
4066 typedef struct AVCodecParserContext {
4067     void *priv_data;
4068     struct AVCodecParser *parser;
4069     int64_t frame_offset; /* offset of the current frame */
4070     int64_t cur_offset; /* current offset
4071                            (incremented by each av_parser_parse()) */
4072     int64_t next_frame_offset; /* offset of the next frame */
4073     /* video info */
4074     int pict_type; /* XXX: Put it back in AVCodecContext. */
4075     /**
4076      * This field is used for proper frame duration computation in lavf.
4077      * It signals, how much longer the frame duration of the current frame
4078      * is compared to normal frame duration.
4079      *
4080      * frame_duration = (1 + repeat_pict) * time_base
4081      *
4082      * It is used by codecs like H.264 to display telecined material.
4083      */
4084     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4085     int64_t pts;     /* pts of the current frame */
4086     int64_t dts;     /* dts of the current frame */
4087
4088     /* private data */
4089     int64_t last_pts;
4090     int64_t last_dts;
4091     int fetch_timestamp;
4092
4093 #define AV_PARSER_PTS_NB 4
4094     int cur_frame_start_index;
4095     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4096     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4097     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4098
4099     int flags;
4100 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4101 #define PARSER_FLAG_ONCE                      0x0002
4102 /// Set if the parser has a valid file offset
4103 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4104 #define PARSER_FLAG_USE_CODEC_TS              0x1000
4105
4106     int64_t offset;      ///< byte offset from starting packet start
4107     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4108
4109     /**
4110      * Set by parser to 1 for key frames and 0 for non-key frames.
4111      * It is initialized to -1, so if the parser doesn't set this flag,
4112      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4113      * will be used.
4114      */
4115     int key_frame;
4116
4117     /**
4118      * Time difference in stream time base units from the pts of this
4119      * packet to the point at which the output from the decoder has converged
4120      * independent from the availability of previous frames. That is, the
4121      * frames are virtually identical no matter if decoding started from
4122      * the very first frame or from this keyframe.
4123      * Is AV_NOPTS_VALUE if unknown.
4124      * This field is not the display duration of the current frame.
4125      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4126      * set.
4127      *
4128      * The purpose of this field is to allow seeking in streams that have no
4129      * keyframes in the conventional sense. It corresponds to the
4130      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4131      * essential for some types of subtitle streams to ensure that all
4132      * subtitles are correctly displayed after seeking.
4133      */
4134     int64_t convergence_duration;
4135
4136     // Timestamp generation support:
4137     /**
4138      * Synchronization point for start of timestamp generation.
4139      *
4140      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4141      * (default).
4142      *
4143      * For example, this corresponds to presence of H.264 buffering period
4144      * SEI message.
4145      */
4146     int dts_sync_point;
4147
4148     /**
4149      * Offset of the current timestamp against last timestamp sync point in
4150      * units of AVCodecContext.time_base.
4151      *
4152      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4153      * contain a valid timestamp offset.
4154      *
4155      * Note that the timestamp of sync point has usually a nonzero
4156      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4157      * the next frame after timestamp sync point will be usually 1.
4158      *
4159      * For example, this corresponds to H.264 cpb_removal_delay.
4160      */
4161     int dts_ref_dts_delta;
4162
4163     /**
4164      * Presentation delay of current frame in units of AVCodecContext.time_base.
4165      *
4166      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4167      * contain valid non-negative timestamp delta (presentation time of a frame
4168      * must not lie in the past).
4169      *
4170      * This delay represents the difference between decoding and presentation
4171      * time of the frame.
4172      *
4173      * For example, this corresponds to H.264 dpb_output_delay.
4174      */
4175     int pts_dts_delta;
4176
4177     /**
4178      * Position of the packet in file.
4179      *
4180      * Analogous to cur_frame_pts/dts
4181      */
4182     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4183
4184     /**
4185      * Byte position of currently parsed frame in stream.
4186      */
4187     int64_t pos;
4188
4189     /**
4190      * Previous frame byte position.
4191      */
4192     int64_t last_pos;
4193
4194     /**
4195      * Duration of the current frame.
4196      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4197      * For all other types, this is in units of AVCodecContext.time_base.
4198      */
4199     int duration;
4200 } AVCodecParserContext;
4201
4202 typedef struct AVCodecParser {
4203     int codec_ids[5]; /* several codec IDs are permitted */
4204     int priv_data_size;
4205     int (*parser_init)(AVCodecParserContext *s);
4206     int (*parser_parse)(AVCodecParserContext *s,
4207                         AVCodecContext *avctx,
4208                         const uint8_t **poutbuf, int *poutbuf_size,
4209                         const uint8_t *buf, int buf_size);
4210     void (*parser_close)(AVCodecParserContext *s);
4211     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4212     struct AVCodecParser *next;
4213 } AVCodecParser;
4214
4215 AVCodecParser *av_parser_next(AVCodecParser *c);
4216
4217 void av_register_codec_parser(AVCodecParser *parser);
4218 AVCodecParserContext *av_parser_init(int codec_id);
4219
4220 /**
4221  * Parse a packet.
4222  *
4223  * @param s             parser context.
4224  * @param avctx         codec context.
4225  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4226  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4227  * @param buf           input buffer.
4228  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4229  * @param pts           input presentation timestamp.
4230  * @param dts           input decoding timestamp.
4231  * @param pos           input byte position in stream.
4232  * @return the number of bytes of the input bitstream used.
4233  *
4234  * Example:
4235  * @code
4236  *   while(in_len){
4237  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4238  *                                        in_data, in_len,
4239  *                                        pts, dts, pos);
4240  *       in_data += len;
4241  *       in_len  -= len;
4242  *
4243  *       if(size)
4244  *          decode_frame(data, size);
4245  *   }
4246  * @endcode
4247  */
4248 int av_parser_parse2(AVCodecParserContext *s,
4249                      AVCodecContext *avctx,
4250                      uint8_t **poutbuf, int *poutbuf_size,
4251                      const uint8_t *buf, int buf_size,
4252                      int64_t pts, int64_t dts,
4253                      int64_t pos);
4254
4255 /**
4256  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4257  * @deprecated use AVBitstreamFilter
4258  */
4259 int av_parser_change(AVCodecParserContext *s,
4260                      AVCodecContext *avctx,
4261                      uint8_t **poutbuf, int *poutbuf_size,
4262                      const uint8_t *buf, int buf_size, int keyframe);
4263 void av_parser_close(AVCodecParserContext *s);
4264
4265 /**
4266  * @}
4267  * @}
4268  */
4269
4270 /**
4271  * @addtogroup lavc_encoding
4272  * @{
4273  */
4274
4275 /**
4276  * Find a registered encoder with a matching codec ID.
4277  *
4278  * @param id AVCodecID of the requested encoder
4279  * @return An encoder if one was found, NULL otherwise.
4280  */
4281 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4282
4283 /**
4284  * Find a registered encoder with the specified name.
4285  *
4286  * @param name name of the requested encoder
4287  * @return An encoder if one was found, NULL otherwise.
4288  */
4289 AVCodec *avcodec_find_encoder_by_name(const char *name);
4290
4291 #if FF_API_OLD_ENCODE_AUDIO
4292 /**
4293  * Encode an audio frame from samples into buf.
4294  *
4295  * @deprecated Use avcodec_encode_audio2 instead.
4296  *
4297  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4298  * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4299  * will know how much space is needed because it depends on the value passed
4300  * in buf_size as described below. In that case a lower value can be used.
4301  *
4302  * @param avctx the codec context
4303  * @param[out] buf the output buffer
4304  * @param[in] buf_size the output buffer size
4305  * @param[in] samples the input buffer containing the samples
4306  * The number of samples read from this buffer is frame_size*channels,
4307  * both of which are defined in avctx.
4308  * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4309  * samples read from samples is equal to:
4310  * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4311  * This also implies that av_get_bits_per_sample() must not return 0 for these
4312  * codecs.
4313  * @return On error a negative value is returned, on success zero or the number
4314  * of bytes used to encode the data read from the input buffer.
4315  */
4316 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4317                                               uint8_t *buf, int buf_size,
4318                                               const short *samples);
4319 #endif
4320
4321 /**
4322  * Encode a frame of audio.
4323  *
4324  * Takes input samples from frame and writes the next output packet, if
4325  * available, to avpkt. The output packet does not necessarily contain data for
4326  * the most recent frame, as encoders can delay, split, and combine input frames
4327  * internally as needed.
4328  *
4329  * @param avctx     codec context
4330  * @param avpkt     output AVPacket.
4331  *                  The user can supply an output buffer by setting
4332  *                  avpkt->data and avpkt->size prior to calling the
4333  *                  function, but if the size of the user-provided data is not
4334  *                  large enough, encoding will fail. If avpkt->data and
4335  *                  avpkt->size are set, avpkt->destruct must also be set. All
4336  *                  other AVPacket fields will be reset by the encoder using
4337  *                  av_init_packet(). If avpkt->data is NULL, the encoder will
4338  *                  allocate it. The encoder will set avpkt->size to the size
4339  *                  of the output packet.
4340  *
4341  *                  If this function fails or produces no output, avpkt will be
4342  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
4343  *                  called to free the user supplied buffer).
4344  * @param[in] frame AVFrame containing the raw audio data to be encoded.
4345  *                  May be NULL when flushing an encoder that has the
4346  *                  CODEC_CAP_DELAY capability set.
4347  *                  If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4348  *                  can have any number of samples.
4349  *                  If it is not set, frame->nb_samples must be equal to
4350  *                  avctx->frame_size for all frames except the last.
4351  *                  The final frame may be smaller than avctx->frame_size.
4352  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4353  *                            output packet is non-empty, and to 0 if it is
4354  *                            empty. If the function returns an error, the
4355  *                            packet can be assumed to be invalid, and the
4356  *                            value of got_packet_ptr is undefined and should
4357  *                            not be used.
4358  * @return          0 on success, negative error code on failure
4359  */
4360 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4361                           const AVFrame *frame, int *got_packet_ptr);
4362
4363 #if FF_API_OLD_ENCODE_VIDEO
4364 /**
4365  * @deprecated use avcodec_encode_video2() instead.
4366  *
4367  * Encode a video frame from pict into buf.
4368  * The input picture should be
4369  * stored using a specific format, namely avctx.pix_fmt.
4370  *
4371  * @param avctx the codec context
4372  * @param[out] buf the output buffer for the bitstream of encoded frame
4373  * @param[in] buf_size the size of the output buffer in bytes
4374  * @param[in] pict the input picture to encode
4375  * @return On error a negative value is returned, on success zero or the number
4376  * of bytes used from the output buffer.
4377  */
4378 attribute_deprecated
4379 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4380                          const AVFrame *pict);
4381 #endif
4382
4383 /**
4384  * Encode a frame of video.
4385  *
4386  * Takes input raw video data from frame and writes the next output packet, if
4387  * available, to avpkt. The output packet does not necessarily contain data for
4388  * the most recent frame, as encoders can delay and reorder input frames
4389  * internally as needed.
4390  *
4391  * @param avctx     codec context
4392  * @param avpkt     output AVPacket.
4393  *                  The user can supply an output buffer by setting
4394  *                  avpkt->data and avpkt->size prior to calling the
4395  *                  function, but if the size of the user-provided data is not
4396  *                  large enough, encoding will fail. All other AVPacket fields
4397  *                  will be reset by the encoder using av_init_packet(). If
4398  *                  avpkt->data is NULL, the encoder will allocate it.
4399  *                  The encoder will set avpkt->size to the size of the
4400  *                  output packet. The returned data (if any) belongs to the
4401  *                  caller, he is responsible for freeing it.
4402  *
4403  *                  If this function fails or produces no output, avpkt will be
4404  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
4405  *                  called to free the user supplied buffer).
4406  * @param[in] frame AVFrame containing the raw video data to be encoded.
4407  *                  May be NULL when flushing an encoder that has the
4408  *                  CODEC_CAP_DELAY capability set.
4409  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4410  *                            output packet is non-empty, and to 0 if it is
4411  *                            empty. If the function returns an error, the
4412  *                            packet can be assumed to be invalid, and the
4413  *                            value of got_packet_ptr is undefined and should
4414  *                            not be used.
4415  * @return          0 on success, negative error code on failure
4416  */
4417 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4418                           const AVFrame *frame, int *got_packet_ptr);
4419
4420 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4421                             const AVSubtitle *sub);
4422
4423
4424 /**
4425  * @}
4426  */
4427
4428 #if FF_API_AVCODEC_RESAMPLE
4429 /**
4430  * @defgroup lavc_resample Audio resampling
4431  * @ingroup libavc
4432  * @deprecated use libswresample instead
4433  *
4434  * @{
4435  */
4436 struct ReSampleContext;
4437 struct AVResampleContext;
4438
4439 typedef struct ReSampleContext ReSampleContext;
4440
4441 /**
4442  *  Initialize audio resampling context.
4443  *
4444  * @param output_channels  number of output channels
4445  * @param input_channels   number of input channels
4446  * @param output_rate      output sample rate
4447  * @param input_rate       input sample rate
4448  * @param sample_fmt_out   requested output sample format
4449  * @param sample_fmt_in    input sample format
4450  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
4451  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4452  * @param linear           if 1 then the used FIR filter will be linearly interpolated
4453                            between the 2 closest, if 0 the closest will be used
4454  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
4455  * @return allocated ReSampleContext, NULL if error occurred
4456  */
4457 attribute_deprecated
4458 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4459                                         int output_rate, int input_rate,
4460                                         enum AVSampleFormat sample_fmt_out,
4461                                         enum AVSampleFormat sample_fmt_in,
4462                                         int filter_length, int log2_phase_count,
4463                                         int linear, double cutoff);
4464
4465 attribute_deprecated
4466 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4467
4468 /**
4469  * Free resample context.
4470  *
4471  * @param s a non-NULL pointer to a resample context previously
4472  *          created with av_audio_resample_init()
4473  */
4474 attribute_deprecated
4475 void audio_resample_close(ReSampleContext *s);
4476
4477
4478 /**
4479  * Initialize an audio resampler.
4480  * Note, if either rate is not an integer then simply scale both rates up so they are.
4481  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4482  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4483  * @param linear If 1 then the used FIR filter will be linearly interpolated
4484                  between the 2 closest, if 0 the closest will be used
4485  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4486  */
4487 attribute_deprecated
4488 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4489
4490 /**
4491  * Resample an array of samples using a previously configured context.
4492  * @param src an array of unconsumed samples
4493  * @param consumed the number of samples of src which have been consumed are returned here
4494  * @param src_size the number of unconsumed samples available
4495  * @param dst_size the amount of space in samples available in dst
4496  * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4497  * @return the number of samples written in dst or -1 if an error occurred
4498  */
4499 attribute_deprecated
4500 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4501
4502
4503 /**
4504  * Compensate samplerate/timestamp drift. The compensation is done by changing
4505  * the resampler parameters, so no audible clicks or similar distortions occur
4506  * @param compensation_distance distance in output samples over which the compensation should be performed
4507  * @param sample_delta number of output samples which should be output less
4508  *
4509  * example: av_resample_compensate(c, 10, 500)
4510  * here instead of 510 samples only 500 samples would be output
4511  *
4512  * note, due to rounding the actual compensation might be slightly different,
4513  * especially if the compensation_distance is large and the in_rate used during init is small
4514  */
4515 attribute_deprecated
4516 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4517 attribute_deprecated
4518 void av_resample_close(struct AVResampleContext *c);
4519
4520 /**
4521  * @}
4522  */
4523 #endif
4524
4525 /**
4526  * @addtogroup lavc_picture
4527  * @{
4528  */
4529
4530 /**
4531  * Allocate memory for a picture.  Call avpicture_free() to free it.
4532  *
4533  * @see avpicture_fill()
4534  *
4535  * @param picture the picture to be filled in
4536  * @param pix_fmt the format of the picture
4537  * @param width the width of the picture
4538  * @param height the height of the picture
4539  * @return zero if successful, a negative value if not
4540  */
4541 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4542
4543 /**
4544  * Free a picture previously allocated by avpicture_alloc().
4545  * The data buffer used by the AVPicture is freed, but the AVPicture structure
4546  * itself is not.
4547  *
4548  * @param picture the AVPicture to be freed
4549  */
4550 void avpicture_free(AVPicture *picture);
4551
4552 /**
4553  * Fill in the AVPicture fields, always assume a linesize alignment of
4554  * 1.
4555  *
4556  * @see av_image_fill_arrays()
4557  */
4558 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4559                    enum AVPixelFormat pix_fmt, int width, int height);
4560
4561 /**
4562  * Copy pixel data from an AVPicture into a buffer, always assume a
4563  * linesize alignment of 1.
4564  *
4565  * @see av_image_copy_to_buffer()
4566  */
4567 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4568                      int width, int height,
4569                      unsigned char *dest, int dest_size);
4570
4571 /**
4572  * Calculate the size in bytes that a picture of the given width and height
4573  * would occupy if stored in the given picture format.
4574  * Always assume a linesize alignment of 1.
4575  *
4576  * @see av_image_get_buffer_size().
4577  */
4578 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4579
4580 /**
4581  *  deinterlace - if not supported return -1
4582  */
4583 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4584                           enum AVPixelFormat pix_fmt, int width, int height);
4585 /**
4586  * Copy image src to dst. Wraps av_image_copy().
4587  */
4588 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4589                      enum AVPixelFormat pix_fmt, int width, int height);
4590
4591 /**
4592  * Crop image top and left side.
4593  */
4594 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4595                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
4596
4597 /**
4598  * Pad image.
4599  */
4600 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4601             int padtop, int padbottom, int padleft, int padright, int *color);
4602
4603 /**
4604  * @}
4605  */
4606
4607 /**
4608  * @defgroup lavc_misc Utility functions
4609  * @ingroup libavc
4610  *
4611  * Miscellaneous utility functions related to both encoding and decoding
4612  * (or neither).
4613  * @{
4614  */
4615
4616 /**
4617  * @defgroup lavc_misc_pixfmt Pixel formats
4618  *
4619  * Functions for working with pixel formats.
4620  * @{
4621  */
4622
4623 /**
4624  * Utility function to access log2_chroma_w log2_chroma_h from
4625  * the pixel format AVPixFmtDescriptor.
4626  *
4627  * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4628  * for one that returns a failure code and continues in case of invalid
4629  * pix_fmts.
4630  *
4631  * @param[in]  pix_fmt the pixel format
4632  * @param[out] h_shift store log2_chroma_h
4633  * @param[out] v_shift store log2_chroma_w
4634  *
4635  * @see av_pix_fmt_get_chroma_sub_sample
4636  */
4637
4638 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4639
4640 /**
4641  * Return a value representing the fourCC code associated to the
4642  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4643  * found.
4644  */
4645 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4646
4647 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
4648 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
4649 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
4650 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
4651 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
4652 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4653
4654 /**
4655  * Compute what kind of losses will occur when converting from one specific
4656  * pixel format to another.
4657  * When converting from one pixel format to another, information loss may occur.
4658  * For example, when converting from RGB24 to GRAY, the color information will
4659  * be lost. Similarly, other losses occur when converting from some formats to
4660  * other formats. These losses can involve loss of chroma, but also loss of
4661  * resolution, loss of color depth, loss due to the color space conversion, loss
4662  * of the alpha bits or loss due to color quantization.
4663  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4664  * which will occur when converting from one pixel format to another.
4665  *
4666  * @param[in] dst_pix_fmt destination pixel format
4667  * @param[in] src_pix_fmt source pixel format
4668  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4669  * @return Combination of flags informing you what kind of losses will occur
4670  * (maximum loss for an invalid dst_pix_fmt).
4671  */
4672 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4673                              int has_alpha);
4674
4675 #if FF_API_FIND_BEST_PIX_FMT
4676 /**
4677  * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4678  *
4679  * Find the best pixel format to convert to given a certain source pixel
4680  * format.  When converting from one pixel format to another, information loss
4681  * may occur.  For example, when converting from RGB24 to GRAY, the color
4682  * information will be lost. Similarly, other losses occur when converting from
4683  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4684  * the given pixel formats should be used to suffer the least amount of loss.
4685  * The pixel formats from which it chooses one, are determined by the
4686  * pix_fmt_mask parameter.
4687  *
4688  * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4689  *
4690  * @code
4691  * src_pix_fmt = AV_PIX_FMT_YUV420P;
4692  * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4693  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4694  * @endcode
4695  *
4696  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4697  * @param[in] src_pix_fmt source pixel format
4698  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4699  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4700  * @return The best pixel format to convert to or -1 if none was found.
4701  */
4702 attribute_deprecated
4703 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4704                               int has_alpha, int *loss_ptr);
4705 #endif /* FF_API_FIND_BEST_PIX_FMT */
4706
4707 /**
4708  * Find the best pixel format to convert to given a certain source pixel
4709  * format.  When converting from one pixel format to another, information loss
4710  * may occur.  For example, when converting from RGB24 to GRAY, the color
4711  * information will be lost. Similarly, other losses occur when converting from
4712  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4713  * the given pixel formats should be used to suffer the least amount of loss.
4714  * The pixel formats from which it chooses one, are determined by the
4715  * pix_fmt_list parameter.
4716  *
4717  *
4718  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4719  * @param[in] src_pix_fmt source pixel format
4720  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4721  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4722  * @return The best pixel format to convert to or -1 if none was found.
4723  */
4724 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4725                                             enum AVPixelFormat src_pix_fmt,
4726                                             int has_alpha, int *loss_ptr);
4727
4728 /**
4729  * Find the best pixel format to convert to given a certain source pixel
4730  * format and a selection of two destination pixel formats. When converting from
4731  * one pixel format to another, information loss may occur.  For example, when converting
4732  * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4733  * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4734  * the given pixel formats should be used to suffer the least amount of loss.
4735  *
4736  * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4737  * returned.
4738  *
4739  * @code
4740  * src_pix_fmt = AV_PIX_FMT_YUV420P;
4741  * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4742  * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4743  * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4744  * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4745  * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4746  * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4747  * @endcode
4748  *
4749  * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4750  * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4751  * @param[in] src_pix_fmt Source pixel format
4752  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4753  * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4754  *                               NULL or value of zero means we care about all losses. Out: the loss
4755  *                               that occurs when converting from src to selected dst pixel format.
4756  * @return The best pixel format to convert to or -1 if none was found.
4757  */
4758 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4759                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4760
4761 attribute_deprecated
4762 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4763 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4764                                               enum AVPixelFormat src_pix_fmt,
4765                                               int has_alpha, int *loss_ptr);
4766 #else
4767 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4768                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4769 #endif
4770
4771
4772 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4773
4774 /**
4775  * @}
4776  */
4777
4778 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4779
4780 /**
4781  * Put a string representing the codec tag codec_tag in buf.
4782  *
4783  * @param buf_size size in bytes of buf
4784  * @return the length of the string that would have been generated if
4785  * enough space had been available, excluding the trailing null
4786  */
4787 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4788
4789 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4790
4791 /**
4792  * Return a name for the specified profile, if available.
4793  *
4794  * @param codec the codec that is searched for the given profile
4795  * @param profile the profile value for which a name is requested
4796  * @return A name for the profile if found, NULL otherwise.
4797  */
4798 const char *av_get_profile_name(const AVCodec *codec, int profile);
4799
4800 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4801 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4802 //FIXME func typedef
4803
4804 /**
4805  * Fill AVFrame audio data and linesize pointers.
4806  *
4807  * The buffer buf must be a preallocated buffer with a size big enough
4808  * to contain the specified samples amount. The filled AVFrame data
4809  * pointers will point to this buffer.
4810  *
4811  * AVFrame extended_data channel pointers are allocated if necessary for
4812  * planar audio.
4813  *
4814  * @param frame       the AVFrame
4815  *                    frame->nb_samples must be set prior to calling the
4816  *                    function. This function fills in frame->data,
4817  *                    frame->extended_data, frame->linesize[0].
4818  * @param nb_channels channel count
4819  * @param sample_fmt  sample format
4820  * @param buf         buffer to use for frame data
4821  * @param buf_size    size of buffer
4822  * @param align       plane size sample alignment (0 = default)
4823  * @return            >=0 on success, negative error code on failure
4824  * @todo return the size in bytes required to store the samples in
4825  * case of success, at the next libavutil bump
4826  */
4827 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4828                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4829                              int buf_size, int align);
4830
4831 /**
4832  * Flush buffers, should be called when seeking or when switching to a different stream.
4833  */
4834 void avcodec_flush_buffers(AVCodecContext *avctx);
4835
4836 void avcodec_default_free_buffers(AVCodecContext *s);
4837
4838 /**
4839  * Return codec bits per sample.
4840  *
4841  * @param[in] codec_id the codec
4842  * @return Number of bits per sample or zero if unknown for the given codec.
4843  */
4844 int av_get_bits_per_sample(enum AVCodecID codec_id);
4845
4846 /**
4847  * Return the PCM codec associated with a sample format.
4848  * @param be  endianness, 0 for little, 1 for big,
4849  *            -1 (or anything else) for native
4850  * @return  AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4851  */
4852 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4853
4854 /**
4855  * Return codec bits per sample.
4856  * Only return non-zero if the bits per sample is exactly correct, not an
4857  * approximation.
4858  *
4859  * @param[in] codec_id the codec
4860  * @return Number of bits per sample or zero if unknown for the given codec.
4861  */
4862 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4863
4864 /**
4865  * Return audio frame duration.
4866  *
4867  * @param avctx        codec context
4868  * @param frame_bytes  size of the frame, or 0 if unknown
4869  * @return             frame duration, in samples, if known. 0 if not able to
4870  *                     determine.
4871  */
4872 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4873
4874
4875 typedef struct AVBitStreamFilterContext {
4876     void *priv_data;
4877     struct AVBitStreamFilter *filter;
4878     AVCodecParserContext *parser;
4879     struct AVBitStreamFilterContext *next;
4880 } AVBitStreamFilterContext;
4881
4882
4883 typedef struct AVBitStreamFilter {
4884     const char *name;
4885     int priv_data_size;
4886     int (*filter)(AVBitStreamFilterContext *bsfc,
4887                   AVCodecContext *avctx, const char *args,
4888                   uint8_t **poutbuf, int *poutbuf_size,
4889                   const uint8_t *buf, int buf_size, int keyframe);
4890     void (*close)(AVBitStreamFilterContext *bsfc);
4891     struct AVBitStreamFilter *next;
4892 } AVBitStreamFilter;
4893
4894 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4895 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4896 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4897                                AVCodecContext *avctx, const char *args,
4898                                uint8_t **poutbuf, int *poutbuf_size,
4899                                const uint8_t *buf, int buf_size, int keyframe);
4900 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4901
4902 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4903
4904 /* memory */
4905
4906 /**
4907  * Reallocate the given block if it is not large enough, otherwise do nothing.
4908  *
4909  * @see av_realloc
4910  */
4911 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4912
4913 /**
4914  * Allocate a buffer, reusing the given one if large enough.
4915  *
4916  * Contrary to av_fast_realloc the current buffer contents might not be
4917  * preserved and on error the old buffer is freed, thus no special
4918  * handling to avoid memleaks is necessary.
4919  *
4920  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4921  * @param size size of the buffer *ptr points to
4922  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4923  *                 *size 0 if an error occurred.
4924  */
4925 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4926
4927 /**
4928  * Same behaviour av_fast_malloc but the buffer has additional
4929  * FF_INPUT_BUFFER_PADDING_SIZE at the end which will will always be 0.
4930  *
4931  * In addition the whole buffer will initially and after resizes
4932  * be 0-initialized so that no uninitialized data will ever appear.
4933  */
4934 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4935
4936 /**
4937  * Same behaviour av_fast_padded_malloc except that buffer will always
4938  * be 0-initialized after call.
4939  */
4940 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4941
4942 /**
4943  * Encode extradata length to a buffer. Used by xiph codecs.
4944  *
4945  * @param s buffer to write to; must be at least (v/255+1) bytes long
4946  * @param v size of extradata in bytes
4947  * @return number of bytes written to the buffer.
4948  */
4949 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4950
4951 /**
4952  * Log a generic warning message about a missing feature. This function is
4953  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4954  * only, and would normally not be used by applications.
4955  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4956  * a pointer to an AVClass struct
4957  * @param[in] feature string containing the name of the missing feature
4958  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4959  * If want_sample is non-zero, additional verbage will be added to the log
4960  * message which tells the user how to report samples to the development
4961  * mailing list.
4962  */
4963 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4964
4965 /**
4966  * Log a generic warning message asking for a sample. This function is
4967  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4968  * only, and would normally not be used by applications.
4969  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4970  * a pointer to an AVClass struct
4971  * @param[in] msg string containing an optional message, or NULL if no message
4972  */
4973 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4974
4975 /**
4976  * Register the hardware accelerator hwaccel.
4977  */
4978 void av_register_hwaccel(AVHWAccel *hwaccel);
4979
4980 /**
4981  * If hwaccel is NULL, returns the first registered hardware accelerator,
4982  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4983  * after hwaccel, or NULL if hwaccel is the last one.
4984  */
4985 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4986
4987
4988 /**
4989  * Lock operation used by lockmgr
4990  */
4991 enum AVLockOp {
4992   AV_LOCK_CREATE,  ///< Create a mutex
4993   AV_LOCK_OBTAIN,  ///< Lock the mutex
4994   AV_LOCK_RELEASE, ///< Unlock the mutex
4995   AV_LOCK_DESTROY, ///< Free mutex resources
4996 };
4997
4998 /**
4999  * Register a user provided lock manager supporting the operations
5000  * specified by AVLockOp. mutex points to a (void *) where the
5001  * lockmgr should store/get a pointer to a user allocated mutex. It's
5002  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5003  *
5004  * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5005  *           callback during the call to av_lockmgr_register().
5006  *           Thus, the application must be prepared to handle that.
5007  *           If cb is set to NULL the lockmgr will be unregistered.
5008  *           Also note that during unregistration the previously registered
5009  *           lockmgr callback may also be invoked.
5010  */
5011 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5012
5013 /**
5014  * Get the type of the given codec.
5015  */
5016 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5017
5018 /**
5019  * Get the name of a codec.
5020  * @return  a static string identifying the codec; never NULL
5021  */
5022 const char *avcodec_get_name(enum AVCodecID id);
5023
5024 /**
5025  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5026  * with no corresponding avcodec_close()), 0 otherwise.
5027  */
5028 int avcodec_is_open(AVCodecContext *s);
5029
5030 /**
5031  * @return a non-zero number if codec is an encoder, zero otherwise
5032  */
5033 int av_codec_is_encoder(const AVCodec *codec);
5034
5035 /**
5036  * @return a non-zero number if codec is a decoder, zero otherwise
5037  */
5038 int av_codec_is_decoder(const AVCodec *codec);
5039
5040 /**
5041  * @return descriptor for given codec ID or NULL if no descriptor exists.
5042  */
5043 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5044
5045 /**
5046  * Iterate over all codec descriptors known to libavcodec.
5047  *
5048  * @param prev previous descriptor. NULL to get the first descriptor.
5049  *
5050  * @return next descriptor or NULL after the last descriptor
5051  */
5052 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5053
5054 /**
5055  * @return codec descriptor with the given name or NULL if no such descriptor
5056  *         exists.
5057  */
5058 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5059
5060 /**
5061  * @}
5062  */
5063
5064 #endif /* AVCODEC_AVCODEC_H */