avcodec.h 52.5 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

glantau's avatar
glantau committed
14
#include "common.h"
michael's avatar
michael committed
15
#include "rational.h"
glantau's avatar
glantau committed
16

bellard's avatar
bellard committed
17 18
#define FFMPEG_VERSION_INT     0x000408
#define FFMPEG_VERSION         "0.4.8"
19
#define LIBAVCODEC_BUILD       4688
20

bellard's avatar
bellard committed
21 22 23 24 25 26
#define LIBAVCODEC_VERSION_INT FFMPEG_VERSION_INT
#define LIBAVCODEC_VERSION     FFMPEG_VERSION

#define AV_STRINGIFY(s)	AV_TOSTRING(s)
#define AV_TOSTRING(s) #s
#define LIBAVCODEC_IDENT	"FFmpeg" LIBAVCODEC_VERSION "b" AV_STRINGIFY(LIBAVCODEC_BUILD)
al3x's avatar
al3x committed
27

glantau's avatar
glantau committed
28 29 30
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
31
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
iive's avatar
iive committed
32
    CODEC_ID_MPEG2VIDEO_XVMC,
glantau's avatar
glantau committed
33 34 35
    CODEC_ID_H263,
    CODEC_ID_RV10,
    CODEC_ID_MP2,
36
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
michaelni's avatar
 
michaelni committed
37
    CODEC_ID_VORBIS,
glantau's avatar
glantau committed
38 39
    CODEC_ID_AC3,
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
40
    CODEC_ID_MJPEGB,
41
    CODEC_ID_LJPEG,
alex's avatar
alex committed
42
    CODEC_ID_SP5X,
glantau's avatar
glantau committed
43
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
44
    CODEC_ID_RAWVIDEO,
45 46 47
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
48
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
49
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
50 51
    CODEC_ID_H263P,
    CODEC_ID_H263I,
52
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
53
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
54
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
55 56
    CODEC_ID_DVVIDEO,
    CODEC_ID_DVAUDIO,
bellard's avatar
bellard committed
57 58
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
59 60
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
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,
67 68
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
michaelni's avatar
michaelni committed
69
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
70
    CODEC_ID_ASV2,
71
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
72
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
73
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
74
    CODEC_ID_CLJR,
75
    CODEC_ID_MDEC,
76 77
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
78 79
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
80 81 82 83 84
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
85
    CODEC_ID_IDCIN,
glantau's avatar
glantau committed
86 87 88 89 90 91 92 93 94 95

    /* various pcm "codecs" */
    CODEC_ID_PCM_S16LE,
    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,
96 97 98 99

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
100 101
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
102
    CODEC_ID_ADPCM_IMA_WS,
103
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
104
    CODEC_ID_ADPCM_4XM,
105 106
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
107 108 109

	/* AMR */
    CODEC_ID_AMR_NB,
110 111
    CODEC_ID_AMR_WB,

112 113 114
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
115 116 117 118

    /* various DPCM codecs */
    CODEC_ID_ROQ_DPCM,
    CODEC_ID_INTERPLAY_DPCM,
119
    CODEC_ID_XAN_DPCM,
120 121 122
    
    CODEC_ID_MPEG2TS, /* _FAKE_ codec to indicate a raw MPEG2 transport
                         stream (only used by libavformat) */
glantau's avatar
glantau committed
123
};
124 125 126

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
glantau's avatar
glantau committed
127 128

enum CodecType {
129
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
130 131
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
132
    CODEC_TYPE_DATA,
glantau's avatar
glantau committed
133 134
};

135
/**
tmmm's avatar
tmmm committed
136 137 138 139 140 141 142 143 144 145 146 147
 * 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
148 149 150 151
 * 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.
152
 */
glantau's avatar
glantau committed
153
enum PixelFormat {
michaelni's avatar
michaelni committed
154 155 156 157 158 159
    PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
    PIX_FMT_YUV422,    
    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
160
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
michaelni's avatar
michaelni committed
161 162
    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)
163 164
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
165
    PIX_FMT_GRAY8,
166 167 168
    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
169 170 171
    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
172 173
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
174
    PIX_FMT_NB,
glantau's avatar
glantau committed
175 176
};

glantau's avatar
glantau committed
177 178
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
179
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
glantau's avatar
glantau committed
180 181
};

glantau's avatar
glantau committed
182
/* in bytes */
bellard's avatar
bellard committed
183
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
glantau's avatar
glantau committed
184

