Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ eb285cfe

History | View | Annotate | Download (126 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 55
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
    CODEC_ID_BINKVIDEO,
207
    CODEC_ID_IFF_ILBM,
208
    CODEC_ID_IFF_BYTERUN1,
209

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

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

    
267
    /* AMR */
268
    CODEC_ID_AMR_NB= 0x12000,
269
    CODEC_ID_AMR_WB,
270

    
271
    /* RealAudio codecs*/
272
    CODEC_ID_RA_144= 0x13000,
273
    CODEC_ID_RA_288,
274

    
275
    /* various DPCM codecs */
276
    CODEC_ID_ROQ_DPCM= 0x14000,
277
    CODEC_ID_INTERPLAY_DPCM,
278
    CODEC_ID_XAN_DPCM,
279
    CODEC_ID_SOL_DPCM,
280

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

    
335
    /* subtitle codecs */
336
    CODEC_ID_DVD_SUBTITLE= 0x17000,
337
    CODEC_ID_DVB_SUBTITLE,
338
    CODEC_ID_TEXT,  ///< raw UTF-8 text
339
    CODEC_ID_XSUB,
340
    CODEC_ID_SSA,
341
    CODEC_ID_MOV_TEXT,
342
    CODEC_ID_HDMV_PGS_SUBTITLE,
343
    CODEC_ID_DVB_TELETEXT,
344

    
345
    /* other specific kind of codecs (generally used for attachments) */
346
    CODEC_ID_TTF= 0x18000,
347

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

    
350
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
351
                                * stream (only used by libavformat) */
352
};
353

    
354
enum CodecType {
355
    CODEC_TYPE_UNKNOWN = -1,
356
    CODEC_TYPE_VIDEO,
357
    CODEC_TYPE_AUDIO,
358
    CODEC_TYPE_DATA,
359
    CODEC_TYPE_SUBTITLE,
360
    CODEC_TYPE_ATTACHMENT,
361
    CODEC_TYPE_NB
362
};
363

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

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

    
399
/** Channel mask value used for AVCodecContext.request_channel_layout
400
    to indicate that the user requests the channel order of the decoder output
401
    to be the native codec channel order. */
402
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
403

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

    
422
/* in bytes */
423
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
424

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

    
434
/**
435
 * minimum encoding buffer size
436
 * Used to avoid some checks during header writing.
437
 */
438
#define FF_MIN_BUFFER_SIZE 16384
439

    
440

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

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

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

    
479
enum AVColorTransferCharacteristic{
480
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
481
    AVCOL_TRC_UNSPECIFIED=2,
482
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
483
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
484
    AVCOL_TRC_NB           , ///< Not part of ABI
485
};
486

    
487
enum AVColorSpace{
488
    AVCOL_SPC_RGB        =0,
489
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
490
    AVCOL_SPC_UNSPECIFIED=2,
491
    AVCOL_SPC_FCC        =4,
492
    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
493
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
494
    AVCOL_SPC_SMPTE240M  =7,
495
    AVCOL_SPC_NB           , ///< Not part of ABI
496
};
497

    
498
enum AVColorRange{
499
    AVCOL_RANGE_UNSPECIFIED=0,
500
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
501
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
502
    AVCOL_RANGE_NB           , ///< Not part of ABI
503
};
504

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

    
521
typedef struct RcOverride{
522
    int start_frame;
523
    int end_frame;
524
    int qscale; // If this is 0 then quality_factor will be used instead.
525
    float quality_factor;
526
} RcOverride;
527

    
528
#define FF_MAX_B_FRAMES 16
529

    
530
/* encoding support
531
   These flags can be passed in AVCodecContext.flags before initialization.
532
   Note: Not everything is supported yet.
533
*/
534

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

    
593
/* Unsupported options :
594
 *              Syntax Arithmetic coding (SAC)
595
 *              Reference Picture Selection
596
 *              Independent Segment Decoding */
597
/* /Fx */
598
/* codec capabilities */
599

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

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

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

    
675
    /**
676
     * width and height in 1/16 pel
677
     * - encoding: Set by user.
678
     * - decoding: Set by libavcodec.
679
     */
680
    int width;
681
    int height;
682

    
683
    /**
684
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
685
     * - encoding: Set by user.
686
     * - decoding: Set by libavcodec.
687
     */
688
    int16_t position[3][2];
689
}AVPanScan;
690

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

    
918

    
919
#define FF_QSCALE_TYPE_MPEG1 0
920
#define FF_QSCALE_TYPE_MPEG2 1
921
#define FF_QSCALE_TYPE_H264  2
922
#define FF_QSCALE_TYPE_VP56  3
923

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

    
929

    
930
#define FF_I_TYPE  1 ///< Intra
931
#define FF_P_TYPE  2 ///< Predicted
932
#define FF_B_TYPE  3 ///< Bi-dir predicted
933
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
934
#define FF_SI_TYPE 5 ///< Switching Intra
935
#define FF_SP_TYPE 6 ///< Switching Predicted
936
#define FF_BI_TYPE 7
937

    
938
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
939
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
940
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
941
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
942

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

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

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

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

    
1028
    /**
1029
     * number of bits the bitstream is allowed to diverge from the reference.
1030
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1031
     * - encoding: Set by user; unused for constant quantizer encoding.
1032
     * - decoding: unused
1033
     */
1034
    int bit_rate_tolerance;
1035

    
1036
    /**
1037
     * CODEC_FLAG_*.
1038
     * - encoding: Set by user.
1039
     * - decoding: Set by user.
1040
     */
1041
    int flags;
1042

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

    
1053
    /**
1054
     * Motion estimation algorithm used for video coding.
1055
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1056
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1057
     * - encoding: MUST be set by user.
1058
     * - decoding: unused
1059
     */
1060
    int me_method;
1061

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

    
1076
    /**
1077
     * This is the fundamental unit of time (in seconds) in terms
1078
     * of which frame timestamps are represented. For fixed-fps content,
1079
     * timebase should be 1/framerate and timestamp increments should be
1080
     * identically 1.
1081
     * - encoding: MUST be set by user.
1082
     * - decoding: Set by libavcodec.
1083
     */
1084
    AVRational time_base;
1085

    
1086
    /* video only */
1087
    /**
1088
     * picture width / height.
1089
     * - encoding: MUST be set by user.
1090
     * - decoding: Set by libavcodec.
1091
     * Note: For compatibility it is possible to set this instead of
1092
     * coded_width/height before decoding.
1093
     */
1094
    int width, height;
1095

    
1096
#define FF_ASPECT_EXTENDED 15
1097

    
1098
    /**
1099
     * the number of pictures in a group of pictures, or 0 for intra_only
1100
     * - encoding: Set by user.
1101
     * - decoding: unused
1102
     */
1103
    int gop_size;
1104

    
1105
    /**
1106
     * Pixel format, see PIX_FMT_xxx.
1107
     * - encoding: Set by user.
1108
     * - decoding: Set by libavcodec.
1109
     */
1110
    enum PixelFormat pix_fmt;
1111

    
1112
    /**
1113
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1114
     * has to read frames at native frame rate.
1115
     * - encoding: Set by user.
1116
     * - decoding: unused
1117
     */
1118
    int rate_emu;
1119

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

    
1143
    /* audio only */
1144
    int sample_rate; ///< samples per second
1145
    int channels;    ///< number of audio channels
1146

    
1147
    /**
1148
     * audio sample format
1149
     * - encoding: Set by user.
1150
     * - decoding: Set by libavcodec.
1151
     */
1152
    enum SampleFormat sample_fmt;  ///< sample format
1153

    
1154
    /* The following data should not be initialized. */
1155
    /**
1156
     * Samples per packet, initialized when calling 'init'.
1157
     */
1158
    int frame_size;
1159
    int frame_number;   ///< audio or video frame number
1160
#if LIBAVCODEC_VERSION_MAJOR < 53
1161
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1162
#endif
1163

    
1164
    /**
1165
     * Number of frames the decoded output will be delayed relative to
1166
     * the encoded input.
1167
     * - encoding: Set by libavcodec.
1168
     * - decoding: unused
1169
     */
1170
    int delay;
1171

    
1172
    /* - encoding parameters */
1173
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1174
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1175

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

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

    
1190
    /**
1191
     * maximum quantizer difference between frames
1192
     * - encoding: Set by user.
1193
     * - decoding: unused
1194
     */
1195
    int max_qdiff;
1196

    
1197
    /**
1198
     * maximum number of B-frames between non-B-frames
1199
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1200
     * - encoding: Set by user.
1201
     * - decoding: unused
1202
     */
1203
    int max_b_frames;
1204

    
1205
    /**
1206
     * qscale factor between IP and B-frames
1207
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1208
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1209
     * - encoding: Set by user.
1210
     * - decoding: unused
1211
     */
1212
    float b_quant_factor;
1213

    
1214
    /** obsolete FIXME remove */
1215
    int rc_strategy;
1216
#define FF_RC_STRATEGY_XVID 1
1217

    
1218
    int b_frame_strategy;
1219

    
1220
    /**
1221
     * hurry up amount
1222
     * - encoding: unused
1223
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1224
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1225
     */
1226
    int hurry_up;
1227

    
1228
    struct AVCodec *codec;
1229

    
1230
    void *priv_data;
1231

    
1232
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1233
                            /* do its best to deliver a chunk with size     */
1234
                            /* below rtp_payload_size, the chunk will start */
1235
                            /* with a start code on some codecs like H.263. */
1236
                            /* This doesn't take account of any particular  */
1237
                            /* headers inside the transmitted RTP payload.  */
1238

    
1239

    
1240
    /* The RTP callback: This function is called    */
1241
    /* every time the encoder has a packet to send. */
1242
    /* It depends on the encoder if the data starts */
1243
    /* with a Start Code (it should). H.263 does.   */
1244
    /* mb_nb contains the number of macroblocks     */
1245
    /* encoded in the RTP payload.                  */
1246
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1247

    
1248
    /* statistics, used for 2-pass encoding */
1249
    int mv_bits;
1250
    int header_bits;
1251
    int i_tex_bits;
1252
    int p_tex_bits;
1253
    int i_count;
1254
    int p_count;
1255
    int skip_count;
1256
    int misc_bits;
1257

    
1258
    /**
1259
     * number of bits used for the previously encoded frame
1260
     * - encoding: Set by libavcodec.
1261
     * - decoding: unused
1262
     */
1263
    int frame_bits;
1264

    
1265
    /**
1266
     * Private data of the user, can be used to carry app specific stuff.
1267
     * - encoding: Set by user.
1268
     * - decoding: Set by user.
1269
     */
1270
    void *opaque;
1271

    
1272
    char codec_name[32];
1273
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1274
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1275

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

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

    
1315
    /**
1316
     * luma single coefficient elimination threshold
1317
     * - encoding: Set by user.
1318
     * - decoding: unused
1319
     */
