avcodec.h 92.1 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12 13 14 15 16
 * 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
17
 * License along with FFmpeg; if not, write to the Free Software
diego's avatar
diego committed
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 20
 */

21 22
#ifndef FFMPEG_AVCODEC_H
#define FFMPEG_AVCODEC_H
glantau's avatar
glantau committed
23

michaelni's avatar
michaelni committed
24 25
/**
 * @file avcodec.h
diego's avatar
diego committed
26
 * external API header
michaelni's avatar
michaelni committed
27 28 29
 */


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

mru's avatar
mru committed
33 34 35 36
#define LIBAVCODEC_VERSION_TRIPLET 51,50,1

#define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_TRIPLET)
#define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_TRIPLET)
37
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
38

39
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
al3x's avatar
al3x committed
40

41
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
42 43
#define AV_TIME_BASE            1000000
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
44

michael's avatar
michael committed
45
/**
benoit's avatar
benoit committed
46 47 48 49 50 51
 * Identifies the syntax and semantics of the bitstream.
 * The principle is roughly:
 * Two decoders with the same ID can decode the same streams.
 * Two encoders with the same ID can encode compatible streams.
 * There may be slight deviations from the principle due to implementation
 * details.
michael's avatar
michael committed
52
 *
diego's avatar
diego committed
53 54 55
 * If you add a codec ID to this list, add it so that
 * 1. no value of a existing codec ID changes (that would break ABI),
 * 2. it is as close as possible to similar codecs.
michael's avatar
michael committed
56
 */
glantau's avatar
glantau committed
57
enum CodecID {
58
    CODEC_ID_NONE,
glantau's avatar
glantau committed
59
    CODEC_ID_MPEG1VIDEO,
60
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
iive's avatar
iive committed
61
    CODEC_ID_MPEG2VIDEO_XVMC,
62
    CODEC_ID_H261,
glantau's avatar
glantau committed
63 64
    CODEC_ID_H263,
    CODEC_ID_RV10,
michael's avatar
michael committed
65
    CODEC_ID_RV20,
glantau's avatar
glantau committed
66
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
67
    CODEC_ID_MJPEGB,
68
    CODEC_ID_LJPEG,
alex's avatar
alex committed
69
    CODEC_ID_SP5X,
70
    CODEC_ID_JPEGLS,
glantau's avatar
glantau committed
71
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
72
    CODEC_ID_RAWVIDEO,
73 74 75
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
76
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
77
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
78 79
    CODEC_ID_H263P,
    CODEC_ID_H263I,
80
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
81
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
82
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
83
    CODEC_ID_DVVIDEO,
michaelni's avatar
michaelni committed
84
    CODEC_ID_HUFFYUV,
85
    CODEC_ID_CYUV,
michaelni's avatar
michaelni committed
86
    CODEC_ID_H264,
tmmm's avatar
tmmm committed
87
    CODEC_ID_INDEO3,
tmmm's avatar
tmmm committed
88
    CODEC_ID_VP3,
89
    CODEC_ID_THEORA,
michaelni's avatar
michaelni committed
90
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
91
    CODEC_ID_ASV2,
92
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
93
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
94
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
95
    CODEC_ID_CLJR,
96
    CODEC_ID_MDEC,
97 98
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
99 100
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
101 102 103 104 105
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
106
    CODEC_ID_IDCIN,
rtognimp's avatar
rtognimp committed
107
    CODEC_ID_8BPS,
108
    CODEC_ID_SMC,
melanson's avatar
melanson committed
109
    CODEC_ID_FLIC,
110
    CODEC_ID_TRUEMOTION1,
111
    CODEC_ID_VMDVIDEO,
rtognimp's avatar
rtognimp committed
112 113
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
114
    CODEC_ID_QTRLE,
michael's avatar
michael committed
115
    CODEC_ID_SNOW,
116
    CODEC_ID_TSCC,
117
    CODEC_ID_ULTI,
118
    CODEC_ID_QDRAW,
119
    CODEC_ID_VIXL,
120
    CODEC_ID_QPEG,
121 122 123 124 125 126 127
    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
128
    CODEC_ID_FFVHUFF,
michael's avatar
michael committed
129 130
    CODEC_ID_RV30,
    CODEC_ID_RV40,
131
    CODEC_ID_VC1,
132
    CODEC_ID_WMV3,
133
    CODEC_ID_LOCO,
134
    CODEC_ID_WNV1,
135
    CODEC_ID_AASC,
136
    CODEC_ID_INDEO2,
137
    CODEC_ID_FRAPS,
138
    CODEC_ID_TRUEMOTION2,
mru's avatar
mru committed
139
    CODEC_ID_BMP,
140
    CODEC_ID_CSCD,
141
    CODEC_ID_MMVIDEO,
142
    CODEC_ID_ZMBV,
143
    CODEC_ID_AVS,
kostya's avatar
kostya committed
144
    CODEC_ID_SMACKVIDEO,
145
    CODEC_ID_NUV,
146
    CODEC_ID_KMVC,
147
    CODEC_ID_FLASHSV,
148
    CODEC_ID_CAVS,
149
    CODEC_ID_JPEG2000,
kostya's avatar
kostya committed
150
    CODEC_ID_VMNC,
aurel's avatar
aurel committed
151 152 153
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
kostya's avatar
kostya committed
154
    CODEC_ID_TARGA,
155
    CODEC_ID_DSICINVIDEO,
156
    CODEC_ID_TIERTEXSEQVIDEO,
kostya's avatar
kostya committed
157
    CODEC_ID_TIFF,
158
    CODEC_ID_GIF,
159
    CODEC_ID_FFH264,
kostya's avatar
kostya committed
160
    CODEC_ID_DXA,
bcoudurier's avatar
bcoudurier committed
161
    CODEC_ID_DNXHD,
162
    CODEC_ID_THP,
163
    CODEC_ID_SGI,
164
    CODEC_ID_C93,
165
    CODEC_ID_BETHSOFTVID,
ivo's avatar
ivo committed
166
    CODEC_ID_PTX,
ivo's avatar
ivo committed
167
    CODEC_ID_TXD,
168
    CODEC_ID_VP6A,
vitor's avatar
vitor committed
169
    CODEC_ID_AMV,
170
    CODEC_ID_VB,
ivo's avatar
ivo committed
171
    CODEC_ID_PCX,
ivo's avatar
ivo committed
172
    CODEC_ID_SUNRAST,
glantau's avatar
glantau committed
173

diego's avatar
diego committed
174
    /* various PCM "codecs" */
175
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
176 177 178 179 180 181 182
    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,
183 184 185 186 187 188 189 190 191
    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,
192
    CODEC_ID_PCM_ZORK,
193
    CODEC_ID_PCM_S16LE_PLANAR,
194

diego's avatar
diego committed
195
    /* various ADPCM codecs */
196
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
197
    CODEC_ID_ADPCM_IMA_WAV,
198 199
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
200
    CODEC_ID_ADPCM_IMA_WS,
201
    CODEC_ID_ADPCM_IMA_SMJPEG,
202
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
203
    CODEC_ID_ADPCM_4XM,
204 205
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
206
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
207
    CODEC_ID_ADPCM_G726,
208
    CODEC_ID_ADPCM_CT,
209
    CODEC_ID_ADPCM_SWF,
210
    CODEC_ID_ADPCM_YAMAHA,
211 212 213
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
214
    CODEC_ID_ADPCM_THP,
vitor's avatar
vitor committed
215
    CODEC_ID_ADPCM_IMA_AMV,
aurel's avatar
aurel committed
216 217 218
    CODEC_ID_ADPCM_EA_R1,
    CODEC_ID_ADPCM_EA_R3,
    CODEC_ID_ADPCM_EA_R2,
aurel's avatar
aurel committed
219
    CODEC_ID_ADPCM_IMA_EA_SEAD,
aurel's avatar
aurel committed
220
    CODEC_ID_ADPCM_IMA_EA_EACS,
221
    CODEC_ID_ADPCM_EA_XAS,
222

223 224
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
225 226
    CODEC_ID_AMR_WB,

227
    /* RealAudio codecs*/
228
    CODEC_ID_RA_144= 0x13000,
229
    CODEC_ID_RA_288,
230 231

    /* various DPCM codecs */
232
    CODEC_ID_ROQ_DPCM= 0x14000,
233
    CODEC_ID_INTERPLAY_DPCM,
234
    CODEC_ID_XAN_DPCM,
235
    CODEC_ID_SOL_DPCM,
236

237
    CODEC_ID_MP2= 0x15000,
238
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
239
    CODEC_ID_AAC,
240
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
241
    CODEC_ID_MPEG4AAC,
242
#endif
243 244 245 246 247 248 249 250 251 252 253
    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
254
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
255
    CODEC_ID_MP3ADU,
256
    CODEC_ID_MP3ON4,
257
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
258
    CODEC_ID_ALAC,
259
    CODEC_ID_WESTWOOD_SND1,
260
    CODEC_ID_GSM, ///< as in Berlin toast format
rtognimp's avatar
rtognimp committed
261
    CODEC_ID_QDM2,
262
    CODEC_ID_COOK,
263
    CODEC_ID_TRUESPEECH,
264
    CODEC_ID_TTA,
kostya's avatar
kostya committed
265
    CODEC_ID_SMACKAUDIO,
banan's avatar
banan committed
266
    CODEC_ID_QCELP,
kostya's avatar
kostya committed
267
    CODEC_ID_WAVPACK,
268
    CODEC_ID_DSICINAUDIO,
kostya's avatar
kostya committed
269
    CODEC_ID_IMC,
kostya's avatar
kostya committed
270
    CODEC_ID_MUSEPACK7,
271
    CODEC_ID_MLP,
diego's avatar
diego committed
272
    CODEC_ID_GSM_MS, /* as found in WAV */
banan's avatar
banan committed
273
    CODEC_ID_ATRAC3,
michael's avatar
michael committed
274
    CODEC_ID_VOXWARE,
kostya's avatar
kostya committed
275
    CODEC_ID_APE,
banan's avatar
banan committed
276
    CODEC_ID_NELLYMOSER,
kostya's avatar
kostya committed
277
    CODEC_ID_MUSEPACK8,
reimar's avatar
reimar committed
278
    CODEC_ID_SPEEX,
279 280
    CODEC_ID_WMAVOICE,
    CODEC_ID_WMAPRO,
281

bellard's avatar
bellard committed
282
    /* subtitle codecs */
283 284
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
285
    CODEC_ID_TEXT,  ///< raw UTF-8 text
286
    CODEC_ID_XSUB,
287
    CODEC_ID_SSA,
288
    CODEC_ID_MOV_TEXT,
289

290 291 292
    /* other specific kind of codecs (generaly used for attachments) */
    CODEC_ID_TTF= 0x18000,

293
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
diego's avatar
diego committed
294
                                * stream (only used by libavformat) */
glantau's avatar
glantau committed
295
};
296

297
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
298
/* CODEC_ID_MP3LAME is obsolete */
299
#define CODEC_ID_MP3LAME CODEC_ID_MP3
300 301
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
glantau's avatar
glantau committed
302 303

enum CodecType {
304
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
305 306
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
307
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
308
    CODEC_TYPE_SUBTITLE,
309
    CODEC_TYPE_ATTACHMENT,
310
    CODEC_TYPE_NB
glantau's avatar
glantau committed
311 312
};

313 314 315 316
/**
 * Currently unused, may be used if 24/32 bits samples are ever supported.
 * all in native-endian format
 */
glantau's avatar
glantau committed
317
enum SampleFormat {
mru's avatar
mru committed
318
    SAMPLE_FMT_NONE = -1,
319 320 321
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
322
    SAMPLE_FMT_S32,             ///< signed 32 bits
323
    SAMPLE_FMT_FLT,             ///< float
glantau's avatar
glantau committed
324 325
};

