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