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