Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 8bfb108b

History | View | Annotate | Download (91.7 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 FFMPEG_AVCODEC_H
22
#define FFMPEG_AVCODEC_H
23

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

    
29

    
30
#include "avutil.h"
31
#include <sys/types.h> /* size_t */
32

    
33
#define AV_STRINGIFY(s)         AV_TOSTRING(s)
34
#define AV_TOSTRING(s) #s
35

    
36
#define LIBAVCODEC_VERSION_INT  ((51<<16)+(49<<8)+0)
37
#define LIBAVCODEC_VERSION      51.49.0
38
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
39

    
40
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
41

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

    
46
/**
47
 * Identifies the syntax and semantics of the bitstream.
48
 * The principle is roughly:
49
 * Two decoders with the same ID can decode the same streams.
50
 * Two encoders with the same ID can encode compatible streams.
51
 * There may be slight deviations from the principle due to implementation
52
 * details.
53
 *
54
 * If you add a codec ID to this list, add it so that
55
 * 1. no value of a existing codec ID changes (that would break ABI),
56
 * 2. it is as close as possible to similar codecs.
57
 */
58
enum CodecID {
59
    CODEC_ID_NONE,
60
    CODEC_ID_MPEG1VIDEO,
61
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
62
    CODEC_ID_MPEG2VIDEO_XVMC,
63
    CODEC_ID_H261,
64
    CODEC_ID_H263,
65
    CODEC_ID_RV10,
66
    CODEC_ID_RV20,
67
    CODEC_ID_MJPEG,
68
    CODEC_ID_MJPEGB,
69
    CODEC_ID_LJPEG,
70
    CODEC_ID_SP5X,
71
    CODEC_ID_JPEGLS,
72
    CODEC_ID_MPEG4,
73
    CODEC_ID_RAWVIDEO,
74
    CODEC_ID_MSMPEG4V1,
75
    CODEC_ID_MSMPEG4V2,
76
    CODEC_ID_MSMPEG4V3,
77
    CODEC_ID_WMV1,
78
    CODEC_ID_WMV2,
79
    CODEC_ID_H263P,
80
    CODEC_ID_H263I,
81
    CODEC_ID_FLV1,
82
    CODEC_ID_SVQ1,
83
    CODEC_ID_SVQ3,
84
    CODEC_ID_DVVIDEO,
85
    CODEC_ID_HUFFYUV,
86
    CODEC_ID_CYUV,
87
    CODEC_ID_H264,
88
    CODEC_ID_INDEO3,
89
    CODEC_ID_VP3,
90
    CODEC_ID_THEORA,
91
    CODEC_ID_ASV1,
92
    CODEC_ID_ASV2,
93
    CODEC_ID_FFV1,
94
    CODEC_ID_4XM,
95
    CODEC_ID_VCR1,
96
    CODEC_ID_CLJR,
97
    CODEC_ID_MDEC,
98
    CODEC_ID_ROQ,
99
    CODEC_ID_INTERPLAY_VIDEO,
100
    CODEC_ID_XAN_WC3,
101
    CODEC_ID_XAN_WC4,
102
    CODEC_ID_RPZA,
103
    CODEC_ID_CINEPAK,
104
    CODEC_ID_WS_VQA,
105
    CODEC_ID_MSRLE,
106
    CODEC_ID_MSVIDEO1,
107
    CODEC_ID_IDCIN,
108
    CODEC_ID_8BPS,
109
    CODEC_ID_SMC,
110
    CODEC_ID_FLIC,
111
    CODEC_ID_TRUEMOTION1,
112
    CODEC_ID_VMDVIDEO,
113
    CODEC_ID_MSZH,
114
    CODEC_ID_ZLIB,
115
    CODEC_ID_QTRLE,
116
    CODEC_ID_SNOW,
117
    CODEC_ID_TSCC,
118
    CODEC_ID_ULTI,
119
    CODEC_ID_QDRAW,
120
    CODEC_ID_VIXL,
121
    CODEC_ID_QPEG,
122
    CODEC_ID_XVID,
123
    CODEC_ID_PNG,
124
    CODEC_ID_PPM,
125
    CODEC_ID_PBM,
126
    CODEC_ID_PGM,
127
    CODEC_ID_PGMYUV,
128
    CODEC_ID_PAM,
129
    CODEC_ID_FFVHUFF,
130
    CODEC_ID_RV30,
131
    CODEC_ID_RV40,
132
    CODEC_ID_VC1,
133
    CODEC_ID_WMV3,
134
    CODEC_ID_LOCO,
135
    CODEC_ID_WNV1,
136
    CODEC_ID_AASC,
137
    CODEC_ID_INDEO2,
138
    CODEC_ID_FRAPS,
139
    CODEC_ID_TRUEMOTION2,
140
    CODEC_ID_BMP,
141
    CODEC_ID_CSCD,
142
    CODEC_ID_MMVIDEO,
143
    CODEC_ID_ZMBV,
144
    CODEC_ID_AVS,
145
    CODEC_ID_SMACKVIDEO,
146
    CODEC_ID_NUV,
147
    CODEC_ID_KMVC,
148
    CODEC_ID_FLASHSV,
149
    CODEC_ID_CAVS,
150
    CODEC_ID_JPEG2000,
151
    CODEC_ID_VMNC,
152
    CODEC_ID_VP5,
153
    CODEC_ID_VP6,
154
    CODEC_ID_VP6F,
155
    CODEC_ID_TARGA,
156
    CODEC_ID_DSICINVIDEO,
157
    CODEC_ID_TIERTEXSEQVIDEO,
158
    CODEC_ID_TIFF,
159
    CODEC_ID_GIF,
160
    CODEC_ID_FFH264,
161
    CODEC_ID_DXA,
162
    CODEC_ID_DNXHD,
163
    CODEC_ID_THP,
164
    CODEC_ID_SGI,
165
    CODEC_ID_C93,
166
    CODEC_ID_BETHSOFTVID,
167
    CODEC_ID_PTX,
168
    CODEC_ID_TXD,
169
    CODEC_ID_VP6A,
170
    CODEC_ID_AMV,
171
    CODEC_ID_VB,
172

    
173
    /* various PCM "codecs" */
174
    CODEC_ID_PCM_S16LE= 0x10000,
175
    CODEC_ID_PCM_S16BE,
176
    CODEC_ID_PCM_U16LE,
177
    CODEC_ID_PCM_U16BE,
178
    CODEC_ID_PCM_S8,
179
    CODEC_ID_PCM_U8,
180
    CODEC_ID_PCM_MULAW,
181
    CODEC_ID_PCM_ALAW,
182
    CODEC_ID_PCM_S32LE,
183
    CODEC_ID_PCM_S32BE,
184
    CODEC_ID_PCM_U32LE,
185
    CODEC_ID_PCM_U32BE,
186
    CODEC_ID_PCM_S24LE,
187
    CODEC_ID_PCM_S24BE,
188
    CODEC_ID_PCM_U24LE,
189
    CODEC_ID_PCM_U24BE,
190
    CODEC_ID_PCM_S24DAUD,
191
    CODEC_ID_PCM_ZORK,
192
    CODEC_ID_PCM_S16LE_PLANAR,
193

    
194
    /* various ADPCM codecs */
195
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
196
    CODEC_ID_ADPCM_IMA_WAV,
197
    CODEC_ID_ADPCM_IMA_DK3,
198
    CODEC_ID_ADPCM_IMA_DK4,
199
    CODEC_ID_ADPCM_IMA_WS,
200
    CODEC_ID_ADPCM_IMA_SMJPEG,
201
    CODEC_ID_ADPCM_MS,
202
    CODEC_ID_ADPCM_4XM,
203
    CODEC_ID_ADPCM_XA,
204
    CODEC_ID_ADPCM_ADX,
205
    CODEC_ID_ADPCM_EA,
206
    CODEC_ID_ADPCM_G726,
207
    CODEC_ID_ADPCM_CT,
208
    CODEC_ID_ADPCM_SWF,
209
    CODEC_ID_ADPCM_YAMAHA,
210
    CODEC_ID_ADPCM_SBPRO_4,
211
    CODEC_ID_ADPCM_SBPRO_3,
212
    CODEC_ID_ADPCM_SBPRO_2,
213
    CODEC_ID_ADPCM_THP,
214
    CODEC_ID_ADPCM_IMA_AMV,
215
    CODEC_ID_ADPCM_EA_R1,
216
    CODEC_ID_ADPCM_EA_R3,
217
    CODEC_ID_ADPCM_EA_R2,
218
    CODEC_ID_ADPCM_IMA_EA_SEAD,
219
    CODEC_ID_ADPCM_IMA_EA_EACS,
220
    CODEC_ID_ADPCM_EA_XAS,
221

    
222
    /* AMR */
223
    CODEC_ID_AMR_NB= 0x12000,
224
    CODEC_ID_AMR_WB,
225

    
226
    /* RealAudio codecs*/
227
    CODEC_ID_RA_144= 0x13000,
228
    CODEC_ID_RA_288,
229

    
230
    /* various DPCM codecs */
231
    CODEC_ID_ROQ_DPCM= 0x14000,
232
    CODEC_ID_INTERPLAY_DPCM,
233
    CODEC_ID_XAN_DPCM,
234
    CODEC_ID_SOL_DPCM,
235

    
236
    CODEC_ID_MP2= 0x15000,
237
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
238
    CODEC_ID_AAC,
239
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
240
    CODEC_ID_MPEG4AAC,
241
#endif
242
    CODEC_ID_AC3,
243
    CODEC_ID_DTS,
244
    CODEC_ID_VORBIS,
245
    CODEC_ID_DVAUDIO,
246
    CODEC_ID_WMAV1,
247
    CODEC_ID_WMAV2,
248
    CODEC_ID_MACE3,
249
    CODEC_ID_MACE6,
250
    CODEC_ID_VMDAUDIO,
251
    CODEC_ID_SONIC,
252
    CODEC_ID_SONIC_LS,
253
    CODEC_ID_FLAC,
254
    CODEC_ID_MP3ADU,
255
    CODEC_ID_MP3ON4,
256
    CODEC_ID_SHORTEN,
257
    CODEC_ID_ALAC,
258
    CODEC_ID_WESTWOOD_SND1,
259
    CODEC_ID_GSM, ///< as in Berlin toast format
260
    CODEC_ID_QDM2,
261
    CODEC_ID_COOK,
262
    CODEC_ID_TRUESPEECH,
263
    CODEC_ID_TTA,
264
    CODEC_ID_SMACKAUDIO,
265
    CODEC_ID_QCELP,
266
    CODEC_ID_WAVPACK,
267
    CODEC_ID_DSICINAUDIO,
268
    CODEC_ID_IMC,
269
    CODEC_ID_MUSEPACK7,
270
    CODEC_ID_MLP,
271
    CODEC_ID_GSM_MS, /* as found in WAV */
272
    CODEC_ID_ATRAC3,
273
    CODEC_ID_VOXWARE,
274
    CODEC_ID_APE,
275
    CODEC_ID_NELLYMOSER,
276
    CODEC_ID_MUSEPACK8,
277

    
278
    /* subtitle codecs */
279
    CODEC_ID_DVD_SUBTITLE= 0x17000,
280
    CODEC_ID_DVB_SUBTITLE,
281
    CODEC_ID_TEXT,  ///< raw UTF-8 text
282
    CODEC_ID_XSUB,
283

    
284
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
285
                                * stream (only used by libavformat) */
286
};
287

    
288
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
289
/* CODEC_ID_MP3LAME is obsolete */
290
#define CODEC_ID_MP3LAME CODEC_ID_MP3
291
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
292
#endif
293

    
294
enum CodecType {
295
    CODEC_TYPE_UNKNOWN = -1,
296
    CODEC_TYPE_VIDEO,
297
    CODEC_TYPE_AUDIO,
298
    CODEC_TYPE_DATA,
299
    CODEC_TYPE_SUBTITLE,
300
    CODEC_TYPE_NB
301
};
302

    
303
/**
304
 * Currently unused, may be used if 24/32 bits samples are ever supported.
305
 * all in native-endian format
306
 */
307
enum SampleFormat {
308
    SAMPLE_FMT_NONE = -1,
309
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
310
    SAMPLE_FMT_S16,             ///< signed 16 bits
311
    SAMPLE_FMT_S24,             ///< signed 24 bits
312
    SAMPLE_FMT_S32,             ///< signed 32 bits
313
    SAMPLE_FMT_FLT,             ///< float
314
};
315

    
316
/* in bytes */
317
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
318

    
319
/**
320
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
321
 * This is mainly needed because some optimized bitstream readers read
322
 * 32 or 64 bit at once and could read over the end.<br>
323
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
324
 * MPEG bitstreams could cause overread and segfault.
325
 */
326
#define FF_INPUT_BUFFER_PADDING_SIZE 8
327

    
328
/**
329
 * minimum encoding buffer size
330
 * Used to avoid some checks during header writing.
331
 */
332
#define FF_MIN_BUFFER_SIZE 16384
333

    
334
/**
335
 * motion estimation type.
336
 */
337
enum Motion_Est_ID {
338
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
339
    ME_FULL,
340
    ME_LOG,
341
    ME_PHODS,
342
    ME_EPZS,        ///< enhanced predictive zonal search
343
    ME_X1,          ///< reserved for experiments
344
    ME_HEX,         ///< hexagon based search
345
    ME_UMH,         ///< uneven multi-hexagon search
346
    ME_ITER,        ///< iterative search
347
};
348

    
349
enum AVDiscard{
350
    /* We leave some space between them for extensions (drop some
351
     * keyframes for intra-only or drop just some bidir frames). */
352
    AVDISCARD_NONE   =-16, ///< discard nothing
353
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
354
    AVDISCARD_NONREF =  8, ///< discard all non reference
355
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
356
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
357
    AVDISCARD_ALL    = 48, ///< discard all
358
};
359

    
360
typedef struct RcOverride{
361
    int start_frame;
362
    int end_frame;
363
    int qscale; // If this is 0 then quality_factor will be used instead.
364
    float quality_factor;
365
} RcOverride;
366

    
367
#define FF_MAX_B_FRAMES 16
368

    
369
/* encoding support
370
   These flags can be passed in AVCodecContext.flags before initialization.
371
   Note: Not everything is supported yet.
372
*/
373

    
374
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
375
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
376
#define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
377
#define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
378
#define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
379
#define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
380
/**
381
 * The parent program guarantees that the input for B-frames containing
382
 * streams is not written to for at least s->max_b_frames+1 frames, if
383
 * this is not set the input will be copied.
384
 */
385
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
386
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
387
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
388
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
389
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
390
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
391
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
392
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
393
                                                  location instead of only at frame boundaries. */
394
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
395
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
396
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
397
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
398
#define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
399
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
400
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
401
/* Fx : Flag for h263+ extra options */
402
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
403
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
404
#endif
405
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
406
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
407
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
408
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
409
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
410
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
411
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
412
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
413
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
414
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
415
#define CODEC_FLAG_CLOSED_GOP     ((int)0x80000000)
416
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
417
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
418
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
419
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
420
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
421
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
422
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
423
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
424
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
425
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
426
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
427
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
428
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
429
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
430
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
431
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
432
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
433

    
434
/* Unsupported options :
435
 *              Syntax Arithmetic coding (SAC)
436
 *              Reference Picture Selection
437
 *              Independent Segment Decoding */
438
/* /Fx */
439
/* codec capabilities */
440

    
441
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
442
/**
443
 * Codec uses get_buffer() for allocating buffers.
444
 * direct rendering method 1
445
 */
446
#define CODEC_CAP_DR1             0x0002
447
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
448
#define CODEC_CAP_PARSE_ONLY      0x0004
449
#define CODEC_CAP_TRUNCATED       0x0008
450
/* Codec can export data for HW decoding (XvMC). */
451
#define CODEC_CAP_HWACCEL         0x0010
452
/**
453
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
454
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
455
 */
456
#define CODEC_CAP_DELAY           0x0020
457
/**
458
 * Codec can be fed a final frame with a smaller size.
459
 * This can be used to prevent truncation of the last audio samples.
460
 */
461
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
462

    
463
//The following defines may change, don't expect compatibility if you use them.
464
#define MB_TYPE_INTRA4x4   0x0001
465
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
466
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
467
#define MB_TYPE_16x16      0x0008
468
#define MB_TYPE_16x8       0x0010
469
#define MB_TYPE_8x16       0x0020
470
#define MB_TYPE_8x8        0x0040
471
#define MB_TYPE_INTERLACED 0x0080
472
#define MB_TYPE_DIRECT2    0x0100 //FIXME
473
#define MB_TYPE_ACPRED     0x0200
474
#define MB_TYPE_GMC        0x0400
475
#define MB_TYPE_SKIP       0x0800
476
#define MB_TYPE_P0L0       0x1000
477
#define MB_TYPE_P1L0       0x2000
478
#define MB_TYPE_P0L1       0x4000
479
#define MB_TYPE_P1L1       0x8000
480
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
481
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
482
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
483
#define MB_TYPE_QUANT      0x00010000
484
#define MB_TYPE_CBP        0x00020000
485
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
486

    
487
/**
488
 * Pan Scan area.
489
 * This specifies the area which should be displayed.
490
 * Note there may be multiple such areas for one frame.
491
 */
492
typedef struct AVPanScan{
493
    /**
494
     * id
495
     * - encoding: Set by user.
496
     * - decoding: Set by libavcodec.
497
     */
498
    int id;
499

    
500
    /**
501
     * width and height in 1/16 pel
502
     * - encoding: Set by user.
503
     * - decoding: Set by libavcodec.
504
     */
505
    int width;
506
    int height;
507

    
508
    /**
509
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
510
     * - encoding: Set by user.
511
     * - decoding: Set by libavcodec.
512
     */
513
    int16_t position[3][2];
514
}AVPanScan;
515

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

    
724
#define FF_QSCALE_TYPE_MPEG1 0
725
#define FF_QSCALE_TYPE_MPEG2 1
726
#define FF_QSCALE_TYPE_H264  2
727

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

    
733

    
734
#define FF_I_TYPE  1 // Intra
735
#define FF_P_TYPE  2 // Predicted
736
#define FF_B_TYPE  3 // Bi-dir predicted
737
#define FF_S_TYPE  4 // S(GMC)-VOP MPEG4
738
#define FF_SI_TYPE 5
739
#define FF_SP_TYPE 6
740

    
741
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
742
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
743
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
744
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
745

    
746
/**
747
 * Audio Video Frame.
748
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
749
 * bumps.
750
 * Removal, reordering and changes to existing fields require a major
751
 * version bump. No fields should be added into AVFrame before or after
752
 * FF_COMMON_FRAME!
753
 * sizeof(AVFrame) must not be used outside libav*.
754
 */
755
typedef struct AVFrame {
756
    FF_COMMON_FRAME
757
} AVFrame;
758

    
759
#define DEFAULT_FRAME_RATE_BASE 1001000
760

    
761
/**
762
 * main external API structure.
763
 * New fields can be added to the end with minor version bumps.
764
 * Removal, reordering and changes to existing fields require a major
765
 * version bump.
766
 * sizeof(AVCodecContext) must not be used outside libav*.
767
 */
768
typedef struct AVCodecContext {
769
    /**
770
     * information on struct for av_log
771
     * - set by avcodec_alloc_context
772
     */
773
    AVClass *av_class;
774
    /**
775
     * the average bitrate
776
     * - encoding: Set by user; unused for constant quantizer encoding.
777
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
778
     */
779
    int bit_rate;
780

    
781
    /**
782
     * number of bits the bitstream is allowed to diverge from the reference.
783
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
784
     * - encoding: Set by user; unused for constant quantizer encoding.
785
     * - decoding: unused
786
     */
787
    int bit_rate_tolerance;
788

    
789
    /**
790
     * CODEC_FLAG_*.
791
     * - encoding: Set by user.
792
     * - decoding: Set by user.
793
     */
794
    int flags;
795

    
796
    /**
797
     * Some codecs need additional format info. It is stored here.
798
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
799
     * specific codec MUST set it correctly otherwise stream copy breaks.
800
     * In general use of this field by muxers is not recommanded.
801
     * - encoding: Set by libavcodec.
802
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
803
     */
804
    int sub_id;
805

    
806
    /**
807
     * Motion estimation algorithm used for video coding.
808
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
809
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
810
     * - encoding: MUST be set by user.
811
     * - decoding: unused
812
     */
813
    int me_method;
814

    
815
    /**
816
     * some codecs need / can use extradata like Huffman tables.
817
     * mjpeg: Huffman tables
818
     * rv10: additional flags
819
     * mpeg4: global headers (they can be in the bitstream or here)
820
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
821
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
822
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
823
     * - encoding: Set/allocated/freed by libavcodec.
824
     * - decoding: Set/allocated/freed by user.
825
     */
826
    uint8_t *extradata;
827
    int extradata_size;
828

    
829
    /**
830
     * This is the fundamental unit of time (in seconds) in terms
831
     * of which frame timestamps are represented. For fixed-fps content,
832
     * timebase should be 1/framerate and timestamp increments should be
833
     * identically 1.
834
     * - encoding: MUST be set by user.
835
     * - decoding: Set by libavcodec.
836
     */
837
    AVRational time_base;
838

    
839
    /* video only */
840
    /**
841
     * picture width / height.
842
     * - encoding: MUST be set by user.
843
     * - decoding: Set by libavcodec.
844
     * Note: For compatibility it is possible to set this instead of
845
     * coded_width/height before decoding.
846
     */
847
    int width, height;
848

    
849
#define FF_ASPECT_EXTENDED 15
850

    
851
    /**
852
     * the number of pictures in a group of pictures, or 0 for intra_only
853
     * - encoding: Set by user.
854
     * - decoding: unused
855
     */
856
    int gop_size;
857

    
858
    /**
859
     * Pixel format, see PIX_FMT_xxx.
860
     * - encoding: Set by user.
861
     * - decoding: Set by libavcodec.
862
     */
863
    enum PixelFormat pix_fmt;
864

    
865
    /**
866
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
867
     * has to read frames at native frame rate.
868
     * - encoding: Set by user.
869
     * - decoding: unused
870
     */
871
    int rate_emu;
872

    
873
    /**
874
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
875
     * decoder to draw a horizontal band. It improves cache usage. Not
876
     * all codecs can do that. You must check the codec capabilities
877
     * beforehand.
878
     * - encoding: unused
879
     * - decoding: Set by user.
880
     * @param height the height of the slice
881
     * @param y the y position of the slice
882
     * @param type 1->top field, 2->bottom field, 3->frame
883
     * @param offset offset into the AVFrame.data from which the slice should be read
884
     */
885
    void (*draw_horiz_band)(struct AVCodecContext *s,
886
                            const AVFrame *src, int offset[4],
887
                            int y, int type, int height);
888

    
889
    /* audio only */
890
    int sample_rate; ///< samples per second
891
    int channels;
892

    
893
    /**
894
     * audio sample format
895
     * - encoding: Set by user.
896
     * - decoding: Set by libavcodec.
897
     */
898
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
899

    
900
    /* The following data should not be initialized. */
901
    /**
902
     * Samples per packet, initialized when calling 'init'.
903
     */
904
    int frame_size;
905
    int frame_number;   ///< audio or video frame number
906
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
907

    
908
    /**
909
     * Number of frames the decoded output will be delayed relative to
910
     * the encoded input.
911
     * - encoding: Set by libavcodec.
912
     * - decoding: unused
913
     */
914
    int delay;
915

    
916
    /* - encoding parameters */
917
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
918
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
919

    
920
    /**
921
     * minimum quantizer
922
     * - encoding: Set by user.
923
     * - decoding: unused
924
     */
925
    int qmin;
926

    
927
    /**
928
     * maximum quantizer
929
     * - encoding: Set by user.
930
     * - decoding: unused
931
     */
932
    int qmax;
933

    
934
    /**
935
     * maximum quantizer difference between frames
936
     * - encoding: Set by user.
937
     * - decoding: unused
938
     */
939
    int max_qdiff;
940

    
941
    /**
942
     * maximum number of B-frames between non-B-frames
943
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
944
     * - encoding: Set by user.
945
     * - decoding: unused
946
     */
947
    int max_b_frames;
948

    
949
    /**
950
     * qscale factor between IP and B-frames
951
     * - encoding: Set by user.
952
     * - decoding: unused
953
     */
954
    float b_quant_factor;
955

    
956
    /** obsolete FIXME remove */
957
    int rc_strategy;
958
#define FF_RC_STRATEGY_XVID 1
959

    
960
    int b_frame_strategy;
961

    
962
    /**
963
     * hurry up amount
964
     * - encoding: unused
965
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
966
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
967
     */
968
    int hurry_up;
969

    
970
    struct AVCodec *codec;
971

    
972
    void *priv_data;
973

    
974
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
975
    /* unused, FIXME remove*/
976
    int rtp_mode;
977
#endif
978

    
979
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
980
                            /* do its best to deliver a chunk with size     */
981
                            /* below rtp_payload_size, the chunk will start */
982
                            /* with a start code on some codecs like H.263. */
983
                            /* This doesn't take account of any particular  */
984
                            /* headers inside the transmitted RTP payload.  */
985

    
986

    
987
    /* The RTP callback: This function is called    */
988
    /* every time the encoder has a packet to send. */
989
    /* It depends on the encoder if the data starts */
990
    /* with a Start Code (it should). H.263 does.   */
991
    /* mb_nb contains the number of macroblocks     */
992
    /* encoded in the RTP payload.                  */
993
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
994

    
995
    /* statistics, used for 2-pass encoding */
996
    int mv_bits;
997
    int header_bits;
998
    int i_tex_bits;
999
    int p_tex_bits;
1000
    int i_count;
1001
    int p_count;
1002
    int skip_count;
1003
    int misc_bits;
1004

    
1005
    /**
1006
     * number of bits used for the previously encoded frame
1007
     * - encoding: Set by libavcodec.
1008
     * - decoding: unused
1009
     */
1010
    int frame_bits;
1011

    
1012
    /**
1013
     * Private data of the user, can be used to carry app specific stuff.
1014
     * - encoding: Set by user.
1015
     * - decoding: Set by user.
1016
     */
1017
    void *opaque;
1018

    
1019
    char codec_name[32];
1020
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1021
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1022

    
1023
    /**
1024
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1025
     * This is used to work around some encoder bugs.
1026
     * A demuxer should set this to what is stored in the field used to identify the codec.
1027
     * If there are multiple such fields in a container then the demuxer should choose the one
1028
     * which maximizes the information about the used codec.
1029
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1030
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1031
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1032
     * first.
1033
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1034
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1035
     */
1036
    unsigned int codec_tag;
1037

    
1038
    /**
1039
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1040
     * - encoding: Set by user
1041
     * - decoding: Set by user
1042
     */
1043
    int workaround_bugs;
1044
#define FF_BUG_AUTODETECT       1  ///< autodetection
1045
#define FF_BUG_OLD_MSMPEG4      2
1046
#define FF_BUG_XVID_ILACE       4
1047
#define FF_BUG_UMP4             8
1048
#define FF_BUG_NO_PADDING       16
1049
#define FF_BUG_AMV              32
1050
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1051
#define FF_BUG_QPEL_CHROMA      64
1052
#define FF_BUG_STD_QPEL         128
1053
#define FF_BUG_QPEL_CHROMA2     256
1054
#define FF_BUG_DIRECT_BLOCKSIZE 512
1055
#define FF_BUG_EDGE             1024
1056
#define FF_BUG_HPEL_CHROMA      2048
1057
#define FF_BUG_DC_CLIP          4096
1058
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1059
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1060

    
1061
    /**
1062
     * luma single coefficient elimination threshold
1063
     * - encoding: Set by user.
1064
     * - decoding: unused
1065
     */
1066
    int luma_elim_threshold;
1067

    
1068
    /**
1069
     * chroma single coeff elimination threshold
1070
     * - encoding: Set by user.
1071
     * - decoding: unused
1072
     */
1073
    int chroma_elim_threshold;
1074

    
1075
    /**
1076
     * strictly follow the standard (MPEG4, ...).
1077
     * - encoding: Set by user.
1078
     * - decoding: unused
1079
     */
1080
    int strict_std_compliance;
1081
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1082
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1083
#define FF_COMPLIANCE_NORMAL        0
1084
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1085
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1086

    
1087
    /**
1088
     * qscale offset between IP and B-frames
1089
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1090
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1091
     * - encoding: Set by user.
1092
     * - decoding: unused
1093
     */
1094
    float b_quant_offset;
1095

    
1096
    /**
1097
     * Error resilience; higher values will detect more errors but may
1098
     * misdetect some more or less valid parts as errors.
1099
     * - encoding: unused
1100
     * - decoding: Set by user.
1101
     */
1102
    int error_resilience;
1103
#define FF_ER_CAREFUL         1
1104
#define FF_ER_COMPLIANT       2
1105
#define FF_ER_AGGRESSIVE      3
1106
#define FF_ER_VERY_AGGRESSIVE 4
1107

    
1108
    /**
1109
     * Called at the beginning of each frame to get a buffer for it.
1110
     * If pic.reference is set then the frame will be read later by libavcodec.
1111
     * avcodec_align_dimensions() should be used to find the required width and
1112
     * height, as they normally need to be rounded up to the next multiple of 16.
1113
     * - encoding: unused
1114
     * - decoding: Set by libavcodec., user can override.
1115
     */
1116
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1117

    
1118
    /**
1119
     * Called to release buffers which where allocated with get_buffer.
1120
     * A released buffer can be reused in get_buffer().
1121
     * pic.data[*] must be set to NULL.
1122
     * - encoding: unused
1123
     * - decoding: Set by libavcodec., user can override.
1124
     */
1125
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1126

    
1127
    /**
1128
     * If 1 the stream has a 1 frame delay during decoding.
1129
     * - encoding: Set by libavcodec.
1130
     * - decoding: Set by libavcodec.
1131
     */
1132
    int has_b_frames;
1133

    
1134
    /**
1135
     * number of bytes per packet if constant and known or 0
1136
     * Used by some WAV based audio codecs.
1137
     */
1138
    int block_align;
1139

    
1140
    int parse_only; /* - decoding only: If true, only parsing is done
1141
                       (function avcodec_parse_frame()). The frame
1142
                       data is returned. Only MPEG codecs support this now. */
1143

    
1144
    /**
1145
     * 0-> h263 quant 1-> mpeg quant
1146
     * - encoding: Set by user.
1147
     * - decoding: unused
1148
     */
1149
    int mpeg_quant;
1150

    
1151
    /**
1152
     * pass1 encoding statistics output buffer
1153
     * - encoding: Set by libavcodec.
1154
     * - decoding: unused
1155
     */
1156
    char *stats_out;
1157

    
1158
    /**
1159
     * pass2 encoding statistics input buffer
1160
     * Concatenated stuff from stats_out of pass1 should be placed here.
1161
     * - encoding: Allocated/set/freed by user.
1162
     * - decoding: unused
1163
     */
1164
    char *stats_in;
1165

    
1166
    /**
1167
     * ratecontrol qmin qmax limiting method
1168
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1169
     * - encoding: Set by user.
1170
     * - decoding: unused
1171
     */
1172
    float rc_qsquish;
1173

    
1174
    float rc_qmod_amp;
1175
    int rc_qmod_freq;
1176

    
1177
    /**
1178
     * ratecontrol override, see RcOverride
1179
     * - encoding: Allocated/set/freed by user.
1180
     * - decoding: unused
1181
     */
1182
    RcOverride *rc_override;
1183
    int rc_override_count;
1184

    
1185
    /**
1186
     * rate control equation
1187
     * - encoding: Set by user
1188
     * - decoding: unused
1189
     */
1190
    char *rc_eq;
1191

    
1192
    /**
1193
     * maximum bitrate
1194
     * - encoding: Set by user.
1195
     * - decoding: unused
1196
     */
1197
    int rc_max_rate;
1198

    
1199
    /**
1200
     * minimum bitrate
1201
     * - encoding: Set by user.
1202
     * - decoding: unused
1203
     */
1204
    int rc_min_rate;
1205

    
1206
    /**
1207
     * decoder bitstream buffer size
1208
     * - encoding: Set by user.
1209
     * - decoding: unused
1210
     */
1211
    int rc_buffer_size;
1212
    float rc_buffer_aggressivity;
1213

    
1214
    /**
1215
     * qscale factor between P and I-frames
1216
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1217
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1218
     * - encoding: Set by user.
1219
     * - decoding: unused
1220
     */
1221
    float i_quant_factor;
1222

    
1223
    /**
1224
     * qscale offset between P and I-frames
1225
     * - encoding: Set by user.
1226
     * - decoding: unused
1227
     */
1228
    float i_quant_offset;
1229

    
1230
    /**
1231
     * initial complexity for pass1 ratecontrol
1232
     * - encoding: Set by user.
1233
     * - decoding: unused
1234
     */
1235
    float rc_initial_cplx;
1236

    
1237
    /**
1238
     * DCT algorithm, see FF_DCT_* below
1239
     * - encoding: Set by user.
1240
     * - decoding: unused
1241
     */
1242
    int dct_algo;
1243
#define FF_DCT_AUTO    0
1244
#define FF_DCT_FASTINT 1
1245
#define FF_DCT_INT     2
1246
#define FF_DCT_MMX     3
1247
#define FF_DCT_MLIB    4
1248
#define FF_DCT_ALTIVEC 5
1249
#define FF_DCT_FAAN    6
1250

    
1251
    /**
1252
     * luminance masking (0-> disabled)
1253
     * - encoding: Set by user.
1254
     * - decoding: unused
1255
     */
1256
    float lumi_masking;
1257

    
1258
    /**
1259
     * temporary complexity masking (0-> disabled)
1260
     * - encoding: Set by user.
1261
     * - decoding: unused
1262
     */
1263
    float temporal_cplx_masking;
1264

    
1265
    /**
1266
     * spatial complexity masking (0-> disabled)
1267
     * - encoding: Set by user.
1268
     * - decoding: unused
1269
     */
1270
    float spatial_cplx_masking;
1271

    
1272
    /**
1273
     * p block masking (0-> disabled)
1274
     * - encoding: Set by user.
1275
     * - decoding: unused
1276
     */
1277
    float p_masking;
1278

    
1279
    /**
1280
     * darkness masking (0-> disabled)
1281
     * - encoding: Set by user.
1282
     * - decoding: unused
1283
     */
1284
    float dark_masking;
1285

    
1286

    
1287
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1288
    /* for binary compatibility */
1289
    int unused;
1290
#endif
1291

    
1292
    /**
1293
     * IDCT algorithm, see FF_IDCT_* below.
1294
     * - encoding: Set by user.
1295
     * - decoding: Set by user.
1296
     */
1297
    int idct_algo;
1298
#define FF_IDCT_AUTO          0
1299
#define FF_IDCT_INT           1
1300
#define FF_IDCT_SIMPLE        2
1301
#define FF_IDCT_SIMPLEMMX     3
1302
#define FF_IDCT_LIBMPEG2MMX   4
1303
#define FF_IDCT_PS2           5
1304
#define FF_IDCT_MLIB          6
1305
#define FF_IDCT_ARM           7
1306
#define FF_IDCT_ALTIVEC       8
1307
#define FF_IDCT_SH4           9
1308
#define FF_IDCT_SIMPLEARM     10
1309
#define FF_IDCT_H264          11
1310
#define FF_IDCT_VP3           12
1311
#define FF_IDCT_IPP           13
1312
#define FF_IDCT_XVIDMMX       14
1313
#define FF_IDCT_CAVS          15
1314
#define FF_IDCT_SIMPLEARMV5TE 16
1315
#define FF_IDCT_SIMPLEARMV6   17
1316
#define FF_IDCT_SIMPLEVIS     18
1317
#define FF_IDCT_WMV2          19
1318

    
1319
    /**
1320
     * slice count
1321
     * - encoding: Set by libavcodec.
1322
     * - decoding: Set by user (or 0).
1323
     */
1324
    int slice_count;
1325
    /**
1326
     * slice offsets in the frame in bytes
1327
     * - encoding: Set/allocated by libavcodec.
1328
     * - decoding: Set/allocated by user (or NULL).
1329
     */
1330
    int *slice_offset;
1331

    
1332
    /**
1333
     * error concealment flags
1334
     * - encoding: unused
1335
     * - decoding: Set by user.
1336
     */
1337
    int error_concealment;
1338
#define FF_EC_GUESS_MVS   1
1339
#define FF_EC_DEBLOCK     2
1340

    
1341
    /**
1342
     * dsp_mask could be add used to disable unwanted CPU features
1343
     * CPU features (i.e. MMX, SSE. ...)
1344
     *
1345
     * With the FORCE flag you may instead enable given CPU features.
1346
     * (Dangerous: Usable in case of misdetection, improper usage however will
1347
     * result into program crash.)
1348
     */
1349
    unsigned dsp_mask;
1350
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1351
    /* lower 16 bits - CPU features */
1352
#define FF_MM_MMX      0x0001 ///< standard MMX
1353
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1354
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1355
#define FF_MM_SSE      0x0008 ///< SSE functions
1356
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1357
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1358
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1359
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1360
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1361

    
1362
    /**
1363
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1364
     * - encoding: Set by libavcodec.
1365
     * - decoding: Set by user.
1366
     */
1367
     int bits_per_sample;
1368

    
1369
    /**
1370
     * prediction method (needed for huffyuv)
1371
     * - encoding: Set by user.
1372
     * - decoding: unused
1373
     */
1374
     int prediction_method;
1375
#define FF_PRED_LEFT   0
1376
#define FF_PRED_PLANE  1
1377
#define FF_PRED_MEDIAN 2
1378

    
1379
    /**
1380
     * sample aspect ratio (0 if unknown)
1381
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1382
     * - encoding: Set by user.
1383
     * - decoding: Set by libavcodec.
1384
     */
1385
    AVRational sample_aspect_ratio;
1386

    
1387
    /**
1388
     * the picture in the bitstream
1389
     * - encoding: Set by libavcodec.
1390
     * - decoding: Set by libavcodec.
1391
     */
1392
    AVFrame *coded_frame;
1393

    
1394
    /**
1395
     * debug
1396
     * - encoding: Set by user.
1397
     * - decoding: Set by user.
1398
     */
1399
    int debug;
1400
#define FF_DEBUG_PICT_INFO   1
1401
#define FF_DEBUG_RC          2
1402
#define FF_DEBUG_BITSTREAM   4
1403
#define FF_DEBUG_MB_TYPE     8
1404
#define FF_DEBUG_QP          16
1405
#define FF_DEBUG_MV          32
1406
#define FF_DEBUG_DCT_COEFF   0x00000040
1407
#define FF_DEBUG_SKIP        0x00000080
1408
#define FF_DEBUG_STARTCODE   0x00000100
1409
#define FF_DEBUG_PTS         0x00000200
1410
#define FF_DEBUG_ER          0x00000400
1411
#define FF_DEBUG_MMCO        0x00000800
1412
#define FF_DEBUG_BUGS        0x00001000
1413
#define FF_DEBUG_VIS_QP      0x00002000
1414
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1415

    
1416
    /**
1417
     * debug
1418
     * - encoding: Set by user.
1419
     * - decoding: Set by user.
1420
     */
1421
    int debug_mv;
1422
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1423
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1424
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1425

    
1426
    /**
1427
     * error
1428
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1429
     * - decoding: unused
1430
     */
1431
    uint64_t error[4];
1432

    
1433
    /**
1434
     * minimum MB quantizer
1435
     * - encoding: unused
1436
     * - decoding: unused
1437
     */
1438
    int mb_qmin;
1439

    
1440
    /**
1441
     * maximum MB quantizer
1442
     * - encoding: unused
1443
     * - decoding: unused
1444
     */
1445
    int mb_qmax;
1446

    
1447
    /**
1448
     * motion estimation comparison function
1449
     * - encoding: Set by user.
1450
     * - decoding: unused
1451
     */
1452
    int me_cmp;
1453
    /**
1454
     * subpixel motion estimation comparison function
1455
     * - encoding: Set by user.
1456
     * - decoding: unused
1457
     */
1458
    int me_sub_cmp;
1459
    /**
1460
     * macroblock comparison function (not supported yet)
1461
     * - encoding: Set by user.
1462
     * - decoding: unused
1463
     */
1464
    int mb_cmp;
1465
    /**
1466
     * interlaced DCT comparison function
1467
     * - encoding: Set by user.
1468
     * - decoding: unused
1469
     */
1470
    int ildct_cmp;
1471
#define FF_CMP_SAD    0
1472
#define FF_CMP_SSE    1
1473
#define FF_CMP_SATD   2
1474
#define FF_CMP_DCT    3
1475
#define FF_CMP_PSNR   4
1476
#define FF_CMP_BIT    5
1477
#define FF_CMP_RD     6
1478
#define FF_CMP_ZERO   7
1479
#define FF_CMP_VSAD   8
1480
#define FF_CMP_VSSE   9
1481
#define FF_CMP_NSSE   10
1482
#define FF_CMP_W53    11
1483
#define FF_CMP_W97    12
1484
#define FF_CMP_DCTMAX 13
1485
#define FF_CMP_DCT264 14
1486
#define FF_CMP_CHROMA 256
1487

    
1488
    /**
1489
     * ME diamond size & shape
1490
     * - encoding: Set by user.
1491
     * - decoding: unused
1492
     */
1493
    int dia_size;
1494

    
1495
    /**
1496
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1497
     * - encoding: Set by user.
1498
     * - decoding: unused
1499
     */
1500
    int last_predictor_count;
1501

    
1502
    /**
1503
     * prepass for motion estimation
1504
     * - encoding: Set by user.
1505
     * - decoding: unused
1506
     */
1507
    int pre_me;
1508

    
1509
    /**
1510
     * motion estimation prepass comparison function
1511
     * - encoding: Set by user.
1512
     * - decoding: unused
1513
     */
1514
    int me_pre_cmp;
1515

    
1516
    /**
1517
     * ME prepass diamond size & shape
1518
     * - encoding: Set by user.
1519
     * - decoding: unused
1520
     */
1521
    int pre_dia_size;
1522

    
1523
    /**
1524
     * subpel ME quality
1525
     * - encoding: Set by user.
1526
     * - decoding: unused
1527
     */
1528
    int me_subpel_quality;
1529

    
1530
    /**
1531
     * callback to negotiate the pixelFormat
1532
     * @param fmt is the list of formats which are supported by the codec,
1533
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1534
     * The first is always the native one.
1535
     * @return the chosen format
1536
     * - encoding: unused
1537
     * - decoding: Set by user, if not set the native format will be chosen.
1538
     */
1539
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1540

    
1541
    /**
1542
     * DTG active format information (additional aspect ratio
1543
     * information only used in DVB MPEG-2 transport streams)
1544
     * 0 if not set.
1545
     *
1546
     * - encoding: unused
1547
     * - decoding: Set by decoder.
1548
     */
1549
    int dtg_active_format;
1550
#define FF_DTG_AFD_SAME         8
1551
#define FF_DTG_AFD_4_3          9
1552
#define FF_DTG_AFD_16_9         10
1553
#define FF_DTG_AFD_14_9         11
1554
#define FF_DTG_AFD_4_3_SP_14_9  13
1555
#define FF_DTG_AFD_16_9_SP_14_9 14
1556
#define FF_DTG_AFD_SP_4_3       15
1557

    
1558
    /**
1559
     * maximum motion estimation search range in subpel units
1560
     * If 0 then no limit.
1561
     *
1562
     * - encoding: Set by user.
1563
     * - decoding: unused
1564
     */
1565
    int me_range;
1566

    
1567
    /**
1568
     * intra quantizer bias
1569
     * - encoding: Set by user.
1570
     * - decoding: unused
1571
     */
1572
    int intra_quant_bias;
1573
#define FF_DEFAULT_QUANT_BIAS 999999
1574

    
1575
    /**
1576
     * inter quantizer bias
1577
     * - encoding: Set by user.
1578
     * - decoding: unused
1579
     */
1580
    int inter_quant_bias;
1581

    
1582
    /**
1583
     * color table ID
1584
     * - encoding: unused
1585
     * - decoding: Which clrtable should be used for 8bit RGB images.
1586
     *             Tables have to be stored somewhere. FIXME
1587
     */
1588
    int color_table_id;
1589

    
1590
    /**
1591
     * internal_buffer count
1592
     * Don't touch, used by libavcodec default_get_buffer().
1593
     */
1594
    int internal_buffer_count;
1595

    
1596
    /**
1597
     * internal_buffers
1598
     * Don't touch, used by libavcodec default_get_buffer().
1599
     */
1600
    void *internal_buffer;
1601

    
1602
#define FF_LAMBDA_SHIFT 7
1603
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1604
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1605
#define FF_LAMBDA_MAX (256*128-1)
1606

    
1607
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1608
    /**
1609
     * Global quality for codecs which cannot change it per frame.
1610
     * This should be proportional to MPEG-1/2/4 qscale.
1611
     * - encoding: Set by user.
1612
     * - decoding: unused
1613
     */
1614
    int global_quality;
1615

    
1616
#define FF_CODER_TYPE_VLC       0
1617
#define FF_CODER_TYPE_AC        1
1618
#define FF_CODER_TYPE_RAW       2
1619
#define FF_CODER_TYPE_RLE       3
1620
#define FF_CODER_TYPE_DEFLATE   4
1621
    /**
1622
     * coder type
1623
     * - encoding: Set by user.
1624
     * - decoding: unused
1625
     */
1626
    int coder_type;
1627

    
1628
    /**
1629
     * context model
1630
     * - encoding: Set by user.
1631
     * - decoding: unused
1632
     */
1633
    int context_model;
1634
#if 0
1635
    /**
1636
     *
1637
     * - encoding: unused
1638
     * - decoding: Set by user.
1639
     */
1640
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1641
#endif
1642

    
1643
    /**
1644
     * slice flags
1645
     * - encoding: unused
1646
     * - decoding: Set by user.
1647
     */
1648
    int slice_flags;
1649
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1650
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1651
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1652

    
1653
    /**
1654
     * XVideo Motion Acceleration
1655
     * - encoding: forbidden
1656
     * - decoding: set by decoder
1657
     */
1658
    int xvmc_acceleration;
1659

    
1660
    /**
1661
     * macroblock decision mode
1662
     * - encoding: Set by user.
1663
     * - decoding: unused
1664
     */
1665
    int mb_decision;
1666
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1667
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1668
#define FF_MB_DECISION_RD     2        ///< rate distoration
1669

    
1670
    /**
1671
     * custom intra quantization matrix
1672
     * - encoding: Set by user, can be NULL.
1673
     * - decoding: Set by libavcodec.
1674
     */
1675
    uint16_t *intra_matrix;
1676

    
1677
    /**
1678
     * custom inter quantization matrix
1679
     * - encoding: Set by user, can be NULL.
1680
     * - decoding: Set by libavcodec.
1681
     */
1682
    uint16_t *inter_matrix;
1683

    
1684
    /**
1685
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1686
     * This is used to work around some encoder bugs.
1687
     * - encoding: unused
1688
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1689
     */
1690
    unsigned int stream_codec_tag;
1691

    
1692
    /**
1693
     * scene change detection threshold
1694
     * 0 is default, larger means fewer detected scene changes.
1695
     * - encoding: Set by user.
1696
     * - decoding: unused
1697
     */
1698
    int scenechange_threshold;
1699

    
1700
    /**
1701
     * minimum Lagrange multipler
1702
     * - encoding: Set by user.
1703
     * - decoding: unused
1704
     */
1705
    int lmin;
1706

    
1707
    /**
1708
     * maximum Lagrange multipler
1709
     * - encoding: Set by user.
1710
     * - decoding: unused
1711
     */
1712
    int lmax;
1713

    
1714
    /**
1715
     * palette control structure
1716
     * - encoding: ??? (no palette-enabled encoder yet)
1717
     * - decoding: Set by user.
1718
     */
1719
    struct AVPaletteControl *palctrl;
1720

    
1721
    /**
1722
     * noise reduction strength
1723
     * - encoding: Set by user.
1724
     * - decoding: unused
1725
     */
1726
    int noise_reduction;
1727

    
1728
    /**
1729
     * Called at the beginning of a frame to get cr buffer for it.
1730
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1731
     * libavcodec will pass previous buffer in pic, function should return
1732
     * same buffer or new buffer with old frame "painted" into it.
1733
     * If pic.data[0] == NULL must behave like get_buffer().
1734
     * - encoding: unused
1735
     * - decoding: Set by libavcodec., user can override
1736
     */
1737
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1738

    
1739
    /**
1740
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1741
     * - encoding: Set by user.
1742
     * - decoding: unused
1743
     */
1744
    int rc_initial_buffer_occupancy;
1745

    
1746
    /**
1747
     *
1748
     * - encoding: Set by user.
1749
     * - decoding: unused
1750
     */
1751
    int inter_threshold;
1752

    
1753
    /**
1754
     * CODEC_FLAG2_*
1755
     * - encoding: Set by user.
1756
     * - decoding: Set by user.
1757
     */
1758
    int flags2;
1759

    
1760
    /**
1761
     * Simulates errors in the bitstream to test error concealment.
1762
     * - encoding: Set by user.
1763
     * - decoding: unused
1764
     */
1765
    int error_rate;
1766

    
1767
    /**
1768
     * MP3 antialias algorithm, see FF_AA_* below.
1769
     * - encoding: unused
1770
     * - decoding: Set by user.
1771
     */
1772
    int antialias_algo;
1773
#define FF_AA_AUTO    0
1774
#define FF_AA_FASTINT 1 //not implemented yet
1775
#define FF_AA_INT     2
1776
#define FF_AA_FLOAT   3
1777
    /**
1778
     * quantizer noise shaping
1779
     * - encoding: Set by user.
1780
     * - decoding: unused
1781
     */
1782
    int quantizer_noise_shaping;
1783

    
1784
    /**
1785
     * thread count
1786
     * is used to decide how many independent tasks should be passed to execute()
1787
     * - encoding: Set by user.
1788
     * - decoding: Set by user.
1789
     */
1790
    int thread_count;
1791

    
1792
    /**
1793
     * The codec may call this to execute several independent things.
1794
     * It will return only after finishing all tasks.
1795
     * The user may replace this with some multithreaded implementation,
1796
     * the default implementation will execute the parts serially.
1797
     * @param count the number of things to execute
1798
     * - encoding: Set by libavcodec, user can override.
1799
     * - decoding: Set by libavcodec, user can override.
1800
     */
1801
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1802

    
1803
    /**
1804
     * thread opaque
1805
     * Can be used by execute() to store some per AVCodecContext stuff.
1806
     * - encoding: set by execute()
1807
     * - decoding: set by execute()
1808
     */
1809
    void *thread_opaque;
1810

    
1811
    /**
1812
     * Motion estimation threshold below which no motion estimation is
1813
     * performed, but instead the user specified motion vectors are used.
1814
     *
1815
     * - encoding: Set by user.
1816
     * - decoding: unused
1817
     */
1818
     int me_threshold;
1819

    
1820
    /**
1821
     * Macroblock threshold below which the user specified macroblock types will be used.
1822
     * - encoding: Set by user.
1823
     * - decoding: unused
1824
     */
1825
     int mb_threshold;
1826

    
1827
    /**
1828
     * precision of the intra DC coefficient - 8
1829
     * - encoding: Set by user.
1830
     * - decoding: unused
1831
     */
1832
     int intra_dc_precision;
1833

    
1834
    /**
1835
     * noise vs. sse weight for the nsse comparsion function
1836
     * - encoding: Set by user.
1837
     * - decoding: unused
1838
     */
1839
     int nsse_weight;
1840

    
1841
    /**
1842
     * Number of macroblock rows at the top which are skipped.
1843
     * - encoding: unused
1844
     * - decoding: Set by user.
1845
     */
1846
     int skip_top;
1847

    
1848
    /**
1849
     * Number of macroblock rows at the bottom which are skipped.
1850
     * - encoding: unused
1851
     * - decoding: Set by user.
1852
     */
1853
     int skip_bottom;
1854

    
1855
    /**
1856
     * profile
1857
     * - encoding: Set by user.
1858
     * - decoding: Set by libavcodec.
1859
     */
1860
     int profile;
1861
#define FF_PROFILE_UNKNOWN -99
1862
#define FF_PROFILE_AAC_MAIN 0
1863
#define FF_PROFILE_AAC_LOW  1
1864
#define FF_PROFILE_AAC_SSR  2
1865
#define FF_PROFILE_AAC_LTP  3
1866

    
1867
    /**
1868
     * level
1869
     * - encoding: Set by user.
1870
     * - decoding: Set by libavcodec.
1871
     */
1872
     int level;
1873
#define FF_LEVEL_UNKNOWN -99
1874

    
1875
    /**
1876
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1877
     * - encoding: unused
1878
     * - decoding: Set by user.
1879
     */
1880
     int lowres;
1881

    
1882
    /**
1883
     * Bitstream width / height, may be different from width/height if lowres
1884
     * or other things are used.
1885
     * - encoding: unused
1886
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1887
     */
1888
    int coded_width, coded_height;
1889

    
1890
    /**
1891
     * frame skip threshold
1892
     * - encoding: Set by user.
1893
     * - decoding: unused
1894
     */
1895
    int frame_skip_threshold;
1896

    
1897
    /**
1898
     * frame skip factor
1899
     * - encoding: Set by user.
1900
     * - decoding: unused
1901
     */
1902
    int frame_skip_factor;
1903

    
1904
    /**
1905
     * frame skip exponent
1906
     * - encoding: Set by user.
1907
     * - decoding: unused
1908
     */
1909
    int frame_skip_exp;
1910

    
1911
    /**
1912
     * frame skip comparison function
1913
     * - encoding: Set by user.
1914
     * - decoding: unused
1915
     */
1916
    int frame_skip_cmp;
1917

    
1918
    /**
1919
     * Border processing masking, raises the quantizer for mbs on the borders
1920
     * of the picture.
1921
     * - encoding: Set by user.
1922
     * - decoding: unused
1923
     */
1924
    float border_masking;
1925

    
1926
    /**
1927
     * minimum MB lagrange multipler
1928
     * - encoding: Set by user.
1929
     * - decoding: unused
1930
     */
1931
    int mb_lmin;
1932

    
1933
    /**
1934
     * maximum MB lagrange multipler
1935
     * - encoding: Set by user.
1936
     * - decoding: unused
1937
     */
1938
    int mb_lmax;
1939

    
1940
    /**
1941
     *
1942
     * - encoding: Set by user.
1943
     * - decoding: unused
1944
     */
1945
    int me_penalty_compensation;
1946

    
1947
    /**
1948
     *
1949
     * - encoding: unused
1950
     * - decoding: Set by user.
1951
     */
1952
    enum AVDiscard skip_loop_filter;
1953

    
1954
    /**
1955
     *
1956
     * - encoding: unused
1957
     * - decoding: Set by user.
1958
     */
1959
    enum AVDiscard skip_idct;
1960

    
1961
    /**
1962
     *
1963
     * - encoding: unused
1964
     * - decoding: Set by user.
1965
     */
1966
    enum AVDiscard skip_frame;
1967

    
1968
    /**
1969
     *
1970
     * - encoding: Set by user.
1971
     * - decoding: unused
1972
     */
1973
    int bidir_refine;
1974

    
1975
    /**
1976
     *
1977
     * - encoding: Set by user.
1978
     * - decoding: unused
1979
     */
1980
    int brd_scale;
1981

    
1982
    /**
1983
     * constant rate factor - quality-based VBR - values ~correspond to qps
1984
     * - encoding: Set by user.
1985
     * - decoding: unused
1986
     */
1987
    float crf;
1988

    
1989
    /**
1990
     * constant quantization parameter rate control method
1991
     * - encoding: Set by user.
1992
     * - decoding: unused
1993
     */
1994
    int cqp;
1995

    
1996
    /**
1997
     * minimum GOP size
1998
     * - encoding: Set by user.
1999
     * - decoding: unused
2000
     */
2001
    int keyint_min;
2002

    
2003
    /**
2004
     * number of reference frames
2005
     * - encoding: Set by user.
2006
     * - decoding: unused
2007
     */
2008
    int refs;
2009

    
2010
    /**
2011
     * chroma qp offset from luma
2012
     * - encoding: Set by user.
2013
     * - decoding: unused
2014
     */
2015
    int chromaoffset;
2016

    
2017
    /**
2018
     * Influences how often B-frames are used.
2019
     * - encoding: Set by user.
2020
     * - decoding: unused
2021
     */
2022
    int bframebias;
2023

    
2024
    /**
2025
     * trellis RD quantization
2026
     * - encoding: Set by user.
2027
     * - decoding: unused
2028
     */
2029
    int trellis;
2030

    
2031
    /**
2032
     * Reduce fluctuations in qp (before curve compression).
2033
     * - encoding: Set by user.
2034
     * - decoding: unused
2035
     */
2036
    float complexityblur;
2037

    
2038
    /**
2039
     * in-loop deblocking filter alphac0 parameter
2040
     * alpha is in the range -6...6
2041
     * - encoding: Set by user.
2042
     * - decoding: unused
2043
     */
2044
    int deblockalpha;
2045

    
2046
    /**
2047
     * in-loop deblocking filter beta parameter
2048
     * beta is in the range -6...6
2049
     * - encoding: Set by user.
2050
     * - decoding: unused
2051
     */
2052
    int deblockbeta;
2053

    
2054
    /**
2055
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2056
     * - encoding: Set by user.
2057
     * - decoding: unused
2058
     */
2059
    int partitions;
2060
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2061
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2062
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2063
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2064
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2065

    
2066
    /**
2067
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2068
     * - encoding: Set by user.
2069
     * - decoding: unused
2070
     */
2071
    int directpred;
2072

    
2073
    /**
2074
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2075
     * - encoding: Set by user.
2076
     * - decoding: unused
2077
     */
2078
    int cutoff;
2079

    
2080
    /**
2081
     * Multiplied by qscale for each frame and added to scene_change_score.
2082
     * - encoding: Set by user.
2083
     * - decoding: unused
2084
     */
2085
    int scenechange_factor;
2086

    
2087
    /**
2088
     *
2089
     * Note: Value depends upon the compare function used for fullpel ME.
2090
     * - encoding: Set by user.
2091
     * - decoding: unused
2092
     */
2093
    int mv0_threshold;
2094

    
2095
    /**
2096
     * Adjusts sensitivity of b_frame_strategy 1.
2097
     * - encoding: Set by user.
2098
     * - decoding: unused
2099
     */
2100
    int b_sensitivity;
2101

    
2102
    /**
2103
     * - encoding: Set by user.
2104
     * - decoding: unused
2105
     */
2106
    int compression_level;
2107
#define FF_COMPRESSION_DEFAULT -1
2108

    
2109
    /**
2110
     * Sets whether to use LPC mode - used by FLAC encoder.
2111
     * - encoding: Set by user.
2112
     * - decoding: unused
2113
     */
2114
    int use_lpc;
2115

    
2116
    /**
2117
     * LPC coefficient precision - used by FLAC encoder
2118
     * - encoding: Set by user.
2119
     * - decoding: unused
2120
     */
2121
    int lpc_coeff_precision;
2122

    
2123
    /**
2124
     * - encoding: Set by user.
2125
     * - decoding: unused
2126
     */
2127
    int min_prediction_order;
2128

    
2129
    /**
2130
     * - encoding: Set by user.
2131
     * - decoding: unused
2132
     */
2133
    int max_prediction_order;
2134

    
2135
    /**
2136
     * search method for selecting prediction order
2137
     * - encoding: Set by user.
2138
     * - decoding: unused
2139
     */
2140
    int prediction_order_method;
2141

    
2142
    /**
2143
     * - encoding: Set by user.
2144
     * - decoding: unused
2145
     */
2146
    int min_partition_order;
2147

    
2148
    /**
2149
     * - encoding: Set by user.
2150
     * - decoding: unused
2151
     */
2152
    int max_partition_order;
2153

    
2154
    /**
2155
     * GOP timecode frame start number, in non drop frame format
2156
     * - encoding: Set by user.
2157
     * - decoding: unused
2158
     */
2159
    int64_t timecode_frame_start;
2160

    
2161
    /**
2162
     * Decoder should decode to this many channels if it can (0 for default)
2163
     * - encoding: unused
2164
     * - decoding: Set by user.
2165
     */
2166
    int request_channels;
2167

    
2168
    /**
2169
     * Percentage of dynamic range compression to be applied by the decoder.
2170
     * The default value is 1.0, corresponding to full compression.
2171
     * - encoding: unused
2172
     * - decoding: Set by user.
2173
     */
2174
    float drc_scale;
2175
} AVCodecContext;
2176

    
2177
/**
2178
 * AVCodec.
2179
 */
2180
typedef struct AVCodec {
2181
    /**
2182
     * Name of the codec implementation.
2183
     * The name is globally unique among encoders and among decoders (but an
2184
     * encoder and a decoder can share the same name).
2185
     * This is the primary way to find a codec from the user perspective.
2186
     */
2187
    const char *name;
2188
    enum CodecType type;
2189
    enum CodecID id;
2190
    int priv_data_size;
2191
    int (*init)(AVCodecContext *);
2192
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2193
    int (*close)(AVCodecContext *);
2194
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2195
                  uint8_t *buf, int buf_size);
2196
    int capabilities;
2197
    struct AVCodec *next;
2198
    void (*flush)(AVCodecContext *);
2199
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2200
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2201
} AVCodec;
2202

    
2203
/**
2204
 * four components are given, that's all.
2205
 * the last component is alpha
2206
 */
