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

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

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


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

33 34 35
#define LIBAVCODEC_VERSION_MAJOR 51
#define LIBAVCODEC_VERSION_MINOR 50
#define LIBAVCODEC_VERSION_MICRO  1
mru's avatar
mru committed
36

37 38 39 40 41 42
#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)
43
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
44

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

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

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

diego's avatar
diego committed
182
    /* various PCM "codecs" */
183
    CODEC_ID_PCM_S16LE= 0x10000,
glantau's avatar
glantau committed
184 185 186 187 188 189 190
    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,
191 192 193 194 195 196 197 198 199
    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,
200
    CODEC_ID_PCM_ZORK,
201
    CODEC_ID_PCM_S16LE_PLANAR,
202

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

231 232
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
233 234
    CODEC_ID_AMR_WB,

235
    /* RealAudio codecs*/
236
    CODEC_ID_RA_144= 0x13000,
237
    CODEC_ID_RA_288,
238 239

    /* various DPCM codecs */
240
    CODEC_ID_ROQ_DPCM= 0x14000,
241
    CODEC_ID_INTERPLAY_DPCM,
242
    CODEC_ID_XAN_DPCM,
243
    CODEC_ID_SOL_DPCM,
244

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

bellard's avatar
bellard committed
291
    /* subtitle codecs */
292 293
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
294
    CODEC_ID_TEXT,  ///< raw UTF-8 text
295
    CODEC_ID_XSUB,
296
    CODEC_ID_SSA,
297
    CODEC_ID_MOV_TEXT,
298

299 300 301
    /* other specific kind of codecs (generaly used for attachments) */
    CODEC_ID_TTF= 0x18000,

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

306
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
307
/* CODEC_ID_MP3LAME is obsolete */
308
#define CODEC_ID_MP3LAME CODEC_ID_MP3
309 310
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
glantau's avatar
glantau committed
311 312

enum CodecType {
313
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
314 315
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
316
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
317
    CODEC_TYPE_SUBTITLE,
318
    CODEC_TYPE_ATTACHMENT,
319
    CODEC_TYPE_NB
glantau's avatar
glantau committed
320 321
};

322 323 324 325
/**
 * Currently unused, may be used if 24/32 bits samples are ever supported.
 * all in native-endian format
 */
glantau's avatar
glantau committed
326
enum SampleFormat {
mru's avatar
mru committed
327
    SAMPLE_FMT_NONE = -1,
328 329 330
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
331
    SAMPLE_FMT_S32,             ///< signed 32 bits
332
    SAMPLE_FMT_FLT,             ///< float
glantau's avatar
glantau committed
333 334
};

glantau's avatar
glantau committed
335
/* in bytes */
336
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
337

338
/**
339
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
diego's avatar
diego committed
340 341 342 343
 * 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.
344 345 346
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

347
/**
diego's avatar
diego committed
348 349
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
350 351 352
 */
#define FF_MIN_BUFFER_SIZE 16384

353
/**
354
 * motion estimation type.
355
 */
356
enum Motion_Est_ID {
michael's avatar
michael committed
357
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
358 359 360
    ME_FULL,
    ME_LOG,
    ME_PHODS,
michael's avatar
michael committed
361 362 363 364 365
    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
366 367
};

