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

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


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

F
Fabrice Bellard 已提交
14
#include "common.h"
M
Michael Niedermayer 已提交
15
#include "rational.h"
Z
Zdenek Kabelac 已提交
16
#include <sys/types.h> /* size_t */
F
Fabrice Bellard 已提交
17

18 19
#define FFMPEG_VERSION_INT     0x000409
#define FFMPEG_VERSION         "0.4.9-pre1"
R
Roberto Togni 已提交
20
#define LIBAVCODEC_BUILD       4738
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

29
#define AV_NOPTS_VALUE int64_t_C(0x8000000000000000)
30 31
#define AV_TIME_BASE 1000000

F
Fabrice Bellard 已提交
32 33 34
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
35
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
I
Ivan Kalvachev 已提交
36
    CODEC_ID_MPEG2VIDEO_XVMC,
37
    CODEC_ID_H261,
F
Fabrice Bellard 已提交
38 39
    CODEC_ID_H263,
    CODEC_ID_RV10,
M
Michael Niedermayer 已提交
40
    CODEC_ID_RV20,
F
Fabrice Bellard 已提交
41
    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
    CODEC_ID_DVVIDEO,
M
huffyuv  
Michael Niedermayer 已提交
58
    CODEC_ID_HUFFYUV,
59
    CODEC_ID_CYUV,
M
Michael Niedermayer 已提交
60
    CODEC_ID_H264,
61
    CODEC_ID_INDEO3,
62
    CODEC_ID_VP3,
63
    CODEC_ID_THEORA,
M
Michael Niedermayer 已提交
64
    CODEC_ID_ASV1,
M
Michael Niedermayer 已提交
65
    CODEC_ID_ASV2,
66
    CODEC_ID_FFV1,
67
    CODEC_ID_4XM,
M
Michael Niedermayer 已提交
68
    CODEC_ID_VCR1,
A
Alex Beregszaszi 已提交
69
    CODEC_ID_CLJR,
70
    CODEC_ID_MDEC,
71 72
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
73 74
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
75 76 77 78 79
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
80
    CODEC_ID_IDCIN,
R
Roberto Togni 已提交
81
    CODEC_ID_8BPS,
M
Mike Melanson 已提交
82
    CODEC_ID_SMC,
M
Mike Melanson 已提交
83
    CODEC_ID_FLIC,
84
    CODEC_ID_TRUEMOTION1,
85
    CODEC_ID_VMDVIDEO,
R
Roberto Togni 已提交
86 87
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
88
    CODEC_ID_QTRLE,
89
    CODEC_ID_SNOW,
90
    CODEC_ID_TSCC,
91
    CODEC_ID_ULTI,
92
    CODEC_ID_QDRAW,
93
    CODEC_ID_VIXL,
94
    CODEC_ID_QPEG,
95 96 97 98 99 100 101
    CODEC_ID_XVID,
    CODEC_ID_PNG,
    CODEC_ID_PPM,
    CODEC_ID_PBM,
    CODEC_ID_PGM,
    CODEC_ID_PGMYUV,
    CODEC_ID_PAM,
L
Loren Merritt 已提交
102
    CODEC_ID_FFVHUFF,
103 104 105
    CODEC_ID_RV30,
    CODEC_ID_RV40,
    
F
Fabrice Bellard 已提交
106 107

    /* various pcm "codecs" */
108
    CODEC_ID_PCM_S16LE= 0x10000,
F
Fabrice Bellard 已提交
109 110 111 112 113 114 115
    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,
116 117

    /* various adpcm codecs */
118
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
119
    CODEC_ID_ADPCM_IMA_WAV,
120 121
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
122
    CODEC_ID_ADPCM_IMA_WS,
123
    CODEC_ID_ADPCM_IMA_SMJPEG,
124
    CODEC_ID_ADPCM_MS,
125
    CODEC_ID_ADPCM_4XM,
126 127
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
128
    CODEC_ID_ADPCM_EA,
129
    CODEC_ID_ADPCM_G726,
130
    CODEC_ID_ADPCM_CT,
131

132 133
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
134 135
    CODEC_ID_AMR_WB,

136
    /* RealAudio codecs*/
137
    CODEC_ID_RA_144= 0x13000,
138
    CODEC_ID_RA_288,
139 140

    /* various DPCM codecs */
141
    CODEC_ID_ROQ_DPCM= 0x14000,
142
    CODEC_ID_INTERPLAY_DPCM,
143
    CODEC_ID_XAN_DPCM,
144
    CODEC_ID_SOL_DPCM,
145
    
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    CODEC_ID_MP2= 0x15000,
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
    CODEC_ID_AC3,
    CODEC_ID_DTS,
    CODEC_ID_VORBIS,
    CODEC_ID_DVAUDIO,
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
    CODEC_ID_VMDAUDIO,
    CODEC_ID_SONIC,
    CODEC_ID_SONIC_LS,
M
Michael Niedermayer 已提交
161
    CODEC_ID_FLAC,
R
Roberto Togni 已提交
162
    CODEC_ID_MP3ADU,
M
Michael Niedermayer 已提交
163
    
164
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
165
                         stream (only used by libavformat) */
F
Fabrice Bellard 已提交
166
};
167 168 169

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
F
Fabrice Bellard 已提交
170 171

enum CodecType {
172
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
173 174
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
175
    CODEC_TYPE_DATA,
F
Fabrice Bellard 已提交
176 177
};

178
/**
M
Mike Melanson 已提交
179 180 181 182 183 184 185 186 187 188 189 190
 * 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
191 192 193 194
 * 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.
195
 */
F
Fabrice Bellard 已提交
196
enum PixelFormat {
M
Michael Niedermayer 已提交
197
    PIX_FMT_YUV420P,   ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
198
    PIX_FMT_YUV422,    ///< Packed pixel, Y0 Cb Y1 Cr 
M
Michael Niedermayer 已提交
199 200 201 202
    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 已提交
203
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
M
Michael Niedermayer 已提交
204 205
    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)
206 207
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
208
    PIX_FMT_GRAY8,
