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