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