Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ e9e949cf

History | View | Annotate | Download (125 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 libavcodec/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 48
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
    CODEC_ID_TQI,
194
    CODEC_ID_AURA,
195
    CODEC_ID_AURA2,
196
    CODEC_ID_V210X,
197
    CODEC_ID_TMV,
198
    CODEC_ID_V210,
199
    CODEC_ID_DPX,
200
    CODEC_ID_MAD,
201
    CODEC_ID_FRWU,
202
    CODEC_ID_FLASHSV2,
203
    CODEC_ID_CDGRAPHICS,
204
    CODEC_ID_R210,
205
    CODEC_ID_ANM,
206

    
207
    /* various PCM "codecs" */
208
    CODEC_ID_PCM_S16LE= 0x10000,
209
    CODEC_ID_PCM_S16BE,
210
    CODEC_ID_PCM_U16LE,
211
    CODEC_ID_PCM_U16BE,
212
    CODEC_ID_PCM_S8,
213
    CODEC_ID_PCM_U8,
214
    CODEC_ID_PCM_MULAW,
215
    CODEC_ID_PCM_ALAW,
216
    CODEC_ID_PCM_S32LE,
217
    CODEC_ID_PCM_S32BE,
218
    CODEC_ID_PCM_U32LE,
219
    CODEC_ID_PCM_U32BE,
220
    CODEC_ID_PCM_S24LE,
221
    CODEC_ID_PCM_S24BE,
222
    CODEC_ID_PCM_U24LE,
223
    CODEC_ID_PCM_U24BE,
224
    CODEC_ID_PCM_S24DAUD,
225
    CODEC_ID_PCM_ZORK,
226
    CODEC_ID_PCM_S16LE_PLANAR,
227
    CODEC_ID_PCM_DVD,
228
    CODEC_ID_PCM_F32BE,
229
    CODEC_ID_PCM_F32LE,
230
    CODEC_ID_PCM_F64BE,
231
    CODEC_ID_PCM_F64LE,
232
    CODEC_ID_PCM_BLURAY,
233

    
234
    /* various ADPCM codecs */
235
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
236
    CODEC_ID_ADPCM_IMA_WAV,
237
    CODEC_ID_ADPCM_IMA_DK3,
238
    CODEC_ID_ADPCM_IMA_DK4,
239
    CODEC_ID_ADPCM_IMA_WS,
240
    CODEC_ID_ADPCM_IMA_SMJPEG,
241
    CODEC_ID_ADPCM_MS,
242
    CODEC_ID_ADPCM_4XM,
243
    CODEC_ID_ADPCM_XA,
244
    CODEC_ID_ADPCM_ADX,
245
    CODEC_ID_ADPCM_EA,
246
    CODEC_ID_ADPCM_G726,
247
    CODEC_ID_ADPCM_CT,
248
    CODEC_ID_ADPCM_SWF,
249
    CODEC_ID_ADPCM_YAMAHA,
250
    CODEC_ID_ADPCM_SBPRO_4,
251
    CODEC_ID_ADPCM_SBPRO_3,
252
    CODEC_ID_ADPCM_SBPRO_2,
253
    CODEC_ID_ADPCM_THP,
254
    CODEC_ID_ADPCM_IMA_AMV,
255
    CODEC_ID_ADPCM_EA_R1,
256
    CODEC_ID_ADPCM_EA_R3,
257
    CODEC_ID_ADPCM_EA_R2,
258
    CODEC_ID_ADPCM_IMA_EA_SEAD,
259
    CODEC_ID_ADPCM_IMA_EA_EACS,
260
    CODEC_ID_ADPCM_EA_XAS,
261
    CODEC_ID_ADPCM_EA_MAXIS_XA,
262
    CODEC_ID_ADPCM_IMA_ISS,
263

    
264
    /* AMR */
265
    CODEC_ID_AMR_NB= 0x12000,
266
    CODEC_ID_AMR_WB,
267

    
268
    /* RealAudio codecs*/
269
    CODEC_ID_RA_144= 0x13000,
270
    CODEC_ID_RA_288,
271

    
272
    /* various DPCM codecs */
273
    CODEC_ID_ROQ_DPCM= 0x14000,
274
    CODEC_ID_INTERPLAY_DPCM,
275
    CODEC_ID_XAN_DPCM,
276
    CODEC_ID_SOL_DPCM,
277

    
278
    /* audio codecs */
279
    CODEC_ID_MP2= 0x15000,
280
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
281
    CODEC_ID_AAC,
282
    CODEC_ID_AC3,
283
    CODEC_ID_DTS,
284
    CODEC_ID_VORBIS,
285
    CODEC_ID_DVAUDIO,
286
    CODEC_ID_WMAV1,
287
    CODEC_ID_WMAV2,
288
    CODEC_ID_MACE3,
289
    CODEC_ID_MACE6,
290
    CODEC_ID_VMDAUDIO,
291
    CODEC_ID_SONIC,
292
    CODEC_ID_SONIC_LS,
293
    CODEC_ID_FLAC,
294
    CODEC_ID_MP3ADU,
295
    CODEC_ID_MP3ON4,
296
    CODEC_ID_SHORTEN,
297
    CODEC_ID_ALAC,
298
    CODEC_ID_WESTWOOD_SND1,
299
    CODEC_ID_GSM, ///< as in Berlin toast format
300
    CODEC_ID_QDM2,
301
    CODEC_ID_COOK,
302
    CODEC_ID_TRUESPEECH,
303
    CODEC_ID_TTA,
304
    CODEC_ID_SMACKAUDIO,
305
    CODEC_ID_QCELP,
306
    CODEC_ID_WAVPACK,
307
    CODEC_ID_DSICINAUDIO,
308
    CODEC_ID_IMC,
309
    CODEC_ID_MUSEPACK7,
310
    CODEC_ID_MLP,
311
    CODEC_ID_GSM_MS, /* as found in WAV */
312
    CODEC_ID_ATRAC3,
313
    CODEC_ID_VOXWARE,
314
    CODEC_ID_APE,
315
    CODEC_ID_NELLYMOSER,
316
    CODEC_ID_MUSEPACK8,
317
    CODEC_ID_SPEEX,
318
    CODEC_ID_WMAVOICE,
319
    CODEC_ID_WMAPRO,
320
    CODEC_ID_WMALOSSLESS,
321
    CODEC_ID_ATRAC3P,
322
    CODEC_ID_EAC3,
323
    CODEC_ID_SIPR,
324
    CODEC_ID_MP1,
325
    CODEC_ID_TWINVQ,
326
    CODEC_ID_TRUEHD,
327
    CODEC_ID_MP4ALS,
328
    CODEC_ID_ATRAC1,
329

    
330
    /* subtitle codecs */
331
    CODEC_ID_DVD_SUBTITLE= 0x17000,
332
    CODEC_ID_DVB_SUBTITLE,
333
    CODEC_ID_TEXT,  ///< raw UTF-8 text
334
    CODEC_ID_XSUB,
335
    CODEC_ID_SSA,
336
    CODEC_ID_MOV_TEXT,
337
    CODEC_ID_HDMV_PGS_SUBTITLE,
338
    CODEC_ID_DVB_TELETEXT,
339

    
340
    /* other specific kind of codecs (generally used for attachments) */
341
    CODEC_ID_TTF= 0x18000,
342

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

    
345
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
346
                                * stream (only used by libavformat) */
347
};
348

    
349
enum CodecType {
350
    CODEC_TYPE_UNKNOWN = -1,
351
    CODEC_TYPE_VIDEO,
352
    CODEC_TYPE_AUDIO,
353
    CODEC_TYPE_DATA,
354
    CODEC_TYPE_SUBTITLE,
355
    CODEC_TYPE_ATTACHMENT,
356
    CODEC_TYPE_NB
357
};
358

    
359
/**
360
 * all in native-endian format
361
 */
362
enum SampleFormat {
363
    SAMPLE_FMT_NONE = -1,
364
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
365
    SAMPLE_FMT_S16,             ///< signed 16 bits
366
    SAMPLE_FMT_S32,             ///< signed 32 bits
367
    SAMPLE_FMT_FLT,             ///< float
368
    SAMPLE_FMT_DBL,             ///< double
369
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
370
};
371

    
372
/* Audio channel masks */
373
#define CH_FRONT_LEFT             0x00000001
374
#define CH_FRONT_RIGHT            0x00000002
375
#define CH_FRONT_CENTER           0x00000004
376
#define CH_LOW_FREQUENCY          0x00000008
377
#define CH_BACK_LEFT              0x00000010
378
#define CH_BACK_RIGHT             0x00000020
379
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
380
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
381
#define CH_BACK_CENTER            0x00000100
382
#define CH_SIDE_LEFT              0x00000200
383
#define CH_SIDE_RIGHT             0x00000400
384
#define CH_TOP_CENTER             0x00000800
385
#define CH_TOP_FRONT_LEFT         0x00001000
386
#define CH_TOP_FRONT_CENTER       0x00002000
387
#define CH_TOP_FRONT_RIGHT        0x00004000
388
#define CH_TOP_BACK_LEFT          0x00008000
389
#define CH_TOP_BACK_CENTER        0x00010000
390
#define CH_TOP_BACK_RIGHT         0x00020000
391
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
392
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
393

    
394
/** Channel mask value used for AVCodecContext.request_channel_layout
395
    to indicate that the user requests the channel order of the decoder output
396
    to be the native codec channel order. */
397
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
398

    
399
/* Audio channel convenience macros */
400
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
401
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
402
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
403
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
404
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
405
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
406
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
407
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
408
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
409
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
410
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
411
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
412
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
413
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
414
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
415
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
416

    
417
/* in bytes */
418
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
419

    
420
/**
421
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
422
 * This is mainly needed because some optimized bitstream readers read
423
 * 32 or 64 bit at once and could read over the end.<br>
424
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
425
 * MPEG bitstreams could cause overread and segfault.
426
 */
427
#define FF_INPUT_BUFFER_PADDING_SIZE 8
428

    
429
/**
430
 * minimum encoding buffer size
431
 * Used to avoid some checks during header writing.
432
 */
433
#define FF_MIN_BUFFER_SIZE 16384
434

    
435

    
436
/**
437
 * motion estimation type.
438
 */
439
enum Motion_Est_ID {
440
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
441
    ME_FULL,
442
    ME_LOG,
443
    ME_PHODS,
444
    ME_EPZS,        ///< enhanced predictive zonal search
445
    ME_X1,          ///< reserved for experiments
446
    ME_HEX,         ///< hexagon based search
447
    ME_UMH,         ///< uneven multi-hexagon search
448
    ME_ITER,        ///< iterative search
449
    ME_TESA,        ///< transformed exhaustive search algorithm
450
};
451

    
452
enum AVDiscard{
453
    /* We leave some space between them for extensions (drop some
454
     * keyframes for intra-only or drop just some bidir frames). */
455
    AVDISCARD_NONE   =-16, ///< discard nothing
456
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
457
    AVDISCARD_NONREF =  8, ///< discard all non reference
458
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
459
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
460
    AVDISCARD_ALL    = 48, ///< discard all
461
};
462

    
463
enum AVColorPrimaries{
464
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
465
    AVCOL_PRI_UNSPECIFIED=2,
466
    AVCOL_PRI_BT470M     =4,
467
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
468
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
469
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
470
    AVCOL_PRI_FILM       =8,
471
    AVCOL_PRI_NB           , ///< Not part of ABI
472
};
473

    
474
enum AVColorTransferCharacteristic{
475
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
476
    AVCOL_TRC_UNSPECIFIED=2,
477
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
478
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
479
    AVCOL_TRC_NB           , ///< Not part of ABI
480
};
481

    
482
enum AVColorSpace{
483
    AVCOL_SPC_RGB        =0,
484
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
485
    AVCOL_SPC_UNSPECIFIED=2,
486
    AVCOL_SPC_FCC        =4,
487
    AVCOL_SPC_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
488
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
489
    AVCOL_SPC_SMPTE240M  =7,
490
    AVCOL_SPC_NB           , ///< Not part of ABI
491
};
492

    
493
enum AVColorRange{
494
    AVCOL_RANGE_UNSPECIFIED=0,
495
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
496
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
497
    AVCOL_RANGE_NB           , ///< Not part of ABI
498
};
499

    
500
/**
501
 *  X   X      3 4 X      X are luma samples,
502
 *             1 2        1-6 are possible chroma positions
503
 *  X   X      5 6 X      0 is undefined/unknown position
504
 */
505
enum AVChromaLocation{
506
    AVCHROMA_LOC_UNSPECIFIED=0,
507
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
508
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
509
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
510
    AVCHROMA_LOC_TOP        =4,
511
    AVCHROMA_LOC_BOTTOMLEFT =5,
512
    AVCHROMA_LOC_BOTTOM     =6,
513
    AVCHROMA_LOC_NB           , ///< Not part of ABI
514
};
515

    
516
typedef struct RcOverride{
517
    int start_frame;
518
    int end_frame;
519
    int qscale; // If this is 0 then quality_factor will be used instead.
520
    float quality_factor;
521
} RcOverride;
522

    
523
#define FF_MAX_B_FRAMES 16
524

    
525
/* encoding support
526
   These flags can be passed in AVCodecContext.flags before initialization.
527
   Note: Not everything is supported yet.
528
*/
529

    
530
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
531
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
532
#define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
533
#define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
534
#define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
535
#define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
536
/**
537
 * The parent program guarantees that the input for B-frames containing
538
 * streams is not written to for at least s->max_b_frames+1 frames, if
539
 * this is not set the input will be copied.
540
 */
541
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
542
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
543
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
544
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
545
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
546
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
547
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
548
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
549
                                                  location instead of only at frame boundaries. */
550
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
551
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
552
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
553
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
554
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
555
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
556
/* Fx : Flag for h263+ extra options */
557
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
558
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
559
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
560
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
561
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
562
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
563
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
564
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
565
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
566
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
567
#define CODEC_FLAG_CLOSED_GOP     0x80000000
568
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
569
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
570
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
571
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
572
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
573
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
574
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
575
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
576
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
577
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
578
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
579
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
580
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
581
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
582
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
583
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
584
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
585
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
586
#define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
587

    
588
/* Unsupported options :
589
 *              Syntax Arithmetic coding (SAC)
590
 *              Reference Picture Selection
591
 *              Independent Segment Decoding */
592
/* /Fx */
593
/* codec capabilities */
594

    
595
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
596
/**
597
 * Codec uses get_buffer() for allocating buffers.
598
 * direct rendering method 1
599
 */
