avcodec.h 71.3 KB
Newer Older
glantau's avatar
glantau committed
1 2 3
#ifndef AVCODEC_H
#define AVCODEC_H

michaelni's avatar
michaelni committed
4 5
/**
 * @file avcodec.h
michaelni's avatar
doxy  
michaelni committed
6
 * external api header.
michaelni's avatar
michaelni committed
7 8 9
 */


kabi's avatar
kabi committed
10 11 12 13
#ifdef __cplusplus
extern "C" {
#endif

14
#include "avutil.h"
15
#include "opt.h"
kabi's avatar
kabi committed
16
#include <sys/types.h> /* size_t */
glantau's avatar
glantau committed
17

michael's avatar
michael committed
18
//FIXME the following 2 really dont belong in here
michael's avatar
michael committed
19
#define FFMPEG_VERSION_INT     0x000409
michael's avatar
michael committed
20
#define FFMPEG_VERSION         "CVS"
bellard's avatar
bellard committed
21 22 23

#define AV_STRINGIFY(s)	AV_TOSTRING(s)
#define AV_TOSTRING(s) #s
michael's avatar
michael committed
24

michael's avatar
michael committed
25 26
#define LIBAVCODEC_VERSION_INT ((50<<16)+(0<<8)+0)
#define LIBAVCODEC_VERSION     50.0.0
michael's avatar
michael committed
27 28 29
#define LIBAVCODEC_BUILD       LIBAVCODEC_VERSION_INT

#define LIBAVCODEC_IDENT       "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
al3x's avatar
al3x committed
30

31
#define AV_NOPTS_VALUE int64_t_C(0x8000000000000000)
32
#define AV_TIME_BASE 1000000
michael's avatar
michael committed
33
#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
34

glantau's avatar
glantau committed
35 36 37
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
38
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
iive's avatar
iive committed
39
    CODEC_ID_MPEG2VIDEO_XVMC,
40
    CODEC_ID_H261,
glantau's avatar
glantau committed
41 42
    CODEC_ID_H263,
    CODEC_ID_RV10,
michael's avatar
michael committed
43
    CODEC_ID_RV20,
glantau's avatar
glantau committed
44
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
45
    CODEC_ID_MJPEGB,
46
    CODEC_ID_LJPEG,
alex's avatar
alex committed
47
    CODEC_ID_SP5X,
glantau's avatar
glantau committed
48
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
49
    CODEC_ID_RAWVIDEO,
50 51 52
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
53
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
54
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
55 56
    CODEC_ID_H263P,
    CODEC_ID_H263I,
57
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
58
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
59
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
60
    CODEC_ID_DVVIDEO,
michaelni's avatar
michaelni committed
61
    CODEC_ID_HUFFYUV,
62
    CODEC_ID_CYUV,
michaelni's avatar
michaelni committed
63
    CODEC_ID_H264,
tmmm's avatar
tmmm committed
64
    CODEC_ID_INDEO3,
tmmm's avatar
tmmm committed
65
    CODEC_ID_VP3,
66
    CODEC_ID_THEORA,
michaelni's avatar
michaelni committed
67
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
68
    CODEC_ID_ASV2,
69
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
70
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
71
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
72
    CODEC_ID_CLJR,
73
    CODEC_ID_MDEC,
74 75
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
76 77
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
78 79 80 81 82
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
83
    CODEC_ID_IDCIN,
rtognimp's avatar
rtognimp committed
84
    CODEC_ID_8BPS,
85
    CODEC_ID_SMC,
melanson's avatar
melanson committed
86
    CODEC_ID_FLIC,
87
    CODEC_ID_TRUEMOTION1,
88
    CODEC_ID_VMDVIDEO,
rtognimp's avatar
rtognimp committed
89 90
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
91
    CODEC_ID_QTRLE,
michael's avatar
michael committed
92
    CODEC_ID_SNOW,
93
    CODEC_ID_TSCC,
94
    CODEC_ID_ULTI,
95
    CODEC_ID_QDRAW,
96
    CODEC_ID_VIXL,
97
    CODEC_ID_QPEG,
98 99 100 101 102 103 104
    CODEC_ID_XVID,
    CODEC_ID_PNG,
    CODEC_ID_PPM,
    CODEC_ID_PBM,
    CODEC_ID_PGM,
    CODEC_ID_PGMYUV,
    CODEC_ID_PAM,
lorenm's avatar
lorenm committed
105
    CODEC_ID_FFVHUFF,
michael's avatar
michael committed
106 107
    CODEC_ID_RV30,
    CODEC_ID_RV40,
108 109
    CODEC_ID_VC9,
    CODEC_ID_WMV3,
110
    CODEC_ID_LOCO,
111
    CODEC_ID_WNV1,
112
    CODEC_ID_AASC,
113
    CODEC_ID_INDEO2,
114
    CODEC_ID_FRAPS,
glantau's avatar
glantau committed
115 116

    /* various pcm "codecs" */
117
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
118 119 120 121 122 123 124
    CODEC_ID_PCM_S16BE,
    CODEC_ID_PCM_U16LE,
    CODEC_ID_PCM_U16BE,
    CODEC_ID_PCM_S8,
    CODEC_ID_PCM_U8,
    CODEC_ID_PCM_MULAW,
    CODEC_ID_PCM_ALAW,
125 126 127 128 129 130 131 132 133
    CODEC_ID_PCM_S32LE,
    CODEC_ID_PCM_S32BE,
    CODEC_ID_PCM_U32LE,
    CODEC_ID_PCM_U32BE,
    CODEC_ID_PCM_S24LE,
    CODEC_ID_PCM_S24BE,
    CODEC_ID_PCM_U24LE,
    CODEC_ID_PCM_U24BE,
    CODEC_ID_PCM_S24DAUD,
134 135

    /* various adpcm codecs */
136
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
137
    CODEC_ID_ADPCM_IMA_WAV,
138 139
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
140
    CODEC_ID_ADPCM_IMA_WS,
141
    CODEC_ID_ADPCM_IMA_SMJPEG,
142
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
143
    CODEC_ID_ADPCM_4XM,
144 145
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
146
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
147
    CODEC_ID_ADPCM_G726,
148
    CODEC_ID_ADPCM_CT,
149
    CODEC_ID_ADPCM_SWF,
150
    CODEC_ID_ADPCM_YAMAHA,
151

152 153
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
154 155
    CODEC_ID_AMR_WB,

156
    /* RealAudio codecs*/
157
    CODEC_ID_RA_144= 0x13000,
158
    CODEC_ID_RA_288,
159 160

    /* various DPCM codecs */
161
    CODEC_ID_ROQ_DPCM= 0x14000,
162
    CODEC_ID_INTERPLAY_DPCM,
163
    CODEC_ID_XAN_DPCM,
164
    CODEC_ID_SOL_DPCM,
165
    
166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
    CODEC_ID_MP2= 0x15000,
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
    CODEC_ID_AC3,
    CODEC_ID_DTS,
    CODEC_ID_VORBIS,
    CODEC_ID_DVAUDIO,
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
    CODEC_ID_VMDAUDIO,
    CODEC_ID_SONIC,
    CODEC_ID_SONIC_LS,
michael's avatar
michael committed
181
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
182
    CODEC_ID_MP3ADU,
183
    CODEC_ID_MP3ON4,
184
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
185
    CODEC_ID_ALAC,
186
    CODEC_ID_WESTWOOD_SND1,
187
    CODEC_ID_GSM,    
michael's avatar
michael committed
188
    
michael's avatar
michael committed
189
    CODEC_ID_OGGTHEORA= 0x16000, 
bellard's avatar
bellard committed
190 191 192 193

    /* subtitle codecs */
    CODEC_ID_DVD_SUBTITLE= 0x17000, 
    CODEC_ID_DVB_SUBTITLE, 
michael's avatar
michael committed
194
    
195
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
196
                         stream (only used by libavformat) */
glantau's avatar
glantau committed
197
};
198 199 200

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
glantau's avatar
glantau committed
201 202

enum CodecType {
203
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
204 205
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
206
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
207
    CODEC_TYPE_SUBTITLE,
glantau's avatar
glantau committed
208 209
};

210
/**
tmmm's avatar
tmmm committed
211 212 213 214 215 216 217 218 219 220 221 222
 * Pixel format. Notes: 
 *
 * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
 * color is put together as:
 *  (A << 24) | (R << 16) | (G << 8) | B
 * This is stored as BGRA on little endian CPU architectures and ARGB on
 * big endian CPUs.
 *
 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
 * image data is stored in AVFrame.data[0]. The palette is transported in
 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
 * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
223 224 225 226
 * also endian-specific). Note also that the individual RGB palette
 * components stored in AVFrame.data[1] should be in the range 0..255.
 * This is important as many custom PAL8 video codecs that were designed
 * to run on the IBM VGA graphics adapter use 6-bit palette components.
227
 */
