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

F
Fabrice Bellard 已提交
21 22 23
#ifndef AVCODEC_H
#define AVCODEC_H

M
Michael Niedermayer 已提交
24 25
/**
 * @file avcodec.h
D
Diego Biurrun 已提交
26
 * external API header
M
Michael Niedermayer 已提交
27 28 29
 */


30
#include "avutil.h"
Z
Zdenek Kabelac 已提交
31
#include <sys/types.h> /* size_t */
F
Fabrice Bellard 已提交
32

33
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
F
Fabrice Bellard 已提交
34
#define AV_TOSTRING(s) #s
M
Michael Niedermayer 已提交
35

B
Benjamin Larsson 已提交
36 37
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(40<<8)+4)
#define LIBAVCODEC_VERSION      51.40.4
38
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
M
Michael Niedermayer 已提交
39

40
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
A
Alex Beregszaszi 已提交
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

46
/**
N
Nicolas George 已提交
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.
53
 *
D
Diego Biurrun 已提交
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.
57
 */
F
Fabrice Bellard 已提交
58
enum CodecID {
59
    CODEC_ID_NONE,
F
Fabrice Bellard 已提交
60
    CODEC_ID_MPEG1VIDEO,
D
Diego Biurrun 已提交
61
    CODEC_ID_MPEG2VIDEO, /* preferred ID for MPEG-1/2 video decoding */
I
Ivan Kalvachev 已提交
62
    CODEC_ID_MPEG2VIDEO_XVMC,
63
    CODEC_ID_H261,
F
Fabrice Bellard 已提交
64 65
    CODEC_ID_H263,
    CODEC_ID_RV10,
M
Michael Niedermayer 已提交
66
    CODEC_ID_RV20,
F
Fabrice Bellard 已提交
67
    CODEC_ID_MJPEG,
68
    CODEC_ID_MJPEGB,
69
    CODEC_ID_LJPEG,
70
    CODEC_ID_SP5X,
71
    CODEC_ID_JPEGLS,
F
Fabrice Bellard 已提交
72
    CODEC_ID_MPEG4,
F
Fabrice Bellard 已提交
73
    CODEC_ID_RAWVIDEO,
74 75 76
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
77
    CODEC_ID_WMV1,
M
Michael Niedermayer 已提交
78
    CODEC_ID_WMV2,
F
Fabrice Bellard 已提交
79 80
    CODEC_ID_H263P,
    CODEC_ID_H263I,
81
    CODEC_ID_FLV1,
N
Nick Kurshev 已提交
82
    CODEC_ID_SVQ1,
M
Michael Niedermayer 已提交
83
    CODEC_ID_SVQ3,
F
Fabrice Bellard 已提交
84
    CODEC_ID_DVVIDEO,
M
huffyuv  
Michael Niedermayer 已提交
85
    CODEC_ID_HUFFYUV,
86
    CODEC_ID_CYUV,
M
Michael Niedermayer 已提交
87
    CODEC_ID_H264,
88
    CODEC_ID_INDEO3,
89
    CODEC_ID_VP3,
90
    CODEC_ID_THEORA,
M
Michael Niedermayer 已提交
91
    CODEC_ID_ASV1,
M
Michael Niedermayer 已提交
92
    CODEC_ID_ASV2,
93
    CODEC_ID_FFV1,
94
    CODEC_ID_4XM,
M
Michael Niedermayer 已提交
95
    CODEC_ID_VCR1,
A
Alex Beregszaszi 已提交
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,
107
    CODEC_ID_IDCIN,
R
Roberto Togni 已提交
108
    CODEC_ID_8BPS,
M
Mike Melanson 已提交
109
    CODEC_ID_SMC,
M
Mike Melanson 已提交
110
    CODEC_ID_FLIC,
111
    CODEC_ID_TRUEMOTION1,
112
    CODEC_ID_VMDVIDEO,
R
Roberto Togni 已提交
113 114
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
115
    CODEC_ID_QTRLE,
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,
L
Loren Merritt 已提交
129
    CODEC_ID_FFVHUFF,
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,
M
Måns Rullgård 已提交
140
    CODEC_ID_BMP,
141
    CODEC_ID_CSCD,
142
    CODEC_ID_MMVIDEO,
143
    CODEC_ID_ZMBV,
144
    CODEC_ID_AVS,
K
Kostya Shishkov 已提交
145
    CODEC_ID_SMACKVIDEO,
146
    CODEC_ID_NUV,
147
    CODEC_ID_KMVC,
148
    CODEC_ID_FLASHSV,
149
    CODEC_ID_CAVS,
150
    CODEC_ID_JPEG2000,
151
    CODEC_ID_VMNC,
A
Aurelien Jacobs 已提交
152 153 154
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
K
Kostya Shishkov 已提交
155
    CODEC_ID_TARGA,
156
    CODEC_ID_DSICINVIDEO,
157
    CODEC_ID_TIERTEXSEQVIDEO,
K
Kostya Shishkov 已提交
158
    CODEC_ID_TIFF,
159
    CODEC_ID_GIF,
160
    CODEC_ID_FFH264,
K
Kostya Shishkov 已提交
161
    CODEC_ID_DXA,
B
Baptiste Coudurier 已提交
162
    CODEC_ID_DNXHD,
163
    CODEC_ID_THP,
164
    CODEC_ID_SGI,
165
    CODEC_ID_C93,
166
    CODEC_ID_BETHSOFTVID,
I
Ivo van Poorten 已提交
167
    CODEC_ID_PTX,
I
Ivo van Poorten 已提交
168
    CODEC_ID_TXD,
F
Fabrice Bellard 已提交
169

D
Diego Biurrun 已提交
170
    /* various PCM "codecs" */
171
    CODEC_ID_PCM_S16LE= 0x10000,
F
Fabrice Bellard 已提交
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

D
Diego Biurrun 已提交
189
    /* various ADPCM codecs */
190
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
191
    CODEC_ID_ADPCM_IMA_WAV,
192 193
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
194
    CODEC_ID_ADPCM_IMA_WS,
195
    CODEC_ID_ADPCM_IMA_SMJPEG,
196
    CODEC_ID_ADPCM_MS,
197
    CODEC_ID_ADPCM_4XM,
198 199
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
200
    CODEC_ID_ADPCM_EA,
201
    CODEC_ID_ADPCM_G726,
202
    CODEC_ID_ADPCM_CT,
203
    CODEC_ID_ADPCM_SWF,
204
    CODEC_ID_ADPCM_YAMAHA,
205 206 207
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
208
    CODEC_ID_ADPCM_THP,
209

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

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

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

224
    CODEC_ID_MP2= 0x15000,
D
Diego Biurrun 已提交
225
    CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
226
    CODEC_ID_AAC,
227
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
228
    CODEC_ID_MPEG4AAC,
229
#endif
230 231 232 233 234 235 236 237 238 239 240
    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,
M
Michael Niedermayer 已提交
241
    CODEC_ID_FLAC,
R
Roberto Togni 已提交
242
    CODEC_ID_MP3ADU,
243
    CODEC_ID_MP3ON4,
244
    CODEC_ID_SHORTEN,
M
Michael Niedermayer 已提交
245
    CODEC_ID_ALAC,
246
    CODEC_ID_WESTWOOD_SND1,
D
Diego Biurrun 已提交
247
    CODEC_ID_GSM, /* as in Berlin toast format */
R
Roberto Togni 已提交
248
    CODEC_ID_QDM2,
249
    CODEC_ID_COOK,
250
    CODEC_ID_TRUESPEECH,
251
    CODEC_ID_TTA,
K
Kostya Shishkov 已提交
252
    CODEC_ID_SMACKAUDIO,
B
Benjamin Larsson 已提交
253
    CODEC_ID_QCELP,
K
Kostya Shishkov 已提交
254
    CODEC_ID_WAVPACK,
255
    CODEC_ID_DSICINAUDIO,
K
Kostya Shishkov 已提交
256
    CODEC_ID_IMC,
K
Kostya Shishkov 已提交
257
    CODEC_ID_MUSEPACK7,
258
    CODEC_ID_MLP,
D
Diego Biurrun 已提交
259
    CODEC_ID_GSM_MS, /* as found in WAV */
B
Benjamin Larsson 已提交
260
    CODEC_ID_ATRAC3,
261

F
Fabrice Bellard 已提交
262
    /* subtitle codecs */
263 264
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
265
    CODEC_ID_TEXT,  /* raw UTF-8 text */
266

D
Diego Biurrun 已提交
267 268
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
                                * stream (only used by libavformat) */
F
Fabrice Bellard 已提交
269
};
270

271
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
D
Diego Biurrun 已提交
272
/* CODEC_ID_MP3LAME is obsolete */
273
#define CODEC_ID_MP3LAME CODEC_ID_MP3
274 275
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
F
Fabrice Bellard 已提交
276 277

enum CodecType {
278
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
279 280
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
281
    CODEC_TYPE_DATA,
F
Fabrice Bellard 已提交
282
    CODEC_TYPE_SUBTITLE,
283
    CODEC_TYPE_NB
F
Fabrice Bellard 已提交
284 285
};

D
Diego Biurrun 已提交
286 287
/* Currently unused, may be used if 24/32 bits samples are ever supported. */
/* all in native-endian format */
F
Fabrice Bellard 已提交
288
enum SampleFormat {
289
    SAMPLE_FMT_NONE = -1,
290 291 292
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
293
    SAMPLE_FMT_S32,             ///< signed 32 bits
294
    SAMPLE_FMT_FLT,             ///< float
F
Fabrice Bellard 已提交
295 296
};

