Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ a377cfa6

History | View | Annotate | Download (131 KB)

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

    
21
#ifndef AVCODEC_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

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

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

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

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

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

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

    
64
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
65
#define AV_TIME_BASE            1000000
66
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
67

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

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

    
238
    /* various PCM "codecs" */
239
    CODEC_ID_PCM_S16LE= 0x10000,
240
    CODEC_ID_PCM_S16BE,
241
    CODEC_ID_PCM_U16LE,
242
    CODEC_ID_PCM_U16BE,
243
    CODEC_ID_PCM_S8,
244
    CODEC_ID_PCM_U8,
245
    CODEC_ID_PCM_MULAW,
246
    CODEC_ID_PCM_ALAW,
247
    CODEC_ID_PCM_S32LE,
248
    CODEC_ID_PCM_S32BE,
249
    CODEC_ID_PCM_U32LE,
250
    CODEC_ID_PCM_U32BE,
251
    CODEC_ID_PCM_S24LE,
252
    CODEC_ID_PCM_S24BE,
253
    CODEC_ID_PCM_U24LE,
254
    CODEC_ID_PCM_U24BE,
255
    CODEC_ID_PCM_S24DAUD,
256
    CODEC_ID_PCM_ZORK,
257
    CODEC_ID_PCM_S16LE_PLANAR,
258
    CODEC_ID_PCM_DVD,
259
    CODEC_ID_PCM_F32BE,
260
    CODEC_ID_PCM_F32LE,
261
    CODEC_ID_PCM_F64BE,
262
    CODEC_ID_PCM_F64LE,
263
    CODEC_ID_PCM_BLURAY,
264

    
265
    /* various ADPCM codecs */
266
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
267
    CODEC_ID_ADPCM_IMA_WAV,
268
    CODEC_ID_ADPCM_IMA_DK3,
269
    CODEC_ID_ADPCM_IMA_DK4,
270
    CODEC_ID_ADPCM_IMA_WS,
271
    CODEC_ID_ADPCM_IMA_SMJPEG,
272
    CODEC_ID_ADPCM_MS,
273
    CODEC_ID_ADPCM_4XM,
274
    CODEC_ID_ADPCM_XA,
275
    CODEC_ID_ADPCM_ADX,
276
    CODEC_ID_ADPCM_EA,
277
    CODEC_ID_ADPCM_G726,
278
    CODEC_ID_ADPCM_CT,
279
    CODEC_ID_ADPCM_SWF,
280
    CODEC_ID_ADPCM_YAMAHA,
281
    CODEC_ID_ADPCM_SBPRO_4,
282
    CODEC_ID_ADPCM_SBPRO_3,
283
    CODEC_ID_ADPCM_SBPRO_2,
284
    CODEC_ID_ADPCM_THP,
285
    CODEC_ID_ADPCM_IMA_AMV,
286
    CODEC_ID_ADPCM_EA_R1,
287
    CODEC_ID_ADPCM_EA_R3,
288
    CODEC_ID_ADPCM_EA_R2,
289
    CODEC_ID_ADPCM_IMA_EA_SEAD,
290
    CODEC_ID_ADPCM_IMA_EA_EACS,
291
    CODEC_ID_ADPCM_EA_XAS,
292
    CODEC_ID_ADPCM_EA_MAXIS_XA,
293
    CODEC_ID_ADPCM_IMA_ISS,
294
    CODEC_ID_ADPCM_G722,
295

    
296
    /* AMR */
297
    CODEC_ID_AMR_NB= 0x12000,
298
    CODEC_ID_AMR_WB,
299

    
300
    /* RealAudio codecs*/
301
    CODEC_ID_RA_144= 0x13000,
302
    CODEC_ID_RA_288,
303

    
304
    /* various DPCM codecs */
305
    CODEC_ID_ROQ_DPCM= 0x14000,
306
    CODEC_ID_INTERPLAY_DPCM,
307
    CODEC_ID_XAN_DPCM,
308
    CODEC_ID_SOL_DPCM,
309

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

    
364
    /* subtitle codecs */
365
    CODEC_ID_DVD_SUBTITLE= 0x17000,
366
    CODEC_ID_DVB_SUBTITLE,
367
    CODEC_ID_TEXT,  ///< raw UTF-8 text
368
    CODEC_ID_XSUB,
369
    CODEC_ID_SSA,
370
    CODEC_ID_MOV_TEXT,
371
    CODEC_ID_HDMV_PGS_SUBTITLE,
372
    CODEC_ID_DVB_TELETEXT,
373
    CODEC_ID_SRT,
374

    
375
    /* other specific kind of codecs (generally used for attachments) */
376
    CODEC_ID_TTF= 0x18000,
377

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

    
380
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
381
                                * stream (only used by libavformat) */
382
};
383

    
384
#if LIBAVCODEC_VERSION_MAJOR < 53
385
#define CodecType AVMediaType
386

    
387
#define CODEC_TYPE_UNKNOWN    AVMEDIA_TYPE_UNKNOWN
388
#define CODEC_TYPE_VIDEO      AVMEDIA_TYPE_VIDEO
389
#define CODEC_TYPE_AUDIO      AVMEDIA_TYPE_AUDIO
390
#define CODEC_TYPE_DATA       AVMEDIA_TYPE_DATA
391
#define CODEC_TYPE_SUBTITLE   AVMEDIA_TYPE_SUBTITLE
392
#define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
393
#define CODEC_TYPE_NB         AVMEDIA_TYPE_NB
394
#endif
395

    
396
/**
397
 * all in native-endian format
398
 */
399
enum SampleFormat {
400
    SAMPLE_FMT_NONE = -1,
401
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
402
    SAMPLE_FMT_S16,             ///< signed 16 bits
403
    SAMPLE_FMT_S32,             ///< signed 32 bits
404
    SAMPLE_FMT_FLT,             ///< float
405
    SAMPLE_FMT_DBL,             ///< double
406
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
407
};
408

    
409
/* Audio channel masks */
410
#define CH_FRONT_LEFT             0x00000001
411
#define CH_FRONT_RIGHT            0x00000002
412
#define CH_FRONT_CENTER           0x00000004
413
#define CH_LOW_FREQUENCY          0x00000008
414
#define CH_BACK_LEFT              0x00000010
415
#define CH_BACK_RIGHT             0x00000020
416
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
417
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
418
#define CH_BACK_CENTER            0x00000100
419
#define CH_SIDE_LEFT              0x00000200
420
#define CH_SIDE_RIGHT             0x00000400
421
#define CH_TOP_CENTER             0x00000800
422
#define CH_TOP_FRONT_LEFT         0x00001000
423
#define CH_TOP_FRONT_CENTER       0x00002000
424
#define CH_TOP_FRONT_RIGHT        0x00004000
425
#define CH_TOP_BACK_LEFT          0x00008000
426
#define CH_TOP_BACK_CENTER        0x00010000
427
#define CH_TOP_BACK_RIGHT         0x00020000
428
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
429
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
430

    
431
/** Channel mask value used for AVCodecContext.request_channel_layout
432
    to indicate that the user requests the channel order of the decoder output
433
    to be the native codec channel order. */
434
#define CH_LAYOUT_NATIVE          0x8000000000000000LL
435

    
436
/* Audio channel convenience macros */
437
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
438
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
439
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
440
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
441
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
442
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
443
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
444
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
445
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
446
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
447
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
448
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
449
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
450
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
451
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
452
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
453

    
454
/* in bytes */
455
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
456

    
457
/**
458
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
459
 * This is mainly needed because some optimized bitstream readers read
460
 * 32 or 64 bit at once and could read over the end.<br>
461
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
462
 * MPEG bitstreams could cause overread and segfault.
463
 */
464
#define FF_INPUT_BUFFER_PADDING_SIZE 8
465

    
466
/**
467
 * minimum encoding buffer size
468
 * Used to avoid some checks during header writing.
469
 */
470
#define FF_MIN_BUFFER_SIZE 16384
471

    
472

    
473
/**
474
 * motion estimation type.
475
 */
476
enum Motion_Est_ID {
477
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
478
    ME_FULL,
479
    ME_LOG,
480
    ME_PHODS,
481
    ME_EPZS,        ///< enhanced predictive zonal search
482
    ME_X1,          ///< reserved for experiments
483
    ME_HEX,         ///< hexagon based search
484
    ME_UMH,         ///< uneven multi-hexagon search
485
    ME_ITER,        ///< iterative search
486
    ME_TESA,        ///< transformed exhaustive search algorithm
487
};
488

    
489
enum AVDiscard{
490
    /* We leave some space between them for extensions (drop some
491
     * keyframes for intra-only or drop just some bidir frames). */
492
    AVDISCARD_NONE   =-16, ///< discard nothing
493
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
494
    AVDISCARD_NONREF =  8, ///< discard all non reference
495
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
496
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
497
    AVDISCARD_ALL    = 48, ///< discard all
498
};
499

    
500
enum AVColorPrimaries{
501
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
502
    AVCOL_PRI_UNSPECIFIED=2,
503
    AVCOL_PRI_BT470M     =4,
504
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
505
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
506
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
507
    AVCOL_PRI_FILM       =8,
508
    AVCOL_PRI_NB           , ///< Not part of ABI
509
};
510

    
511
enum AVColorTransferCharacteristic{
512
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
513
    AVCOL_TRC_UNSPECIFIED=2,
514
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
515
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
516
    AVCOL_TRC_NB           , ///< Not part of ABI
517
};
518

    
519
enum AVColorSpace{
520
    AVCOL_SPC_RGB        =0,
521
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
522
    AVCOL_SPC_UNSPECIFIED=2,
523
    AVCOL_SPC_FCC        =4,
524
    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
525
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
526
    AVCOL_SPC_SMPTE240M  =7,
527
    AVCOL_SPC_NB           , ///< Not part of ABI
528
};
529

    
530
enum AVColorRange{
531
    AVCOL_RANGE_UNSPECIFIED=0,
532
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
533
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
534
    AVCOL_RANGE_NB           , ///< Not part of ABI
535
};
536

    
537
/**
538
 *  X   X      3 4 X      X are luma samples,
539
 *             1 2        1-6 are possible chroma positions
540
 *  X   X      5 6 X      0 is undefined/unknown position
541
 */
