Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 1ba57272

History | View | Annotate | Download (135 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/samplefmt.h"
31
#include "libavutil/avutil.h"
32
#include "libavutil/cpu.h"
33

    
34
#include "libavcodec/version.h"
35

    
36
/**
37
 * Identify the syntax and semantics of the bitstream.
38
 * The principle is roughly:
39
 * Two decoders with the same ID can decode the same streams.
40
 * Two encoders with the same ID can encode compatible streams.
41
 * There may be slight deviations from the principle due to implementation
42
 * details.
43
 *
44
 * If you add a codec ID to this list, add it so that
45
 * 1. no value of a existing codec ID changes (that would break ABI),
46
 * 2. it is as close as possible to similar codecs.
47
 */
48
enum CodecID {
49
    CODEC_ID_NONE,
50

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

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

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

    
267
    /* AMR */
268
    CODEC_ID_AMR_NB= 0x12000,
269
    CODEC_ID_AMR_WB,
270

    
271
    /* RealAudio codecs*/
272
    CODEC_ID_RA_144= 0x13000,
273
    CODEC_ID_RA_288,
274

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

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

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

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

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

    
355
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
356
                                * stream (only used by libavformat) */
357
    CODEC_ID_FFMETADATA=0x21000,   ///< Dummy codec for streams containing only metadata information.
358
};
359

    
360
#if FF_API_OLD_SAMPLE_FMT
361
#define SampleFormat AVSampleFormat
362

    
363
#define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
364
#define SAMPLE_FMT_U8   AV_SAMPLE_FMT_U8
365
#define SAMPLE_FMT_S16  AV_SAMPLE_FMT_S16
366
#define SAMPLE_FMT_S32  AV_SAMPLE_FMT_S32
367
#define SAMPLE_FMT_FLT  AV_SAMPLE_FMT_FLT
368
#define SAMPLE_FMT_DBL  AV_SAMPLE_FMT_DBL
369
#define SAMPLE_FMT_NB   AV_SAMPLE_FMT_NB
370
#endif
371

    
372
#if FF_API_OLD_AUDIOCONVERT
373
#include "libavutil/audioconvert.h"
374

    
375
/* Audio channel masks */
376
#define CH_FRONT_LEFT            AV_CH_FRONT_LEFT
377
#define CH_FRONT_RIGHT           AV_CH_FRONT_RIGHT
378
#define CH_FRONT_CENTER          AV_CH_FRONT_CENTER
379
#define CH_LOW_FREQUENCY         AV_CH_LOW_FREQUENCY
380
#define CH_BACK_LEFT             AV_CH_BACK_LEFT
381
#define CH_BACK_RIGHT            AV_CH_BACK_RIGHT
382
#define CH_FRONT_LEFT_OF_CENTER  AV_CH_FRONT_LEFT_OF_CENTER
383
#define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
384
#define CH_BACK_CENTER           AV_CH_BACK_CENTER
385
#define CH_SIDE_LEFT             AV_CH_SIDE_LEFT
386
#define CH_SIDE_RIGHT            AV_CH_SIDE_RIGHT
387
#define CH_TOP_CENTER            AV_CH_TOP_CENTER
388
#define CH_TOP_FRONT_LEFT        AV_CH_TOP_FRONT_LEFT
389
#define CH_TOP_FRONT_CENTER      AV_CH_TOP_FRONT_CENTER
390
#define CH_TOP_FRONT_RIGHT       AV_CH_TOP_FRONT_RIGHT
391
#define CH_TOP_BACK_LEFT         AV_CH_TOP_BACK_LEFT
392
#define CH_TOP_BACK_CENTER       AV_CH_TOP_BACK_CENTER
393
#define CH_TOP_BACK_RIGHT        AV_CH_TOP_BACK_RIGHT
394
#define CH_STEREO_LEFT           AV_CH_STEREO_LEFT
395
#define CH_STEREO_RIGHT          AV_CH_STEREO_RIGHT
396

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

    
402
/* Audio channel convenience macros */
403
#define CH_LAYOUT_MONO           AV_CH_LAYOUT_MONO
404
#define CH_LAYOUT_STEREO         AV_CH_LAYOUT_STEREO
405
#define CH_LAYOUT_2_1            AV_CH_LAYOUT_2_1
406
#define CH_LAYOUT_SURROUND       AV_CH_LAYOUT_SURROUND
407
#define CH_LAYOUT_4POINT0        AV_CH_LAYOUT_4POINT0
408
#define CH_LAYOUT_2_2            AV_CH_LAYOUT_2_2
409
#define CH_LAYOUT_QUAD           AV_CH_LAYOUT_QUAD
410
#define CH_LAYOUT_5POINT0        AV_CH_LAYOUT_5POINT0
411
#define CH_LAYOUT_5POINT1        AV_CH_LAYOUT_5POINT1
412
#define CH_LAYOUT_5POINT0_BACK   AV_CH_LAYOUT_5POINT0_BACK
413
#define CH_LAYOUT_5POINT1_BACK   AV_CH_LAYOUT_5POINT1_BACK
414
#define CH_LAYOUT_7POINT0        AV_CH_LAYOUT_7POINT0
415
#define CH_LAYOUT_7POINT1        AV_CH_LAYOUT_7POINT1
416
#define CH_LAYOUT_7POINT1_WIDE   AV_CH_LAYOUT_7POINT1_WIDE
417
#define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
418
#endif
419

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

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

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

    
438

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

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

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

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

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

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

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

    
519
/**
520
 * LPC analysis type
521
 */
522
enum AVLPCType {
523
    AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
524
    AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
525
    AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
526
    AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
527
    AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
528
    AV_LPC_TYPE_NB              , ///< Not part of ABI
529
};
530

    
531
enum AVAudioServiceType {
532
    AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
533
    AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
534
    AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
535
    AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
536
    AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
537
    AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
538
    AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
539
    AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
540
    AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
541
    AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
542
};
543

    
544
typedef struct RcOverride{
545
    int start_frame;
546
    int end_frame;
547
    int qscale; // If this is 0 then quality_factor will be used instead.
548
    float quality_factor;
549
} RcOverride;
550

    
551
#define FF_MAX_B_FRAMES 16
552

    
553
/* encoding support
554
   These flags can be passed in AVCodecContext.flags before initialization.
555
   Note: Not everything is supported yet.
556
*/
557

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

    
619
/* Unsupported options :
620
 *              Syntax Arithmetic coding (SAC)
621
 *              Reference Picture Selection
622
 *              Independent Segment Decoding */
623
/* /Fx */
624
/* codec capabilities */
625

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

    
674
/**
675
 * Codec is able to deal with negative linesizes
676
 */
677
#define CODEC_CAP_NEG_LINESIZES    0x0800
678

    
679
/**
680
 * Codec supports frame-level multithreading.
681
 */
682
#define CODEC_CAP_FRAME_THREADS    0x1000
683
/**
684
 * Codec supports slice-based (or partition-based) multithreading.
685
 */
686
#define CODEC_CAP_SLICE_THREADS    0x2000
687

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

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

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

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

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

    
1015

    
1016
#define FF_QSCALE_TYPE_MPEG1 0
1017
#define FF_QSCALE_TYPE_MPEG2 1
1018
#define FF_QSCALE_TYPE_H264  2
1019
#define FF_QSCALE_TYPE_VP56  3
1020

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

    
1026
#if FF_API_OLD_FF_PICT_TYPES
1027
/* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
1028
#define FF_I_TYPE  AV_PICTURE_TYPE_I  ///< Intra
1029
#define FF_P_TYPE  AV_PICTURE_TYPE_P  ///< Predicted
1030
#define FF_B_TYPE  AV_PICTURE_TYPE_B  ///< Bi-dir predicted
1031
#define FF_S_TYPE  AV_PICTURE_TYPE_S  ///< S(GMC)-VOP MPEG4
1032
#define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
1033
#define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
1034
#define FF_BI_TYPE AV_PICTURE_TYPE_BI
1035
#endif
1036

    
1037
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
1038
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1039
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1040
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1041

    
1042
enum AVPacketSideDataType {
1043
    AV_PKT_DATA_PALETTE,
1044
};
1045

    
1046
typedef struct AVPacket {
1047
    /**
1048
     * Presentation timestamp in AVStream->time_base units; the time at which
1049
     * the decompressed packet will be presented to the user.
1050
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1051
     * pts MUST be larger or equal to dts as presentation cannot happen before
1052
     * decompression, unless one wants to view hex dumps. Some formats misuse
1053
     * the terms dts and pts/cts to mean something different. Such timestamps
1054
     * must be converted to true pts/dts before they are stored in AVPacket.
1055
     */
1056
    int64_t pts;
1057
    /**
1058
     * Decompression timestamp in AVStream->time_base units; the time at which
1059
     * the packet is decompressed.
1060
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1061
     */
1062
    int64_t dts;
1063
    uint8_t *data;
1064
    int   size;
1065
    int   stream_index;
1066
    int   flags;
1067
    /**
1068
     * Additional packet data that can be provided by the container.
1069
     * Packet can contain several types of side information.
1070
     */
1071
    struct {
1072
        uint8_t *data;
1073
        int      size;
1074
        enum AVPacketSideDataType type;
1075
    } *side_data;
1076
    int side_data_elems;
1077

    
1078
    /**
1079
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
1080
     * Equals next_pts - this_pts in presentation order.
1081
     */
1082
    int   duration;
1083
    void  (*destruct)(struct AVPacket *);
1084
    void  *priv;
1085
    int64_t pos;                            ///< byte position in stream, -1 if unknown
1086

    
1087
    /**
1088
     * Time difference in AVStream->time_base units from the pts of this
1089
     * packet to the point at which the output from the decoder has converged
1090
     * independent from the availability of previous frames. That is, the
1091
     * frames are virtually identical no matter if decoding started from
1092
     * the very first frame or from this keyframe.
1093
     * Is AV_NOPTS_VALUE if unknown.
1094
     * This field is not the display duration of the current packet.
1095
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1096
     * set.
1097
     *
1098
     * The purpose of this field is to allow seeking in streams that have no
1099
     * keyframes in the conventional sense. It corresponds to the
1100
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1101
     * essential for some types of subtitle streams to ensure that all
1102
     * subtitles are correctly displayed after seeking.
1103
     */
1104
    int64_t convergence_duration;
1105
} AVPacket;
1106
#define AV_PKT_FLAG_KEY   0x0001
1107

    
1108
/**
1109
 * Audio Video Frame.
1110
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1111
 * bumps.
1112
 * Removal, reordering and changes to existing fields require a major
1113
 * version bump. No fields should be added into AVFrame before or after
1114
 * FF_COMMON_FRAME!
1115
 * sizeof(AVFrame) must not be used outside libav*.
1116
 */
1117
typedef struct AVFrame {
1118
    FF_COMMON_FRAME
1119
} AVFrame;
1120

    
1121
/**
1122
 * main external API structure.
1123
 * New fields can be added to the end with minor version bumps.
1124
 * Removal, reordering and changes to existing fields require a major
1125
 * version bump.
1126
 * sizeof(AVCodecContext) must not be used outside libav*.
1127
 */
