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