542
enum AVChromaLocation{
543
    AVCHROMA_LOC_UNSPECIFIED=0,
544
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
545
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
546
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
547
    AVCHROMA_LOC_TOP        =4,
548
    AVCHROMA_LOC_BOTTOMLEFT =5,
549
    AVCHROMA_LOC_BOTTOM     =6,
550
    AVCHROMA_LOC_NB           , ///< Not part of ABI
551
};
552

    
553
/**
554
 * LPC analysis type
555
 */
556
enum AVLPCType {
557
    AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
558
    AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
559
    AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
560
    AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
561
    AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
562
    AV_LPC_TYPE_NB              , ///< Not part of ABI
563
};
564

    
565
typedef struct RcOverride{
566
    int start_frame;
567
    int end_frame;
568
    int qscale; // If this is 0 then quality_factor will be used instead.
569
    float quality_factor;
570
} RcOverride;
571

    
572
#define FF_MAX_B_FRAMES 16
573

    
574
/* encoding support
575
   These flags can be passed in AVCodecContext.flags before initialization.
576
   Note: Not everything is supported yet.
577
*/
578

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

    
640
/* Unsupported options :
641
 *              Syntax Arithmetic coding (SAC)
642
 *              Reference Picture Selection
643
 *              Independent Segment Decoding */
644
/* /Fx */
645
/* codec capabilities */
646

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

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

    
715
/**
716
 * Pan Scan area.
717
 * This specifies the area which should be displayed.
718
 * Note there may be multiple such areas for one frame.
719
 */
720
typedef struct AVPanScan{
721
    /**
722
     * id
723
     * - encoding: Set by user.
724
     * - decoding: Set by libavcodec.
725
     */
726
    int id;
727

    
728
    /**
729
     * width and height in 1/16 pel
730
     * - encoding: Set by user.
731
     * - decoding: Set by libavcodec.
732
     */
733
    int width;
734
    int height;
735

    
736
    /**
737
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
738
     * - encoding: Set by user.
739
     * - decoding: Set by libavcodec.
740
     */
741
    int16_t position[3][2];
742
}AVPanScan;
743

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

    
971

    
972
#define FF_QSCALE_TYPE_MPEG1 0
973
#define FF_QSCALE_TYPE_MPEG2 1
974
#define FF_QSCALE_TYPE_H264  2
975
#define FF_QSCALE_TYPE_VP56  3
976

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

    
982

    
983
#define FF_I_TYPE  1 ///< Intra
984
#define FF_P_TYPE  2 ///< Predicted
985
#define FF_B_TYPE  3 ///< Bi-dir predicted
986
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
987
#define FF_SI_TYPE 5 ///< Switching Intra
988
#define FF_SP_TYPE 6 ///< Switching Predicted
989
#define FF_BI_TYPE 7
990

    
991
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
992
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
993
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
994
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
995

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

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

    
1050
/**
1051
 * Audio Video Frame.
1052
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1053
 * bumps.
1054
 * Removal, reordering and changes to existing fields require a major
1055
 * version bump. No fields should be added into AVFrame before or after
1056
 * FF_COMMON_FRAME!
1057
 * sizeof(AVFrame) must not be used outside libav*.
1058
 */
1059
typedef struct AVFrame {
1060
    FF_COMMON_FRAME
1061
} AVFrame;
1062

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

    
1083
    /**
1084
     * number of bits the bitstream is allowed to diverge from the reference.
1085
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1086
     * - encoding: Set by user; unused for constant quantizer encoding.
1087
     * - decoding: unused
1088
     */
1089
    int bit_rate_tolerance;
1090

    
1091
    /**
1092
     * CODEC_FLAG_*.
1093
     * - encoding: Set by user.
1094
     * - decoding: Set by user.
1095
     */
1096
    int flags;
1097

    
1098
    /**
1099
     * Some codecs need additional format info. It is stored here.
1100
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1101
     * specific codec MUST set it correctly otherwise stream copy breaks.
1102
     * In general use of this field by muxers is not recommanded.
1103
     * - encoding: Set by libavcodec.
1104
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1105
     */
1106
    int sub_id;
1107

    
1108
    /**
1109
     * Motion estimation algorithm used for video coding.
1110
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1111
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1112
     * - encoding: MUST be set by user.
1113
     * - decoding: unused
1114
     */
1115
    int me_method;
1116

    
1117
    /**
1118
     * some codecs need / can use extradata like Huffman tables.
1119
     * mjpeg: Huffman tables
1120
     * rv10: additional flags
1121
     * mpeg4: global headers (they can be in the bitstream or here)
1122
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1123
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1124
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1125
     * - encoding: Set/allocated/freed by libavcodec.
1126
     * - decoding: Set/allocated/freed by user.
1127
     */
1128
    uint8_t *extradata;
1129
    int extradata_size;
1130

    
1131
    /**
1132
     * This is the fundamental unit of time (in seconds) in terms
1133
     * of which frame timestamps are represented. For fixed-fps content,
1134
     * timebase should be 1/framerate and timestamp increments should be
1135
     * identically 1.
1136
     * - encoding: MUST be set by user.
1137
     * - decoding: Set by libavcodec.
1138
     */
1139
    AVRational time_base;
1140

    
1141
    /* video only */
1142
    /**
1143
     * picture width / height.
1144
     * - encoding: MUST be set by user.
1145
     * - decoding: Set by libavcodec.
1146
     * Note: For compatibility it is possible to set this instead of
1147
     * coded_width/height before decoding.
1148
     */
1149
    int width, height;
1150

    
1151
#define FF_ASPECT_EXTENDED 15
1152

    
1153
    /**
1154
     * the number of pictures in a group of pictures, or 0 for intra_only
1155
     * - encoding: Set by user.
1156
     * - decoding: unused
1157
     */
1158
    int gop_size;
1159

    
1160
    /**
1161
     * Pixel format, see PIX_FMT_xxx.
1162
     * May be set by the demuxer if known from headers.
1163
     * May be overriden by the decoder if it knows better.
1164
     * - encoding: Set by user.
1165
     * - decoding: Set by user if known, overridden by libavcodec if known
1166
     */
1167
    enum PixelFormat pix_fmt;
1168

    
1169
    /**
1170
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1171
     * has to read frames at native frame rate.
1172
     * - encoding: Set by user.
1173
     * - decoding: unused
1174
     */
1175
    int rate_emu;
1176

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

    
1200
    /* audio only */
1201
    int sample_rate; ///< samples per second
1202
    int channels;    ///< number of audio channels
1203

    
1204
    /**
1205
     * audio sample format
1206
     * - encoding: Set by user.
1207
     * - decoding: Set by libavcodec.
1208
     */
1209
    enum SampleFormat sample_fmt;  ///< sample format
1210

    
1211
    /* The following data should not be initialized. */
1212
    /**
1213
     * Samples per packet, initialized when calling 'init'.
1214
     */
1215
    int frame_size;
1216
    int frame_number;   ///< audio or video frame number
1217
#if LIBAVCODEC_VERSION_MAJOR < 53
1218
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1219
#endif
1220

    
1221
    /**
1222
     * Number of frames the decoded output will be delayed relative to
1223
     * the encoded input.
1224
     * - encoding: Set by libavcodec.
1225
     * - decoding: unused
1226
     */
1227
    int delay;
1228

    
1229
    /* - encoding parameters */
1230
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1231
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1232

    
1233
    /**
1234
     * minimum quantizer
1235
     * - encoding: Set by user.
1236
     * - decoding: unused
1237
     */
1238
    int qmin;
1239

    
1240
    /**
1241
     * maximum quantizer
1242
     * - encoding: Set by user.
1243
     * - decoding: unused
1244
     */
1245
    int qmax;
1246

    
1247
    /**
1248
     * maximum quantizer difference between frames
1249
     * - encoding: Set by user.
1250
     * - decoding: unused
1251
     */
1252
    int max_qdiff;
1253

    
1254
    /**
1255
     * maximum number of B-frames between non-B-frames
1256
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1257
     * - encoding: Set by user.
1258
     * - decoding: unused
1259
     */
1260
    int max_b_frames;
1261

    
1262
    /**
1263
     * qscale factor between IP and B-frames
1264
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1265
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1266
     * - encoding: Set by user.
1267
     * - decoding: unused
1268
     */
1269
    float b_quant_factor;
1270

    
1271
    /** obsolete FIXME remove */
1272
    int rc_strategy;
1273
#define FF_RC_STRATEGY_XVID 1
1274

    
1275
    int b_frame_strategy;
1276

    
1277
    /**
1278
     * hurry up amount
1279
     * - encoding: unused
1280
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1281
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1282
     */
1283
    int hurry_up;
1284

    
1285
    struct AVCodec *codec;
1286

    
1287
    void *priv_data;
1288

    
1289
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1290
                            /* do its best to deliver a chunk with size     */
1291
                            /* below rtp_payload_size, the chunk will start */
1292
                            /* with a start code on some codecs like H.263. */
1293
                            /* This doesn't take account of any particular  */
1294
                            /* headers inside the transmitted RTP payload.  */
1295

    
1296

    
1297
    /* The RTP callback: This function is called    */
1298
    /* every time the encoder has a packet to send. */
1299
    /* It depends on the encoder if the data starts */
1300
    /* with a Start Code (it should). H.263 does.   */
1301
    /* mb_nb contains the number of macroblocks     */
1302
    /* encoded in the RTP payload.                  */
1303
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1304

    
1305
    /* statistics, used for 2-pass encoding */
1306
    int mv_bits;
1307
    int header_bits;
1308
    int i_tex_bits;
1309
    int p_tex_bits;
1310
    int i_count;
1311
    int p_count;
1312
    int skip_count;
