Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 725d86bf

History | View | Annotate | Download (90.3 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)+(48<<8)+0)
37
#define LIBAVCODEC_VERSION      51.48.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
/* Currently unused, may be used if 24/32 bits samples are ever supported. */
304
/* all in native-endian format */
305
enum SampleFormat {
306
    SAMPLE_FMT_NONE = -1,
307
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
308
    SAMPLE_FMT_S16,             ///< signed 16 bits
309
    SAMPLE_FMT_S24,             ///< signed 24 bits
310
    SAMPLE_FMT_S32,             ///< signed 32 bits
311
    SAMPLE_FMT_FLT,             ///< float
312
};
313

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

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

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

    
332
/* motion estimation type, EPZS by default */
333
enum Motion_Est_ID {
334
    ME_ZERO = 1,
335
    ME_FULL,
336
    ME_LOG,
337
    ME_PHODS,
338
    ME_EPZS,
339
    ME_X1,
340
    ME_HEX,
341
    ME_UMH,
342
    ME_ITER,
343
};
344

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

    
356
typedef struct RcOverride{
357
    int start_frame;
358
    int end_frame;
359
    int qscale; // If this is 0 then quality_factor will be used instead.
360
    float quality_factor;
361
} RcOverride;
362

    
363
#define FF_MAX_B_FRAMES 16
364

    
365
/* encoding support
366
   These flags can be passed in AVCodecContext.flags before initialization.
367
   Note: Not everything is supported yet.
368
*/
369

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

    
428
/* Unsupported options :
429
 *              Syntax Arithmetic coding (SAC)
430
 *              Reference Picture Selection
431
 *              Independent Segment Decoding */
432
/* /Fx */
433
/* codec capabilities */
434

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

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

    
481
/**
482
 * Pan Scan area.
483
 * This specifies the area which should be displayed.
484
 * Note there may be multiple such areas for one frame.
485
 */
486
typedef struct AVPanScan{
487
    /**
488
     * id
489
     * - encoding: Set by user.
490
     * - decoding: Set by libavcodec.
491
     */
492
    int id;
493

    
494
    /**
495
     * width and height in 1/16 pel
496
     * - encoding: Set by user.
497
     * - decoding: Set by libavcodec.
498
     */
499
    int width;
500
    int height;
501

    
502
    /**
503
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
504
     * - encoding: Set by user.
505
     * - decoding: Set by libavcodec.
506
     */
507
    int16_t position[3][2];
508
}AVPanScan;
509

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

    
718
#define FF_QSCALE_TYPE_MPEG1 0
719
#define FF_QSCALE_TYPE_MPEG2 1
720
#define FF_QSCALE_TYPE_H264  2
721

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

    
727

    
728
#define FF_I_TYPE  1 // Intra
729
#define FF_P_TYPE  2 // Predicted
730
#define FF_B_TYPE  3 // Bi-dir predicted
731
#define FF_S_TYPE  4 // S(GMC)-VOP MPEG4
732
#define FF_SI_TYPE 5
733
#define FF_SP_TYPE 6
734

    
735
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
736
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
737
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
738
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
739

    
740
/**
741
 * Audio Video Frame.
742
 */
743
typedef struct AVFrame {
744
    FF_COMMON_FRAME
745
} AVFrame;
746

    
747
#define DEFAULT_FRAME_RATE_BASE 1001000
748

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

    
765
    /**
766
     * number of bits the bitstream is allowed to diverge from the reference.
767
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
768
     * - encoding: Set by user; unused for constant quantizer encoding.
769
     * - decoding: unused
770
     */
771
    int bit_rate_tolerance;
772

    
773
    /**
774
     * CODEC_FLAG_*.
775
     * - encoding: Set by user.
776
     * - decoding: Set by user.
777
     */
778
    int flags;
779

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

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

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

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

    
823
    /* video only */
824
    /**
825
     * picture width / height.
826
     * - encoding: MUST be set by user.
827
     * - decoding: Set by libavcodec.
828
     * Note: For compatibility it is possible to set this instead of
829
     * coded_width/height before decoding.
830
     */
831
    int width, height;
832

    
833
#define FF_ASPECT_EXTENDED 15
834

    
835
    /**
836
     * the number of pictures in a group of pictures, or 0 for intra_only
837
     * - encoding: Set by user.
838
     * - decoding: unused
839
     */
840
    int gop_size;
841

    
842
    /**
843
     * Pixel format, see PIX_FMT_xxx.
844
     * - encoding: Set by user.
845
     * - decoding: Set by libavcodec.
846
     */
847
    enum PixelFormat pix_fmt;
848

    
849
    /**
850
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
851
     * has to read frames at native frame rate.
852
     * - encoding: Set by user.
853
     * - decoding: unused
854
     */
855
    int rate_emu;
856

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

    
873
    /* audio only */
874
    int sample_rate; ///< samples per second
875
    int channels;
876

    
877
    /**
878
     * audio sample format
879
     * - encoding: Set by user.
880
     * - decoding: Set by libavcodec.
881
     */
882
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
883

    
884
    /* The following data should not be initialized. */
885
    /**
886
     * Samples per packet, initialized when calling 'init'.
887
     */
888
    int frame_size;
889
    int frame_number;   ///< audio or video frame number
890
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
891

    
892
    /**
893
     * Number of frames the decoded output will be delayed relative to
894
     * the encoded input.
895
     * - encoding: Set by libavcodec.
896
     * - decoding: unused
897
     */
898
    int delay;
899

    
900
    /* - encoding parameters */
901
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
902
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
903

    
904
    /**
905
     * minimum quantizer
906
     * - encoding: Set by user.
907
     * - decoding: unused
908
     */
909
    int qmin;
910

    
911
    /**
912
     * maximum quantizer
913
     * - encoding: Set by user.
914
     * - decoding: unused
915
     */
916
    int qmax;
917

    
918
    /**
919
     * maximum quantizer difference between frames
920
     * - encoding: Set by user.
921
     * - decoding: unused
922
     */
923
    int max_qdiff;
924

    
925
    /**
926
     * maximum number of B-frames between non-B-frames
927
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
928
     * - encoding: Set by user.
929
     * - decoding: unused
930
     */
931
    int max_b_frames;
932

    
933
    /**
934
     * qscale factor between IP and B-frames
935
     * - encoding: Set by user.
936
     * - decoding: unused
937
     */
938
    float b_quant_factor;
939

    
940
    /** obsolete FIXME remove */
941
    int rc_strategy;
942
#define FF_RC_STRATEGY_XVID 1
943

    
944
    int b_frame_strategy;
945

    
946
    /**
947
     * hurry up amount
948
     * - encoding: unused
949
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
950
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
951
     */
952
    int hurry_up;