1128
typedef struct AVCodecContext {
1129
    /**
1130
     * information on struct for av_log
1131
     * - set by avcodec_alloc_context
1132
     */
1133
    const AVClass *av_class;
1134
    /**
1135
     * the average bitrate
1136
     * - encoding: Set by user; unused for constant quantizer encoding.
1137
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1138
     */
1139
    int bit_rate;
1140

    
1141
    /**
1142
     * number of bits the bitstream is allowed to diverge from the reference.
1143
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1144
     * - encoding: Set by user; unused for constant quantizer encoding.
1145
     * - decoding: unused
1146
     */
1147
    int bit_rate_tolerance;
1148

    
1149
    /**
1150
     * CODEC_FLAG_*.
1151
     * - encoding: Set by user.
1152
     * - decoding: Set by user.
1153
     */
1154
    int flags;
1155

    
1156
    /**
1157
     * Some codecs need additional format info. It is stored here.
1158
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1159
     * specific codec MUST set it correctly otherwise stream copy breaks.
1160
     * In general use of this field by muxers is not recommanded.
1161
     * - encoding: Set by libavcodec.
1162
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1163
     */
1164
    int sub_id;
1165

    
1166
    /**
1167
     * Motion estimation algorithm used for video coding.
1168
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1169
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1170
     * - encoding: MUST be set by user.
1171
     * - decoding: unused
1172
     */
1173
    int me_method;
1174

    
1175
    /**
1176
     * some codecs need / can use extradata like Huffman tables.
1177
     * mjpeg: Huffman tables
1178
     * rv10: additional flags
1179
     * mpeg4: global headers (they can be in the bitstream or here)
1180
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1181
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1182
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1183
     * - encoding: Set/allocated/freed by libavcodec.
1184
     * - decoding: Set/allocated/freed by user.
1185
     */
1186
    uint8_t *extradata;
1187
    int extradata_size;
1188

    
1189
    /**
1190
     * This is the fundamental unit of time (in seconds) in terms
1191
     * of which frame timestamps are represented. For fixed-fps content,
1192
     * timebase should be 1/framerate and timestamp increments should be
1193
     * identically 1.
1194
     * - encoding: MUST be set by user.
1195
     * - decoding: Set by libavcodec.
1196
     */
1197
    AVRational time_base;
1198

    
1199
    /* video only */
1200
    /**
1201
     * picture width / height.
1202
     * - encoding: MUST be set by user.
1203
     * - decoding: Set by libavcodec.
1204
     * Note: For compatibility it is possible to set this instead of
1205
     * coded_width/height before decoding.
1206
     */
1207
    int width, height;
1208

    
1209
#define FF_ASPECT_EXTENDED 15
1210

    
1211
    /**
1212
     * the number of pictures in a group of pictures, or 0 for intra_only
1213
     * - encoding: Set by user.
1214
     * - decoding: unused
1215
     */
1216
    int gop_size;
1217

    
1218
    /**
1219
     * Pixel format, see PIX_FMT_xxx.
1220
     * May be set by the demuxer if known from headers.
1221
     * May be overriden by the decoder if it knows better.
1222
     * - encoding: Set by user.
1223
     * - decoding: Set by user if known, overridden by libavcodec if known
1224
     */
1225
    enum PixelFormat pix_fmt;
1226

    
1227
    /**
1228
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1229
     * decoder to draw a horizontal band. It improves cache usage. Not
1230
     * all codecs can do that. You must check the codec capabilities
1231
     * beforehand.
1232
     * When multithreading is used, it may be called from multiple threads
1233
     * at the same time; threads might draw different parts of the same AVFrame,
1234
     * or multiple AVFrames, and there is no guarantee that slices will be drawn
1235
     * in order.
1236
     * The function is also used by hardware acceleration APIs.
1237
     * It is called at least once during frame decoding to pass
1238
     * the data needed for hardware render.
1239
     * In that mode instead of pixel data, AVFrame points to
1240
     * a structure specific to the acceleration API. The application
1241
     * reads the structure and can change some fields to indicate progress
1242
     * or mark state.
1243
     * - encoding: unused
1244
     * - decoding: Set by user.
1245
     * @param height the height of the slice
1246
     * @param y the y position of the slice
1247
     * @param type 1->top field, 2->bottom field, 3->frame
1248
     * @param offset offset into the AVFrame.data from which the slice should be read
1249
     */
1250
    void (*draw_horiz_band)(struct AVCodecContext *s,
1251
                            const AVFrame *src, int offset[4],
1252
                            int y, int type, int height);
1253

    
1254
    /* audio only */
1255
    int sample_rate; ///< samples per second
1256
    int channels;    ///< number of audio channels
1257

    
1258
    /**
1259
     * audio sample format
1260
     * - encoding: Set by user.
1261
     * - decoding: Set by libavcodec.
1262
     */
1263
    enum AVSampleFormat sample_fmt;  ///< sample format
1264

    
1265
    /* The following data should not be initialized. */
1266
    /**
1267
     * Samples per packet, initialized when calling 'init'.
1268
     */
1269
    int frame_size;
1270
    int frame_number;   ///< audio or video frame number
1271

    
1272
    /**
1273
     * Number of frames the decoded output will be delayed relative to
1274
     * the encoded input.
1275
     * - encoding: Set by libavcodec.
1276
     * - decoding: unused
1277
     */
1278
    int delay;
1279

    
1280
    /* - encoding parameters */
1281
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1282
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1283

    
1284
    /**
1285
     * minimum quantizer
1286
     * - encoding: Set by user.
1287
     * - decoding: unused
1288
     */
1289
    int qmin;
1290

    
1291
    /**
1292
     * maximum quantizer
1293
     * - encoding: Set by user.
1294
     * - decoding: unused
1295
     */
1296
    int qmax;
1297

    
1298
    /**
1299
     * maximum quantizer difference between frames
1300
     * - encoding: Set by user.
1301
     * - decoding: unused
1302
     */
1303
    int max_qdiff;
1304

    
1305
    /**
1306
     * maximum number of B-frames between non-B-frames
1307
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1308
     * - encoding: Set by user.
1309
     * - decoding: unused
1310
     */
1311
    int max_b_frames;
1312

    
1313
    /**
1314
     * qscale factor between IP and B-frames
1315
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1316
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1317
     * - encoding: Set by user.
1318
     * - decoding: unused
1319
     */
1320
    float b_quant_factor;
1321

    
1322
    /** obsolete FIXME remove */
1323
    int rc_strategy;
1324
#define FF_RC_STRATEGY_XVID 1
1325

    
1326
    int b_frame_strategy;
1327

    
1328
    struct AVCodec *codec;
1329

    
1330
    void *priv_data;
1331

    
1332
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1333
                            /* do its best to deliver a chunk with size     */
1334
                            /* below rtp_payload_size, the chunk will start */
1335
                            /* with a start code on some codecs like H.263. */
1336
                            /* This doesn't take account of any particular  */
1337
                            /* headers inside the transmitted RTP payload.  */
1338

    
1339

    
1340
    /* The RTP callback: This function is called    */
1341
    /* every time the encoder has a packet to send. */
1342
    /* It depends on the encoder if the data starts */
1343
    /* with a Start Code (it should). H.263 does.   */
1344
    /* mb_nb contains the number of macroblocks     */
1345
    /* encoded in the RTP payload.                  */
1346
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1347

    
1348
    /* statistics, used for 2-pass encoding */
1349
    int mv_bits;
1350
    int header_bits;
1351
    int i_tex_bits;
1352
    int p_tex_bits;
1353
    int i_count;
1354
    int p_count;
1355
    int skip_count;
1356
    int misc_bits;
1357

    
1358
    /**
1359
     * number of bits used for the previously encoded frame
1360
     * - encoding: Set by libavcodec.
1361
     * - decoding: unused
1362
     */
1363
    int frame_bits;
1364

    
1365
    /**
1366
     * Private data of the user, can be used to carry app specific stuff.
1367
     * - encoding: Set by user.
1368
     * - decoding: Set by user.
1369
     */
1370
    void *opaque;
1371

    
1372
    char codec_name[32];
1373
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1374
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1375

    
1376
    /**
1377
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1378
     * This is used to work around some encoder bugs.
1379
     * A demuxer should set this to what is stored in the field used to identify the codec.
1380
     * If there are multiple such fields in a container then the demuxer should choose the one
1381
     * which maximizes the information about the used codec.
1382
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1383
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1384
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1385
     * first.
1386
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1387
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1388
     */
1389
    unsigned int codec_tag;
1390

    
1391
    /**
1392
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1393
     * - encoding: Set by user
1394
     * - decoding: Set by user
1395
     */
1396
    int workaround_bugs;
1397
#define FF_BUG_AUTODETECT       1  ///< autodetection
1398
#define FF_BUG_OLD_MSMPEG4      2
1399
#define FF_BUG_XVID_ILACE       4
1400
#define FF_BUG_UMP4             8
1401
#define FF_BUG_NO_PADDING       16
1402
#define FF_BUG_AMV              32
1403
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1404
#define FF_BUG_QPEL_CHROMA      64
1405
#define FF_BUG_STD_QPEL         128
1406
#define FF_BUG_QPEL_CHROMA2     256
1407
#define FF_BUG_DIRECT_BLOCKSIZE 512
1408
#define FF_BUG_EDGE             1024
1409
#define FF_BUG_HPEL_CHROMA      2048
1410
#define FF_BUG_DC_CLIP          4096
1411
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1412
#define FF_BUG_TRUNCATED       16384
1413
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1414

    
1415
    /**
1416
     * luma single coefficient elimination threshold
1417
     * - encoding: Set by user.
1418
     * - decoding: unused
1419
     */
1420
    int luma_elim_threshold;
1421

    
1422
    /**
1423
     * chroma single coeff elimination threshold
1424
     * - encoding: Set by user.
1425
     * - decoding: unused
1426
     */
1427
    int chroma_elim_threshold;
1428

    
1429
    /**
1430
     * strictly follow the standard (MPEG4, ...).
1431
     * - encoding: Set by user.
1432
     * - decoding: Set by user.
1433
     * Setting this to STRICT or higher means the encoder and decoder will
1434
     * generally do stupid things, whereas setting it to unofficial or lower
1435
     * will mean the encoder might produce output that is not supported by all
1436
     * spec-compliant decoders. Decoders don't differentiate between normal,
1437
     * unofficial and experimental (that is, they always try to decode things
1438
     * when they can) unless they are explicitly asked to behave stupidly
1439
     * (=strictly conform to the specs)
1440
     */
1441
    int strict_std_compliance;
1442
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1443
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1444
#define FF_COMPLIANCE_NORMAL        0
1445
#define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1446
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1447

    
1448
    /**
1449
     * qscale offset between IP and B-frames
1450
     * - encoding: Set by user.
1451
     * - decoding: unused
1452
     */
1453
    float b_quant_offset;
1454

    
1455
    /**
1456
     * Error recognization; higher values will detect more errors but may
1457
     * misdetect some more or less valid parts as errors.
1458
     * - encoding: unused
1459
     * - decoding: Set by user.
1460
     */
1461
    int error_recognition;
1462
#define FF_ER_CAREFUL         1
1463
#define FF_ER_COMPLIANT       2
1464
#define FF_ER_AGGRESSIVE      3
1465
#define FF_ER_VERY_AGGRESSIVE 4
1466

    
1467
    /**
1468
     * Called at the beginning of each frame to get a buffer for it.
1469
     * If pic.reference is set then the frame will be read later by libavcodec.
1470
     * avcodec_align_dimensions2() should be used to find the required width and
1471
     * height, as they normally need to be rounded up to the next multiple of 16.
1472
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1473
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1474
     * some other means.
1475
     * If frame multithreading is used and thread_safe_callbacks is set,
1476
     * it may be called from a different thread, but not from more than one at once.
1477
     * Does not need to be reentrant.
1478
     * - encoding: unused
1479
     * - decoding: Set by libavcodec, user can override.
1480
     */
1481
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1482

    
1483
    /**
1484
     * Called to release buffers which were allocated with get_buffer.
1485
     * A released buffer can be reused in get_buffer().
1486
     * pic.data[*] must be set to NULL.
1487
     * May be called from a different thread if frame multithreading is used,
1488
     * but not by more than one thread at once, so does not need to be reentrant.
1489
     * - encoding: unused
1490
     * - decoding: Set by libavcodec, user can override.
1491
     */
1492
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1493

    
1494
    /**
1495
     * Size of the frame reordering buffer in the decoder.
1496
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1497
     * - encoding: Set by libavcodec.
1498
     * - decoding: Set by libavcodec.
1499
     */
1500
    int has_b_frames;
1501

    
1502
    /**
1503
     * number of bytes per packet if constant and known or 0
1504
     * Used by some WAV based audio codecs.
1505
     */
1506
    int block_align;
1507

    
1508
    int parse_only; /* - decoding only: If true, only parsing is done
1509
                       (function avcodec_parse_frame()). The frame
1510
                       data is returned. Only MPEG codecs support this now. */
1511

    
1512
    /**
1513
     * 0-> h263 quant 1-> mpeg quant
1514
     * - encoding: Set by user.
1515
     * - decoding: unused
1516
     */
1517
    int mpeg_quant;
1518

    
1519
    /**
1520
     * pass1 encoding statistics output buffer
1521
     * - encoding: Set by libavcodec.
1522
     * - decoding: unused
1523
     */
1524
    char *stats_out;
1525

    
1526
    /**
1527
     * pass2 encoding statistics input buffer
1528
     * Concatenated stuff from stats_out of pass1 should be placed here.
1529
     * - encoding: Allocated/set/freed by user.
1530
     * - decoding: unused
1531
     */
1532
    char *stats_in;
1533

    
1534
    /**
1535
     * ratecontrol qmin qmax limiting method
1536
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1537
     * - encoding: Set by user.
1538
     * - decoding: unused
1539
     */
1540
    float rc_qsquish;
1541

    
1542
    float rc_qmod_amp;
1543
    int rc_qmod_freq;
1544

    
1545
    /**
1546
     * ratecontrol override, see RcOverride
1547
     * - encoding: Allocated/set/freed by user.
1548
     * - decoding: unused
1549
     */
1550
    RcOverride *rc_override;
1551
    int rc_override_count;
1552

    
1553
    /**
1554
     * rate control equation
1555
     * - encoding: Set by user
1556
     * - decoding: unused
1557
     */
1558
    const char *rc_eq;
1559

    
1560
    /**
1561
     * maximum bitrate
1562
     * - encoding: Set by user.
1563
     * - decoding: unused
1564
     */
1565
    int rc_max_rate;
1566

    
1567
    /**
1568
     * minimum bitrate
1569
     * - encoding: Set by user.
1570
     * - decoding: unused
1571
     */
1572
    int rc_min_rate;
1573

    
1574
    /**
1575
     * decoder bitstream buffer size
1576
     * - encoding: Set by user.
1577
     * - decoding: unused
1578
     */
1579
    int rc_buffer_size;
1580
    float rc_buffer_aggressivity;
1581

    
1582
    /**
1583
     * qscale factor between P and I-frames
1584
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1585
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1586
     * - encoding: Set by user.
1587
     * - decoding: unused
1588
     */
1589
    float i_quant_factor;
1590

    
1591
    /**
1592
     * qscale offset between P and I-frames
1593
     * - encoding: Set by user.
1594
     * - decoding: unused
1595
     */
1596
    float i_quant_offset;
1597

    
1598
    /**
1599
     * initial complexity for pass1 ratecontrol
1600
     * - encoding: Set by user.
1601
     * - decoding: unused
1602
     */
1603
    float rc_initial_cplx;
1604

    
1605
    /**
1606
     * DCT algorithm, see FF_DCT_* below
1607
     * - encoding: Set by user.
1608
     * - decoding: unused
1609
     */
1610
    int dct_algo;
1611
#define FF_DCT_AUTO    0
1612
#define FF_DCT_FASTINT 1
1613
#define FF_DCT_INT     2
1614
#define FF_DCT_MMX     3
1615
#define FF_DCT_MLIB    4
1616
#define FF_DCT_ALTIVEC 5
1617
#define FF_DCT_FAAN    6
1618

    
1619
    /**
1620
     * luminance masking (0-> disabled)
1621
     * - encoding: Set by user.
1622
     * - decoding: unused
1623
     */
1624
    float lumi_masking;
1625

    
1626
    /**
1627
     * temporary complexity masking (0-> disabled)
1628
     * - encoding: Set by user.
1629
     * - decoding: unused
1630
     */
1631
    float temporal_cplx_masking;
1632

    
1633
    /**
1634
     * spatial complexity masking (0-> disabled)
1635
     * - encoding: Set by user.
1636
     * - decoding: unused
1637
     */
1638
    float spatial_cplx_masking;
1639

    
1640
    /**
1641
     * p block masking (0-> disabled)
1642
     * - encoding: Set by user.
1643
     * - decoding: unused
1644
     */
1645
    float p_masking;
1646

    
1647
    /**
1648
     * darkness masking (0-> disabled)
1649
     * - encoding: Set by user.
1650
     * - decoding: unused
1651
     */
1652
    float dark_masking;
1653

    
1654
    /**
1655
     * IDCT algorithm, see FF_IDCT_* below.
1656
     * - encoding: Set by user.
1657
     * - decoding: Set by user.
1658
     */
1659
    int idct_algo;
1660
#define FF_IDCT_AUTO          0
1661
#define FF_IDCT_INT           1
1662
#define FF_IDCT_SIMPLE        2
1663
#define FF_IDCT_SIMPLEMMX     3
1664
#define FF_IDCT_LIBMPEG2MMX   4
1665
#define FF_IDCT_PS2           5
1666
#define FF_IDCT_MLIB          6
1667
#define FF_IDCT_ARM           7
1668
#define FF_IDCT_ALTIVEC       8
1669
#define FF_IDCT_SH4           9
1670
#define FF_IDCT_SIMPLEARM     10
1671
#define FF_IDCT_H264          11
1672
#define FF_IDCT_VP3           12
1673
#define FF_IDCT_IPP           13
1674
#define FF_IDCT_XVIDMMX       14
1675
#define FF_IDCT_CAVS          15
1676
#define FF_IDCT_SIMPLEARMV5TE 16
1677
#define FF_IDCT_SIMPLEARMV6   17
1678
#define FF_IDCT_SIMPLEVIS     18
1679
#define FF_IDCT_WMV2          19
1680
#define FF_IDCT_FAAN          20
1681
#define FF_IDCT_EA            21
1682
#define FF_IDCT_SIMPLENEON    22
1683
#define FF_IDCT_SIMPLEALPHA   23
1684
#define FF_IDCT_BINK          24
1685

    
1686
    /**
1687
     * slice count
1688
     * - encoding: Set by libavcodec.
1689
     * - decoding: Set by user (or 0).
1690
     */
1691
    int slice_count;
1692
    /**
1693
     * slice offsets in the frame in bytes
1694
     * - encoding: Set/allocated by libavcodec.
1695
     * - decoding: Set/allocated by user (or NULL).
1696
     */
1697
    int *slice_offset;
1698

    
1699
    /**
1700
     * error concealment flags
1701
     * - encoding: unused
1702
     * - decoding: Set by user.
1703
     */
1704
    int error_concealment;
1705
#define FF_EC_GUESS_MVS   1
1706
#define FF_EC_DEBLOCK     2
1707

    
1708
    /**
1709
     * dsp_mask could be add used to disable unwanted CPU features
1710
     * CPU features (i.e. MMX, SSE. ...)
1711
     *
1712
     * With the FORCE flag you may instead enable given CPU features.
1713
     * (Dangerous: Usable in case of misdetection, improper usage however will
1714
     * result into program crash.)
1715
     */
1716
    unsigned dsp_mask;
1717

    
1718
    /**
1719
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1720
     * - encoding: Set by libavcodec.
1721
     * - decoding: Set by user.
1722
     */
1723
     int bits_per_coded_sample;
1724

    
1725
    /**
1726
     * prediction method (needed for huffyuv)
1727
     * - encoding: Set by user.
1728
     * - decoding: unused
1729
     */
1730
     int prediction_method;
1731
#define FF_PRED_LEFT   0
1732
#define FF_PRED_PLANE  1
1733
#define FF_PRED_MEDIAN 2
1734

    
1735
    /**
1736
     * sample aspect ratio (0 if unknown)
1737
     * That is the width of a pixel divided by the height of the pixel.
1738
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1739
     * - encoding: Set by user.
1740
     * - decoding: Set by libavcodec.
1741
     */
1742
    AVRational sample_aspect_ratio;
1743

    
1744
    /**
1745
     * the picture in the bitstream
1746
     * - encoding: Set by libavcodec.
1747
     * - decoding: Set by libavcodec.
1748
     */
1749
    AVFrame *coded_frame;
1750

    
1751
    /**
1752
     * debug
1753
     * - encoding: Set by user.
1754
     * - decoding: Set by user.
1755
     */
1756
    int debug;
1757
#define FF_DEBUG_PICT_INFO   1
1758
#define FF_DEBUG_RC          2
1759
#define FF_DEBUG_BITSTREAM   4
1760
#define FF_DEBUG_MB_TYPE     8
1761
#define FF_DEBUG_QP          16
1762
#define FF_DEBUG_MV          32
1763
#define FF_DEBUG_DCT_COEFF   0x00000040
1764
#define FF_DEBUG_SKIP        0x00000080
1765
#define FF_DEBUG_STARTCODE   0x00000100
1766
#define FF_DEBUG_PTS         0x00000200
1767
#define FF_DEBUG_ER          0x00000400
1768
#define FF_DEBUG_MMCO        0x00000800
1769
#define FF_DEBUG_BUGS        0x00001000
1770
#define FF_DEBUG_VIS_QP      0x00002000
1771
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1772
#define FF_DEBUG_BUFFERS     0x00008000
1773
#define FF_DEBUG_THREADS     0x00010000
1774

    
1775
    /**
1776
     * debug
1777
     * - encoding: Set by user.
1778
     * - decoding: Set by user.
1779
     */
1780
    int debug_mv;
1781
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1782
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1783
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1784

    
1785
    /**
1786
     * error
1787
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1788
     * - decoding: unused
1789
     */
1790
    uint64_t error[4];
1791

    
1792
    /**
1793
     * motion estimation comparison function
1794
     * - encoding: Set by user.
1795
     * - decoding: unused
1796
     */
1797
    int me_cmp;
1798
    /**
1799
     * subpixel motion estimation comparison function
1800
     * - encoding: Set by user.
1801
     * - decoding: unused
1802
     */
1803
    int me_sub_cmp;
1804
    /**
1805
     * macroblock comparison function (not supported yet)
1806
     * - encoding: Set by user.
1807
     * - decoding: unused
1808
     */
1809
    int mb_cmp;
1810
    /**
1811
     * interlaced DCT comparison function
1812
     * - encoding: Set by user.
1813
     * - decoding: unused
1814
     */
1815
    int ildct_cmp;
1816
#define FF_CMP_SAD    0
1817
#define FF_CMP_SSE    1
1818
#define FF_CMP_SATD   2
1819
#define FF_CMP_DCT    3
1820
#define FF_CMP_PSNR   4
1821
#define FF_CMP_BIT    5
1822
#define FF_CMP_RD     6
1823
#define FF_CMP_ZERO   7
1824
#define FF_CMP_VSAD   8
1825
#define FF_CMP_VSSE   9
1826
#define FF_CMP_NSSE   10
1827
#define FF_CMP_W53    11
1828
#define FF_CMP_W97    12
1829
#define FF_CMP_DCTMAX 13
1830
#define FF_CMP_DCT264 14
1831
#define FF_CMP_CHROMA 256
1832

    
1833
    /**
1834
     * ME diamond size & shape
1835
     * - encoding: Set by user.
1836
     * - decoding: unused
1837
     */
1838
    int dia_size;
1839

    
1840
    /**
1841
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1842
     * - encoding: Set by user.
1843
     * - decoding: unused
1844
     */
1845
    int last_predictor_count;
1846

    
1847
    /**
1848
     * prepass for motion estimation
1849
     * - encoding: Set by user.
1850
     * - decoding: unused
1851
     */
1852
    int pre_me;
1853

    
1854
    /**
1855
     * motion estimation prepass comparison function
1856
     * - encoding: Set by user.
1857
     * - decoding: unused
1858
     */
1859
    int me_pre_cmp;
1860

    
1861
    /**
1862
     * ME prepass diamond size & shape
1863
     * - encoding: Set by user.
1864
     * - decoding: unused
1865
     */
1866
    int pre_dia_size;
1867

    
1868
    /**
1869
     * subpel ME quality
1870
     * - encoding: Set by user.
1871
     * - decoding: unused
1872
     */
1873
    int me_subpel_quality;
1874

    
1875
    /**
1876
     * callback to negotiate the pixelFormat
1877
     * @param fmt is the list of formats which are supported by the codec,
1878
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1879
     * The first is always the native one.
1880
     * @return the chosen format
1881
     * - encoding: unused
1882
     * - decoding: Set by user, if not set the native format will be chosen.
1883
     */
1884
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1885

    
1886
    /**
1887
     * DTG active format information (additional aspect ratio
1888
     * information only used in DVB MPEG-2 transport streams)
1889
     * 0 if not set.
1890
     *
1891
     * - encoding: unused
1892
     * - decoding: Set by decoder.
1893
     */
1894
    int dtg_active_format;
1895
#define FF_DTG_AFD_SAME         8
1896
#define FF_DTG_AFD_4_3          9
1897
#define FF_DTG_AFD_16_9         10
1898
#define FF_DTG_AFD_14_9         11
1899
#define FF_DTG_AFD_4_3_SP_14_9  13
1900
#define FF_DTG_AFD_16_9_SP_14_9 14
1901
#define FF_DTG_AFD_SP_4_3       15
1902

    
1903
    /**
1904
     * maximum motion estimation search range in subpel units
1905
     * If 0 then no limit.
1906
     *
1907
     * - encoding: Set by user.
1908
     * - decoding: unused
1909
     */
1910
    int me_range;
1911

    
1912
    /**
1913
     * intra quantizer bias
1914
     * - encoding: Set by user.
1915
     * - decoding: unused
1916
     */
1917
    int intra_quant_bias;
1918
#define FF_DEFAULT_QUANT_BIAS 999999
1919

    
1920
    /**
1921
     * inter quantizer bias
1922
     * - encoding: Set by user.
1923
     * - decoding: unused
1924
     */
1925
    int inter_quant_bias;
1926

    
1927
    /**
1928
     * color table ID
1929
     * - encoding: unused
1930
     * - decoding: Which clrtable should be used for 8bit RGB images.
1931
     *             Tables have to be stored somewhere. FIXME
1932
     */
1933
    int color_table_id;
1934

    
1935
    /**
1936
     * internal_buffer count
1937
     * Don't touch, used by libavcodec default_get_buffer().
1938
     */
1939
    int internal_buffer_count;
1940

    
1941
    /**
1942
     * internal_buffers
1943
     * Don't touch, used by libavcodec default_get_buffer().
1944
     */
1945
    void *internal_buffer;
1946

    
1947
    /**
1948
     * Global quality for codecs which cannot change it per frame.
1949
     * This should be proportional to MPEG-1/2/4 qscale.
1950
     * - encoding: Set by user.
1951
     * - decoding: unused
1952
     */
1953
    int global_quality;
1954

    
1955
#define FF_CODER_TYPE_VLC       0
1956
#define FF_CODER_TYPE_AC        1
1957
#define FF_CODER_TYPE_RAW       2
1958
#define FF_CODER_TYPE_RLE       3
1959
#define FF_CODER_TYPE_DEFLATE   4
1960
    /**
1961
     * coder type
1962
     * - encoding: Set by user.
1963
     * - decoding: unused
1964
     */
1965
    int coder_type;
1966

    
1967
    /**
1968
     * context model
1969
     * - encoding: Set by user.
1970
     * - decoding: unused
1971
     */
1972
    int context_model;
1973
#if 0
1974
    /**
1975
     *
1976
     * - encoding: unused
1977
     * - decoding: Set by user.
1978
     */
1979
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1980
#endif
1981

    
1982
    /**
1983
     * slice flags
1984
     * - encoding: unused
1985
     * - decoding: Set by user.
1986
     */
1987
    int slice_flags;
1988
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1989
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1990
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1991

    
1992
    /**
1993
     * XVideo Motion Acceleration
1994
     * - encoding: forbidden
1995
     * - decoding: set by decoder
1996
     */
1997
    int xvmc_acceleration;
1998

    
1999
    /**
2000
     * macroblock decision mode
2001
     * - encoding: Set by user.
2002
     * - decoding: unused
2003
     */
2004
    int mb_decision;
2005
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2006
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2007
#define FF_MB_DECISION_RD     2        ///< rate distortion
2008

    
2009
    /**
2010
     * custom intra quantization matrix
2011
     * - encoding: Set by user, can be NULL.
2012
     * - decoding: Set by libavcodec.
2013
     */
2014
    uint16_t *intra_matrix;
2015

    
2016
    /**
2017
     * custom inter quantization matrix
2018
     * - encoding: Set by user, can be NULL.
2019
     * - decoding: Set by libavcodec.
2020
     */
2021
    uint16_t *inter_matrix;
2022

    
2023
    /**
2024
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2025
     * This is used to work around some encoder bugs.
2026
     * - encoding: unused
2027
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2028
     */
2029
    unsigned int stream_codec_tag;
2030

    
2031
    /**
2032
     * scene change detection threshold
2033
     * 0 is default, larger means fewer detected scene changes.
2034
     * - encoding: Set by user.
2035
     * - decoding: unused
2036
     */
2037
    int scenechange_threshold;
2038

    
2039
    /**
2040
     * minimum Lagrange multipler
2041
     * - encoding: Set by user.
2042
     * - decoding: unused
2043
     */
2044
    int lmin;
2045

    
2046
    /**
2047
     * maximum Lagrange multipler
2048
     * - encoding: Set by user.
2049
     * - decoding: unused
2050
     */
2051
    int lmax;
2052

    
2053
#if FF_API_PALETTE_CONTROL
2054
    /**
2055
     * palette control structure
2056
     * - encoding: ??? (no palette-enabled encoder yet)
2057
     * - decoding: Set by user.
2058
     */
2059
    struct AVPaletteControl *palctrl;
2060
#endif
2061

    
2062
    /**
2063
     * noise reduction strength
2064
     * - encoding: Set by user.
2065
     * - decoding: unused
2066
     */
2067
    int noise_reduction;
2068

    
2069
    /**
2070
     * Called at the beginning of a frame to get cr buffer for it.
2071
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
2072
     * libavcodec will pass previous buffer in pic, function should return
2073
     * same buffer or new buffer with old frame "painted" into it.
2074
     * If pic.data[0] == NULL must behave like get_buffer().
2075
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2076
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
2077
     * some other means.
2078
     * - encoding: unused
2079
     * - decoding: Set by libavcodec, user can override.
2080
     */
2081
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2082

    
2083
    /**
2084
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2085
     * - encoding: Set by user.
2086
     * - decoding: unused
2087
     */
2088
    int rc_initial_buffer_occupancy;
2089

    
2090
    /**
2091
     *
2092
     * - encoding: Set by user.
2093
     * - decoding: unused
2094
     */
2095
    int inter_threshold;
2096

    
2097
    /**
2098
     * CODEC_FLAG2_*
2099
     * - encoding: Set by user.
2100
     * - decoding: Set by user.
2101
     */
2102
    int flags2;
2103

    
2104
    /**
2105
     * Simulates errors in the bitstream to test error concealment.
2106
     * - encoding: Set by user.
2107
     * - decoding: unused
2108
     */
2109
    int error_rate;
2110

    
2111
#if FF_API_ANTIALIAS_ALGO
2112
    /**
2113
     * MP3 antialias algorithm, see FF_AA_* below.
2114
     * - encoding: unused
2115
     * - decoding: Set by user.
2116
     */
2117
    attribute_deprecated int antialias_algo;
2118
#define FF_AA_AUTO    0
2119
#define FF_AA_FASTINT 1 //not implemented yet
2120
#define FF_AA_INT     2
2121
#define FF_AA_FLOAT   3
2122
#endif
2123

    
2124
    /**
2125
     * quantizer noise shaping
2126
     * - encoding: Set by user.
2127
     * - decoding: unused
2128
     */
2129
    int quantizer_noise_shaping;
2130

    
2131
    /**
2132
     * thread count
2133
     * is used to decide how many independent tasks should be passed to execute()
2134
     * - encoding: Set by user.
2135
     * - decoding: Set by user.
2136
     */
2137
    int thread_count;
2138

    
2139
    /**
2140
     * The codec may call this to execute several independent things.
2141
     * It will return only after finishing all tasks.
2142
     * The user may replace this with some multithreaded implementation,
2143
     * the default implementation will execute the parts serially.
2144
     * @param count the number of things to execute
2145
     * - encoding: Set by libavcodec, user can override.
2146
     * - decoding: Set by libavcodec, user can override.
2147
     */
2148
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2149

    
2150
    /**
2151
     * thread opaque
2152
     * Can be used by execute() to store some per AVCodecContext stuff.
2153
     * - encoding: set by execute()
2154
     * - decoding: set by execute()
2155
     */
2156
    void *thread_opaque;
2157

    
2158
    /**
2159
     * Motion estimation threshold below which no motion estimation is
2160
     * performed, but instead the user specified motion vectors are used.
2161
     *
2162
     * - encoding: Set by user.
2163
     * - decoding: unused
2164
     */
2165
     int me_threshold;
2166

    
2167
    /**
2168
     * Macroblock threshold below which the user specified macroblock types will be used.
2169
     * - encoding: Set by user.
2170
     * - decoding: unused
2171
     */
2172
     int mb_threshold;
2173

    
2174
    /**
2175
     * precision of the intra DC coefficient - 8
2176
     * - encoding: Set by user.
2177
     * - decoding: unused
2178
     */
2179
     int intra_dc_precision;
2180

    
2181
    /**
2182
     * noise vs. sse weight for the nsse comparsion function
2183
     * - encoding: Set by user.
2184
     * - decoding: unused
2185
     */
2186
     int nsse_weight;
2187

    
2188
    /**
2189
     * Number of macroblock rows at the top which are skipped.
2190
     * - encoding: unused
2191
     * - decoding: Set by user.
2192
     */
2193
     int skip_top;
2194

    
2195
    /**
2196
     * Number of macroblock rows at the bottom which are skipped.
2197
     * - encoding: unused
2198
     * - decoding: Set by user.
2199
     */
2200
     int skip_bottom;
2201

    
2202
    /**
2203
     * profile
2204
     * - encoding: Set by user.
2205
     * - decoding: Set by libavcodec.
2206
     */
2207
     int profile;
2208
#define FF_PROFILE_UNKNOWN -99
2209
#define FF_PROFILE_RESERVED -100
2210

    
2211
#define FF_PROFILE_AAC_MAIN 0
2212
#define FF_PROFILE_AAC_LOW  1
2213
#define FF_PROFILE_AAC_SSR  2
2214
#define FF_PROFILE_AAC_LTP  3
2215

    
2216
#define FF_PROFILE_DTS         20
2217
#define FF_PROFILE_DTS_ES      30
2218
#define FF_PROFILE_DTS_96_24   40
2219
#define FF_PROFILE_DTS_HD_HRA  50
2220
#define FF_PROFILE_DTS_HD_MA   60
2221

    
2222
#define FF_PROFILE_MPEG2_422    0
2223
#define FF_PROFILE_MPEG2_HIGH   1
2224
#define FF_PROFILE_MPEG2_SS     2
2225
#define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2226
#define FF_PROFILE_MPEG2_MAIN   4
2227
#define FF_PROFILE_MPEG2_SIMPLE 5
2228

    
2229
#define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2230
#define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2231

    
2232
#define FF_PROFILE_H264_BASELINE             66
2233
#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2234
#define FF_PROFILE_H264_MAIN                 77
2235
#define FF_PROFILE_H264_EXTENDED             88
2236
#define FF_PROFILE_H264_HIGH                 100
2237
#define FF_PROFILE_H264_HIGH_10              110
2238
#define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2239
#define FF_PROFILE_H264_HIGH_422             122
2240
#define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2241
#define FF_PROFILE_H264_HIGH_444             144
2242
#define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2243
#define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2244
#define FF_PROFILE_H264_CAVLC_444            44
2245

    
2246
#define FF_PROFILE_VC1_SIMPLE   0
2247
#define FF_PROFILE_VC1_MAIN     1
2248
#define FF_PROFILE_VC1_COMPLEX  2
2249
#define FF_PROFILE_VC1_ADVANCED 3
2250

    
2251
    /**
2252
     * level
2253
     * - encoding: Set by user.
2254
     * - decoding: Set by libavcodec.
2255
     */
2256
     int level;
2257
#define FF_LEVEL_UNKNOWN -99
2258

    
2259
    /**
2260
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2261
     * - encoding: unused
2262
     * - decoding: Set by user.
2263
     */
2264
     int lowres;
2265

    
2266
    /**
2267
     * Bitstream width / height, may be different from width/height if lowres
2268
     * or other things are used.
2269
     * - encoding: unused
2270
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2271
     */
2272
    int coded_width, coded_height;
2273

    
2274
    /**
2275
     * frame skip threshold
2276
     * - encoding: Set by user.
2277
     * - decoding: unused
2278
     */
2279
    int frame_skip_threshold;
2280

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

    
2288
    /**
2289
     * frame skip exponent
2290
     * - encoding: Set by user.
2291
     * - decoding: unused
2292
     */
2293
    int frame_skip_exp;
2294

    
2295
    /**
2296
     * frame skip comparison function
2297
     * - encoding: Set by user.
2298
     * - decoding: unused
2299
     */
2300
    int frame_skip_cmp;
2301

    
2302
    /**
2303
     * Border processing masking, raises the quantizer for mbs on the borders
2304
     * of the picture.
2305
     * - encoding: Set by user.
2306
     * - decoding: unused
2307
     */
2308
    float border_masking;
2309

    
2310
    /**
2311
     * minimum MB lagrange multipler
2312
     * - encoding: Set by user.
2313
     * - decoding: unused
2314
     */
2315
    int mb_lmin;
2316

    
2317
    /**
2318
     * maximum MB lagrange multipler
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int mb_lmax;
2323

    
2324
    /**
2325
     *
2326
     * - encoding: Set by user.
2327
     * - decoding: unused
2328
     */
2329
    int me_penalty_compensation;
2330

    
2331
    /**
2332
     *
2333
     * - encoding: unused
2334
     * - decoding: Set by user.
2335
     */
2336
    enum AVDiscard skip_loop_filter;
2337

    
2338
    /**
2339
     *
2340
     * - encoding: unused
2341
     * - decoding: Set by user.
2342
     */
2343
    enum AVDiscard skip_idct;
2344

    
2345
    /**
2346
     *
2347
     * - encoding: unused
2348
     * - decoding: Set by user.
2349
     */
2350
    enum AVDiscard skip_frame;
2351

    
2352
    /**
2353
     *
2354
     * - encoding: Set by user.
2355
     * - decoding: unused
2356
     */
2357
    int bidir_refine;
2358

    
2359
    /**
2360
     *
2361
     * - encoding: Set by user.
2362
     * - decoding: unused
2363
     */
2364
    int brd_scale;
2365

    
2366
    /**
2367
     * constant rate factor - quality-based VBR - values ~correspond to qps
2368
     * - encoding: Set by user.
2369
     * - decoding: unused
2370
     */
2371
    float crf;
2372

    
2373
    /**
2374
     * constant quantization parameter rate control method
2375
     * - encoding: Set by user.
2376
     * - decoding: unused
2377
     */
2378
    int cqp;
2379

    
2380
    /**
2381
     * minimum GOP size
2382
     * - encoding: Set by user.
2383
     * - decoding: unused
2384
     */
2385
    int keyint_min;
2386

    
2387
    /**
2388
     * number of reference frames
2389
     * - encoding: Set by user.
2390
     * - decoding: Set by lavc.
2391
     */
2392
    int refs;
2393

    
2394
    /**
2395
     * chroma qp offset from luma
2396
     * - encoding: Set by user.
2397
     * - decoding: unused
2398
     */
2399
    int chromaoffset;
2400

    
2401
    /**
2402
     * Influences how often B-frames are used.
2403
     * - encoding: Set by user.
2404
     * - decoding: unused
2405
     */
2406
    int bframebias;
2407

    
2408
    /**
2409
     * trellis RD quantization
2410
     * - encoding: Set by user.
2411
     * - decoding: unused
2412
     */
2413
    int trellis;
2414

    
2415
    /**
2416
     * Reduce fluctuations in qp (before curve compression).
2417
     * - encoding: Set by user.
2418
     * - decoding: unused
2419
     */
2420
    float complexityblur;
2421

    
2422
    /**
2423
     * in-loop deblocking filter alphac0 parameter
2424
     * alpha is in the range -6...6
2425
     * - encoding: Set by user.
2426
     * - decoding: unused
2427
     */
2428
    int deblockalpha;
2429

    
2430
    /**
2431
     * in-loop deblocking filter beta parameter
2432
     * beta is in the range -6...6
2433
     * - encoding: Set by user.
2434
     * - decoding: unused
2435
     */
2436
    int deblockbeta;
2437

    
2438
    /**
2439
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2440
     * - encoding: Set by user.
2441
     * - decoding: unused
2442
     */
2443
    int partitions;
2444
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2445
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2446
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2447
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2448
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2449

    
2450
    /**
2451
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2452
     * - encoding: Set by user.
2453
     * - decoding: unused
2454
     */
2455
    int directpred;
2456

    
2457
    /**
2458
     * Audio cutoff bandwidth (0 means "automatic")
2459
     * - encoding: Set by user.
2460
     * - decoding: unused
2461
     */
2462
    int cutoff;
2463

    
2464
    /**
2465
     * Multiplied by qscale for each frame and added to scene_change_score.
2466
     * - encoding: Set by user.
2467
     * - decoding: unused
2468
     */
2469
    int scenechange_factor;
2470

    
2471
    /**
2472
     *
2473
     * Note: Value depends upon the compare function used for fullpel ME.
2474
     * - encoding: Set by user.
2475
     * - decoding: unused
2476
     */
2477
    int mv0_threshold;
2478

    
2479
    /**
2480
     * Adjusts sensitivity of b_frame_strategy 1.
2481
     * - encoding: Set by user.
2482
     * - decoding: unused
2483
     */
2484
    int b_sensitivity;
2485

    
2486
    /**
2487
     * - encoding: Set by user.
2488
     * - decoding: unused
2489
     */
2490
    int compression_level;
2491
#define FF_COMPRESSION_DEFAULT -1
2492

    
2493
    /**
2494
     * LPC coefficient precision - used by FLAC encoder
2495
     * - encoding: Set by user.
2496
     * - decoding: unused
2497
     */
2498
    int lpc_coeff_precision;
2499

    
2500
    /**
2501
     * - encoding: Set by user.
2502
     * - decoding: unused
2503
     */
2504
    int min_prediction_order;
2505

    
2506
    /**
2507
     * - encoding: Set by user.
2508
     * - decoding: unused
2509
     */
2510
    int max_prediction_order;
2511

    
2512
    /**
2513
     * search method for selecting prediction order
2514
     * - encoding: Set by user.
2515
     * - decoding: unused
2516
     */
2517
    int prediction_order_method;
2518

    
2519
    /**
2520
     * - encoding: Set by user.
2521
     * - decoding: unused
2522
     */
2523
    int min_partition_order;
2524

    
2525
    /**
2526
     * - encoding: Set by user.
2527
     * - decoding: unused
2528
     */
2529
    int max_partition_order;
2530

    
2531
    /**
2532
     * GOP timecode frame start number, in non drop frame format
2533
     * - encoding: Set by user.
2534
     * - decoding: unused
2535
     */
2536
    int64_t timecode_frame_start;
2537

    
2538
#if FF_API_REQUEST_CHANNELS
2539
    /**
2540
     * Decoder should decode to this many channels if it can (0 for default)
2541
     * - encoding: unused
2542
     * - decoding: Set by user.
2543
     * @deprecated Deprecated in favor of request_channel_layout.
2544
     */
2545
    int request_channels;
2546
#endif
2547

    
2548
    /**
2549
     * Percentage of dynamic range compression to be applied by the decoder.
2550
     * The default value is 1.0, corresponding to full compression.
2551
     * - encoding: unused
2552
     * - decoding: Set by user.
2553
     */
2554
    float drc_scale;
2555

    
2556
    /**
2557
     * opaque 64bit number (generally a PTS) that will be reordered and
2558
     * output in AVFrame.reordered_opaque
2559
     * @deprecated in favor of pkt_pts
2560
     * - encoding: unused
2561
     * - decoding: Set by user.
2562
     */
2563
    int64_t reordered_opaque;
2564

    
2565
    /**
2566
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2567
     * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2568
     * - encoding: set by user.
2569
     * - decoding: set by libavcodec.
2570
     */
2571
    int bits_per_raw_sample;
2572

    
2573
    /**
2574
     * Audio channel layout.
2575
     * - encoding: set by user.
2576
     * - decoding: set by libavcodec.
2577
     */
2578
    int64_t channel_layout;
2579

    
2580
    /**
2581
     * Request decoder to use this channel layout if it can (0 for default)
2582
     * - encoding: unused
2583
     * - decoding: Set by user.
2584
     */
2585
    int64_t request_channel_layout;
2586

    
2587
    /**
2588
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2589
     * - encoding: Set by user.
2590
     * - decoding: unused.
2591
     */
2592
    float rc_max_available_vbv_use;
2593

    
2594
    /**
2595
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2596
     * - encoding: Set by user.
2597
     * - decoding: unused.
2598
     */
2599
    float rc_min_vbv_overflow_use;
2600

    
2601
    /**
2602
     * Hardware accelerator in use
2603
     * - encoding: unused.
2604
     * - decoding: Set by libavcodec
2605
     */
2606
    struct AVHWAccel *hwaccel;
2607

    
2608
    /**
2609
     * For some codecs, the time base is closer to the field rate than the frame rate.
2610
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2611
     * if no telecine is used ...
2612
     *
2613
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2614
     */
2615
    int ticks_per_frame;
2616

    
2617
    /**
2618
     * Hardware accelerator context.
2619
     * For some hardware accelerators, a global context needs to be
2620
     * provided by the user. In that case, this holds display-dependent
2621
     * data FFmpeg cannot instantiate itself. Please refer to the
2622
     * FFmpeg HW accelerator documentation to know how to fill this
2623
     * is. e.g. for VA API, this is a struct vaapi_context.
2624
     * - encoding: unused
2625
     * - decoding: Set by user
2626
     */
2627
    void *hwaccel_context;
2628

    
2629
    /**
2630
     * Chromaticity coordinates of the source primaries.
2631
     * - encoding: Set by user
2632
     * - decoding: Set by libavcodec
2633
     */
2634
    enum AVColorPrimaries color_primaries;
2635

    
2636
    /**
2637
     * Color Transfer Characteristic.
2638
     * - encoding: Set by user
2639
     * - decoding: Set by libavcodec
2640
     */
2641
    enum AVColorTransferCharacteristic color_trc;
2642

    
2643
    /**
2644
     * YUV colorspace type.
2645
     * - encoding: Set by user
2646
     * - decoding: Set by libavcodec
2647
     */
2648
    enum AVColorSpace colorspace;
2649

    
2650
    /**
2651
     * MPEG vs JPEG YUV range.
2652
     * - encoding: Set by user
2653
     * - decoding: Set by libavcodec
2654
     */
2655
    enum AVColorRange color_range;
2656

    
2657
    /**
2658
     * This defines the location of chroma samples.
2659
     * - encoding: Set by user
2660
     * - decoding: Set by libavcodec
2661
     */
2662
    enum AVChromaLocation chroma_sample_location;
2663

    
2664
    /**
2665
     * The codec may call this to execute several independent things.
2666
     * It will return only after finishing all tasks.
2667
     * The user may replace this with some multithreaded implementation,
2668
     * the default implementation will execute the parts serially.
2669
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2670
     * @param c context passed also to func
2671
     * @param count the number of things to execute
2672
     * @param arg2 argument passed unchanged to func
2673
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2674
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2675
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2676
     *             two instances of func executing at the same time will have the same threadnr.
2677
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2678
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2679
     * - encoding: Set by libavcodec, user can override.
2680
     * - decoding: Set by libavcodec, user can override.
2681
     */
2682
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2683

    
2684
    /**
2685
     * explicit P-frame weighted prediction analysis method
2686
     * 0: off
2687
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2688
     * 2: smart weighting (full fade detection analysis)
2689
     * - encoding: Set by user.
2690
     * - decoding: unused
2691
     */
2692
    int weighted_p_pred;
2693

    
2694
    /**
2695
     * AQ mode
2696
     * 0: Disabled
2697
     * 1: Variance AQ (complexity mask)
2698
     * 2: Auto-variance AQ (experimental)
2699
     * - encoding: Set by user
2700
     * - decoding: unused
2701
     */
2702
    int aq_mode;
2703

    
2704
    /**
2705
     * AQ strength
2706
     * Reduces blocking and blurring in flat and textured areas.
2707
     * - encoding: Set by user
2708
     * - decoding: unused
2709
     */
2710
    float aq_strength;
2711

    
2712
    /**
2713
     * PSY RD
2714
     * Strength of psychovisual optimization
2715
     * - encoding: Set by user
2716
     * - decoding: unused
2717
     */
2718
    float psy_rd;
2719

    
2720
    /**
2721
     * PSY trellis
2722
     * Strength of psychovisual optimization
2723
     * - encoding: Set by user
2724
     * - decoding: unused
2725
     */
2726
    float psy_trellis;
2727

    
2728
    /**
2729
     * RC lookahead
2730
     * Number of frames for frametype and ratecontrol lookahead
2731
     * - encoding: Set by user
2732
     * - decoding: unused
2733
     */
2734
    int rc_lookahead;
2735

    
2736
    /**
2737
     * Constant rate factor maximum
2738
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2739
     * than crf_max, even if doing so would violate VBV restrictions.
2740
     * - encoding: Set by user.
2741
     * - decoding: unused
2742
     */
2743
    float crf_max;
2744

    
2745
    int log_level_offset;
2746

    
2747
    /**
2748
     * Determines which LPC analysis algorithm to use.
2749
     * - encoding: Set by user
2750
     * - decoding: unused
2751
     */
2752
    enum AVLPCType lpc_type;
2753

    
2754
    /**
2755
     * Number of passes to use for Cholesky factorization during LPC analysis
2756
     * - encoding: Set by user
2757
     * - decoding: unused
2758
     */
2759
    int lpc_passes;
2760

    
2761
    /**
2762
     * Number of slices.
2763
     * Indicates number of picture subdivisions. Used for parallelized
2764
     * decoding.
2765
     * - encoding: Set by user
2766
     * - decoding: unused
2767
     */
2768
    int slices;
2769

    
2770
    /**
2771
     * Header containing style information for text subtitles.
2772
     * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2773
     * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2774
     * the Format line following. It shouldn't include any Dialogue line.
2775
     * - encoding: Set/allocated/freed by user (before avcodec_open())
2776
     * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2777
     */
2778
    uint8_t *subtitle_header;
2779
    int subtitle_header_size;
2780

    
2781
    /**
2782
     * Current packet as passed into the decoder, to avoid having
2783
     * to pass the packet into every function. Currently only valid
2784
     * inside lavc and get/release_buffer callbacks.
2785
     * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2786
     * - encoding: unused
2787
     */
2788
    AVPacket *pkt;
2789

    
2790
    /**
2791
     * Whether this is a copy of the context which had init() called on it.
2792
     * This is used by multithreading - shared tables and picture pointers
2793
     * should be freed from the original context only.
2794
     * - encoding: Set by libavcodec.
2795
     * - decoding: Set by libavcodec.
2796
     */
2797
    int is_copy;
2798

    
2799
    /**
2800
     * Which multithreading methods to use.
2801
     * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2802
     * so clients which cannot provide future frames should not use it.
2803
     *
2804
     * - encoding: Set by user, otherwise the default is used.
2805
     * - decoding: Set by user, otherwise the default is used.
2806
     */
2807
    int thread_type;
2808
#define FF_THREAD_FRAME   1 //< Decode more than one frame at once
2809
#define FF_THREAD_SLICE   2 //< Decode more than one part of a single frame at once
2810

    
2811
    /**
2812
     * Which multithreading methods are in use by the codec.
2813
     * - encoding: Set by libavcodec.
2814
     * - decoding: Set by libavcodec.
2815
     */
2816
    int active_thread_type;
2817

    
2818
    /**
2819
     * Set by the client if its custom get_buffer() callback can be called
2820
     * from another thread, which allows faster multithreaded decoding.
2821
     * draw_horiz_band() will be called from other threads regardless of this setting.
2822
     * Ignored if the default get_buffer() is used.
2823
     * - encoding: Set by user.
2824
     * - decoding: Set by user.
2825
     */
2826
    int thread_safe_callbacks;
2827

    
2828
    /**
2829
     * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2830
     * Used for compliant TS muxing.
2831
     * - encoding: Set by libavcodec.
2832
     * - decoding: unused.
2833
     */
2834
    uint64_t vbv_delay;
2835

    
2836
    /**
2837
     * Type of service that the audio stream conveys.
2838
     * - encoding: Set by user.
2839
     * - decoding: Set by libavcodec.
2840
     */
2841
    enum AVAudioServiceType audio_service_type;
2842

    
2843
    /**
2844
     * Current statistics for PTS correction.
2845
     * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2846
     * - encoding: unused
2847
     */
2848
    int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2849
    int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2850
    int64_t pts_correction_last_pts;       /// PTS of the last frame
2851
    int64_t pts_correction_last_dts;       /// DTS of the last frame
2852

    
2853
    /**
2854
     * desired sample format
2855
     * - encoding: Not used.
2856
     * - decoding: Set by user.
2857
     * Decoder will decode to this format if it can.
2858
     */
2859
    enum AVSampleFormat request_sample_fmt;
2860

    
2861
} AVCodecContext;
2862

    
2863
/**
2864
 * AVProfile.
2865
 */
