avcodec.h 56.8 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
#include "common.h"
M
Michael Niedermayer 已提交
15
#include "rational.h"
Z
Zdenek Kabelac 已提交
16
#include <sys/types.h> /* size_t */
F
Fabrice Bellard 已提交
17

F
Fabrice Bellard 已提交
18 19
#define FFMPEG_VERSION_INT     0x000408
#define FFMPEG_VERSION         "0.4.8"
20
#define LIBAVCODEC_BUILD       4693
21

F
Fabrice Bellard 已提交
22 23 24 25 26 27
#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 已提交
28

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

    /* 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,
102 103 104 105

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
106 107
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
108
    CODEC_ID_ADPCM_IMA_WS,
109
    CODEC_ID_ADPCM_MS,
110
    CODEC_ID_ADPCM_4XM,
111 112
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
113 114 115

	/* AMR */
    CODEC_ID_AMR_NB,
116 117
    CODEC_ID_AMR_WB,

118 119 120
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
121 122 123 124

    /* various DPCM codecs */
    CODEC_ID_ROQ_DPCM,
    CODEC_ID_INTERPLAY_DPCM,
125
    CODEC_ID_XAN_DPCM,
126 127 128
    
    CODEC_ID_MPEG2TS, /* _FAKE_ codec to indicate a raw MPEG2 transport
                         stream (only used by libavformat) */
F
Fabrice Bellard 已提交
129
};
130 131 132

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
F
Fabrice Bellard 已提交
133 134

enum CodecType {
135
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
136 137
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
138
    CODEC_TYPE_DATA,
F
Fabrice Bellard 已提交
139 140
};

141
/**
M
Mike Melanson 已提交
142 143 144 145 146 147 148 149 150 151 152 153
 * Pixel format. Notes: 
 *
 * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
 * color is put together as:
 *  (A << 24) | (R << 16) | (G << 8) | B
 * This is stored as BGRA on little endian CPU architectures and ARGB on
 * big endian CPUs.
 *
 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
 * image data is stored in AVFrame.data[0]. The palette is transported in
 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
 * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
154 155 156 157
 * also endian-specific). Note also that the individual RGB palette
 * components stored in AVFrame.data[1] should be in the range 0..255.
 * This is important as many custom PAL8 video codecs that were designed
 * to run on the IBM VGA graphics adapter use 6-bit palette components.
158
 */
F
Fabrice Bellard 已提交
159
enum PixelFormat {
M
Michael Niedermayer 已提交
160 161 162 163 164 165
    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)
M
Mike Melanson 已提交
166
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
M
Michael Niedermayer 已提交
167 168
    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)
169 170
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
171
    PIX_FMT_GRAY8,
172 173 174
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
M
Michael Niedermayer 已提交
175 176 177
    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 已提交
178 179
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
180
    PIX_FMT_NB,
F
Fabrice Bellard 已提交
181 182
};

F
Fabrice Bellard 已提交
183 184
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
185
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
F
Fabrice Bellard 已提交
186 187
};

F
Fabrice Bellard 已提交
188
/* in bytes */
F
Fabrice Bellard 已提交
189
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
F
Fabrice Bellard 已提交
190