glantau's avatar
glantau committed
326
/* in bytes */
327
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
328

329
/**
330
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
diego's avatar
diego committed
331 332 333 334
 * This is mainly needed because some optimized bitstream readers read
 * 32 or 64 bit at once and could read over the end.<br>
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 * MPEG bitstreams could cause overread and segfault.
335 336 337
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

338
/**
diego's avatar
diego committed
339 340
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
341 342 343
 */
#define FF_MIN_BUFFER_SIZE 16384

344
/**
345
 * motion estimation type.
346
 */
347
enum Motion_Est_ID {
michael's avatar
michael committed
348
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
349 350 351
    ME_FULL,
    ME_LOG,
    ME_PHODS,
michael's avatar
michael committed
352 353 354 355 356
    ME_EPZS,        ///< enhanced predictive zonal search
    ME_X1,          ///< reserved for experiments
    ME_HEX,         ///< hexagon based search
    ME_UMH,         ///< uneven multi-hexagon search
    ME_ITER,        ///< iterative search
357 358
};

michael's avatar
michael committed
359
enum AVDiscard{
diego's avatar
diego committed
360 361
    /* We leave some space between them for extensions (drop some
     * keyframes for intra-only or drop just some bidir frames). */
michael's avatar
michael committed
362 363 364 365 366 367 368 369
    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
370 371 372
typedef struct RcOverride{
    int start_frame;
    int end_frame;
diego's avatar
diego committed
373
    int qscale; // If this is 0 then quality_factor will be used instead.
michaelni's avatar
michaelni committed
374 375 376
    float quality_factor;
} RcOverride;

377
#define FF_MAX_B_FRAMES 16
378

michaelni's avatar
michaelni committed
379
/* encoding support
diego's avatar
diego committed
380 381
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
michaelni's avatar
michaelni committed
382
*/
glantau's avatar
glantau committed
383

diego's avatar
diego committed
384 385 386 387 388 389
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
#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.
michael's avatar
michael committed
390 391
/**
 * The parent program guarantees that the input for B-frames containing
diego's avatar
diego committed
392
 * streams is not written to for at least s->max_b_frames+1 frames, if
michael's avatar
michael committed
393 394
 * this is not set the input will be copied.
 */
michaelni's avatar
michaelni committed
395
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
diego's avatar
diego committed
396 397 398 399 400 401 402 403
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
                                                  location instead of only at frame boundaries. */
diego's avatar
diego committed
404 405 406 407 408 409 410
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
#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).
411
/* Fx : Flag for h263+ extra options */
412
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
413
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
414
#endif
diego's avatar
diego committed
415 416 417 418 419
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
michael's avatar
michael committed
420 421
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
422 423
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
diego's avatar
diego committed
424
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
bcoudurier's avatar
bcoudurier committed
425
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
diego's avatar
diego committed
426 427 428 429 430 431
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
#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
432
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
lorenm's avatar
lorenm committed
433 434 435
#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
diego's avatar
diego committed
436 437 438 439 440 441 442
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
443
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
444

445
/* Unsupported options :
446 447
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
448
 *              Independent Segment Decoding */
449
/* /Fx */
glantau's avatar
glantau committed
450 451
/* codec capabilities */

diego's avatar
diego committed
452
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
michaelni's avatar
michaelni committed
453 454 455 456 457
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
diego's avatar
diego committed
458
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
459
#define CODEC_CAP_PARSE_ONLY      0x0004
460
#define CODEC_CAP_TRUNCATED       0x0008
diego's avatar
diego committed
461
/* Codec can export data for HW decoding (XvMC). */
462
#define CODEC_CAP_HWACCEL         0x0010
463
/**
diego's avatar
diego committed
464 465
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
466
 */
467
#define CODEC_CAP_DELAY           0x0020
468 469 470 471 472
/**
 * 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
473

diego's avatar
diego committed
474
//The following defines may change, don't expect compatibility if you use them.
475
#define MB_TYPE_INTRA4x4   0x0001
diego's avatar
diego committed
476 477
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
478 479 480 481 482
#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
diego's avatar
diego committed
483
#define MB_TYPE_DIRECT2    0x0100 //FIXME
484 485 486 487 488 489 490 491 492 493 494 495 496 497
#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, ...)

498 499
/**
 * Pan Scan area.
diego's avatar
diego committed
500 501
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
502 503 504
 */
typedef struct AVPanScan{
    /**
diego's avatar
diego committed
505 506 507
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
508 509 510 511 512
     */
    int id;

    /**
     * width and height in 1/16 pel
diego's avatar
diego committed
513 514
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
515 516 517 518 519
     */
    int width;
    int height;

    /**
diego's avatar
diego committed
520 521 522
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
523 524 525 526
     */
    int16_t position[3][2];
}AVPanScan;

michaelni's avatar
michaelni committed
527
#define FF_COMMON_FRAME \
michaelni's avatar
michaelni committed
528 529
    /**\
     * pointer to the picture planes.\
diego's avatar
diego committed
530
     * This might be different from the first allocated byte\
michaelni's avatar
michaelni committed
531 532 533
     * - encoding: \
     * - decoding: \
     */\
michaelni's avatar
michaelni committed
534 535 536
    uint8_t *data[4];\
    int linesize[4];\
    /**\
diego's avatar
diego committed
537 538
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
     * This isn't used by libavcodec unless the default get/release_buffer() is used.\
539 540
     * - encoding: \
     * - decoding: \
michaelni's avatar
michaelni committed
541 542 543 544
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
diego's avatar
diego committed
545 546
     * - encoding: Set by libavcodec.\
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
547 548 549 550
     */\
    int key_frame;\
\
    /**\
diego's avatar
diego committed
551 552 553
     * Picture type of the frame, see ?_TYPE below.\
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
554 555 556 557
     */\
    int pict_type;\
\
    /**\
michael's avatar
michael committed
558
     * presentation timestamp in time_base units (time when frame should be shown to user)\
diego's avatar
diego committed
559 560 561
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
     * - encoding: MUST be set by user.\
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
562
     */\
563
    int64_t pts;\
michaelni's avatar
michaelni committed
564 565
\
    /**\
diego's avatar
diego committed
566
     * picture number in bitstream order\
567
     * - encoding: set by\
diego's avatar
diego committed
568
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
569 570 571
     */\
    int coded_picture_number;\
    /**\
diego's avatar
diego committed
572
     * picture number in display order\
573
     * - encoding: set by\
diego's avatar
diego committed
574
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
575 576 577 578
     */\
    int display_picture_number;\
\
    /**\
579
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
diego's avatar
diego committed
580 581
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
582
     */\
583
    int quality; \
michaelni's avatar
michaelni committed
584 585 586
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
diego's avatar
diego committed
587
     * Set to INT_MAX if the buffer has not been used yet.\
588
     * - encoding: unused\
diego's avatar
diego committed
589
     * - decoding: MUST be set by get_buffer().\
michaelni's avatar
michaelni committed
590 591 592 593 594
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
595
     * - encoding: unused\
diego's avatar
diego committed
596
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
michaelni's avatar
michaelni committed
597 598 599 600 601
     */\
    int reference;\
\
    /**\
     * QP table\
602
     * - encoding: unused\
diego's avatar
diego committed
603
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
604 605 606 607
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
608
     * - encoding: unused\
diego's avatar
diego committed
609
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
610 611 612 613
     */\
    int qstride;\
\
    /**\
diego's avatar
diego committed
614
     * mbskip_table[mb]>=1 if MB didn't change\
michaelni's avatar
michaelni committed
615
     * stride= mb_width = (width+15)>>4\
616
     * - encoding: unused\
diego's avatar
diego committed
617
     * - decoding: Set by libavcodec.\
michaelni's avatar
michaelni committed
618 619
     */\
    uint8_t *mbskip_table;\
620 621
\
    /**\
diego's avatar
diego committed
622
     * motion vector table\
michael's avatar
michael committed
623 624 625 626 627 628 629
     * @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\
diego's avatar
diego committed
630 631
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
632 633 634 635
     */\
    int16_t (*motion_val[2])[2];\
\
    /**\
diego's avatar
diego committed
636
     * macroblock type table\
637
     * mb_type_base + mb_width + 2\
diego's avatar
diego committed
638 639
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
640 641 642 643
     */\
    uint32_t *mb_type;\
\
    /**\
michael's avatar
michael committed
644 645
     * log2 of the size of the block which a single vector in motion_val represents: \
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
646
     * - encoding: unused\
diego's avatar
diego committed
647
     * - decoding: Set by libavcodec.\
648 649
     */\
    uint8_t motion_subsample_log2;\
michaelni's avatar
michaelni committed
650 651 652
\
    /**\
     * for some private data of the user\
653
     * - encoding: unused\
diego's avatar
diego committed
654
     * - decoding: Set by user.\
michaelni's avatar
michaelni committed
655 656
     */\
    void *opaque;\
657 658 659
\
    /**\
     * error\
diego's avatar
diego committed
660
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
661
     * - decoding: unused\
662 663
     */\
    uint64_t error[4];\
michaelni's avatar
michaelni committed
664 665
\
    /**\
diego's avatar
diego committed
666 667 668 669
     * type of the buffer (to keep track of who has to deallocate data[*])\
     * - encoding: Set by the one who allocates it.\
     * - decoding: Set by the one who allocates it.\
     * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
michaelni's avatar
michaelni committed
670 671
     */\
    int type;\
672 673
    \
    /**\
diego's avatar
diego committed
674
     * When decoding, this signals how much the picture must be delayed.\
675
     * extra_delay = repeat_pict / (2*fps)\
676
     * - encoding: unused\
diego's avatar
diego committed
677
     * - decoding: Set by libavcodec.\
678
     */\
michaelni's avatar
michaelni committed
679 680 681 682 683 684
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
romansh's avatar
 
romansh committed
685 686 687
    \
    /**\
     * The content of the picture is interlaced.\
diego's avatar
diego committed
688 689
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec. (default 0)\
romansh's avatar
 
romansh committed
690 691 692 693
     */\
    int interlaced_frame;\
    \
    /**\
diego's avatar
diego committed
694 695 696
     * If the content is interlaced, is top field displayed first.\
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
romansh's avatar
 
romansh committed
697
     */\
698
    int top_field_first;\
699 700 701
    \
    /**\
     * Pan scan.\
diego's avatar
diego committed
702 703
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
704 705
     */\
    AVPanScan *pan_scan;\
706 707
    \
    /**\
diego's avatar
diego committed
708
     * Tell user application that palette has changed from previous frame.\
709
     * - encoding: ??? (no palette-enabled encoder yet)\
diego's avatar
diego committed
710
     * - decoding: Set by libavcodec. (default 0).\
711 712
     */\
    int palette_has_changed;\
713 714
    \
    /**\
diego's avatar
diego committed
715
     * codec suggestion on buffer type if != 0\
716
     * - encoding: unused\
diego's avatar
diego committed
717
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
718 719
     */\
    int buffer_hints;\
720 721
\
    /**\
diego's avatar
diego committed
722
     * DCT coefficients\
723
     * - encoding: unused\
diego's avatar
diego committed
724
     * - decoding: Set by libavcodec.\
725 726
     */\
    short *dct_coeff;\
727 728
\
    /**\
diego's avatar
diego committed
729 730 731
     * motion referece frame index\
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
732 733
     */\
    int8_t *ref_index[2];
734

735 736 737
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
738 739

#define FF_BUFFER_TYPE_INTERNAL 1
diego's avatar
diego committed
740 741 742
#define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
#define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate 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 deallocate anything.
michaelni's avatar
michaelni committed
743

michaelni's avatar
michaelni committed
744

diego's avatar
diego committed
745 746 747 748
#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
749 750
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
751

diego's avatar
diego committed
752 753 754 755
#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).
756

michaelni's avatar
michaelni committed
757 758
/**
 * Audio Video Frame.
759 760
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
 * bumps.
diego's avatar
diego committed
761
 * Removal, reordering and changes to existing fields require a major
762 763
 * version bump. No fields should be added into AVFrame before or after
 * FF_COMMON_FRAME!
diego's avatar
diego committed
764
 * sizeof(AVFrame) must not be used outside libav*.
michaelni's avatar
michaelni committed
765
 */
michaelni's avatar
michaelni committed
766 767 768
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
769

770
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
771 772

/**
773 774
 * main external API structure.
 * New fields can be added to the end with minor version bumps.
diego's avatar
diego committed
775
 * Removal, reordering and changes to existing fields require a major
776
 * version bump.
diego's avatar
diego committed
777
 * sizeof(AVCodecContext) must not be used outside libav*.
michaelni's avatar
doxy  
michaelni committed
778
 */
glantau's avatar
glantau committed
779
typedef struct AVCodecContext {
780
    /**
diego's avatar
diego committed
781
     * information on struct for av_log
782 783
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
784
    AVClass *av_class;
785
    /**
diego's avatar
diego committed
786 787 788
     * the average bitrate
     * - encoding: Set by user; unused for constant quantizer encoding.
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
789
     */
glantau's avatar
glantau committed
790
    int bit_rate;
791 792

    /**
793
     * number of bits the bitstream is allowed to diverge from the reference.
794
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
diego's avatar
diego committed
795
     * - encoding: Set by user; unused for constant quantizer encoding.
796
     * - decoding: unused
797
     */
798
    int bit_rate_tolerance;
799 800

    /**
801
     * CODEC_FLAG_*.
diego's avatar
diego committed
802 803
     * - encoding: Set by user.
     * - decoding: Set by user.
804
     */
glantau's avatar
glantau committed
805
    int flags;
806 807

    /**
diego's avatar
diego committed
808 809 810 811 812 813
     * Some codecs need additional format info. It is stored here.
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
     * specific codec MUST set it correctly otherwise stream copy breaks.
     * In general use of this field by muxers is not recommanded.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
814 815 816 817
     */
    int sub_id;

    /**
diego's avatar
diego committed
818
     * Motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
819 820
     * 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]
821 822
     * - encoding: MUST be set by user.
     * - decoding: unused
823 824 825 826
     */
    int me_method;

    /**
diego's avatar
diego committed
827 828
     * some codecs need / can use extradata like Huffman tables.
     * mjpeg: Huffman tables
829
     * rv10: additional flags
830
     * mpeg4: global headers (they can be in the bitstream or here)
diego's avatar
diego committed
831 832 833 834 835
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
     * - encoding: Set/allocated/freed by libavcodec.
     * - decoding: Set/allocated/freed by user.
836
     */
837
    uint8_t *extradata;
838
    int extradata_size;
839

840
    /**
diego's avatar
diego committed
841 842
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
843 844
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
diego's avatar
diego committed
845 846
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
847
     */
michael's avatar
michael committed
848
    AVRational time_base;
849

850
    /* video only */
851
    /**
852
     * picture width / height.
853
     * - encoding: MUST be set by user.
diego's avatar
diego committed
854 855 856
     * - decoding: Set by libavcodec.
     * Note: For compatibility it is possible to set this instead of
     * coded_width/height before decoding.
857
     */
glantau's avatar
glantau committed
858
    int width, height;
859

860
#define FF_ASPECT_EXTENDED 15
861 862

    /**
diego's avatar
diego committed
863 864
     * the number of pictures in a group of pictures, or 0 for intra_only
     * - encoding: Set by user.
865
     * - decoding: unused
866 867 868 869
     */
    int gop_size;

    /**
diego's avatar
diego committed
870 871 872
     * Pixel format, see PIX_FMT_xxx.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
873
     */
874
    enum PixelFormat pix_fmt;
875

876
    /**
diego's avatar
diego committed
877
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
878
     * has to read frames at native frame rate.
diego's avatar
diego committed
879 880
     * - encoding: Set by user.
     * - decoding: unused
881 882
     */
    int rate_emu;
883

884
    /**
diego's avatar
diego committed
885 886
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw a horizontal band. It improves cache usage. Not
887
     * all codecs can do that. You must check the codec capabilities
diego's avatar
diego committed
888
     * beforehand.
889
     * - encoding: unused
diego's avatar
diego committed
890
     * - decoding: Set by user.
891 892 893 894
     * @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
895
     */
glantau's avatar
glantau committed
896
    void (*draw_horiz_band)(struct AVCodecContext *s,
897
                            const AVFrame *src, int offset[4],
898
                            int y, int type, int height);
glantau's avatar
glantau committed
899

glantau's avatar
glantau committed
900
    /* audio only */
diego's avatar
diego committed
901
    int sample_rate; ///< samples per second
glantau's avatar
glantau committed
902
    int channels;
903 904

    /**
diego's avatar
diego committed
905 906 907
     * audio sample format
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
908
     */
diego's avatar
diego committed
909
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
glantau's avatar
glantau committed
910

diego's avatar
diego committed
911
    /* The following data should not be initialized. */
912
    /**
diego's avatar
diego committed
913
     * Samples per packet, initialized when calling 'init'.
914 915
     */
    int frame_size;
916
    int frame_number;   ///< audio or video frame number
diego's avatar
diego committed
917
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
918

919
    /**
diego's avatar
diego committed
920
     * Number of frames the decoded output will be delayed relative to
921
     * the encoded input.
diego's avatar
diego committed
922
     * - encoding: Set by libavcodec.
923
     * - decoding: unused
924 925
     */
    int delay;
926

927 928
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
929 930
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

931
    /**
diego's avatar
diego committed
932 933
     * minimum quantizer
     * - encoding: Set by user.
934
     * - decoding: unused
935 936 937 938
     */
    int qmin;

    /**
diego's avatar
diego committed
939 940
     * maximum quantizer
     * - encoding: Set by user.
941
     * - decoding: unused
942 943 944 945
     */
    int qmax;

    /**
diego's avatar
diego committed
946 947
     * maximum quantizer difference between frames
     * - encoding: Set by user.
948
     * - decoding: unused
949 950 951 952
     */
    int max_qdiff;

    /**
diego's avatar
diego committed
953 954 955
     * maximum number of B-frames between non-B-frames
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
     * - encoding: Set by user.
956
     * - decoding: unused
957 958 959 960
     */
    int max_b_frames;

    /**
diego's avatar
diego committed
961 962
     * qscale factor between IP and B-frames
     * - encoding: Set by user.
963
     * - decoding: unused
964 965
     */
    float b_quant_factor;
966

967 968
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
969 970
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
971
    int b_frame_strategy;
972

973
    /**
diego's avatar
diego committed
974
     * hurry up amount
975
     * - encoding: unused
diego's avatar
diego committed
976
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
takis's avatar
takis committed
977
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
978 979
     */
    int hurry_up;
980

glantau's avatar
glantau committed
981
    struct AVCodec *codec;
982

glantau's avatar
glantau committed
983 984
    void *priv_data;

985
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
michael's avatar
michael committed
986 987
    /* unused, FIXME remove*/
    int rtp_mode;
988
#endif
989

diego's avatar
diego committed
990
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
diego's avatar
diego committed
991
                            /* do its best to deliver a chunk with size     */
992
                            /* below rtp_payload_size, the chunk will start */
diego's avatar
diego committed
993
                            /* with a start code on some codecs like H.263. */
994
                            /* This doesn't take account of any particular  */
diego's avatar
diego committed
995
                            /* headers inside the transmitted RTP payload.  */
996

997

diego's avatar
diego committed
998 999 1000 1001 1002 1003
    /* The RTP callback: This function is called    */
    /* every time the encoder has a packet to send. */
    /* It 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.                  */
1004
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1005

michaelni's avatar
michaelni committed
1006 1007 1008 1009 1010 1011 1012 1013
    /* 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;
1014
    int misc_bits;
1015

1016
    /**
diego's avatar
diego committed
1017 1018
     * number of bits used for the previously encoded frame
     * - encoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1019
     * - decoding: unused
1020
     */
michaelni's avatar
michaelni committed
1021
    int frame_bits;
michaelni's avatar
michaelni committed
1022

1023
    /**
diego's avatar
diego committed
1024 1025 1026
     * Private data of the user, can be used to carry app specific stuff.
     * - encoding: Set by user.
     * - decoding: Set by user.
1027 1028 1029
     */
    void *opaque;

glantau's avatar
glantau committed
1030
    char codec_name[32];
1031 1032
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1033

michaelni's avatar
michaelni committed
1034 1035
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1036 1037 1038 1039 1040 1041
     * This is used to work around some encoder bugs.
     * A demuxer should set this to what is stored in the field used to identify the codec.
     * If there are multiple such fields in a container then the demuxer should choose the one
     * which maximizes the information about the used codec.
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
michael's avatar
michael committed
1042
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
diego's avatar
diego committed
1043 1044 1045
     * first.
     * - encoding: Set by user, if not then the default based on codec_id will be used.
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
michaelni's avatar
michaelni committed
1046 1047
     */
    unsigned int codec_tag;
1048

1049
    /**
diego's avatar
diego committed
1050 1051 1052
     * Work around bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: Set by user
     * - decoding: Set by user
1053 1054
     */
    int workaround_bugs;
1055
#define FF_BUG_AUTODETECT       1  ///< autodetection
1056 1057 1058 1059
#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
1060
#define FF_BUG_AMV              32
diego's avatar
diego committed
1061
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
michaelni's avatar
michaelni committed
1062
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
1063
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
1064
#define FF_BUG_QPEL_CHROMA2     256
1065
#define FF_BUG_DIRECT_BLOCKSIZE 512
1066
#define FF_BUG_EDGE             1024
1067
#define FF_BUG_HPEL_CHROMA      2048
1068
#define FF_BUG_DC_CLIP          4096
diego's avatar
diego committed
1069 1070
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1071

1072
    /**
diego's avatar
diego committed
1073 1074
     * luma single coefficient elimination threshold
     * - encoding: Set by user.
1075
     * - decoding: unused
1076
     */
michaelni's avatar
 
michaelni committed
1077
    int luma_elim_threshold;
1078

1079
    /**
diego's avatar
diego committed
1080 1081
     * chroma single coeff elimination threshold
     * - encoding: Set by user.
1082
     * - decoding: unused
1083
     */
michaelni's avatar
 
michaelni committed
1084
    int chroma_elim_threshold;
1085

1086
    /**
diego's avatar
diego committed
1087 1088
     * strictly follow the standard (MPEG4, ...).
     * - encoding: Set by user.
1089
     * - decoding: unused
1090 1091
     */
    int strict_std_compliance;
diego's avatar
diego committed
1092 1093
#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.
1094
#define FF_COMPLIANCE_NORMAL        0
diego's avatar
diego committed
1095 1096
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1097

1098
    /**
diego's avatar
diego committed
1099 1100 1101 1102
     * qscale offset between IP and B-frames
     * 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).
     * - encoding: Set by user.
1103
     * - decoding: unused
1104 1105
     */
    float b_quant_offset;
1106

1107
    /**
diego's avatar
diego committed
1108 1109
     * Error resilience; higher values will detect more errors but may
     * misdetect some more or less valid parts as errors.
1110
     * - encoding: unused
diego's avatar
diego committed
1111
     * - decoding: Set by user.
1112
     */
michaelni's avatar
 
michaelni committed
1113
    int error_resilience;
diego's avatar
diego committed
1114
#define FF_ER_CAREFUL         1
1115 1116 1117
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1118

1119
    /**
diego's avatar
diego committed
1120 1121
     * 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 libavcodec.
michael's avatar
michael committed
1122
     * avcodec_align_dimensions() should be used to find the required width and
diego's avatar
diego committed
1123
     * height, as they normally need to be rounded up to the next multiple of 16.
1124
     * - encoding: unused
diego's avatar
diego committed
1125
     * - decoding: Set by libavcodec., user can override.
1126
     */
michaelni's avatar
michaelni committed
1127
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1128

1129
    /**
diego's avatar
diego committed
1130 1131 1132
     * 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.
1133
     * - encoding: unused
diego's avatar
diego committed
1134
     * - decoding: Set by libavcodec., user can override.
1135
     */
michaelni's avatar
michaelni committed
1136
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1137

1138
    /**
diego's avatar
diego committed
1139 1140 1141
     * If 1 the stream has a 1 frame delay during decoding.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
1142 1143
     */
    int has_b_frames;
1144 1145 1146

    /**
     * number of bytes per packet if constant and known or 0
diego's avatar
diego committed
1147
     * Used by some WAV based audio codecs.
1148 1149
     */
    int block_align;
1150

diego's avatar
diego committed
1151
    int parse_only; /* - decoding only: If true, only parsing is done
1152 1153
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1154

1155
    /**
diego's avatar
diego committed
1156 1157
     * 0-> h263 quant 1-> mpeg quant
     * - encoding: Set by user.
1158
     * - decoding: unused
1159 1160
     */
    int mpeg_quant;
1161

1162
    /**
diego's avatar
diego committed
1163 1164
     * pass1 encoding statistics output buffer
     * - encoding: Set by libavcodec.
1165
     * - decoding: unused
1166
     */
1167
    char *stats_out;
1168

1169
    /**
diego's avatar
diego committed
1170 1171 1172
     * pass2 encoding statistics input buffer
     * Concatenated stuff from stats_out of pass1 should be placed here.
     * - encoding: Allocated/set/freed by user.
1173
     * - decoding: unused
1174 1175
     */
    char *stats_in;
1176

1177
    /**
diego's avatar
diego committed
1178 1179 1180
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
     * - encoding: Set by user.
1181
     * - decoding: unused
1182
     */
michaelni's avatar
michaelni committed
1183
    float rc_qsquish;
1184

michaelni's avatar
michaelni committed
1185 1186
    float rc_qmod_amp;
    int rc_qmod_freq;
1187

1188
    /**
diego's avatar
diego committed
1189 1190
     * ratecontrol override, see RcOverride
     * - encoding: Allocated/set/freed by user.
1191
     * - decoding: unused
1192
     */
michaelni's avatar
michaelni committed
1193 1194
    RcOverride *rc_override;
    int rc_override_count;
1195

1196
    /**
diego's avatar
diego committed
1197 1198
     * rate control equation
     * - encoding: Set by user
1199
     * - decoding: unused
1200
     */
lucabe's avatar
Fix  
lucabe committed
1201
    const char *rc_eq;
1202

1203
    /**
diego's avatar
diego committed
1204 1205
     * maximum bitrate
     * - encoding: Set by user.
1206
     * - decoding: unused
1207
     */
michaelni's avatar
michaelni committed
1208
    int rc_max_rate;
1209

1210
    /**
diego's avatar
diego committed
1211 1212
     * minimum bitrate
     * - encoding: Set by user.
1213
     * - decoding: unused
1214
     */
michaelni's avatar
michaelni committed
1215
    int rc_min_rate;
1216

1217
    /**
diego's avatar
diego committed
1218 1219
     * decoder bitstream buffer size
     * - encoding: Set by user.
1220
     * - decoding: unused
1221
     */
michaelni's avatar
michaelni committed
1222 1223
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1224 1225

    /**
diego's avatar
diego committed
1226 1227 1228 1229
     * qscale factor between P and I-frames
     * 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).
     * - encoding: Set by user.
1230
     * - decoding: unused
1231 1232
     */
    float i_quant_factor;
1233

1234
    /**
diego's avatar
diego committed
1235 1236
     * qscale offset between P and I-frames
     * - encoding: Set by user.
1237
     * - decoding: unused
1238 1239
     */
    float i_quant_offset;
1240

1241
    /**
diego's avatar
diego committed
1242 1243
     * initial complexity for pass1 ratecontrol
     * - encoding: Set by user.
1244
     * - decoding: unused
1245
     */
michaelni's avatar
michaelni committed
1246
    float rc_initial_cplx;
1247

1248
    /**
diego's avatar
diego committed
1249 1250
     * DCT algorithm, see FF_DCT_* below
     * - encoding: Set by user.
1251
     * - decoding: unused
1252
     */
1253
    int dct_algo;
1254
#define FF_DCT_AUTO    0
1255
#define FF_DCT_FASTINT 1
1256 1257 1258
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1259
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1260
#define FF_DCT_FAAN    6
1261

1262
    /**
diego's avatar
diego committed
1263 1264
     * luminance masking (0-> disabled)
     * - encoding: Set by user.
1265
     * - decoding: unused
1266 1267
     */
    float lumi_masking;
1268

1269
    /**
diego's avatar
diego committed
1270 1271
     * temporary complexity masking (0-> disabled)
     * - encoding: Set by user.
1272
     * - decoding: unused
1273 1274
     */
    float temporal_cplx_masking;
1275

1276
    /**
diego's avatar
diego committed
1277 1278
     * spatial complexity masking (0-> disabled)
     * - encoding: Set by user.
1279
     * - decoding: unused
1280 1281
     */
    float spatial_cplx_masking;
1282

1283
    /**
diego's avatar
diego committed
1284 1285
     * p block masking (0-> disabled)
     * - encoding: Set by user.
1286
     * - decoding: unused
1287 1288
     */
    float p_masking;
1289

1290
    /**
diego's avatar
diego committed
1291 1292
     * darkness masking (0-> disabled)
     * - encoding: Set by user.
1293
     * - decoding: unused
1294 1295
     */
    float dark_masking;
1296 1297


1298
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1299 1300
    /* for binary compatibility */
    int unused;
1301
#endif
1302

1303
    /**
diego's avatar
diego committed
1304 1305 1306
     * IDCT algorithm, see FF_IDCT_* below.
     * - encoding: Set by user.
     * - decoding: Set by user.
1307 1308
     */
    int idct_algo;
diego's avatar
diego committed
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
#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
#define FF_IDCT_ALTIVEC       8
#define FF_IDCT_SH4           9
#define FF_IDCT_SIMPLEARM     10
#define FF_IDCT_H264          11
#define FF_IDCT_VP3           12
#define FF_IDCT_IPP           13
#define FF_IDCT_XVIDMMX       14
#define FF_IDCT_CAVS          15
mru's avatar
mru committed
1325
#define FF_IDCT_SIMPLEARMV5TE 16
diego's avatar
diego committed
1326
#define FF_IDCT_SIMPLEARMV6   17
1327
#define FF_IDCT_SIMPLEVIS     18
michael's avatar
michael committed
1328
#define FF_IDCT_WMV2          19
michael's avatar
michael committed
1329
#define FF_IDCT_FAAN          20
1330

1331
    /**
diego's avatar
diego committed
1332 1333 1334
     * slice count
     * - encoding: Set by libavcodec.
     * - decoding: Set by user (or 0).
1335 1336 1337
     */
    int slice_count;
    /**
diego's avatar
diego committed
1338 1339 1340
     * slice offsets in the frame in bytes
     * - encoding: Set/allocated by libavcodec.
     * - decoding: Set/allocated by user (or NULL).
1341 1342 1343
     */
    int *slice_offset;

1344
    /**
diego's avatar
diego committed
1345
     * error concealment flags
1346
     * - encoding: unused
diego's avatar
diego committed
1347
     * - decoding: Set by user.
1348 1349 1350 1351 1352
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1353
    /**
kabi's avatar
kabi committed
1354
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1355
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1356
     *
diego's avatar
diego committed
1357 1358 1359
     * With the FORCE flag you may instead enable given CPU features.
     * (Dangerous: Usable in case of misdetection, improper usage however will
     * result into program crash.)
kabi's avatar
kabi committed
1360 1361
     */
    unsigned dsp_mask;
diego's avatar
diego committed
1362
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
kabi's avatar
kabi committed
1363
    /* lower 16 bits - CPU features */
michael's avatar
michael committed
1364 1365 1366 1367 1368 1369 1370 1371 1372
#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
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
michaelni's avatar
michaelni committed
1373 1374

    /**
1375
     * bits per sample/pixel from the demuxer (needed for huffyuv).
diego's avatar
diego committed
1376 1377
     * - encoding: Set by libavcodec.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1378 1379
     */
     int bits_per_sample;
1380

michaelni's avatar
michaelni committed
1381
    /**
diego's avatar
diego committed
1382 1383
     * prediction method (needed for huffyuv)
     * - encoding: Set by user.
1384
     * - decoding: unused
michaelni's avatar
michaelni committed
1385 1386 1387 1388 1389
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1390

michaelni's avatar
michaelni committed
1391
    /**
diego's avatar
diego committed
1392 1393 1394 1395
     * sample aspect ratio (0 if unknown)
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1396
     */
michael's avatar
michael committed
1397
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1398 1399

    /**
diego's avatar
diego committed
1400 1401 1402
     * the picture in the bitstream
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1403
     */
michaelni's avatar
michaelni committed
1404
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1405 1406

    /**
diego's avatar
diego committed
1407 1408 1409
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1410 1411
     */
    int debug;
diego's avatar
diego committed
1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
#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
#define FF_DEBUG_DCT_COEFF   0x00000040
#define FF_DEBUG_SKIP        0x00000080
#define FF_DEBUG_STARTCODE   0x00000100
#define FF_DEBUG_PTS         0x00000200
#define FF_DEBUG_ER          0x00000400
#define FF_DEBUG_MMCO        0x00000800
#define FF_DEBUG_BUGS        0x00001000
#define FF_DEBUG_VIS_QP      0x00002000
michael's avatar
michael committed
1426
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1427

1428
    /**
diego's avatar
diego committed
1429 1430 1431
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1432 1433 1434 1435 1436 1437
     */
    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

1438
    /**
diego's avatar
diego committed
1439 1440
     * error
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1441
     * - decoding: unused
1442 1443
     */
    uint64_t error[4];
1444

michaelni's avatar
michaelni committed
1445
    /**
diego's avatar
diego committed
1446
     * minimum MB quantizer
1447
     * - encoding: unused
1448
     * - decoding: unused
michaelni's avatar
michaelni committed
1449 1450 1451 1452
     */
    int mb_qmin;

    /**
diego's avatar
diego committed
1453
     * maximum MB quantizer
1454
     * - encoding: unused
1455
     * - decoding: unused
michaelni's avatar
michaelni committed
1456 1457
     */
    int mb_qmax;
1458

michaelni's avatar
michaelni committed
1459
    /**
diego's avatar
diego committed
1460 1461
     * motion estimation comparison function
     * - encoding: Set by user.
1462
     * - decoding: unused
michaelni's avatar
michaelni committed
1463 1464 1465
     */
    int me_cmp;
    /**
diego's avatar
diego committed
1466 1467
     * subpixel motion estimation comparison function
     * - encoding: Set by user.
1468
     * - decoding: unused
michaelni's avatar
michaelni committed
1469 1470 1471
     */
    int me_sub_cmp;
    /**
diego's avatar
diego committed
1472 1473
     * macroblock comparison function (not supported yet)
     * - encoding: Set by user.
1474
     * - decoding: unused
michaelni's avatar
michaelni committed
1475 1476
     */
    int mb_cmp;
michael's avatar
michael committed
1477
    /**
diego's avatar
diego committed
1478 1479
     * interlaced DCT comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1480 1481 1482
     * - decoding: unused
     */
    int ildct_cmp;
diego's avatar
diego committed
1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
#define FF_CMP_SAD    0
#define FF_CMP_SSE    1
#define FF_CMP_SATD   2
#define FF_CMP_DCT    3
#define FF_CMP_PSNR   4
#define FF_CMP_BIT    5
#define FF_CMP_RD     6
#define FF_CMP_ZERO   7
#define FF_CMP_VSAD   8
#define FF_CMP_VSSE   9
#define FF_CMP_NSSE   10
#define FF_CMP_W53    11
#define FF_CMP_W97    12
michael's avatar
michael committed
1496
#define FF_CMP_DCTMAX 13
1497
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1498
#define FF_CMP_CHROMA 256
1499

michaelni's avatar
michaelni committed
1500
    /**
diego's avatar
diego committed
1501 1502
     * ME diamond size & shape
     * - encoding: Set by user.
1503
     * - decoding: unused
michaelni's avatar
michaelni committed
1504 1505
     */
    int dia_size;
michaelni's avatar
michaelni committed
1506 1507

    /**
diego's avatar
diego committed
1508 1509
     * amount of previous MV predictors (2a+1 x 2a+1 square)
     * - encoding: Set by user.
1510
     * - decoding: unused
michaelni's avatar
michaelni committed
1511 1512
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1513

michaelni's avatar
michaelni committed
1514
    /**
diego's avatar
diego committed
1515 1516
     * prepass for motion estimation
     * - encoding: Set by user.
1517
     * - decoding: unused
michaelni's avatar
michaelni committed
1518 1519
     */
    int pre_me;
michaelni's avatar
michaelni committed
1520

michaelni's avatar
michaelni committed
1521
    /**
diego's avatar
diego committed
1522 1523
     * motion estimation prepass comparison function
     * - encoding: Set by user.
1524
     * - decoding: unused
michaelni's avatar
michaelni committed
1525 1526
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1527

michaelni's avatar
michaelni committed
1528
    /**
diego's avatar
diego committed
1529 1530
     * ME prepass diamond size & shape
     * - encoding: Set by user.
1531
     * - decoding: unused
michaelni's avatar
michaelni committed
1532 1533 1534
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1535
    /**
diego's avatar
diego committed
1536 1537
     * subpel ME quality
     * - encoding: Set by user.
1538
     * - decoding: unused
michaelni's avatar
michaelni committed
1539 1540 1541
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1542
    /**
diego's avatar
diego committed
1543
     * callback to negotiate the pixelFormat
michaelni's avatar
michaelni committed
1544
     * @param fmt is the list of formats which are supported by the codec,
diego's avatar
diego committed
1545 1546 1547
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
     * The first is always the native one.
     * @return the chosen format
1548
     * - encoding: unused
diego's avatar
diego committed
1549
     * - decoding: Set by user, if not set the native format will be chosen.
michaelni's avatar
michaelni committed
1550
     */
iive's avatar
iive committed
1551
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1552 1553

    /**
diego's avatar
diego committed
1554 1555 1556
     * DTG active format information (additional aspect ratio
     * information only used in DVB MPEG-2 transport streams)
     * 0 if not set.
1557
     *
diego's avatar
diego committed
1558 1559
     * - encoding: unused
     * - decoding: Set by decoder.
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
     */
    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

1570
    /**
diego's avatar
diego committed
1571 1572
     * maximum motion estimation search range in subpel units
     * If 0 then no limit.
1573
     *
diego's avatar
diego committed
1574 1575
     * - encoding: Set by user.
     * - decoding: unused
1576
     */
kabi's avatar
kabi committed
1577
    int me_range;
1578

michaelni's avatar
michaelni committed
1579
    /**
diego's avatar
diego committed
1580 1581
     * intra quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1582 1583 1584 1585
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1586

michaelni's avatar
michaelni committed
1587
    /**
diego's avatar
diego committed
1588 1589
     * inter quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1590 1591 1592
     * - decoding: unused
     */
    int inter_quant_bias;
1593 1594

    /**
diego's avatar
diego committed
1595 1596 1597 1598
     * color table ID
     * - encoding: unused
     * - decoding: Which clrtable should be used for 8bit RGB images.
     *             Tables have to be stored somewhere. FIXME
1599 1600
     */
    int color_table_id;
1601

1602
    /**
diego's avatar
diego committed
1603 1604
     * internal_buffer count
     * Don't touch, used by libavcodec default_get_buffer().
1605 1606
     */
    int internal_buffer_count;
1607

1608
    /**
diego's avatar
diego committed
1609 1610
     * internal_buffers
     * Don't touch, used by libavcodec default_get_buffer().
1611 1612
     */
    void *internal_buffer;
1613 1614 1615 1616 1617 1618 1619

#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
1620
    /**
diego's avatar
diego committed
1621 1622 1623
     * Global quality for codecs which cannot change it per frame.
     * This should be proportional to MPEG-1/2/4 qscale.
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1624 1625 1626
     * - decoding: unused
     */
    int global_quality;
1627

michael's avatar
michael committed
1628 1629
#define FF_CODER_TYPE_VLC       0
#define FF_CODER_TYPE_AC        1
1630 1631 1632
#define FF_CODER_TYPE_RAW       2
#define FF_CODER_TYPE_RLE       3
#define FF_CODER_TYPE_DEFLATE   4
michaelni's avatar
michaelni committed
1633 1634
    /**
     * coder type
diego's avatar
diego committed
1635
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1636 1637 1638 1639 1640 1641
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
diego's avatar
diego committed
1642
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1643 1644 1645
     * - decoding: unused
     */
    int context_model;
1646 1647 1648 1649
#if 0
    /**
     *
     * - encoding: unused
diego's avatar
diego committed
1650
     * - decoding: Set by user.
1651 1652 1653
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1654

1655 1656 1657
    /**
     * slice flags
     * - encoding: unused
diego's avatar
diego committed
1658
     * - decoding: Set by user.
1659 1660 1661 1662 1663 1664
     */
    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
1665 1666 1667 1668 1669 1670
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1671

1672 1673
    /**
     * macroblock decision mode
diego's avatar
diego committed
1674
     * - encoding: Set by user.
1675 1676 1677 1678 1679 1680
     * - 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
1681 1682 1683

    /**
     * custom intra quantization matrix
diego's avatar
diego committed
1684 1685
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1686 1687 1688 1689 1690
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
diego's avatar
diego committed
1691 1692
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1693 1694
     */
    uint16_t *inter_matrix;
1695

1696 1697
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1698
     * This is used to work around some encoder bugs.
1699
     * - encoding: unused
diego's avatar
diego committed
1700
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1701 1702
     */
    unsigned int stream_codec_tag;
michaelni's avatar
michaelni committed
1703 1704

    /**
diego's avatar
diego committed
1705 1706 1707
     * scene change detection threshold
     * 0 is default, larger means fewer detected scene changes.
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1708 1709 1710
     * - decoding: unused
     */
    int scenechange_threshold;
1711 1712

    /**
diego's avatar
diego committed
1713 1714
     * minimum Lagrange multipler
     * - encoding: Set by user.
1715 1716 1717 1718 1719
     * - decoding: unused
     */
    int lmin;

    /**
diego's avatar
diego committed
1720 1721
     * maximum Lagrange multipler
     * - encoding: Set by user.
1722 1723 1724
     * - decoding: unused
     */
    int lmax;
1725 1726

    /**
diego's avatar
diego committed
1727
     * palette control structure
1728
     * - encoding: ??? (no palette-enabled encoder yet)
diego's avatar
diego committed
1729
     * - decoding: Set by user.
1730 1731
     */
    struct AVPaletteControl *palctrl;
1732 1733 1734

    /**
     * noise reduction strength
diego's avatar
diego committed
1735
     * - encoding: Set by user.
1736 1737 1738
     * - decoding: unused
     */
    int noise_reduction;
1739

1740
    /**
diego's avatar
diego committed
1741 1742 1743
     * Called at the beginning of a frame to get cr buffer for it.
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
     * libavcodec will pass previous buffer in pic, function should return
1744
     * same buffer or new buffer with old frame "painted" into it.
diego's avatar
diego committed
1745
     * If pic.data[0] == NULL must behave like get_buffer().
1746
     * - encoding: unused
diego's avatar
diego committed
1747
     * - decoding: Set by libavcodec., user can override
1748
     */
1749
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1750 1751

    /**
diego's avatar
diego committed
1752 1753
     * Number of bits which should be loaded into the rc buffer before decoding starts.
     * - encoding: Set by user.
michael's avatar
michael committed
1754 1755 1756 1757 1758 1759
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
diego's avatar
diego committed
1760
     * - encoding: Set by user.
michael's avatar
michael committed
1761 1762 1763 1764 1765
     * - decoding: unused
     */
    int inter_threshold;

    /**
diego's avatar
diego committed
1766 1767 1768
     * CODEC_FLAG2_*
     * - encoding: Set by user.
     * - decoding: Set by user.
michael's avatar
michael committed
1769 1770
     */
    int flags2;
michael's avatar
michael committed
1771 1772

    /**
diego's avatar
diego committed
1773 1774 1775
     * Simulates errors in the bitstream to test error concealment.
     * - encoding: Set by user.
     * - decoding: unused
michael's avatar
michael committed
1776 1777
     */
    int error_rate;
1778

1779 1780 1781
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
diego's avatar
diego committed
1782
     * - decoding: Set by user.
1783 1784 1785 1786 1787 1788
     */
    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
1789
    /**
diego's avatar
diego committed
1790 1791
     * quantizer noise shaping
     * - encoding: Set by user.
michael's avatar
michael committed
1792 1793 1794
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1795 1796

    /**
diego's avatar
diego committed
1797
     * thread count
1798
     * is used to decide how many independent tasks should be passed to execute()
diego's avatar
diego committed
1799 1800
     * - encoding: Set by user.
     * - decoding: Set by user.
1801 1802
     */
    int thread_count;
1803

1804
    /**
diego's avatar
diego committed
1805 1806 1807 1808
     * The codec may call this to execute several independent 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
1809
     * @param count the number of things to execute
diego's avatar
diego committed
1810 1811
     * - encoding: Set by libavcodec, user can override.
     * - decoding: Set by libavcodec, user can override.
1812 1813
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1814

1815
    /**
diego's avatar
diego committed
1816 1817
     * thread opaque
     * Can be used by execute() to store some per AVCodecContext stuff.
1818 1819 1820 1821
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1822 1823

    /**
diego's avatar
diego committed
1824 1825
     * Motion estimation threshold below which no motion estimation is
     * performed, but instead the user specified motion vectors are used.
1826
     *
diego's avatar
diego committed
1827
     * - encoding: Set by user.
1828
     * - decoding: unused
1829
     */
michael's avatar
michael committed
1830
     int me_threshold;
1831 1832

    /**
diego's avatar
diego committed
1833 1834
     * Macroblock threshold below which the user specified macroblock types will be used.
     * - encoding: Set by user.
1835 1836 1837
     * - decoding: unused
     */
     int mb_threshold;
1838 1839

    /**
diego's avatar
diego committed
1840 1841
     * precision of the intra DC coefficient - 8
     * - encoding: Set by user.
1842 1843 1844
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1845 1846

    /**
diego's avatar
diego committed
1847 1848
     * noise vs. sse weight for the nsse comparsion function
     * - encoding: Set by user.
michael's avatar
michael committed
1849 1850 1851
     * - decoding: unused
     */
     int nsse_weight;
1852 1853

    /**
diego's avatar
diego committed
1854
     * Number of macroblock rows at the top which are skipped.
1855
     * - encoding: unused
diego's avatar
diego committed
1856
     * - decoding: Set by user.
1857 1858 1859 1860
     */
     int skip_top;

    /**
diego's avatar
diego committed
1861
     * Number of macroblock rows at the bottom which are skipped.
1862
     * - encoding: unused
diego's avatar
diego committed
1863
     * - decoding: Set by user.
1864 1865
     */
     int skip_bottom;
michael's avatar
michael committed
1866 1867 1868

    /**
     * profile
diego's avatar
diego committed
1869 1870
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1871 1872 1873
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99
benoit's avatar
 
benoit committed
1874
#define FF_PROFILE_AAC_MAIN 0
diego's avatar
diego committed
1875 1876 1877
#define FF_PROFILE_AAC_LOW  1
#define FF_PROFILE_AAC_SSR  2
#define FF_PROFILE_AAC_LTP  3
michael's avatar
michael committed
1878 1879 1880

    /**
     * level
diego's avatar
diego committed
1881 1882
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1883 1884 1885
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1886 1887

    /**
diego's avatar
diego committed
1888
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
michael's avatar
michael committed
1889
     * - encoding: unused
diego's avatar
diego committed
1890
     * - decoding: Set by user.
michael's avatar
michael committed
1891 1892
     */
     int lowres;
1893 1894

    /**
diego's avatar
diego committed
1895 1896
     * Bitstream width / height, may be different from width/height if lowres
     * or other things are used.
1897
     * - encoding: unused
diego's avatar
diego committed
1898
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1899 1900
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1901 1902 1903

    /**
     * frame skip threshold
diego's avatar
diego committed
1904
     * - encoding: Set by user.
michael's avatar
michael committed
1905 1906 1907 1908 1909 1910
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
diego's avatar
diego committed
1911
     * - encoding: Set by user.
michael's avatar
michael committed
1912 1913 1914
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1915 1916 1917

    /**
     * frame skip exponent
diego's avatar
diego committed
1918
     * - encoding: Set by user.
michael's avatar
michael committed
1919 1920 1921 1922 1923
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
diego's avatar
diego committed
1924 1925
     * frame skip comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1926 1927 1928
     * - decoding: unused
     */
    int frame_skip_cmp;
1929 1930

    /**
diego's avatar
diego committed
1931
     * Border processing masking, raises the quantizer for mbs on the borders
1932
     * of the picture.
diego's avatar
diego committed
1933
     * - encoding: Set by user.
1934 1935 1936
     * - decoding: unused
     */
    float border_masking;
1937 1938

    /**
diego's avatar
diego committed
1939 1940
     * minimum MB lagrange multipler
     * - encoding: Set by user.
1941 1942 1943 1944 1945
     * - decoding: unused
     */
    int mb_lmin;

    /**
diego's avatar
diego committed
1946 1947
     * maximum MB lagrange multipler
     * - encoding: Set by user.
1948 1949 1950
     * - decoding: unused
     */
    int mb_lmax;
1951 1952

    /**
1953
     *
diego's avatar
diego committed
1954
     * - encoding: Set by user.
1955 1956 1957
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1958 1959

    /**
1960
     *
michael's avatar
michael committed
1961
     * - encoding: unused
diego's avatar
diego committed
1962
     * - decoding: Set by user.
michael's avatar
michael committed
1963 1964 1965 1966
     */
    enum AVDiscard skip_loop_filter;

    /**
1967
     *
michael's avatar
michael committed
1968
     * - encoding: unused
diego's avatar
diego committed
1969
     * - decoding: Set by user.
michael's avatar
michael committed
1970 1971 1972 1973
     */
    enum AVDiscard skip_idct;

    /**
1974
     *
michael's avatar
michael committed
1975
     * - encoding: unused
diego's avatar
diego committed
1976
     * - decoding: Set by user.
michael's avatar
michael committed
1977 1978
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
1979 1980 1981

    /**
     *
diego's avatar
diego committed
1982
     * - encoding: Set by user.
michael's avatar
michael committed
1983 1984 1985
     * - decoding: unused
     */
    int bidir_refine;
1986 1987 1988

    /**
     *
diego's avatar
diego committed
1989
     * - encoding: Set by user.
1990 1991 1992
     * - decoding: unused
     */
    int brd_scale;
lorenm's avatar
lorenm committed
1993 1994 1995

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
diego's avatar
diego committed
1996
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1997 1998
     * - decoding: unused
     */
lu_zero's avatar
lu_zero committed
1999
    float crf;
lorenm's avatar
lorenm committed
2000 2001 2002

    /**
     * constant quantization parameter rate control method
diego's avatar
diego committed
2003
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2004 2005 2006 2007 2008
     * - decoding: unused
     */
    int cqp;

    /**
diego's avatar
diego committed
2009 2010
     * minimum GOP size
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2011 2012 2013 2014 2015 2016
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
diego's avatar
diego committed
2017
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2018 2019 2020 2021 2022 2023
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
diego's avatar
diego committed
2024
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2025 2026 2027 2028 2029
     * - decoding: unused
     */
    int chromaoffset;

    /**
diego's avatar
diego committed
2030 2031
     * Influences how often B-frames are used.
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2032 2033 2034 2035 2036 2037
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
diego's avatar
diego committed
2038
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2039 2040 2041 2042 2043
     * - decoding: unused
     */
    int trellis;

    /**
diego's avatar
diego committed
2044 2045
     * Reduce fluctuations in qp (before curve compression).
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2046 2047 2048 2049 2050 2051 2052
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
diego's avatar
diego committed
2053
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2054 2055 2056 2057 2058 2059 2060
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
diego's avatar
diego committed
2061
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2062 2063 2064 2065 2066 2067
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
diego's avatar
diego committed
2068
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2069 2070 2071
     * - decoding: unused
     */
    int partitions;
2072 2073 2074 2075 2076
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
lorenm's avatar
lorenm committed
2077 2078

    /**
diego's avatar
diego committed
2079 2080
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2081 2082 2083
     * - decoding: unused
     */
    int directpred;
2084

2085
    /**
2086
     * Audio cutoff bandwidth (0 means "automatic")
diego's avatar
diego committed
2087
     * - encoding: Set by user.
2088 2089 2090
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
2091 2092

    /**
diego's avatar
diego committed
2093 2094
     * Multiplied by qscale for each frame and added to scene_change_score.
     * - encoding: Set by user.
corey's avatar
corey committed
2095 2096 2097
     * - decoding: unused
     */
    int scenechange_factor;
2098 2099 2100

    /**
     *
diego's avatar
diego committed
2101 2102
     * Note: Value depends upon the compare function used for fullpel ME.
     * - encoding: Set by user.
2103 2104 2105
     * - decoding: unused
     */
    int mv0_threshold;
2106 2107

    /**
diego's avatar
diego committed
2108 2109
     * Adjusts sensitivity of b_frame_strategy 1.
     * - encoding: Set by user.
2110 2111 2112
     * - decoding: unused
     */
    int b_sensitivity;
2113 2114

    /**
diego's avatar
diego committed
2115
     * - encoding: Set by user.
2116 2117 2118 2119 2120 2121
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
diego's avatar
diego committed
2122 2123 2124
     * Sets whether to use LPC mode - used by FLAC encoder.
     * - encoding: Set by user.
     * - decoding: unused
2125 2126 2127 2128 2129
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
diego's avatar
diego committed
2130 2131
     * - encoding: Set by user.
     * - decoding: unused
2132 2133 2134 2135
     */
    int lpc_coeff_precision;

    /**
diego's avatar
diego committed
2136 2137
     * - encoding: Set by user.
     * - decoding: unused
2138 2139 2140 2141
     */
    int min_prediction_order;

    /**
diego's avatar
diego committed
2142 2143
     * - encoding: Set by user.
     * - decoding: unused
2144 2145 2146 2147 2148
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
diego's avatar
diego committed
2149 2150
     * - encoding: Set by user.
     * - decoding: unused
2151 2152 2153 2154
     */
    int prediction_order_method;

    /**
diego's avatar
diego committed
2155 2156
     * - encoding: Set by user.
     * - decoding: unused
2157 2158 2159 2160
     */
    int min_partition_order;

    /**
diego's avatar
diego committed
2161 2162
     * - encoding: Set by user.
     * - decoding: unused
2163 2164
     */
    int max_partition_order;
2165 2166 2167

    /**
     * GOP timecode frame start number, in non drop frame format
diego's avatar
diego committed
2168 2169
     * - encoding: Set by user.
     * - decoding: unused
2170 2171
     */
    int64_t timecode_frame_start;
2172 2173 2174 2175 2176 2177 2178

    /**
     * Decoder should decode to this many channels if it can (0 for default)
     * - encoding: unused
     * - decoding: Set by user.
     */
    int request_channels;
2179 2180 2181 2182 2183 2184 2185 2186

    /**
     * Percentage of dynamic range compression to be applied by the decoder.
     * The default value is 1.0, corresponding to full compression.
     * - encoding: unused
     * - decoding: Set by user.
     */
    float drc_scale;
glantau's avatar
glantau committed
2187 2188
} AVCodecContext;

2189 2190 2191
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
2192
typedef struct AVCodec {
benoit's avatar
benoit committed
2193 2194 2195 2196 2197 2198
    /**
     * Name of the codec implementation.
     * The name is globally unique among encoders and among decoders (but an
     * encoder and a decoder can share the same name).
     * This is the primary way to find a codec from the user perspective.
     */
kabi's avatar
kabi committed
2199
    const char *name;
kabi's avatar
kabi committed
2200
    enum CodecType type;
michael's avatar
michael committed
2201
    enum CodecID id;
glantau's avatar
glantau committed
2202 2203
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
2204
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
2205
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
2206
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2207
                  const uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
2208
    int capabilities;
glantau's avatar
glantau committed
2209
    struct AVCodec *next;
michaelni's avatar
michaelni committed
2210
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
2211
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
2212
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
2213 2214
} AVCodec;

kabi's avatar
kabi committed
2215
/**
2216 2217 2218
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
2219
typedef struct AVPicture {
kabi's avatar
kabi committed
2220
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2221
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2222 2223
} AVPicture;

tmmm's avatar
tmmm committed
2224 2225 2226 2227
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
benoit's avatar
 
benoit committed
2228 2229 2230
 *
 * @deprecated Use AVPacket to send palette changes instead.
 * This is totally broken.
tmmm's avatar
tmmm committed
2231
 */
2232
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2233
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2234 2235
typedef struct AVPaletteControl {

diego's avatar
diego committed
2236 2237
    /* Demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0. */
tmmm's avatar
tmmm committed
2238 2239
    int palette_changed;

2240 2241
    /* 4-byte ARGB palette entries, stored in native byte order; note that
     * the individual palette components should be on a 8-bit scale; if
diego's avatar
diego committed
2242 2243
     * the palette data comes from an IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled. */
2244
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2245

2246
} AVPaletteControl attribute_deprecated;
tmmm's avatar
tmmm committed
2247

2248
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2249 2250 2251 2252 2253 2254 2255 2256
    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;
2257 2258 2259 2260 2261 2262 2263 2264
} 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
2265 2266 2267
} AVSubtitle;


