Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ c60208e7

History | View | Annotate | Download (96.2 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_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

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

    
29
#include <errno.h>
30
#include "libavutil/avutil.h"
31

    
32
#define LIBAVCODEC_VERSION_MAJOR 52
33
#define LIBAVCODEC_VERSION_MINOR 11
34
#define LIBAVCODEC_VERSION_MICRO  0
35

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

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

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

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

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

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

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

    
250
    /* AMR */
251
    CODEC_ID_AMR_NB= 0x12000,
252
    CODEC_ID_AMR_WB,
253

    
254
    /* RealAudio codecs*/
255
    CODEC_ID_RA_144= 0x13000,
256
    CODEC_ID_RA_288,
257

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

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

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

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

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

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

    
329
enum CodecType {
330
    CODEC_TYPE_UNKNOWN = -1,
331
    CODEC_TYPE_VIDEO,
332
    CODEC_TYPE_AUDIO,
333
    CODEC_TYPE_DATA,
334
    CODEC_TYPE_SUBTITLE,
335
    CODEC_TYPE_ATTACHMENT,
336
    CODEC_TYPE_NB
337
};
338

    
339
/**
340
 * all in native-endian format
341
 */
342
enum SampleFormat {
343
    SAMPLE_FMT_NONE = -1,
344
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
345
    SAMPLE_FMT_S16,             ///< signed 16 bits
346
    SAMPLE_FMT_S32,             ///< signed 32 bits
347
    SAMPLE_FMT_FLT,             ///< float
348
    SAMPLE_FMT_DBL,             ///< double
349
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
350
};
351

    
352
/* Audio channel masks */
353
#define CH_FRONT_LEFT             0x00000001
354
#define CH_FRONT_RIGHT            0x00000002
355
#define CH_FRONT_CENTER           0x00000004
356
#define CH_LOW_FREQUENCY          0x00000008
357
#define CH_BACK_LEFT              0x00000010
358
#define CH_BACK_RIGHT             0x00000020
359
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
360
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
361
#define CH_BACK_CENTER            0x00000100
362
#define CH_SIDE_LEFT              0x00000200
363
#define CH_SIDE_RIGHT             0x00000400
364
#define CH_TOP_CENTER             0x00000800
365
#define CH_TOP_FRONT_LEFT         0x00001000
366
#define CH_TOP_FRONT_CENTER       0x00002000
367
#define CH_TOP_FRONT_RIGHT        0x00004000
368
#define CH_TOP_BACK_LEFT          0x00008000
369
#define CH_TOP_BACK_CENTER        0x00010000
370
#define CH_TOP_BACK_RIGHT         0x00020000
371
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
372
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
373

    
374
/* Audio channel convenience macros */
375
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
376
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
377
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
378
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
379
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
380
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
381
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
382
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
383
                                          CH_BACK_LEFT|CH_BACK_RIGHT|\
384
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
385
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
386

    
387
/* in bytes */
388
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
389

    
390
/**
391
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
392
 * This is mainly needed because some optimized bitstream readers read
393
 * 32 or 64 bit at once and could read over the end.<br>
394
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
395
 * MPEG bitstreams could cause overread and segfault.
396
 */
397
#define FF_INPUT_BUFFER_PADDING_SIZE 8
398

    
399
/**
400
 * minimum encoding buffer size
401
 * Used to avoid some checks during header writing.
402
 */
403
#define FF_MIN_BUFFER_SIZE 16384
404

    
405

    
406
/**
407
 * motion estimation type.
408
 */
409
enum Motion_Est_ID {
410
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
411
    ME_FULL,
412
    ME_LOG,
413
    ME_PHODS,
414
    ME_EPZS,        ///< enhanced predictive zonal search
415
    ME_X1,          ///< reserved for experiments
416
    ME_HEX,         ///< hexagon based search
417
    ME_UMH,         ///< uneven multi-hexagon search
418
    ME_ITER,        ///< iterative search
419
    ME_TESA,        ///< transformed exhaustive search algorithm
420
};
421

    
422
enum AVDiscard{
423
    /* We leave some space between them for extensions (drop some
424
     * keyframes for intra-only or drop just some bidir frames). */
425
    AVDISCARD_NONE   =-16, ///< discard nothing
426
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
427
    AVDISCARD_NONREF =  8, ///< discard all non reference
428
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
429
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
430
    AVDISCARD_ALL    = 48, ///< discard all
431
};
432

    
433
typedef struct RcOverride{
434
    int start_frame;
435
    int end_frame;
436
    int qscale; // If this is 0 then quality_factor will be used instead.
437
    float quality_factor;
438
} RcOverride;
439

    
440
#define FF_MAX_B_FRAMES 16
441

    
442
/* encoding support
443
   These flags can be passed in AVCodecContext.flags before initialization.
444
   Note: Not everything is supported yet.
445
*/
446

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

    
504
/* Unsupported options :
505
 *              Syntax Arithmetic coding (SAC)
506
 *              Reference Picture Selection
507
 *              Independent Segment Decoding */
508
/* /Fx */
509
/* codec capabilities */
510

    
511
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
512
/**
513
 * Codec uses get_buffer() for allocating buffers.
514
 * direct rendering method 1
515
 */
516
#define CODEC_CAP_DR1             0x0002
517
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
518
#define CODEC_CAP_PARSE_ONLY      0x0004
519
#define CODEC_CAP_TRUNCATED       0x0008
520
/* Codec can export data for HW decoding (XvMC). */
521
#define CODEC_CAP_HWACCEL         0x0010
522
/**
523
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
524
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
525
 */
526
#define CODEC_CAP_DELAY           0x0020
527
/**
528
 * Codec can be fed a final frame with a smaller size.
529
 * This can be used to prevent truncation of the last audio samples.
530
 */
531
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
532
/**
533
 * Codec can export data for HW decoding (VDPAU).
534
 */
535
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
536

    
537
//The following defines may change, don't expect compatibility if you use them.
538
#define MB_TYPE_INTRA4x4   0x0001
539
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
540
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
541
#define MB_TYPE_16x16      0x0008
542
#define MB_TYPE_16x8       0x0010
543
#define MB_TYPE_8x16       0x0020
544
#define MB_TYPE_8x8        0x0040
545
#define MB_TYPE_INTERLACED 0x0080
546
#define MB_TYPE_DIRECT2    0x0100 //FIXME
547
#define MB_TYPE_ACPRED     0x0200
548
#define MB_TYPE_GMC        0x0400
549
#define MB_TYPE_SKIP       0x0800
550
#define MB_TYPE_P0L0       0x1000
551
#define MB_TYPE_P1L0       0x2000
552
#define MB_TYPE_P0L1       0x4000
553
#define MB_TYPE_P1L1       0x8000
554
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
555
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
556
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
557
#define MB_TYPE_QUANT      0x00010000
558
#define MB_TYPE_CBP        0x00020000
559
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
560

    
561
/**
562
 * Pan Scan area.
563
 * This specifies the area which should be displayed.
564
 * Note there may be multiple such areas for one frame.
565
 */
566
typedef struct AVPanScan{
567
    /**
568
     * id
569
     * - encoding: Set by user.
570
     * - decoding: Set by libavcodec.
571
     */
572
    int id;
573

    
574
    /**
575
     * width and height in 1/16 pel
576
     * - encoding: Set by user.
577
     * - decoding: Set by libavcodec.
578
     */
579
    int width;
580
    int height;
581

    
582
    /**
583
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
584
     * - encoding: Set by user.
585
     * - decoding: Set by libavcodec.
586
     */
587
    int16_t position[3][2];
588
}AVPanScan;
589

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

    
808

    
809
#define FF_QSCALE_TYPE_MPEG1 0
810
#define FF_QSCALE_TYPE_MPEG2 1
811
#define FF_QSCALE_TYPE_H264  2
812

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

    
818

    
819
#define FF_I_TYPE  1 ///< Intra
820
#define FF_P_TYPE  2 ///< Predicted
821
#define FF_B_TYPE  3 ///< Bi-dir predicted
822
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
823
#define FF_SI_TYPE 5 ///< Switching Intra
824
#define FF_SP_TYPE 6 ///< Switching Predicted
825
#define FF_BI_TYPE 7
826

    
827
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
828
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
829
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
830
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
831

    
832
/**
833
 * Audio Video Frame.
834
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
835
 * bumps.
836
 * Removal, reordering and changes to existing fields require a major
837
 * version bump. No fields should be added into AVFrame before or after
838
 * FF_COMMON_FRAME!
839
 * sizeof(AVFrame) must not be used outside libav*.
840
 */
841
typedef struct AVFrame {
842
    FF_COMMON_FRAME
843
} AVFrame;
844

    
845
/**
846
 * main external API structure.
847
 * New fields can be added to the end with minor version bumps.
848
 * Removal, reordering and changes to existing fields require a major
849
 * version bump.
850
 * sizeof(AVCodecContext) must not be used outside libav*.
851
 */
852
typedef struct AVCodecContext {
853
    /**
854
     * information on struct for av_log
855
     * - set by avcodec_alloc_context
856
     */
857
    const AVClass *av_class;
858
    /**
859
     * the average bitrate
860
     * - encoding: Set by user; unused for constant quantizer encoding.
861
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
862
     */
863
    int bit_rate;
864

    
865
    /**
866
     * number of bits the bitstream is allowed to diverge from the reference.
867
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
868
     * - encoding: Set by user; unused for constant quantizer encoding.
869
     * - decoding: unused
870
     */
871
    int bit_rate_tolerance;
872

    
873
    /**
874
     * CODEC_FLAG_*.
875
     * - encoding: Set by user.
876
     * - decoding: Set by user.
877
     */
878
    int flags;
879

    
880
    /**
881
     * Some codecs need additional format info. It is stored here.
882
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
883
     * specific codec MUST set it correctly otherwise stream copy breaks.
884
     * In general use of this field by muxers is not recommanded.
885
     * - encoding: Set by libavcodec.
886
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
887
     */
888
    int sub_id;
889

    
890
    /**
891
     * Motion estimation algorithm used for video coding.
892
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
893
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
894
     * - encoding: MUST be set by user.
895
     * - decoding: unused
896
     */
897
    int me_method;
898

    
899
    /**
900
     * some codecs need / can use extradata like Huffman tables.
901
     * mjpeg: Huffman tables
902
     * rv10: additional flags
903
     * mpeg4: global headers (they can be in the bitstream or here)
904
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
905
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
906
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
907
     * - encoding: Set/allocated/freed by libavcodec.
908
     * - decoding: Set/allocated/freed by user.
909
     */
910
    uint8_t *extradata;
911
    int extradata_size;
912

    
913
    /**
914
     * This is the fundamental unit of time (in seconds) in terms
915
     * of which frame timestamps are represented. For fixed-fps content,
916
     * timebase should be 1/framerate and timestamp increments should be
917
     * identically 1.
918
     * - encoding: MUST be set by user.
919
     * - decoding: Set by libavcodec.
920
     */
921
    AVRational time_base;
922

    
923
    /* video only */
924
    /**
925
     * picture width / height.
926
     * - encoding: MUST be set by user.
927
     * - decoding: Set by libavcodec.
928
     * Note: For compatibility it is possible to set this instead of
929
     * coded_width/height before decoding.
930
     */
931
    int width, height;
932

    
933
#define FF_ASPECT_EXTENDED 15
934

    
935
    /**
936
     * the number of pictures in a group of pictures, or 0 for intra_only
937
     * - encoding: Set by user.
938
     * - decoding: unused
939
     */
940
    int gop_size;
941

    
942
    /**
943
     * Pixel format, see PIX_FMT_xxx.
944
     * - encoding: Set by user.
945
     * - decoding: Set by libavcodec.
946
     */
947
    enum PixelFormat pix_fmt;
948

    
949
    /**
950
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
951
     * has to read frames at native frame rate.
952
     * - encoding: Set by user.
953
     * - decoding: unused
954
     */
955
    int rate_emu;
956

    
957
    /**
958
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
959
     * decoder to draw a horizontal band. It improves cache usage. Not
960
     * all codecs can do that. You must check the codec capabilities
961
     * beforehand.
962
     * - encoding: unused
963
     * - decoding: Set by user.
964
     * @param height the height of the slice
965
     * @param y the y position of the slice
966
     * @param type 1->top field, 2->bottom field, 3->frame
967
     * @param offset offset into the AVFrame.data from which the slice should be read
968
     */
969
    void (*draw_horiz_band)(struct AVCodecContext *s,
970
                            const AVFrame *src, int offset[4],
971
                            int y, int type, int height);
972

    
973
    /* audio only */
974
    int sample_rate; ///< samples per second
975
    int channels;    ///< number of audio channels
976

    
977
    /**
978
     * audio sample format
979
     * - encoding: Set by user.
980
     * - decoding: Set by libavcodec.
981
     */
982
    enum SampleFormat sample_fmt;  ///< sample format, currently unused
983

    
984
    /* The following data should not be initialized. */
985
    /**
986
     * Samples per packet, initialized when calling 'init'.
987
     */
988
    int frame_size;
989
    int frame_number;   ///< audio or video frame number
990
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
991

    
992
    /**
993
     * Number of frames the decoded output will be delayed relative to
994
     * the encoded input.
995
     * - encoding: Set by libavcodec.
996
     * - decoding: unused
997
     */
998
    int delay;
999

    
1000
    /* - encoding parameters */
1001
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1002
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1003

    
1004
    /**
1005
     * minimum quantizer
1006
     * - encoding: Set by user.
1007
     * - decoding: unused
1008
     */
1009
    int qmin;
1010

    
1011
    /**
1012
     * maximum quantizer
1013
     * - encoding: Set by user.
1014
     * - decoding: unused
1015
     */
1016
    int qmax;
1017

    
1018
    /**
1019
     * maximum quantizer difference between frames
1020
     * - encoding: Set by user.
1021
     * - decoding: unused
1022
     */
1023
    int max_qdiff;
1024

    
1025
    /**
1026
     * maximum number of B-frames between non-B-frames
1027
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1028
     * - encoding: Set by user.
1029
     * - decoding: unused
1030
     */
1031
    int max_b_frames;
1032

    
1033
    /**
1034
     * qscale factor between IP and B-frames
1035
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1036
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1037
     * - encoding: Set by user.
1038
     * - decoding: unused
1039
     */
1040
    float b_quant_factor;
1041

    
1042
    /** obsolete FIXME remove */
1043
    int rc_strategy;
1044
#define FF_RC_STRATEGY_XVID 1
1045

    
1046
    int b_frame_strategy;
1047

    
1048
    /**
1049
     * hurry up amount
1050
     * - encoding: unused
1051
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1052
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1053
     */
1054
    int hurry_up;
1055

    
1056
    struct AVCodec *codec;
1057

    
1058
    void *priv_data;
1059

    
1060
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1061
                            /* do its best to deliver a chunk with size     */
1062
                            /* below rtp_payload_size, the chunk will start */
1063
                            /* with a start code on some codecs like H.263. */
1064
                            /* This doesn't take account of any particular  */
1065
                            /* headers inside the transmitted RTP payload.  */
1066

    
1067

    
1068
    /* The RTP callback: This function is called    */
1069
    /* every time the encoder has a packet to send. */
1070
    /* It depends on the encoder if the data starts */
1071
    /* with a Start Code (it should). H.263 does.   */
1072
    /* mb_nb contains the number of macroblocks     */
1073
    /* encoded in the RTP payload.                  */
1074
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1075

    
1076
    /* statistics, used for 2-pass encoding */
1077
    int mv_bits;
1078
    int header_bits;
1079
    int i_tex_bits;
1080
    int p_tex_bits;
1081
    int i_count;
1082
    int p_count;
1083
    int skip_count;
1084
    int misc_bits;
1085

    
1086
    /**
1087
     * number of bits used for the previously encoded frame
1088
     * - encoding: Set by libavcodec.
1089
     * - decoding: unused
1090
     */
1091
    int frame_bits;
1092

    
1093
    /**
1094
     * Private data of the user, can be used to carry app specific stuff.
1095
     * - encoding: Set by user.
1096
     * - decoding: Set by user.
1097
     */
1098
    void *opaque;
1099

    
1100
    char codec_name[32];
1101
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1102
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1103

    
1104
    /**
1105
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1106
     * This is used to work around some encoder bugs.
1107
     * A demuxer should set this to what is stored in the field used to identify the codec.
1108
     * If there are multiple such fields in a container then the demuxer should choose the one
1109
     * which maximizes the information about the used codec.
1110
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1111
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1112
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1113
     * first.
1114
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1115
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1116
     */
1117
    unsigned int codec_tag;
1118

    
1119
    /**
1120
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1121
     * - encoding: Set by user
1122
     * - decoding: Set by user
1123
     */
1124
    int workaround_bugs;
1125
#define FF_BUG_AUTODETECT       1  ///< autodetection
1126
#define FF_BUG_OLD_MSMPEG4      2
1127
#define FF_BUG_XVID_ILACE       4
1128
#define FF_BUG_UMP4             8
1129
#define FF_BUG_NO_PADDING       16
1130
#define FF_BUG_AMV              32
1131
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1132
#define FF_BUG_QPEL_CHROMA      64
1133
#define FF_BUG_STD_QPEL         128
1134
#define FF_BUG_QPEL_CHROMA2     256
1135
#define FF_BUG_DIRECT_BLOCKSIZE 512
1136
#define FF_BUG_EDGE             1024
1137
#define FF_BUG_HPEL_CHROMA      2048
1138
#define FF_BUG_DC_CLIP          4096
1139
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1140
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1141

    
1142
    /**
1143
     * luma single coefficient elimination threshold
1144
     * - encoding: Set by user.
1145
     * - decoding: unused
1146
     */
1147
    int luma_elim_threshold;
1148

    
1149
    /**
1150
     * chroma single coeff elimination threshold
1151
     * - encoding: Set by user.
1152
     * - decoding: unused
1153
     */
1154
    int chroma_elim_threshold;
1155

    
1156
    /**
1157
     * strictly follow the standard (MPEG4, ...).
1158
     * - encoding: Set by user.
1159
     * - decoding: Set by user.
1160
     * Setting this to STRICT or higher means the encoder and decoder will
1161
     * generally do stupid things. While setting it to inofficial or lower
1162
     * will mean the encoder might use things that are not supported by all
1163
     * spec compliant decoders. Decoders make no difference between normal,
1164
     * inofficial and experimental, that is they always try to decode things
1165
     * when they can unless they are explicitly asked to behave stupid
1166
     * (=strictly conform to the specs)
1167
     */
1168
    int strict_std_compliance;
1169
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1170
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1171
#define FF_COMPLIANCE_NORMAL        0
1172
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1173
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1174

    
1175
    /**
1176
     * qscale offset between IP and B-frames
1177
     * - encoding: Set by user.
1178
     * - decoding: unused
1179
     */
1180
    float b_quant_offset;
1181

    
1182
    /**
1183
     * Error recognization; higher values will detect more errors but may
1184
     * misdetect some more or less valid parts as errors.
1185
     * - encoding: unused
1186
     * - decoding: Set by user.
1187
     */
1188
    int error_recognition;
1189
#define FF_ER_CAREFUL         1
1190
#define FF_ER_COMPLIANT       2
1191
#define FF_ER_AGGRESSIVE      3
1192
#define FF_ER_VERY_AGGRESSIVE 4
1193

    
1194
    /**
1195
     * Called at the beginning of each frame to get a buffer for it.
1196
     * If pic.reference is set then the frame will be read later by libavcodec.
1197
     * avcodec_align_dimensions() should be used to find the required width and
1198
     * height, as they normally need to be rounded up to the next multiple of 16.
1199
     * - encoding: unused
1200
     * - decoding: Set by libavcodec., user can override.
1201
     */
1202
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1203

    
1204
    /**
1205
     * Called to release buffers which were allocated with get_buffer.
1206
     * A released buffer can be reused in get_buffer().
1207
     * pic.data[*] must be set to NULL.
1208
     * - encoding: unused
1209
     * - decoding: Set by libavcodec., user can override.
1210
     */
1211
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1212

    
1213
    /**
1214
     * If 1 the stream has a 1 frame delay during decoding.
1215
     * - encoding: Set by libavcodec.
1216
     * - decoding: Set by libavcodec.
1217
     */
1218
    int has_b_frames;
1219

    
1220
    /**
1221
     * number of bytes per packet if constant and known or 0
1222
     * Used by some WAV based audio codecs.
1223
     */
1224
    int block_align;
1225

    
1226
    int parse_only; /* - decoding only: If true, only parsing is done
1227
                       (function avcodec_parse_frame()). The frame
1228
                       data is returned. Only MPEG codecs support this now. */
1229

    
1230
    /**
1231
     * 0-> h263 quant 1-> mpeg quant
1232
     * - encoding: Set by user.
1233
     * - decoding: unused
1234
     */
1235
    int mpeg_quant;
1236

    
1237
    /**
1238
     * pass1 encoding statistics output buffer
1239
     * - encoding: Set by libavcodec.
1240
     * - decoding: unused
1241
     */
1242
    char *stats_out;
1243

    
1244
    /**
1245
     * pass2 encoding statistics input buffer
1246
     * Concatenated stuff from stats_out of pass1 should be placed here.
1247
     * - encoding: Allocated/set/freed by user.
1248
     * - decoding: unused
1249
     */
1250
    char *stats_in;
1251

    
1252
    /**
1253
     * ratecontrol qmin qmax limiting method
1254
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1255
     * - encoding: Set by user.
1256
     * - decoding: unused
1257
     */
1258
    float rc_qsquish;
1259

    
1260
    float rc_qmod_amp;
1261
    int rc_qmod_freq;
1262

    
1263
    /**
1264
     * ratecontrol override, see RcOverride
1265
     * - encoding: Allocated/set/freed by user.
1266
     * - decoding: unused
1267
     */
1268
    RcOverride *rc_override;
1269
    int rc_override_count;
1270

    
1271
    /**
1272
     * rate control equation
1273
     * - encoding: Set by user
1274
     * - decoding: unused
1275
     */
1276
    const char *rc_eq;
1277

    
1278
    /**
1279
     * maximum bitrate
1280
     * - encoding: Set by user.
1281
     * - decoding: unused
1282
     */
1283
    int rc_max_rate;
1284

    
1285
    /**
1286
     * minimum bitrate
1287
     * - encoding: Set by user.
1288
     * - decoding: unused
1289
     */
1290
    int rc_min_rate;
1291

    
1292
    /**
1293
     * decoder bitstream buffer size
1294
     * - encoding: Set by user.
1295
     * - decoding: unused
1296
     */
1297
    int rc_buffer_size;
1298
    float rc_buffer_aggressivity;
1299

    
1300
    /**
1301
     * qscale factor between P and I-frames
1302
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1303
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1304
     * - encoding: Set by user.
1305
     * - decoding: unused
1306
     */
1307
    float i_quant_factor;
1308

    
1309
    /**
1310
     * qscale offset between P and I-frames
1311
     * - encoding: Set by user.
1312
     * - decoding: unused
1313
     */
1314
    float i_quant_offset;
1315

    
1316
    /**
1317
     * initial complexity for pass1 ratecontrol
1318
     * - encoding: Set by user.
1319
     * - decoding: unused
1320
     */
1321
    float rc_initial_cplx;
1322

    
1323
    /**
1324
     * DCT algorithm, see FF_DCT_* below
1325
     * - encoding: Set by user.
1326
     * - decoding: unused
1327
     */
1328
    int dct_algo;
1329
#define FF_DCT_AUTO    0
1330
#define FF_DCT_FASTINT 1
1331
#define FF_DCT_INT     2
1332
#define FF_DCT_MMX     3
1333
#define FF_DCT_MLIB    4
1334
#define FF_DCT_ALTIVEC 5
1335
#define FF_DCT_FAAN    6
1336

    
1337
    /**
1338
     * luminance masking (0-> disabled)
1339
     * - encoding: Set by user.
1340
     * - decoding: unused
1341
     */
1342
    float lumi_masking;
1343

    
1344
    /**
1345
     * temporary complexity masking (0-> disabled)
1346
     * - encoding: Set by user.
1347
     * - decoding: unused
1348
     */
1349
    float temporal_cplx_masking;
1350

    
1351
    /**
1352
     * spatial complexity masking (0-> disabled)
1353
     * - encoding: Set by user.
1354
     * - decoding: unused
1355
     */
1356
    float spatial_cplx_masking;
1357

    
1358
    /**
1359
     * p block masking (0-> disabled)
1360
     * - encoding: Set by user.
1361
     * - decoding: unused
1362
     */
1363
    float p_masking;
1364

    
1365
    /**
1366
     * darkness masking (0-> disabled)
1367
     * - encoding: Set by user.
1368
     * - decoding: unused
1369
     */
1370
    float dark_masking;
1371

    
1372
    /**
1373
     * IDCT algorithm, see FF_IDCT_* below.
1374
     * - encoding: Set by user.
1375
     * - decoding: Set by user.
1376
     */
1377
    int idct_algo;
1378
#define FF_IDCT_AUTO          0
1379
#define FF_IDCT_INT           1
1380
#define FF_IDCT_SIMPLE        2
1381
#define FF_IDCT_SIMPLEMMX     3
1382
#define FF_IDCT_LIBMPEG2MMX   4
1383
#define FF_IDCT_PS2           5
1384
#define FF_IDCT_MLIB          6
1385
#define FF_IDCT_ARM           7
1386
#define FF_IDCT_ALTIVEC       8
1387
#define FF_IDCT_SH4           9
1388
#define FF_IDCT_SIMPLEARM     10
1389
#define FF_IDCT_H264          11
1390
#define FF_IDCT_VP3           12
1391
#define FF_IDCT_IPP           13
1392
#define FF_IDCT_XVIDMMX       14
1393
#define FF_IDCT_CAVS          15
1394
#define FF_IDCT_SIMPLEARMV5TE 16
1395
#define FF_IDCT_SIMPLEARMV6   17
1396
#define FF_IDCT_SIMPLEVIS     18
1397
#define FF_IDCT_WMV2          19
1398
#define FF_IDCT_FAAN          20
1399
#define FF_IDCT_EA            21
1400
#define FF_IDCT_SIMPLENEON    22
1401
#define FF_IDCT_SIMPLEALPHA   23
1402

    
1403
    /**
1404
     * slice count
1405
     * - encoding: Set by libavcodec.
1406
     * - decoding: Set by user (or 0).
1407
     */
1408
    int slice_count;
1409
    /**
1410
     * slice offsets in the frame in bytes
1411
     * - encoding: Set/allocated by libavcodec.
1412
     * - decoding: Set/allocated by user (or NULL).
1413
     */
1414
    int *slice_offset;
1415

    
1416
    /**
1417
     * error concealment flags
1418
     * - encoding: unused
1419
     * - decoding: Set by user.
1420
     */
1421
    int error_concealment;
1422
#define FF_EC_GUESS_MVS   1
1423
#define FF_EC_DEBLOCK     2
1424

    
1425
    /**
1426
     * dsp_mask could be add used to disable unwanted CPU features
1427
     * CPU features (i.e. MMX, SSE. ...)
1428
     *
1429
     * With the FORCE flag you may instead enable given CPU features.
1430
     * (Dangerous: Usable in case of misdetection, improper usage however will
1431
     * result into program crash.)
1432
     */
1433
    unsigned dsp_mask;
1434
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1435
    /* lower 16 bits - CPU features */
1436
#define FF_MM_MMX      0x0001 ///< standard MMX
1437
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1438
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1439
#define FF_MM_SSE      0x0008 ///< SSE functions
1440
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1441
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1442
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1443
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1444
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1445
#define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
1446

    
1447
    /**
1448
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1449
     * - encoding: Set by libavcodec.
1450
     * - decoding: Set by user.
1451
     */
1452
     int bits_per_coded_sample;
1453

    
1454
    /**
1455
     * prediction method (needed for huffyuv)
1456
     * - encoding: Set by user.
1457
     * - decoding: unused
1458
     */
1459
     int prediction_method;
1460
#define FF_PRED_LEFT   0
1461
#define FF_PRED_PLANE  1
1462
#define FF_PRED_MEDIAN 2
1463

    
1464
    /**
1465
     * sample aspect ratio (0 if unknown)
1466
     * That is the width of a pixel divided by the height of the pixel.
1467
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1468
     * - encoding: Set by user.
1469
     * - decoding: Set by libavcodec.
1470
     */
1471
    AVRational sample_aspect_ratio;
1472

    
1473
    /**
1474
     * the picture in the bitstream
1475
     * - encoding: Set by libavcodec.
1476
     * - decoding: Set by libavcodec.
1477
     */
1478
    AVFrame *coded_frame;
1479

    
1480
    /**
1481
     * debug
1482
     * - encoding: Set by user.
1483
     * - decoding: Set by user.
1484
     */
1485
    int debug;
1486
#define FF_DEBUG_PICT_INFO   1
1487
#define FF_DEBUG_RC          2
1488
#define FF_DEBUG_BITSTREAM   4
1489
#define FF_DEBUG_MB_TYPE     8
1490
#define FF_DEBUG_QP          16
1491
#define FF_DEBUG_MV          32
1492
#define FF_DEBUG_DCT_COEFF   0x00000040
1493
#define FF_DEBUG_SKIP        0x00000080
1494
#define FF_DEBUG_STARTCODE   0x00000100
1495
#define FF_DEBUG_PTS         0x00000200
1496
#define FF_DEBUG_ER          0x00000400
1497
#define FF_DEBUG_MMCO        0x00000800
1498
#define FF_DEBUG_BUGS        0x00001000
1499
#define FF_DEBUG_VIS_QP      0x00002000
1500
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1501
#define FF_DEBUG_BUFFERS     0x00008000
1502

    
1503
    /**
1504
     * debug
1505
     * - encoding: Set by user.
1506
     * - decoding: Set by user.
1507
     */
1508
    int debug_mv;
1509
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1510
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1511
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1512

    
1513
    /**
1514
     * error
1515
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1516
     * - decoding: unused
1517
     */
1518
    uint64_t error[4];
1519

    
1520
    /**
1521
     * minimum MB quantizer
1522
     * - encoding: unused
1523
     * - decoding: unused
1524
     */
1525
    int mb_qmin;
1526

    
1527
    /**
1528
     * maximum MB quantizer
1529
     * - encoding: unused
1530
     * - decoding: unused
1531
     */
1532
    int mb_qmax;
1533

    
1534
    /**
1535
     * motion estimation comparison function
1536
     * - encoding: Set by user.
1537
     * - decoding: unused
1538
     */
1539
    int me_cmp;
1540
    /**
1541
     * subpixel motion estimation comparison function
1542
     * - encoding: Set by user.
1543
     * - decoding: unused
1544
     */
1545
    int me_sub_cmp;
1546
    /**
1547
     * macroblock comparison function (not supported yet)
1548
     * - encoding: Set by user.
1549
     * - decoding: unused
1550
     */
1551
    int mb_cmp;
1552
    /**
1553
     * interlaced DCT comparison function
1554
     * - encoding: Set by user.
1555
     * - decoding: unused
1556
     */
1557
    int ildct_cmp;
1558
#define FF_CMP_SAD    0
1559
#define FF_CMP_SSE    1
1560
#define FF_CMP_SATD   2
1561
#define FF_CMP_DCT    3
1562
#define FF_CMP_PSNR   4
1563
#define FF_CMP_BIT    5
1564
#define FF_CMP_RD     6
1565
#define FF_CMP_ZERO   7
1566
#define FF_CMP_VSAD   8
1567
#define FF_CMP_VSSE   9
1568
#define FF_CMP_NSSE   10
1569
#define FF_CMP_W53    11
1570
#define FF_CMP_W97    12
1571
#define FF_CMP_DCTMAX 13
1572
#define FF_CMP_DCT264 14
1573
#define FF_CMP_CHROMA 256
1574

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

    
1582
    /**
1583
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1584
     * - encoding: Set by user.
1585
     * - decoding: unused
1586
     */
1587
    int last_predictor_count;
1588

    
1589
    /**
1590
     * prepass for motion estimation
1591
     * - encoding: Set by user.
1592
     * - decoding: unused
1593
     */
1594
    int pre_me;
1595

    
1596
    /**
1597
     * motion estimation prepass comparison function
1598
     * - encoding: Set by user.
1599
     * - decoding: unused
1600
     */
1601
    int me_pre_cmp;
1602

    
1603
    /**
1604
     * ME prepass diamond size & shape
1605
     * - encoding: Set by user.
1606
     * - decoding: unused
1607
     */
1608
    int pre_dia_size;
1609

    
1610
    /**
1611
     * subpel ME quality
1612
     * - encoding: Set by user.
1613
     * - decoding: unused
1614
     */
1615
    int me_subpel_quality;
1616

    
1617
    /**
1618
     * callback to negotiate the pixelFormat
1619
     * @param fmt is the list of formats which are supported by the codec,
1620
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1621
     * The first is always the native one.
1622
     * @return the chosen format
1623
     * - encoding: unused
1624
     * - decoding: Set by user, if not set the native format will be chosen.
1625
     */
1626
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1627

    
1628
    /**
1629
     * DTG active format information (additional aspect ratio
1630
     * information only used in DVB MPEG-2 transport streams)
1631
     * 0 if not set.
1632
     *
1633
     * - encoding: unused
1634
     * - decoding: Set by decoder.
1635
     */
1636
    int dtg_active_format;
1637
#define FF_DTG_AFD_SAME         8
1638
#define FF_DTG_AFD_4_3          9
1639
#define FF_DTG_AFD_16_9         10
1640
#define FF_DTG_AFD_14_9         11
1641
#define FF_DTG_AFD_4_3_SP_14_9  13
1642
#define FF_DTG_AFD_16_9_SP_14_9 14
1643
#define FF_DTG_AFD_SP_4_3       15
1644

    
1645
    /**
1646
     * maximum motion estimation search range in subpel units
1647
     * If 0 then no limit.
1648
     *
1649
     * - encoding: Set by user.
1650
     * - decoding: unused
1651
     */
1652
    int me_range;
1653

    
1654
    /**
1655
     * intra quantizer bias
1656
     * - encoding: Set by user.
1657
     * - decoding: unused
1658
     */
1659
    int intra_quant_bias;
1660
#define FF_DEFAULT_QUANT_BIAS 999999
1661

    
1662
    /**
1663
     * inter quantizer bias
1664
     * - encoding: Set by user.
1665
     * - decoding: unused
1666
     */
1667
    int inter_quant_bias;
1668

    
1669
    /**
1670
     * color table ID
1671
     * - encoding: unused
1672
     * - decoding: Which clrtable should be used for 8bit RGB images.
1673
     *             Tables have to be stored somewhere. FIXME
1674
     */
1675
    int color_table_id;
1676

    
1677
    /**
1678
     * internal_buffer count
1679
     * Don't touch, used by libavcodec default_get_buffer().
1680
     */
1681
    int internal_buffer_count;
1682

    
1683
    /**
1684
     * internal_buffers
1685
     * Don't touch, used by libavcodec default_get_buffer().
1686
     */
1687
    void *internal_buffer;
1688

    
1689
#define FF_LAMBDA_SHIFT 7
1690
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1691
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1692
#define FF_LAMBDA_MAX (256*128-1)
1693

    
1694
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1695
    /**
1696
     * Global quality for codecs which cannot change it per frame.
1697
     * This should be proportional to MPEG-1/2/4 qscale.
1698
     * - encoding: Set by user.
1699
     * - decoding: unused
1700
     */
1701
    int global_quality;
1702

    
1703
#define FF_CODER_TYPE_VLC       0
1704
#define FF_CODER_TYPE_AC        1
1705
#define FF_CODER_TYPE_RAW       2
1706
#define FF_CODER_TYPE_RLE       3
1707
#define FF_CODER_TYPE_DEFLATE   4
1708
    /**
1709
     * coder type
1710
     * - encoding: Set by user.
1711
     * - decoding: unused
1712
     */
1713
    int coder_type;
1714

    
1715
    /**
1716
     * context model
1717
     * - encoding: Set by user.
1718
     * - decoding: unused
1719
     */
1720
    int context_model;
1721
#if 0
1722
    /**
1723
     *
1724
     * - encoding: unused
1725
     * - decoding: Set by user.
1726
     */
1727
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1728
#endif
1729

    
1730
    /**
1731
     * slice flags
1732
     * - encoding: unused
1733
     * - decoding: Set by user.
1734
     */
1735
    int slice_flags;
1736
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1737
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1738
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1739

    
1740
    /**
1741
     * XVideo Motion Acceleration
1742
     * - encoding: forbidden
1743
     * - decoding: set by decoder
1744
     */
1745
    int xvmc_acceleration;
1746

    
1747
    /**
1748
     * macroblock decision mode
1749
     * - encoding: Set by user.
1750
     * - decoding: unused
1751
     */
1752
    int mb_decision;
1753
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1754
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1755
#define FF_MB_DECISION_RD     2        ///< rate distortion
1756

    
1757
    /**
1758
     * custom intra quantization matrix
1759
     * - encoding: Set by user, can be NULL.
1760
     * - decoding: Set by libavcodec.
1761
     */
1762
    uint16_t *intra_matrix;
1763

    
1764
    /**
1765
     * custom inter quantization matrix
1766
     * - encoding: Set by user, can be NULL.
1767
     * - decoding: Set by libavcodec.
1768
     */
1769
    uint16_t *inter_matrix;
1770

    
1771
    /**
1772
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1773
     * This is used to work around some encoder bugs.
1774
     * - encoding: unused
1775
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1776
     */
1777
    unsigned int stream_codec_tag;
1778

    
1779
    /**
1780
     * scene change detection threshold
1781
     * 0 is default, larger means fewer detected scene changes.
1782
     * - encoding: Set by user.
1783
     * - decoding: unused
1784
     */
1785
    int scenechange_threshold;
1786

    
1787
    /**
1788
     * minimum Lagrange multipler
1789
     * - encoding: Set by user.
1790
     * - decoding: unused
1791
     */
1792
    int lmin;
1793

    
1794
    /**
1795
     * maximum Lagrange multipler
1796
     * - encoding: Set by user.
1797
     * - decoding: unused
1798
     */
1799
    int lmax;
1800

    
1801
    /**
1802
     * palette control structure
1803
     * - encoding: ??? (no palette-enabled encoder yet)
1804
     * - decoding: Set by user.
1805
     */
1806
    struct AVPaletteControl *palctrl;
1807

    
1808
    /**
1809
     * noise reduction strength
1810
     * - encoding: Set by user.
1811
     * - decoding: unused
1812
     */
1813
    int noise_reduction;
1814

    
1815
    /**
1816
     * Called at the beginning of a frame to get cr buffer for it.
1817
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1818
     * libavcodec will pass previous buffer in pic, function should return
1819
     * same buffer or new buffer with old frame "painted" into it.
1820
     * If pic.data[0] == NULL must behave like get_buffer().
1821
     * - encoding: unused
1822
     * - decoding: Set by libavcodec., user can override
1823
     */
1824
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1825

    
1826
    /**
1827
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1828
     * - encoding: Set by user.
1829
     * - decoding: unused
1830
     */
1831
    int rc_initial_buffer_occupancy;
1832

    
1833
    /**
1834
     *
1835
     * - encoding: Set by user.
1836
     * - decoding: unused
1837
     */
1838
    int inter_threshold;
1839

    
1840
    /**
1841
     * CODEC_FLAG2_*
1842
     * - encoding: Set by user.
1843
     * - decoding: Set by user.
1844
     */
1845
    int flags2;
1846

    
1847
    /**
1848
     * Simulates errors in the bitstream to test error concealment.
1849
     * - encoding: Set by user.
1850
     * - decoding: unused
1851
     */
1852
    int error_rate;
1853

    
1854
    /**
1855
     * MP3 antialias algorithm, see FF_AA_* below.
1856
     * - encoding: unused
1857
     * - decoding: Set by user.
1858
     */
1859
    int antialias_algo;
1860
#define FF_AA_AUTO    0
1861
#define FF_AA_FASTINT 1 //not implemented yet
1862
#define FF_AA_INT     2
1863
#define FF_AA_FLOAT   3
1864
    /**
1865
     * quantizer noise shaping
1866
     * - encoding: Set by user.
1867
     * - decoding: unused
1868
     */
1869
    int quantizer_noise_shaping;
1870

    
1871
    /**
1872
     * thread count
1873
     * is used to decide how many independent tasks should be passed to execute()
1874
     * - encoding: Set by user.
1875
     * - decoding: Set by user.
1876
     */
1877
    int thread_count;
1878

    
1879
    /**
1880
     * The codec may call this to execute several independent things.
1881
     * It will return only after finishing all tasks.
1882
     * The user may replace this with some multithreaded implementation,
1883
     * the default implementation will execute the parts serially.
1884
     * @param count the number of things to execute
1885
     * - encoding: Set by libavcodec, user can override.
1886
     * - decoding: Set by libavcodec, user can override.
1887
     */
1888
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1889

    
1890
    /**
1891
     * thread opaque
1892
     * Can be used by execute() to store some per AVCodecContext stuff.
1893
     * - encoding: set by execute()
1894
     * - decoding: set by execute()
1895
     */
1896
    void *thread_opaque;
1897

    
1898
    /**
1899
     * Motion estimation threshold below which no motion estimation is
1900
     * performed, but instead the user specified motion vectors are used.
1901
     *
1902
     * - encoding: Set by user.
1903
     * - decoding: unused
1904
     */
1905
     int me_threshold;
1906

    
1907
    /**
1908
     * Macroblock threshold below which the user specified macroblock types will be used.
1909
     * - encoding: Set by user.
1910
     * - decoding: unused
1911
     */
1912
     int mb_threshold;
1913

    
1914
    /**
1915
     * precision of the intra DC coefficient - 8
1916
     * - encoding: Set by user.
1917
     * - decoding: unused
1918
     */
1919
     int intra_dc_precision;
1920

    
1921
    /**
1922
     * noise vs. sse weight for the nsse comparsion function
1923
     * - encoding: Set by user.
1924
     * - decoding: unused
1925
     */
1926
     int nsse_weight;
1927

    
1928
    /**
1929
     * Number of macroblock rows at the top which are skipped.
1930
     * - encoding: unused
1931
     * - decoding: Set by user.
1932
     */
1933
     int skip_top;
1934

    
1935
    /**
1936
     * Number of macroblock rows at the bottom which are skipped.
1937
     * - encoding: unused
1938
     * - decoding: Set by user.
1939
     */
1940
     int skip_bottom;
1941

    
1942
    /**
1943
     * profile
1944
     * - encoding: Set by user.
1945
     * - decoding: Set by libavcodec.
1946
     */
1947
     int profile;
1948
#define FF_PROFILE_UNKNOWN -99
1949
#define FF_PROFILE_AAC_MAIN 0
1950
#define FF_PROFILE_AAC_LOW  1
1951
#define FF_PROFILE_AAC_SSR  2
1952
#define FF_PROFILE_AAC_LTP  3
1953

    
1954
    /**
1955
     * level
1956
     * - encoding: Set by user.
1957
     * - decoding: Set by libavcodec.
1958
     */
1959
     int level;
1960
#define FF_LEVEL_UNKNOWN -99
1961

    
1962
    /**
1963
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1964
     * - encoding: unused
1965
     * - decoding: Set by user.
1966
     */
1967
     int lowres;
1968

    
1969
    /**
1970
     * Bitstream width / height, may be different from width/height if lowres
1971
     * or other things are used.
1972
     * - encoding: unused
1973
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1974
     */
1975
    int coded_width, coded_height;
1976

    
1977
    /**
1978
     * frame skip threshold
1979
     * - encoding: Set by user.
1980
     * - decoding: unused
1981
     */
1982
    int frame_skip_threshold;
1983

    
1984
    /**
1985
     * frame skip factor
1986
     * - encoding: Set by user.
1987
     * - decoding: unused
1988
     */
1989
    int frame_skip_factor;
1990

    
1991
    /**
1992
     * frame skip exponent
1993
     * - encoding: Set by user.
1994
     * - decoding: unused
1995
     */
1996
    int frame_skip_exp;
1997

    
1998
    /**
1999
     * frame skip comparison function
2000
     * - encoding: Set by user.
2001
     * - decoding: unused
2002
     */
2003
    int frame_skip_cmp;
2004

    
2005
    /**
2006
     * Border processing masking, raises the quantizer for mbs on the borders
2007
     * of the picture.
2008
     * - encoding: Set by user.
2009
     * - decoding: unused
2010
     */
2011
    float border_masking;
2012

    
2013
    /**
2014
     * minimum MB lagrange multipler
2015
     * - encoding: Set by user.
2016
     * - decoding: unused
2017
     */
2018
    int mb_lmin;
2019

    
2020
    /**
2021
     * maximum MB lagrange multipler
2022
     * - encoding: Set by user.
2023
     * - decoding: unused
2024
     */
2025
    int mb_lmax;
2026

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

    
2034
    /**
2035
     *
2036
     * - encoding: unused
2037
     * - decoding: Set by user.
2038
     */
2039
    enum AVDiscard skip_loop_filter;
2040

    
2041
    /**
2042
     *
2043
     * - encoding: unused
2044
     * - decoding: Set by user.
2045
     */
2046
    enum AVDiscard skip_idct;
2047

    
2048
    /**
2049
     *
2050
     * - encoding: unused
2051
     * - decoding: Set by user.
2052
     */
2053
    enum AVDiscard skip_frame;
2054

    
2055
    /**
2056
     *
2057
     * - encoding: Set by user.
2058
     * - decoding: unused
2059
     */
2060
    int bidir_refine;
2061

    
2062
    /**
2063
     *
2064
     * - encoding: Set by user.
2065
     * - decoding: unused
2066
     */
2067
    int brd_scale;
2068

    
2069
    /**
2070
     * constant rate factor - quality-based VBR - values ~correspond to qps
2071
     * - encoding: Set by user.
2072
     * - decoding: unused
2073
     */
2074
    float crf;
2075

    
2076
    /**
2077
     * constant quantization parameter rate control method
2078
     * - encoding: Set by user.
2079
     * - decoding: unused
2080
     */
2081
    int cqp;
2082

    
2083
    /**
2084
     * minimum GOP size
2085
     * - encoding: Set by user.
2086
     * - decoding: unused
2087
     */
2088
    int keyint_min;
2089

    
2090
    /**
2091
     * number of reference frames
2092
     * - encoding: Set by user.
2093
     * - decoding: Set by lavc.
2094
     */
2095
    int refs;
2096

    
2097
    /**
2098
     * chroma qp offset from luma
2099
     * - encoding: Set by user.
2100
     * - decoding: unused
2101
     */
2102
    int chromaoffset;
2103

    
2104
    /**
2105
     * Influences how often B-frames are used.
2106
     * - encoding: Set by user.
2107
     * - decoding: unused
2108
     */
2109
    int bframebias;
2110

    
2111
    /**
2112
     * trellis RD quantization
2113
     * - encoding: Set by user.
2114
     * - decoding: unused
2115
     */
2116
    int trellis;
2117

    
2118
    /**
2119
     * Reduce fluctuations in qp (before curve compression).
2120
     * - encoding: Set by user.
2121
     * - decoding: unused
2122
     */
2123
    float complexityblur;
2124

    
2125
    /**
2126
     * in-loop deblocking filter alphac0 parameter
2127
     * alpha is in the range -6...6
2128
     * - encoding: Set by user.
2129
     * - decoding: unused
2130
     */
2131
    int deblockalpha;
2132

    
2133
    /**
2134
     * in-loop deblocking filter beta parameter
2135
     * beta is in the range -6...6
2136
     * - encoding: Set by user.
2137
     * - decoding: unused
2138
     */
2139
    int deblockbeta;
2140

    
2141
    /**
2142
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2143
     * - encoding: Set by user.
2144
     * - decoding: unused
2145
     */
2146
    int partitions;
2147
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2148
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2149
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2150
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2151
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2152

    
2153
    /**
2154
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2155
     * - encoding: Set by user.
2156
     * - decoding: unused
2157
     */
2158
    int directpred;
2159

    
2160
    /**
2161
     * Audio cutoff bandwidth (0 means "automatic")
2162
     * - encoding: Set by user.
2163
     * - decoding: unused
2164
     */
2165
    int cutoff;
2166

    
2167
    /**
2168
     * Multiplied by qscale for each frame and added to scene_change_score.
2169
     * - encoding: Set by user.
2170
     * - decoding: unused
2171
     */
2172
    int scenechange_factor;
2173

    
2174
    /**
2175
     *
2176
     * Note: Value depends upon the compare function used for fullpel ME.
2177
     * - encoding: Set by user.
2178
     * - decoding: unused
2179
     */
2180
    int mv0_threshold;
2181

    
2182
    /**
2183
     * Adjusts sensitivity of b_frame_strategy 1.
2184
     * - encoding: Set by user.
2185
     * - decoding: unused
2186
     */
2187
    int b_sensitivity;
2188

    
2189
    /**
2190
     * - encoding: Set by user.
2191
     * - decoding: unused
2192
     */
2193
    int compression_level;
2194
#define FF_COMPRESSION_DEFAULT -1
2195

    
2196
    /**
2197
     * Sets whether to use LPC mode - used by FLAC encoder.
2198
     * - encoding: Set by user.
2199
     * - decoding: unused
2200
     */
2201
    int use_lpc;
2202

    
2203
    /**
2204
     * LPC coefficient precision - used by FLAC encoder
2205
     * - encoding: Set by user.
2206
     * - decoding: unused
2207
     */
2208
    int lpc_coeff_precision;
2209

    
2210
    /**
2211
     * - encoding: Set by user.
2212
     * - decoding: unused
2213
     */
2214
    int min_prediction_order;
2215

    
2216
    /**
2217
     * - encoding: Set by user.
2218
     * - decoding: unused
2219
     */
2220
    int max_prediction_order;
2221

    
2222
    /**
2223
     * search method for selecting prediction order
2224
     * - encoding: Set by user.
2225
     * - decoding: unused
2226
     */
2227
    int prediction_order_method;
2228

    
2229
    /**
2230
     * - encoding: Set by user.
2231
     * - decoding: unused
2232
     */
2233
    int min_partition_order;
2234

    
2235
    /**
2236
     * - encoding: Set by user.
2237
     * - decoding: unused
2238
     */
2239
    int max_partition_order;
2240

    
2241
    /**
2242
     * GOP timecode frame start number, in non drop frame format
2243
     * - encoding: Set by user.
2244
     * - decoding: unused
2245
     */
2246
    int64_t timecode_frame_start;
2247

    
2248
#if LIBAVCODEC_VERSION_MAJOR < 53
2249
    /**
2250
     * Decoder should decode to this many channels if it can (0 for default)
2251
     * - encoding: unused
2252
     * - decoding: Set by user.
2253
     * @deprecated Deprecated in favor of request_channel_layout.
2254
     */
2255
    int request_channels;
2256
#endif
2257

    
2258
    /**
2259
     * Percentage of dynamic range compression to be applied by the decoder.
2260
     * The default value is 1.0, corresponding to full compression.
2261
     * - encoding: unused
2262
     * - decoding: Set by user.
2263
     */
2264
    float drc_scale;
2265

    
2266
    /**
2267
     * opaque 64bit number (generally a PTS) that will be reordered and
2268
     * output in AVFrame.reordered_opaque
2269
     * - encoding: unused
2270
     * - decoding: Set by user.
2271
     */
2272
    int64_t reordered_opaque;
2273

    
2274
    /**
2275
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2276
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2277
     * - encoding: set by user.
2278
     * - decoding: set by libavcodec.
2279
     */
2280
    int bits_per_raw_sample;
2281

    
2282
    /**
2283
     * Audio channel layout.
2284
     * - encoding: set by user.
2285
     * - decoding: set by libavcodec.
2286
     */
2287
    int64_t channel_layout;
2288

    
2289
    /**
2290
     * Request decoder to use this channel layout if it can (0 for default)
2291
     * - encoding: unused
2292
     * - decoding: Set by user.
2293
     */
2294
    int64_t request_channel_layout;
2295

    
2296
    /**
2297
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2298
     * - encoding: Set by user.
2299
     * - decoding: unused.
2300
     */
2301
    float rc_max_available_vbv_use;
2302

    
2303
    /**
2304
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2305
     * - encoding: Set by user.
2306
     * - decoding: unused.
2307
     */
2308
    float rc_min_vbv_overflow_use;
2309
} AVCodecContext;
2310

    
2311
/**
2312
 * AVCodec.
2313
 */
2314
typedef struct AVCodec {
2315
    /**
2316
     * Name of the codec implementation.
2317
     * The name is globally unique among encoders and among decoders (but an
2318
     * encoder and a decoder can share the same name).
2319
     * This is the primary way to find a codec from the user perspective.
2320
     */
2321
    const char *name;
2322
    enum CodecType type;
2323
    enum CodecID id;
2324
    int priv_data_size;
2325
    int (*init)(AVCodecContext *);
2326
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2327
    int (*close)(AVCodecContext *);
2328
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2329
                  const uint8_t *buf, int buf_size);
2330
    /**
2331
     * Codec capabilities.
2332
     * see CODEC_CAP_*
2333
     */
2334
    int capabilities;
2335
    struct AVCodec *next;
2336
    /**
2337
     * Flush buffers.
2338
     * Will be called when seeking
2339
     */
2340
    void (*flush)(AVCodecContext *);
2341
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2342
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2343
    /**
2344
     * Descriptive name for the codec, meant to be more human readable than \p name.
2345
     * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2346
     */
2347
    const char *long_name;
2348
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2349
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2350
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2351
} AVCodec;
2352

    
2353
/**
2354
 * four components are given, that's all.
2355
 * the last component is alpha
2356
 */