185
/**
186 187 188 189 190
 * 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
191 192 193
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

194 195
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
196
    ME_ZERO = 1,
197 198 199 200 201 202 203
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

michaelni's avatar
michaelni committed
204 205 206 207 208 209 210
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;

211 212 213
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

214
/* ME algos sorted by quality */
michaelni's avatar
michaelni committed
215
//FIXME remove IMHO
216 217
static const __attribute__((unused)) int Motion_Est_QTab[] =
 { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
glantau's avatar
glantau committed
218

219

michaelni's avatar
michaelni committed
220
#define FF_MAX_B_FRAMES 8
221

michaelni's avatar
michaelni committed
222 223 224 225
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
glantau's avatar
glantau committed
226

227 228 229 230
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed 
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
231
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
232
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
233 234
/* 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
235
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
236 237 238 239 240 241 242
#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 
#define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges 
#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 
243
                                            of only at frame boundaries */
244 245
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
246
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
247 248 249 250
#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) 
251
/* Fx : Flag for h263+ extra options */
michaelni's avatar
michaelni committed
252 253
#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
254
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
255
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
256 257 258 259 260 261 262 263 264 265
/* For advanced prediction mode, we reuse the 4MV flag */
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Deblocking filter internal loop
 * 		Slice structured
 * 		Reference Picture Selection
 * 		Independant Segment Decoding
 * 		Alternative Inter * 		VLC
 * 		Modified Quantization */
/* /Fx */
glantau's avatar
glantau committed
266 267
/* codec capabilities */

268
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
michaelni's avatar
michaelni committed
269 270 271 272 273
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
274 275 276
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
277
#define CODEC_CAP_TRUNCATED       0x0008
glantau's avatar
glantau committed
278

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
/**
 * 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
307
#define FF_COMMON_FRAME \
michaelni's avatar
michaelni committed
308 309 310 311 312 313
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
michaelni's avatar
michaelni committed
314 315 316
    uint8_t *data[4];\
    int linesize[4];\
    /**\
michaelni's avatar
michaelni committed
317
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
michaelni's avatar
michaelni committed
318
     * this isnt used by lavc unless the default get/release_buffer() is used\
319 320
     * - encoding: \
     * - decoding: \
michaelni's avatar
michaelni committed
321 322 323 324
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
325 326
     * - encoding: set by lavc\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
327 328 329 330
     */\
    int key_frame;\
\
    /**\
michaelni's avatar
michaelni committed
331
     * picture type of the frame, see ?_TYPE below.\
332 333
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
334 335 336 337 338 339
     */\
    int pict_type;\
\
    /**\
     * presentation timestamp in micro seconds (time when frame should be shown to user)\
     * if 0 then the frame_rate will be used as reference\
340 341
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
342
     */\
343
    int64_t pts;\
michaelni's avatar
michaelni committed
344 345 346
\
    /**\
     * picture number in bitstream order.\
347 348
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
349 350 351 352
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
353 354
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
355 356 357 358
     */\
    int display_picture_number;\
\
    /**\
359
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
360 361
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
362
     */\
363
    int quality; \
michaelni's avatar
michaelni committed
364 365 366
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
367
     * set to INT_MAX if the buffer has not been used yet \
368 369
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
michaelni's avatar
michaelni committed
370 371 372 373 374
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
375 376
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
michaelni's avatar
michaelni committed
377 378 379 380 381
     */\
    int reference;\
\
    /**\
     * QP table\
382 383
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
384 385 386 387
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
388 389
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
390 391 392 393 394 395
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
396 397
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
398 399 400 401 402
     */\
    uint8_t *mbskip_table;\
\
    /**\
     * for some private data of the user\
403 404
     * - encoding: unused\
     * - decoding: set by user\
michaelni's avatar
michaelni committed
405 406
     */\
    void *opaque;\
407 408 409
\
    /**\
     * error\
410 411
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
412 413
     */\
    uint64_t error[4];\
michaelni's avatar
michaelni committed
414 415 416
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
417 418
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
mellum's avatar
mellum committed
419
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
michaelni's avatar
michaelni committed
420 421
     */\
    int type;\
422 423 424 425
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
426 427
     * - encoding: unused\
     * - decoding: set by lavc\
428
     */\
michaelni's avatar
michaelni committed
429 430 431 432 433 434
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
romansh's avatar
 
romansh committed
435 436 437 438 439 440 441 442 443
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
444
     * if the content is interlaced, is top field displayed first.\
romansh's avatar
 
romansh committed
445
     * - encoding: set by user\
446
     * - decoding: set by lavc\
romansh's avatar
 
romansh committed
447
     */\
448
    int top_field_first;\
449 450 451 452 453 454 455
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
456 457 458 459 460 461 462
    \
    /**\
     * 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;\
463

michaelni's avatar
michaelni committed
464 465
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
michaelni's avatar
michaelni committed
466 467

#define FF_BUFFER_TYPE_INTERNAL 1
michaelni's avatar
michaelni committed
468 469 470
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewher else, dont dealloc image (data/base)
#define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, dont dealloc anything
michaelni's avatar
michaelni committed
471

michaelni's avatar
michaelni committed
472

473 474 475 476
#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
477 478
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
479

michaelni's avatar
michaelni committed
480 481 482
/**
 * Audio Video Frame.
 */
michaelni's avatar
michaelni committed
483 484 485
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
486

487
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
488 489 490 491

/**
 * main external api structure.
 */
glantau's avatar
glantau committed
492
typedef struct AVCodecContext {
493
    /**
494 495 496
     * 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 
497
     */
glantau's avatar
glantau committed
498
    int bit_rate;
499 500

    /**
501
     * number of bits the bitstream is allowed to diverge from the reference.
502
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
503 504
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
505 506 507 508
     */
    int bit_rate_tolerance; 

    /**
509 510 511
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
512
     */
glantau's avatar
glantau committed
513
    int flags;
514 515 516

    /**
     * some codecs needs additionnal format info. It is stored here
517 518
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
519 520 521 522
     */
    int sub_id;

    /**
523 524 525
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
526 527 528 529
     */
    int me_method;

    /**
530
     * some codecs need / can use extra-data like huffman tables.
531 532
     * mjpeg: huffman tables
     * rv10: additional flags
533
     * mpeg4: global headers (they can be in the bitstream or here)
534 535
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
536
     */
537 538 539
    void *extradata;
    int extradata_size;
    
glantau's avatar
glantau committed
540
    /* video only */
541
    /**
542
     * frames per sec multiplied by frame_rate_base.
543
     * for variable fps this is the precission, so if the timestamps 
544
     * can be specified in msec precssion then this is 1000*frame_rate_base
545 546
     * - encoding: MUST be set by user
     * - decoding: set by lavc. 0 or the frame_rate if available
547 548
     */
    int frame_rate;
549
    
550
    /**
551 552
     * width / height.
     * - encoding: MUST be set by user. 
michael's avatar
michael committed
553
     * - decoding: set by user if known, codec should override / dynamically change if needed
554
     */
glantau's avatar
glantau committed
555
    int width, height;
556
    
michaelni's avatar
michaelni committed
557 558 559 560 561
#define FF_ASPECT_SQUARE 1
#define FF_ASPECT_4_3_625 2
#define FF_ASPECT_4_3_525 3
#define FF_ASPECT_16_9_625 4
#define FF_ASPECT_16_9_525 5
562
#define FF_ASPECT_EXTENDED 15
563 564

    /**
565 566 567
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
568 569 570 571
     */
    int gop_size;

    /**
572
     * pixel format, see PIX_FMT_xxx.
romansh's avatar
 
romansh committed
573 574 575 576
     * - encoding: FIXME: used by ffmpeg to decide whether an pix_fmt
     *                    conversion is in order. This only works for
     *                    codecs with one supported pix_fmt, we should
     *                    do something for a generic case as well.
577
     * - decoding: set by lavc.
578
     */
579
    enum PixelFormat pix_fmt;
580 581 582 583 584 585 586 587 588
 
    /**
     * 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;
       
589 590 591 592 593
    /**
     * 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
594 595
     * - encoding: unused
     * - decoding: set by user.
596 597 598 599
     * @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
600
     */
glantau's avatar
glantau committed
601
    void (*draw_horiz_band)(struct AVCodecContext *s,
602
                            const AVFrame *src, int offset[4],
603
                            int y, int type, int height);
glantau's avatar
glantau committed
604

glantau's avatar
glantau committed
605
    /* audio only */
606
    int sample_rate; ///< samples per sec 
glantau's avatar
glantau committed
607
    int channels;
608
    int sample_fmt;  ///< sample format, currenly unused 
glantau's avatar
glantau committed
609 610

    /* the following data should not be initialized */
611 612 613
    int frame_size;     ///< in samples, initialized when calling 'init' 
    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
614
    
615 616
    /**
     * number of frames the decoded output will be delayed relative to 
617 618 619
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
620 621
     */
    int delay;
michaelni's avatar
michaelni committed
622
    
623 624 625
    /* - 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) 
626 627
    
    /**
628 629 630
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
631 632 633 634
     */
    int qmin;

    /**
635 636 637
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
638 639 640 641
     */
    int qmax;

    /**
642 643 644
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
645 646 647 648
     */
    int max_qdiff;

    /**
649
     * maximum number of b frames between non b frames.
650
     * note: the output will be delayed by max_b_frames+1 relative to the input
651 652
     * - encoding: set by user.
     * - decoding: unused
653 654 655 656
     */
    int max_b_frames;

    /**
657 658 659
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
660 661 662 663 664
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
michaelni's avatar
michaelni committed
665
    int b_frame_strategy;
666

667
    /**
668 669 670
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
671 672
     */
    int hurry_up;
673
    
glantau's avatar
glantau committed
674
    struct AVCodec *codec;
675
    
glantau's avatar
glantau committed
676 677
    void *priv_data;

678
    /* The following data is for RTP friendly coding */
michaelni's avatar
 
michaelni committed
679
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
680 681 682 683 684 685 686 687 688 689
    int rtp_mode;   /* 1 for activate RTP friendly-mode           */
                    /* highers numbers represent more error-prone */
                    /* enviroments, by now just "1" exist         */
    
    int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
                            /* 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    */
690 691 692 693 694 695 696 697

    
    /* The RTP callcack: This function is called  */
    /* every time the encoder as a packet to send */
    /* Depends on the encoder if the data starts  */
    /* with a Start Code (it should) H.263 does   */
    void (*rtp_callback)(void *data, int size, int packet_number); 

michaelni's avatar
michaelni committed
698 699 700 701 702 703 704 705
    /* 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;
706 707 708
    int misc_bits;
    
    /**
709 710
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
michaelni's avatar
michaelni committed
711
     * - decoding: unused
712
     */
michaelni's avatar
michaelni committed
713
    int frame_bits;
michaelni's avatar
michaelni committed
714

715
    /**
716 717 718
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
719 720 721
     */
    void *opaque;

glantau's avatar
glantau committed
722
    char codec_name[32];
723 724
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
michaelni's avatar
michaelni committed
725 726 727 728
    
    /**
     * 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
729
     * - encoding: set by user, if not then the default based on codec_id will be used
michaelni's avatar
michaelni committed
730 731 732
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
michaelni's avatar
 
michaelni committed
733
    
734
    /**
735 736 737
     * workaround bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: unused
     * - decoding: set by user
738 739
     */
    int workaround_bugs;
740
#define FF_BUG_AUTODETECT       1  ///< autodetection
741 742 743 744
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
745
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
michaelni's avatar
michaelni committed
746
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
747
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
748
#define FF_BUG_QPEL_CHROMA2     256
749
#define FF_BUG_DIRECT_BLOCKSIZE 512
750
#define FF_BUG_EDGE             1024
751 752
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
753
    /**
754 755 756
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
757
     */
michaelni's avatar
 
michaelni committed
758
    int luma_elim_threshold;
759 760
    
    /**
761 762 763
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
764
     */
michaelni's avatar
 
michaelni committed
765
    int chroma_elim_threshold;
766 767
    
    /**
768 769 770
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
771 772 773 774
     */
    int strict_std_compliance;
    
    /**
775
     * qscale offset between ip and b frames.
776 777
     * 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)
778 779
     * - encoding: set by user.
     * - decoding: unused
780 781 782 783
     */
    float b_quant_offset;
    
    /**
784
     * error resilience higher values will detect more errors but may missdetect
785 786 787
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
788
     */
michaelni's avatar
 
michaelni committed
789
    int error_resilience;
790 791 792 793
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
794
    
795
    /**
michaelni's avatar
michaelni committed
796 797
     * 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
798
     * width and height should be rounded up to the next multiple of 16
799 800
     * - encoding: unused
     * - decoding: set by lavc, user can override
801
     */
michaelni's avatar
michaelni committed
802
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
803 804
    
    /**
michaelni's avatar
michaelni committed
805 806 807
     * 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
808 809
     * - encoding: unused
     * - decoding: set by lavc, user can override
810
     */
michaelni's avatar
michaelni committed
811
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
812

813
    /**
814 815 816
     * is 1 if the decoded stream contains b frames, 0 otherwise.
     * - encoding: unused
     * - decoding: set by lavc
817 818 819
     */
    int has_b_frames;
    
820
    int block_align; ///< used by some WAV based audio codecs
michaelni's avatar
michaelni committed
821
    
822
    int parse_only; /* - decoding only: if true, only parsing is done
823 824
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
michaelni's avatar
michaelni committed
825
    
826
    /**
827
     * 0-> h263 quant 1-> mpeg quant.
828 829
     * - encoding: set by user.
     * - decoding: unused
830 831
     */
    int mpeg_quant;
michaelni's avatar
michaelni committed
832
    
833
    /**
834 835 836
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
837
     */
838
    char *stats_out;
839 840 841 842
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
843 844
     * - encoding: allocated/set/freed by user
     * - decoding: unused
845 846 847 848
     */
    char *stats_in;
    
    /**
849
     * ratecontrol qmin qmax limiting method.
850
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
851 852
     * - encoding: set by user.
     * - decoding: unused
853
     */
michaelni's avatar
michaelni committed
854
    float rc_qsquish;
855

michaelni's avatar
michaelni committed
856 857
    float rc_qmod_amp;
    int rc_qmod_freq;
858 859
    
    /**
860 861 862
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
863
     */
michaelni's avatar
michaelni committed
864 865
    RcOverride *rc_override;
    int rc_override_count;
866 867
    
    /**
868 869 870
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
871
     */
michaelni's avatar
michaelni committed
872
    char *rc_eq;
873 874
    
    /**
875 876 877
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
878
     */
michaelni's avatar
michaelni committed
879
    int rc_max_rate;
880 881
    
    /**
882 883 884
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
885
     */
michaelni's avatar
michaelni committed
886
    int rc_min_rate;
887 888
    
    /**
889 890 891
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
892
     */
michaelni's avatar
michaelni committed
893 894
    int rc_buffer_size;
    float rc_buffer_aggressivity;
895 896

    /**
897 898 899
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
900 901 902 903
     */
    float i_quant_factor;
    
    /**
904
     * qscale offset between p and i frames.
905 906
     * 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)
907 908
     * - encoding: set by user.
     * - decoding: unused
909 910 911 912
     */
    float i_quant_offset;
    
    /**
913 914 915
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
916
     */
michaelni's avatar
michaelni committed
917
    float rc_initial_cplx;
918

919
    /**
920 921 922
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
923
     */
924
    int dct_algo;
925
#define FF_DCT_AUTO    0
926
#define FF_DCT_FASTINT 1
927 928 929
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
930
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
931
#define FF_DCT_FAAN    6
932 933
    
    /**
934 935 936
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
937 938 939 940
     */
    float lumi_masking;
    
    /**
941 942 943
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
944 945 946 947
     */
    float temporal_cplx_masking;
    
    /**
948 949 950
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
951 952 953 954
     */
    float spatial_cplx_masking;
    
    /**
955 956 957
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
958 959
     */
    float p_masking;
960

961
    /**
962 963 964
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
965 966
     */
    float dark_masking;
967
    
968 969 970 971
    
    /* for binary compatibility */
    int unused;
    
972
    /**
973 974 975
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
976 977 978 979 980 981 982 983 984 985
     */
    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
986
#define FF_IDCT_ALTIVEC      8
987
#define FF_IDCT_SH4          9
988
#define FF_IDCT_SIMPLEARM    10
989

990
    /**
991 992 993
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
994 995 996
     */
    int slice_count;
    /**
997 998 999
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1000 1001 1002
     */
    int *slice_offset;

1003
    /**
1004 1005 1006
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1007 1008 1009 1010 1011
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1012
    /**
kabi's avatar
kabi committed
1013
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1014
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
     *
     * 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 */
#endif /* HAVE_MMX */
michaelni's avatar
michaelni committed
1030 1031

    /**
1032 1033 1034
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
michaelni's avatar
michaelni committed
1035 1036 1037 1038
     */
     int bits_per_sample;
    
    /**
1039 1040 1041
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
michaelni's avatar
michaelni committed
1042 1043 1044 1045 1046
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
michaelni's avatar
michaelni committed
1047 1048
    
    /**
michael's avatar
michael committed
1049
     * sample aspect ratio (0 if unknown).
1050 1051
     * - encoding: set by user.
     * - decoding: set by lavc.
michaelni's avatar
michaelni committed
1052
     */
michael's avatar
michael committed
1053
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1054 1055

    /**
1056 1057 1058
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
michaelni's avatar
michaelni committed
1059
     */
michaelni's avatar
michaelni committed
1060
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1061 1062

    /**
1063 1064 1065
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
michaelni's avatar
michaelni committed
1066 1067 1068 1069 1070 1071 1072 1073
     */
    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
michaelni's avatar
michaelni committed
1074 1075 1076 1077
#define FF_DEBUG_VIS_MV    0x00000040
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1078
#define FF_DEBUG_ER        0x00000400
michaelni's avatar
michaelni committed
1079
#define FF_DEBUG_MMCO      0x00000800
michaelni's avatar
michaelni committed
1080
#define FF_DEBUG_BUGS      0x00001000
1081 1082
    
    /**
1083 1084 1085
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1086 1087
     */
    uint64_t error[4];
michaelni's avatar
michaelni committed
1088 1089
    
    /**
1090 1091 1092
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1093 1094 1095 1096
     */
    int mb_qmin;

    /**
1097 1098 1099
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1100 1101
     */
    int mb_qmax;
michaelni's avatar
michaelni committed
1102 1103
    
    /**
1104 1105 1106
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1107 1108 1109
     */
    int me_cmp;
    /**
1110 1111 1112
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1113 1114 1115
     */
    int me_sub_cmp;
    /**
1116 1117 1118
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
     */
    int mb_cmp;
#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
#define FF_CMP_CHROMA 256
    
    /**
1132 1133 1134
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1135 1136
     */
    int dia_size;
michaelni's avatar
michaelni committed
1137 1138

    /**
1139 1140 1141
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1142 1143
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1144

michaelni's avatar
michaelni committed
1145
    /**
1146 1147 1148
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1149 1150
     */
    int pre_me;
michaelni's avatar
michaelni committed
1151

michaelni's avatar
michaelni committed
1152
    /**
1153 1154 1155
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1156 1157
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1158

michaelni's avatar
michaelni committed
1159
    /**
1160 1161 1162
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1163 1164 1165
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1166
    /**
1167 1168 1169
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1170 1171 1172
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1173
    /**
1174
     * callback to negotiate the pixelFormat.
michaelni's avatar
michaelni committed
1175 1176 1177 1178
     * @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
1179 1180
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
michaelni's avatar
michaelni committed
1181 1182
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1183 1184 1185 1186 1187 1188

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1189 1190
     * - encoding: unused.
     * - decoding: set by decoder 
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
     */
    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

1201 1202 1203 1204
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1205 1206
     * - encoding: set by user.
     * - decoding: unused.
1207
     */
kabi's avatar
kabi committed
1208
    int me_range;
1209

michaelni's avatar
michaelni committed
1210 1211 1212 1213 1214 1215 1216 1217
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

michaelni's avatar
michaelni committed
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
    int frame_rate_base;
    /**
     * 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;
1233 1234 1235 1236 1237 1238 1239 1240

    /**
     * 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
1241
    
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
    /**
     * internal_buffer count. 
     * Dont touch, used by lavc default_get_buffer()
     */
    int internal_buffer_count;
    
    /**
     * internal_buffers. 
     * Dont touch, used by lavc default_get_buffer()
     */
    void *internal_buffer;
1253 1254 1255 1256 1257 1258 1259

#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
1260 1261 1262 1263 1264 1265 1266
    /**
     * 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
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
    
#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;
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
    
    /**
     * 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
1294 1295 1296 1297 1298 1299
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
    
    /**
     * 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
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323

    /**
     * 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;
1324
    
1325 1326 1327 1328 1329 1330 1331
    /**
     * 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
1332 1333 1334 1335 1336 1337 1338 1339

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1354 1355 1356 1357 1358 1359 1360

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1361
    
glantau's avatar
glantau committed
1362 1363
} AVCodecContext;

kabi's avatar
kabi committed
1364

1365 1366 1367
/**
 * AVOption.
 */
kabi's avatar
kabi committed
1368 1369 1370
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
kabi's avatar
kabi committed
1371 1372
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
kabi's avatar
kabi committed
1373 1374 1375 1376
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1377 1378 1379 1380 1381
#define FF_OPT_TYPE_BOOL 1      ///< boolean - true,1,on  (or simply presence)
#define FF_OPT_TYPE_DOUBLE 2    ///< double
#define FF_OPT_TYPE_INT 3       ///< integer
#define FF_OPT_TYPE_STRING 4    ///< string (finished with \0)
#define FF_OPT_TYPE_MASK 0x1f	///< mask for types - upper bits are various flags
kabi's avatar
kabi committed
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
//#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
#define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
#define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
    /** min value  (min == max   ->  no limits) */
    double min;
    /** maximum value for double/int */
    double max;
    /** default boo [0,1]l/double/int value */
    double defval;
    /**
     * default string value (with optional semicolon delimited extra option-list
     * i.e.   option1;option2;option3
     * defval might select other then first argument as default
     */
    const char *defstr;
#define FF_OPT_MAX_DEPTH 10
} AVOption;

kabi's avatar
kabi committed
1400 1401 1402 1403 1404 1405 1406 1407 1408
/**
 * Parse option(s) and sets fields in passed structure
 * @param strct	structure where the parsed results will be written
 * @param list  list with AVOptions
 * @param opts	string with options for parsing
 */
int avoption_parse(void* strct, const AVOption* list, const char* opts);


1409 1410 1411
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
1412
typedef struct AVCodec {
kabi's avatar
kabi committed
1413
    const char *name;
kabi's avatar
kabi committed
1414
    enum CodecType type;
glantau's avatar
glantau committed
1415 1416 1417
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
1418
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
1419
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
1420
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
kabi's avatar
kabi committed
1421
                  uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
1422
    int capabilities;
kabi's avatar
kabi committed
1423
    const AVOption *options;
glantau's avatar
glantau committed
1424
    struct AVCodec *next;
michaelni's avatar
michaelni committed
1425
    void (*flush)(AVCodecContext *);
glantau's avatar
glantau committed
1426 1427
} AVCodec;

kabi's avatar
kabi committed
1428
/**
1429 1430 1431
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
1432
typedef struct AVPicture {
kabi's avatar
kabi committed
1433
    uint8_t *data[4];
michaelni's avatar
michaelni committed
1434
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
1435 1436
} AVPicture;

tmmm's avatar
tmmm committed
1437 1438 1439 1440 1441
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1442
#define AVPALETTE_SIZE 256
tmmm's avatar
tmmm committed
1443 1444 1445 1446 1447 1448
typedef struct AVPaletteControl {

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

1449 1450 1451 1452 1453
    /* 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 */
    unsigned int palette[AVPALETTE_SIZE];
tmmm's avatar
tmmm committed
1454 1455 1456

} AVPaletteControl;

