Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 30ab4ded

History | View | Annotate | Download (91.9 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * 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
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVCODEC_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

    
24
/**
25
 * @file avcodec.h
26
 * external API header
27
 */
28

    
29

    
30
#include "libavutil/avutil.h"
31

    
32
#define LIBAVCODEC_VERSION_MAJOR 52
33
#define LIBAVCODEC_VERSION_MINOR  0
34
#define LIBAVCODEC_VERSION_MICRO  0
35

    
36
#define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37
                                               LIBAVCODEC_VERSION_MINOR, \
38
                                               LIBAVCODEC_VERSION_MICRO)
39
#define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
40
                                           LIBAVCODEC_VERSION_MINOR,    \
41
                                           LIBAVCODEC_VERSION_MICRO)
42
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
43

    
44
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
45

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

    
50
/**
51
 * Identifies the syntax and semantics of the bitstream.
52
 * The principle is roughly:
53
 * Two decoders with the same ID can decode the same streams.
54
 * Two encoders with the same ID can encode compatible streams.
55
 * There may be slight deviations from the principle due to implementation
56
 * details.
57
 *
58
 * If you add a codec ID to this list, add it so that
59
 * 1. no value of a existing codec ID changes (that would break ABI),
60
 * 2. it is as close as possible to similar codecs.
61
 */
62
enum CodecID {
63
    CODEC_ID_NONE,
64

    
65
    /* video codecs */
66
    CODEC_ID_MPEG1VIDEO,
67
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
68
    CODEC_ID_MPEG2VIDEO_XVMC,
69
    CODEC_ID_H261,
70
    CODEC_ID_H263,
71
    CODEC_ID_RV10,
72
    CODEC_ID_RV20,
73
    CODEC_ID_MJPEG,
74
    CODEC_ID_MJPEGB,
75
    CODEC_ID_LJPEG,
76
    CODEC_ID_SP5X,
77
    CODEC_ID_JPEGLS,
78
    CODEC_ID_MPEG4,
79
    CODEC_ID_RAWVIDEO,
80
    CODEC_ID_MSMPEG4V1,
81
    CODEC_ID_MSMPEG4V2,
82
    CODEC_ID_MSMPEG4V3,
83
    CODEC_ID_WMV1,
84
    CODEC_ID_WMV2,
85
    CODEC_ID_H263P,
86
    CODEC_ID_H263I,
87
    CODEC_ID_FLV1,
88
    CODEC_ID_SVQ1,
89
    CODEC_ID_SVQ3,
90
    CODEC_ID_DVVIDEO,
91
    CODEC_ID_HUFFYUV,
92
    CODEC_ID_CYUV,
93
    CODEC_ID_H264,
94
    CODEC_ID_INDEO3,
95
    CODEC_ID_VP3,
96
    CODEC_ID_THEORA,
97
    CODEC_ID_ASV1,
98
    CODEC_ID_ASV2,
99
    CODEC_ID_FFV1,
100
    CODEC_ID_4XM,
101
    CODEC_ID_VCR1,
102
    CODEC_ID_CLJR,
103
    CODEC_ID_MDEC,
104
    CODEC_ID_ROQ,
105
    CODEC_ID_INTERPLAY_VIDEO,
106
    CODEC_ID_XAN_WC3,
107
    CODEC_ID_XAN_WC4,
108
    CODEC_ID_RPZA,
109
    CODEC_ID_CINEPAK,
110
    CODEC_ID_WS_VQA,
111
    CODEC_ID_MSRLE,
112
    CODEC_ID_MSVIDEO1,
113
    CODEC_ID_IDCIN,
114
    CODEC_ID_8BPS,
115
    CODEC_ID_SMC,
116
    CODEC_ID_FLIC,
117
    CODEC_ID_TRUEMOTION1,
118
    CODEC_ID_VMDVIDEO,
119
    CODEC_ID_MSZH,
120
    CODEC_ID_ZLIB,
121
    CODEC_ID_QTRLE,
122
    CODEC_ID_SNOW,
123
    CODEC_ID_TSCC,
124
    CODEC_ID_ULTI,
125
    CODEC_ID_QDRAW,
126
    CODEC_ID_VIXL,
127
    CODEC_ID_QPEG,
128
    CODEC_ID_XVID,
129
    CODEC_ID_PNG,
130
    CODEC_ID_PPM,
131
    CODEC_ID_PBM,
132
    CODEC_ID_PGM,
133
    CODEC_ID_PGMYUV,
134
    CODEC_ID_PAM,
135
    CODEC_ID_FFVHUFF,
136
    CODEC_ID_RV30,
137
    CODEC_ID_RV40,
138
    CODEC_ID_VC1,
139
    CODEC_ID_WMV3,
140
    CODEC_ID_LOCO,
141
    CODEC_ID_WNV1,
142
    CODEC_ID_AASC,
143
    CODEC_ID_INDEO2,
144
    CODEC_ID_FRAPS,
145
    CODEC_ID_TRUEMOTION2,
146
    CODEC_ID_BMP,
147
    CODEC_ID_CSCD,
148
    CODEC_ID_MMVIDEO,
149
    CODEC_ID_ZMBV,
150
    CODEC_ID_AVS,
151
    CODEC_ID_SMACKVIDEO,
152
    CODEC_ID_NUV,
153
    CODEC_ID_KMVC,
154
    CODEC_ID_FLASHSV,
155
    CODEC_ID_CAVS,
156
    CODEC_ID_JPEG2000,
157
    CODEC_ID_VMNC,
158
    CODEC_ID_VP5,
159
    CODEC_ID_VP6,
160
    CODEC_ID_VP6F,
161
    CODEC_ID_TARGA,
162
    CODEC_ID_DSICINVIDEO,
163
    CODEC_ID_TIERTEXSEQVIDEO,
164
    CODEC_ID_TIFF,
165
    CODEC_ID_GIF,
166
    CODEC_ID_FFH264,
167
    CODEC_ID_DXA,
168
    CODEC_ID_DNXHD,
169
    CODEC_ID_THP,
170
    CODEC_ID_SGI,
171
    CODEC_ID_C93,
172
    CODEC_ID_BETHSOFTVID,
173
    CODEC_ID_PTX,
174
    CODEC_ID_TXD,
175
    CODEC_ID_VP6A,
176
    CODEC_ID_AMV,
177
    CODEC_ID_VB,
178
    CODEC_ID_PCX,
179
    CODEC_ID_SUNRAST,
180
    CODEC_ID_INDEO4,
181
    CODEC_ID_INDEO5,
182
    CODEC_ID_MIMIC,
183
    CODEC_ID_RL2,
184
    CODEC_ID_8SVX_EXP,
185
    CODEC_ID_8SVX_FIB,
186
    CODEC_ID_ESCAPE124,
187
    CODEC_ID_DIRAC,
188
    CODEC_ID_BFI,
189
    CODEC_ID_CMV,
190
    CODEC_ID_MOTIONPIXELS,
191
    CODEC_ID_TGV,
192

    
193
    /* various PCM "codecs" */
194
    CODEC_ID_PCM_S16LE= 0x10000,
195
    CODEC_ID_PCM_S16BE,
196
    CODEC_ID_PCM_U16LE,
197
    CODEC_ID_PCM_U16BE,
198
    CODEC_ID_PCM_S8,
199
    CODEC_ID_PCM_U8,
200
    CODEC_ID_PCM_MULAW,
201
    CODEC_ID_PCM_ALAW,
202
    CODEC_ID_PCM_S32LE,
203
    CODEC_ID_PCM_S32BE,
204
    CODEC_ID_PCM_U32LE,
205
    CODEC_ID_PCM_U32BE,
206
    CODEC_ID_PCM_S24LE,
207
    CODEC_ID_PCM_S24BE,
208
    CODEC_ID_PCM_U24LE,
209
    CODEC_ID_PCM_U24BE,
210
    CODEC_ID_PCM_S24DAUD,
211
    CODEC_ID_PCM_ZORK,
212
    CODEC_ID_PCM_S16LE_PLANAR,
213
    CODEC_ID_PCM_DVD,
214
    CODEC_ID_PCM_F32BE,
215
    CODEC_ID_PCM_F32LE,
216
    CODEC_ID_PCM_F64BE,
217
    CODEC_ID_PCM_F64LE,
218

    
219
    /* various ADPCM codecs */
220
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
221
    CODEC_ID_ADPCM_IMA_WAV,
222
    CODEC_ID_ADPCM_IMA_DK3,
223
    CODEC_ID_ADPCM_IMA_DK4,
224
    CODEC_ID_ADPCM_IMA_WS,
225
    CODEC_ID_ADPCM_IMA_SMJPEG,
226
    CODEC_ID_ADPCM_MS,
227
    CODEC_ID_ADPCM_4XM,
228
    CODEC_ID_ADPCM_XA,
229
    CODEC_ID_ADPCM_ADX,
230
    CODEC_ID_ADPCM_EA,
231
    CODEC_ID_ADPCM_G726,
232
    CODEC_ID_ADPCM_CT,
233
    CODEC_ID_ADPCM_SWF,
234
    CODEC_ID_ADPCM_YAMAHA,
235
    CODEC_ID_ADPCM_SBPRO_4,
236
    CODEC_ID_ADPCM_SBPRO_3,
237
    CODEC_ID_ADPCM_SBPRO_2,
238
    CODEC_ID_ADPCM_THP,
239
    CODEC_ID_ADPCM_IMA_AMV,
240
    CODEC_ID_ADPCM_EA_R1,
241
    CODEC_ID_ADPCM_EA_R3,
242
    CODEC_ID_ADPCM_EA_R2,
243
    CODEC_ID_ADPCM_IMA_EA_SEAD,
244
    CODEC_ID_ADPCM_IMA_EA_EACS,
245
    CODEC_ID_ADPCM_EA_XAS,
246
    CODEC_ID_ADPCM_EA_MAXIS_XA,
247

    
248
    /* AMR */
249
    CODEC_ID_AMR_NB= 0x12000,
250
    CODEC_ID_AMR_WB,
251

    
252
    /* RealAudio codecs*/
253
    CODEC_ID_RA_144= 0x13000,
254
    CODEC_ID_RA_288,
255

    
256
    /* various DPCM codecs */
257
    CODEC_ID_ROQ_DPCM= 0x14000,
258
    CODEC_ID_INTERPLAY_DPCM,
259
    CODEC_ID_XAN_DPCM,
260
    CODEC_ID_SOL_DPCM,
261

    
262
    /* audio codecs */
263
    CODEC_ID_MP2= 0x15000,
264
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
265
    CODEC_ID_AAC,
266
    CODEC_ID_AC3,
267
    CODEC_ID_DTS,
268
    CODEC_ID_VORBIS,
269
    CODEC_ID_DVAUDIO,
270
    CODEC_ID_WMAV1,
271
    CODEC_ID_WMAV2,
272
    CODEC_ID_MACE3,
273
    CODEC_ID_MACE6,
274
    CODEC_ID_VMDAUDIO,
275
    CODEC_ID_SONIC,
276
    CODEC_ID_SONIC_LS,
277
    CODEC_ID_FLAC,
278
    CODEC_ID_MP3ADU,
279
    CODEC_ID_MP3ON4,
280
    CODEC_ID_SHORTEN,
281
    CODEC_ID_ALAC,
282
    CODEC_ID_WESTWOOD_SND1,
283
    CODEC_ID_GSM, ///< as in Berlin toast format
284
    CODEC_ID_QDM2,
285
    CODEC_ID_COOK,
286
    CODEC_ID_TRUESPEECH,
287
    CODEC_ID_TTA,
288
    CODEC_ID_SMACKAUDIO,
289
    CODEC_ID_QCELP,
290
    CODEC_ID_WAVPACK,
291
    CODEC_ID_DSICINAUDIO,
292
    CODEC_ID_IMC,
293
    CODEC_ID_MUSEPACK7,
294
    CODEC_ID_MLP,
295
    CODEC_ID_GSM_MS, /* as found in WAV */
296
    CODEC_ID_ATRAC3,
297
    CODEC_ID_VOXWARE,
298
    CODEC_ID_APE,
299
    CODEC_ID_NELLYMOSER,
300
    CODEC_ID_MUSEPACK8,
301
    CODEC_ID_SPEEX,
302
    CODEC_ID_WMAVOICE,
303
    CODEC_ID_WMAPRO,
304
    CODEC_ID_WMALOSSLESS,
305
    CODEC_ID_ATRAC3P,
306
    CODEC_ID_EAC3,
307
    CODEC_ID_SIPR,
308

    
309
    /* subtitle codecs */
310
    CODEC_ID_DVD_SUBTITLE= 0x17000,
311
    CODEC_ID_DVB_SUBTITLE,
312
    CODEC_ID_TEXT,  ///< raw UTF-8 text
313
    CODEC_ID_XSUB,
314
    CODEC_ID_SSA,
315
    CODEC_ID_MOV_TEXT,
316

    
317
    /* other specific kind of codecs (generally used for attachments) */
318
    CODEC_ID_TTF= 0x18000,
319

    
320
    CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
321

    
322
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
323
                                * stream (only used by libavformat) */
324
};
325

    
326
enum CodecType {
327
    CODEC_TYPE_UNKNOWN = -1,
328
    CODEC_TYPE_VIDEO,
329
    CODEC_TYPE_AUDIO,
330
    CODEC_TYPE_DATA,
331
    CODEC_TYPE_SUBTITLE,
332
    CODEC_TYPE_ATTACHMENT,
333
    CODEC_TYPE_NB
334
};
335

    
336
/**
337
 * all in native-endian format
338
 */
