Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ edd259f9

History | View | Annotate | Download (128 KB)

1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20

    
21
#ifndef AVCODEC_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

    
24
/**
25
 * @file
26
 * external API header
27
 */
28

    
29
#include <errno.h>
30
#include "libavutil/avutil.h"
31

    
32
#define LIBAVCODEC_VERSION_MAJOR 52
33
#define LIBAVCODEC_VERSION_MINOR 67
34
#define LIBAVCODEC_VERSION_MICRO  1
35

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

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

    
46
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
47
#define AV_TIME_BASE            1000000
48
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
49

    
50
/**
51
 * Identifies the syntax and semantics of the bitstream.
52
 * The principle is roughly:
53
 * Two decoders with the same ID can decode the same streams.
54
 * Two encoders with the same ID can encode compatible streams.
55
 * There may be slight deviations from the principle due to implementation
56
 * details.
57
 *
58
 * If you add a codec ID to this list, add it so that
59
 * 1. no value of a existing codec ID changes (that would break ABI),
60
 * 2. it is as close as possible to similar codecs.
61
 */
62
enum CodecID {
63
    CODEC_ID_NONE,
64

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

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

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

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

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

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

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

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

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

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

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

    
358
#if LIBAVCODEC_VERSION_MAJOR < 53
359
#define CodecType AVMediaType
360

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

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

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

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

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

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

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

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

    
446

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

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

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

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

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

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

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

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

    
534
#define FF_MAX_B_FRAMES 16
535

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

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

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

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

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

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

    
685
    /**
686
     * width and height in 1/16 pel
687
     * - encoding: Set by user.
688
     * - decoding: Set by libavcodec.
689
     */
690
    int width;
691
    int height;
692

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

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

    
928

    
929
#define FF_QSCALE_TYPE_MPEG1 0
930
#define FF_QSCALE_TYPE_MPEG2 1
931
#define FF_QSCALE_TYPE_H264  2
932
#define FF_QSCALE_TYPE_VP56  3
933

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

    
939

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

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

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

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

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

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

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

    
1046
    /**
1047
     * CODEC_FLAG_*.
1048
     * - encoding: Set by user.
1049
     * - decoding: Set by user.
1050
     */
1051
    int flags;
1052

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

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

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

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

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

    
1106
#define FF_ASPECT_EXTENDED 15
1107

    
1108
    /**
1109
     * the number of pictures in a group of pictures, or 0 for intra_only
1110
     * - encoding: Set by user.
1111
     * - decoding: unused
1112
     */
1113
    int gop_size;
1114

    
1115
    /**
1116
     * Pixel format, see PIX_FMT_xxx.
1117
     * - encoding: Set by user.
1118
     * - decoding: Set by libavcodec.
1119
     */
1120
    enum PixelFormat pix_fmt;
1121

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

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

    
1153
    /* audio only */
1154
    int sample_rate; ///< samples per second
1155
    int channels;    ///< number of audio channels
1156

    
1157
    /**
1158
     * audio sample format
1159
     * - encoding: Set by user.
1160
     * - decoding: Set by libavcodec.
1161
     */
1162
    enum SampleFormat sample_fmt;  ///< sample format
1163

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

    
1174
    /**
1175
     * Number of frames the decoded output will be delayed relative to
1176
     * the encoded input.
1177
     * - encoding: Set by libavcodec.
1178
     * - decoding: unused
1179
     */
1180
    int delay;
1181

    
1182
    /* - encoding parameters */
1183
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1184
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1185

    
1186
    /**
1187
     * minimum quantizer
1188
     * - encoding: Set by user.
1189
     * - decoding: unused
1190
     */
1191
    int qmin;
1192

    
1193
    /**
1194
     * maximum quantizer
1195
     * - encoding: Set by user.
1196
     * - decoding: unused
1197
     */
1198
    int qmax;
1199

    
1200
    /**
1201
     * maximum quantizer difference between frames
1202
     * - encoding: Set by user.
1203
     * - decoding: unused
1204
     */
1205
    int max_qdiff;
1206

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

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

    
1224
    /** obsolete FIXME remove */
1225
    int rc_strategy;
1226
#define FF_RC_STRATEGY_XVID 1
1227

    
1228
    int b_frame_strategy;
1229

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

    
1238
    struct AVCodec *codec;
1239

    
1240
    void *priv_data;
1241

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

    
1249

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

    
1258
    /* statistics, used for 2-pass encoding */
1259
    int mv_bits;
1260
    int header_bits;
1261
    int i_tex_bits;
1262
    int p_tex_bits;
1263
    int i_count;
1264
    int p_count;
1265
    int skip_count;
1266
    int misc_bits;
1267

    
1268
    /**
1269
     * number of bits used for the previously encoded frame
1270
     * - encoding: Set by libavcodec.
1271
     * - decoding: unused
1272
     */
1273
    int frame_bits;
1274

    
1275
    /**
1276
     * Private data of the user, can be used to carry app specific stuff.
1277
     * - encoding: Set by user.
1278
     * - decoding: Set by user.
1279
     */
1280
    void *opaque;
1281

    
1282
    char codec_name[32];
1283
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1284
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1285

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

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

    
1325
    /**
1326
     * luma single coefficient elimination threshold
1327
     * - encoding: Set by user.
1328
     * - decoding: unused
1329
     */
1330
    int luma_elim_threshold;
1331

    
1332
    /**
1333
     * chroma single coeff elimination threshold
1334
     * - encoding: Set by user.
1335
     * - decoding: unused
1336
     */
1337
    int chroma_elim_threshold;
1338

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

    
1358
    /**
1359
     * qscale offset between IP and B-frames
1360
     * - encoding: Set by user.
1361
     * - decoding: unused
1362
     */
1363
    float b_quant_offset;
1364

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

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

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

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

    
1407
    /**
1408
     * number of bytes per packet if constant and known or 0
1409
     * Used by some WAV based audio codecs.
1410
     */
1411
    int block_align;
1412

    
1413
    int parse_only; /* - decoding only: If true, only parsing is done
1414
                       (function avcodec_parse_frame()). The frame
1415
                       data is returned. Only MPEG codecs support this now. */
1416

    
1417
    /**
1418
     * 0-> h263 quant 1-> mpeg quant
1419
     * - encoding: Set by user.
1420
     * - decoding: unused
1421
     */
1422
    int mpeg_quant;
1423

    
1424
    /**
1425
     * pass1 encoding statistics output buffer
1426
     * - encoding: Set by libavcodec.
1427
     * - decoding: unused
1428
     */
1429
    char *stats_out;
1430

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

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

    
1447
    float rc_qmod_amp;
1448
    int rc_qmod_freq;
1449

    
1450
    /**
1451
     * ratecontrol override, see RcOverride
1452
     * - encoding: Allocated/set/freed by user.
1453
     * - decoding: unused
1454
     */
1455
    RcOverride *rc_override;
1456
    int rc_override_count;
1457

    
1458
    /**
1459
     * rate control equation
1460
     * - encoding: Set by user
1461
     * - decoding: unused
1462
     */
1463
    const char *rc_eq;
1464

    
1465
    /**
1466
     * maximum bitrate
1467
     * - encoding: Set by user.
1468
     * - decoding: unused
1469
     */
1470
    int rc_max_rate;
1471

    
1472
    /**
1473
     * minimum bitrate
1474
     * - encoding: Set by user.
1475
     * - decoding: unused
1476
     */
1477
    int rc_min_rate;
1478

    
1479
    /**
1480
     * decoder bitstream buffer size
1481
     * - encoding: Set by user.
1482
     * - decoding: unused
1483
     */
1484
    int rc_buffer_size;
1485
    float rc_buffer_aggressivity;
1486

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

    
1496
    /**
1497
     * qscale offset between P and I-frames
1498
     * - encoding: Set by user.
1499
     * - decoding: unused
1500
     */
1501
    float i_quant_offset;
1502

    
1503
    /**
1504
     * initial complexity for pass1 ratecontrol
1505
     * - encoding: Set by user.
1506
     * - decoding: unused
1507
     */
1508
    float rc_initial_cplx;
1509

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

    
1524
    /**
1525
     * luminance masking (0-> disabled)
1526
     * - encoding: Set by user.
1527
     * - decoding: unused
1528
     */
1529
    float lumi_masking;
1530

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

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

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

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

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

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

    
1604
    /**
1605
     * error concealment flags
1606
     * - encoding: unused
1607
     * - decoding: Set by user.
1608
     */
1609
    int error_concealment;
1610
#define FF_EC_GUESS_MVS   1
1611
#define FF_EC_DEBLOCK     2
1612

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

    
1640
    /**
1641
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1642
     * - encoding: Set by libavcodec.
1643
     * - decoding: Set by user.
1644
     */
1645
     int bits_per_coded_sample;
1646

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

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

    
1666
    /**
1667
     * the picture in the bitstream
1668
     * - encoding: Set by libavcodec.
1669
     * - decoding: Set by libavcodec.
1670
     */
1671
    AVFrame *coded_frame;
1672

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

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

    
1706
    /**
1707
     * error
1708
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1709
     * - decoding: unused
1710
     */
1711
    uint64_t error[4];
1712

    
1713
    /**
1714
     * minimum MB quantizer
1715
     * - encoding: unused
1716
     * - decoding: unused
1717
     */
1718
    int mb_qmin;
1719

    
1720
    /**
1721
     * maximum MB quantizer
1722
     * - encoding: unused
1723
     * - decoding: unused
1724
     */
1725
    int mb_qmax;
1726

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

    
1768
    /**
1769
     * ME diamond size & shape
1770
     * - encoding: Set by user.
1771
     * - decoding: unused
1772
     */
1773
    int dia_size;
1774

    
1775
    /**
1776
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1777
     * - encoding: Set by user.
1778
     * - decoding: unused
1779
     */
1780
    int last_predictor_count;
1781

    
1782
    /**
1783
     * prepass for motion estimation
1784
     * - encoding: Set by user.
1785
     * - decoding: unused
1786
     */
1787
    int pre_me;
1788

    
1789
    /**
1790
     * motion estimation prepass comparison function
1791
     * - encoding: Set by user.
1792
     * - decoding: unused
1793
     */
1794
    int me_pre_cmp;
1795

    
1796
    /**
1797
     * ME prepass diamond size & shape
1798
     * - encoding: Set by user.
1799
     * - decoding: unused
1800
     */
1801
    int pre_dia_size;
1802

    
1803
    /**
1804
     * subpel ME quality
1805
     * - encoding: Set by user.
1806
     * - decoding: unused
1807
     */
1808
    int me_subpel_quality;
1809

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

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

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

    
1847
    /**
1848
     * intra quantizer bias
1849
     * - encoding: Set by user.
1850
     * - decoding: unused
1851
     */
1852
    int intra_quant_bias;
1853
#define FF_DEFAULT_QUANT_BIAS 999999
1854

    
1855
    /**
1856
     * inter quantizer bias
1857
     * - encoding: Set by user.
1858
     * - decoding: unused
1859
     */
1860
    int inter_quant_bias;
1861

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

    
1870
    /**
1871
     * internal_buffer count
1872
     * Don't touch, used by libavcodec default_get_buffer().
1873
     */
1874
    int internal_buffer_count;
1875

    
1876
    /**
1877
     * internal_buffers
1878
     * Don't touch, used by libavcodec default_get_buffer().
1879
     */
1880
    void *internal_buffer;
1881

    
1882
#define FF_LAMBDA_SHIFT 7
1883
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1884
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1885
#define FF_LAMBDA_MAX (256*128-1)
1886

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

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

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

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

    
1933
    /**
1934
     * XVideo Motion Acceleration
1935
     * - encoding: forbidden
1936
     * - decoding: set by decoder
1937
     */
1938
    int xvmc_acceleration;
1939

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

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

    
1957
    /**
1958
     * custom inter quantization matrix
1959
     * - encoding: Set by user, can be NULL.
1960
     * - decoding: Set by libavcodec.
1961
     */
1962
    uint16_t *inter_matrix;
1963

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

    
1972
    /**
1973
     * scene change detection threshold
1974
     * 0 is default, larger means fewer detected scene changes.
1975
     * - encoding: Set by user.
1976
     * - decoding: unused
1977
     */
1978
    int scenechange_threshold;
1979

    
1980
    /**
1981
     * minimum Lagrange multipler
1982
     * - encoding: Set by user.
1983
     * - decoding: unused
1984
     */
1985
    int lmin;
1986

    
1987
    /**
1988
     * maximum Lagrange multipler
1989
     * - encoding: Set by user.
1990
     * - decoding: unused
1991
     */
1992
    int lmax;
1993

    
1994
    /**
1995
     * palette control structure
1996
     * - encoding: ??? (no palette-enabled encoder yet)
1997
     * - decoding: Set by user.
1998
     */
1999
    struct AVPaletteControl *palctrl;
2000

    
2001
    /**
2002
     * noise reduction strength
2003
     * - encoding: Set by user.
2004
     * - decoding: unused
2005
     */
2006
    int noise_reduction;
2007

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

    
2022
    /**
2023
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2024
     * - encoding: Set by user.
2025
     * - decoding: unused
2026
     */
2027
    int rc_initial_buffer_occupancy;
2028

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

    
2036
    /**
2037
     * CODEC_FLAG2_*
2038
     * - encoding: Set by user.
2039
     * - decoding: Set by user.
2040
     */
2041
    int flags2;
2042

    
2043
    /**
2044
     * Simulates errors in the bitstream to test error concealment.
2045
     * - encoding: Set by user.
2046
     * - decoding: unused
2047
     */
2048
    int error_rate;
2049

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

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

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

    
2086
    /**
2087
     * thread opaque
2088
     * Can be used by execute() to store some per AVCodecContext stuff.
2089
     * - encoding: set by execute()
2090
     * - decoding: set by execute()
2091
     */
2092
    void *thread_opaque;
2093

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

    
2103
    /**
2104
     * Macroblock threshold below which the user specified macroblock types will be used.
2105
     * - encoding: Set by user.
2106
     * - decoding: unused
2107
     */
2108
     int mb_threshold;
2109

    
2110
    /**
2111
     * precision of the intra DC coefficient - 8
2112
     * - encoding: Set by user.
2113
     * - decoding: unused
2114
     */
2115
     int intra_dc_precision;
2116

    
2117
    /**
2118
     * noise vs. sse weight for the nsse comparsion function
2119
     * - encoding: Set by user.
2120
     * - decoding: unused
2121
     */
2122
     int nsse_weight;
2123

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

    
2131
    /**
2132
     * Number of macroblock rows at the bottom which are skipped.
2133
     * - encoding: unused
2134
     * - decoding: Set by user.
2135
     */
2136
     int skip_bottom;
2137

    
2138
    /**
2139
     * profile
2140
     * - encoding: Set by user.
2141
     * - decoding: Set by libavcodec.
2142
     */
2143
     int profile;
2144
#define FF_PROFILE_UNKNOWN -99
2145

    
2146
#define FF_PROFILE_AAC_MAIN 0
2147
#define FF_PROFILE_AAC_LOW  1
2148
#define FF_PROFILE_AAC_SSR  2
2149
#define FF_PROFILE_AAC_LTP  3
2150

    
2151
#define FF_PROFILE_H264_BASELINE    66
2152
#define FF_PROFILE_H264_MAIN        77
2153
#define FF_PROFILE_H264_EXTENDED    88
2154
#define FF_PROFILE_H264_HIGH        100
2155
#define FF_PROFILE_H264_HIGH_10     110
2156
#define FF_PROFILE_H264_HIGH_422    122
2157
#define FF_PROFILE_H264_HIGH_444    244
2158
#define FF_PROFILE_H264_CAVLC_444   44
2159

    
2160
    /**
2161
     * level
2162
     * - encoding: Set by user.
2163
     * - decoding: Set by libavcodec.
2164
     */
2165
     int level;
2166
#define FF_LEVEL_UNKNOWN -99
2167

    
2168
    /**
2169
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2170
     * - encoding: unused
2171
     * - decoding: Set by user.
2172
     */
2173
     int lowres;
2174

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

    
2183
    /**
2184
     * frame skip threshold
2185
     * - encoding: Set by user.
2186
     * - decoding: unused
2187
     */
2188
    int frame_skip_threshold;
2189

    
2190
    /**
2191
     * frame skip factor
2192
     * - encoding: Set by user.
2193
     * - decoding: unused
2194
     */
2195
    int frame_skip_factor;
2196

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

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

    
2211
    /**
2212
     * Border processing masking, raises the quantizer for mbs on the borders
2213
     * of the picture.
2214
     * - encoding: Set by user.
2215
     * - decoding: unused
2216
     */
2217
    float border_masking;
2218

    
2219
    /**
2220
     * minimum MB lagrange multipler
2221
     * - encoding: Set by user.
2222
     * - decoding: unused
2223
     */
2224
    int mb_lmin;
2225

    
2226
    /**
2227
     * maximum MB lagrange multipler
2228
     * - encoding: Set by user.
2229
     * - decoding: unused
2230
     */
2231
    int mb_lmax;
2232

    
2233
    /**
2234
     *
2235
     * - encoding: Set by user.
2236
     * - decoding: unused
2237
     */
2238
    int me_penalty_compensation;
2239

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

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

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

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

    
2268
    /**
2269
     *
2270
     * - encoding: Set by user.
2271
     * - decoding: unused
2272
     */
2273
    int brd_scale;
2274

    
2275
    /**
2276
     * constant rate factor - quality-based VBR - values ~correspond to qps
2277
     * - encoding: Set by user.
2278
     * - decoding: unused
2279
     */
2280
    float crf;
2281

    
2282
    /**
2283
     * constant quantization parameter rate control method
2284
     * - encoding: Set by user.
2285
     * - decoding: unused
2286
     */
2287
    int cqp;
2288

    
2289
    /**
2290
     * minimum GOP size
2291
     * - encoding: Set by user.
2292
     * - decoding: unused
2293
     */
2294
    int keyint_min;
2295

    
2296
    /**
2297
     * number of reference frames
2298
     * - encoding: Set by user.
2299
     * - decoding: Set by lavc.
2300
     */
2301
    int refs;
2302

    
2303
    /**
2304
     * chroma qp offset from luma
2305
     * - encoding: Set by user.
2306
     * - decoding: unused
2307
     */
2308
    int chromaoffset;
2309

    
2310
    /**
2311
     * Influences how often B-frames are used.
2312
     * - encoding: Set by user.
2313
     * - decoding: unused
2314
     */
2315
    int bframebias;
2316

    
2317
    /**
2318
     * trellis RD quantization
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int trellis;
2323

    
2324
    /**
2325
     * Reduce fluctuations in qp (before curve compression).
2326
     * - encoding: Set by user.
2327
     * - decoding: unused
2328
     */
2329
    float complexityblur;
2330

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

    
2339
    /**
2340
     * in-loop deblocking filter beta parameter
2341
     * beta is in the range -6...6
2342
     * - encoding: Set by user.
2343
     * - decoding: unused
2344
     */
2345
    int deblockbeta;
2346

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

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

    
2366
    /**
2367
     * Audio cutoff bandwidth (0 means "automatic")
2368
     * - encoding: Set by user.
2369
     * - decoding: unused
2370
     */
2371
    int cutoff;
2372

    
2373
    /**
2374
     * Multiplied by qscale for each frame and added to scene_change_score.
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int scenechange_factor;
2379

    
2380
    /**
2381
     *
2382
     * Note: Value depends upon the compare function used for fullpel ME.
2383
     * - encoding: Set by user.
2384
     * - decoding: unused
2385
     */
2386
    int mv0_threshold;
2387

    
2388
    /**
2389
     * Adjusts sensitivity of b_frame_strategy 1.
2390
     * - encoding: Set by user.
2391
     * - decoding: unused
2392
     */
2393
    int b_sensitivity;
2394

    
2395
    /**
2396
     * - encoding: Set by user.
2397
     * - decoding: unused
2398
     */
2399
    int compression_level;
2400
#define FF_COMPRESSION_DEFAULT -1
2401

    
2402
    /**
2403
     * Sets whether to use LPC mode - used by FLAC encoder.
2404
     * - encoding: Set by user.
2405
     * - decoding: unused
2406
     */
2407
    int use_lpc;
2408

    
2409
    /**
2410
     * LPC coefficient precision - used by FLAC encoder
2411
     * - encoding: Set by user.
2412
     * - decoding: unused
2413
     */
2414
    int lpc_coeff_precision;
2415

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

    
2422
    /**
2423
     * - encoding: Set by user.
2424
     * - decoding: unused
2425
     */
2426
    int max_prediction_order;
2427

    
2428
    /**
2429
     * search method for selecting prediction order
2430
     * - encoding: Set by user.
2431
     * - decoding: unused
2432
     */
2433
    int prediction_order_method;
2434

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

    
2441
    /**
2442
     * - encoding: Set by user.
2443
     * - decoding: unused
2444
     */
2445
    int max_partition_order;
2446

    
2447
    /**
2448
     * GOP timecode frame start number, in non drop frame format
2449
     * - encoding: Set by user.
2450
     * - decoding: unused
2451
     */
2452
    int64_t timecode_frame_start;
2453

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

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

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

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

    
2488
    /**
2489
     * Audio channel layout.
2490
     * - encoding: set by user.
2491
     * - decoding: set by libavcodec.
2492
     */
2493
    int64_t channel_layout;
2494

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

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

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

    
2516
    /**
2517
     * Hardware accelerator in use
2518
     * - encoding: unused.
2519
     * - decoding: Set by libavcodec
2520
     */
2521
    struct AVHWAccel *hwaccel;
2522

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

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

    
2544
    /**
2545
     * Chromaticity coordinates of the source primaries.
2546
     * - encoding: Set by user
2547
     * - decoding: Set by libavcodec
2548
     */
2549
    enum AVColorPrimaries color_primaries;
2550

    
2551
    /**
2552
     * Color Transfer Characteristic.
2553
     * - encoding: Set by user
2554
     * - decoding: Set by libavcodec
2555
     */
2556
    enum AVColorTransferCharacteristic color_trc;
2557

    
2558
    /**
2559
     * YUV colorspace type.
2560
     * - encoding: Set by user
2561
     * - decoding: Set by libavcodec
2562
     */
2563
    enum AVColorSpace colorspace;
2564

    
2565
    /**
2566
     * MPEG vs JPEG YUV range.
2567
     * - encoding: Set by user
2568
     * - decoding: Set by libavcodec
2569
     */
2570
    enum AVColorRange color_range;
2571

    
2572
    /**
2573
     * This defines the location of chroma samples.
2574
     * - encoding: Set by user
2575
     * - decoding: Set by libavcodec
2576
     */
2577
    enum AVChromaLocation chroma_sample_location;
2578

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

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

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

    
2619
    /**
2620
     * AQ strength
2621
     * Reduces blocking and blurring in flat and textured areas.
2622
     * - encoding: Set by user
2623
     * - decoding: unused
2624
     */
2625
    float aq_strength;
2626

    
2627
    /**
2628
     * PSY RD
2629
     * Strength of psychovisual optimization
2630
     * - encoding: Set by user
2631
     * - decoding: unused
2632
     */
2633
    float psy_rd;
2634

    
2635
    /**
2636
     * PSY trellis
2637
     * Strength of psychovisual optimization
2638
     * - encoding: Set by user
2639
     * - decoding: unused
2640
     */
2641
    float psy_trellis;
2642

    
2643
    /**
2644
     * RC lookahead
2645
     * Number of frames for frametype and ratecontrol lookahead
2646
     * - encoding: Set by user
2647
     * - decoding: unused
2648
     */
2649
    int rc_lookahead;
2650

    
2651
    /**
2652
     * Constant rate factor maximum
2653
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2654
     * than crf_max, even if doing so would violate VBV restrictions.
2655
     * - encoding: Set by user.
2656
     * - decoding: unused
2657
     */
2658
    float crf_max;
2659
} AVCodecContext;
2660

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

    
2702
/**
2703
 * AVHWAccel.
2704
 */
