Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 3e0b7b56

History | View | Annotate | Download (90.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,
339
    ME_FULL,
340
    ME_LOG,
341
    ME_PHODS,
342
    ME_EPZS,
343
    ME_X1,
344
    ME_HEX,
345
    ME_UMH,
346
    ME_ITER,
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
 */
749
typedef struct AVFrame {
750
    FF_COMMON_FRAME
751
} AVFrame;
752

    
753
#define DEFAULT_FRAME_RATE_BASE 1001000
754

    
755
/**
756
 * main external API structure
757
 */
758
typedef struct AVCodecContext {
759
    /**
760
     * information on struct for av_log
761
     * - set by avcodec_alloc_context
762
     */
763
    AVClass *av_class;
764
    /**
765
     * the average bitrate
766
     * - encoding: Set by user; unused for constant quantizer encoding.
767
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
768
     */
769
    int bit_rate;
770

    
771
    /**
772
     * number of bits the bitstream is allowed to diverge from the reference.
773
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
774
     * - encoding: Set by user; unused for constant quantizer encoding.
775
     * - decoding: unused
776
     */
777
    int bit_rate_tolerance;
778

    
779
    /**
780
     * CODEC_FLAG_*.
781
     * - encoding: Set by user.
782
     * - decoding: Set by user.
783
     */
784
    int flags;
785

    
786
    /**
787
     * Some codecs need additional format info. It is stored here.
788
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
789
     * specific codec MUST set it correctly otherwise stream copy breaks.
790
     * In general use of this field by muxers is not recommanded.
791
     * - encoding: Set by libavcodec.
792
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
793
     */
794
    int sub_id;
795

    
796
    /**
797
     * Motion estimation algorithm used for video coding.
798
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
799
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
800
     * - encoding: MUST be set by user.
801
     * - decoding: unused
802
     */
803
    int me_method;
804

    
805
    /**
806
     * some codecs need / can use extradata like Huffman tables.
807
     * mjpeg: Huffman tables
808
     * rv10: additional flags
809
     * mpeg4: global headers (they can be in the bitstream or here)
810
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
811
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
812
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
813
     * - encoding: Set/allocated/freed by libavcodec.
814
     * - decoding: Set/allocated/freed by user.
815
     */
816
    uint8_t *extradata;
817
    int extradata_size;
818

    
819
    /**
820
     * This is the fundamental unit of time (in seconds) in terms
821
     * of which frame timestamps are represented. For fixed-fps content,
822
     * timebase should be 1/framerate and timestamp increments should be
823
     * identically 1.
824
     * - encoding: MUST be set by user.
825
     * - decoding: Set by libavcodec.
826
     */
827
    AVRational time_base;
828

    
829
    /* video only */
830
    /**
831
     * picture width / height.
832
     * - encoding: MUST be set by user.
833
     * - decoding: Set by libavcodec.
834
     * Note: For compatibility it is possible to set this instead of
835
     * coded_width/height before decoding.
836
     */
837
    int width, height;
838

    
839
#define FF_ASPECT_EXTENDED 15
840

    
841
    /**
842
     * the number of pictures in a group of pictures, or 0 for intra_only
843
     * - encoding: Set by user.
844
     * - decoding: unused
845
     */
846
    int gop_size;
847

    
848
    /**
849
     * Pixel format, see PIX_FMT_xxx.
850
     * - encoding: Set by user.
851
     * - decoding: Set by libavcodec.
852
     */
853
    enum PixelFormat pix_fmt;
854

    
855
    /**
856
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
857
     * has to read frames at native frame rate.
858
     * - encoding: Set by user.
859
     * - decoding: unused
860
     */
861
    int rate_emu;
862

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

    
879
    /* audio only */
880
    int sample_rate; ///< samples per second
881
    int channels;
882

    
883
    /**
884
     * audio sample format
885
     * - encoding: Set by user.
886
     * - decoding: Set by libavcodec.
887
     */
888
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
889

    
890
    /* The following data should not be initialized. */
891
    /**
892
     * Samples per packet, initialized when calling 'init'.
893
     */
894
    int frame_size;
895
    int frame_number;   ///< audio or video frame number
896
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
897

    
898
    /**
899
     * Number of frames the decoded output will be delayed relative to
900
     * the encoded input.
901
     * - encoding: Set by libavcodec.
902
     * - decoding: unused
903
     */
904
    int delay;
905

    
906
    /* - encoding parameters */
907
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
908
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
909

    
910
    /**
911
     * minimum quantizer
912
     * - encoding: Set by user.
913
     * - decoding: unused
914
     */
915
    int qmin;
916

    
917
    /**
918
     * maximum quantizer
919
     * - encoding: Set by user.
920
     * - decoding: unused
921
     */
922
    int qmax;
923

    
924
    /**
925
     * maximum quantizer difference between frames
926
     * - encoding: Set by user.
927
     * - decoding: unused
928
     */
929
    int max_qdiff;
930

    
931
    /**
932
     * maximum number of B-frames between non-B-frames
933
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
934
     * - encoding: Set by user.
935
     * - decoding: unused
936
     */
937
    int max_b_frames;
938

    
939
    /**
940
     * qscale factor between IP and B-frames
941
     * - encoding: Set by user.
942
     * - decoding: unused
943
     */
944
    float b_quant_factor;
945

    
946
    /** obsolete FIXME remove */
947
    int rc_strategy;
948
#define FF_RC_STRATEGY_XVID 1
949

    
950
    int b_frame_strategy;
951

    
952
    /**
953
     * hurry up amount
954
     * - encoding: unused
955
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
956
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
957
     */
958
    int hurry_up;
959

    
960
    struct AVCodec *codec;
961

    
962
    void *priv_data;
963

    
964
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
965
    /* unused, FIXME remove*/
966
    int rtp_mode;
967
#endif
968

    
969
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
970
                            /* do its best to deliver a chunk with size     */
971
                            /* below rtp_payload_size, the chunk will start */
972
                            /* with a start code on some codecs like H.263. */
973
                            /* This doesn't take account of any particular  */
974
                            /* headers inside the transmitted RTP payload.  */
975

    
976

    
977
    /* The RTP callback: This function is called    */
978
    /* every time the encoder has a packet to send. */
979
    /* It depends on the encoder if the data starts */
980
    /* with a Start Code (it should). H.263 does.   */
981
    /* mb_nb contains the number of macroblocks     */
982
    /* encoded in the RTP payload.                  */
983
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
984

    
985
    /* statistics, used for 2-pass encoding */
986
    int mv_bits;
987
    int header_bits;
988
    int i_tex_bits;
989
    int p_tex_bits;
990
    int i_count;
991
    int p_count;
992
    int skip_count;
993
    int misc_bits;
994

    
995
    /**
996
     * number of bits used for the previously encoded frame
997
     * - encoding: Set by libavcodec.
998
     * - decoding: unused
999
     */
1000
    int frame_bits;
1001

    
1002
    /**
1003
     * Private data of the user, can be used to carry app specific stuff.
1004
     * - encoding: Set by user.
1005
     * - decoding: Set by user.
1006
     */
1007
    void *opaque;
1008

    
1009
    char codec_name[32];
1010
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1011
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1012

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

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

    
1051
    /**
1052
     * luma single coefficient elimination threshold
1053
     * - encoding: Set by user.
1054
     * - decoding: unused
1055
     */
1056
    int luma_elim_threshold;
1057

    
1058
    /**
1059
     * chroma single coeff elimination threshold
1060
     * - encoding: Set by user.
1061
     * - decoding: unused
1062
     */
1063
    int chroma_elim_threshold;
1064

    
1065
    /**
1066
     * strictly follow the standard (MPEG4, ...).
1067
     * - encoding: Set by user.
1068
     * - decoding: unused
1069
     */
1070
    int strict_std_compliance;
1071
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1072
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1073
#define FF_COMPLIANCE_NORMAL        0
1074
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1075
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1076

    
1077
    /**
1078
     * qscale offset between IP and B-frames
1079
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1080
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1081
     * - encoding: Set by user.
1082
     * - decoding: unused
1083
     */
1084
    float b_quant_offset;
1085

    
1086
    /**
1087
     * Error resilience; higher values will detect more errors but may
1088
     * misdetect some more or less valid parts as errors.
1089
     * - encoding: unused
1090
     * - decoding: Set by user.
1091
     */
1092
    int error_resilience;
1093
#define FF_ER_CAREFUL         1
1094
#define FF_ER_COMPLIANT       2
1095
#define FF_ER_AGGRESSIVE      3
1096
#define FF_ER_VERY_AGGRESSIVE 4
1097

    
1098
    /**
1099
     * Called at the beginning of each frame to get a buffer for it.
1100
     * If pic.reference is set then the frame will be read later by libavcodec.
1101
     * avcodec_align_dimensions() should be used to find the required width and
1102
     * height, as they normally need to be rounded up to the next multiple of 16.
1103
     * - encoding: unused
1104
     * - decoding: Set by libavcodec., user can override.
1105
     */
1106
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1107

    
1108
    /**
1109
     * Called to release buffers which where allocated with get_buffer.
1110
     * A released buffer can be reused in get_buffer().
1111
     * pic.data[*] must be set to NULL.
1112
     * - encoding: unused
1113
     * - decoding: Set by libavcodec., user can override.
1114
     */
1115
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1116

    
1117
    /**
1118
     * If 1 the stream has a 1 frame delay during decoding.
1119
     * - encoding: Set by libavcodec.
1120
     * - decoding: Set by libavcodec.
1121
     */
1122
    int has_b_frames;
1123

    
1124
    /**
1125
     * number of bytes per packet if constant and known or 0
1126
     * Used by some WAV based audio codecs.
1127
     */
1128
    int block_align;
1129

    
1130
    int parse_only; /* - decoding only: If true, only parsing is done
1131
                       (function avcodec_parse_frame()). The frame
1132
                       data is returned. Only MPEG codecs support this now. */
1133

    
1134
    /**
1135
     * 0-> h263 quant 1-> mpeg quant
1136
     * - encoding: Set by user.
1137
     * - decoding: unused
1138
     */
1139
    int mpeg_quant;
1140

    
1141
    /**
1142
     * pass1 encoding statistics output buffer
1143
     * - encoding: Set by libavcodec.
1144
     * - decoding: unused
1145
     */
1146
    char *stats_out;
1147

    
1148
    /**
1149
     * pass2 encoding statistics input buffer
1150
     * Concatenated stuff from stats_out of pass1 should be placed here.
1151
     * - encoding: Allocated/set/freed by user.
1152
     * - decoding: unused
1153
     */
1154
    char *stats_in;
1155

    
1156
    /**
1157
     * ratecontrol qmin qmax limiting method
1158
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1159
     * - encoding: Set by user.
1160
     * - decoding: unused
1161
     */
1162
    float rc_qsquish;
1163

    
1164
    float rc_qmod_amp;
1165
    int rc_qmod_freq;
1166

    
1167
    /**
1168
     * ratecontrol override, see RcOverride
1169
     * - encoding: Allocated/set/freed by user.
1170
     * - decoding: unused
1171
     */
1172
    RcOverride *rc_override;
1173
    int rc_override_count;
1174

    
1175
    /**
1176
     * rate control equation
1177
     * - encoding: Set by user
1178
     * - decoding: unused
1179
     */
1180
    char *rc_eq;
1181

    
1182
    /**
1183
     * maximum bitrate
1184
     * - encoding: Set by user.
1185
     * - decoding: unused
1186
     */
1187
    int rc_max_rate;
1188

    
1189
    /**
1190
     * minimum bitrate
1191
     * - encoding: Set by user.
1192
     * - decoding: unused
1193
     */
1194
    int rc_min_rate;
1195

    
1196
    /**
1197
     * decoder bitstream buffer size
1198
     * - encoding: Set by user.
1199
     * - decoding: unused
1200
     */
1201
    int rc_buffer_size;
1202
    float rc_buffer_aggressivity;
1203

    
1204
    /**
1205
     * qscale factor between P and I-frames
1206
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1207
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1208
     * - encoding: Set by user.
1209
     * - decoding: unused
1210
     */
1211
    float i_quant_factor;
1212

    
1213
    /**
1214
     * qscale offset between P and I-frames
1215
     * - encoding: Set by user.
1216
     * - decoding: unused
1217
     */
1218
    float i_quant_offset;
1219

    
1220
    /**
1221
     * initial complexity for pass1 ratecontrol
1222
     * - encoding: Set by user.
1223
     * - decoding: unused
1224
     */
1225
    float rc_initial_cplx;
1226

    
1227
    /**
1228
     * DCT algorithm, see FF_DCT_* below
1229
     * - encoding: Set by user.
1230
     * - decoding: unused
1231
     */
1232
    int dct_algo;
1233
#define FF_DCT_AUTO    0
1234
#define FF_DCT_FASTINT 1
1235
#define FF_DCT_INT     2
1236
#define FF_DCT_MMX     3
1237
#define FF_DCT_MLIB    4
1238
#define FF_DCT_ALTIVEC 5
1239
#define FF_DCT_FAAN    6
1240

    
1241
    /**
1242
     * luminance masking (0-> disabled)
1243
     * - encoding: Set by user.
1244
     * - decoding: unused
1245
     */
1246
    float lumi_masking;
1247

    
1248
    /**
1249
     * temporary complexity masking (0-> disabled)
1250
     * - encoding: Set by user.
1251
     * - decoding: unused
1252
     */
1253
    float temporal_cplx_masking;
1254

    
1255
    /**
1256
     * spatial complexity masking (0-> disabled)
1257
     * - encoding: Set by user.
1258
     * - decoding: unused
1259
     */
1260
    float spatial_cplx_masking;
1261

    
1262
    /**
1263
     * p block masking (0-> disabled)
1264
     * - encoding: Set by user.
1265
     * - decoding: unused
1266
     */
1267
    float p_masking;
1268

    
1269
    /**
1270
     * darkness masking (0-> disabled)
1271
     * - encoding: Set by user.
1272
     * - decoding: unused
1273
     */
1274
    float dark_masking;
1275

    
1276

    
1277
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1278
    /* for binary compatibility */
1279
    int unused;
1280
#endif
1281

    
1282
    /**
1283
     * IDCT algorithm, see FF_IDCT_* below.
1284
     * - encoding: Set by user.
1285
     * - decoding: Set by user.
1286
     */
1287
    int idct_algo;
1288
#define FF_IDCT_AUTO          0
1289
#define FF_IDCT_INT           1
1290
#define FF_IDCT_SIMPLE        2
1291
#define FF_IDCT_SIMPLEMMX     3
1292
#define FF_IDCT_LIBMPEG2MMX   4
1293
#define FF_IDCT_PS2           5
1294
#define FF_IDCT_MLIB          6
1295
#define FF_IDCT_ARM           7
1296
#define FF_IDCT_ALTIVEC       8
1297
#define FF_IDCT_SH4           9
1298
#define FF_IDCT_SIMPLEARM     10
1299
#define FF_IDCT_H264          11
1300
#define FF_IDCT_VP3           12
1301
#define FF_IDCT_IPP           13
1302
#define FF_IDCT_XVIDMMX       14
1303
#define FF_IDCT_CAVS          15
1304
#define FF_IDCT_SIMPLEARMV5TE 16
1305
#define FF_IDCT_SIMPLEARMV6   17
1306
#define FF_IDCT_SIMPLEVIS     18
1307
#define FF_IDCT_WMV2          19
1308

    
1309
    /**
1310
     * slice count
1311
     * - encoding: Set by libavcodec.
1312
     * - decoding: Set by user (or 0).
1313
     */
1314
    int slice_count;
1315
    /**
1316
     * slice offsets in the frame in bytes
1317
     * - encoding: Set/allocated by libavcodec.
1318
     * - decoding: Set/allocated by user (or NULL).
1319
     */
1320
    int *slice_offset;
1321

    
1322
    /**
1323
     * error concealment flags
1324
     * - encoding: unused
1325
     * - decoding: Set by user.
1326
     */
1327
    int error_concealment;
1328
#define FF_EC_GUESS_MVS   1
1329
#define FF_EC_DEBLOCK     2
1330

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

    
1352
    /**
1353
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1354
     * - encoding: Set by libavcodec.
1355
     * - decoding: Set by user.
1356
     */
1357
     int bits_per_sample;
1358

    
1359
    /**
1360
     * prediction method (needed for huffyuv)
1361
     * - encoding: Set by user.
1362
     * - decoding: unused
1363
     */
1364
     int prediction_method;
1365
#define FF_PRED_LEFT   0
1366
#define FF_PRED_PLANE  1
1367
#define FF_PRED_MEDIAN 2
1368

    
1369
    /**
1370
     * sample aspect ratio (0 if unknown)
1371
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1372
     * - encoding: Set by user.
1373
     * - decoding: Set by libavcodec.
1374
     */
1375
    AVRational sample_aspect_ratio;
1376

    
1377
    /**
1378
     * the picture in the bitstream
1379
     * - encoding: Set by libavcodec.
1380
     * - decoding: Set by libavcodec.
1381
     */
1382
    AVFrame *coded_frame;
1383

    
1384
    /**
1385
     * debug
1386
     * - encoding: Set by user.
1387
     * - decoding: Set by user.
1388
     */
1389
    int debug;
1390
#define FF_DEBUG_PICT_INFO   1
1391
#define FF_DEBUG_RC          2
1392
#define FF_DEBUG_BITSTREAM   4
1393
#define FF_DEBUG_MB_TYPE     8
1394
#define FF_DEBUG_QP          16
1395
#define FF_DEBUG_MV          32
1396
#define FF_DEBUG_DCT_COEFF   0x00000040
1397
#define FF_DEBUG_SKIP        0x00000080
1398
#define FF_DEBUG_STARTCODE   0x00000100
1399
#define FF_DEBUG_PTS         0x00000200
1400
#define FF_DEBUG_ER          0x00000400
1401
#define FF_DEBUG_MMCO        0x00000800
1402
#define FF_DEBUG_BUGS        0x00001000
1403
#define FF_DEBUG_VIS_QP      0x00002000
1404
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1405

    
1406
    /**
1407
     * debug
1408
     * - encoding: Set by user.
1409
     * - decoding: Set by user.
1410
     */
1411
    int debug_mv;
1412
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1413
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1414
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1415

    
1416
    /**
1417
     * error
1418
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1419
     * - decoding: unused
1420
     */
1421
    uint64_t error[4];
1422

    
1423
    /**
1424
     * minimum MB quantizer
1425
     * - encoding: unused
1426
     * - decoding: unused
1427
     */
1428
    int mb_qmin;
1429

    
1430
    /**
1431
     * maximum MB quantizer
1432
     * - encoding: unused
1433
     * - decoding: unused
1434
     */
1435
    int mb_qmax;
1436

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

    
1478
    /**
1479
     * ME diamond size & shape
1480
     * - encoding: Set by user.
1481
     * - decoding: unused
1482
     */
1483
    int dia_size;
1484

    
1485
    /**
1486
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1487
     * - encoding: Set by user.
1488
     * - decoding: unused
1489
     */
1490
    int last_predictor_count;
1491

    
1492
    /**
1493
     * prepass for motion estimation
1494
     * - encoding: Set by user.
1495
     * - decoding: unused
1496
     */
1497
    int pre_me;
1498

    
1499
    /**
1500
     * motion estimation prepass comparison function
1501
     * - encoding: Set by user.
1502
     * - decoding: unused
1503
     */
1504
    int me_pre_cmp;
1505

    
1506
    /**
1507
     * ME prepass diamond size & shape
1508
     * - encoding: Set by user.
1509
     * - decoding: unused
1510
     */
1511
    int pre_dia_size;
1512

    
1513
    /**
1514
     * subpel ME quality
1515
     * - encoding: Set by user.
1516
     * - decoding: unused
1517
     */
1518
    int me_subpel_quality;
1519

    
1520
    /**
1521
     * callback to negotiate the pixelFormat
1522
     * @param fmt is the list of formats which are supported by the codec,
1523
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1524
     * The first is always the native one.
1525
     * @return the chosen format
1526
     * - encoding: unused
1527
     * - decoding: Set by user, if not set the native format will be chosen.
1528
     */
1529
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1530

    
1531
    /**
1532
     * DTG active format information (additional aspect ratio
1533
     * information only used in DVB MPEG-2 transport streams)
1534
     * 0 if not set.
1535
     *
1536
     * - encoding: unused
1537
     * - decoding: Set by decoder.
1538
     */
1539
    int dtg_active_format;
1540
#define FF_DTG_AFD_SAME         8
1541
#define FF_DTG_AFD_4_3          9
1542
#define FF_DTG_AFD_16_9         10
1543
#define FF_DTG_AFD_14_9         11
1544
#define FF_DTG_AFD_4_3_SP_14_9  13
1545
#define FF_DTG_AFD_16_9_SP_14_9 14
1546
#define FF_DTG_AFD_SP_4_3       15
1547

    
1548
    /**
1549
     * maximum motion estimation search range in subpel units
1550
     * If 0 then no limit.
1551
     *
1552
     * - encoding: Set by user.
1553
     * - decoding: unused
1554
     */
1555
    int me_range;
1556

    
1557
    /**
1558
     * intra quantizer bias
1559
     * - encoding: Set by user.
1560
     * - decoding: unused
1561
     */
1562
    int intra_quant_bias;
1563
#define FF_DEFAULT_QUANT_BIAS 999999
1564

    
1565
    /**
1566
     * inter quantizer bias
1567
     * - encoding: Set by user.
1568
     * - decoding: unused
1569
     */
1570
    int inter_quant_bias;
1571

    
1572
    /**
1573
     * color table ID
1574
     * - encoding: unused
1575
     * - decoding: Which clrtable should be used for 8bit RGB images.
1576
     *             Tables have to be stored somewhere. FIXME
1577
     */
1578
    int color_table_id;
1579

    
1580
    /**
1581
     * internal_buffer count
1582
     * Don't touch, used by libavcodec default_get_buffer().
1583
     */
1584
    int internal_buffer_count;
1585

    
1586
    /**
1587
     * internal_buffers
1588
     * Don't touch, used by libavcodec default_get_buffer().
1589
     */
1590
    void *internal_buffer;
1591

    
1592
#define FF_LAMBDA_SHIFT 7
1593
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1594
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1595
#define FF_LAMBDA_MAX (256*128-1)
1596

    
1597
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1598
    /**
1599
     * Global quality for codecs which cannot change it per frame.
1600
     * This should be proportional to MPEG-1/2/4 qscale.
1601
     * - encoding: Set by user.
1602
     * - decoding: unused
1603
     */
1604
    int global_quality;
1605

    
1606
#define FF_CODER_TYPE_VLC       0
1607
#define FF_CODER_TYPE_AC        1
1608
#define FF_CODER_TYPE_RAW       2
1609
#define FF_CODER_TYPE_RLE       3
1610
#define FF_CODER_TYPE_DEFLATE   4
1611
    /**
1612
     * coder type
1613
     * - encoding: Set by user.
1614
     * - decoding: unused
1615
     */
1616
    int coder_type;
1617

    
1618
    /**
1619
     * context model
1620
     * - encoding: Set by user.
1621
     * - decoding: unused
1622
     */
1623
    int context_model;
1624
#if 0
1625
    /**
1626
     *
1627
     * - encoding: unused
1628
     * - decoding: Set by user.
1629
     */
1630
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1631
#endif
1632

    
1633
    /**
1634
     * slice flags
1635
     * - encoding: unused
1636
     * - decoding: Set by user.
1637
     */
1638
    int slice_flags;
1639
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1640
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1641
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1642

    
1643
    /**
1644
     * XVideo Motion Acceleration
1645
     * - encoding: forbidden
1646
     * - decoding: set by decoder
1647
     */
1648
    int xvmc_acceleration;
1649

    
1650
    /**
1651
     * macroblock decision mode
1652
     * - encoding: Set by user.
1653
     * - decoding: unused
1654
     */
1655
    int mb_decision;
1656
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1657
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1658
#define FF_MB_DECISION_RD     2        ///< rate distoration
1659

    
1660
    /**
1661
     * custom intra quantization matrix
1662
     * - encoding: Set by user, can be NULL.
1663
     * - decoding: Set by libavcodec.
1664
     */
1665
    uint16_t *intra_matrix;
1666

    
1667
    /**
1668
     * custom inter quantization matrix
1669
     * - encoding: Set by user, can be NULL.
1670
     * - decoding: Set by libavcodec.
1671
     */
1672
    uint16_t *inter_matrix;
1673

    
1674
    /**
1675
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1676
     * This is used to work around some encoder bugs.
1677
     * - encoding: unused
1678
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1679
     */
1680
    unsigned int stream_codec_tag;
1681

    
1682
    /**
1683
     * scene change detection threshold
1684
     * 0 is default, larger means fewer detected scene changes.
1685
     * - encoding: Set by user.
1686
     * - decoding: unused
1687
     */
1688
    int scenechange_threshold;
1689

    
1690
    /**
1691
     * minimum Lagrange multipler
1692
     * - encoding: Set by user.
1693
     * - decoding: unused
1694
     */
1695
    int lmin;
1696

    
1697
    /**
1698
     * maximum Lagrange multipler
1699
     * - encoding: Set by user.
1700
     * - decoding: unused
1701
     */
1702
    int lmax;
1703

    
1704
    /**
1705
     * palette control structure
1706
     * - encoding: ??? (no palette-enabled encoder yet)
1707
     * - decoding: Set by user.
1708
     */
1709
    struct AVPaletteControl *palctrl;
1710

    
1711
    /**
1712
     * noise reduction strength
1713
     * - encoding: Set by user.
1714
     * - decoding: unused
1715
     */
1716
    int noise_reduction;
1717

    
1718
    /**
1719
     * Called at the beginning of a frame to get cr buffer for it.
1720
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1721
     * libavcodec will pass previous buffer in pic, function should return
1722
     * same buffer or new buffer with old frame "painted" into it.
1723
     * If pic.data[0] == NULL must behave like get_buffer().
1724
     * - encoding: unused
1725
     * - decoding: Set by libavcodec., user can override
1726
     */
1727
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1728

    
1729
    /**
1730
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1731
     * - encoding: Set by user.
1732
     * - decoding: unused
1733
     */
1734
    int rc_initial_buffer_occupancy;
1735

    
1736
    /**
1737
     *
1738
     * - encoding: Set by user.
1739
     * - decoding: unused
1740
     */
1741
    int inter_threshold;
1742

    
1743
    /**
1744
     * CODEC_FLAG2_*
1745
     * - encoding: Set by user.
1746
     * - decoding: Set by user.
1747
     */
1748
    int flags2;
1749

    
1750
    /**
1751
     * Simulates errors in the bitstream to test error concealment.
1752
     * - encoding: Set by user.
1753
     * - decoding: unused
1754
     */
1755
    int error_rate;
1756

    
1757
    /**
1758
     * MP3 antialias algorithm, see FF_AA_* below.
1759
     * - encoding: unused
1760
     * - decoding: Set by user.
1761
     */
1762
    int antialias_algo;
1763
#define FF_AA_AUTO    0
1764
#define FF_AA_FASTINT 1 //not implemented yet
1765
#define FF_AA_INT     2
1766
#define FF_AA_FLOAT   3
1767
    /**
1768
     * quantizer noise shaping
1769
     * - encoding: Set by user.
1770
     * - decoding: unused
1771
     */
1772
    int quantizer_noise_shaping;
1773

    
1774
    /**
1775
     * thread count
1776
     * is used to decide how many independent tasks should be passed to execute()
1777
     * - encoding: Set by user.
1778
     * - decoding: Set by user.
1779
     */
1780
    int thread_count;
1781

    
1782
    /**
1783
     * The codec may call this to execute several independent things.
1784
     * It will return only after finishing all tasks.
1785
     * The user may replace this with some multithreaded implementation,
1786
     * the default implementation will execute the parts serially.
1787
     * @param count the number of things to execute
1788
     * - encoding: Set by libavcodec, user can override.
1789
     * - decoding: Set by libavcodec, user can override.
1790
     */
1791
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1792

    
1793
    /**
1794
     * thread opaque
1795
     * Can be used by execute() to store some per AVCodecContext stuff.
1796
     * - encoding: set by execute()
1797
     * - decoding: set by execute()
1798
     */
1799
    void *thread_opaque;
1800

    
1801
    /**
1802
     * Motion estimation threshold below which no motion estimation is
1803
     * performed, but instead the user specified motion vectors are used.
1804
     *
1805
     * - encoding: Set by user.
1806
     * - decoding: unused
1807
     */
1808
     int me_threshold;
1809

    
1810
    /**
1811
     * Macroblock threshold below which the user specified macroblock types will be used.
1812
     * - encoding: Set by user.
1813
     * - decoding: unused
1814
     */
1815
     int mb_threshold;
1816

    
1817
    /**
1818
     * precision of the intra DC coefficient - 8
1819
     * - encoding: Set by user.
1820
     * - decoding: unused
1821
     */
1822
     int intra_dc_precision;
1823

    
1824
    /**
1825
     * noise vs. sse weight for the nsse comparsion function
1826
     * - encoding: Set by user.
1827
     * - decoding: unused
1828
     */
1829
     int nsse_weight;
1830

    
1831
    /**
1832
     * Number of macroblock rows at the top which are skipped.
1833
     * - encoding: unused
1834
     * - decoding: Set by user.
1835
     */
1836
     int skip_top;
1837

    
1838
    /**
1839
     * Number of macroblock rows at the bottom which are skipped.
1840
     * - encoding: unused
1841
     * - decoding: Set by user.
1842
     */
1843
     int skip_bottom;
1844

    
1845
    /**
1846
     * profile
1847
     * - encoding: Set by user.
1848
     * - decoding: Set by libavcodec.
1849
     */
1850
     int profile;
1851
#define FF_PROFILE_UNKNOWN -99
1852
#define FF_PROFILE_AAC_MAIN 0
1853
#define FF_PROFILE_AAC_LOW  1
1854
#define FF_PROFILE_AAC_SSR  2
1855
#define FF_PROFILE_AAC_LTP  3
1856

    
1857
    /**
1858
     * level
1859
     * - encoding: Set by user.
1860
     * - decoding: Set by libavcodec.
1861
     */
1862
     int level;
1863
#define FF_LEVEL_UNKNOWN -99
1864

    
1865
    /**
1866
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1867
     * - encoding: unused
1868
     * - decoding: Set by user.
1869
     */
1870
     int lowres;
1871

    
1872
    /**
1873
     * Bitstream width / height, may be different from width/height if lowres
1874
     * or other things are used.
1875
     * - encoding: unused
1876
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1877
     */
1878
    int coded_width, coded_height;
1879

    
1880
    /**
1881
     * frame skip threshold
1882
     * - encoding: Set by user.
1883
     * - decoding: unused
1884
     */
1885
    int frame_skip_threshold;
1886

    
1887
    /**
1888
     * frame skip factor
1889
     * - encoding: Set by user.
1890
     * - decoding: unused
1891
     */
1892
    int frame_skip_factor;
1893

    
1894
    /**
1895
     * frame skip exponent
1896
     * - encoding: Set by user.
1897
     * - decoding: unused
1898
     */
1899
    int frame_skip_exp;
1900

    
1901
    /**
1902
     * frame skip comparison function
1903
     * - encoding: Set by user.
1904
     * - decoding: unused
1905
     */
1906
    int frame_skip_cmp;
1907

    
1908
    /**
1909
     * Border processing masking, raises the quantizer for mbs on the borders
1910
     * of the picture.
1911
     * - encoding: Set by user.
1912
     * - decoding: unused
1913
     */
1914
    float border_masking;
1915

    
1916
    /**
1917
     * minimum MB lagrange multipler
1918
     * - encoding: Set by user.
1919
     * - decoding: unused
1920
     */
1921
    int mb_lmin;
1922

    
1923
    /**
1924
     * maximum MB lagrange multipler
1925
     * - encoding: Set by user.
1926
     * - decoding: unused
1927
     */
1928
    int mb_lmax;
1929

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

    
1937
    /**
1938
     *
1939
     * - encoding: unused
1940
     * - decoding: Set by user.
1941
     */
1942
    enum AVDiscard skip_loop_filter;
1943

    
1944
    /**
1945
     *
1946
     * - encoding: unused
1947
     * - decoding: Set by user.
1948
     */
1949
    enum AVDiscard skip_idct;
1950

    
1951
    /**
1952
     *
1953
     * - encoding: unused
1954
     * - decoding: Set by user.
1955
     */
1956
    enum AVDiscard skip_frame;
1957

    
1958
    /**
1959
     *
1960
     * - encoding: Set by user.
1961
     * - decoding: unused
1962
     */
1963
    int bidir_refine;
1964

    
1965
    /**
1966
     *
1967
     * - encoding: Set by user.
1968
     * - decoding: unused
1969
     */
1970
    int brd_scale;
1971

    
1972
    /**
1973
     * constant rate factor - quality-based VBR - values ~correspond to qps
1974
     * - encoding: Set by user.
1975
     * - decoding: unused
1976
     */
1977
    float crf;
1978

    
1979
    /**
1980
     * constant quantization parameter rate control method
1981
     * - encoding: Set by user.
1982
     * - decoding: unused
1983
     */
1984
    int cqp;
1985

    
1986
    /**
1987
     * minimum GOP size
1988
     * - encoding: Set by user.
1989
     * - decoding: unused
1990
     */
1991
    int keyint_min;
1992

    
1993
    /**
1994
     * number of reference frames
1995
     * - encoding: Set by user.
1996
     * - decoding: unused
1997
     */
1998
    int refs;
1999

    
2000
    /**
2001
     * chroma qp offset from luma
2002
     * - encoding: Set by user.
2003
     * - decoding: unused
2004
     */
2005
    int chromaoffset;
2006

    
2007
    /**
2008
     * Influences how often B-frames are used.
2009
     * - encoding: Set by user.
2010
     * - decoding: unused
2011
     */
2012
    int bframebias;
2013

    
2014
    /**
2015
     * trellis RD quantization
2016
     * - encoding: Set by user.
2017
     * - decoding: unused
2018
     */
2019
    int trellis;
2020

    
2021
    /**
2022
     * Reduce fluctuations in qp (before curve compression).
2023
     * - encoding: Set by user.
2024
     * - decoding: unused
2025
     */
2026
    float complexityblur;
2027

    
2028
    /**
2029
     * in-loop deblocking filter alphac0 parameter
2030
     * alpha is in the range -6...6
2031
     * - encoding: Set by user.
2032
     * - decoding: unused
2033
     */
2034
    int deblockalpha;
2035

    
2036
    /**
2037
     * in-loop deblocking filter beta parameter
2038
     * beta is in the range -6...6
2039
     * - encoding: Set by user.
2040
     * - decoding: unused
2041
     */
2042
    int deblockbeta;
2043

    
2044
    /**
2045
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2046
     * - encoding: Set by user.
2047
     * - decoding: unused
2048
     */
2049
    int partitions;
2050
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2051
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2052
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2053
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2054
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2055

    
2056
    /**
2057
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2058
     * - encoding: Set by user.
2059
     * - decoding: unused
2060
     */
2061
    int directpred;
2062

    
2063
    /**
2064
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2065
     * - encoding: Set by user.
2066
     * - decoding: unused
2067
     */
2068
    int cutoff;
2069

    
2070
    /**
2071
     * Multiplied by qscale for each frame and added to scene_change_score.
2072
     * - encoding: Set by user.
2073
     * - decoding: unused
2074
     */
2075
    int scenechange_factor;
2076

    
2077
    /**
2078
     *
2079
     * Note: Value depends upon the compare function used for fullpel ME.
2080
     * - encoding: Set by user.
2081
     * - decoding: unused
2082
     */
2083
    int mv0_threshold;
2084

    
2085
    /**
2086
     * Adjusts sensitivity of b_frame_strategy 1.
2087
     * - encoding: Set by user.
2088
     * - decoding: unused
2089
     */
2090
    int b_sensitivity;
2091

    
2092
    /**
2093
     * - encoding: Set by user.
2094
     * - decoding: unused
2095
     */
2096
    int compression_level;
2097
#define FF_COMPRESSION_DEFAULT -1
2098

    
2099
    /**
2100
     * Sets whether to use LPC mode - used by FLAC encoder.
2101
     * - encoding: Set by user.
2102
     * - decoding: unused
2103
     */
2104
    int use_lpc;
2105

    
2106
    /**
2107
     * LPC coefficient precision - used by FLAC encoder
2108
     * - encoding: Set by user.
2109
     * - decoding: unused
2110
     */
2111
    int lpc_coeff_precision;
2112

    
2113
    /**
2114
     * - encoding: Set by user.
2115
     * - decoding: unused
2116
     */
2117
    int min_prediction_order;
2118

    
2119
    /**
2120
     * - encoding: Set by user.
2121
     * - decoding: unused
2122
     */
2123
    int max_prediction_order;
2124

    
2125
    /**
2126
     * search method for selecting prediction order
2127
     * - encoding: Set by user.
2128
     * - decoding: unused
2129
     */
2130
    int prediction_order_method;
2131

    
2132
    /**
2133
     * - encoding: Set by user.
2134
     * - decoding: unused
2135
     */
2136
    int min_partition_order;
2137

    
2138
    /**
2139
     * - encoding: Set by user.
2140
     * - decoding: unused
2141
     */
2142
    int max_partition_order;
2143

    
2144
    /**
2145
     * GOP timecode frame start number, in non drop frame format
2146
     * - encoding: Set by user.
2147
     * - decoding: unused
2148
     */
2149
    int64_t timecode_frame_start;
2150

    
2151
    /**
2152
     * Decoder should decode to this many channels if it can (0 for default)
2153
     * - encoding: unused
2154
     * - decoding: Set by user.
2155
     */
2156
    int request_channels;
2157
} AVCodecContext;
2158

    
2159
/**
2160
 * AVCodec.
2161
 */
2162
typedef struct AVCodec {
2163
    /**
2164
     * Name of the codec implementation.
2165
     * The name is globally unique among encoders and among decoders (but an
2166
     * encoder and a decoder can share the same name).
2167
     * This is the primary way to find a codec from the user perspective.
2168
     */
2169
    const char *name;
2170
    enum CodecType type;
2171
    enum CodecID id;
2172
    int priv_data_size;
2173
    int (*init)(AVCodecContext *);
2174
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2175
    int (*close)(AVCodecContext *);
2176
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2177
                  uint8_t *buf, int buf_size);
2178
    int capabilities;
2179
    struct AVCodec *next;
2180
    void (*flush)(AVCodecContext *);
2181
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2182
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2183
} AVCodec;
2184

    
2185
/**
2186
 * four components are given, that's all.
2187
 * the last component is alpha
2188
 */