glantau's avatar
glantau committed
228
enum PixelFormat {
michael's avatar
michael committed
229
    PIX_FMT_NONE= -1,
michaelni's avatar
michaelni committed
230
    PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
231
    PIX_FMT_YUV422,    ///< Packed pixel, Y0 Cb Y1 Cr 
michaelni's avatar
michaelni committed
232 233 234 235
    PIX_FMT_RGB24,     ///< Packed pixel, 3 bytes per pixel, RGBRGB...
    PIX_FMT_BGR24,     ///< Packed pixel, 3 bytes per pixel, BGRBGR...
    PIX_FMT_YUV422P,   ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
    PIX_FMT_YUV444P,   ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
tmmm's avatar
tmmm committed
236
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
michaelni's avatar
michaelni committed
237 238
    PIX_FMT_YUV410P,   ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
    PIX_FMT_YUV411P,   ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
239 240
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
241
    PIX_FMT_GRAY8,
242 243 244
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
michaelni's avatar
michaelni committed
245 246 247
    PIX_FMT_YUVJ420P,  ///< Planar YUV 4:2:0 full scale (jpeg)
    PIX_FMT_YUVJ422P,  ///< Planar YUV 4:2:2 full scale (jpeg)
    PIX_FMT_YUVJ444P,  ///< Planar YUV 4:4:4 full scale (jpeg)
iive's avatar
iive committed
248 249
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
250
    PIX_FMT_UYVY422,   ///< Packed pixel, Cb Y0 Cr Y1 
romansh's avatar
 
romansh committed
251
    PIX_FMT_UYVY411,   ///< Packed pixel, Cb Y0 Y1 Cr Y2 Y3
252
    PIX_FMT_NB,
glantau's avatar
glantau committed
253 254
};

glantau's avatar
glantau committed
255 256
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
257
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
258 259 260
    SAMPLE_FMT_S32,             ///< signed 32 bits 
    SAMPLE_FMT_FLT,             ///< float
    SAMPLE_FMT_DBL,             ///< double
glantau's avatar
glantau committed
261 262
};

glantau's avatar
glantau committed
263
/* in bytes */
bellard's avatar
bellard committed
264
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
glantau's avatar
glantau committed
265

266
/**
267 268 269 270 271
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 * this is mainly needed because some optimized bitstream readers read 
 * 32 or 64 bit at once and could read over the end<br>
 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
 * MPEG bitstreams could cause overread and segfault
272 273 274
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

275 276 277 278 279 280
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

281 282
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
283
    ME_ZERO = 1,
284 285 286 287 288 289 290
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

michael's avatar
michael committed
291 292 293 294 295 296 297 298 299 300
enum AVDiscard{
//we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
    AVDISCARD_NONE   =-16, ///< discard nothing
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
    AVDISCARD_NONREF =  8, ///< discard all non reference
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
    AVDISCARD_ALL    = 48, ///< discard all
};

michaelni's avatar
michaelni committed
301 302 303 304 305 306 307
typedef struct RcOverride{
    int start_frame;
    int end_frame;
    int qscale; // if this is 0 then quality_factor will be used instead
    float quality_factor;
} RcOverride;

308 309 310
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

michaelni's avatar
michaelni committed
311
#define FF_MAX_B_FRAMES 8
312

michaelni's avatar
michaelni committed
313 314
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
diego's avatar
diego committed
315
   Note: not everything is supported yet.
michaelni's avatar
michaelni committed
316
*/
glantau's avatar
glantau committed
317

318
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
michael's avatar
michael committed
319
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
320 321
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
322
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
323
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
324 325
/* parent program gurantees that the input for b-frame containing streams is not written to 
   for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
michaelni's avatar
michaelni committed
326
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
327 328 329 330
#define CODEC_FLAG_PASS1 0x0200   ///< use internal 2pass ratecontrol in first  pass mode 
#define CODEC_FLAG_PASS2 0x0400   ///< use internal 2pass ratecontrol in second pass mode 
#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg) 
#define CODEC_FLAG_GRAY  0x2000   ///< only decode/encode grayscale 
diego's avatar
diego committed
331
#define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
332 333
#define CODEC_FLAG_PSNR           0x8000 ///< error[?] variables will be set during encoding 
#define CODEC_FLAG_TRUNCATED  0x00010000 /** input bitstream might be truncated at a random location instead 
334
                                            of only at frame boundaries */
335 336
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
337
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
338 339 340 341
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< use alternate scan 
#define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< use trellis quantization 
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< place global headers in extradata instead of every keyframe 
#define CODEC_FLAG_BITEXACT       0x00800000 ///< use only bitexact stuff (except (i)dct) 
342
/* Fx : Flag for h263+ extra options */
michaelni's avatar
michaelni committed
343 344
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
345
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
346
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
347
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
michael's avatar
michael committed
348
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
michael's avatar
michael committed
349 350
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
351 352
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
michael's avatar
michael committed
353
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
354
#define CODEC_FLAG_CLOSED_GOP     0x80000000
355
#define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
356
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
357
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< skip bitstream encoding
358
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< place global headers at every keyframe instead of in extradata
359

360 361 362
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Reference Picture Selection
michael's avatar
michael committed
363
 * 		Independant Segment Decoding */
364
/* /Fx */
glantau's avatar
glantau committed
365 366
/* codec capabilities */

367
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
michaelni's avatar
michaelni committed
368 369 370 371 372
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
373 374 375
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
376
#define CODEC_CAP_TRUNCATED       0x0008
377 378
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
379 380 381 382
/** 
 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
 * if this is not set, the codec is guranteed to never be feeded with NULL data
 */
383
#define CODEC_CAP_DELAY           0x0020
glantau's avatar
glantau committed
384

diego's avatar
diego committed
385
//the following defines may change, don't expect compatibility if you use them
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
#define MB_TYPE_INTRA4x4   0x0001
#define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME h264 specific
#define MB_TYPE_16x16      0x0008
#define MB_TYPE_16x8       0x0010
#define MB_TYPE_8x16       0x0020
#define MB_TYPE_8x8        0x0040
#define MB_TYPE_INTERLACED 0x0080
#define MB_TYPE_DIRECT2     0x0100 //FIXME
#define MB_TYPE_ACPRED     0x0200
#define MB_TYPE_GMC        0x0400
#define MB_TYPE_SKIP       0x0800
#define MB_TYPE_P0L0       0x1000
#define MB_TYPE_P1L0       0x2000
#define MB_TYPE_P0L1       0x4000
#define MB_TYPE_P1L1       0x8000
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
#define MB_TYPE_QUANT      0x00010000
#define MB_TYPE_CBP        0x00020000
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)

409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
/**
 * Pan Scan area.
 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
 */
