Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 80a07f6e

History | View | Annotate | Download (125 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 49
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
    CODEC_ID_FLASHSV2,
203
    CODEC_ID_CDGRAPHICS,
204
    CODEC_ID_R210,
205
    CODEC_ID_ANM,
206
    CODEC_ID_BINKVIDEO,
207

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

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

    
265
    /* AMR */
266
    CODEC_ID_AMR_NB= 0x12000,
267
    CODEC_ID_AMR_WB,
268

    
269
    /* RealAudio codecs*/
270
    CODEC_ID_RA_144= 0x13000,
271
    CODEC_ID_RA_288,
272

    
273
    /* various DPCM codecs */
274
    CODEC_ID_ROQ_DPCM= 0x14000,
275
    CODEC_ID_INTERPLAY_DPCM,
276
    CODEC_ID_XAN_DPCM,
277
    CODEC_ID_SOL_DPCM,
278

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

    
333
    /* subtitle codecs */
334
    CODEC_ID_DVD_SUBTITLE= 0x17000,
335
    CODEC_ID_DVB_SUBTITLE,
336
    CODEC_ID_TEXT,  ///< raw UTF-8 text
337
    CODEC_ID_XSUB,
338
    CODEC_ID_SSA,
339
    CODEC_ID_MOV_TEXT,
340
    CODEC_ID_HDMV_PGS_SUBTITLE,
341
    CODEC_ID_DVB_TELETEXT,
342

    
343
    /* other specific kind of codecs (generally used for attachments) */
344
    CODEC_ID_TTF= 0x18000,
345

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

    
348
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
349
                                * stream (only used by libavformat) */
350
};
351

    
352
enum CodecType {
353
    CODEC_TYPE_UNKNOWN = -1,
354
    CODEC_TYPE_VIDEO,
355
    CODEC_TYPE_AUDIO,
356
    CODEC_TYPE_DATA,
357
    CODEC_TYPE_SUBTITLE,
358
    CODEC_TYPE_ATTACHMENT,
359
    CODEC_TYPE_NB
360
};
361

    
362
/**
363
 * all in native-endian format
364
 */
365
enum SampleFormat {
366
    SAMPLE_FMT_NONE = -1,
367
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
368
    SAMPLE_FMT_S16,             ///< signed 16 bits
369
    SAMPLE_FMT_S32,             ///< signed 32 bits
370
    SAMPLE_FMT_FLT,             ///< float
371
    SAMPLE_FMT_DBL,             ///< double
372
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
373
};
374

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

    
397
/** Channel mask value used for AVCodecContext.request_channel_layout
398
    to indicate that the user requests the channel order of the decoder output
399
    to be the native codec channel order. */
400
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
401

    
402
/* Audio channel convenience macros */
403
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
404
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
405
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
406
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
407
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
408
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
409
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
410
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
411
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
412
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
413
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
414
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
415
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
416
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
417
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
418
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
419

    
420
/* in bytes */
421
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
422

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

    
432
/**
433
 * minimum encoding buffer size
434
 * Used to avoid some checks during header writing.
435
 */
436
#define FF_MIN_BUFFER_SIZE 16384
437

    
438

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

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

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

    
477
enum AVColorTransferCharacteristic{
478
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
479
    AVCOL_TRC_UNSPECIFIED=2,
480
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
481
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
482
    AVCOL_TRC_NB           , ///< Not part of ABI
483
};
484

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

    
496
enum AVColorRange{
497
    AVCOL_RANGE_UNSPECIFIED=0,
498
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
499
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
500
    AVCOL_RANGE_NB           , ///< Not part of ABI
501
};
502

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

    
519
typedef struct RcOverride{
520
    int start_frame;
521
    int end_frame;
522
    int qscale; // If this is 0 then quality_factor will be used instead.
523
    float quality_factor;
524
} RcOverride;
525

    
526
#define FF_MAX_B_FRAMES 16
527

    
528
/* encoding support
529
   These flags can be passed in AVCodecContext.flags before initialization.
530
   Note: Not everything is supported yet.
531
*/
532

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

    
591
/* Unsupported options :
592
 *              Syntax Arithmetic coding (SAC)
593
 *              Reference Picture Selection
594
 *              Independent Segment Decoding */
595
/* /Fx */
596
/* codec capabilities */
597

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

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

    
660
/**
661
 * Pan Scan area.
662
 * This specifies the area which should be displayed.
663
 * Note there may be multiple such areas for one frame.
664
 */
665
typedef struct AVPanScan{
666
    /**
667
     * id
668
     * - encoding: Set by user.
669
     * - decoding: Set by libavcodec.
670
     */
671
    int id;
672

    
673
    /**
674
     * width and height in 1/16 pel
675
     * - encoding: Set by user.
676
     * - decoding: Set by libavcodec.
677
     */
678
    int width;
679
    int height;
680

    
681
    /**
682
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
683
     * - encoding: Set by user.
684
     * - decoding: Set by libavcodec.
685
     */
686
    int16_t position[3][2];
687
}AVPanScan;
688

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

    
915

    
916
#define FF_QSCALE_TYPE_MPEG1 0
917
#define FF_QSCALE_TYPE_MPEG2 1
918
#define FF_QSCALE_TYPE_H264  2
919
#define FF_QSCALE_TYPE_VP56  3
920

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

    
926

    
927
#define FF_I_TYPE  1 ///< Intra
928
#define FF_P_TYPE  2 ///< Predicted
929
#define FF_B_TYPE  3 ///< Bi-dir predicted
930
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
931
#define FF_SI_TYPE 5 ///< Switching Intra
932
#define FF_SP_TYPE 6 ///< Switching Predicted
933
#define FF_BI_TYPE 7
934

    
935
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
936
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
937
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
938
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
939

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

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

    
992
/**
993
 * Audio Video Frame.
994
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
995
 * bumps.
996
 * Removal, reordering and changes to existing fields require a major
997
 * version bump. No fields should be added into AVFrame before or after
998
 * FF_COMMON_FRAME!
999
 * sizeof(AVFrame) must not be used outside libav*.
1000
 */
1001
typedef struct AVFrame {
1002
    FF_COMMON_FRAME
1003
} AVFrame;
1004

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

    
1025
    /**
1026
     * number of bits the bitstream is allowed to diverge from the reference.
1027
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1028
     * - encoding: Set by user; unused for constant quantizer encoding.
1029
     * - decoding: unused
1030
     */
1031
    int bit_rate_tolerance;
1032

    
1033
    /**
1034
     * CODEC_FLAG_*.
1035
     * - encoding: Set by user.
1036
     * - decoding: Set by user.
1037
     */
1038
    int flags;
1039

    
1040
    /**
1041
     * Some codecs need additional format info. It is stored here.
1042
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1043
     * specific codec MUST set it correctly otherwise stream copy breaks.
1044
     * In general use of this field by muxers is not recommanded.
1045
     * - encoding: Set by libavcodec.
1046
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1047
     */
1048
    int sub_id;
1049

    
1050
    /**
1051
     * Motion estimation algorithm used for video coding.
1052
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1053
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1054
     * - encoding: MUST be set by user.
1055
     * - decoding: unused
1056
     */
1057
    int me_method;
1058

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

    
1073
    /**
1074
     * This is the fundamental unit of time (in seconds) in terms
1075
     * of which frame timestamps are represented. For fixed-fps content,
1076
     * timebase should be 1/framerate and timestamp increments should be
1077
     * identically 1.
1078
     * - encoding: MUST be set by user.
1079
     * - decoding: Set by libavcodec.
1080
     */
1081
    AVRational time_base;
1082

    
1083
    /* video only */
1084
    /**
1085
     * picture width / height.
1086
     * - encoding: MUST be set by user.
1087
     * - decoding: Set by libavcodec.
1088
     * Note: For compatibility it is possible to set this instead of
1089
     * coded_width/height before decoding.
1090
     */
1091
    int width, height;
1092

    
1093
#define FF_ASPECT_EXTENDED 15
1094

    
1095
    /**
1096
     * the number of pictures in a group of pictures, or 0 for intra_only
1097
     * - encoding: Set by user.
1098
     * - decoding: unused
1099
     */
1100
    int gop_size;
1101

    
1102
    /**
1103
     * Pixel format, see PIX_FMT_xxx.
1104
     * - encoding: Set by user.
1105
     * - decoding: Set by libavcodec.
1106
     */
1107
    enum PixelFormat pix_fmt;
1108

    
1109
    /**
1110
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1111
     * has to read frames at native frame rate.
1112
     * - encoding: Set by user.
1113
     * - decoding: unused
1114
     */
1115
    int rate_emu;
1116

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

    
1140
    /* audio only */
1141
    int sample_rate; ///< samples per second
1142
    int channels;    ///< number of audio channels
1143

    
1144
    /**
1145
     * audio sample format
1146
     * - encoding: Set by user.
1147
     * - decoding: Set by libavcodec.
1148
     */
1149
    enum SampleFormat sample_fmt;  ///< sample format
1150

    
1151
    /* The following data should not be initialized. */
1152
    /**
1153
     * Samples per packet, initialized when calling 'init'.
1154
     */
1155
    int frame_size;
1156
    int frame_number;   ///< audio or video frame number
1157
#if LIBAVCODEC_VERSION_MAJOR < 53
1158
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1159
#endif
1160

    
1161
    /**
1162
     * Number of frames the decoded output will be delayed relative to
1163
     * the encoded input.
1164
     * - encoding: Set by libavcodec.
1165
     * - decoding: unused
1166
     */
1167
    int delay;
1168

    
1169
    /* - encoding parameters */
1170
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1171
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1172

    
1173
    /**
1174
     * minimum quantizer
1175
     * - encoding: Set by user.
1176
     * - decoding: unused
1177
     */
1178
    int qmin;
1179

    
1180
    /**
1181
     * maximum quantizer
1182
     * - encoding: Set by user.
1183
     * - decoding: unused
1184
     */
1185
    int qmax;
1186

    
1187
    /**
1188
     * maximum quantizer difference between frames
1189
     * - encoding: Set by user.
1190
     * - decoding: unused
1191
     */
1192
    int max_qdiff;
1193

    
1194
    /**
1195
     * maximum number of B-frames between non-B-frames
1196
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1197
     * - encoding: Set by user.
1198
     * - decoding: unused
1199
     */
1200
    int max_b_frames;
1201

    
1202
    /**
1203
     * qscale factor between IP and B-frames
1204
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1205
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1206
     * - encoding: Set by user.
1207
     * - decoding: unused
1208
     */
1209
    float b_quant_factor;
1210

    
1211
    /** obsolete FIXME remove */
1212
    int rc_strategy;
1213
#define FF_RC_STRATEGY_XVID 1
1214

    
1215
    int b_frame_strategy;
1216

    
1217
    /**
1218
     * hurry up amount
1219
     * - encoding: unused
1220
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1221
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1222
     */
1223
    int hurry_up;