600
#define CODEC_CAP_DR1             0x0002
601
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
602
#define CODEC_CAP_PARSE_ONLY      0x0004
603
#define CODEC_CAP_TRUNCATED       0x0008
604
/* Codec can export data for HW decoding (XvMC). */
605
#define CODEC_CAP_HWACCEL         0x0010
606
/**
607
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
608
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
609
 */
610
#define CODEC_CAP_DELAY           0x0020
611
/**
612
 * Codec can be fed a final frame with a smaller size.
613
 * This can be used to prevent truncation of the last audio samples.
614
 */
615
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
616
/**
617
 * Codec can export data for HW decoding (VDPAU).
618
 */
619
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
620
/**
621
 * Codec can output multiple frames per AVPacket
622
 * Normally demuxers return one frame at a time, demuxers which do not do
623
 * are connected to a parser to split what they return into proper frames.
624
 * This flag is reserved to the very rare category of codecs which have a
625
 * bitstream that cannot be split into frames without timeconsuming
626
 * operations like full decoding. Demuxers carring such bitstreams thus
627
 * may return multiple frames in a packet. This has many disadvantages like
628
 * prohibiting stream copy in many cases thus it should only be considered
629
 * as a last resort.
630
 */
631
#define CODEC_CAP_SUBFRAMES        0x0100
632

    
633
//The following defines may change, don't expect compatibility if you use them.
634
#define MB_TYPE_INTRA4x4   0x0001
635
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
636
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
637
#define MB_TYPE_16x16      0x0008
638
#define MB_TYPE_16x8       0x0010
639
#define MB_TYPE_8x16       0x0020
640
#define MB_TYPE_8x8        0x0040
641
#define MB_TYPE_INTERLACED 0x0080
642
#define MB_TYPE_DIRECT2    0x0100 //FIXME
643
#define MB_TYPE_ACPRED     0x0200
644
#define MB_TYPE_GMC        0x0400
645
#define MB_TYPE_SKIP       0x0800
646
#define MB_TYPE_P0L0       0x1000
647
#define MB_TYPE_P1L0       0x2000
648
#define MB_TYPE_P0L1       0x4000
649
#define MB_TYPE_P1L1       0x8000
650
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
651
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
652
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
653
#define MB_TYPE_QUANT      0x00010000
654
#define MB_TYPE_CBP        0x00020000
655
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
656

    
657
/**
658
 * Pan Scan area.
659
 * This specifies the area which should be displayed.
660
 * Note there may be multiple such areas for one frame.
661
 */
662
typedef struct AVPanScan{
663
    /**
664
     * id
665
     * - encoding: Set by user.
666
     * - decoding: Set by libavcodec.
667
     */
668
    int id;
669

    
670
    /**
671
     * width and height in 1/16 pel
672
     * - encoding: Set by user.
673
     * - decoding: Set by libavcodec.
674
     */
675
    int width;
676
    int height;
677

    
678
    /**
679
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
680
     * - encoding: Set by user.
681
     * - decoding: Set by libavcodec.
682
     */
683
    int16_t position[3][2];
684
}AVPanScan;
685

    
686
#define FF_COMMON_FRAME \
687
    /**\
688
     * pointer to the picture planes.\
689
     * This might be different from the first allocated byte\
690
     * - encoding: \
691
     * - decoding: \
692
     */\
693
    uint8_t *data[4];\
694
    int linesize[4];\
695
    /**\
696
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
697
     * This isn't used by libavcodec unless the default get/release_buffer() is used.\
698
     * - encoding: \
699
     * - decoding: \
700
     */\
701
    uint8_t *base[4];\
702
    /**\
703
     * 1 -> keyframe, 0-> not\
704
     * - encoding: Set by libavcodec.\
705
     * - decoding: Set by libavcodec.\
706
     */\
707
    int key_frame;\
708
\
709
    /**\
710
     * Picture type of the frame, see ?_TYPE below.\
711
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
712
     * - decoding: Set by libavcodec.\
713
     */\
714
    int pict_type;\
715
\
716
    /**\
717
     * presentation timestamp in time_base units (time when frame should be shown to user)\
718
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
719
     * - encoding: MUST be set by user.\
720
     * - decoding: Set by libavcodec.\
721
     */\
722
    int64_t pts;\
723
\
724
    /**\
725
     * picture number in bitstream order\
726
     * - encoding: set by\
727
     * - decoding: Set by libavcodec.\
728
     */\
729
    int coded_picture_number;\
730
    /**\
731
     * picture number in display order\
732
     * - encoding: set by\
733
     * - decoding: Set by libavcodec.\
734
     */\
735
    int display_picture_number;\
736
\
737
    /**\
738
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
739
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
740
     * - decoding: Set by libavcodec.\
741
     */\
742
    int quality; \
743
\
744
    /**\
745
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
746
     * Set to INT_MAX if the buffer has not been used yet.\
747
     * - encoding: unused\
748
     * - decoding: MUST be set by get_buffer().\
749
     */\
750
    int age;\
751
\
752
    /**\
753
     * is this picture used as reference\
754
     * The values for this are the same as the MpegEncContext.picture_structure\
755
     * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
756
     * Set to 4 for delayed, non-reference frames.\
757
     * - encoding: unused\
758
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
759
     */\
760
    int reference;\
761
\
762
    /**\
763
     * QP table\
764
     * - encoding: unused\
765
     * - decoding: Set by libavcodec.\
766
     */\
767
    int8_t *qscale_table;\
768
    /**\
769
     * QP store stride\
770
     * - encoding: unused\
771
     * - decoding: Set by libavcodec.\
772
     */\
773
    int qstride;\
774
\
775
    /**\
776
     * mbskip_table[mb]>=1 if MB didn't change\
777
     * stride= mb_width = (width+15)>>4\
778
     * - encoding: unused\
779
     * - decoding: Set by libavcodec.\
780
     */\
781
    uint8_t *mbskip_table;\
782
\
783
    /**\
784
     * motion vector table\
785
     * @code\
786
     * example:\
787
     * int mv_sample_log2= 4 - motion_subsample_log2;\
788
     * int mb_width= (width+15)>>4;\
789
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
790
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
791
     * @endcode\
792
     * - encoding: Set by user.\
793
     * - decoding: Set by libavcodec.\
794
     */\
795
    int16_t (*motion_val[2])[2];\
796
\
797
    /**\
798
     * macroblock type table\
799
     * mb_type_base + mb_width + 2\
800
     * - encoding: Set by user.\
801
     * - decoding: Set by libavcodec.\
802
     */\
803
    uint32_t *mb_type;\
804
\
805
    /**\
806
     * log2 of the size of the block which a single vector in motion_val represents: \
807
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
808
     * - encoding: unused\
809
     * - decoding: Set by libavcodec.\
810
     */\
811
    uint8_t motion_subsample_log2;\
812
\
813
    /**\
814
     * for some private data of the user\
815
     * - encoding: unused\
816
     * - decoding: Set by user.\
817
     */\
818
    void *opaque;\
819
\
820
    /**\
821
     * error\
822
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
823
     * - decoding: unused\
824
     */\
825
    uint64_t error[4];\
826
\
827
    /**\
828
     * type of the buffer (to keep track of who has to deallocate data[*])\
829
     * - encoding: Set by the one who allocates it.\
830
     * - decoding: Set by the one who allocates it.\
831
     * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
832
     */\
833
    int type;\
834
    \
835
    /**\
836
     * When decoding, this signals how much the picture must be delayed.\
837
     * extra_delay = repeat_pict / (2*fps)\
838
     * - encoding: unused\
839
     * - decoding: Set by libavcodec.\
840
     */\
841
    int repeat_pict;\
842
    \
843
    /**\
844
     * \
845
     */\
846
    int qscale_type;\
847
    \
848
    /**\
849
     * The content of the picture is interlaced.\
850
     * - encoding: Set by user.\
851
     * - decoding: Set by libavcodec. (default 0)\
852
     */\
853
    int interlaced_frame;\
854
    \
855
    /**\
856
     * If the content is interlaced, is top field displayed first.\
857
     * - encoding: Set by user.\
858
     * - decoding: Set by libavcodec.\
859
     */\
860
    int top_field_first;\
861
    \
862
    /**\
863
     * Pan scan.\
864
     * - encoding: Set by user.\
865
     * - decoding: Set by libavcodec.\
866
     */\
867
    AVPanScan *pan_scan;\
868
    \
869
    /**\
870
     * Tell user application that palette has changed from previous frame.\
871
     * - encoding: ??? (no palette-enabled encoder yet)\
872
     * - decoding: Set by libavcodec. (default 0).\
873
     */\
874
    int palette_has_changed;\
875
    \
876
    /**\
877
     * codec suggestion on buffer type if != 0\
878
     * - encoding: unused\
879
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
880
     */\
881
    int buffer_hints;\
882
\
883
    /**\
884
     * DCT coefficients\
885
     * - encoding: unused\
886
     * - decoding: Set by libavcodec.\
887
     */\
888
    short *dct_coeff;\
889
\
890
    /**\
891
     * motion referece frame index\
892
     * - encoding: Set by user.\
893
     * - decoding: Set by libavcodec.\
894
     */\
895
    int8_t *ref_index[2];\
896
\
897
    /**\
898
     * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
899
     * output in AVFrame.reordered_opaque\
900
     * - encoding: unused\
901
     * - decoding: Read by user.\
902
     */\
903
    int64_t reordered_opaque;\
904
\
905
    /**\
906
     * hardware accelerator private data (FFmpeg allocated)\
907
     * - encoding: unused\
908
     * - decoding: Set by libavcodec\
909
     */\
910
    void *hwaccel_picture_private;\
911

    
912

    
913
#define FF_QSCALE_TYPE_MPEG1 0
914
#define FF_QSCALE_TYPE_MPEG2 1
915
#define FF_QSCALE_TYPE_H264  2
916

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

    
922

    
923
#define FF_I_TYPE  1 ///< Intra
924
#define FF_P_TYPE  2 ///< Predicted
925
#define FF_B_TYPE  3 ///< Bi-dir predicted
926
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
927
#define FF_SI_TYPE 5 ///< Switching Intra
928
#define FF_SP_TYPE 6 ///< Switching Predicted
929
#define FF_BI_TYPE 7
930

    
931
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
932
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
933
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
934
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
935

    
936
typedef struct AVPacket {
937
    /**
938
     * Presentation timestamp in AVStream->time_base units; the time at which
939
     * the decompressed packet will be presented to the user.
940
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
941
     * pts MUST be larger or equal to dts as presentation cannot happen before
942
     * decompression, unless one wants to view hex dumps. Some formats misuse
943
     * the terms dts and pts/cts to mean something different. Such timestamps
944
     * must be converted to true pts/dts before they are stored in AVPacket.
945
     */
946
    int64_t pts;
947
    /**
948
     * Decompression timestamp in AVStream->time_base units; the time at which
949
     * the packet is decompressed.
950
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
951
     */
952
    int64_t dts;
953
    uint8_t *data;
954
    int   size;
955
    int   stream_index;
956
    int   flags;
957
    /**
958
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
959
     * Equals next_pts - this_pts in presentation order.
960
     */
961
    int   duration;
962
    void  (*destruct)(struct AVPacket *);
963
    void  *priv;
964
    int64_t pos;                            ///< byte position in stream, -1 if unknown
965

    
966
    /**
967
     * Time difference in AVStream->time_base units from the pts of this
968
     * packet to the point at which the output from the decoder has converged
969
     * independent from the availability of previous frames. That is, the
970
     * frames are virtually identical no matter if decoding started from
971
     * the very first frame or from this keyframe.
972
     * Is AV_NOPTS_VALUE if unknown.
973
     * This field is not the display duration of the current packet.
974
     *
975
     * The purpose of this field is to allow seeking in streams that have no
976
     * keyframes in the conventional sense. It corresponds to the
977
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
978
     * essential for some types of subtitle streams to ensure that all
979
     * subtitles are correctly displayed after seeking.
980
     */
981
    int64_t convergence_duration;
982
} AVPacket;
983
#define AV_PKT_FLAG_KEY   0x0001
984
#if LIBAVCODEC_VERSION_MAJOR < 53
985
#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
986
#endif
987

    
988
/**
989
 * Audio Video Frame.
990
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
991
 * bumps.
992
 * Removal, reordering and changes to existing fields require a major
993
 * version bump. No fields should be added into AVFrame before or after
994
 * FF_COMMON_FRAME!
995
 * sizeof(AVFrame) must not be used outside libav*.
996
 */
997
typedef struct AVFrame {
998
    FF_COMMON_FRAME
999
} AVFrame;
1000

    
1001
/**
1002
 * main external API structure.
1003
 * New fields can be added to the end with minor version bumps.
1004
 * Removal, reordering and changes to existing fields require a major
1005
 * version bump.
1006
 * sizeof(AVCodecContext) must not be used outside libav*.
1007
 */
