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