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