typedef struct AVPanScan{
    /**
     * id.
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int id;

    /**
     * width and height in 1/16 pel
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int width;
    int height;

    /**
     * position of the top left corner in 1/16 pel for up to 3 fields/frames.
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int16_t position[3][2];
}AVPanScan;

michaelni's avatar
michaelni committed
437
#define FF_COMMON_FRAME \
michaelni's avatar
michaelni committed
438 439 440 441 442 443
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
michaelni's avatar
michaelni committed
444 445 446
    uint8_t *data[4];\
    int linesize[4];\
    /**\
michaelni's avatar
michaelni committed
447
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
diego's avatar
diego committed
448
     * this isn't used by lavc unless the default get/release_buffer() is used\
449 450
     * - encoding: \
     * - decoding: \
michaelni's avatar
michaelni committed
451 452 453 454
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
455 456
     * - encoding: set by lavc\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
457 458 459 460
     */\
    int key_frame;\
\
    /**\
michaelni's avatar
michaelni committed
461
     * picture type of the frame, see ?_TYPE below.\
462 463
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
464 465 466 467
     */\
    int pict_type;\
\
    /**\
michael's avatar
michael committed
468 469
     * presentation timestamp in time_base units (time when frame should be shown to user)\
     * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
470 471
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
472
     */\
473
    int64_t pts;\
michaelni's avatar
michaelni committed
474 475 476
\
    /**\
     * picture number in bitstream order.\
477 478
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
479 480 481 482
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
483 484
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
485 486 487 488
     */\
    int display_picture_number;\
\
    /**\
489
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
490 491
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
492
     */\
493
    int quality; \
michaelni's avatar
michaelni committed
494 495 496
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
497
     * set to INT_MAX if the buffer has not been used yet \
498 499
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
michaelni's avatar
michaelni committed
500 501 502 503 504
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
505 506
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
michaelni's avatar
michaelni committed
507 508 509 510 511
     */\
    int reference;\
\
    /**\
     * QP table\
512 513
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
514 515 516 517
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
518 519
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
520 521 522 523 524 525
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
526 527
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
528 529
     */\
    uint8_t *mbskip_table;\
530 531
\
    /**\
michael's avatar
michael committed
532 533 534 535 536 537 538 539
     * Motion vector table.\
     * @code\
     * example:\
     * int mv_sample_log2= 4 - motion_subsample_log2;\
     * int mb_width= (width+15)>>4;\
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
     * @endcode\
540
     * - encoding: set by user\
541 542 543 544 545 546 547
     * - decoding: set by lavc\
     */\
    int16_t (*motion_val[2])[2];\
\
    /**\
     * Macroblock type table\
     * mb_type_base + mb_width + 2\
548
     * - encoding: set by user\
549 550 551 552 553
     * - decoding: set by lavc\
     */\
    uint32_t *mb_type;\
\
    /**\
michael's avatar
michael committed
554 555
     * log2 of the size of the block which a single vector in motion_val represents: \
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
556 557 558 559
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    uint8_t motion_subsample_log2;\
michaelni's avatar
michaelni committed
560 561 562
\
    /**\
     * for some private data of the user\
563 564
     * - encoding: unused\
     * - decoding: set by user\
michaelni's avatar
michaelni committed
565 566
     */\
    void *opaque;\
567 568 569
\
    /**\
     * error\
570 571
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
572 573
     */\
    uint64_t error[4];\
michaelni's avatar
michaelni committed
574 575 576
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
577 578
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
mellum's avatar
mellum committed
579
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
michaelni's avatar
michaelni committed
580 581
     */\
    int type;\
582 583 584 585
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
586 587
     * - encoding: unused\
     * - decoding: set by lavc\
588
     */\
michaelni's avatar
michaelni committed
589 590 591 592 593 594
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
romansh's avatar
 
romansh committed
595 596 597 598 599 600 601 602 603
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
604
     * if the content is interlaced, is top field displayed first.\
romansh's avatar
 
romansh committed
605
     * - encoding: set by user\
606
     * - decoding: set by lavc\
romansh's avatar
 
romansh committed
607
     */\
608
    int top_field_first;\
609 610 611 612 613 614 615
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
616 617 618 619 620 621 622
    \
    /**\
     * tell user application that palette has changed from previous frame.\
     * - encoding: ??? (no palette-enabled encoder yet)\
     * - decoding: set by lavc (default 0)\
     */\
    int palette_has_changed;\
623 624 625 626 627 628 629
    \
    /**\
     * Codec suggestion on buffer type if != 0\
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
     */\
    int buffer_hints;\
630 631 632 633 634 635 636
\
    /**\
     * DCT coeffitients\
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    short *dct_coeff;\
637 638 639 640 641 642 643
\
    /**\
     * Motion referece frame index\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    int8_t *ref_index[2];
644

michaelni's avatar
michaelni committed
645 646
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
michaelni's avatar
michaelni committed
647 648

#define FF_BUFFER_TYPE_INTERNAL 1
michaelni's avatar
michaelni committed
649
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
diego's avatar
diego committed
650 651
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
#define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, don't dealloc anything
michaelni's avatar
michaelni committed
652

michaelni's avatar
michaelni committed
653

654 655 656 657
#define FF_I_TYPE 1 // Intra
#define FF_P_TYPE 2 // Predicted
#define FF_B_TYPE 3 // Bi-dir predicted
#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
michaelni's avatar
michaelni committed
658 659
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
660

661 662 663 664 665
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore)
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)

michaelni's avatar
michaelni committed
666 667 668
/**
 * Audio Video Frame.
 */
michaelni's avatar
michaelni committed
669 670 671
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
672

673
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
674

675 676 677 678 679 680 681 682 683 684
/**
 * Used by av_log
 */
typedef struct AVCLASS AVClass;
struct AVCLASS {
    const char* class_name;
    const char* (*item_name)(void*); /* actually passing a pointer to an AVCodecContext
					or AVFormatContext, which begin with an AVClass.
					Needed because av_log is in libavcodec and has no visibility
					of AVIn/OutputFormat */
michael's avatar
michael committed
685
    AVOption *option;
686 687
};

michaelni's avatar
doxy  
michaelni committed
688 689 690
/**
 * main external api structure.
 */
glantau's avatar
glantau committed
691
typedef struct AVCodecContext {
692 693 694 695
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
696
    AVClass *av_class;
697
    /**
698 699 700
     * the average bitrate.
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream 
701
     */
glantau's avatar
glantau committed
702
    int bit_rate;
703 704

    /**
705
     * number of bits the bitstream is allowed to diverge from the reference.
706
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
707 708
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
709 710 711 712
     */
    int bit_rate_tolerance; 

    /**
713 714 715
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
716
     */
glantau's avatar
glantau committed
717
    int flags;
718 719 720

    /**
     * some codecs needs additionnal format info. It is stored here
721 722
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
723 724 725 726
     */
    int sub_id;

    /**
727 728 729
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
730 731 732 733
     */
    int me_method;

    /**
734
     * some codecs need / can use extra-data like huffman tables.
735 736
     * mjpeg: huffman tables
     * rv10: additional flags
737
     * mpeg4: global headers (they can be in the bitstream or here)
738 739
     * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
     * then extradata_size to avoid prolems if its read with the bitstream reader
740 741
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
742
     */
743 744 745
    void *extradata;
    int extradata_size;
    
746
    /**
747 748 749 750
     * this is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. for fixed-fps content,
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
751
     * - encoding: MUST be set by user
michael's avatar
michael committed
752
     * - decoding: set by lavc.
753
     */
michael's avatar
michael committed
754
    AVRational time_base;
755
    
756
    /* video only */
757
    /**
758
     * picture width / height.
759
     * - encoding: MUST be set by user. 
760 761 762
     * - decoding: set by lavc.
     * Note, for compatibility its possible to set this instead of 
     * coded_width/height before decoding
763
     */
glantau's avatar
glantau committed
764
    int width, height;
765
    
766
#define FF_ASPECT_EXTENDED 15
767 768

    /**
769 770 771
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
772 773 774 775
     */
    int gop_size;

    /**
776
     * pixel format, see PIX_FMT_xxx.
777
     * - encoding: set by user.
778
     * - decoding: set by lavc.
779
     */
780
    enum PixelFormat pix_fmt;
781 782 783 784 785 786 787 788 789
 
    /**
     * Frame rate emulation. If not zero lower layer (i.e. format handler) 
     * has to read frames at native frame rate.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int rate_emu;
       
790 791 792 793 794
    /**
     * if non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw an horizontal band. It improve cache usage. Not
     * all codecs can do that. You must check the codec capabilities
     * before
795 796
     * - encoding: unused
     * - decoding: set by user.
797 798 799 800
     * @param height the height of the slice
     * @param y the y position of the slice
     * @param type 1->top field, 2->bottom field, 3->frame
     * @param offset offset into the AVFrame.data from which the slice should be read
801
     */
glantau's avatar
glantau committed
802
    void (*draw_horiz_band)(struct AVCodecContext *s,
803
                            const AVFrame *src, int offset[4],
804
                            int y, int type, int height);
glantau's avatar
glantau committed
805

glantau's avatar
glantau committed
806
    /* audio only */
807
    int sample_rate; ///< samples per sec 
glantau's avatar
glantau committed
808
    int channels;
809 810 811 812 813 814 815

    /**
     * audio sample format.
     * - encoding: set by user.
     * - decoding: set by lavc.
     */
    enum SampleFormat sample_fmt;  ///< sample format, currenly unused 
glantau's avatar
glantau committed
816 817

    /* the following data should not be initialized */
818 819 820 821
    /**
     * samples per packet. initialized when calling 'init' 
     */
    int frame_size;
822 823
    int frame_number;   ///< audio or video frame number 
    int real_pict_num;  ///< returns the real picture number of previous encoded frame 
michaelni's avatar
michaelni committed
824
    
825 826
    /**
     * number of frames the decoded output will be delayed relative to 
827 828 829
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
830 831
     */
    int delay;
michaelni's avatar
michaelni committed
832
    
833 834 835
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0) 
836 837
    
    /**
838 839 840
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
841 842 843 844
     */
    int qmin;

    /**
845 846 847
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
848 849 850 851
     */
    int qmax;

    /**
852 853 854
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
855 856 857 858
     */
    int max_qdiff;

    /**
859
     * maximum number of b frames between non b frames.
860
     * note: the output will be delayed by max_b_frames+1 relative to the input
861 862
     * - encoding: set by user.
     * - decoding: unused
863 864 865 866
     */
    int max_b_frames;

    /**
867 868 869
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
870 871 872 873 874
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
michaelni's avatar
michaelni committed
875
    int b_frame_strategy;
876

877
    /**
878
     * hurry up amount.
michael's avatar
michael committed
879
     * deprecated in favor of skip_idct and skip_frame
880 881
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
882 883
     */
    int hurry_up;
884
    
glantau's avatar
glantau committed
885
    struct AVCodec *codec;
886
    
glantau's avatar
glantau committed
887 888
    void *priv_data;

michael's avatar
michael committed
889 890
    /* unused, FIXME remove*/
    int rtp_mode;
891
    
diego's avatar
diego committed
892
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
893 894 895 896 897
                            /* do it's best to deliver a chunk with size    */
                            /* below rtp_payload_size, the chunk will start */
                            /* with a start code on some codecs like H.263  */
                            /* This doesn't take account of any particular  */
                            /* headers inside the transmited RTP payload    */
898 899

    
diego's avatar
diego committed
900 901 902 903 904 905
    /* The RTP callback: This function is called   */
    /* every time the encoder has a packet to send */
    /* Depends on the encoder if the data starts   */
    /* with a Start Code (it should) H.263 does.   */
    /* mb_nb contains the number of macroblocks    */
    /* encoded in the RTP payload                  */
906
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb); 
907

