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