avcodec.h 77.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * copyright (c) 2001 Fabrice Bellard
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

glantau's avatar
glantau committed
19 20 21
#ifndef AVCODEC_H
#define AVCODEC_H

michaelni's avatar
michaelni committed
22 23
/**
 * @file avcodec.h
michaelni's avatar
doxy  
michaelni committed
24
 * external api header.
michaelni's avatar
michaelni committed
25 26 27
 */


kabi's avatar
kabi committed
28 29 30 31
#ifdef __cplusplus
extern "C" {
#endif

32
#include "avutil.h"
kabi's avatar
kabi committed
33
#include <sys/types.h> /* size_t */
glantau's avatar
glantau committed
34

35
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
bellard's avatar
bellard committed
36
#define AV_TOSTRING(s) #s
michael's avatar
michael committed
37

38 39
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(16<<8)+0)
#define LIBAVCODEC_VERSION      51.16.0
40
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
41

42
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
al3x's avatar
al3x committed
43

44 45 46
#define AV_NOPTS_VALUE          int64_t_C(0x8000000000000000)
#define AV_TIME_BASE            1000000
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
47

glantau's avatar
glantau committed
48
enum CodecID {
49
    CODEC_ID_NONE,
glantau's avatar
glantau committed
50
    CODEC_ID_MPEG1VIDEO,
51
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
iive's avatar
iive committed
52
    CODEC_ID_MPEG2VIDEO_XVMC,
53
    CODEC_ID_H261,
glantau's avatar
glantau committed
54 55
    CODEC_ID_H263,
    CODEC_ID_RV10,
michael's avatar
michael committed
56
    CODEC_ID_RV20,
glantau's avatar
glantau committed
57
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
58
    CODEC_ID_MJPEGB,
59
    CODEC_ID_LJPEG,
alex's avatar
alex committed
60
    CODEC_ID_SP5X,
61
    CODEC_ID_JPEGLS,
glantau's avatar
glantau committed
62
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
63
    CODEC_ID_RAWVIDEO,
64 65 66
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
67
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
68
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
69 70
    CODEC_ID_H263P,
    CODEC_ID_H263I,
71
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
72
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
73
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
74
    CODEC_ID_DVVIDEO,
michaelni's avatar
michaelni committed
75
    CODEC_ID_HUFFYUV,
76
    CODEC_ID_CYUV,
michaelni's avatar
michaelni committed
77
    CODEC_ID_H264,
tmmm's avatar
tmmm committed
78
    CODEC_ID_INDEO3,
tmmm's avatar
tmmm committed
79
    CODEC_ID_VP3,
80
    CODEC_ID_THEORA,
michaelni's avatar
michaelni committed
81
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
82
    CODEC_ID_ASV2,
83
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
84
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
85
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
86
    CODEC_ID_CLJR,
87
    CODEC_ID_MDEC,
88 89
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
90 91
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
92 93 94 95 96
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
97
    CODEC_ID_IDCIN,
rtognimp's avatar
rtognimp committed
98
    CODEC_ID_8BPS,
99
    CODEC_ID_SMC,
melanson's avatar
melanson committed
100
    CODEC_ID_FLIC,
101
    CODEC_ID_TRUEMOTION1,
102
    CODEC_ID_VMDVIDEO,
rtognimp's avatar
rtognimp committed
103 104
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
105
    CODEC_ID_QTRLE,
michael's avatar
michael committed
106
    CODEC_ID_SNOW,
107
    CODEC_ID_TSCC,
108
    CODEC_ID_ULTI,
109
    CODEC_ID_QDRAW,
110
    CODEC_ID_VIXL,
111
    CODEC_ID_QPEG,
112 113 114 115 116 117 118
    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
119
    CODEC_ID_FFVHUFF,
michael's avatar
michael committed
120 121
    CODEC_ID_RV30,
    CODEC_ID_RV40,
122
    CODEC_ID_VC1,
123
    CODEC_ID_WMV3,
124
    CODEC_ID_LOCO,
125
    CODEC_ID_WNV1,
126
    CODEC_ID_AASC,
127
    CODEC_ID_INDEO2,
128
    CODEC_ID_FRAPS,
129
    CODEC_ID_TRUEMOTION2,
mru's avatar
mru committed
130
    CODEC_ID_BMP,
131
    CODEC_ID_CSCD,
132
    CODEC_ID_MMVIDEO,
133
    CODEC_ID_ZMBV,
134
    CODEC_ID_AVS,
kostya's avatar
kostya committed
135
    CODEC_ID_SMACKVIDEO,
136
    CODEC_ID_NUV,
137
    CODEC_ID_KMVC,
138
    CODEC_ID_FLASHSV,
139
    CODEC_ID_CAVS,
140
    CODEC_ID_JPEG2000,
kostya's avatar
kostya committed
141
    CODEC_ID_VMNC,
aurel's avatar
aurel committed
142 143 144
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
glantau's avatar
glantau committed
145 146

    /* various pcm "codecs" */
147
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
148 149 150 151 152 153 154
    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,
155 156 157 158 159 160 161 162 163
    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,
164 165

    /* various adpcm codecs */
166
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
167
    CODEC_ID_ADPCM_IMA_WAV,
168 169
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
170
    CODEC_ID_ADPCM_IMA_WS,
171
    CODEC_ID_ADPCM_IMA_SMJPEG,
172
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
173
    CODEC_ID_ADPCM_4XM,
174 175
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
176
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
177
    CODEC_ID_ADPCM_G726,
178
    CODEC_ID_ADPCM_CT,
179
    CODEC_ID_ADPCM_SWF,
180
    CODEC_ID_ADPCM_YAMAHA,
181 182 183
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
184

185 186
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
187 188
    CODEC_ID_AMR_WB,

189
    /* RealAudio codecs*/
190
    CODEC_ID_RA_144= 0x13000,
191
    CODEC_ID_RA_288,
192 193

    /* various DPCM codecs */
194
    CODEC_ID_ROQ_DPCM= 0x14000,
195
    CODEC_ID_INTERPLAY_DPCM,
196
    CODEC_ID_XAN_DPCM,
197
    CODEC_ID_SOL_DPCM,
198

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
    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
214
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
215
    CODEC_ID_MP3ADU,
216
    CODEC_ID_MP3ON4,
217
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
218
    CODEC_ID_ALAC,
219
    CODEC_ID_WESTWOOD_SND1,
220
    CODEC_ID_GSM,
rtognimp's avatar
rtognimp committed
221
    CODEC_ID_QDM2,
222
    CODEC_ID_COOK,
223
    CODEC_ID_TRUESPEECH,
224
    CODEC_ID_TTA,
kostya's avatar
kostya committed
225
    CODEC_ID_SMACKAUDIO,
banan's avatar
banan committed
226
    CODEC_ID_QCELP,
kostya's avatar
kostya committed
227
    CODEC_ID_WAVPACK,
228

bellard's avatar
bellard committed
229
    /* subtitle codecs */
230 231 232
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,

233
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
234
                         stream (only used by libavformat) */
glantau's avatar
glantau committed
235
};
236 237 238

