Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 5ab65707

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

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

    
29

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

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

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

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

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

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

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

    
190
    /* various ADPCM codecs */
191
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
192
    CODEC_ID_ADPCM_IMA_WAV,
193
    CODEC_ID_ADPCM_IMA_DK3,
194
    CODEC_ID_ADPCM_IMA_DK4,
195
    CODEC_ID_ADPCM_IMA_WS,
196
    CODEC_ID_ADPCM_IMA_SMJPEG,
197
    CODEC_ID_ADPCM_MS,
198
    CODEC_ID_ADPCM_4XM,
199
    CODEC_ID_ADPCM_XA,
200
    CODEC_ID_ADPCM_ADX,
201
    CODEC_ID_ADPCM_EA,
202
    CODEC_ID_ADPCM_G726,
203
    CODEC_ID_ADPCM_CT,
204
    CODEC_ID_ADPCM_SWF,
205
    CODEC_ID_ADPCM_YAMAHA,
206
    CODEC_ID_ADPCM_SBPRO_4,
207
    CODEC_ID_ADPCM_SBPRO_3,
208
    CODEC_ID_ADPCM_SBPRO_2,
209
    CODEC_ID_ADPCM_THP,
210

    
211
    /* AMR */
212
    CODEC_ID_AMR_NB= 0x12000,
213
    CODEC_ID_AMR_WB,
214

    
215
    /* RealAudio codecs*/
216
    CODEC_ID_RA_144= 0x13000,
217
    CODEC_ID_RA_288,
218

    
219
    /* various DPCM codecs */
220
    CODEC_ID_ROQ_DPCM= 0x14000,
221
    CODEC_ID_INTERPLAY_DPCM,
222
    CODEC_ID_XAN_DPCM,
223
    CODEC_ID_SOL_DPCM,
224

    
225
    CODEC_ID_MP2= 0x15000,
226
    CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
227
    CODEC_ID_AAC,
228
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
229
    CODEC_ID_MPEG4AAC,
230
#endif
231
    CODEC_ID_AC3,
232
    CODEC_ID_DTS,
233
    CODEC_ID_VORBIS,
234
    CODEC_ID_DVAUDIO,
235
    CODEC_ID_WMAV1,
236
    CODEC_ID_WMAV2,
237
    CODEC_ID_MACE3,
238
    CODEC_ID_MACE6,
239
    CODEC_ID_VMDAUDIO,
240
    CODEC_ID_SONIC,
241
    CODEC_ID_SONIC_LS,
242
    CODEC_ID_FLAC,
243
    CODEC_ID_MP3ADU,
244
    CODEC_ID_MP3ON4,
245
    CODEC_ID_SHORTEN,
246
    CODEC_ID_ALAC,
247
    CODEC_ID_WESTWOOD_SND1,
248
    CODEC_ID_GSM, /* as in Berlin toast format */
249
    CODEC_ID_QDM2,
250
    CODEC_ID_COOK,
251
    CODEC_ID_TRUESPEECH,
252
    CODEC_ID_TTA,
253
    CODEC_ID_SMACKAUDIO,
254
    CODEC_ID_QCELP,
255
    CODEC_ID_WAVPACK,
256
    CODEC_ID_DSICINAUDIO,
257
    CODEC_ID_IMC,
258
    CODEC_ID_MUSEPACK7,
259
    CODEC_ID_MLP,
260
    CODEC_ID_GSM_MS, /* as found in WAV */
261
    CODEC_ID_ATRAC3,
262
    CODEC_ID_VOXWARE,
263

    
264
    /* subtitle codecs */
265
    CODEC_ID_DVD_SUBTITLE= 0x17000,
266
    CODEC_ID_DVB_SUBTITLE,
267
    CODEC_ID_TEXT,  /* raw UTF-8 text */
268
    CODEC_ID_XSUB,
269

    
270
    CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
271
                                * stream (only used by libavformat) */
272
};
273

    
274
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
275
/* CODEC_ID_MP3LAME is obsolete */
276
#define CODEC_ID_MP3LAME CODEC_ID_MP3
277
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
278
#endif
279

    
280
enum CodecType {
281
    CODEC_TYPE_UNKNOWN = -1,
282
    CODEC_TYPE_VIDEO,
283
    CODEC_TYPE_AUDIO,
284
    CODEC_TYPE_DATA,
285
    CODEC_TYPE_SUBTITLE,
286
    CODEC_TYPE_NB
287
};
288

    
289
/* Currently unused, may be used if 24/32 bits samples are ever supported. */
290
/* all in native-endian format */
291
enum SampleFormat {
292
    SAMPLE_FMT_NONE = -1,
293
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
294
    SAMPLE_FMT_S16,             ///< signed 16 bits
295
    SAMPLE_FMT_S24,             ///< signed 24 bits
296
    SAMPLE_FMT_S32,             ///< signed 32 bits
297
    SAMPLE_FMT_FLT,             ///< float
298
};
299

    
300
/* in bytes */
301
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
302

    
303
/**
304
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
305
 * This is mainly needed because some optimized bitstream readers read
306
 * 32 or 64 bit at once and could read over the end.<br>
307
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
308
 * MPEG bitstreams could cause overread and segfault.
309
 */
310
#define FF_INPUT_BUFFER_PADDING_SIZE 8
311

    
312
/**
313
 * minimum encoding buffer size
314
 * Used to avoid some checks during header writing.
315
 */
316
#define FF_MIN_BUFFER_SIZE 16384
317

    
318
/* motion estimation type, EPZS by default */
319
enum Motion_Est_ID {
320
    ME_ZERO = 1,
321
    ME_FULL,
322
    ME_LOG,
323
    ME_PHODS,
324
    ME_EPZS,
325
    ME_X1,
326
    ME_HEX,
327
    ME_UMH,
328
    ME_ITER,
329
};
330

    
331
enum AVDiscard{
332
    /* We leave some space between them for extensions (drop some
333
     * keyframes for intra-only or drop just some bidir frames). */
334
    AVDISCARD_NONE   =-16, ///< discard nothing
335
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
336
    AVDISCARD_NONREF =  8, ///< discard all non reference
337
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
338
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
339
    AVDISCARD_ALL    = 48, ///< discard all
340
};
341

    
342
typedef struct RcOverride{
343
    int start_frame;
344
    int end_frame;
345
    int qscale; // If this is 0 then quality_factor will be used instead.
346
    float quality_factor;
347
} RcOverride;
348

    
349
#define FF_MAX_B_FRAMES 16
350

    
351
/* encoding support
352
   These flags can be passed in AVCodecContext.flags before initialization.
353
   Note: Not everything is supported yet.
354
*/
355

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

    
414
/* Unsupported options :
415
 *              Syntax Arithmetic coding (SAC)
416
 *              Reference Picture Selection
417
 *              Independent Segment Decoding */
418
/* /Fx */
419
/* codec capabilities */
420

    
421
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
422
/**
423
 * Codec uses get_buffer() for allocating buffers.
424
 * direct rendering method 1
425
 */
426
#define CODEC_CAP_DR1             0x0002
427
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
428
#define CODEC_CAP_PARSE_ONLY      0x0004
429
#define CODEC_CAP_TRUNCATED       0x0008
430
/* Codec can export data for HW decoding (XvMC). */
431
#define CODEC_CAP_HWACCEL         0x0010
432
/**
433
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
434
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
435
 */
436
#define CODEC_CAP_DELAY           0x0020
437
/**
438
 * Codec can be fed a final frame with a smaller size.
439
 * This can be used to prevent truncation of the last audio samples.
440
 */
441
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
442

    
443
//The following defines may change, don't expect compatibility if you use them.
444
#define MB_TYPE_INTRA4x4   0x0001
445
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
446
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
447
#define MB_TYPE_16x16      0x0008
448
#define MB_TYPE_16x8       0x0010
449
#define MB_TYPE_8x16       0x0020
450
#define MB_TYPE_8x8        0x0040
451
#define MB_TYPE_INTERLACED 0x0080
452
#define MB_TYPE_DIRECT2     0x0100 //FIXME
453
#define MB_TYPE_ACPRED     0x0200
454
#define MB_TYPE_GMC        0x0400
455
#define MB_TYPE_SKIP       0x0800
456
#define MB_TYPE_P0L0       0x1000
457
#define MB_TYPE_P1L0       0x2000
458
#define MB_TYPE_P0L1       0x4000
459
#define MB_TYPE_P1L1       0x8000
460
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
461
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
462
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
463
#define MB_TYPE_QUANT      0x00010000
464
#define MB_TYPE_CBP        0x00020000
465
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
466

    
467
/**
468
 * Pan Scan area.
469
 * This specifies the area which should be displayed.
470
 * Note there may be multiple such areas for one frame.
471
 */
472
typedef struct AVPanScan{
473
    /**
474
     * id
475
     * - encoding: Set by user.
476
     * - decoding: Set by libavcodec.
477
     */
478
    int id;
479

    
480
    /**
481
     * width and height in 1/16 pel
482
     * - encoding: Set by user.
483
     * - decoding: Set by libavcodec.
484
     */
485
    int width;
486
    int height;
487

    
488
    /**
489
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
490
     * - encoding: Set by user.
491
     * - decoding: Set by libavcodec.
492
     */
493
    int16_t position[3][2];
494
}AVPanScan;
495

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

    
704
#define FF_QSCALE_TYPE_MPEG1 0
705
#define FF_QSCALE_TYPE_MPEG2 1
706
#define FF_QSCALE_TYPE_H264  2
707

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

    
713

    
714
#define FF_I_TYPE 1 // Intra
715
#define FF_P_TYPE 2 // Predicted
716
#define FF_B_TYPE 3 // Bi-dir predicted
717
#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
718
#define FF_SI_TYPE 5
719
#define FF_SP_TYPE 6
720

    
721
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
722
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
723
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
724
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
725

    
726
/**
727
 * Audio Video Frame.
728
 */