1313
    int misc_bits;
1314

    
1315
    /**
1316
     * number of bits used for the previously encoded frame
1317
     * - encoding: Set by libavcodec.
1318
     * - decoding: unused
1319
     */
1320
    int frame_bits;
1321

    
1322
    /**
1323
     * Private data of the user, can be used to carry app specific stuff.
1324
     * - encoding: Set by user.
1325
     * - decoding: Set by user.
1326
     */
1327
    void *opaque;
1328

    
1329
    char codec_name[32];
1330
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1331
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1332

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

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

    
1372
    /**
1373
     * luma single coefficient elimination threshold
1374
     * - encoding: Set by user.
1375
     * - decoding: unused
1376
     */
1377
    int luma_elim_threshold;
1378

    
1379
    /**
1380
     * chroma single coeff elimination threshold
1381
     * - encoding: Set by user.
1382
     * - decoding: unused
1383
     */
1384
    int chroma_elim_threshold;
1385

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

    
1408
    /**
1409
     * qscale offset between IP and B-frames
1410
     * - encoding: Set by user.
1411
     * - decoding: unused
1412
     */
1413
    float b_quant_offset;
1414

    
1415
    /**
1416
     * Error recognization; higher values will detect more errors but may
1417
     * misdetect some more or less valid parts as errors.
1418
     * - encoding: unused
1419
     * - decoding: Set by user.
1420
     */
1421
    int error_recognition;
1422
#define FF_ER_CAREFUL         1
1423
#define FF_ER_COMPLIANT       2
1424
#define FF_ER_AGGRESSIVE      3
1425
#define FF_ER_VERY_AGGRESSIVE 4
1426

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

    
1440
    /**
1441
     * Called to release buffers which were allocated with get_buffer.
1442
     * A released buffer can be reused in get_buffer().
1443
     * pic.data[*] must be set to NULL.
1444
     * - encoding: unused
1445
     * - decoding: Set by libavcodec, user can override.
1446
     */
1447
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1448

    
1449
    /**
1450
     * Size of the frame reordering buffer in the decoder.
1451
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1452
     * - encoding: Set by libavcodec.
1453
     * - decoding: Set by libavcodec.
1454
     */
1455
    int has_b_frames;
1456

    
1457
    /**
1458
     * number of bytes per packet if constant and known or 0
1459
     * Used by some WAV based audio codecs.
1460
     */
1461
    int block_align;
1462

    
1463
    int parse_only; /* - decoding only: If true, only parsing is done
1464
                       (function avcodec_parse_frame()). The frame
1465
                       data is returned. Only MPEG codecs support this now. */
1466

    
1467
    /**
1468
     * 0-> h263 quant 1-> mpeg quant
1469
     * - encoding: Set by user.
1470
     * - decoding: unused
1471
     */
1472
    int mpeg_quant;
1473

    
1474
    /**
1475
     * pass1 encoding statistics output buffer
1476
     * - encoding: Set by libavcodec.
1477
     * - decoding: unused
1478
     */
1479
    char *stats_out;
1480

    
1481
    /**
1482
     * pass2 encoding statistics input buffer
1483
     * Concatenated stuff from stats_out of pass1 should be placed here.
1484
     * - encoding: Allocated/set/freed by user.
1485
     * - decoding: unused
1486
     */
1487
    char *stats_in;
1488

    
1489
    /**
1490
     * ratecontrol qmin qmax limiting method
1491
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1492
     * - encoding: Set by user.
1493
     * - decoding: unused
1494
     */
1495
    float rc_qsquish;
1496

    
1497
    float rc_qmod_amp;
1498
    int rc_qmod_freq;
1499

    
1500
    /**
1501
     * ratecontrol override, see RcOverride
1502
     * - encoding: Allocated/set/freed by user.
1503
     * - decoding: unused
1504
     */
1505
    RcOverride *rc_override;
1506
    int rc_override_count;
1507

    
1508
    /**
1509
     * rate control equation
1510
     * - encoding: Set by user
1511
     * - decoding: unused
1512
     */
1513
    const char *rc_eq;
1514

    
1515
    /**
1516
     * maximum bitrate
1517
     * - encoding: Set by user.
1518
     * - decoding: unused
1519
     */
1520
    int rc_max_rate;
1521

    
1522
    /**
1523
     * minimum bitrate
1524
     * - encoding: Set by user.
1525
     * - decoding: unused
1526
     */
1527
    int rc_min_rate;
1528

    
1529
    /**
1530
     * decoder bitstream buffer size
1531
     * - encoding: Set by user.
1532
     * - decoding: unused
1533
     */
1534
    int rc_buffer_size;
1535
    float rc_buffer_aggressivity;
1536

    
1537
    /**
1538
     * qscale factor between P and I-frames
1539
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1540
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1541
     * - encoding: Set by user.
1542
     * - decoding: unused
1543
     */
1544
    float i_quant_factor;
1545

    
1546
    /**
1547
     * qscale offset between P and I-frames
1548
     * - encoding: Set by user.
1549
     * - decoding: unused
1550
     */
1551
    float i_quant_offset;
1552

    
1553
    /**
1554
     * initial complexity for pass1 ratecontrol
1555
     * - encoding: Set by user.
1556
     * - decoding: unused
1557
     */
1558
    float rc_initial_cplx;
1559

    
1560
    /**
1561
     * DCT algorithm, see FF_DCT_* below
1562
     * - encoding: Set by user.
1563
     * - decoding: unused
1564
     */
1565
    int dct_algo;
1566
#define FF_DCT_AUTO    0
1567
#define FF_DCT_FASTINT 1
1568
#define FF_DCT_INT     2
1569
#define FF_DCT_MMX     3
1570
#define FF_DCT_MLIB    4
1571
#define FF_DCT_ALTIVEC 5
1572
#define FF_DCT_FAAN    6
1573

    
1574
    /**
1575
     * luminance masking (0-> disabled)
1576
     * - encoding: Set by user.
1577
     * - decoding: unused
1578
     */
1579
    float lumi_masking;
1580

    
1581
    /**
1582
     * temporary complexity masking (0-> disabled)
1583
     * - encoding: Set by user.
1584
     * - decoding: unused
1585
     */
1586
    float temporal_cplx_masking;
1587

    
1588
    /**
1589
     * spatial complexity masking (0-> disabled)
1590
     * - encoding: Set by user.
1591
     * - decoding: unused
1592
     */
1593
    float spatial_cplx_masking;
1594

    
1595
    /**
1596
     * p block masking (0-> disabled)
1597
     * - encoding: Set by user.
1598
     * - decoding: unused
1599
     */
1600
    float p_masking;
1601

    
1602
    /**
1603
     * darkness masking (0-> disabled)
1604
     * - encoding: Set by user.
1605
     * - decoding: unused
1606
     */
1607
    float dark_masking;
1608

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

    
1641
    /**
1642
     * slice count
1643
     * - encoding: Set by libavcodec.
1644
     * - decoding: Set by user (or 0).
1645
     */
1646
    int slice_count;
1647
    /**
1648
     * slice offsets in the frame in bytes
1649
     * - encoding: Set/allocated by libavcodec.
1650
     * - decoding: Set/allocated by user (or NULL).
1651
     */
1652
    int *slice_offset;
1653

    
1654
    /**
1655
     * error concealment flags
1656
     * - encoding: unused
1657
     * - decoding: Set by user.
1658
     */
1659
    int error_concealment;
1660
#define FF_EC_GUESS_MVS   1
1661
#define FF_EC_DEBLOCK     2
1662

    
1663
    /**
1664
     * dsp_mask could be add used to disable unwanted CPU features
1665
     * CPU features (i.e. MMX, SSE. ...)
1666
     *
1667
     * With the FORCE flag you may instead enable given CPU features.
1668
     * (Dangerous: Usable in case of misdetection, improper usage however will
1669
     * result into program crash.)
1670
     */
1671
    unsigned dsp_mask;
1672

    
1673
#if FF_API_MM_FLAGS
1674
#define FF_MM_FORCE      AV_CPU_FLAG_FORCE
1675
#define FF_MM_MMX        AV_CPU_FLAG_MMX
1676
#define FF_MM_3DNOW      AV_CPU_FLAG_3DNOW
1677
#define FF_MM_MMXEXT     AV_CPU_FLAG_MMX2
1678
#define FF_MM_MMX2       AV_CPU_FLAG_MMX2
1679
#define FF_MM_SSE        AV_CPU_FLAG_SSE
1680
#define FF_MM_SSE2       AV_CPU_FLAG_SSE2
1681
#define FF_MM_SSE2SLOW   AV_CPU_FLAG_SSE2SLOW
1682
#define FF_MM_3DNOWEXT   AV_CPU_FLAG_3DNOWEXT
1683
#define FF_MM_SSE3       AV_CPU_FLAG_SSE3
1684
#define FF_MM_SSE3SLOW   AV_CPU_FLAG_SSE3SLOW
1685
#define FF_MM_SSSE3      AV_CPU_FLAG_SSSE3
1686
#define FF_MM_SSE4       AV_CPU_FLAG_SSE4
1687
#define FF_MM_SSE42      AV_CPU_FLAG_SSE42
1688
#define FF_MM_IWMMXT     AV_CPU_FLAG_IWMMXT
1689
#define FF_MM_ALTIVEC    AV_CPU_FLAG_ALTIVEC
1690
#endif
1691

    
1692
    /**
1693
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1694
     * - encoding: Set by libavcodec.
1695
     * - decoding: Set by user.
1696
     */
1697
     int bits_per_coded_sample;
1698

    
1699
    /**
1700
     * prediction method (needed for huffyuv)
1701
     * - encoding: Set by user.
1702
     * - decoding: unused
1703
     */
1704
     int prediction_method;
1705
#define FF_PRED_LEFT   0
1706
#define FF_PRED_PLANE  1
1707
#define FF_PRED_MEDIAN 2
1708

    
1709
    /**
1710
     * sample aspect ratio (0 if unknown)
1711
     * That is the width of a pixel divided by the height of the pixel.
1712
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1713
     * - encoding: Set by user.
1714
     * - decoding: Set by libavcodec.
1715
     */
