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