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