glantau's avatar
glantau committed
1457 1458
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1459
extern AVCodec mp3lame_encoder;
michaelni's avatar
 
michaelni committed
1460
extern AVCodec oggvorbis_encoder;
1461
extern AVCodec faac_encoder;
glantau's avatar
glantau committed
1462
extern AVCodec mpeg1video_encoder;
michaelni's avatar
michaelni committed
1463
extern AVCodec mpeg2video_encoder;
glantau's avatar
glantau committed
1464 1465
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1466
extern AVCodec flv_encoder;
glantau's avatar
glantau committed
1467 1468
extern AVCodec rv10_encoder;
extern AVCodec mjpeg_encoder;
1469
extern AVCodec ljpeg_encoder;
glantau's avatar
glantau committed
1470
extern AVCodec mpeg4_encoder;
1471 1472 1473
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
michaelni's avatar
 
michaelni committed
1474 1475
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
michaelni's avatar
michaelni committed
1476
extern AVCodec huffyuv_encoder;
michaelni's avatar
michaelni committed
1477
extern AVCodec h264_encoder;
michaelni's avatar
michaelni committed
1478
extern AVCodec asv1_encoder;
michaelni's avatar
michaelni committed
1479
extern AVCodec asv2_encoder;
michaelni's avatar
michaelni committed
1480
extern AVCodec vcr1_encoder;
1481
extern AVCodec ffv1_encoder;
1482
extern AVCodec mdec_encoder;
glantau's avatar
glantau committed
1483 1484