2207
typedef struct AVPicture {
2208
    uint8_t *data[4];
2209
    int linesize[4];       ///< number of bytes per line
2210
} AVPicture;
2211

    
2212
/**
2213
 * AVPaletteControl
2214
 * This structure defines a method for communicating palette changes
2215
 * between and demuxer and a decoder.
2216
 *
2217
 * @deprecated Use AVPacket to send palette changes instead.
2218
 * This is totally broken.
2219
 */
2220
#define AVPALETTE_SIZE 1024
2221
#define AVPALETTE_COUNT 256
2222
typedef struct AVPaletteControl {
2223

    
2224
    /* Demuxer sets this to 1 to indicate the palette has changed;
2225
     * decoder resets to 0. */
2226
    int palette_changed;
2227

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

    
2234
} AVPaletteControl attribute_deprecated;
2235

    
2236
typedef struct AVSubtitleRect {
2237
    uint16_t x;
2238
    uint16_t y;
2239
    uint16_t w;
2240
    uint16_t h;
2241
    uint16_t nb_colors;
2242
    int linesize;
2243
    uint32_t *rgba_palette;
2244
    uint8_t *bitmap;
2245
} AVSubtitleRect;
2246

    
2247
typedef struct AVSubtitle {
2248
    uint16_t format; /* 0 = graphics */
2249
    uint32_t start_display_time; /* relative to packet pts, in ms */
2250
    uint32_t end_display_time; /* relative to packet pts, in ms */
2251
    uint32_t num_rects;
2252
    AVSubtitleRect *rects;
2253
} AVSubtitle;
2254

    
2255

    
2256
/* resample.c */
2257

    
2258
struct ReSampleContext;
2259
struct AVResampleContext;
2260

    
2261
typedef struct ReSampleContext ReSampleContext;
2262

    
2263
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2264
                                     int output_rate, int input_rate);