/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
glantau's avatar
glantau committed
239 240

enum CodecType {
241
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
242 243
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
244
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
245
    CODEC_TYPE_SUBTITLE,
glantau's avatar
glantau committed
246 247
};

glantau's avatar
glantau committed
248
/* currently unused, may be used if 24/32 bits samples ever supported */
249
/* all in native endian */
glantau's avatar
glantau committed
250
enum SampleFormat {
mru's avatar
mru committed
251
    SAMPLE_FMT_NONE = -1,
252 253 254
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
255
    SAMPLE_FMT_S32,             ///< signed 32 bits
256
    SAMPLE_FMT_FLT,             ///< float
glantau's avatar
glantau committed
257 258
};

glantau's avatar
glantau committed
259
/* in bytes */
260
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
261

262
/**
263
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
264
 * this is mainly needed because some optimized bitstream readers read
265 266 267
 * 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
268 269 270
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

271 272 273 274 275 276
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

277 278
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
279
    ME_ZERO = 1,
280 281 282 283
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
284 285 286 287
    ME_X1,
    ME_HEX,
    ME_UMH,
    ME_ITER,
288 289
};

michael's avatar
michael committed
290 291 292 293 294 295 296 297 298 299
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
300 301 302 303 304 305 306
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;

307
#define FF_MAX_B_FRAMES 16
308

michaelni's avatar
michaelni committed
309
/* encoding support
310
   these flags can be passed in AVCodecContext.flags before initing
diego's avatar
diego committed
311
   Note: not everything is supported yet.
michaelni's avatar
michaelni committed
312
*/
glantau's avatar
glantau committed
313

314
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale
michael's avatar
michael committed
315
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
316 317 318 319 320
#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
321
   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
322
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
323 324 325 326
#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
327
#define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
328 329
#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
330
                                            of only at frame boundaries */
331 332
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
333
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
334 335 336 337
#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)
338
/* Fx : Flag for h263+ extra options */
michaelni's avatar
michaelni committed
339 340
#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
341
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector
342
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
343
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
michael's avatar
michael committed
344
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
michael's avatar
michael committed
345 346
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
347 348
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
michael's avatar
michael committed
349
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
bcoudurier's avatar
bcoudurier committed
350
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
351
#define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
352
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
353
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< skip bitstream encoding
354
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< place global headers at every keyframe instead of in extradata
lorenm's avatar
lorenm committed
355 356 357 358 359 360 361
#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
bcoudurier's avatar
bcoudurier committed
362
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< use MPEG-2 intra VLC table
363
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< only do ME/MC (I frames -> ref, P frame -> ME+MC)
364

365
/* Unsupported options :
366 367 368
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
 *              Independant Segment Decoding */
369
/* /Fx */
glantau's avatar
glantau committed
370 371
/* codec capabilities */

372
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
michaelni's avatar
michaelni committed
373 374 375 376 377
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
378 379 380
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
381
#define CODEC_CAP_TRUNCATED       0x0008
382 383
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
384
/**
385 386 387
 * 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
 */
388
#define CODEC_CAP_DELAY           0x0020
389 390 391 392 393
/**
 * Codec can be fed a final frame with a smaller size.
 * This can be used to prevent truncation of the last audio samples.
 */
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
glantau's avatar
glantau committed
394

diego's avatar
diego committed
395
//the following defines may change, don't expect compatibility if you use them
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
#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, ...)

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

655 656 657
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
658 659

#define FF_BUFFER_TYPE_INTERNAL 1
michaelni's avatar
michaelni committed
660
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
diego's avatar
diego committed
661 662
#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
663

michaelni's avatar
michaelni committed
664

665 666 667 668
#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
669 670
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
671

672 673 674 675 676
#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
677 678 679
/**
 * Audio Video Frame.
 */
michaelni's avatar
michaelni committed
680 681 682
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
683

684
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
685 686 687 688

/**
 * main external api structure.
 */