339
enum SampleFormat {
340
    SAMPLE_FMT_NONE = -1,
341
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
342
    SAMPLE_FMT_S16,             ///< signed 16 bits
343
    SAMPLE_FMT_S32,             ///< signed 32 bits
344
    SAMPLE_FMT_FLT,             ///< float
345
    SAMPLE_FMT_DBL,             ///< double
346
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
347
};
348

    
349
/* in bytes */
350
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
351

    
352
/**
353
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
354
 * This is mainly needed because some optimized bitstream readers read
355
 * 32 or 64 bit at once and could read over the end.<br>
356
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
357
 * MPEG bitstreams could cause overread and segfault.
358
 */
359
#define FF_INPUT_BUFFER_PADDING_SIZE 8
360

    
361
/**
362
 * minimum encoding buffer size
363
 * Used to avoid some checks during header writing.
364
 */
365
#define FF_MIN_BUFFER_SIZE 16384
366

    
367
/**
368
 * motion estimation type.
369
 */
370
enum Motion_Est_ID {
371
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
372
    ME_FULL,
373
    ME_LOG,
374
    ME_PHODS,
375
    ME_EPZS,        ///< enhanced predictive zonal search
376
    ME_X1,          ///< reserved for experiments
377
    ME_HEX,         ///< hexagon based search
378
    ME_UMH,         ///< uneven multi-hexagon search
379
    ME_ITER,        ///< iterative search
380
    ME_TESA,        ///< transformed exhaustive search algorithm
381
};
382

    
383
enum AVDiscard{
384
    /* We leave some space between them for extensions (drop some
385
     * keyframes for intra-only or drop just some bidir frames). */
386
    AVDISCARD_NONE   =-16, ///< discard nothing
387
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
388
    AVDISCARD_NONREF =  8, ///< discard all non reference
389
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
390
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
391
    AVDISCARD_ALL    = 48, ///< discard all
392
};
393

    
394
typedef struct RcOverride{
395
    int start_frame;
396
    int end_frame;
397
    int qscale; // If this is 0 then quality_factor will be used instead.
398
    float quality_factor;
399
} RcOverride;
400

    
401
#define FF_MAX_B_FRAMES 16
402

    
403
/* encoding support
404
   These flags can be passed in AVCodecContext.flags before initialization.
405
   Note: Not everything is supported yet.
406
*/
407

    
408
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
409
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
410
#define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
411
#define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
412
#define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
413
#define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
414
/**
415
 * The parent program guarantees that the input for B-frames containing
416
 * streams is not written to for at least s->max_b_frames+1 frames, if
417
 * this is not set the input will be copied.
418
 */
419
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
420
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
421
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
422
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
423
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
424
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
425
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
426
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
427
                                                  location instead of only at frame boundaries. */
428
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
429
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
430
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
431
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
432
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
433
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
434
/* Fx : Flag for h263+ extra options */
435
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
436
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
437
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
438
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
439
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
440
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
441
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
442
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
443
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
444
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
445
#define CODEC_FLAG_CLOSED_GOP     0x80000000
446
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
447
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
448
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
449
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
450
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
451
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
452
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
453
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
454
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
455
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
456
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
457
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
458
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
459
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
460
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
461
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
462
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
463
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
464

    
465
/* Unsupported options :
466
 *              Syntax Arithmetic coding (SAC)
467
 *              Reference Picture Selection
468
 *              Independent Segment Decoding */
469
/* /Fx */
470
/* codec capabilities */
471

    
472
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
473
/**
474
 * Codec uses get_buffer() for allocating buffers.
475
 * direct rendering method 1
476
 */
477
#define CODEC_CAP_DR1             0x0002
478
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
479
#define CODEC_CAP_PARSE_ONLY      0x0004
480
#define CODEC_CAP_TRUNCATED       0x0008
481
/* Codec can export data for HW decoding (XvMC). */
482
#define CODEC_CAP_HWACCEL         0x0010
483
/**
484
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
485
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
486
 */
487
#define CODEC_CAP_DELAY           0x0020
488
/**
489
 * Codec can be fed a final frame with a smaller size.
490
 * This can be used to prevent truncation of the last audio samples.
491
 */
492
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
493

    
494
//The following defines may change, don't expect compatibility if you use them.
495
#define MB_TYPE_INTRA4x4   0x0001
496
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
497
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
498
#define MB_TYPE_16x16      0x0008
499
#define MB_TYPE_16x8       0x0010
500
#define MB_TYPE_8x16       0x0020
501
#define MB_TYPE_8x8        0x0040
502
#define MB_TYPE_INTERLACED 0x0080
503
#define MB_TYPE_DIRECT2    0x0100 //FIXME
504
#define MB_TYPE_ACPRED     0x0200
505
#define MB_TYPE_GMC        0x0400
506
#define MB_TYPE_SKIP       0x0800
507
#define MB_TYPE_P0L0       0x1000
508
#define MB_TYPE_P1L0       0x2000
509
#define MB_TYPE_P0L1       0x4000
510
#define MB_TYPE_P1L1       0x8000
511
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
512
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
513
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
514
#define MB_TYPE_QUANT      0x00010000
515
#define MB_TYPE_CBP        0x00020000
516
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
517

    
518
/**
519
 * Pan Scan area.
520
 * This specifies the area which should be displayed.
521
 * Note there may be multiple such areas for one frame.
522
 */
523
typedef struct AVPanScan{
524
    /**
525
     * id
526
     * - encoding: Set by user.
527
     * - decoding: Set by libavcodec.
528
     */
529
    int id;
530

    
531
    /**
532
     * width and height in 1/16 pel
533
     * - encoding: Set by user.
534
     * - decoding: Set by libavcodec.
535
     */
536
    int width;
537
    int height;
538

    
539
    /**
540
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
541
     * - encoding: Set by user.
542
     * - decoding: Set by libavcodec.
543
     */
544
    int16_t position[3][2];
545
}AVPanScan;
546

    
547
#define FF_COMMON_FRAME \
548
    /**\
549
     * pointer to the picture planes.\
550
     * This might be different from the first allocated byte\
551
     * - encoding: \
552
     * - decoding: \
553
     */\
554
    uint8_t *data[4];\
555
    int linesize[4];\
556
    /**\
557
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
558
     * This isn't used by libavcodec unless the default get/release_buffer() is used.\
559
     * - encoding: \
560
     * - decoding: \
561
     */\
562
    uint8_t *base[4];\
563
    /**\
564
     * 1 -> keyframe, 0-> not\
565
     * - encoding: Set by libavcodec.\
566
     * - decoding: Set by libavcodec.\
567
     */\
568
    int key_frame;\
569
\
570
    /**\
571
     * Picture type of the frame, see ?_TYPE below.\
572
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
573
     * - decoding: Set by libavcodec.\
574
     */\
575
    int pict_type;\
576
\
577
    /**\
578
     * presentation timestamp in time_base units (time when frame should be shown to user)\
579
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
580
     * - encoding: MUST be set by user.\
581
     * - decoding: Set by libavcodec.\
582
     */\
583
    int64_t pts;\
584
\
585
    /**\
586
     * picture number in bitstream order\
587
     * - encoding: set by\
588
     * - decoding: Set by libavcodec.\
589
     */\
590
    int coded_picture_number;\
591
    /**\
592
     * picture number in display order\
593
     * - encoding: set by\
594
     * - decoding: Set by libavcodec.\
595
     */\
596
    int display_picture_number;\
597
\
598
    /**\
599
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
600
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
601
     * - decoding: Set by libavcodec.\
602
     */\
603
    int quality; \
604
\
605
    /**\
606
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
607
     * Set to INT_MAX if the buffer has not been used yet.\
608
     * - encoding: unused\
609
     * - decoding: MUST be set by get_buffer().\
610
     */\
611
    int age;\
612
\
613
    /**\
614
     * is this picture used as reference\
615
     * The values for this are the same as the MpegEncContext.picture_structure\
616
     * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
617
     * - encoding: unused\
618
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
619
     */\
620
    int reference;\
621
\
622
    /**\
623
     * QP table\
624
     * - encoding: unused\
625
     * - decoding: Set by libavcodec.\
626
     */\
627
    int8_t *qscale_table;\
628
    /**\
629
     * QP store stride\
630
     * - encoding: unused\
631
     * - decoding: Set by libavcodec.\
632
     */\
633
    int qstride;\
634
\
635
    /**\
636
     * mbskip_table[mb]>=1 if MB didn't change\
637
     * stride= mb_width = (width+15)>>4\
638
     * - encoding: unused\
639
     * - decoding: Set by libavcodec.\
640
     */\
641
    uint8_t *mbskip_table;\
642
\
643
    /**\
644
     * motion vector table\
645
     * @code\
646
     * example:\
647
     * int mv_sample_log2= 4 - motion_subsample_log2;\
648
     * int mb_width= (width+15)>>4;\
649
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
650
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
651
     * @endcode\
652
     * - encoding: Set by user.\
653
     * - decoding: Set by libavcodec.\
654
     */\
655
    int16_t (*motion_val[2])[2];\
656
\
657
    /**\
658
     * macroblock type table\
659
     * mb_type_base + mb_width + 2\
660
     * - encoding: Set by user.\
661
     * - decoding: Set by libavcodec.\
662
     */\
663
    uint32_t *mb_type;\
664
\
665
    /**\
666
     * log2 of the size of the block which a single vector in motion_val represents: \
667
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
668
     * - encoding: unused\
669
     * - decoding: Set by libavcodec.\
670
     */\
671
    uint8_t motion_subsample_log2;\
672
\
673
    /**\
674
     * for some private data of the user\
675
     * - encoding: unused\
676
     * - decoding: Set by user.\
677
     */\
678
    void *opaque;\
679
\
680
    /**\
681
     * error\
682
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
683
     * - decoding: unused\
684
     */\
685
    uint64_t error[4];\
686
\
687
    /**\
688
     * type of the buffer (to keep track of who has to deallocate data[*])\
689
     * - encoding: Set by the one who allocates it.\
690
     * - decoding: Set by the one who allocates it.\
691
     * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
692
     */\