glantau's avatar
glantau committed
2268 2269 2270
/* resample.c */

struct ReSampleContext;
2271
struct AVResampleContext;
glantau's avatar
glantau committed
2272 2273 2274

typedef struct ReSampleContext ReSampleContext;

2275
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2276 2277 2278 2279
                                     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
2280
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2281
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
2282
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2283
void av_resample_close(struct AVResampleContext *c);
2284

2285
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
glantau's avatar
glantau committed
2286 2287
/* YUV420 format is assumed ! */

benoit's avatar
 
benoit committed
2288 2289 2290
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2291
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
glantau's avatar
glantau committed
2292

benoit's avatar
 
benoit committed
2293 2294 2295
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2296
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
glantau's avatar
glantau committed
2297
                                      int input_width, int input_height);
2298

benoit's avatar
 
benoit committed
2299 2300 2301
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2302
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2303 2304
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2305 2306 2307 2308
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

benoit's avatar
 
benoit committed
2309 2310 2311
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2312
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2313
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2314

benoit's avatar
 
benoit committed
2315 2316 2317
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2318
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2319 2320

#endif
glantau's avatar
glantau committed
2321

michael's avatar
michael committed
2322 2323 2324
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
diego's avatar
diego committed
2325 2326 2327 2328 2329
 * @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 zero if successful, a negative value if not
