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

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

M
Michael Niedermayer 已提交
24 25
/**
 * @file avcodec.h
M
doxy  
Michael Niedermayer 已提交
26
 * external api header.
M
Michael Niedermayer 已提交
27 28 29
 */


30 31 32 33
#ifdef __cplusplus
extern "C" {
#endif

34
#include "avutil.h"
Z
Zdenek Kabelac 已提交
35
#include <sys/types.h> /* size_t */
F
Fabrice Bellard 已提交
36

37
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
F
Fabrice Bellard 已提交
38
#define AV_TOSTRING(s) #s
M
Michael Niedermayer 已提交
39

40 41
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(40<<8)+2)
#define LIBAVCODEC_VERSION      51.40.2
42
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
M
Michael Niedermayer 已提交
43

44
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
A
Alex Beregszaszi 已提交
45

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

50 51 52 53 54 55
/**
 *
 * if you add a codec id to this list add it so that
 * 1. no value of a existing codec id changes (that would break ABI)
 * 2. closest to similar codecs
 */
F
Fabrice Bellard 已提交
56
enum CodecID {
57
    CODEC_ID_NONE,
F
Fabrice Bellard 已提交
58
    CODEC_ID_MPEG1VIDEO,
59
    CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
I
Ivan Kalvachev 已提交
60
    CODEC_ID_MPEG2VIDEO_XVMC,
61
    CODEC_ID_H261,
F
Fabrice Bellard 已提交
62 63
    CODEC_ID_H263,
    CODEC_ID_RV10,
M
Michael Niedermayer 已提交
64
    CODEC_ID_RV20,
F
Fabrice Bellard 已提交
65
    CODEC_ID_MJPEG,
66
    CODEC_ID_MJPEGB,
67
    CODEC_ID_LJPEG,
68
    CODEC_ID_SP5X,
69
    CODEC_ID_JPEGLS,
F
Fabrice Bellard 已提交
70
    CODEC_ID_MPEG4,
F
Fabrice Bellard 已提交
71
    CODEC_ID_RAWVIDEO,
72 73 74
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
75
    CODEC_ID_WMV1,
M
Michael Niedermayer 已提交
76
    CODEC_ID_WMV2,
F
Fabrice Bellard 已提交
77 78
    CODEC_ID_H263P,
    CODEC_ID_H263I,
79
    CODEC_ID_FLV1,
N
Nick Kurshev 已提交
80
    CODEC_ID_SVQ1,
M
Michael Niedermayer 已提交
81
    CODEC_ID_SVQ3,
F
Fabrice Bellard 已提交
82
    CODEC_ID_DVVIDEO,
M
huffyuv  
Michael Niedermayer 已提交
83
    CODEC_ID_HUFFYUV,
84
    CODEC_ID_CYUV,
M
Michael Niedermayer 已提交
85
    CODEC_ID_H264,
86
    CODEC_ID_INDEO3,
87
    CODEC_ID_VP3,
88
    CODEC_ID_THEORA,
M
Michael Niedermayer 已提交
89
    CODEC_ID_ASV1,
M
Michael Niedermayer 已提交
90
    CODEC_ID_ASV2,
91
    CODEC_ID_FFV1,
92
    CODEC_ID_4XM,
M
Michael Niedermayer 已提交
93
    CODEC_ID_VCR1,
A
Alex Beregszaszi 已提交
94
    CODEC_ID_CLJR,
95
    CODEC_ID_MDEC,
96 97
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
98 99
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
100 101 102 103 104
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
105
    CODEC_ID_IDCIN,
R
Roberto Togni 已提交
106
    CODEC_ID_8BPS,
M
Mike Melanson 已提交
107
    CODEC_ID_SMC,
M
Mike Melanson 已提交
108
    CODEC_ID_FLIC,
109
    CODEC_ID_TRUEMOTION1,
110
    CODEC_ID_VMDVIDEO,
R
Roberto Togni 已提交
111 112
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
113
    CODEC_ID_QTRLE,
114
    CODEC_ID_SNOW,
115
    CODEC_ID_TSCC,
116
    CODEC_ID_ULTI,
117
    CODEC_ID_QDRAW,
118
    CODEC_ID_VIXL,
119
    CODEC_ID_QPEG,
120 121 122 123 124 125 126
    CODEC_ID_XVID,
    CODEC_ID_PNG,
    CODEC_ID_PPM,
    CODEC_ID_PBM,
    CODEC_ID_PGM,
    CODEC_ID_PGMYUV,
    CODEC_ID_PAM,
L
Loren Merritt 已提交
127
    CODEC_ID_FFVHUFF,
128 129
    CODEC_ID_RV30,
    CODEC_ID_RV40,
130
    CODEC_ID_VC1,
131
    CODEC_ID_WMV3,
132
    CODEC_ID_LOCO,
133
    CODEC_ID_WNV1,
134
    CODEC_ID_AASC,
135
    CODEC_ID_INDEO2,
136
    CODEC_ID_FRAPS,
137
    CODEC_ID_TRUEMOTION2,
M
Måns Rullgård 已提交
138
    CODEC_ID_BMP,
139
    CODEC_ID_CSCD,
140
    CODEC_ID_MMVIDEO,
141
    CODEC_ID_ZMBV,
142
    CODEC_ID_AVS,
K
Kostya Shishkov 已提交
143
    CODEC_ID_SMACKVIDEO,
144
    CODEC_ID_NUV,
145
    CODEC_ID_KMVC,
146
    CODEC_ID_FLASHSV,
147
    CODEC_ID_CAVS,
148
    CODEC_ID_JPEG2000,
149
    CODEC_ID_VMNC,
A
Aurelien Jacobs 已提交
150 151 152
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
K
Kostya Shishkov 已提交
153
    CODEC_ID_TARGA,
154
    CODEC_ID_DSICINVIDEO,
155
    CODEC_ID_TIERTEXSEQVIDEO,
K
Kostya Shishkov 已提交
156
    CODEC_ID_TIFF,
157
    CODEC_ID_GIF,
158
    CODEC_ID_FFH264,
K
Kostya Shishkov 已提交
159
    CODEC_ID_DXA,
B
Baptiste Coudurier 已提交
160
    CODEC_ID_DNXHD,
161
    CODEC_ID_THP,
F
Fabrice Bellard 已提交
162 163

    /* various pcm "codecs" */
164
    CODEC_ID_PCM_S16LE= 0x10000,
F
Fabrice Bellard 已提交
165 166 167 168 169 170 171
    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,
172 173 174 175 176 177 178 179 180
    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,
181 182

    /* various adpcm codecs */
183
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
184
    CODEC_ID_ADPCM_IMA_WAV,
185 186
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
187
    CODEC_ID_ADPCM_IMA_WS,
188
    CODEC_ID_ADPCM_IMA_SMJPEG,
189
    CODEC_ID_ADPCM_MS,
190
    CODEC_ID_ADPCM_4XM,
191 192
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
193
    CODEC_ID_ADPCM_EA,
194
    CODEC_ID_ADPCM_G726,
195
    CODEC_ID_ADPCM_CT,
196
    CODEC_ID_ADPCM_SWF,
197
    CODEC_ID_ADPCM_YAMAHA,
198 199 200
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
201

202 203
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
204 205
    CODEC_ID_AMR_WB,

206
    /* RealAudio codecs*/
207
    CODEC_ID_RA_144= 0x13000,
208
    CODEC_ID_RA_288,
209 210

    /* various DPCM codecs */
211
    CODEC_ID_ROQ_DPCM= 0x14000,
212
    CODEC_ID_INTERPLAY_DPCM,
213
    CODEC_ID_XAN_DPCM,
214
    CODEC_ID_SOL_DPCM,
215

216 217 218
    CODEC_ID_MP2= 0x15000,
    CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
    CODEC_ID_AAC,
219
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
220
    CODEC_ID_MPEG4AAC,
221
#endif
222 223 224 225 226 227 228 229 230 231 232
    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 已提交
233
    CODEC_ID_FLAC,
R
Roberto Togni 已提交
234
    CODEC_ID_MP3ADU,
235
    CODEC_ID_MP3ON4,
236
    CODEC_ID_SHORTEN,
M
Michael Niedermayer 已提交
237
    CODEC_ID_ALAC,
238
    CODEC_ID_WESTWOOD_SND1,
M
Michel Bardiaux 已提交
239
    CODEC_ID_GSM, /* As in Berlin toast format */
R
Roberto Togni 已提交
240
    CODEC_ID_QDM2,
241
    CODEC_ID_COOK,
242
    CODEC_ID_TRUESPEECH,
243
    CODEC_ID_TTA,
K
Kostya Shishkov 已提交
244
    CODEC_ID_SMACKAUDIO,
B
Benjamin Larsson 已提交
245
    CODEC_ID_QCELP,
K
Kostya Shishkov 已提交
246
    CODEC_ID_WAVPACK,
247
    CODEC_ID_DSICINAUDIO,
K
Kostya Shishkov 已提交
248
    CODEC_ID_IMC,
K
Kostya Shishkov 已提交
249
    CODEC_ID_MUSEPACK7,
250
    CODEC_ID_MLP,
M
Michel Bardiaux 已提交
251
    CODEC_ID_GSM_MS, /* As found in WAV */
252

F
Fabrice Bellard 已提交
253
    /* subtitle codecs */
254 255 256
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,

257
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
258
                         stream (only used by libavformat) */
F
Fabrice Bellard 已提交
259
};
260

