avcodec.h 45.6 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"

16 17
#define LIBAVCODEC_VERSION_INT 0x000406
#define LIBAVCODEC_VERSION     "0.4.6"
M
Michael Niedermayer 已提交
18 19
#define LIBAVCODEC_BUILD       4676
#define LIBAVCODEC_BUILD_STR   "4676"
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,
63
    CODEC_ID_FFV1,
64
    CODEC_ID_4XM,
M
Michael Niedermayer 已提交
65
    CODEC_ID_VCR1,
A
Alex Beregszaszi 已提交
66
    CODEC_ID_CLJR,
67
    CODEC_ID_MDEC,
F
Fabrice Bellard 已提交
68 69 70 71 72 73 74 75 76 77

    /* 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,
78 79 80 81 82

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
    CODEC_ID_ADPCM_MS,
83
    CODEC_ID_ADPCM_4XM,
84 85 86

	/* AMR */
    CODEC_ID_AMR_NB,
87 88 89
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
F
Fabrice Bellard 已提交
90 91 92
};

enum CodecType {
93
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
94 95 96 97
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
};

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

F
Fabrice Bellard 已提交
125 126
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
127
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
F
Fabrice Bellard 已提交
128 129
};

F
Fabrice Bellard 已提交
130
/* in bytes */
F
Fabrice Bellard 已提交
131
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
F
Fabrice Bellard 已提交
132

133
/**
134 135 136 137 138
 * 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
139 140 141
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

142 143
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
144
    ME_ZERO = 1,
145 146 147 148 149 150 151
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

M
Michael Niedermayer 已提交
152 153 154 155 156 157 158
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;

159 160 161
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

162
/* ME algos sorted by quality */
163 164
static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG, 
                                       ME_X1, ME_EPZS, ME_FULL };
F
Fabrice Bellard 已提交
165

166

M
Michael Niedermayer 已提交
167
#define FF_MAX_B_FRAMES 8
168

M
Michael Niedermayer 已提交
169 170 171 172
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
F
Fabrice Bellard 已提交
173

174 175 176 177 178
#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 
179 180
/* 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 */
181
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
182 183 184 185 186 187 188
#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 
189
                                            of only at frame boundaries */
190 191
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
192
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
193 194 195 196
#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) 
197
/* Fx : Flag for h263+ extra options */
198 199
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< Advanced intra coding 
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
200 201 202 203 204 205 206 207 208 209
/* 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 已提交
210 211
/* codec capabilities */

212
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
M
Michael Niedermayer 已提交
213 214 215 216 217
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
218 219 220
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
221
#define CODEC_CAP_TRUNCATED       0x0008
F
Fabrice Bellard 已提交
222

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

M
Michael Niedermayer 已提交
352 353
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
354 355

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
356 357
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewher else, dont dealloc
M
Michael Niedermayer 已提交
358

M
cleanup  
Michael Niedermayer 已提交
359

360 361 362 363
#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 已提交
364 365
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
366

M
Michael Niedermayer 已提交
367 368 369
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
370 371 372
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
373