191
/**
192 193 194 195 196
 * 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
197 198 199
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

200 201
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
202
    ME_ZERO = 1,
203 204 205 206 207 208 209
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

M
Michael Niedermayer 已提交
210 211 212 213 214 215 216
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;

217 218 219
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

220
/* ME algos sorted by quality */
M
Michael Niedermayer 已提交
221
//FIXME remove IMHO
222 223
static const __attribute__((unused)) int Motion_Est_QTab[] =
 { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
F
Fabrice Bellard 已提交
224

225

M
Michael Niedermayer 已提交
226
#define FF_MAX_B_FRAMES 8
227

M
Michael Niedermayer 已提交
228 229 230 231
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
F
Fabrice Bellard 已提交
232

233
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
234
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
235 236
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
237
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
238
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
239 240
/* 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 */
241
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
242 243 244 245 246 247 248
#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 
249
                                            of only at frame boundaries */
250 251
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
252
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
253 254 255 256
#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) 
257
/* Fx : Flag for h263+ extra options */
M
Michael Niedermayer 已提交
258 259
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
260
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
261
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
262
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
263
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
M
Michael Niedermayer 已提交
264 265
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
266 267 268 269 270 271 272 273 274
/* 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
 * 		Modified Quantization */
/* /Fx */
F
Fabrice Bellard 已提交
275 276
/* codec capabilities */

277
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
M
Michael Niedermayer 已提交
278 279 280 281 282
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
283 284 285
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
286
#define CODEC_CAP_TRUNCATED       0x0008
F
Fabrice Bellard 已提交
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
/**
 * Pan Scan area.
 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
 */
typedef struct AVPanScan{
    /**
     * id.
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int id;

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

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

M
Michael Niedermayer 已提交
316
#define FF_COMMON_FRAME \
M
Michael Niedermayer 已提交
317 318 319 320 321 322
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
M
cleanup  
Michael Niedermayer 已提交
323 324 325
    uint8_t *data[4];\
    int linesize[4];\
    /**\
M
Michael Niedermayer 已提交
326
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
M
cleanup  
Michael Niedermayer 已提交
327
     * this isnt used by lavc unless the default get/release_buffer() is used\
328 329
     * - encoding: \
     * - decoding: \
M
cleanup  
Michael Niedermayer 已提交
330 331 332 333
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
334 335
     * - encoding: set by lavc\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
336 337 338 339
     */\
    int key_frame;\
\
    /**\
M
Michael Niedermayer 已提交
340
     * picture type of the frame, see ?_TYPE below.\
341 342
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
343 344 345 346 347 348
     */\
    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\
349 350
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
351
     */\
352
    int64_t pts;\
M
cleanup  
Michael Niedermayer 已提交
353 354 355
\
    /**\
     * picture number in bitstream order.\
356 357
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
358 359 360 361
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
362 363
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
364 365 366 367
     */\
    int display_picture_number;\
\
    /**\
368
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
369 370
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
371
     */\
372
    int quality; \
M
cleanup  
Michael Niedermayer 已提交
373 374 375
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
376
     * set to INT_MAX if the buffer has not been used yet \
377 378
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
M
cleanup  
Michael Niedermayer 已提交
379 380 381 382 383
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
384 385
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
M
cleanup  
Michael Niedermayer 已提交
386 387 388 389 390
     */\
    int reference;\
\
    /**\
     * QP table\
391 392
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
393 394 395 396
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
397 398
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
399 400 401 402 403 404
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
405 406
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
407 408 409 410 411
     */\
    uint8_t *mbskip_table;\
\
    /**\
     * for some private data of the user\
412 413
     * - encoding: unused\
     * - decoding: set by user\
M
cleanup  
Michael Niedermayer 已提交
414 415
     */\
    void *opaque;\
416 417 418
\
    /**\
     * error\
419 420
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
421 422
     */\
    uint64_t error[4];\
M
Michael Niedermayer 已提交
423 424 425
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
426 427
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
F
Falk Hüffner 已提交
428
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
M
Michael Niedermayer 已提交
429 430
     */\
    int type;\
431 432 433 434
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
435 436
     * - encoding: unused\
     * - decoding: set by lavc\
437
     */\
M
Michael Niedermayer 已提交
438 439 440 441 442 443
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
444 445 446 447 448 449 450 451 452
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
453
     * if the content is interlaced, is top field displayed first.\
454
     * - encoding: set by user\
455
     * - decoding: set by lavc\
456
     */\
457
    int top_field_first;\
458 459 460 461 462 463 464
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
465 466 467 468 469 470 471
    \
    /**\
     * tell user application that palette has changed from previous frame.\
     * - encoding: ??? (no palette-enabled encoder yet)\
     * - decoding: set by lavc (default 0)\
     */\
    int palette_has_changed;\
472 473 474 475 476 477 478
    \
    /**\
     * Codec suggestion on buffer type if != 0\
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
     */\
    int buffer_hints;\
479

M
Michael Niedermayer 已提交
480 481
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
482 483

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
484 485 486
#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 已提交
487

M
cleanup  
Michael Niedermayer 已提交
488

489 490 491 492
#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 已提交
493 494
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
495

496 497 498 499 500
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore)
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)