F
Fabrice Bellard 已提交
297
/* in bytes */
298
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
F
Fabrice Bellard 已提交
299

300
/**
301
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
D
Diego Biurrun 已提交
302 303 304 305
 * 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.
306 307 308
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

309
/**
D
Diego Biurrun 已提交
310 311
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
312 313 314
 */
#define FF_MIN_BUFFER_SIZE 16384

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

M
Michael Niedermayer 已提交
328
enum AVDiscard{
D
Diego Biurrun 已提交
329 330
    /* We leave some space between them for extensions (drop some
     * keyframes for intra-only or drop just some bidir frames). */
M
Michael Niedermayer 已提交
331 332 333 334 335 336 337 338
    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
};

M
Michael Niedermayer 已提交
339 340 341
typedef struct RcOverride{
    int start_frame;
    int end_frame;
D
Diego Biurrun 已提交
342
    int qscale; // If this is 0 then quality_factor will be used instead.
M
Michael Niedermayer 已提交
343 344 345
    float quality_factor;
} RcOverride;

346
#define FF_MAX_B_FRAMES 16
347

M
Michael Niedermayer 已提交
348
/* encoding support
D
Diego Biurrun 已提交
349 350
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
M
Michael Niedermayer 已提交
351
*/
F
Fabrice Bellard 已提交
352

D
Diego Biurrun 已提交
353 354 355 356 357 358 359 360 361
#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. */
362
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
D
Diego Biurrun 已提交
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
#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).
378
/* Fx : Flag for h263+ extra options */
379
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
D
Diego Biurrun 已提交
380
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
381
#endif
D
Diego Biurrun 已提交
382 383 384 385 386
#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
M
Michael Niedermayer 已提交
387 388
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
M
Michael Niedermayer 已提交
389 390
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
D
Diego Biurrun 已提交
391
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
B
Baptiste Coudurier 已提交
392
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
D
Diego Biurrun 已提交
393 394 395 396 397 398
#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
399
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
R
Robert Swain 已提交
400 401 402
#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
D
Diego Biurrun 已提交
403 404 405 406 407 408 409
#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.
410

411
/* Unsupported options :
412 413
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
414
 *              Independent Segment Decoding */
415
/* /Fx */
F
Fabrice Bellard 已提交
416 417
/* codec capabilities */

D
Diego Biurrun 已提交
418
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
M
Michael Niedermayer 已提交
419 420 421 422 423
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
D
Diego Biurrun 已提交
424
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
425
#define CODEC_CAP_PARSE_ONLY      0x0004
426
#define CODEC_CAP_TRUNCATED       0x0008
D
Diego Biurrun 已提交
427
/* Codec can export data for HW decoding (XvMC). */
428
#define CODEC_CAP_HWACCEL         0x0010
429
/**
D
Diego Biurrun 已提交
430 431
 * 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.
432
 */
433
#define CODEC_CAP_DELAY           0x0020
434 435 436 437 438
/**
 * 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
F
Fabrice Bellard 已提交
439

D
Diego Biurrun 已提交
440
//The following defines may change, don't expect compatibility if you use them.
441
#define MB_TYPE_INTRA4x4   0x0001
D
Diego Biurrun 已提交
442 443
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
#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, ...)

464 465
/**
 * Pan Scan area.
D
Diego Biurrun 已提交
466 467
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
468 469 470
 */
typedef struct AVPanScan{
    /**
D
Diego Biurrun 已提交
471 472 473
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
474 475 476 477 478
     */
    int id;

    /**
     * width and height in 1/16 pel
D
Diego Biurrun 已提交
479 480
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
481 482 483 484 485
     */
    int width;
    int height;

    /**
D
Diego Biurrun 已提交
486 487 488
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
489 490 491 492
     */
    int16_t position[3][2];
}AVPanScan;

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

701 702 703
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
M
Michael Niedermayer 已提交
704 705

#define FF_BUFFER_TYPE_INTERNAL 1
D
Diego Biurrun 已提交
706 707 708
#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.
M
Michael Niedermayer 已提交
709

M
cleanup  
Michael Niedermayer 已提交
710

711 712 713 714
#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
M
Michael Niedermayer 已提交
715 716
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
717

D
Diego Biurrun 已提交
718 719 720 721
#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).
722

M
Michael Niedermayer 已提交
723 724 725
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
726 727 728
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
729

730
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
731 732

/**
D
Diego Biurrun 已提交
733
 * main external API structure
M
doxy  
Michael Niedermayer 已提交
734
 */