1224

    
1225
    struct AVCodec *codec;
1226

    
1227
    void *priv_data;
1228

    
1229
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1230
                            /* do its best to deliver a chunk with size     */
1231
                            /* below rtp_payload_size, the chunk will start */
1232
                            /* with a start code on some codecs like H.263. */
1233
                            /* This doesn't take account of any particular  */
1234
                            /* headers inside the transmitted RTP payload.  */
1235

    
1236

    
1237
    /* The RTP callback: This function is called    */
1238
    /* every time the encoder has a packet to send. */
1239
    /* It depends on the encoder if the data starts */
1240
    /* with a Start Code (it should). H.263 does.   */
1241
    /* mb_nb contains the number of macroblocks     */
1242
    /* encoded in the RTP payload.                  */
1243
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1244

    
1245
    /* statistics, used for 2-pass encoding */
1246
    int mv_bits;
1247
    int header_bits;
1248
    int i_tex_bits;
1249
    int p_tex_bits;
1250
    int i_count;
1251
    int p_count;
1252
    int skip_count;
1253
    int misc_bits;
1254

    
1255
    /**
1256
     * number of bits used for the previously encoded frame
1257
     * - encoding: Set by libavcodec.
1258
     * - decoding: unused
1259
     */
1260
    int frame_bits;
1261

    
1262
    /**
1263
     * Private data of the user, can be used to carry app specific stuff.
1264
     * - encoding: Set by user.
1265
     * - decoding: Set by user.
1266
     */
1267
    void *opaque;
1268

    
1269
    char codec_name[32];
1270
    enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1271
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1272

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

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

    
1311
    /**
1312
     * luma single coefficient elimination threshold
1313
     * - encoding: Set by user.
1314
     * - decoding: unused
1315
     */
1316
    int luma_elim_threshold;
1317

    
1318
    /**
1319
     * chroma single coeff elimination threshold
1320
     * - encoding: Set by user.
1321
     * - decoding: unused
1322
     */
1323
    int chroma_elim_threshold;
1324

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

    
1344
    /**
1345
     * qscale offset between IP and B-frames
1346
     * - encoding: Set by user.
1347
     * - decoding: unused
1348
     */
1349
    float b_quant_offset;
1350

    
1351
    /**
1352
     * Error recognization; higher values will detect more errors but may
1353
     * misdetect some more or less valid parts as errors.
1354
     * - encoding: unused
1355
     * - decoding: Set by user.
1356
     */
1357
    int error_recognition;
1358
#define FF_ER_CAREFUL         1
1359
#define FF_ER_COMPLIANT       2
1360
#define FF_ER_AGGRESSIVE      3
1361
#define FF_ER_VERY_AGGRESSIVE 4
1362

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

    
1376
    /**
1377
     * Called to release buffers which were allocated with get_buffer.
1378
     * A released buffer can be reused in get_buffer().
1379
     * pic.data[*] must be set to NULL.
1380
     * - encoding: unused
1381
     * - decoding: Set by libavcodec., user can override.
1382
     */
1383
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1384

    
1385
    /**
1386
     * Size of the frame reordering buffer in the decoder.
1387
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1388
     * - encoding: Set by libavcodec.
1389
     * - decoding: Set by libavcodec.
1390
     */
1391
    int has_b_frames;
1392

    
1393
    /**
1394
     * number of bytes per packet if constant and known or 0
1395
     * Used by some WAV based audio codecs.
1396
     */
1397
    int block_align;
1398

    
1399
    int parse_only; /* - decoding only: If true, only parsing is done
1400
                       (function avcodec_parse_frame()). The frame
1401
                       data is returned. Only MPEG codecs support this now. */
1402

    
1403
    /**
1404
     * 0-> h263 quant 1-> mpeg quant
1405
     * - encoding: Set by user.
1406
     * - decoding: unused
1407
     */
1408
    int mpeg_quant;
1409

    
1410
    /**
1411
     * pass1 encoding statistics output buffer
1412
     * - encoding: Set by libavcodec.
1413
     * - decoding: unused
1414
     */
1415
    char *stats_out;
1416

    
1417
    /**
1418
     * pass2 encoding statistics input buffer
1419
     * Concatenated stuff from stats_out of pass1 should be placed here.
1420
     * - encoding: Allocated/set/freed by user.
1421
     * - decoding: unused
1422
     */
1423
    char *stats_in;
1424

    
1425
    /**
1426
     * ratecontrol qmin qmax limiting method
1427
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1428
     * - encoding: Set by user.
1429
     * - decoding: unused
1430
     */
1431
    float rc_qsquish;
1432

    
1433
    float rc_qmod_amp;
1434
    int rc_qmod_freq;
1435

    
1436
    /**
1437
     * ratecontrol override, see RcOverride
1438
     * - encoding: Allocated/set/freed by user.
1439
     * - decoding: unused
1440
     */
1441
    RcOverride *rc_override;
1442
    int rc_override_count;
1443

    
1444
    /**
1445
     * rate control equation
1446
     * - encoding: Set by user
1447
     * - decoding: unused
1448
     */
1449
    const char *rc_eq;
1450

    
1451
    /**
1452
     * maximum bitrate
1453
     * - encoding: Set by user.
1454
     * - decoding: unused
1455
     */
1456
    int rc_max_rate;
1457

    
1458
    /**
1459
     * minimum bitrate
1460
     * - encoding: Set by user.
1461
     * - decoding: unused
1462
     */
1463
    int rc_min_rate;
1464

    
1465
    /**
1466
     * decoder bitstream buffer size
1467
     * - encoding: Set by user.
1468
     * - decoding: unused
1469
     */
1470
    int rc_buffer_size;
1471
    float rc_buffer_aggressivity;
1472

    
1473
    /**
1474
     * qscale factor between P and I-frames
1475
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1476
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1477
     * - encoding: Set by user.
1478
     * - decoding: unused
1479
     */
1480
    float i_quant_factor;
1481

    
1482
    /**
1483
     * qscale offset between P and I-frames
1484
     * - encoding: Set by user.
1485
     * - decoding: unused
1486
     */
1487
    float i_quant_offset;
1488

    
1489
    /**
1490
     * initial complexity for pass1 ratecontrol
1491
     * - encoding: Set by user.
1492
     * - decoding: unused
1493
     */
1494
    float rc_initial_cplx;
1495

    
1496
    /**
1497
     * DCT algorithm, see FF_DCT_* below
1498
     * - encoding: Set by user.
1499
     * - decoding: unused
1500
     */
1501
    int dct_algo;
1502
#define FF_DCT_AUTO    0
1503
#define FF_DCT_FASTINT 1
1504
#define FF_DCT_INT     2
1505
#define FF_DCT_MMX     3
1506
#define FF_DCT_MLIB    4
1507
#define FF_DCT_ALTIVEC 5
1508
#define FF_DCT_FAAN    6
1509

    
1510
    /**
1511
     * luminance masking (0-> disabled)
1512
     * - encoding: Set by user.
1513
     * - decoding: unused
1514
     */
1515
    float lumi_masking;
1516

    
1517
    /**
1518
     * temporary complexity masking (0-> disabled)
1519
     * - encoding: Set by user.
1520
     * - decoding: unused
1521
     */
1522
    float temporal_cplx_masking;
1523

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

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

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

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

    
1576
    /**
1577
     * slice count
1578
     * - encoding: Set by libavcodec.
1579
     * - decoding: Set by user (or 0).
1580
     */
1581
    int slice_count;
1582
    /**
1583
     * slice offsets in the frame in bytes
1584
     * - encoding: Set/allocated by libavcodec.
1585
     * - decoding: Set/allocated by user (or NULL).
1586
     */
1587
    int *slice_offset;
1588

    
1589
    /**
1590
     * error concealment flags
1591
     * - encoding: unused
1592
     * - decoding: Set by user.
1593
     */
1594
    int error_concealment;
1595
#define FF_EC_GUESS_MVS   1
1596
#define FF_EC_DEBLOCK     2
1597

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

    
1625
    /**
1626
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1627
     * - encoding: Set by libavcodec.
1628
     * - decoding: Set by user.
1629
     */
1630
     int bits_per_coded_sample;
1631

    
1632
    /**
1633
     * prediction method (needed for huffyuv)
1634
     * - encoding: Set by user.
1635
     * - decoding: unused
1636
     */
1637
     int prediction_method;
1638
#define FF_PRED_LEFT   0
1639
#define FF_PRED_PLANE  1
1640
#define FF_PRED_MEDIAN 2
1641

    
1642
    /**
1643
     * sample aspect ratio (0 if unknown)
1644
     * That is the width of a pixel divided by the height of the pixel.
1645
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1646
     * - encoding: Set by user.
1647
     * - decoding: Set by libavcodec.
1648
     */
1649
    AVRational sample_aspect_ratio;
1650

    
1651
    /**
1652
     * the picture in the bitstream
1653
     * - encoding: Set by libavcodec.
1654
     * - decoding: Set by libavcodec.
1655
     */
1656
    AVFrame *coded_frame;
1657

    
1658
    /**
1659
     * debug
1660
     * - encoding: Set by user.
1661
     * - decoding: Set by user.
1662
     */
1663
    int debug;
1664
#define FF_DEBUG_PICT_INFO   1
1665
#define FF_DEBUG_RC          2
1666
#define FF_DEBUG_BITSTREAM   4
1667
#define FF_DEBUG_MB_TYPE     8
1668
#define FF_DEBUG_QP          16
1669
#define FF_DEBUG_MV          32
1670
#define FF_DEBUG_DCT_COEFF   0x00000040
1671
#define FF_DEBUG_SKIP        0x00000080
1672
#define FF_DEBUG_STARTCODE   0x00000100
1673
#define FF_DEBUG_PTS         0x00000200
1674
#define FF_DEBUG_ER          0x00000400
1675
#define FF_DEBUG_MMCO        0x00000800
1676
#define FF_DEBUG_BUGS        0x00001000
1677
#define FF_DEBUG_VIS_QP      0x00002000
1678
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1679
#define FF_DEBUG_BUFFERS     0x00008000
1680

    
1681
    /**
1682
     * debug
1683
     * - encoding: Set by user.
1684
     * - decoding: Set by user.
1685
     */
1686
    int debug_mv;
1687
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1688
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1689
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1690

    
1691
    /**
1692
     * error
1693
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1694
     * - decoding: unused
1695
     */
1696
    uint64_t error[4];
1697

    
1698
    /**
1699
     * minimum MB quantizer
1700
     * - encoding: unused
1701
     * - decoding: unused
1702
     */
1703
    int mb_qmin;
1704

    
1705
    /**
1706
     * maximum MB quantizer
1707
     * - encoding: unused
1708
     * - decoding: unused
1709
     */
1710
    int mb_qmax;
1711

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

    
1753
    /**
1754
     * ME diamond size & shape
1755
     * - encoding: Set by user.
1756
     * - decoding: unused
1757
     */
