avcodec.h 73.8 KB
Newer Older
glantau's avatar
glantau committed
1 2 3
#ifndef AVCODEC_H
#define AVCODEC_H

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


kabi's avatar
kabi committed
10 11 12 13
#ifdef __cplusplus
extern "C" {
#endif

14
#include "avutil.h"
kabi's avatar
kabi committed
15
#include <sys/types.h> /* size_t */
glantau's avatar
glantau committed
16

michael's avatar
michael committed
17
//FIXME the following 2 really dont belong in here
18 19
#define FFMPEG_VERSION_INT      0x000409
#define FFMPEG_VERSION          "CVS"
bellard's avatar
bellard committed
20

21
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
bellard's avatar
bellard committed
22
#define AV_TOSTRING(s) #s
michael's avatar
michael committed
23

kostya's avatar
kostya committed
24 25
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(8<<8)+0)
#define LIBAVCODEC_VERSION      51.8.0
26
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
27

28
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
al3x's avatar
al3x committed
29

30 31 32
#define AV_NOPTS_VALUE          int64_t_C(0x8000000000000000)
#define AV_TIME_BASE            1000000
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
33

glantau's avatar
glantau committed
34
enum CodecID {
35
    CODEC_ID_NONE,
glantau's avatar
glantau committed
36
    CODEC_ID_MPEG1VIDEO,
37
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
iive's avatar
iive committed
38
    CODEC_ID_MPEG2VIDEO_XVMC,
39
    CODEC_ID_H261,
glantau's avatar
glantau committed
40 41
    CODEC_ID_H263,
    CODEC_ID_RV10,
michael's avatar
michael committed
42
    CODEC_ID_RV20,
glantau's avatar
glantau committed
43
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
44
    CODEC_ID_MJPEGB,
45
    CODEC_ID_LJPEG,
alex's avatar
alex committed
46
    CODEC_ID_SP5X,
47
    CODEC_ID_JPEGLS,
glantau's avatar
glantau committed
48
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
49
    CODEC_ID_RAWVIDEO,
50 51 52
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
53
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
54
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
55 56
    CODEC_ID_H263P,
    CODEC_ID_H263I,
57
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
58
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
59
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
60
    CODEC_ID_DVVIDEO,
michaelni's avatar
michaelni committed
61
    CODEC_ID_HUFFYUV,
62
    CODEC_ID_CYUV,
michaelni's avatar
michaelni committed
63
    CODEC_ID_H264,
tmmm's avatar
tmmm committed
64
    CODEC_ID_INDEO3,
tmmm's avatar
tmmm committed
65
    CODEC_ID_VP3,
66
    CODEC_ID_THEORA,
michaelni's avatar
michaelni committed
67
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
68
    CODEC_ID_ASV2,
69
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
70
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
71
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
72
    CODEC_ID_CLJR,
73
    CODEC_ID_MDEC,
74 75
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
76 77
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
78 79 80 81 82
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
83
    CODEC_ID_IDCIN,
rtognimp's avatar
rtognimp committed
84
    CODEC_ID_8BPS,
85
    CODEC_ID_SMC,
melanson's avatar
melanson committed
86
    CODEC_ID_FLIC,
87
    CODEC_ID_TRUEMOTION1,
88
    CODEC_ID_VMDVIDEO,
rtognimp's avatar
rtognimp committed
89 90
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
91
    CODEC_ID_QTRLE,
michael's avatar
michael committed
92
    CODEC_ID_SNOW,
93
    CODEC_ID_TSCC,
94
    CODEC_ID_ULTI,
95
    CODEC_ID_QDRAW,
96
    CODEC_ID_VIXL,
97
    CODEC_ID_QPEG,
98 99 100 101 102 103 104
    CODEC_ID_XVID,
    CODEC_ID_PNG,
    CODEC_ID_PPM,
    CODEC_ID_PBM,
    CODEC_ID_PGM,
    CODEC_ID_PGMYUV,
    CODEC_ID_PAM,
lorenm's avatar
lorenm committed
105
    CODEC_ID_FFVHUFF,
michael's avatar
michael committed
106 107
    CODEC_ID_RV30,
    CODEC_ID_RV40,
108 109
    CODEC_ID_VC9,
    CODEC_ID_WMV3,
110
    CODEC_ID_LOCO,
111
    CODEC_ID_WNV1,
112
    CODEC_ID_AASC,
113
    CODEC_ID_INDEO2,
114
    CODEC_ID_FRAPS,
115
    CODEC_ID_TRUEMOTION2,
mru's avatar
mru committed
116
    CODEC_ID_BMP,
117
    CODEC_ID_CSCD,
118
    CODEC_ID_MMVIDEO,
119
    CODEC_ID_ZMBV,
120
    CODEC_ID_AVS,
kostya's avatar
kostya committed
121
    CODEC_ID_SMACKVIDEO,
122
    CODEC_ID_NUV,
glantau's avatar
glantau committed
123 124

    /* various pcm "codecs" */
125
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
126 127 128 129 130 131 132
    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,
133 134 135 136 137 138 139 140 141
    CODEC_ID_PCM_S32LE,
    CODEC_ID_PCM_S32BE,
    CODEC_ID_PCM_U32LE,
    CODEC_ID_PCM_U32BE,
    CODEC_ID_PCM_S24LE,
    CODEC_ID_PCM_S24BE,
    CODEC_ID_PCM_U24LE,
    CODEC_ID_PCM_U24BE,
    CODEC_ID_PCM_S24DAUD,
142 143

    /* various adpcm codecs */
144
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
145
    CODEC_ID_ADPCM_IMA_WAV,
146 147
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
148
    CODEC_ID_ADPCM_IMA_WS,
149
    CODEC_ID_ADPCM_IMA_SMJPEG,
150
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
151
    CODEC_ID_ADPCM_4XM,
152 153
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
154
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
155
    CODEC_ID_ADPCM_G726,
156
    CODEC_ID_ADPCM_CT,
157
    CODEC_ID_ADPCM_SWF,
158
    CODEC_ID_ADPCM_YAMAHA,
159 160 161
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
162

163 164
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
165 166
    CODEC_ID_AMR_WB,

167
    /* RealAudio codecs*/
168
    CODEC_ID_RA_144= 0x13000,
169
    CODEC_ID_RA_288,
170 171

    /* various DPCM codecs */
172
    CODEC_ID_ROQ_DPCM= 0x14000,
173
    CODEC_ID_INTERPLAY_DPCM,
174
    CODEC_ID_XAN_DPCM,
175
    CODEC_ID_SOL_DPCM,
176

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    CODEC_ID_MP2= 0x15000,
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
    CODEC_ID_AAC,
    CODEC_ID_MPEG4AAC,
    CODEC_ID_AC3,
    CODEC_ID_DTS,
    CODEC_ID_VORBIS,
    CODEC_ID_DVAUDIO,
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
    CODEC_ID_VMDAUDIO,
    CODEC_ID_SONIC,
    CODEC_ID_SONIC_LS,
michael's avatar
michael committed
192
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
193
    CODEC_ID_MP3ADU,
194
    CODEC_ID_MP3ON4,
195
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
196
    CODEC_ID_ALAC,
197
    CODEC_ID_WESTWOOD_SND1,
198
    CODEC_ID_GSM,
rtognimp's avatar
rtognimp committed
199
    CODEC_ID_QDM2,
200
    CODEC_ID_COOK,
201
    CODEC_ID_TRUESPEECH,
202
    CODEC_ID_TTA,
kostya's avatar
kostya committed
203
    CODEC_ID_SMACKAUDIO,
204 205

    CODEC_ID_OGGTHEORA= 0x16000,
bellard's avatar
bellard committed
206 207

    /* subtitle codecs */
208 209 210
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,

211
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
212
                         stream (only used by libavformat) */
glantau's avatar
glantau committed
213
};
214 215 216

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
glantau's avatar
glantau committed
217 218

enum CodecType {
219
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
220 221
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
222
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
223
    CODEC_TYPE_SUBTITLE,
glantau's avatar
glantau committed
224 225
};

