avcodec.h 60.1 KB
Newer Older
Fabrice Bellard's avatar
Fabrice Bellard committed
1 2 3
#ifndef AVCODEC_H
#define AVCODEC_H

4 5
/**
 * @file avcodec.h
Michael Niedermayer's avatar
Michael Niedermayer committed
6
 * external api header.
7 8 9
 */


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

Fabrice Bellard's avatar
Fabrice Bellard committed
14
#include "common.h"
Michael Niedermayer's avatar
Michael Niedermayer committed
15
#include "rational.h"
16
#include <sys/types.h> /* size_t */
Fabrice Bellard's avatar
Fabrice Bellard committed
17

18 19
#define FFMPEG_VERSION_INT     0x000408
#define FFMPEG_VERSION         "0.4.8"
20
#define LIBAVCODEC_BUILD       4699
21

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)
Alex Beregszaszi's avatar
Alex Beregszaszi committed
28

Fabrice Bellard's avatar
Fabrice Bellard committed
29 30 31
enum CodecID {
    CODEC_ID_NONE, 
    CODEC_ID_MPEG1VIDEO,
32
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
Ivan Kalvachev's avatar
Ivan Kalvachev committed
33
    CODEC_ID_MPEG2VIDEO_XVMC,
Fabrice Bellard's avatar
Fabrice Bellard committed
34 35
    CODEC_ID_H263,
    CODEC_ID_RV10,
Michael Niedermayer's avatar
Michael Niedermayer committed
36
    CODEC_ID_RV20,
Fabrice Bellard's avatar
Fabrice Bellard committed
37
    CODEC_ID_MP2,
38
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
39
    CODEC_ID_VORBIS,
Fabrice Bellard's avatar
Fabrice Bellard committed
40 41
    CODEC_ID_AC3,
    CODEC_ID_MJPEG,
42
    CODEC_ID_MJPEGB,
43
    CODEC_ID_LJPEG,
44
    CODEC_ID_SP5X,
45
    CODEC_ID_MPEG4,
Fabrice Bellard's avatar
Fabrice Bellard committed
46
    CODEC_ID_RAWVIDEO,
47 48 49
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
50
    CODEC_ID_WMV1,
51
    CODEC_ID_WMV2,
Fabrice Bellard's avatar
Fabrice Bellard committed
52 53
    CODEC_ID_H263P,
    CODEC_ID_H263I,
54
    CODEC_ID_FLV1,
Nick Kurshev's avatar
Nick Kurshev committed
55
    CODEC_ID_SVQ1,
56
    CODEC_ID_SVQ3,
Fabrice Bellard's avatar
Fabrice Bellard committed
57 58
    CODEC_ID_DVVIDEO,
    CODEC_ID_DVAUDIO,
Fabrice Bellard's avatar
Fabrice Bellard committed
59 60
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
61 62
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
Michael Niedermayer's avatar
Michael Niedermayer committed
63
    CODEC_ID_HUFFYUV,
64
    CODEC_ID_CYUV,
65
    CODEC_ID_H264,
66
    CODEC_ID_INDEO3,
67
    CODEC_ID_VP3,
68
    CODEC_ID_THEORA,
69 70
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
Michael Niedermayer's avatar
Michael Niedermayer committed
71
    CODEC_ID_ASV1,
Michael Niedermayer's avatar
Michael Niedermayer committed
72
    CODEC_ID_ASV2,
73
    CODEC_ID_FFV1,
74
    CODEC_ID_4XM,
Michael Niedermayer's avatar
Michael Niedermayer committed
75
    CODEC_ID_VCR1,
Alex Beregszaszi's avatar
Alex Beregszaszi committed
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,
Roberto Togni's avatar
Roberto Togni committed
88
    CODEC_ID_8BPS,
89
    CODEC_ID_SMC,
Mike Melanson's avatar
Mike Melanson committed
90
    CODEC_ID_FLIC,
91
    CODEC_ID_TRUEMOTION1,
92 93
    CODEC_ID_VMDVIDEO,
    CODEC_ID_VMDAUDIO,
94 95
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
Fabrice Bellard's avatar
Fabrice Bellard committed
96 97 98 99 100 101 102 103 104 105

