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