2357
typedef struct AVPicture {
2358
    uint8_t *data[4];
2359
    int linesize[4];       ///< number of bytes per line
2360
} AVPicture;
2361

    
2362
/**
2363
 * AVPaletteControl
2364
 * This structure defines a method for communicating palette changes
2365
 * between and demuxer and a decoder.
2366
 *
2367
 * @deprecated Use AVPacket to send palette changes instead.
2368
 * This is totally broken.
2369
 */
2370
#define AVPALETTE_SIZE 1024
2371
#define AVPALETTE_COUNT 256
2372
typedef struct AVPaletteControl {
2373

    
2374
    /* Demuxer sets this to 1 to indicate the palette has changed;
2375
     * decoder resets to 0. */
2376
    int palette_changed;
2377

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

    
2384
} AVPaletteControl attribute_deprecated;
2385

    
2386
enum AVSubtitleType {
2387
    SUBTITLE_NONE,
2388

    
2389
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2390

    
2391
    /**
2392
     * Plain text, the text field must be set by the decoder and is
2393
     * authoritative. ass and pict fields may contain approximations.
2394
     */
2395
    SUBTITLE_TEXT,
2396

    
2397
    /**
2398
     * Formatted text, the ass field must be set by the decoder and is
2399
     * authoritative. pict and text fields may contain approximations.
2400
     */
2401
    SUBTITLE_ASS,
2402
};
2403

    
2404
typedef struct AVSubtitleRect {
2405
    int x;         ///< top left corner  of pict, undefined when pict is not set
2406
    int y;         ///< top left corner  of pict, undefined when pict is not set
2407
    int w;         ///< width            of pict, undefined when pict is not set
2408
    int h;         ///< height           of pict, undefined when pict is not set
2409
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2410

    
2411
    /**
2412
     * data+linesize for the bitmap of this subtitle.
2413
     * can be set for text/ass as well once they where rendered
2414
     */
2415
    AVPicture pict;
2416
    enum AVSubtitleType type;
2417

    
2418
    char *text;                     ///< 0 terminated plain UTF-8 text
2419

    
2420
    /**
2421
     * 0 terminated ASS/SSA compatible event line.
2422
     * The pressentation of this is unaffected by the other values in this
2423
     * struct.
2424
     */
2425
    char *ass;
2426
} AVSubtitleRect;
2427

    
2428
typedef struct AVSubtitle {
2429
    uint16_t format; /* 0 = graphics */
2430
    uint32_t start_display_time; /* relative to packet pts, in ms */
2431
    uint32_t end_display_time; /* relative to packet pts, in ms */
2432
    unsigned num_rects;
2433
    AVSubtitleRect **rects;
2434
} AVSubtitle;
2435

    
2436

    
2437
/* resample.c */
2438

    
2439
struct ReSampleContext;
2440
struct AVResampleContext;
2441

    
2442
typedef struct ReSampleContext ReSampleContext;
2443

    
2444
ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2445
                                     int output_rate, int input_rate);