michael's avatar
michael committed
2330 2331 2332
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2333 2334 2335
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
diego's avatar
diego committed
2336
 * @param picture the AVPicture to be freed
2337
 */
michael's avatar
michael committed
2338 2339
void avpicture_free(AVPicture *picture);

2340
/**
diego's avatar
diego committed
2341
 * Fill in the AVPicture fields.
2342 2343 2344 2345 2346 2347 2348
 * The fields of the given AVPicture are filled in by using the 'ptr' address
 * which points to the image data buffer. Depending on the specified picture
 * format, one or multiple image data pointers and line sizes will be set.
 * If a planar format is specified, several pointers will be set pointing to
 * the different picture planes and the line sizes of the different planes
 * will be stored in the lines_sizes array.
 *
diego's avatar
diego committed
2349
 * @param picture AVPicture whose fields are to be filled in
2350
 * @param ptr Buffer which will contain or contains the actual image data
diego's avatar
diego committed
2351 2352 2353 2354
 * @param pix_fmt The format in which the picture data is stored.
 * @param width the width of the image in pixels
 * @param height the height of the image in pixels
 * @return size of the image data in bytes
2355
 */
kabi's avatar
kabi committed
2356
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2357
                   int pix_fmt, int width, int height);
2358
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2359
                     unsigned char *dest, int dest_size);