209 210 211
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
M
Michael Niedermayer 已提交
212 213 214
    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 已提交
215 216
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
217
    PIX_FMT_UYVY422,   ///< Packed pixel, Cb Y0 Cr Y1 
218
    PIX_FMT_UYVY411,   ///< Packed pixel, Cb Y0 Y1 Cr Y2 Y3
219
    PIX_FMT_NB,
F
Fabrice Bellard 已提交
220 221
};

F
Fabrice Bellard 已提交
222 223
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
224
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
F
Fabrice Bellard 已提交
225 226
};

F
Fabrice Bellard 已提交
227
/* in bytes */
F
Fabrice Bellard 已提交
228
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
F
Fabrice Bellard 已提交
229

230
/**
231 232 233 234 235
 * 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
236 237 238
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

239 240 241 242 243 244
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

245 246
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
247
    ME_ZERO = 1,
248 249 250 251 252 253 254
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

255 256 257 258 259 260 261 262
enum AVRounding {
    AV_ROUND_ZERO     = 0, ///< round toward zero
    AV_ROUND_INF      = 1, ///< round away from zero
    AV_ROUND_DOWN     = 2, ///< round toward -infinity
    AV_ROUND_UP       = 3, ///< round toward +infinity
    AV_ROUND_NEAR_INF = 5, ///< round to nearest and halfway cases away from zero
};

M
Michael Niedermayer 已提交
263 264 265 266 267 268 269
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;

270 271 272
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

M
Michael Niedermayer 已提交
273
#define FF_MAX_B_FRAMES 8
274

M
Michael Niedermayer 已提交
275 276 277 278
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
F
Fabrice Bellard 已提交
279

280
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
281
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
282 283
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
284
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
285
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
286 287
/* 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 */
288
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
289 290 291 292 293 294 295
#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 
296
                                            of only at frame boundaries */
297 298
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
299
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
300 301 302 303
#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) 
304
/* Fx : Flag for h263+ extra options */
M
Michael Niedermayer 已提交
305 306
#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
307
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
308
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
309
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
310
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
M
Michael Niedermayer 已提交
311 312
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
M
Michael Niedermayer 已提交
313 314
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
M
Michael Niedermayer 已提交
315
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
316
#define CODEC_FLAG_CLOSED_GOP     0x80000000
317
#define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
318
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
319

320 321 322
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Reference Picture Selection
M
Michael Niedermayer 已提交
323
 * 		Independant Segment Decoding */
324
/* /Fx */
F
Fabrice Bellard 已提交
325 326
/* codec capabilities */

327
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
M
Michael Niedermayer 已提交
328 329 330 331 332
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
333 334 335
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
336
#define CODEC_CAP_TRUNCATED       0x0008
337 338
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
339 340
/** codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data */
#define CODEC_CAP_DELAY           0x0020
F
Fabrice Bellard 已提交
341

342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
//the following defines might change, so dont expect compatibility if u use them
#define MB_TYPE_INTRA4x4   0x0001
#define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME h264 specific
#define MB_TYPE_16x16      0x0008
#define MB_TYPE_16x8       0x0010
#define MB_TYPE_8x16       0x0020
#define MB_TYPE_8x8        0x0040
#define MB_TYPE_INTERLACED 0x0080
#define MB_TYPE_DIRECT2     0x0100 //FIXME
#define MB_TYPE_ACPRED     0x0200
#define MB_TYPE_GMC        0x0400
#define MB_TYPE_SKIP       0x0800
#define MB_TYPE_P0L0       0x1000
#define MB_TYPE_P1L0       0x2000
#define MB_TYPE_P0L1       0x4000
#define MB_TYPE_P1L1       0x8000
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
#define MB_TYPE_QUANT      0x00010000
#define MB_TYPE_CBP        0x00020000
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
/**
 * 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 已提交
394
#define FF_COMMON_FRAME \
M
Michael Niedermayer 已提交
395 396 397 398 399 400
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
M
cleanup  
Michael Niedermayer 已提交
401 402 403
    uint8_t *data[4];\
    int linesize[4];\
    /**\
M
Michael Niedermayer 已提交
404
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
M
cleanup  
Michael Niedermayer 已提交
405
     * this isnt used by lavc unless the default get/release_buffer() is used\
406 407
     * - encoding: \
     * - decoding: \
M
cleanup  
Michael Niedermayer 已提交
408 409 410 411
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
412 413
     * - encoding: set by lavc\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
414 415 416 417
     */\
    int key_frame;\
\
    /**\
M
Michael Niedermayer 已提交
418
     * picture type of the frame, see ?_TYPE below.\
419 420
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
421 422 423 424
     */\
    int pict_type;\
\
    /**\
425 426
     * presentation timestamp in AV_TIME_BASE (=micro seconds currently) (time when frame should be shown to user)\
     * if AV_NOPTS_VALUE then the frame_rate will be used as reference\
427 428
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
429
     */\
430
    int64_t pts;\
M
cleanup  
Michael Niedermayer 已提交
431 432 433
\
    /**\
     * picture number in bitstream order.\
434 435
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
436 437 438 439
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
440 441
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
442 443 444 445
     */\
    int display_picture_number;\
\
    /**\
446
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
447 448
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
449
     */\
450
    int quality; \
M
cleanup  
Michael Niedermayer 已提交
451 452 453
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
454
     * set to INT_MAX if the buffer has not been used yet \
455 456
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
M
cleanup  
Michael Niedermayer 已提交
457 458 459 460 461
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
462 463
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
M
cleanup  
Michael Niedermayer 已提交
464 465 466 467 468
     */\
    int reference;\
\
    /**\
     * QP table\
469 470
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
471 472 473 474
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
475 476
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
477 478 479 480 481 482
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
483 484
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
485 486
     */\
    uint8_t *mbskip_table;\