729
typedef struct AVFrame {
730
    FF_COMMON_FRAME
731
} AVFrame;
732

    
733
#define DEFAULT_FRAME_RATE_BASE 1001000
734

    
735
/**
736
 * main external API structure
737
 */
738
typedef struct AVCodecContext {
739
    /**
740
     * information on struct for av_log
741
     * - set by avcodec_alloc_context
742
     */
743
    AVClass *av_class;
744
    /**
745
     * the average bitrate
746
     * - encoding: Set by user; unused for constant quantizer encoding.
747
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
748
     */
749
    int bit_rate;
750

    
751
    /**
752
     * number of bits the bitstream is allowed to diverge from the reference.
753
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
754
     * - encoding: Set by user; unused for constant quantizer encoding.
755
     * - decoding: unused
756
     */
757
    int bit_rate_tolerance;
758

    
759
    /**
760
     * CODEC_FLAG_*.
761
     * - encoding: Set by user.
762
     * - decoding: Set by user.
763
     */
764
    int flags;
765

    
766
    /**
767
     * Some codecs need additional format info. It is stored here.
768
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
769
     * specific codec MUST set it correctly otherwise stream copy breaks.
770
     * In general use of this field by muxers is not recommanded.
771
     * - encoding: Set by libavcodec.
772
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
773
     */
774
    int sub_id;
775

    
776
    /**
777
     * Motion estimation algorithm used for video coding.
778
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
779
     * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
780
     * - encoding: MUST be set by user.
781
     * - decoding: unused
782
     */
783
    int me_method;
784

    
785
    /**
786
     * some codecs need / can use extradata like Huffman tables.
787
     * mjpeg: Huffman tables
788
     * rv10: additional flags
789
     * mpeg4: global headers (they can be in the bitstream or here)
790
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
791
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
792
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
793
     * - encoding: Set/allocated/freed by libavcodec.
794
     * - decoding: Set/allocated/freed by user.
795
     */
796
    uint8_t *extradata;
797
    int extradata_size;
798

    
799
    /**
800
     * This is the fundamental unit of time (in seconds) in terms
801
     * of which frame timestamps are represented. For fixed-fps content,
802
     * timebase should be 1/framerate and timestamp increments should be
803
     * identically 1.
804
     * - encoding: MUST be set by user.
805
     * - decoding: Set by libavcodec.
806
     */
807
    AVRational time_base;
808

    
809
    /* video only */
810
    /**
811
     * picture width / height.
812
     * - encoding: MUST be set by user.
813
     * - decoding: Set by libavcodec.
814
     * Note: For compatibility it is possible to set this instead of
815
     * coded_width/height before decoding.
816
     */
817
    int width, height;
818

    
819
#define FF_ASPECT_EXTENDED 15
820

    
821
    /**
822
     * the number of pictures in a group of pictures, or 0 for intra_only
823
     * - encoding: Set by user.
824
     * - decoding: unused
825
     */
826
    int gop_size;
827

    
828
    /**
829
     * Pixel format, see PIX_FMT_xxx.
830
     * - encoding: Set by user.
831
     * - decoding: Set by libavcodec.
832
     */
833
    enum PixelFormat pix_fmt;
834

    
835
    /**
836
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
837
     * has to read frames at native frame rate.
838
     * - encoding: Set by user.
839
     * - decoding: unused
840
     */
841
    int rate_emu;
842

    
843
    /**
844
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
845
     * decoder to draw a horizontal band. It improves cache usage. Not
846
     * all codecs can do that. You must check the codec capabilities
847
     * beforehand.
848
     * - encoding: unused
849
     * - decoding: Set by user.
850
     * @param height the height of the slice
851
     * @param y the y position of the slice
852
     * @param type 1->top field, 2->bottom field, 3->frame
853
     * @param offset offset into the AVFrame.data from which the slice should be read
854
     */
855
    void (*draw_horiz_band)(struct AVCodecContext *s,
856
                            const AVFrame *src, int offset[4],
857
                            int y, int type, int height);
858

    
859
    /* audio only */
860
    int sample_rate; ///< samples per second
861
    int channels;
862

    
863
    /**
864
     * audio sample format
865
     * - encoding: Set by user.
866
     * - decoding: Set by libavcodec.
867
     */
868
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
869

    
870
    /* The following data should not be initialized. */
871
    /**
872
     * Samples per packet, initialized when calling 'init'.
873
     */
874
    int frame_size;
875
    int frame_number;   ///< audio or video frame number
876
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
877

    
878
    /**
879
     * Number of frames the decoded output will be delayed relative to
880
     * the encoded input.
881
     * - encoding: Set by libavcodec.
882
     * - decoding: unused
883
     */
884
    int delay;
885

    
886
    /* - encoding parameters */
887
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
888
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
889

    
890
    /**
891
     * minimum quantizer
892
     * - encoding: Set by user.
893
     * - decoding: unused
894
     */
895
    int qmin;
896

    
897
    /**
898
     * maximum quantizer
899
     * - encoding: Set by user.
900
     * - decoding: unused
901
     */
902
    int qmax;
903

    
904
    /**
905
     * maximum quantizer difference between frames
906
     * - encoding: Set by user.
907
     * - decoding: unused
908
     */
909
    int max_qdiff;
910

    
911
    /**
912
     * maximum number of B-frames between non-B-frames
913
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
914
     * - encoding: Set by user.
915
     * - decoding: unused
916
     */
917
    int max_b_frames;
918

    
919
    /**
920
     * qscale factor between IP and B-frames
921
     * - encoding: Set by user.
922
     * - decoding: unused
923
     */
924
    float b_quant_factor;
925

    
926
    /** obsolete FIXME remove */
927
    int rc_strategy;
928
#define FF_RC_STRATEGY_XVID 1
929

    
930
    int b_frame_strategy;
931

    
932
    /**
933
     * hurry up amount
934
     * - encoding: unused
935
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
936
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
937
     */
938
    int hurry_up;
939

    
940
    struct AVCodec *codec;
941

    
942
    void *priv_data;
943

    
944
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
945
    /* unused, FIXME remove*/
946
    int rtp_mode;
947
#endif
948

    
949
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
950
                            /* do its best to deliver a chunk with size     */
951
                            /* below rtp_payload_size, the chunk will start */
952
                            /* with a start code on some codecs like H.263. */
953
                            /* This doesn't take account of any particular  */
954
                            /* headers inside the transmitted RTP payload.  */
955

    
956

    
957
    /* The RTP callback: This function is called    */
958
    /* every time the encoder has a packet to send. */
959
    /* It depends on the encoder if the data starts */
960
    /* with a Start Code (it should). H.263 does.   */
961
    /* mb_nb contains the number of macroblocks     */
962
    /* encoded in the RTP payload.                  */
963
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
964

    
965
    /* statistics, used for 2-pass encoding */
966
    int mv_bits;
967
    int header_bits;
968
    int i_tex_bits;
969
    int p_tex_bits;
970
    int i_count;
971
    int p_count;
972
    int skip_count;
973
    int misc_bits;
974

    
975
    /**
976
     * number of bits used for the previously encoded frame
977
     * - encoding: Set by libavcodec.
978
     * - decoding: unused
979
     */
980
    int frame_bits;
981

    
982
    /**
983
     * Private data of the user, can be used to carry app specific stuff.
984
     * - encoding: Set by user.
985
     * - decoding: Set by user.
986
     */
987
    void *opaque;
988

    
989
    char codec_name[32];
990
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
991
    enum CodecID codec_id; /* see CODEC_ID_xxx */
992

    
993
    /**
994
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
995
     * This is used to work around some encoder bugs.
996
     * A demuxer should set this to what is stored in the field used to identify the codec.
997
     * If there are multiple such fields in a container then the demuxer should choose the one
998
     * which maximizes the information about the used codec.
999
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1000
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1001
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1002
     * first.
1003
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1004
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1005
     */
1006
    unsigned int codec_tag;
1007

    
1008
    /**
1009
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1010
     * - encoding: Set by user
1011
     * - decoding: Set by user
1012
     */
1013
    int workaround_bugs;
1014
#define FF_BUG_AUTODETECT       1  ///< autodetection
1015
#define FF_BUG_OLD_MSMPEG4      2
1016
#define FF_BUG_XVID_ILACE       4
1017
#define FF_BUG_UMP4             8
1018
#define FF_BUG_NO_PADDING       16
1019
#define FF_BUG_AMV              32
1020
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1021
#define FF_BUG_QPEL_CHROMA      64
1022
#define FF_BUG_STD_QPEL         128
1023
#define FF_BUG_QPEL_CHROMA2     256
1024
#define FF_BUG_DIRECT_BLOCKSIZE 512
1025
#define FF_BUG_EDGE             1024
1026
#define FF_BUG_HPEL_CHROMA      2048
1027
#define FF_BUG_DC_CLIP          4096
1028
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1029
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1030

    
1031
    /**
1032
     * luma single coefficient elimination threshold
1033
     * - encoding: Set by user.
1034
     * - decoding: unused
1035
     */
1036
    int luma_elim_threshold;
1037

    
1038
    /**
1039
     * chroma single coeff elimination threshold
1040
     * - encoding: Set by user.
1041
     * - decoding: unused
1042
     */
1043
    int chroma_elim_threshold;
1044

    
1045
    /**
1046
     * strictly follow the standard (MPEG4, ...).
1047
     * - encoding: Set by user.
1048
     * - decoding: unused
1049
     */
1050
    int strict_std_compliance;
1051
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1052
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1053
#define FF_COMPLIANCE_NORMAL        0
1054
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1055
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1056

    
1057
    /**
1058
     * qscale offset between IP and B-frames
1059
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1060
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1061
     * - encoding: Set by user.
1062
     * - decoding: unused
1063
     */
1064
    float b_quant_offset;
1065

    
1066
    /**
1067
     * Error resilience; higher values will detect more errors but may
1068
     * misdetect some more or less valid parts as errors.
1069
     * - encoding: unused
1070
     * - decoding: Set by user.
1071
     */
1072
    int error_resilience;
1073
#define FF_ER_CAREFUL         1
1074
#define FF_ER_COMPLIANT       2
1075
#define FF_ER_AGGRESSIVE      3
1076
#define FF_ER_VERY_AGGRESSIVE 4
1077

    
1078
    /**
1079
     * Called at the beginning of each frame to get a buffer for it.
1080
     * If pic.reference is set then the frame will be read later by libavcodec.
1081
     * avcodec_align_dimensions() should be used to find the required width and
1082
     * height, as they normally need to be rounded up to the next multiple of 16.
1083
     * - encoding: unused
1084
     * - decoding: Set by libavcodec., user can override.
1085
     */
1086
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1087

    
1088
    /**
1089
     * Called to release buffers which where allocated with get_buffer.
1090
     * A released buffer can be reused in get_buffer().
1091
     * pic.data[*] must be set to NULL.
1092
     * - encoding: unused
1093
     * - decoding: Set by libavcodec., user can override.
1094
     */
1095
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1096

    
1097
    /**
1098
     * If 1 the stream has a 1 frame delay during decoding.
1099
     * - encoding: Set by libavcodec.
1100
     * - decoding: Set by libavcodec.
1101
     */
1102
    int has_b_frames;
1103

    
1104
    /**
1105
     * number of bytes per packet if constant and known or 0
1106
     * Used by some WAV based audio codecs.
1107
     */
1108
    int block_align;
1109

    
1110
    int parse_only; /* - decoding only: If true, only parsing is done
1111
                       (function avcodec_parse_frame()). The frame
1112
                       data is returned. Only MPEG codecs support this now. */
1113

    
1114
    /**
1115
     * 0-> h263 quant 1-> mpeg quant
1116
     * - encoding: Set by user.
1117
     * - decoding: unused
1118
     */
1119
    int mpeg_quant;
1120

    
1121
    /**
1122
     * pass1 encoding statistics output buffer
1123
     * - encoding: Set by libavcodec.
1124
     * - decoding: unused
1125
     */
1126
    char *stats_out;
1127

    
1128
    /**
1129
     * pass2 encoding statistics input buffer
1130
     * Concatenated stuff from stats_out of pass1 should be placed here.
1131
     * - encoding: Allocated/set/freed by user.
1132
     * - decoding: unused
1133
     */
1134
    char *stats_in;
1135

    
1136
    /**
1137
     * ratecontrol qmin qmax limiting method
1138
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1139
     * - encoding: Set by user.
1140
     * - decoding: unused
1141
     */
1142
    float rc_qsquish;
1143

    
1144
    float rc_qmod_amp;
1145
    int rc_qmod_freq;
1146

    
1147
    /**
1148
     * ratecontrol override, see RcOverride
1149
     * - encoding: Allocated/set/freed by user.
1150
     * - decoding: unused
1151
     */
1152
    RcOverride *rc_override;
1153
    int rc_override_count;
1154

    
1155
    /**
1156
     * rate control equation
1157
     * - encoding: Set by user
1158
     * - decoding: unused
1159
     */
1160
    char *rc_eq;
1161

    
1162
    /**
1163
     * maximum bitrate
1164
     * - encoding: Set by user.
1165
     * - decoding: unused
1166
     */
1167
    int rc_max_rate;
1168

    
1169
    /**
1170
     * minimum bitrate
1171
     * - encoding: Set by user.
1172
     * - decoding: unused
1173
     */
1174
    int rc_min_rate;
1175

    
1176
    /**
1177
     * decoder bitstream buffer size
1178
     * - encoding: Set by user.
1179
     * - decoding: unused
1180
     */
1181
    int rc_buffer_size;
1182
    float rc_buffer_aggressivity;
1183

    
1184
    /**
1185
     * qscale factor between P and I-frames
1186
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1187
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1188
     * - encoding: Set by user.
1189
     * - decoding: unused
1190
     */
1191
    float i_quant_factor;
1192

    
1193
    /**
1194
     * qscale offset between P and I-frames
1195
     * - encoding: Set by user.
1196
     * - decoding: unused
1197
     */
1198
    float i_quant_offset;
1199

    
1200
    /**
1201
     * initial complexity for pass1 ratecontrol
1202
     * - encoding: Set by user.
1203
     * - decoding: unused
1204
     */
1205
    float rc_initial_cplx;
1206

    
1207
    /**
1208
     * DCT algorithm, see FF_DCT_* below
1209
     * - encoding: Set by user.
1210
     * - decoding: unused
1211
     */
1212
    int dct_algo;
1213
#define FF_DCT_AUTO    0
1214
#define FF_DCT_FASTINT 1
1215
#define FF_DCT_INT     2
1216
#define FF_DCT_MMX     3
1217
#define FF_DCT_MLIB    4
1218
#define FF_DCT_ALTIVEC 5
1219
#define FF_DCT_FAAN    6
1220

    
1221
    /**
1222
     * luminance masking (0-> disabled)
1223
     * - encoding: Set by user.
1224
     * - decoding: unused
1225
     */
1226
    float lumi_masking;
1227

    
1228
    /**
1229
     * temporary complexity masking (0-> disabled)
1230
     * - encoding: Set by user.
1231
     * - decoding: unused
1232
     */
1233
    float temporal_cplx_masking;
1234

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

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

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

    
1256

    
1257
    /* for binary compatibility */
1258
    int unused;
1259

    
1260
    /**
1261
     * IDCT algorithm, see FF_IDCT_* below.
1262
     * - encoding: Set by user.
1263
     * - decoding: Set by user.
1264
     */
1265
    int idct_algo;
1266
#define FF_IDCT_AUTO         0
1267
#define FF_IDCT_INT          1
1268
#define FF_IDCT_SIMPLE       2
1269
#define FF_IDCT_SIMPLEMMX    3
1270
#define FF_IDCT_LIBMPEG2MMX  4
1271
#define FF_IDCT_PS2          5
1272
#define FF_IDCT_MLIB         6
1273
#define FF_IDCT_ARM          7
1274
#define FF_IDCT_ALTIVEC      8
1275
#define FF_IDCT_SH4          9
1276
#define FF_IDCT_SIMPLEARM    10
1277
#define FF_IDCT_H264         11
1278
#define FF_IDCT_VP3          12
1279
#define FF_IDCT_IPP          13
1280
#define FF_IDCT_XVIDMMX      14
1281
#define FF_IDCT_CAVS         15
1282
#define FF_IDCT_SIMPLEARMV5TE 16
1283
#define FF_IDCT_SIMPLEARMV6  17
1284

    
1285
    /**
1286
     * slice count
1287
     * - encoding: Set by libavcodec.
1288
     * - decoding: Set by user (or 0).
1289
     */
1290
    int slice_count;
1291
    /**
1292
     * slice offsets in the frame in bytes
1293
     * - encoding: Set/allocated by libavcodec.
1294
     * - decoding: Set/allocated by user (or NULL).
1295
     */
1296
    int *slice_offset;
1297

    
1298
    /**
1299
     * error concealment flags
1300
     * - encoding: unused
1301
     * - decoding: Set by user.
1302
     */
1303
    int error_concealment;
1304
#define FF_EC_GUESS_MVS   1
1305
#define FF_EC_DEBLOCK     2
1306

    
1307
    /**
1308
     * dsp_mask could be add used to disable unwanted CPU features
1309
     * CPU features (i.e. MMX, SSE. ...)
1310
     *
1311
     * With the FORCE flag you may instead enable given CPU features.
1312
     * (Dangerous: Usable in case of misdetection, improper usage however will
1313
     * result into program crash.)
1314
     */
1315
    unsigned dsp_mask;
1316
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1317
    /* lower 16 bits - CPU features */
1318
#define FF_MM_MMX      0x0001 /* standard MMX */
1319
#define FF_MM_3DNOW    0x0004 /* AMD 3DNOW */
1320
#define FF_MM_MMXEXT   0x0002 /* SSE integer functions or AMD MMX ext */
1321
#define FF_MM_SSE      0x0008 /* SSE functions */
1322
#define FF_MM_SSE2     0x0010 /* PIV SSE2 functions */
1323
#define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1324
#define FF_MM_SSE3     0x0040 /* Prescott SSE3 functions */
1325
#define FF_MM_SSSE3    0x0080 /* Conroe SSSE3 functions */
1326
#define FF_MM_IWMMXT   0x0100 /* XScale IWMMXT */
1327

    
1328
    /**
1329
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1330
     * - encoding: Set by libavcodec.
1331
     * - decoding: Set by user.
1332
     */
1333
     int bits_per_sample;
1334

    
1335
    /**
1336
     * prediction method (needed for huffyuv)
1337
     * - encoding: Set by user.
1338
     * - decoding: unused
1339
     */
1340
     int prediction_method;
1341
#define FF_PRED_LEFT   0
1342
#define FF_PRED_PLANE  1
1343
#define FF_PRED_MEDIAN 2
1344

    
1345
    /**
1346
     * sample aspect ratio (0 if unknown)
1347
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1348
     * - encoding: Set by user.
1349
     * - decoding: Set by libavcodec.
1350
     */
1351
    AVRational sample_aspect_ratio;
1352

    
1353
    /**
1354
     * the picture in the bitstream
1355
     * - encoding: Set by libavcodec.
1356
     * - decoding: Set by libavcodec.
1357
     */
1358
    AVFrame *coded_frame;
1359

    
1360
    /**
1361
     * debug
1362
     * - encoding: Set by user.
1363
     * - decoding: Set by user.
1364
     */
1365
    int debug;
1366
#define FF_DEBUG_PICT_INFO 1
1367
#define FF_DEBUG_RC        2
1368
#define FF_DEBUG_BITSTREAM 4
1369
#define FF_DEBUG_MB_TYPE   8
1370
#define FF_DEBUG_QP        16
1371
#define FF_DEBUG_MV        32
1372
#define FF_DEBUG_DCT_COEFF 0x00000040
1373
#define FF_DEBUG_SKIP      0x00000080
1374
#define FF_DEBUG_STARTCODE 0x00000100
1375
#define FF_DEBUG_PTS       0x00000200
1376
#define FF_DEBUG_ER        0x00000400
1377
#define FF_DEBUG_MMCO      0x00000800
1378
#define FF_DEBUG_BUGS      0x00001000
1379
#define FF_DEBUG_VIS_QP    0x00002000
1380
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1381

    
1382
    /**
1383
     * debug
1384
     * - encoding: Set by user.
1385
     * - decoding: Set by user.
1386
     */
1387
    int debug_mv;
1388
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1389
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1390
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1391

    
1392
    /**
1393
     * error
1394
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1395
     * - decoding: unused
1396
     */
1397
    uint64_t error[4];
1398

    
1399
    /**
1400
     * minimum MB quantizer
1401
     * - encoding: unused
1402
     * - decoding: unused
1403
     */
1404
    int mb_qmin;
1405

    
1406
    /**
1407
     * maximum MB quantizer
1408
     * - encoding: unused
1409
     * - decoding: unused
1410
     */
1411
    int mb_qmax;
1412

    
1413
    /**
1414
     * motion estimation comparison function
1415
     * - encoding: Set by user.
1416
     * - decoding: unused
1417
     */
1418
    int me_cmp;
1419
    /**
1420
     * subpixel motion estimation comparison function
1421
     * - encoding: Set by user.
1422
     * - decoding: unused
1423
     */
1424
    int me_sub_cmp;
1425
    /**
1426
     * macroblock comparison function (not supported yet)
1427
     * - encoding: Set by user.
1428
     * - decoding: unused
1429
     */
1430
    int mb_cmp;
1431
    /**
1432
     * interlaced DCT comparison function
1433
     * - encoding: Set by user.
1434
     * - decoding: unused
1435
     */
1436
    int ildct_cmp;
1437
#define FF_CMP_SAD  0
1438
#define FF_CMP_SSE  1
1439
#define FF_CMP_SATD 2
1440
#define FF_CMP_DCT  3
1441
#define FF_CMP_PSNR 4
1442
#define FF_CMP_BIT  5
1443
#define FF_CMP_RD   6
1444
#define FF_CMP_ZERO 7
1445
#define FF_CMP_VSAD 8
1446
#define FF_CMP_VSSE 9
1447
#define FF_CMP_NSSE 10
1448
#define FF_CMP_W53  11
1449
#define FF_CMP_W97  12
1450
#define FF_CMP_DCTMAX 13
1451
#define FF_CMP_DCT264 14
1452
#define FF_CMP_CHROMA 256
1453

    
1454
    /**
1455
     * ME diamond size & shape
1456
     * - encoding: Set by user.
1457
     * - decoding: unused
1458
     */
1459
    int dia_size;
1460

    
1461
    /**
1462
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1463
     * - encoding: Set by user.
1464
     * - decoding: unused
1465
     */
1466
    int last_predictor_count;
1467

    
1468
    /**
1469
     * prepass for motion estimation
1470
     * - encoding: Set by user.
1471
     * - decoding: unused
1472
     */
1473
    int pre_me;
1474

    
1475
    /**
1476
     * motion estimation prepass comparison function
1477
     * - encoding: Set by user.
1478
     * - decoding: unused
1479
     */
1480
    int me_pre_cmp;
1481

    
1482
    /**
1483
     * ME prepass diamond size & shape
1484
     * - encoding: Set by user.
1485
     * - decoding: unused
1486
     */
1487
    int pre_dia_size;
1488

    
1489
    /**
1490
     * subpel ME quality
1491
     * - encoding: Set by user.
1492
     * - decoding: unused
1493
     */
1494
    int me_subpel_quality;
1495

    
1496
    /**
1497
     * callback to negotiate the pixelFormat
1498
     * @param fmt is the list of formats which are supported by the codec,
1499
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1500
     * The first is always the native one.
1501
     * @return the chosen format
1502
     * - encoding: unused
1503
     * - decoding: Set by user, if not set the native format will be chosen.
1504
     */
1505
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1506

    
1507
    /**
1508
     * DTG active format information (additional aspect ratio
1509
     * information only used in DVB MPEG-2 transport streams)
1510
     * 0 if not set.
1511
     *
1512
     * - encoding: unused
1513
     * - decoding: Set by decoder.
1514
     */
1515
    int dtg_active_format;
1516
#define FF_DTG_AFD_SAME         8
1517
#define FF_DTG_AFD_4_3          9
1518
#define FF_DTG_AFD_16_9         10
1519
#define FF_DTG_AFD_14_9         11
1520
#define FF_DTG_AFD_4_3_SP_14_9  13
1521
#define FF_DTG_AFD_16_9_SP_14_9 14
1522
#define FF_DTG_AFD_SP_4_3       15
1523

    
1524
    /**
1525
     * maximum motion estimation search range in subpel units
1526
     * If 0 then no limit.
1527
     *
1528
     * - encoding: Set by user.
1529
     * - decoding: unused
1530
     */
1531
    int me_range;
1532

    
1533
    /**
1534
     * intra quantizer bias
1535
     * - encoding: Set by user.
1536
     * - decoding: unused
1537
     */
1538
    int intra_quant_bias;
1539
#define FF_DEFAULT_QUANT_BIAS 999999
1540

    
1541
    /**
1542
     * inter quantizer bias
1543
     * - encoding: Set by user.
1544
     * - decoding: unused
1545
     */
1546
    int inter_quant_bias;
1547

    
1548
    /**
1549
     * color table ID
1550
     * - encoding: unused
1551
     * - decoding: Which clrtable should be used for 8bit RGB images.
1552
     *             Tables have to be stored somewhere. FIXME
1553
     */
1554
    int color_table_id;
1555

    
1556
    /**
1557
     * internal_buffer count
1558
     * Don't touch, used by libavcodec default_get_buffer().
1559
     */
1560
    int internal_buffer_count;
1561

    
1562
    /**
1563
     * internal_buffers
1564
     * Don't touch, used by libavcodec default_get_buffer().
1565
     */
1566
    void *internal_buffer;
1567

    
1568
#define FF_LAMBDA_SHIFT 7
1569
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1570
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1571
#define FF_LAMBDA_MAX (256*128-1)
1572

    
1573
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1574
    /**
1575
     * Global quality for codecs which cannot change it per frame.
1576
     * This should be proportional to MPEG-1/2/4 qscale.
1577
     * - encoding: Set by user.
1578
     * - decoding: unused
1579
     */
1580
    int global_quality;
1581

    
1582
#define FF_CODER_TYPE_VLC       0
1583
#define FF_CODER_TYPE_AC        1
1584
#define FF_CODER_TYPE_RAW       2
1585
#define FF_CODER_TYPE_RLE       3
1586
#define FF_CODER_TYPE_DEFLATE   4
1587
    /**
1588
     * coder type
1589
     * - encoding: Set by user.
1590
     * - decoding: unused
1591
     */
1592
    int coder_type;
1593

    
1594
    /**
1595
     * context model
1596
     * - encoding: Set by user.
1597
     * - decoding: unused
1598
     */
1599
    int context_model;
1600
#if 0
1601
    /**
1602
     *
1603
     * - encoding: unused
1604
     * - decoding: Set by user.
1605
     */
1606
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1607
#endif
1608

    
1609
    /**
1610
     * slice flags
1611
     * - encoding: unused
1612
     * - decoding: Set by user.
1613
     */
1614
    int slice_flags;
1615
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1616
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1617
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1618

    
1619
    /**
1620
     * XVideo Motion Acceleration
1621
     * - encoding: forbidden
1622
     * - decoding: set by decoder
1623
     */
1624
    int xvmc_acceleration;
1625

    
1626
    /**
1627
     * macroblock decision mode
1628
     * - encoding: Set by user.
1629
     * - decoding: unused
1630
     */
1631
    int mb_decision;
1632
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1633
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1634
#define FF_MB_DECISION_RD     2        ///< rate distoration
1635

    
1636
    /**
1637
     * custom intra quantization matrix
1638
     * - encoding: Set by user, can be NULL.
1639
     * - decoding: Set by libavcodec.
1640
     */
1641
    uint16_t *intra_matrix;
1642

    
1643
    /**
1644
     * custom inter quantization matrix
1645
     * - encoding: Set by user, can be NULL.
1646
     * - decoding: Set by libavcodec.
1647
     */
1648
    uint16_t *inter_matrix;
1649

    
1650
    /**
1651
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1652
     * This is used to work around some encoder bugs.
1653
     * - encoding: unused
1654
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1655
     */
1656
    unsigned int stream_codec_tag;
1657

    
1658
    /**
1659
     * scene change detection threshold
1660
     * 0 is default, larger means fewer detected scene changes.
1661
     * - encoding: Set by user.
1662
     * - decoding: unused
1663
     */
1664
    int scenechange_threshold;
1665

    
1666
    /**
1667
     * minimum Lagrange multipler
1668
     * - encoding: Set by user.
1669
     * - decoding: unused
1670
     */
1671
    int lmin;
1672

    
1673
    /**
1674
     * maximum Lagrange multipler
1675
     * - encoding: Set by user.
1676
     * - decoding: unused
1677
     */
1678
    int lmax;
1679

    
1680
    /**
1681
     * palette control structure
1682
     * - encoding: ??? (no palette-enabled encoder yet)
1683
     * - decoding: Set by user.
1684
     */
1685
    struct AVPaletteControl *palctrl;
1686

    
1687
    /**
1688
     * noise reduction strength
1689
     * - encoding: Set by user.
1690
     * - decoding: unused
1691
     */
1692
    int noise_reduction;
1693

    
1694
    /**
1695
     * Called at the beginning of a frame to get cr buffer for it.
1696
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1697
     * libavcodec will pass previous buffer in pic, function should return
1698
     * same buffer or new buffer with old frame "painted" into it.
1699
     * If pic.data[0] == NULL must behave like get_buffer().
1700
     * - encoding: unused
1701
     * - decoding: Set by libavcodec., user can override
1702
     */
1703
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1704

    
1705
    /**
1706
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1707
     * - encoding: Set by user.
1708
     * - decoding: unused
1709
     */
1710
    int rc_initial_buffer_occupancy;
1711

    
1712
    /**
1713
     *
1714
     * - encoding: Set by user.
1715
     * - decoding: unused
1716
     */
1717
    int inter_threshold;
1718

    
1719
    /**
1720
     * CODEC_FLAG2_*
1721
     * - encoding: Set by user.
1722
     * - decoding: Set by user.
1723
     */
1724
    int flags2;
1725

    
1726
    /**
1727
     * Simulates errors in the bitstream to test error concealment.
1728
     * - encoding: Set by user.
1729
     * - decoding: unused
1730
     */
1731
    int error_rate;
1732

    
1733
    /**
1734
     * MP3 antialias algorithm, see FF_AA_* below.
1735
     * - encoding: unused
1736
     * - decoding: Set by user.
1737
     */
1738
    int antialias_algo;
1739
#define FF_AA_AUTO    0
1740
#define FF_AA_FASTINT 1 //not implemented yet
1741
#define FF_AA_INT     2
1742
#define FF_AA_FLOAT   3
1743
    /**
1744
     * quantizer noise shaping
1745
     * - encoding: Set by user.
1746
     * - decoding: unused
1747
     */
1748
    int quantizer_noise_shaping;
1749

    
1750
    /**
1751
     * thread count
1752
     * is used to decide how many independent tasks should be passed to execute()
1753
     * - encoding: Set by user.
1754
     * - decoding: Set by user.
1755
     */
1756
    int thread_count;
1757

    
1758
    /**
1759
     * The codec may call this to execute several independent things.
1760
     * It will return only after finishing all tasks.
1761
     * The user may replace this with some multithreaded implementation,
1762
     * the default implementation will execute the parts serially.
1763
     * @param count the number of things to execute
1764
     * - encoding: Set by libavcodec, user can override.
1765
     * - decoding: Set by libavcodec, user can override.
1766
     */
1767
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1768

    
1769
    /**
1770
     * thread opaque
1771
     * Can be used by execute() to store some per AVCodecContext stuff.
1772
     * - encoding: set by execute()
1773
     * - decoding: set by execute()
1774
     */
1775
    void *thread_opaque;
1776

    
1777
    /**
1778
     * Motion estimation threshold below which no motion estimation is
1779
     * performed, but instead the user specified motion vectors are used.
1780
     *
1781
     * - encoding: Set by user.
1782
     * - decoding: unused
1783
     */
1784
     int me_threshold;
1785

    
1786
    /**
1787
     * Macroblock threshold below which the user specified macroblock types will be used.
1788
     * - encoding: Set by user.
1789
     * - decoding: unused
1790
     */
1791
     int mb_threshold;
1792

    
1793
    /**
1794
     * precision of the intra DC coefficient - 8
1795
     * - encoding: Set by user.
1796
     * - decoding: unused
1797
     */
1798
     int intra_dc_precision;
1799

    
1800
    /**
1801
     * noise vs. sse weight for the nsse comparsion function
1802
     * - encoding: Set by user.
1803
     * - decoding: unused
1804
     */
1805
     int nsse_weight;
1806

    
1807
    /**
1808
     * Number of macroblock rows at the top which are skipped.
1809
     * - encoding: unused
1810
     * - decoding: Set by user.
1811
     */
1812
     int skip_top;
1813

    
1814
    /**
1815
     * Number of macroblock rows at the bottom which are skipped.
1816
     * - encoding: unused
1817
     * - decoding: Set by user.
1818
     */
1819
     int skip_bottom;
1820

    
1821
    /**
1822
     * profile
1823
     * - encoding: Set by user.
1824
     * - decoding: Set by libavcodec.
1825
     */
1826
     int profile;
1827
#define FF_PROFILE_UNKNOWN -99
1828
#define FF_PROFILE_AAC_MAIN 0
1829
#define FF_PROFILE_AAC_LOW 1
1830
#define FF_PROFILE_AAC_SSR 2
1831
#define FF_PROFILE_AAC_LTP 3
1832

    
1833
    /**
1834
     * level
1835
     * - encoding: Set by user.
1836
     * - decoding: Set by libavcodec.
1837
     */
1838
     int level;
1839
#define FF_LEVEL_UNKNOWN -99
1840

    
1841
    /**
1842
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1843
     * - encoding: unused
1844
     * - decoding: Set by user.
1845
     */
1846
     int lowres;
1847

    
1848
    /**
1849
     * Bitstream width / height, may be different from width/height if lowres
1850
     * or other things are used.
1851
     * - encoding: unused
1852
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1853
     */
1854
    int coded_width, coded_height;
1855

    
1856
    /**
1857
     * frame skip threshold
1858
     * - encoding: Set by user.
1859
     * - decoding: unused
1860
     */
1861
    int frame_skip_threshold;
1862

    
1863
    /**
1864
     * frame skip factor
1865
     * - encoding: Set by user.
1866
     * - decoding: unused
1867
     */
1868
    int frame_skip_factor;
1869

    
1870
    /**
1871
     * frame skip exponent
1872
     * - encoding: Set by user.
1873
     * - decoding: unused
1874
     */
1875
    int frame_skip_exp;
1876

    
1877
    /**
1878
     * frame skip comparison function
1879
     * - encoding: Set by user.
1880
     * - decoding: unused
1881
     */
1882
    int frame_skip_cmp;
1883

    
1884
    /**
1885
     * Border processing masking, raises the quantizer for mbs on the borders
1886
     * of the picture.
1887
     * - encoding: Set by user.
1888
     * - decoding: unused
1889
     */
1890
    float border_masking;
1891

    
1892
    /**
1893
     * minimum MB lagrange multipler
1894
     * - encoding: Set by user.
1895
     * - decoding: unused
1896
     */
1897
    int mb_lmin;
1898

    
1899
    /**
1900
     * maximum MB lagrange multipler
1901
     * - encoding: Set by user.
1902
     * - decoding: unused
1903
     */
1904
    int mb_lmax;
1905

    
1906
    /**
1907
     *
1908
     * - encoding: Set by user.
1909
     * - decoding: unused
1910
     */
1911
    int me_penalty_compensation;
1912

    
1913
    /**
1914
     *
1915
     * - encoding: unused
1916
     * - decoding: Set by user.
1917
     */
1918
    enum AVDiscard skip_loop_filter;
1919

    
1920
    /**
1921
     *
1922
     * - encoding: unused
1923
     * - decoding: Set by user.
1924
     */
1925
    enum AVDiscard skip_idct;
1926

    
1927
    /**
1928
     *
1929
     * - encoding: unused
1930
     * - decoding: Set by user.
1931
     */
1932
    enum AVDiscard skip_frame;
1933

    
1934
    /**
1935
     *
1936
     * - encoding: Set by user.
1937
     * - decoding: unused
1938
     */
1939
    int bidir_refine;
1940

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

    
1948
    /**
1949
     * constant rate factor - quality-based VBR - values ~correspond to qps
1950
     * - encoding: Set by user.
1951
     * - decoding: unused
1952
     */
1953
    float crf;
1954

    
1955
    /**
1956
     * constant quantization parameter rate control method
1957
     * - encoding: Set by user.
1958
     * - decoding: unused
1959
     */
1960
    int cqp;
1961

    
1962
    /**
1963
     * minimum GOP size
1964
     * - encoding: Set by user.
1965
     * - decoding: unused
1966
     */
1967
    int keyint_min;
1968

    
1969
    /**
1970
     * number of reference frames
1971
     * - encoding: Set by user.
1972
     * - decoding: unused
1973
     */
1974
    int refs;
1975

    
1976
    /**
1977
     * chroma qp offset from luma
1978
     * - encoding: Set by user.
1979
     * - decoding: unused
1980
     */
1981
    int chromaoffset;
1982

    
1983
    /**
1984
     * Influences how often B-frames are used.
1985
     * - encoding: Set by user.
1986
     * - decoding: unused
1987
     */
1988
    int bframebias;
1989

    
1990
    /**
1991
     * trellis RD quantization
1992
     * - encoding: Set by user.
1993
     * - decoding: unused
1994
     */
1995
    int trellis;
1996

    
1997
    /**
1998
     * Reduce fluctuations in qp (before curve compression).
1999
     * - encoding: Set by user.
2000
     * - decoding: unused
2001
     */
2002
    float complexityblur;
2003

    
2004
    /**
2005
     * in-loop deblocking filter alphac0 parameter
2006
     * alpha is in the range -6...6
2007
     * - encoding: Set by user.
2008
     * - decoding: unused
2009
     */
2010
    int deblockalpha;
2011

    
2012
    /**
2013
     * in-loop deblocking filter beta parameter
2014
     * beta is in the range -6...6
2015
     * - encoding: Set by user.
2016
     * - decoding: unused
2017
     */
2018
    int deblockbeta;
2019

    
2020
    /**
2021
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2022
     * - encoding: Set by user.
2023
     * - decoding: unused
2024
     */
2025
    int partitions;
2026
#define X264_PART_I4X4 0x001  /* Analyse i4x4 */
2027
#define X264_PART_I8X8 0x002  /* Analyse i8x8 (requires 8x8 transform) */
2028
#define X264_PART_P8X8 0x010  /* Analyse p16x8, p8x16 and p8x8 */
2029
#define X264_PART_P4X4 0x020  /* Analyse p8x4, p4x8, p4x4 */
2030
#define X264_PART_B8X8 0x100  /* Analyse b16x8, b8x16 and b8x8 */
2031

    
2032
    /**
2033
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2034
     * - encoding: Set by user.
2035
     * - decoding: unused
2036
     */
2037
    int directpred;
2038

    
2039
    /**
2040
     * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2041
     * - encoding: Set by user.
2042
     * - decoding: unused
2043
     */
2044
    int cutoff;
2045

    
2046
    /**
2047
     * Multiplied by qscale for each frame and added to scene_change_score.
2048
     * - encoding: Set by user.
2049
     * - decoding: unused
2050
     */
2051
    int scenechange_factor;
2052

    
2053
    /**
2054
     *
2055
     * Note: Value depends upon the compare function used for fullpel ME.
2056
     * - encoding: Set by user.
2057
     * - decoding: unused
2058
     */
2059
    int mv0_threshold;
2060

    
2061
    /**
2062
     * Adjusts sensitivity of b_frame_strategy 1.
2063
     * - encoding: Set by user.
2064
     * - decoding: unused
2065
     */
2066
    int b_sensitivity;
2067

    
2068
    /**
2069
     * - encoding: Set by user.
2070
     * - decoding: unused
2071
     */
2072
    int compression_level;
2073
#define FF_COMPRESSION_DEFAULT -1
2074

    
2075
    /**
2076
     * Sets whether to use LPC mode - used by FLAC encoder.
2077
     * - encoding: Set by user.
2078
     * - decoding: unused
2079
     */
2080
    int use_lpc;
2081

    
2082
    /**
2083
     * LPC coefficient precision - used by FLAC encoder
2084
     * - encoding: Set by user.
2085
     * - decoding: unused
2086
     */
2087
    int lpc_coeff_precision;
2088

    
2089
    /**
2090
     * - encoding: Set by user.
2091
     * - decoding: unused
2092
     */
2093
    int min_prediction_order;
2094

    
2095
    /**
2096
     * - encoding: Set by user.
2097
     * - decoding: unused
2098
     */
2099
    int max_prediction_order;
2100

    
2101
    /**
2102
     * search method for selecting prediction order
2103
     * - encoding: Set by user.
2104
     * - decoding: unused
2105
     */
2106
    int prediction_order_method;
2107

    
2108
    /**
2109
     * - encoding: Set by user.
2110
     * - decoding: unused
2111
     */
2112
    int min_partition_order;
2113

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

    
2120
    /**
2121
     * GOP timecode frame start number, in non drop frame format
2122
     * - encoding: Set by user.
2123
     * - decoding: unused
2124
     */
2125
    int64_t timecode_frame_start;
2126
} AVCodecContext;
2127

    
2128
/**
2129
 * AVCodec.
2130
 */
