Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 2efa7fd1

History | View | Annotate | Download (91.9 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef 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)+(50<<8)+0)
37
#define LIBAVCODEC_VERSION      51.50.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
    CODEC_ID_PCX,
173
    CODEC_ID_SUNRAST,
174

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

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

    
224
    /* AMR */
225
    CODEC_ID_AMR_NB= 0x12000,
226
    CODEC_ID_AMR_WB,
227

    
228
    /* RealAudio codecs*/
229
    CODEC_ID_RA_144= 0x13000,
230
    CODEC_ID_RA_288,
231

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

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

    
280
    /* subtitle codecs */
281
    CODEC_ID_DVD_SUBTITLE= 0x17000,
282
    CODEC_ID_DVB_SUBTITLE,
283
    CODEC_ID_TEXT,  ///< raw UTF-8 text
284
    CODEC_ID_XSUB,
285
    CODEC_ID_SSA,
286
    CODEC_ID_MOV_TEXT,
287

    
288
    /* other specific kind of codecs (generaly used for attachments) */
289
    CODEC_ID_TTF= 0x18000,
290

    
291
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
292
                                * stream (only used by libavformat) */
293
};
294

    
295
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
296
/* CODEC_ID_MP3LAME is obsolete */
297
#define CODEC_ID_MP3LAME CODEC_ID_MP3
298
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
299
#endif
300

    
301
enum CodecType {
302
    CODEC_TYPE_UNKNOWN = -1,
303
    CODEC_TYPE_VIDEO,
304
    CODEC_TYPE_AUDIO,
305
    CODEC_TYPE_DATA,
306
    CODEC_TYPE_SUBTITLE,
307
    CODEC_TYPE_ATTACHMENT,
308
    CODEC_TYPE_NB
309
};
310

    
311
/**
312
 * Currently unused, may be used if 24/32 bits samples are ever supported.
313
 * all in native-endian format
314
 */
315
enum SampleFormat {
316
    SAMPLE_FMT_NONE = -1,
317
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
318
    SAMPLE_FMT_S16,             ///< signed 16 bits
319
    SAMPLE_FMT_S24,             ///< signed 24 bits
320
    SAMPLE_FMT_S32,             ///< signed 32 bits
321
    SAMPLE_FMT_FLT,             ///< float
322
};
323

    
324
/* in bytes */
325
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
326

    
327
/**
328
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
329
 * This is mainly needed because some optimized bitstream readers read
330
 * 32 or 64 bit at once and could read over the end.<br>
331
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
332
 * MPEG bitstreams could cause overread and segfault.
333
 */
334
#define FF_INPUT_BUFFER_PADDING_SIZE 8
335

    
336
/**
337
 * minimum encoding buffer size
338
 * Used to avoid some checks during header writing.
339
 */
340
#define FF_MIN_BUFFER_SIZE 16384
341

    
342
/**
343
 * motion estimation type.
344
 */
345
enum Motion_Est_ID {
346
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
347
    ME_FULL,
348
    ME_LOG,
349
    ME_PHODS,
350
    ME_EPZS,        ///< enhanced predictive zonal search
351
    ME_X1,          ///< reserved for experiments
352
    ME_HEX,         ///< hexagon based search
353
    ME_UMH,         ///< uneven multi-hexagon search
354
    ME_ITER,        ///< iterative search
355
};
356

    
357
enum AVDiscard{
358
    /* We leave some space between them for extensions (drop some
359
     * keyframes for intra-only or drop just some bidir frames). */
360
    AVDISCARD_NONE   =-16, ///< discard nothing
361
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
362
    AVDISCARD_NONREF =  8, ///< discard all non reference
363
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
364
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
365
    AVDISCARD_ALL    = 48, ///< discard all
366
};
367

    
368
typedef struct RcOverride{
369
    int start_frame;
370
    int end_frame;
371
    int qscale; // If this is 0 then quality_factor will be used instead.
372
    float quality_factor;
373
} RcOverride;
374

    
375
#define FF_MAX_B_FRAMES 16
376

    
377
/* encoding support
378
   These flags can be passed in AVCodecContext.flags before initialization.
379
   Note: Not everything is supported yet.
380
*/
381

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

    
442
/* Unsupported options :
443
 *              Syntax Arithmetic coding (SAC)
444
 *              Reference Picture Selection
445
 *              Independent Segment Decoding */
446
/* /Fx */
447
/* codec capabilities */
448

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

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

    
495
/**
496
 * Pan Scan area.
497
 * This specifies the area which should be displayed.
498
 * Note there may be multiple such areas for one frame.
499
 */
500
typedef struct AVPanScan{
501
    /**
502
     * id
503
     * - encoding: Set by user.
504
     * - decoding: Set by libavcodec.
505
     */
506
    int id;
507

    
508
    /**
509
     * width and height in 1/16 pel
510
     * - encoding: Set by user.
511
     * - decoding: Set by libavcodec.
512
     */
513
    int width;
514
    int height;
515

    
516
    /**
517
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
518
     * - encoding: Set by user.
519
     * - decoding: Set by libavcodec.
520
     */
521
    int16_t position[3][2];
522
}AVPanScan;
523

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

    
732
#define FF_QSCALE_TYPE_MPEG1 0
733
#define FF_QSCALE_TYPE_MPEG2 1
734
#define FF_QSCALE_TYPE_H264  2
735

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

    
741

    
742
#define FF_I_TYPE  1 // Intra
743
#define FF_P_TYPE  2 // Predicted
744
#define FF_B_TYPE  3 // Bi-dir predicted
745
#define FF_S_TYPE  4 // S(GMC)-VOP MPEG4
746
#define FF_SI_TYPE 5
747
#define FF_SP_TYPE 6
748

    
749
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
750
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
751
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
752
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
753

    
754
/**
755
 * Audio Video Frame.
756
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
757
 * bumps.
758
 * Removal, reordering and changes to existing fields require a major
759
 * version bump. No fields should be added into AVFrame before or after
760
 * FF_COMMON_FRAME!
761
 * sizeof(AVFrame) must not be used outside libav*.
762
 */
763
typedef struct AVFrame {
764
    FF_COMMON_FRAME
765
} AVFrame;
766

    
767
#define DEFAULT_FRAME_RATE_BASE 1001000
768

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

    
789
    /**
790
     * number of bits the bitstream is allowed to diverge from the reference.
791
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
792
     * - encoding: Set by user; unused for constant quantizer encoding.
793
     * - decoding: unused
794
     */
795
    int bit_rate_tolerance;
796

    
797
    /**
798
     * CODEC_FLAG_*.
799
     * - encoding: Set by user.
800
     * - decoding: Set by user.
801
     */
802
    int flags;
803

    
804
    /**
805
     * Some codecs need additional format info. It is stored here.
806
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
807
     * specific codec MUST set it correctly otherwise stream copy breaks.
808
     * In general use of this field by muxers is not recommanded.
809
     * - encoding: Set by libavcodec.
810
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
811
     */
812
    int sub_id;
