Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 1f96d868

History | View | Annotate | Download (130 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
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 81
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
 * Identify 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
    CODEC_ID_YOP,
213
    CODEC_ID_VP8,
214
    CODEC_ID_PICTOR,
215

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

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

    
273
    /* AMR */
274
    CODEC_ID_AMR_NB= 0x12000,
275
    CODEC_ID_AMR_WB,
276

    
277
    /* RealAudio codecs*/
278
    CODEC_ID_RA_144= 0x13000,
279
    CODEC_ID_RA_288,
280

    
281
    /* various DPCM codecs */
282
    CODEC_ID_ROQ_DPCM= 0x14000,
283
    CODEC_ID_INTERPLAY_DPCM,
284
    CODEC_ID_XAN_DPCM,
285
    CODEC_ID_SOL_DPCM,
286

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

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

    
351
    /* other specific kind of codecs (generally used for attachments) */
352
    CODEC_ID_TTF= 0x18000,
353

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

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

    
360
#if LIBAVCODEC_VERSION_MAJOR < 53
361
#define CodecType AVMediaType
362

    
363
#define CODEC_TYPE_UNKNOWN    AVMEDIA_TYPE_UNKNOWN
364
#define CODEC_TYPE_VIDEO      AVMEDIA_TYPE_VIDEO
365
#define CODEC_TYPE_AUDIO      AVMEDIA_TYPE_AUDIO
366
#define CODEC_TYPE_DATA       AVMEDIA_TYPE_DATA
367
#define CODEC_TYPE_SUBTITLE   AVMEDIA_TYPE_SUBTITLE
368
#define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
369
#define CODEC_TYPE_NB         AVMEDIA_TYPE_NB
370
#endif
371

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

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

    
407
/** Channel mask value used for AVCodecContext.request_channel_layout
408
    to indicate that the user requests the channel order of the decoder output
409
    to be the native codec channel order. */
410
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
411

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

    
430
/* in bytes */
431
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
432

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

    
442
/**
443
 * minimum encoding buffer size
444
 * Used to avoid some checks during header writing.
445
 */
446
#define FF_MIN_BUFFER_SIZE 16384
447

    
448

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

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

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

    
487
enum AVColorTransferCharacteristic{
488
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
489
    AVCOL_TRC_UNSPECIFIED=2,
490
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
491
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
492
    AVCOL_TRC_NB           , ///< Not part of ABI
493
};
494

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

    
506
enum AVColorRange{
507
    AVCOL_RANGE_UNSPECIFIED=0,
508
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
509
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
510
    AVCOL_RANGE_NB           , ///< Not part of ABI
511
};
512

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

    
529
typedef struct RcOverride{
530
    int start_frame;
531
    int end_frame;
532
    int qscale; // If this is 0 then quality_factor will be used instead.
533
    float quality_factor;
534
} RcOverride;
535

    
536
#define FF_MAX_B_FRAMES 16
537

    
538
/* encoding support
539
   These flags can be passed in AVCodecContext.flags before initialization.
540
   Note: Not everything is supported yet.
541
*/
542

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

    
604
/* Unsupported options :
605
 *              Syntax Arithmetic coding (SAC)
606
 *              Reference Picture Selection
607
 *              Independent Segment Decoding */
608
/* /Fx */
609
/* codec capabilities */
610

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

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

    
679
/**
680
 * Pan Scan area.
681
 * This specifies the area which should be displayed.
682
 * Note there may be multiple such areas for one frame.
683
 */
684
typedef struct AVPanScan{
685
    /**
686
     * id
687
     * - encoding: Set by user.
688
     * - decoding: Set by libavcodec.
689
     */
690
    int id;
691

    
692
    /**
693
     * width and height in 1/16 pel
694
     * - encoding: Set by user.
695
     * - decoding: Set by libavcodec.
696
     */
697
    int width;
698
    int height;
699

    
700
    /**
701
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
702
     * - encoding: Set by user.
703
     * - decoding: Set by libavcodec.
704
     */
705
    int16_t position[3][2];
706
}AVPanScan;
707

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

    
935

    
936
#define FF_QSCALE_TYPE_MPEG1 0
937
#define FF_QSCALE_TYPE_MPEG2 1
938
#define FF_QSCALE_TYPE_H264  2
939
#define FF_QSCALE_TYPE_VP56  3
940

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

    
946

    
947
#define FF_I_TYPE  1 ///< Intra
948
#define FF_P_TYPE  2 ///< Predicted
949
#define FF_B_TYPE  3 ///< Bi-dir predicted
950
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
951
#define FF_SI_TYPE 5 ///< Switching Intra
952
#define FF_SP_TYPE 6 ///< Switching Predicted
953
#define FF_BI_TYPE 7
954

    
955
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
956
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
957
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
958
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
959

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

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

    
1014
/**
1015
 * Audio Video Frame.
1016
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1017
 * bumps.
1018
 * Removal, reordering and changes to existing fields require a major
1019
 * version bump. No fields should be added into AVFrame before or after
1020
 * FF_COMMON_FRAME!
1021
 * sizeof(AVFrame) must not be used outside libav*.
1022
 */
1023
typedef struct AVFrame {
1024
    FF_COMMON_FRAME
1025
} AVFrame;
1026

    
1027
/**
1028
 * main external API structure.
1029
 * New fields can be added to the end with minor version bumps.
1030
 * Removal, reordering and changes to existing fields require a major
1031
 * version bump.
1032
 * sizeof(AVCodecContext) must not be used outside libav*.
1033
 */
1034
typedef struct AVCodecContext {
1035
    /**
1036
     * information on struct for av_log
1037
     * - set by avcodec_alloc_context
1038
     */
1039
    const AVClass *av_class;
1040
    /**
1041
     * the average bitrate
1042
     * - encoding: Set by user; unused for constant quantizer encoding.
1043
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1044
     */
1045
    int bit_rate;
1046

    
1047
    /**
1048
     * number of bits the bitstream is allowed to diverge from the reference.
1049
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1050
     * - encoding: Set by user; unused for constant quantizer encoding.
1051
     * - decoding: unused
1052
     */
1053
    int bit_rate_tolerance;
1054

    
1055
    /**
1056
     * CODEC_FLAG_*.
1057
     * - encoding: Set by user.
1058
     * - decoding: Set by user.
1059
     */
1060
    int flags;
1061

    
1062
    /**
1063
     * Some codecs need additional format info. It is stored here.
1064
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1065
     * specific codec MUST set it correctly otherwise stream copy breaks.
1066
     * In general use of this field by muxers is not recommanded.
1067
     * - encoding: Set by libavcodec.
1068
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1069
     */
1070
    int sub_id;
1071

    
1072
    /**
1073
     * Motion estimation algorithm used for video coding.
1074
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1075
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1076
     * - encoding: MUST be set by user.
1077
     * - decoding: unused
1078
     */
1079
    int me_method;
1080

    
1081
    /**
1082
     * some codecs need / can use extradata like Huffman tables.
1083
     * mjpeg: Huffman tables
1084
     * rv10: additional flags
1085
     * mpeg4: global headers (they can be in the bitstream or here)
1086
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1087
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1088
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1089
     * - encoding: Set/allocated/freed by libavcodec.
1090
     * - decoding: Set/allocated/freed by user.
1091
     */
1092
    uint8_t *extradata;
1093
    int extradata_size;
1094

    
1095
    /**
1096
     * This is the fundamental unit of time (in seconds) in terms
1097
     * of which frame timestamps are represented. For fixed-fps content,
1098
     * timebase should be 1/framerate and timestamp increments should be
1099
     * identically 1.
1100
     * - encoding: MUST be set by user.
1101
     * - decoding: Set by libavcodec.
1102
     */
1103
    AVRational time_base;
1104

    
1105
    /* video only */
1106
    /**
1107
     * picture width / height.
1108
     * - encoding: MUST be set by user.
1109
     * - decoding: Set by libavcodec.
1110
     * Note: For compatibility it is possible to set this instead of
1111
     * coded_width/height before decoding.
1112
     */
1113
    int width, height;
1114

    
1115
#define FF_ASPECT_EXTENDED 15
1116

    
1117
    /**
1118
     * the number of pictures in a group of pictures, or 0 for intra_only
1119
     * - encoding: Set by user.
1120
     * - decoding: unused
1121
     */
1122
    int gop_size;
1123

    
1124
    /**
1125
     * Pixel format, see PIX_FMT_xxx.
1126
     * May be set by the demuxer if known from headers.
1127
     * May be overriden by the decoder if it knows better.
1128
     * - encoding: Set by user.
1129
     * - decoding: Set by user if known, overridden by libavcodec if known
1130
     */
1131
    enum PixelFormat pix_fmt;
1132

    
1133
    /**
1134
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1135
     * has to read frames at native frame rate.
1136
     * - encoding: Set by user.
1137
     * - decoding: unused
1138
     */
1139
    int rate_emu;
1140

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

    
1164
    /* audio only */
1165
    int sample_rate; ///< samples per second
1166
    int channels;    ///< number of audio channels
1167

    
1168
    /**
1169
     * audio sample format
1170
     * - encoding: Set by user.
1171
     * - decoding: Set by libavcodec.
1172
     */
1173
    enum SampleFormat sample_fmt;  ///< sample format
1174

    
1175
    /* The following data should not be initialized. */
1176
    /**
1177
     * Samples per packet, initialized when calling 'init'.
1178
     */
1179
    int frame_size;
1180
    int frame_number;   ///< audio or video frame number
1181
#if LIBAVCODEC_VERSION_MAJOR < 53
1182
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1183
#endif
1184

    
1185
    /**
1186
     * Number of frames the decoded output will be delayed relative to
1187
     * the encoded input.
1188
     * - encoding: Set by libavcodec.
1189
     * - decoding: unused
1190
     */
1191
    int delay;
1192

    
1193
    /* - encoding parameters */
1194
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1195
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1196

    
1197
    /**
1198
     * minimum quantizer
1199
     * - encoding: Set by user.
1200
     * - decoding: unused
1201
     */
1202
    int qmin;
1203

    
1204
    /**
1205
     * maximum quantizer
1206
     * - encoding: Set by user.
1207
     * - decoding: unused
1208
     */
1209
    int qmax;
1210

    
1211
    /**
1212
     * maximum quantizer difference between frames
1213
     * - encoding: Set by user.
1214
     * - decoding: unused
1215
     */
1216
    int max_qdiff;
1217

    
1218
    /**
1219
     * maximum number of B-frames between non-B-frames
1220
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1221
     * - encoding: Set by user.
1222
     * - decoding: unused
1223
     */
1224
    int max_b_frames;
1225

    
1226
    /**
1227
     * qscale factor between IP and B-frames
1228
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1229
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1230
     * - encoding: Set by user.
1231
     * - decoding: unused
1232
     */
1233
    float b_quant_factor;
1234

    
1235
    /** obsolete FIXME remove */
1236
    int rc_strategy;
1237
#define FF_RC_STRATEGY_XVID 1
1238

    
1239
    int b_frame_strategy;
1240

    
1241
    /**
1242
     * hurry up amount
1243
     * - encoding: unused
1244
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1245
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1246
     */
1247
    int hurry_up;
1248

    
1249
    struct AVCodec *codec;
1250

    
1251
    void *priv_data;
1252

    
1253
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1254
                            /* do its best to deliver a chunk with size     */
1255
                            /* below rtp_payload_size, the chunk will start */
1256
                            /* with a start code on some codecs like H.263. */
1257
                            /* This doesn't take account of any particular  */
1258
                            /* headers inside the transmitted RTP payload.  */
1259

    
1260

    
1261
    /* The RTP callback: This function is called    */
1262
    /* every time the encoder has a packet to send. */
1263
    /* It depends on the encoder if the data starts */
1264
    /* with a Start Code (it should). H.263 does.   */
1265
    /* mb_nb contains the number of macroblocks     */
1266
    /* encoded in the RTP payload.                  */
1267
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1268

    
1269
    /* statistics, used for 2-pass encoding */
1270
    int mv_bits;
1271
    int header_bits;
1272
    int i_tex_bits;
1273
    int p_tex_bits;
1274
    int i_count;
1275
    int p_count;
1276
    int skip_count;
1277
    int misc_bits;
1278

    
1279
    /**
1280
     * number of bits used for the previously encoded frame
1281
     * - encoding: Set by libavcodec.
1282
     * - decoding: unused
1283
     */
1284
    int frame_bits;
1285

    
1286
    /**
1287
     * Private data of the user, can be used to carry app specific stuff.
1288
     * - encoding: Set by user.
1289
     * - decoding: Set by user.
1290
     */
1291
    void *opaque;
1292

    
1293
    char codec_name[32];
1294
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1295
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1296

    
1297
    /**
1298
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1299
     * This is used to work around some encoder bugs.
1300
     * A demuxer should set this to what is stored in the field used to identify the codec.
1301
     * If there are multiple such fields in a container then the demuxer should choose the one
1302
     * which maximizes the information about the used codec.
1303
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1304
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1305
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1306
     * first.
1307
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1308
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1309
     */
1310
    unsigned int codec_tag;
1311

    
1312
    /**
1313
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1314
     * - encoding: Set by user
1315
     * - decoding: Set by user
1316
     */
1317
    int workaround_bugs;
1318
#define FF_BUG_AUTODETECT       1  ///< autodetection
1319
#define FF_BUG_OLD_MSMPEG4      2
1320
#define FF_BUG_XVID_ILACE       4
1321
#define FF_BUG_UMP4             8
1322
#define FF_BUG_NO_PADDING       16
1323
#define FF_BUG_AMV              32
1324
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1325
#define FF_BUG_QPEL_CHROMA      64
1326
#define FF_BUG_STD_QPEL         128
1327
#define FF_BUG_QPEL_CHROMA2     256
1328
#define FF_BUG_DIRECT_BLOCKSIZE 512
1329
#define FF_BUG_EDGE             1024
1330
#define FF_BUG_HPEL_CHROMA      2048
1331
#define FF_BUG_DC_CLIP          4096
1332
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1333
#define FF_BUG_TRUNCATED       16384
1334
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1335

    
1336
    /**
1337
     * luma single coefficient elimination threshold
1338
     * - encoding: Set by user.
1339
     * - decoding: unused
1340
     */
1341
    int luma_elim_threshold;
1342

    
1343
    /**
1344
     * chroma single coeff elimination threshold
1345
     * - encoding: Set by user.
1346
     * - decoding: unused
1347
     */
1348
    int chroma_elim_threshold;
1349

    
1350
    /**
1351
     * strictly follow the standard (MPEG4, ...).
1352
     * - encoding: Set by user.
1353
     * - decoding: Set by user.
1354
     * Setting this to STRICT or higher means the encoder and decoder will
1355
     * generally do stupid things, whereas setting it to unofficial or lower
1356
     * will mean the encoder might produce output that is not supported by all
1357
     * spec-compliant decoders. Decoders don't differentiate between normal,
1358
     * unofficial and experimental (that is, they always try to decode things
1359
     * when they can) unless they are explicitly asked to behave stupidly
1360
     * (=strictly conform to the specs)
1361
     */
1362
    int strict_std_compliance;
1363
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1364
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1365
#define FF_COMPLIANCE_NORMAL        0
1366
#if LIBAVCODEC_VERSION_MAJOR < 53
1367
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1368
#endif
1369
#define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1370
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1371

    
1372
    /**
1373
     * qscale offset between IP and B-frames
1374
     * - encoding: Set by user.
1375
     * - decoding: unused
1376
     */
1377
    float b_quant_offset;
1378

    
1379
    /**
1380
     * Error recognization; higher values will detect more errors but may
1381
     * misdetect some more or less valid parts as errors.
1382
     * - encoding: unused
1383
     * - decoding: Set by user.
1384
     */
1385
    int error_recognition;
1386
#define FF_ER_CAREFUL         1
1387
#define FF_ER_COMPLIANT       2
1388
#define FF_ER_AGGRESSIVE      3
1389
#define FF_ER_VERY_AGGRESSIVE 4
1390

    
1391
    /**
1392
     * Called at the beginning of each frame to get a buffer for it.
1393
     * If pic.reference is set then the frame will be read later by libavcodec.
1394
     * avcodec_align_dimensions2() should be used to find the required width and
1395
     * height, as they normally need to be rounded up to the next multiple of 16.
1396
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1397
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1398
     * some other means.
1399
     * - encoding: unused
1400
     * - decoding: Set by libavcodec., user can override.
1401
     */
1402
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1403

    
1404
    /**
1405
     * Called to release buffers which were allocated with get_buffer.
1406
     * A released buffer can be reused in get_buffer().
1407
     * pic.data[*] must be set to NULL.
1408
     * - encoding: unused
1409
     * - decoding: Set by libavcodec., user can override.
1410
     */
1411
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1412

    
1413
    /**
1414
     * Size of the frame reordering buffer in the decoder.
1415
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1416
     * - encoding: Set by libavcodec.
1417
     * - decoding: Set by libavcodec.
1418
     */
1419
    int has_b_frames;
1420

    
1421
    /**
1422
     * number of bytes per packet if constant and known or 0
1423
     * Used by some WAV based audio codecs.
1424
     */
1425
    int block_align;
1426

    
1427
    int parse_only; /* - decoding only: If true, only parsing is done
1428
                       (function avcodec_parse_frame()). The frame
1429
                       data is returned. Only MPEG codecs support this now. */
1430

    
1431
    /**
1432
     * 0-> h263 quant 1-> mpeg quant
1433
     * - encoding: Set by user.
1434
     * - decoding: unused
1435
     */
1436
    int mpeg_quant;
1437

    
1438
    /**
1439
     * pass1 encoding statistics output buffer
1440
     * - encoding: Set by libavcodec.
1441
     * - decoding: unused
1442
     */
1443
    char *stats_out;
1444

    
1445
    /**
1446
     * pass2 encoding statistics input buffer
1447
     * Concatenated stuff from stats_out of pass1 should be placed here.
1448
     * - encoding: Allocated/set/freed by user.
1449
     * - decoding: unused
1450
     */
1451
    char *stats_in;
1452

    
1453
    /**
1454
     * ratecontrol qmin qmax limiting method
1455
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1456
     * - encoding: Set by user.
1457
     * - decoding: unused
1458
     */
1459
    float rc_qsquish;
1460

    
1461
    float rc_qmod_amp;
1462
    int rc_qmod_freq;
1463

    
1464
    /**
1465
     * ratecontrol override, see RcOverride
1466
     * - encoding: Allocated/set/freed by user.
1467
     * - decoding: unused
1468
     */
1469
    RcOverride *rc_override;
1470
    int rc_override_count;
1471

    
1472
    /**
1473
     * rate control equation
1474
     * - encoding: Set by user
1475
     * - decoding: unused
1476
     */
1477
    const char *rc_eq;
1478

    
1479
    /**
1480
     * maximum bitrate
1481
     * - encoding: Set by user.
1482
     * - decoding: unused
1483
     */
1484
    int rc_max_rate;
1485

    
1486
    /**
1487
     * minimum bitrate
1488
     * - encoding: Set by user.
1489
     * - decoding: unused
1490
     */
1491
    int rc_min_rate;
1492

    
1493
    /**
1494
     * decoder bitstream buffer size
1495
     * - encoding: Set by user.
1496
     * - decoding: unused
1497
     */
1498
    int rc_buffer_size;
1499
    float rc_buffer_aggressivity;
1500

    
1501
    /**
1502
     * qscale factor between P and I-frames
1503
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1504
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1505
     * - encoding: Set by user.
1506
     * - decoding: unused
1507
     */
1508
    float i_quant_factor;
1509

    
1510
    /**
1511
     * qscale offset between P and I-frames
1512
     * - encoding: Set by user.
1513
     * - decoding: unused
1514
     */
1515
    float i_quant_offset;
1516

    
1517
    /**
1518
     * initial complexity for pass1 ratecontrol
1519
     * - encoding: Set by user.
1520
     * - decoding: unused
1521
     */
1522
    float rc_initial_cplx;
1523

    
1524
    /**
1525
     * DCT algorithm, see FF_DCT_* below
1526
     * - encoding: Set by user.
1527
     * - decoding: unused
1528
     */
1529
    int dct_algo;
1530
#define FF_DCT_AUTO    0
1531
#define FF_DCT_FASTINT 1
1532
#define FF_DCT_INT     2
1533
#define FF_DCT_MMX     3
1534
#define FF_DCT_MLIB    4
1535
#define FF_DCT_ALTIVEC 5
1536
#define FF_DCT_FAAN    6
1537

    
1538
    /**
1539
     * luminance masking (0-> disabled)
1540
     * - encoding: Set by user.
1541
     * - decoding: unused
1542
     */
1543
    float lumi_masking;
1544

    
1545
    /**
1546
     * temporary complexity masking (0-> disabled)
1547
     * - encoding: Set by user.
1548
     * - decoding: unused
1549
     */
1550
    float temporal_cplx_masking;
1551

    
1552
    /**
1553
     * spatial complexity masking (0-> disabled)
1554
     * - encoding: Set by user.
1555
     * - decoding: unused
1556
     */
1557
    float spatial_cplx_masking;
1558

    
1559
    /**
1560
     * p block masking (0-> disabled)
1561
     * - encoding: Set by user.
1562
     * - decoding: unused
1563
     */
1564
    float p_masking;
1565

    
1566
    /**
1567
     * darkness masking (0-> disabled)
1568
     * - encoding: Set by user.
1569
     * - decoding: unused
1570
     */
1571
    float dark_masking;
1572

    
1573
    /**
1574
     * IDCT algorithm, see FF_IDCT_* below.
1575
     * - encoding: Set by user.
1576
     * - decoding: Set by user.
1577
     */
1578
    int idct_algo;
1579
#define FF_IDCT_AUTO          0
1580
#define FF_IDCT_INT           1
1581
#define FF_IDCT_SIMPLE        2
1582
#define FF_IDCT_SIMPLEMMX     3
1583
#define FF_IDCT_LIBMPEG2MMX   4
1584
#define FF_IDCT_PS2           5
1585
#define FF_IDCT_MLIB          6
1586
#define FF_IDCT_ARM           7
1587
#define FF_IDCT_ALTIVEC       8
1588
#define FF_IDCT_SH4           9
1589
#define FF_IDCT_SIMPLEARM     10
1590
#define FF_IDCT_H264          11
1591
#define FF_IDCT_VP3           12
1592
#define FF_IDCT_IPP           13
1593
#define FF_IDCT_XVIDMMX       14
1594
#define FF_IDCT_CAVS          15
1595
#define FF_IDCT_SIMPLEARMV5TE 16
1596
#define FF_IDCT_SIMPLEARMV6   17
1597
#define FF_IDCT_SIMPLEVIS     18
1598
#define FF_IDCT_WMV2          19
1599
#define FF_IDCT_FAAN          20
1600
#define FF_IDCT_EA            21
1601
#define FF_IDCT_SIMPLENEON    22
1602
#define FF_IDCT_SIMPLEALPHA   23
1603
#define FF_IDCT_BINK          24
1604

    
1605
    /**
1606
     * slice count
1607
     * - encoding: Set by libavcodec.
1608
     * - decoding: Set by user (or 0).
1609
     */
1610
    int slice_count;
1611
    /**
1612
     * slice offsets in the frame in bytes
1613
     * - encoding: Set/allocated by libavcodec.
1614
     * - decoding: Set/allocated by user (or NULL).
1615
     */
1616
    int *slice_offset;
1617

    
1618
    /**
1619
     * error concealment flags
1620
     * - encoding: unused
1621
     * - decoding: Set by user.
1622
     */
1623
    int error_concealment;
1624
#define FF_EC_GUESS_MVS   1
1625
#define FF_EC_DEBLOCK     2
1626

    
1627
    /**
1628
     * dsp_mask could be add used to disable unwanted CPU features
1629
     * CPU features (i.e. MMX, SSE. ...)
1630
     *
1631
     * With the FORCE flag you may instead enable given CPU features.
1632
     * (Dangerous: Usable in case of misdetection, improper usage however will
1633
     * result into program crash.)
1634
     */
1635
    unsigned dsp_mask;
1636
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1637
    /* lower 16 bits - CPU features */
1638
#define FF_MM_MMX      0x0001 ///< standard MMX
1639
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1640
#if LIBAVCODEC_VERSION_MAJOR < 53
1641
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1642
#endif
1643
#define FF_MM_MMX2     0x0002 ///< SSE integer functions or AMD MMX ext
1644
#define FF_MM_SSE      0x0008 ///< SSE functions
1645
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1646
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1647
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1648
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1649
#define FF_MM_SSE4     0x0100 ///< Penryn SSE4.1 functions
1650
#define FF_MM_SSE42    0x0200 ///< Nehalem SSE4.2 functions
1651
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1652
#define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
1653

    
1654
    /**
1655
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1656
     * - encoding: Set by libavcodec.
1657
     * - decoding: Set by user.
1658
     */
1659
     int bits_per_coded_sample;
1660

    
1661
    /**
1662
     * prediction method (needed for huffyuv)
1663
     * - encoding: Set by user.
1664
     * - decoding: unused
1665
     */
1666
     int prediction_method;
1667
#define FF_PRED_LEFT   0
1668
#define FF_PRED_PLANE  1
1669
#define FF_PRED_MEDIAN 2
1670

    
1671
    /**
1672
     * sample aspect ratio (0 if unknown)
1673
     * That is the width of a pixel divided by the height of the pixel.
1674
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1675
     * - encoding: Set by user.
1676
     * - decoding: Set by libavcodec.
1677
     */
1678
    AVRational sample_aspect_ratio;
1679

    
1680
    /**
1681
     * the picture in the bitstream
1682
     * - encoding: Set by libavcodec.
1683
     * - decoding: Set by libavcodec.
1684
     */
1685
    AVFrame *coded_frame;
1686

    
1687
    /**
1688
     * debug
1689
     * - encoding: Set by user.
1690
     * - decoding: Set by user.
1691
     */
1692
    int debug;
1693
#define FF_DEBUG_PICT_INFO   1
1694
#define FF_DEBUG_RC          2
1695
#define FF_DEBUG_BITSTREAM   4
1696
#define FF_DEBUG_MB_TYPE     8
1697
#define FF_DEBUG_QP          16
1698
#define FF_DEBUG_MV          32
1699
#define FF_DEBUG_DCT_COEFF   0x00000040
1700
#define FF_DEBUG_SKIP        0x00000080
1701
#define FF_DEBUG_STARTCODE   0x00000100
1702
#define FF_DEBUG_PTS         0x00000200
1703
#define FF_DEBUG_ER          0x00000400
1704
#define FF_DEBUG_MMCO        0x00000800
1705
#define FF_DEBUG_BUGS        0x00001000
1706
#define FF_DEBUG_VIS_QP      0x00002000
1707
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1708
#define FF_DEBUG_BUFFERS     0x00008000
1709

    
1710
    /**
1711
     * debug
1712
     * - encoding: Set by user.
1713
     * - decoding: Set by user.
1714
     */
1715
    int debug_mv;
1716
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1717
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1718
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1719

    
1720
    /**
1721
     * error
1722
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1723
     * - decoding: unused
1724
     */
1725
    uint64_t error[4];
1726

    
1727
    /**
1728
     * minimum MB quantizer
1729
     * - encoding: unused
1730
     * - decoding: unused
1731
     */
1732
    int mb_qmin;
1733

    
1734
    /**
1735
     * maximum MB quantizer
1736
     * - encoding: unused
1737
     * - decoding: unused
1738
     */
1739
    int mb_qmax;
1740

    
1741
    /**
1742
     * motion estimation comparison function
1743
     * - encoding: Set by user.
1744
     * - decoding: unused
1745
     */
1746
    int me_cmp;
1747
    /**
1748
     * subpixel motion estimation comparison function
1749
     * - encoding: Set by user.
1750
     * - decoding: unused
1751
     */
1752
    int me_sub_cmp;
1753
    /**
1754
     * macroblock comparison function (not supported yet)
1755
     * - encoding: Set by user.
1756
     * - decoding: unused
1757
     */
1758
    int mb_cmp;
1759
    /**
1760
     * interlaced DCT comparison function
1761
     * - encoding: Set by user.
1762
     * - decoding: unused
1763
     */
1764
    int ildct_cmp;
1765
#define FF_CMP_SAD    0
1766
#define FF_CMP_SSE    1
1767
#define FF_CMP_SATD   2
1768
#define FF_CMP_DCT    3
1769
#define FF_CMP_PSNR   4
1770
#define FF_CMP_BIT    5
1771
#define FF_CMP_RD     6
1772
#define FF_CMP_ZERO   7
1773
#define FF_CMP_VSAD   8
1774
#define FF_CMP_VSSE   9
1775
#define FF_CMP_NSSE   10
1776
#define FF_CMP_W53    11
1777
#define FF_CMP_W97    12
1778
#define FF_CMP_DCTMAX 13
1779
#define FF_CMP_DCT264 14
1780
#define FF_CMP_CHROMA 256
1781

    
1782
    /**
1783
     * ME diamond size & shape
1784
     * - encoding: Set by user.
1785
     * - decoding: unused
1786
     */
1787
    int dia_size;
1788

    
1789
    /**
1790
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1791
     * - encoding: Set by user.
1792
     * - decoding: unused
1793
     */
1794
    int last_predictor_count;
1795

    
1796
    /**
1797
     * prepass for motion estimation
1798
     * - encoding: Set by user.
1799
     * - decoding: unused
1800
     */
1801
    int pre_me;
1802

    
1803
    /**
1804
     * motion estimation prepass comparison function
1805
     * - encoding: Set by user.
1806
     * - decoding: unused
1807
     */
1808
    int me_pre_cmp;
1809

    
1810
    /**
1811
     * ME prepass diamond size & shape
1812
     * - encoding: Set by user.
1813
     * - decoding: unused
1814
     */
1815
    int pre_dia_size;
1816

    
1817
    /**
1818
     * subpel ME quality
1819
     * - encoding: Set by user.
1820
     * - decoding: unused
1821
     */
1822
    int me_subpel_quality;
1823

    
1824
    /**
1825
     * callback to negotiate the pixelFormat
1826
     * @param fmt is the list of formats which are supported by the codec,
1827
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1828
     * The first is always the native one.
1829
     * @return the chosen format
1830
     * - encoding: unused
1831
     * - decoding: Set by user, if not set the native format will be chosen.
1832
     */
1833
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1834

    
1835
    /**
1836
     * DTG active format information (additional aspect ratio
1837
     * information only used in DVB MPEG-2 transport streams)
1838
     * 0 if not set.
1839
     *
1840
     * - encoding: unused
1841
     * - decoding: Set by decoder.
1842
     */
1843
    int dtg_active_format;
1844
#define FF_DTG_AFD_SAME         8
1845
#define FF_DTG_AFD_4_3          9
1846
#define FF_DTG_AFD_16_9         10
1847
#define FF_DTG_AFD_14_9         11
1848
#define FF_DTG_AFD_4_3_SP_14_9  13
1849
#define FF_DTG_AFD_16_9_SP_14_9 14
1850
#define FF_DTG_AFD_SP_4_3       15
1851

    
1852
    /**
1853
     * maximum motion estimation search range in subpel units
1854
     * If 0 then no limit.
1855
     *
1856
     * - encoding: Set by user.
1857
     * - decoding: unused
1858
     */
1859
    int me_range;
1860

    
1861
    /**
1862
     * intra quantizer bias
1863
     * - encoding: Set by user.
1864
     * - decoding: unused
1865
     */
1866
    int intra_quant_bias;
1867
#define FF_DEFAULT_QUANT_BIAS 999999
1868

    
1869
    /**
1870
     * inter quantizer bias
1871
     * - encoding: Set by user.
1872
     * - decoding: unused
1873
     */
1874
    int inter_quant_bias;
1875

    
1876
    /**
1877
     * color table ID
1878
     * - encoding: unused
1879
     * - decoding: Which clrtable should be used for 8bit RGB images.
1880
     *             Tables have to be stored somewhere. FIXME
1881
     */
1882
    int color_table_id;
1883

    
1884
    /**
1885
     * internal_buffer count
1886
     * Don't touch, used by libavcodec default_get_buffer().
1887
     */
1888
    int internal_buffer_count;
1889

    
1890
    /**
1891
     * internal_buffers
1892
     * Don't touch, used by libavcodec default_get_buffer().
1893
     */
1894
    void *internal_buffer;
1895

    
1896
#define FF_LAMBDA_SHIFT 7
1897
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1898
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1899
#define FF_LAMBDA_MAX (256*128-1)
1900

    
1901
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1902
    /**
1903
     * Global quality for codecs which cannot change it per frame.
1904
     * This should be proportional to MPEG-1/2/4 qscale.
1905
     * - encoding: Set by user.
1906
     * - decoding: unused
1907
     */
1908
    int global_quality;
1909

    
1910
#define FF_CODER_TYPE_VLC       0
1911
#define FF_CODER_TYPE_AC        1
1912
#define FF_CODER_TYPE_RAW       2
1913
#define FF_CODER_TYPE_RLE       3
1914
#define FF_CODER_TYPE_DEFLATE   4
1915
    /**
1916
     * coder type
1917
     * - encoding: Set by user.
1918
     * - decoding: unused
1919
     */
1920
    int coder_type;
1921

    
1922
    /**
1923
     * context model
1924
     * - encoding: Set by user.
1925
     * - decoding: unused
1926
     */
1927
    int context_model;
1928
#if 0
1929
    /**
1930
     *
1931
     * - encoding: unused
1932
     * - decoding: Set by user.
1933
     */
1934
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1935
#endif
1936

    
1937
    /**
1938
     * slice flags
1939
     * - encoding: unused
1940
     * - decoding: Set by user.
1941
     */
1942
    int slice_flags;
1943
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1944
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1945
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1946

    
1947
    /**
1948
     * XVideo Motion Acceleration
1949
     * - encoding: forbidden
1950
     * - decoding: set by decoder
1951
     */
1952
    int xvmc_acceleration;
1953

    
1954
    /**
1955
     * macroblock decision mode
1956
     * - encoding: Set by user.
1957
     * - decoding: unused
1958
     */
1959
    int mb_decision;
1960
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1961
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1962
#define FF_MB_DECISION_RD     2        ///< rate distortion
1963

    
1964
    /**
1965
     * custom intra quantization matrix
1966
     * - encoding: Set by user, can be NULL.
1967
     * - decoding: Set by libavcodec.
1968
     */
1969
    uint16_t *intra_matrix;
1970

    
1971
    /**
1972
     * custom inter quantization matrix
1973
     * - encoding: Set by user, can be NULL.
1974
     * - decoding: Set by libavcodec.
1975
     */
1976
    uint16_t *inter_matrix;
1977

    
1978
    /**
1979
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1980
     * This is used to work around some encoder bugs.
1981
     * - encoding: unused
1982
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1983
     */
1984
    unsigned int stream_codec_tag;
1985

    
1986
    /**
1987
     * scene change detection threshold
1988
     * 0 is default, larger means fewer detected scene changes.
1989
     * - encoding: Set by user.
1990
     * - decoding: unused
1991
     */
1992
    int scenechange_threshold;
1993

    
1994
    /**
1995
     * minimum Lagrange multipler
1996
     * - encoding: Set by user.
1997
     * - decoding: unused
1998
     */
1999
    int lmin;
2000

    
2001
    /**
2002
     * maximum Lagrange multipler
2003
     * - encoding: Set by user.
2004
     * - decoding: unused
2005
     */
2006
    int lmax;
2007

    
2008
    /**
2009
     * palette control structure
2010
     * - encoding: ??? (no palette-enabled encoder yet)
2011
     * - decoding: Set by user.
2012
     */
2013
    struct AVPaletteControl *palctrl;
2014

    
2015
    /**
2016
     * noise reduction strength
2017
     * - encoding: Set by user.
2018
     * - decoding: unused
2019
     */
2020
    int noise_reduction;
2021

    
2022
    /**
2023
     * Called at the beginning of a frame to get cr buffer for it.
2024
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
2025
     * libavcodec will pass previous buffer in pic, function should return
2026
     * same buffer or new buffer with old frame "painted" into it.
2027
     * If pic.data[0] == NULL must behave like get_buffer().
2028
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2029
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
2030
     * some other means.
2031
     * - encoding: unused
2032
     * - decoding: Set by libavcodec., user can override
2033
     */
2034
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2035

    
2036
    /**
2037
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2038
     * - encoding: Set by user.
2039
     * - decoding: unused
2040
     */
2041
    int rc_initial_buffer_occupancy;
2042

    
2043
    /**
2044
     *
2045
     * - encoding: Set by user.
2046
     * - decoding: unused
2047
     */
2048
    int inter_threshold;
2049

    
2050
    /**
2051
     * CODEC_FLAG2_*
2052
     * - encoding: Set by user.
2053
     * - decoding: Set by user.
2054
     */
2055
    int flags2;
2056

    
2057
    /**
2058
     * Simulates errors in the bitstream to test error concealment.
2059
     * - encoding: Set by user.
2060
     * - decoding: unused
2061
     */
2062
    int error_rate;
2063

    
2064
    /**
2065
     * MP3 antialias algorithm, see FF_AA_* below.
2066
     * - encoding: unused
2067
     * - decoding: Set by user.
2068
     */
2069
    int antialias_algo;
2070
#define FF_AA_AUTO    0
2071
#define FF_AA_FASTINT 1 //not implemented yet
2072
#define FF_AA_INT     2
2073
#define FF_AA_FLOAT   3
2074
    /**
2075
     * quantizer noise shaping
2076
     * - encoding: Set by user.
2077
     * - decoding: unused
2078
     */
2079
    int quantizer_noise_shaping;
2080

    
2081
    /**
2082
     * thread count
2083
     * is used to decide how many independent tasks should be passed to execute()
2084
     * - encoding: Set by user.
2085
     * - decoding: Set by user.
2086
     */
2087
    int thread_count;
2088

    
2089
    /**
2090
     * The codec may call this to execute several independent things.
2091
     * It will return only after finishing all tasks.
2092
     * The user may replace this with some multithreaded implementation,
2093
     * the default implementation will execute the parts serially.
2094
     * @param count the number of things to execute
2095
     * - encoding: Set by libavcodec, user can override.
2096
     * - decoding: Set by libavcodec, user can override.
2097
     */
2098
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2099

    
2100
    /**
2101
     * thread opaque
2102
     * Can be used by execute() to store some per AVCodecContext stuff.
2103
     * - encoding: set by execute()
2104
     * - decoding: set by execute()
2105
     */
2106
    void *thread_opaque;
2107

    
2108
    /**
2109
     * Motion estimation threshold below which no motion estimation is
2110
     * performed, but instead the user specified motion vectors are used.
2111
     *
2112
     * - encoding: Set by user.
2113
     * - decoding: unused
2114
     */
2115
     int me_threshold;
2116

    
2117
    /**
2118
     * Macroblock threshold below which the user specified macroblock types will be used.
2119
     * - encoding: Set by user.
2120
     * - decoding: unused
2121
     */
2122
     int mb_threshold;
2123

    
2124
    /**
2125
     * precision of the intra DC coefficient - 8
2126
     * - encoding: Set by user.
2127
     * - decoding: unused
2128
     */
2129
     int intra_dc_precision;
2130

    
2131
    /**
2132
     * noise vs. sse weight for the nsse comparsion function
2133
     * - encoding: Set by user.
2134
     * - decoding: unused
2135
     */
2136
     int nsse_weight;
2137

    
2138
    /**
2139
     * Number of macroblock rows at the top which are skipped.
2140
     * - encoding: unused
2141
     * - decoding: Set by user.
2142
     */
2143
     int skip_top;
2144

    
2145
    /**
2146
     * Number of macroblock rows at the bottom which are skipped.
2147
     * - encoding: unused
2148
     * - decoding: Set by user.
2149
     */
2150
     int skip_bottom;
2151

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

    
2160
#define FF_PROFILE_AAC_MAIN 0
2161
#define FF_PROFILE_AAC_LOW  1
2162
#define FF_PROFILE_AAC_SSR  2
2163
#define FF_PROFILE_AAC_LTP  3
2164

    
2165
#define FF_PROFILE_H264_BASELINE    66
2166
#define FF_PROFILE_H264_MAIN        77
2167
#define FF_PROFILE_H264_EXTENDED    88
2168
#define FF_PROFILE_H264_HIGH        100
2169
#define FF_PROFILE_H264_HIGH_10     110
2170
#define FF_PROFILE_H264_HIGH_422    122
2171
#define FF_PROFILE_H264_HIGH_444    244
2172
#define FF_PROFILE_H264_CAVLC_444   44
2173

    
2174
    /**
2175
     * level
2176
     * - encoding: Set by user.
2177
     * - decoding: Set by libavcodec.
2178
     */
2179
     int level;
2180
#define FF_LEVEL_UNKNOWN -99
2181

    
2182
    /**
2183
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2184
     * - encoding: unused
2185
     * - decoding: Set by user.
2186
     */
2187
     int lowres;
2188

    
2189
    /**
2190
     * Bitstream width / height, may be different from width/height if lowres
2191
     * or other things are used.
2192
     * - encoding: unused
2193
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2194
     */
2195
    int coded_width, coded_height;
2196

    
2197
    /**
2198
     * frame skip threshold
2199
     * - encoding: Set by user.
2200
     * - decoding: unused
2201
     */
2202
    int frame_skip_threshold;
2203

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

    
2211
    /**
2212
     * frame skip exponent
2213
     * - encoding: Set by user.
2214
     * - decoding: unused
2215
     */
2216
    int frame_skip_exp;
2217

    
2218
    /**
2219
     * frame skip comparison function
2220
     * - encoding: Set by user.
2221
     * - decoding: unused
2222
     */
2223
    int frame_skip_cmp;
2224

    
2225
    /**
2226
     * Border processing masking, raises the quantizer for mbs on the borders
2227
     * of the picture.
2228
     * - encoding: Set by user.
2229
     * - decoding: unused
2230
     */
2231
    float border_masking;
2232

    
2233
    /**
2234
     * minimum MB lagrange multipler
2235
     * - encoding: Set by user.
2236
     * - decoding: unused
2237
     */
2238
    int mb_lmin;
2239

    
2240
    /**
2241
     * maximum MB lagrange multipler
2242
     * - encoding: Set by user.
2243
     * - decoding: unused
2244
     */
2245
    int mb_lmax;
2246

    
2247
    /**
2248
     *
2249
     * - encoding: Set by user.
2250
     * - decoding: unused
2251
     */
2252
    int me_penalty_compensation;
2253

    
2254
    /**
2255
     *
2256
     * - encoding: unused
2257
     * - decoding: Set by user.
2258
     */
2259
    enum AVDiscard skip_loop_filter;
2260

    
2261
    /**
2262
     *
2263
     * - encoding: unused
2264
     * - decoding: Set by user.
2265
     */
2266
    enum AVDiscard skip_idct;
2267

    
2268
    /**
2269
     *
2270
     * - encoding: unused
2271
     * - decoding: Set by user.
2272
     */
2273
    enum AVDiscard skip_frame;
2274

    
2275
    /**
2276
     *
2277
     * - encoding: Set by user.
2278
     * - decoding: unused
2279
     */
2280
    int bidir_refine;
2281

    
2282
    /**
2283
     *
2284
     * - encoding: Set by user.
2285
     * - decoding: unused
2286
     */
2287
    int brd_scale;
2288

    
2289
    /**
2290
     * constant rate factor - quality-based VBR - values ~correspond to qps
2291
     * - encoding: Set by user.
2292
     * - decoding: unused
2293
     */
2294
    float crf;
2295

    
2296
    /**
2297
     * constant quantization parameter rate control method
2298
     * - encoding: Set by user.
2299
     * - decoding: unused
2300
     */
2301
    int cqp;
2302

    
2303
    /**
2304
     * minimum GOP size
2305
     * - encoding: Set by user.
2306
     * - decoding: unused
2307
     */
2308
    int keyint_min;
2309

    
2310
    /**
2311
     * number of reference frames
2312
     * - encoding: Set by user.
2313
     * - decoding: Set by lavc.
2314
     */
2315
    int refs;
2316

    
2317
    /**
2318
     * chroma qp offset from luma
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int chromaoffset;
2323

    
2324
    /**
2325
     * Influences how often B-frames are used.
2326
     * - encoding: Set by user.
2327
     * - decoding: unused
2328
     */
2329
    int bframebias;
2330

    
2331
    /**
2332
     * trellis RD quantization
2333
     * - encoding: Set by user.
2334
     * - decoding: unused
2335
     */
2336
    int trellis;
2337

    
2338
    /**
2339
     * Reduce fluctuations in qp (before curve compression).
2340
     * - encoding: Set by user.
2341
     * - decoding: unused
2342
     */
2343
    float complexityblur;
2344

    
2345
    /**
2346
     * in-loop deblocking filter alphac0 parameter
2347
     * alpha is in the range -6...6
2348
     * - encoding: Set by user.
2349
     * - decoding: unused
2350
     */
2351
    int deblockalpha;
2352

    
2353
    /**
2354
     * in-loop deblocking filter beta parameter
2355
     * beta is in the range -6...6
2356
     * - encoding: Set by user.
2357
     * - decoding: unused
2358
     */
2359
    int deblockbeta;
2360

    
2361
    /**
2362
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2363
     * - encoding: Set by user.
2364
     * - decoding: unused
2365
     */
2366
    int partitions;
2367
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2368
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2369
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2370
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2371
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2372

    
2373
    /**
2374
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int directpred;
2379

    
2380
    /**
2381
     * Audio cutoff bandwidth (0 means "automatic")
2382
     * - encoding: Set by user.
2383
     * - decoding: unused
2384
     */
2385
    int cutoff;
2386

    
2387
    /**
2388
     * Multiplied by qscale for each frame and added to scene_change_score.
2389
     * - encoding: Set by user.
2390
     * - decoding: unused
2391
     */
2392
    int scenechange_factor;
2393

    
2394
    /**
2395
     *
2396
     * Note: Value depends upon the compare function used for fullpel ME.
2397
     * - encoding: Set by user.
2398
     * - decoding: unused
2399
     */
2400
    int mv0_threshold;
2401

    
2402
    /**
2403
     * Adjusts sensitivity of b_frame_strategy 1.
2404
     * - encoding: Set by user.
2405
     * - decoding: unused
2406
     */
2407
    int b_sensitivity;
2408

    
2409
    /**
2410
     * - encoding: Set by user.
2411
     * - decoding: unused
2412
     */
2413
    int compression_level;
2414
#define FF_COMPRESSION_DEFAULT -1
2415

    
2416
    /**
2417
     * Sets whether to use LPC mode - used by FLAC encoder.
2418
     * - encoding: Set by user.
2419
     * - decoding: unused
2420
     */
2421
    int use_lpc;
2422

    
2423
    /**
2424
     * LPC coefficient precision - used by FLAC encoder
2425
     * - encoding: Set by user.
2426
     * - decoding: unused
2427
     */
2428
    int lpc_coeff_precision;
2429

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

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

    
2442
    /**
2443
     * search method for selecting prediction order
2444
     * - encoding: Set by user.
2445
     * - decoding: unused
2446
     */
2447
    int prediction_order_method;
2448

    
2449
    /**
2450
     * - encoding: Set by user.
2451
     * - decoding: unused
2452
     */
2453
    int min_partition_order;
2454

    
2455
    /**
2456
     * - encoding: Set by user.
2457
     * - decoding: unused
2458
     */
2459
    int max_partition_order;
2460

    
2461
    /**
2462
     * GOP timecode frame start number, in non drop frame format
2463
     * - encoding: Set by user.
2464
     * - decoding: unused
2465
     */
2466
    int64_t timecode_frame_start;
2467

    
2468
#if LIBAVCODEC_VERSION_MAJOR < 53
2469
    /**
2470
     * Decoder should decode to this many channels if it can (0 for default)
2471
     * - encoding: unused
2472
     * - decoding: Set by user.
2473
     * @deprecated Deprecated in favor of request_channel_layout.
2474
     */
2475
    int request_channels;
2476
#endif
2477

    
2478
    /**
2479
     * Percentage of dynamic range compression to be applied by the decoder.
2480
     * The default value is 1.0, corresponding to full compression.
2481
     * - encoding: unused
2482
     * - decoding: Set by user.
2483
     */
2484
    float drc_scale;
2485

    
2486
    /**
2487
     * opaque 64bit number (generally a PTS) that will be reordered and
2488
     * output in AVFrame.reordered_opaque
2489
     * - encoding: unused
2490
     * - decoding: Set by user.
2491
     */
2492
    int64_t reordered_opaque;
2493

    
2494
    /**
2495
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2496
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2497
     * - encoding: set by user.
2498
     * - decoding: set by libavcodec.
2499
     */
2500
    int bits_per_raw_sample;
2501

    
2502
    /**
2503
     * Audio channel layout.
2504
     * - encoding: set by user.
2505
     * - decoding: set by libavcodec.
2506
     */
2507
    int64_t channel_layout;
2508

    
2509
    /**
2510
     * Request decoder to use this channel layout if it can (0 for default)
2511
     * - encoding: unused
2512
     * - decoding: Set by user.
2513
     */
2514
    int64_t request_channel_layout;
2515

    
2516
    /**
2517
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2518
     * - encoding: Set by user.
2519
     * - decoding: unused.
2520
     */
2521
    float rc_max_available_vbv_use;
2522

    
2523
    /**
2524
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2525
     * - encoding: Set by user.
2526
     * - decoding: unused.
2527
     */
2528
    float rc_min_vbv_overflow_use;
2529

    
2530
    /**
2531
     * Hardware accelerator in use
2532
     * - encoding: unused.
2533
     * - decoding: Set by libavcodec
2534
     */
2535
    struct AVHWAccel *hwaccel;
2536

    
2537
    /**
2538
     * For some codecs, the time base is closer to the field rate than the frame rate.
2539
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2540
     * if no telecine is used ...
2541
     *
2542
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2543
     */
2544
    int ticks_per_frame;
2545

    
2546
    /**
2547
     * Hardware accelerator context.
2548
     * For some hardware accelerators, a global context needs to be
2549
     * provided by the user. In that case, this holds display-dependent
2550
     * data FFmpeg cannot instantiate itself. Please refer to the
2551
     * FFmpeg HW accelerator documentation to know how to fill this
2552
     * is. e.g. for VA API, this is a struct vaapi_context.
2553
     * - encoding: unused
2554
     * - decoding: Set by user
2555
     */
2556
    void *hwaccel_context;
2557

    
2558
    /**
2559
     * Chromaticity coordinates of the source primaries.
2560
     * - encoding: Set by user
2561
     * - decoding: Set by libavcodec
2562
     */
2563
    enum AVColorPrimaries color_primaries;
2564

    
2565
    /**
2566
     * Color Transfer Characteristic.
2567
     * - encoding: Set by user
2568
     * - decoding: Set by libavcodec
2569
     */
2570
    enum AVColorTransferCharacteristic color_trc;
2571

    
2572
    /**
2573
     * YUV colorspace type.
2574
     * - encoding: Set by user
2575
     * - decoding: Set by libavcodec
2576
     */
2577
    enum AVColorSpace colorspace;
2578

    
2579
    /**
2580
     * MPEG vs JPEG YUV range.
2581
     * - encoding: Set by user
2582
     * - decoding: Set by libavcodec
2583
     */
2584
    enum AVColorRange color_range;
2585

    
2586
    /**
2587
     * This defines the location of chroma samples.
2588
     * - encoding: Set by user
2589
     * - decoding: Set by libavcodec
2590
     */
2591
    enum AVChromaLocation chroma_sample_location;
2592

    
2593
    /**
2594
     * The codec may call this to execute several independent things.
2595
     * It will return only after finishing all tasks.
2596
     * The user may replace this with some multithreaded implementation,
2597
     * the default implementation will execute the parts serially.
2598
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2599
     * @param c context passed also to func
2600
     * @param count the number of things to execute
2601
     * @param arg2 argument passed unchanged to func
2602
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2603
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2604
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2605
     *             two instances of func executing at the same time will have the same threadnr.
2606
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2607
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2608
     * - encoding: Set by libavcodec, user can override.
2609
     * - decoding: Set by libavcodec, user can override.
2610
     */
2611
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2612

    
2613
    /**
2614
     * explicit P-frame weighted prediction analysis method
2615
     * 0: off
2616
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2617
     * 2: smart weighting (full fade detection analysis)
2618
     * - encoding: Set by user.
2619
     * - decoding: unused
2620
     */
2621
    int weighted_p_pred;
2622

    
2623
    /**
2624
     * AQ mode
2625
     * 0: Disabled
2626
     * 1: Variance AQ (complexity mask)
2627
     * 2: Auto-variance AQ (experimental)
2628
     * - encoding: Set by user
2629
     * - decoding: unused
2630
     */
2631
    int aq_mode;
2632

    
2633
    /**
2634
     * AQ strength
2635
     * Reduces blocking and blurring in flat and textured areas.
2636
     * - encoding: Set by user
2637
     * - decoding: unused
2638
     */
2639
    float aq_strength;
2640

    
2641
    /**
2642
     * PSY RD
2643
     * Strength of psychovisual optimization
2644
     * - encoding: Set by user
2645
     * - decoding: unused
2646
     */
2647
    float psy_rd;
2648

    
2649
    /**
2650
     * PSY trellis
2651
     * Strength of psychovisual optimization
2652
     * - encoding: Set by user
2653
     * - decoding: unused
2654
     */
2655
    float psy_trellis;
2656

    
2657
    /**
2658
     * RC lookahead
2659
     * Number of frames for frametype and ratecontrol lookahead
2660
     * - encoding: Set by user
2661
     * - decoding: unused
2662
     */
2663
    int rc_lookahead;
2664

    
2665
    /**
2666
     * Constant rate factor maximum
2667
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2668
     * than crf_max, even if doing so would violate VBV restrictions.
2669
     * - encoding: Set by user.
2670
     * - decoding: unused
2671
     */
2672
    float crf_max;
2673

    
2674
    int log_level_offset;
2675
} AVCodecContext;
2676

    
2677
/**
2678
 * AVCodec.
2679
 */
2680
typedef struct AVCodec {
2681
    /**
2682
     * Name of the codec implementation.
2683
     * The name is globally unique among encoders and among decoders (but an
2684
     * encoder and a decoder can share the same name).
2685
     * This is the primary way to find a codec from the user perspective.
2686
     */
2687
    const char *name;
2688
    enum AVMediaType type;
2689
    enum CodecID id;
2690
    int priv_data_size;
2691
    int (*init)(AVCodecContext *);
2692
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2693
    int (*close)(AVCodecContext *);
2694
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2695
    /**
2696
     * Codec capabilities.
2697
     * see CODEC_CAP_*
2698
     */
2699
    int capabilities;
2700
    struct AVCodec *next;
2701
    /**
2702
     * Flush buffers.
2703
     * Will be called when seeking
2704
     */
2705
    void (*flush)(AVCodecContext *);
2706
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2707
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2708
    /**
2709
     * Descriptive name for the codec, meant to be more human readable than name.
2710
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2711
     */
2712
    const char *long_name;
2713
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2714
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2715
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2716
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2717
} AVCodec;
2718

    
2719
/**
2720
 * AVHWAccel.
2721
 */
2722
typedef struct AVHWAccel {
2723
    /**
2724
     * Name of the hardware accelerated codec.
2725
     * The name is globally unique among encoders and among decoders (but an
2726
     * encoder and a decoder can share the same name).
2727
     */
2728
    const char *name;
2729

    
2730
    /**
2731
     * Type of codec implemented by the hardware accelerator.
2732
     *
2733
     * See AVMEDIA_TYPE_xxx
2734
     */
2735
    enum AVMediaType type;
2736

    
2737
    /**
2738
     * Codec implemented by the hardware accelerator.
2739
     *
2740
     * See CODEC_ID_xxx
2741
     */
2742
    enum CodecID id;
2743

    
2744
    /**
2745
     * Supported pixel format.
2746
     *
2747
     * Only hardware accelerated formats are supported here.
2748
     */
2749
    enum PixelFormat pix_fmt;
2750

    
2751
    /**
2752
     * Hardware accelerated codec capabilities.
2753
     * see FF_HWACCEL_CODEC_CAP_*
2754
     */
2755
    int capabilities;
2756

    
2757
    struct AVHWAccel *next;
2758

    
2759
    /**
2760
     * Called at the beginning of each frame or field picture.
2761
     *
2762
     * Meaningful frame information (codec specific) is guaranteed to
2763
     * be parsed at this point. This function is mandatory.
2764
     *
2765
     * Note that buf can be NULL along with buf_size set to 0.
2766
     * Otherwise, this means the whole frame is available at this point.
2767
     *
2768
     * @param avctx the codec context
2769
     * @param buf the frame data buffer base
2770
     * @param buf_size the size of the frame in bytes
2771
     * @return zero if successful, a negative value otherwise
2772
     */
2773
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2774

    
2775
    /**
2776
     * Callback for each slice.
2777
     *
2778
     * Meaningful slice information (codec specific) is guaranteed to
2779
     * be parsed at this point. This function is mandatory.
2780
     *
2781
     * @param avctx the codec context
2782
     * @param buf the slice data buffer base
2783
     * @param buf_size the size of the slice in bytes
2784
     * @return zero if successful, a negative value otherwise
2785
     */
2786
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2787

    
2788
    /**
2789
     * Called at the end of each frame or field picture.
2790
     *
2791
     * The whole picture is parsed at this point and can now be sent
2792
     * to the hardware accelerator. This function is mandatory.
2793
     *
2794
     * @param avctx the codec context
2795
     * @return zero if successful, a negative value otherwise
2796
     */
2797
    int (*end_frame)(AVCodecContext *avctx);
2798

    
2799
    /**
2800
     * Size of HW accelerator private data.
2801
     *
2802
     * Private data is allocated with av_mallocz() before
2803
     * AVCodecContext.get_buffer() and deallocated after
2804
     * AVCodecContext.release_buffer().
2805
     */
2806
    int priv_data_size;
2807
} AVHWAccel;
2808

    
2809
/**
2810
 * four components are given, that's all.
2811
 * the last component is alpha
2812
 */
2813
typedef struct AVPicture {
2814
    uint8_t *data[4];
2815
    int linesize[4];       ///< number of bytes per line
2816
} AVPicture;
2817

    
2818
#if LIBAVCODEC_VERSION_MAJOR < 53
2819
/**
2820
 * AVPaletteControl
2821
 * This structure defines a method for communicating palette changes
2822
 * between and demuxer and a decoder.
2823
 *
2824
 * @deprecated Use AVPacket to send palette changes instead.
2825
 * This is totally broken.
2826
 */
2827
#define AVPALETTE_SIZE 1024
2828
#define AVPALETTE_COUNT 256
2829
typedef struct AVPaletteControl {
2830

    
2831
    /* Demuxer sets this to 1 to indicate the palette has changed;
2832
     * decoder resets to 0. */
2833
    int palette_changed;
2834

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

    
2841
} AVPaletteControl attribute_deprecated;
2842
#endif
2843

    
2844
enum AVSubtitleType {
2845
    SUBTITLE_NONE,
2846

    
2847
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2848

    
2849
    /**
2850
     * Plain text, the text field must be set by the decoder and is
2851
     * authoritative. ass and pict fields may contain approximations.
2852
     */
2853
    SUBTITLE_TEXT,
2854

    
2855
    /**
2856
     * Formatted text, the ass field must be set by the decoder and is
2857
     * authoritative. pict and text fields may contain approximations.
2858
     */
2859
    SUBTITLE_ASS,
2860
};
2861

    
2862
typedef struct AVSubtitleRect {
2863
    int x;         ///< top left corner  of pict, undefined when pict is not set
2864
    int y;         ///< top left corner  of pict, undefined when pict is not set
2865
    int w;         ///< width            of pict, undefined when pict is not set
2866
    int h;         ///< height           of pict, undefined when pict is not set
2867
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2868

    
2869
    /**
2870
     * data+linesize for the bitmap of this subtitle.
2871
     * can be set for text/ass as well once they where rendered
2872
     */
2873
    AVPicture pict;
2874
    enum AVSubtitleType type;
2875

    
2876
    char *text;                     ///< 0 terminated plain UTF-8 text
2877

    
2878
    /**
2879
     * 0 terminated ASS/SSA compatible event line.
2880
     * The pressentation of this is unaffected by the other values in this
2881
     * struct.
2882
     */
2883
    char *ass;
2884
} AVSubtitleRect;
2885

    
2886
typedef struct AVSubtitle {
2887
    uint16_t format; /* 0 = graphics */
2888
    uint32_t start_display_time; /* relative to packet pts, in ms */
2889
    uint32_t end_display_time; /* relative to packet pts, in ms */
2890
    unsigned num_rects;
2891
    AVSubtitleRect **rects;
2892
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2893
} AVSubtitle;
2894

    
2895
/* packet functions */
2896

    
2897
/**
2898
 * @deprecated use NULL instead
2899
 */
2900
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2901

    
2902
/**
2903
 * Default packet destructor.
2904
 */
2905
void av_destruct_packet(AVPacket *pkt);
2906

    
2907
/**
2908
 * Initialize optional fields of a packet with default values.
2909
 *
2910
 * @param pkt packet
2911
 */
2912
void av_init_packet(AVPacket *pkt);
2913

    
2914
/**
2915
 * Allocate the payload of a packet and initialize its fields with
2916
 * default values.
2917
 *
2918
 * @param pkt packet
2919
 * @param size wanted payload size
2920
 * @return 0 if OK, AVERROR_xxx otherwise
2921
 */
2922
int av_new_packet(AVPacket *pkt, int size);
2923

    
2924
/**
2925
 * Reduce packet size, correctly zeroing padding
2926
 *
2927
 * @param pkt packet
2928
 * @param size new size
2929
 */
2930
void av_shrink_packet(AVPacket *pkt, int size);
2931

    
2932
/**
2933
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2934
 * packet is allocated if it was not really allocated.
2935
 */
2936
int av_dup_packet(AVPacket *pkt);
2937

    
2938
/**
2939
 * Free a packet.
2940
 *
2941
 * @param pkt packet to free
2942
 */
2943
void av_free_packet(AVPacket *pkt);
2944

    
2945
/* resample.c */
2946

    
2947
struct ReSampleContext;
2948
struct AVResampleContext;
2949

    
2950
typedef struct ReSampleContext ReSampleContext;
2951

    
2952
#if LIBAVCODEC_VERSION_MAJOR < 53
2953
/**
2954
 * @deprecated Use av_audio_resample_init() instead.
2955
 */
2956
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2957
                                                          int output_rate, int input_rate);
