Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 7160bb71

History | View | Annotate | Download (131 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
#include "libavutil/cpu.h"
32

    
33
#define LIBAVCODEC_VERSION_MAJOR 52
34
#define LIBAVCODEC_VERSION_MINOR 87
35
#define LIBAVCODEC_VERSION_MICRO  1
36

    
37
#define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
38
                                               LIBAVCODEC_VERSION_MINOR, \
39
                                               LIBAVCODEC_VERSION_MICRO)
40
#define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
41
                                           LIBAVCODEC_VERSION_MINOR,    \
42
                                           LIBAVCODEC_VERSION_MICRO)
43
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
44

    
45
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
46

    
47
/**
48
 * Those FF_API_* defines are not part of public API.
49
 * They may change, break or disappear at any time.
50
 */
51
#ifndef FF_API_PALETTE_CONTROL
52
#define FF_API_PALETTE_CONTROL  (LIBAVCODEC_VERSION_MAJOR < 54)
53
#endif
54
#define FF_API_MM_FLAGS         (LIBAVCODEC_VERSION_MAJOR < 53)
55

    
56
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
57
#define AV_TIME_BASE            1000000
58
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
59

    
60
/**
61
 * Identify the syntax and semantics of the bitstream.
62
 * The principle is roughly:
63
 * Two decoders with the same ID can decode the same streams.
64
 * Two encoders with the same ID can encode compatible streams.
65
 * There may be slight deviations from the principle due to implementation
66
 * details.
67
 *
68
 * If you add a codec ID to this list, add it so that
69
 * 1. no value of a existing codec ID changes (that would break ABI),
70
 * 2. it is as close as possible to similar codecs.
71
 */
72
enum CodecID {
73
    CODEC_ID_NONE,
74

    
75
    /* video codecs */
76
    CODEC_ID_MPEG1VIDEO,
77
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
78
    CODEC_ID_MPEG2VIDEO_XVMC,
79
    CODEC_ID_H261,
80
    CODEC_ID_H263,
81
    CODEC_ID_RV10,
82
    CODEC_ID_RV20,
83
    CODEC_ID_MJPEG,
84
    CODEC_ID_MJPEGB,
85
    CODEC_ID_LJPEG,
86
    CODEC_ID_SP5X,
87
    CODEC_ID_JPEGLS,
88
    CODEC_ID_MPEG4,
89
    CODEC_ID_RAWVIDEO,
90
    CODEC_ID_MSMPEG4V1,
91
    CODEC_ID_MSMPEG4V2,
92
    CODEC_ID_MSMPEG4V3,
93
    CODEC_ID_WMV1,
94
    CODEC_ID_WMV2,
95
    CODEC_ID_H263P,
96
    CODEC_ID_H263I,
97
    CODEC_ID_FLV1,
98
    CODEC_ID_SVQ1,
99
    CODEC_ID_SVQ3,
100
    CODEC_ID_DVVIDEO,
101
    CODEC_ID_HUFFYUV,
102
    CODEC_ID_CYUV,
103
    CODEC_ID_H264,
104
    CODEC_ID_INDEO3,
105
    CODEC_ID_VP3,
106
    CODEC_ID_THEORA,
107
    CODEC_ID_ASV1,
108
    CODEC_ID_ASV2,
109
    CODEC_ID_FFV1,
110
    CODEC_ID_4XM,
111
    CODEC_ID_VCR1,
112
    CODEC_ID_CLJR,
113
    CODEC_ID_MDEC,
114
    CODEC_ID_ROQ,
115
    CODEC_ID_INTERPLAY_VIDEO,
116
    CODEC_ID_XAN_WC3,
117
    CODEC_ID_XAN_WC4,
118
    CODEC_ID_RPZA,
119
    CODEC_ID_CINEPAK,
120
    CODEC_ID_WS_VQA,
121
    CODEC_ID_MSRLE,
122
    CODEC_ID_MSVIDEO1,
123
    CODEC_ID_IDCIN,
124
    CODEC_ID_8BPS,
125
    CODEC_ID_SMC,
126
    CODEC_ID_FLIC,
127
    CODEC_ID_TRUEMOTION1,
128
    CODEC_ID_VMDVIDEO,
129
    CODEC_ID_MSZH,
130
    CODEC_ID_ZLIB,
131
    CODEC_ID_QTRLE,
132
    CODEC_ID_SNOW,
133
    CODEC_ID_TSCC,
134
    CODEC_ID_ULTI,
135
    CODEC_ID_QDRAW,
136
    CODEC_ID_VIXL,
137
    CODEC_ID_QPEG,
138
#if LIBAVCODEC_VERSION_MAJOR < 53
139
    CODEC_ID_XVID,
140
#endif
141
    CODEC_ID_PNG,
142
    CODEC_ID_PPM,
143
    CODEC_ID_PBM,
144
    CODEC_ID_PGM,
145
    CODEC_ID_PGMYUV,
146
    CODEC_ID_PAM,
147
    CODEC_ID_FFVHUFF,
148
    CODEC_ID_RV30,
149
    CODEC_ID_RV40,
150
    CODEC_ID_VC1,
151
    CODEC_ID_WMV3,
152
    CODEC_ID_LOCO,
153
    CODEC_ID_WNV1,
154
    CODEC_ID_AASC,
155
    CODEC_ID_INDEO2,
156
    CODEC_ID_FRAPS,
157
    CODEC_ID_TRUEMOTION2,
158
    CODEC_ID_BMP,
159
    CODEC_ID_CSCD,
160
    CODEC_ID_MMVIDEO,
161
    CODEC_ID_ZMBV,
162
    CODEC_ID_AVS,
163
    CODEC_ID_SMACKVIDEO,
164
    CODEC_ID_NUV,
165
    CODEC_ID_KMVC,
166
    CODEC_ID_FLASHSV,
167
    CODEC_ID_CAVS,
168
    CODEC_ID_JPEG2000,
169
    CODEC_ID_VMNC,
170
    CODEC_ID_VP5,
171
    CODEC_ID_VP6,
172
    CODEC_ID_VP6F,
173
    CODEC_ID_TARGA,
174
    CODEC_ID_DSICINVIDEO,
175
    CODEC_ID_TIERTEXSEQVIDEO,
176
    CODEC_ID_TIFF,
177
    CODEC_ID_GIF,
178
    CODEC_ID_FFH264,
179
    CODEC_ID_DXA,
180
    CODEC_ID_DNXHD,
181
    CODEC_ID_THP,
182
    CODEC_ID_SGI,
183
    CODEC_ID_C93,
184
    CODEC_ID_BETHSOFTVID,
185
    CODEC_ID_PTX,
186
    CODEC_ID_TXD,
187
    CODEC_ID_VP6A,
188
    CODEC_ID_AMV,
189
    CODEC_ID_VB,
190
    CODEC_ID_PCX,
191
    CODEC_ID_SUNRAST,
192
    CODEC_ID_INDEO4,
193
    CODEC_ID_INDEO5,
194
    CODEC_ID_MIMIC,
195
    CODEC_ID_RL2,
196
    CODEC_ID_8SVX_EXP,
197
    CODEC_ID_8SVX_FIB,
198
    CODEC_ID_ESCAPE124,
199
    CODEC_ID_DIRAC,
200
    CODEC_ID_BFI,
201
    CODEC_ID_CMV,
202
    CODEC_ID_MOTIONPIXELS,
203
    CODEC_ID_TGV,
204
    CODEC_ID_TGQ,
205
    CODEC_ID_TQI,
206
    CODEC_ID_AURA,
207
    CODEC_ID_AURA2,
208
    CODEC_ID_V210X,
209
    CODEC_ID_TMV,
210
    CODEC_ID_V210,
211
    CODEC_ID_DPX,
212
    CODEC_ID_MAD,
213
    CODEC_ID_FRWU,
214
    CODEC_ID_FLASHSV2,
215
    CODEC_ID_CDGRAPHICS,
216
    CODEC_ID_R210,
217
    CODEC_ID_ANM,
218
    CODEC_ID_BINKVIDEO,
219
    CODEC_ID_IFF_ILBM,
220
    CODEC_ID_IFF_BYTERUN1,
221
    CODEC_ID_KGV1,
222
    CODEC_ID_YOP,
223
    CODEC_ID_VP8,
224
    CODEC_ID_PICTOR,
225
    CODEC_ID_ANSI,
226
    CODEC_ID_A64_MULTI,
227
    CODEC_ID_A64_MULTI5,
228

    
229
    /* various PCM "codecs" */
230
    CODEC_ID_PCM_S16LE= 0x10000,
231
    CODEC_ID_PCM_S16BE,
232
    CODEC_ID_PCM_U16LE,
233
    CODEC_ID_PCM_U16BE,
234
    CODEC_ID_PCM_S8,
235
    CODEC_ID_PCM_U8,
236
    CODEC_ID_PCM_MULAW,
237
    CODEC_ID_PCM_ALAW,
238
    CODEC_ID_PCM_S32LE,
239
    CODEC_ID_PCM_S32BE,
240
    CODEC_ID_PCM_U32LE,
241
    CODEC_ID_PCM_U32BE,
242
    CODEC_ID_PCM_S24LE,
243
    CODEC_ID_PCM_S24BE,
244
    CODEC_ID_PCM_U24LE,
245
    CODEC_ID_PCM_U24BE,
246
    CODEC_ID_PCM_S24DAUD,
247
    CODEC_ID_PCM_ZORK,
248
    CODEC_ID_PCM_S16LE_PLANAR,
249
    CODEC_ID_PCM_DVD,
250
    CODEC_ID_PCM_F32BE,
251
    CODEC_ID_PCM_F32LE,
252
    CODEC_ID_PCM_F64BE,
253
    CODEC_ID_PCM_F64LE,
254
    CODEC_ID_PCM_BLURAY,
255

    
256
    /* various ADPCM codecs */
257
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
258
    CODEC_ID_ADPCM_IMA_WAV,
259
    CODEC_ID_ADPCM_IMA_DK3,
260
    CODEC_ID_ADPCM_IMA_DK4,
261
    CODEC_ID_ADPCM_IMA_WS,
262
    CODEC_ID_ADPCM_IMA_SMJPEG,
263
    CODEC_ID_ADPCM_MS,
264
    CODEC_ID_ADPCM_4XM,
265
    CODEC_ID_ADPCM_XA,
266
    CODEC_ID_ADPCM_ADX,
267
    CODEC_ID_ADPCM_EA,
268
    CODEC_ID_ADPCM_G726,
269
    CODEC_ID_ADPCM_CT,
270
    CODEC_ID_ADPCM_SWF,
271
    CODEC_ID_ADPCM_YAMAHA,
272
    CODEC_ID_ADPCM_SBPRO_4,
273
    CODEC_ID_ADPCM_SBPRO_3,
274
    CODEC_ID_ADPCM_SBPRO_2,
275
    CODEC_ID_ADPCM_THP,
276
    CODEC_ID_ADPCM_IMA_AMV,
277
    CODEC_ID_ADPCM_EA_R1,
278
    CODEC_ID_ADPCM_EA_R3,
279
    CODEC_ID_ADPCM_EA_R2,
280
    CODEC_ID_ADPCM_IMA_EA_SEAD,
281
    CODEC_ID_ADPCM_IMA_EA_EACS,
282
    CODEC_ID_ADPCM_EA_XAS,
283
    CODEC_ID_ADPCM_EA_MAXIS_XA,
284
    CODEC_ID_ADPCM_IMA_ISS,
285

    
286
    /* AMR */
287
    CODEC_ID_AMR_NB= 0x12000,
288
    CODEC_ID_AMR_WB,
289

    
290
    /* RealAudio codecs*/
291
    CODEC_ID_RA_144= 0x13000,
292
    CODEC_ID_RA_288,
293

    
294
    /* various DPCM codecs */
295
    CODEC_ID_ROQ_DPCM= 0x14000,
296
    CODEC_ID_INTERPLAY_DPCM,
297
    CODEC_ID_XAN_DPCM,
298
    CODEC_ID_SOL_DPCM,
299

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

    
354
    /* subtitle codecs */
355
    CODEC_ID_DVD_SUBTITLE= 0x17000,
356
    CODEC_ID_DVB_SUBTITLE,
357
    CODEC_ID_TEXT,  ///< raw UTF-8 text
358
    CODEC_ID_XSUB,
359
    CODEC_ID_SSA,
360
    CODEC_ID_MOV_TEXT,
361
    CODEC_ID_HDMV_PGS_SUBTITLE,
362
    CODEC_ID_DVB_TELETEXT,
363
    CODEC_ID_SRT,
364

    
365
    /* other specific kind of codecs (generally used for attachments) */
366
    CODEC_ID_TTF= 0x18000,
367

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

    
370
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
371
                                * stream (only used by libavformat) */
372
};
373

    
374
#if LIBAVCODEC_VERSION_MAJOR < 53
375
#define CodecType AVMediaType
376

    
377
#define CODEC_TYPE_UNKNOWN    AVMEDIA_TYPE_UNKNOWN
378
#define CODEC_TYPE_VIDEO      AVMEDIA_TYPE_VIDEO
379
#define CODEC_TYPE_AUDIO      AVMEDIA_TYPE_AUDIO
380
#define CODEC_TYPE_DATA       AVMEDIA_TYPE_DATA
381
#define CODEC_TYPE_SUBTITLE   AVMEDIA_TYPE_SUBTITLE
382
#define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
383
#define CODEC_TYPE_NB         AVMEDIA_TYPE_NB
384
#endif
385

    
386
/**
387
 * all in native-endian format
388
 */
389
enum SampleFormat {
390
    SAMPLE_FMT_NONE = -1,
391
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
392
    SAMPLE_FMT_S16,             ///< signed 16 bits
393
    SAMPLE_FMT_S32,             ///< signed 32 bits
394
    SAMPLE_FMT_FLT,             ///< float
395
    SAMPLE_FMT_DBL,             ///< double
396
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
397
};
398

    
399
/* Audio channel masks */
400
#define CH_FRONT_LEFT             0x00000001
401
#define CH_FRONT_RIGHT            0x00000002
402
#define CH_FRONT_CENTER           0x00000004
403
#define CH_LOW_FREQUENCY          0x00000008
404
#define CH_BACK_LEFT              0x00000010
405
#define CH_BACK_RIGHT             0x00000020
406
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
407
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
408
#define CH_BACK_CENTER            0x00000100
409
#define CH_SIDE_LEFT              0x00000200
410
#define CH_SIDE_RIGHT             0x00000400
411
#define CH_TOP_CENTER             0x00000800
412
#define CH_TOP_FRONT_LEFT         0x00001000
413
#define CH_TOP_FRONT_CENTER       0x00002000
414
#define CH_TOP_FRONT_RIGHT        0x00004000
415
#define CH_TOP_BACK_LEFT          0x00008000
416
#define CH_TOP_BACK_CENTER        0x00010000
417
#define CH_TOP_BACK_RIGHT         0x00020000
418
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
419
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
420

    
421
/** Channel mask value used for AVCodecContext.request_channel_layout
422
    to indicate that the user requests the channel order of the decoder output
423
    to be the native codec channel order. */