813

    
814
    /**
815
     * Motion estimation algorithm used for video coding.
816
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
817
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
818
     * - encoding: MUST be set by user.
819
     * - decoding: unused
820
     */
821
    int me_method;
822

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

    
837
    /**
838
     * This is the fundamental unit of time (in seconds) in terms
839
     * of which frame timestamps are represented. For fixed-fps content,
840
     * timebase should be 1/framerate and timestamp increments should be
841
     * identically 1.
842
     * - encoding: MUST be set by user.
843
     * - decoding: Set by libavcodec.
844
     */
845
    AVRational time_base;
846

    
847
    /* video only */
848
    /**
849
     * picture width / height.
850
     * - encoding: MUST be set by user.
851
     * - decoding: Set by libavcodec.
852
     * Note: For compatibility it is possible to set this instead of
853
     * coded_width/height before decoding.
854
     */
855
    int width, height;
856

    
857
#define FF_ASPECT_EXTENDED 15
858

    
859
    /**
860
     * the number of pictures in a group of pictures, or 0 for intra_only
861
     * - encoding: Set by user.
862
     * - decoding: unused
863
     */
864
    int gop_size;
865

    
866
    /**
867
     * Pixel format, see PIX_FMT_xxx.
868
     * - encoding: Set by user.
869
     * - decoding: Set by libavcodec.
870
     */
871
    enum PixelFormat pix_fmt;
872

    
873
    /**
874
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
875
     * has to read frames at native frame rate.
876
     * - encoding: Set by user.
877
     * - decoding: unused
878
     */
879
    int rate_emu;
880

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

    
897
    /* audio only */
898
    int sample_rate; ///< samples per second
899
    int channels;
900

    
901
    /**
902
     * audio sample format
903
     * - encoding: Set by user.
904
     * - decoding: Set by libavcodec.
905
     */
906
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
907

    
908
    /* The following data should not be initialized. */
909
    /**
910
     * Samples per packet, initialized when calling 'init'.
911
     */
912
    int frame_size;
913
    int frame_number;   ///< audio or video frame number
914
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
915

    
916
    /**
917
     * Number of frames the decoded output will be delayed relative to
918
     * the encoded input.
919
     * - encoding: Set by libavcodec.
920
     * - decoding: unused
921
     */
922
    int delay;
923

    
924
    /* - encoding parameters */
925
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
926
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
927

    
928
    /**
929
     * minimum quantizer
930
     * - encoding: Set by user.
931
     * - decoding: unused
932
     */
933
    int qmin;
934

    
935
    /**
936
     * maximum quantizer
937
     * - encoding: Set by user.
938
     * - decoding: unused
939
     */
940
    int qmax;
941

    
942
    /**
943
     * maximum quantizer difference between frames
944
     * - encoding: Set by user.
945
     * - decoding: unused
946
     */
947
    int max_qdiff;
948

    
949
    /**
950
     * maximum number of B-frames between non-B-frames
951
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
952
     * - encoding: Set by user.
953
     * - decoding: unused
954
     */
955
    int max_b_frames;
956

    
957
    /**
958
     * qscale factor between IP and B-frames
959
     * - encoding: Set by user.
960
     * - decoding: unused
961
     */
962
    float b_quant_factor;
963

    
964
    /** obsolete FIXME remove */
965
    int rc_strategy;
966
#define FF_RC_STRATEGY_XVID 1
967

    
968
    int b_frame_strategy;
969

    
970
    /**
971
     * hurry up amount
972
     * - encoding: unused
973
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
974
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
975
     */
976
    int hurry_up;
977

    
978
    struct AVCodec *codec;
979

    
980
    void *priv_data;
981

    
982
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
983
    /* unused, FIXME remove*/
984
    int rtp_mode;
985
#endif
986

    
987
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
988
                            /* do its best to deliver a chunk with size     */
989
                            /* below rtp_payload_size, the chunk will start */
990
                            /* with a start code on some codecs like H.263. */
991
                            /* This doesn't take account of any particular  */
992
                            /* headers inside the transmitted RTP payload.  */
993

    
994

    
995
    /* The RTP callback: This function is called    */
996
    /* every time the encoder has a packet to send. */
997
    /* It depends on the encoder if the data starts */
998
    /* with a Start Code (it should). H.263 does.   */
999
    /* mb_nb contains the number of macroblocks     */
1000
    /* encoded in the RTP payload.                  */
1001
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1002

    
1003
    /* statistics, used for 2-pass encoding */
1004
    int mv_bits;
1005
    int header_bits;
1006
    int i_tex_bits;
1007
    int p_tex_bits;
1008
    int i_count;
1009
    int p_count;
1010
    int skip_count;
1011
    int misc_bits;
1012

    
1013
    /**
1014
     * number of bits used for the previously encoded frame
1015
     * - encoding: Set by libavcodec.
1016
     * - decoding: unused
1017
     */
1018
    int frame_bits;
1019

    
1020
    /**
1021
     * Private data of the user, can be used to carry app specific stuff.
1022
     * - encoding: Set by user.
1023
     * - decoding: Set by user.
1024
     */
1025
    void *opaque;
1026

    
1027
    char codec_name[32];
1028
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1029
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1030

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

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

    
1069
    /**
1070
     * luma single coefficient elimination threshold
1071
     * - encoding: Set by user.
1072
     * - decoding: unused
1073
     */
1074
    int luma_elim_threshold;
1075

    
1076
    /**
1077
     * chroma single coeff elimination threshold
1078
     * - encoding: Set by user.
1079
     * - decoding: unused
1080
     */
1081
    int chroma_elim_threshold;
1082

    
1083
    /**
1084
     * strictly follow the standard (MPEG4, ...).
1085
     * - encoding: Set by user.
1086
     * - decoding: unused
1087
     */
1088
    int strict_std_compliance;
1089
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1090
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1091
#define FF_COMPLIANCE_NORMAL        0
1092
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1093
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1094

    
1095
    /**
1096
     * qscale offset between IP and B-frames
1097
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1098
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1099
     * - encoding: Set by user.
1100
     * - decoding: unused
1101
     */
1102
    float b_quant_offset;
1103

    
1104
    /**
1105
     * Error resilience; higher values will detect more errors but may
1106
     * misdetect some more or less valid parts as errors.
1107
     * - encoding: unused
1108
     * - decoding: Set by user.
1109
     */
1110
    int error_resilience;
1111
#define FF_ER_CAREFUL         1
1112
#define FF_ER_COMPLIANT       2
1113
#define FF_ER_AGGRESSIVE      3
1114
#define FF_ER_VERY_AGGRESSIVE 4
1115

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

    
1126
    /**
1127
     * Called to release buffers which where allocated with get_buffer.
1128
     * A released buffer can be reused in get_buffer().
1129
     * pic.data[*] must be set to NULL.
1130
     * - encoding: unused
1131
     * - decoding: Set by libavcodec., user can override.
1132
     */
1133
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1134

    
1135
    /**
1136
     * If 1 the stream has a 1 frame delay during decoding.
1137
     * - encoding: Set by libavcodec.
1138
     * - decoding: Set by libavcodec.
1139
     */
