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