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