1716
    AVRational sample_aspect_ratio;
1717

    
1718
    /**
1719
     * the picture in the bitstream
1720
     * - encoding: Set by libavcodec.
1721
     * - decoding: Set by libavcodec.
1722
     */
1723
    AVFrame *coded_frame;
1724

    
1725
    /**
1726
     * debug
1727
     * - encoding: Set by user.
1728
     * - decoding: Set by user.
1729
     */
1730
    int debug;
1731
#define FF_DEBUG_PICT_INFO   1
1732
#define FF_DEBUG_RC          2
1733
#define FF_DEBUG_BITSTREAM   4
1734
#define FF_DEBUG_MB_TYPE     8
1735
#define FF_DEBUG_QP          16
1736
#define FF_DEBUG_MV          32
1737
#define FF_DEBUG_DCT_COEFF   0x00000040
1738
#define FF_DEBUG_SKIP        0x00000080
1739
#define FF_DEBUG_STARTCODE   0x00000100
1740
#define FF_DEBUG_PTS         0x00000200
1741
#define FF_DEBUG_ER          0x00000400
1742
#define FF_DEBUG_MMCO        0x00000800
1743
#define FF_DEBUG_BUGS        0x00001000
1744
#define FF_DEBUG_VIS_QP      0x00002000
1745
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1746
#define FF_DEBUG_BUFFERS     0x00008000
1747

    
1748
    /**
1749
     * debug
1750
     * - encoding: Set by user.
1751
     * - decoding: Set by user.
1752
     */
1753
    int debug_mv;
1754
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1755
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1756
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1757

    
1758
    /**
1759
     * error
1760
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1761
     * - decoding: unused
1762
     */
1763
    uint64_t error[4];
1764

    
1765
    /**
1766
     * minimum MB quantizer
1767
     * - encoding: unused
1768
     * - decoding: unused
1769
     */
1770
    int mb_qmin;
1771

    
1772
    /**
1773
     * maximum MB quantizer
1774
     * - encoding: unused
1775
     * - decoding: unused
1776
     */
1777
    int mb_qmax;
1778

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

    
1820
    /**
1821
     * ME diamond size & shape
1822
     * - encoding: Set by user.
1823
     * - decoding: unused
1824
     */
1825
    int dia_size;
1826

    
1827
    /**
1828
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1829
     * - encoding: Set by user.
1830
     * - decoding: unused
1831
     */
1832
    int last_predictor_count;
1833

    
1834
    /**
1835
     * prepass for motion estimation
1836
     * - encoding: Set by user.
1837
     * - decoding: unused
1838
     */
1839
    int pre_me;
1840

    
1841
    /**
1842
     * motion estimation prepass comparison function
1843
     * - encoding: Set by user.
1844
     * - decoding: unused
1845
     */
1846
    int me_pre_cmp;
1847

    
1848
    /**
1849
     * ME prepass diamond size & shape
1850
     * - encoding: Set by user.
1851
     * - decoding: unused
1852
     */
1853
    int pre_dia_size;
1854

    
1855
    /**
1856
     * subpel ME quality
1857
     * - encoding: Set by user.
1858
     * - decoding: unused
1859
     */
1860
    int me_subpel_quality;
1861

    
1862
    /**
1863
     * callback to negotiate the pixelFormat
1864
     * @param fmt is the list of formats which are supported by the codec,
1865
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1866
     * The first is always the native one.
1867
     * @return the chosen format
1868
     * - encoding: unused
1869
     * - decoding: Set by user, if not set the native format will be chosen.
1870
     */
1871
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1872

    
1873
    /**
1874
     * DTG active format information (additional aspect ratio
1875
     * information only used in DVB MPEG-2 transport streams)
1876
     * 0 if not set.
1877
     *
1878
     * - encoding: unused
1879
     * - decoding: Set by decoder.
1880
     */
1881
    int dtg_active_format;
1882
#define FF_DTG_AFD_SAME         8
1883
#define FF_DTG_AFD_4_3          9
1884
#define FF_DTG_AFD_16_9         10
1885
#define FF_DTG_AFD_14_9         11
1886
#define FF_DTG_AFD_4_3_SP_14_9  13
1887
#define FF_DTG_AFD_16_9_SP_14_9 14
1888
#define FF_DTG_AFD_SP_4_3       15
1889

    
1890
    /**
1891
     * maximum motion estimation search range in subpel units
1892
     * If 0 then no limit.
1893
     *
1894
     * - encoding: Set by user.
1895
     * - decoding: unused
1896
     */
1897
    int me_range;
1898

    
1899
    /**
1900
     * intra quantizer bias
1901
     * - encoding: Set by user.
1902
     * - decoding: unused
1903
     */
1904
    int intra_quant_bias;
1905
#define FF_DEFAULT_QUANT_BIAS 999999
1906

    
1907
    /**
1908
     * inter quantizer bias
1909
     * - encoding: Set by user.
1910
     * - decoding: unused
1911
     */
1912
    int inter_quant_bias;
1913

    
1914
    /**
1915
     * color table ID
1916
     * - encoding: unused
1917
     * - decoding: Which clrtable should be used for 8bit RGB images.
1918
     *             Tables have to be stored somewhere. FIXME
1919
     */
1920
    int color_table_id;
1921

    
1922
    /**
1923
     * internal_buffer count
1924
     * Don't touch, used by libavcodec default_get_buffer().
1925
     */
1926
    int internal_buffer_count;
1927

    
1928
    /**
1929
     * internal_buffers
1930
     * Don't touch, used by libavcodec default_get_buffer().
1931
     */
1932
    void *internal_buffer;
1933

    
1934
    /**
1935
     * Global quality for codecs which cannot change it per frame.
1936
     * This should be proportional to MPEG-1/2/4 qscale.
1937
     * - encoding: Set by user.
1938
     * - decoding: unused
1939
     */
1940
    int global_quality;
1941

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

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

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

    
1979
    /**
1980
     * XVideo Motion Acceleration
1981
     * - encoding: forbidden
1982
     * - decoding: set by decoder
1983
     */
1984
    int xvmc_acceleration;
1985

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

    
1996
    /**
1997
     * custom intra quantization matrix
1998
     * - encoding: Set by user, can be NULL.
1999
     * - decoding: Set by libavcodec.
2000
     */
2001
    uint16_t *intra_matrix;
2002

    
2003
    /**
2004
     * custom inter quantization matrix
2005
     * - encoding: Set by user, can be NULL.
2006
     * - decoding: Set by libavcodec.
2007
     */
2008
    uint16_t *inter_matrix;
2009

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

    
2018
    /**
2019
     * scene change detection threshold
2020
     * 0 is default, larger means fewer detected scene changes.
2021
     * - encoding: Set by user.
2022
     * - decoding: unused
2023
     */
2024
    int scenechange_threshold;
2025

    
2026
    /**
2027
     * minimum Lagrange multipler
2028
     * - encoding: Set by user.
2029
     * - decoding: unused
2030
     */
2031
    int lmin;
2032

    
2033
    /**
2034
     * maximum Lagrange multipler
2035
     * - encoding: Set by user.
2036
     * - decoding: unused
2037
     */
2038
    int lmax;
2039

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

    
2049
    /**
2050
     * noise reduction strength
2051
     * - encoding: Set by user.
2052
     * - decoding: unused
2053
     */
2054
    int noise_reduction;
2055

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

    
2070
    /**
2071
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2072
     * - encoding: Set by user.
2073
     * - decoding: unused
2074
     */
2075
    int rc_initial_buffer_occupancy;
2076

    
2077
    /**
2078
     *
2079
     * - encoding: Set by user.
2080
     * - decoding: unused
2081
     */
2082
    int inter_threshold;
2083

    
2084
    /**
2085
     * CODEC_FLAG2_*
2086
     * - encoding: Set by user.
2087
     * - decoding: Set by user.
2088
     */
2089
    int flags2;
2090

    
2091
    /**
2092
     * Simulates errors in the bitstream to test error concealment.
2093
     * - encoding: Set by user.
2094
     * - decoding: unused
2095
     */
2096
    int error_rate;
2097

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

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

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

    
2134
    /**
2135
     * thread opaque
2136
     * Can be used by execute() to store some per AVCodecContext stuff.
2137
     * - encoding: set by execute()
2138
     * - decoding: set by execute()
2139
     */
2140
    void *thread_opaque;
2141

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

    
2151
    /**
2152
     * Macroblock threshold below which the user specified macroblock types will be used.
2153
     * - encoding: Set by user.
2154
     * - decoding: unused
2155
     */
2156
     int mb_threshold;
2157

    
2158
    /**
2159
     * precision of the intra DC coefficient - 8
2160
     * - encoding: Set by user.
2161
     * - decoding: unused
2162
     */
2163
     int intra_dc_precision;
2164

    
2165
    /**
2166
     * noise vs. sse weight for the nsse comparsion function
2167
     * - encoding: Set by user.
2168
     * - decoding: unused
2169
     */
2170
     int nsse_weight;
2171

    
2172
    /**
2173
     * Number of macroblock rows at the top which are skipped.
2174
     * - encoding: unused
2175
     * - decoding: Set by user.
2176
     */
2177
     int skip_top;
2178

    
2179
    /**
2180
     * Number of macroblock rows at the bottom which are skipped.
2181
     * - encoding: unused
2182
     * - decoding: Set by user.
2183
     */
2184
     int skip_bottom;
2185

    
2186
    /**
2187
     * profile
2188
     * - encoding: Set by user.
2189
     * - decoding: Set by libavcodec.
2190
     */
2191
     int profile;
