Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ c1736936

History | View | Annotate | Download (123 KB)

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

    
21
#ifndef AVCODEC_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

    
24
/**
25
 * @file libavcodec/avcodec.h
26
 * external API header
27
 */
28

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

    
32
#define LIBAVCODEC_VERSION_MAJOR 52
33
#define LIBAVCODEC_VERSION_MINOR 41
34
#define LIBAVCODEC_VERSION_MICRO  0
35

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

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

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

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

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

    
203
    /* various PCM "codecs" */
204
    CODEC_ID_PCM_S16LE= 0x10000,
205
    CODEC_ID_PCM_S16BE,
206
    CODEC_ID_PCM_U16LE,
207
    CODEC_ID_PCM_U16BE,
208
    CODEC_ID_PCM_S8,
209
    CODEC_ID_PCM_U8,
210
    CODEC_ID_PCM_MULAW,
211
    CODEC_ID_PCM_ALAW,
212
    CODEC_ID_PCM_S32LE,
213
    CODEC_ID_PCM_S32BE,
214
    CODEC_ID_PCM_U32LE,
215
    CODEC_ID_PCM_U32BE,
216
    CODEC_ID_PCM_S24LE,
217
    CODEC_ID_PCM_S24BE,
218
    CODEC_ID_PCM_U24LE,
219
    CODEC_ID_PCM_U24BE,
220
    CODEC_ID_PCM_S24DAUD,
221
    CODEC_ID_PCM_ZORK,
222
    CODEC_ID_PCM_S16LE_PLANAR,
223
    CODEC_ID_PCM_DVD,
224
    CODEC_ID_PCM_F32BE,
225
    CODEC_ID_PCM_F32LE,
226
    CODEC_ID_PCM_F64BE,
227
    CODEC_ID_PCM_F64LE,
228
    CODEC_ID_PCM_BLURAY,
229

    
230
    /* various ADPCM codecs */
231
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
232
    CODEC_ID_ADPCM_IMA_WAV,
233
    CODEC_ID_ADPCM_IMA_DK3,
234
    CODEC_ID_ADPCM_IMA_DK4,
235
    CODEC_ID_ADPCM_IMA_WS,
236
    CODEC_ID_ADPCM_IMA_SMJPEG,
237
    CODEC_ID_ADPCM_MS,
238
    CODEC_ID_ADPCM_4XM,
239
    CODEC_ID_ADPCM_XA,
240
    CODEC_ID_ADPCM_ADX,
241
    CODEC_ID_ADPCM_EA,
242
    CODEC_ID_ADPCM_G726,
243
    CODEC_ID_ADPCM_CT,
244
    CODEC_ID_ADPCM_SWF,
245
    CODEC_ID_ADPCM_YAMAHA,
246
    CODEC_ID_ADPCM_SBPRO_4,
247
    CODEC_ID_ADPCM_SBPRO_3,
248
    CODEC_ID_ADPCM_SBPRO_2,
249
    CODEC_ID_ADPCM_THP,
250
    CODEC_ID_ADPCM_IMA_AMV,
251
    CODEC_ID_ADPCM_EA_R1,
252
    CODEC_ID_ADPCM_EA_R3,
253
    CODEC_ID_ADPCM_EA_R2,
254
    CODEC_ID_ADPCM_IMA_EA_SEAD,
255
    CODEC_ID_ADPCM_IMA_EA_EACS,
256
    CODEC_ID_ADPCM_EA_XAS,
257
    CODEC_ID_ADPCM_EA_MAXIS_XA,
258
    CODEC_ID_ADPCM_IMA_ISS,
259

    
260
    /* AMR */
261
    CODEC_ID_AMR_NB= 0x12000,
262
    CODEC_ID_AMR_WB,
263

    
264
    /* RealAudio codecs*/
265
    CODEC_ID_RA_144= 0x13000,
266
    CODEC_ID_RA_288,
267

    
268
    /* various DPCM codecs */
269
    CODEC_ID_ROQ_DPCM= 0x14000,
270
    CODEC_ID_INTERPLAY_DPCM,
271
    CODEC_ID_XAN_DPCM,
272
    CODEC_ID_SOL_DPCM,
273

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

    
326
    /* subtitle codecs */
327
    CODEC_ID_DVD_SUBTITLE= 0x17000,
328
    CODEC_ID_DVB_SUBTITLE,
329
    CODEC_ID_TEXT,  ///< raw UTF-8 text
330
    CODEC_ID_XSUB,
331
    CODEC_ID_SSA,
332
    CODEC_ID_MOV_TEXT,
333
    CODEC_ID_HDMV_PGS_SUBTITLE,
334
    CODEC_ID_DVB_TELETEXT,
335

    
336
    /* other specific kind of codecs (generally used for attachments) */
337
    CODEC_ID_TTF= 0x18000,
338

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

    
341
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
342
                                * stream (only used by libavformat) */
343
};
344

    
345
enum CodecType {
346
    CODEC_TYPE_UNKNOWN = -1,
347
    CODEC_TYPE_VIDEO,
348
    CODEC_TYPE_AUDIO,
349
    CODEC_TYPE_DATA,
350
    CODEC_TYPE_SUBTITLE,
351
    CODEC_TYPE_ATTACHMENT,
352
    CODEC_TYPE_NB
353
};
354

    
355
/**
356
 * all in native-endian format
357
 */
358
enum SampleFormat {
359
    SAMPLE_FMT_NONE = -1,
360
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
361
    SAMPLE_FMT_S16,             ///< signed 16 bits
362
    SAMPLE_FMT_S32,             ///< signed 32 bits
363
    SAMPLE_FMT_FLT,             ///< float
364
    SAMPLE_FMT_DBL,             ///< double
365
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
366
};
367

    
368
/* Audio channel masks */
369
#define CH_FRONT_LEFT             0x00000001
370
#define CH_FRONT_RIGHT            0x00000002
371
#define CH_FRONT_CENTER           0x00000004
372
#define CH_LOW_FREQUENCY          0x00000008
373
#define CH_BACK_LEFT              0x00000010
374
#define CH_BACK_RIGHT             0x00000020
375
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
376
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
377
#define CH_BACK_CENTER            0x00000100
378
#define CH_SIDE_LEFT              0x00000200
379
#define CH_SIDE_RIGHT             0x00000400
380
#define CH_TOP_CENTER             0x00000800
381
#define CH_TOP_FRONT_LEFT         0x00001000
382
#define CH_TOP_FRONT_CENTER       0x00002000
383
#define CH_TOP_FRONT_RIGHT        0x00004000
384
#define CH_TOP_BACK_LEFT          0x00008000
385
#define CH_TOP_BACK_CENTER        0x00010000
386
#define CH_TOP_BACK_RIGHT         0x00020000
387
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
388
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
389

    
390
/** Channel mask value used for AVCodecContext.request_channel_layout
391
    to indicate that the user requests the channel order of the decoder output
392
    to be the native codec channel order. */
393
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
394

    
395
/* Audio channel convenience macros */
396
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
397
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
398
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
399
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
400
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
401
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
402
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
403
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
404
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
405
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
406
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
407
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
408
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
409
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
410
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
411
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
412

    
413
/* in bytes */
414
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
415

    
416
/**
417
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
418
 * This is mainly needed because some optimized bitstream readers read
419
 * 32 or 64 bit at once and could read over the end.<br>
420
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
421
 * MPEG bitstreams could cause overread and segfault.
422
 */
423
#define FF_INPUT_BUFFER_PADDING_SIZE 8
424

    
425
/**
426
 * minimum encoding buffer size
427
 * Used to avoid some checks during header writing.
428
 */
429
#define FF_MIN_BUFFER_SIZE 16384
430

    
431

    
432
/**
433
 * motion estimation type.
434
 */
435
enum Motion_Est_ID {
436
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
437
    ME_FULL,
438
    ME_LOG,
439
    ME_PHODS,
440
    ME_EPZS,        ///< enhanced predictive zonal search
441
    ME_X1,          ///< reserved for experiments
442
    ME_HEX,         ///< hexagon based search
443
    ME_UMH,         ///< uneven multi-hexagon search
444
    ME_ITER,        ///< iterative search
445
    ME_TESA,        ///< transformed exhaustive search algorithm
446
};
447

    
448
enum AVDiscard{
449
    /* We leave some space between them for extensions (drop some
450
     * keyframes for intra-only or drop just some bidir frames). */
451
    AVDISCARD_NONE   =-16, ///< discard nothing
452
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
453
    AVDISCARD_NONREF =  8, ///< discard all non reference
454
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
455
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
456
    AVDISCARD_ALL    = 48, ///< discard all
457
};
458

    
459
enum AVColorPrimaries{
460
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
461
    AVCOL_PRI_UNSPECIFIED=2,
462
    AVCOL_PRI_BT470M     =4,
463
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
464
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
465
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
466
    AVCOL_PRI_FILM       =8,
467
    AVCOL_PRI_NB           , ///< Not part of ABI
468
};
469

    
470
enum AVColorTransferCharacteristic{
471
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
472
    AVCOL_TRC_UNSPECIFIED=2,
473
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
474
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
475
    AVCOL_TRC_NB           , ///< Not part of ABI
476
};
477

    
478
enum AVColorSpace{
479
    AVCOL_SPC_RGB        =0,
480
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
481
    AVCOL_SPC_UNSPECIFIED=2,
482
    AVCOL_SPC_FCC        =4,
483
    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
484
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
485
    AVCOL_SPC_SMPTE240M  =7,
486
    AVCOL_SPC_NB           , ///< Not part of ABI
487
};
488

    
489
enum AVColorRange{
490
    AVCOL_RANGE_UNSPECIFIED=0,
491
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
492
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
493
    AVCOL_RANGE_NB           , ///< Not part of ABI
494
};
495

    
496
/**
497
 *  X   X      3 4 X      X are luma samples,
498
 *             1 2        1-6 are possible chroma positions
499
 *  X   X      5 6 X      0 is undefined/unknown position
500
 */
501
enum AVChromaLocation{
502
    AVCHROMA_LOC_UNSPECIFIED=0,
503
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
504
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
505
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
506
    AVCHROMA_LOC_TOP        =4,
507
    AVCHROMA_LOC_BOTTOMLEFT =5,
508
    AVCHROMA_LOC_BOTTOM     =6,
509
    AVCHROMA_LOC_NB           , ///< Not part of ABI
510
};
511

    
512
typedef struct RcOverride{
513
    int start_frame;
514
    int end_frame;
515
    int qscale; // If this is 0 then quality_factor will be used instead.
516
    float quality_factor;
517
} RcOverride;
518

    
519
#define FF_MAX_B_FRAMES 16
520

    
521
/* encoding support
522
   These flags can be passed in AVCodecContext.flags before initialization.
523
   Note: Not everything is supported yet.
524
*/
525

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

    
583
/* Unsupported options :
584
 *              Syntax Arithmetic coding (SAC)
585
 *              Reference Picture Selection
586
 *              Independent Segment Decoding */
587
/* /Fx */
588
/* codec capabilities */
589

    
590
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
591
/**
592
 * Codec uses get_buffer() for allocating buffers.
593
 * direct rendering method 1
594
 */
595
#define CODEC_CAP_DR1             0x0002
596
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
597
#define CODEC_CAP_PARSE_ONLY      0x0004
598
#define CODEC_CAP_TRUNCATED       0x0008
599
/* Codec can export data for HW decoding (XvMC). */
600
#define CODEC_CAP_HWACCEL         0x0010
601
/**
602
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
603
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
604
 */
605
#define CODEC_CAP_DELAY           0x0020
606
/**
607
 * Codec can be fed a final frame with a smaller size.
608
 * This can be used to prevent truncation of the last audio samples.
609
 */
610
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
611
/**
612
 * Codec can export data for HW decoding (VDPAU).
613
 */
614
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
615
/**
616
 * Codec can output multiple frames per AVPacket
617
 */
618
#define CODEC_CAP_SUBFRAMES        0x0100
619

    
620
//The following defines may change, don't expect compatibility if you use them.
621
#define MB_TYPE_INTRA4x4   0x0001
622
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
623
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
624
#define MB_TYPE_16x16      0x0008
625
#define MB_TYPE_16x8       0x0010
626
#define MB_TYPE_8x16       0x0020
627
#define MB_TYPE_8x8        0x0040
628
#define MB_TYPE_INTERLACED 0x0080
629
#define MB_TYPE_DIRECT2    0x0100 //FIXME
630
#define MB_TYPE_ACPRED     0x0200
631
#define MB_TYPE_GMC        0x0400
632
#define MB_TYPE_SKIP       0x0800
633
#define MB_TYPE_P0L0       0x1000
634
#define MB_TYPE_P1L0       0x2000
635
#define MB_TYPE_P0L1       0x4000
636
#define MB_TYPE_P1L1       0x8000
637
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
638
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
639
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
640
#define MB_TYPE_QUANT      0x00010000
641
#define MB_TYPE_CBP        0x00020000
642
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
643

    
644
/**
645
 * Pan Scan area.
646
 * This specifies the area which should be displayed.
647
 * Note there may be multiple such areas for one frame.
648
 */