1008
typedef struct AVCodecContext {
1009
    /**
1010
     * information on struct for av_log
1011
     * - set by avcodec_alloc_context
1012
     */
1013
    const AVClass *av_class;
1014
    /**
1015
     * the average bitrate
1016
     * - encoding: Set by user; unused for constant quantizer encoding.
1017
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1018
     */
1019
    int bit_rate;
1020

    
1021
    /**
1022
     * number of bits the bitstream is allowed to diverge from the reference.
1023
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1024
     * - encoding: Set by user; unused for constant quantizer encoding.
1025
     * - decoding: unused
1026
     */
1027
    int bit_rate_tolerance;
1028

    
1029
    /**
1030
     * CODEC_FLAG_*.
1031
     * - encoding: Set by user.
1032
     * - decoding: Set by user.
1033
     */
1034
    int flags;
1035

    
1036
    /**
1037
     * Some codecs need additional format info. It is stored here.
1038
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1039
     * specific codec MUST set it correctly otherwise stream copy breaks.
1040
     * In general use of this field by muxers is not recommanded.
1041
     * - encoding: Set by libavcodec.
1042
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1043
     */
1044
    int sub_id;
1045

    
1046
    /**
1047
     * Motion estimation algorithm used for video coding.
1048
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1049
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1050
     * - encoding: MUST be set by user.
1051
     * - decoding: unused
1052
     */
1053
    int me_method;
1054

    
1055
    /**
1056
     * some codecs need / can use extradata like Huffman tables.
1057
     * mjpeg: Huffman tables
1058
     * rv10: additional flags
1059
     * mpeg4: global headers (they can be in the bitstream or here)
1060
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1061
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1062
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1063
     * - encoding: Set/allocated/freed by libavcodec.
1064
     * - decoding: Set/allocated/freed by user.
1065
     */
1066
    uint8_t *extradata;
1067
    int extradata_size;
1068

    
1069
    /**
1070
     * This is the fundamental unit of time (in seconds) in terms
1071
     * of which frame timestamps are represented. For fixed-fps content,
1072
     * timebase should be 1/framerate and timestamp increments should be
1073
     * identically 1.
1074
     * - encoding: MUST be set by user.
1075
     * - decoding: Set by libavcodec.
1076
     */
1077
    AVRational time_base;
1078

    
1079
    /* video only */
1080
    /**
1081
     * picture width / height.
1082
     * - encoding: MUST be set by user.
1083
     * - decoding: Set by libavcodec.
1084
     * Note: For compatibility it is possible to set this instead of
1085
     * coded_width/height before decoding.
1086
     */
1087
    int width, height;
1088

    
1089
#define FF_ASPECT_EXTENDED 15
1090

    
1091
    /**
1092
     * the number of pictures in a group of pictures, or 0 for intra_only
1093
     * - encoding: Set by user.
1094
     * - decoding: unused
1095
     */
1096
    int gop_size;
1097

    
1098
    /**
1099
     * Pixel format, see PIX_FMT_xxx.
1100
     * - encoding: Set by user.
1101
     * - decoding: Set by libavcodec.
1102
     */
1103
    enum PixelFormat pix_fmt;
1104

    
1105
    /**
1106
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1107
     * has to read frames at native frame rate.
1108
     * - encoding: Set by user.
1109
     * - decoding: unused
1110
     */
1111
    int rate_emu;
1112

    
1113
    /**
1114
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1115
     * decoder to draw a horizontal band. It improves cache usage. Not
1116
     * all codecs can do that. You must check the codec capabilities
1117
     * beforehand.
1118
     * The function is also used by hardware acceleration APIs.
1119
     * It is called at least once during frame decoding to pass
1120
     * the data needed for hardware render.
1121
     * In that mode instead of pixel data, AVFrame points to
1122
     * a structure specific to the acceleration API. The application
1123
     * reads the structure and can change some fields to indicate progress
1124
     * or mark state.
1125
     * - encoding: unused
1126
     * - decoding: Set by user.
1127
     * @param height the height of the slice
1128
     * @param y the y position of the slice
1129
     * @param type 1->top field, 2->bottom field, 3->frame
1130
     * @param offset offset into the AVFrame.data from which the slice should be read
1131
     */
1132
    void (*draw_horiz_band)(struct AVCodecContext *s,
1133
                            const AVFrame *src, int offset[4],
1134
                            int y, int type, int height);
1135

    
1136
    /* audio only */
1137
    int sample_rate; ///< samples per second
1138
    int channels;    ///< number of audio channels
1139

    
1140
    /**
1141
     * audio sample format
1142
     * - encoding: Set by user.
1143
     * - decoding: Set by libavcodec.
1144
     */
1145
    enum SampleFormat sample_fmt;  ///< sample format
1146

    
1147
    /* The following data should not be initialized. */
1148
    /**
1149
     * Samples per packet, initialized when calling 'init'.
1150
     */
1151
    int frame_size;
1152
    int frame_number;   ///< audio or video frame number
1153
#if LIBAVCODEC_VERSION_MAJOR < 53
1154
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1155
#endif
1156

    
1157
    /**
1158
     * Number of frames the decoded output will be delayed relative to
1159
     * the encoded input.
1160
     * - encoding: Set by libavcodec.
1161
     * - decoding: unused
1162
     */
1163
    int delay;
1164

    
1165
    /* - encoding parameters */
1166
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1167
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1168

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

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

    
1183
    /**
1184
     * maximum quantizer difference between frames
1185
     * - encoding: Set by user.
1186
     * - decoding: unused
1187
     */
1188
    int max_qdiff;
1189

    
1190
    /**
1191
     * maximum number of B-frames between non-B-frames
1192
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1193
     * - encoding: Set by user.
1194
     * - decoding: unused
1195
     */
1196
    int max_b_frames;
1197

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

    
1207
    /** obsolete FIXME remove */
1208
    int rc_strategy;
1209
#define FF_RC_STRATEGY_XVID 1
1210

    
1211
    int b_frame_strategy;
1212

    
1213
    /**
1214
     * hurry up amount
1215
     * - encoding: unused
1216
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1217
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1218
     */
1219
    int hurry_up;
1220

    
1221
    struct AVCodec *codec;
1222

    
1223
    void *priv_data;
1224

    
1225
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1226
                            /* do its best to deliver a chunk with size     */
1227
                            /* below rtp_payload_size, the chunk will start */
1228
                            /* with a start code on some codecs like H.263. */
1229
                            /* This doesn't take account of any particular  */
1230
                            /* headers inside the transmitted RTP payload.  */
1231

    
1232

    
1233
    /* The RTP callback: This function is called    */
1234
    /* every time the encoder has a packet to send. */
1235
    /* It depends on the encoder if the data starts */
1236
    /* with a Start Code (it should). H.263 does.   */
1237
    /* mb_nb contains the number of macroblocks     */
1238
    /* encoded in the RTP payload.                  */
1239
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1240

    
1241
    /* statistics, used for 2-pass encoding */
1242
    int mv_bits;
1243
    int header_bits;
1244
    int i_tex_bits;
1245
    int p_tex_bits;
1246
    int i_count;
1247
    int p_count;
1248
    int skip_count;
1249
    int misc_bits;
1250

    
1251
    /**
1252
     * number of bits used for the previously encoded frame
1253
     * - encoding: Set by libavcodec.
1254
     * - decoding: unused
1255
     */
1256
    int frame_bits;
1257

    
1258
    /**
1259
     * Private data of the user, can be used to carry app specific stuff.
1260
     * - encoding: Set by user.
1261
     * - decoding: Set by user.
1262
     */
1263
    void *opaque;
1264

    
1265
    char codec_name[32];
1266
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1267
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1268

    
1269
    /**
1270
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1271
     * This is used to work around some encoder bugs.
1272
     * A demuxer should set this to what is stored in the field used to identify the codec.
1273
     * If there are multiple such fields in a container then the demuxer should choose the one
1274
     * which maximizes the information about the used codec.
1275
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1276
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1277
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1278
     * first.
1279
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1280
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1281
     */
1282
    unsigned int codec_tag;
1283

    
1284
    /**
1285
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1286
     * - encoding: Set by user
1287
     * - decoding: Set by user
1288
     */
1289
    int workaround_bugs;
1290
#define FF_BUG_AUTODETECT       1  ///< autodetection
1291
#define FF_BUG_OLD_MSMPEG4      2
1292
#define FF_BUG_XVID_ILACE       4
1293
#define FF_BUG_UMP4             8
1294
#define FF_BUG_NO_PADDING       16
1295
#define FF_BUG_AMV              32
1296
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1297
#define FF_BUG_QPEL_CHROMA      64
1298
#define FF_BUG_STD_QPEL         128
1299
#define FF_BUG_QPEL_CHROMA2     256
1300
#define FF_BUG_DIRECT_BLOCKSIZE 512
1301
#define FF_BUG_EDGE             1024
1302
#define FF_BUG_HPEL_CHROMA      2048
1303
#define FF_BUG_DC_CLIP          4096
1304
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1305
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1306

    
1307
    /**
1308
     * luma single coefficient elimination threshold
1309
     * - encoding: Set by user.
1310
     * - decoding: unused
1311
     */
1312
    int luma_elim_threshold;
1313

    
1314
    /**
1315
     * chroma single coeff elimination threshold
1316
     * - encoding: Set by user.
1317
     * - decoding: unused
1318
     */
1319
    int chroma_elim_threshold;
1320

    
1321
    /**
1322
     * strictly follow the standard (MPEG4, ...).
1323
     * - encoding: Set by user.
1324
     * - decoding: Set by user.
1325
     * Setting this to STRICT or higher means the encoder and decoder will
1326
     * generally do stupid things. While setting it to inofficial or lower
1327
     * will mean the encoder might use things that are not supported by all
1328
     * spec compliant decoders. Decoders make no difference between normal,
1329
     * inofficial and experimental, that is they always try to decode things
1330
     * when they can unless they are explicitly asked to behave stupid
1331
     * (=strictly conform to the specs)
1332
     */
1333
    int strict_std_compliance;
1334
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1335
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1336
#define FF_COMPLIANCE_NORMAL        0
1337
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1338
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1339

    
1340
    /**
1341
     * qscale offset between IP and B-frames
1342
     * - encoding: Set by user.
1343
     * - decoding: unused
1344
     */
1345
    float b_quant_offset;
1346

    
1347
    /**
1348
     * Error recognization; higher values will detect more errors but may
1349
     * misdetect some more or less valid parts as errors.
1350
     * - encoding: unused
1351
     * - decoding: Set by user.
1352
     */
1353
    int error_recognition;
1354
#define FF_ER_CAREFUL         1
1355
#define FF_ER_COMPLIANT       2
1356
#define FF_ER_AGGRESSIVE      3
1357
#define FF_ER_VERY_AGGRESSIVE 4
1358

    
1359
    /**
1360
     * Called at the beginning of each frame to get a buffer for it.
1361
     * If pic.reference is set then the frame will be read later by libavcodec.
1362
     * avcodec_align_dimensions() should be used to find the required width and
1363
     * height, as they normally need to be rounded up to the next multiple of 16.
1364
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1365
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1366
     * some other means.
1367
     * - encoding: unused
1368
     * - decoding: Set by libavcodec., user can override.
1369
     */
1370
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1371

    
1372
    /**
1373
     * Called to release buffers which were allocated with get_buffer.
1374
     * A released buffer can be reused in get_buffer().
1375
     * pic.data[*] must be set to NULL.
1376
     * - encoding: unused
1377
     * - decoding: Set by libavcodec., user can override.
1378
     */
1379
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1380

    
1381
    /**
1382
     * Size of the frame reordering buffer in the decoder.
1383
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1384
     * - encoding: Set by libavcodec.
1385
     * - decoding: Set by libavcodec.
1386
     */
1387
    int has_b_frames;
1388

    
1389
    /**
1390
     * number of bytes per packet if constant and known or 0
1391
     * Used by some WAV based audio codecs.
1392
     */
1393
    int block_align;
1394

    
1395
    int parse_only; /* - decoding only: If true, only parsing is done
1396
                       (function avcodec_parse_frame()). The frame
1397
                       data is returned. Only MPEG codecs support this now. */
1398

    
1399
    /**
1400
     * 0-> h263 quant 1-> mpeg quant
1401
     * - encoding: Set by user.
1402
     * - decoding: unused
1403
     */
1404
    int mpeg_quant;
1405

    
1406
    /**
1407
     * pass1 encoding statistics output buffer
1408
     * - encoding: Set by libavcodec.
1409
     * - decoding: unused
1410
     */
1411
    char *stats_out;
1412

    
1413
    /**
1414
     * pass2 encoding statistics input buffer
1415
     * Concatenated stuff from stats_out of pass1 should be placed here.
1416
     * - encoding: Allocated/set/freed by user.
1417
     * - decoding: unused
1418
     */
1419
    char *stats_in;
1420

    
1421
    /**
1422
     * ratecontrol qmin qmax limiting method
1423
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1424
     * - encoding: Set by user.
1425
     * - decoding: unused
1426
     */
1427
    float rc_qsquish;
1428

    
1429
    float rc_qmod_amp;
1430
    int rc_qmod_freq;
1431

    
1432
    /**
1433
     * ratecontrol override, see RcOverride
1434
     * - encoding: Allocated/set/freed by user.
1435
     * - decoding: unused
1436
     */
1437
    RcOverride *rc_override;
1438
    int rc_override_count;
1439

    
1440
    /**
1441
     * rate control equation
1442
     * - encoding: Set by user
1443
     * - decoding: unused
1444
     */
1445
    const char *rc_eq;
1446

    
1447
    /**
1448
     * maximum bitrate
1449
     * - encoding: Set by user.
1450
     * - decoding: unused
1451
     */
1452
    int rc_max_rate;
1453

    
1454
    /**
1455
     * minimum bitrate
1456
     * - encoding: Set by user.
1457
     * - decoding: unused
1458
     */
1459
    int rc_min_rate;
1460

    
1461
    /**
1462
     * decoder bitstream buffer size
1463
     * - encoding: Set by user.
1464
     * - decoding: unused
1465
     */
1466
    int rc_buffer_size;
1467
    float rc_buffer_aggressivity;
1468

    
1469
    /**
1470
     * qscale factor between P and I-frames
1471
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1472
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1473
     * - encoding: Set by user.
1474
     * - decoding: unused
1475
     */
1476
    float i_quant_factor;
1477

    
1478
    /**
1479
     * qscale offset between P and I-frames
1480
     * - encoding: Set by user.
1481
     * - decoding: unused
1482
     */
1483
    float i_quant_offset;
1484

    
1485
    /**
1486
     * initial complexity for pass1 ratecontrol
1487
     * - encoding: Set by user.
1488
     * - decoding: unused
1489
     */
1490
    float rc_initial_cplx;
1491

    
1492
    /**
1493
     * DCT algorithm, see FF_DCT_* below
1494
     * - encoding: Set by user.
1495
     * - decoding: unused
1496
     */
1497
    int dct_algo;
1498
#define FF_DCT_AUTO    0
1499
#define FF_DCT_FASTINT 1
1500
#define FF_DCT_INT     2
1501
#define FF_DCT_MMX     3
1502
#define FF_DCT_MLIB    4
1503
#define FF_DCT_ALTIVEC 5
1504
#define FF_DCT_FAAN    6
1505

    
1506
    /**
1507
     * luminance masking (0-> disabled)
1508
     * - encoding: Set by user.
1509
     * - decoding: unused
1510
     */
1511
    float lumi_masking;
1512

    
1513
    /**
1514
     * temporary complexity masking (0-> disabled)
1515
     * - encoding: Set by user.
1516
     * - decoding: unused
1517
     */
1518
    float temporal_cplx_masking;
1519

    
1520
    /**
1521
     * spatial complexity masking (0-> disabled)
1522
     * - encoding: Set by user.
1523
     * - decoding: unused
1524
     */
1525
    float spatial_cplx_masking;
1526

    
1527
    /**
1528
     * p block masking (0-> disabled)
1529
     * - encoding: Set by user.
1530
     * - decoding: unused
1531
     */
1532
    float p_masking;
1533

    
1534
    /**
1535
     * darkness masking (0-> disabled)
1536
     * - encoding: Set by user.
1537
     * - decoding: unused
1538
     */
1539
    float dark_masking;
1540

    
1541
    /**
1542
     * IDCT algorithm, see FF_IDCT_* below.
1543
     * - encoding: Set by user.
1544
     * - decoding: Set by user.
1545
     */
1546
    int idct_algo;
1547
#define FF_IDCT_AUTO          0
1548
#define FF_IDCT_INT           1
1549
#define FF_IDCT_SIMPLE        2
1550
#define FF_IDCT_SIMPLEMMX     3
1551
#define FF_IDCT_LIBMPEG2MMX   4
1552
#define FF_IDCT_PS2           5
1553
#define FF_IDCT_MLIB          6
1554
#define FF_IDCT_ARM           7
1555
#define FF_IDCT_ALTIVEC       8
1556
#define FF_IDCT_SH4           9
1557
#define FF_IDCT_SIMPLEARM     10
1558
#define FF_IDCT_H264          11
1559
#define FF_IDCT_VP3           12
1560
#define FF_IDCT_IPP           13
1561
#define FF_IDCT_XVIDMMX       14
1562
#define FF_IDCT_CAVS          15
1563
#define FF_IDCT_SIMPLEARMV5TE 16
1564
#define FF_IDCT_SIMPLEARMV6   17
1565
#define FF_IDCT_SIMPLEVIS     18
1566
#define FF_IDCT_WMV2          19
1567
#define FF_IDCT_FAAN          20
1568
#define FF_IDCT_EA            21
1569
#define FF_IDCT_SIMPLENEON    22
1570
#define FF_IDCT_SIMPLEALPHA   23
1571

    
1572
    /**
1573
     * slice count
1574
     * - encoding: Set by libavcodec.
1575
     * - decoding: Set by user (or 0).
1576
     */
1577
    int slice_count;
1578
    /**
1579
     * slice offsets in the frame in bytes
1580
     * - encoding: Set/allocated by libavcodec.
1581
     * - decoding: Set/allocated by user (or NULL).
1582
     */
1583
    int *slice_offset;
1584

    
1585
    /**
1586
     * error concealment flags
1587
     * - encoding: unused
1588
     * - decoding: Set by user.
1589
     */
1590
    int error_concealment;
1591
#define FF_EC_GUESS_MVS   1
1592
#define FF_EC_DEBLOCK     2
1593

    
1594
    /**
1595
     * dsp_mask could be add used to disable unwanted CPU features
1596
     * CPU features (i.e. MMX, SSE. ...)
1597
     *
1598
     * With the FORCE flag you may instead enable given CPU features.
1599
     * (Dangerous: Usable in case of misdetection, improper usage however will
1600
     * result into program crash.)
1601
     */
1602
    unsigned dsp_mask;
1603
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1604
    /* lower 16 bits - CPU features */
1605
#define FF_MM_MMX      0x0001 ///< standard MMX
1606
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1607
#if LIBAVCODEC_VERSION_MAJOR < 53
1608
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1609
#endif
1610
#define FF_MM_MMX2     0x0002 ///< SSE integer functions or AMD MMX ext
1611
#define FF_MM_SSE      0x0008 ///< SSE functions
1612
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1613
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1614
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1615
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1616
#define FF_MM_SSE4     0x0100 ///< Penryn SSE4.1 functions
1617
#define FF_MM_SSE42    0x0200 ///< Nehalem SSE4.2 functions
1618
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1619
#define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
1620

    
1621
    /**
1622
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1623
     * - encoding: Set by libavcodec.
1624
     * - decoding: Set by user.
1625
     */
1626
     int bits_per_coded_sample;
1627

    
1628
    /**
1629
     * prediction method (needed for huffyuv)
1630
     * - encoding: Set by user.
1631
     * - decoding: unused
1632
     */
1633
     int prediction_method;
1634
#define FF_PRED_LEFT   0
1635
#define FF_PRED_PLANE  1
1636
#define FF_PRED_MEDIAN 2
1637

    
1638
    /**
1639
     * sample aspect ratio (0 if unknown)
1640
     * That is the width of a pixel divided by the height of the pixel.
1641
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1642
     * - encoding: Set by user.
1643
     * - decoding: Set by libavcodec.
1644
     */
1645
    AVRational sample_aspect_ratio;
1646

    
1647
    /**
1648
     * the picture in the bitstream
1649
     * - encoding: Set by libavcodec.
1650
     * - decoding: Set by libavcodec.
1651
     */
1652
    AVFrame *coded_frame;
1653

    
1654
    /**
1655
     * debug
1656
     * - encoding: Set by user.
1657
     * - decoding: Set by user.
1658
     */
1659
    int debug;
1660
#define FF_DEBUG_PICT_INFO   1
1661
#define FF_DEBUG_RC          2
1662
#define FF_DEBUG_BITSTREAM   4
1663
#define FF_DEBUG_MB_TYPE     8
1664
#define FF_DEBUG_QP          16
1665
#define FF_DEBUG_MV          32
1666
#define FF_DEBUG_DCT_COEFF   0x00000040
1667
#define FF_DEBUG_SKIP        0x00000080
1668
#define FF_DEBUG_STARTCODE   0x00000100
1669
#define FF_DEBUG_PTS         0x00000200
1670
#define FF_DEBUG_ER          0x00000400
1671
#define FF_DEBUG_MMCO        0x00000800
1672
#define FF_DEBUG_BUGS        0x00001000
1673
#define FF_DEBUG_VIS_QP      0x00002000
1674
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1675
#define FF_DEBUG_BUFFERS     0x00008000
1676

    
1677
    /**
1678
     * debug
1679
     * - encoding: Set by user.
1680
     * - decoding: Set by user.
1681
     */
1682
    int debug_mv;
1683
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1684
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1685
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1686

    
1687
    /**
1688
     * error
1689
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1690
     * - decoding: unused
1691
     */
1692
    uint64_t error[4];
1693

    
1694
    /**
1695
     * minimum MB quantizer
1696
     * - encoding: unused
1697
     * - decoding: unused
1698
     */
1699
    int mb_qmin;
1700

    
1701
    /**
1702
     * maximum MB quantizer
1703
     * - encoding: unused
1704
     * - decoding: unused
1705
     */
1706
    int mb_qmax;
1707

    
1708
    /**
1709
     * motion estimation comparison function
1710
     * - encoding: Set by user.
1711
     * - decoding: unused
1712
     */
1713
    int me_cmp;
1714
    /**
1715
     * subpixel motion estimation comparison function
1716
     * - encoding: Set by user.
1717
     * - decoding: unused
1718
     */
1719
    int me_sub_cmp;
1720
    /**
1721
     * macroblock comparison function (not supported yet)
1722
     * - encoding: Set by user.
1723
     * - decoding: unused
1724
     */
1725
    int mb_cmp;
1726
    /**
1727
     * interlaced DCT comparison function
1728
     * - encoding: Set by user.
1729
     * - decoding: unused
1730
     */
1731
    int ildct_cmp;
1732
#define FF_CMP_SAD    0
1733
#define FF_CMP_SSE    1
1734
#define FF_CMP_SATD   2
1735
#define FF_CMP_DCT    3
1736
#define FF_CMP_PSNR   4
1737
#define FF_CMP_BIT    5
1738
#define FF_CMP_RD     6
1739
#define FF_CMP_ZERO   7
1740
#define FF_CMP_VSAD   8
1741
#define FF_CMP_VSSE   9
1742
#define FF_CMP_NSSE   10
1743
#define FF_CMP_W53    11
1744
#define FF_CMP_W97    12
1745
#define FF_CMP_DCTMAX 13
1746
#define FF_CMP_DCT264 14
1747
#define FF_CMP_CHROMA 256
1748

    
1749
    /**
1750
     * ME diamond size & shape
1751
     * - encoding: Set by user.
1752
     * - decoding: unused
1753
     */
1754
    int dia_size;
1755

    
1756
    /**
1757
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1758
     * - encoding: Set by user.
1759
     * - decoding: unused
1760
     */
1761
    int last_predictor_count;
1762

    
1763
    /**
1764
     * prepass for motion estimation
1765
     * - encoding: Set by user.
1766
     * - decoding: unused
1767
     */
1768
    int pre_me;
1769

    
1770
    /**
1771
     * motion estimation prepass comparison function
1772
     * - encoding: Set by user.
1773
     * - decoding: unused
1774
     */
1775
    int me_pre_cmp;
1776

    
1777
    /**
1778
     * ME prepass diamond size & shape
1779
     * - encoding: Set by user.
1780
     * - decoding: unused
1781
     */
1782
    int pre_dia_size;
1783

    
1784
    /**
1785
     * subpel ME quality
1786
     * - encoding: Set by user.
1787
     * - decoding: unused
1788
     */
1789
    int me_subpel_quality;
1790

    
1791
    /**
1792
     * callback to negotiate the pixelFormat
1793
     * @param fmt is the list of formats which are supported by the codec,
1794
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1795
     * The first is always the native one.
1796
     * @return the chosen format
1797
     * - encoding: unused
1798
     * - decoding: Set by user, if not set the native format will be chosen.
1799
     */
1800
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1801

    
1802
    /**
1803
     * DTG active format information (additional aspect ratio
1804
     * information only used in DVB MPEG-2 transport streams)
1805
     * 0 if not set.
1806
     *
1807
     * - encoding: unused
1808
     * - decoding: Set by decoder.
1809
     */
1810
    int dtg_active_format;
1811
#define FF_DTG_AFD_SAME         8
1812
#define FF_DTG_AFD_4_3          9
1813
#define FF_DTG_AFD_16_9         10
1814
#define FF_DTG_AFD_14_9         11
1815
#define FF_DTG_AFD_4_3_SP_14_9  13
1816
#define FF_DTG_AFD_16_9_SP_14_9 14
1817
#define FF_DTG_AFD_SP_4_3       15
1818

    
1819
    /**
1820
     * maximum motion estimation search range in subpel units
1821
     * If 0 then no limit.
1822
     *
1823
     * - encoding: Set by user.
1824
     * - decoding: unused
1825
     */
1826
    int me_range;
1827

    
1828
    /**
1829
     * intra quantizer bias
1830
     * - encoding: Set by user.
1831
     * - decoding: unused
1832
     */
1833
    int intra_quant_bias;
1834
#define FF_DEFAULT_QUANT_BIAS 999999
1835

    
1836
    /**
1837
     * inter quantizer bias
1838
     * - encoding: Set by user.
1839
     * - decoding: unused
1840
     */
1841
    int inter_quant_bias;
1842

    
1843
    /**
1844
     * color table ID
1845
     * - encoding: unused
1846
     * - decoding: Which clrtable should be used for 8bit RGB images.
1847
     *             Tables have to be stored somewhere. FIXME
1848
     */
1849
    int color_table_id;
1850

    
1851
    /**
1852
     * internal_buffer count
1853
     * Don't touch, used by libavcodec default_get_buffer().
1854
     */
1855
    int internal_buffer_count;
1856

    
1857
    /**
1858
     * internal_buffers
1859
     * Don't touch, used by libavcodec default_get_buffer().
1860
     */
1861
    void *internal_buffer;
1862

    
1863
#define FF_LAMBDA_SHIFT 7
1864
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1865
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1866
#define FF_LAMBDA_MAX (256*128-1)
1867

    
1868
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1869
    /**
1870
     * Global quality for codecs which cannot change it per frame.
1871
     * This should be proportional to MPEG-1/2/4 qscale.
1872
     * - encoding: Set by user.
1873
     * - decoding: unused
1874
     */
1875
    int global_quality;
1876

    
1877
#define FF_CODER_TYPE_VLC       0
1878
#define FF_CODER_TYPE_AC        1
1879
#define FF_CODER_TYPE_RAW       2
1880
#define FF_CODER_TYPE_RLE       3
1881
#define FF_CODER_TYPE_DEFLATE   4
1882
    /**
1883
     * coder type
1884
     * - encoding: Set by user.
1885
     * - decoding: unused
1886
     */
1887
    int coder_type;
1888

    
1889
    /**
1890
     * context model
1891
     * - encoding: Set by user.
1892
     * - decoding: unused
1893
     */
1894
    int context_model;
1895
#if 0
1896
    /**
1897
     *
1898
     * - encoding: unused
1899
     * - decoding: Set by user.
1900
     */
1901
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1902
#endif
1903

    
1904
    /**
1905
     * slice flags
1906
     * - encoding: unused
1907
     * - decoding: Set by user.
1908
     */
1909
    int slice_flags;
1910
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1911
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1912
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1913

    
1914
    /**
1915
     * XVideo Motion Acceleration
1916
     * - encoding: forbidden
1917
     * - decoding: set by decoder
1918
     */
1919
    int xvmc_acceleration;
1920

    
1921
    /**
1922
     * macroblock decision mode
1923
     * - encoding: Set by user.
1924
     * - decoding: unused
1925
     */
1926
    int mb_decision;
1927
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1928
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1929
#define FF_MB_DECISION_RD     2        ///< rate distortion
1930

    
1931
    /**
1932
     * custom intra quantization matrix
1933
     * - encoding: Set by user, can be NULL.
1934
     * - decoding: Set by libavcodec.
1935
     */
1936
    uint16_t *intra_matrix;
1937

    
1938
    /**
1939
     * custom inter quantization matrix
1940
     * - encoding: Set by user, can be NULL.
1941
     * - decoding: Set by libavcodec.
1942
     */
1943
    uint16_t *inter_matrix;
1944

    
1945
    /**
1946
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1947
     * This is used to work around some encoder bugs.
1948
     * - encoding: unused
1949
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1950
     */
1951
    unsigned int stream_codec_tag;
1952

    
1953
    /**
1954
     * scene change detection threshold
1955
     * 0 is default, larger means fewer detected scene changes.
1956
     * - encoding: Set by user.
1957
     * - decoding: unused
1958
     */
1959
    int scenechange_threshold;
1960

    
1961
    /**
1962
     * minimum Lagrange multipler
1963
     * - encoding: Set by user.
1964
     * - decoding: unused
1965
     */
1966
    int lmin;
1967

    
1968
    /**
1969
     * maximum Lagrange multipler
1970
     * - encoding: Set by user.
1971
     * - decoding: unused
1972
     */
1973
    int lmax;
1974

    
1975
    /**
1976
     * palette control structure
1977
     * - encoding: ??? (no palette-enabled encoder yet)
1978
     * - decoding: Set by user.
1979
     */
1980
    struct AVPaletteControl *palctrl;
1981

    
1982
    /**
1983
     * noise reduction strength
1984
     * - encoding: Set by user.
1985
     * - decoding: unused
1986
     */
1987
    int noise_reduction;
1988

    
1989
    /**
1990
     * Called at the beginning of a frame to get cr buffer for it.
1991
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1992
     * libavcodec will pass previous buffer in pic, function should return
1993
     * same buffer or new buffer with old frame "painted" into it.
1994
     * If pic.data[0] == NULL must behave like get_buffer().
1995
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1996
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
1997
     * some other means.
1998
     * - encoding: unused
1999
     * - decoding: Set by libavcodec., user can override
2000
     */
2001
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2002

    
2003
    /**
2004
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2005
     * - encoding: Set by user.
2006
     * - decoding: unused
2007
     */
2008
    int rc_initial_buffer_occupancy;
2009

    
2010
    /**
2011
     *
2012
     * - encoding: Set by user.
2013
     * - decoding: unused
2014
     */
2015
    int inter_threshold;
2016

    
2017
    /**
2018
     * CODEC_FLAG2_*
2019
     * - encoding: Set by user.
2020
     * - decoding: Set by user.
2021
     */
2022
    int flags2;
2023

    
2024
    /**
2025
     * Simulates errors in the bitstream to test error concealment.
2026
     * - encoding: Set by user.
2027
     * - decoding: unused
2028
     */
2029
    int error_rate;
2030

    
2031
    /**
2032
     * MP3 antialias algorithm, see FF_AA_* below.
2033
     * - encoding: unused
2034
     * - decoding: Set by user.
2035
     */
2036
    int antialias_algo;
2037
#define FF_AA_AUTO    0
2038
#define FF_AA_FASTINT 1 //not implemented yet
2039
#define FF_AA_INT     2
2040
#define FF_AA_FLOAT   3
2041
    /**
2042
     * quantizer noise shaping
2043
     * - encoding: Set by user.
2044
     * - decoding: unused
2045
     */
2046
    int quantizer_noise_shaping;
2047

    
2048
    /**
2049
     * thread count
2050
     * is used to decide how many independent tasks should be passed to execute()
2051
     * - encoding: Set by user.
2052
     * - decoding: Set by user.
2053
     */
2054
    int thread_count;
2055

    
2056
    /**
2057
     * The codec may call this to execute several independent things.
2058
     * It will return only after finishing all tasks.
2059
     * The user may replace this with some multithreaded implementation,
2060
     * the default implementation will execute the parts serially.
2061
     * @param count the number of things to execute
2062
     * - encoding: Set by libavcodec, user can override.
2063
     * - decoding: Set by libavcodec, user can override.
2064
     */
2065
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2066

    
2067
    /**
2068
     * thread opaque
2069
     * Can be used by execute() to store some per AVCodecContext stuff.
2070
     * - encoding: set by execute()
2071
     * - decoding: set by execute()
2072
     */
2073
    void *thread_opaque;
2074

    
2075
    /**
2076
     * Motion estimation threshold below which no motion estimation is
2077
     * performed, but instead the user specified motion vectors are used.
2078
     *
2079
     * - encoding: Set by user.
2080
     * - decoding: unused
2081
     */
2082
     int me_threshold;
2083

    
2084
    /**
2085
     * Macroblock threshold below which the user specified macroblock types will be used.
2086
     * - encoding: Set by user.
2087
     * - decoding: unused
2088
     */
2089
     int mb_threshold;
2090

    
2091
    /**
2092
     * precision of the intra DC coefficient - 8
2093
     * - encoding: Set by user.
2094
     * - decoding: unused
2095
     */
2096
     int intra_dc_precision;
2097

    
2098
    /**
2099
     * noise vs. sse weight for the nsse comparsion function
2100
     * - encoding: Set by user.
2101
     * - decoding: unused
2102
     */
2103
     int nsse_weight;
2104

    
2105
    /**
2106
     * Number of macroblock rows at the top which are skipped.
2107
     * - encoding: unused
2108
     * - decoding: Set by user.
2109
     */
2110
     int skip_top;
2111

    
2112
    /**
2113
     * Number of macroblock rows at the bottom which are skipped.
2114
     * - encoding: unused
2115
     * - decoding: Set by user.
2116
     */
2117
     int skip_bottom;
2118

    
2119
    /**
2120
     * profile
2121
     * - encoding: Set by user.
2122
     * - decoding: Set by libavcodec.
2123
     */
2124
     int profile;
2125
#define FF_PROFILE_UNKNOWN -99
2126
#define FF_PROFILE_AAC_MAIN 0
2127
#define FF_PROFILE_AAC_LOW  1
2128
#define FF_PROFILE_AAC_SSR  2
2129
#define FF_PROFILE_AAC_LTP  3
2130

    
2131
    /**
2132
     * level
2133
     * - encoding: Set by user.
2134
     * - decoding: Set by libavcodec.
2135
     */
2136
     int level;
2137
#define FF_LEVEL_UNKNOWN -99
2138

    
2139
    /**
2140
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2141
     * - encoding: unused
2142
     * - decoding: Set by user.
2143
     */
2144
     int lowres;
2145

    
2146
    /**
2147
     * Bitstream width / height, may be different from width/height if lowres
2148
     * or other things are used.
2149
     * - encoding: unused
2150
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2151
     */
2152
    int coded_width, coded_height;
2153

    
2154
    /**
2155
     * frame skip threshold
2156
     * - encoding: Set by user.
2157
     * - decoding: unused
2158
     */
2159
    int frame_skip_threshold;
2160

    
2161
    /**
2162
     * frame skip factor
2163
     * - encoding: Set by user.
2164
     * - decoding: unused
2165
     */
2166
    int frame_skip_factor;
2167

    
2168
    /**
2169
     * frame skip exponent
2170
     * - encoding: Set by user.
2171
     * - decoding: unused
2172
     */
2173
    int frame_skip_exp;
2174

    
2175
    /**
2176
     * frame skip comparison function
2177
     * - encoding: Set by user.
2178
     * - decoding: unused
2179
     */
2180
    int frame_skip_cmp;
2181

    
2182
    /**
2183
     * Border processing masking, raises the quantizer for mbs on the borders
2184
     * of the picture.
2185
     * - encoding: Set by user.
2186
     * - decoding: unused
2187
     */
2188
    float border_masking;
2189

    
2190
    /**
2191
     * minimum MB lagrange multipler
2192
     * - encoding: Set by user.
2193
     * - decoding: unused
2194
     */
2195
    int mb_lmin;
2196

    
2197
    /**
2198
     * maximum MB lagrange multipler
2199
     * - encoding: Set by user.
2200
     * - decoding: unused
2201
     */
2202
    int mb_lmax;
2203

    
2204
    /**
2205
     *
2206
     * - encoding: Set by user.
2207
     * - decoding: unused
2208
     */
2209
    int me_penalty_compensation;
2210

    
2211
    /**
2212
     *
2213
     * - encoding: unused
2214
     * - decoding: Set by user.
2215
     */
2216
    enum AVDiscard skip_loop_filter;
2217

    
2218
    /**
2219
     *
2220
     * - encoding: unused
2221
     * - decoding: Set by user.
2222
     */
2223
    enum AVDiscard skip_idct;
2224

    
2225
    /**
2226
     *
2227
     * - encoding: unused
2228
     * - decoding: Set by user.
2229
     */
2230
    enum AVDiscard skip_frame;
2231

    
2232
    /**
2233
     *
2234
     * - encoding: Set by user.
2235
     * - decoding: unused
2236
     */
2237
    int bidir_refine;
2238

    
2239
    /**
2240
     *
2241
     * - encoding: Set by user.
2242
     * - decoding: unused
2243
     */
2244
    int brd_scale;
2245

    
2246
    /**
2247
     * constant rate factor - quality-based VBR - values ~correspond to qps
2248
     * - encoding: Set by user.
2249
     * - decoding: unused
2250
     */
2251
    float crf;
2252

    
2253
    /**
2254
     * constant quantization parameter rate control method
2255
     * - encoding: Set by user.
2256
     * - decoding: unused
2257
     */
2258
    int cqp;
2259

    
2260
    /**
2261
     * minimum GOP size
2262
     * - encoding: Set by user.
2263
     * - decoding: unused
2264
     */
2265
    int keyint_min;
2266

    
2267
    /**
2268
     * number of reference frames
2269
     * - encoding: Set by user.
2270
     * - decoding: Set by lavc.
2271
     */
2272
    int refs;
2273

    
2274
    /**
2275
     * chroma qp offset from luma
2276
     * - encoding: Set by user.
2277
     * - decoding: unused
2278
     */
2279
    int chromaoffset;
2280

    
2281
    /**
2282
     * Influences how often B-frames are used.
2283
     * - encoding: Set by user.
2284
     * - decoding: unused
2285
     */
2286
    int bframebias;
2287

    
2288
    /**
2289
     * trellis RD quantization
2290
     * - encoding: Set by user.
2291
     * - decoding: unused
2292
     */
2293
    int trellis;
2294

    
2295
    /**
2296
     * Reduce fluctuations in qp (before curve compression).
2297
     * - encoding: Set by user.
2298
     * - decoding: unused
2299
     */
2300
    float complexityblur;
2301

    
2302
    /**
2303
     * in-loop deblocking filter alphac0 parameter
2304
     * alpha is in the range -6...6
2305
     * - encoding: Set by user.
2306
     * - decoding: unused
2307
     */
2308
    int deblockalpha;
2309

    
2310
    /**
2311
     * in-loop deblocking filter beta parameter
2312
     * beta is in the range -6...6
2313
     * - encoding: Set by user.
2314
     * - decoding: unused
2315
     */
2316
    int deblockbeta;
2317

    
2318
    /**
2319
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2320
     * - encoding: Set by user.
2321
     * - decoding: unused
2322
     */
2323
    int partitions;
2324
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2325
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2326
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2327
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2328
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2329

    
2330
    /**
2331
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2332
     * - encoding: Set by user.
2333
     * - decoding: unused
2334
     */
2335
    int directpred;
2336

    
2337
    /**
2338
     * Audio cutoff bandwidth (0 means "automatic")
2339
     * - encoding: Set by user.
2340
     * - decoding: unused
2341
     */
2342
    int cutoff;
2343

    
2344
    /**
2345
     * Multiplied by qscale for each frame and added to scene_change_score.
2346
     * - encoding: Set by user.
2347
     * - decoding: unused
2348
     */
2349
    int scenechange_factor;
2350

    
2351
    /**
2352
     *
2353
     * Note: Value depends upon the compare function used for fullpel ME.
2354
     * - encoding: Set by user.
2355
     * - decoding: unused
2356
     */
2357
    int mv0_threshold;
2358

    
2359
    /**
2360
     * Adjusts sensitivity of b_frame_strategy 1.
2361
     * - encoding: Set by user.
2362
     * - decoding: unused
2363
     */
2364
    int b_sensitivity;
2365

    
2366
    /**
2367
     * - encoding: Set by user.
2368
     * - decoding: unused
2369
     */
2370
    int compression_level;
2371
#define FF_COMPRESSION_DEFAULT -1
2372

    
2373
    /**
2374
     * Sets whether to use LPC mode - used by FLAC encoder.
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int use_lpc;
2379

    
2380
    /**
2381
     * LPC coefficient precision - used by FLAC encoder
2382
     * - encoding: Set by user.
2383
     * - decoding: unused
2384
     */
2385
    int lpc_coeff_precision;
2386

    
2387
    /**
2388
     * - encoding: Set by user.
2389
     * - decoding: unused
2390
     */
2391
    int min_prediction_order;
2392

    
2393
    /**
2394
     * - encoding: Set by user.
2395
     * - decoding: unused
2396
     */
2397
    int max_prediction_order;
2398

    
2399
    /**
2400
     * search method for selecting prediction order
2401
     * - encoding: Set by user.
2402
     * - decoding: unused
2403
     */
2404
    int prediction_order_method;
2405

    
2406
    /**
2407
     * - encoding: Set by user.
2408
     * - decoding: unused
2409
     */
2410
    int min_partition_order;
2411

    
2412
    /**
2413
     * - encoding: Set by user.
2414
     * - decoding: unused
2415
     */
2416
    int max_partition_order;
2417

    
2418
    /**
2419
     * GOP timecode frame start number, in non drop frame format
2420
     * - encoding: Set by user.
2421
     * - decoding: unused
2422
     */
2423
    int64_t timecode_frame_start;
2424

    
2425
#if LIBAVCODEC_VERSION_MAJOR < 53
2426
    /**
2427
     * Decoder should decode to this many channels if it can (0 for default)
2428
     * - encoding: unused
2429
     * - decoding: Set by user.
2430
     * @deprecated Deprecated in favor of request_channel_layout.
2431
     */
2432
    int request_channels;
2433
#endif
2434

    
2435
    /**
2436
     * Percentage of dynamic range compression to be applied by the decoder.
2437
     * The default value is 1.0, corresponding to full compression.
2438
     * - encoding: unused
2439
     * - decoding: Set by user.
2440
     */
2441
    float drc_scale;
2442

    
2443
    /**
2444
     * opaque 64bit number (generally a PTS) that will be reordered and
2445
     * output in AVFrame.reordered_opaque
2446
     * - encoding: unused
2447
     * - decoding: Set by user.
2448
     */
2449
    int64_t reordered_opaque;
2450

    
2451
    /**
2452
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2453
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2454
     * - encoding: set by user.
2455
     * - decoding: set by libavcodec.
2456
     */
2457
    int bits_per_raw_sample;
2458

    
2459
    /**
2460
     * Audio channel layout.
2461
     * - encoding: set by user.
2462
     * - decoding: set by libavcodec.
2463
     */
2464
    int64_t channel_layout;
2465

    
2466
    /**
2467
     * Request decoder to use this channel layout if it can (0 for default)
2468
     * - encoding: unused
2469
     * - decoding: Set by user.
2470
     */
2471
    int64_t request_channel_layout;
2472

    
2473
    /**
2474
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2475
     * - encoding: Set by user.
2476
     * - decoding: unused.
2477
     */
2478
    float rc_max_available_vbv_use;
2479

    
2480
    /**
2481
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2482
     * - encoding: Set by user.
2483
     * - decoding: unused.
2484
     */
2485
    float rc_min_vbv_overflow_use;
2486

    
2487
    /**
2488
     * Hardware accelerator in use
2489
     * - encoding: unused.
2490
     * - decoding: Set by libavcodec
2491
     */
2492
    struct AVHWAccel *hwaccel;
2493

    
2494
    /**
2495
     * For some codecs, the time base is closer to the field rate than the frame rate.
2496
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2497
     * if no telecine is used ...
2498
     *
2499
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2500
     */
2501
    int ticks_per_frame;
2502

    
2503
    /**
2504
     * Hardware accelerator context.
2505
     * For some hardware accelerators, a global context needs to be
2506
     * provided by the user. In that case, this holds display-dependent
2507
     * data FFmpeg cannot instantiate itself. Please refer to the
2508
     * FFmpeg HW accelerator documentation to know how to fill this
2509
     * is. e.g. for VA API, this is a struct vaapi_context.
2510
     * - encoding: unused
2511
     * - decoding: Set by user
2512
     */
2513
    void *hwaccel_context;
2514

    
2515
    /**
2516
     * Chromaticity coordinates of the source primaries.
2517
     * - encoding: Set by user
2518
     * - decoding: Set by libavcodec
2519
     */
2520
    enum AVColorPrimaries color_primaries;
2521

    
2522
    /**
2523
     * Color Transfer Characteristic.
2524
     * - encoding: Set by user
2525
     * - decoding: Set by libavcodec
2526
     */
2527
    enum AVColorTransferCharacteristic color_trc;
2528

    
2529
    /**
2530
     * YUV colorspace type.
2531
     * - encoding: Set by user
2532
     * - decoding: Set by libavcodec
2533
     */
2534
    enum AVColorSpace colorspace;
2535

    
2536
    /**
2537
     * MPEG vs JPEG YUV range.
2538
     * - encoding: Set by user
2539
     * - decoding: Set by libavcodec
2540
     */
2541
    enum AVColorRange color_range;
2542

    
2543
    /**
2544
     * This defines the location of chroma samples.
2545
     * - encoding: Set by user
2546
     * - decoding: Set by libavcodec
2547
     */
2548
    enum AVChromaLocation chroma_sample_location;
2549

    
2550
    /**
2551
     * The codec may call this to execute several independent things.
2552
     * It will return only after finishing all tasks.
2553
     * The user may replace this with some multithreaded implementation,
2554
     * the default implementation will execute the parts serially.
2555
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2556
     * @param c context passed also to func
2557
     * @param count the number of things to execute
2558
     * @param arg2 argument passed unchanged to func
2559
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2560
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2561
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2562
     *             two instances of func executing at the same time will have the same threadnr.
2563
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2564
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2565
     * - encoding: Set by libavcodec, user can override.
2566
     * - decoding: Set by libavcodec, user can override.
2567
     */
2568
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2569

    
2570
    /**
2571
     * explicit P-frame weighted prediction analysis method
2572
     * 0: off
2573
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2574
     * 2: smart weighting (full fade detection analysis)
2575
     * - encoding: Set by user.
2576
     * - decoding: unused
2577
     */
2578
    int weighted_p_pred;
2579
} AVCodecContext;
2580

    
2581
/**
2582
 * AVCodec.
2583
 */