    /* 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,
106 107 108 109

    /* various adpcm codecs */
    CODEC_ID_ADPCM_IMA_QT,
    CODEC_ID_ADPCM_IMA_WAV,
110 111
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
112
    CODEC_ID_ADPCM_IMA_WS,
113
    CODEC_ID_ADPCM_MS,
114
    CODEC_ID_ADPCM_4XM,
115 116
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
117 118 119

	/* AMR */
    CODEC_ID_AMR_NB,
120 121
    CODEC_ID_AMR_WB,

122 123 124
    /* RealAudio codecs*/
    CODEC_ID_RA_144,
    CODEC_ID_RA_288,
125 126 127 128

    /* various DPCM codecs */
    CODEC_ID_ROQ_DPCM,
    CODEC_ID_INTERPLAY_DPCM,
129
    CODEC_ID_XAN_DPCM,
130 131 132
    
    CODEC_ID_MPEG2TS, /* _FAKE_ codec to indicate a raw MPEG2 transport
                         stream (only used by libavformat) */
Fabrice Bellard's avatar
Fabrice Bellard committed
133
};
134 135 136

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
Fabrice Bellard's avatar
Fabrice Bellard committed
137 138

enum CodecType {
139
    CODEC_TYPE_UNKNOWN = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
140 141
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
142
    CODEC_TYPE_DATA,
Fabrice Bellard's avatar
Fabrice Bellard committed
143 144
};

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

Fabrice Bellard's avatar
Fabrice Bellard committed
187 188
/* currently unused, may be used if 24/32 bits samples ever supported */
enum SampleFormat {
189
    SAMPLE_FMT_S16 = 0,         ///< signed 16 bits 
Fabrice Bellard's avatar
Fabrice Bellard committed
190 191
};

Fabrice Bellard's avatar
Fabrice Bellard committed
192
/* in bytes */
Fabrice Bellard's avatar
Fabrice Bellard committed
193
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
Fabrice Bellard's avatar
Fabrice Bellard committed
194