2265
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2266
void audio_resample_close(ReSampleContext *s);
2267

    
2268
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2269
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2270
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2271
void av_resample_close(struct AVResampleContext *c);
2272

    
2273
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2274
/* YUV420 format is assumed ! */
2275

    
2276
/**
2277
 * @deprecated Use the software scaler (swscale) instead.
2278
 */
2279
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2280

    
2281
/**
2282
 * @deprecated Use the software scaler (swscale) instead.
2283
 */
2284
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2285
                                      int input_width, int input_height);
2286

    
2287
/**
2288
 * @deprecated Use the software scaler (swscale) instead.
2289
 */
2290
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2291
                                      int iwidth, int iheight,
2292
                                      int topBand, int bottomBand,
2293
                                      int leftBand, int rightBand,
2294
                                      int padtop, int padbottom,
2295
                                      int padleft, int padright);
2296

    
2297
/**
2298
 * @deprecated Use the software scaler (swscale) instead.
2299
 */
2300
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2301
                  AVPicture *output, const AVPicture *input);
2302

    
2303
/**
2304
 * @deprecated Use the software scaler (swscale) instead.
2305
 */
2306
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2307

    
2308
#endif
2309

    
2310
/**
2311
 * Allocate memory for a picture.  Call avpicture_free to free it.
2312
 *
2313
 * @param picture the picture to be filled in
2314
 * @param pix_fmt the format of the picture
2315
 * @param width the width of the picture
2316
 * @param height the height of the picture
2317
 * @return zero if successful, a negative value if not
2318
 */
