avcodec.h 89.5 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
 */

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

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 "avutil.h"
kabi's avatar
kabi committed
31
#include <sys/types.h> /* size_t */
glantau's avatar
glantau committed
32

33
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
bellard's avatar
bellard committed
34
#define AV_TOSTRING(s) #s
michael's avatar
michael committed
35

conrad's avatar
conrad committed
36 37
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(41<<8)+0)
#define LIBAVCODEC_VERSION      51.41.0
38
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
michael's avatar
michael committed
39

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

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

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

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

diego's avatar
diego committed
190
    /* various ADPCM codecs */
191
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
192
    CODEC_ID_ADPCM_IMA_WAV,
193 194
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
195
    CODEC_ID_ADPCM_IMA_WS,
196
    CODEC_ID_ADPCM_IMA_SMJPEG,
197
    CODEC_ID_ADPCM_MS,
tmmm's avatar
tmmm committed
198
    CODEC_ID_ADPCM_4XM,
199 200
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
201
    CODEC_ID_ADPCM_EA,
romansh's avatar
 
romansh committed
202
    CODEC_ID_ADPCM_G726,
203
    CODEC_ID_ADPCM_CT,
204
    CODEC_ID_ADPCM_SWF,
205
    CODEC_ID_ADPCM_YAMAHA,
206 207 208
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
209
    CODEC_ID_ADPCM_THP,
210

211 212
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
213 214
    CODEC_ID_AMR_WB,

215
    /* RealAudio codecs*/
216
    CODEC_ID_RA_144= 0x13000,
217
    CODEC_ID_RA_288,
218 219

    /* various DPCM codecs */
220
    CODEC_ID_ROQ_DPCM= 0x14000,
221
    CODEC_ID_INTERPLAY_DPCM,
222
    CODEC_ID_XAN_DPCM,
223
    CODEC_ID_SOL_DPCM,
224

225
    CODEC_ID_MP2= 0x15000,
diego's avatar
diego committed
226
    CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
227
    CODEC_ID_AAC,
228
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
229
    CODEC_ID_MPEG4AAC,
230
#endif
231 232 233 234 235 236 237 238 239 240 241
    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
242
    CODEC_ID_FLAC,
rtognimp's avatar
rtognimp committed
243
    CODEC_ID_MP3ADU,
244
    CODEC_ID_MP3ON4,
245
    CODEC_ID_SHORTEN,
michael's avatar
michael committed
246
    CODEC_ID_ALAC,
247
    CODEC_ID_WESTWOOD_SND1,
diego's avatar
diego committed
248
    CODEC_ID_GSM, /* as in Berlin toast format */
rtognimp's avatar
rtognimp committed
249
    CODEC_ID_QDM2,
250
    CODEC_ID_COOK,
251
    CODEC_ID_TRUESPEECH,
252
    CODEC_ID_TTA,
kostya's avatar
kostya committed
253
    CODEC_ID_SMACKAUDIO,
banan's avatar
banan committed
254
    CODEC_ID_QCELP,
kostya's avatar
kostya committed
255
    CODEC_ID_WAVPACK,
256
    CODEC_ID_DSICINAUDIO,
kostya's avatar
kostya committed
257
    CODEC_ID_IMC,
kostya's avatar
kostya committed
258
    CODEC_ID_MUSEPACK7,
259
    CODEC_ID_MLP,
diego's avatar
diego committed
260
    CODEC_ID_GSM_MS, /* as found in WAV */
banan's avatar
banan committed
261
    CODEC_ID_ATRAC3,
michael's avatar
michael committed
262
    CODEC_ID_VOXWARE,
263

bellard's avatar
bellard committed
264
    /* subtitle codecs */
265 266
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
267
    CODEC_ID_TEXT,  /* raw UTF-8 text */
268
    CODEC_ID_XSUB,
269

diego's avatar
diego committed
270 271
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
                                * stream (only used by libavformat) */
glantau's avatar
glantau committed
272
};
273

274
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
275
/* CODEC_ID_MP3LAME is obsolete */
276
#define CODEC_ID_MP3LAME CODEC_ID_MP3
277 278
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
glantau's avatar
glantau committed
279 280

enum CodecType {
281
    CODEC_TYPE_UNKNOWN = -1,
glantau's avatar
glantau committed
282 283
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
284
    CODEC_TYPE_DATA,
bellard's avatar
bellard committed
285
    CODEC_TYPE_SUBTITLE,
286
    CODEC_TYPE_NB
glantau's avatar
glantau committed
287 288
};

diego's avatar
diego committed
289 290
/* Currently unused, may be used if 24/32 bits samples are ever supported. */
/* all in native-endian format */
glantau's avatar
glantau committed
291
enum SampleFormat {
mru's avatar
mru committed
292
    SAMPLE_FMT_NONE = -1,
293 294 295
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
296
    SAMPLE_FMT_S32,             ///< signed 32 bits
297
    SAMPLE_FMT_FLT,             ///< float
glantau's avatar
glantau committed
298 299
};

glantau's avatar
glantau committed
300
/* in bytes */
301
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
glantau's avatar
glantau committed
302

303
/**
304
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
diego's avatar
diego committed
305 306 307 308
 * 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.
309 310 311
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

312
/**
diego's avatar
diego committed
313 314
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
315 316 317
 */
#define FF_MIN_BUFFER_SIZE 16384

318 319
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
320
    ME_ZERO = 1,
321 322 323 324
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
325 326 327 328
    ME_X1,
    ME_HEX,
    ME_UMH,
    ME_ITER,
329 330
};