M
Michael Niedermayer 已提交
501 502 503
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
504 505 506
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
507

508
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
509 510 511 512

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
513
typedef struct AVCodecContext {
514
    /**
515 516 517
     * 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 
518
     */
F
Fabrice Bellard 已提交
519
    int bit_rate;
520 521

    /**
522
     * number of bits the bitstream is allowed to diverge from the reference.
523
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
524 525
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
526 527 528 529
     */
    int bit_rate_tolerance; 

    /**
530 531 532
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
533
     */
F
Fabrice Bellard 已提交
534
    int flags;
535 536 537

    /**
     * some codecs needs additionnal format info. It is stored here
538 539
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
540 541 542 543
     */
    int sub_id;

    /**
544 545 546
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
547 548 549 550
     */
    int me_method;

    /**
551
     * some codecs need / can use extra-data like huffman tables.
552 553
     * mjpeg: huffman tables
     * rv10: additional flags
554
     * mpeg4: global headers (they can be in the bitstream or here)
555 556
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
557
     */
558 559 560
    void *extradata;
    int extradata_size;
    
F
Fabrice Bellard 已提交
561
    /* video only */
562
    /**
563
     * frames per sec multiplied by frame_rate_base.
564
     * for variable fps this is the precission, so if the timestamps 
565
     * can be specified in msec precssion then this is 1000*frame_rate_base
566 567
     * - encoding: MUST be set by user
     * - decoding: set by lavc. 0 or the frame_rate if available
568 569
     */
    int frame_rate;
570
    
571
    /**
572 573
     * width / height.
     * - encoding: MUST be set by user. 
M
Michael Niedermayer 已提交
574
     * - decoding: set by user if known, codec should override / dynamically change if needed
575
     */
F
Fabrice Bellard 已提交
576
    int width, height;
577
    
M
Michael Niedermayer 已提交
578 579 580 581 582
#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
583
#define FF_ASPECT_EXTENDED 15
584 585

    /**
586 587 588
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
589 590 591 592
     */
    int gop_size;

    /**
593
     * pixel format, see PIX_FMT_xxx.
594 595 596 597
     * - 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.
598
     * - decoding: set by lavc.
599
     */
600
    enum PixelFormat pix_fmt;
601 602 603 604 605 606 607 608 609
 
    /**
     * 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;
       
610 611 612 613 614
    /**
     * 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
615 616
     * - encoding: unused
     * - decoding: set by user.
617 618 619 620
     * @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
621
     */
F
Fabrice Bellard 已提交
622
    void (*draw_horiz_band)(struct AVCodecContext *s,
623
                            const AVFrame *src, int offset[4],
624
                            int y, int type, int height);
F
Fabrice Bellard 已提交
625

F
Fabrice Bellard 已提交
626
    /* audio only */
627
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
628
    int channels;
629
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
630 631

    /* the following data should not be initialized */
632 633 634
    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 已提交
635
    
636 637
    /**
     * number of frames the decoded output will be delayed relative to 
638 639 640
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
641 642
     */
    int delay;
M
Michael Niedermayer 已提交
643
    
644 645 646
    /* - 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) 
647 648
    
    /**
649 650 651
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
652 653 654 655
     */
    int qmin;

    /**
656 657 658
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
659 660 661 662
     */
    int qmax;

    /**
663 664 665
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
666 667 668 669
     */
    int max_qdiff;

    /**
670
     * maximum number of b frames between non b frames.
671
     * note: the output will be delayed by max_b_frames+1 relative to the input
672 673
     * - encoding: set by user.
     * - decoding: unused
674 675 676 677
     */
    int max_b_frames;

    /**
678 679 680
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
681 682 683 684 685
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
686
    int b_frame_strategy;
687

688
    /**
689 690 691
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
692 693
     */
    int hurry_up;
694
    
F
Fabrice Bellard 已提交
695
    struct AVCodec *codec;
696
    
F
Fabrice Bellard 已提交
697 698
    void *priv_data;

699
    /* The following data is for RTP friendly coding */
700
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
701 702 703 704 705 706 707 708 709 710
    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    */
711 712 713 714 715 716 717 718

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

719 720 721 722 723 724 725 726
    /* 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;
727 728 729
    int misc_bits;
    
    /**
730 731
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
732
     * - decoding: unused
733
     */
734
    int frame_bits;
735

736
    /**
737 738 739
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
740 741 742
     */
    void *opaque;

F
Fabrice Bellard 已提交
743
    char codec_name[32];
744 745
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
746 747 748 749
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
750
     * - encoding: set by user, if not then the default based on codec_id will be used
751 752 753
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
754
    
755
    /**
756 757 758
     * workaround bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: unused
     * - decoding: set by user
759 760
     */
    int workaround_bugs;
761
#define FF_BUG_AUTODETECT       1  ///< autodetection
762 763 764 765
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
766
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
M
Michael Niedermayer 已提交
767
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
768
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
769
#define FF_BUG_QPEL_CHROMA2     256
770
#define FF_BUG_DIRECT_BLOCKSIZE 512
771
#define FF_BUG_EDGE             1024
772 773
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
774
    /**
775 776 777
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
778
     */
779
    int luma_elim_threshold;
780 781
    
    /**
782 783 784
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
785
     */
786
    int chroma_elim_threshold;
787 788
    
    /**
789 790 791
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
792 793 794 795
     */
    int strict_std_compliance;
    
    /**
796
     * qscale offset between ip and b frames.
797 798
     * 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)
799 800
     * - encoding: set by user.
     * - decoding: unused
801 802 803 804
     */
    float b_quant_offset;
    
    /**
805
     * error resilience higher values will detect more errors but may missdetect
806 807 808
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
809
     */
810
    int error_resilience;
811 812 813 814
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
815
    
816
    /**
M
cleanup  
Michael Niedermayer 已提交
817 818
     * 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
819
     * width and height should be rounded up to the next multiple of 16
820 821
     * - encoding: unused
     * - decoding: set by lavc, user can override
822
     */
M
Michael Niedermayer 已提交
823
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
824 825
    
    /**
M
cleanup  
Michael Niedermayer 已提交
826 827 828
     * 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
829 830
     * - encoding: unused
     * - decoding: set by lavc, user can override
831
     */
M
Michael Niedermayer 已提交
832
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
833

834
    /**
835 836 837
     * is 1 if the decoded stream contains b frames, 0 otherwise.
     * - encoding: unused
     * - decoding: set by lavc
838 839 840
     */
    int has_b_frames;
    
841
    int block_align; ///< used by some WAV based audio codecs
M
Michael Niedermayer 已提交
842
    
843
    int parse_only; /* - decoding only: if true, only parsing is done
844 845
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
M
Michael Niedermayer 已提交
846
    
847
    /**
848
     * 0-> h263 quant 1-> mpeg quant.
849 850
     * - encoding: set by user.
     * - decoding: unused
851 852
     */
    int mpeg_quant;
M
Michael Niedermayer 已提交
853
    
854
    /**
855 856 857
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
858
     */
859
    char *stats_out;
860 861 862 863
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
864 865
     * - encoding: allocated/set/freed by user
     * - decoding: unused
866 867 868 869
     */
    char *stats_in;
    
    /**
870
     * ratecontrol qmin qmax limiting method.
871
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
872 873
     * - encoding: set by user.
     * - decoding: unused
874
     */
M
Michael Niedermayer 已提交
875
    float rc_qsquish;
876

M
Michael Niedermayer 已提交
877 878
    float rc_qmod_amp;
    int rc_qmod_freq;
879 880
    
    /**
881 882 883
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
884
     */
M
Michael Niedermayer 已提交
885 886
    RcOverride *rc_override;
    int rc_override_count;
887 888
    
    /**
889 890 891
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
892
     */
M
Michael Niedermayer 已提交
893
    char *rc_eq;
894 895
    
    /**
896 897 898
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
899
     */
M
Michael Niedermayer 已提交
900
    int rc_max_rate;
901 902
    
    /**
903 904 905
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
906
     */
M
Michael Niedermayer 已提交
907
    int rc_min_rate;
908 909
    
    /**
910 911 912
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
913
     */
M
Michael Niedermayer 已提交
914 915
    int rc_buffer_size;
    float rc_buffer_aggressivity;
916 917

    /**
918 919 920
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
921 922 923 924
     */
    float i_quant_factor;
    
    /**
925
     * qscale offset between p and i frames.
926 927
     * 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)
928 929
     * - encoding: set by user.
     * - decoding: unused
930 931 932 933
     */
    float i_quant_offset;
    
    /**
934 935 936
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
937
     */
M
Michael Niedermayer 已提交
938
    float rc_initial_cplx;
939

940
    /**
941 942 943
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
944
     */
945
    int dct_algo;
946
#define FF_DCT_AUTO    0
947
#define FF_DCT_FASTINT 1
948 949 950
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
951
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
952
#define FF_DCT_FAAN    6
953 954
    
    /**
955 956 957
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
958 959 960 961
     */
    float lumi_masking;
    
    /**
962 963 964
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
965 966 967 968
     */
    float temporal_cplx_masking;
    
    /**
969 970 971
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
972 973 974 975
     */
    float spatial_cplx_masking;
    
    /**
976 977 978
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
979 980
     */
    float p_masking;
981

982
    /**
983 984 985
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
986 987
     */
    float dark_masking;
988
    
989 990 991 992
    
    /* for binary compatibility */
    int unused;
    
993
    /**
994 995 996
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
997 998 999 1000 1001 1002 1003 1004 1005 1006
     */
    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
1007
#define FF_IDCT_ALTIVEC      8
1008
#define FF_IDCT_SH4          9
1009
#define FF_IDCT_SIMPLEARM    10
1010

1011
    /**
1012 1013 1014
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1015 1016 1017
     */
    int slice_count;
    /**
1018 1019 1020
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1021 1022 1023
     */
    int *slice_offset;

1024
    /**
1025 1026 1027
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1028 1029 1030 1031 1032
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1033
    /**
Z
Zdenek Kabelac 已提交
1034
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1035
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
     *
     * 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 已提交
1051 1052

    /**
1053 1054 1055
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
1056 1057 1058 1059
     */
     int bits_per_sample;
    
    /**
1060 1061 1062
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1063 1064 1065 1066 1067
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
1068 1069
    
    /**
M
Michael Niedermayer 已提交
1070
     * sample aspect ratio (0 if unknown).
1071
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1072 1073
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
1074
     */
M
Michael Niedermayer 已提交
1075
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1076 1077

    /**
1078 1079 1080
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
1081
     */
M
Michael Niedermayer 已提交
1082
    AVFrame *coded_frame;
1083 1084

    /**
1085 1086 1087
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1088 1089 1090 1091 1092 1093 1094 1095
     */
    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 已提交
1096 1097 1098 1099
#define FF_DEBUG_VIS_MV    0x00000040
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1100
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1101
#define FF_DEBUG_MMCO      0x00000800
1102
#define FF_DEBUG_BUGS      0x00001000
1103 1104
    
    /**
1105 1106 1107
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1108 1109
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
1110 1111
    
    /**
1112 1113 1114
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1115 1116 1117 1118
     */
    int mb_qmin;

    /**
1119 1120 1121
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1122 1123
     */
    int mb_qmax;
M
Michael Niedermayer 已提交
1124 1125
    
    /**
1126 1127 1128
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1129 1130 1131
     */
    int me_cmp;
    /**
1132 1133 1134
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1135 1136 1137
     */
    int me_sub_cmp;
    /**
1138 1139 1140
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
     */
    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
    
    /**
1154 1155 1156
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1157 1158
     */
    int dia_size;
1159 1160

    /**
1161 1162 1163
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1164 1165
     */
    int last_predictor_count;
1166

M
Michael Niedermayer 已提交
1167
    /**
1168 1169 1170
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1171 1172
     */
    int pre_me;
1173

1174
    /**
1175 1176 1177
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1178 1179
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1180

1181
    /**
1182 1183 1184
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1185 1186 1187
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1188
    /**
1189 1190 1191
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1192 1193 1194
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1195
    /**
1196
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1197 1198 1199 1200
     * @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
1201 1202
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1203 1204
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1205 1206 1207 1208 1209 1210

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1211 1212
     * - encoding: unused.
     * - decoding: set by decoder 
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
     */
    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

1223 1224 1225 1226
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1227 1228
     * - encoding: set by user.
     * - decoding: unused.
1229
     */
Z
Zdenek Kabelac 已提交
1230
    int me_range;
1231

M
Michael Niedermayer 已提交
1232 1233 1234 1235 1236 1237 1238 1239
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
    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;
1255 1256 1257 1258 1259 1260 1261 1262

    /**
     * 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;
1263
    
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
    /**
     * 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;
1275 1276 1277 1278 1279 1280 1281

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

#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
M
Michael Niedermayer 已提交
1282 1283 1284 1285 1286 1287 1288
    /**
     * 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 已提交
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
    
#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;
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
    
    /**
     * 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 已提交
1316 1317 1318 1319 1320 1321
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    
    /**
     * 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
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345

    /**
     * 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;
1346
    
1347 1348 1349 1350 1351 1352 1353
    /**
     * 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;
M
Michael Niedermayer 已提交
1354 1355 1356 1357 1358 1359 1360 1361

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1376 1377 1378 1379 1380 1381 1382

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1383 1384 1385 1386 1387 1388 1389

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1390
    
1391
    /**
1392 1393 1394 1395 1396
     * called at the beginning of a frame to get cr buffer for it.
     * buffer type (size, hints) must be the same. lavc won't check it.
     * lavc will pass previous buffer in pic, function should return
     * same buffer or new buffer with old frame "painted" into it.
     * if pic.data[0] == NULL must behave like get_buffer().
1397
     * - encoding: unused
1398
     * - decoding: set by lavc, user can override
1399
     */
1400
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1401
    
F
Fabrice Bellard 已提交
1402 1403
} AVCodecContext;