1320
    int luma_elim_threshold;
1321

    
1322
    /**
1323
     * chroma single coeff elimination threshold
1324
     * - encoding: Set by user.
1325
     * - decoding: unused
1326
     */
1327
    int chroma_elim_threshold;
1328

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

    
1348
    /**
1349
     * qscale offset between IP and B-frames
1350
     * - encoding: Set by user.
1351
     * - decoding: unused
1352
     */
1353
    float b_quant_offset;
1354

    
1355
    /**
1356
     * Error recognization; higher values will detect more errors but may
1357
     * misdetect some more or less valid parts as errors.
1358
     * - encoding: unused
1359
     * - decoding: Set by user.
1360
     */
1361
    int error_recognition;
1362
#define FF_ER_CAREFUL         1
1363
#define FF_ER_COMPLIANT       2
1364
#define FF_ER_AGGRESSIVE      3
1365
#define FF_ER_VERY_AGGRESSIVE 4
1366

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

    
1380
    /**
1381
     * Called to release buffers which were allocated with get_buffer.
1382
     * A released buffer can be reused in get_buffer().
1383
     * pic.data[*] must be set to NULL.
1384
     * - encoding: unused
1385
     * - decoding: Set by libavcodec., user can override.
1386
     */
1387
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1388

    
1389
    /**
1390
     * Size of the frame reordering buffer in the decoder.
1391
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1392
     * - encoding: Set by libavcodec.
1393
     * - decoding: Set by libavcodec.
1394
     */
1395
    int has_b_frames;
1396

    
1397
    /**
1398
     * number of bytes per packet if constant and known or 0
1399
     * Used by some WAV based audio codecs.
1400
     */
1401
    int block_align;
1402

    
1403
    int parse_only; /* - decoding only: If true, only parsing is done
1404
                       (function avcodec_parse_frame()). The frame
1405
                       data is returned. Only MPEG codecs support this now. */
1406

    
1407
    /**
1408
     * 0-> h263 quant 1-> mpeg quant
1409
     * - encoding: Set by user.
1410
     * - decoding: unused
1411
     */
1412
    int mpeg_quant;
1413

    
1414
    /**
1415
     * pass1 encoding statistics output buffer
1416
     * - encoding: Set by libavcodec.
1417
     * - decoding: unused
1418
     */
1419
    char *stats_out;
1420

    
1421
    /**
1422
     * pass2 encoding statistics input buffer
1423
     * Concatenated stuff from stats_out of pass1 should be placed here.
1424
     * - encoding: Allocated/set/freed by user.
1425
     * - decoding: unused
1426
     */
1427
    char *stats_in;
1428

    
1429
    /**
1430
     * ratecontrol qmin qmax limiting method
1431
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1432
     * - encoding: Set by user.
1433
     * - decoding: unused
1434
     */
1435
    float rc_qsquish;
1436

    
1437
    float rc_qmod_amp;
1438
    int rc_qmod_freq;
1439

    
1440
    /**
1441
     * ratecontrol override, see RcOverride
1442
     * - encoding: Allocated/set/freed by user.
1443
     * - decoding: unused
1444
     */
1445
    RcOverride *rc_override;
1446
    int rc_override_count;
1447

    
1448
    /**
1449
     * rate control equation
1450
     * - encoding: Set by user
1451
     * - decoding: unused
1452
     */
1453
    const char *rc_eq;
1454

    
1455
    /**
1456
     * maximum bitrate
1457
     * - encoding: Set by user.
1458
     * - decoding: unused
1459
     */
1460
    int rc_max_rate;
1461

    
1462
    /**
1463
     * minimum bitrate
1464
     * - encoding: Set by user.
1465
     * - decoding: unused
1466
     */
1467
    int rc_min_rate;
1468

    
1469
    /**
1470
     * decoder bitstream buffer size
1471
     * - encoding: Set by user.
1472
     * - decoding: unused
1473
     */
1474
    int rc_buffer_size;
1475
    float rc_buffer_aggressivity;
1476

    
1477
    /**
1478
     * qscale factor between P and I-frames
1479
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1480
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1481
     * - encoding: Set by user.
1482
     * - decoding: unused
1483
     */
1484
    float i_quant_factor;
1485

    
1486
    /**
1487
     * qscale offset between P and I-frames
1488
     * - encoding: Set by user.
1489
     * - decoding: unused
1490
     */
1491
    float i_quant_offset;
1492

    
1493
    /**
1494
     * initial complexity for pass1 ratecontrol
1495
     * - encoding: Set by user.
1496
     * - decoding: unused
1497
     */
1498
    float rc_initial_cplx;
1499

    
1500
    /**
1501
     * DCT algorithm, see FF_DCT_* below
1502
     * - encoding: Set by user.
1503
     * - decoding: unused
1504
     */
1505
    int dct_algo;
1506
#define FF_DCT_AUTO    0
1507
#define FF_DCT_FASTINT 1
1508
#define FF_DCT_INT     2
1509
#define FF_DCT_MMX     3
1510
#define FF_DCT_MLIB    4
1511
#define FF_DCT_ALTIVEC 5
1512
#define FF_DCT_FAAN    6
1513

    
1514
    /**
1515
     * luminance masking (0-> disabled)
1516
     * - encoding: Set by user.
1517
     * - decoding: unused
1518
     */
1519
    float lumi_masking;
1520

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

    
1528
    /**
1529
     * spatial complexity masking (0-> disabled)
1530
     * - encoding: Set by user.
1531
     * - decoding: unused
1532
     */
1533
    float spatial_cplx_masking;
1534

    
1535
    /**
1536
     * p block masking (0-> disabled)
1537
     * - encoding: Set by user.
1538
     * - decoding: unused
1539
     */
1540
    float p_masking;
1541

    
1542
    /**
1543
     * darkness masking (0-> disabled)
1544
     * - encoding: Set by user.
1545
     * - decoding: unused
1546
     */
1547
    float dark_masking;
1548

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

    
1581
    /**
1582
     * slice count
1583
     * - encoding: Set by libavcodec.
1584
     * - decoding: Set by user (or 0).
1585
     */
1586
    int slice_count;
1587
    /**
1588
     * slice offsets in the frame in bytes
1589
     * - encoding: Set/allocated by libavcodec.
1590
     * - decoding: Set/allocated by user (or NULL).
1591
     */
1592
    int *slice_offset;
1593

    
1594
    /**
1595
     * error concealment flags
1596
     * - encoding: unused
1597
     * - decoding: Set by user.
1598
     */
1599
    int error_concealment;
1600
#define FF_EC_GUESS_MVS   1
1601
#define FF_EC_DEBLOCK     2
1602

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

    
1630
    /**
1631
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1632
     * - encoding: Set by libavcodec.
1633
     * - decoding: Set by user.
1634
     */
1635
     int bits_per_coded_sample;
1636

    
1637
    /**
1638
     * prediction method (needed for huffyuv)
1639
     * - encoding: Set by user.
1640
     * - decoding: unused
1641
     */
1642
     int prediction_method;
1643
#define FF_PRED_LEFT   0
1644
#define FF_PRED_PLANE  1
1645
#define FF_PRED_MEDIAN 2
1646

    
1647
    /**
1648
     * sample aspect ratio (0 if unknown)
1649
     * That is the width of a pixel divided by the height of the pixel.
1650
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1651
     * - encoding: Set by user.
1652
     * - decoding: Set by libavcodec.
1653
     */
1654
    AVRational sample_aspect_ratio;
1655

    
1656
    /**
1657
     * the picture in the bitstream
1658
     * - encoding: Set by libavcodec.
1659
     * - decoding: Set by libavcodec.
1660
     */
1661
    AVFrame *coded_frame;
1662

    
1663
    /**
1664
     * debug
1665
     * - encoding: Set by user.
1666
     * - decoding: Set by user.
1667
     */
1668
    int debug;
1669
#define FF_DEBUG_PICT_INFO   1
1670
#define FF_DEBUG_RC          2
1671
#define FF_DEBUG_BITSTREAM   4
1672
#define FF_DEBUG_MB_TYPE     8
1673
#define FF_DEBUG_QP          16
1674
#define FF_DEBUG_MV          32
1675
#define FF_DEBUG_DCT_COEFF   0x00000040
1676
#define FF_DEBUG_SKIP        0x00000080
1677
#define FF_DEBUG_STARTCODE   0x00000100
1678
#define FF_DEBUG_PTS         0x00000200
1679
#define FF_DEBUG_ER          0x00000400
1680
#define FF_DEBUG_MMCO        0x00000800
1681
#define FF_DEBUG_BUGS        0x00001000
1682
#define FF_DEBUG_VIS_QP      0x00002000
1683
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1684
#define FF_DEBUG_BUFFERS     0x00008000
1685

    
1686
    /**
1687
     * debug
1688
     * - encoding: Set by user.
1689
     * - decoding: Set by user.
1690
     */
1691
    int debug_mv;
1692
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1693
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1694
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1695

    
1696
    /**
1697
     * error
1698
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1699
     * - decoding: unused
1700
     */
1701
    uint64_t error[4];
1702

    
1703
    /**
1704
     * minimum MB quantizer
1705
     * - encoding: unused
1706
     * - decoding: unused
1707
     */
1708
    int mb_qmin;
1709

    
1710
    /**
1711
     * maximum MB quantizer
1712
     * - encoding: unused
1713
     * - decoding: unused
1714
     */
1715
    int mb_qmax;
1716

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

    
1758
    /**
1759
     * ME diamond size & shape
1760
     * - encoding: Set by user.
1761
     * - decoding: unused
1762
     */
1763
    int dia_size;
1764

    
1765
    /**
1766
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1767
     * - encoding: Set by user.
1768
     * - decoding: unused
1769
     */
1770
    int last_predictor_count;
1771

    
1772
    /**
1773
     * prepass for motion estimation
1774
     * - encoding: Set by user.
1775
     * - decoding: unused
1776
     */
1777
    int pre_me;
1778

    
1779
    /**
1780
     * motion estimation prepass comparison function
1781
     * - encoding: Set by user.
1782
     * - decoding: unused
1783
     */
1784
    int me_pre_cmp;
1785

    
1786
    /**
1787
     * ME prepass diamond size & shape
1788
     * - encoding: Set by user.
1789
     * - decoding: unused
1790
     */
1791
    int pre_dia_size;
1792

    
1793
    /**
1794
     * subpel ME quality
1795
     * - encoding: Set by user.
1796
     * - decoding: unused
1797
     */
1798
    int me_subpel_quality;
1799

    
1800
    /**
1801
     * callback to negotiate the pixelFormat
1802
     * @param fmt is the list of formats which are supported by the codec,
1803
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1804
     * The first is always the native one.
1805
     * @return the chosen format
1806
     * - encoding: unused
1807
     * - decoding: Set by user, if not set the native format will be chosen.
1808
     */