424
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
425

    
426
/* Audio channel convenience macros */
427
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
428
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
429
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
430
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
431
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
432
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
433
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
434
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
435
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
436
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
437
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
438
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
439
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
440
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
441
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
442
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
443

    
444
/* in bytes */
445
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
446

    
447
/**
448
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
449
 * This is mainly needed because some optimized bitstream readers read
450
 * 32 or 64 bit at once and could read over the end.<br>
451
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
452
 * MPEG bitstreams could cause overread and segfault.
453
 */
454
#define FF_INPUT_BUFFER_PADDING_SIZE 8
455

    
456
/**
457
 * minimum encoding buffer size
458
 * Used to avoid some checks during header writing.
459
 */
460
#define FF_MIN_BUFFER_SIZE 16384
461

    
462

    
463
/**
464
 * motion estimation type.
465
 */
466
enum Motion_Est_ID {
467
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
468
    ME_FULL,
469
    ME_LOG,
470
    ME_PHODS,
471
    ME_EPZS,        ///< enhanced predictive zonal search
472
    ME_X1,          ///< reserved for experiments
473
    ME_HEX,         ///< hexagon based search
474
    ME_UMH,         ///< uneven multi-hexagon search
475
    ME_ITER,        ///< iterative search
476
    ME_TESA,        ///< transformed exhaustive search algorithm
477
};
478

    
479
enum AVDiscard{
480
    /* We leave some space between them for extensions (drop some
481
     * keyframes for intra-only or drop just some bidir frames). */
482
    AVDISCARD_NONE   =-16, ///< discard nothing
483
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
484
    AVDISCARD_NONREF =  8, ///< discard all non reference
485
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
486
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
487
    AVDISCARD_ALL    = 48, ///< discard all
488
};
489

    
490
enum AVColorPrimaries{
491
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
492
    AVCOL_PRI_UNSPECIFIED=2,
493
    AVCOL_PRI_BT470M     =4,
494
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
495
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
496
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
497
    AVCOL_PRI_FILM       =8,
498
    AVCOL_PRI_NB           , ///< Not part of ABI
499
};
500

    
501
enum AVColorTransferCharacteristic{
502
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
503
    AVCOL_TRC_UNSPECIFIED=2,
504
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
505
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
506
    AVCOL_TRC_NB           , ///< Not part of ABI
507
};
508

    
509
enum AVColorSpace{
510
    AVCOL_SPC_RGB        =0,
511
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
512
    AVCOL_SPC_UNSPECIFIED=2,
513
    AVCOL_SPC_FCC        =4,
514
    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
515
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
516
    AVCOL_SPC_SMPTE240M  =7,
517
    AVCOL_SPC_NB           , ///< Not part of ABI
518
};
519

    
520
enum AVColorRange{
521
    AVCOL_RANGE_UNSPECIFIED=0,
522
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
523
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
524
    AVCOL_RANGE_NB           , ///< Not part of ABI
525
};
526

    
527
/**
528
 *  X   X      3 4 X      X are luma samples,
529
 *             1 2        1-6 are possible chroma positions
530
 *  X   X      5 6 X      0 is undefined/unknown position
531
 */
532
enum AVChromaLocation{
533
    AVCHROMA_LOC_UNSPECIFIED=0,
534
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
535
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
536
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
537
    AVCHROMA_LOC_TOP        =4,
538
    AVCHROMA_LOC_BOTTOMLEFT =5,
539
    AVCHROMA_LOC_BOTTOM     =6,
540
    AVCHROMA_LOC_NB           , ///< Not part of ABI
541
};
542

    
543
/**
544
 * LPC analysis type
545
 */
546
enum AVLPCType {
547
    AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
548
    AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
549
    AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
550
    AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
551
    AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
552
    AV_LPC_TYPE_NB              , ///< Not part of ABI
553
};
554

    
555
typedef struct RcOverride{
556
    int start_frame;
557
    int end_frame;
558
    int qscale; // If this is 0 then quality_factor will be used instead.
559
    float quality_factor;
560
} RcOverride;
561

    
562
#define FF_MAX_B_FRAMES 16
563

    
564
/* encoding support
565
   These flags can be passed in AVCodecContext.flags before initialization.
566
   Note: Not everything is supported yet.
567
*/
568

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

    
630
/* Unsupported options :
631
 *              Syntax Arithmetic coding (SAC)
632
 *              Reference Picture Selection
633
 *              Independent Segment Decoding */
634
/* /Fx */
635
/* codec capabilities */
636

    
637
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
638
/**
639
 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
640
 * If not set, it might not use get_buffer() at all or use operations that
641
 * assume the buffer was allocated by avcodec_default_get_buffer.
642
 */
643
#define CODEC_CAP_DR1             0x0002
644
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
645
#define CODEC_CAP_PARSE_ONLY      0x0004
646
#define CODEC_CAP_TRUNCATED       0x0008
647
/* Codec can export data for HW decoding (XvMC). */
648
#define CODEC_CAP_HWACCEL         0x0010
649
/**
650
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
651
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
652
 */
653
#define CODEC_CAP_DELAY           0x0020
654
/**
655
 * Codec can be fed a final frame with a smaller size.
656
 * This can be used to prevent truncation of the last audio samples.
657
 */
658
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
659
/**
660
 * Codec can export data for HW decoding (VDPAU).
661
 */
662
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
663
/**
664
 * Codec can output multiple frames per AVPacket
665
 * Normally demuxers return one frame at a time, demuxers which do not do
666
 * are connected to a parser to split what they return into proper frames.
667
 * This flag is reserved to the very rare category of codecs which have a
668
 * bitstream that cannot be split into frames without timeconsuming
669
 * operations like full decoding. Demuxers carring such bitstreams thus
670
 * may return multiple frames in a packet. This has many disadvantages like
671
 * prohibiting stream copy in many cases thus it should only be considered
672
 * as a last resort.
673
 */
674
#define CODEC_CAP_SUBFRAMES        0x0100
675
/**
676
 * Codec is experimental and is thus avoided in favor of non experimental
677
 * encoders
678
 */
679
#define CODEC_CAP_EXPERIMENTAL     0x0200
680

    
681
//The following defines may change, don't expect compatibility if you use them.
682
#define MB_TYPE_INTRA4x4   0x0001
683
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
684
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
685
#define MB_TYPE_16x16      0x0008
686
#define MB_TYPE_16x8       0x0010
687
#define MB_TYPE_8x16       0x0020
688
#define MB_TYPE_8x8        0x0040
689
#define MB_TYPE_INTERLACED 0x0080
690
#define MB_TYPE_DIRECT2    0x0100 //FIXME
691
#define MB_TYPE_ACPRED     0x0200
692
#define MB_TYPE_GMC        0x0400
693
#define MB_TYPE_SKIP       0x0800
694
#define MB_TYPE_P0L0       0x1000
695
#define MB_TYPE_P1L0       0x2000
696
#define MB_TYPE_P0L1       0x4000
697
#define MB_TYPE_P1L1       0x8000
698
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
699
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
700
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
701
#define MB_TYPE_QUANT      0x00010000
702
#define MB_TYPE_CBP        0x00020000
703
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
704

    
705
/**
706
 * Pan Scan area.
707
 * This specifies the area which should be displayed.
708
 * Note there may be multiple such areas for one frame.
709
 */
710
typedef struct AVPanScan{
711
    /**
712
     * id
713
     * - encoding: Set by user.
714
     * - decoding: Set by libavcodec.
715
     */
716
    int id;
717

    
718
    /**
719
     * width and height in 1/16 pel
720
     * - encoding: Set by user.
721
     * - decoding: Set by libavcodec.
722
     */
723
    int width;
724
    int height;
725

    
726
    /**
727
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
728
     * - encoding: Set by user.
729
     * - decoding: Set by libavcodec.
730
     */
731
    int16_t position[3][2];
732
}AVPanScan;
733

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

    
961

    
962
#define FF_QSCALE_TYPE_MPEG1 0
963
#define FF_QSCALE_TYPE_MPEG2 1
964
#define FF_QSCALE_TYPE_H264  2
965
#define FF_QSCALE_TYPE_VP56  3
966

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

    
972

    
973
#define FF_I_TYPE  1 ///< Intra
974
#define FF_P_TYPE  2 ///< Predicted
975
#define FF_B_TYPE  3 ///< Bi-dir predicted
976
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
977
#define FF_SI_TYPE 5 ///< Switching Intra
978
#define FF_SP_TYPE 6 ///< Switching Predicted
979
#define FF_BI_TYPE 7
980

    
981
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
982
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
983
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
984
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
985

    
986
typedef struct AVPacket {
987
    /**
988
     * Presentation timestamp in AVStream->time_base units; the time at which
989
     * the decompressed packet will be presented to the user.
990
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
991
     * pts MUST be larger or equal to dts as presentation cannot happen before
992
     * decompression, unless one wants to view hex dumps. Some formats misuse
993
     * the terms dts and pts/cts to mean something different. Such timestamps
994
     * must be converted to true pts/dts before they are stored in AVPacket.
995
     */
996
    int64_t pts;
997
    /**
998
     * Decompression timestamp in AVStream->time_base units; the time at which
999
     * the packet is decompressed.
1000
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1001
     */
1002
    int64_t dts;
1003
    uint8_t *data;
1004
    int   size;
1005
    int   stream_index;
1006
    int   flags;
1007
    /**
1008
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
1009
     * Equals next_pts - this_pts in presentation order.
1010
     */
1011
    int   duration;
1012
    void  (*destruct)(struct AVPacket *);
1013
    void  *priv;
1014
    int64_t pos;                            ///< byte position in stream, -1 if unknown
1015

    
1016
    /**
1017
     * Time difference in AVStream->time_base units from the pts of this
1018
     * packet to the point at which the output from the decoder has converged
1019
     * independent from the availability of previous frames. That is, the
1020
     * frames are virtually identical no matter if decoding started from
1021
     * the very first frame or from this keyframe.
1022
     * Is AV_NOPTS_VALUE if unknown.
1023
     * This field is not the display duration of the current packet.
1024
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1025
     * set.
1026
     *
1027
     * The purpose of this field is to allow seeking in streams that have no
1028
     * keyframes in the conventional sense. It corresponds to the
1029
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1030
     * essential for some types of subtitle streams to ensure that all
1031
     * subtitles are correctly displayed after seeking.
1032
     */
1033
    int64_t convergence_duration;
1034
} AVPacket;
1035
#define AV_PKT_FLAG_KEY   0x0001
1036
#if LIBAVCODEC_VERSION_MAJOR < 53
1037
#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1038
#endif
1039

    
1040
/**
1041
 * Audio Video Frame.
1042
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1043
 * bumps.
1044
 * Removal, reordering and changes to existing fields require a major
1045
 * version bump. No fields should be added into AVFrame before or after
1046
 * FF_COMMON_FRAME!
1047
 * sizeof(AVFrame) must not be used outside libav*.
1048
 */
1049
typedef struct AVFrame {
1050
    FF_COMMON_FRAME
1051
} AVFrame;
1052

    
1053
/**
1054
 * main external API structure.
1055
 * New fields can be added to the end with minor version bumps.
1056
 * Removal, reordering and changes to existing fields require a major
1057
 * version bump.
1058
 * sizeof(AVCodecContext) must not be used outside libav*.
1059
 */