glantau's avatar
glantau committed
226
/* currently unused, may be used if 24/32 bits samples ever supported */
227
/* all in native endian */
glantau's avatar
glantau committed
228
enum SampleFormat {
mru's avatar
mru committed
229
    SAMPLE_FMT_NONE = -1,
230 231 232
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
233
    SAMPLE_FMT_S32,             ///< signed 32 bits
234
    SAMPLE_FMT_FLT,             ///< float
glantau's avatar
glantau committed
235 236
};

glantau's avatar
glantau committed
237
/* in bytes */
238
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
239

240
/**
241
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
242
 * this is mainly needed because some optimized bitstream readers read
243 244 245
 * 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
246 247 248
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

249 250 251 252 253 254
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

255 256
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
257
    ME_ZERO = 1,
258 259 260 261
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
262 263 264 265
    ME_X1,
    ME_HEX,
    ME_UMH,
    ME_ITER,
266 267
};

michael's avatar
michael committed
268 269 270 271 272 273 274 275 276 277
enum AVDiscard{
//we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
    AVDISCARD_NONE   =-16, ///< discard nothing
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
    AVDISCARD_NONREF =  8, ///< discard all non reference
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
    AVDISCARD_ALL    = 48, ///< discard all
};

michaelni's avatar
michaelni committed
278 279 280 281 282 283 284
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;

285 286 287
/* only for ME compatiblity with old apps */
extern int motion_estimation_method;

288
#define FF_MAX_B_FRAMES 16
289

michaelni's avatar
michaelni committed
290
/* encoding support
291
   these flags can be passed in AVCodecContext.flags before initing
diego's avatar
diego committed
292
   Note: not everything is supported yet.
michaelni's avatar
michaelni committed
293
*/
glantau's avatar
glantau committed
294

295
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale
michael's avatar
michael committed
296
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
297 298 299 300 301
#define CODEC_FLAG_QPEL   0x0010  ///< use qpel MC
#define CODEC_FLAG_GMC    0x0020  ///< use GMC
#define CODEC_FLAG_MV0    0x0040  ///< always try a MB with MV=<0,0>
#define CODEC_FLAG_PART   0x0080  ///< use data partitioning
/* parent program gurantees that the input for b-frame containing streams is not written to
302
   for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
michaelni's avatar
michaelni committed
303
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
304 305 306 307
#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
diego's avatar
diego committed
308
#define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
309 310
#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
311
                                            of only at frame boundaries */
312 313
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
314
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
315 316 317 318
#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)
319
/* Fx : Flag for h263+ extra options */
michaelni's avatar
michaelni committed
320 321
#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
322
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector
323
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
324
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
michael's avatar
michael committed
325
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
michael's avatar
michael committed
326 327
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
328 329
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
michael's avatar
michael committed
330
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
331
#define CODEC_FLAG_CLOSED_GOP     0x80000000
332
#define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
333
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
334
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< skip bitstream encoding
335
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< place global headers at every keyframe instead of in extradata
lorenm's avatar
lorenm committed
336 337 338 339 340 341 342
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow b-frames to be used as references
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for b-frames
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 multiple references per partition
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
#define CODEC_FLAG2_BRDO          0x00000400 ///< b-frame rate-distortion optimization
343

344
/* Unsupported options :
345 346 347
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
 *              Independant Segment Decoding */
348
/* /Fx */
glantau's avatar
glantau committed
349 350
/* codec capabilities */

351
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
michaelni's avatar
michaelni committed
352 353 354 355 356
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
357 358 359
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
360
#define CODEC_CAP_TRUNCATED       0x0008
361 362
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
363
/**
364 365 366
 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
 * if this is not set, the codec is guranteed to never be feeded with NULL data
 */
367
#define CODEC_CAP_DELAY           0x0020
glantau's avatar
glantau committed
368

diego's avatar
diego committed
369
//the following defines may change, don't expect compatibility if you use them
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
#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, ...)

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
/**
 * 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;

michaelni's avatar
michaelni committed
421
#define FF_COMMON_FRAME \
michaelni's avatar
michaelni committed
422 423 424 425 426 427
    /**\
     * pointer to the picture planes.\
     * this might be different from the first allocated byte\
     * - encoding: \
     * - decoding: \
     */\
michaelni's avatar
michaelni committed
428 429 430
    uint8_t *data[4];\
    int linesize[4];\
    /**\
michaelni's avatar
michaelni committed
431
     * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
diego's avatar
diego committed
432
     * this isn't used by lavc unless the default get/release_buffer() is used\
433 434
     * - encoding: \
     * - decoding: \
michaelni's avatar
michaelni committed
435 436 437 438
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
439 440
     * - encoding: set by lavc\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
441 442 443 444
     */\
    int key_frame;\
\
    /**\
michaelni's avatar
michaelni committed
445
     * picture type of the frame, see ?_TYPE below.\
446 447
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
448 449 450 451
     */\
    int pict_type;\
\
    /**\
michael's avatar
michael committed
452 453
     * presentation timestamp in time_base units (time when frame should be shown to user)\
     * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
454 455
     * - encoding: MUST be set by user\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
456
     */\
457
    int64_t pts;\
michaelni's avatar
michaelni committed
458 459 460
\
    /**\
     * picture number in bitstream order.\
461 462
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
463 464 465 466
     */\
    int coded_picture_number;\
    /**\
     * picture number in display order.\
467 468
     * - encoding: set by\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
469 470 471 472
     */\
    int display_picture_number;\
\
    /**\
473
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
474 475
     * - encoding: set by lavc for coded_picture (and set by user for input)\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
476
     */\
477
    int quality; \
michaelni's avatar
michaelni committed
478 479 480
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
481
     * set to INT_MAX if the buffer has not been used yet \
482 483
     * - encoding: unused\
     * - decoding: MUST be set by get_buffer()\
michaelni's avatar
michaelni committed
484 485 486 487 488
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
489 490
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
michaelni's avatar
michaelni committed
491 492 493 494 495
     */\
    int reference;\
\
    /**\
     * QP table\
496 497
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
498 499 500 501
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
502 503
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
504 505 506 507 508 509
     */\
    int qstride;\
\
    /**\
     * mbskip_table[mb]>=1 if MB didnt change\
     * stride= mb_width = (width+15)>>4\
510 511
     * - encoding: unused\
     * - decoding: set by lavc\
michaelni's avatar
michaelni committed
512 513
     */\
    uint8_t *mbskip_table;\
514 515
\
    /**\
michael's avatar
michael committed
516 517 518 519 520 521 522 523
     * Motion vector table.\
     * @code\
     * example:\
     * int mv_sample_log2= 4 - motion_subsample_log2;\
     * int mb_width= (width+15)>>4;\
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
     * @endcode\
524
     * - encoding: set by user\
525 526 527 528 529 530 531
     * - decoding: set by lavc\
     */\
    int16_t (*motion_val[2])[2];\
\
    /**\
     * Macroblock type table\
     * mb_type_base + mb_width + 2\
532
     * - encoding: set by user\
533 534 535 536 537
     * - decoding: set by lavc\
     */\
    uint32_t *mb_type;\
\
    /**\
michael's avatar
michael committed
538 539
     * log2 of the size of the block which a single vector in motion_val represents: \
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
540 541 542 543
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    uint8_t motion_subsample_log2;\
michaelni's avatar
michaelni committed
544 545 546
\
    /**\
     * for some private data of the user\
547 548
     * - encoding: unused\
     * - decoding: set by user\
michaelni's avatar
michaelni committed
549 550
     */\
    void *opaque;\
551 552 553
\
    /**\
     * error\
554 555
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
     * - decoding: unused\
556 557
     */\
    uint64_t error[4];\
michaelni's avatar
michaelni committed
558 559 560
\
    /**\
     * type of the buffer (to keep track of who has to dealloc data[*])\
561 562
     * - encoding: set by the one who allocs it\
     * - decoding: set by the one who allocs it\
mellum's avatar
mellum committed
563
     * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
michaelni's avatar
michaelni committed
564 565
     */\
    int type;\
566 567 568 569
    \
    /**\
     * when decoding, this signal how much the picture must be delayed.\
     * extra_delay = repeat_pict / (2*fps)\
570 571
     * - encoding: unused\
     * - decoding: set by lavc\
572
     */\