2446
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2447
void audio_resample_close(ReSampleContext *s);
2448

    
2449
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2450
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2451
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2452
void av_resample_close(struct AVResampleContext *c);
2453

    
2454
/**
2455
 * Allocate memory for a picture.  Call avpicture_free to free it.
2456
 *
2457
 * @param picture the picture to be filled in
2458
 * @param pix_fmt the format of the picture
2459
 * @param width the width of the picture
2460
 * @param height the height of the picture
2461
 * @return zero if successful, a negative value if not
2462
 */
2463
int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2464

    
2465
/**
2466
 * Free a picture previously allocated by avpicture_alloc().
2467
 *
2468
 * @param picture the AVPicture to be freed
2469
 */
2470
void avpicture_free(AVPicture *picture);
2471

    
2472
/**
2473
 * Fill in the AVPicture fields.
2474
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2475
 * which points to the image data buffer. Depending on the specified picture
2476
 * format, one or multiple image data pointers and line sizes will be set.
2477
 * If a planar format is specified, several pointers will be set pointing to
2478
 * the different picture planes and the line sizes of the different planes
2479
 * will be stored in the lines_sizes array.
2480
 *
2481
 * @param picture AVPicture whose fields are to be filled in
2482
 * @param ptr Buffer which will contain or contains the actual image data
2483
 * @param pix_fmt The format in which the picture data is stored.
2484
 * @param width the width of the image in pixels
2485
 * @param height the height of the image in pixels
2486
 * @return size of the image data in bytes
2487
 */