953

    
954
    struct AVCodec *codec;
955

    
956
    void *priv_data;
957

    
958
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
959
    /* unused, FIXME remove*/
960
    int rtp_mode;
961
#endif
962

    
963
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
964
                            /* do its best to deliver a chunk with size     */
965
                            /* below rtp_payload_size, the chunk will start */
966
                            /* with a start code on some codecs like H.263. */
967
                            /* This doesn't take account of any particular  */
968
                            /* headers inside the transmitted RTP payload.  */
969

    
970

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

    
979
    /* statistics, used for 2-pass encoding */
980
    int mv_bits;
981
    int header_bits;
982
    int i_tex_bits;
983
    int p_tex_bits;
984
    int i_count;
985
    int p_count;
986
    int skip_count;
987
    int misc_bits;
988

    
989
    /**
990
     * number of bits used for the previously encoded frame
991
     * - encoding: Set by libavcodec.
992
     * - decoding: unused
993
     */
994
    int frame_bits;
995

    
996
    /**
997
     * Private data of the user, can be used to carry app specific stuff.
998
     * - encoding: Set by user.
999
     * - decoding: Set by user.
1000
     */
1001
    void *opaque;
1002

    
1003
    char codec_name[32];
1004
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1005
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1006

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

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

    
1045
    /**
1046
     * luma single coefficient elimination threshold
1047
     * - encoding: Set by user.
1048
     * - decoding: unused
1049
     */
1050
    int luma_elim_threshold;
1051

    
1052
    /**
1053
     * chroma single coeff elimination threshold
1054
     * - encoding: Set by user.
1055
     * - decoding: unused
1056
     */
1057
    int chroma_elim_threshold;
1058

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

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

    
1080
    /**
1081
     * Error resilience; higher values will detect more errors but may
1082
     * misdetect some more or less valid parts as errors.
1083
     * - encoding: unused
1084
     * - decoding: Set by user.
1085
     */
1086
    int error_resilience;
1087
#define FF_ER_CAREFUL         1
1088
#define FF_ER_COMPLIANT       2
1089
#define FF_ER_AGGRESSIVE      3
1090
#define FF_ER_VERY_AGGRESSIVE 4
1091

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

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

    
1111
    /**
1112
     * If 1 the stream has a 1 frame delay during decoding.
1113
     * - encoding: Set by libavcodec.
1114
     * - decoding: Set by libavcodec.
1115
     */
1116
    int has_b_frames;
1117

    
1118
    /**
1119
     * number of bytes per packet if constant and known or 0
1120
     * Used by some WAV based audio codecs.
1121
     */
1122
    int block_align;
1123

    
1124
    int parse_only; /* - decoding only: If true, only parsing is done
1125
                       (function avcodec_parse_frame()). The frame
1126
                       data is returned. Only MPEG codecs support this now. */
1127

    
1128
    /**
1129
     * 0-> h263 quant 1-> mpeg quant
1130
     * - encoding: Set by user.
1131
     * - decoding: unused
1132
     */
1133
    int mpeg_quant;
1134

    
1135
    /**
1136
     * pass1 encoding statistics output buffer
1137
     * - encoding: Set by libavcodec.
1138
     * - decoding: unused
1139
     */
1140
    char *stats_out;
1141

    
1142
    /**
1143
     * pass2 encoding statistics input buffer
1144
     * Concatenated stuff from stats_out of pass1 should be placed here.
1145
     * - encoding: Allocated/set/freed by user.
1146
     * - decoding: unused
1147
     */
1148
    char *stats_in;
1149

    
1150
    /**
1151
     * ratecontrol qmin qmax limiting method
1152
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1153
     * - encoding: Set by user.
1154
     * - decoding: unused
1155
     */
1156
    float rc_qsquish;
1157

    
1158
    float rc_qmod_amp;
1159
    int rc_qmod_freq;
1160

    
1161
    /**
1162
     * ratecontrol override, see RcOverride
1163
     * - encoding: Allocated/set/freed by user.
1164
     * - decoding: unused
1165
     */
1166
    RcOverride *rc_override;
1167
    int rc_override_count;
1168

    
1169
    /**
1170
     * rate control equation
1171
     * - encoding: Set by user
1172
     * - decoding: unused
1173
     */
1174
    char *rc_eq;
1175

    
1176
    /**
1177
     * maximum bitrate
1178
     * - encoding: Set by user.
1179
     * - decoding: unused
1180
     */
1181
    int rc_max_rate;
1182

    
1183
    /**
1184
     * minimum bitrate
1185
     * - encoding: Set by user.
1186
     * - decoding: unused
1187
     */
1188
    int rc_min_rate;
1189

    
1190
    /**
1191
     * decoder bitstream buffer size
1192
     * - encoding: Set by user.
1193
     * - decoding: unused
1194
     */
1195
    int rc_buffer_size;
1196
    float rc_buffer_aggressivity;
1197

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

    
1207
    /**
1208
     * qscale offset between P and I-frames
1209
     * - encoding: Set by user.
1210
     * - decoding: unused
1211
     */
1212
    float i_quant_offset;
1213

    
1214
    /**
1215
     * initial complexity for pass1 ratecontrol
1216
     * - encoding: Set by user.
1217
     * - decoding: unused
1218
     */
1219
    float rc_initial_cplx;
1220

    
1221
    /**
1222
     * DCT algorithm, see FF_DCT_* below
1223
     * - encoding: Set by user.
1224
     * - decoding: unused
1225
     */
1226
    int dct_algo;
1227
#define FF_DCT_AUTO    0
1228
#define FF_DCT_FASTINT 1
1229
#define FF_DCT_INT     2
1230
#define FF_DCT_MMX     3
1231
#define FF_DCT_MLIB    4
1232
#define FF_DCT_ALTIVEC 5
1233
#define FF_DCT_FAAN    6
1234

    
1235
    /**
1236
     * luminance masking (0-> disabled)
1237
     * - encoding: Set by user.
1238
     * - decoding: unused
1239
     */
1240
    float lumi_masking;
1241

    
1242
    /**
1243
     * temporary complexity masking (0-> disabled)
1244
     * - encoding: Set by user.
1245
     * - decoding: unused
1246
     */
1247
    float temporal_cplx_masking;
1248

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

    
1256
    /**
1257
     * p block masking (0-> disabled)
1258
     * - encoding: Set by user.
1259
     * - decoding: unused
1260
     */
1261
    float p_masking;
1262

    
1263
    /**
1264
     * darkness masking (0-> disabled)
1265
     * - encoding: Set by user.
1266
     * - decoding: unused
1267
     */
1268
    float dark_masking;
1269

    
1270

    
1271
    /* for binary compatibility */
1272
    int unused;