michaelni's avatar
michaelni committed
573 574 575 576 577 578
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
romansh's avatar
 
romansh committed
579 580 581 582 583 584 585 586 587
    \
    /**\
     * The content of the picture is interlaced.\
     * - encoding: set by user\
     * - decoding: set by lavc (default 0)\
     */\
    int interlaced_frame;\
    \
    /**\
588
     * if the content is interlaced, is top field displayed first.\
romansh's avatar
 
romansh committed
589
     * - encoding: set by user\
590
     * - decoding: set by lavc\
romansh's avatar
 
romansh committed
591
     */\
592
    int top_field_first;\
593 594 595 596 597 598 599
    \
    /**\
     * Pan scan.\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    AVPanScan *pan_scan;\
600 601 602 603 604 605 606
    \
    /**\
     * 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;\
607 608 609 610 611 612 613
    \
    /**\
     * Codec suggestion on buffer type if != 0\
     * - encoding: unused\
     * - decoding: set by lavc (before get_buffer() call))\
     */\
    int buffer_hints;\
614 615 616 617 618 619 620
\
    /**\
     * DCT coeffitients\
     * - encoding: unused\
     * - decoding: set by lavc\
     */\
    short *dct_coeff;\
621 622 623 624 625 626 627
\
    /**\
     * Motion referece frame index\
     * - encoding: set by user\
     * - decoding: set by lavc\
     */\
    int8_t *ref_index[2];
628

629 630 631
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
632 633

#define FF_BUFFER_TYPE_INTERNAL 1
michaelni's avatar
michaelni committed
634
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
diego's avatar
diego committed
635 636
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
#define FF_BUFFER_TYPE_COPY     8 ///< just a (modified) copy of some other buffer, don't dealloc anything
michaelni's avatar
michaelni committed
637

michaelni's avatar
michaelni committed
638

639 640 641 642
#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
michaelni's avatar
michaelni committed
643 644
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
645

646 647 648 649 650
#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)

michaelni's avatar
michaelni committed
651 652 653
/**
 * Audio Video Frame.
 */
michaelni's avatar
michaelni committed
654 655 656
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
657

658
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
659

660 661 662 663 664 665 666
/**
 * Used by av_log
 */
typedef struct AVCLASS AVClass;
struct AVCLASS {
    const char* class_name;
    const char* (*item_name)(void*); /* actually passing a pointer to an AVCodecContext
667 668 669
                                        or AVFormatContext, which begin with an AVClass.
                                        Needed because av_log is in libavcodec and has no visibility
                                        of AVIn/OutputFormat */
michael's avatar
michael committed
670
    struct AVOption *option;
671 672
};

michaelni's avatar
doxy  
michaelni committed
673 674 675
/**
 * main external api structure.
 */