2958
#endif
2959
/**
2960
 *  Initialize audio resampling context
2961
 *
2962
 * @param output_channels  number of output channels
2963
 * @param input_channels   number of input channels
2964
 * @param output_rate      output sample rate
2965
 * @param input_rate       input sample rate
2966
 * @param sample_fmt_out   requested output sample format
2967
 * @param sample_fmt_in    input sample format
2968
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2969
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2970
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2971
                           between the 2 closest, if 0 the closest will be used
2972
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2973
 * @return allocated ReSampleContext, NULL if error occured
2974
 */
2975
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2976
                                        int output_rate, int input_rate,
2977
                                        enum SampleFormat sample_fmt_out,
2978
                                        enum SampleFormat sample_fmt_in,
2979
                                        int filter_length, int log2_phase_count,
2980
                                        int linear, double cutoff);
2981

    
2982
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2983
void audio_resample_close(ReSampleContext *s);
2984

    
2985

    
2986
/**
2987
 * Initialize an audio resampler.
2988
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2989
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2990
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2991
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2992
                 between the 2 closest, if 0 the closest will be used
2993
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2994
 */
2995
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2996

    
2997
/**
2998
 * Resample an array of samples using a previously configured context.
2999
 * @param src an array of unconsumed samples
3000
 * @param consumed the number of samples of src which have been consumed are returned here
3001
 * @param src_size the number of unconsumed samples available
3002
 * @param dst_size the amount of space in samples available in dst
3003
 * @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.
3004
 * @return the number of samples written in dst or -1 if an error occurred
3005
 */