2319
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2320

    
2321
/**
2322
 * Free a picture previously allocated by avpicture_alloc().
2323
 *
2324
 * @param picture the AVPicture to be freed
2325
 */
2326
void avpicture_free(AVPicture *picture);
2327

    
2328
/**
2329
 * Fill in the AVPicture fields.
2330
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2331
 * which points to the image data buffer. Depending on the specified picture
2332
 * format, one or multiple image data pointers and line sizes will be set.
2333
 * If a planar format is specified, several pointers will be set pointing to
2334
 * the different picture planes and the line sizes of the different planes
2335
 * will be stored in the lines_sizes array.
2336
 *
2337
 * @param picture AVPicture whose fields are to be filled in
2338
 * @param ptr Buffer which will contain or contains the actual image data
2339
 * @param pix_fmt The format in which the picture data is stored.
2340
 * @param width the width of the image in pixels
2341
 * @param height the height of the image in pixels
2342
 * @return size of the image data in bytes
2343
 */
2344
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2345
                   int pix_fmt, int width, int height);
2346
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2347
                     unsigned char *dest, int dest_size);
2348

    
2349
/**
2350
 * Calculate the size in bytes that a picture of the given width and height
2351
 * would occupy if stored in the given picture format.
2352
 *
2353
 * @param pix_fmt the given picture format
2354
 * @param width the width of the image
2355
 * @param height the height of the image
2356
 * @return Image data size in bytes
2357
 */