487 488
\
    /**\
M
Michael Niedermayer 已提交
489 490 491 492 493 494 495 496
     * Motion vector table.\
     * @code\
     * example:\
     * int mv_sample_log2= 4 - motion_subsample_log2;\
     * int mb_width= (width+15)>>4;\
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
     * @endcode\
497
     * - encoding: set by user\
498 499 500 501 502 503 504
     * - decoding: set by lavc\
     */\
    int16_t (*motion_val[2])[2];\
\
    /**\
     * Macroblock type table\
     * mb_type_base + mb_width + 2\
505
     * - encoding: set by user\
506 507 508 509 510
     * - decoding: set by lavc\
     */\
    uint32_t *mb_type;\
\
    /**\
511 512
     * log2 of the size of the block which a single vector in motion_val represents: \
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
513 514 515 516
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    uint8_t motion_subsample_log2;\
M
cleanup  
Michael Niedermayer 已提交
517 518 519
\
    /**\
     * for some private data of the user\
520 521
     * - encoding: unused\
     * - decoding: set by user\
M
cleanup  
Michael Niedermayer 已提交
522 523
     */\
    void *opaque;\
524 525 526
\
    /**\
     * error\
527 528
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
529 530
     */\
    uint64_t error[4];\
M
Michael Niedermayer 已提交
531 532 533
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
534 535
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
F
Falk Hüffner 已提交
536
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
M
Michael Niedermayer 已提交
537 538
     */\
    int type;\
539 540 541 542
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
543 544
     * - encoding: unused\
     * - decoding: set by lavc\
545
     */\
M
Michael Niedermayer 已提交
546 547 548 549 550 551
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
552 553 554 555 556 557 558 559 560
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
561
     * if the content is interlaced, is top field displayed first.\
562
     * - encoding: set by user\
563
     * - decoding: set by lavc\
564
     */\
565
    int top_field_first;\
566 567 568 569 570 571 572
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
573 574 575 576 577 578 579
    \
    /**\
     * 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;\
580 581 582 583 584 585 586
    \
    /**\
     * Codec suggestion on buffer type if != 0\
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
     */\
    int buffer_hints;\
587 588 589 590 591 592 593
\
    /**\
     * DCT coeffitients\
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    short *dct_coeff;\
594 595 596 597 598 599 600
\
    /**\
     * Motion referece frame index\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    int8_t *ref_index[2];
601

M
Michael Niedermayer 已提交
602 603
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
604 605

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
606
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
607
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewher else, dont dealloc image (data/base), all other tables are not shared
M
Michael Niedermayer 已提交
608
#define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, dont dealloc anything
M
Michael Niedermayer 已提交
609

M
cleanup  
Michael Niedermayer 已提交
610

611 612 613 614
#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 已提交
615 616
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
617

618 619 620 621 622
#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 已提交
623 624 625
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
626 627 628
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
629

630
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
631

632 633 634 635 636 637 638 639 640 641 642 643
/**
 * Used by av_log
 */
typedef struct AVCLASS AVClass;
struct AVCLASS {
    const char* class_name;
    const char* (*item_name)(void*); /* actually passing a pointer to an AVCodecContext
					or AVFormatContext, which begin with an AVClass.
					Needed because av_log is in libavcodec and has no visibility
					of AVIn/OutputFormat */
};

M
doxy  
Michael Niedermayer 已提交
644 645 646
/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
647
typedef struct AVCodecContext {
648 649 650 651
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
M
Michael Niedermayer 已提交
652
    AVClass *av_class;
653
    /**
654 655 656
     * 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 
657
     */
F
Fabrice Bellard 已提交
658
    int bit_rate;
659 660

    /**
661
     * number of bits the bitstream is allowed to diverge from the reference.
662
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
663 664
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
665 666 667 668
     */
    int bit_rate_tolerance; 

    /**
669 670 671
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
672
     */
F
Fabrice Bellard 已提交
673
    int flags;
674 675 676

    /**
     * some codecs needs additionnal format info. It is stored here
677 678
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
679 680 681 682
     */
    int sub_id;

    /**
683 684 685
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
686 687 688 689
     */
    int me_method;

    /**
690
     * some codecs need / can use extra-data like huffman tables.
691 692
     * mjpeg: huffman tables
     * rv10: additional flags
693
     * mpeg4: global headers (they can be in the bitstream or here)
694 695
     * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
     * then extradata_size to avoid prolems if its read with the bitstream reader
696 697
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
698
     */
699 700 701
    void *extradata;
    int extradata_size;
    
F
Fabrice Bellard 已提交
702
    /* video only */
703
    /**
704
     * frames per sec multiplied by frame_rate_base.
705
     * for variable fps this is the precission, so if the timestamps 
706
     * can be specified in msec precssion then this is 1000*frame_rate_base
707 708
     * - encoding: MUST be set by user
     * - decoding: set by lavc. 0 or the frame_rate if available
709 710
     */
    int frame_rate;
711
    
712
    /**
713
     * picture width / height.
714
     * - encoding: MUST be set by user. 
715 716 717
     * - decoding: set by lavc.
     * Note, for compatibility its possible to set this instead of 
     * coded_width/height before decoding
718
     */
F
Fabrice Bellard 已提交
719
    int width, height;
720
    
721
#define FF_ASPECT_EXTENDED 15
722 723

    /**
724 725 726
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
727 728 729 730
     */
    int gop_size;

    /**
731
     * pixel format, see PIX_FMT_xxx.
732 733 734 735
     * - 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.
736
     * - decoding: set by lavc.
737
     */
738
    enum PixelFormat pix_fmt;
739 740 741 742 743 744 745 746 747
 
    /**
     * 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;
       
748 749 750 751 752
    /**
     * 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
753 754
     * - encoding: unused
     * - decoding: set by user.
755 756 757 758
     * @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
759
     */
F
Fabrice Bellard 已提交
760
    void (*draw_horiz_band)(struct AVCodecContext *s,
761
                            const AVFrame *src, int offset[4],
762
                            int y, int type, int height);
F
Fabrice Bellard 已提交
763

F
Fabrice Bellard 已提交
764
    /* audio only */
765
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
766
    int channels;
767
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
768 769

    /* the following data should not be initialized */
770 771 772
    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 已提交
773
    
774 775
    /**
     * number of frames the decoded output will be delayed relative to 
776 777 778
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
779 780
     */
    int delay;
M
Michael Niedermayer 已提交
781
    
782 783 784
    /* - 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) 
785 786
    
    /**
787 788 789
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
790 791 792 793
     */
    int qmin;

    /**
794 795 796
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
797 798 799 800
     */
    int qmax;

    /**
801 802 803
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
804 805 806 807
     */
    int max_qdiff;

    /**
808
     * maximum number of b frames between non b frames.
809
     * note: the output will be delayed by max_b_frames+1 relative to the input
810 811
     * - encoding: set by user.
     * - decoding: unused
812 813 814 815
     */
    int max_b_frames;

    /**
816 817 818
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
819 820 821 822 823
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
824
    int b_frame_strategy;
825

826
    /**
827 828 829
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
830 831
     */
    int hurry_up;
832
    
F
Fabrice Bellard 已提交
833
    struct AVCodec *codec;
834
    
F
Fabrice Bellard 已提交
835 836
    void *priv_data;

M
Michael Niedermayer 已提交
837 838
    /* unused, FIXME remove*/
    int rtp_mode;
839 840 841 842 843 844 845
    
    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    */
846 847 848 849 850 851

    
    /* 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   */
852
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int packet_number); 
853