1273

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

    
1301
    /**
1302
     * slice count
1303
     * - encoding: Set by libavcodec.
1304
     * - decoding: Set by user (or 0).
1305
     */
1306
    int slice_count;
1307
    /**
1308
     * slice offsets in the frame in bytes
1309
     * - encoding: Set/allocated by libavcodec.
1310
     * - decoding: Set/allocated by user (or NULL).
1311
     */
1312
    int *slice_offset;
1313

    
1314
    /**
1315
     * error concealment flags
1316
     * - encoding: unused
1317
     * - decoding: Set by user.
1318
     */
1319
    int error_concealment;
1320
#define FF_EC_GUESS_MVS   1
1321
#define FF_EC_DEBLOCK     2
1322

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

    
1344
    /**
1345
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1346
     * - encoding: Set by libavcodec.
1347
     * - decoding: Set by user.
1348
     */
1349
     int bits_per_sample;
1350

    
1351
    /**
1352
     * prediction method (needed for huffyuv)
1353
     * - encoding: Set by user.
1354
     * - decoding: unused
1355
     */
1356
     int prediction_method;
1357
#define FF_PRED_LEFT   0
1358
#define FF_PRED_PLANE  1
1359
#define FF_PRED_MEDIAN 2
1360

    
1361
    /**
1362
     * sample aspect ratio (0 if unknown)
1363
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1364
     * - encoding: Set by user.
1365
     * - decoding: Set by libavcodec.
1366
     */
1367
    AVRational sample_aspect_ratio;
1368

    
1369
    /**
1370
     * the picture in the bitstream
1371
     * - encoding: Set by libavcodec.
1372
     * - decoding: Set by libavcodec.
1373
     */
1374
    AVFrame *coded_frame;
1375

    
1376
    /**
1377
     * debug
1378
     * - encoding: Set by user.
1379
     * - decoding: Set by user.
1380
     */
1381
    int debug;
1382
#define FF_DEBUG_PICT_INFO   1
1383
#define FF_DEBUG_RC          2
1384
#define FF_DEBUG_BITSTREAM   4
1385
#define FF_DEBUG_MB_TYPE     8
1386
#define FF_DEBUG_QP          16
1387
#define FF_DEBUG_MV          32
1388
#define FF_DEBUG_DCT_COEFF   0x00000040
1389
#define FF_DEBUG_SKIP        0x00000080
1390
#define FF_DEBUG_STARTCODE   0x00000100
1391
#define FF_DEBUG_PTS         0x00000200
1392
#define FF_DEBUG_ER          0x00000400
1393
#define FF_DEBUG_MMCO        0x00000800
1394
#define FF_DEBUG_BUGS        0x00001000
1395
#define FF_DEBUG_VIS_QP      0x00002000
1396
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1397

    
1398
    /**
1399
     * debug
1400
     * - encoding: Set by user.
1401
     * - decoding: Set by user.
1402
     */
1403
    int debug_mv;
1404
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1405
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1406
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1407

    
1408
    /**
1409
     * error
1410
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1411
     * - decoding: unused
1412
     */
1413
    uint64_t error[4];
1414

    
1415
    /**
1416
     * minimum MB quantizer
1417
     * - encoding: unused
1418
     * - decoding: unused
1419
     */
1420
    int mb_qmin;
1421

    
1422
    /**
1423
     * maximum MB quantizer
1424
     * - encoding: unused
1425
     * - decoding: unused
1426
     */
1427
    int mb_qmax;
1428

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

    
1470
    /**
1471
     * ME diamond size & shape
1472
     * - encoding: Set by user.
1473
     * - decoding: unused
1474
     */
1475
    int dia_size;
1476

    
1477
    /**
1478
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1479
     * - encoding: Set by user.
1480
     * - decoding: unused
1481
     */
1482
    int last_predictor_count;
1483

    
1484
    /**
1485
     * prepass for motion estimation
1486
     * - encoding: Set by user.
1487
     * - decoding: unused
1488
     */
1489
    int pre_me;
1490

    
1491
    /**
1492
     * motion estimation prepass comparison function
1493
     * - encoding: Set by user.
1494
     * - decoding: unused
1495
     */
1496
    int me_pre_cmp;
1497

    
1498
    /**
1499
     * ME prepass diamond size & shape
1500
     * - encoding: Set by user.
1501
     * - decoding: unused
1502
     */
1503
    int pre_dia_size;
1504

    
1505
    /**
1506
     * subpel ME quality
1507
     * - encoding: Set by user.
1508
     * - decoding: unused
1509
     */
1510
    int me_subpel_quality;
1511

    
1512
    /**
1513
     * callback to negotiate the pixelFormat
1514
     * @param fmt is the list of formats which are supported by the codec,
1515
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1516
     * The first is always the native one.
1517
     * @return the chosen format
1518
     * - encoding: unused
1519
     * - decoding: Set by user, if not set the native format will be chosen.
1520
     */
1521
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1522

    
1523
    /**
1524
     * DTG active format information (additional aspect ratio
1525
     * information only used in DVB MPEG-2 transport streams)
1526
     * 0 if not set.
1527
     *
1528
     * - encoding: unused
1529
     * - decoding: Set by decoder.
1530
     */
1531
    int dtg_active_format;
1532
#define FF_DTG_AFD_SAME         8
1533
#define FF_DTG_AFD_4_3          9
1534
#define FF_DTG_AFD_16_9         10
1535
#define FF_DTG_AFD_14_9         11
1536
#define FF_DTG_AFD_4_3_SP_14_9  13
1537
#define FF_DTG_AFD_16_9_SP_14_9 14
1538
#define FF_DTG_AFD_SP_4_3       15
1539

    
1540
    /**
1541
     * maximum motion estimation search range in subpel units
1542
     * If 0 then no limit.
1543
     *
1544
     * - encoding: Set by user.
1545
     * - decoding: unused
1546
     */
1547
    int me_range;
1548

    
1549
    /**
1550
     * intra quantizer bias
1551
     * - encoding: Set by user.
1552
     * - decoding: unused
1553
     */
1554
    int intra_quant_bias;
1555
#define FF_DEFAULT_QUANT_BIAS 999999
1556

    
1557
    /**
1558
     * inter quantizer bias
1559
     * - encoding: Set by user.
1560
     * - decoding: unused
1561
     */
1562
    int inter_quant_bias;
1563

    
1564
    /**
1565
     * color table ID
1566
     * - encoding: unused
1567
     * - decoding: Which clrtable should be used for 8bit RGB images.
1568
     *             Tables have to be stored somewhere. FIXME
1569
     */
1570
    int color_table_id;
1571

    
1572
    /**
1573
     * internal_buffer count
1574
     * Don't touch, used by libavcodec default_get_buffer().
1575
     */
