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