2705
typedef struct AVHWAccel {
2706
    /**
2707
     * Name of the hardware accelerated codec.
2708
     * The name is globally unique among encoders and among decoders (but an
2709
     * encoder and a decoder can share the same name).
2710
     */
2711
    const char *name;
2712

    
2713
    /**
2714
     * Type of codec implemented by the hardware accelerator.
2715
     *
2716
     * See AVMEDIA_TYPE_xxx
2717
     */
2718
    enum AVMediaType type;
2719

    
2720
    /**
2721
     * Codec implemented by the hardware accelerator.
2722
     *
2723
     * See CODEC_ID_xxx
2724
     */
2725
    enum CodecID id;
2726

    
2727
    /**
2728
     * Supported pixel format.
2729
     *
2730
     * Only hardware accelerated formats are supported here.
2731
     */
2732
    enum PixelFormat pix_fmt;
2733

    
2734
    /**
2735
     * Hardware accelerated codec capabilities.
2736
     * see FF_HWACCEL_CODEC_CAP_*
2737
     */
2738
    int capabilities;
2739

    
2740
    struct AVHWAccel *next;
2741

    
2742
    /**
2743
     * Called at the beginning of each frame or field picture.
2744
     *
2745
     * Meaningful frame information (codec specific) is guaranteed to
2746
     * be parsed at this point. This function is mandatory.
2747
     *
2748
     * Note that buf can be NULL along with buf_size set to 0.
2749
     * Otherwise, this means the whole frame is available at this point.
2750
     *
2751
     * @param avctx the codec context
2752
     * @param buf the frame data buffer base
2753
     * @param buf_size the size of the frame in bytes
2754
     * @return zero if successful, a negative value otherwise
2755
     */
2756
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2757

    
2758
    /**
2759
     * Callback for each slice.
2760
     *
2761
     * Meaningful slice information (codec specific) is guaranteed to
2762
     * be parsed at this point. This function is mandatory.
2763
     *
2764
     * @param avctx the codec context
2765
     * @param buf the slice data buffer base
2766
     * @param buf_size the size of the slice in bytes
2767
     * @return zero if successful, a negative value otherwise
2768
     */
2769
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2770

    
2771
    /**
2772
     * Called at the end of each frame or field picture.
2773
     *
2774
     * The whole picture is parsed at this point and can now be sent
2775
     * to the hardware accelerator. This function is mandatory.
2776
     *
2777
     * @param avctx the codec context
2778
     * @return zero if successful, a negative value otherwise
2779
     */
2780
    int (*end_frame)(AVCodecContext *avctx);
2781

    
2782
    /**
2783
     * Size of HW accelerator private data.
2784
     *
2785
     * Private data is allocated with av_mallocz() before
2786
     * AVCodecContext.get_buffer() and deallocated after
2787
     * AVCodecContext.release_buffer().
2788
     */
2789
    int priv_data_size;
2790
} AVHWAccel;
2791

    
2792
/**
2793
 * four components are given, that's all.
2794
 * the last component is alpha
2795
 */