1576
    int internal_buffer_count;
1577

    
1578
    /**
1579
     * internal_buffers
1580
     * Don't touch, used by libavcodec default_get_buffer().
1581
     */
1582
    void *internal_buffer;
1583

    
1584
#define FF_LAMBDA_SHIFT 7
1585
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1586
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1587
#define FF_LAMBDA_MAX (256*128-1)
1588

    
1589
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1590
    /**
1591
     * Global quality for codecs which cannot change it per frame.
1592
     * This should be proportional to MPEG-1/2/4 qscale.
1593
     * - encoding: Set by user.
1594
     * - decoding: unused
1595
     */
1596
    int global_quality;
1597

    
1598
#define FF_CODER_TYPE_VLC       0
1599
#define FF_CODER_TYPE_AC        1
1600
#define FF_CODER_TYPE_RAW       2
1601
#define FF_CODER_TYPE_RLE       3
1602
#define FF_CODER_TYPE_DEFLATE   4
1603
    /**
1604
     * coder type
1605
     * - encoding: Set by user.
1606
     * - decoding: unused
1607
     */
1608
    int coder_type;
1609

    
1610
    /**
1611
     * context model
1612
     * - encoding: Set by user.
1613
     * - decoding: unused
1614
     */
1615
    int context_model;
1616
#if 0
1617
    /**
1618
     *
1619
     * - encoding: unused
1620
     * - decoding: Set by user.
1621
     */
1622
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1623
#endif
1624

    
1625
    /**
1626
     * slice flags
1627
     * - encoding: unused
1628
     * - decoding: Set by user.
1629
     */
1630
    int slice_flags;
1631
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1632
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1633
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1634

    
1635
    /**
1636
     * XVideo Motion Acceleration
1637
     * - encoding: forbidden
1638
     * - decoding: set by decoder
1639
     */
1640
    int xvmc_acceleration;
1641

    
1642
    /**
1643
     * macroblock decision mode
1644
     * - encoding: Set by user.
1645
     * - decoding: unused
1646
     */
1647
    int mb_decision;
1648
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1649
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1650
#define FF_MB_DECISION_RD     2        ///< rate distoration
1651

    
1652
    /**
1653
     * custom intra quantization matrix
1654
     * - encoding: Set by user, can be NULL.
1655
     * - decoding: Set by libavcodec.
1656
     */
1657
    uint16_t *intra_matrix;
1658

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

    
1666
    /**
1667
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1668
     * This is used to work around some encoder bugs.
1669
     * - encoding: unused
1670
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1671
     */
1672
    unsigned int stream_codec_tag;
1673

    
1674
    /**
1675
     * scene change detection threshold
1676
     * 0 is default, larger means fewer detected scene changes.
1677
     * - encoding: Set by user.
1678
     * - decoding: unused
1679
     */
1680
    int scenechange_threshold;
1681

    
1682
    /**
1683
     * minimum Lagrange multipler
1684
     * - encoding: Set by user.
1685
     * - decoding: unused
1686
     */
1687
    int lmin;
1688

    
1689
    /**
1690
     * maximum Lagrange multipler
1691
     * - encoding: Set by user.
1692
     * - decoding: unused
1693
     */
1694
    int lmax;
1695

    
1696
    /**
1697
     * palette control structure
1698
     * - encoding: ??? (no palette-enabled encoder yet)
1699
     * - decoding: Set by user.
1700
     */
1701
    struct AVPaletteControl *palctrl;
1702

    
1703
    /**
1704
     * noise reduction strength
1705
     * - encoding: Set by user.
1706
     * - decoding: unused
1707
     */
1708
    int noise_reduction;
1709

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

    
1721
    /**
1722
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1723
     * - encoding: Set by user.
1724
     * - decoding: unused
1725
     */
1726
    int rc_initial_buffer_occupancy;
1727

    
1728
    /**
1729
     *
1730
     * - encoding: Set by user.
1731
     * - decoding: unused
1732
     */
1733
    int inter_threshold;
1734

    
1735
    /**
1736
     * CODEC_FLAG2_*
1737
     * - encoding: Set by user.
1738
     * - decoding: Set by user.
1739
     */
1740
    int flags2;
1741

    
1742
    /**
1743
     * Simulates errors in the bitstream to test error concealment.
1744
     * - encoding: Set by user.
1745
     * - decoding: unused
1746
     */
1747
    int error_rate;
1748

    
1749
    /**
1750
     * MP3 antialias algorithm, see FF_AA_* below.
1751
     * - encoding: unused
1752
     * - decoding: Set by user.
1753
     */
1754
    int antialias_algo;
1755
#define FF_AA_AUTO    0
1756
#define FF_AA_FASTINT 1 //not implemented yet
1757
#define FF_AA_INT     2
1758
#define FF_AA_FLOAT   3
1759
    /**
1760
     * quantizer noise shaping
1761
     * - encoding: Set by user.
1762
     * - decoding: unused
1763
     */
1764
    int quantizer_noise_shaping;
1765

    
1766
    /**
1767
     * thread count
1768
     * is used to decide how many independent tasks should be passed to execute()
1769
     * - encoding: Set by user.
1770
     * - decoding: Set by user.
1771
     */
1772
    int thread_count;
1773

    
1774
    /**
1775
     * The codec may call this to execute several independent things.
1776
     * It will return only after finishing all tasks.
1777
     * The user may replace this with some multithreaded implementation,
1778
     * the default implementation will execute the parts serially.
1779
     * @param count the number of things to execute
1780
     * - encoding: Set by libavcodec, user can override.
1781
     * - decoding: Set by libavcodec, user can override.
1782
     */
1783
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1784

    
1785
    /**
1786
     * thread opaque
1787
     * Can be used by execute() to store some per AVCodecContext stuff.
1788
     * - encoding: set by execute()
1789
     * - decoding: set by execute()
1790
     */
1791
    void *thread_opaque;
1792

    
1793
    /**
1794
     * Motion estimation threshold below which no motion estimation is
1795
     * performed, but instead the user specified motion vectors are used.
1796
     *
1797
     * - encoding: Set by user.
1798
     * - decoding: unused
1799
     */
1800
     int me_threshold;
1801

    
1802
    /**
1803
     * Macroblock threshold below which the user specified macroblock types will be used.
1804
     * - encoding: Set by user.
1805
     * - decoding: unused
1806
     */
1807
     int mb_threshold;
1808

    
1809
    /**
1810
     * precision of the intra DC coefficient - 8
1811
     * - encoding: Set by user.
1812
     * - decoding: unused
1813
     */
1814
     int intra_dc_precision;