2866
typedef struct AVProfile {
2867
    int profile;
2868
    const char *name; ///< short name for the profile
2869
} AVProfile;
2870

    
2871
/**
2872
 * AVCodec.
2873
 */
2874
typedef struct AVCodec {
2875
    /**
2876
     * Name of the codec implementation.
2877
     * The name is globally unique among encoders and among decoders (but an
2878
     * encoder and a decoder can share the same name).
2879
     * This is the primary way to find a codec from the user perspective.
2880
     */
2881
    const char *name;
2882
    enum AVMediaType type;
2883
    enum CodecID id;
2884
    int priv_data_size;
2885
    int (*init)(AVCodecContext *);
2886
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2887
    int (*close)(AVCodecContext *);
2888
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2889
    /**
2890
     * Codec capabilities.
2891
     * see CODEC_CAP_*
2892
     */
2893
    int capabilities;
2894
    struct AVCodec *next;
2895
    /**
2896
     * Flush buffers.
2897
     * Will be called when seeking
2898
     */
2899
    void (*flush)(AVCodecContext *);
2900
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2901
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2902
    /**
2903
     * Descriptive name for the codec, meant to be more human readable than name.
2904
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2905
     */
2906
    const char *long_name;
2907
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2908
    const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2909
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2910
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2911
    const AVClass *priv_class;              ///< AVClass for the private context
2912
    const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2913

    
2914
    /**
2915
     * @defgroup framethreading Frame-level threading support functions.
2916
     * @{
2917
     */
2918
    /**
2919
     * If defined, called on thread contexts when they are created.
2920
     * If the codec allocates writable tables in init(), re-allocate them here.
2921
     * priv_data will be set to a copy of the original.
2922
     */
2923
    int (*init_thread_copy)(AVCodecContext *);
2924
    /**
2925
     * Copy necessary context variables from a previous thread context to the current one.
2926
     * If not defined, the next thread will start automatically; otherwise, the codec
2927
     * must call ff_thread_finish_setup().
2928
     *
2929
     * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2930
     */
2931
    int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2932
    /** @} */
2933
} AVCodec;
2934

    
2935
/**
2936
 * AVHWAccel.
2937
 */
