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