1140
    int has_b_frames;
1141

    
1142
    /**
1143
     * number of bytes per packet if constant and known or 0
1144
     * Used by some WAV based audio codecs.
1145
     */
1146
    int block_align;
1147

    
1148
    int parse_only; /* - decoding only: If true, only parsing is done
1149
                       (function avcodec_parse_frame()). The frame
1150
                       data is returned. Only MPEG codecs support this now. */
1151

    
1152
    /**
1153
     * 0-> h263 quant 1-> mpeg quant
1154
     * - encoding: Set by user.
1155
     * - decoding: unused
1156
     */
1157
    int mpeg_quant;
1158

    
1159
    /**
1160
     * pass1 encoding statistics output buffer
1161
     * - encoding: Set by libavcodec.
1162
     * - decoding: unused
1163
     */
1164
    char *stats_out;
1165

    
1166
    /**
1167
     * pass2 encoding statistics input buffer
1168
     * Concatenated stuff from stats_out of pass1 should be placed here.
1169
     * - encoding: Allocated/set/freed by user.
1170
     * - decoding: unused
1171
     */
1172
    char *stats_in;
1173

    
1174
    /**
1175
     * ratecontrol qmin qmax limiting method
1176
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1177
     * - encoding: Set by user.
1178
     * - decoding: unused
1179
     */
1180
    float rc_qsquish;
1181

    
1182
    float rc_qmod_amp;
1183
    int rc_qmod_freq;
1184

    
1185
    /**
1186
     * ratecontrol override, see RcOverride
1187
     * - encoding: Allocated/set/freed by user.
1188
     * - decoding: unused
1189
     */
1190
    RcOverride *rc_override;
1191
    int rc_override_count;
1192

    
1193
    /**
1194
     * rate control equation
1195
     * - encoding: Set by user
1196
     * - decoding: unused
1197
     */
1198
    char *rc_eq;
1199

    
1200
    /**
1201
     * maximum bitrate
1202
     * - encoding: Set by user.
1203
     * - decoding: unused
1204
     */
1205
    int rc_max_rate;
1206

    
1207
    /**
1208
     * minimum bitrate
1209
     * - encoding: Set by user.
1210
     * - decoding: unused
1211
     */
1212
    int rc_min_rate;
1213

    
1214
    /**
1215
     * decoder bitstream buffer size
1216
     * - encoding: Set by user.
1217
     * - decoding: unused
1218
     */
1219
    int rc_buffer_size;
1220
    float rc_buffer_aggressivity;
1221

    
1222
    /**
1223
     * qscale factor between P and I-frames
1224
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1225
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1226
     * - encoding: Set by user.
1227
     * - decoding: unused
1228
     */
1229
    float i_quant_factor;
1230

    
1231
    /**
1232
     * qscale offset between P and I-frames
1233
     * - encoding: Set by user.
1234
     * - decoding: unused
1235
     */
1236
    float i_quant_offset;
1237

    
1238
    /**
1239
     * initial complexity for pass1 ratecontrol
1240
     * - encoding: Set by user.
1241
     * - decoding: unused
1242
     */
1243
    float rc_initial_cplx;
1244

    
1245
    /**
1246
     * DCT algorithm, see FF_DCT_* below
1247
     * - encoding: Set by user.
1248
     * - decoding: unused
1249
     */
1250
    int dct_algo;
1251
#define FF_DCT_AUTO    0
1252
#define FF_DCT_FASTINT 1
1253
#define FF_DCT_INT     2
1254
#define FF_DCT_MMX     3
1255
#define FF_DCT_MLIB    4
1256
#define FF_DCT_ALTIVEC 5
1257
#define FF_DCT_FAAN    6
1258

    
1259
    /**
1260
     * luminance masking (0-> disabled)
1261
     * - encoding: Set by user.
1262
     * - decoding: unused
1263
     */
1264
    float lumi_masking;
1265

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

    
1273
    /**
1274
     * spatial complexity masking (0-> disabled)
1275
     * - encoding: Set by user.
1276
     * - decoding: unused
1277
     */
1278
    float spatial_cplx_masking;
1279

    
1280
    /**
1281
     * p block masking (0-> disabled)
1282
     * - encoding: Set by user.
1283
     * - decoding: unused
1284
     */
1285
    float p_masking;
1286

    
1287
    /**
1288
     * darkness masking (0-> disabled)
1289
     * - encoding: Set by user.
1290
     * - decoding: unused
1291
     */
1292
    float dark_masking;
1293

    
1294

    
1295
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1296
    /* for binary compatibility */
1297
    int unused;
1298
#endif
1299

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

    
1327
    /**
1328
     * slice count
1329
     * - encoding: Set by libavcodec.
1330
     * - decoding: Set by user (or 0).
1331
     */
1332
    int slice_count;
1333
    /**
1334
     * slice offsets in the frame in bytes
1335
     * - encoding: Set/allocated by libavcodec.
1336
     * - decoding: Set/allocated by user (or NULL).
1337
     */
1338
    int *slice_offset;
1339

    
1340
    /**
1341
     * error concealment flags
1342
     * - encoding: unused
1343
     * - decoding: Set by user.
1344
     */
1345
    int error_concealment;
1346
#define FF_EC_GUESS_MVS   1
1347
#define FF_EC_DEBLOCK     2
1348

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

    
1370
    /**
1371
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1372
     * - encoding: Set by libavcodec.
1373
     * - decoding: Set by user.
1374
     */
1375
     int bits_per_sample;
1376

    
1377
    /**
1378
     * prediction method (needed for huffyuv)
1379
     * - encoding: Set by user.
1380
     * - decoding: unused
1381
     */
1382
     int prediction_method;
1383
#define FF_PRED_LEFT   0
1384
#define FF_PRED_PLANE  1
1385
#define FF_PRED_MEDIAN 2
1386

    
1387
    /**
1388
     * sample aspect ratio (0 if unknown)
1389
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1390
     * - encoding: Set by user.
1391
     * - decoding: Set by libavcodec.
1392
     */
1393
    AVRational sample_aspect_ratio;
1394

    
1395
    /**
1396
     * the picture in the bitstream
1397
     * - encoding: Set by libavcodec.
1398
     * - decoding: Set by libavcodec.
1399
     */
1400
    AVFrame *coded_frame;
1401

    
1402
    /**
1403
     * debug
1404
     * - encoding: Set by user.
1405
     * - decoding: Set by user.
1406
     */
1407
    int debug;