3006
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3007

    
3008

    
3009
/**
3010
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3011
 * the resampler parameters, so no audible clicks or similar distortions occur
3012
 * @param compensation_distance distance in output samples over which the compensation should be performed
3013
 * @param sample_delta number of output samples which should be output less
3014
 *
3015
 * example: av_resample_compensate(c, 10, 500)
3016
 * here instead of 510 samples only 500 samples would be output
3017
 *
3018
 * note, due to rounding the actual compensation might be slightly different,
3019
 * especially if the compensation_distance is large and the in_rate used during init is small
3020
 */
3021
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3022
void av_resample_close(struct AVResampleContext *c);
3023

    
3024
/**
3025
 * Allocate memory for a picture.  Call avpicture_free to free it.
3026
 *
3027
 * @param picture the picture to be filled in
3028
 * @param pix_fmt the format of the picture
3029
 * @param width the width of the picture
3030
 * @param height the height of the picture
3031
 * @return zero if successful, a negative value if not
3032
 */
3033
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3034

    
3035
/**
3036
 * Free a picture previously allocated by avpicture_alloc().
3037
 *
3038
 * @param picture the AVPicture to be freed
3039
 */
3040
void avpicture_free(AVPicture *picture);
3041

    
3042
/**
3043
 * Fill in the AVPicture fields.
3044
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3045
 * which points to the image data buffer. Depending on the specified picture
3046
 * format, one or multiple image data pointers and line sizes will be set.
3047
 * If a planar format is specified, several pointers will be set pointing to
3048
 * the different picture planes and the line sizes of the different planes
3049
 * will be stored in the lines_sizes array.
3050
 * Call with ptr == NULL to get the required size for the ptr buffer.
3051
 *
3052
 * @param picture AVPicture whose fields are to be filled in
3053
 * @param ptr Buffer which will contain or contains the actual image data
3054
 * @param pix_fmt The format in which the picture data is stored.
3055
 * @param width the width of the image in pixels
3056
 * @param height the height of the image in pixels
3057
 * @return size of the image data in bytes
3058
 */