1809
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1810

    
1811
    /**
1812
     * DTG active format information (additional aspect ratio
1813
     * information only used in DVB MPEG-2 transport streams)
1814
     * 0 if not set.
1815
     *
1816
     * - encoding: unused
1817
     * - decoding: Set by decoder.
1818
     */
1819
    int dtg_active_format;
1820
#define FF_DTG_AFD_SAME         8
1821
#define FF_DTG_AFD_4_3          9
1822
#define FF_DTG_AFD_16_9         10
1823
#define FF_DTG_AFD_14_9         11
1824
#define FF_DTG_AFD_4_3_SP_14_9  13
1825
#define FF_DTG_AFD_16_9_SP_14_9 14
1826
#define FF_DTG_AFD_SP_4_3       15
1827

    
1828
    /**
1829
     * maximum motion estimation search range in subpel units
1830
     * If 0 then no limit.
1831
     *
1832
     * - encoding: Set by user.
1833
     * - decoding: unused
1834
     */
1835
    int me_range;
1836

    
1837
    /**
1838
     * intra quantizer bias
1839
     * - encoding: Set by user.
1840
     * - decoding: unused
1841
     */
1842
    int intra_quant_bias;
1843
#define FF_DEFAULT_QUANT_BIAS 999999
1844

    
1845
    /**
1846
     * inter quantizer bias
1847
     * - encoding: Set by user.
1848
     * - decoding: unused
1849
     */
1850
    int inter_quant_bias;
1851

    
1852
    /**
1853
     * color table ID
1854
     * - encoding: unused
1855
     * - decoding: Which clrtable should be used for 8bit RGB images.
1856
     *             Tables have to be stored somewhere. FIXME
1857
     */
1858
    int color_table_id;
1859

    
1860
    /**
1861
     * internal_buffer count
1862
     * Don't touch, used by libavcodec default_get_buffer().
1863
     */
1864
    int internal_buffer_count;
1865

    
1866
    /**
1867
     * internal_buffers
1868
     * Don't touch, used by libavcodec default_get_buffer().
1869
     */
1870
    void *internal_buffer;
1871

    
1872
#define FF_LAMBDA_SHIFT 7
1873
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1874
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1875
#define FF_LAMBDA_MAX (256*128-1)
1876

    
1877
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1878
    /**
1879
     * Global quality for codecs which cannot change it per frame.
1880
     * This should be proportional to MPEG-1/2/4 qscale.
1881
     * - encoding: Set by user.
1882
     * - decoding: unused
1883
     */
1884
    int global_quality;
1885

    
1886
#define FF_CODER_TYPE_VLC       0
1887
#define FF_CODER_TYPE_AC        1
1888
#define FF_CODER_TYPE_RAW       2
1889
#define FF_CODER_TYPE_RLE       3
1890
#define FF_CODER_TYPE_DEFLATE   4
1891
    /**
1892
     * coder type
1893
     * - encoding: Set by user.
1894
     * - decoding: unused
1895
     */
1896
    int coder_type;
1897

    
1898
    /**
1899
     * context model
1900
     * - encoding: Set by user.
1901
     * - decoding: unused
1902
     */
1903
    int context_model;
1904
#if 0
1905
    /**
1906
     *
1907
     * - encoding: unused
1908
     * - decoding: Set by user.
1909
     */
1910
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1911
#endif
1912

    
1913
    /**
1914
     * slice flags
1915
     * - encoding: unused
1916
     * - decoding: Set by user.
1917
     */
1918
    int slice_flags;
1919
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1920
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1921
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1922

    
1923
    /**
1924
     * XVideo Motion Acceleration
1925
     * - encoding: forbidden
1926
     * - decoding: set by decoder
1927
     */
1928
    int xvmc_acceleration;
1929

    
1930
    /**
1931
     * macroblock decision mode
1932
     * - encoding: Set by user.
1933
     * - decoding: unused
1934
     */
1935
    int mb_decision;
1936
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1937
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1938
#define FF_MB_DECISION_RD     2        ///< rate distortion
1939

    
1940
    /**
1941
     * custom intra quantization matrix
1942
     * - encoding: Set by user, can be NULL.
1943
     * - decoding: Set by libavcodec.
1944
     */
1945
    uint16_t *intra_matrix;
1946

    
1947
    /**
1948
     * custom inter quantization matrix
1949
     * - encoding: Set by user, can be NULL.
1950
     * - decoding: Set by libavcodec.
1951
     */
1952
    uint16_t *inter_matrix;
1953

    
1954
    /**
1955
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1956
     * This is used to work around some encoder bugs.
1957
     * - encoding: unused
1958
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1959
     */
1960
    unsigned int stream_codec_tag;
1961

    
1962
    /**
1963
     * scene change detection threshold
1964
     * 0 is default, larger means fewer detected scene changes.
1965
     * - encoding: Set by user.
1966
     * - decoding: unused
1967
     */
1968
    int scenechange_threshold;
1969

    
1970
    /**
1971
     * minimum Lagrange multipler
1972
     * - encoding: Set by user.
1973
     * - decoding: unused
1974
     */
1975
    int lmin;
1976

    
1977
    /**
1978
     * maximum Lagrange multipler
1979
     * - encoding: Set by user.
1980
     * - decoding: unused
1981
     */
1982
    int lmax;
1983

    
1984
    /**
1985
     * palette control structure
1986
     * - encoding: ??? (no palette-enabled encoder yet)
1987
     * - decoding: Set by user.
1988
     */
1989
    struct AVPaletteControl *palctrl;
1990

    
1991
    /**
1992
     * noise reduction strength
1993
     * - encoding: Set by user.
1994
     * - decoding: unused
1995
     */
1996
    int noise_reduction;
1997

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

    
2012
    /**
2013
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2014
     * - encoding: Set by user.
2015
     * - decoding: unused
2016
     */
2017
    int rc_initial_buffer_occupancy;
2018

    
2019
    /**
2020
     *
2021
     * - encoding: Set by user.
2022
     * - decoding: unused
2023
     */
2024
    int inter_threshold;
2025

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

    
2033
    /**
2034
     * Simulates errors in the bitstream to test error concealment.
2035
     * - encoding: Set by user.
2036
     * - decoding: unused
2037
     */
2038
    int error_rate;
2039

    
2040
    /**
2041
     * MP3 antialias algorithm, see FF_AA_* below.
2042
     * - encoding: unused
2043
     * - decoding: Set by user.
2044
     */
2045
    int antialias_algo;
2046
#define FF_AA_AUTO    0
2047
#define FF_AA_FASTINT 1 //not implemented yet
2048
#define FF_AA_INT     2
2049
#define FF_AA_FLOAT   3
2050
    /**
2051
     * quantizer noise shaping
2052
     * - encoding: Set by user.
2053
     * - decoding: unused
2054
     */
2055
    int quantizer_noise_shaping;
2056

    
2057
    /**
2058
     * thread count
2059
     * is used to decide how many independent tasks should be passed to execute()
2060
     * - encoding: Set by user.
2061
     * - decoding: Set by user.
2062
     */
2063
    int thread_count;
2064

    
2065
    /**
2066
     * The codec may call this to execute several independent things.
2067
     * It will return only after finishing all tasks.
2068
     * The user may replace this with some multithreaded implementation,
2069
     * the default implementation will execute the parts serially.
2070
     * @param count the number of things to execute
2071
     * - encoding: Set by libavcodec, user can override.
2072
     * - decoding: Set by libavcodec, user can override.
2073
     */
2074
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2075

    
2076
    /**
2077
     * thread opaque
2078
     * Can be used by execute() to store some per AVCodecContext stuff.
2079
     * - encoding: set by execute()
2080
     * - decoding: set by execute()
2081
     */
2082
    void *thread_opaque;
2083

    
2084
    /**
2085
     * Motion estimation threshold below which no motion estimation is
2086
     * performed, but instead the user specified motion vectors are used.
2087
     *
2088
     * - encoding: Set by user.
2089
     * - decoding: unused
2090
     */
2091
     int me_threshold;
2092

    
2093
    /**
2094
     * Macroblock threshold below which the user specified macroblock types will be used.
2095
     * - encoding: Set by user.
2096
     * - decoding: unused
2097
     */
2098
     int mb_threshold;
2099

    
2100
    /**
2101
     * precision of the intra DC coefficient - 8
2102
     * - encoding: Set by user.
2103
     * - decoding: unused
2104
     */
2105
     int intra_dc_precision;
2106

    
2107
    /**
2108
     * noise vs. sse weight for the nsse comparsion function
2109
     * - encoding: Set by user.
2110
     * - decoding: unused
2111
     */
2112
     int nsse_weight;
2113

    
2114
    /**
2115
     * Number of macroblock rows at the top which are skipped.
2116
     * - encoding: unused
2117
     * - decoding: Set by user.
2118
     */
2119
     int skip_top;
2120

    
2121
    /**
2122
     * Number of macroblock rows at the bottom which are skipped.
2123
     * - encoding: unused
2124
     * - decoding: Set by user.
2125
     */
2126
     int skip_bottom;
2127

    
2128
    /**
2129
     * profile
2130
     * - encoding: Set by user.
2131
     * - decoding: Set by libavcodec.
2132
     */
2133
     int profile;
2134
#define FF_PROFILE_UNKNOWN -99
2135

    
2136
#define FF_PROFILE_AAC_MAIN 0
2137
#define FF_PROFILE_AAC_LOW  1
2138
#define FF_PROFILE_AAC_SSR  2
2139
#define FF_PROFILE_AAC_LTP  3
2140

    
2141
#define FF_PROFILE_H264_BASELINE    66
2142
#define FF_PROFILE_H264_MAIN        77
2143
#define FF_PROFILE_H264_EXTENDED    88
2144
#define FF_PROFILE_H264_HIGH        100
2145
#define FF_PROFILE_H264_HIGH_10     110
2146
#define FF_PROFILE_H264_HIGH_422    122
2147
#define FF_PROFILE_H264_HIGH_444    244
2148
#define FF_PROFILE_H264_CAVLC_444   44
2149

    
2150
    /**
2151
     * level
2152
     * - encoding: Set by user.
2153
     * - decoding: Set by libavcodec.
2154
     */
2155
     int level;
2156
#define FF_LEVEL_UNKNOWN -99
2157

    
2158
    /**
2159
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2160
     * - encoding: unused
2161
     * - decoding: Set by user.
2162
     */
2163
     int lowres;
2164

    
2165
    /**
2166
     * Bitstream width / height, may be different from width/height if lowres
2167
     * or other things are used.
2168
     * - encoding: unused
2169
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2170
     */
2171
    int coded_width, coded_height;