2189
typedef struct AVPicture {
2190
    uint8_t *data[4];
2191
    int linesize[4];       ///< number of bytes per line
2192
} AVPicture;
2193

    
2194
/**
2195
 * AVPaletteControl
2196
 * This structure defines a method for communicating palette changes
2197
 * between and demuxer and a decoder.
2198
 *
2199
 * @deprecated Use AVPacket to send palette changes instead.
2200
 * This is totally broken.
2201
 */
2202
#define AVPALETTE_SIZE 1024
2203
#define AVPALETTE_COUNT 256
2204
typedef struct AVPaletteControl {
2205

    
2206
    /* Demuxer sets this to 1 to indicate the palette has changed;
2207
     * decoder resets to 0. */
2208
    int palette_changed;
2209

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

    
2216
} AVPaletteControl attribute_deprecated;
2217

    
2218
typedef struct AVSubtitleRect {
2219
    uint16_t x;
2220
    uint16_t y;
2221
    uint16_t w;
2222
    uint16_t h;
2223
    uint16_t nb_colors;
2224
    int linesize;
2225
    uint32_t *rgba_palette;
2226
    uint8_t *bitmap;
2227
} AVSubtitleRect;
2228

    
2229
typedef struct AVSubtitle {
2230
    uint16_t format; /* 0 = graphics */
2231
    uint32_t start_display_time; /* relative to packet pts, in ms */
2232
    uint32_t end_display_time; /* relative to packet pts, in ms */
2233
    uint32_t num_rects;
2234
    AVSubtitleRect *rects;
2235
} AVSubtitle;
2236

    
2237

    
2238
/* resample.c */
2239

    
2240
struct ReSampleContext;
2241
struct AVResampleContext;
2242

    
2243
typedef struct ReSampleContext ReSampleContext;
2244

    
2245
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2246
                                     int output_rate, int input_rate);