854 855 856 857 858 859 860 861
    /* 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;
862 863 864
    int misc_bits;
    
    /**
865 866
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
867
     * - decoding: unused
868
     */
869
    int frame_bits;
870

871
    /**
872 873 874
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
875 876 877
     */
    void *opaque;

F
Fabrice Bellard 已提交
878
    char codec_name[32];
879 880
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
881 882 883 884
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
885
     * - encoding: set by user, if not then the default based on codec_id will be used
886 887 888
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
889
    
890
    /**
891 892 893
     * workaround bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: unused
     * - decoding: set by user
894 895
     */
    int workaround_bugs;
896
#define FF_BUG_AUTODETECT       1  ///< autodetection
897 898 899 900
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
M
Michael Niedermayer 已提交
901
#define FF_BUG_AMV              32
902
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
M
Michael Niedermayer 已提交
903
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
904
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
905
#define FF_BUG_QPEL_CHROMA2     256
906
#define FF_BUG_DIRECT_BLOCKSIZE 512
907
#define FF_BUG_EDGE             1024
908
#define FF_BUG_HPEL_CHROMA      2048
909
#define FF_BUG_DC_CLIP          4096
910 911
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
912
    /**
913 914 915
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
916
     */
917
    int luma_elim_threshold;
918 919
    
    /**
920 921 922
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
923
     */
924
    int chroma_elim_threshold;
925 926
    
    /**
927 928 929
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
930 931 932 933
     */
    int strict_std_compliance;
    
    /**
934
     * qscale offset between ip and b frames.
935 936
     * 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)
937 938
     * - encoding: set by user.
     * - decoding: unused
939 940 941 942
     */
    float b_quant_offset;
    
    /**
943
     * error resilience higher values will detect more errors but may missdetect
944 945 946
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
947
     */
948
    int error_resilience;
949 950 951 952
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
953
    
954
    /**
M
cleanup  
Michael Niedermayer 已提交
955 956
     * 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
957 958
     * avcodec_align_dimensions() should be used to find the required width and
     * height, as they normally need to be rounded up to the next multiple of 16
959 960
     * - encoding: unused
     * - decoding: set by lavc, user can override
961
     */
M
Michael Niedermayer 已提交
962
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
963 964
    
    /**
M
cleanup  
Michael Niedermayer 已提交
965 966 967
     * 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
968 969
     * - encoding: unused
     * - decoding: set by lavc, user can override
970
     */
M
Michael Niedermayer 已提交
971
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
972

973
    /**
974 975
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
976
     * - decoding: set by lavc
977 978 979
     */
    int has_b_frames;
    
980
    int block_align; ///< used by some WAV based audio codecs
M
Michael Niedermayer 已提交
981
    
982
    int parse_only; /* - decoding only: if true, only parsing is done
983 984
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
M
Michael Niedermayer 已提交
985
    
986
    /**
987
     * 0-> h263 quant 1-> mpeg quant.
988 989
     * - encoding: set by user.
     * - decoding: unused
990 991
     */
    int mpeg_quant;
M
Michael Niedermayer 已提交
992
    
993
    /**
994 995 996
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
997
     */
998
    char *stats_out;
999 1000 1001 1002
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1003 1004
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1005 1006 1007 1008
     */
    char *stats_in;
    
    /**
1009
     * ratecontrol qmin qmax limiting method.
1010
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1011 1012
     * - encoding: set by user.
     * - decoding: unused
1013
     */
M
Michael Niedermayer 已提交
1014
    float rc_qsquish;
1015

M
Michael Niedermayer 已提交
1016 1017
    float rc_qmod_amp;
    int rc_qmod_freq;
1018 1019
    
    /**
1020 1021 1022
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1023
     */
M
Michael Niedermayer 已提交
1024 1025
    RcOverride *rc_override;
    int rc_override_count;
1026 1027
    
    /**
1028 1029 1030
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1031
     */
M
Michael Niedermayer 已提交
1032
    char *rc_eq;
1033 1034
    
    /**
1035 1036 1037
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1038
     */
M
Michael Niedermayer 已提交
1039
    int rc_max_rate;
1040 1041
    
    /**
1042 1043 1044
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1045
     */
M
Michael Niedermayer 已提交
1046
    int rc_min_rate;
1047 1048
    
    /**
1049 1050 1051
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1052
     */
M
Michael Niedermayer 已提交
1053 1054
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1055 1056

    /**
1057
     * qscale factor between p and i frames.
1058 1059
     * 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)
1060 1061
     * - encoding: set by user.
     * - decoding: unused
1062 1063 1064 1065
     */
    float i_quant_factor;
    
    /**
1066 1067 1068
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1069 1070 1071 1072
     */
    float i_quant_offset;
    
    /**
1073 1074 1075
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1076
     */