2192
#define FF_PROFILE_UNKNOWN -99
2193

    
2194
#define FF_PROFILE_AAC_MAIN 0
2195
#define FF_PROFILE_AAC_LOW  1
2196
#define FF_PROFILE_AAC_SSR  2
2197
#define FF_PROFILE_AAC_LTP  3
2198

    
2199
#define FF_PROFILE_H264_BASELINE    66
2200
#define FF_PROFILE_H264_MAIN        77
2201
#define FF_PROFILE_H264_EXTENDED    88
2202
#define FF_PROFILE_H264_HIGH        100
2203
#define FF_PROFILE_H264_HIGH_10     110
2204
#define FF_PROFILE_H264_HIGH_422    122
2205
#define FF_PROFILE_H264_HIGH_444    244
2206
#define FF_PROFILE_H264_CAVLC_444   44
2207

    
2208
    /**
2209
     * level
2210
     * - encoding: Set by user.
2211
     * - decoding: Set by libavcodec.
2212
     */
2213
     int level;
2214
#define FF_LEVEL_UNKNOWN -99
2215

    
2216
    /**
2217
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2218
     * - encoding: unused
2219
     * - decoding: Set by user.
2220
     */
2221
     int lowres;
2222

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

    
2231
    /**
2232
     * frame skip threshold
2233
     * - encoding: Set by user.
2234
     * - decoding: unused
2235
     */
2236
    int frame_skip_threshold;
2237

    
2238
    /**
2239
     * frame skip factor
2240
     * - encoding: Set by user.
2241
     * - decoding: unused
2242
     */
2243
    int frame_skip_factor;
2244

    
2245
    /**
2246
     * frame skip exponent
2247
     * - encoding: Set by user.
2248
     * - decoding: unused
2249
     */
2250
    int frame_skip_exp;
2251

    
2252
    /**
2253
     * frame skip comparison function
2254
     * - encoding: Set by user.
2255
     * - decoding: unused
2256
     */
2257
    int frame_skip_cmp;
2258

    
2259
    /**
2260
     * Border processing masking, raises the quantizer for mbs on the borders
2261
     * of the picture.
2262
     * - encoding: Set by user.
2263
     * - decoding: unused
2264
     */
2265
    float border_masking;
2266

    
2267
    /**
2268
     * minimum MB lagrange multipler
2269
     * - encoding: Set by user.
2270
     * - decoding: unused
2271
     */
2272
    int mb_lmin;
2273

    
2274
    /**
2275
     * maximum MB lagrange multipler
2276
     * - encoding: Set by user.
2277
     * - decoding: unused
2278
     */
2279
    int mb_lmax;
2280

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

    
2288
    /**
2289
     *
2290
     * - encoding: unused
2291
     * - decoding: Set by user.
2292
     */
2293
    enum AVDiscard skip_loop_filter;
2294

    
2295
    /**
2296
     *
2297
     * - encoding: unused
2298
     * - decoding: Set by user.
2299
     */
2300
    enum AVDiscard skip_idct;
2301

    
2302
    /**
2303
     *
2304
     * - encoding: unused
2305
     * - decoding: Set by user.
2306
     */
2307
    enum AVDiscard skip_frame;
2308

    
2309
    /**
2310
     *
2311
     * - encoding: Set by user.
2312
     * - decoding: unused
2313
     */
2314
    int bidir_refine;
2315

    
2316
    /**
2317
     *
2318
     * - encoding: Set by user.
2319
     * - decoding: unused
2320
     */
2321
    int brd_scale;
2322

    
2323
    /**
2324
     * constant rate factor - quality-based VBR - values ~correspond to qps
2325
     * - encoding: Set by user.
2326
     * - decoding: unused
2327
     */
2328
    float crf;
2329

    
2330
    /**
2331
     * constant quantization parameter rate control method
2332
     * - encoding: Set by user.
2333
     * - decoding: unused
2334
     */
2335
    int cqp;
2336

    
2337
    /**
2338
     * minimum GOP size
2339
     * - encoding: Set by user.
2340
     * - decoding: unused
2341
     */
2342
    int keyint_min;
2343

    
2344
    /**
2345
     * number of reference frames
2346
     * - encoding: Set by user.
2347
     * - decoding: Set by lavc.
2348
     */
2349
    int refs;
2350

    
2351
    /**
2352
     * chroma qp offset from luma
2353
     * - encoding: Set by user.
2354
     * - decoding: unused
2355
     */
2356
    int chromaoffset;
2357

    
2358
    /**
2359
     * Influences how often B-frames are used.
2360
     * - encoding: Set by user.
2361
     * - decoding: unused
2362
     */
2363
    int bframebias;
2364

    
2365
    /**
2366
     * trellis RD quantization
2367
     * - encoding: Set by user.
2368
     * - decoding: unused
2369
     */
2370
    int trellis;
2371

    
2372
    /**
2373
     * Reduce fluctuations in qp (before curve compression).
2374
     * - encoding: Set by user.
2375
     * - decoding: unused
2376
     */
2377
    float complexityblur;
2378

    
2379
    /**
2380
     * in-loop deblocking filter alphac0 parameter
2381
     * alpha is in the range -6...6
2382
     * - encoding: Set by user.
2383
     * - decoding: unused
2384
     */
2385
    int deblockalpha;
2386

    
2387
    /**
2388
     * in-loop deblocking filter beta parameter
2389
     * beta is in the range -6...6
2390
     * - encoding: Set by user.
2391
     * - decoding: unused
2392
     */
2393
    int deblockbeta;
2394

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

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

    
2414
    /**
2415
     * Audio cutoff bandwidth (0 means "automatic")
2416
     * - encoding: Set by user.
2417
     * - decoding: unused
2418
     */
2419
    int cutoff;
2420

    
2421
    /**
2422
     * Multiplied by qscale for each frame and added to scene_change_score.
2423
     * - encoding: Set by user.
2424
     * - decoding: unused
2425
     */
2426
    int scenechange_factor;
2427

    
2428
    /**
2429
     *
2430
     * Note: Value depends upon the compare function used for fullpel ME.
2431
     * - encoding: Set by user.
2432
     * - decoding: unused
2433
     */
2434
    int mv0_threshold;
2435

    
2436
    /**
2437
     * Adjusts sensitivity of b_frame_strategy 1.
2438
     * - encoding: Set by user.
2439
     * - decoding: unused
2440
     */
2441
    int b_sensitivity;
2442

    
2443
    /**
2444
     * - encoding: Set by user.
2445
     * - decoding: unused
2446
     */
2447
    int compression_level;
2448
#define FF_COMPRESSION_DEFAULT -1
2449

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

    
2460
    /**
2461
     * LPC coefficient precision - used by FLAC encoder
2462
     * - encoding: Set by user.
2463
     * - decoding: unused
2464
     */
2465
    int lpc_coeff_precision;
2466

    
2467
    /**
2468
     * - encoding: Set by user.
2469
     * - decoding: unused
2470
     */
2471
    int min_prediction_order;
2472

    
2473
    /**
2474
     * - encoding: Set by user.
2475
     * - decoding: unused
2476
     */
2477
    int max_prediction_order;
2478

    
2479
    /**
2480
     * search method for selecting prediction order
2481
     * - encoding: Set by user.
2482
     * - decoding: unused
2483
     */
2484
    int prediction_order_method;
2485

    
2486
    /**
2487
     * - encoding: Set by user.
2488
     * - decoding: unused
2489
     */
2490
    int min_partition_order;
2491

    
2492
    /**
2493
     * - encoding: Set by user.
2494
     * - decoding: unused
2495
     */
2496
    int max_partition_order;
2497

    
2498
    /**
2499
     * GOP timecode frame start number, in non drop frame format
2500
     * - encoding: Set by user.
2501
     * - decoding: unused
2502
     */
2503
    int64_t timecode_frame_start;
2504

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

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

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

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

    
2539
    /**
2540
     * Audio channel layout.
2541
     * - encoding: set by user.
2542
     * - decoding: set by libavcodec.
2543
     */
2544
    int64_t channel_layout;
2545

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

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

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

    
2567
    /**
2568
     * Hardware accelerator in use
2569
     * - encoding: unused.
2570
     * - decoding: Set by libavcodec
2571
     */
2572
    struct AVHWAccel *hwaccel;
2573

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

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

    
2595
    /**
2596
     * Chromaticity coordinates of the source primaries.
2597
     * - encoding: Set by user
2598
     * - decoding: Set by libavcodec
2599
     */
2600
    enum AVColorPrimaries color_primaries;
2601

    
2602
    /**
2603
     * Color Transfer Characteristic.
2604
     * - encoding: Set by user
2605
     * - decoding: Set by libavcodec
2606
     */
2607
    enum AVColorTransferCharacteristic color_trc;
2608

    
2609
    /**
2610
     * YUV colorspace type.
2611
     * - encoding: Set by user
2612
     * - decoding: Set by libavcodec
2613
     */
2614
    enum AVColorSpace colorspace;
2615

    
2616
    /**
2617
     * MPEG vs JPEG YUV range.
2618
     * - encoding: Set by user
2619
     * - decoding: Set by libavcodec
2620
     */
2621
    enum AVColorRange color_range;
2622

    
2623
    /**
2624
     * This defines the location of chroma samples.
2625
     * - encoding: Set by user
2626
     * - decoding: Set by libavcodec
2627
     */
2628
    enum AVChromaLocation chroma_sample_location;
2629

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

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

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

    
2670
    /**
2671
     * AQ strength
2672
     * Reduces blocking and blurring in flat and textured areas.
2673
     * - encoding: Set by user
2674
     * - decoding: unused
2675
     */
2676
    float aq_strength;
2677

    
2678
    /**
2679
     * PSY RD
2680
     * Strength of psychovisual optimization
2681
     * - encoding: Set by user
2682
     * - decoding: unused
2683
     */
2684
    float psy_rd;
2685

    
2686
    /**
2687
     * PSY trellis
2688
     * Strength of psychovisual optimization
2689
     * - encoding: Set by user
2690
     * - decoding: unused
2691
     */
2692
    float psy_trellis;
2693

    
2694
    /**
2695
     * RC lookahead
2696
     * Number of frames for frametype and ratecontrol lookahead
2697
     * - encoding: Set by user
2698
     * - decoding: unused
2699
     */