649
typedef struct AVPanScan{
650
    /**
651
     * id
652
     * - encoding: Set by user.
653
     * - decoding: Set by libavcodec.
654
     */
655
    int id;
656

    
657
    /**
658
     * width and height in 1/16 pel
659
     * - encoding: Set by user.
660
     * - decoding: Set by libavcodec.
661
     */
662
    int width;
663
    int height;
664

    
665
    /**
666
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
667
     * - encoding: Set by user.
668
     * - decoding: Set by libavcodec.
669
     */
670
    int16_t position[3][2];
671
}AVPanScan;
672

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

    
899

    
900
#define FF_QSCALE_TYPE_MPEG1 0
901
#define FF_QSCALE_TYPE_MPEG2 1
902
#define FF_QSCALE_TYPE_H264  2
903

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

    
909

    
910
#define FF_I_TYPE  1 ///< Intra
911
#define FF_P_TYPE  2 ///< Predicted
912
#define FF_B_TYPE  3 ///< Bi-dir predicted
913
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
914
#define FF_SI_TYPE 5 ///< Switching Intra
915
#define FF_SP_TYPE 6 ///< Switching Predicted
916
#define FF_BI_TYPE 7
917

    
918
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
919
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
920
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
921
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
922

    
923
typedef struct AVPacket {
924
    /**
925
     * Presentation timestamp in AVStream->time_base units; the time at which
926
     * the decompressed packet will be presented to the user.
927
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
928
     * pts MUST be larger or equal to dts as presentation cannot happen before
929
     * decompression, unless one wants to view hex dumps. Some formats misuse
930
     * the terms dts and pts/cts to mean something different. Such timestamps
931
     * must be converted to true pts/dts before they are stored in AVPacket.
932
     */
933
    int64_t pts;
934
    /**
935
     * Decompression timestamp in AVStream->time_base units; the time at which
936
     * the packet is decompressed.
937
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
938
     */
939
    int64_t dts;
940
    uint8_t *data;
941
    int   size;
942
    int   stream_index;
943
    int   flags;
944
    /**
945
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
946
     * Equals next_pts - this_pts in presentation order.
947
     */
948
    int   duration;
949
    void  (*destruct)(struct AVPacket *);
950
    void  *priv;
951
    int64_t pos;                            ///< byte position in stream, -1 if unknown
952

    
953
    /**
954
     * Time difference in AVStream->time_base units from the pts of this
955
     * packet to the point at which the output from the decoder has converged
956
     * independent from the availability of previous frames. That is, the
957
     * frames are virtually identical no matter if decoding started from
958
     * the very first frame or from this keyframe.
959
     * Is AV_NOPTS_VALUE if unknown.
960
     * This field is not the display duration of the current packet.
961
     *
962
     * The purpose of this field is to allow seeking in streams that have no
963
     * keyframes in the conventional sense. It corresponds to the
964
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
965
     * essential for some types of subtitle streams to ensure that all
966
     * subtitles are correctly displayed after seeking.
967
     */
968
    int64_t convergence_duration;
969
} AVPacket;
970
#define AV_PKT_FLAG_KEY   0x0001
971
#if LIBAVCODEC_VERSION_MAJOR < 53
972
#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
973
#endif
974

    
975
/**
976
 * Audio Video Frame.
977
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
978
 * bumps.
979
 * Removal, reordering and changes to existing fields require a major
980
 * version bump. No fields should be added into AVFrame before or after
981
 * FF_COMMON_FRAME!
982
 * sizeof(AVFrame) must not be used outside libav*.
983
 */
984
typedef struct AVFrame {
985
    FF_COMMON_FRAME
986
} AVFrame;
987

    
988
/**
989
 * main external API structure.
990
 * New fields can be added to the end with minor version bumps.
991
 * Removal, reordering and changes to existing fields require a major
992
 * version bump.
993
 * sizeof(AVCodecContext) must not be used outside libav*.
994
 */