3059
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3060
                   enum PixelFormat pix_fmt, int width, int height);
3061
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3062
                     unsigned char *dest, int dest_size);
3063

    
3064
/**
3065
 * Calculate the size in bytes that a picture of the given width and height
3066
 * would occupy if stored in the given picture format.
3067
 * Note that this returns the size of a compact representation as generated
3068
 * by avpicture_layout, which can be smaller than the size required for e.g.
3069
 * avpicture_fill.
3070
 *
3071
 * @param pix_fmt the given picture format
3072
 * @param width the width of the image
3073
 * @param height the height of the image
3074
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3075
 */
3076
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3077
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3078
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3079
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3080

    
3081
#if LIBAVCODEC_VERSION_MAJOR < 53
3082
/**
3083
 * Return the pixel format corresponding to the name name.
3084
 *
3085
 * If there is no pixel format with name name, then look for a
3086
 * pixel format with the name corresponding to the native endian
3087
 * format of name.
3088
 * For example in a little-endian system, first look for "gray16",
3089
 * then for "gray16le".
3090
 *
3091
 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3092
 *
3093
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3094
 */
3095
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3096
#endif
3097

    
3098
/**
3099
 * Return a value representing the fourCC code associated to the
3100
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3101
 * found.
3102
 */
3103
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3104

    
3105
/**
3106
 * Put a string representing the codec tag codec_tag in buf.
3107
 *
3108
 * @param buf_size size in bytes of buf
3109
 * @return the length of the string that would have been generated if
3110
 * enough space had been available, excluding the trailing null
3111
 */