1758
    int dia_size;
1759

    
1760
    /**
1761
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1762
     * - encoding: Set by user.
1763
     * - decoding: unused
1764
     */
1765
    int last_predictor_count;
1766

    
1767
    /**
1768
     * prepass for motion estimation
1769
     * - encoding: Set by user.
1770
     * - decoding: unused
1771
     */
1772
    int pre_me;
1773

    
1774
    /**
1775
     * motion estimation prepass comparison function
1776
     * - encoding: Set by user.
1777
     * - decoding: unused
1778
     */
1779
    int me_pre_cmp;
1780

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

    
1788
    /**
1789
     * subpel ME quality
1790
     * - encoding: Set by user.
1791
     * - decoding: unused
1792
     */
1793
    int me_subpel_quality;
1794

    
1795
    /**
1796
     * callback to negotiate the pixelFormat
1797
     * @param fmt is the list of formats which are supported by the codec,
1798
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1799
     * The first is always the native one.
1800
     * @return the chosen format
1801
     * - encoding: unused
1802
     * - decoding: Set by user, if not set the native format will be chosen.
1803
     */
1804
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1805

    
1806
    /**
1807
     * DTG active format information (additional aspect ratio
1808
     * information only used in DVB MPEG-2 transport streams)
1809
     * 0 if not set.
1810
     *
1811
     * - encoding: unused
1812
     * - decoding: Set by decoder.
1813
     */
1814
    int dtg_active_format;
1815
#define FF_DTG_AFD_SAME         8
1816
#define FF_DTG_AFD_4_3          9
1817
#define FF_DTG_AFD_16_9         10
1818
#define FF_DTG_AFD_14_9         11
1819
#define FF_DTG_AFD_4_3_SP_14_9  13
1820
#define FF_DTG_AFD_16_9_SP_14_9 14
1821
#define FF_DTG_AFD_SP_4_3       15
1822

    
1823
    /**
1824
     * maximum motion estimation search range in subpel units
1825
     * If 0 then no limit.
1826
     *
1827
     * - encoding: Set by user.
1828
     * - decoding: unused
1829
     */
1830
    int me_range;
1831

    
1832
    /**
1833
     * intra quantizer bias
1834
     * - encoding: Set by user.
1835
     * - decoding: unused
1836
     */
1837
    int intra_quant_bias;
1838
#define FF_DEFAULT_QUANT_BIAS 999999
1839

    
1840
    /**
1841
     * inter quantizer bias
1842
     * - encoding: Set by user.
1843
     * - decoding: unused
1844
     */
1845
    int inter_quant_bias;
1846

    
1847
    /**
1848
     * color table ID
1849
     * - encoding: unused
1850
     * - decoding: Which clrtable should be used for 8bit RGB images.
1851
     *             Tables have to be stored somewhere. FIXME
1852
     */
1853
    int color_table_id;
1854

    
1855
    /**
1856
     * internal_buffer count
1857
     * Don't touch, used by libavcodec default_get_buffer().
1858
     */
1859
    int internal_buffer_count;
1860

    
1861
    /**
1862
     * internal_buffers
1863
     * Don't touch, used by libavcodec default_get_buffer().
1864
     */
1865
    void *internal_buffer;
1866

    
1867
#define FF_LAMBDA_SHIFT 7
1868
#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1869
#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1870
#define FF_LAMBDA_MAX (256*128-1)
1871

    
1872
#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1873
    /**
1874
     * Global quality for codecs which cannot change it per frame.
1875
     * This should be proportional to MPEG-1/2/4 qscale.
1876
     * - encoding: Set by user.
1877
     * - decoding: unused
1878
     */
1879
    int global_quality;
1880

    
1881
#define FF_CODER_TYPE_VLC       0
1882
#define FF_CODER_TYPE_AC        1
1883
#define FF_CODER_TYPE_RAW       2
1884
#define FF_CODER_TYPE_RLE       3
1885
#define FF_CODER_TYPE_DEFLATE   4
1886
    /**
1887
     * coder type
1888
     * - encoding: Set by user.
1889
     * - decoding: unused
1890
     */
1891
    int coder_type;
1892

    
1893
    /**
1894
     * context model
1895
     * - encoding: Set by user.
1896
     * - decoding: unused
1897
     */
1898
    int context_model;
1899
#if 0
1900
    /**
1901
     *
1902
     * - encoding: unused
1903
     * - decoding: Set by user.
1904
     */
1905
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1906
#endif
1907

    
1908
    /**
1909
     * slice flags
1910
     * - encoding: unused
1911
     * - decoding: Set by user.
1912
     */
1913
    int slice_flags;
1914
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1915
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1916
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1917

    
1918
    /**
1919
     * XVideo Motion Acceleration
1920
     * - encoding: forbidden
1921
     * - decoding: set by decoder
1922
     */
1923
    int xvmc_acceleration;
1924

    
1925
    /**
1926
     * macroblock decision mode
1927
     * - encoding: Set by user.
1928
     * - decoding: unused
1929
     */
1930
    int mb_decision;
1931
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1932
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1933
#define FF_MB_DECISION_RD     2        ///< rate distortion
1934

    
1935
    /**
1936
     * custom intra quantization matrix
1937
     * - encoding: Set by user, can be NULL.
1938
     * - decoding: Set by libavcodec.
1939
     */
1940
    uint16_t *intra_matrix;
1941

    
1942
    /**
1943
     * custom inter quantization matrix
1944
     * - encoding: Set by user, can be NULL.
1945
     * - decoding: Set by libavcodec.
1946
     */
1947
    uint16_t *inter_matrix;
1948

    
1949
    /**
1950
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1951
     * This is used to work around some encoder bugs.
1952
     * - encoding: unused
1953
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1954
     */
1955
    unsigned int stream_codec_tag;
1956

    
1957
    /**
1958
     * scene change detection threshold
1959
     * 0 is default, larger means fewer detected scene changes.
1960
     * - encoding: Set by user.
1961
     * - decoding: unused
1962
     */
1963
    int scenechange_threshold;
1964

    
1965
    /**
1966
     * minimum Lagrange multipler
1967
     * - encoding: Set by user.
1968
     * - decoding: unused
1969
     */
1970
    int lmin;
1971

    
1972
    /**
1973
     * maximum Lagrange multipler
1974
     * - encoding: Set by user.
1975
     * - decoding: unused
1976
     */
1977
    int lmax;
1978

    
1979
    /**
1980
     * palette control structure
1981
     * - encoding: ??? (no palette-enabled encoder yet)
1982
     * - decoding: Set by user.
1983
     */
1984
    struct AVPaletteControl *palctrl;
1985

    
1986
    /**
1987
     * noise reduction strength
1988
     * - encoding: Set by user.
1989
     * - decoding: unused
1990
     */
1991
    int noise_reduction;
1992

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

    
2007
    /**
2008
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2009
     * - encoding: Set by user.
2010
     * - decoding: unused
2011
     */
2012
    int rc_initial_buffer_occupancy;
2013

    
2014
    /**
2015
     *
2016
     * - encoding: Set by user.
2017
     * - decoding: unused
2018
     */
2019
    int inter_threshold;
2020

    
2021
    /**
2022
     * CODEC_FLAG2_*
2023
     * - encoding: Set by user.
2024
     * - decoding: Set by user.
2025
     */
2026
    int flags2;
2027

    
2028
    /**
2029
     * Simulates errors in the bitstream to test error concealment.
2030
     * - encoding: Set by user.
2031
     * - decoding: unused
2032
     */
2033
    int error_rate;
2034

    
2035
    /**
2036
     * MP3 antialias algorithm, see FF_AA_* below.
2037
     * - encoding: unused
2038
     * - decoding: Set by user.
2039
     */
2040
    int antialias_algo;
2041
#define FF_AA_AUTO    0
2042
#define FF_AA_FASTINT 1 //not implemented yet
2043
#define FF_AA_INT     2
2044
#define FF_AA_FLOAT   3
2045
    /**
2046
     * quantizer noise shaping
2047
     * - encoding: Set by user.
2048
     * - decoding: unused
2049
     */
2050
    int quantizer_noise_shaping;
2051

    
2052
    /**
2053
     * thread count
2054
     * is used to decide how many independent tasks should be passed to execute()
2055
     * - encoding: Set by user.
2056
     * - decoding: Set by user.
2057
     */
2058
    int thread_count;
2059

    
2060
    /**
2061
     * The codec may call this to execute several independent things.
2062
     * It will return only after finishing all tasks.
2063
     * The user may replace this with some multithreaded implementation,
2064
     * the default implementation will execute the parts serially.
2065
     * @param count the number of things to execute
2066
     * - encoding: Set by libavcodec, user can override.
2067
     * - decoding: Set by libavcodec, user can override.
2068
     */
2069
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2070

    
2071
    /**
2072
     * thread opaque
2073
     * Can be used by execute() to store some per AVCodecContext stuff.
2074
     * - encoding: set by execute()
2075
     * - decoding: set by execute()
2076
     */
2077
    void *thread_opaque;
2078

    
2079
    /**
2080
     * Motion estimation threshold below which no motion estimation is
2081
     * performed, but instead the user specified motion vectors are used.
2082
     *
2083
     * - encoding: Set by user.
2084
     * - decoding: unused
2085
     */
2086
     int me_threshold;
2087

    
2088
    /**
2089
     * Macroblock threshold below which the user specified macroblock types will be used.
2090
     * - encoding: Set by user.
2091
     * - decoding: unused
2092
     */
2093
     int mb_threshold;
2094

    
2095
    /**
2096
     * precision of the intra DC coefficient - 8
2097
     * - encoding: Set by user.
2098
     * - decoding: unused
2099
     */
2100
     int intra_dc_precision;
2101

    
2102
    /**
2103
     * noise vs. sse weight for the nsse comparsion function
2104
     * - encoding: Set by user.
2105
     * - decoding: unused
2106
     */
2107
     int nsse_weight;
2108

    
2109
    /**
2110
     * Number of macroblock rows at the top which are skipped.
2111
     * - encoding: unused
2112
     * - decoding: Set by user.
2113
     */
2114
     int skip_top;
2115

    
2116
    /**
2117
     * Number of macroblock rows at the bottom which are skipped.
2118
     * - encoding: unused
2119
     * - decoding: Set by user.
2120
     */
2121
     int skip_bottom;
2122

    
2123
    /**
2124
     * profile
2125
     * - encoding: Set by user.
2126
     * - decoding: Set by libavcodec.
2127
     */
2128
     int profile;