195
/**
196 197 198 199 200
 * 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
201 202 203
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

204 205
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
206
    ME_ZERO = 1,
207 208 209 210 211 212 213
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
    ME_X1
};

214 215 216 217 218 219 220
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;

221 222 223
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

224
/* ME algos sorted by quality */
225
//FIXME remove IMHO
226 227
static const __attribute__((unused)) int Motion_Est_QTab[] =
 { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
Fabrice Bellard's avatar
Fabrice Bellard committed
228

229

Michael Niedermayer's avatar
Michael Niedermayer committed
230
#define FF_MAX_B_FRAMES 8
231

232 233 234 235
/* encoding support
   these flags can be passed in AVCodecContext.flags before initing 
   Note: note not everything is supported yet 
*/
Fabrice Bellard's avatar
Fabrice Bellard committed
236

237
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale 
238
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
239 240
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC 
#define CODEC_FLAG_GMC    0x0020  ///< use GMC 
241
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0> 
242
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning 
243 244
/* 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 */
245
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
246 247 248 249 250 251 252
#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 
253
                                            of only at frame boundaries */
254 255
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization 
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct 
256
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
257 258 259 260
#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) 
261
/* Fx : Flag for h263+ extra options */
262 263
#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
264
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector  
265
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
266
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
267
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
Michael Niedermayer's avatar
Michael Niedermayer committed
268 269
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
270 271
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
272
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
273
#define CODEC_FLAG_CLOSED_GOP     0x80000000
274 275 276
/* Unsupported options :
 * 		Syntax Arithmetic coding (SAC)
 * 		Reference Picture Selection
277
 * 		Independant Segment Decoding */
278
/* /Fx */
279 280
/* codec capabilities */

281
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback 
282 283 284 285 286
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
287 288 289
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
290
#define CODEC_CAP_TRUNCATED       0x0008
291

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
//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, ...)

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
/**
 * 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;

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

Michael Niedermayer's avatar
Michael Niedermayer committed
530 531
#define FF_QSCALE_TYPE_MPEG1	0
#define FF_QSCALE_TYPE_MPEG2	1
Michael Niedermayer's avatar
Michael Niedermayer committed
532 533

#define FF_BUFFER_TYPE_INTERNAL 1
Michael Niedermayer's avatar
Michael Niedermayer committed
534 535 536
#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
Michael Niedermayer's avatar
Michael Niedermayer committed
537

Michael Niedermayer's avatar
Michael Niedermayer committed
538

539 540 541 542
#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
543 544
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
Michael Niedermayer's avatar
Michael Niedermayer committed
545

546 547 548 549 550
#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)

551 552 553
/**
 * Audio Video Frame.
 */
554 555 556
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
Michael Niedermayer's avatar
Michael Niedermayer committed
557

558
#define DEFAULT_FRAME_RATE_BASE 1001000
Michael Niedermayer's avatar
Michael Niedermayer committed
559 560 561 562

/**
 * main external api structure.
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
563
typedef struct AVCodecContext {
564
    /**
565 566 567
     * 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 
568
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
569
    int bit_rate;
570 571

    /**
572
     * number of bits the bitstream is allowed to diverge from the reference.
573
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
574 575
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
576 577 578 579
     */
    int bit_rate_tolerance; 

    /**
580 581 582
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
583
     */
Fabrice Bellard's avatar
Fabrice Bellard committed
584
    int flags;
585 586 587

    /**
     * some codecs needs additionnal format info. It is stored here
588 589
     * - encoding: set by user. 
     * - decoding: set by lavc. (FIXME is this ok?)
590 591 592 593
     */
    int sub_id;

    /**
594 595 596
     * motion estimation algorithm used for video coding.
     * - encoding: MUST be set by user.
     * - decoding: unused
597 598 599 600
     */
    int me_method;

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

    /**
636 637 638
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
639 640 641 642
     */
    int gop_size;

    /**
643
     * pixel format, see PIX_FMT_xxx.
644 645 646 647
     * - 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.
648
     * - decoding: set by lavc.
649
     */
650
    enum PixelFormat pix_fmt;
651 652 653 654 655 656 657 658 659
 
    /**
     * 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;
       
660 661 662 663 664
    /**
     * 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
665 666
     * - encoding: unused
     * - decoding: set by user.
667 668 669 670
     * @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
671
     */
672
    void (*draw_horiz_band)(struct AVCodecContext *s,
673
                            const AVFrame *src, int offset[4],
674
                            int y, int type, int height);
675

Fabrice Bellard's avatar
Fabrice Bellard committed
676
    /* audio only */
677
    int sample_rate; ///< samples per sec 
Fabrice Bellard's avatar
Fabrice Bellard committed
678
    int channels;
679
    int sample_fmt;  ///< sample format, currenly unused 
Fabrice Bellard's avatar
Fabrice Bellard committed
680 681

    /* the following data should not be initialized */
682 683 684
    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 
Michael Niedermayer's avatar
Michael Niedermayer committed
685
    
686 687
    /**
     * number of frames the decoded output will be delayed relative to 
688 689 690
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
691 692
     */
    int delay;
Michael Niedermayer's avatar
Michael Niedermayer committed
693
    
694 695 696
    /* - 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) 
697 698
    
    /**
699 700 701
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
702 703 704 705
     */
    int qmin;

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

    /**
713 714 715
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
716 717 718 719
     */
    int max_qdiff;

    /**
720
     * maximum number of b frames between non b frames.
721
     * note: the output will be delayed by max_b_frames+1 relative to the input
722 723
     * - encoding: set by user.
     * - decoding: unused
724 725 726 727
     */
    int max_b_frames;

    /**
728 729 730
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
731 732 733 734 735
     */
    float b_quant_factor;
    
    /** obsolete FIXME remove */
    int rc_strategy;
736
    int b_frame_strategy;
737

738
    /**
739 740 741
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
742 743
     */
    int hurry_up;
744
    
Fabrice Bellard's avatar
Fabrice Bellard committed
745
    struct AVCodec *codec;
746
    
Fabrice Bellard's avatar
Fabrice Bellard committed
747 748
    void *priv_data;

749 750
    /* unused, FIXME remove*/
    int rtp_mode;
751 752 753 754 755 756 757
    
    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    */
758 759 760 761 762 763 764 765

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

766 767 768 769 770 771 772 773
    /* 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;
774 775 776
    int misc_bits;
    
    /**
777 778
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
779
     * - decoding: unused
780
     */
781
    int frame_bits;
782

783
    /**
784 785 786
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
787 788 789
     */
    void *opaque;

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

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

924 925
    float rc_qmod_amp;
    int rc_qmod_freq;
926 927
    
    /**
928 929 930
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
931
     */
932 933
    RcOverride *rc_override;
    int rc_override_count;
934 935
    
    /**
936 937 938
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
939
     */
940
    char *rc_eq;
941 942
    
    /**
943 944 945
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
946
     */
947
    int rc_max_rate;
948 949
    
    /**
950 951 952
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
953
     */
954
    int rc_min_rate;
955 956
    
    /**
957 958 959
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
960
     */
961 962
    int rc_buffer_size;
    float rc_buffer_aggressivity;
963 964

    /**
965
     * qscale factor 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_factor;
    
    /**
974 975 976
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
977 978 979 980
     */
    float i_quant_offset;
    
    /**
981 982 983
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
984
     */
985
    float rc_initial_cplx;
986

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

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

1058
    /**
1059 1060 1061
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1062 1063 1064
     */
    int slice_count;
    /**
1065 1066 1067
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1068 1069 1070
     */
    int *slice_offset;

1071
    /**
1072 1073 1074
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1075 1076 1077 1078 1079
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Zdenek Kabelac's avatar
Zdenek Kabelac committed
1080
    /**
1081
     * dsp_mask could be add used to disable unwanted CPU features
Zdenek Kabelac's avatar
Zdenek Kabelac committed
1082
     * CPU features (i.e. MMX, SSE. ...)
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
     *
     * 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 */
Michael Niedermayer's avatar
Michael Niedermayer committed
1098 1099

    /**
1100 1101 1102
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
Michael Niedermayer's avatar
Michael Niedermayer committed
1103 1104 1105 1106
     */
     int bits_per_sample;
    
    /**
1107 1108 1109
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1110 1111 1112 1113 1114
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1115 1116
    
    /**
Michael Niedermayer's avatar
Michael Niedermayer committed
1117
     * sample aspect ratio (0 if unknown).
1118
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1119 1120
     * - encoding: set by user.
     * - decoding: set by lavc.
1121
     */
Michael Niedermayer's avatar
Michael Niedermayer committed
1122
    AVRational sample_aspect_ratio;
Michael Niedermayer's avatar
Michael Niedermayer committed
1123 1124

    /**
1125 1126 1127
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
Michael Niedermayer's avatar
Michael Niedermayer committed
1128
     */
1129
    AVFrame *coded_frame;
1130 1131

    /**
1132 1133 1134
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1135 1136 1137 1138 1139 1140 1141 1142
     */
    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
1143
//#define FF_DEBUG_VIS_MV    0x00000040
1144 1145 1146
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1147
#define FF_DEBUG_ER        0x00000400
1148
#define FF_DEBUG_MMCO      0x00000800
1149
#define FF_DEBUG_BUGS      0x00001000
1150 1151
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1152
    
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    /**
     * 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

1163
    /**
1164 1165 1166
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1167 1168
     */
    uint64_t error[4];
Michael Niedermayer's avatar
Michael Niedermayer committed
1169 1170
    
    /**
1171 1172 1173
     * minimum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1174 1175 1176 1177
     */
    int mb_qmin;

    /**
1178 1179 1180
     * maximum MB quantizer.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1181 1182
     */
    int mb_qmax;
Michael Niedermayer's avatar
Michael Niedermayer committed
1183 1184
    
    /**
1185 1186 1187
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1188 1189 1190
     */
    int me_cmp;
    /**
1191 1192 1193
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1194 1195 1196
     */
    int me_sub_cmp;
    /**
1197 1198 1199
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1200 1201
     */
    int mb_cmp;
1202 1203 1204 1205 1206 1207
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
Michael Niedermayer's avatar
Michael Niedermayer committed
1208 1209 1210 1211 1212 1213 1214 1215
#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
1216 1217
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
Michael Niedermayer's avatar
Michael Niedermayer committed
1218 1219 1220
#define FF_CMP_CHROMA 256
    
    /**
1221 1222 1223
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1224 1225
     */
    int dia_size;
1226 1227

    /**
1228 1229 1230
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1231 1232
     */
    int last_predictor_count;
1233

1234
    /**
1235 1236 1237
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
1238 1239
     */
    int pre_me;
1240

1241
    /**
1242 1243 1244
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1245 1246
     */
    int me_pre_cmp;
Michael Niedermayer's avatar
Michael Niedermayer committed
1247

1248
    /**
1249 1250 1251
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1252 1253 1254
     */
    int pre_dia_size;

Michael Niedermayer's avatar
Michael Niedermayer committed
1255
    /**
1256 1257 1258
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
Michael Niedermayer's avatar
Michael Niedermayer committed
1259 1260 1261
     */
    int me_subpel_quality;

Michael Niedermayer's avatar
Michael Niedermayer committed
1262
    /**
1263
     * callback to negotiate the pixelFormat.
Michael Niedermayer's avatar
Michael Niedermayer committed
1264 1265 1266 1267
     * @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
1268 1269
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
Michael Niedermayer's avatar
Michael Niedermayer committed
1270 1271
     */
    enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1272 1273 1274 1275 1276 1277

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
     * 
1278 1279
     * - encoding: unused.
     * - decoding: set by decoder 
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
     */
    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

1290 1291 1292 1293
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
     * 
1294 1295
     * - encoding: set by user.
     * - decoding: unused.
1296
     */
Zdenek Kabelac's avatar
Zdenek Kabelac committed
1297
    int me_range;
1298

1299 1300 1301 1302 1303 1304 1305 1306
    /**
     * frame_rate_base.
     * for variable fps this is 1
     * - encoding: set by user.
     * - decoding: set by lavc.
     * @todo move this after frame_rate
     */

1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321
    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;
1322 1323 1324 1325 1326 1327 1328 1329

    /**
     * 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;
1330
    
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341
    /**
     * 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;
1342 1343 1344 1345 1346 1347 1348

#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
Michael Niedermayer's avatar
Michael Niedermayer committed
1349 1350 1351 1352 1353 1354 1355
    /**
     * 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;
Michael Niedermayer's avatar
Michael Niedermayer committed
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
    
#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;
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
    
    /**
     * 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)

Ivan Kalvachev's avatar
Ivan Kalvachev committed
1383 1384 1385 1386 1387 1388
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
    
    /**
     * 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
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412

    /**
     * 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;
1413
    
1414 1415 1416 1417 1418 1419 1420
    /**
     * 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;
1421 1422 1423 1424 1425 1426 1427 1428

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1443 1444 1445 1446 1447 1448 1449

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1450 1451 1452 1453 1454 1455 1456

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1457
    
1458
    /**
1459 1460 1461 1462 1463
     * 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().
1464
     * - encoding: unused
1465
     * - decoding: set by lavc, user can override
1466
     */
1467
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488

    /**
     * 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;
1489 1490 1491 1492 1493 1494 1495

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506
    
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
     * - decoding: set by user
     */
    int antialias_algo;
#define FF_AA_AUTO    0
#define FF_AA_FASTINT 1 //not implemented yet
#define FF_AA_INT     2
#define FF_AA_FLOAT   3
Fabrice Bellard's avatar
Fabrice Bellard committed
1507 1508
} AVCodecContext;

