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