Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 833e90dd

History | View | Annotate | Download (94.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 "libavutil/avutil.h"
31

    
32
#define LIBAVCODEC_VERSION_MAJOR 51
33
#define LIBAVCODEC_VERSION_MINOR 67
34
#define LIBAVCODEC_VERSION_MICRO  0
35

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
327
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
328
/* CODEC_ID_MP3LAME is obsolete */
329
#define CODEC_ID_MP3LAME CODEC_ID_MP3
330
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
331
#endif
332

    
333
enum CodecType {
334
    CODEC_TYPE_UNKNOWN = -1,
335
    CODEC_TYPE_VIDEO,
336
    CODEC_TYPE_AUDIO,
337
    CODEC_TYPE_DATA,
338
    CODEC_TYPE_SUBTITLE,
339
    CODEC_TYPE_ATTACHMENT,
340
    CODEC_TYPE_NB
341
};
342

    
343
/**
344
 * Currently unused, may be used if 24/32 bits samples are ever supported.
345
 * all in native-endian format
346
 */
347
enum SampleFormat {
348
    SAMPLE_FMT_NONE = -1,
349
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
350
    SAMPLE_FMT_S16,             ///< signed 16 bits
351
    SAMPLE_FMT_S24,             ///< signed 24 bits @deprecated Deprecated in favor of SAMPLE_FMT_S32
352
    SAMPLE_FMT_S32,             ///< signed 32 bits
353
    SAMPLE_FMT_FLT,             ///< float
354
    SAMPLE_FMT_DBL,             ///< double
355
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
356
};
357

    
358
/* in bytes */
359
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
360

    
361
/**
362
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
363
 * This is mainly needed because some optimized bitstream readers read
364
 * 32 or 64 bit at once and could read over the end.<br>
365
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
366
 * MPEG bitstreams could cause overread and segfault.
367
 */
368
#define FF_INPUT_BUFFER_PADDING_SIZE 8
369

    
370
/**
371
 * minimum encoding buffer size
372
 * Used to avoid some checks during header writing.
373
 */
374
#define FF_MIN_BUFFER_SIZE 16384
375

    
376
/**
377
 * motion estimation type.
378
 */
379
enum Motion_Est_ID {
380
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
381
    ME_FULL,
382
    ME_LOG,
383
    ME_PHODS,
384
    ME_EPZS,        ///< enhanced predictive zonal search
385
    ME_X1,          ///< reserved for experiments
386
    ME_HEX,         ///< hexagon based search
387
    ME_UMH,         ///< uneven multi-hexagon search
388
    ME_ITER,        ///< iterative search
389
    ME_TESA,        ///< transformed exhaustive search algorithm
390
};
391

    
392
enum AVDiscard{
393
    /* We leave some space between them for extensions (drop some
394
     * keyframes for intra-only or drop just some bidir frames). */
395
    AVDISCARD_NONE   =-16, ///< discard nothing
396
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
397
    AVDISCARD_NONREF =  8, ///< discard all non reference
398
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
399
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
400
    AVDISCARD_ALL    = 48, ///< discard all
401
};
402

    
403
typedef struct RcOverride{
404
    int start_frame;
405
    int end_frame;
406
    int qscale; // If this is 0 then quality_factor will be used instead.
407
    float quality_factor;
408
} RcOverride;
409

    
410
#define FF_MAX_B_FRAMES 16
411

    
412
/* encoding support
413
   These flags can be passed in AVCodecContext.flags before initialization.
414
   Note: Not everything is supported yet.
415
*/
416

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

    
480
/* Unsupported options :
481
 *              Syntax Arithmetic coding (SAC)
482
 *              Reference Picture Selection
483
 *              Independent Segment Decoding */
484
/* /Fx */
485
/* codec capabilities */
486

    
487
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
488
/**
489
 * Codec uses get_buffer() for allocating buffers.
490
 * direct rendering method 1
491
 */
492
#define CODEC_CAP_DR1             0x0002
493
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
494
#define CODEC_CAP_PARSE_ONLY      0x0004
495
#define CODEC_CAP_TRUNCATED       0x0008
496
/* Codec can export data for HW decoding (XvMC). */
497
#define CODEC_CAP_HWACCEL         0x0010
498
/**
499
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
500
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
501
 */
502
#define CODEC_CAP_DELAY           0x0020
503
/**
504
 * Codec can be fed a final frame with a smaller size.
505
 * This can be used to prevent truncation of the last audio samples.
506
 */
507
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
508

    
509
//The following defines may change, don't expect compatibility if you use them.
510
#define MB_TYPE_INTRA4x4   0x0001
511
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
512
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
513
#define MB_TYPE_16x16      0x0008
514
#define MB_TYPE_16x8       0x0010
515
#define MB_TYPE_8x16       0x0020
516
#define MB_TYPE_8x8        0x0040
517
#define MB_TYPE_INTERLACED 0x0080
518
#define MB_TYPE_DIRECT2    0x0100 //FIXME
519
#define MB_TYPE_ACPRED     0x0200
520
#define MB_TYPE_GMC        0x0400
521
#define MB_TYPE_SKIP       0x0800
522
#define MB_TYPE_P0L0       0x1000
523
#define MB_TYPE_P1L0       0x2000
524
#define MB_TYPE_P0L1       0x4000
525
#define MB_TYPE_P1L1       0x8000
526
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
527
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
528
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
529
#define MB_TYPE_QUANT      0x00010000
530
#define MB_TYPE_CBP        0x00020000
531
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
532

    
533
/**
534
 * Pan Scan area.
535
 * This specifies the area which should be displayed.
536
 * Note there may be multiple such areas for one frame.
537
 */
538
typedef struct AVPanScan{
539
    /**
540
     * id
541
     * - encoding: Set by user.
542
     * - decoding: Set by libavcodec.
543
     */
544
    int id;
545

    
546
    /**
547
     * width and height in 1/16 pel
548
     * - encoding: Set by user.
549
     * - decoding: Set by libavcodec.
550
     */
551
    int width;
552
    int height;
553

    
554
    /**
555
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
556
     * - encoding: Set by user.
557
     * - decoding: Set by libavcodec.
558
     */
559
    int16_t position[3][2];
560
}AVPanScan;
561

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

    
772
#define FF_QSCALE_TYPE_MPEG1 0
773
#define FF_QSCALE_TYPE_MPEG2 1
774
#define FF_QSCALE_TYPE_H264  2
775

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

    
781

    
782
#define FF_I_TYPE  1 ///< Intra
783
#define FF_P_TYPE  2 ///< Predicted
784
#define FF_B_TYPE  3 ///< Bi-dir predicted
785
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
786
#define FF_SI_TYPE 5 ///< Switching Intra
787
#define FF_SP_TYPE 6 ///< Switching Predicted
788
#define FF_BI_TYPE 7
789

    
790
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
791
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
792
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
793
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
794

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

    
808
#define DEFAULT_FRAME_RATE_BASE 1001000
809

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

    
830
    /**
831
     * number of bits the bitstream is allowed to diverge from the reference.
832
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
833
     * - encoding: Set by user; unused for constant quantizer encoding.
834
     * - decoding: unused
835
     */
836
    int bit_rate_tolerance;
837

    
838
    /**
839
     * CODEC_FLAG_*.
840
     * - encoding: Set by user.
841
     * - decoding: Set by user.
842
     */
843
    int flags;
844

    
845
    /**
846
     * Some codecs need additional format info. It is stored here.
847
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
848
     * specific codec MUST set it correctly otherwise stream copy breaks.
849
     * In general use of this field by muxers is not recommanded.
850
     * - encoding: Set by libavcodec.
851
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
852
     */
853
    int sub_id;
854

    
855
    /**
856
     * Motion estimation algorithm used for video coding.
857
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
858
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
859
     * - encoding: MUST be set by user.
860
     * - decoding: unused
861
     */
862
    int me_method;
863

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

    
878
    /**
879
     * This is the fundamental unit of time (in seconds) in terms
880
     * of which frame timestamps are represented. For fixed-fps content,
881
     * timebase should be 1/framerate and timestamp increments should be
882
     * identically 1.
883
     * - encoding: MUST be set by user.
884
     * - decoding: Set by libavcodec.
885
     */
886
    AVRational time_base;
887

    
888
    /* video only */
889
    /**
890
     * picture width / height.
891
     * - encoding: MUST be set by user.
892
     * - decoding: Set by libavcodec.
893
     * Note: For compatibility it is possible to set this instead of
894
     * coded_width/height before decoding.
895
     */
896
    int width, height;
897

    
898
#define FF_ASPECT_EXTENDED 15
899

    
900
    /**
901
     * the number of pictures in a group of pictures, or 0 for intra_only
902
     * - encoding: Set by user.
903
     * - decoding: unused
904
     */
905
    int gop_size;
906

    
907
    /**
908
     * Pixel format, see PIX_FMT_xxx.
909
     * - encoding: Set by user.
910
     * - decoding: Set by libavcodec.
911
     */
912
    enum PixelFormat pix_fmt;
913

    
914
    /**
915
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
916
     * has to read frames at native frame rate.
917
     * - encoding: Set by user.
918
     * - decoding: unused
919
     */
920
    int rate_emu;
921

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

    
938
    /* audio only */
939
    int sample_rate; ///< samples per second
940
    int channels;    ///< number of audio channels
941

    
942
    /**
943
     * audio sample format
944
     * - encoding: Set by user.
945
     * - decoding: Set by libavcodec.
946
     */
947
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
948

    
949
    /* The following data should not be initialized. */
950
    /**
951
     * Samples per packet, initialized when calling 'init'.
952
     */
953
    int frame_size;
954
    int frame_number;   ///< audio or video frame number
955
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
956

    
957
    /**
958
     * Number of frames the decoded output will be delayed relative to
959
     * the encoded input.
960
     * - encoding: Set by libavcodec.
961
     * - decoding: unused
962
     */
963
    int delay;
964

    
965
    /* - encoding parameters */
966
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
967
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
968

    
969
    /**
970
     * minimum quantizer
971
     * - encoding: Set by user.
972
     * - decoding: unused
973
     */
974
    int qmin;
975

    
976
    /**
977
     * maximum quantizer
978
     * - encoding: Set by user.
979
     * - decoding: unused
980
     */
981
    int qmax;
982

    
983
    /**
984
     * maximum quantizer difference between frames
985
     * - encoding: Set by user.
986
     * - decoding: unused
987
     */
988
    int max_qdiff;
989

    
990
    /**
991
     * maximum number of B-frames between non-B-frames
992
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
993
     * - encoding: Set by user.
994
     * - decoding: unused
995
     */
996
    int max_b_frames;
997

    
998
    /**
999
     * qscale factor between IP and B-frames
1000
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1001
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1002
     * - encoding: Set by user.
1003
     * - decoding: unused
1004
     */
1005
    float b_quant_factor;
1006

    
1007
    /** obsolete FIXME remove */
1008
    int rc_strategy;
1009
#define FF_RC_STRATEGY_XVID 1
1010

    
1011
    int b_frame_strategy;
1012

    
1013
    /**
1014
     * hurry up amount
1015
     * - encoding: unused
1016
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1017
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1018
     */
1019
    int hurry_up;
1020

    
1021
    struct AVCodec *codec;
1022

    
1023
    void *priv_data;
1024

    
1025
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1026
    /* unused, FIXME remove*/
1027
    int rtp_mode;
1028
#endif
1029

    
1030
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1031
                            /* do its best to deliver a chunk with size     */
1032
                            /* below rtp_payload_size, the chunk will start */
1033
                            /* with a start code on some codecs like H.263. */
1034
                            /* This doesn't take account of any particular  */
1035
                            /* headers inside the transmitted RTP payload.  */
1036

    
1037

    
1038
    /* The RTP callback: This function is called    */
1039
    /* every time the encoder has a packet to send. */
1040
    /* It depends on the encoder if the data starts */
1041
    /* with a Start Code (it should). H.263 does.   */
1042
    /* mb_nb contains the number of macroblocks     */
1043
    /* encoded in the RTP payload.                  */
1044
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1045

    
1046
    /* statistics, used for 2-pass encoding */
1047
    int mv_bits;
1048
    int header_bits;
1049
    int i_tex_bits;
1050
    int p_tex_bits;
1051
    int i_count;
1052
    int p_count;
1053
    int skip_count;
1054
    int misc_bits;
1055

    
1056
    /**
1057
     * number of bits used for the previously encoded frame
1058
     * - encoding: Set by libavcodec.
1059
     * - decoding: unused
1060
     */
1061
    int frame_bits;
1062

    
1063
    /**
1064
     * Private data of the user, can be used to carry app specific stuff.
1065
     * - encoding: Set by user.
1066
     * - decoding: Set by user.
1067
     */
1068
    void *opaque;
1069

    
1070
    char codec_name[32];
1071
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1072
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1073

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

    
1089
    /**
1090
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1091
     * - encoding: Set by user
1092
     * - decoding: Set by user
1093
     */
1094
    int workaround_bugs;
1095
#define FF_BUG_AUTODETECT       1  ///< autodetection
1096
#define FF_BUG_OLD_MSMPEG4      2
1097
#define FF_BUG_XVID_ILACE       4
1098
#define FF_BUG_UMP4             8
1099
#define FF_BUG_NO_PADDING       16
1100
#define FF_BUG_AMV              32
1101
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1102
#define FF_BUG_QPEL_CHROMA      64
1103
#define FF_BUG_STD_QPEL         128
1104
#define FF_BUG_QPEL_CHROMA2     256
1105
#define FF_BUG_DIRECT_BLOCKSIZE 512
1106
#define FF_BUG_EDGE             1024
1107
#define FF_BUG_HPEL_CHROMA      2048
1108
#define FF_BUG_DC_CLIP          4096
1109
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1110
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1111

    
1112
    /**
1113
     * luma single coefficient elimination threshold
1114
     * - encoding: Set by user.
1115
     * - decoding: unused
1116
     */
1117
    int luma_elim_threshold;
1118

    
1119
    /**
1120
     * chroma single coeff elimination threshold
1121
     * - encoding: Set by user.
1122
     * - decoding: unused
1123
     */
1124
    int chroma_elim_threshold;
1125

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

    
1145
    /**
1146
     * qscale offset between IP and B-frames
1147
     * - encoding: Set by user.
1148
     * - decoding: unused
1149
     */
1150
    float b_quant_offset;
1151

    
1152
    /**
1153
     * Error resilience; higher values will detect more errors but may
1154
     * misdetect some more or less valid parts as errors.
1155
     * - encoding: unused
1156
     * - decoding: Set by user.
1157
     */
1158
    int error_resilience;
1159
#define FF_ER_CAREFUL         1
1160
#define FF_ER_COMPLIANT       2
1161
#define FF_ER_AGGRESSIVE      3
1162
#define FF_ER_VERY_AGGRESSIVE 4
1163

    
1164
    /**
1165
     * Called at the beginning of each frame to get a buffer for it.
1166
     * If pic.reference is set then the frame will be read later by libavcodec.
1167
     * avcodec_align_dimensions() should be used to find the required width and
1168
     * height, as they normally need to be rounded up to the next multiple of 16.
1169
     * - encoding: unused
1170
     * - decoding: Set by libavcodec., user can override.
1171
     */
1172
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1173

    
1174
    /**
1175
     * Called to release buffers which were allocated with get_buffer.
1176
     * A released buffer can be reused in get_buffer().
1177
     * pic.data[*] must be set to NULL.
1178
     * - encoding: unused
1179
     * - decoding: Set by libavcodec., user can override.
1180
     */
1181
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1182

    
1183
    /**
1184
     * If 1 the stream has a 1 frame delay during decoding.
1185
     * - encoding: Set by libavcodec.
1186
     * - decoding: Set by libavcodec.
1187
     */
1188
    int has_b_frames;
1189

    
1190
    /**
1191
     * number of bytes per packet if constant and known or 0
1192
     * Used by some WAV based audio codecs.
1193
     */
1194
    int block_align;
1195

    
1196
    int parse_only; /* - decoding only: If true, only parsing is done
1197
                       (function avcodec_parse_frame()). The frame
1198
                       data is returned. Only MPEG codecs support this now. */
1199

    
1200
    /**
1201
     * 0-> h263 quant 1-> mpeg quant
1202
     * - encoding: Set by user.
1203
     * - decoding: unused
1204
     */
1205
    int mpeg_quant;
1206

    
1207
    /**
1208
     * pass1 encoding statistics output buffer
1209
     * - encoding: Set by libavcodec.
1210
     * - decoding: unused
1211
     */
1212
    char *stats_out;
1213

    
1214
    /**
1215
     * pass2 encoding statistics input buffer
1216
     * Concatenated stuff from stats_out of pass1 should be placed here.
1217
     * - encoding: Allocated/set/freed by user.
1218
     * - decoding: unused
1219
     */
1220
    char *stats_in;
1221

    
1222
    /**
1223
     * ratecontrol qmin qmax limiting method
1224
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1225
     * - encoding: Set by user.
1226
     * - decoding: unused
1227
     */
1228
    float rc_qsquish;
1229

    
1230
    float rc_qmod_amp;
1231
    int rc_qmod_freq;
1232

    
1233
    /**
1234
     * ratecontrol override, see RcOverride
1235
     * - encoding: Allocated/set/freed by user.
1236
     * - decoding: unused
1237
     */
1238
    RcOverride *rc_override;
1239
    int rc_override_count;
1240

    
1241
    /**
1242
     * rate control equation
1243
     * - encoding: Set by user
1244
     * - decoding: unused
1245
     */
1246
    const char *rc_eq;
1247

    
1248
    /**
1249
     * maximum bitrate
1250
     * - encoding: Set by user.
1251
     * - decoding: unused
1252
     */
1253
    int rc_max_rate;
1254

    
1255
    /**
1256
     * minimum bitrate
1257
     * - encoding: Set by user.
1258
     * - decoding: unused
1259
     */
1260
    int rc_min_rate;
1261

    
1262
    /**
1263
     * decoder bitstream buffer size
1264
     * - encoding: Set by user.
1265
     * - decoding: unused
1266
     */
1267
    int rc_buffer_size;
1268
    float rc_buffer_aggressivity;
1269

    
1270
    /**
1271
     * qscale factor between P and I-frames
1272
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1273
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1274
     * - encoding: Set by user.
1275
     * - decoding: unused
1276
     */
1277
    float i_quant_factor;
1278

    
1279
    /**
1280
     * qscale offset between P and I-frames
1281
     * - encoding: Set by user.
1282
     * - decoding: unused
1283
     */
1284
    float i_quant_offset;
1285

    
1286
    /**
1287
     * initial complexity for pass1 ratecontrol
1288
     * - encoding: Set by user.
1289
     * - decoding: unused
1290
     */
1291
    float rc_initial_cplx;
1292

    
1293
    /**
1294
     * DCT algorithm, see FF_DCT_* below
1295
     * - encoding: Set by user.
1296
     * - decoding: unused
1297
     */
1298
    int dct_algo;
1299
#define FF_DCT_AUTO    0
1300
#define FF_DCT_FASTINT 1
1301
#define FF_DCT_INT     2
1302
#define FF_DCT_MMX     3
1303
#define FF_DCT_MLIB    4
1304
#define FF_DCT_ALTIVEC 5
1305
#define FF_DCT_FAAN    6
1306

    
1307
    /**
1308
     * luminance masking (0-> disabled)
1309
     * - encoding: Set by user.
1310
     * - decoding: unused
1311
     */
1312
    float lumi_masking;
1313

    
1314
    /**
1315
     * temporary complexity masking (0-> disabled)
1316
     * - encoding: Set by user.
1317
     * - decoding: unused
1318
     */
1319
    float temporal_cplx_masking;
1320

    
1321
    /**
1322
     * spatial complexity masking (0-> disabled)
1323
     * - encoding: Set by user.
1324
     * - decoding: unused
1325
     */
1326
    float spatial_cplx_masking;
1327

    
1328
    /**
1329
     * p block masking (0-> disabled)
1330
     * - encoding: Set by user.
1331
     * - decoding: unused
1332
     */
1333
    float p_masking;
1334

    
1335
    /**
1336
     * darkness masking (0-> disabled)
1337
     * - encoding: Set by user.
1338
     * - decoding: unused
1339
     */
1340
    float dark_masking;
1341

    
1342

    
1343
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1344
    /* for binary compatibility */
1345
    int unused;
1346
#endif
1347

    
1348
    /**
1349
     * IDCT algorithm, see FF_IDCT_* below.
1350
     * - encoding: Set by user.
1351
     * - decoding: Set by user.
1352
     */
1353
    int idct_algo;
1354
#define FF_IDCT_AUTO          0
1355
#define FF_IDCT_INT           1
1356
#define FF_IDCT_SIMPLE        2
1357
#define FF_IDCT_SIMPLEMMX     3
1358
#define FF_IDCT_LIBMPEG2MMX   4
1359
#define FF_IDCT_PS2           5
1360
#define FF_IDCT_MLIB          6
1361
#define FF_IDCT_ARM           7
1362
#define FF_IDCT_ALTIVEC       8
1363
#define FF_IDCT_SH4           9
1364
#define FF_IDCT_SIMPLEARM     10
1365
#define FF_IDCT_H264          11
1366
#define FF_IDCT_VP3           12
1367
#define FF_IDCT_IPP           13
1368
#define FF_IDCT_XVIDMMX       14
1369
#define FF_IDCT_CAVS          15
1370
#define FF_IDCT_SIMPLEARMV5TE 16
1371
#define FF_IDCT_SIMPLEARMV6   17
1372
#define FF_IDCT_SIMPLEVIS     18
1373
#define FF_IDCT_WMV2          19
1374
#define FF_IDCT_FAAN          20
1375

    
1376
    /**
1377
     * slice count
1378
     * - encoding: Set by libavcodec.
1379
     * - decoding: Set by user (or 0).
1380
     */
1381
    int slice_count;
1382
    /**
1383
     * slice offsets in the frame in bytes
1384
     * - encoding: Set/allocated by libavcodec.
1385
     * - decoding: Set/allocated by user (or NULL).
1386
     */
1387
    int *slice_offset;
1388

    
1389
    /**
1390
     * error concealment flags
1391
     * - encoding: unused
1392
     * - decoding: Set by user.
1393
     */
1394
    int error_concealment;
1395
#define FF_EC_GUESS_MVS   1
1396
#define FF_EC_DEBLOCK     2
1397

    
1398
    /**
1399
     * dsp_mask could be add used to disable unwanted CPU features
1400
     * CPU features (i.e. MMX, SSE. ...)
1401
     *
1402
     * With the FORCE flag you may instead enable given CPU features.
1403
     * (Dangerous: Usable in case of misdetection, improper usage however will
1404
     * result into program crash.)
1405
     */
1406
    unsigned dsp_mask;
1407
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1408
    /* lower 16 bits - CPU features */
1409
#define FF_MM_MMX      0x0001 ///< standard MMX
1410
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1411
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1412
#define FF_MM_SSE      0x0008 ///< SSE functions
1413
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1414
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1415
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1416
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1417
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1418

    
1419
    /**
1420
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1421
     * - encoding: Set by libavcodec.
1422
     * - decoding: Set by user.
1423
     */
1424
     int bits_per_sample;
1425

    
1426
    /**
1427
     * prediction method (needed for huffyuv)
1428
     * - encoding: Set by user.
1429
     * - decoding: unused
1430
     */
1431
     int prediction_method;
1432
#define FF_PRED_LEFT   0
1433
#define FF_PRED_PLANE  1
1434
#define FF_PRED_MEDIAN 2
1435

    
1436
    /**
1437
     * sample aspect ratio (0 if unknown)
1438
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1439
     * - encoding: Set by user.
1440
     * - decoding: Set by libavcodec.
1441
     */
1442
    AVRational sample_aspect_ratio;
1443

    
1444
    /**
1445
     * the picture in the bitstream
1446
     * - encoding: Set by libavcodec.
1447
     * - decoding: Set by libavcodec.
1448
     */
1449
    AVFrame *coded_frame;
1450

    
1451
    /**
1452
     * debug
1453
     * - encoding: Set by user.
1454
     * - decoding: Set by user.
1455
     */
1456
    int debug;
1457
#define FF_DEBUG_PICT_INFO   1
1458
#define FF_DEBUG_RC          2
1459
#define FF_DEBUG_BITSTREAM   4
1460
#define FF_DEBUG_MB_TYPE     8
1461
#define FF_DEBUG_QP          16
1462
#define FF_DEBUG_MV          32
1463
#define FF_DEBUG_DCT_COEFF   0x00000040
1464
#define FF_DEBUG_SKIP        0x00000080
1465
#define FF_DEBUG_STARTCODE   0x00000100
1466
#define FF_DEBUG_PTS         0x00000200
1467
#define FF_DEBUG_ER          0x00000400
1468
#define FF_DEBUG_MMCO        0x00000800
1469
#define FF_DEBUG_BUGS        0x00001000
1470
#define FF_DEBUG_VIS_QP      0x00002000
1471
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1472
#define FF_DEBUG_BUFFERS     0x00008000
1473

    
1474
    /**
1475
     * debug
1476
     * - encoding: Set by user.
1477
     * - decoding: Set by user.
1478
     */
1479
    int debug_mv;
1480
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1481
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1482
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1483

    
1484
    /**
1485
     * error
1486
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1487
     * - decoding: unused
1488
     */
1489
    uint64_t error[4];
1490

    
1491
    /**
1492
     * minimum MB quantizer
1493
     * - encoding: unused
1494
     * - decoding: unused
1495
     */
1496
    int mb_qmin;
1497

    
1498
    /**
1499
     * maximum MB quantizer
1500
     * - encoding: unused
1501
     * - decoding: unused
1502
     */
1503
    int mb_qmax;
1504

    
1505
    /**
1506
     * motion estimation comparison function
1507
     * - encoding: Set by user.
1508
     * - decoding: unused
1509
     */
1510
    int me_cmp;
1511
    /**
1512
     * subpixel motion estimation comparison function
1513
     * - encoding: Set by user.
1514
     * - decoding: unused
1515
     */
1516
    int me_sub_cmp;
1517
    /**
1518
     * macroblock comparison function (not supported yet)
1519
     * - encoding: Set by user.
1520
     * - decoding: unused
1521
     */
1522
    int mb_cmp;
1523
    /**
1524
     * interlaced DCT comparison function
1525
     * - encoding: Set by user.
1526
     * - decoding: unused
1527
     */
1528
    int ildct_cmp;
1529
#define FF_CMP_SAD    0
1530
#define FF_CMP_SSE    1
1531
#define FF_CMP_SATD   2
1532
#define FF_CMP_DCT    3
1533
#define FF_CMP_PSNR   4
1534
#define FF_CMP_BIT    5
1535
#define FF_CMP_RD     6
1536
#define FF_CMP_ZERO   7
1537
#define FF_CMP_VSAD   8
1538
#define FF_CMP_VSSE   9
1539
#define FF_CMP_NSSE   10
1540
#define FF_CMP_W53    11
1541
#define FF_CMP_W97    12
1542
#define FF_CMP_DCTMAX 13
1543
#define FF_CMP_DCT264 14
1544
#define FF_CMP_CHROMA 256
1545

    
1546
    /**
1547
     * ME diamond size & shape
1548
     * - encoding: Set by user.
1549
     * - decoding: unused
1550
     */
1551
    int dia_size;
1552

    
1553
    /**
1554
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1555
     * - encoding: Set by user.
1556
     * - decoding: unused
1557
     */
1558
    int last_predictor_count;
1559

    
1560
    /**
1561
     * prepass for motion estimation
1562
     * - encoding: Set by user.
1563
     * - decoding: unused
1564
     */
1565
    int pre_me;
1566

    
1567
    /**
1568
     * motion estimation prepass comparison function
1569
     * - encoding: Set by user.
1570
     * - decoding: unused
1571
     */
1572
    int me_pre_cmp;
1573

    
1574
    /**
1575
     * ME prepass diamond size & shape
1576
     * - encoding: Set by user.
1577
     * - decoding: unused
1578
     */
1579
    int pre_dia_size;
1580

    
1581
    /**
1582
     * subpel ME quality
1583
     * - encoding: Set by user.
1584
     * - decoding: unused
1585
     */
1586
    int me_subpel_quality;
1587

    
1588
    /**
1589
     * callback to negotiate the pixelFormat
1590
     * @param fmt is the list of formats which are supported by the codec,
1591
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1592
     * The first is always the native one.
1593
     * @return the chosen format
1594
     * - encoding: unused
1595
     * - decoding: Set by user, if not set the native format will be chosen.
1596
     */
1597
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1598

    
1599
    /**
1600
     * DTG active format information (additional aspect ratio
1601
     * information only used in DVB MPEG-2 transport streams)
1602
     * 0 if not set.
1603
     *
1604
     * - encoding: unused
1605
     * - decoding: Set by decoder.
1606
     */
1607
    int dtg_active_format;
1608
#define FF_DTG_AFD_SAME         8
1609
#define FF_DTG_AFD_4_3          9
1610
#define FF_DTG_AFD_16_9         10
1611
#define FF_DTG_AFD_14_9         11
1612
#define FF_DTG_AFD_4_3_SP_14_9  13
1613
#define FF_DTG_AFD_16_9_SP_14_9 14
1614
#define FF_DTG_AFD_SP_4_3       15
1615

    
1616
    /**
1617
     * maximum motion estimation search range in subpel units
1618
     * If 0 then no limit.
1619
     *
1620
     * - encoding: Set by user.
1621
     * - decoding: unused
1622
     */
1623
    int me_range;
1624

    
1625
    /**
1626
     * intra quantizer bias
1627
     * - encoding: Set by user.
1628
     * - decoding: unused
1629
     */
1630
    int intra_quant_bias;
1631
#define FF_DEFAULT_QUANT_BIAS 999999
1632

    
1633
    /**
1634
     * inter quantizer bias
1635
     * - encoding: Set by user.
1636
     * - decoding: unused
1637
     */
1638
    int inter_quant_bias;
1639

    
1640
    /**
1641
     * color table ID
1642
     * - encoding: unused
1643
     * - decoding: Which clrtable should be used for 8bit RGB images.
1644
     *             Tables have to be stored somewhere. FIXME
1645
     */
1646
    int color_table_id;
1647

    
1648
    /**
1649
     * internal_buffer count
1650
     * Don't touch, used by libavcodec default_get_buffer().
1651
     */
1652
    int internal_buffer_count;
1653

    
1654
    /**
1655
     * internal_buffers
1656
     * Don't touch, used by libavcodec default_get_buffer().
1657
     */
1658
    void *internal_buffer;
1659

    
1660
#define FF_LAMBDA_SHIFT 7
1661
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1662
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1663
#define FF_LAMBDA_MAX (256*128-1)
1664

    
1665
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1666
    /**
1667
     * Global quality for codecs which cannot change it per frame.
1668
     * This should be proportional to MPEG-1/2/4 qscale.
1669
     * - encoding: Set by user.
1670
     * - decoding: unused
1671
     */
1672
    int global_quality;
1673

    
1674
#define FF_CODER_TYPE_VLC       0
1675
#define FF_CODER_TYPE_AC        1
1676
#define FF_CODER_TYPE_RAW       2
1677
#define FF_CODER_TYPE_RLE       3
1678
#define FF_CODER_TYPE_DEFLATE   4
1679
    /**
1680
     * coder type
1681
     * - encoding: Set by user.
1682
     * - decoding: unused
1683
     */
1684
    int coder_type;
1685

    
1686
    /**
1687
     * context model
1688
     * - encoding: Set by user.
1689
     * - decoding: unused
1690
     */
1691
    int context_model;
1692
#if 0
1693
    /**
1694
     *
1695
     * - encoding: unused
1696
     * - decoding: Set by user.
1697
     */
1698
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1699
#endif
1700

    
1701
    /**
1702
     * slice flags
1703
     * - encoding: unused
1704
     * - decoding: Set by user.
1705
     */
1706
    int slice_flags;
1707
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1708
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1709
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1710

    
1711
    /**
1712
     * XVideo Motion Acceleration
1713
     * - encoding: forbidden
1714
     * - decoding: set by decoder
1715
     */
1716
    int xvmc_acceleration;
1717

    
1718
    /**
1719
     * macroblock decision mode
1720
     * - encoding: Set by user.
1721
     * - decoding: unused
1722
     */
1723
    int mb_decision;
1724
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1725
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1726
#define FF_MB_DECISION_RD     2        ///< rate distortion
1727

    
1728
    /**
1729
     * custom intra quantization matrix
1730
     * - encoding: Set by user, can be NULL.
1731
     * - decoding: Set by libavcodec.
1732
     */
1733
    uint16_t *intra_matrix;
1734

    
1735
    /**
1736
     * custom inter quantization matrix
1737
     * - encoding: Set by user, can be NULL.
1738
     * - decoding: Set by libavcodec.
1739
     */
1740
    uint16_t *inter_matrix;
1741

    
1742
    /**
1743
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1744
     * This is used to work around some encoder bugs.
1745
     * - encoding: unused
1746
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1747
     */
1748
    unsigned int stream_codec_tag;
1749

    
1750
    /**
1751
     * scene change detection threshold
1752
     * 0 is default, larger means fewer detected scene changes.
1753
     * - encoding: Set by user.
1754
     * - decoding: unused
1755
     */
1756
    int scenechange_threshold;
1757

    
1758
    /**
1759
     * minimum Lagrange multipler
1760
     * - encoding: Set by user.
1761
     * - decoding: unused
1762
     */
1763
    int lmin;
1764

    
1765
    /**
1766
     * maximum Lagrange multipler
1767
     * - encoding: Set by user.
1768
     * - decoding: unused
1769
     */
1770
    int lmax;
1771

    
1772
    /**
1773
     * palette control structure
1774
     * - encoding: ??? (no palette-enabled encoder yet)
1775
     * - decoding: Set by user.
1776
     */
1777
    struct AVPaletteControl *palctrl;
1778

    
1779
    /**
1780
     * noise reduction strength
1781
     * - encoding: Set by user.
1782
     * - decoding: unused
1783
     */
1784
    int noise_reduction;
1785

    
1786
    /**
1787
     * Called at the beginning of a frame to get cr buffer for it.
1788
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1789
     * libavcodec will pass previous buffer in pic, function should return
1790
     * same buffer or new buffer with old frame "painted" into it.
1791
     * If pic.data[0] == NULL must behave like get_buffer().
1792
     * - encoding: unused
1793
     * - decoding: Set by libavcodec., user can override
1794
     */
1795
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1796

    
1797
    /**
1798
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1799
     * - encoding: Set by user.
1800
     * - decoding: unused
1801
     */
1802
    int rc_initial_buffer_occupancy;
1803

    
1804
    /**
1805
     *
1806
     * - encoding: Set by user.
1807
     * - decoding: unused
1808
     */
1809
    int inter_threshold;
1810

    
1811
    /**
1812
     * CODEC_FLAG2_*
1813
     * - encoding: Set by user.
1814
     * - decoding: Set by user.
1815
     */
1816
    int flags2;
1817

    
1818
    /**
1819
     * Simulates errors in the bitstream to test error concealment.
1820
     * - encoding: Set by user.
1821
     * - decoding: unused
1822
     */
1823
    int error_rate;
1824

    
1825
    /**
1826
     * MP3 antialias algorithm, see FF_AA_* below.
1827
     * - encoding: unused
1828
     * - decoding: Set by user.
1829
     */
1830
    int antialias_algo;
1831
#define FF_AA_AUTO    0
1832
#define FF_AA_FASTINT 1 //not implemented yet
1833
#define FF_AA_INT     2
1834
#define FF_AA_FLOAT   3
1835
    /**
1836
     * quantizer noise shaping
1837
     * - encoding: Set by user.
1838
     * - decoding: unused
1839
     */
1840
    int quantizer_noise_shaping;
1841

    
1842
    /**
1843
     * thread count
1844
     * is used to decide how many independent tasks should be passed to execute()
1845
     * - encoding: Set by user.
1846
     * - decoding: Set by user.
1847
     */
1848
    int thread_count;
1849

    
1850
    /**
1851
     * The codec may call this to execute several independent things.
1852
     * It will return only after finishing all tasks.
1853
     * The user may replace this with some multithreaded implementation,
1854
     * the default implementation will execute the parts serially.
1855
     * @param count the number of things to execute
1856
     * - encoding: Set by libavcodec, user can override.
1857
     * - decoding: Set by libavcodec, user can override.
1858
     */
1859
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1860

    
1861
    /**
1862
     * thread opaque
1863
     * Can be used by execute() to store some per AVCodecContext stuff.
1864
     * - encoding: set by execute()
1865
     * - decoding: set by execute()
1866
     */
1867
    void *thread_opaque;
1868

    
1869
    /**
1870
     * Motion estimation threshold below which no motion estimation is
1871
     * performed, but instead the user specified motion vectors are used.
1872
     *
1873
     * - encoding: Set by user.
1874
     * - decoding: unused
1875
     */
1876
     int me_threshold;
1877

    
1878
    /**
1879
     * Macroblock threshold below which the user specified macroblock types will be used.
1880
     * - encoding: Set by user.
1881
     * - decoding: unused
1882
     */
1883
     int mb_threshold;
1884

    
1885
    /**
1886
     * precision of the intra DC coefficient - 8
1887
     * - encoding: Set by user.
1888
     * - decoding: unused
1889
     */
1890
     int intra_dc_precision;
1891

    
1892
    /**
1893
     * noise vs. sse weight for the nsse comparsion function
1894
     * - encoding: Set by user.
1895
     * - decoding: unused
1896
     */
1897
     int nsse_weight;
1898

    
1899
    /**
1900
     * Number of macroblock rows at the top which are skipped.
1901
     * - encoding: unused
1902
     * - decoding: Set by user.
1903
     */
1904
     int skip_top;
1905

    
1906
    /**
1907
     * Number of macroblock rows at the bottom which are skipped.
1908
     * - encoding: unused
1909
     * - decoding: Set by user.
1910
     */
1911
     int skip_bottom;
1912

    
1913
    /**
1914
     * profile
1915
     * - encoding: Set by user.
1916
     * - decoding: Set by libavcodec.
1917
     */
1918
     int profile;
1919
#define FF_PROFILE_UNKNOWN -99
1920
#define FF_PROFILE_AAC_MAIN 0
1921
#define FF_PROFILE_AAC_LOW  1
1922
#define FF_PROFILE_AAC_SSR  2
1923
#define FF_PROFILE_AAC_LTP  3
1924

    
1925
    /**
1926
     * level
1927
     * - encoding: Set by user.
1928
     * - decoding: Set by libavcodec.
1929
     */
1930
     int level;
1931
#define FF_LEVEL_UNKNOWN -99
1932

    
1933
    /**
1934
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1935
     * - encoding: unused
1936
     * - decoding: Set by user.
1937
     */
1938
     int lowres;
1939

    
1940
    /**
1941
     * Bitstream width / height, may be different from width/height if lowres
1942
     * or other things are used.
1943
     * - encoding: unused
1944
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1945
     */
1946
    int coded_width, coded_height;
1947

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

    
1955
    /**
1956
     * frame skip factor
1957
     * - encoding: Set by user.
1958
     * - decoding: unused
1959
     */
1960
    int frame_skip_factor;
1961

    
1962
    /**
1963
     * frame skip exponent
1964
     * - encoding: Set by user.
1965
     * - decoding: unused
1966
     */
1967
    int frame_skip_exp;
1968

    
1969
    /**
1970
     * frame skip comparison function
1971
     * - encoding: Set by user.
1972
     * - decoding: unused
1973
     */
1974
    int frame_skip_cmp;
1975

    
1976
    /**
1977
     * Border processing masking, raises the quantizer for mbs on the borders
1978
     * of the picture.
1979
     * - encoding: Set by user.
1980
     * - decoding: unused
1981
     */
1982
    float border_masking;
1983

    
1984
    /**
1985
     * minimum MB lagrange multipler
1986
     * - encoding: Set by user.
1987
     * - decoding: unused
1988
     */
1989
    int mb_lmin;
1990

    
1991
    /**
1992
     * maximum MB lagrange multipler
1993
     * - encoding: Set by user.
1994
     * - decoding: unused
1995
     */
1996
    int mb_lmax;
1997

    
1998
    /**
1999
     *
2000
     * - encoding: Set by user.
2001
     * - decoding: unused
2002
     */
2003
    int me_penalty_compensation;
2004

    
2005
    /**
2006
     *
2007
     * - encoding: unused
2008
     * - decoding: Set by user.
2009
     */
2010
    enum AVDiscard skip_loop_filter;
2011

    
2012
    /**
2013
     *
2014
     * - encoding: unused
2015
     * - decoding: Set by user.
2016
     */
2017
    enum AVDiscard skip_idct;
2018

    
2019
    /**
2020
     *
2021
     * - encoding: unused
2022
     * - decoding: Set by user.
2023
     */
2024
    enum AVDiscard skip_frame;
2025

    
2026
    /**
2027
     *
2028
     * - encoding: Set by user.
2029
     * - decoding: unused
2030
     */
2031
    int bidir_refine;
2032

    
2033
    /**
2034
     *
2035
     * - encoding: Set by user.
2036
     * - decoding: unused
2037
     */
2038
    int brd_scale;
2039

    
2040
    /**
2041
     * constant rate factor - quality-based VBR - values ~correspond to qps
2042
     * - encoding: Set by user.
2043
     * - decoding: unused
2044
     */
2045
    float crf;
2046

    
2047
    /**
2048
     * constant quantization parameter rate control method
2049
     * - encoding: Set by user.
2050
     * - decoding: unused
2051
     */
2052
    int cqp;
2053

    
2054
    /**
2055
     * minimum GOP size
2056
     * - encoding: Set by user.
2057
     * - decoding: unused
2058
     */
2059
    int keyint_min;
2060

    
2061
    /**
2062
     * number of reference frames
2063
     * - encoding: Set by user.
2064
     * - decoding: unused
2065
     */
2066
    int refs;
2067

    
2068
    /**
2069
     * chroma qp offset from luma
2070
     * - encoding: Set by user.
2071
     * - decoding: unused
2072
     */
2073
    int chromaoffset;
2074

    
2075
    /**
2076
     * Influences how often B-frames are used.
2077
     * - encoding: Set by user.
2078
     * - decoding: unused
2079
     */
2080
    int bframebias;
2081

    
2082
    /**
2083
     * trellis RD quantization
2084
     * - encoding: Set by user.
2085
     * - decoding: unused
2086
     */
2087
    int trellis;
2088

    
2089
    /**
2090
     * Reduce fluctuations in qp (before curve compression).
2091
     * - encoding: Set by user.
2092
     * - decoding: unused
2093
     */
2094
    float complexityblur;
2095

    
2096
    /**
2097
     * in-loop deblocking filter alphac0 parameter
2098
     * alpha is in the range -6...6
2099
     * - encoding: Set by user.
2100
     * - decoding: unused
2101
     */
2102
    int deblockalpha;
2103

    
2104
    /**
2105
     * in-loop deblocking filter beta parameter
2106
     * beta is in the range -6...6
2107
     * - encoding: Set by user.
2108
     * - decoding: unused
2109
     */
2110
    int deblockbeta;
2111

    
2112
    /**
2113
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2114
     * - encoding: Set by user.
2115
     * - decoding: unused
2116
     */
2117
    int partitions;
2118
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2119
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2120
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2121
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2122
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2123

    
2124
    /**
2125
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2126
     * - encoding: Set by user.
2127
     * - decoding: unused
2128
     */
2129
    int directpred;
2130

    
2131
    /**
2132
     * Audio cutoff bandwidth (0 means "automatic")
2133
     * - encoding: Set by user.
2134
     * - decoding: unused
2135
     */
2136
    int cutoff;
2137

    
2138
    /**
2139
     * Multiplied by qscale for each frame and added to scene_change_score.
2140
     * - encoding: Set by user.
2141
     * - decoding: unused
2142
     */
2143
    int scenechange_factor;
2144

    
2145
    /**
2146
     *
2147
     * Note: Value depends upon the compare function used for fullpel ME.
2148
     * - encoding: Set by user.
2149
     * - decoding: unused
2150
     */
2151
    int mv0_threshold;
2152

    
2153
    /**
2154
     * Adjusts sensitivity of b_frame_strategy 1.
2155
     * - encoding: Set by user.
2156
     * - decoding: unused
2157
     */
2158
    int b_sensitivity;
2159

    
2160
    /**
2161
     * - encoding: Set by user.
2162
     * - decoding: unused
2163
     */
2164
    int compression_level;
2165
#define FF_COMPRESSION_DEFAULT -1
2166

    
2167
    /**
2168
     * Sets whether to use LPC mode - used by FLAC encoder.
2169
     * - encoding: Set by user.
2170
     * - decoding: unused
2171
     */
2172
    int use_lpc;
2173

    
2174
    /**
2175
     * LPC coefficient precision - used by FLAC encoder
2176
     * - encoding: Set by user.
2177
     * - decoding: unused
2178
     */
2179
    int lpc_coeff_precision;
2180

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

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

    
2193
    /**
2194
     * search method for selecting prediction order
2195
     * - encoding: Set by user.
2196
     * - decoding: unused
2197
     */
2198
    int prediction_order_method;
2199

    
2200
    /**
2201
     * - encoding: Set by user.
2202
     * - decoding: unused
2203
     */
2204
    int min_partition_order;
2205

    
2206
    /**
2207
     * - encoding: Set by user.
2208
     * - decoding: unused
2209
     */
2210
    int max_partition_order;
2211

    
2212
    /**
2213
     * GOP timecode frame start number, in non drop frame format
2214
     * - encoding: Set by user.
2215
     * - decoding: unused
2216
     */
2217
    int64_t timecode_frame_start;
2218

    
2219
    /**
2220
     * Decoder should decode to this many channels if it can (0 for default)
2221
     * - encoding: unused
2222
     * - decoding: Set by user.
2223
     */
2224
    int request_channels;
2225

    
2226
    /**
2227
     * Percentage of dynamic range compression to be applied by the decoder.
2228
     * The default value is 1.0, corresponding to full compression.
2229
     * - encoding: unused
2230
     * - decoding: Set by user.
2231
     */
2232
    float drc_scale;
2233
} AVCodecContext;
2234

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

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

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

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

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

    
2307
} AVPaletteControl attribute_deprecated;
2308

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

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

    
2328

    
2329
/* resample.c */
2330

    
2331
struct ReSampleContext;
2332
struct AVResampleContext;
2333

    
2334
typedef struct ReSampleContext ReSampleContext;
2335

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

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

    
2346
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2347
/* YUV420 format is assumed ! */
2348

    
2349
/**
2350
 * @deprecated Use the software scaler (swscale) instead.
2351
 */