michael's avatar
michael committed
368
enum AVDiscard{
diego's avatar
diego committed
369 370
    /* 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
371 372 373 374 375 376 377 378
    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
379 380 381
typedef struct RcOverride{
    int start_frame;
    int end_frame;
diego's avatar
diego committed
382
    int qscale; // If this is 0 then quality_factor will be used instead.
michaelni's avatar
michaelni committed
383 384 385
    float quality_factor;
} RcOverride;

386
#define FF_MAX_B_FRAMES 16
387

michaelni's avatar
michaelni committed
388
/* encoding support
diego's avatar
diego committed
389 390
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
michaelni's avatar
michaelni committed
391
*/
glantau's avatar
glantau committed
392

diego's avatar
diego committed
393 394 395 396 397 398
#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
399 400
/**
 * The parent program guarantees that the input for B-frames containing
diego's avatar
diego committed
401
 * streams is not written to for at least s->max_b_frames+1 frames, if
michael's avatar
michael committed
402 403
 * this is not set the input will be copied.
 */
michaelni's avatar
michaelni committed
404
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
diego's avatar
diego committed
405 406 407 408 409 410 411 412
#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
413 414 415 416 417 418 419
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
#define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
420
/* Fx : Flag for h263+ extra options */
421
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
422
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
423
#endif
diego's avatar
diego committed
424 425 426 427 428
#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
429 430
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
431 432
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
diego's avatar
diego committed
433
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
bcoudurier's avatar
bcoudurier committed
434
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
diego's avatar
diego committed
435 436 437 438 439 440
#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
441
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
lorenm's avatar
lorenm committed
442 443 444
#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
445 446 447 448 449 450 451
#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.
452
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
453

454
/* Unsupported options :
455 456
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
457
 *              Independent Segment Decoding */
458
/* /Fx */
glantau's avatar
glantau committed
459 460
/* codec capabilities */

diego's avatar
diego committed
461
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
michaelni's avatar
michaelni committed
462 463 464 465 466
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
diego's avatar
diego committed
467
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
468
#define CODEC_CAP_PARSE_ONLY      0x0004
469
#define CODEC_CAP_TRUNCATED       0x0008
diego's avatar
diego committed
470
/* Codec can export data for HW decoding (XvMC). */
471
#define CODEC_CAP_HWACCEL         0x0010
472
/**
diego's avatar
diego committed
473 474
 * 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.
475
 */
476
#define CODEC_CAP_DELAY           0x0020
477 478 479 480 481
/**
 * 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
482

diego's avatar
diego committed
483
//The following defines may change, don't expect compatibility if you use them.
484
#define MB_TYPE_INTRA4x4   0x0001
diego's avatar
diego committed
485 486
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
487 488 489 490 491
#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
492
#define MB_TYPE_DIRECT2    0x0100 //FIXME
493 494 495 496 497 498 499 500 501 502 503 504 505 506
#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, ...)

507 508
/**
 * Pan Scan area.
diego's avatar
diego committed
509 510
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
511 512 513
 */
typedef struct AVPanScan{
    /**
diego's avatar
diego committed
514 515 516
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
517 518 519 520 521
     */
    int id;

    /**
     * width and height in 1/16 pel
diego's avatar
diego committed
522 523
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
524 525 526 527 528
     */
    int width;
    int height;

    /**
diego's avatar
diego committed
529 530 531
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
532 533 534 535
     */
    int16_t position[3][2];
}AVPanScan;

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

744 745 746
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
747 748

#define FF_BUFFER_TYPE_INTERNAL 1
diego's avatar
diego committed
749 750 751
#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
752

michaelni's avatar
michaelni committed
753

diego's avatar
diego committed
754 755 756 757
#define FF_I_TYPE  1 // Intra
#define FF_P_TYPE  2 // Predicted
#define FF_B_TYPE  3 // Bi-dir predicted
#define FF_S_TYPE  4 // S(GMC)-VOP MPEG4
michaelni's avatar
michaelni committed
758 759
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
760
#define FF_BI_TYPE 7
michaelni's avatar
michaelni committed
761

diego's avatar
diego committed
762 763 764 765
#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).
766

michaelni's avatar
michaelni committed
767 768
/**
 * Audio Video Frame.
769 770
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
 * bumps.
diego's avatar
diego committed
771
 * Removal, reordering and changes to existing fields require a major
772 773
 * version bump. No fields should be added into AVFrame before or after
 * FF_COMMON_FRAME!
diego's avatar
diego committed
774
 * sizeof(AVFrame) must not be used outside libav*.
michaelni's avatar
michaelni committed
775
 */
michaelni's avatar
michaelni committed
776 777 778
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
779

780
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
781 782

/**
783 784
 * main external API structure.
 * New fields can be added to the end with minor version bumps.
diego's avatar
diego committed
785
 * Removal, reordering and changes to existing fields require a major
786
 * version bump.
diego's avatar
diego committed
787
 * sizeof(AVCodecContext) must not be used outside libav*.
michaelni's avatar
doxy  
michaelni committed
788
 */
glantau's avatar
glantau committed
789
typedef struct AVCodecContext {
790
    /**
diego's avatar
diego committed
791
     * information on struct for av_log
792 793
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
794
    AVClass *av_class;
795
    /**
diego's avatar
diego committed
796 797 798
     * 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.
799
     */
glantau's avatar
glantau committed
800
    int bit_rate;
801 802

    /**
803
     * number of bits the bitstream is allowed to diverge from the reference.
804
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
diego's avatar
diego committed
805
     * - encoding: Set by user; unused for constant quantizer encoding.
806
     * - decoding: unused
807
     */
808
    int bit_rate_tolerance;
809 810

    /**
811
     * CODEC_FLAG_*.
diego's avatar
diego committed
812 813
     * - encoding: Set by user.
     * - decoding: Set by user.
814
     */
glantau's avatar
glantau committed
815
    int flags;
816 817

    /**
diego's avatar
diego committed
818 819 820 821 822 823
     * 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?)
824 825 826 827
     */
    int sub_id;

    /**
diego's avatar
diego committed
828
     * Motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
829 830
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
831 832
     * - encoding: MUST be set by user.
     * - decoding: unused
833 834 835 836
     */
    int me_method;

    /**
diego's avatar
diego committed
837 838
     * some codecs need / can use extradata like Huffman tables.
     * mjpeg: Huffman tables
839
     * rv10: additional flags
840
     * mpeg4: global headers (they can be in the bitstream or here)
diego's avatar
diego committed
841 842 843 844 845
     * 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.
846
     */
847
    uint8_t *extradata;
848
    int extradata_size;
849

850
    /**
diego's avatar
diego committed
851 852
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
853 854
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
diego's avatar
diego committed
855 856
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
857
     */
michael's avatar
michael committed
858
    AVRational time_base;
859

860
    /* video only */
861
    /**
862
     * picture width / height.
863
     * - encoding: MUST be set by user.
diego's avatar
diego committed
864 865 866
     * - decoding: Set by libavcodec.
     * Note: For compatibility it is possible to set this instead of
     * coded_width/height before decoding.
867
     */
glantau's avatar
glantau committed
868
    int width, height;
869

870
#define FF_ASPECT_EXTENDED 15
871 872

    /**
diego's avatar
diego committed
873 874
     * the number of pictures in a group of pictures, or 0 for intra_only
     * - encoding: Set by user.
875
     * - decoding: unused
876 877 878 879
     */
    int gop_size;

    /**
diego's avatar
diego committed
880 881 882
     * Pixel format, see PIX_FMT_xxx.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
883
     */
884
    enum PixelFormat pix_fmt;
885

886
    /**
diego's avatar
diego committed
887
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
888
     * has to read frames at native frame rate.
diego's avatar
diego committed
889 890
     * - encoding: Set by user.
     * - decoding: unused
891 892
     */
    int rate_emu;
893

894
    /**
diego's avatar
diego committed
895 896
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw a horizontal band. It improves cache usage. Not
897
     * all codecs can do that. You must check the codec capabilities
diego's avatar
diego committed
898
     * beforehand.
899
     * - encoding: unused
diego's avatar
diego committed
900
     * - decoding: Set by user.
901 902 903 904
     * @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
905
     */
glantau's avatar
glantau committed
906
    void (*draw_horiz_band)(struct AVCodecContext *s,
907
                            const AVFrame *src, int offset[4],
908
                            int y, int type, int height);
glantau's avatar
glantau committed
909

glantau's avatar
glantau committed
910
    /* audio only */
diego's avatar
diego committed
911
    int sample_rate; ///< samples per second
glantau's avatar
glantau committed
912
    int channels;
913 914

    /**
diego's avatar
diego committed
915 916 917
     * audio sample format
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
918
     */
diego's avatar
diego committed
919
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
glantau's avatar
glantau committed
920

diego's avatar
diego committed
921
    /* The following data should not be initialized. */
922
    /**
diego's avatar
diego committed
923
     * Samples per packet, initialized when calling 'init'.
924 925
     */
    int frame_size;
926
    int frame_number;   ///< audio or video frame number
diego's avatar
diego committed
927
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
928

929
    /**
diego's avatar
diego committed
930
     * Number of frames the decoded output will be delayed relative to
931
     * the encoded input.
diego's avatar
diego committed
932
     * - encoding: Set by libavcodec.
933
     * - decoding: unused
934 935
     */
    int delay;
936

937 938
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
939 940
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

941
    /**
diego's avatar
diego committed
942 943
     * minimum quantizer
     * - encoding: Set by user.
944
     * - decoding: unused
945 946 947 948
     */
    int qmin;

    /**
diego's avatar
diego committed
949 950
     * maximum quantizer
     * - encoding: Set by user.
951
     * - decoding: unused
952 953 954 955
     */
    int qmax;

    /**
diego's avatar
diego committed
956 957
     * maximum quantizer difference between frames
     * - encoding: Set by user.
958
     * - decoding: unused
959 960 961 962
     */
    int max_qdiff;

    /**
diego's avatar
diego committed
963 964 965
     * 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.
966
     * - decoding: unused
967 968 969 970
     */
    int max_b_frames;

    /**
diego's avatar
diego committed
971 972
     * qscale factor between IP and B-frames
     * - encoding: Set by user.
973
     * - decoding: unused
974 975
     */
    float b_quant_factor;
976

977 978
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
979 980
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
981
    int b_frame_strategy;
982

983
    /**
diego's avatar
diego committed
984
     * hurry up amount
985
     * - encoding: unused
diego's avatar
diego committed
986
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
takis's avatar
takis committed
987
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
988 989
     */
    int hurry_up;
990

glantau's avatar
glantau committed
991
    struct AVCodec *codec;
992

glantau's avatar
glantau committed
993 994
    void *priv_data;

995
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
michael's avatar
michael committed
996 997
    /* unused, FIXME remove*/
    int rtp_mode;
998
#endif
999

diego's avatar
diego committed
1000
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
diego's avatar
diego committed
1001
                            /* do its best to deliver a chunk with size     */
1002
                            /* below rtp_payload_size, the chunk will start */
diego's avatar
diego committed
1003
                            /* with a start code on some codecs like H.263. */
1004
                            /* This doesn't take account of any particular  */
diego's avatar
diego committed
1005
                            /* headers inside the transmitted RTP payload.  */
1006

1007

diego's avatar
diego committed
1008 1009 1010 1011 1012 1013
    /* 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.                  */
1014
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1015

michaelni's avatar
michaelni committed
1016 1017 1018 1019 1020 1021 1022 1023
    /* 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;
1024
    int misc_bits;
1025

1026
    /**
diego's avatar
diego committed
1027 1028
     * number of bits used for the previously encoded frame
     * - encoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1029
     * - decoding: unused
1030
     */
michaelni's avatar
michaelni committed
1031
    int frame_bits;
michaelni's avatar
michaelni committed
1032

1033
    /**
diego's avatar
diego committed
1034 1035 1036
     * Private data of the user, can be used to carry app specific stuff.
     * - encoding: Set by user.
     * - decoding: Set by user.
1037 1038 1039
     */
    void *opaque;

glantau's avatar
glantau committed
1040
    char codec_name[32];
1041 1042
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1043

michaelni's avatar
michaelni committed
1044 1045
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1046 1047 1048 1049 1050 1051
     * 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
1052
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
diego's avatar
diego committed
1053 1054 1055
     * 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
1056 1057
     */
    unsigned int codec_tag;
1058

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

1082
    /**
diego's avatar
diego committed
1083 1084
     * luma single coefficient elimination threshold
     * - encoding: Set by user.
1085
     * - decoding: unused
1086
     */
michaelni's avatar
 
michaelni committed
1087
    int luma_elim_threshold;
1088

1089
    /**
diego's avatar
diego committed
1090 1091
     * chroma single coeff elimination threshold
     * - encoding: Set by user.
1092
     * - decoding: unused
1093
     */
michaelni's avatar
 
michaelni committed
1094
    int chroma_elim_threshold;
1095

1096
    /**
diego's avatar
diego committed
1097 1098
     * strictly follow the standard (MPEG4, ...).
     * - encoding: Set by user.
1099
     * - decoding: unused
1100 1101
     */
    int strict_std_compliance;
diego's avatar
diego committed
1102 1103
#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.
1104
#define FF_COMPLIANCE_NORMAL        0
diego's avatar
diego committed
1105 1106
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1107

1108
    /**
diego's avatar
diego committed
1109 1110 1111 1112
     * qscale offset between IP and B-frames
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
     * - encoding: Set by user.
1113
     * - decoding: unused
1114 1115
     */
    float b_quant_offset;
1116

1117
    /**
diego's avatar
diego committed
1118 1119
     * Error resilience; higher values will detect more errors but may
     * misdetect some more or less valid parts as errors.
1120
     * - encoding: unused
diego's avatar
diego committed
1121
     * - decoding: Set by user.
1122
     */
michaelni's avatar
 
michaelni committed
1123
    int error_resilience;
diego's avatar
diego committed
1124
#define FF_ER_CAREFUL         1
1125 1126 1127
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1128

1129
    /**
diego's avatar
diego committed
1130 1131
     * 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
1132
     * avcodec_align_dimensions() should be used to find the required width and
diego's avatar
diego committed
1133
     * height, as they normally need to be rounded up to the next multiple of 16.
1134
     * - encoding: unused
diego's avatar
diego committed
1135
     * - decoding: Set by libavcodec., user can override.
1136
     */
michaelni's avatar
michaelni committed
1137
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1138

1139
    /**
diego's avatar
diego committed
1140 1141 1142
     * Called to release buffers which where allocated with get_buffer.
     * A released buffer can be reused in get_buffer().
     * pic.data[*] must be set to NULL.
1143
     * - encoding: unused
diego's avatar
diego committed
1144
     * - decoding: Set by libavcodec., user can override.
1145
     */
michaelni's avatar
michaelni committed
1146
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1147

1148
    /**
diego's avatar
diego committed
1149 1150 1151
     * If 1 the stream has a 1 frame delay during decoding.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
1152 1153
     */
    int has_b_frames;
1154 1155 1156

    /**
     * number of bytes per packet if constant and known or 0
diego's avatar
diego committed
1157
     * Used by some WAV based audio codecs.
1158 1159
     */
    int block_align;
1160

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

1165
    /**
diego's avatar
diego committed
1166 1167
     * 0-> h263 quant 1-> mpeg quant
     * - encoding: Set by user.
1168
     * - decoding: unused
1169 1170
     */
    int mpeg_quant;
1171

1172
    /**
diego's avatar
diego committed
1173 1174
     * pass1 encoding statistics output buffer
     * - encoding: Set by libavcodec.
1175
     * - decoding: unused
1176
     */
1177
    char *stats_out;
1178

1179
    /**
diego's avatar
diego committed
1180 1181 1182
     * pass2 encoding statistics input buffer
     * Concatenated stuff from stats_out of pass1 should be placed here.
     * - encoding: Allocated/set/freed by user.
1183
     * - decoding: unused
1184 1185
     */
    char *stats_in;
1186

1187
    /**
diego's avatar
diego committed
1188 1189 1190
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
     * - encoding: Set by user.
1191
     * - decoding: unused
1192
     */
michaelni's avatar
michaelni committed
1193
    float rc_qsquish;
1194

michaelni's avatar
michaelni committed
1195 1196
    float rc_qmod_amp;
    int rc_qmod_freq;
1197

1198
    /**
diego's avatar
diego committed
1199 1200
     * ratecontrol override, see RcOverride
     * - encoding: Allocated/set/freed by user.
1201
     * - decoding: unused
1202
     */
michaelni's avatar
michaelni committed
1203 1204
    RcOverride *rc_override;
    int rc_override_count;
1205

1206
    /**
diego's avatar
diego committed
1207 1208
     * rate control equation
     * - encoding: Set by user
1209
     * - decoding: unused
1210
     */
lucabe's avatar
Fix  
lucabe committed
1211
    const char *rc_eq;
1212

1213
    /**
diego's avatar
diego committed
1214 1215
     * maximum bitrate
     * - encoding: Set by user.
1216
     * - decoding: unused
1217
     */
michaelni's avatar
michaelni committed
1218
    int rc_max_rate;
1219

1220
    /**
diego's avatar
diego committed
1221 1222
     * minimum bitrate
     * - encoding: Set by user.
1223
     * - decoding: unused
1224
     */
michaelni's avatar
michaelni committed
1225
    int rc_min_rate;
1226

1227
    /**
diego's avatar
diego committed
1228 1229
     * decoder bitstream buffer size
     * - encoding: Set by user.
1230
     * - decoding: unused
1231
     */
michaelni's avatar
michaelni committed
1232 1233
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1234 1235

    /**
diego's avatar
diego committed
1236 1237 1238 1239
     * 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.
1240
     * - decoding: unused
1241 1242
     */
    float i_quant_factor;
1243

1244
    /**
diego's avatar
diego committed
1245 1246
     * qscale offset between P and I-frames
     * - encoding: Set by user.
1247
     * - decoding: unused
1248 1249
     */
    float i_quant_offset;
1250

1251
    /**
diego's avatar
diego committed
1252 1253
     * initial complexity for pass1 ratecontrol
     * - encoding: Set by user.
1254
     * - decoding: unused
1255
     */
michaelni's avatar
michaelni committed
1256
    float rc_initial_cplx;
1257

1258
    /**
diego's avatar
diego committed
1259 1260
     * DCT algorithm, see FF_DCT_* below
     * - encoding: Set by user.
1261
     * - decoding: unused
1262
     */
1263
    int dct_algo;
1264
#define FF_DCT_AUTO    0
1265
#define FF_DCT_FASTINT 1
1266 1267 1268
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1269
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1270
#define FF_DCT_FAAN    6
1271

1272
    /**
diego's avatar
diego committed
1273 1274
     * luminance masking (0-> disabled)
     * - encoding: Set by user.
1275
     * - decoding: unused
1276 1277
     */
    float lumi_masking;
1278

1279
    /**
diego's avatar
diego committed
1280 1281
     * temporary complexity masking (0-> disabled)
     * - encoding: Set by user.
1282
     * - decoding: unused
1283 1284
     */
    float temporal_cplx_masking;
1285

1286
    /**
diego's avatar
diego committed
1287 1288
     * spatial complexity masking (0-> disabled)
     * - encoding: Set by user.
1289
     * - decoding: unused
1290 1291
     */
    float spatial_cplx_masking;
1292

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

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


1308
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1309 1310
    /* for binary compatibility */
    int unused;
1311
#endif
1312

1313
    /**
diego's avatar
diego committed
1314 1315 1316
     * IDCT algorithm, see FF_IDCT_* below.
     * - encoding: Set by user.
     * - decoding: Set by user.
1317 1318
     */
    int idct_algo;
diego's avatar
diego committed
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
#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
1335
#define FF_IDCT_SIMPLEARMV5TE 16
diego's avatar
diego committed
1336
#define FF_IDCT_SIMPLEARMV6   17
1337
#define FF_IDCT_SIMPLEVIS     18
michael's avatar
michael committed
1338
#define FF_IDCT_WMV2          19
michael's avatar
michael committed
1339
#define FF_IDCT_FAAN          20
1340

1341
    /**
diego's avatar
diego committed
1342 1343 1344
     * slice count
     * - encoding: Set by libavcodec.
     * - decoding: Set by user (or 0).
1345 1346 1347
     */
    int slice_count;
    /**
diego's avatar
diego committed
1348 1349 1350
     * slice offsets in the frame in bytes
     * - encoding: Set/allocated by libavcodec.
     * - decoding: Set/allocated by user (or NULL).
1351 1352 1353
     */
    int *slice_offset;

1354
    /**
diego's avatar
diego committed
1355
     * error concealment flags
1356
     * - encoding: unused
diego's avatar
diego committed
1357
     * - decoding: Set by user.
1358 1359 1360 1361 1362
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1363
    /**
kabi's avatar
kabi committed
1364
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1365
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1366
     *
diego's avatar
diego committed
1367 1368 1369
     * 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
1370 1371
     */
    unsigned dsp_mask;
diego's avatar
diego committed
1372
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
kabi's avatar
kabi committed
1373
    /* lower 16 bits - CPU features */
michael's avatar
michael committed
1374 1375 1376 1377 1378 1379 1380 1381 1382
#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
1383 1384

    /**
1385
     * bits per sample/pixel from the demuxer (needed for huffyuv).
diego's avatar
diego committed
1386 1387
     * - encoding: Set by libavcodec.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1388 1389
     */
     int bits_per_sample;
1390

michaelni's avatar
michaelni committed
1391
    /**
diego's avatar
diego committed
1392 1393
     * prediction method (needed for huffyuv)
     * - encoding: Set by user.
1394
     * - decoding: unused
michaelni's avatar
michaelni committed
1395 1396 1397 1398 1399
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1400

michaelni's avatar
michaelni committed
1401
    /**
diego's avatar
diego committed
1402 1403 1404 1405
     * sample aspect ratio (0 if unknown)
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1406
     */
michael's avatar
michael committed
1407
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1408 1409

    /**
diego's avatar
diego committed
1410 1411 1412
     * the picture in the bitstream
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1413
     */
michaelni's avatar
michaelni committed
1414
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1415 1416

    /**
diego's avatar
diego committed
1417 1418 1419
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1420 1421
     */
    int debug;
diego's avatar
diego committed
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
#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
1436
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1437

1438
    /**
diego's avatar
diego committed
1439 1440 1441
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1442 1443 1444 1445 1446 1447
     */
    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

1448
    /**
diego's avatar
diego committed
1449 1450
     * error
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1451
     * - decoding: unused
1452 1453
     */
    uint64_t error[4];
1454

michaelni's avatar
michaelni committed
1455
    /**
diego's avatar
diego committed
1456
     * minimum MB quantizer
1457
     * - encoding: unused
1458
     * - decoding: unused
michaelni's avatar
michaelni committed
1459 1460 1461 1462
     */
    int mb_qmin;

    /**
diego's avatar
diego committed
1463
     * maximum MB quantizer
1464
     * - encoding: unused
1465
     * - decoding: unused
michaelni's avatar
michaelni committed
1466 1467
     */
    int mb_qmax;
1468

michaelni's avatar
michaelni committed
1469
    /**
diego's avatar
diego committed
1470 1471
     * motion estimation comparison function
     * - encoding: Set by user.
1472
     * - decoding: unused
michaelni's avatar
michaelni committed
1473 1474 1475
     */
    int me_cmp;
    /**
diego's avatar
diego committed
1476 1477
     * subpixel motion estimation comparison function
     * - encoding: Set by user.
1478
     * - decoding: unused
michaelni's avatar
michaelni committed
1479 1480 1481
     */
    int me_sub_cmp;
    /**
diego's avatar
diego committed
1482 1483
     * macroblock comparison function (not supported yet)
     * - encoding: Set by user.
1484
     * - decoding: unused
michaelni's avatar
michaelni committed
1485 1486
     */
    int mb_cmp;
michael's avatar
michael committed
1487
    /**
diego's avatar
diego committed
1488 1489
     * interlaced DCT comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1490 1491 1492
     * - decoding: unused
     */
    int ildct_cmp;
diego's avatar
diego committed
1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505
#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
1506
#define FF_CMP_DCTMAX 13
1507
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1508
#define FF_CMP_CHROMA 256
1509

michaelni's avatar
michaelni committed
1510
    /**
diego's avatar
diego committed
1511 1512
     * ME diamond size & shape
     * - encoding: Set by user.
1513
     * - decoding: unused
michaelni's avatar
michaelni committed
1514 1515
     */
    int dia_size;
michaelni's avatar
michaelni committed
1516 1517

    /**
diego's avatar
diego committed
1518 1519
     * amount of previous MV predictors (2a+1 x 2a+1 square)
     * - encoding: Set by user.
1520
     * - decoding: unused
michaelni's avatar
michaelni committed
1521 1522
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1523

michaelni's avatar
michaelni committed
1524
    /**
diego's avatar
diego committed
1525 1526
     * prepass for motion estimation
     * - encoding: Set by user.
1527
     * - decoding: unused
michaelni's avatar
michaelni committed
1528 1529
     */
    int pre_me;
michaelni's avatar
michaelni committed
1530

michaelni's avatar
michaelni committed
1531
    /**
diego's avatar
diego committed
1532 1533
     * motion estimation prepass comparison function
     * - encoding: Set by user.
1534
     * - decoding: unused
michaelni's avatar
michaelni committed
1535 1536
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1537

michaelni's avatar
michaelni committed
1538
    /**
diego's avatar
diego committed
1539 1540
     * ME prepass diamond size & shape
     * - encoding: Set by user.
1541
     * - decoding: unused
michaelni's avatar
michaelni committed
1542 1543 1544
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1545
    /**
diego's avatar
diego committed
1546 1547
     * subpel ME quality
     * - encoding: Set by user.
1548
     * - decoding: unused
michaelni's avatar
michaelni committed
1549 1550 1551
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1552
    /**
diego's avatar
diego committed
1553
     * callback to negotiate the pixelFormat
michaelni's avatar
michaelni committed
1554
     * @param fmt is the list of formats which are supported by the codec,
diego's avatar
diego committed
1555 1556 1557
     * 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
1558
     * - encoding: unused
diego's avatar
diego committed
1559
     * - decoding: Set by user, if not set the native format will be chosen.
michaelni's avatar
michaelni committed
1560
     */
iive's avatar
iive committed
1561
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1562 1563

    /**
diego's avatar
diego committed
1564 1565 1566
     * DTG active format information (additional aspect ratio
     * information only used in DVB MPEG-2 transport streams)
     * 0 if not set.
1567
     *
diego's avatar
diego committed
1568 1569
     * - encoding: unused
     * - decoding: Set by decoder.
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
     */
    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

1580
    /**
diego's avatar
diego committed
1581 1582
     * maximum motion estimation search range in subpel units
     * If 0 then no limit.
1583
     *
diego's avatar
diego committed
1584 1585
     * - encoding: Set by user.
     * - decoding: unused
1586
     */
kabi's avatar
kabi committed
1587
    int me_range;
1588

michaelni's avatar
michaelni committed
1589
    /**
diego's avatar
diego committed
1590 1591
     * intra quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1592 1593 1594 1595
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1596

michaelni's avatar
michaelni committed
1597
    /**
diego's avatar
diego committed
1598 1599
     * inter quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1600 1601 1602
     * - decoding: unused
     */
    int inter_quant_bias;
1603 1604

    /**
diego's avatar
diego committed
1605 1606 1607 1608
     * color table ID
     * - encoding: unused
     * - decoding: Which clrtable should be used for 8bit RGB images.
     *             Tables have to be stored somewhere. FIXME
1609 1610
     */
    int color_table_id;
1611

1612
    /**
diego's avatar
diego committed
1613 1614
     * internal_buffer count
     * Don't touch, used by libavcodec default_get_buffer().
1615 1616
     */
    int internal_buffer_count;
1617

1618
    /**
diego's avatar
diego committed
1619 1620
     * internal_buffers
     * Don't touch, used by libavcodec default_get_buffer().
1621 1622
     */
    void *internal_buffer;
1623 1624 1625 1626 1627 1628 1629

#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
1630
    /**
diego's avatar
diego committed
1631 1632 1633
     * 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
1634 1635 1636
     * - decoding: unused
     */
    int global_quality;
1637

michael's avatar
michael committed
1638 1639
#define FF_CODER_TYPE_VLC       0
#define FF_CODER_TYPE_AC        1
1640 1641 1642
#define FF_CODER_TYPE_RAW       2
#define FF_CODER_TYPE_RLE       3
#define FF_CODER_TYPE_DEFLATE   4
michaelni's avatar
michaelni committed
1643 1644
    /**
     * coder type
diego's avatar
diego committed
1645
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1646 1647 1648 1649 1650 1651
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
diego's avatar
diego committed
1652
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1653 1654 1655
     * - decoding: unused
     */
    int context_model;
1656 1657 1658 1659
#if 0
    /**
     *
     * - encoding: unused
diego's avatar
diego committed
1660
     * - decoding: Set by user.
1661 1662 1663
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1664

1665 1666 1667
    /**
     * slice flags
     * - encoding: unused
diego's avatar
diego committed
1668
     * - decoding: Set by user.
1669 1670 1671 1672 1673 1674
     */
    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
1675 1676 1677 1678 1679 1680
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1681

1682 1683
    /**
     * macroblock decision mode
diego's avatar
diego committed
1684
     * - encoding: Set by user.
1685 1686 1687 1688 1689 1690
     * - decoding: unused
     */
    int mb_decision;
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
#define FF_MB_DECISION_RD     2        ///< rate distoration
1691 1692 1693

    /**
     * custom intra quantization matrix
diego's avatar
diego committed
1694 1695
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1696 1697 1698 1699 1700
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
diego's avatar
diego committed
1701 1702
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1703 1704
     */
    uint16_t *inter_matrix;
1705

1706 1707
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1708
     * This is used to work around some encoder bugs.
1709
     * - encoding: unused
diego's avatar
diego committed
1710
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1711 1712
     */
    unsigned int stream_codec_tag;
michaelni's avatar
michaelni committed
1713 1714

    /**
diego's avatar
diego committed
1715 1716 1717
     * scene change detection threshold
     * 0 is default, larger means fewer detected scene changes.
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1718 1719 1720
     * - decoding: unused
     */
    int scenechange_threshold;
1721 1722

    /**
diego's avatar
diego committed
1723 1724
     * minimum Lagrange multipler
     * - encoding: Set by user.
1725 1726 1727 1728 1729
     * - decoding: unused
     */
    int lmin;

    /**
diego's avatar
diego committed
1730 1731
     * maximum Lagrange multipler
     * - encoding: Set by user.
1732 1733 1734
     * - decoding: unused
     */
    int lmax;
1735 1736

    /**
diego's avatar
diego committed
1737
     * palette control structure
1738
     * - encoding: ??? (no palette-enabled encoder yet)
diego's avatar
diego committed
1739
     * - decoding: Set by user.
1740 1741
     */
    struct AVPaletteControl *palctrl;
1742 1743 1744

    /**
     * noise reduction strength
diego's avatar
diego committed
1745
     * - encoding: Set by user.
1746 1747 1748
     * - decoding: unused
     */
    int noise_reduction;
1749

1750
    /**
diego's avatar
diego committed
1751 1752 1753
     * 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
1754
     * same buffer or new buffer with old frame "painted" into it.
diego's avatar
diego committed
1755
     * If pic.data[0] == NULL must behave like get_buffer().
1756
     * - encoding: unused
diego's avatar
diego committed
1757
     * - decoding: Set by libavcodec., user can override
1758
     */
1759
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1760 1761

    /**
diego's avatar
diego committed
1762 1763
     * Number of bits which should be loaded into the rc buffer before decoding starts.
     * - encoding: Set by user.
michael's avatar
michael committed
1764 1765 1766 1767 1768 1769
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
diego's avatar
diego committed
1770
     * - encoding: Set by user.
michael's avatar
michael committed
1771 1772 1773 1774 1775
     * - decoding: unused
     */
    int inter_threshold;

    /**
diego's avatar
diego committed
1776 1777 1778
     * CODEC_FLAG2_*
     * - encoding: Set by user.
     * - decoding: Set by user.
michael's avatar
michael committed
1779 1780
     */
    int flags2;
michael's avatar
michael committed
1781 1782

    /**
diego's avatar
diego committed
1783 1784 1785
     * Simulates errors in the bitstream to test error concealment.
     * - encoding: Set by user.
     * - decoding: unused
michael's avatar
michael committed
1786 1787
     */
    int error_rate;
1788

1789 1790 1791
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
diego's avatar
diego committed
1792
     * - decoding: Set by user.
1793 1794 1795 1796 1797 1798
     */
    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
1799
    /**
diego's avatar
diego committed
1800 1801
     * quantizer noise shaping
     * - encoding: Set by user.
michael's avatar
michael committed
1802 1803 1804
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1805 1806

    /**
diego's avatar
diego committed
1807
     * thread count
1808
     * is used to decide how many independent tasks should be passed to execute()
diego's avatar
diego committed
1809 1810
     * - encoding: Set by user.
     * - decoding: Set by user.
1811 1812
     */
    int thread_count;
1813

1814
    /**
diego's avatar
diego committed
1815 1816 1817 1818
     * 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
1819
     * @param count the number of things to execute
diego's avatar
diego committed
1820 1821
     * - encoding: Set by libavcodec, user can override.
     * - decoding: Set by libavcodec, user can override.
1822 1823
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1824

1825
    /**
diego's avatar
diego committed
1826 1827
     * thread opaque
     * Can be used by execute() to store some per AVCodecContext stuff.
1828 1829 1830 1831
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1832 1833

    /**
diego's avatar
diego committed
1834 1835
     * Motion estimation threshold below which no motion estimation is
     * performed, but instead the user specified motion vectors are used.
1836
     *
diego's avatar
diego committed
1837
     * - encoding: Set by user.
1838
     * - decoding: unused
1839
     */
michael's avatar
michael committed
1840
     int me_threshold;
1841 1842

    /**
diego's avatar
diego committed
1843 1844
     * Macroblock threshold below which the user specified macroblock types will be used.
     * - encoding: Set by user.
1845 1846 1847
     * - decoding: unused
     */
     int mb_threshold;
1848 1849

    /**
diego's avatar
diego committed
1850 1851
     * precision of the intra DC coefficient - 8
     * - encoding: Set by user.
1852 1853 1854
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1855 1856

    /**
diego's avatar
diego committed
1857 1858
     * noise vs. sse weight for the nsse comparsion function
     * - encoding: Set by user.
michael's avatar
michael committed
1859 1860 1861
     * - decoding: unused
     */
     int nsse_weight;
1862 1863

    /**
diego's avatar
diego committed
1864
     * Number of macroblock rows at the top which are skipped.
1865
     * - encoding: unused
diego's avatar
diego committed
1866
     * - decoding: Set by user.
1867 1868 1869 1870
     */
     int skip_top;

    /**
diego's avatar
diego committed
1871
     * Number of macroblock rows at the bottom which are skipped.
1872
     * - encoding: unused
diego's avatar
diego committed
1873
     * - decoding: Set by user.
1874 1875
     */
     int skip_bottom;
michael's avatar
michael committed
1876 1877 1878

    /**
     * profile
diego's avatar
diego committed
1879 1880
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1881 1882 1883
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99
benoit's avatar
 
benoit committed
1884
#define FF_PROFILE_AAC_MAIN 0
diego's avatar
diego committed
1885 1886 1887
#define FF_PROFILE_AAC_LOW  1
#define FF_PROFILE_AAC_SSR  2
#define FF_PROFILE_AAC_LTP  3
michael's avatar
michael committed
1888 1889 1890

    /**
     * level
diego's avatar
diego committed
1891 1892
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1893 1894 1895
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1896 1897

    /**
diego's avatar
diego committed
1898
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
michael's avatar
michael committed
1899
     * - encoding: unused
diego's avatar
diego committed
1900
     * - decoding: Set by user.
michael's avatar
michael committed
1901 1902
     */
     int lowres;
1903 1904

    /**
diego's avatar
diego committed
1905 1906
     * Bitstream width / height, may be different from width/height if lowres
     * or other things are used.
1907
     * - encoding: unused
diego's avatar
diego committed
1908
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1909 1910
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1911 1912 1913

    /**
     * frame skip threshold
diego's avatar
diego committed
1914
     * - encoding: Set by user.
michael's avatar
michael committed
1915 1916 1917 1918 1919 1920
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
diego's avatar
diego committed
1921
     * - encoding: Set by user.
michael's avatar
michael committed
1922 1923 1924
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1925 1926 1927

    /**
     * frame skip exponent
diego's avatar
diego committed
1928
     * - encoding: Set by user.
michael's avatar
michael committed
1929 1930 1931 1932 1933
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
diego's avatar
diego committed
1934 1935
     * frame skip comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1936 1937 1938
     * - decoding: unused
     */
    int frame_skip_cmp;
1939 1940

    /**
diego's avatar
diego committed
1941
     * Border processing masking, raises the quantizer for mbs on the borders
1942
     * of the picture.
diego's avatar
diego committed
1943
     * - encoding: Set by user.
1944 1945 1946
     * - decoding: unused
     */
    float border_masking;
1947 1948

    /**
diego's avatar
diego committed
1949 1950
     * minimum MB lagrange multipler
     * - encoding: Set by user.
1951 1952 1953 1954 1955
     * - decoding: unused
     */
    int mb_lmin;

    /**
diego's avatar
diego committed
1956 1957
     * maximum MB lagrange multipler
     * - encoding: Set by user.
1958 1959 1960
     * - decoding: unused
     */
    int mb_lmax;
1961 1962

    /**
1963
     *
diego's avatar
diego committed
1964
     * - encoding: Set by user.
1965 1966 1967
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1968 1969

    /**
1970
     *
michael's avatar
michael committed
1971
     * - encoding: unused
diego's avatar
diego committed
1972
     * - decoding: Set by user.
michael's avatar
michael committed
1973 1974 1975 1976
     */
    enum AVDiscard skip_loop_filter;

    /**
1977
     *
michael's avatar
michael committed
1978
     * - encoding: unused
diego's avatar
diego committed
1979
     * - decoding: Set by user.
michael's avatar
michael committed
1980 1981 1982 1983
     */
    enum AVDiscard skip_idct;

    /**
1984
     *
michael's avatar
michael committed
1985
     * - encoding: unused
diego's avatar
diego committed
1986
     * - decoding: Set by user.
michael's avatar
michael committed
1987 1988
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
1989 1990 1991

    /**
     *
diego's avatar
diego committed
1992
     * - encoding: Set by user.
michael's avatar
michael committed
1993 1994 1995
     * - decoding: unused
     */
    int bidir_refine;
1996 1997 1998

    /**
     *
diego's avatar
diego committed
1999
     * - encoding: Set by user.
2000 2001 2002
     * - decoding: unused
     */
    int brd_scale;
lorenm's avatar
lorenm committed
2003 2004 2005

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
diego's avatar
diego committed
2006
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2007 2008
     * - decoding: unused
     */
lu_zero's avatar
lu_zero committed
2009
    float crf;
lorenm's avatar
lorenm committed
2010 2011 2012

    /**
     * constant quantization parameter rate control method
diego's avatar
diego committed
2013
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2014 2015 2016 2017 2018
     * - decoding: unused
     */
    int cqp;

    /**
diego's avatar
diego committed
2019 2020
     * minimum GOP size
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2021 2022 2023 2024 2025 2026
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
diego's avatar
diego committed
2027
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2028 2029 2030 2031 2032 2033
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
diego's avatar
diego committed
2034
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2035 2036 2037 2038 2039
     * - decoding: unused
     */
    int chromaoffset;

    /**
diego's avatar
diego committed
2040 2041
     * Influences how often B-frames are used.
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2042 2043 2044 2045 2046 2047
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
diego's avatar
diego committed
2048
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2049 2050 2051 2052 2053
     * - decoding: unused
     */
    int trellis;

    /**
diego's avatar
diego committed
2054 2055
     * Reduce fluctuations in qp (before curve compression).
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2056 2057 2058 2059 2060 2061 2062
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
diego's avatar
diego committed
2063
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2064 2065 2066 2067 2068 2069 2070
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
diego's avatar
diego committed
2071
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2072 2073 2074 2075 2076 2077
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
diego's avatar
diego committed
2078
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2079 2080 2081
     * - decoding: unused
     */
    int partitions;
2082 2083 2084 2085 2086
#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
2087 2088

    /**
diego's avatar
diego committed
2089 2090
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2091 2092 2093
     * - decoding: unused
     */
    int directpred;
2094

2095
    /**
2096
     * Audio cutoff bandwidth (0 means "automatic")
diego's avatar
diego committed
2097
     * - encoding: Set by user.
2098 2099 2100
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
2101 2102

    /**
diego's avatar
diego committed
2103 2104
     * Multiplied by qscale for each frame and added to scene_change_score.
     * - encoding: Set by user.
corey's avatar
corey committed
2105 2106 2107
     * - decoding: unused
     */
    int scenechange_factor;
2108 2109 2110

    /**
     *
diego's avatar
diego committed
2111 2112
     * Note: Value depends upon the compare function used for fullpel ME.
     * - encoding: Set by user.
2113 2114 2115
     * - decoding: unused
     */
    int mv0_threshold;
2116 2117

    /**
diego's avatar
diego committed
2118 2119
     * Adjusts sensitivity of b_frame_strategy 1.
     * - encoding: Set by user.
2120 2121 2122
     * - decoding: unused
     */
    int b_sensitivity;
2123 2124

    /**
diego's avatar
diego committed
2125
     * - encoding: Set by user.
2126 2127 2128 2129 2130 2131
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
diego's avatar
diego committed
2132 2133 2134
     * Sets whether to use LPC mode - used by FLAC encoder.
     * - encoding: Set by user.
     * - decoding: unused
2135 2136 2137 2138 2139
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
diego's avatar
diego committed
2140 2141
     * - encoding: Set by user.
     * - decoding: unused
2142 2143 2144 2145
     */
    int lpc_coeff_precision;

    /**
diego's avatar
diego committed
2146 2147
     * - encoding: Set by user.
     * - decoding: unused
2148 2149 2150 2151
     */
    int min_prediction_order;

    /**
diego's avatar
diego committed
2152 2153
     * - encoding: Set by user.
     * - decoding: unused
2154 2155 2156 2157 2158
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
diego's avatar
diego committed
2159 2160
     * - encoding: Set by user.
     * - decoding: unused
2161 2162 2163 2164
     */
    int prediction_order_method;

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

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

    /**
     * GOP timecode frame start number, in non drop frame format
diego's avatar
diego committed
2178 2179
     * - encoding: Set by user.
     * - decoding: unused
2180 2181
     */
    int64_t timecode_frame_start;
2182 2183 2184 2185 2186 2187 2188

    /**
     * Decoder should decode to this many channels if it can (0 for default)
     * - encoding: unused
     * - decoding: Set by user.
     */
    int request_channels;
2189 2190 2191 2192 2193 2194 2195 2196

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

2199 2200 2201
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
2202
typedef struct AVCodec {
benoit's avatar
benoit committed
2203 2204 2205 2206 2207 2208
    /**
     * 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
2209
    const char *name;
kabi's avatar
kabi committed
2210
    enum CodecType type;
michael's avatar
michael committed
2211
    enum CodecID id;
glantau's avatar
glantau committed
2212 2213
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
2214
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
2215
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
2216
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2217
                  const uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
2218
    int capabilities;
glantau's avatar
glantau committed
2219
    struct AVCodec *next;
michaelni's avatar
michaelni committed
2220
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
2221
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
2222
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
2223 2224
} AVCodec;

kabi's avatar
kabi committed
2225
/**
2226 2227 2228
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
2229
typedef struct AVPicture {
kabi's avatar
kabi committed
2230
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2231
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2232 2233
} AVPicture;

tmmm's avatar
tmmm committed
2234 2235 2236 2237
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
benoit's avatar
 
benoit committed
2238 2239 2240
 *
 * @deprecated Use AVPacket to send palette changes instead.
 * This is totally broken.
tmmm's avatar
tmmm committed
2241
 */
2242
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2243
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2244 2245
typedef struct AVPaletteControl {

diego's avatar
diego committed
2246 2247
    /* Demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0. */
tmmm's avatar
tmmm committed
2248 2249
    int palette_changed;

2250 2251
    /* 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
2252 2253
     * the palette data comes from an IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled. */
2254
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2255

2256
} AVPaletteControl attribute_deprecated;
tmmm's avatar
tmmm committed
2257

2258
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2259 2260 2261 2262 2263 2264 2265 2266
    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;
2267 2268 2269 2270 2271 2272 2273 2274
} 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
2275 2276 2277
} AVSubtitle;


glantau's avatar
glantau committed
2278 2279 2280
/* resample.c */

struct ReSampleContext;
2281
struct AVResampleContext;
glantau's avatar
glantau committed
2282 2283 2284

typedef struct ReSampleContext ReSampleContext;

2285
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2286 2287 2288 2289
                                     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
2290
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2291
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
2292
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2293
void av_resample_close(struct AVResampleContext *c);
2294

2295
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
glantau's avatar
glantau committed
2296 2297
/* YUV420 format is assumed ! */

benoit's avatar
 
benoit committed
2298 2299 2300
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2301
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
glantau's avatar
glantau committed
2302

benoit's avatar
 
benoit committed
2303 2304 2305
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2306
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
glantau's avatar
glantau committed
2307
                                      int input_width, int input_height);