michael's avatar
michael committed
331
enum AVDiscard{
diego's avatar
diego committed
332 333
    /* 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
334 335 336 337 338 339 340 341
    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
342 343 344
typedef struct RcOverride{
    int start_frame;
    int end_frame;
diego's avatar
diego committed
345
    int qscale; // If this is 0 then quality_factor will be used instead.
michaelni's avatar
michaelni committed
346 347 348
    float quality_factor;
} RcOverride;

349
#define FF_MAX_B_FRAMES 16
350

michaelni's avatar
michaelni committed
351
/* encoding support
diego's avatar
diego committed
352 353
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
michaelni's avatar
michaelni committed
354
*/
glantau's avatar
glantau committed
355

diego's avatar
diego committed
356 357 358 359 360 361 362 363 364
#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.
/* The parent program guarantees that the input for B-frames containing
 * streams is not written to for at least s->max_b_frames+1 frames, if
 * this is not set the input will be copied. */
michaelni's avatar
michaelni committed
365
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
diego's avatar
diego committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
#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. */
#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).
381
/* Fx : Flag for h263+ extra options */
382
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
diego's avatar
diego committed
383
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
384
#endif
diego's avatar
diego committed
385 386 387 388 389
#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
390 391
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
michael's avatar
michael committed
392 393
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
diego's avatar
diego committed
394
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
bcoudurier's avatar
bcoudurier committed
395
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
diego's avatar
diego committed
396 397 398 399 400 401
#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
402
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
lorenm's avatar
lorenm committed
403 404 405
#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
406 407 408 409 410 411 412
#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.
413

414
/* Unsupported options :
415 416
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
417
 *              Independent Segment Decoding */
418
/* /Fx */
glantau's avatar
glantau committed
419 420
/* codec capabilities */

diego's avatar
diego committed
421
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
michaelni's avatar
michaelni committed
422 423 424 425 426
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
diego's avatar
diego committed
427
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
428
#define CODEC_CAP_PARSE_ONLY      0x0004
429
#define CODEC_CAP_TRUNCATED       0x0008
diego's avatar
diego committed
430
/* Codec can export data for HW decoding (XvMC). */
431
#define CODEC_CAP_HWACCEL         0x0010
432
/**
diego's avatar
diego committed
433 434
 * 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.
435
 */
436
#define CODEC_CAP_DELAY           0x0020
437 438 439 440 441
/**
 * 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
442

diego's avatar
diego committed
443
//The following defines may change, don't expect compatibility if you use them.
444
#define MB_TYPE_INTRA4x4   0x0001
diego's avatar
diego committed
445 446
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
#define MB_TYPE_16x16      0x0008
#define MB_TYPE_16x8       0x0010
#define MB_TYPE_8x16       0x0020
#define MB_TYPE_8x8        0x0040
#define MB_TYPE_INTERLACED 0x0080
#define MB_TYPE_DIRECT2     0x0100 //FIXME
#define MB_TYPE_ACPRED     0x0200
#define MB_TYPE_GMC        0x0400
#define MB_TYPE_SKIP       0x0800
#define MB_TYPE_P0L0       0x1000
#define MB_TYPE_P1L0       0x2000
#define MB_TYPE_P0L1       0x4000
#define MB_TYPE_P1L1       0x8000
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
#define MB_TYPE_QUANT      0x00010000
#define MB_TYPE_CBP        0x00020000
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)

467 468
/**
 * Pan Scan area.
diego's avatar
diego committed
469 470
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
471 472 473
 */
typedef struct AVPanScan{
    /**
diego's avatar
diego committed
474 475 476
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
477 478 479 480 481
     */
    int id;

    /**
     * width and height in 1/16 pel
diego's avatar
diego committed
482 483
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
484 485 486 487 488
     */
    int width;
    int height;

    /**
diego's avatar
diego committed
489 490 491
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
492 493 494 495
     */
    int16_t position[3][2];
}AVPanScan;

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

704 705 706
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
michaelni's avatar
michaelni committed
707 708

#define FF_BUFFER_TYPE_INTERNAL 1
diego's avatar
diego committed
709 710 711
#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
712

michaelni's avatar
michaelni committed
713

714 715 716 717
#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
718 719
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
michaelni's avatar
michaelni committed
720

diego's avatar
diego committed
721 722 723 724
#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).
725

michaelni's avatar
michaelni committed
726 727 728
/**
 * Audio Video Frame.
 */
michaelni's avatar
michaelni committed
729 730 731
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
michaelni's avatar
michaelni committed
732

733
#define DEFAULT_FRAME_RATE_BASE 1001000
michaelni's avatar
doxy  
michaelni committed
734 735

/**
diego's avatar
diego committed
736
 * main external API structure
michaelni's avatar
doxy  
michaelni committed
737
 */
glantau's avatar
glantau committed
738
typedef struct AVCodecContext {
739
    /**
diego's avatar
diego committed
740
     * information on struct for av_log
741 742
     * - set by avcodec_alloc_context
     */
michael's avatar
michael committed
743
    AVClass *av_class;
744
    /**
diego's avatar
diego committed
745 746 747
     * 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.
748
     */
glantau's avatar
glantau committed
749
    int bit_rate;
750 751

    /**
752
     * number of bits the bitstream is allowed to diverge from the reference.
753
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
diego's avatar
diego committed
754
     * - encoding: Set by user; unused for constant quantizer encoding.
755
     * - decoding: unused
756
     */
757
    int bit_rate_tolerance;
758 759

    /**
760
     * CODEC_FLAG_*.
diego's avatar
diego committed
761 762
     * - encoding: Set by user.
     * - decoding: Set by user.
763
     */
glantau's avatar
glantau committed
764
    int flags;
765 766

    /**
diego's avatar
diego committed
767 768 769 770 771 772
     * 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?)
773 774 775 776
     */
    int sub_id;

    /**
diego's avatar
diego committed
777
     * Motion estimation algorithm used for video coding.
lorenm's avatar
lorenm committed
778 779
     * 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]
780 781
     * - encoding: MUST be set by user.
     * - decoding: unused
782 783 784 785
     */
    int me_method;

    /**
diego's avatar
diego committed
786 787
     * some codecs need / can use extradata like Huffman tables.
     * mjpeg: Huffman tables
788
     * rv10: additional flags
789
     * mpeg4: global headers (they can be in the bitstream or here)
diego's avatar
diego committed
790 791 792 793 794
     * 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.
795
     */
796
    uint8_t *extradata;
797
    int extradata_size;
798

799
    /**
diego's avatar
diego committed
800 801
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
802 803
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
diego's avatar
diego committed
804 805
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
806
     */
michael's avatar
michael committed
807
    AVRational time_base;
808

809
    /* video only */
810
    /**
811
     * picture width / height.
812
     * - encoding: MUST be set by user.
diego's avatar
diego committed
813 814 815
     * - decoding: Set by libavcodec.
     * Note: For compatibility it is possible to set this instead of
     * coded_width/height before decoding.
816
     */
glantau's avatar
glantau committed
817
    int width, height;
818

819
#define FF_ASPECT_EXTENDED 15
820 821

    /**
diego's avatar
diego committed
822 823
     * the number of pictures in a group of pictures, or 0 for intra_only
     * - encoding: Set by user.
824
     * - decoding: unused
825 826 827 828
     */
    int gop_size;

    /**
diego's avatar
diego committed
829 830 831
     * Pixel format, see PIX_FMT_xxx.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
832
     */
833
    enum PixelFormat pix_fmt;
834

835
    /**
diego's avatar
diego committed
836
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
837
     * has to read frames at native frame rate.
diego's avatar
diego committed
838 839
     * - encoding: Set by user.
     * - decoding: unused
840 841
     */
    int rate_emu;
842

843
    /**
diego's avatar
diego committed
844 845
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw a horizontal band. It improves cache usage. Not
846
     * all codecs can do that. You must check the codec capabilities
diego's avatar
diego committed
847
     * beforehand.
848
     * - encoding: unused
diego's avatar
diego committed
849
     * - decoding: Set by user.
850 851 852 853
     * @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
854
     */
glantau's avatar
glantau committed
855
    void (*draw_horiz_band)(struct AVCodecContext *s,
856
                            const AVFrame *src, int offset[4],
857
                            int y, int type, int height);
glantau's avatar
glantau committed
858

glantau's avatar
glantau committed
859
    /* audio only */
diego's avatar
diego committed
860
    int sample_rate; ///< samples per second
glantau's avatar
glantau committed
861
    int channels;
862 863

    /**
diego's avatar
diego committed
864 865 866
     * audio sample format
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
867
     */
diego's avatar
diego committed
868
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
glantau's avatar
glantau committed
869

diego's avatar
diego committed
870
    /* The following data should not be initialized. */
871
    /**
diego's avatar
diego committed
872
     * Samples per packet, initialized when calling 'init'.
873 874
     */
    int frame_size;
875
    int frame_number;   ///< audio or video frame number
diego's avatar
diego committed
876
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
877

878
    /**
diego's avatar
diego committed
879
     * Number of frames the decoded output will be delayed relative to
880
     * the encoded input.
diego's avatar
diego committed
881
     * - encoding: Set by libavcodec.
882
     * - decoding: unused
883 884
     */
    int delay;
885

886 887
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
888 889
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

890
    /**
diego's avatar
diego committed
891 892
     * minimum quantizer
     * - encoding: Set by user.
893
     * - decoding: unused
894 895 896 897
     */
    int qmin;

    /**
diego's avatar
diego committed
898 899
     * maximum quantizer
     * - encoding: Set by user.
900
     * - decoding: unused
901 902 903 904
     */
    int qmax;

    /**
diego's avatar
diego committed
905 906
     * maximum quantizer difference between frames
     * - encoding: Set by user.
907
     * - decoding: unused
908 909 910 911
     */
    int max_qdiff;

    /**
diego's avatar
diego committed
912 913 914
     * 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.
915
     * - decoding: unused
916 917 918 919
     */
    int max_b_frames;

    /**
diego's avatar
diego committed
920 921
     * qscale factor between IP and B-frames
     * - encoding: Set by user.
922
     * - decoding: unused
923 924
     */
    float b_quant_factor;
925

926 927
    /** obsolete FIXME remove */
    int rc_strategy;
michael's avatar
michael committed
928 929
#define FF_RC_STRATEGY_XVID 1

michaelni's avatar
michaelni committed
930
    int b_frame_strategy;
931

932
    /**
diego's avatar
diego committed
933
     * hurry up amount
934
     * - encoding: unused
diego's avatar
diego committed
935
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
takis's avatar
takis committed
936
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
937 938
     */
    int hurry_up;
939

glantau's avatar
glantau committed
940
    struct AVCodec *codec;
941

glantau's avatar
glantau committed
942 943
    void *priv_data;

944
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
michael's avatar
michael committed
945 946
    /* unused, FIXME remove*/
    int rtp_mode;
947
#endif
948

diego's avatar
diego committed
949
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
diego's avatar
diego committed
950
                            /* do its best to deliver a chunk with size     */
951
                            /* below rtp_payload_size, the chunk will start */
diego's avatar
diego committed
952
                            /* with a start code on some codecs like H.263. */
953
                            /* This doesn't take account of any particular  */
diego's avatar
diego committed
954
                            /* headers inside the transmitted RTP payload.  */
955

956

diego's avatar
diego committed
957 958 959 960 961 962
    /* 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.                  */
963
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
964

michaelni's avatar
michaelni committed
965 966 967 968 969 970 971 972
    /* 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;
973
    int misc_bits;
974

975
    /**
diego's avatar
diego committed
976 977
     * number of bits used for the previously encoded frame
     * - encoding: Set by libavcodec.
michaelni's avatar
michaelni committed
978
     * - decoding: unused
979
     */
michaelni's avatar
michaelni committed
980
    int frame_bits;
michaelni's avatar
michaelni committed
981

982
    /**
diego's avatar
diego committed
983 984 985
     * Private data of the user, can be used to carry app specific stuff.
     * - encoding: Set by user.
     * - decoding: Set by user.
986 987 988
     */
    void *opaque;

glantau's avatar
glantau committed
989
    char codec_name[32];
990 991
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
992

michaelni's avatar
michaelni committed
993 994
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
995 996 997 998 999 1000
     * 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
1001
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
diego's avatar
diego committed
1002 1003 1004
     * 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
1005 1006
     */
    unsigned int codec_tag;
1007

1008
    /**
diego's avatar
diego committed
1009 1010 1011
     * Work around bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: Set by user
     * - decoding: Set by user
1012 1013
     */
    int workaround_bugs;
1014
#define FF_BUG_AUTODETECT       1  ///< autodetection
1015 1016 1017 1018
#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
1019
#define FF_BUG_AMV              32
diego's avatar
diego committed
1020
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
michaelni's avatar
michaelni committed
1021
#define FF_BUG_QPEL_CHROMA      64
michaelni's avatar
michaelni committed
1022
#define FF_BUG_STD_QPEL         128
michaelni's avatar
michaelni committed
1023
#define FF_BUG_QPEL_CHROMA2     256
1024
#define FF_BUG_DIRECT_BLOCKSIZE 512
1025
#define FF_BUG_EDGE             1024
1026
#define FF_BUG_HPEL_CHROMA      2048
1027
#define FF_BUG_DC_CLIP          4096
diego's avatar
diego committed
1028 1029
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1030

1031
    /**
diego's avatar
diego committed
1032 1033
     * luma single coefficient elimination threshold
     * - encoding: Set by user.
1034
     * - decoding: unused
1035
     */
michaelni's avatar
 
michaelni committed
1036
    int luma_elim_threshold;
1037

1038
    /**
diego's avatar
diego committed
1039 1040
     * chroma single coeff elimination threshold
     * - encoding: Set by user.
1041
     * - decoding: unused
1042
     */
michaelni's avatar
 
michaelni committed
1043
    int chroma_elim_threshold;
1044

1045
    /**
diego's avatar
diego committed
1046 1047
     * strictly follow the standard (MPEG4, ...).
     * - encoding: Set by user.
1048
     * - decoding: unused
1049 1050
     */
    int strict_std_compliance;
diego's avatar
diego committed
1051 1052
#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.
1053
#define FF_COMPLIANCE_NORMAL        0
diego's avatar
diego committed
1054 1055
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1056

1057
    /**
diego's avatar
diego committed
1058 1059 1060 1061
     * 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.
1062
     * - decoding: unused
1063 1064
     */
    float b_quant_offset;
1065

1066
    /**
diego's avatar
diego committed
1067 1068
     * Error resilience; higher values will detect more errors but may
     * misdetect some more or less valid parts as errors.
1069
     * - encoding: unused
diego's avatar
diego committed
1070
     * - decoding: Set by user.
1071
     */
michaelni's avatar
 
michaelni committed
1072
    int error_resilience;
diego's avatar
diego committed
1073
#define FF_ER_CAREFUL         1
1074 1075 1076
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1077

1078
    /**
diego's avatar
diego committed
1079 1080
     * 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
1081
     * avcodec_align_dimensions() should be used to find the required width and
diego's avatar
diego committed
1082
     * height, as they normally need to be rounded up to the next multiple of 16.
1083
     * - encoding: unused
diego's avatar
diego committed
1084
     * - decoding: Set by libavcodec., user can override.
1085
     */
michaelni's avatar
michaelni committed
1086
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1087

1088
    /**
diego's avatar
diego committed
1089 1090 1091
     * 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.
1092
     * - encoding: unused
diego's avatar
diego committed
1093
     * - decoding: Set by libavcodec., user can override.
1094
     */
michaelni's avatar
michaelni committed
1095
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
michaelni's avatar
michaelni committed
1096

1097
    /**
diego's avatar
diego committed
1098 1099 1100
     * If 1 the stream has a 1 frame delay during decoding.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
1101 1102
     */
    int has_b_frames;
1103 1104 1105

    /**
     * number of bytes per packet if constant and known or 0
diego's avatar
diego committed
1106
     * Used by some WAV based audio codecs.
1107 1108
     */
    int block_align;
1109

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

1114
    /**
diego's avatar
diego committed
1115 1116
     * 0-> h263 quant 1-> mpeg quant
     * - encoding: Set by user.
1117
     * - decoding: unused
1118 1119
     */
    int mpeg_quant;
1120

1121
    /**
diego's avatar
diego committed
1122 1123
     * pass1 encoding statistics output buffer
     * - encoding: Set by libavcodec.
1124
     * - decoding: unused
1125
     */
1126
    char *stats_out;
1127

1128
    /**
diego's avatar
diego committed
1129 1130 1131
     * pass2 encoding statistics input buffer
     * Concatenated stuff from stats_out of pass1 should be placed here.
     * - encoding: Allocated/set/freed by user.
1132
     * - decoding: unused
1133 1134
     */
    char *stats_in;
1135

1136
    /**
diego's avatar
diego committed
1137 1138 1139
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
     * - encoding: Set by user.
1140
     * - decoding: unused
1141
     */
michaelni's avatar
michaelni committed
1142
    float rc_qsquish;
1143

michaelni's avatar
michaelni committed
1144 1145
    float rc_qmod_amp;
    int rc_qmod_freq;
1146

1147
    /**
diego's avatar
diego committed
1148 1149
     * ratecontrol override, see RcOverride
     * - encoding: Allocated/set/freed by user.
1150
     * - decoding: unused
1151
     */
michaelni's avatar
michaelni committed
1152 1153
    RcOverride *rc_override;
    int rc_override_count;
1154

1155
    /**
diego's avatar
diego committed
1156 1157
     * rate control equation
     * - encoding: Set by user
1158
     * - decoding: unused
1159
     */
michaelni's avatar
michaelni committed
1160
    char *rc_eq;
1161

1162
    /**
diego's avatar
diego committed
1163 1164
     * maximum bitrate
     * - encoding: Set by user.
1165
     * - decoding: unused
1166
     */
michaelni's avatar
michaelni committed
1167
    int rc_max_rate;
1168

1169
    /**
diego's avatar
diego committed
1170 1171
     * minimum bitrate
     * - encoding: Set by user.
1172
     * - decoding: unused
1173
     */
michaelni's avatar
michaelni committed
1174
    int rc_min_rate;
1175

1176
    /**
diego's avatar
diego committed
1177 1178
     * decoder bitstream buffer size
     * - encoding: Set by user.
1179
     * - decoding: unused
1180
     */
michaelni's avatar
michaelni committed
1181 1182
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1183 1184

    /**
diego's avatar
diego committed
1185 1186 1187 1188
     * 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.
1189
     * - decoding: unused
1190 1191
     */
    float i_quant_factor;
1192

1193
    /**
diego's avatar
diego committed
1194 1195
     * qscale offset between P and I-frames
     * - encoding: Set by user.
1196
     * - decoding: unused
1197 1198
     */
    float i_quant_offset;
1199

1200
    /**
diego's avatar
diego committed
1201 1202
     * initial complexity for pass1 ratecontrol
     * - encoding: Set by user.
1203
     * - decoding: unused
1204
     */
michaelni's avatar
michaelni committed
1205
    float rc_initial_cplx;
1206

1207
    /**
diego's avatar
diego committed
1208 1209
     * DCT algorithm, see FF_DCT_* below
     * - encoding: Set by user.
1210
     * - decoding: unused
1211
     */
1212
    int dct_algo;
1213
#define FF_DCT_AUTO    0
1214
#define FF_DCT_FASTINT 1
1215 1216 1217
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1218
#define FF_DCT_ALTIVEC 5
michael's avatar
michael committed
1219
#define FF_DCT_FAAN    6
1220

1221
    /**
diego's avatar
diego committed
1222 1223
     * luminance masking (0-> disabled)
     * - encoding: Set by user.
1224
     * - decoding: unused
1225 1226
     */
    float lumi_masking;
1227

1228
    /**
diego's avatar
diego committed
1229 1230
     * temporary complexity masking (0-> disabled)
     * - encoding: Set by user.
1231
     * - decoding: unused
1232 1233
     */
    float temporal_cplx_masking;
1234

1235
    /**
diego's avatar
diego committed
1236 1237
     * spatial complexity masking (0-> disabled)
     * - encoding: Set by user.
1238
     * - decoding: unused
1239 1240
     */
    float spatial_cplx_masking;
1241

1242
    /**
diego's avatar
diego committed
1243 1244
     * p block masking (0-> disabled)
     * - encoding: Set by user.
1245
     * - decoding: unused
1246 1247
     */
    float p_masking;
1248

1249
    /**
diego's avatar
diego committed
1250 1251
     * darkness masking (0-> disabled)
     * - encoding: Set by user.
1252
     * - decoding: unused
1253 1254
     */
    float dark_masking;
1255 1256


1257 1258
    /* for binary compatibility */
    int unused;
1259

1260
    /**
diego's avatar
diego committed
1261 1262 1263
     * IDCT algorithm, see FF_IDCT_* below.
     * - encoding: Set by user.
     * - decoding: Set by user.
1264 1265 1266 1267 1268 1269 1270 1271 1272 1273
     */
    int idct_algo;
#define FF_IDCT_AUTO         0
#define FF_IDCT_INT          1
#define FF_IDCT_SIMPLE       2
#define FF_IDCT_SIMPLEMMX    3
#define FF_IDCT_LIBMPEG2MMX  4
#define FF_IDCT_PS2          5
#define FF_IDCT_MLIB         6
#define FF_IDCT_ARM          7
1274
#define FF_IDCT_ALTIVEC      8
1275
#define FF_IDCT_SH4          9
1276
#define FF_IDCT_SIMPLEARM    10
1277
#define FF_IDCT_H264         11
1278
#define FF_IDCT_VP3          12
1279
#define FF_IDCT_IPP          13
michael's avatar
michael committed
1280
#define FF_IDCT_XVIDMMX      14
1281
#define FF_IDCT_CAVS         15
mru's avatar
mru committed
1282
#define FF_IDCT_SIMPLEARMV5TE 16
mru's avatar
mru committed
1283
#define FF_IDCT_SIMPLEARMV6  17
1284

1285
    /**
diego's avatar
diego committed
1286 1287 1288
     * slice count
     * - encoding: Set by libavcodec.
     * - decoding: Set by user (or 0).
1289 1290 1291
     */
    int slice_count;
    /**
diego's avatar
diego committed
1292 1293 1294
     * slice offsets in the frame in bytes
     * - encoding: Set/allocated by libavcodec.
     * - decoding: Set/allocated by user (or NULL).
1295 1296 1297
     */
    int *slice_offset;

1298
    /**
diego's avatar
diego committed
1299
     * error concealment flags
1300
     * - encoding: unused
diego's avatar
diego committed
1301
     * - decoding: Set by user.
1302 1303 1304 1305 1306
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

kabi's avatar
kabi committed
1307
    /**
kabi's avatar
kabi committed
1308
     * dsp_mask could be add used to disable unwanted CPU features
kabi's avatar
kabi committed
1309
     * CPU features (i.e. MMX, SSE. ...)
kabi's avatar
kabi committed
1310
     *
diego's avatar
diego committed
1311 1312 1313
     * 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
1314 1315
     */
    unsigned dsp_mask;
diego's avatar
diego committed
1316
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
kabi's avatar
kabi committed
1317
    /* lower 16 bits - CPU features */
1318 1319 1320 1321 1322 1323
#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 */
1324 1325
#define FF_MM_SSE3     0x0040 /* Prescott SSE3 functions */
#define FF_MM_SSSE3    0x0080 /* Conroe SSSE3 functions */
1326
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
michaelni's avatar
michaelni committed
1327 1328

    /**
1329
     * bits per sample/pixel from the demuxer (needed for huffyuv).
diego's avatar
diego committed
1330 1331
     * - encoding: Set by libavcodec.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1332 1333
     */
     int bits_per_sample;
1334

michaelni's avatar
michaelni committed
1335
    /**
diego's avatar
diego committed
1336 1337
     * prediction method (needed for huffyuv)
     * - encoding: Set by user.
1338
     * - decoding: unused
michaelni's avatar
michaelni committed
1339 1340 1341 1342 1343
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1344

michaelni's avatar
michaelni committed
1345
    /**
diego's avatar
diego committed
1346 1347 1348 1349
     * 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
1350
     */
michael's avatar
michael committed
1351
    AVRational sample_aspect_ratio;
michaelni's avatar
michaelni committed
1352 1353

    /**
diego's avatar
diego committed
1354 1355 1356
     * the picture in the bitstream
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
michaelni's avatar
michaelni committed
1357
     */
michaelni's avatar
michaelni committed
1358
    AVFrame *coded_frame;
michaelni's avatar
michaelni committed
1359 1360

    /**
diego's avatar
diego committed
1361 1362 1363
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
michaelni's avatar
michaelni committed
1364 1365 1366 1367 1368 1369 1370 1371
     */
    int debug;
#define FF_DEBUG_PICT_INFO 1
#define FF_DEBUG_RC        2
#define FF_DEBUG_BITSTREAM 4
#define FF_DEBUG_MB_TYPE   8
#define FF_DEBUG_QP        16
#define FF_DEBUG_MV        32
1372
#define FF_DEBUG_DCT_COEFF 0x00000040
michaelni's avatar
michaelni committed
1373 1374 1375
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1376
#define FF_DEBUG_ER        0x00000400
michaelni's avatar
michaelni committed
1377
#define FF_DEBUG_MMCO      0x00000800
michaelni's avatar
michaelni committed
1378
#define FF_DEBUG_BUGS      0x00001000
michael's avatar
michael committed
1379 1380
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1381

1382
    /**
diego's avatar
diego committed
1383 1384 1385
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1386 1387 1388 1389 1390 1391
     */
    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

1392
    /**
diego's avatar
diego committed
1393 1394
     * error
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1395
     * - decoding: unused
1396 1397
     */
    uint64_t error[4];
1398

michaelni's avatar
michaelni committed
1399
    /**
diego's avatar
diego committed
1400
     * minimum MB quantizer
1401
     * - encoding: unused
1402
     * - decoding: unused
michaelni's avatar
michaelni committed
1403 1404 1405 1406
     */
    int mb_qmin;

    /**
diego's avatar
diego committed
1407
     * maximum MB quantizer
1408
     * - encoding: unused
1409
     * - decoding: unused
michaelni's avatar
michaelni committed
1410 1411
     */
    int mb_qmax;
1412

michaelni's avatar
michaelni committed
1413
    /**
diego's avatar
diego committed
1414 1415
     * motion estimation comparison function
     * - encoding: Set by user.
1416
     * - decoding: unused
michaelni's avatar
michaelni committed
1417 1418 1419
     */
    int me_cmp;
    /**
diego's avatar
diego committed
1420 1421
     * subpixel motion estimation comparison function
     * - encoding: Set by user.
1422
     * - decoding: unused
michaelni's avatar
michaelni committed
1423 1424 1425
     */
    int me_sub_cmp;
    /**
diego's avatar
diego committed
1426 1427
     * macroblock comparison function (not supported yet)
     * - encoding: Set by user.
1428
     * - decoding: unused
michaelni's avatar
michaelni committed
1429 1430
     */
    int mb_cmp;
michael's avatar
michael committed
1431
    /**
diego's avatar
diego committed
1432 1433
     * interlaced DCT comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1434 1435 1436
     * - decoding: unused
     */
    int ildct_cmp;
michaelni's avatar
michaelni committed
1437 1438 1439 1440 1441 1442 1443 1444
#define FF_CMP_SAD  0
#define FF_CMP_SSE  1
#define FF_CMP_SATD 2
#define FF_CMP_DCT  3
#define FF_CMP_PSNR 4
#define FF_CMP_BIT  5
#define FF_CMP_RD   6
#define FF_CMP_ZERO 7
michael's avatar
michael committed
1445 1446
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1447
#define FF_CMP_NSSE 10
michael's avatar
michael committed
1448 1449
#define FF_CMP_W53  11
#define FF_CMP_W97  12
michael's avatar
michael committed
1450
#define FF_CMP_DCTMAX 13
1451
#define FF_CMP_DCT264 14
michaelni's avatar
michaelni committed
1452
#define FF_CMP_CHROMA 256
1453

michaelni's avatar
michaelni committed
1454
    /**
diego's avatar
diego committed
1455 1456
     * ME diamond size & shape
     * - encoding: Set by user.
1457
     * - decoding: unused
michaelni's avatar
michaelni committed
1458 1459
     */
    int dia_size;
michaelni's avatar
michaelni committed
1460 1461

    /**
diego's avatar
diego committed
1462 1463
     * amount of previous MV predictors (2a+1 x 2a+1 square)
     * - encoding: Set by user.
1464
     * - decoding: unused
michaelni's avatar
michaelni committed
1465 1466
     */
    int last_predictor_count;
michaelni's avatar
michaelni committed
1467

michaelni's avatar
michaelni committed
1468
    /**
diego's avatar
diego committed
1469 1470
     * prepass for motion estimation
     * - encoding: Set by user.
1471
     * - decoding: unused
michaelni's avatar
michaelni committed
1472 1473
     */
    int pre_me;
michaelni's avatar
michaelni committed
1474

michaelni's avatar
michaelni committed
1475
    /**
diego's avatar
diego committed
1476 1477
     * motion estimation prepass comparison function
     * - encoding: Set by user.
1478
     * - decoding: unused
michaelni's avatar
michaelni committed
1479 1480
     */
    int me_pre_cmp;
michaelni's avatar
michaelni committed
1481

michaelni's avatar
michaelni committed
1482
    /**
diego's avatar
diego committed
1483 1484
     * ME prepass diamond size & shape
     * - encoding: Set by user.
1485
     * - decoding: unused
michaelni's avatar
michaelni committed
1486 1487 1488
     */
    int pre_dia_size;

michaelni's avatar
michaelni committed
1489
    /**
diego's avatar
diego committed
1490 1491
     * subpel ME quality
     * - encoding: Set by user.
1492
     * - decoding: unused
michaelni's avatar
michaelni committed
1493 1494 1495
     */
    int me_subpel_quality;

michaelni's avatar
michaelni committed
1496
    /**
diego's avatar
diego committed
1497
     * callback to negotiate the pixelFormat
michaelni's avatar
michaelni committed
1498
     * @param fmt is the list of formats which are supported by the codec,
diego's avatar
diego committed
1499 1500 1501
     * 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
1502
     * - encoding: unused
diego's avatar
diego committed
1503
     * - decoding: Set by user, if not set the native format will be chosen.
michaelni's avatar
michaelni committed
1504
     */
iive's avatar
iive committed
1505
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1506 1507

    /**
diego's avatar
diego committed
1508 1509 1510
     * DTG active format information (additional aspect ratio
     * information only used in DVB MPEG-2 transport streams)
     * 0 if not set.
1511
     *
diego's avatar
diego committed
1512 1513
     * - encoding: unused
     * - decoding: Set by decoder.
1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
     */
    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

1524
    /**
diego's avatar
diego committed
1525 1526
     * maximum motion estimation search range in subpel units
     * If 0 then no limit.
1527
     *
diego's avatar
diego committed
1528 1529
     * - encoding: Set by user.
     * - decoding: unused
1530
     */
kabi's avatar
kabi committed
1531
    int me_range;
1532

michaelni's avatar
michaelni committed
1533
    /**
diego's avatar
diego committed
1534 1535
     * intra quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1536 1537 1538 1539
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1540

michaelni's avatar
michaelni committed
1541
    /**
diego's avatar
diego committed
1542 1543
     * inter quantizer bias
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1544 1545 1546
     * - decoding: unused
     */
    int inter_quant_bias;
1547 1548

    /**
diego's avatar
diego committed
1549 1550 1551 1552
     * color table ID
     * - encoding: unused
     * - decoding: Which clrtable should be used for 8bit RGB images.
     *             Tables have to be stored somewhere. FIXME
1553 1554
     */
    int color_table_id;
1555

1556
    /**
diego's avatar
diego committed
1557 1558
     * internal_buffer count
     * Don't touch, used by libavcodec default_get_buffer().
1559 1560
     */
    int internal_buffer_count;
1561

1562
    /**
diego's avatar
diego committed
1563 1564
     * internal_buffers
     * Don't touch, used by libavcodec default_get_buffer().
1565 1566
     */
    void *internal_buffer;
1567 1568 1569 1570 1571 1572 1573

#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
1574
    /**
diego's avatar
diego committed
1575 1576 1577
     * 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
1578 1579 1580
     * - decoding: unused
     */
    int global_quality;
1581

michael's avatar
michael committed
1582 1583
#define FF_CODER_TYPE_VLC       0
#define FF_CODER_TYPE_AC        1
1584 1585 1586
#define FF_CODER_TYPE_RAW       2
#define FF_CODER_TYPE_RLE       3
#define FF_CODER_TYPE_DEFLATE   4
michaelni's avatar
michaelni committed
1587 1588
    /**
     * coder type
diego's avatar
diego committed
1589
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1590 1591 1592 1593 1594 1595
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
diego's avatar
diego committed
1596
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1597 1598 1599
     * - decoding: unused
     */
    int context_model;
1600 1601 1602 1603
#if 0
    /**
     *
     * - encoding: unused
diego's avatar
diego committed
1604
     * - decoding: Set by user.
1605 1606 1607
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1608

1609 1610 1611
    /**
     * slice flags
     * - encoding: unused
diego's avatar
diego committed
1612
     * - decoding: Set by user.
1613 1614 1615 1616 1617 1618
     */
    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
1619 1620 1621 1622 1623 1624
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1625

1626 1627
    /**
     * macroblock decision mode
diego's avatar
diego committed
1628
     * - encoding: Set by user.
1629 1630 1631 1632 1633 1634
     * - 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
1635 1636 1637

    /**
     * custom intra quantization matrix
diego's avatar
diego committed
1638 1639
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1640 1641 1642 1643 1644
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
diego's avatar
diego committed
1645 1646
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1647 1648
     */
    uint16_t *inter_matrix;
1649

1650 1651
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
diego's avatar
diego committed
1652
     * This is used to work around some encoder bugs.
1653
     * - encoding: unused
diego's avatar
diego committed
1654
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1655 1656
     */
    unsigned int stream_codec_tag;
michaelni's avatar
michaelni committed
1657 1658

    /**
diego's avatar
diego committed
1659 1660 1661
     * scene change detection threshold
     * 0 is default, larger means fewer detected scene changes.
     * - encoding: Set by user.
michaelni's avatar
michaelni committed
1662 1663 1664
     * - decoding: unused
     */
    int scenechange_threshold;
1665 1666

    /**
diego's avatar
diego committed
1667 1668
     * minimum Lagrange multipler
     * - encoding: Set by user.
1669 1670 1671 1672 1673
     * - decoding: unused
     */
    int lmin;

    /**
diego's avatar
diego committed
1674 1675
     * maximum Lagrange multipler
     * - encoding: Set by user.
1676 1677 1678
     * - decoding: unused
     */
    int lmax;
1679 1680

    /**
diego's avatar
diego committed
1681
     * palette control structure
1682
     * - encoding: ??? (no palette-enabled encoder yet)
diego's avatar
diego committed
1683
     * - decoding: Set by user.
1684 1685
     */
    struct AVPaletteControl *palctrl;
1686 1687 1688

    /**
     * noise reduction strength
diego's avatar
diego committed
1689
     * - encoding: Set by user.
1690 1691 1692
     * - decoding: unused
     */
    int noise_reduction;
1693

1694
    /**
diego's avatar
diego committed
1695 1696 1697
     * 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
1698
     * same buffer or new buffer with old frame "painted" into it.
diego's avatar
diego committed
1699
     * If pic.data[0] == NULL must behave like get_buffer().
1700
     * - encoding: unused
diego's avatar
diego committed
1701
     * - decoding: Set by libavcodec., user can override
1702
     */
1703
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
michael's avatar
michael committed
1704 1705

    /**
diego's avatar
diego committed
1706 1707
     * Number of bits which should be loaded into the rc buffer before decoding starts.
     * - encoding: Set by user.
michael's avatar
michael committed
1708 1709 1710 1711 1712 1713
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
diego's avatar
diego committed
1714
     * - encoding: Set by user.
michael's avatar
michael committed
1715 1716 1717 1718 1719
     * - decoding: unused
     */
    int inter_threshold;

    /**
diego's avatar
diego committed
1720 1721 1722
     * CODEC_FLAG2_*
     * - encoding: Set by user.
     * - decoding: Set by user.
michael's avatar
michael committed
1723 1724
     */
    int flags2;
michael's avatar
michael committed
1725 1726

    /**
diego's avatar
diego committed
1727 1728 1729
     * Simulates errors in the bitstream to test error concealment.
     * - encoding: Set by user.
     * - decoding: unused
michael's avatar
michael committed
1730 1731
     */
    int error_rate;
1732

1733 1734 1735
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
diego's avatar
diego committed
1736
     * - decoding: Set by user.
1737 1738 1739 1740 1741 1742
     */
    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
1743
    /**
diego's avatar
diego committed
1744 1745
     * quantizer noise shaping
     * - encoding: Set by user.
michael's avatar
michael committed
1746 1747 1748
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1749 1750

    /**
diego's avatar
diego committed
1751
     * thread count
1752
     * is used to decide how many independent tasks should be passed to execute()
diego's avatar
diego committed
1753 1754
     * - encoding: Set by user.
     * - decoding: Set by user.
1755 1756
     */
    int thread_count;
1757

1758
    /**
diego's avatar
diego committed
1759 1760 1761 1762
     * 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
1763
     * @param count the number of things to execute
diego's avatar
diego committed
1764 1765
     * - encoding: Set by libavcodec, user can override.
     * - decoding: Set by libavcodec, user can override.
1766 1767
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1768

1769
    /**
diego's avatar
diego committed
1770 1771
     * thread opaque
     * Can be used by execute() to store some per AVCodecContext stuff.
1772 1773 1774 1775
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1776 1777

    /**
diego's avatar
diego committed
1778 1779
     * Motion estimation threshold below which no motion estimation is
     * performed, but instead the user specified motion vectors are used.
1780
     *
diego's avatar
diego committed
1781
     * - encoding: Set by user.
1782
     * - decoding: unused
1783
     */
michael's avatar
michael committed
1784
     int me_threshold;
1785 1786

    /**
diego's avatar
diego committed
1787 1788
     * Macroblock threshold below which the user specified macroblock types will be used.
     * - encoding: Set by user.
1789 1790 1791
     * - decoding: unused
     */
     int mb_threshold;
1792 1793

    /**
diego's avatar
diego committed
1794 1795
     * precision of the intra DC coefficient - 8
     * - encoding: Set by user.
1796 1797 1798
     * - decoding: unused
     */
     int intra_dc_precision;
michael's avatar
michael committed
1799 1800

    /**
diego's avatar
diego committed
1801 1802
     * noise vs. sse weight for the nsse comparsion function
     * - encoding: Set by user.
michael's avatar
michael committed
1803 1804 1805
     * - decoding: unused
     */
     int nsse_weight;
1806 1807

    /**
diego's avatar
diego committed
1808
     * Number of macroblock rows at the top which are skipped.
1809
     * - encoding: unused
diego's avatar
diego committed
1810
     * - decoding: Set by user.
1811 1812 1813 1814
     */
     int skip_top;

    /**
diego's avatar
diego committed
1815
     * Number of macroblock rows at the bottom which are skipped.
1816
     * - encoding: unused
diego's avatar
diego committed
1817
     * - decoding: Set by user.
1818 1819
     */
     int skip_bottom;
michael's avatar
michael committed
1820 1821 1822

    /**
     * profile
diego's avatar
diego committed
1823 1824
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1825 1826 1827
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99
benoit's avatar
 
benoit committed
1828 1829 1830 1831
#define FF_PROFILE_AAC_MAIN 0
#define FF_PROFILE_AAC_LOW 1
#define FF_PROFILE_AAC_SSR 2
#define FF_PROFILE_AAC_LTP 3
michael's avatar
michael committed
1832 1833 1834

    /**
     * level
diego's avatar
diego committed
1835 1836
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
michael's avatar
michael committed
1837 1838 1839
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
michael's avatar
michael committed
1840 1841

    /**
diego's avatar
diego committed
1842
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
michael's avatar
michael committed
1843
     * - encoding: unused
diego's avatar
diego committed
1844
     * - decoding: Set by user.
michael's avatar
michael committed
1845 1846
     */
     int lowres;
1847 1848

    /**
diego's avatar
diego committed
1849 1850
     * Bitstream width / height, may be different from width/height if lowres
     * or other things are used.
1851
     * - encoding: unused
diego's avatar
diego committed
1852
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1853 1854
     */
    int coded_width, coded_height;
michael's avatar
michael committed
1855 1856 1857

    /**
     * frame skip threshold
diego's avatar
diego committed
1858
     * - encoding: Set by user.
michael's avatar
michael committed
1859 1860 1861 1862 1863 1864
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
diego's avatar
diego committed
1865
     * - encoding: Set by user.
michael's avatar
michael committed
1866 1867 1868
     * - decoding: unused
     */
    int frame_skip_factor;
michael's avatar
michael committed
1869 1870 1871

    /**
     * frame skip exponent
diego's avatar
diego committed
1872
     * - encoding: Set by user.
michael's avatar
michael committed
1873 1874 1875 1876 1877
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
diego's avatar
diego committed
1878 1879
     * frame skip comparison function
     * - encoding: Set by user.
michael's avatar
michael committed
1880 1881 1882
     * - decoding: unused
     */
    int frame_skip_cmp;
1883 1884

    /**
diego's avatar
diego committed
1885
     * Border processing masking, raises the quantizer for mbs on the borders
1886
     * of the picture.
diego's avatar
diego committed
1887
     * - encoding: Set by user.
1888 1889 1890
     * - decoding: unused
     */
    float border_masking;
1891 1892

    /**
diego's avatar
diego committed
1893 1894
     * minimum MB lagrange multipler
     * - encoding: Set by user.
1895 1896 1897 1898 1899
     * - decoding: unused
     */
    int mb_lmin;

    /**
diego's avatar
diego committed
1900 1901
     * maximum MB lagrange multipler
     * - encoding: Set by user.
1902 1903 1904
     * - decoding: unused
     */
    int mb_lmax;
1905 1906

    /**
1907
     *
diego's avatar
diego committed
1908
     * - encoding: Set by user.
1909 1910 1911
     * - decoding: unused
     */
    int me_penalty_compensation;
michael's avatar
michael committed
1912 1913

    /**
1914
     *
michael's avatar
michael committed
1915
     * - encoding: unused
diego's avatar
diego committed
1916
     * - decoding: Set by user.
michael's avatar
michael committed
1917 1918 1919 1920
     */
    enum AVDiscard skip_loop_filter;

    /**
1921
     *
michael's avatar
michael committed
1922
     * - encoding: unused
diego's avatar
diego committed
1923
     * - decoding: Set by user.
michael's avatar
michael committed
1924 1925 1926 1927
     */
    enum AVDiscard skip_idct;

    /**
1928
     *
michael's avatar
michael committed
1929
     * - encoding: unused
diego's avatar
diego committed
1930
     * - decoding: Set by user.
michael's avatar
michael committed
1931 1932
     */
    enum AVDiscard skip_frame;
michael's avatar
michael committed
1933 1934 1935

    /**
     *
diego's avatar
diego committed
1936
     * - encoding: Set by user.
michael's avatar
michael committed
1937 1938 1939
     * - decoding: unused
     */
    int bidir_refine;
1940 1941 1942

    /**
     *
diego's avatar
diego committed
1943
     * - encoding: Set by user.
1944 1945 1946
     * - decoding: unused
     */
    int brd_scale;
lorenm's avatar
lorenm committed
1947 1948 1949

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
diego's avatar
diego committed
1950
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1951 1952
     * - decoding: unused
     */
lu_zero's avatar
lu_zero committed
1953
    float crf;
lorenm's avatar
lorenm committed
1954 1955 1956

    /**
     * constant quantization parameter rate control method
diego's avatar
diego committed
1957
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1958 1959 1960 1961 1962
     * - decoding: unused
     */
    int cqp;

    /**
diego's avatar
diego committed
1963 1964
     * minimum GOP size
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1965 1966 1967 1968 1969 1970
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
diego's avatar
diego committed
1971
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1972 1973 1974 1975 1976 1977
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
diego's avatar
diego committed
1978
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1979 1980 1981 1982 1983
     * - decoding: unused
     */
    int chromaoffset;

    /**
diego's avatar
diego committed
1984 1985
     * Influences how often B-frames are used.
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1986 1987 1988 1989 1990 1991
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
diego's avatar
diego committed
1992
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
1993 1994 1995 1996 1997
     * - decoding: unused
     */
    int trellis;

    /**
diego's avatar
diego committed
1998 1999
     * Reduce fluctuations in qp (before curve compression).
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2000 2001 2002 2003 2004 2005 2006
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
diego's avatar
diego committed
2007
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2008 2009 2010 2011 2012 2013 2014
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
diego's avatar
diego committed
2015
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2016 2017 2018 2019 2020 2021
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
diego's avatar
diego committed
2022
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032
     * - decoding: unused
     */
    int partitions;
#define X264_PART_I4X4 0x001  /* Analyse i4x4 */
#define X264_PART_I8X8 0x002  /* Analyse i8x8 (requires 8x8 transform) */
#define X264_PART_P8X8 0x010  /* Analyse p16x8, p8x16 and p8x8 */
#define X264_PART_P4X4 0x020  /* Analyse p8x4, p4x8, p4x4 */
#define X264_PART_B8X8 0x100  /* Analyse b16x8, b8x16 and b8x8 */

    /**
diego's avatar
diego committed
2033 2034
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: Set by user.
lorenm's avatar
lorenm committed
2035 2036 2037
     * - decoding: unused
     */
    int directpred;
2038

2039
    /**
diego's avatar
diego committed
2040 2041
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
     * - encoding: Set by user.
2042 2043 2044
     * - decoding: unused
     */
    int cutoff;
corey's avatar
corey committed
2045 2046

    /**
diego's avatar
diego committed
2047 2048
     * Multiplied by qscale for each frame and added to scene_change_score.
     * - encoding: Set by user.
corey's avatar
corey committed
2049 2050 2051
     * - decoding: unused
     */
    int scenechange_factor;
2052 2053 2054

    /**
     *
diego's avatar
diego committed
2055 2056
     * Note: Value depends upon the compare function used for fullpel ME.
     * - encoding: Set by user.
2057 2058 2059
     * - decoding: unused
     */
    int mv0_threshold;
2060 2061

    /**
diego's avatar
diego committed
2062 2063
     * Adjusts sensitivity of b_frame_strategy 1.
     * - encoding: Set by user.
2064 2065 2066
     * - decoding: unused
     */
    int b_sensitivity;
2067 2068

    /**
diego's avatar
diego committed
2069
     * - encoding: Set by user.
2070 2071 2072 2073 2074 2075
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
diego's avatar
diego committed
2076 2077 2078
     * Sets whether to use LPC mode - used by FLAC encoder.
     * - encoding: Set by user.
     * - decoding: unused
2079 2080 2081 2082 2083
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
diego's avatar
diego committed
2084 2085
     * - encoding: Set by user.
     * - decoding: unused
2086 2087 2088 2089
     */
    int lpc_coeff_precision;

    /**
diego's avatar
diego committed
2090 2091
     * - encoding: Set by user.
     * - decoding: unused
2092 2093 2094 2095
     */
    int min_prediction_order;

    /**
diego's avatar
diego committed
2096 2097
     * - encoding: Set by user.
     * - decoding: unused
2098 2099 2100 2101 2102
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
diego's avatar
diego committed
2103 2104
     * - encoding: Set by user.
     * - decoding: unused
2105 2106 2107 2108
     */
    int prediction_order_method;

    /**
diego's avatar
diego committed
2109 2110
     * - encoding: Set by user.
     * - decoding: unused
2111 2112 2113 2114
     */
    int min_partition_order;

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

    /**
     * GOP timecode frame start number, in non drop frame format
diego's avatar
diego committed
2122 2123
     * - encoding: Set by user.
     * - decoding: unused
2124 2125
     */
    int64_t timecode_frame_start;
glantau's avatar
glantau committed
2126 2127
} AVCodecContext;

2128 2129 2130
/**
 * AVCodec.
 */
glantau's avatar
glantau committed
2131
typedef struct AVCodec {
benoit's avatar
benoit committed
2132 2133 2134 2135 2136 2137
    /**
     * 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
2138
    const char *name;
kabi's avatar
kabi committed
2139
    enum CodecType type;
michael's avatar
michael committed
2140
    enum CodecID id;
glantau's avatar
glantau committed
2141 2142
    int priv_data_size;
    int (*init)(AVCodecContext *);
kabi's avatar
kabi committed
2143
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
glantau's avatar
glantau committed
2144
    int (*close)(AVCodecContext *);
michaelni's avatar
michaelni committed
2145
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
kabi's avatar
kabi committed
2146
                  uint8_t *buf, int buf_size);
glantau's avatar
glantau committed
2147
    int capabilities;
glantau's avatar
glantau committed
2148
    struct AVCodec *next;
michaelni's avatar
michaelni committed
2149
    void (*flush)(AVCodecContext *);
kabi's avatar
kabi committed
2150
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
michael's avatar
michael committed
2151
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
glantau's avatar
glantau committed
2152 2153
} AVCodec;

kabi's avatar
kabi committed
2154
/**
2155 2156 2157
 * four components are given, that's all.
 * the last component is alpha
 */
glantau's avatar
glantau committed
2158
typedef struct AVPicture {
kabi's avatar
kabi committed
2159
    uint8_t *data[4];
michaelni's avatar
michaelni committed
2160
    int linesize[4];       ///< number of bytes per line
glantau's avatar
glantau committed
2161 2162
} AVPicture;

tmmm's avatar
tmmm committed
2163 2164 2165 2166
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
benoit's avatar
 
benoit committed
2167 2168 2169
 *
 * @deprecated Use AVPacket to send palette changes instead.
 * This is totally broken.
tmmm's avatar
tmmm committed
2170
 */
2171
#define AVPALETTE_SIZE 1024
michael's avatar
michael committed
2172
#define AVPALETTE_COUNT 256
tmmm's avatar
tmmm committed
2173 2174
typedef struct AVPaletteControl {

diego's avatar
diego committed
2175 2176
    /* Demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0. */
tmmm's avatar
tmmm committed
2177 2178
    int palette_changed;

2179 2180
    /* 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
2181 2182
     * the palette data comes from an IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled. */
2183
    unsigned int palette[AVPALETTE_COUNT];
tmmm's avatar
tmmm committed
2184

2185
} AVPaletteControl attribute_deprecated;
tmmm's avatar
tmmm committed
2186

2187
typedef struct AVSubtitleRect {
bellard's avatar
bellard committed
2188 2189 2190 2191 2192 2193 2194 2195
    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;
2196 2197 2198 2199 2200 2201 2202 2203
} 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
2204 2205 2206
} AVSubtitle;


glantau's avatar
glantau committed
2207 2208 2209
/* resample.c */

struct ReSampleContext;
2210
struct AVResampleContext;
glantau's avatar
glantau committed
2211 2212 2213

typedef struct ReSampleContext ReSampleContext;

2214
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
glantau's avatar
glantau committed
2215 2216 2217 2218
                                     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
2219
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2220
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
2221
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2222
void av_resample_close(struct AVResampleContext *c);
2223

2224
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
glantau's avatar
glantau committed
2225 2226
/* YUV420 format is assumed ! */

benoit's avatar
 
benoit committed
2227 2228 2229
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2230
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
glantau's avatar
glantau committed
2231

benoit's avatar
 
benoit committed
2232 2233 2234
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2235
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
glantau's avatar
glantau committed
2236
                                      int input_width, int input_height);