693
    int type;\
694
    \
695
    /**\
696
     * When decoding, this signals how much the picture must be delayed.\
697
     * extra_delay = repeat_pict / (2*fps)\
698
     * - encoding: unused\
699
     * - decoding: Set by libavcodec.\
700
     */\
701
    int repeat_pict;\
702
    \
703
    /**\
704
     * \
705
     */\
706
    int qscale_type;\
707
    \
708
    /**\
709
     * The content of the picture is interlaced.\
710
     * - encoding: Set by user.\
711
     * - decoding: Set by libavcodec. (default 0)\
712
     */\
713
    int interlaced_frame;\
714
    \
715
    /**\
716
     * If the content is interlaced, is top field displayed first.\
717
     * - encoding: Set by user.\
718
     * - decoding: Set by libavcodec.\
719
     */\
720
    int top_field_first;\
721
    \
722
    /**\
723
     * Pan scan.\
724
     * - encoding: Set by user.\
725
     * - decoding: Set by libavcodec.\
726
     */\
727
    AVPanScan *pan_scan;\
728
    \
729
    /**\
730
     * Tell user application that palette has changed from previous frame.\
731
     * - encoding: ??? (no palette-enabled encoder yet)\
732
     * - decoding: Set by libavcodec. (default 0).\
733
     */\
734
    int palette_has_changed;\
735
    \
736
    /**\
737
     * codec suggestion on buffer type if != 0\
738
     * - encoding: unused\
739
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
740
     */\
741
    int buffer_hints;\
742
\
743
    /**\
744
     * DCT coefficients\
745
     * - encoding: unused\
746
     * - decoding: Set by libavcodec.\
747
     */\
748
    short *dct_coeff;\
749
\
750
    /**\
751
     * motion referece frame index\
752
     * - encoding: Set by user.\
753
     * - decoding: Set by libavcodec.\
754
     */\
755
    int8_t *ref_index[2];\
756
\
757
    /**\
758
     * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
759
     * output in AVFrame.reordered_opaque\
760
     * - encoding: unused\
761
     * - decoding: Read by user.\
762
     */\
763
    int64_t reordered_opaque;\
764

    
765

    
766
#define FF_QSCALE_TYPE_MPEG1 0
767
#define FF_QSCALE_TYPE_MPEG2 1
768
#define FF_QSCALE_TYPE_H264  2
769

    
770
#define FF_BUFFER_TYPE_INTERNAL 1
771
#define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
772
#define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
773
#define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
774

    
775

    
776
#define FF_I_TYPE  1 ///< Intra
777
#define FF_P_TYPE  2 ///< Predicted
778
#define FF_B_TYPE  3 ///< Bi-dir predicted
779
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
780
#define FF_SI_TYPE 5 ///< Switching Intra
781
#define FF_SP_TYPE 6 ///< Switching Predicted
782
#define FF_BI_TYPE 7
783

    
784
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
785
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
786
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
787
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
788

    
789
/**
790
 * Audio Video Frame.
791
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
792
 * bumps.
793
 * Removal, reordering and changes to existing fields require a major
794
 * version bump. No fields should be added into AVFrame before or after
795
 * FF_COMMON_FRAME!
796
 * sizeof(AVFrame) must not be used outside libav*.
797
 */
798
typedef struct AVFrame {
799
    FF_COMMON_FRAME
800
} AVFrame;
801

    
802
/**
803
 * main external API structure.
804
 * New fields can be added to the end with minor version bumps.
805
 * Removal, reordering and changes to existing fields require a major
806
 * version bump.
807
 * sizeof(AVCodecContext) must not be used outside libav*.
808
 */