2352
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2353

    
2354
/**
2355
 * @deprecated Use the software scaler (swscale) instead.
2356
 */
2357
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2358
                                      int input_width, int input_height);
2359

    
2360
/**
2361
 * @deprecated Use the software scaler (swscale) instead.
2362
 */
2363
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2364
                                      int iwidth, int iheight,
2365
                                      int topBand, int bottomBand,
2366
                                      int leftBand, int rightBand,
2367
                                      int padtop, int padbottom,
2368
                                      int padleft, int padright);
2369

    
2370
/**
2371
 * @deprecated Use the software scaler (swscale) instead.
2372
 */
2373
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2374
                  AVPicture *output, const AVPicture *input);
2375

    
2376
/**
2377
 * @deprecated Use the software scaler (swscale) instead.
2378
 */
2379
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2380

    
2381
#endif
2382

    
2383
/**
2384
 * Allocate memory for a picture.  Call avpicture_free to free it.
2385
 *
2386
 * @param picture the picture to be filled in
2387
 * @param pix_fmt the format of the picture
2388
 * @param width the width of the picture
2389
 * @param height the height of the picture
2390
 * @return zero if successful, a negative value if not
2391
 */
2392
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2393

    
2394
/**
2395
 * Free a picture previously allocated by avpicture_alloc().
2396
 *
2397
 * @param picture the AVPicture to be freed
2398
 */