F
Fabrice Bellard 已提交
735
typedef struct AVCodecContext {
736
    /**
D
Diego Biurrun 已提交
737
     * information on struct for av_log
738 739
     * - set by avcodec_alloc_context
     */
M
Michael Niedermayer 已提交
740
    AVClass *av_class;
741
    /**
D
Diego Biurrun 已提交
742 743 744
     * 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.
745
     */
F
Fabrice Bellard 已提交
746
    int bit_rate;
747 748

    /**
749
     * number of bits the bitstream is allowed to diverge from the reference.
750
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
D
Diego Biurrun 已提交
751
     * - encoding: Set by user; unused for constant quantizer encoding.
752
     * - decoding: unused
753
     */
754
    int bit_rate_tolerance;
755 756

    /**
757
     * CODEC_FLAG_*.
D
Diego Biurrun 已提交
758 759
     * - encoding: Set by user.
     * - decoding: Set by user.
760
     */
F
Fabrice Bellard 已提交
761
    int flags;
762 763

    /**
D
Diego Biurrun 已提交
764 765 766 767 768 769
     * 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?)
770 771 772 773
     */
    int sub_id;

    /**
D
Diego Biurrun 已提交
774
     * Motion estimation algorithm used for video coding.
R
Robert Swain 已提交
775 776
     * 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]
777 778
     * - encoding: MUST be set by user.
     * - decoding: unused
779 780 781 782
     */
    int me_method;

    /**
D
Diego Biurrun 已提交
783 784
     * some codecs need / can use extradata like Huffman tables.
     * mjpeg: Huffman tables
785
     * rv10: additional flags
786
     * mpeg4: global headers (they can be in the bitstream or here)
D
Diego Biurrun 已提交
787 788 789 790 791
     * 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.
792
     */
793
    uint8_t *extradata;
794
    int extradata_size;
795

796
    /**
D
Diego Biurrun 已提交
797 798
     * This is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. For fixed-fps content,
799 800
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
D
Diego Biurrun 已提交
801 802
     * - encoding: MUST be set by user.
     * - decoding: Set by libavcodec.
803
     */
804
    AVRational time_base;
805

806
    /* video only */
807
    /**
808
     * picture width / height.
809
     * - encoding: MUST be set by user.
D
Diego Biurrun 已提交
810 811 812
     * - decoding: Set by libavcodec.
     * Note: For compatibility it is possible to set this instead of
     * coded_width/height before decoding.
813
     */
F
Fabrice Bellard 已提交
814
    int width, height;
815

816
#define FF_ASPECT_EXTENDED 15
817 818

    /**
D
Diego Biurrun 已提交
819 820
     * the number of pictures in a group of pictures, or 0 for intra_only
     * - encoding: Set by user.
821
     * - decoding: unused
822 823 824 825
     */
    int gop_size;

    /**
D
Diego Biurrun 已提交
826 827 828
     * Pixel format, see PIX_FMT_xxx.
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
829
     */
830
    enum PixelFormat pix_fmt;
831

832
    /**
D
Diego Biurrun 已提交
833
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
834
     * has to read frames at native frame rate.
D
Diego Biurrun 已提交
835 836
     * - encoding: Set by user.
     * - decoding: unused
837 838
     */
    int rate_emu;
839

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

F
Fabrice Bellard 已提交
856
    /* audio only */
D
Diego Biurrun 已提交
857
    int sample_rate; ///< samples per second
F
Fabrice Bellard 已提交
858
    int channels;
859 860

    /**
D
Diego Biurrun 已提交
861 862 863
     * audio sample format
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
864
     */
D
Diego Biurrun 已提交
865
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
F
Fabrice Bellard 已提交
866

D
Diego Biurrun 已提交
867
    /* The following data should not be initialized. */
868
    /**
D
Diego Biurrun 已提交
869
     * Samples per packet, initialized when calling 'init'.
870 871
     */
    int frame_size;
872
    int frame_number;   ///< audio or video frame number
D
Diego Biurrun 已提交
873
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
874

875
    /**
D
Diego Biurrun 已提交
876
     * Number of frames the decoded output will be delayed relative to
877
     * the encoded input.
D
Diego Biurrun 已提交
878
     * - encoding: Set by libavcodec.
879
     * - decoding: unused
880 881
     */
    int delay;
882

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

887
    /**
D
Diego Biurrun 已提交
888 889
     * minimum quantizer
     * - encoding: Set by user.
890
     * - decoding: unused
891 892 893 894
     */
    int qmin;

    /**
D
Diego Biurrun 已提交
895 896
     * maximum quantizer
     * - encoding: Set by user.
897
     * - decoding: unused
898 899 900 901
     */
    int qmax;

    /**
D
Diego Biurrun 已提交
902 903
     * maximum quantizer difference between frames
     * - encoding: Set by user.
904
     * - decoding: unused
905 906 907 908
     */
    int max_qdiff;

    /**
D
Diego Biurrun 已提交
909 910 911
     * 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.
912
     * - decoding: unused
913 914 915 916
     */
    int max_b_frames;

    /**
D
Diego Biurrun 已提交
917 918
     * qscale factor between IP and B-frames
     * - encoding: Set by user.
919
     * - decoding: unused
920 921
     */
    float b_quant_factor;
922

923 924
    /** obsolete FIXME remove */
    int rc_strategy;
M
Michael Niedermayer 已提交
925 926
#define FF_RC_STRATEGY_XVID 1

927
    int b_frame_strategy;
928

929
    /**
D
Diego Biurrun 已提交
930
     * hurry up amount
931
     * - encoding: unused
D
Diego Biurrun 已提交
932
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
933
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
934 935
     */
    int hurry_up;
936

F
Fabrice Bellard 已提交
937
    struct AVCodec *codec;
938

F
Fabrice Bellard 已提交
939 940
    void *priv_data;

941
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
M
Michael Niedermayer 已提交
942 943
    /* unused, FIXME remove*/
    int rtp_mode;
944
#endif
945

D
Diego Biurrun 已提交
946
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
D
Diego Biurrun 已提交
947
                            /* do its best to deliver a chunk with size     */
948
                            /* below rtp_payload_size, the chunk will start */
D
Diego Biurrun 已提交
949
                            /* with a start code on some codecs like H.263. */
950
                            /* This doesn't take account of any particular  */
D
Diego Biurrun 已提交
951
                            /* headers inside the transmitted RTP payload.  */
952

953

D
Diego Biurrun 已提交
954 955 956 957 958 959
    /* 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.                  */
960
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
961

962 963 964 965 966 967 968 969
    /* 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;
970
    int misc_bits;
971

972
    /**
D
Diego Biurrun 已提交
973 974
     * number of bits used for the previously encoded frame
     * - encoding: Set by libavcodec.
975
     * - decoding: unused
976
     */
977
    int frame_bits;
978

979
    /**
D
Diego Biurrun 已提交
980 981 982
     * Private data of the user, can be used to carry app specific stuff.
     * - encoding: Set by user.
     * - decoding: Set by user.
983 984 985
     */
    void *opaque;

F
Fabrice Bellard 已提交
986
    char codec_name[32];
987 988
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
989

990 991
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
D
Diego Biurrun 已提交
992 993 994 995 996 997
     * 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
M
Michael Niedermayer 已提交
998
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
D
Diego Biurrun 已提交
999 1000 1001
     * 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.
1002 1003
     */
    unsigned int codec_tag;
1004

1005
    /**
D
Diego Biurrun 已提交
1006 1007 1008
     * Work around bugs in encoders which sometimes cannot be detected automatically.
     * - encoding: Set by user
     * - decoding: Set by user
1009 1010
     */
    int workaround_bugs;
1011
#define FF_BUG_AUTODETECT       1  ///< autodetection
1012 1013 1014 1015
#define FF_BUG_OLD_MSMPEG4      2
#define FF_BUG_XVID_ILACE       4
#define FF_BUG_UMP4             8
#define FF_BUG_NO_PADDING       16
M
Michael Niedermayer 已提交
1016
#define FF_BUG_AMV              32
D
Diego Biurrun 已提交
1017
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
M
Michael Niedermayer 已提交
1018
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
1019
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
1020
#define FF_BUG_QPEL_CHROMA2     256
1021
#define FF_BUG_DIRECT_BLOCKSIZE 512
1022
#define FF_BUG_EDGE             1024
1023
#define FF_BUG_HPEL_CHROMA      2048
1024
#define FF_BUG_DC_CLIP          4096
D
Diego Biurrun 已提交
1025 1026
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1027

1028
    /**
D
Diego Biurrun 已提交
1029 1030
     * luma single coefficient elimination threshold
     * - encoding: Set by user.
1031
     * - decoding: unused
1032
     */
1033
    int luma_elim_threshold;
1034

1035
    /**
D
Diego Biurrun 已提交
1036 1037
     * chroma single coeff elimination threshold
     * - encoding: Set by user.
1038
     * - decoding: unused
1039
     */
1040
    int chroma_elim_threshold;
1041

1042
    /**
D
Diego Biurrun 已提交
1043 1044
     * strictly follow the standard (MPEG4, ...).
     * - encoding: Set by user.
1045
     * - decoding: unused
1046 1047
     */
    int strict_std_compliance;
D
Diego Biurrun 已提交
1048 1049
#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.
1050
#define FF_COMPLIANCE_NORMAL        0
D
Diego Biurrun 已提交
1051 1052
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1053

1054
    /**
D
Diego Biurrun 已提交
1055 1056 1057 1058
     * 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.
1059
     * - decoding: unused
1060 1061
     */
    float b_quant_offset;
1062

1063
    /**
D
Diego Biurrun 已提交
1064 1065
     * Error resilience; higher values will detect more errors but may
     * misdetect some more or less valid parts as errors.
1066
     * - encoding: unused
D
Diego Biurrun 已提交
1067
     * - decoding: Set by user.
1068
     */
1069
    int error_resilience;
D
Diego Biurrun 已提交
1070
#define FF_ER_CAREFUL         1
1071 1072 1073
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1074

1075
    /**
D
Diego Biurrun 已提交
1076 1077
     * 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.
1078
     * avcodec_align_dimensions() should be used to find the required width and
D
Diego Biurrun 已提交
1079
     * height, as they normally need to be rounded up to the next multiple of 16.
1080
     * - encoding: unused
D
Diego Biurrun 已提交
1081
     * - decoding: Set by libavcodec., user can override.
1082
     */
M
Michael Niedermayer 已提交
1083
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1084

1085
    /**
D
Diego Biurrun 已提交
1086 1087 1088
     * 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.
1089
     * - encoding: unused
D
Diego Biurrun 已提交
1090
     * - decoding: Set by libavcodec., user can override.
1091
     */
M
Michael Niedermayer 已提交
1092
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1093

1094
    /**
D
Diego Biurrun 已提交
1095 1096 1097
     * If 1 the stream has a 1 frame delay during decoding.
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
1098 1099
     */
    int has_b_frames;
1100 1101 1102

    /**
     * number of bytes per packet if constant and known or 0
D
Diego Biurrun 已提交
1103
     * Used by some WAV based audio codecs.
1104 1105
     */
    int block_align;
1106

D
Diego Biurrun 已提交
1107
    int parse_only; /* - decoding only: If true, only parsing is done
1108 1109
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1110

1111
    /**
D
Diego Biurrun 已提交
1112 1113
     * 0-> h263 quant 1-> mpeg quant
     * - encoding: Set by user.
1114
     * - decoding: unused
1115 1116
     */
    int mpeg_quant;
1117

1118
    /**
D
Diego Biurrun 已提交
1119 1120
     * pass1 encoding statistics output buffer
     * - encoding: Set by libavcodec.
1121
     * - decoding: unused
1122
     */
1123
    char *stats_out;
1124

1125
    /**
D
Diego Biurrun 已提交
1126 1127 1128
     * pass2 encoding statistics input buffer
     * Concatenated stuff from stats_out of pass1 should be placed here.
     * - encoding: Allocated/set/freed by user.
1129
     * - decoding: unused
1130 1131
     */
    char *stats_in;
1132

1133
    /**
D
Diego Biurrun 已提交
1134 1135 1136
     * ratecontrol qmin qmax limiting method
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
     * - encoding: Set by user.
1137
     * - decoding: unused
1138
     */
M
Michael Niedermayer 已提交
1139
    float rc_qsquish;
1140

M
Michael Niedermayer 已提交
1141 1142
    float rc_qmod_amp;
    int rc_qmod_freq;
1143

1144
    /**
D
Diego Biurrun 已提交
1145 1146
     * ratecontrol override, see RcOverride
     * - encoding: Allocated/set/freed by user.
1147
     * - decoding: unused
1148
     */
M
Michael Niedermayer 已提交
1149 1150
    RcOverride *rc_override;
    int rc_override_count;
1151

1152
    /**
D
Diego Biurrun 已提交
1153 1154
     * rate control equation
     * - encoding: Set by user
1155
     * - decoding: unused
1156
     */
M
Michael Niedermayer 已提交
1157
    char *rc_eq;
1158

1159
    /**
D
Diego Biurrun 已提交
1160 1161
     * maximum bitrate
     * - encoding: Set by user.
1162
     * - decoding: unused
1163
     */
M
Michael Niedermayer 已提交
1164
    int rc_max_rate;
1165

1166
    /**
D
Diego Biurrun 已提交
1167 1168
     * minimum bitrate
     * - encoding: Set by user.
1169
     * - decoding: unused
1170
     */
M
Michael Niedermayer 已提交
1171
    int rc_min_rate;
1172

1173
    /**
D
Diego Biurrun 已提交
1174 1175
     * decoder bitstream buffer size
     * - encoding: Set by user.
1176
     * - decoding: unused
1177
     */
M
Michael Niedermayer 已提交
1178 1179
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1180 1181

    /**
D
Diego Biurrun 已提交
1182 1183 1184 1185
     * 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.
1186
     * - decoding: unused
1187 1188
     */
    float i_quant_factor;
1189

1190
    /**
D
Diego Biurrun 已提交
1191 1192
     * qscale offset between P and I-frames
     * - encoding: Set by user.
1193
     * - decoding: unused
1194 1195
     */
    float i_quant_offset;
1196

1197
    /**
D
Diego Biurrun 已提交
1198 1199
     * initial complexity for pass1 ratecontrol
     * - encoding: Set by user.
1200
     * - decoding: unused
1201
     */
M
Michael Niedermayer 已提交
1202
    float rc_initial_cplx;
1203

1204
    /**
D
Diego Biurrun 已提交
1205 1206
     * DCT algorithm, see FF_DCT_* below
     * - encoding: Set by user.
1207
     * - decoding: unused
1208
     */
1209
    int dct_algo;
1210
#define FF_DCT_AUTO    0
1211
#define FF_DCT_FASTINT 1
1212 1213 1214
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1215
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
1216
#define FF_DCT_FAAN    6
1217

1218
    /**
D
Diego Biurrun 已提交
1219 1220
     * luminance masking (0-> disabled)
     * - encoding: Set by user.
1221
     * - decoding: unused
1222 1223
     */
    float lumi_masking;
1224

1225
    /**
D
Diego Biurrun 已提交
1226 1227
     * temporary complexity masking (0-> disabled)
     * - encoding: Set by user.
1228
     * - decoding: unused
1229 1230
     */
    float temporal_cplx_masking;
1231

1232
    /**
D
Diego Biurrun 已提交
1233 1234
     * spatial complexity masking (0-> disabled)
     * - encoding: Set by user.
1235
     * - decoding: unused
1236 1237
     */
    float spatial_cplx_masking;
1238

1239
    /**
D
Diego Biurrun 已提交
1240 1241
     * p block masking (0-> disabled)
     * - encoding: Set by user.
1242
     * - decoding: unused
1243 1244
     */
    float p_masking;
1245

1246
    /**
D
Diego Biurrun 已提交
1247 1248
     * darkness masking (0-> disabled)
     * - encoding: Set by user.
1249
     * - decoding: unused
1250 1251
     */
    float dark_masking;
1252 1253


1254 1255
    /* for binary compatibility */
    int unused;
1256

1257
    /**
D
Diego Biurrun 已提交
1258 1259 1260
     * IDCT algorithm, see FF_IDCT_* below.
     * - encoding: Set by user.
     * - decoding: Set by user.
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
     */
    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
1271
#define FF_IDCT_ALTIVEC      8
1272
#define FF_IDCT_SH4          9
1273
#define FF_IDCT_SIMPLEARM    10
1274
#define FF_IDCT_H264         11
1275
#define FF_IDCT_VP3          12
1276
#define FF_IDCT_IPP          13
M
Michael Niedermayer 已提交
1277
#define FF_IDCT_XVIDMMX      14
1278
#define FF_IDCT_CAVS         15
M
Måns Rullgård 已提交
1279
#define FF_IDCT_SIMPLEARMV5TE 16
M
Måns Rullgård 已提交
1280
#define FF_IDCT_SIMPLEARMV6  17
1281

1282
    /**
D
Diego Biurrun 已提交
1283 1284 1285
     * slice count
     * - encoding: Set by libavcodec.
     * - decoding: Set by user (or 0).
1286 1287 1288
     */
    int slice_count;
    /**
D
Diego Biurrun 已提交
1289 1290 1291
     * slice offsets in the frame in bytes
     * - encoding: Set/allocated by libavcodec.
     * - decoding: Set/allocated by user (or NULL).
1292 1293 1294
     */
    int *slice_offset;

1295
    /**
D
Diego Biurrun 已提交
1296
     * error concealment flags
1297
     * - encoding: unused
D
Diego Biurrun 已提交
1298
     * - decoding: Set by user.
1299 1300 1301 1302 1303
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1304
    /**
Z
Zdenek Kabelac 已提交
1305
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1306
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1307
     *
D
Diego Biurrun 已提交
1308 1309 1310
     * 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.)
Z
Zdenek Kabelac 已提交
1311 1312
     */
    unsigned dsp_mask;
D
Diego Biurrun 已提交
1313
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
Z
Zdenek Kabelac 已提交
1314
    /* lower 16 bits - CPU features */
1315 1316 1317 1318 1319 1320
#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 */
1321 1322
#define FF_MM_SSE3     0x0040 /* Prescott SSE3 functions */
#define FF_MM_SSSE3    0x0080 /* Conroe SSSE3 functions */
1323
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
M
huffyuv  
Michael Niedermayer 已提交
1324 1325

    /**
1326
     * bits per sample/pixel from the demuxer (needed for huffyuv).
D
Diego Biurrun 已提交
1327 1328
     * - encoding: Set by libavcodec.
     * - decoding: Set by user.
M
huffyuv  
Michael Niedermayer 已提交
1329 1330
     */
     int bits_per_sample;
1331

M
huffyuv  
Michael Niedermayer 已提交
1332
    /**
D
Diego Biurrun 已提交
1333 1334
     * prediction method (needed for huffyuv)
     * - encoding: Set by user.
1335
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1336 1337 1338 1339 1340
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1341

M
Michael Niedermayer 已提交
1342
    /**
D
Diego Biurrun 已提交
1343 1344 1345 1346
     * 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.
M
Michael Niedermayer 已提交
1347
     */
M
Michael Niedermayer 已提交
1348
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1349 1350

    /**
D
Diego Biurrun 已提交
1351 1352 1353
     * the picture in the bitstream
     * - encoding: Set by libavcodec.
     * - decoding: Set by libavcodec.
M
cleanup  
Michael Niedermayer 已提交
1354
     */
M
Michael Niedermayer 已提交
1355
    AVFrame *coded_frame;
1356 1357

    /**
D
Diego Biurrun 已提交
1358 1359 1360
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1361 1362 1363 1364 1365 1366 1367 1368
     */
    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
1369
#define FF_DEBUG_DCT_COEFF 0x00000040
M
Michael Niedermayer 已提交
1370 1371 1372
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1373
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1374
#define FF_DEBUG_MMCO      0x00000800
1375
#define FF_DEBUG_BUGS      0x00001000
M
Michael Niedermayer 已提交
1376 1377
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1378

1379
    /**
D
Diego Biurrun 已提交
1380 1381 1382
     * debug
     * - encoding: Set by user.
     * - decoding: Set by user.
1383 1384 1385 1386 1387 1388
     */
    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

1389
    /**
D
Diego Biurrun 已提交
1390 1391
     * error
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1392
     * - decoding: unused
1393 1394
     */
    uint64_t error[4];
1395

M
Michael Niedermayer 已提交
1396
    /**
D
Diego Biurrun 已提交
1397
     * minimum MB quantizer
1398
     * - encoding: unused
1399
     * - decoding: unused
M
Michael Niedermayer 已提交
1400 1401 1402 1403
     */
    int mb_qmin;

    /**
D
Diego Biurrun 已提交
1404
     * maximum MB quantizer
1405
     * - encoding: unused
1406
     * - decoding: unused
M
Michael Niedermayer 已提交
1407 1408
     */
    int mb_qmax;
1409

M
Michael Niedermayer 已提交
1410
    /**
D
Diego Biurrun 已提交
1411 1412
     * motion estimation comparison function
     * - encoding: Set by user.
1413
     * - decoding: unused
M
Michael Niedermayer 已提交
1414 1415 1416
     */
    int me_cmp;
    /**
D
Diego Biurrun 已提交
1417 1418
     * subpixel motion estimation comparison function
     * - encoding: Set by user.
1419
     * - decoding: unused
M
Michael Niedermayer 已提交
1420 1421 1422
     */
    int me_sub_cmp;
    /**
D
Diego Biurrun 已提交
1423 1424
     * macroblock comparison function (not supported yet)
     * - encoding: Set by user.
1425
     * - decoding: unused
M
Michael Niedermayer 已提交
1426 1427
     */
    int mb_cmp;
1428
    /**
D
Diego Biurrun 已提交
1429 1430
     * interlaced DCT comparison function
     * - encoding: Set by user.
1431 1432 1433
     * - decoding: unused
     */
    int ildct_cmp;
M
Michael Niedermayer 已提交
1434 1435 1436 1437 1438 1439 1440 1441
#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
1442 1443
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1444
#define FF_CMP_NSSE 10
M
Michael Niedermayer 已提交
1445 1446
#define FF_CMP_W53  11
#define FF_CMP_W97  12
1447
#define FF_CMP_DCTMAX 13
1448
#define FF_CMP_DCT264 14
M
Michael Niedermayer 已提交
1449
#define FF_CMP_CHROMA 256
1450

M
Michael Niedermayer 已提交
1451
    /**
D
Diego Biurrun 已提交
1452 1453
     * ME diamond size & shape
     * - encoding: Set by user.
1454
     * - decoding: unused
M
Michael Niedermayer 已提交
1455 1456
     */
    int dia_size;
1457 1458

    /**
D
Diego Biurrun 已提交
1459 1460
     * amount of previous MV predictors (2a+1 x 2a+1 square)
     * - encoding: Set by user.
1461
     * - decoding: unused
1462 1463
     */
    int last_predictor_count;
1464

M
Michael Niedermayer 已提交
1465
    /**
D
Diego Biurrun 已提交
1466 1467
     * prepass for motion estimation
     * - encoding: Set by user.
1468
     * - decoding: unused
M
Michael Niedermayer 已提交
1469 1470
     */
    int pre_me;
1471

1472
    /**
D
Diego Biurrun 已提交
1473 1474
     * motion estimation prepass comparison function
     * - encoding: Set by user.
1475
     * - decoding: unused
1476 1477
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1478

1479
    /**
D
Diego Biurrun 已提交
1480 1481
     * ME prepass diamond size & shape
     * - encoding: Set by user.
1482
     * - decoding: unused
1483 1484 1485
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1486
    /**
D
Diego Biurrun 已提交
1487 1488
     * subpel ME quality
     * - encoding: Set by user.
1489
     * - decoding: unused
M
Michael Niedermayer 已提交
1490 1491 1492
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1493
    /**
D
Diego Biurrun 已提交
1494
     * callback to negotiate the pixelFormat
M
Michael Niedermayer 已提交
1495
     * @param fmt is the list of formats which are supported by the codec,
D
Diego Biurrun 已提交
1496 1497 1498
     * 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
1499
     * - encoding: unused
D
Diego Biurrun 已提交
1500
     * - decoding: Set by user, if not set the native format will be chosen.
M
Michael Niedermayer 已提交
1501
     */
I
Ivan Kalvachev 已提交
1502
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1503 1504

    /**
D
Diego Biurrun 已提交
1505 1506 1507
     * DTG active format information (additional aspect ratio
     * information only used in DVB MPEG-2 transport streams)
     * 0 if not set.
1508
     *
D
Diego Biurrun 已提交
1509 1510
     * - encoding: unused
     * - decoding: Set by decoder.
1511 1512 1513 1514 1515 1516 1517 1518 1519 1520
     */
    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

1521
    /**
D
Diego Biurrun 已提交
1522 1523
     * maximum motion estimation search range in subpel units
     * If 0 then no limit.
1524
     *
D
Diego Biurrun 已提交
1525 1526
     * - encoding: Set by user.
     * - decoding: unused
1527
     */
Z
Zdenek Kabelac 已提交
1528
    int me_range;
1529

1530
    /**
D
Diego Biurrun 已提交
1531 1532
     * intra quantizer bias
     * - encoding: Set by user.
1533 1534 1535 1536
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1537

1538
    /**
D
Diego Biurrun 已提交
1539 1540
     * inter quantizer bias
     * - encoding: Set by user.
1541 1542 1543
     * - decoding: unused
     */
    int inter_quant_bias;
1544 1545

    /**
D
Diego Biurrun 已提交
1546 1547 1548 1549
     * color table ID
     * - encoding: unused
     * - decoding: Which clrtable should be used for 8bit RGB images.
     *             Tables have to be stored somewhere. FIXME
1550 1551
     */
    int color_table_id;
1552

1553
    /**
D
Diego Biurrun 已提交
1554 1555
     * internal_buffer count
     * Don't touch, used by libavcodec default_get_buffer().
1556 1557
     */
    int internal_buffer_count;
1558

1559
    /**
D
Diego Biurrun 已提交
1560 1561
     * internal_buffers
     * Don't touch, used by libavcodec default_get_buffer().
1562 1563
     */
    void *internal_buffer;
1564 1565 1566 1567 1568 1569 1570

#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
M
Michael Niedermayer 已提交
1571
    /**
D
Diego Biurrun 已提交
1572 1573 1574
     * Global quality for codecs which cannot change it per frame.
     * This should be proportional to MPEG-1/2/4 qscale.
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1575 1576 1577
     * - decoding: unused
     */
    int global_quality;
1578

M
Michael Niedermayer 已提交
1579 1580
#define FF_CODER_TYPE_VLC       0
#define FF_CODER_TYPE_AC        1
1581 1582 1583
#define FF_CODER_TYPE_RAW       2
#define FF_CODER_TYPE_RLE       3
#define FF_CODER_TYPE_DEFLATE   4
M
Michael Niedermayer 已提交
1584 1585
    /**
     * coder type
D
Diego Biurrun 已提交
1586
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1587 1588 1589 1590 1591 1592
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
D
Diego Biurrun 已提交
1593
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1594 1595 1596
     * - decoding: unused
     */
    int context_model;
1597 1598 1599 1600
#if 0
    /**
     *
     * - encoding: unused
D
Diego Biurrun 已提交
1601
     * - decoding: Set by user.
1602 1603 1604
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1605

1606 1607 1608
    /**
     * slice flags
     * - encoding: unused
D
Diego Biurrun 已提交
1609
     * - decoding: Set by user.
1610 1611 1612 1613 1614 1615
     */
    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)