809
typedef struct AVCodecContext {
810
    /**
811
     * information on struct for av_log
812
     * - set by avcodec_alloc_context
813
     */
814
    const AVClass *av_class;
815
    /**
816
     * the average bitrate
817
     * - encoding: Set by user; unused for constant quantizer encoding.
818
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
819
     */
820
    int bit_rate;
821

    
822
    /**
823
     * number of bits the bitstream is allowed to diverge from the reference.
824
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
825
     * - encoding: Set by user; unused for constant quantizer encoding.
826
     * - decoding: unused
827
     */
828
    int bit_rate_tolerance;
829

    
830
    /**
831
     * CODEC_FLAG_*.
832
     * - encoding: Set by user.
833
     * - decoding: Set by user.
834
     */
835
    int flags;
836

    
837
    /**
838
     * Some codecs need additional format info. It is stored here.
839
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
840
     * specific codec MUST set it correctly otherwise stream copy breaks.
841
     * In general use of this field by muxers is not recommanded.
842
     * - encoding: Set by libavcodec.
843
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
844
     */
845
    int sub_id;
846

    
847
    /**
848
     * Motion estimation algorithm used for video coding.
849
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
850
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
851
     * - encoding: MUST be set by user.
852
     * - decoding: unused
853
     */
854
    int me_method;
855

    
856
    /**
857
     * some codecs need / can use extradata like Huffman tables.
858
     * mjpeg: Huffman tables
859
     * rv10: additional flags
860
     * mpeg4: global headers (they can be in the bitstream or here)
861
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
862
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
863
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
864
     * - encoding: Set/allocated/freed by libavcodec.
865
     * - decoding: Set/allocated/freed by user.
866
     */
867
    uint8_t *extradata;
868
    int extradata_size;
869

    
870
    /**
871
     * This is the fundamental unit of time (in seconds) in terms
872
     * of which frame timestamps are represented. For fixed-fps content,
873
     * timebase should be 1/framerate and timestamp increments should be
874
     * identically 1.
875
     * - encoding: MUST be set by user.
876
     * - decoding: Set by libavcodec.
877
     */
878
    AVRational time_base;
879

    
880
    /* video only */
881
    /**
882
     * picture width / height.
883
     * - encoding: MUST be set by user.
884
     * - decoding: Set by libavcodec.
885
     * Note: For compatibility it is possible to set this instead of
886
     * coded_width/height before decoding.
887
     */
888
    int width, height;
889

    
890
#define FF_ASPECT_EXTENDED 15
891

    
892
    /**
893
     * the number of pictures in a group of pictures, or 0 for intra_only
894
     * - encoding: Set by user.
895
     * - decoding: unused
896
     */
897
    int gop_size;
898

    
899
    /**
900
     * Pixel format, see PIX_FMT_xxx.
901
     * - encoding: Set by user.
902
     * - decoding: Set by libavcodec.
903
     */
904
    enum PixelFormat pix_fmt;
905

    
906
    /**
907
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
908
     * has to read frames at native frame rate.
909
     * - encoding: Set by user.
910
     * - decoding: unused
911
     */
912
    int rate_emu;
913

    
914
    /**
915
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
916
     * decoder to draw a horizontal band. It improves cache usage. Not
917
     * all codecs can do that. You must check the codec capabilities
918
     * beforehand.
919
     * - encoding: unused
920
     * - decoding: Set by user.
921
     * @param height the height of the slice
922
     * @param y the y position of the slice
923
     * @param type 1->top field, 2->bottom field, 3->frame
924
     * @param offset offset into the AVFrame.data from which the slice should be read
925
     */
926
    void (*draw_horiz_band)(struct AVCodecContext *s,
927
                            const AVFrame *src, int offset[4],
928
                            int y, int type, int height);
929

    
930
    /* audio only */
931
    int sample_rate; ///< samples per second
932
    int channels;    ///< number of audio channels
933

    
934
    /**
935
     * audio sample format
936
     * - encoding: Set by user.
937
     * - decoding: Set by libavcodec.
938
     */
939
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
940

    
941
    /* The following data should not be initialized. */
942
    /**
943
     * Samples per packet, initialized when calling 'init'.
944
     */
945
    int frame_size;
946
    int frame_number;   ///< audio or video frame number
947
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
948

    
949
    /**
950
     * Number of frames the decoded output will be delayed relative to
951
     * the encoded input.
952
     * - encoding: Set by libavcodec.
953
     * - decoding: unused
954
     */
955
    int delay;
956

    
957
    /* - encoding parameters */
958
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
959
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
960

    
961
    /**
962
     * minimum quantizer
963
     * - encoding: Set by user.
964
     * - decoding: unused
965
     */
966
    int qmin;
967

    
968
    /**
969
     * maximum quantizer
970
     * - encoding: Set by user.
971
     * - decoding: unused
972
     */
973
    int qmax;
974

    
975
    /**
976
     * maximum quantizer difference between frames
977
     * - encoding: Set by user.
978
     * - decoding: unused
979
     */
980
    int max_qdiff;
981

    
982
    /**
983
     * maximum number of B-frames between non-B-frames
984
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
985
     * - encoding: Set by user.
986
     * - decoding: unused
987
     */
988
    int max_b_frames;
989

    
990
    /**
991
     * qscale factor between IP and B-frames
992
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
993
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
994
     * - encoding: Set by user.
995
     * - decoding: unused
996
     */
997
    float b_quant_factor;
998

    
999
    /** obsolete FIXME remove */
1000
    int rc_strategy;
1001
#define FF_RC_STRATEGY_XVID 1
1002

    
1003
    int b_frame_strategy;
1004

    
1005
    /**
1006
     * hurry up amount
1007
     * - encoding: unused
1008
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1009
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1010
     */
1011
    int hurry_up;
1012

    
1013
    struct AVCodec *codec;
1014

    
1015
    void *priv_data;
1016

    
1017
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1018
                            /* do its best to deliver a chunk with size     */
1019
                            /* below rtp_payload_size, the chunk will start */
1020
                            /* with a start code on some codecs like H.263. */
1021
                            /* This doesn't take account of any particular  */
1022
                            /* headers inside the transmitted RTP payload.  */
1023

    
1024

    
1025
    /* The RTP callback: This function is called    */
1026
    /* every time the encoder has a packet to send. */
1027
    /* It depends on the encoder if the data starts */
1028
    /* with a Start Code (it should). H.263 does.   */
1029
    /* mb_nb contains the number of macroblocks     */
1030
    /* encoded in the RTP payload.                  */
1031
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1032

    
1033
    /* statistics, used for 2-pass encoding */
1034
    int mv_bits;
1035
    int header_bits;
1036
    int i_tex_bits;
1037
    int p_tex_bits;
1038
    int i_count;
1039
    int p_count;
1040
    int skip_count;
1041
    int misc_bits;
1042

    
1043
    /**
1044
     * number of bits used for the previously encoded frame
1045
     * - encoding: Set by libavcodec.
1046
     * - decoding: unused
1047
     */
1048
    int frame_bits;
1049

    
1050
    /**
1051
     * Private data of the user, can be used to carry app specific stuff.
1052
     * - encoding: Set by user.
1053
     * - decoding: Set by user.
1054
     */
1055
    void *opaque;
1056

    
1057
    char codec_name[32];
1058
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1059
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1060

    
1061
    /**
1062
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1063
     * This is used to work around some encoder bugs.
1064
     * A demuxer should set this to what is stored in the field used to identify the codec.
1065
     * If there are multiple such fields in a container then the demuxer should choose the one
1066
     * which maximizes the information about the used codec.
1067
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1068
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1069
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1070
     * first.
1071
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1072
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1073
     */
1074
    unsigned int codec_tag;
1075

    
1076
    /**
1077
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1078
     * - encoding: Set by user
1079
     * - decoding: Set by user
1080
     */
1081
    int workaround_bugs;
1082
#define FF_BUG_AUTODETECT       1  ///< autodetection
1083
#define FF_BUG_OLD_MSMPEG4      2
1084
#define FF_BUG_XVID_ILACE       4
1085
#define FF_BUG_UMP4             8
1086
#define FF_BUG_NO_PADDING       16
1087
#define FF_BUG_AMV              32
1088
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1089
#define FF_BUG_QPEL_CHROMA      64
1090
#define FF_BUG_STD_QPEL         128
1091
#define FF_BUG_QPEL_CHROMA2     256
1092
#define FF_BUG_DIRECT_BLOCKSIZE 512
1093
#define FF_BUG_EDGE             1024
1094
#define FF_BUG_HPEL_CHROMA      2048
1095
#define FF_BUG_DC_CLIP          4096
1096
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1097
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1098

    
1099
    /**
1100
     * luma single coefficient elimination threshold
1101
     * - encoding: Set by user.
1102
     * - decoding: unused
1103
     */
1104
    int luma_elim_threshold;
1105

    
1106
    /**
1107
     * chroma single coeff elimination threshold
1108
     * - encoding: Set by user.
1109
     * - decoding: unused
1110
     */
1111
    int chroma_elim_threshold;
1112

    
1113
    /**
1114
     * strictly follow the standard (MPEG4, ...).
1115
     * - encoding: Set by user.
1116
     * - decoding: Set by user.
1117
     * Setting this to STRICT or higher means the encoder and decoder will
1118
     * generally do stupid things. While setting it to inofficial or lower
1119
     * will mean the encoder might use things that are not supported by all
1120
     * spec compliant decoders. Decoders make no difference between normal,
1121
     * inofficial and experimental, that is they always try to decode things
1122
     * when they can unless they are explicitly asked to behave stupid
1123
     * (=strictly conform to the specs)
1124
     */
1125
    int strict_std_compliance;
1126
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1127
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1128
#define FF_COMPLIANCE_NORMAL        0
1129
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1130
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1131

    
1132
    /**
1133
     * qscale offset between IP and B-frames
1134
     * - encoding: Set by user.
1135
     * - decoding: unused
1136
     */
1137
    float b_quant_offset;
1138

    
1139
    /**
1140
     * Error recognization; higher values will detect more errors but may
1141
     * misdetect some more or less valid parts as errors.
1142
     * - encoding: unused
1143
     * - decoding: Set by user.
1144
     */
1145
    int error_recognition;
1146
#define FF_ER_CAREFUL         1
1147
#define FF_ER_COMPLIANT       2
1148
#define FF_ER_AGGRESSIVE      3
1149
#define FF_ER_VERY_AGGRESSIVE 4
1150

    
1151
    /**
1152
     * Called at the beginning of each frame to get a buffer for it.
1153
     * If pic.reference is set then the frame will be read later by libavcodec.
1154
     * avcodec_align_dimensions() should be used to find the required width and
1155
     * height, as they normally need to be rounded up to the next multiple of 16.
1156
     * - encoding: unused
1157
     * - decoding: Set by libavcodec., user can override.
1158
     */
1159
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1160

    
1161
    /**
1162
     * Called to release buffers which were allocated with get_buffer.
1163
     * A released buffer can be reused in get_buffer().
1164
     * pic.data[*] must be set to NULL.
1165
     * - encoding: unused
1166
     * - decoding: Set by libavcodec., user can override.
1167
     */
1168
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1169

    
1170
    /**
1171
     * If 1 the stream has a 1 frame delay during decoding.
1172
     * - encoding: Set by libavcodec.
1173
     * - decoding: Set by libavcodec.
1174
     */
1175
    int has_b_frames;
1176

    
1177
    /**
1178
     * number of bytes per packet if constant and known or 0
1179
     * Used by some WAV based audio codecs.
1180
     */
1181
    int block_align;
1182

    
1183
    int parse_only; /* - decoding only: If true, only parsing is done
1184
                       (function avcodec_parse_frame()). The frame
1185
                       data is returned. Only MPEG codecs support this now. */
1186

    
1187
    /**
1188
     * 0-> h263 quant 1-> mpeg quant
1189
     * - encoding: Set by user.
1190
     * - decoding: unused
1191
     */
1192
    int mpeg_quant;
1193

    
1194
    /**
1195
     * pass1 encoding statistics output buffer
1196
     * - encoding: Set by libavcodec.
1197
     * - decoding: unused
1198
     */
1199
    char *stats_out;
1200

    
1201
    /**
1202
     * pass2 encoding statistics input buffer
1203
     * Concatenated stuff from stats_out of pass1 should be placed here.
1204
     * - encoding: Allocated/set/freed by user.
1205
     * - decoding: unused
1206
     */
1207
    char *stats_in;
1208

    
1209
    /**
1210
     * ratecontrol qmin qmax limiting method
1211
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1212
     * - encoding: Set by user.
1213
     * - decoding: unused
1214
     */
1215
    float rc_qsquish;
1216

    
1217
    float rc_qmod_amp;
1218
    int rc_qmod_freq;
1219

    
1220
    /**
1221
     * ratecontrol override, see RcOverride
1222
     * - encoding: Allocated/set/freed by user.
1223
     * - decoding: unused
1224
     */
1225
    RcOverride *rc_override;
1226
    int rc_override_count;
1227

    
1228
    /**
1229
     * rate control equation
1230
     * - encoding: Set by user
1231
     * - decoding: unused
1232
     */
1233
    const char *rc_eq;
1234

    
1235
    /**
1236
     * maximum bitrate
1237
     * - encoding: Set by user.
1238
     * - decoding: unused
1239
     */
1240
    int rc_max_rate;
1241

    
1242
    /**
1243
     * minimum bitrate
1244
     * - encoding: Set by user.
1245
     * - decoding: unused
1246
     */
1247
    int rc_min_rate;
1248

    
1249
    /**
1250
     * decoder bitstream buffer size
1251
     * - encoding: Set by user.
1252
     * - decoding: unused
1253
     */
1254
    int rc_buffer_size;
1255
    float rc_buffer_aggressivity;
1256

    
1257
    /**
1258
     * qscale factor between P and I-frames
1259
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1260
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1261
     * - encoding: Set by user.
1262
     * - decoding: unused
1263
     */
1264
    float i_quant_factor;
1265

    
1266
    /**
1267
     * qscale offset between P and I-frames
1268
     * - encoding: Set by user.
1269
     * - decoding: unused
1270
     */
1271
    float i_quant_offset;
1272

    
1273
    /**
1274
     * initial complexity for pass1 ratecontrol
1275
     * - encoding: Set by user.
1276
     * - decoding: unused
1277
     */
1278
    float rc_initial_cplx;
1279

    
1280
    /**
1281
     * DCT algorithm, see FF_DCT_* below
1282
     * - encoding: Set by user.
1283
     * - decoding: unused
1284
     */
1285
    int dct_algo;
1286
#define FF_DCT_AUTO    0
1287
#define FF_DCT_FASTINT 1
1288
#define FF_DCT_INT     2
1289
#define FF_DCT_MMX     3
1290
#define FF_DCT_MLIB    4
1291
#define FF_DCT_ALTIVEC 5
1292
#define FF_DCT_FAAN    6
1293

    
1294
    /**
1295
     * luminance masking (0-> disabled)
1296
     * - encoding: Set by user.
1297
     * - decoding: unused
1298
     */
1299
    float lumi_masking;
1300

    
1301
    /**
1302
     * temporary complexity masking (0-> disabled)
1303
     * - encoding: Set by user.
1304
     * - decoding: unused
1305
     */
1306
    float temporal_cplx_masking;
1307

    
1308
    /**
1309
     * spatial complexity masking (0-> disabled)
1310
     * - encoding: Set by user.
1311
     * - decoding: unused
1312
     */
1313
    float spatial_cplx_masking;
1314

    
1315
    /**
1316
     * p block masking (0-> disabled)
1317
     * - encoding: Set by user.
1318
     * - decoding: unused
1319
     */
1320
    float p_masking;
1321

    
1322
    /**
1323
     * darkness masking (0-> disabled)
1324
     * - encoding: Set by user.
1325
     * - decoding: unused
1326
     */
1327
    float dark_masking;
1328

    
1329
    /**
1330
     * IDCT algorithm, see FF_IDCT_* below.
1331
     * - encoding: Set by user.
1332
     * - decoding: Set by user.
1333
     */
1334
    int idct_algo;
1335
#define FF_IDCT_AUTO          0
1336
#define FF_IDCT_INT           1
1337
#define FF_IDCT_SIMPLE        2
1338
#define FF_IDCT_SIMPLEMMX     3
1339
#define FF_IDCT_LIBMPEG2MMX   4
1340
#define FF_IDCT_PS2           5
1341
#define FF_IDCT_MLIB          6
1342
#define FF_IDCT_ARM           7
1343
#define FF_IDCT_ALTIVEC       8
1344
#define FF_IDCT_SH4           9
1345
#define FF_IDCT_SIMPLEARM     10
1346
#define FF_IDCT_H264          11
1347
#define FF_IDCT_VP3           12
1348
#define FF_IDCT_IPP           13
1349
#define FF_IDCT_XVIDMMX       14
1350
#define FF_IDCT_CAVS          15
1351
#define FF_IDCT_SIMPLEARMV5TE 16
1352
#define FF_IDCT_SIMPLEARMV6   17
1353
#define FF_IDCT_SIMPLEVIS     18
1354
#define FF_IDCT_WMV2          19
1355
#define FF_IDCT_FAAN          20
1356

    
1357
    /**
1358
     * slice count
1359
     * - encoding: Set by libavcodec.
1360
     * - decoding: Set by user (or 0).
1361
     */
1362
    int slice_count;
1363
    /**
1364
     * slice offsets in the frame in bytes
1365
     * - encoding: Set/allocated by libavcodec.
1366
     * - decoding: Set/allocated by user (or NULL).
1367
     */
1368
    int *slice_offset;
1369

    
1370
    /**
1371
     * error concealment flags
1372
     * - encoding: unused
1373
     * - decoding: Set by user.
1374
     */
1375
    int error_concealment;
1376
#define FF_EC_GUESS_MVS   1
1377
#define FF_EC_DEBLOCK     2
1378

    
1379
    /**
1380
     * dsp_mask could be add used to disable unwanted CPU features
1381
     * CPU features (i.e. MMX, SSE. ...)
1382
     *
1383
     * With the FORCE flag you may instead enable given CPU features.
1384
     * (Dangerous: Usable in case of misdetection, improper usage however will
1385
     * result into program crash.)
1386
     */
1387
    unsigned dsp_mask;
1388
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1389
    /* lower 16 bits - CPU features */
1390
#define FF_MM_MMX      0x0001 ///< standard MMX
1391
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1392
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1393
#define FF_MM_SSE      0x0008 ///< SSE functions
1394
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1395
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1396
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1397
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1398
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1399

    
1400
    /**
1401
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1402
     * - encoding: Set by libavcodec.
1403
     * - decoding: Set by user.
1404
     */
1405
     int bits_per_coded_sample;
1406

    
1407
    /**
1408
     * prediction method (needed for huffyuv)
1409
     * - encoding: Set by user.
1410
     * - decoding: unused
1411
     */
1412
     int prediction_method;
1413
#define FF_PRED_LEFT   0
1414
#define FF_PRED_PLANE  1
1415
#define FF_PRED_MEDIAN 2
1416

    
1417
    /**
1418
     * sample aspect ratio (0 if unknown)
1419
     * That is the width of a pixel divided by the height of the pixel.
1420
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1421
     * - encoding: Set by user.
1422
     * - decoding: Set by libavcodec.
1423
     */
1424
    AVRational sample_aspect_ratio;
1425

    
1426
    /**
1427
     * the picture in the bitstream
1428
     * - encoding: Set by libavcodec.
1429
     * - decoding: Set by libavcodec.
1430
     */
1431
    AVFrame *coded_frame;
1432

    
1433
    /**
1434
     * debug
1435
     * - encoding: Set by user.
1436
     * - decoding: Set by user.
1437
     */
1438
    int debug;
1439
#define FF_DEBUG_PICT_INFO   1
1440
#define FF_DEBUG_RC          2
1441
#define FF_DEBUG_BITSTREAM   4
1442
#define FF_DEBUG_MB_TYPE     8
1443
#define FF_DEBUG_QP          16
1444
#define FF_DEBUG_MV          32
1445
#define FF_DEBUG_DCT_COEFF   0x00000040
1446
#define FF_DEBUG_SKIP        0x00000080
1447
#define FF_DEBUG_STARTCODE   0x00000100
1448
#define FF_DEBUG_PTS         0x00000200
1449
#define FF_DEBUG_ER          0x00000400
1450
#define FF_DEBUG_MMCO        0x00000800
1451
#define FF_DEBUG_BUGS        0x00001000
1452
#define FF_DEBUG_VIS_QP      0x00002000
1453
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1454
#define FF_DEBUG_BUFFERS     0x00008000
1455

    
1456
    /**
1457
     * debug
1458
     * - encoding: Set by user.
1459
     * - decoding: Set by user.
1460
     */
1461
    int debug_mv;
1462
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1463
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1464
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1465

    
1466
    /**
1467
     * error
1468
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1469
     * - decoding: unused
1470
     */
1471
    uint64_t error[4];
1472

    
1473
    /**
1474
     * minimum MB quantizer
1475
     * - encoding: unused
1476
     * - decoding: unused
1477
     */
1478
    int mb_qmin;
1479

    
1480
    /**
1481
     * maximum MB quantizer
1482
     * - encoding: unused
1483
     * - decoding: unused
1484
     */
1485
    int mb_qmax;
1486

    
1487
    /**
1488
     * motion estimation comparison function
1489
     * - encoding: Set by user.
1490
     * - decoding: unused
1491
     */
1492
    int me_cmp;
1493
    /**
1494
     * subpixel motion estimation comparison function
1495
     * - encoding: Set by user.
1496
     * - decoding: unused
1497
     */
1498
    int me_sub_cmp;
1499
    /**
1500
     * macroblock comparison function (not supported yet)
1501
     * - encoding: Set by user.
1502
     * - decoding: unused
1503
     */
1504
    int mb_cmp;
1505
    /**
1506
     * interlaced DCT comparison function
1507
     * - encoding: Set by user.
1508
     * - decoding: unused
1509
     */
1510
    int ildct_cmp;
1511
#define FF_CMP_SAD    0
1512
#define FF_CMP_SSE    1
1513
#define FF_CMP_SATD   2
1514
#define FF_CMP_DCT    3
1515
#define FF_CMP_PSNR   4
1516
#define FF_CMP_BIT    5
1517
#define FF_CMP_RD     6
1518
#define FF_CMP_ZERO   7
1519
#define FF_CMP_VSAD   8
1520
#define FF_CMP_VSSE   9
1521
#define FF_CMP_NSSE   10
1522
#define FF_CMP_W53    11
1523
#define FF_CMP_W97    12
1524
#define FF_CMP_DCTMAX 13
1525
#define FF_CMP_DCT264 14
1526
#define FF_CMP_CHROMA 256
1527

    
1528
    /**
1529
     * ME diamond size & shape
1530
     * - encoding: Set by user.
1531
     * - decoding: unused
1532
     */
1533
    int dia_size;
1534

    
1535
    /**
1536
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1537
     * - encoding: Set by user.
1538
     * - decoding: unused
1539
     */
1540
    int last_predictor_count;
1541

    
1542
    /**
1543
     * prepass for motion estimation
1544
     * - encoding: Set by user.
1545
     * - decoding: unused
1546
     */
1547
    int pre_me;
1548

    
1549
    /**
1550
     * motion estimation prepass comparison function
1551
     * - encoding: Set by user.
1552
     * - decoding: unused
1553
     */
1554
    int me_pre_cmp;
1555

    
1556
    /**
1557
     * ME prepass diamond size & shape
1558
     * - encoding: Set by user.
1559
     * - decoding: unused
1560
     */
1561
    int pre_dia_size;
1562

    
1563
    /**
1564
     * subpel ME quality
1565
     * - encoding: Set by user.
1566
     * - decoding: unused
1567
     */
1568
    int me_subpel_quality;
1569

    
1570
    /**
1571
     * callback to negotiate the pixelFormat
1572
     * @param fmt is the list of formats which are supported by the codec,
1573
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1574
     * The first is always the native one.
1575
     * @return the chosen format
1576
     * - encoding: unused
1577
     * - decoding: Set by user, if not set the native format will be chosen.
1578
     */
1579
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1580

    
1581
    /**
1582
     * DTG active format information (additional aspect ratio
1583
     * information only used in DVB MPEG-2 transport streams)
1584
     * 0 if not set.
1585
     *
1586
     * - encoding: unused
1587
     * - decoding: Set by decoder.
1588
     */
1589
    int dtg_active_format;
1590
#define FF_DTG_AFD_SAME         8
1591
#define FF_DTG_AFD_4_3          9
1592
#define FF_DTG_AFD_16_9         10
1593
#define FF_DTG_AFD_14_9         11
1594
#define FF_DTG_AFD_4_3_SP_14_9  13
1595
#define FF_DTG_AFD_16_9_SP_14_9 14
1596
#define FF_DTG_AFD_SP_4_3       15
1597

    
1598
    /**
1599
     * maximum motion estimation search range in subpel units
1600
     * If 0 then no limit.
1601
     *
1602
     * - encoding: Set by user.
1603
     * - decoding: unused
1604
     */
1605
    int me_range;
1606

    
1607
    /**
1608
     * intra quantizer bias
1609
     * - encoding: Set by user.
1610
     * - decoding: unused
1611
     */
1612
    int intra_quant_bias;
1613
#define FF_DEFAULT_QUANT_BIAS 999999
1614

    
1615
    /**
1616
     * inter quantizer bias
1617
     * - encoding: Set by user.
1618
     * - decoding: unused
1619
     */
1620
    int inter_quant_bias;
1621

    
1622
    /**
1623
     * color table ID
1624
     * - encoding: unused
1625
     * - decoding: Which clrtable should be used for 8bit RGB images.
1626
     *             Tables have to be stored somewhere. FIXME
1627
     */
1628
    int color_table_id;
1629

    
1630
    /**
1631
     * internal_buffer count
1632
     * Don't touch, used by libavcodec default_get_buffer().
1633
     */
1634
    int internal_buffer_count;
1635

    
1636
    /**
1637
     * internal_buffers
1638
     * Don't touch, used by libavcodec default_get_buffer().
1639
     */
1640
    void *internal_buffer;
1641

    
1642
#define FF_LAMBDA_SHIFT 7
1643
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1644
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1645
#define FF_LAMBDA_MAX (256*128-1)
1646

    
1647
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1648
    /**
1649
     * Global quality for codecs which cannot change it per frame.
1650
     * This should be proportional to MPEG-1/2/4 qscale.
1651
     * - encoding: Set by user.
1652
     * - decoding: unused
1653
     */
1654
    int global_quality;
1655

    
1656
#define FF_CODER_TYPE_VLC       0
1657
#define FF_CODER_TYPE_AC        1
1658
#define FF_CODER_TYPE_RAW       2
1659
#define FF_CODER_TYPE_RLE       3
1660
#define FF_CODER_TYPE_DEFLATE   4
1661
    /**
1662
     * coder type
1663
     * - encoding: Set by user.
1664
     * - decoding: unused
1665
     */
1666
    int coder_type;
1667

    
1668
    /**
1669
     * context model
1670
     * - encoding: Set by user.
1671
     * - decoding: unused
1672
     */
1673
    int context_model;
1674
#if 0
1675
    /**
1676
     *
1677
     * - encoding: unused
1678
     * - decoding: Set by user.
1679
     */
1680
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1681
#endif
1682

    
1683
    /**
1684
     * slice flags
1685
     * - encoding: unused
1686
     * - decoding: Set by user.
1687
     */
1688
    int slice_flags;
1689
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1690
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1691
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1692

    
1693
    /**
1694
     * XVideo Motion Acceleration
1695
     * - encoding: forbidden
1696
     * - decoding: set by decoder
1697
     */
1698
    int xvmc_acceleration;
1699

    
1700
    /**
1701
     * macroblock decision mode
1702
     * - encoding: Set by user.
1703
     * - decoding: unused
1704
     */
1705
    int mb_decision;
1706
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1707
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1708
#define FF_MB_DECISION_RD     2        ///< rate distortion
1709

    
1710
    /**
1711
     * custom intra quantization matrix
1712
     * - encoding: Set by user, can be NULL.
1713
     * - decoding: Set by libavcodec.
1714
     */
1715
    uint16_t *intra_matrix;
1716

    
1717
    /**
1718
     * custom inter quantization matrix
1719
     * - encoding: Set by user, can be NULL.
1720
     * - decoding: Set by libavcodec.
1721
     */
1722
    uint16_t *inter_matrix;
1723

    
1724
    /**
1725
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1726
     * This is used to work around some encoder bugs.
1727
     * - encoding: unused
1728
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1729
     */
1730
    unsigned int stream_codec_tag;
1731

    
1732
    /**
1733
     * scene change detection threshold
1734
     * 0 is default, larger means fewer detected scene changes.
1735
     * - encoding: Set by user.
1736
     * - decoding: unused
1737
     */
1738
    int scenechange_threshold;
1739

    
1740
    /**
1741
     * minimum Lagrange multipler
1742
     * - encoding: Set by user.
1743
     * - decoding: unused
1744
     */
1745
    int lmin;
1746

    
1747
    /**
1748
     * maximum Lagrange multipler
1749
     * - encoding: Set by user.
1750
     * - decoding: unused
1751
     */
1752
    int lmax;
1753

    
1754
    /**
1755
     * palette control structure
1756
     * - encoding: ??? (no palette-enabled encoder yet)
1757
     * - decoding: Set by user.
1758
     */
1759
    struct AVPaletteControl *palctrl;
1760

    
1761
    /**
1762
     * noise reduction strength
1763
     * - encoding: Set by user.
1764
     * - decoding: unused
1765
     */
1766
    int noise_reduction;
1767

    
1768
    /**
1769
     * Called at the beginning of a frame to get cr buffer for it.
1770
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1771
     * libavcodec will pass previous buffer in pic, function should return
1772
     * same buffer or new buffer with old frame "painted" into it.
1773
     * If pic.data[0] == NULL must behave like get_buffer().
1774
     * - encoding: unused
1775
     * - decoding: Set by libavcodec., user can override
1776
     */
1777
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1778

    
1779
    /**
1780
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1781
     * - encoding: Set by user.
1782
     * - decoding: unused
1783
     */
1784
    int rc_initial_buffer_occupancy;
1785

    
1786
    /**
1787
     *
1788
     * - encoding: Set by user.
1789
     * - decoding: unused
1790
     */
1791
    int inter_threshold;
1792

    
1793
    /**
1794
     * CODEC_FLAG2_*
1795
     * - encoding: Set by user.
1796
     * - decoding: Set by user.
1797
     */
1798
    int flags2;
1799

    
1800
    /**
1801
     * Simulates errors in the bitstream to test error concealment.
1802
     * - encoding: Set by user.
1803
     * - decoding: unused
1804
     */
1805
    int error_rate;
1806

    
1807
    /**
1808
     * MP3 antialias algorithm, see FF_AA_* below.
1809
     * - encoding: unused
1810
     * - decoding: Set by user.
1811
     */
1812
    int antialias_algo;
1813
#define FF_AA_AUTO    0
1814
#define FF_AA_FASTINT 1 //not implemented yet
1815
#define FF_AA_INT     2
1816
#define FF_AA_FLOAT   3
1817
    /**
1818
     * quantizer noise shaping
1819
     * - encoding: Set by user.
1820
     * - decoding: unused
1821
     */
1822
    int quantizer_noise_shaping;
1823

    
1824
    /**
1825
     * thread count
1826
     * is used to decide how many independent tasks should be passed to execute()
1827
     * - encoding: Set by user.
1828
     * - decoding: Set by user.
1829
     */
1830
    int thread_count;
1831

    
1832
    /**
1833
     * The codec may call this to execute several independent things.
1834
     * It will return only after finishing all tasks.
1835
     * The user may replace this with some multithreaded implementation,
1836
     * the default implementation will execute the parts serially.
1837
     * @param count the number of things to execute
1838
     * - encoding: Set by libavcodec, user can override.
1839
     * - decoding: Set by libavcodec, user can override.
1840
     */
1841
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1842

    
1843
    /**
1844
     * thread opaque
1845
     * Can be used by execute() to store some per AVCodecContext stuff.
1846
     * - encoding: set by execute()
1847
     * - decoding: set by execute()
1848
     */
1849
    void *thread_opaque;
1850

    
1851
    /**
1852
     * Motion estimation threshold below which no motion estimation is
1853
     * performed, but instead the user specified motion vectors are used.
1854
     *
1855
     * - encoding: Set by user.
1856
     * - decoding: unused
1857
     */
1858
     int me_threshold;
1859

    
1860
    /**
1861
     * Macroblock threshold below which the user specified macroblock types will be used.
1862
     * - encoding: Set by user.
1863
     * - decoding: unused
1864
     */
1865
     int mb_threshold;
1866

    
1867
    /**
1868
     * precision of the intra DC coefficient - 8
1869
     * - encoding: Set by user.
1870
     * - decoding: unused
1871
     */
1872
     int intra_dc_precision;
1873

    
1874
    /**
1875
     * noise vs. sse weight for the nsse comparsion function
1876
     * - encoding: Set by user.
1877
     * - decoding: unused
1878
     */
1879
     int nsse_weight;
1880

    
1881
    /**
1882
     * Number of macroblock rows at the top which are skipped.
1883
     * - encoding: unused
1884
     * - decoding: Set by user.
1885
     */
1886
     int skip_top;
1887

    
1888
    /**
1889
     * Number of macroblock rows at the bottom which are skipped.
1890
     * - encoding: unused
1891
     * - decoding: Set by user.
1892
     */
1893
     int skip_bottom;
1894

    
1895
    /**
1896
     * profile
1897
     * - encoding: Set by user.
1898
     * - decoding: Set by libavcodec.
1899
     */
1900
     int profile;
1901
#define FF_PROFILE_UNKNOWN -99
1902
#define FF_PROFILE_AAC_MAIN 0
1903
#define FF_PROFILE_AAC_LOW  1
1904
#define FF_PROFILE_AAC_SSR  2
1905
#define FF_PROFILE_AAC_LTP  3
1906

    
1907
    /**
1908
     * level
1909
     * - encoding: Set by user.
1910
     * - decoding: Set by libavcodec.
1911
     */
1912
     int level;
1913
#define FF_LEVEL_UNKNOWN -99
1914

    
1915
    /**
1916
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1917
     * - encoding: unused
1918
     * - decoding: Set by user.
1919
     */
1920
     int lowres;
1921

    
1922
    /**
1923
     * Bitstream width / height, may be different from width/height if lowres
1924
     * or other things are used.
1925
     * - encoding: unused
1926
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1927
     */
1928
    int coded_width, coded_height;
1929

    
1930
    /**
1931
     * frame skip threshold
1932
     * - encoding: Set by user.
1933
     * - decoding: unused
1934
     */
1935
    int frame_skip_threshold;
1936

    
1937
    /**
1938
     * frame skip factor
1939
     * - encoding: Set by user.
1940
     * - decoding: unused
1941
     */
1942
    int frame_skip_factor;
1943

    
1944
    /**
1945
     * frame skip exponent
1946
     * - encoding: Set by user.
1947
     * - decoding: unused
1948
     */
1949
    int frame_skip_exp;
1950

    
1951
    /**
1952
     * frame skip comparison function
1953
     * - encoding: Set by user.
1954
     * - decoding: unused
1955
     */
1956
    int frame_skip_cmp;
1957

    
1958
    /**
1959
     * Border processing masking, raises the quantizer for mbs on the borders
1960
     * of the picture.
1961
     * - encoding: Set by user.
1962
     * - decoding: unused
1963
     */
1964
    float border_masking;
1965

    
1966
    /**
1967
     * minimum MB lagrange multipler
1968
     * - encoding: Set by user.
1969
     * - decoding: unused
1970
     */
1971
    int mb_lmin;
1972

    
1973
    /**
1974
     * maximum MB lagrange multipler
1975
     * - encoding: Set by user.
1976
     * - decoding: unused
1977
     */
1978
    int mb_lmax;
1979

    
1980
    /**
1981
     *
1982
     * - encoding: Set by user.
1983
     * - decoding: unused
1984
     */
1985
    int me_penalty_compensation;
1986

    
1987
    /**
1988
     *
1989
     * - encoding: unused
1990
     * - decoding: Set by user.
1991
     */
1992
    enum AVDiscard skip_loop_filter;
1993

    
1994
    /**
1995
     *
1996
     * - encoding: unused
1997
     * - decoding: Set by user.
1998
     */
1999
    enum AVDiscard skip_idct;
2000

    
2001
    /**
2002
     *
2003
     * - encoding: unused
2004
     * - decoding: Set by user.
2005
     */
2006
    enum AVDiscard skip_frame;
2007

    
2008
    /**
2009
     *
2010
     * - encoding: Set by user.
2011
     * - decoding: unused
2012
     */
2013
    int bidir_refine;
2014

    
2015
    /**
2016
     *
2017
     * - encoding: Set by user.
2018
     * - decoding: unused
2019
     */
2020
    int brd_scale;
2021

    
2022
    /**
2023
     * constant rate factor - quality-based VBR - values ~correspond to qps
2024
     * - encoding: Set by user.
2025
     * - decoding: unused
2026
     */
2027
    float crf;
2028

    
2029
    /**
2030
     * constant quantization parameter rate control method
2031
     * - encoding: Set by user.
2032
     * - decoding: unused
2033
     */
2034
    int cqp;
2035

    
2036
    /**
2037
     * minimum GOP size
2038
     * - encoding: Set by user.
2039
     * - decoding: unused
2040
     */
2041
    int keyint_min;
2042

    
2043
    /**
2044
     * number of reference frames
2045
     * - encoding: Set by user.
2046
     * - decoding: unused
2047
     */
2048
    int refs;
2049

    
2050
    /**
2051
     * chroma qp offset from luma
2052
     * - encoding: Set by user.
2053
     * - decoding: unused
2054
     */
2055
    int chromaoffset;
2056

    
2057
    /**
2058
     * Influences how often B-frames are used.
2059
     * - encoding: Set by user.
2060
     * - decoding: unused
2061
     */
2062
    int bframebias;
2063

    
2064
    /**
2065
     * trellis RD quantization
2066
     * - encoding: Set by user.
2067
     * - decoding: unused
2068
     */
2069
    int trellis;
2070

    
2071
    /**
2072
     * Reduce fluctuations in qp (before curve compression).
2073
     * - encoding: Set by user.
2074
     * - decoding: unused
2075
     */
2076
    float complexityblur;
2077

    
2078
    /**
2079
     * in-loop deblocking filter alphac0 parameter
2080
     * alpha is in the range -6...6
2081
     * - encoding: Set by user.
2082
     * - decoding: unused
2083
     */
2084
    int deblockalpha;
2085

    
2086
    /**
2087
     * in-loop deblocking filter beta parameter
2088
     * beta is in the range -6...6
2089
     * - encoding: Set by user.
2090
     * - decoding: unused
2091
     */
2092
    int deblockbeta;
2093

    
2094
    /**
2095
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2096
     * - encoding: Set by user.
2097
     * - decoding: unused
2098
     */
2099
    int partitions;
2100
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2101
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2102
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2103
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2104
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2105

    
2106
    /**
2107
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2108
     * - encoding: Set by user.
2109
     * - decoding: unused
2110
     */
2111
    int directpred;
2112

    
2113
    /**
2114
     * Audio cutoff bandwidth (0 means "automatic")
2115
     * - encoding: Set by user.
2116
     * - decoding: unused
2117
     */
2118
    int cutoff;
2119

    
2120
    /**
2121
     * Multiplied by qscale for each frame and added to scene_change_score.
2122
     * - encoding: Set by user.
2123
     * - decoding: unused
2124
     */
2125
    int scenechange_factor;
2126

    
2127
    /**
2128
     *
2129
     * Note: Value depends upon the compare function used for fullpel ME.
2130
     * - encoding: Set by user.
2131
     * - decoding: unused
2132
     */
2133
    int mv0_threshold;
2134

    
2135
    /**
2136
     * Adjusts sensitivity of b_frame_strategy 1.
2137
     * - encoding: Set by user.
2138
     * - decoding: unused
2139
     */
2140
    int b_sensitivity;
2141

    
2142
    /**
2143
     * - encoding: Set by user.
2144
     * - decoding: unused
2145
     */
2146
    int compression_level;
2147
#define FF_COMPRESSION_DEFAULT -1
2148

    
2149
    /**
2150
     * Sets whether to use LPC mode - used by FLAC encoder.
2151
     * - encoding: Set by user.
2152
     * - decoding: unused
2153
     */
2154
    int use_lpc;
2155

    
2156
    /**
2157
     * LPC coefficient precision - used by FLAC encoder
2158
     * - encoding: Set by user.
2159
     * - decoding: unused
2160
     */
2161
    int lpc_coeff_precision;
2162

    
2163
    /**
2164
     * - encoding: Set by user.
2165
     * - decoding: unused
2166
     */
2167
    int min_prediction_order;
2168

    
2169
    /**
2170
     * - encoding: Set by user.
2171
     * - decoding: unused
2172
     */
2173
    int max_prediction_order;
2174

    
2175
    /**
2176
     * search method for selecting prediction order
2177
     * - encoding: Set by user.
2178
     * - decoding: unused
2179
     */
2180
    int prediction_order_method;
2181

    
2182
    /**
2183
     * - encoding: Set by user.
2184
     * - decoding: unused
2185
     */
2186
    int min_partition_order;
2187

    
2188
    /**
2189
     * - encoding: Set by user.
2190
     * - decoding: unused
2191
     */
2192
    int max_partition_order;
2193

    
2194
    /**
2195
     * GOP timecode frame start number, in non drop frame format
2196
     * - encoding: Set by user.
2197
     * - decoding: unused
2198
     */
2199
    int64_t timecode_frame_start;
2200

    
2201
    /**
2202
     * Decoder should decode to this many channels if it can (0 for default)
2203
     * - encoding: unused
2204
     * - decoding: Set by user.
2205
     */
2206
    int request_channels;
2207

    
2208
    /**
2209
     * Percentage of dynamic range compression to be applied by the decoder.
2210
     * The default value is 1.0, corresponding to full compression.
2211
     * - encoding: unused
2212
     * - decoding: Set by user.
2213
     */
2214
    float drc_scale;
2215

    
2216
    /**
2217
     * opaque 64bit number (generally a PTS) that will be reordered and
2218
     * output in AVFrame.reordered_opaque
2219
     * - encoding: unused
2220
     * - decoding: Set by user.
2221
     */
2222
    int64_t reordered_opaque;
2223

    
2224
    /**
2225
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2226
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2227
     * - encoding: set by user.
2228
     * - decoding: set by libavcodec.
2229
     */
2230
    int bits_per_raw_sample;
2231
} AVCodecContext;
2232

    
2233
/**
2234
 * AVCodec.
2235
 */