1509

1510 1511 1512
/**
 * AVOption.
 */
1513 1514 1515
typedef struct AVOption {
    /** options' name */
    const char *name; /* if name is NULL, it indicates a link to next */
1516 1517
    /** short English text help or const struct AVOption* subpointer */
    const char *help; //	const struct AVOption* sub;
1518 1519 1520 1521
    /** offset to context structure where the parsed value should be stored */
    int offset;
    /** options' type */
    int type;
1522 1523 1524 1525 1526
#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
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
//#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;

1545 1546 1547 1548 1549 1550 1551 1552 1553
/**
 * 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);


1554 1555 1556
/**
 * AVCodec.
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1557
typedef struct AVCodec {
1558
    const char *name;
Zdenek Kabelac's avatar
Zdenek Kabelac committed
1559
    enum CodecType type;
Fabrice Bellard's avatar
Fabrice Bellard committed
1560 1561 1562
    int id;
    int priv_data_size;
    int (*init)(AVCodecContext *);
1563
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
Fabrice Bellard's avatar
Fabrice Bellard committed
1564
    int (*close)(AVCodecContext *);
Michael Niedermayer's avatar
Michael Niedermayer committed
1565
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1566
                  uint8_t *buf, int buf_size);
1567
    int capabilities;
1568
    const AVOption *options;
Fabrice Bellard's avatar
Fabrice Bellard committed
1569
    struct AVCodec *next;
Michael Niedermayer's avatar
Michael Niedermayer committed
1570
    void (*flush)(AVCodecContext *);
Fabrice Bellard's avatar
Fabrice Bellard committed
1571 1572
} AVCodec;

1573
/**
1574 1575 1576
 * four components are given, that's all.
 * the last component is alpha
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1577
typedef struct AVPicture {
1578
    uint8_t *data[4];
Michael Niedermayer's avatar
Michael Niedermayer committed
1579
    int linesize[4];       ///< number of bytes per line
Fabrice Bellard's avatar
Fabrice Bellard committed
1580 1581
} AVPicture;

1582 1583 1584 1585 1586
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
1587
#define AVPALETTE_SIZE 1024
Michael Niedermayer's avatar
Michael Niedermayer committed
1588
#define AVPALETTE_COUNT 256
1589 1590 1591 1592 1593 1594
typedef struct AVPaletteControl {

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

1595 1596 1597 1598
    /* 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 */
1599
    unsigned int palette[AVPALETTE_COUNT];
1600 1601 1602

} AVPaletteControl;