2938
typedef struct AVHWAccel {
2939
    /**
2940
     * Name of the hardware accelerated codec.
2941
     * The name is globally unique among encoders and among decoders (but an
2942
     * encoder and a decoder can share the same name).
2943
     */
2944
    const char *name;
2945

    
2946
    /**
2947
     * Type of codec implemented by the hardware accelerator.
2948
     *
2949
     * See AVMEDIA_TYPE_xxx
2950
     */
2951
    enum AVMediaType type;
2952

    
2953
    /**
2954
     * Codec implemented by the hardware accelerator.
2955
     *
2956
     * See CODEC_ID_xxx
2957
     */
2958
    enum CodecID id;
2959

    
2960
    /**
2961
     * Supported pixel format.
2962
     *
2963
     * Only hardware accelerated formats are supported here.
2964
     */
2965
    enum PixelFormat pix_fmt;
2966

    
2967
    /**
2968
     * Hardware accelerated codec capabilities.
2969
     * see FF_HWACCEL_CODEC_CAP_*
2970
     */
2971
    int capabilities;
2972

    
2973
    struct AVHWAccel *next;
2974

    
2975
    /**
2976
     * Called at the beginning of each frame or field picture.
2977
     *
2978
     * Meaningful frame information (codec specific) is guaranteed to
2979
     * be parsed at this point. This function is mandatory.
2980
     *
2981
     * Note that buf can be NULL along with buf_size set to 0.
2982
     * Otherwise, this means the whole frame is available at this point.
2983
     *
2984
     * @param avctx the codec context
2985
     * @param buf the frame data buffer base
2986
     * @param buf_size the size of the frame in bytes
2987
     * @return zero if successful, a negative value otherwise
2988
     */
2989
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2990

    
2991
    /**
2992
     * Callback for each slice.
2993
     *
2994
     * Meaningful slice information (codec specific) is guaranteed to
2995
     * be parsed at this point. This function is mandatory.
2996
     *
2997
     * @param avctx the codec context
2998
     * @param buf the slice data buffer base
2999
     * @param buf_size the size of the slice in bytes
3000
     * @return zero if successful, a negative value otherwise
3001
     */
3002
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3003

    
3004
    /**
3005
     * Called at the end of each frame or field picture.
3006
     *
3007
     * The whole picture is parsed at this point and can now be sent
3008
     * to the hardware accelerator. This function is mandatory.
3009
     *
3010
     * @param avctx the codec context
3011
     * @return zero if successful, a negative value otherwise
3012
     */
3013
    int (*end_frame)(AVCodecContext *avctx);
3014

    
3015
    /**
3016
     * Size of HW accelerator private data.
3017
     *
3018
     * Private data is allocated with av_mallocz() before
3019
     * AVCodecContext.get_buffer() and deallocated after
3020
     * AVCodecContext.release_buffer().
3021
     */
3022
    int priv_data_size;
3023
} AVHWAccel;
3024

    
3025
/**
3026
 * four components are given, that's all.
3027
 * the last component is alpha
3028
 */