2129
#define FF_PROFILE_UNKNOWN -99
2130

    
2131
#define FF_PROFILE_AAC_MAIN 0
2132
#define FF_PROFILE_AAC_LOW  1
2133
#define FF_PROFILE_AAC_SSR  2
2134
#define FF_PROFILE_AAC_LTP  3
2135

    
2136
#define FF_PROFILE_H264_BASELINE    66
2137
#define FF_PROFILE_H264_MAIN        77
2138
#define FF_PROFILE_H264_EXTENDED    88
2139
#define FF_PROFILE_H264_HIGH        100
2140
#define FF_PROFILE_H264_HIGH_10     110
2141
#define FF_PROFILE_H264_HIGH_422    122
2142
#define FF_PROFILE_H264_HIGH_444    244
2143
#define FF_PROFILE_H264_CAVLC_444   44
2144

    
2145
    /**
2146
     * level
2147
     * - encoding: Set by user.
2148
     * - decoding: Set by libavcodec.
2149
     */
2150
     int level;
2151
#define FF_LEVEL_UNKNOWN -99
2152

    
2153
    /**
2154
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2155
     * - encoding: unused
2156
     * - decoding: Set by user.
2157
     */
2158
     int lowres;
2159

    
2160
    /**
2161
     * Bitstream width / height, may be different from width/height if lowres
2162
     * or other things are used.
2163
     * - encoding: unused
2164
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2165
     */
2166
    int coded_width, coded_height;
2167

    
2168
    /**
2169
     * frame skip threshold
2170
     * - encoding: Set by user.
2171
     * - decoding: unused
2172
     */
2173
    int frame_skip_threshold;
2174

    
2175
    /**
2176
     * frame skip factor
2177
     * - encoding: Set by user.
2178
     * - decoding: unused
2179
     */
2180
    int frame_skip_factor;
2181

    
2182
    /**
2183
     * frame skip exponent
2184
     * - encoding: Set by user.
2185
     * - decoding: unused
2186
     */
2187
    int frame_skip_exp;
2188

    
2189
    /**
2190
     * frame skip comparison function
2191
     * - encoding: Set by user.
2192
     * - decoding: unused
2193
     */
2194
    int frame_skip_cmp;
2195

    
2196
    /**
2197
     * Border processing masking, raises the quantizer for mbs on the borders
2198
     * of the picture.
2199
     * - encoding: Set by user.
2200
     * - decoding: unused
2201
     */
2202
    float border_masking;
2203

    
2204
    /**
2205
     * minimum MB lagrange multipler
2206
     * - encoding: Set by user.
2207
     * - decoding: unused
2208
     */
2209
    int mb_lmin;
2210

    
2211
    /**
2212
     * maximum MB lagrange multipler
2213
     * - encoding: Set by user.
2214
     * - decoding: unused
2215
     */
2216
    int mb_lmax;
2217

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

    
2225
    /**
2226
     *
2227
     * - encoding: unused
2228
     * - decoding: Set by user.
2229
     */
2230
    enum AVDiscard skip_loop_filter;
2231

    
2232
    /**
2233
     *
2234
     * - encoding: unused
2235
     * - decoding: Set by user.
2236
     */
2237
    enum AVDiscard skip_idct;
2238

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

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

    
2253
    /**
2254
     *
2255
     * - encoding: Set by user.
2256
     * - decoding: unused
2257
     */
2258
    int brd_scale;
2259

    
2260
    /**
2261
     * constant rate factor - quality-based VBR - values ~correspond to qps
2262
     * - encoding: Set by user.
2263
     * - decoding: unused
2264
     */
2265
    float crf;
2266

    
2267
    /**
2268
     * constant quantization parameter rate control method
2269
     * - encoding: Set by user.
2270
     * - decoding: unused
2271
     */
2272
    int cqp;
2273

    
2274
    /**
2275
     * minimum GOP size
2276
     * - encoding: Set by user.
2277
     * - decoding: unused
2278
     */
2279
    int keyint_min;
2280

    
2281
    /**
2282
     * number of reference frames
2283
     * - encoding: Set by user.
2284
     * - decoding: Set by lavc.
2285
     */
2286
    int refs;
2287

    
2288
    /**
2289
     * chroma qp offset from luma
2290
     * - encoding: Set by user.
2291
     * - decoding: unused
2292
     */
2293
    int chromaoffset;
2294

    
2295
    /**
2296
     * Influences how often B-frames are used.
2297
     * - encoding: Set by user.
2298
     * - decoding: unused
2299
     */
2300
    int bframebias;
2301

    
2302
    /**
2303
     * trellis RD quantization
2304
     * - encoding: Set by user.
2305
     * - decoding: unused
2306
     */
2307
    int trellis;
2308

    
2309
    /**
2310
     * Reduce fluctuations in qp (before curve compression).
2311
     * - encoding: Set by user.
2312
     * - decoding: unused
2313
     */
2314
    float complexityblur;
2315

    
2316
    /**
2317
     * in-loop deblocking filter alphac0 parameter
2318
     * alpha is in the range -6...6
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int deblockalpha;
2323

    
2324
    /**
2325
     * in-loop deblocking filter beta parameter
2326
     * beta is in the range -6...6
2327
     * - encoding: Set by user.
2328
     * - decoding: unused
2329
     */
2330
    int deblockbeta;
2331

    
2332
    /**
2333
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2334
     * - encoding: Set by user.
2335
     * - decoding: unused
2336
     */
2337
    int partitions;
2338
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2339
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2340
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2341
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2342
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2343

    
2344
    /**
2345
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2346
     * - encoding: Set by user.
2347
     * - decoding: unused
2348
     */
2349
    int directpred;
2350

    
2351
    /**
2352
     * Audio cutoff bandwidth (0 means "automatic")
2353
     * - encoding: Set by user.
2354
     * - decoding: unused
2355
     */
2356
    int cutoff;
2357

    
2358
    /**
2359
     * Multiplied by qscale for each frame and added to scene_change_score.
2360
     * - encoding: Set by user.
2361
     * - decoding: unused
2362
     */
2363
    int scenechange_factor;
2364

    
2365
    /**
2366
     *
2367
     * Note: Value depends upon the compare function used for fullpel ME.
2368
     * - encoding: Set by user.
2369
     * - decoding: unused
2370
     */
2371
    int mv0_threshold;
2372

    
2373
    /**
2374
     * Adjusts sensitivity of b_frame_strategy 1.
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int b_sensitivity;
2379

    
2380
    /**
2381
     * - encoding: Set by user.
2382
     * - decoding: unused
2383
     */
2384
    int compression_level;
2385
#define FF_COMPRESSION_DEFAULT -1
2386

    
2387
    /**
2388
     * Sets whether to use LPC mode - used by FLAC encoder.
2389
     * - encoding: Set by user.
2390
     * - decoding: unused
2391
     */
2392
    int use_lpc;
2393

    
2394
    /**
2395
     * LPC coefficient precision - used by FLAC encoder
2396
     * - encoding: Set by user.
2397
     * - decoding: unused
2398
     */
2399
    int lpc_coeff_precision;
2400

    
2401
    /**
2402
     * - encoding: Set by user.
2403
     * - decoding: unused
2404
     */
2405
    int min_prediction_order;
2406

    
2407
    /**
2408
     * - encoding: Set by user.
2409
     * - decoding: unused
2410
     */
2411
    int max_prediction_order;
2412

    
2413
    /**
2414
     * search method for selecting prediction order
2415
     * - encoding: Set by user.
2416
     * - decoding: unused
2417
     */
2418
    int prediction_order_method;
2419

    
2420
    /**
2421
     * - encoding: Set by user.
2422
     * - decoding: unused
2423
     */
2424
    int min_partition_order;
2425

    
2426
    /**
2427
     * - encoding: Set by user.
2428
     * - decoding: unused
2429
     */
2430
    int max_partition_order;
2431

    
2432
    /**
2433
     * GOP timecode frame start number, in non drop frame format
2434
     * - encoding: Set by user.
2435
     * - decoding: unused
2436
     */
2437
    int64_t timecode_frame_start;
2438

    
2439
#if LIBAVCODEC_VERSION_MAJOR < 53
2440
    /**
2441
     * Decoder should decode to this many channels if it can (0 for default)
2442
     * - encoding: unused
2443
     * - decoding: Set by user.
2444
     * @deprecated Deprecated in favor of request_channel_layout.
2445
     */
2446
    int request_channels;
2447
#endif
2448

    
2449
    /**
2450
     * Percentage of dynamic range compression to be applied by the decoder.
2451
     * The default value is 1.0, corresponding to full compression.
2452
     * - encoding: unused
2453
     * - decoding: Set by user.
2454
     */
2455
    float drc_scale;
2456

    
2457
    /**
2458
     * opaque 64bit number (generally a PTS) that will be reordered and
2459
     * output in AVFrame.reordered_opaque
2460
     * - encoding: unused
2461
     * - decoding: Set by user.
2462
     */
2463
    int64_t reordered_opaque;
2464

    
2465
    /**
2466
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2467
     * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2468
     * - encoding: set by user.
2469
     * - decoding: set by libavcodec.
2470
     */
2471
    int bits_per_raw_sample;
2472

    
2473
    /**
2474
     * Audio channel layout.
2475
     * - encoding: set by user.
2476
     * - decoding: set by libavcodec.
2477
     */
2478
    int64_t channel_layout;
2479

    
2480
    /**
2481
     * Request decoder to use this channel layout if it can (0 for default)
2482
     * - encoding: unused
2483
     * - decoding: Set by user.
2484
     */
2485
    int64_t request_channel_layout;
2486

    
2487
    /**
2488
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2489
     * - encoding: Set by user.
2490
     * - decoding: unused.
2491
     */
2492
    float rc_max_available_vbv_use;
2493

    
2494
    /**
2495
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2496
     * - encoding: Set by user.
2497
     * - decoding: unused.
2498
     */
2499
    float rc_min_vbv_overflow_use;
2500

    
2501
    /**
2502
     * Hardware accelerator in use
2503
     * - encoding: unused.
2504
     * - decoding: Set by libavcodec
2505
     */
2506
    struct AVHWAccel *hwaccel;
2507

    
2508
    /**
2509
     * For some codecs, the time base is closer to the field rate than the frame rate.
2510
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2511
     * if no telecine is used ...
2512
     *
2513
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2514
     */
2515
    int ticks_per_frame;
2516

    
2517
    /**
2518
     * Hardware accelerator context.
2519
     * For some hardware accelerators, a global context needs to be
2520
     * provided by the user. In that case, this holds display-dependent
2521
     * data FFmpeg cannot instantiate itself. Please refer to the
2522
     * FFmpeg HW accelerator documentation to know how to fill this
2523
     * is. e.g. for VA API, this is a struct vaapi_context.
2524
     * - encoding: unused
2525
     * - decoding: Set by user
2526
     */
2527
    void *hwaccel_context;
2528

    
2529
    /**
2530
     * Chromaticity coordinates of the source primaries.
2531
     * - encoding: Set by user
2532
     * - decoding: Set by libavcodec
2533
     */
2534
    enum AVColorPrimaries color_primaries;
2535

    
2536
    /**
2537
     * Color Transfer Characteristic.
2538
     * - encoding: Set by user
2539
     * - decoding: Set by libavcodec
2540
     */