michaelni's avatar
michaelni committed
908 909 910 911 912 913 914 915
    /* statistics, used for 2-pass encoding */
    int mv_bits;
    int header_bits;
    int i_tex_bits;
    int p_tex_bits;
    int i_count;
    int p_count;
    int skip_count;
916 917 918
    int misc_bits;
    
    /**
919 920
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
michaelni's avatar
michaelni committed
921
     * - decoding: unused
922
     */
michaelni's avatar
michaelni committed
923
    int frame_bits;
michaelni's avatar
michaelni committed
924

925
    /**
926 927 928
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
929 930 931
     */
    void *opaque;

glantau's avatar
glantau committed
932
    char codec_name[32];
933 934
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
michaelni's avatar
michaelni committed
935 936 937 938
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
michaelni's avatar
michaelni committed
939
     * - encoding: set by user, if not then the default based on codec_id will be used
michaelni's avatar
michaelni committed
940 941 942
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
michaelni's avatar
 
michaelni committed
943
    
944
    /**
945
     * workaround bugs in encoders which sometimes cannot be detected automatically.
946
     * - encoding: set by user
947
     * - decoding: set by user
948 949
     */
    int workaround_bugs;
950
#define FF_BUG_AUTODETECT       1  ///< autodetection
951 952 953 954
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
michael's avatar
michael committed
955
#define FF_BUG_AMV              32
956
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
michaelni's avatar
michaelni committed
957
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
958
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
959
#define FF_BUG_QPEL_CHROMA2     256
960
#define FF_BUG_DIRECT_BLOCKSIZE 512
961
#define FF_BUG_EDGE             1024
962
#define FF_BUG_HPEL_CHROMA      2048
963
#define FF_BUG_DC_CLIP          4096
964
#define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
965 966
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
967
    /**
968 969 970
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
971
     */
michaelni's avatar
 
michaelni committed
972
    int luma_elim_threshold;
973 974
    
    /**
975 976 977
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
978
     */
michaelni's avatar
 
michaelni committed
979
    int chroma_elim_threshold;
980 981
    
    /**
982 983 984
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
985 986
     */
    int strict_std_compliance;
987 988 989 990 991 992
#define FF_COMPLIANCE_VERY_STRICT   2 ///< strictly conform to a older more strict version of the spec or reference software
#define FF_COMPLIANCE_STRICT        1 ///< strictly conform to all the things in the spec no matter what consequences
#define FF_COMPLIANCE_NORMAL        0
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< allow inofficial extensions
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things

993
    /**
994
     * qscale offset between ip and b frames.
995 996
     * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
     * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
997 998
     * - encoding: set by user.
     * - decoding: unused
999 1000 1001 1002
     */
    float b_quant_offset;
    
    /**
1003
     * error resilience higher values will detect more errors but may missdetect
1004 1005 1006
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
1007
     */
michaelni's avatar
 
michaelni committed
1008
    int error_resilience;
1009 1010 1011 1012
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1013
    
1014
    /**
michaelni's avatar
michaelni committed
1015 1016
     * called at the beginning of each frame to get a buffer for it.
     * if pic.reference is set then the frame will be read later by lavc
michael's avatar
michael committed
1017 1018
     * avcodec_align_dimensions() should be used to find the required width and
     * height, as they normally need to be rounded up to the next multiple of 16
1019 1020
     * - encoding: unused
     * - decoding: set by lavc, user can override
1021
     */
michaelni's avatar
michaelni committed
1022
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1023 1024
    
    /**
michaelni's avatar
michaelni committed
1025 1026 1027
     * called to release buffers which where allocated with get_buffer.
     * a released buffer can be reused in get_buffer()
     * pic.data[*] must be set to NULL
1028 1029
     * - encoding: unused
     * - decoding: set by lavc, user can override
1030
     */
michaelni's avatar
michaelni committed
1031
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1032

1033
    /**
1034 1035
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
1036
     * - decoding: set by lavc
1037 1038
     */
    int has_b_frames;
1039 1040 1041 1042 1043 1044

    /**
     * number of bytes per packet if constant and known or 0
     * used by some WAV based audio codecs
     */
    int block_align;
michaelni's avatar
michaelni committed
1045
    
1046
    int parse_only; /* - decoding only: if true, only parsing is done
1047 1048
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
michaelni's avatar
michaelni committed
1049
    
1050
    /**
1051
     * 0-> h263 quant 1-> mpeg quant.
1052 1053
     * - encoding: set by user.
     * - decoding: unused
1054 1055
     */
    int mpeg_quant;
michaelni's avatar
michaelni committed
1056
    
1057
    /**
1058 1059 1060
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
1061
     */
1062
    char *stats_out;
1063 1064 1065 1066
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1067 1068
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1069 1070 1071 1072
     */
    char *stats_in;
    
    /**
1073
     * ratecontrol qmin qmax limiting method.
1074
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1075 1076
     * - encoding: set by user.
     * - decoding: unused
1077
     */
michaelni's avatar
michaelni committed
1078
    float rc_qsquish;
1079

michaelni's avatar
michaelni committed
1080 1081
    float rc_qmod_amp;
    int rc_qmod_freq;
1082 1083
    
    /**
1084 1085 1086
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1087
     */
michaelni's avatar
michaelni committed
1088 1089
    RcOverride *rc_override;
    int rc_override_count;
1090 1091
    
    /**
1092 1093 1094
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1095
     */
michaelni's avatar
michaelni committed
1096
    char *rc_eq;
1097 1098
    
    /**
1099 1100 1101
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1102
     */
michaelni's avatar
michaelni committed
1103
    int rc_max_rate;
1104 1105
    
    /**
1106 1107 1108
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1109
     */
michaelni's avatar
michaelni committed
1110
    int rc_min_rate;
1111 1112
    
    /**
1113 1114 1115
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1116
     */
michaelni's avatar
michaelni committed
1117 1118
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1119 1120

    /**
1121
     * qscale factor between p and i frames.
1122 1123
     * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
     * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
1124 1125
     * - encoding: set by user.
     * - decoding: unused
1126 1127 1128 1129
     */
    float i_quant_factor;
    
    /**
1130 1131 1132
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1133 1134 1135 1136
     */
    float i_quant_offset;
    
    /**
1137 1138 1139
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1140
     */
michaelni's avatar
michaelni committed
1141
    float rc_initial_cplx;
1142

1143
    /**
1144 1145 1146
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1147
     */
1148
    int dct_algo;
1149
#define FF_DCT_AUTO    0
1150
#define FF_DCT_FASTINT 1
1151 1152 1153
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1154
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1155
#define FF_DCT_FAAN    6
1156 1157
    
    /**
1158 1159 1160
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1161 1162 1163 1164
     */
    float lumi_masking;
    
    /**
1165 1166 1167
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1168 1169 1170 1171
     */
    float temporal_cplx_masking;
    
    /**
1172 1173 1174
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1175 1176 1177 1178
     */
    float spatial_cplx_masking;
    
    /**
1179 1180 1181
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1182 1183
     */
    float p_masking;
1184

1185
    /**
1186 1187 1188
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1189 1190
     */
    float dark_masking;
1191
    
1192 1193 1194 1195
    
    /* for binary compatibility */
    int unused;
    
1196
    /**
1197 1198 1199
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
     */
    int idct_algo;
#define FF_IDCT_AUTO         0
#define FF_IDCT_INT          1
#define FF_IDCT_SIMPLE       2
#define FF_IDCT_SIMPLEMMX    3
#define FF_IDCT_LIBMPEG2MMX  4
#define FF_IDCT_PS2          5
#define FF_IDCT_MLIB         6
#define FF_IDCT_ARM          7
1210
#define FF_IDCT_ALTIVEC      8
1211
#define FF_IDCT_SH4          9
1212
#define FF_IDCT_SIMPLEARM    10
1213
#define FF_IDCT_H264         11
1214
#define FF_IDCT_VP3          12
1215
#define FF_IDCT_IPP          13
michael's avatar
michael committed
1216
#define FF_IDCT_XVIDMMX      14
1217

1218
    /**
1219 1220 1221
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1222 1223 1224
     */
    int slice_count;
    /**
1225 1226 1227
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1228 1229 1230
     */
    int *slice_offset;

