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