avcodec.h 46.1 KB
Newer Older
F
Fabrice Bellard 已提交
1 2 3
#ifndef AVCODEC_H
#define AVCODEC_H

M
Michael Niedermayer 已提交
4 5
/**
 * @file avcodec.h
M
doxy  
Michael Niedermayer 已提交
6
 * external api header.
M
Michael Niedermayer 已提交
7 8 9
 */


10 11 12 13
#ifdef __cplusplus
extern "C" {
#endif

F
Fabrice Bellard 已提交
14 15
#include "common.h"

A
Alex Beregszaszi 已提交
16 17
#define LIBAVCODEC_VERSION_INT 0x000408
#define LIBAVCODEC_VERSION     "0.4.8"
M
Michael Niedermayer 已提交
18 19
#define LIBAVCODEC_BUILD       4677
#define LIBAVCODEC_BUILD_STR   "4677"
20

A
Alex Beregszaszi 已提交
21 22
#define LIBAVCODEC_IDENT	"FFmpeg" LIBAVCODEC_VERSION "b" LIBAVCODEC_BUILD_STR

F
Fabrice Bellard 已提交
23 24 25
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
M
Michael Niedermayer 已提交
26
    CODEC_ID_MPEG2VIDEO,
I
Ivan Kalvachev 已提交
27
    CODEC_ID_MPEG2VIDEO_XVMC,
F
Fabrice Bellard 已提交
28 29 30
    CODEC_ID_H263,
    CODEC_ID_RV10,
    CODEC_ID_MP2,
31
    CODEC_ID_MP3LAME,
32
    CODEC_ID_VORBIS,
F
Fabrice Bellard 已提交
33 34
    CODEC_ID_AC3,
    CODEC_ID_MJPEG,
35
    CODEC_ID_MJPEGB,
36
    CODEC_ID_LJPEG,
F
Fabrice Bellard 已提交
37
    CODEC_ID_MPEG4,
F
Fabrice Bellard 已提交
38
    CODEC_ID_RAWVIDEO,
39 40 41
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
42
    CODEC_ID_WMV1,
M
Michael Niedermayer 已提交
43
    CODEC_ID_WMV2,
F
Fabrice Bellard 已提交
44 45
    CODEC_ID_H263P,
    CODEC_ID_H263I,
46
    CODEC_ID_FLV1,
N
Nick Kurshev 已提交
47
    CODEC_ID_SVQ1,
M
Michael Niedermayer 已提交
48
    CODEC_ID_SVQ3,
F
Fabrice Bellard 已提交
49 50
    CODEC_ID_DVVIDEO,
    CODEC_ID_DVAUDIO,
F
Fabrice Bellard 已提交
51 52
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
53 54
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
M
huffyuv  
Michael Niedermayer 已提交
55
    CODEC_ID_HUFFYUV,
56
    CODEC_ID_CYUV,
M
Michael Niedermayer 已提交
57
    CODEC_ID_H264,
58
    CODEC_ID_INDEO3,
59
    CODEC_ID_VP3,
60 61
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
M
Michael Niedermayer 已提交
62
    CODEC_ID_ASV1,
M
Michael Niedermayer 已提交
63
    CODEC_ID_ASV2,
64
    CODEC_ID_FFV1,
65
    CODEC_ID_4XM,
M
Michael Niedermayer 已提交
66
    CODEC_ID_VCR1,
A
Alex Beregszaszi 已提交
67
    CODEC_ID_CLJR,
68
    CODEC_ID_MDEC,
69 70
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
F
Fabrice Bellard 已提交
71 72 73 74 75 76 77 78 79 80

    /* 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,
81 82 83 84 85

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
    CODEC_ID_ADPCM_MS,
86
    CODEC_ID_ADPCM_4XM,
87 88 89

	/* AMR */
    CODEC_ID_AMR_NB,
90 91 92
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
93 94 95 96

    /* various DPCM codecs */
    CODEC_ID_ROQ_DPCM,
    CODEC_ID_INTERPLAY_DPCM,
F
Fabrice Bellard 已提交
97
};
M
Michael Niedermayer 已提交
98
#define CODEC_ID_MPEGVIDEO CODEC_ID_MPEG1VIDEO
F
Fabrice Bellard 已提交
99 100