2172

    
2173
    /**
2174
     * frame skip threshold
2175
     * - encoding: Set by user.
2176
     * - decoding: unused
2177
     */
2178
    int frame_skip_threshold;
2179

    
2180
    /**
2181
     * frame skip factor
2182
     * - encoding: Set by user.
2183
     * - decoding: unused
2184
     */
2185
    int frame_skip_factor;
2186

    
2187
    /**
2188
     * frame skip exponent
2189
     * - encoding: Set by user.
2190
     * - decoding: unused
2191
     */
2192
    int frame_skip_exp;
2193

    
2194
    /**
2195
     * frame skip comparison function
2196
     * - encoding: Set by user.
2197
     * - decoding: unused
2198
     */
2199
    int frame_skip_cmp;
2200

    
2201
    /**
2202
     * Border processing masking, raises the quantizer for mbs on the borders
2203
     * of the picture.
2204
     * - encoding: Set by user.
2205
     * - decoding: unused
2206
     */
2207
    float border_masking;
2208

    
2209
    /**
2210
     * minimum MB lagrange multipler
2211
     * - encoding: Set by user.
2212
     * - decoding: unused
2213
     */
2214
    int mb_lmin;
2215

    
2216
    /**
2217
     * maximum MB lagrange multipler
2218
     * - encoding: Set by user.
2219
     * - decoding: unused
2220
     */
2221
    int mb_lmax;
2222

    
2223
    /**
2224
     *
2225
     * - encoding: Set by user.
2226
     * - decoding: unused
2227
     */
2228
    int me_penalty_compensation;
2229

    
2230
    /**
2231
     *
2232
     * - encoding: unused
2233
     * - decoding: Set by user.
2234
     */
2235
    enum AVDiscard skip_loop_filter;
2236

    
2237
    /**
2238
     *
2239
     * - encoding: unused
2240
     * - decoding: Set by user.
2241
     */
2242
    enum AVDiscard skip_idct;
2243

    
2244
    /**
2245
     *
2246
     * - encoding: unused
2247
     * - decoding: Set by user.
2248
     */
2249
    enum AVDiscard skip_frame;
2250

    
2251
    /**
2252
     *
2253
     * - encoding: Set by user.
2254
     * - decoding: unused
2255
     */
2256
    int bidir_refine;
2257

    
2258
    /**
2259
     *
2260
     * - encoding: Set by user.
2261
     * - decoding: unused
2262
     */
2263
    int brd_scale;
2264

    
2265
    /**
2266
     * constant rate factor - quality-based VBR - values ~correspond to qps
2267
     * - encoding: Set by user.
2268
     * - decoding: unused
2269
     */
2270
    float crf;
2271

    
2272
    /**
2273
     * constant quantization parameter rate control method
2274
     * - encoding: Set by user.
2275
     * - decoding: unused
2276
     */
2277
    int cqp;
2278

    
2279
    /**
2280
     * minimum GOP size
2281
     * - encoding: Set by user.
2282
     * - decoding: unused
2283
     */
2284
    int keyint_min;
2285

    
2286
    /**
2287
     * number of reference frames
2288
     * - encoding: Set by user.
2289
     * - decoding: Set by lavc.
2290
     */
2291
    int refs;
2292

    
2293
    /**
2294
     * chroma qp offset from luma
2295
     * - encoding: Set by user.
2296
     * - decoding: unused
2297
     */
2298
    int chromaoffset;
2299

    
2300
    /**
2301
     * Influences how often B-frames are used.
2302
     * - encoding: Set by user.
2303
     * - decoding: unused
2304
     */
2305
    int bframebias;
2306

    
2307
    /**
2308
     * trellis RD quantization
2309
     * - encoding: Set by user.
2310
     * - decoding: unused
2311
     */
2312
    int trellis;
2313

    
2314
    /**
2315
     * Reduce fluctuations in qp (before curve compression).
2316
     * - encoding: Set by user.
2317
     * - decoding: unused
2318
     */
2319
    float complexityblur;
2320

    
2321
    /**
2322
     * in-loop deblocking filter alphac0 parameter
2323
     * alpha is in the range -6...6
2324
     * - encoding: Set by user.
2325
     * - decoding: unused
2326
     */
2327
    int deblockalpha;
2328

    
2329
    /**
2330
     * in-loop deblocking filter beta parameter
2331
     * beta is in the range -6...6
2332
     * - encoding: Set by user.
2333
     * - decoding: unused
2334
     */
2335
    int deblockbeta;
2336

    
2337
    /**
2338
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2339
     * - encoding: Set by user.
2340
     * - decoding: unused
2341
     */
2342
    int partitions;
2343
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2344
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2345
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2346
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2347
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2348

    
2349
    /**
2350
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2351
     * - encoding: Set by user.
2352
     * - decoding: unused
2353
     */
2354
    int directpred;
2355

    
2356
    /**
2357
     * Audio cutoff bandwidth (0 means "automatic")
2358
     * - encoding: Set by user.
2359
     * - decoding: unused
2360
     */
2361
    int cutoff;
2362

    
2363
    /**
2364
     * Multiplied by qscale for each frame and added to scene_change_score.
2365
     * - encoding: Set by user.
2366
     * - decoding: unused
2367
     */
2368
    int scenechange_factor;
2369

    
2370
    /**
2371
     *
2372
     * Note: Value depends upon the compare function used for fullpel ME.
2373
     * - encoding: Set by user.
2374
     * - decoding: unused
2375
     */
2376
    int mv0_threshold;
2377

    
2378
    /**
2379
     * Adjusts sensitivity of b_frame_strategy 1.
2380
     * - encoding: Set by user.
2381
     * - decoding: unused
2382
     */
2383
    int b_sensitivity;
2384

    
2385
    /**
2386
     * - encoding: Set by user.
2387
     * - decoding: unused
2388
     */
2389
    int compression_level;
2390
#define FF_COMPRESSION_DEFAULT -1
2391

    
2392
    /**
2393
     * Sets whether to use LPC mode - used by FLAC encoder.
2394
     * - encoding: Set by user.
2395
     * - decoding: unused
2396
     */
2397
    int use_lpc;
2398

    
2399
    /**
2400
     * LPC coefficient precision - used by FLAC encoder
2401
     * - encoding: Set by user.
2402
     * - decoding: unused
2403
     */
2404
    int lpc_coeff_precision;
2405

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

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

    
2418
    /**
2419
     * search method for selecting prediction order
2420
     * - encoding: Set by user.
2421
     * - decoding: unused
2422
     */
2423
    int prediction_order_method;
2424

    
2425
    /**
2426
     * - encoding: Set by user.
2427
     * - decoding: unused
2428
     */
2429
    int min_partition_order;
2430

    
2431
    /**
2432
     * - encoding: Set by user.
2433
     * - decoding: unused
2434
     */
2435
    int max_partition_order;
2436

    
2437
    /**
2438
     * GOP timecode frame start number, in non drop frame format
2439
     * - encoding: Set by user.
2440
     * - decoding: unused
2441
     */
2442
    int64_t timecode_frame_start;
2443

    
2444
#if LIBAVCODEC_VERSION_MAJOR < 53
2445
    /**
2446
     * Decoder should decode to this many channels if it can (0 for default)
2447
     * - encoding: unused
2448
     * - decoding: Set by user.
2449
     * @deprecated Deprecated in favor of request_channel_layout.
2450
     */
2451
    int request_channels;
2452
#endif
2453

    
2454
    /**
2455
     * Percentage of dynamic range compression to be applied by the decoder.
2456
     * The default value is 1.0, corresponding to full compression.
2457
     * - encoding: unused
2458
     * - decoding: Set by user.
2459
     */
2460
    float drc_scale;
2461

    
2462
    /**
2463
     * opaque 64bit number (generally a PTS) that will be reordered and
2464
     * output in AVFrame.reordered_opaque
2465
     * - encoding: unused
2466
     * - decoding: Set by user.
2467
     */
2468
    int64_t reordered_opaque;
2469

    
2470
    /**
2471
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2472
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2473
     * - encoding: set by user.
2474
     * - decoding: set by libavcodec.
2475
     */
2476
    int bits_per_raw_sample;
2477

    
2478
    /**
2479
     * Audio channel layout.
2480
     * - encoding: set by user.
2481
     * - decoding: set by libavcodec.
2482
     */
2483
    int64_t channel_layout;
2484

    
2485
    /**
2486
     * Request decoder to use this channel layout if it can (0 for default)
2487
     * - encoding: unused
2488
     * - decoding: Set by user.
2489
     */
2490
    int64_t request_channel_layout;
2491

    
2492
    /**
2493
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2494
     * - encoding: Set by user.
2495
     * - decoding: unused.
2496
     */
2497
    float rc_max_available_vbv_use;
2498

    
2499
    /**
2500
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2501
     * - encoding: Set by user.
2502
     * - decoding: unused.
2503
     */
2504
    float rc_min_vbv_overflow_use;
2505

    
2506
    /**
2507
     * Hardware accelerator in use
2508
     * - encoding: unused.
2509
     * - decoding: Set by libavcodec
2510
     */
2511
    struct AVHWAccel *hwaccel;
2512

    
2513
    /**
2514
     * For some codecs, the time base is closer to the field rate than the frame rate.
2515
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2516
     * if no telecine is used ...
2517
     *
2518
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2519
     */
2520
    int ticks_per_frame;
2521

    
2522
    /**
2523
     * Hardware accelerator context.
2524
     * For some hardware accelerators, a global context needs to be
2525
     * provided by the user. In that case, this holds display-dependent
2526
     * data FFmpeg cannot instantiate itself. Please refer to the
2527
     * FFmpeg HW accelerator documentation to know how to fill this
2528
     * is. e.g. for VA API, this is a struct vaapi_context.
2529
     * - encoding: unused
2530
     * - decoding: Set by user
2531
     */
2532
    void *hwaccel_context;
2533

    
2534
    /**
2535
     * Chromaticity coordinates of the source primaries.
2536
     * - encoding: Set by user
2537
     * - decoding: Set by libavcodec
2538
     */
2539
    enum AVColorPrimaries color_primaries;
2540

    
2541
    /**
2542
     * Color Transfer Characteristic.
2543
     * - encoding: Set by user
2544
     * - decoding: Set by libavcodec
2545
     */
2546
    enum AVColorTransferCharacteristic color_trc;
2547

    
2548
    /**
2549
     * YUV colorspace type.
2550
     * - encoding: Set by user
2551
     * - decoding: Set by libavcodec
2552
     */
2553
    enum AVColorSpace colorspace;
2554

    
2555
    /**
2556
     * MPEG vs JPEG YUV range.
2557
     * - encoding: Set by user
2558
     * - decoding: Set by libavcodec
2559
     */
2560
    enum AVColorRange color_range;
