avcodec.h 91.9 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 AVCODEC_AVCODEC_H
#define AVCODEC_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"
glantau's avatar
glantau committed
31

32
#define LIBAVCODEC_VERSION_MAJOR 52
bcoudurier's avatar
bcoudurier committed
33
#define LIBAVCODEC_VERSION_MINOR  1
ramiro's avatar
ramiro committed
34
#define LIBAVCODEC_VERSION_MICRO  0
mru's avatar
mru committed
35

36 37 38 39 40 41
#define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
                                               LIBAVCODEC_VERSION_MINOR, \
                                               LIBAVCODEC_VERSION_MICRO)
#define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
                                           LIBAVCODEC_VERSION_MINOR,    \
                                           LIBAVCODEC_VERSION_MICRO)
42
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
43

44
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
al3x's avatar
al3x committed
45

46
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
47 48
#define AV_TIME_BASE            1000000
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
49

michael's avatar
michael committed
50
/**
benoit's avatar
benoit committed
51 52 53 54 55 56
 * 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
57
 *
diego's avatar
diego committed
58 59 60
 * 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
61
 */
glantau's avatar
glantau committed
62
enum CodecID {
63
    CODEC_ID_NONE,
64 65

    /* video codecs */
glantau's avatar
glantau committed
66
    CODEC_ID_MPEG1VIDEO,
67
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
iive's avatar
iive committed
68
    CODEC_ID_MPEG2VIDEO_XVMC,
69
    CODEC_ID_H261,
glantau's avatar
glantau committed
70 71
    CODEC_ID_H263,
    CODEC_ID_RV10,
michael's avatar
michael committed
72
    CODEC_ID_RV20,
glantau's avatar
glantau committed
73
    CODEC_ID_MJPEG,
al3x's avatar
al3x committed
74
    CODEC_ID_MJPEGB,
75
    CODEC_ID_LJPEG,
alex's avatar
alex committed
76
    CODEC_ID_SP5X,
77
    CODEC_ID_JPEGLS,
glantau's avatar
glantau committed
78
    CODEC_ID_MPEG4,
glantau's avatar
glantau committed
79
    CODEC_ID_RAWVIDEO,
80 81 82
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
michaelni's avatar
michaelni committed
83
    CODEC_ID_WMV1,
michaelni's avatar
 
michaelni committed
84
    CODEC_ID_WMV2,
glantau's avatar
glantau committed
85 86
    CODEC_ID_H263P,
    CODEC_ID_H263I,
87
    CODEC_ID_FLV1,
nickols_k's avatar
nickols_k committed
88
    CODEC_ID_SVQ1,
michaelni's avatar
michaelni committed
89
    CODEC_ID_SVQ3,
bellard's avatar
bellard committed
90
    CODEC_ID_DVVIDEO,
michaelni's avatar
michaelni committed
91
    CODEC_ID_HUFFYUV,
92
    CODEC_ID_CYUV,
michaelni's avatar
michaelni committed
93
    CODEC_ID_H264,
tmmm's avatar
tmmm committed
94
    CODEC_ID_INDEO3,
tmmm's avatar
tmmm committed
95
    CODEC_ID_VP3,
96
    CODEC_ID_THEORA,
michaelni's avatar
michaelni committed
97
    CODEC_ID_ASV1,
michaelni's avatar
michaelni committed
98
    CODEC_ID_ASV2,
99
    CODEC_ID_FFV1,
tmmm's avatar
tmmm committed
100
    CODEC_ID_4XM,
michaelni's avatar
michaelni committed
101
    CODEC_ID_VCR1,
al3x's avatar
al3x committed
102
    CODEC_ID_CLJR,
103
    CODEC_ID_MDEC,
104 105
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
106 107
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
108 109 110 111 112
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
tmmm's avatar
tmmm committed
113
    CODEC_ID_IDCIN,
rtognimp's avatar
rtognimp committed
114
    CODEC_ID_8BPS,
115
    CODEC_ID_SMC,
melanson's avatar
melanson committed
116
    CODEC_ID_FLIC,
117
    CODEC_ID_TRUEMOTION1,
118
    CODEC_ID_VMDVIDEO,
rtognimp's avatar
rtognimp committed
119 120
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
121
    CODEC_ID_QTRLE,
michael's avatar
michael committed
122
    CODEC_ID_SNOW,
123
    CODEC_ID_TSCC,
124
    CODEC_ID_ULTI,
125
    CODEC_ID_QDRAW,
126
    CODEC_ID_VIXL,
127
    CODEC_ID_QPEG,
128 129 130 131 132 133 134
    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
135
    CODEC_ID_FFVHUFF,
michael's avatar
michael committed
136 137
    CODEC_ID_RV30,
    CODEC_ID_RV40,
138
    CODEC_ID_VC1,
139
    CODEC_ID_WMV3,
140
    CODEC_ID_LOCO,
141
    CODEC_ID_WNV1,
142
    CODEC_ID_AASC,
143
    CODEC_ID_INDEO2,
144
    CODEC_ID_FRAPS,
145
    CODEC_ID_TRUEMOTION2,
mru's avatar
mru committed
146
    CODEC_ID_BMP,
147
    CODEC_ID_CSCD,
148
    CODEC_ID_MMVIDEO,
149
    CODEC_ID_ZMBV,
150
    CODEC_ID_AVS,
kostya's avatar
kostya committed
151
    CODEC_ID_SMACKVIDEO,
152
    CODEC_ID_NUV,
153
    CODEC_ID_KMVC,
154
    CODEC_ID_FLASHSV,
155
    CODEC_ID_CAVS,
156
    CODEC_ID_JPEG2000,
kostya's avatar
kostya committed
157
    CODEC_ID_VMNC,
aurel's avatar
aurel committed
158 159 160
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
kostya's avatar
kostya committed
161
    CODEC_ID_TARGA,
162
    CODEC_ID_DSICINVIDEO,
163
    CODEC_ID_TIERTEXSEQVIDEO,
kostya's avatar
kostya committed
164
    CODEC_ID_TIFF,
165
    CODEC_ID_GIF,
166
    CODEC_ID_FFH264,
kostya's avatar
kostya committed
167
    CODEC_ID_DXA,
bcoudurier's avatar
bcoudurier committed
168
    CODEC_ID_DNXHD,
169
    CODEC_ID_THP,
170
    CODEC_ID_SGI,
171
    CODEC_ID_C93,
172
    CODEC_ID_BETHSOFTVID,
ivo's avatar
ivo committed
173
    CODEC_ID_PTX,
ivo's avatar
ivo committed
174
    CODEC_ID_TXD,
175
    CODEC_ID_VP6A,
vitor's avatar
vitor committed
176
    CODEC_ID_AMV,
177
    CODEC_ID_VB,
ivo's avatar
ivo committed
178
    CODEC_ID_PCX,
ivo's avatar
ivo committed
179
    CODEC_ID_SUNRAST,
180 181
    CODEC_ID_INDEO4,
    CODEC_ID_INDEO5,
ramiro's avatar
ramiro committed
182
    CODEC_ID_MIMIC,
faust3's avatar
faust3 committed
183
    CODEC_ID_RL2,
vitor's avatar
vitor committed
184 185
    CODEC_ID_8SVX_EXP,
    CODEC_ID_8SVX_FIB,
superdump's avatar
superdump committed
186
    CODEC_ID_ESCAPE124,
michael's avatar
michael committed
187
    CODEC_ID_DIRAC,
vitor's avatar
vitor committed
188
    CODEC_ID_BFI,
pross's avatar
pross committed
189
    CODEC_ID_CMV,
ramiro's avatar
ramiro committed
190
    CODEC_ID_MOTIONPIXELS,
pross's avatar
pross committed
191
    CODEC_ID_TGV,
glantau's avatar
glantau committed
192

diego's avatar
diego committed
193
    /* various PCM "codecs" */
194
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
195 196 197 198 199 200 201
    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,
202 203 204 205 206 207 208 209 210
    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,
211
    CODEC_ID_PCM_ZORK,
212
    CODEC_ID_PCM_S16LE_PLANAR,
213
    CODEC_ID_PCM_DVD,
214
    CODEC_ID_PCM_F32BE,
215 216 217
    CODEC_ID_PCM_F32LE,
    CODEC_ID_PCM_F64BE,
    CODEC_ID_PCM_F64LE,
218

diego's avatar
diego committed
219
    /* various ADPCM codecs */
220
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
221
    CODEC_ID_ADPCM_IMA_WAV,
222 223
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
224
    CODEC_ID_ADPCM_IMA_WS,
225
    CODEC_ID_ADPCM_IMA_SMJPEG,
226
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
227
    CODEC_ID_ADPCM_4XM,
228 229
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
230
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
231
    CODEC_ID_ADPCM_G726,
232
    CODEC_ID_ADPCM_CT,
233
    CODEC_ID_ADPCM_SWF,
234
    CODEC_ID_ADPCM_YAMAHA,
235 236 237
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
238
    CODEC_ID_ADPCM_THP,
vitor's avatar
vitor committed
239
    CODEC_ID_ADPCM_IMA_AMV,
aurel's avatar
aurel committed
240 241 242
    CODEC_ID_ADPCM_EA_R1,
    CODEC_ID_ADPCM_EA_R3,
    CODEC_ID_ADPCM_EA_R2,
aurel's avatar
aurel committed
243
    CODEC_ID_ADPCM_IMA_EA_SEAD,
aurel's avatar
aurel committed
244
    CODEC_ID_ADPCM_IMA_EA_EACS,
245
    CODEC_ID_ADPCM_EA_XAS,
benoit's avatar
benoit committed
246
    CODEC_ID_ADPCM_EA_MAXIS_XA,
247

248 249
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
250 251
    CODEC_ID_AMR_WB,

252
    /* RealAudio codecs*/
253
    CODEC_ID_RA_144= 0x13000,
254
    CODEC_ID_RA_288,
255 256