2236
typedef struct AVCodec {
2237
    /**
2238
     * Name of the codec implementation.
2239
     * The name is globally unique among encoders and among decoders (but an
2240
     * encoder and a decoder can share the same name).
2241
     * This is the primary way to find a codec from the user perspective.
2242
     */
2243
    const char *name;
2244
    enum CodecType type;
2245
    enum CodecID id;
2246
    int priv_data_size;
2247
    int (*init)(AVCodecContext *);
2248
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2249
    int (*close)(AVCodecContext *);
2250
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2251
                  const uint8_t *buf, int buf_size);
2252
    /**
2253
     * Codec capabilities.
2254
     * see CODEC_CAP_*
2255
     */
2256
    int capabilities;
2257
    struct AVCodec *next;
2258
    /**
2259
     * Flush buffers.
2260
     * Will be called when seeking
2261
     */
2262
    void (*flush)(AVCodecContext *);
2263
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2264
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2265
    /**
2266
     * Descriptive name for the codec, meant to be more human readable than \p name.
2267
     * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2268
     */
2269
    const char *long_name;
2270
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2271
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2272
} AVCodec;
2273

    
2274
/**
2275
 * four components are given, that's all.
2276
 * the last component is alpha
2277
 */
2278
typedef struct AVPicture {
2279
    uint8_t *data[4];
2280
    int linesize[4];       ///< number of bytes per line
2281
} AVPicture;
2282

    
2283
/**
2284
 * AVPaletteControl
2285
 * This structure defines a method for communicating palette changes
2286
 * between and demuxer and a decoder.
2287
 *
2288
 * @deprecated Use AVPacket to send palette changes instead.
2289
 * This is totally broken.
2290
 */