261
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
262 263
/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
264 265
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
F
Fabrice Bellard 已提交
266 267

enum CodecType {
268
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
269 270
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
271
    CODEC_TYPE_DATA,
F
Fabrice Bellard 已提交
272
    CODEC_TYPE_SUBTITLE,
273
    CODEC_TYPE_NB
F
Fabrice Bellard 已提交
274 275
};

F
Fabrice Bellard 已提交
276
/* currently unused, may be used if 24/32 bits samples ever supported */
277
/* all in native endian */
F
Fabrice Bellard 已提交
278
enum SampleFormat {
279
    SAMPLE_FMT_NONE = -1,
280 281 282
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
283
    SAMPLE_FMT_S32,             ///< signed 32 bits
284
    SAMPLE_FMT_FLT,             ///< float
F
Fabrice Bellard 已提交
285 286
};

F
Fabrice Bellard 已提交
287
/* in bytes */
288
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
F
Fabrice Bellard 已提交
289

290
/**
291
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
292
 * this is mainly needed because some optimized bitstream readers read
293 294 295
 * 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
296 297 298
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

299 300 301 302 303 304
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

305 306
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
307
    ME_ZERO = 1,
308 309 310 311
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
312 313 314 315
    ME_X1,
    ME_HEX,
    ME_UMH,
    ME_ITER,
316 317
};

M
Michael Niedermayer 已提交
318 319 320 321 322 323 324 325 326 327
enum AVDiscard{
//we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
    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 已提交
328 329 330 331 332 333 334
typedef struct RcOverride{
    int start_frame;
    int end_frame;
    int qscale; // if this is 0 then quality_factor will be used instead
    float quality_factor;
} RcOverride;

335
#define FF_MAX_B_FRAMES 16
336

M
Michael Niedermayer 已提交
337
/* encoding support
338
   these flags can be passed in AVCodecContext.flags before initing
D
Diego Biurrun 已提交
339
   Note: not everything is supported yet.
M
Michael Niedermayer 已提交
340
*/
F
Fabrice Bellard 已提交
341

342
#define CODEC_FLAG_QSCALE 0x0002  ///< use fixed qscale
343
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / Advanced prediction for H263
344 345 346 347
#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
348
/* parent program guarantees that the input for b-frame containing streams is not written to
349
   for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
350
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
351 352 353 354
#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
D
Diego Biurrun 已提交
355
#define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
356 357
#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
358
                                            of only at frame boundaries */
359 360
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< normalize adaptive quantization
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
361
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< force low delay
362 363 364 365
#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)
366
/* Fx : Flag for h263+ extra options */
367
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
M
Michael Niedermayer 已提交
368
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
369
#endif
M
Michael Niedermayer 已提交
370
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
371
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< Unlimited motion vector
372
#define CODEC_FLAG_CBP_RD         0x04000000 ///< use rate distortion optimization for cbp
373
#define CODEC_FLAG_QP_RD          0x08000000 ///< use rate distortion optimization for qp selectioon
374
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H263 Alternative inter vlc
M
Michael Niedermayer 已提交
375 376
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
M
Michael Niedermayer 已提交
377 378
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
M
Michael Niedermayer 已提交
379
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
B
Baptiste Coudurier 已提交
380
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
381
#define CODEC_FLAG2_FAST          0x00000001 ///< allow non spec compliant speedup tricks
382
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< strictly enforce GOP size
383
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< skip bitstream encoding
384
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< place global headers at every keyframe instead of in extradata
R
Robert Swain 已提交
385 386
#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
387
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
R
Robert Swain 已提交
388 389 390 391
#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
#define CODEC_FLAG2_BRDO          0x00000400 ///< b-frame rate-distortion optimization
392
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< use MPEG-2 intra VLC table
393
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< only do ME/MC (I frames -> ref, P frame -> ME+MC)
394
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format
M
skiprd  
Michael Niedermayer 已提交
395
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skiping
396
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< input bitstream might be truncated at a packet boundaries instead of only at frame boundaries
397
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< use MPEG-2 non linear quantizer
398

399
/* Unsupported options :
400 401
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
402
 *              Independent Segment Decoding */
403
/* /Fx */
F
Fabrice Bellard 已提交
404 405
/* codec capabilities */

406
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
M
Michael Niedermayer 已提交
407 408 409 410 411
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
412 413 414
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
415
#define CODEC_CAP_TRUNCATED       0x0008
416 417
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
418
/**
419
 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
420
 * if this is not set, the codec is guaranteed to never be feeded with NULL data
421
 */
422
#define CODEC_CAP_DELAY           0x0020
423 424 425 426 427
/**
 * 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 已提交
428

D
Diego Biurrun 已提交
429
//the following defines may change, don't expect compatibility if you use them
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
#define MB_TYPE_INTRA4x4   0x0001
#define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME h264 specific
#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, ...)

453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
/**
 * Pan Scan area.
 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
 */
typedef struct AVPanScan{
    /**
     * id.
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int id;

    /**
     * width and height in 1/16 pel
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int width;
    int height;

    /**
     * position of the top left corner in 1/16 pel for up to 3 fields/frames.
     * - encoding: set by user.
     * - decoding: set by lavc
     */
    int16_t position[3][2];
}AVPanScan;

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

689 690 691
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
M
Michael Niedermayer 已提交
692 693

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
694
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
D
Diego Biurrun 已提交
695 696
#define FF_BUFFER_TYPE_SHARED   4 ///< buffer from somewhere else, don't dealloc 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 dealloc anything
M
Michael Niedermayer 已提交
697

M
cleanup  
Michael Niedermayer 已提交
698

699 700 701 702
#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 已提交
703 704
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
705

706 707 708 709 710
#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)

M
Michael Niedermayer 已提交
711 712 713
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
714 715 716
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
717