glantau's avatar
glantau committed
676
typedef struct AVCodecContext {
677 678 679 680
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
681
    AVClass *av_class;
682
    /**
683 684
     * the average bitrate.
     * - encoding: set by user. unused for constant quantizer encoding
685
     * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
686
     */
glantau's avatar
glantau committed
687
    int bit_rate;
688 689

    /**
690
     * number of bits the bitstream is allowed to diverge from the reference.
691
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
692 693
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
694
     */
695
    int bit_rate_tolerance;
696 697

    /**
698 699 700
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
701
     */
glantau's avatar
glantau committed
702
    int flags;
703 704 705

    /**
     * some codecs needs additionnal format info. It is stored here
706
     * - encoding: set by user.
707
     * - decoding: set by lavc. (FIXME is this ok?)
708 709 710 711
     */
    int sub_id;

    /**
712
     * motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
713 714
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
715 716
     * - encoding: MUST be set by user.
     * - decoding: unused
717 718 719 720
     */
    int me_method;

    /**
721
     * some codecs need / can use extra-data like huffman tables.
722 723
     * mjpeg: huffman tables
     * rv10: additional flags
724
     * mpeg4: global headers (they can be in the bitstream or here)
725 726
     * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
     * then extradata_size to avoid prolems if its read with the bitstream reader
michael's avatar
michael committed
727
     * the bytewise contents of extradata must not depend on the architecture or cpu endianness
728 729
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
730
     */
731 732
    void *extradata;
    int extradata_size;
733

734
    /**
735 736 737 738
     * this is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. for fixed-fps content,
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
739
     * - encoding: MUST be set by user
michael's avatar
michael committed
740
     * - decoding: set by lavc.
741
     */
michael's avatar
michael committed
742
    AVRational time_base;
743

744
    /* video only */
745
    /**
746
     * picture width / height.
747
     * - encoding: MUST be set by user.
748
     * - decoding: set by lavc.
749
     * Note, for compatibility its possible to set this instead of
750
     * coded_width/height before decoding
751
     */
glantau's avatar
glantau committed
752
    int width, height;
753

754
#define FF_ASPECT_EXTENDED 15
755 756

    /**
757 758 759
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
760 761 762 763
     */
    int gop_size;

    /**
764
     * pixel format, see PIX_FMT_xxx.
765
     * - encoding: set by user.
766
     * - decoding: set by lavc.
767
     */
768
    enum PixelFormat pix_fmt;
769

770
    /**
771
     * Frame rate emulation. If not zero lower layer (i.e. format handler)
772 773 774 775 776
     * has to read frames at native frame rate.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int rate_emu;
777

778 779 780 781 782
    /**
     * 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
783 784
     * - encoding: unused
     * - decoding: set by user.
785 786 787 788
     * @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
789
     */
glantau's avatar
glantau committed
790
    void (*draw_horiz_band)(struct AVCodecContext *s,
791
                            const AVFrame *src, int offset[4],
792
                            int y, int type, int height);
glantau's avatar
glantau committed
793

glantau's avatar
glantau committed
794
    /* audio only */
795
    int sample_rate; ///< samples per sec
glantau's avatar
glantau committed
796
    int channels;
797 798 799 800 801 802

    /**
     * audio sample format.
     * - encoding: set by user.
     * - decoding: set by lavc.
     */
803
    enum SampleFormat sample_fmt;  ///< sample format, currenly unused
glantau's avatar
glantau committed
804 805

    /* the following data should not be initialized */
806
    /**
807
     * samples per packet. initialized when calling 'init'
808 809
     */
    int frame_size;
810 811 812
    int frame_number;   ///< audio or video frame number
    int real_pict_num;  ///< returns the real picture number of previous encoded frame

813
    /**
814
     * number of frames the decoded output will be delayed relative to
815 816 817
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
818 819
     */
    int delay;
820

821 822
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
823 824
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

825
    /**
826 827 828
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
829 830 831 832
     */
    int qmin;

    /**
833 834 835
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
836 837 838 839
     */
    int qmax;

    /**
840 841 842
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
843 844 845 846
     */
    int max_qdiff;

    /**
847
     * maximum number of b frames between non b frames.
848
     * note: the output will be delayed by max_b_frames+1 relative to the input
849 850
     * - encoding: set by user.
     * - decoding: unused
851 852 853 854
     */
    int max_b_frames;

    /**
855 856 857
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
858 859
     */
    float b_quant_factor;
860

861 862
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
863 864
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
865
    int b_frame_strategy;
866

867
    /**
868
     * hurry up amount.
michael's avatar
michael committed
869
     * deprecated in favor of skip_idct and skip_frame
870 871
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
872 873
     */
    int hurry_up;
874

glantau's avatar
glantau committed
875
    struct AVCodec *codec;
876

glantau's avatar
glantau committed
877 878
    void *priv_data;

michael's avatar
michael committed
879 880
    /* unused, FIXME remove*/
    int rtp_mode;
881

diego's avatar
diego committed
882
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
883 884 885 886 887
                            /* 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    */
888

889

diego's avatar
diego committed
890 891 892 893 894 895
    /* The RTP callback: This function is called   */
    /* every time the encoder has a packet to send */
    /* Depends on the encoder if the data starts   */
    /* with a Start Code (it should) H.263 does.   */
    /* mb_nb contains the number of macroblocks    */
    /* encoded in the RTP payload                  */
896
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
897

michaelni's avatar
michaelni committed
898 899 900 901 902 903 904 905
    /* 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;
906
    int misc_bits;
907

908
    /**
909 910
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
michaelni's avatar
michaelni committed
911
     * - decoding: unused
912
     */
michaelni's avatar
michaelni committed
913
    int frame_bits;
michaelni's avatar
michaelni committed
914

915
    /**
916 917 918
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
919 920 921
     */
    void *opaque;

glantau's avatar
glantau committed
922
    char codec_name[32];
923 924
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
925

michaelni's avatar
michaelni committed
926 927 928
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
michaelni's avatar
michaelni committed
929
     * - encoding: set by user, if not then the default based on codec_id will be used
michaelni's avatar
michaelni committed
930 931 932
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
933

934
    /**
935
     * workaround bugs in encoders which sometimes cannot be detected automatically.
936
     * - encoding: set by user
937
     * - decoding: set by user
938 939
     */
    int workaround_bugs;
940
#define FF_BUG_AUTODETECT       1  ///< autodetection
941 942 943 944
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
michael's avatar
michael committed
945
#define FF_BUG_AMV              32
946
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
michaelni's avatar
michaelni committed
947
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
948
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
949
#define FF_BUG_QPEL_CHROMA2     256
950
#define FF_BUG_DIRECT_BLOCKSIZE 512
951
#define FF_BUG_EDGE             1024
952
#define FF_BUG_HPEL_CHROMA      2048
953
#define FF_BUG_DC_CLIP          4096
954
#define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
955
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
956

957
    /**
958 959 960
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
961
     */
michaelni's avatar
 
michaelni committed
962
    int luma_elim_threshold;
963

964
    /**
965 966 967
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
968
     */
michaelni's avatar
 
michaelni committed
969
    int chroma_elim_threshold;
970

971
    /**
972 973 974
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
975 976
     */
    int strict_std_compliance;
977 978 979 980 981 982
#define FF_COMPLIANCE_VERY_STRICT   2 ///< strictly conform to a older more strict version of the spec or reference software
#define FF_COMPLIANCE_STRICT        1 ///< strictly conform to all the things in the spec no matter what consequences
#define FF_COMPLIANCE_NORMAL        0
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< allow inofficial extensions
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things

983
    /**
984
     * qscale offset between ip and b frames.
985 986
     * 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)
987 988
     * - encoding: set by user.
     * - decoding: unused
989 990
     */
    float b_quant_offset;
991

992
    /**
993
     * error resilience higher values will detect more errors but may missdetect
994 995 996
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
997
     */
michaelni's avatar
 
michaelni committed
998
    int error_resilience;
diego's avatar
diego committed
999
#define FF_ER_CAREFUL         1
1000 1001 1002
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1003

1004
    /**
michaelni's avatar
michaelni committed
1005 1006
     * 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
michael's avatar
michael committed
1007 1008
     * avcodec_align_dimensions() should be used to find the required width and
     * height, as they normally need to be rounded up to the next multiple of 16
1009 1010
     * - encoding: unused
     * - decoding: set by lavc, user can override
1011
     */
michaelni's avatar
michaelni committed
1012
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1013

1014
    /**
michaelni's avatar
michaelni committed
1015 1016 1017
     * 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
1018 1019
     * - encoding: unused
     * - decoding: set by lavc, user can override
1020
     */
michaelni's avatar
michaelni committed
1021
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1022

1023
    /**
1024 1025
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
1026
     * - decoding: set by lavc
1027 1028
     */
    int has_b_frames;
1029 1030 1031 1032 1033 1034

    /**
     * number of bytes per packet if constant and known or 0
     * used by some WAV based audio codecs
     */
    int block_align;
1035

1036
    int parse_only; /* - decoding only: if true, only parsing is done
1037 1038
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1039

1040
    /**
1041
     * 0-> h263 quant 1-> mpeg quant.
1042 1043
     * - encoding: set by user.
     * - decoding: unused
1044 1045
     */
    int mpeg_quant;
1046

1047
    /**
1048 1049 1050
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
1051
     */
1052
    char *stats_out;
1053

1054 1055 1056
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1057 1058
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1059 1060
     */
    char *stats_in;
1061

1062
    /**
1063
     * ratecontrol qmin qmax limiting method.
1064
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1065 1066
     * - encoding: set by user.
     * - decoding: unused
1067
     */
michaelni's avatar
michaelni committed
1068
    float rc_qsquish;
1069

michaelni's avatar
michaelni committed
1070 1071
    float rc_qmod_amp;
    int rc_qmod_freq;
1072

1073
    /**
1074 1075 1076
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1077
     */
michaelni's avatar
michaelni committed
1078 1079
    RcOverride *rc_override;
    int rc_override_count;
1080

1081
    /**
1082 1083 1084
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1085
     */
michaelni's avatar
michaelni committed
1086
    char *rc_eq;
1087

1088
    /**
1089 1090 1091
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1092
     */
michaelni's avatar
michaelni committed
1093
    int rc_max_rate;
1094

1095
    /**
1096 1097 1098
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1099
     */
michaelni's avatar
michaelni committed
1100
    int rc_min_rate;
1101

1102
    /**
1103 1104 1105
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1106
     */
michaelni's avatar
michaelni committed
1107 1108
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1109 1110

    /**
1111
     * qscale factor between p and i frames.
1112 1113
     * 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)
1114 1115
     * - encoding: set by user.
     * - decoding: unused
1116 1117
     */
    float i_quant_factor;
1118

1119
    /**
1120 1121 1122
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1123 1124
     */
    float i_quant_offset;
1125

1126
    /**
1127 1128 1129
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1130
     */
michaelni's avatar
michaelni committed
1131
    float rc_initial_cplx;
1132

1133
    /**
1134 1135 1136
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1137
     */
1138
    int dct_algo;
1139
#define FF_DCT_AUTO    0
1140
#define FF_DCT_FASTINT 1
1141 1142 1143
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1144
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1145
#define FF_DCT_FAAN    6
1146

1147
    /**
1148 1149 1150
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1151 1152
     */
    float lumi_masking;
1153

1154
    /**
1155 1156 1157
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1158 1159
     */
    float temporal_cplx_masking;
1160

1161
    /**
1162 1163 1164
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1165 1166
     */
    float spatial_cplx_masking;
1167

1168
    /**
1169 1170 1171
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1172 1173
     */
    float p_masking;
1174

1175
    /**
1176 1177 1178
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1179 1180
     */
    float dark_masking;
1181 1182


1183 1184
    /* for binary compatibility */
    int unused;
1185

1186
    /**
1187 1188 1189
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
     */
    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
1200
#define FF_IDCT_ALTIVEC      8
1201
#define FF_IDCT_SH4          9
1202
#define FF_IDCT_SIMPLEARM    10
1203
#define FF_IDCT_H264         11
1204
#define FF_IDCT_VP3          12
1205
#define FF_IDCT_IPP          13
michael's avatar
michael committed
1206
#define FF_IDCT_XVIDMMX      14
1207

1208
    /**
1209 1210 1211
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1212 1213 1214
     */
    int slice_count;
    /**
1215 1216 1217
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1218 1219 1220
     */
    int *slice_offset;

1221
    /**
1222 1223 1224
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1225 1226 1227 1228 1229
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1230
    /**
kabi's avatar
kabi committed
1231
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1232
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1233 1234 1235 1236 1237 1238
     *
     * 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;
1239
#define FF_MM_FORCE    0x80000000 /* force usage of selected flags (OR) */
kabi's avatar
kabi committed
1240 1241
    /* lower 16 bits - CPU features */
#ifdef HAVE_MMX
1242 1243 1244 1245 1246 1247
#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 */
#define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
kabi's avatar
kabi committed
1248
#endif /* HAVE_MMX */
1249
#ifdef HAVE_IWMMXT
1250
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1251
#endif /* HAVE_IWMMXT */
michaelni's avatar
michaelni committed
1252 1253

    /**
1254 1255 1256
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
michaelni's avatar
michaelni committed
1257 1258
     */
     int bits_per_sample;
1259

michaelni's avatar
michaelni committed
1260
    /**
1261 1262 1263
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
michaelni's avatar
michaelni committed
1264 1265 1266 1267 1268
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1269

michaelni's avatar
michaelni committed
1270
    /**
michael's avatar
michael committed
1271
     * sample aspect ratio (0 if unknown).
1272
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1273 1274
     * - encoding: set by user.
     * - decoding: set by lavc.
michaelni's avatar
michaelni committed
1275
     */
michael's avatar
michael committed
1276
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1277 1278

    /**
1279 1280 1281
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
michaelni's avatar
michaelni committed
1282
     */
michaelni's avatar
michaelni committed
1283
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1284 1285

    /**
1286 1287 1288
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
michaelni's avatar
michaelni committed
1289 1290 1291 1292 1293 1294 1295 1296
     */
    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
1297
#define FF_DEBUG_DCT_COEFF 0x00000040
michaelni's avatar
michaelni committed
1298 1299 1300
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1301
#define FF_DEBUG_ER        0x00000400
michaelni's avatar
michaelni committed
1302
#define FF_DEBUG_MMCO      0x00000800
michaelni's avatar
michaelni committed
1303
#define FF_DEBUG_BUGS      0x00001000
michael's avatar
michael committed
1304 1305
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1306

1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
    /**
     * 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

1317
    /**
1318 1319 1320
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1321 1322
     */
    uint64_t error[4];
1323

michaelni's avatar
michaelni committed
1324
    /**
1325
     * minimum MB quantizer.
1326
     * - encoding: unused
1327
     * - decoding: unused
michaelni's avatar
michaelni committed
1328 1329 1330 1331
     */
    int mb_qmin;

    /**
1332
     * maximum MB quantizer.
1333
     * - encoding: unused
1334
     * - decoding: unused
michaelni's avatar
michaelni committed
1335 1336
     */
    int mb_qmax;
1337

michaelni's avatar
michaelni committed
1338
    /**
1339 1340 1341
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1342 1343 1344
     */
    int me_cmp;
    /**
1345 1346 1347
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1348 1349 1350
     */
    int me_sub_cmp;
    /**
1351 1352 1353
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1354 1355
     */
    int mb_cmp;
michael's avatar
michael committed
1356 1357 1358 1359 1360 1361
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
michaelni's avatar
michaelni committed
1362 1363 1364 1365 1366 1367 1368 1369
#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
michael's avatar
michael committed
1370 1371
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1372
#define FF_CMP_NSSE 10
michael's avatar
michael committed
1373 1374
#define FF_CMP_W53  11
#define FF_CMP_W97  12
michael's avatar
michael committed
1375
#define FF_CMP_DCTMAX 13
1376
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1377
#define FF_CMP_CHROMA 256
1378

michaelni's avatar
michaelni committed
1379
    /**
1380 1381 1382
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1383 1384
     */
    int dia_size;
michaelni's avatar
michaelni committed
1385 1386

    /**
1387 1388 1389
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1390 1391
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1392

michaelni's avatar
michaelni committed
1393
    /**
1394 1395 1396
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1397 1398
     */
    int pre_me;
michaelni's avatar
michaelni committed
1399

michaelni's avatar
michaelni committed
1400
    /**
1401 1402 1403
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1404 1405
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1406

michaelni's avatar
michaelni committed
1407
    /**
1408 1409 1410
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1411 1412 1413
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1414
    /**
1415 1416 1417
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1418 1419 1420
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1421
    /**
1422
     * callback to negotiate the pixelFormat.
michaelni's avatar
michaelni committed
1423 1424 1425 1426
     * @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
1427 1428
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
michaelni's avatar
michaelni committed
1429
     */
iive's avatar
iive committed
1430
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1431 1432 1433 1434 1435

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
1436
     *
1437
     * - encoding: unused.
1438
     * - decoding: set by decoder
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
     */
    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

1449 1450 1451
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
1452
     *
1453 1454
     * - encoding: set by user.
     * - decoding: unused.
1455
     */
kabi's avatar
kabi committed
1456
    int me_range;
1457

michaelni's avatar
michaelni committed
1458 1459 1460 1461 1462 1463 1464
    /**
     * intra quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1465

michaelni's avatar
michaelni committed
1466 1467 1468 1469 1470 1471
    /**
     * inter quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_quant_bias;
1472 1473 1474 1475 1476 1477 1478 1479

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

1481
    /**
1482
     * internal_buffer count.
diego's avatar
diego committed
1483
     * Don't touch, used by lavc default_get_buffer()
1484 1485
     */
    int internal_buffer_count;
1486

1487
    /**
1488
     * internal_buffers.
diego's avatar
diego committed
1489
     * Don't touch, used by lavc default_get_buffer()
1490 1491
     */
    void *internal_buffer;
1492 1493 1494 1495 1496 1497 1498

#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
michaelni's avatar
michaelni committed
1499 1500 1501 1502 1503 1504 1505
    /**
     * 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;
1506

michaelni's avatar
michaelni committed
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
#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;
1522 1523 1524 1525 1526 1527 1528 1529
#if 0
    /**
     *
     * - encoding: unused
     * - decoding: set by user.
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1530

1531 1532 1533 1534 1535 1536 1537 1538 1539 1540
    /**
     * 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)

iive's avatar
iive committed
1541 1542 1543 1544 1545 1546
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1547

1548 1549 1550 1551 1552 1553 1554 1555 1556
    /**
     * 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
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570

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

1572 1573 1574 1575 1576 1577 1578
    /**
     * 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;
michaelni's avatar
michaelni committed
1579 1580 1581 1582 1583 1584 1585 1586

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1601 1602 1603 1604 1605 1606 1607

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1608 1609 1610 1611 1612 1613 1614

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1615

1616
    /**
1617 1618 1619 1620 1621
     * 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().
1622
     * - encoding: unused
1623
     * - decoding: set by lavc, user can override
1624
     */
1625
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646

    /**
     * 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;
michael's avatar
michael committed
1647 1648 1649 1650 1651 1652 1653

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
1654

1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
    /**
     * 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
michael's avatar
michael committed
1665 1666 1667 1668 1669 1670
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1671 1672 1673 1674 1675 1676 1677 1678

    /**
     * Thread count.
     * is used to decide how many independant tasks should be passed to execute()
     * - encoding: set by user
     * - decoding: set by user
     */
    int thread_count;
1679

1680 1681 1682 1683
    /**
     * the codec may call this to execute several independant things. it will return only after
     * finishing all tasks, the user may replace this with some multithreaded implementation, the
     * default implementation will execute the parts serially
michael's avatar
michael committed
1684
     * @param count the number of things to execute
1685 1686 1687 1688
     * - encoding: set by lavc, user can override
     * - decoding: set by lavc, user can override
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1689

1690 1691 1692 1693 1694 1695 1696
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1697 1698

    /**
1699
     * Motion estimation threshold. under which no motion estimation is
1700
     * performed, but instead the user specified motion vectors are used
1701
     *
1702
     * - encoding: set by user
1703
     * - decoding: unused
1704
     */
michael's avatar
michael committed
1705
     int me_threshold;
1706 1707 1708 1709 1710 1711 1712

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

    /**
michael's avatar
michael committed
1715
     * precision of the intra dc coefficient - 8.
1716 1717 1718 1719
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1720 1721 1722 1723 1724 1725 1726

    /**
     * noise vs. sse weight for the nsse comparsion function.
     * - encoding: set by user
     * - decoding: unused
     */
     int nsse_weight;
1727 1728

    /**
1729
     * number of macroblock rows at the top which are skipped.
1730 1731 1732 1733 1734 1735
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
1736
     * number of macroblock rows at the bottom which are skipped.
1737 1738 1739 1740
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
michael's avatar
michael committed
1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756

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

    /**
     * level
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1757 1758 1759 1760 1761 1762 1763

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

    /**
michael's avatar
michael committed
1766
     * bitsream width / height. may be different from width/height if lowres
1767 1768 1769 1770 1771
     * or other things are used
     * - encoding: unused
     * - decoding: set by user before init if known, codec should override / dynamically change if needed
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785

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

    /**
     * frame skip factor
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799

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

    /**
     * frame skip comparission function
     * - encoding: set by user.
     * - decoding: unused
     */
    int frame_skip_cmp;
1800 1801 1802 1803 1804 1805 1806 1807

    /**
     * border processing masking. raises the quantizer for mbs on the borders
     * of the picture.
     * - encoding: set by user
     * - decoding: unused
     */
    float border_masking;
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821

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

    /**
     * maximum MB lagrange multipler.
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_lmax;
1822 1823

    /**
1824
     *
1825 1826 1827 1828
     * - encoding: set by user.
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1829 1830

    /**
1831
     *
michael's avatar
michael committed
1832 1833 1834 1835 1836 1837
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_loop_filter;

    /**
1838
     *
michael's avatar
michael committed
1839 1840 1841 1842 1843 1844
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_idct;

    /**
1845
     *
michael's avatar
michael committed
1846 1847 1848 1849
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
1850 1851 1852 1853 1854 1855 1856

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int bidir_refine;
1857 1858 1859 1860 1861 1862 1863

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int brd_scale;
lorenm's avatar
lorenm committed
1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 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

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
     * - encoding: set by user.
     * - decoding: unused
     */
    int crf;

    /**
     * constant quantization parameter rate control method
     * - encoding: set by user.
     * - decoding: unused
     */
    int cqp;

    /**
     * minimum gop size
     * - encoding: set by user.
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
     * - encoding: set by user.
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
     * - encoding: set by user.
     * - decoding: unused
     */
    int chromaoffset;

    /**
     * influences how often b-frames are used
     * - encoding: set by user.
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
     * - encoding: set by user.
     * - decoding: unused
     */
    int trellis;

    /**
     * reduce fluctuations in qp (before curve compression)
     * - encoding: set by user.
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
     * - encoding: set by user.
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
     * - encoding: set by user.
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
     * - encoding: set by user.
     * - decoding: unused
     */
    int partitions;
#define X264_PART_I4X4 0x001  /* Analyse i4x4 */
#define X264_PART_I8X8 0x002  /* Analyse i8x8 (requires 8x8 transform) */
#define X264_PART_P8X8 0x010  /* Analyse p16x8, p8x16 and p8x8 */
#define X264_PART_P4X4 0x020  /* Analyse p8x4, p4x8, p4x4 */
#define X264_PART_B8X8 0x100  /* Analyse b16x8, b8x16 and b8x8 */

    /**
     * direct mv prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: set by user.
     * - decoding: unused
     */
    int directpred;
1955

1956 1957 1958 1959 1960 1961
    /**
     * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
     * - encoding: set by user.
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
1962 1963 1964 1965 1966 1967 1968

    /**
     * multiplied by qscale for each frame and added to scene_change_score
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_factor;
glantau's avatar
glantau committed
1969 1970
} AVCodecContext;

1971 1972 1973
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
1974
typedef struct AVCodec {
kabi's avatar
kabi committed
1975
    const char *name;
kabi's avatar
kabi committed
1976
    enum CodecType type;
michael's avatar
michael committed
1977
    enum CodecID id;
glantau's avatar
glantau committed
1978 1979
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
1980
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
1981
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
1982
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
kabi's avatar
kabi committed
1983
                  uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
1984
    int capabilities;
michael's avatar
michael committed
1985
#if LIBAVCODEC_VERSION_INT < ((50<<16)+(0<<8)+0)
1986
    void *dummy; // FIXME remove next time we break binary compatibility
michael's avatar
michael committed
1987
#endif
glantau's avatar
glantau committed
1988
    struct AVCodec *next;
michaelni's avatar
michaelni committed
1989
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
1990
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
1991
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
1992 1993
} AVCodec;

kabi's avatar
kabi committed
1994
/**
1995 1996 1997
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
1998
typedef struct AVPicture {
kabi's avatar
kabi committed
1999
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2000
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2001 2002
} AVPicture;

tmmm's avatar
tmmm committed
2003 2004 2005 2006 2007
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
 */
2008
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2009
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2010 2011 2012 2013 2014 2015
typedef struct AVPaletteControl {

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

2016 2017 2018 2019
    /* 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 */
2020
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2021 2022 2023

} AVPaletteControl;

2024
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2025 2026 2027 2028 2029 2030 2031 2032
    uint16_t x;
    uint16_t y;
    uint16_t w;
    uint16_t h;
    uint16_t nb_colors;
    int linesize;
    uint32_t *rgba_palette;
    uint8_t *bitmap;
2033 2034 2035 2036 2037 2038 2039 2040
} AVSubtitleRect;

