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