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