2237

benoit's avatar
 
benoit committed
2238 2239 2240
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2241
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2242 2243
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2244 2245 2246 2247
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

benoit's avatar
 
benoit committed
2248 2249 2250
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2251
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2252
                  AVPicture *output, const AVPicture *input);
glantau's avatar
glantau committed
2253

benoit's avatar
 
benoit committed
2254 2255 2256
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2257
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2258 2259

#endif
glantau's avatar
glantau committed
2260

michael's avatar
michael committed
2261 2262 2263
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
diego's avatar
diego committed
2264 2265 2266 2267 2268
 * @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
2269 2270 2271
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2272 2273 2274
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
diego's avatar
diego committed
2275
 * @param picture the AVPicture to be freed
2276
 */
michael's avatar
michael committed
2277 2278
void avpicture_free(AVPicture *picture);

2279
/**
diego's avatar
diego committed
2280
 * Fill in the AVPicture fields.
2281 2282 2283 2284 2285 2286 2287
 * 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
2288
 * @param picture AVPicture whose fields are to be filled in
2289
 * @param ptr Buffer which will contain or contains the actual image data
diego's avatar
diego committed
2290 2291 2292 2293
 * @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
2294
 */
kabi's avatar
kabi committed
2295
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2296
                   int pix_fmt, int width, int height);