2399
void avpicture_free(AVPicture *picture);
2400

    
2401
/**
2402
 * Fill in the AVPicture fields.
2403
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2404
 * which points to the image data buffer. Depending on the specified picture
2405
 * format, one or multiple image data pointers and line sizes will be set.
2406
 * If a planar format is specified, several pointers will be set pointing to
2407
 * the different picture planes and the line sizes of the different planes
2408
 * will be stored in the lines_sizes array.
2409
 *
2410
 * @param picture AVPicture whose fields are to be filled in
2411
 * @param ptr Buffer which will contain or contains the actual image data
2412
 * @param pix_fmt The format in which the picture data is stored.
2413
 * @param width the width of the image in pixels
2414
 * @param height the height of the image in pixels
2415
 * @return size of the image data in bytes
2416
 */
2417
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2418
                   int pix_fmt, int width, int height);
2419
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2420
                     unsigned char *dest, int dest_size);
2421

    
2422
/**
2423
 * Calculate the size in bytes that a picture of the given width and height
2424
 * would occupy if stored in the given picture format.
2425
 *
2426
 * @param pix_fmt the given picture format
2427
 * @param width the width of the image
2428
 * @param height the height of the image
2429
 * @return Image data size in bytes
2430
 */
2431
int avpicture_get_size(int pix_fmt, int width, int height);
2432
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2433
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2434
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2435
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2436
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2437

    
2438
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2439
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2440
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2441
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2442
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2443
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2444

    
2445
/**
2446
 * Computes what kind of losses will occur when converting from one specific
2447
 * pixel format to another.
2448
 * When converting from one pixel format to another, information loss may occur.
2449
 * For example, when converting from RGB24 to GRAY, the color information will
2450
 * be lost. Similarly, other losses occur when converting from some formats to
2451
 * other formats. These losses can involve loss of chroma, but also loss of
2452
 * resolution, loss of color depth, loss due to the color space conversion, loss
2453
 * of the alpha bits or loss due to color quantization.
2454
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2455
 * which will occur when converting from one pixel format to another.
2456
 *
2457
 * @param[in] dst_pix_fmt destination pixel format
2458
 * @param[in] src_pix_fmt source pixel format
2459
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2460
 * @return Combination of flags informing you what kind of losses will occur.
2461
 */
