avcodec.h 59.2 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       4697
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
M
Michael Niedermayer 已提交
266
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000 
267 268 269
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Reference Picture Selection
M
Michael Niedermayer 已提交
270
 * 		Independant Segment Decoding */
271
/* /Fx */
F
Fabrice Bellard 已提交
272 273
/* codec capabilities */

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

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
//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, ...)

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

M
Michael Niedermayer 已提交
523 524
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
525 526

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
527 528 529
#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 已提交
530

M
cleanup  
Michael Niedermayer 已提交
531

532 533 534 535
#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 已提交
536 537
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
538

539 540 541 542 543
#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 已提交
544 545 546
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
547 548 549
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
550

551
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
552 553 554 555

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
556
typedef struct AVCodecContext {
557
    /**
558 559 560
     * 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 
561
     */
F
Fabrice Bellard 已提交
562
    int bit_rate;
563 564

    /**
565
     * number of bits the bitstream is allowed to diverge from the reference.
566
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
567 568
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
569 570 571 572
     */
    int bit_rate_tolerance; 

    /**
573 574 575
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
576
     */
F
Fabrice Bellard 已提交
577
    int flags;
578 579 580

    /**
     * some codecs needs additionnal format info. It is stored here
581 582
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
583 584 585 586
     */
    int sub_id;

    /**
587 588 589
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
590 591 592 593
     */
    int me_method;

    /**
594
     * some codecs need / can use extra-data like huffman tables.
595 596
     * mjpeg: huffman tables
     * rv10: additional flags
597
     * mpeg4: global headers (they can be in the bitstream or here)
598 599
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
600
     */
601 602 603
    void *extradata;
    int extradata_size;
    
F
Fabrice Bellard 已提交
604
    /* video only */
605
    /**
606
     * frames per sec multiplied by frame_rate_base.
607
     * for variable fps this is the precission, so if the timestamps 
608
     * can be specified in msec precssion then this is 1000*frame_rate_base
609 610
     * - encoding: MUST be set by user
     * - decoding: set by lavc. 0 or the frame_rate if available
611 612
     */
    int frame_rate;
613
    
614
    /**
615 616
     * width / height.
     * - encoding: MUST be set by user. 
M
Michael Niedermayer 已提交
617
     * - decoding: set by user if known, codec should override / dynamically change if needed
618
     */
F
Fabrice Bellard 已提交
619
    int width, height;
620
    
M
Michael Niedermayer 已提交
621 622 623 624 625
#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
626
#define FF_ASPECT_EXTENDED 15
627 628

    /**
629 630 631
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
632 633 634 635
     */
    int gop_size;

    /**
636
     * pixel format, see PIX_FMT_xxx.
637 638 639 640
     * - 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.
641
     * - decoding: set by lavc.
642
     */
643
    enum PixelFormat pix_fmt;
644 645 646 647 648 649 650 651 652
 
    /**
     * 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;
       
653 654 655 656 657
    /**
     * 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
658 659
     * - encoding: unused
     * - decoding: set by user.
660 661 662 663
     * @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
664
     */
F
Fabrice Bellard 已提交
665
    void (*draw_horiz_band)(struct AVCodecContext *s,
666
                            const AVFrame *src, int offset[4],
667
                            int y, int type, int height);
F
Fabrice Bellard 已提交
668

F
Fabrice Bellard 已提交
669
    /* audio only */
670
    int sample_rate; ///< samples per sec 
F
Fabrice Bellard 已提交
671
    int channels;
672
    int sample_fmt;  ///< sample format, currenly unused 
F
Fabrice Bellard 已提交
673 674

    /* the following data should not be initialized */
675 676 677
    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 已提交
678
    
679 680
    /**
     * number of frames the decoded output will be delayed relative to 
681 682 683
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
684 685
     */
    int delay;
M
Michael Niedermayer 已提交
686
    
687 688 689
    /* - 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) 
690 691
    
    /**
692 693 694
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
695 696 697 698
     */
    int qmin;

    /**
699 700 701
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
702 703 704 705
     */
    int qmax;

    /**
706 707 708
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
709 710 711 712
     */
    int max_qdiff;

    /**
713
     * maximum number of b frames between non b frames.
714
     * note: the output will be delayed by max_b_frames+1 relative to the input
715 716
     * - encoding: set by user.
     * - decoding: unused
717 718 719 720
     */
    int max_b_frames;

    /**
721 722 723
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
724 725 726 727 728
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
729
    int b_frame_strategy;
730

731
    /**
732 733 734
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
735 736
     */
    int hurry_up;
737
    
F
Fabrice Bellard 已提交
738
    struct AVCodec *codec;
739
    
F
Fabrice Bellard 已提交
740 741
    void *priv_data;

M
Michael Niedermayer 已提交
742 743
    /* unused, FIXME remove*/
    int rtp_mode;
744 745 746 747 748 749 750
    
    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    */
751 752 753 754 755 756 757 758

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

759 760 761 762 763 764 765 766
    /* 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;
767 768 769
    int misc_bits;
    
    /**
770 771
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
772
     * - decoding: unused
773
     */
774
    int frame_bits;
775

776
    /**
777 778 779
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
780 781 782
     */
    void *opaque;

F
Fabrice Bellard 已提交
783
    char codec_name[32];
784 785
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
786 787 788 789
    
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
790
     * - encoding: set by user, if not then the default based on codec_id will be used
791 792 793
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
794
    
795
    /**
796 797 798
     * workaround bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: unused
     * - decoding: set by user
799 800
     */
    int workaround_bugs;
801
#define FF_BUG_AUTODETECT       1  ///< autodetection
802 803 804 805
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
806
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
M
Michael Niedermayer 已提交
807
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
808
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
809
#define FF_BUG_QPEL_CHROMA2     256
810
#define FF_BUG_DIRECT_BLOCKSIZE 512
811
#define FF_BUG_EDGE             1024
812 813
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
        
814
    /**
815 816 817
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
818
     */
819
    int luma_elim_threshold;
820 821
    
    /**
822 823 824
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
825
     */
826
    int chroma_elim_threshold;
827 828
    
    /**
829 830 831
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
832 833 834 835
     */
    int strict_std_compliance;
    
    /**
836
     * qscale offset between ip and b frames.
837 838
     * 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)
839 840
     * - encoding: set by user.
     * - decoding: unused
841 842 843 844
     */
    float b_quant_offset;
    
    /**
845
     * error resilience higher values will detect more errors but may missdetect
846 847 848
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
849
     */
850
    int error_resilience;
851 852 853 854
#define FF_ER_CAREFULL        1
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
855
    
856
    /**
M
cleanup  
Michael Niedermayer 已提交
857 858
     * 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
859
     * width and height should be rounded up to the next multiple of 16
860 861
     * - encoding: unused
     * - decoding: set by lavc, user can override
862
     */
M
Michael Niedermayer 已提交
863
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
864 865
    
    /**
M
cleanup  
Michael Niedermayer 已提交
866 867 868
     * 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
869 870
     * - encoding: unused
     * - decoding: set by lavc, user can override
871
     */
M
Michael Niedermayer 已提交
872
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
873

874
    /**
875 876 877
     * is 1 if the decoded stream contains b frames, 0 otherwise.
     * - encoding: unused
     * - decoding: set by lavc
878 879 880
     */
    int has_b_frames;
    
881
    int block_align; ///< used by some WAV based audio codecs
M
Michael Niedermayer 已提交
882
    
883
    int parse_only; /* - decoding only: if true, only parsing is done
884 885
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
M
Michael Niedermayer 已提交
886
    
887
    /**
888
     * 0-> h263 quant 1-> mpeg quant.
889 890
     * - encoding: set by user.
     * - decoding: unused
891 892
     */
    int mpeg_quant;
M
Michael Niedermayer 已提交
893
    
894
    /**
895 896 897
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
898
     */
899
    char *stats_out;
900 901 902 903
    
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
904 905
     * - encoding: allocated/set/freed by user
     * - decoding: unused
906 907 908 909
     */
    char *stats_in;
    
    /**
910
     * ratecontrol qmin qmax limiting method.
911
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
912 913
     * - encoding: set by user.
     * - decoding: unused
914
     */
M
Michael Niedermayer 已提交
915
    float rc_qsquish;
916

M
Michael Niedermayer 已提交
917 918
    float rc_qmod_amp;
    int rc_qmod_freq;
919 920
    
    /**
921 922 923
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
924
     */
M
Michael Niedermayer 已提交
925 926
    RcOverride *rc_override;
    int rc_override_count;
927 928
    
    /**
929 930 931
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
932
     */
M
Michael Niedermayer 已提交
933
    char *rc_eq;
934 935
    
    /**
936 937 938
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
939
     */
M
Michael Niedermayer 已提交
940
    int rc_max_rate;
941 942
    
    /**
943 944 945
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
946
     */
M
Michael Niedermayer 已提交
947
    int rc_min_rate;
948 949
    
    /**
950 951 952
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
953
     */
M
Michael Niedermayer 已提交
954 955
    int rc_buffer_size;
    float rc_buffer_aggressivity;
956 957

    /**
958 959 960
     * qscale factor between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
961 962 963 964
     */
    float i_quant_factor;
    
    /**
965
     * qscale offset between p and i frames.
966 967
     * 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)
968 969
     * - encoding: set by user.
     * - decoding: unused
970 971 972 973
     */
    float i_quant_offset;
    
    /**
974 975 976
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
977
     */
M
Michael Niedermayer 已提交
978
    float rc_initial_cplx;
979

980
    /**
981 982 983
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
984
     */
985
    int dct_algo;
986
#define FF_DCT_AUTO    0
987
#define FF_DCT_FASTINT 1
988 989 990
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
991
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
992
#define FF_DCT_FAAN    6
993 994
    
    /**
995 996 997
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
998 999 1000 1001
     */
    float lumi_masking;
    
    /**
1002 1003 1004
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1005 1006 1007 1008
     */
    float temporal_cplx_masking;
    
    /**
1009 1010 1011
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1012 1013 1014 1015
     */
    float spatial_cplx_masking;
    
    /**
1016 1017 1018
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1019 1020
     */
    float p_masking;
1021

1022
    /**
1023 1024 1025
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1026 1027
     */
    float dark_masking;
1028
    
1029 1030 1031 1032
    
    /* for binary compatibility */
    int unused;
    
1033
    /**
1034 1035 1036
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
     */
    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
1047
#define FF_IDCT_ALTIVEC      8
1048
#define FF_IDCT_SH4          9
1049
#define FF_IDCT_SIMPLEARM    10
1050

1051
    /**
1052 1053 1054
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1055 1056 1057
     */
    int slice_count;
    /**
1058 1059 1060
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1061 1062 1063
     */
    int *slice_offset;

1064
    /**
1065 1066 1067
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1068 1069 1070 1071 1072
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1073
    /**
Z
Zdenek Kabelac 已提交
1074
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1075
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
     *
     * 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 已提交
1091 1092

    /**
1093 1094 1095
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
1096 1097 1098 1099
     */
     int bits_per_sample;
    
    /**
1100 1101 1102
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1103 1104 1105 1106 1107
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
M
Michael Niedermayer 已提交
1108 1109
    
    /**
M
Michael Niedermayer 已提交
1110
     * sample aspect ratio (0 if unknown).
1111
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1112 1113
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
1114
     */
M
Michael Niedermayer 已提交
1115
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1116 1117

    /**
1118 1119 1120
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
1121
     */
M
Michael Niedermayer 已提交
1122
    AVFrame *coded_frame;
1123 1124

    /**
1125 1126 1127
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1128 1129 1130 1131 1132 1133 1134 1135
     */
    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
1136
//#define FF_DEBUG_VIS_MV    0x00000040
M
Michael Niedermayer 已提交
1137 1138 1139
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1140
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1141
#define FF_DEBUG_MMCO      0x00000800
1142
#define FF_DEBUG_BUGS      0x00001000
M
Michael Niedermayer 已提交
1143 1144
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1145
    
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
    /**
     * 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

1156
    /**
1157 1158 1159
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1160 1161
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
1162 1163
    
    /**
1164 1165 1166
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1167 1168 1169 1170
     */
    int mb_qmin;

    /**
1171 1172 1173
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1174 1175
     */
    int mb_qmax;
M
Michael Niedermayer 已提交
1176 1177
    
    /**
1178 1179 1180
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1181 1182 1183
     */
    int me_cmp;
    /**
1184 1185 1186
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1187 1188 1189
     */
    int me_sub_cmp;
    /**
1190 1191 1192
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
     */
    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
    
    /**
1206 1207 1208
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1209 1210
     */
    int dia_size;
1211 1212

    /**
1213 1214 1215
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1216 1217
     */
    int last_predictor_count;
1218

M
Michael Niedermayer 已提交
1219
    /**
1220 1221 1222
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1223 1224
     */
    int pre_me;
1225

1226
    /**
1227 1228 1229
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1230 1231
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1232

1233
    /**
1234 1235 1236
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1237 1238 1239
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1240
    /**
1241 1242 1243
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1244 1245 1246
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1247
    /**
1248
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1249 1250 1251 1252
     * @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
1253 1254
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1255 1256
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1257 1258 1259 1260 1261 1262

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1263 1264
     * - encoding: unused.
     * - decoding: set by decoder 
1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
     */
    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

1275 1276 1277 1278
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1279 1280
     * - encoding: set by user.
     * - decoding: unused.
1281
     */
Z
Zdenek Kabelac 已提交
1282
    int me_range;
1283

M
Michael Niedermayer 已提交
1284 1285 1286 1287 1288 1289 1290 1291
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
    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;
1307 1308 1309 1310 1311 1312 1313 1314

    /**
     * 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;
1315
    
1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
    /**
     * 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;
1327 1328 1329 1330 1331 1332 1333

#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 已提交
1334 1335 1336 1337 1338 1339 1340
    /**
     * 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 已提交
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
    
#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;
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
    
    /**
     * 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 已提交
1368 1369 1370 1371 1372 1373
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
    
    /**
     * 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
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397

    /**
     * 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;
1398
    
1399 1400 1401 1402 1403 1404 1405
    /**
     * 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 已提交
1406 1407 1408 1409 1410 1411 1412 1413

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1428 1429 1430 1431 1432 1433 1434

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1435 1436 1437 1438 1439 1440 1441

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1442
    
1443
    /**
1444 1445 1446 1447 1448
     * 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().
1449
     * - encoding: unused
1450
     * - decoding: set by lavc, user can override
1451
     */
1452
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473

    /**
     * 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;
1474 1475 1476 1477 1478 1479 1480

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
F
Fabrice Bellard 已提交
1481 1482
} AVCodecContext;

1483

1484 1485 1486
/**
 * AVOption.
 */
1487 1488 1489
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
Z
Zdenek Kabelac 已提交
1490 1491
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1492 1493 1494 1495
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1496 1497 1498 1499 1500
#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
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
//#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 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527
/**
 * 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);


1528 1529 1530
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
1531
typedef struct AVCodec {
1532
    const char *name;
Z
Zdenek Kabelac 已提交
1533
    enum CodecType type;
F
Fabrice Bellard 已提交
1534 1535 1536
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1537
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
1538
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
1539
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1540
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
1541
    int capabilities;
1542
    const AVOption *options;
F
Fabrice Bellard 已提交
1543
    struct AVCodec *next;
M
Michael Niedermayer 已提交
1544
    void (*flush)(AVCodecContext *);
F
Fabrice Bellard 已提交
1545 1546
} AVCodec;

1547
/**
1548 1549 1550
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
1551
typedef struct AVPicture {
1552
    uint8_t *data[4];
M
Michael Niedermayer 已提交
1553
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
1554 1555
} AVPicture;

M
Mike Melanson 已提交
1556 1557 1558 1559 1560
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1561
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
1562
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
1563 1564 1565 1566 1567 1568
typedef struct AVPaletteControl {

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

1569 1570 1571 1572
    /* 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 */
1573
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
1574 1575 1576

} AVPaletteControl;

