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