avcodec.h 89.3 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

K
Kostya Shishkov 已提交
40 41
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(35<<8)+0)
#define LIBAVCODEC_VERSION      51.35.0
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

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

    /* various pcm "codecs" */
155
    CODEC_ID_PCM_S16LE= 0x10000,
F
Fabrice Bellard 已提交
156 157 158 159 160 161 162
    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,
163 164 165 166 167 168 169 170 171
    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,
172 173

    /* various adpcm codecs */
174
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
175
    CODEC_ID_ADPCM_IMA_WAV,
176 177
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
178
    CODEC_ID_ADPCM_IMA_WS,
179
    CODEC_ID_ADPCM_IMA_SMJPEG,
180
    CODEC_ID_ADPCM_MS,
181
    CODEC_ID_ADPCM_4XM,
182 183
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
184
    CODEC_ID_ADPCM_EA,
185
    CODEC_ID_ADPCM_G726,
186
    CODEC_ID_ADPCM_CT,
187
    CODEC_ID_ADPCM_SWF,
188
    CODEC_ID_ADPCM_YAMAHA,
189 190 191
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
192

193 194
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
195 196
    CODEC_ID_AMR_WB,

197
    /* RealAudio codecs*/
198
    CODEC_ID_RA_144= 0x13000,
199
    CODEC_ID_RA_288,
200 201

    /* various DPCM codecs */
202
    CODEC_ID_ROQ_DPCM= 0x14000,
203
    CODEC_ID_INTERPLAY_DPCM,
204
    CODEC_ID_XAN_DPCM,
205
    CODEC_ID_SOL_DPCM,
206

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

F
Fabrice Bellard 已提交
244
    /* subtitle codecs */
245 246 247
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,

248
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
249
                         stream (only used by libavformat) */
F
Fabrice Bellard 已提交
250
};
251

252
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
253 254
/* CODEC_ID_MP3LAME is absolete */
#define CODEC_ID_MP3LAME CODEC_ID_MP3
255 256
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
F
Fabrice Bellard 已提交
257 258

enum CodecType {
259
    CODEC_TYPE_UNKNOWN = -1,
F
Fabrice Bellard 已提交
260 261
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
262
    CODEC_TYPE_DATA,
F
Fabrice Bellard 已提交
263
    CODEC_TYPE_SUBTITLE,
264
    CODEC_TYPE_NB
F
Fabrice Bellard 已提交
265 266
};

F
Fabrice Bellard 已提交
267
/* currently unused, may be used if 24/32 bits samples ever supported */
268
/* all in native endian */
F
Fabrice Bellard 已提交
269
enum SampleFormat {
270
    SAMPLE_FMT_NONE = -1,
271 272 273
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
    SAMPLE_FMT_S24,             ///< signed 24 bits
274
    SAMPLE_FMT_S32,             ///< signed 32 bits
275
    SAMPLE_FMT_FLT,             ///< float
F
Fabrice Bellard 已提交
276 277
};

F
Fabrice Bellard 已提交
278
/* in bytes */
279
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
F
Fabrice Bellard 已提交
280

281
/**
282
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
283
 * this is mainly needed because some optimized bitstream readers read
284 285 286
 * 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
287 288 289
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

290 291 292 293 294 295
/**
 * minimum encoding buffer size.
 * used to avoid some checks during header writing
 */
#define FF_MIN_BUFFER_SIZE 16384

296 297
/* motion estimation type, EPZS by default */
enum Motion_Est_ID {
298
    ME_ZERO = 1,
299 300 301 302
    ME_FULL,
    ME_LOG,
    ME_PHODS,
    ME_EPZS,
303 304 305 306
    ME_X1,
    ME_HEX,
    ME_UMH,
    ME_ITER,
307 308
};

M
Michael Niedermayer 已提交
309 310 311 312 313 314 315 316 317 318
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 已提交
319 320 321 322 323 324 325
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;

326
#define FF_MAX_B_FRAMES 16
327

M
Michael Niedermayer 已提交
328
/* encoding support
329
   these flags can be passed in AVCodecContext.flags before initing
D
Diego Biurrun 已提交
330
   Note: not everything is supported yet.
M
Michael Niedermayer 已提交
331
*/
F
Fabrice Bellard 已提交
332

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

386
/* Unsupported options :
387 388
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
389
 *              Independent Segment Decoding */
390
/* /Fx */
F
Fabrice Bellard 已提交
391 392
/* codec capabilities */

393
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
M
Michael Niedermayer 已提交
394 395 396 397 398
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
399 400 401
/* if 'parse_only' field is true, then avcodec_parse_frame() can be
   used */
#define CODEC_CAP_PARSE_ONLY      0x0004
402
#define CODEC_CAP_TRUNCATED       0x0008
403 404
/* codec can export data for HW decoding (XvMC) */
#define CODEC_CAP_HWACCEL         0x0010
405
/**
406
 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
407
 * if this is not set, the codec is guaranteed to never be feeded with NULL data
408
 */
409
#define CODEC_CAP_DELAY           0x0020
410 411 412 413 414
/**
 * 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 已提交
415

D
Diego Biurrun 已提交
416
//the following defines may change, don't expect compatibility if you use them
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
#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, ...)

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

676 677 678
#define FF_QSCALE_TYPE_MPEG1 0
#define FF_QSCALE_TYPE_MPEG2 1
#define FF_QSCALE_TYPE_H264  2
M
Michael Niedermayer 已提交
679 680

#define FF_BUFFER_TYPE_INTERNAL 1
M
Michael Niedermayer 已提交
681
#define FF_BUFFER_TYPE_USER     2 ///< Direct rendering buffers (image is (de)allocated by user)
D
Diego Biurrun 已提交
682 683
#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 已提交
684

M
cleanup  
Michael Niedermayer 已提交
685

686 687 688 689
#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 已提交
690 691
#define FF_SI_TYPE 5
#define FF_SP_TYPE 6
M
cleanup  
Michael Niedermayer 已提交
692

693 694 695 696 697
#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 已提交
698 699 700
/**
 * Audio Video Frame.
 */
M
Michael Niedermayer 已提交
701 702 703
typedef struct AVFrame {
    FF_COMMON_FRAME
} AVFrame;
M
cleanup  
Michael Niedermayer 已提交
704

705
#define DEFAULT_FRAME_RATE_BASE 1001000
M
doxy  
Michael Niedermayer 已提交
706 707 708 709

/**
 * main external api structure.
 */