2358
int avpicture_get_size(int pix_fmt, int width, int height);
2359
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2360
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2361
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2362
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2363
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2364

    
2365
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2366
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2367
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2368
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2369
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2370
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2371

    
2372
/**
2373
 * Computes what kind of losses will occur when converting from one specific
2374
 * pixel format to another.
2375
 * When converting from one pixel format to another, information loss may occur.
2376
 * For example, when converting from RGB24 to GRAY, the color information will
2377
 * be lost. Similarly, other losses occur when converting from some formats to
2378
 * other formats. These losses can involve loss of chroma, but also loss of
2379
 * resolution, loss of color depth, loss due to the color space conversion, loss
2380
 * of the alpha bits or loss due to color quantization.
2381
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2382
 * which will occur when converting from one pixel format to another.
2383
 *
2384
 * @param[in] dst_pix_fmt destination pixel format
2385
 * @param[in] src_pix_fmt source pixel format
2386
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2387
 * @return Combination of flags informing you what kind of losses will occur.
2388
 */
2389
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2390
                             int has_alpha);
2391

    
2392
/**
2393
 * Finds the best pixel format to convert to given a certain source pixel
2394
 * format.  When converting from one pixel format to another, information loss
2395
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2396
 * information will be lost. Similarly, other losses occur when converting from
2397
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2398
 * the given pixel formats should be used to suffer the least amount of loss.
2399
 * The pixel formats from which it chooses one, are determined by the
2400
 * \p pix_fmt_mask parameter.
2401
 *
2402
 * @code
2403
 * src_pix_fmt = PIX_FMT_YUV420P;
2404
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2405
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2406
 * @endcode
2407
 *
2408
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2409
 * @param[in] src_pix_fmt source pixel format
2410
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2411
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2412
 * @return The best pixel format to convert to or -1 if none was found.
2413
 */