    /* various DPCM codecs */
257
    CODEC_ID_ROQ_DPCM= 0x14000,
258
    CODEC_ID_INTERPLAY_DPCM,
259
    CODEC_ID_XAN_DPCM,
260
    CODEC_ID_SOL_DPCM,
261

262
    /* audio codecs */
263
    CODEC_ID_MP2= 0x15000,
264
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
265 266 267 268 269 270 271 272 273 274 275 276
    CODEC_ID_AAC,
    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
277
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
278
    CODEC_ID_MP3ADU,
279
    CODEC_ID_MP3ON4,
280
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
281
    CODEC_ID_ALAC,
282
    CODEC_ID_WESTWOOD_SND1,
283
    CODEC_ID_GSM, ///< as in Berlin toast format
rtognimp's avatar
rtognimp committed
284
    CODEC_ID_QDM2,
285
    CODEC_ID_COOK,
286
    CODEC_ID_TRUESPEECH,
287
    CODEC_ID_TTA,
kostya's avatar
kostya committed
288
    CODEC_ID_SMACKAUDIO,
banan's avatar
banan committed
289
    CODEC_ID_QCELP,
kostya's avatar
kostya committed
290
    CODEC_ID_WAVPACK,
291
    CODEC_ID_DSICINAUDIO,
kostya's avatar
kostya committed
292
    CODEC_ID_IMC,
kostya's avatar
kostya committed
293
    CODEC_ID_MUSEPACK7,
294
    CODEC_ID_MLP,
diego's avatar
diego committed
295
    CODEC_ID_GSM_MS, /* as found in WAV */
banan's avatar
banan committed
296
    CODEC_ID_ATRAC3,
michael's avatar
michael committed
297
    CODEC_ID_VOXWARE,
kostya's avatar
kostya committed
298
    CODEC_ID_APE,
banan's avatar
banan committed
299
    CODEC_ID_NELLYMOSER,
kostya's avatar
kostya committed
300
    CODEC_ID_MUSEPACK8,
reimar's avatar
reimar committed
301
    CODEC_ID_SPEEX,
302 303
    CODEC_ID_WMAVOICE,
    CODEC_ID_WMAPRO,
304
    CODEC_ID_WMALOSSLESS,
banan's avatar
banan committed
305
    CODEC_ID_ATRAC3P,
jbr's avatar
jbr committed
306
    CODEC_ID_EAC3,
307
    CODEC_ID_SIPR,
308

bellard's avatar
bellard committed
309
    /* subtitle codecs */
310 311
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
312
    CODEC_ID_TEXT,  ///< raw UTF-8 text
313
    CODEC_ID_XSUB,
314
    CODEC_ID_SSA,
315
    CODEC_ID_MOV_TEXT,
316

diego's avatar
diego committed
317
    /* other specific kind of codecs (generally used for attachments) */
318 319
    CODEC_ID_TTF= 0x18000,

michael's avatar
michael committed
320 321
    CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it

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

glantau's avatar
glantau committed
326
enum CodecType {
327
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
328 329
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
330
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
331
    CODEC_TYPE_SUBTITLE,
332
    CODEC_TYPE_ATTACHMENT,
333
    CODEC_TYPE_NB
glantau's avatar
glantau committed
334 335
};

336 337 338
/**
 * all in native-endian format
 */
glantau's avatar
glantau committed
339
enum SampleFormat {
mru's avatar
mru committed
340
    SAMPLE_FMT_NONE = -1,
341 342
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
343
    SAMPLE_FMT_S32,             ///< signed 32 bits
344
    SAMPLE_FMT_FLT,             ///< float
pross's avatar
pross committed
345
    SAMPLE_FMT_DBL,             ///< double
346
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
glantau's avatar
glantau committed
347 348
};

glantau's avatar
glantau committed
349
/* in bytes */
350
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
351

352
/**
353
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
diego's avatar
diego committed
354 355 356 357
 * 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.
358 359 360
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

361
/**
diego's avatar
diego committed
362 363
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
364 365 366
 */
#define FF_MIN_BUFFER_SIZE 16384

367
/**
368
 * motion estimation type.
369
 */
370
enum Motion_Est_ID {
michael's avatar
michael committed
371
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
372 373 374
    ME_FULL,
    ME_LOG,
    ME_PHODS,
michael's avatar
michael committed
375 376 377 378 379
    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
lorenm's avatar
lorenm committed
380
    ME_TESA,        ///< transformed exhaustive search algorithm
381 382
};

michael's avatar
michael committed
383
enum AVDiscard{
diego's avatar
diego committed
384 385
    /* 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
386 387 388 389 390 391 392 393
    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
394 395 396
typedef struct RcOverride{
    int start_frame;
    int end_frame;
diego's avatar
diego committed
397
    int qscale; // If this is 0 then quality_factor will be used instead.
michaelni's avatar
michaelni committed
398 399 400
    float quality_factor;
} RcOverride;

401
#define FF_MAX_B_FRAMES 16
402

michaelni's avatar
michaelni committed
403
/* encoding support
diego's avatar
diego committed
404 405
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
michaelni's avatar
michaelni committed
406
*/
glantau's avatar
glantau committed
407

diego's avatar
diego committed
408 409 410 411 412 413
#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
414 415
/**
 * The parent program guarantees that the input for B-frames containing
diego's avatar
diego committed
416
 * streams is not written to for at least s->max_b_frames+1 frames, if
michael's avatar
michael committed
417 418
 * this is not set the input will be copied.
 */
michaelni's avatar
michaelni committed
419
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
diego's avatar
diego committed
420 421 422 423 424 425 426 427
#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
428 429 430 431 432 433
#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_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
434
/* Fx : Flag for h263+ extra options */
diego's avatar
diego committed
435 436 437 438 439
#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
440 441
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
442 443
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
diego's avatar
diego committed
444
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
michael's avatar
michael committed
445
#define CODEC_FLAG_CLOSED_GOP     0x80000000
diego's avatar
diego committed
446 447 448 449 450 451
#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
452
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
lorenm's avatar
lorenm committed
453 454 455
#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
456 457 458 459 460 461 462
#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.
463
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
464

465
/* Unsupported options :
466 467
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
468
 *              Independent Segment Decoding */
469
/* /Fx */
glantau's avatar
glantau committed
470 471
/* codec capabilities */

diego's avatar
diego committed
472
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
michaelni's avatar
michaelni committed
473 474 475 476 477
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
diego's avatar
diego committed
478
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
479
#define CODEC_CAP_PARSE_ONLY      0x0004
480
#define CODEC_CAP_TRUNCATED       0x0008
diego's avatar
diego committed
481
/* Codec can export data for HW decoding (XvMC). */
482
#define CODEC_CAP_HWACCEL         0x0010
483
/**
diego's avatar
diego committed
484 485
 * 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.
486
 */
487
#define CODEC_CAP_DELAY           0x0020
488 489 490 491 492
/**
 * 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
493

diego's avatar
diego committed
494
//The following defines may change, don't expect compatibility if you use them.
495
#define MB_TYPE_INTRA4x4   0x0001
diego's avatar
diego committed
496 497
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
498 499 500 501 502
#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
503
#define MB_TYPE_DIRECT2    0x0100 //FIXME
504 505 506 507 508 509 510 511 512 513 514 515 516 517
#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, ...)

518 519
/**
 * Pan Scan area.
diego's avatar
diego committed
520 521
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
522 523 524
 */
typedef struct AVPanScan{
    /**
diego's avatar
diego committed
525 526 527
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
528 529 530 531 532
     */
    int id;

    /**
     * width and height in 1/16 pel
diego's avatar
diego committed
533 534
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
535 536 537 538 539
     */
    int width;
    int height;

    /**
diego's avatar
diego committed
540 541 542
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
543 544 545 546
     */
    int16_t position[3][2];
}AVPanScan;

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

765

766 767 768
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
769 770

#define FF_BUFFER_TYPE_INTERNAL 1
diego's avatar
diego committed
771 772 773
#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
774

michaelni's avatar
michaelni committed
775

776 777 778 779 780 781
#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
#define FF_SI_TYPE 5 ///< Switching Intra
#define FF_SP_TYPE 6 ///< Switching Predicted
782
#define FF_BI_TYPE 7
michaelni's avatar
michaelni committed
783

diego's avatar
diego committed
784 785 786 787
#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).
788

michaelni's avatar
michaelni committed
789 790
/**
 * Audio Video Frame.
791 792
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
 * bumps.
diego's avatar
diego committed
793
 * Removal, reordering and changes to existing fields require a major
794 795
 * version bump. No fields should be added into AVFrame before or after
 * FF_COMMON_FRAME!
diego's avatar
diego committed
796
 * sizeof(AVFrame) must not be used outside libav*.
michaelni's avatar
michaelni committed
797
 */
michaelni's avatar
michaelni committed
798 799 800
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
801

michaelni's avatar
doxy  
michaelni committed
802
/**
803 804
 * main external API structure.
 * New fields can be added to the end with minor version bumps.
diego's avatar
diego committed
805
 * Removal, reordering and changes to existing fields require a major
806
 * version bump.
diego's avatar
diego committed
807
 * sizeof(AVCodecContext) must not be used outside libav*.
michaelni's avatar
doxy  
michaelni committed
808
 */
glantau's avatar
glantau committed
809
typedef struct AVCodecContext {
810
    /**
diego's avatar
diego committed
811
     * information on struct for av_log
812 813
     * - set by avcodec_alloc_context
     */
814
    const AVClass *av_class;
815
    /**
diego's avatar
diego committed
816 817 818
     * 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.
819
     */
glantau's avatar
glantau committed
820
    int bit_rate;
821 822

    /**
823
     * number of bits the bitstream is allowed to diverge from the reference.
824
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
diego's avatar
diego committed
825
     * - encoding: Set by user; unused for constant quantizer encoding.
826
     * - decoding: unused
827
     */
828
    int bit_rate_tolerance;
829 830

    /**
831
     * CODEC_FLAG_*.
diego's avatar
diego committed
832 833
     * - encoding: Set by user.
     * - decoding: Set by user.
834
     */
glantau's avatar
glantau committed
835
    int flags;
836 837

    /**
diego's avatar
diego committed
838 839 840 841 842 843
     * 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?)
844 845 846 847
     */
    int sub_id;

    /**
diego's avatar
diego committed
848
     * Motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
849
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
850
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
851 852
     * - encoding: MUST be set by user.
     * - decoding: unused
853 854 855 856
     */
    int me_method;

    /**
diego's avatar
diego committed
857 858
     * some codecs need / can use extradata like Huffman tables.
     * mjpeg: Huffman tables
859
     * rv10: additional flags
860
     * mpeg4: global headers (they can be in the bitstream or here)
diego's avatar
diego committed
861 862 863 864 865
     * 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.
866
     */
867
    uint8_t *extradata;
868
    int extradata_size;
869

870
    /**
diego's avatar
diego committed
871 872
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
873 874
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
diego's avatar
diego committed
875 876
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
877
     */
michael's avatar
michael committed
878
    AVRational time_base;
879

880
    /* video only */
881
    /**
882
     * picture width / height.
883
     * - encoding: MUST be set by user.
diego's avatar
diego committed
884 885 886
     * - decoding: Set by libavcodec.
     * Note: For compatibility it is possible to set this instead of
     * coded_width/height before decoding.
887
     */
glantau's avatar
glantau committed
888
    int width, height;
889

890
#define FF_ASPECT_EXTENDED 15
891 892

    /**
diego's avatar
diego committed
893 894
     * the number of pictures in a group of pictures, or 0 for intra_only
     * - encoding: Set by user.
895
     * - decoding: unused
896 897 898 899
     */
    int gop_size;

    /**
diego's avatar
diego committed
900 901 902
     * Pixel format, see PIX_FMT_xxx.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
903
     */
904
    enum PixelFormat pix_fmt;
905

906
    /**
diego's avatar
diego committed
907
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
908
     * has to read frames at native frame rate.
diego's avatar
diego committed
909 910
     * - encoding: Set by user.
     * - decoding: unused
911 912
     */
    int rate_emu;
913

914
    /**
diego's avatar
diego committed
915 916
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw a horizontal band. It improves cache usage. Not
917
     * all codecs can do that. You must check the codec capabilities
diego's avatar
diego committed
918
     * beforehand.
919
     * - encoding: unused
diego's avatar
diego committed
920
     * - decoding: Set by user.
921 922 923 924
     * @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
925
     */
glantau's avatar
glantau committed
926
    void (*draw_horiz_band)(struct AVCodecContext *s,
927
                            const AVFrame *src, int offset[4],
928
                            int y, int type, int height);
glantau's avatar
glantau committed
929

glantau's avatar
glantau committed
930
    /* audio only */
diego's avatar
diego committed
931
    int sample_rate; ///< samples per second
932
    int channels;    ///< number of audio channels
933 934

    /**
diego's avatar
diego committed
935 936 937
     * audio sample format
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
938
     */
diego's avatar
diego committed
939
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
glantau's avatar
glantau committed
940

diego's avatar
diego committed
941
    /* The following data should not be initialized. */
942
    /**
diego's avatar
diego committed
943
     * Samples per packet, initialized when calling 'init'.
944 945
     */
    int frame_size;
946
    int frame_number;   ///< audio or video frame number
diego's avatar
diego committed
947
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
948

949
    /**
diego's avatar
diego committed
950
     * Number of frames the decoded output will be delayed relative to
951
     * the encoded input.
diego's avatar
diego committed
952
     * - encoding: Set by libavcodec.
953
     * - decoding: unused
954 955
     */
    int delay;
956

957 958
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
959 960
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

961
    /**
diego's avatar
diego committed
962 963
     * minimum quantizer
     * - encoding: Set by user.
964
     * - decoding: unused
965 966 967 968
     */
    int qmin;

    /**
diego's avatar
diego committed
969 970
     * maximum quantizer
     * - encoding: Set by user.
971
     * - decoding: unused
972 973 974 975
     */
    int qmax;

    /**
diego's avatar
diego committed
976 977
     * maximum quantizer difference between frames
     * - encoding: Set by user.
978
     * - decoding: unused
979 980 981 982
     */
    int max_qdiff;

    /**
diego's avatar
diego committed
983 984 985
     * 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.
986
     * - decoding: unused
987 988 989 990
     */
    int max_b_frames;

    /**
diego's avatar
diego committed
991
     * qscale factor between IP and B-frames
992 993
     * 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).
diego's avatar
diego committed
994
     * - encoding: Set by user.
995
     * - decoding: unused
996 997
     */
    float b_quant_factor;
998

999 1000
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
1001 1002
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
1003
    int b_frame_strategy;
1004

1005
    /**
diego's avatar
diego committed
1006
     * hurry up amount
1007
     * - encoding: unused
diego's avatar
diego committed
1008
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
takis's avatar
takis committed
1009
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1010 1011
     */
    int hurry_up;
1012

glantau's avatar
glantau committed
1013
    struct AVCodec *codec;
1014

glantau's avatar
glantau committed
1015 1016
    void *priv_data;

diego's avatar
diego committed
1017
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
diego's avatar
diego committed
1018
                            /* do its best to deliver a chunk with size     */
1019
                            /* below rtp_payload_size, the chunk will start */
diego's avatar
diego committed
1020
                            /* with a start code on some codecs like H.263. */
1021
                            /* This doesn't take account of any particular  */
diego's avatar
diego committed
1022
                            /* headers inside the transmitted RTP payload.  */
1023

1024

diego's avatar
diego committed
1025 1026 1027 1028 1029 1030
    /* 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.                  */
1031
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1032

michaelni's avatar
michaelni committed
1033 1034 1035 1036 1037 1038 1039 1040
    /* 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;
1041
    int misc_bits;
1042

1043
    /**
diego's avatar
diego committed
1044 1045
     * number of bits used for the previously encoded frame
     * - encoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1046
     * - decoding: unused
1047
     */
michaelni's avatar
michaelni committed
1048
    int frame_bits;
michaelni's avatar
michaelni committed
1049

1050
    /**
diego's avatar
diego committed
1051 1052 1053
     * Private data of the user, can be used to carry app specific stuff.
     * - encoding: Set by user.
     * - decoding: Set by user.
1054 1055 1056
     */
    void *opaque;

glantau's avatar
glantau committed
1057
    char codec_name[32];
1058 1059
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1060

michaelni's avatar
michaelni committed
1061 1062
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1063 1064 1065 1066 1067 1068
     * 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
1069
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
diego's avatar
diego committed
1070 1071 1072
     * 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
1073 1074
     */
    unsigned int codec_tag;
1075

1076
    /**
diego's avatar
diego committed
1077 1078 1079
     * Work around bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: Set by user
     * - decoding: Set by user
1080 1081
     */
    int workaround_bugs;
1082
#define FF_BUG_AUTODETECT       1  ///< autodetection
1083 1084 1085 1086
#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
1087
#define FF_BUG_AMV              32
diego's avatar
diego committed
1088
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
michaelni's avatar
michaelni committed
1089
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
1090
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
1091
#define FF_BUG_QPEL_CHROMA2     256
1092
#define FF_BUG_DIRECT_BLOCKSIZE 512
1093
#define FF_BUG_EDGE             1024
1094
#define FF_BUG_HPEL_CHROMA      2048
1095
#define FF_BUG_DC_CLIP          4096
diego's avatar
diego committed
1096 1097
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1098

1099
    /**
diego's avatar
diego committed
1100 1101
     * luma single coefficient elimination threshold
     * - encoding: Set by user.
1102
     * - decoding: unused
1103
     */
michaelni's avatar
 
michaelni committed
1104
    int luma_elim_threshold;
1105

1106
    /**
diego's avatar
diego committed
1107 1108
     * chroma single coeff elimination threshold
     * - encoding: Set by user.
1109
     * - decoding: unused
1110
     */
michaelni's avatar
 
michaelni committed
1111
    int chroma_elim_threshold;
1112

1113
    /**
diego's avatar
diego committed
1114 1115
     * strictly follow the standard (MPEG4, ...).
     * - encoding: Set by user.
1116 1117 1118 1119 1120 1121 1122 1123
     * - decoding: Set by user.
     * Setting this to STRICT or higher means the encoder and decoder will
     * generally do stupid things. While setting it to inofficial or lower
     * will mean the encoder might use things that are not supported by all
     * spec compliant decoders. Decoders make no difference between normal,
     * inofficial and experimental, that is they always try to decode things
     * when they can unless they are explicitly asked to behave stupid
     * (=strictly conform to the specs)
1124 1125
     */
    int strict_std_compliance;
diego's avatar
diego committed
1126 1127
#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.
1128
#define FF_COMPLIANCE_NORMAL        0
diego's avatar
diego committed
1129 1130
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1131

1132
    /**
diego's avatar
diego committed
1133 1134
     * qscale offset between IP and B-frames
     * - encoding: Set by user.
1135
     * - decoding: unused
1136 1137
     */
    float b_quant_offset;
1138

1139
    /**
1140
     * Error recognization; higher values will detect more errors but may
diego's avatar
diego committed
1141
     * misdetect some more or less valid parts as errors.
1142
     * - encoding: unused
diego's avatar
diego committed
1143
     * - decoding: Set by user.
1144
     */
1145
    int error_recognition;
diego's avatar
diego committed
1146
#define FF_ER_CAREFUL         1
1147 1148 1149
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1150

1151
    /**
diego's avatar
diego committed
1152 1153
     * 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
1154
     * avcodec_align_dimensions() should be used to find the required width and
diego's avatar
diego committed
1155
     * height, as they normally need to be rounded up to the next multiple of 16.
1156
     * - encoding: unused
diego's avatar
diego committed
1157
     * - decoding: Set by libavcodec., user can override.
1158
     */
michaelni's avatar
michaelni committed
1159
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1160

1161
    /**
ramiro's avatar
Typo  
ramiro committed
1162
     * Called to release buffers which were allocated with get_buffer.
diego's avatar
diego committed
1163 1164
     * A released buffer can be reused in get_buffer().
     * pic.data[*] must be set to NULL.
1165
     * - encoding: unused
diego's avatar
diego committed
1166
     * - decoding: Set by libavcodec., user can override.
1167
     */
michaelni's avatar
michaelni committed
1168
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1169

1170
    /**
diego's avatar
diego committed
1171 1172 1173
     * If 1 the stream has a 1 frame delay during decoding.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
1174 1175
     */
    int has_b_frames;
1176 1177 1178

    /**
     * number of bytes per packet if constant and known or 0
diego's avatar
diego committed
1179
     * Used by some WAV based audio codecs.
1180 1181
     */
    int block_align;
1182

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

1187
    /**
diego's avatar
diego committed
1188 1189
     * 0-> h263 quant 1-> mpeg quant
     * - encoding: Set by user.
1190
     * - decoding: unused
1191 1192
     */
    int mpeg_quant;
1193

1194
    /**
diego's avatar
diego committed
1195 1196
     * pass1 encoding statistics output buffer
     * - encoding: Set by libavcodec.
1197
     * - decoding: unused
1198
     */
1199
    char *stats_out;
1200

1201
    /**
diego's avatar
diego committed
1202 1203 1204
     * pass2 encoding statistics input buffer
     * Concatenated stuff from stats_out of pass1 should be placed here.
     * - encoding: Allocated/set/freed by user.
1205
     * - decoding: unused
1206 1207
     */
    char *stats_in;
1208

1209
    /**
diego's avatar
diego committed
1210 1211 1212
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
     * - encoding: Set by user.
1213
     * - decoding: unused
1214
     */
michaelni's avatar
michaelni committed
1215
    float rc_qsquish;
1216

michaelni's avatar
michaelni committed
1217 1218
    float rc_qmod_amp;
    int rc_qmod_freq;
1219

1220
    /**
diego's avatar
diego committed
1221 1222
     * ratecontrol override, see RcOverride
     * - encoding: Allocated/set/freed by user.
1223
     * - decoding: unused
1224
     */
michaelni's avatar
michaelni committed
1225 1226
    RcOverride *rc_override;
    int rc_override_count;
1227

1228
    /**
diego's avatar
diego committed
1229 1230
     * rate control equation
     * - encoding: Set by user
1231
     * - decoding: unused
1232
     */
lucabe's avatar
Fix  
lucabe committed
1233
    const char *rc_eq;
1234

1235
    /**
diego's avatar
diego committed
1236 1237
     * maximum bitrate
     * - encoding: Set by user.
1238
     * - decoding: unused
1239
     */
michaelni's avatar
michaelni committed
1240
    int rc_max_rate;
1241

1242
    /**
diego's avatar
diego committed
1243 1244
     * minimum bitrate
     * - encoding: Set by user.
1245
     * - decoding: unused
1246
     */
michaelni's avatar
michaelni committed
1247
    int rc_min_rate;
1248

1249
    /**
diego's avatar
diego committed
1250 1251
     * decoder bitstream buffer size
     * - encoding: Set by user.
1252
     * - decoding: unused
1253
     */
michaelni's avatar
michaelni committed
1254 1255
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1256 1257

    /**
diego's avatar
diego committed
1258 1259 1260 1261
     * 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.
1262
     * - decoding: unused
1263 1264
     */
    float i_quant_factor;
1265

1266
    /**
diego's avatar
diego committed
1267 1268
     * qscale offset between P and I-frames
     * - encoding: Set by user.
1269
     * - decoding: unused
1270 1271
     */
    float i_quant_offset;
1272

1273
    /**
diego's avatar
diego committed
1274 1275
     * initial complexity for pass1 ratecontrol
     * - encoding: Set by user.
1276
     * - decoding: unused
1277
     */
michaelni's avatar
michaelni committed
1278
    float rc_initial_cplx;
1279

1280
    /**
diego's avatar
diego committed
1281 1282
     * DCT algorithm, see FF_DCT_* below
     * - encoding: Set by user.
1283
     * - decoding: unused
1284
     */
1285
    int dct_algo;
1286
#define FF_DCT_AUTO    0
1287
#define FF_DCT_FASTINT 1
1288 1289 1290
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1291
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1292
#define FF_DCT_FAAN    6
1293

1294
    /**
diego's avatar
diego committed
1295 1296
     * luminance masking (0-> disabled)
     * - encoding: Set by user.
1297
     * - decoding: unused
1298 1299
     */
    float lumi_masking;
1300

1301
    /**
diego's avatar
diego committed
1302 1303
     * temporary complexity masking (0-> disabled)
     * - encoding: Set by user.
1304
     * - decoding: unused
1305 1306
     */
    float temporal_cplx_masking;
1307

1308
    /**
diego's avatar
diego committed
1309 1310
     * spatial complexity masking (0-> disabled)
     * - encoding: Set by user.
1311
     * - decoding: unused
1312 1313
     */
    float spatial_cplx_masking;
1314

1315
    /**
diego's avatar
diego committed
1316 1317
     * p block masking (0-> disabled)
     * - encoding: Set by user.
1318
     * - decoding: unused
1319 1320
     */
    float p_masking;
1321

1322
    /**
diego's avatar
diego committed
1323 1324
     * darkness masking (0-> disabled)
     * - encoding: Set by user.
1325
     * - decoding: unused
1326 1327
     */
    float dark_masking;
1328

1329
    /**
diego's avatar
diego committed
1330 1331 1332
     * IDCT algorithm, see FF_IDCT_* below.
     * - encoding: Set by user.
     * - decoding: Set by user.
1333 1334
     */
    int idct_algo;
diego's avatar
diego committed
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350
#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
1351
#define FF_IDCT_SIMPLEARMV5TE 16
diego's avatar
diego committed
1352
#define FF_IDCT_SIMPLEARMV6   17
1353
#define FF_IDCT_SIMPLEVIS     18
michael's avatar
michael committed
1354
#define FF_IDCT_WMV2          19
michael's avatar
michael committed
1355
#define FF_IDCT_FAAN          20
1356

1357
    /**
diego's avatar
diego committed
1358 1359 1360
     * slice count
     * - encoding: Set by libavcodec.
     * - decoding: Set by user (or 0).
1361 1362 1363
     */
    int slice_count;
    /**
diego's avatar
diego committed
1364 1365 1366
     * slice offsets in the frame in bytes
     * - encoding: Set/allocated by libavcodec.
     * - decoding: Set/allocated by user (or NULL).
1367 1368 1369
     */
    int *slice_offset;

1370
    /**
diego's avatar
diego committed
1371
     * error concealment flags
1372
     * - encoding: unused
diego's avatar
diego committed
1373
     * - decoding: Set by user.
1374 1375 1376 1377 1378
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1379
    /**
kabi's avatar
kabi committed
1380
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1381
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1382
     *
diego's avatar
diego committed
1383 1384 1385
     * 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
1386 1387
     */
    unsigned dsp_mask;
diego's avatar
diego committed
1388
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
kabi's avatar
kabi committed
1389
    /* lower 16 bits - CPU features */
michael's avatar
michael committed
1390 1391 1392 1393 1394 1395 1396 1397 1398
#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
1399 1400

    /**
1401
     * bits per sample/pixel from the demuxer (needed for huffyuv).
diego's avatar
diego committed
1402 1403
     * - encoding: Set by libavcodec.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1404
     */
1405
     int bits_per_coded_sample;
1406

michaelni's avatar
michaelni committed
1407
    /**
diego's avatar
diego committed
1408 1409
     * prediction method (needed for huffyuv)
     * - encoding: Set by user.
1410
     * - decoding: unused
michaelni's avatar
michaelni committed
1411 1412 1413 1414 1415
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1416

michaelni's avatar
michaelni committed
1417
    /**
diego's avatar
diego committed
1418
     * sample aspect ratio (0 if unknown)
michael's avatar
michael committed
1419
     * That is the width of a pixel divided by the height of the pixel.
diego's avatar
diego committed
1420 1421 1422
     * 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
1423
     */
michael's avatar
michael committed
1424
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1425 1426

    /**
diego's avatar
diego committed
1427 1428 1429
     * the picture in the bitstream
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1430
     */
michaelni's avatar
michaelni committed
1431
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1432 1433

    /**
diego's avatar
diego committed
1434 1435 1436
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1437 1438
     */
    int debug;
diego's avatar
diego committed
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
#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
1453
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1454
#define FF_DEBUG_BUFFERS     0x00008000
1455

1456
    /**
diego's avatar
diego committed
1457 1458 1459
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1460 1461 1462 1463 1464 1465
     */
    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

1466
    /**
diego's avatar
diego committed
1467 1468
     * error
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1469
     * - decoding: unused
1470 1471
     */
    uint64_t error[4];
1472

michaelni's avatar
michaelni committed
1473
    /**
diego's avatar
diego committed
1474
     * minimum MB quantizer
1475
     * - encoding: unused
1476
     * - decoding: unused
michaelni's avatar
michaelni committed
1477 1478 1479 1480
     */
    int mb_qmin;

    /**
diego's avatar
diego committed
1481
     * maximum MB quantizer
1482
     * - encoding: unused
1483
     * - decoding: unused
michaelni's avatar
michaelni committed
1484 1485
     */
    int mb_qmax;
1486

michaelni's avatar
michaelni committed
1487
    /**
diego's avatar
diego committed
1488 1489
     * motion estimation comparison function
     * - encoding: Set by user.
1490
     * - decoding: unused
michaelni's avatar
michaelni committed
1491 1492 1493
     */
    int me_cmp;
    /**
diego's avatar
diego committed
1494 1495
     * subpixel motion estimation comparison function
     * - encoding: Set by user.
1496
     * - decoding: unused
michaelni's avatar
michaelni committed
1497 1498 1499
     */
    int me_sub_cmp;
    /**
diego's avatar
diego committed
1500 1501
     * macroblock comparison function (not supported yet)
     * - encoding: Set by user.
1502
     * - decoding: unused
michaelni's avatar
michaelni committed
1503 1504
     */
    int mb_cmp;
michael's avatar
michael committed
1505
    /**
diego's avatar
diego committed
1506 1507
     * interlaced DCT comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1508 1509 1510
     * - decoding: unused
     */
    int ildct_cmp;
diego's avatar
diego committed
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
#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
1524
#define FF_CMP_DCTMAX 13
1525
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1526
#define FF_CMP_CHROMA 256
1527

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

    /**
diego's avatar
diego committed
1536 1537
     * amount of previous MV predictors (2a+1 x 2a+1 square)
     * - encoding: Set by user.
1538
     * - decoding: unused
michaelni's avatar
michaelni committed
1539 1540
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1541

michaelni's avatar
michaelni committed
1542
    /**
diego's avatar
diego committed
1543 1544
     * prepass for motion estimation
     * - encoding: Set by user.
1545
     * - decoding: unused
michaelni's avatar
michaelni committed
1546 1547
     */
    int pre_me;
michaelni's avatar
michaelni committed
1548

michaelni's avatar
michaelni committed
1549
    /**
diego's avatar
diego committed
1550 1551
     * motion estimation prepass comparison function
     * - encoding: Set by user.
1552
     * - decoding: unused
michaelni's avatar
michaelni committed
1553 1554
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1555

michaelni's avatar
michaelni committed
1556
    /**
diego's avatar
diego committed
1557 1558
     * ME prepass diamond size & shape
     * - encoding: Set by user.
1559
     * - decoding: unused
michaelni's avatar
michaelni committed
1560 1561 1562
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1563
    /**
diego's avatar
diego committed
1564 1565
     * subpel ME quality
     * - encoding: Set by user.
1566
     * - decoding: unused
michaelni's avatar
michaelni committed
1567 1568 1569
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1570
    /**
diego's avatar
diego committed
1571
     * callback to negotiate the pixelFormat
michaelni's avatar
michaelni committed
1572
     * @param fmt is the list of formats which are supported by the codec,
diego's avatar
diego committed
1573 1574 1575
     * 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
1576
     * - encoding: unused
diego's avatar
diego committed
1577
     * - decoding: Set by user, if not set the native format will be chosen.
michaelni's avatar
michaelni committed
1578
     */
iive's avatar
iive committed
1579
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1580 1581

    /**
diego's avatar
diego committed
1582 1583 1584
     * DTG active format information (additional aspect ratio
     * information only used in DVB MPEG-2 transport streams)
     * 0 if not set.
1585
     *
diego's avatar
diego committed
1586 1587
     * - encoding: unused
     * - decoding: Set by decoder.
1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
     */
    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

1598
    /**
diego's avatar
diego committed
1599 1600
     * maximum motion estimation search range in subpel units
     * If 0 then no limit.
1601
     *
diego's avatar
diego committed
1602 1603
     * - encoding: Set by user.
     * - decoding: unused
1604
     */
kabi's avatar
kabi committed
1605
    int me_range;
1606

michaelni's avatar
michaelni committed
1607
    /**
diego's avatar
diego committed
1608 1609
     * intra quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1610 1611 1612 1613
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1614

michaelni's avatar
michaelni committed
1615
    /**
diego's avatar
diego committed
1616 1617
     * inter quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1618 1619 1620
     * - decoding: unused
     */
    int inter_quant_bias;
1621 1622

    /**
diego's avatar
diego committed
1623 1624 1625 1626
     * color table ID
     * - encoding: unused
     * - decoding: Which clrtable should be used for 8bit RGB images.
     *             Tables have to be stored somewhere. FIXME
1627 1628
     */
    int color_table_id;
1629

1630
    /**
diego's avatar
diego committed
1631 1632
     * internal_buffer count
     * Don't touch, used by libavcodec default_get_buffer().
1633 1634
     */
    int internal_buffer_count;
1635

1636
    /**
diego's avatar
diego committed
1637 1638
     * internal_buffers
     * Don't touch, used by libavcodec default_get_buffer().
1639 1640
     */
    void *internal_buffer;
1641 1642 1643 1644 1645 1646 1647

#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
1648
    /**
diego's avatar
diego committed
1649 1650 1651
     * 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
1652 1653 1654
     * - decoding: unused
     */
    int global_quality;
1655

michael's avatar
michael committed
1656 1657
#define FF_CODER_TYPE_VLC       0
#define FF_CODER_TYPE_AC        1
1658 1659 1660
#define FF_CODER_TYPE_RAW       2
#define FF_CODER_TYPE_RLE       3
#define FF_CODER_TYPE_DEFLATE   4
michaelni's avatar
michaelni committed
1661 1662
    /**
     * coder type
diego's avatar
diego committed
1663
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1664 1665 1666 1667 1668 1669
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
diego's avatar
diego committed
1670
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1671 1672 1673
     * - decoding: unused
     */
    int context_model;
1674 1675 1676 1677
#if 0
    /**
     *
     * - encoding: unused
diego's avatar
diego committed
1678
     * - decoding: Set by user.
1679 1680 1681
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1682

1683 1684 1685
    /**
     * slice flags
     * - encoding: unused
diego's avatar
diego committed
1686
     * - decoding: Set by user.
1687 1688 1689 1690 1691 1692
     */
    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
1693 1694 1695 1696 1697 1698
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1699

1700 1701
    /**
     * macroblock decision mode
diego's avatar
diego committed
1702
     * - encoding: Set by user.
1703 1704 1705 1706 1707
     * - 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
ramiro's avatar
ramiro committed
1708
#define FF_MB_DECISION_RD     2        ///< rate distortion
1709 1710 1711

    /**
     * custom intra quantization matrix
diego's avatar
diego committed
1712 1713
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1714 1715 1716 1717 1718
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
diego's avatar
diego committed
1719 1720
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1721 1722
     */
    uint16_t *inter_matrix;
1723

1724 1725
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1726
     * This is used to work around some encoder bugs.
1727
     * - encoding: unused
diego's avatar
diego committed
1728
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1729 1730
     */
    unsigned int stream_codec_tag;
michaelni's avatar
michaelni committed
1731 1732

    /**
diego's avatar
diego committed
1733 1734 1735
     * scene change detection threshold
     * 0 is default, larger means fewer detected scene changes.
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1736 1737 1738
     * - decoding: unused
     */
    int scenechange_threshold;
1739 1740

    /**
diego's avatar
diego committed
1741 1742
     * minimum Lagrange multipler
     * - encoding: Set by user.
1743 1744 1745 1746 1747
     * - decoding: unused
     */
    int lmin;

    /**
diego's avatar
diego committed
1748 1749
     * maximum Lagrange multipler
     * - encoding: Set by user.
1750 1751 1752
     * - decoding: unused
     */
    int lmax;
1753 1754

    /**
diego's avatar
diego committed
1755
     * palette control structure
1756
     * - encoding: ??? (no palette-enabled encoder yet)
diego's avatar
diego committed
1757
     * - decoding: Set by user.
1758 1759
     */
    struct AVPaletteControl *palctrl;
1760 1761 1762

    /**
     * noise reduction strength
diego's avatar
diego committed
1763
     * - encoding: Set by user.
1764 1765 1766
     * - decoding: unused
     */
    int noise_reduction;
1767

1768
    /**
diego's avatar
diego committed
1769 1770 1771
     * 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
1772
     * same buffer or new buffer with old frame "painted" into it.
diego's avatar
diego committed
1773
     * If pic.data[0] == NULL must behave like get_buffer().
1774
     * - encoding: unused
diego's avatar
diego committed
1775
     * - decoding: Set by libavcodec., user can override
1776
     */
1777
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1778 1779

    /**
diego's avatar
diego committed
1780 1781
     * Number of bits which should be loaded into the rc buffer before decoding starts.
     * - encoding: Set by user.
michael's avatar
michael committed
1782 1783 1784 1785 1786 1787
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
diego's avatar
diego committed
1788
     * - encoding: Set by user.
michael's avatar
michael committed
1789 1790 1791 1792 1793
     * - decoding: unused
     */
    int inter_threshold;

    /**
diego's avatar
diego committed
1794 1795 1796
     * CODEC_FLAG2_*
     * - encoding: Set by user.
     * - decoding: Set by user.
michael's avatar
michael committed
1797 1798
     */
    int flags2;
michael's avatar
michael committed
1799 1800

    /**
diego's avatar
diego committed
1801 1802 1803
     * Simulates errors in the bitstream to test error concealment.
     * - encoding: Set by user.
     * - decoding: unused
michael's avatar
michael committed
1804 1805
     */
    int error_rate;
1806

1807 1808 1809
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
diego's avatar
diego committed
1810
     * - decoding: Set by user.
1811 1812 1813 1814 1815 1816
     */
    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
1817
    /**
diego's avatar
diego committed
1818 1819
     * quantizer noise shaping
     * - encoding: Set by user.
michael's avatar
michael committed
1820 1821 1822
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1823 1824

    /**
diego's avatar
diego committed
1825
     * thread count
1826
     * is used to decide how many independent tasks should be passed to execute()
diego's avatar
diego committed
1827 1828
     * - encoding: Set by user.
     * - decoding: Set by user.
1829 1830
     */
    int thread_count;
1831

1832
    /**
diego's avatar
diego committed
1833 1834 1835 1836
     * 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
1837
     * @param count the number of things to execute
diego's avatar
diego committed
1838 1839
     * - encoding: Set by libavcodec, user can override.
     * - decoding: Set by libavcodec, user can override.
1840 1841
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1842

1843
    /**
diego's avatar
diego committed
1844 1845
     * thread opaque
     * Can be used by execute() to store some per AVCodecContext stuff.
1846 1847 1848 1849
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1850 1851

    /**
diego's avatar
diego committed
1852 1853
     * Motion estimation threshold below which no motion estimation is
     * performed, but instead the user specified motion vectors are used.
1854
     *
diego's avatar
diego committed
1855
     * - encoding: Set by user.
1856
     * - decoding: unused
1857
     */
michael's avatar
michael committed
1858
     int me_threshold;
1859 1860

    /**
diego's avatar
diego committed
1861 1862
     * Macroblock threshold below which the user specified macroblock types will be used.
     * - encoding: Set by user.
1863 1864 1865
     * - decoding: unused
     */
     int mb_threshold;
1866 1867

    /**
diego's avatar
diego committed
1868 1869
     * precision of the intra DC coefficient - 8
     * - encoding: Set by user.
1870 1871 1872
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1873 1874

    /**
diego's avatar
diego committed
1875 1876
     * noise vs. sse weight for the nsse comparsion function
     * - encoding: Set by user.
michael's avatar
michael committed
1877 1878 1879
     * - decoding: unused
     */
     int nsse_weight;
1880 1881

    /**
diego's avatar
diego committed
1882
     * Number of macroblock rows at the top which are skipped.
1883
     * - encoding: unused
diego's avatar
diego committed
1884
     * - decoding: Set by user.
1885 1886 1887 1888
     */
     int skip_top;

    /**
diego's avatar
diego committed
1889
     * Number of macroblock rows at the bottom which are skipped.
1890
     * - encoding: unused
diego's avatar
diego committed
1891
     * - decoding: Set by user.
1892 1893
     */
     int skip_bottom;
michael's avatar
michael committed
1894 1895 1896

    /**
     * profile
diego's avatar
diego committed
1897 1898
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1899 1900 1901
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99
benoit's avatar
 
benoit committed
1902
#define FF_PROFILE_AAC_MAIN 0
diego's avatar
diego committed
1903 1904 1905
#define FF_PROFILE_AAC_LOW  1
#define FF_PROFILE_AAC_SSR  2
#define FF_PROFILE_AAC_LTP  3
michael's avatar
michael committed
1906 1907 1908

    /**
     * level
diego's avatar
diego committed
1909 1910
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1911 1912 1913
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1914 1915

    /**
diego's avatar
diego committed
1916
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
michael's avatar
michael committed
1917
     * - encoding: unused
diego's avatar
diego committed
1918
     * - decoding: Set by user.
michael's avatar
michael committed
1919 1920
     */
     int lowres;
1921 1922

    /**
diego's avatar
diego committed
1923 1924
     * Bitstream width / height, may be different from width/height if lowres
     * or other things are used.
1925
     * - encoding: unused
diego's avatar
diego committed
1926
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1927 1928
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1929 1930 1931

    /**
     * frame skip threshold
diego's avatar
diego committed
1932
     * - encoding: Set by user.
michael's avatar
michael committed
1933 1934 1935 1936 1937 1938
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
diego's avatar
diego committed
1939
     * - encoding: Set by user.
michael's avatar
michael committed
1940 1941 1942
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1943 1944 1945

    /**
     * frame skip exponent
diego's avatar
diego committed
1946
     * - encoding: Set by user.
michael's avatar
michael committed
1947 1948 1949 1950 1951
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
diego's avatar
diego committed
1952 1953
     * frame skip comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1954 1955 1956
     * - decoding: unused
     */
    int frame_skip_cmp;
1957 1958

    /**
diego's avatar
diego committed
1959
     * Border processing masking, raises the quantizer for mbs on the borders
1960
     * of the picture.
diego's avatar
diego committed
1961
     * - encoding: Set by user.
1962 1963 1964
     * - decoding: unused
     */
    float border_masking;
1965 1966

    /**
diego's avatar
diego committed
1967 1968
     * minimum MB lagrange multipler
     * - encoding: Set by user.
1969 1970 1971 1972 1973
     * - decoding: unused
     */
    int mb_lmin;

    /**
diego's avatar
diego committed
1974 1975
     * maximum MB lagrange multipler
     * - encoding: Set by user.
1976 1977 1978
     * - decoding: unused
     */
    int mb_lmax;
1979 1980

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

    /**
1988
     *
michael's avatar
michael committed
1989
     * - encoding: unused
diego's avatar
diego committed
1990
     * - decoding: Set by user.
michael's avatar
michael committed
1991 1992 1993 1994
     */
    enum AVDiscard skip_loop_filter;

    /**
1995
     *
michael's avatar
michael committed
1996
     * - encoding: unused
diego's avatar
diego committed
1997
     * - decoding: Set by user.
michael's avatar
michael committed
1998 1999 2000 2001
     */
    enum AVDiscard skip_idct;

    /**
2002
     *
michael's avatar
michael committed
2003
     * - encoding: unused
diego's avatar
diego committed
2004
     * - decoding: Set by user.
michael's avatar
michael committed
2005 2006
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
2007 2008 2009

    /**
     *
diego's avatar
diego committed
2010
     * - encoding: Set by user.
michael's avatar
michael committed
2011 2012 2013
     * - decoding: unused
     */
    int bidir_refine;
2014 2015 2016

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

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
diego's avatar
diego committed
2024
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2025 2026
     * - decoding: unused
     */
lu_zero's avatar
lu_zero committed
2027
    float crf;
lorenm's avatar
lorenm committed
2028 2029 2030

    /**
     * constant quantization parameter rate control method
diego's avatar
diego committed
2031
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2032 2033 2034 2035 2036
     * - decoding: unused
     */
    int cqp;

    /**
diego's avatar
diego committed
2037 2038
     * minimum GOP size
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2039 2040 2041 2042 2043 2044
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
diego's avatar
diego committed
2045
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2046 2047 2048 2049 2050 2051
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
diego's avatar
diego committed
2052
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2053 2054 2055 2056 2057
     * - decoding: unused
     */
    int chromaoffset;

    /**
diego's avatar
diego committed
2058 2059
     * Influences how often B-frames are used.
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2060 2061 2062 2063 2064 2065
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
diego's avatar
diego committed
2066
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2067 2068 2069 2070 2071
     * - decoding: unused
     */
    int trellis;

    /**
diego's avatar
diego committed
2072 2073
     * Reduce fluctuations in qp (before curve compression).
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2074 2075 2076 2077 2078 2079 2080
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
diego's avatar
diego committed
2081
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2082 2083 2084 2085 2086 2087 2088
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
diego's avatar
diego committed
2089
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2090 2091 2092 2093 2094 2095
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
diego's avatar
diego committed
2096
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2097 2098 2099
     * - decoding: unused
     */
    int partitions;
2100 2101 2102 2103 2104
#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
2105 2106

    /**
2107
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
diego's avatar
diego committed
2108
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2109 2110 2111
     * - decoding: unused
     */
    int directpred;
2112

2113
    /**
2114
     * Audio cutoff bandwidth (0 means "automatic")
diego's avatar
diego committed
2115
     * - encoding: Set by user.
2116 2117 2118
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
2119 2120

    /**
diego's avatar
diego committed
2121 2122
     * Multiplied by qscale for each frame and added to scene_change_score.
     * - encoding: Set by user.
corey's avatar
corey committed
2123 2124 2125
     * - decoding: unused
     */
    int scenechange_factor;
2126 2127 2128

    /**
     *
diego's avatar
diego committed
2129 2130
     * Note: Value depends upon the compare function used for fullpel ME.
     * - encoding: Set by user.
2131 2132 2133
     * - decoding: unused
     */
    int mv0_threshold;
2134 2135

    /**
diego's avatar
diego committed
2136 2137
     * Adjusts sensitivity of b_frame_strategy 1.
     * - encoding: Set by user.
2138 2139 2140
     * - decoding: unused
     */
    int b_sensitivity;
2141 2142

    /**
diego's avatar
diego committed
2143
     * - encoding: Set by user.
2144 2145 2146 2147 2148 2149
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
diego's avatar
diego committed
2150 2151 2152
     * Sets whether to use LPC mode - used by FLAC encoder.
     * - encoding: Set by user.
     * - decoding: unused
2153 2154 2155 2156 2157
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
diego's avatar
diego committed
2158 2159
     * - encoding: Set by user.
     * - decoding: unused
2160 2161 2162 2163
     */
    int lpc_coeff_precision;

    /**
diego's avatar
diego committed
2164 2165
     * - encoding: Set by user.
     * - decoding: unused
2166 2167 2168 2169
     */
    int min_prediction_order;

    /**
diego's avatar
diego committed
2170 2171
     * - encoding: Set by user.
     * - decoding: unused
2172 2173 2174 2175 2176
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
diego's avatar
diego committed
2177 2178
     * - encoding: Set by user.
     * - decoding: unused
2179 2180 2181 2182
     */
    int prediction_order_method;

    /**
diego's avatar
diego committed
2183 2184
     * - encoding: Set by user.
     * - decoding: unused
2185 2186 2187 2188
     */
    int min_partition_order;

    /**
diego's avatar
diego committed
2189 2190
     * - encoding: Set by user.
     * - decoding: unused
2191 2192
     */
    int max_partition_order;
2193 2194 2195

    /**
     * GOP timecode frame start number, in non drop frame format
diego's avatar
diego committed
2196 2197
     * - encoding: Set by user.
     * - decoding: unused
2198 2199
     */
    int64_t timecode_frame_start;
2200 2201 2202 2203 2204 2205 2206

    /**
     * Decoder should decode to this many channels if it can (0 for default)
     * - encoding: unused
     * - decoding: Set by user.
     */
    int request_channels;
2207 2208 2209 2210 2211 2212 2213 2214

    /**
     * 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;
2215 2216 2217 2218 2219 2220 2221 2222

    /**
     * opaque 64bit number (generally a PTS) that will be reordered and
     * output in AVFrame.reordered_opaque
     * - encoding: unused
     * - decoding: Set by user.
     */
    int64_t reordered_opaque;
2223 2224 2225 2226 2227 2228 2229 2230

    /**
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
     * - encoding: set by user.
     * - decoding: set by libavcodec.
     */
    int bits_per_raw_sample;
glantau's avatar
glantau committed
2231 2232
} AVCodecContext;

2233 2234 2235
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
2236
typedef struct AVCodec {
benoit's avatar
benoit committed
2237 2238 2239 2240 2241 2242
    /**
     * 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
2243
    const char *name;
kabi's avatar
kabi committed
2244
    enum CodecType type;
michael's avatar
michael committed
2245
    enum CodecID id;
glantau's avatar
glantau committed
2246 2247
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
2248
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
2249
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
2250
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2251
                  const uint8_t *buf, int buf_size);
michael's avatar
michael committed
2252 2253 2254 2255
    /**
     * Codec capabilities.
     * see CODEC_CAP_*
     */
glantau's avatar
glantau committed
2256
    int capabilities;
glantau's avatar
glantau committed
2257
    struct AVCodec *next;
michael's avatar
michael committed
2258 2259 2260 2261
    /**
     * Flush buffers.
     * Will be called when seeking
     */
michaelni's avatar
michaelni committed
2262
    void (*flush)(AVCodecContext *);
2263
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
benoit's avatar
benoit committed
2264
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2265 2266 2267 2268 2269
    /**
     * Descriptive name for the codec, meant to be more human readable than \p name.
     * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
     */
    const char *long_name;
2270
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2271
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
glantau's avatar
glantau committed
2272 2273
} AVCodec;

kabi's avatar
kabi committed
2274
/**
2275 2276 2277
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
2278
typedef struct AVPicture {
kabi's avatar
kabi committed
2279
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2280
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2281 2282
} AVPicture;

tmmm's avatar
tmmm committed
2283 2284 2285 2286
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
benoit's avatar
 
benoit committed
2287 2288 2289
 *
 * @deprecated Use AVPacket to send palette changes instead.
 * This is totally broken.
tmmm's avatar
tmmm committed
2290
 */
2291
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2292
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2293 2294
typedef struct AVPaletteControl {

diego's avatar
diego committed
2295 2296
    /* Demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0. */
tmmm's avatar
tmmm committed
2297 2298
    int palette_changed;

2299 2300
    /* 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
2301 2302
     * the palette data comes from an IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled. */
2303
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2304

2305
} AVPaletteControl attribute_deprecated;
tmmm's avatar
tmmm committed
2306

2307
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2308 2309 2310 2311 2312 2313 2314 2315
    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;
2316 2317 2318 2319 2320 2321 2322 2323
} 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
2324 2325 2326
} AVSubtitle;


