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