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