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