enum CodecType {
101
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
102 103 104 105
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
};

106 107 108
/**
 * Pixel format.
 */
F
Fabrice Bellard 已提交
109
enum PixelFormat {
M
Michael Niedermayer 已提交
110 111 112 113 114 115
    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)
116
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA...
M
Michael Niedermayer 已提交
117 118
    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)
119 120
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
121
    PIX_FMT_GRAY8,
122 123 124
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
M
Michael Niedermayer 已提交
125 126 127
    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)
I
Ivan Kalvachev 已提交
128 129
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
130
    PIX_FMT_NB,
F
Fabrice Bellard 已提交
131 132
};

F
Fabrice Bellard 已提交
133 134
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
135
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
F
Fabrice Bellard 已提交
136 137
};

F
Fabrice Bellard 已提交
138
/* in bytes */
F
Fabrice Bellard 已提交
139
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
F
Fabrice Bellard 已提交
140

141
/**
142 143 144 145 146
 * 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
147 148 149
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

150 151
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
152
    ME_ZERO = 1,
153 154 155 156 157 158 159
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

M
Michael Niedermayer 已提交
160 161 162 163 164 165 166
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;

167 168 169
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

170
/* ME algos sorted by quality */
171 172
static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG, 
                                       ME_X1, ME_EPZS, ME_FULL };
F
Fabrice Bellard 已提交
173

174

M
Michael Niedermayer 已提交
175
#define FF_MAX_B_FRAMES 8
176

M
Michael Niedermayer 已提交
177 178 179 180
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
F
Fabrice Bellard 已提交
181

182 183 184 185 186
#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 
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
187 188
/* 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 */
189
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
190 191 192 193 194 195 196
#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 
197
                                            of only at frame boundaries */
198 199
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
200
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
201 202 203 204
#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) 
205
/* Fx : Flag for h263+ extra options */
206 207
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< Advanced intra coding 
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
208 209 210 211 212 213 214 215 216 217
/* 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 */
F
Fabrice Bellard 已提交
218 219
/* codec capabilities */

220
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
M
Michael Niedermayer 已提交
221 222 223 224 225
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
226 227 228
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
229
#define CODEC_CAP_TRUNCATED       0x0008
F
Fabrice Bellard 已提交
230

M
Michael Niedermayer 已提交
231
#define FF_COMMON_FRAME \
M
Michael Niedermayer 已提交
232 233 234 235 236 237
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
M
cleanup  
Michael Niedermayer 已提交
238 239 240
    uint8_t *data[4];\
    int linesize[4];\
    /**\
M
Michael Niedermayer 已提交
241
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
M
cleanup  
Michael Niedermayer 已提交
242
     * this isnt used by lavc unless the default get/release_buffer() is used\
243 244
     * - encoding: \
     * - decoding: \
M
cleanup  
Michael Niedermayer 已提交
245 246 247 248
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
249 250
     * - encoding: set by lavc\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
251 252 253 254
     */\
    int key_frame;\
\
    /**\
M
Michael Niedermayer 已提交
255
     * picture type of the frame, see ?_TYPE below.\
256 257
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
258 259 260 261 262 263
     */\
    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\
264 265
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
266
     */\
267
    int64_t pts;\
M
cleanup  
Michael Niedermayer 已提交
268 269 270
\
    /**\
     * picture number in bitstream order.\
271 272
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
273 274 275 276
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
277 278
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
279 280 281 282 283
     */\
    int display_picture_number;\
\
    /**\
     * quality (between 1 (good) and 31 (bad)) \
284 285
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
286 287 288 289 290 291
     */\
    float quality; \
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
     * set to something large if the buffer has not been used yet \
292 293
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
M
cleanup  
Michael Niedermayer 已提交
294 295 296 297 298
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
299 300
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
M
cleanup  
Michael Niedermayer 已提交
301 302 303 304 305
     */\
    int reference;\
\
    /**\
     * QP table\
306 307
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
308 309 310 311
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
312 313
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
314 315 316 317 318 319
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
320 321
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
322 323 324 325 326
     */\
    uint8_t *mbskip_table;\