2131
typedef struct AVCodec {
2132
    /**
2133
     * Name of the codec implementation.
2134
     * The name is globally unique among encoders and among decoders (but an
2135
     * encoder and a decoder can share the same name).
2136
     * This is the primary way to find a codec from the user perspective.
2137
     */
2138
    const char *name;
2139
    enum CodecType type;
2140
    enum CodecID id;
2141
    int priv_data_size;
2142
    int (*init)(AVCodecContext *);
2143
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2144
    int (*close)(AVCodecContext *);
2145
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2146
                  uint8_t *buf, int buf_size);
2147
    int capabilities;
2148
    struct AVCodec *next;
2149
    void (*flush)(AVCodecContext *);
2150
    const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2151
    const enum PixelFormat *pix_fmts;       ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2152
} AVCodec;
2153

    
2154
/**
2155
 * four components are given, that's all.
2156
 * the last component is alpha
2157
 */
2158
typedef struct AVPicture {
2159
    uint8_t *data[4];
2160
    int linesize[4];       ///< number of bytes per line
2161
} AVPicture;
2162

    
2163
/**
2164
 * AVPaletteControl
2165
 * This structure defines a method for communicating palette changes
2166
 * between and demuxer and a decoder.
2167
 *
2168
 * @deprecated Use AVPacket to send palette changes instead.
2169
 * This is totally broken.
2170
 */