2308

benoit's avatar
 
benoit committed
2309 2310 2311
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2312
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2313 2314
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2315 2316 2317 2318
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

benoit's avatar
 
benoit committed
2319 2320 2321
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2322
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2323
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2324

benoit's avatar
 
benoit committed
2325 2326 2327
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2328
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2329 2330

#endif
glantau's avatar
glantau committed
2331

michael's avatar
michael committed
2332 2333 2334
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
diego's avatar
diego committed
2335 2336 2337 2338 2339
 * @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
2340 2341 2342
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2343 2344 2345
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
diego's avatar
diego committed
2346
 * @param picture the AVPicture to be freed
2347
 */
michael's avatar
michael committed
2348 2349
void avpicture_free(AVPicture *picture);

2350
/**
diego's avatar
diego committed
2351
 * Fill in the AVPicture fields.
2352 2353 2354 2355 2356 2357 2358
 * 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
2359
 * @param picture AVPicture whose fields are to be filled in
2360
 * @param ptr Buffer which will contain or contains the actual image data
diego's avatar
diego committed
2361 2362 2363 2364
 * @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
2365
 */
kabi's avatar
kabi committed
2366
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2367
                   int pix_fmt, int width, int height);
2368
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2369
                     unsigned char *dest, int dest_size);
2370 2371 2372 2373 2374