1231
    /**
1232 1233 1234
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1235 1236 1237 1238 1239
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1240
    /**
kabi's avatar
kabi committed
1241
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1242
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
     *
     * with FORCE flag you may instead enable given CPU features
     * (Dangerous: usable in case of misdetection, improper usage however will
     * result into program crash)
     */
    unsigned dsp_mask;
#define FF_MM_FORCE	0x80000000 /* force usage of selected flags (OR) */
    /* lower 16 bits - CPU features */
#ifdef HAVE_MMX
#define FF_MM_MMX	0x0001 /* standard MMX */
#define FF_MM_3DNOW	0x0004 /* AMD 3DNOW */
#define FF_MM_MMXEXT	0x0002 /* SSE integer functions or AMD MMX ext */
#define FF_MM_SSE	0x0008 /* SSE functions */
#define FF_MM_SSE2	0x0010 /* PIV SSE2 functions */
1257
#define FF_MM_3DNOWEXT	0x0020 /* AMD 3DNowExt */
kabi's avatar
kabi committed
1258
#endif /* HAVE_MMX */
1259 1260 1261
#ifdef HAVE_IWMMXT
#define FF_MM_IWMMXT	0x0100 /* XScale IWMMXT */
#endif /* HAVE_IWMMXT */
michaelni's avatar
michaelni committed
1262 1263

    /**
1264 1265 1266
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
michaelni's avatar
michaelni committed
1267 1268 1269 1270
     */
     int bits_per_sample;
    
    /**
1271 1272 1273
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
michaelni's avatar
michaelni committed
1274 1275 1276 1277 1278
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
michaelni's avatar
michaelni committed
1279 1280
    
    /**
michael's avatar
michael committed
1281
     * sample aspect ratio (0 if unknown).
1282
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1283 1284
     * - encoding: set by user.
     * - decoding: set by lavc.
michaelni's avatar
michaelni committed
1285
     */
michael's avatar
michael committed
1286
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1287 1288

    /**
1289 1290 1291
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
michaelni's avatar
michaelni committed
1292
     */
michaelni's avatar
michaelni committed
1293
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1294 1295

    /**
1296 1297 1298
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
michaelni's avatar
michaelni committed
1299 1300 1301 1302 1303 1304 1305 1306
     */
    int debug;
#define FF_DEBUG_PICT_INFO 1
#define FF_DEBUG_RC        2
#define FF_DEBUG_BITSTREAM 4
#define FF_DEBUG_MB_TYPE   8
#define FF_DEBUG_QP        16
#define FF_DEBUG_MV        32
1307
#define FF_DEBUG_DCT_COEFF 0x00000040
michaelni's avatar
michaelni committed
1308 1309 1310
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1311
#define FF_DEBUG_ER        0x00000400
michaelni's avatar
michaelni committed
1312
#define FF_DEBUG_MMCO      0x00000800
michaelni's avatar
michaelni committed
1313
#define FF_DEBUG_BUGS      0x00001000
michael's avatar
michael committed
1314 1315
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1316
    
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
    /**
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    int debug_mv;
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames

1327
    /**
1328 1329 1330
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1331 1332
     */
    uint64_t error[4];
michaelni's avatar
michaelni committed
1333 1334
    
    /**
1335
     * minimum MB quantizer.
1336
     * - encoding: unused
1337
     * - decoding: unused
michaelni's avatar
michaelni committed
1338 1339 1340 1341
     */
    int mb_qmin;

    /**
1342
     * maximum MB quantizer.
1343
     * - encoding: unused
1344
     * - decoding: unused
michaelni's avatar
michaelni committed
1345 1346
     */
    int mb_qmax;
michaelni's avatar
michaelni committed
1347 1348
    
    /**
1349 1350 1351
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1352 1353 1354
     */
    int me_cmp;
    /**
1355 1356 1357
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1358 1359 1360
     */
    int me_sub_cmp;
    /**
1361 1362 1363
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1364 1365
     */
    int mb_cmp;
michael's avatar
michael committed
1366 1367 1368 1369 1370 1371
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
michaelni's avatar
michaelni committed
1372 1373 1374 1375 1376 1377 1378 1379
#define FF_CMP_SAD  0
#define FF_CMP_SSE  1
#define FF_CMP_SATD 2
#define FF_CMP_DCT  3
#define FF_CMP_PSNR 4
#define FF_CMP_BIT  5
#define FF_CMP_RD   6
#define FF_CMP_ZERO 7
michael's avatar
michael committed
1380 1381
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1382
#define FF_CMP_NSSE 10
michael's avatar
michael committed
1383 1384
#define FF_CMP_W53  11
#define FF_CMP_W97  12
michael's avatar
michael committed
1385
#define FF_CMP_DCTMAX 13
michaelni's avatar
michaelni committed
1386 1387 1388
#define FF_CMP_CHROMA 256
    
    /**
1389 1390 1391
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1392 1393
     */
    int dia_size;
michaelni's avatar
michaelni committed
1394 1395

    /**
1396 1397 1398
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1399 1400
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1401

michaelni's avatar
michaelni committed
1402
    /**
1403 1404 1405
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1406 1407
     */
    int pre_me;
michaelni's avatar
michaelni committed
1408

michaelni's avatar
michaelni committed
1409
    /**
1410 1411 1412
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1413 1414
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1415

michaelni's avatar
michaelni committed
1416
    /**
1417 1418 1419
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1420 1421 1422
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1423
    /**
1424 1425 1426
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1427 1428 1429
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1430
    /**
1431
     * callback to negotiate the pixelFormat.
michaelni's avatar
michaelni committed
1432 1433 1434 1435
     * @param fmt is the list of formats which are supported by the codec,
     * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
     * the first is allways the native one
     * @return the choosen format
1436 1437
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
michaelni's avatar
michaelni committed
1438
     */
iive's avatar
iive committed
1439
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1440 1441 1442 1443 1444 1445

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1446 1447
     * - encoding: unused.
     * - decoding: set by decoder 
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457
     */
    int dtg_active_format;
#define FF_DTG_AFD_SAME         8
#define FF_DTG_AFD_4_3          9
#define FF_DTG_AFD_16_9         10
#define FF_DTG_AFD_14_9         11
#define FF_DTG_AFD_4_3_SP_14_9  13
#define FF_DTG_AFD_16_9_SP_14_9 14
#define FF_DTG_AFD_SP_4_3       15

1458 1459 1460 1461
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1462 1463
     * - encoding: set by user.
     * - decoding: unused.
1464
     */
kabi's avatar
kabi committed
1465
    int me_range;
1466

michaelni's avatar
michaelni committed
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
    /**
     * intra quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
    
    /**
     * inter quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_quant_bias;
1481 1482 1483 1484 1485 1486 1487 1488

    /**
     * color table ID.
     * - encoding: unused.
     * - decoding: which clrtable should be used for 8bit RGB images
     *             table have to be stored somewhere FIXME
     */
    int color_table_id;
michaelni's avatar
michaelni committed
1489
    
1490 1491
    /**
     * internal_buffer count. 
diego's avatar
diego committed
1492
     * Don't touch, used by lavc default_get_buffer()
1493 1494 1495 1496 1497
     */
    int internal_buffer_count;
    
    /**
     * internal_buffers. 
diego's avatar
diego committed
1498
     * Don't touch, used by lavc default_get_buffer()
1499 1500
     */
    void *internal_buffer;
1501 1502 1503 1504 1505 1506 1507

#define FF_LAMBDA_SHIFT 7
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
#define FF_LAMBDA_MAX (256*128-1)

#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
michaelni's avatar
michaelni committed
1508 1509 1510 1511 1512 1513 1514
    /**
     * global quality for codecs which cannot change it per frame.
     * this should be proportional to MPEG1/2/4 qscale.
     * - encoding: set by user.
     * - decoding: unused
     */
    int global_quality;
michaelni's avatar
michaelni committed
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530
    
#define FF_CODER_TYPE_VLC   0
#define FF_CODER_TYPE_AC    1
    /**
     * coder type
     * - encoding: set by user.
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
     * - encoding: set by user.
     * - decoding: unused
     */
    int context_model;
1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541
    
    /**
     * slice flags
     * - encoding: unused
     * - decoding: set by user.
     */
    int slice_flags;
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)

iive's avatar
iive committed
1542 1543 1544 1545 1546 1547
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
    
    /**
     * macroblock decision mode
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_decision;
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
#define FF_MB_DECISION_RD     2        ///< rate distoration
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571

    /**
     * custom intra quantization matrix
     * - encoding: set by user, can be NULL
     * - decoding: set by lavc
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
     * - encoding: set by user, can be NULL
     * - decoding: set by lavc
     */
    uint16_t *inter_matrix;
1572
    