F
Fabrice Bellard 已提交
710
typedef struct AVCodecContext {
711 712 713 714
    /**
     * Info on struct for av_log
     * - set by avcodec_alloc_context
     */
M
Michael Niedermayer 已提交
715
    AVClass *av_class;
716
    /**
717 718
     * the average bitrate.
     * - encoding: set by user. unused for constant quantizer encoding
719
     * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
720
     */
F
Fabrice Bellard 已提交
721
    int bit_rate;
722 723

    /**
724
     * number of bits the bitstream is allowed to diverge from the reference.
725
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
726 727
     * - encoding: set by user. unused for constant quantizer encoding
     * - decoding: unused
728
     */
729
    int bit_rate_tolerance;
730 731

    /**
732 733 734
     * CODEC_FLAG_*.
     * - encoding: set by user.
     * - decoding: set by user.
735
     */
F
Fabrice Bellard 已提交
736
    int flags;
737 738 739

    /**
     * some codecs needs additionnal format info. It is stored here
740
     * - encoding: set by user.
741
     * - decoding: set by lavc. (FIXME is this ok?)
742 743 744 745
     */
    int sub_id;

    /**
746
     * motion estimation algorithm used for video coding.
R
Robert Swain 已提交
747 748
     * 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]
749 750
     * - encoding: MUST be set by user.
     * - decoding: unused
751 752 753 754
     */
    int me_method;

    /**
755
     * some codecs need / can use extra-data like huffman tables.
756 757
     * mjpeg: huffman tables
     * rv10: additional flags
758
     * mpeg4: global headers (they can be in the bitstream or here)
759 760
     * 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 已提交
761
     * the bytewise contents of extradata must not depend on the architecture or cpu endianness
762 763
     * - encoding: set/allocated/freed by lavc.
     * - decoding: set/allocated/freed by user.
764
     */
765
    uint8_t *extradata;
766
    int extradata_size;
767

768
    /**
769 770 771 772
     * 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.
773
     * - encoding: MUST be set by user
774
     * - decoding: set by lavc.
775
     */
776
    AVRational time_base;
777

778
    /* video only */
779
    /**
780
     * picture width / height.
781
     * - encoding: MUST be set by user.
782
     * - decoding: set by lavc.
783
     * Note, for compatibility its possible to set this instead of
784
     * coded_width/height before decoding
785
     */
F
Fabrice Bellard 已提交
786
    int width, height;
787

788
#define FF_ASPECT_EXTENDED 15
789 790

    /**
791 792 793
     * the number of pictures in a group of pitures, or 0 for intra_only.
     * - encoding: set by user.
     * - decoding: unused
794 795 796 797
     */
    int gop_size;

    /**
798
     * pixel format, see PIX_FMT_xxx.
799
     * - encoding: set by user.
800
     * - decoding: set by lavc.
801
     */
802
    enum PixelFormat pix_fmt;
803

804
    /**
805
     * Frame rate emulation. If not zero lower layer (i.e. format handler)
806 807 808 809 810
     * has to read frames at native frame rate.
     * - encoding: set by user.
     * - decoding: unused.
     */
    int rate_emu;
811

812 813 814 815 816
    /**
     * 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
817 818
     * - encoding: unused
     * - decoding: set by user.
819 820 821 822
     * @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
823
     */
F
Fabrice Bellard 已提交
824
    void (*draw_horiz_band)(struct AVCodecContext *s,
825
                            const AVFrame *src, int offset[4],
826
                            int y, int type, int height);
F
Fabrice Bellard 已提交
827

F
Fabrice Bellard 已提交
828
    /* audio only */
829
    int sample_rate; ///< samples per sec
F
Fabrice Bellard 已提交
830
    int channels;
831 832 833 834 835 836

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

    /* the following data should not be initialized */
840
    /**
841
     * samples per packet. initialized when calling 'init'
842 843
     */
    int frame_size;
844 845 846
    int frame_number;   ///< audio or video frame number
    int real_pict_num;  ///< returns the real picture number of previous encoded frame

847
    /**
848
     * number of frames the decoded output will be delayed relative to
849 850 851
     * the encoded input.
     * - encoding: set by lavc.
     * - decoding: unused
852 853
     */
    int delay;
854

855 856
    /* - encoding parameters */
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
857 858
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)

859
    /**
860 861 862
     * minimum quantizer.
     * - encoding: set by user.
     * - decoding: unused
863 864 865 866
     */
    int qmin;

    /**
867 868 869
     * maximum quantizer.
     * - encoding: set by user.
     * - decoding: unused
870 871 872 873
     */
    int qmax;

    /**
P
Typo  
Panagiotis Issaris 已提交
874
     * maximum quantizer difference between frames.
875 876
     * - encoding: set by user.
     * - decoding: unused
877 878 879 880
     */
    int max_qdiff;

    /**
881
     * maximum number of b frames between non b frames.
882
     * note: the output will be delayed by max_b_frames+1 relative to the input
883 884
     * - encoding: set by user.
     * - decoding: unused
885 886 887 888
     */
    int max_b_frames;

    /**
889 890 891
     * qscale factor between ip and b frames.
     * - encoding: set by user.
     * - decoding: unused
892 893
     */
    float b_quant_factor;
894

895 896
    /** obsolete FIXME remove */
    int rc_strategy;
M
Michael Niedermayer 已提交
897 898
#define FF_RC_STRATEGY_XVID 1

899
    int b_frame_strategy;
900

901
    /**
902 903 904
     * hurry up amount.
     * - encoding: unused
     * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
905
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
906 907
     */
    int hurry_up;
908

F
Fabrice Bellard 已提交
909
    struct AVCodec *codec;
910

F
Fabrice Bellard 已提交
911 912
    void *priv_data;

913
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
M
Michael Niedermayer 已提交
914 915
    /* unused, FIXME remove*/
    int rtp_mode;
916
#endif
917

D
Diego Biurrun 已提交
918
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
919 920 921 922 923
                            /* 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    */
924

925

D
Diego Biurrun 已提交
926 927 928 929 930 931
    /* 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                  */
932
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
933

934 935 936 937 938 939 940 941
    /* 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;
942
    int misc_bits;
943

944
    /**
945 946
     * number of bits used for the previously encoded frame.
     * - encoding: set by lavc
947
     * - decoding: unused
948
     */
949
    int frame_bits;
950

951
    /**
952 953 954
     * private data of the user, can be used to carry app specific stuff.
     * - encoding: set by user
     * - decoding: set by user
955 956 957
     */
    void *opaque;

F
Fabrice Bellard 已提交
958
    char codec_name[32];
959 960
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
    enum CodecID codec_id; /* see CODEC_ID_xxx */
961

962 963 964
    /**
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
     * this is used to workaround some encoder bugs
965
     * - encoding: set by user, if not then the default based on codec_id will be used
966 967 968
     * - decoding: set by user, will be converted to upper case by lavc during init
     */
    unsigned int codec_tag;
969

970
    /**
971
     * workaround bugs in encoders which sometimes cannot be detected automatically.
972
     * - encoding: set by user
973
     * - decoding: set by user
974 975
     */
    int workaround_bugs;
976
#define FF_BUG_AUTODETECT       1  ///< autodetection
977 978 979 980
#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 已提交
981
#define FF_BUG_AMV              32
982
#define FF_BUG_AC_VLC           0  ///< will be removed, libavcodec can now handle these non compliant files by default
M
Michael Niedermayer 已提交
983
#define FF_BUG_QPEL_CHROMA      64
M
Michael Niedermayer 已提交
984
#define FF_BUG_STD_QPEL         128
M
Michael Niedermayer 已提交
985
#define FF_BUG_QPEL_CHROMA2     256
986
#define FF_BUG_DIRECT_BLOCKSIZE 512
987
#define FF_BUG_EDGE             1024
988
#define FF_BUG_HPEL_CHROMA      2048
989
#define FF_BUG_DC_CLIP          4096
990
#define FF_BUG_MS               8192 ///< workaround various bugs in microsofts broken decoders
991
//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
992

993
    /**
994 995 996
     * luma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
997
     */
998
    int luma_elim_threshold;
999

1000
    /**
1001 1002 1003
     * chroma single coeff elimination threshold.
     * - encoding: set by user
     * - decoding: unused
1004
     */
1005
    int chroma_elim_threshold;
1006

1007
    /**
1008 1009 1010
     * strictly follow the std (MPEG4, ...).
     * - encoding: set by user
     * - decoding: unused
1011 1012
     */
    int strict_std_compliance;