3112
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3113

    
3114
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3115
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3116
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3117
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3118
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3119
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3120

    
3121
/**
3122
 * Compute what kind of losses will occur when converting from one specific
3123
 * pixel format to another.
3124
 * When converting from one pixel format to another, information loss may occur.
3125
 * For example, when converting from RGB24 to GRAY, the color information will
3126
 * be lost. Similarly, other losses occur when converting from some formats to
3127
 * other formats. These losses can involve loss of chroma, but also loss of
3128
 * resolution, loss of color depth, loss due to the color space conversion, loss
3129
 * of the alpha bits or loss due to color quantization.
3130
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3131
 * which will occur when converting from one pixel format to another.
3132
 *
3133
 * @param[in] dst_pix_fmt destination pixel format
3134
 * @param[in] src_pix_fmt source pixel format
3135
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3136
 * @return Combination of flags informing you what kind of losses will occur.
3137
 */
3138
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3139
                             int has_alpha);
3140

    
3141
/**
3142
 * Find the best pixel format to convert to given a certain source pixel
3143
 * format.  When converting from one pixel format to another, information loss
3144
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3145
 * information will be lost. Similarly, other losses occur when converting from
3146
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3147
 * the given pixel formats should be used to suffer the least amount of loss.
3148
 * The pixel formats from which it chooses one, are determined by the
3149
 * pix_fmt_mask parameter.
3150
 *
3151
 * @code
3152
 * src_pix_fmt = PIX_FMT_YUV420P;
3153
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3154
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3155
 * @endcode
3156
 *
3157
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3158
 * @param[in] src_pix_fmt source pixel format
3159
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3160
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3161
 * @return The best pixel format to convert to or -1 if none was found.
3162
 */