M
Michael Niedermayer 已提交
1077
    float rc_initial_cplx;
1078

1079
    /**
1080 1081 1082
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1083
     */
1084
    int dct_algo;
1085
#define FF_DCT_AUTO    0
1086
#define FF_DCT_FASTINT 1
1087 1088 1089
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1090
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
1091
#define FF_DCT_FAAN    6
1092 1093
    
    /**
1094 1095 1096
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1097 1098 1099 1100
     */
    float lumi_masking;
    
    /**
1101 1102 1103
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1104 1105 1106 1107
     */
    float temporal_cplx_masking;
    
    /**
1108 1109 1110
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1111 1112 1113 1114
     */
    float spatial_cplx_masking;
    
    /**
1115 1116 1117
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1118 1119
     */
    float p_masking;
1120

1121
    /**
1122 1123 1124
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1125 1126
     */
    float dark_masking;
1127
    
1128 1129 1130 1131
    
    /* for binary compatibility */
    int unused;
    
1132
    /**
1133 1134 1135
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
     */
    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
1146
#define FF_IDCT_ALTIVEC      8
1147
#define FF_IDCT_SH4          9
1148
#define FF_IDCT_SIMPLEARM    10
1149
#define FF_IDCT_H264         11
1150

1151
    /**
1152 1153 1154
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1155 1156 1157
     */
    int slice_count;
    /**
1158 1159 1160
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1161 1162 1163
     */
    int *slice_offset;

1164
    /**
1165 1166 1167
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1168 1169 1170 1171 1172
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1173
    /**
Z
Zdenek Kabelac 已提交
1174
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1175
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
     *
     * 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 */
1190
#define FF_MM_3DNOWEXT	0x0020 /* AMD 3DNowExt */
Z
Zdenek Kabelac 已提交
1191
#endif /* HAVE_MMX */
M
huffyuv  
Michael Niedermayer 已提交
1192 1193

    /**
1194 1195 1196
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
1197 1198 1199 1200
     */
     int bits_per_sample;
    
    /**
1201 1202 1203
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1204 1205 1206 1207 1208
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
1209 1210
    
    /**
M
Michael Niedermayer 已提交
1211
     * sample aspect ratio (0 if unknown).
1212
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1213 1214
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
1215
     */
M
Michael Niedermayer 已提交
1216
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1217 1218

    /**
1219 1220 1221
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
1222
     */
M
Michael Niedermayer 已提交
1223
    AVFrame *coded_frame;
1224 1225

    /**
1226 1227 1228
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1229 1230 1231 1232 1233 1234 1235 1236
     */
    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
1237
#define FF_DEBUG_DCT_COEFF 0x00000040
M
Michael Niedermayer 已提交
1238 1239 1240
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1241
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1242
#define FF_DEBUG_MMCO      0x00000800
1243
#define FF_DEBUG_BUGS      0x00001000
M
Michael Niedermayer 已提交
1244 1245
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1246
    
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256
    /**
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    int debug_mv;
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames

1257
    /**
1258 1259 1260
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1261 1262
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
1263 1264
    
    /**
1265 1266 1267
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1268 1269 1270 1271
     */
    int mb_qmin;

    /**
1272 1273 1274
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1275 1276
     */
    int mb_qmax;
M
Michael Niedermayer 已提交
1277 1278
    
    /**
1279 1280 1281
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1282 1283 1284
     */
    int me_cmp;
    /**
1285 1286 1287
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1288 1289 1290
     */
    int me_sub_cmp;
    /**
1291 1292 1293
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1294 1295
     */
    int mb_cmp;
1296 1297 1298 1299 1300 1301
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
M
Michael Niedermayer 已提交
1302 1303 1304 1305 1306 1307 1308 1309
#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
1310 1311
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1312
#define FF_CMP_NSSE 10
M
Michael Niedermayer 已提交
1313 1314
#define FF_CMP_W53  11
#define FF_CMP_W97  12
1315
#define FF_CMP_DCTMAX 13
M
Michael Niedermayer 已提交
1316 1317 1318
#define FF_CMP_CHROMA 256
    
    /**
1319 1320 1321
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1322 1323
     */
    int dia_size;
1324 1325

    /**
1326 1327 1328
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1329 1330
     */
    int last_predictor_count;
1331

M
Michael Niedermayer 已提交
1332
    /**
1333 1334 1335
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1336 1337
     */
    int pre_me;
1338

1339
    /**
1340 1341 1342
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1343 1344
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1345

1346
    /**
1347 1348 1349
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1350 1351 1352
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1353
    /**
1354 1355 1356
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1357 1358 1359
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1360
    /**
1361
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1362 1363 1364 1365
     * @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
1366 1367
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1368
     */
I
Ivan Kalvachev 已提交
1369
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1370 1371 1372 1373 1374 1375

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1376 1377
     * - encoding: unused.
     * - decoding: set by decoder 
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387
     */
    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

1388 1389 1390 1391
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1392 1393
     * - encoding: set by user.
     * - decoding: unused.
1394
     */
Z
Zdenek Kabelac 已提交
1395
    int me_range;
1396

M
Michael Niedermayer 已提交
1397 1398 1399 1400 1401 1402 1403 1404
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
    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;
1420 1421 1422 1423 1424 1425 1426 1427

    /**
     * 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;
1428
    
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439
    /**
     * 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;
1440 1441 1442 1443 1444 1445 1446

#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 已提交
1447 1448 1449 1450 1451 1452 1453
    /**
     * 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 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469
    
#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;
1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
    
    /**
     * 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 已提交
1481 1482 1483 1484 1485 1486
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
    
    /**
     * 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
1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510

    /**
     * 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;
1511
    
1512 1513 1514 1515 1516 1517 1518
    /**
     * 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 已提交
1519 1520 1521 1522 1523 1524 1525 1526

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1541 1542 1543 1544 1545 1546 1547

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1548 1549 1550 1551 1552 1553 1554

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1555
    
1556
    /**
1557 1558 1559 1560 1561
     * 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().
1562
     * - encoding: unused
1563
     * - decoding: set by lavc, user can override
1564
     */