374
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
375 376 377 378

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
379
typedef struct AVCodecContext {
380
    /**
381 382 383
     * 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 
384
     */
F
Fabrice Bellard 已提交
385
    int bit_rate;
386 387

    /**
388
     * number of bits the bitstream is allowed to diverge from the reference.
389
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
390 391
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
392 393 394 395
     */
    int bit_rate_tolerance; 

    /**
396 397 398
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
399
     */
F
Fabrice Bellard 已提交
400
    int flags;
401 402 403

    /**
     * some codecs needs additionnal format info. It is stored here
404 405
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
406 407 408 409
     */
    int sub_id;

    /**
410 411 412
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
413 414 415 416
     */
    int me_method;

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

    /**
452 453 454
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
455 456 457 458
     */
    int gop_size;

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

F
Fabrice Bellard 已提交
492
    /* audio only */
493
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
494
    int channels;
495
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
496 497

    /* the following data should not be initialized */
498 499 500
    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 已提交
501
    
502 503
    /**
     * number of frames the decoded output will be delayed relative to 
504 505 506
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
507 508
     */
    int delay;
M
Michael Niedermayer 已提交
509
    
510 511 512
    /* - 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) 
513 514
    
    /**
515 516 517
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
518 519 520 521
     */
    int qmin;

    /**
522 523 524
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
525 526 527 528
     */
    int qmax;

    /**
529 530 531
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
532 533 534 535
     */
    int max_qdiff;

    /**
536
     * maximum number of b frames between non b frames.
537
     * note: the output will be delayed by max_b_frames+1 relative to the input
538 539
     * - encoding: set by user.
     * - decoding: unused
540 541 542 543
     */
    int max_b_frames;

    /**
544 545 546
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
547 548 549 550 551
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
552
    int b_frame_strategy;
553

554
    /**
555 556 557
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
558 559
     */
    int hurry_up;
560
    
F
Fabrice Bellard 已提交
561
    struct AVCodec *codec;
562
    
F
Fabrice Bellard 已提交
563 564
    void *priv_data;

565
    /* The following data is for RTP friendly coding */
566
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
567 568 569 570 571 572 573 574 575 576
    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    */
577 578 579 580 581 582 583 584

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

585 586 587 588 589 590 591 592
    /* 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;
593 594 595
    int misc_bits;
    
    /**
596 597
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
598
     * - decoding: unused
599
     */
600
    int frame_bits;
601

602
    /**
603 604 605
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
606 607 608
     */
    void *opaque;

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

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

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

    /**
784 785 786
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
787 788 789 790
     */
    float i_quant_factor;
    
    /**
791
     * qscale offset between p and i frames.
792 793
     * 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)
794 795
     * - encoding: set by user.
     * - decoding: unused
796 797 798 799
     */
    float i_quant_offset;
    
    /**
800 801 802
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
803
     */
M
Michael Niedermayer 已提交
804
    float rc_initial_cplx;
805

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

847
    /**
848 849 850
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
851 852
     */
    float dark_masking;
853
    
854 855 856 857
    
    /* for binary compatibility */
    int unused;
    
858
    /**
859 860 861
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
862 863 864 865 866 867 868 869 870 871
     */
    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
872
#define FF_IDCT_ALTIVEC      8
873
#define FF_IDCT_SH4          9
874
#define FF_IDCT_SIMPLEARM    10
875

876
    /**
877 878 879
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
880 881 882
     */
    int slice_count;
    /**
883 884 885
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
886 887 888
     */
    int *slice_offset;

889
    /**
890 891 892
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
893 894 895 896 897
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
898
    /**
Z
Zdenek Kabelac 已提交
899
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
900
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
     *
     * 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 已提交
916 917

    /**
918 919 920
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
921 922 923 924
     */
     int bits_per_sample;
    
    /**
925 926 927
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
928 929 930 931 932
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
933 934
    
    /**
935 936 937
     * aspect ratio (0 if unknown).
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
938 939
     */
    float aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
940 941

    /**
942 943 944
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
945
     */
M
Michael Niedermayer 已提交
946
    AVFrame *coded_frame;
947 948

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

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

    /**
1024 1025 1026
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1027 1028
     */
    int last_predictor_count;
1029

M
Michael Niedermayer 已提交
1030
    /**
1031 1032 1033
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1034 1035
     */
    int pre_me;
1036

1037
    /**
1038 1039 1040
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1041 1042
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1043

1044
    /**
1045 1046 1047
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1048 1049 1050
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1051
    /**
1052 1053 1054
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1055 1056 1057
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1058
    /**
1059
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1060 1061 1062 1063
     * @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
1064 1065
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1066 1067
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1068 1069 1070 1071 1072 1073

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1074 1075
     * - encoding: unused.
     * - decoding: set by decoder 
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
     */
    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

1086 1087 1088 1089
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1090 1091
     * - encoding: set by user.
     * - decoding: unused.
1092
     */
Z
Zdenek Kabelac 已提交
1093
    int me_range;
1094

M
Michael Niedermayer 已提交
1095 1096 1097 1098 1099 1100 1101 1102
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
    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;
1118 1119 1120 1121 1122 1123 1124 1125

    /**
     * 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;
1126
    
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
    /**
     * 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 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146
    
#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 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    
#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;
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
    
    /**
     * 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 已提交
1174 1175 1176 1177 1178 1179
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
    
    /**
     * 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
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203

    /**
     * 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;
1204
    
F
Fabrice Bellard 已提交
1205 1206
} AVCodecContext;

1207

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


1252 1253 1254
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1255
typedef struct AVCodec {
1256
    const char *name;
Z
Zdenek Kabelac 已提交
1257
    enum CodecType type;
F
Fabrice Bellard 已提交
1258 1259 1260
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1261
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1262
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1263
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1264
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1265
    int capabilities;
1266
    const AVOption *options;
F
Fabrice Bellard 已提交
1267
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1268
    void (*flush)(AVCodecContext *);
F
Fabrice Bellard 已提交
1269 1270
} AVCodec;

1271
/**
1272 1273 1274
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1275
typedef struct AVPicture {
1276
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1277
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1278 1279 1280 1281
} AVPicture;

extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1282
extern AVCodec mp3lame_encoder;
1283
extern AVCodec oggvorbis_encoder;
F
Fabrice Bellard 已提交
1284
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1285
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
1286 1287
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1288
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1289 1290
extern AVCodec rv10_encoder;
extern AVCodec mjpeg_encoder;
1291
extern AVCodec ljpeg_encoder;
F
Fabrice Bellard 已提交
1292
extern AVCodec mpeg4_encoder;
1293 1294 1295
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1296 1297
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1298
extern AVCodec huffyuv_encoder;
M
Michael Niedermayer 已提交
1299
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1300
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1301
extern AVCodec vcr1_encoder;
1302
extern AVCodec ffv1_encoder;
1303
extern AVCodec mdec_encoder;
F
Fabrice Bellard 已提交
1304 1305

extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
1306
extern AVCodec mpeg4_decoder;
1307 1308 1309
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1310
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1311
extern AVCodec wmv2_decoder;
F
Fabrice Bellard 已提交
1312
extern AVCodec mpeg_decoder;
I
Ivan Kalvachev 已提交
1313
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1314
extern AVCodec h263i_decoder;
1315
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1316
extern AVCodec rv10_decoder;
N
Nick Kurshev 已提交
1317
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1318
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1319 1320
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
F
Fabrice Bellard 已提交
1321 1322
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1323
extern AVCodec mjpeg_decoder;
1324
extern AVCodec mjpegb_decoder;
1325
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1326
extern AVCodec mp3_decoder;
1327 1328
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1329
extern AVCodec huffyuv_decoder;
M
Mark Hills 已提交
1330
extern AVCodec oggvorbis_decoder;
1331
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1332
extern AVCodec h264_decoder;
1333
extern AVCodec indeo3_decoder;
1334
extern AVCodec vp3_decoder;
1335
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1336
extern AVCodec amr_nb_encoder;
1337 1338
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1339
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1340
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1341
extern AVCodec cljr_decoder;
1342
extern AVCodec ffv1_decoder;
M
Michael Niedermayer 已提交
1343
extern AVCodec fourxm_decoder;
1344
extern AVCodec mdec_decoder;
1345 1346
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
F
Fabrice Bellard 已提交
1347

F
Fabrice Bellard 已提交
1348 1349 1350
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1351
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361

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

1362 1363 1364 1365 1366
/* 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 已提交
1367
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1368

F
Fabrice Bellard 已提交
1369 1370 1371
#undef PCM_CODEC

/* dummy raw video codec */
1372 1373
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396

/* 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);
1397 1398 1399 1400 1401 1402

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

F
Fabrice Bellard 已提交
1403 1404 1405 1406 1407
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

1408
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1409
                   int pix_fmt, int width, int height);
1410 1411
int avpicture_layout(AVPicture* src, int pix_fmt, int width, int height,
                     unsigned char *dest, int dest_size);
1412
int avpicture_get_size(int pix_fmt, int width, int height);
1413 1414
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);
1415
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1416

1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
#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 已提交
1429 1430 1431 1432
#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);

1433 1434 1435 1436 1437 1438 1439
/* 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 已提交
1440 1441 1442 1443 1444 1445
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1446
/* returns LIBAVCODEC_VERSION_INT constant */
1447
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1448
/* returns LIBAVCODEC_BUILD constant */
1449
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1450 1451 1452 1453
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1454
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
1455 1456 1457 1458
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 已提交
1459
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
1460
AVCodecContext *avcodec_alloc_context(void);
M
Michael Niedermayer 已提交
1461
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
1462

M
Michael Niedermayer 已提交
1463 1464
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1465
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1466

M
Michael Niedermayer 已提交
1467 1468 1469 1470
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1471
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1472

1473
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
1474
                         int *frame_size_ptr,
1475
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
1476
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
1477
                         int *got_picture_ptr,
1478 1479
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1480
                        int *data_size_ptr,
1481 1482
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
1483
                         const short *samples);
1484
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
1485
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
1486 1487 1488 1489

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
1491 1492
void avcodec_flush_buffers(AVCodecContext *avctx);

1493
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1494 1495 1496 1497 1498 1499

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

1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
/**
 * 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);
1513 1514


1515 1516 1517 1518 1519 1520 1521
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1522
    /// compressed size used from given memory buffer
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 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
    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 已提交
1591
/* memory */
1592
void *av_malloc(unsigned int size);
1593
void *av_mallocz(unsigned int size);
1594
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
1595
void av_free(void *ptr);
1596
char *av_strdup(const char *s);
F
Fabrice Bellard 已提交
1597 1598
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1599
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1600 1601
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
1602
void av_free_static(void);
1603 1604
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
F
Fabrice Bellard 已提交
1605

1606 1607 1608 1609
#ifdef __cplusplus
}
#endif

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