2488
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2489
                   int pix_fmt, int width, int height);
2490
int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2491
                     unsigned char *dest, int dest_size);
2492

    
2493
/**
2494
 * Calculate the size in bytes that a picture of the given width and height
2495
 * would occupy if stored in the given picture format.
2496
 *
2497
 * @param pix_fmt the given picture format
2498
 * @param width the width of the image
2499
 * @param height the height of the image
2500
 * @return Image data size in bytes
2501
 */
2502
int avpicture_get_size(int pix_fmt, int width, int height);
2503
void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2504
const char *avcodec_get_pix_fmt_name(int pix_fmt);
2505
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2506
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2507
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2508

    
2509
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2510
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2511
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2512
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2513
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2514
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2515

    
2516
/**
2517
 * Computes what kind of losses will occur when converting from one specific
2518
 * pixel format to another.
2519
 * When converting from one pixel format to another, information loss may occur.
2520
 * For example, when converting from RGB24 to GRAY, the color information will
2521
 * be lost. Similarly, other losses occur when converting from some formats to
2522
 * other formats. These losses can involve loss of chroma, but also loss of
2523
 * resolution, loss of color depth, loss due to the color space conversion, loss
2524
 * of the alpha bits or loss due to color quantization.
2525
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2526
 * which will occur when converting from one pixel format to another.
2527
 *
2528
 * @param[in] dst_pix_fmt destination pixel format
2529
 * @param[in] src_pix_fmt source pixel format
2530
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2531
 * @return Combination of flags informing you what kind of losses will occur.
2532
 */