2247
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2248
void audio_resample_close(ReSampleContext *s);
2249

    
2250
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2251
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2252
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2253
void av_resample_close(struct AVResampleContext *c);
2254

    
2255
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2256
/* YUV420 format is assumed ! */
2257

    
2258
/**
2259
 * @deprecated Use the software scaler (swscale) instead.
2260
 */
2261
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2262

    
2263
/**
2264
 * @deprecated Use the software scaler (swscale) instead.
2265
 */
2266
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2267
                                      int input_width, int input_height);
2268

    
2269
/**
2270
 * @deprecated Use the software scaler (swscale) instead.
2271
 */
2272
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2273
                                      int iwidth, int iheight,
2274
                                      int topBand, int bottomBand,
2275
                                      int leftBand, int rightBand,
2276
                                      int padtop, int padbottom,
2277
                                      int padleft, int padright);
2278

    
2279
/**
2280
 * @deprecated Use the software scaler (swscale) instead.
2281
 */
2282
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2283
                  AVPicture *output, const AVPicture *input);
2284

    
2285
/**
2286
 * @deprecated Use the software scaler (swscale) instead.
2287
 */
2288
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2289

    
2290
#endif
2291

    
2292
/**
2293
 * Allocate memory for a picture.  Call avpicture_free to free it.
2294
 *
2295
 * @param picture the picture to be filled in
2296
 * @param pix_fmt the format of the picture
2297
 * @param width the width of the picture
2298
 * @param height the height of the picture
2299
 * @return zero if successful, a negative value if not
2300
 */