glantau's avatar
glantau committed
2327 2328 2329
/* resample.c */

struct ReSampleContext;
2330
struct AVResampleContext;
glantau's avatar
glantau committed
2331 2332 2333

typedef struct ReSampleContext ReSampleContext;

2334
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2335 2336 2337 2338
                                     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
2339
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2340
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
2341
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2342
void av_resample_close(struct AVResampleContext *c);
2343

michael's avatar
michael committed
2344 2345 2346
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
diego's avatar
diego committed
2347 2348 2349 2350 2351
 * @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
2352 2353 2354
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2355 2356 2357
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
diego's avatar
diego committed
2358
 * @param picture the AVPicture to be freed
2359
 */
michael's avatar
michael committed
2360 2361
void avpicture_free(AVPicture *picture);

2362
/**
diego's avatar
diego committed
2363
 * Fill in the AVPicture fields.
2364 2365 2366 2367 2368 2369 2370
 * 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
2371
 * @param picture AVPicture whose fields are to be filled in
2372
 * @param ptr Buffer which will contain or contains the actual image data
diego's avatar
diego committed
2373 2374 2375 2376
 * @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
2377
 */
kabi's avatar
kabi committed
2378
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2379
                   int pix_fmt, int width, int height);
2380
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2381
                     unsigned char *dest, int dest_size);