2796
typedef struct AVPicture {
2797
    uint8_t *data[4];
2798
    int linesize[4];       ///< number of bytes per line
2799
} AVPicture;
2800

    
2801
#if LIBAVCODEC_VERSION_MAJOR < 53
2802
/**
2803
 * AVPaletteControl
2804
 * This structure defines a method for communicating palette changes
2805
 * between and demuxer and a decoder.
2806
 *
2807
 * @deprecated Use AVPacket to send palette changes instead.
2808
 * This is totally broken.
2809
 */
2810
#define AVPALETTE_SIZE 1024
2811
#define AVPALETTE_COUNT 256
2812
typedef struct AVPaletteControl {
2813

    
2814
    /* Demuxer sets this to 1 to indicate the palette has changed;
2815
     * decoder resets to 0. */
2816
    int palette_changed;
2817

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

    
2824
} AVPaletteControl attribute_deprecated;
2825
#endif
2826

    
2827
enum AVSubtitleType {
2828
    SUBTITLE_NONE,
2829

    
2830
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2831

    
2832
    /**
2833
     * Plain text, the text field must be set by the decoder and is
2834
     * authoritative. ass and pict fields may contain approximations.
2835
     */
2836
    SUBTITLE_TEXT,
2837

    
2838
    /**
2839
     * Formatted text, the ass field must be set by the decoder and is
2840
     * authoritative. pict and text fields may contain approximations.
2841
     */
2842
    SUBTITLE_ASS,
2843
};
2844

    
2845
typedef struct AVSubtitleRect {
2846
    int x;         ///< top left corner  of pict, undefined when pict is not set
2847
    int y;         ///< top left corner  of pict, undefined when pict is not set
2848
    int w;         ///< width            of pict, undefined when pict is not set
2849
    int h;         ///< height           of pict, undefined when pict is not set
2850
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2851

    
2852
    /**
2853
     * data+linesize for the bitmap of this subtitle.
2854
     * can be set for text/ass as well once they where rendered
2855
     */
2856
    AVPicture pict;
2857
    enum AVSubtitleType type;
2858

    
2859
    char *text;                     ///< 0 terminated plain UTF-8 text
2860

    
2861
    /**
2862
     * 0 terminated ASS/SSA compatible event line.
2863
     * The pressentation of this is unaffected by the other values in this
2864
     * struct.
2865
     */
2866
    char *ass;
2867
} AVSubtitleRect;
2868

    
2869
typedef struct AVSubtitle {
2870
    uint16_t format; /* 0 = graphics */
2871
    uint32_t start_display_time; /* relative to packet pts, in ms */
2872
    uint32_t end_display_time; /* relative to packet pts, in ms */
2873
    unsigned num_rects;
2874
    AVSubtitleRect **rects;
2875
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2876
} AVSubtitle;
2877

    
2878
/* packet functions */
2879

    
2880
/**
2881
 * @deprecated use NULL instead
2882
 */