2171
#define AVPALETTE_SIZE 1024
2172
#define AVPALETTE_COUNT 256
2173
typedef struct AVPaletteControl {
2174

    
2175
    /* Demuxer sets this to 1 to indicate the palette has changed;
2176
     * decoder resets to 0. */
2177
    int palette_changed;
2178

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

    
2185
} AVPaletteControl attribute_deprecated;
2186

    
2187
typedef struct AVSubtitleRect {
2188
    uint16_t x;
2189
    uint16_t y;
2190
    uint16_t w;
2191
    uint16_t h;
2192
    uint16_t nb_colors;
2193
    int linesize;
2194
    uint32_t *rgba_palette;
2195
    uint8_t *bitmap;
2196
} AVSubtitleRect;
2197

    
2198
typedef struct AVSubtitle {
2199
    uint16_t format; /* 0 = graphics */
2200
    uint32_t start_display_time; /* relative to packet pts, in ms */
2201
    uint32_t end_display_time; /* relative to packet pts, in ms */
2202
    uint32_t num_rects;
2203
    AVSubtitleRect *rects;
2204
} AVSubtitle;
2205

    
2206

    
2207
/* resample.c */
2208

    
2209
struct ReSampleContext;
2210
struct AVResampleContext;
2211

    
2212
typedef struct ReSampleContext ReSampleContext;
2213

    
2214
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2215
                                     int output_rate, int input_rate);
