Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 9b489e02

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 61
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
#if LIBAVCODEC_VERSION_MAJOR < 53
129
    CODEC_ID_XVID,
130
#endif
131
    CODEC_ID_PNG,
132
    CODEC_ID_PPM,
133
    CODEC_ID_PBM,
134
    CODEC_ID_PGM,
135
    CODEC_ID_PGMYUV,
136
    CODEC_ID_PAM,
137
    CODEC_ID_FFVHUFF,
138
    CODEC_ID_RV30,
139
    CODEC_ID_RV40,
140
    CODEC_ID_VC1,
141
    CODEC_ID_WMV3,
142
    CODEC_ID_LOCO,
143
    CODEC_ID_WNV1,
144
    CODEC_ID_AASC,
145
    CODEC_ID_INDEO2,
146
    CODEC_ID_FRAPS,
147
    CODEC_ID_TRUEMOTION2,
148
    CODEC_ID_BMP,
149
    CODEC_ID_CSCD,
150
    CODEC_ID_MMVIDEO,
151
    CODEC_ID_ZMBV,
152
    CODEC_ID_AVS,
153
    CODEC_ID_SMACKVIDEO,
154
    CODEC_ID_NUV,
155
    CODEC_ID_KMVC,
156
    CODEC_ID_FLASHSV,
157
    CODEC_ID_CAVS,
158
    CODEC_ID_JPEG2000,
159
    CODEC_ID_VMNC,
160
    CODEC_ID_VP5,
161
    CODEC_ID_VP6,
162
    CODEC_ID_VP6F,
163
    CODEC_ID_TARGA,
164
    CODEC_ID_DSICINVIDEO,
165
    CODEC_ID_TIERTEXSEQVIDEO,
166
    CODEC_ID_TIFF,
167
    CODEC_ID_GIF,
168
    CODEC_ID_FFH264,
169
    CODEC_ID_DXA,
170
    CODEC_ID_DNXHD,
171
    CODEC_ID_THP,
172
    CODEC_ID_SGI,
173
    CODEC_ID_C93,
174
    CODEC_ID_BETHSOFTVID,
175
    CODEC_ID_PTX,
176
    CODEC_ID_TXD,
177
    CODEC_ID_VP6A,
178
    CODEC_ID_AMV,
179
    CODEC_ID_VB,
180
    CODEC_ID_PCX,
181
    CODEC_ID_SUNRAST,
182
    CODEC_ID_INDEO4,
183
    CODEC_ID_INDEO5,
184
    CODEC_ID_MIMIC,
185
    CODEC_ID_RL2,
186
    CODEC_ID_8SVX_EXP,
187
    CODEC_ID_8SVX_FIB,
188
    CODEC_ID_ESCAPE124,
189
    CODEC_ID_DIRAC,
190
    CODEC_ID_BFI,
191
    CODEC_ID_CMV,
192
    CODEC_ID_MOTIONPIXELS,
193
    CODEC_ID_TGV,
194
    CODEC_ID_TGQ,
195
    CODEC_ID_TQI,
196
    CODEC_ID_AURA,
197
    CODEC_ID_AURA2,
198
    CODEC_ID_V210X,
199
    CODEC_ID_TMV,
200
    CODEC_ID_V210,
201
    CODEC_ID_DPX,
202
    CODEC_ID_MAD,
203
    CODEC_ID_FRWU,
204
    CODEC_ID_FLASHSV2,
205
    CODEC_ID_CDGRAPHICS,
206
    CODEC_ID_R210,
207
    CODEC_ID_ANM,
208
    CODEC_ID_BINKVIDEO,
209
    CODEC_ID_IFF_ILBM,
210
    CODEC_ID_IFF_BYTERUN1,
211
    CODEC_ID_KGV1,
212

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

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

    
270
    /* AMR */
271
    CODEC_ID_AMR_NB= 0x12000,
272
    CODEC_ID_AMR_WB,
273

    
274
    /* RealAudio codecs*/
275
    CODEC_ID_RA_144= 0x13000,
276
    CODEC_ID_RA_288,
277

    
278
    /* various DPCM codecs */
279
    CODEC_ID_ROQ_DPCM= 0x14000,
280
    CODEC_ID_INTERPLAY_DPCM,
281
    CODEC_ID_XAN_DPCM,
282
    CODEC_ID_SOL_DPCM,
283

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

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

    
348
    /* other specific kind of codecs (generally used for attachments) */
349
    CODEC_ID_TTF= 0x18000,
350

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

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

    
357
enum CodecType {
358
    CODEC_TYPE_UNKNOWN = -1,
359
    CODEC_TYPE_VIDEO,
360
    CODEC_TYPE_AUDIO,
361
    CODEC_TYPE_DATA,
362
    CODEC_TYPE_SUBTITLE,
363
    CODEC_TYPE_ATTACHMENT,
364
    CODEC_TYPE_NB
365
};
366

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

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

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

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

    
425
/* in bytes */
426
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
427

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

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

    
443

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

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

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

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

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

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

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

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

    
531
#define FF_MAX_B_FRAMES 16
532

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

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

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

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

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

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

    
681
    /**
682
     * width and height in 1/16 pel
683
     * - encoding: Set by user.
684
     * - decoding: Set by libavcodec.
685
     */
686
    int width;
687
    int height;
688

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

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

    
924

    
925
#define FF_QSCALE_TYPE_MPEG1 0
926
#define FF_QSCALE_TYPE_MPEG2 1
927
#define FF_QSCALE_TYPE_H264  2
928
#define FF_QSCALE_TYPE_VP56  3
929

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

    
935

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

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

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

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

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

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

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

    
1042
    /**
1043
     * CODEC_FLAG_*.
1044
     * - encoding: Set by user.
1045
     * - decoding: Set by user.
1046
     */
1047
    int flags;
1048

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

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

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

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

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

    
1102
#define FF_ASPECT_EXTENDED 15
1103

    
1104
    /**
1105
     * the number of pictures in a group of pictures, or 0 for intra_only
1106
     * - encoding: Set by user.
1107
     * - decoding: unused
1108
     */
1109
    int gop_size;
1110

    
1111
    /**
1112
     * Pixel format, see PIX_FMT_xxx.
1113
     * - encoding: Set by user.
1114
     * - decoding: Set by libavcodec.
1115
     */
1116
    enum PixelFormat pix_fmt;
1117

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

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

    
1149
    /* audio only */
1150
    int sample_rate; ///< samples per second
1151
    int channels;    ///< number of audio channels
1152

    
1153
    /**
1154
     * audio sample format
1155
     * - encoding: Set by user.
1156
     * - decoding: Set by libavcodec.
1157
     */
1158
    enum SampleFormat sample_fmt;  ///< sample format
1159

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

    
1170
    /**
1171
     * Number of frames the decoded output will be delayed relative to
1172
     * the encoded input.
1173
     * - encoding: Set by libavcodec.
1174
     * - decoding: unused
1175
     */
1176
    int delay;
1177

    
1178
    /* - encoding parameters */
1179
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1180
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1181

    
1182
    /**
1183
     * minimum quantizer
1184
     * - encoding: Set by user.
1185
     * - decoding: unused
1186
     */
1187
    int qmin;
1188

    
1189
    /**
1190
     * maximum quantizer
1191
     * - encoding: Set by user.
1192
     * - decoding: unused
1193
     */
1194
    int qmax;
1195

    
1196
    /**
1197
     * maximum quantizer difference between frames
1198
     * - encoding: Set by user.
1199
     * - decoding: unused
1200
     */
1201
    int max_qdiff;
1202

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

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

    
1220
    /** obsolete FIXME remove */
1221
    int rc_strategy;
1222
#define FF_RC_STRATEGY_XVID 1
1223

    
1224
    int b_frame_strategy;
1225

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

    
1234
    struct AVCodec *codec;
1235

    
1236
    void *priv_data;
1237

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

    
1245

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

    
1254
    /* statistics, used for 2-pass encoding */
1255
    int mv_bits;
1256
    int header_bits;
1257
    int i_tex_bits;
1258
    int p_tex_bits;
1259
    int i_count;
1260
    int p_count;
1261
    int skip_count;
1262
    int misc_bits;
1263

    
1264
    /**
1265
     * number of bits used for the previously encoded frame
1266
     * - encoding: Set by libavcodec.
1267
     * - decoding: unused
1268
     */
1269
    int frame_bits;
1270

    
1271
    /**
1272
     * Private data of the user, can be used to carry app specific stuff.
1273
     * - encoding: Set by user.
1274
     * - decoding: Set by user.
1275
     */
1276
    void *opaque;
1277

    
1278
    char codec_name[32];
1279
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1280
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1281

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

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

    
1321
    /**
1322
     * luma single coefficient elimination threshold
1323
     * - encoding: Set by user.
1324
     * - decoding: unused
1325
     */
1326
    int luma_elim_threshold;
