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