2216
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2217
void audio_resample_close(ReSampleContext *s);
2218

    
2219
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2220
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2221
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2222
void av_resample_close(struct AVResampleContext *c);
2223

    
2224
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2225
/* YUV420 format is assumed ! */
2226

    
2227
/**
2228
 * @deprecated Use the software scaler (swscale) instead.
2229
 */
2230
typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2231

    
2232
/**
2233
 * @deprecated Use the software scaler (swscale) instead.
2234
 */
2235
attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2236
                                      int input_width, int input_height);
2237

    
2238
/**
2239
 * @deprecated Use the software scaler (swscale) instead.
2240
 */
2241
attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2242
                                      int iwidth, int iheight,
2243
                                      int topBand, int bottomBand,
2244
                                      int leftBand, int rightBand,
2245
                                      int padtop, int padbottom,
2246
                                      int padleft, int padright);
2247

    
2248
/**
2249
 * @deprecated Use the software scaler (swscale) instead.
2250
 */
2251
attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2252
                  AVPicture *output, const AVPicture *input);
2253

    
2254
/**
2255
 * @deprecated Use the software scaler (swscale) instead.
2256
 */
2257
attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2258

    
2259
#endif
2260

    
2261
/**
2262
 * Allocate memory for a picture.  Call avpicture_free to free it.
2263
 *
2264
 * @param picture the picture to be filled in
2265
 * @param pix_fmt the format of the picture
2266
 * @param width the width of the picture
2267
 * @param height the height of the picture
2268
 * @return zero if successful, a negative value if not
2269
 */
