Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ f3b3b489

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

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

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

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

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

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

    
923

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

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

    
934

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1101
#define FF_ASPECT_EXTENDED 15
1102

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1223
    int b_frame_strategy;
1224

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

    
1233
    struct AVCodec *codec;
1234

    
1235
    void *priv_data;
1236

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

    
1244

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
1442
    float rc_qmod_amp;
1443
    int rc_qmod_freq;
1444

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
2726
    struct AVHWAccel *next;
2727

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

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

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

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

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

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

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

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

    
2810
} AVPaletteControl attribute_deprecated;
2811
#endif
2812

    
2813
enum AVSubtitleType {
2814
    SUBTITLE_NONE,
2815

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

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

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

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

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

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

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

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

    
2864
/* packet functions */
2865

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

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

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

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

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

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

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

    
2914
/* resample.c */
2915

    
2916
struct ReSampleContext;
2917
struct AVResampleContext;
2918

    
2919
typedef struct ReSampleContext ReSampleContext;
2920

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

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

    
2954

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

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

    
2977

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

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

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

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

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

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

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

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

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

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

    
3126

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

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

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

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

    
3154
/* external high level API */
3155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
3520
int avcodec_close(AVCodecContext *avctx);
3521

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

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

    
3539
void avcodec_default_free_buffers(AVCodecContext *s);
3540

    
3541
/* misc useful functions */
3542

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

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

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

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

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

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

    
3601
    int flags;
3602
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3603

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

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

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

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

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

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

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

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

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

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

    
3704
AVCodecParser *av_parser_next(AVCodecParser *c);
3705

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

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

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

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

    
3759

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

    
3767

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

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

    
3787
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3788

    
3789
/* memory */
3790

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

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

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

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

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

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

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

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

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

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

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

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

    
3900

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

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

    
3926
#endif /* AVCODEC_AVCODEC_H */