3029
typedef struct AVPicture {
3030
    uint8_t *data[4];
3031
    int linesize[4];       ///< number of bytes per line
3032
} AVPicture;
3033

    
3034
#if FF_API_PALETTE_CONTROL
3035
/**
3036
 * AVPaletteControl
3037
 * This structure defines a method for communicating palette changes
3038
 * between and demuxer and a decoder.
3039
 *
3040
 * @deprecated Use AVPacket to send palette changes instead.
3041
 * This is totally broken.
3042
 */
3043
#define AVPALETTE_SIZE 1024
3044
#define AVPALETTE_COUNT 256
3045
typedef struct AVPaletteControl {
3046

    
3047
    /* Demuxer sets this to 1 to indicate the palette has changed;
3048
     * decoder resets to 0. */
3049
    int palette_changed;
3050

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

    
3057
} AVPaletteControl attribute_deprecated;
3058
#endif
3059

    
3060
enum AVSubtitleType {
3061
    SUBTITLE_NONE,
3062

    
3063
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3064

    
3065
    /**
3066
     * Plain text, the text field must be set by the decoder and is
3067
     * authoritative. ass and pict fields may contain approximations.
3068
     */
3069
    SUBTITLE_TEXT,
3070

    
3071
    /**
3072
     * Formatted text, the ass field must be set by the decoder and is
3073
     * authoritative. pict and text fields may contain approximations.
3074
     */
3075
    SUBTITLE_ASS,
3076
};
3077

    
3078
typedef struct AVSubtitleRect {
3079
    int x;         ///< top left corner  of pict, undefined when pict is not set
3080
    int y;         ///< top left corner  of pict, undefined when pict is not set
3081
    int w;         ///< width            of pict, undefined when pict is not set
3082
    int h;         ///< height           of pict, undefined when pict is not set
3083
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
3084

    
3085
    /**
3086
     * data+linesize for the bitmap of this subtitle.
3087
     * can be set for text/ass as well once they where rendered
3088
     */
3089
    AVPicture pict;
3090
    enum AVSubtitleType type;
3091

    
3092
    char *text;                     ///< 0 terminated plain UTF-8 text
3093

    
3094
    /**
3095
     * 0 terminated ASS/SSA compatible event line.
3096
     * The pressentation of this is unaffected by the other values in this
3097
     * struct.
3098
     */
3099
    char *ass;
3100
} AVSubtitleRect;
3101

    
3102
typedef struct AVSubtitle {
3103
    uint16_t format; /* 0 = graphics */
3104
    uint32_t start_display_time; /* relative to packet pts, in ms */
3105
    uint32_t end_display_time; /* relative to packet pts, in ms */
3106
    unsigned num_rects;
3107
    AVSubtitleRect **rects;
3108
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3109
} AVSubtitle;
3110

    
3111
/* packet functions */
3112

    
3113
/**
3114
 * @deprecated use NULL instead
3115
 */
