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