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

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


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

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

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

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

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

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

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

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

	/* AMR */
    CODEC_ID_AMR_NB,
115 116
    CODEC_ID_AMR_WB,

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

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

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

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

140
/**
M
Mike Melanson 已提交
141 142 143 144 145 146 147 148 149 150 151 152
 * 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
153 154 155 156
 * 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.
157
 */
F
Fabrice Bellard 已提交
158
enum PixelFormat {
M
Michael Niedermayer 已提交
159 160 161 162 163 164
    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 已提交
165
    PIX_FMT_RGBA32,    ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
M
Michael Niedermayer 已提交
166 167
    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)
168 169
    PIX_FMT_RGB565,    ///< always stored in cpu endianness 
    PIX_FMT_RGB555,    ///< always stored in cpu endianness, most significant bit to 1 
170
    PIX_FMT_GRAY8,
171 172 173
    PIX_FMT_MONOWHITE, ///< 0 is white 
    PIX_FMT_MONOBLACK, ///< 0 is black 
    PIX_FMT_PAL8,      ///< 8 bit with RGBA palette 
M
Michael Niedermayer 已提交
174 175 176
    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 已提交
177 178
    PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
    PIX_FMT_XVMC_MPEG2_IDCT,
179
    PIX_FMT_NB,
F
Fabrice Bellard 已提交
180 181
};

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

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

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

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

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

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

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

224

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

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

232
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
233
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
234 235
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
236
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
237
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
238 239
/* 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 */
240
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
241 242 243 244 245 246 247
#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 
248
                                            of only at frame boundaries */
249 250
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
251
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
252 253 254 255
#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) 
256
/* Fx : Flag for h263+ extra options */
M
Michael Niedermayer 已提交
257 258
#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
259
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
260
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
261
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
262
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
263 264 265 266 267 268 269 270 271
/* For advanced prediction mode, we reuse the 4MV flag */
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Deblocking filter internal loop
 * 		Slice structured
 * 		Reference Picture Selection
 * 		Independant Segment Decoding
 * 		Modified Quantization */
/* /Fx */
F
Fabrice Bellard 已提交
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 309 310 311 312
/**
 * 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 已提交
313
#define FF_COMMON_FRAME \
M
Michael Niedermayer 已提交
314 315 316 317 318 319
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
M
cleanup  
Michael Niedermayer 已提交
320 321 322
    uint8_t *data[4];\
    int linesize[4];\
    /**\
M
Michael Niedermayer 已提交
323
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
M
cleanup  
Michael Niedermayer 已提交
324
     * this isnt used by lavc unless the default get/release_buffer() is used\
325 326
     * - encoding: \
     * - decoding: \
M
cleanup  
Michael Niedermayer 已提交
327 328 329 330
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
331 332
     * - encoding: set by lavc\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
333 334 335 336
     */\
    int key_frame;\
\
    /**\
M
Michael Niedermayer 已提交
337
     * picture type of the frame, see ?_TYPE below.\
338 339
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
340 341 342 343 344 345
     */\
    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\
346 347
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
348
     */\
349
    int64_t pts;\
M
cleanup  
Michael Niedermayer 已提交
350 351 352
\
    /**\
     * picture number in bitstream order.\
353 354
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
355 356 357 358
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
359 360
     * - encoding: set by\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
361 362 363 364
     */\
    int display_picture_number;\
\
    /**\
365
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
366 367
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
368
     */\
369
    int quality; \
M
cleanup  
Michael Niedermayer 已提交
370 371 372
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
373
     * set to INT_MAX if the buffer has not been used yet \
374 375
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
M
cleanup  
Michael Niedermayer 已提交
376 377 378 379 380
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
381 382
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
M
cleanup  
Michael Niedermayer 已提交
383 384 385 386 387
     */\
    int reference;\
\
    /**\
     * QP table\
388 389
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
390 391 392 393
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
394 395
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
396 397 398 399 400 401
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
402 403
     * - encoding: unused\
     * - decoding: set by lavc\
M
cleanup  
Michael Niedermayer 已提交
404 405 406 407 408
     */\
    uint8_t *mbskip_table;\
\
    /**\
     * for some private data of the user\
409 410
     * - encoding: unused\
     * - decoding: set by user\
M
cleanup  
Michael Niedermayer 已提交
411 412
     */\
    void *opaque;\
413 414 415
\
    /**\
     * error\
416 417
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
418 419
     */\
    uint64_t error[4];\
M
Michael Niedermayer 已提交
420 421 422
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
423 424
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
F
Falk Hüffner 已提交
425
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
M
Michael Niedermayer 已提交
426 427
     */\
    int type;\
428 429 430 431
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
432 433
     * - encoding: unused\
     * - decoding: set by lavc\
434
     */\
M
Michael Niedermayer 已提交
435 436 437 438 439 440
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
441 442 443 444 445 446 447 448 449
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
450
     * if the content is interlaced, is top field displayed first.\
451
     * - encoding: set by user\
452
     * - decoding: set by lavc\
453
     */\
454
    int top_field_first;\