1815

    
1816
    /**
1817
     * noise vs. sse weight for the nsse comparsion function
1818
     * - encoding: Set by user.
1819
     * - decoding: unused
1820
     */
1821
     int nsse_weight;
1822

    
1823
    /**
1824
     * Number of macroblock rows at the top which are skipped.
1825
     * - encoding: unused
1826
     * - decoding: Set by user.
1827
     */
1828
     int skip_top;
1829

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

    
1837
    /**
1838
     * profile
1839
     * - encoding: Set by user.
1840
     * - decoding: Set by libavcodec.
1841
     */
1842
     int profile;
1843
#define FF_PROFILE_UNKNOWN -99
1844
#define FF_PROFILE_AAC_MAIN 0
1845
#define FF_PROFILE_AAC_LOW  1
1846
#define FF_PROFILE_AAC_SSR  2
1847
#define FF_PROFILE_AAC_LTP  3
1848

    
1849
    /**
1850
     * level
1851
     * - encoding: Set by user.
1852
     * - decoding: Set by libavcodec.
1853
     */
1854
     int level;
1855
#define FF_LEVEL_UNKNOWN -99
1856

    
1857
    /**
1858
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1859
     * - encoding: unused
1860
     * - decoding: Set by user.
1861
     */
1862
     int lowres;
1863

    
1864
    /**
1865
     * Bitstream width / height, may be different from width/height if lowres
1866
     * or other things are used.
1867
     * - encoding: unused
1868
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1869
     */
1870
    int coded_width, coded_height;
1871

    
1872
    /**
1873
     * frame skip threshold
1874
     * - encoding: Set by user.
1875
     * - decoding: unused
1876
     */
1877
    int frame_skip_threshold;
1878

    
1879
    /**
1880
     * frame skip factor
1881
     * - encoding: Set by user.
1882
     * - decoding: unused
1883
     */
1884
    int frame_skip_factor;
1885

    
1886
    /**
1887
     * frame skip exponent
1888
     * - encoding: Set by user.
1889
     * - decoding: unused
1890
     */
1891
    int frame_skip_exp;
1892

    
1893
    /**
1894
     * frame skip comparison function
1895
     * - encoding: Set by user.
1896
     * - decoding: unused
1897
     */
1898
    int frame_skip_cmp;
1899

    
1900
    /**
1901
     * Border processing masking, raises the quantizer for mbs on the borders
1902
     * of the picture.
1903
     * - encoding: Set by user.
1904
     * - decoding: unused
1905
     */
1906
    float border_masking;
1907

    
1908
    /**
1909
     * minimum MB lagrange multipler
1910
     * - encoding: Set by user.
1911
     * - decoding: unused
1912
     */
1913
    int mb_lmin;
1914

    
1915
    /**
1916
     * maximum MB lagrange multipler
1917
     * - encoding: Set by user.
1918
     * - decoding: unused
1919
     */
1920
    int mb_lmax;
1921

    
1922
    /**
1923
     *
1924
     * - encoding: Set by user.
1925
     * - decoding: unused
1926
     */
1927
    int me_penalty_compensation;
1928

    
1929
    /**
1930
     *
1931
     * - encoding: unused
1932
     * - decoding: Set by user.
1933
     */
1934
    enum AVDiscard skip_loop_filter;
1935

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

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

    
1950
    /**
1951
     *
1952
     * - encoding: Set by user.
1953
     * - decoding: unused
1954
     */
1955
    int bidir_refine;
1956

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

    
1964
    /**
1965
     * constant rate factor - quality-based VBR - values ~correspond to qps
1966
     * - encoding: Set by user.
1967
     * - decoding: unused
1968
     */
1969
    float crf;
1970

    
1971
    /**
1972
     * constant quantization parameter rate control method
1973
     * - encoding: Set by user.
1974
     * - decoding: unused
1975
     */
1976
    int cqp;
1977

    
1978
    /**
1979
     * minimum GOP size
1980
     * - encoding: Set by user.
1981
     * - decoding: unused
1982
     */
1983
    int keyint_min;
1984

    
1985
    /**
1986
     * number of reference frames
1987
     * - encoding: Set by user.
1988
     * - decoding: unused
1989
     */
1990
    int refs;
1991

    
1992
    /**
1993
     * chroma qp offset from luma
1994
     * - encoding: Set by user.
1995
     * - decoding: unused
1996
     */
1997
    int chromaoffset;
1998

    
1999
    /**
2000
     * Influences how often B-frames are used.
2001
     * - encoding: Set by user.
2002
     * - decoding: unused
2003
     */
2004
    int bframebias;
2005

    
2006
    /**
2007
     * trellis RD quantization
2008
     * - encoding: Set by user.
2009
     * - decoding: unused
2010
     */
2011
    int trellis;
2012

    
2013
    /**
2014
     * Reduce fluctuations in qp (before curve compression).
2015
     * - encoding: Set by user.
2016
     * - decoding: unused
2017
     */
2018
    float complexityblur;
2019

    
2020
    /**
2021
     * in-loop deblocking filter alphac0 parameter
2022
     * alpha is in the range -6...6
2023
     * - encoding: Set by user.
2024
     * - decoding: unused
2025
     */
2026
    int deblockalpha;
2027

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

    
2036
    /**
2037
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2038
     * - encoding: Set by user.
2039
     * - decoding: unused
2040
     */
2041
    int partitions;
2042
#define X264_PART_I4X4 0x001  /* Analyse i4x4 */
2043
#define X264_PART_I8X8 0x002  /* Analyse i8x8 (requires 8x8 transform) */
2044
#define X264_PART_P8X8 0x010  /* Analyse p16x8, p8x16 and p8x8 */
2045
#define X264_PART_P4X4 0x020  /* Analyse p8x4, p4x8, p4x4 */
2046
#define X264_PART_B8X8 0x100  /* Analyse b16x8, b8x16 and b8x8 */
2047

    
2048
    /**
2049
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2050
     * - encoding: Set by user.
2051
     * - decoding: unused
2052
     */
2053
    int directpred;
2054

    
2055
    /**
2056
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2057
     * - encoding: Set by user.
2058
     * - decoding: unused
2059
     */
2060
    int cutoff;
2061

    
2062
    /**
2063
     * Multiplied by qscale for each frame and added to scene_change_score.
2064
     * - encoding: Set by user.
2065
     * - decoding: unused
2066
     */
2067
    int scenechange_factor;
2068

    
2069
    /**
2070
     *
2071
     * Note: Value depends upon the compare function used for fullpel ME.
2072
     * - encoding: Set by user.
2073
     * - decoding: unused
2074
     */
2075
    int mv0_threshold;
2076

    
2077
    /**
2078
     * Adjusts sensitivity of b_frame_strategy 1.
2079
     * - encoding: Set by user.
2080
     * - decoding: unused
2081
     */