2584
typedef struct AVCodec {
2585
    /**
2586
     * Name of the codec implementation.
2587
     * The name is globally unique among encoders and among decoders (but an
2588
     * encoder and a decoder can share the same name).
2589
     * This is the primary way to find a codec from the user perspective.
2590
     */
2591
    const char *name;
2592
    enum CodecType type;
2593
    enum CodecID id;
2594
    int priv_data_size;
2595
    int (*init)(AVCodecContext *);
2596
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2597
    int (*close)(AVCodecContext *);
2598
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2599
    /**
2600
     * Codec capabilities.
2601
     * see CODEC_CAP_*
2602
     */
2603
    int capabilities;
2604
    struct AVCodec *next;
2605
    /**
2606
     * Flush buffers.
2607
     * Will be called when seeking
2608
     */
2609
    void (*flush)(AVCodecContext *);
2610
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2611
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2612
    /**
2613
     * Descriptive name for the codec, meant to be more human readable than name.
2614
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2615
     */
2616
    const char *long_name;
2617
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2618
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2619
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2620
} AVCodec;
2621

    
2622
/**
2623
 * AVHWAccel.
2624
 */
2625
typedef struct AVHWAccel {
2626
    /**
2627
     * Name of the hardware accelerated codec.
2628
     * The name is globally unique among encoders and among decoders (but an
2629
     * encoder and a decoder can share the same name).
2630
     */
2631
    const char *name;
2632

    
2633
    /**
2634
     * Type of codec implemented by the hardware accelerator.
2635
     *
2636
     * See CODEC_TYPE_xxx
2637
     */
2638
    enum CodecType type;
2639

    
2640
    /**
2641
     * Codec implemented by the hardware accelerator.
2642
     *
2643
     * See CODEC_ID_xxx
2644
     */
2645
    enum CodecID id;
2646

    
2647
    /**
2648
     * Supported pixel format.
2649
     *
2650
     * Only hardware accelerated formats are supported here.
2651
     */
2652
    enum PixelFormat pix_fmt;
2653

    
2654
    /**
2655
     * Hardware accelerated codec capabilities.
2656
     * see FF_HWACCEL_CODEC_CAP_*
2657
     */
2658
    int capabilities;
2659

    
2660
    struct AVHWAccel *next;
2661

    
2662
    /**
2663
     * Called at the beginning of each frame or field picture.
2664
     *
2665
     * Meaningful frame information (codec specific) is guaranteed to
2666
     * be parsed at this point. This function is mandatory.
2667
     *
2668
     * Note that buf can be NULL along with buf_size set to 0.
2669
     * Otherwise, this means the whole frame is available at this point.
2670
     *
2671
     * @param avctx the codec context
2672
     * @param buf the frame data buffer base
2673
     * @param buf_size the size of the frame in bytes
2674
     * @return zero if successful, a negative value otherwise
2675
     */
2676
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2677

    
2678
    /**
2679
     * Callback for each slice.
2680
     *
2681
     * Meaningful slice information (codec specific) is guaranteed to
2682
     * be parsed at this point. This function is mandatory.
2683
     *
2684
     * @param avctx the codec context
2685
     * @param buf the slice data buffer base
2686
     * @param buf_size the size of the slice in bytes
2687
     * @return zero if successful, a negative value otherwise
2688
     */
2689
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2690

    
2691
    /**
2692
     * Called at the end of each frame or field picture.
2693
     *
2694
     * The whole picture is parsed at this point and can now be sent
2695
     * to the hardware accelerator. This function is mandatory.
2696
     *
2697
     * @param avctx the codec context
2698
     * @return zero if successful, a negative value otherwise
2699
     */
2700
    int (*end_frame)(AVCodecContext *avctx);
2701

    
2702
    /**
2703
     * Size of HW accelerator private data.
2704
     *
2705
     * Private data is allocated with av_mallocz() before
2706
     * AVCodecContext.get_buffer() and deallocated after
2707
     * AVCodecContext.release_buffer().
2708
     */
2709
    int priv_data_size;
2710
} AVHWAccel;
2711

    
2712
/**
2713
 * four components are given, that's all.
2714
 * the last component is alpha
2715
 */