2297
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
romansh's avatar
 
romansh committed
2298
                     unsigned char *dest, int dest_size);
2299 2300 2301 2302 2303

/**
 * 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
2304 2305 2306
 * @param pix_fmt the given picture format
 * @param width the width of the image
 * @param height the height of the image
2307 2308
 * @return Image data size in bytes
 */
2309
int avpicture_get_size(int pix_fmt, int width, int height);
2310 2311
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);
2312
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
romansh's avatar
 
romansh committed
2313
enum PixelFormat avcodec_get_pix_fmt(const char* name);
michael's avatar
michael committed
2314
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2315

2316 2317 2318 2319 2320 2321
#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) */
2322

2323
/**
2324 2325 2326 2327 2328 2329 2330 2331
 * 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
2332 2333
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 * which will occur when converting from one pixel format to another.
2334
 *
diego's avatar
diego committed
2335 2336
 * @param[in] dst_pix_fmt destination pixel format
 * @param[in] src_pix_fmt source pixel format
2337 2338
 * @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.
2339
 */
2340 2341
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2342 2343

/**
2344 2345 2346 2347 2348
 * 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
2349 2350
 * 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
2351 2352 2353 2354 2355 2356 2357 2358
 * \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
2359 2360
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 * @param[in] src_pix_fmt source pixel format
2361 2362 2363
 * @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.
2364
 */