glantau's avatar
glantau committed
689
typedef struct AVCodecContext {
690 691 692 693
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
694
    AVClass *av_class;
695
    /**
696 697
     * the average bitrate.
     * - encoding: set by user. unused for constant quantizer encoding
698
     * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
699
     */
glantau's avatar
glantau committed
700
    int bit_rate;
701 702

    /**
703
     * number of bits the bitstream is allowed to diverge from the reference.
704
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
705 706
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
707
     */
708
    int bit_rate_tolerance;
709 710

    /**
711 712 713
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
714
     */
glantau's avatar
glantau committed
715
    int flags;
716 717 718

    /**
     * some codecs needs additionnal format info. It is stored here
719
     * - encoding: set by user.
720
     * - decoding: set by lavc. (FIXME is this ok?)
721 722 723 724
     */
    int sub_id;

    /**
725
     * motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
726 727
     * 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]
728 729
     * - encoding: MUST be set by user.
     * - decoding: unused
730 731 732 733
     */
    int me_method;

    /**
734
     * some codecs need / can use extra-data like huffman tables.
735 736
     * mjpeg: huffman tables
     * rv10: additional flags
737
     * mpeg4: global headers (they can be in the bitstream or here)
738 739
     * 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
740
     * the bytewise contents of extradata must not depend on the architecture or cpu endianness
741 742
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
743
     */
744
    uint8_t *extradata;
745
    int extradata_size;
746

747
    /**
748 749 750 751
     * 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.
752
     * - encoding: MUST be set by user
michael's avatar
michael committed
753
     * - decoding: set by lavc.
754
     */
michael's avatar
michael committed
755
    AVRational time_base;
756

757
    /* video only */
758
    /**
759
     * picture width / height.
760
     * - encoding: MUST be set by user.
761
     * - decoding: set by lavc.
762
     * Note, for compatibility its possible to set this instead of
763
     * coded_width/height before decoding
764
     */
glantau's avatar
glantau committed
765
    int width, height;
766

767
#define FF_ASPECT_EXTENDED 15
768 769

    /**
770 771 772
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
773 774 775 776
     */
    int gop_size;

    /**
777
     * pixel format, see PIX_FMT_xxx.
778
     * - encoding: set by user.
779
     * - decoding: set by lavc.
780
     */
781
    enum PixelFormat pix_fmt;
782

783
    /**
784
     * Frame rate emulation. If not zero lower layer (i.e. format handler)
785 786 787 788 789
     * has to read frames at native frame rate.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int rate_emu;
790

791 792 793 794 795
    /**
     * 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
796 797
     * - encoding: unused
     * - decoding: set by user.
798 799 800 801
     * @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
802
     */
glantau's avatar
glantau committed
803
    void (*draw_horiz_band)(struct AVCodecContext *s,
804
                            const AVFrame *src, int offset[4],
805
                            int y, int type, int height);
glantau's avatar
glantau committed
806

glantau's avatar
glantau committed
807
    /* audio only */
808
    int sample_rate; ///< samples per sec
glantau's avatar
glantau committed
809
    int channels;
810 811 812 813 814 815

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

    /* the following data should not be initialized */
819
    /**
820
     * samples per packet. initialized when calling 'init'
821 822
     */
    int frame_size;
823 824 825
    int frame_number;   ///< audio or video frame number
    int real_pict_num;  ///< returns the real picture number of previous encoded frame

826
    /**
827
     * number of frames the decoded output will be delayed relative to
828 829 830
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
831 832
     */
    int delay;
833

834 835
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
836 837
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

838
    /**
839 840 841
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
842 843 844 845
     */
    int qmin;

    /**
846 847 848
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
849 850 851 852
     */
    int qmax;

    /**
853 854 855
     * maximum quantizer difference etween frames.
     * - encoding: set by user.
     * - decoding: unused
856 857 858 859
     */
    int max_qdiff;

    /**
860
     * maximum number of b frames between non b frames.
861
     * note: the output will be delayed by max_b_frames+1 relative to the input
862 863
     * - encoding: set by user.
     * - decoding: unused
864 865 866 867
     */
    int max_b_frames;

    /**
868 869 870
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
871 872
     */
    float b_quant_factor;
873

874 875
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
876 877
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
878
    int b_frame_strategy;
879

880
    /**
881
     * hurry up amount.
michael's avatar
michael committed
882
     * deprecated in favor of skip_idct and skip_frame
883 884
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
885 886
     */
    int hurry_up;
887

glantau's avatar
glantau committed
888
    struct AVCodec *codec;
889

glantau's avatar
glantau committed
890 891
    void *priv_data;

michael's avatar
michael committed
892 893
    /* unused, FIXME remove*/
    int rtp_mode;
894

diego's avatar
diego committed
895
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
896 897 898 899 900
                            /* 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    */
901

902

diego's avatar
diego committed
903 904 905 906 907 908
    /* 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                  */
909
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
910

michaelni's avatar
michaelni committed
911 912 913 914 915 916 917 918
    /* 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;
919
    int misc_bits;
920

921
    /**
922 923
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
michaelni's avatar
michaelni committed
924
     * - decoding: unused
925
     */
michaelni's avatar
michaelni committed
926
    int frame_bits;
michaelni's avatar
michaelni committed
927

928
    /**
929 930 931
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
932 933 934
     */
    void *opaque;

glantau's avatar
glantau committed
935
    char codec_name[32];
936 937
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
938

michaelni's avatar
michaelni committed
939 940 941
    /**
     * 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
942
     * - encoding: set by user, if not then the default based on codec_id will be used
michaelni's avatar
michaelni committed
943 944 945
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
946

947
    /**
948
     * workaround bugs in encoders which sometimes cannot be detected automatically.
949
     * - encoding: set by user
950
     * - decoding: set by user
951 952
     */
    int workaround_bugs;
953
#define FF_BUG_AUTODETECT       1  ///< autodetection
954 955 956 957
#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
958
#define FF_BUG_AMV              32
959
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
michaelni's avatar
michaelni committed
960
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
961
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
962
#define FF_BUG_QPEL_CHROMA2     256
963
#define FF_BUG_DIRECT_BLOCKSIZE 512
964
#define FF_BUG_EDGE             1024
965
#define FF_BUG_HPEL_CHROMA      2048
966
#define FF_BUG_DC_CLIP          4096
967
#define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
968
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
969

970
    /**
971 972 973
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
974
     */
michaelni's avatar
 
michaelni committed
975
    int luma_elim_threshold;
976

977
    /**
978 979 980
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
981
     */
michaelni's avatar
 
michaelni committed
982
    int chroma_elim_threshold;
983

984
    /**
985 986 987
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
988 989
     */
    int strict_std_compliance;
990 991 992 993 994 995
#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

996
    /**
997
     * qscale offset between ip and b frames.
998 999
     * 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)
1000 1001
     * - encoding: set by user.
     * - decoding: unused
1002 1003
     */
    float b_quant_offset;
1004

1005
    /**
1006
     * error resilience higher values will detect more errors but may missdetect
1007 1008 1009
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
1010
     */
michaelni's avatar
 
michaelni committed
1011
    int error_resilience;
diego's avatar
diego committed
1012
#define FF_ER_CAREFUL         1
1013 1014 1015
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1016

1017
    /**
michaelni's avatar
michaelni committed
1018 1019
     * 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
1020 1021
     * 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
1022 1023
     * - encoding: unused
     * - decoding: set by lavc, user can override
1024
     */
michaelni's avatar
michaelni committed
1025
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1026

1027
    /**
michaelni's avatar
michaelni committed
1028 1029 1030
     * 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
1031 1032
     * - encoding: unused
     * - decoding: set by lavc, user can override
1033
     */
michaelni's avatar
michaelni committed
1034
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1035

1036
    /**
1037 1038
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
1039
     * - decoding: set by lavc
1040 1041
     */
    int has_b_frames;
1042 1043 1044 1045 1046 1047

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

1049
    int parse_only; /* - decoding only: if true, only parsing is done
1050 1051
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1052

1053
    /**
1054
     * 0-> h263 quant 1-> mpeg quant.
1055 1056
     * - encoding: set by user.
     * - decoding: unused
1057 1058
     */
    int mpeg_quant;
1059

1060
    /**
1061 1062 1063
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
1064
     */
1065
    char *stats_out;
1066

1067 1068 1069
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1070 1071
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1072 1073
     */
    char *stats_in;
1074

1075
    /**
1076
     * ratecontrol qmin qmax limiting method.
1077
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1078 1079
     * - encoding: set by user.
     * - decoding: unused
1080
     */
michaelni's avatar
michaelni committed
1081
    float rc_qsquish;
1082

michaelni's avatar
michaelni committed
1083 1084
    float rc_qmod_amp;
    int rc_qmod_freq;
1085

1086
    /**
1087 1088 1089
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1090
     */
michaelni's avatar
michaelni committed
1091 1092
    RcOverride *rc_override;
    int rc_override_count;
1093

1094
    /**
1095 1096 1097
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1098
     */
michaelni's avatar
michaelni committed
1099
    char *rc_eq;
1100

1101
    /**
1102 1103 1104
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1105
     */
michaelni's avatar
michaelni committed
1106
    int rc_max_rate;
1107

1108
    /**
1109 1110 1111
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1112
     */
michaelni's avatar
michaelni committed
1113
    int rc_min_rate;
1114

1115
    /**
1116 1117 1118
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1119
     */
michaelni's avatar
michaelni committed
1120 1121
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1122 1123

    /**
1124
     * qscale factor between p and i frames.
1125 1126
     * 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)
1127 1128
     * - encoding: set by user.
     * - decoding: unused
1129 1130
     */
    float i_quant_factor;
1131

1132
    /**
1133 1134 1135
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1136 1137
     */
    float i_quant_offset;
1138

1139
    /**
1140 1141 1142
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1143
     */
michaelni's avatar
michaelni committed
1144
    float rc_initial_cplx;
1145

1146
    /**
1147 1148 1149
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1150
     */
1151
    int dct_algo;
1152
#define FF_DCT_AUTO    0
1153
#define FF_DCT_FASTINT 1
1154 1155 1156
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1157
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1158
#define FF_DCT_FAAN    6
1159

1160
    /**
1161 1162 1163
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1164 1165
     */
    float lumi_masking;
1166

1167
    /**
1168 1169 1170
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1171 1172
     */
    float temporal_cplx_masking;
1173

1174
    /**
1175 1176 1177
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1178 1179
     */
    float spatial_cplx_masking;
1180

1181
    /**
1182 1183 1184
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1185 1186
     */
    float p_masking;
1187

1188
    /**
1189 1190 1191
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1192 1193
     */
    float dark_masking;
1194 1195


1196 1197
    /* for binary compatibility */
    int unused;
1198

1199
    /**
1200 1201 1202
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
     */
    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
1213
#define FF_IDCT_ALTIVEC      8
1214
#define FF_IDCT_SH4          9
1215
#define FF_IDCT_SIMPLEARM    10
1216
#define FF_IDCT_H264         11
1217
#define FF_IDCT_VP3          12
1218
#define FF_IDCT_IPP          13
michael's avatar
michael committed
1219
#define FF_IDCT_XVIDMMX      14
1220
#define FF_IDCT_CAVS         15
mru's avatar
mru committed
1221
#define FF_IDCT_SIMPLEARMV5TE 16
1222

1223
    /**
1224 1225 1226
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1227 1228 1229
     */
    int slice_count;
    /**
1230 1231 1232
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1233 1234 1235
     */
    int *slice_offset;

1236
    /**
1237 1238 1239
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1240 1241 1242 1243 1244
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1245
    /**
kabi's avatar
kabi committed
1246
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1247
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1248 1249 1250 1251 1252 1253
     *
     * 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;
1254
#define FF_MM_FORCE    0x80000000 /* force usage of selected flags (OR) */
kabi's avatar
kabi committed
1255 1256
    /* lower 16 bits - CPU features */
#ifdef HAVE_MMX
1257 1258 1259 1260 1261 1262
#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
1263
#endif /* HAVE_MMX */
1264
#ifdef HAVE_IWMMXT
1265
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1266
#endif /* HAVE_IWMMXT */
michaelni's avatar
michaelni committed
1267 1268

    /**
1269 1270 1271
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
michaelni's avatar
michaelni committed
1272 1273
     */
     int bits_per_sample;
1274

michaelni's avatar
michaelni committed
1275
    /**
1276 1277 1278
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
michaelni's avatar
michaelni committed
1279 1280 1281 1282 1283
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1284

michaelni's avatar
michaelni committed
1285
    /**
michael's avatar
michael committed
1286
     * sample aspect ratio (0 if unknown).
1287
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1288 1289
     * - encoding: set by user.
     * - decoding: set by lavc.
michaelni's avatar
michaelni committed
1290
     */
michael's avatar
michael committed
1291
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1292 1293

    /**
1294 1295 1296
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
michaelni's avatar
michaelni committed
1297
     */
michaelni's avatar
michaelni committed
1298
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1299 1300

    /**
1301 1302 1303
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
michaelni's avatar
michaelni committed
1304 1305 1306 1307 1308 1309 1310 1311
     */
    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
1312
#define FF_DEBUG_DCT_COEFF 0x00000040
michaelni's avatar
michaelni committed
1313 1314 1315
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1316
#define FF_DEBUG_ER        0x00000400
michaelni's avatar
michaelni committed
1317
#define FF_DEBUG_MMCO      0x00000800
michaelni's avatar
michaelni committed
1318
#define FF_DEBUG_BUGS      0x00001000
michael's avatar
michael committed
1319 1320
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1321

1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
    /**
     * 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

1332
    /**
1333 1334 1335
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1336 1337
     */
    uint64_t error[4];
1338

michaelni's avatar
michaelni committed
1339
    /**
1340
     * minimum MB quantizer.
1341
     * - encoding: unused
1342
     * - decoding: unused
michaelni's avatar
michaelni committed
1343 1344 1345 1346
     */
    int mb_qmin;

    /**
1347
     * maximum MB quantizer.
1348
     * - encoding: unused
1349
     * - decoding: unused
michaelni's avatar
michaelni committed
1350 1351
     */
    int mb_qmax;
1352

michaelni's avatar
michaelni committed
1353
    /**
1354 1355 1356
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1357 1358 1359
     */
    int me_cmp;
    /**
1360 1361 1362
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1363 1364 1365
     */
    int me_sub_cmp;
    /**
1366 1367 1368
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1369 1370
     */
    int mb_cmp;
michael's avatar
michael committed
1371 1372 1373 1374 1375 1376
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
michaelni's avatar
michaelni committed
1377 1378 1379 1380 1381 1382 1383 1384
#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
1385 1386
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1387
#define FF_CMP_NSSE 10
michael's avatar
michael committed
1388 1389
#define FF_CMP_W53  11
#define FF_CMP_W97  12
michael's avatar
michael committed
1390
#define FF_CMP_DCTMAX 13
1391
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1392
#define FF_CMP_CHROMA 256
1393

michaelni's avatar
michaelni committed
1394
    /**
1395 1396 1397
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1398 1399
     */
    int dia_size;
michaelni's avatar
michaelni committed
1400 1401

    /**
1402 1403 1404
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1405 1406
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1407

michaelni's avatar
michaelni committed
1408
    /**
1409 1410 1411
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1412 1413
     */
    int pre_me;
michaelni's avatar
michaelni committed
1414

michaelni's avatar
michaelni committed
1415
    /**
1416 1417 1418
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1419 1420
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1421

michaelni's avatar
michaelni committed
1422
    /**
1423 1424 1425
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1426 1427 1428
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1429
    /**
1430 1431 1432
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
michaelni's avatar
michaelni committed
1433 1434 1435
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1436
    /**
1437
     * callback to negotiate the pixelFormat.
michaelni's avatar
michaelni committed
1438 1439 1440 1441
     * @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
1442 1443
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
michaelni's avatar
michaelni committed
1444
     */
iive's avatar
iive committed
1445
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1446 1447 1448 1449 1450

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
1451
     *
1452
     * - encoding: unused.
1453
     * - decoding: set by decoder
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463
     */
    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

1464 1465 1466
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
1467
     *
1468 1469
     * - encoding: set by user.
     * - decoding: unused.
1470
     */
kabi's avatar
kabi committed
1471
    int me_range;
1472

michaelni's avatar
michaelni committed
1473 1474 1475 1476 1477 1478 1479
    /**
     * intra quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1480

michaelni's avatar
michaelni committed
1481 1482 1483 1484 1485 1486
    /**
     * inter quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_quant_bias;
1487 1488 1489 1490 1491 1492 1493 1494

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

1496
    /**
1497
     * internal_buffer count.
diego's avatar
diego committed
1498
     * Don't touch, used by lavc default_get_buffer()
1499 1500
     */
    int internal_buffer_count;
1501

1502
    /**
1503
     * internal_buffers.
diego's avatar
diego committed
1504
     * Don't touch, used by lavc default_get_buffer()
1505 1506
     */
    void *internal_buffer;
1507 1508 1509 1510 1511 1512 1513

#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
1514 1515 1516 1517 1518 1519 1520
    /**
     * 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;
1521

michaelni's avatar
michaelni committed
1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
#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;
1537 1538 1539 1540 1541 1542 1543 1544
#if 0
    /**
     *
     * - encoding: unused
     * - decoding: set by user.
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1545

1546 1547 1548 1549 1550 1551 1552 1553 1554 1555
    /**
     * 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
1556 1557 1558 1559 1560 1561
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1562

1563 1564 1565 1566 1567 1568 1569 1570 1571
    /**
     * 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
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585

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

1587 1588 1589 1590 1591 1592 1593
    /**
     * 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
1594 1595 1596 1597 1598 1599 1600 1601

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1616 1617 1618 1619 1620 1621 1622

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1623 1624 1625 1626 1627 1628 1629

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

1631
    /**
1632 1633 1634 1635 1636
     * 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().
1637
     * - encoding: unused
1638
     * - decoding: set by lavc, user can override
1639
     */
1640
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661

    /**
     * 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
1662 1663 1664 1665 1666 1667 1668

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

1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
    /**
     * 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
1680 1681 1682 1683 1684 1685
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1686 1687 1688 1689 1690 1691 1692 1693

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

1695 1696 1697 1698
    /**
     * 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
1699
     * @param count the number of things to execute
1700 1701 1702 1703
     * - 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);
1704

1705 1706 1707 1708 1709 1710 1711
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1712 1713

    /**
1714
     * Motion estimation threshold. under which no motion estimation is
1715
     * performed, but instead the user specified motion vectors are used
1716
     *
1717
     * - encoding: set by user
1718
     * - decoding: unused
1719
     */
michael's avatar
michael committed
1720
     int me_threshold;
1721 1722 1723 1724 1725 1726 1727

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

    /**
michael's avatar
michael committed
1730
     * precision of the intra dc coefficient - 8.
1731 1732 1733 1734
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1735 1736 1737 1738 1739 1740 1741

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

    /**
1744
     * number of macroblock rows at the top which are skipped.
1745 1746 1747 1748 1749 1750
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
1751
     * number of macroblock rows at the bottom which are skipped.
1752 1753 1754 1755
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
michael's avatar
michael committed
1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771

    /**
     * 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
1772 1773 1774 1775 1776 1777 1778

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

    /**
michael's avatar
michael committed
1781
     * bitsream width / height. may be different from width/height if lowres
1782 1783 1784 1785 1786
     * 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
1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800

    /**
     * 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
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814

    /**
     * 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;
1815 1816 1817 1818 1819 1820 1821 1822

    /**
     * border processing masking. raises the quantizer for mbs on the borders
     * of the picture.
     * - encoding: set by user
     * - decoding: unused
     */
    float border_masking;
1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836

    /**
     * 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;
1837 1838

    /**
1839
     *
1840 1841 1842 1843
     * - encoding: set by user.
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1844 1845

    /**
1846
     *
michael's avatar
michael committed
1847 1848 1849 1850 1851 1852
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_loop_filter;

    /**
1853
     *
michael's avatar
michael committed
1854 1855 1856 1857 1858 1859
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_idct;

    /**
1860
     *
michael's avatar
michael committed
1861 1862 1863 1864
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
1865 1866 1867 1868 1869 1870 1871

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int bidir_refine;
1872 1873 1874 1875 1876 1877 1878

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int brd_scale;
lorenm's avatar
lorenm committed
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 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969

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

1971 1972 1973 1974 1975 1976
    /**
     * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
     * - encoding: set by user.
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
1977 1978 1979 1980 1981 1982 1983

    /**
     * multiplied by qscale for each frame and added to scene_change_score
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_factor;
1984 1985 1986 1987 1988 1989 1990 1991

    /**
     *
     * note: value depends upon the compare functin used for fullpel ME
     * - encoding: set by user.
     * - decoding: unused
     */
    int mv0_threshold;
1992 1993 1994 1995 1996 1997 1998

    /**
     * adjusts sensitivity of b_frame_strategy 1
     * - encoding: set by user.
     * - decoding: unused
     */
    int b_sensitivity;
1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050

    /**
     * - encoding: set by user.
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
     * sets whether to use LPC mode - used by FLAC encoder
     * - encoding: set by user.
     * - decoding: unused.
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
     * - encoding: set by user.
     * - decoding: unused.
     */
    int lpc_coeff_precision;

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

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

    /**
     * search method for selecting prediction order
     * - encoding: set by user.
     * - decoding: unused.
     */
    int prediction_order_method;

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

    /**
     * - encoding: set by user.
     * - decoding: unused.
     */
    int max_partition_order;
glantau's avatar
glantau committed
2051 2052
} AVCodecContext;