2462
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2463
                             int has_alpha);
2464

    
2465
/**
2466
 * Finds the best pixel format to convert to given a certain source pixel
2467
 * format.  When converting from one pixel format to another, information loss
2468
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2469
 * information will be lost. Similarly, other losses occur when converting from
2470
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2471
 * the given pixel formats should be used to suffer the least amount of loss.
2472
 * The pixel formats from which it chooses one, are determined by the
2473
 * \p pix_fmt_mask parameter.
2474
 *
2475
 * @code
2476
 * src_pix_fmt = PIX_FMT_YUV420P;
2477
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2478
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2479
 * @endcode
2480
 *
2481
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2482
 * @param[in] src_pix_fmt source pixel format
2483
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2484
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2485
 * @return The best pixel format to convert to or -1 if none was found.
2486
 */
2487
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2488
                              int has_alpha, int *loss_ptr);
2489

    
2490

    
2491
/**
2492
 * Print in buf the string corresponding to the pixel format with
2493
 * number pix_fmt, or an header if pix_fmt is negative.
2494
 *
2495
 * @param[in] buf the buffer where to write the string
2496
 * @param[in] buf_size the size of buf
2497
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2498
 * a negative value to print the corresponding header.
2499
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2500
 */
2501
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2502

    
2503
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2504
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2505

    
2506
/**
2507
 * Tell if an image really has transparent alpha values.
2508
 * @return ored mask of FF_ALPHA_xxx constants
2509
 */