1327

    
1328
    /**
1329
     * chroma single coeff elimination threshold
1330
     * - encoding: Set by user.
1331
     * - decoding: unused
1332
     */
1333
    int chroma_elim_threshold;
1334

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

    
1354
    /**
1355
     * qscale offset between IP and B-frames
1356
     * - encoding: Set by user.
1357
     * - decoding: unused
1358
     */
1359
    float b_quant_offset;
1360

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

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

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

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

    
1403
    /**
1404
     * number of bytes per packet if constant and known or 0
1405
     * Used by some WAV based audio codecs.
1406
     */
1407
    int block_align;
1408

    
1409
    int parse_only; /* - decoding only: If true, only parsing is done
1410
                       (function avcodec_parse_frame()). The frame
1411
                       data is returned. Only MPEG codecs support this now. */
1412

    
1413
    /**
1414
     * 0-> h263 quant 1-> mpeg quant
1415
     * - encoding: Set by user.
1416
     * - decoding: unused
1417
     */
1418
    int mpeg_quant;
1419

    
1420
    /**
1421
     * pass1 encoding statistics output buffer
1422
     * - encoding: Set by libavcodec.
1423
     * - decoding: unused
1424
     */
1425
    char *stats_out;
1426

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

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

    
1443
    float rc_qmod_amp;
1444
    int rc_qmod_freq;
1445

    
1446
    /**
1447
     * ratecontrol override, see RcOverride
1448
     * - encoding: Allocated/set/freed by user.
1449
     * - decoding: unused
1450
     */
1451
    RcOverride *rc_override;
1452
    int rc_override_count;
1453

    
1454
    /**
1455
     * rate control equation
1456
     * - encoding: Set by user
1457
     * - decoding: unused
1458
     */
1459
    const char *rc_eq;
1460

    
1461
    /**
1462
     * maximum bitrate
1463
     * - encoding: Set by user.
1464
     * - decoding: unused
1465
     */
1466
    int rc_max_rate;
1467

    
1468
    /**
1469
     * minimum bitrate
1470
     * - encoding: Set by user.
1471
     * - decoding: unused
1472
     */
1473
    int rc_min_rate;
1474

    
1475
    /**
1476
     * decoder bitstream buffer size
1477
     * - encoding: Set by user.
1478
     * - decoding: unused
1479
     */
1480
    int rc_buffer_size;
1481
    float rc_buffer_aggressivity;
1482

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

    
1492
    /**
1493
     * qscale offset between P and I-frames
1494
     * - encoding: Set by user.
1495
     * - decoding: unused
1496
     */
1497
    float i_quant_offset;
1498

    
1499
    /**
1500
     * initial complexity for pass1 ratecontrol
1501
     * - encoding: Set by user.
1502
     * - decoding: unused
1503
     */
1504
    float rc_initial_cplx;
1505

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

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

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

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

    
1541
    /**
1542
     * p block masking (0-> disabled)
1543
     * - encoding: Set by user.
1544
     * - decoding: unused
1545
     */
1546
    float p_masking;
1547

    
1548
    /**
1549
     * darkness masking (0-> disabled)
1550
     * - encoding: Set by user.
1551
     * - decoding: unused
1552
     */
1553
    float dark_masking;
1554

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

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

    
1600
    /**
1601
     * error concealment flags
1602
     * - encoding: unused
1603
     * - decoding: Set by user.
1604
     */
1605
    int error_concealment;
1606
#define FF_EC_GUESS_MVS   1
1607
#define FF_EC_DEBLOCK     2
1608

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

    
1636
    /**
1637
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1638
     * - encoding: Set by libavcodec.
1639
     * - decoding: Set by user.
1640
     */
1641
     int bits_per_coded_sample;
1642

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

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

    
1662
    /**
1663
     * the picture in the bitstream
1664
     * - encoding: Set by libavcodec.
1665
     * - decoding: Set by libavcodec.
1666
     */
1667
    AVFrame *coded_frame;
1668

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

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

    
1702
    /**
1703
     * error
1704
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1705
     * - decoding: unused
1706
     */
1707
    uint64_t error[4];
1708

    
1709
    /**
1710
     * minimum MB quantizer
1711
     * - encoding: unused
1712
     * - decoding: unused
1713
     */
1714
    int mb_qmin;
1715

    
1716
    /**
1717
     * maximum MB quantizer
1718
     * - encoding: unused
1719
     * - decoding: unused
1720
     */
1721
    int mb_qmax;
1722

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

    
1764
    /**
1765
     * ME diamond size & shape
1766
     * - encoding: Set by user.
1767
     * - decoding: unused
1768
     */
1769
    int dia_size;
1770

    
1771
    /**
1772
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1773
     * - encoding: Set by user.
1774
     * - decoding: unused
1775
     */
1776
    int last_predictor_count;
1777

    
1778
    /**
1779
     * prepass for motion estimation
1780
     * - encoding: Set by user.
1781
     * - decoding: unused
1782
     */
1783
    int pre_me;
1784

    
1785
    /**
1786
     * motion estimation prepass comparison function
1787
     * - encoding: Set by user.
1788
     * - decoding: unused
1789
     */
1790
    int me_pre_cmp;
1791

    
1792
    /**
1793
     * ME prepass diamond size & shape
1794
     * - encoding: Set by user.
1795
     * - decoding: unused
1796
     */
1797
    int pre_dia_size;
1798

    
1799
    /**
1800
     * subpel ME quality
1801
     * - encoding: Set by user.
1802
     * - decoding: unused
1803
     */
1804
    int me_subpel_quality;
1805

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

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

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

    
1843
    /**
1844
     * intra quantizer bias
1845
     * - encoding: Set by user.
1846
     * - decoding: unused
1847
     */
1848
    int intra_quant_bias;
1849
#define FF_DEFAULT_QUANT_BIAS 999999
1850

    
1851
    /**
1852
     * inter quantizer bias
1853
     * - encoding: Set by user.
1854
     * - decoding: unused
1855
     */
1856
    int inter_quant_bias;
1857

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

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

    
1872
    /**
1873
     * internal_buffers
1874
     * Don't touch, used by libavcodec default_get_buffer().
1875
     */
1876
    void *internal_buffer;
1877

    
1878
#define FF_LAMBDA_SHIFT 7
1879
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1880
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1881
#define FF_LAMBDA_MAX (256*128-1)
1882

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

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

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

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

    
1929
    /**
1930
     * XVideo Motion Acceleration
1931
     * - encoding: forbidden
1932
     * - decoding: set by decoder
1933
     */
1934
    int xvmc_acceleration;
1935

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

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

    
1953
    /**
1954
     * custom inter quantization matrix
1955
     * - encoding: Set by user, can be NULL.
1956
     * - decoding: Set by libavcodec.
1957
     */
1958
    uint16_t *inter_matrix;
1959

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

    
1968
    /**
1969
     * scene change detection threshold
1970
     * 0 is default, larger means fewer detected scene changes.
1971
     * - encoding: Set by user.
1972
     * - decoding: unused
1973
     */
1974
    int scenechange_threshold;
1975

    
1976
    /**
1977
     * minimum Lagrange multipler
1978
     * - encoding: Set by user.
1979
     * - decoding: unused
1980
     */
1981
    int lmin;
1982

    
1983
    /**
1984
     * maximum Lagrange multipler
1985
     * - encoding: Set by user.
1986
     * - decoding: unused
1987
     */
1988
    int lmax;
1989

    
1990
    /**
1991
     * palette control structure
1992
     * - encoding: ??? (no palette-enabled encoder yet)
1993
     * - decoding: Set by user.
1994
     */
1995
    struct AVPaletteControl *palctrl;
1996

    
1997
    /**
1998
     * noise reduction strength
1999
     * - encoding: Set by user.
2000
     * - decoding: unused
2001
     */
2002
    int noise_reduction;
2003

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

    
2018
    /**
2019
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2020
     * - encoding: Set by user.
2021
     * - decoding: unused
2022
     */
2023
    int rc_initial_buffer_occupancy;
2024

    
2025
    /**
2026
     *
2027
     * - encoding: Set by user.
2028
     * - decoding: unused
2029
     */
2030
    int inter_threshold;
2031

    
2032
    /**
2033
     * CODEC_FLAG2_*
2034
     * - encoding: Set by user.
2035
     * - decoding: Set by user.
2036
     */
2037
    int flags2;
2038

    
2039
    /**
2040
     * Simulates errors in the bitstream to test error concealment.
2041
     * - encoding: Set by user.
2042
     * - decoding: unused
2043
     */
2044
    int error_rate;
2045

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

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

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

    
2082
    /**
2083
     * thread opaque
2084
     * Can be used by execute() to store some per AVCodecContext stuff.
2085
     * - encoding: set by execute()
2086
     * - decoding: set by execute()
2087
     */
2088
    void *thread_opaque;
