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