2382 2383 2384 2385 2386

/**
 * 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
2387 2388 2389
 * @param pix_fmt the given picture format
 * @param width the width of the image
 * @param height the height of the image
2390 2391
 * @return Image data size in bytes
 */
2392
int avpicture_get_size(int pix_fmt, int width, int height);
2393 2394
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);
2395
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2396
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2397
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2398

2399 2400 2401 2402 2403 2404
#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) */
2405

2406
/**
2407 2408 2409 2410 2411 2412 2413 2414
 * 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
2415 2416
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 * which will occur when converting from one pixel format to another.
2417
 *
diego's avatar
diego committed
2418 2419
 * @param[in] dst_pix_fmt destination pixel format
 * @param[in] src_pix_fmt source pixel format
2420 2421
 * @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.
2422
 */
2423 2424
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2425 2426

/**
2427 2428 2429 2430 2431
 * 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
2432 2433
 * 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
2434 2435 2436 2437 2438 2439 2440 2441
 * \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
2442 2443
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 * @param[in] src_pix_fmt source pixel format
2444 2445 2446
 * @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.
2447
 */
2448
int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2449 2450
                              int has_alpha, int *loss_ptr);

benoit's avatar
 
benoit committed
2451 2452 2453 2454 2455

/**
 * Print in buf the string corresponding to the pixel format with
 * number pix_fmt, or an header if pix_fmt is negative.
 *
2456 2457 2458
 * @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
2459 2460 2461 2462 2463
 * 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
2464 2465
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2466 2467 2468 2469 2470

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

2474
/* deinterlace a picture */
2475
/* deinterlace - if not supported return -1 */
2476
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2477 2478 2479 2480
                          int pix_fmt, int width, int height);