2510
int img_get_alpha_info(const AVPicture *src,
2511
                       int pix_fmt, int width, int height);
2512

    
2513
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2514
/**
2515
 * convert among pixel formats
2516
 * @deprecated Use the software scaler (swscale) instead.
2517
 */
2518
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2519
                const AVPicture *src, int pix_fmt,
2520
                int width, int height);
2521
#endif
2522

    
2523
/* deinterlace a picture */
2524
/* deinterlace - if not supported return -1 */
2525
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2526
                          int pix_fmt, int width, int height);
2527

    
2528
/* external high level API */
2529

    
2530
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2531
extern AVCodec *first_avcodec;
2532
#endif
2533
AVCodec *av_codec_next(AVCodec *c);
2534

    
2535
/**
2536
 * Returns the LIBAVCODEC_VERSION_INT constant.
2537
 */
2538
unsigned avcodec_version(void);
2539

    
2540
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2541
/* returns LIBAVCODEC_BUILD constant */
2542
attribute_deprecated unsigned avcodec_build(void);
2543
#endif
2544

    
2545
/**
2546
 * Initializes libavcodec.
2547
 *
2548
 * @warning This function \e must be called before any other libavcodec
2549
 * function.
2550
 */
2551
void avcodec_init(void);
2552

    
2553
void register_avcodec(AVCodec *format);
2554

    
2555
/**
2556
 * Finds a registered encoder with a matching codec ID.
2557
 *
2558
 * @param id CodecID of the requested encoder
2559
 * @return An encoder if one was found, NULL otherwise.
2560
 */