F
Fabrice Bellard 已提交
1577 1578
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1579
extern AVCodec mp3lame_encoder;
1580
extern AVCodec oggvorbis_encoder;
1581
extern AVCodec faac_encoder;
F
Fabrice Bellard 已提交
1582
extern AVCodec mpeg1video_encoder;
M
Michael Niedermayer 已提交
1583
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
1584 1585
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1586
extern AVCodec flv_encoder;
F
Fabrice Bellard 已提交
1587
extern AVCodec rv10_encoder;
M
Michael Niedermayer 已提交
1588
extern AVCodec rv20_encoder;
F
Fabrice Bellard 已提交
1589
extern AVCodec mjpeg_encoder;
1590
extern AVCodec ljpeg_encoder;
F
Fabrice Bellard 已提交
1591
extern AVCodec mpeg4_encoder;
1592 1593 1594
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
M
Michael Niedermayer 已提交
1595 1596
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
M
huffyuv  
Michael Niedermayer 已提交
1597
extern AVCodec huffyuv_encoder;
M
Michael Niedermayer 已提交
1598
extern AVCodec h264_encoder;
M
Michael Niedermayer 已提交
1599
extern AVCodec asv1_encoder;
M
Michael Niedermayer 已提交
1600
extern AVCodec asv2_encoder;
M
Michael Niedermayer 已提交
1601
extern AVCodec vcr1_encoder;
1602
extern AVCodec ffv1_encoder;
1603
extern AVCodec mdec_encoder;
F
Fabrice Bellard 已提交
1604 1605

extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
1606
extern AVCodec mpeg4_decoder;
1607 1608 1609
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1610
extern AVCodec wmv1_decoder;
M
Michael Niedermayer 已提交
1611
extern AVCodec wmv2_decoder;
M
Michael Niedermayer 已提交
1612 1613
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
I
Ivan Kalvachev 已提交
1614
extern AVCodec mpegvideo_decoder;
I
Ivan Kalvachev 已提交
1615
extern AVCodec mpeg_xvmc_decoder;
F
Fabrice Bellard 已提交
1616
extern AVCodec h263i_decoder;
1617
extern AVCodec flv_decoder;
F
Fabrice Bellard 已提交
1618
extern AVCodec rv10_decoder;
M
Michael Niedermayer 已提交
1619
extern AVCodec rv20_decoder;
N
Nick Kurshev 已提交
1620
extern AVCodec svq1_decoder;
M
Michael Niedermayer 已提交
1621
extern AVCodec svq3_decoder;
F
Fabrice Bellard 已提交
1622
extern AVCodec dvvideo_decoder;
F
Fabrice Bellard 已提交
1623 1624
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
F
Fabrice Bellard 已提交
1625
extern AVCodec mjpeg_decoder;
1626
extern AVCodec mjpegb_decoder;
1627
extern AVCodec sp5x_decoder;
1628
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
1629
extern AVCodec mp3_decoder;
1630 1631
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
M
huffyuv  
Michael Niedermayer 已提交
1632
extern AVCodec huffyuv_decoder;
M
Mark Hills 已提交
1633
extern AVCodec oggvorbis_decoder;
1634
extern AVCodec cyuv_decoder;
M
Michael Niedermayer 已提交
1635
extern AVCodec h264_decoder;
1636
extern AVCodec indeo3_decoder;
1637
extern AVCodec vp3_decoder;
1638
extern AVCodec theora_decoder;
1639
extern AVCodec amr_nb_decoder;
Z
Zdenek Kabelac 已提交
1640
extern AVCodec amr_nb_encoder;
1641 1642
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
1643 1644
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
M
Michael Niedermayer 已提交
1645
extern AVCodec asv1_decoder;
M
Michael Niedermayer 已提交
1646
extern AVCodec asv2_decoder;
M
Michael Niedermayer 已提交
1647
extern AVCodec vcr1_decoder;
A
Alex Beregszaszi 已提交
1648
extern AVCodec cljr_decoder;
1649
extern AVCodec ffv1_decoder;
M
Michael Niedermayer 已提交
1650
extern AVCodec fourxm_decoder;
1651
extern AVCodec mdec_decoder;
1652 1653
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1654
extern AVCodec xan_wc3_decoder;
1655 1656 1657 1658
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
M
Mike Melanson 已提交
1659
extern AVCodec vqa_decoder;
1660
extern AVCodec idcin_decoder;
R
Roberto Togni 已提交
1661
extern AVCodec eightbps_decoder;
M
Mike Melanson 已提交
1662
extern AVCodec smc_decoder;
M
Mike Melanson 已提交
1663
extern AVCodec flic_decoder;
1664
extern AVCodec truemotion1_decoder;
1665 1666
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1667 1668
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1669
extern AVCodec xan_dpcm_decoder;
F
Fabrice Bellard 已提交
1670