/* external high level API */

michael's avatar
michael committed
2481
AVCodec *av_codec_next(AVCodec *c);
glantau's avatar
glantau committed
2482

stefano's avatar
stefano committed
2483 2484 2485
/**
 * Returns the LIBAVCODEC_VERSION_INT constant.
 */
2486
unsigned avcodec_version(void);
stefano's avatar
stefano committed
2487

takis's avatar
takis committed
2488 2489 2490 2491 2492 2493
/**
 * Initializes libavcodec.
 *
 * @warning This function \e must be called before any other libavcodec
 * function.
 */
glantau's avatar
glantau committed
2494 2495 2496
void avcodec_init(void);

void register_avcodec(AVCodec *format);
takis's avatar
takis committed
2497 2498

/**
2499
 * Finds a registered encoder with a matching codec ID.
takis's avatar
takis committed
2500
 *
diego's avatar
diego committed
2501
 * @param id CodecID of the requested encoder
takis's avatar
takis committed
2502 2503
 * @return An encoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2504
AVCodec *avcodec_find_encoder(enum CodecID id);
takis's avatar
takis committed
2505 2506

/**
2507
 * Finds a registered encoder with the specified name.
takis's avatar
takis committed
2508
 *
diego's avatar
diego committed
2509
 * @param name name of the requested encoder
takis's avatar
takis committed
2510 2511
 * @return An encoder if one was found, NULL otherwise.
 */