2082
    int b_sensitivity;
2083

    
2084
    /**
2085
     * - encoding: Set by user.
2086
     * - decoding: unused
2087
     */
2088
    int compression_level;
2089
#define FF_COMPRESSION_DEFAULT -1
2090

    
2091
    /**
2092
     * Sets whether to use LPC mode - used by FLAC encoder.
2093
     * - encoding: Set by user.
2094
     * - decoding: unused
2095
     */
2096
    int use_lpc;
2097

    
2098
    /**
2099
     * LPC coefficient precision - used by FLAC encoder
2100
     * - encoding: Set by user.
2101
     * - decoding: unused
2102
     */
2103
    int lpc_coeff_precision;
2104

    
2105
    /**
2106
     * - encoding: Set by user.
2107
     * - decoding: unused
2108
     */
2109
    int min_prediction_order;
2110

    
2111
    /**
2112
     * - encoding: Set by user.
2113
     * - decoding: unused
2114
     */
2115
    int max_prediction_order;
2116

    
2117
    /**
2118
     * search method for selecting prediction order
2119
     * - encoding: Set by user.
2120
     * - decoding: unused
2121
     */
2122
    int prediction_order_method;
2123

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

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

    
2136
    /**
2137
     * GOP timecode frame start number, in non drop frame format
2138
     * - encoding: Set by user.
2139
     * - decoding: unused
2140
     */
2141
    int64_t timecode_frame_start;
2142

    
2143
    /**
2144
     * Decoder should decode to this many channels if it can (0 for default)
2145
     * - encoding: unused
2146
     * - decoding: Set by user.
2147
     */
2148
    int request_channels;
2149
} AVCodecContext;
2150

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

    
2177
/**
2178
 * four components are given, that's all.
2179
 * the last component is alpha
2180
 */
2181
typedef struct AVPicture {
2182
    uint8_t *data[4];
2183
    int linesize[4];       ///< number of bytes per line
2184
} AVPicture;
2185

    
2186
/**
2187
 * AVPaletteControl
2188
 * This structure defines a method for communicating palette changes
2189
 * between and demuxer and a decoder.
2190
 *
2191
 * @deprecated Use AVPacket to send palette changes instead.
2192
 * This is totally broken.
2193
 */
2194
#define AVPALETTE_SIZE 1024
2195
#define AVPALETTE_COUNT 256
2196
typedef struct AVPaletteControl {
2197

    
2198
    /* Demuxer sets this to 1 to indicate the palette has changed;
2199
     * decoder resets to 0. */
2200
    int palette_changed;
2201

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

    
2208
} AVPaletteControl attribute_deprecated;
2209

    
2210
typedef struct AVSubtitleRect {
2211
    uint16_t x;
2212
    uint16_t y;
2213
    uint16_t w;
2214
    uint16_t h;
2215
    uint16_t nb_colors;
2216
    int linesize;
2217
    uint32_t *rgba_palette;
2218
    uint8_t *bitmap;
2219
} AVSubtitleRect;
2220

    
2221
typedef struct AVSubtitle {
2222
    uint16_t format; /* 0 = graphics */
2223
    uint32_t start_display_time; /* relative to packet pts, in ms */
2224
    uint32_t end_display_time; /* relative to packet pts, in ms */
2225
    uint32_t num_rects;
2226
    AVSubtitleRect *rects;
2227
} AVSubtitle;
2228

    
2229

    
2230
/* resample.c */
2231

    
2232
struct ReSampleContext;
2233
struct AVResampleContext;
2234

    
2235
typedef struct ReSampleContext ReSampleContext;
2236

    
2237
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2238
                                     int output_rate, int input_rate);
2239
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2240
void audio_resample_close(ReSampleContext *s);
2241

    
2242
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2243
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2244
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2245
void av_resample_close(struct AVResampleContext *c);
2246

    
2247
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2248
/* YUV420 format is assumed ! */
2249

    
2250
/**
2251
 * @deprecated Use the software scaler (swscale) instead.
2252
 */
2253
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2254

    
2255
/**
2256
 * @deprecated Use the software scaler (swscale) instead.
2257
 */
2258
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2259
                                      int input_width, int input_height);
2260

    
2261
/**
2262
 * @deprecated Use the software scaler (swscale) instead.
2263
 */
2264
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2265
                                      int iwidth, int iheight,
2266
                                      int topBand, int bottomBand,
2267
                                      int leftBand, int rightBand,
2268
                                      int padtop, int padbottom,
2269
                                      int padleft, int padright);
2270

    
2271
/**
2272
 * @deprecated Use the software scaler (swscale) instead.
2273
 */
2274
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2275
                  AVPicture *output, const AVPicture *input);
2276

    
2277
/**
2278
 * @deprecated Use the software scaler (swscale) instead.
2279
 */
2280
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2281

    
2282
#endif
2283

    
2284
/**
2285
 * Allocate memory for a picture.  Call avpicture_free to free it.
2286
 *
2287
 * @param picture the picture to be filled in
2288
 * @param pix_fmt the format of the picture
2289
 * @param width the width of the picture
2290
 * @param height the height of the picture
2291
 * @return zero if successful, a negative value if not
2292
 */
2293
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2294

    
2295
/**
2296
 * Free a picture previously allocated by avpicture_alloc().
2297
 *
2298
 * @param picture the AVPicture to be freed
2299
 */
2300
void avpicture_free(AVPicture *picture);
2301

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

    
2323
/**
2324
 * Calculate the size in bytes that a picture of the given width and height
2325
 * would occupy if stored in the given picture format.
2326
 *
2327
 * @param pix_fmt the given picture format
2328
 * @param width the width of the image
2329
 * @param height the height of the image
2330
 * @return Image data size in bytes
2331
 */
2332
int avpicture_get_size(int pix_fmt, int width, int height);
2333
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2334
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2335
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2336
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2337
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2338

    
2339
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2340
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2341
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2342
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2343
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2344
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2345

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

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

    
2391

    
2392
/**
2393
 * Print in buf the string corresponding to the pixel format with
2394
 * number pix_fmt, or an header if pix_fmt is negative.
2395
 *
2396
 * @param[in] buf the buffer where to write the string
2397
 * @param[in] buf_size the size of buf
2398
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2399
 * a negative value to print the corresponding header.
2400
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2401
 */
2402
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2403

    
2404
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2405
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2406

    
2407
/**
2408
 * Tell if an image really has transparent alpha values.
2409
 * @return ored mask of FF_ALPHA_xxx constants
2410
 */
2411
int img_get_alpha_info(const AVPicture *src,
2412
                       int pix_fmt, int width, int height);
