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