995
typedef struct AVCodecContext {
996
    /**
997
     * information on struct for av_log
998
     * - set by avcodec_alloc_context
999
     */
1000
    const AVClass *av_class;
1001
    /**
1002
     * the average bitrate
1003
     * - encoding: Set by user; unused for constant quantizer encoding.
1004
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1005
     */
1006
    int bit_rate;
1007

    
1008
    /**
1009
     * number of bits the bitstream is allowed to diverge from the reference.
1010
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1011
     * - encoding: Set by user; unused for constant quantizer encoding.
1012
     * - decoding: unused
1013
     */
1014
    int bit_rate_tolerance;
1015

    
1016
    /**
1017
     * CODEC_FLAG_*.
1018
     * - encoding: Set by user.
1019
     * - decoding: Set by user.
1020
     */
1021
    int flags;
1022

    
1023
    /**
1024
     * Some codecs need additional format info. It is stored here.
1025
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1026
     * specific codec MUST set it correctly otherwise stream copy breaks.
1027
     * In general use of this field by muxers is not recommanded.
1028
     * - encoding: Set by libavcodec.
1029
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1030
     */
1031
    int sub_id;
1032

    
1033
    /**
1034
     * Motion estimation algorithm used for video coding.
1035
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1036
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1037
     * - encoding: MUST be set by user.
1038
     * - decoding: unused
1039
     */
1040
    int me_method;
1041

    
1042
    /**
1043
     * some codecs need / can use extradata like Huffman tables.
1044
     * mjpeg: Huffman tables
1045
     * rv10: additional flags
1046
     * mpeg4: global headers (they can be in the bitstream or here)
1047
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1048
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1049
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1050
     * - encoding: Set/allocated/freed by libavcodec.
1051
     * - decoding: Set/allocated/freed by user.
1052
     */
1053
    uint8_t *extradata;
1054
    int extradata_size;
1055

    
1056
    /**
1057
     * This is the fundamental unit of time (in seconds) in terms
1058
     * of which frame timestamps are represented. For fixed-fps content,
1059
     * timebase should be 1/framerate and timestamp increments should be
1060
     * identically 1.
1061
     * - encoding: MUST be set by user.
1062
     * - decoding: Set by libavcodec.
1063
     */
1064
    AVRational time_base;
1065

    
1066
    /* video only */
1067
    /**
1068
     * picture width / height.
1069
     * - encoding: MUST be set by user.
1070
     * - decoding: Set by libavcodec.
1071
     * Note: For compatibility it is possible to set this instead of
1072
     * coded_width/height before decoding.
1073
     */
1074
    int width, height;
1075

    
1076
#define FF_ASPECT_EXTENDED 15
1077

    
1078
    /**
1079
     * the number of pictures in a group of pictures, or 0 for intra_only
1080
     * - encoding: Set by user.
1081
     * - decoding: unused
1082
     */
1083
    int gop_size;
1084

    
1085
    /**
1086
     * Pixel format, see PIX_FMT_xxx.
1087
     * - encoding: Set by user.
1088
     * - decoding: Set by libavcodec.
1089
     */
1090
    enum PixelFormat pix_fmt;
1091

    
1092
    /**
1093
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1094
     * has to read frames at native frame rate.
1095
     * - encoding: Set by user.
1096
     * - decoding: unused
1097
     */
1098
    int rate_emu;
1099

    
1100
    /**
1101
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1102
     * decoder to draw a horizontal band. It improves cache usage. Not
1103
     * all codecs can do that. You must check the codec capabilities
1104
     * beforehand.
1105
     * The function is also used by hardware acceleration APIs.
1106
     * It is called at least once during frame decoding to pass
1107
     * the data needed for hardware render.
1108
     * In that mode instead of pixel data, AVFrame points to
1109
     * a structure specific to the acceleration API. The application
1110
     * reads the structure and can change some fields to indicate progress
1111
     * or mark state.
1112
     * - encoding: unused
1113
     * - decoding: Set by user.
1114
     * @param height the height of the slice
1115
     * @param y the y position of the slice
1116
     * @param type 1->top field, 2->bottom field, 3->frame
1117
     * @param offset offset into the AVFrame.data from which the slice should be read
1118
     */
1119
    void (*draw_horiz_band)(struct AVCodecContext *s,
1120
                            const AVFrame *src, int offset[4],
1121
                            int y, int type, int height);
1122

    
1123
    /* audio only */
1124
    int sample_rate; ///< samples per second
1125
    int channels;    ///< number of audio channels
1126

    
1127
    /**
1128
     * audio sample format
1129
     * - encoding: Set by user.
1130
     * - decoding: Set by libavcodec.
1131
     */
1132
    enum SampleFormat sample_fmt;  ///< sample format
1133

    
1134
    /* The following data should not be initialized. */
1135
    /**
1136
     * Samples per packet, initialized when calling 'init'.
1137
     */
1138
    int frame_size;
1139
    int frame_number;   ///< audio or video frame number
1140
#if LIBAVCODEC_VERSION_MAJOR < 53
1141
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1142
#endif
1143

    
1144
    /**
1145
     * Number of frames the decoded output will be delayed relative to
1146
     * the encoded input.
1147
     * - encoding: Set by libavcodec.
1148
     * - decoding: unused
1149
     */
1150
    int delay;
1151

    
1152
    /* - encoding parameters */
1153
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1154
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1155

    
1156
    /**
1157
     * minimum quantizer
1158
     * - encoding: Set by user.
1159
     * - decoding: unused
1160
     */
1161
    int qmin;
1162

    
1163
    /**
1164
     * maximum quantizer
1165
     * - encoding: Set by user.
1166
     * - decoding: unused
1167
     */
1168
    int qmax;
1169

    
1170
    /**
1171
     * maximum quantizer difference between frames
1172
     * - encoding: Set by user.
1173
     * - decoding: unused
1174
     */
1175
    int max_qdiff;
1176

    
1177
    /**
1178
     * maximum number of B-frames between non-B-frames
1179
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1180
     * - encoding: Set by user.
1181
     * - decoding: unused
1182
     */
1183
    int max_b_frames;
1184

    
1185
    /**
1186
     * qscale factor between IP and B-frames
1187
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1188
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1189
     * - encoding: Set by user.
1190
     * - decoding: unused
1191
     */
1192
    float b_quant_factor;
1193

    
1194
    /** obsolete FIXME remove */
1195
    int rc_strategy;
1196
#define FF_RC_STRATEGY_XVID 1
1197

    
1198
    int b_frame_strategy;
1199

    
1200
    /**
1201
     * hurry up amount
1202
     * - encoding: unused
1203
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1204
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1205
     */
1206
    int hurry_up;
1207

    
1208
    struct AVCodec *codec;
1209

    
1210
    void *priv_data;
1211

    
1212
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1213
                            /* do its best to deliver a chunk with size     */
1214
                            /* below rtp_payload_size, the chunk will start */
1215
                            /* with a start code on some codecs like H.263. */
1216
                            /* This doesn't take account of any particular  */
1217
                            /* headers inside the transmitted RTP payload.  */
1218

    
1219

    
1220
    /* The RTP callback: This function is called    */
1221
    /* every time the encoder has a packet to send. */
1222
    /* It depends on the encoder if the data starts */
1223
    /* with a Start Code (it should). H.263 does.   */
1224
    /* mb_nb contains the number of macroblocks     */
1225
    /* encoded in the RTP payload.                  */
1226
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1227

    
1228
    /* statistics, used for 2-pass encoding */
1229
    int mv_bits;
1230
    int header_bits;
1231
    int i_tex_bits;
1232
    int p_tex_bits;
1233
    int i_count;
1234
    int p_count;
1235
    int skip_count;
1236
    int misc_bits;
1237

    
1238
    /**
1239
     * number of bits used for the previously encoded frame
1240
     * - encoding: Set by libavcodec.
1241
     * - decoding: unused
1242
     */
1243
    int frame_bits;
1244

    
1245
    /**
1246
     * Private data of the user, can be used to carry app specific stuff.
1247
     * - encoding: Set by user.
1248
     * - decoding: Set by user.
1249
     */
1250
    void *opaque;
1251

    
1252
    char codec_name[32];
1253
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1254
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1255

    
1256
    /**
1257
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1258
     * This is used to work around some encoder bugs.
1259
     * A demuxer should set this to what is stored in the field used to identify the codec.
1260
     * If there are multiple such fields in a container then the demuxer should choose the one
1261
     * which maximizes the information about the used codec.
1262
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1263
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1264
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1265
     * first.
1266
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1267
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1268
     */
1269
    unsigned int codec_tag;
1270

    
1271
    /**
1272
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1273
     * - encoding: Set by user
1274
     * - decoding: Set by user
1275
     */
1276
    int workaround_bugs;
1277
#define FF_BUG_AUTODETECT       1  ///< autodetection
1278
#define FF_BUG_OLD_MSMPEG4      2
1279
#define FF_BUG_XVID_ILACE       4
1280
#define FF_BUG_UMP4             8
1281
#define FF_BUG_NO_PADDING       16
1282
#define FF_BUG_AMV              32
1283
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1284
#define FF_BUG_QPEL_CHROMA      64
1285
#define FF_BUG_STD_QPEL         128
1286
#define FF_BUG_QPEL_CHROMA2     256
1287
#define FF_BUG_DIRECT_BLOCKSIZE 512
1288
#define FF_BUG_EDGE             1024
1289
#define FF_BUG_HPEL_CHROMA      2048
1290
#define FF_BUG_DC_CLIP          4096
1291
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1292
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1293

    
1294
    /**
1295
     * luma single coefficient elimination threshold
1296
     * - encoding: Set by user.
1297
     * - decoding: unused
1298
     */
1299
    int luma_elim_threshold;
1300

    
1301
    /**
1302
     * chroma single coeff elimination threshold
1303
     * - encoding: Set by user.
1304
     * - decoding: unused
1305
     */
1306
    int chroma_elim_threshold;
1307

    
1308
    /**
1309
     * strictly follow the standard (MPEG4, ...).
1310
     * - encoding: Set by user.
1311
     * - decoding: Set by user.
1312
     * Setting this to STRICT or higher means the encoder and decoder will
1313
     * generally do stupid things. While setting it to inofficial or lower
1314
     * will mean the encoder might use things that are not supported by all
1315
     * spec compliant decoders. Decoders make no difference between normal,
1316
     * inofficial and experimental, that is they always try to decode things
1317
     * when they can unless they are explicitly asked to behave stupid
1318
     * (=strictly conform to the specs)
1319
     */
1320
    int strict_std_compliance;
1321
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1322
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1323
#define FF_COMPLIANCE_NORMAL        0
1324
#define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1325
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1326

    
1327
    /**
1328
     * qscale offset between IP and B-frames
1329
     * - encoding: Set by user.
1330
     * - decoding: unused
1331
     */
1332
    float b_quant_offset;
1333

    
1334
    /**
1335
     * Error recognization; higher values will detect more errors but may
1336
     * misdetect some more or less valid parts as errors.
1337
     * - encoding: unused
1338
     * - decoding: Set by user.
1339
     */
1340
    int error_recognition;
1341
#define FF_ER_CAREFUL         1
1342
#define FF_ER_COMPLIANT       2
1343
#define FF_ER_AGGRESSIVE      3
1344
#define FF_ER_VERY_AGGRESSIVE 4
1345

    
1346
    /**
1347
     * Called at the beginning of each frame to get a buffer for it.
1348
     * If pic.reference is set then the frame will be read later by libavcodec.
1349
     * avcodec_align_dimensions() should be used to find the required width and
1350
     * height, as they normally need to be rounded up to the next multiple of 16.
1351
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1352
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1353
     * some other means.
1354
     * - encoding: unused
1355
     * - decoding: Set by libavcodec., user can override.
1356
     */
1357
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1358

    
1359
    /**
1360
     * Called to release buffers which were allocated with get_buffer.
1361
     * A released buffer can be reused in get_buffer().
1362
     * pic.data[*] must be set to NULL.
1363
     * - encoding: unused
1364
     * - decoding: Set by libavcodec., user can override.
1365
     */
1366
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1367

    
1368
    /**
1369
     * Size of the frame reordering buffer in the decoder.
1370
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1371
     * - encoding: Set by libavcodec.
1372
     * - decoding: Set by libavcodec.
1373
     */
1374
    int has_b_frames;
1375

    
1376
    /**
1377
     * number of bytes per packet if constant and known or 0
1378
     * Used by some WAV based audio codecs.
1379
     */
1380
    int block_align;
1381

    
1382
    int parse_only; /* - decoding only: If true, only parsing is done
1383
                       (function avcodec_parse_frame()). The frame
1384
                       data is returned. Only MPEG codecs support this now. */
1385

    
1386
    /**
1387
     * 0-> h263 quant 1-> mpeg quant
1388
     * - encoding: Set by user.
1389
     * - decoding: unused
1390
     */
1391
    int mpeg_quant;
1392

    
1393
    /**
1394
     * pass1 encoding statistics output buffer
1395
     * - encoding: Set by libavcodec.
1396
     * - decoding: unused
1397
     */
1398
    char *stats_out;
1399

    
1400
    /**
1401
     * pass2 encoding statistics input buffer
1402
     * Concatenated stuff from stats_out of pass1 should be placed here.
1403
     * - encoding: Allocated/set/freed by user.
1404
     * - decoding: unused
1405
     */
1406
    char *stats_in;
1407

    
1408
    /**
1409
     * ratecontrol qmin qmax limiting method
1410
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1411
     * - encoding: Set by user.
1412
     * - decoding: unused
1413
     */
1414
    float rc_qsquish;
1415

    
1416
    float rc_qmod_amp;
1417
    int rc_qmod_freq;
1418

    
1419
    /**
1420
     * ratecontrol override, see RcOverride
1421
     * - encoding: Allocated/set/freed by user.
1422
     * - decoding: unused
1423
     */
1424
    RcOverride *rc_override;
1425
    int rc_override_count;
1426

    
1427
    /**
1428
     * rate control equation
1429
     * - encoding: Set by user
1430
     * - decoding: unused
1431
     */
1432
    const char *rc_eq;
1433

    
1434
    /**
1435
     * maximum bitrate
1436
     * - encoding: Set by user.
1437
     * - decoding: unused
1438
     */
1439
    int rc_max_rate;
1440

    
1441
    /**
1442
     * minimum bitrate
1443
     * - encoding: Set by user.
1444
     * - decoding: unused
1445
     */
1446
    int rc_min_rate;
1447

    
1448
    /**
1449
     * decoder bitstream buffer size
1450
     * - encoding: Set by user.
1451
     * - decoding: unused
1452
     */
1453
    int rc_buffer_size;
1454
    float rc_buffer_aggressivity;
1455

    
1456
    /**
1457
     * qscale factor between P and I-frames
1458
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1459
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1460
     * - encoding: Set by user.
1461
     * - decoding: unused
1462
     */
1463
    float i_quant_factor;
1464

    
1465
    /**
1466
     * qscale offset between P and I-frames
1467
     * - encoding: Set by user.
1468
     * - decoding: unused
1469
     */
1470
    float i_quant_offset;
1471

    
1472
    /**
1473
     * initial complexity for pass1 ratecontrol
1474
     * - encoding: Set by user.
1475
     * - decoding: unused
1476
     */
1477
    float rc_initial_cplx;
1478

    
1479
    /**
1480
     * DCT algorithm, see FF_DCT_* below
1481
     * - encoding: Set by user.
1482
     * - decoding: unused
1483
     */
1484
    int dct_algo;
1485
#define FF_DCT_AUTO    0
1486
#define FF_DCT_FASTINT 1
1487
#define FF_DCT_INT     2
1488
#define FF_DCT_MMX     3
1489
#define FF_DCT_MLIB    4
1490
#define FF_DCT_ALTIVEC 5
1491
#define FF_DCT_FAAN    6
1492

    
1493
    /**
1494
     * luminance masking (0-> disabled)
1495
     * - encoding: Set by user.
1496
     * - decoding: unused
1497
     */
1498
    float lumi_masking;
1499

    
1500
    /**
1501
     * temporary complexity masking (0-> disabled)
1502
     * - encoding: Set by user.
1503
     * - decoding: unused
1504
     */
1505
    float temporal_cplx_masking;
1506

    
1507
    /**
1508
     * spatial complexity masking (0-> disabled)
1509
     * - encoding: Set by user.
1510
     * - decoding: unused
1511
     */
1512
    float spatial_cplx_masking;
1513

    
1514
    /**
1515
     * p block masking (0-> disabled)
1516
     * - encoding: Set by user.
1517
     * - decoding: unused
1518
     */
1519
    float p_masking;
1520

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

    
1528
    /**
1529
     * IDCT algorithm, see FF_IDCT_* below.
1530
     * - encoding: Set by user.
1531
     * - decoding: Set by user.
1532
     */
1533
    int idct_algo;
1534
#define FF_IDCT_AUTO          0
1535
#define FF_IDCT_INT           1
1536
#define FF_IDCT_SIMPLE        2
1537
#define FF_IDCT_SIMPLEMMX     3
1538
#define FF_IDCT_LIBMPEG2MMX   4
1539
#define FF_IDCT_PS2           5
1540
#define FF_IDCT_MLIB          6
1541
#define FF_IDCT_ARM           7
1542
#define FF_IDCT_ALTIVEC       8
1543
#define FF_IDCT_SH4           9
1544
#define FF_IDCT_SIMPLEARM     10
1545
#define FF_IDCT_H264          11
1546
#define FF_IDCT_VP3           12
1547
#define FF_IDCT_IPP           13
1548
#define FF_IDCT_XVIDMMX       14
1549
#define FF_IDCT_CAVS          15
1550
#define FF_IDCT_SIMPLEARMV5TE 16
1551
#define FF_IDCT_SIMPLEARMV6   17
1552
#define FF_IDCT_SIMPLEVIS     18
1553
#define FF_IDCT_WMV2          19
1554
#define FF_IDCT_FAAN          20
1555
#define FF_IDCT_EA            21
1556
#define FF_IDCT_SIMPLENEON    22
1557
#define FF_IDCT_SIMPLEALPHA   23
1558

    
1559
    /**
1560
     * slice count
1561
     * - encoding: Set by libavcodec.
1562
     * - decoding: Set by user (or 0).
1563
     */
1564
    int slice_count;
1565
    /**
1566
     * slice offsets in the frame in bytes
1567
     * - encoding: Set/allocated by libavcodec.
1568
     * - decoding: Set/allocated by user (or NULL).
1569
     */
1570
    int *slice_offset;
1571

    
1572
    /**
1573
     * error concealment flags
1574
     * - encoding: unused
1575
     * - decoding: Set by user.
1576
     */
1577
    int error_concealment;
1578
#define FF_EC_GUESS_MVS   1
1579
#define FF_EC_DEBLOCK     2
1580

    
1581
    /**
1582
     * dsp_mask could be add used to disable unwanted CPU features
1583
     * CPU features (i.e. MMX, SSE. ...)
1584
     *
1585
     * With the FORCE flag you may instead enable given CPU features.
1586
     * (Dangerous: Usable in case of misdetection, improper usage however will
1587
     * result into program crash.)
1588
     */
1589
    unsigned dsp_mask;
1590
#define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1591
    /* lower 16 bits - CPU features */
1592
#define FF_MM_MMX      0x0001 ///< standard MMX
1593
#define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1594
#if LIBAVCODEC_VERSION_MAJOR < 53
1595
#define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1596
#endif
1597
#define FF_MM_MMX2     0x0002 ///< SSE integer functions or AMD MMX ext
1598
#define FF_MM_SSE      0x0008 ///< SSE functions
1599
#define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1600
#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1601
#define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1602
#define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1603
#define FF_MM_SSE4     0x0100 ///< Penryn SSE4.1 functions
1604
#define FF_MM_SSE42    0x0200 ///< Nehalem SSE4.2 functions
1605
#define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1606
#define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
1607

    
1608
    /**
1609
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1610
     * - encoding: Set by libavcodec.
1611
     * - decoding: Set by user.
1612
     */
1613
     int bits_per_coded_sample;
1614

    
1615
    /**
1616
     * prediction method (needed for huffyuv)
1617
     * - encoding: Set by user.
1618
     * - decoding: unused
1619
     */
1620
     int prediction_method;
1621
#define FF_PRED_LEFT   0
1622
#define FF_PRED_PLANE  1
1623
#define FF_PRED_MEDIAN 2
1624

    
1625
    /**
1626
     * sample aspect ratio (0 if unknown)
1627
     * That is the width of a pixel divided by the height of the pixel.
1628
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1629
     * - encoding: Set by user.
1630
     * - decoding: Set by libavcodec.
1631
     */
1632
    AVRational sample_aspect_ratio;
1633

    
1634
    /**
1635
     * the picture in the bitstream
1636
     * - encoding: Set by libavcodec.
1637
     * - decoding: Set by libavcodec.
1638
     */
1639
    AVFrame *coded_frame;
1640

    
1641
    /**
1642
     * debug
1643
     * - encoding: Set by user.
1644
     * - decoding: Set by user.
1645
     */
1646
    int debug;
1647
#define FF_DEBUG_PICT_INFO   1
1648
#define FF_DEBUG_RC          2
1649
#define FF_DEBUG_BITSTREAM   4
1650
#define FF_DEBUG_MB_TYPE     8
1651
#define FF_DEBUG_QP          16
1652
#define FF_DEBUG_MV          32
1653
#define FF_DEBUG_DCT_COEFF   0x00000040
1654
#define FF_DEBUG_SKIP        0x00000080
1655
#define FF_DEBUG_STARTCODE   0x00000100
1656
#define FF_DEBUG_PTS         0x00000200
1657
#define FF_DEBUG_ER          0x00000400
1658
#define FF_DEBUG_MMCO        0x00000800
1659
#define FF_DEBUG_BUGS        0x00001000
1660
#define FF_DEBUG_VIS_QP      0x00002000
1661
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1662
#define FF_DEBUG_BUFFERS     0x00008000
1663

    
1664
    /**
1665
     * debug
1666
     * - encoding: Set by user.
1667
     * - decoding: Set by user.
1668
     */
1669
    int debug_mv;
1670
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1671
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1672
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1673

    
1674
    /**
1675
     * error
1676
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1677
     * - decoding: unused
1678
     */
1679
    uint64_t error[4];
1680

    
1681
    /**
1682
     * minimum MB quantizer
1683
     * - encoding: unused
1684
     * - decoding: unused
1685
     */
1686
    int mb_qmin;
1687

    
1688
    /**
1689
     * maximum MB quantizer
1690
     * - encoding: unused
1691
     * - decoding: unused
1692
     */
1693
    int mb_qmax;
1694

    
1695
    /**
1696
     * motion estimation comparison function
1697
     * - encoding: Set by user.
1698
     * - decoding: unused
1699
     */
1700
    int me_cmp;
1701
    /**
1702
     * subpixel motion estimation comparison function
1703
     * - encoding: Set by user.
1704
     * - decoding: unused
1705
     */
1706
    int me_sub_cmp;
1707
    /**
1708
     * macroblock comparison function (not supported yet)
1709
     * - encoding: Set by user.
1710
     * - decoding: unused
1711
     */
1712
    int mb_cmp;
1713
    /**
1714
     * interlaced DCT comparison function
1715
     * - encoding: Set by user.
1716
     * - decoding: unused
1717
     */
1718
    int ildct_cmp;
1719
#define FF_CMP_SAD    0
1720
#define FF_CMP_SSE    1
1721
#define FF_CMP_SATD   2
1722
#define FF_CMP_DCT    3
1723
#define FF_CMP_PSNR   4
1724
#define FF_CMP_BIT    5
1725
#define FF_CMP_RD     6
1726
#define FF_CMP_ZERO   7
1727
#define FF_CMP_VSAD   8
1728
#define FF_CMP_VSSE   9
1729
#define FF_CMP_NSSE   10
1730
#define FF_CMP_W53    11
1731
#define FF_CMP_W97    12
1732
#define FF_CMP_DCTMAX 13
1733
#define FF_CMP_DCT264 14
1734
#define FF_CMP_CHROMA 256
1735

    
1736
    /**
1737
     * ME diamond size & shape
1738
     * - encoding: Set by user.
1739
     * - decoding: unused
1740
     */
1741
    int dia_size;
1742

    
1743
    /**
1744
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1745
     * - encoding: Set by user.
1746
     * - decoding: unused
1747
     */
1748
    int last_predictor_count;
1749

    
1750
    /**
1751
     * prepass for motion estimation
1752
     * - encoding: Set by user.
1753
     * - decoding: unused
1754
     */
1755
    int pre_me;
1756

    
1757
    /**
1758
     * motion estimation prepass comparison function
1759
     * - encoding: Set by user.
1760
     * - decoding: unused
1761
     */
1762
    int me_pre_cmp;
1763

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

    
1771
    /**
1772
     * subpel ME quality
1773
     * - encoding: Set by user.
1774
     * - decoding: unused
1775
     */
1776
    int me_subpel_quality;
1777

    
1778
    /**
1779
     * callback to negotiate the pixelFormat
1780
     * @param fmt is the list of formats which are supported by the codec,
1781
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1782
     * The first is always the native one.
1783
     * @return the chosen format
1784
     * - encoding: unused
1785
     * - decoding: Set by user, if not set the native format will be chosen.
1786
     */
1787
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1788

    
1789
    /**
1790
     * DTG active format information (additional aspect ratio
1791
     * information only used in DVB MPEG-2 transport streams)
1792
     * 0 if not set.
1793
     *
1794
     * - encoding: unused
1795
     * - decoding: Set by decoder.
1796
     */
1797
    int dtg_active_format;
1798
#define FF_DTG_AFD_SAME         8
1799
#define FF_DTG_AFD_4_3          9
1800
#define FF_DTG_AFD_16_9         10
1801
#define FF_DTG_AFD_14_9         11
1802
#define FF_DTG_AFD_4_3_SP_14_9  13
1803
#define FF_DTG_AFD_16_9_SP_14_9 14
1804
#define FF_DTG_AFD_SP_4_3       15
1805

    
1806
    /**
1807
     * maximum motion estimation search range in subpel units
1808
     * If 0 then no limit.
1809
     *
1810
     * - encoding: Set by user.
1811
     * - decoding: unused
1812
     */
1813
    int me_range;
1814

    
1815
    /**
1816
     * intra quantizer bias
1817
     * - encoding: Set by user.
1818
     * - decoding: unused
1819
     */
1820
    int intra_quant_bias;
1821
#define FF_DEFAULT_QUANT_BIAS 999999
1822

    
1823
    /**
1824
     * inter quantizer bias
1825
     * - encoding: Set by user.
1826
     * - decoding: unused
1827
     */
1828
    int inter_quant_bias;
1829

    
1830
    /**
1831
     * color table ID
1832
     * - encoding: unused
1833
     * - decoding: Which clrtable should be used for 8bit RGB images.
1834
     *             Tables have to be stored somewhere. FIXME
1835
     */
1836
    int color_table_id;
1837

    
1838
    /**
1839
     * internal_buffer count
1840
     * Don't touch, used by libavcodec default_get_buffer().
1841
     */
1842
    int internal_buffer_count;
1843

    
1844
    /**
1845
     * internal_buffers
1846
     * Don't touch, used by libavcodec default_get_buffer().
1847
     */
1848
    void *internal_buffer;
1849

    
1850
#define FF_LAMBDA_SHIFT 7
1851
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1852
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1853
#define FF_LAMBDA_MAX (256*128-1)
1854

    
1855
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1856
    /**
1857
     * Global quality for codecs which cannot change it per frame.
1858
     * This should be proportional to MPEG-1/2/4 qscale.
1859
     * - encoding: Set by user.
1860
     * - decoding: unused
1861
     */
1862
    int global_quality;
1863

    
1864
#define FF_CODER_TYPE_VLC       0
1865
#define FF_CODER_TYPE_AC        1
1866
#define FF_CODER_TYPE_RAW       2
1867
#define FF_CODER_TYPE_RLE       3
1868
#define FF_CODER_TYPE_DEFLATE   4
1869
    /**
1870
     * coder type
1871
     * - encoding: Set by user.
1872
     * - decoding: unused
1873
     */
1874
    int coder_type;
1875

    
1876
    /**
1877
     * context model
1878
     * - encoding: Set by user.
1879
     * - decoding: unused
1880
     */
1881
    int context_model;
1882
#if 0
1883
    /**
1884
     *
1885
     * - encoding: unused
1886
     * - decoding: Set by user.
1887
     */
1888
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1889
#endif
1890

    
1891
    /**
1892
     * slice flags
1893
     * - encoding: unused
1894
     * - decoding: Set by user.
1895
     */
1896
    int slice_flags;
1897
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1898
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1899
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1900

    
1901
    /**
1902
     * XVideo Motion Acceleration
1903
     * - encoding: forbidden
1904
     * - decoding: set by decoder
1905
     */
1906
    int xvmc_acceleration;
1907

    
1908
    /**
1909
     * macroblock decision mode
1910
     * - encoding: Set by user.
1911
     * - decoding: unused
1912
     */
1913
    int mb_decision;
1914
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1915
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1916
#define FF_MB_DECISION_RD     2        ///< rate distortion
1917

    
1918
    /**
1919
     * custom intra quantization matrix
1920
     * - encoding: Set by user, can be NULL.
1921
     * - decoding: Set by libavcodec.
1922
     */
1923
    uint16_t *intra_matrix;
1924

    
1925
    /**
1926
     * custom inter quantization matrix
1927
     * - encoding: Set by user, can be NULL.
1928
     * - decoding: Set by libavcodec.
1929
     */
1930
    uint16_t *inter_matrix;
1931

    
1932
    /**
1933
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1934
     * This is used to work around some encoder bugs.
1935
     * - encoding: unused
1936
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1937
     */
1938
    unsigned int stream_codec_tag;
1939

    
1940
    /**
1941
     * scene change detection threshold
1942
     * 0 is default, larger means fewer detected scene changes.
1943
     * - encoding: Set by user.
1944
     * - decoding: unused
1945
     */
1946
    int scenechange_threshold;
1947

    
1948
    /**
1949
     * minimum Lagrange multipler
1950
     * - encoding: Set by user.
1951
     * - decoding: unused
1952
     */
1953
    int lmin;
1954

    
1955
    /**
1956
     * maximum Lagrange multipler
1957
     * - encoding: Set by user.
1958
     * - decoding: unused
1959
     */
1960
    int lmax;
1961

    
1962
    /**
1963
     * palette control structure
1964
     * - encoding: ??? (no palette-enabled encoder yet)
1965
     * - decoding: Set by user.
1966
     */
1967
    struct AVPaletteControl *palctrl;
1968

    
1969
    /**
1970
     * noise reduction strength
1971
     * - encoding: Set by user.
1972
     * - decoding: unused
1973
     */
1974
    int noise_reduction;
1975

    
1976
    /**
1977
     * Called at the beginning of a frame to get cr buffer for it.
1978
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
1979
     * libavcodec will pass previous buffer in pic, function should return
1980
     * same buffer or new buffer with old frame "painted" into it.
1981
     * If pic.data[0] == NULL must behave like get_buffer().
1982
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1983
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
1984
     * some other means.
1985
     * - encoding: unused
1986
     * - decoding: Set by libavcodec., user can override
1987
     */
1988
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1989

    
1990
    /**
1991
     * Number of bits which should be loaded into the rc buffer before decoding starts.
1992
     * - encoding: Set by user.
1993
     * - decoding: unused
1994
     */
1995
    int rc_initial_buffer_occupancy;
1996

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

    
2004
    /**
2005
     * CODEC_FLAG2_*
2006
     * - encoding: Set by user.
2007
     * - decoding: Set by user.
2008
     */
2009
    int flags2;
2010

    
2011
    /**
2012
     * Simulates errors in the bitstream to test error concealment.
2013
     * - encoding: Set by user.
2014
     * - decoding: unused
2015
     */
2016
    int error_rate;
2017

    
2018
    /**
2019
     * MP3 antialias algorithm, see FF_AA_* below.
2020
     * - encoding: unused
2021
     * - decoding: Set by user.
2022
     */
2023
    int antialias_algo;
2024
#define FF_AA_AUTO    0
2025
#define FF_AA_FASTINT 1 //not implemented yet
2026
#define FF_AA_INT     2
2027
#define FF_AA_FLOAT   3
2028
    /**
2029
     * quantizer noise shaping
2030
     * - encoding: Set by user.
2031
     * - decoding: unused
2032
     */
2033
    int quantizer_noise_shaping;
2034

    
2035
    /**
2036
     * thread count
2037
     * is used to decide how many independent tasks should be passed to execute()
2038
     * - encoding: Set by user.
2039
     * - decoding: Set by user.
2040
     */
2041
    int thread_count;
2042

    
2043
    /**
2044
     * The codec may call this to execute several independent things.
2045
     * It will return only after finishing all tasks.
2046
     * The user may replace this with some multithreaded implementation,
2047
     * the default implementation will execute the parts serially.
2048
     * @param count the number of things to execute
2049
     * - encoding: Set by libavcodec, user can override.
2050
     * - decoding: Set by libavcodec, user can override.
2051
     */
2052
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2053

    
2054
    /**
2055
     * thread opaque
2056
     * Can be used by execute() to store some per AVCodecContext stuff.
2057
     * - encoding: set by execute()
2058
     * - decoding: set by execute()
2059
     */
2060
    void *thread_opaque;
2061

    
2062
    /**
2063
     * Motion estimation threshold below which no motion estimation is
2064
     * performed, but instead the user specified motion vectors are used.
2065
     *
2066
     * - encoding: Set by user.
2067
     * - decoding: unused
2068
     */
2069
     int me_threshold;
2070

    
2071
    /**
2072
     * Macroblock threshold below which the user specified macroblock types will be used.
2073
     * - encoding: Set by user.
2074
     * - decoding: unused
2075
     */
2076
     int mb_threshold;
2077

    
2078
    /**
2079
     * precision of the intra DC coefficient - 8
2080
     * - encoding: Set by user.
2081
     * - decoding: unused
2082
     */
2083
     int intra_dc_precision;
2084

    
2085
    /**
2086
     * noise vs. sse weight for the nsse comparsion function
2087
     * - encoding: Set by user.
2088
     * - decoding: unused
2089
     */
2090
     int nsse_weight;
2091

    
2092
    /**
2093
     * Number of macroblock rows at the top which are skipped.
2094
     * - encoding: unused
2095
     * - decoding: Set by user.
2096
     */
2097
     int skip_top;
2098

    
2099
    /**
2100
     * Number of macroblock rows at the bottom which are skipped.
2101
     * - encoding: unused
2102
     * - decoding: Set by user.
2103
     */
2104
     int skip_bottom;
2105

    
2106
    /**
2107
     * profile
2108
     * - encoding: Set by user.
2109
     * - decoding: Set by libavcodec.
2110
     */
2111
     int profile;
2112
#define FF_PROFILE_UNKNOWN -99
2113
#define FF_PROFILE_AAC_MAIN 0
2114
#define FF_PROFILE_AAC_LOW  1
2115
#define FF_PROFILE_AAC_SSR  2
2116
#define FF_PROFILE_AAC_LTP  3
2117

    
2118
    /**
2119
     * level
2120
     * - encoding: Set by user.
2121
     * - decoding: Set by libavcodec.
2122
     */
2123
     int level;
2124
#define FF_LEVEL_UNKNOWN -99
2125

    
2126
    /**
2127
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2128
     * - encoding: unused
2129
     * - decoding: Set by user.
2130
     */
2131
     int lowres;
2132

    
2133
    /**
2134
     * Bitstream width / height, may be different from width/height if lowres
2135
     * or other things are used.
2136
     * - encoding: unused
2137
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2138
     */
2139
    int coded_width, coded_height;
2140

    
2141
    /**
2142
     * frame skip threshold
2143
     * - encoding: Set by user.
2144
     * - decoding: unused
2145
     */
2146
    int frame_skip_threshold;
2147

    
2148
    /**
2149
     * frame skip factor
2150
     * - encoding: Set by user.
2151
     * - decoding: unused
2152
     */
2153
    int frame_skip_factor;
2154

    
2155
    /**
2156
     * frame skip exponent
2157
     * - encoding: Set by user.
2158
     * - decoding: unused
2159
     */
2160
    int frame_skip_exp;
2161

    
2162
    /**
2163
     * frame skip comparison function
2164
     * - encoding: Set by user.
2165
     * - decoding: unused
2166
     */
2167
    int frame_skip_cmp;
2168

    
2169
    /**
2170
     * Border processing masking, raises the quantizer for mbs on the borders
2171
     * of the picture.
2172
     * - encoding: Set by user.
2173
     * - decoding: unused
2174
     */
2175
    float border_masking;
2176

    
2177
    /**
2178
     * minimum MB lagrange multipler
2179
     * - encoding: Set by user.
2180
     * - decoding: unused
2181
     */
2182
    int mb_lmin;
2183

    
2184
    /**
2185
     * maximum MB lagrange multipler
2186
     * - encoding: Set by user.
2187
     * - decoding: unused
2188
     */
2189
    int mb_lmax;
2190

    
2191
    /**
2192
     *
2193
     * - encoding: Set by user.
2194
     * - decoding: unused
2195
     */
2196
    int me_penalty_compensation;
2197

    
2198
    /**
2199
     *
2200
     * - encoding: unused
2201
     * - decoding: Set by user.
2202
     */
2203
    enum AVDiscard skip_loop_filter;
2204

    
2205
    /**
2206
     *
2207
     * - encoding: unused
2208
     * - decoding: Set by user.
2209
     */
2210
    enum AVDiscard skip_idct;
2211

    
2212
    /**
2213
     *
2214
     * - encoding: unused
2215
     * - decoding: Set by user.
2216
     */
2217
    enum AVDiscard skip_frame;
2218

    
2219
    /**
2220
     *
2221
     * - encoding: Set by user.
2222
     * - decoding: unused
2223
     */
2224
    int bidir_refine;
2225

    
2226
    /**
2227
     *
2228
     * - encoding: Set by user.
2229
     * - decoding: unused
2230
     */
2231
    int brd_scale;
2232

    
2233
    /**
2234
     * constant rate factor - quality-based VBR - values ~correspond to qps
2235
     * - encoding: Set by user.
2236
     * - decoding: unused
2237
     */
2238
    float crf;
2239

    
2240
    /**
2241
     * constant quantization parameter rate control method
2242
     * - encoding: Set by user.
2243
     * - decoding: unused
2244
     */
2245
    int cqp;
2246

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

    
2254
    /**
2255
     * number of reference frames
2256
     * - encoding: Set by user.
2257
     * - decoding: Set by lavc.
2258
     */
2259
    int refs;
2260

    
2261
    /**
2262
     * chroma qp offset from luma
2263
     * - encoding: Set by user.
2264
     * - decoding: unused
2265
     */
2266
    int chromaoffset;
2267

    
2268
    /**
2269
     * Influences how often B-frames are used.
2270
     * - encoding: Set by user.
2271
     * - decoding: unused
2272
     */
2273
    int bframebias;
2274

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

    
2282
    /**
2283
     * Reduce fluctuations in qp (before curve compression).
2284
     * - encoding: Set by user.
2285
     * - decoding: unused
2286
     */
2287
    float complexityblur;
2288

    
2289
    /**
2290
     * in-loop deblocking filter alphac0 parameter
2291
     * alpha is in the range -6...6
2292
     * - encoding: Set by user.
2293
     * - decoding: unused
2294
     */
2295
    int deblockalpha;
2296

    
2297
    /**
2298
     * in-loop deblocking filter beta parameter
2299
     * beta is in the range -6...6
2300
     * - encoding: Set by user.
2301
     * - decoding: unused
2302
     */
2303
    int deblockbeta;
2304

    
2305
    /**
2306
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2307
     * - encoding: Set by user.
2308
     * - decoding: unused
2309
     */
2310
    int partitions;
2311
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2312
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2313
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2314
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2315
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2316

    
2317
    /**
2318
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int directpred;
2323

    
2324
    /**
2325
     * Audio cutoff bandwidth (0 means "automatic")
2326
     * - encoding: Set by user.
2327
     * - decoding: unused
2328
     */
2329
    int cutoff;
2330

    
2331
    /**
2332
     * Multiplied by qscale for each frame and added to scene_change_score.
2333
     * - encoding: Set by user.
2334
     * - decoding: unused
2335
     */
2336
    int scenechange_factor;
2337

    
2338
    /**
2339
     *
2340
     * Note: Value depends upon the compare function used for fullpel ME.
2341
     * - encoding: Set by user.
2342
     * - decoding: unused
2343
     */
2344
    int mv0_threshold;
2345

    
2346
    /**
2347
     * Adjusts sensitivity of b_frame_strategy 1.
2348
     * - encoding: Set by user.
2349
     * - decoding: unused
2350
     */
2351
    int b_sensitivity;
2352

    
2353
    /**
2354
     * - encoding: Set by user.
2355
     * - decoding: unused
2356
     */
2357
    int compression_level;
2358
#define FF_COMPRESSION_DEFAULT -1
2359

    
2360
    /**
2361
     * Sets whether to use LPC mode - used by FLAC encoder.
2362
     * - encoding: Set by user.
2363
     * - decoding: unused
2364
     */
2365
    int use_lpc;
2366

    
2367
    /**
2368
     * LPC coefficient precision - used by FLAC encoder
2369
     * - encoding: Set by user.
2370
     * - decoding: unused
2371
     */
2372
    int lpc_coeff_precision;
2373

    
2374
    /**
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int min_prediction_order;
2379

    
2380
    /**
2381
     * - encoding: Set by user.
2382
     * - decoding: unused
2383
     */
2384
    int max_prediction_order;
2385

    
2386
    /**
2387
     * search method for selecting prediction order
2388
     * - encoding: Set by user.
2389
     * - decoding: unused
2390
     */
2391
    int prediction_order_method;
2392

    
2393
    /**
2394
     * - encoding: Set by user.
2395
     * - decoding: unused
2396
     */
2397
    int min_partition_order;
2398

    
2399
    /**
2400
     * - encoding: Set by user.
2401
     * - decoding: unused
2402
     */
2403
    int max_partition_order;
2404

    
2405
    /**
2406
     * GOP timecode frame start number, in non drop frame format
2407
     * - encoding: Set by user.
2408
     * - decoding: unused
2409
     */
2410
    int64_t timecode_frame_start;
2411

    
2412
#if LIBAVCODEC_VERSION_MAJOR < 53
2413
    /**
2414
     * Decoder should decode to this many channels if it can (0 for default)
2415
     * - encoding: unused
2416
     * - decoding: Set by user.
2417
     * @deprecated Deprecated in favor of request_channel_layout.
2418
     */
2419
    int request_channels;
2420
#endif
2421

    
2422
    /**
2423
     * Percentage of dynamic range compression to be applied by the decoder.
2424
     * The default value is 1.0, corresponding to full compression.
2425
     * - encoding: unused
2426
     * - decoding: Set by user.
2427
     */
2428
    float drc_scale;
2429

    
2430
    /**
2431
     * opaque 64bit number (generally a PTS) that will be reordered and
2432
     * output in AVFrame.reordered_opaque
2433
     * - encoding: unused
2434
     * - decoding: Set by user.
2435
     */
2436
    int64_t reordered_opaque;
2437

    
2438
    /**
2439
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2440
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2441
     * - encoding: set by user.
2442
     * - decoding: set by libavcodec.
2443
     */
2444
    int bits_per_raw_sample;
2445

    
2446
    /**
2447
     * Audio channel layout.
2448
     * - encoding: set by user.
2449
     * - decoding: set by libavcodec.
2450
     */
2451
    int64_t channel_layout;
2452

    
2453
    /**
2454
     * Request decoder to use this channel layout if it can (0 for default)
2455
     * - encoding: unused
2456
     * - decoding: Set by user.
2457
     */
2458
    int64_t request_channel_layout;
2459

    
2460
    /**
2461
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2462
     * - encoding: Set by user.
2463
     * - decoding: unused.
2464
     */
2465
    float rc_max_available_vbv_use;
2466

    
2467
    /**
2468
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2469
     * - encoding: Set by user.
2470
     * - decoding: unused.
2471
     */
2472
    float rc_min_vbv_overflow_use;
2473

    
2474
    /**
2475
     * Hardware accelerator in use
2476
     * - encoding: unused.
2477
     * - decoding: Set by libavcodec
2478
     */
2479
    struct AVHWAccel *hwaccel;
2480

    
2481
    /**
2482
     * For some codecs, the time base is closer to the field rate than the frame rate.
2483
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2484
     * if no telecine is used ...
2485
     *
2486
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2487
     */
2488
    int ticks_per_frame;
2489

    
2490
    /**
2491
     * Hardware accelerator context.
2492
     * For some hardware accelerators, a global context needs to be
2493
     * provided by the user. In that case, this holds display-dependent
2494
     * data FFmpeg cannot instantiate itself. Please refer to the
2495
     * FFmpeg HW accelerator documentation to know how to fill this
2496
     * is. e.g. for VA API, this is a struct vaapi_context.
2497
     * - encoding: unused
2498
     * - decoding: Set by user
2499
     */
2500
    void *hwaccel_context;
2501

    
2502
    /**
2503
     * Chromaticity coordinates of the source primaries.
2504
     * - encoding: Set by user
2505
     * - decoding: Set by libavcodec
2506
     */
2507
    enum AVColorPrimaries color_primaries;
2508

    
2509
    /**
2510
     * Color Transfer Characteristic.
2511
     * - encoding: Set by user
2512
     * - decoding: Set by libavcodec
2513
     */
2514
    enum AVColorTransferCharacteristic color_trc;
2515

    
2516
    /**
2517
     * YUV colorspace type.
2518
     * - encoding: Set by user
2519
     * - decoding: Set by libavcodec
2520
     */
2521
    enum AVColorSpace colorspace;
2522

    
2523
    /**
2524
     * MPEG vs JPEG YUV range.
2525
     * - encoding: Set by user
2526
     * - decoding: Set by libavcodec
2527
     */
2528
    enum AVColorRange color_range;
2529

    
2530
    /**
2531
     * This defines the location of chroma samples.
2532
     * - encoding: Set by user
2533
     * - decoding: Set by libavcodec
2534
     */
2535
    enum AVChromaLocation chroma_sample_location;
2536

    
2537
    /**
2538
     * The codec may call this to execute several independent things.
2539
     * It will return only after finishing all tasks.
2540
     * The user may replace this with some multithreaded implementation,
2541
     * the default implementation will execute the parts serially.
2542
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2543
     * @param c context passed also to func
2544
     * @param count the number of things to execute
2545
     * @param arg2 argument passed unchanged to func
2546
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2547
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2548
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2549
     *             two instances of func executing at the same time will have the same threadnr.
2550
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2551
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2552
     * - encoding: Set by libavcodec, user can override.
2553
     * - decoding: Set by libavcodec, user can override.
2554
     */
2555
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2556
} AVCodecContext;
2557

    
2558
/**
2559
 * AVCodec.
2560
 */