1013 1014 1015 1016 1017 1018
#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

1019
    /**
1020
     * qscale offset between ip and b frames.
1021 1022
     * 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)
1023 1024
     * - encoding: set by user.
     * - decoding: unused
1025 1026
     */
    float b_quant_offset;
1027

1028
    /**
1029
     * error resilience higher values will detect more errors but may missdetect
1030 1031 1032
     * some more or less valid parts as errors.
     * - encoding: unused
     * - decoding: set by user
1033
     */
1034
    int error_resilience;
D
Diego Biurrun 已提交
1035
#define FF_ER_CAREFUL         1
1036 1037 1038
#define FF_ER_COMPLIANT       2
#define FF_ER_AGGRESSIVE      3
#define FF_ER_VERY_AGGRESSIVE 4
1039

1040
    /**
M
cleanup  
Michael Niedermayer 已提交
1041 1042
     * 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
1043 1044
     * 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
1045 1046
     * - encoding: unused
     * - decoding: set by lavc, user can override
1047
     */
M
Michael Niedermayer 已提交
1048
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1049

1050
    /**
M
cleanup  
Michael Niedermayer 已提交
1051 1052 1053
     * 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
1054 1055
     * - encoding: unused
     * - decoding: set by lavc, user can override
1056
     */
M
Michael Niedermayer 已提交
1057
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1058

1059
    /**
1060 1061
     * if 1 the stream has a 1 frame delay during decoding.
     * - encoding: set by lavc
1062
     * - decoding: set by lavc
1063 1064
     */
    int has_b_frames;
1065 1066 1067 1068 1069 1070

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

1072
    int parse_only; /* - decoding only: if true, only parsing is done
1073 1074
                       (function avcodec_parse_frame()). The frame
                       data is returned. Only MPEG codecs support this now. */
1075

1076
    /**
1077
     * 0-> h263 quant 1-> mpeg quant.
1078 1079
     * - encoding: set by user.
     * - decoding: unused
1080 1081
     */
    int mpeg_quant;
1082

1083
    /**
1084 1085 1086
     * pass1 encoding statistics output buffer.
     * - encoding: set by lavc
     * - decoding: unused
1087
     */
1088
    char *stats_out;
1089

1090 1091 1092
    /**
     * pass2 encoding statistics input buffer.
     * concatenated stuff from stats_out of pass1 should be placed here
1093 1094
     * - encoding: allocated/set/freed by user
     * - decoding: unused
1095 1096
     */
    char *stats_in;
1097

1098
    /**
1099
     * ratecontrol qmin qmax limiting method.
1100
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1101 1102
     * - encoding: set by user.
     * - decoding: unused
1103
     */
M
Michael Niedermayer 已提交
1104
    float rc_qsquish;
1105

M
Michael Niedermayer 已提交
1106 1107
    float rc_qmod_amp;
    int rc_qmod_freq;
1108

1109
    /**
1110 1111 1112
     * ratecontrol override, see RcOverride.
     * - encoding: allocated/set/freed by user.
     * - decoding: unused
1113
     */
M
Michael Niedermayer 已提交
1114 1115
    RcOverride *rc_override;
    int rc_override_count;
1116

1117
    /**
1118 1119 1120
     * rate control equation.
     * - encoding: set by user
     * - decoding: unused
1121
     */
M
Michael Niedermayer 已提交
1122
    char *rc_eq;
1123

1124
    /**
1125 1126 1127
     * maximum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1128
     */
M
Michael Niedermayer 已提交
1129
    int rc_max_rate;
1130

1131
    /**
1132 1133 1134
     * minimum bitrate.
     * - encoding: set by user.
     * - decoding: unused
1135
     */
M
Michael Niedermayer 已提交
1136
    int rc_min_rate;
1137

1138
    /**
1139 1140 1141
     * decoder bitstream buffer size.
     * - encoding: set by user.
     * - decoding: unused
1142
     */
M
Michael Niedermayer 已提交
1143 1144
    int rc_buffer_size;
    float rc_buffer_aggressivity;
1145 1146

    /**
1147
     * qscale factor between p and i frames.
1148 1149
     * 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)
1150 1151
     * - encoding: set by user.
     * - decoding: unused
1152 1153
     */
    float i_quant_factor;
1154

1155
    /**
1156 1157 1158
     * qscale offset between p and i frames.
     * - encoding: set by user.
     * - decoding: unused
1159 1160
     */
    float i_quant_offset;
1161

1162
    /**
1163 1164 1165
     * initial complexity for pass1 ratecontrol.
     * - encoding: set by user.
     * - decoding: unused
1166
     */
M
Michael Niedermayer 已提交
1167
    float rc_initial_cplx;
1168

1169
    /**
1170 1171 1172
     * dct algorithm, see FF_DCT_* below.
     * - encoding: set by user
     * - decoding: unused
1173
     */
1174
    int dct_algo;
1175
#define FF_DCT_AUTO    0
1176
#define FF_DCT_FASTINT 1
1177 1178 1179
#define FF_DCT_INT     2
#define FF_DCT_MMX     3
#define FF_DCT_MLIB    4
1180
#define FF_DCT_ALTIVEC 5
M
Michael Niedermayer 已提交
1181
#define FF_DCT_FAAN    6
1182

1183
    /**
1184 1185 1186
     * luminance masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1187 1188
     */
    float lumi_masking;
1189

1190
    /**
1191 1192 1193
     * temporary complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1194 1195
     */
    float temporal_cplx_masking;
1196

1197
    /**
1198 1199 1200
     * spatial complexity masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1201 1202
     */
    float spatial_cplx_masking;
1203

1204
    /**
1205 1206 1207
     * p block masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1208 1209
     */
    float p_masking;
1210

1211
    /**
1212 1213 1214
     * darkness masking (0-> disabled).
     * - encoding: set by user
     * - decoding: unused
1215 1216
     */
    float dark_masking;
1217 1218


1219 1220
    /* for binary compatibility */
    int unused;
1221

1222
    /**
1223 1224 1225
     * idct algorithm, see FF_IDCT_* below.
     * - encoding: set by user
     * - decoding: set by user
1226 1227 1228 1229 1230 1231 1232 1233 1234 1235
     */
    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
1236
#define FF_IDCT_ALTIVEC      8
1237
#define FF_IDCT_SH4          9
1238
#define FF_IDCT_SIMPLEARM    10
1239
#define FF_IDCT_H264         11
1240
#define FF_IDCT_VP3          12
1241
#define FF_IDCT_IPP          13
M
Michael Niedermayer 已提交
1242
#define FF_IDCT_XVIDMMX      14
1243
#define FF_IDCT_CAVS         15
M
Måns Rullgård 已提交
1244
#define FF_IDCT_SIMPLEARMV5TE 16
M
Måns Rullgård 已提交
1245
#define FF_IDCT_SIMPLEARMV6  17
1246

1247
    /**
1248 1249 1250
     * slice count.
     * - encoding: set by lavc
     * - decoding: set by user (or 0)
1251 1252 1253
     */
    int slice_count;
    /**
1254 1255 1256
     * slice offsets in the frame in bytes.
     * - encoding: set/allocated by lavc
     * - decoding: set/allocated by user (or NULL)
1257 1258 1259
     */
    int *slice_offset;

1260
    /**
1261 1262 1263
     * error concealment flags.
     * - encoding: unused
     * - decoding: set by user
1264 1265 1266 1267 1268
     */
    int error_concealment;