Fabrice Bellard's avatar
Fabrice Bellard committed
1603 1604
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
1605
extern AVCodec mp3lame_encoder;
1606
extern AVCodec oggvorbis_encoder;
1607
extern AVCodec faac_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1608
extern AVCodec mpeg1video_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1609
extern AVCodec mpeg2video_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1610 1611
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
1612
extern AVCodec flv_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1613
extern AVCodec rv10_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1614
extern AVCodec rv20_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1615
extern AVCodec mjpeg_encoder;
1616
extern AVCodec ljpeg_encoder;
1617
extern AVCodec mpeg4_encoder;
1618 1619 1620
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1621 1622
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1623
extern AVCodec huffyuv_encoder;
1624
extern AVCodec h264_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1625
extern AVCodec asv1_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1626
extern AVCodec asv2_encoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1627
extern AVCodec vcr1_encoder;
1628
extern AVCodec ffv1_encoder;
1629
extern AVCodec mdec_encoder;
1630
extern AVCodec zlib_encoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1631 1632

extern AVCodec h263_decoder;
1633
extern AVCodec mpeg4_decoder;
1634 1635 1636
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
1637
extern AVCodec wmv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1638
extern AVCodec wmv2_decoder;
1639 1640
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
Ivan Kalvachev's avatar
Ivan Kalvachev committed
1641
extern AVCodec mpegvideo_decoder;
Ivan Kalvachev's avatar
Ivan Kalvachev committed
1642
extern AVCodec mpeg_xvmc_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1643
extern AVCodec h263i_decoder;
1644
extern AVCodec flv_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1645
extern AVCodec rv10_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1646
extern AVCodec rv20_decoder;
Nick Kurshev's avatar
Nick Kurshev committed
1647
extern AVCodec svq1_decoder;
1648
extern AVCodec svq3_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1649
extern AVCodec dvvideo_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1650 1651
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
1652
extern AVCodec mjpeg_decoder;
1653
extern AVCodec mjpegb_decoder;
1654
extern AVCodec sp5x_decoder;
1655
extern AVCodec mp2_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1656
extern AVCodec mp3_decoder;
1657 1658
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1659
extern AVCodec huffyuv_decoder;
1660
extern AVCodec oggvorbis_decoder;
1661
extern AVCodec cyuv_decoder;
1662
extern AVCodec h264_decoder;
1663
extern AVCodec indeo3_decoder;
1664
extern AVCodec vp3_decoder;
1665
extern AVCodec theora_decoder;
1666
extern AVCodec amr_nb_decoder;
Zdenek Kabelac's avatar
Zdenek Kabelac committed
1667
extern AVCodec amr_nb_encoder;
1668 1669
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
1670 1671
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1672
extern AVCodec asv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1673
extern AVCodec asv2_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1674
extern AVCodec vcr1_decoder;
Alex Beregszaszi's avatar
Alex Beregszaszi committed
1675
extern AVCodec cljr_decoder;
1676
extern AVCodec ffv1_decoder;
Michael Niedermayer's avatar
Michael Niedermayer committed
1677
extern AVCodec fourxm_decoder;
1678
extern AVCodec mdec_decoder;
1679 1680
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
1681
extern AVCodec xan_wc3_decoder;
1682 1683 1684 1685
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
1686
extern AVCodec vqa_decoder;
1687
extern AVCodec idcin_decoder;
Roberto Togni's avatar
Roberto Togni committed
1688
extern AVCodec eightbps_decoder;
1689
extern AVCodec smc_decoder;
Mike Melanson's avatar
Mike Melanson committed
1690
extern AVCodec flic_decoder;
1691 1692
extern AVCodec vmdvideo_decoder;
extern AVCodec vmdaudio_decoder;
1693
extern AVCodec truemotion1_decoder;
1694 1695
extern AVCodec mszh_decoder;
extern AVCodec zlib_decoder;
1696 1697
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
1698 1699
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
1700
extern AVCodec xan_dpcm_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1701

