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