2413

    
2414
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2415
/**
2416
 * convert among pixel formats
2417
 * @deprecated Use the software scaler (swscale) instead.
2418
 */
2419
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2420
                const AVPicture *src, int pix_fmt,
2421
                int width, int height);
2422
#endif
2423

    
2424
/* deinterlace a picture */
2425
/* deinterlace - if not supported return -1 */
2426
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2427
                          int pix_fmt, int width, int height);
2428

    
2429
/* external high level API */
2430

    
2431
extern AVCodec *first_avcodec;
2432

    
2433
/* returns LIBAVCODEC_VERSION_INT constant */
2434
unsigned avcodec_version(void);
2435
/* returns LIBAVCODEC_BUILD constant */
2436
unsigned avcodec_build(void);
2437

    
2438
/**
2439
 * Initializes libavcodec.
2440
 *
2441
 * @warning This function \e must be called before any other libavcodec
2442
 * function.
2443
 */
2444
void avcodec_init(void);
2445

    
2446
void register_avcodec(AVCodec *format);
2447

    
2448
/**
2449
 * Finds a registered encoder with a matching codec ID.
2450
 *
2451
 * @param id CodecID of the requested encoder
2452
 * @return An encoder if one was found, NULL otherwise.
2453
 */
2454
AVCodec *avcodec_find_encoder(enum CodecID id);
2455

    
2456
/**
2457
 * Finds a registered encoder with the specified name.
2458
 *
2459
 * @param name name of the requested encoder
2460
 * @return An encoder if one was found, NULL otherwise.
2461
 */
2462
AVCodec *avcodec_find_encoder_by_name(const char *name);
2463

    
2464
/**
2465
 * Finds a registered decoder with a matching codec ID.
2466
 *
2467
 * @param id CodecID of the requested decoder
2468
 * @return A decoder if one was found, NULL otherwise.
2469
 */
2470
AVCodec *avcodec_find_decoder(enum CodecID id);
2471

    
2472
/**
2473
 * Finds a registered decoder with the specified name.
2474
 *
2475
 * @param name name of the requested decoder
2476
 * @return A decoder if one was found, NULL otherwise.
2477
 */
2478
AVCodec *avcodec_find_decoder_by_name(const char *name);
2479
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2480

    
2481
/**
2482
 * Sets the fields of the given AVCodecContext to default values.
2483
 *
2484
 * @param s The AVCodecContext of which the fields should be set to default values.
2485
 */
2486
void avcodec_get_context_defaults(AVCodecContext *s);
2487

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

    
2492
/**
2493
 * Allocates an AVCodecContext and sets its fields to default values.  The
2494
 * resulting struct can be deallocated by simply calling av_free().
2495
 *
2496
 * @return An AVCodecContext filled with default values or NULL on failure.
2497
 * @see avcodec_get_context_defaults
2498
 */
2499
AVCodecContext *avcodec_alloc_context(void);
2500

    
2501
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2502
 *  we WILL change its arguments and name a few times! */
2503
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2504

    
2505
/**
2506
 * Sets the fields of the given AVFrame to default values.
2507
 *
2508
 * @param pic The AVFrame of which the fields should be set to default values.
2509
 */
2510
void avcodec_get_frame_defaults(AVFrame *pic);
2511

    
2512
/**
2513
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2514
 * struct can be deallocated by simply calling av_free().
2515
 *
2516
 * @return An AVFrame filled with default values or NULL on failure.
2517
 * @see avcodec_get_frame_defaults
2518
 */
2519
AVFrame *avcodec_alloc_frame(void);
2520

    
2521
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2522
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2523
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2524
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2525

    
2526
/**
2527
 * Checks if the given dimension of a picture is valid, meaning that all
2528
 * bytes of the picture can be addressed with a signed int.
2529
 *
2530
 * @param[in] w Width of the picture.
2531
 * @param[in] h Height of the picture.
2532
 * @return Zero if valid, a negative value if invalid.
2533
 */
2534
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2535
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2536

    
2537
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2538
void avcodec_thread_free(AVCodecContext *s);
2539
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2540
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2541
//FIXME func typedef
2542

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

    
2572
/**
2573
 * @deprecated Use avcodec_decode_audio2() instead.
2574
 */
2575
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2576
                         int *frame_size_ptr,
2577
                         uint8_t *buf, int buf_size);
2578

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

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

    
2654
/* Decode a subtitle message. Return -1 if error, otherwise return the
2655
 * number of bytes used. If no subtitle could be decompressed,
2656
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2657
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2658
                            int *got_sub_ptr,
2659
                            const uint8_t *buf, int buf_size);
2660
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2661
                        int *data_size_ptr,
2662
                        uint8_t *buf, int buf_size);
2663

    
2664
/**
2665
 * Encodes an audio frame from \p samples into \p buf.
2666
 * The avcodec_encode_audio() function encodes an audio frame from the input
2667
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2668
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2669
 * stored in output buffer \p buf.
2670
 *
2671
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2672
 *
2673
 * @param avctx the codec context
2674
 * @param[out] buf the output buffer
2675
 * @param[in] buf_size the output buffer size
2676
 * @param[in] samples the input buffer containing the samples
2677
 * @return On error a negative value is returned, on succes zero or the number
2678
 * of bytes used from the input buffer.
2679
 */
2680
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2681
                         const short *samples);
2682

    
2683
/**
2684
 * Encodes a video frame from \p pict into \p buf.
2685
 * The avcodec_encode_video() function encodes a video frame from the input
2686
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2687
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2688
 * frame are stored in the output buffer \p buf. The input picture should be
2689
 * stored using a specific format, namely \c avctx.pix_fmt.
2690
 *
2691
 * @param avctx the codec context
2692
 * @param[out] buf the output buffer for the bitstream of encoded frame
2693
 * @param[in] buf_size the size of the output buffer in bytes
2694
 * @param[in] pict the input picture to encode
2695
 * @return On error a negative value is returned, on success zero or the number
2696
 * of bytes used from the input buffer.
2697
 */
2698
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2699
                         const AVFrame *pict);
2700
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2701
                            const AVSubtitle *sub);
2702

    
2703
int avcodec_close(AVCodecContext *avctx);
2704

    
2705
void avcodec_register_all(void);
2706

    
2707
/**
2708
 * Flush buffers, should be called when seeking or when switching to a different stream.
2709
 */
2710
void avcodec_flush_buffers(AVCodecContext *avctx);
2711

    
2712
void avcodec_default_free_buffers(AVCodecContext *s);
2713

    
2714
/* misc useful functions */
2715

    
2716
/**
2717
 * Returns a single letter to describe the given picture type \p pict_type.
2718
 *
2719
 * @param[in] pict_type the picture type
2720
 * @return A single character representing the picture type.
2721
 */