typedef struct AVSubtitle {
    uint16_t format; /* 0 = graphics */
    uint32_t start_display_time; /* relative to packet pts, in ms */
    uint32_t end_display_time; /* relative to packet pts, in ms */
    uint32_t num_rects;
    AVSubtitleRect *rects;
bellard's avatar
bellard committed
2041 2042
} AVSubtitle;

glantau's avatar
glantau committed
2043 2044
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
2045
extern AVCodec mp3lame_encoder;
michaelni's avatar
 
michaelni committed
2046
extern AVCodec oggvorbis_encoder;
michael's avatar
michael committed
2047
extern AVCodec oggtheora_encoder;
2048
extern AVCodec faac_encoder;
2049
extern AVCodec xvid_encoder;
glantau's avatar
glantau committed
2050
extern AVCodec mpeg1video_encoder;
michaelni's avatar
michaelni committed
2051
extern AVCodec mpeg2video_encoder;
2052
extern AVCodec h261_encoder;
glantau's avatar
glantau committed
2053 2054
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
2055
extern AVCodec flv_encoder;
glantau's avatar
glantau committed
2056
extern AVCodec rv10_encoder;
michael's avatar
michael committed
2057
extern AVCodec rv20_encoder;
romansh's avatar
 
romansh committed
2058
extern AVCodec dvvideo_encoder;
glantau's avatar
glantau committed
2059
extern AVCodec mjpeg_encoder;
2060
extern AVCodec ljpeg_encoder;
2061
extern AVCodec jpegls_encoder;
2062
extern AVCodec png_encoder;
2063 2064 2065 2066 2067
extern AVCodec ppm_encoder;
extern AVCodec pgm_encoder;
extern AVCodec pgmyuv_encoder;
extern AVCodec pbm_encoder;
extern AVCodec pam_encoder;
glantau's avatar
glantau committed
2068
extern AVCodec mpeg4_encoder;
2069 2070 2071
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
michaelni's avatar
 