2360 2361 2362 2363 2364

/**
 * Calculate the size in bytes that a picture of the given width and height
 * would occupy if stored in the given picture format.
 *
diego's avatar
diego committed
2365 2366 2367
 * @param pix_fmt the given picture format
 * @param width the width of the image
 * @param height the height of the image
2368 2369
 * @return Image data size in bytes
 */
2370
int avpicture_get_size(int pix_fmt, int width, int height);
2371 2372
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);
2373
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2374
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2375
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2376

2377 2378 2379 2380 2381 2382
#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) */
2383

2384
/**
2385 2386 2387 2388 2389 2390 2391 2392
 * Computes what kind of losses will occur when converting from one specific
 * pixel format to another.
 * When converting from one pixel format to another, information loss may occur.
 * For example, when converting from RGB24 to GRAY, the color information will
 * be lost. Similarly, other losses occur when converting from some formats to
 * other formats. These losses can involve loss of chroma, but also loss of
 * resolution, loss of color depth, loss due to the color space conversion, loss
 * of the alpha bits or loss due to color quantization.
diego's avatar
diego committed
2393 2394
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 * which will occur when converting from one pixel format to another.
2395
 *
diego's avatar
diego committed
2396 2397
 * @param[in] dst_pix_fmt destination pixel format
 * @param[in] src_pix_fmt source pixel format
2398 2399
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 * @return Combination of flags informing you what kind of losses will occur.
2400
 */