1404

1405 1406 1407
/**
 * AVOption.
 */
1408 1409 1410
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
Z
Zdenek Kabelac 已提交
1411 1412
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1413 1414 1415 1416
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1417 1418 1419 1420 1421
#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
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
//#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 已提交
1440 1441 1442 1443 1444 1445 1446 1447 1448
/**
 * 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);


1449 1450 1451
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1452
typedef struct AVCodec {
1453
    const char *name;
Z
Zdenek Kabelac 已提交
1454
    enum CodecType type;
F
Fabrice Bellard 已提交
1455 1456 1457
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1458
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1459
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1460
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1461
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1462
    int capabilities;
1463
    const AVOption *options;
F
Fabrice Bellard 已提交
1464
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1465
    void (*flush)(AVCodecContext *);
F
Fabrice Bellard 已提交
1466 1467
} AVCodec;

1468
/**
1469 1470 1471
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1472
typedef struct AVPicture {
1473
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1474
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1475 1476
} AVPicture;

M
Mike Melanson 已提交
1477 1478 1479 1480 1481
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1482
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
1483
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
1484 1485 1486 1487 1488 1489
typedef struct AVPaletteControl {

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

1490 1491 1492 1493
    /* 4-byte ARGB palette entries, stored in native byte order; note that
     * the individual palette components should be on a 8-bit scale; if
     * the palette data comes from a IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled */
1494
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
1495 1496 1497

} AVPaletteControl;

F
Fabrice Bellard 已提交
1498 1499
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1500
extern AVCodec mp3lame_encoder;
1501
extern AVCodec oggvorbis_encoder;
1502
extern AVCodec faac_encoder;
F
Fabrice Bellard 已提交
1503
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1504
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
1505 1506
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1507
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1508
extern AVCodec rv10_encoder;
M
Michael Niedermayer 已提交
1509
extern AVCodec rv20_encoder;
F
Fabrice Bellard 已提交
1510
extern AVCodec mjpeg_encoder;
1511
extern AVCodec ljpeg_encoder;
F
Fabrice Bellard 已提交
1512
extern AVCodec mpeg4_encoder;
1513 1514 1515
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1516 1517
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1518
extern AVCodec huffyuv_encoder;
M
Michael Niedermayer 已提交
1519
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1520
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1521
extern AVCodec asv2_encoder;
M
Michael Niedermayer 已提交
1522
extern AVCodec vcr1_encoder;
1523
extern AVCodec ffv1_encoder;
1524
extern AVCodec mdec_encoder;
F
Fabrice Bellard 已提交
1525 1526

extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
1527
extern AVCodec mpeg4_decoder;
1528 1529 1530
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1531
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1532
extern AVCodec wmv2_decoder;
M
Michael Niedermayer 已提交
1533 1534
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
I
Ivan Kalvachev 已提交
1535
extern AVCodec mpegvideo_decoder;
I
Ivan Kalvachev 已提交
1536
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1537
extern AVCodec h263i_decoder;
1538
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1539
extern AVCodec rv10_decoder;
M
Michael Niedermayer 已提交
1540
extern AVCodec rv20_decoder;
N
Nick Kurshev 已提交
1541
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1542
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1543
extern AVCodec dvvideo_decoder;
F
Fabrice Bellard 已提交
1544 1545
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1546
extern AVCodec mjpeg_decoder;
1547
extern AVCodec mjpegb_decoder;
1548
extern AVCodec sp5x_decoder;
1549
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1550
extern AVCodec mp3_decoder;
1551 1552
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1553
extern AVCodec huffyuv_decoder;
M
Mark Hills 已提交
1554
extern AVCodec oggvorbis_decoder;
1555
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1556
extern AVCodec h264_decoder;
1557
extern AVCodec indeo3_decoder;
1558
extern AVCodec vp3_decoder;
1559
extern AVCodec theora_decoder;
1560
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1561
extern AVCodec amr_nb_encoder;
1562 1563
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
1564 1565
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1566
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1567
extern AVCodec asv2_decoder;
M
Michael Niedermayer 已提交
1568
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1569
extern AVCodec cljr_decoder;
1570
extern AVCodec ffv1_decoder;
M
Michael Niedermayer 已提交
1571
extern AVCodec fourxm_decoder;
1572
extern AVCodec mdec_decoder;
1573 1574
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1575
extern AVCodec xan_wc3_decoder;
1576 1577 1578 1579
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
M
Mike Melanson 已提交
1580
extern AVCodec vqa_decoder;
1581
extern AVCodec idcin_decoder;
R
Roberto Togni 已提交
1582
extern AVCodec eightbps_decoder;
M
Mike Melanson 已提交
1583
extern AVCodec smc_decoder;
M
Mike Melanson 已提交
1584
extern AVCodec flic_decoder;
1585
extern AVCodec truemotion1_decoder;
1586 1587
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1588 1589
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1590
extern AVCodec xan_dpcm_decoder;
F
Fabrice Bellard 已提交
1591