2533
int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2534
                             int has_alpha);
2535

    
2536
/**
2537
 * Finds the best pixel format to convert to given a certain source pixel
2538
 * format.  When converting from one pixel format to another, information loss
2539
 * may occur.  For example, when converting from RGB24 to GRAY, the color
2540
 * information will be lost. Similarly, other losses occur when converting from
2541
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2542
 * the given pixel formats should be used to suffer the least amount of loss.
2543
 * The pixel formats from which it chooses one, are determined by the
2544
 * \p pix_fmt_mask parameter.
2545
 *
2546
 * @code
2547
 * src_pix_fmt = PIX_FMT_YUV420P;
2548
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2549
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2550
 * @endcode
2551
 *
2552
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2553
 * @param[in] src_pix_fmt source pixel format
2554
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2555
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2556
 * @return The best pixel format to convert to or -1 if none was found.
2557
 */
2558
int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2559
                              int has_alpha, int *loss_ptr);
2560

    
2561

    
2562
/**
2563
 * Print in buf the string corresponding to the pixel format with
2564
 * number pix_fmt, or an header if pix_fmt is negative.
2565
 *
2566
 * @param[in] buf the buffer where to write the string
2567
 * @param[in] buf_size the size of buf
2568
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2569
 * a negative value to print the corresponding header.
2570
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2571
 */