#define FF_EC_GUESS_MVS   1
#define FF_EC_DEBLOCK     2

Z
Zdenek Kabelac 已提交
1269
    /**
Z
Zdenek Kabelac 已提交
1270
     * dsp_mask could be add used to disable unwanted CPU features
Z
Zdenek Kabelac 已提交
1271
     * CPU features (i.e. MMX, SSE. ...)
Z
Zdenek Kabelac 已提交
1272 1273 1274 1275 1276 1277
     *
     * 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;
1278
#define FF_MM_FORCE    0x80000000 /* force usage of selected flags (OR) */
Z
Zdenek Kabelac 已提交
1279 1280
    /* lower 16 bits - CPU features */
#ifdef HAVE_MMX
1281 1282 1283 1284 1285 1286
#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 已提交
1287
#endif /* HAVE_MMX */
1288
#ifdef HAVE_IWMMXT
1289
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1290
#endif /* HAVE_IWMMXT */
M
huffyuv  
Michael Niedermayer 已提交
1291 1292

    /**
1293 1294 1295
     * bits per sample/pixel from the demuxer (needed for huffyuv).
     * - encoding: set by lavc
     * - decoding: set by user
M
huffyuv  
Michael Niedermayer 已提交
1296 1297
     */
     int bits_per_sample;
1298

M
huffyuv  
Michael Niedermayer 已提交
1299
    /**
1300 1301 1302
     * prediction method (needed for huffyuv).
     * - encoding: set by user
     * - decoding: unused
M
huffyuv  
Michael Niedermayer 已提交
1303 1304 1305 1306 1307
     */
     int prediction_method;
#define FF_PRED_LEFT   0
#define FF_PRED_PLANE  1
#define FF_PRED_MEDIAN 2
1308

M
Michael Niedermayer 已提交
1309
    /**
M
Michael Niedermayer 已提交
1310
     * sample aspect ratio (0 if unknown).
1311
     * numerator and denominator must be relative prime and smaller then 256 for some video standards
1312 1313
     * - encoding: set by user.
     * - decoding: set by lavc.
M
Michael Niedermayer 已提交
1314
     */
M
Michael Niedermayer 已提交
1315
    AVRational sample_aspect_ratio;
M
cleanup  
Michael Niedermayer 已提交
1316 1317

    /**
1318 1319 1320
     * the picture in the bitstream.
     * - encoding: set by lavc
     * - decoding: set by lavc
M
cleanup  
Michael Niedermayer 已提交
1321
     */
M
Michael Niedermayer 已提交
1322
    AVFrame *coded_frame;
1323 1324

    /**
1325 1326 1327
     * debug.
     * - encoding: set by user.
     * - decoding: set by user.
1328 1329 1330 1331 1332 1333 1334 1335
     */
    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
1336
#define FF_DEBUG_DCT_COEFF 0x00000040
M
Michael Niedermayer 已提交
1337 1338 1339
#define FF_DEBUG_SKIP      0x00000080
#define FF_DEBUG_STARTCODE 0x00000100
#define FF_DEBUG_PTS       0x00000200
1340
#define FF_DEBUG_ER        0x00000400
M
Michael Niedermayer 已提交
1341
#define FF_DEBUG_MMCO      0x00000800
1342
#define FF_DEBUG_BUGS      0x00001000
M
Michael Niedermayer 已提交
1343 1344
#define FF_DEBUG_VIS_QP    0x00002000
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1345

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
    /**
     * 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

1356
    /**
1357 1358 1359
     * error.
     * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
     * - decoding: unused
1360 1361
     */
    uint64_t error[4];
1362

M
Michael Niedermayer 已提交
1363
    /**
1364
     * minimum MB quantizer.
1365
     * - encoding: unused
1366
     * - decoding: unused
M
Michael Niedermayer 已提交
1367 1368 1369 1370
     */
    int mb_qmin;

    /**
1371
     * maximum MB quantizer.
1372
     * - encoding: unused
1373
     * - decoding: unused
M
Michael Niedermayer 已提交
1374 1375
     */
    int mb_qmax;
1376

M
Michael Niedermayer 已提交
1377
    /**
1378 1379 1380
     * motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1381 1382 1383
     */
    int me_cmp;
    /**
1384 1385 1386
     * subpixel motion estimation compare function.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1387 1388 1389
     */
    int me_sub_cmp;
    /**
1390 1391 1392
     * macroblock compare function (not supported yet).
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1393 1394
     */
    int mb_cmp;
1395 1396 1397 1398 1399 1400
    /**
     * interlaced dct compare function
     * - encoding: set by user.
     * - decoding: unused
     */
    int ildct_cmp;
M
Michael Niedermayer 已提交
1401 1402 1403 1404 1405 1406 1407 1408
#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
1409 1410
#define FF_CMP_VSAD 8
#define FF_CMP_VSSE 9
1411
#define FF_CMP_NSSE 10
M
Michael Niedermayer 已提交
1412 1413
#define FF_CMP_W53  11
#define FF_CMP_W97  12
1414
#define FF_CMP_DCTMAX 13
1415
#define FF_CMP_DCT264 14
M
Michael Niedermayer 已提交
1416
#define FF_CMP_CHROMA 256
1417

M
Michael Niedermayer 已提交
1418
    /**
1419 1420 1421
     * ME diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1422 1423
     */
    int dia_size;
1424 1425

    /**
1426 1427 1428
     * amount of previous MV predictors (2a+1 x 2a+1 square).
     * - encoding: set by user.
     * - decoding: unused
1429 1430
     */
    int last_predictor_count;
1431

M
Michael Niedermayer 已提交
1432
    /**
1433 1434 1435
     * pre pass for motion estimation.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1436 1437
     */
    int pre_me;
1438

1439
    /**
1440 1441 1442
     * motion estimation pre pass compare function.
     * - encoding: set by user.
     * - decoding: unused
1443 1444
     */
    int me_pre_cmp;
M
Michael Niedermayer 已提交
1445

1446
    /**
1447 1448 1449
     * ME pre pass diamond size & shape.
     * - encoding: set by user.
     * - decoding: unused
1450 1451 1452
     */
    int pre_dia_size;

M
Michael Niedermayer 已提交
1453
    /**
1454 1455 1456
     * subpel ME quality.
     * - encoding: set by user.
     * - decoding: unused
M
Michael Niedermayer 已提交
1457 1458 1459
     */
    int me_subpel_quality;

M
Michael Niedermayer 已提交
1460
    /**
1461
     * callback to negotiate the pixelFormat.
M
Michael Niedermayer 已提交
1462 1463 1464 1465
     * @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
1466 1467
     * - encoding: unused
     * - decoding: set by user, if not set then the native format will always be choosen
M
Michael Niedermayer 已提交
1468
     */
I
Ivan Kalvachev 已提交
1469
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1470 1471 1472 1473 1474

    /**
     * DTG active format information (additionnal aspect ratio
     * information only used in DVB MPEG2 transport streams). 0 if
     * not set.
1475
     *
1476
     * - encoding: unused.
1477
     * - decoding: set by decoder
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
     */
    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

1488 1489 1490
    /**
     * Maximum motion estimation search range in subpel units.
     * if 0 then no limit
1491
     *
1492 1493
     * - encoding: set by user.
     * - decoding: unused.
1494
     */
Z
Zdenek Kabelac 已提交
1495
    int me_range;
1496