michaelni committed
2072 2073
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
michaelni's avatar
michaelni committed
2074
extern AVCodec huffyuv_encoder;
lorenm's avatar
lorenm committed
2075
extern AVCodec ffvhuff_encoder;
michaelni's avatar
michaelni committed
2076
extern AVCodec h264_encoder;
michaelni's avatar
michaelni committed
2077
extern AVCodec asv1_encoder;
michaelni's avatar
michaelni committed
2078
extern AVCodec asv2_encoder;
michaelni's avatar
michaelni committed
2079
extern AVCodec vcr1_encoder;
2080
extern AVCodec ffv1_encoder;
michael's avatar
michael committed
2081
extern AVCodec snow_encoder;
2082
extern AVCodec mdec_encoder;
rtognimp's avatar
rtognimp committed
2083
extern AVCodec zlib_encoder;
2084 2085
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
2086
extern AVCodec svq1_encoder;
2087
extern AVCodec x264_encoder;
glantau's avatar
glantau committed
2088 2089

extern AVCodec h263_decoder;
2090
extern AVCodec h261_decoder;
glantau's avatar
glantau committed
2091
extern AVCodec mpeg4_decoder;
2092 2093 2094
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
michaelni's avatar
michaelni committed
2095
extern AVCodec wmv1_decoder;
michaelni's avatar
 