2541
    enum AVColorTransferCharacteristic color_trc;
2542

    
2543
    /**
2544
     * YUV colorspace type.
2545
     * - encoding: Set by user
2546
     * - decoding: Set by libavcodec
2547
     */
2548
    enum AVColorSpace colorspace;
2549

    
2550
    /**
2551
     * MPEG vs JPEG YUV range.
2552
     * - encoding: Set by user
2553
     * - decoding: Set by libavcodec
2554
     */
2555
    enum AVColorRange color_range;
2556

    
2557
    /**
2558
     * This defines the location of chroma samples.
2559
     * - encoding: Set by user
2560
     * - decoding: Set by libavcodec
2561
     */
2562
    enum AVChromaLocation chroma_sample_location;
2563

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

    
2584
    /**
2585
     * explicit P-frame weighted prediction analysis method
2586
     * 0: off
2587
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2588
     * 2: smart weighting (full fade detection analysis)
2589
     * - encoding: Set by user.
2590
     * - decoding: unused
2591
     */
2592
    int weighted_p_pred;
2593
} AVCodecContext;
2594

    
2595
/**
2596
 * AVCodec.
2597
 */
2598
typedef struct AVCodec {
2599
    /**
2600
     * Name of the codec implementation.
2601
     * The name is globally unique among encoders and among decoders (but an
2602
     * encoder and a decoder can share the same name).
2603
     * This is the primary way to find a codec from the user perspective.
2604
     */
2605
    const char *name;
2606
    enum CodecType type;
2607
    enum CodecID id;
2608
    int priv_data_size;
2609
    int (*init)(AVCodecContext *);
2610
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2611
    int (*close)(AVCodecContext *);
2612
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2613
    /**
2614
     * Codec capabilities.
2615
     * see CODEC_CAP_*
2616
     */
2617
    int capabilities;
2618
    struct AVCodec *next;
2619
    /**
2620
     * Flush buffers.
2621
     * Will be called when seeking
2622
     */
2623
    void (*flush)(AVCodecContext *);
2624
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2625
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2626
    /**
2627
     * Descriptive name for the codec, meant to be more human readable than name.
2628
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2629
     */
2630
    const char *long_name;
2631
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2632
    const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2633
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2634
} AVCodec;
2635

    
2636
/**
2637
 * AVHWAccel.
2638
 */
2639
typedef struct AVHWAccel {
2640
    /**
2641
     * Name of the hardware accelerated codec.
2642
     * The name is globally unique among encoders and among decoders (but an
2643
     * encoder and a decoder can share the same name).
2644
     */
2645
    const char *name;
2646

    
2647
    /**
2648
     * Type of codec implemented by the hardware accelerator.
2649
     *
2650
     * See CODEC_TYPE_xxx
2651
     */
2652
    enum CodecType type;
2653

    
2654
    /**
2655
     * Codec implemented by the hardware accelerator.
2656
     *
2657
     * See CODEC_ID_xxx
2658
     */
2659
    enum CodecID id;
2660

    
2661
    /**
2662
     * Supported pixel format.
2663
     *
2664
     * Only hardware accelerated formats are supported here.
2665
     */
2666
    enum PixelFormat pix_fmt;
2667

    
2668
    /**
2669
     * Hardware accelerated codec capabilities.
2670
     * see FF_HWACCEL_CODEC_CAP_*
2671
     */
2672
    int capabilities;
2673

    
2674
    struct AVHWAccel *next;
2675

    
2676
    /**
2677
     * Called at the beginning of each frame or field picture.
2678
     *
2679
     * Meaningful frame information (codec specific) is guaranteed to
2680
     * be parsed at this point. This function is mandatory.
2681
     *
2682
     * Note that buf can be NULL along with buf_size set to 0.
2683
     * Otherwise, this means the whole frame is available at this point.
2684
     *
2685
     * @param avctx the codec context
2686
     * @param buf the frame data buffer base
2687
     * @param buf_size the size of the frame in bytes
2688
     * @return zero if successful, a negative value otherwise
2689
     */
2690
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2691

    
2692
    /**
2693
     * Callback for each slice.
2694
     *
2695
     * Meaningful slice information (codec specific) is guaranteed to
2696
     * be parsed at this point. This function is mandatory.
2697
     *
2698
     * @param avctx the codec context
2699
     * @param buf the slice data buffer base
2700
     * @param buf_size the size of the slice in bytes
2701
     * @return zero if successful, a negative value otherwise
2702
     */
2703
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2704

    
2705
    /**
2706
     * Called at the end of each frame or field picture.
2707
     *
2708
     * The whole picture is parsed at this point and can now be sent
2709
     * to the hardware accelerator. This function is mandatory.
2710
     *
2711
     * @param avctx the codec context
2712
     * @return zero if successful, a negative value otherwise
2713
     */
2714
    int (*end_frame)(AVCodecContext *avctx);
2715

    
2716
    /**
2717
     * Size of HW accelerator private data.
2718
     *
2719
     * Private data is allocated with av_mallocz() before
2720
     * AVCodecContext.get_buffer() and deallocated after
2721
     * AVCodecContext.release_buffer().
2722
     */
2723
    int priv_data_size;
2724
} AVHWAccel;
2725

    
2726
/**
2727
 * four components are given, that's all.
2728
 * the last component is alpha
2729
 */
2730
typedef struct AVPicture {
2731
    uint8_t *data[4];
2732
    int linesize[4];       ///< number of bytes per line
2733
} AVPicture;
2734

    
2735
#if LIBAVCODEC_VERSION_MAJOR < 53
2736
/**
2737
 * AVPaletteControl
2738
 * This structure defines a method for communicating palette changes
2739
 * between and demuxer and a decoder.
2740
 *
2741
 * @deprecated Use AVPacket to send palette changes instead.
2742
 * This is totally broken.
2743
 */
2744
#define AVPALETTE_SIZE 1024
2745
#define AVPALETTE_COUNT 256
2746
typedef struct AVPaletteControl {
2747

    
2748
    /* Demuxer sets this to 1 to indicate the palette has changed;
2749
     * decoder resets to 0. */
2750
    int palette_changed;
2751

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

    
2758
} AVPaletteControl attribute_deprecated;
2759
#endif
2760

    
2761
enum AVSubtitleType {
2762
    SUBTITLE_NONE,
2763

    
2764
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2765

    
2766
    /**
2767
     * Plain text, the text field must be set by the decoder and is
2768
     * authoritative. ass and pict fields may contain approximations.
2769
     */
2770
    SUBTITLE_TEXT,
2771

    
2772
    /**
2773
     * Formatted text, the ass field must be set by the decoder and is
2774
     * authoritative. pict and text fields may contain approximations.
2775
     */
2776
    SUBTITLE_ASS,
2777
};
2778

    
2779
typedef struct AVSubtitleRect {
2780
    int x;         ///< top left corner  of pict, undefined when pict is not set
2781
    int y;         ///< top left corner  of pict, undefined when pict is not set
2782
    int w;         ///< width            of pict, undefined when pict is not set
2783
    int h;         ///< height           of pict, undefined when pict is not set
2784
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2785

    
2786
    /**
2787
     * data+linesize for the bitmap of this subtitle.
2788
     * can be set for text/ass as well once they where rendered
2789
     */
2790
    AVPicture pict;
2791
    enum AVSubtitleType type;
2792

    
2793
    char *text;                     ///< 0 terminated plain UTF-8 text
2794

    
2795
    /**
2796
     * 0 terminated ASS/SSA compatible event line.
2797
     * The pressentation of this is unaffected by the other values in this
2798
     * struct.
2799
     */
2800
    char *ass;
2801
} AVSubtitleRect;
2802

    
2803
typedef struct AVSubtitle {
2804
    uint16_t format; /* 0 = graphics */
2805
    uint32_t start_display_time; /* relative to packet pts, in ms */
2806
    uint32_t end_display_time; /* relative to packet pts, in ms */
2807
    unsigned num_rects;
2808
    AVSubtitleRect **rects;
2809
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2810
} AVSubtitle;
2811

    
2812
/* packet functions */
2813

    
2814
/**
2815
 * @deprecated use NULL instead
2816
 */
2817
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2818

    
2819
/**
2820
 * Default packet destructor.
2821
 */
2822
void av_destruct_packet(AVPacket *pkt);
2823

    
2824
/**
2825
 * Initialize optional fields of a packet with default values.
2826
 *
2827
 * @param pkt packet
2828
 */
2829
void av_init_packet(AVPacket *pkt);
2830

    
2831
/**
2832
 * Allocate the payload of a packet and initialize its fields with
2833
 * default values.
2834
 *
2835
 * @param pkt packet
2836
 * @param size wanted payload size
2837
 * @return 0 if OK, AVERROR_xxx otherwise
2838
 */
2839
int av_new_packet(AVPacket *pkt, int size);
2840

    
2841
/**
2842
 * Reduce packet size, correctly zeroing padding
2843
 *
2844
 * @param pkt packet
2845
 * @param size new size
2846
 */
2847
void av_shrink_packet(AVPacket *pkt, int size);
2848

    
2849
/**
2850
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2851
 * packet is allocated if it was not really allocated.
2852
 */
2853
int av_dup_packet(AVPacket *pkt);
2854

    
2855
/**
2856
 * Free a packet.
2857
 *
2858
 * @param pkt packet to free
2859
 */
2860
void av_free_packet(AVPacket *pkt);
2861

    
2862
/* resample.c */
2863

    
2864
struct ReSampleContext;
2865
struct AVResampleContext;
2866

    
2867
typedef struct ReSampleContext ReSampleContext;
2868

    
2869
#if LIBAVCODEC_VERSION_MAJOR < 53
2870
/**
2871
 * @deprecated Use av_audio_resample_init() instead.
2872
 */
2873
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2874
                                                          int output_rate, int input_rate);
2875
#endif
2876
/**
2877
 *  Initializes audio resampling context
2878
 *
2879
 * @param output_channels  number of output channels
2880
 * @param input_channels   number of input channels
2881
 * @param output_rate      output sample rate
2882
 * @param input_rate       input sample rate
2883
 * @param sample_fmt_out   requested output sample format
2884
 * @param sample_fmt_in    input sample format
2885
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2886
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2887
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
2888
                           between the 2 closest, if 0 the closest will be used
2889
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2890
 * @return allocated ReSampleContext, NULL if error occured
2891
 */
2892
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2893
                                        int output_rate, int input_rate,
2894
                                        enum SampleFormat sample_fmt_out,
2895
                                        enum SampleFormat sample_fmt_in,
2896
                                        int filter_length, int log2_phase_count,
2897
                                        int linear, double cutoff);