1060
typedef struct AVCodecContext {
1061
    /**
1062
     * information on struct for av_log
1063
     * - set by avcodec_alloc_context
1064
     */
1065
    const AVClass *av_class;
1066
    /**
1067
     * the average bitrate
1068
     * - encoding: Set by user; unused for constant quantizer encoding.
1069
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1070
     */
1071
    int bit_rate;
1072

    
1073
    /**
1074
     * number of bits the bitstream is allowed to diverge from the reference.
1075
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1076
     * - encoding: Set by user; unused for constant quantizer encoding.
1077
     * - decoding: unused
1078
     */
1079
    int bit_rate_tolerance;
1080

    
1081
    /**
1082
     * CODEC_FLAG_*.
1083
     * - encoding: Set by user.
1084
     * - decoding: Set by user.
1085
     */
1086
    int flags;
1087

    
1088
    /**
1089
     * Some codecs need additional format info. It is stored here.
1090
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1091
     * specific codec MUST set it correctly otherwise stream copy breaks.
1092
     * In general use of this field by muxers is not recommanded.
1093
     * - encoding: Set by libavcodec.
1094
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1095
     */
1096
    int sub_id;
1097

    
1098
    /**
1099
     * Motion estimation algorithm used for video coding.
1100
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1101
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1102
     * - encoding: MUST be set by user.
1103
     * - decoding: unused
1104
     */
1105
    int me_method;
1106

    
1107
    /**
1108
     * some codecs need / can use extradata like Huffman tables.
1109
     * mjpeg: Huffman tables
1110
     * rv10: additional flags
1111
     * mpeg4: global headers (they can be in the bitstream or here)
1112
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1113
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1114
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1115
     * - encoding: Set/allocated/freed by libavcodec.
1116
     * - decoding: Set/allocated/freed by user.
1117
     */
1118
    uint8_t *extradata;
1119
    int extradata_size;
1120

    
1121
    /**
1122
     * This is the fundamental unit of time (in seconds) in terms
1123
     * of which frame timestamps are represented. For fixed-fps content,
1124
     * timebase should be 1/framerate and timestamp increments should be
1125
     * identically 1.
1126
     * - encoding: MUST be set by user.
1127
     * - decoding: Set by libavcodec.
1128
     */
1129
    AVRational time_base;
1130

    
1131
    /* video only */
1132
    /**
1133
     * picture width / height.
1134
     * - encoding: MUST be set by user.
1135
     * - decoding: Set by libavcodec.
1136
     * Note: For compatibility it is possible to set this instead of
1137
     * coded_width/height before decoding.
1138
     */
1139
    int width, height;
1140

    
1141
#define FF_ASPECT_EXTENDED 15
1142

    
1143
    /**
1144
     * the number of pictures in a group of pictures, or 0 for intra_only
1145
     * - encoding: Set by user.
1146
     * - decoding: unused
1147
     */
1148
    int gop_size;
1149

    
1150
    /**
1151
     * Pixel format, see PIX_FMT_xxx.
1152
     * May be set by the demuxer if known from headers.
1153
     * May be overriden by the decoder if it knows better.
1154
     * - encoding: Set by user.
1155
     * - decoding: Set by user if known, overridden by libavcodec if known
1156
     */
1157
    enum PixelFormat pix_fmt;
1158

    
1159
    /**
1160
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1161
     * has to read frames at native frame rate.
1162
     * - encoding: Set by user.
1163
     * - decoding: unused
1164
     */
1165
    int rate_emu;
1166

    
1167
    /**
1168
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1169
     * decoder to draw a horizontal band. It improves cache usage. Not
1170
     * all codecs can do that. You must check the codec capabilities
1171
     * beforehand.
1172
     * The function is also used by hardware acceleration APIs.
1173
     * It is called at least once during frame decoding to pass
1174
     * the data needed for hardware render.
1175
     * In that mode instead of pixel data, AVFrame points to
1176
     * a structure specific to the acceleration API. The application
1177
     * reads the structure and can change some fields to indicate progress
1178
     * or mark state.
1179
     * - encoding: unused
1180
     * - decoding: Set by user.
1181
     * @param height the height of the slice
1182
     * @param y the y position of the slice
1183
     * @param type 1->top field, 2->bottom field, 3->frame
1184
     * @param offset offset into the AVFrame.data from which the slice should be read
1185
     */
1186
    void (*draw_horiz_band)(struct AVCodecContext *s,
1187
                            const AVFrame *src, int offset[4],
1188
                            int y, int type, int height);
1189

    
1190
    /* audio only */
1191
    int sample_rate; ///< samples per second
1192
    int channels;    ///< number of audio channels
1193

    
1194
    /**
1195
     * audio sample format
1196
     * - encoding: Set by user.
1197
     * - decoding: Set by libavcodec.
1198
     */
1199
    enum SampleFormat sample_fmt;  ///< sample format
1200

    
1201
    /* The following data should not be initialized. */
1202
    /**
1203
     * Samples per packet, initialized when calling 'init'.
1204
     */
1205
    int frame_size;
1206
    int frame_number;   ///< audio or video frame number
1207
#if LIBAVCODEC_VERSION_MAJOR < 53
1208
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1209
#endif
1210

    
1211
    /**
1212
     * Number of frames the decoded output will be delayed relative to
1213
     * the encoded input.
1214
     * - encoding: Set by libavcodec.
1215
     * - decoding: unused
1216
     */
1217
    int delay;
1218

    
1219
    /* - encoding parameters */
1220
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1221
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1222

    
1223
    /**
1224
     * minimum quantizer
1225
     * - encoding: Set by user.
1226
     * - decoding: unused
1227
     */
1228
    int qmin;
1229

    
1230
    /**
1231
     * maximum quantizer
1232
     * - encoding: Set by user.
1233
     * - decoding: unused
1234
     */
1235
    int qmax;
1236

    
1237
    /**
1238
     * maximum quantizer difference between frames
1239
     * - encoding: Set by user.
1240
     * - decoding: unused
1241
     */
1242
    int max_qdiff;
1243

    
1244
    /**
1245
     * maximum number of B-frames between non-B-frames
1246
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1247
     * - encoding: Set by user.
1248
     * - decoding: unused
1249
     */
1250
    int max_b_frames;
1251

    
1252
    /**
1253
     * qscale factor between IP and B-frames
1254
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1255
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1256
     * - encoding: Set by user.
1257
     * - decoding: unused
1258
     */
1259
    float b_quant_factor;
1260

    
1261
    /** obsolete FIXME remove */
1262
    int rc_strategy;
1263
#define FF_RC_STRATEGY_XVID 1
1264

    
1265
    int b_frame_strategy;
1266

    
1267
    /**
1268
     * hurry up amount
1269
     * - encoding: unused
1270
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1271
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1272
     */
1273
    int hurry_up;
1274

    
1275
    struct AVCodec *codec;
1276

    
1277
    void *priv_data;
1278

    
1279
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1280
                            /* do its best to deliver a chunk with size     */
1281
                            /* below rtp_payload_size, the chunk will start */
1282
                            /* with a start code on some codecs like H.263. */
1283
                            /* This doesn't take account of any particular  */
1284
                            /* headers inside the transmitted RTP payload.  */
1285

    
1286

    
1287
    /* The RTP callback: This function is called    */
1288
    /* every time the encoder has a packet to send. */
1289
    /* It depends on the encoder if the data starts */
1290
    /* with a Start Code (it should). H.263 does.   */
1291
    /* mb_nb contains the number of macroblocks     */
1292
    /* encoded in the RTP payload.                  */
1293
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1294

    
1295
    /* statistics, used for 2-pass encoding */
1296
    int mv_bits;
1297
    int header_bits;
1298
    int i_tex_bits;
1299
    int p_tex_bits;
1300
    int i_count;
1301
    int p_count;
1302
    int skip_count;
1303
    int misc_bits;
1304

    
1305
    /**
1306
     * number of bits used for the previously encoded frame
1307
     * - encoding: Set by libavcodec.
1308
     * - decoding: unused
1309
     */
1310
    int frame_bits;
1311

    
1312
    /**
1313
     * Private data of the user, can be used to carry app specific stuff.
1314
     * - encoding: Set by user.
1315
     * - decoding: Set by user.
1316
     */
1317
    void *opaque;
1318

    
1319
    char codec_name[32];
1320
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1321
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1322

    
1323
    /**
1324
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1325
     * This is used to work around some encoder bugs.
1326
     * A demuxer should set this to what is stored in the field used to identify the codec.
1327
     * If there are multiple such fields in a container then the demuxer should choose the one
1328
     * which maximizes the information about the used codec.
1329
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1330
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1331
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1332
     * first.
1333
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1334
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1335
     */
1336
    unsigned int codec_tag;
1337

    
1338
    /**
1339
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1340
     * - encoding: Set by user
1341
     * - decoding: Set by user
1342
     */
1343
    int workaround_bugs;
1344
#define FF_BUG_AUTODETECT       1  ///< autodetection
1345
#define FF_BUG_OLD_MSMPEG4      2
1346
#define FF_BUG_XVID_ILACE       4
1347
#define FF_BUG_UMP4             8
1348
#define FF_BUG_NO_PADDING       16
1349
#define FF_BUG_AMV              32
1350
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1351
#define FF_BUG_QPEL_CHROMA      64
1352
#define FF_BUG_STD_QPEL         128
1353
#define FF_BUG_QPEL_CHROMA2     256
1354
#define FF_BUG_DIRECT_BLOCKSIZE 512
1355
#define FF_BUG_EDGE             1024
1356
#define FF_BUG_HPEL_CHROMA      2048
1357
#define FF_BUG_DC_CLIP          4096
1358
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1359
#define FF_BUG_TRUNCATED       16384
1360
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1361

    
1362
    /**
1363
     * luma single coefficient elimination threshold
1364
     * - encoding: Set by user.
1365
     * - decoding: unused
1366
     */
1367
    int luma_elim_threshold;
1368

    
1369
    /**
1370
     * chroma single coeff elimination threshold
1371
     * - encoding: Set by user.
1372
     * - decoding: unused
1373
     */
1374
    int chroma_elim_threshold;
1375

    
1376
    /**
1377
     * strictly follow the standard (MPEG4, ...).
1378
     * - encoding: Set by user.
1379
     * - decoding: Set by user.
1380
     * Setting this to STRICT or higher means the encoder and decoder will
1381
     * generally do stupid things, whereas setting it to unofficial or lower
1382
     * will mean the encoder might produce output that is not supported by all
1383
     * spec-compliant decoders. Decoders don't differentiate between normal,
1384
     * unofficial and experimental (that is, they always try to decode things
1385
     * when they can) unless they are explicitly asked to behave stupidly
1386
     * (=strictly conform to the specs)
1387
     */
1388
    int strict_std_compliance;
1389
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1390
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1391
#define FF_COMPLIANCE_NORMAL        0
1392
#if LIBAVCODEC_VERSION_MAJOR < 53
1393
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1394
#endif
1395
#define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1396
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1397

    
1398
    /**
1399
     * qscale offset between IP and B-frames
1400
     * - encoding: Set by user.
1401
     * - decoding: unused
1402
     */
1403
    float b_quant_offset;
1404

    
1405
    /**
1406
     * Error recognization; higher values will detect more errors but may
1407
     * misdetect some more or less valid parts as errors.
1408
     * - encoding: unused
1409
     * - decoding: Set by user.
1410
     */
1411
    int error_recognition;
1412
#define FF_ER_CAREFUL         1
1413
#define FF_ER_COMPLIANT       2
1414
#define FF_ER_AGGRESSIVE      3
1415
#define FF_ER_VERY_AGGRESSIVE 4
1416

    
1417
    /**
1418
     * Called at the beginning of each frame to get a buffer for it.
1419
     * If pic.reference is set then the frame will be read later by libavcodec.
1420
     * avcodec_align_dimensions2() should be used to find the required width and
1421
     * height, as they normally need to be rounded up to the next multiple of 16.
1422
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1423
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1424
     * some other means.
1425
     * - encoding: unused
1426
     * - decoding: Set by libavcodec, user can override.
1427
     */
1428
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1429

    
1430
    /**
1431
     * Called to release buffers which were allocated with get_buffer.
1432
     * A released buffer can be reused in get_buffer().
1433
     * pic.data[*] must be set to NULL.
1434
     * - encoding: unused
1435
     * - decoding: Set by libavcodec, user can override.
1436
     */
1437
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1438

    
1439
    /**
1440
     * Size of the frame reordering buffer in the decoder.
1441
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1442
     * - encoding: Set by libavcodec.
1443
     * - decoding: Set by libavcodec.
1444
     */
1445
    int has_b_frames;
1446

    
1447
    /**
1448
     * number of bytes per packet if constant and known or 0
1449
     * Used by some WAV based audio codecs.
1450
     */
1451
    int block_align;
1452

    
1453
    int parse_only; /* - decoding only: If true, only parsing is done
1454
                       (function avcodec_parse_frame()). The frame
1455
                       data is returned. Only MPEG codecs support this now. */
1456

    
1457
    /**
1458
     * 0-> h263 quant 1-> mpeg quant
1459
     * - encoding: Set by user.
1460
     * - decoding: unused
1461
     */
1462
    int mpeg_quant;
1463

    
1464
    /**
1465
     * pass1 encoding statistics output buffer
1466
     * - encoding: Set by libavcodec.
1467
     * - decoding: unused
1468
     */
1469
    char *stats_out;
1470

    
1471
    /**
1472
     * pass2 encoding statistics input buffer
1473
     * Concatenated stuff from stats_out of pass1 should be placed here.
1474
     * - encoding: Allocated/set/freed by user.
1475
     * - decoding: unused
1476
     */
1477
    char *stats_in;
1478

    
1479
    /**
1480
     * ratecontrol qmin qmax limiting method
1481
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1482
     * - encoding: Set by user.
1483
     * - decoding: unused
1484
     */
1485
    float rc_qsquish;
1486

    
1487
    float rc_qmod_amp;
1488
    int rc_qmod_freq;
1489

    
1490
    /**
1491
     * ratecontrol override, see RcOverride
1492
     * - encoding: Allocated/set/freed by user.
1493
     * - decoding: unused
1494
     */
1495
    RcOverride *rc_override;
1496
    int rc_override_count;
1497

    
1498
    /**
1499
     * rate control equation
1500
     * - encoding: Set by user
1501
     * - decoding: unused
1502
     */
1503
    const char *rc_eq;
1504

    
1505
    /**
1506
     * maximum bitrate
1507
     * - encoding: Set by user.
1508
     * - decoding: unused
1509
     */
1510
    int rc_max_rate;
1511

    
1512
    /**
1513
     * minimum bitrate
1514
     * - encoding: Set by user.
1515
     * - decoding: unused
1516
     */
1517
    int rc_min_rate;
1518

    
1519
    /**
1520
     * decoder bitstream buffer size
1521
     * - encoding: Set by user.
1522
     * - decoding: unused
1523
     */
1524
    int rc_buffer_size;
1525
    float rc_buffer_aggressivity;
1526

    
1527
    /**
1528
     * qscale factor between P and I-frames
1529
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1530
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1531
     * - encoding: Set by user.
1532
     * - decoding: unused
1533
     */
1534
    float i_quant_factor;
1535

    
1536
    /**
1537
     * qscale offset between P and I-frames
1538
     * - encoding: Set by user.
1539
     * - decoding: unused
1540
     */
1541
    float i_quant_offset;
1542

    
1543
    /**
1544
     * initial complexity for pass1 ratecontrol
1545
     * - encoding: Set by user.
1546
     * - decoding: unused
1547
     */
1548
    float rc_initial_cplx;
1549

    
1550
    /**
1551
     * DCT algorithm, see FF_DCT_* below
1552
     * - encoding: Set by user.
1553
     * - decoding: unused
1554
     */
1555
    int dct_algo;
1556
#define FF_DCT_AUTO    0
1557
#define FF_DCT_FASTINT 1
1558
#define FF_DCT_INT     2
1559
#define FF_DCT_MMX     3
1560
#define FF_DCT_MLIB    4
1561
#define FF_DCT_ALTIVEC 5
1562
#define FF_DCT_FAAN    6
1563

    
1564
    /**
1565
     * luminance masking (0-> disabled)
1566
     * - encoding: Set by user.
1567
     * - decoding: unused
1568
     */
1569
    float lumi_masking;
1570

    
1571
    /**
1572
     * temporary complexity masking (0-> disabled)
1573
     * - encoding: Set by user.
1574
     * - decoding: unused
1575
     */
1576
    float temporal_cplx_masking;
1577

    
1578
    /**
1579
     * spatial complexity masking (0-> disabled)
1580
     * - encoding: Set by user.
1581
     * - decoding: unused
1582
     */
1583
    float spatial_cplx_masking;
1584

    
1585
    /**
1586
     * p block masking (0-> disabled)
1587
     * - encoding: Set by user.
1588
     * - decoding: unused
1589
     */
1590
    float p_masking;
1591

    
1592
    /**
1593
     * darkness masking (0-> disabled)
1594
     * - encoding: Set by user.
1595
     * - decoding: unused
1596
     */
1597
    float dark_masking;
1598

    
1599
    /**
1600
     * IDCT algorithm, see FF_IDCT_* below.
1601
     * - encoding: Set by user.
1602
     * - decoding: Set by user.
1603
     */
1604
    int idct_algo;
1605
#define FF_IDCT_AUTO          0
1606
#define FF_IDCT_INT           1
1607
#define FF_IDCT_SIMPLE        2
1608
#define FF_IDCT_SIMPLEMMX     3
1609
#define FF_IDCT_LIBMPEG2MMX   4
1610
#define FF_IDCT_PS2           5
1611
#define FF_IDCT_MLIB          6
1612
#define FF_IDCT_ARM           7
1613
#define FF_IDCT_ALTIVEC       8
1614
#define FF_IDCT_SH4           9
1615
#define FF_IDCT_SIMPLEARM     10
1616
#define FF_IDCT_H264          11
1617
#define FF_IDCT_VP3           12
1618
#define FF_IDCT_IPP           13
1619
#define FF_IDCT_XVIDMMX       14
1620
#define FF_IDCT_CAVS          15
1621
#define FF_IDCT_SIMPLEARMV5TE 16
1622
#define FF_IDCT_SIMPLEARMV6   17
1623
#define FF_IDCT_SIMPLEVIS     18
1624
#define FF_IDCT_WMV2          19
1625
#define FF_IDCT_FAAN          20
1626
#define FF_IDCT_EA            21
1627
#define FF_IDCT_SIMPLENEON    22
1628
#define FF_IDCT_SIMPLEALPHA   23
1629
#define FF_IDCT_BINK          24
1630

    
1631
    /**
1632
     * slice count
1633
     * - encoding: Set by libavcodec.
1634
     * - decoding: Set by user (or 0).
1635
     */
1636
    int slice_count;
1637
    /**
1638
     * slice offsets in the frame in bytes
1639
     * - encoding: Set/allocated by libavcodec.
1640
     * - decoding: Set/allocated by user (or NULL).
1641
     */
1642
    int *slice_offset;
1643

    
1644
    /**
1645
     * error concealment flags
1646
     * - encoding: unused
1647
     * - decoding: Set by user.
1648
     */
1649
    int error_concealment;
1650
#define FF_EC_GUESS_MVS   1
1651
#define FF_EC_DEBLOCK     2
1652

    
1653
    /**
1654
     * dsp_mask could be add used to disable unwanted CPU features
1655
     * CPU features (i.e. MMX, SSE. ...)
1656
     *
1657
     * With the FORCE flag you may instead enable given CPU features.
1658
     * (Dangerous: Usable in case of misdetection, improper usage however will
1659
     * result into program crash.)
1660
     */
1661
    unsigned dsp_mask;
1662

    
1663
#if FF_API_MM_FLAGS
1664
#define FF_MM_FORCE      AV_CPU_FLAG_FORCE
1665
#define FF_MM_MMX        AV_CPU_FLAG_MMX
1666
#define FF_MM_3DNOW      AV_CPU_FLAG_3DNOW
1667
#define FF_MM_MMXEXT     AV_CPU_FLAG_MMX2
1668
#define FF_MM_MMX2       AV_CPU_FLAG_MMX2
1669
#define FF_MM_SSE        AV_CPU_FLAG_SSE
1670
#define FF_MM_SSE2       AV_CPU_FLAG_SSE2
1671
#define FF_MM_SSE2SLOW   AV_CPU_FLAG_SSE2SLOW
1672
#define FF_MM_3DNOWEXT   AV_CPU_FLAG_3DNOWEXT
1673
#define FF_MM_SSE3       AV_CPU_FLAG_SSE3
1674
#define FF_MM_SSE3SLOW   AV_CPU_FLAG_SSE3SLOW
1675
#define FF_MM_SSSE3      AV_CPU_FLAG_SSSE3
1676
#define FF_MM_SSE4       AV_CPU_FLAG_SSE4
1677
#define FF_MM_SSE42      AV_CPU_FLAG_SSE42
1678
#define FF_MM_IWMMXT     AV_CPU_FLAG_IWMMXT
1679
#define FF_MM_ALTIVEC    AV_CPU_FLAG_ALTIVEC
1680
#endif
1681

    
1682
    /**
1683
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1684
     * - encoding: Set by libavcodec.
1685
     * - decoding: Set by user.
1686
     */
1687
     int bits_per_coded_sample;
1688

    
1689
    /**
1690
     * prediction method (needed for huffyuv)
1691
     * - encoding: Set by user.
1692
     * - decoding: unused
1693
     */
1694
     int prediction_method;
1695
#define FF_PRED_LEFT   0
1696
#define FF_PRED_PLANE  1
1697
#define FF_PRED_MEDIAN 2
1698

    
1699
    /**
1700
     * sample aspect ratio (0 if unknown)
1701
     * That is the width of a pixel divided by the height of the pixel.
1702
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1703
     * - encoding: Set by user.
1704
     * - decoding: Set by libavcodec.
1705
     */
1706
    AVRational sample_aspect_ratio;
1707

    
1708
    /**
1709
     * the picture in the bitstream
1710
     * - encoding: Set by libavcodec.
1711
     * - decoding: Set by libavcodec.
1712
     */
1713
    AVFrame *coded_frame;
1714

    
1715
    /**
1716
     * debug
1717
     * - encoding: Set by user.
1718
     * - decoding: Set by user.
1719
     */
1720
    int debug;
1721
#define FF_DEBUG_PICT_INFO   1
1722
#define FF_DEBUG_RC          2
1723
#define FF_DEBUG_BITSTREAM   4
1724
#define FF_DEBUG_MB_TYPE     8
1725
#define FF_DEBUG_QP          16
1726
#define FF_DEBUG_MV          32
1727
#define FF_DEBUG_DCT_COEFF   0x00000040
1728
#define FF_DEBUG_SKIP        0x00000080
1729
#define FF_DEBUG_STARTCODE   0x00000100
1730
#define FF_DEBUG_PTS         0x00000200
1731
#define FF_DEBUG_ER          0x00000400
1732
#define FF_DEBUG_MMCO        0x00000800
1733
#define FF_DEBUG_BUGS        0x00001000
1734
#define FF_DEBUG_VIS_QP      0x00002000
1735
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1736
#define FF_DEBUG_BUFFERS     0x00008000
1737

    
1738
    /**
1739
     * debug
1740
     * - encoding: Set by user.
1741
     * - decoding: Set by user.
1742
     */
1743
    int debug_mv;
1744
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1745
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1746
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1747

    
1748
    /**
1749
     * error
1750
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1751
     * - decoding: unused
1752
     */
1753
    uint64_t error[4];
1754

    
1755
    /**
1756
     * minimum MB quantizer
1757
     * - encoding: unused
1758
     * - decoding: unused
1759
     */
1760
    int mb_qmin;
1761

    
1762
    /**
1763
     * maximum MB quantizer
1764
     * - encoding: unused
1765
     * - decoding: unused
1766
     */
1767
    int mb_qmax;
1768

    
1769
    /**
1770
     * motion estimation comparison function
1771
     * - encoding: Set by user.
1772
     * - decoding: unused
1773
     */
1774
    int me_cmp;
1775
    /**
1776
     * subpixel motion estimation comparison function
1777
     * - encoding: Set by user.
1778
     * - decoding: unused
1779
     */
1780
    int me_sub_cmp;
1781
    /**
1782
     * macroblock comparison function (not supported yet)
1783
     * - encoding: Set by user.
1784
     * - decoding: unused
1785
     */
1786
    int mb_cmp;
1787
    /**
1788
     * interlaced DCT comparison function
1789
     * - encoding: Set by user.
1790
     * - decoding: unused
1791
     */
1792
    int ildct_cmp;
1793
#define FF_CMP_SAD    0
1794
#define FF_CMP_SSE    1
1795
#define FF_CMP_SATD   2
1796
#define FF_CMP_DCT    3
1797
#define FF_CMP_PSNR   4
1798
#define FF_CMP_BIT    5
1799
#define FF_CMP_RD     6
1800
#define FF_CMP_ZERO   7
1801
#define FF_CMP_VSAD   8
1802
#define FF_CMP_VSSE   9
1803
#define FF_CMP_NSSE   10
1804
#define FF_CMP_W53    11
1805
#define FF_CMP_W97    12
1806
#define FF_CMP_DCTMAX 13
1807
#define FF_CMP_DCT264 14
1808
#define FF_CMP_CHROMA 256
1809

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

    
1817
    /**
1818
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1819
     * - encoding: Set by user.
1820
     * - decoding: unused
1821
     */
1822
    int last_predictor_count;
1823

    
1824
    /**
1825
     * prepass for motion estimation
1826
     * - encoding: Set by user.
1827
     * - decoding: unused
1828
     */
1829
    int pre_me;
1830

    
1831
    /**
1832
     * motion estimation prepass comparison function
1833
     * - encoding: Set by user.
1834
     * - decoding: unused
1835
     */
1836
    int me_pre_cmp;
1837

    
1838
    /**
1839
     * ME prepass diamond size & shape
1840
     * - encoding: Set by user.
1841
     * - decoding: unused
1842
     */
1843
    int pre_dia_size;
1844

    
1845
    /**
1846
     * subpel ME quality
1847
     * - encoding: Set by user.
1848
     * - decoding: unused
1849
     */
1850
    int me_subpel_quality;
1851

    
1852
    /**
1853
     * callback to negotiate the pixelFormat
1854
     * @param fmt is the list of formats which are supported by the codec,
1855
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1856
     * The first is always the native one.
1857
     * @return the chosen format
1858
     * - encoding: unused
1859
     * - decoding: Set by user, if not set the native format will be chosen.
1860
     */
1861
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1862

    
1863
    /**
1864
     * DTG active format information (additional aspect ratio
1865
     * information only used in DVB MPEG-2 transport streams)
1866
     * 0 if not set.
1867
     *
1868
     * - encoding: unused
1869
     * - decoding: Set by decoder.
1870
     */
1871
    int dtg_active_format;
1872
#define FF_DTG_AFD_SAME         8
1873
#define FF_DTG_AFD_4_3          9
1874
#define FF_DTG_AFD_16_9         10
1875
#define FF_DTG_AFD_14_9         11
1876
#define FF_DTG_AFD_4_3_SP_14_9  13
1877
#define FF_DTG_AFD_16_9_SP_14_9 14
1878
#define FF_DTG_AFD_SP_4_3       15
1879

    
1880
    /**
1881
     * maximum motion estimation search range in subpel units
1882
     * If 0 then no limit.
1883
     *
1884
     * - encoding: Set by user.
1885
     * - decoding: unused
1886
     */
1887
    int me_range;
1888

    
1889
    /**
1890
     * intra quantizer bias
1891
     * - encoding: Set by user.
1892
     * - decoding: unused
1893
     */
1894
    int intra_quant_bias;
1895
#define FF_DEFAULT_QUANT_BIAS 999999
1896

    
1897
    /**
1898
     * inter quantizer bias
1899
     * - encoding: Set by user.
1900
     * - decoding: unused
1901
     */
1902
    int inter_quant_bias;
1903

    
1904
    /**
1905
     * color table ID
1906
     * - encoding: unused
1907
     * - decoding: Which clrtable should be used for 8bit RGB images.
1908
     *             Tables have to be stored somewhere. FIXME
1909
     */
1910
    int color_table_id;
1911

    
1912
    /**
1913
     * internal_buffer count
1914
     * Don't touch, used by libavcodec default_get_buffer().
1915
     */
1916
    int internal_buffer_count;
1917

    
1918
    /**
1919
     * internal_buffers
1920
     * Don't touch, used by libavcodec default_get_buffer().
1921
     */
1922
    void *internal_buffer;
1923

    
1924
#define FF_LAMBDA_SHIFT 7
1925
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1926
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1927
#define FF_LAMBDA_MAX (256*128-1)
1928

    
1929
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1930
    /**
1931
     * Global quality for codecs which cannot change it per frame.
1932
     * This should be proportional to MPEG-1/2/4 qscale.
1933
     * - encoding: Set by user.
1934
     * - decoding: unused
1935
     */
1936
    int global_quality;
1937

    
1938
#define FF_CODER_TYPE_VLC       0
1939
#define FF_CODER_TYPE_AC        1
1940
#define FF_CODER_TYPE_RAW       2
1941
#define FF_CODER_TYPE_RLE       3
1942
#define FF_CODER_TYPE_DEFLATE   4
1943
    /**
1944
     * coder type
1945
     * - encoding: Set by user.
1946
     * - decoding: unused
1947
     */
1948
    int coder_type;
1949

    
1950
    /**
1951
     * context model
1952
     * - encoding: Set by user.
1953
     * - decoding: unused
1954
     */
1955
    int context_model;
1956
#if 0
1957
    /**
1958
     *
1959
     * - encoding: unused
1960
     * - decoding: Set by user.
1961
     */
1962
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1963
#endif
1964

    
1965
    /**
1966
     * slice flags
1967
     * - encoding: unused
1968
     * - decoding: Set by user.
1969
     */
1970
    int slice_flags;
1971
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1972
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1973
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1974

    
1975
    /**
1976
     * XVideo Motion Acceleration
1977
     * - encoding: forbidden
1978
     * - decoding: set by decoder
1979
     */
1980
    int xvmc_acceleration;
1981

    
1982
    /**
1983
     * macroblock decision mode
1984
     * - encoding: Set by user.
1985
     * - decoding: unused
1986
     */
1987
    int mb_decision;
1988
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1989
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1990
#define FF_MB_DECISION_RD     2        ///< rate distortion
1991

    
1992
    /**
1993
     * custom intra quantization matrix
1994
     * - encoding: Set by user, can be NULL.
1995
     * - decoding: Set by libavcodec.
1996
     */
1997
    uint16_t *intra_matrix;
1998

    
1999
    /**
2000
     * custom inter quantization matrix
2001
     * - encoding: Set by user, can be NULL.
2002
     * - decoding: Set by libavcodec.
2003
     */
2004
    uint16_t *inter_matrix;
2005

    
2006
    /**
2007
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2008
     * This is used to work around some encoder bugs.
2009
     * - encoding: unused
2010
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2011
     */
2012
    unsigned int stream_codec_tag;
2013

    
2014
    /**
2015
     * scene change detection threshold
2016
     * 0 is default, larger means fewer detected scene changes.
2017
     * - encoding: Set by user.
2018
     * - decoding: unused
2019
     */
2020
    int scenechange_threshold;
2021

    
2022
    /**
2023
     * minimum Lagrange multipler
2024
     * - encoding: Set by user.
2025
     * - decoding: unused
2026
     */
2027
    int lmin;
2028

    
2029
    /**
2030
     * maximum Lagrange multipler
2031
     * - encoding: Set by user.
2032
     * - decoding: unused
2033
     */
2034
    int lmax;
2035

    
2036
#if FF_API_PALETTE_CONTROL
2037
    /**
2038
     * palette control structure
2039
     * - encoding: ??? (no palette-enabled encoder yet)
2040
     * - decoding: Set by user.
2041
     */
2042
    struct AVPaletteControl *palctrl;
2043
#endif
2044

    
2045
    /**
2046
     * noise reduction strength
2047
     * - encoding: Set by user.
2048
     * - decoding: unused
2049
     */
2050
    int noise_reduction;
2051

    
2052
    /**
2053
     * Called at the beginning of a frame to get cr buffer for it.
2054
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
2055
     * libavcodec will pass previous buffer in pic, function should return
2056
     * same buffer or new buffer with old frame "painted" into it.
2057
     * If pic.data[0] == NULL must behave like get_buffer().
2058
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2059
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
2060
     * some other means.
2061
     * - encoding: unused
2062
     * - decoding: Set by libavcodec, user can override.
2063
     */
2064
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2065

    
2066
    /**
2067
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2068
     * - encoding: Set by user.
2069
     * - decoding: unused
2070
     */
2071
    int rc_initial_buffer_occupancy;
2072

    
2073
    /**
2074
     *
2075
     * - encoding: Set by user.
2076
     * - decoding: unused
2077
     */
2078
    int inter_threshold;
2079

    
2080
    /**
2081
     * CODEC_FLAG2_*
2082
     * - encoding: Set by user.
2083
     * - decoding: Set by user.
2084
     */
2085
    int flags2;
2086

    
2087
    /**
2088
     * Simulates errors in the bitstream to test error concealment.
2089
     * - encoding: Set by user.
2090
     * - decoding: unused
2091
     */
2092
    int error_rate;
2093

    
2094
    /**
2095
     * MP3 antialias algorithm, see FF_AA_* below.
2096
     * - encoding: unused
2097
     * - decoding: Set by user.
2098
     */
2099
    int antialias_algo;
2100
#define FF_AA_AUTO    0
2101
#define FF_AA_FASTINT 1 //not implemented yet
2102
#define FF_AA_INT     2
2103
#define FF_AA_FLOAT   3
2104
    /**
2105
     * quantizer noise shaping
2106
     * - encoding: Set by user.
2107
     * - decoding: unused
2108
     */
2109
    int quantizer_noise_shaping;
2110

    
2111
    /**
2112
     * thread count
2113
     * is used to decide how many independent tasks should be passed to execute()
2114
     * - encoding: Set by user.
2115
     * - decoding: Set by user.
2116
     */
2117
    int thread_count;
2118

    
2119
    /**
2120
     * The codec may call this to execute several independent things.
2121
     * It will return only after finishing all tasks.
2122
     * The user may replace this with some multithreaded implementation,
2123
     * the default implementation will execute the parts serially.
2124
     * @param count the number of things to execute
2125
     * - encoding: Set by libavcodec, user can override.
2126
     * - decoding: Set by libavcodec, user can override.
2127
     */
2128
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2129

    
2130
    /**
2131
     * thread opaque
2132
     * Can be used by execute() to store some per AVCodecContext stuff.
2133
     * - encoding: set by execute()
2134
     * - decoding: set by execute()
2135
     */
2136
    void *thread_opaque;
2137

    
2138
    /**
2139
     * Motion estimation threshold below which no motion estimation is
2140
     * performed, but instead the user specified motion vectors are used.
2141
     *
2142
     * - encoding: Set by user.
2143
     * - decoding: unused
2144
     */
2145
     int me_threshold;
2146

    
2147
    /**
2148
     * Macroblock threshold below which the user specified macroblock types will be used.
2149
     * - encoding: Set by user.
2150
     * - decoding: unused
2151
     */
2152
     int mb_threshold;
2153

    
2154
    /**
2155
     * precision of the intra DC coefficient - 8
2156
     * - encoding: Set by user.
2157
     * - decoding: unused
2158
     */
2159
     int intra_dc_precision;
2160

    
2161
    /**
2162
     * noise vs. sse weight for the nsse comparsion function
2163
     * - encoding: Set by user.
2164
     * - decoding: unused
2165
     */
2166
     int nsse_weight;
2167

    
2168
    /**
2169
     * Number of macroblock rows at the top which are skipped.
2170
     * - encoding: unused
2171
     * - decoding: Set by user.
2172
     */
2173
     int skip_top;
2174

    
2175
    /**
2176
     * Number of macroblock rows at the bottom which are skipped.
2177
     * - encoding: unused
2178
     * - decoding: Set by user.
2179
     */
2180
     int skip_bottom;
2181

    
2182
    /**
2183
     * profile
2184
     * - encoding: Set by user.
2185
     * - decoding: Set by libavcodec.
2186
     */
2187
     int profile;
2188
#define FF_PROFILE_UNKNOWN -99
2189

    
2190
#define FF_PROFILE_AAC_MAIN 0
2191
#define FF_PROFILE_AAC_LOW  1
2192
#define FF_PROFILE_AAC_SSR  2
2193
#define FF_PROFILE_AAC_LTP  3
2194

    
2195
#define FF_PROFILE_H264_BASELINE    66
2196
#define FF_PROFILE_H264_MAIN        77
2197
#define FF_PROFILE_H264_EXTENDED    88
2198
#define FF_PROFILE_H264_HIGH        100
2199
#define FF_PROFILE_H264_HIGH_10     110
2200
#define FF_PROFILE_H264_HIGH_422    122
2201
#define FF_PROFILE_H264_HIGH_444    244
2202
#define FF_PROFILE_H264_CAVLC_444   44
2203

    
2204
    /**
2205
     * level
2206
     * - encoding: Set by user.
2207
     * - decoding: Set by libavcodec.
2208
     */
2209
     int level;
2210
#define FF_LEVEL_UNKNOWN -99
2211

    
2212
    /**
2213
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2214
     * - encoding: unused
2215
     * - decoding: Set by user.
2216
     */
2217
     int lowres;
2218

    
2219
    /**
2220
     * Bitstream width / height, may be different from width/height if lowres
2221
     * or other things are used.
2222
     * - encoding: unused
2223
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2224
     */
2225
    int coded_width, coded_height;
2226

    
2227
    /**
2228
     * frame skip threshold
2229
     * - encoding: Set by user.
2230
     * - decoding: unused
2231
     */
2232
    int frame_skip_threshold;
2233

    
2234
    /**
2235
     * frame skip factor
2236
     * - encoding: Set by user.
2237
     * - decoding: unused
2238
     */
2239
    int frame_skip_factor;
2240

    
2241
    /**
2242
     * frame skip exponent
2243
     * - encoding: Set by user.
2244
     * - decoding: unused
2245
     */
2246
    int frame_skip_exp;
2247

    
2248
    /**
2249
     * frame skip comparison function
2250
     * - encoding: Set by user.
2251
     * - decoding: unused
2252
     */
2253
    int frame_skip_cmp;
2254

    
2255
    /**
2256
     * Border processing masking, raises the quantizer for mbs on the borders
2257
     * of the picture.
2258
     * - encoding: Set by user.
2259
     * - decoding: unused
2260
     */
2261
    float border_masking;
2262

    
2263
    /**
2264
     * minimum MB lagrange multipler
2265
     * - encoding: Set by user.
2266
     * - decoding: unused
2267
     */
2268
    int mb_lmin;
2269

    
2270
    /**
2271
     * maximum MB lagrange multipler
2272
     * - encoding: Set by user.
2273
     * - decoding: unused
2274
     */
2275
    int mb_lmax;
2276

    
2277
    /**
2278
     *
2279
     * - encoding: Set by user.
2280
     * - decoding: unused
2281
     */
2282
    int me_penalty_compensation;
2283

    
2284
    /**
2285
     *
2286
     * - encoding: unused
2287
     * - decoding: Set by user.
2288
     */
2289
    enum AVDiscard skip_loop_filter;
2290

    
2291
    /**
2292
     *
2293
     * - encoding: unused
2294
     * - decoding: Set by user.
2295
     */
2296
    enum AVDiscard skip_idct;
2297

    
2298
    /**
2299
     *
2300
     * - encoding: unused
2301
     * - decoding: Set by user.
2302
     */
2303
    enum AVDiscard skip_frame;
2304

    
2305
    /**
2306
     *
2307
     * - encoding: Set by user.
2308
     * - decoding: unused
2309
     */
2310
    int bidir_refine;
2311

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

    
2319
    /**
2320
     * constant rate factor - quality-based VBR - values ~correspond to qps
2321
     * - encoding: Set by user.
2322
     * - decoding: unused
2323
     */
2324
    float crf;
2325

    
2326
    /**
2327
     * constant quantization parameter rate control method
2328
     * - encoding: Set by user.
2329
     * - decoding: unused
2330
     */
2331
    int cqp;
2332

    
2333
    /**
2334
     * minimum GOP size
2335
     * - encoding: Set by user.
2336
     * - decoding: unused
2337
     */
2338
    int keyint_min;
2339

    
2340
    /**
2341
     * number of reference frames
2342
     * - encoding: Set by user.
2343
     * - decoding: Set by lavc.
2344
     */
2345
    int refs;
2346

    
2347
    /**
2348
     * chroma qp offset from luma
2349
     * - encoding: Set by user.
2350
     * - decoding: unused
2351
     */
2352
    int chromaoffset;
2353

    
2354
    /**
2355
     * Influences how often B-frames are used.
2356
     * - encoding: Set by user.
2357
     * - decoding: unused
2358
     */
2359
    int bframebias;
2360

    
2361
    /**
2362
     * trellis RD quantization
2363
     * - encoding: Set by user.
2364
     * - decoding: unused
2365
     */
2366
    int trellis;
2367

    
2368
    /**
2369
     * Reduce fluctuations in qp (before curve compression).
2370
     * - encoding: Set by user.
2371
     * - decoding: unused
2372
     */
2373
    float complexityblur;
2374

    
2375
    /**
2376
     * in-loop deblocking filter alphac0 parameter
2377
     * alpha is in the range -6...6
2378
     * - encoding: Set by user.
2379
     * - decoding: unused
2380
     */
2381
    int deblockalpha;
2382

    
2383
    /**
2384
     * in-loop deblocking filter beta parameter
2385
     * beta is in the range -6...6
2386
     * - encoding: Set by user.
2387
     * - decoding: unused
2388
     */
2389
    int deblockbeta;
2390

    
2391
    /**
2392
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2393
     * - encoding: Set by user.
2394
     * - decoding: unused
2395
     */
2396
    int partitions;
2397
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2398
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2399
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2400
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2401
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2402

    
2403
    /**
2404
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2405
     * - encoding: Set by user.
2406
     * - decoding: unused
2407
     */
2408
    int directpred;
2409

    
2410
    /**
2411
     * Audio cutoff bandwidth (0 means "automatic")
2412
     * - encoding: Set by user.
2413
     * - decoding: unused
2414
     */
2415
    int cutoff;
2416

    
2417
    /**
2418
     * Multiplied by qscale for each frame and added to scene_change_score.
2419
     * - encoding: Set by user.
2420
     * - decoding: unused
2421
     */
2422
    int scenechange_factor;
2423

    
2424
    /**
2425
     *
2426
     * Note: Value depends upon the compare function used for fullpel ME.
2427
     * - encoding: Set by user.
2428
     * - decoding: unused
2429
     */
2430
    int mv0_threshold;
2431

    
2432
    /**
2433
     * Adjusts sensitivity of b_frame_strategy 1.
2434
     * - encoding: Set by user.
2435
     * - decoding: unused
2436
     */
2437
    int b_sensitivity;
2438

    
2439
    /**
2440
     * - encoding: Set by user.
2441
     * - decoding: unused
2442
     */
2443
    int compression_level;
2444
#define FF_COMPRESSION_DEFAULT -1
2445

    
2446
#if LIBAVCODEC_VERSION_MAJOR < 53
2447
    /**
2448
     * Sets whether to use LPC mode - used by FLAC encoder.
2449
     * - encoding: Set by user.
2450
     * - decoding: unused
2451
     * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2452
     */
2453
    int use_lpc;
2454
#endif
2455

    
2456
    /**
2457
     * LPC coefficient precision - used by FLAC encoder
2458
     * - encoding: Set by user.
2459
     * - decoding: unused
2460
     */
2461
    int lpc_coeff_precision;
2462

    
2463
    /**
2464
     * - encoding: Set by user.
2465
     * - decoding: unused
2466
     */
2467
    int min_prediction_order;
2468

    
2469
    /**
2470
     * - encoding: Set by user.
2471
     * - decoding: unused
2472
     */
2473
    int max_prediction_order;
2474

    
2475
    /**
2476
     * search method for selecting prediction order
2477
     * - encoding: Set by user.
2478
     * - decoding: unused
2479
     */
2480
    int prediction_order_method;
2481

    
2482
    /**
2483
     * - encoding: Set by user.
2484
     * - decoding: unused
2485
     */
2486
    int min_partition_order;
2487

    
2488
    /**
2489
     * - encoding: Set by user.
2490
     * - decoding: unused
2491
     */
2492
    int max_partition_order;
2493

    
2494
    /**
2495
     * GOP timecode frame start number, in non drop frame format
2496
     * - encoding: Set by user.
2497
     * - decoding: unused
2498
     */
2499
    int64_t timecode_frame_start;
2500

    
2501
#if LIBAVCODEC_VERSION_MAJOR < 53
2502
    /**
2503
     * Decoder should decode to this many channels if it can (0 for default)
2504
     * - encoding: unused
2505
     * - decoding: Set by user.
2506
     * @deprecated Deprecated in favor of request_channel_layout.
2507
     */
2508
    int request_channels;
2509
#endif
2510

    
2511
    /**
2512
     * Percentage of dynamic range compression to be applied by the decoder.
2513
     * The default value is 1.0, corresponding to full compression.
2514
     * - encoding: unused
2515
     * - decoding: Set by user.
2516
     */
2517
    float drc_scale;
2518

    
2519
    /**
2520
     * opaque 64bit number (generally a PTS) that will be reordered and
2521
     * output in AVFrame.reordered_opaque
2522
     * - encoding: unused
2523
     * - decoding: Set by user.
2524
     */
2525
    int64_t reordered_opaque;
2526

    
2527
    /**
2528
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2529
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2530
     * - encoding: set by user.
2531
     * - decoding: set by libavcodec.
2532
     */
2533
    int bits_per_raw_sample;
2534

    
2535
    /**
2536
     * Audio channel layout.
2537
     * - encoding: set by user.
2538
     * - decoding: set by libavcodec.
2539
     */
2540
    int64_t channel_layout;
2541

    
2542
    /**
2543
     * Request decoder to use this channel layout if it can (0 for default)
2544
     * - encoding: unused
2545
     * - decoding: Set by user.
2546
     */
2547
    int64_t request_channel_layout;
2548

    
2549
    /**
2550
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2551
     * - encoding: Set by user.
2552
     * - decoding: unused.
2553
     */
2554
    float rc_max_available_vbv_use;
2555

    
2556
    /**
2557
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2558
     * - encoding: Set by user.
2559
     * - decoding: unused.
2560
     */
2561
    float rc_min_vbv_overflow_use;
2562

    
2563
    /**
2564
     * Hardware accelerator in use
2565
     * - encoding: unused.
2566
     * - decoding: Set by libavcodec
2567
     */
2568
    struct AVHWAccel *hwaccel;
2569

    
2570
    /**
2571
     * For some codecs, the time base is closer to the field rate than the frame rate.
2572
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2573
     * if no telecine is used ...
2574
     *
2575
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2576
     */
2577
    int ticks_per_frame;
2578

    
2579
    /**
2580
     * Hardware accelerator context.
2581
     * For some hardware accelerators, a global context needs to be
2582
     * provided by the user. In that case, this holds display-dependent
2583
     * data FFmpeg cannot instantiate itself. Please refer to the
2584
     * FFmpeg HW accelerator documentation to know how to fill this
2585
     * is. e.g. for VA API, this is a struct vaapi_context.
2586
     * - encoding: unused
2587
     * - decoding: Set by user
2588
     */
2589
    void *hwaccel_context;
2590

    
2591
    /**
2592
     * Chromaticity coordinates of the source primaries.
2593
     * - encoding: Set by user
2594
     * - decoding: Set by libavcodec
2595
     */
2596
    enum AVColorPrimaries color_primaries;
2597

    
2598
    /**
2599
     * Color Transfer Characteristic.
2600
     * - encoding: Set by user
2601
     * - decoding: Set by libavcodec
2602
     */
2603
    enum AVColorTransferCharacteristic color_trc;
2604

    
2605
    /**
2606
     * YUV colorspace type.
2607
     * - encoding: Set by user
2608
     * - decoding: Set by libavcodec
2609
     */
2610
    enum AVColorSpace colorspace;
2611

    
2612
    /**
2613
     * MPEG vs JPEG YUV range.
2614
     * - encoding: Set by user
2615
     * - decoding: Set by libavcodec
2616
     */
2617
    enum AVColorRange color_range;
2618

    
2619
    /**
2620
     * This defines the location of chroma samples.
2621
     * - encoding: Set by user
2622
     * - decoding: Set by libavcodec
2623
     */
2624
    enum AVChromaLocation chroma_sample_location;
2625

    
2626
    /**
2627
     * The codec may call this to execute several independent things.
2628
     * It will return only after finishing all tasks.
2629
     * The user may replace this with some multithreaded implementation,
2630
     * the default implementation will execute the parts serially.
2631
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2632
     * @param c context passed also to func
2633
     * @param count the number of things to execute
2634
     * @param arg2 argument passed unchanged to func
2635
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2636
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2637
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2638
     *             two instances of func executing at the same time will have the same threadnr.
2639
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2640
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2641
     * - encoding: Set by libavcodec, user can override.
2642
     * - decoding: Set by libavcodec, user can override.
2643
     */
2644
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2645

    
2646
    /**
2647
     * explicit P-frame weighted prediction analysis method
2648
     * 0: off
2649
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2650
     * 2: smart weighting (full fade detection analysis)
2651
     * - encoding: Set by user.
2652
     * - decoding: unused
2653
     */
2654
    int weighted_p_pred;
2655

    
2656
    /**
2657
     * AQ mode
2658
     * 0: Disabled
2659
     * 1: Variance AQ (complexity mask)
2660
     * 2: Auto-variance AQ (experimental)
2661
     * - encoding: Set by user
2662
     * - decoding: unused
2663
     */
2664
    int aq_mode;
2665

    
2666
    /**
2667
     * AQ strength
2668
     * Reduces blocking and blurring in flat and textured areas.
2669
     * - encoding: Set by user
2670
     * - decoding: unused
2671
     */
2672
    float aq_strength;
2673

    
2674
    /**
2675
     * PSY RD
2676
     * Strength of psychovisual optimization
2677
     * - encoding: Set by user
2678
     * - decoding: unused
2679
     */
2680
    float psy_rd;
2681

    
2682
    /**
2683
     * PSY trellis
2684
     * Strength of psychovisual optimization
2685
     * - encoding: Set by user
2686
     * - decoding: unused
2687
     */
2688
    float psy_trellis;
2689

    
2690
    /**
2691
     * RC lookahead
2692
     * Number of frames for frametype and ratecontrol lookahead
2693
     * - encoding: Set by user
2694
     * - decoding: unused
2695
     */
2696
    int rc_lookahead;
2697

    
2698
    /**
2699
     * Constant rate factor maximum
2700
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2701
     * than crf_max, even if doing so would violate VBV restrictions.
2702
     * - encoding: Set by user.
2703
     * - decoding: unused
2704
     */
2705
    float crf_max;
2706

    
2707
    int log_level_offset;
2708

    
2709
    /**
2710
     * Determines which LPC analysis algorithm to use.
2711
     * - encoding: Set by user
2712
     * - decoding: unused
2713
     */
2714
    enum AVLPCType lpc_type;
2715

    
2716
    /**
2717
     * Number of passes to use for Cholesky factorization during LPC analysis
2718
     * - encoding: Set by user
2719
     * - decoding: unused
2720
     */
2721
    int lpc_passes;
2722
} AVCodecContext;
2723

    
2724
/**
2725
 * AVCodec.
2726
 */