2270
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2271

    
2272
/**
2273
 * Free a picture previously allocated by avpicture_alloc().
2274
 *
2275
 * @param picture the AVPicture to be freed
2276
 */
2277
void avpicture_free(AVPicture *picture);
2278

    
2279
/**
2280
 * Fill in the AVPicture fields.
2281
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2282
 * which points to the image data buffer. Depending on the specified picture
2283
 * format, one or multiple image data pointers and line sizes will be set.
2284
 * If a planar format is specified, several pointers will be set pointing to
2285
 * the different picture planes and the line sizes of the different planes
2286
 * will be stored in the lines_sizes array.
2287
 *
2288
 * @param picture AVPicture whose fields are to be filled in
2289
 * @param ptr Buffer which will contain or contains the actual image data
2290
 * @param pix_fmt The format in which the picture data is stored.
2291
 * @param width the width of the image in pixels
2292
 * @param height the height of the image in pixels
2293
 * @return size of the image data in bytes
2294
 */
2295
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2296
                   int pix_fmt, int width, int height);
2297
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2298
                     unsigned char *dest, int dest_size);
2299

    
2300
/**
2301
 * Calculate the size in bytes that a picture of the given width and height
2302
 * would occupy if stored in the given picture format.
2303
 *
2304
 * @param pix_fmt the given picture format
2305
 * @param width the width of the image
2306
 * @param height the height of the image
2307
 * @return Image data size in bytes
2308
 */