2301
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2302

    
2303
/**
2304
 * Free a picture previously allocated by avpicture_alloc().
2305
 *
2306
 * @param picture the AVPicture to be freed
2307
 */
2308
void avpicture_free(AVPicture *picture);
2309

    
2310
/**
2311
 * Fill in the AVPicture fields.
2312
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2313
 * which points to the image data buffer. Depending on the specified picture
2314
 * format, one or multiple image data pointers and line sizes will be set.
2315
 * If a planar format is specified, several pointers will be set pointing to
2316
 * the different picture planes and the line sizes of the different planes
2317
 * will be stored in the lines_sizes array.
2318
 *
2319
 * @param picture AVPicture whose fields are to be filled in
2320
 * @param ptr Buffer which will contain or contains the actual image data
2321
 * @param pix_fmt The format in which the picture data is stored.
2322
 * @param width the width of the image in pixels
2323
 * @param height the height of the image in pixels
2324
 * @return size of the image data in bytes
2325
 */
2326
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2327
                   int pix_fmt, int width, int height);
2328
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2329
                     unsigned char *dest, int dest_size);
2330

    
2331
/**
2332
 * Calculate the size in bytes that a picture of the given width and height
2333
 * would occupy if stored in the given picture format.
2334
 *
2335
 * @param pix_fmt the given picture format
2336
 * @param width the width of the image
2337
 * @param height the height of the image
2338
 * @return Image data size in bytes
2339
 */
