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