2401 2402
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2403 2404

/**
2405 2406 2407 2408 2409
 * Finds the best pixel format to convert to given a certain source pixel
 * format.  When converting from one pixel format to another, information loss
 * may occur.  For example, when converting from RGB24 to GRAY, the color
 * information will be lost. Similarly, other losses occur when converting from
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
diego's avatar
diego committed
2410 2411
 * the given pixel formats should be used to suffer the least amount of loss.
 * The pixel formats from which it chooses one, are determined by the
2412 2413 2414 2415 2416 2417 2418 2419
 * \p pix_fmt_mask parameter.
 *
 * @code
 * src_pix_fmt = PIX_FMT_YUV420P;
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
 * @endcode
 *
diego's avatar
diego committed
2420 2421
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 * @param[in] src_pix_fmt source pixel format
2422 2423 2424
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
 * @return The best pixel format to convert to or -1 if none was found.
2425
 */
2426 2427 2428
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

benoit's avatar
 
benoit committed
2429 2430 2431 2432 2433

/**
 * Print in buf the string corresponding to the pixel format with
 * number pix_fmt, or an header if pix_fmt is negative.
 *
2434 2435 2436
 * @param[in] buf the buffer where to write the string
 * @param[in] buf_size the size of buf
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
benoit's avatar
 
benoit committed
2437 2438 2439 2440 2441
 * a negative value to print the corresponding header.
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
 */
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);