2700
    int rc_lookahead;
2701

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

    
2711
    int log_level_offset;
2712

    
2713
    /**
2714
     * Determines which LPC analysis algorithm to use.
2715
     * - encoding: Set by user
2716
     * - decoding: unused
2717
     */
2718
    enum AVLPCType lpc_type;
2719

    
2720
    /**
2721
     * Number of passes to use for Cholesky factorization during LPC analysis
2722
     * - encoding: Set by user
2723
     * - decoding: unused
2724
     */
2725
    int lpc_passes;
2726
} AVCodecContext;
2727

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

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

    
2782
    /**
2783
     * Type of codec implemented by the hardware accelerator.
2784
     *
2785
     * See AVMEDIA_TYPE_xxx
2786
     */
2787
    enum AVMediaType type;
2788

    
2789
    /**
2790
     * Codec implemented by the hardware accelerator.
2791
     *
2792
     * See CODEC_ID_xxx
2793
     */
2794
    enum CodecID id;
2795

    
2796
    /**
2797
     * Supported pixel format.
2798
     *
2799
     * Only hardware accelerated formats are supported here.
2800
     */
2801
    enum PixelFormat pix_fmt;
2802

    
2803
    /**
2804
     * Hardware accelerated codec capabilities.
2805
     * see FF_HWACCEL_CODEC_CAP_*
2806
     */
2807
    int capabilities;
2808

    
2809
    struct AVHWAccel *next;
2810

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

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

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

    
2851
    /**
2852
     * Size of HW accelerator private data.
2853
     *
2854
     * Private data is allocated with av_mallocz() before
2855
     * AVCodecContext.get_buffer() and deallocated after
2856
     * AVCodecContext.release_buffer().
2857
     */
2858
    int priv_data_size;
2859
} AVHWAccel;
2860

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

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

    
2883
    /* Demuxer sets this to 1 to indicate the palette has changed;
2884
     * decoder resets to 0. */
2885
    int palette_changed;
2886

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

    
2893
} AVPaletteControl attribute_deprecated;
2894
#endif
2895

    
2896
enum AVSubtitleType {
2897
    SUBTITLE_NONE,
2898

    
2899
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2900

    
2901
    /**
2902
     * Plain text, the text field must be set by the decoder and is
2903
     * authoritative. ass and pict fields may contain approximations.
2904
     */
2905
    SUBTITLE_TEXT,
2906

    
2907
    /**
2908
     * Formatted text, the ass field must be set by the decoder and is
2909
     * authoritative. pict and text fields may contain approximations.
2910
     */
2911
    SUBTITLE_ASS,
2912
};
2913

    
2914
typedef struct AVSubtitleRect {
2915
    int x;         ///< top left corner  of pict, undefined when pict is not set
2916
    int y;         ///< top left corner  of pict, undefined when pict is not set
2917
    int w;         ///< width            of pict, undefined when pict is not set
2918
    int h;         ///< height           of pict, undefined when pict is not set
2919
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
2920

    
2921
    /**
2922
     * data+linesize for the bitmap of this subtitle.
2923
     * can be set for text/ass as well once they where rendered
2924
     */
2925
    AVPicture pict;
2926
    enum AVSubtitleType type;
2927

    
2928
    char *text;                     ///< 0 terminated plain UTF-8 text
2929

    
2930
    /**
2931
     * 0 terminated ASS/SSA compatible event line.
2932
     * The pressentation of this is unaffected by the other values in this
2933
     * struct.
2934
     */
2935
    char *ass;
2936
} AVSubtitleRect;
2937

    
2938
typedef struct AVSubtitle {
2939
    uint16_t format; /* 0 = graphics */
2940
    uint32_t start_display_time; /* relative to packet pts, in ms */
2941
    uint32_t end_display_time; /* relative to packet pts, in ms */
2942
    unsigned num_rects;
2943
    AVSubtitleRect **rects;
2944
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
2945
} AVSubtitle;
2946

    
2947
/* packet functions */
2948

    
2949
/**
2950
 * @deprecated use NULL instead
2951
 */
2952
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2953

    
2954
/**
2955
 * Default packet destructor.
2956
 */
2957
void av_destruct_packet(AVPacket *pkt);
2958

    
2959
/**
2960
 * Initialize optional fields of a packet with default values.
2961
 *
2962
 * @param pkt packet
2963
 */
2964
void av_init_packet(AVPacket *pkt);
2965

    
2966
/**
2967
 * Allocate the payload of a packet and initialize its fields with
2968
 * default values.
2969
 *
2970
 * @param pkt packet
2971
 * @param size wanted payload size
2972
 * @return 0 if OK, AVERROR_xxx otherwise
2973
 */
2974
int av_new_packet(AVPacket *pkt, int size);
2975

    
2976
/**
2977
 * Reduce packet size, correctly zeroing padding
2978
 *
2979
 * @param pkt packet
2980
 * @param size new size
2981
 */
2982
void av_shrink_packet(AVPacket *pkt, int size);
2983

    
2984
/**
2985
 * @warning This is a hack - the packet memory allocation stuff is broken. The
2986
 * packet is allocated if it was not really allocated.
2987
 */
2988
int av_dup_packet(AVPacket *pkt);
2989

    
2990
/**
2991
 * Free a packet.
2992
 *
2993
 * @param pkt packet to free
2994
 */
2995
void av_free_packet(AVPacket *pkt);
2996

    
2997
/* resample.c */
2998

    
2999
struct ReSampleContext;
3000
struct AVResampleContext;
3001

    
3002
typedef struct ReSampleContext ReSampleContext;
3003

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

    
3034
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3035
void audio_resample_close(ReSampleContext *s);
3036

    
3037

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

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

    
3060

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

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

    
3087
/**
3088
 * Free a picture previously allocated by avpicture_alloc().
3089
 *
3090
 * @param picture the AVPicture to be freed
3091
 */
3092
void avpicture_free(AVPicture *picture);
3093

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

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

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

    
3150
/**
3151
 * Return a value representing the fourCC code associated to the
3152
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3153
 * found.
3154
 */
3155
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3156

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

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

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

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

    
3218

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

    
3231
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3232
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3233

    
3234
/**
3235
 * Tell if an image really has transparent alpha values.
3236
 * @return ored mask of FF_ALPHA_xxx constants
3237
 */
3238
int img_get_alpha_info(const AVPicture *src,
3239
                       enum PixelFormat pix_fmt, int width, int height);
3240

    
3241
/* deinterlace a picture */
3242
/* deinterlace - if not supported return -1 */
3243
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3244
                          enum PixelFormat pix_fmt, int width, int height);
3245

    
3246
/* external high level API */
3247

    
3248
/**
3249
 * If c is NULL, returns the first registered codec,
3250
 * if c is non-NULL, returns the next registered codec after c,
3251
 * or NULL if c is the last one.
3252
 */
3253
AVCodec *av_codec_next(AVCodec *c);
3254

    
3255
/**
3256
 * Return the LIBAVCODEC_VERSION_INT constant.
3257
 */
3258
unsigned avcodec_version(void);
3259

    
3260
/**
3261
 * Return the libavcodec build-time configuration.
3262
 */
3263
const char *avcodec_configuration(void);
3264

    
3265
/**
3266
 * Return the libavcodec license.
3267
 */
3268
const char *avcodec_license(void);
3269

    
3270
/**
3271
 * Initialize libavcodec.
3272
 *
3273
 * @warning This function must be called before any other libavcodec
3274
 * function.
3275
 */
3276
void avcodec_init(void);
3277

    
3278
#if LIBAVCODEC_VERSION_MAJOR < 53
3279
/**
3280
 * @deprecated Deprecated in favor of avcodec_register().
3281
 */
3282
attribute_deprecated void register_avcodec(AVCodec *codec);
3283
#endif
3284

    
3285
/**
3286
 * Register the codec codec and initialize libavcodec.
3287
 *
3288
 * @see avcodec_init()
3289
 */
3290
void avcodec_register(AVCodec *codec);
3291

    
3292
/**
3293
 * Find a registered encoder with a matching codec ID.
3294
 *
3295
 * @param id CodecID of the requested encoder
3296
 * @return An encoder if one was found, NULL otherwise.
3297
 */
3298
AVCodec *avcodec_find_encoder(enum CodecID id);
3299

    
3300
/**
3301
 * Find a registered encoder with the specified name.
3302
 *
3303
 * @param name name of the requested encoder
3304
 * @return An encoder if one was found, NULL otherwise.
3305
 */
3306
AVCodec *avcodec_find_encoder_by_name(const char *name);
3307

    
3308
/**
3309
 * Find a registered decoder with a matching codec ID.
3310
 *
3311
 * @param id CodecID of the requested decoder
3312
 * @return A decoder if one was found, NULL otherwise.
3313
 */
3314
AVCodec *avcodec_find_decoder(enum CodecID id);
3315

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

    
3325
/**
3326
 * Set the fields of the given AVCodecContext to default values.
3327
 *
3328
 * @param s The AVCodecContext of which the fields should be set to default values.
3329
 */
3330
void avcodec_get_context_defaults(AVCodecContext *s);
3331

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

    
3336
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3337
 *  we WILL change its arguments and name a few times! */
3338
int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3339

    
3340
/**
3341
 * Allocate an AVCodecContext and set its fields to default values.  The
3342
 * resulting struct can be deallocated by simply calling av_free().
3343
 *
3344
 * @return An AVCodecContext filled with default values or NULL on failure.
3345
 * @see avcodec_get_context_defaults
3346
 */
3347
AVCodecContext *avcodec_alloc_context(void);
3348

    
3349
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3350
 *  we WILL change its arguments and name a few times! */
3351
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3352

    
3353
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3354
 *  we WILL change its arguments and name a few times! */