2340
int avpicture_get_size(int pix_fmt, int width, int height);
2341
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2342
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2343
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2344
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2345
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2346

    
2347
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2348
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2349
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2350
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2351
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2352
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2353

    
2354
/**
2355
 * Computes what kind of losses will occur when converting from one specific
2356
 * pixel format to another.
2357
 * When converting from one pixel format to another, information loss may occur.
2358
 * For example, when converting from RGB24 to GRAY, the color information will
2359
 * be lost. Similarly, other losses occur when converting from some formats to
2360
 * other formats. These losses can involve loss of chroma, but also loss of
2361
 * resolution, loss of color depth, loss due to the color space conversion, loss
2362
 * of the alpha bits or loss due to color quantization.
2363
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2364
 * which will occur when converting from one pixel format to another.
2365
 *
2366
 * @param[in] dst_pix_fmt destination pixel format
2367
 * @param[in] src_pix_fmt source pixel format
2368
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2369
 * @return Combination of flags informing you what kind of losses will occur.
2370
 */
2371
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2372
                             int has_alpha);
2373

    
2374
/**
2375
 * Finds the best pixel format to convert to given a certain source pixel
2376
 * format.  When converting from one pixel format to another, information loss
2377
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2378
 * information will be lost. Similarly, other losses occur when converting from
2379
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2380
 * the given pixel formats should be used to suffer the least amount of loss.
2381
 * The pixel formats from which it chooses one, are determined by the
2382
 * \p pix_fmt_mask parameter.
2383
 *
2384
 * @code
2385
 * src_pix_fmt = PIX_FMT_YUV420P;
2386
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2387
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2388
 * @endcode
2389
 *
2390
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2391
 * @param[in] src_pix_fmt source pixel format
2392
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2393
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2394
 * @return The best pixel format to convert to or -1 if none was found.
2395
 */