2291
#define AVPALETTE_SIZE 1024
2292
#define AVPALETTE_COUNT 256
2293
typedef struct AVPaletteControl {
2294

    
2295
    /* Demuxer sets this to 1 to indicate the palette has changed;
2296
     * decoder resets to 0. */
2297
    int palette_changed;
2298

    
2299
    /* 4-byte ARGB palette entries, stored in native byte order; note that
2300
     * the individual palette components should be on a 8-bit scale; if
2301
     * the palette data comes from an IBM VGA native format, the component
2302
     * data is probably 6 bits in size and needs to be scaled. */
2303
    unsigned int palette[AVPALETTE_COUNT];
2304

    
2305
} AVPaletteControl attribute_deprecated;
2306

    
2307
typedef struct AVSubtitleRect {
2308
    uint16_t x;
2309
    uint16_t y;
2310
    uint16_t w;
2311
    uint16_t h;
2312
    uint16_t nb_colors;
2313
    int linesize;
2314
    uint32_t *rgba_palette;
2315
    uint8_t *bitmap;
2316
} AVSubtitleRect;
2317

    
2318
typedef struct AVSubtitle {
2319
    uint16_t format; /* 0 = graphics */
2320
    uint32_t start_display_time; /* relative to packet pts, in ms */
2321
    uint32_t end_display_time; /* relative to packet pts, in ms */
2322
    uint32_t num_rects;
2323
    AVSubtitleRect *rects;
2324
} AVSubtitle;
2325

    
2326

    
2327
/* resample.c */
2328

    
2329
struct ReSampleContext;
2330
struct AVResampleContext;
2331

    
2332
typedef struct ReSampleContext ReSampleContext;
2333

    
2334
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2335
                                     int output_rate, int input_rate);