718
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
719 720 721 722

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
723
typedef struct AVCodecContext {
724 725 726 727
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
M
Michael Niedermayer 已提交
728
    AVClass *av_class;
729
    /**
730 731
     * the average bitrate.
     * - encoding: set by user. unused for constant quantizer encoding
732
     * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
733
     */
F
Fabrice Bellard 已提交
734
    int bit_rate;
735 736

    /**
737
     * number of bits the bitstream is allowed to diverge from the reference.
738
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
739 740
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
741
     */
742
    int bit_rate_tolerance;
743 744

    /**
745 746 747
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
748
     */
F
Fabrice Bellard 已提交
749
    int flags;
750 751 752

    /**
     * some codecs needs additionnal format info. It is stored here
M
Michael Niedermayer 已提交
753 754 755 756
     * if any muxer uses this then ALL demuxers/parsers AND encoders for the specific codec MUST set it correctly
     * too otherwise stream copy breaks
     * in general use of this field by muxers is not recommanded
     * - encoding: set by lavc.
757
     * - decoding: set by lavc. (FIXME is this ok?)
758 759 760 761
     */
    int sub_id;

    /**
762
     * motion estimation algorithm used for video coding.
R
Robert Swain 已提交
763 764
     * 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]
765 766
     * - encoding: MUST be set by user.
     * - decoding: unused
767 768 769 770
     */
    int me_method;

    /**
771
     * some codecs need / can use extra-data like huffman tables.
772 773
     * mjpeg: huffman tables
     * rv10: additional flags
774
     * mpeg4: global headers (they can be in the bitstream or here)
775 776
     * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
     * then extradata_size to avoid prolems if its read with the bitstream reader
M
Michael Niedermayer 已提交
777
     * the bytewise contents of extradata must not depend on the architecture or cpu endianness
778 779
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
780
     */
781
    uint8_t *extradata;
782
    int extradata_size;
783

784
    /**
785 786 787 788
     * this is the fundamental unit of time (in seconds) in terms
     * of which frame timestamps are represented. for fixed-fps content,
     * timebase should be 1/framerate and timestamp increments should be
     * identically 1.
789
     * - encoding: MUST be set by user
790
     * - decoding: set by lavc.
791
     */
792
    AVRational time_base;
793

794
    /* video only */
795
    /**
796
     * picture width / height.
797
     * - encoding: MUST be set by user.
798
     * - decoding: set by lavc.
799
     * Note, for compatibility its possible to set this instead of
800
     * coded_width/height before decoding
801
     */
F
Fabrice Bellard 已提交
802
    int width, height;
803

804
#define FF_ASPECT_EXTENDED 15
805 806

    /**
807 808 809
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
810 811 812 813
     */
    int gop_size;

    /**
814
     * pixel format, see PIX_FMT_xxx.
815
     * - encoding: set by user.
816
     * - decoding: set by lavc.
817
     */
818
    enum PixelFormat pix_fmt;
819

820
    /**
821
     * Frame rate emulation. If not zero lower layer (i.e. format handler)
822 823 824 825 826
     * has to read frames at native frame rate.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int rate_emu;
827

828 829 830 831 832
    /**
     * if non NULL, 'draw_horiz_band' is called by the libavcodec
     * decoder to draw an horizontal band. It improve cache usage. Not
     * all codecs can do that. You must check the codec capabilities
     * before
833 834
     * - encoding: unused
     * - decoding: set by user.
835 836 837 838
     * @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
839
     */
F
Fabrice Bellard 已提交
840
    void (*draw_horiz_band)(struct AVCodecContext *s,
841
                            const AVFrame *src, int offset[4],
842
                            int y, int type, int height);
F
Fabrice Bellard 已提交
843

F
Fabrice Bellard 已提交
844
    /* audio only */
845
    int sample_rate; ///< samples per sec
F
Fabrice Bellard 已提交
846
    int channels;
847 848 849 850 851 852

    /**
     * audio sample format.
     * - encoding: set by user.
     * - decoding: set by lavc.
     */
853
    enum SampleFormat sample_fmt;  ///< sample format, currenly unused
F
Fabrice Bellard 已提交
854 855

    /* the following data should not be initialized */
856
    /**
857
     * samples per packet. initialized when calling 'init'
858 859
     */
    int frame_size;
860 861 862
    int frame_number;   ///< audio or video frame number
    int real_pict_num;  ///< returns the real picture number of previous encoded frame

863
    /**
864
     * number of frames the decoded output will be delayed relative to
865 866 867
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
868 869
     */
    int delay;
870

871 872
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
873 874
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

875
    /**
876 877 878
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
879 880 881 882
     */
    int qmin;

    /**
883 884 885
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
886 887 888 889
     */
    int qmax;

    /**
P
Typo  
Panagiotis Issaris 已提交
890
     * maximum quantizer difference between frames.
891 892
     * - encoding: set by user.
     * - decoding: unused
893 894 895 896
     */
    int max_qdiff;

    /**
897
     * maximum number of b frames between non b frames.
898
     * note: the output will be delayed by max_b_frames+1 relative to the input
899 900
     * - encoding: set by user.
     * - decoding: unused
901 902 903 904
     */
    int max_b_frames;

    /**
905 906 907
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
908 909
     */
    float b_quant_factor;
910

911 912
    /** obsolete FIXME remove */
    int rc_strategy;
M
Michael Niedermayer 已提交
913 914
#define FF_RC_STRATEGY_XVID 1

915
    int b_frame_strategy;
916

917
    /**
918 919 920
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
921
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
922 923
     */
    int hurry_up;
924

F
Fabrice Bellard 已提交
925
    struct AVCodec *codec;
926

F
Fabrice Bellard 已提交
927 928
    void *priv_data;

929
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
M
Michael Niedermayer 已提交
930 931
    /* unused, FIXME remove*/
    int rtp_mode;
932
#endif
933

D
Diego Biurrun 已提交
934
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
935 936 937 938 939
                            /* do it's best to deliver a chunk with size    */
                            /* below rtp_payload_size, the chunk will start */
                            /* with a start code on some codecs like H.263  */
                            /* This doesn't take account of any particular  */
                            /* headers inside the transmited RTP payload    */
940

941

D
Diego Biurrun 已提交
942 943 944 945 946 947
    /* The RTP callback: This function is called   */
    /* every time the encoder has a packet to send */
    /* 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                  */
948
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
949

950 951 952 953 954 955 956 957
    /* 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;
958
    int misc_bits;
959

960
    /**
961 962
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
963
     * - decoding: unused
964
     */
965
    int frame_bits;
966

967
    /**
968 969 970
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
971 972 973
     */
    void *opaque;

F
Fabrice Bellard 已提交
974
    char codec_name[32];
975 976
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
977

978 979 980
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
M
Michael Niedermayer 已提交
981 982 983 984 985 986 987
     * a demuxer should set this to what is stored in the field used to identify the codec
     * if there are mutiple 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 32bit then the demxuer should
     * remap the longer id to 32bit with a table or other structure alternatively a new
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
     * first
988
     * - encoding: set by user, if not then the default based on codec_id will be used
989 990 991
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
992

993
    /**
994
     * workaround bugs in encoders which sometimes cannot be detected automatically.
995
     * - encoding: set by user
996
     * - decoding: set by user
997 998
     */
    int workaround_bugs;
999
#define FF_BUG_AUTODETECT       1  ///< autodetection
1000 1001 1002 1003
#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 已提交
1004
#define FF_BUG_AMV              32
1005
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
M
Michael Niedermayer 已提交
1006
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
1007
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
1008
#define FF_BUG_QPEL_CHROMA2     256
1009
#define FF_BUG_DIRECT_BLOCKSIZE 512
1010
#define FF_BUG_EDGE             1024
1011
#define FF_BUG_HPEL_CHROMA      2048
1012
#define FF_BUG_DC_CLIP          4096
1013
#define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
1014
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
1015

1016
    /**
1017 1018 1019
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
1020
     */
1021
    int luma_elim_threshold;
1022

1023
    /**
1024 1025 1026
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
1027
     */
1028
    int chroma_elim_threshold;
1029

1030
    /**
1031 1032 1033
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
1034 1035
     */
    int strict_std_compliance;
1036 1037 1038 1039 1040 1041
#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
#define FF_COMPLIANCE_NORMAL        0
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< allow inofficial extensions
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things

1042
    /**
1043
     * qscale offset between ip and b frames.
1044 1045
     * 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)
1046 1047
     * - encoding: set by user.
     * - decoding: unused
1048 1049
     */
    float b_quant_offset;
1050

1051
    /**
1052
     * error resilience higher values will detect more errors but may missdetect
1053 1054 1055
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
1056
     */
1057
    int error_resilience;
D
Diego Biurrun 已提交
1058
#define FF_ER_CAREFUL         1
1059 1060 1061
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1062

1063
    /**
M
cleanup  
Michael Niedermayer 已提交
1064 1065
     * 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 lavc
1066 1067
     * avcodec_align_dimensions() should be used to find the required width and
     * height, as they normally need to be rounded up to the next multiple of 16
1068 1069
     * - encoding: unused
     * - decoding: set by lavc, user can override
1070
     */
M
Michael Niedermayer 已提交
1071
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1072

1073
    /**
M
cleanup  
Michael Niedermayer 已提交
1074 1075 1076
     * 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
1077 1078
     * - encoding: unused
     * - decoding: set by lavc, user can override
1079
     */
M
Michael Niedermayer 已提交
1080
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1081

1082
    /**
1083 1084
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
1085
     * - decoding: set by lavc
1086 1087
     */
    int has_b_frames;
1088 1089 1090 1091 1092 1093

    /**
     * number of bytes per packet if constant and known or 0
     * used by some WAV based audio codecs
     */
    int block_align;
1094

1095
    int parse_only; /* - decoding only: if true, only parsing is done
1096 1097
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1098

1099
    /**
1100
     * 0-> h263 quant 1-> mpeg quant.
1101 1102
     * - encoding: set by user.
     * - decoding: unused
1103 1104
     */
    int mpeg_quant;
1105

1106
    /**
1107 1108 1109
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
1110
     */
1111
    char *stats_out;
1112

1113 1114 1115
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1116 1117
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1118 1119
     */
    char *stats_in;
1120

1121
    /**
1122
     * ratecontrol qmin qmax limiting method.
1123
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1124 1125
     * - encoding: set by user.
     * - decoding: unused
1126
     */
M
Michael Niedermayer 已提交
1127
    float rc_qsquish;
1128

M
Michael Niedermayer 已提交
1129 1130
    float rc_qmod_amp;
    int rc_qmod_freq;
1131

1132
    /**
1133 1134 1135
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1136
     */
M
Michael Niedermayer 已提交
1137 1138
    RcOverride *rc_override;
    int rc_override_count;
1139

1140
    /**
1141 1142 1143
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1144
     */
M
Michael Niedermayer 已提交
1145
    char *rc_eq;
1146

1147
    /**
1148 1149 1150
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1151
     */
M
Michael Niedermayer 已提交
1152
    int rc_max_rate;
1153

1154
    /**
1155 1156 1157
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1158
     */
M
Michael Niedermayer 已提交
1159
    int rc_min_rate;
1160

1161
    /**
1162 1163 1164
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1165
     */
M
Michael Niedermayer 已提交
1166 1167
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1168 1169

    /**
1170
     * qscale factor between p and i frames.
1171 1172
     * 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)
1173 1174
     * - encoding: set by user.
     * - decoding: unused
1175 1176
     */
    float i_quant_factor;
1177

1178
    /**
1179 1180 1181
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1182 1183
     */
    float i_quant_offset;
1184

1185
    /**
1186 1187 1188
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1189
     */
M
Michael Niedermayer 已提交
1190
    float rc_initial_cplx;
1191

1192
    /**
1193 1194 1195
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1196
     */
1197
    int dct_algo;
1198
#define FF_DCT_AUTO    0
1199
#define FF_DCT_FASTINT 1
1200 1201 1202
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1203
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
1204
#define FF_DCT_FAAN    6
1205

1206
    /**
1207 1208 1209
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1210 1211
     */
    float lumi_masking;
1212

1213
    /**
1214 1215 1216
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1217 1218
     */
    float temporal_cplx_masking;
1219

1220
    /**
1221 1222 1223
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1224 1225
     */
    float spatial_cplx_masking;
1226

1227
    /**
1228 1229 1230
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1231 1232
     */
    float p_masking;
1233

1234
    /**
1235 1236 1237
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1238 1239
     */
    float dark_masking;
1240 1241


1242 1243
    /* for binary compatibility */
    int unused;
1244

1245
    /**
1246 1247 1248
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
     */
    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
1259
#define FF_IDCT_ALTIVEC      8
1260
#define FF_IDCT_SH4          9
1261
#define FF_IDCT_SIMPLEARM    10
1262
#define FF_IDCT_H264         11
1263
#define FF_IDCT_VP3          12
1264
#define FF_IDCT_IPP          13
M
Michael Niedermayer 已提交
1265
#define FF_IDCT_XVIDMMX      14
1266
#define FF_IDCT_CAVS         15
M
Måns Rullgård 已提交
1267
#define FF_IDCT_SIMPLEARMV5TE 16
M
Måns Rullgård 已提交
1268
#define FF_IDCT_SIMPLEARMV6  17
1269

1270
    /**
1271 1272 1273
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1274 1275 1276
     */
    int slice_count;
    /**
1277 1278 1279
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1280 1281 1282
     */
    int *slice_offset;

1283
    /**
1284 1285 1286
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1287 1288 1289 1290 1291
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1292
    /**
Z
Zdenek Kabelac 已提交
1293
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1294
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1295 1296 1297 1298 1299 1300
     *
     * with FORCE flag you may instead enable given CPU features
     * (Dangerous: usable in case of misdetection, improper usage however will
     * result into program crash)
     */
    unsigned dsp_mask;
1301
#define FF_MM_FORCE    0x80000000 /* force usage of selected flags (OR) */
Z
Zdenek Kabelac 已提交
1302 1303
    /* lower 16 bits - CPU features */
#ifdef HAVE_MMX
1304 1305 1306 1307 1308 1309
#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 */
Z
Zdenek Kabelac 已提交
1310
#endif /* HAVE_MMX */
1311
#ifdef HAVE_IWMMXT
1312
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1313
#endif /* HAVE_IWMMXT */
M
huffyuv  
Michael Niedermayer 已提交
1314 1315

    /**
1316 1317 1318
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
1319 1320
     */
     int bits_per_sample;
1321

M
huffyuv  
Michael Niedermayer 已提交
1322
    /**
1323 1324 1325
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1326 1327 1328 1329 1330
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1331

M
Michael Niedermayer 已提交
1332
    /**
M
Michael Niedermayer 已提交
1333
     * sample aspect ratio (0 if unknown).
1334
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1335 1336
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
1337
     */
M
Michael Niedermayer 已提交
1338
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1339 1340

    /**
1341 1342 1343
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
1344
     */
M
Michael Niedermayer 已提交
1345
    AVFrame *coded_frame;
1346 1347

    /**
1348 1349 1350
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1351 1352 1353 1354 1355 1356 1357 1358
     */
    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
1359
#define FF_DEBUG_DCT_COEFF 0x00000040
M
Michael Niedermayer 已提交
1360 1361 1362
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1363
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1364
#define FF_DEBUG_MMCO      0x00000800
1365
#define FF_DEBUG_BUGS      0x00001000
M
Michael Niedermayer 已提交
1366 1367
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1368

1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
    /**
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    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

1379
    /**
1380 1381 1382
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1383 1384
     */
    uint64_t error[4];
1385

M
Michael Niedermayer 已提交
1386
    /**
1387
     * minimum MB quantizer.
1388
     * - encoding: unused
1389
     * - decoding: unused
M
Michael Niedermayer 已提交
1390 1391 1392 1393
     */
    int mb_qmin;

    /**
1394
     * maximum MB quantizer.
1395
     * - encoding: unused
1396
     * - decoding: unused
M
Michael Niedermayer 已提交
1397 1398
     */
    int mb_qmax;
1399

M
Michael Niedermayer 已提交
1400
    /**
1401 1402 1403
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1404 1405 1406
     */
    int me_cmp;
    /**
1407 1408 1409
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1410 1411 1412
     */
    int me_sub_cmp;
    /**
1413 1414 1415
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1416 1417
     */
    int mb_cmp;
1418 1419 1420 1421 1422 1423
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
M
Michael Niedermayer 已提交
1424 1425 1426 1427 1428 1429 1430 1431
#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
1432 1433
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1434
#define FF_CMP_NSSE 10
M
Michael Niedermayer 已提交
1435 1436
#define FF_CMP_W53  11
#define FF_CMP_W97  12
1437
#define FF_CMP_DCTMAX 13
1438
#define FF_CMP_DCT264 14
M
Michael Niedermayer 已提交
1439
#define FF_CMP_CHROMA 256
1440

M
Michael Niedermayer 已提交
1441
    /**
1442 1443 1444
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1445 1446
     */
    int dia_size;
1447 1448

    /**
1449 1450 1451
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1452 1453
     */
    int last_predictor_count;
1454

M
Michael Niedermayer 已提交
1455
    /**
1456 1457 1458
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1459 1460
     */
    int pre_me;
1461

1462
    /**
1463 1464 1465
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1466 1467
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1468

1469
    /**
1470 1471 1472
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1473 1474 1475
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1476
    /**
1477 1478 1479
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1480 1481 1482
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1483
    /**
1484
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1485 1486 1487 1488
     * @param fmt is the list of formats which are supported by the codec,
     * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
     * the first is allways the native one
     * @return the choosen format
1489 1490
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1491
     */
I
Ivan Kalvachev 已提交
1492
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1493 1494 1495 1496 1497

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
1498
     *
1499
     * - encoding: unused.
1500
     * - decoding: set by decoder
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
     */
    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

1511 1512 1513
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
1514
     *
1515 1516
     * - encoding: set by user.
     * - decoding: unused.
1517
     */
Z
Zdenek Kabelac 已提交
1518
    int me_range;
1519

1520 1521 1522 1523 1524 1525 1526
    /**
     * intra quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1527

1528 1529 1530 1531 1532 1533
    /**
     * inter quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_quant_bias;
1534 1535 1536 1537 1538 1539 1540 1541

    /**
     * color table ID.
     * - encoding: unused.
     * - decoding: which clrtable should be used for 8bit RGB images
     *             table have to be stored somewhere FIXME
     */
    int color_table_id;
1542

1543
    /**
1544
     * internal_buffer count.
D
Diego Biurrun 已提交
1545
     * Don't touch, used by lavc default_get_buffer()
1546 1547
     */
    int internal_buffer_count;
1548

1549
    /**
1550
     * internal_buffers.
D
Diego Biurrun 已提交
1551
     * Don't touch, used by lavc default_get_buffer()
1552 1553
     */
    void *internal_buffer;
1554 1555 1556 1557 1558 1559 1560

#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 已提交
1561 1562 1563 1564 1565 1566 1567
    /**
     * global quality for codecs which cannot change it per frame.
     * this should be proportional to MPEG1/2/4 qscale.
     * - encoding: set by user.
     * - decoding: unused
     */
    int global_quality;
1568

M
Michael Niedermayer 已提交
1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583
#define FF_CODER_TYPE_VLC   0
#define FF_CODER_TYPE_AC    1
    /**
     * coder type
     * - encoding: set by user.
     * - decoding: unused
     */
    int coder_type;

    /**
     * context model
     * - encoding: set by user.
     * - decoding: unused
     */
    int context_model;
1584 1585 1586 1587 1588 1589 1590 1591
#if 0
    /**
     *
     * - encoding: unused
     * - decoding: set by user.
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1592

1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
    /**
     * slice flags
     * - encoding: unused
     * - decoding: set by user.
     */
    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 已提交
1603 1604 1605 1606 1607 1608
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1609

1610 1611 1612 1613 1614 1615 1616 1617 1618
    /**
     * macroblock decision mode
     * - encoding: set by user.
     * - 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
1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632

    /**
     * custom intra quantization matrix
     * - encoding: set by user, can be NULL
     * - decoding: set by lavc
     */
    uint16_t *intra_matrix;

    /**
     * custom inter quantization matrix
     * - encoding: set by user, can be NULL
     * - decoding: set by lavc
     */
    uint16_t *inter_matrix;
1633

1634 1635 1636 1637 1638 1639 1640
    /**
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
     * - encoding: unused
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int stream_codec_tag;
M
Michael Niedermayer 已提交
1641 1642 1643 1644 1645 1646 1647 1648

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662

    /**
     * minimum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmin;

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1663 1664 1665 1666 1667 1668 1669

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1670 1671 1672 1673 1674 1675 1676

    /**
     * noise reduction strength
     * - encoding: set by user.
     * - decoding: unused
     */
    int noise_reduction;
1677

1678
    /**
1679 1680 1681 1682 1683
     * called at the beginning of a frame to get cr buffer for it.
     * buffer type (size, hints) must be the same. lavc won't check it.
     * lavc will pass previous buffer in pic, function should return
     * same buffer or new buffer with old frame "painted" into it.
     * if pic.data[0] == NULL must behave like get_buffer().
1684
     * - encoding: unused
1685
     * - decoding: set by lavc, user can override
1686
     */
1687
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708

    /**
     * number of bits which should be loaded into the rc buffer before decoding starts
     * - encoding: set by user.
     * - decoding: unused
     */
    int rc_initial_buffer_occupancy;

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_threshold;

    /**
     * CODEC_FLAG2_*.
     * - encoding: set by user.
     * - decoding: set by user.
     */
    int flags2;
1709 1710 1711 1712 1713 1714 1715

    /**
     * simulates errors in the bitstream to test error concealment.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int error_rate;
1716

1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
    /**
     * MP3 antialias algorithm, see FF_AA_* below.
     * - encoding: unused
     * - decoding: set by user
     */
    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 已提交
1727 1728 1729 1730 1731 1732
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1733 1734 1735

    /**
     * Thread count.
1736
     * is used to decide how many independent tasks should be passed to execute()
1737 1738 1739 1740
     * - encoding: set by user
     * - decoding: set by user
     */
    int thread_count;
1741

1742
    /**
1743
     * the codec may call this to execute several independent things. it will return only after
1744 1745
     * finishing all tasks, the user may replace this with some multithreaded implementation, the
     * default implementation will execute the parts serially
1746
     * @param count the number of things to execute
1747 1748 1749 1750
     * - encoding: set by lavc, user can override
     * - decoding: set by lavc, user can override
     */
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1751

1752 1753 1754 1755 1756 1757 1758
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1759 1760

    /**
1761
     * Motion estimation threshold. under which no motion estimation is
1762
     * performed, but instead the user specified motion vectors are used
1763
     *
1764
     * - encoding: set by user
1765
     * - decoding: unused
1766
     */
M
Michael Niedermayer 已提交
1767
     int me_threshold;
1768 1769 1770 1771 1772 1773 1774

    /**
     * Macroblock threshold. under which the user specified macroblock types will be used
     * - encoding: set by user
     * - decoding: unused
     */
     int mb_threshold;
1775 1776

    /**
M
Michael Niedermayer 已提交
1777
     * precision of the intra dc coefficient - 8.
1778 1779 1780 1781
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
M
Michael Niedermayer 已提交
1782 1783 1784 1785 1786 1787 1788

    /**
     * noise vs. sse weight for the nsse comparsion function.
     * - encoding: set by user
     * - decoding: unused
     */
     int nsse_weight;
1789 1790

    /**
1791
     * number of macroblock rows at the top which are skipped.
1792 1793 1794 1795 1796 1797
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
1798
     * number of macroblock rows at the bottom which are skipped.
1799 1800 1801 1802
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818

    /**
     * profile
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int profile;
#define FF_PROFILE_UNKNOWN -99

    /**
     * level
     * - encoding: set by user
     * - decoding: set by lavc
     */
     int level;
#define FF_LEVEL_UNKNOWN -99
M
Michael Niedermayer 已提交
1819 1820 1821 1822 1823 1824 1825

    /**
     * low resolution decoding. 1-> 1/2 size, 2->1/4 size
     * - encoding: unused
     * - decoding: set by user
     */
     int lowres;
1826 1827

    /**
M
Michael Niedermayer 已提交
1828
     * bitsream width / height. may be different from width/height if lowres
1829 1830 1831 1832 1833
     * or other things are used
     * - encoding: unused
     * - decoding: set by user before init if known, codec should override / dynamically change if needed
     */
    int coded_width, coded_height;
M
Michael Niedermayer 已提交
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847

    /**
     * frame skip threshold
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_threshold;

    /**
     * frame skip factor
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_factor;
1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861

    /**
     * frame skip exponent
     * - encoding: set by user
     * - decoding: unused
     */
    int frame_skip_exp;

    /**
     * frame skip comparission function
     * - encoding: set by user.
     * - decoding: unused
     */
    int frame_skip_cmp;
1862 1863 1864 1865 1866 1867 1868 1869

    /**
     * border processing masking. raises the quantizer for mbs on the borders
     * of the picture.
     * - encoding: set by user
     * - decoding: unused
     */
    float border_masking;
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883

    /**
     * minimum MB lagrange multipler.
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_lmin;

    /**
     * maximum MB lagrange multipler.
     * - encoding: set by user.
     * - decoding: unused
     */
    int mb_lmax;
1884 1885

    /**
1886
     *
1887 1888 1889 1890
     * - encoding: set by user.
     * - decoding: unused
     */
    int me_penalty_compensation;
M
Michael Niedermayer 已提交
1891 1892

    /**
1893
     *
M
Michael Niedermayer 已提交
1894 1895 1896 1897 1898 1899
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_loop_filter;

    /**
1900
     *
M
Michael Niedermayer 已提交
1901 1902 1903 1904 1905 1906
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_idct;

    /**
1907
     *
M
Michael Niedermayer 已提交
1908 1909 1910 1911
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_frame;
M
Michael Niedermayer 已提交
1912 1913 1914 1915 1916 1917 1918

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int bidir_refine;
1919 1920 1921 1922 1923 1924 1925

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int brd_scale;
R
Robert Swain 已提交
1926 1927 1928 1929 1930 1931

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
     * - encoding: set by user.
     * - decoding: unused
     */
L
Luca Barbato 已提交
1932
    float crf;
R
Robert Swain 已提交
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016

    /**
     * constant quantization parameter rate control method
     * - encoding: set by user.
     * - decoding: unused
     */
    int cqp;

    /**
     * minimum gop size
     * - encoding: set by user.
     * - decoding: unused
     */
    int keyint_min;

    /**
     * number of reference frames
     * - encoding: set by user.
     * - decoding: unused
     */
    int refs;

    /**
     * chroma qp offset from luma
     * - encoding: set by user.
     * - decoding: unused
     */
    int chromaoffset;

    /**
     * influences how often b-frames are used
     * - encoding: set by user.
     * - decoding: unused
     */
    int bframebias;

    /**
     * trellis RD quantization
     * - encoding: set by user.
     * - decoding: unused
     */
    int trellis;

    /**
     * reduce fluctuations in qp (before curve compression)
     * - encoding: set by user.
     * - decoding: unused
     */
    float complexityblur;

    /**
     * in-loop deblocking filter alphac0 parameter
     * alpha is in the range -6...6
     * - encoding: set by user.
     * - decoding: unused
     */
    int deblockalpha;

    /**
     * in-loop deblocking filter beta parameter
     * beta is in the range -6...6
     * - encoding: set by user.
     * - decoding: unused
     */
    int deblockbeta;

    /**
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
     * - encoding: set by user.
     * - 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 */

    /**
     * direct mv prediction mode - 0 (none), 1 (spatial), 2 (temporal)
     * - encoding: set by user.
     * - decoding: unused
     */
    int directpred;
2017

2018 2019 2020 2021 2022 2023
    /**
     * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
     * - encoding: set by user.
     * - decoding: unused
     */
    int cutoff;
C
Corey Hickey 已提交
2024 2025 2026 2027 2028 2029 2030

    /**
     * multiplied by qscale for each frame and added to scene_change_score
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_factor;
2031 2032 2033 2034 2035 2036 2037 2038

    /**
     *
     * note: value depends upon the compare functin used for fullpel ME
     * - encoding: set by user.
     * - decoding: unused
     */
    int mv0_threshold;
2039 2040 2041 2042 2043 2044 2045

    /**
     * adjusts sensitivity of b_frame_strategy 1
     * - encoding: set by user.
     * - decoding: unused
     */
    int b_sensitivity;
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097

    /**
     * - encoding: set by user.
     * - decoding: unused
     */
    int compression_level;
#define FF_COMPRESSION_DEFAULT -1

    /**
     * sets whether to use LPC mode - used by FLAC encoder
     * - encoding: set by user.
     * - decoding: unused.
     */
    int use_lpc;

    /**
     * LPC coefficient precision - used by FLAC encoder
     * - encoding: set by user.
     * - decoding: unused.
     */
    int lpc_coeff_precision;

    /**
     * - encoding: set by user.
     * - decoding: unused.
     */
    int min_prediction_order;

    /**
     * - encoding: set by user.
     * - decoding: unused.
     */
    int max_prediction_order;

    /**
     * search method for selecting prediction order
     * - encoding: set by user.
     * - decoding: unused.
     */
    int prediction_order_method;

    /**
     * - encoding: set by user.
     * - decoding: unused.
     */
    int min_partition_order;

    /**
     * - encoding: set by user.
     * - decoding: unused.
     */
    int max_partition_order;
2098 2099 2100 2101 2102 2103 2104

    /**
     * GOP timecode frame start number, in non drop frame format
     * - encoding: set by user.
     * - decoding: unused.
     */
    int64_t timecode_frame_start;
F
Fabrice Bellard 已提交
2105 2106
} AVCodecContext;