2883
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2884

    
2885
/**
2886
 * Default packet destructor.
2887
 */
2888
void av_destruct_packet(AVPacket *pkt);
2889

    
2890
/**
2891
 * Initialize optional fields of a packet with default values.
2892
 *
2893
 * @param pkt packet
2894
 */
2895
void av_init_packet(AVPacket *pkt);
2896

    
2897
/**
2898
 * Allocate the payload of a packet and initialize its fields with
2899
 * default values.
2900
 *
2901
 * @param pkt packet
2902
 * @param size wanted payload size
2903
 * @return 0 if OK, AVERROR_xxx otherwise
2904
 */
2905
int av_new_packet(AVPacket *pkt, int size);
2906

    
2907
/**
2908
 * Reduce packet size, correctly zeroing padding
2909
 *
2910
 * @param pkt packet
2911
 * @param size new size
2912
 */
2913
void av_shrink_packet(AVPacket *pkt, int size);
2914

    
2915
/**
2916
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2917
 * packet is allocated if it was not really allocated.
2918
 */
2919
int av_dup_packet(AVPacket *pkt);
2920

    
2921
/**
2922
 * Free a packet.
2923
 *
2924
 * @param pkt packet to free
2925
 */
2926
void av_free_packet(AVPacket *pkt);
2927

    
2928
/* resample.c */
2929

    
2930
struct ReSampleContext;
2931
struct AVResampleContext;
2932

    
2933
typedef struct ReSampleContext ReSampleContext;
2934

    
2935
#if LIBAVCODEC_VERSION_MAJOR < 53
2936
/**
2937
 * @deprecated Use av_audio_resample_init() instead.
2938
 */
2939
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2940
                                                          int output_rate, int input_rate);
2941
#endif
2942
/**
2943
 *  Initializes audio resampling context
2944
 *
2945
 * @param output_channels  number of output channels
2946
 * @param input_channels   number of input channels
2947
 * @param output_rate      output sample rate
2948
 * @param input_rate       input sample rate
2949
 * @param sample_fmt_out   requested output sample format
2950
 * @param sample_fmt_in    input sample format
2951
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2952
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2953
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2954
                           between the 2 closest, if 0 the closest will be used
2955
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2956
 * @return allocated ReSampleContext, NULL if error occured
2957
 */
2958
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2959
                                        int output_rate, int input_rate,
2960
                                        enum SampleFormat sample_fmt_out,
2961
                                        enum SampleFormat sample_fmt_in,
2962
                                        int filter_length, int log2_phase_count,
