add AVERROR_NOENT
[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 St, Fifth Floor, Boston, MA  02110-1301  USA
19  */
20
21 #ifndef AVCODEC_H
22 #define AVCODEC_H
23
24 /**
25  * @file avcodec.h
26  * external API header
27  */
28
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 #include "avutil.h"
35 #include <sys/types.h> /* size_t */
36
37 #define AV_STRINGIFY(s)         AV_TOSTRING(s)
38 #define AV_TOSTRING(s) #s
39
40 #define LIBAVCODEC_VERSION_INT  ((51<<16)+(40<<8)+4)
41 #define LIBAVCODEC_VERSION      51.40.4
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  *
52  * If you add a codec ID to this list, add it so that
53  * 1. no value of a existing codec ID changes (that would break ABI),
54  * 2. it is as close as possible to similar codecs.
55  */
56 enum CodecID {
57     CODEC_ID_NONE,
58     CODEC_ID_MPEG1VIDEO,
59     CODEC_ID_MPEG2VIDEO, /* preferred ID for MPEG-1/2 video decoding */
60     CODEC_ID_MPEG2VIDEO_XVMC,
61     CODEC_ID_H261,
62     CODEC_ID_H263,
63     CODEC_ID_RV10,
64     CODEC_ID_RV20,
65     CODEC_ID_MJPEG,
66     CODEC_ID_MJPEGB,
67     CODEC_ID_LJPEG,
68     CODEC_ID_SP5X,
69     CODEC_ID_JPEGLS,
70     CODEC_ID_MPEG4,
71     CODEC_ID_RAWVIDEO,
72     CODEC_ID_MSMPEG4V1,
73     CODEC_ID_MSMPEG4V2,
74     CODEC_ID_MSMPEG4V3,
75     CODEC_ID_WMV1,
76     CODEC_ID_WMV2,
77     CODEC_ID_H263P,
78     CODEC_ID_H263I,
79     CODEC_ID_FLV1,
80     CODEC_ID_SVQ1,
81     CODEC_ID_SVQ3,
82     CODEC_ID_DVVIDEO,
83     CODEC_ID_HUFFYUV,
84     CODEC_ID_CYUV,
85     CODEC_ID_H264,
86     CODEC_ID_INDEO3,
87     CODEC_ID_VP3,
88     CODEC_ID_THEORA,
89     CODEC_ID_ASV1,
90     CODEC_ID_ASV2,
91     CODEC_ID_FFV1,
92     CODEC_ID_4XM,
93     CODEC_ID_VCR1,
94     CODEC_ID_CLJR,
95     CODEC_ID_MDEC,
96     CODEC_ID_ROQ,
97     CODEC_ID_INTERPLAY_VIDEO,
98     CODEC_ID_XAN_WC3,
99     CODEC_ID_XAN_WC4,
100     CODEC_ID_RPZA,
101     CODEC_ID_CINEPAK,
102     CODEC_ID_WS_VQA,
103     CODEC_ID_MSRLE,
104     CODEC_ID_MSVIDEO1,
105     CODEC_ID_IDCIN,
106     CODEC_ID_8BPS,
107     CODEC_ID_SMC,
108     CODEC_ID_FLIC,
109     CODEC_ID_TRUEMOTION1,
110     CODEC_ID_VMDVIDEO,
111     CODEC_ID_MSZH,
112     CODEC_ID_ZLIB,
113     CODEC_ID_QTRLE,
114     CODEC_ID_SNOW,
115     CODEC_ID_TSCC,
116     CODEC_ID_ULTI,
117     CODEC_ID_QDRAW,
118     CODEC_ID_VIXL,
119     CODEC_ID_QPEG,
120     CODEC_ID_XVID,
121     CODEC_ID_PNG,
122     CODEC_ID_PPM,
123     CODEC_ID_PBM,
124     CODEC_ID_PGM,
125     CODEC_ID_PGMYUV,
126     CODEC_ID_PAM,
127     CODEC_ID_FFVHUFF,
128     CODEC_ID_RV30,
129     CODEC_ID_RV40,
130     CODEC_ID_VC1,
131     CODEC_ID_WMV3,
132     CODEC_ID_LOCO,
133     CODEC_ID_WNV1,
134     CODEC_ID_AASC,
135     CODEC_ID_INDEO2,
136     CODEC_ID_FRAPS,
137     CODEC_ID_TRUEMOTION2,
138     CODEC_ID_BMP,
139     CODEC_ID_CSCD,
140     CODEC_ID_MMVIDEO,
141     CODEC_ID_ZMBV,
142     CODEC_ID_AVS,
143     CODEC_ID_SMACKVIDEO,
144     CODEC_ID_NUV,
145     CODEC_ID_KMVC,
146     CODEC_ID_FLASHSV,
147     CODEC_ID_CAVS,
148     CODEC_ID_JPEG2000,
149     CODEC_ID_VMNC,
150     CODEC_ID_VP5,
151     CODEC_ID_VP6,
152     CODEC_ID_VP6F,
153     CODEC_ID_TARGA,
154     CODEC_ID_DSICINVIDEO,
155     CODEC_ID_TIERTEXSEQVIDEO,
156     CODEC_ID_TIFF,
157     CODEC_ID_GIF,
158     CODEC_ID_FFH264,
159     CODEC_ID_DXA,
160     CODEC_ID_DNXHD,
161     CODEC_ID_THP,
162     CODEC_ID_SGI,
163     CODEC_ID_C93,
164     CODEC_ID_BETHSOFTVID,
165     CODEC_ID_PTX,
166     CODEC_ID_TXD,
167
168     /* various PCM "codecs" */
169     CODEC_ID_PCM_S16LE= 0x10000,
170     CODEC_ID_PCM_S16BE,
171     CODEC_ID_PCM_U16LE,
172     CODEC_ID_PCM_U16BE,
173     CODEC_ID_PCM_S8,
174     CODEC_ID_PCM_U8,
175     CODEC_ID_PCM_MULAW,
176     CODEC_ID_PCM_ALAW,
177     CODEC_ID_PCM_S32LE,
178     CODEC_ID_PCM_S32BE,
179     CODEC_ID_PCM_U32LE,
180     CODEC_ID_PCM_U32BE,
181     CODEC_ID_PCM_S24LE,
182     CODEC_ID_PCM_S24BE,
183     CODEC_ID_PCM_U24LE,
184     CODEC_ID_PCM_U24BE,
185     CODEC_ID_PCM_S24DAUD,
186
187     /* various ADPCM codecs */
188     CODEC_ID_ADPCM_IMA_QT= 0x11000,
189     CODEC_ID_ADPCM_IMA_WAV,
190     CODEC_ID_ADPCM_IMA_DK3,
191     CODEC_ID_ADPCM_IMA_DK4,
192     CODEC_ID_ADPCM_IMA_WS,
193     CODEC_ID_ADPCM_IMA_SMJPEG,
194     CODEC_ID_ADPCM_MS,
195     CODEC_ID_ADPCM_4XM,
196     CODEC_ID_ADPCM_XA,
197     CODEC_ID_ADPCM_ADX,
198     CODEC_ID_ADPCM_EA,
199     CODEC_ID_ADPCM_G726,
200     CODEC_ID_ADPCM_CT,
201     CODEC_ID_ADPCM_SWF,
202     CODEC_ID_ADPCM_YAMAHA,
203     CODEC_ID_ADPCM_SBPRO_4,
204     CODEC_ID_ADPCM_SBPRO_3,
205     CODEC_ID_ADPCM_SBPRO_2,
206     CODEC_ID_ADPCM_THP,
207
208     /* AMR */
209     CODEC_ID_AMR_NB= 0x12000,
210     CODEC_ID_AMR_WB,
211
212     /* RealAudio codecs*/
213     CODEC_ID_RA_144= 0x13000,
214     CODEC_ID_RA_288,
215
216     /* various DPCM codecs */
217     CODEC_ID_ROQ_DPCM= 0x14000,
218     CODEC_ID_INTERPLAY_DPCM,
219     CODEC_ID_XAN_DPCM,
220     CODEC_ID_SOL_DPCM,
221
222     CODEC_ID_MP2= 0x15000,
223     CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
224     CODEC_ID_AAC,
225 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
226     CODEC_ID_MPEG4AAC,
227 #endif
228     CODEC_ID_AC3,
229     CODEC_ID_DTS,
230     CODEC_ID_VORBIS,
231     CODEC_ID_DVAUDIO,
232     CODEC_ID_WMAV1,
233     CODEC_ID_WMAV2,
234     CODEC_ID_MACE3,
235     CODEC_ID_MACE6,
236     CODEC_ID_VMDAUDIO,
237     CODEC_ID_SONIC,
238     CODEC_ID_SONIC_LS,
239     CODEC_ID_FLAC,
240     CODEC_ID_MP3ADU,
241     CODEC_ID_MP3ON4,
242     CODEC_ID_SHORTEN,
243     CODEC_ID_ALAC,
244     CODEC_ID_WESTWOOD_SND1,
245     CODEC_ID_GSM, /* as in Berlin toast format */
246     CODEC_ID_QDM2,
247     CODEC_ID_COOK,
248     CODEC_ID_TRUESPEECH,
249     CODEC_ID_TTA,
250     CODEC_ID_SMACKAUDIO,
251     CODEC_ID_QCELP,
252     CODEC_ID_WAVPACK,
253     CODEC_ID_DSICINAUDIO,
254     CODEC_ID_IMC,
255     CODEC_ID_MUSEPACK7,
256     CODEC_ID_MLP,
257     CODEC_ID_GSM_MS, /* as found in WAV */
258     CODEC_ID_ATRAC3,
259
260     /* subtitle codecs */
261     CODEC_ID_DVD_SUBTITLE= 0x17000,
262     CODEC_ID_DVB_SUBTITLE,
263
264     CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
265                                 * stream (only used by libavformat) */
266 };
267
268 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
269 /* CODEC_ID_MP3LAME is obsolete */
270 #define CODEC_ID_MP3LAME CODEC_ID_MP3
271 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
272 #endif
273
274 enum CodecType {
275     CODEC_TYPE_UNKNOWN = -1,
276     CODEC_TYPE_VIDEO,
277     CODEC_TYPE_AUDIO,
278     CODEC_TYPE_DATA,
279     CODEC_TYPE_SUBTITLE,
280     CODEC_TYPE_NB
281 };
282
283 /* Currently unused, may be used if 24/32 bits samples are ever supported. */
284 /* all in native-endian format */
285 enum SampleFormat {
286     SAMPLE_FMT_NONE = -1,
287     SAMPLE_FMT_U8,              ///< unsigned 8 bits
288     SAMPLE_FMT_S16,             ///< signed 16 bits
289     SAMPLE_FMT_S24,             ///< signed 24 bits
290     SAMPLE_FMT_S32,             ///< signed 32 bits
291     SAMPLE_FMT_FLT,             ///< float
292 };
293
294 /* in bytes */
295 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
296
297 /**
298  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
299  * This is mainly needed because some optimized bitstream readers read
300  * 32 or 64 bit at once and could read over the end.<br>
301  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
302  * MPEG bitstreams could cause overread and segfault.
303  */
304 #define FF_INPUT_BUFFER_PADDING_SIZE 8
305
306 /**
307  * minimum encoding buffer size
308  * Used to avoid some checks during header writing.
309  */
310 #define FF_MIN_BUFFER_SIZE 16384
311
312 /* motion estimation type, EPZS by default */
313 enum Motion_Est_ID {
314     ME_ZERO = 1,
315     ME_FULL,
316     ME_LOG,
317     ME_PHODS,
318     ME_EPZS,
319     ME_X1,
320     ME_HEX,
321     ME_UMH,
322     ME_ITER,
323 };
324
325 enum AVDiscard{
326     /* We leave some space between them for extensions (drop some
327      * keyframes for intra-only or drop just some bidir frames). */
328     AVDISCARD_NONE   =-16, ///< discard nothing
329     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
330     AVDISCARD_NONREF =  8, ///< discard all non reference
331     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
332     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
333     AVDISCARD_ALL    = 48, ///< discard all
334 };
335
336 typedef struct RcOverride{
337     int start_frame;
338     int end_frame;
339     int qscale; // If this is 0 then quality_factor will be used instead.
340     float quality_factor;
341 } RcOverride;
342
343 #define FF_MAX_B_FRAMES 16
344
345 /* encoding support
346    These flags can be passed in AVCodecContext.flags before initialization.
347    Note: Not everything is supported yet.
348 */
349
350 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
351 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
352 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
353 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
354 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
355 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
356 /* The parent program guarantees that the input for B-frames containing
357  * streams is not written to for at least s->max_b_frames+1 frames, if
358  * this is not set the input will be copied. */
359 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
360 #define CODEC_FLAG_PASS1 0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
361 #define CODEC_FLAG_PASS2 0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
362 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
363 #define CODEC_FLAG_GRAY  0x2000   ///< Only decode/encode grayscale.
364 #define CODEC_FLAG_EMU_EDGE 0x4000///< Don't draw edges.
365 #define CODEC_FLAG_PSNR           0x8000 ///< error[?] variables will be set during encoding.
366 #define CODEC_FLAG_TRUNCATED  0x00010000 /** Input bitstream might be truncated at a random location instead
367                                             of only at frame boundaries. */
368 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
369 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
370 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
371 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
372 #define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
373 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
374 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
375 /* Fx : Flag for h263+ extra options */
376 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
377 #define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
378 #endif
379 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
380 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
381 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
382 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
383 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
384 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
385 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
386 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
387 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
388 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
389 #define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
390 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
391 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
392 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
393 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
394 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
395 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
396 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
397 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
398 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
399 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
400 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
401 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
402 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
403 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
404 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
405 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
406 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
407
408 /* Unsupported options :
409  *              Syntax Arithmetic coding (SAC)
410  *              Reference Picture Selection
411  *              Independent Segment Decoding */
412 /* /Fx */
413 /* codec capabilities */
414
415 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
416 /**
417  * Codec uses get_buffer() for allocating buffers.
418  * direct rendering method 1
419  */
420 #define CODEC_CAP_DR1             0x0002
421 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
422 #define CODEC_CAP_PARSE_ONLY      0x0004
423 #define CODEC_CAP_TRUNCATED       0x0008
424 /* Codec can export data for HW decoding (XvMC). */
425 #define CODEC_CAP_HWACCEL         0x0010
426 /**
427  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
428  * If this is not set, the codec is guaranteed to never be fed with NULL data.
429  */
430 #define CODEC_CAP_DELAY           0x0020
431 /**
432  * Codec can be fed a final frame with a smaller size.
433  * This can be used to prevent truncation of the last audio samples.
434  */
435 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
436
437 //The following defines may change, don't expect compatibility if you use them.
438 #define MB_TYPE_INTRA4x4   0x0001
439 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
440 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
441 #define MB_TYPE_16x16      0x0008
442 #define MB_TYPE_16x8       0x0010
443 #define MB_TYPE_8x16       0x0020
444 #define MB_TYPE_8x8        0x0040
445 #define MB_TYPE_INTERLACED 0x0080
446 #define MB_TYPE_DIRECT2     0x0100 //FIXME
447 #define MB_TYPE_ACPRED     0x0200
448 #define MB_TYPE_GMC        0x0400
449 #define MB_TYPE_SKIP       0x0800
450 #define MB_TYPE_P0L0       0x1000
451 #define MB_TYPE_P1L0       0x2000
452 #define MB_TYPE_P0L1       0x4000
453 #define MB_TYPE_P1L1       0x8000
454 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
455 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
456 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
457 #define MB_TYPE_QUANT      0x00010000
458 #define MB_TYPE_CBP        0x00020000
459 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
460
461 /**
462  * Pan Scan area.
463  * This specifies the area which should be displayed.
464  * Note there may be multiple such areas for one frame.
465  */
466 typedef struct AVPanScan{
467     /**
468      * id
469      * - encoding: Set by user.
470      * - decoding: Set by libavcodec.
471      */
472     int id;
473
474     /**
475      * width and height in 1/16 pel
476      * - encoding: Set by user.
477      * - decoding: Set by libavcodec.
478      */
479     int width;
480     int height;
481
482     /**
483      * position of the top left corner in 1/16 pel for up to 3 fields/frames
484      * - encoding: Set by user.
485      * - decoding: Set by libavcodec.
486      */
487     int16_t position[3][2];
488 }AVPanScan;
489
490 #define FF_COMMON_FRAME \
491     /**\
492      * pointer to the picture planes.\
493      * This might be different from the first allocated byte\
494      * - encoding: \
495      * - decoding: \
496      */\
497     uint8_t *data[4];\
498     int linesize[4];\
499     /**\
500      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
501      * This isn't used by libavcodec unless the default get/release_buffer() is used.\
502      * - encoding: \
503      * - decoding: \
504      */\
505     uint8_t *base[4];\
506     /**\
507      * 1 -> keyframe, 0-> not\
508      * - encoding: Set by libavcodec.\
509      * - decoding: Set by libavcodec.\
510      */\
511     int key_frame;\
512 \
513     /**\
514      * Picture type of the frame, see ?_TYPE below.\
515      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
516      * - decoding: Set by libavcodec.\
517      */\
518     int pict_type;\
519 \
520     /**\
521      * presentation timestamp in time_base units (time when frame should be shown to user)\
522      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
523      * - encoding: MUST be set by user.\
524      * - decoding: Set by libavcodec.\
525      */\
526     int64_t pts;\
527 \
528     /**\
529      * picture number in bitstream order\
530      * - encoding: set by\
531      * - decoding: Set by libavcodec.\
532      */\
533     int coded_picture_number;\
534     /**\
535      * picture number in display order\
536      * - encoding: set by\
537      * - decoding: Set by libavcodec.\
538      */\
539     int display_picture_number;\
540 \
541     /**\
542      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
543      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
544      * - decoding: Set by libavcodec.\
545      */\
546     int quality; \
547 \
548     /**\
549      * buffer age (1->was last buffer and dint change, 2->..., ...).\
550      * Set to INT_MAX if the buffer has not been used yet.\
551      * - encoding: unused\
552      * - decoding: MUST be set by get_buffer().\
553      */\
554     int age;\
555 \
556     /**\
557      * is this picture used as reference\
558      * - encoding: unused\
559      * - decoding: Set by libavcodec. (before get_buffer() call)).\
560      */\
561     int reference;\
562 \
563     /**\
564      * QP table\
565      * - encoding: unused\
566      * - decoding: Set by libavcodec.\
567      */\
568     int8_t *qscale_table;\
569     /**\
570      * QP store stride\
571      * - encoding: unused\
572      * - decoding: Set by libavcodec.\
573      */\
574     int qstride;\
575 \
576     /**\
577      * mbskip_table[mb]>=1 if MB didn't change\
578      * stride= mb_width = (width+15)>>4\
579      * - encoding: unused\
580      * - decoding: Set by libavcodec.\
581      */\
582     uint8_t *mbskip_table;\
583 \
584     /**\
585      * motion vector table\
586      * @code\
587      * example:\
588      * int mv_sample_log2= 4 - motion_subsample_log2;\
589      * int mb_width= (width+15)>>4;\
590      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
591      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
592      * @endcode\
593      * - encoding: Set by user.\
594      * - decoding: Set by libavcodec.\
595      */\
596     int16_t (*motion_val[2])[2];\
597 \
598     /**\
599      * macroblock type table\
600      * mb_type_base + mb_width + 2\
601      * - encoding: Set by user.\
602      * - decoding: Set by libavcodec.\
603      */\
604     uint32_t *mb_type;\
605 \
606     /**\
607      * log2 of the size of the block which a single vector in motion_val represents: \
608      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
609      * - encoding: unused\
610      * - decoding: Set by libavcodec.\
611      */\
612     uint8_t motion_subsample_log2;\
613 \
614     /**\
615      * for some private data of the user\
616      * - encoding: unused\
617      * - decoding: Set by user.\
618      */\
619     void *opaque;\
620 \
621     /**\
622      * error\
623      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
624      * - decoding: unused\
625      */\
626     uint64_t error[4];\
627 \
628     /**\
629      * type of the buffer (to keep track of who has to deallocate data[*])\
630      * - encoding: Set by the one who allocates it.\
631      * - decoding: Set by the one who allocates it.\
632      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
633      */\
634     int type;\
635     \
636     /**\
637      * When decoding, this signals how much the picture must be delayed.\
638      * extra_delay = repeat_pict / (2*fps)\
639      * - encoding: unused\
640      * - decoding: Set by libavcodec.\
641      */\
642     int repeat_pict;\
643     \
644     /**\
645      * \
646      */\
647     int qscale_type;\
648     \
649     /**\
650      * The content of the picture is interlaced.\
651      * - encoding: Set by user.\
652      * - decoding: Set by libavcodec. (default 0)\
653      */\
654     int interlaced_frame;\
655     \
656     /**\
657      * If the content is interlaced, is top field displayed first.\
658      * - encoding: Set by user.\
659      * - decoding: Set by libavcodec.\
660      */\
661     int top_field_first;\
662     \
663     /**\
664      * Pan scan.\
665      * - encoding: Set by user.\
666      * - decoding: Set by libavcodec.\
667      */\
668     AVPanScan *pan_scan;\
669     \
670     /**\
671      * Tell user application that palette has changed from previous frame.\
672      * - encoding: ??? (no palette-enabled encoder yet)\
673      * - decoding: Set by libavcodec. (default 0).\
674      */\
675     int palette_has_changed;\
676     \
677     /**\
678      * codec suggestion on buffer type if != 0\
679      * - encoding: unused\
680      * - decoding: Set by libavcodec. (before get_buffer() call)).\
681      */\
682     int buffer_hints;\
683 \
684     /**\
685      * DCT coefficients\
686      * - encoding: unused\
687      * - decoding: Set by libavcodec.\
688      */\
689     short *dct_coeff;\
690 \
691     /**\
692      * motion referece frame index\
693      * - encoding: Set by user.\
694      * - decoding: Set by libavcodec.\
695      */\
696     int8_t *ref_index[2];
697
698 #define FF_QSCALE_TYPE_MPEG1 0
699 #define FF_QSCALE_TYPE_MPEG2 1
700 #define FF_QSCALE_TYPE_H264  2
701
702 #define FF_BUFFER_TYPE_INTERNAL 1
703 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
704 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
705 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
706
707
708 #define FF_I_TYPE 1 // Intra
709 #define FF_P_TYPE 2 // Predicted
710 #define FF_B_TYPE 3 // Bi-dir predicted
711 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
712 #define FF_SI_TYPE 5
713 #define FF_SP_TYPE 6
714
715 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
716 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
717 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
718 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
719
720 /**
721  * Audio Video Frame.
722  */
723 typedef struct AVFrame {
724     FF_COMMON_FRAME
725 } AVFrame;
726
727 #define DEFAULT_FRAME_RATE_BASE 1001000
728
729 /**
730  * main external API structure
731  */
732 typedef struct AVCodecContext {
733     /**
734      * information on struct for av_log
735      * - set by avcodec_alloc_context
736      */
737     AVClass *av_class;
738     /**
739      * the average bitrate
740      * - encoding: Set by user; unused for constant quantizer encoding.
741      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
742      */
743     int bit_rate;
744
745     /**
746      * number of bits the bitstream is allowed to diverge from the reference.
747      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
748      * - encoding: Set by user; unused for constant quantizer encoding.
749      * - decoding: unused
750      */
751     int bit_rate_tolerance;
752
753     /**
754      * CODEC_FLAG_*.
755      * - encoding: Set by user.
756      * - decoding: Set by user.
757      */
758     int flags;
759
760     /**
761      * Some codecs need additional format info. It is stored here.
762      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
763      * specific codec MUST set it correctly otherwise stream copy breaks.
764      * In general use of this field by muxers is not recommanded.
765      * - encoding: Set by libavcodec.
766      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
767      */
768     int sub_id;
769
770     /**
771      * Motion estimation algorithm used for video coding.
772      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
773      * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
774      * - encoding: MUST be set by user.
775      * - decoding: unused
776      */
777     int me_method;
778
779     /**
780      * some codecs need / can use extradata like Huffman tables.
781      * mjpeg: Huffman tables
782      * rv10: additional flags
783      * mpeg4: global headers (they can be in the bitstream or here)
784      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
785      * than extradata_size to avoid prolems if it is read with the bitstream reader.
786      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
787      * - encoding: Set/allocated/freed by libavcodec.
788      * - decoding: Set/allocated/freed by user.
789      */
790     uint8_t *extradata;
791     int extradata_size;
792
793     /**
794      * This is the fundamental unit of time (in seconds) in terms
795      * of which frame timestamps are represented. For fixed-fps content,
796      * timebase should be 1/framerate and timestamp increments should be
797      * identically 1.
798      * - encoding: MUST be set by user.
799      * - decoding: Set by libavcodec.
800      */
801     AVRational time_base;
802
803     /* video only */
804     /**
805      * picture width / height.
806      * - encoding: MUST be set by user.
807      * - decoding: Set by libavcodec.
808      * Note: For compatibility it is possible to set this instead of
809      * coded_width/height before decoding.
810      */
811     int width, height;
812
813 #define FF_ASPECT_EXTENDED 15
814
815     /**
816      * the number of pictures in a group of pictures, or 0 for intra_only
817      * - encoding: Set by user.
818      * - decoding: unused
819      */
820     int gop_size;
821
822     /**
823      * Pixel format, see PIX_FMT_xxx.
824      * - encoding: Set by user.
825      * - decoding: Set by libavcodec.
826      */
827     enum PixelFormat pix_fmt;
828
829     /**
830      * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
831      * has to read frames at native frame rate.
832      * - encoding: Set by user.
833      * - decoding: unused
834      */
835     int rate_emu;
836
837     /**
838      * If non NULL, 'draw_horiz_band' is called by the libavcodec
839      * decoder to draw a horizontal band. It improves cache usage. Not
840      * all codecs can do that. You must check the codec capabilities
841      * beforehand.
842      * - encoding: unused
843      * - decoding: Set by user.
844      * @param height the height of the slice
845      * @param y the y position of the slice
846      * @param type 1->top field, 2->bottom field, 3->frame
847      * @param offset offset into the AVFrame.data from which the slice should be read
848      */
849     void (*draw_horiz_band)(struct AVCodecContext *s,
850                             const AVFrame *src, int offset[4],
851                             int y, int type, int height);
852
853     /* audio only */
854     int sample_rate; ///< samples per second
855     int channels;
856
857     /**
858      * audio sample format
859      * - encoding: Set by user.
860      * - decoding: Set by libavcodec.
861      */
862     enum SampleFormat sample_fmt;  ///< sample format, currently unused
863
864     /* The following data should not be initialized. */
865     /**
866      * Samples per packet, initialized when calling 'init'.
867      */
868     int frame_size;
869     int frame_number;   ///< audio or video frame number
870     int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
871
872     /**
873      * Number of frames the decoded output will be delayed relative to
874      * the encoded input.
875      * - encoding: Set by libavcodec.
876      * - decoding: unused
877      */
878     int delay;
879
880     /* - encoding parameters */
881     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
882     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
883
884     /**
885      * minimum quantizer
886      * - encoding: Set by user.
887      * - decoding: unused
888      */
889     int qmin;
890
891     /**
892      * maximum quantizer
893      * - encoding: Set by user.
894      * - decoding: unused
895      */
896     int qmax;
897
898     /**
899      * maximum quantizer difference between frames
900      * - encoding: Set by user.
901      * - decoding: unused
902      */
903     int max_qdiff;
904
905     /**
906      * maximum number of B-frames between non-B-frames
907      * Note: The output will be delayed by max_b_frames+1 relative to the input.
908      * - encoding: Set by user.
909      * - decoding: unused
910      */
911     int max_b_frames;
912
913     /**
914      * qscale factor between IP and B-frames
915      * - encoding: Set by user.
916      * - decoding: unused
917      */
918     float b_quant_factor;
919
920     /** obsolete FIXME remove */
921     int rc_strategy;
922 #define FF_RC_STRATEGY_XVID 1
923
924     int b_frame_strategy;
925
926     /**
927      * hurry up amount
928      * - encoding: unused
929      * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
930      * @deprecated Deprecated in favor of skip_idct and skip_frame.
931      */
932     int hurry_up;
933
934     struct AVCodec *codec;
935
936     void *priv_data;
937
938 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
939     /* unused, FIXME remove*/
940     int rtp_mode;
941 #endif
942
943     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
944                             /* do its best to deliver a chunk with size     */
945                             /* below rtp_payload_size, the chunk will start */
946                             /* with a start code on some codecs like H.263. */
947                             /* This doesn't take account of any particular  */
948                             /* headers inside the transmitted RTP payload.  */
949
950
951     /* The RTP callback: This function is called    */
952     /* every time the encoder has a packet to send. */
953     /* It depends on the encoder if the data starts */
954     /* with a Start Code (it should). H.263 does.   */
955     /* mb_nb contains the number of macroblocks     */
956     /* encoded in the RTP payload.                  */
957     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
958
959     /* statistics, used for 2-pass encoding */
960     int mv_bits;
961     int header_bits;
962     int i_tex_bits;
963     int p_tex_bits;
964     int i_count;
965     int p_count;
966     int skip_count;
967     int misc_bits;
968
969     /**
970      * number of bits used for the previously encoded frame
971      * - encoding: Set by libavcodec.
972      * - decoding: unused
973      */
974     int frame_bits;
975
976     /**
977      * Private data of the user, can be used to carry app specific stuff.
978      * - encoding: Set by user.
979      * - decoding: Set by user.
980      */
981     void *opaque;
982
983     char codec_name[32];
984     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
985     enum CodecID codec_id; /* see CODEC_ID_xxx */
986
987     /**
988      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
989      * This is used to work around some encoder bugs.
990      * A demuxer should set this to what is stored in the field used to identify the codec.
991      * If there are multiple such fields in a container then the demuxer should choose the one
992      * which maximizes the information about the used codec.
993      * If the codec tag field in a container is larger then 32 bits then the demuxer should
994      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
995      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
996      * first.
997      * - encoding: Set by user, if not then the default based on codec_id will be used.
998      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
999      */
1000     unsigned int codec_tag;
1001
1002     /**
1003      * Work around bugs in encoders which sometimes cannot be detected automatically.
1004      * - encoding: Set by user
1005      * - decoding: Set by user
1006      */
1007     int workaround_bugs;
1008 #define FF_BUG_AUTODETECT       1  ///< autodetection
1009 #define FF_BUG_OLD_MSMPEG4      2
1010 #define FF_BUG_XVID_ILACE       4
1011 #define FF_BUG_UMP4             8
1012 #define FF_BUG_NO_PADDING       16
1013 #define FF_BUG_AMV              32
1014 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1015 #define FF_BUG_QPEL_CHROMA      64
1016 #define FF_BUG_STD_QPEL         128
1017 #define FF_BUG_QPEL_CHROMA2     256
1018 #define FF_BUG_DIRECT_BLOCKSIZE 512
1019 #define FF_BUG_EDGE             1024
1020 #define FF_BUG_HPEL_CHROMA      2048
1021 #define FF_BUG_DC_CLIP          4096
1022 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1023 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1024
1025     /**
1026      * luma single coefficient elimination threshold
1027      * - encoding: Set by user.
1028      * - decoding: unused
1029      */
1030     int luma_elim_threshold;
1031
1032     /**
1033      * chroma single coeff elimination threshold
1034      * - encoding: Set by user.
1035      * - decoding: unused
1036      */
1037     int chroma_elim_threshold;
1038
1039     /**
1040      * strictly follow the standard (MPEG4, ...).
1041      * - encoding: Set by user.
1042      * - decoding: unused
1043      */
1044     int strict_std_compliance;
1045 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1046 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1047 #define FF_COMPLIANCE_NORMAL        0
1048 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1049 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1050
1051     /**
1052      * qscale offset between IP and B-frames
1053      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1054      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1055      * - encoding: Set by user.
1056      * - decoding: unused
1057      */
1058     float b_quant_offset;
1059
1060     /**
1061      * Error resilience; higher values will detect more errors but may
1062      * misdetect some more or less valid parts as errors.
1063      * - encoding: unused
1064      * - decoding: Set by user.
1065      */
1066     int error_resilience;
1067 #define FF_ER_CAREFUL         1
1068 #define FF_ER_COMPLIANT       2
1069 #define FF_ER_AGGRESSIVE      3
1070 #define FF_ER_VERY_AGGRESSIVE 4
1071
1072     /**
1073      * Called at the beginning of each frame to get a buffer for it.
1074      * If pic.reference is set then the frame will be read later by libavcodec.
1075      * avcodec_align_dimensions() should be used to find the required width and
1076      * height, as they normally need to be rounded up to the next multiple of 16.
1077      * - encoding: unused
1078      * - decoding: Set by libavcodec., user can override.
1079      */
1080     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1081
1082     /**
1083      * Called to release buffers which where allocated with get_buffer.
1084      * A released buffer can be reused in get_buffer().
1085      * pic.data[*] must be set to NULL.
1086      * - encoding: unused
1087      * - decoding: Set by libavcodec., user can override.
1088      */
1089     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1090
1091     /**
1092      * If 1 the stream has a 1 frame delay during decoding.
1093      * - encoding: Set by libavcodec.
1094      * - decoding: Set by libavcodec.
1095      */
1096     int has_b_frames;
1097
1098     /**
1099      * number of bytes per packet if constant and known or 0
1100      * Used by some WAV based audio codecs.
1101      */
1102     int block_align;
1103
1104     int parse_only; /* - decoding only: If true, only parsing is done
1105                        (function avcodec_parse_frame()). The frame
1106                        data is returned. Only MPEG codecs support this now. */
1107
1108     /**
1109      * 0-> h263 quant 1-> mpeg quant
1110      * - encoding: Set by user.
1111      * - decoding: unused
1112      */
1113     int mpeg_quant;
1114
1115     /**
1116      * pass1 encoding statistics output buffer
1117      * - encoding: Set by libavcodec.
1118      * - decoding: unused
1119      */
1120     char *stats_out;
1121
1122     /**
1123      * pass2 encoding statistics input buffer
1124      * Concatenated stuff from stats_out of pass1 should be placed here.
1125      * - encoding: Allocated/set/freed by user.
1126      * - decoding: unused
1127      */
1128     char *stats_in;
1129
1130     /**
1131      * ratecontrol qmin qmax limiting method
1132      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1133      * - encoding: Set by user.
1134      * - decoding: unused
1135      */
1136     float rc_qsquish;
1137
1138     float rc_qmod_amp;
1139     int rc_qmod_freq;
1140
1141     /**
1142      * ratecontrol override, see RcOverride
1143      * - encoding: Allocated/set/freed by user.
1144      * - decoding: unused
1145      */
1146     RcOverride *rc_override;
1147     int rc_override_count;
1148
1149     /**
1150      * rate control equation
1151      * - encoding: Set by user
1152      * - decoding: unused
1153      */
1154     char *rc_eq;
1155
1156     /**
1157      * maximum bitrate
1158      * - encoding: Set by user.
1159      * - decoding: unused
1160      */
1161     int rc_max_rate;
1162
1163     /**
1164      * minimum bitrate
1165      * - encoding: Set by user.
1166      * - decoding: unused
1167      */
1168     int rc_min_rate;
1169
1170     /**
1171      * decoder bitstream buffer size
1172      * - encoding: Set by user.
1173      * - decoding: unused
1174      */
1175     int rc_buffer_size;
1176     float rc_buffer_aggressivity;
1177
1178     /**
1179      * qscale factor between P and I-frames
1180      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1181      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1182      * - encoding: Set by user.
1183      * - decoding: unused
1184      */
1185     float i_quant_factor;
1186
1187     /**
1188      * qscale offset between P and I-frames
1189      * - encoding: Set by user.
1190      * - decoding: unused
1191      */
1192     float i_quant_offset;
1193
1194     /**
1195      * initial complexity for pass1 ratecontrol
1196      * - encoding: Set by user.
1197      * - decoding: unused
1198      */
1199     float rc_initial_cplx;
1200
1201     /**
1202      * DCT algorithm, see FF_DCT_* below
1203      * - encoding: Set by user.
1204      * - decoding: unused
1205      */
1206     int dct_algo;
1207 #define FF_DCT_AUTO    0
1208 #define FF_DCT_FASTINT 1
1209 #define FF_DCT_INT     2
1210 #define FF_DCT_MMX     3
1211 #define FF_DCT_MLIB    4
1212 #define FF_DCT_ALTIVEC 5
1213 #define FF_DCT_FAAN    6
1214
1215     /**
1216      * luminance masking (0-> disabled)
1217      * - encoding: Set by user.
1218      * - decoding: unused
1219      */
1220     float lumi_masking;
1221
1222     /**
1223      * temporary complexity masking (0-> disabled)
1224      * - encoding: Set by user.
1225      * - decoding: unused
1226      */
1227     float temporal_cplx_masking;
1228
1229     /**
1230      * spatial complexity masking (0-> disabled)
1231      * - encoding: Set by user.
1232      * - decoding: unused
1233      */
1234     float spatial_cplx_masking;
1235
1236     /**
1237      * p block masking (0-> disabled)
1238      * - encoding: Set by user.
1239      * - decoding: unused
1240      */
1241     float p_masking;
1242
1243     /**
1244      * darkness masking (0-> disabled)
1245      * - encoding: Set by user.
1246      * - decoding: unused
1247      */
1248     float dark_masking;
1249
1250
1251     /* for binary compatibility */
1252     int unused;
1253
1254     /**
1255      * IDCT algorithm, see FF_IDCT_* below.
1256      * - encoding: Set by user.
1257      * - decoding: Set by user.
1258      */
1259     int idct_algo;
1260 #define FF_IDCT_AUTO         0
1261 #define FF_IDCT_INT          1
1262 #define FF_IDCT_SIMPLE       2
1263 #define FF_IDCT_SIMPLEMMX    3
1264 #define FF_IDCT_LIBMPEG2MMX  4
1265 #define FF_IDCT_PS2          5
1266 #define FF_IDCT_MLIB         6
1267 #define FF_IDCT_ARM          7
1268 #define FF_IDCT_ALTIVEC      8
1269 #define FF_IDCT_SH4          9
1270 #define FF_IDCT_SIMPLEARM    10
1271 #define FF_IDCT_H264         11
1272 #define FF_IDCT_VP3          12
1273 #define FF_IDCT_IPP          13
1274 #define FF_IDCT_XVIDMMX      14
1275 #define FF_IDCT_CAVS         15
1276 #define FF_IDCT_SIMPLEARMV5TE 16
1277 #define FF_IDCT_SIMPLEARMV6  17
1278
1279     /**
1280      * slice count
1281      * - encoding: Set by libavcodec.
1282      * - decoding: Set by user (or 0).
1283      */
1284     int slice_count;
1285     /**
1286      * slice offsets in the frame in bytes
1287      * - encoding: Set/allocated by libavcodec.
1288      * - decoding: Set/allocated by user (or NULL).
1289      */
1290     int *slice_offset;
1291
1292     /**
1293      * error concealment flags
1294      * - encoding: unused
1295      * - decoding: Set by user.
1296      */
1297     int error_concealment;
1298 #define FF_EC_GUESS_MVS   1
1299 #define FF_EC_DEBLOCK     2
1300
1301     /**
1302      * dsp_mask could be add used to disable unwanted CPU features
1303      * CPU features (i.e. MMX, SSE. ...)
1304      *
1305      * With the FORCE flag you may instead enable given CPU features.
1306      * (Dangerous: Usable in case of misdetection, improper usage however will
1307      * result into program crash.)
1308      */
1309     unsigned dsp_mask;
1310 #define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1311     /* lower 16 bits - CPU features */
1312 #ifdef HAVE_MMX
1313 #define FF_MM_MMX      0x0001 /* standard MMX */
1314 #define FF_MM_3DNOW    0x0004 /* AMD 3DNOW */
1315 #define FF_MM_MMXEXT   0x0002 /* SSE integer functions or AMD MMX ext */
1316 #define FF_MM_SSE      0x0008 /* SSE functions */
1317 #define FF_MM_SSE2     0x0010 /* PIV SSE2 functions */
1318 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1319 #endif /* HAVE_MMX */
1320 #ifdef HAVE_IWMMXT
1321 #define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1322 #endif /* HAVE_IWMMXT */
1323
1324     /**
1325      * bits per sample/pixel from the demuxer (needed for huffyuv).
1326      * - encoding: Set by libavcodec.
1327      * - decoding: Set by user.
1328      */
1329      int bits_per_sample;
1330
1331     /**
1332      * prediction method (needed for huffyuv)
1333      * - encoding: Set by user.
1334      * - decoding: unused
1335      */
1336      int prediction_method;
1337 #define FF_PRED_LEFT   0
1338 #define FF_PRED_PLANE  1
1339 #define FF_PRED_MEDIAN 2
1340
1341     /**
1342      * sample aspect ratio (0 if unknown)
1343      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1344      * - encoding: Set by user.
1345      * - decoding: Set by libavcodec.
1346      */
1347     AVRational sample_aspect_ratio;
1348
1349     /**
1350      * the picture in the bitstream
1351      * - encoding: Set by libavcodec.
1352      * - decoding: Set by libavcodec.
1353      */
1354     AVFrame *coded_frame;
1355
1356     /**
1357      * debug
1358      * - encoding: Set by user.
1359      * - decoding: Set by user.
1360      */
1361     int debug;
1362 #define FF_DEBUG_PICT_INFO 1
1363 #define FF_DEBUG_RC        2
1364 #define FF_DEBUG_BITSTREAM 4
1365 #define FF_DEBUG_MB_TYPE   8
1366 #define FF_DEBUG_QP        16
1367 #define FF_DEBUG_MV        32
1368 #define FF_DEBUG_DCT_COEFF 0x00000040
1369 #define FF_DEBUG_SKIP      0x00000080
1370 #define FF_DEBUG_STARTCODE 0x00000100
1371 #define FF_DEBUG_PTS       0x00000200
1372 #define FF_DEBUG_ER        0x00000400
1373 #define FF_DEBUG_MMCO      0x00000800
1374 #define FF_DEBUG_BUGS      0x00001000
1375 #define FF_DEBUG_VIS_QP    0x00002000
1376 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1377
1378     /**
1379      * debug
1380      * - encoding: Set by user.
1381      * - decoding: Set by user.
1382      */
1383     int debug_mv;
1384 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1385 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1386 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1387
1388     /**
1389      * error
1390      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1391      * - decoding: unused
1392      */
1393     uint64_t error[4];
1394
1395     /**
1396      * minimum MB quantizer
1397      * - encoding: unused
1398      * - decoding: unused
1399      */
1400     int mb_qmin;
1401
1402     /**
1403      * maximum MB quantizer
1404      * - encoding: unused
1405      * - decoding: unused
1406      */
1407     int mb_qmax;
1408
1409     /**
1410      * motion estimation comparison function
1411      * - encoding: Set by user.
1412      * - decoding: unused
1413      */
1414     int me_cmp;
1415     /**
1416      * subpixel motion estimation comparison function
1417      * - encoding: Set by user.
1418      * - decoding: unused
1419      */
1420     int me_sub_cmp;
1421     /**
1422      * macroblock comparison function (not supported yet)
1423      * - encoding: Set by user.
1424      * - decoding: unused
1425      */
1426     int mb_cmp;
1427     /**
1428      * interlaced DCT comparison function
1429      * - encoding: Set by user.
1430      * - decoding: unused
1431      */
1432     int ildct_cmp;
1433 #define FF_CMP_SAD  0
1434 #define FF_CMP_SSE  1
1435 #define FF_CMP_SATD 2
1436 #define FF_CMP_DCT  3
1437 #define FF_CMP_PSNR 4
1438 #define FF_CMP_BIT  5
1439 #define FF_CMP_RD   6
1440 #define FF_CMP_ZERO 7
1441 #define FF_CMP_VSAD 8
1442 #define FF_CMP_VSSE 9
1443 #define FF_CMP_NSSE 10
1444 #define FF_CMP_W53  11
1445 #define FF_CMP_W97  12
1446 #define FF_CMP_DCTMAX 13
1447 #define FF_CMP_DCT264 14
1448 #define FF_CMP_CHROMA 256
1449
1450     /**
1451      * ME diamond size & shape
1452      * - encoding: Set by user.
1453      * - decoding: unused
1454      */
1455     int dia_size;
1456
1457     /**
1458      * amount of previous MV predictors (2a+1 x 2a+1 square)
1459      * - encoding: Set by user.
1460      * - decoding: unused
1461      */
1462     int last_predictor_count;
1463
1464     /**
1465      * prepass for motion estimation
1466      * - encoding: Set by user.
1467      * - decoding: unused
1468      */
1469     int pre_me;
1470
1471     /**
1472      * motion estimation prepass comparison function
1473      * - encoding: Set by user.
1474      * - decoding: unused
1475      */
1476     int me_pre_cmp;
1477
1478     /**
1479      * ME prepass diamond size & shape
1480      * - encoding: Set by user.
1481      * - decoding: unused
1482      */
1483     int pre_dia_size;
1484
1485     /**
1486      * subpel ME quality
1487      * - encoding: Set by user.
1488      * - decoding: unused
1489      */
1490     int me_subpel_quality;
1491
1492     /**
1493      * callback to negotiate the pixelFormat
1494      * @param fmt is the list of formats which are supported by the codec,
1495      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1496      * The first is always the native one.
1497      * @return the chosen format
1498      * - encoding: unused
1499      * - decoding: Set by user, if not set the native format will be chosen.
1500      */
1501     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1502
1503     /**
1504      * DTG active format information (additional aspect ratio
1505      * information only used in DVB MPEG-2 transport streams)
1506      * 0 if not set.
1507      *
1508      * - encoding: unused
1509      * - decoding: Set by decoder.
1510      */
1511     int dtg_active_format;
1512 #define FF_DTG_AFD_SAME         8
1513 #define FF_DTG_AFD_4_3          9
1514 #define FF_DTG_AFD_16_9         10
1515 #define FF_DTG_AFD_14_9         11
1516 #define FF_DTG_AFD_4_3_SP_14_9  13
1517 #define FF_DTG_AFD_16_9_SP_14_9 14
1518 #define FF_DTG_AFD_SP_4_3       15
1519
1520     /**
1521      * maximum motion estimation search range in subpel units
1522      * If 0 then no limit.
1523      *
1524      * - encoding: Set by user.
1525      * - decoding: unused
1526      */
1527     int me_range;
1528
1529     /**
1530      * intra quantizer bias
1531      * - encoding: Set by user.
1532      * - decoding: unused
1533      */
1534     int intra_quant_bias;
1535 #define FF_DEFAULT_QUANT_BIAS 999999
1536
1537     /**
1538      * inter quantizer bias
1539      * - encoding: Set by user.
1540      * - decoding: unused
1541      */
1542     int inter_quant_bias;
1543
1544     /**
1545      * color table ID
1546      * - encoding: unused
1547      * - decoding: Which clrtable should be used for 8bit RGB images.
1548      *             Tables have to be stored somewhere. FIXME
1549      */
1550     int color_table_id;
1551
1552     /**
1553      * internal_buffer count
1554      * Don't touch, used by libavcodec default_get_buffer().
1555      */
1556     int internal_buffer_count;
1557
1558     /**
1559      * internal_buffers
1560      * Don't touch, used by libavcodec default_get_buffer().
1561      */
1562     void *internal_buffer;
1563
1564 #define FF_LAMBDA_SHIFT 7
1565 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1566 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1567 #define FF_LAMBDA_MAX (256*128-1)
1568
1569 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1570     /**
1571      * Global quality for codecs which cannot change it per frame.
1572      * This should be proportional to MPEG-1/2/4 qscale.
1573      * - encoding: Set by user.
1574      * - decoding: unused
1575      */
1576     int global_quality;
1577
1578 #define FF_CODER_TYPE_VLC       0
1579 #define FF_CODER_TYPE_AC        1
1580 #define FF_CODER_TYPE_RAW       2
1581 #define FF_CODER_TYPE_RLE       3
1582 #define FF_CODER_TYPE_DEFLATE   4
1583     /**
1584      * coder type
1585      * - encoding: Set by user.
1586      * - decoding: unused
1587      */
1588     int coder_type;
1589
1590     /**
1591      * context model
1592      * - encoding: Set by user.
1593      * - decoding: unused
1594      */
1595     int context_model;
1596 #if 0
1597     /**
1598      *
1599      * - encoding: unused
1600      * - decoding: Set by user.
1601      */
1602     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1603 #endif
1604
1605     /**
1606      * slice flags
1607      * - encoding: unused
1608      * - decoding: Set by user.
1609      */
1610     int slice_flags;
1611 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1612 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1613 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1614
1615     /**
1616      * XVideo Motion Acceleration
1617      * - encoding: forbidden
1618      * - decoding: set by decoder
1619      */
1620     int xvmc_acceleration;
1621
1622     /**
1623      * macroblock decision mode
1624      * - encoding: Set by user.
1625      * - decoding: unused
1626      */
1627     int mb_decision;
1628 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1629 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1630 #define FF_MB_DECISION_RD     2        ///< rate distoration
1631
1632     /**
1633      * custom intra quantization matrix
1634      * - encoding: Set by user, can be NULL.
1635      * - decoding: Set by libavcodec.
1636      */
1637     uint16_t *intra_matrix;
1638
1639     /**
1640      * custom inter quantization matrix
1641      * - encoding: Set by user, can be NULL.
1642      * - decoding: Set by libavcodec.
1643      */
1644     uint16_t *inter_matrix;
1645
1646     /**
1647      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1648      * This is used to work around some encoder bugs.
1649      * - encoding: unused
1650      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1651      */
1652     unsigned int stream_codec_tag;
1653
1654     /**
1655      * scene change detection threshold
1656      * 0 is default, larger means fewer detected scene changes.
1657      * - encoding: Set by user.
1658      * - decoding: unused
1659      */
1660     int scenechange_threshold;
1661
1662     /**
1663      * minimum Lagrange multipler
1664      * - encoding: Set by user.
1665      * - decoding: unused
1666      */
1667     int lmin;
1668
1669     /**
1670      * maximum Lagrange multipler
1671      * - encoding: Set by user.
1672      * - decoding: unused
1673      */
1674     int lmax;
1675
1676     /**
1677      * palette control structure
1678      * - encoding: ??? (no palette-enabled encoder yet)
1679      * - decoding: Set by user.
1680      */
1681     struct AVPaletteControl *palctrl;
1682
1683     /**
1684      * noise reduction strength
1685      * - encoding: Set by user.
1686      * - decoding: unused
1687      */
1688     int noise_reduction;
1689
1690     /**
1691      * Called at the beginning of a frame to get cr buffer for it.
1692      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1693      * libavcodec will pass previous buffer in pic, function should return
1694      * same buffer or new buffer with old frame "painted" into it.
1695      * If pic.data[0] == NULL must behave like get_buffer().
1696      * - encoding: unused
1697      * - decoding: Set by libavcodec., user can override
1698      */
1699     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1700
1701     /**
1702      * Number of bits which should be loaded into the rc buffer before decoding starts.
1703      * - encoding: Set by user.
1704      * - decoding: unused
1705      */
1706     int rc_initial_buffer_occupancy;
1707
1708     /**
1709      *
1710      * - encoding: Set by user.
1711      * - decoding: unused
1712      */
1713     int inter_threshold;
1714
1715     /**
1716      * CODEC_FLAG2_*
1717      * - encoding: Set by user.
1718      * - decoding: Set by user.
1719      */
1720     int flags2;
1721
1722     /**
1723      * Simulates errors in the bitstream to test error concealment.
1724      * - encoding: Set by user.
1725      * - decoding: unused
1726      */
1727     int error_rate;
1728
1729     /**
1730      * MP3 antialias algorithm, see FF_AA_* below.
1731      * - encoding: unused
1732      * - decoding: Set by user.
1733      */
1734     int antialias_algo;
1735 #define FF_AA_AUTO    0
1736 #define FF_AA_FASTINT 1 //not implemented yet
1737 #define FF_AA_INT     2
1738 #define FF_AA_FLOAT   3
1739     /**
1740      * quantizer noise shaping
1741      * - encoding: Set by user.
1742      * - decoding: unused
1743      */
1744     int quantizer_noise_shaping;
1745
1746     /**
1747      * thread count
1748      * is used to decide how many independent tasks should be passed to execute()
1749      * - encoding: Set by user.
1750      * - decoding: Set by user.
1751      */
1752     int thread_count;
1753
1754     /**
1755      * The codec may call this to execute several independent things.
1756      * It will return only after finishing all tasks.
1757      * The user may replace this with some multithreaded implementation,
1758      * the default implementation will execute the parts serially.
1759      * @param count the number of things to execute
1760      * - encoding: Set by libavcodec, user can override.
1761      * - decoding: Set by libavcodec, user can override.
1762      */
1763     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1764
1765     /**
1766      * thread opaque
1767      * Can be used by execute() to store some per AVCodecContext stuff.
1768      * - encoding: set by execute()
1769      * - decoding: set by execute()
1770      */
1771     void *thread_opaque;
1772
1773     /**
1774      * Motion estimation threshold below which no motion estimation is
1775      * performed, but instead the user specified motion vectors are used.
1776      *
1777      * - encoding: Set by user.
1778      * - decoding: unused
1779      */
1780      int me_threshold;
1781
1782     /**
1783      * Macroblock threshold below which the user specified macroblock types will be used.
1784      * - encoding: Set by user.
1785      * - decoding: unused
1786      */
1787      int mb_threshold;
1788
1789     /**
1790      * precision of the intra DC coefficient - 8
1791      * - encoding: Set by user.
1792      * - decoding: unused
1793      */
1794      int intra_dc_precision;
1795
1796     /**
1797      * noise vs. sse weight for the nsse comparsion function
1798      * - encoding: Set by user.
1799      * - decoding: unused
1800      */
1801      int nsse_weight;
1802
1803     /**
1804      * Number of macroblock rows at the top which are skipped.
1805      * - encoding: unused
1806      * - decoding: Set by user.
1807      */
1808      int skip_top;
1809
1810     /**
1811      * Number of macroblock rows at the bottom which are skipped.
1812      * - encoding: unused
1813      * - decoding: Set by user.
1814      */
1815      int skip_bottom;
1816
1817     /**
1818      * profile
1819      * - encoding: Set by user.
1820      * - decoding: Set by libavcodec.
1821      */
1822      int profile;
1823 #define FF_PROFILE_UNKNOWN -99
1824 #define FF_PROFILE_AAC_MAIN 0
1825 #define FF_PROFILE_AAC_LOW 1
1826 #define FF_PROFILE_AAC_SSR 2
1827 #define FF_PROFILE_AAC_LTP 3
1828
1829     /**
1830      * level
1831      * - encoding: Set by user.
1832      * - decoding: Set by libavcodec.
1833      */
1834      int level;
1835 #define FF_LEVEL_UNKNOWN -99
1836
1837     /**
1838      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1839      * - encoding: unused
1840      * - decoding: Set by user.
1841      */
1842      int lowres;
1843
1844     /**
1845      * Bitstream width / height, may be different from width/height if lowres
1846      * or other things are used.
1847      * - encoding: unused
1848      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1849      */
1850     int coded_width, coded_height;
1851
1852     /**
1853      * frame skip threshold
1854      * - encoding: Set by user.
1855      * - decoding: unused
1856      */
1857     int frame_skip_threshold;
1858
1859     /**
1860      * frame skip factor
1861      * - encoding: Set by user.
1862      * - decoding: unused
1863      */
1864     int frame_skip_factor;
1865
1866     /**
1867      * frame skip exponent
1868      * - encoding: Set by user.
1869      * - decoding: unused
1870      */
1871     int frame_skip_exp;
1872
1873     /**
1874      * frame skip comparison function
1875      * - encoding: Set by user.
1876      * - decoding: unused
1877      */
1878     int frame_skip_cmp;
1879
1880     /**
1881      * Border processing masking, raises the quantizer for mbs on the borders
1882      * of the picture.
1883      * - encoding: Set by user.
1884      * - decoding: unused
1885      */
1886     float border_masking;
1887
1888     /**
1889      * minimum MB lagrange multipler
1890      * - encoding: Set by user.
1891      * - decoding: unused
1892      */
1893     int mb_lmin;
1894
1895     /**
1896      * maximum MB lagrange multipler
1897      * - encoding: Set by user.
1898      * - decoding: unused
1899      */
1900     int mb_lmax;
1901
1902     /**
1903      *
1904      * - encoding: Set by user.
1905      * - decoding: unused
1906      */
1907     int me_penalty_compensation;
1908
1909     /**
1910      *
1911      * - encoding: unused
1912      * - decoding: Set by user.
1913      */
1914     enum AVDiscard skip_loop_filter;
1915
1916     /**
1917      *
1918      * - encoding: unused
1919      * - decoding: Set by user.
1920      */
1921     enum AVDiscard skip_idct;
1922
1923     /**
1924      *
1925      * - encoding: unused
1926      * - decoding: Set by user.
1927      */
1928     enum AVDiscard skip_frame;
1929
1930     /**
1931      *
1932      * - encoding: Set by user.
1933      * - decoding: unused
1934      */
1935     int bidir_refine;
1936
1937     /**
1938      *
1939      * - encoding: Set by user.
1940      * - decoding: unused
1941      */
1942     int brd_scale;
1943
1944     /**
1945      * constant rate factor - quality-based VBR - values ~correspond to qps
1946      * - encoding: Set by user.
1947      * - decoding: unused
1948      */
1949     float crf;
1950
1951     /**
1952      * constant quantization parameter rate control method
1953      * - encoding: Set by user.
1954      * - decoding: unused
1955      */
1956     int cqp;
1957
1958     /**
1959      * minimum GOP size
1960      * - encoding: Set by user.
1961      * - decoding: unused
1962      */
1963     int keyint_min;
1964
1965     /**
1966      * number of reference frames
1967      * - encoding: Set by user.
1968      * - decoding: unused
1969      */
1970     int refs;
1971
1972     /**
1973      * chroma qp offset from luma
1974      * - encoding: Set by user.
1975      * - decoding: unused
1976      */
1977     int chromaoffset;
1978
1979     /**
1980      * Influences how often B-frames are used.
1981      * - encoding: Set by user.
1982      * - decoding: unused
1983      */
1984     int bframebias;
1985
1986     /**
1987      * trellis RD quantization
1988      * - encoding: Set by user.
1989      * - decoding: unused
1990      */
1991     int trellis;
1992
1993     /**
1994      * Reduce fluctuations in qp (before curve compression).
1995      * - encoding: Set by user.
1996      * - decoding: unused
1997      */
1998     float complexityblur;
1999
2000     /**
2001      * in-loop deblocking filter alphac0 parameter
2002      * alpha is in the range -6...6
2003      * - encoding: Set by user.
2004      * - decoding: unused
2005      */
2006     int deblockalpha;
2007
2008     /**
2009      * in-loop deblocking filter beta parameter
2010      * beta is in the range -6...6
2011      * - encoding: Set by user.
2012      * - decoding: unused
2013      */
2014     int deblockbeta;
2015
2016     /**
2017      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2018      * - encoding: Set by user.
2019      * - decoding: unused
2020      */
2021     int partitions;
2022 #define X264_PART_I4X4 0x001  /* Analyse i4x4 */
2023 #define X264_PART_I8X8 0x002  /* Analyse i8x8 (requires 8x8 transform) */
2024 #define X264_PART_P8X8 0x010  /* Analyse p16x8, p8x16 and p8x8 */
2025 #define X264_PART_P4X4 0x020  /* Analyse p8x4, p4x8, p4x4 */
2026 #define X264_PART_B8X8 0x100  /* Analyse b16x8, b8x16 and b8x8 */
2027
2028     /**
2029      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2030      * - encoding: Set by user.
2031      * - decoding: unused
2032      */
2033     int directpred;
2034
2035     /**
2036      * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2037      * - encoding: Set by user.
2038      * - decoding: unused
2039      */
2040     int cutoff;
2041
2042     /**
2043      * Multiplied by qscale for each frame and added to scene_change_score.
2044      * - encoding: Set by user.
2045      * - decoding: unused
2046      */
2047     int scenechange_factor;
2048
2049     /**
2050      *
2051      * Note: Value depends upon the compare function used for fullpel ME.
2052      * - encoding: Set by user.
2053      * - decoding: unused
2054      */
2055     int mv0_threshold;
2056
2057     /**
2058      * Adjusts sensitivity of b_frame_strategy 1.
2059      * - encoding: Set by user.
2060      * - decoding: unused
2061      */
2062     int b_sensitivity;
2063
2064     /**
2065      * - encoding: Set by user.
2066      * - decoding: unused
2067      */
2068     int compression_level;
2069 #define FF_COMPRESSION_DEFAULT -1
2070
2071     /**
2072      * Sets whether to use LPC mode - used by FLAC encoder.
2073      * - encoding: Set by user.
2074      * - decoding: unused
2075      */
2076     int use_lpc;
2077
2078     /**
2079      * LPC coefficient precision - used by FLAC encoder
2080      * - encoding: Set by user.
2081      * - decoding: unused
2082      */
2083     int lpc_coeff_precision;
2084
2085     /**
2086      * - encoding: Set by user.
2087      * - decoding: unused
2088      */
2089     int min_prediction_order;
2090
2091     /**
2092      * - encoding: Set by user.
2093      * - decoding: unused
2094      */
2095     int max_prediction_order;
2096
2097     /**
2098      * search method for selecting prediction order
2099      * - encoding: Set by user.
2100      * - decoding: unused
2101      */
2102     int prediction_order_method;
2103
2104     /**
2105      * - encoding: Set by user.
2106      * - decoding: unused
2107      */
2108     int min_partition_order;
2109
2110     /**
2111      * - encoding: Set by user.
2112      * - decoding: unused
2113      */
2114     int max_partition_order;
2115
2116     /**
2117      * GOP timecode frame start number, in non drop frame format
2118      * - encoding: Set by user.
2119      * - decoding: unused
2120      */
2121     int64_t timecode_frame_start;
2122 } AVCodecContext;
2123
2124 /**
2125  * AVCodec.
2126  */
2127 typedef struct AVCodec {
2128     const char *name;
2129     enum CodecType type;
2130     enum CodecID id;
2131     int priv_data_size;
2132     int (*init)(AVCodecContext *);
2133     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2134     int (*close)(AVCodecContext *);
2135     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2136                   uint8_t *buf, int buf_size);
2137     int capabilities;
2138     struct AVCodec *next;
2139     void (*flush)(AVCodecContext *);
2140     const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2141     const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2142 } AVCodec;
2143
2144 /**
2145  * four components are given, that's all.
2146  * the last component is alpha
2147  */
2148 typedef struct AVPicture {
2149     uint8_t *data[4];
2150     int linesize[4];       ///< number of bytes per line
2151 } AVPicture;
2152
2153 /**
2154  * AVPaletteControl
2155  * This structure defines a method for communicating palette changes
2156  * between and demuxer and a decoder.
2157  *
2158  * @deprecated Use AVPacket to send palette changes instead.
2159  * This is totally broken.
2160  */
2161 #define AVPALETTE_SIZE 1024
2162 #define AVPALETTE_COUNT 256
2163 typedef struct AVPaletteControl {
2164
2165     /* Demuxer sets this to 1 to indicate the palette has changed;
2166      * decoder resets to 0. */
2167     int palette_changed;
2168
2169     /* 4-byte ARGB palette entries, stored in native byte order; note that
2170      * the individual palette components should be on a 8-bit scale; if
2171      * the palette data comes from an IBM VGA native format, the component
2172      * data is probably 6 bits in size and needs to be scaled. */
2173     unsigned int palette[AVPALETTE_COUNT];
2174
2175 } AVPaletteControl attribute_deprecated;
2176
2177 typedef struct AVSubtitleRect {
2178     uint16_t x;
2179     uint16_t y;
2180     uint16_t w;
2181     uint16_t h;
2182     uint16_t nb_colors;
2183     int linesize;
2184     uint32_t *rgba_palette;
2185     uint8_t *bitmap;
2186 } AVSubtitleRect;
2187
2188 typedef struct AVSubtitle {
2189     uint16_t format; /* 0 = graphics */
2190     uint32_t start_display_time; /* relative to packet pts, in ms */
2191     uint32_t end_display_time; /* relative to packet pts, in ms */
2192     uint32_t num_rects;
2193     AVSubtitleRect *rects;
2194 } AVSubtitle;
2195
2196 extern AVCodec ac3_encoder;
2197 extern AVCodec asv1_encoder;
2198 extern AVCodec asv2_encoder;
2199 extern AVCodec bmp_encoder;
2200 extern AVCodec dvvideo_encoder;
2201 extern AVCodec ffv1_encoder;
2202 extern AVCodec ffvhuff_encoder;
2203 extern AVCodec flac_encoder;
2204 extern AVCodec flashsv_encoder;
2205 extern AVCodec flv_encoder;
2206 extern AVCodec gif_encoder;
2207 extern AVCodec h261_encoder;
2208 extern AVCodec h263_encoder;
2209 extern AVCodec h263p_encoder;
2210 extern AVCodec h264_encoder;
2211 extern AVCodec huffyuv_encoder;
2212 extern AVCodec jpegls_encoder;
2213 extern AVCodec ljpeg_encoder;
2214 extern AVCodec mdec_encoder;
2215 extern AVCodec mjpeg_encoder;
2216 extern AVCodec mp2_encoder;
2217 extern AVCodec mpeg1video_encoder;
2218 extern AVCodec mpeg2video_encoder;
2219 extern AVCodec mpeg4_encoder;
2220 extern AVCodec msmpeg4v1_encoder;
2221 extern AVCodec msmpeg4v2_encoder;
2222 extern AVCodec msmpeg4v3_encoder;
2223 extern AVCodec pam_encoder;
2224 extern AVCodec pbm_encoder;
2225 extern AVCodec pgm_encoder;
2226 extern AVCodec pgmyuv_encoder;
2227 extern AVCodec png_encoder;
2228 extern AVCodec ppm_encoder;
2229 extern AVCodec roq_dpcm_encoder;
2230 extern AVCodec rv10_encoder;
2231 extern AVCodec rv20_encoder;
2232 extern AVCodec sgi_encoder;
2233 extern AVCodec snow_encoder;
2234 extern AVCodec sonic_encoder;
2235 extern AVCodec sonic_ls_encoder;
2236 extern AVCodec svq1_encoder;
2237 extern AVCodec targa_encoder;
2238 extern AVCodec tiff_encoder;
2239 extern AVCodec vcr1_encoder;
2240 extern AVCodec vorbis_encoder;
2241 extern AVCodec wmav1_encoder;
2242 extern AVCodec wmav2_encoder;
2243 extern AVCodec wmv1_encoder;
2244 extern AVCodec wmv2_encoder;
2245 extern AVCodec zmbv_encoder;
2246
2247 extern AVCodec aasc_decoder;
2248 extern AVCodec alac_decoder;
2249 extern AVCodec asv1_decoder;
2250 extern AVCodec asv2_decoder;
2251 extern AVCodec atrac3_decoder;
2252 extern AVCodec avs_decoder;
2253 extern AVCodec bethsoftvid_decoder;
2254 extern AVCodec bmp_decoder;
2255 extern AVCodec c93_decoder;
2256 extern AVCodec cavs_decoder;
2257 extern AVCodec cinepak_decoder;
2258 extern AVCodec cljr_decoder;
2259 extern AVCodec cook_decoder;
2260 extern AVCodec cscd_decoder;
2261 extern AVCodec cyuv_decoder;
2262 extern AVCodec dca_decoder;
2263 extern AVCodec dnxhd_decoder;
2264 extern AVCodec dsicinaudio_decoder;
2265 extern AVCodec dsicinvideo_decoder;
2266 extern AVCodec dvvideo_decoder;
2267 extern AVCodec dxa_decoder;
2268 extern AVCodec eightbps_decoder;
2269 extern AVCodec ffv1_decoder;
2270 extern AVCodec ffvhuff_decoder;
2271 extern AVCodec flac_decoder;
2272 extern AVCodec flashsv_decoder;
2273 extern AVCodec flic_decoder;
2274 extern AVCodec flv_decoder;
2275 extern AVCodec fourxm_decoder;
2276 extern AVCodec fraps_decoder;
2277 extern AVCodec gif_decoder;
2278 extern AVCodec h261_decoder;
2279 extern AVCodec h263_decoder;
2280 extern AVCodec h263i_decoder;
2281 extern AVCodec h264_decoder;
2282 extern AVCodec huffyuv_decoder;
2283 extern AVCodec idcin_decoder;
2284 extern AVCodec imc_decoder;
2285 extern AVCodec indeo2_decoder;
2286 extern AVCodec indeo3_decoder;
2287 extern AVCodec interplay_dpcm_decoder;
2288 extern AVCodec interplay_video_decoder;
2289 extern AVCodec kmvc_decoder;
2290 extern AVCodec loco_decoder;
2291 extern AVCodec mace3_decoder;
2292 extern AVCodec mace6_decoder;
2293 extern AVCodec mdec_decoder;
2294 extern AVCodec mjpeg_decoder;
2295 extern AVCodec mjpegb_decoder;
2296 extern AVCodec mmvideo_decoder;
2297 extern AVCodec mp2_decoder;
2298 extern AVCodec mp3_decoder;
2299 extern AVCodec mp3adu_decoder;
2300 extern AVCodec mp3on4_decoder;
2301 extern AVCodec mpc7_decoder;
2302 extern AVCodec mpeg1video_decoder;
2303 extern AVCodec mpeg2video_decoder;
2304 extern AVCodec mpeg4_decoder;
2305 extern AVCodec mpeg_xvmc_decoder;
2306 extern AVCodec mpegvideo_decoder;
2307 extern AVCodec msmpeg4v1_decoder;
2308 extern AVCodec msmpeg4v2_decoder;
2309 extern AVCodec msmpeg4v3_decoder;
2310 extern AVCodec msrle_decoder;
2311 extern AVCodec msvideo1_decoder;
2312 extern AVCodec mszh_decoder;
2313 extern AVCodec nuv_decoder;
2314 extern AVCodec png_decoder;
2315 extern AVCodec ptx_decoder;
2316 extern AVCodec qdm2_decoder;
2317 extern AVCodec qdraw_decoder;
2318 extern AVCodec qpeg_decoder;
2319 extern AVCodec qtrle_decoder;
2320 extern AVCodec ra_144_decoder;
2321 extern AVCodec ra_288_decoder;
2322 extern AVCodec roq_decoder;
2323 extern AVCodec roq_dpcm_decoder;
2324 extern AVCodec rpza_decoder;
2325 extern AVCodec rv10_decoder;
2326 extern AVCodec rv20_decoder;
2327 extern AVCodec rv30_decoder;
2328 extern AVCodec rv40_decoder;
2329 extern AVCodec sgi_decoder;
2330 extern AVCodec shorten_decoder;
2331 extern AVCodec smackaud_decoder;
2332 extern AVCodec smacker_decoder;
2333 extern AVCodec smc_decoder;
2334 extern AVCodec snow_decoder;
2335 extern AVCodec sol_dpcm_decoder;
2336 extern AVCodec sonic_decoder;
2337 extern AVCodec sp5x_decoder;
2338 extern AVCodec svq1_decoder;
2339 extern AVCodec svq3_decoder;
2340 extern AVCodec targa_decoder;
2341 extern AVCodec theora_decoder;
2342 extern AVCodec thp_decoder;
2343 extern AVCodec tiertexseqvideo_decoder;
2344 extern AVCodec tiff_decoder;
2345 extern AVCodec truemotion1_decoder;
2346 extern AVCodec truemotion2_decoder;
2347 extern AVCodec truespeech_decoder;
2348 extern AVCodec tscc_decoder;
2349 extern AVCodec tta_decoder;
2350 extern AVCodec txd_decoder;
2351 extern AVCodec ulti_decoder;
2352 extern AVCodec vc1_decoder;
2353 extern AVCodec vcr1_decoder;
2354 extern AVCodec vmdaudio_decoder;
2355 extern AVCodec vmdvideo_decoder;
2356 extern AVCodec vmnc_decoder;
2357 extern AVCodec vorbis_decoder;
2358 extern AVCodec vp3_decoder;
2359 extern AVCodec vp5_decoder;
2360 extern AVCodec vp6_decoder;
2361 extern AVCodec vp6f_decoder;
2362 extern AVCodec vqa_decoder;
2363 extern AVCodec wavpack_decoder;
2364 extern AVCodec wmav1_decoder;
2365 extern AVCodec wmav2_decoder;
2366 extern AVCodec wmv1_decoder;
2367 extern AVCodec wmv2_decoder;
2368 extern AVCodec wmv3_decoder;
2369 extern AVCodec wnv1_decoder;
2370 extern AVCodec ws_snd1_decoder;
2371 extern AVCodec xan_dpcm_decoder;
2372 extern AVCodec xan_wc3_decoder;
2373 extern AVCodec xl_decoder;
2374 extern AVCodec zmbv_decoder;
2375
2376 /* PCM codecs */
2377 #define PCM_CODEC(id, name) \
2378 extern AVCodec name ## _decoder; \
2379 extern AVCodec name ## _encoder
2380
2381 PCM_CODEC(CODEC_ID_PCM_ALAW,    pcm_alaw);
2382 PCM_CODEC(CODEC_ID_PCM_MULAW,   pcm_mulaw);
2383 PCM_CODEC(CODEC_ID_PCM_S8,      pcm_s8);
2384 PCM_CODEC(CODEC_ID_PCM_S16BE,   pcm_s16be);
2385 PCM_CODEC(CODEC_ID_PCM_S16LE,   pcm_s16le);
2386 PCM_CODEC(CODEC_ID_PCM_S24BE,   pcm_s24be);
2387 PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
2388 PCM_CODEC(CODEC_ID_PCM_S24LE,   pcm_s24le);
2389 PCM_CODEC(CODEC_ID_PCM_S32BE,   pcm_s32be);
2390 PCM_CODEC(CODEC_ID_PCM_S32LE,   pcm_s32le);
2391 PCM_CODEC(CODEC_ID_PCM_U8,      pcm_u8);
2392 PCM_CODEC(CODEC_ID_PCM_U16BE,   pcm_u16be);
2393 PCM_CODEC(CODEC_ID_PCM_U16LE,   pcm_u16le);
2394 PCM_CODEC(CODEC_ID_PCM_U24BE,   pcm_u24be);
2395 PCM_CODEC(CODEC_ID_PCM_U24LE,   pcm_u24le);
2396 PCM_CODEC(CODEC_ID_PCM_U32BE,   pcm_u32be);
2397 PCM_CODEC(CODEC_ID_PCM_U32LE,   pcm_u32le);
2398
2399 /* ADPCM codecs */
2400
2401 PCM_CODEC(CODEC_ID_ADPCM_4XM,     adpcm_4xm);
2402 PCM_CODEC(CODEC_ID_ADPCM_ADX,     adpcm_adx);
2403 PCM_CODEC(CODEC_ID_ADPCM_CT,      adpcm_ct);
2404 PCM_CODEC(CODEC_ID_ADPCM_EA,      adpcm_ea);
2405 PCM_CODEC(CODEC_ID_ADPCM_G726,    adpcm_g726);
2406 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
2407 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2408 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT,  adpcm_ima_qt);
2409 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2410 PCM_CODEC(CODEC_ID_ADPCM_IMA_WS,  adpcm_ima_ws);
2411 PCM_CODEC(CODEC_ID_ADPCM_MS,      adpcm_ms);
2412 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
2413 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_3, adpcm_sbpro_3);
2414 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_4, adpcm_sbpro_4);
2415 PCM_CODEC(CODEC_ID_ADPCM_SMJPEG,  adpcm_ima_smjpeg);
2416 PCM_CODEC(CODEC_ID_ADPCM_SWF,     adpcm_swf);
2417 PCM_CODEC(CODEC_ID_ADPCM_THP,     adpcm_thp);
2418 PCM_CODEC(CODEC_ID_ADPCM_XA,      adpcm_xa);
2419 PCM_CODEC(CODEC_ID_ADPCM_YAMAHA,  adpcm_yamaha);
2420
2421 #undef PCM_CODEC
2422
2423 /* dummy raw video codec */
2424 extern AVCodec rawvideo_decoder;
2425 extern AVCodec rawvideo_encoder;
2426
2427 /* the following codecs use external libs */
2428 extern AVCodec aac_decoder;
2429 extern AVCodec faac_encoder;
2430 extern AVCodec liba52_decoder;
2431 extern AVCodec libamr_nb_decoder;
2432 extern AVCodec libamr_nb_encoder;
2433 extern AVCodec libamr_wb_decoder;
2434 extern AVCodec libamr_wb_encoder;
2435 extern AVCodec libdts_decoder;
2436 extern AVCodec libgsm_decoder;
2437 extern AVCodec libgsm_encoder;
2438 extern AVCodec libgsm_ms_decoder;
2439 extern AVCodec libgsm_ms_encoder;
2440 extern AVCodec libtheora_encoder;
2441 extern AVCodec libvorbis_decoder;
2442 extern AVCodec libvorbis_encoder;
2443 extern AVCodec mp3lame_encoder;
2444 extern AVCodec mpeg4aac_decoder;
2445 extern AVCodec x264_encoder;
2446 extern AVCodec xvid_encoder;
2447 extern AVCodec zlib_decoder;
2448 extern AVCodec zlib_encoder;
2449
2450 /* subtitles */
2451 extern AVCodec dvbsub_decoder;
2452 extern AVCodec dvbsub_encoder;
2453 extern AVCodec dvdsub_decoder;
2454 extern AVCodec dvdsub_encoder;
2455
2456 /* resample.c */
2457
2458 struct ReSampleContext;
2459 struct AVResampleContext;
2460
2461 typedef struct ReSampleContext ReSampleContext;
2462
2463 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2464                                      int output_rate, int input_rate);
2465 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2466 void audio_resample_close(ReSampleContext *s);
2467
2468 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2469 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2470 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2471 void av_resample_close(struct AVResampleContext *c);
2472
2473 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2474 /* YUV420 format is assumed ! */
2475
2476 /**
2477  * @deprecated Use the software scaler (swscale) instead.
2478  */
2479 struct ImgReSampleContext attribute_deprecated;
2480
2481 /**
2482  * @deprecated Use the software scaler (swscale) instead.
2483  */
2484 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2485
2486 /**
2487  * @deprecated Use the software scaler (swscale) instead.
2488  */
2489 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2490                                       int input_width, int input_height);
2491
2492 /**
2493  * @deprecated Use the software scaler (swscale) instead.
2494  */
2495 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2496                                       int iwidth, int iheight,
2497                                       int topBand, int bottomBand,
2498                                       int leftBand, int rightBand,
2499                                       int padtop, int padbottom,
2500                                       int padleft, int padright);
2501
2502 /**
2503  * @deprecated Use the software scaler (swscale) instead.
2504  */
2505 attribute_deprecated void img_resample(ImgReSampleContext *s,
2506                   AVPicture *output, const AVPicture *input);
2507
2508 /**
2509  * @deprecated Use the software scaler (swscale) instead.
2510  */
2511 attribute_deprecated void img_resample_close(ImgReSampleContext *s);
2512
2513 #endif
2514
2515 /**
2516  * Allocate memory for a picture.  Call avpicture_free to free it.
2517  *
2518  * @param picture the picture to be filled in
2519  * @param pix_fmt the format of the picture
2520  * @param width the width of the picture
2521  * @param height the height of the picture
2522  * @return zero if successful, a negative value if not
2523  */
2524 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2525
2526 /**
2527  * Free a picture previously allocated by avpicture_alloc().
2528  *
2529  * @param picture the AVPicture to be freed
2530  */
2531 void avpicture_free(AVPicture *picture);
2532
2533 /**
2534  * Fill in the AVPicture fields.
2535  * The fields of the given AVPicture are filled in by using the 'ptr' address
2536  * which points to the image data buffer. Depending on the specified picture
2537  * format, one or multiple image data pointers and line sizes will be set.
2538  * If a planar format is specified, several pointers will be set pointing to
2539  * the different picture planes and the line sizes of the different planes
2540  * will be stored in the lines_sizes array.
2541  *
2542  * @param picture AVPicture whose fields are to be filled in
2543  * @param ptr Buffer which will contain or contains the actual image data
2544  * @param pix_fmt The format in which the picture data is stored.
2545  * @param width the width of the image in pixels
2546  * @param height the height of the image in pixels
2547  * @return size of the image data in bytes
2548  */
2549 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2550                    int pix_fmt, int width, int height);
2551 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2552                      unsigned char *dest, int dest_size);
2553
2554 /**
2555  * Calculate the size in bytes that a picture of the given width and height
2556  * would occupy if stored in the given picture format.
2557  *
2558  * @param pix_fmt the given picture format
2559  * @param width the width of the image
2560  * @param height the height of the image
2561  * @return Image data size in bytes
2562  */
2563 int avpicture_get_size(int pix_fmt, int width, int height);
2564 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2565 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2566 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2567 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2568 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2569
2570 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2571 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2572 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2573 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2574 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2575 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2576
2577 /**
2578  * Computes what kind of losses will occur when converting from one specific
2579  * pixel format to another.
2580  * When converting from one pixel format to another, information loss may occur.
2581  * For example, when converting from RGB24 to GRAY, the color information will
2582  * be lost. Similarly, other losses occur when converting from some formats to
2583  * other formats. These losses can involve loss of chroma, but also loss of
2584  * resolution, loss of color depth, loss due to the color space conversion, loss
2585  * of the alpha bits or loss due to color quantization.
2586  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2587  * which will occur when converting from one pixel format to another.
2588  *
2589  * @param[in] dst_pix_fmt destination pixel format
2590  * @param[in] src_pix_fmt source pixel format
2591  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2592  * @return Combination of flags informing you what kind of losses will occur.
2593  */
2594 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2595                              int has_alpha);
2596
2597 /**
2598  * Finds the best pixel format to convert to given a certain source pixel
2599  * format.  When converting from one pixel format to another, information loss
2600  * may occur.  For example, when converting from RGB24 to GRAY, the color
2601  * information will be lost. Similarly, other losses occur when converting from
2602  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2603  * the given pixel formats should be used to suffer the least amount of loss.
2604  * The pixel formats from which it chooses one, are determined by the
2605  * \p pix_fmt_mask parameter.
2606  *
2607  * @code
2608  * src_pix_fmt = PIX_FMT_YUV420P;
2609  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2610  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2611  * @endcode
2612  *
2613  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2614  * @param[in] src_pix_fmt source pixel format
2615  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2616  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2617  * @return The best pixel format to convert to or -1 if none was found.
2618  */
2619 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2620                               int has_alpha, int *loss_ptr);
2621
2622 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2623 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2624
2625 /**
2626  * Tell if an image really has transparent alpha values.
2627  * @return ored mask of FF_ALPHA_xxx constants
2628  */
2629 int img_get_alpha_info(const AVPicture *src,
2630                        int pix_fmt, int width, int height);
2631
2632 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2633 /**
2634  * convert among pixel formats
2635  * @deprecated Use the software scaler (swscale) instead.
2636  */
2637 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2638                 const AVPicture *src, int pix_fmt,
2639                 int width, int height);
2640 #endif
2641
2642 /* deinterlace a picture */
2643 /* deinterlace - if not supported return -1 */
2644 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2645                           int pix_fmt, int width, int height);
2646
2647 /* external high level API */
2648
2649 extern AVCodec *first_avcodec;
2650
2651 /* returns LIBAVCODEC_VERSION_INT constant */
2652 unsigned avcodec_version(void);
2653 /* returns LIBAVCODEC_BUILD constant */
2654 unsigned avcodec_build(void);
2655
2656 /**
2657  * Initializes libavcodec.
2658  *
2659  * @warning This function \e must be called before any other libavcodec
2660  * function.
2661  */
2662 void avcodec_init(void);
2663
2664 void register_avcodec(AVCodec *format);
2665
2666 /**
2667  * Finds an encoder with a matching codec ID.
2668  *
2669  * @param id CodecID of the requested encoder
2670  * @return An encoder if one was found, NULL otherwise.
2671  */
2672 AVCodec *avcodec_find_encoder(enum CodecID id);
2673
2674 /**
2675  * Finds an encoder with the specified name.
2676  *
2677  * @param name name of the requested encoder
2678  * @return An encoder if one was found, NULL otherwise.
2679  */
2680 AVCodec *avcodec_find_encoder_by_name(const char *name);
2681
2682 /**
2683  * Finds a decoder with a matching codec ID.
2684  *
2685  * @param id CodecID of the requested decoder
2686  * @return A decoder if one was found, NULL otherwise.
2687  */
2688 AVCodec *avcodec_find_decoder(enum CodecID id);
2689
2690 /**
2691  * Finds an decoder with the specified name.
2692  *
2693  * @param name name of the requested decoder
2694  * @return A decoder if one was found, NULL otherwise.
2695  */
2696 AVCodec *avcodec_find_decoder_by_name(const char *name);
2697 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2698
2699 /**
2700  * Sets the fields of the given AVCodecContext to default values.
2701  *
2702  * @param s The AVCodecContext of which the fields should be set to default values.
2703  */
2704 void avcodec_get_context_defaults(AVCodecContext *s);
2705
2706 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2707  *  we WILL change its arguments and name a few times! */
2708 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2709
2710 /**
2711  * Allocates an AVCodecContext and sets its fields to default values.  The
2712  * resulting struct can be deallocated by simply calling av_free().
2713  *
2714  * @return An AVCodecContext filled with default values or NULL on failure.
2715  * @see avcodec_get_context_defaults
2716  */
2717 AVCodecContext *avcodec_alloc_context(void);
2718
2719 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2720  *  we WILL change its arguments and name a few times! */
2721 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2722
2723 /**
2724  * Sets the fields of the given AVFrame to default values.
2725  *
2726  * @param pic The AVFrame of which the fields should be set to default values.
2727  */
2728 void avcodec_get_frame_defaults(AVFrame *pic);
2729
2730 /**
2731  * Allocates an AVFrame and sets its fields to default values.  The resulting
2732  * struct can be deallocated by simply calling av_free().
2733  *
2734  * @return An AVFrame filled with default values or NULL on failure.
2735  * @see avcodec_get_frame_defaults
2736  */
2737 AVFrame *avcodec_alloc_frame(void);
2738
2739 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2740 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2741 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2742 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2743
2744 /**
2745  * Checks if the given dimension of a picture is valid, meaning that all
2746  * bytes of the picture can be addressed with a signed int.
2747  *
2748  * @param[in] w Width of the picture.
2749  * @param[in] h Height of the picture.
2750  * @return Zero if valid, a negative value if invalid.
2751  */
2752 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2753 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2754
2755 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2756 void avcodec_thread_free(AVCodecContext *s);
2757 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2758 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2759 //FIXME func typedef
2760
2761 /**
2762  * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2763  * function the context has to be allocated.
2764  *
2765  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2766  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2767  * retrieving a codec.
2768  *
2769  * @warning This function is not thread safe!
2770  *
2771  * @code
2772  * codec = avcodec_find_decoder(CODEC_ID_H264);
2773  * if (!codec)
2774  *     exit(1);
2775  *
2776  * context = avcodec_alloc_context();
2777  *
2778  * if (avcodec_open(context, codec) < 0)
2779  *     exit(1);
2780  * @endcode
2781  *
2782  * @param avctx The context which will be set up to use the given codec.
2783  * @param codec The codec to use within the context.
2784  * @return zero on success, a negative value on error
2785  * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2786  */
2787 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2788
2789 /**
2790  * @deprecated Use avcodec_decode_audio2() instead.
2791  */
2792 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2793                          int *frame_size_ptr,
2794                          uint8_t *buf, int buf_size);
2795
2796 /**
2797  * Decodes an audio frame from \p buf into \p samples.
2798  * The avcodec_decode_audio2() function decodes an audio frame from the input
2799  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2800  * audio codec which was coupled with \p avctx using avcodec_open(). The
2801  * resulting decoded frame is stored in output buffer \p samples.  If no frame
2802  * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2803  * decompressed frame size in \e bytes.
2804  *
2805  * @warning You \e must set \p frame_size_ptr to the allocated size of the
2806  * output buffer before calling avcodec_decode_audio2().
2807  *
2808  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2809  * the actual read bytes because some optimized bitstream readers read 32 or 64
2810  * bits at once and could read over the end.
2811  *
2812  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2813  * no overreading happens for damaged MPEG streams.
2814  *
2815  * @note You might have to align the input buffer \p buf and output buffer \p
2816  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2817  * necessary at all, on others it won't work at all if not aligned and on others
2818  * it will work but it will have an impact on performance. In practice, the
2819  * bitstream should have 4 byte alignment at minimum and all sample data should
2820  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2821  * the linesize is not a multiple of 16 then there's no sense in aligning the
2822  * start of the buffer to 16.
2823  *
2824  * @param avctx the codec context
2825  * @param[out] samples the output buffer
2826  * @param[in,out] frame_size_ptr the output buffer size in bytes
2827  * @param[in] buf the input buffer
2828  * @param[in] buf_size the input buffer size in bytes
2829  * @return On error a negative value is returned, otherwise the number of bytes
2830  * used or zero if no frame could be decompressed.
2831  */
2832 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2833                          int *frame_size_ptr,
2834                          uint8_t *buf, int buf_size);
2835
2836 /**
2837  * Decodes a video frame from \p buf into \p picture.
2838  * The avcodec_decode_video() function decodes a video frame from the input
2839  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2840  * video codec which was coupled with \p avctx using avcodec_open(). The
2841  * resulting decoded frame is stored in \p picture.
2842  *
2843  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2844  * the actual read bytes because some optimized bitstream readers read 32 or 64
2845  * bits at once and could read over the end.
2846  *
2847  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2848  * no overreading happens for damaged MPEG streams.
2849  *
2850  * @note You might have to align the input buffer \p buf and output buffer \p
2851  * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2852  * necessary at all, on others it won't work at all if not aligned and on others
2853  * it will work but it will have an impact on performance. In practice, the
2854  * bitstream should have 4 byte alignment at minimum and all sample data should
2855  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2856  * the linesize is not a multiple of 16 then there's no sense in aligning the
2857  * start of the buffer to 16.
2858  *
2859  * @param avctx the codec context
2860  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2861  * @param[in] buf the input buffer
2862  * @param[in] buf_size the size of the input buffer in bytes
2863  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2864  * @return On error a negative value is returned, otherwise the number of bytes
2865  * used or zero if no frame could be decompressed.
2866  */
2867 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2868                          int *got_picture_ptr,
2869                          uint8_t *buf, int buf_size);
2870
2871 /* Decode a subtitle message. Return -1 if error, otherwise return the
2872  * number of bytes used. If no subtitle could be decompressed,
2873  * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2874 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2875                             int *got_sub_ptr,
2876                             const uint8_t *buf, int buf_size);
2877 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2878                         int *data_size_ptr,
2879                         uint8_t *buf, int buf_size);
2880
2881 /**
2882  * Encodes an audio frame from \p samples into \p buf.
2883  * The avcodec_encode_audio() function encodes an audio frame from the input
2884  * buffer \p samples. To encode it, it makes use of the audio codec which was
2885  * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2886  * stored in output buffer \p buf.
2887  *
2888  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2889  *
2890  * @param avctx the codec context
2891  * @param[out] buf the output buffer
2892  * @param[in] buf_size the output buffer size
2893  * @param[in] samples the input buffer containing the samples
2894  * @return On error a negative value is returned, on succes zero or the number
2895  * of bytes used from the input buffer.
2896  */
2897 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2898                          const short *samples);
2899
2900 /**
2901  * Encodes a video frame from \p pict into \p buf.
2902  * The avcodec_encode_video() function encodes a video frame from the input
2903  * \p pict. To encode it, it makes use of the video codec which was coupled with
2904  * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2905  * frame are stored in the output buffer \p buf. The input picture should be
2906  * stored using a specific format, namely \c avctx.pix_fmt.
2907  *
2908  * @param avctx the codec context
2909  * @param[out] buf the output buffer for the bitstream of encoded frame
2910  * @param[in] buf_size the size of the output buffer in bytes
2911  * @param[in] pict the input picture to encode
2912  * @return On error a negative value is returned, on success zero or the number
2913  * of bytes used from the input buffer.
2914  */
2915 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2916                          const AVFrame *pict);
2917 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2918                             const AVSubtitle *sub);
2919
2920 int avcodec_close(AVCodecContext *avctx);
2921
2922 void avcodec_register_all(void);
2923
2924 /**
2925  * Flush buffers, should be called when seeking or when switching to a different stream.
2926  */
2927 void avcodec_flush_buffers(AVCodecContext *avctx);
2928
2929 void avcodec_default_free_buffers(AVCodecContext *s);
2930
2931 /* misc useful functions */
2932
2933 /**
2934  * Returns a single letter to describe the given picture type \p pict_type.
2935  *
2936  * @param[in] pict_type the picture type
2937  * @return A single character representing the picture type.
2938  */
2939 char av_get_pict_type_char(int pict_type);
2940
2941 /**
2942  * Returns codec bits per sample.
2943  *
2944  * @param[in] codec_id the codec
2945  * @return Number of bits per sample or zero if unknown for the given codec.
2946  */
2947 int av_get_bits_per_sample(enum CodecID codec_id);
2948
2949 /* frame parsing */
2950 typedef struct AVCodecParserContext {
2951     void *priv_data;
2952     struct AVCodecParser *parser;
2953     int64_t frame_offset; /* offset of the current frame */
2954     int64_t cur_offset; /* current offset
2955                            (incremented by each av_parser_parse()) */
2956     int64_t last_frame_offset; /* offset of the last frame */
2957     /* video info */
2958     int pict_type; /* XXX: Put it back in AVCodecContext. */
2959     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2960     int64_t pts;     /* pts of the current frame */
2961     int64_t dts;     /* dts of the current frame */
2962
2963     /* private data */
2964     int64_t last_pts;
2965     int64_t last_dts;
2966     int fetch_timestamp;
2967
2968 #define AV_PARSER_PTS_NB 4
2969     int cur_frame_start_index;
2970     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2971     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2972     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2973
2974     int flags;
2975 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2976
2977     int64_t offset;      ///< byte offset from starting packet start
2978     int64_t last_offset;
2979 } AVCodecParserContext;
2980
2981 typedef struct AVCodecParser {
2982     int codec_ids[5]; /* several codec IDs are permitted */
2983     int priv_data_size;
2984     int (*parser_init)(AVCodecParserContext *s);
2985     int (*parser_parse)(AVCodecParserContext *s,
2986                         AVCodecContext *avctx,
2987                         const uint8_t **poutbuf, int *poutbuf_size,
2988                         const uint8_t *buf, int buf_size);
2989     void (*parser_close)(AVCodecParserContext *s);
2990     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2991     struct AVCodecParser *next;
2992 } AVCodecParser;
2993
2994 extern AVCodecParser *av_first_parser;
2995
2996 void av_register_codec_parser(AVCodecParser *parser);
2997 AVCodecParserContext *av_parser_init(int codec_id);
2998 int av_parser_parse(AVCodecParserContext *s,
2999                     AVCodecContext *avctx,
3000                     uint8_t **poutbuf, int *poutbuf_size,
3001                     const uint8_t *buf, int buf_size,
3002                     int64_t pts, int64_t dts);
3003 int av_parser_change(AVCodecParserContext *s,
3004                      AVCodecContext *avctx,
3005                      uint8_t **poutbuf, int *poutbuf_size,
3006                      const uint8_t *buf, int buf_size, int keyframe);
3007 void av_parser_close(AVCodecParserContext *s);
3008
3009 extern AVCodecParser aac_parser;
3010 extern AVCodecParser ac3_parser;
3011 extern AVCodecParser cavsvideo_parser;
3012 extern AVCodecParser dca_parser;
3013 extern AVCodecParser dvbsub_parser;
3014 extern AVCodecParser dvdsub_parser;
3015 extern AVCodecParser h261_parser;
3016 extern AVCodecParser h263_parser;
3017 extern AVCodecParser h264_parser;
3018 extern AVCodecParser mjpeg_parser;
3019 extern AVCodecParser mpeg4video_parser;
3020 extern AVCodecParser mpegaudio_parser;
3021 extern AVCodecParser mpegvideo_parser;
3022 extern AVCodecParser pnm_parser;
3023 extern AVCodecParser vc1_parser;
3024
3025
3026 typedef struct AVBitStreamFilterContext {
3027     void *priv_data;
3028     struct AVBitStreamFilter *filter;
3029     AVCodecParserContext *parser;
3030     struct AVBitStreamFilterContext *next;
3031 } AVBitStreamFilterContext;
3032
3033
3034 typedef struct AVBitStreamFilter {
3035     const char *name;
3036     int priv_data_size;
3037     int (*filter)(AVBitStreamFilterContext *bsfc,
3038                   AVCodecContext *avctx, const char *args,
3039                   uint8_t **poutbuf, int *poutbuf_size,
3040                   const uint8_t *buf, int buf_size, int keyframe);
3041     struct AVBitStreamFilter *next;
3042 } AVBitStreamFilter;
3043
3044 extern AVBitStreamFilter *av_first_bitstream_filter;
3045
3046 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3047 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3048 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3049                                AVCodecContext *avctx, const char *args,
3050                                uint8_t **poutbuf, int *poutbuf_size,
3051                                const uint8_t *buf, int buf_size, int keyframe);
3052 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3053
3054 extern AVBitStreamFilter dump_extradata_bsf;
3055 extern AVBitStreamFilter remove_extradata_bsf;
3056 extern AVBitStreamFilter noise_bsf;
3057 extern AVBitStreamFilter mp3_header_compress_bsf;
3058 extern AVBitStreamFilter mp3_header_decompress_bsf;
3059 extern AVBitStreamFilter mjpega_dump_header_bsf;
3060 extern AVBitStreamFilter imx_dump_header_bsf;
3061
3062
3063 /* memory */
3064
3065 /**
3066  * Reallocates the given block if it is not large enough, otherwise it
3067  * does nothing.
3068  *
3069  * @see av_realloc
3070  */
3071 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3072
3073 /* for static data only */
3074
3075 /**
3076  * Frees all static arrays and resets their pointers to 0.
3077  * Call this function to release all statically allocated tables.
3078  *
3079  * @deprecated. Code which uses av_free_static is broken/missdesigned
3080  * and should correctly use static arrays
3081  *
3082  */
3083 attribute_deprecated void av_free_static(void);
3084
3085 /**
3086  * Allocation of static arrays.
3087  *
3088  * @warning Do not use for normal allocation.
3089  *
3090  * @param[in] size The amount of memory you need in bytes.
3091  * @return block of memory of the requested size
3092  * @deprecated. Code which uses av_mallocz_static is broken/missdesigned
3093  * and should correctly use static arrays
3094  */
3095 attribute_deprecated void *av_mallocz_static(unsigned int size);
3096
3097 /**
3098  * Copy image 'src' to 'dst'.
3099  */
3100 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3101               int pix_fmt, int width, int height);
3102
3103 /**
3104  * Crop image top and left side.
3105  */
3106 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3107              int pix_fmt, int top_band, int left_band);
3108
3109 /**
3110  * Pad image.
3111  */
3112 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3113             int padtop, int padbottom, int padleft, int padright, int *color);
3114
3115 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
3116 /**
3117  * @deprecated Use the software scaler (swscale) instead.
3118  */
3119 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
3120               int pix_fmt, int width, int height);
3121
3122 /**
3123  * @deprecated Use the software scaler (swscale) instead.
3124  */
3125 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
3126              int pix_fmt, int top_band, int left_band);
3127
3128 /**
3129  * @deprecated Use the software scaler (swscale) instead.
3130  */
3131 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3132             int padtop, int padbottom, int padleft, int padright, int *color);
3133 #endif
3134
3135 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3136
3137 /* error handling */
3138 #if EINVAL > 0
3139 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3140 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3141 #else
3142 /* Some platforms have E* and errno already negated. */
3143 #define AVERROR(e) (e)
3144 #define AVUNERROR(e) (e)
3145 #endif
3146 #define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3147 #define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3148 #define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3149 #define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3150 #define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3151 #define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3152 #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3153 #define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3154
3155 #ifdef __cplusplus
3156 }
3157 #endif
3158
3159 #endif /* AVCODEC_H */