1408
#define FF_DEBUG_PICT_INFO   1
1409
#define FF_DEBUG_RC          2
1410
#define FF_DEBUG_BITSTREAM   4
1411
#define FF_DEBUG_MB_TYPE     8
1412
#define FF_DEBUG_QP          16
1413
#define FF_DEBUG_MV          32
1414
#define FF_DEBUG_DCT_COEFF   0x00000040
1415
#define FF_DEBUG_SKIP        0x00000080
1416
#define FF_DEBUG_STARTCODE   0x00000100
1417
#define FF_DEBUG_PTS         0x00000200
1418
#define FF_DEBUG_ER          0x00000400
1419
#define FF_DEBUG_MMCO        0x00000800
1420
#define FF_DEBUG_BUGS        0x00001000
1421
#define FF_DEBUG_VIS_QP      0x00002000
1422
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1423

    
1424
    /**
1425
     * debug
1426
     * - encoding: Set by user.
1427
     * - decoding: Set by user.
1428
     */
1429
    int debug_mv;
1430
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1431
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1432
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1433

    
1434
    /**
1435
     * error
1436
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1437
     * - decoding: unused
1438
     */
1439
    uint64_t error[4];
1440

    
1441
    /**
1442
     * minimum MB quantizer
1443
     * - encoding: unused
1444
     * - decoding: unused
1445
     */
1446
    int mb_qmin;
1447

    
1448
    /**
1449
     * maximum MB quantizer
1450
     * - encoding: unused
1451
     * - decoding: unused
1452
     */
1453
    int mb_qmax;
1454

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

    
1496
    /**
1497
     * ME diamond size & shape
1498
     * - encoding: Set by user.
1499
     * - decoding: unused
1500
     */
1501
    int dia_size;
1502

    
1503
    /**
1504
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1505
     * - encoding: Set by user.
1506
     * - decoding: unused
1507
     */
1508
    int last_predictor_count;
1509

    
1510
    /**
1511
     * prepass for motion estimation
1512
     * - encoding: Set by user.
1513
     * - decoding: unused
1514
     */
1515
    int pre_me;
1516

    
1517
    /**
1518
     * motion estimation prepass comparison function
1519
     * - encoding: Set by user.
1520
     * - decoding: unused
1521
     */
1522
    int me_pre_cmp;
1523

    
1524
    /**
1525
     * ME prepass diamond size & shape
1526
     * - encoding: Set by user.
1527
     * - decoding: unused
1528
     */
1529
    int pre_dia_size;
1530

    
1531
    /**
1532
     * subpel ME quality
1533
     * - encoding: Set by user.
1534
     * - decoding: unused
1535
     */
1536
    int me_subpel_quality;
1537

    
1538
    /**
1539
     * callback to negotiate the pixelFormat
1540
     * @param fmt is the list of formats which are supported by the codec,
1541
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1542
     * The first is always the native one.
1543
     * @return the chosen format
1544
     * - encoding: unused
1545
     * - decoding: Set by user, if not set the native format will be chosen.
1546
     */
1547
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1548

    
1549
    /**
1550
     * DTG active format information (additional aspect ratio
1551
     * information only used in DVB MPEG-2 transport streams)
1552
     * 0 if not set.
1553
     *
1554
     * - encoding: unused
1555
     * - decoding: Set by decoder.
1556
     */
1557
    int dtg_active_format;
1558
#define FF_DTG_AFD_SAME         8
1559
#define FF_DTG_AFD_4_3          9
1560
#define FF_DTG_AFD_16_9         10
1561
#define FF_DTG_AFD_14_9         11
1562
#define FF_DTG_AFD_4_3_SP_14_9  13
1563
#define FF_DTG_AFD_16_9_SP_14_9 14
1564
#define FF_DTG_AFD_SP_4_3       15
1565

    
1566
    /**
1567
     * maximum motion estimation search range in subpel units
1568
     * If 0 then no limit.
1569
     *
1570
     * - encoding: Set by user.
1571
     * - decoding: unused
1572
     */
1573
    int me_range;
1574

    
1575
    /**
1576
     * intra quantizer bias
1577
     * - encoding: Set by user.
1578
     * - decoding: unused
1579
     */
1580
    int intra_quant_bias;
1581
#define FF_DEFAULT_QUANT_BIAS 999999
1582

    
1583
    /**
1584
     * inter quantizer bias
1585
     * - encoding: Set by user.
1586
     * - decoding: unused
1587
     */
1588
    int inter_quant_bias;
1589

    
1590
    /**
1591
     * color table ID
1592
     * - encoding: unused
1593
     * - decoding: Which clrtable should be used for 8bit RGB images.
1594
     *             Tables have to be stored somewhere. FIXME
1595
     */
1596
    int color_table_id;
1597

    
1598
    /**
1599
     * internal_buffer count
1600
     * Don't touch, used by libavcodec default_get_buffer().
1601
     */
1602
    int internal_buffer_count;
1603

    
1604
    /**
1605
     * internal_buffers
1606
     * Don't touch, used by libavcodec default_get_buffer().
1607
     */
1608
    void *internal_buffer;
1609

    
1610
#define FF_LAMBDA_SHIFT 7
1611
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1612
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1613
#define FF_LAMBDA_MAX (256*128-1)
1614

    
1615
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1616
    /**
1617
     * Global quality for codecs which cannot change it per frame.
1618
     * This should be proportional to MPEG-1/2/4 qscale.
1619
     * - encoding: Set by user.
1620
     * - decoding: unused
1621
     */
1622
    int global_quality;
1623

    
1624
#define FF_CODER_TYPE_VLC       0
1625
#define FF_CODER_TYPE_AC        1
1626
#define FF_CODER_TYPE_RAW       2
1627
#define FF_CODER_TYPE_RLE       3
1628
#define FF_CODER_TYPE_DEFLATE   4
1629
    /**
1630
     * coder type
1631
     * - encoding: Set by user.
1632
     * - decoding: unused
1633
     */
1634
    int coder_type;
1635

    
1636
    /**
1637
     * context model
1638
     * - encoding: Set by user.
1639
     * - decoding: unused
1640
     */
1641
    int context_model;
1642
#if 0
1643
    /**
1644
     *
1645
     * - encoding: unused
1646
     * - decoding: Set by user.
1647
     */
1648
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1649
#endif
1650

    
1651
    /**
1652
     * slice flags
1653
     * - encoding: unused
1654
     * - decoding: Set by user.
1655
     */
1656
    int slice_flags;
1657
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1658
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1659
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1660

    
1661
    /**
1662
     * XVideo Motion Acceleration
1663
     * - encoding: forbidden
1664
     * - decoding: set by decoder
1665
     */
1666
    int xvmc_acceleration;
1667

    
1668
    /**
1669
     * macroblock decision mode
1670
     * - encoding: Set by user.
1671
     * - decoding: unused
1672
     */
1673
    int mb_decision;
1674
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1675
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1676
#define FF_MB_DECISION_RD     2        ///< rate distoration
1677

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

    
1685
    /**
1686
     * custom inter quantization matrix
1687
     * - encoding: Set by user, can be NULL.
1688
     * - decoding: Set by libavcodec.
1689
     */
1690
    uint16_t *inter_matrix;
1691

    
1692
    /**
1693
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1694
     * This is used to work around some encoder bugs.
1695
     * - encoding: unused
1696
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1697
     */
1698
    unsigned int stream_codec_tag;