/**
 * 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
2375 2376 2377
 * @param pix_fmt the given picture format
 * @param width the width of the image
 * @param height the height of the image
2378 2379
 * @return Image data size in bytes
 */
2380
int avpicture_get_size(int pix_fmt, int width, int height);
2381 2382
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);
2383
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2384
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2385
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2386

2387 2388 2389 2390 2391 2392
#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) */
2393

2394
/**
2395 2396 2397 2398 2399 2400 2401 2402
 * 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
2403 2404
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 * which will occur when converting from one pixel format to another.
2405
 *
diego's avatar
diego committed
2406 2407
 * @param[in] dst_pix_fmt destination pixel format
 * @param[in] src_pix_fmt source pixel format
2408 2409
 * @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.
2410
 */
2411 2412
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2413 2414

/**
2415 2416 2417 2418 2419
 * 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
2420 2421
 * 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
2422 2423 2424 2425 2426 2427 2428 2429
 * \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
2430 2431
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 * @param[in] src_pix_fmt source pixel format
2432 2433 2434
 * @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.
2435
 */
2436 2437 2438
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

benoit's avatar
 
benoit committed
2439 2440 2441 2442 2443

/**
 * Print in buf the string corresponding to the pixel format with
 * number pix_fmt, or an header if pix_fmt is negative.
 *
2444 2445 2446
 * @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
2447 2448 2449 2450 2451
 * 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
2452 2453
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2454 2455 2456 2457 2458

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

2462
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2463 2464 2465 2466
/**
 * convert among pixel formats
 * @deprecated Use the software scaler (swscale) instead.
 */