2727
typedef struct AVCodec {
2728
    /**
2729
     * Name of the codec implementation.
2730
     * The name is globally unique among encoders and among decoders (but an
2731
     * encoder and a decoder can share the same name).
2732
     * This is the primary way to find a codec from the user perspective.
2733
     */
2734
    const char *name;
2735
    enum AVMediaType type;
2736
    enum CodecID id;
2737
    int priv_data_size;
2738
    int (*init)(AVCodecContext *);
2739
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2740
    int (*close)(AVCodecContext *);
2741
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2742
    /**
2743
     * Codec capabilities.
2744
     * see CODEC_CAP_*
2745
     */
2746
    int capabilities;
2747
    struct AVCodec *next;
2748
    /**
2749
     * Flush buffers.
2750
     * Will be called when seeking
2751
     */
2752
    void (*flush)(AVCodecContext *);
2753
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2754
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2755
    /**
2756
     * Descriptive name for the codec, meant to be more human readable than name.
2757
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2758
     */
2759
    const char *long_name;
2760
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2761
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2762
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2763
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2764
} AVCodec;
2765

    
2766
/**
2767
 * AVHWAccel.
2768
 */
2769
typedef struct AVHWAccel {
2770
    /**
2771
     * Name of the hardware accelerated codec.
2772
     * The name is globally unique among encoders and among decoders (but an
2773
     * encoder and a decoder can share the same name).
2774
     */
2775
    const char *name;
2776

    
2777
    /**
2778
     * Type of codec implemented by the hardware accelerator.
2779
     *
2780
     * See AVMEDIA_TYPE_xxx
2781
     */
2782
    enum AVMediaType type;
2783

    
2784
    /**
2785
     * Codec implemented by the hardware accelerator.
2786
     *
2787
     * See CODEC_ID_xxx
2788
     */
2789
    enum CodecID id;
2790

    
2791
    /**
2792
     * Supported pixel format.
2793
     *
2794
     * Only hardware accelerated formats are supported here.
2795
     */
2796
    enum PixelFormat pix_fmt;
2797

    
2798
    /**
2799
     * Hardware accelerated codec capabilities.
2800
     * see FF_HWACCEL_CODEC_CAP_*
2801
     */
2802
    int capabilities;
2803

    
2804
    struct AVHWAccel *next;
2805

    
2806
    /**
2807
     * Called at the beginning of each frame or field picture.
2808
     *
2809
     * Meaningful frame information (codec specific) is guaranteed to
2810
     * be parsed at this point. This function is mandatory.
2811
     *
2812
     * Note that buf can be NULL along with buf_size set to 0.
2813
     * Otherwise, this means the whole frame is available at this point.
2814
     *
2815
     * @param avctx the codec context
2816
     * @param buf the frame data buffer base
2817
     * @param buf_size the size of the frame in bytes
2818
     * @return zero if successful, a negative value otherwise
2819
     */
2820
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2821

    
2822
    /**
2823
     * Callback for each slice.
2824
     *
2825
     * Meaningful slice information (codec specific) is guaranteed to
2826
     * be parsed at this point. This function is mandatory.
2827
     *
2828
     * @param avctx the codec context
2829
     * @param buf the slice data buffer base
2830
     * @param buf_size the size of the slice in bytes
2831
     * @return zero if successful, a negative value otherwise
2832
     */
2833
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2834

    
2835
    /**
2836
     * Called at the end of each frame or field picture.
2837
     *
2838
     * The whole picture is parsed at this point and can now be sent
2839
     * to the hardware accelerator. This function is mandatory.
2840
     *
2841
     * @param avctx the codec context
2842
     * @return zero if successful, a negative value otherwise
2843
     */
2844
    int (*end_frame)(AVCodecContext *avctx);
2845

    
2846
    /**
2847
     * Size of HW accelerator private data.
2848
     *
2849
     * Private data is allocated with av_mallocz() before
2850
     * AVCodecContext.get_buffer() and deallocated after
2851
     * AVCodecContext.release_buffer().
2852
     */
2853
    int priv_data_size;
2854
} AVHWAccel;
2855

    
2856
/**
2857
 * four components are given, that's all.
2858
 * the last component is alpha
2859
 */
