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

F
Fabrice Bellard 已提交
16 17
#define FFMPEG_VERSION_INT     0x000408
#define FFMPEG_VERSION         "0.4.8"
18
#define LIBAVCODEC_BUILD       4679
19

F
Fabrice Bellard 已提交
20 21 22 23 24 25
#define LIBAVCODEC_VERSION_INT FFMPEG_VERSION_INT
#define LIBAVCODEC_VERSION     FFMPEG_VERSION

#define AV_STRINGIFY(s)	AV_TOSTRING(s)
#define AV_TOSTRING(s) #s
#define LIBAVCODEC_IDENT	"FFmpeg" LIBAVCODEC_VERSION "b" AV_STRINGIFY(LIBAVCODEC_BUILD)
A
Alex Beregszaszi 已提交
26

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

    /* 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,
87 88 89 90

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
91 92
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
93
    CODEC_ID_ADPCM_MS,
94
    CODEC_ID_ADPCM_4XM,
95 96 97

	/* AMR */
    CODEC_ID_AMR_NB,
98 99 100
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
101 102 103 104

    /* various DPCM codecs */
    CODEC_ID_ROQ_DPCM,
    CODEC_ID_INTERPLAY_DPCM,
105
    CODEC_ID_XAN_DPCM,
F
Fabrice Bellard 已提交
106
};
107 108 109

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
F
Fabrice Bellard 已提交
110 111

enum CodecType {
112
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
113 114 115 116
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
};

117 118 119
/**
 * Pixel format.
 */
F
Fabrice Bellard 已提交
120
enum PixelFormat {
M
Michael Niedermayer 已提交
121 122 123 124 125 126
    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)
127
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA...
M
Michael Niedermayer 已提交
128 129
    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)
130 131
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
132
    PIX_FMT_GRAY8,
133 134 135
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
M
Michael Niedermayer 已提交
136 137 138
    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 已提交
139 140
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
141
    PIX_FMT_NB,
F
Fabrice Bellard 已提交
142 143
};

F
Fabrice Bellard 已提交
144 145
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
146
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
F
Fabrice Bellard 已提交
147 148
};

F
Fabrice Bellard 已提交
149
/* in bytes */
F
Fabrice Bellard 已提交
150
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
F
Fabrice Bellard 已提交
151

152
/**
153 154 155 156 157
 * 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
158 159 160
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

161 162
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
163
    ME_ZERO = 1,
164 165 166 167 168 169 170
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

M
Michael Niedermayer 已提交
171 172 173 174 175 176 177
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;

178 179 180
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

181
/* ME algos sorted by quality */
182 183
static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG, 
                                       ME_X1, ME_EPZS, ME_FULL };
F
Fabrice Bellard 已提交
184

185

M
Michael Niedermayer 已提交
186
#define FF_MAX_B_FRAMES 8
187

M
Michael Niedermayer 已提交
188 189 190 191
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
F
Fabrice Bellard 已提交
192

193 194 195 196 197
#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 
198 199
/* 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 */
200
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
201 202 203 204 205 206 207
#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 
208
                                            of only at frame boundaries */
209 210
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
211
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
212 213 214 215
#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) 
216
/* Fx : Flag for h263+ extra options */
217 218
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< Advanced intra coding 
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
219 220 221 222 223 224 225 226 227 228
/* 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 已提交
229 230
/* codec capabilities */

231
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
M
Michael Niedermayer 已提交
232 233 234 235 236
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
237 238 239
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
240
#define CODEC_CAP_TRUNCATED       0x0008
F
Fabrice Bellard 已提交
241

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

M
Michael Niedermayer 已提交
371 372
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
373 374

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
375 376 377
#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 已提交
378

M
cleanup  
Michael Niedermayer 已提交
379

380 381 382 383
#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 已提交
384 385
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
386

M
Michael Niedermayer 已提交
387 388 389
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
390 391 392
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
393