2365 2366 2367
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
2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380

/**
 * Print in buf the string corresponding to the pixel format with
 * number pix_fmt, or an header if pix_fmt is negative.
 *
 * @param buf[in] the buffer where to write the string
 * @param buf_size[in] the size of buf
 * @param pix_fmt[in] the number of the pixel format to print the corresponding info string, or
 * 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
2381 2382
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2383 2384 2385 2386 2387

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

2391
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2392 2393 2394 2395
/**
 * convert among pixel formats
 * @deprecated Use the software scaler (swscale) instead.
 */
2396
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2397
                const AVPicture *src, int pix_fmt,
2398
                int width, int height);
2399
#endif
2400 2401

/* deinterlace a picture */
2402
/* deinterlace - if not supported return -1 */
2403
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
glantau's avatar
glantau committed
2404 2405 2406 2407 2408 2409
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

nickols_k's avatar
nickols_k committed
2410
/* returns LIBAVCODEC_VERSION_INT constant */
2411
unsigned avcodec_version(void);
nickols_k's avatar
nickols_k committed
2412
/* returns LIBAVCODEC_BUILD constant */
2413
unsigned avcodec_build(void);
takis's avatar
takis committed
2414 2415 2416 2417 2418 2419 2420

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

void register_avcodec(AVCodec *format);
takis's avatar
takis committed
2424 2425 2426 2427