2898

    
2899
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2900
void audio_resample_close(ReSampleContext *s);
2901

    
2902

    
2903
/**
2904
 * Initializes an audio resampler.
2905
 * Note, if either rate is not an integer then simply scale both rates up so they are.
2906
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2907
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2908
 * @param linear If 1 then the used FIR filter will be linearly interpolated
2909
                 between the 2 closest, if 0 the closest will be used
2910
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2911
 */
2912
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2913

    
2914
/**
2915
 * resamples.
2916
 * @param src an array of unconsumed samples
2917
 * @param consumed the number of samples of src which have been consumed are returned here
2918
 * @param src_size the number of unconsumed samples available
2919
 * @param dst_size the amount of space in samples available in dst
2920
 * @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.
2921
 * @return the number of samples written in dst or -1 if an error occurred
2922
 */
2923
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2924

    
2925

    
2926
/**
2927
 * Compensates samplerate/timestamp drift. The compensation is done by changing
2928
 * the resampler parameters, so no audible clicks or similar distortions occur
2929
 * @param compensation_distance distance in output samples over which the compensation should be performed
2930
 * @param sample_delta number of output samples which should be output less
2931
 *
2932
 * example: av_resample_compensate(c, 10, 500)
2933
 * here instead of 510 samples only 500 samples would be output
2934
 *
2935
 * note, due to rounding the actual compensation might be slightly different,
2936
 * especially if the compensation_distance is large and the in_rate used during init is small
2937
 */
2938
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2939
void av_resample_close(struct AVResampleContext *c);
2940

    
2941
/**
2942
 * Allocate memory for a picture.  Call avpicture_free to free it.
2943
 *
2944
 * @param picture the picture to be filled in
2945
 * @param pix_fmt the format of the picture
2946
 * @param width the width of the picture
2947
 * @param height the height of the picture
2948
 * @return zero if successful, a negative value if not
2949
 */
2950
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2951

    
2952
/**
2953
 * Free a picture previously allocated by avpicture_alloc().
2954
 *
2955
 * @param picture the AVPicture to be freed
2956
 */
2957
void avpicture_free(AVPicture *picture);
2958

    
2959
/**
2960
 * Fill in the AVPicture fields.
2961
 * The fields of the given AVPicture are filled in by using the 'ptr' address
2962
 * which points to the image data buffer. Depending on the specified picture
2963
 * format, one or multiple image data pointers and line sizes will be set.
2964
 * If a planar format is specified, several pointers will be set pointing to
2965
 * the different picture planes and the line sizes of the different planes
2966
 * will be stored in the lines_sizes array.
2967
 * Call with ptr == NULL to get the required size for the ptr buffer.
2968
 *
2969
 * @param picture AVPicture whose fields are to be filled in
2970
 * @param ptr Buffer which will contain or contains the actual image data
2971
 * @param pix_fmt The format in which the picture data is stored.
2972
 * @param width the width of the image in pixels
2973
 * @param height the height of the image in pixels
2974
 * @return size of the image data in bytes
2975
 */
2976
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2977
                   enum PixelFormat pix_fmt, int width, int height);
2978
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2979
                     unsigned char *dest, int dest_size);
2980

    
2981
/**
2982
 * Calculate the size in bytes that a picture of the given width and height
2983
 * would occupy if stored in the given picture format.
2984
 * Note that this returns the size of a compact representation as generated
2985
 * by avpicture_layout, which can be smaller than the size required for e.g.
2986
 * avpicture_fill.
2987
 *
2988
 * @param pix_fmt the given picture format
2989
 * @param width the width of the image
2990
 * @param height the height of the image
2991
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2992
 */
2993
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2994
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2995
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2996
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2997

    
2998
#if LIBAVCODEC_VERSION_MAJOR < 53
2999
/**
3000
 * Returns the pixel format corresponding to the name name.
3001
 *
3002
 * If there is no pixel format with name name, then looks for a
3003
 * pixel format with the name corresponding to the native endian
3004
 * format of name.
3005
 * For example in a little-endian system, first looks for "gray16",
3006
 * then for "gray16le".
3007
 *
3008
 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
3009
 *
3010
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3011
 */
3012
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3013
#endif
3014

    
3015
/**
3016
 * Returns a value representing the fourCC code associated to the
3017
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3018
 * found.
3019
 */
3020
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3021

    
3022
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3023
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3024
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3025
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3026
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3027
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3028

    
3029
/**
3030
 * Computes what kind of losses will occur when converting from one specific
3031
 * pixel format to another.
3032
 * When converting from one pixel format to another, information loss may occur.
3033
 * For example, when converting from RGB24 to GRAY, the color information will
3034
 * be lost. Similarly, other losses occur when converting from some formats to
3035
 * other formats. These losses can involve loss of chroma, but also loss of
3036
 * resolution, loss of color depth, loss due to the color space conversion, loss
3037
 * of the alpha bits or loss due to color quantization.
3038
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3039
 * which will occur when converting from one pixel format to another.
3040
 *
3041
 * @param[in] dst_pix_fmt destination pixel format
3042
 * @param[in] src_pix_fmt source pixel format
3043
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3044
 * @return Combination of flags informing you what kind of losses will occur.
3045
 */
3046
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3047
                             int has_alpha);
3048

    
3049
/**
3050
 * Finds the best pixel format to convert to given a certain source pixel
3051
 * format.  When converting from one pixel format to another, information loss
3052
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3053
 * information will be lost. Similarly, other losses occur when converting from
3054
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3055
 * the given pixel formats should be used to suffer the least amount of loss.
3056
 * The pixel formats from which it chooses one, are determined by the
3057
 * pix_fmt_mask parameter.
3058
 *
3059
 * @code
3060
 * src_pix_fmt = PIX_FMT_YUV420P;
3061
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3062
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3063
 * @endcode
3064
 *
3065
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3066
 * @param[in] src_pix_fmt source pixel format
3067
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3068
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3069
 * @return The best pixel format to convert to or -1 if none was found.
3070
 */
3071
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3072
                              int has_alpha, int *loss_ptr);
3073

    
3074

    
3075
/**
3076
 * Print in buf the string corresponding to the pixel format with
3077
 * number pix_fmt, or an header if pix_fmt is negative.
3078
 *
3079
 * @param[in] buf the buffer where to write the string
3080
 * @param[in] buf_size the size of buf
3081
 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3082
 * a negative value to print the corresponding header.
3083
 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3084
 */
3085
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3086

    
3087
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3088
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3089

    
3090
/**
3091
 * Tell if an image really has transparent alpha values.
3092
 * @return ored mask of FF_ALPHA_xxx constants
3093
 */
3094
int img_get_alpha_info(const AVPicture *src,
3095
                       enum PixelFormat pix_fmt, int width, int height);
3096

    
3097
/* deinterlace a picture */
3098
/* deinterlace - if not supported return -1 */
3099
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3100
                          enum PixelFormat pix_fmt, int width, int height);
3101

    
3102
/* external high level API */
3103

    
3104
/**
3105
 * If c is NULL, returns the first registered codec,
3106
 * if c is non-NULL, returns the next registered codec after c,
3107
 * or NULL if c is the last one.
3108
 */
3109
AVCodec *av_codec_next(AVCodec *c);
3110

    
3111
/**
3112
 * Returns the LIBAVCODEC_VERSION_INT constant.
3113
 */
3114
unsigned avcodec_version(void);
3115

    
3116
/**
3117
 * Returns the libavcodec build-time configuration.
3118
 */
3119
const char *avcodec_configuration(void);
3120

    
3121
/**
3122
 * Returns the libavcodec license.
3123
 */
3124
const char *avcodec_license(void);
3125

    
3126
/**
3127
 * Initializes libavcodec.
3128
 *
3129
 * @warning This function must be called before any other libavcodec
3130
 * function.
3131
 */
3132
void avcodec_init(void);
3133

    
3134
#if LIBAVCODEC_VERSION_MAJOR < 53
3135
/**
3136
 * @deprecated Deprecated in favor of avcodec_register().
3137
 */
3138
attribute_deprecated void register_avcodec(AVCodec *codec);
3139
#endif
3140

    
3141
/**
3142
 * Register the codec codec and initialize libavcodec.
3143
 *
3144
 * @see avcodec_init()
3145
 */
3146
void avcodec_register(AVCodec *codec);
3147

    
3148
/**
3149
 * Finds a registered encoder with a matching codec ID.
3150
 *
3151
 * @param id CodecID of the requested encoder
3152
 * @return An encoder if one was found, NULL otherwise.
3153
 */
3154
AVCodec *avcodec_find_encoder(enum CodecID id);
3155

    
3156
/**
3157
 * Finds a registered encoder with the specified name.
3158
 *
3159
 * @param name name of the requested encoder
3160
 * @return An encoder if one was found, NULL otherwise.
3161
 */
3162
AVCodec *avcodec_find_encoder_by_name(const char *name);
3163

    
3164
/**
3165
 * Finds a registered decoder with a matching codec ID.
3166
 *
3167
 * @param id CodecID of the requested decoder
3168
 * @return A decoder if one was found, NULL otherwise.
3169
 */
3170
AVCodec *avcodec_find_decoder(enum CodecID id);
3171

    
3172
/**
3173
 * Finds a registered decoder with the specified name.
3174
 *
3175
 * @param name name of the requested decoder
3176
 * @return A decoder if one was found, NULL otherwise.
3177
 */
3178
AVCodec *avcodec_find_decoder_by_name(const char *name);
3179
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3180

    
3181
/**
3182
 * Sets the fields of the given AVCodecContext to default values.
3183
 *
3184
 * @param s The AVCodecContext of which the fields should be set to default values.
3185
 */
3186
void avcodec_get_context_defaults(AVCodecContext *s);
3187

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

    
3192
/**
3193
 * Allocates an AVCodecContext and sets its fields to default values.  The
3194
 * resulting struct can be deallocated by simply calling av_free().
3195
 *
3196
 * @return An AVCodecContext filled with default values or NULL on failure.
3197
 * @see avcodec_get_context_defaults
3198
 */
3199
AVCodecContext *avcodec_alloc_context(void);
3200

    
3201
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3202
 *  we WILL change its arguments and name a few times! */
3203
AVCodecContext *avcodec_alloc_context2(enum CodecType);
3204

    
3205
/**
3206
 * Sets the fields of the given AVFrame to default values.
3207
 *
3208
 * @param pic The AVFrame of which the fields should be set to default values.
3209
 */
3210
void avcodec_get_frame_defaults(AVFrame *pic);
3211

    
3212
/**
3213
 * Allocates an AVFrame and sets its fields to default values.  The resulting
3214
 * struct can be deallocated by simply calling av_free().
3215
 *
3216
 * @return An AVFrame filled with default values or NULL on failure.
3217
 * @see avcodec_get_frame_defaults
3218
 */
3219
AVFrame *avcodec_alloc_frame(void);
3220

    
3221
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3222
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3223
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3224
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3225

    
3226
/**
3227
 * Checks if the given dimension of a picture is valid, meaning that all
3228
 * bytes of the picture can be addressed with a signed int.
3229
 *
3230
 * @param[in] w Width of the picture.
3231
 * @param[in] h Height of the picture.
3232
 * @return Zero if valid, a negative value if invalid.
3233
 */