2467
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2468
                const AVPicture *src, int pix_fmt,
2469
                int width, int height);
2470
#endif
2471 2472

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

/* external high level API */

michael's avatar
michael committed
2479
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
glantau's avatar
glantau committed
2480
extern AVCodec *first_avcodec;
michael's avatar
michael committed
2481 2482
#endif
AVCodec *av_codec_next(AVCodec *c);
glantau's avatar
glantau committed
2483

nickols_k's avatar
nickols_k committed
2484
/* returns LIBAVCODEC_VERSION_INT constant */
2485
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2486
/* returns LIBAVCODEC_BUILD constant */
2487
unsigned avcodec_build(void);
takis's avatar
takis committed
2488 2489 2490 2491 2492 2493 2494

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

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

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

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

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

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

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

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

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

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

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

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

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

takis's avatar
takis committed
2623 2624 2625
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
michael's avatar
michael committed
2626 2627
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
2628
                         const uint8_t *buf, int buf_size);
takis's avatar
takis committed
2629

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

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

diego's avatar
diego committed
2705 2706 2707
/* 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
2708 2709 2710
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2711
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2712
                        int *data_size_ptr,
kabi's avatar
kabi committed
2713
                        uint8_t *buf, int buf_size);
takis's avatar
takis committed
2714 2715 2716

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

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

int avcodec_close(AVCodecContext *avctx);

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

2760 2761 2762
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
michaelni's avatar
michaelni committed
2763 2764
void avcodec_flush_buffers(AVCodecContext *avctx);

2765 2766
void avcodec_default_free_buffers(AVCodecContext *s);

takis's avatar
takis committed
2767
/* misc useful functions */
michaelni's avatar
michaelni committed
2768 2769