2336
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2337
void audio_resample_close(ReSampleContext *s);
2338

    
2339
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2340
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2341
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2342
void av_resample_close(struct AVResampleContext *c);
2343

    
2344
/**
2345
 * Allocate memory for a picture.  Call avpicture_free to free it.
2346
 *
2347
 * @param picture the picture to be filled in
2348
 * @param pix_fmt the format of the picture
2349
 * @param width the width of the picture
2350
 * @param height the height of the picture
2351
 * @return zero if successful, a negative value if not
2352
 */
2353
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2354

    
2355
/**
2356
 * Free a picture previously allocated by avpicture_alloc().
2357
 *
2358
 * @param picture the AVPicture to be freed
2359
 */
2360
void avpicture_free(AVPicture *picture);
2361

    
2362
/**
2363
 * Fill in the AVPicture fields.
2364
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2365
 * which points to the image data buffer. Depending on the specified picture
2366
 * format, one or multiple image data pointers and line sizes will be set.
2367
 * If a planar format is specified, several pointers will be set pointing to
2368
 * the different picture planes and the line sizes of the different planes
2369
 * will be stored in the lines_sizes array.
2370
 *
2371
 * @param picture AVPicture whose fields are to be filled in
2372
 * @param ptr Buffer which will contain or contains the actual image data
2373
 * @param pix_fmt The format in which the picture data is stored.
2374
 * @param width the width of the image in pixels
2375
 * @param height the height of the image in pixels
2376
 * @return size of the image data in bytes
2377
 */
2378
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2379
                   int pix_fmt, int width, int height);
2380
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2381
                     unsigned char *dest, int dest_size);
2382

    
2383
/**
2384
 * Calculate the size in bytes that a picture of the given width and height
2385
 * would occupy if stored in the given picture format.
2386
 *
2387
 * @param pix_fmt the given picture format
2388
 * @param width the width of the image
2389
 * @param height the height of the image
2390
 * @return Image data size in bytes
2391
 */
2392
int avpicture_get_size(int pix_fmt, int width, int height);
2393
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2394
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2395
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2396
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2397
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2398

    
2399
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2400
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2401
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2402
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2403
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2404
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2405

    
2406
/**
2407
 * Computes what kind of losses will occur when converting from one specific
2408
 * pixel format to another.
2409
 * When converting from one pixel format to another, information loss may occur.
2410
 * For example, when converting from RGB24 to GRAY, the color information will
2411
 * be lost. Similarly, other losses occur when converting from some formats to
2412
 * other formats. These losses can involve loss of chroma, but also loss of
2413
 * resolution, loss of color depth, loss due to the color space conversion, loss
2414
 * of the alpha bits or loss due to color quantization.
2415
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2416
 * which will occur when converting from one pixel format to another.
2417
 *
2418
 * @param[in] dst_pix_fmt destination pixel format
2419
 * @param[in] src_pix_fmt source pixel format
2420
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2421
 * @return Combination of flags informing you what kind of losses will occur.
2422
 */
2423
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2424
                             int has_alpha);
2425

    
2426
/**
2427
 * Finds the best pixel format to convert to given a certain source pixel
2428
 * format.  When converting from one pixel format to another, information loss
2429
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2430
 * information will be lost. Similarly, other losses occur when converting from
2431
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2432
 * the given pixel formats should be used to suffer the least amount of loss.
2433
 * The pixel formats from which it chooses one, are determined by the
2434
 * \p pix_fmt_mask parameter.
2435
 *
2436
 * @code
2437
 * src_pix_fmt = PIX_FMT_YUV420P;
2438
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2439
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2440
 * @endcode
2441
 *
2442
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2443
 * @param[in] src_pix_fmt source pixel format
2444
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2445
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2446
 * @return The best pixel format to convert to or -1 if none was found.
2447
 */
2448
int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2449
                              int has_alpha, int *loss_ptr);
2450

    
2451

    
2452
/**
2453
 * Print in buf the string corresponding to the pixel format with
2454
 * number pix_fmt, or an header if pix_fmt is negative.
2455
 *
2456
 * @param[in] buf the buffer where to write the string
2457
 * @param[in] buf_size the size of buf
2458
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2459
 * a negative value to print the corresponding header.
2460
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2461
 */
2462
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2463

    
2464
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2465
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2466

    
2467
/**
2468
 * Tell if an image really has transparent alpha values.
2469
 * @return ored mask of FF_ALPHA_xxx constants
2470
 */
2471
int img_get_alpha_info(const AVPicture *src,
2472
                       int pix_fmt, int width, int height);
2473

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

    
2479
/* external high level API */
2480

    
2481
AVCodec *av_codec_next(AVCodec *c);
2482

    
2483
/**
2484
 * Returns the LIBAVCODEC_VERSION_INT constant.
2485
 */
2486
unsigned avcodec_version(void);
2487

    
2488
/**
2489
 * Initializes libavcodec.
2490
 *
2491
 * @warning This function \e must be called before any other libavcodec
2492
 * function.
2493
 */
2494
void avcodec_init(void);
2495

    
2496
void register_avcodec(AVCodec *format);
2497

    
2498
/**
2499
 * Finds a registered encoder with a matching codec ID.
2500
 *
2501
 * @param id CodecID of the requested encoder
2502
 * @return An encoder if one was found, NULL otherwise.
2503
 */
2504
AVCodec *avcodec_find_encoder(enum CodecID id);
2505

    
2506
/**
2507
 * Finds a registered encoder with the specified name.
2508
 *
2509
 * @param name name of the requested encoder
2510
 * @return An encoder if one was found, NULL otherwise.
2511
 */
2512
AVCodec *avcodec_find_encoder_by_name(const char *name);
2513

    
2514
/**
2515
 * Finds a registered decoder with a matching codec ID.
2516
 *
2517
 * @param id CodecID of the requested decoder
2518
 * @return A decoder if one was found, NULL otherwise.
2519
 */
2520
AVCodec *avcodec_find_decoder(enum CodecID id);
2521

    
2522
/**
2523
 * Finds a registered decoder with the specified name.
2524
 *
2525
 * @param name name of the requested decoder
2526
 * @return A decoder if one was found, NULL otherwise.
2527
 */
2528
AVCodec *avcodec_find_decoder_by_name(const char *name);
2529
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2530

    
2531
/**
2532
 * Sets the fields of the given AVCodecContext to default values.
2533
 *
2534
 * @param s The AVCodecContext of which the fields should be set to default values.
2535
 */
2536
void avcodec_get_context_defaults(AVCodecContext *s);
2537

    
2538
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2539
 *  we WILL change its arguments and name a few times! */
2540
void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2541

    
2542
/**
2543
 * Allocates an AVCodecContext and sets its fields to default values.  The
2544
 * resulting struct can be deallocated by simply calling av_free().
2545
 *
2546
 * @return An AVCodecContext filled with default values or NULL on failure.
2547
 * @see avcodec_get_context_defaults
2548
 */
2549
AVCodecContext *avcodec_alloc_context(void);
2550

    
2551
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2552
 *  we WILL change its arguments and name a few times! */
2553
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2554

    
2555
/**
2556
 * Sets the fields of the given AVFrame to default values.
2557
 *
2558
 * @param pic The AVFrame of which the fields should be set to default values.
2559
 */
2560
void avcodec_get_frame_defaults(AVFrame *pic);
2561

    
2562
/**
2563
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2564
 * struct can be deallocated by simply calling av_free().
2565
 *
2566
 * @return An AVFrame filled with default values or NULL on failure.
2567
 * @see avcodec_get_frame_defaults
2568
 */
2569
AVFrame *avcodec_alloc_frame(void);
2570

    
2571
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2572
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2573
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2574
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2575

    
2576
/**
2577
 * Checks if the given dimension of a picture is valid, meaning that all
2578
 * bytes of the picture can be addressed with a signed int.
2579
 *
2580
 * @param[in] w Width of the picture.
2581
 * @param[in] h Height of the picture.
2582
 * @return Zero if valid, a negative value if invalid.
2583
 */
2584
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2585
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2586

    
2587
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2588
void avcodec_thread_free(AVCodecContext *s);
2589
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2590
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2591
//FIXME func typedef
2592

    
2593
/**
2594
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2595
 * function the context has to be allocated.
2596
 *
2597
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2598
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2599
 * retrieving a codec.
2600
 *
2601
 * @warning This function is not thread safe!
2602
 *
2603
 * @code
2604
 * avcodec_register_all();
2605
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2606
 * if (!codec)
2607
 *     exit(1);
2608
 *
2609
 * context = avcodec_alloc_context();
2610
 *
2611
 * if (avcodec_open(context, codec) < 0)
2612
 *     exit(1);
2613
 * @endcode
2614
 *
2615
 * @param avctx The context which will be set up to use the given codec.
2616
 * @param codec The codec to use within the context.
2617
 * @return zero on success, a negative value on error
2618
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2619
 */