2561

    
2562
    /**
2563
     * This defines the location of chroma samples.
2564
     * - encoding: Set by user
2565
     * - decoding: Set by libavcodec
2566
     */
2567
    enum AVChromaLocation chroma_sample_location;
2568

    
2569
    /**
2570
     * The codec may call this to execute several independent things.
2571
     * It will return only after finishing all tasks.
2572
     * The user may replace this with some multithreaded implementation,
2573
     * the default implementation will execute the parts serially.
2574
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2575
     * @param c context passed also to func
2576
     * @param count the number of things to execute
2577
     * @param arg2 argument passed unchanged to func
2578
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2579
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2580
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2581
     *             two instances of func executing at the same time will have the same threadnr.
2582
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2583
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2584
     * - encoding: Set by libavcodec, user can override.
2585
     * - decoding: Set by libavcodec, user can override.
2586
     */
2587
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2588

    
2589
    /**
2590
     * explicit P-frame weighted prediction analysis method
2591
     * 0: off
2592
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2593
     * 2: smart weighting (full fade detection analysis)
2594
     * - encoding: Set by user.
2595
     * - decoding: unused
2596
     */
2597
    int weighted_p_pred;
2598
} AVCodecContext;
2599

    
2600
/**
2601
 * AVCodec.
2602
 */
2603
typedef struct AVCodec {
2604
    /**
2605
     * Name of the codec implementation.
2606
     * The name is globally unique among encoders and among decoders (but an
2607
     * encoder and a decoder can share the same name).
2608
     * This is the primary way to find a codec from the user perspective.
2609
     */
2610
    const char *name;
2611
    enum CodecType type;
2612
    enum CodecID id;
2613
    int priv_data_size;
2614
    int (*init)(AVCodecContext *);
2615
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2616
    int (*close)(AVCodecContext *);
2617
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2618
    /**
2619
     * Codec capabilities.
2620
     * see CODEC_CAP_*
2621
     */
2622
    int capabilities;
2623
    struct AVCodec *next;
2624
    /**
2625
     * Flush buffers.
2626
     * Will be called when seeking
2627
     */
2628
    void (*flush)(AVCodecContext *);
2629
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2630
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2631
    /**
2632
     * Descriptive name for the codec, meant to be more human readable than name.
2633
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2634
     */
2635
    const char *long_name;
2636
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2637
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2638
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2639
} AVCodec;
2640

    
2641
/**
2642
 * AVHWAccel.
2643
 */
2644
typedef struct AVHWAccel {
2645
    /**
2646
     * Name of the hardware accelerated codec.
2647
     * The name is globally unique among encoders and among decoders (but an
2648
     * encoder and a decoder can share the same name).
2649
     */
2650
    const char *name;
2651

    
2652
    /**
2653
     * Type of codec implemented by the hardware accelerator.
2654
     *
2655
     * See CODEC_TYPE_xxx
2656
     */
2657
    enum CodecType type;
2658

    
2659
    /**
2660
     * Codec implemented by the hardware accelerator.
2661
     *
2662
     * See CODEC_ID_xxx
2663
     */
2664
    enum CodecID id;
2665

    
2666
    /**
2667
     * Supported pixel format.
2668
     *
2669
     * Only hardware accelerated formats are supported here.
2670
     */
2671
    enum PixelFormat pix_fmt;
2672

    
2673
    /**
2674
     * Hardware accelerated codec capabilities.
2675
     * see FF_HWACCEL_CODEC_CAP_*
2676
     */
2677
    int capabilities;
2678

    
2679
    struct AVHWAccel *next;
2680

    
2681
    /**
2682
     * Called at the beginning of each frame or field picture.
2683
     *
2684
     * Meaningful frame information (codec specific) is guaranteed to
2685
     * be parsed at this point. This function is mandatory.
2686
     *
2687
     * Note that buf can be NULL along with buf_size set to 0.
2688
     * Otherwise, this means the whole frame is available at this point.
2689
     *
2690
     * @param avctx the codec context
2691
     * @param buf the frame data buffer base
2692
     * @param buf_size the size of the frame in bytes
2693
     * @return zero if successful, a negative value otherwise
2694
     */
2695
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2696

    
2697
    /**
2698
     * Callback for each slice.
2699
     *
2700
     * Meaningful slice information (codec specific) is guaranteed to
2701
     * be parsed at this point. This function is mandatory.
2702
     *
2703
     * @param avctx the codec context
2704
     * @param buf the slice data buffer base
2705
     * @param buf_size the size of the slice in bytes
2706
     * @return zero if successful, a negative value otherwise
2707
     */
2708
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2709

    
2710
    /**
2711
     * Called at the end of each frame or field picture.
2712
     *
2713
     * The whole picture is parsed at this point and can now be sent
2714
     * to the hardware accelerator. This function is mandatory.
2715
     *
2716
     * @param avctx the codec context
2717
     * @return zero if successful, a negative value otherwise
2718
     */
2719
    int (*end_frame)(AVCodecContext *avctx);
2720

    
2721
    /**
2722
     * Size of HW accelerator private data.
2723
     *
2724
     * Private data is allocated with av_mallocz() before
2725
     * AVCodecContext.get_buffer() and deallocated after
2726
     * AVCodecContext.release_buffer().
2727
     */
2728
    int priv_data_size;
2729
} AVHWAccel;
2730

    
2731
/**
2732
 * four components are given, that's all.
2733
 * the last component is alpha
2734
 */
2735
typedef struct AVPicture {
2736
    uint8_t *data[4];
2737
    int linesize[4];       ///< number of bytes per line
2738
} AVPicture;
2739

    
2740
#if LIBAVCODEC_VERSION_MAJOR < 53
2741
/**
2742
 * AVPaletteControl
2743
 * This structure defines a method for communicating palette changes
2744
 * between and demuxer and a decoder.
2745
 *
2746
 * @deprecated Use AVPacket to send palette changes instead.
2747
 * This is totally broken.
2748
 */
2749
#define AVPALETTE_SIZE 1024
2750
#define AVPALETTE_COUNT 256
2751
typedef struct AVPaletteControl {
2752

    
2753
    /* Demuxer sets this to 1 to indicate the palette has changed;
2754
     * decoder resets to 0. */
2755
    int palette_changed;
2756

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

    
2763
} AVPaletteControl attribute_deprecated;
2764
#endif
2765

    
2766
enum AVSubtitleType {
2767
    SUBTITLE_NONE,
2768

    
2769
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2770

    
2771
    /**
2772
     * Plain text, the text field must be set by the decoder and is
2773
     * authoritative. ass and pict fields may contain approximations.
2774
     */
2775
    SUBTITLE_TEXT,
2776

    
2777
    /**
2778
     * Formatted text, the ass field must be set by the decoder and is
2779
     * authoritative. pict and text fields may contain approximations.
2780
     */
2781
    SUBTITLE_ASS,
2782
};
2783

    
2784
typedef struct AVSubtitleRect {
2785
    int x;         ///< top left corner  of pict, undefined when pict is not set
2786
    int y;         ///< top left corner  of pict, undefined when pict is not set
2787
    int w;         ///< width            of pict, undefined when pict is not set
2788
    int h;         ///< height           of pict, undefined when pict is not set
2789
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2790

    
2791
    /**
2792
     * data+linesize for the bitmap of this subtitle.
2793
     * can be set for text/ass as well once they where rendered
2794
     */
2795
    AVPicture pict;
2796
    enum AVSubtitleType type;
2797

    
2798
    char *text;                     ///< 0 terminated plain UTF-8 text
2799

    
2800
    /**
2801
     * 0 terminated ASS/SSA compatible event line.
2802
     * The pressentation of this is unaffected by the other values in this
2803
     * struct.
2804
     */
2805
    char *ass;
2806
} AVSubtitleRect;
2807

    
2808
typedef struct AVSubtitle {
2809
    uint16_t format; /* 0 = graphics */
2810
    uint32_t start_display_time; /* relative to packet pts, in ms */
2811
    uint32_t end_display_time; /* relative to packet pts, in ms */
2812
    unsigned num_rects;
2813
    AVSubtitleRect **rects;
2814
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2815
} AVSubtitle;
2816

    
2817
/* packet functions */
2818

    
2819
/**
2820
 * @deprecated use NULL instead
2821
 */
2822
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2823

    
2824
/**
2825
 * Default packet destructor.
2826
 */
2827
void av_destruct_packet(AVPacket *pkt);
2828

    
2829
/**
2830
 * Initialize optional fields of a packet with default values.
2831
 *
2832
 * @param pkt packet
2833
 */
2834
void av_init_packet(AVPacket *pkt);
2835

    
2836
/**
2837
 * Allocate the payload of a packet and initialize its fields with
2838
 * default values.
2839
 *
2840
 * @param pkt packet
2841
 * @param size wanted payload size
2842
 * @return 0 if OK, AVERROR_xxx otherwise
2843
 */
2844
int av_new_packet(AVPacket *pkt, int size);
2845

    
2846
/**
2847
 * Reduce packet size, correctly zeroing padding
2848
 *
2849
 * @param pkt packet
2850
 * @param size new size
2851
 */
2852
void av_shrink_packet(AVPacket *pkt, int size);
2853

    
2854
/**
2855
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2856
 * packet is allocated if it was not really allocated.
2857
 */
2858
int av_dup_packet(AVPacket *pkt);
2859

    
2860
/**
2861
 * Free a packet.
2862
 *
2863
 * @param pkt packet to free
2864
 */
2865
void av_free_packet(AVPacket *pkt);
2866

    
2867
/* resample.c */
2868

    
2869
struct ReSampleContext;
2870
struct AVResampleContext;
2871

    
2872
typedef struct ReSampleContext ReSampleContext;
2873

    
2874
#if LIBAVCODEC_VERSION_MAJOR < 53
2875
/**
2876
 * @deprecated Use av_audio_resample_init() instead.
2877
 */
2878
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2879
                                                          int output_rate, int input_rate);
2880
#endif
2881
/**
2882
 *  Initializes audio resampling context
2883
 *
2884
 * @param output_channels  number of output channels
2885
 * @param input_channels   number of input channels
2886
 * @param output_rate      output sample rate
2887
 * @param input_rate       input sample rate
2888
 * @param sample_fmt_out   requested output sample format
2889
 * @param sample_fmt_in    input sample format
2890
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2891
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2892
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2893
                           between the 2 closest, if 0 the closest will be used
2894
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2895
 * @return allocated ReSampleContext, NULL if error occured
2896
 */
2897
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2898
                                        int output_rate, int input_rate,
2899
                                        enum SampleFormat sample_fmt_out,
2900
                                        enum SampleFormat sample_fmt_in,
2901
                                        int filter_length, int log2_phase_count,
2902
                                        int linear, double cutoff);