2089

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

    
2099
    /**
2100
     * Macroblock threshold below which the user specified macroblock types will be used.
2101
     * - encoding: Set by user.
2102
     * - decoding: unused
2103
     */
2104
     int mb_threshold;
2105

    
2106
    /**
2107
     * precision of the intra DC coefficient - 8
2108
     * - encoding: Set by user.
2109
     * - decoding: unused
2110
     */
2111
     int intra_dc_precision;
2112

    
2113
    /**
2114
     * noise vs. sse weight for the nsse comparsion function
2115
     * - encoding: Set by user.
2116
     * - decoding: unused
2117
     */
2118
     int nsse_weight;
2119

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

    
2127
    /**
2128
     * Number of macroblock rows at the bottom which are skipped.
2129
     * - encoding: unused
2130
     * - decoding: Set by user.
2131
     */
2132
     int skip_bottom;
2133

    
2134
    /**
2135
     * profile
2136
     * - encoding: Set by user.
2137
     * - decoding: Set by libavcodec.
2138
     */
2139
     int profile;
2140
#define FF_PROFILE_UNKNOWN -99
2141

    
2142
#define FF_PROFILE_AAC_MAIN 0
2143
#define FF_PROFILE_AAC_LOW  1
2144
#define FF_PROFILE_AAC_SSR  2
2145
#define FF_PROFILE_AAC_LTP  3
2146

    
2147
#define FF_PROFILE_H264_BASELINE    66
2148
#define FF_PROFILE_H264_MAIN        77
2149
#define FF_PROFILE_H264_EXTENDED    88
2150
#define FF_PROFILE_H264_HIGH        100
2151
#define FF_PROFILE_H264_HIGH_10     110
2152
#define FF_PROFILE_H264_HIGH_422    122
2153
#define FF_PROFILE_H264_HIGH_444    244
2154
#define FF_PROFILE_H264_CAVLC_444   44
2155

    
2156
    /**
2157
     * level
2158
     * - encoding: Set by user.
2159
     * - decoding: Set by libavcodec.
2160
     */
2161
     int level;
2162
#define FF_LEVEL_UNKNOWN -99
2163

    
2164
    /**
2165
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2166
     * - encoding: unused
2167
     * - decoding: Set by user.
2168
     */
2169
     int lowres;
2170

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

    
2179
    /**
2180
     * frame skip threshold
2181
     * - encoding: Set by user.
2182
     * - decoding: unused
2183
     */
2184
    int frame_skip_threshold;
2185

    
2186
    /**
2187
     * frame skip factor
2188
     * - encoding: Set by user.
2189
     * - decoding: unused
2190
     */
2191
    int frame_skip_factor;
2192

    
2193
    /**
2194
     * frame skip exponent
2195
     * - encoding: Set by user.
2196
     * - decoding: unused
2197
     */
2198
    int frame_skip_exp;
2199

    
2200
    /**
2201
     * frame skip comparison function
2202
     * - encoding: Set by user.
2203
     * - decoding: unused
2204
     */
2205
    int frame_skip_cmp;
2206

    
2207
    /**
2208
     * Border processing masking, raises the quantizer for mbs on the borders
2209
     * of the picture.
2210
     * - encoding: Set by user.
2211
     * - decoding: unused
2212
     */
2213
    float border_masking;
2214

    
2215
    /**
2216
     * minimum MB lagrange multipler
2217
     * - encoding: Set by user.
2218
     * - decoding: unused
2219
     */
2220
    int mb_lmin;
2221

    
2222
    /**
2223
     * maximum MB lagrange multipler
2224
     * - encoding: Set by user.
2225
     * - decoding: unused
2226
     */
2227
    int mb_lmax;
2228

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

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

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

    
2250
    /**
2251
     *
2252
     * - encoding: unused
2253
     * - decoding: Set by user.
2254
     */
2255
    enum AVDiscard skip_frame;
2256

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

    
2264
    /**
2265
     *
2266
     * - encoding: Set by user.
2267
     * - decoding: unused
2268
     */
2269
    int brd_scale;
2270

    
2271
    /**
2272
     * constant rate factor - quality-based VBR - values ~correspond to qps
2273
     * - encoding: Set by user.
2274
     * - decoding: unused
2275
     */
2276
    float crf;
2277

    
2278
    /**
2279
     * constant quantization parameter rate control method
2280
     * - encoding: Set by user.
2281
     * - decoding: unused
2282
     */
2283
    int cqp;
2284

    
2285
    /**
2286
     * minimum GOP size
2287
     * - encoding: Set by user.
2288
     * - decoding: unused
2289
     */
2290
    int keyint_min;
2291

    
2292
    /**
2293
     * number of reference frames
2294
     * - encoding: Set by user.
2295
     * - decoding: Set by lavc.
2296
     */
2297
    int refs;
2298

    
2299
    /**
2300
     * chroma qp offset from luma
2301
     * - encoding: Set by user.
2302
     * - decoding: unused
2303
     */
2304
    int chromaoffset;
2305

    
2306
    /**
2307
     * Influences how often B-frames are used.
2308
     * - encoding: Set by user.
2309
     * - decoding: unused
2310
     */
2311
    int bframebias;
2312

    
2313
    /**
2314
     * trellis RD quantization
2315
     * - encoding: Set by user.
2316
     * - decoding: unused
2317
     */
2318
    int trellis;
2319

    
2320
    /**
2321
     * Reduce fluctuations in qp (before curve compression).
2322
     * - encoding: Set by user.
2323
     * - decoding: unused
2324
     */
2325
    float complexityblur;
2326

    
2327
    /**
2328
     * in-loop deblocking filter alphac0 parameter
2329
     * alpha is in the range -6...6
2330
     * - encoding: Set by user.
2331
     * - decoding: unused
2332
     */
2333
    int deblockalpha;
2334

    
2335
    /**
2336
     * in-loop deblocking filter beta parameter
2337
     * beta is in the range -6...6
2338
     * - encoding: Set by user.
2339
     * - decoding: unused
2340
     */
2341
    int deblockbeta;
2342

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

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

    
2362
    /**
2363
     * Audio cutoff bandwidth (0 means "automatic")
2364
     * - encoding: Set by user.
2365
     * - decoding: unused
2366
     */
2367
    int cutoff;
2368

    
2369
    /**
2370
     * Multiplied by qscale for each frame and added to scene_change_score.
2371
     * - encoding: Set by user.
2372
     * - decoding: unused
2373
     */
2374
    int scenechange_factor;
2375

    
2376
    /**
2377
     *
2378
     * Note: Value depends upon the compare function used for fullpel ME.
2379
     * - encoding: Set by user.
2380
     * - decoding: unused
2381
     */
2382
    int mv0_threshold;
2383

    
2384
    /**
2385
     * Adjusts sensitivity of b_frame_strategy 1.
2386
     * - encoding: Set by user.
2387
     * - decoding: unused
2388
     */
2389
    int b_sensitivity;
2390

    
2391
    /**
2392
     * - encoding: Set by user.
2393
     * - decoding: unused
2394
     */
2395
    int compression_level;
2396
#define FF_COMPRESSION_DEFAULT -1
2397

    
2398
    /**
2399
     * Sets whether to use LPC mode - used by FLAC encoder.
2400
     * - encoding: Set by user.
2401
     * - decoding: unused
2402
     */
2403
    int use_lpc;
2404

    
2405
    /**
2406
     * LPC coefficient precision - used by FLAC encoder
2407
     * - encoding: Set by user.
2408
     * - decoding: unused
2409
     */
2410
    int lpc_coeff_precision;
2411

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

    
2418
    /**
2419
     * - encoding: Set by user.
2420
     * - decoding: unused
2421
     */
2422
    int max_prediction_order;
2423

    
2424
    /**
2425
     * search method for selecting prediction order
2426
     * - encoding: Set by user.
2427
     * - decoding: unused
2428
     */
2429
    int prediction_order_method;
2430

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

    
2437
    /**
2438
     * - encoding: Set by user.
2439
     * - decoding: unused
2440
     */
2441
    int max_partition_order;
2442

    
2443
    /**
2444
     * GOP timecode frame start number, in non drop frame format
2445
     * - encoding: Set by user.
2446
     * - decoding: unused
2447
     */
2448
    int64_t timecode_frame_start;
2449

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

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

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

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

    
2484
    /**
2485
     * Audio channel layout.
2486
     * - encoding: set by user.
2487
     * - decoding: set by libavcodec.
2488
     */
2489
    int64_t channel_layout;
2490

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

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

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

    
2512
    /**
2513
     * Hardware accelerator in use
2514
     * - encoding: unused.
2515
     * - decoding: Set by libavcodec
2516
     */
2517
    struct AVHWAccel *hwaccel;
2518

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

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

    
2540
    /**
2541
     * Chromaticity coordinates of the source primaries.
2542
     * - encoding: Set by user
2543
     * - decoding: Set by libavcodec
2544
     */
2545
    enum AVColorPrimaries color_primaries;