2107 2108 2109
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
2110
typedef struct AVCodec {
2111
    const char *name;
Z
Zdenek Kabelac 已提交
2112
    enum CodecType type;
M
Michael Niedermayer 已提交
2113
    enum CodecID id;
F
Fabrice Bellard 已提交
2114 2115
    int priv_data_size;
    int (*init)(AVCodecContext *);
2116
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
2117
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
2118
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2119
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2120
    int capabilities;
F
Fabrice Bellard 已提交
2121
    struct AVCodec *next;
M
Michael Niedermayer 已提交
2122
    void (*flush)(AVCodecContext *);
Z
* const  
Zdenek Kabelac 已提交
2123
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2124
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
F
Fabrice Bellard 已提交
2125 2126
} AVCodec;

2127
/**
2128 2129 2130
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
2131
typedef struct AVPicture {
2132
    uint8_t *data[4];
M
Michael Niedermayer 已提交
2133
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
2134 2135
} AVPicture;

M
Mike Melanson 已提交
2136 2137 2138 2139
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
2140
 * this is totally broken, palette changes should be sent as AVPackets
M
Mike Melanson 已提交
2141
 */
2142
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
2143
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
2144 2145 2146 2147 2148 2149
typedef struct AVPaletteControl {

    /* demuxer sets this to 1 to indicate the palette has changed;
     * decoder resets to 0 */
    int palette_changed;

2150 2151 2152 2153
    /* 4-byte ARGB palette entries, stored in native byte order; note that
     * the individual palette components should be on a 8-bit scale; if
     * the palette data comes from a IBM VGA native format, the component
     * data is probably 6 bits in size and needs to be scaled */
2154
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
2155

2156
} AVPaletteControl attribute_deprecated;
M
Mike Melanson 已提交
2157