2053 2054 2055
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
2056
typedef struct AVCodec {
kabi's avatar
kabi committed
2057
    const char *name;
kabi's avatar
kabi committed
2058
    enum CodecType type;
michael's avatar
michael committed
2059
    enum CodecID id;
glantau's avatar
glantau committed
2060 2061
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
2062
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
2063
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
2064
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
kabi's avatar
kabi committed
2065
                  uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
2066
    int capabilities;
michael's avatar
michael committed
2067
#if LIBAVCODEC_VERSION_INT < ((50<<16)+(0<<8)+0)
2068
    void *dummy; // FIXME remove next time we break binary compatibility
michael's avatar
michael committed
2069
#endif
glantau's avatar
glantau committed
2070
    struct AVCodec *next;
michaelni's avatar
michaelni committed
2071
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
2072
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
2073
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
2074 2075
} AVCodec;

kabi's avatar
kabi committed
2076
/**
2077 2078 2079
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
2080
typedef struct AVPicture {
kabi's avatar
kabi committed
2081
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2082
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2083 2084
} AVPicture;

tmmm's avatar
tmmm committed
2085 2086 2087 2088
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
2089
 * this is totally broken, palette changes should be sent as AVPackets
tmmm's avatar
tmmm committed
2090
 */
2091
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2092
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2093 2094 2095 2096 2097 2098
typedef struct AVPaletteControl {

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

2099 2100 2101 2102
    /* 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 */
2103
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2104

2105
} AVPaletteControl attribute_deprecated;
tmmm's avatar
tmmm committed
2106