2561
typedef struct AVCodec {
2562
    /**
2563
     * Name of the codec implementation.
2564
     * The name is globally unique among encoders and among decoders (but an
2565
     * encoder and a decoder can share the same name).
2566
     * This is the primary way to find a codec from the user perspective.
2567
     */
2568
    const char *name;
2569
    enum CodecType type;
2570
    enum CodecID id;
2571
    int priv_data_size;
2572
    int (*init)(AVCodecContext *);
2573
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2574
    int (*close)(AVCodecContext *);
2575
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2576
    /**
2577
     * Codec capabilities.
2578
     * see CODEC_CAP_*
2579
     */
2580
    int capabilities;
2581
    struct AVCodec *next;
2582
    /**
2583
     * Flush buffers.
2584
     * Will be called when seeking
2585
     */
2586
    void (*flush)(AVCodecContext *);
2587
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2588
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2589
    /**
2590
     * Descriptive name for the codec, meant to be more human readable than name.
2591
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2592
     */
2593
    const char *long_name;
2594
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2595
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2596
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2597
} AVCodec;
2598

    
2599
/**
2600
 * AVHWAccel.
2601
 */
2602
typedef struct AVHWAccel {
2603
    /**
2604
     * Name of the hardware accelerated codec.
2605
     * The name is globally unique among encoders and among decoders (but an
2606
     * encoder and a decoder can share the same name).
2607
     */
2608
    const char *name;
2609

    
2610
    /**
2611
     * Type of codec implemented by the hardware accelerator.
2612
     *
2613
     * See CODEC_TYPE_xxx
2614
     */
2615
    enum CodecType type;
2616

    
2617
    /**
2618
     * Codec implemented by the hardware accelerator.
2619
     *
2620
     * See CODEC_ID_xxx
2621
     */
2622
    enum CodecID id;
2623

    
2624
    /**
2625
     * Supported pixel format.
2626
     *
2627
     * Only hardware accelerated formats are supported here.
2628
     */
2629
    enum PixelFormat pix_fmt;
2630

    
2631
    /**
2632
     * Hardware accelerated codec capabilities.
2633
     * see FF_HWACCEL_CODEC_CAP_*
2634
     */
2635
    int capabilities;
2636

    
2637
    struct AVHWAccel *next;
2638

    
2639
    /**
2640
     * Called at the beginning of each frame or field picture.
2641
     *
2642
     * Meaningful frame information (codec specific) is guaranteed to
2643
     * be parsed at this point. This function is mandatory.
2644
     *
2645
     * Note that buf can be NULL along with buf_size set to 0.
2646
     * Otherwise, this means the whole frame is available at this point.
2647
     *
2648
     * @param avctx the codec context
2649
     * @param buf the frame data buffer base
2650
     * @param buf_size the size of the frame in bytes
2651
     * @return zero if successful, a negative value otherwise
2652
     */
2653
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2654

    
2655
    /**
2656
     * Callback for each slice.
2657
     *
2658
     * Meaningful slice information (codec specific) is guaranteed to
2659
     * be parsed at this point. This function is mandatory.
2660
     *
2661
     * @param avctx the codec context
2662
     * @param buf the slice data buffer base
2663
     * @param buf_size the size of the slice in bytes
2664
     * @return zero if successful, a negative value otherwise
2665
     */
2666
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2667

    
2668
    /**
2669
     * Called at the end of each frame or field picture.
2670
     *
2671
     * The whole picture is parsed at this point and can now be sent
2672
     * to the hardware accelerator. This function is mandatory.
2673
     *
2674
     * @param avctx the codec context
2675
     * @return zero if successful, a negative value otherwise
2676
     */
2677
    int (*end_frame)(AVCodecContext *avctx);
2678

    
2679
    /**
2680
     * Size of HW accelerator private data.
2681
     *
2682
     * Private data is allocated with av_mallocz() before
2683
     * AVCodecContext.get_buffer() and deallocated after
2684
     * AVCodecContext.release_buffer().
2685
     */
2686
    int priv_data_size;
2687
} AVHWAccel;
2688

    
2689
/**
2690
 * four components are given, that's all.
2691
 * the last component is alpha
2692
 */
