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