/**
2770 2771
 * Returns a single letter to describe the given picture type \p pict_type.
 *
diego's avatar
diego committed
2772
 * @param[in] pict_type the picture type
2773
 * @return A single character representing the picture type.
michaelni's avatar
michaelni committed
2774 2775 2776
 */
char av_get_pict_type_char(int pict_type);

2777
/**
2778 2779
 * Returns codec bits per sample.
 *
diego's avatar
diego committed
2780
 * @param[in] codec_id the codec
2781
 * @return Number of bits per sample or zero if unknown for the given codec.
2782 2783
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2784

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

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

michael's avatar
michael committed
2818 2819
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
benoit's avatar
 
benoit committed
2820 2821 2822

    int64_t offset;      ///< byte offset from starting packet start
    int64_t last_offset;
bellard's avatar
bellard committed
2823 2824 2825
} AVCodecParserContext;

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

michael's avatar
michael committed
2838
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
bellard's avatar
bellard committed
2839
extern AVCodecParser *av_first_parser;
michael's avatar
michael committed
2840 2841
#endif
AVCodecParser *av_parser_next(AVCodecParser *c);
bellard's avatar
bellard committed
2842 2843 2844

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2845
int av_parser_parse(AVCodecParserContext *s,
bellard's avatar
bellard committed
2846
                    AVCodecContext *avctx,
2847
                    uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2848 2849
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2850 2851
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2852
                     uint8_t **poutbuf, int *poutbuf_size,
2853
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2854 2855
void av_parser_close(AVCodecParserContext *s);

2856 2857

typedef struct AVBitStreamFilterContext {
michael's avatar
michael committed
2858
    void *priv_data;
2859 2860 2861 2862 2863 2864 2865 2866
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
michael's avatar
michael committed
2867
    int priv_data_size;
2868 2869 2870 2871
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
2872
    void (*close)(AVBitStreamFilterContext *bsfc);
2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883
    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
2884
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2885

bellard's avatar
bellard committed
2886
/* memory */
2887 2888