2546

    
2547
    /**
2548
     * Color Transfer Characteristic.
2549
     * - encoding: Set by user
2550
     * - decoding: Set by libavcodec
2551
     */
2552
    enum AVColorTransferCharacteristic color_trc;
2553

    
2554
    /**
2555
     * YUV colorspace type.
2556
     * - encoding: Set by user
2557
     * - decoding: Set by libavcodec
2558
     */
2559
    enum AVColorSpace colorspace;
2560

    
2561
    /**
2562
     * MPEG vs JPEG YUV range.
2563
     * - encoding: Set by user
2564
     * - decoding: Set by libavcodec
2565
     */
2566
    enum AVColorRange color_range;
2567

    
2568
    /**
2569
     * This defines the location of chroma samples.
2570
     * - encoding: Set by user
2571
     * - decoding: Set by libavcodec
2572
     */
2573
    enum AVChromaLocation chroma_sample_location;
2574

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

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

    
2605
    /**
2606
     * AQ mode
2607
     * 0: Disabled
2608
     * 1: Variance AQ (complexity mask)
2609
     * 2: Auto-variance AQ (experimental)
2610
     * - encoding: Set by user
2611
     * - decoding: unused
2612
     */
2613
    int aq_mode;
2614

    
2615
    /**
2616
     * AQ strength
2617
     * Reduces blocking and blurring in flat and textured areas.
2618
     * - encoding: Set by user
2619
     * - decoding: unused
2620
     */
2621
    float aq_strength;
2622

    
2623
    /**
2624
     * PSY RD
2625
     * Strength of psychovisual optimization
2626
     * - encoding: Set by user
2627
     * - decoding: unused
2628
     */
2629
    float psy_rd;
2630

    
2631
    /**
2632
     * PSY trellis
2633
     * Strength of psychovisual optimization
2634
     * - encoding: Set by user
2635
     * - decoding: unused
2636
     */
2637
    float psy_trellis;
2638

    
2639
    /**
2640
     * RC lookahead
2641
     * Number of frames for frametype and ratecontrol lookahead
2642
     * - encoding: Set by user
2643
     * - decoding: unused
2644
     */
2645
    int rc_lookahead;
2646
} AVCodecContext;
2647

    
2648
/**
2649
 * AVCodec.
2650
 */
2651
typedef struct AVCodec {
2652
    /**
2653
     * Name of the codec implementation.
2654
     * The name is globally unique among encoders and among decoders (but an
2655
     * encoder and a decoder can share the same name).
2656
     * This is the primary way to find a codec from the user perspective.
2657
     */
2658
    const char *name;
2659
    enum CodecType type;
2660
    enum CodecID id;
2661
    int priv_data_size;
2662
    int (*init)(AVCodecContext *);
2663
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2664
    int (*close)(AVCodecContext *);
2665
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2666
    /**
2667
     * Codec capabilities.
2668
     * see CODEC_CAP_*
2669
     */
2670
    int capabilities;
2671
    struct AVCodec *next;
2672
    /**
2673
     * Flush buffers.
2674
     * Will be called when seeking
2675
     */
2676
    void (*flush)(AVCodecContext *);
2677
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2678
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2679
    /**
2680
     * Descriptive name for the codec, meant to be more human readable than name.
2681
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2682
     */
2683
    const char *long_name;
2684
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2685
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2686
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2687
} AVCodec;
2688

    
2689
/**
2690
 * AVHWAccel.
2691
 */
2692
typedef struct AVHWAccel {
2693
    /**
2694
     * Name of the hardware accelerated codec.
2695
     * The name is globally unique among encoders and among decoders (but an
2696
     * encoder and a decoder can share the same name).
2697
     */
2698
    const char *name;
2699

    
2700
    /**
2701
     * Type of codec implemented by the hardware accelerator.
2702
     *
2703
     * See CODEC_TYPE_xxx
2704
     */
2705
    enum CodecType type;
2706

    
2707
    /**
2708
     * Codec implemented by the hardware accelerator.
2709
     *
2710
     * See CODEC_ID_xxx
2711
     */
2712
    enum CodecID id;
2713

    
2714
    /**
2715
     * Supported pixel format.
2716
     *
2717
     * Only hardware accelerated formats are supported here.
2718
     */
2719
    enum PixelFormat pix_fmt;
2720

    
2721
    /**
2722
     * Hardware accelerated codec capabilities.
2723
     * see FF_HWACCEL_CODEC_CAP_*
2724
     */
2725
    int capabilities;
2726

    
2727
    struct AVHWAccel *next;
2728

    
2729
    /**
2730
     * Called at the beginning of each frame or field picture.
2731
     *
2732
     * Meaningful frame information (codec specific) is guaranteed to
2733
     * be parsed at this point. This function is mandatory.
2734
     *
2735
     * Note that buf can be NULL along with buf_size set to 0.
2736
     * Otherwise, this means the whole frame is available at this point.
2737
     *
2738
     * @param avctx the codec context
2739
     * @param buf the frame data buffer base
2740
     * @param buf_size the size of the frame in bytes
2741
     * @return zero if successful, a negative value otherwise
2742
     */
2743
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2744

    
2745
    /**
2746
     * Callback for each slice.
2747
     *
2748
     * Meaningful slice information (codec specific) is guaranteed to
2749
     * be parsed at this point. This function is mandatory.
2750
     *
2751
     * @param avctx the codec context
2752
     * @param buf the slice data buffer base
2753
     * @param buf_size the size of the slice in bytes
2754
     * @return zero if successful, a negative value otherwise
2755
     */
2756
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2757

    
2758
    /**
2759
     * Called at the end of each frame or field picture.
2760
     *
2761
     * The whole picture is parsed at this point and can now be sent
2762
     * to the hardware accelerator. This function is mandatory.
2763
     *
2764
     * @param avctx the codec context
2765
     * @return zero if successful, a negative value otherwise
2766
     */
2767
    int (*end_frame)(AVCodecContext *avctx);
2768

    
2769
    /**
2770
     * Size of HW accelerator private data.
2771
     *
2772
     * Private data is allocated with av_mallocz() before
2773
     * AVCodecContext.get_buffer() and deallocated after
2774
     * AVCodecContext.release_buffer().
2775
     */
2776
    int priv_data_size;
2777
} AVHWAccel;
2778

    
2779
/**
2780
 * four components are given, that's all.
2781
 * the last component is alpha
2782
 */
2783
typedef struct AVPicture {
2784
    uint8_t *data[4];
2785
    int linesize[4];       ///< number of bytes per line
2786
} AVPicture;
2787

    
2788
#if LIBAVCODEC_VERSION_MAJOR < 53
2789
/**
2790
 * AVPaletteControl
2791
 * This structure defines a method for communicating palette changes
2792
 * between and demuxer and a decoder.
2793
 *
2794
 * @deprecated Use AVPacket to send palette changes instead.
2795
 * This is totally broken.
2796
 */
2797
#define AVPALETTE_SIZE 1024
2798
#define AVPALETTE_COUNT 256
2799
typedef struct AVPaletteControl {
2800

    
2801
    /* Demuxer sets this to 1 to indicate the palette has changed;
2802
     * decoder resets to 0. */
2803
    int palette_changed;
2804

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

    
2811
} AVPaletteControl attribute_deprecated;
2812
#endif
2813

    
2814
enum AVSubtitleType {
2815
    SUBTITLE_NONE,
2816

    
2817
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2818

    
2819
    /**
2820
     * Plain text, the text field must be set by the decoder and is
2821
     * authoritative. ass and pict fields may contain approximations.
2822
     */
2823
    SUBTITLE_TEXT,
2824

    
2825
    /**
2826
     * Formatted text, the ass field must be set by the decoder and is
2827
     * authoritative. pict and text fields may contain approximations.
2828
     */
2829
    SUBTITLE_ASS,
2830
};
2831

    
2832
typedef struct AVSubtitleRect {
2833
    int x;         ///< top left corner  of pict, undefined when pict is not set
2834
    int y;         ///< top left corner  of pict, undefined when pict is not set
2835
    int w;         ///< width            of pict, undefined when pict is not set
2836
    int h;         ///< height           of pict, undefined when pict is not set
2837
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2838

    
2839
    /**
2840
     * data+linesize for the bitmap of this subtitle.
2841
     * can be set for text/ass as well once they where rendered
2842
     */
2843
    AVPicture pict;
2844
    enum AVSubtitleType type;
2845

    
2846
    char *text;                     ///< 0 terminated plain UTF-8 text
2847

    
2848
    /**
2849
     * 0 terminated ASS/SSA compatible event line.
2850
     * The pressentation of this is unaffected by the other values in this
2851
     * struct.
2852
     */
2853
    char *ass;
2854
} AVSubtitleRect;
2855

    
2856
typedef struct AVSubtitle {
2857
    uint16_t format; /* 0 = graphics */
2858
    uint32_t start_display_time; /* relative to packet pts, in ms */
2859
    uint32_t end_display_time; /* relative to packet pts, in ms */
2860
    unsigned num_rects;
2861
    AVSubtitleRect **rects;
2862
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2863
} AVSubtitle;
2864

    
2865
/* packet functions */
2866

    
2867
/**
2868
 * @deprecated use NULL instead
2869
 */