2158
typedef struct AVSubtitleRect {
F
Fabrice Bellard 已提交
2159 2160 2161 2162 2163 2164 2165 2166
    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;
2167 2168 2169 2170 2171 2172 2173 2174
} 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 已提交
2175 2176
} AVSubtitle;

F
Fabrice Bellard 已提交
2177
extern AVCodec ac3_encoder;
2178 2179 2180 2181
extern AVCodec amr_nb_encoder;
extern AVCodec amr_wb_encoder;
extern AVCodec asv1_encoder;
extern AVCodec asv2_encoder;
2182
extern AVCodec bmp_encoder;
2183
extern AVCodec dvvideo_encoder;
2184
extern AVCodec faac_encoder;
2185 2186
extern AVCodec ffv1_encoder;
extern AVCodec ffvhuff_encoder;
2187
extern AVCodec flac_encoder;
2188 2189
extern AVCodec flashsv_encoder;
extern AVCodec flv_encoder;
2190
extern AVCodec gif_encoder;
2191
extern AVCodec h261_encoder;
F
Fabrice Bellard 已提交
2192 2193
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
2194 2195
extern AVCodec h264_encoder;
extern AVCodec huffyuv_encoder;
2196
extern AVCodec jpegls_encoder;
2197
extern AVCodec libgsm_encoder;
M
Michel Bardiaux 已提交
2198
extern AVCodec libgsm_ms_encoder;
D
Diego Biurrun 已提交
2199
extern AVCodec libtheora_encoder;
2200 2201 2202 2203 2204 2205 2206
extern AVCodec ljpeg_encoder;
extern AVCodec mdec_encoder;
extern AVCodec mjpeg_encoder;
extern AVCodec mp2_encoder;
extern AVCodec mp3lame_encoder;
extern AVCodec mpeg1video_encoder;
extern AVCodec mpeg2video_encoder;
F
Fabrice Bellard 已提交
2207
extern AVCodec mpeg4_encoder;
2208 2209 2210
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
2211 2212 2213 2214 2215 2216 2217 2218 2219
extern AVCodec oggvorbis_encoder;
extern AVCodec pam_encoder;
extern AVCodec pbm_encoder;
extern AVCodec pgm_encoder;
extern AVCodec pgmyuv_encoder;
extern AVCodec png_encoder;
extern AVCodec ppm_encoder;
extern AVCodec rv10_encoder;
extern AVCodec rv20_encoder;
2220
extern AVCodec snow_encoder;
2221 2222
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
2223
extern AVCodec svq1_encoder;
B
Bobby Bingham 已提交
2224
extern AVCodec targa_encoder;
2225 2226
extern AVCodec vcr1_encoder;
extern AVCodec vorbis_encoder;
M
Michael Niedermayer 已提交
2227 2228
extern AVCodec wmav1_encoder;
extern AVCodec wmav2_encoder;
2229 2230
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
2231
extern AVCodec x264_encoder;
2232 2233
extern AVCodec xvid_encoder;
extern AVCodec zlib_encoder;
2234
extern AVCodec zmbv_encoder;
F
Fabrice Bellard 已提交
2235