1497 1498 1499 1500 1501 1502 1503
    /**
     * intra quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int intra_quant_bias;
#define FF_DEFAULT_QUANT_BIAS 999999
1504

1505 1506 1507 1508 1509 1510
    /**
     * inter quantizer bias.
     * - encoding: set by user.
     * - decoding: unused
     */
    int inter_quant_bias;
1511 1512 1513 1514 1515 1516 1517 1518

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

1520
    /**
1521
     * internal_buffer count.
D
Diego Biurrun 已提交
1522
     * Don't touch, used by lavc default_get_buffer()
1523 1524
     */
    int internal_buffer_count;
1525

1526
    /**
1527
     * internal_buffers.
D
Diego Biurrun 已提交
1528
     * Don't touch, used by lavc default_get_buffer()
1529 1530
     */
    void *internal_buffer;
1531 1532 1533 1534 1535 1536 1537

#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 已提交
1538 1539 1540 1541 1542 1543 1544
    /**
     * 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;
1545

M
Michael Niedermayer 已提交
1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
#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;
1561 1562 1563 1564 1565 1566 1567 1568
#if 0
    /**
     *
     * - encoding: unused
     * - decoding: set by user.
     */
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
#endif
1569

1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
    /**
     * 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 已提交
1580 1581 1582 1583 1584 1585
    /**
     * XVideo Motion Acceleration
     * - encoding: forbidden
     * - decoding: set by decoder
     */
    int xvmc_acceleration;
1586

1587 1588 1589 1590 1591 1592 1593 1594 1595
    /**
     * 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
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609

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

1611 1612 1613 1614 1615 1616 1617
    /**
     * 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 已提交
1618 1619 1620 1621 1622 1623 1624 1625

    /**
     * scene change detection threshold.
     * 0 is default, larger means fewer detected scene changes
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_threshold;
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639

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

    /**
     * maximum lagrange multipler
     * - encoding: set by user.
     * - decoding: unused
     */
    int lmax;
1640 1641 1642 1643 1644 1645 1646

    /**
     * Palette control structure
     * - encoding: ??? (no palette-enabled encoder yet)
     * - decoding: set by user.
     */
    struct AVPaletteControl *palctrl;
1647 1648 1649 1650 1651 1652 1653

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

1655
    /**
1656 1657 1658 1659 1660
     * 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().
1661
     * - encoding: unused
1662
     * - decoding: set by lavc, user can override
1663
     */
1664
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
M
Michael Niedermayer 已提交
1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685

    /**
     * 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;
1686 1687 1688 1689 1690 1691 1692

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

1694 1695 1696 1697 1698 1699 1700 1701 1702 1703
    /**
     * 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 已提交
1704 1705 1706 1707 1708 1709
    /**
     * Quantizer noise shaping.
     * - encoding: set by user
     * - decoding: unused
     */
    int quantizer_noise_shaping;
1710 1711 1712

    /**
     * Thread count.
1713
     * is used to decide how many independent tasks should be passed to execute()
1714 1715 1716 1717
     * - encoding: set by user
     * - decoding: set by user
     */
    int thread_count;
1718

1719
    /**
1720
     * the codec may call this to execute several independent things. it will return only after
1721 1722
     * finishing all tasks, the user may replace this with some multithreaded implementation, the
     * default implementation will execute the parts serially
1723
     * @param count the number of things to execute
1724 1725 1726 1727
     * - 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);
1728

1729 1730 1731 1732 1733 1734 1735
    /**
     * Thread opaque.
     * can be used by execute() to store some per AVCodecContext stuff.
     * - encoding: set by execute()
     * - decoding: set by execute()
     */
    void *thread_opaque;
1736 1737

    /**
1738
     * Motion estimation threshold. under which no motion estimation is
1739
     * performed, but instead the user specified motion vectors are used
1740
     *
1741
     * - encoding: set by user
1742
     * - decoding: unused
1743
     */
M
Michael Niedermayer 已提交
1744
     int me_threshold;
1745 1746 1747 1748 1749 1750 1751

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

    /**
M
Michael Niedermayer 已提交
1754
     * precision of the intra dc coefficient - 8.
1755 1756 1757 1758
     * - encoding: set by user
     * - decoding: unused
     */
     int intra_dc_precision;
M
Michael Niedermayer 已提交
1759 1760 1761 1762 1763 1764 1765

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

    /**
1768
     * number of macroblock rows at the top which are skipped.
1769 1770 1771 1772 1773 1774
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_top;

    /**
1775
     * number of macroblock rows at the bottom which are skipped.
1776 1777 1778 1779
     * - encoding: unused
     * - decoding: set by user
     */
     int skip_bottom;
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795

    /**
     * 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 已提交
1796 1797 1798 1799 1800 1801 1802

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

    /**
M
Michael Niedermayer 已提交
1805
     * bitsream width / height. may be different from width/height if lowres
1806 1807 1808 1809 1810
     * 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 已提交
1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824

    /**
     * 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;
1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838

    /**
     * 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;
1839 1840 1841 1842 1843 1844 1845 1846

    /**
     * border processing masking. raises the quantizer for mbs on the borders
     * of the picture.
     * - encoding: set by user
     * - decoding: unused
     */
    float border_masking;
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860

    /**
     * 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;
1861 1862

    /**
1863
     *
1864 1865 1866 1867
     * - encoding: set by user.
     * - decoding: unused
     */
    int me_penalty_compensation;
M
Michael Niedermayer 已提交
1868 1869

    /**
1870
     *
M
Michael Niedermayer 已提交
1871 1872 1873 1874 1875 1876
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_loop_filter;

    /**
1877
     *
M
Michael Niedermayer 已提交
1878 1879 1880 1881 1882 1883
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_idct;

    /**
1884
     *
M
Michael Niedermayer 已提交
1885 1886 1887 1888
     * - encoding: unused
     * - decoding: set by user.
     */
    enum AVDiscard skip_frame;
M
Michael Niedermayer 已提交
1889 1890 1891 1892 1893 1894 1895

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int bidir_refine;
1896 1897 1898 1899 1900 1901 1902

    /**
     *
     * - encoding: set by user.
     * - decoding: unused
     */
    int brd_scale;
R
Robert Swain 已提交
1903 1904 1905 1906 1907 1908

    /**
     * constant rate factor - quality-based VBR - values ~correspond to qps
     * - encoding: set by user.
     * - decoding: unused
     */
L
Luca Barbato 已提交
1909
    float crf;
R
Robert Swain 已提交
1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 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

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

1995 1996 1997 1998 1999 2000
    /**
     * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
     * - encoding: set by user.
     * - decoding: unused
     */
    int cutoff;
C
Corey Hickey 已提交
2001 2002 2003 2004 2005 2006 2007

    /**
     * multiplied by qscale for each frame and added to scene_change_score
     * - encoding: set by user.
     * - decoding: unused
     */
    int scenechange_factor;
2008 2009 2010 2011 2012 2013 2014 2015

    /**
     *
     * note: value depends upon the compare functin used for fullpel ME
     * - encoding: set by user.
     * - decoding: unused
     */
    int mv0_threshold;
2016 2017 2018 2019 2020 2021 2022

    /**
     * adjusts sensitivity of b_frame_strategy 1
     * - encoding: set by user.
     * - decoding: unused
     */
    int b_sensitivity;
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 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

    /**
     * - 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;
2075 2076 2077 2078 2079 2080 2081

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

2084 2085 2086
/**
 * AVCodec.
 */