extern AVCodec h263_decoder;
glantau's avatar
glantau committed
1485
extern AVCodec mpeg4_decoder;
1486 1487 1488
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
michaelni's avatar
michaelni committed
1489
extern AVCodec wmv1_decoder;
michaelni's avatar
 
michaelni committed
1490
extern AVCodec wmv2_decoder;
michaelni's avatar
michaelni committed
1491 1492
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
iive's avatar
iive committed
1493
extern AVCodec mpeg_xvmc_decoder;
glantau's avatar
glantau committed
1494
extern AVCodec h263i_decoder;
1495
extern AVCodec flv_decoder;
glantau's avatar
glantau committed
1496
extern AVCodec rv10_decoder;
nickols_k's avatar
nickols_k committed
1497
extern AVCodec svq1_decoder;
michaelni's avatar
michaelni committed
1498
extern AVCodec svq3_decoder;
bellard's avatar
bellard committed
1499
extern AVCodec dvvideo_decoder;
bellard's avatar
bellard committed
1500 1501
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
glantau's avatar
glantau committed
1502
extern AVCodec mjpeg_decoder;
al3x's avatar
al3x committed
1503
extern AVCodec mjpegb_decoder;
alex's avatar
alex committed
1504
extern AVCodec sp5x_decoder;
1505
extern AVCodec mp2_decoder;
glantau's avatar
glantau committed
1506
extern AVCodec mp3_decoder;
1507 1508
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
michaelni's avatar
michaelni committed
1509
extern AVCodec huffyuv_decoder;
kabi's avatar
kabi committed
1510
extern AVCodec oggvorbis_decoder;
1511
extern AVCodec cyuv_decoder;
michaelni's avatar
michaelni committed
1512
extern AVCodec h264_decoder;
tmmm's avatar
tmmm committed
1513
extern AVCodec indeo3_decoder;
tmmm's avatar
tmmm committed
1514
extern AVCodec vp3_decoder;
1515
extern AVCodec theora_decoder;
1516
extern AVCodec amr_nb_decoder;
kabi's avatar
kabi committed
1517
extern AVCodec amr_nb_encoder;
1518 1519
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
1520 1521
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
michaelni's avatar
michaelni committed
1522
extern AVCodec asv1_decoder;
michaelni's avatar
michaelni committed
1523
extern AVCodec asv2_decoder;
michaelni's avatar
michaelni committed
1524
extern AVCodec vcr1_decoder;
al3x's avatar
al3x committed
1525
extern AVCodec cljr_decoder;
1526
extern AVCodec ffv1_decoder;
michaelni's avatar
michaelni committed
1527
extern AVCodec fourxm_decoder;
1528
extern AVCodec mdec_decoder;
1529 1530
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1531
extern AVCodec xan_wc3_decoder;
1532 1533 1534 1535
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
tmmm's avatar
tmmm committed
1536
extern AVCodec vqa_decoder;
tmmm's avatar
tmmm committed
1537
extern AVCodec idcin_decoder;
1538 1539
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1540 1541
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1542
extern AVCodec xan_dpcm_decoder;
glantau's avatar
glantau committed
1543

