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