3163
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3164
                              int has_alpha, int *loss_ptr);
3165

    
3166

    
3167
/**
3168
 * Print in buf the string corresponding to the pixel format with
3169
 * number pix_fmt, or an header if pix_fmt is negative.
3170
 *
3171
 * @param[in] buf the buffer where to write the string
3172
 * @param[in] buf_size the size of buf
3173
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3174
 * a negative value to print the corresponding header.
3175
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3176
 */
3177
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3178

    
3179
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3180
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3181

    
3182
/**
3183
 * Tell if an image really has transparent alpha values.
3184
 * @return ored mask of FF_ALPHA_xxx constants
3185
 */
3186
int img_get_alpha_info(const AVPicture *src,
3187
                       enum PixelFormat pix_fmt, int width, int height);
3188

    
3189
/* deinterlace a picture */
3190
/* deinterlace - if not supported return -1 */
3191
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3192
                          enum PixelFormat pix_fmt, int width, int height);
3193

    
3194
/* external high level API */
3195

    
3196
/**
3197
 * If c is NULL, returns the first registered codec,
3198
 * if c is non-NULL, returns the next registered codec after c,
3199
 * or NULL if c is the last one.
3200
 */
3201
AVCodec *av_codec_next(AVCodec *c);
3202

    
3203
/**
3204
 * Return the LIBAVCODEC_VERSION_INT constant.
3205
 */
3206
unsigned avcodec_version(void);
3207

    
3208
/**
3209
 * Return the libavcodec build-time configuration.
3210
 */
3211
const char *avcodec_configuration(void);
3212

    
3213
/**
3214
 * Return the libavcodec license.
3215
 */
3216
const char *avcodec_license(void);
3217

    
3218
/**
3219
 * Initialize libavcodec.
3220
 *
3221
 * @warning This function must be called before any other libavcodec
3222
 * function.
3223
 */
3224
void avcodec_init(void);
3225

    
3226
#if LIBAVCODEC_VERSION_MAJOR < 53
3227
/**
3228
 * @deprecated Deprecated in favor of avcodec_register().
3229
 */
3230
attribute_deprecated void register_avcodec(AVCodec *codec);
3231
#endif
3232

    
3233
/**
3234
 * Register the codec codec and initialize libavcodec.
3235
 *
3236
 * @see avcodec_init()
3237
 */
3238
void avcodec_register(AVCodec *codec);
3239

    
3240
/**
3241
 * Find a registered encoder with a matching codec ID.
3242
 *
3243
 * @param id CodecID of the requested encoder
3244
 * @return An encoder if one was found, NULL otherwise.
3245
 */
3246
AVCodec *avcodec_find_encoder(enum CodecID id);
3247

    
3248
/**
3249
 * Find a registered encoder with the specified name.
3250
 *
3251
 * @param name name of the requested encoder
3252
 * @return An encoder if one was found, NULL otherwise.
3253
 */
3254
AVCodec *avcodec_find_encoder_by_name(const char *name);
3255

    
3256
/**
3257
 * Find a registered decoder with a matching codec ID.
3258
 *
3259
 * @param id CodecID of the requested decoder
3260
 * @return A decoder if one was found, NULL otherwise.
3261
 */
3262
AVCodec *avcodec_find_decoder(enum CodecID id);
3263

    
3264
/**
3265
 * Find a registered decoder with the specified name.
3266
 *
3267
 * @param name name of the requested decoder
3268
 * @return A decoder if one was found, NULL otherwise.
3269
 */
3270
AVCodec *avcodec_find_decoder_by_name(const char *name);
3271
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3272

    
3273
/**
3274
 * Set the fields of the given AVCodecContext to default values.
3275
 *
3276
 * @param s The AVCodecContext of which the fields should be set to default values.
3277
 */