glantau's avatar
glantau committed
1544 1545 1546
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1547
extern AVCodec name ## _encoder
glantau's avatar
glantau committed
1548 1549 1550 1551 1552 1553 1554 1555 1556 1557

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);

1558 1559 1560 1561
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1562 1563
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1564
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1565
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
michaelni's avatar
michaelni committed
1566
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1567 1568
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1569

glantau's avatar
glantau committed
1570 1571 1572
#undef PCM_CODEC

/* dummy raw video codec */
romansh's avatar
 
romansh committed
1573 1574
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
glantau's avatar
glantau committed
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597

/* the following codecs use external GPL libs */
extern AVCodec ac3_decoder;

/* resample.c */

struct ReSampleContext;

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);

/* 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);
1598 1599 1600 1601 1602 1603

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
                                      int leftBand, int rightBand);

glantau's avatar
glantau committed
1604
void img_resample(ImgReSampleContext *s, 
1605
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
1606 1607 1608

void img_resample_close(ImgReSampleContext *s);

michael's avatar
michael committed
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
/**
 * 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
1623
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1624
                   int pix_fmt, int width, int height);
1625
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
1626
                     unsigned char *dest, int dest_size);
1627
int avpicture_get_size(int pix_fmt, int width, int height);
1628 1629
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);
romansh's avatar
 
romansh committed
1630
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1631

1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643
#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
1644 1645
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
1646 1647
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
bellard's avatar
bellard committed
1648

1649 1650
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
1651
                const AVPicture *src, int pix_fmt, 
1652 1653 1654
                int width, int height);

/* deinterlace a picture */
1655
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
1656 1657 1658 1659 1660 1661
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