I
Ivan Kalvachev 已提交
1616 1617 1618 1619 1620 1621
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1622

1623 1624
    /**
     * macroblock decision mode
D
Diego Biurrun 已提交
1625
     * - encoding: Set by user.
1626 1627 1628 1629 1630 1631
     * - 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
1632 1633 1634

    /**
     * custom intra quantization matrix
D
Diego Biurrun 已提交
1635 1636
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1637 1638 1639 1640 1641
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
D
Diego Biurrun 已提交
1642 1643
     * - encoding: Set by user, can be NULL.
     * - decoding: Set by libavcodec.
1644 1645
     */
    uint16_t *inter_matrix;
1646

1647 1648
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
D
Diego Biurrun 已提交
1649
     * This is used to work around some encoder bugs.
1650
     * - encoding: unused
D
Diego Biurrun 已提交
1651
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1652 1653
     */
    unsigned int stream_codec_tag;
M
Michael Niedermayer 已提交
1654 1655

    /**
D
Diego Biurrun 已提交
1656 1657 1658
     * scene change detection threshold
     * 0 is default, larger means fewer detected scene changes.
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1659 1660 1661
     * - decoding: unused
     */
    int scenechange_threshold;
1662 1663

    /**
D
Diego Biurrun 已提交
1664 1665
     * minimum Lagrange multipler
     * - encoding: Set by user.
1666 1667 1668 1669 1670
     * - decoding: unused
     */
    int lmin;

    /**
D
Diego Biurrun 已提交
1671 1672
     * maximum Lagrange multipler
     * - encoding: Set by user.
1673 1674 1675
     * - decoding: unused
     */
    int lmax;