2716
typedef struct AVPicture {
2717
    uint8_t *data[4];
2718
    int linesize[4];       ///< number of bytes per line
2719
} AVPicture;
2720

    
2721
#if LIBAVCODEC_VERSION_MAJOR < 53
2722
/**
2723
 * AVPaletteControl
2724
 * This structure defines a method for communicating palette changes
2725
 * between and demuxer and a decoder.
2726
 *
2727
 * @deprecated Use AVPacket to send palette changes instead.
2728
 * This is totally broken.
2729
 */
2730
#define AVPALETTE_SIZE 1024
2731
#define AVPALETTE_COUNT 256
2732
typedef struct AVPaletteControl {
2733

    
2734
    /* Demuxer sets this to 1 to indicate the palette has changed;
2735
     * decoder resets to 0. */
2736
    int palette_changed;
2737

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

    
2744
} AVPaletteControl attribute_deprecated;
2745
#endif
2746

    
2747
enum AVSubtitleType {
2748
    SUBTITLE_NONE,
2749

    
2750
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2751

    
2752
    /**
2753
     * Plain text, the text field must be set by the decoder and is
2754
     * authoritative. ass and pict fields may contain approximations.
2755
     */
2756
    SUBTITLE_TEXT,
2757

    
2758
    /**
2759
     * Formatted text, the ass field must be set by the decoder and is
2760
     * authoritative. pict and text fields may contain approximations.
2761
     */
2762
    SUBTITLE_ASS,
2763
};
2764

    
2765
typedef struct AVSubtitleRect {
2766
    int x;         ///< top left corner  of pict, undefined when pict is not set
2767
    int y;         ///< top left corner  of pict, undefined when pict is not set
2768
    int w;         ///< width            of pict, undefined when pict is not set
2769
    int h;         ///< height           of pict, undefined when pict is not set
2770
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2771

    
2772
    /**
2773
     * data+linesize for the bitmap of this subtitle.
2774
     * can be set for text/ass as well once they where rendered
2775
     */
2776
    AVPicture pict;
2777
    enum AVSubtitleType type;
2778

    
2779
    char *text;                     ///< 0 terminated plain UTF-8 text
2780

    
2781
    /**
2782
     * 0 terminated ASS/SSA compatible event line.
2783
     * The pressentation of this is unaffected by the other values in this
2784
     * struct.
2785
     */
2786
    char *ass;
2787
} AVSubtitleRect;
2788

    
2789
typedef struct AVSubtitle {
2790
    uint16_t format; /* 0 = graphics */
2791
    uint32_t start_display_time; /* relative to packet pts, in ms */
2792
    uint32_t end_display_time; /* relative to packet pts, in ms */
2793
    unsigned num_rects;
2794
    AVSubtitleRect **rects;
2795
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2796
} AVSubtitle;
2797

    
2798
/* packet functions */
2799

    
2800
/**
2801
 * @deprecated use NULL instead
2802
 */
