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