1676 1677

    /**
D
Diego Biurrun 已提交
1678
     * palette control structure
1679
     * - encoding: ??? (no palette-enabled encoder yet)
D
Diego Biurrun 已提交
1680
     * - decoding: Set by user.
1681 1682
     */
    struct AVPaletteControl *palctrl;
1683 1684 1685

    /**
     * noise reduction strength
D
Diego Biurrun 已提交
1686
     * - encoding: Set by user.
1687 1688 1689
     * - decoding: unused
     */
    int noise_reduction;
1690

1691
    /**
D
Diego Biurrun 已提交
1692 1693 1694
     * 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
1695
     * same buffer or new buffer with old frame "painted" into it.
D
Diego Biurrun 已提交
1696
     * If pic.data[0] == NULL must behave like get_buffer().
1697
     * - encoding: unused
D
Diego Biurrun 已提交
1698
     * - decoding: Set by libavcodec., user can override
1699
     */
1700
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1701 1702

    /**
D
Diego Biurrun 已提交
1703 1704
     * Number of bits which should be loaded into the rc buffer before decoding starts.
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1705 1706 1707 1708 1709 1710
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
D
Diego Biurrun 已提交
1711
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1712 1713 1714 1715 1716
     * - decoding: unused
     */
    int inter_threshold;

    /**
D
Diego Biurrun 已提交
1717 1718 1719
     * CODEC_FLAG2_*
     * - encoding: Set by user.
     * - decoding: Set by user.
M
Michael Niedermayer 已提交
1720 1721
     */
    int flags2;
1722 1723

    /**
D
Diego Biurrun 已提交
1724 1725 1726
     * Simulates errors in the bitstream to test error concealment.
     * - encoding: Set by user.
     * - decoding: unused
1727 1728
     */
    int error_rate;
1729

1730 1731 1732
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
D
Diego Biurrun 已提交
1733
     * - decoding: Set by user.
1734 1735 1736 1737 1738 1739
     */
    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
M
Michael Niedermayer 已提交
1740
    /**
D
Diego Biurrun 已提交
1741 1742
     * quantizer noise shaping
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1743 1744 1745
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1746 1747

    /**
D
Diego Biurrun 已提交
1748
     * thread count
1749
     * is used to decide how many independent tasks should be passed to execute()
D
Diego Biurrun 已提交
1750 1751
     * - encoding: Set by user.
     * - decoding: Set by user.
1752 1753
     */
    int thread_count;
1754

1755
    /**
D
Diego Biurrun 已提交
1756 1757 1758 1759
     * 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.
1760
     * @param count the number of things to execute
D
Diego Biurrun 已提交
1761 1762
     * - encoding: Set by libavcodec, user can override.
     * - decoding: Set by libavcodec, user can override.
1763 1764
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1765

1766
    /**
D
Diego Biurrun 已提交
1767 1768
     * thread opaque
     * Can be used by execute() to store some per AVCodecContext stuff.
1769 1770 1771 1772
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1773 1774

    /**
D
Diego Biurrun 已提交
1775 1776
     * Motion estimation threshold below which no motion estimation is
     * performed, but instead the user specified motion vectors are used.
1777
     *
D
Diego Biurrun 已提交
1778
     * - encoding: Set by user.
1779
     * - decoding: unused
1780
     */
M
Michael Niedermayer 已提交
1781
     int me_threshold;
1782 1783

    /**
D
Diego Biurrun 已提交
1784 1785
     * Macroblock threshold below which the user specified macroblock types will be used.
     * - encoding: Set by user.
1786 1787 1788
     * - decoding: unused
     */
     int mb_threshold;
1789 1790

    /**
D
Diego Biurrun 已提交
1791 1792
     * precision of the intra DC coefficient - 8
     * - encoding: Set by user.
1793 1794 1795
     * - decoding: unused
     */
     int intra_dc_precision;
M
Michael Niedermayer 已提交
1796 1797

    /**
D
Diego Biurrun 已提交
1798 1799
     * noise vs. sse weight for the nsse comparsion function
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1800 1801 1802
     * - decoding: unused
     */
     int nsse_weight;
1803 1804

    /**
D
Diego Biurrun 已提交
1805
     * Number of macroblock rows at the top which are skipped.
1806
     * - encoding: unused
D
Diego Biurrun 已提交
1807
     * - decoding: Set by user.
1808 1809 1810 1811
     */
     int skip_top;

    /**
D
Diego Biurrun 已提交
1812
     * Number of macroblock rows at the bottom which are skipped.
1813
     * - encoding: unused
D
Diego Biurrun 已提交
1814
     * - decoding: Set by user.
1815 1816
     */
     int skip_bottom;