2963
                                        int linear, double cutoff);
2964

    
2965
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2966
void audio_resample_close(ReSampleContext *s);
2967

    
2968

    
2969
/**
2970
 * Initializes an audio resampler.
2971
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2972
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2973
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2974
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2975
                 between the 2 closest, if 0 the closest will be used
2976
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2977
 */
2978
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2979

    
2980
/**
2981
 * resamples.
2982
 * @param src an array of unconsumed samples
2983
 * @param consumed the number of samples of src which have been consumed are returned here
2984
 * @param src_size the number of unconsumed samples available
2985
 * @param dst_size the amount of space in samples available in dst
2986
 * @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.
2987
 * @return the number of samples written in dst or -1 if an error occurred
2988
 */
2989
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2990

    
2991

    
2992
/**
2993
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2994
 * the resampler parameters, so no audible clicks or similar distortions occur
2995
 * @param compensation_distance distance in output samples over which the compensation should be performed
2996
 * @param sample_delta number of output samples which should be output less
2997
 *
2998
 * example: av_resample_compensate(c, 10, 500)
2999
 * here instead of 510 samples only 500 samples would be output
3000
 *
3001
 * note, due to rounding the actual compensation might be slightly different,
3002
 * especially if the compensation_distance is large and the in_rate used during init is small
3003
 */
3004
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3005
void av_resample_close(struct AVResampleContext *c);
3006

    
3007
/**
3008
 * Allocate memory for a picture.  Call avpicture_free to free it.
3009
 *
3010
 * @param picture the picture to be filled in
3011
 * @param pix_fmt the format of the picture
3012
 * @param width the width of the picture
3013
 * @param height the height of the picture
3014
 * @return zero if successful, a negative value if not
3015
 */
3016
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3017

    
3018
/**
3019
 * Free a picture previously allocated by avpicture_alloc().
3020
 *
3021
 * @param picture the AVPicture to be freed
3022
 */
3023
void avpicture_free(AVPicture *picture);
3024

    
3025
/**
3026
 * Fill in the AVPicture fields.
3027
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3028
 * which points to the image data buffer. Depending on the specified picture
3029
 * format, one or multiple image data pointers and line sizes will be set.
3030
 * If a planar format is specified, several pointers will be set pointing to
3031
 * the different picture planes and the line sizes of the different planes
3032
 * will be stored in the lines_sizes array.
3033
 * Call with ptr == NULL to get the required size for the ptr buffer.
3034
 *
3035
 * @param picture AVPicture whose fields are to be filled in
3036
 * @param ptr Buffer which will contain or contains the actual image data
3037
 * @param pix_fmt The format in which the picture data is stored.
3038
 * @param width the width of the image in pixels
3039
 * @param height the height of the image in pixels
3040
 * @return size of the image data in bytes
3041
 */
3042
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3043
                   enum PixelFormat pix_fmt, int width, int height);
3044
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3045
                     unsigned char *dest, int dest_size);
3046

    
3047
/**
3048
 * Calculate the size in bytes that a picture of the given width and height
3049
 * would occupy if stored in the given picture format.
3050
 * Note that this returns the size of a compact representation as generated
3051
 * by avpicture_layout, which can be smaller than the size required for e.g.
3052
 * avpicture_fill.
3053
 *
3054
 * @param pix_fmt the given picture format
3055
 * @param width the width of the image
3056
 * @param height the height of the image
3057
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3058
 */
3059
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3060
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3061
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3062
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3063

    
3064
#if LIBAVCODEC_VERSION_MAJOR < 53
3065
/**
3066
 * Returns the pixel format corresponding to the name name.
3067
 *
3068
 * If there is no pixel format with name name, then looks for a
3069
 * pixel format with the name corresponding to the native endian
3070
 * format of name.
3071
 * For example in a little-endian system, first looks for "gray16",
3072
 * then for "gray16le".
3073
 *
3074
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
3075
 *
3076
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3077
 */
3078
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3079
#endif
3080

    
3081
/**
3082
 * Returns a value representing the fourCC code associated to the
3083
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3084
 * found.
3085
 */
3086
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3087

    
3088
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3089
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3090
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3091
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3092
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3093
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3094

    
3095
/**
3096
 * Computes what kind of losses will occur when converting from one specific
3097
 * pixel format to another.
3098
 * When converting from one pixel format to another, information loss may occur.
3099
 * For example, when converting from RGB24 to GRAY, the color information will
3100
 * be lost. Similarly, other losses occur when converting from some formats to
3101
 * other formats. These losses can involve loss of chroma, but also loss of
3102
 * resolution, loss of color depth, loss due to the color space conversion, loss
3103
 * of the alpha bits or loss due to color quantization.
3104
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3105
 * which will occur when converting from one pixel format to another.
3106
 *
3107
 * @param[in] dst_pix_fmt destination pixel format
3108
 * @param[in] src_pix_fmt source pixel format
3109
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3110
 * @return Combination of flags informing you what kind of losses will occur.
3111
 */
3112
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3113
                             int has_alpha);
3114

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

    
3140

    
3141
/**
3142
 * Print in buf the string corresponding to the pixel format with
3143
 * number pix_fmt, or an header if pix_fmt is negative.
3144
 *
3145
 * @param[in] buf the buffer where to write the string
3146
 * @param[in] buf_size the size of buf
3147
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3148
 * a negative value to print the corresponding header.
3149
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3150
 */
3151
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3152

    
3153
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3154
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3155

    
3156
/**
3157
 * Tell if an image really has transparent alpha values.
3158
 * @return ored mask of FF_ALPHA_xxx constants
3159
 */
3160
int img_get_alpha_info(const AVPicture *src,
3161
                       enum PixelFormat pix_fmt, int width, int height);
3162

    
3163
/* deinterlace a picture */
3164
/* deinterlace - if not supported return -1 */
3165
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3166
                          enum PixelFormat pix_fmt, int width, int height);
3167

    
3168
/* external high level API */
3169

    
3170
/**
3171
 * If c is NULL, returns the first registered codec,
3172
 * if c is non-NULL, returns the next registered codec after c,
3173
 * or NULL if c is the last one.
3174
 */
3175
AVCodec *av_codec_next(AVCodec *c);
3176

    
3177
/**
3178
 * Returns the LIBAVCODEC_VERSION_INT constant.
3179
 */
3180
unsigned avcodec_version(void);
3181

    
3182
/**
3183
 * Returns the libavcodec build-time configuration.
3184
 */
3185
const char *avcodec_configuration(void);
3186

    
3187
/**
3188
 * Returns the libavcodec license.
3189
 */
3190
const char *avcodec_license(void);
3191

    
3192
/**
3193
 * Initializes libavcodec.
3194
 *
3195
 * @warning This function must be called before any other libavcodec
3196
 * function.
3197
 */
3198
void avcodec_init(void);
3199

    
3200
#if LIBAVCODEC_VERSION_MAJOR < 53
3201
/**
3202
 * @deprecated Deprecated in favor of avcodec_register().
3203
 */
3204
attribute_deprecated void register_avcodec(AVCodec *codec);
3205
#endif
3206

    
3207
/**
3208
 * Register the codec codec and initialize libavcodec.
3209
 *
3210
 * @see avcodec_init()
3211
 */
3212
void avcodec_register(AVCodec *codec);
3213

    
3214
/**
3215
 * Finds a registered encoder with a matching codec ID.
3216
 *
3217
 * @param id CodecID of the requested encoder
3218
 * @return An encoder if one was found, NULL otherwise.
3219
 */
3220
AVCodec *avcodec_find_encoder(enum CodecID id);
3221

    
3222
/**
3223
 * Finds a registered encoder with the specified name.
3224
 *
3225
 * @param name name of the requested encoder
3226
 * @return An encoder if one was found, NULL otherwise.
3227
 */
3228
AVCodec *avcodec_find_encoder_by_name(const char *name);
3229

    
3230
/**
3231
 * Finds a registered decoder with a matching codec ID.
3232
 *
3233
 * @param id CodecID of the requested decoder
3234
 * @return A decoder if one was found, NULL otherwise.
3235
 */