1573 1574 1575 1576 1577 1578 1579
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
     * - encoding: unused
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int stream_codec_tag;
michaelni's avatar
michaelni committed
1580 1581 1582 1583 1584 1585 1586 1587

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601

    /**
     * minimum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmin;

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1602 1603 1604 1605 1606 1607 1608

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1609 1610 1611 1612 1613 1614 1615

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1616
    
1617
    /**
1618 1619 1620 1621 1622
     * called at the beginning of a frame to get cr buffer for it.
     * buffer type (size, hints) must be the same. lavc won't check it.
     * lavc will pass previous buffer in pic, function should return
     * same buffer or new buffer with old frame "painted" into it.
     * if pic.data[0] == NULL must behave like get_buffer().
1623
     * - encoding: unused
1624
     * - decoding: set by lavc, user can override
1625
     */
1626
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647

    /**
     * number of bits which should be loaded into the rc buffer before decoding starts
     * - encoding: set by user.
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_threshold;

    /**
     * CODEC_FLAG2_*.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    int flags2;
michael's avatar
michael committed
1648 1649 1650 1651 1652 1653 1654

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665
    
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
     * - decoding: set by user
     */
    int antialias_algo;
#define FF_AA_AUTO    0
#define FF_AA_FASTINT 1 //not implemented yet
#define FF_AA_INT     2
#define FF_AA_FLOAT   3
michael's avatar
michael committed
1666 1667 1668 1669 1670 1671
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

    /**
     * Thread count.
     * is used to decide how many independant tasks should be passed to execute()
     * - encoding: set by user
     * - decoding: set by user
     */
    int thread_count;
    
    /**
     * the codec may call this to execute several independant things. it will return only after
     * finishing all tasks, the user may replace this with some multithreaded implementation, the
     * default implementation will execute the parts serially
michael's avatar
michael committed
1685
     * @param count the number of things to execute
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697
     * - encoding: set by lavc, user can override
     * - decoding: set by lavc, user can override
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
    
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1698 1699

    /**
1700 1701
     * Motion estimation threshold. under which no motion estimation is 
     * performed, but instead the user specified motion vectors are used
1702 1703
     * 
     * - encoding: set by user
1704
     * - decoding: unused
1705
     */
michael's avatar
michael committed
1706
     int me_threshold;
1707 1708 1709 1710 1711 1712 1713

    /**
     * Macroblock threshold. under which the user specified macroblock types will be used
     * - encoding: set by user
     * - decoding: unused
     */
     int mb_threshold;
1714 1715

    /**
michael's avatar
michael committed
1716
     * precision of the intra dc coefficient - 8.
1717 1718 1719 1720
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1721 1722 1723 1724 1725 1726 1727

    /**
     * noise vs. sse weight for the nsse comparsion function.
     * - encoding: set by user
     * - decoding: unused
     */
     int nsse_weight;
1728 1729

    /**
1730
     * number of macroblock rows at the top which are skipped.
1731 1732 1733 1734 1735 1736
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
1737
     * number of macroblock rows at the bottom which are skipped.
1738 1739 1740 1741
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
michael's avatar
michael committed
1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757

    /**
     * profile
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99

    /**
     * level
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1758 1759 1760 1761 1762 1763 1764

    /**
     * low resolution decoding. 1-> 1/2 size, 2->1/4 size
     * - encoding: unused
     * - decoding: set by user
     */
     int lowres;
1765 1766

    /**
michael's avatar
michael committed
1767
     * bitsream width / height. may be different from width/height if lowres
1768 1769 1770 1771 1772
     * or other things are used
     * - encoding: unused
     * - decoding: set by user before init if known, codec should override / dynamically change if needed
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786

    /**
     * frame skip threshold
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800

    /**
     * frame skip exponent
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
     * frame skip comparission function
     * - encoding: set by user.
     * - decoding: unused
     */
    int frame_skip_cmp;
1801 1802 1803 1804 1805 1806 1807 1808

    /**
     * border processing masking. raises the quantizer for mbs on the borders
     * of the picture.
     * - encoding: set by user
     * - decoding: unused
     */
    float border_masking;
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822

    /**
     * minimum MB lagrange multipler.
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_lmin;

    /**
     * maximum MB lagrange multipler.
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_lmax;
1823 1824 1825 1826 1827 1828 1829

    /**
     * 
     * - encoding: set by user.
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850

    /**
     * 
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_loop_filter;

    /**
     * 
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_idct;

    /**
     * 
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_frame;
glantau's avatar
glantau committed
1851 1852
} AVCodecContext;

1853 1854 1855
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
1856
typedef struct AVCodec {
kabi's avatar
kabi committed
1857
    const char *name;
kabi's avatar
kabi committed
1858
    enum CodecType type;
michael's avatar
michael committed
1859
    enum CodecID id;
glantau's avatar
glantau committed
1860 1861
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
1862
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
1863
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
1864
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
kabi's avatar
kabi committed
1865
                  uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
1866
    int capabilities;
michael's avatar
michael committed
1867
#if LIBAVCODEC_VERSION_INT < ((50<<16)+(0<<8)+0)
1868
    void *dummy; // FIXME remove next time we break binary compatibility
michael's avatar
michael committed
1869
#endif
glantau's avatar
glantau committed
1870
    struct AVCodec *next;
michaelni's avatar
michaelni committed
1871
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
1872
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
1873
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
1874 1875
} AVCodec;

kabi's avatar
kabi committed
1876
/**
1877 1878 1879
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
1880
typedef struct AVPicture {
kabi's avatar
kabi committed
1881
    uint8_t *data[4];
michaelni's avatar
michaelni committed
1882
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
1883 1884
} AVPicture;

tmmm's avatar
tmmm committed
1885 1886 1887 1888 1889
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1890
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
1891
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
1892 1893 1894 1895 1896 1897
typedef struct AVPaletteControl {

    /* demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0 */
    int palette_changed;

1898 1899 1900 1901
    /* 4-byte ARGB palette entries, stored in native byte order; note that
     * the individual palette components should be on a 8-bit scale; if
     * the palette data comes from a IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled */
1902
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
1903 1904 1905

} AVPaletteControl;

1906
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
1907 1908 1909 1910 1911 1912 1913 1914
    uint16_t x;
    uint16_t y;
    uint16_t w;
    uint16_t h;
    uint16_t nb_colors;
    int linesize;
    uint32_t *rgba_palette;
    uint8_t *bitmap;
1915 1916 1917 1918 1919 1920 1921 1922
} AVSubtitleRect;

typedef struct AVSubtitle {
    uint16_t format; /* 0 = graphics */
    uint32_t start_display_time; /* relative to packet pts, in ms */
    uint32_t end_display_time; /* relative to packet pts, in ms */
    uint32_t num_rects;
    AVSubtitleRect *rects;
bellard's avatar
bellard committed
1923 1924
} AVSubtitle;

glantau's avatar
glantau committed
1925 1926
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1927
extern AVCodec mp3lame_encoder;
michaelni's avatar
 
michaelni committed
1928
extern AVCodec oggvorbis_encoder;
michael's avatar
michael committed
1929
extern AVCodec oggtheora_encoder;
1930
extern AVCodec faac_encoder;
1931
extern AVCodec xvid_encoder;
glantau's avatar
glantau committed
1932
extern AVCodec mpeg1video_encoder;
michaelni's avatar
michaelni committed
1933
extern AVCodec mpeg2video_encoder;
1934
extern AVCodec h261_encoder;
glantau's avatar
glantau committed
1935 1936
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1937
extern AVCodec flv_encoder;
glantau's avatar
glantau committed
1938
extern AVCodec rv10_encoder;
michael's avatar
michael committed
1939
extern AVCodec rv20_encoder;
romansh's avatar
 
romansh committed
1940
extern AVCodec dvvideo_encoder;
glantau's avatar
glantau committed
1941
extern AVCodec mjpeg_encoder;
1942
extern AVCodec ljpeg_encoder;
1943
extern AVCodec png_encoder;
1944 1945 1946 1947 1948
extern AVCodec ppm_encoder;
extern AVCodec pgm_encoder;
extern AVCodec pgmyuv_encoder;
extern AVCodec pbm_encoder;
extern AVCodec pam_encoder;
glantau's avatar
glantau committed
1949
extern AVCodec mpeg4_encoder;
1950 1951 1952
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
michaelni's avatar
 
michaelni committed
1953 1954
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
michaelni's avatar
michaelni committed
1955
extern AVCodec huffyuv_encoder;
lorenm's avatar
lorenm committed
1956
extern AVCodec ffvhuff_encoder;
michaelni's avatar
michaelni committed
1957
extern AVCodec h264_encoder;
michaelni's avatar
michaelni committed
1958
extern AVCodec asv1_encoder;
michaelni's avatar
michaelni committed
1959
extern AVCodec asv2_encoder;
michaelni's avatar
michaelni committed
1960
extern AVCodec vcr1_encoder;
1961
extern AVCodec ffv1_encoder;
michael's avatar
michael committed
1962
extern AVCodec snow_encoder;
1963
extern AVCodec mdec_encoder;
rtognimp's avatar
rtognimp committed
1964
extern AVCodec zlib_encoder;
1965 1966
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
1967
extern AVCodec svq1_encoder;
1968
extern AVCodec x264_encoder;
glantau's avatar
glantau committed
1969 1970