3116
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3117

    
3118
/**
3119
 * Default packet destructor.
3120
 */
3121
void av_destruct_packet(AVPacket *pkt);
3122

    
3123
/**
3124
 * Initialize optional fields of a packet with default values.
3125
 *
3126
 * @param pkt packet
3127
 */
3128
void av_init_packet(AVPacket *pkt);
3129

    
3130
/**
3131
 * Allocate the payload of a packet and initialize its fields with
3132
 * default values.
3133
 *
3134
 * @param pkt packet
3135
 * @param size wanted payload size
3136
 * @return 0 if OK, AVERROR_xxx otherwise
3137
 */
3138
int av_new_packet(AVPacket *pkt, int size);
3139

    
3140
/**
3141
 * Reduce packet size, correctly zeroing padding
3142
 *
3143
 * @param pkt packet
3144
 * @param size new size
3145
 */
3146
void av_shrink_packet(AVPacket *pkt, int size);
3147

    
3148
/**
3149
 * Increase packet size, correctly zeroing padding
3150
 *
3151
 * @param pkt packet
3152
 * @param grow_by number of bytes by which to increase the size of the packet
3153
 */
3154
int av_grow_packet(AVPacket *pkt, int grow_by);
3155

    
3156
/**
3157
 * @warning This is a hack - the packet memory allocation stuff is broken. The
3158
 * packet is allocated if it was not really allocated.
3159
 */
3160
int av_dup_packet(AVPacket *pkt);
3161

    
3162
/**
3163
 * Free a packet.
3164
 *
3165
 * @param pkt packet to free
3166
 */
3167
void av_free_packet(AVPacket *pkt);
3168

    
3169
/**
3170
 * Allocate new information of a packet.
3171
 *
3172
 * @param pkt packet
3173
 * @param type side information type
3174
 * @param size side information size
3175
 * @return pointer to fresh allocated data or NULL otherwise
3176
 */
3177
uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3178
                                 int size);
3179

    
3180
/**
3181
 * Get side information from packet.
3182
 *
3183
 * @param pkt packet
3184
 * @param type desired side information type
3185
 * @param size pointer for side information size to store (optional)
3186
 * @return pointer to data if present or NULL otherwise
3187
 */
3188
uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3189
                                 int *size);
3190

    
3191
/* resample.c */
3192

    
3193
struct ReSampleContext;
3194
struct AVResampleContext;
3195

    
3196
typedef struct ReSampleContext ReSampleContext;
3197

    
3198
/**
3199
 *  Initialize audio resampling context.
3200
 *
3201
 * @param output_channels  number of output channels
3202
 * @param input_channels   number of input channels
3203
 * @param output_rate      output sample rate
3204
 * @param input_rate       input sample rate
3205
 * @param sample_fmt_out   requested output sample format
3206
 * @param sample_fmt_in    input sample format
3207
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3208
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3209
 * @param linear           if 1 then the used FIR filter will be linearly interpolated
3210
                           between the 2 closest, if 0 the closest will be used
3211
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3212
 * @return allocated ReSampleContext, NULL if error occured
3213
 */
3214
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3215
                                        int output_rate, int input_rate,
3216
                                        enum AVSampleFormat sample_fmt_out,
3217
                                        enum AVSampleFormat sample_fmt_in,
3218
                                        int filter_length, int log2_phase_count,
3219
                                        int linear, double cutoff);
3220

    
3221
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3222

    
3223
/**
3224
 * Free resample context.
3225
 *
3226
 * @param s a non-NULL pointer to a resample context previously
3227
 *          created with av_audio_resample_init()
3228
 */
3229
void audio_resample_close(ReSampleContext *s);
3230

    
3231

    
3232
/**
3233
 * Initialize an audio resampler.
3234
 * Note, if either rate is not an integer then simply scale both rates up so they are.
3235
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3236
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3237
 * @param linear If 1 then the used FIR filter will be linearly interpolated
3238
                 between the 2 closest, if 0 the closest will be used
3239
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3240
 */
3241
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3242

    
3243
/**
3244
 * Resample an array of samples using a previously configured context.
3245
 * @param src an array of unconsumed samples
3246
 * @param consumed the number of samples of src which have been consumed are returned here
3247
 * @param src_size the number of unconsumed samples available
3248
 * @param dst_size the amount of space in samples available in dst
3249
 * @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.
3250
 * @return the number of samples written in dst or -1 if an error occurred
3251
 */
3252
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3253

    
3254

    
3255
/**
3256
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3257
 * the resampler parameters, so no audible clicks or similar distortions occur
3258
 * @param compensation_distance distance in output samples over which the compensation should be performed
3259
 * @param sample_delta number of output samples which should be output less
3260
 *
3261
 * example: av_resample_compensate(c, 10, 500)
3262
 * here instead of 510 samples only 500 samples would be output
3263
 *
3264
 * note, due to rounding the actual compensation might be slightly different,
3265
 * especially if the compensation_distance is large and the in_rate used during init is small
3266
 */
3267
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3268
void av_resample_close(struct AVResampleContext *c);
3269

    
3270
/**
3271
 * Allocate memory for a picture.  Call avpicture_free() to free it.
3272
 *
3273
 * \see avpicture_fill()
3274
 *
3275
 * @param picture the picture to be filled in
3276
 * @param pix_fmt the format of the picture
3277
 * @param width the width of the picture
3278
 * @param height the height of the picture
3279
 * @return zero if successful, a negative value if not
3280
 */
3281
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3282

    
3283
/**
3284
 * Free a picture previously allocated by avpicture_alloc().
3285
 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3286
 * itself is not.
3287
 *
3288
 * @param picture the AVPicture to be freed
3289
 */
3290
void avpicture_free(AVPicture *picture);
3291

    
3292
/**
3293
 * Fill in the AVPicture fields.
3294
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3295
 * which points to the image data buffer. Depending on the specified picture
3296
 * format, one or multiple image data pointers and line sizes will be set.
3297
 * If a planar format is specified, several pointers will be set pointing to
3298
 * the different picture planes and the line sizes of the different planes
3299
 * will be stored in the lines_sizes array.
3300
 * Call with ptr == NULL to get the required size for the ptr buffer.
3301
 *
3302
 * To allocate the buffer and fill in the AVPicture fields in one call,
3303
 * use avpicture_alloc().
3304
 *
3305
 * @param picture AVPicture whose fields are to be filled in
3306
 * @param ptr Buffer which will contain or contains the actual image data
3307
 * @param pix_fmt The format in which the picture data is stored.
3308
 * @param width the width of the image in pixels
3309
 * @param height the height of the image in pixels
3310
 * @return size of the image data in bytes
3311
 */
3312
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3313
                   enum PixelFormat pix_fmt, int width, int height);
3314

    
3315
/**
3316
 * Copy pixel data from an AVPicture into a buffer.
3317
 * The data is stored compactly, without any gaps for alignment or padding
3318
 * which may be applied by avpicture_fill().
3319
 *
3320
 * \see avpicture_get_size()
3321
 *
3322
 * @param[in] src AVPicture containing image data
3323
 * @param[in] pix_fmt The format in which the picture data is stored.
3324
 * @param[in] width the width of the image in pixels.
3325
 * @param[in] height the height of the image in pixels.
3326
 * @param[out] dest A buffer into which picture data will be copied.
3327
 * @param[in] dest_size The size of 'dest'.
3328
 * @return The number of bytes written to dest, or a negative value (error code) on error.
3329
 */
3330
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3331
                     unsigned char *dest, int dest_size);
3332

    
3333
/**
3334
 * Calculate the size in bytes that a picture of the given width and height
3335
 * would occupy if stored in the given picture format.
3336
 * Note that this returns the size of a compact representation as generated
3337
 * by avpicture_layout(), which can be smaller than the size required for e.g.
3338
 * avpicture_fill().
3339
 *
3340
 * @param pix_fmt the given picture format
3341
 * @param width the width of the image
3342
 * @param height the height of the image
3343
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3344
 */
3345
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3346
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3347

    
3348
/**
3349
 * Return the short name for a pixel format.
3350
 *
3351
 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3352
 */
3353
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3354

    
3355
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3356

    
3357
/**
3358
 * Return a value representing the fourCC code associated to the
3359
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3360
 * found.
3361
 */
3362
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3363

    
3364
/**
3365
 * Put a string representing the codec tag codec_tag in buf.
3366
 *
3367
 * @param buf_size size in bytes of buf
3368
 * @return the length of the string that would have been generated if
3369
 * enough space had been available, excluding the trailing null
3370
 */