2309
int avpicture_get_size(int pix_fmt, int width, int height);
2310
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2311
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2312
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2313
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2314
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2315

    
2316
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2317
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2318
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2319
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2320
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2321
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2322

    
2323
/**
2324
 * Computes what kind of losses will occur when converting from one specific
2325
 * pixel format to another.
2326
 * When converting from one pixel format to another, information loss may occur.
2327
 * For example, when converting from RGB24 to GRAY, the color information will
2328
 * be lost. Similarly, other losses occur when converting from some formats to
2329
 * other formats. These losses can involve loss of chroma, but also loss of
2330
 * resolution, loss of color depth, loss due to the color space conversion, loss
2331
 * of the alpha bits or loss due to color quantization.
2332
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2333
 * which will occur when converting from one pixel format to another.
2334
 *
2335
 * @param[in] dst_pix_fmt destination pixel format
2336
 * @param[in] src_pix_fmt source pixel format
2337
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2338
 * @return Combination of flags informing you what kind of losses will occur.
2339
 */
2340
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2341
                             int has_alpha);
2342

    
2343
/**
2344
 * Finds the best pixel format to convert to given a certain source pixel
2345
 * format.  When converting from one pixel format to another, information loss
2346
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2347
 * information will be lost. Similarly, other losses occur when converting from
2348
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2349
 * the given pixel formats should be used to suffer the least amount of loss.
2350
 * The pixel formats from which it chooses one, are determined by the
2351
 * \p pix_fmt_mask parameter.
2352
 *
2353
 * @code
2354
 * src_pix_fmt = PIX_FMT_YUV420P;
2355
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2356
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2357
 * @endcode
2358
 *
2359
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2360
 * @param[in] src_pix_fmt source pixel format
2361
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2362
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2363
 * @return The best pixel format to convert to or -1 if none was found.
2364
 */
2365
int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2366
                              int has_alpha, int *loss_ptr);
2367

    
2368

    
2369
/**
2370
 * Print in buf the string corresponding to the pixel format with
2371
 * number pix_fmt, or an header if pix_fmt is negative.
2372
 *
2373
 * @param buf[in] the buffer where to write the string
2374
 * @param buf_size[in] the size of buf
2375
 * @param pix_fmt[in] the number of the pixel format to print the corresponding info string, or
2376
 * a negative value to print the corresponding header.
2377
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2378
 */
2379
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2380

    
2381
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2382
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2383

    
2384
/**
2385
 * Tell if an image really has transparent alpha values.
2386
 * @return ored mask of FF_ALPHA_xxx constants
2387
 */
2388
int img_get_alpha_info(const AVPicture *src,
2389
                       int pix_fmt, int width, int height);
2390

    
2391
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2392
/**
2393
 * convert among pixel formats
2394
 * @deprecated Use the software scaler (swscale) instead.
2395
 */
2396
attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2397
                const AVPicture *src, int pix_fmt,
2398
                int width, int height);
2399
#endif
2400

    
2401
/* deinterlace a picture */
2402
/* deinterlace - if not supported return -1 */
2403
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2404
                          int pix_fmt, int width, int height);
2405

    
2406
/* external high level API */
2407

    
2408
extern AVCodec *first_avcodec;
2409

    
2410
/* returns LIBAVCODEC_VERSION_INT constant */
2411
unsigned avcodec_version(void);
2412
/* returns LIBAVCODEC_BUILD constant */
2413
unsigned avcodec_build(void);
2414

    
2415
/**
2416
 * Initializes libavcodec.
2417
 *
2418
 * @warning This function \e must be called before any other libavcodec
2419
 * function.
2420
 */
2421
void avcodec_init(void);
2422

    
2423
void register_avcodec(AVCodec *format);
2424

    
2425
/**
2426
 * Finds an encoder with a matching codec ID.
2427
 *
2428
 * @param id CodecID of the requested encoder
2429
 * @return An encoder if one was found, NULL otherwise.
2430
 */
2431
AVCodec *avcodec_find_encoder(enum CodecID id);
2432

    
2433
/**
2434
 * Finds an encoder with the specified name.
2435
 *
2436
 * @param name name of the requested encoder
2437
 * @return An encoder if one was found, NULL otherwise.
2438
 */
2439
AVCodec *avcodec_find_encoder_by_name(const char *name);
2440

    
2441
/**
2442
 * Finds a decoder with a matching codec ID.
2443
 *
2444
 * @param id CodecID of the requested decoder
2445
 * @return A decoder if one was found, NULL otherwise.
2446
 */
2447
AVCodec *avcodec_find_decoder(enum CodecID id);
2448

    
2449
/**
2450
 * Finds an decoder with the specified name.
2451
 *
2452
 * @param name name of the requested decoder
2453
 * @return A decoder if one was found, NULL otherwise.
2454
 */
2455
AVCodec *avcodec_find_decoder_by_name(const char *name);
2456
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2457

    
2458
/**
2459
 * Sets the fields of the given AVCodecContext to default values.
2460
 *
2461
 * @param s The AVCodecContext of which the fields should be set to default values.
2462
 */
2463
void avcodec_get_context_defaults(AVCodecContext *s);
2464

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

    
2469
/**
2470
 * Allocates an AVCodecContext and sets its fields to default values.  The
2471
 * resulting struct can be deallocated by simply calling av_free().
2472
 *
2473
 * @return An AVCodecContext filled with default values or NULL on failure.
2474
 * @see avcodec_get_context_defaults
2475
 */
2476
AVCodecContext *avcodec_alloc_context(void);
2477

    
2478
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2479
 *  we WILL change its arguments and name a few times! */
2480
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2481

    
2482
/**
2483
 * Sets the fields of the given AVFrame to default values.
2484
 *
2485
 * @param pic The AVFrame of which the fields should be set to default values.
2486
 */
2487
void avcodec_get_frame_defaults(AVFrame *pic);
2488

    
2489
/**
2490
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2491
 * struct can be deallocated by simply calling av_free().
2492
 *
2493
 * @return An AVFrame filled with default values or NULL on failure.
2494
 * @see avcodec_get_frame_defaults
2495
 */
2496
AVFrame *avcodec_alloc_frame(void);
2497

    
2498
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2499
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2500
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2501
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2502

    
2503
/**
2504
 * Checks if the given dimension of a picture is valid, meaning that all
2505
 * bytes of the picture can be addressed with a signed int.
2506
 *
2507
 * @param[in] w Width of the picture.
2508
 * @param[in] h Height of the picture.
2509
 * @return Zero if valid, a negative value if invalid.
2510
 */
2511
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2512
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2513

    
2514
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2515
void avcodec_thread_free(AVCodecContext *s);
2516
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2517
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2518
//FIXME func typedef
2519

    
2520
/**
2521
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2522
 * function the context has to be allocated.
2523
 *
2524
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2525
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2526
 * retrieving a codec.
2527
 *
2528
 * @warning This function is not thread safe!
2529
 *
2530
 * @code
2531
 * avcodec_register_all();
2532
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2533
 * if (!codec)
2534
 *     exit(1);
2535
 *
2536
 * context = avcodec_alloc_context();
2537
 *
2538
 * if (avcodec_open(context, codec) < 0)
2539
 *     exit(1);
2540
 * @endcode
2541
 *
2542
 * @param avctx The context which will be set up to use the given codec.
2543
 * @param codec The codec to use within the context.
2544
 * @return zero on success, a negative value on error
2545
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2546
 */
2547
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2548

    
2549
/**
2550
 * @deprecated Use avcodec_decode_audio2() instead.
2551
 */
2552
attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2553
                         int *frame_size_ptr,
2554
                         uint8_t *buf, int buf_size);
2555

    
2556
/**
2557
 * Decodes an audio frame from \p buf into \p samples.
2558
 * The avcodec_decode_audio2() function decodes an audio frame from the input
2559
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2560
 * audio codec which was coupled with \p avctx using avcodec_open(). The
2561
 * resulting decoded frame is stored in output buffer \p samples.  If no frame
2562
 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2563
 * decompressed frame size in \e bytes.
2564
 *
2565
 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2566
 * output buffer before calling avcodec_decode_audio2().
2567
 *
2568
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2569
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2570
 * bits at once and could read over the end.
2571
 *
2572
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2573
 * no overreading happens for damaged MPEG streams.
2574
 *
2575
 * @note You might have to align the input buffer \p buf and output buffer \p
2576
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2577
 * necessary at all, on others it won't work at all if not aligned and on others
2578
 * it will work but it will have an impact on performance. In practice, the
2579
 * bitstream should have 4 byte alignment at minimum and all sample data should
2580
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2581
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2582
 * start of the buffer to 16.
2583
 *
2584
 * @param avctx the codec context
2585
 * @param[out] samples the output buffer
2586
 * @param[in,out] frame_size_ptr the output buffer size in bytes
2587
 * @param[in] buf the input buffer
2588
 * @param[in] buf_size the input buffer size in bytes
2589
 * @return On error a negative value is returned, otherwise the number of bytes
2590
 * used or zero if no frame could be decompressed.
2591
 */
2592
int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2593
                         int *frame_size_ptr,
2594
                         uint8_t *buf, int buf_size);