2693
typedef struct AVPicture {
2694
    uint8_t *data[4];
2695
    int linesize[4];       ///< number of bytes per line
2696
} AVPicture;
2697

    
2698
#if LIBAVCODEC_VERSION_MAJOR < 53
2699
/**
2700
 * AVPaletteControl
2701
 * This structure defines a method for communicating palette changes
2702
 * between and demuxer and a decoder.
2703
 *
2704
 * @deprecated Use AVPacket to send palette changes instead.
2705
 * This is totally broken.
2706
 */
2707
#define AVPALETTE_SIZE 1024
2708
#define AVPALETTE_COUNT 256
2709
typedef struct AVPaletteControl {
2710

    
2711
    /* Demuxer sets this to 1 to indicate the palette has changed;
2712
     * decoder resets to 0. */
2713
    int palette_changed;
2714

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

    
2721
} AVPaletteControl attribute_deprecated;
2722
#endif
2723

    
2724
enum AVSubtitleType {
2725
    SUBTITLE_NONE,
2726

    
2727
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2728

    
2729
    /**
2730
     * Plain text, the text field must be set by the decoder and is
2731
     * authoritative. ass and pict fields may contain approximations.
2732
     */
2733
    SUBTITLE_TEXT,
2734

    
2735
    /**
2736
     * Formatted text, the ass field must be set by the decoder and is
2737
     * authoritative. pict and text fields may contain approximations.
2738
     */
2739
    SUBTITLE_ASS,
2740
};
2741

    
2742
typedef struct AVSubtitleRect {
2743
    int x;         ///< top left corner  of pict, undefined when pict is not set
2744
    int y;         ///< top left corner  of pict, undefined when pict is not set
2745
    int w;         ///< width            of pict, undefined when pict is not set
2746
    int h;         ///< height           of pict, undefined when pict is not set
2747
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2748

    
2749
    /**
2750
     * data+linesize for the bitmap of this subtitle.
2751
     * can be set for text/ass as well once they where rendered
2752
     */
2753
    AVPicture pict;
2754
    enum AVSubtitleType type;
2755

    
2756
    char *text;                     ///< 0 terminated plain UTF-8 text
2757

    
2758
    /**
2759
     * 0 terminated ASS/SSA compatible event line.
2760
     * The pressentation of this is unaffected by the other values in this
2761
     * struct.
2762
     */
2763
    char *ass;
2764
} AVSubtitleRect;
2765

    
2766
typedef struct AVSubtitle {
2767
    uint16_t format; /* 0 = graphics */
2768
    uint32_t start_display_time; /* relative to packet pts, in ms */
2769
    uint32_t end_display_time; /* relative to packet pts, in ms */
2770
    unsigned num_rects;
2771
    AVSubtitleRect **rects;
2772
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2773
} AVSubtitle;
2774

    
2775
/* packet functions */
2776

    
2777
/**
2778
 * @deprecated use NULL instead
2779
 */