F
Fabrice Bellard 已提交
2087
typedef struct AVCodec {
2088
    const char *name;
Z
Zdenek Kabelac 已提交
2089
    enum CodecType type;
M
Michael Niedermayer 已提交
2090
    enum CodecID id;
F
Fabrice Bellard 已提交
2091 2092
    int priv_data_size;
    int (*init)(AVCodecContext *);
2093
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
F
Fabrice Bellard 已提交
2094
    int (*close)(AVCodecContext *);
M
Michael Niedermayer 已提交
2095
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2096
                  uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2097
    int capabilities;
F
Fabrice Bellard 已提交
2098
    struct AVCodec *next;
M
Michael Niedermayer 已提交
2099
    void (*flush)(AVCodecContext *);
Z
* const  
Zdenek Kabelac 已提交
2100
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2101
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
F
Fabrice Bellard 已提交
2102 2103
} AVCodec;

2104
/**
2105 2106 2107
 * four components are given, that's all.
 * the last component is alpha
 */
F
Fabrice Bellard 已提交
2108
typedef struct AVPicture {
2109
    uint8_t *data[4];
M
Michael Niedermayer 已提交
2110
    int linesize[4];       ///< number of bytes per line
F
Fabrice Bellard 已提交
2111 2112
} AVPicture;

M
Mike Melanson 已提交
2113 2114 2115 2116
/**
 * AVPaletteControl
 * This structure defines a method for communicating palette changes
 * between and demuxer and a decoder.
2117
 * this is totally broken, palette changes should be sent as AVPackets
M
Mike Melanson 已提交
2118
 */
2119
#define AVPALETTE_SIZE 1024
M
10l ...  
Michael Niedermayer 已提交
2120
#define AVPALETTE_COUNT 256
M
Mike Melanson 已提交
2121 2122 2123 2124 2125 2126
typedef struct AVPaletteControl {

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

2127 2128 2129 2130
    /* 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 */
2131
    unsigned int palette[AVPALETTE_COUNT];
M
Mike Melanson 已提交
2132

2133
} AVPaletteControl attribute_deprecated;
M
Mike Melanson 已提交
2134

2135
typedef struct AVSubtitleRect {
F
Fabrice Bellard 已提交
2136 2137 2138 2139 2140 2141 2142 2143
    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;
2144 2145 2146 2147 2148 2149 2150 2151
} 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 已提交
2152 2153
} AVSubtitle;

F
Fabrice Bellard 已提交
2154
extern AVCodec ac3_encoder;
2155 2156 2157 2158
extern AVCodec amr_nb_encoder;
extern AVCodec amr_wb_encoder;
extern AVCodec asv1_encoder;
extern AVCodec asv2_encoder;
2159
extern AVCodec bmp_encoder;
2160
extern AVCodec dvvideo_encoder;
2161
extern AVCodec faac_encoder;
2162 2163
extern AVCodec ffv1_encoder;
extern AVCodec ffvhuff_encoder;
2164
extern AVCodec flac_encoder;
2165 2166
extern AVCodec flashsv_encoder;
extern AVCodec flv_encoder;
2167
extern AVCodec gif_encoder;
2168
extern AVCodec h261_encoder;
F
Fabrice Bellard 已提交
2169 2170
extern AVCodec h263_encoder;
extern AVCodec h263p_encoder;
2171 2172
extern AVCodec h264_encoder;
extern AVCodec huffyuv_encoder;
2173
extern AVCodec jpegls_encoder;
2174
extern AVCodec libgsm_encoder;
M
Michel Bardiaux 已提交
2175
extern AVCodec libgsm_ms_encoder;
D
Diego Biurrun 已提交
2176
extern AVCodec libtheora_encoder;
2177 2178 2179 2180 2181 2182 2183
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 已提交
2184
extern AVCodec mpeg4_encoder;
2185 2186 2187
extern AVCodec msmpeg4v1_encoder;
extern AVCodec msmpeg4v2_encoder;
extern AVCodec msmpeg4v3_encoder;
2188 2189 2190 2191 2192 2193 2194 2195 2196
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;
2197
extern AVCodec snow_encoder;
2198 2199
extern AVCodec sonic_encoder;
extern AVCodec sonic_ls_encoder;
2200
extern AVCodec svq1_encoder;
2201 2202
extern AVCodec vcr1_encoder;
extern AVCodec vorbis_encoder;
M
Michael Niedermayer 已提交
2203 2204
extern AVCodec wmav1_encoder;
extern AVCodec wmav2_encoder;
2205 2206
extern AVCodec wmv1_encoder;
extern AVCodec wmv2_encoder;
2207
extern AVCodec x264_encoder;
2208 2209
extern AVCodec xvid_encoder;
extern AVCodec zlib_encoder;
2210
extern AVCodec zmbv_encoder;
F
Fabrice Bellard 已提交
2211

2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
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 已提交
2227
extern AVCodec dca_decoder;
2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
extern AVCodec dsicinaudio_decoder;
extern AVCodec dsicinvideo_decoder;
extern AVCodec dvvideo_decoder;
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;
2240
extern AVCodec gif_decoder;
2241
extern AVCodec h261_decoder;
2242
extern AVCodec h263_decoder;
F
Fabrice Bellard 已提交
2243
extern AVCodec h263i_decoder;
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253
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 已提交
2254
extern AVCodec libgsm_ms_decoder;
2255 2256 2257 2258
extern AVCodec loco_decoder;
extern AVCodec mace3_decoder;
extern AVCodec mace6_decoder;
extern AVCodec mdec_decoder;
F
Fabrice Bellard 已提交
2259
extern AVCodec mjpeg_decoder;
2260
extern AVCodec mjpegb_decoder;
2261
extern AVCodec mmvideo_decoder;
2262
extern AVCodec mp2_decoder;
F
Fabrice Bellard 已提交
2263
extern AVCodec mp3_decoder;
R
Roberto Togni 已提交
2264
extern AVCodec mp3adu_decoder;
2265
extern AVCodec mp3on4_decoder;
2266 2267 2268 2269
extern AVCodec mpc7_decoder;
extern AVCodec mpeg1video_decoder;
extern AVCodec mpeg2video_decoder;
extern AVCodec mpeg4_decoder;
2270
extern AVCodec mpeg4aac_decoder;
2271 2272 2273 2274 2275
extern AVCodec mpeg_xvmc_decoder;
extern AVCodec mpegvideo_decoder;
extern AVCodec msmpeg4v1_decoder;
extern AVCodec msmpeg4v2_decoder;
extern AVCodec msmpeg4v3_decoder;
2276 2277
extern AVCodec msrle_decoder;
extern AVCodec msvideo1_decoder;
R
Roberto Togni 已提交
2278
extern AVCodec mszh_decoder;
2279 2280 2281 2282 2283 2284 2285
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;
2286 2287
extern AVCodec ra_144_decoder;
extern AVCodec ra_288_decoder;
2288
extern AVCodec roq_decoder;
2289
extern AVCodec roq_dpcm_decoder;
2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
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;
2300
extern AVCodec sol_dpcm_decoder;
2301
extern AVCodec sonic_decoder;
2302 2303 2304 2305 2306 2307 2308 2309 2310 2311
extern AVCodec sp5x_decoder;
extern AVCodec svq1_decoder;
extern AVCodec svq3_decoder;
extern AVCodec targa_decoder;
extern AVCodec theora_decoder;
extern AVCodec tiertexseqvideo_decoder;
extern AVCodec tiff_decoder;
extern AVCodec truemotion1_decoder;
extern AVCodec truemotion2_decoder;
extern AVCodec truespeech_decoder;
2312
extern AVCodec tscc_decoder;
2313
extern AVCodec tta_decoder;
2314
extern AVCodec ulti_decoder;
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331
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;
2332
extern AVCodec wnv1_decoder;
2333
extern AVCodec ws_snd1_decoder;
2334 2335 2336 2337
extern AVCodec xan_dpcm_decoder;
extern AVCodec xan_wc3_decoder;
extern AVCodec xl_decoder;
extern AVCodec zlib_decoder;
2338
extern AVCodec zmbv_decoder;
F
Fabrice Bellard 已提交
2339