1565
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586

    /**
     * number of bits which should be loaded into the rc buffer before decoding starts
     * - encoding: set by user.
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_threshold;

    /**
     * CODEC_FLAG2_*.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    int flags2;
1587 1588 1589 1590 1591 1592 1593

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604
    
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
     * - decoding: set by user
     */
    int antialias_algo;
#define FF_AA_AUTO    0
#define FF_AA_FASTINT 1 //not implemented yet
#define FF_AA_INT     2
#define FF_AA_FLOAT   3
M
Michael Niedermayer 已提交
1605 1606 1607 1608 1609 1610
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623

    /**
     * Thread count.
     * is used to decide how many independant tasks should be passed to execute()
     * - encoding: set by user
     * - decoding: set by user
     */
    int thread_count;
    
    /**
     * the codec may call this to execute several independant things. it will return only after
     * finishing all tasks, the user may replace this with some multithreaded implementation, the
     * default implementation will execute the parts serially
1624
     * @param count the number of things to execute
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636
     * - encoding: set by lavc, user can override
     * - decoding: set by lavc, user can override
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
    
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1637 1638

    /**
1639 1640
     * Motion estimation threshold. under which no motion estimation is 
     * performed, but instead the user specified motion vectors are used
1641 1642
     * 
     * - encoding: set by user
1643
     * - decoding: unused
1644
     */
M
Michael Niedermayer 已提交
1645
     int me_threshold;
1646 1647 1648 1649 1650 1651 1652

    /**
     * Macroblock threshold. under which the user specified macroblock types will be used
     * - encoding: set by user
     * - decoding: unused
     */
     int mb_threshold;
1653 1654

    /**
M
Michael Niedermayer 已提交
1655
     * precision of the intra dc coefficient - 8.
1656 1657 1658 1659
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
M
Michael Niedermayer 已提交
1660 1661 1662 1663 1664 1665 1666

    /**
     * noise vs. sse weight for the nsse comparsion function.
     * - encoding: set by user
     * - decoding: unused
     */
     int nsse_weight;
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680

    /**
     * number of macroblock rows at the top which are skiped.
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
     * number of macroblock rows at the bottom which are skiped.
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696

    /**
     * profile
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99

    /**
     * level
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
M
Michael Niedermayer 已提交
1697 1698 1699 1700 1701 1702 1703

    /**
     * low resolution decoding. 1-> 1/2 size, 2->1/4 size
     * - encoding: unused
     * - decoding: set by user
     */
     int lowres;
1704 1705

    /**
M
Michael Niedermayer 已提交
1706
     * bitsream width / height. may be different from width/height if lowres
1707 1708 1709 1710 1711
     * or other things are used
     * - encoding: unused
     * - decoding: set by user before init if known, codec should override / dynamically change if needed
     */
    int coded_width, coded_height;
M
Michael Niedermayer 已提交
1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725

    /**
     * frame skip threshold
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_factor;
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739

    /**
     * frame skip exponent
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
     * frame skip comparission function
     * - encoding: set by user.
     * - decoding: unused
     */
    int frame_skip_cmp;
F
Fabrice Bellard 已提交
1740 1741
} AVCodecContext;

1742

1743 1744 1745
/**
 * AVOption.
 */
1746 1747 1748
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
Z
Zdenek Kabelac 已提交
1749 1750
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1751 1752 1753 1754
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1755 1756 1757 1758 1759
#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
1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777
//#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 已提交
1778 1779 1780 1781 1782 1783 1784 1785 1786
/**
 * 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);


1787 1788 1789
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1790
typedef struct AVCodec {
1791
    const char *name;
Z
Zdenek Kabelac 已提交
1792
    enum CodecType type;
M
Michael Niedermayer 已提交
1793
    enum CodecID id;
F
Fabrice Bellard 已提交
1794 1795
    int priv_data_size;
    int (*init)(AVCodecContext *);
1796
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1797
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1798
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1799
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1800
    int capabilities;
1801
    const AVOption *options;
F
Fabrice Bellard 已提交
1802
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1803
    void (*flush)(AVCodecContext *);
Z
* const  
Zdenek Kabelac 已提交
1804
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
1805
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
F
Fabrice Bellard 已提交
1806 1807
} AVCodec;

1808
/**
1809 1810 1811
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1812
typedef struct AVPicture {
1813
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1814
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1815 1816
} AVPicture;

M
Mike Melanson 已提交
1817 1818 1819 1820 1821
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1822
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
1823
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
1824 1825 1826 1827 1828 1829
typedef struct AVPaletteControl {

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

1830 1831 1832 1833
    /* 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 */
1834
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
1835 1836 1837

} AVPaletteControl;

F
Fabrice Bellard 已提交
1838 1839
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1840
extern AVCodec mp3lame_encoder;
1841
extern AVCodec oggvorbis_encoder;
1842
extern AVCodec faac_encoder;
1843
extern AVCodec xvid_encoder;
F
Fabrice Bellard 已提交
1844
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1845
extern AVCodec mpeg2video_encoder;
1846
extern AVCodec h261_encoder;
F
Fabrice Bellard 已提交
1847 1848
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1849
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1850
extern AVCodec rv10_encoder;
M
Michael Niedermayer 已提交
1851
extern AVCodec rv20_encoder;
1852
extern AVCodec dvvideo_encoder;
F
Fabrice Bellard 已提交
1853
extern AVCodec mjpeg_encoder;
1854
extern AVCodec ljpeg_encoder;
1855
extern AVCodec png_encoder;
1856 1857 1858 1859 1860
extern AVCodec ppm_encoder;
extern AVCodec pgm_encoder;
extern AVCodec pgmyuv_encoder;
extern AVCodec pbm_encoder;
extern AVCodec pam_encoder;
F
Fabrice Bellard 已提交
1861
extern AVCodec mpeg4_encoder;
1862 1863 1864
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1865 1866
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1867
extern AVCodec huffyuv_encoder;
L
Loren Merritt 已提交
1868
extern AVCodec ffvhuff_encoder;
M
Michael Niedermayer 已提交
1869
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1870
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1871
extern AVCodec asv2_encoder;
M
Michael Niedermayer 已提交
1872
extern AVCodec vcr1_encoder;
1873
extern AVCodec ffv1_encoder;
1874
extern AVCodec snow_encoder;
1875
extern AVCodec mdec_encoder;
R
Roberto Togni 已提交
1876
extern AVCodec zlib_encoder;
1877 1878
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
1879
extern AVCodec svq1_encoder;
F
Fabrice Bellard 已提交
1880 1881