394
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
395 396 397 398

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
399
typedef struct AVCodecContext {
400
    /**
401 402 403
     * 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 
404
     */
F
Fabrice Bellard 已提交
405
    int bit_rate;
406 407

    /**
408
     * number of bits the bitstream is allowed to diverge from the reference.
409
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
410 411
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
412 413 414 415
     */
    int bit_rate_tolerance; 

    /**
416 417 418
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
419
     */
F
Fabrice Bellard 已提交
420
    int flags;
421 422 423

    /**
     * some codecs needs additionnal format info. It is stored here
424 425
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
426 427 428 429
     */
    int sub_id;

    /**
430 431 432
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
433 434 435 436
     */
    int me_method;

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

    /**
472 473 474
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
475 476 477 478
     */
    int gop_size;

    /**
479
     * pixel format, see PIX_FMT_xxx.
480 481 482 483
     * - 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.
484
     * - decoding: set by lavc.
485
     */
486
    enum PixelFormat pix_fmt;
487 488 489 490 491 492 493 494 495
 
    /**
     * 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;
       
496 497 498 499 500
    /**
     * 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
501 502
     * - encoding: unused
     * - decoding: set by user.
503 504 505 506
     * @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
507
     */
F
Fabrice Bellard 已提交
508
    void (*draw_horiz_band)(struct AVCodecContext *s,
M
Michael Niedermayer 已提交
509
                            AVFrame *src, int offset[4],
510
                            int y, int type, int height);
F
Fabrice Bellard 已提交
511

F
Fabrice Bellard 已提交
512
    /* audio only */
513
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
514
    int channels;
515
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
516 517

    /* the following data should not be initialized */
518 519 520
    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 已提交
521
    
522 523
    /**
     * number of frames the decoded output will be delayed relative to 
524 525 526
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
527 528
     */
    int delay;
M
Michael Niedermayer 已提交
529
    
530 531 532
    /* - 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) 
533 534
    
    /**
535 536 537
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
538 539 540 541
     */
    int qmin;

    /**
542 543 544
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
545 546 547 548
     */
    int qmax;

    /**
549 550 551
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
552 553 554 555
     */
    int max_qdiff;

    /**
556
     * maximum number of b frames between non b frames.
557
     * note: the output will be delayed by max_b_frames+1 relative to the input
558 559
     * - encoding: set by user.
     * - decoding: unused
560 561 562 563
     */
    int max_b_frames;

    /**
564 565 566
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
567 568 569 570 571
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
572
    int b_frame_strategy;
573

574
    /**
575 576 577
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
578 579
     */
    int hurry_up;
580
    
F
Fabrice Bellard 已提交
581
    struct AVCodec *codec;
582
    
F
Fabrice Bellard 已提交
583 584
    void *priv_data;

585
    /* The following data is for RTP friendly coding */
586
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
587 588 589 590 591 592 593 594 595 596
    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    */
597 598 599 600 601 602 603 604

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

605 606 607 608 609 610 611 612
    /* 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;
613 614 615
    int misc_bits;
    
    /**
616 617
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
618
     * - decoding: unused
619
     */
620
    int frame_bits;
621

622
    /**
623 624 625
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
626 627 628
     */
    void *opaque;

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

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

M
Michael Niedermayer 已提交
763 764
    float rc_qmod_amp;
    int rc_qmod_freq;
765 766
    
    /**
767 768 769
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
770
     */
M
Michael Niedermayer 已提交
771 772
    RcOverride *rc_override;
    int rc_override_count;
773 774
    
    /**
775 776 777
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
778
     */
M
Michael Niedermayer 已提交
779
    char *rc_eq;
780 781
    
    /**
782 783 784
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
785
     */
M
Michael Niedermayer 已提交
786
    int rc_max_rate;
787 788
    
    /**
789 790 791
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
792
     */
M
Michael Niedermayer 已提交
793
    int rc_min_rate;
794 795
    
    /**
796 797 798
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
799
     */
M
Michael Niedermayer 已提交
800 801
    int rc_buffer_size;
    float rc_buffer_aggressivity;
802 803

    /**
804 805 806
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
807 808 809 810
     */
    float i_quant_factor;
    
    /**
811
     * qscale offset between p and i frames.
812 813
     * 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)
814 815
     * - encoding: set by user.
     * - decoding: unused
816 817 818 819
     */
    float i_quant_offset;
    
    /**
820 821 822
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
823
     */
M
Michael Niedermayer 已提交
824
    float rc_initial_cplx;
825

826
    /**
827 828 829
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
830
     */
831
    int dct_algo;
832
#define FF_DCT_AUTO    0
833
#define FF_DCT_FASTINT 1
834 835 836
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
837
#define FF_DCT_ALTIVEC 5
838 839
    
    /**
840 841 842
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
843 844 845 846
     */
    float lumi_masking;
    
    /**
847 848 849
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
850 851 852 853
     */
    float temporal_cplx_masking;
    
    /**
854 855 856
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
857 858 859 860
     */
    float spatial_cplx_masking;
    
    /**
861 862 863
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
864 865
     */
    float p_masking;
866

867
    /**
868 869 870
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
871 872
     */
    float dark_masking;
873
    
874 875 876 877
    
    /* for binary compatibility */
    int unused;
    
878
    /**
879 880 881
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
882 883 884 885 886 887 888 889 890 891
     */
    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
892
#define FF_IDCT_ALTIVEC      8
893
#define FF_IDCT_SH4          9
894
#define FF_IDCT_SIMPLEARM    10
895

896
    /**
897 898 899
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
900 901 902
     */
    int slice_count;
    /**
903 904 905
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
906 907 908
     */
    int *slice_offset;

909
    /**
910 911 912
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
913 914 915 916 917
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
918
    /**
Z
Zdenek Kabelac 已提交
919
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
920
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
     *
     * 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 已提交
936 937

    /**
938 939 940
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
941 942 943 944
     */
     int bits_per_sample;
    
    /**
945 946 947
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
948 949 950 951 952
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
953 954
    
    /**
955 956 957
     * aspect ratio (0 if unknown).
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
958 959
     */
    float aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
960 961

    /**
962 963 964
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
965
     */
M
Michael Niedermayer 已提交
966
    AVFrame *coded_frame;
967 968

    /**
969 970 971
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
972 973 974 975 976 977 978 979
     */
    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 已提交
980 981 982 983
#define FF_DEBUG_VIS_MV    0x00000040
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
984
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
985
#define FF_DEBUG_MMCO      0x00000800
986
#define FF_DEBUG_BUGS      0x00001000
987 988
    
    /**
989 990 991
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
992 993
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
994 995
    
    /**
996 997 998
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
999 1000 1001 1002
     */
    int mb_qmin;

    /**
1003 1004 1005
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1006 1007
     */
    int mb_qmax;
M
Michael Niedermayer 已提交
1008 1009
    
    /**
1010 1011 1012
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1013 1014 1015
     */
    int me_cmp;
    /**
1016 1017 1018
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1019 1020 1021
     */
    int me_sub_cmp;
    /**
1022 1023 1024
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
     */
    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
    
    /**
1038 1039 1040
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1041 1042
     */
    int dia_size;
1043 1044

    /**
1045 1046 1047
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1048 1049
     */
    int last_predictor_count;
1050

M
Michael Niedermayer 已提交
1051
    /**
1052 1053 1054
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1055 1056
     */
    int pre_me;
1057

1058
    /**
1059 1060 1061
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1062 1063
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1064

1065
    /**
1066 1067 1068
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1069 1070 1071
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1072
    /**
1073 1074 1075
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1076 1077 1078
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1079
    /**
1080
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1081 1082 1083 1084
     * @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
1085 1086
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1087 1088
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1089 1090 1091 1092 1093 1094

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1095 1096
     * - encoding: unused.
     * - decoding: set by decoder 
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
     */
    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

1107 1108 1109 1110
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1111 1112
     * - encoding: set by user.
     * - decoding: unused.
1113
     */
Z
Zdenek Kabelac 已提交
1114
    int me_range;
1115

M
Michael Niedermayer 已提交
1116 1117 1118 1119 1120 1121 1122 1123
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
    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;
1139 1140 1141 1142 1143 1144 1145 1146

    /**
     * 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;
1147
    
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
    /**
     * 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 已提交
1159 1160 1161 1162 1163 1164 1165 1166 1167
    
#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 已提交
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
    
#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;
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
    
    /**
     * 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 已提交
1195 1196 1197 1198 1199 1200
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
    
    /**
     * 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
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224

    /**
     * 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;
1225
    
1226 1227 1228 1229 1230 1231 1232
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
     * - encoding: unused
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int stream_codec_tag;
F
Fabrice Bellard 已提交
1233 1234
} AVCodecContext;

1235

1236 1237 1238
/**
 * AVOption.
 */
1239 1240 1241
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
Z
Zdenek Kabelac 已提交
1242 1243
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1244 1245 1246 1247
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1248 1249 1250 1251 1252
#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
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
//#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 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279
/**
 * 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);


1280 1281 1282
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1283
typedef struct AVCodec {
1284
    const char *name;
Z
Zdenek Kabelac 已提交
1285
    enum CodecType type;
F
Fabrice Bellard 已提交
1286 1287 1288
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1289
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1290
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1291
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1292
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1293
    int capabilities;
1294
    const AVOption *options;
F
Fabrice Bellard 已提交
1295
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1296
    void (*flush)(AVCodecContext *);
F
Fabrice Bellard 已提交
1297 1298
} AVCodec;

1299
/**
1300 1301 1302
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1303
typedef struct AVPicture {
1304
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1305
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1306 1307
} AVPicture;

M
Mike Melanson 已提交
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
typedef struct AVPaletteControl {

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

    /* 256 3-byte RGB palette entries; the components should be
     * formatted in the buffer as "RGBRGB..." and should be scaled to
     * 8 bits if they originally represented 6-bit VGA palette
     * components */
    unsigned char palette[256 * 3];

} AVPaletteControl;