2512
AVCodec *avcodec_find_encoder_by_name(const char *name);
takis's avatar
takis committed
2513 2514

/**
2515
 * Finds a registered decoder with a matching codec ID.
takis's avatar
takis committed
2516
 *
diego's avatar
diego committed
2517
 * @param id CodecID of the requested decoder
takis's avatar
takis committed
2518 2519
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2520
AVCodec *avcodec_find_decoder(enum CodecID id);
takis's avatar
takis committed
2521 2522

/**
2523
 * Finds a registered decoder with the specified name.
takis's avatar
takis committed
2524
 *
diego's avatar
diego committed
2525
 * @param name name of the requested decoder
takis's avatar
takis committed
2526 2527
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2528 2529 2530
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
2531 2532 2533 2534 2535
/**
 * 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
2536
void avcodec_get_context_defaults(AVCodecContext *s);
takis's avatar
takis committed
2537

2538 2539 2540 2541
/** 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
2542 2543 2544 2545 2546 2547 2548
/**
 * 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
2549
AVCodecContext *avcodec_alloc_context(void);
takis's avatar
takis committed
2550

2551 2552 2553 2554
/** 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
2555 2556 2557 2558 2559
/**
 * 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
2560
void avcodec_get_frame_defaults(AVFrame *pic);
takis's avatar
takis committed
2561 2562 2563 2564 2565 2566 2567 2568

/**
 * 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
2569
AVFrame *avcodec_alloc_frame(void);
michaelni's avatar
michaelni committed
2570

michaelni's avatar
michaelni committed
2571 2572
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2573 2574
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
takis's avatar
takis committed
2575 2576 2577 2578 2579 2580 2581 2582 2583

/**
 * 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.
 */
