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