2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250
extern AVCodec aac_decoder;
extern AVCodec aasc_decoder;
extern AVCodec alac_decoder;
extern AVCodec amr_nb_decoder;
extern AVCodec amr_wb_decoder;
extern AVCodec asv1_decoder;
extern AVCodec asv2_decoder;
extern AVCodec avs_decoder;
extern AVCodec bmp_decoder;
extern AVCodec cavs_decoder;
extern AVCodec cinepak_decoder;
extern AVCodec cljr_decoder;
extern AVCodec cook_decoder;
extern AVCodec cscd_decoder;
extern AVCodec cyuv_decoder;
K
Kostya Shishkov 已提交
2251
extern AVCodec dca_decoder;
B
Baptiste Coudurier 已提交
2252
extern AVCodec dnxhd_decoder;
2253 2254 2255
extern AVCodec dsicinaudio_decoder;
extern AVCodec dsicinvideo_decoder;
extern AVCodec dvvideo_decoder;
K
Kostya Shishkov 已提交
2256
extern AVCodec dxa_decoder;
2257 2258 2259 2260 2261 2262 2263 2264 2265
extern AVCodec eightbps_decoder;
extern AVCodec ffv1_decoder;
extern AVCodec ffvhuff_decoder;
extern AVCodec flac_decoder;
extern AVCodec flashsv_decoder;
extern AVCodec flic_decoder;
extern AVCodec flv_decoder;
extern AVCodec fourxm_decoder;
extern AVCodec fraps_decoder;
2266
extern AVCodec gif_decoder;
2267
extern AVCodec h261_decoder;
2268
extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
2269
extern AVCodec h263i_decoder;
2270 2271 2272 2273 2274 2275 2276 2277 2278 2279
extern AVCodec h264_decoder;
extern AVCodec huffyuv_decoder;
extern AVCodec idcin_decoder;
extern AVCodec imc_decoder;
extern AVCodec indeo2_decoder;
extern AVCodec indeo3_decoder;
extern AVCodec interplay_dpcm_decoder;
extern AVCodec interplay_video_decoder;
extern AVCodec kmvc_decoder;
extern AVCodec libgsm_decoder;
M
Michel Bardiaux 已提交
2280
extern AVCodec libgsm_ms_decoder;
2281 2282 2283 2284
extern AVCodec loco_decoder;
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
extern AVCodec mdec_decoder;
F
Fabrice Bellard 已提交
2285
extern AVCodec mjpeg_decoder;
2286
extern AVCodec mjpegb_decoder;
2287
extern AVCodec mmvideo_decoder;
2288
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
2289
extern AVCodec mp3_decoder;
R
Roberto Togni 已提交
2290
extern AVCodec mp3adu_decoder;
2291
extern AVCodec mp3on4_decoder;
2292 2293 2294 2295
extern AVCodec mpc7_decoder;
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
extern AVCodec mpeg4_decoder;
2296
extern AVCodec mpeg4aac_decoder;
2297 2298 2299 2300 2301
extern AVCodec mpeg_xvmc_decoder;
extern AVCodec mpegvideo_decoder;
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
2302 2303
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
R
Roberto Togni 已提交
2304
extern AVCodec mszh_decoder;
2305 2306 2307 2308 2309 2310 2311
extern AVCodec nuv_decoder;
extern AVCodec oggvorbis_decoder;
extern AVCodec png_decoder;
extern AVCodec qdm2_decoder;
extern AVCodec qdraw_decoder;
extern AVCodec qpeg_decoder;
extern AVCodec qtrle_decoder;
2312 2313
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
2314
extern AVCodec roq_decoder;
2315
extern AVCodec roq_dpcm_decoder;
2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
extern AVCodec rpza_decoder;
extern AVCodec rv10_decoder;
extern AVCodec rv20_decoder;
extern AVCodec rv30_decoder;
extern AVCodec rv40_decoder;
extern AVCodec shorten_decoder;
extern AVCodec smackaud_decoder;
extern AVCodec smacker_decoder;
extern AVCodec smc_decoder;
extern AVCodec snow_decoder;
2326
extern AVCodec sol_dpcm_decoder;
2327
extern AVCodec sonic_decoder;
2328 2329 2330 2331 2332
extern AVCodec sp5x_decoder;
extern AVCodec svq1_decoder;
extern AVCodec svq3_decoder;
extern AVCodec targa_decoder;
extern AVCodec theora_decoder;
2333
extern AVCodec thp_decoder;
2334 2335 2336 2337 2338
extern AVCodec tiertexseqvideo_decoder;
extern AVCodec tiff_decoder;
extern AVCodec truemotion1_decoder;
extern AVCodec truemotion2_decoder;
extern AVCodec truespeech_decoder;
2339
extern AVCodec tscc_decoder;
2340
extern AVCodec tta_decoder;
2341
extern AVCodec ulti_decoder;
2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
extern AVCodec vc1_decoder;
extern AVCodec vcr1_decoder;
extern AVCodec vmdaudio_decoder;
extern AVCodec vmdvideo_decoder;
extern AVCodec vmnc_decoder;
extern AVCodec vorbis_decoder;
extern AVCodec vp3_decoder;
extern AVCodec vp5_decoder;
extern AVCodec vp6_decoder;
extern AVCodec vp6f_decoder;
extern AVCodec vqa_decoder;
extern AVCodec wavpack_decoder;
extern AVCodec wmav1_decoder;
extern AVCodec wmav2_decoder;
extern AVCodec wmv1_decoder;
extern AVCodec wmv2_decoder;
extern AVCodec wmv3_decoder;
2359
extern AVCodec wnv1_decoder;
2360
extern AVCodec ws_snd1_decoder;
2361 2362 2363 2364
extern AVCodec xan_dpcm_decoder;
extern AVCodec xan_wc3_decoder;
extern AVCodec xl_decoder;
extern AVCodec zlib_decoder;
2365
extern AVCodec zmbv_decoder;
F
Fabrice Bellard 已提交
2366