nickols_k's avatar
nickols_k committed
1662
/* returns LIBAVCODEC_VERSION_INT constant */
1663
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
1664
/* returns LIBAVCODEC_BUILD constant */
1665
unsigned avcodec_build(void);
glantau's avatar
glantau committed
1666 1667 1668 1669
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1670
AVCodec *avcodec_find_encoder_by_name(const char *name);
glantau's avatar
glantau committed
1671 1672 1673 1674
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
1675
void avcodec_get_context_defaults(AVCodecContext *s);
mellum's avatar
mellum committed
1676
AVCodecContext *avcodec_alloc_context(void);
michaelni's avatar
michaelni committed
1677
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
1678

michaelni's avatar
michaelni committed
1679 1680
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1681
void avcodec_default_free_buffers(AVCodecContext *s);
michaelni's avatar
michaelni committed
1682

michaelni's avatar
michaelni committed
1683 1684 1685 1686
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
glantau's avatar
glantau committed
1687
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
1688

kabi's avatar
kabi committed
1689
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
glantau's avatar
glantau committed
1690
                         int *frame_size_ptr,
kabi's avatar
kabi committed
1691
                         uint8_t *buf, int buf_size);
michaelni's avatar
michaelni committed
1692
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
glantau's avatar
glantau committed
1693
                         int *got_picture_ptr,