1699

    
1700
    /**
1701
     * scene change detection threshold
1702
     * 0 is default, larger means fewer detected scene changes.
1703
     * - encoding: Set by user.
1704
     * - decoding: unused
1705
     */
1706
    int scenechange_threshold;
1707

    
1708
    /**
1709
     * minimum Lagrange multipler
1710
     * - encoding: Set by user.
1711
     * - decoding: unused
1712
     */
1713
    int lmin;
1714

    
1715
    /**
1716
     * maximum Lagrange multipler
1717
     * - encoding: Set by user.
1718
     * - decoding: unused
1719
     */
1720
    int lmax;
1721

    
1722
    /**
1723
     * palette control structure
1724
     * - encoding: ??? (no palette-enabled encoder yet)
1725
     * - decoding: Set by user.
1726
     */
1727
    struct AVPaletteControl *palctrl;
1728

    
1729
    /**
1730
     * noise reduction strength
1731
     * - encoding: Set by user.
1732
     * - decoding: unused
1733
     */
1734
    int noise_reduction;
1735

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

    
1747
    /**
1748
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1749
     * - encoding: Set by user.
1750
     * - decoding: unused
1751
     */
1752
    int rc_initial_buffer_occupancy;
1753

    
1754
    /**
1755
     *
1756
     * - encoding: Set by user.
1757
     * - decoding: unused
1758
     */
1759
    int inter_threshold;
1760

    
1761
    /**
1762
     * CODEC_FLAG2_*
1763
     * - encoding: Set by user.
1764
     * - decoding: Set by user.
1765
     */
1766
    int flags2;
1767

    
1768
    /**
1769
     * Simulates errors in the bitstream to test error concealment.
1770
     * - encoding: Set by user.
1771
     * - decoding: unused
1772
     */
1773
    int error_rate;
1774

    
1775
    /**
1776
     * MP3 antialias algorithm, see FF_AA_* below.
1777
     * - encoding: unused
1778
     * - decoding: Set by user.
1779
     */
1780
    int antialias_algo;
1781
#define FF_AA_AUTO    0
1782
#define FF_AA_FASTINT 1 //not implemented yet
1783
#define FF_AA_INT     2
1784
#define FF_AA_FLOAT   3
1785
    /**
1786
     * quantizer noise shaping
1787
     * - encoding: Set by user.
1788
     * - decoding: unused
1789
     */
1790
    int quantizer_noise_shaping;
1791

    
1792
    /**
1793
     * thread count
1794
     * is used to decide how many independent tasks should be passed to execute()
1795
     * - encoding: Set by user.
1796
     * - decoding: Set by user.
1797
     */
1798
    int thread_count;
1799

    
1800
    /**
1801
     * The codec may call this to execute several independent things.
1802
     * It will return only after finishing all tasks.
1803
     * The user may replace this with some multithreaded implementation,
1804
     * the default implementation will execute the parts serially.
1805
     * @param count the number of things to execute
1806
     * - encoding: Set by libavcodec, user can override.
1807
     * - decoding: Set by libavcodec, user can override.
1808
     */
1809
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1810

    
1811
    /**
1812
     * thread opaque
1813
     * Can be used by execute() to store some per AVCodecContext stuff.
1814
     * - encoding: set by execute()
1815
     * - decoding: set by execute()
1816
     */
1817
    void *thread_opaque;
1818

    
1819
    /**
1820
     * Motion estimation threshold below which no motion estimation is
1821
     * performed, but instead the user specified motion vectors are used.
1822
     *
1823
     * - encoding: Set by user.
1824
     * - decoding: unused
1825
     */
1826
     int me_threshold;
1827

    
1828
    /**
1829
     * Macroblock threshold below which the user specified macroblock types will be used.
1830
     * - encoding: Set by user.
1831
     * - decoding: unused
1832
     */
1833
     int mb_threshold;
1834

    
1835
    /**
1836
     * precision of the intra DC coefficient - 8
1837
     * - encoding: Set by user.
1838
     * - decoding: unused
1839
     */
1840
     int intra_dc_precision;
1841

    
1842
    /**
1843
     * noise vs. sse weight for the nsse comparsion function
1844
     * - encoding: Set by user.
1845
     * - decoding: unused
1846
     */
1847
     int nsse_weight;
1848

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

    
1856
    /**
1857
     * Number of macroblock rows at the bottom which are skipped.
1858
     * - encoding: unused
1859
     * - decoding: Set by user.
1860
     */
1861
     int skip_bottom;
1862

    
1863
    /**
1864
     * profile
1865
     * - encoding: Set by user.
1866
     * - decoding: Set by libavcodec.
1867
     */
1868
     int profile;
1869
#define FF_PROFILE_UNKNOWN -99
1870
#define FF_PROFILE_AAC_MAIN 0
1871
#define FF_PROFILE_AAC_LOW  1
1872
#define FF_PROFILE_AAC_SSR  2
1873
#define FF_PROFILE_AAC_LTP  3
1874

    
1875
    /**
1876
     * level
1877
     * - encoding: Set by user.
1878
     * - decoding: Set by libavcodec.
1879
     */
1880
     int level;
1881
#define FF_LEVEL_UNKNOWN -99
1882

    
1883
    /**
1884
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1885
     * - encoding: unused
1886
     * - decoding: Set by user.
1887
     */
1888
     int lowres;
1889

    
1890
    /**
1891
     * Bitstream width / height, may be different from width/height if lowres
1892
     * or other things are used.
1893
     * - encoding: unused
1894
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1895
     */
1896
    int coded_width, coded_height;
1897

    
1898
    /**
1899
     * frame skip threshold
1900
     * - encoding: Set by user.
1901
     * - decoding: unused
1902
     */
1903
    int frame_skip_threshold;
1904

    
1905
    /**
1906
     * frame skip factor
1907
     * - encoding: Set by user.
1908
     * - decoding: unused
1909
     */
1910
    int frame_skip_factor;
1911

    
1912
    /**
1913
     * frame skip exponent
1914
     * - encoding: Set by user.
1915
     * - decoding: unused
1916
     */
1917
    int frame_skip_exp;
1918

    
1919
    /**
1920
     * frame skip comparison function
1921
     * - encoding: Set by user.
1922
     * - decoding: unused
1923
     */
1924
    int frame_skip_cmp;
1925

    
1926
    /**
1927
     * Border processing masking, raises the quantizer for mbs on the borders
1928
     * of the picture.
1929
     * - encoding: Set by user.
1930
     * - decoding: unused
1931
     */
1932
    float border_masking;
1933

    
1934
    /**
1935
     * minimum MB lagrange multipler
1936
     * - encoding: Set by user.
1937
     * - decoding: unused
1938
     */
1939
    int mb_lmin;
1940

    
1941
    /**
1942
     * maximum MB lagrange multipler
1943
     * - encoding: Set by user.
1944
     * - decoding: unused
1945
     */
1946
    int mb_lmax;
1947

    
1948
    /**
1949
     *
1950
     * - encoding: Set by user.
1951
     * - decoding: unused
1952
     */
1953
    int me_penalty_compensation;