3278
void avcodec_get_context_defaults(AVCodecContext *s);
3279

    
3280
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3281
 *  we WILL change its arguments and name a few times! */
3282
void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3283

    
3284
/**
3285
 * Allocate an AVCodecContext and set its fields to default values.  The
3286
 * resulting struct can be deallocated by simply calling av_free().
3287
 *
3288
 * @return An AVCodecContext filled with default values or NULL on failure.
3289
 * @see avcodec_get_context_defaults
3290
 */
3291
AVCodecContext *avcodec_alloc_context(void);
3292

    
3293
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3294
 *  we WILL change its arguments and name a few times! */
3295
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3296

    
3297
/**
3298
 * Copy the settings of the source AVCodecContext into the destination
3299
 * AVCodecContext. The resulting destination codec context will be
3300
 * unopened, i.e. you are required to call avcodec_open() before you
3301
 * can use this AVCodecContext to decode/encode video/audio data.
3302
 *
3303
 * @param dest target codec context, should be initialized with
3304
 *             avcodec_alloc_context(), but otherwise uninitialized
3305
 * @param src source codec context
3306
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3307
 */
3308
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3309

    
3310
/**
3311
 * Set the fields of the given AVFrame to default values.
3312
 *
3313
 * @param pic The AVFrame of which the fields should be set to default values.
3314
 */
3315
void avcodec_get_frame_defaults(AVFrame *pic);
3316

    
3317
/**
3318
 * Allocate an AVFrame and set its fields to default values.  The resulting
3319
 * struct can be deallocated by simply calling av_free().
3320
 *
3321
 * @return An AVFrame filled with default values or NULL on failure.
3322
 * @see avcodec_get_frame_defaults
3323
 */
3324
AVFrame *avcodec_alloc_frame(void);
3325

    
3326
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3327
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3328
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3329

    
3330
/**
3331
 * Return the amount of padding in pixels which the get_buffer callback must
3332
 * provide around the edge of the image for codecs which do not have the
3333
 * CODEC_FLAG_EMU_EDGE flag.
3334
 *
3335
 * @return Required padding in pixels.
3336
 */
3337
unsigned avcodec_get_edge_width(void);
3338
/**
3339
 * Modify width and height values so that they will result in a memory
3340
 * buffer that is acceptable for the codec if you do not use any horizontal
3341
 * padding.
3342
 *
3343
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3344
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3345
 * according to avcodec_get_edge_width() before.
3346
 */
3347
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3348
/**
3349
 * Modify width and height values so that they will result in a memory
3350
 * buffer that is acceptable for the codec if you also ensure that all
3351
 * line sizes are a multiple of the respective linesize_align[i].
3352
 *
3353
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3354
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3355
 * according to avcodec_get_edge_width() before.
3356
 */
3357
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3358
                               int linesize_align[4]);
3359

    
3360
/**
3361
 * Check if the given dimension of a picture is valid, meaning that all
3362
 * bytes of the picture can be addressed with a signed int.
3363
 *
3364
 * @param[in] w Width of the picture.
3365
 * @param[in] h Height of the picture.
3366
 * @return Zero if valid, a negative value if invalid.
3367
 */
3368
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3369
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3370

    
3371
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3372
void avcodec_thread_free(AVCodecContext *s);
3373
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3374
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3375
//FIXME func typedef
3376

    
3377
/**
3378
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3379
 * function the context has to be allocated.
3380
 *
3381
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3382
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3383
 * retrieving a codec.
3384
 *
3385
 * @warning This function is not thread safe!
3386
 *
3387
 * @code
3388
 * avcodec_register_all();
3389
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3390
 * if (!codec)
3391
 *     exit(1);
3392
 *
3393
 * context = avcodec_alloc_context();
3394
 *
3395
 * if (avcodec_open(context, codec) < 0)
3396
 *     exit(1);
3397
 * @endcode
3398
 *
3399
 * @param avctx The context which will be set up to use the given codec.
3400
 * @param codec The codec to use within the context.
3401
 * @return zero on success, a negative value on error
3402
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3403
 */
3404
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3405

    
3406
#if LIBAVCODEC_VERSION_MAJOR < 53
3407
/**
3408
 * Decode an audio frame from buf into samples.
3409
 * Wrapper function which calls avcodec_decode_audio3.
3410
 *
3411
 * @deprecated Use avcodec_decode_audio3 instead.
3412
 * @param avctx the codec context
3413
 * @param[out] samples the output buffer
3414
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3415
 * @param[in] buf the input buffer
3416
 * @param[in] buf_size the input buffer size in bytes
3417
 * @return On error a negative value is returned, otherwise the number of bytes
3418
 * used or zero if no frame could be decompressed.
3419
 */
3420
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3421
                         int *frame_size_ptr,
3422
                         const uint8_t *buf, int buf_size);
3423
#endif
3424

    
3425
/**
3426
 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3427
 * Some decoders may support multiple frames in a single AVPacket, such
3428
 * decoders would then just decode the first frame. In this case,
3429
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3430
 * the remaining data in order to decode the second frame etc.
3431
 * If no frame
3432
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3433
 * decompressed frame size in bytes.
3434
 *
3435
 * @warning You must set frame_size_ptr to the allocated size of the
3436
 * output buffer before calling avcodec_decode_audio3().
3437
 *
3438
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3439
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3440
 * bits at once and could read over the end.
3441
 *
3442
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3443
 * no overreading happens for damaged MPEG streams.
3444
 *
3445
 * @note You might have to align the input buffer avpkt->data and output buffer
3446
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3447
 * necessary at all, on others it won't work at all if not aligned and on others
3448
 * it will work but it will have an impact on performance.
3449
 *
3450
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3451
 * samples should be 16 byte aligned unless the CPU doesn't need it
3452
 * (AltiVec and SSE do).
3453
 *
3454
 * @param avctx the codec context
3455
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3456
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3457
 * @param[in] avpkt The input AVPacket containing the input buffer.
3458
 *            You can create such packet with av_init_packet() and by then setting
3459
 *            data and size, some decoders might in addition need other fields.
3460
 *            All decoders are designed to use the least fields possible though.
3461
 * @return On error a negative value is returned, otherwise the number of bytes
3462
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3463
 */
3464
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3465
                         int *frame_size_ptr,
3466
                         AVPacket *avpkt);
3467

    
3468
#if LIBAVCODEC_VERSION_MAJOR < 53
3469
/**
3470
 * Decode a video frame from buf into picture.
3471
 * Wrapper function which calls avcodec_decode_video2.
3472
 *
3473
 * @deprecated Use avcodec_decode_video2 instead.
3474
 * @param avctx the codec context
3475
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3476
 * @param[in] buf the input buffer
3477
 * @param[in] buf_size the size of the input buffer in bytes
3478
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3479
 * @return On error a negative value is returned, otherwise the number of bytes
3480
 * used or zero if no frame could be decompressed.
3481
 */
3482
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3483
                         int *got_picture_ptr,
3484
                         const uint8_t *buf, int buf_size);
3485
#endif
3486

    
3487
/**
3488
 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3489
 * Some decoders may support multiple frames in a single AVPacket, such
3490
 * decoders would then just decode the first frame.
3491
 *
3492
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3493
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3494
 * bits at once and could read over the end.
3495
 *
3496
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3497
 * no overreading happens for damaged MPEG streams.
3498
 *
3499
 * @note You might have to align the input buffer avpkt->data.
3500
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3501
 * necessary at all, on others it won't work at all if not aligned and on others
3502
 * it will work but it will have an impact on performance.
3503
 *
3504
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3505
 *
3506
 * @note Some codecs have a delay between input and output, these need to be
3507
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3508
 *
3509
 * @param avctx the codec context
3510
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3511
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3512
 *             allocate memory for the actual bitmap.
3513
 *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3514
 *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3515
 *                   decodes and the decoder tells the user once it does not need the data anymore,
3516
 *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3517
 *
3518
 * @param[in] avpkt The input AVpacket containing the input buffer.
3519
 *            You can create such packet with av_init_packet() and by then setting
3520
 *            data and size, some decoders might in addition need other fields like
3521
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3522
 *            fields possible.
3523
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3524
 * @return On error a negative value is returned, otherwise the number of bytes
3525
 * used or zero if no frame could be decompressed.
3526
 */
3527
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3528
                         int *got_picture_ptr,
3529
                         AVPacket *avpkt);
3530

    
3531
#if LIBAVCODEC_VERSION_MAJOR < 53
3532
/* Decode a subtitle message. Return -1 if error, otherwise return the
3533
 * number of bytes used. If no subtitle could be decompressed,
3534
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3535
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3536
                            int *got_sub_ptr,
3537
                            const uint8_t *buf, int buf_size);
3538
#endif
3539

    
3540
/**
3541
 * Decode a subtitle message.
3542
 * Return a negative value on error, otherwise return the number of bytes used.
3543
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3544
 * Otherwise, the subtitle is stored in *sub.
3545
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3546
 * simplicity, because the performance difference is expect to be negligible
3547
 * and reusing a get_buffer written for video codecs would probably perform badly
3548
 * due to a potentially very different allocation pattern.
3549
 *
3550
 * @param avctx the codec context
3551
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3552
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3553
 * @param[in] avpkt The input AVPacket containing the input buffer.
3554
 */
3555
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3556
                            int *got_sub_ptr,
3557
                            AVPacket *avpkt);
3558
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3559
                        int *data_size_ptr,
3560
                        uint8_t *buf, int buf_size);
3561

    
3562
/**
3563
 * Encode an audio frame from samples into buf.
3564
 *
3565
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3566
 * However, for PCM audio the user will know how much space is needed
3567
 * because it depends on the value passed in buf_size as described
3568
 * below. In that case a lower value can be used.
3569
 *
3570
 * @param avctx the codec context
3571
 * @param[out] buf the output buffer
3572
 * @param[in] buf_size the output buffer size
3573
 * @param[in] samples the input buffer containing the samples
3574
 * The number of samples read from this buffer is frame_size*channels,
3575
 * both of which are defined in avctx.
3576
 * For PCM audio the number of samples read from samples is equal to
3577
 * buf_size * input_sample_size / output_sample_size.
3578
 * @return On error a negative value is returned, on success zero or the number
3579
 * of bytes used to encode the data read from the input buffer.
3580
 */
3581
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3582
                         const short *samples);
3583

    
3584
/**
3585
 * Encode a video frame from pict into buf.
3586
 * The input picture should be
3587
 * stored using a specific format, namely avctx.pix_fmt.
3588
 *
3589
 * @param avctx the codec context
3590
 * @param[out] buf the output buffer for the bitstream of encoded frame
3591
 * @param[in] buf_size the size of the output buffer in bytes
3592
 * @param[in] pict the input picture to encode
3593
 * @return On error a negative value is returned, on success zero or the number
3594
 * of bytes used from the output buffer.
3595
 */
3596
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3597
                         const AVFrame *pict);
3598
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3599
                            const AVSubtitle *sub);
3600

    
3601
int avcodec_close(AVCodecContext *avctx);
3602

    
3603
/**
3604
 * Register all the codecs, parsers and bitstream filters which were enabled at
3605
 * configuration time. If you do not call this function you can select exactly
3606
 * which formats you want to support, by using the individual registration
3607
 * functions.
3608
 *
3609
 * @see avcodec_register
3610
 * @see av_register_codec_parser
3611
 * @see av_register_bitstream_filter
3612
 */
3613
void avcodec_register_all(void);
3614

    
3615
/**
3616
 * Flush buffers, should be called when seeking or when switching to a different stream.
3617
 */
3618
void avcodec_flush_buffers(AVCodecContext *avctx);
3619

    
3620
void avcodec_default_free_buffers(AVCodecContext *s);
3621

    
3622
/* misc useful functions */
3623

    
3624
/**
3625
 * Return a single letter to describe the given picture type pict_type.
3626
 *
3627
 * @param[in] pict_type the picture type
3628
 * @return A single character representing the picture type.
3629
 */
3630
char av_get_pict_type_char(int pict_type);
3631

    
3632
/**
3633
 * Return codec bits per sample.
3634
 *
3635
 * @param[in] codec_id the codec
3636
 * @return Number of bits per sample or zero if unknown for the given codec.
3637
 */
