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