3234
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3235
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3236

    
3237
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3238
void avcodec_thread_free(AVCodecContext *s);
3239
int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3240
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3241
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3242
//FIXME func typedef
3243

    
3244
/**
3245
 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3246
 * function the context has to be allocated.
3247
 *
3248
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3249
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3250
 * retrieving a codec.
3251
 *
3252
 * @warning This function is not thread safe!
3253
 *
3254
 * @code
3255
 * avcodec_register_all();
3256
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3257
 * if (!codec)
3258
 *     exit(1);
3259
 *
3260
 * context = avcodec_alloc_context();
3261
 *
3262
 * if (avcodec_open(context, codec) < 0)
3263
 *     exit(1);
3264
 * @endcode
3265
 *
3266
 * @param avctx The context which will be set up to use the given codec.
3267
 * @param codec The codec to use within the context.
3268
 * @return zero on success, a negative value on error
3269
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3270
 */
3271
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3272

    
3273
#if LIBAVCODEC_VERSION_MAJOR < 53
3274
/**
3275
 * Decodes an audio frame from buf into samples.
3276
 * Wrapper function which calls avcodec_decode_audio3.
3277
 *
3278
 * @deprecated Use avcodec_decode_audio3 instead.
3279
 * @param avctx the codec context
3280
 * @param[out] samples the output buffer
3281
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3282
 * @param[in] buf the input buffer
3283
 * @param[in] buf_size the input buffer size in bytes
3284
 * @return On error a negative value is returned, otherwise the number of bytes
3285
 * used or zero if no frame could be decompressed.
3286
 */
3287
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3288
                         int *frame_size_ptr,
3289
                         const uint8_t *buf, int buf_size);
3290
#endif
3291

    
3292
/**
3293
 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3294
 * Some decoders may support multiple frames in a single AVPacket, such
3295
 * decoders would then just decode the first frame. In this case,
3296
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3297
 * the remaining data in order to decode the second frame etc.
3298
 * If no frame
3299
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3300
 * decompressed frame size in bytes.
3301
 *
3302
 * @warning You must set frame_size_ptr to the allocated size of the
3303
 * output buffer before calling avcodec_decode_audio3().
3304
 *
3305
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3306
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3307
 * bits at once and could read over the end.
3308
 *
3309
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3310
 * no overreading happens for damaged MPEG streams.
3311
 *
3312
 * @note You might have to align the input buffer avpkt->data and output buffer
3313
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3314
 * necessary at all, on others it won't work at all if not aligned and on others
3315
 * it will work but it will have an impact on performance.
3316
 *
3317
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3318
 * samples should be 16 byte aligned unless the CPU doesn't need it
3319
 * (AltiVec and SSE do).
3320
 *
3321
 * @param avctx the codec context
3322
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3323
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3324
 * @param[in] avpkt The input AVPacket containing the input buffer.
3325
 *            You can create such packet with av_init_packet() and by then setting
3326
 *            data and size, some decoders might in addition need other fields.
3327
 *            All decoders are designed to use the least fields possible though.
3328
 * @return On error a negative value is returned, otherwise the number of bytes
3329
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3330
 */
3331
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3332
                         int *frame_size_ptr,
3333
                         AVPacket *avpkt);
3334

    
3335
#if LIBAVCODEC_VERSION_MAJOR < 53
3336
/**
3337
 * Decodes a video frame from buf into picture.
3338
 * Wrapper function which calls avcodec_decode_video2.
3339
 *
3340
 * @deprecated Use avcodec_decode_video2 instead.
3341
 * @param avctx the codec context
3342
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3343
 * @param[in] buf the input buffer
3344
 * @param[in] buf_size the size of the input buffer in bytes
3345
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3346
 * @return On error a negative value is returned, otherwise the number of bytes
3347
 * used or zero if no frame could be decompressed.
3348
 */
3349
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3350
                         int *got_picture_ptr,
3351
                         const uint8_t *buf, int buf_size);
3352
#endif
3353

    
3354
/**
3355
 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3356
 * Some decoders may support multiple frames in a single AVPacket, such
3357
 * decoders would then just decode the first frame.
3358
 *
3359
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3360
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3361
 * bits at once and could read over the end.
3362
 *
3363
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3364
 * no overreading happens for damaged MPEG streams.
3365
 *
3366
 * @note You might have to align the input buffer avpkt->data.
3367
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3368
 * necessary at all, on others it won't work at all if not aligned and on others
3369
 * it will work but it will have an impact on performance.
3370
 *
3371
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3372
 *
3373
 * @note Some codecs have a delay between input and output, these need to be
3374
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3375
 *
3376
 * @param avctx the codec context
3377
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3378
 * @param[in] avpkt The input AVpacket containing the input buffer.
3379
 *            You can create such packet with av_init_packet() and by then setting
3380
 *            data and size, some decoders might in addition need other fields like
3381
 *            flags&PKT_FLAG_KEY. All decoders are designed to use the least
3382
 *            fields possible.
3383
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3384
 * @return On error a negative value is returned, otherwise the number of bytes
3385
 * used or zero if no frame could be decompressed.
3386
 */
3387
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3388
                         int *got_picture_ptr,
3389
                         AVPacket *avpkt);
3390

    
3391
#if LIBAVCODEC_VERSION_MAJOR < 53
3392
/* Decode a subtitle message. Return -1 if error, otherwise return the
3393
 * number of bytes used. If no subtitle could be decompressed,
3394
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3395
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3396
                            int *got_sub_ptr,
3397
                            const uint8_t *buf, int buf_size);
3398
#endif
3399

    
3400
/**
3401
 * Decodes a subtitle message.
3402
 * Returns a negative value on error, otherwise returns the number of bytes used.
3403
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3404
 * Otherwise, the subtitle is stored in *sub.
3405
 *
3406
 * @param avctx the codec context
3407
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3408
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3409
 * @param[in] avpkt The input AVPacket containing the input buffer.
3410
 */
3411
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3412
                            int *got_sub_ptr,
3413
                            AVPacket *avpkt);
3414
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3415
                        int *data_size_ptr,
3416
                        uint8_t *buf, int buf_size);
3417

    
3418
/**
3419
 * Encodes an audio frame from samples into buf.
3420
 *
3421
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3422
 * However, for PCM audio the user will know how much space is needed
3423
 * because it depends on the value passed in buf_size as described
3424
 * below. In that case a lower value can be used.
3425
 *
3426
 * @param avctx the codec context
3427
 * @param[out] buf the output buffer
3428
 * @param[in] buf_size the output buffer size
3429
 * @param[in] samples the input buffer containing the samples
3430
 * The number of samples read from this buffer is frame_size*channels,
3431
 * both of which are defined in avctx.
3432
 * For PCM audio the number of samples read from samples is equal to
3433
 * buf_size * input_sample_size / output_sample_size.
3434
 * @return On error a negative value is returned, on success zero or the number
3435
 * of bytes used to encode the data read from the input buffer.
3436
 */
3437
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3438
                         const short *samples);
3439

    
3440
/**
3441
 * Encodes a video frame from pict into buf.
3442
 * The input picture should be
3443
 * stored using a specific format, namely avctx.pix_fmt.
3444
 *
3445
 * @param avctx the codec context
3446
 * @param[out] buf the output buffer for the bitstream of encoded frame
3447
 * @param[in] buf_size the size of the output buffer in bytes
3448
 * @param[in] pict the input picture to encode
3449
 * @return On error a negative value is returned, on success zero or the number
3450
 * of bytes used from the output buffer.
3451
 */
3452
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3453
                         const AVFrame *pict);
3454
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3455
                            const AVSubtitle *sub);
3456

    
3457
int avcodec_close(AVCodecContext *avctx);
3458

    
3459
/**
3460
 * Register all the codecs, parsers and bitstream filters which were enabled at
3461
 * configuration time. If you do not call this function you can select exactly
3462
 * which formats you want to support, by using the individual registration
3463
 * functions.
3464
 *
3465
 * @see avcodec_register
3466
 * @see av_register_codec_parser
3467
 * @see av_register_bitstream_filter
3468
 */
3469
void avcodec_register_all(void);
3470

    
3471
/**
3472
 * Flush buffers, should be called when seeking or when switching to a different stream.
3473
 */
3474
void avcodec_flush_buffers(AVCodecContext *avctx);
3475

    
3476
void avcodec_default_free_buffers(AVCodecContext *s);
3477

    
3478
/* misc useful functions */
3479

    
3480
/**
3481
 * Returns a single letter to describe the given picture type pict_type.
3482
 *
3483
 * @param[in] pict_type the picture type
3484
 * @return A single character representing the picture type.
3485
 */
3486
char av_get_pict_type_char(int pict_type);
3487

    
3488
/**
3489
 * Returns codec bits per sample.
3490
 *
3491
 * @param[in] codec_id the codec
3492
 * @return Number of bits per sample or zero if unknown for the given codec.
3493
 */
3494
int av_get_bits_per_sample(enum CodecID codec_id);
3495

    
3496
/**
3497
 * Returns sample format bits per sample.
3498
 *
3499
 * @param[in] sample_fmt the sample format
3500
 * @return Number of bits per sample or zero if unknown for the given sample format.
3501
 */