1817 1818 1819

    /**
     * profile
D
Diego Biurrun 已提交
1820 1821
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
1822 1823 1824
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99
1825 1826 1827 1828
#define FF_PROFILE_AAC_MAIN 0
#define FF_PROFILE_AAC_LOW 1
#define FF_PROFILE_AAC_SSR 2
#define FF_PROFILE_AAC_LTP 3
1829 1830 1831

    /**
     * level
D
Diego Biurrun 已提交
1832 1833
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
1834 1835 1836
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
M
Michael Niedermayer 已提交
1837 1838

    /**
D
Diego Biurrun 已提交
1839
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
M
Michael Niedermayer 已提交
1840
     * - encoding: unused
D
Diego Biurrun 已提交
1841
     * - decoding: Set by user.
M
Michael Niedermayer 已提交
1842 1843
     */
     int lowres;
1844 1845

    /**
D
Diego Biurrun 已提交
1846 1847
     * Bitstream width / height, may be different from width/height if lowres
     * or other things are used.
1848
     * - encoding: unused
D
Diego Biurrun 已提交
1849
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1850 1851
     */
    int coded_width, coded_height;
M
Michael Niedermayer 已提交
1852 1853 1854

    /**
     * frame skip threshold
D
Diego Biurrun 已提交
1855
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1856 1857 1858 1859 1860 1861
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
D
Diego Biurrun 已提交
1862
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1863 1864 1865
     * - decoding: unused
     */
    int frame_skip_factor;
1866 1867 1868

    /**
     * frame skip exponent
D
Diego Biurrun 已提交
1869
     * - encoding: Set by user.
1870 1871 1872 1873 1874
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
D
Diego Biurrun 已提交
1875 1876
     * frame skip comparison function
     * - encoding: Set by user.
1877 1878 1879
     * - decoding: unused
     */
    int frame_skip_cmp;
1880 1881

    /**
D
Diego Biurrun 已提交
1882
     * Border processing masking, raises the quantizer for mbs on the borders
1883
     * of the picture.
D
Diego Biurrun 已提交
1884
     * - encoding: Set by user.
1885 1886 1887
     * - decoding: unused
     */
    float border_masking;
1888 1889

    /**
D
Diego Biurrun 已提交
1890 1891
     * minimum MB lagrange multipler
     * - encoding: Set by user.
1892 1893 1894 1895 1896
     * - decoding: unused
     */
    int mb_lmin;

    /**
D
Diego Biurrun 已提交
1897 1898
     * maximum MB lagrange multipler
     * - encoding: Set by user.
1899 1900 1901
     * - decoding: unused
     */
    int mb_lmax;
1902 1903

    /**
1904
     *
D
Diego Biurrun 已提交
1905
     * - encoding: Set by user.
1906 1907 1908
     * - decoding: unused
     */
    int me_penalty_compensation;
M
Michael Niedermayer 已提交
1909 1910

    /**
1911
     *
M
Michael Niedermayer 已提交
1912
     * - encoding: unused
D
Diego Biurrun 已提交
1913
     * - decoding: Set by user.
M
Michael Niedermayer 已提交
1914 1915 1916 1917
     */
    enum AVDiscard skip_loop_filter;

    /**
1918
     *
M
Michael Niedermayer 已提交
1919
     * - encoding: unused
D
Diego Biurrun 已提交
1920
     * - decoding: Set by user.
M
Michael Niedermayer 已提交
1921 1922 1923 1924
     */
    enum AVDiscard skip_idct;

    /**
1925
     *
M
Michael Niedermayer 已提交
1926
     * - encoding: unused
D
Diego Biurrun 已提交
1927
     * - decoding: Set by user.
M
Michael Niedermayer 已提交
1928 1929
     */
    enum AVDiscard skip_frame;
M
Michael Niedermayer 已提交
1930 1931 1932

    /**
     *
D
Diego Biurrun 已提交
1933
     * - encoding: Set by user.
M
Michael Niedermayer 已提交
1934 1935 1936
     * - decoding: unused
     */
    int bidir_refine;
1937 1938 1939

    /**
     *
D
Diego Biurrun 已提交
1940
     * - encoding: Set by user.
1941 1942 1943
     * - decoding: unused
     */
    int brd_scale;
R
Robert Swain 已提交
1944 1945 1946

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
D
Diego Biurrun 已提交
1947
     * - encoding: Set by user.
R
Robert Swain 已提交
1948 1949
     * - decoding: unused
     */
L
Luca Barbato 已提交
1950
    float crf;
R
Robert Swain 已提交
1951 1952 1953

    /**
     * constant quantization parameter rate control method
D
Diego Biurrun 已提交
1954
     * - encoding: Set by user.
R
Robert Swain 已提交
1955 1956 1957 1958 1959
     * - decoding: unused
     */
    int cqp;

    /**
D
Diego Biurrun 已提交
1960 1961
     * minimum GOP size
     * - encoding: Set by user.
R
Robert Swain 已提交
1962 1963 1964 1965 1966 1967
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
D
Diego Biurrun 已提交
1968
     * - encoding: Set by user.
R
Robert Swain 已提交
1969 1970 1971 1972 1973 1974
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
D
Diego Biurrun 已提交
1975
     * - encoding: Set by user.
R
Robert Swain 已提交
1976 1977 1978 1979 1980
     * - decoding: unused
     */
    int chromaoffset;

    /**
D
Diego Biurrun 已提交
1981 1982
     * Influences how often B-frames are used.
     * - encoding: Set by user.
R
Robert Swain 已提交
1983 1984 1985 1986 1987 1988
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
D
Diego Biurrun 已提交
1989
     * - encoding: Set by user.
R
Robert Swain 已提交
1990 1991 1992 1993 1994
     * - decoding: unused
     */
    int trellis;

    /**
D
Diego Biurrun 已提交
1995 1996
     * Reduce fluctuations in qp (before curve compression).
     * - encoding: Set by user.
R
Robert Swain 已提交
1997 1998 1999 2000 2001 2002 2003
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
D
Diego Biurrun 已提交
2004
     * - encoding: Set by user.
R
Robert Swain 已提交
2005 2006 2007 2008 2009 2010 2011
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
D
Diego Biurrun 已提交
2012
     * - encoding: Set by user.
R
Robert Swain 已提交
2013 2014 2015 2016 2017 2018
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
D
Diego Biurrun 已提交
2019
     * - encoding: Set by user.
R
Robert Swain 已提交
2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
     * - 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 */

    /**
D
Diego Biurrun 已提交
2030 2031
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: Set by user.
R
Robert Swain 已提交
2032 2033 2034
     * - decoding: unused
     */
    int directpred;
2035

2036
    /**
D
Diego Biurrun 已提交
2037 2038
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
     * - encoding: Set by user.
2039 2040 2041
     * - decoding: unused
     */
    int cutoff;
C
Corey Hickey 已提交
2042 2043

    /**
D
Diego Biurrun 已提交
2044 2045
     * Multiplied by qscale for each frame and added to scene_change_score.
     * - encoding: Set by user.
C
Corey Hickey 已提交
2046 2047 2048
     * - decoding: unused
     */
    int scenechange_factor;
2049 2050 2051

    /**
     *
D
Diego Biurrun 已提交
2052 2053
     * Note: Value depends upon the compare function used for fullpel ME.
     * - encoding: Set by user.
2054 2055 2056
     * - decoding: unused
     */
    int mv0_threshold;
2057 2058

    /**
D
Diego Biurrun 已提交
2059 2060
     * Adjusts sensitivity of b_frame_strategy 1.
     * - encoding: Set by user.
2061 2062 2063
     * - decoding: unused
     */
    int b_sensitivity;
2064 2065

    /**
D
Diego Biurrun 已提交
2066
     * - encoding: Set by user.
2067 2068 2069 2070 2071 2072
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
D
Diego Biurrun 已提交
2073 2074 2075
     * Sets whether to use LPC mode - used by FLAC encoder.
     * - encoding: Set by user.
     * - decoding: unused
2076 2077 2078 2079 2080
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
D
Diego Biurrun 已提交
2081 2082
     * - encoding: Set by user.
     * - decoding: unused
2083 2084 2085 2086
     */
    int lpc_coeff_precision;

    /**
D
Diego Biurrun 已提交
2087 2088
     * - encoding: Set by user.
     * - decoding: unused
2089 2090 2091 2092
     */
    int min_prediction_order;

    /**
D
Diego Biurrun 已提交
2093 2094
     * - encoding: Set by user.
     * - decoding: unused
2095 2096 2097 2098 2099
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
D
Diego Biurrun 已提交
2100 2101
     * - encoding: Set by user.
     * - decoding: unused
2102 2103 2104 2105
     */
    int prediction_order_method;

    /**
D
Diego Biurrun 已提交
2106 2107
     * - encoding: Set by user.
     * - decoding: unused
2108 2109 2110 2111
     */
    int min_partition_order;

    /**
D
Diego Biurrun 已提交
2112 2113
     * - encoding: Set by user.
     * - decoding: unused
2114 2115
     */
    int max_partition_order;
2116 2117 2118

    /**
     * GOP timecode frame start number, in non drop frame format
D
Diego Biurrun 已提交
2119 2120
     * - encoding: Set by user.
     * - decoding: unused
2121 2122
     */
    int64_t timecode_frame_start;
F
Fabrice Bellard 已提交
2123 2124
} AVCodecContext;