3355
AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3356

    
3357
/**
3358
 * Copy the settings of the source AVCodecContext into the destination
3359
 * AVCodecContext. The resulting destination codec context will be
3360
 * unopened, i.e. you are required to call avcodec_open() before you
3361
 * can use this AVCodecContext to decode/encode video/audio data.
3362
 *
3363
 * @param dest target codec context, should be initialized with
3364
 *             avcodec_alloc_context(), but otherwise uninitialized
3365
 * @param src source codec context
3366
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3367
 */
3368
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3369

    
3370
/**
3371
 * Set the fields of the given AVFrame to default values.
3372
 *
3373
 * @param pic The AVFrame of which the fields should be set to default values.
3374
 */
3375
void avcodec_get_frame_defaults(AVFrame *pic);
3376

    
3377
/**
3378
 * Allocate an AVFrame and set its fields to default values.  The resulting
3379
 * struct can be deallocated by simply calling av_free().
3380
 *
3381
 * @return An AVFrame filled with default values or NULL on failure.
3382
 * @see avcodec_get_frame_defaults
3383
 */
3384
AVFrame *avcodec_alloc_frame(void);
3385

    
3386
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3387
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3388
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3389

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

    
3420
#if LIBAVCODEC_VERSION_MAJOR < 53
3421
/**
3422
 * @deprecated Deprecated in favor of av_check_image_size().
3423
 */
3424
attribute_deprecated
3425
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3426
#endif
3427

    
3428
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3429

    
3430
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3431
void avcodec_thread_free(AVCodecContext *s);
3432
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3433
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3434
//FIXME func typedef
3435

    
3436
/**
3437
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3438
 * function the context has to be allocated.
3439
 *
3440
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3441
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3442
 * retrieving a codec.
3443
 *
3444
 * @warning This function is not thread safe!
3445
 *
3446
 * @code
3447
 * avcodec_register_all();
3448
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3449
 * if (!codec)
3450
 *     exit(1);
3451
 *
3452
 * context = avcodec_alloc_context();
3453
 *
3454
 * if (avcodec_open(context, codec) < 0)
3455
 *     exit(1);
3456
 * @endcode
3457
 *
3458
 * @param avctx The context which will be set up to use the given codec.
3459
 * @param codec The codec to use within the context.
3460
 * @return zero on success, a negative value on error
3461
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3462
 */
3463
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3464

    
3465
#if FF_API_AUDIO_OLD
3466
/**
3467
 * Decode an audio frame from buf into samples.
3468
 * Wrapper function which calls avcodec_decode_audio3.
3469
 *
3470
 * @deprecated Use avcodec_decode_audio3 instead.
3471
 * @param avctx the codec context
3472
 * @param[out] samples the output buffer
3473
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3474
 * @param[in] buf the input buffer
3475
 * @param[in] buf_size the input buffer size in bytes
3476
 * @return On error a negative value is returned, otherwise the number of bytes
3477
 * used or zero if no frame could be decompressed.
3478
 */
3479
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3480
                         int *frame_size_ptr,
3481
                         const uint8_t *buf, int buf_size);
3482
#endif
3483

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

    
3527
#if LIBAVCODEC_VERSION_MAJOR < 53
3528
/**
3529
 * Decode a video frame from buf into picture.
3530
 * Wrapper function which calls avcodec_decode_video2.
3531
 *
3532
 * @deprecated Use avcodec_decode_video2 instead.
3533
 * @param avctx the codec context
3534
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3535
 * @param[in] buf the input buffer
3536
 * @param[in] buf_size the size of the input buffer in bytes
3537
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3538
 * @return On error a negative value is returned, otherwise the number of bytes
3539
 * used or zero if no frame could be decompressed.
3540
 */
3541
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3542
                         int *got_picture_ptr,
3543
                         const uint8_t *buf, int buf_size);
3544
#endif
3545

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

    
3590
#if LIBAVCODEC_VERSION_MAJOR < 53
3591
/* Decode a subtitle message. Return -1 if error, otherwise return the
3592
 * number of bytes used. If no subtitle could be decompressed,
3593
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3594
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3595
                            int *got_sub_ptr,
3596
                            const uint8_t *buf, int buf_size);
3597
#endif
3598

    
3599
/**
3600
 * Decode a subtitle message.
3601
 * Return a negative value on error, otherwise return the number of bytes used.
3602
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3603
 * Otherwise, the subtitle is stored in *sub.
3604
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3605
 * simplicity, because the performance difference is expect to be negligible
3606
 * and reusing a get_buffer written for video codecs would probably perform badly
3607
 * due to a potentially very different allocation pattern.
3608
 *
3609
 * @param avctx the codec context
3610
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3611
                   freed with avsubtitle_free if *got_sub_ptr is set.
3612
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3613
 * @param[in] avpkt The input AVPacket containing the input buffer.
3614
 */
3615
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3616
                            int *got_sub_ptr,
3617
                            AVPacket *avpkt);
3618

    
3619
/**
3620
 * Frees all allocated data in the given subtitle struct.
3621
 *
3622
 * @param sub AVSubtitle to free.
3623
 */
3624
void avsubtitle_free(AVSubtitle *sub);
3625

    
3626
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3627
                        int *data_size_ptr,
3628
                        uint8_t *buf, int buf_size);
3629

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

    
3652
/**
3653
 * Encode a video frame from pict into buf.
3654
 * The input picture should be
3655
 * stored using a specific format, namely avctx.pix_fmt.
3656
 *
3657
 * @param avctx the codec context
3658
 * @param[out] buf the output buffer for the bitstream of encoded frame
3659
 * @param[in] buf_size the size of the output buffer in bytes
3660
 * @param[in] pict the input picture to encode
3661
 * @return On error a negative value is returned, on success zero or the number
3662
 * of bytes used from the output buffer.
3663
 */
3664
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3665
                         const AVFrame *pict);
3666
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3667
                            const AVSubtitle *sub);
3668

    
3669
int avcodec_close(AVCodecContext *avctx);
3670

    
3671
/**
3672
 * Register all the codecs, parsers and bitstream filters which were enabled at
3673
 * configuration time. If you do not call this function you can select exactly
3674
 * which formats you want to support, by using the individual registration
3675
 * functions.
3676
 *
3677
 * @see avcodec_register
3678
 * @see av_register_codec_parser
3679
 * @see av_register_bitstream_filter
3680
 */
3681
void avcodec_register_all(void);
3682

    
3683
/**
3684
 * Flush buffers, should be called when seeking or when switching to a different stream.
3685
 */
3686
void avcodec_flush_buffers(AVCodecContext *avctx);
3687

    
3688
void avcodec_default_free_buffers(AVCodecContext *s);
3689

    
3690
/* misc useful functions */
3691

    
3692
/**
3693
 * Return a single letter to describe the given picture type pict_type.
3694
 *
3695
 * @param[in] pict_type the picture type
3696
 * @return A single character representing the picture type.
3697
 */
3698
char av_get_pict_type_char(int pict_type);
3699

    
3700
/**
3701
 * Return codec bits per sample.
3702
 *
3703
 * @param[in] codec_id the codec
3704
 * @return Number of bits per sample or zero if unknown for the given codec.
3705
 */
3706
int av_get_bits_per_sample(enum CodecID codec_id);
3707

    
3708
/**
3709
 * Return sample format bits per sample.
3710
 *
3711
 * @param[in] sample_fmt the sample format
3712
 * @return Number of bits per sample or zero if unknown for the given sample format.
3713
 */
