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