1954

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

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

    
1969
    /**
1970
     *
1971
     * - encoding: unused
1972
     * - decoding: Set by user.
1973
     */
1974
    enum AVDiscard skip_frame;
1975

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

    
1983
    /**
1984
     *
1985
     * - encoding: Set by user.
1986
     * - decoding: unused
1987
     */
1988
    int brd_scale;
1989

    
1990
    /**
1991
     * constant rate factor - quality-based VBR - values ~correspond to qps
1992
     * - encoding: Set by user.
1993
     * - decoding: unused
1994
     */
1995
    float crf;
1996

    
1997
    /**
1998
     * constant quantization parameter rate control method
1999
     * - encoding: Set by user.
2000
     * - decoding: unused
2001
     */
2002
    int cqp;
2003

    
2004
    /**
2005
     * minimum GOP size
2006
     * - encoding: Set by user.
2007
     * - decoding: unused
2008
     */
2009
    int keyint_min;
2010

    
2011
    /**
2012
     * number of reference frames
2013
     * - encoding: Set by user.
2014
     * - decoding: unused
2015
     */
2016
    int refs;
2017

    
2018
    /**
2019
     * chroma qp offset from luma
2020
     * - encoding: Set by user.
2021
     * - decoding: unused
2022
     */
2023
    int chromaoffset;
2024

    
2025
    /**
2026
     * Influences how often B-frames are used.
2027
     * - encoding: Set by user.
2028
     * - decoding: unused
2029
     */
2030
    int bframebias;
2031

    
2032
    /**
2033
     * trellis RD quantization
2034
     * - encoding: Set by user.
2035
     * - decoding: unused
2036
     */
2037
    int trellis;
2038

    
2039
    /**
2040
     * Reduce fluctuations in qp (before curve compression).
2041
     * - encoding: Set by user.
2042
     * - decoding: unused
2043
     */
2044
    float complexityblur;
2045

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

    
2054
    /**
2055
     * in-loop deblocking filter beta parameter
2056
     * beta is in the range -6...6
2057
     * - encoding: Set by user.
2058
     * - decoding: unused
2059
     */
2060
    int deblockbeta;
2061

    
2062
    /**
2063
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2064
     * - encoding: Set by user.
2065
     * - decoding: unused
2066
     */
2067
    int partitions;
2068
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2069
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2070
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2071
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2072
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2073

    
2074
    /**
2075
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2076
     * - encoding: Set by user.
2077
     * - decoding: unused
2078
     */
2079
    int directpred;
2080

    
2081
    /**
2082
     * Audio cutoff bandwidth (0 means "automatic")
2083
     * - encoding: Set by user.
2084
     * - decoding: unused
2085
     */
2086
    int cutoff;
2087

    
2088
    /**
2089
     * Multiplied by qscale for each frame and added to scene_change_score.
2090
     * - encoding: Set by user.
2091
     * - decoding: unused
2092
     */
2093
    int scenechange_factor;
2094

    
2095
    /**
2096
     *
2097
     * Note: Value depends upon the compare function used for fullpel ME.
2098
     * - encoding: Set by user.
2099
     * - decoding: unused
2100
     */
2101
    int mv0_threshold;
2102

    
2103
    /**
2104
     * Adjusts sensitivity of b_frame_strategy 1.
2105
     * - encoding: Set by user.
2106
     * - decoding: unused
2107
     */
2108
    int b_sensitivity;
2109

    
2110
    /**
2111
     * - encoding: Set by user.
2112
     * - decoding: unused
2113
     */
2114
    int compression_level;
2115
#define FF_COMPRESSION_DEFAULT -1
2116

    
2117
    /**
2118
     * Sets whether to use LPC mode - used by FLAC encoder.
2119
     * - encoding: Set by user.
2120
     * - decoding: unused
2121
     */
2122
    int use_lpc;
2123

    
2124
    /**
2125
     * LPC coefficient precision - used by FLAC encoder
2126
     * - encoding: Set by user.
2127
     * - decoding: unused
2128
     */
2129
    int lpc_coeff_precision;
2130

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

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

    
2143
    /**
2144
     * search method for selecting prediction order
2145
     * - encoding: Set by user.
2146
     * - decoding: unused
2147
     */
2148
    int prediction_order_method;
2149

    
2150
    /**
2151
     * - encoding: Set by user.
2152
     * - decoding: unused
2153
     */
2154
    int min_partition_order;
2155

    
2156
    /**
2157
     * - encoding: Set by user.
2158
     * - decoding: unused
2159
     */
2160
    int max_partition_order;
2161

    
2162
    /**
2163
     * GOP timecode frame start number, in non drop frame format
2164
     * - encoding: Set by user.
2165
     * - decoding: unused
2166
     */
2167
    int64_t timecode_frame_start;
2168

    
2169
    /**
2170
     * Decoder should decode to this many channels if it can (0 for default)
2171
     * - encoding: unused
2172
     * - decoding: Set by user.
2173
     */
2174
    int request_channels;
2175

    
2176
    /**
2177
     * Percentage of dynamic range compression to be applied by the decoder.
2178
     * The default value is 1.0, corresponding to full compression.
2179
     * - encoding: unused
2180
     * - decoding: Set by user.
2181
     */
2182
    float drc_scale;
2183
} AVCodecContext;
2184

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

    
2211
/**
2212
 * four components are given, that's all.
2213
 * the last component is alpha
2214
 */
2215
typedef struct AVPicture {
2216
    uint8_t *data[4];
2217
    int linesize[4];       ///< number of bytes per line
2218
} AVPicture;
2219

    
2220
/**
2221
 * AVPaletteControl
2222
 * This structure defines a method for communicating palette changes
2223
 * between and demuxer and a decoder.
2224
 *
2225
 * @deprecated Use AVPacket to send palette changes instead.
2226
 * This is totally broken.
2227
 */
2228
#define AVPALETTE_SIZE 1024
2229
#define AVPALETTE_COUNT 256
2230
typedef struct AVPaletteControl {
2231

    
2232
    /* Demuxer sets this to 1 to indicate the palette has changed;
2233
     * decoder resets to 0. */
2234
    int palette_changed;
2235

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

    
2242
} AVPaletteControl attribute_deprecated;
2243

    
2244
typedef struct AVSubtitleRect {
2245
    uint16_t x;
2246
    uint16_t y;
2247
    uint16_t w;
2248
    uint16_t h;
2249
    uint16_t nb_colors;
2250
    int linesize;
2251
    uint32_t *rgba_palette;
2252
    uint8_t *bitmap;
2253
} AVSubtitleRect;
2254

    
2255
typedef struct AVSubtitle {
2256
    uint16_t format; /* 0 = graphics */
2257
    uint32_t start_display_time; /* relative to packet pts, in ms */
2258
    uint32_t end_display_time; /* relative to packet pts, in ms */
2259
    uint32_t num_rects;
2260
    AVSubtitleRect *rects;
2261
} AVSubtitle;
2262

    
2263

    
2264
/* resample.c */
2265

    
2266
struct ReSampleContext;
2267
struct AVResampleContext;
2268

    
2269
typedef struct ReSampleContext ReSampleContext;
2270

    
2271
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2272
                                     int output_rate, int input_rate);