2903

    
2904
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2905
void audio_resample_close(ReSampleContext *s);
2906

    
2907

    
2908
/**
2909
 * Initializes an audio resampler.
2910
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2911
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2912
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2913
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2914
                 between the 2 closest, if 0 the closest will be used
2915
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2916
 */
2917
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2918

    
2919
/**
2920
 * resamples.
2921
 * @param src an array of unconsumed samples
2922
 * @param consumed the number of samples of src which have been consumed are returned here
2923
 * @param src_size the number of unconsumed samples available
2924
 * @param dst_size the amount of space in samples available in dst
2925
 * @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.
2926
 * @return the number of samples written in dst or -1 if an error occurred
2927
 */
2928
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2929

    
2930

    
2931
/**
2932
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2933
 * the resampler parameters, so no audible clicks or similar distortions occur
2934
 * @param compensation_distance distance in output samples over which the compensation should be performed
2935
 * @param sample_delta number of output samples which should be output less
2936
 *
2937
 * example: av_resample_compensate(c, 10, 500)
2938
 * here instead of 510 samples only 500 samples would be output
2939
 *
2940
 * note, due to rounding the actual compensation might be slightly different,
2941
 * especially if the compensation_distance is large and the in_rate used during init is small
2942
 */
2943
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2944
void av_resample_close(struct AVResampleContext *c);
2945

    
2946
/**
2947
 * Allocate memory for a picture.  Call avpicture_free to free it.
2948
 *
2949
 * @param picture the picture to be filled in
2950
 * @param pix_fmt the format of the picture
2951
 * @param width the width of the picture
2952
 * @param height the height of the picture
2953
 * @return zero if successful, a negative value if not
2954
 */
2955
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2956

    
2957
/**
2958
 * Free a picture previously allocated by avpicture_alloc().
2959
 *
2960
 * @param picture the AVPicture to be freed
2961
 */
2962
void avpicture_free(AVPicture *picture);
2963

    
2964
/**
2965
 * Fill in the AVPicture fields.
2966
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2967
 * which points to the image data buffer. Depending on the specified picture
2968
 * format, one or multiple image data pointers and line sizes will be set.
2969
 * If a planar format is specified, several pointers will be set pointing to
2970
 * the different picture planes and the line sizes of the different planes
2971
 * will be stored in the lines_sizes array.
2972
 * Call with ptr == NULL to get the required size for the ptr buffer.
2973
 *
2974
 * @param picture AVPicture whose fields are to be filled in
2975
 * @param ptr Buffer which will contain or contains the actual image data
2976
 * @param pix_fmt The format in which the picture data is stored.
2977
 * @param width the width of the image in pixels
2978
 * @param height the height of the image in pixels
2979
 * @return size of the image data in bytes
2980
 */
2981
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2982
                   enum PixelFormat pix_fmt, int width, int height);
2983
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2984
                     unsigned char *dest, int dest_size);
2985

    
2986
/**
2987
 * Calculate the size in bytes that a picture of the given width and height
2988
 * would occupy if stored in the given picture format.
2989
 * Note that this returns the size of a compact representation as generated
2990
 * by avpicture_layout, which can be smaller than the size required for e.g.
2991
 * avpicture_fill.
2992
 *
2993
 * @param pix_fmt the given picture format
2994
 * @param width the width of the image
2995
 * @param height the height of the image
2996
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2997
 */
2998
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2999
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3000
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3001
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3002

    
3003
#if LIBAVCODEC_VERSION_MAJOR < 53
3004
/**
3005
 * Returns the pixel format corresponding to the name name.
3006
 *
3007
 * If there is no pixel format with name name, then looks for a
3008
 * pixel format with the name corresponding to the native endian
3009
 * format of name.
3010
 * For example in a little-endian system, first looks for "gray16",
3011
 * then for "gray16le".
3012
 *
3013
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
3014
 *
3015
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3016
 */
3017
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3018
#endif
3019

    
3020
/**
3021
 * Returns a value representing the fourCC code associated to the
3022
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3023
 * found.
3024
 */
3025
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3026

    
3027
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3028
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3029
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3030
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3031
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3032
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3033

    
3034
/**
3035
 * Computes what kind of losses will occur when converting from one specific
3036
 * pixel format to another.
3037
 * When converting from one pixel format to another, information loss may occur.
3038
 * For example, when converting from RGB24 to GRAY, the color information will
3039
 * be lost. Similarly, other losses occur when converting from some formats to
3040
 * other formats. These losses can involve loss of chroma, but also loss of
3041
 * resolution, loss of color depth, loss due to the color space conversion, loss
3042
 * of the alpha bits or loss due to color quantization.
3043
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3044
 * which will occur when converting from one pixel format to another.
3045
 *
3046
 * @param[in] dst_pix_fmt destination pixel format
3047
 * @param[in] src_pix_fmt source pixel format
3048
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3049
 * @return Combination of flags informing you what kind of losses will occur.
3050
 */
3051
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3052
                             int has_alpha);
3053

    
3054
/**
3055
 * Finds the best pixel format to convert to given a certain source pixel
3056
 * format.  When converting from one pixel format to another, information loss
3057
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3058
 * information will be lost. Similarly, other losses occur when converting from
3059
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3060
 * the given pixel formats should be used to suffer the least amount of loss.
3061
 * The pixel formats from which it chooses one, are determined by the
3062
 * pix_fmt_mask parameter.
3063
 *
3064
 * @code
3065
 * src_pix_fmt = PIX_FMT_YUV420P;
3066
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3067
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3068
 * @endcode
3069
 *
3070
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3071
 * @param[in] src_pix_fmt source pixel format
3072
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3073
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3074
 * @return The best pixel format to convert to or -1 if none was found.
3075
 */
3076
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3077
                              int has_alpha, int *loss_ptr);
3078

    
3079

    
3080
/**
3081
 * Print in buf the string corresponding to the pixel format with
3082
 * number pix_fmt, or an header if pix_fmt is negative.
3083
 *
3084
 * @param[in] buf the buffer where to write the string
3085
 * @param[in] buf_size the size of buf
3086
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3087
 * a negative value to print the corresponding header.
3088
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3089
 */
3090
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3091

    
3092
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3093
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3094

    
3095
/**
3096
 * Tell if an image really has transparent alpha values.
3097
 * @return ored mask of FF_ALPHA_xxx constants
3098
 */
3099
int img_get_alpha_info(const AVPicture *src,
3100
                       enum PixelFormat pix_fmt, int width, int height);
3101

    
3102
/* deinterlace a picture */
3103
/* deinterlace - if not supported return -1 */
3104
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3105
                          enum PixelFormat pix_fmt, int width, int height);
3106

    
3107
/* external high level API */
3108

    
3109
/**
3110
 * If c is NULL, returns the first registered codec,
3111
 * if c is non-NULL, returns the next registered codec after c,
3112
 * or NULL if c is the last one.
3113
 */
3114
AVCodec *av_codec_next(AVCodec *c);
3115

    
3116
/**
3117
 * Returns the LIBAVCODEC_VERSION_INT constant.
3118
 */
3119
unsigned avcodec_version(void);
3120

    
3121
/**
3122
 * Returns the libavcodec build-time configuration.
3123
 */
3124
const char *avcodec_configuration(void);
3125

    
3126
/**
3127
 * Returns the libavcodec license.
3128
 */
3129
const char *avcodec_license(void);
3130

    
3131
/**
3132
 * Initializes libavcodec.
3133
 *
3134
 * @warning This function must be called before any other libavcodec
3135
 * function.
3136
 */
3137
void avcodec_init(void);
3138

    
3139
#if LIBAVCODEC_VERSION_MAJOR < 53
3140
/**
3141
 * @deprecated Deprecated in favor of avcodec_register().
3142
 */
3143
attribute_deprecated void register_avcodec(AVCodec *codec);
3144
#endif
3145

    
3146
/**
3147
 * Register the codec codec and initialize libavcodec.
3148
 *
3149
 * @see avcodec_init()
3150
 */
3151
void avcodec_register(AVCodec *codec);
3152

    
3153
/**
3154
 * Finds a registered encoder with a matching codec ID.
3155
 *
3156
 * @param id CodecID of the requested encoder
3157
 * @return An encoder if one was found, NULL otherwise.
3158
 */
3159
AVCodec *avcodec_find_encoder(enum CodecID id);
3160

    
3161
/**
3162
 * Finds a registered encoder with the specified name.
3163
 *
3164
 * @param name name of the requested encoder
3165
 * @return An encoder if one was found, NULL otherwise.
3166
 */
3167
AVCodec *avcodec_find_encoder_by_name(const char *name);
3168

    
3169
/**
3170
 * Finds a registered decoder with a matching codec ID.
3171
 *
3172
 * @param id CodecID of the requested decoder
3173
 * @return A decoder if one was found, NULL otherwise.
3174
 */
3175
AVCodec *avcodec_find_decoder(enum CodecID id);
3176

    
3177
/**
3178
 * Finds a registered decoder with the specified name.
3179
 *
3180
 * @param name name of the requested decoder
3181
 * @return A decoder if one was found, NULL otherwise.
3182
 */
3183
AVCodec *avcodec_find_decoder_by_name(const char *name);
3184
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3185

    
3186
/**
3187
 * Sets the fields of the given AVCodecContext to default values.
3188
 *
3189
 * @param s The AVCodecContext of which the fields should be set to default values.
3190
 */
3191
void avcodec_get_context_defaults(AVCodecContext *s);
3192

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

    
3197
/**
3198
 * Allocates an AVCodecContext and sets its fields to default values.  The
3199
 * resulting struct can be deallocated by simply calling av_free().
3200
 *
3201
 * @return An AVCodecContext filled with default values or NULL on failure.
3202
 * @see avcodec_get_context_defaults
3203
 */
3204
AVCodecContext *avcodec_alloc_context(void);
3205

    
3206
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3207
 *  we WILL change its arguments and name a few times! */
3208
AVCodecContext *avcodec_alloc_context2(enum CodecType);
3209

    
3210
/**
3211
 * Sets the fields of the given AVFrame to default values.
3212
 *
3213
 * @param pic The AVFrame of which the fields should be set to default values.
3214
 */
3215
void avcodec_get_frame_defaults(AVFrame *pic);
3216

    
3217
/**
3218
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3219
 * struct can be deallocated by simply calling av_free().
3220
 *
3221
 * @return An AVFrame filled with default values or NULL on failure.
3222
 * @see avcodec_get_frame_defaults
3223
 */
3224
AVFrame *avcodec_alloc_frame(void);
3225

    
3226
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3227
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3228
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3229
/**
3230
 * Modifies width and height values so that they will result in a memory
3231
 * buffer that is acceptable for the codec if you do not use any horizontal
3232
 * padding.
3233
 */