3236
AVCodec *avcodec_find_decoder(enum CodecID id);
3237

    
3238
/**
3239
 * Finds a registered decoder with the specified name.
3240
 *
3241
 * @param name name of the requested decoder
3242
 * @return A decoder if one was found, NULL otherwise.
3243
 */
3244
AVCodec *avcodec_find_decoder_by_name(const char *name);
3245
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3246

    
3247
/**
3248
 * Sets the fields of the given AVCodecContext to default values.
3249
 *
3250
 * @param s The AVCodecContext of which the fields should be set to default values.
3251
 */
3252
void avcodec_get_context_defaults(AVCodecContext *s);
3253

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

    
3258
/**
3259
 * Allocates an AVCodecContext and sets its fields to default values.  The
3260
 * resulting struct can be deallocated by simply calling av_free().
3261
 *
3262
 * @return An AVCodecContext filled with default values or NULL on failure.
3263
 * @see avcodec_get_context_defaults
3264
 */
3265
AVCodecContext *avcodec_alloc_context(void);
3266

    
3267
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3268
 *  we WILL change its arguments and name a few times! */
3269
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3270

    
3271
/**
3272
 * Copy the settings of the source AVCodecContext into the destination
3273
 * AVCodecContext. The resulting destination codec context will be
3274
 * unopened, i.e. you are required to call avcodec_open() before you
3275
 * can use this AVCodecContext to decode/encode video/audio data.
3276
 *
3277
 * @param dest target codec context, should be initialized with
3278
 *             avcodec_alloc_context(), but otherwise uninitialized
3279
 * @param src source codec context
3280
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3281
 */
3282
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3283

    
3284
/**
3285
 * Sets the fields of the given AVFrame to default values.
3286
 *
3287
 * @param pic The AVFrame of which the fields should be set to default values.
3288
 */
3289
void avcodec_get_frame_defaults(AVFrame *pic);
3290

    
3291
/**
3292
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3293
 * struct can be deallocated by simply calling av_free().
3294
 *
3295
 * @return An AVFrame filled with default values or NULL on failure.
3296
 * @see avcodec_get_frame_defaults
3297
 */
3298
AVFrame *avcodec_alloc_frame(void);
3299

    
3300
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3301
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3302
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3303

    
3304
/**
3305
 * Returns the amount of padding in pixels which the get_buffer callback must
3306
 * provide around the edge of the image for codecs which do not have the
3307
 * CODEC_FLAG_EMU_EDGE flag.
3308
 *
3309
 * @return Required padding in pixels.
3310
 */
3311
unsigned avcodec_get_edge_width(void);
3312
/**
3313
 * Modifies width and height values so that they will result in a memory
3314
 * buffer that is acceptable for the codec if you do not use any horizontal
3315
 * padding.
3316
 */
3317
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3318
/**
3319
 * Modifies width and height values so that they will result in a memory
3320
 * buffer that is acceptable for the codec if you also ensure that all
3321
 * line sizes are a multiple of the respective linesize_align[i].
3322
 */
3323
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3324
                               int linesize_align[4]);
3325

    
3326
/**
3327
 * Checks if the given dimension of a picture is valid, meaning that all
3328
 * bytes of the picture can be addressed with a signed int.
3329
 *
3330
 * @param[in] w Width of the picture.
3331
 * @param[in] h Height of the picture.
3332
 * @return Zero if valid, a negative value if invalid.
3333
 */
3334
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3335
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3336

    
3337
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3338
void avcodec_thread_free(AVCodecContext *s);
3339
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3340
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3341
//FIXME func typedef
3342

    
3343
/**
3344
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3345
 * function the context has to be allocated.
3346
 *
3347
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3348
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3349
 * retrieving a codec.
3350
 *
3351
 * @warning This function is not thread safe!
3352
 *
3353
 * @code
3354
 * avcodec_register_all();
3355
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3356
 * if (!codec)
3357
 *     exit(1);
3358
 *
3359
 * context = avcodec_alloc_context();
3360
 *
3361
 * if (avcodec_open(context, codec) < 0)
3362
 *     exit(1);
3363
 * @endcode
3364
 *
3365
 * @param avctx The context which will be set up to use the given codec.
3366
 * @param codec The codec to use within the context.
3367
 * @return zero on success, a negative value on error
3368
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3369
 */
3370
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3371

    
3372
#if LIBAVCODEC_VERSION_MAJOR < 53
3373
/**
3374
 * Decodes an audio frame from buf into samples.
3375
 * Wrapper function which calls avcodec_decode_audio3.
3376
 *
3377
 * @deprecated Use avcodec_decode_audio3 instead.
3378
 * @param avctx the codec context
3379
 * @param[out] samples the output buffer
3380
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3381
 * @param[in] buf the input buffer
3382
 * @param[in] buf_size the input buffer size in bytes
3383
 * @return On error a negative value is returned, otherwise the number of bytes
3384
 * used or zero if no frame could be decompressed.
3385
 */
3386
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3387
                         int *frame_size_ptr,
3388
                         const uint8_t *buf, int buf_size);
3389
#endif
3390

    
3391
/**
3392
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3393
 * Some decoders may support multiple frames in a single AVPacket, such
3394
 * decoders would then just decode the first frame. In this case,
3395
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3396
 * the remaining data in order to decode the second frame etc.
3397
 * If no frame
3398
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3399
 * decompressed frame size in bytes.
3400
 *
3401
 * @warning You must set frame_size_ptr to the allocated size of the
3402
 * output buffer before calling avcodec_decode_audio3().
3403
 *
3404
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3405
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3406
 * bits at once and could read over the end.
3407
 *
3408
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3409
 * no overreading happens for damaged MPEG streams.
3410
 *
3411
 * @note You might have to align the input buffer avpkt->data and output buffer
3412
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3413
 * necessary at all, on others it won't work at all if not aligned and on others
3414
 * it will work but it will have an impact on performance.
3415
 *
3416
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3417
 * samples should be 16 byte aligned unless the CPU doesn't need it
3418
 * (AltiVec and SSE do).
3419
 *
3420
 * @param avctx the codec context
3421
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3422
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3423
 * @param[in] avpkt The input AVPacket containing the input buffer.
3424
 *            You can create such packet with av_init_packet() and by then setting
3425
 *            data and size, some decoders might in addition need other fields.
3426
 *            All decoders are designed to use the least fields possible though.
3427
 * @return On error a negative value is returned, otherwise the number of bytes
3428
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3429
 */
3430
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3431
                         int *frame_size_ptr,
3432
                         AVPacket *avpkt);
3433

    
3434
#if LIBAVCODEC_VERSION_MAJOR < 53
3435
/**
3436
 * Decodes a video frame from buf into picture.
3437
 * Wrapper function which calls avcodec_decode_video2.
3438
 *
3439
 * @deprecated Use avcodec_decode_video2 instead.
3440
 * @param avctx the codec context
3441
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3442
 * @param[in] buf the input buffer
3443
 * @param[in] buf_size the size of the input buffer in bytes
3444
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3445
 * @return On error a negative value is returned, otherwise the number of bytes
3446
 * used or zero if no frame could be decompressed.
3447
 */
3448
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3449
                         int *got_picture_ptr,
3450
                         const uint8_t *buf, int buf_size);
3451
#endif
3452

    
3453
/**
3454
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3455
 * Some decoders may support multiple frames in a single AVPacket, such
3456
 * decoders would then just decode the first frame.
3457
 *
3458
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3459
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3460
 * bits at once and could read over the end.
3461
 *
3462
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3463
 * no overreading happens for damaged MPEG streams.
3464
 *
3465
 * @note You might have to align the input buffer avpkt->data.
3466
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3467
 * necessary at all, on others it won't work at all if not aligned and on others
3468
 * it will work but it will have an impact on performance.
3469
 *
3470
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3471
 *
3472
 * @note Some codecs have a delay between input and output, these need to be
3473
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3474
 *
3475
 * @param avctx the codec context
3476
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3477
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3478
 *             allocate memory for the actual bitmap.
3479
 * @param[in] avpkt The input AVpacket containing the input buffer.
3480
 *            You can create such packet with av_init_packet() and by then setting
3481
 *            data and size, some decoders might in addition need other fields like
3482
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3483
 *            fields possible.
3484
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3485
 * @return On error a negative value is returned, otherwise the number of bytes
3486
 * used or zero if no frame could be decompressed.
3487
 */