extern AVCodec h263_decoder;
1882
extern AVCodec h261_decoder;
F
Fabrice Bellard 已提交
1883
extern AVCodec mpeg4_decoder;
1884 1885 1886
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1887
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1888
extern AVCodec wmv2_decoder;
M
Michael Niedermayer 已提交
1889 1890
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
I
Ivan Kalvachev 已提交
1891
extern AVCodec mpegvideo_decoder;
I
Ivan Kalvachev 已提交
1892
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1893
extern AVCodec h263i_decoder;
1894
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1895
extern AVCodec rv10_decoder;
M
Michael Niedermayer 已提交
1896
extern AVCodec rv20_decoder;
1897 1898
extern AVCodec rv30_decoder;
extern AVCodec rv40_decoder;
N
Nick Kurshev 已提交
1899
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1900
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1901
extern AVCodec dvvideo_decoder;
F
Fabrice Bellard 已提交
1902 1903
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1904
extern AVCodec mjpeg_decoder;
1905
extern AVCodec mjpegb_decoder;
1906
extern AVCodec sp5x_decoder;
1907
extern AVCodec png_decoder;
1908
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1909
extern AVCodec mp3_decoder;
R
Roberto Togni 已提交
1910
extern AVCodec mp3adu_decoder;
1911 1912
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1913
extern AVCodec huffyuv_decoder;
L
Loren Merritt 已提交
1914
extern AVCodec ffvhuff_decoder;
M
Mark Hills 已提交
1915
extern AVCodec oggvorbis_decoder;
1916
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1917
extern AVCodec h264_decoder;
1918
extern AVCodec indeo3_decoder;
1919
extern AVCodec vp3_decoder;
1920
extern AVCodec theora_decoder;
1921
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1922
extern AVCodec amr_nb_encoder;
1923 1924
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
1925 1926
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1927
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1928
extern AVCodec asv2_decoder;
M
Michael Niedermayer 已提交
1929
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1930
extern AVCodec cljr_decoder;
1931
extern AVCodec ffv1_decoder;
1932
extern AVCodec snow_decoder;
M
Michael Niedermayer 已提交
1933
extern AVCodec fourxm_decoder;
1934
extern AVCodec mdec_decoder;
1935 1936
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1937
extern AVCodec xan_wc3_decoder;
1938 1939 1940 1941
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
M
Mike Melanson 已提交
1942
extern AVCodec vqa_decoder;
1943
extern AVCodec idcin_decoder;
R
Roberto Togni 已提交
1944
extern AVCodec eightbps_decoder;
M
Mike Melanson 已提交
1945
extern AVCodec smc_decoder;
M
Mike Melanson 已提交
1946
extern AVCodec flic_decoder;
1947 1948
extern AVCodec vmdvideo_decoder;
extern AVCodec vmdaudio_decoder;
1949
extern AVCodec truemotion1_decoder;
R
Roberto Togni 已提交
1950 1951
extern AVCodec mszh_decoder;
extern AVCodec zlib_decoder;
1952 1953
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1954 1955
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1956
extern AVCodec xan_dpcm_decoder;
1957
extern AVCodec sol_dpcm_decoder;
1958
extern AVCodec sonic_decoder;
1959
extern AVCodec qtrle_decoder;
M
Michael Niedermayer 已提交
1960
extern AVCodec flac_decoder;
1961
extern AVCodec tscc_decoder;
1962
extern AVCodec ulti_decoder;
1963
extern AVCodec qdraw_decoder;
1964
extern AVCodec xl_decoder;
1965
extern AVCodec qpeg_decoder;
F
Fabrice Bellard 已提交
1966

F
Fabrice Bellard 已提交
1967 1968 1969
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1970
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1971 1972 1973 1974 1975 1976 1977 1978 1979 1980

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

1981 1982 1983 1984
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1985 1986
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1987
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1988
PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
1989
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
M
Michael Niedermayer 已提交
1990
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1991 1992
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1993
PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
1994
PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
1995
PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
1996

F
Fabrice Bellard 已提交
1997 1998 1999
#undef PCM_CODEC

/* dummy raw video codec */
2000 2001
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
2002 2003 2004

/* the following codecs use external GPL libs */
extern AVCodec ac3_decoder;
2005
extern AVCodec dts_decoder;
F
Fabrice Bellard 已提交
2006 2007 2008 2009

/* resample.c */

struct ReSampleContext;
2010
struct AVResampleContext;
F
Fabrice Bellard 已提交
2011 2012 2013 2014 2015 2016 2017 2018

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

2019
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2020
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
M
Michael Niedermayer 已提交
2021
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2022
void av_resample_close(struct AVResampleContext *c);
2023