2780
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2781

    
2782
/**
2783
 * Default packet destructor.
2784
 */
2785
void av_destruct_packet(AVPacket *pkt);
2786

    
2787
/**
2788
 * Initialize optional fields of a packet with default values.
2789
 *
2790
 * @param pkt packet
2791
 */
2792
void av_init_packet(AVPacket *pkt);
2793

    
2794
/**
2795
 * Allocate the payload of a packet and initialize its fields with
2796
 * default values.
2797
 *
2798
 * @param pkt packet
2799
 * @param size wanted payload size
2800
 * @return 0 if OK, AVERROR_xxx otherwise
2801
 */
2802
int av_new_packet(AVPacket *pkt, int size);
2803

    
2804
/**
2805
 * Reduce packet size, correctly zeroing padding
2806
 *
2807
 * @param pkt packet
2808
 * @param size new size
2809
 */
2810
void av_shrink_packet(AVPacket *pkt, int size);
2811

    
2812
/**
2813
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2814
 * packet is allocated if it was not really allocated.
2815
 */
2816
int av_dup_packet(AVPacket *pkt);
2817

    
2818
/**
2819
 * Free a packet.
2820
 *
2821
 * @param pkt packet to free
2822
 */
2823
void av_free_packet(AVPacket *pkt);
2824

    
2825
/* resample.c */
2826

    
2827
struct ReSampleContext;
2828
struct AVResampleContext;
2829

    
2830
typedef struct ReSampleContext ReSampleContext;
2831

    
2832
#if LIBAVCODEC_VERSION_MAJOR < 53
2833
/**
2834
 * @deprecated Use av_audio_resample_init() instead.
2835
 */
2836
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2837
                                                          int output_rate, int input_rate);
2838
#endif
2839
/**
2840
 *  Initializes audio resampling context
2841
 *
2842
 * @param output_channels  number of output channels
2843
 * @param input_channels   number of input channels
2844
 * @param output_rate      output sample rate
2845
 * @param input_rate       input sample rate
2846
 * @param sample_fmt_out   requested output sample format
2847
 * @param sample_fmt_in    input sample format
2848
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2849
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2850
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2851
                           between the 2 closest, if 0 the closest will be used
2852
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2853
 * @return allocated ReSampleContext, NULL if error occured
2854
 */
2855
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2856
                                        int output_rate, int input_rate,
2857
                                        enum SampleFormat sample_fmt_out,
2858
                                        enum SampleFormat sample_fmt_in,
2859
                                        int filter_length, int log2_phase_count,
2860
                                        int linear, double cutoff);
2861

    
2862
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2863
void audio_resample_close(ReSampleContext *s);
2864

    
2865

    
2866
/**
2867
 * Initializes an audio resampler.
2868
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2869
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2870
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2871
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2872
                 between the 2 closest, if 0 the closest will be used
2873
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2874
 */
2875
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2876

    
2877
/**
2878
 * resamples.
2879
 * @param src an array of unconsumed samples
2880
 * @param consumed the number of samples of src which have been consumed are returned here
2881
 * @param src_size the number of unconsumed samples available
2882
 * @param dst_size the amount of space in samples available in dst
2883
 * @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.
2884
 * @return the number of samples written in dst or -1 if an error occurred
2885
 */
2886
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2887

    
2888

    
2889
/**
2890
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2891
 * the resampler parameters, so no audible clicks or similar distortions occur
2892
 * @param compensation_distance distance in output samples over which the compensation should be performed
2893
 * @param sample_delta number of output samples which should be output less
2894
 *
2895
 * example: av_resample_compensate(c, 10, 500)
2896
 * here instead of 510 samples only 500 samples would be output
2897
 *
2898
 * note, due to rounding the actual compensation might be slightly different,
2899
 * especially if the compensation_distance is large and the in_rate used during init is small
2900
 */
2901
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2902
void av_resample_close(struct AVResampleContext *c);
2903

    
2904
/**
2905
 * Allocate memory for a picture.  Call avpicture_free to free it.
2906
 *
2907
 * @param picture the picture to be filled in
2908
 * @param pix_fmt the format of the picture
2909
 * @param width the width of the picture
2910
 * @param height the height of the picture
2911
 * @return zero if successful, a negative value if not
2912
 */
2913
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2914

    
2915
/**
2916
 * Free a picture previously allocated by avpicture_alloc().
2917
 *
2918
 * @param picture the AVPicture to be freed
2919
 */
2920
void avpicture_free(AVPicture *picture);
2921

    
2922
/**
2923
 * Fill in the AVPicture fields.
2924
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2925
 * which points to the image data buffer. Depending on the specified picture
2926
 * format, one or multiple image data pointers and line sizes will be set.
2927
 * If a planar format is specified, several pointers will be set pointing to
2928
 * the different picture planes and the line sizes of the different planes
2929
 * will be stored in the lines_sizes array.
2930
 * Call with ptr == NULL to get the required size for the ptr buffer.
2931
 *
2932
 * @param picture AVPicture whose fields are to be filled in
2933
 * @param ptr Buffer which will contain or contains the actual image data
2934
 * @param pix_fmt The format in which the picture data is stored.
2935
 * @param width the width of the image in pixels
2936
 * @param height the height of the image in pixels
2937
 * @return size of the image data in bytes
2938
 */
2939
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2940
                   enum PixelFormat pix_fmt, int width, int height);
2941
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2942
                     unsigned char *dest, int dest_size);
2943

    
2944
/**
2945
 * Calculate the size in bytes that a picture of the given width and height
2946
 * would occupy if stored in the given picture format.
2947
 * Note that this returns the size of a compact representation as generated
2948
 * by avpicture_layout, which can be smaller than the size required for e.g.
2949
 * avpicture_fill.
2950
 *
2951
 * @param pix_fmt the given picture format
2952
 * @param width the width of the image
2953
 * @param height the height of the image
2954
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2955
 */
2956
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2957
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2958
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2959
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2960

    
2961
/**
2962
 * Returns the pixel format corresponding to the name name.
2963
 *
2964
 * If there is no pixel format with name name, then looks for a
2965
 * pixel format with the name corresponding to the native endian
2966
 * format of name.
2967
 * For example in a little-endian system, first looks for "gray16",
2968
 * then for "gray16le".
2969
 *
2970
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
2971
 */
2972
enum PixelFormat avcodec_get_pix_fmt(const char* name);
2973
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2974

    
2975
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2976
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2977
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2978
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2979
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2980
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2981

    
2982
/**
2983
 * Computes what kind of losses will occur when converting from one specific
2984
 * pixel format to another.
2985
 * When converting from one pixel format to another, information loss may occur.
2986
 * For example, when converting from RGB24 to GRAY, the color information will
2987
 * be lost. Similarly, other losses occur when converting from some formats to
2988
 * other formats. These losses can involve loss of chroma, but also loss of
2989
 * resolution, loss of color depth, loss due to the color space conversion, loss
2990
 * of the alpha bits or loss due to color quantization.
2991
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2992
 * which will occur when converting from one pixel format to another.
2993
 *
2994
 * @param[in] dst_pix_fmt destination pixel format
2995
 * @param[in] src_pix_fmt source pixel format
2996
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2997
 * @return Combination of flags informing you what kind of losses will occur.
2998
 */
2999
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3000
                             int has_alpha);
3001

    
3002
/**
3003
 * Finds the best pixel format to convert to given a certain source pixel
3004
 * format.  When converting from one pixel format to another, information loss
3005
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3006
 * information will be lost. Similarly, other losses occur when converting from
3007
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3008
 * the given pixel formats should be used to suffer the least amount of loss.
3009
 * The pixel formats from which it chooses one, are determined by the
3010
 * pix_fmt_mask parameter.
3011
 *
3012
 * @code
3013
 * src_pix_fmt = PIX_FMT_YUV420P;
3014
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3015
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3016
 * @endcode
3017
 *
3018
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3019
 * @param[in] src_pix_fmt source pixel format
3020
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3021
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3022
 * @return The best pixel format to convert to or -1 if none was found.
3023
 */