2860
typedef struct AVPicture {
2861
    uint8_t *data[4];
2862
    int linesize[4];       ///< number of bytes per line
2863
} AVPicture;
2864

    
2865
#if FF_API_PALETTE_CONTROL
2866
/**
2867
 * AVPaletteControl
2868
 * This structure defines a method for communicating palette changes
2869
 * between and demuxer and a decoder.
2870
 *
2871
 * @deprecated Use AVPacket to send palette changes instead.
2872
 * This is totally broken.
2873
 */
2874
#define AVPALETTE_SIZE 1024
2875
#define AVPALETTE_COUNT 256
2876
typedef struct AVPaletteControl {
2877

    
2878
    /* Demuxer sets this to 1 to indicate the palette has changed;
2879
     * decoder resets to 0. */
2880
    int palette_changed;
2881

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

    
2888
} AVPaletteControl attribute_deprecated;
2889
#endif
2890

    
2891
enum AVSubtitleType {
2892
    SUBTITLE_NONE,
2893

    
2894
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2895

    
2896
    /**
2897
     * Plain text, the text field must be set by the decoder and is
2898
     * authoritative. ass and pict fields may contain approximations.
2899
     */
2900
    SUBTITLE_TEXT,
2901

    
2902
    /**
2903
     * Formatted text, the ass field must be set by the decoder and is
2904
     * authoritative. pict and text fields may contain approximations.
2905
     */
2906
    SUBTITLE_ASS,
2907
};
2908

    
2909
typedef struct AVSubtitleRect {
2910
    int x;         ///< top left corner  of pict, undefined when pict is not set
2911
    int y;         ///< top left corner  of pict, undefined when pict is not set
2912
    int w;         ///< width            of pict, undefined when pict is not set
2913
    int h;         ///< height           of pict, undefined when pict is not set
2914
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2915

    
2916
    /**
2917
     * data+linesize for the bitmap of this subtitle.
2918
     * can be set for text/ass as well once they where rendered
2919
     */
2920
    AVPicture pict;
2921
    enum AVSubtitleType type;
2922

    
2923
    char *text;                     ///< 0 terminated plain UTF-8 text
2924

    
2925
    /**
2926
     * 0 terminated ASS/SSA compatible event line.
2927
     * The pressentation of this is unaffected by the other values in this
2928
     * struct.
2929
     */
2930
    char *ass;
2931
} AVSubtitleRect;
2932

    
2933
typedef struct AVSubtitle {
2934
    uint16_t format; /* 0 = graphics */
2935
    uint32_t start_display_time; /* relative to packet pts, in ms */
2936
    uint32_t end_display_time; /* relative to packet pts, in ms */
2937
    unsigned num_rects;
2938
    AVSubtitleRect **rects;
2939
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2940
} AVSubtitle;
2941

    
2942
/* packet functions */
2943

    
2944
/**
2945
 * @deprecated use NULL instead
2946
 */