bellard's avatar
bellard committed
2442 2443
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2444 2445 2446 2447 2448

/**
 * Tell if an image really has transparent alpha values.
 * @return ored mask of FF_ALPHA_xxx constants
 */
2449
int img_get_alpha_info(const AVPicture *src,
2450
                       int pix_fmt, int width, int height);
bellard's avatar
bellard committed
2451

2452
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2453 2454 2455 2456
/**
 * convert among pixel formats
 * @deprecated Use the software scaler (swscale) instead.
 */
2457
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2458
                const AVPicture *src, int pix_fmt,
2459
                int width, int height);
2460
#endif
2461 2462

/* deinterlace a picture */
2463
/* deinterlace - if not supported return -1 */
2464
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2465 2466 2467 2468
                          int pix_fmt, int width, int height);

/* external high level API */

michael's avatar
michael committed
2469
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
glantau's avatar
glantau committed
2470
extern AVCodec *first_avcodec;
michael's avatar
michael committed
2471 2472
#endif
AVCodec *av_codec_next(AVCodec *c);
glantau's avatar
glantau committed
2473

nickols_k's avatar
nickols_k committed
2474
/* returns LIBAVCODEC_VERSION_INT constant */
2475
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2476
/* returns LIBAVCODEC_BUILD constant */
2477
unsigned avcodec_build(void);
takis's avatar
takis committed
2478 2479 2480 2481 2482 2483 2484

/**
 * Initializes libavcodec.
 *
 * @warning This function \e must be called before any other libavcodec
 * function.
 */
glantau's avatar
glantau committed
2485 2486 2487
void avcodec_init(void);

void register_avcodec(AVCodec *format);
takis's avatar
takis committed
2488 2489

/**
2490
 * Finds a registered encoder with a matching codec ID.
takis's avatar
takis committed
2491
 *
diego's avatar
diego committed
2492
 * @param id CodecID of the requested encoder
takis's avatar
takis committed
2493 2494
 * @return An encoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2495
AVCodec *avcodec_find_encoder(enum CodecID id);
takis's avatar
takis committed
2496 2497

/**
2498
 * Finds a registered encoder with the specified name.
takis's avatar
takis committed
2499
 *
diego's avatar
diego committed
2500
 * @param name name of the requested encoder
takis's avatar
takis committed
2501 2502
 * @return An encoder if one was found, NULL otherwise.
 */
2503
AVCodec *avcodec_find_encoder_by_name(const char *name);
takis's avatar
takis committed
2504 2505

/**
2506
 * Finds a registered decoder with a matching codec ID.
takis's avatar
takis committed
2507
 *
diego's avatar
diego committed
2508
 * @param id CodecID of the requested decoder
takis's avatar
takis committed
2509 2510
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2511
AVCodec *avcodec_find_decoder(enum CodecID id);
takis's avatar
takis committed
2512 2513

/**
2514
 * Finds a registered decoder with the specified name.
takis's avatar
takis committed
2515
 *
diego's avatar
diego committed
2516
 * @param name name of the requested decoder
takis's avatar
takis committed
2517 2518
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2519 2520 2521
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

takis's avatar
takis committed
2522 2523 2524 2525 2526
/**
 * Sets the fields of the given AVCodecContext to default values.
 *
 * @param s The AVCodecContext of which the fields should be set to default values.
 */
michaelni's avatar
michaelni committed
2527
void avcodec_get_context_defaults(AVCodecContext *s);
takis's avatar
takis committed
2528

2529 2530 2531 2532
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 *  we WILL change its arguments and name a few times! */
void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);

takis's avatar
takis committed
2533 2534 2535 2536 2537 2538 2539
/**
 * Allocates an AVCodecContext and sets its fields to default values.  The
 * resulting struct can be deallocated by simply calling av_free().
 *
 * @return An AVCodecContext filled with default values or NULL on failure.
 * @see avcodec_get_context_defaults
 */
mellum's avatar
mellum committed
2540
AVCodecContext *avcodec_alloc_context(void);
takis's avatar
takis committed
2541

2542 2543 2544 2545
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 *  we WILL change its arguments and name a few times! */
AVCodecContext *avcodec_alloc_context2(enum CodecType);

takis's avatar
takis committed
2546 2547 2548 2549 2550
/**
 * Sets the fields of the given AVFrame to default values.
 *
 * @param pic The AVFrame of which the fields should be set to default values.
 */
mellum's avatar
mellum committed
2551
void avcodec_get_frame_defaults(AVFrame *pic);
takis's avatar
takis committed
2552 2553 2554 2555 2556 2557 2558 2559

/**
 * Allocates an AVFrame and sets its fields to default values.  The resulting
 * struct can be deallocated by simply calling av_free().
 *
 * @return An AVFrame filled with default values or NULL on failure.
 * @see avcodec_get_frame_defaults
 */
michaelni's avatar
michaelni committed
2560
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
2561

michaelni's avatar
michaelni committed
2562 2563
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2564 2565
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
takis's avatar
takis committed
2566 2567 2568 2569 2570 2571 2572 2573 2574

/**
 * Checks if the given dimension of a picture is valid, meaning that all
 * bytes of the picture can be addressed with a signed int.
 *
 * @param[in] w Width of the picture.
 * @param[in] h Height of the picture.
 * @return Zero if valid, a negative value if invalid.
 */
2575
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
michael's avatar
michael committed
2576
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
michaelni's avatar
michaelni committed
2577

michael's avatar
1l  
michael committed
2578 2579 2580
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
2581
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2582 2583
//FIXME func typedef

michaelni's avatar
michaelni committed
2584
/**
takis's avatar
takis committed
2585 2586 2587 2588 2589 2590 2591
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
 * function the context has to be allocated.
 *
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
 * retrieving a codec.
 *
diego's avatar
diego committed
2592
 * @warning This function is not thread safe!
takis's avatar
takis committed
2593 2594
 *
 * @code
2595
 * avcodec_register_all();
takis's avatar
takis committed
2596 2597 2598 2599 2600 2601 2602 2603 2604 2605
 * codec = avcodec_find_decoder(CODEC_ID_H264);
 * if (!codec)
 *     exit(1);
 *
 * context = avcodec_alloc_context();
 *
 * if (avcodec_open(context, codec) < 0)
 *     exit(1);
 * @endcode
 *
diego's avatar
diego committed
2606
 * @param avctx The context which will be set up to use the given codec.
takis's avatar
takis committed
2607
 * @param codec The codec to use within the context.
diego's avatar
diego committed
2608
 * @return zero on success, a negative value on error
takis's avatar
takis committed
2609
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
michaelni's avatar
michaelni committed
2610
 */
glantau's avatar
glantau committed
2611
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2612

takis's avatar
takis committed
2613 2614 2615
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
michael's avatar
michael committed
2616 2617
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
2618
                         const uint8_t *buf, int buf_size);
takis's avatar
takis committed
2619