2396
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2397
                              int has_alpha, int *loss_ptr);
2398

    
2399

    
2400
/**
2401
 * Print in buf the string corresponding to the pixel format with
2402
 * number pix_fmt, or an header if pix_fmt is negative.
2403
 *
2404
 * @param[in] buf the buffer where to write the string
2405
 * @param[in] buf_size the size of buf
2406
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2407
 * a negative value to print the corresponding header.
2408
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2409
 */
2410
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2411

    
2412
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2413
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2414

    
2415
/**
2416
 * Tell if an image really has transparent alpha values.
2417
 * @return ored mask of FF_ALPHA_xxx constants
2418
 */
2419
int img_get_alpha_info(const AVPicture *src,
2420
                       int pix_fmt, int width, int height);
2421

    
2422
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2423
/**
2424
 * convert among pixel formats
2425
 * @deprecated Use the software scaler (swscale) instead.
2426
 */
2427
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2428
                const AVPicture *src, int pix_fmt,
2429
                int width, int height);
2430
#endif
2431

    
2432
/* deinterlace a picture */
2433
/* deinterlace - if not supported return -1 */
2434
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2435
                          int pix_fmt, int width, int height);
2436

    
2437
/* external high level API */
2438

    
2439
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2440
extern AVCodec *first_avcodec;
2441
#endif
2442
AVCodec *av_codec_next(AVCodec *c);
2443

    
2444
/* returns LIBAVCODEC_VERSION_INT constant */
2445
unsigned avcodec_version(void);
2446
/* returns LIBAVCODEC_BUILD constant */
2447
unsigned avcodec_build(void);
2448

    
2449
/**
2450
 * Initializes libavcodec.
2451
 *
2452
 * @warning This function \e must be called before any other libavcodec
2453
 * function.
2454
 */