2947
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2948

    
2949
/**
2950
 * Default packet destructor.
2951
 */
2952
void av_destruct_packet(AVPacket *pkt);
2953

    
2954
/**
2955
 * Initialize optional fields of a packet with default values.
2956
 *
2957
 * @param pkt packet
2958
 */
2959
void av_init_packet(AVPacket *pkt);
2960

    
2961
/**
2962
 * Allocate the payload of a packet and initialize its fields with
2963
 * default values.
2964
 *
2965
 * @param pkt packet
2966
 * @param size wanted payload size
2967
 * @return 0 if OK, AVERROR_xxx otherwise
2968
 */
2969
int av_new_packet(AVPacket *pkt, int size);
2970

    
2971
/**
2972
 * Reduce packet size, correctly zeroing padding
2973
 *
2974
 * @param pkt packet
2975
 * @param size new size
2976
 */
2977
void av_shrink_packet(AVPacket *pkt, int size);
2978

    
2979
/**
2980
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2981
 * packet is allocated if it was not really allocated.
2982
 */
2983
int av_dup_packet(AVPacket *pkt);
2984

    
2985
/**
2986
 * Free a packet.
2987
 *
2988
 * @param pkt packet to free
2989
 */
2990
void av_free_packet(AVPacket *pkt);
2991

    
2992
/* resample.c */
2993

    
2994
struct ReSampleContext;
2995
struct AVResampleContext;
2996

    
2997
typedef struct ReSampleContext ReSampleContext;
2998

    
2999
#if LIBAVCODEC_VERSION_MAJOR < 53
3000
/**
3001
 * @deprecated Use av_audio_resample_init() instead.
3002
 */
3003
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3004
                                                          int output_rate, int input_rate);
3005
#endif
3006
/**
3007
 *  Initialize audio resampling context
3008
 *
3009
 * @param output_channels  number of output channels
3010
 * @param input_channels   number of input channels
3011
 * @param output_rate      output sample rate
3012
 * @param input_rate       input sample rate
3013
 * @param sample_fmt_out   requested output sample format
3014
 * @param sample_fmt_in    input sample format
3015
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
3016
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3017
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
3018
                           between the 2 closest, if 0 the closest will be used
3019
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3020
 * @return allocated ReSampleContext, NULL if error occured
3021
 */
3022
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3023
                                        int output_rate, int input_rate,
3024
                                        enum SampleFormat sample_fmt_out,
3025
                                        enum SampleFormat sample_fmt_in,
3026
                                        int filter_length, int log2_phase_count,
3027
                                        int linear, double cutoff);
3028

    
3029
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3030
void audio_resample_close(ReSampleContext *s);
3031

    
3032

    
3033
/**
3034
 * Initialize an audio resampler.
3035
 * Note, if either rate is not an integer then simply scale both rates up so they are.
3036
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3037
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3038
 * @param linear If 1 then the used FIR filter will be linearly interpolated
3039
                 between the 2 closest, if 0 the closest will be used
3040
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3041
 */
3042
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3043

    
3044
/**
3045
 * Resample an array of samples using a previously configured context.
3046
 * @param src an array of unconsumed samples
3047
 * @param consumed the number of samples of src which have been consumed are returned here
3048
 * @param src_size the number of unconsumed samples available
3049
 * @param dst_size the amount of space in samples available in dst
3050
 * @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.
3051
 * @return the number of samples written in dst or -1 if an error occurred
3052
 */
3053
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3054

    
3055

    
3056
/**
3057
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3058
 * the resampler parameters, so no audible clicks or similar distortions occur
3059
 * @param compensation_distance distance in output samples over which the compensation should be performed
3060
 * @param sample_delta number of output samples which should be output less
3061
 *
3062
 * example: av_resample_compensate(c, 10, 500)
3063
 * here instead of 510 samples only 500 samples would be output
3064
 *
3065
 * note, due to rounding the actual compensation might be slightly different,
3066
 * especially if the compensation_distance is large and the in_rate used during init is small
3067
 */
3068
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3069
void av_resample_close(struct AVResampleContext *c);
3070

    
3071
/**
3072
 * Allocate memory for a picture.  Call avpicture_free to free it.
3073
 *
3074
 * @param picture the picture to be filled in
3075
 * @param pix_fmt the format of the picture
3076
 * @param width the width of the picture
3077
 * @param height the height of the picture
3078
 * @return zero if successful, a negative value if not
3079
 */
3080
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3081

    
3082
/**
3083
 * Free a picture previously allocated by avpicture_alloc().
3084
 *
3085
 * @param picture the AVPicture to be freed
3086
 */
3087
void avpicture_free(AVPicture *picture);
3088

    
3089
/**
3090
 * Fill in the AVPicture fields.
3091
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3092
 * which points to the image data buffer. Depending on the specified picture
3093
 * format, one or multiple image data pointers and line sizes will be set.
3094
 * If a planar format is specified, several pointers will be set pointing to
3095
 * the different picture planes and the line sizes of the different planes
3096
 * will be stored in the lines_sizes array.
3097
 * Call with ptr == NULL to get the required size for the ptr buffer.
3098
 *
3099
 * @param picture AVPicture whose fields are to be filled in
3100
 * @param ptr Buffer which will contain or contains the actual image data
3101
 * @param pix_fmt The format in which the picture data is stored.
3102
 * @param width the width of the image in pixels
3103
 * @param height the height of the image in pixels
3104
 * @return size of the image data in bytes
3105
 */
3106
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3107
                   enum PixelFormat pix_fmt, int width, int height);
3108
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3109
                     unsigned char *dest, int dest_size);
3110

    
3111
/**
3112
 * Calculate the size in bytes that a picture of the given width and height
3113
 * would occupy if stored in the given picture format.
3114
 * Note that this returns the size of a compact representation as generated
3115
 * by avpicture_layout, which can be smaller than the size required for e.g.
3116
 * avpicture_fill.
3117
 *
3118
 * @param pix_fmt the given picture format
3119
 * @param width the width of the image
3120
 * @param height the height of the image
3121
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3122
 */
3123
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3124
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3125
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3126
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3127

    
3128
#if LIBAVCODEC_VERSION_MAJOR < 53
3129
/**
3130
 * Return the pixel format corresponding to the name name.
3131
 *
3132
 * If there is no pixel format with name name, then look for a
3133
 * pixel format with the name corresponding to the native endian
3134
 * format of name.
3135
 * For example in a little-endian system, first look for "gray16",
3136
 * then for "gray16le".
3137
 *
3138
 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3139
 *
3140
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3141
 */