F
Fabrice Bellard 已提交
1327 1328
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1329
extern AVCodec mp3lame_encoder;
1330
extern AVCodec oggvorbis_encoder;
F
Fabrice Bellard 已提交
1331
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1332
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
1333 1334
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1335
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1336 1337
extern AVCodec rv10_encoder;
extern AVCodec mjpeg_encoder;
1338
extern AVCodec ljpeg_encoder;
F
Fabrice Bellard 已提交
1339
extern AVCodec mpeg4_encoder;
1340 1341 1342
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1343 1344
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1345
extern AVCodec huffyuv_encoder;
M
Michael Niedermayer 已提交
1346
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1347
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1348
extern AVCodec asv2_encoder;
M
Michael Niedermayer 已提交
1349
extern AVCodec vcr1_encoder;
1350
extern AVCodec ffv1_encoder;
1351
extern AVCodec mdec_encoder;
F
Fabrice Bellard 已提交
1352 1353

extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
1354
extern AVCodec mpeg4_decoder;
1355 1356 1357
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1358
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1359
extern AVCodec wmv2_decoder;
M
Michael Niedermayer 已提交
1360 1361
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
I
Ivan Kalvachev 已提交
1362
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1363
extern AVCodec h263i_decoder;
1364
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1365
extern AVCodec rv10_decoder;
N
Nick Kurshev 已提交
1366
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1367
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1368 1369
extern AVCodec dvvideo_decoder;
extern AVCodec dvaudio_decoder;
F
Fabrice Bellard 已提交
1370 1371
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1372
extern AVCodec mjpeg_decoder;
1373
extern AVCodec mjpegb_decoder;
1374
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1375
extern AVCodec mp3_decoder;
1376 1377
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1378
extern AVCodec huffyuv_decoder;
M
Mark Hills 已提交
1379
extern AVCodec oggvorbis_decoder;
1380
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1381
extern AVCodec h264_decoder;
1382
extern AVCodec indeo3_decoder;
1383
extern AVCodec vp3_decoder;
1384
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1385
extern AVCodec amr_nb_encoder;
1386 1387
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1388
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1389
extern AVCodec asv2_decoder;
M
Michael Niedermayer 已提交
1390
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1391
extern AVCodec cljr_decoder;
1392
extern AVCodec ffv1_decoder;
M
Michael Niedermayer 已提交
1393
extern AVCodec fourxm_decoder;
1394
extern AVCodec mdec_decoder;
1395 1396
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1397
extern AVCodec xan_wc3_decoder;
1398 1399
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1400 1401
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1402
extern AVCodec xan_dpcm_decoder;
F
Fabrice Bellard 已提交
1403

