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