michaelni committed
2096
extern AVCodec wmv2_decoder;
2097 2098
extern AVCodec vc9_decoder;
extern AVCodec wmv3_decoder;
michaelni's avatar
michaelni committed
2099 2100
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
iive's avatar
iive committed
2101
extern AVCodec mpegvideo_decoder;
iive's avatar
iive committed
2102
extern AVCodec mpeg_xvmc_decoder;
glantau's avatar
glantau committed
2103
extern AVCodec h263i_decoder;
2104
extern AVCodec flv_decoder;
glantau's avatar
glantau committed
2105
extern AVCodec rv10_decoder;
michael's avatar
michael committed
2106
extern AVCodec rv20_decoder;
michael's avatar
michael committed
2107 2108
extern AVCodec rv30_decoder;
extern AVCodec rv40_decoder;
nickols_k's avatar
nickols_k committed
2109
extern AVCodec svq1_decoder;
michaelni's avatar
michaelni committed
2110
extern AVCodec svq3_decoder;
bellard's avatar
bellard committed
2111
extern AVCodec dvvideo_decoder;
bellard's avatar
bellard committed
2112 2113
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
glantau's avatar
glantau committed
2114
extern AVCodec mjpeg_decoder;
al3x's avatar
al3x committed
2115
extern AVCodec mjpegb_decoder;
alex's avatar
alex committed
2116
extern AVCodec sp5x_decoder;
2117
extern AVCodec png_decoder;
2118
extern AVCodec mp2_decoder;
glantau's avatar
glantau committed
2119
extern AVCodec mp3_decoder;
rtognimp's avatar
rtognimp committed
2120
extern AVCodec mp3adu_decoder;
2121
extern AVCodec mp3on4_decoder;
rtognimp's avatar
rtognimp committed
2122
extern AVCodec qdm2_decoder;
2123
extern AVCodec cook_decoder;
2124
extern AVCodec truespeech_decoder;
2125
extern AVCodec tta_decoder;
2126 2127
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
michaelni's avatar
michaelni committed
2128
extern AVCodec huffyuv_decoder;
lorenm's avatar
lorenm committed
2129
extern AVCodec ffvhuff_decoder;
kabi's avatar
kabi committed
2130
extern AVCodec oggvorbis_decoder;
michael's avatar
michael committed
2131
extern AVCodec oggtheora_decoder;
2132
extern AVCodec cyuv_decoder;
michaelni's avatar
michaelni committed
2133
extern AVCodec h264_decoder;
tmmm's avatar
tmmm committed
2134
extern AVCodec indeo3_decoder;
tmmm's avatar
tmmm committed
2135
extern AVCodec vp3_decoder;
2136
extern AVCodec theora_decoder;
2137
extern AVCodec amr_nb_decoder;
kabi's avatar
kabi committed
2138
extern AVCodec amr_nb_encoder;
2139 2140
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
2141 2142
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
michaelni's avatar
michaelni committed
2143
extern AVCodec asv1_decoder;
michaelni's avatar
michaelni committed
2144
extern AVCodec asv2_decoder;
michaelni's avatar
michaelni committed
2145
extern AVCodec vcr1_decoder;
al3x's avatar
al3x committed
2146
extern AVCodec cljr_decoder;
2147
extern AVCodec ffv1_decoder;
michael's avatar
michael committed
2148
extern AVCodec snow_decoder;
michaelni's avatar
michaelni committed
2149
extern AVCodec fourxm_decoder;
2150
extern AVCodec mdec_decoder;
2151 2152
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
2153
extern AVCodec xan_wc3_decoder;
2154 2155 2156 2157
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
tmmm's avatar
tmmm committed
2158
extern AVCodec vqa_decoder;
tmmm's avatar
tmmm committed
2159
extern AVCodec idcin_decoder;
rtognimp's avatar
rtognimp committed
2160
extern AVCodec eightbps_decoder;
2161
extern AVCodec smc_decoder;
melanson's avatar
melanson committed
2162
extern AVCodec flic_decoder;
2163 2164
extern AVCodec vmdvideo_decoder;
extern AVCodec vmdaudio_decoder;
2165
extern AVCodec truemotion1_decoder;
2166
extern AVCodec truemotion2_decoder;
rtognimp's avatar
rtognimp committed
2167 2168
extern AVCodec mszh_decoder;
extern AVCodec zlib_decoder;
2169 2170
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
2171 2172
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
2173
extern AVCodec xan_dpcm_decoder;
2174
extern AVCodec sol_dpcm_decoder;
2175
extern AVCodec sonic_decoder;
2176
extern AVCodec qtrle_decoder;
michael's avatar
michael committed
2177
extern AVCodec flac_decoder;
2178
extern AVCodec tscc_decoder;
2179
extern AVCodec cscd_decoder;
2180
extern AVCodec nuv_decoder;
2181
extern AVCodec ulti_decoder;
2182
extern AVCodec qdraw_decoder;
2183
extern AVCodec xl_decoder;
2184
extern AVCodec qpeg_decoder;
2185
extern AVCodec shorten_decoder;
2186
extern AVCodec loco_decoder;
2187
extern AVCodec wnv1_decoder;
2188
extern AVCodec aasc_decoder;
2189
extern AVCodec alac_decoder;
2190
extern AVCodec ws_snd1_decoder;
2191
extern AVCodec indeo2_decoder;
2192
extern AVCodec vorbis_decoder;
2193
extern AVCodec fraps_decoder;
2194 2195
extern AVCodec libgsm_encoder;
extern AVCodec libgsm_decoder;
mru's avatar
mru committed
2196
extern AVCodec bmp_decoder;
2197
extern AVCodec mmvideo_decoder;
2198
extern AVCodec zmbv_decoder;
2199
extern AVCodec avs_decoder;
kostya's avatar
kostya committed
2200 2201
extern AVCodec smacker_decoder;
extern AVCodec smackaud_decoder;
glantau's avatar
glantau committed
2202

glantau's avatar
glantau committed
2203 2204 2205
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
2206
extern AVCodec name ## _encoder
glantau's avatar
glantau committed
2207

2208 2209 2210 2211 2212 2213 2214 2215 2216
PCM_CODEC(CODEC_ID_PCM_S32LE, pcm_s32le);
PCM_CODEC(CODEC_ID_PCM_S32BE, pcm_s32be);
PCM_CODEC(CODEC_ID_PCM_U32LE, pcm_u32le);
PCM_CODEC(CODEC_ID_PCM_U32BE, pcm_u32be);
PCM_CODEC(CODEC_ID_PCM_S24LE, pcm_s24le);
PCM_CODEC(CODEC_ID_PCM_S24BE, pcm_s24be);
PCM_CODEC(CODEC_ID_PCM_U24LE, pcm_u24le);
PCM_CODEC(CODEC_ID_PCM_U24BE, pcm_u24be);
PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
glantau's avatar
glantau committed
2217 2218 2219 2220 2221 2222 2223 2224 2225
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);

2226 2227 2228 2229
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2230 2231
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2232
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2233
PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2234
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
michaelni's avatar
michaelni committed
2235
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2236 2237
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2238
PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
romansh's avatar
 
romansh committed
2239
PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2240
PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2241
PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2242
PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2243 2244 2245
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_4, adpcm_sbpro_4);
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_3, adpcm_sbpro_3);
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
2246

glantau's avatar
glantau committed
2247 2248 2249
#undef PCM_CODEC

/* dummy raw video codec */
romansh's avatar
 
romansh committed
2250 2251
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
glantau's avatar
glantau committed
2252 2253 2254

/* the following codecs use external GPL libs */
extern AVCodec ac3_decoder;
2255
extern AVCodec dts_decoder;
glantau's avatar
glantau committed
2256

bellard's avatar
bellard committed
2257
/* subtitles */
2258
extern AVCodec dvdsub_encoder;
bellard's avatar
bellard committed
2259 2260
extern AVCodec dvdsub_decoder;
extern AVCodec dvbsub_encoder;
2261
extern AVCodec dvbsub_decoder;
bellard's avatar
bellard committed
2262

glantau's avatar
glantau committed
2263 2264 2265
/* resample.c */

struct ReSampleContext;
2266
struct AVResampleContext;
glantau's avatar
glantau committed
2267 2268 2269

typedef struct ReSampleContext ReSampleContext;

2270
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2271 2272 2273 2274
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

michael's avatar
michael committed
2275
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2276
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
michael's avatar
michael committed
2277
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2278
void av_resample_close(struct AVResampleContext *c);
2279