2870
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2871

    
2872
/**
2873
 * Default packet destructor.
2874
 */
2875
void av_destruct_packet(AVPacket *pkt);
2876

    
2877
/**
2878
 * Initialize optional fields of a packet with default values.
2879
 *
2880
 * @param pkt packet
2881
 */
2882
void av_init_packet(AVPacket *pkt);
2883

    
2884
/**
2885
 * Allocate the payload of a packet and initialize its fields with
2886
 * default values.
2887
 *
2888
 * @param pkt packet
2889
 * @param size wanted payload size
2890
 * @return 0 if OK, AVERROR_xxx otherwise
2891
 */
2892
int av_new_packet(AVPacket *pkt, int size);
2893

    
2894
/**
2895
 * Reduce packet size, correctly zeroing padding
2896
 *
2897
 * @param pkt packet
2898
 * @param size new size
2899
 */
2900
void av_shrink_packet(AVPacket *pkt, int size);
2901

    
2902
/**
2903
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2904
 * packet is allocated if it was not really allocated.
2905
 */
2906
int av_dup_packet(AVPacket *pkt);
2907

    
2908
/**
2909
 * Free a packet.
2910
 *
2911
 * @param pkt packet to free
2912
 */
2913
void av_free_packet(AVPacket *pkt);
2914

    
2915
/* resample.c */
2916

    
2917
struct ReSampleContext;
2918
struct AVResampleContext;
2919

    
2920
typedef struct ReSampleContext ReSampleContext;
2921

    
2922
#if LIBAVCODEC_VERSION_MAJOR < 53
2923
/**
2924
 * @deprecated Use av_audio_resample_init() instead.
2925
 */
2926
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2927
                                                          int output_rate, int input_rate);
2928
#endif
2929
/**
2930
 *  Initializes audio resampling context
2931
 *
2932
 * @param output_channels  number of output channels
2933
 * @param input_channels   number of input channels
2934
 * @param output_rate      output sample rate
2935
 * @param input_rate       input sample rate
2936
 * @param sample_fmt_out   requested output sample format
2937
 * @param sample_fmt_in    input sample format
2938
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2939
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2940
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2941
                           between the 2 closest, if 0 the closest will be used
2942
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2943
 * @return allocated ReSampleContext, NULL if error occured
2944
 */
2945
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2946
                                        int output_rate, int input_rate,
2947
                                        enum SampleFormat sample_fmt_out,
2948
                                        enum SampleFormat sample_fmt_in,
2949
                                        int filter_length, int log2_phase_count,
2950
                                        int linear, double cutoff);
2951

    
2952
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2953
void audio_resample_close(ReSampleContext *s);
2954

    
2955

    
2956
/**
2957
 * Initializes an audio resampler.
2958
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2959
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2960
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2961
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2962
                 between the 2 closest, if 0 the closest will be used
2963
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2964
 */
2965
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2966

    
2967
/**
2968
 * resamples.
2969
 * @param src an array of unconsumed samples
2970
 * @param consumed the number of samples of src which have been consumed are returned here
2971
 * @param src_size the number of unconsumed samples available
2972
 * @param dst_size the amount of space in samples available in dst
2973
 * @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.
2974
 * @return the number of samples written in dst or -1 if an error occurred
2975
 */
2976
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2977

    
2978

    
2979
/**
2980
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2981
 * the resampler parameters, so no audible clicks or similar distortions occur
2982
 * @param compensation_distance distance in output samples over which the compensation should be performed
2983
 * @param sample_delta number of output samples which should be output less
2984
 *
2985
 * example: av_resample_compensate(c, 10, 500)
2986
 * here instead of 510 samples only 500 samples would be output
2987
 *
2988
 * note, due to rounding the actual compensation might be slightly different,
2989
 * especially if the compensation_distance is large and the in_rate used during init is small
2990
 */
2991
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2992
void av_resample_close(struct AVResampleContext *c);
2993

    
2994
/**
2995
 * Allocate memory for a picture.  Call avpicture_free to free it.
2996
 *
2997
 * @param picture the picture to be filled in
2998
 * @param pix_fmt the format of the picture
2999
 * @param width the width of the picture
3000
 * @param height the height of the picture
3001
 * @return zero if successful, a negative value if not
3002
 */
3003
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3004

    
3005
/**
3006
 * Free a picture previously allocated by avpicture_alloc().
3007
 *
3008
 * @param picture the AVPicture to be freed
3009
 */
3010
void avpicture_free(AVPicture *picture);
3011

    
3012
/**
3013
 * Fill in the AVPicture fields.
3014
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3015
 * which points to the image data buffer. Depending on the specified picture
3016
 * format, one or multiple image data pointers and line sizes will be set.
3017
 * If a planar format is specified, several pointers will be set pointing to
3018
 * the different picture planes and the line sizes of the different planes
3019
 * will be stored in the lines_sizes array.
3020
 * Call with ptr == NULL to get the required size for the ptr buffer.
3021
 *
3022
 * @param picture AVPicture whose fields are to be filled in
3023
 * @param ptr Buffer which will contain or contains the actual image data
3024
 * @param pix_fmt The format in which the picture data is stored.
3025
 * @param width the width of the image in pixels
3026
 * @param height the height of the image in pixels
3027
 * @return size of the image data in bytes
3028
 */
3029
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3030
                   enum PixelFormat pix_fmt, int width, int height);
3031
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3032
                     unsigned char *dest, int dest_size);
3033

    
3034
/**
3035
 * Calculate the size in bytes that a picture of the given width and height
3036
 * would occupy if stored in the given picture format.
3037
 * Note that this returns the size of a compact representation as generated
3038
 * by avpicture_layout, which can be smaller than the size required for e.g.
3039
 * avpicture_fill.
3040
 *
3041
 * @param pix_fmt the given picture format
3042
 * @param width the width of the image
3043
 * @param height the height of the image
3044
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3045
 */
3046
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3047
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3048
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3049
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3050

    
3051
#if LIBAVCODEC_VERSION_MAJOR < 53
3052
/**
3053
 * Returns the pixel format corresponding to the name name.
3054
 *
3055
 * If there is no pixel format with name name, then looks for a
3056
 * pixel format with the name corresponding to the native endian
3057
 * format of name.
3058
 * For example in a little-endian system, first looks for "gray16",
3059
 * then for "gray16le".
3060
 *
3061
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
3062
 *
3063
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3064
 */
3065
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3066
#endif
3067

    
3068
/**
3069
 * Returns a value representing the fourCC code associated to the
3070
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3071
 * found.
3072
 */
3073
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3074

    
3075
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3076
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3077
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3078
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3079
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3080
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3081

    
3082
/**
3083
 * Computes what kind of losses will occur when converting from one specific
3084
 * pixel format to another.
3085
 * When converting from one pixel format to another, information loss may occur.
3086
 * For example, when converting from RGB24 to GRAY, the color information will
3087
 * be lost. Similarly, other losses occur when converting from some formats to
3088
 * other formats. These losses can involve loss of chroma, but also loss of
3089
 * resolution, loss of color depth, loss due to the color space conversion, loss
3090
 * of the alpha bits or loss due to color quantization.
3091
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3092
 * which will occur when converting from one pixel format to another.
3093
 *
3094
 * @param[in] dst_pix_fmt destination pixel format
3095
 * @param[in] src_pix_fmt source pixel format
3096
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3097
 * @return Combination of flags informing you what kind of losses will occur.
3098
 */
3099
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3100
                             int has_alpha);
3101

    
3102
/**
3103
 * Finds the best pixel format to convert to given a certain source pixel
3104
 * format.  When converting from one pixel format to another, information loss
3105
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3106
 * information will be lost. Similarly, other losses occur when converting from
3107
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3108
 * the given pixel formats should be used to suffer the least amount of loss.
3109
 * The pixel formats from which it chooses one, are determined by the
3110
 * pix_fmt_mask parameter.
3111
 *
3112
 * @code
3113
 * src_pix_fmt = PIX_FMT_YUV420P;
3114
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3115
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3116
 * @endcode
3117
 *
3118
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3119
 * @param[in] src_pix_fmt source pixel format
3120
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3121
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3122
 * @return The best pixel format to convert to or -1 if none was found.
3123
 */
3124
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3125
                              int has_alpha, int *loss_ptr);
3126

    
3127

    
3128
/**
3129
 * Print in buf the string corresponding to the pixel format with
3130
 * number pix_fmt, or an header if pix_fmt is negative.
3131
 *
3132
 * @param[in] buf the buffer where to write the string
3133
 * @param[in] buf_size the size of buf
3134
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3135
 * a negative value to print the corresponding header.
3136
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3137
 */