3714
int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3715

    
3716
/* frame parsing */
3717
typedef struct AVCodecParserContext {
3718
    void *priv_data;
3719
    struct AVCodecParser *parser;
3720
    int64_t frame_offset; /* offset of the current frame */
3721
    int64_t cur_offset; /* current offset
3722
                           (incremented by each av_parser_parse()) */
3723
    int64_t next_frame_offset; /* offset of the next frame */
3724
    /* video info */
3725
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3726
    /**
3727
     * This field is used for proper frame duration computation in lavf.
3728
     * It signals, how much longer the frame duration of the current frame
3729
     * is compared to normal frame duration.
3730
     *
3731
     * frame_duration = (1 + repeat_pict) * time_base
3732
     *
3733
     * It is used by codecs like H.264 to display telecined material.
3734
     */
3735
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3736
    int64_t pts;     /* pts of the current frame */
3737
    int64_t dts;     /* dts of the current frame */
3738

    
3739
    /* private data */
3740
    int64_t last_pts;
3741
    int64_t last_dts;
3742
    int fetch_timestamp;
3743

    
3744
#define AV_PARSER_PTS_NB 4
3745
    int cur_frame_start_index;
3746
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3747
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3748
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3749

    
3750
    int flags;
3751
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3752
#define PARSER_FLAG_ONCE                      0x0002
3753
/// Set if the parser has a valid file offset
3754
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
3755

    
3756
    int64_t offset;      ///< byte offset from starting packet start
3757
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3758

    
3759
    /*!
3760
     * Set by parser to 1 for key frames and 0 for non-key frames.
3761
     * It is initialized to -1, so if the parser doesn't set this flag,
3762
     * old-style fallback using FF_I_TYPE picture type as key frames
3763
     * will be used.
3764
     */
3765
    int key_frame;
3766

    
3767
    /**
3768
     * Time difference in stream time base units from the pts of this
3769
     * packet to the point at which the output from the decoder has converged
3770
     * independent from the availability of previous frames. That is, the
3771
     * frames are virtually identical no matter if decoding started from
3772
     * the very first frame or from this keyframe.
3773
     * Is AV_NOPTS_VALUE if unknown.
3774
     * This field is not the display duration of the current frame.
3775
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3776
     * set.
3777
     *
3778
     * The purpose of this field is to allow seeking in streams that have no
3779
     * keyframes in the conventional sense. It corresponds to the
3780
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3781
     * essential for some types of subtitle streams to ensure that all
3782
     * subtitles are correctly displayed after seeking.
3783
     */
3784
    int64_t convergence_duration;
3785

    
3786
    // Timestamp generation support:
3787
    /**
3788
     * Synchronization point for start of timestamp generation.
3789
     *
3790
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3791
     * (default).
3792
     *
3793
     * For example, this corresponds to presence of H.264 buffering period
3794
     * SEI message.
3795
     */
3796
    int dts_sync_point;
3797

    
3798
    /**
3799
     * Offset of the current timestamp against last timestamp sync point in
3800
     * units of AVCodecContext.time_base.
3801
     *
3802
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3803
     * contain a valid timestamp offset.
3804
     *
3805
     * Note that the timestamp of sync point has usually a nonzero
3806
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3807
     * the next frame after timestamp sync point will be usually 1.
3808
     *
3809
     * For example, this corresponds to H.264 cpb_removal_delay.
3810
     */
3811
    int dts_ref_dts_delta;
3812

    
3813
    /**
3814
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3815
     *
3816
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3817
     * contain valid non-negative timestamp delta (presentation time of a frame
3818
     * must not lie in the past).
3819
     *
3820
     * This delay represents the difference between decoding and presentation
3821
     * time of the frame.
3822
     *
3823
     * For example, this corresponds to H.264 dpb_output_delay.
3824
     */
3825
    int pts_dts_delta;
3826

    
3827
    /**
3828
     * Position of the packet in file.
3829
     *
3830
     * Analogous to cur_frame_pts/dts
3831
     */
3832
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3833

    
3834
    /**
3835
     * Byte position of currently parsed frame in stream.
3836
     */
3837
    int64_t pos;
3838

    
3839
    /**
3840
     * Previous frame byte position.
3841
     */
3842
    int64_t last_pos;
3843
} AVCodecParserContext;
3844

    
3845
typedef struct AVCodecParser {
3846
    int codec_ids[5]; /* several codec IDs are permitted */
3847
    int priv_data_size;
3848
    int (*parser_init)(AVCodecParserContext *s);
3849
    int (*parser_parse)(AVCodecParserContext *s,
3850
                        AVCodecContext *avctx,
3851
                        const uint8_t **poutbuf, int *poutbuf_size,
3852
                        const uint8_t *buf, int buf_size);
3853
    void (*parser_close)(AVCodecParserContext *s);
3854
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3855
    struct AVCodecParser *next;
3856
} AVCodecParser;
3857

    
3858
AVCodecParser *av_parser_next(AVCodecParser *c);
3859

    
3860
void av_register_codec_parser(AVCodecParser *parser);
3861
AVCodecParserContext *av_parser_init(int codec_id);
3862

    
3863
#if LIBAVCODEC_VERSION_MAJOR < 53
3864
attribute_deprecated
3865
int av_parser_parse(AVCodecParserContext *s,
3866
                    AVCodecContext *avctx,
3867
                    uint8_t **poutbuf, int *poutbuf_size,
3868
                    const uint8_t *buf, int buf_size,
3869
                    int64_t pts, int64_t dts);
3870
#endif
3871

    
3872
/**
3873
 * Parse a packet.
3874
 *
3875
 * @param s             parser context.
3876
 * @param avctx         codec context.
3877
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3878
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3879
 * @param buf           input buffer.
3880
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3881
 * @param pts           input presentation timestamp.
3882
 * @param dts           input decoding timestamp.
3883
 * @param pos           input byte position in stream.
3884
 * @return the number of bytes of the input bitstream used.
3885
 *
3886
 * Example:
3887
 * @code
3888
 *   while(in_len){
3889
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3890
 *                                        in_data, in_len,
3891
 *                                        pts, dts, pos);
3892
 *       in_data += len;
3893
 *       in_len  -= len;
3894
 *
3895
 *       if(size)
3896
 *          decode_frame(data, size);
3897
 *   }
3898
 * @endcode
3899
 */
3900
int av_parser_parse2(AVCodecParserContext *s,
3901
                     AVCodecContext *avctx,
3902
                     uint8_t **poutbuf, int *poutbuf_size,
3903
                     const uint8_t *buf, int buf_size,
3904
                     int64_t pts, int64_t dts,
3905
                     int64_t pos);
3906

    
3907
int av_parser_change(AVCodecParserContext *s,
3908
                     AVCodecContext *avctx,
3909
                     uint8_t **poutbuf, int *poutbuf_size,
3910
                     const uint8_t *buf, int buf_size, int keyframe);
3911
void av_parser_close(AVCodecParserContext *s);
3912

    
3913

    
3914
typedef struct AVBitStreamFilterContext {
3915
    void *priv_data;
3916
    struct AVBitStreamFilter *filter;
3917
    AVCodecParserContext *parser;
3918
    struct AVBitStreamFilterContext *next;
3919
} AVBitStreamFilterContext;
3920

    
3921

    
3922
typedef struct AVBitStreamFilter {
3923
    const char *name;
3924
    int priv_data_size;
3925
    int (*filter)(AVBitStreamFilterContext *bsfc,
3926
                  AVCodecContext *avctx, const char *args,
3927
                  uint8_t **poutbuf, int *poutbuf_size,
3928
                  const uint8_t *buf, int buf_size, int keyframe);
3929
    void (*close)(AVBitStreamFilterContext *bsfc);
3930
    struct AVBitStreamFilter *next;
3931
} AVBitStreamFilter;
3932

    
3933
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3934
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3935
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3936
                               AVCodecContext *avctx, const char *args,
3937
                               uint8_t **poutbuf, int *poutbuf_size,
3938
                               const uint8_t *buf, int buf_size, int keyframe);
3939
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3940

    
3941
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3942

    
3943
/* memory */
3944

    
3945
/**
3946
 * Reallocate the given block if it is not large enough, otherwise do nothing.
3947
 *
3948
 * @see av_realloc
3949
 */
3950
void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3951

    
3952
/**
3953
 * Allocate a buffer, reusing the given one if large enough.
3954
 *
3955
 * Contrary to av_fast_realloc the current buffer contents might not be
3956
 * preserved and on error the old buffer is freed, thus no special
3957
 * handling to avoid memleaks is necessary.
3958
 *
3959
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3960
 * @param size size of the buffer *ptr points to
3961
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3962
 *                 *size 0 if an error occurred.
3963
 */
3964
void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3965

    
3966
#if LIBAVCODEC_VERSION_MAJOR < 53
3967
/**
3968
 * @deprecated Deprecated in favor of av_image_copy().
3969
 */
3970
attribute_deprecated
3971
void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
3972
                          uint8_t *src_data[4], int src_linesize[4],
3973
                          enum PixelFormat pix_fmt, int width, int height);
3974
#endif
3975

    
3976
/**
3977
 * Copy image src to dst. Wraps av_picture_data_copy() above.
3978
 */
3979
void av_picture_copy(AVPicture *dst, const AVPicture *src,
3980
                     enum PixelFormat pix_fmt, int width, int height);
3981

    
3982
/**
3983
 * Crop image top and left side.
3984
 */
3985
int av_picture_crop(AVPicture *dst, const AVPicture *src,
3986
                    enum PixelFormat pix_fmt, int top_band, int left_band);
3987

    
3988
/**
3989
 * Pad image.
3990
 */
3991
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3992
            int padtop, int padbottom, int padleft, int padright, int *color);
3993

    
3994
/**
3995
 * Encode extradata length to a buffer. Used by xiph codecs.
3996
 *
3997
 * @param s buffer to write to; must be at least (v/255+1) bytes long
3998
 * @param v size of extradata in bytes
3999
 * @return number of bytes written to the buffer.
4000
 */
4001
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4002

    
4003
#if LIBAVCODEC_VERSION_MAJOR < 53
4004
/**
4005
 * Parse str and put in width_ptr and height_ptr the detected values.
4006
 *
4007
 * @deprecated Deprecated in favor of av_parse_video_size().
4008
 */
4009
attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4010

    
4011
/**
4012
 * Parse str and store the detected values in *frame_rate.
4013
 *
4014
 * @deprecated Deprecated in favor of av_parse_video_rate().
4015
 */
4016
attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4017
#endif
4018

    
4019
/**
4020
 * Logs a generic warning message about a missing feature. This function is
4021
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4022
 * only, and would normally not be used by applications.
4023
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4024
 * a pointer to an AVClass struct
4025
 * @param[in] feature string containing the name of the missing feature
4026
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4027
 * If want_sample is non-zero, additional verbage will be added to the log
4028
 * message which tells the user how to report samples to the development
4029
 * mailing list.
4030
 */
4031
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4032

    
4033
/**
4034
 * Log a generic warning message asking for a sample. This function is
4035
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4036
 * only, and would normally not be used by applications.
4037
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4038
 * a pointer to an AVClass struct
4039
 * @param[in] msg string containing an optional message, or NULL if no message
4040
 */
4041
void av_log_ask_for_sample(void *avc, const char *msg);
4042

    
4043
/**
4044
 * Register the hardware accelerator hwaccel.
4045
 */
4046
void av_register_hwaccel(AVHWAccel *hwaccel);
4047

    
4048
/**
4049
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4050
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4051
 * after hwaccel, or NULL if hwaccel is the last one.
4052
 */
4053
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4054

    
4055

    
4056
/**
4057
 * Lock operation used by lockmgr
4058
 */
4059
enum AVLockOp {
4060
  AV_LOCK_CREATE,  ///< Create a mutex
4061
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4062
  AV_LOCK_RELEASE, ///< Unlock the mutex
4063
  AV_LOCK_DESTROY, ///< Free mutex resources
4064
};
4065

    
4066
/**
4067
 * Register a user provided lock manager supporting the operations
4068
 * specified by AVLockOp. mutex points to a (void *) where the
4069
 * lockmgr should store/get a pointer to a user allocated mutex. It's
4070
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4071
 *
4072
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4073
 *           callback during the call to av_lockmgr_register().
4074
 *           Thus, the application must be prepared to handle that.
4075
 *           If cb is set to NULL the lockmgr will be unregistered.
4076
 *           Also note that during unregistration the previously registered
4077
 *           lockmgr callback may also be invoked.
4078
 */
4079
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4080

    
4081
#endif /* AVCODEC_AVCODEC_H */