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