2107
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2108 2109 2110 2111 2112 2113 2114 2115
    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;
2116 2117 2118 2119 2120 2121 2122 2123
} 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
2124 2125
} AVSubtitle;

glantau's avatar
glantau committed
2126 2127
extern AVCodec ac3_encoder;
extern AVCodec mp2_encoder;
2128
extern AVCodec mp3lame_encoder;
michaelni's avatar
 
michaelni committed
2129
extern AVCodec oggvorbis_encoder;
2130
extern AVCodec faac_encoder;
2131
extern AVCodec flac_encoder;
2132
extern AVCodec xvid_encoder;
glantau's avatar
glantau committed
2133
extern AVCodec mpeg1video_encoder;
michaelni's avatar
michaelni committed
2134
extern AVCodec mpeg2video_encoder;
2135
extern AVCodec h261_encoder;
glantau's avatar
glantau committed
2136 2137
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
2138
extern AVCodec flv_encoder;
glantau's avatar
glantau committed
2139
extern AVCodec rv10_encoder;
michael's avatar
michael committed
2140
extern AVCodec rv20_encoder;
romansh's avatar
 
romansh committed
2141
extern AVCodec dvvideo_encoder;
glantau's avatar
glantau committed
2142
extern AVCodec mjpeg_encoder;
2143
extern AVCodec ljpeg_encoder;
2144
extern AVCodec jpegls_encoder;
2145
extern AVCodec png_encoder;
2146 2147 2148 2149 2150
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
2151
extern AVCodec mpeg4_encoder;
2152 2153 2154
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
michaelni's avatar
 