kabi's avatar
kabi committed
1694 1695
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1696
                        int *data_size_ptr,
kabi's avatar
kabi committed
1697 1698
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
glantau's avatar
glantau committed
1699
                         const short *samples);
kabi's avatar
kabi committed
1700
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
michaelni's avatar
michaelni committed
1701
                         const AVFrame *pict);
glantau's avatar
glantau committed
1702 1703 1704 1705

int avcodec_close(AVCodecContext *avctx);

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

michaelni's avatar
michaelni committed
1707 1708
void avcodec_flush_buffers(AVCodecContext *avctx);

1709
/* misc usefull functions */
michaelni's avatar
michaelni committed
1710 1711 1712 1713 1714 1715

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

1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728
/**
 * reduce a fraction.
 * this is usefull for framerate calculations
 * @param max the maximum allowed for dst_nom & dst_den
 * @return 1 if exact, 0 otherwise
 */
int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);

/**
 * rescale a 64bit integer.
 * a simple a*b/c isnt possible as it can overflow
 */
int64_t av_rescale(int64_t a, int b, int c);
1729 1730


kabi's avatar
kabi committed
1731 1732 1733 1734 1735 1736 1737
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1738
    /// compressed size used from given memory buffer
kabi's avatar
kabi committed
1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
    int size;
    /// I/P/B frame type
    int frame_type;
} avc_enc_result_t;