3138
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3139

    
3140
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3141
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3142

    
3143
/**
3144
 * Tell if an image really has transparent alpha values.
3145
 * @return ored mask of FF_ALPHA_xxx constants
3146
 */
3147
int img_get_alpha_info(const AVPicture *src,
3148
                       enum PixelFormat pix_fmt, int width, int height);
3149

    
3150
/* deinterlace a picture */
3151
/* deinterlace - if not supported return -1 */
3152
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3153
                          enum PixelFormat pix_fmt, int width, int height);
3154

    
3155
/* external high level API */
3156

    
3157
/**
3158
 * If c is NULL, returns the first registered codec,
3159
 * if c is non-NULL, returns the next registered codec after c,
3160
 * or NULL if c is the last one.
3161
 */
3162
AVCodec *av_codec_next(AVCodec *c);
3163

    
3164
/**
3165
 * Returns the LIBAVCODEC_VERSION_INT constant.
3166
 */
3167
unsigned avcodec_version(void);
3168

    
3169
/**
3170
 * Returns the libavcodec build-time configuration.
3171
 */
3172
const char *avcodec_configuration(void);
3173

    
3174
/**
3175
 * Returns the libavcodec license.
3176
 */
3177
const char *avcodec_license(void);
3178

    
3179
/**
3180
 * Initializes libavcodec.
3181
 *
3182
 * @warning This function must be called before any other libavcodec
3183
 * function.
3184
 */
3185
void avcodec_init(void);
3186

    
3187
#if LIBAVCODEC_VERSION_MAJOR < 53
3188
/**
3189
 * @deprecated Deprecated in favor of avcodec_register().
3190
 */
3191
attribute_deprecated void register_avcodec(AVCodec *codec);
3192
#endif
3193

    
3194
/**
3195
 * Register the codec codec and initialize libavcodec.
3196
 *
3197
 * @see avcodec_init()
3198
 */
3199
void avcodec_register(AVCodec *codec);
3200

    
3201
/**
3202
 * Finds a registered encoder with a matching codec ID.
3203
 *
3204
 * @param id CodecID of the requested encoder
3205
 * @return An encoder if one was found, NULL otherwise.
3206
 */
3207
AVCodec *avcodec_find_encoder(enum CodecID id);
3208

    
3209
/**
3210
 * Finds a registered encoder with the specified name.
3211
 *
3212
 * @param name name of the requested encoder
3213
 * @return An encoder if one was found, NULL otherwise.
3214
 */
3215
AVCodec *avcodec_find_encoder_by_name(const char *name);
3216

    
3217
/**
3218
 * Finds a registered decoder with a matching codec ID.
3219
 *
3220
 * @param id CodecID of the requested decoder
3221
 * @return A decoder if one was found, NULL otherwise.
3222
 */
3223
AVCodec *avcodec_find_decoder(enum CodecID id);
3224

    
3225
/**
3226
 * Finds a registered decoder with the specified name.
3227
 *
3228
 * @param name name of the requested decoder
3229
 * @return A decoder if one was found, NULL otherwise.
3230
 */
3231
AVCodec *avcodec_find_decoder_by_name(const char *name);
3232
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3233

    
3234
/**
3235
 * Sets the fields of the given AVCodecContext to default values.
3236
 *
3237
 * @param s The AVCodecContext of which the fields should be set to default values.
3238
 */
3239
void avcodec_get_context_defaults(AVCodecContext *s);
3240

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

    
3245
/**
3246
 * Allocates an AVCodecContext and sets its fields to default values.  The
3247
 * resulting struct can be deallocated by simply calling av_free().
3248
 *
3249
 * @return An AVCodecContext filled with default values or NULL on failure.
3250
 * @see avcodec_get_context_defaults
3251
 */
3252
AVCodecContext *avcodec_alloc_context(void);
3253

    
3254
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3255
 *  we WILL change its arguments and name a few times! */
3256
AVCodecContext *avcodec_alloc_context2(enum CodecType);
3257

    
3258
/**
3259
 * Sets the fields of the given AVFrame to default values.
3260
 *
3261
 * @param pic The AVFrame of which the fields should be set to default values.
3262
 */
3263
void avcodec_get_frame_defaults(AVFrame *pic);
3264

    
3265
/**
3266
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3267
 * struct can be deallocated by simply calling av_free().
3268
 *
3269
 * @return An AVFrame filled with default values or NULL on failure.
3270
 * @see avcodec_get_frame_defaults
3271
 */
3272
AVFrame *avcodec_alloc_frame(void);
3273

    
3274
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3275
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3276
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3277
/**
3278
 * Modifies width and height values so that they will result in a memory
3279
 * buffer that is acceptable for the codec if you do not use any horizontal
3280
 * padding.
3281
 */
3282
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3283
/**
3284
 * Modifies width and height values so that they will result in a memory
3285
 * buffer that is acceptable for the codec if you also ensure that all
3286
 * line sizes are a multiple of the respective linesize_align[i].
3287
 */
3288
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3289
                               int linesize_align[4]);
3290

    
3291
/**
3292
 * Checks if the given dimension of a picture is valid, meaning that all
3293
 * bytes of the picture can be addressed with a signed int.
3294
 *
3295
 * @param[in] w Width of the picture.
3296
 * @param[in] h Height of the picture.
3297
 * @return Zero if valid, a negative value if invalid.
3298
 */
3299
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3300
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3301

    
3302
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3303
void avcodec_thread_free(AVCodecContext *s);
3304
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3305
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3306
//FIXME func typedef
3307

    
3308
/**
3309
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3310
 * function the context has to be allocated.
3311
 *
3312
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3313
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3314
 * retrieving a codec.
3315
 *
3316
 * @warning This function is not thread safe!
3317
 *
3318
 * @code
3319
 * avcodec_register_all();
3320
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3321
 * if (!codec)
3322
 *     exit(1);
3323
 *
3324
 * context = avcodec_alloc_context();
3325
 *
3326
 * if (avcodec_open(context, codec) < 0)
3327
 *     exit(1);
3328
 * @endcode
3329
 *
3330
 * @param avctx The context which will be set up to use the given codec.
3331
 * @param codec The codec to use within the context.
3332
 * @return zero on success, a negative value on error
3333
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3334
 */
3335
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3336

    
3337
#if LIBAVCODEC_VERSION_MAJOR < 53
3338
/**
3339
 * Decodes an audio frame from buf into samples.
3340
 * Wrapper function which calls avcodec_decode_audio3.
3341
 *
3342
 * @deprecated Use avcodec_decode_audio3 instead.
3343
 * @param avctx the codec context
3344
 * @param[out] samples the output buffer
3345
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3346
 * @param[in] buf the input buffer
3347
 * @param[in] buf_size the input buffer size in bytes
3348
 * @return On error a negative value is returned, otherwise the number of bytes
3349
 * used or zero if no frame could be decompressed.
3350
 */
3351
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3352
                         int *frame_size_ptr,
3353
                         const uint8_t *buf, int buf_size);
3354
#endif
3355

    
3356
/**
3357
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3358
 * Some decoders may support multiple frames in a single AVPacket, such
3359
 * decoders would then just decode the first frame. In this case,
3360
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3361
 * the remaining data in order to decode the second frame etc.
3362
 * If no frame
3363
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3364
 * decompressed frame size in bytes.
3365
 *
3366
 * @warning You must set frame_size_ptr to the allocated size of the
3367
 * output buffer before calling avcodec_decode_audio3().
3368
 *
3369
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3370
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3371
 * bits at once and could read over the end.
3372
 *
3373
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3374
 * no overreading happens for damaged MPEG streams.
3375
 *
3376
 * @note You might have to align the input buffer avpkt->data and output buffer
3377
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3378
 * necessary at all, on others it won't work at all if not aligned and on others
3379
 * it will work but it will have an impact on performance.
3380
 *
3381
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3382
 * samples should be 16 byte aligned unless the CPU doesn't need it
3383
 * (AltiVec and SSE do).
3384
 *
3385
 * @param avctx the codec context
3386
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3387
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3388
 * @param[in] avpkt The input AVPacket containing the input buffer.
3389
 *            You can create such packet with av_init_packet() and by then setting
3390
 *            data and size, some decoders might in addition need other fields.
3391
 *            All decoders are designed to use the least fields possible though.
3392
 * @return On error a negative value is returned, otherwise the number of bytes
3393
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3394
 */
3395
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3396
                         int *frame_size_ptr,
3397
                         AVPacket *avpkt);
3398

    
3399
#if LIBAVCODEC_VERSION_MAJOR < 53
3400
/**
3401
 * Decodes a video frame from buf into picture.
3402
 * Wrapper function which calls avcodec_decode_video2.
3403
 *
3404
 * @deprecated Use avcodec_decode_video2 instead.
3405
 * @param avctx the codec context
3406
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3407
 * @param[in] buf the input buffer
3408
 * @param[in] buf_size the size of the input buffer in bytes
3409
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3410
 * @return On error a negative value is returned, otherwise the number of bytes
3411
 * used or zero if no frame could be decompressed.
3412
 */