F
Fabrice Bellard 已提交
2340 2341 2342
/* pcm codecs */
#define PCM_CODEC(id, name) \
extern AVCodec name ## _decoder; \
2343
extern AVCodec name ## _encoder
F
Fabrice Bellard 已提交
2344

2345 2346 2347 2348 2349 2350
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);
2351
PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
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 已提交
2362

2363 2364
/* adpcm codecs */

2365 2366 2367 2368 2369
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);
2370 2371
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2372 2373 2374 2375
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);
2376
PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
2377 2378 2379 2380 2381 2382
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);
2383

F
Fabrice Bellard 已提交
2384 2385 2386
#undef PCM_CODEC

/* dummy raw video codec */
2387
extern AVCodec rawvideo_decoder;
2388
extern AVCodec rawvideo_encoder;
F
Fabrice Bellard 已提交
2389 2390

/* the following codecs use external GPL libs */
2391
extern AVCodec dts_decoder;
2392
extern AVCodec liba52_decoder;
F
Fabrice Bellard 已提交
2393

F
Fabrice Bellard 已提交
2394
/* subtitles */
2395
extern AVCodec dvbsub_decoder;
2396 2397 2398
extern AVCodec dvbsub_encoder;
extern AVCodec dvdsub_decoder;
extern AVCodec dvdsub_encoder;
F
Fabrice Bellard 已提交
2399

F
Fabrice Bellard 已提交
2400 2401 2402
/* resample.c */

struct ReSampleContext;
2403
struct AVResampleContext;
F
Fabrice Bellard 已提交
2404 2405 2406

typedef struct ReSampleContext ReSampleContext;

2407
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
F
Fabrice Bellard 已提交
2408 2409 2410 2411
                                     int output_rate, int input_rate);
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
void audio_resample_close(ReSampleContext *s);

2412
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2413
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
M
Michael Niedermayer 已提交
2414
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2415
void av_resample_close(struct AVResampleContext *c);
2416

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

2420
struct ImgReSampleContext attribute_deprecated;
F
Fabrice Bellard 已提交
2421

2422
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
F
Fabrice Bellard 已提交
2423

2424
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
F
Fabrice Bellard 已提交
2425
                                      int input_width, int input_height);
2426

2427
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2428 2429
                                      int iwidth, int iheight,
                                      int topBand, int bottomBand,
2430 2431 2432 2433
                                      int leftBand, int rightBand,
                                      int padtop, int padbottom,
                                      int padleft, int padright);

2434

2435
attribute_deprecated void img_resample(ImgReSampleContext *s,
2436
                  AVPicture *output, const AVPicture *input);
F
Fabrice Bellard 已提交
2437

2438 2439 2440
attribute_deprecated void img_resample_close(ImgReSampleContext *s);

#endif
F
Fabrice Bellard 已提交
2441

D
Drew Hess 已提交
2442 2443 2444 2445 2446 2447 2448
/**
 * 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.
2449
 * @return Zero if successful, a negative value if not.
D
Drew Hess 已提交
2450 2451 2452
 */
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);

2453 2454 2455 2456 2457
/**
 * Free a picture previously allocated by avpicture_alloc().
 *
 * @param picture The AVPicture to be freed.
 */
D
Drew Hess 已提交
2458 2459
void avpicture_free(AVPicture *picture);

2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
/**
 * 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.
 */
2476
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2477
                   int pix_fmt, int width, int height);
2478
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2479
                     unsigned char *dest, int dest_size);
2480 2481 2482 2483 2484 2485 2486 2487 2488 2489

/**
 * 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
 */
2490
int avpicture_get_size(int pix_fmt, int width, int height);
2491 2492
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);
2493
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2494
enum PixelFormat avcodec_get_pix_fmt(const char* name);
M
Michael Niedermayer 已提交
2495
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2496

2497 2498 2499 2500 2501 2502 2503
#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) */

2504 2505 2506
/**
 * compute the loss when converting from a pixel format to another
 */
2507 2508
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
                             int has_alpha);
2509 2510 2511 2512

/**
 * find best pixel format to convert to. Return -1 if none found
 */
2513 2514 2515
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
                              int has_alpha, int *loss_ptr);

F
Fabrice Bellard 已提交
2516 2517
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2518 2519 2520 2521 2522

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

2526
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2527
/* convert among pixel formats */
2528
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2529
                const AVPicture *src, int pix_fmt,
2530
                int width, int height);
2531
#endif
2532 2533

/* deinterlace a picture */
2534
/* deinterlace - if not supported return -1 */
2535
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
F
Fabrice Bellard 已提交
2536 2537 2538 2539 2540 2541
                          int pix_fmt, int width, int height);

/* external high level API */

extern AVCodec *first_avcodec;

N
Nick Kurshev 已提交
2542
/* returns LIBAVCODEC_VERSION_INT constant */
2543
unsigned avcodec_version(void);
N
Nick Kurshev 已提交
2544
/* returns LIBAVCODEC_BUILD constant */
2545
unsigned avcodec_build(void);
2546 2547 2548 2549 2550 2551 2552

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

void register_avcodec(AVCodec *format);
2556 2557 2558 2559 2560 2561 2562

/**
 * 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 已提交
2563
AVCodec *avcodec_find_encoder(enum CodecID id);
2564 2565 2566 2567 2568 2569 2570

/**
 * Finds an encoder with the specified name.
 *
 * @param name Name of the requested encoder.
 * @return An encoder if one was found, NULL otherwise.
 */
2571
AVCodec *avcodec_find_encoder_by_name(const char *name);
2572 2573 2574 2575 2576 2577 2578

/**
 * 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 已提交
2579
AVCodec *avcodec_find_decoder(enum CodecID id);
2580 2581 2582 2583 2584 2585 2586

/**
 * 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 已提交
2587 2588 2589
AVCodec *avcodec_find_decoder_by_name(const char *name);
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);

2590 2591 2592 2593 2594
/**
 * 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 已提交
2595
void avcodec_get_context_defaults(AVCodecContext *s);
2596 2597 2598 2599 2600 2601 2602 2603

/**
 * 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 已提交
2604
AVCodecContext *avcodec_alloc_context(void);
2605 2606 2607 2608 2609 2610

/**
 * 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 已提交
2611
void avcodec_get_frame_defaults(AVFrame *pic);
2612 2613 2614 2615 2616 2617 2618 2619

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

M
Michael Niedermayer 已提交
2622 2623
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
M
Michael Niedermayer 已提交
2624 2625
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2626 2627 2628 2629 2630 2631 2632 2633 2634

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

M
1l  
Michael Niedermayer 已提交
2638 2639 2640
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 已提交
2641
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2642 2643
//FIXME func typedef

M
Michael Niedermayer 已提交
2644
/**
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668
 * 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 已提交
2669
 */
F
Fabrice Bellard 已提交
2670
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
M
Michael Niedermayer 已提交
2671