F
Fabrice Bellard 已提交
1404 1405 1406
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1407
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1408 1409 1410 1411 1412 1413 1414 1415 1416 1417

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

1418 1419 1420 1421
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1422 1423
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1424
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
M
Michael Niedermayer 已提交
1425
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1426

F
Fabrice Bellard 已提交
1427 1428 1429
#undef PCM_CODEC

/* dummy raw video codec */
1430 1431
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454

/* 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);
1455 1456 1457 1458 1459 1460

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

F
Fabrice Bellard 已提交
1461 1462 1463 1464 1465
void img_resample(ImgReSampleContext *s, 
                  AVPicture *output, AVPicture *input);

void img_resample_close(ImgReSampleContext *s);

1466
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1467
                   int pix_fmt, int width, int height);
1468 1469
int avpicture_layout(AVPicture* src, int pix_fmt, int width, int height,
                     unsigned char *dest, int dest_size);
1470
int avpicture_get_size(int pix_fmt, int width, int height);
1471 1472
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);
1473
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1474

1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
#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 已提交
1487 1488 1489 1490
#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);

1491 1492 1493 1494 1495 1496 1497
/* 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 已提交
1498 1499 1500 1501 1502 1503
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1504
/* returns LIBAVCODEC_VERSION_INT constant */
1505
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1506
/* returns LIBAVCODEC_BUILD constant */
1507
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1508 1509 1510 1511
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1512
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
1513 1514 1515 1516
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 已提交
1517
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
1518
AVCodecContext *avcodec_alloc_context(void);
M
Michael Niedermayer 已提交
1519
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
1520

M
Michael Niedermayer 已提交
1521 1522
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1523
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1524

M
Michael Niedermayer 已提交
1525 1526 1527 1528
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1529
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1530

1531
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
1532
                         int *frame_size_ptr,
1533
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
1534
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
1535
                         int *got_picture_ptr,
1536 1537
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1538
                        int *data_size_ptr,
1539 1540
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
1541
                         const short *samples);
1542
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
1543
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
1544 1545 1546 1547

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
1549 1550
void avcodec_flush_buffers(AVCodecContext *avctx);

1551
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1552 1553 1554 1555 1556 1557

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

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570
/**
 * 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);
1571 1572


1573 1574 1575 1576 1577 1578 1579
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1580
    /// compressed size used from given memory buffer
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 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
    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 已提交
1649
/* memory */
1650
void *av_malloc(unsigned int size);
1651
void *av_mallocz(unsigned int size);
1652
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
1653
void av_free(void *ptr);
1654
char *av_strdup(const char *s);
F
Fabrice Bellard 已提交
1655 1656
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1657
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1658 1659
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
1660
void av_free_static(void);
1661 1662
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
F
Fabrice Bellard 已提交
1663

1664 1665 1666 1667
#ifdef __cplusplus
}
#endif

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