/**
2889 2890 2891 2892
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
2893
 */
kabi's avatar
kabi committed
2894
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2895

2896
/* for static data only */
2897 2898

/**
diego's avatar
diego committed
2899
 * Frees all static arrays and resets their pointers to 0.
2900
 * Call this function to release all statically allocated tables.
benoit's avatar
 
benoit committed
2901
 *
diego's avatar
diego committed
2902
 * @deprecated. Code which uses av_free_static is broken/misdesigned
benoit's avatar
 
benoit committed
2903 2904
 * and should correctly use static arrays
 *
2905
 */
michael's avatar
michael committed
2906
attribute_deprecated void av_free_static(void);
2907 2908

/**
2909 2910 2911 2912 2913
 * Allocation of static arrays.
 *
 * @warning Do not use for normal allocation.
 *
 * @param[in] size The amount of memory you need in bytes.
diego's avatar
diego committed
2914
 * @return block of memory of the requested size
diego's avatar
diego committed
2915
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
benoit's avatar
 
benoit committed
2916
 * and should correctly use static arrays
2917
 */
michael's avatar
michael committed
2918
attribute_deprecated void *av_mallocz_static(unsigned int size);
2919

2920 2921 2922
/**
 * Copy image 'src' to 'dst'.
 */
2923
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2924 2925
              int pix_fmt, int width, int height);