extern AVCodec h263_decoder;
1971
extern AVCodec h261_decoder;
glantau's avatar
glantau committed
1972
extern AVCodec mpeg4_decoder;
1973 1974 1975
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
michaelni's avatar
michaelni committed
1976
extern AVCodec wmv1_decoder;
michaelni's avatar
 
michaelni committed
1977
extern AVCodec wmv2_decoder;
1978 1979
extern AVCodec vc9_decoder;
extern AVCodec wmv3_decoder;
michaelni's avatar
michaelni committed
1980 1981
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
iive's avatar
iive committed
1982
extern AVCodec mpegvideo_decoder;
iive's avatar
iive committed
1983
extern AVCodec mpeg_xvmc_decoder;
glantau's avatar
glantau committed
1984
extern AVCodec h263i_decoder;
1985
extern AVCodec flv_decoder;
glantau's avatar
glantau committed
1986
extern AVCodec rv10_decoder;
michael's avatar
michael committed
1987
extern AVCodec rv20_decoder;
michael's avatar
michael committed
1988 1989
extern AVCodec rv30_decoder;
extern AVCodec rv40_decoder;
nickols_k's avatar
nickols_k committed
1990
extern AVCodec svq1_decoder;
michaelni's avatar
michaelni committed
1991
extern AVCodec svq3_decoder;
bellard's avatar
bellard committed
1992
extern AVCodec dvvideo_decoder;
bellard's avatar
bellard committed
1993 1994
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
glantau's avatar
glantau committed
1995
extern AVCodec mjpeg_decoder;
al3x's avatar
al3x committed
1996
extern AVCodec mjpegb_decoder;
alex's avatar
alex committed
1997
extern AVCodec sp5x_decoder;
1998
extern AVCodec png_decoder;
1999
extern AVCodec mp2_decoder;
glantau's avatar
glantau committed
2000
extern AVCodec mp3_decoder;
rtognimp's avatar
rtognimp committed
2001
extern AVCodec mp3adu_decoder;
2002
extern AVCodec mp3on4_decoder;
2003 2004
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
michaelni's avatar
michaelni committed
2005
extern AVCodec huffyuv_decoder;
lorenm's avatar
lorenm committed
2006
extern AVCodec ffvhuff_decoder;
kabi's avatar
kabi committed
2007
extern AVCodec oggvorbis_decoder;
michael's avatar
michael committed
2008
extern AVCodec oggtheora_decoder;
2009
extern AVCodec cyuv_decoder;
michaelni's avatar
michaelni committed
2010
extern AVCodec h264_decoder;
tmmm's avatar
tmmm committed
2011
extern AVCodec indeo3_decoder;
tmmm's avatar
tmmm committed
2012
extern AVCodec vp3_decoder;
2013
extern AVCodec theora_decoder;
2014
extern AVCodec amr_nb_decoder;
kabi's avatar
kabi committed
2015
extern AVCodec amr_nb_encoder;
2016 2017
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
2018 2019
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
michaelni's avatar
michaelni committed
2020
extern AVCodec asv1_decoder;
michaelni's avatar
michaelni committed
2021
extern AVCodec asv2_decoder;
michaelni's avatar
michaelni committed
2022
extern AVCodec vcr1_decoder;
al3x's avatar
al3x committed
2023
extern AVCodec cljr_decoder;
2024
extern AVCodec ffv1_decoder;
michael's avatar
michael committed
2025
extern AVCodec snow_decoder;
michaelni's avatar
michaelni committed
2026
extern AVCodec fourxm_decoder;
2027
extern AVCodec mdec_decoder;
2028 2029
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
2030
extern AVCodec xan_wc3_decoder;
2031 2032 2033 2034
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
tmmm's avatar
tmmm committed
2035
extern AVCodec vqa_decoder;
tmmm's avatar
tmmm committed
2036
extern AVCodec idcin_decoder;
rtognimp's avatar
rtognimp committed
2037
extern AVCodec eightbps_decoder;
2038
extern AVCodec smc_decoder;
melanson's avatar
melanson committed
2039
extern AVCodec flic_decoder;
2040 2041
extern AVCodec vmdvideo_decoder;
extern AVCodec vmdaudio_decoder;
2042
extern AVCodec truemotion1_decoder;
rtognimp's avatar
rtognimp committed
2043 2044
extern AVCodec mszh_decoder;
extern AVCodec zlib_decoder;
2045 2046
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
2047 2048
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
2049
extern AVCodec xan_dpcm_decoder;
2050
extern AVCodec sol_dpcm_decoder;
2051
extern AVCodec sonic_decoder;
2052
extern AVCodec qtrle_decoder;
michael's avatar
michael committed
2053
extern AVCodec flac_decoder;
2054
extern AVCodec tscc_decoder;
2055
extern AVCodec ulti_decoder;
2056
extern AVCodec qdraw_decoder;
2057
extern AVCodec xl_decoder;
2058
extern AVCodec qpeg_decoder;
2059
extern AVCodec shorten_decoder;
2060
extern AVCodec loco_decoder;
2061
extern AVCodec wnv1_decoder;
2062
extern AVCodec aasc_decoder;
2063
extern AVCodec alac_decoder;
2064
extern AVCodec ws_snd1_decoder;
2065
extern AVCodec indeo2_decoder;
2066
extern AVCodec vorbis_decoder;
2067
extern AVCodec fraps_decoder;
2068 2069
extern AVCodec libgsm_encoder;
extern AVCodec libgsm_decoder;
glantau's avatar
glantau committed
2070

glantau's avatar
glantau committed
2071 2072 2073
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
2074
extern AVCodec name ## _encoder
glantau's avatar
glantau committed
2075

2076 2077 2078 2079 2080 2081 2082 2083 2084
PCM_CODEC(CODEC_ID_PCM_S32LE, pcm_s32le);
PCM_CODEC(CODEC_ID_PCM_S32BE, pcm_s32be);
PCM_CODEC(CODEC_ID_PCM_U32LE, pcm_u32le);
PCM_CODEC(CODEC_ID_PCM_U32BE, pcm_u32be);
PCM_CODEC(CODEC_ID_PCM_S24LE, pcm_s24le);
PCM_CODEC(CODEC_ID_PCM_S24BE, pcm_s24be);
PCM_CODEC(CODEC_ID_PCM_U24LE, pcm_u24le);
PCM_CODEC(CODEC_ID_PCM_U24BE, pcm_u24be);
PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
glantau's avatar
glantau committed
2085 2086 2087 2088 2089 2090 2091 2092 2093
PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);

2094 2095 2096 2097
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2098 2099
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2100
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2101
PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2102
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
michaelni's avatar
michaelni committed
2103
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2104 2105
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2106
PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
romansh's avatar
 
romansh committed
2107
PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2108
PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2109
PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2110
PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2111

glantau's avatar
glantau committed
2112 2113 2114
#undef PCM_CODEC

/* dummy raw video codec */
romansh's avatar
 
romansh committed
2115 2116
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
glantau's avatar
glantau committed
2117 2118 2119

/* the following codecs use external GPL libs */
extern AVCodec ac3_decoder;
2120
extern AVCodec dts_decoder;
glantau's avatar
glantau committed
2121

bellard's avatar
bellard committed
2122 2123 2124
/* subtitles */
extern AVCodec dvdsub_decoder;
extern AVCodec dvbsub_encoder;
2125
extern AVCodec dvbsub_decoder;
bellard's avatar
bellard committed
2126

glantau's avatar
glantau committed
2127 2128 2129
/* resample.c */

struct ReSampleContext;
2130
struct AVResampleContext;
glantau's avatar
glantau committed
2131 2132 2133 2134 2135 2136 2137 2138

typedef struct ReSampleContext ReSampleContext;

ReSampleContext *audio_resample_init(int output_channels, int input_channels, 
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

michael's avatar
michael committed
2139
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2140
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
michael's avatar
michael committed
2141
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2142
void av_resample_close(struct AVResampleContext *c);
2143

glantau's avatar
glantau committed
2144 2145 2146 2147 2148 2149 2150 2151
/* YUV420 format is assumed ! */

struct ImgReSampleContext;

typedef struct ImgReSampleContext ImgReSampleContext;

ImgReSampleContext *img_resample_init(int output_width, int output_height,
                                      int input_width, int input_height);
2152 2153 2154 2155

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2156 2157 2158 2159
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2160

glantau's avatar
glantau committed
2161
void img_resample(ImgReSampleContext *s, 
2162
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2163 2164 2165

void img_resample_close(ImgReSampleContext *s);

michael's avatar
michael committed
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
 * @param picture the picture to be filled in.
 * @param pix_fmt the format of the picture.
 * @param width the width of the picture.
 * @param height the height of the picture.
 * @return 0 if successful, -1 if not.
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

/* Free a picture previously allocated by avpicture_alloc. */
void avpicture_free(AVPicture *picture);

kabi's avatar
kabi committed
2180
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2181
                   int pix_fmt, int width, int height);
2182
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2183
                     unsigned char *dest, int dest_size);