2561
AVCodec *avcodec_find_encoder(enum CodecID id);
2562

    
2563
/**
2564
 * Finds a registered encoder with the specified name.
2565
 *
2566
 * @param name name of the requested encoder
2567
 * @return An encoder if one was found, NULL otherwise.
2568
 */
2569
AVCodec *avcodec_find_encoder_by_name(const char *name);
2570

    
2571
/**
2572
 * Finds a registered decoder with a matching codec ID.
2573
 *
2574
 * @param id CodecID of the requested decoder
2575
 * @return A decoder if one was found, NULL otherwise.
2576
 */
2577
AVCodec *avcodec_find_decoder(enum CodecID id);
2578

    
2579
/**
2580
 * Finds a registered decoder with the specified name.
2581
 *
2582
 * @param name name of the requested decoder
2583
 * @return A decoder if one was found, NULL otherwise.
2584
 */
2585
AVCodec *avcodec_find_decoder_by_name(const char *name);
2586
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2587

    
2588
/**
2589
 * Sets the fields of the given AVCodecContext to default values.
2590
 *
2591
 * @param s The AVCodecContext of which the fields should be set to default values.
2592
 */
2593
void avcodec_get_context_defaults(AVCodecContext *s);
2594

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

    
2599
/**
2600
 * Allocates an AVCodecContext and sets its fields to default values.  The
2601
 * resulting struct can be deallocated by simply calling av_free().
2602
 *
2603
 * @return An AVCodecContext filled with default values or NULL on failure.
2604
 * @see avcodec_get_context_defaults
2605
 */