3488
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3489
                         int *got_picture_ptr,
3490
                         AVPacket *avpkt);
3491

    
3492
#if LIBAVCODEC_VERSION_MAJOR < 53
3493
/* Decode a subtitle message. Return -1 if error, otherwise return the
3494
 * number of bytes used. If no subtitle could be decompressed,
3495
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3496
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3497
                            int *got_sub_ptr,
3498
                            const uint8_t *buf, int buf_size);
3499
#endif
3500

    
3501
/**
3502
 * Decodes a subtitle message.
3503
 * Returns a negative value on error, otherwise returns the number of bytes used.
3504
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3505
 * Otherwise, the subtitle is stored in *sub.
3506
 *
3507
 * @param avctx the codec context
3508
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3509
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3510
 * @param[in] avpkt The input AVPacket containing the input buffer.
3511
 */
3512
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3513
                            int *got_sub_ptr,
3514
                            AVPacket *avpkt);
3515
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3516
                        int *data_size_ptr,
3517
                        uint8_t *buf, int buf_size);
3518

    
3519
/**
3520
 * Encodes an audio frame from samples into buf.
3521
 *
3522
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3523
 * However, for PCM audio the user will know how much space is needed
3524
 * because it depends on the value passed in buf_size as described
3525
 * below. In that case a lower value can be used.
3526
 *
3527
 * @param avctx the codec context
3528
 * @param[out] buf the output buffer
3529
 * @param[in] buf_size the output buffer size
3530
 * @param[in] samples the input buffer containing the samples
3531
 * The number of samples read from this buffer is frame_size*channels,
3532
 * both of which are defined in avctx.
3533
 * For PCM audio the number of samples read from samples is equal to
3534
 * buf_size * input_sample_size / output_sample_size.
3535
 * @return On error a negative value is returned, on success zero or the number
3536
 * of bytes used to encode the data read from the input buffer.
3537
 */
3538
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3539
                         const short *samples);
3540

    
3541
/**
3542
 * Encodes a video frame from pict into buf.
3543
 * The input picture should be
3544
 * stored using a specific format, namely avctx.pix_fmt.
3545
 *
3546
 * @param avctx the codec context
3547
 * @param[out] buf the output buffer for the bitstream of encoded frame
3548
 * @param[in] buf_size the size of the output buffer in bytes
3549
 * @param[in] pict the input picture to encode
3550
 * @return On error a negative value is returned, on success zero or the number
3551
 * of bytes used from the output buffer.
3552
 */
3553
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3554
                         const AVFrame *pict);
3555
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3556
                            const AVSubtitle *sub);
3557

    
3558
int avcodec_close(AVCodecContext *avctx);
3559

    
3560
/**
3561
 * Register all the codecs, parsers and bitstream filters which were enabled at
3562
 * configuration time. If you do not call this function you can select exactly
3563
 * which formats you want to support, by using the individual registration
3564
 * functions.
3565
 *
3566
 * @see avcodec_register
3567
 * @see av_register_codec_parser
3568
 * @see av_register_bitstream_filter
3569
 */
3570
void avcodec_register_all(void);
3571

    
3572
/**
3573
 * Flush buffers, should be called when seeking or when switching to a different stream.
3574
 */
3575
void avcodec_flush_buffers(AVCodecContext *avctx);
3576

    
3577
void avcodec_default_free_buffers(AVCodecContext *s);
3578

    
3579
/* misc useful functions */
3580

    
3581
/**
3582
 * Returns a single letter to describe the given picture type pict_type.
3583
 *
3584
 * @param[in] pict_type the picture type
3585
 * @return A single character representing the picture type.
3586
 */
3587
char av_get_pict_type_char(int pict_type);
3588

    
3589
/**
3590
 * Returns codec bits per sample.
3591
 *
3592
 * @param[in] codec_id the codec
3593
 * @return Number of bits per sample or zero if unknown for the given codec.
3594
 */
3595
int av_get_bits_per_sample(enum CodecID codec_id);
3596

    
3597
/**
3598
 * Returns sample format bits per sample.
3599
 *
3600
 * @param[in] sample_fmt the sample format
3601
 * @return Number of bits per sample or zero if unknown for the given sample format.
3602
 */
3603
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3604

    
3605
/* frame parsing */
3606
typedef struct AVCodecParserContext {
3607
    void *priv_data;
3608
    struct AVCodecParser *parser;
3609
    int64_t frame_offset; /* offset of the current frame */
3610
    int64_t cur_offset; /* current offset
3611
                           (incremented by each av_parser_parse()) */
3612
    int64_t next_frame_offset; /* offset of the next frame */
3613
    /* video info */
3614
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3615
    /**
3616
     * This field is used for proper frame duration computation in lavf.
3617
     * It signals, how much longer the frame duration of the current frame
3618
     * is compared to normal frame duration.
3619
     *
3620
     * frame_duration = (1 + repeat_pict) * time_base
3621
     *
3622
     * It is used by codecs like H.264 to display telecined material.
3623
     */
3624
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3625
    int64_t pts;     /* pts of the current frame */
3626
    int64_t dts;     /* dts of the current frame */
3627

    
3628
    /* private data */
3629
    int64_t last_pts;
3630
    int64_t last_dts;
3631
    int fetch_timestamp;
3632

    
3633
#define AV_PARSER_PTS_NB 4
3634
    int cur_frame_start_index;
3635
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3636
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3637
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3638

    
3639
    int flags;
3640
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3641

    
3642
    int64_t offset;      ///< byte offset from starting packet start
3643
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3644

    
3645
    /*!
3646
     * Set by parser to 1 for key frames and 0 for non-key frames.
3647
     * It is initialized to -1, so if the parser doesn't set this flag,
3648
     * old-style fallback using FF_I_TYPE picture type as key frames
3649
     * will be used.
3650
     */
3651
    int key_frame;
3652

    
3653
    /**
3654
     * Time difference in stream time base units from the pts of this
3655
     * packet to the point at which the output from the decoder has converged
3656
     * independent from the availability of previous frames. That is, the
3657
     * frames are virtually identical no matter if decoding started from
3658
     * the very first frame or from this keyframe.
3659
     * Is AV_NOPTS_VALUE if unknown.
3660
     * This field is not the display duration of the current frame.
3661
     *
3662
     * The purpose of this field is to allow seeking in streams that have no
3663
     * keyframes in the conventional sense. It corresponds to the
3664
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3665
     * essential for some types of subtitle streams to ensure that all
3666
     * subtitles are correctly displayed after seeking.
3667
     */
3668
    int64_t convergence_duration;
3669

    
3670
    // Timestamp generation support:
3671
    /**
3672
     * Synchronization point for start of timestamp generation.
3673
     *
3674
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3675
     * (default).
3676
     *
3677
     * For example, this corresponds to presence of H.264 buffering period
3678
     * SEI message.
3679
     */
3680
    int dts_sync_point;
3681

    
3682
    /**
3683
     * Offset of the current timestamp against last timestamp sync point in
3684
     * units of AVCodecContext.time_base.
3685
     *
3686
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3687
     * contain a valid timestamp offset.
3688
     *
3689
     * Note that the timestamp of sync point has usually a nonzero
3690
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3691
     * the next frame after timestamp sync point will be usually 1.
3692
     *
3693
     * For example, this corresponds to H.264 cpb_removal_delay.
3694
     */
3695
    int dts_ref_dts_delta;
3696

    
3697
    /**
3698
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3699
     *
3700
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3701
     * contain valid non-negative timestamp delta (presentation time of a frame
3702
     * must not lie in the past).
3703
     *
3704
     * This delay represents the difference between decoding and presentation
3705
     * time of the frame.
3706
     *
3707
     * For example, this corresponds to H.264 dpb_output_delay.
3708
     */
3709
    int pts_dts_delta;
3710

    
3711
    /**
3712
     * Position of the packet in file.
3713
     *
3714
     * Analogous to cur_frame_pts/dts
3715
     */
3716
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3717

    
3718
    /**
3719
     * Byte position of currently parsed frame in stream.
3720
     */
3721
    int64_t pos;
3722

    
3723
    /**
3724
     * Previous frame byte position.
3725
     */
3726
    int64_t last_pos;
3727
} AVCodecParserContext;
3728

    
3729
typedef struct AVCodecParser {
3730
    int codec_ids[5]; /* several codec IDs are permitted */
3731
    int priv_data_size;
3732
    int (*parser_init)(AVCodecParserContext *s);
3733
    int (*parser_parse)(AVCodecParserContext *s,
3734
                        AVCodecContext *avctx,
3735
                        const uint8_t **poutbuf, int *poutbuf_size,
3736
                        const uint8_t *buf, int buf_size);
3737
    void (*parser_close)(AVCodecParserContext *s);
3738
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3739
    struct AVCodecParser *next;
3740
} AVCodecParser;
3741

    
3742
AVCodecParser *av_parser_next(AVCodecParser *c);
3743

    
3744
void av_register_codec_parser(AVCodecParser *parser);
3745
AVCodecParserContext *av_parser_init(int codec_id);
3746

    
3747
#if LIBAVCODEC_VERSION_MAJOR < 53
3748
attribute_deprecated
3749
int av_parser_parse(AVCodecParserContext *s,
3750
                    AVCodecContext *avctx,
3751
                    uint8_t **poutbuf, int *poutbuf_size,
3752
                    const uint8_t *buf, int buf_size,
3753
                    int64_t pts, int64_t dts);