michaelni committed
2155 2156
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
michaelni's avatar
michaelni committed
2157
extern AVCodec huffyuv_encoder;
lorenm's avatar
lorenm committed
2158
extern AVCodec ffvhuff_encoder;
michaelni's avatar
michaelni committed
2159
extern AVCodec h264_encoder;
michaelni's avatar
michaelni committed
2160
extern AVCodec asv1_encoder;
michaelni's avatar
michaelni committed
2161
extern AVCodec asv2_encoder;
michaelni's avatar
michaelni committed
2162
extern AVCodec vcr1_encoder;
2163
extern AVCodec ffv1_encoder;
michael's avatar
michael committed
2164
extern AVCodec snow_encoder;
ods15's avatar
ods15 committed
2165
extern AVCodec vorbis_encoder;
2166
extern AVCodec mdec_encoder;
rtognimp's avatar
rtognimp committed
2167
extern AVCodec zlib_encoder;
2168 2169
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
2170
extern AVCodec svq1_encoder;
2171
extern AVCodec x264_encoder;
glantau's avatar
glantau committed
2172 2173

extern AVCodec h263_decoder;
2174
extern AVCodec h261_decoder;
glantau's avatar
glantau committed
2175
extern AVCodec mpeg4_decoder;
2176 2177 2178
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
michaelni's avatar
michaelni committed
2179
extern AVCodec wmv1_decoder;
michaelni's avatar
 