2803
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2804

    
2805
/**
2806
 * Default packet destructor.
2807
 */
2808
void av_destruct_packet(AVPacket *pkt);
2809

    
2810
/**
2811
 * Initialize optional fields of a packet with default values.
2812
 *
2813
 * @param pkt packet
2814
 */
2815
void av_init_packet(AVPacket *pkt);
2816

    
2817
/**
2818
 * Allocate the payload of a packet and initialize its fields with
2819
 * default values.
2820
 *
2821
 * @param pkt packet
2822
 * @param size wanted payload size
2823
 * @return 0 if OK, AVERROR_xxx otherwise
2824
 */
2825
int av_new_packet(AVPacket *pkt, int size);
2826

    
2827
/**
2828
 * Reduce packet size, correctly zeroing padding
2829
 *
2830
 * @param pkt packet
2831
 * @param size new size
2832
 */
2833
void av_shrink_packet(AVPacket *pkt, int size);
2834

    
2835
/**
2836
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2837
 * packet is allocated if it was not really allocated.
2838
 */
2839
int av_dup_packet(AVPacket *pkt);
2840

    
2841
/**
2842
 * Free a packet.
2843
 *
2844
 * @param pkt packet to free
2845
 */
2846
void av_free_packet(AVPacket *pkt);
2847

    
2848
/* resample.c */
2849

    
2850
struct ReSampleContext;
2851
struct AVResampleContext;
2852

    
2853
typedef struct ReSampleContext ReSampleContext;
2854

    
2855
#if LIBAVCODEC_VERSION_MAJOR < 53
2856
/**
2857
 * @deprecated Use av_audio_resample_init() instead.
2858
 */
2859
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2860
                                                          int output_rate, int input_rate);
2861
#endif
2862
/**
2863
 *  Initializes audio resampling context
2864
 *
2865
 * @param output_channels  number of output channels
2866
 * @param input_channels   number of input channels
2867
 * @param output_rate      output sample rate
2868
 * @param input_rate       input sample rate
2869
 * @param sample_fmt_out   requested output sample format
2870
 * @param sample_fmt_in    input sample format
2871
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2872
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2873
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2874
                           between the 2 closest, if 0 the closest will be used
2875
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2876
 * @return allocated ReSampleContext, NULL if error occured
2877
 */
2878
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2879
                                        int output_rate, int input_rate,
2880
                                        enum SampleFormat sample_fmt_out,
2881
                                        enum SampleFormat sample_fmt_in,
2882
                                        int filter_length, int log2_phase_count,
2883
                                        int linear, double cutoff);
2884

    
2885
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2886
void audio_resample_close(ReSampleContext *s);
2887

    
2888

    
2889
/**
2890
 * Initializes an audio resampler.
2891
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2892
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2893
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2894
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2895
                 between the 2 closest, if 0 the closest will be used
2896
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2897
 */
2898
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2899

    
2900
/**
2901
 * resamples.
2902
 * @param src an array of unconsumed samples
2903
 * @param consumed the number of samples of src which have been consumed are returned here
2904
 * @param src_size the number of unconsumed samples available
2905
 * @param dst_size the amount of space in samples available in dst
2906
 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
2907
 * @return the number of samples written in dst or -1 if an error occurred
2908
 */
2909
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2910

    
2911

    
2912
/**
2913
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2914
 * the resampler parameters, so no audible clicks or similar distortions occur
2915
 * @param compensation_distance distance in output samples over which the compensation should be performed
2916
 * @param sample_delta number of output samples which should be output less
2917
 *
2918
 * example: av_resample_compensate(c, 10, 500)
2919
 * here instead of 510 samples only 500 samples would be output
2920
 *
2921
 * note, due to rounding the actual compensation might be slightly different,
2922
 * especially if the compensation_distance is large and the in_rate used during init is small
2923
 */
2924
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2925
void av_resample_close(struct AVResampleContext *c);
2926

    
2927
/**
2928
 * Allocate memory for a picture.  Call avpicture_free to free it.
2929
 *
2930
 * @param picture the picture to be filled in
2931
 * @param pix_fmt the format of the picture
2932
 * @param width the width of the picture
2933
 * @param height the height of the picture
2934
 * @return zero if successful, a negative value if not
2935
 */
2936
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2937

    
2938
/**
2939
 * Free a picture previously allocated by avpicture_alloc().
2940
 *
2941
 * @param picture the AVPicture to be freed
2942
 */
2943
void avpicture_free(AVPicture *picture);
2944

    
2945
/**
2946
 * Fill in the AVPicture fields.
2947
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2948
 * which points to the image data buffer. Depending on the specified picture
2949
 * format, one or multiple image data pointers and line sizes will be set.
2950
 * If a planar format is specified, several pointers will be set pointing to
2951
 * the different picture planes and the line sizes of the different planes
2952
 * will be stored in the lines_sizes array.
2953
 * Call with ptr == NULL to get the required size for the ptr buffer.
2954
 *
2955
 * @param picture AVPicture whose fields are to be filled in
2956
 * @param ptr Buffer which will contain or contains the actual image data
2957
 * @param pix_fmt The format in which the picture data is stored.
2958
 * @param width the width of the image in pixels
2959
 * @param height the height of the image in pixels
2960
 * @return size of the image data in bytes
2961
 */