\
    /**\
     * for some private data of the user\
327 328
     * - encoding: unused\
     * - decoding: set by user\
M
cleanup  
Michael Niedermayer 已提交
329 330
     */\
    void *opaque;\
331 332 333
\
    /**\
     * error\
334 335
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
336 337
     */\
    uint64_t error[4];\
M
Michael Niedermayer 已提交
338 339 340
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
341 342
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
F
Falk Hüffner 已提交
343
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
M
Michael Niedermayer 已提交
344 345
     */\
    int type;\
346 347 348 349
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
350 351
     * - encoding: unused\
     * - decoding: set by lavc\
352
     */\
M
Michael Niedermayer 已提交
353 354 355 356 357 358
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
359

M
Michael Niedermayer 已提交
360 361
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
362 363

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
364 365 366
#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
M
Michael Niedermayer 已提交
367

M
cleanup  
Michael Niedermayer 已提交
368

369 370 371 372
#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
M
Michael Niedermayer 已提交
373 374
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
375

M
Michael Niedermayer 已提交
376 377 378
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
379 380 381
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
382

383
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
384 385 386 387

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
388
typedef struct AVCodecContext {
389
    /**
390 391 392
     * 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 
393
     */
F
Fabrice Bellard 已提交
394
    int bit_rate;
395 396

    /**
397
     * number of bits the bitstream is allowed to diverge from the reference.
398
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
399 400
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
401 402 403 404
     */
    int bit_rate_tolerance; 

    /**
405 406 407
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
408
     */
F
Fabrice Bellard 已提交
409
    int flags;
410 411 412

    /**
     * some codecs needs additionnal format info. It is stored here
413 414
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
415 416 417 418
     */
    int sub_id;

    /**
419 420 421
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
422 423 424 425
     */
    int me_method;

    /**
426
     * some codecs need / can use extra-data like huffman tables.
427 428
     * mjpeg: huffman tables
     * rv10: additional flags
429
     * mpeg4: global headers (they can be in the bitstream or here)
430 431
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
432
     */
433 434 435
    void *extradata;
    int extradata_size;
    
F
Fabrice Bellard 已提交
436
    /* video only */
437
    /**
438
     * frames per sec multiplied by frame_rate_base.
439
     * for variable fps this is the precission, so if the timestamps 
440
     * can be specified in msec precssion then this is 1000*frame_rate_base
441 442
     * - encoding: MUST be set by user
     * - decoding: set by lavc. 0 or the frame_rate if available
443 444
     */
    int frame_rate;
445
    
446
    /**
447 448 449
     * width / height.
     * - encoding: MUST be set by user. 
     * - decoding: set by user, some codecs might override / change it during playback
450
     */
F
Fabrice Bellard 已提交
451
    int width, height;
452
    
M
Michael Niedermayer 已提交
453 454 455 456 457
#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
458
#define FF_ASPECT_EXTENDED 15
459 460

    /**
461 462 463
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
464 465 466 467
     */
    int gop_size;

    /**
468
     * pixel format, see PIX_FMT_xxx.
469 470 471 472
     * - 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.
473
     * - decoding: set by lavc.
474
     */
475
    enum PixelFormat pix_fmt;
476 477 478 479 480 481 482 483 484
 
    /**
     * 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;
       
485 486 487 488 489
    /**
     * 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
490 491
     * - encoding: unused
     * - decoding: set by user.
492 493 494 495
     * @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
496
     */
F
Fabrice Bellard 已提交
497
    void (*draw_horiz_band)(struct AVCodecContext *s,
M
Michael Niedermayer 已提交
498
                            AVFrame *src, int offset[4],
499
                            int y, int type, int height);
F
Fabrice Bellard 已提交
500

F
Fabrice Bellard 已提交
501
    /* audio only */
502
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
503
    int channels;
504
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
505 506

    /* the following data should not be initialized */
507 508 509
    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 
M
cleanup  
Michael Niedermayer 已提交
510
    
511 512
    /**
     * number of frames the decoded output will be delayed relative to 
513 514 515
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
516 517
     */
    int delay;
M
Michael Niedermayer 已提交
518
    
519 520 521
    /* - 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) 
522 523
    
    /**
524 525 526
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
527 528 529 530
     */
    int qmin;

    /**
531 532 533
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
534 535 536 537
     */
    int qmax;

    /**
538 539 540
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
541 542 543 544
     */
    int max_qdiff;

    /**
545
     * maximum number of b frames between non b frames.
546
     * note: the output will be delayed by max_b_frames+1 relative to the input
547 548
     * - encoding: set by user.
     * - decoding: unused
549 550 551 552
     */
    int max_b_frames;

    /**
553 554 555
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
556 557 558 559 560
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
561
    int b_frame_strategy;
562

563
    /**
564 565 566
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
567 568
     */
    int hurry_up;
569
    
F
Fabrice Bellard 已提交
570
    struct AVCodec *codec;
571
    
F
Fabrice Bellard 已提交
572 573
    void *priv_data;

574
    /* The following data is for RTP friendly coding */
575
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
576 577 578 579 580 581 582 583 584 585
    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    */
586 587 588 589 590 591 592 593

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

594 595 596 597 598 599 600 601
    /* 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;
602 603 604
    int misc_bits;
    
    /**
605 606
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
607
     * - decoding: unused
608
     */
609
    int frame_bits;
610

611
    /**
612 613 614
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
615 616 617
     */
    void *opaque;

F
Fabrice Bellard 已提交
618
    char codec_name[32];
619 620
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
621 622 623 624
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
625
     * - encoding: set by user, if not then the default based on codec_id will be used
626 627 628
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
629
    
630
    /**
631 632 633
     * workaround bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: unused
     * - decoding: set by user
634 635
     */
    int workaround_bugs;
636
#define FF_BUG_AUTODETECT       1  ///< autodetection
637 638 639 640 641
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
#define FF_BUG_AC_VLC           32
M
Michael Niedermayer 已提交
642
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
643
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
644
#define FF_BUG_QPEL_CHROMA2     256
645
#define FF_BUG_DIRECT_BLOCKSIZE 512
646
#define FF_BUG_EDGE             1024
647 648
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
649
    /**
650 651 652
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
653
     */
654
    int luma_elim_threshold;
655 656
    
    /**
657 658 659
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
660
     */
661
    int chroma_elim_threshold;
662 663
    
    /**
664 665 666
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
667 668 669 670
     */
    int strict_std_compliance;
    
    /**
671
     * qscale offset between ip and b frames.
672 673
     * 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)
674 675
     * - encoding: set by user.
     * - decoding: unused
676 677 678 679
     */
    float b_quant_offset;
    
    /**
680
     * error resilience higher values will detect more errors but may missdetect
681 682 683
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
684
     */
685
    int error_resilience;
686 687 688 689
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
690
    
691
    /**
M
cleanup  
Michael Niedermayer 已提交
692 693
     * 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
694
     * width and height should be rounded up to the next multiple of 16
695 696
     * - encoding: unused
     * - decoding: set by lavc, user can override
697
     */
M
Michael Niedermayer 已提交
698
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
699 700
    
    /**
M
cleanup  
Michael Niedermayer 已提交
701 702 703
     * 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
704 705
     * - encoding: unused
     * - decoding: set by lavc, user can override
706
     */
M
Michael Niedermayer 已提交
707
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
708

709
    /**
710 711 712
     * is 1 if the decoded stream contains b frames, 0 otherwise.
     * - encoding: unused
     * - decoding: set by lavc
713 714 715
     */
    int has_b_frames;
    
716
    int block_align; ///< used by some WAV based audio codecs
M
Michael Niedermayer 已提交
717
    
718
    int parse_only; /* - decoding only: if true, only parsing is done
719 720
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
M
Michael Niedermayer 已提交
721
    
722
    /**
723
     * 0-> h263 quant 1-> mpeg quant.
724 725
     * - encoding: set by user.
     * - decoding: unused
726 727
     */
    int mpeg_quant;
M
Michael Niedermayer 已提交
728
    
729
    /**
730 731 732
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
733
     */
734
    char *stats_out;
735 736 737 738
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
739 740
     * - encoding: allocated/set/freed by user
     * - decoding: unused
741 742 743 744
     */
    char *stats_in;
    
    /**
745
     * ratecontrol qmin qmax limiting method.
746
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
747 748
     * - encoding: set by user.
     * - decoding: unused
749
     */
M
Michael Niedermayer 已提交
750
    float rc_qsquish;
751

M
Michael Niedermayer 已提交
752 753
    float rc_qmod_amp;
    int rc_qmod_freq;
754 755
    
    /**
756 757 758
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
759
     */
M
Michael Niedermayer 已提交
760 761
    RcOverride *rc_override;
    int rc_override_count;
762 763
    
    /**
764 765 766
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
767
     */
M
Michael Niedermayer 已提交
768
    char *rc_eq;
769 770
    
    /**
771 772 773
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
774
     */
M
Michael Niedermayer 已提交
775
    int rc_max_rate;
776 777
    
    /**
778 779 780
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
781
     */
M
Michael Niedermayer 已提交
782
    int rc_min_rate;
783 784
    
    /**
785 786 787
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
788
     */
M
Michael Niedermayer 已提交
789 790
    int rc_buffer_size;
    float rc_buffer_aggressivity;
791 792

    /**
793 794 795
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
796 797 798 799
     */
    float i_quant_factor;
    
    /**
800
     * qscale offset between p and i frames.
801 802
     * 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)
803 804
     * - encoding: set by user.
     * - decoding: unused
805 806 807 808
     */
    float i_quant_offset;
    
    /**
809 810 811
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
812
     */
M
Michael Niedermayer 已提交
813
    float rc_initial_cplx;
814

815
    /**
816 817 818
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
819
     */
820
    int dct_algo;
821
#define FF_DCT_AUTO    0
822
#define FF_DCT_FASTINT 1
823 824 825
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
826
#define FF_DCT_ALTIVEC 5
827 828
    
    /**
829 830 831
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
832 833 834 835
     */
    float lumi_masking;
    
    /**
836 837 838
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
839 840 841 842
     */
    float temporal_cplx_masking;
    
    /**
843 844 845
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
846 847 848 849
     */
    float spatial_cplx_masking;
    
    /**
850 851 852
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
853 854
     */
    float p_masking;
855

856
    /**
857 858 859
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
860 861
     */
    float dark_masking;
862
    
863 864 865 866
    
    /* for binary compatibility */
    int unused;
    
867
    /**
868 869 870
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
871 872 873 874 875 876 877 878 879 880
     */
    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
881
#define FF_IDCT_ALTIVEC      8
882
#define FF_IDCT_SH4          9
883
#define FF_IDCT_SIMPLEARM    10
884

885
    /**
886 887 888
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
889 890 891
     */
    int slice_count;
    /**
892 893 894
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
895 896 897
     */
    int *slice_offset;

898
    /**
899 900 901
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
902 903 904 905 906
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
907
    /**
Z
Zdenek Kabelac 已提交
908
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
909
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
     *
     * 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 */
M
huffyuv  
Michael Niedermayer 已提交
925 926

    /**
927 928 929
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
930 931 932 933
     */
     int bits_per_sample;
    
    /**
934 935 936
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
937 938 939 940 941
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
942 943
    
    /**
944 945 946
     * aspect ratio (0 if unknown).
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
947 948
     */
    float aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
949 950

    /**
951 952 953
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
954
     */
M
Michael Niedermayer 已提交
955
    AVFrame *coded_frame;
956 957

    /**
958 959 960
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
961 962 963 964 965 966 967 968
     */
    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
M
Michael Niedermayer 已提交
969 970 971 972
#define FF_DEBUG_VIS_MV    0x00000040
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
973
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
974
#define FF_DEBUG_MMCO      0x00000800
975 976
    
    /**
977 978 979
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
980 981
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
982 983
    
    /**
984 985 986
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
987 988 989 990
     */
    int mb_qmin;

    /**
991 992 993
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
994 995
     */
    int mb_qmax;
M
Michael Niedermayer 已提交
996 997
    
    /**
998 999 1000
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1001 1002 1003
     */
    int me_cmp;
    /**
1004 1005 1006
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1007 1008 1009
     */
    int me_sub_cmp;
    /**
1010 1011 1012
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
     */
    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
    
    /**
1026 1027 1028
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1029 1030
     */
    int dia_size;
1031 1032

    /**
1033 1034 1035
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1036 1037
     */
    int last_predictor_count;
1038

M
Michael Niedermayer 已提交
1039
    /**
1040 1041 1042
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1043 1044
     */
    int pre_me;
1045

1046
    /**
1047 1048 1049
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1050 1051
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1052

1053
    /**
1054 1055 1056
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1057 1058 1059
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1060
    /**
1061 1062 1063
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1064 1065 1066
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1067
    /**
1068
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1069 1070 1071 1072
     * @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
1073 1074
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1075 1076
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1077 1078 1079 1080 1081 1082

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1083 1084
     * - encoding: unused.
     * - decoding: set by decoder 
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
     */
    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

1095 1096 1097 1098
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1099 1100
     * - encoding: set by user.
     * - decoding: unused.
1101
     */
Z
Zdenek Kabelac 已提交
1102
    int me_range;
1103

M
Michael Niedermayer 已提交
1104 1105 1106 1107 1108 1109 1110 1111
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
    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;
1127 1128 1129 1130 1131 1132 1133 1134

    /**
     * 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;
1135
    
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146
    /**
     * 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;
M
Michael Niedermayer 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155
    
#define FF_QUALITY_SCALE 256
    /**
     * 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;
M
Michael Niedermayer 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
    
#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;
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
    
    /**
     * 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)

I
Ivan Kalvachev 已提交
1183 1184 1185 1186 1187 1188
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    
    /**
     * 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
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212

    /**
     * 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;
1213
    
F
Fabrice Bellard 已提交
1214 1215
} AVCodecContext;

1216

1217 1218 1219
/**
 * AVOption.
 */
1220 1221 1222
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
Z
Zdenek Kabelac 已提交
1223 1224
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1225 1226 1227 1228
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1229 1230 1231 1232 1233
#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
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
//#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;

Z
Zdenek Kabelac 已提交
1252 1253 1254 1255 1256 1257 1258 1259 1260
/**
 * 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);


1261 1262 1263
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1264
typedef struct AVCodec {
1265
    const char *name;
Z
Zdenek Kabelac 已提交
1266
    enum CodecType type;
F
Fabrice Bellard 已提交
1267 1268 1269
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1270
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1271
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1272
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1273
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1274
    int capabilities;
1275
    const AVOption *options;
F
Fabrice Bellard 已提交
1276
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1277
    void (*flush)(AVCodecContext *);
F
Fabrice Bellard 已提交
1278 1279
} AVCodec;

1280
/**
1281 1282 1283
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1284
typedef struct AVPicture {
1285
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1286
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1287 1288 1289 1290
} AVPicture;

extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1291
extern AVCodec mp3lame_encoder;
1292
extern AVCodec oggvorbis_encoder;
F
Fabrice Bellard 已提交
1293
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1294
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
1295 1296
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1297
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1298 1299
extern AVCodec rv10_encoder;
extern AVCodec mjpeg_encoder;
1300
extern AVCodec ljpeg_encoder;
F
Fabrice Bellard 已提交
1301
extern AVCodec mpeg4_encoder;
1302 1303 1304
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1305 1306
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1307
extern AVCodec huffyuv_encoder;
M
Michael Niedermayer 已提交
1308
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1309
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1310
extern AVCodec asv2_encoder;
M
Michael Niedermayer 已提交
1311
extern AVCodec vcr1_encoder;
1312
extern AVCodec ffv1_encoder;
1313
extern AVCodec mdec_encoder;
F
Fabrice Bellard 已提交
1314 1315

extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
1316
extern AVCodec mpeg4_decoder;
1317 1318 1319
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1320
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1321
extern AVCodec wmv2_decoder;
M
Michael Niedermayer 已提交
1322 1323
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
I
Ivan Kalvachev 已提交
1324
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1325
extern AVCodec h263i_decoder;
1326
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1327
extern AVCodec rv10_decoder;
N
Nick Kurshev 已提交
1328
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1329
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1330 1331
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
F
Fabrice Bellard 已提交
1332 1333
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1334
extern AVCodec mjpeg_decoder;
1335
extern AVCodec mjpegb_decoder;
1336
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1337
extern AVCodec mp3_decoder;
1338 1339
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1340
extern AVCodec huffyuv_decoder;
M
Mark Hills 已提交
1341
extern AVCodec oggvorbis_decoder;
1342
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1343
extern AVCodec h264_decoder;
1344
extern AVCodec indeo3_decoder;
1345
extern AVCodec vp3_decoder;
1346
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1347
extern AVCodec amr_nb_encoder;
1348 1349
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1350
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1351
extern AVCodec asv2_decoder;
M
Michael Niedermayer 已提交
1352
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1353
extern AVCodec cljr_decoder;
1354
extern AVCodec ffv1_decoder;
M
Michael Niedermayer 已提交
1355
extern AVCodec fourxm_decoder;
1356
extern AVCodec mdec_decoder;
1357 1358
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1359 1360
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1361 1362
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
F
Fabrice Bellard 已提交
1363

F
Fabrice Bellard 已提交
1364 1365 1366
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1367
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1368 1369 1370 1371 1372 1373 1374 1375 1376 1377

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

1378 1379 1380 1381 1382
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
M
Michael Niedermayer 已提交
1383
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1384

F
Fabrice Bellard 已提交
1385 1386 1387
#undef PCM_CODEC

/* dummy raw video codec */
1388 1389
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412

/* 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);
1413 1414 1415 1416 1417 1418

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

F
Fabrice Bellard 已提交
1419 1420 1421 1422 1423
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

1424
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1425
                   int pix_fmt, int width, int height);
1426 1427
int avpicture_layout(AVPicture* src, int pix_fmt, int width, int height,
                     unsigned char *dest, int dest_size);
1428
int avpicture_get_size(int pix_fmt, int width, int height);
1429 1430
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);
1431
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1432

1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
#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);

F
Fabrice Bellard 已提交
1445 1446 1447 1448
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
int img_get_alpha_info(AVPicture *src, int pix_fmt, int width, int height);

1449 1450 1451 1452 1453 1454 1455
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
                AVPicture *src, int pix_fmt, 
                int width, int height);

/* deinterlace a picture */
int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
F
Fabrice Bellard 已提交
1456 1457 1458 1459 1460 1461
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1462
/* returns LIBAVCODEC_VERSION_INT constant */
1463
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1464
/* returns LIBAVCODEC_BUILD constant */
1465
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1466 1467 1468 1469
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1470
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
1471 1472 1473 1474
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);