michaelni committed
2180
extern AVCodec wmv2_decoder;
2181
extern AVCodec vc1_decoder;
2182
extern AVCodec wmv3_decoder;
michaelni's avatar
michaelni committed
2183 2184
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
iive's avatar
iive committed
2185
extern AVCodec mpegvideo_decoder;
iive's avatar
iive committed
2186
extern AVCodec mpeg_xvmc_decoder;
glantau's avatar
glantau committed
2187
extern AVCodec h263i_decoder;
2188
extern AVCodec flv_decoder;
glantau's avatar
glantau committed
2189
extern AVCodec rv10_decoder;
michael's avatar
michael committed
2190
extern AVCodec rv20_decoder;
michael's avatar
michael committed
2191 2192
extern AVCodec rv30_decoder;
extern AVCodec rv40_decoder;
nickols_k's avatar
nickols_k committed
2193
extern AVCodec svq1_decoder;
michaelni's avatar
michaelni committed
2194
extern AVCodec svq3_decoder;
bellard's avatar
bellard committed
2195
extern AVCodec dvvideo_decoder;
bellard's avatar
bellard committed
2196 2197
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
glantau's avatar
glantau committed
2198
extern AVCodec mjpeg_decoder;
al3x's avatar
al3x committed
2199
extern AVCodec mjpegb_decoder;
alex's avatar
alex committed
2200
extern AVCodec sp5x_decoder;
2201
extern AVCodec png_decoder;
2202
extern AVCodec mp2_decoder;
glantau's avatar
glantau committed
2203
extern AVCodec mp3_decoder;
rtognimp's avatar
rtognimp committed
2204
extern AVCodec mp3adu_decoder;
2205
extern AVCodec mp3on4_decoder;
rtognimp's avatar
rtognimp committed
2206
extern AVCodec qdm2_decoder;
2207
extern AVCodec cook_decoder;
2208
extern AVCodec truespeech_decoder;
2209
extern AVCodec tta_decoder;
2210 2211
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
michaelni's avatar
michaelni committed
2212
extern AVCodec huffyuv_decoder;
lorenm's avatar
lorenm committed
2213
extern AVCodec ffvhuff_decoder;
kabi's avatar
kabi committed
2214
extern AVCodec oggvorbis_decoder;
2215
extern AVCodec cyuv_decoder;
michaelni's avatar
michaelni committed
2216
extern AVCodec h264_decoder;
tmmm's avatar
tmmm committed
2217
extern AVCodec indeo3_decoder;
tmmm's avatar
tmmm committed
2218
extern AVCodec vp3_decoder;
2219
extern AVCodec theora_decoder;
aurel's avatar
aurel committed
2220 2221 2222
extern AVCodec vp5_decoder;
extern AVCodec vp6_decoder;
extern AVCodec vp6f_decoder;
2223
extern AVCodec amr_nb_decoder;
kabi's avatar
kabi committed
2224
extern AVCodec amr_nb_encoder;
2225 2226
extern AVCodec amr_wb_encoder;
extern AVCodec amr_wb_decoder;
2227 2228
extern AVCodec aac_decoder;
extern AVCodec mpeg4aac_decoder;
michaelni's avatar
michaelni committed
2229
extern AVCodec asv1_decoder;
michaelni's avatar
michaelni committed
2230
extern AVCodec asv2_decoder;
michaelni's avatar
michaelni committed
2231
extern AVCodec vcr1_decoder;
al3x's avatar
al3x committed
2232
extern AVCodec cljr_decoder;
2233
extern AVCodec ffv1_decoder;
michael's avatar
michael committed
2234
extern AVCodec snow_decoder;
michaelni's avatar
michaelni committed
2235
extern AVCodec fourxm_decoder;
2236
extern AVCodec mdec_decoder;
2237 2238
extern AVCodec roq_decoder;
extern AVCodec interplay_video_decoder;
2239
extern AVCodec xan_wc3_decoder;
2240 2241 2242 2243
extern AVCodec rpza_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
tmmm's avatar
tmmm committed
2244
extern AVCodec vqa_decoder;
tmmm's avatar
tmmm committed
2245
extern AVCodec idcin_decoder;
rtognimp's avatar
rtognimp committed
2246
extern AVCodec eightbps_decoder;
2247
extern AVCodec smc_decoder;
melanson's avatar
melanson committed
2248
extern AVCodec flic_decoder;
2249 2250
extern AVCodec vmdvideo_decoder;
extern AVCodec vmdaudio_decoder;
2251
extern AVCodec truemotion1_decoder;
2252
extern AVCodec truemotion2_decoder;
rtognimp's avatar
rtognimp committed
2253 2254
extern AVCodec mszh_decoder;
extern AVCodec zlib_decoder;
2255 2256
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
2257 2258
extern AVCodec roq_dpcm_decoder;
extern AVCodec interplay_dpcm_decoder;
2259
extern AVCodec xan_dpcm_decoder;
2260
extern AVCodec sol_dpcm_decoder;
2261
extern AVCodec sonic_decoder;
2262
extern AVCodec qtrle_decoder;
michael's avatar
michael committed
2263
extern AVCodec flac_decoder;
2264
extern AVCodec tscc_decoder;
2265
extern AVCodec cscd_decoder;
2266
extern AVCodec nuv_decoder;
2267
extern AVCodec ulti_decoder;
2268
extern AVCodec qdraw_decoder;
2269
extern AVCodec xl_decoder;
2270
extern AVCodec qpeg_decoder;
2271
extern AVCodec shorten_decoder;
2272
extern AVCodec loco_decoder;
2273
extern AVCodec wnv1_decoder;
2274
extern AVCodec aasc_decoder;
2275
extern AVCodec alac_decoder;
2276
extern AVCodec ws_snd1_decoder;
2277
extern AVCodec indeo2_decoder;
2278
extern AVCodec vorbis_decoder;
2279
extern AVCodec fraps_decoder;
2280 2281
extern AVCodec libgsm_encoder;
extern AVCodec libgsm_decoder;
mru's avatar
mru committed
2282
extern AVCodec bmp_decoder;
2283
extern AVCodec mmvideo_decoder;
2284
extern AVCodec zmbv_decoder;
2285
extern AVCodec avs_decoder;
kostya's avatar
kostya committed
2286 2287
extern AVCodec smacker_decoder;
extern AVCodec smackaud_decoder;
2288
extern AVCodec kmvc_decoder;
2289
extern AVCodec flashsv_decoder;
2290
extern AVCodec cavs_decoder;
kostya's avatar
kostya committed
2291
extern AVCodec vmnc_decoder;
kostya's avatar
kostya committed
2292
extern AVCodec wavpack_decoder;
glantau's avatar
glantau committed
2293

glantau's avatar
glantau committed
2294 2295 2296
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
2297
extern AVCodec name ## _encoder
glantau's avatar
glantau committed
2298

2299 2300 2301 2302 2303 2304 2305 2306 2307
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
2308 2309 2310 2311 2312 2313 2314 2315 2316
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);

2317 2318 2319 2320
/* adpcm codecs */

PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2321 2322
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2323
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2324
PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2325
PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
michaelni's avatar
michaelni committed
2326
PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2327 2328
PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2329
PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
romansh's avatar
 
romansh committed
2330
PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2331
PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2332
PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2333
PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2334 2335 2336
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);
2337

glantau's avatar
glantau committed
2338 2339 2340
#undef PCM_CODEC

/* dummy raw video codec */
romansh's avatar
 
romansh committed
2341 2342
extern AVCodec rawvideo_encoder;
extern AVCodec rawvideo_decoder;
glantau's avatar
glantau committed
2343 2344 2345

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

bellard's avatar
bellard committed
2348
/* subtitles */
2349
extern AVCodec dvdsub_encoder;
bellard's avatar
bellard committed
2350 2351
extern AVCodec dvdsub_decoder;
extern AVCodec dvbsub_encoder;
2352
extern AVCodec dvbsub_decoder;
bellard's avatar
bellard committed
2353

glantau's avatar
glantau committed
2354 2355 2356
/* resample.c */

struct ReSampleContext;
2357
struct AVResampleContext;
glantau's avatar
glantau committed
2358 2359 2360

typedef struct ReSampleContext ReSampleContext;

2361
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2362 2363 2364 2365
                                     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
2366
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2367
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
2368
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2369
void av_resample_close(struct AVResampleContext *c);
2370

glantau's avatar
glantau committed
2371 2372 2373 2374 2375 2376 2377 2378
/* 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);
2379 2380 2381 2382

ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2383 2384 2385 2386
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2387

2388
void img_resample(ImgReSampleContext *s,
2389
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2390 2391 2392

void img_resample_close(ImgReSampleContext *s);

michael's avatar
michael committed
2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
/**
 * 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
2407
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2408
                   int pix_fmt, int width, int height);
2409
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2410
                     unsigned char *dest, int dest_size);
2411
int avpicture_get_size(int pix_fmt, int width, int height);
2412 2413
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);
2414
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2415
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2416
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2417

2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
#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
2430 2431
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2432
int img_get_alpha_info(const AVPicture *src,
2433
                       int pix_fmt, int width, int height);
bellard's avatar
bellard committed
2434

2435 2436
/* convert among pixel formats */
int img_convert(AVPicture *dst, int dst_pix_fmt,
2437
                const AVPicture *src, int pix_fmt,
2438 2439 2440
                int width, int height);

/* deinterlace a picture */
2441
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2442 2443 2444 2445 2446 2447
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