2962
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2963
                   enum PixelFormat pix_fmt, int width, int height);
2964
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2965
                     unsigned char *dest, int dest_size);
2966

    
2967
/**
2968
 * Calculate the size in bytes that a picture of the given width and height
2969
 * would occupy if stored in the given picture format.
2970
 * Note that this returns the size of a compact representation as generated
2971
 * by avpicture_layout, which can be smaller than the size required for e.g.
2972
 * avpicture_fill.
2973
 *
2974
 * @param pix_fmt the given picture format
2975
 * @param width the width of the image
2976
 * @param height the height of the image
2977
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2978
 */
2979
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2980
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2981
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2982
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2983

    
2984
/**
2985
 * Returns the pixel format corresponding to the name name.
2986
 *
2987
 * If there is no pixel format with name name, then looks for a
2988
 * pixel format with the name corresponding to the native endian
2989
 * format of name.
2990
 * For example in a little-endian system, first looks for "gray16",
2991
 * then for "gray16le".
2992
 *
2993
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
2994
 */
2995
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2996

    
2997
/**
2998
 * Returns a value representing the fourCC code associated to the
2999
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3000
 * found.
3001
 */
3002
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3003

    
3004
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3005
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3006
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3007
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3008
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3009
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3010

    
3011
/**
3012
 * Computes what kind of losses will occur when converting from one specific
3013
 * pixel format to another.
3014
 * When converting from one pixel format to another, information loss may occur.
3015
 * For example, when converting from RGB24 to GRAY, the color information will
3016
 * be lost. Similarly, other losses occur when converting from some formats to
3017
 * other formats. These losses can involve loss of chroma, but also loss of
3018
 * resolution, loss of color depth, loss due to the color space conversion, loss
3019
 * of the alpha bits or loss due to color quantization.
3020
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3021
 * which will occur when converting from one pixel format to another.
3022
 *
3023
 * @param[in] dst_pix_fmt destination pixel format
3024
 * @param[in] src_pix_fmt source pixel format
3025
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3026
 * @return Combination of flags informing you what kind of losses will occur.
3027
 */
3028
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3029
                             int has_alpha);
3030

    
3031
/**
3032
 * Finds the best pixel format to convert to given a certain source pixel
3033
 * format.  When converting from one pixel format to another, information loss
3034
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3035
 * information will be lost. Similarly, other losses occur when converting from
3036
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3037
 * the given pixel formats should be used to suffer the least amount of loss.
3038
 * The pixel formats from which it chooses one, are determined by the
3039
 * pix_fmt_mask parameter.
3040
 *
3041
 * @code
3042
 * src_pix_fmt = PIX_FMT_YUV420P;
3043
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3044
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3045
 * @endcode
3046
 *
3047
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3048
 * @param[in] src_pix_fmt source pixel format
3049
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3050
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3051
 * @return The best pixel format to convert to or -1 if none was found.
3052
 */
3053
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3054
                              int has_alpha, int *loss_ptr);
3055

    
3056

    
3057
/**
3058
 * Print in buf the string corresponding to the pixel format with
3059
 * number pix_fmt, or an header if pix_fmt is negative.
3060
 *
3061
 * @param[in] buf the buffer where to write the string
3062
 * @param[in] buf_size the size of buf
3063
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3064
 * a negative value to print the corresponding header.
3065
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3066
 */
3067
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3068

    
3069
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3070
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3071

    
3072
/**
3073
 * Tell if an image really has transparent alpha values.
3074
 * @return ored mask of FF_ALPHA_xxx constants
3075
 */
3076
int img_get_alpha_info(const AVPicture *src,
3077
                       enum PixelFormat pix_fmt, int width, int height);
3078

    
3079
/* deinterlace a picture */
3080
/* deinterlace - if not supported return -1 */
3081
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3082
                          enum PixelFormat pix_fmt, int width, int height);
3083

    
3084
/* external high level API */
3085

    
3086
/**
3087
 * If c is NULL, returns the first registered codec,
3088
 * if c is non-NULL, returns the next registered codec after c,
3089
 * or NULL if c is the last one.
3090
 */
3091
AVCodec *av_codec_next(AVCodec *c);
3092

    
3093
/**
3094
 * Returns the LIBAVCODEC_VERSION_INT constant.
3095
 */
3096
unsigned avcodec_version(void);
3097

    
3098
/**
3099
 * Returns the libavcodec build-time configuration.
3100
 */
3101
const char *avcodec_configuration(void);
3102

    
3103
/**
3104
 * Returns the libavcodec license.
3105
 */
3106
const char *avcodec_license(void);
3107

    
3108
/**
3109
 * Initializes libavcodec.
3110
 *
3111
 * @warning This function must be called before any other libavcodec
3112
 * function.
3113
 */
3114
void avcodec_init(void);
3115

    
3116
#if LIBAVCODEC_VERSION_MAJOR < 53
3117
/**
3118
 * @deprecated Deprecated in favor of avcodec_register().
3119
 */
3120
attribute_deprecated void register_avcodec(AVCodec *codec);
3121
#endif
3122

    
3123
/**
3124
 * Register the codec codec and initialize libavcodec.
3125
 *
3126
 * @see avcodec_init()
3127
 */
3128
void avcodec_register(AVCodec *codec);
3129

    
3130
/**
3131
 * Finds a registered encoder with a matching codec ID.
3132
 *
3133
 * @param id CodecID of the requested encoder
3134
 * @return An encoder if one was found, NULL otherwise.
3135
 */
3136
AVCodec *avcodec_find_encoder(enum CodecID id);
3137

    
3138
/**
3139
 * Finds a registered encoder with the specified name.
3140
 *
3141
 * @param name name of the requested encoder
3142
 * @return An encoder if one was found, NULL otherwise.
3143
 */
3144
AVCodec *avcodec_find_encoder_by_name(const char *name);
3145

    
3146
/**
3147
 * Finds a registered decoder with a matching codec ID.
3148
 *
3149
 * @param id CodecID of the requested decoder
3150
 * @return A decoder if one was found, NULL otherwise.
3151
 */
3152
AVCodec *avcodec_find_decoder(enum CodecID id);
3153

    
3154
/**
3155
 * Finds a registered decoder with the specified name.
3156
 *
3157
 * @param name name of the requested decoder
3158
 * @return A decoder if one was found, NULL otherwise.
3159
 */
3160
AVCodec *avcodec_find_decoder_by_name(const char *name);
3161
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3162

    
3163
/**
3164
 * Sets the fields of the given AVCodecContext to default values.
3165
 *
3166
 * @param s The AVCodecContext of which the fields should be set to default values.
3167
 */
3168
void avcodec_get_context_defaults(AVCodecContext *s);
3169

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

    
3174
/**
3175
 * Allocates an AVCodecContext and sets its fields to default values.  The
3176
 * resulting struct can be deallocated by simply calling av_free().
3177
 *
3178
 * @return An AVCodecContext filled with default values or NULL on failure.
3179
 * @see avcodec_get_context_defaults
3180
 */
3181
AVCodecContext *avcodec_alloc_context(void);
3182

    
3183
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3184
 *  we WILL change its arguments and name a few times! */
3185
AVCodecContext *avcodec_alloc_context2(enum CodecType);
3186

    
3187
/**
3188
 * Sets the fields of the given AVFrame to default values.
3189
 *
3190
 * @param pic The AVFrame of which the fields should be set to default values.
3191
 */
3192
void avcodec_get_frame_defaults(AVFrame *pic);
3193

    
3194
/**
3195
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3196
 * struct can be deallocated by simply calling av_free().
3197
 *
3198
 * @return An AVFrame filled with default values or NULL on failure.
3199
 * @see avcodec_get_frame_defaults
3200
 */
3201
AVFrame *avcodec_alloc_frame(void);
3202

    
3203
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3204
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3205
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3206
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3207

    
3208
/**
3209
 * Checks if the given dimension of a picture is valid, meaning that all
3210
 * bytes of the picture can be addressed with a signed int.
3211
 *
3212
 * @param[in] w Width of the picture.
3213
 * @param[in] h Height of the picture.
3214
 * @return Zero if valid, a negative value if invalid.
3215
 */
3216
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3217
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3218

    
3219
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3220
void avcodec_thread_free(AVCodecContext *s);
3221
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3222
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3223
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3224
//FIXME func typedef
3225

    
3226
/**
3227
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3228
 * function the context has to be allocated.
3229
 *
3230
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3231
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3232
 * retrieving a codec.
3233
 *
3234
 * @warning This function is not thread safe!
3235
 *
3236
 * @code
3237
 * avcodec_register_all();
3238
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3239
 * if (!codec)
3240
 *     exit(1);
3241
 *
3242
 * context = avcodec_alloc_context();
3243
 *
3244
 * if (avcodec_open(context, codec) < 0)
3245
 *     exit(1);
3246
 * @endcode
3247
 *
3248
 * @param avctx The context which will be set up to use the given codec.
3249
 * @param codec The codec to use within the context.
3250
 * @return zero on success, a negative value on error
3251
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3252
 */
3253
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3254

    
3255
#if LIBAVCODEC_VERSION_MAJOR < 53
3256
/**
3257
 * Decodes an audio frame from buf into samples.
3258
 * Wrapper function which calls avcodec_decode_audio3.
3259
 *
3260
 * @deprecated Use avcodec_decode_audio3 instead.
3261
 * @param avctx the codec context
3262
 * @param[out] samples the output buffer
3263
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3264
 * @param[in] buf the input buffer
3265
 * @param[in] buf_size the input buffer size in bytes
3266
 * @return On error a negative value is returned, otherwise the number of bytes
3267
 * used or zero if no frame could be decompressed.
3268
 */
3269
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3270
                         int *frame_size_ptr,
3271
                         const uint8_t *buf, int buf_size);
3272
#endif
3273

    
3274
/**
3275
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3276
 * Some decoders may support multiple frames in a single AVPacket, such
3277
 * decoders would then just decode the first frame. In this case,
3278
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3279
 * the remaining data in order to decode the second frame etc.
3280
 * If no frame
3281
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3282
 * decompressed frame size in bytes.
3283
 *
3284
 * @warning You must set frame_size_ptr to the allocated size of the
3285
 * output buffer before calling avcodec_decode_audio3().
3286
 *
3287
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3288
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3289
 * bits at once and could read over the end.
3290
 *
3291
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3292
 * no overreading happens for damaged MPEG streams.
3293
 *
3294
 * @note You might have to align the input buffer avpkt->data and output buffer
3295
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3296
 * necessary at all, on others it won't work at all if not aligned and on others
3297
 * it will work but it will have an impact on performance.
3298
 *
3299
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3300
 * samples should be 16 byte aligned unless the CPU doesn't need it
3301
 * (AltiVec and SSE do).
3302
 *
3303
 * @param avctx the codec context
3304
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3305
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3306
 * @param[in] avpkt The input AVPacket containing the input buffer.
3307
 *            You can create such packet with av_init_packet() and by then setting
3308
 *            data and size, some decoders might in addition need other fields.
3309
 *            All decoders are designed to use the least fields possible though.
3310
 * @return On error a negative value is returned, otherwise the number of bytes
3311
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3312
 */
3313
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3314
                         int *frame_size_ptr,
3315
                         AVPacket *avpkt);
3316

    
3317
#if LIBAVCODEC_VERSION_MAJOR < 53
3318
/**
3319
 * Decodes a video frame from buf into picture.
3320
 * Wrapper function which calls avcodec_decode_video2.
3321
 *
3322
 * @deprecated Use avcodec_decode_video2 instead.
3323
 * @param avctx the codec context
3324
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3325
 * @param[in] buf the input buffer
3326
 * @param[in] buf_size the size of the input buffer in bytes
3327
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3328
 * @return On error a negative value is returned, otherwise the number of bytes
3329
 * used or zero if no frame could be decompressed.
3330
 */
3331
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3332
                         int *got_picture_ptr,
3333
                         const uint8_t *buf, int buf_size);
3334
#endif
3335

    
3336
/**
3337
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3338
 * Some decoders may support multiple frames in a single AVPacket, such
3339
 * decoders would then just decode the first frame.
3340
 *
3341
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3342
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3343
 * bits at once and could read over the end.
3344
 *
3345
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3346
 * no overreading happens for damaged MPEG streams.
3347
 *
3348
 * @note You might have to align the input buffer avpkt->data.
3349
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3350
 * necessary at all, on others it won't work at all if not aligned and on others
3351
 * it will work but it will have an impact on performance.
3352
 *
3353
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3354
 *
3355
 * @note Some codecs have a delay between input and output, these need to be
3356
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3357
 *
3358
 * @param avctx the codec context
3359
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3360
 * @param[in] avpkt The input AVpacket containing the input buffer.
3361
 *            You can create such packet with av_init_packet() and by then setting
3362
 *            data and size, some decoders might in addition need other fields like
3363
 *            flags&PKT_FLAG_KEY. All decoders are designed to use the least
3364
 *            fields possible.
3365
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3366
 * @return On error a negative value is returned, otherwise the number of bytes
3367
 * used or zero if no frame could be decompressed.
3368
 */
3369
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3370
                         int *got_picture_ptr,
3371
                         AVPacket *avpkt);
3372

    
3373
#if LIBAVCODEC_VERSION_MAJOR < 53
3374
/* Decode a subtitle message. Return -1 if error, otherwise return the
3375
 * number of bytes used. If no subtitle could be decompressed,
3376
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3377
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3378
                            int *got_sub_ptr,
3379
                            const uint8_t *buf, int buf_size);
3380
#endif
3381

    
3382
/**
3383
 * Decodes a subtitle message.
3384
 * Returns a negative value on error, otherwise returns the number of bytes used.
3385
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3386
 * Otherwise, the subtitle is stored in *sub.
3387
 *
3388
 * @param avctx the codec context
3389
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3390
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3391
 * @param[in] avpkt The input AVPacket containing the input buffer.
3392
 */
3393
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3394
                            int *got_sub_ptr,
3395
                            AVPacket *avpkt);
3396
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3397
                        int *data_size_ptr,
3398
                        uint8_t *buf, int buf_size);
3399

    
3400
/**
3401
 * Encodes an audio frame from samples into buf.
3402
 *
3403
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3404
 * However, for PCM audio the user will know how much space is needed
3405
 * because it depends on the value passed in buf_size as described
3406
 * below. In that case a lower value can be used.
3407
 *
3408
 * @param avctx the codec context
3409
 * @param[out] buf the output buffer
3410
 * @param[in] buf_size the output buffer size
3411
 * @param[in] samples the input buffer containing the samples
3412
 * The number of samples read from this buffer is frame_size*channels,
3413
 * both of which are defined in avctx.
3414
 * For PCM audio the number of samples read from samples is equal to
3415
 * buf_size * input_sample_size / output_sample_size.
3416
 * @return On error a negative value is returned, on success zero or the number
3417
 * of bytes used to encode the data read from the input buffer.
3418
 */