Fabrice Bellard's avatar
Fabrice Bellard committed
1702 1703 1704
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
1705
extern AVCodec name ## _encoder
Fabrice Bellard's avatar
Fabrice Bellard committed
1706 1707 1708 1709 1710 1711 1712 1713 1714 1715

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

1716 1717 1718 1719
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1720 1721
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
1722
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
1723
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
Michael Niedermayer's avatar
Michael Niedermayer committed
1724
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
1725 1726
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
1727

Fabrice Bellard's avatar
Fabrice Bellard committed
1728 1729 1730
#undef PCM_CODEC

/* dummy raw video codec */
1731 1732
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
Fabrice Bellard's avatar
Fabrice Bellard committed
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755

/* 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);
1756 1757 1758 1759 1760 1761

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

Fabrice Bellard's avatar
Fabrice Bellard committed
1762
void img_resample(ImgReSampleContext *s, 
1763
                  AVPicture *output, const AVPicture *input);
Fabrice Bellard's avatar
Fabrice Bellard committed
1764 1765 1766

void img_resample_close(ImgReSampleContext *s);

Drew Hess's avatar
Drew Hess committed
1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
/**
 * 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);

1781
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1782
                   int pix_fmt, int width, int height);
1783
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
1784
                     unsigned char *dest, int dest_size);
1785
int avpicture_get_size(int pix_fmt, int width, int height);
1786 1787
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);
1788
enum PixelFormat avcodec_get_pix_fmt(const char* name);
1789

1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
#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);

1802 1803
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
1804 1805
int img_get_alpha_info(const AVPicture *src,
		       int pix_fmt, int width, int height);
1806

1807 1808
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
1809
                const AVPicture *src, int pix_fmt, 
1810 1811 1812
                int width, int height);

/* deinterlace a picture */
1813
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
Fabrice Bellard's avatar
Fabrice Bellard committed
1814 1815 1816 1817 1818 1819
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