2455
void avcodec_init(void);
2456

    
2457
void register_avcodec(AVCodec *format);
2458

    
2459
/**
2460
 * Finds a registered encoder with a matching codec ID.
2461
 *
2462
 * @param id CodecID of the requested encoder
2463
 * @return An encoder if one was found, NULL otherwise.
2464
 */
2465
AVCodec *avcodec_find_encoder(enum CodecID id);
2466

    
2467
/**
2468
 * Finds a registered encoder with the specified name.
2469
 *
2470
 * @param name name of the requested encoder
2471
 * @return An encoder if one was found, NULL otherwise.
2472
 */
2473
AVCodec *avcodec_find_encoder_by_name(const char *name);
2474

    
2475
/**
2476
 * Finds a registered decoder with a matching codec ID.
2477
 *
2478
 * @param id CodecID of the requested decoder
2479
 * @return A decoder if one was found, NULL otherwise.
2480
 */
2481
AVCodec *avcodec_find_decoder(enum CodecID id);
2482

    
2483
/**
2484
 * Finds a registered decoder with the specified name.
2485
 *
2486
 * @param name name of the requested decoder
2487
 * @return A decoder if one was found, NULL otherwise.
2488
 */
2489
AVCodec *avcodec_find_decoder_by_name(const char *name);
2490
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2491

    
2492
/**
2493
 * Sets the fields of the given AVCodecContext to default values.
2494
 *
2495
 * @param s The AVCodecContext of which the fields should be set to default values.
2496
 */
2497
void avcodec_get_context_defaults(AVCodecContext *s);
2498

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

    
2503
/**
2504
 * Allocates an AVCodecContext and sets its fields to default values.  The
2505
 * resulting struct can be deallocated by simply calling av_free().
2506
 *
2507
 * @return An AVCodecContext filled with default values or NULL on failure.
2508
 * @see avcodec_get_context_defaults
2509
 */
2510
AVCodecContext *avcodec_alloc_context(void);
2511

    
2512
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2513
 *  we WILL change its arguments and name a few times! */
2514
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2515

    
2516
/**
2517
 * Sets the fields of the given AVFrame to default values.
2518
 *
2519
 * @param pic The AVFrame of which the fields should be set to default values.
2520
 */
2521
void avcodec_get_frame_defaults(AVFrame *pic);
2522

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

    
2532
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2533
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2534
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2535
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2536

    
2537
/**
2538
 * Checks if the given dimension of a picture is valid, meaning that all
2539
 * bytes of the picture can be addressed with a signed int.
2540
 *
2541
 * @param[in] w Width of the picture.
2542
 * @param[in] h Height of the picture.
2543
 * @return Zero if valid, a negative value if invalid.
2544
 */
2545
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2546
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2547

    
2548
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2549
void avcodec_thread_free(AVCodecContext *s);
2550
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2551
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2552
//FIXME func typedef
2553

    
2554
/**
2555
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2556
 * function the context has to be allocated.
2557
 *
2558
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2559
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2560
 * retrieving a codec.
2561
 *
2562
 * @warning This function is not thread safe!
2563
 *
2564
 * @code
2565
 * avcodec_register_all();
2566
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2567
 * if (!codec)
2568
 *     exit(1);
2569
 *
2570
 * context = avcodec_alloc_context();
2571
 *
2572
 * if (avcodec_open(context, codec) < 0)
2573
 *     exit(1);
2574
 * @endcode
2575
 *
2576
 * @param avctx The context which will be set up to use the given codec.
2577
 * @param codec The codec to use within the context.
2578
 * @return zero on success, a negative value on error
2579
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2580
 */
2581
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2582

    
2583
/**
2584
 * @deprecated Use avcodec_decode_audio2() instead.
2585
 */
2586
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2587
                         int *frame_size_ptr,
2588
                         uint8_t *buf, int buf_size);
2589

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

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

    
2665
/* Decode a subtitle message. Return -1 if error, otherwise return the
2666
 * number of bytes used. If no subtitle could be decompressed,
2667
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2668
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2669
                            int *got_sub_ptr,
2670
                            const uint8_t *buf, int buf_size);
2671
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2672
                        int *data_size_ptr,
2673
                        uint8_t *buf, int buf_size);
2674

    
2675
/**
2676
 * Encodes an audio frame from \p samples into \p buf.
2677
 * The avcodec_encode_audio() function encodes an audio frame from the input
2678
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2679
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2680
 * stored in output buffer \p buf.
2681
 *
2682
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2683
 *
2684
 * @param avctx the codec context
2685
 * @param[out] buf the output buffer
2686
 * @param[in] buf_size the output buffer size
2687
 * @param[in] samples the input buffer containing the samples
2688
 * The number of samples read from this buffer is frame_size*channels,
2689
 * both of which are defined in \p avctx.
2690
 * @return On error a negative value is returned, on success zero or the number
2691
 * of bytes used to encode the data read from the input buffer.
2692
 */
2693
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2694
                         const short *samples);
2695

    
2696
/**
2697
 * Encodes a video frame from \p pict into \p buf.
2698
 * The avcodec_encode_video() function encodes a video frame from the input
2699
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2700
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2701
 * frame are stored in the output buffer \p buf. The input picture should be
2702
 * stored using a specific format, namely \c avctx.pix_fmt.
2703
 *
2704
 * @param avctx the codec context
2705
 * @param[out] buf the output buffer for the bitstream of encoded frame
2706
 * @param[in] buf_size the size of the output buffer in bytes
2707
 * @param[in] pict the input picture to encode
2708
 * @return On error a negative value is returned, on success zero or the number
2709
 * of bytes used from the input buffer.
2710
 */
2711
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2712
                         const AVFrame *pict);
2713
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2714
                            const AVSubtitle *sub);