2414
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2415
                              int has_alpha, int *loss_ptr);
2416

    
2417

    
2418
/**
2419
 * Print in buf the string corresponding to the pixel format with
2420
 * number pix_fmt, or an header if pix_fmt is negative.
2421
 *
2422
 * @param[in] buf the buffer where to write the string
2423
 * @param[in] buf_size the size of buf
2424
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2425
 * a negative value to print the corresponding header.
2426
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2427
 */
2428
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2429

    
2430
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2431
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2432

    
2433
/**
2434
 * Tell if an image really has transparent alpha values.
2435
 * @return ored mask of FF_ALPHA_xxx constants
2436
 */
2437
int img_get_alpha_info(const AVPicture *src,
2438
                       int pix_fmt, int width, int height);
2439

    
2440
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2441
/**
2442
 * convert among pixel formats
2443
 * @deprecated Use the software scaler (swscale) instead.
2444
 */
2445
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2446
                const AVPicture *src, int pix_fmt,
2447
                int width, int height);
2448
#endif
2449

    
2450
/* deinterlace a picture */
2451
/* deinterlace - if not supported return -1 */
2452
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2453
                          int pix_fmt, int width, int height);
2454

    
2455
/* external high level API */
2456

    
2457
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2458
extern AVCodec *first_avcodec;
2459
#endif
2460
AVCodec *av_codec_next(AVCodec *c);
2461

    
2462
/* returns LIBAVCODEC_VERSION_INT constant */
2463
unsigned avcodec_version(void);
2464
/* returns LIBAVCODEC_BUILD constant */
2465
unsigned avcodec_build(void);
2466

    
2467
/**
2468
 * Initializes libavcodec.
2469
 *
2470
 * @warning This function \e must be called before any other libavcodec
2471
 * function.
2472
 */
