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