3502
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3503

    
3504
/* frame parsing */
3505
typedef struct AVCodecParserContext {
3506
    void *priv_data;
3507
    struct AVCodecParser *parser;
3508
    int64_t frame_offset; /* offset of the current frame */
3509
    int64_t cur_offset; /* current offset
3510
                           (incremented by each av_parser_parse()) */
3511
    int64_t next_frame_offset; /* offset of the next frame */
3512
    /* video info */
3513
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3514
    /**
3515
     * This field is used for proper frame duration computation in lavf.
3516
     * It signals, how much longer the frame duration of the current frame
3517
     * is compared to normal frame duration.
3518
     *
3519
     * frame_duration = (1 + repeat_pict) * time_base
3520
     *
3521
     * It is used by codecs like H.264 to display telecined material.
3522
     */
3523
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3524
    int64_t pts;     /* pts of the current frame */
3525
    int64_t dts;     /* dts of the current frame */
3526

    
3527
    /* private data */
3528
    int64_t last_pts;
3529
    int64_t last_dts;
3530
    int fetch_timestamp;
3531

    
3532
#define AV_PARSER_PTS_NB 4
3533
    int cur_frame_start_index;
3534
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3535
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3536
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3537

    
3538
    int flags;
3539
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3540

    
3541
    int64_t offset;      ///< byte offset from starting packet start
3542
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3543

    
3544
    /*!
3545
     * Set by parser to 1 for key frames and 0 for non-key frames.
3546
     * It is initialized to -1, so if the parser doesn't set this flag,
3547
     * old-style fallback using FF_I_TYPE picture type as key frames
3548
     * will be used.
3549
     */
3550
    int key_frame;
3551

    
3552
    /**
3553
     * Time difference in stream time base units from the pts of this
3554
     * packet to the point at which the output from the decoder has converged
3555
     * independent from the availability of previous frames. That is, the
3556
     * frames are virtually identical no matter if decoding started from
3557
     * the very first frame or from this keyframe.
3558
     * Is AV_NOPTS_VALUE if unknown.
3559
     * This field is not the display duration of the current frame.
3560
     *
3561
     * The purpose of this field is to allow seeking in streams that have no
3562
     * keyframes in the conventional sense. It corresponds to the
3563
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3564
     * essential for some types of subtitle streams to ensure that all
3565
     * subtitles are correctly displayed after seeking.
3566
     */
3567
    int64_t convergence_duration;
3568

    
3569
    // Timestamp generation support:
3570
    /**
3571
     * Synchronization point for start of timestamp generation.
3572
     *
3573
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3574
     * (default).
3575
     *
3576
     * For example, this corresponds to presence of H.264 buffering period
3577
     * SEI message.
3578
     */
3579
    int dts_sync_point;
3580

    
3581
    /**
3582
     * Offset of the current timestamp against last timestamp sync point in
3583
     * units of AVCodecContext.time_base.
3584
     *
3585
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3586
     * contain a valid timestamp offset.
3587
     *
3588
     * Note that the timestamp of sync point has usually a nonzero
3589
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3590
     * the next frame after timestamp sync point will be usually 1.
3591
     *
3592
     * For example, this corresponds to H.264 cpb_removal_delay.
3593
     */
3594
    int dts_ref_dts_delta;
3595

    
3596
    /**
3597
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3598
     *
3599
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3600
     * contain valid non-negative timestamp delta (presentation time of a frame
3601
     * must not lie in the past).
3602
     *
3603
     * This delay represents the difference between decoding and presentation
3604
     * time of the frame.
3605
     *
3606
     * For example, this corresponds to H.264 dpb_output_delay.
3607
     */
3608
    int pts_dts_delta;
3609

    
3610
    /**
3611
     * Position of the packet in file.
3612
     *
3613
     * Analogous to cur_frame_pts/dts
3614
     */
3615
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3616

    
3617
    /**
3618
     * Byte position of currently parsed frame in stream.
3619
     */
3620
    int64_t pos;
3621

    
3622
    /**
3623
     * Previous frame byte position.
3624
     */
3625
    int64_t last_pos;
3626
} AVCodecParserContext;
3627

    
3628
typedef struct AVCodecParser {
3629
    int codec_ids[5]; /* several codec IDs are permitted */
3630
    int priv_data_size;
3631
    int (*parser_init)(AVCodecParserContext *s);
3632
    int (*parser_parse)(AVCodecParserContext *s,
3633
                        AVCodecContext *avctx,
3634
                        const uint8_t **poutbuf, int *poutbuf_size,
3635
                        const uint8_t *buf, int buf_size);
3636
    void (*parser_close)(AVCodecParserContext *s);
3637
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3638
    struct AVCodecParser *next;
3639
} AVCodecParser;
3640

    
3641
AVCodecParser *av_parser_next(AVCodecParser *c);
3642

    
3643
void av_register_codec_parser(AVCodecParser *parser);
3644
AVCodecParserContext *av_parser_init(int codec_id);
3645

    
3646
#if LIBAVCODEC_VERSION_MAJOR < 53
3647
attribute_deprecated
3648
int av_parser_parse(AVCodecParserContext *s,
3649
                    AVCodecContext *avctx,
3650
                    uint8_t **poutbuf, int *poutbuf_size,
3651
                    const uint8_t *buf, int buf_size,
3652
                    int64_t pts, int64_t dts);
3653
#endif
3654

    
3655
/**
3656
 * Parse a packet.
3657
 *
3658
 * @param s             parser context.
3659
 * @param avctx         codec context.
3660
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3661
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3662
 * @param buf           input buffer.
3663
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3664
 * @param pts           input presentation timestamp.
3665
 * @param dts           input decoding timestamp.
3666
 * @param pos           input byte position in stream.
3667
 * @return the number of bytes of the input bitstream used.
3668
 *
3669
 * Example:
3670
 * @code
3671
 *   while(in_len){
3672
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3673
 *                                        in_data, in_len,
3674
 *                                        pts, dts, pos);
3675
 *       in_data += len;
3676
 *       in_len  -= len;
3677
 *
3678
 *       if(size)
3679
 *          decode_frame(data, size);
3680
 *   }
3681
 * @endcode
3682
 */
3683
int av_parser_parse2(AVCodecParserContext *s,
3684
                     AVCodecContext *avctx,
3685
                     uint8_t **poutbuf, int *poutbuf_size,
3686
                     const uint8_t *buf, int buf_size,
3687
                     int64_t pts, int64_t dts,
3688
                     int64_t pos);
3689

    
3690
int av_parser_change(AVCodecParserContext *s,
3691
                     AVCodecContext *avctx,
3692
                     uint8_t **poutbuf, int *poutbuf_size,
3693
                     const uint8_t *buf, int buf_size, int keyframe);
3694
void av_parser_close(AVCodecParserContext *s);
3695

    
3696

    
3697
typedef struct AVBitStreamFilterContext {
3698
    void *priv_data;
3699
    struct AVBitStreamFilter *filter;
3700
    AVCodecParserContext *parser;
3701
    struct AVBitStreamFilterContext *next;
3702
} AVBitStreamFilterContext;
3703

    
3704

    
3705
typedef struct AVBitStreamFilter {
3706
    const char *name;
3707
    int priv_data_size;
3708
    int (*filter)(AVBitStreamFilterContext *bsfc,
3709
                  AVCodecContext *avctx, const char *args,
3710
                  uint8_t **poutbuf, int *poutbuf_size,
3711
                  const uint8_t *buf, int buf_size, int keyframe);
3712
    void (*close)(AVBitStreamFilterContext *bsfc);
3713
    struct AVBitStreamFilter *next;
3714
} AVBitStreamFilter;
3715

    
3716
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3717
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3718
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3719
                               AVCodecContext *avctx, const char *args,
3720
                               uint8_t **poutbuf, int *poutbuf_size,
3721
                               const uint8_t *buf, int buf_size, int keyframe);
3722
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3723

    
3724
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3725

    
3726
/* memory */
3727

    
3728
/**
3729
 * Reallocates the given block if it is not large enough, otherwise it
3730
 * does nothing.
3731
 *
3732
 * @see av_realloc
3733
 */
3734
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3735

    
3736
/**
3737
 * Allocates a buffer, reusing the given one if large enough.
3738
 *
3739
 * Contrary to av_fast_realloc the current buffer contents might not be
3740
 * preserved and on error the old buffer is freed, thus no special
3741
 * handling to avoid memleaks is necessary.
3742
 *
3743
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3744
 * @param size size of the buffer *ptr points to
3745
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3746
 *                 *size 0 if an error occurred.
3747
 */
3748
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3749

    
3750
/**
3751
 * Copy image 'src' to 'dst'.
3752
 */
3753
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3754
                     enum PixelFormat pix_fmt, int width, int height);
3755

    
3756
/**
3757
 * Crop image top and left side.
3758
 */
3759
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3760
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3761

    
3762
/**
3763
 * Pad image.
3764
 */
3765
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3766
            int padtop, int padbottom, int padleft, int padright, int *color);
3767

    
3768
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3769

    
3770
/**
3771
 * Parses str and put in width_ptr and height_ptr the detected values.
3772
 *
3773
 * @return 0 in case of a successful parsing, a negative value otherwise
3774
 * @param[in] str the string to parse: it has to be a string in the format
3775
 * <width>x<height> or a valid video frame size abbreviation.
3776
 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3777
 * frame width value
3778
 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3779
 * frame height value
3780
 */
3781
int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3782

    
3783
/**
3784
 * Parses str and put in frame_rate the detected values.
3785
 *
3786
 * @return 0 in case of a successful parsing, a negative value otherwise
3787
 * @param[in] str the string to parse: it has to be a string in the format
3788
 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3789
 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3790
 * frame rate
3791
 */
3792
int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3793

    
3794
/* error handling */
3795
#if EINVAL > 0
3796
#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3797
#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3798
#else
3799
/* Some platforms have E* and errno already negated. */
3800
#define AVERROR(e) (e)
3801
#define AVUNERROR(e) (e)
3802
#endif
3803
#define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3804
#define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3805
#define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3806
#define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3807
#define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3808
#define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3809
#define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3810
#define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3811
#define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
3812
#define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3813

    
3814
/**
3815
 * Logs a generic warning message about a missing feature. This function is
3816
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3817
 * only, and would normally not be used by applications.
3818
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3819
 * a pointer to an AVClass struct
3820
 * @param[in] feature string containing the name of the missing feature
3821
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3822
 * If want_sample is non-zero, additional verbage will be added to the log
3823
 * message which tells the user how to report samples to the development
3824
 * mailing list.
3825
 */
3826
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3827

    
3828
/**
3829
 * Logs a generic warning message asking for a sample. This function is
3830
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3831
 * only, and would normally not be used by applications.
3832
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3833
 * a pointer to an AVClass struct
3834
 * @param[in] msg string containing an optional message, or NULL if no message
3835
 */
3836
void av_log_ask_for_sample(void *avc, const char *msg);
3837

    
3838
/**
3839
 * Registers the hardware accelerator hwaccel.
3840
 */
3841
void av_register_hwaccel(AVHWAccel *hwaccel);
3842

    
3843
/**
3844
 * If hwaccel is NULL, returns the first registered hardware accelerator,
3845
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3846
 * after hwaccel, or NULL if hwaccel is the last one.
3847
 */
3848
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3849

    
3850

    
3851
/**
3852
 * Lock operation used by lockmgr
3853
 */
3854
enum AVLockOp {
3855
  AV_LOCK_CREATE,  ///< Create a mutex
3856
  AV_LOCK_OBTAIN,  ///< Lock the mutex
3857
  AV_LOCK_RELEASE, ///< Unlock the mutex
3858
  AV_LOCK_DESTROY, ///< Free mutex resources
3859
};
3860

    
3861
/**
3862
 * Register a user provided lock manager supporting the operations
3863
 * specified by AVLockOp. mutex points to a (void *) where the
3864
 * lockmgr should store/get a pointer to a user allocated mutex. It's
3865
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3866
 *
3867
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3868
 *           callback during the call to av_lockmgr_register().
3869
 *           Thus, the application must be prepared to handle that.
3870
 *           If cb is set to NULL the lockmgr will be unregistered.
3871
 *           Also note that during unregistration the previously registered
3872
 *           lockmgr callback may also be invoked.
3873
 */
3874
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3875

    
3876
#endif /* AVCODEC_AVCODEC_H */