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