Nick Kurshev's avatar
Nick Kurshev committed
1820
/* returns LIBAVCODEC_VERSION_INT constant */
1821
unsigned avcodec_version(void);
Nick Kurshev's avatar
Nick Kurshev committed
1822
/* returns LIBAVCODEC_BUILD constant */
1823
unsigned avcodec_build(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
1824 1825 1826 1827
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
1828
AVCodec *avcodec_find_encoder_by_name(const char *name);
Fabrice Bellard's avatar
Fabrice Bellard committed
1829 1830 1831 1832
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);

Michael Niedermayer's avatar
Michael Niedermayer committed
1833
void avcodec_get_context_defaults(AVCodecContext *s);
Falk Hüffner's avatar
Falk Hüffner committed
1834
AVCodecContext *avcodec_alloc_context(void);
1835
AVFrame *avcodec_alloc_frame(void);
Michael Niedermayer's avatar
Michael Niedermayer committed
1836

1837 1838
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1839
void avcodec_default_free_buffers(AVCodecContext *s);
Michael Niedermayer's avatar
Michael Niedermayer committed
1840

Michael Niedermayer's avatar
Michael Niedermayer committed
1841 1842 1843 1844
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
1845
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
Michael Niedermayer's avatar
Michael Niedermayer committed
1846