2273
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2274
void audio_resample_close(ReSampleContext *s);
2275

    
2276
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2277
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2278
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2279
void av_resample_close(struct AVResampleContext *c);
2280

    
2281
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2282
/* YUV420 format is assumed ! */
2283

    
2284
/**
2285
 * @deprecated Use the software scaler (swscale) instead.
2286
 */
2287
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2288

    
2289
/**
2290
 * @deprecated Use the software scaler (swscale) instead.
2291
 */
2292
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2293
                                      int input_width, int input_height);
2294

    
2295
/**
2296
 * @deprecated Use the software scaler (swscale) instead.
2297
 */
2298
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2299
                                      int iwidth, int iheight,
2300
                                      int topBand, int bottomBand,
2301
                                      int leftBand, int rightBand,
2302
                                      int padtop, int padbottom,
2303
                                      int padleft, int padright);
2304

    
2305
/**
2306
 * @deprecated Use the software scaler (swscale) instead.
2307
 */
2308
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2309
                  AVPicture *output, const AVPicture *input);
2310

    
2311
/**
2312
 * @deprecated Use the software scaler (swscale) instead.
2313
 */
2314
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2315

    
2316
#endif
2317

    
2318
/**
2319
 * Allocate memory for a picture.  Call avpicture_free to free it.
2320
 *
2321
 * @param picture the picture to be filled in
2322
 * @param pix_fmt the format of the picture
2323
 * @param width the width of the picture
2324
 * @param height the height of the picture
2325
 * @return zero if successful, a negative value if not
2326
 */
2327
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2328

    
2329
/**
2330
 * Free a picture previously allocated by avpicture_alloc().
2331
 *
2332
 * @param picture the AVPicture to be freed
2333
 */
2334
void avpicture_free(AVPicture *picture);
2335

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

    
2357
/**
2358
 * Calculate the size in bytes that a picture of the given width and height
2359
 * would occupy if stored in the given picture format.
2360
 *
2361
 * @param pix_fmt the given picture format
2362
 * @param width the width of the image
2363
 * @param height the height of the image
2364
 * @return Image data size in bytes
2365
 */
2366
int avpicture_get_size(int pix_fmt, int width, int height);
2367
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2368
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2369
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2370
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2371
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2372

    
2373
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2374
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2375
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2376
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2377
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2378
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2379

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

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

    
2425

    
2426
/**
2427
 * Print in buf the string corresponding to the pixel format with
2428
 * number pix_fmt, or an header if pix_fmt is negative.
2429
 *
2430
 * @param[in] buf the buffer where to write the string
2431
 * @param[in] buf_size the size of buf
2432
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2433
 * a negative value to print the corresponding header.
2434
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2435
 */
2436
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2437

    
2438
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2439
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2440

    
2441
/**
2442
 * Tell if an image really has transparent alpha values.
2443
 * @return ored mask of FF_ALPHA_xxx constants
2444
 */
2445
int img_get_alpha_info(const AVPicture *src,
2446
                       int pix_fmt, int width, int height);
2447

    
2448
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2449
/**
2450
 * convert among pixel formats
2451
 * @deprecated Use the software scaler (swscale) instead.
2452
 */
2453
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2454
                const AVPicture *src, int pix_fmt,
2455
                int width, int height);
2456
#endif
2457

    
2458
/* deinterlace a picture */
2459
/* deinterlace - if not supported return -1 */
2460
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2461
                          int pix_fmt, int width, int height);
2462

    
2463
/* external high level API */
2464

    
2465
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2466
extern AVCodec *first_avcodec;
2467
#endif
2468
AVCodec *av_codec_next(AVCodec *c);
2469

    
2470
/* returns LIBAVCODEC_VERSION_INT constant */
2471
unsigned avcodec_version(void);
2472
/* returns LIBAVCODEC_BUILD constant */
2473
unsigned avcodec_build(void);
2474

    
2475
/**
2476
 * Initializes libavcodec.
2477
 *
2478
 * @warning This function \e must be called before any other libavcodec
2479
 * function.
2480
 */
2481
void avcodec_init(void);
2482

    
2483
void register_avcodec(AVCodec *format);
2484

    
2485
/**
2486
 * Finds a registered encoder with a matching codec ID.
2487
 *
2488
 * @param id CodecID of the requested encoder
2489
 * @return An encoder if one was found, NULL otherwise.
2490
 */
2491
AVCodec *avcodec_find_encoder(enum CodecID id);
2492

    
2493
/**
2494
 * Finds a registered encoder with the specified name.
2495
 *
2496
 * @param name name of the requested encoder
2497
 * @return An encoder if one was found, NULL otherwise.
2498
 */
2499
AVCodec *avcodec_find_encoder_by_name(const char *name);
2500

    
2501
/**
2502
 * Finds a registered decoder with a matching codec ID.
2503
 *
2504
 * @param id CodecID of the requested decoder
2505
 * @return A decoder if one was found, NULL otherwise.
2506
 */
2507
AVCodec *avcodec_find_decoder(enum CodecID id);
2508

    
2509
/**
2510
 * Finds a registered decoder with the specified name.
2511
 *
2512
 * @param name name of the requested decoder
2513
 * @return A decoder if one was found, NULL otherwise.
2514
 */
2515
AVCodec *avcodec_find_decoder_by_name(const char *name);
2516
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2517

    
2518
/**
2519
 * Sets the fields of the given AVCodecContext to default values.
2520
 *
2521
 * @param s The AVCodecContext of which the fields should be set to default values.
2522
 */
2523
void avcodec_get_context_defaults(AVCodecContext *s);
2524

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

    
2529
/**
2530
 * Allocates an AVCodecContext and sets its fields to default values.  The
2531
 * resulting struct can be deallocated by simply calling av_free().
2532
 *
2533
 * @return An AVCodecContext filled with default values or NULL on failure.
2534
 * @see avcodec_get_context_defaults
2535
 */
2536
AVCodecContext *avcodec_alloc_context(void);
2537

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

    
2542
/**
2543
 * Sets the fields of the given AVFrame to default values.
2544
 *
2545
 * @param pic The AVFrame of which the fields should be set to default values.
2546
 */
2547
void avcodec_get_frame_defaults(AVFrame *pic);
2548

    
2549
/**
2550
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2551
 * struct can be deallocated by simply calling av_free().
2552
 *
2553
 * @return An AVFrame filled with default values or NULL on failure.
2554
 * @see avcodec_get_frame_defaults
2555
 */
2556
AVFrame *avcodec_alloc_frame(void);
2557

    
2558
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2559
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2560
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2561
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2562

    
2563
/**
2564
 * Checks if the given dimension of a picture is valid, meaning that all
2565
 * bytes of the picture can be addressed with a signed int.
2566
 *
2567
 * @param[in] w Width of the picture.
2568
 * @param[in] h Height of the picture.
2569
 * @return Zero if valid, a negative value if invalid.
2570
 */