3371
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3372

    
3373
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3374
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3375
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3376
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3377
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3378
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3379

    
3380
/**
3381
 * Compute what kind of losses will occur when converting from one specific
3382
 * pixel format to another.
3383
 * When converting from one pixel format to another, information loss may occur.
3384
 * For example, when converting from RGB24 to GRAY, the color information will
3385
 * be lost. Similarly, other losses occur when converting from some formats to
3386
 * other formats. These losses can involve loss of chroma, but also loss of
3387
 * resolution, loss of color depth, loss due to the color space conversion, loss
3388
 * of the alpha bits or loss due to color quantization.
3389
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3390
 * which will occur when converting from one pixel format to another.
3391
 *
3392
 * @param[in] dst_pix_fmt destination pixel format
3393
 * @param[in] src_pix_fmt source pixel format
3394
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3395
 * @return Combination of flags informing you what kind of losses will occur.
3396
 */
3397
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3398
                             int has_alpha);
3399

    
3400
/**
3401
 * Find the best pixel format to convert to given a certain source pixel
3402
 * format.  When converting from one pixel format to another, information loss
3403
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3404
 * information will be lost. Similarly, other losses occur when converting from
3405
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3406
 * the given pixel formats should be used to suffer the least amount of loss.
3407
 * The pixel formats from which it chooses one, are determined by the
3408
 * pix_fmt_mask parameter.
3409
 *
3410
 * @code
3411
 * src_pix_fmt = PIX_FMT_YUV420P;
3412
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3413
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3414
 * @endcode
3415
 *
3416
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3417
 * @param[in] src_pix_fmt source pixel format
3418
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3419
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3420
 * @return The best pixel format to convert to or -1 if none was found.
3421
 */
3422
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3423
                              int has_alpha, int *loss_ptr);
3424

    
3425
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3426
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3427

    
3428
/**
3429
 * Tell if an image really has transparent alpha values.
3430
 * @return ored mask of FF_ALPHA_xxx constants
3431
 */
3432
int img_get_alpha_info(const AVPicture *src,
3433
                       enum PixelFormat pix_fmt, int width, int height);
3434

    
3435
/* deinterlace a picture */
3436
/* deinterlace - if not supported return -1 */
3437
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3438
                          enum PixelFormat pix_fmt, int width, int height);
3439

    
3440
/* external high level API */
3441

    
3442
/**
3443
 * If c is NULL, returns the first registered codec,
3444
 * if c is non-NULL, returns the next registered codec after c,
3445
 * or NULL if c is the last one.
3446
 */
3447
AVCodec *av_codec_next(AVCodec *c);
3448

    
3449
/**
3450
 * Return the LIBAVCODEC_VERSION_INT constant.
3451
 */
3452
unsigned avcodec_version(void);
3453

    
3454
/**
3455
 * Return the libavcodec build-time configuration.
3456
 */
3457
const char *avcodec_configuration(void);
3458

    
3459
/**
3460
 * Return the libavcodec license.
3461
 */
3462
const char *avcodec_license(void);
3463

    
3464
/**
3465
 * Initialize libavcodec.
3466
 * If called more than once, does nothing.
3467
 *
3468
 * @warning This function must be called before any other libavcodec
3469
 * function.
3470
 *
3471
 * @warning This function is not thread-safe.
3472
 */
3473
void avcodec_init(void);
3474

    
3475
/**
3476
 * Register the codec codec and initialize libavcodec.
3477
 *
3478
 * @see avcodec_init(), avcodec_register_all()
3479
 */
3480
void avcodec_register(AVCodec *codec);
3481

    
3482
/**
3483
 * Find a registered encoder with a matching codec ID.
3484
 *
3485
 * @param id CodecID of the requested encoder
3486
 * @return An encoder if one was found, NULL otherwise.
3487
 */
3488
AVCodec *avcodec_find_encoder(enum CodecID id);
3489

    
3490
/**
3491
 * Find a registered encoder with the specified name.
3492
 *
3493
 * @param name name of the requested encoder
3494
 * @return An encoder if one was found, NULL otherwise.
3495
 */
3496
AVCodec *avcodec_find_encoder_by_name(const char *name);
3497

    
3498
/**
3499
 * Find a registered decoder with a matching codec ID.
3500
 *
3501
 * @param id CodecID of the requested decoder
3502
 * @return A decoder if one was found, NULL otherwise.
3503
 */
3504
AVCodec *avcodec_find_decoder(enum CodecID id);
3505

    
3506
/**
3507
 * Find a registered decoder with the specified name.
3508
 *
3509
 * @param name name of the requested decoder
3510
 * @return A decoder if one was found, NULL otherwise.
3511
 */
3512
AVCodec *avcodec_find_decoder_by_name(const char *name);
3513
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3514

    
3515
/**
3516
 * Return a name for the specified profile, if available.
3517
 *
3518
 * @param codec the codec that is searched for the given profile
3519
 * @param profile the profile value for which a name is requested
3520
 * @return A name for the profile if found, NULL otherwise.
3521
 */
3522
const char *av_get_profile_name(const AVCodec *codec, int profile);
3523

    
3524
/**
3525
 * Set the fields of the given AVCodecContext to default values.
3526
 *
3527
 * @param s The AVCodecContext of which the fields should be set to default values.
3528
 */
3529
void avcodec_get_context_defaults(AVCodecContext *s);
3530

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

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

    
3539
/**
3540
 * Allocate an AVCodecContext and set its fields to default values.  The
3541
 * resulting struct can be deallocated by simply calling av_free().
3542
 *
3543
 * @return An AVCodecContext filled with default values or NULL on failure.
3544
 * @see avcodec_get_context_defaults
3545
 */
3546
AVCodecContext *avcodec_alloc_context(void);
3547

    
3548
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3549
 *  we WILL change its arguments and name a few times! */
3550
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3551

    
3552
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3553
 *  we WILL change its arguments and name a few times! */
3554
AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3555

    
3556
/**
3557
 * Copy the settings of the source AVCodecContext into the destination
3558
 * AVCodecContext. The resulting destination codec context will be
3559
 * unopened, i.e. you are required to call avcodec_open() before you
3560
 * can use this AVCodecContext to decode/encode video/audio data.
3561
 *
3562
 * @param dest target codec context, should be initialized with
3563
 *             avcodec_alloc_context(), but otherwise uninitialized
3564
 * @param src source codec context
3565
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3566
 */
3567
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3568

    
3569
/**
3570
 * Set the fields of the given AVFrame to default values.
3571
 *
3572
 * @param pic The AVFrame of which the fields should be set to default values.
3573
 */
3574
void avcodec_get_frame_defaults(AVFrame *pic);
3575

    
3576
/**
3577
 * Allocate an AVFrame and set its fields to default values.  The resulting
3578
 * struct can be deallocated by simply calling av_free().
3579
 *
3580
 * @return An AVFrame filled with default values or NULL on failure.
3581
 * @see avcodec_get_frame_defaults
3582
 */
3583
AVFrame *avcodec_alloc_frame(void);
3584

    
3585
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3586
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3587
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3588

    
3589
/**
3590
 * Return the amount of padding in pixels which the get_buffer callback must
3591
 * provide around the edge of the image for codecs which do not have the
3592
 * CODEC_FLAG_EMU_EDGE flag.
3593
 *
3594
 * @return Required padding in pixels.
3595
 */
3596
unsigned avcodec_get_edge_width(void);
3597
/**
3598
 * Modify width and height values so that they will result in a memory
3599
 * buffer that is acceptable for the codec if you do not use any horizontal
3600
 * padding.
3601
 *
3602
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3603
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3604
 * according to avcodec_get_edge_width() before.
3605
 */
3606
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3607
/**
3608
 * Modify width and height values so that they will result in a memory
3609
 * buffer that is acceptable for the codec if you also ensure that all
3610
 * line sizes are a multiple of the respective linesize_align[i].
3611
 *
3612
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3613
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3614
 * according to avcodec_get_edge_width() before.
3615
 */
3616
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3617
                               int linesize_align[4]);
3618

    
3619
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3620

    
3621
#if FF_API_THREAD_INIT
3622
/**
3623
 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3624
 */
3625
attribute_deprecated
3626
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3627
#endif
3628

    
3629
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3630
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3631
//FIXME func typedef
3632

    
3633
/**
3634
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3635
 * function the context has to be allocated.
3636
 *
3637
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3638
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3639
 * retrieving a codec.
3640
 *
3641
 * @warning This function is not thread safe!
3642
 *
3643
 * @code
3644
 * avcodec_register_all();
3645
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3646
 * if (!codec)
3647
 *     exit(1);
3648
 *
3649
 * context = avcodec_alloc_context();
3650
 *
3651
 * if (avcodec_open(context, codec) < 0)
3652
 *     exit(1);
3653
 * @endcode
3654
 *
3655
 * @param avctx The context which will be set up to use the given codec.
3656
 * @param codec The codec to use within the context.
3657
 * @return zero on success, a negative value on error
3658
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3659
 */
3660
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3661

    
3662
/**
3663
 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3664
 * Some decoders may support multiple frames in a single AVPacket, such
3665
 * decoders would then just decode the first frame. In this case,
3666
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3667
 * the remaining data in order to decode the second frame etc.
3668
 * If no frame
3669
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3670
 * decompressed frame size in bytes.
3671
 *
3672
 * @warning You must set frame_size_ptr to the allocated size of the
3673
 * output buffer before calling avcodec_decode_audio3().
3674
 *
3675
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3676
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3677
 * bits at once and could read over the end.
3678
 *
3679
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3680
 * no overreading happens for damaged MPEG streams.
3681
 *
3682
 * @note You might have to align the input buffer avpkt->data and output buffer
3683
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3684
 * necessary at all, on others it won't work at all if not aligned and on others
3685
 * it will work but it will have an impact on performance.
3686
 *
3687
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3688
 * samples should be 16 byte aligned unless the CPU doesn't need it
3689
 * (AltiVec and SSE do).
3690
 *
3691
 * @param avctx the codec context
3692
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3693
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3694
 * @param[in] avpkt The input AVPacket containing the input buffer.
3695
 *            You can create such packet with av_init_packet() and by then setting
3696
 *            data and size, some decoders might in addition need other fields.
3697
 *            All decoders are designed to use the least fields possible though.
3698
 * @return On error a negative value is returned, otherwise the number of bytes
3699
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3700
 */
3701
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3702
                         int *frame_size_ptr,
3703
                         AVPacket *avpkt);
3704

    
3705
/**
3706
 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3707
 * Some decoders may support multiple frames in a single AVPacket, such
3708
 * decoders would then just decode the first frame.
3709
 *
3710
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3711
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3712
 * bits at once and could read over the end.
3713
 *
3714
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3715
 * no overreading happens for damaged MPEG streams.
3716
 *
3717
 * @note You might have to align the input buffer avpkt->data.
3718
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3719
 * necessary at all, on others it won't work at all if not aligned and on others
3720
 * it will work but it will have an impact on performance.
3721
 *
3722
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3723
 *
3724
 * @note Some codecs have a delay between input and output, these need to be
3725
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3726
 *
3727
 * @param avctx the codec context
3728
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3729
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3730
 *             allocate memory for the actual bitmap.
3731
 *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3732
 *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3733
 *                   decodes and the decoder tells the user once it does not need the data anymore,
3734
 *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3735
 *
3736
 * @param[in] avpkt The input AVpacket containing the input buffer.
3737
 *            You can create such packet with av_init_packet() and by then setting
3738
 *            data and size, some decoders might in addition need other fields like
3739
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3740
 *            fields possible.
3741
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3742
 * @return On error a negative value is returned, otherwise the number of bytes
3743
 * used or zero if no frame could be decompressed.
3744
 */
3745
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3746
                         int *got_picture_ptr,
3747
                         AVPacket *avpkt);
3748

    
3749
/**
3750
 * Decode a subtitle message.
3751
 * Return a negative value on error, otherwise return the number of bytes used.
3752
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3753
 * Otherwise, the subtitle is stored in *sub.
3754
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3755
 * simplicity, because the performance difference is expect to be negligible
3756
 * and reusing a get_buffer written for video codecs would probably perform badly
3757
 * due to a potentially very different allocation pattern.
3758
 *
3759
 * @param avctx the codec context
3760
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3761
                   freed with avsubtitle_free if *got_sub_ptr is set.
3762
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3763
 * @param[in] avpkt The input AVPacket containing the input buffer.
3764
 */
3765
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3766
                            int *got_sub_ptr,
3767
                            AVPacket *avpkt);
3768

    
3769
/**
3770
 * Frees all allocated data in the given subtitle struct.
3771
 *
3772
 * @param sub AVSubtitle to free.
3773
 */
3774
void avsubtitle_free(AVSubtitle *sub);
3775

    
3776
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3777
                        int *data_size_ptr,
3778
                        uint8_t *buf, int buf_size);
3779

    
3780
/**
3781
 * Encode an audio frame from samples into buf.
3782
 *
3783
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3784
 * However, for PCM audio the user will know how much space is needed
3785
 * because it depends on the value passed in buf_size as described
3786
 * below. In that case a lower value can be used.
3787
 *
3788
 * @param avctx the codec context
3789
 * @param[out] buf the output buffer
3790
 * @param[in] buf_size the output buffer size
3791
 * @param[in] samples the input buffer containing the samples
3792
 * The number of samples read from this buffer is frame_size*channels,
3793
 * both of which are defined in avctx.
3794
 * For PCM audio the number of samples read from samples is equal to
3795
 * buf_size * input_sample_size / output_sample_size.
3796
 * @return On error a negative value is returned, on success zero or the number
3797
 * of bytes used to encode the data read from the input buffer.
3798
 */