F
Fabrice Bellard 已提交
2367 2368 2369
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
2370
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
2371

2372 2373 2374 2375 2376 2377
PCM_CODEC(CODEC_ID_PCM_ALAW,    pcm_alaw);
PCM_CODEC(CODEC_ID_PCM_MULAW,   pcm_mulaw);
PCM_CODEC(CODEC_ID_PCM_S8,      pcm_s8);
PCM_CODEC(CODEC_ID_PCM_S16BE,   pcm_s16be);
PCM_CODEC(CODEC_ID_PCM_S16LE,   pcm_s16le);
PCM_CODEC(CODEC_ID_PCM_S24BE,   pcm_s24be);
2378
PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
PCM_CODEC(CODEC_ID_PCM_S24LE,   pcm_s24le);
PCM_CODEC(CODEC_ID_PCM_S32BE,   pcm_s32be);
PCM_CODEC(CODEC_ID_PCM_S32LE,   pcm_s32le);
PCM_CODEC(CODEC_ID_PCM_U8,      pcm_u8);
PCM_CODEC(CODEC_ID_PCM_U16BE,   pcm_u16be);
PCM_CODEC(CODEC_ID_PCM_U16LE,   pcm_u16le);
PCM_CODEC(CODEC_ID_PCM_U24BE,   pcm_u24be);
PCM_CODEC(CODEC_ID_PCM_U24LE,   pcm_u24le);
PCM_CODEC(CODEC_ID_PCM_U32BE,   pcm_u32be);
PCM_CODEC(CODEC_ID_PCM_U32LE,   pcm_u32le);
F
Fabrice Bellard 已提交
2389

2390 2391
/* adpcm codecs */

2392 2393 2394 2395 2396
PCM_CODEC(CODEC_ID_ADPCM_4XM,     adpcm_4xm);
PCM_CODEC(CODEC_ID_ADPCM_ADX,     adpcm_adx);
PCM_CODEC(CODEC_ID_ADPCM_CT,      adpcm_ct);
PCM_CODEC(CODEC_ID_ADPCM_EA,      adpcm_ea);
PCM_CODEC(CODEC_ID_ADPCM_G726,    adpcm_g726);
2397 2398
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2399 2400 2401 2402
PCM_CODEC(CODEC_ID_ADPCM_IMA_QT,  adpcm_ima_qt);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
PCM_CODEC(CODEC_ID_ADPCM_IMA_WS,  adpcm_ima_ws);
PCM_CODEC(CODEC_ID_ADPCM_MS,      adpcm_ms);
2403
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
2404 2405 2406 2407 2408 2409
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_3, adpcm_sbpro_3);
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_4, adpcm_sbpro_4);
PCM_CODEC(CODEC_ID_ADPCM_SMJPEG,  adpcm_ima_smjpeg);
PCM_CODEC(CODEC_ID_ADPCM_SWF,     adpcm_swf);
PCM_CODEC(CODEC_ID_ADPCM_XA,      adpcm_xa);
PCM_CODEC(CODEC_ID_ADPCM_YAMAHA,  adpcm_yamaha);
2410

F
Fabrice Bellard 已提交
2411 2412 2413
#undef PCM_CODEC

/* dummy raw video codec */
2414
extern AVCodec rawvideo_decoder;
2415
extern AVCodec rawvideo_encoder;
F
Fabrice Bellard 已提交
2416 2417

/* the following codecs use external GPL libs */
2418
extern AVCodec dts_decoder;
2419
extern AVCodec liba52_decoder;
F
Fabrice Bellard 已提交
2420

F
Fabrice Bellard 已提交
2421
/* subtitles */
2422
extern AVCodec dvbsub_decoder;
2423 2424 2425
extern AVCodec dvbsub_encoder;
extern AVCodec dvdsub_decoder;
extern AVCodec dvdsub_encoder;
F
Fabrice Bellard 已提交
2426

F
Fabrice Bellard 已提交
2427 2428 2429
/* resample.c */

struct ReSampleContext;
2430
struct AVResampleContext;
F
Fabrice Bellard 已提交
2431 2432 2433

typedef struct ReSampleContext ReSampleContext;

2434
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
F
Fabrice Bellard 已提交
2435 2436 2437 2438
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

2439
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2440
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
M
Michael Niedermayer 已提交
2441
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2442
void av_resample_close(struct AVResampleContext *c);
2443

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

2447
struct ImgReSampleContext attribute_deprecated;
F
Fabrice Bellard 已提交
2448

2449
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
F
Fabrice Bellard 已提交
2450

2451
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
F
Fabrice Bellard 已提交
2452
                                      int input_width, int input_height);
2453

2454
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2455 2456
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2457 2458 2459 2460
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2461

2462
attribute_deprecated void img_resample(ImgReSampleContext *s,
2463
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
2464

2465 2466 2467
attribute_deprecated void img_resample_close(ImgReSampleContext *s);

#endif
F
Fabrice Bellard 已提交
2468

D
Drew Hess 已提交
2469 2470 2471 2472 2473 2474 2475
/**
 * Allocate memory for a picture.  Call avpicture_free to free it.
 *
 * @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.
2476
 * @return Zero if successful, a negative value if not.
D
Drew Hess 已提交
2477 2478 2479
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2480 2481 2482 2483 2484
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
 * @param picture The AVPicture to be freed.
 */
D
Drew Hess 已提交
2485 2486
void avpicture_free(AVPicture *picture);

2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
/**
 * Fill in AVPicture's fields.
 * 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.
 *
 * @param picture AVPicture who's fields are to be filled in
 * @param ptr Buffer which will contain or contains the actual image data
 * @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.
 */
2503
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2504
                   int pix_fmt, int width, int height);
2505
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2506
                     unsigned char *dest, int dest_size);
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516

/**
 * Calculate the size in bytes that a picture of the given width and height
 * would occupy if stored in the given picture format.
 *
 * @param pix_fmt The given picture format
 * @param width The width of the image
 * @param height The height of the image
 * @return Image data size in bytes
 */
2517
int avpicture_get_size(int pix_fmt, int width, int height);
2518 2519
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);
2520
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2521
enum PixelFormat avcodec_get_pix_fmt(const char* name);
M
Michael Niedermayer 已提交
2522
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2523

2524 2525 2526 2527 2528 2529
#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) */
2530

2531
/**
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546
 * 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.
 * avcodec_get_fix_fmt_loss() informs you on the various types of losses which
 * will occur when converting from one pixel format to another.
 *
 * @param[in] dst_pix_fmt Destination pixel format.
 * @param[in] src_pix_fmt Source pixel format.
 * @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.
2547
 */
2548 2549
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2550 2551

/**
2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
 * 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
 * the given pixel formats should be used to undergo the least amount of losses.
 * The pixel formats from which it choses one, are determined by the
 * \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
 *
 * @param[in] pix_fmt_mask Bitmask determining which pixel format to choose from.
 * @param[in] src_pix_fmt Source pixel format.
 * @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.
2572
 */
2573 2574 2575
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

F
Fabrice Bellard 已提交
2576 2577
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2578 2579 2580 2581 2582

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

2586
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2587
/* convert among pixel formats */
2588
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2589
                const AVPicture *src, int pix_fmt,
2590
                int width, int height);
2591
#endif
2592 2593

/* deinterlace a picture */
2594
/* deinterlace - if not supported return -1 */
2595
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
2596 2597 2598 2599 2600 2601
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
2602
/* returns LIBAVCODEC_VERSION_INT constant */
2603
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
2604
/* returns LIBAVCODEC_BUILD constant */
2605
unsigned avcodec_build(void);
2606 2607 2608 2609 2610 2611 2612

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

void register_avcodec(AVCodec *format);
2616 2617 2618 2619 2620 2621 2622

/**
 * Finds an encoder with a matching codec ID.
 *
 * @param id CodecID of the requested encoder.
 * @return An encoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2623
AVCodec *avcodec_find_encoder(enum CodecID id);
2624 2625 2626 2627 2628 2629 2630

/**
 * Finds an encoder with the specified name.
 *
 * @param name Name of the requested encoder.
 * @return An encoder if one was found, NULL otherwise.
 */
2631
AVCodec *avcodec_find_encoder_by_name(const char *name);
2632 2633 2634 2635 2636 2637 2638

/**
 * Finds a decoder with a matching codec ID.
 *
 * @param id CodecID of the requested decoder.
 * @return A decoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2639
AVCodec *avcodec_find_decoder(enum CodecID id);
2640 2641 2642 2643 2644 2645 2646

/**
 * Finds an decoder with the specified name.
 *
 * @param name Name of the requested decoder.
 * @return A decoder if one was found, NULL otherwise.
 */
F
Fabrice Bellard 已提交
2647 2648 2649
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

