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