2620
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2621

    
2622
/**
2623
 * Decodes an audio frame from \p buf into \p samples.
2624
 * The avcodec_decode_audio2() function decodes an audio frame from the input
2625
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2626
 * audio codec which was coupled with \p avctx using avcodec_open(). The
2627
 * resulting decoded frame is stored in output buffer \p samples.  If no frame
2628
 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2629
 * decompressed frame size in \e bytes.
2630
 *
2631
 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2632
 * output buffer before calling avcodec_decode_audio2().
2633
 *
2634
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2635
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2636
 * bits at once and could read over the end.
2637
 *
2638
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2639
 * no overreading happens for damaged MPEG streams.
2640
 *
2641
 * @note You might have to align the input buffer \p buf and output buffer \p
2642
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2643
 * necessary at all, on others it won't work at all if not aligned and on others
2644
 * it will work but it will have an impact on performance. In practice, the
2645
 * bitstream should have 4 byte alignment at minimum and all sample data should
2646
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2647
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2648
 * start of the buffer to 16.
2649
 *
2650
 * @param avctx the codec context
2651
 * @param[out] samples the output buffer
2652
 * @param[in,out] frame_size_ptr the output buffer size in bytes
2653
 * @param[in] buf the input buffer
2654
 * @param[in] buf_size the input buffer size in bytes
2655
 * @return On error a negative value is returned, otherwise the number of bytes
2656
 * used or zero if no frame could be decompressed.
2657
 */
2658
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2659
                         int *frame_size_ptr,
2660
                         const uint8_t *buf, int buf_size);
2661

    
2662
/**
2663
 * Decodes a video frame from \p buf into \p picture.
2664
 * The avcodec_decode_video() function decodes a video frame from the input
2665
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2666
 * video codec which was coupled with \p avctx using avcodec_open(). The
2667
 * resulting decoded frame is stored in \p picture.
2668
 *
2669
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2670
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2671
 * bits at once and could read over the end.
2672
 *
2673
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2674
 * no overreading happens for damaged MPEG streams.
2675
 *
2676
 * @note You might have to align the input buffer \p buf and output buffer \p
2677
 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2678
 * necessary at all, on others it won't work at all if not aligned and on others
2679
 * it will work but it will have an impact on performance. In practice, the
2680
 * bitstream should have 4 byte alignment at minimum and all sample data should
2681
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2682
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2683
 * start of the buffer to 16.
2684
 *
2685
 * @param avctx the codec context
2686
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2687
 * @param[in] buf the input buffer
2688
 * @param[in] buf_size the size of the input buffer in bytes
2689
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2690
 * @return On error a negative value is returned, otherwise the number of bytes
2691
 * used or zero if no frame could be decompressed.
2692
 */
2693
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2694
                         int *got_picture_ptr,
2695
                         const uint8_t *buf, int buf_size);
2696

    
2697
/* Decode a subtitle message. Return -1 if error, otherwise return the
2698
 * number of bytes used. If no subtitle could be decompressed,
2699
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2700
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2701
                            int *got_sub_ptr,
2702
                            const uint8_t *buf, int buf_size);
2703
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2704
                        int *data_size_ptr,
2705
                        uint8_t *buf, int buf_size);
2706

    
2707
/**
2708
 * Encodes an audio frame from \p samples into \p buf.
2709
 * The avcodec_encode_audio() function encodes an audio frame from the input
2710
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2711
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2712
 * stored in output buffer \p buf.
2713
 *
2714
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2715
 *
2716
 * @param avctx the codec context
2717
 * @param[out] buf the output buffer
2718
 * @param[in] buf_size the output buffer size
2719
 * @param[in] samples the input buffer containing the samples
2720
 * The number of samples read from this buffer is frame_size*channels,
2721
 * both of which are defined in \p avctx.
2722
 * For PCM audio the number of samples read from \p samples is equal to
2723
 * \p buf_size * input_sample_size / output_sample_size.
2724
 * @return On error a negative value is returned, on success zero or the number
2725
 * of bytes used to encode the data read from the input buffer.
2726
 */
2727
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2728
                         const short *samples);
2729

    
2730
/**
2731
 * Encodes a video frame from \p pict into \p buf.
2732
 * The avcodec_encode_video() function encodes a video frame from the input
2733
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2734
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2735
 * frame are stored in the output buffer \p buf. The input picture should be
2736
 * stored using a specific format, namely \c avctx.pix_fmt.
2737
 *
2738
 * @param avctx the codec context
2739
 * @param[out] buf the output buffer for the bitstream of encoded frame
2740
 * @param[in] buf_size the size of the output buffer in bytes
2741
 * @param[in] pict the input picture to encode
2742
 * @return On error a negative value is returned, on success zero or the number
2743
 * of bytes used from the input buffer.
2744
 */
2745
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2746
                         const AVFrame *pict);
2747
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2748
                            const AVSubtitle *sub);
2749

    
2750
int avcodec_close(AVCodecContext *avctx);
2751

    
2752
void avcodec_register_all(void);
2753

    
2754
/**
2755
 * Flush buffers, should be called when seeking or when switching to a different stream.
2756
 */
2757
void avcodec_flush_buffers(AVCodecContext *avctx);
2758

    
2759
void avcodec_default_free_buffers(AVCodecContext *s);
2760

    
2761
/* misc useful functions */
2762

    
2763
/**
2764
 * Returns a single letter to describe the given picture type \p pict_type.
2765
 *
2766
 * @param[in] pict_type the picture type
2767
 * @return A single character representing the picture type.
2768
 */
2769
char av_get_pict_type_char(int pict_type);
2770

    
2771
/**
2772
 * Returns codec bits per sample.
2773
 *
2774
 * @param[in] codec_id the codec
2775
 * @return Number of bits per sample or zero if unknown for the given codec.
2776
 */
2777
int av_get_bits_per_sample(enum CodecID codec_id);
2778

    
2779
/**
2780
 * Returns sample format bits per sample.
2781
 *
2782
 * @param[in] sample_fmt the sample format
2783
 * @return Number of bits per sample or zero if unknown for the given sample format.
2784
 */
2785
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2786

    
2787
/* frame parsing */
2788
typedef struct AVCodecParserContext {
2789
    void *priv_data;
2790
    struct AVCodecParser *parser;
2791
    int64_t frame_offset; /* offset of the current frame */
2792
    int64_t cur_offset; /* current offset
2793
                           (incremented by each av_parser_parse()) */
2794
    int64_t next_frame_offset; /* offset of the next frame */
2795
    /* video info */
2796
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2797
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2798
    int64_t pts;     /* pts of the current frame */
2799
    int64_t dts;     /* dts of the current frame */
2800

    
2801
    /* private data */
2802
    int64_t last_pts;
2803
    int64_t last_dts;
2804
    int fetch_timestamp;
2805

    
2806
#define AV_PARSER_PTS_NB 4
2807
    int cur_frame_start_index;
2808
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2809
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2810
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2811

    
2812
    int flags;
2813
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2814

    
2815
    int64_t offset;      ///< byte offset from starting packet start
2816
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
2817
} AVCodecParserContext;
2818

    
2819
typedef struct AVCodecParser {
2820
    int codec_ids[5]; /* several codec IDs are permitted */
2821
    int priv_data_size;
2822
    int (*parser_init)(AVCodecParserContext *s);
2823
    int (*parser_parse)(AVCodecParserContext *s,
2824
                        AVCodecContext *avctx,
2825
                        const uint8_t **poutbuf, int *poutbuf_size,
2826
                        const uint8_t *buf, int buf_size);
2827
    void (*parser_close)(AVCodecParserContext *s);
2828
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2829
    struct AVCodecParser *next;
2830
} AVCodecParser;
2831

    
2832
AVCodecParser *av_parser_next(AVCodecParser *c);
2833

    
2834
void av_register_codec_parser(AVCodecParser *parser);
2835
AVCodecParserContext *av_parser_init(int codec_id);
2836
int av_parser_parse(AVCodecParserContext *s,
2837
                    AVCodecContext *avctx,
2838
                    uint8_t **poutbuf, int *poutbuf_size,
2839
                    const uint8_t *buf, int buf_size,
2840
                    int64_t pts, int64_t dts);
2841
int av_parser_change(AVCodecParserContext *s,
2842
                     AVCodecContext *avctx,
2843
                     uint8_t **poutbuf, int *poutbuf_size,
2844
                     const uint8_t *buf, int buf_size, int keyframe);
2845
void av_parser_close(AVCodecParserContext *s);
2846

    
2847

    
2848
typedef struct AVBitStreamFilterContext {
2849
    void *priv_data;
2850
    struct AVBitStreamFilter *filter;
2851
    AVCodecParserContext *parser;
2852
    struct AVBitStreamFilterContext *next;
2853
} AVBitStreamFilterContext;
2854

    
2855

    
2856
typedef struct AVBitStreamFilter {
2857
    const char *name;
2858
    int priv_data_size;
2859
    int (*filter)(AVBitStreamFilterContext *bsfc,
2860
                  AVCodecContext *avctx, const char *args,
2861
                  uint8_t **poutbuf, int *poutbuf_size,
2862
                  const uint8_t *buf, int buf_size, int keyframe);
2863
    void (*close)(AVBitStreamFilterContext *bsfc);
2864
    struct AVBitStreamFilter *next;
2865
} AVBitStreamFilter;
2866

    
2867
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2868
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2869
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2870
                               AVCodecContext *avctx, const char *args,
2871
                               uint8_t **poutbuf, int *poutbuf_size,
2872
                               const uint8_t *buf, int buf_size, int keyframe);
2873
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2874

    
2875
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2876

    
2877
/* memory */
2878

    
2879
/**
2880
 * Reallocates the given block if it is not large enough, otherwise it
2881
 * does nothing.
2882
 *
2883
 * @see av_realloc
2884
 */
2885
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2886

    
2887
/**
2888
 * Copy image 'src' to 'dst'.
2889
 */
2890
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2891
              int pix_fmt, int width, int height);
2892

    
2893
/**
2894
 * Crop image top and left side.
2895
 */
2896
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2897
             int pix_fmt, int top_band, int left_band);
2898

    
2899
/**
2900
 * Pad image.
2901
 */
2902
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2903
            int padtop, int padbottom, int padleft, int padright, int *color);
2904

    
2905
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2906

    
2907
/**
2908
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2909
 *
2910
 * @return 0 in case of a successful parsing, a negative value otherwise
2911
 * @param[in] str the string to parse: it has to be a string in the format
2912
 * <width>x<height> or a valid video frame size abbreviation.
2913
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2914
 * frame width value
2915
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2916
 * frame height value
2917
 */
2918
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2919

    
2920
/**
2921
 * Parses \p str and put in \p frame_rate the detected values.
2922
 *
2923
 * @return 0 in case of a successful parsing, a negative value otherwise
2924
 * @param[in] str the string to parse: it has to be a string in the format
2925
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2926
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2927
 * frame rate
2928
 */
2929
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2930

    
2931
/**
2932
 * Logs a generic warning message about a missing feature.
2933
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
2934
 * a pointer to an AVClass struct
2935
 * @param[in] feature string containing the name of the missing feature
2936
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
2937
 * If \p want_sample is non-zero, additional verbage will be added to the log
2938
 * message which tells the user how to report samples to the development
2939
 * mailing list.
2940
 */
2941
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
2942

    
2943
/* error handling */
2944
#if EINVAL > 0
2945
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2946
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2947
#else
2948
/* Some platforms have E* and errno already negated. */
2949
#define AVERROR(e) (e)
2950
#define AVUNERROR(e) (e)
2951
#endif
2952
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
2953
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
2954
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2955
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
2956
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
2957
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
2958
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
2959
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
2960
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2961

    
2962
#endif /* AVCODEC_AVCODEC_H */