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