3142
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3143
#endif
3144

    
3145
/**
3146
 * Return a value representing the fourCC code associated to the
3147
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3148
 * found.
3149
 */
3150
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3151

    
3152
/**
3153
 * Put a string representing the codec tag codec_tag in buf.
3154
 *
3155
 * @param buf_size size in bytes of buf
3156
 * @return the length of the string that would have been generated if
3157
 * enough space had been available, excluding the trailing null
3158
 */
3159
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3160

    
3161
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3162
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3163
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3164
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3165
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3166
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3167

    
3168
/**
3169
 * Compute what kind of losses will occur when converting from one specific
3170
 * pixel format to another.
3171
 * When converting from one pixel format to another, information loss may occur.
3172
 * For example, when converting from RGB24 to GRAY, the color information will
3173
 * be lost. Similarly, other losses occur when converting from some formats to
3174
 * other formats. These losses can involve loss of chroma, but also loss of
3175
 * resolution, loss of color depth, loss due to the color space conversion, loss
3176
 * of the alpha bits or loss due to color quantization.
3177
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3178
 * which will occur when converting from one pixel format to another.
3179
 *
3180
 * @param[in] dst_pix_fmt destination pixel format
3181
 * @param[in] src_pix_fmt source pixel format
3182
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3183
 * @return Combination of flags informing you what kind of losses will occur.
3184
 */
3185
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3186
                             int has_alpha);
3187

    
3188
/**
3189
 * Find the best pixel format to convert to given a certain source pixel
3190
 * format.  When converting from one pixel format to another, information loss
3191
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3192
 * information will be lost. Similarly, other losses occur when converting from
3193
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3194
 * the given pixel formats should be used to suffer the least amount of loss.
3195
 * The pixel formats from which it chooses one, are determined by the
3196
 * pix_fmt_mask parameter.
3197
 *
3198
 * @code
3199
 * src_pix_fmt = PIX_FMT_YUV420P;
3200
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3201
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3202
 * @endcode
3203
 *
3204
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3205
 * @param[in] src_pix_fmt source pixel format
3206
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3207
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3208
 * @return The best pixel format to convert to or -1 if none was found.
3209
 */
3210
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3211
                              int has_alpha, int *loss_ptr);
3212

    
3213

    
3214
/**
3215
 * Print in buf the string corresponding to the pixel format with
3216
 * number pix_fmt, or an header if pix_fmt is negative.
3217
 *
3218
 * @param[in] buf the buffer where to write the string
3219
 * @param[in] buf_size the size of buf
3220
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3221
 * a negative value to print the corresponding header.
3222
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3223
 */
3224
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3225

    
3226
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3227
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3228

    
3229
/**
3230
 * Tell if an image really has transparent alpha values.
3231
 * @return ored mask of FF_ALPHA_xxx constants
3232
 */
3233
int img_get_alpha_info(const AVPicture *src,
3234
                       enum PixelFormat pix_fmt, int width, int height);
3235

    
3236
/* deinterlace a picture */
3237
/* deinterlace - if not supported return -1 */
3238
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3239
                          enum PixelFormat pix_fmt, int width, int height);
3240

    
3241
/* external high level API */
3242

    
3243
/**
3244
 * If c is NULL, returns the first registered codec,
3245
 * if c is non-NULL, returns the next registered codec after c,
3246
 * or NULL if c is the last one.
3247
 */
3248
AVCodec *av_codec_next(AVCodec *c);
3249

    
3250
/**
3251
 * Return the LIBAVCODEC_VERSION_INT constant.
3252
 */
3253
unsigned avcodec_version(void);
3254

    
3255
/**
3256
 * Return the libavcodec build-time configuration.
3257
 */
3258
const char *avcodec_configuration(void);
3259

    
3260
/**
3261
 * Return the libavcodec license.
3262
 */
3263
const char *avcodec_license(void);
3264

    
3265
/**
3266
 * Initialize libavcodec.
3267
 *
3268
 * @warning This function must be called before any other libavcodec
3269
 * function.
3270
 */
3271
void avcodec_init(void);
3272

    
3273
#if LIBAVCODEC_VERSION_MAJOR < 53
3274
/**
3275
 * @deprecated Deprecated in favor of avcodec_register().
3276
 */
3277
attribute_deprecated void register_avcodec(AVCodec *codec);
3278
#endif
3279

    
3280
/**
3281
 * Register the codec codec and initialize libavcodec.
3282
 *
3283
 * @see avcodec_init()
3284
 */
3285
void avcodec_register(AVCodec *codec);
3286

    
3287
/**
3288
 * Find a registered encoder with a matching codec ID.
3289
 *
3290
 * @param id CodecID of the requested encoder
3291
 * @return An encoder if one was found, NULL otherwise.
3292
 */
3293
AVCodec *avcodec_find_encoder(enum CodecID id);
3294

    
3295
/**
3296
 * Find a registered encoder with the specified name.
3297
 *
3298
 * @param name name of the requested encoder
3299
 * @return An encoder if one was found, NULL otherwise.
3300
 */
3301
AVCodec *avcodec_find_encoder_by_name(const char *name);
3302

    
3303
/**
3304
 * Find a registered decoder with a matching codec ID.
3305
 *
3306
 * @param id CodecID of the requested decoder
3307
 * @return A decoder if one was found, NULL otherwise.
3308
 */
3309
AVCodec *avcodec_find_decoder(enum CodecID id);
3310

    
3311
/**
3312
 * Find a registered decoder with the specified name.
3313
 *
3314
 * @param name name of the requested decoder
3315
 * @return A decoder if one was found, NULL otherwise.
3316
 */
3317
AVCodec *avcodec_find_decoder_by_name(const char *name);
3318
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3319

    
3320
/**
3321
 * Set the fields of the given AVCodecContext to default values.
3322
 *
3323
 * @param s The AVCodecContext of which the fields should be set to default values.
3324
 */
3325
void avcodec_get_context_defaults(AVCodecContext *s);
3326

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

    
3331
/**
3332
 * Allocate an AVCodecContext and set its fields to default values.  The
3333
 * resulting struct can be deallocated by simply calling av_free().
3334
 *
3335
 * @return An AVCodecContext filled with default values or NULL on failure.
3336
 * @see avcodec_get_context_defaults
3337
 */
3338
AVCodecContext *avcodec_alloc_context(void);
3339

    
3340
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3341
 *  we WILL change its arguments and name a few times! */
3342
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3343

    
3344
/**
3345
 * Copy the settings of the source AVCodecContext into the destination
3346
 * AVCodecContext. The resulting destination codec context will be
3347
 * unopened, i.e. you are required to call avcodec_open() before you
3348
 * can use this AVCodecContext to decode/encode video/audio data.
3349
 *
3350
 * @param dest target codec context, should be initialized with
3351
 *             avcodec_alloc_context(), but otherwise uninitialized
3352
 * @param src source codec context
3353
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3354
 */
3355
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3356

    
3357
/**
3358
 * Set the fields of the given AVFrame to default values.
3359
 *
3360
 * @param pic The AVFrame of which the fields should be set to default values.
3361
 */
3362
void avcodec_get_frame_defaults(AVFrame *pic);
3363

    
3364
/**
3365
 * Allocate an AVFrame and set its fields to default values.  The resulting
3366
 * struct can be deallocated by simply calling av_free().
3367
 *
3368
 * @return An AVFrame filled with default values or NULL on failure.
3369
 * @see avcodec_get_frame_defaults
3370
 */
3371
AVFrame *avcodec_alloc_frame(void);
3372

    
3373
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3374
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3375
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3376

    
3377
/**
3378
 * Return the amount of padding in pixels which the get_buffer callback must
3379
 * provide around the edge of the image for codecs which do not have the
3380
 * CODEC_FLAG_EMU_EDGE flag.
3381
 *
3382
 * @return Required padding in pixels.
3383
 */
3384
unsigned avcodec_get_edge_width(void);
3385
/**
3386
 * Modify width and height values so that they will result in a memory
3387
 * buffer that is acceptable for the codec if you do not use any horizontal
3388
 * padding.
3389
 *
3390
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3391
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3392
 * according to avcodec_get_edge_width() before.
3393
 */
3394
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3395
/**
3396
 * Modify width and height values so that they will result in a memory
3397
 * buffer that is acceptable for the codec if you also ensure that all
3398
 * line sizes are a multiple of the respective linesize_align[i].
3399
 *
3400
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3401
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3402
 * according to avcodec_get_edge_width() before.
3403
 */
3404
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3405
                               int linesize_align[4]);
3406

    
3407
#if LIBAVCODEC_VERSION_MAJOR < 53
3408
/**
3409
 * @deprecated Deprecated in favor of av_check_image_size().
3410
 */
3411
attribute_deprecated
3412
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3413
#endif
3414

    
3415
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3416

    
3417
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3418
void avcodec_thread_free(AVCodecContext *s);
3419
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3420
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3421
//FIXME func typedef
3422

    
3423
/**
3424
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3425
 * function the context has to be allocated.
3426
 *
3427
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3428
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3429
 * retrieving a codec.
3430
 *
3431
 * @warning This function is not thread safe!
3432
 *
3433
 * @code
3434
 * avcodec_register_all();
3435
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3436
 * if (!codec)
3437
 *     exit(1);
3438
 *
3439
 * context = avcodec_alloc_context();
3440
 *
3441
 * if (avcodec_open(context, codec) < 0)
3442
 *     exit(1);
3443
 * @endcode
3444
 *
3445
 * @param avctx The context which will be set up to use the given codec.
3446
 * @param codec The codec to use within the context.
3447
 * @return zero on success, a negative value on error
3448
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3449
 */
3450
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3451

    
3452
#if LIBAVCODEC_VERSION_MAJOR < 53
3453
/**
3454
 * Decode an audio frame from buf into samples.
3455
 * Wrapper function which calls avcodec_decode_audio3.
3456
 *
3457
 * @deprecated Use avcodec_decode_audio3 instead.
3458
 * @param avctx the codec context
3459
 * @param[out] samples the output buffer
3460
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3461
 * @param[in] buf the input buffer
3462
 * @param[in] buf_size the input buffer size in bytes
3463
 * @return On error a negative value is returned, otherwise the number of bytes
3464
 * used or zero if no frame could be decompressed.
3465
 */
3466
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3467
                         int *frame_size_ptr,
3468
                         const uint8_t *buf, int buf_size);
3469
#endif
3470

    
3471
/**
3472
 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3473
 * Some decoders may support multiple frames in a single AVPacket, such
3474
 * decoders would then just decode the first frame. In this case,
3475
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3476
 * the remaining data in order to decode the second frame etc.
3477
 * If no frame
3478
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3479
 * decompressed frame size in bytes.
3480
 *
3481
 * @warning You must set frame_size_ptr to the allocated size of the
3482
 * output buffer before calling avcodec_decode_audio3().
3483
 *
3484
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3485
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3486
 * bits at once and could read over the end.
3487
 *
3488
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3489
 * no overreading happens for damaged MPEG streams.
3490
 *
3491
 * @note You might have to align the input buffer avpkt->data and output buffer
3492
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3493
 * necessary at all, on others it won't work at all if not aligned and on others
3494
 * it will work but it will have an impact on performance.
3495
 *
3496
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3497
 * samples should be 16 byte aligned unless the CPU doesn't need it
3498
 * (AltiVec and SSE do).
3499
 *
3500
 * @param avctx the codec context
3501
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3502
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3503
 * @param[in] avpkt The input AVPacket containing the input buffer.
3504
 *            You can create such packet with av_init_packet() and by then setting
3505
 *            data and size, some decoders might in addition need other fields.
3506
 *            All decoders are designed to use the least fields possible though.
3507
 * @return On error a negative value is returned, otherwise the number of bytes
3508
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3509
 */
3510
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3511
                         int *frame_size_ptr,
3512
                         AVPacket *avpkt);
3513

    
3514
#if LIBAVCODEC_VERSION_MAJOR < 53
3515
/**
3516
 * Decode a video frame from buf into picture.
3517
 * Wrapper function which calls avcodec_decode_video2.
3518
 *
3519
 * @deprecated Use avcodec_decode_video2 instead.
3520
 * @param avctx the codec context
3521
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3522
 * @param[in] buf the input buffer
3523
 * @param[in] buf_size the size of the input buffer in bytes
3524
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3525
 * @return On error a negative value is returned, otherwise the number of bytes
3526
 * used or zero if no frame could be decompressed.
3527
 */
3528
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3529
                         int *got_picture_ptr,
3530
                         const uint8_t *buf, int buf_size);
3531
#endif
3532

    
3533
/**
3534
 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3535
 * Some decoders may support multiple frames in a single AVPacket, such
3536
 * decoders would then just decode the first frame.
3537
 *
3538
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3539
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3540
 * bits at once and could read over the end.
3541
 *
3542
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3543
 * no overreading happens for damaged MPEG streams.
3544
 *
3545
 * @note You might have to align the input buffer avpkt->data.
3546
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3547
 * necessary at all, on others it won't work at all if not aligned and on others
3548
 * it will work but it will have an impact on performance.
3549
 *
3550
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3551
 *
3552
 * @note Some codecs have a delay between input and output, these need to be
3553
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3554
 *
3555
 * @param avctx the codec context
3556
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3557
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3558
 *             allocate memory for the actual bitmap.
3559
 *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3560
 *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3561
 *                   decodes and the decoder tells the user once it does not need the data anymore,
3562
 *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3563
 *
3564
 * @param[in] avpkt The input AVpacket containing the input buffer.
3565
 *            You can create such packet with av_init_packet() and by then setting
3566
 *            data and size, some decoders might in addition need other fields like
3567
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3568
 *            fields possible.
3569
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3570
 * @return On error a negative value is returned, otherwise the number of bytes
3571
 * used or zero if no frame could be decompressed.
3572
 */
3573
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3574
                         int *got_picture_ptr,
3575
                         AVPacket *avpkt);
3576

    
3577
#if LIBAVCODEC_VERSION_MAJOR < 53
3578
/* Decode a subtitle message. Return -1 if error, otherwise return the
3579
 * number of bytes used. If no subtitle could be decompressed,
3580
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3581
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3582
                            int *got_sub_ptr,
3583
                            const uint8_t *buf, int buf_size);
3584
#endif
3585

    
3586
/**
3587
 * Decode a subtitle message.
3588
 * Return a negative value on error, otherwise return the number of bytes used.
3589
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3590
 * Otherwise, the subtitle is stored in *sub.
3591
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3592
 * simplicity, because the performance difference is expect to be negligible
3593
 * and reusing a get_buffer written for video codecs would probably perform badly
3594
 * due to a potentially very different allocation pattern.
3595
 *
3596
 * @param avctx the codec context
3597
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3598
                   freed with avsubtitle_free if *got_sub_ptr is set.
3599
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3600
 * @param[in] avpkt The input AVPacket containing the input buffer.
3601
 */
3602
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3603
                            int *got_sub_ptr,
3604
                            AVPacket *avpkt);
3605

    
3606
/**
3607
 * Frees all allocated data in the given subtitle struct.
3608
 *
3609
 * @param sub AVSubtitle to free.
3610
 */
3611
void avsubtitle_free(AVSubtitle *sub);
3612

    
3613
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3614
                        int *data_size_ptr,
3615
                        uint8_t *buf, int buf_size);