3413
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3414
                         int *got_picture_ptr,
3415
                         const uint8_t *buf, int buf_size);
3416
#endif
3417

    
3418
/**
3419
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3420
 * Some decoders may support multiple frames in a single AVPacket, such
3421
 * decoders would then just decode the first frame.
3422
 *
3423
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3424
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3425
 * bits at once and could read over the end.
3426
 *
3427
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3428
 * no overreading happens for damaged MPEG streams.
3429
 *
3430
 * @note You might have to align the input buffer avpkt->data.
3431
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3432
 * necessary at all, on others it won't work at all if not aligned and on others
3433
 * it will work but it will have an impact on performance.
3434
 *
3435
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3436
 *
3437
 * @note Some codecs have a delay between input and output, these need to be
3438
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3439
 *
3440
 * @param avctx the codec context
3441
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3442
 * @param[in] avpkt The input AVpacket containing the input buffer.
3443
 *            You can create such packet with av_init_packet() and by then setting
3444
 *            data and size, some decoders might in addition need other fields like
3445
 *            flags&PKT_FLAG_KEY. All decoders are designed to use the least
3446
 *            fields possible.
3447
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3448
 * @return On error a negative value is returned, otherwise the number of bytes
3449
 * used or zero if no frame could be decompressed.
3450
 */
3451
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3452
                         int *got_picture_ptr,
3453
                         AVPacket *avpkt);
3454

    
3455
#if LIBAVCODEC_VERSION_MAJOR < 53
3456
/* Decode a subtitle message. Return -1 if error, otherwise return the
3457
 * number of bytes used. If no subtitle could be decompressed,
3458
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3459
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3460
                            int *got_sub_ptr,
3461
                            const uint8_t *buf, int buf_size);
3462
#endif
3463

    
3464
/**
3465
 * Decodes a subtitle message.
3466
 * Returns a negative value on error, otherwise returns the number of bytes used.
3467
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3468
 * Otherwise, the subtitle is stored in *sub.
3469
 *
3470
 * @param avctx the codec context
3471
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3472
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3473
 * @param[in] avpkt The input AVPacket containing the input buffer.
3474
 */
3475
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3476
                            int *got_sub_ptr,
3477
                            AVPacket *avpkt);
3478
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3479
                        int *data_size_ptr,
3480
                        uint8_t *buf, int buf_size);
3481

    
3482
/**
3483
 * Encodes an audio frame from samples into buf.
3484
 *
3485
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3486
 * However, for PCM audio the user will know how much space is needed
3487
 * because it depends on the value passed in buf_size as described
3488
 * below. In that case a lower value can be used.
3489
 *
3490
 * @param avctx the codec context
3491
 * @param[out] buf the output buffer
3492
 * @param[in] buf_size the output buffer size
3493
 * @param[in] samples the input buffer containing the samples
3494
 * The number of samples read from this buffer is frame_size*channels,
3495
 * both of which are defined in avctx.
3496
 * For PCM audio the number of samples read from samples is equal to
3497
 * buf_size * input_sample_size / output_sample_size.
3498
 * @return On error a negative value is returned, on success zero or the number
3499
 * of bytes used to encode the data read from the input buffer.
3500
 */
3501
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3502
                         const short *samples);
3503

    
3504
/**
3505
 * Encodes a video frame from pict into buf.
3506
 * The input picture should be
3507
 * stored using a specific format, namely avctx.pix_fmt.
3508
 *
3509
 * @param avctx the codec context
3510
 * @param[out] buf the output buffer for the bitstream of encoded frame
3511
 * @param[in] buf_size the size of the output buffer in bytes
3512
 * @param[in] pict the input picture to encode
3513
 * @return On error a negative value is returned, on success zero or the number
3514
 * of bytes used from the output buffer.
3515
 */
3516
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3517
                         const AVFrame *pict);
3518
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3519
                            const AVSubtitle *sub);
3520

    
3521
int avcodec_close(AVCodecContext *avctx);
3522

    
3523
/**
3524
 * Register all the codecs, parsers and bitstream filters which were enabled at
3525
 * configuration time. If you do not call this function you can select exactly
3526
 * which formats you want to support, by using the individual registration
3527
 * functions.
3528
 *
3529
 * @see avcodec_register
3530
 * @see av_register_codec_parser
3531
 * @see av_register_bitstream_filter
3532
 */
3533
void avcodec_register_all(void);
3534

    
3535
/**
3536
 * Flush buffers, should be called when seeking or when switching to a different stream.
3537
 */
3538
void avcodec_flush_buffers(AVCodecContext *avctx);
3539

    
3540
void avcodec_default_free_buffers(AVCodecContext *s);
3541

    
3542
/* misc useful functions */
3543

    
3544
/**
3545
 * Returns a single letter to describe the given picture type pict_type.
3546
 *
3547
 * @param[in] pict_type the picture type
3548
 * @return A single character representing the picture type.
3549
 */
3550
char av_get_pict_type_char(int pict_type);
3551

    
3552
/**
3553
 * Returns codec bits per sample.
3554
 *
3555
 * @param[in] codec_id the codec
3556
 * @return Number of bits per sample or zero if unknown for the given codec.
3557
 */
3558
int av_get_bits_per_sample(enum CodecID codec_id);
3559

    
3560
/**
3561
 * Returns sample format bits per sample.
3562
 *
3563
 * @param[in] sample_fmt the sample format
3564
 * @return Number of bits per sample or zero if unknown for the given sample format.
3565
 */
3566
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3567

    
3568
/* frame parsing */
3569
typedef struct AVCodecParserContext {
3570
    void *priv_data;
3571
    struct AVCodecParser *parser;
3572
    int64_t frame_offset; /* offset of the current frame */
3573
    int64_t cur_offset; /* current offset
3574
                           (incremented by each av_parser_parse()) */
3575
    int64_t next_frame_offset; /* offset of the next frame */
3576
    /* video info */
3577
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3578
    /**
3579
     * This field is used for proper frame duration computation in lavf.
3580
     * It signals, how much longer the frame duration of the current frame
3581
     * is compared to normal frame duration.
3582
     *
3583
     * frame_duration = (1 + repeat_pict) * time_base
3584
     *
3585
     * It is used by codecs like H.264 to display telecined material.
3586
     */
3587
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3588
    int64_t pts;     /* pts of the current frame */
3589
    int64_t dts;     /* dts of the current frame */
3590

    
3591
    /* private data */
3592
    int64_t last_pts;
3593
    int64_t last_dts;
3594
    int fetch_timestamp;
3595

    
3596
#define AV_PARSER_PTS_NB 4
3597
    int cur_frame_start_index;
3598
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3599
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3600
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3601

    
3602
    int flags;
3603
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3604

    
3605
    int64_t offset;      ///< byte offset from starting packet start
3606
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3607

    
3608
    /*!
3609
     * Set by parser to 1 for key frames and 0 for non-key frames.
3610
     * It is initialized to -1, so if the parser doesn't set this flag,
3611
     * old-style fallback using FF_I_TYPE picture type as key frames
3612
     * will be used.
3613
     */
3614
    int key_frame;
3615

    
3616
    /**
3617
     * Time difference in stream time base units from the pts of this
3618
     * packet to the point at which the output from the decoder has converged
3619
     * independent from the availability of previous frames. That is, the
3620
     * frames are virtually identical no matter if decoding started from
3621
     * the very first frame or from this keyframe.
3622
     * Is AV_NOPTS_VALUE if unknown.
3623
     * This field is not the display duration of the current frame.
3624
     *
3625
     * The purpose of this field is to allow seeking in streams that have no
3626
     * keyframes in the conventional sense. It corresponds to the
3627
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3628
     * essential for some types of subtitle streams to ensure that all
3629
     * subtitles are correctly displayed after seeking.
3630
     */
3631
    int64_t convergence_duration;
3632

    
3633
    // Timestamp generation support:
3634
    /**
3635
     * Synchronization point for start of timestamp generation.
3636
     *
3637
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3638
     * (default).
3639
     *
3640
     * For example, this corresponds to presence of H.264 buffering period
3641
     * SEI message.
3642
     */
3643
    int dts_sync_point;
3644

    
3645
    /**
3646
     * Offset of the current timestamp against last timestamp sync point in
3647
     * units of AVCodecContext.time_base.
3648
     *
3649
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3650
     * contain a valid timestamp offset.
3651
     *
3652
     * Note that the timestamp of sync point has usually a nonzero
3653
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3654
     * the next frame after timestamp sync point will be usually 1.
3655
     *
3656
     * For example, this corresponds to H.264 cpb_removal_delay.
3657
     */
3658
    int dts_ref_dts_delta;
3659

    
3660
    /**
3661
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3662
     *
3663
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3664
     * contain valid non-negative timestamp delta (presentation time of a frame
3665
     * must not lie in the past).
3666
     *
3667
     * This delay represents the difference between decoding and presentation
3668
     * time of the frame.
3669
     *
3670
     * For example, this corresponds to H.264 dpb_output_delay.
3671
     */
3672
    int pts_dts_delta;
3673

    
3674
    /**
3675
     * Position of the packet in file.
3676
     *
3677
     * Analogous to cur_frame_pts/dts
3678
     */
3679
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3680

    
3681
    /**
3682
     * Byte position of currently parsed frame in stream.
3683
     */
3684
    int64_t pos;
3685

    
3686
    /**
3687
     * Previous frame byte position.
3688
     */
3689
    int64_t last_pos;
3690
} AVCodecParserContext;
3691

    
3692
typedef struct AVCodecParser {
3693
    int codec_ids[5]; /* several codec IDs are permitted */
3694
    int priv_data_size;
3695
    int (*parser_init)(AVCodecParserContext *s);
3696
    int (*parser_parse)(AVCodecParserContext *s,
3697
                        AVCodecContext *avctx,
3698
                        const uint8_t **poutbuf, int *poutbuf_size,
3699
                        const uint8_t *buf, int buf_size);
3700
    void (*parser_close)(AVCodecParserContext *s);
3701
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3702
    struct AVCodecParser *next;
3703
} AVCodecParser;
3704

    
3705
AVCodecParser *av_parser_next(AVCodecParser *c);
3706

    
3707
void av_register_codec_parser(AVCodecParser *parser);
3708
AVCodecParserContext *av_parser_init(int codec_id);
3709

    
3710
#if LIBAVCODEC_VERSION_MAJOR < 53
3711
attribute_deprecated
3712
int av_parser_parse(AVCodecParserContext *s,
3713
                    AVCodecContext *avctx,
3714
                    uint8_t **poutbuf, int *poutbuf_size,
3715
                    const uint8_t *buf, int buf_size,
3716
                    int64_t pts, int64_t dts);