F
Fabrice Bellard 已提交
1671 1672 1673
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1674
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
1675 1676 1677 1678 1679 1680 1681 1682 1683 1684

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

1685 1686 1687 1688
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1689 1690
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1691
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1692
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
M
Michael Niedermayer 已提交
1693
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1694 1695
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1696

F
Fabrice Bellard 已提交
1697 1698 1699
#undef PCM_CODEC

/* dummy raw video codec */
1700 1701
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
F
Fabrice Bellard 已提交
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724

/* 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);
1725 1726 1727 1728 1729 1730

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

F
Fabrice Bellard 已提交
1731
void img_resample(ImgReSampleContext *s, 
1732
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
1733 1734 1735

void img_resample_close(ImgReSampleContext *s);

D
Drew Hess 已提交
1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
/**
 * 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);

1750
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1751
                   int pix_fmt, int width, int height);
1752
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
1753
                     unsigned char *dest, int dest_size);
1754
int avpicture_get_size(int pix_fmt, int width, int height);
1755 1756
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);
1757
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1758

1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770
#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 已提交
1771 1772
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
1773 1774
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
F
Fabrice Bellard 已提交
1775

1776 1777
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
1778
                const AVPicture *src, int pix_fmt, 
1779 1780 1781
                int width, int height);

/* deinterlace a picture */
1782
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
1783 1784 1785 1786 1787 1788
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1789
/* returns LIBAVCODEC_VERSION_INT constant */
1790
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1791
/* returns LIBAVCODEC_BUILD constant */
1792
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1793 1794 1795 1796
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1797
AVCodec *avcodec_find_encoder_by_name(const char *name);
F
Fabrice Bellard 已提交
1798 1799 1800 1801
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 已提交
1802
void avcodec_get_context_defaults(AVCodecContext *s);
F
Falk Hüffner 已提交
1803
AVCodecContext *avcodec_alloc_context(void);
M
Michael Niedermayer 已提交
1804
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
1805