2606
AVCodecContext *avcodec_alloc_context(void);
2607

    
2608
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2609
 *  we WILL change its arguments and name a few times! */
2610
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2611

    
2612
/**
2613
 * Sets the fields of the given AVFrame to default values.
2614
 *
2615
 * @param pic The AVFrame of which the fields should be set to default values.
2616
 */
2617
void avcodec_get_frame_defaults(AVFrame *pic);
2618

    
2619
/**
2620
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2621
 * struct can be deallocated by simply calling av_free().
2622
 *
2623
 * @return An AVFrame filled with default values or NULL on failure.
2624
 * @see avcodec_get_frame_defaults
2625
 */
2626
AVFrame *avcodec_alloc_frame(void);
2627

    
2628
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2629
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2630
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2631
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2632

    
2633
/**
2634
 * Checks if the given dimension of a picture is valid, meaning that all
2635
 * bytes of the picture can be addressed with a signed int.
2636
 *
2637
 * @param[in] w Width of the picture.
2638
 * @param[in] h Height of the picture.
2639
 * @return Zero if valid, a negative value if invalid.
2640
 */
2641
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2642
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2643

    
2644
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2645
void avcodec_thread_free(AVCodecContext *s);
2646
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2647
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2648
//FIXME func typedef
2649

    
2650
/**
2651
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2652
 * function the context has to be allocated.
2653
 *
2654
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2655
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2656
 * retrieving a codec.
2657
 *
2658
 * @warning This function is not thread safe!
2659
 *
2660
 * @code
2661
 * avcodec_register_all();
2662
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2663
 * if (!codec)
2664
 *     exit(1);
2665
 *
2666
 * context = avcodec_alloc_context();
2667
 *
2668
 * if (avcodec_open(context, codec) < 0)
2669
 *     exit(1);
2670
 * @endcode
2671
 *
2672
 * @param avctx The context which will be set up to use the given codec.
2673
 * @param codec The codec to use within the context.
2674
 * @return zero on success, a negative value on error
2675
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2676
 */
2677
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2678

    
2679
/**
2680
 * @deprecated Use avcodec_decode_audio2() instead.
2681
 */
2682
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2683
                         int *frame_size_ptr,
2684
                         const uint8_t *buf, int buf_size);
2685

    
2686
/**
2687
 * Decodes an audio frame from \p buf into \p samples.
2688
 * The avcodec_decode_audio2() function decodes an audio frame from the input
2689
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2690
 * audio codec which was coupled with \p avctx using avcodec_open(). The
2691
 * resulting decoded frame is stored in output buffer \p samples.  If no frame
2692
 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2693
 * decompressed frame size in \e bytes.
2694
 *
2695
 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2696
 * output buffer before calling avcodec_decode_audio2().
2697
 *
2698
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2699
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2700
 * bits at once and could read over the end.
2701
 *
2702
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2703
 * no overreading happens for damaged MPEG streams.
2704
 *
2705
 * @note You might have to align the input buffer \p buf and output buffer \p
2706
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2707
 * necessary at all, on others it won't work at all if not aligned and on others
2708
 * it will work but it will have an impact on performance. In practice, the
2709
 * bitstream should have 4 byte alignment at minimum and all sample data should
2710
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2711
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2712
 * start of the buffer to 16.
2713
 *
2714
 * @param avctx the codec context
2715
 * @param[out] samples the output buffer
2716
 * @param[in,out] frame_size_ptr the output buffer size in bytes
2717
 * @param[in] buf the input buffer
2718
 * @param[in] buf_size the input buffer size in bytes
2719
 * @return On error a negative value is returned, otherwise the number of bytes
2720
 * used or zero if no frame could be decompressed.
2721
 */
2722
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2723
                         int *frame_size_ptr,
2724
                         const uint8_t *buf, int buf_size);
2725

    
2726
/**
2727
 * Decodes a video frame from \p buf into \p picture.
2728
 * The avcodec_decode_video() function decodes a video frame from the input
2729
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2730
 * video codec which was coupled with \p avctx using avcodec_open(). The
2731
 * resulting decoded frame is stored in \p picture.
2732
 *
2733
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2734
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2735
 * bits at once and could read over the end.
2736
 *
2737
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2738
 * no overreading happens for damaged MPEG streams.
2739
 *
2740
 * @note You might have to align the input buffer \p buf and output buffer \p
2741
 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2742
 * necessary at all, on others it won't work at all if not aligned and on others
2743
 * it will work but it will have an impact on performance. In practice, the
2744
 * bitstream should have 4 byte alignment at minimum and all sample data should
2745
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2746
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2747
 * start of the buffer to 16.
2748
 *
2749
 * @param avctx the codec context
2750
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2751
 * @param[in] buf the input buffer
2752
 * @param[in] buf_size the size of the input buffer in bytes
2753
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2754
 * @return On error a negative value is returned, otherwise the number of bytes
2755
 * used or zero if no frame could be decompressed.
2756
 */
2757
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2758
                         int *got_picture_ptr,
2759
                         const uint8_t *buf, int buf_size);
2760

    
2761
/* Decode a subtitle message. Return -1 if error, otherwise return the
2762
 * number of bytes used. If no subtitle could be decompressed,
2763
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2764
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2765
                            int *got_sub_ptr,
2766
                            const uint8_t *buf, int buf_size);
2767
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2768
                        int *data_size_ptr,
2769
                        uint8_t *buf, int buf_size);
2770

    
2771
/**
2772
 * Encodes an audio frame from \p samples into \p buf.
2773
 * The avcodec_encode_audio() function encodes an audio frame from the input
2774
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2775
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2776
 * stored in output buffer \p buf.
2777
 *
2778
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2779
 *
2780
 * @param avctx the codec context
2781
 * @param[out] buf the output buffer
2782
 * @param[in] buf_size the output buffer size
2783
 * @param[in] samples the input buffer containing the samples
2784
 * The number of samples read from this buffer is frame_size*channels,
2785
 * both of which are defined in \p avctx.
2786
 * For PCM audio the number of samples read from \p samples is equal to
2787
 * \p buf_size * input_sample_size / output_sample_size.
2788
 * @return On error a negative value is returned, on success zero or the number
2789
 * of bytes used to encode the data read from the input buffer.
2790
 */