2715

    
2716
int avcodec_close(AVCodecContext *avctx);
2717

    
2718
void avcodec_register_all(void);
2719

    
2720
/**
2721
 * Flush buffers, should be called when seeking or when switching to a different stream.
2722
 */
2723
void avcodec_flush_buffers(AVCodecContext *avctx);
2724

    
2725
void avcodec_default_free_buffers(AVCodecContext *s);
2726

    
2727
/* misc useful functions */
2728

    
2729
/**
2730
 * Returns a single letter to describe the given picture type \p pict_type.
2731
 *
2732
 * @param[in] pict_type the picture type
2733
 * @return A single character representing the picture type.
2734
 */
2735
char av_get_pict_type_char(int pict_type);
2736

    
2737
/**
2738
 * Returns codec bits per sample.
2739
 *
2740
 * @param[in] codec_id the codec
2741
 * @return Number of bits per sample or zero if unknown for the given codec.
2742
 */
2743
int av_get_bits_per_sample(enum CodecID codec_id);
2744

    
2745
/**
2746
 * Returns sample format bits per sample.
2747
 *
2748
 * @param[in] sample_fmt the sample format
2749
 * @return Number of bits per sample or zero if unknown for the given sample format.
2750
 */
2751
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2752

    
2753
/* frame parsing */
2754
typedef struct AVCodecParserContext {
2755
    void *priv_data;
2756
    struct AVCodecParser *parser;
2757
    int64_t frame_offset; /* offset of the current frame */
2758
    int64_t cur_offset; /* current offset
2759
                           (incremented by each av_parser_parse()) */
2760
    int64_t last_frame_offset; /* offset of the last frame */
2761
    /* video info */
2762
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2763
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2764
    int64_t pts;     /* pts of the current frame */
2765
    int64_t dts;     /* dts of the current frame */
2766

    
2767
    /* private data */
2768
    int64_t last_pts;
2769
    int64_t last_dts;
2770
    int fetch_timestamp;
2771

    
2772
#define AV_PARSER_PTS_NB 4
2773
    int cur_frame_start_index;
2774
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2775
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2776
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2777

    
2778
    int flags;
2779
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2780

    
2781
    int64_t offset;      ///< byte offset from starting packet start
2782
    int64_t last_offset;
2783
} AVCodecParserContext;
2784

    
2785
typedef struct AVCodecParser {
2786
    int codec_ids[5]; /* several codec IDs are permitted */
2787
    int priv_data_size;
2788
    int (*parser_init)(AVCodecParserContext *s);
2789
    int (*parser_parse)(AVCodecParserContext *s,
2790
                        AVCodecContext *avctx,
2791
                        const uint8_t **poutbuf, int *poutbuf_size,
2792
                        const uint8_t *buf, int buf_size);
2793
    void (*parser_close)(AVCodecParserContext *s);
2794
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2795
    struct AVCodecParser *next;
2796
} AVCodecParser;
2797

    
2798
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2799
extern AVCodecParser *av_first_parser;
2800
#endif
2801
AVCodecParser *av_parser_next(AVCodecParser *c);
2802

    
2803
void av_register_codec_parser(AVCodecParser *parser);
2804
AVCodecParserContext *av_parser_init(int codec_id);
2805
int av_parser_parse(AVCodecParserContext *s,
2806
                    AVCodecContext *avctx,
2807
                    uint8_t **poutbuf, int *poutbuf_size,
2808
                    const uint8_t *buf, int buf_size,
2809
                    int64_t pts, int64_t dts);
2810
int av_parser_change(AVCodecParserContext *s,
2811
                     AVCodecContext *avctx,
2812
                     uint8_t **poutbuf, int *poutbuf_size,
2813
                     const uint8_t *buf, int buf_size, int keyframe);
2814
void av_parser_close(AVCodecParserContext *s);
2815

    
2816

    
2817
typedef struct AVBitStreamFilterContext {
2818
    void *priv_data;
2819
    struct AVBitStreamFilter *filter;
2820
    AVCodecParserContext *parser;
2821
    struct AVBitStreamFilterContext *next;
2822
} AVBitStreamFilterContext;
2823

    
2824

    
2825
typedef struct AVBitStreamFilter {
2826
    const char *name;
2827
    int priv_data_size;
2828
    int (*filter)(AVBitStreamFilterContext *bsfc,
2829
                  AVCodecContext *avctx, const char *args,
2830
                  uint8_t **poutbuf, int *poutbuf_size,
2831
                  const uint8_t *buf, int buf_size, int keyframe);
2832
    void (*close)(AVBitStreamFilterContext *bsfc);
2833
    struct AVBitStreamFilter *next;
2834
} AVBitStreamFilter;
2835

    
2836
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2837
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2838
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2839
                               AVCodecContext *avctx, const char *args,
2840
                               uint8_t **poutbuf, int *poutbuf_size,
2841
                               const uint8_t *buf, int buf_size, int keyframe);
2842
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2843

    
2844
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2845

    
2846
/* memory */
2847

    
2848
/**
2849
 * Reallocates the given block if it is not large enough, otherwise it
2850
 * does nothing.
2851
 *
2852
 * @see av_realloc
2853
 */
2854
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2855

    
2856
/* for static data only */
2857

    
2858
/**
2859
 * Frees all static arrays and resets their pointers to 0.
2860
 * Call this function to release all statically allocated tables.
2861
 *
2862
 * @deprecated. Code which uses av_free_static is broken/misdesigned
2863
 * and should correctly use static arrays
2864
 *
2865
 */
2866
attribute_deprecated void av_free_static(void);
2867

    
2868
/**
2869
 * Allocation of static arrays.
2870
 *
2871
 * @warning Do not use for normal allocation.
2872
 *
2873
 * @param[in] size The amount of memory you need in bytes.
2874
 * @return block of memory of the requested size
2875
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2876
 * and should correctly use static arrays
2877
 */
2878
attribute_deprecated void *av_mallocz_static(unsigned int size);
2879

    
2880
/**
2881
 * Copy image 'src' to 'dst'.
2882
 */
2883
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2884
              int pix_fmt, int width, int height);
2885

    
2886
/**
2887
 * Crop image top and left side.
2888
 */
2889
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2890
             int pix_fmt, int top_band, int left_band);
2891

    
2892
/**
2893
 * Pad image.
2894
 */
2895
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2896
            int padtop, int padbottom, int padleft, int padright, int *color);
2897

    
2898
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2899
/**
2900
 * @deprecated Use the software scaler (swscale) instead.
2901
 */
2902
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2903
              int pix_fmt, int width, int height);
2904

    
2905
/**
2906
 * @deprecated Use the software scaler (swscale) instead.
2907
 */
2908
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2909
             int pix_fmt, int top_band, int left_band);
2910

    
2911
/**
2912
 * @deprecated Use the software scaler (swscale) instead.
2913
 */
2914
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2915
            int padtop, int padbottom, int padleft, int padright, int *color);
2916
#endif
2917

    
2918
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2919

    
2920
/**
2921
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2922
 *
2923
 * @return 0 in case of a successful parsing, a negative value otherwise
2924
 * @param[in] str the string to parse: it has to be a string in the format
2925
 * <width>x<height> or a valid video frame size abbreviation.
2926
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2927
 * frame width value
2928
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2929
 * frame height value
2930
 */
2931
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2932

    
2933
/**
2934
 * Parses \p str and put in \p frame_rate the detected values.
2935
 *
2936
 * @return 0 in case of a successful parsing, a negative value otherwise
2937
 * @param[in] str the string to parse: it has to be a string in the format
2938
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2939
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2940
 * frame rate
2941
 */
2942
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2943

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

    
2963
#endif /* FFMPEG_AVCODEC_H */