3616

    
3617
/**
3618
 * Encode an audio frame from samples into buf.
3619
 *
3620
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3621
 * However, for PCM audio the user will know how much space is needed
3622
 * because it depends on the value passed in buf_size as described
3623
 * below. In that case a lower value can be used.
3624
 *
3625
 * @param avctx the codec context
3626
 * @param[out] buf the output buffer
3627
 * @param[in] buf_size the output buffer size
3628
 * @param[in] samples the input buffer containing the samples
3629
 * The number of samples read from this buffer is frame_size*channels,
3630
 * both of which are defined in avctx.
3631
 * For PCM audio the number of samples read from samples is equal to
3632
 * buf_size * input_sample_size / output_sample_size.
3633
 * @return On error a negative value is returned, on success zero or the number
3634
 * of bytes used to encode the data read from the input buffer.
3635
 */
3636
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3637
                         const short *samples);
3638

    
3639
/**
3640
 * Encode a video frame from pict into buf.
3641
 * The input picture should be
3642
 * stored using a specific format, namely avctx.pix_fmt.
3643
 *
3644
 * @param avctx the codec context
3645
 * @param[out] buf the output buffer for the bitstream of encoded frame
3646
 * @param[in] buf_size the size of the output buffer in bytes
3647
 * @param[in] pict the input picture to encode
3648
 * @return On error a negative value is returned, on success zero or the number
3649
 * of bytes used from the output buffer.
3650
 */
3651
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3652
                         const AVFrame *pict);
3653
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3654
                            const AVSubtitle *sub);
3655

    
3656
int avcodec_close(AVCodecContext *avctx);
3657

    
3658
/**
3659
 * Register all the codecs, parsers and bitstream filters which were enabled at
3660
 * configuration time. If you do not call this function you can select exactly
3661
 * which formats you want to support, by using the individual registration
3662
 * functions.
3663
 *
3664
 * @see avcodec_register
3665
 * @see av_register_codec_parser
3666
 * @see av_register_bitstream_filter
3667
 */
3668
void avcodec_register_all(void);
3669

    
3670
/**
3671
 * Flush buffers, should be called when seeking or when switching to a different stream.
3672
 */
3673
void avcodec_flush_buffers(AVCodecContext *avctx);
3674

    
3675
void avcodec_default_free_buffers(AVCodecContext *s);
3676

    
3677
/* misc useful functions */
3678

    
3679
/**
3680
 * Return a single letter to describe the given picture type pict_type.
3681
 *
3682
 * @param[in] pict_type the picture type
3683
 * @return A single character representing the picture type.
3684
 */
3685
char av_get_pict_type_char(int pict_type);
3686

    
3687
/**
3688
 * Return codec bits per sample.
3689
 *
3690
 * @param[in] codec_id the codec
3691
 * @return Number of bits per sample or zero if unknown for the given codec.
3692
 */
3693
int av_get_bits_per_sample(enum CodecID codec_id);
3694

    
3695
/**
3696
 * Return sample format bits per sample.
3697
 *
3698
 * @param[in] sample_fmt the sample format
3699
 * @return Number of bits per sample or zero if unknown for the given sample format.
3700
 */
3701
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3702

    
3703
/* frame parsing */
3704
typedef struct AVCodecParserContext {
3705
    void *priv_data;
3706
    struct AVCodecParser *parser;
3707
    int64_t frame_offset; /* offset of the current frame */
3708
    int64_t cur_offset; /* current offset
3709
                           (incremented by each av_parser_parse()) */
3710
    int64_t next_frame_offset; /* offset of the next frame */
3711
    /* video info */
3712
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3713
    /**
3714
     * This field is used for proper frame duration computation in lavf.
3715
     * It signals, how much longer the frame duration of the current frame
3716
     * is compared to normal frame duration.
3717
     *
3718
     * frame_duration = (1 + repeat_pict) * time_base
3719
     *
3720
     * It is used by codecs like H.264 to display telecined material.
3721
     */
3722
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3723
    int64_t pts;     /* pts of the current frame */
3724
    int64_t dts;     /* dts of the current frame */
3725

    
3726
    /* private data */
3727
    int64_t last_pts;
3728
    int64_t last_dts;
3729
    int fetch_timestamp;
3730

    
3731
#define AV_PARSER_PTS_NB 4
3732
    int cur_frame_start_index;
3733
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3734
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3735
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3736

    
3737
    int flags;
3738
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3739
#define PARSER_FLAG_ONCE                      0x0002
3740

    
3741
    int64_t offset;      ///< byte offset from starting packet start
3742
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3743

    
3744
    /*!
3745
     * Set by parser to 1 for key frames and 0 for non-key frames.
3746
     * It is initialized to -1, so if the parser doesn't set this flag,
3747
     * old-style fallback using FF_I_TYPE picture type as key frames
3748
     * will be used.
3749
     */
3750
    int key_frame;
3751

    
3752
    /**
3753
     * Time difference in stream time base units from the pts of this
3754
     * packet to the point at which the output from the decoder has converged
3755
     * independent from the availability of previous frames. That is, the
3756
     * frames are virtually identical no matter if decoding started from
3757
     * the very first frame or from this keyframe.
3758
     * Is AV_NOPTS_VALUE if unknown.
3759
     * This field is not the display duration of the current frame.
3760
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3761
     * set.
3762
     *
3763
     * The purpose of this field is to allow seeking in streams that have no
3764
     * keyframes in the conventional sense. It corresponds to the
3765
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3766
     * essential for some types of subtitle streams to ensure that all
3767
     * subtitles are correctly displayed after seeking.
3768
     */
3769
    int64_t convergence_duration;
3770

    
3771
    // Timestamp generation support:
3772
    /**
3773
     * Synchronization point for start of timestamp generation.
3774
     *
3775
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3776
     * (default).
3777
     *
3778
     * For example, this corresponds to presence of H.264 buffering period
3779
     * SEI message.
3780
     */
3781
    int dts_sync_point;
3782

    
3783
    /**
3784
     * Offset of the current timestamp against last timestamp sync point in
3785
     * units of AVCodecContext.time_base.
3786
     *
3787
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3788
     * contain a valid timestamp offset.
3789
     *
3790
     * Note that the timestamp of sync point has usually a nonzero
3791
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3792
     * the next frame after timestamp sync point will be usually 1.
3793
     *
3794
     * For example, this corresponds to H.264 cpb_removal_delay.
3795
     */
3796
    int dts_ref_dts_delta;
3797

    
3798
    /**
3799
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3800
     *
3801
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3802
     * contain valid non-negative timestamp delta (presentation time of a frame
3803
     * must not lie in the past).
3804
     *
3805
     * This delay represents the difference between decoding and presentation
3806
     * time of the frame.
3807
     *
3808
     * For example, this corresponds to H.264 dpb_output_delay.
3809
     */
3810
    int pts_dts_delta;
3811

    
3812
    /**
3813
     * Position of the packet in file.
3814
     *
3815
     * Analogous to cur_frame_pts/dts
3816
     */
3817
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3818

    
3819
    /**
3820
     * Byte position of currently parsed frame in stream.
3821
     */
3822
    int64_t pos;
3823

    
3824
    /**
3825
     * Previous frame byte position.
3826
     */
3827
    int64_t last_pos;
3828
} AVCodecParserContext;
3829

    
3830
typedef struct AVCodecParser {
3831
    int codec_ids[5]; /* several codec IDs are permitted */
3832
    int priv_data_size;
3833
    int (*parser_init)(AVCodecParserContext *s);
3834
    int (*parser_parse)(AVCodecParserContext *s,
3835
                        AVCodecContext *avctx,
3836
                        const uint8_t **poutbuf, int *poutbuf_size,
3837
                        const uint8_t *buf, int buf_size);
3838
    void (*parser_close)(AVCodecParserContext *s);
3839
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3840
    struct AVCodecParser *next;
3841
} AVCodecParser;
3842

    
3843
AVCodecParser *av_parser_next(AVCodecParser *c);
3844

    
3845
void av_register_codec_parser(AVCodecParser *parser);
3846
AVCodecParserContext *av_parser_init(int codec_id);
3847

    
3848
#if LIBAVCODEC_VERSION_MAJOR < 53
3849
attribute_deprecated
3850
int av_parser_parse(AVCodecParserContext *s,
3851
                    AVCodecContext *avctx,
3852
                    uint8_t **poutbuf, int *poutbuf_size,
3853
                    const uint8_t *buf, int buf_size,
3854
                    int64_t pts, int64_t dts);
3855
#endif
3856

    
3857
/**
3858
 * Parse a packet.
3859
 *
3860
 * @param s             parser context.
3861
 * @param avctx         codec context.
3862
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3863
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3864
 * @param buf           input buffer.
3865
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3866
 * @param pts           input presentation timestamp.
3867
 * @param dts           input decoding timestamp.
3868
 * @param pos           input byte position in stream.
3869
 * @return the number of bytes of the input bitstream used.
3870
 *
3871
 * Example:
3872
 * @code
3873
 *   while(in_len){
3874
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3875
 *                                        in_data, in_len,
3876
 *                                        pts, dts, pos);
3877
 *       in_data += len;
3878
 *       in_len  -= len;
3879
 *
3880
 *       if(size)
3881
 *          decode_frame(data, size);
3882
 *   }
3883
 * @endcode
3884
 */
3885
int av_parser_parse2(AVCodecParserContext *s,
3886
                     AVCodecContext *avctx,
3887
                     uint8_t **poutbuf, int *poutbuf_size,
3888
                     const uint8_t *buf, int buf_size,
3889
                     int64_t pts, int64_t dts,
3890
                     int64_t pos);
3891

    
3892
int av_parser_change(AVCodecParserContext *s,
3893
                     AVCodecContext *avctx,
3894
                     uint8_t **poutbuf, int *poutbuf_size,
3895
                     const uint8_t *buf, int buf_size, int keyframe);
3896
void av_parser_close(AVCodecParserContext *s);
3897

    
3898

    
3899
typedef struct AVBitStreamFilterContext {
3900
    void *priv_data;
3901
    struct AVBitStreamFilter *filter;
3902
    AVCodecParserContext *parser;
3903
    struct AVBitStreamFilterContext *next;
3904
} AVBitStreamFilterContext;
3905

    
3906

    
3907
typedef struct AVBitStreamFilter {
3908
    const char *name;
3909
    int priv_data_size;
3910
    int (*filter)(AVBitStreamFilterContext *bsfc,
3911
                  AVCodecContext *avctx, const char *args,
3912
                  uint8_t **poutbuf, int *poutbuf_size,
3913
                  const uint8_t *buf, int buf_size, int keyframe);
3914
    void (*close)(AVBitStreamFilterContext *bsfc);
3915
    struct AVBitStreamFilter *next;
3916
} AVBitStreamFilter;
3917

    
3918
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3919
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3920
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3921
                               AVCodecContext *avctx, const char *args,
3922
                               uint8_t **poutbuf, int *poutbuf_size,
3923
                               const uint8_t *buf, int buf_size, int keyframe);
3924
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3925

    
3926
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3927

    
3928
/* memory */
3929

    
3930
/**
3931
 * Reallocate the given block if it is not large enough, otherwise do nothing.
3932
 *
3933
 * @see av_realloc
3934
 */
3935
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3936

    
3937
/**
3938
 * Allocate a buffer, reusing the given one if large enough.
3939
 *
3940
 * Contrary to av_fast_realloc the current buffer contents might not be
3941
 * preserved and on error the old buffer is freed, thus no special
3942
 * handling to avoid memleaks is necessary.
3943
 *
3944
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3945
 * @param size size of the buffer *ptr points to
3946
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3947
 *                 *size 0 if an error occurred.
3948
 */
3949
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3950

    
3951
/**
3952
 * Copy image data in src_data to dst_data.
3953
 *
3954
 * @param dst_linesize linesizes for the image in dst_data
3955
 * @param src_linesize linesizes for the image in src_data
3956
 */
3957
void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
3958
                          uint8_t *src_data[4], int src_linesize[4],
3959
                          enum PixelFormat pix_fmt, int width, int height);
3960

    
3961
/**
3962
 * Copy image src to dst. Wraps av_picture_data_copy() above.
3963
 */
3964
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3965
                     enum PixelFormat pix_fmt, int width, int height);
3966

    
3967
/**
3968
 * Crop image top and left side.
3969
 */
3970
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3971
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3972

    
3973
/**
3974
 * Pad image.
3975
 */
3976
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3977
            int padtop, int padbottom, int padleft, int padright, int *color);
3978

    
3979
/**
3980
 * Encode extradata length to a buffer. Used by xiph codecs.
3981
 *
3982
 * @param s buffer to write to; must be at least (v/255+1) bytes long
3983
 * @param v size of extradata in bytes
3984
 * @return number of bytes written to the buffer.
3985
 */
3986
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3987

    
3988
#if LIBAVCODEC_VERSION_MAJOR < 53
3989
/**
3990
 * Parse str and put in width_ptr and height_ptr the detected values.
3991
 *
3992
 * @deprecated Deprecated in favor of av_parse_video_size().
3993
 */
3994
attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3995

    
3996
/**
3997
 * Parse str and store the detected values in *frame_rate.
3998
 *
3999
 * @deprecated Deprecated in favor of av_parse_video_rate().
4000
 */
4001
attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4002
#endif
4003

    
4004
/**
4005
 * Logs a generic warning message about a missing feature. This function is
4006
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4007
 * only, and would normally not be used by applications.
4008
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4009
 * a pointer to an AVClass struct
4010
 * @param[in] feature string containing the name of the missing feature
4011
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4012
 * If want_sample is non-zero, additional verbage will be added to the log
4013
 * message which tells the user how to report samples to the development
4014
 * mailing list.
4015
 */
4016
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4017

    
4018
/**
4019
 * Log a generic warning message asking for a sample. This function is
4020
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4021
 * only, and would normally not be used by applications.
4022
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4023
 * a pointer to an AVClass struct
4024
 * @param[in] msg string containing an optional message, or NULL if no message
4025
 */
4026
void av_log_ask_for_sample(void *avc, const char *msg);
4027

    
4028
/**
4029
 * Register the hardware accelerator hwaccel.
4030
 */
4031
void av_register_hwaccel(AVHWAccel *hwaccel);
4032

    
4033
/**
4034
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4035
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4036
 * after hwaccel, or NULL if hwaccel is the last one.
4037
 */
4038
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4039

    
4040

    
4041
/**
4042
 * Lock operation used by lockmgr
4043
 */
4044
enum AVLockOp {
4045
  AV_LOCK_CREATE,  ///< Create a mutex
4046
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4047
  AV_LOCK_RELEASE, ///< Unlock the mutex
4048
  AV_LOCK_DESTROY, ///< Free mutex resources
4049
};
4050

    
4051
/**
4052
 * Register a user provided lock manager supporting the operations
4053
 * specified by AVLockOp. mutex points to a (void *) where the
4054
 * lockmgr should store/get a pointer to a user allocated mutex. It's
4055
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4056
 *
4057
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4058
 *           callback during the call to av_lockmgr_register().
4059
 *           Thus, the application must be prepared to handle that.
4060
 *           If cb is set to NULL the lockmgr will be unregistered.
4061
 *           Also note that during unregistration the previously registered
4062
 *           lockmgr callback may also be invoked.
4063
 */
4064
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4065

    
4066
#endif /* AVCODEC_AVCODEC_H */