/**
 * Finds an encoder with a matching codec ID.
 *
diego's avatar
diego committed
2428
 * @param id CodecID of the requested encoder
takis's avatar
takis committed
2429 2430
 * @return An encoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2431
AVCodec *avcodec_find_encoder(enum CodecID id);
takis's avatar
takis committed
2432 2433 2434 2435

/**
 * Finds an encoder with the specified name.
 *
diego's avatar
diego committed
2436
 * @param name name of the requested encoder
takis's avatar
takis committed
2437 2438
 * @return An encoder if one was found, NULL otherwise.
 */
2439
AVCodec *avcodec_find_encoder_by_name(const char *name);
takis's avatar
takis committed
2440 2441 2442 2443

/**
 * Finds a decoder with a matching codec ID.
 *
diego's avatar
diego committed
2444
 * @param id CodecID of the requested decoder
takis's avatar
takis committed
2445 2446
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2447
AVCodec *avcodec_find_decoder(enum CodecID id);
takis's avatar
takis committed
2448 2449 2450 2451

/**
 * Finds an decoder with the specified name.
 *
diego's avatar
diego committed
2452
 * @param name name of the requested decoder
takis's avatar
takis committed
2453 2454
 * @return A decoder if one was found, NULL otherwise.
 */
glantau's avatar
glantau committed
2455 2456 2457
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
2458 2459 2460 2461 2462
/**
 * 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
2463
void avcodec_get_context_defaults(AVCodecContext *s);
takis's avatar
takis committed
2464

2465 2466 2467 2468
/** 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
2469 2470 2471 2472 2473 2474 2475
/**
 * 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
2476
AVCodecContext *avcodec_alloc_context(void);
takis's avatar
takis committed
2477

2478 2479 2480 2481
/** 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
2482 2483 2484 2485 2486
/**
 * 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
2487
void avcodec_get_frame_defaults(AVFrame *pic);
takis's avatar
takis committed
2488 2489 2490 2491 2492 2493 2494 2495

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

michaelni's avatar
michaelni committed
2498 2499
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
michael's avatar
michael committed
2500 2501
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
takis's avatar
takis committed
2502 2503 2504 2505 2506 2507 2508 2509 2510

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

michael's avatar
1l  
michael committed
2514 2515 2516
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
2517
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2518 2519
//FIXME func typedef

michaelni's avatar
michaelni committed
2520
/**
takis's avatar
takis committed
2521 2522 2523 2524 2525 2526 2527
 * 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
2528
 * @warning This function is not thread safe!
takis's avatar
takis committed
2529 2530
 *
 * @code
2531
 * avcodec_register_all();
takis's avatar
takis committed
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541
 * 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
2542
 * @param avctx The context which will be set up to use the given codec.
takis's avatar
takis committed
2543
 * @param codec The codec to use within the context.
diego's avatar
diego committed
2544
 * @return zero on success, a negative value on error
takis's avatar
takis committed
2545
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
michaelni's avatar
michaelni committed
2546
 */
