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