3024
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3025
                              int has_alpha, int *loss_ptr);
3026

    
3027

    
3028
/**
3029
 * Print in buf the string corresponding to the pixel format with
3030
 * number pix_fmt, or an header if pix_fmt is negative.
3031
 *
3032
 * @param[in] buf the buffer where to write the string
3033
 * @param[in] buf_size the size of buf
3034
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3035
 * a negative value to print the corresponding header.
3036
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3037
 */
3038
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3039

    
3040
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3041
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3042

    
3043
/**
3044
 * Tell if an image really has transparent alpha values.
3045
 * @return ored mask of FF_ALPHA_xxx constants
3046
 */
3047
int img_get_alpha_info(const AVPicture *src,
3048
                       enum PixelFormat pix_fmt, int width, int height);
3049

    
3050
/* deinterlace a picture */
3051
/* deinterlace - if not supported return -1 */
3052
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3053
                          enum PixelFormat pix_fmt, int width, int height);
3054

    
3055
/* external high level API */
3056

    
3057
/**
3058
 * If c is NULL, returns the first registered codec,
3059
 * if c is non-NULL, returns the next registered codec after c,
3060
 * or NULL if c is the last one.
3061
 */
3062
AVCodec *av_codec_next(AVCodec *c);
3063

    
3064
/**
3065
 * Returns the LIBAVCODEC_VERSION_INT constant.
3066
 */
3067
unsigned avcodec_version(void);
3068

    
3069
/**
3070
 * Returns the libavcodec build-time configuration.
3071
 */
3072
const char * avcodec_configuration(void);
3073

    
3074
/**
3075
 * Returns the libavcodec license.
3076
 */
3077
const char * avcodec_license(void);
3078

    
3079
/**
3080
 * Initializes libavcodec.
3081
 *
3082
 * @warning This function must be called before any other libavcodec
3083
 * function.
3084
 */
3085
void avcodec_init(void);
3086

    
3087
#if LIBAVCODEC_VERSION_MAJOR < 53
3088
/**
3089
 * @deprecated Deprecated in favor of avcodec_register().
3090
 */
3091
attribute_deprecated void register_avcodec(AVCodec *codec);
3092
#endif
3093

    
3094
/**
3095
 * Register the codec codec and initialize libavcodec.
3096
 *
3097
 * @see avcodec_init()
3098
 */
3099
void avcodec_register(AVCodec *codec);
3100

    
3101
/**
3102
 * Finds a registered encoder with a matching codec ID.
3103
 *
3104
 * @param id CodecID of the requested encoder
3105
 * @return An encoder if one was found, NULL otherwise.
3106
 */
3107
AVCodec *avcodec_find_encoder(enum CodecID id);
3108

    
3109
/**
3110
 * Finds a registered encoder with the specified name.
3111
 *
3112
 * @param name name of the requested encoder
3113
 * @return An encoder if one was found, NULL otherwise.
3114
 */
3115
AVCodec *avcodec_find_encoder_by_name(const char *name);
3116

    
3117
/**
3118
 * Finds a registered decoder with a matching codec ID.
3119
 *
3120
 * @param id CodecID of the requested decoder
3121
 * @return A decoder if one was found, NULL otherwise.
3122
 */
3123
AVCodec *avcodec_find_decoder(enum CodecID id);
3124

    
3125
/**
3126
 * Finds a registered decoder with the specified name.
3127
 *
3128
 * @param name name of the requested decoder
3129
 * @return A decoder if one was found, NULL otherwise.
3130
 */
3131
AVCodec *avcodec_find_decoder_by_name(const char *name);
3132
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3133

    
3134
/**
3135
 * Sets the fields of the given AVCodecContext to default values.
3136
 *
3137
 * @param s The AVCodecContext of which the fields should be set to default values.
3138
 */
3139
void avcodec_get_context_defaults(AVCodecContext *s);
3140

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

    
3145
/**
3146
 * Allocates an AVCodecContext and sets its fields to default values.  The
3147
 * resulting struct can be deallocated by simply calling av_free().
3148
 *
3149
 * @return An AVCodecContext filled with default values or NULL on failure.
3150
 * @see avcodec_get_context_defaults
3151
 */
3152
AVCodecContext *avcodec_alloc_context(void);
3153

    
3154
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3155
 *  we WILL change its arguments and name a few times! */
3156
AVCodecContext *avcodec_alloc_context2(enum CodecType);
3157

    
3158
/**
3159
 * Sets the fields of the given AVFrame to default values.
3160
 *
3161
 * @param pic The AVFrame of which the fields should be set to default values.
3162
 */
3163
void avcodec_get_frame_defaults(AVFrame *pic);
3164

    
3165
/**
3166
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3167
 * struct can be deallocated by simply calling av_free().
3168
 *
3169
 * @return An AVFrame filled with default values or NULL on failure.
3170
 * @see avcodec_get_frame_defaults
3171
 */
3172
AVFrame *avcodec_alloc_frame(void);
3173

    
3174
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3175
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3176
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3177
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3178

    
3179
/**
3180
 * Checks if the given dimension of a picture is valid, meaning that all
3181
 * bytes of the picture can be addressed with a signed int.
3182
 *
3183
 * @param[in] w Width of the picture.
3184
 * @param[in] h Height of the picture.
3185
 * @return Zero if valid, a negative value if invalid.
3186
 */
3187
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3188
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3189

    
3190
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3191
void avcodec_thread_free(AVCodecContext *s);
3192
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3193
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3194
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3195
//FIXME func typedef
3196

    
3197
/**
3198
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3199
 * function the context has to be allocated.
3200
 *
3201
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3202
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3203
 * retrieving a codec.
3204
 *
3205
 * @warning This function is not thread safe!
3206
 *
3207
 * @code
3208
 * avcodec_register_all();
3209
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3210
 * if (!codec)
3211
 *     exit(1);
3212
 *
3213
 * context = avcodec_alloc_context();
3214
 *
3215
 * if (avcodec_open(context, codec) < 0)
3216
 *     exit(1);
3217
 * @endcode
3218
 *
3219
 * @param avctx The context which will be set up to use the given codec.
3220
 * @param codec The codec to use within the context.
3221
 * @return zero on success, a negative value on error
3222
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3223
 */
3224
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3225

    
3226
#if LIBAVCODEC_VERSION_MAJOR < 53
3227
/**
3228
 * Decodes an audio frame from buf into samples.
3229
 * Wrapper function which calls avcodec_decode_audio3.
3230
 *
3231
 * @deprecated Use avcodec_decode_audio3 instead.
3232
 * @param avctx the codec context
3233
 * @param[out] samples the output buffer
3234
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3235
 * @param[in] buf the input buffer
3236
 * @param[in] buf_size the input buffer size in bytes
3237
 * @return On error a negative value is returned, otherwise the number of bytes
3238
 * used or zero if no frame could be decompressed.
3239
 */
3240
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3241
                         int *frame_size_ptr,
3242
                         const uint8_t *buf, int buf_size);
3243
#endif
3244

    
3245
/**
3246
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3247
 * Some decoders may support multiple frames in a single AVPacket, such
3248
 * decoders would then just decode the first frame. In this case,
3249
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3250
 * the remaining data in order to decode the second frame etc.
3251
 * If no frame
3252
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3253
 * decompressed frame size in bytes.
3254
 *
3255
 * @warning You must set frame_size_ptr to the allocated size of the
3256
 * output buffer before calling avcodec_decode_audio3().
3257
 *
3258
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3259
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3260
 * bits at once and could read over the end.
3261
 *
3262
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3263
 * no overreading happens for damaged MPEG streams.
3264
 *
3265
 * @note You might have to align the input buffer avpkt->data and output buffer
3266
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3267
 * necessary at all, on others it won't work at all if not aligned and on others
3268
 * it will work but it will have an impact on performance.
3269
 *
3270
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3271
 * samples should be 16 byte aligned unless the CPU doesn't need it
3272
 * (AltiVec and SSE do).
3273
 *
3274
 * @param avctx the codec context
3275
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3276
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3277
 * @param[in] avpkt The input AVPacket containing the input buffer.
3278
 *            You can create such packet with av_init_packet() and by then setting
3279
 *            data and size, some decoders might in addition need other fields.
3280
 *            All decoders are designed to use the least fields possible though.
3281
 * @return On error a negative value is returned, otherwise the number of bytes
3282
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3283
 */
3284
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3285
                         int *frame_size_ptr,
3286
                         AVPacket *avpkt);
3287

    
3288
#if LIBAVCODEC_VERSION_MAJOR < 53
3289
/**
3290
 * Decodes a video frame from buf into picture.
3291
 * Wrapper function which calls avcodec_decode_video2.
3292
 *
3293
 * @deprecated Use avcodec_decode_video2 instead.
3294
 * @param avctx the codec context
3295
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3296
 * @param[in] buf the input buffer
3297
 * @param[in] buf_size the size of the input buffer in bytes
3298
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3299
 * @return On error a negative value is returned, otherwise the number of bytes
3300
 * used or zero if no frame could be decompressed.
3301
 */
3302
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3303
                         int *got_picture_ptr,
3304
                         const uint8_t *buf, int buf_size);
3305
#endif
3306

    
3307
/**
3308
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3309
 * Some decoders may support multiple frames in a single AVPacket, such
3310
 * decoders would then just decode the first frame.
3311
 *
3312
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3313
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3314
 * bits at once and could read over the end.
3315
 *
3316
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3317
 * no overreading happens for damaged MPEG streams.
3318
 *
3319
 * @note You might have to align the input buffer avpkt->data.
3320
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3321
 * necessary at all, on others it won't work at all if not aligned and on others
3322
 * it will work but it will have an impact on performance.
3323
 *
3324
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3325
 *
3326
 * @note Some codecs have a delay between input and output, these need to be
3327
 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3328
 *
3329
 * @param avctx the codec context
3330
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3331
 * @param[in] avpkt The input AVpacket containing the input buffer.
3332
 *            You can create such packet with av_init_packet() and by then setting
3333
 *            data and size, some decoders might in addition need other fields like
3334
 *            flags&PKT_FLAG_KEY. All decoders are designed to use the least
3335
 *            fields possible.
3336
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3337
 * @return On error a negative value is returned, otherwise the number of bytes
3338
 * used or zero if no frame could be decompressed.
3339
 */
3340
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3341
                         int *got_picture_ptr,
3342
                         AVPacket *avpkt);
3343

    
3344
#if LIBAVCODEC_VERSION_MAJOR < 53
3345
/* Decode a subtitle message. Return -1 if error, otherwise return the
3346
 * number of bytes used. If no subtitle could be decompressed,
3347
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3348
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3349
                            int *got_sub_ptr,
3350
                            const uint8_t *buf, int buf_size);
3351
#endif
3352

    
3353
/**
3354
 * Decodes a subtitle message.
3355
 * Returns a negative value on error, otherwise returns the number of bytes used.
3356
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3357
 * Otherwise, the subtitle is stored in *sub.
3358
 *
3359
 * @param avctx the codec context
3360
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3361
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3362
 * @param[in] avpkt The input AVPacket containing the input buffer.
3363
 */
3364
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3365
                            int *got_sub_ptr,
3366
                            AVPacket *avpkt);
3367
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3368
                        int *data_size_ptr,
3369
                        uint8_t *buf, int buf_size);
3370

    
3371
/**
3372
 * Encodes an audio frame from samples into buf.
3373
 *
3374
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3375
 * However, for PCM audio the user will know how much space is needed
3376
 * because it depends on the value passed in buf_size as described
3377
 * below. In that case a lower value can be used.
3378
 *
3379
 * @param avctx the codec context
3380
 * @param[out] buf the output buffer
3381
 * @param[in] buf_size the output buffer size
3382
 * @param[in] samples the input buffer containing the samples
3383
 * The number of samples read from this buffer is frame_size*channels,
3384
 * both of which are defined in avctx.
3385
 * For PCM audio the number of samples read from samples is equal to
3386
 * buf_size * input_sample_size / output_sample_size.
3387
 * @return On error a negative value is returned, on success zero or the number
3388
 * of bytes used to encode the data read from the input buffer.
3389
 */
3390
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3391
                         const short *samples);
3392

    
3393
/**
3394
 * Encodes a video frame from pict into buf.
3395
 * The input picture should be
3396
 * stored using a specific format, namely avctx.pix_fmt.
3397
 *
3398
 * @param avctx the codec context
3399
 * @param[out] buf the output buffer for the bitstream of encoded frame
3400
 * @param[in] buf_size the size of the output buffer in bytes
3401
 * @param[in] pict the input picture to encode
3402
 * @return On error a negative value is returned, on success zero or the number
3403
 * of bytes used from the output buffer.
3404
 */
3405
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3406
                         const AVFrame *pict);
3407
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3408
                            const AVSubtitle *sub);
3409

    
3410
int avcodec_close(AVCodecContext *avctx);
3411

    
3412
/**
3413
 * Register all the codecs, parsers and bitstream filters which were enabled at
3414
 * configuration time. If you do not call this function you can select exactly
3415
 * which formats you want to support, by using the individual registration
3416
 * functions.
3417
 *
3418
 * @see avcodec_register
3419
 * @see av_register_codec_parser
3420
 * @see av_register_bitstream_filter
3421
 */
