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