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