3234
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3235
/**
3236
 * Modifies width and height values so that they will result in a memory
3237
 * buffer that is acceptable for the codec if you also ensure that all
3238
 * line sizes are a multiple of the respective linesize_align[i].
3239
 */
3240
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3241
                               int linesize_align[4]);
3242

    
3243
/**
3244
 * Checks if the given dimension of a picture is valid, meaning that all
3245
 * bytes of the picture can be addressed with a signed int.
3246
 *
3247
 * @param[in] w Width of the picture.
3248
 * @param[in] h Height of the picture.
3249
 * @return Zero if valid, a negative value if invalid.
3250
 */
3251
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3252
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3253

    
3254
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3255
void avcodec_thread_free(AVCodecContext *s);
3256
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3257
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3258
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3259
//FIXME func typedef
3260

    
3261
/**
3262
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3263
 * function the context has to be allocated.
3264
 *
3265
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3266
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3267
 * retrieving a codec.
3268
 *
3269
 * @warning This function is not thread safe!
3270
 *
3271
 * @code
3272
 * avcodec_register_all();
3273
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3274
 * if (!codec)
3275
 *     exit(1);
3276
 *
3277
 * context = avcodec_alloc_context();
3278
 *
3279
 * if (avcodec_open(context, codec) < 0)
3280
 *     exit(1);
3281
 * @endcode
3282
 *
3283
 * @param avctx The context which will be set up to use the given codec.
3284
 * @param codec The codec to use within the context.
3285
 * @return zero on success, a negative value on error
3286
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3287
 */
3288
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3289

    
3290
#if LIBAVCODEC_VERSION_MAJOR < 53
3291
/**
3292
 * Decodes an audio frame from buf into samples.
3293
 * Wrapper function which calls avcodec_decode_audio3.
3294
 *
3295
 * @deprecated Use avcodec_decode_audio3 instead.
3296
 * @param avctx the codec context
3297
 * @param[out] samples the output buffer
3298
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3299
 * @param[in] buf the input buffer
3300
 * @param[in] buf_size the input buffer size in bytes
3301
 * @return On error a negative value is returned, otherwise the number of bytes
3302
 * used or zero if no frame could be decompressed.
3303
 */
3304
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3305
                         int *frame_size_ptr,
3306
                         const uint8_t *buf, int buf_size);
3307
#endif
3308

    
3309
/**
3310
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3311
 * Some decoders may support multiple frames in a single AVPacket, such
3312
 * decoders would then just decode the first frame. In this case,
3313
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3314
 * the remaining data in order to decode the second frame etc.
3315
 * If no frame
3316
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3317
 * decompressed frame size in bytes.
3318
 *
3319
 * @warning You must set frame_size_ptr to the allocated size of the
3320
 * output buffer before calling avcodec_decode_audio3().
3321
 *
3322
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3323
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3324
 * bits at once and could read over the end.
3325
 *
3326
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3327
 * no overreading happens for damaged MPEG streams.
3328
 *
3329
 * @note You might have to align the input buffer avpkt->data and output buffer
3330
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3331
 * necessary at all, on others it won't work at all if not aligned and on others
3332
 * it will work but it will have an impact on performance.
3333
 *
3334
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3335
 * samples should be 16 byte aligned unless the CPU doesn't need it
3336
 * (AltiVec and SSE do).
3337
 *
3338
 * @param avctx the codec context
3339
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3340
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3341
 * @param[in] avpkt The input AVPacket containing the input buffer.
3342
 *            You can create such packet with av_init_packet() and by then setting
3343
 *            data and size, some decoders might in addition need other fields.
3344
 *            All decoders are designed to use the least fields possible though.
3345
 * @return On error a negative value is returned, otherwise the number of bytes
3346
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3347
 */
3348
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3349
                         int *frame_size_ptr,
3350
                         AVPacket *avpkt);
3351

    
3352
#if LIBAVCODEC_VERSION_MAJOR < 53
3353
/**
3354
 * Decodes a video frame from buf into picture.
3355
 * Wrapper function which calls avcodec_decode_video2.
3356
 *
3357
 * @deprecated Use avcodec_decode_video2 instead.
3358
 * @param avctx the codec context
3359
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3360
 * @param[in] buf the input buffer
3361
 * @param[in] buf_size the size of the input buffer in bytes
3362
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3363
 * @return On error a negative value is returned, otherwise the number of bytes
3364
 * used or zero if no frame could be decompressed.
3365
 */
3366
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3367
                         int *got_picture_ptr,
3368
                         const uint8_t *buf, int buf_size);
3369
#endif
3370

    
3371
/**
3372
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3373
 * Some decoders may support multiple frames in a single AVPacket, such
3374
 * decoders would then just decode the first frame.
3375
 *
3376
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3377
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3378
 * bits at once and could read over the end.
3379
 *
3380
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3381
 * no overreading happens for damaged MPEG streams.
3382
 *
3383
 * @note You might have to align the input buffer avpkt->data.
3384
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3385
 * necessary at all, on others it won't work at all if not aligned and on others
3386
 * it will work but it will have an impact on performance.
3387
 *
3388
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3389
 *
3390
 * @note Some codecs have a delay between input and output, these need to be
3391
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3392
 *
3393
 * @param avctx the codec context
3394
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3395
 * @param[in] avpkt The input AVpacket containing the input buffer.
3396
 *            You can create such packet with av_init_packet() and by then setting
3397
 *            data and size, some decoders might in addition need other fields like
3398
 *            flags&PKT_FLAG_KEY. All decoders are designed to use the least
3399
 *            fields possible.
3400
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3401
 * @return On error a negative value is returned, otherwise the number of bytes
3402
 * used or zero if no frame could be decompressed.
3403
 */
3404
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3405
                         int *got_picture_ptr,
3406
                         AVPacket *avpkt);
3407

    
3408
#if LIBAVCODEC_VERSION_MAJOR < 53
3409
/* Decode a subtitle message. Return -1 if error, otherwise return the
3410
 * number of bytes used. If no subtitle could be decompressed,
3411
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3412
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3413
                            int *got_sub_ptr,
3414
                            const uint8_t *buf, int buf_size);
3415
#endif
3416

    
3417
/**
3418
 * Decodes a subtitle message.
3419
 * Returns a negative value on error, otherwise returns the number of bytes used.
3420
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3421
 * Otherwise, the subtitle is stored in *sub.
3422
 *
3423
 * @param avctx the codec context
3424
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3425
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3426
 * @param[in] avpkt The input AVPacket containing the input buffer.
3427
 */
3428
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3429
                            int *got_sub_ptr,
3430
                            AVPacket *avpkt);
3431
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3432
                        int *data_size_ptr,
3433
                        uint8_t *buf, int buf_size);
3434

    
3435
/**
3436
 * Encodes an audio frame from samples into buf.
3437
 *
3438
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3439
 * However, for PCM audio the user will know how much space is needed
3440
 * because it depends on the value passed in buf_size as described
3441
 * below. In that case a lower value can be used.
3442
 *
3443
 * @param avctx the codec context
3444
 * @param[out] buf the output buffer
3445
 * @param[in] buf_size the output buffer size
3446
 * @param[in] samples the input buffer containing the samples
3447
 * The number of samples read from this buffer is frame_size*channels,
3448
 * both of which are defined in avctx.
3449
 * For PCM audio the number of samples read from samples is equal to
3450
 * buf_size * input_sample_size / output_sample_size.
3451
 * @return On error a negative value is returned, on success zero or the number
3452
 * of bytes used to encode the data read from the input buffer.
3453
 */
3454
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3455
                         const short *samples);
3456

    
3457
/**
3458
 * Encodes a video frame from pict into buf.
3459
 * The input picture should be
3460
 * stored using a specific format, namely avctx.pix_fmt.
3461
 *
3462
 * @param avctx the codec context
3463
 * @param[out] buf the output buffer for the bitstream of encoded frame
3464
 * @param[in] buf_size the size of the output buffer in bytes
3465
 * @param[in] pict the input picture to encode
3466
 * @return On error a negative value is returned, on success zero or the number
3467
 * of bytes used from the output buffer.
3468
 */
3469
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3470
                         const AVFrame *pict);
3471
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3472
                            const AVSubtitle *sub);
3473

    
3474
int avcodec_close(AVCodecContext *avctx);
3475

    
3476
/**
3477
 * Register all the codecs, parsers and bitstream filters which were enabled at
3478
 * configuration time. If you do not call this function you can select exactly
3479
 * which formats you want to support, by using the individual registration
3480
 * functions.
3481
 *
3482
 * @see avcodec_register
3483
 * @see av_register_codec_parser
3484
 * @see av_register_bitstream_filter
3485
 */
3486
void avcodec_register_all(void);
3487

    
3488
/**
3489
 * Flush buffers, should be called when seeking or when switching to a different stream.
3490
 */
3491
void avcodec_flush_buffers(AVCodecContext *avctx);
3492

    
3493
void avcodec_default_free_buffers(AVCodecContext *s);
3494

    
3495
/* misc useful functions */
3496

    
3497
/**
3498
 * Returns a single letter to describe the given picture type pict_type.
3499
 *
3500
 * @param[in] pict_type the picture type
3501
 * @return A single character representing the picture type.
3502
 */
3503
char av_get_pict_type_char(int pict_type);
3504

    
3505
/**
3506
 * Returns codec bits per sample.
3507
 *
3508
 * @param[in] codec_id the codec
3509
 * @return Number of bits per sample or zero if unknown for the given codec.
3510
 */
3511
int av_get_bits_per_sample(enum CodecID codec_id);
3512

    
3513
/**
3514
 * Returns sample format bits per sample.
3515
 *
3516
 * @param[in] sample_fmt the sample format
3517
 * @return Number of bits per sample or zero if unknown for the given sample format.
3518
 */