2650 2651 2652 2653 2654
/**
 * 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 已提交
2655
void avcodec_get_context_defaults(AVCodecContext *s);
2656

2657 2658 2659 2660
/** 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);

2661 2662 2663 2664 2665 2666 2667
/**
 * 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 已提交
2668
AVCodecContext *avcodec_alloc_context(void);
2669

2670 2671 2672 2673
/** 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);

2674 2675 2676 2677 2678
/**
 * 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 已提交
2679
void avcodec_get_frame_defaults(AVFrame *pic);
2680 2681 2682 2683 2684 2685 2686 2687

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

M
Michael Niedermayer 已提交
2690 2691
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
M
Michael Niedermayer 已提交
2692 2693
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2694 2695 2696 2697 2698 2699 2700 2701 2702

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

M
1l  
Michael Niedermayer 已提交
2706 2707 2708
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 已提交
2709
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2710 2711
//FIXME func typedef

M
Michael Niedermayer 已提交
2712
/**
2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736
 * 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.
 *
 * @warning This function is not thread save!
 *
 * @code
 * codec = avcodec_find_decoder(CODEC_ID_H264);
 * if (!codec)
 *     exit(1);
 *
 * context = avcodec_alloc_context();
 *
 * if (avcodec_open(context, codec) < 0)
 *     exit(1);
 * @endcode
 *
 * @param avctx The context which will be setup to use the given codec.
 * @param codec The codec to use within the context.
 * @return Zero on success, a negative value on error.
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
M
Michael Niedermayer 已提交
2737
 */
F
Fabrice Bellard 已提交
2738
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
2739

2740 2741 2742
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
M
Michael Niedermayer 已提交
2743 2744 2745
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
                         uint8_t *buf, int buf_size);
2746

2747
/**
2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764
 * Decodes an audio frame from \p buf into \p samples.
 * The avcodec_decode_audio2() function decodes a frame of audio from the input
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
 * audiocodec which was coupled with \p avctx using avcodec_open(). The
 * 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.
2765
 *
2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781
 * @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.
 *
 * @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.
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
2782
 */
M
Michael Niedermayer 已提交
2783
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
F
Fabrice Bellard 已提交
2784
                         int *frame_size_ptr,
2785
                         uint8_t *buf, int buf_size);
2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817

/**
 * Decodes a video frame from \p buf into \p picture.
 * The avcodec_decode_video() function decodes a frame of video from the input
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
 * videocodec which was coupled with \p avctx using avcodec_open(). The
 * 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.
 *
 * @param avctx The codec context.
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
 * @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 non zero.
 * @return On error a negative value is returned, otherwise the number of bytes
 * used or zero if no frame could be decompressed.
 */
2818
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
F
Fabrice Bellard 已提交
2819
                         int *got_picture_ptr,
2820
                         uint8_t *buf, int buf_size);
2821 2822 2823 2824

/* 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 已提交
2825 2826 2827
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2828
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2829
                        int *data_size_ptr,
2830
                        uint8_t *buf, int buf_size);
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847

/**
 * Encodes an audio frame from \p samples into \p buf.
 * The avcodec_encode_audio() function encodes a frame of audio from the input
 * buffer \p samples. To encode it, it makes use of the audiocodec which was
 * 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.
 *
 * @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.
 * @return On error a negative value is returned, on succes zero or the number
 * of bytes used from the input buffer.
 */
2848
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2849
                         const short *samples);
2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865

/**
 * Encodes a video frame from \p pict into \p buf.
 * The avcodec_encode_video() function encodes a frame of video from the input
 * \p pict. To encode it, it makes use of the videocodec which was coupled with
 * \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.
 *
 * @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 outputbuffer in bytes.
 * @param[in] pict The input picture to encode.
 * @return On error a negative value is returned, on success zero or the number
 * of bytes used from the input buffer.
 */
2866
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
M
Michael Niedermayer 已提交
2867
                         const AVFrame *pict);
2868
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2869
                            const AVSubtitle *sub);
F
Fabrice Bellard 已提交
2870 2871 2872 2873

int avcodec_close(AVCodecContext *avctx);

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

2875 2876 2877
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
M
Michael Niedermayer 已提交
2878 2879
void avcodec_flush_buffers(AVCodecContext *avctx);

2880 2881
void avcodec_default_free_buffers(AVCodecContext *s);

P
Panagiotis Issaris 已提交
2882
/* misc useful functions */
M
cleanup  
Michael Niedermayer 已提交
2883 2884

/**
2885 2886 2887 2888
 * Returns a single letter to describe the given picture type \p pict_type.
 *
 * @param[in] pict_type The picture type.
 * @return A single character representing the picture type.
M
cleanup  
Michael Niedermayer 已提交
2889 2890 2891
 */
char av_get_pict_type_char(int pict_type);

2892
/**
2893 2894 2895 2896
 * Returns codec bits per sample.
 *
 * @param[in] codec_id The codec.
 * @return Number of bits per sample or zero if unknown for the given codec.
2897 2898
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2899

F
Fabrice Bellard 已提交
2900 2901 2902 2903 2904
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2905
    int64_t cur_offset; /* current offset
F
Fabrice Bellard 已提交
2906 2907 2908 2909 2910
                           (incremented by each av_parser_parse()) */
    int64_t last_frame_offset; /* offset of the last frame */
    /* video info */
    int pict_type; /* XXX: put it back in AVCodecContext */
    int repeat_pict; /* XXX: put it back in AVCodecContext */
2911 2912 2913 2914 2915 2916
    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 已提交
2917
    int fetch_timestamp;
2918 2919 2920 2921 2922 2923

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

2925 2926
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
F
Fabrice Bellard 已提交
2927 2928 2929
} AVCodecParserContext;

typedef struct AVCodecParser {
M
Michael Niedermayer 已提交
2930
    int codec_ids[5]; /* several codec IDs are permitted */
F
Fabrice Bellard 已提交
2931 2932
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2933
    int (*parser_parse)(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2934
                        AVCodecContext *avctx,
2935
                        uint8_t **poutbuf, int *poutbuf_size,
F
Fabrice Bellard 已提交
2936 2937
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2938
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2939 2940 2941 2942 2943 2944 2945
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2946
int av_parser_parse(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2947
                    AVCodecContext *avctx,
2948
                    uint8_t **poutbuf, int *poutbuf_size,
2949 2950
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2951 2952
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2953
                     uint8_t **poutbuf, int *poutbuf_size,
2954
                     const uint8_t *buf, int buf_size, int keyframe);
F
Fabrice Bellard 已提交
2955 2956
void av_parser_close(AVCodecParserContext *s);

2957 2958
extern AVCodecParser aac_parser;
extern AVCodecParser ac3_parser;
2959
extern AVCodecParser cavsvideo_parser;
K
Kostya Shishkov 已提交
2960
extern AVCodecParser dca_parser;
2961 2962
extern AVCodecParser dvbsub_parser;
extern AVCodecParser dvdsub_parser;
2963
extern AVCodecParser h261_parser;
F
Fabrice Bellard 已提交
2964 2965
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
M
Michael Niedermayer 已提交
2966
extern AVCodecParser mjpeg_parser;
2967
extern AVCodecParser mpeg4video_parser;
F
Fabrice Bellard 已提交
2968
extern AVCodecParser mpegaudio_parser;
2969 2970
extern AVCodecParser mpegvideo_parser;
extern AVCodecParser pnm_parser;
K
Kostya Shishkov 已提交
2971
extern AVCodecParser vc1_parser;
F
Fabrice Bellard 已提交
2972

2973 2974

typedef struct AVBitStreamFilterContext {
M
Michael Niedermayer 已提交
2975
    void *priv_data;
2976 2977 2978 2979 2980 2981 2982 2983
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
M
Michael Niedermayer 已提交
2984
    int priv_data_size;
2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003
    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 已提交
3004
extern AVBitStreamFilter noise_bsf;
3005 3006
extern AVBitStreamFilter mp3_header_compress_bsf;
extern AVBitStreamFilter mp3_header_decompress_bsf;
3007
extern AVBitStreamFilter mjpega_dump_header_bsf;
3008
extern AVBitStreamFilter imx_dump_header_bsf;
3009 3010


F
Fabrice Bellard 已提交
3011
/* memory */
3012 3013

/**
3014 3015 3016 3017
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
3018
 */
3019
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3020

3021
/* for static data only */
3022 3023

/**
3024 3025
 * Frees all static arrays and reset their pointers to 0.
 * Call this function to release all statically allocated tables.
3026
 */
3027
attribute_deprecated void av_free_static(void);
3028 3029

/**
3030 3031 3032 3033 3034 3035
 * Allocation of static arrays.
 *
 * @warning Do not use for normal allocation.
 *
 * @param[in] size The amount of memory you need in bytes.
 * @return Block of memory of the requested size.
3036
 */
3037
attribute_deprecated void *av_mallocz_static(unsigned int size);
3038

3039 3040 3041
/**
 * Copy image 'src' to 'dst'.
 */
3042
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3043 3044
              int pix_fmt, int width, int height);

3045 3046 3047
/**
 * Crop image top and left side
 */
3048
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3049 3050
             int pix_fmt, int top_band, int left_band);

3051 3052 3053
/**
 * Pad image
 */
3054
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3055 3056
            int padtop, int padbottom, int padleft, int padright, int *color);

3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

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

3068 3069
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086
/* error handling */
#if EINVAL > 0
#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. */
#else
/* some platforms have E* and errno already negated. */
#define AVERROR(e) (e)
#define AVUNERROR(e) (e)
#endif
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
#define AVERROR_IO          AVERROR(EIO)     /**< i/o error */
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< number syntax expected in filename */
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< operation not supported */

3087 3088 3089 3090
#ifdef __cplusplus
}
#endif

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