/**
 * Commands
 * order can't be changed - once it was defined
 */
typedef enum {
    // general commands
    AVC_OPEN_BY_NAME = 0xACA000,
    AVC_OPEN_BY_CODEC_ID,
    AVC_OPEN_BY_FOURCC,
    AVC_CLOSE,

    AVC_FLUSH,
    // pin - struct { uint8_t* src, uint_t src_size }
    // pout - struct { AVPicture* img, consumed_bytes,
    AVC_DECODE,
    // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
    // pout - uint_t used_from_dest_size
    AVC_ENCODE, 

    // query/get video commands
    AVC_GET_VERSION = 0xACB000,
    AVC_GET_WIDTH,
    AVC_GET_HEIGHT,
    AVC_GET_DELAY,
    AVC_GET_QUANT_TABLE,
    // ...

    // query/get audio commands
    AVC_GET_FRAME_SIZE = 0xABC000,

    // maybe define some simple structure which
    // might be passed to the user - but they can't
    // contain any codec specific parts and these
    // calls are usualy necessary only few times

    // set video commands
    AVC_SET_WIDTH = 0xACD000,
    AVC_SET_HEIGHT,

    // set video encoding commands
    AVC_SET_FRAME_RATE = 0xACD800,
    AVC_SET_QUALITY,
    AVC_SET_HURRY_UP,

    // set audio commands
    AVC_SET_SAMPLE_RATE = 0xACE000,
    AVC_SET_CHANNELS,

} avc_cmd_t;

/**
 * \param handle  allocated private structure by libavcodec
 *                for initialization pass NULL - will be returned pout
 *                user is supposed to know nothing about its structure
 * \param cmd     type of operation to be performed
 * \param pint    input parameter
 * \param pout    output parameter
 *
 * \returns  command status - eventually for query command it might return
 * integer resulting value
 */
int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);

bellard's avatar
bellard committed
1807
/* memory */
1808
void *av_malloc(unsigned int size);
kabi's avatar
kabi committed
1809
void *av_mallocz(unsigned int size);
1810
void *av_realloc(void *ptr, unsigned int size);
bellard's avatar
bellard committed
1811
void av_free(void *ptr);
1812
char *av_strdup(const char *s);
bellard's avatar
bellard committed
1813 1814
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
kabi's avatar
kabi committed
1815
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1816 1817
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
1818
void av_free_static(void);
1819 1820
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
bellard's avatar
bellard committed
1821

1822 1823 1824
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

kabi's avatar
kabi committed
1825 1826 1827 1828
#ifdef __cplusplus
}
#endif

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