2926
/**
diego's avatar
diego committed
2927
 * Crop image top and left side.
2928
 */
2929
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2930 2931
             int pix_fmt, int top_band, int left_band);

2932
/**
diego's avatar
diego committed
2933
 * Pad image.
2934
 */
2935
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2936 2937
            int padtop, int padbottom, int padleft, int padright, int *color);

2938
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2939 2940 2941
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2942 2943 2944
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

benoit's avatar
 
benoit committed
2945 2946 2947
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2948 2949 2950
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

benoit's avatar
 
benoit committed
2951 2952 2953
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2954 2955 2956 2957
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
            int padtop, int padbottom, int padleft, int padright, int *color);
#endif

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

2960 2961 2962
/**
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
 *
diego's avatar
diego committed
2963
 * @return 0 in case of a successful parsing, a negative value otherwise
2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975
 * @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
2976
 * @return 0 in case of a successful parsing, a negative value otherwise
2977 2978 2979 2980 2981 2982 2983
 * @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);

2984 2985
/* error handling */
#if EINVAL > 0
diego's avatar
diego committed
2986 2987
#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. */
2988
#else
diego's avatar
diego committed
2989
/* Some platforms have E* and errno already negated. */
2990 2991 2992 2993
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
diego's avatar
diego committed
2994 2995
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2996 2997 2998
#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
2999
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
benoit's avatar
 
benoit committed
3000
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
ramiro's avatar
ramiro committed
3001
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3002

3003
#endif /* FFMPEG_AVCODEC_H */