glantau's avatar
glantau committed
2547
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
michaelni's avatar
michaelni committed
2548

takis's avatar
takis committed
2549 2550 2551
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
michael's avatar
michael committed
2552 2553 2554
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
                         uint8_t *buf, int buf_size);
takis's avatar
takis committed
2555

2556
/**
takis's avatar
takis committed
2557
 * Decodes an audio frame from \p buf into \p samples.
diego's avatar
diego committed
2558
 * The avcodec_decode_audio2() function decodes an audio frame from the input
takis's avatar
takis committed
2559
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2560
 * audio codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
 * 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.
2574
 *
takis's avatar
takis committed
2575
 * @note You might have to align the input buffer \p buf and output buffer \p
diego's avatar
diego committed
2576
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
takis's avatar
takis committed
2577 2578 2579 2580 2581 2582 2583
 * 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
2584 2585 2586 2587 2588
 * @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
2589 2590
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
2591
 */
michael's avatar
michael committed
2592
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
glantau's avatar
glantau committed
2593
                         int *frame_size_ptr,
kabi's avatar
kabi committed
2594
                         uint8_t *buf, int buf_size);
takis's avatar
takis committed
2595 2596 2597

/**
 * Decodes a video frame from \p buf into \p picture.
diego's avatar
diego committed
2598
 * The avcodec_decode_video() function decodes a video frame from the input
takis's avatar
takis committed
2599
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
diego's avatar
diego committed
2600
 * video codec which was coupled with \p avctx using avcodec_open(). The
takis's avatar
takis committed
2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618
 * 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
2619
 * @param avctx the codec context
takis's avatar
takis committed
2620
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
diego's avatar
diego committed
2621 2622 2623
 * @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
2624 2625 2626
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
 */
