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