1847
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples, 
Fabrice Bellard's avatar
Fabrice Bellard committed
1848
                         int *frame_size_ptr,
1849
                         uint8_t *buf, int buf_size);
1850
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture, 
Fabrice Bellard's avatar
Fabrice Bellard committed
1851
                         int *got_picture_ptr,
1852 1853
                         uint8_t *buf, int buf_size);
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata, 
1854
                        int *data_size_ptr,
1855 1856
                        uint8_t *buf, int buf_size);
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
Fabrice Bellard's avatar
Fabrice Bellard committed
1857
                         const short *samples);
1858
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, 
1859
                         const AVFrame *pict);
Fabrice Bellard's avatar
Fabrice Bellard committed
1860 1861 1862 1863

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
Fabrice Bellard's avatar
Fabrice Bellard committed
1864

1865 1866
void avcodec_flush_buffers(AVCodecContext *avctx);

1867
/* misc usefull functions */
Michael Niedermayer's avatar
Michael Niedermayer committed
1868 1869 1870 1871 1872 1873

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

1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
/**
 * 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);
1887 1888


1889 1890 1891 1892 1893 1894 1895
/**
 * Interface for 0.5.0 version
 *
 * do not even think about it's usage for this moment
 */

typedef struct {
1896
    /// compressed size used from given memory buffer
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 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964
    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);

1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
/* 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 */
1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
    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];
1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008
} 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, 
2009 2010
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2011 2012 2013 2014 2015 2016 2017 2018 2019
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;

2020
/* memory */
2021
void *av_malloc(unsigned int size);
2022
void *av_mallocz(unsigned int size);
2023
void *av_realloc(void *ptr, unsigned int size);
2024
void av_free(void *ptr);
2025
char *av_strdup(const char *s);
2026 2027
void __av_freep(void **ptr);
#define av_freep(p) __av_freep((void **)(p))
2028
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2029 2030
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2031
void av_free_static(void);
2032 2033
void *__av_mallocz_static(void** location, unsigned int size);
#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
2034

2035 2036 2037
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

2038 2039 2040
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
/* 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

2063 2064 2065 2066
#ifdef __cplusplus
}
#endif

Fabrice Bellard's avatar
Fabrice Bellard committed
2067
#endif /* AVCODEC_H */