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