3638
int av_get_bits_per_sample(enum CodecID codec_id);
3639

    
3640
/**
3641
 * Return sample format bits per sample.
3642
 *
3643
 * @param[in] sample_fmt the sample format
3644
 * @return Number of bits per sample or zero if unknown for the given sample format.
3645
 */
3646
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3647

    
3648
/* frame parsing */
3649
typedef struct AVCodecParserContext {
3650
    void *priv_data;
3651
    struct AVCodecParser *parser;
3652
    int64_t frame_offset; /* offset of the current frame */
3653
    int64_t cur_offset; /* current offset
3654
                           (incremented by each av_parser_parse()) */
3655
    int64_t next_frame_offset; /* offset of the next frame */
3656
    /* video info */
3657
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3658
    /**
3659
     * This field is used for proper frame duration computation in lavf.
3660
     * It signals, how much longer the frame duration of the current frame
3661
     * is compared to normal frame duration.
3662
     *
3663
     * frame_duration = (1 + repeat_pict) * time_base
3664
     *
3665
     * It is used by codecs like H.264 to display telecined material.
3666
     */
3667
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3668
    int64_t pts;     /* pts of the current frame */
3669
    int64_t dts;     /* dts of the current frame */
3670

    
3671
    /* private data */
3672
    int64_t last_pts;
3673
    int64_t last_dts;
3674
    int fetch_timestamp;
3675

    
3676
#define AV_PARSER_PTS_NB 4
3677
    int cur_frame_start_index;
3678
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3679
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3680
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3681

    
3682
    int flags;
3683
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3684
#define PARSER_FLAG_ONCE                      0x0002
3685

    
3686
    int64_t offset;      ///< byte offset from starting packet start
3687
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3688

    
3689
    /*!
3690
     * Set by parser to 1 for key frames and 0 for non-key frames.
3691
     * It is initialized to -1, so if the parser doesn't set this flag,
3692
     * old-style fallback using FF_I_TYPE picture type as key frames
3693
     * will be used.
3694
     */
3695
    int key_frame;
3696

    
3697
    /**
3698
     * Time difference in stream time base units from the pts of this
3699
     * packet to the point at which the output from the decoder has converged
3700
     * independent from the availability of previous frames. That is, the
3701
     * frames are virtually identical no matter if decoding started from
3702
     * the very first frame or from this keyframe.
3703
     * Is AV_NOPTS_VALUE if unknown.
3704
     * This field is not the display duration of the current frame.
3705
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3706
     * set.
3707
     *
3708
     * The purpose of this field is to allow seeking in streams that have no
3709
     * keyframes in the conventional sense. It corresponds to the
3710
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3711
     * essential for some types of subtitle streams to ensure that all
3712
     * subtitles are correctly displayed after seeking.
3713
     */
3714
    int64_t convergence_duration;
3715

    
3716
    // Timestamp generation support:
3717
    /**
3718
     * Synchronization point for start of timestamp generation.
3719
     *
3720
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3721
     * (default).
3722
     *
3723
     * For example, this corresponds to presence of H.264 buffering period
3724
     * SEI message.
3725
     */
3726
    int dts_sync_point;
3727

    
3728
    /**
3729
     * Offset of the current timestamp against last timestamp sync point in
3730
     * units of AVCodecContext.time_base.
3731
     *
3732
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3733
     * contain a valid timestamp offset.
3734
     *
3735
     * Note that the timestamp of sync point has usually a nonzero
3736
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3737
     * the next frame after timestamp sync point will be usually 1.
3738
     *
3739
     * For example, this corresponds to H.264 cpb_removal_delay.
3740
     */
3741
    int dts_ref_dts_delta;
3742

    
3743
    /**
3744
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3745
     *
3746
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3747
     * contain valid non-negative timestamp delta (presentation time of a frame
3748
     * must not lie in the past).
3749
     *
3750
     * This delay represents the difference between decoding and presentation
3751
     * time of the frame.
3752
     *
3753
     * For example, this corresponds to H.264 dpb_output_delay.
3754
     */
3755
    int pts_dts_delta;
3756

    
3757
    /**
3758
     * Position of the packet in file.
3759
     *
3760
     * Analogous to cur_frame_pts/dts
3761
     */
3762
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3763

    
3764
    /**
3765
     * Byte position of currently parsed frame in stream.
3766
     */
3767
    int64_t pos;
3768

    
3769
    /**
3770
     * Previous frame byte position.
3771
     */
3772
    int64_t last_pos;
3773
} AVCodecParserContext;
3774

    
3775
typedef struct AVCodecParser {
3776
    int codec_ids[5]; /* several codec IDs are permitted */
3777
    int priv_data_size;
3778
    int (*parser_init)(AVCodecParserContext *s);
3779
    int (*parser_parse)(AVCodecParserContext *s,
3780
                        AVCodecContext *avctx,
3781
                        const uint8_t **poutbuf, int *poutbuf_size,
3782
                        const uint8_t *buf, int buf_size);
3783
    void (*parser_close)(AVCodecParserContext *s);
3784
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3785
    struct AVCodecParser *next;
3786
} AVCodecParser;
3787

    
3788
AVCodecParser *av_parser_next(AVCodecParser *c);
3789

    
3790
void av_register_codec_parser(AVCodecParser *parser);
3791
AVCodecParserContext *av_parser_init(int codec_id);
3792

    
3793
#if LIBAVCODEC_VERSION_MAJOR < 53
3794
attribute_deprecated
3795
int av_parser_parse(AVCodecParserContext *s,
3796
                    AVCodecContext *avctx,
3797
                    uint8_t **poutbuf, int *poutbuf_size,
3798
                    const uint8_t *buf, int buf_size,
3799
                    int64_t pts, int64_t dts);
3800
#endif
3801

    
3802
/**
3803
 * Parse a packet.
3804
 *
3805
 * @param s             parser context.
3806
 * @param avctx         codec context.
3807
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3808
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3809
 * @param buf           input buffer.
3810
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3811
 * @param pts           input presentation timestamp.
3812
 * @param dts           input decoding timestamp.
3813
 * @param pos           input byte position in stream.
3814
 * @return the number of bytes of the input bitstream used.
3815
 *
3816
 * Example:
3817
 * @code
3818
 *   while(in_len){
3819
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3820
 *                                        in_data, in_len,
3821
 *                                        pts, dts, pos);
3822
 *       in_data += len;
3823
 *       in_len  -= len;
3824
 *
3825
 *       if(size)
3826
 *          decode_frame(data, size);
3827
 *   }
3828
 * @endcode
3829
 */
3830
int av_parser_parse2(AVCodecParserContext *s,
3831
                     AVCodecContext *avctx,
3832
                     uint8_t **poutbuf, int *poutbuf_size,
3833
                     const uint8_t *buf, int buf_size,
3834
                     int64_t pts, int64_t dts,
3835
                     int64_t pos);
3836

    
3837
int av_parser_change(AVCodecParserContext *s,
3838
                     AVCodecContext *avctx,
3839
                     uint8_t **poutbuf, int *poutbuf_size,
3840
                     const uint8_t *buf, int buf_size, int keyframe);
3841
void av_parser_close(AVCodecParserContext *s);
3842

    
3843

    
3844
typedef struct AVBitStreamFilterContext {
3845
    void *priv_data;
3846
    struct AVBitStreamFilter *filter;
3847
    AVCodecParserContext *parser;
3848
    struct AVBitStreamFilterContext *next;
3849
} AVBitStreamFilterContext;
3850

    
3851

    
3852
typedef struct AVBitStreamFilter {
3853
    const char *name;
3854
    int priv_data_size;
3855
    int (*filter)(AVBitStreamFilterContext *bsfc,
3856
                  AVCodecContext *avctx, const char *args,
3857
                  uint8_t **poutbuf, int *poutbuf_size,
3858
                  const uint8_t *buf, int buf_size, int keyframe);
3859
    void (*close)(AVBitStreamFilterContext *bsfc);
3860
    struct AVBitStreamFilter *next;
3861
} AVBitStreamFilter;
3862

    
3863
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3864
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3865
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3866
                               AVCodecContext *avctx, const char *args,
3867
                               uint8_t **poutbuf, int *poutbuf_size,
3868
                               const uint8_t *buf, int buf_size, int keyframe);
3869
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3870

    
3871
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3872

    
3873
/* memory */
3874

    
3875
/**
3876
 * Reallocate the given block if it is not large enough, otherwise do nothing.
3877
 *
3878
 * @see av_realloc
3879
 */
3880
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3881

    
3882
/**
3883
 * Allocate a buffer, reusing the given one if large enough.
3884
 *
3885
 * Contrary to av_fast_realloc the current buffer contents might not be
3886
 * preserved and on error the old buffer is freed, thus no special
3887
 * handling to avoid memleaks is necessary.
3888
 *
3889
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3890
 * @param size size of the buffer *ptr points to
3891
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3892
 *                 *size 0 if an error occurred.
3893
 */
3894
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3895

    
3896
/**
3897
 * Copy image 'src' to 'dst'.
3898
 */
3899
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3900
                     enum PixelFormat pix_fmt, int width, int height);
3901

    
3902
/**
3903
 * Crop image top and left side.
3904
 */
3905
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3906
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3907

    
3908
/**
3909
 * Pad image.
3910
 */
3911
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3912
            int padtop, int padbottom, int padleft, int padright, int *color);
3913

    
3914
/**
3915
 * Encode extradata length to a buffer. Used by xiph codecs.
3916
 *
3917
 * @param s buffer to write to; must be at least (v/255+1) bytes long
3918
 * @param v size of extradata in bytes
3919
 * @return number of bytes written to the buffer.
3920
 */
3921
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3922

    
3923
/**
3924
 * Parse str and put in width_ptr and height_ptr the detected values.
3925
 *
3926
 * @return 0 in case of a successful parsing, a negative value otherwise
3927
 * @param[in] str the string to parse: it has to be a string in the format
3928
 * width x height or a valid video frame size abbreviation.
3929
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3930
 * frame width value
3931
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3932
 * frame height value
3933
 */
3934
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3935

    
3936
/**
3937
 * Parse str and store the detected values in *frame_rate.
3938
 *
3939
 * @return 0 in case of a successful parsing, a negative value otherwise
3940
 * @param[in] str the string to parse: it has to be a string in the format
3941
 * frame_rate_num / frame_rate_den, a float number or a valid video rate abbreviation
3942
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3943
 * frame rate
3944
 */
3945
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3946

    
3947
/**
3948
 * Logs a generic warning message about a missing feature. This function is
3949
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3950
 * only, and would normally not be used by applications.
3951
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3952
 * a pointer to an AVClass struct
3953
 * @param[in] feature string containing the name of the missing feature
3954
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3955
 * If want_sample is non-zero, additional verbage will be added to the log
3956
 * message which tells the user how to report samples to the development
3957
 * mailing list.
3958
 */
3959
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3960

    
3961
/**
3962
 * Log a generic warning message asking for a sample. This function is
3963
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3964
 * only, and would normally not be used by applications.
3965
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3966
 * a pointer to an AVClass struct
3967
 * @param[in] msg string containing an optional message, or NULL if no message
3968
 */
3969
void av_log_ask_for_sample(void *avc, const char *msg);
3970

    
3971
/**
3972
 * Register the hardware accelerator hwaccel.
3973
 */
3974
void av_register_hwaccel(AVHWAccel *hwaccel);
3975

    
3976
/**
3977
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3978
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3979
 * after hwaccel, or NULL if hwaccel is the last one.
3980
 */
3981
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3982

    
3983

    
3984
/**
3985
 * Lock operation used by lockmgr
3986
 */
3987
enum AVLockOp {
3988
  AV_LOCK_CREATE,  ///< Create a mutex
3989
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3990
  AV_LOCK_RELEASE, ///< Unlock the mutex
3991
  AV_LOCK_DESTROY, ///< Free mutex resources
3992
};
3993

    
3994
/**
3995
 * Register a user provided lock manager supporting the operations
3996
 * specified by AVLockOp. mutex points to a (void *) where the
3997
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3998
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3999
 *
4000
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4001
 *           callback during the call to av_lockmgr_register().
4002
 *           Thus, the application must be prepared to handle that.
4003
 *           If cb is set to NULL the lockmgr will be unregistered.
4004
 *           Also note that during unregistration the previously registered
4005
 *           lockmgr callback may also be invoked.
4006
 */
4007
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4008

    
4009
#endif /* AVCODEC_AVCODEC_H */