M
cleanup  
Michael Niedermayer 已提交
1475
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
1476
AVCodecContext *avcodec_alloc_context(void);
M
Michael Niedermayer 已提交
1477
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
1478

M
Michael Niedermayer 已提交
1479 1480
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1481
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1482

M
Michael Niedermayer 已提交
1483 1484 1485 1486
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1487
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1488

1489
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
1490
                         int *frame_size_ptr,
1491
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
1492
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
1493
                         int *got_picture_ptr,
1494 1495
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1496
                        int *data_size_ptr,
1497 1498
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
1499
                         const short *samples);
1500
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
1501
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
1502 1503 1504 1505

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
F
Fabrice Bellard 已提交
1506

M
Michael Niedermayer 已提交
1507 1508
void avcodec_flush_buffers(AVCodecContext *avctx);

1509
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1510 1511 1512 1513 1514 1515

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

1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528
/**
 * 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);
1529 1530


1531 1532 1533 1534 1535 1536 1537
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1538
    /// compressed size used from given memory buffer
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606
    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);

F
Fabrice Bellard 已提交
1607
/* memory */
1608
void *av_malloc(unsigned int size);
1609
void *av_mallocz(unsigned int size);
1610
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
1611
void av_free(void *ptr);
1612
char *av_strdup(const char *s);
F
Fabrice Bellard 已提交
1613 1614
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1615
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1616 1617
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
1618
void av_free_static(void);
1619 1620
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
F
Fabrice Bellard 已提交
1621

1622 1623 1624 1625
#ifdef __cplusplus
}
#endif

F
Fabrice Bellard 已提交
1626
#endif /* AVCODEC_H */