3519
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3520

    
3521
/* frame parsing */
3522
typedef struct AVCodecParserContext {
3523
    void *priv_data;
3524
    struct AVCodecParser *parser;
3525
    int64_t frame_offset; /* offset of the current frame */
3526
    int64_t cur_offset; /* current offset
3527
                           (incremented by each av_parser_parse()) */
3528
    int64_t next_frame_offset; /* offset of the next frame */
3529
    /* video info */
3530
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3531
    /**
3532
     * This field is used for proper frame duration computation in lavf.
3533
     * It signals, how much longer the frame duration of the current frame
3534
     * is compared to normal frame duration.
3535
     *
3536
     * frame_duration = (1 + repeat_pict) * time_base
3537
     *
3538
     * It is used by codecs like H.264 to display telecined material.
3539
     */
3540
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3541
    int64_t pts;     /* pts of the current frame */
3542
    int64_t dts;     /* dts of the current frame */
3543

    
3544
    /* private data */
3545
    int64_t last_pts;
3546
    int64_t last_dts;
3547
    int fetch_timestamp;
3548

    
3549
#define AV_PARSER_PTS_NB 4
3550
    int cur_frame_start_index;
3551
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3552
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3553
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3554

    
3555
    int flags;
3556
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3557

    
3558
    int64_t offset;      ///< byte offset from starting packet start
3559
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3560

    
3561
    /*!
3562
     * Set by parser to 1 for key frames and 0 for non-key frames.
3563
     * It is initialized to -1, so if the parser doesn't set this flag,
3564
     * old-style fallback using FF_I_TYPE picture type as key frames
3565
     * will be used.
3566
     */
3567
    int key_frame;
3568

    
3569
    /**
3570
     * Time difference in stream time base units from the pts of this
3571
     * packet to the point at which the output from the decoder has converged
3572
     * independent from the availability of previous frames. That is, the
3573
     * frames are virtually identical no matter if decoding started from
3574
     * the very first frame or from this keyframe.
3575
     * Is AV_NOPTS_VALUE if unknown.
3576
     * This field is not the display duration of the current frame.
3577
     *
3578
     * The purpose of this field is to allow seeking in streams that have no
3579
     * keyframes in the conventional sense. It corresponds to the
3580
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3581
     * essential for some types of subtitle streams to ensure that all
3582
     * subtitles are correctly displayed after seeking.
3583
     */
3584
    int64_t convergence_duration;
3585

    
3586
    // Timestamp generation support:
3587
    /**
3588
     * Synchronization point for start of timestamp generation.
3589
     *
3590
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3591
     * (default).
3592
     *
3593
     * For example, this corresponds to presence of H.264 buffering period
3594
     * SEI message.
3595
     */
3596
    int dts_sync_point;
3597

    
3598
    /**
3599
     * Offset of the current timestamp against last timestamp sync point in
3600
     * units of AVCodecContext.time_base.
3601
     *
3602
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3603
     * contain a valid timestamp offset.
3604
     *
3605
     * Note that the timestamp of sync point has usually a nonzero
3606
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3607
     * the next frame after timestamp sync point will be usually 1.
3608
     *
3609
     * For example, this corresponds to H.264 cpb_removal_delay.
3610
     */
3611
    int dts_ref_dts_delta;
3612

    
3613
    /**
3614
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3615
     *
3616
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3617
     * contain valid non-negative timestamp delta (presentation time of a frame
3618
     * must not lie in the past).
3619
     *
3620
     * This delay represents the difference between decoding and presentation
3621
     * time of the frame.
3622
     *
3623
     * For example, this corresponds to H.264 dpb_output_delay.
3624
     */
3625
    int pts_dts_delta;
3626

    
3627
    /**
3628
     * Position of the packet in file.
3629
     *
3630
     * Analogous to cur_frame_pts/dts
3631
     */
3632
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3633

    
3634
    /**
3635
     * Byte position of currently parsed frame in stream.
3636
     */
3637
    int64_t pos;
3638

    
3639
    /**
3640
     * Previous frame byte position.
3641
     */
3642
    int64_t last_pos;
3643
} AVCodecParserContext;
3644

    
3645
typedef struct AVCodecParser {
3646
    int codec_ids[5]; /* several codec IDs are permitted */
3647
    int priv_data_size;
3648
    int (*parser_init)(AVCodecParserContext *s);
3649
    int (*parser_parse)(AVCodecParserContext *s,
3650
                        AVCodecContext *avctx,
3651
                        const uint8_t **poutbuf, int *poutbuf_size,
3652
                        const uint8_t *buf, int buf_size);
3653
    void (*parser_close)(AVCodecParserContext *s);
3654
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3655
    struct AVCodecParser *next;
3656
} AVCodecParser;
3657

    
3658
AVCodecParser *av_parser_next(AVCodecParser *c);
3659

    
3660
void av_register_codec_parser(AVCodecParser *parser);
3661
AVCodecParserContext *av_parser_init(int codec_id);
3662

    
3663
#if LIBAVCODEC_VERSION_MAJOR < 53
3664
attribute_deprecated
3665
int av_parser_parse(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
#endif
3671

    
3672
/**
3673
 * Parse a packet.
3674
 *
3675
 * @param s             parser context.
3676
 * @param avctx         codec context.
3677
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3678
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3679
 * @param buf           input buffer.
3680
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3681
 * @param pts           input presentation timestamp.
3682
 * @param dts           input decoding timestamp.
3683
 * @param pos           input byte position in stream.
3684
 * @return the number of bytes of the input bitstream used.
3685
 *
3686
 * Example:
3687
 * @code
3688
 *   while(in_len){
3689
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3690
 *                                        in_data, in_len,
3691
 *                                        pts, dts, pos);
3692
 *       in_data += len;
3693
 *       in_len  -= len;
3694
 *
3695
 *       if(size)
3696
 *          decode_frame(data, size);
3697
 *   }
3698
 * @endcode
3699
 */
3700
int av_parser_parse2(AVCodecParserContext *s,
3701
                     AVCodecContext *avctx,
3702
                     uint8_t **poutbuf, int *poutbuf_size,
3703
                     const uint8_t *buf, int buf_size,
3704
                     int64_t pts, int64_t dts,
3705
                     int64_t pos);
3706

    
3707
int av_parser_change(AVCodecParserContext *s,
3708
                     AVCodecContext *avctx,
3709
                     uint8_t **poutbuf, int *poutbuf_size,
3710
                     const uint8_t *buf, int buf_size, int keyframe);
3711
void av_parser_close(AVCodecParserContext *s);
3712

    
3713

    
3714
typedef struct AVBitStreamFilterContext {
3715
    void *priv_data;
3716
    struct AVBitStreamFilter *filter;
3717
    AVCodecParserContext *parser;
3718
    struct AVBitStreamFilterContext *next;
3719
} AVBitStreamFilterContext;
3720

    
3721

    
3722
typedef struct AVBitStreamFilter {
3723
    const char *name;
3724
    int priv_data_size;
3725
    int (*filter)(AVBitStreamFilterContext *bsfc,
3726
                  AVCodecContext *avctx, const char *args,
3727
                  uint8_t **poutbuf, int *poutbuf_size,
3728
                  const uint8_t *buf, int buf_size, int keyframe);
3729
    void (*close)(AVBitStreamFilterContext *bsfc);
3730
    struct AVBitStreamFilter *next;
3731
} AVBitStreamFilter;
3732

    
3733
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3734
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3735
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3736
                               AVCodecContext *avctx, const char *args,
3737
                               uint8_t **poutbuf, int *poutbuf_size,
3738
                               const uint8_t *buf, int buf_size, int keyframe);
3739
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3740

    
3741
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3742

    
3743
/* memory */
3744

    
3745
/**
3746
 * Reallocates the given block if it is not large enough, otherwise it
3747
 * does nothing.
3748
 *
3749
 * @see av_realloc
3750
 */
3751
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3752

    
3753
/**
3754
 * Allocates a buffer, reusing the given one if large enough.
3755
 *
3756
 * Contrary to av_fast_realloc the current buffer contents might not be
3757
 * preserved and on error the old buffer is freed, thus no special
3758
 * handling to avoid memleaks is necessary.
3759
 *
3760
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3761
 * @param size size of the buffer *ptr points to
3762
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3763
 *                 *size 0 if an error occurred.
3764
 */
3765
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3766

    
3767
/**
3768
 * Copy image 'src' to 'dst'.
3769
 */
3770
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3771
                     enum PixelFormat pix_fmt, int width, int height);
3772

    
3773
/**
3774
 * Crop image top and left side.
3775
 */
3776
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3777
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3778

    
3779
/**
3780
 * Pad image.
3781
 */
3782
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3783
            int padtop, int padbottom, int padleft, int padright, int *color);
3784

    
3785
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3786

    
3787
/**
3788
 * Parses str and put in width_ptr and height_ptr the detected values.
3789
 *
3790
 * @return 0 in case of a successful parsing, a negative value otherwise
3791
 * @param[in] str the string to parse: it has to be a string in the format
3792
 * <width>x<height> or a valid video frame size abbreviation.
3793
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3794
 * frame width value
3795
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3796
 * frame height value
3797
 */
3798
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3799

    
3800
/**
3801
 * Parses str and put in frame_rate the detected values.
3802
 *
3803
 * @return 0 in case of a successful parsing, a negative value otherwise
3804
 * @param[in] str the string to parse: it has to be a string in the format
3805
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3806
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3807
 * frame rate
3808
 */
3809
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3810

    
3811
/* error handling */
3812
#if EINVAL > 0
3813
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3814
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3815
#else
3816
/* Some platforms have E* and errno already negated. */
3817
#define AVERROR(e) (e)
3818
#define AVUNERROR(e) (e)
3819
#endif
3820
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3821
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3822
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3823
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3824
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3825
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3826
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3827
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3828
#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
3829
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3830

    
3831
/**
3832
 * Logs a generic warning message about a missing feature. This function is
3833
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3834
 * only, and would normally not be used by applications.
3835
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3836
 * a pointer to an AVClass struct
3837
 * @param[in] feature string containing the name of the missing feature
3838
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3839
 * If want_sample is non-zero, additional verbage will be added to the log
3840
 * message which tells the user how to report samples to the development
3841
 * mailing list.
3842
 */
3843
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3844

    
3845
/**
3846
 * Logs a generic warning message asking for a sample. This function is
3847
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3848
 * only, and would normally not be used by applications.
3849
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3850
 * a pointer to an AVClass struct
3851
 * @param[in] msg string containing an optional message, or NULL if no message
3852
 */
3853
void av_log_ask_for_sample(void *avc, const char *msg);
3854

    
3855
/**
3856
 * Registers the hardware accelerator hwaccel.
3857
 */
3858
void av_register_hwaccel(AVHWAccel *hwaccel);
3859

    
3860
/**
3861
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3862
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3863
 * after hwaccel, or NULL if hwaccel is the last one.
3864
 */
3865
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3866

    
3867

    
3868
/**
3869
 * Lock operation used by lockmgr
3870
 */
3871
enum AVLockOp {
3872
  AV_LOCK_CREATE,  ///< Create a mutex
3873
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3874
  AV_LOCK_RELEASE, ///< Unlock the mutex
3875
  AV_LOCK_DESTROY, ///< Free mutex resources
3876
};
3877

    
3878
/**
3879
 * Register a user provided lock manager supporting the operations
3880
 * specified by AVLockOp. mutex points to a (void *) where the
3881
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3882
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3883
 *
3884
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3885
 *           callback during the call to av_lockmgr_register().
3886
 *           Thus, the application must be prepared to handle that.
3887
 *           If cb is set to NULL the lockmgr will be unregistered.
3888
 *           Also note that during unregistration the previously registered
3889
 *           lockmgr callback may also be invoked.
3890
 */
3891
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3892

    
3893
#endif /* AVCODEC_AVCODEC_H */