2125 2126 2127
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
2128
typedef struct AVCodec {
N
Nicolas George 已提交
2129 2130 2131 2132 2133 2134
    /**
     * 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.
     */
2135
    const char *name;
Z
Zdenek Kabelac 已提交
2136
    enum CodecType type;
M
Michael Niedermayer 已提交
2137
    enum CodecID id;
F
Fabrice Bellard 已提交
2138 2139
    int priv_data_size;
    int (*init)(AVCodecContext *);
2140
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
2141
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
2142
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2143
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2144
    int capabilities;
F
Fabrice Bellard 已提交
2145
    struct AVCodec *next;
M
Michael Niedermayer 已提交
2146
    void (*flush)(AVCodecContext *);
Z
* const  
Zdenek Kabelac 已提交
2147
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2148
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
F
Fabrice Bellard 已提交
2149 2150
} AVCodec;

2151
/**
2152 2153 2154
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
2155
typedef struct AVPicture {
2156
    uint8_t *data[4];
M
Michael Niedermayer 已提交
2157
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
2158 2159
} AVPicture;

M
Mike Melanson 已提交
2160 2161 2162 2163
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
2164 2165 2166
 *
 * @deprecated Use AVPacket to send palette changes instead.
 * This is totally broken.
M
Mike Melanson 已提交
2167
 */
2168
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
2169
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
2170 2171
typedef struct AVPaletteControl {

D
Diego Biurrun 已提交
2172 2173
    /* Demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0. */
M
Mike Melanson 已提交
2174 2175
    int palette_changed;

2176 2177
    /* 4-byte ARGB palette entries, stored in native byte order; note that
     * the individual palette components should be on a 8-bit scale; if
D
Diego Biurrun 已提交
2178 2179
     * the palette data comes from an IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled. */
2180
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
2181

2182
} AVPaletteControl attribute_deprecated;
M
Mike Melanson 已提交
2183

2184
typedef struct AVSubtitleRect {
F
Fabrice Bellard 已提交
2185 2186 2187 2188 2189 2190 2191 2192
    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;
2193 2194 2195 2196 2197 2198 2199 2200
} 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;
F
Fabrice Bellard 已提交
2201 2202 2203
} AVSubtitle;


F
Fabrice Bellard 已提交
2204 2205 2206
/* resample.c */

struct ReSampleContext;
2207
struct AVResampleContext;
F
Fabrice Bellard 已提交
2208 2209 2210

typedef struct ReSampleContext ReSampleContext;

2211
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
F
Fabrice Bellard 已提交
2212 2213 2214 2215
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

2216
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2217
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
M
Michael Niedermayer 已提交
2218
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2219
void av_resample_close(struct AVResampleContext *c);
2220

2221
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
F
Fabrice Bellard 已提交
2222 2223
/* YUV420 format is assumed ! */

2224 2225 2226
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2227
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
F
Fabrice Bellard 已提交
2228

2229 2230 2231
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2232
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
F
Fabrice Bellard 已提交
2233
                                      int input_width, int input_height);
2234

2235 2236 2237
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2238
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2239 2240
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2241 2242 2243 2244
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2245 2246 2247
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2248
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2249
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
2250

2251 2252 2253
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2254
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2255 2256

#endif
F
Fabrice Bellard 已提交
2257

D
Drew Hess 已提交
2258 2259 2260
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
D
Diego Biurrun 已提交
2261 2262 2263 2264 2265
 * @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
D
Drew Hess 已提交
2266 2267 2268
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2269 2270 2271
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
D
Diego Biurrun 已提交
2272
 * @param picture the AVPicture to be freed
2273
 */
D
Drew Hess 已提交
2274 2275
void avpicture_free(AVPicture *picture);

2276
/**
D
Diego Biurrun 已提交
2277
 * Fill in the AVPicture fields.
2278 2279 2280 2281 2282 2283 2284
 * 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.
 *
D
Diego Biurrun 已提交
2285
 * @param picture AVPicture whose fields are to be filled in
2286
 * @param ptr Buffer which will contain or contains the actual image data
D
Diego Biurrun 已提交
2287 2288 2289 2290
 * @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
2291
 */
2292
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2293
                   int pix_fmt, int width, int height);
2294
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2295
                     unsigned char *dest, int dest_size);
2296 2297 2298 2299 2300

/**
 * Calculate the size in bytes that a picture of the given width and height
 * would occupy if stored in the given picture format.
 *
D
Diego Biurrun 已提交
2301 2302 2303
 * @param pix_fmt the given picture format
 * @param width the width of the image
 * @param height the height of the image
2304 2305
 * @return Image data size in bytes
 */
2306
int avpicture_get_size(int pix_fmt, int width, int height);
2307 2308
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);
2309
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2310
enum PixelFormat avcodec_get_pix_fmt(const char* name);
M
Michael Niedermayer 已提交
2311
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2312

2313 2314 2315 2316 2317 2318
#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) */
2319

2320
/**
2321 2322 2323 2324 2325 2326 2327 2328
 * 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.
D
Diego Biurrun 已提交
2329 2330
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 * which will occur when converting from one pixel format to another.
2331
 *
D
Diego Biurrun 已提交
2332 2333
 * @param[in] dst_pix_fmt destination pixel format
 * @param[in] src_pix_fmt source pixel format
2334 2335
 * @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.
2336
 */
2337 2338
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2339 2340

/**
2341 2342 2343 2344 2345
 * 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
D
Diego Biurrun 已提交
2346 2347
 * 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
2348 2349 2350 2351 2352 2353 2354 2355
 * \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
 *
D
Diego Biurrun 已提交
2356 2357
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 * @param[in] src_pix_fmt source pixel format
2358 2359 2360
 * @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.
2361
 */
2362 2363 2364
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377

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

F
Fabrice Bellard 已提交
2378 2379
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2380 2381 2382 2383 2384

/**
 * Tell if an image really has transparent alpha values.
 * @return ored mask of FF_ALPHA_xxx constants
 */
2385
int img_get_alpha_info(const AVPicture *src,
2386
                       int pix_fmt, int width, int height);
F
Fabrice Bellard 已提交
2387

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

/* deinterlace a picture */
2399
/* deinterlace - if not supported return -1 */
2400
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
2401 2402 2403 2404 2405 2406
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
2407
/* returns LIBAVCODEC_VERSION_INT constant */
2408
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
2409
/* returns LIBAVCODEC_BUILD constant */
2410
unsigned avcodec_build(void);
2411 2412 2413 2414 2415 2416 2417

/**
 * Initializes libavcodec.
 *
 * @warning This function \e must be called before any other libavcodec
 * function.
 */
F
Fabrice Bellard 已提交
2418 2419 2420
void avcodec_init(void);

void register_avcodec(AVCodec *format);
2421 2422 2423 2424

/**
 * Finds an encoder with a matching codec ID.
 *
D
Diego Biurrun 已提交
2425
 * @param id CodecID of the requested encoder
2426 2427
 * @return An encoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2428
AVCodec *avcodec_find_encoder(enum CodecID id);
2429 2430 2431 2432

/**
 * Finds an encoder with the specified name.
 *
D
Diego Biurrun 已提交
2433
 * @param name name of the requested encoder
2434 2435
 * @return An encoder if one was found, NULL otherwise.
 */
2436
AVCodec *avcodec_find_encoder_by_name(const char *name);
2437 2438 2439 2440

/**
 * Finds a decoder with a matching codec ID.
 *
D
Diego Biurrun 已提交
2441
 * @param id CodecID of the requested decoder
2442 2443
 * @return A decoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2444
AVCodec *avcodec_find_decoder(enum CodecID id);
2445 2446 2447 2448

/**
 * Finds an decoder with the specified name.
 *
D
Diego Biurrun 已提交
2449
 * @param name name of the requested decoder
2450 2451
 * @return A decoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2452 2453 2454
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

2455 2456 2457 2458 2459
/**
 * Sets the fields of the given AVCodecContext to default values.
 *
 * @param s The AVCodecContext of which the fields should be set to default values.
 */
M
cleanup  
Michael Niedermayer 已提交
2460
void avcodec_get_context_defaults(AVCodecContext *s);
2461

2462 2463 2464 2465
/** 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);

2466 2467 2468 2469 2470 2471 2472
/**
 * 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
 */
F
Falk Hüffner 已提交
2473
AVCodecContext *avcodec_alloc_context(void);
2474

2475 2476 2477 2478
/** 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);

2479 2480 2481 2482 2483
/**
 * Sets the fields of the given AVFrame to default values.
 *
 * @param pic The AVFrame of which the fields should be set to default values.
 */
F
Falk Hüffner 已提交
2484
void avcodec_get_frame_defaults(AVFrame *pic);
2485 2486 2487 2488 2489 2490 2491 2492

/**
 * 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
 */
M
Michael Niedermayer 已提交
2493
AVFrame *avcodec_alloc_frame(void);
M
cleanup  
Michael Niedermayer 已提交
2494

M
Michael Niedermayer 已提交
2495 2496
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
M
Michael Niedermayer 已提交
2497 2498
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2499 2500 2501 2502 2503 2504 2505 2506 2507

/**
 * 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.
 */
2508
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
M
Michael Niedermayer 已提交
2509
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
M
cleanup  
Michael Niedermayer 已提交
2510

M
1l  
Michael Niedermayer 已提交
2511 2512 2513
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);
M
Michael Niedermayer 已提交
2514
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2515 2516
//FIXME func typedef