2473
void avcodec_init(void);
2474

    
2475
void register_avcodec(AVCodec *format);
2476

    
2477
/**
2478
 * Finds a registered encoder with a matching codec ID.
2479
 *
2480
 * @param id CodecID of the requested encoder
2481
 * @return An encoder if one was found, NULL otherwise.
2482
 */
2483
AVCodec *avcodec_find_encoder(enum CodecID id);
2484

    
2485
/**
2486
 * Finds a registered encoder with the specified name.
2487
 *
2488
 * @param name name of the requested encoder
2489
 * @return An encoder if one was found, NULL otherwise.
2490
 */
2491
AVCodec *avcodec_find_encoder_by_name(const char *name);
2492

    
2493
/**
2494
 * Finds a registered decoder with a matching codec ID.
2495
 *
2496
 * @param id CodecID of the requested decoder
2497
 * @return A decoder if one was found, NULL otherwise.
2498
 */
2499
AVCodec *avcodec_find_decoder(enum CodecID id);
2500

    
2501
/**
2502
 * Finds a registered decoder with the specified name.
2503
 *
2504
 * @param name name of the requested decoder
2505
 * @return A decoder if one was found, NULL otherwise.
2506
 */
2507
AVCodec *avcodec_find_decoder_by_name(const char *name);
2508
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2509

    
2510
/**
2511
 * Sets the fields of the given AVCodecContext to default values.
2512
 *
2513
 * @param s The AVCodecContext of which the fields should be set to default values.
2514
 */
2515
void avcodec_get_context_defaults(AVCodecContext *s);
2516

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

    
2521
/**
2522
 * Allocates an AVCodecContext and sets its fields to default values.  The
2523
 * resulting struct can be deallocated by simply calling av_free().
2524
 *
2525
 * @return An AVCodecContext filled with default values or NULL on failure.
2526
 * @see avcodec_get_context_defaults
2527
 */
2528
AVCodecContext *avcodec_alloc_context(void);
2529

    
2530
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2531
 *  we WILL change its arguments and name a few times! */
2532
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2533

    
2534
/**
2535
 * Sets the fields of the given AVFrame to default values.
2536
 *
2537
 * @param pic The AVFrame of which the fields should be set to default values.
2538
 */
2539
void avcodec_get_frame_defaults(AVFrame *pic);
2540

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

    
2550
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2551
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2552
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2553
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2554

    
2555
/**
2556
 * Checks if the given dimension of a picture is valid, meaning that all
2557
 * bytes of the picture can be addressed with a signed int.
2558
 *
2559
 * @param[in] w Width of the picture.
2560
 * @param[in] h Height of the picture.
2561
 * @return Zero if valid, a negative value if invalid.
2562
 */
2563
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2564
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2565

    
2566
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2567
void avcodec_thread_free(AVCodecContext *s);
2568
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2569
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2570
//FIXME func typedef
2571

    
2572
/**
2573
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2574
 * function the context has to be allocated.
2575
 *
2576
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2577
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2578
 * retrieving a codec.
2579
 *
2580
 * @warning This function is not thread safe!
2581
 *
2582
 * @code
2583
 * avcodec_register_all();
2584
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2585
 * if (!codec)
2586
 *     exit(1);
2587
 *
2588
 * context = avcodec_alloc_context();
2589
 *
2590
 * if (avcodec_open(context, codec) < 0)
2591
 *     exit(1);
2592
 * @endcode
2593
 *
2594
 * @param avctx The context which will be set up to use the given codec.
2595
 * @param codec The codec to use within the context.
2596
 * @return zero on success, a negative value on error
2597
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2598
 */