3754
#endif
3755

    
3756
/**
3757
 * Parse a packet.
3758
 *
3759
 * @param s             parser context.
3760
 * @param avctx         codec context.
3761
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3762
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3763
 * @param buf           input buffer.
3764
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3765
 * @param pts           input presentation timestamp.
3766
 * @param dts           input decoding timestamp.
3767
 * @param pos           input byte position in stream.
3768
 * @return the number of bytes of the input bitstream used.
3769
 *
3770
 * Example:
3771
 * @code
3772
 *   while(in_len){
3773
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3774
 *                                        in_data, in_len,
3775
 *                                        pts, dts, pos);
3776
 *       in_data += len;
3777
 *       in_len  -= len;
3778
 *
3779
 *       if(size)
3780
 *          decode_frame(data, size);
3781
 *   }
3782
 * @endcode
3783
 */
3784
int av_parser_parse2(AVCodecParserContext *s,
3785
                     AVCodecContext *avctx,
3786
                     uint8_t **poutbuf, int *poutbuf_size,
3787
                     const uint8_t *buf, int buf_size,
3788
                     int64_t pts, int64_t dts,
3789
                     int64_t pos);
3790

    
3791
int av_parser_change(AVCodecParserContext *s,
3792
                     AVCodecContext *avctx,
3793
                     uint8_t **poutbuf, int *poutbuf_size,
3794
                     const uint8_t *buf, int buf_size, int keyframe);
3795
void av_parser_close(AVCodecParserContext *s);
3796

    
3797

    
3798
typedef struct AVBitStreamFilterContext {
3799
    void *priv_data;
3800
    struct AVBitStreamFilter *filter;
3801
    AVCodecParserContext *parser;
3802
    struct AVBitStreamFilterContext *next;
3803
} AVBitStreamFilterContext;
3804

    
3805

    
3806
typedef struct AVBitStreamFilter {
3807
    const char *name;
3808
    int priv_data_size;
3809
    int (*filter)(AVBitStreamFilterContext *bsfc,
3810
                  AVCodecContext *avctx, const char *args,
3811
                  uint8_t **poutbuf, int *poutbuf_size,
3812
                  const uint8_t *buf, int buf_size, int keyframe);
3813
    void (*close)(AVBitStreamFilterContext *bsfc);
3814
    struct AVBitStreamFilter *next;
3815
} AVBitStreamFilter;
3816

    
3817
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3818
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3819
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3820
                               AVCodecContext *avctx, const char *args,
3821
                               uint8_t **poutbuf, int *poutbuf_size,
3822
                               const uint8_t *buf, int buf_size, int keyframe);
3823
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3824

    
3825
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3826

    
3827
/* memory */
3828

    
3829
/**
3830
 * Reallocates the given block if it is not large enough, otherwise it
3831
 * does nothing.
3832
 *
3833
 * @see av_realloc
3834
 */
3835
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3836

    
3837
/**
3838
 * Allocates a buffer, reusing the given one if large enough.
3839
 *
3840
 * Contrary to av_fast_realloc the current buffer contents might not be
3841
 * preserved and on error the old buffer is freed, thus no special
3842
 * handling to avoid memleaks is necessary.
3843
 *
3844
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3845
 * @param size size of the buffer *ptr points to
3846
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3847
 *                 *size 0 if an error occurred.
3848
 */
3849
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3850

    
3851
/**
3852
 * Copy image 'src' to 'dst'.
3853
 */
3854
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3855
                     enum PixelFormat pix_fmt, int width, int height);
3856

    
3857
/**
3858
 * Crop image top and left side.
3859
 */
3860
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3861
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3862

    
3863
/**
3864
 * Pad image.
3865
 */
3866
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3867
            int padtop, int padbottom, int padleft, int padright, int *color);
3868

    
3869
/**
3870
 * Encodes extradata length to a buffer. Used by xiph codecs.
3871
 *
3872
 * @param s buffer to write to; must be at least (v/255+1) bytes long
3873
 * @param v size of extradata in bytes
3874
 * @return number of bytes written to the buffer.
3875
 */
3876
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3877

    
3878
/**
3879
 * Parses str and put in width_ptr and height_ptr the detected values.
3880
 *
3881
 * @return 0 in case of a successful parsing, a negative value otherwise
3882
 * @param[in] str the string to parse: it has to be a string in the format
3883
 * <width>x<height> or a valid video frame size abbreviation.
3884
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3885
 * frame width value
3886
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3887
 * frame height value
3888
 */
3889
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3890

    
3891
/**
3892
 * Parses str and put in frame_rate the detected values.
3893
 *
3894
 * @return 0 in case of a successful parsing, a negative value otherwise
3895
 * @param[in] str the string to parse: it has to be a string in the format
3896
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3897
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3898
 * frame rate
3899
 */
3900
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3901

    
3902
/**
3903
 * Logs a generic warning message about a missing feature. This function is
3904
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3905
 * only, and would normally not be used by applications.
3906
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3907
 * a pointer to an AVClass struct
3908
 * @param[in] feature string containing the name of the missing feature
3909
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3910
 * If want_sample is non-zero, additional verbage will be added to the log
3911
 * message which tells the user how to report samples to the development
3912
 * mailing list.
3913
 */
3914
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3915

    
3916
/**
3917
 * Logs a generic warning message asking for a sample. This function is
3918
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3919
 * only, and would normally not be used by applications.
3920
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3921
 * a pointer to an AVClass struct
3922
 * @param[in] msg string containing an optional message, or NULL if no message
3923
 */
3924
void av_log_ask_for_sample(void *avc, const char *msg);
3925

    
3926
/**
3927
 * Registers the hardware accelerator hwaccel.
3928
 */
3929
void av_register_hwaccel(AVHWAccel *hwaccel);
3930

    
3931
/**
3932
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3933
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3934
 * after hwaccel, or NULL if hwaccel is the last one.
3935
 */
3936
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3937

    
3938

    
3939
/**
3940
 * Lock operation used by lockmgr
3941
 */
3942
enum AVLockOp {
3943
  AV_LOCK_CREATE,  ///< Create a mutex
3944
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3945
  AV_LOCK_RELEASE, ///< Unlock the mutex
3946
  AV_LOCK_DESTROY, ///< Free mutex resources
3947
};
3948

    
3949
/**
3950
 * Register a user provided lock manager supporting the operations
3951
 * specified by AVLockOp. mutex points to a (void *) where the
3952
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3953
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3954
 *
3955
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3956
 *           callback during the call to av_lockmgr_register().
3957
 *           Thus, the application must be prepared to handle that.
3958
 *           If cb is set to NULL the lockmgr will be unregistered.
3959
 *           Also note that during unregistration the previously registered
3960
 *           lockmgr callback may also be invoked.
3961
 */
3962
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3963

    
3964
#endif /* AVCODEC_AVCODEC_H */