F
Fabrice Bellard 已提交
1592 1593 1594
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1595
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605

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

1606 1607 1608 1609
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1610 1611
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1612
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1613
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
M
Michael Niedermayer 已提交
1614
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1615 1616
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1617

F
Fabrice Bellard 已提交
1618 1619 1620
#undef PCM_CODEC

/* dummy raw video codec */
1621 1622
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645

/* 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);
1646 1647 1648 1649 1650 1651

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

F
Fabrice Bellard 已提交
1652
void img_resample(ImgReSampleContext *s, 
1653
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
1654 1655 1656

void img_resample_close(ImgReSampleContext *s);

D
Drew Hess 已提交
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
 * @param picture the picture to be filled in.
 * @param pix_fmt the format of the picture.
 * @param width the width of the picture.
 * @param height the height of the picture.
 * @return 0 if successful, -1 if not.
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

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

1671
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1672
                   int pix_fmt, int width, int height);
1673
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
1674
                     unsigned char *dest, int dest_size);
1675
int avpicture_get_size(int pix_fmt, int width, int height);
1676 1677
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);
1678
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1679

1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
#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 已提交
1692 1693
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
1694 1695
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
F
Fabrice Bellard 已提交
1696

1697 1698
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
1699
                const AVPicture *src, int pix_fmt, 
1700 1701 1702
                int width, int height);

/* deinterlace a picture */
1703
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
1704 1705 1706 1707 1708 1709
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1710
/* returns LIBAVCODEC_VERSION_INT constant */
1711
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1712
/* returns LIBAVCODEC_BUILD constant */
1713
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1714 1715 1716 1717
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1718
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
1719 1720 1721 1722
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 已提交
1723
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
1724
AVCodecContext *avcodec_alloc_context(void);
M
Michael Niedermayer 已提交
1725
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
1726