3419
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3420
                         const short *samples);
3421

    
3422
/**
3423
 * Encodes a video frame from pict into buf.
3424
 * The input picture should be
3425
 * stored using a specific format, namely avctx.pix_fmt.
3426
 *
3427
 * @param avctx the codec context
3428
 * @param[out] buf the output buffer for the bitstream of encoded frame
3429
 * @param[in] buf_size the size of the output buffer in bytes
3430
 * @param[in] pict the input picture to encode
3431
 * @return On error a negative value is returned, on success zero or the number
3432
 * of bytes used from the output buffer.
3433
 */
3434
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3435
                         const AVFrame *pict);
3436
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3437
                            const AVSubtitle *sub);
3438

    
3439
int avcodec_close(AVCodecContext *avctx);
3440

    
3441
/**
3442
 * Register all the codecs, parsers and bitstream filters which were enabled at
3443
 * configuration time. If you do not call this function you can select exactly
3444
 * which formats you want to support, by using the individual registration
3445
 * functions.
3446
 *
3447
 * @see avcodec_register
3448
 * @see av_register_codec_parser
3449
 * @see av_register_bitstream_filter
3450
 */
3451
void avcodec_register_all(void);
3452

    
3453
/**
3454
 * Flush buffers, should be called when seeking or when switching to a different stream.
3455
 */
3456
void avcodec_flush_buffers(AVCodecContext *avctx);
3457

    
3458
void avcodec_default_free_buffers(AVCodecContext *s);
3459

    
3460
/* misc useful functions */
3461

    
3462
/**
3463
 * Returns a single letter to describe the given picture type pict_type.
3464
 *
3465
 * @param[in] pict_type the picture type
3466
 * @return A single character representing the picture type.
3467
 */
3468
char av_get_pict_type_char(int pict_type);
3469

    
3470
/**
3471
 * Returns codec bits per sample.
3472
 *
3473
 * @param[in] codec_id the codec
3474
 * @return Number of bits per sample or zero if unknown for the given codec.
3475
 */
3476
int av_get_bits_per_sample(enum CodecID codec_id);
3477

    
3478
/**
3479
 * Returns sample format bits per sample.
3480
 *
3481
 * @param[in] sample_fmt the sample format
3482
 * @return Number of bits per sample or zero if unknown for the given sample format.
3483
 */
3484
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3485

    
3486
/* frame parsing */
3487
typedef struct AVCodecParserContext {
3488
    void *priv_data;
3489
    struct AVCodecParser *parser;
3490
    int64_t frame_offset; /* offset of the current frame */
3491
    int64_t cur_offset; /* current offset
3492
                           (incremented by each av_parser_parse()) */
3493
    int64_t next_frame_offset; /* offset of the next frame */
3494
    /* video info */
3495
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3496
    /**
3497
     * This field is used for proper frame duration computation in lavf.
3498
     * It signals, how much longer the frame duration of the current frame
3499
     * is compared to normal frame duration.
3500
     *
3501
     * frame_duration = (1 + repeat_pict) * time_base
3502
     *
3503
     * It is used by codecs like H.264 to display telecined material.
3504
     */
3505
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3506
    int64_t pts;     /* pts of the current frame */
3507
    int64_t dts;     /* dts of the current frame */
3508

    
3509
    /* private data */
3510
    int64_t last_pts;
3511
    int64_t last_dts;
3512
    int fetch_timestamp;
3513

    
3514
#define AV_PARSER_PTS_NB 4
3515
    int cur_frame_start_index;
3516
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3517
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3518
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3519

    
3520
    int flags;
3521
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3522

    
3523
    int64_t offset;      ///< byte offset from starting packet start
3524
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3525

    
3526
    /*!
3527
     * Set by parser to 1 for key frames and 0 for non-key frames.
3528
     * It is initialized to -1, so if the parser doesn't set this flag,
3529
     * old-style fallback using FF_I_TYPE picture type as key frames
3530
     * will be used.
3531
     */
3532
    int key_frame;
3533

    
3534
    /**
3535
     * Time difference in stream time base units from the pts of this
3536
     * packet to the point at which the output from the decoder has converged
3537
     * independent from the availability of previous frames. That is, the
3538
     * frames are virtually identical no matter if decoding started from
3539
     * the very first frame or from this keyframe.
3540
     * Is AV_NOPTS_VALUE if unknown.
3541
     * This field is not the display duration of the current frame.
3542
     *
3543
     * The purpose of this field is to allow seeking in streams that have no
3544
     * keyframes in the conventional sense. It corresponds to the
3545
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3546
     * essential for some types of subtitle streams to ensure that all
3547
     * subtitles are correctly displayed after seeking.
3548
     */
3549
    int64_t convergence_duration;
3550

    
3551
    // Timestamp generation support:
3552
    /**
3553
     * Synchronization point for start of timestamp generation.
3554
     *
3555
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3556
     * (default).
3557
     *
3558
     * For example, this corresponds to presence of H.264 buffering period
3559
     * SEI message.
3560
     */
3561
    int dts_sync_point;
3562

    
3563
    /**
3564
     * Offset of the current timestamp against last timestamp sync point in
3565
     * units of AVCodecContext.time_base.
3566
     *
3567
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3568
     * contain a valid timestamp offset.
3569
     *
3570
     * Note that the timestamp of sync point has usually a nonzero
3571
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3572
     * the next frame after timestamp sync point will be usually 1.
3573
     *
3574
     * For example, this corresponds to H.264 cpb_removal_delay.
3575
     */
3576
    int dts_ref_dts_delta;
3577

    
3578
    /**
3579
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3580
     *
3581
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3582
     * contain valid non-negative timestamp delta (presentation time of a frame
3583
     * must not lie in the past).
3584
     *
3585
     * This delay represents the difference between decoding and presentation
3586
     * time of the frame.
3587
     *
3588
     * For example, this corresponds to H.264 dpb_output_delay.
3589
     */
3590
    int pts_dts_delta;
3591

    
3592
    /**
3593
     * Position of the packet in file.
3594
     *
3595
     * Analogous to cur_frame_pts/dts
3596
     */
3597
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3598

    
3599
    /**
3600
     * Byte position of currently parsed frame in stream.
3601
     */
3602
    int64_t pos;
3603

    
3604
    /**
3605
     * Previous frame byte position.
3606
     */
3607
    int64_t last_pos;
3608
} AVCodecParserContext;
3609

    
3610
typedef struct AVCodecParser {
3611
    int codec_ids[5]; /* several codec IDs are permitted */
3612
    int priv_data_size;
3613
    int (*parser_init)(AVCodecParserContext *s);
3614
    int (*parser_parse)(AVCodecParserContext *s,
3615
                        AVCodecContext *avctx,
3616
                        const uint8_t **poutbuf, int *poutbuf_size,
3617
                        const uint8_t *buf, int buf_size);
3618
    void (*parser_close)(AVCodecParserContext *s);
3619
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3620
    struct AVCodecParser *next;
3621
} AVCodecParser;
3622

    
3623
AVCodecParser *av_parser_next(AVCodecParser *c);
3624

    
3625
void av_register_codec_parser(AVCodecParser *parser);
3626
AVCodecParserContext *av_parser_init(int codec_id);
3627

    
3628
#if LIBAVCODEC_VERSION_MAJOR < 53
3629
attribute_deprecated
3630
int av_parser_parse(AVCodecParserContext *s,
3631
                    AVCodecContext *avctx,
3632
                    uint8_t **poutbuf, int *poutbuf_size,
3633
                    const uint8_t *buf, int buf_size,
3634
                    int64_t pts, int64_t dts);
3635
#endif
3636

    
3637
/**
3638
 * Parse a packet.
3639
 *
3640
 * @param s             parser context.
3641
 * @param avctx         codec context.
3642
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3643
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3644
 * @param buf           input buffer.
3645
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3646
 * @param pts           input presentation timestamp.
3647
 * @param dts           input decoding timestamp.
3648
 * @param pos           input byte position in stream.
3649
 * @return the number of bytes of the input bitstream used.
3650
 *
3651
 * Example:
3652
 * @code
3653
 *   while(in_len){
3654
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3655
 *                                        in_data, in_len,
3656
 *                                        pts, dts, pos);
3657
 *       in_data += len;
3658
 *       in_len  -= len;
3659
 *
3660
 *       if(size)
3661
 *          decode_frame(data, size);
3662
 *   }
3663
 * @endcode
3664
 */
3665
int av_parser_parse2(AVCodecParserContext *s,
3666
                     AVCodecContext *avctx,
3667
                     uint8_t **poutbuf, int *poutbuf_size,
3668
                     const uint8_t *buf, int buf_size,
3669
                     int64_t pts, int64_t dts,
3670
                     int64_t pos);
3671

    
3672
int av_parser_change(AVCodecParserContext *s,
3673
                     AVCodecContext *avctx,
3674
                     uint8_t **poutbuf, int *poutbuf_size,
3675
                     const uint8_t *buf, int buf_size, int keyframe);
3676
void av_parser_close(AVCodecParserContext *s);
3677

    
3678

    
3679
typedef struct AVBitStreamFilterContext {
3680
    void *priv_data;
3681
    struct AVBitStreamFilter *filter;
3682
    AVCodecParserContext *parser;
3683
    struct AVBitStreamFilterContext *next;
3684
} AVBitStreamFilterContext;
3685

    
3686

    
3687
typedef struct AVBitStreamFilter {
3688
    const char *name;
3689
    int priv_data_size;
3690
    int (*filter)(AVBitStreamFilterContext *bsfc,
3691
                  AVCodecContext *avctx, const char *args,
3692
                  uint8_t **poutbuf, int *poutbuf_size,
3693
                  const uint8_t *buf, int buf_size, int keyframe);
3694
    void (*close)(AVBitStreamFilterContext *bsfc);
3695
    struct AVBitStreamFilter *next;
3696
} AVBitStreamFilter;
3697

    
3698
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3699
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3700
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3701
                               AVCodecContext *avctx, const char *args,
3702
                               uint8_t **poutbuf, int *poutbuf_size,
3703
                               const uint8_t *buf, int buf_size, int keyframe);
3704
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3705

    
3706
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3707

    
3708
/* memory */
3709

    
3710
/**
3711
 * Reallocates the given block if it is not large enough, otherwise it
3712
 * does nothing.
3713
 *
3714
 * @see av_realloc
3715
 */
3716
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3717

    
3718
/**
3719
 * Allocates a buffer, reusing the given one if large enough.
3720
 *
3721
 * Contrary to av_fast_realloc the current buffer contents might not be
3722
 * preserved and on error the old buffer is freed, thus no special
3723
 * handling to avoid memleaks is necessary.
3724
 *
3725
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3726
 * @param size size of the buffer *ptr points to
3727
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3728
 *                 *size 0 if an error occurred.
3729
 */
3730
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3731

    
3732
/**
3733
 * Copy image 'src' to 'dst'.
3734
 */
3735
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3736
                     enum PixelFormat pix_fmt, int width, int height);
3737

    
3738
/**
3739
 * Crop image top and left side.
3740
 */
3741
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3742
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3743

    
3744
/**
3745
 * Pad image.
3746
 */
3747
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3748
            int padtop, int padbottom, int padleft, int padright, int *color);
3749

    
3750
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3751

    
3752
/**
3753
 * Parses str and put in width_ptr and height_ptr the detected values.
3754
 *
3755
 * @return 0 in case of a successful parsing, a negative value otherwise
3756
 * @param[in] str the string to parse: it has to be a string in the format
3757
 * <width>x<height> or a valid video frame size abbreviation.
3758
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3759
 * frame width value
3760
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3761
 * frame height value
3762
 */
3763
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3764

    
3765
/**
3766
 * Parses str and put in frame_rate the detected values.
3767
 *
3768
 * @return 0 in case of a successful parsing, a negative value otherwise
3769
 * @param[in] str the string to parse: it has to be a string in the format
3770
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3771
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3772
 * frame rate
3773
 */
3774
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3775

    
3776
/* error handling */
3777
#if EINVAL > 0
3778
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3779
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3780
#else
3781
/* Some platforms have E* and errno already negated. */
3782
#define AVERROR(e) (e)
3783
#define AVUNERROR(e) (e)
3784
#endif
3785
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3786
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3787
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3788
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3789
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3790
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3791
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3792
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3793
#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
3794
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3795

    
3796
/**
3797
 * Logs a generic warning message about a missing feature. This function is
3798
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3799
 * only, and would normally not be used by applications.
3800
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3801
 * a pointer to an AVClass struct
3802
 * @param[in] feature string containing the name of the missing feature
3803
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3804
 * If want_sample is non-zero, additional verbage will be added to the log
3805
 * message which tells the user how to report samples to the development
3806
 * mailing list.
3807
 */
3808
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3809

    
3810
/**
3811
 * Logs a generic warning message asking for a sample. This function is
3812
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3813
 * only, and would normally not be used by applications.
3814
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3815
 * a pointer to an AVClass struct
3816
 * @param[in] msg string containing an optional message, or NULL if no message
3817
 */
3818
void av_log_ask_for_sample(void *avc, const char *msg);
3819

    
3820
/**
3821
 * Registers the hardware accelerator hwaccel.
3822
 */
3823
void av_register_hwaccel(AVHWAccel *hwaccel);
3824

    
3825
/**
3826
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3827
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3828
 * after hwaccel, or NULL if hwaccel is the last one.
3829
 */
3830
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3831

    
3832

    
3833
/**
3834
 * Lock operation used by lockmgr
3835
 */
3836
enum AVLockOp {
3837
  AV_LOCK_CREATE,  ///< Create a mutex
3838
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3839
  AV_LOCK_RELEASE, ///< Unlock the mutex
3840
  AV_LOCK_DESTROY, ///< Free mutex resources
3841
};
3842

    
3843
/**
3844
 * Register a user provided lock manager supporting the operations
3845
 * specified by AVLockOp. mutex points to a (void *) where the
3846
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3847
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3848
 *
3849
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3850
 *           callback during the call to av_lockmgr_register().
3851
 *           Thus, the application must be prepared to handle that.
3852
 *           If cb is set to NULL the lockmgr will be unregistered.
3853
 *           Also note that during unregistration the previously registered
3854
 *           lockmgr callback may also be invoked.
3855
 */
3856
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3857

    
3858
#endif /* AVCODEC_AVCODEC_H */