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