2599
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2600

    
2601
/**
2602
 * @deprecated Use avcodec_decode_audio2() instead.
2603
 */
2604
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2605
                         int *frame_size_ptr,
2606
                         uint8_t *buf, int buf_size);
2607

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

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

    
2683
/* Decode a subtitle message. Return -1 if error, otherwise return the
2684
 * number of bytes used. If no subtitle could be decompressed,
2685
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2686
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2687
                            int *got_sub_ptr,
2688
                            const uint8_t *buf, int buf_size);
2689
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2690
                        int *data_size_ptr,
2691
                        uint8_t *buf, int buf_size);
2692

    
2693
/**
2694
 * Encodes an audio frame from \p samples into \p buf.
2695
 * The avcodec_encode_audio() function encodes an audio frame from the input
2696
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2697
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2698
 * stored in output buffer \p buf.
2699
 *
2700
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2701
 *
2702
 * @param avctx the codec context
2703
 * @param[out] buf the output buffer
2704
 * @param[in] buf_size the output buffer size
2705
 * @param[in] samples the input buffer containing the samples
2706
 * The number of samples read from this buffer is frame_size*channels,
2707
 * both of which are defined in \p avctx.
2708
 * @return On error a negative value is returned, on success zero or the number
2709
 * of bytes used to encode the data read from the input buffer.
2710
 */
2711
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2712
                         const short *samples);
2713

    
2714
/**
2715
 * Encodes a video frame from \p pict into \p buf.
2716
 * The avcodec_encode_video() function encodes a video frame from the input
2717
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2718
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2719
 * frame are stored in the output buffer \p buf. The input picture should be
2720
 * stored using a specific format, namely \c avctx.pix_fmt.
2721
 *
2722
 * @param avctx the codec context
2723
 * @param[out] buf the output buffer for the bitstream of encoded frame
2724
 * @param[in] buf_size the size of the output buffer in bytes
2725
 * @param[in] pict the input picture to encode
2726
 * @return On error a negative value is returned, on success zero or the number
2727
 * of bytes used from the input buffer.
2728
 */
2729
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2730
                         const AVFrame *pict);
2731
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2732
                            const AVSubtitle *sub);
2733

    
2734
int avcodec_close(AVCodecContext *avctx);
2735

    
2736
void avcodec_register_all(void);
2737

    
2738
/**
2739
 * Flush buffers, should be called when seeking or when switching to a different stream.
2740
 */
2741
void avcodec_flush_buffers(AVCodecContext *avctx);
2742

    
2743
void avcodec_default_free_buffers(AVCodecContext *s);
2744

    
2745
/* misc useful functions */
2746

    
2747
/**
2748
 * Returns a single letter to describe the given picture type \p pict_type.
2749
 *
2750
 * @param[in] pict_type the picture type
2751
 * @return A single character representing the picture type.
2752
 */
2753
char av_get_pict_type_char(int pict_type);
2754

    
2755
/**
2756
 * Returns codec bits per sample.
2757
 *
2758
 * @param[in] codec_id the codec
2759
 * @return Number of bits per sample or zero if unknown for the given codec.
2760
 */
2761
int av_get_bits_per_sample(enum CodecID codec_id);
2762

    
2763
/**
2764
 * Returns sample format bits per sample.
2765
 *
2766
 * @param[in] sample_fmt the sample format
2767
 * @return Number of bits per sample or zero if unknown for the given sample format.
2768
 */
2769
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2770

    
2771
/* frame parsing */
2772
typedef struct AVCodecParserContext {
2773
    void *priv_data;
2774
    struct AVCodecParser *parser;
2775
    int64_t frame_offset; /* offset of the current frame */
2776
    int64_t cur_offset; /* current offset
2777
                           (incremented by each av_parser_parse()) */
2778
    int64_t last_frame_offset; /* offset of the last frame */
2779
    /* video info */
2780
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2781
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2782
    int64_t pts;     /* pts of the current frame */
2783
    int64_t dts;     /* dts of the current frame */
2784

    
2785
    /* private data */
2786
    int64_t last_pts;
2787
    int64_t last_dts;
2788
    int fetch_timestamp;
2789

    
2790
#define AV_PARSER_PTS_NB 4
2791
    int cur_frame_start_index;
2792
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2793
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2794
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2795

    
2796
    int flags;
2797
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2798

    
2799
    int64_t offset;      ///< byte offset from starting packet start
2800
    int64_t last_offset;
2801
} AVCodecParserContext;
2802

    
2803
typedef struct AVCodecParser {
2804
    int codec_ids[5]; /* several codec IDs are permitted */
2805
    int priv_data_size;
2806
    int (*parser_init)(AVCodecParserContext *s);
2807
    int (*parser_parse)(AVCodecParserContext *s,
2808
                        AVCodecContext *avctx,
2809
                        const uint8_t **poutbuf, int *poutbuf_size,
2810
                        const uint8_t *buf, int buf_size);
2811
    void (*parser_close)(AVCodecParserContext *s);
2812
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2813
    struct AVCodecParser *next;
2814
} AVCodecParser;
2815

    
2816
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2817
extern AVCodecParser *av_first_parser;
2818
#endif
2819
AVCodecParser *av_parser_next(AVCodecParser *c);
2820

    
2821
void av_register_codec_parser(AVCodecParser *parser);
2822
AVCodecParserContext *av_parser_init(int codec_id);
2823
int av_parser_parse(AVCodecParserContext *s,
2824
                    AVCodecContext *avctx,
2825
                    uint8_t **poutbuf, int *poutbuf_size,
2826
                    const uint8_t *buf, int buf_size,
2827
                    int64_t pts, int64_t dts);
2828
int av_parser_change(AVCodecParserContext *s,
2829
                     AVCodecContext *avctx,
2830
                     uint8_t **poutbuf, int *poutbuf_size,
2831
                     const uint8_t *buf, int buf_size, int keyframe);
2832
void av_parser_close(AVCodecParserContext *s);
2833

    
2834

    
2835
typedef struct AVBitStreamFilterContext {
2836
    void *priv_data;
2837
    struct AVBitStreamFilter *filter;
2838
    AVCodecParserContext *parser;
2839
    struct AVBitStreamFilterContext *next;
2840
} AVBitStreamFilterContext;
2841

    
2842

    
2843
typedef struct AVBitStreamFilter {
2844
    const char *name;
2845
    int priv_data_size;
2846
    int (*filter)(AVBitStreamFilterContext *bsfc,
2847
                  AVCodecContext *avctx, const char *args,
2848
                  uint8_t **poutbuf, int *poutbuf_size,
2849
                  const uint8_t *buf, int buf_size, int keyframe);
2850
    void (*close)(AVBitStreamFilterContext *bsfc);
2851
    struct AVBitStreamFilter *next;
2852
} AVBitStreamFilter;
2853

    
2854
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2855
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2856
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2857
                               AVCodecContext *avctx, const char *args,
2858
                               uint8_t **poutbuf, int *poutbuf_size,
2859
                               const uint8_t *buf, int buf_size, int keyframe);
2860
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2861

    
2862
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2863

    
2864
/* memory */
2865

    
2866
/**
2867
 * Reallocates the given block if it is not large enough, otherwise it
2868
 * does nothing.
2869
 *
2870
 * @see av_realloc
2871
 */
2872
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2873

    
2874
/* for static data only */
2875

    
2876
/**
2877
 * Frees all static arrays and resets their pointers to 0.
2878
 * Call this function to release all statically allocated tables.
2879
 *
2880
 * @deprecated. Code which uses av_free_static is broken/misdesigned
2881
 * and should correctly use static arrays
2882
 *
2883
 */
2884
attribute_deprecated void av_free_static(void);
2885

    
2886
/**
2887
 * Allocation of static arrays.
2888
 *
2889
 * @warning Do not use for normal allocation.
2890
 *
2891
 * @param[in] size The amount of memory you need in bytes.
2892
 * @return block of memory of the requested size
2893
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2894
 * and should correctly use static arrays
2895
 */
2896
attribute_deprecated void *av_mallocz_static(unsigned int size);
2897

    
2898
/**
2899
 * Copy image 'src' to 'dst'.
2900
 */
2901
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2902
              int pix_fmt, int width, int height);
2903

    
2904
/**
2905
 * Crop image top and left side.
2906
 */
2907
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2908
             int pix_fmt, int top_band, int left_band);
2909

    
2910
/**
2911
 * Pad image.
2912
 */
2913
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2914
            int padtop, int padbottom, int padleft, int padright, int *color);
2915

    
2916
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2917
/**
2918
 * @deprecated Use the software scaler (swscale) instead.
2919
 */
2920
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2921
              int pix_fmt, int width, int height);
2922

    
2923
/**
2924
 * @deprecated Use the software scaler (swscale) instead.
2925
 */
2926
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2927
             int pix_fmt, int top_band, int left_band);
2928

    
2929
/**
2930
 * @deprecated Use the software scaler (swscale) instead.
2931
 */
2932
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2933
            int padtop, int padbottom, int padleft, int padright, int *color);
2934
#endif
2935

    
2936
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2937

    
2938
/**
2939
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2940
 *
2941
 * @return 0 in case of a successful parsing, a negative value otherwise
2942
 * @param[in] str the string to parse: it has to be a string in the format
2943
 * <width>x<height> or a valid video frame size abbreviation.
2944
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2945
 * frame width value
2946
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2947
 * frame height value
2948
 */
2949
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2950

    
2951
/**
2952
 * Parses \p str and put in \p frame_rate the detected values.
2953
 *
2954
 * @return 0 in case of a successful parsing, a negative value otherwise
2955
 * @param[in] str the string to parse: it has to be a string in the format
2956
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2957
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2958
 * frame rate
2959
 */
2960
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2961

    
2962
/* error handling */
2963
#if EINVAL > 0
2964
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2965
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2966
#else
2967
/* Some platforms have E* and errno already negated. */
2968
#define AVERROR(e) (e)
2969
#define AVUNERROR(e) (e)
2970
#endif
2971
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
2972
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
2973
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2974
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
2975
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
2976
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
2977
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
2978
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
2979
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2980

    
2981
#endif /* FFMPEG_AVCODEC_H */