2584
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
michael's avatar
michael committed
2585
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
michaelni's avatar
michaelni committed
2586

michael's avatar
1l  
michael committed
2587 2588 2589
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
2590
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2591 2592
//FIXME func typedef

michaelni's avatar
michaelni committed
2593
/**
takis's avatar
takis committed
2594 2595 2596 2597 2598 2599 2600
 * 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
2601
 * @warning This function is not thread safe!
takis's avatar
takis committed
2602 2603
 *
 * @code
2604
 * avcodec_register_all();
takis's avatar
takis committed
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
 * 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
2615
 * @param avctx The context which will be set up to use the given codec.
takis's avatar
takis committed
2616
 * @param codec The codec to use within the context.
diego's avatar
diego committed
2617
 * @return zero on success, a negative value on error
takis's avatar
takis committed
2618
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
michaelni's avatar
michaelni committed
2619
 */
glantau's avatar
glantau committed
2620
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2621

2622
/**
takis's avatar
takis committed
2623
 * Decodes an audio frame from \p buf into \p samples.
diego's avatar
diego committed
2624
 * The avcodec_decode_audio2() function decodes an audio frame from the input
takis's avatar
takis committed
2625
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2626
 * audio codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639
 * 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.
2640
 *
takis's avatar
takis committed
2641
 * @note You might have to align the input buffer \p buf and output buffer \p
diego's avatar
diego committed
2642
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
takis's avatar
takis committed
2643 2644 2645 2646 2647 2648 2649
 * 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
2650 2651 2652 2653 2654
 * @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
2655 2656
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
2657
 */
