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