glantau's avatar
glantau committed
2280 2281 2282 2283 2284 2285 2286 2287
/* 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);
2288 2289 2290 2291

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2292 2293 2294 2295
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2296

2297
void img_resample(ImgReSampleContext *s,
2298
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2299 2300 2301

void img_resample_close(ImgReSampleContext *s);

michael's avatar
michael committed
2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315
/**
 * 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);

kabi's avatar
kabi committed
2316
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2317
                   int pix_fmt, int width, int height);
2318
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2319
                     unsigned char *dest, int dest_size);
2320
int avpicture_get_size(int pix_fmt, int width, int height);
2321 2322
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);
2323
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2324
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2325
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2326

2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338
#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);

bellard's avatar
bellard committed
2339 2340
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2341
int img_get_alpha_info(const AVPicture *src,
2342
                       int pix_fmt, int width, int height);
bellard's avatar
bellard committed
2343

2344 2345
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
2346
                const AVPicture *src, int pix_fmt,
2347 2348 2349
                int width, int height);

/* deinterlace a picture */
2350
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2351 2352 2353 2354 2355 2356
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

nickols_k's avatar
nickols_k committed
2357
/* returns LIBAVCODEC_VERSION_INT constant */
2358
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2359
/* returns LIBAVCODEC_BUILD constant */
2360
unsigned avcodec_build(void);
glantau's avatar
glantau committed
2361 2362 2363 2364
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
2365
AVCodec *avcodec_find_encoder_by_name(const char *name);
glantau's avatar
glantau committed
2366 2367 2368 2369
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);

michaelni's avatar
michaelni committed
2370
void avcodec_get_context_defaults(AVCodecContext *s);
mellum's avatar
mellum committed
2371
AVCodecContext *avcodec_alloc_context(void);
mellum's avatar
mellum committed
2372
void avcodec_get_frame_defaults(AVFrame *pic);
michaelni's avatar
michaelni committed
2373
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
2374

michaelni's avatar
michaelni committed
2375 2376
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2377 2378
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2379
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
michael's avatar
michael committed
2380
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
michaelni's avatar
michaelni committed
2381

michael's avatar
1l  
michael committed
2382 2383 2384
int avcodec_thread_init(AVCodecContext *s, int thread_count);
void avcodec_thread_free(AVCodecContext *s);
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
michael's avatar
michael committed
2385
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2386 2387
//FIXME func typedef

michaelni's avatar
michaelni committed
2388 2389 2390 2391
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
glantau's avatar
glantau committed
2392
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2393

2394
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
glantau's avatar
glantau committed
2395
                         int *frame_size_ptr,
kabi's avatar
kabi committed
2396
                         uint8_t *buf, int buf_size);
2397
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
glantau's avatar
glantau committed
2398
                         int *got_picture_ptr,
kabi's avatar
kabi committed
2399
                         uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2400 2401 2402
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2403
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2404
                        int *data_size_ptr,
kabi's avatar
kabi committed
2405
                        uint8_t *buf, int buf_size);
2406
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
glantau's avatar
glantau committed
2407
                         const short *samples);
2408
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
michaelni's avatar
michaelni committed
2409
                         const AVFrame *pict);
2410
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
bellard's avatar
bellard committed
2411
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2412 2413 2414 2415

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
glantau's avatar
glantau committed
2416

michaelni's avatar
michaelni committed
2417 2418
void avcodec_flush_buffers(AVCodecContext *avctx);

2419 2420
void avcodec_default_free_buffers(AVCodecContext *s);

2421
/* misc usefull functions */
michaelni's avatar
michaelni committed
2422 2423 2424 2425 2426 2427

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

2428

bellard's avatar
bellard committed
2429 2430 2431 2432 2433
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2434
    int64_t cur_offset; /* current offset
bellard's avatar
bellard committed
2435 2436 2437 2438 2439
                           (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 */
bellard's avatar
bellard committed
2440 2441 2442 2443 2444 2445
    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;
michael's avatar
michael committed
2446
    int fetch_timestamp;
bellard's avatar
bellard committed
2447 2448 2449 2450 2451 2452

#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];
2453

michael's avatar
michael committed
2454 2455
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
bellard's avatar
bellard committed
2456 2457 2458
} AVCodecParserContext;

typedef struct AVCodecParser {
michael's avatar
michael committed
2459
    int codec_ids[5]; /* several codec IDs are permitted */
bellard's avatar
bellard committed
2460 2461
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2462
    int (*parser_parse)(AVCodecParserContext *s,
bellard's avatar
bellard committed
2463
                        AVCodecContext *avctx,
2464
                        uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2465 2466
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2467
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2468 2469 2470 2471 2472 2473 2474
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2475
int av_parser_parse(AVCodecParserContext *s,
bellard's avatar
bellard committed
2476
                    AVCodecContext *avctx,
2477
                    uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2478 2479
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2480 2481
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2482
                     uint8_t **poutbuf, int *poutbuf_size,
2483
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2484 2485 2486 2487
void av_parser_close(AVCodecParserContext *s);

extern AVCodecParser mpegvideo_parser;
extern AVCodecParser mpeg4video_parser;
2488
extern AVCodecParser h261_parser;
bellard's avatar
bellard committed
2489 2490
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
michael's avatar
michael committed
2491
extern AVCodecParser mjpeg_parser;
michael's avatar
michael committed
2492
extern AVCodecParser pnm_parser;
bellard's avatar
bellard committed
2493 2494
extern AVCodecParser mpegaudio_parser;
extern AVCodecParser ac3_parser;
bellard's avatar
bellard committed
2495
extern AVCodecParser dvdsub_parser;
2496
extern AVCodecParser dvbsub_parser;
mru's avatar
mru committed
2497
extern AVCodecParser aac_parser;
bellard's avatar
bellard committed
2498

bellard's avatar
bellard committed
2499
/* memory */
2500
void *av_malloc(unsigned int size);
kabi's avatar
kabi committed
2501
void *av_mallocz(unsigned int size);
2502
void *av_realloc(void *ptr, unsigned int size);
bellard's avatar
bellard committed
2503
void av_free(void *ptr);
2504
char *av_strdup(const char *s);
michael's avatar
michael committed
2505
void av_freep(void *ptr);
kabi's avatar
kabi committed
2506
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2507 2508
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2509
void av_free_static(void);
2510
void *av_mallocz_static(unsigned int size);
2511
void *av_realloc_static(void *ptr, unsigned int size);
bellard's avatar
bellard committed
2512

2513 2514 2515
/* add by bero : in adx.c */
int is_adx(const unsigned char *buf,size_t bufsize);

2516 2517 2518
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2519 2520 2521
int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

2522 2523 2524 2525
/* av_log API */

#include <stdarg.h>

2526
#define AV_LOG_QUIET -1
2527 2528 2529 2530
#define AV_LOG_ERROR 0
#define AV_LOG_INFO 1
#define AV_LOG_DEBUG 2

2531
#ifdef __GNUC__
2532
extern void av_log(void*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
2533 2534 2535 2536
#else
extern void av_log(void*, int level, const char *fmt, ...);
#endif

2537
extern void av_vlog(void*, int level, const char *fmt, va_list);
2538 2539
extern int av_log_get_level(void);
extern void av_log_set_level(int);
2540
extern void av_log_set_callback(void (*)(void*, int, const char*, va_list));
2541

2542
/* endian macros */
2543
#if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553
#define BE_16(x)  ((((uint8_t*)(x))[0] << 8) | ((uint8_t*)(x))[1])
#define BE_32(x)  ((((uint8_t*)(x))[0] << 24) | \
                   (((uint8_t*)(x))[1] << 16) | \
                   (((uint8_t*)(x))[2] << 8) | \
                    ((uint8_t*)(x))[3])
#define LE_16(x)  ((((uint8_t*)(x))[1] << 8) | ((uint8_t*)(x))[0])
#define LE_32(x)  ((((uint8_t*)(x))[3] << 24) | \
                   (((uint8_t*)(x))[2] << 16) | \
                   (((uint8_t*)(x))[1] << 8) | \
                    ((uint8_t*)(x))[0])
2554
#endif
2555

mru's avatar
mru committed
2556 2557
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

kabi's avatar
kabi committed
2558 2559 2560 2561
#ifdef __cplusplus
}
#endif

glantau's avatar
glantau committed
2562
#endif /* AVCODEC_H */