Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ c7094831

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 56
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
 * The first 8 bytes are needed because some optimized bitstream readers read
428
 * 32 or 64 bit at once and could read over the end. The remainder is to give
429
 * decoders a reasonable amount of distance to work with before checking for
430
 * buffer overreads.<br>
431
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
432
 * MPEG bitstreams could cause overread and segfault.
433
 */
434
#define FF_INPUT_BUFFER_PADDING_SIZE 64
435

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

    
442

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

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

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

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

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

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

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

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

    
530
#define FF_MAX_B_FRAMES 16
531

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

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

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

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

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

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

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

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

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

    
920

    
921
#define FF_QSCALE_TYPE_MPEG1 0
922
#define FF_QSCALE_TYPE_MPEG2 1
923
#define FF_QSCALE_TYPE_H264  2
924
#define FF_QSCALE_TYPE_VP56  3
925

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

    
931

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1098
#define FF_ASPECT_EXTENDED 15
1099

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1216
    /** obsolete FIXME remove */
1217
    int rc_strategy;
1218
#define FF_RC_STRATEGY_XVID 1
1219

    
1220
    int b_frame_strategy;
1221

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

    
1230
    struct AVCodec *codec;
1231

    
1232
    void *priv_data;
1233

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

    
1241

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1439
    float rc_qmod_amp;
1440
    int rc_qmod_freq;
1441

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
2138
#define FF_PROFILE_AAC_MAIN 0
2139
#define FF_PROFILE_AAC_LOW  1
2140
#define FF_PROFILE_AAC_SSR  2
2141
#define FF_PROFILE_AAC_LTP  3
2142

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
2675
    /**
2676
     * Hardware accelerated codec capabilities.
2677
     * see FF_HWACCEL_CODEC_CAP_*
2678
     */
2679
    int capabilities;
2680

    
2681
    struct AVHWAccel *next;
2682

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

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

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

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

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

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

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

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

    
2765
} AVPaletteControl attribute_deprecated;
2766
#endif
2767

    
2768
enum AVSubtitleType {
2769
    SUBTITLE_NONE,
2770

    
2771
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2772

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

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

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

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

    
2800
    char *text;                     ///< 0 terminated plain UTF-8 text
2801

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

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

    
2819
/* packet functions */
2820

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

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

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

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

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

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

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

    
2869
/* resample.c */
2870

    
2871
struct ReSampleContext;
2872
struct AVResampleContext;
2873

    
2874
typedef struct ReSampleContext ReSampleContext;
2875

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

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

    
2909

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

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

    
2932

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

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

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

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

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

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

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

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

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

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

    
3081

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

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

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

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

    
3109
/* external high level API */
3110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
3476
int avcodec_close(AVCodecContext *avctx);
3477

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

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

    
3495
void avcodec_default_free_buffers(AVCodecContext *s);
3496

    
3497
/* misc useful functions */
3498

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

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

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

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

    
3546
    /* private data */
3547
    int64_t last_pts;
3548
    int64_t last_dts;
3549
    int fetch_timestamp;
3550

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

    
3557
    int flags;
3558
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3559

    
3560
    int64_t offset;      ///< byte offset from starting packet start
3561
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3562

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

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

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

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

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

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

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

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

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

    
3660
AVCodecParser *av_parser_next(AVCodecParser *c);
3661

    
3662
void av_register_codec_parser(AVCodecParser *parser);
3663
AVCodecParserContext *av_parser_init(int codec_id);
3664

    
3665
#if LIBAVCODEC_VERSION_MAJOR < 53
3666
attribute_deprecated
3667
int av_parser_parse(AVCodecParserContext *s,
3668
                    AVCodecContext *avctx,
3669
                    uint8_t **poutbuf, int *poutbuf_size,
3670
                    const uint8_t *buf, int buf_size,
3671
                    int64_t pts, int64_t dts);
3672
#endif
3673

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

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

    
3715

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

    
3723

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

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

    
3743
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3744

    
3745
/* memory */
3746

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

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

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

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

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

    
3787
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3788

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

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

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

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

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

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

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

    
3869

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

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

    
3895
#endif /* AVCODEC_AVCODEC_H */