2620
/**
takis's avatar
takis committed
2621
 * Decodes an audio frame from \p buf into \p samples.
diego's avatar
diego committed
2622
 * The avcodec_decode_audio2() function decodes an audio frame from the input
takis's avatar
takis committed
2623
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2624
 * audio codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637
 * resulting decoded frame is stored in output buffer \p samples.  If no frame
 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
 * decompressed frame size in \e bytes.
 *
 * @warning You \e must set \p frame_size_ptr to the allocated size of the
 * output buffer before calling avcodec_decode_audio2().
 *
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
 * the actual read bytes because some optimized bitstream readers read 32 or 64
 * bits at once and could read over the end.
 *
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
 * no overreading happens for damaged MPEG streams.
2638
 *
takis's avatar
takis committed
2639
 * @note You might have to align the input buffer \p buf and output buffer \p
diego's avatar
diego committed
2640
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
takis's avatar
takis committed
2641 2642 2643 2644 2645 2646 2647
 * necessary at all, on others it won't work at all if not aligned and on others
 * it will work but it will have an impact on performance. In practice, the
 * bitstream should have 4 byte alignment at minimum and all sample data should
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
 * the linesize is not a multiple of 16 then there's no sense in aligning the
 * start of the buffer to 16.
 *
diego's avatar
diego committed
2648 2649 2650 2651 2652
 * @param avctx the codec context
 * @param[out] samples the output buffer
 * @param[in,out] frame_size_ptr the output buffer size in bytes
 * @param[in] buf the input buffer
 * @param[in] buf_size the input buffer size in bytes
takis's avatar
takis committed
2653 2654
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
2655
 */
michael's avatar
michael committed
2656
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
glantau's avatar
glantau committed
2657
                         int *frame_size_ptr,
2658
                         const uint8_t *buf, int buf_size);
takis's avatar
takis committed
2659 2660 2661

/**
 * Decodes a video frame from \p buf into \p picture.
diego's avatar
diego committed
2662
 * The avcodec_decode_video() function decodes a video frame from the input
takis's avatar
takis committed
2663
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2664
 * video codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682
 * resulting decoded frame is stored in \p picture.
 *
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
 * the actual read bytes because some optimized bitstream readers read 32 or 64
 * bits at once and could read over the end.
 *
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
 * no overreading happens for damaged MPEG streams.
 *
 * @note You might have to align the input buffer \p buf and output buffer \p
 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
 * necessary at all, on others it won't work at all if not aligned and on others
 * it will work but it will have an impact on performance. In practice, the
 * bitstream should have 4 byte alignment at minimum and all sample data should
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
 * the linesize is not a multiple of 16 then there's no sense in aligning the
 * start of the buffer to 16.
 *
diego's avatar
diego committed
2683
 * @param avctx the codec context
takis's avatar
takis committed
2684
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
diego's avatar
diego committed
2685 2686 2687
 * @param[in] buf the input buffer
 * @param[in] buf_size the size of the input buffer in bytes
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
takis's avatar
takis committed
2688 2689 2690
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
 */
2691
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
glantau's avatar
glantau committed
2692
                         int *got_picture_ptr,
2693
                         const uint8_t *buf, int buf_size);
2694

diego's avatar
diego committed
2695 2696 2697
/* Decode a subtitle message. Return -1 if error, otherwise return the
 * number of bytes used. If no subtitle could be decompressed,
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
bellard's avatar
bellard committed
2698 2699 2700
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2701
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2702
                        int *data_size_ptr,
kabi's avatar
kabi committed
2703
                        uint8_t *buf, int buf_size);
takis's avatar
takis committed
2704 2705 2706

/**
 * Encodes an audio frame from \p samples into \p buf.
diego's avatar
diego committed
2707 2708
 * The avcodec_encode_audio() function encodes an audio frame from the input
 * buffer \p samples. To encode it, it makes use of the audio codec which was
takis's avatar
takis committed
2709 2710 2711 2712 2713
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
 * stored in output buffer \p buf.
 *
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
 *
diego's avatar
diego committed
2714 2715 2716 2717
 * @param avctx the codec context
 * @param[out] buf the output buffer
 * @param[in] buf_size the output buffer size
 * @param[in] samples the input buffer containing the samples
2718 2719
 * The number of samples read from this buffer is frame_size*channels,
 * both of which are defined in \p avctx.
diego's avatar
diego committed
2720
 * @return On error a negative value is returned, on success zero or the number
2721
 * of bytes used to encode the data read from the input buffer.
takis's avatar
takis committed
2722
 */
2723
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
glantau's avatar
glantau committed
2724
                         const short *samples);
takis's avatar
takis committed
2725 2726 2727

/**
 * Encodes a video frame from \p pict into \p buf.
diego's avatar
diego committed
2728 2729
 * The avcodec_encode_video() function encodes a video frame from the input
 * \p pict. To encode it, it makes use of the video codec which was coupled with
takis's avatar
takis committed
2730 2731 2732 2733
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
 * frame are stored in the output buffer \p buf. The input picture should be
 * stored using a specific format, namely \c avctx.pix_fmt.
 *
diego's avatar
diego committed
2734 2735 2736 2737
 * @param avctx the codec context
 * @param[out] buf the output buffer for the bitstream of encoded frame
 * @param[in] buf_size the size of the output buffer in bytes
 * @param[in] pict the input picture to encode
takis's avatar
takis committed
2738 2739 2740
 * @return On error a negative value is returned, on success zero or the number
 * of bytes used from the input buffer.
 */
2741
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
michaelni's avatar
michaelni committed
2742
                         const AVFrame *pict);
2743
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
bellard's avatar
bellard committed
2744
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2745 2746 2747 2748

int avcodec_close(AVCodecContext *avctx);

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

2750 2751 2752
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
michaelni's avatar
michaelni committed
2753 2754
void avcodec_flush_buffers(AVCodecContext *avctx);

2755 2756
void avcodec_default_free_buffers(AVCodecContext *s);

takis's avatar
takis committed
2757
/* misc useful functions */
michaelni's avatar
michaelni committed
2758 2759

/**
2760 2761
 * Returns a single letter to describe the given picture type \p pict_type.
 *
diego's avatar
diego committed
2762
 * @param[in] pict_type the picture type
2763
 * @return A single character representing the picture type.
michaelni's avatar
michaelni committed
2764 2765 2766
 */
char av_get_pict_type_char(int pict_type);

2767
/**
2768 2769
 * Returns codec bits per sample.
 *
diego's avatar
diego committed
2770
 * @param[in] codec_id the codec
2771
 * @return Number of bits per sample or zero if unknown for the given codec.
2772 2773
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2774

conrad's avatar
conrad committed
2775 2776 2777 2778 2779 2780 2781 2782
/**
 * Returns sample format bits per sample.
 *
 * @param[in] sample_fmt the sample format
 * @return Number of bits per sample or zero if unknown for the given sample format.
 */
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);

bellard's avatar
bellard committed
2783 2784 2785 2786 2787
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2788
    int64_t cur_offset; /* current offset
bellard's avatar
bellard committed
2789 2790 2791
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
diego's avatar
diego committed
2792 2793
    int pict_type; /* XXX: Put it back in AVCodecContext. */
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
bellard's avatar
bellard committed
2794 2795 2796 2797 2798 2799
    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
2800
    int fetch_timestamp;
bellard's avatar
bellard committed
2801 2802 2803 2804 2805 2806

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

michael's avatar
michael committed
2808 2809
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
benoit's avatar
 
benoit committed
2810 2811 2812

    int64_t offset;      ///< byte offset from starting packet start
    int64_t last_offset;
bellard's avatar
bellard committed
2813 2814 2815
} AVCodecParserContext;

typedef struct AVCodecParser {
michael's avatar
michael committed
2816
    int codec_ids[5]; /* several codec IDs are permitted */
bellard's avatar
bellard committed
2817 2818
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2819
    int (*parser_parse)(AVCodecParserContext *s,
bellard's avatar
bellard committed
2820
                        AVCodecContext *avctx,
2821
                        const uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2822 2823
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2824
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2825 2826 2827
    struct AVCodecParser *next;
} AVCodecParser;

michael's avatar
michael committed
2828
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
bellard's avatar
bellard committed
2829
extern AVCodecParser *av_first_parser;
michael's avatar
michael committed
2830 2831
#endif
AVCodecParser *av_parser_next(AVCodecParser *c);
bellard's avatar
bellard committed
2832 2833 2834

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2835
int av_parser_parse(AVCodecParserContext *s,
bellard's avatar
bellard committed
2836
                    AVCodecContext *avctx,
2837
                    uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2838 2839
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2840 2841
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2842
                     uint8_t **poutbuf, int *poutbuf_size,
2843
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2844 2845
void av_parser_close(AVCodecParserContext *s);

2846 2847

typedef struct AVBitStreamFilterContext {
michael's avatar
michael committed
2848
    void *priv_data;
2849 2850 2851 2852 2853 2854 2855 2856
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
michael's avatar
michael committed
2857
    int priv_data_size;
2858 2859 2860 2861
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
2862
    void (*close)(AVBitStreamFilterContext *bsfc);
2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
    struct AVBitStreamFilter *next;
} AVBitStreamFilter;

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

michael's avatar
michael committed
2874
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2875

bellard's avatar
bellard committed
2876
/* memory */
2877 2878

/**
2879 2880 2881 2882
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
2883
 */
kabi's avatar
kabi committed
2884
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2885

2886
/* for static data only */
2887 2888

/**
diego's avatar
diego committed
2889
 * Frees all static arrays and resets their pointers to 0.
2890
 * Call this function to release all statically allocated tables.
benoit's avatar
 
benoit committed
2891
 *
diego's avatar
diego committed
2892
 * @deprecated. Code which uses av_free_static is broken/misdesigned
benoit's avatar
 
benoit committed
2893 2894
 * and should correctly use static arrays
 *
2895
 */
michael's avatar
michael committed
2896
attribute_deprecated void av_free_static(void);
2897 2898

/**
2899 2900 2901 2902 2903
 * Allocation of static arrays.
 *
 * @warning Do not use for normal allocation.
 *
 * @param[in] size The amount of memory you need in bytes.
diego's avatar
diego committed
2904
 * @return block of memory of the requested size
diego's avatar
diego committed
2905
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
benoit's avatar
 
benoit committed
2906
 * and should correctly use static arrays
2907
 */
michael's avatar
michael committed
2908
attribute_deprecated void *av_mallocz_static(unsigned int size);
2909

2910 2911 2912
/**
 * Copy image 'src' to 'dst'.
 */
2913
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2914 2915
              int pix_fmt, int width, int height);

2916
/**
diego's avatar
diego committed
2917
 * Crop image top and left side.
2918
 */
2919
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2920 2921
             int pix_fmt, int top_band, int left_band);

2922
/**
diego's avatar
diego committed
2923
 * Pad image.
2924
 */
2925
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2926 2927
            int padtop, int padbottom, int padleft, int padright, int *color);

2928
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2929 2930 2931
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2932 2933 2934
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

benoit's avatar
 
benoit committed
2935 2936 2937
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2938 2939 2940
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

benoit's avatar
 
benoit committed
2941 2942 2943
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2944 2945 2946 2947
attribute_deprecated 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);
#endif

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

2950 2951 2952
/**
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
 *
diego's avatar
diego committed
2953
 * @return 0 in case of a successful parsing, a negative value otherwise
2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965
 * @param[in] str the string to parse: it has to be a string in the format
 * <width>x<height> or a valid video frame size abbreviation.
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
 * frame width value
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
 * frame height value
 */
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);

/**
 * Parses \p str and put in \p frame_rate the detected values.
 *
diego's avatar
diego committed
2966
 * @return 0 in case of a successful parsing, a negative value otherwise
2967 2968 2969 2970 2971 2972 2973
 * @param[in] str the string to parse: it has to be a string in the format
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
 * frame rate
 */
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);

2974 2975
/* error handling */
#if EINVAL > 0
diego's avatar
diego committed
2976 2977
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2978
#else
diego's avatar
diego committed
2979
/* Some platforms have E* and errno already negated. */
2980 2981 2982 2983
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
diego's avatar
diego committed
2984 2985
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2986 2987 2988
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
diego's avatar
diego committed
2989
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
benoit's avatar
 
benoit committed
2990
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
ramiro's avatar
ramiro committed
2991
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2992

2993
#endif /* FFMPEG_AVCODEC_H */