2791
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2792
                         const short *samples);
2793

    
2794
/**
2795
 * Encodes a video frame from \p pict into \p buf.
2796
 * The avcodec_encode_video() function encodes a video frame from the input
2797
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2798
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2799
 * frame are stored in the output buffer \p buf. The input picture should be
2800
 * stored using a specific format, namely \c avctx.pix_fmt.
2801
 *
2802
 * @param avctx the codec context
2803
 * @param[out] buf the output buffer for the bitstream of encoded frame
2804
 * @param[in] buf_size the size of the output buffer in bytes
2805
 * @param[in] pict the input picture to encode
2806
 * @return On error a negative value is returned, on success zero or the number
2807
 * of bytes used from the input buffer.
2808
 */
2809
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2810
                         const AVFrame *pict);
2811
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2812
                            const AVSubtitle *sub);
2813

    
2814
int avcodec_close(AVCodecContext *avctx);
2815

    
2816
void avcodec_register_all(void);
2817

    
2818
/**
2819
 * Flush buffers, should be called when seeking or when switching to a different stream.
2820
 */
2821
void avcodec_flush_buffers(AVCodecContext *avctx);
2822

    
2823
void avcodec_default_free_buffers(AVCodecContext *s);
2824

    
2825
/* misc useful functions */
2826

    
2827
/**
2828
 * Returns a single letter to describe the given picture type \p pict_type.
2829
 *
2830
 * @param[in] pict_type the picture type
2831
 * @return A single character representing the picture type.
2832
 */
2833
char av_get_pict_type_char(int pict_type);
2834

    
2835
/**
2836
 * Returns codec bits per sample.
2837
 *
2838
 * @param[in] codec_id the codec
2839
 * @return Number of bits per sample or zero if unknown for the given codec.
2840
 */
2841
int av_get_bits_per_sample(enum CodecID codec_id);
2842

    
2843
/**
2844
 * Returns sample format bits per sample.
2845
 *
2846
 * @param[in] sample_fmt the sample format
2847
 * @return Number of bits per sample or zero if unknown for the given sample format.
2848
 */
2849
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2850

    
2851
/* frame parsing */
2852
typedef struct AVCodecParserContext {
2853
    void *priv_data;
2854
    struct AVCodecParser *parser;
2855
    int64_t frame_offset; /* offset of the current frame */
2856
    int64_t cur_offset; /* current offset
2857
                           (incremented by each av_parser_parse()) */
2858
    int64_t next_frame_offset; /* offset of the next frame */
2859
    /* video info */
2860
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2861
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2862
    int64_t pts;     /* pts of the current frame */
2863
    int64_t dts;     /* dts of the current frame */
2864

    
2865
    /* private data */
2866
    int64_t last_pts;
2867
    int64_t last_dts;
2868
    int fetch_timestamp;
2869

    
2870
#define AV_PARSER_PTS_NB 4
2871
    int cur_frame_start_index;
2872
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2873
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2874
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2875

    
2876
    int flags;
2877
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2878

    
2879
    int64_t offset;      ///< byte offset from starting packet start
2880
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
2881
} AVCodecParserContext;
2882

    
2883
typedef struct AVCodecParser {
2884
    int codec_ids[5]; /* several codec IDs are permitted */
2885
    int priv_data_size;
2886
    int (*parser_init)(AVCodecParserContext *s);
2887
    int (*parser_parse)(AVCodecParserContext *s,
2888
                        AVCodecContext *avctx,
2889
                        const uint8_t **poutbuf, int *poutbuf_size,
2890
                        const uint8_t *buf, int buf_size);
2891
    void (*parser_close)(AVCodecParserContext *s);
2892
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2893
    struct AVCodecParser *next;
2894
} AVCodecParser;
2895

    
2896
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2897
extern AVCodecParser *av_first_parser;
2898
#endif
2899
AVCodecParser *av_parser_next(AVCodecParser *c);
2900

    
2901
void av_register_codec_parser(AVCodecParser *parser);
2902
AVCodecParserContext *av_parser_init(int codec_id);
2903
int av_parser_parse(AVCodecParserContext *s,
2904
                    AVCodecContext *avctx,
2905
                    uint8_t **poutbuf, int *poutbuf_size,
2906
                    const uint8_t *buf, int buf_size,
2907
                    int64_t pts, int64_t dts);
2908
int av_parser_change(AVCodecParserContext *s,
2909
                     AVCodecContext *avctx,
2910
                     uint8_t **poutbuf, int *poutbuf_size,
2911
                     const uint8_t *buf, int buf_size, int keyframe);
2912
void av_parser_close(AVCodecParserContext *s);
2913

    
2914

    
2915
typedef struct AVBitStreamFilterContext {
2916
    void *priv_data;
2917
    struct AVBitStreamFilter *filter;
2918
    AVCodecParserContext *parser;
2919
    struct AVBitStreamFilterContext *next;
2920
} AVBitStreamFilterContext;
2921

    
2922

    
2923
typedef struct AVBitStreamFilter {
2924
    const char *name;
2925
    int priv_data_size;
2926
    int (*filter)(AVBitStreamFilterContext *bsfc,
2927
                  AVCodecContext *avctx, const char *args,
2928
                  uint8_t **poutbuf, int *poutbuf_size,
2929
                  const uint8_t *buf, int buf_size, int keyframe);
2930
    void (*close)(AVBitStreamFilterContext *bsfc);
2931
    struct AVBitStreamFilter *next;
2932
} AVBitStreamFilter;
2933

    
2934
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2935
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2936
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2937
                               AVCodecContext *avctx, const char *args,
2938
                               uint8_t **poutbuf, int *poutbuf_size,
2939
                               const uint8_t *buf, int buf_size, int keyframe);
2940
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2941

    
2942
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2943

    
2944
/* memory */
2945

    
2946
/**
2947
 * Reallocates the given block if it is not large enough, otherwise it
2948
 * does nothing.
2949
 *
2950
 * @see av_realloc
2951
 */
2952
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2953

    
2954
/**
2955
 * Copy image 'src' to 'dst'.
2956
 */
2957
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2958
              int pix_fmt, int width, int height);
2959

    
2960
/**
2961
 * Crop image top and left side.
2962
 */
2963
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2964
             int pix_fmt, int top_band, int left_band);
2965

    
2966
/**
2967
 * Pad image.
2968
 */
2969
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2970
            int padtop, int padbottom, int padleft, int padright, int *color);
2971

    
2972
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2973
/**
2974
 * @deprecated Use the software scaler (swscale) instead.
2975
 */
2976
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2977
              int pix_fmt, int width, int height);
2978

    
2979
/**
2980
 * @deprecated Use the software scaler (swscale) instead.
2981
 */
2982
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2983
             int pix_fmt, int top_band, int left_band);
2984

    
2985
/**
2986
 * @deprecated Use the software scaler (swscale) instead.
2987
 */
2988
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2989
            int padtop, int padbottom, int padleft, int padright, int *color);
2990
#endif
2991

    
2992
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2993

    
2994
/**
2995
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2996
 *
2997
 * @return 0 in case of a successful parsing, a negative value otherwise
2998
 * @param[in] str the string to parse: it has to be a string in the format
2999
 * <width>x<height> or a valid video frame size abbreviation.
3000
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3001
 * frame width value
3002
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3003
 * frame height value
3004
 */
3005
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3006

    
3007
/**
3008
 * Parses \p str and put in \p frame_rate the detected values.
3009
 *
3010
 * @return 0 in case of a successful parsing, a negative value otherwise
3011
 * @param[in] str the string to parse: it has to be a string in the format
3012
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
3013
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3014
 * frame rate
3015
 */
3016
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3017

    
3018
/**
3019
 * Logs a generic warning message about a missing feature.
3020
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3021
 * a pointer to an AVClass struct
3022
 * @param[in] feature string containing the name of the missing feature
3023
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3024
 * If \p want_sample is non-zero, additional verbage will be added to the log
3025
 * message which tells the user how to report samples to the development
3026
 * mailing list.
3027
 */
3028
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3029

    
3030
/* error handling */
3031
#if EINVAL > 0
3032
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3033
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3034
#else
3035
/* Some platforms have E* and errno already negated. */
3036
#define AVERROR(e) (e)
3037
#define AVUNERROR(e) (e)
3038
#endif
3039
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3040
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3041
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3042
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3043
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3044
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3045
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3046
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3047
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3048

    
3049
#endif /* FFMPEG_AVCODEC_H */