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