F
Fabrice Bellard 已提交
2024 2025 2026 2027 2028 2029 2030 2031
/* 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);
2032 2033 2034 2035

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2036 2037 2038 2039
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2040

F
Fabrice Bellard 已提交
2041
void img_resample(ImgReSampleContext *s, 
2042
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
2043 2044 2045

void img_resample_close(ImgReSampleContext *s);

D
Drew Hess 已提交
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059
/**
 * 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);

2060
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2061
                   int pix_fmt, int width, int height);
2062
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2063
                     unsigned char *dest, int dest_size);
2064
int avpicture_get_size(int pix_fmt, int width, int height);
2065 2066
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);
2067
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2068
enum PixelFormat avcodec_get_pix_fmt(const char* name);
M
Michael Niedermayer 已提交
2069
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2070

2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
#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 已提交
2083 2084
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2085 2086
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
F
Fabrice Bellard 已提交
2087

2088 2089
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
2090
                const AVPicture *src, int pix_fmt, 
2091 2092 2093
                int width, int height);

/* deinterlace a picture */
2094
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
2095 2096 2097 2098 2099 2100
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
2101
/* returns LIBAVCODEC_VERSION_INT constant */
2102
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
2103
/* returns LIBAVCODEC_BUILD constant */
2104
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
2105 2106 2107 2108
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
2109
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
2110 2111 2112 2113
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 已提交
2114
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
2115
AVCodecContext *avcodec_alloc_context(void);
F
Falk Hüffner 已提交
2116
void avcodec_get_frame_defaults(AVFrame *pic);
M
Michael Niedermayer 已提交
2117
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
2118

M
Michael Niedermayer 已提交
2119 2120
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
M
Michael Niedermayer 已提交
2121 2122
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2123
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
M
Michael Niedermayer 已提交
2124
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
M
cleanup  
Michael Niedermayer 已提交
2125

M
1l  
Michael Niedermayer 已提交
2126 2127 2128
int avcodec_thread_init(AVCodecContext *s, int thread_count);
void avcodec_thread_free(AVCodecContext *s);
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
M
Michael Niedermayer 已提交
2129
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2130 2131
//FIXME func typedef

M
Michael Niedermayer 已提交
2132 2133 2134 2135
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
2136
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
2137

2138
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
2139
                         int *frame_size_ptr,
2140
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
2141
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
2142
                         int *got_picture_ptr,
2143 2144
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
2145
                        int *data_size_ptr,
2146 2147
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
2148
                         const short *samples);
2149
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
2150
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
2151 2152 2153 2154

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
2156 2157
void avcodec_flush_buffers(AVCodecContext *avctx);

2158
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
2159 2160 2161 2162 2163 2164

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

2165 2166 2167 2168 2169 2170 2171 2172 2173
/**
 * 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);

/**
2174
 * rescale a 64bit integer with rounding to nearest.
2175 2176
 * a simple a*b/c isnt possible as it can overflow
 */
2177
int64_t av_rescale(int64_t a, int64_t b, int64_t c);
2178

2179 2180 2181 2182 2183
/**
 * rescale a 64bit integer with specified rounding.
 * a simple a*b/c isnt possible as it can overflow
 */
int64_t av_rescale_rnd(int64_t a, int64_t b, int64_t c, enum AVRounding);
2184

F
Fabrice Bellard 已提交
2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
/* 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 */
2196 2197 2198 2199 2200 2201
    int64_t pts;     /* pts of the current frame */
    int64_t dts;     /* dts of the current frame */

    /* private data */
    int64_t last_pts;
    int64_t last_dts;
M
Michael Niedermayer 已提交
2202
    int fetch_timestamp;
2203 2204 2205 2206 2207 2208

#define AV_PARSER_PTS_NB 4
    int cur_frame_start_index;
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
F
Fabrice Bellard 已提交
2209 2210 2211
} AVCodecParserContext;

typedef struct AVCodecParser {
M
Michael Niedermayer 已提交
2212
    int codec_ids[5]; /* several codec IDs are permitted */
F
Fabrice Bellard 已提交
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229
    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, 
2230 2231
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
F
Fabrice Bellard 已提交
2232 2233 2234 2235
void av_parser_close(AVCodecParserContext *s);

extern AVCodecParser mpegvideo_parser;
extern AVCodecParser mpeg4video_parser;
2236
extern AVCodecParser h261_parser;
F
Fabrice Bellard 已提交
2237 2238
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
M
Michael Niedermayer 已提交
2239
extern AVCodecParser mjpeg_parser;
M
Michael Niedermayer 已提交
2240
extern AVCodecParser pnm_parser;
F
Fabrice Bellard 已提交
2241 2242 2243
extern AVCodecParser mpegaudio_parser;
extern AVCodecParser ac3_parser;

F
Fabrice Bellard 已提交
2244
/* memory */
2245
void *av_malloc(unsigned int size);
2246
void *av_mallocz(unsigned int size);
2247
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
2248
void av_free(void *ptr);
2249
char *av_strdup(const char *s);
M
Michael Niedermayer 已提交
2250
void av_freep(void *ptr);
2251
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2252 2253
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2254
void av_free_static(void);
2255
void *av_mallocz_static(unsigned int size);
2256
void *av_realloc_static(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
2257

2258 2259 2260
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

2261 2262 2263
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2264 2265 2266 2267
/* av_log API */

#include <stdarg.h>

2268
#define AV_LOG_QUIET -1
2269 2270 2271 2272
#define AV_LOG_ERROR 0
#define AV_LOG_INFO 1
#define AV_LOG_DEBUG 2

2273
#ifdef __GNUC__
2274
extern void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2275 2276 2277 2278
#else
extern void av_log(void*, int level, const char *fmt, ...);
#endif

2279
extern void av_vlog(void*, int level, const char *fmt, va_list);
2280 2281
extern int av_log_get_level(void);
extern void av_log_set_level(int);
2282
extern void av_log_set_callback(void (*)(void*, int, const char*, va_list));
2283

2284
/* endian macros */
2285
#if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2286 2287 2288 2289 2290 2291 2292 2293 2294 2295
#define BE_16(x)  ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
#define BE_32(x)  ((((uint8_t*)(x))[0] << 24) | \
                   (((uint8_t*)(x))[1] << 16) | \
                   (((uint8_t*)(x))[2] << 8) | \
                    ((uint8_t*)(x))[3])
#define LE_16(x)  ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
#define LE_32(x)  ((((uint8_t*)(x))[3] << 24) | \
                   (((uint8_t*)(x))[2] << 16) | \
                   (((uint8_t*)(x))[1] << 8) | \
                    ((uint8_t*)(x))[0])
2296
#endif
2297

2298 2299 2300 2301
#ifdef __cplusplus
}
#endif

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