M
Michael Niedermayer 已提交
1806 1807
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1808
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1809

M
Michael Niedermayer 已提交
1810 1811 1812 1813
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1814
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1815

1816
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
F
Fabrice Bellard 已提交
1817
                         int *frame_size_ptr,
1818
                         uint8_t *buf, int buf_size);
M
Michael Niedermayer 已提交
1819
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
F
Fabrice Bellard 已提交
1820
                         int *got_picture_ptr,
1821 1822
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1823
                        int *data_size_ptr,
1824 1825
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
F
Fabrice Bellard 已提交
1826
                         const short *samples);
1827
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
M
Michael Niedermayer 已提交
1828
                         const AVFrame *pict);
F
Fabrice Bellard 已提交
1829 1830 1831 1832

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
1834 1835
void avcodec_flush_buffers(AVCodecContext *avctx);

1836
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1837 1838 1839 1840 1841 1842

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

1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855
/**
 * 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);
1856 1857


1858 1859 1860 1861 1862 1863 1864
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1865
    /// compressed size used from given memory buffer
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 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
    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 已提交
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944
/* 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 */
1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956
    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;

#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 已提交
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
} 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, 
1978 1979
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
F
Fabrice Bellard 已提交
1980 1981 1982 1983 1984 1985 1986 1987 1988
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 已提交
1989
/* memory */
1990
void *av_malloc(unsigned int size);
1991
void *av_mallocz(unsigned int size);
1992
void *av_realloc(void *ptr, unsigned int size);
F
Fabrice Bellard 已提交
1993
void av_free(void *ptr);
1994
char *av_strdup(const char *s);
F
Fabrice Bellard 已提交
1995 1996
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
1997
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1998 1999
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2000
void av_free_static(void);
2001 2002
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
F
Fabrice Bellard 已提交
2003

2004 2005 2006
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

2007 2008 2009
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
/* 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

2032 2033 2034 2035
#ifdef __cplusplus
}
#endif

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