2572
void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2573

    
2574
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2575
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2576

    
2577
/**
2578
 * Tell if an image really has transparent alpha values.
2579
 * @return ored mask of FF_ALPHA_xxx constants
2580
 */
2581
int img_get_alpha_info(const AVPicture *src,
2582
                       int pix_fmt, int width, int height);
2583

    
2584
/* deinterlace a picture */
2585
/* deinterlace - if not supported return -1 */
2586
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2587
                          int pix_fmt, int width, int height);
2588

    
2589
/* external high level API */
2590

    
2591
AVCodec *av_codec_next(AVCodec *c);
2592

    
2593
/**
2594
 * Returns the LIBAVCODEC_VERSION_INT constant.
2595
 */
2596
unsigned avcodec_version(void);
2597

    
2598
/**
2599
 * Initializes libavcodec.
2600
 *
2601
 * @warning This function \e must be called before any other libavcodec
2602
 * function.
2603
 */
2604
void avcodec_init(void);
2605

    
2606
/**
2607
 * Register the codec \p codec and initialize libavcodec.
2608
 *
2609
 * @see avcodec_init()
2610
 */
2611
void register_avcodec(AVCodec *codec);
2612

    
2613
/**
2614
 * Finds a registered encoder with a matching codec ID.
2615
 *
2616
 * @param id CodecID of the requested encoder
2617
 * @return An encoder if one was found, NULL otherwise.
2618
 */