M
Michael Niedermayer 已提交
1727 1728
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1729
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1730

M
Michael Niedermayer 已提交
1731 1732 1733 1734
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1735
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1736

1737
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
1738
                         int *frame_size_ptr,
1739
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
1740
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
1741
                         int *got_picture_ptr,
1742 1743
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1744
                        int *data_size_ptr,
1745 1746
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
1747
                         const short *samples);
1748
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
1749
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
1750 1751 1752 1753

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
1755 1756
void avcodec_flush_buffers(AVCodecContext *avctx);

1757
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1758 1759 1760 1761 1762 1763

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

1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776
/**
 * 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);
1777 1778


1779 1780 1781 1782 1783 1784 1785
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1786
    /// compressed size used from given memory buffer
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
    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 已提交
1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
    int64_t cur_offset; /* current offset 
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
    int pict_type; /* XXX: put it back in AVCodecContext */
    int repeat_pict; /* XXX: put it back in AVCodecContext */
    int64_t pts;     /* in us, if given by the codec (used by raw mpeg4) */
    int64_t dts;     /* in us, if given by the codec (used by raw mpeg4) */
} AVCodecParserContext;

typedef struct AVCodecParser {
    int codec_ids[3]; /* several codec IDs are permitted */
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
    int (*parser_parse)(AVCodecParserContext *s, 
                        AVCodecContext *avctx,
                        uint8_t **poutbuf, int *poutbuf_size, 
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
int av_parser_parse(AVCodecParserContext *s, 
                    AVCodecContext *avctx,
                    uint8_t **poutbuf, int *poutbuf_size, 
                    const uint8_t *buf, int buf_size);
void av_parser_close(AVCodecParserContext *s);

extern AVCodecParser mpegvideo_parser;
extern AVCodecParser mpeg4video_parser;
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
extern AVCodecParser mpegaudio_parser;
extern AVCodecParser ac3_parser;

F
Fabrice Bellard 已提交
1899
/* memory */
1900
void *av_malloc(unsigned int size);
1901
void *av_mallocz(unsigned int size);
1902
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
1903
void av_free(void *ptr);
1904
char *av_strdup(const char *s);
F
Fabrice Bellard 已提交
1905 1906
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1907
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1908 1909
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
1910
void av_free_static(void);
1911 1912
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
F
Fabrice Bellard 已提交
1913

1914 1915 1916
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

1917 1918 1919
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
/* av_log API */

#include <stdarg.h>

#define AV_LOG_ERROR 0
#define AV_LOG_INFO 1
#define AV_LOG_DEBUG 2

extern void av_log(AVCodecContext*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
extern void av_vlog(AVCodecContext*, int level, const char *fmt, va_list);
extern int av_log_get_level(void);
extern void av_log_set_level(int);
extern void av_log_set_callback(void (*)(AVCodecContext*, int, const char*, va_list));

#undef  AV_LOG_TRAP_PRINTF
#ifdef AV_LOG_TRAP_PRINTF
#define printf DO NOT USE
#define fprintf DO NOT USE
#undef stderr
#define stderr DO NOT USE
#endif

1942 1943 1944 1945
#ifdef __cplusplus
}
#endif

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