3799
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3800
                         const short *samples);
3801

    
3802
/**
3803
 * Encode a video frame from pict into buf.
3804
 * The input picture should be
3805
 * stored using a specific format, namely avctx.pix_fmt.
3806
 *
3807
 * @param avctx the codec context
3808
 * @param[out] buf the output buffer for the bitstream of encoded frame
3809
 * @param[in] buf_size the size of the output buffer in bytes
3810
 * @param[in] pict the input picture to encode
3811
 * @return On error a negative value is returned, on success zero or the number
3812
 * of bytes used from the output buffer.
3813
 */
3814
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3815
                         const AVFrame *pict);
3816
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3817
                            const AVSubtitle *sub);
3818

    
3819
int avcodec_close(AVCodecContext *avctx);
3820

    
3821
/**
3822
 * Register all the codecs, parsers and bitstream filters which were enabled at
3823
 * configuration time. If you do not call this function you can select exactly
3824
 * which formats you want to support, by using the individual registration
3825
 * functions.
3826
 *
3827
 * @see avcodec_register
3828
 * @see av_register_codec_parser
3829
 * @see av_register_bitstream_filter
3830
 */
3831
void avcodec_register_all(void);
3832

    
3833
/**
3834
 * Flush buffers, should be called when seeking or when switching to a different stream.
3835
 */
3836
void avcodec_flush_buffers(AVCodecContext *avctx);
3837

    
3838
void avcodec_default_free_buffers(AVCodecContext *s);
3839

    
3840
/* misc useful functions */
3841

    
3842
#if FF_API_OLD_FF_PICT_TYPES
3843
/**
3844
 * Return a single letter to describe the given picture type pict_type.
3845
 *
3846
 * @param[in] pict_type the picture type
3847
 * @return A single character representing the picture type.
3848
 * @deprecated Use av_get_picture_type_char() instead.
3849
 */
3850
attribute_deprecated
3851
char av_get_pict_type_char(int pict_type);
3852
#endif
3853

    
3854
/**
3855
 * Return codec bits per sample.
3856
 *
3857
 * @param[in] codec_id the codec
3858
 * @return Number of bits per sample or zero if unknown for the given codec.
3859
 */
3860
int av_get_bits_per_sample(enum CodecID codec_id);
3861

    
3862
#if FF_API_OLD_SAMPLE_FMT
3863
/**
3864
 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3865
 */
3866
attribute_deprecated
3867
int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3868
#endif
3869

    
3870
/* frame parsing */
3871
typedef struct AVCodecParserContext {
3872
    void *priv_data;
3873
    struct AVCodecParser *parser;
3874
    int64_t frame_offset; /* offset of the current frame */
3875
    int64_t cur_offset; /* current offset
3876
                           (incremented by each av_parser_parse()) */
3877
    int64_t next_frame_offset; /* offset of the next frame */
3878
    /* video info */
3879
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3880
    /**
3881
     * This field is used for proper frame duration computation in lavf.
3882
     * It signals, how much longer the frame duration of the current frame
3883
     * is compared to normal frame duration.
3884
     *
3885
     * frame_duration = (1 + repeat_pict) * time_base
3886
     *
3887
     * It is used by codecs like H.264 to display telecined material.
3888
     */
3889
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3890
    int64_t pts;     /* pts of the current frame */
3891
    int64_t dts;     /* dts of the current frame */
3892

    
3893
    /* private data */
3894
    int64_t last_pts;
3895
    int64_t last_dts;
3896
    int fetch_timestamp;
3897

    
3898
#define AV_PARSER_PTS_NB 4
3899
    int cur_frame_start_index;
3900
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3901
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3902
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3903

    
3904
    int flags;
3905
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3906
#define PARSER_FLAG_ONCE                      0x0002
3907
/// Set if the parser has a valid file offset
3908
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
3909

    
3910
    int64_t offset;      ///< byte offset from starting packet start
3911
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3912

    
3913
    /*!
3914
     * Set by parser to 1 for key frames and 0 for non-key frames.
3915
     * It is initialized to -1, so if the parser doesn't set this flag,
3916
     * old-style fallback using FF_I_TYPE picture type as key frames
3917
     * will be used.
3918
     */
3919
    int key_frame;
3920

    
3921
    /**
3922
     * Time difference in stream time base units from the pts of this
3923
     * packet to the point at which the output from the decoder has converged
3924
     * independent from the availability of previous frames. That is, the
3925
     * frames are virtually identical no matter if decoding started from
3926
     * the very first frame or from this keyframe.
3927
     * Is AV_NOPTS_VALUE if unknown.
3928
     * This field is not the display duration of the current frame.
3929
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3930
     * set.
3931
     *
3932
     * The purpose of this field is to allow seeking in streams that have no
3933
     * keyframes in the conventional sense. It corresponds to the
3934
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3935
     * essential for some types of subtitle streams to ensure that all
3936
     * subtitles are correctly displayed after seeking.
3937
     */
3938
    int64_t convergence_duration;
3939

    
3940
    // Timestamp generation support:
3941
    /**
3942
     * Synchronization point for start of timestamp generation.
3943
     *
3944
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3945
     * (default).
3946
     *
3947
     * For example, this corresponds to presence of H.264 buffering period
3948
     * SEI message.
3949
     */
3950
    int dts_sync_point;
3951

    
3952
    /**
3953
     * Offset of the current timestamp against last timestamp sync point in
3954
     * units of AVCodecContext.time_base.
3955
     *
3956
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3957
     * contain a valid timestamp offset.
3958
     *
3959
     * Note that the timestamp of sync point has usually a nonzero
3960
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3961
     * the next frame after timestamp sync point will be usually 1.
3962
     *
3963
     * For example, this corresponds to H.264 cpb_removal_delay.
3964
     */
3965
    int dts_ref_dts_delta;
3966

    
3967
    /**
3968
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3969
     *
3970
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3971
     * contain valid non-negative timestamp delta (presentation time of a frame
3972
     * must not lie in the past).
3973
     *
3974
     * This delay represents the difference between decoding and presentation
3975
     * time of the frame.
3976
     *
3977
     * For example, this corresponds to H.264 dpb_output_delay.
3978
     */
3979
    int pts_dts_delta;
3980

    
3981
    /**
3982
     * Position of the packet in file.
3983
     *
3984
     * Analogous to cur_frame_pts/dts
3985
     */
3986
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3987

    
3988
    /**
3989
     * Byte position of currently parsed frame in stream.
3990
     */
3991
    int64_t pos;
3992

    
3993
    /**
3994
     * Previous frame byte position.
3995
     */
3996
    int64_t last_pos;
3997
} AVCodecParserContext;
3998

    
3999
typedef struct AVCodecParser {
4000
    int codec_ids[5]; /* several codec IDs are permitted */
4001
    int priv_data_size;
4002
    int (*parser_init)(AVCodecParserContext *s);
4003
    int (*parser_parse)(AVCodecParserContext *s,
4004
                        AVCodecContext *avctx,
4005
                        const uint8_t **poutbuf, int *poutbuf_size,
4006
                        const uint8_t *buf, int buf_size);
4007
    void (*parser_close)(AVCodecParserContext *s);
4008
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4009
    struct AVCodecParser *next;
4010
} AVCodecParser;
4011

    
4012
AVCodecParser *av_parser_next(AVCodecParser *c);
4013

    
4014
void av_register_codec_parser(AVCodecParser *parser);
4015
AVCodecParserContext *av_parser_init(int codec_id);
4016

    
4017
/**
4018
 * Parse a packet.
4019
 *
4020
 * @param s             parser context.
4021
 * @param avctx         codec context.
4022
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4023
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4024
 * @param buf           input buffer.
4025
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4026
 * @param pts           input presentation timestamp.
4027
 * @param dts           input decoding timestamp.
4028
 * @param pos           input byte position in stream.
4029
 * @return the number of bytes of the input bitstream used.
4030
 *
4031
 * Example:
4032
 * @code
4033
 *   while(in_len){
4034
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4035
 *                                        in_data, in_len,
4036
 *                                        pts, dts, pos);
4037
 *       in_data += len;
4038
 *       in_len  -= len;
4039
 *
4040
 *       if(size)
4041
 *          decode_frame(data, size);
4042
 *   }
4043
 * @endcode
4044
 */
4045
int av_parser_parse2(AVCodecParserContext *s,
4046
                     AVCodecContext *avctx,
4047
                     uint8_t **poutbuf, int *poutbuf_size,
4048
                     const uint8_t *buf, int buf_size,
4049
                     int64_t pts, int64_t dts,
4050
                     int64_t pos);
4051

    
4052
int av_parser_change(AVCodecParserContext *s,
4053
                     AVCodecContext *avctx,
4054
                     uint8_t **poutbuf, int *poutbuf_size,
4055
                     const uint8_t *buf, int buf_size, int keyframe);
4056
void av_parser_close(AVCodecParserContext *s);
4057

    
4058

    
4059
typedef struct AVBitStreamFilterContext {
4060
    void *priv_data;
4061
    struct AVBitStreamFilter *filter;
4062
    AVCodecParserContext *parser;
4063
    struct AVBitStreamFilterContext *next;
4064
} AVBitStreamFilterContext;
4065

    
4066

    
4067
typedef struct AVBitStreamFilter {
4068
    const char *name;
4069
    int priv_data_size;
4070
    int (*filter)(AVBitStreamFilterContext *bsfc,
4071
                  AVCodecContext *avctx, const char *args,
4072
                  uint8_t **poutbuf, int *poutbuf_size,
4073
                  const uint8_t *buf, int buf_size, int keyframe);
4074
    void (*close)(AVBitStreamFilterContext *bsfc);
4075
    struct AVBitStreamFilter *next;
4076
} AVBitStreamFilter;
4077

    
4078
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4079
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4080
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4081
                               AVCodecContext *avctx, const char *args,
4082
                               uint8_t **poutbuf, int *poutbuf_size,
4083
                               const uint8_t *buf, int buf_size, int keyframe);
4084
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4085

    
4086
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4087

    
4088
/* memory */
4089

    
4090
/**
4091
 * Reallocate the given block if it is not large enough, otherwise do nothing.
4092
 *
4093
 * @see av_realloc
4094
 */
4095
void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4096

    
4097
/**
4098
 * Allocate a buffer, reusing the given one if large enough.
4099
 *
4100
 * Contrary to av_fast_realloc the current buffer contents might not be
4101
 * preserved and on error the old buffer is freed, thus no special
4102
 * handling to avoid memleaks is necessary.
4103
 *
4104
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4105
 * @param size size of the buffer *ptr points to
4106
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4107
 *                 *size 0 if an error occurred.
4108
 */
4109
void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4110

    
4111
/**
4112
 * Copy image src to dst. Wraps av_picture_data_copy() above.
4113
 */
4114
void av_picture_copy(AVPicture *dst, const AVPicture *src,
4115
                     enum PixelFormat pix_fmt, int width, int height);
4116

    
4117
/**
4118
 * Crop image top and left side.
4119
 */
4120
int av_picture_crop(AVPicture *dst, const AVPicture *src,
4121
                    enum PixelFormat pix_fmt, int top_band, int left_band);
4122

    
4123
/**
4124
 * Pad image.
4125
 */
4126
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4127
            int padtop, int padbottom, int padleft, int padright, int *color);
4128

    
4129
/**
4130
 * Encode extradata length to a buffer. Used by xiph codecs.
4131
 *
4132
 * @param s buffer to write to; must be at least (v/255+1) bytes long
4133
 * @param v size of extradata in bytes
4134
 * @return number of bytes written to the buffer.
4135
 */
4136
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4137

    
4138
/**
4139
 * Logs a generic warning message about a missing feature. This function is
4140
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4141
 * only, and would normally not be used by applications.
4142
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4143
 * a pointer to an AVClass struct
4144
 * @param[in] feature string containing the name of the missing feature
4145
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4146
 * If want_sample is non-zero, additional verbage will be added to the log
4147
 * message which tells the user how to report samples to the development
4148
 * mailing list.
4149
 */
4150
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4151

    
4152
/**
4153
 * Log a generic warning message asking for a sample. This function is
4154
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4155
 * only, and would normally not be used by applications.
4156
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4157
 * a pointer to an AVClass struct
4158
 * @param[in] msg string containing an optional message, or NULL if no message
4159
 */
4160
void av_log_ask_for_sample(void *avc, const char *msg, ...);
4161

    
4162
/**
4163
 * Register the hardware accelerator hwaccel.
4164
 */
4165
void av_register_hwaccel(AVHWAccel *hwaccel);
4166

    
4167
/**
4168
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4169
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4170
 * after hwaccel, or NULL if hwaccel is the last one.
4171
 */
4172
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4173

    
4174

    
4175
/**
4176
 * Lock operation used by lockmgr
4177
 */
4178
enum AVLockOp {
4179
  AV_LOCK_CREATE,  ///< Create a mutex
4180
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4181
  AV_LOCK_RELEASE, ///< Unlock the mutex
4182
  AV_LOCK_DESTROY, ///< Free mutex resources
4183
};
4184

    
4185
/**
4186
 * Register a user provided lock manager supporting the operations
4187
 * specified by AVLockOp. mutex points to a (void *) where the
4188
 * lockmgr should store/get a pointer to a user allocated mutex. It's
4189
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4190
 *
4191
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4192
 *           callback during the call to av_lockmgr_register().
4193
 *           Thus, the application must be prepared to handle that.
4194
 *           If cb is set to NULL the lockmgr will be unregistered.
4195
 *           Also note that during unregistration the previously registered
4196
 *           lockmgr callback may also be invoked.
4197
 */
4198
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4199

    
4200
#endif /* AVCODEC_AVCODEC_H */