455 456 457 458 459 460 461
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
462 463 464 465 466 467 468
    \
    /**\
     * 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;\
469 470 471 472 473 474 475
    \
    /**\
     * Codec suggestion on buffer type if != 0\
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
     */\
    int buffer_hints;\
476

M
Michael Niedermayer 已提交
477 478
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
M
Michael Niedermayer 已提交
479 480

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
481 482 483
#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 已提交
484

M
cleanup  
Michael Niedermayer 已提交
485

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

493 494 495 496 497
#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 已提交
498 499 500
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
501 502 503
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
504

505
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
506 507 508 509

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

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

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

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

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

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

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

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

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

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

    /**
653 654 655
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
656 657 658 659
     */
    int qmax;

    /**
660 661 662
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
663 664 665 666
     */
    int max_qdiff;

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

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

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

696
    /* The following data is for RTP friendly coding */
697
    /* By now only H.263/H.263+/MPEG4 coder honours this   */
698 699 700 701 702 703 704 705 706 707
    int rtp_mode;   /* 1 for activate RTP friendly-mode           */
                    /* highers numbers represent more error-prone */
                    /* enviroments, by now just "1" exist         */
    
    int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
                            /* do it's best to deliver a chunk with size    */
                            /* below rtp_payload_size, the chunk will start */
                            /* with a start code on some codecs like H.263  */
                            /* This doesn't take account of any particular  */
                            /* headers inside the transmited RTP payload    */
708 709 710 711 712 713 714 715

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
1082 1083 1084
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1085 1086 1087 1088 1089 1090 1091 1092
     */
    int debug;
#define FF_DEBUG_PICT_INFO 1
#define FF_DEBUG_RC        2
#define FF_DEBUG_BITSTREAM 4
#define FF_DEBUG_MB_TYPE   8
#define FF_DEBUG_QP        16
#define FF_DEBUG_MV        32
M
Michael Niedermayer 已提交
1093 1094 1095 1096
#define FF_DEBUG_VIS_MV    0x00000040
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1097
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1098
#define FF_DEBUG_MMCO      0x00000800
1099
#define FF_DEBUG_BUGS      0x00001000
1100 1101
    
    /**
1102 1103 1104
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1105 1106
     */
    uint64_t error[4];
M
Michael Niedermayer 已提交
1107 1108
    
    /**
1109 1110 1111
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1112 1113 1114 1115
     */
    int mb_qmin;

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

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

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

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

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

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

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

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

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

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

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

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

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

    /**
     * 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;
1343
    
1344 1345 1346 1347 1348 1349 1350
    /**
     * 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 已提交
1351 1352 1353 1354 1355 1356 1357 1358

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

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1373 1374 1375 1376 1377 1378 1379

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

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1387
    
1388
    /**
1389 1390 1391 1392 1393
     * 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().
1394
     * - encoding: unused
1395
     * - decoding: set by lavc, user can override
1396
     */
1397
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1398
    
F
Fabrice Bellard 已提交
1399 1400
} AVCodecContext;

1401

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


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

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

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

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

1487 1488 1489 1490
    /* 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 */
1491
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
1492 1493 1494

} AVPaletteControl;

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

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

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

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

1602 1603 1604 1605
/* adpcm codecs */

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

F
Fabrice Bellard 已提交
1614 1615 1616
#undef PCM_CODEC

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

/* 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);
1642 1643 1644 1645 1646 1647

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

F
Fabrice Bellard 已提交
1648
void img_resample(ImgReSampleContext *s, 
1649
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
1650 1651 1652

void img_resample_close(ImgReSampleContext *s);

D
Drew Hess 已提交
1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666
/**
 * 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);

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

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

1693 1694
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
1695
                const AVPicture *src, int pix_fmt, 
1696 1697 1698
                int width, int height);

/* deinterlace a picture */
1699
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
1700 1701 1702 1703 1704 1705
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
1706
/* returns LIBAVCODEC_VERSION_INT constant */
1707
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
1708
/* returns LIBAVCODEC_BUILD constant */
1709
unsigned avcodec_build(void);
F
Fabrice Bellard 已提交
1710 1711 1712 1713
void avcodec_init(void);

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

M
Michael Niedermayer 已提交
1723 1724
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1725
void avcodec_default_free_buffers(AVCodecContext *s);
M
cleanup  
Michael Niedermayer 已提交
1726

M
Michael Niedermayer 已提交
1727 1728 1729 1730
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
F
Fabrice Bellard 已提交
1731
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
1732

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

int avcodec_close(AVCodecContext *avctx);

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

M
Michael Niedermayer 已提交
1751 1752
void avcodec_flush_buffers(AVCodecContext *avctx);

1753
/* misc usefull functions */
M
cleanup  
Michael Niedermayer 已提交
1754 1755 1756 1757 1758 1759

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

1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
/**
 * 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);
1773 1774


1775 1776 1777 1778 1779 1780 1781
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

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

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

extern AVCodecParser *av_first_parser;

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

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

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

1910 1911 1912
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

1913 1914 1915
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937
/* 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

1938 1939 1940 1941
#ifdef __cplusplus
}
#endif

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