M
Michael Niedermayer 已提交
2517
/**
2518 2519 2520 2521 2522 2523 2524
 * 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.
 *
D
Diego Biurrun 已提交
2525
 * @warning This function is not thread safe!
2526 2527
 *
 * @code
2528
 * avcodec_register_all();
2529 2530 2531 2532 2533 2534 2535 2536 2537 2538
 * codec = avcodec_find_decoder(CODEC_ID_H264);
 * if (!codec)
 *     exit(1);
 *
 * context = avcodec_alloc_context();
 *
 * if (avcodec_open(context, codec) < 0)
 *     exit(1);
 * @endcode
 *
D
Diego Biurrun 已提交
2539
 * @param avctx The context which will be set up to use the given codec.
2540
 * @param codec The codec to use within the context.
D
Diego Biurrun 已提交
2541
 * @return zero on success, a negative value on error
2542
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
M
Michael Niedermayer 已提交
2543
 */
F
Fabrice Bellard 已提交
2544
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
2545

2546 2547 2548
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
M
Michael Niedermayer 已提交
2549 2550 2551
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
                         uint8_t *buf, int buf_size);
2552

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

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

D
Diego Biurrun 已提交
2628 2629 2630
/* 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. */
F
Fabrice Bellard 已提交
2631 2632 2633
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2634
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2635
                        int *data_size_ptr,
2636
                        uint8_t *buf, int buf_size);
2637 2638 2639

/**
 * Encodes an audio frame from \p samples into \p buf.
D
Diego Biurrun 已提交
2640 2641
 * 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
2642 2643 2644 2645 2646
 * 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.
 *
D
Diego Biurrun 已提交
2647 2648 2649 2650
 * @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
2651 2652 2653
 * @return On error a negative value is returned, on succes zero or the number
 * of bytes used from the input buffer.
 */
2654
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2655
                         const short *samples);
2656 2657 2658

/**
 * Encodes a video frame from \p pict into \p buf.
D
Diego Biurrun 已提交
2659 2660
 * 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
2661 2662 2663 2664
 * \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.
 *
D
Diego Biurrun 已提交
2665 2666 2667 2668
 * @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
2669 2670 2671
 * @return On error a negative value is returned, on success zero or the number
 * of bytes used from the input buffer.
 */
2672
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
M
Michael Niedermayer 已提交
2673
                         const AVFrame *pict);
2674
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2675
                            const AVSubtitle *sub);
F
Fabrice Bellard 已提交
2676 2677 2678 2679

int avcodec_close(AVCodecContext *avctx);

void avcodec_register_all(void);
F
Fabrice Bellard 已提交
2680

2681 2682 2683
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
M
Michael Niedermayer 已提交
2684 2685
void avcodec_flush_buffers(AVCodecContext *avctx);

2686 2687
void avcodec_default_free_buffers(AVCodecContext *s);

P
Panagiotis Issaris 已提交
2688
/* misc useful functions */
M
cleanup  
Michael Niedermayer 已提交
2689 2690

/**
2691 2692
 * Returns a single letter to describe the given picture type \p pict_type.
 *
D
Diego Biurrun 已提交
2693
 * @param[in] pict_type the picture type
2694
 * @return A single character representing the picture type.
M
cleanup  
Michael Niedermayer 已提交
2695 2696 2697
 */
char av_get_pict_type_char(int pict_type);

2698
/**
2699 2700
 * Returns codec bits per sample.
 *
D
Diego Biurrun 已提交
2701
 * @param[in] codec_id the codec
2702
 * @return Number of bits per sample or zero if unknown for the given codec.
2703 2704
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2705

F
Fabrice Bellard 已提交
2706 2707 2708 2709 2710
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2711
    int64_t cur_offset; /* current offset
F
Fabrice Bellard 已提交
2712 2713 2714
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
D
Diego Biurrun 已提交
2715 2716
    int pict_type; /* XXX: Put it back in AVCodecContext. */
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2717 2718 2719 2720 2721 2722
    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;
M
Michael Niedermayer 已提交
2723
    int fetch_timestamp;
2724 2725 2726 2727 2728 2729

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

2731 2732
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2733 2734 2735

    int64_t offset;      ///< byte offset from starting packet start
    int64_t last_offset;
F
Fabrice Bellard 已提交
2736 2737 2738
} AVCodecParserContext;

typedef struct AVCodecParser {
M
Michael Niedermayer 已提交
2739
    int codec_ids[5]; /* several codec IDs are permitted */
F
Fabrice Bellard 已提交
2740 2741
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2742
    int (*parser_parse)(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2743
                        AVCodecContext *avctx,
2744
                        const uint8_t **poutbuf, int *poutbuf_size,
F
Fabrice Bellard 已提交
2745 2746
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2747
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2748 2749 2750 2751 2752 2753 2754
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2755
int av_parser_parse(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2756
                    AVCodecContext *avctx,
2757
                    uint8_t **poutbuf, int *poutbuf_size,
2758 2759
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2760 2761
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2762
                     uint8_t **poutbuf, int *poutbuf_size,
2763
                     const uint8_t *buf, int buf_size, int keyframe);
F
Fabrice Bellard 已提交
2764 2765
void av_parser_close(AVCodecParserContext *s);

2766 2767
extern AVCodecParser aac_parser;
extern AVCodecParser ac3_parser;
2768
extern AVCodecParser cavsvideo_parser;
K
Kostya Shishkov 已提交
2769
extern AVCodecParser dca_parser;
2770 2771
extern AVCodecParser dvbsub_parser;
extern AVCodecParser dvdsub_parser;
2772
extern AVCodecParser h261_parser;
F
Fabrice Bellard 已提交
2773 2774
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
M
Michael Niedermayer 已提交
2775
extern AVCodecParser mjpeg_parser;
2776
extern AVCodecParser mpeg4video_parser;
F
Fabrice Bellard 已提交
2777
extern AVCodecParser mpegaudio_parser;
2778 2779
extern AVCodecParser mpegvideo_parser;
extern AVCodecParser pnm_parser;
K
Kostya Shishkov 已提交
2780
extern AVCodecParser vc1_parser;
F
Fabrice Bellard 已提交
2781

2782 2783

typedef struct AVBitStreamFilterContext {
M
Michael Niedermayer 已提交
2784
    void *priv_data;
2785 2786 2787 2788 2789 2790 2791 2792
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
M
Michael Niedermayer 已提交
2793
    int priv_data_size;
2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
    int (*filter)(AVBitStreamFilterContext *bsfc,
                  AVCodecContext *avctx, const char *args,
                  uint8_t **poutbuf, int *poutbuf_size,
                  const uint8_t *buf, int buf_size, int keyframe);
    struct AVBitStreamFilter *next;
} AVBitStreamFilter;

extern AVBitStreamFilter *av_first_bitstream_filter;

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

extern AVBitStreamFilter dump_extradata_bsf;
extern AVBitStreamFilter remove_extradata_bsf;
M
Michael Niedermayer 已提交
2813
extern AVBitStreamFilter noise_bsf;
2814 2815
extern AVBitStreamFilter mp3_header_compress_bsf;
extern AVBitStreamFilter mp3_header_decompress_bsf;
2816
extern AVBitStreamFilter mjpega_dump_header_bsf;
2817
extern AVBitStreamFilter imx_dump_header_bsf;
2818 2819


F
Fabrice Bellard 已提交
2820
/* memory */
2821 2822

/**
2823 2824 2825 2826
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
2827
 */
2828
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2829

2830
/* for static data only */
2831 2832

/**
D
Diego Biurrun 已提交
2833
 * Frees all static arrays and resets their pointers to 0.
2834
 * Call this function to release all statically allocated tables.
2835 2836 2837 2838
 *
 * @deprecated. Code which uses av_free_static is broken/missdesigned
 * and should correctly use static arrays
 *
2839
 */
2840
attribute_deprecated void av_free_static(void);
2841 2842

/**
2843 2844 2845 2846 2847
 * Allocation of static arrays.
 *
 * @warning Do not use for normal allocation.
 *
 * @param[in] size The amount of memory you need in bytes.
D
Diego Biurrun 已提交
2848
 * @return block of memory of the requested size
2849 2850
 * @deprecated. Code which uses av_mallocz_static is broken/missdesigned
 * and should correctly use static arrays
2851
 */
2852
attribute_deprecated void *av_mallocz_static(unsigned int size);
2853

2854 2855 2856
/**
 * Copy image 'src' to 'dst'.
 */
2857
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2858 2859
              int pix_fmt, int width, int height);

2860
/**
D
Diego Biurrun 已提交
2861
 * Crop image top and left side.
2862
 */
2863
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2864 2865
             int pix_fmt, int top_band, int left_band);

2866
/**
D
Diego Biurrun 已提交
2867
 * Pad image.
2868
 */
2869
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2870 2871
            int padtop, int padbottom, int padleft, int padright, int *color);

2872
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2873 2874 2875
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2876 2877 2878
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2879 2880 2881
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2882 2883 2884
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

2885 2886 2887
/**
 * @deprecated Use the software scaler (swscale) instead.
 */
2888 2889 2890 2891
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

2892 2893
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

2894 2895 2896
/**
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
 *
D
Diego Biurrun 已提交
2897
 * @return 0 in case of a successful parsing, a negative value otherwise
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
 * @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.
 *
D
Diego Biurrun 已提交
2910
 * @return 0 in case of a successful parsing, a negative value otherwise
2911 2912 2913 2914 2915 2916 2917
 * @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);

2918 2919
/* error handling */
#if EINVAL > 0
D
Diego Biurrun 已提交
2920 2921
#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. */
2922
#else
D
Diego Biurrun 已提交
2923
/* Some platforms have E* and errno already negated. */
2924 2925 2926 2927
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
D
Diego Biurrun 已提交
2928 2929
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2930 2931 2932
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
D
Diego Biurrun 已提交
2933
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
B
Benoit Fouet 已提交
2934
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
2935

F
Fabrice Bellard 已提交
2936
#endif /* AVCODEC_H */