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