2722
char av_get_pict_type_char(int pict_type);
2723

    
2724
/**
2725
 * Returns codec bits per sample.
2726
 *
2727
 * @param[in] codec_id the codec
2728
 * @return Number of bits per sample or zero if unknown for the given codec.
2729
 */
2730
int av_get_bits_per_sample(enum CodecID codec_id);
2731

    
2732
/**
2733
 * Returns sample format bits per sample.
2734
 *
2735
 * @param[in] sample_fmt the sample format
2736
 * @return Number of bits per sample or zero if unknown for the given sample format.
2737
 */
2738
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2739

    
2740
/* frame parsing */
2741
typedef struct AVCodecParserContext {
2742
    void *priv_data;
2743
    struct AVCodecParser *parser;
2744
    int64_t frame_offset; /* offset of the current frame */
2745
    int64_t cur_offset; /* current offset
2746
                           (incremented by each av_parser_parse()) */
2747
    int64_t last_frame_offset; /* offset of the last frame */
2748
    /* video info */
2749
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2750
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2751
    int64_t pts;     /* pts of the current frame */
2752
    int64_t dts;     /* dts of the current frame */
2753

    
2754
    /* private data */
2755
    int64_t last_pts;
2756
    int64_t last_dts;
2757
    int fetch_timestamp;
2758

    
2759
#define AV_PARSER_PTS_NB 4
2760
    int cur_frame_start_index;
2761
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2762
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2763
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2764

    
2765
    int flags;
2766
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2767

    
2768
    int64_t offset;      ///< byte offset from starting packet start
2769
    int64_t last_offset;
2770
} AVCodecParserContext;
2771

    
2772
typedef struct AVCodecParser {
2773
    int codec_ids[5]; /* several codec IDs are permitted */
2774
    int priv_data_size;
2775
    int (*parser_init)(AVCodecParserContext *s);
2776
    int (*parser_parse)(AVCodecParserContext *s,
2777
                        AVCodecContext *avctx,
2778
                        const uint8_t **poutbuf, int *poutbuf_size,
2779
                        const uint8_t *buf, int buf_size);
2780
    void (*parser_close)(AVCodecParserContext *s);
2781
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2782
    struct AVCodecParser *next;
2783
} AVCodecParser;
2784

    
2785
extern AVCodecParser *av_first_parser;
2786

    
2787
void av_register_codec_parser(AVCodecParser *parser);
2788
AVCodecParserContext *av_parser_init(int codec_id);
2789
int av_parser_parse(AVCodecParserContext *s,
2790
                    AVCodecContext *avctx,
2791
                    uint8_t **poutbuf, int *poutbuf_size,
2792
                    const uint8_t *buf, int buf_size,
2793
                    int64_t pts, int64_t dts);
2794
int av_parser_change(AVCodecParserContext *s,
2795
                     AVCodecContext *avctx,
2796
                     uint8_t **poutbuf, int *poutbuf_size,
2797
                     const uint8_t *buf, int buf_size, int keyframe);
2798
void av_parser_close(AVCodecParserContext *s);
2799

    
2800

    
2801
typedef struct AVBitStreamFilterContext {
2802
    void *priv_data;
2803
    struct AVBitStreamFilter *filter;
2804
    AVCodecParserContext *parser;
2805
    struct AVBitStreamFilterContext *next;
2806
} AVBitStreamFilterContext;
2807

    
2808

    
2809
typedef struct AVBitStreamFilter {
2810
    const char *name;
2811
    int priv_data_size;
2812
    int (*filter)(AVBitStreamFilterContext *bsfc,
2813
                  AVCodecContext *avctx, const char *args,
2814
                  uint8_t **poutbuf, int *poutbuf_size,
2815
                  const uint8_t *buf, int buf_size, int keyframe);
2816
    void (*close)(AVBitStreamFilterContext *bsfc);
2817
    struct AVBitStreamFilter *next;
2818
} AVBitStreamFilter;
2819

    
2820
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2821
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2822
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2823
                               AVCodecContext *avctx, const char *args,
2824
                               uint8_t **poutbuf, int *poutbuf_size,
2825
                               const uint8_t *buf, int buf_size, int keyframe);
2826
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2827

    
2828

    
2829
/* memory */
2830

    
2831
/**
2832
 * Reallocates the given block if it is not large enough, otherwise it
2833
 * does nothing.
2834
 *
2835
 * @see av_realloc
2836
 */
2837
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2838

    
2839
/* for static data only */
2840

    
2841
/**
2842
 * Frees all static arrays and resets their pointers to 0.
2843
 * Call this function to release all statically allocated tables.
2844
 *
2845
 * @deprecated. Code which uses av_free_static is broken/misdesigned
2846
 * and should correctly use static arrays
2847
 *
2848
 */
2849
attribute_deprecated void av_free_static(void);
2850

    
2851
/**
2852
 * Allocation of static arrays.
2853
 *
2854
 * @warning Do not use for normal allocation.
2855
 *
2856
 * @param[in] size The amount of memory you need in bytes.
2857
 * @return block of memory of the requested size
2858
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2859
 * and should correctly use static arrays
2860
 */
2861
attribute_deprecated void *av_mallocz_static(unsigned int size);
2862

    
2863
/**
2864
 * Copy image 'src' to 'dst'.
2865
 */
2866
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2867
              int pix_fmt, int width, int height);
2868

    
2869
/**
2870
 * Crop image top and left side.
2871
 */
2872
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2873
             int pix_fmt, int top_band, int left_band);
2874

    
2875
/**
2876
 * Pad image.
2877
 */
2878
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2879
            int padtop, int padbottom, int padleft, int padright, int *color);
2880

    
2881
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2882
/**
2883
 * @deprecated Use the software scaler (swscale) instead.
2884
 */
2885
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2886
              int pix_fmt, int width, int height);
2887

    
2888
/**
2889
 * @deprecated Use the software scaler (swscale) instead.
2890
 */
2891
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2892
             int pix_fmt, int top_band, int left_band);
2893

    
2894
/**
2895
 * @deprecated Use the software scaler (swscale) instead.
2896
 */
2897
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2898
            int padtop, int padbottom, int padleft, int padright, int *color);
2899
#endif
2900

    
2901
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2902

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

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

    
2927
/* error handling */
2928
#if EINVAL > 0
2929
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2930
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2931
#else
2932
/* Some platforms have E* and errno already negated. */
2933
#define AVERROR(e) (e)
2934
#define AVUNERROR(e) (e)
2935
#endif
2936
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
2937
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
2938
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2939
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
2940
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
2941
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
2942
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
2943
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
2944
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2945

    
2946
#endif /* FFMPEG_AVCODEC_H */