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