2619
AVCodec *avcodec_find_encoder(enum CodecID id);
2620

    
2621
/**
2622
 * Finds a registered encoder with the specified name.
2623
 *
2624
 * @param name name of the requested encoder
2625
 * @return An encoder if one was found, NULL otherwise.
2626
 */
2627
AVCodec *avcodec_find_encoder_by_name(const char *name);
2628

    
2629
/**
2630
 * Finds a registered decoder with a matching codec ID.
2631
 *
2632
 * @param id CodecID of the requested decoder
2633
 * @return A decoder if one was found, NULL otherwise.
2634
 */
2635
AVCodec *avcodec_find_decoder(enum CodecID id);
2636

    
2637
/**
2638
 * Finds a registered decoder with the specified name.
2639
 *
2640
 * @param name name of the requested decoder
2641
 * @return A decoder if one was found, NULL otherwise.
2642
 */
2643
AVCodec *avcodec_find_decoder_by_name(const char *name);
2644
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2645

    
2646
/**
2647
 * Sets the fields of the given AVCodecContext to default values.
2648
 *
2649
 * @param s The AVCodecContext of which the fields should be set to default values.
2650
 */
2651
void avcodec_get_context_defaults(AVCodecContext *s);
2652

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

    
2657
/**
2658
 * Allocates an AVCodecContext and sets its fields to default values.  The
2659
 * resulting struct can be deallocated by simply calling av_free().
2660
 *
2661
 * @return An AVCodecContext filled with default values or NULL on failure.
2662
 * @see avcodec_get_context_defaults
2663
 */
2664
AVCodecContext *avcodec_alloc_context(void);
2665

    
2666
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2667
 *  we WILL change its arguments and name a few times! */
2668
AVCodecContext *avcodec_alloc_context2(enum CodecType);
2669

    
2670
/**
2671
 * Sets the fields of the given AVFrame to default values.
2672
 *
2673
 * @param pic The AVFrame of which the fields should be set to default values.
2674
 */
2675
void avcodec_get_frame_defaults(AVFrame *pic);
2676

    
2677
/**
2678
 * Allocates an AVFrame and sets its fields to default values.  The resulting
2679
 * struct can be deallocated by simply calling av_free().
2680
 *
2681
 * @return An AVFrame filled with default values or NULL on failure.
2682
 * @see avcodec_get_frame_defaults
2683
 */
2684
AVFrame *avcodec_alloc_frame(void);
2685

    
2686
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2687
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2688
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2689
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2690

    
2691
/**
2692
 * Checks if the given dimension of a picture is valid, meaning that all
2693
 * bytes of the picture can be addressed with a signed int.
2694
 *
2695
 * @param[in] w Width of the picture.
2696
 * @param[in] h Height of the picture.
2697
 * @return Zero if valid, a negative value if invalid.
2698
 */
2699
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2700
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2701

    
2702
int avcodec_thread_init(AVCodecContext *s, int thread_count);
2703
void avcodec_thread_free(AVCodecContext *s);
2704
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2705
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2706
//FIXME func typedef
2707

    
2708
/**
2709
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2710
 * function the context has to be allocated.
2711
 *
2712
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2713
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2714
 * retrieving a codec.
2715
 *
2716
 * @warning This function is not thread safe!
2717
 *
2718
 * @code
2719
 * avcodec_register_all();
2720
 * codec = avcodec_find_decoder(CODEC_ID_H264);
2721
 * if (!codec)
2722
 *     exit(1);
2723
 *
2724
 * context = avcodec_alloc_context();
2725
 *
2726
 * if (avcodec_open(context, codec) < 0)
2727
 *     exit(1);
2728
 * @endcode
2729
 *
2730
 * @param avctx The context which will be set up to use the given codec.
2731
 * @param codec The codec to use within the context.
2732
 * @return zero on success, a negative value on error
2733
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2734
 */
2735
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2736

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

    
2777
/**
2778
 * Decodes a video frame from \p buf into \p picture.
2779
 * The avcodec_decode_video() function decodes a video frame from the input
2780
 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2781
 * video codec which was coupled with \p avctx using avcodec_open(). The
2782
 * resulting decoded frame is stored in \p picture.
2783
 *
2784
 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2785
 * the actual read bytes because some optimized bitstream readers read 32 or 64
2786
 * bits at once and could read over the end.
2787
 *
2788
 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2789
 * no overreading happens for damaged MPEG streams.
2790
 *
2791
 * @note You might have to align the input buffer \p buf and output buffer \p
2792
 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2793
 * necessary at all, on others it won't work at all if not aligned and on others
2794
 * it will work but it will have an impact on performance. In practice, the
2795
 * bitstream should have 4 byte alignment at minimum and all sample data should
2796
 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2797
 * the linesize is not a multiple of 16 then there's no sense in aligning the
2798
 * start of the buffer to 16.
2799
 *
2800
 * @note Some codecs have a delay between input and output, these need to be
2801
 * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
2802
 *
2803
 * @param avctx the codec context
2804
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2805
 * @param[in] buf the input buffer
2806
 * @param[in] buf_size the size of the input buffer in bytes
2807
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2808
 * @return On error a negative value is returned, otherwise the number of bytes
2809
 * used or zero if no frame could be decompressed.
2810
 */