2672 2673 2674
/**
 * @deprecated Use avcodec_decode_audio2() instead.
 */
M
Michael Niedermayer 已提交
2675 2676 2677
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
                         int *frame_size_ptr,
                         uint8_t *buf, int buf_size);
2678

2679
/**
2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696
 * 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.
2697
 *
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713
 * @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.
2714
 */
M
Michael Niedermayer 已提交
2715
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
F
Fabrice Bellard 已提交
2716
                         int *frame_size_ptr,
2717
                         uint8_t *buf, int buf_size);
2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749

/**
 * 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.
 */
2750
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
F
Fabrice Bellard 已提交
2751
                         int *got_picture_ptr,
2752
                         uint8_t *buf, int buf_size);
2753 2754 2755 2756

/* 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 已提交
2757 2758 2759
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
                            int *got_sub_ptr,
                            const uint8_t *buf, int buf_size);
2760
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2761
                        int *data_size_ptr,
2762
                        uint8_t *buf, int buf_size);
2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779

/**
 * 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.
 */
2780
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2781
                         const short *samples);
2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797

/**
 * 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.
 */
2798
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
M
Michael Niedermayer 已提交
2799
                         const AVFrame *pict);
2800
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
F
Fabrice Bellard 已提交
2801
                            const AVSubtitle *sub);
F
Fabrice Bellard 已提交
2802 2803 2804 2805

int avcodec_close(AVCodecContext *avctx);

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

2807 2808 2809
/**
 * Flush buffers, should be called when seeking or when switching to a different stream.
 */
M
Michael Niedermayer 已提交
2810 2811
void avcodec_flush_buffers(AVCodecContext *avctx);

2812 2813
void avcodec_default_free_buffers(AVCodecContext *s);

P
Panagiotis Issaris 已提交
2814
/* misc useful functions */
M
cleanup  
Michael Niedermayer 已提交
2815 2816

/**
2817 2818 2819 2820
 * 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 已提交
2821 2822 2823
 */
char av_get_pict_type_char(int pict_type);

2824
/**
2825 2826 2827 2828
 * 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.
2829 2830
 */
int av_get_bits_per_sample(enum CodecID codec_id);
2831

F
Fabrice Bellard 已提交
2832 2833 2834 2835 2836
/* frame parsing */
typedef struct AVCodecParserContext {
    void *priv_data;
    struct AVCodecParser *parser;
    int64_t frame_offset; /* offset of the current frame */
2837
    int64_t cur_offset; /* current offset
F
Fabrice Bellard 已提交
2838 2839 2840 2841 2842
                           (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 */
2843 2844 2845 2846 2847 2848
    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 已提交
2849
    int fetch_timestamp;
2850 2851 2852 2853 2854 2855

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

2857 2858
    int flags;
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
F
Fabrice Bellard 已提交
2859 2860 2861
} AVCodecParserContext;

typedef struct AVCodecParser {
M
Michael Niedermayer 已提交
2862
    int codec_ids[5]; /* several codec IDs are permitted */
F
Fabrice Bellard 已提交
2863 2864
    int priv_data_size;
    int (*parser_init)(AVCodecParserContext *s);
2865
    int (*parser_parse)(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2866
                        AVCodecContext *avctx,
2867
                        uint8_t **poutbuf, int *poutbuf_size,
F
Fabrice Bellard 已提交
2868 2869
                        const uint8_t *buf, int buf_size);
    void (*parser_close)(AVCodecParserContext *s);
2870
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
F
Fabrice Bellard 已提交
2871 2872 2873 2874 2875 2876 2877
    struct AVCodecParser *next;
} AVCodecParser;

extern AVCodecParser *av_first_parser;

void av_register_codec_parser(AVCodecParser *parser);
AVCodecParserContext *av_parser_init(int codec_id);
2878
int av_parser_parse(AVCodecParserContext *s,
F
Fabrice Bellard 已提交
2879
                    AVCodecContext *avctx,
2880
                    uint8_t **poutbuf, int *poutbuf_size,
2881 2882
                    const uint8_t *buf, int buf_size,
                    int64_t pts, int64_t dts);
2883 2884
int av_parser_change(AVCodecParserContext *s,
                     AVCodecContext *avctx,
2885
                     uint8_t **poutbuf, int *poutbuf_size,
2886
                     const uint8_t *buf, int buf_size, int keyframe);
F
Fabrice Bellard 已提交
2887 2888
void av_parser_close(AVCodecParserContext *s);

2889 2890
extern AVCodecParser aac_parser;
extern AVCodecParser ac3_parser;
2891
extern AVCodecParser cavsvideo_parser;
K
Kostya Shishkov 已提交
2892
extern AVCodecParser dca_parser;
2893 2894
extern AVCodecParser dvbsub_parser;
extern AVCodecParser dvdsub_parser;
2895
extern AVCodecParser h261_parser;
F
Fabrice Bellard 已提交
2896 2897
extern AVCodecParser h263_parser;
extern AVCodecParser h264_parser;
M
Michael Niedermayer 已提交
2898
extern AVCodecParser mjpeg_parser;
2899
extern AVCodecParser mpeg4video_parser;
F
Fabrice Bellard 已提交
2900
extern AVCodecParser mpegaudio_parser;
2901 2902
extern AVCodecParser mpegvideo_parser;
extern AVCodecParser pnm_parser;
K
Kostya Shishkov 已提交
2903
extern AVCodecParser vc1_parser;
F
Fabrice Bellard 已提交
2904

2905 2906

typedef struct AVBitStreamFilterContext {
M
Michael Niedermayer 已提交
2907
    void *priv_data;
2908 2909 2910 2911 2912 2913 2914 2915
    struct AVBitStreamFilter *filter;
    AVCodecParserContext *parser;
    struct AVBitStreamFilterContext *next;
} AVBitStreamFilterContext;


typedef struct AVBitStreamFilter {
    const char *name;
M
Michael Niedermayer 已提交
2916
    int priv_data_size;
2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935
    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 已提交
2936
extern AVBitStreamFilter noise_bsf;
2937 2938
extern AVBitStreamFilter mp3_header_compress_bsf;
extern AVBitStreamFilter mp3_header_decompress_bsf;
2939
extern AVBitStreamFilter mjpega_dump_header_bsf;
2940 2941


F
Fabrice Bellard 已提交
2942
/* memory */
2943 2944

/**
2945 2946 2947 2948
 * Reallocates the given block if it is not large enough, otherwise it
 * does nothing.
 *
 * @see av_realloc
2949
 */
2950
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2951

2952
/* for static data only */
2953 2954

/**
2955 2956
 * Frees all static arrays and reset their pointers to 0.
 * Call this function to release all statically allocated tables.
2957
 */
2958
void av_free_static(void);
2959 2960

/**
2961 2962 2963 2964 2965 2966
 * 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.
2967
 */
2968
void *av_mallocz_static(unsigned int size);
2969

2970 2971 2972
/**
 * Copy image 'src' to 'dst'.
 */
2973 2974 2975
void img_copy(AVPicture *dst, const AVPicture *src,
              int pix_fmt, int width, int height);

2976 2977 2978
/**
 * Crop image top and left side
 */
2979 2980 2981
int img_crop(AVPicture *dst, const AVPicture *src,
             int pix_fmt, int top_band, int left_band);

2982 2983 2984
/**
 * Pad image
 */
2985 2986 2987
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);

2988 2989
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);

2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006
/* 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 */

3007 3008 3009 3010
#ifdef __cplusplus
}
#endif

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