3422
void avcodec_register_all(void);
3423

    
3424
/**
3425
 * Flush buffers, should be called when seeking or when switching to a different stream.
3426
 */
3427
void avcodec_flush_buffers(AVCodecContext *avctx);
3428

    
3429
void avcodec_default_free_buffers(AVCodecContext *s);
3430

    
3431
/* misc useful functions */
3432

    
3433
/**
3434
 * Returns a single letter to describe the given picture type pict_type.
3435
 *
3436
 * @param[in] pict_type the picture type
3437
 * @return A single character representing the picture type.
3438
 */
3439
char av_get_pict_type_char(int pict_type);
3440

    
3441
/**
3442
 * Returns codec bits per sample.
3443
 *
3444
 * @param[in] codec_id the codec
3445
 * @return Number of bits per sample or zero if unknown for the given codec.
3446
 */
3447
int av_get_bits_per_sample(enum CodecID codec_id);
3448

    
3449
/**
3450
 * Returns sample format bits per sample.
3451
 *
3452
 * @param[in] sample_fmt the sample format
3453
 * @return Number of bits per sample or zero if unknown for the given sample format.
3454
 */
3455
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3456

    
3457
/* frame parsing */
3458
typedef struct AVCodecParserContext {
3459
    void *priv_data;
3460
    struct AVCodecParser *parser;
3461
    int64_t frame_offset; /* offset of the current frame */
3462
    int64_t cur_offset; /* current offset
3463
                           (incremented by each av_parser_parse()) */
3464
    int64_t next_frame_offset; /* offset of the next frame */
3465
    /* video info */
3466
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3467
    /**
3468
     * This field is used for proper frame duration computation in lavf.
3469
     * It signals, how much longer the frame duration of the current frame
3470
     * is compared to normal frame duration.
3471
     *
3472
     * frame_duration = (1 + repeat_pict) * time_base
3473
     *
3474
     * It is used by codecs like H.264 to display telecined material.
3475
     */
3476
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3477
    int64_t pts;     /* pts of the current frame */
3478
    int64_t dts;     /* dts of the current frame */
3479

    
3480
    /* private data */
3481
    int64_t last_pts;
3482
    int64_t last_dts;
3483
    int fetch_timestamp;
3484

    
3485
#define AV_PARSER_PTS_NB 4
3486
    int cur_frame_start_index;
3487
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3488
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3489
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3490

    
3491
    int flags;
3492
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3493

    
3494
    int64_t offset;      ///< byte offset from starting packet start
3495
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3496

    
3497
    /*!
3498
     * Set by parser to 1 for key frames and 0 for non-key frames.
3499
     * It is initialized to -1, so if the parser doesn't set this flag,
3500
     * old-style fallback using FF_I_TYPE picture type as key frames
3501
     * will be used.
3502
     */
3503
    int key_frame;
3504

    
3505
    /**
3506
     * Time difference in stream time base units from the pts of this
3507
     * packet to the point at which the output from the decoder has converged
3508
     * independent from the availability of previous frames. That is, the
3509
     * frames are virtually identical no matter if decoding started from
3510
     * the very first frame or from this keyframe.
3511
     * Is AV_NOPTS_VALUE if unknown.
3512
     * This field is not the display duration of the current frame.
3513
     *
3514
     * The purpose of this field is to allow seeking in streams that have no
3515
     * keyframes in the conventional sense. It corresponds to the
3516
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3517
     * essential for some types of subtitle streams to ensure that all
3518
     * subtitles are correctly displayed after seeking.
3519
     */
3520
    int64_t convergence_duration;
3521

    
3522
    // Timestamp generation support:
3523
    /**
3524
     * Synchronization point for start of timestamp generation.
3525
     *
3526
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3527
     * (default).
3528
     *
3529
     * For example, this corresponds to presence of H.264 buffering period
3530
     * SEI message.
3531
     */
3532
    int dts_sync_point;
3533

    
3534
    /**
3535
     * Offset of the current timestamp against last timestamp sync point in
3536
     * units of AVCodecContext.time_base.
3537
     *
3538
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3539
     * contain a valid timestamp offset.
3540
     *
3541
     * Note that the timestamp of sync point has usually a nonzero
3542
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3543
     * the next frame after timestamp sync point will be usually 1.
3544
     *
3545
     * For example, this corresponds to H.264 cpb_removal_delay.
3546
     */
3547
    int dts_ref_dts_delta;
3548

    
3549
    /**
3550
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3551
     *
3552
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3553
     * contain valid non-negative timestamp delta (presentation time of a frame
3554
     * must not lie in the past).
3555
     *
3556
     * This delay represents the difference between decoding and presentation
3557
     * time of the frame.
3558
     *
3559
     * For example, this corresponds to H.264 dpb_output_delay.
3560
     */
3561
    int pts_dts_delta;
3562

    
3563
    /**
3564
     * Position of the packet in file.
3565
     *
3566
     * Analogous to cur_frame_pts/dts
3567
     */
3568
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3569

    
3570
    /**
3571
     * Byte position of currently parsed frame in stream.
3572
     */
3573
    int64_t pos;
3574

    
3575
    /**
3576
     * Previous frame byte position.
3577
     */
3578
    int64_t last_pos;
3579
} AVCodecParserContext;
3580

    
3581
typedef struct AVCodecParser {
3582
    int codec_ids[5]; /* several codec IDs are permitted */
3583
    int priv_data_size;
3584
    int (*parser_init)(AVCodecParserContext *s);
3585
    int (*parser_parse)(AVCodecParserContext *s,
3586
                        AVCodecContext *avctx,
3587
                        const uint8_t **poutbuf, int *poutbuf_size,
3588
                        const uint8_t *buf, int buf_size);
3589
    void (*parser_close)(AVCodecParserContext *s);
3590
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3591
    struct AVCodecParser *next;
3592
} AVCodecParser;
3593

    
3594
AVCodecParser *av_parser_next(AVCodecParser *c);
3595

    
3596
void av_register_codec_parser(AVCodecParser *parser);
3597
AVCodecParserContext *av_parser_init(int codec_id);
3598

    
3599
#if LIBAVCODEC_VERSION_MAJOR < 53
3600
attribute_deprecated
3601
int av_parser_parse(AVCodecParserContext *s,
3602
                    AVCodecContext *avctx,
3603
                    uint8_t **poutbuf, int *poutbuf_size,
3604
                    const uint8_t *buf, int buf_size,
3605
                    int64_t pts, int64_t dts);
3606
#endif
3607

    
3608
/**
3609
 * Parse a packet.
3610
 *
3611
 * @param s             parser context.
3612
 * @param avctx         codec context.
3613
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3614
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3615
 * @param buf           input buffer.
3616
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3617
 * @param pts           input presentation timestamp.
3618
 * @param dts           input decoding timestamp.
3619
 * @param pos           input byte position in stream.
3620
 * @return the number of bytes of the input bitstream used.
3621
 *
3622
 * Example:
3623
 * @code
3624
 *   while(in_len){
3625
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3626
 *                                        in_data, in_len,
3627
 *                                        pts, dts, pos);
3628
 *       in_data += len;
3629
 *       in_len  -= len;
3630
 *
3631
 *       if(size)
3632
 *          decode_frame(data, size);
3633
 *   }
3634
 * @endcode
3635
 */
3636
int av_parser_parse2(AVCodecParserContext *s,
3637
                     AVCodecContext *avctx,
3638
                     uint8_t **poutbuf, int *poutbuf_size,
3639
                     const uint8_t *buf, int buf_size,
3640
                     int64_t pts, int64_t dts,
3641
                     int64_t pos);
3642

    
3643
int av_parser_change(AVCodecParserContext *s,
3644
                     AVCodecContext *avctx,
3645
                     uint8_t **poutbuf, int *poutbuf_size,
3646
                     const uint8_t *buf, int buf_size, int keyframe);
3647
void av_parser_close(AVCodecParserContext *s);
3648

    
3649

    
3650
typedef struct AVBitStreamFilterContext {
3651
    void *priv_data;
3652
    struct AVBitStreamFilter *filter;
3653
    AVCodecParserContext *parser;
3654
    struct AVBitStreamFilterContext *next;
3655
} AVBitStreamFilterContext;
3656

    
3657

    
3658
typedef struct AVBitStreamFilter {
3659
    const char *name;
3660
    int priv_data_size;
3661
    int (*filter)(AVBitStreamFilterContext *bsfc,
3662
                  AVCodecContext *avctx, const char *args,
3663
                  uint8_t **poutbuf, int *poutbuf_size,
3664
                  const uint8_t *buf, int buf_size, int keyframe);
3665
    void (*close)(AVBitStreamFilterContext *bsfc);
3666
    struct AVBitStreamFilter *next;
3667
} AVBitStreamFilter;
3668

    
3669
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3670
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3671
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3672
                               AVCodecContext *avctx, const char *args,
3673
                               uint8_t **poutbuf, int *poutbuf_size,
3674
                               const uint8_t *buf, int buf_size, int keyframe);
3675
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3676

    
3677
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3678

    
3679
/* memory */
3680

    
3681
/**
3682
 * Reallocates the given block if it is not large enough, otherwise it
3683
 * does nothing.
3684
 *
3685
 * @see av_realloc
3686
 */
3687
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3688

    
3689
/**
3690
 * Allocates a buffer, reusing the given one if large enough.
3691
 *
3692
 * Contrary to av_fast_realloc the current buffer contents might not be
3693
 * preserved and on error the old buffer is freed, thus no special
3694
 * handling to avoid memleaks is necessary.
3695
 *
3696
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3697
 * @param size size of the buffer *ptr points to
3698
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3699
 *                 *size 0 if an error occurred.
3700
 */
3701
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3702

    
3703
/**
3704
 * Copy image 'src' to 'dst'.
3705
 */
3706
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3707
                     enum PixelFormat pix_fmt, int width, int height);
3708

    
3709
/**
3710
 * Crop image top and left side.
3711
 */
3712
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3713
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3714

    
3715
/**
3716
 * Pad image.
3717
 */
3718
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3719
            int padtop, int padbottom, int padleft, int padright, int *color);
3720

    
3721
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3722

    
3723
/**
3724
 * Parses str and put in width_ptr and height_ptr the detected values.
3725
 *
3726
 * @return 0 in case of a successful parsing, a negative value otherwise
3727
 * @param[in] str the string to parse: it has to be a string in the format
3728
 * <width>x<height> or a valid video frame size abbreviation.
3729
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3730
 * frame width value
3731
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3732
 * frame height value
3733
 */
3734
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3735

    
3736
/**
3737
 * Parses str and put in frame_rate the detected values.
3738
 *
3739
 * @return 0 in case of a successful parsing, a negative value otherwise
3740
 * @param[in] str the string to parse: it has to be a string in the format
3741
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3742
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3743
 * frame rate
3744
 */
3745
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3746

    
3747
/* error handling */
3748
#if EINVAL > 0
3749
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3750
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3751
#else
3752
/* Some platforms have E* and errno already negated. */
3753
#define AVERROR(e) (e)
3754
#define AVUNERROR(e) (e)
3755
#endif
3756
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3757
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3758
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3759
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3760
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3761
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3762
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3763
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3764
#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
3765
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3766

    
3767
/**
3768
 * Logs a generic warning message about a missing feature. This function is
3769
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3770
 * only, and would normally not be used by applications.
3771
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3772
 * a pointer to an AVClass struct
3773
 * @param[in] feature string containing the name of the missing feature
3774
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3775
 * If want_sample is non-zero, additional verbage will be added to the log
3776
 * message which tells the user how to report samples to the development
3777
 * mailing list.
3778
 */
3779
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3780

    
3781
/**
3782
 * Logs a generic warning message asking for a sample. This function is
3783
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3784
 * only, and would normally not be used by applications.
3785
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3786
 * a pointer to an AVClass struct
3787
 * @param[in] msg string containing an optional message, or NULL if no message
3788
 */
3789
void av_log_ask_for_sample(void *avc, const char *msg);
3790

    
3791
/**
3792
 * Registers the hardware accelerator hwaccel.
3793
 */
3794
void av_register_hwaccel(AVHWAccel *hwaccel);
3795

    
3796
/**
3797
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3798
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3799
 * after hwaccel, or NULL if hwaccel is the last one.
3800
 */
3801
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3802

    
3803

    
3804
/**
3805
 * Lock operation used by lockmgr
3806
 */
3807
enum AVLockOp {
3808
  AV_LOCK_CREATE,  ///< Create a mutex
3809
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3810
  AV_LOCK_RELEASE, ///< Unlock the mutex
3811
  AV_LOCK_DESTROY, ///< Free mutex resources
3812
};
3813

    
3814
/**
3815
 * Register a user provided lock manager supporting the operations
3816
 * specified by AVLockOp. mutex points to a (void *) where the
3817
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3818
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3819
 *
3820
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3821
 *           callback during the call to av_lockmgr_register().
3822
 *           Thus, the application must be prepared to handle that.
3823
 *           If cb is set to NULL the lockmgr will be unregistered.
3824
 *           Also note that during unregistration the previously registered
3825
 *           lockmgr callback may also be invoked.
3826
 */
3827
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3828

    
3829
#endif /* AVCODEC_AVCODEC_H */