michael's avatar
michael committed
2658
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
glantau's avatar
glantau committed
2659
                         int *frame_size_ptr,
2660
                         const uint8_t *buf, int buf_size);
takis's avatar
takis committed
2661 2662 2663

/**
 * Decodes a video frame from \p buf into \p picture.
diego's avatar
diego committed
2664
 * The avcodec_decode_video() function decodes a video frame from the input
takis's avatar
takis committed
2665
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2666
 * video codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684
 * 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
2685
 * @param avctx the codec context
takis's avatar
takis committed
2686
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
diego's avatar
diego committed
2687 2688 2689
 * @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
2690 2691 2692
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
 */
2693
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
glantau's avatar
glantau committed
2694
                         int *got_picture_ptr,
2695
                         const uint8_t *buf, int buf_size);
2696

diego's avatar
diego committed
2697 2698 2699
/* 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
2700 2701 2702
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2703
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2704
                        int *data_size_ptr,
kabi's avatar
kabi committed
2705
                        uint8_t *buf, int buf_size);
takis's avatar
takis committed
2706 2707 2708

/**
 * Encodes an audio frame from \p samples into \p buf.
diego's avatar
diego committed
2709 2710
 * 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
2711 2712 2713 2714 2715
 * 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
2716 2717 2718 2719
 * @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
2720 2721
 * The number of samples read from this buffer is frame_size*channels,
 * both of which are defined in \p avctx.
2722 2723
 * For PCM audio the number of samples read from \p samples is equal to
 * \p buf_size * input_sample_size / output_sample_size.
diego's avatar
diego committed
2724
 * @return On error a negative value is returned, on success zero or the number
2725
 * of bytes used to encode the data read from the input buffer.
takis's avatar
takis committed
2726
 */
2727
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
glantau's avatar
glantau committed
2728
                         const short *samples);
takis's avatar
takis committed
2729 2730 2731

/**
 * Encodes a video frame from \p pict into \p buf.
diego's avatar
diego committed
2732 2733
 * 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
2734 2735 2736 2737
 * \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
2738 2739 2740 2741
 * @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
2742 2743 2744
 * @return On error a negative value is returned, on success zero or the number
 * of bytes used from the input buffer.
 */
2745
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
michaelni's avatar
michaelni committed
2746
                         const AVFrame *pict);
2747
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
bellard's avatar
bellard committed
2748
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2749 2750 2751 2752

int avcodec_close(AVCodecContext *avctx);

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

2754 2755 2756
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
michaelni's avatar
michaelni committed
2757 2758
void avcodec_flush_buffers(AVCodecContext *avctx);

2759 2760
void avcodec_default_free_buffers(AVCodecContext *s);

takis's avatar
takis committed
2761
/* misc useful functions */
michaelni's avatar
michaelni committed
2762 2763

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

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

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

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

michael's avatar
michael committed
2812 2813
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
benoit's avatar
 
benoit committed
2814 2815

    int64_t offset;      ///< byte offset from starting packet start
2816
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
bellard's avatar
bellard committed
2817 2818 2819
} AVCodecParserContext;

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

michael's avatar
michael committed
2832
AVCodecParser *av_parser_next(AVCodecParser *c);
bellard's avatar
bellard committed
2833 2834 2835

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

2847 2848

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


typedef struct AVBitStreamFilter {
    const char *name;
michael's avatar
michael committed
2858
    int priv_data_size;
2859 2860 2861 2862
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
2863
    void (*close)(AVBitStreamFilterContext *bsfc);
2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
    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
2875
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2876

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

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

2887 2888 2889
/**
 * Copy image 'src' to 'dst'.
 */
2890
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2891 2892
              int pix_fmt, int width, int height);

2893
/**
diego's avatar
diego committed
2894
 * Crop image top and left side.
2895
 */
2896
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2897 2898
             int pix_fmt, int top_band, int left_band);

2899
/**
diego's avatar
diego committed
2900
 * Pad image.
2901
 */
2902
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2903 2904
            int padtop, int padbottom, int padleft, int padright, int *color);

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

2907 2908 2909
/**
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
 *
diego's avatar
diego committed
2910
 * @return 0 in case of a successful parsing, a negative value otherwise
2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922
 * @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
2923
 * @return 0 in case of a successful parsing, a negative value otherwise
2924 2925 2926 2927 2928 2929 2930
 * @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);

2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942
/**
 * Logs a generic warning message about a missing feature.
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
 * a pointer to an AVClass struct
 * @param[in] feature string containing the name of the missing feature
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
 * If \p want_sample is non-zero, additional verbage will be added to the log
 * message which tells the user how to report samples to the development
 * mailing list.
 */
void av_log_missing_feature(void *avc, const char *feature, int want_sample);

2943 2944
/* error handling */
#if EINVAL > 0
diego's avatar
diego committed
2945 2946
#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. */
2947
#else
diego's avatar
diego committed
2948
/* Some platforms have E* and errno already negated. */
2949 2950 2951 2952
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
diego's avatar
diego committed
2953 2954
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2955 2956 2957
#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
2958
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
benoit's avatar
 
benoit committed
2959
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
ramiro's avatar
ramiro committed
2960
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2961

2962
#endif /* AVCODEC_AVCODEC_H */