2595

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

    
2631
/* Decode a subtitle message. Return -1 if error, otherwise return the
2632
 * number of bytes used. If no subtitle could be decompressed,
2633
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2634
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2635
                            int *got_sub_ptr,
2636
                            const uint8_t *buf, int buf_size);
2637
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2638
                        int *data_size_ptr,
2639
                        uint8_t *buf, int buf_size);
2640

    
2641
/**
2642
 * Encodes an audio frame from \p samples into \p buf.
2643
 * The avcodec_encode_audio() function encodes an audio frame from the input
2644
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2645
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2646
 * stored in output buffer \p buf.
2647
 *
2648
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2649
 *
2650
 * @param avctx the codec context
2651
 * @param[out] buf the output buffer
2652
 * @param[in] buf_size the output buffer size
2653
 * @param[in] samples the input buffer containing the samples
2654
 * @return On error a negative value is returned, on succes zero or the number
2655
 * of bytes used from the input buffer.
2656
 */
2657
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2658
                         const short *samples);
2659

    
2660
/**
2661
 * Encodes a video frame from \p pict into \p buf.
2662
 * The avcodec_encode_video() function encodes a video frame from the input
2663
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2664
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2665
 * frame are stored in the output buffer \p buf. The input picture should be
2666
 * stored using a specific format, namely \c avctx.pix_fmt.
2667
 *
2668
 * @param avctx the codec context
2669
 * @param[out] buf the output buffer for the bitstream of encoded frame
2670
 * @param[in] buf_size the size of the output buffer in bytes
2671
 * @param[in] pict the input picture to encode
2672
 * @return On error a negative value is returned, on success zero or the number
2673
 * of bytes used from the input buffer.
2674
 */
2675
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2676
                         const AVFrame *pict);
2677
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2678
                            const AVSubtitle *sub);
2679

    
2680
int avcodec_close(AVCodecContext *avctx);
2681

    
2682
void avcodec_register_all(void);
2683

    
2684
/**
2685
 * Flush buffers, should be called when seeking or when switching to a different stream.
2686
 */
2687
void avcodec_flush_buffers(AVCodecContext *avctx);
2688

    
2689
void avcodec_default_free_buffers(AVCodecContext *s);
2690

    
2691
/* misc useful functions */
2692

    
2693
/**
2694
 * Returns a single letter to describe the given picture type \p pict_type.
2695
 *
2696
 * @param[in] pict_type the picture type
2697
 * @return A single character representing the picture type.
2698
 */
2699
char av_get_pict_type_char(int pict_type);
2700

    
2701
/**
2702
 * Returns codec bits per sample.
2703
 *
2704
 * @param[in] codec_id the codec
2705
 * @return Number of bits per sample or zero if unknown for the given codec.
2706
 */
2707
int av_get_bits_per_sample(enum CodecID codec_id);
2708

    
2709
/**
2710
 * Returns sample format bits per sample.
2711
 *
2712
 * @param[in] sample_fmt the sample format
2713
 * @return Number of bits per sample or zero if unknown for the given sample format.
2714
 */
2715
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2716

    
2717
/* frame parsing */
2718
typedef struct AVCodecParserContext {
2719
    void *priv_data;
2720
    struct AVCodecParser *parser;
2721
    int64_t frame_offset; /* offset of the current frame */
2722
    int64_t cur_offset; /* current offset
2723
                           (incremented by each av_parser_parse()) */
2724
    int64_t last_frame_offset; /* offset of the last frame */
2725
    /* video info */
2726
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2727
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2728
    int64_t pts;     /* pts of the current frame */
2729
    int64_t dts;     /* dts of the current frame */
2730

    
2731
    /* private data */
2732
    int64_t last_pts;
2733
    int64_t last_dts;
2734
    int fetch_timestamp;
2735

    
2736
#define AV_PARSER_PTS_NB 4
2737
    int cur_frame_start_index;
2738
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2739
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2740
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2741

    
2742
    int flags;
2743
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2744

    
2745
    int64_t offset;      ///< byte offset from starting packet start
2746
    int64_t last_offset;
2747
} AVCodecParserContext;
2748

    
2749
typedef struct AVCodecParser {
2750
    int codec_ids[5]; /* several codec IDs are permitted */
2751
    int priv_data_size;
2752
    int (*parser_init)(AVCodecParserContext *s);
2753
    int (*parser_parse)(AVCodecParserContext *s,
2754
                        AVCodecContext *avctx,
2755
                        const uint8_t **poutbuf, int *poutbuf_size,
2756
                        const uint8_t *buf, int buf_size);
2757
    void (*parser_close)(AVCodecParserContext *s);
2758
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2759
    struct AVCodecParser *next;
2760
} AVCodecParser;
2761

    
2762
extern AVCodecParser *av_first_parser;
2763

    
2764
void av_register_codec_parser(AVCodecParser *parser);
2765
AVCodecParserContext *av_parser_init(int codec_id);
2766
int av_parser_parse(AVCodecParserContext *s,
2767
                    AVCodecContext *avctx,
2768
                    uint8_t **poutbuf, int *poutbuf_size,
2769
                    const uint8_t *buf, int buf_size,
2770
                    int64_t pts, int64_t dts);
2771
int av_parser_change(AVCodecParserContext *s,
2772
                     AVCodecContext *avctx,
2773
                     uint8_t **poutbuf, int *poutbuf_size,
2774
                     const uint8_t *buf, int buf_size, int keyframe);
2775
void av_parser_close(AVCodecParserContext *s);
2776

    
2777

    
2778
typedef struct AVBitStreamFilterContext {
2779
    void *priv_data;
2780
    struct AVBitStreamFilter *filter;
2781
    AVCodecParserContext *parser;
2782
    struct AVBitStreamFilterContext *next;
2783
} AVBitStreamFilterContext;
2784

    
2785

    
2786
typedef struct AVBitStreamFilter {
2787
    const char *name;
2788
    int priv_data_size;
2789
    int (*filter)(AVBitStreamFilterContext *bsfc,
2790
                  AVCodecContext *avctx, const char *args,
2791
                  uint8_t **poutbuf, int *poutbuf_size,
2792
                  const uint8_t *buf, int buf_size, int keyframe);
2793
    struct AVBitStreamFilter *next;
2794
} AVBitStreamFilter;
2795

    
2796
extern AVBitStreamFilter *av_first_bitstream_filter;
2797

    
2798
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2799
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2800
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2801
                               AVCodecContext *avctx, const char *args,
2802
                               uint8_t **poutbuf, int *poutbuf_size,
2803
                               const uint8_t *buf, int buf_size, int keyframe);
2804
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2805

    
2806

    
2807
/* memory */
2808

    
2809
/**
2810
 * Reallocates the given block if it is not large enough, otherwise it
2811
 * does nothing.
2812
 *
2813
 * @see av_realloc
2814
 */
2815
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2816

    
2817
/* for static data only */
2818

    
2819
/**
2820
 * Frees all static arrays and resets their pointers to 0.
2821
 * Call this function to release all statically allocated tables.
2822
 *
2823
 * @deprecated. Code which uses av_free_static is broken/misdesigned
2824
 * and should correctly use static arrays
2825
 *
2826
 */
2827
attribute_deprecated void av_free_static(void);
2828

    
2829
/**
2830
 * Allocation of static arrays.
2831
 *
2832
 * @warning Do not use for normal allocation.
2833
 *
2834
 * @param[in] size The amount of memory you need in bytes.
2835
 * @return block of memory of the requested size
2836
 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2837
 * and should correctly use static arrays
2838
 */
2839
attribute_deprecated void *av_mallocz_static(unsigned int size);
2840

    
2841
/**
2842
 * Copy image 'src' to 'dst'.
2843
 */
2844
void av_picture_copy(AVPicture *dst, const AVPicture *src,
2845
              int pix_fmt, int width, int height);
2846

    
2847
/**
2848
 * Crop image top and left side.
2849
 */
2850
int av_picture_crop(AVPicture *dst, const AVPicture *src,
2851
             int pix_fmt, int top_band, int left_band);
2852

    
2853
/**
2854
 * Pad image.
2855
 */
2856
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2857
            int padtop, int padbottom, int padleft, int padright, int *color);
2858

    
2859
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2860
/**
2861
 * @deprecated Use the software scaler (swscale) instead.
2862
 */
2863
attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2864
              int pix_fmt, int width, int height);
2865

    
2866
/**
2867
 * @deprecated Use the software scaler (swscale) instead.
2868
 */
2869
attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2870
             int pix_fmt, int top_band, int left_band);
2871

    
2872
/**
2873
 * @deprecated Use the software scaler (swscale) instead.
2874
 */
2875
attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2876
            int padtop, int padbottom, int padleft, int padright, int *color);
2877
#endif
2878

    
2879
extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2880

    
2881
/**
2882
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2883
 *
2884
 * @return 0 in case of a successful parsing, a negative value otherwise
2885
 * @param[in] str the string to parse: it has to be a string in the format
2886
 * <width>x<height> or a valid video frame size abbreviation.
2887
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2888
 * frame width value
2889
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2890
 * frame height value
2891
 */
2892
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2893

    
2894
/**
2895
 * Parses \p str and put in \p frame_rate the detected values.
2896
 *
2897
 * @return 0 in case of a successful parsing, a negative value otherwise
2898
 * @param[in] str the string to parse: it has to be a string in the format
2899
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2900
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2901
 * frame rate
2902
 */
2903
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2904

    
2905
/* error handling */
2906
#if EINVAL > 0
2907
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2908
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2909
#else
2910
/* Some platforms have E* and errno already negated. */
2911
#define AVERROR(e) (e)
2912
#define AVUNERROR(e) (e)
2913
#endif
2914
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
2915
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
2916
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
2917
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
2918
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
2919
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
2920
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
2921
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
2922
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2923

    
2924
#endif /* AVCODEC_H */