2627
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
glantau's avatar
glantau committed
2628
                         int *got_picture_ptr,
kabi's avatar
kabi committed
2629
                         uint8_t *buf, int buf_size);
2630

diego's avatar
diego committed
2631 2632 2633
/* 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
2634 2635 2636
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2637
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2638
                        int *data_size_ptr,
kabi's avatar
kabi committed
2639
                        uint8_t *buf, int buf_size);
takis's avatar
takis committed
2640 2641 2642

/**
 * Encodes an audio frame from \p samples into \p buf.
diego's avatar
diego committed
2643 2644
 * 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
2645 2646 2647 2648 2649
 * 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
2650 2651 2652 2653
 * @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
takis's avatar
takis committed
2654 2655 2656
 * @return On error a negative value is returned, on succes zero or the number
 * of bytes used from the input buffer.
 */
2657
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
glantau's avatar
glantau committed
2658
                         const short *samples);
takis's avatar
takis committed
2659 2660 2661

/**
 * Encodes a video frame from \p pict into \p buf.
diego's avatar
diego committed
2662 2663
 * 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
2664 2665 2666 2667
 * \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
2668 2669 2670 2671
 * @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
2672 2673 2674
 * @return On error a negative value is returned, on success zero or the number
 * of bytes used from the input buffer.
 */
2675
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
michaelni's avatar
michaelni committed
2676
                         const AVFrame *pict);
2677
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
bellard's avatar
bellard committed
2678
                            const AVSubtitle *sub);
glantau's avatar
glantau committed
2679 2680 2681 2682

int avcodec_close(AVCodecContext *avctx);

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

2684 2685 2686
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
michaelni's avatar
michaelni committed
2687 2688
void avcodec_flush_buffers(AVCodecContext *avctx);

2689 2690
void avcodec_default_free_buffers(AVCodecContext *s);

takis's avatar
takis committed
2691
/* misc useful functions */
michaelni's avatar
michaelni committed
2692 2693

/**
2694 2695
 * Returns a single letter to describe the given picture type \p pict_type.
 *
diego's avatar
diego committed
2696
 * @param[in] pict_type the picture type
2697
 * @return A single character representing the picture type.
michaelni's avatar
michaelni committed
2698 2699 2700
 */
char av_get_pict_type_char(int pict_type);

2701
/**
2702 2703
 * Returns codec bits per sample.
 *
diego's avatar
diego committed
2704
 * @param[in] codec_id the codec
2705
 * @return Number of bits per sample or zero if unknown for the given codec.
2706 2707
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2708

conrad's avatar
conrad committed
2709 2710 2711 2712 2713 2714 2715 2716
/**
 * 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
2717 2718 2719 2720 2721
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2722
    int64_t cur_offset; /* current offset
bellard's avatar
bellard committed
2723 2724 2725
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
diego's avatar
diego committed
2726 2727
    int pict_type; /* XXX: Put it back in AVCodecContext. */
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
bellard's avatar
bellard committed
2728 2729 2730 2731 2732 2733
    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
2734
    int fetch_timestamp;
bellard's avatar
bellard committed
2735 2736 2737 2738 2739 2740

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

michael's avatar
michael committed
2742 2743
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
benoit's avatar
 
benoit committed
2744 2745 2746

    int64_t offset;      ///< byte offset from starting packet start
    int64_t last_offset;
bellard's avatar
bellard committed
2747 2748 2749
} AVCodecParserContext;

typedef struct AVCodecParser {
michael's avatar
michael committed
2750
    int codec_ids[5]; /* several codec IDs are permitted */
bellard's avatar
bellard committed
2751 2752
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2753
    int (*parser_parse)(AVCodecParserContext *s,
bellard's avatar
bellard committed
2754
                        AVCodecContext *avctx,
2755
                        const uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2756 2757
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2758
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
bellard's avatar
bellard committed
2759 2760 2761 2762 2763 2764 2765
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2766
int av_parser_parse(AVCodecParserContext *s,
bellard's avatar
bellard committed
2767
                    AVCodecContext *avctx,
2768
                    uint8_t **poutbuf, int *poutbuf_size,
bellard's avatar
bellard committed
2769 2770
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2771 2772
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2773
                     uint8_t **poutbuf, int *poutbuf_size,
2774
                     const uint8_t *buf, int buf_size, int keyframe);
bellard's avatar
bellard committed
2775 2776
void av_parser_close(AVCodecParserContext *s);

2777 2778

typedef struct AVBitStreamFilterContext {
michael's avatar
michael committed
2779
    void *priv_data;
2780 2781 2782 2783 2784 2785 2786 2787
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
michael's avatar
michael committed
2788
    int priv_data_size;
2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
    struct AVBitStreamFilter *next;
} AVBitStreamFilter;

extern AVBitStreamFilter *av_first_bitstream_filter;

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


bellard's avatar
bellard committed
2807
/* memory */
2808 2809

/**
2810 2811 2812 2813
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
2814
 */
kabi's avatar
kabi committed
2815
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2816

2817
/* for static data only */
2818 2819

/**
diego's avatar
diego committed
2820
 * Frees all static arrays and resets their pointers to 0.
2821
 * Call this function to release all statically allocated tables.
benoit's avatar
 
benoit committed
2822
 *
diego's avatar
diego committed
2823
 * @deprecated. Code which uses av_free_static is broken/misdesigned
benoit's avatar
 
benoit committed
2824 2825
 * and should correctly use static arrays
 *
2826
 */
michael's avatar
michael committed
2827
attribute_deprecated void av_free_static(void);
2828 2829

/**
2830 2831 2832 2833 2834
 * 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
2835
 * @return block of memory of the requested size
diego's avatar
diego committed
2836
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
benoit's avatar
 
benoit committed
2837
 * and should correctly use static arrays
2838
 */
michael's avatar
michael committed
2839
attribute_deprecated void *av_mallocz_static(unsigned int size);
2840

2841 2842 2843
/**
 * Copy image 'src' to 'dst'.
 */
2844
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2845 2846
              int pix_fmt, int width, int height);

2847
/**
diego's avatar
diego committed
2848
 * Crop image top and left side.
2849
 */
2850
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2851 2852
             int pix_fmt, int top_band, int left_band);

2853
/**
diego's avatar
diego committed
2854
 * Pad image.
2855
 */
2856
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2857 2858
            int padtop, int padbottom, int padleft, int padright, int *color);

2859
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
benoit's avatar
 
benoit committed
2860 2861 2862
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2863 2864 2865
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

benoit's avatar
 
benoit committed
2866 2867 2868
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2869 2870 2871
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

benoit's avatar
 
benoit committed
2872 2873 2874
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2875 2876 2877 2878
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
2879 2880
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

2881 2882 2883
/**
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
 *
diego's avatar
diego committed
2884
 * @return 0 in case of a successful parsing, a negative value otherwise
2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896
 * @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
2897
 * @return 0 in case of a successful parsing, a negative value otherwise
2898 2899 2900 2901 2902 2903 2904
 * @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);

2905 2906
/* error handling */
#if EINVAL > 0
diego's avatar
diego committed
2907 2908
#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. */
2909
#else
diego's avatar
diego committed
2910
/* Some platforms have E* and errno already negated. */
2911 2912 2913 2914
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
diego's avatar
diego committed
2915 2916
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2917 2918 2919
#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
2920
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
benoit's avatar
 
benoit committed
2921
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
ramiro's avatar
ramiro committed
2922
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2923

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