nickols_k's avatar
nickols_k committed
2448
/* returns LIBAVCODEC_VERSION_INT constant */
2449
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2450
/* returns LIBAVCODEC_BUILD constant */
2451
unsigned avcodec_build(void);
glantau's avatar
glantau committed
2452 2453 2454 2455
void avcodec_init(void);

void register_avcodec(AVCodec *format);
AVCodec *avcodec_find_encoder(enum CodecID id);
2456
AVCodec *avcodec_find_encoder_by_name(const char *name);
glantau's avatar
glantau committed
2457 2458 2459 2460
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
2461
void avcodec_get_context_defaults(AVCodecContext *s);
mellum's avatar
mellum committed
2462
AVCodecContext *avcodec_alloc_context(void);
mellum's avatar
mellum committed
2463
void avcodec_get_frame_defaults(AVFrame *pic);
michaelni's avatar
michaelni committed
2464
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
2465

michaelni's avatar
michaelni committed
2466 2467
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2468 2469
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2470
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
michael's avatar
michael committed
2471
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
michaelni's avatar
michaelni committed
2472

michael's avatar
1l  
michael committed
2473 2474 2475
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
2476
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2477 2478
//FIXME func typedef

michaelni's avatar
michaelni committed
2479 2480 2481 2482
/**
 * opens / inits the AVCodecContext.
 * not thread save!
 */
glantau's avatar
glantau committed
2483
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2484

2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495
/**
 * Decode an audio frame.
 *
 * @param avctx the codec context.
 * @param samples output buffer, 16 byte aligned
 * @param frame_size_ptr the output buffer size in bytes, zero if no frame could be compressed
 * @param buf input buffer, 16 byte aligned
 * @param buf_size the input buffer size
 * @return 0 if successful, -1 if not.
 */

2496
int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
glantau's avatar
glantau committed
2497
                         int *frame_size_ptr,
kabi's avatar
kabi committed
2498
                         uint8_t *buf, int buf_size);
2499
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
glantau's avatar
glantau committed
2500
                         int *got_picture_ptr,
kabi's avatar
kabi committed
2501
                         uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2502 2503 2504
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2505
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2506
                        int *data_size_ptr,
kabi's avatar
kabi committed
2507
                        uint8_t *buf, int buf_size);
2508
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
glantau's avatar
glantau committed
2509
                         const short *samples);
2510
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
michaelni's avatar
michaelni committed
2511
                         const AVFrame *pict);
2512
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
bellard's avatar
bellard committed
2513
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2514 2515 2516 2517

int avcodec_close(AVCodecContext *avctx);

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

michaelni's avatar
michaelni committed
2519 2520
void avcodec_flush_buffers(AVCodecContext *avctx);

2521 2522
void avcodec_default_free_buffers(AVCodecContext *s);

2523
/* misc usefull functions */
michaelni's avatar
michaelni committed
2524 2525 2526 2527 2528 2529

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

2530 2531 2532 2533
/**
 * returns codec bits per sample
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2534

bellard's avatar
bellard committed
2535 2536 2537 2538 2539
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2540
    int64_t cur_offset; /* current offset
bellard's avatar
bellard committed
2541 2542 2543 2544 2545
                           (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
2546 2547 2548 2549 2550 2551
    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
2552
    int fetch_timestamp;
bellard's avatar
bellard committed
2553 2554 2555 2556 2557 2558

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

michael's avatar
michael committed
2560 2561
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
bellard's avatar
bellard committed
2562 2563 2564
} AVCodecParserContext;

typedef struct AVCodecParser {
michael's avatar
michael committed
2565
    int codec_ids[5]; /* several codec IDs are permitted */
bellard's avatar
bellard committed
2566 2567
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2568
    int (*parser_parse)(AVCodecParserContext *s,
bellard's avatar
bellard committed
2569
                        AVCodecContext *avctx,
2570
                        uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2571 2572
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2573
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2574 2575 2576 2577 2578 2579 2580
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2581
int av_parser_parse(AVCodecParserContext *s,
bellard's avatar
bellard committed
2582
                    AVCodecContext *avctx,
2583
                    uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2584 2585
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2586 2587
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2588
                     uint8_t **poutbuf, int *poutbuf_size,
2589
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2590 2591 2592 2593
void av_parser_close(AVCodecParserContext *s);

extern AVCodecParser mpegvideo_parser;
extern AVCodecParser mpeg4video_parser;
2594
extern AVCodecParser cavsvideo_parser;
2595
extern AVCodecParser h261_parser;
bellard's avatar
bellard committed
2596 2597
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
michael's avatar
michael committed
2598
extern AVCodecParser mjpeg_parser;
michael's avatar
michael committed
2599
extern AVCodecParser pnm_parser;
bellard's avatar
bellard committed
2600 2601
extern AVCodecParser mpegaudio_parser;
extern AVCodecParser ac3_parser;
bellard's avatar
bellard committed
2602
extern AVCodecParser dvdsub_parser;
2603
extern AVCodecParser dvbsub_parser;
mru's avatar
mru committed
2604
extern AVCodecParser aac_parser;
bellard's avatar
bellard committed
2605

2606 2607

typedef struct AVBitStreamFilterContext {
michael's avatar
michael committed
2608
    void *priv_data;
2609 2610 2611 2612 2613 2614 2615 2616
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
michael's avatar
michael committed
2617
    int priv_data_size;
2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
    struct AVBitStreamFilter *next;
} AVBitStreamFilter;

extern AVBitStreamFilter *av_first_bitstream_filter;

void av_register_bitstream_filter(AVBitStreamFilter *bsf);
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
                               AVCodecContext *avctx, const char *args,
                               uint8_t **poutbuf, int *poutbuf_size,
                               const uint8_t *buf, int buf_size, int keyframe);
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);

extern AVBitStreamFilter dump_extradata_bsf;
extern AVBitStreamFilter remove_extradata_bsf;
michael's avatar
michael committed
2637
extern AVBitStreamFilter noise_bsf;
2638 2639


bellard's avatar
bellard committed
2640
/* memory */
kabi's avatar
kabi committed
2641
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2642 2643
/* for static data only */
/* call av_free_static to release all staticaly allocated tables */
2644
void av_free_static(void);
2645
void *av_mallocz_static(unsigned int size);
2646
void *av_realloc_static(void *ptr, unsigned int size);
bellard's avatar
bellard committed
2647

2648 2649 2650
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2651 2652 2653
int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

2654 2655 2656
int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
            int padtop, int padbottom, int padleft, int padright, int *color);

2657
/* endian macros */
2658
#if !defined(BE_16) || !defined(BE_32) || !defined(LE_16) || !defined(LE_32)
2659 2660 2661 2662 2663 2664 2665 2666 2667 2668
#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])
2669
#endif
2670

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

kabi's avatar
kabi committed
2673 2674 2675 2676
#ifdef __cplusplus
}
#endif

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