2184
int avpicture_get_size(int pix_fmt, int width, int height);
2185 2186
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2187
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2188
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2189
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2190

2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202
#define FF_LOSS_RESOLUTION  0x0001 /* loss due to resolution change */
#define FF_LOSS_DEPTH       0x0002 /* loss due to color depth change */
#define FF_LOSS_COLORSPACE  0x0004 /* loss due to color space conversion */
#define FF_LOSS_ALPHA       0x0008 /* loss of alpha bits */
#define FF_LOSS_COLORQUANT  0x0010 /* loss due to color quantization */
#define FF_LOSS_CHROMA      0x0020 /* loss of chroma (e.g. rgb to gray conversion) */

int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

bellard's avatar
bellard committed
2203 2204
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2205 2206
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
bellard's avatar
bellard committed
2207

2208 2209
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
2210
                const AVPicture *src, int pix_fmt, 
2211 2212 2213
                int width, int height);

/* deinterlace a picture */
2214
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2215 2216 2217 2218 2219 2220
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

nickols_k's avatar
nickols_k committed
2221
/* returns LIBAVCODEC_VERSION_INT constant */
2222
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2223
/* returns LIBAVCODEC_BUILD constant */
2224
unsigned avcodec_build(void);
glantau's avatar
glantau committed
2225 2226 2227 2228
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
2229
AVCodec *avcodec_find_encoder_by_name(const char *name);
glantau's avatar
glantau committed
2230 2231 2232 2233
AVCodec *avcodec_find_decoder(enum CodecID id);
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

michaelni's avatar
michaelni committed
2234
void avcodec_get_context_defaults(AVCodecContext *s);
mellum's avatar
mellum committed
2235
AVCodecContext *avcodec_alloc_context(void);
mellum's avatar
mellum committed
2236
void avcodec_get_frame_defaults(AVFrame *pic);
michaelni's avatar
michaelni committed
2237
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
2238

michaelni's avatar
michaelni committed
2239 2240
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2241 2242
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2243
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
michael's avatar
michael committed
2244
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
michaelni's avatar
michaelni committed
2245

michael's avatar
1l  
michael committed
2246 2247 2248
int avcodec_thread_init(AVCodecContext *s, int thread_count);
void avcodec_thread_free(AVCodecContext *s);
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
michael's avatar
michael committed
2249
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2250 2251
//FIXME func typedef

michaelni's avatar
michaelni committed
2252 2253 2254 2255
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
glantau's avatar
glantau committed
2256
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2257

kabi's avatar
kabi committed
2258
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
glantau's avatar
glantau committed
2259
                         int *frame_size_ptr,
kabi's avatar
kabi committed
2260
                         uint8_t *buf, int buf_size);
michaelni's avatar
michaelni committed
2261
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
glantau's avatar
glantau committed
2262
                         int *got_picture_ptr,
kabi's avatar
kabi committed
2263
                         uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2264 2265 2266
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
kabi's avatar
kabi committed
2267
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
2268
                        int *data_size_ptr,
kabi's avatar
kabi committed
2269 2270
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
glantau's avatar
glantau committed
2271
                         const short *samples);
kabi's avatar
kabi committed
2272
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
michaelni's avatar
michaelni committed
2273
                         const AVFrame *pict);
bellard's avatar
bellard committed
2274 2275
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2276 2277 2278 2279

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
glantau's avatar
glantau committed
2280

michaelni's avatar
michaelni committed
2281 2282
void avcodec_flush_buffers(AVCodecContext *avctx);

2283 2284
void avcodec_default_free_buffers(AVCodecContext *s);

2285
/* misc usefull functions */
michaelni's avatar
michaelni committed
2286 2287 2288 2289 2290 2291

/**
 * returns a single letter to describe the picture type
 */
char av_get_pict_type_char(int pict_type);

2292

bellard's avatar
bellard committed
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
    int64_t cur_offset; /* current offset 
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
    int pict_type; /* XXX: put it back in AVCodecContext */
    int repeat_pict; /* XXX: put it back in AVCodecContext */
bellard's avatar
bellard committed
2304 2305 2306 2307 2308 2309
    int64_t pts;     /* pts of the current frame */
    int64_t dts;     /* dts of the current frame */

    /* private data */
    int64_t last_pts;
    int64_t last_dts;
michael's avatar
michael committed
2310
    int fetch_timestamp;
bellard's avatar
bellard committed
2311 2312 2313 2314 2315 2316

#define AV_PARSER_PTS_NB 4
    int cur_frame_start_index;
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
michael's avatar
michael committed
2317 2318 2319
    
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
bellard's avatar
bellard committed
2320 2321 2322
} AVCodecParserContext;

typedef struct AVCodecParser {
michael's avatar
michael committed
2323
    int codec_ids[5]; /* several codec IDs are permitted */
bellard's avatar
bellard committed
2324 2325 2326 2327 2328 2329 2330
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
    int (*parser_parse)(AVCodecParserContext *s, 
                        AVCodecContext *avctx,
                        uint8_t **poutbuf, int *poutbuf_size, 
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2331
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2332 2333 2334 2335 2336 2337 2338 2339 2340 2341
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
int av_parser_parse(AVCodecParserContext *s, 
                    AVCodecContext *avctx,
                    uint8_t **poutbuf, int *poutbuf_size, 
bellard's avatar
bellard committed
2342 2343
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2344 2345 2346 2347
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
                     uint8_t **poutbuf, int *poutbuf_size, 
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2348 2349 2350 2351
void av_parser_close(AVCodecParserContext *s);

extern AVCodecParser mpegvideo_parser;
extern AVCodecParser mpeg4video_parser;
2352
extern AVCodecParser h261_parser;
bellard's avatar
bellard committed
2353 2354
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
michael's avatar
michael committed
2355
extern AVCodecParser mjpeg_parser;
michael's avatar
michael committed
2356
extern AVCodecParser pnm_parser;
bellard's avatar
bellard committed
2357 2358
extern AVCodecParser mpegaudio_parser;
extern AVCodecParser ac3_parser;
bellard's avatar
bellard committed
2359
extern AVCodecParser dvdsub_parser;
2360
extern AVCodecParser dvbsub_parser;
bellard's avatar
bellard committed
2361

bellard's avatar
bellard committed
2362
/* memory */
2363
void *av_malloc(unsigned int size);
kabi's avatar
kabi committed
2364
void *av_mallocz(unsigned int size);
2365
void *av_realloc(void *ptr, unsigned int size);
bellard's avatar
bellard committed
2366
void av_free(void *ptr);
2367
char *av_strdup(const char *s);
michael's avatar
michael committed
2368
void av_freep(void *ptr);
kabi's avatar
kabi committed
2369
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2370 2371
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2372
void av_free_static(void);
2373
void *av_mallocz_static(unsigned int size);
2374
void *av_realloc_static(void *ptr, unsigned int size);
bellard's avatar
bellard committed
2375

2376 2377 2378
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

2379 2380 2381
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2382 2383 2384 2385
/* av_log API */

#include <stdarg.h>

2386
#define AV_LOG_QUIET -1
2387 2388 2389 2390
#define AV_LOG_ERROR 0
#define AV_LOG_INFO 1
#define AV_LOG_DEBUG 2

2391
#ifdef __GNUC__
2392
extern void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2393 2394 2395 2396
#else
extern void av_log(void*, int level, const char *fmt, ...);
#endif

2397
extern void av_vlog(void*, int level, const char *fmt, va_list);
2398 2399
extern int av_log_get_level(void);
extern void av_log_set_level(int);
2400
extern void av_log_set_callback(void (*)(void*, int, const char*, va_list));
2401

2402
/* endian macros */
2403
#if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2404 2405 2406 2407 2408 2409 2410 2411 2412 2413
#define BE_16(x)  ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
#define BE_32(x)  ((((uint8_t*)(x))[0] << 24) | \
                   (((uint8_t*)(x))[1] << 16) | \
                   (((uint8_t*)(x))[2] << 8) | \
                    ((uint8_t*)(x))[3])
#define LE_16(x)  ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
#define LE_32(x)  ((((uint8_t*)(x))[3] << 24) | \
                   (((uint8_t*)(x))[2] << 16) | \
                   (((uint8_t*)(x))[1] << 8) | \
                    ((uint8_t*)(x))[0])
2414
#endif
2415

mru's avatar
mru committed
2416 2417
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

kabi's avatar
kabi committed
2418 2419 2420 2421
#ifdef __cplusplus
}
#endif

glantau's avatar
glantau committed
2422
#endif /* AVCODEC_H */