3717
#endif
3718

    
3719
/**
3720
 * Parse a packet.
3721
 *
3722
 * @param s             parser context.
3723
 * @param avctx         codec context.
3724
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3725
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3726
 * @param buf           input buffer.
3727
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3728
 * @param pts           input presentation timestamp.
3729
 * @param dts           input decoding timestamp.
3730
 * @param pos           input byte position in stream.
3731
 * @return the number of bytes of the input bitstream used.
3732
 *
3733
 * Example:
3734
 * @code
3735
 *   while(in_len){
3736
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3737
 *                                        in_data, in_len,
3738
 *                                        pts, dts, pos);
3739
 *       in_data += len;
3740
 *       in_len  -= len;
3741
 *
3742
 *       if(size)
3743
 *          decode_frame(data, size);
3744
 *   }
3745
 * @endcode
3746
 */
3747
int av_parser_parse2(AVCodecParserContext *s,
3748
                     AVCodecContext *avctx,
3749
                     uint8_t **poutbuf, int *poutbuf_size,
3750
                     const uint8_t *buf, int buf_size,
3751
                     int64_t pts, int64_t dts,
3752
                     int64_t pos);
3753

    
3754
int av_parser_change(AVCodecParserContext *s,
3755
                     AVCodecContext *avctx,
3756
                     uint8_t **poutbuf, int *poutbuf_size,
3757
                     const uint8_t *buf, int buf_size, int keyframe);
3758
void av_parser_close(AVCodecParserContext *s);
3759

    
3760

    
3761
typedef struct AVBitStreamFilterContext {
3762
    void *priv_data;
3763
    struct AVBitStreamFilter *filter;
3764
    AVCodecParserContext *parser;
3765
    struct AVBitStreamFilterContext *next;
3766
} AVBitStreamFilterContext;
3767

    
3768

    
3769
typedef struct AVBitStreamFilter {
3770
    const char *name;
3771
    int priv_data_size;
3772
    int (*filter)(AVBitStreamFilterContext *bsfc,
3773
                  AVCodecContext *avctx, const char *args,
3774
                  uint8_t **poutbuf, int *poutbuf_size,
3775
                  const uint8_t *buf, int buf_size, int keyframe);
3776
    void (*close)(AVBitStreamFilterContext *bsfc);
3777
    struct AVBitStreamFilter *next;
3778
} AVBitStreamFilter;
3779

    
3780
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3781
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3782
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3783
                               AVCodecContext *avctx, const char *args,
3784
                               uint8_t **poutbuf, int *poutbuf_size,
3785
                               const uint8_t *buf, int buf_size, int keyframe);
3786
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3787

    
3788
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3789

    
3790
/* memory */
3791

    
3792
/**
3793
 * Reallocates the given block if it is not large enough, otherwise it
3794
 * does nothing.
3795
 *
3796
 * @see av_realloc
3797
 */
3798
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3799

    
3800
/**
3801
 * Allocates a buffer, reusing the given one if large enough.
3802
 *
3803
 * Contrary to av_fast_realloc the current buffer contents might not be
3804
 * preserved and on error the old buffer is freed, thus no special
3805
 * handling to avoid memleaks is necessary.
3806
 *
3807
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3808
 * @param size size of the buffer *ptr points to
3809
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3810
 *                 *size 0 if an error occurred.
3811
 */
3812
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3813

    
3814
/**
3815
 * Copy image 'src' to 'dst'.
3816
 */
3817
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3818
                     enum PixelFormat pix_fmt, int width, int height);
3819

    
3820
/**
3821
 * Crop image top and left side.
3822
 */
3823
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3824
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3825

    
3826
/**
3827
 * Pad image.
3828
 */
3829
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3830
            int padtop, int padbottom, int padleft, int padright, int *color);
3831

    
3832
/**
3833
 * Encodes extradata length to a buffer. Used by xiph codecs.
3834
 *
3835
 * @param s buffer to write to; must be at least (v/255+1) bytes long
3836
 * @param v size of extradata in bytes
3837
 * @return number of bytes written to the buffer.
3838
 */
3839
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3840

    
3841
/**
3842
 * Parses str and put in width_ptr and height_ptr the detected values.
3843
 *
3844
 * @return 0 in case of a successful parsing, a negative value otherwise
3845
 * @param[in] str the string to parse: it has to be a string in the format
3846
 * <width>x<height> or a valid video frame size abbreviation.
3847
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3848
 * frame width value
3849
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3850
 * frame height value
3851
 */
3852
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3853

    
3854
/**
3855
 * Parses str and put in frame_rate the detected values.
3856
 *
3857
 * @return 0 in case of a successful parsing, a negative value otherwise
3858
 * @param[in] str the string to parse: it has to be a string in the format
3859
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3860
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3861
 * frame rate
3862
 */
3863
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3864

    
3865
/**
3866
 * Logs a generic warning message about a missing feature. This function is
3867
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3868
 * only, and would normally not be used by applications.
3869
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3870
 * a pointer to an AVClass struct
3871
 * @param[in] feature string containing the name of the missing feature
3872
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3873
 * If want_sample is non-zero, additional verbage will be added to the log
3874
 * message which tells the user how to report samples to the development
3875
 * mailing list.
3876
 */
3877
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3878

    
3879
/**
3880
 * Logs a generic warning message asking for a sample. This function is
3881
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3882
 * only, and would normally not be used by applications.
3883
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3884
 * a pointer to an AVClass struct
3885
 * @param[in] msg string containing an optional message, or NULL if no message
3886
 */
3887
void av_log_ask_for_sample(void *avc, const char *msg);
3888

    
3889
/**
3890
 * Registers the hardware accelerator hwaccel.
3891
 */
3892
void av_register_hwaccel(AVHWAccel *hwaccel);
3893

    
3894
/**
3895
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3896
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3897
 * after hwaccel, or NULL if hwaccel is the last one.
3898
 */
3899
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3900

    
3901

    
3902
/**
3903
 * Lock operation used by lockmgr
3904
 */
3905
enum AVLockOp {
3906
  AV_LOCK_CREATE,  ///< Create a mutex
3907
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3908
  AV_LOCK_RELEASE, ///< Unlock the mutex
3909
  AV_LOCK_DESTROY, ///< Free mutex resources
3910
};
3911

    
3912
/**
3913
 * Register a user provided lock manager supporting the operations
3914
 * specified by AVLockOp. mutex points to a (void *) where the
3915
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3916
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3917
 *
3918
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3919
 *           callback during the call to av_lockmgr_register().
3920
 *           Thus, the application must be prepared to handle that.
3921
 *           If cb is set to NULL the lockmgr will be unregistered.
3922
 *           Also note that during unregistration the previously registered
3923
 *           lockmgr callback may also be invoked.
3924
 */
3925
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3926

    
3927
#endif /* AVCODEC_AVCODEC_H */