2571
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2572
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2573

    
2574
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2575
void avcodec_thread_free(AVCodecContext *s);
2576
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2577
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2578
//FIXME func typedef
2579

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

    
2609
/**
2610
 * @deprecated Use avcodec_decode_audio2() instead.
2611
 */
2612
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2613
                         int *frame_size_ptr,
2614
                         const uint8_t *buf, int buf_size);
2615

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

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

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

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

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

    
2742
int avcodec_close(AVCodecContext *avctx);
2743

    
2744
void avcodec_register_all(void);
2745

    
2746
/**
2747
 * Flush buffers, should be called when seeking or when switching to a different stream.
2748
 */
2749
void avcodec_flush_buffers(AVCodecContext *avctx);
2750

    
2751
void avcodec_default_free_buffers(AVCodecContext *s);
2752

    
2753
/* misc useful functions */
2754

    
2755
/**
2756
 * Returns a single letter to describe the given picture type \p pict_type.
2757
 *
2758
 * @param[in] pict_type the picture type
2759
 * @return A single character representing the picture type.
2760
 */
2761
char av_get_pict_type_char(int pict_type);
2762

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

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

    
2779
/* frame parsing */
2780
typedef struct AVCodecParserContext {
2781
    void *priv_data;
2782
    struct AVCodecParser *parser;
2783
    int64_t frame_offset; /* offset of the current frame */
2784
    int64_t cur_offset; /* current offset
2785
                           (incremented by each av_parser_parse()) */
2786
    int64_t last_frame_offset; /* offset of the last frame */
2787
    /* video info */
2788
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2789
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2790
    int64_t pts;     /* pts of the current frame */
2791
    int64_t dts;     /* dts of the current frame */
2792

    
2793
    /* private data */
2794
    int64_t last_pts;
2795
    int64_t last_dts;
2796
    int fetch_timestamp;
2797

    
2798
#define AV_PARSER_PTS_NB 4
2799
    int cur_frame_start_index;
2800
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2801
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2802
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2803

    
2804
    int flags;
2805
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2806

    
2807
    int64_t offset;      ///< byte offset from starting packet start
2808
    int64_t last_offset;
2809
} AVCodecParserContext;
2810

    
2811
typedef struct AVCodecParser {
2812
    int codec_ids[5]; /* several codec IDs are permitted */
2813
    int priv_data_size;
2814
    int (*parser_init)(AVCodecParserContext *s);
2815
    int (*parser_parse)(AVCodecParserContext *s,
2816
                        AVCodecContext *avctx,
2817
                        const uint8_t **poutbuf, int *poutbuf_size,
2818
                        const uint8_t *buf, int buf_size);
2819
    void (*parser_close)(AVCodecParserContext *s);
2820
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2821
    struct AVCodecParser *next;
2822
} AVCodecParser;
2823

    
2824
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2825
extern AVCodecParser *av_first_parser;
2826
#endif
2827
AVCodecParser *av_parser_next(AVCodecParser *c);
2828

    
2829
void av_register_codec_parser(AVCodecParser *parser);
2830
AVCodecParserContext *av_parser_init(int codec_id);
2831
int av_parser_parse(AVCodecParserContext *s,
2832
                    AVCodecContext *avctx,
2833
                    uint8_t **poutbuf, int *poutbuf_size,
2834
                    const uint8_t *buf, int buf_size,
2835
                    int64_t pts, int64_t dts);
2836
int av_parser_change(AVCodecParserContext *s,
2837
                     AVCodecContext *avctx,
2838
                     uint8_t **poutbuf, int *poutbuf_size,
2839
                     const uint8_t *buf, int buf_size, int keyframe);
2840
void av_parser_close(AVCodecParserContext *s);
2841

    
2842

    
2843
typedef struct AVBitStreamFilterContext {
2844
    void *priv_data;
2845
    struct AVBitStreamFilter *filter;
2846
    AVCodecParserContext *parser;
2847
    struct AVBitStreamFilterContext *next;
2848
} AVBitStreamFilterContext;
2849

    
2850

    
2851
typedef struct AVBitStreamFilter {
2852
    const char *name;
2853
    int priv_data_size;
2854
    int (*filter)(AVBitStreamFilterContext *bsfc,
2855
                  AVCodecContext *avctx, const char *args,
2856
                  uint8_t **poutbuf, int *poutbuf_size,
2857
                  const uint8_t *buf, int buf_size, int keyframe);
2858
    void (*close)(AVBitStreamFilterContext *bsfc);
2859
    struct AVBitStreamFilter *next;
2860
} AVBitStreamFilter;
2861

    
2862
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2863
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2864
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2865
                               AVCodecContext *avctx, const char *args,
2866
                               uint8_t **poutbuf, int *poutbuf_size,
2867
                               const uint8_t *buf, int buf_size, int keyframe);
2868
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2869

    
2870
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2871

    
2872
/* memory */
2873

    
2874
/**
2875
 * Reallocates the given block if it is not large enough, otherwise it
2876
 * does nothing.
2877
 *
2878
 * @see av_realloc
2879
 */
2880
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2881

    
2882
/* for static data only */
2883

    
2884
/**
2885
 * Frees all static arrays and resets their pointers to 0.
2886
 * Call this function to release all statically allocated tables.
2887
 *
2888
 * @deprecated. Code which uses av_free_static is broken/misdesigned
2889
 * and should correctly use static arrays
2890
 *
2891
 */
2892
attribute_deprecated void av_free_static(void);
2893

    
2894
/**
2895
 * Allocation of static arrays.
2896
 *
2897
 * @warning Do not use for normal allocation.
2898
 *
2899
 * @param[in] size The amount of memory you need in bytes.
2900
 * @return block of memory of the requested size
2901
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2902
 * and should correctly use static arrays
2903
 */
2904
attribute_deprecated void *av_mallocz_static(unsigned int size);
2905

    
2906
/**
2907
 * Copy image 'src' to 'dst'.
2908
 */
2909
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2910
              int pix_fmt, int width, int height);
2911

    
2912
/**
2913
 * Crop image top and left side.
2914
 */
2915
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2916
             int pix_fmt, int top_band, int left_band);
2917

    
2918
/**
2919
 * Pad image.
2920
 */
2921
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2922
            int padtop, int padbottom, int padleft, int padright, int *color);
2923

    
2924
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2925
/**
2926
 * @deprecated Use the software scaler (swscale) instead.
2927
 */
2928
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2929
              int pix_fmt, int width, int height);
2930

    
2931
/**
2932
 * @deprecated Use the software scaler (swscale) instead.
2933
 */
2934
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2935
             int pix_fmt, int top_band, int left_band);
2936

    
2937
/**
2938
 * @deprecated Use the software scaler (swscale) instead.
2939
 */
2940
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2941
            int padtop, int padbottom, int padleft, int padright, int *color);
2942
#endif
2943

    
2944
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2945

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

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

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

    
2989
#endif /* FFMPEG_AVCODEC_H */