2811
int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2812
                         int *got_picture_ptr,
2813
                         const uint8_t *buf, int buf_size);
2814

    
2815
/* Decode a subtitle message. Return -1 if error, otherwise return the
2816
 * number of bytes used. If no subtitle could be decompressed,
2817
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2818
int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2819
                            int *got_sub_ptr,
2820
                            const uint8_t *buf, int buf_size);
2821
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2822
                        int *data_size_ptr,
2823
                        uint8_t *buf, int buf_size);
2824

    
2825
/**
2826
 * Encodes an audio frame from \p samples into \p buf.
2827
 * The avcodec_encode_audio() function encodes an audio frame from the input
2828
 * buffer \p samples. To encode it, it makes use of the audio codec which was
2829
 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2830
 * stored in output buffer \p buf.
2831
 *
2832
 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2833
 *
2834
 * @param avctx the codec context
2835
 * @param[out] buf the output buffer
2836
 * @param[in] buf_size the output buffer size
2837
 * @param[in] samples the input buffer containing the samples
2838
 * The number of samples read from this buffer is frame_size*channels,
2839
 * both of which are defined in \p avctx.
2840
 * For PCM audio the number of samples read from \p samples is equal to
2841
 * \p buf_size * input_sample_size / output_sample_size.
2842
 * @return On error a negative value is returned, on success zero or the number
2843
 * of bytes used to encode the data read from the input buffer.
2844
 */
2845
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2846
                         const short *samples);
2847

    
2848
/**
2849
 * Encodes a video frame from \p pict into \p buf.
2850
 * The avcodec_encode_video() function encodes a video frame from the input
2851
 * \p pict. To encode it, it makes use of the video codec which was coupled with
2852
 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2853
 * frame are stored in the output buffer \p buf. The input picture should be
2854
 * stored using a specific format, namely \c avctx.pix_fmt.
2855
 *
2856
 * @param avctx the codec context
2857
 * @param[out] buf the output buffer for the bitstream of encoded frame
2858
 * @param[in] buf_size the size of the output buffer in bytes
2859
 * @param[in] pict the input picture to encode
2860
 * @return On error a negative value is returned, on success zero or the number
2861
 * of bytes used from the input buffer.
2862
 */
2863
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2864
                         const AVFrame *pict);
2865
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2866
                            const AVSubtitle *sub);
2867

    
2868
int avcodec_close(AVCodecContext *avctx);
2869

    
2870
/**
2871
 * Register all the codecs, parsers and bitstream filters which were enabled at
2872
 * configuration time. If you do not call this function you can select exactly
2873
 * which formats you want to support, by using the individual registration
2874
 * functions.
2875
 *
2876
 * @see register_avcodec
2877
 * @see av_register_codec_parser
2878
 * @see av_register_bitstream_filter
2879
 */
2880
void avcodec_register_all(void);
2881

    
2882
/**
2883
 * Flush buffers, should be called when seeking or when switching to a different stream.
2884
 */
2885
void avcodec_flush_buffers(AVCodecContext *avctx);
2886

    
2887
void avcodec_default_free_buffers(AVCodecContext *s);
2888

    
2889
/* misc useful functions */
2890

    
2891
/**
2892
 * Returns a single letter to describe the given picture type \p pict_type.
2893
 *
2894
 * @param[in] pict_type the picture type
2895
 * @return A single character representing the picture type.
2896
 */
2897
char av_get_pict_type_char(int pict_type);
2898

    
2899
/**
2900
 * Returns codec bits per sample.
2901
 *
2902
 * @param[in] codec_id the codec
2903
 * @return Number of bits per sample or zero if unknown for the given codec.
2904
 */
2905
int av_get_bits_per_sample(enum CodecID codec_id);
2906

    
2907
/**
2908
 * Returns sample format bits per sample.
2909
 *
2910
 * @param[in] sample_fmt the sample format
2911
 * @return Number of bits per sample or zero if unknown for the given sample format.
2912
 */
2913
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2914

    
2915
/* frame parsing */
2916
typedef struct AVCodecParserContext {
2917
    void *priv_data;
2918
    struct AVCodecParser *parser;
2919
    int64_t frame_offset; /* offset of the current frame */
2920
    int64_t cur_offset; /* current offset
2921
                           (incremented by each av_parser_parse()) */
2922
    int64_t next_frame_offset; /* offset of the next frame */
2923
    /* video info */
2924
    int pict_type; /* XXX: Put it back in AVCodecContext. */
2925
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2926
    int64_t pts;     /* pts of the current frame */
2927
    int64_t dts;     /* dts of the current frame */
2928

    
2929
    /* private data */
2930
    int64_t last_pts;
2931
    int64_t last_dts;
2932
    int fetch_timestamp;
2933

    
2934
#define AV_PARSER_PTS_NB 4
2935
    int cur_frame_start_index;
2936
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2937
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2938
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2939

    
2940
    int flags;
2941
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
2942

    
2943
    int64_t offset;      ///< byte offset from starting packet start
2944
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
2945
} AVCodecParserContext;
2946

    
2947
typedef struct AVCodecParser {
2948
    int codec_ids[5]; /* several codec IDs are permitted */
2949
    int priv_data_size;
2950
    int (*parser_init)(AVCodecParserContext *s);
2951
    int (*parser_parse)(AVCodecParserContext *s,
2952
                        AVCodecContext *avctx,
2953
                        const uint8_t **poutbuf, int *poutbuf_size,
2954
                        const uint8_t *buf, int buf_size);
2955
    void (*parser_close)(AVCodecParserContext *s);
2956
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2957
    struct AVCodecParser *next;
2958
} AVCodecParser;
2959

    
2960
AVCodecParser *av_parser_next(AVCodecParser *c);
2961

    
2962
void av_register_codec_parser(AVCodecParser *parser);
2963
AVCodecParserContext *av_parser_init(int codec_id);
2964
int av_parser_parse(AVCodecParserContext *s,
2965
                    AVCodecContext *avctx,
2966
                    uint8_t **poutbuf, int *poutbuf_size,
2967
                    const uint8_t *buf, int buf_size,
2968
                    int64_t pts, int64_t dts);
2969
int av_parser_change(AVCodecParserContext *s,
2970
                     AVCodecContext *avctx,
2971
                     uint8_t **poutbuf, int *poutbuf_size,
2972
                     const uint8_t *buf, int buf_size, int keyframe);
2973
void av_parser_close(AVCodecParserContext *s);
2974

    
2975

    
2976
typedef struct AVBitStreamFilterContext {
2977
    void *priv_data;
2978
    struct AVBitStreamFilter *filter;
2979
    AVCodecParserContext *parser;
2980
    struct AVBitStreamFilterContext *next;
2981
} AVBitStreamFilterContext;
2982

    
2983

    
2984
typedef struct AVBitStreamFilter {
2985
    const char *name;
2986
    int priv_data_size;
2987
    int (*filter)(AVBitStreamFilterContext *bsfc,
2988
                  AVCodecContext *avctx, const char *args,
2989
                  uint8_t **poutbuf, int *poutbuf_size,
2990
                  const uint8_t *buf, int buf_size, int keyframe);
2991
    void (*close)(AVBitStreamFilterContext *bsfc);
2992
    struct AVBitStreamFilter *next;
2993
} AVBitStreamFilter;
2994

    
2995
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2996
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2997
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2998
                               AVCodecContext *avctx, const char *args,
2999
                               uint8_t **poutbuf, int *poutbuf_size,
3000
                               const uint8_t *buf, int buf_size, int keyframe);
3001
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3002

    
3003
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3004

    
3005
/* memory */
3006

    
3007
/**
3008
 * Reallocates the given block if it is not large enough, otherwise it
3009
 * does nothing.
3010
 *
3011
 * @see av_realloc
3012
 */
3013
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3014

    
3015
/**
3016
 * Copy image 'src' to 'dst'.
3017
 */
3018
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3019
              int pix_fmt, int width, int height);
3020

    
3021
/**
3022
 * Crop image top and left side.
3023
 */
3024
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3025
             int pix_fmt, int top_band, int left_band);
3026

    
3027
/**
3028
 * Pad image.
3029
 */
3030
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3031
            int padtop, int padbottom, int padleft, int padright, int *color);
3032

    
3033
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3034

    
3035
/**
3036
 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3037
 *
3038
 * @return 0 in case of a successful parsing, a negative value otherwise
3039
 * @param[in] str the string to parse: it has to be a string in the format
3040
 * <width>x<height> or a valid video frame size abbreviation.
3041
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3042
 * frame width value
3043
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3044
 * frame height value
3045
 */
3046
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3047

    
3048
/**
3049
 * Parses \p str and put in \p frame_rate the detected values.
3050
 *
3051
 * @return 0 in case of a successful parsing, a negative value otherwise
3052
 * @param[in] str the string to parse: it has to be a string in the format
3053
 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
3054
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3055
 * frame rate
3056
 */
3057
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3058

    
3059
/* error handling */
3060
#if EINVAL > 0
3061
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3062
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3063
#else
3064
/* Some platforms have E* and errno already negated. */
3065
#define AVERROR(e) (e)
3066
#define AVUNERROR(e) (e)
3067
#endif
3068
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3069
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3070
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3071
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3072
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3073
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3074
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3075
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3076
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3077

    
3078
#endif /* AVCODEC_AVCODEC_H */