Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 18ded93a

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
     * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1017
     * - encoding: unused\
1018
     * - decoding: Read by user.\
1019
     */\
1020
    AVRational sample_aspect_ratio;\
1021
\
1022
    /**\
1023
     * width and height of the video frame\
1024
     * - encoding: unused\
1025
     * - decoding: Read by user.\
1026
     */\
1027
    int width, height;\
1028
\
1029
    /**\
1030
     * format of the frame, -1 if unknown or unset\
1031
     * It should be cast to the corresponding enum (enum PixelFormat\
1032
     * for video, enum AVSampleFormat for audio)\
1033
     * - encoding: unused\
1034
     * - decoding: Read by user.\
1035
     */\
1036
    int format;\
1037

    
1038

    
1039
#define FF_QSCALE_TYPE_MPEG1 0
1040
#define FF_QSCALE_TYPE_MPEG2 1
1041
#define FF_QSCALE_TYPE_H264  2
1042
#define FF_QSCALE_TYPE_VP56  3
1043

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

    
1049
#if FF_API_OLD_FF_PICT_TYPES
1050
/* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
1051
#define FF_I_TYPE  AV_PICTURE_TYPE_I  ///< Intra
1052
#define FF_P_TYPE  AV_PICTURE_TYPE_P  ///< Predicted
1053
#define FF_B_TYPE  AV_PICTURE_TYPE_B  ///< Bi-dir predicted
1054
#define FF_S_TYPE  AV_PICTURE_TYPE_S  ///< S(GMC)-VOP MPEG4
1055
#define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
1056
#define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
1057
#define FF_BI_TYPE AV_PICTURE_TYPE_BI
1058
#endif
1059

    
1060
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
1061
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1062
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1063
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1064

    
1065
enum AVPacketSideDataType {
1066
    AV_PKT_DATA_PALETTE,
1067
};
1068

    
1069
typedef struct AVPacket {
1070
    /**
1071
     * Presentation timestamp in AVStream->time_base units; the time at which
1072
     * the decompressed packet will be presented to the user.
1073
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1074
     * pts MUST be larger or equal to dts as presentation cannot happen before
1075
     * decompression, unless one wants to view hex dumps. Some formats misuse
1076
     * the terms dts and pts/cts to mean something different. Such timestamps
1077
     * must be converted to true pts/dts before they are stored in AVPacket.
1078
     */
1079
    int64_t pts;
1080
    /**
1081
     * Decompression timestamp in AVStream->time_base units; the time at which
1082
     * the packet is decompressed.
1083
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1084
     */
1085
    int64_t dts;
1086
    uint8_t *data;
1087
    int   size;
1088
    int   stream_index;
1089
    int   flags;
1090
    /**
1091
     * Additional packet data that can be provided by the container.
1092
     * Packet can contain several types of side information.
1093
     */
1094
    struct {
1095
        uint8_t *data;
1096
        int      size;
1097
        enum AVPacketSideDataType type;
1098
    } *side_data;
1099
    int side_data_elems;
1100

    
1101
    /**
1102
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
1103
     * Equals next_pts - this_pts in presentation order.
1104
     */
1105
    int   duration;
1106
    void  (*destruct)(struct AVPacket *);
1107
    void  *priv;
1108
    int64_t pos;                            ///< byte position in stream, -1 if unknown
1109

    
1110
    /**
1111
     * Time difference in AVStream->time_base units from the pts of this
1112
     * packet to the point at which the output from the decoder has converged
1113
     * independent from the availability of previous frames. That is, the
1114
     * frames are virtually identical no matter if decoding started from
1115
     * the very first frame or from this keyframe.
1116
     * Is AV_NOPTS_VALUE if unknown.
1117
     * This field is not the display duration of the current packet.
1118
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1119
     * set.
1120
     *
1121
     * The purpose of this field is to allow seeking in streams that have no
1122
     * keyframes in the conventional sense. It corresponds to the
1123
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1124
     * essential for some types of subtitle streams to ensure that all
1125
     * subtitles are correctly displayed after seeking.
1126
     */
1127
    int64_t convergence_duration;
1128
} AVPacket;
1129
#define AV_PKT_FLAG_KEY   0x0001
1130

    
1131
/**
1132
 * Audio Video Frame.
1133
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1134
 * bumps.
1135
 * Removal, reordering and changes to existing fields require a major
1136
 * version bump. No fields should be added into AVFrame before or after
1137
 * FF_COMMON_FRAME!
1138
 * sizeof(AVFrame) must not be used outside libav*.
1139
 */
1140
typedef struct AVFrame {
1141
    FF_COMMON_FRAME
1142
} AVFrame;
1143

    
1144
/**
1145
 * main external API structure.
1146
 * New fields can be added to the end with minor version bumps.
1147
 * Removal, reordering and changes to existing fields require a major
1148
 * version bump.
1149
 * sizeof(AVCodecContext) must not be used outside libav*.
1150
 */
1151
typedef struct AVCodecContext {
1152
    /**
1153
     * information on struct for av_log
1154
     * - set by avcodec_alloc_context
1155
     */
1156
    const AVClass *av_class;
1157
    /**
1158
     * the average bitrate
1159
     * - encoding: Set by user; unused for constant quantizer encoding.
1160
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1161
     */
1162
    int bit_rate;
1163

    
1164
    /**
1165
     * number of bits the bitstream is allowed to diverge from the reference.
1166
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1167
     * - encoding: Set by user; unused for constant quantizer encoding.
1168
     * - decoding: unused
1169
     */
1170
    int bit_rate_tolerance;
1171

    
1172
    /**
1173
     * CODEC_FLAG_*.
1174
     * - encoding: Set by user.
1175
     * - decoding: Set by user.
1176
     */
1177
    int flags;
1178

    
1179
    /**
1180
     * Some codecs need additional format info. It is stored here.
1181
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1182
     * specific codec MUST set it correctly otherwise stream copy breaks.
1183
     * In general use of this field by muxers is not recommanded.
1184
     * - encoding: Set by libavcodec.
1185
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1186
     */
1187
    int sub_id;
1188

    
1189
    /**
1190
     * Motion estimation algorithm used for video coding.
1191
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1192
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1193
     * - encoding: MUST be set by user.
1194
     * - decoding: unused
1195
     */
1196
    int me_method;
1197

    
1198
    /**
1199
     * some codecs need / can use extradata like Huffman tables.
1200
     * mjpeg: Huffman tables
1201
     * rv10: additional flags
1202
     * mpeg4: global headers (they can be in the bitstream or here)
1203
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1204
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
1205
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1206
     * - encoding: Set/allocated/freed by libavcodec.
1207
     * - decoding: Set/allocated/freed by user.
1208
     */
1209
    uint8_t *extradata;
1210
    int extradata_size;
1211

    
1212
    /**
1213
     * This is the fundamental unit of time (in seconds) in terms
1214
     * of which frame timestamps are represented. For fixed-fps content,
1215
     * timebase should be 1/framerate and timestamp increments should be
1216
     * identically 1.
1217
     * - encoding: MUST be set by user.
1218
     * - decoding: Set by libavcodec.
1219
     */
1220
    AVRational time_base;
1221

    
1222
    /* video only */
1223
    /**
1224
     * picture width / height.
1225
     * - encoding: MUST be set by user.
1226
     * - decoding: Set by libavcodec.
1227
     * Note: For compatibility it is possible to set this instead of
1228
     * coded_width/height before decoding.
1229
     */
1230
    int width, height;
1231

    
1232
#define FF_ASPECT_EXTENDED 15
1233

    
1234
    /**
1235
     * the number of pictures in a group of pictures, or 0 for intra_only
1236
     * - encoding: Set by user.
1237
     * - decoding: unused
1238
     */
1239
    int gop_size;
1240

    
1241
    /**
1242
     * Pixel format, see PIX_FMT_xxx.
1243
     * May be set by the demuxer if known from headers.
1244
     * May be overriden by the decoder if it knows better.
1245
     * - encoding: Set by user.
1246
     * - decoding: Set by user if known, overridden by libavcodec if known
1247
     */
1248
    enum PixelFormat pix_fmt;
1249

    
1250
    /**
1251
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1252
     * decoder to draw a horizontal band. It improves cache usage. Not
1253
     * all codecs can do that. You must check the codec capabilities
1254
     * beforehand.
1255
     * When multithreading is used, it may be called from multiple threads
1256
     * at the same time; threads might draw different parts of the same AVFrame,
1257
     * or multiple AVFrames, and there is no guarantee that slices will be drawn
1258
     * in order.
1259
     * The function is also used by hardware acceleration APIs.
1260
     * It is called at least once during frame decoding to pass
1261
     * the data needed for hardware render.
1262
     * In that mode instead of pixel data, AVFrame points to
1263
     * a structure specific to the acceleration API. The application
1264
     * reads the structure and can change some fields to indicate progress
1265
     * or mark state.
1266
     * - encoding: unused
1267
     * - decoding: Set by user.
1268
     * @param height the height of the slice
1269
     * @param y the y position of the slice
1270
     * @param type 1->top field, 2->bottom field, 3->frame
1271
     * @param offset offset into the AVFrame.data from which the slice should be read
1272
     */
1273
    void (*draw_horiz_band)(struct AVCodecContext *s,
1274
                            const AVFrame *src, int offset[4],
1275
                            int y, int type, int height);
1276

    
1277
    /* audio only */
1278
    int sample_rate; ///< samples per second
1279
    int channels;    ///< number of audio channels
1280

    
1281
    /**
1282
     * audio sample format
1283
     * - encoding: Set by user.
1284
     * - decoding: Set by libavcodec.
1285
     */
1286
    enum AVSampleFormat sample_fmt;  ///< sample format
1287

    
1288
    /* The following data should not be initialized. */
1289
    /**
1290
     * Samples per packet, initialized when calling 'init'.
1291
     */
1292
    int frame_size;
1293
    int frame_number;   ///< audio or video frame number
1294

    
1295
    /**
1296
     * Number of frames the decoded output will be delayed relative to
1297
     * the encoded input.
1298
     * - encoding: Set by libavcodec.
1299
     * - decoding: unused
1300
     */
1301
    int delay;
1302

    
1303
    /* - encoding parameters */
1304
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1305
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1306

    
1307
    /**
1308
     * minimum quantizer
1309
     * - encoding: Set by user.
1310
     * - decoding: unused
1311
     */
1312
    int qmin;
1313

    
1314
    /**
1315
     * maximum quantizer
1316
     * - encoding: Set by user.
1317
     * - decoding: unused
1318
     */
1319
    int qmax;
1320

    
1321
    /**
1322
     * maximum quantizer difference between frames
1323
     * - encoding: Set by user.
1324
     * - decoding: unused
1325
     */
1326
    int max_qdiff;
1327

    
1328
    /**
1329
     * maximum number of B-frames between non-B-frames
1330
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1331
     * - encoding: Set by user.
1332
     * - decoding: unused
1333
     */
1334
    int max_b_frames;
1335

    
1336
    /**
1337
     * qscale factor between IP and B-frames
1338
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1339
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1340
     * - encoding: Set by user.
1341
     * - decoding: unused
1342
     */
1343
    float b_quant_factor;
1344

    
1345
    /** obsolete FIXME remove */
1346
    int rc_strategy;
1347
#define FF_RC_STRATEGY_XVID 1
1348

    
1349
    int b_frame_strategy;
1350

    
1351
    struct AVCodec *codec;
1352

    
1353
    void *priv_data;
1354

    
1355
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1356
                            /* do its best to deliver a chunk with size     */
1357
                            /* below rtp_payload_size, the chunk will start */
1358
                            /* with a start code on some codecs like H.263. */
1359
                            /* This doesn't take account of any particular  */
1360
                            /* headers inside the transmitted RTP payload.  */
1361

    
1362

    
1363
    /* The RTP callback: This function is called    */
1364
    /* every time the encoder has a packet to send. */
1365
    /* It depends on the encoder if the data starts */
1366
    /* with a Start Code (it should). H.263 does.   */
1367
    /* mb_nb contains the number of macroblocks     */
1368
    /* encoded in the RTP payload.                  */
1369
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1370

    
1371
    /* statistics, used for 2-pass encoding */
1372
    int mv_bits;
1373
    int header_bits;
1374
    int i_tex_bits;
1375
    int p_tex_bits;
1376
    int i_count;
1377
    int p_count;
1378
    int skip_count;
1379
    int misc_bits;
1380

    
1381
    /**
1382
     * number of bits used for the previously encoded frame
1383
     * - encoding: Set by libavcodec.
1384
     * - decoding: unused
1385
     */
1386
    int frame_bits;
1387

    
1388
    /**
1389
     * Private data of the user, can be used to carry app specific stuff.
1390
     * - encoding: Set by user.
1391
     * - decoding: Set by user.
1392
     */
1393
    void *opaque;
1394

    
1395
    char codec_name[32];
1396
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1397
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1398

    
1399
    /**
1400
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1401
     * This is used to work around some encoder bugs.
1402
     * A demuxer should set this to what is stored in the field used to identify the codec.
1403
     * If there are multiple such fields in a container then the demuxer should choose the one
1404
     * which maximizes the information about the used codec.
1405
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
1406
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1407
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1408
     * first.
1409
     * - encoding: Set by user, if not then the default based on codec_id will be used.
1410
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1411
     */
1412
    unsigned int codec_tag;
1413

    
1414
    /**
1415
     * Work around bugs in encoders which sometimes cannot be detected automatically.
1416
     * - encoding: Set by user
1417
     * - decoding: Set by user
1418
     */
1419
    int workaround_bugs;
1420
#define FF_BUG_AUTODETECT       1  ///< autodetection
1421
#define FF_BUG_OLD_MSMPEG4      2
1422
#define FF_BUG_XVID_ILACE       4
1423
#define FF_BUG_UMP4             8
1424
#define FF_BUG_NO_PADDING       16
1425
#define FF_BUG_AMV              32
1426
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1427
#define FF_BUG_QPEL_CHROMA      64
1428
#define FF_BUG_STD_QPEL         128
1429
#define FF_BUG_QPEL_CHROMA2     256
1430
#define FF_BUG_DIRECT_BLOCKSIZE 512
1431
#define FF_BUG_EDGE             1024
1432
#define FF_BUG_HPEL_CHROMA      2048
1433
#define FF_BUG_DC_CLIP          4096
1434
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1435
#define FF_BUG_TRUNCATED       16384
1436
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1437

    
1438
    /**
1439
     * luma single coefficient elimination threshold
1440
     * - encoding: Set by user.
1441
     * - decoding: unused
1442
     */
1443
    int luma_elim_threshold;
1444

    
1445
    /**
1446
     * chroma single coeff elimination threshold
1447
     * - encoding: Set by user.
1448
     * - decoding: unused
1449
     */
1450
    int chroma_elim_threshold;
1451

    
1452
    /**
1453
     * strictly follow the standard (MPEG4, ...).
1454
     * - encoding: Set by user.
1455
     * - decoding: Set by user.
1456
     * Setting this to STRICT or higher means the encoder and decoder will
1457
     * generally do stupid things, whereas setting it to unofficial or lower
1458
     * will mean the encoder might produce output that is not supported by all
1459
     * spec-compliant decoders. Decoders don't differentiate between normal,
1460
     * unofficial and experimental (that is, they always try to decode things
1461
     * when they can) unless they are explicitly asked to behave stupidly
1462
     * (=strictly conform to the specs)
1463
     */
1464
    int strict_std_compliance;
1465
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1466
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1467
#define FF_COMPLIANCE_NORMAL        0
1468
#define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1469
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1470

    
1471
    /**
1472
     * qscale offset between IP and B-frames
1473
     * - encoding: Set by user.
1474
     * - decoding: unused
1475
     */
1476
    float b_quant_offset;
1477

    
1478
    /**
1479
     * Error recognization; higher values will detect more errors but may
1480
     * misdetect some more or less valid parts as errors.
1481
     * - encoding: unused
1482
     * - decoding: Set by user.
1483
     */
1484
    int error_recognition;
1485
#define FF_ER_CAREFUL         1
1486
#define FF_ER_COMPLIANT       2
1487
#define FF_ER_AGGRESSIVE      3
1488
#define FF_ER_VERY_AGGRESSIVE 4
1489

    
1490
    /**
1491
     * Called at the beginning of each frame to get a buffer for it.
1492
     * If pic.reference is set then the frame will be read later by libavcodec.
1493
     * avcodec_align_dimensions2() should be used to find the required width and
1494
     * height, as they normally need to be rounded up to the next multiple of 16.
1495
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1496
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1497
     * some other means.
1498
     * If frame multithreading is used and thread_safe_callbacks is set,
1499
     * it may be called from a different thread, but not from more than one at once.
1500
     * Does not need to be reentrant.
1501
     * - encoding: unused
1502
     * - decoding: Set by libavcodec, user can override.
1503
     */
1504
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1505

    
1506
    /**
1507
     * Called to release buffers which were allocated with get_buffer.
1508
     * A released buffer can be reused in get_buffer().
1509
     * pic.data[*] must be set to NULL.
1510
     * May be called from a different thread if frame multithreading is used,
1511
     * but not by more than one thread at once, so does not need to be reentrant.
1512
     * - encoding: unused
1513
     * - decoding: Set by libavcodec, user can override.
1514
     */
1515
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1516

    
1517
    /**
1518
     * Size of the frame reordering buffer in the decoder.
1519
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1520
     * - encoding: Set by libavcodec.
1521
     * - decoding: Set by libavcodec.
1522
     */
1523
    int has_b_frames;
1524

    
1525
    /**
1526
     * number of bytes per packet if constant and known or 0
1527
     * Used by some WAV based audio codecs.
1528
     */
1529
    int block_align;
1530

    
1531
    int parse_only; /* - decoding only: If true, only parsing is done
1532
                       (function avcodec_parse_frame()). The frame
1533
                       data is returned. Only MPEG codecs support this now. */
1534

    
1535
    /**
1536
     * 0-> h263 quant 1-> mpeg quant
1537
     * - encoding: Set by user.
1538
     * - decoding: unused
1539
     */
1540
    int mpeg_quant;
1541

    
1542
    /**
1543
     * pass1 encoding statistics output buffer
1544
     * - encoding: Set by libavcodec.
1545
     * - decoding: unused
1546
     */
1547
    char *stats_out;
1548

    
1549
    /**
1550
     * pass2 encoding statistics input buffer
1551
     * Concatenated stuff from stats_out of pass1 should be placed here.
1552
     * - encoding: Allocated/set/freed by user.
1553
     * - decoding: unused
1554
     */
1555
    char *stats_in;
1556

    
1557
    /**
1558
     * ratecontrol qmin qmax limiting method
1559
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1560
     * - encoding: Set by user.
1561
     * - decoding: unused
1562
     */
1563
    float rc_qsquish;
1564

    
1565
    float rc_qmod_amp;
1566
    int rc_qmod_freq;
1567

    
1568
    /**
1569
     * ratecontrol override, see RcOverride
1570
     * - encoding: Allocated/set/freed by user.
1571
     * - decoding: unused
1572
     */
1573
    RcOverride *rc_override;
1574
    int rc_override_count;
1575

    
1576
    /**
1577
     * rate control equation
1578
     * - encoding: Set by user
1579
     * - decoding: unused
1580
     */
1581
    const char *rc_eq;
1582

    
1583
    /**
1584
     * maximum bitrate
1585
     * - encoding: Set by user.
1586
     * - decoding: unused
1587
     */
1588
    int rc_max_rate;
1589

    
1590
    /**
1591
     * minimum bitrate
1592
     * - encoding: Set by user.
1593
     * - decoding: unused
1594
     */
1595
    int rc_min_rate;
1596

    
1597
    /**
1598
     * decoder bitstream buffer size
1599
     * - encoding: Set by user.
1600
     * - decoding: unused
1601
     */
1602
    int rc_buffer_size;
1603
    float rc_buffer_aggressivity;
1604

    
1605
    /**
1606
     * qscale factor between P and I-frames
1607
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1608
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1609
     * - encoding: Set by user.
1610
     * - decoding: unused
1611
     */
1612
    float i_quant_factor;
1613

    
1614
    /**
1615
     * qscale offset between P and I-frames
1616
     * - encoding: Set by user.
1617
     * - decoding: unused
1618
     */
1619
    float i_quant_offset;
1620

    
1621
    /**
1622
     * initial complexity for pass1 ratecontrol
1623
     * - encoding: Set by user.
1624
     * - decoding: unused
1625
     */
1626
    float rc_initial_cplx;
1627

    
1628
    /**
1629
     * DCT algorithm, see FF_DCT_* below
1630
     * - encoding: Set by user.
1631
     * - decoding: unused
1632
     */
1633
    int dct_algo;
1634
#define FF_DCT_AUTO    0
1635
#define FF_DCT_FASTINT 1
1636
#define FF_DCT_INT     2
1637
#define FF_DCT_MMX     3
1638
#define FF_DCT_MLIB    4
1639
#define FF_DCT_ALTIVEC 5
1640
#define FF_DCT_FAAN    6
1641

    
1642
    /**
1643
     * luminance masking (0-> disabled)
1644
     * - encoding: Set by user.
1645
     * - decoding: unused
1646
     */
1647
    float lumi_masking;
1648

    
1649
    /**
1650
     * temporary complexity masking (0-> disabled)
1651
     * - encoding: Set by user.
1652
     * - decoding: unused
1653
     */
1654
    float temporal_cplx_masking;
1655

    
1656
    /**
1657
     * spatial complexity masking (0-> disabled)
1658
     * - encoding: Set by user.
1659
     * - decoding: unused
1660
     */
1661
    float spatial_cplx_masking;
1662

    
1663
    /**
1664
     * p block masking (0-> disabled)
1665
     * - encoding: Set by user.
1666
     * - decoding: unused
1667
     */
1668
    float p_masking;
1669

    
1670
    /**
1671
     * darkness masking (0-> disabled)
1672
     * - encoding: Set by user.
1673
     * - decoding: unused
1674
     */
1675
    float dark_masking;
1676

    
1677
    /**
1678
     * IDCT algorithm, see FF_IDCT_* below.
1679
     * - encoding: Set by user.
1680
     * - decoding: Set by user.
1681
     */
1682
    int idct_algo;
1683
#define FF_IDCT_AUTO          0
1684
#define FF_IDCT_INT           1
1685
#define FF_IDCT_SIMPLE        2
1686
#define FF_IDCT_SIMPLEMMX     3
1687
#define FF_IDCT_LIBMPEG2MMX   4
1688
#define FF_IDCT_PS2           5
1689
#define FF_IDCT_MLIB          6
1690
#define FF_IDCT_ARM           7
1691
#define FF_IDCT_ALTIVEC       8
1692
#define FF_IDCT_SH4           9
1693
#define FF_IDCT_SIMPLEARM     10
1694
#define FF_IDCT_H264          11
1695
#define FF_IDCT_VP3           12
1696
#define FF_IDCT_IPP           13
1697
#define FF_IDCT_XVIDMMX       14
1698
#define FF_IDCT_CAVS          15
1699
#define FF_IDCT_SIMPLEARMV5TE 16
1700
#define FF_IDCT_SIMPLEARMV6   17
1701
#define FF_IDCT_SIMPLEVIS     18
1702
#define FF_IDCT_WMV2          19
1703
#define FF_IDCT_FAAN          20
1704
#define FF_IDCT_EA            21
1705
#define FF_IDCT_SIMPLENEON    22
1706
#define FF_IDCT_SIMPLEALPHA   23
1707
#define FF_IDCT_BINK          24
1708

    
1709
    /**
1710
     * slice count
1711
     * - encoding: Set by libavcodec.
1712
     * - decoding: Set by user (or 0).
1713
     */
1714
    int slice_count;
1715
    /**
1716
     * slice offsets in the frame in bytes
1717
     * - encoding: Set/allocated by libavcodec.
1718
     * - decoding: Set/allocated by user (or NULL).
1719
     */
1720
    int *slice_offset;
1721

    
1722
    /**
1723
     * error concealment flags
1724
     * - encoding: unused
1725
     * - decoding: Set by user.
1726
     */
1727
    int error_concealment;
1728
#define FF_EC_GUESS_MVS   1
1729
#define FF_EC_DEBLOCK     2
1730

    
1731
    /**
1732
     * dsp_mask could be add used to disable unwanted CPU features
1733
     * CPU features (i.e. MMX, SSE. ...)
1734
     *
1735
     * With the FORCE flag you may instead enable given CPU features.
1736
     * (Dangerous: Usable in case of misdetection, improper usage however will
1737
     * result into program crash.)
1738
     */
1739
    unsigned dsp_mask;
1740

    
1741
    /**
1742
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1743
     * - encoding: Set by libavcodec.
1744
     * - decoding: Set by user.
1745
     */
1746
     int bits_per_coded_sample;
1747

    
1748
    /**
1749
     * prediction method (needed for huffyuv)
1750
     * - encoding: Set by user.
1751
     * - decoding: unused
1752
     */
1753
     int prediction_method;
1754
#define FF_PRED_LEFT   0
1755
#define FF_PRED_PLANE  1
1756
#define FF_PRED_MEDIAN 2
1757

    
1758
    /**
1759
     * sample aspect ratio (0 if unknown)
1760
     * That is the width of a pixel divided by the height of the pixel.
1761
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1762
     * - encoding: Set by user.
1763
     * - decoding: Set by libavcodec.
1764
     */
1765
    AVRational sample_aspect_ratio;
1766

    
1767
    /**
1768
     * the picture in the bitstream
1769
     * - encoding: Set by libavcodec.
1770
     * - decoding: Set by libavcodec.
1771
     */
1772
    AVFrame *coded_frame;
1773

    
1774
    /**
1775
     * debug
1776
     * - encoding: Set by user.
1777
     * - decoding: Set by user.
1778
     */
1779
    int debug;
1780
#define FF_DEBUG_PICT_INFO   1
1781
#define FF_DEBUG_RC          2
1782
#define FF_DEBUG_BITSTREAM   4
1783
#define FF_DEBUG_MB_TYPE     8
1784
#define FF_DEBUG_QP          16
1785
#define FF_DEBUG_MV          32
1786
#define FF_DEBUG_DCT_COEFF   0x00000040
1787
#define FF_DEBUG_SKIP        0x00000080
1788
#define FF_DEBUG_STARTCODE   0x00000100
1789
#define FF_DEBUG_PTS         0x00000200
1790
#define FF_DEBUG_ER          0x00000400
1791
#define FF_DEBUG_MMCO        0x00000800
1792
#define FF_DEBUG_BUGS        0x00001000
1793
#define FF_DEBUG_VIS_QP      0x00002000
1794
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1795
#define FF_DEBUG_BUFFERS     0x00008000
1796
#define FF_DEBUG_THREADS     0x00010000
1797

    
1798
    /**
1799
     * debug
1800
     * - encoding: Set by user.
1801
     * - decoding: Set by user.
1802
     */
1803
    int debug_mv;
1804
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1805
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1806
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1807

    
1808
    /**
1809
     * error
1810
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1811
     * - decoding: unused
1812
     */
1813
    uint64_t error[4];
1814

    
1815
    /**
1816
     * motion estimation comparison function
1817
     * - encoding: Set by user.
1818
     * - decoding: unused
1819
     */
1820
    int me_cmp;
1821
    /**
1822
     * subpixel motion estimation comparison function
1823
     * - encoding: Set by user.
1824
     * - decoding: unused
1825
     */
1826
    int me_sub_cmp;
1827
    /**
1828
     * macroblock comparison function (not supported yet)
1829
     * - encoding: Set by user.
1830
     * - decoding: unused
1831
     */
1832
    int mb_cmp;
1833
    /**
1834
     * interlaced DCT comparison function
1835
     * - encoding: Set by user.
1836
     * - decoding: unused
1837
     */
1838
    int ildct_cmp;
1839
#define FF_CMP_SAD    0
1840
#define FF_CMP_SSE    1
1841
#define FF_CMP_SATD   2
1842
#define FF_CMP_DCT    3
1843
#define FF_CMP_PSNR   4
1844
#define FF_CMP_BIT    5
1845
#define FF_CMP_RD     6
1846
#define FF_CMP_ZERO   7
1847
#define FF_CMP_VSAD   8
1848
#define FF_CMP_VSSE   9
1849
#define FF_CMP_NSSE   10
1850
#define FF_CMP_W53    11
1851
#define FF_CMP_W97    12
1852
#define FF_CMP_DCTMAX 13
1853
#define FF_CMP_DCT264 14
1854
#define FF_CMP_CHROMA 256
1855

    
1856
    /**
1857
     * ME diamond size & shape
1858
     * - encoding: Set by user.
1859
     * - decoding: unused
1860
     */
1861
    int dia_size;
1862

    
1863
    /**
1864
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1865
     * - encoding: Set by user.
1866
     * - decoding: unused
1867
     */
1868
    int last_predictor_count;
1869

    
1870
    /**
1871
     * prepass for motion estimation
1872
     * - encoding: Set by user.
1873
     * - decoding: unused
1874
     */
1875
    int pre_me;
1876

    
1877
    /**
1878
     * motion estimation prepass comparison function
1879
     * - encoding: Set by user.
1880
     * - decoding: unused
1881
     */
1882
    int me_pre_cmp;
1883

    
1884
    /**
1885
     * ME prepass diamond size & shape
1886
     * - encoding: Set by user.
1887
     * - decoding: unused
1888
     */
1889
    int pre_dia_size;
1890

    
1891
    /**
1892
     * subpel ME quality
1893
     * - encoding: Set by user.
1894
     * - decoding: unused
1895
     */
1896
    int me_subpel_quality;
1897

    
1898
    /**
1899
     * callback to negotiate the pixelFormat
1900
     * @param fmt is the list of formats which are supported by the codec,
1901
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1902
     * The first is always the native one.
1903
     * @return the chosen format
1904
     * - encoding: unused
1905
     * - decoding: Set by user, if not set the native format will be chosen.
1906
     */
1907
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1908

    
1909
    /**
1910
     * DTG active format information (additional aspect ratio
1911
     * information only used in DVB MPEG-2 transport streams)
1912
     * 0 if not set.
1913
     *
1914
     * - encoding: unused
1915
     * - decoding: Set by decoder.
1916
     */
1917
    int dtg_active_format;
1918
#define FF_DTG_AFD_SAME         8
1919
#define FF_DTG_AFD_4_3          9
1920
#define FF_DTG_AFD_16_9         10
1921
#define FF_DTG_AFD_14_9         11
1922
#define FF_DTG_AFD_4_3_SP_14_9  13
1923
#define FF_DTG_AFD_16_9_SP_14_9 14
1924
#define FF_DTG_AFD_SP_4_3       15
1925

    
1926
    /**
1927
     * maximum motion estimation search range in subpel units
1928
     * If 0 then no limit.
1929
     *
1930
     * - encoding: Set by user.
1931
     * - decoding: unused
1932
     */
1933
    int me_range;
1934

    
1935
    /**
1936
     * intra quantizer bias
1937
     * - encoding: Set by user.
1938
     * - decoding: unused
1939
     */
1940
    int intra_quant_bias;
1941
#define FF_DEFAULT_QUANT_BIAS 999999
1942

    
1943
    /**
1944
     * inter quantizer bias
1945
     * - encoding: Set by user.
1946
     * - decoding: unused
1947
     */
1948
    int inter_quant_bias;
1949

    
1950
    /**
1951
     * color table ID
1952
     * - encoding: unused
1953
     * - decoding: Which clrtable should be used for 8bit RGB images.
1954
     *             Tables have to be stored somewhere. FIXME
1955
     */
1956
    int color_table_id;
1957

    
1958
    /**
1959
     * internal_buffer count
1960
     * Don't touch, used by libavcodec default_get_buffer().
1961
     */
1962
    int internal_buffer_count;
1963

    
1964
    /**
1965
     * internal_buffers
1966
     * Don't touch, used by libavcodec default_get_buffer().
1967
     */
1968
    void *internal_buffer;
1969

    
1970
    /**
1971
     * Global quality for codecs which cannot change it per frame.
1972
     * This should be proportional to MPEG-1/2/4 qscale.
1973
     * - encoding: Set by user.
1974
     * - decoding: unused
1975
     */
1976
    int global_quality;
1977

    
1978
#define FF_CODER_TYPE_VLC       0
1979
#define FF_CODER_TYPE_AC        1
1980
#define FF_CODER_TYPE_RAW       2
1981
#define FF_CODER_TYPE_RLE       3
1982
#define FF_CODER_TYPE_DEFLATE   4
1983
    /**
1984
     * coder type
1985
     * - encoding: Set by user.
1986
     * - decoding: unused
1987
     */
1988
    int coder_type;
1989

    
1990
    /**
1991
     * context model
1992
     * - encoding: Set by user.
1993
     * - decoding: unused
1994
     */
1995
    int context_model;
1996
#if 0
1997
    /**
1998
     *
1999
     * - encoding: unused
2000
     * - decoding: Set by user.
2001
     */
2002
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2003
#endif
2004

    
2005
    /**
2006
     * slice flags
2007
     * - encoding: unused
2008
     * - decoding: Set by user.
2009
     */
2010
    int slice_flags;
2011
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2012
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2013
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2014

    
2015
    /**
2016
     * XVideo Motion Acceleration
2017
     * - encoding: forbidden
2018
     * - decoding: set by decoder
2019
     */
2020
    int xvmc_acceleration;
2021

    
2022
    /**
2023
     * macroblock decision mode
2024
     * - encoding: Set by user.
2025
     * - decoding: unused
2026
     */
2027
    int mb_decision;
2028
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2029
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2030
#define FF_MB_DECISION_RD     2        ///< rate distortion
2031

    
2032
    /**
2033
     * custom intra quantization matrix
2034
     * - encoding: Set by user, can be NULL.
2035
     * - decoding: Set by libavcodec.
2036
     */
2037
    uint16_t *intra_matrix;
2038

    
2039
    /**
2040
     * custom inter quantization matrix
2041
     * - encoding: Set by user, can be NULL.
2042
     * - decoding: Set by libavcodec.
2043
     */
2044
    uint16_t *inter_matrix;
2045

    
2046
    /**
2047
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2048
     * This is used to work around some encoder bugs.
2049
     * - encoding: unused
2050
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2051
     */
2052
    unsigned int stream_codec_tag;
2053

    
2054
    /**
2055
     * scene change detection threshold
2056
     * 0 is default, larger means fewer detected scene changes.
2057
     * - encoding: Set by user.
2058
     * - decoding: unused
2059
     */
2060
    int scenechange_threshold;
2061

    
2062
    /**
2063
     * minimum Lagrange multipler
2064
     * - encoding: Set by user.
2065
     * - decoding: unused
2066
     */
2067
    int lmin;
2068

    
2069
    /**
2070
     * maximum Lagrange multipler
2071
     * - encoding: Set by user.
2072
     * - decoding: unused
2073
     */
2074
    int lmax;
2075

    
2076
#if FF_API_PALETTE_CONTROL
2077
    /**
2078
     * palette control structure
2079
     * - encoding: ??? (no palette-enabled encoder yet)
2080
     * - decoding: Set by user.
2081
     */
2082
    struct AVPaletteControl *palctrl;
2083
#endif
2084

    
2085
    /**
2086
     * noise reduction strength
2087
     * - encoding: Set by user.
2088
     * - decoding: unused
2089
     */
2090
    int noise_reduction;
2091

    
2092
    /**
2093
     * Called at the beginning of a frame to get cr buffer for it.
2094
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
2095
     * libavcodec will pass previous buffer in pic, function should return
2096
     * same buffer or new buffer with old frame "painted" into it.
2097
     * If pic.data[0] == NULL must behave like get_buffer().
2098
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2099
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
2100
     * some other means.
2101
     * - encoding: unused
2102
     * - decoding: Set by libavcodec, user can override.
2103
     */
2104
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2105

    
2106
    /**
2107
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2108
     * - encoding: Set by user.
2109
     * - decoding: unused
2110
     */
2111
    int rc_initial_buffer_occupancy;
2112

    
2113
    /**
2114
     *
2115
     * - encoding: Set by user.
2116
     * - decoding: unused
2117
     */
2118
    int inter_threshold;
2119

    
2120
    /**
2121
     * CODEC_FLAG2_*
2122
     * - encoding: Set by user.
2123
     * - decoding: Set by user.
2124
     */
2125
    int flags2;
2126

    
2127
    /**
2128
     * Simulates errors in the bitstream to test error concealment.
2129
     * - encoding: Set by user.
2130
     * - decoding: unused
2131
     */
2132
    int error_rate;
2133

    
2134
#if FF_API_ANTIALIAS_ALGO
2135
    /**
2136
     * MP3 antialias algorithm, see FF_AA_* below.
2137
     * - encoding: unused
2138
     * - decoding: Set by user.
2139
     */
2140
    attribute_deprecated int antialias_algo;
2141
#define FF_AA_AUTO    0
2142
#define FF_AA_FASTINT 1 //not implemented yet
2143
#define FF_AA_INT     2
2144
#define FF_AA_FLOAT   3
2145
#endif
2146

    
2147
    /**
2148
     * quantizer noise shaping
2149
     * - encoding: Set by user.
2150
     * - decoding: unused
2151
     */
2152
    int quantizer_noise_shaping;
2153

    
2154
    /**
2155
     * thread count
2156
     * is used to decide how many independent tasks should be passed to execute()
2157
     * - encoding: Set by user.
2158
     * - decoding: Set by user.
2159
     */
2160
    int thread_count;
2161

    
2162
    /**
2163
     * The codec may call this to execute several independent things.
2164
     * It will return only after finishing all tasks.
2165
     * The user may replace this with some multithreaded implementation,
2166
     * the default implementation will execute the parts serially.
2167
     * @param count the number of things to execute
2168
     * - encoding: Set by libavcodec, user can override.
2169
     * - decoding: Set by libavcodec, user can override.
2170
     */
2171
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2172

    
2173
    /**
2174
     * thread opaque
2175
     * Can be used by execute() to store some per AVCodecContext stuff.
2176
     * - encoding: set by execute()
2177
     * - decoding: set by execute()
2178
     */
2179
    void *thread_opaque;
2180

    
2181
    /**
2182
     * Motion estimation threshold below which no motion estimation is
2183
     * performed, but instead the user specified motion vectors are used.
2184
     *
2185
     * - encoding: Set by user.
2186
     * - decoding: unused
2187
     */
2188
     int me_threshold;
2189

    
2190
    /**
2191
     * Macroblock threshold below which the user specified macroblock types will be used.
2192
     * - encoding: Set by user.
2193
     * - decoding: unused
2194
     */
2195
     int mb_threshold;
2196

    
2197
    /**
2198
     * precision of the intra DC coefficient - 8
2199
     * - encoding: Set by user.
2200
     * - decoding: unused
2201
     */
2202
     int intra_dc_precision;
2203

    
2204
    /**
2205
     * noise vs. sse weight for the nsse comparsion function
2206
     * - encoding: Set by user.
2207
     * - decoding: unused
2208
     */
2209
     int nsse_weight;
2210

    
2211
    /**
2212
     * Number of macroblock rows at the top which are skipped.
2213
     * - encoding: unused
2214
     * - decoding: Set by user.
2215
     */
2216
     int skip_top;
2217

    
2218
    /**
2219
     * Number of macroblock rows at the bottom which are skipped.
2220
     * - encoding: unused
2221
     * - decoding: Set by user.
2222
     */
2223
     int skip_bottom;
2224

    
2225
    /**
2226
     * profile
2227
     * - encoding: Set by user.
2228
     * - decoding: Set by libavcodec.
2229
     */
2230
     int profile;
2231
#define FF_PROFILE_UNKNOWN -99
2232
#define FF_PROFILE_RESERVED -100
2233

    
2234
#define FF_PROFILE_AAC_MAIN 0
2235
#define FF_PROFILE_AAC_LOW  1
2236
#define FF_PROFILE_AAC_SSR  2
2237
#define FF_PROFILE_AAC_LTP  3
2238

    
2239
#define FF_PROFILE_DTS         20
2240
#define FF_PROFILE_DTS_ES      30
2241
#define FF_PROFILE_DTS_96_24   40
2242
#define FF_PROFILE_DTS_HD_HRA  50
2243
#define FF_PROFILE_DTS_HD_MA   60
2244

    
2245
#define FF_PROFILE_MPEG2_422    0
2246
#define FF_PROFILE_MPEG2_HIGH   1
2247
#define FF_PROFILE_MPEG2_SS     2
2248
#define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2249
#define FF_PROFILE_MPEG2_MAIN   4
2250
#define FF_PROFILE_MPEG2_SIMPLE 5
2251

    
2252
#define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2253
#define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2254

    
2255
#define FF_PROFILE_H264_BASELINE             66
2256
#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2257
#define FF_PROFILE_H264_MAIN                 77
2258
#define FF_PROFILE_H264_EXTENDED             88
2259
#define FF_PROFILE_H264_HIGH                 100
2260
#define FF_PROFILE_H264_HIGH_10              110
2261
#define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2262
#define FF_PROFILE_H264_HIGH_422             122
2263
#define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2264
#define FF_PROFILE_H264_HIGH_444             144
2265
#define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2266
#define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2267
#define FF_PROFILE_H264_CAVLC_444            44
2268

    
2269
#define FF_PROFILE_VC1_SIMPLE   0
2270
#define FF_PROFILE_VC1_MAIN     1
2271
#define FF_PROFILE_VC1_COMPLEX  2
2272
#define FF_PROFILE_VC1_ADVANCED 3
2273

    
2274
    /**
2275
     * level
2276
     * - encoding: Set by user.
2277
     * - decoding: Set by libavcodec.
2278
     */
2279
     int level;
2280
#define FF_LEVEL_UNKNOWN -99
2281

    
2282
    /**
2283
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2284
     * - encoding: unused
2285
     * - decoding: Set by user.
2286
     */
2287
     int lowres;
2288

    
2289
    /**
2290
     * Bitstream width / height, may be different from width/height if lowres
2291
     * or other things are used.
2292
     * - encoding: unused
2293
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2294
     */
2295
    int coded_width, coded_height;
2296

    
2297
    /**
2298
     * frame skip threshold
2299
     * - encoding: Set by user.
2300
     * - decoding: unused
2301
     */
2302
    int frame_skip_threshold;
2303

    
2304
    /**
2305
     * frame skip factor
2306
     * - encoding: Set by user.
2307
     * - decoding: unused
2308
     */
2309
    int frame_skip_factor;
2310

    
2311
    /**
2312
     * frame skip exponent
2313
     * - encoding: Set by user.
2314
     * - decoding: unused
2315
     */
2316
    int frame_skip_exp;
2317

    
2318
    /**
2319
     * frame skip comparison function
2320
     * - encoding: Set by user.
2321
     * - decoding: unused
2322
     */
2323
    int frame_skip_cmp;
2324

    
2325
    /**
2326
     * Border processing masking, raises the quantizer for mbs on the borders
2327
     * of the picture.
2328
     * - encoding: Set by user.
2329
     * - decoding: unused
2330
     */
2331
    float border_masking;
2332

    
2333
    /**
2334
     * minimum MB lagrange multipler
2335
     * - encoding: Set by user.
2336
     * - decoding: unused
2337
     */
2338
    int mb_lmin;
2339

    
2340
    /**
2341
     * maximum MB lagrange multipler
2342
     * - encoding: Set by user.
2343
     * - decoding: unused
2344
     */
2345
    int mb_lmax;
2346

    
2347
    /**
2348
     *
2349
     * - encoding: Set by user.
2350
     * - decoding: unused
2351
     */
2352
    int me_penalty_compensation;
2353

    
2354
    /**
2355
     *
2356
     * - encoding: unused
2357
     * - decoding: Set by user.
2358
     */
2359
    enum AVDiscard skip_loop_filter;
2360

    
2361
    /**
2362
     *
2363
     * - encoding: unused
2364
     * - decoding: Set by user.
2365
     */
2366
    enum AVDiscard skip_idct;
2367

    
2368
    /**
2369
     *
2370
     * - encoding: unused
2371
     * - decoding: Set by user.
2372
     */
2373
    enum AVDiscard skip_frame;
2374

    
2375
    /**
2376
     *
2377
     * - encoding: Set by user.
2378
     * - decoding: unused
2379
     */
2380
    int bidir_refine;
2381

    
2382
    /**
2383
     *
2384
     * - encoding: Set by user.
2385
     * - decoding: unused
2386
     */
2387
    int brd_scale;
2388

    
2389
    /**
2390
     * constant rate factor - quality-based VBR - values ~correspond to qps
2391
     * - encoding: Set by user.
2392
     * - decoding: unused
2393
     */
2394
    float crf;
2395

    
2396
    /**
2397
     * constant quantization parameter rate control method
2398
     * - encoding: Set by user.
2399
     * - decoding: unused
2400
     */
2401
    int cqp;
2402

    
2403
    /**
2404
     * minimum GOP size
2405
     * - encoding: Set by user.
2406
     * - decoding: unused
2407
     */
2408
    int keyint_min;
2409

    
2410
    /**
2411
     * number of reference frames
2412
     * - encoding: Set by user.
2413
     * - decoding: Set by lavc.
2414
     */
2415
    int refs;
2416

    
2417
    /**
2418
     * chroma qp offset from luma
2419
     * - encoding: Set by user.
2420
     * - decoding: unused
2421
     */
2422
    int chromaoffset;
2423

    
2424
    /**
2425
     * Influences how often B-frames are used.
2426
     * - encoding: Set by user.
2427
     * - decoding: unused
2428
     */
2429
    int bframebias;
2430

    
2431
    /**
2432
     * trellis RD quantization
2433
     * - encoding: Set by user.
2434
     * - decoding: unused
2435
     */
2436
    int trellis;
2437

    
2438
    /**
2439
     * Reduce fluctuations in qp (before curve compression).
2440
     * - encoding: Set by user.
2441
     * - decoding: unused
2442
     */
2443
    float complexityblur;
2444

    
2445
    /**
2446
     * in-loop deblocking filter alphac0 parameter
2447
     * alpha is in the range -6...6
2448
     * - encoding: Set by user.
2449
     * - decoding: unused
2450
     */
2451
    int deblockalpha;
2452

    
2453
    /**
2454
     * in-loop deblocking filter beta parameter
2455
     * beta is in the range -6...6
2456
     * - encoding: Set by user.
2457
     * - decoding: unused
2458
     */
2459
    int deblockbeta;
2460

    
2461
    /**
2462
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2463
     * - encoding: Set by user.
2464
     * - decoding: unused
2465
     */
2466
    int partitions;
2467
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2468
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2469
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2470
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2471
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2472

    
2473
    /**
2474
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2475
     * - encoding: Set by user.
2476
     * - decoding: unused
2477
     */
2478
    int directpred;
2479

    
2480
    /**
2481
     * Audio cutoff bandwidth (0 means "automatic")
2482
     * - encoding: Set by user.
2483
     * - decoding: unused
2484
     */
2485
    int cutoff;
2486

    
2487
    /**
2488
     * Multiplied by qscale for each frame and added to scene_change_score.
2489
     * - encoding: Set by user.
2490
     * - decoding: unused
2491
     */
2492
    int scenechange_factor;
2493

    
2494
    /**
2495
     *
2496
     * Note: Value depends upon the compare function used for fullpel ME.
2497
     * - encoding: Set by user.
2498
     * - decoding: unused
2499
     */
2500
    int mv0_threshold;
2501

    
2502
    /**
2503
     * Adjusts sensitivity of b_frame_strategy 1.
2504
     * - encoding: Set by user.
2505
     * - decoding: unused
2506
     */
2507
    int b_sensitivity;
2508

    
2509
    /**
2510
     * - encoding: Set by user.
2511
     * - decoding: unused
2512
     */
2513
    int compression_level;
2514
#define FF_COMPRESSION_DEFAULT -1
2515

    
2516
    /**
2517
     * LPC coefficient precision - used by FLAC encoder
2518
     * - encoding: Set by user.
2519
     * - decoding: unused
2520
     */
2521
    int lpc_coeff_precision;
2522

    
2523
    /**
2524
     * - encoding: Set by user.
2525
     * - decoding: unused
2526
     */
2527
    int min_prediction_order;
2528

    
2529
    /**
2530
     * - encoding: Set by user.
2531
     * - decoding: unused
2532
     */
2533
    int max_prediction_order;
2534

    
2535
    /**
2536
     * search method for selecting prediction order
2537
     * - encoding: Set by user.
2538
     * - decoding: unused
2539
     */
2540
    int prediction_order_method;
2541

    
2542
    /**
2543
     * - encoding: Set by user.
2544
     * - decoding: unused
2545
     */
2546
    int min_partition_order;
2547

    
2548
    /**
2549
     * - encoding: Set by user.
2550
     * - decoding: unused
2551
     */
2552
    int max_partition_order;
2553

    
2554
    /**
2555
     * GOP timecode frame start number, in non drop frame format
2556
     * - encoding: Set by user.
2557
     * - decoding: unused
2558
     */
2559
    int64_t timecode_frame_start;
2560

    
2561
#if FF_API_REQUEST_CHANNELS
2562
    /**
2563
     * Decoder should decode to this many channels if it can (0 for default)
2564
     * - encoding: unused
2565
     * - decoding: Set by user.
2566
     * @deprecated Deprecated in favor of request_channel_layout.
2567
     */
2568
    int request_channels;
2569
#endif
2570

    
2571
    /**
2572
     * Percentage of dynamic range compression to be applied by the decoder.
2573
     * The default value is 1.0, corresponding to full compression.
2574
     * - encoding: unused
2575
     * - decoding: Set by user.
2576
     */
2577
    float drc_scale;
2578

    
2579
    /**
2580
     * opaque 64bit number (generally a PTS) that will be reordered and
2581
     * output in AVFrame.reordered_opaque
2582
     * @deprecated in favor of pkt_pts
2583
     * - encoding: unused
2584
     * - decoding: Set by user.
2585
     */
2586
    int64_t reordered_opaque;
2587

    
2588
    /**
2589
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2590
     * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2591
     * - encoding: set by user.
2592
     * - decoding: set by libavcodec.
2593
     */
2594
    int bits_per_raw_sample;
2595

    
2596
    /**
2597
     * Audio channel layout.
2598
     * - encoding: set by user.
2599
     * - decoding: set by libavcodec.
2600
     */
2601
    int64_t channel_layout;
2602

    
2603
    /**
2604
     * Request decoder to use this channel layout if it can (0 for default)
2605
     * - encoding: unused
2606
     * - decoding: Set by user.
2607
     */
2608
    int64_t request_channel_layout;
2609

    
2610
    /**
2611
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2612
     * - encoding: Set by user.
2613
     * - decoding: unused.
2614
     */
2615
    float rc_max_available_vbv_use;
2616

    
2617
    /**
2618
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2619
     * - encoding: Set by user.
2620
     * - decoding: unused.
2621
     */
2622
    float rc_min_vbv_overflow_use;
2623

    
2624
    /**
2625
     * Hardware accelerator in use
2626
     * - encoding: unused.
2627
     * - decoding: Set by libavcodec
2628
     */
2629
    struct AVHWAccel *hwaccel;
2630

    
2631
    /**
2632
     * For some codecs, the time base is closer to the field rate than the frame rate.
2633
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2634
     * if no telecine is used ...
2635
     *
2636
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2637
     */
2638
    int ticks_per_frame;
2639

    
2640
    /**
2641
     * Hardware accelerator context.
2642
     * For some hardware accelerators, a global context needs to be
2643
     * provided by the user. In that case, this holds display-dependent
2644
     * data FFmpeg cannot instantiate itself. Please refer to the
2645
     * FFmpeg HW accelerator documentation to know how to fill this
2646
     * is. e.g. for VA API, this is a struct vaapi_context.
2647
     * - encoding: unused
2648
     * - decoding: Set by user
2649
     */
2650
    void *hwaccel_context;
2651

    
2652
    /**
2653
     * Chromaticity coordinates of the source primaries.
2654
     * - encoding: Set by user
2655
     * - decoding: Set by libavcodec
2656
     */
2657
    enum AVColorPrimaries color_primaries;
2658

    
2659
    /**
2660
     * Color Transfer Characteristic.
2661
     * - encoding: Set by user
2662
     * - decoding: Set by libavcodec
2663
     */
2664
    enum AVColorTransferCharacteristic color_trc;
2665

    
2666
    /**
2667
     * YUV colorspace type.
2668
     * - encoding: Set by user
2669
     * - decoding: Set by libavcodec
2670
     */
2671
    enum AVColorSpace colorspace;
2672

    
2673
    /**
2674
     * MPEG vs JPEG YUV range.
2675
     * - encoding: Set by user
2676
     * - decoding: Set by libavcodec
2677
     */
2678
    enum AVColorRange color_range;
2679

    
2680
    /**
2681
     * This defines the location of chroma samples.
2682
     * - encoding: Set by user
2683
     * - decoding: Set by libavcodec
2684
     */
2685
    enum AVChromaLocation chroma_sample_location;
2686

    
2687
    /**
2688
     * The codec may call this to execute several independent things.
2689
     * It will return only after finishing all tasks.
2690
     * The user may replace this with some multithreaded implementation,
2691
     * the default implementation will execute the parts serially.
2692
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2693
     * @param c context passed also to func
2694
     * @param count the number of things to execute
2695
     * @param arg2 argument passed unchanged to func
2696
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2697
     * @param func function that will be called count times, with jobnr from 0 to count-1.
2698
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2699
     *             two instances of func executing at the same time will have the same threadnr.
2700
     * @return always 0 currently, but code should handle a future improvement where when any call to func
2701
     *         returns < 0 no further calls to func may be done and < 0 is returned.
2702
     * - encoding: Set by libavcodec, user can override.
2703
     * - decoding: Set by libavcodec, user can override.
2704
     */
2705
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2706

    
2707
    /**
2708
     * explicit P-frame weighted prediction analysis method
2709
     * 0: off
2710
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2711
     * 2: smart weighting (full fade detection analysis)
2712
     * - encoding: Set by user.
2713
     * - decoding: unused
2714
     */
2715
    int weighted_p_pred;
2716

    
2717
    /**
2718
     * AQ mode
2719
     * 0: Disabled
2720
     * 1: Variance AQ (complexity mask)
2721
     * 2: Auto-variance AQ (experimental)
2722
     * - encoding: Set by user
2723
     * - decoding: unused
2724
     */
2725
    int aq_mode;
2726

    
2727
    /**
2728
     * AQ strength
2729
     * Reduces blocking and blurring in flat and textured areas.
2730
     * - encoding: Set by user
2731
     * - decoding: unused
2732
     */
2733
    float aq_strength;
2734

    
2735
    /**
2736
     * PSY RD
2737
     * Strength of psychovisual optimization
2738
     * - encoding: Set by user
2739
     * - decoding: unused
2740
     */
2741
    float psy_rd;
2742

    
2743
    /**
2744
     * PSY trellis
2745
     * Strength of psychovisual optimization
2746
     * - encoding: Set by user
2747
     * - decoding: unused
2748
     */
2749
    float psy_trellis;
2750

    
2751
    /**
2752
     * RC lookahead
2753
     * Number of frames for frametype and ratecontrol lookahead
2754
     * - encoding: Set by user
2755
     * - decoding: unused
2756
     */
2757
    int rc_lookahead;
2758

    
2759
    /**
2760
     * Constant rate factor maximum
2761
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2762
     * than crf_max, even if doing so would violate VBV restrictions.
2763
     * - encoding: Set by user.
2764
     * - decoding: unused
2765
     */
2766
    float crf_max;
2767

    
2768
    int log_level_offset;
2769

    
2770
    /**
2771
     * Determines which LPC analysis algorithm to use.
2772
     * - encoding: Set by user
2773
     * - decoding: unused
2774
     */
2775
    enum AVLPCType lpc_type;
2776

    
2777
    /**
2778
     * Number of passes to use for Cholesky factorization during LPC analysis
2779
     * - encoding: Set by user
2780
     * - decoding: unused
2781
     */
2782
    int lpc_passes;
2783

    
2784
    /**
2785
     * Number of slices.
2786
     * Indicates number of picture subdivisions. Used for parallelized
2787
     * decoding.
2788
     * - encoding: Set by user
2789
     * - decoding: unused
2790
     */
2791
    int slices;
2792

    
2793
    /**
2794
     * Header containing style information for text subtitles.
2795
     * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2796
     * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2797
     * the Format line following. It shouldn't include any Dialogue line.
2798
     * - encoding: Set/allocated/freed by user (before avcodec_open())
2799
     * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2800
     */
2801
    uint8_t *subtitle_header;
2802
    int subtitle_header_size;
2803

    
2804
    /**
2805
     * Current packet as passed into the decoder, to avoid having
2806
     * to pass the packet into every function. Currently only valid
2807
     * inside lavc and get/release_buffer callbacks.
2808
     * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2809
     * - encoding: unused
2810
     */
2811
    AVPacket *pkt;
2812

    
2813
    /**
2814
     * Whether this is a copy of the context which had init() called on it.
2815
     * This is used by multithreading - shared tables and picture pointers
2816
     * should be freed from the original context only.
2817
     * - encoding: Set by libavcodec.
2818
     * - decoding: Set by libavcodec.
2819
     */
2820
    int is_copy;
2821

    
2822
    /**
2823
     * Which multithreading methods to use.
2824
     * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2825
     * so clients which cannot provide future frames should not use it.
2826
     *
2827
     * - encoding: Set by user, otherwise the default is used.
2828
     * - decoding: Set by user, otherwise the default is used.
2829
     */
2830
    int thread_type;
2831
#define FF_THREAD_FRAME   1 //< Decode more than one frame at once
2832
#define FF_THREAD_SLICE   2 //< Decode more than one part of a single frame at once
2833

    
2834
    /**
2835
     * Which multithreading methods are in use by the codec.
2836
     * - encoding: Set by libavcodec.
2837
     * - decoding: Set by libavcodec.
2838
     */
2839
    int active_thread_type;
2840

    
2841
    /**
2842
     * Set by the client if its custom get_buffer() callback can be called
2843
     * from another thread, which allows faster multithreaded decoding.
2844
     * draw_horiz_band() will be called from other threads regardless of this setting.
2845
     * Ignored if the default get_buffer() is used.
2846
     * - encoding: Set by user.
2847
     * - decoding: Set by user.
2848
     */
2849
    int thread_safe_callbacks;
2850

    
2851
    /**
2852
     * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2853
     * Used for compliant TS muxing.
2854
     * - encoding: Set by libavcodec.
2855
     * - decoding: unused.
2856
     */
2857
    uint64_t vbv_delay;
2858

    
2859
    /**
2860
     * Type of service that the audio stream conveys.
2861
     * - encoding: Set by user.
2862
     * - decoding: Set by libavcodec.
2863
     */
2864
    enum AVAudioServiceType audio_service_type;
2865

    
2866
    /**
2867
     * Current statistics for PTS correction.
2868
     * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2869
     * - encoding: unused
2870
     */
2871
    int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2872
    int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2873
    int64_t pts_correction_last_pts;       /// PTS of the last frame
2874
    int64_t pts_correction_last_dts;       /// DTS of the last frame
2875

    
2876
    /**
2877
     * desired sample format
2878
     * - encoding: Not used.
2879
     * - decoding: Set by user.
2880
     * Decoder will decode to this format if it can.
2881
     */
2882
    enum AVSampleFormat request_sample_fmt;
2883

    
2884
} AVCodecContext;
2885

    
2886
/**
2887
 * AVProfile.
2888
 */
2889
typedef struct AVProfile {
2890
    int profile;
2891
    const char *name; ///< short name for the profile
2892
} AVProfile;
2893

    
2894
/**
2895
 * AVCodec.
2896
 */
2897
typedef struct AVCodec {
2898
    /**
2899
     * Name of the codec implementation.
2900
     * The name is globally unique among encoders and among decoders (but an
2901
     * encoder and a decoder can share the same name).
2902
     * This is the primary way to find a codec from the user perspective.
2903
     */
2904
    const char *name;
2905
    enum AVMediaType type;
2906
    enum CodecID id;
2907
    int priv_data_size;
2908
    int (*init)(AVCodecContext *);
2909
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2910
    int (*close)(AVCodecContext *);
2911
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2912
    /**
2913
     * Codec capabilities.
2914
     * see CODEC_CAP_*
2915
     */
2916
    int capabilities;
2917
    struct AVCodec *next;
2918
    /**
2919
     * Flush buffers.
2920
     * Will be called when seeking
2921
     */
2922
    void (*flush)(AVCodecContext *);
2923
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2924
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2925
    /**
2926
     * Descriptive name for the codec, meant to be more human readable than name.
2927
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2928
     */
2929
    const char *long_name;
2930
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2931
    const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2932
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2933
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2934
    const AVClass *priv_class;              ///< AVClass for the private context
2935
    const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2936

    
2937
    /**
2938
     * @defgroup framethreading Frame-level threading support functions.
2939
     * @{
2940
     */
2941
    /**
2942
     * If defined, called on thread contexts when they are created.
2943
     * If the codec allocates writable tables in init(), re-allocate them here.
2944
     * priv_data will be set to a copy of the original.
2945
     */
2946
    int (*init_thread_copy)(AVCodecContext *);
2947
    /**
2948
     * Copy necessary context variables from a previous thread context to the current one.
2949
     * If not defined, the next thread will start automatically; otherwise, the codec
2950
     * must call ff_thread_finish_setup().
2951
     *
2952
     * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2953
     */
2954
    int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2955
    /** @} */
2956
} AVCodec;
2957

    
2958
/**
2959
 * AVHWAccel.
2960
 */
2961
typedef struct AVHWAccel {
2962
    /**
2963
     * Name of the hardware accelerated codec.
2964
     * The name is globally unique among encoders and among decoders (but an
2965
     * encoder and a decoder can share the same name).
2966
     */
2967
    const char *name;
2968

    
2969
    /**
2970
     * Type of codec implemented by the hardware accelerator.
2971
     *
2972
     * See AVMEDIA_TYPE_xxx
2973
     */
2974
    enum AVMediaType type;
2975

    
2976
    /**
2977
     * Codec implemented by the hardware accelerator.
2978
     *
2979
     * See CODEC_ID_xxx
2980
     */
2981
    enum CodecID id;
2982

    
2983
    /**
2984
     * Supported pixel format.
2985
     *
2986
     * Only hardware accelerated formats are supported here.
2987
     */
2988
    enum PixelFormat pix_fmt;
2989

    
2990
    /**
2991
     * Hardware accelerated codec capabilities.
2992
     * see FF_HWACCEL_CODEC_CAP_*
2993
     */
2994
    int capabilities;
2995

    
2996
    struct AVHWAccel *next;
2997

    
2998
    /**
2999
     * Called at the beginning of each frame or field picture.
3000
     *
3001
     * Meaningful frame information (codec specific) is guaranteed to
3002
     * be parsed at this point. This function is mandatory.
3003
     *
3004
     * Note that buf can be NULL along with buf_size set to 0.
3005
     * Otherwise, this means the whole frame is available at this point.
3006
     *
3007
     * @param avctx the codec context
3008
     * @param buf the frame data buffer base
3009
     * @param buf_size the size of the frame in bytes
3010
     * @return zero if successful, a negative value otherwise
3011
     */
3012
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3013

    
3014
    /**
3015
     * Callback for each slice.
3016
     *
3017
     * Meaningful slice information (codec specific) is guaranteed to
3018
     * be parsed at this point. This function is mandatory.
3019
     *
3020
     * @param avctx the codec context
3021
     * @param buf the slice data buffer base
3022
     * @param buf_size the size of the slice in bytes
3023
     * @return zero if successful, a negative value otherwise
3024
     */
3025
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3026

    
3027
    /**
3028
     * Called at the end of each frame or field picture.
3029
     *
3030
     * The whole picture is parsed at this point and can now be sent
3031
     * to the hardware accelerator. This function is mandatory.
3032
     *
3033
     * @param avctx the codec context
3034
     * @return zero if successful, a negative value otherwise
3035
     */
3036
    int (*end_frame)(AVCodecContext *avctx);
3037

    
3038
    /**
3039
     * Size of HW accelerator private data.
3040
     *
3041
     * Private data is allocated with av_mallocz() before
3042
     * AVCodecContext.get_buffer() and deallocated after
3043
     * AVCodecContext.release_buffer().
3044
     */
3045
    int priv_data_size;
3046
} AVHWAccel;
3047

    
3048
/**
3049
 * four components are given, that's all.
3050
 * the last component is alpha
3051
 */
3052
typedef struct AVPicture {
3053
    uint8_t *data[4];
3054
    int linesize[4];       ///< number of bytes per line
3055
} AVPicture;
3056

    
3057
#if FF_API_PALETTE_CONTROL
3058
/**
3059
 * AVPaletteControl
3060
 * This structure defines a method for communicating palette changes
3061
 * between and demuxer and a decoder.
3062
 *
3063
 * @deprecated Use AVPacket to send palette changes instead.
3064
 * This is totally broken.
3065
 */
3066
#define AVPALETTE_SIZE 1024
3067
#define AVPALETTE_COUNT 256
3068
typedef struct AVPaletteControl {
3069

    
3070
    /* Demuxer sets this to 1 to indicate the palette has changed;
3071
     * decoder resets to 0. */
3072
    int palette_changed;
3073

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

    
3080
} AVPaletteControl attribute_deprecated;
3081
#endif
3082

    
3083
enum AVSubtitleType {
3084
    SUBTITLE_NONE,
3085

    
3086
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3087

    
3088
    /**
3089
     * Plain text, the text field must be set by the decoder and is
3090
     * authoritative. ass and pict fields may contain approximations.
3091
     */
3092
    SUBTITLE_TEXT,
3093

    
3094
    /**
3095
     * Formatted text, the ass field must be set by the decoder and is
3096
     * authoritative. pict and text fields may contain approximations.
3097
     */
3098
    SUBTITLE_ASS,
3099
};
3100

    
3101
typedef struct AVSubtitleRect {
3102
    int x;         ///< top left corner  of pict, undefined when pict is not set
3103
    int y;         ///< top left corner  of pict, undefined when pict is not set
3104
    int w;         ///< width            of pict, undefined when pict is not set
3105
    int h;         ///< height           of pict, undefined when pict is not set
3106
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
3107

    
3108
    /**
3109
     * data+linesize for the bitmap of this subtitle.
3110
     * can be set for text/ass as well once they where rendered
3111
     */
3112
    AVPicture pict;
3113
    enum AVSubtitleType type;
3114

    
3115
    char *text;                     ///< 0 terminated plain UTF-8 text
3116

    
3117
    /**
3118
     * 0 terminated ASS/SSA compatible event line.
3119
     * The pressentation of this is unaffected by the other values in this
3120
     * struct.
3121
     */
3122
    char *ass;
3123
} AVSubtitleRect;
3124

    
3125
typedef struct AVSubtitle {
3126
    uint16_t format; /* 0 = graphics */
3127
    uint32_t start_display_time; /* relative to packet pts, in ms */
3128
    uint32_t end_display_time; /* relative to packet pts, in ms */
3129
    unsigned num_rects;
3130
    AVSubtitleRect **rects;
3131
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3132
} AVSubtitle;
3133

    
3134
/* packet functions */
3135

    
3136
/**
3137
 * @deprecated use NULL instead
3138
 */
3139
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3140

    
3141
/**
3142
 * Default packet destructor.
3143
 */
3144
void av_destruct_packet(AVPacket *pkt);
3145

    
3146
/**
3147
 * Initialize optional fields of a packet with default values.
3148
 *
3149
 * @param pkt packet
3150
 */
3151
void av_init_packet(AVPacket *pkt);
3152

    
3153
/**
3154
 * Allocate the payload of a packet and initialize its fields with
3155
 * default values.
3156
 *
3157
 * @param pkt packet
3158
 * @param size wanted payload size
3159
 * @return 0 if OK, AVERROR_xxx otherwise
3160
 */
3161
int av_new_packet(AVPacket *pkt, int size);
3162

    
3163
/**
3164
 * Reduce packet size, correctly zeroing padding
3165
 *
3166
 * @param pkt packet
3167
 * @param size new size
3168
 */
3169
void av_shrink_packet(AVPacket *pkt, int size);
3170

    
3171
/**
3172
 * Increase packet size, correctly zeroing padding
3173
 *
3174
 * @param pkt packet
3175
 * @param grow_by number of bytes by which to increase the size of the packet
3176
 */
3177
int av_grow_packet(AVPacket *pkt, int grow_by);
3178

    
3179
/**
3180
 * @warning This is a hack - the packet memory allocation stuff is broken. The
3181
 * packet is allocated if it was not really allocated.
3182
 */
3183
int av_dup_packet(AVPacket *pkt);
3184

    
3185
/**
3186
 * Free a packet.
3187
 *
3188
 * @param pkt packet to free
3189
 */
3190
void av_free_packet(AVPacket *pkt);
3191

    
3192
/**
3193
 * Allocate new information of a packet.
3194
 *
3195
 * @param pkt packet
3196
 * @param type side information type
3197
 * @param size side information size
3198
 * @return pointer to fresh allocated data or NULL otherwise
3199
 */
3200
uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3201
                                 int size);
3202

    
3203
/**
3204
 * Get side information from packet.
3205
 *
3206
 * @param pkt packet
3207
 * @param type desired side information type
3208
 * @param size pointer for side information size to store (optional)
3209
 * @return pointer to data if present or NULL otherwise
3210
 */
3211
uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3212
                                 int *size);
3213

    
3214
/* resample.c */
3215

    
3216
struct ReSampleContext;
3217
struct AVResampleContext;
3218

    
3219
typedef struct ReSampleContext ReSampleContext;
3220

    
3221
/**
3222
 *  Initialize audio resampling context.
3223
 *
3224
 * @param output_channels  number of output channels
3225
 * @param input_channels   number of input channels
3226
 * @param output_rate      output sample rate
3227
 * @param input_rate       input sample rate
3228
 * @param sample_fmt_out   requested output sample format
3229
 * @param sample_fmt_in    input sample format
3230
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3231
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3232
 * @param linear           if 1 then the used FIR filter will be linearly interpolated
3233
                           between the 2 closest, if 0 the closest will be used
3234
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3235
 * @return allocated ReSampleContext, NULL if error occured
3236
 */
3237
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3238
                                        int output_rate, int input_rate,
3239
                                        enum AVSampleFormat sample_fmt_out,
3240
                                        enum AVSampleFormat sample_fmt_in,
3241
                                        int filter_length, int log2_phase_count,
3242
                                        int linear, double cutoff);
3243

    
3244
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3245

    
3246
/**
3247
 * Free resample context.
3248
 *
3249
 * @param s a non-NULL pointer to a resample context previously
3250
 *          created with av_audio_resample_init()
3251
 */
3252
void audio_resample_close(ReSampleContext *s);
3253

    
3254

    
3255
/**
3256
 * Initialize an audio resampler.
3257
 * Note, if either rate is not an integer then simply scale both rates up so they are.
3258
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3259
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3260
 * @param linear If 1 then the used FIR filter will be linearly interpolated
3261
                 between the 2 closest, if 0 the closest will be used
3262
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3263
 */
3264
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3265

    
3266
/**
3267
 * Resample an array of samples using a previously configured context.
3268
 * @param src an array of unconsumed samples
3269
 * @param consumed the number of samples of src which have been consumed are returned here
3270
 * @param src_size the number of unconsumed samples available
3271
 * @param dst_size the amount of space in samples available in dst
3272
 * @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.
3273
 * @return the number of samples written in dst or -1 if an error occurred
3274
 */
3275
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3276

    
3277

    
3278
/**
3279
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3280
 * the resampler parameters, so no audible clicks or similar distortions occur
3281
 * @param compensation_distance distance in output samples over which the compensation should be performed
3282
 * @param sample_delta number of output samples which should be output less
3283
 *
3284
 * example: av_resample_compensate(c, 10, 500)
3285
 * here instead of 510 samples only 500 samples would be output
3286
 *
3287
 * note, due to rounding the actual compensation might be slightly different,
3288
 * especially if the compensation_distance is large and the in_rate used during init is small
3289
 */
3290
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3291
void av_resample_close(struct AVResampleContext *c);
3292

    
3293
/**
3294
 * Allocate memory for a picture.  Call avpicture_free() to free it.
3295
 *
3296
 * \see avpicture_fill()
3297
 *
3298
 * @param picture the picture to be filled in
3299
 * @param pix_fmt the format of the picture
3300
 * @param width the width of the picture
3301
 * @param height the height of the picture
3302
 * @return zero if successful, a negative value if not
3303
 */
3304
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3305

    
3306
/**
3307
 * Free a picture previously allocated by avpicture_alloc().
3308
 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3309
 * itself is not.
3310
 *
3311
 * @param picture the AVPicture to be freed
3312
 */
3313
void avpicture_free(AVPicture *picture);
3314

    
3315
/**
3316
 * Fill in the AVPicture fields.
3317
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3318
 * which points to the image data buffer. Depending on the specified picture
3319
 * format, one or multiple image data pointers and line sizes will be set.
3320
 * If a planar format is specified, several pointers will be set pointing to
3321
 * the different picture planes and the line sizes of the different planes
3322
 * will be stored in the lines_sizes array.
3323
 * Call with ptr == NULL to get the required size for the ptr buffer.
3324
 *
3325
 * To allocate the buffer and fill in the AVPicture fields in one call,
3326
 * use avpicture_alloc().
3327
 *
3328
 * @param picture AVPicture whose fields are to be filled in
3329
 * @param ptr Buffer which will contain or contains the actual image data
3330
 * @param pix_fmt The format in which the picture data is stored.
3331
 * @param width the width of the image in pixels
3332
 * @param height the height of the image in pixels
3333
 * @return size of the image data in bytes
3334
 */
3335
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3336
                   enum PixelFormat pix_fmt, int width, int height);
3337

    
3338
/**
3339
 * Copy pixel data from an AVPicture into a buffer.
3340
 * The data is stored compactly, without any gaps for alignment or padding
3341
 * which may be applied by avpicture_fill().
3342
 *
3343
 * \see avpicture_get_size()
3344
 *
3345
 * @param[in] src AVPicture containing image data
3346
 * @param[in] pix_fmt The format in which the picture data is stored.
3347
 * @param[in] width the width of the image in pixels.
3348
 * @param[in] height the height of the image in pixels.
3349
 * @param[out] dest A buffer into which picture data will be copied.
3350
 * @param[in] dest_size The size of 'dest'.
3351
 * @return The number of bytes written to dest, or a negative value (error code) on error.
3352
 */
3353
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3354
                     unsigned char *dest, int dest_size);
3355

    
3356
/**
3357
 * Calculate the size in bytes that a picture of the given width and height
3358
 * would occupy if stored in the given picture format.
3359
 * Note that this returns the size of a compact representation as generated
3360
 * by avpicture_layout(), which can be smaller than the size required for e.g.
3361
 * avpicture_fill().
3362
 *
3363
 * @param pix_fmt the given picture format
3364
 * @param width the width of the image
3365
 * @param height the height of the image
3366
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3367
 */
3368
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3369
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3370

    
3371
/**
3372
 * Return the short name for a pixel format.
3373
 *
3374
 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3375
 */
3376
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3377

    
3378
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3379

    
3380
/**
3381
 * Return a value representing the fourCC code associated to the
3382
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3383
 * found.
3384
 */
3385
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3386

    
3387
/**
3388
 * Put a string representing the codec tag codec_tag in buf.
3389
 *
3390
 * @param buf_size size in bytes of buf
3391
 * @return the length of the string that would have been generated if
3392
 * enough space had been available, excluding the trailing null
3393
 */
3394
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3395

    
3396
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3397
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3398
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3399
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3400
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3401
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3402

    
3403
/**
3404
 * Compute what kind of losses will occur when converting from one specific
3405
 * pixel format to another.
3406
 * When converting from one pixel format to another, information loss may occur.
3407
 * For example, when converting from RGB24 to GRAY, the color information will
3408
 * be lost. Similarly, other losses occur when converting from some formats to
3409
 * other formats. These losses can involve loss of chroma, but also loss of
3410
 * resolution, loss of color depth, loss due to the color space conversion, loss
3411
 * of the alpha bits or loss due to color quantization.
3412
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3413
 * which will occur when converting from one pixel format to another.
3414
 *
3415
 * @param[in] dst_pix_fmt destination pixel format
3416
 * @param[in] src_pix_fmt source pixel format
3417
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3418
 * @return Combination of flags informing you what kind of losses will occur.
3419
 */
3420
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3421
                             int has_alpha);
3422

    
3423
/**
3424
 * Find the best pixel format to convert to given a certain source pixel
3425
 * format.  When converting from one pixel format to another, information loss
3426
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3427
 * information will be lost. Similarly, other losses occur when converting from
3428
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3429
 * the given pixel formats should be used to suffer the least amount of loss.
3430
 * The pixel formats from which it chooses one, are determined by the
3431
 * pix_fmt_mask parameter.
3432
 *
3433
 * @code
3434
 * src_pix_fmt = PIX_FMT_YUV420P;
3435
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3436
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3437
 * @endcode
3438
 *
3439
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3440
 * @param[in] src_pix_fmt source pixel format
3441
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3442
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3443
 * @return The best pixel format to convert to or -1 if none was found.
3444
 */
3445
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3446
                              int has_alpha, int *loss_ptr);
3447

    
3448
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3449
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3450

    
3451
/**
3452
 * Tell if an image really has transparent alpha values.
3453
 * @return ored mask of FF_ALPHA_xxx constants
3454
 */
3455
int img_get_alpha_info(const AVPicture *src,
3456
                       enum PixelFormat pix_fmt, int width, int height);
3457

    
3458
/* deinterlace a picture */
3459
/* deinterlace - if not supported return -1 */
3460
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3461
                          enum PixelFormat pix_fmt, int width, int height);
3462

    
3463
/* external high level API */
3464

    
3465
/**
3466
 * If c is NULL, returns the first registered codec,
3467
 * if c is non-NULL, returns the next registered codec after c,
3468
 * or NULL if c is the last one.
3469
 */
3470
AVCodec *av_codec_next(AVCodec *c);
3471

    
3472
/**
3473
 * Return the LIBAVCODEC_VERSION_INT constant.
3474
 */
3475
unsigned avcodec_version(void);
3476

    
3477
/**
3478
 * Return the libavcodec build-time configuration.
3479
 */
3480
const char *avcodec_configuration(void);
3481

    
3482
/**
3483
 * Return the libavcodec license.
3484
 */
3485
const char *avcodec_license(void);
3486

    
3487
/**
3488
 * Initialize libavcodec.
3489
 * If called more than once, does nothing.
3490
 *
3491
 * @warning This function must be called before any other libavcodec
3492
 * function.
3493
 *
3494
 * @warning This function is not thread-safe.
3495
 */
3496
void avcodec_init(void);
3497

    
3498
/**
3499
 * Register the codec codec and initialize libavcodec.
3500
 *
3501
 * @see avcodec_init(), avcodec_register_all()
3502
 */
3503
void avcodec_register(AVCodec *codec);
3504

    
3505
/**
3506
 * Find a registered encoder with a matching codec ID.
3507
 *
3508
 * @param id CodecID of the requested encoder
3509
 * @return An encoder if one was found, NULL otherwise.
3510
 */
3511
AVCodec *avcodec_find_encoder(enum CodecID id);
3512

    
3513
/**
3514
 * Find a registered encoder with the specified name.
3515
 *
3516
 * @param name name of the requested encoder
3517
 * @return An encoder if one was found, NULL otherwise.
3518
 */
3519
AVCodec *avcodec_find_encoder_by_name(const char *name);
3520

    
3521
/**
3522
 * Find a registered decoder with a matching codec ID.
3523
 *
3524
 * @param id CodecID of the requested decoder
3525
 * @return A decoder if one was found, NULL otherwise.
3526
 */
3527
AVCodec *avcodec_find_decoder(enum CodecID id);
3528

    
3529
/**
3530
 * Find a registered decoder with the specified name.
3531
 *
3532
 * @param name name of the requested decoder
3533
 * @return A decoder if one was found, NULL otherwise.
3534
 */
3535
AVCodec *avcodec_find_decoder_by_name(const char *name);
3536
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3537

    
3538
/**
3539
 * Return a name for the specified profile, if available.
3540
 *
3541
 * @param codec the codec that is searched for the given profile
3542
 * @param profile the profile value for which a name is requested
3543
 * @return A name for the profile if found, NULL otherwise.
3544
 */
3545
const char *av_get_profile_name(const AVCodec *codec, int profile);
3546

    
3547
/**
3548
 * Set the fields of the given AVCodecContext to default values.
3549
 *
3550
 * @param s The AVCodecContext of which the fields should be set to default values.
3551
 */
3552
void avcodec_get_context_defaults(AVCodecContext *s);
3553

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

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

    
3562
/**
3563
 * Allocate an AVCodecContext and set its fields to default values.  The
3564
 * resulting struct can be deallocated by simply calling av_free().
3565
 *
3566
 * @return An AVCodecContext filled with default values or NULL on failure.
3567
 * @see avcodec_get_context_defaults
3568
 */
3569
AVCodecContext *avcodec_alloc_context(void);
3570

    
3571
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3572
 *  we WILL change its arguments and name a few times! */
3573
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3574

    
3575
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3576
 *  we WILL change its arguments and name a few times! */
3577
AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3578

    
3579
/**
3580
 * Copy the settings of the source AVCodecContext into the destination
3581
 * AVCodecContext. The resulting destination codec context will be
3582
 * unopened, i.e. you are required to call avcodec_open() before you
3583
 * can use this AVCodecContext to decode/encode video/audio data.
3584
 *
3585
 * @param dest target codec context, should be initialized with
3586
 *             avcodec_alloc_context(), but otherwise uninitialized
3587
 * @param src source codec context
3588
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3589
 */
3590
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3591

    
3592
/**
3593
 * Set the fields of the given AVFrame to default values.
3594
 *
3595
 * @param pic The AVFrame of which the fields should be set to default values.
3596
 */
3597
void avcodec_get_frame_defaults(AVFrame *pic);
3598

    
3599
/**
3600
 * Allocate an AVFrame and set its fields to default values.  The resulting
3601
 * struct can be deallocated by simply calling av_free().
3602
 *
3603
 * @return An AVFrame filled with default values or NULL on failure.
3604
 * @see avcodec_get_frame_defaults
3605
 */
3606
AVFrame *avcodec_alloc_frame(void);
3607

    
3608
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3609
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3610
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3611

    
3612
/**
3613
 * Return the amount of padding in pixels which the get_buffer callback must
3614
 * provide around the edge of the image for codecs which do not have the
3615
 * CODEC_FLAG_EMU_EDGE flag.
3616
 *
3617
 * @return Required padding in pixels.
3618
 */
3619
unsigned avcodec_get_edge_width(void);
3620
/**
3621
 * Modify width and height values so that they will result in a memory
3622
 * buffer that is acceptable for the codec if you do not use any horizontal
3623
 * padding.
3624
 *
3625
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3626
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3627
 * according to avcodec_get_edge_width() before.
3628
 */
3629
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3630
/**
3631
 * Modify width and height values so that they will result in a memory
3632
 * buffer that is acceptable for the codec if you also ensure that all
3633
 * line sizes are a multiple of the respective linesize_align[i].
3634
 *
3635
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3636
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3637
 * according to avcodec_get_edge_width() before.
3638
 */
3639
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3640
                               int linesize_align[4]);
3641

    
3642
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3643

    
3644
#if FF_API_THREAD_INIT
3645
/**
3646
 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3647
 */
3648
attribute_deprecated
3649
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3650
#endif
3651

    
3652
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3653
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3654
//FIXME func typedef
3655

    
3656
/**
3657
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3658
 * function the context has to be allocated.
3659
 *
3660
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3661
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3662
 * retrieving a codec.
3663
 *
3664
 * @warning This function is not thread safe!
3665
 *
3666
 * @code
3667
 * avcodec_register_all();
3668
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3669
 * if (!codec)
3670
 *     exit(1);
3671
 *
3672
 * context = avcodec_alloc_context();
3673
 *
3674
 * if (avcodec_open(context, codec) < 0)
3675
 *     exit(1);
3676
 * @endcode
3677
 *
3678
 * @param avctx The context which will be set up to use the given codec.
3679
 * @param codec The codec to use within the context.
3680
 * @return zero on success, a negative value on error
3681
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3682
 */
3683
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3684

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

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

    
3772
/**
3773
 * Decode a subtitle message.
3774
 * Return a negative value on error, otherwise return the number of bytes used.
3775
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3776
 * Otherwise, the subtitle is stored in *sub.
3777
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3778
 * simplicity, because the performance difference is expect to be negligible
3779
 * and reusing a get_buffer written for video codecs would probably perform badly
3780
 * due to a potentially very different allocation pattern.
3781
 *
3782
 * @param avctx the codec context
3783
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3784
                   freed with avsubtitle_free if *got_sub_ptr is set.
3785
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3786
 * @param[in] avpkt The input AVPacket containing the input buffer.
3787
 */
3788
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3789
                            int *got_sub_ptr,
3790
                            AVPacket *avpkt);
3791

    
3792
/**
3793
 * Frees all allocated data in the given subtitle struct.
3794
 *
3795
 * @param sub AVSubtitle to free.
3796
 */
3797
void avsubtitle_free(AVSubtitle *sub);
3798

    
3799
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3800
                        int *data_size_ptr,
3801
                        uint8_t *buf, int buf_size);
3802

    
3803
/**
3804
 * Encode an audio frame from samples into buf.
3805
 *
3806
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3807
 * However, for PCM audio the user will know how much space is needed
3808
 * because it depends on the value passed in buf_size as described
3809
 * below. In that case a lower value can be used.
3810
 *
3811
 * @param avctx the codec context
3812
 * @param[out] buf the output buffer
3813
 * @param[in] buf_size the output buffer size
3814
 * @param[in] samples the input buffer containing the samples
3815
 * The number of samples read from this buffer is frame_size*channels,
3816
 * both of which are defined in avctx.
3817
 * For PCM audio the number of samples read from samples is equal to
3818
 * buf_size * input_sample_size / output_sample_size.
3819
 * @return On error a negative value is returned, on success zero or the number
3820
 * of bytes used to encode the data read from the input buffer.
3821
 */
3822
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3823
                         const short *samples);
3824

    
3825
/**
3826
 * Encode a video frame from pict into buf.
3827
 * The input picture should be
3828
 * stored using a specific format, namely avctx.pix_fmt.
3829
 *
3830
 * @param avctx the codec context
3831
 * @param[out] buf the output buffer for the bitstream of encoded frame
3832
 * @param[in] buf_size the size of the output buffer in bytes
3833
 * @param[in] pict the input picture to encode
3834
 * @return On error a negative value is returned, on success zero or the number
3835
 * of bytes used from the output buffer.
3836
 */
3837
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3838
                         const AVFrame *pict);
3839
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3840
                            const AVSubtitle *sub);
3841

    
3842
int avcodec_close(AVCodecContext *avctx);
3843

    
3844
/**
3845
 * Register all the codecs, parsers and bitstream filters which were enabled at
3846
 * configuration time. If you do not call this function you can select exactly
3847
 * which formats you want to support, by using the individual registration
3848
 * functions.
3849
 *
3850
 * @see avcodec_register
3851
 * @see av_register_codec_parser
3852
 * @see av_register_bitstream_filter
3853
 */
3854
void avcodec_register_all(void);
3855

    
3856
/**
3857
 * Flush buffers, should be called when seeking or when switching to a different stream.
3858
 */
3859
void avcodec_flush_buffers(AVCodecContext *avctx);
3860

    
3861
void avcodec_default_free_buffers(AVCodecContext *s);
3862

    
3863
/* misc useful functions */
3864

    
3865
#if FF_API_OLD_FF_PICT_TYPES
3866
/**
3867
 * Return a single letter to describe the given picture type pict_type.
3868
 *
3869
 * @param[in] pict_type the picture type
3870
 * @return A single character representing the picture type.
3871
 * @deprecated Use av_get_picture_type_char() instead.
3872
 */
3873
attribute_deprecated
3874
char av_get_pict_type_char(int pict_type);
3875
#endif
3876

    
3877
/**
3878
 * Return codec bits per sample.
3879
 *
3880
 * @param[in] codec_id the codec
3881
 * @return Number of bits per sample or zero if unknown for the given codec.
3882
 */
3883
int av_get_bits_per_sample(enum CodecID codec_id);
3884

    
3885
#if FF_API_OLD_SAMPLE_FMT
3886
/**
3887
 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3888
 */
3889
attribute_deprecated
3890
int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3891
#endif
3892

    
3893
/* frame parsing */
3894
typedef struct AVCodecParserContext {
3895
    void *priv_data;
3896
    struct AVCodecParser *parser;
3897
    int64_t frame_offset; /* offset of the current frame */
3898
    int64_t cur_offset; /* current offset
3899
                           (incremented by each av_parser_parse()) */
3900
    int64_t next_frame_offset; /* offset of the next frame */
3901
    /* video info */
3902
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3903
    /**
3904
     * This field is used for proper frame duration computation in lavf.
3905
     * It signals, how much longer the frame duration of the current frame
3906
     * is compared to normal frame duration.
3907
     *
3908
     * frame_duration = (1 + repeat_pict) * time_base
3909
     *
3910
     * It is used by codecs like H.264 to display telecined material.
3911
     */
3912
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3913
    int64_t pts;     /* pts of the current frame */
3914
    int64_t dts;     /* dts of the current frame */
3915

    
3916
    /* private data */
3917
    int64_t last_pts;
3918
    int64_t last_dts;
3919
    int fetch_timestamp;
3920

    
3921
#define AV_PARSER_PTS_NB 4
3922
    int cur_frame_start_index;
3923
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3924
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3925
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3926

    
3927
    int flags;
3928
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3929
#define PARSER_FLAG_ONCE                      0x0002
3930
/// Set if the parser has a valid file offset
3931
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
3932

    
3933
    int64_t offset;      ///< byte offset from starting packet start
3934
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3935

    
3936
    /*!
3937
     * Set by parser to 1 for key frames and 0 for non-key frames.
3938
     * It is initialized to -1, so if the parser doesn't set this flag,
3939
     * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3940
     * will be used.
3941
     */
3942
    int key_frame;
3943

    
3944
    /**
3945
     * Time difference in stream time base units from the pts of this
3946
     * packet to the point at which the output from the decoder has converged
3947
     * independent from the availability of previous frames. That is, the
3948
     * frames are virtually identical no matter if decoding started from
3949
     * the very first frame or from this keyframe.
3950
     * Is AV_NOPTS_VALUE if unknown.
3951
     * This field is not the display duration of the current frame.
3952
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3953
     * set.
3954
     *
3955
     * The purpose of this field is to allow seeking in streams that have no
3956
     * keyframes in the conventional sense. It corresponds to the
3957
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3958
     * essential for some types of subtitle streams to ensure that all
3959
     * subtitles are correctly displayed after seeking.
3960
     */
3961
    int64_t convergence_duration;
3962

    
3963
    // Timestamp generation support:
3964
    /**
3965
     * Synchronization point for start of timestamp generation.
3966
     *
3967
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3968
     * (default).
3969
     *
3970
     * For example, this corresponds to presence of H.264 buffering period
3971
     * SEI message.
3972
     */
3973
    int dts_sync_point;
3974

    
3975
    /**
3976
     * Offset of the current timestamp against last timestamp sync point in
3977
     * units of AVCodecContext.time_base.
3978
     *
3979
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3980
     * contain a valid timestamp offset.
3981
     *
3982
     * Note that the timestamp of sync point has usually a nonzero
3983
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3984
     * the next frame after timestamp sync point will be usually 1.
3985
     *
3986
     * For example, this corresponds to H.264 cpb_removal_delay.
3987
     */
3988
    int dts_ref_dts_delta;
3989

    
3990
    /**
3991
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3992
     *
3993
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3994
     * contain valid non-negative timestamp delta (presentation time of a frame
3995
     * must not lie in the past).
3996
     *
3997
     * This delay represents the difference between decoding and presentation
3998
     * time of the frame.
3999
     *
4000
     * For example, this corresponds to H.264 dpb_output_delay.
4001
     */
4002
    int pts_dts_delta;
4003

    
4004
    /**
4005
     * Position of the packet in file.
4006
     *
4007
     * Analogous to cur_frame_pts/dts
4008
     */
4009
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4010

    
4011
    /**
4012
     * Byte position of currently parsed frame in stream.
4013
     */
4014
    int64_t pos;
4015

    
4016
    /**
4017
     * Previous frame byte position.
4018
     */
4019
    int64_t last_pos;
4020
} AVCodecParserContext;
4021

    
4022
typedef struct AVCodecParser {
4023
    int codec_ids[5]; /* several codec IDs are permitted */
4024
    int priv_data_size;
4025
    int (*parser_init)(AVCodecParserContext *s);
4026
    int (*parser_parse)(AVCodecParserContext *s,
4027
                        AVCodecContext *avctx,
4028
                        const uint8_t **poutbuf, int *poutbuf_size,
4029
                        const uint8_t *buf, int buf_size);
4030
    void (*parser_close)(AVCodecParserContext *s);
4031
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4032
    struct AVCodecParser *next;
4033
} AVCodecParser;
4034

    
4035
AVCodecParser *av_parser_next(AVCodecParser *c);
4036

    
4037
void av_register_codec_parser(AVCodecParser *parser);
4038
AVCodecParserContext *av_parser_init(int codec_id);
4039

    
4040
/**
4041
 * Parse a packet.
4042
 *
4043
 * @param s             parser context.
4044
 * @param avctx         codec context.
4045
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4046
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4047
 * @param buf           input buffer.
4048
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4049
 * @param pts           input presentation timestamp.
4050
 * @param dts           input decoding timestamp.
4051
 * @param pos           input byte position in stream.
4052
 * @return the number of bytes of the input bitstream used.
4053
 *
4054
 * Example:
4055
 * @code
4056
 *   while(in_len){
4057
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4058
 *                                        in_data, in_len,
4059
 *                                        pts, dts, pos);
4060
 *       in_data += len;
4061
 *       in_len  -= len;
4062
 *
4063
 *       if(size)
4064
 *          decode_frame(data, size);
4065
 *   }
4066
 * @endcode
4067
 */
4068
int av_parser_parse2(AVCodecParserContext *s,
4069
                     AVCodecContext *avctx,
4070
                     uint8_t **poutbuf, int *poutbuf_size,
4071
                     const uint8_t *buf, int buf_size,
4072
                     int64_t pts, int64_t dts,
4073
                     int64_t pos);
4074

    
4075
int av_parser_change(AVCodecParserContext *s,
4076
                     AVCodecContext *avctx,
4077
                     uint8_t **poutbuf, int *poutbuf_size,
4078
                     const uint8_t *buf, int buf_size, int keyframe);
4079
void av_parser_close(AVCodecParserContext *s);
4080

    
4081

    
4082
typedef struct AVBitStreamFilterContext {
4083
    void *priv_data;
4084
    struct AVBitStreamFilter *filter;
4085
    AVCodecParserContext *parser;
4086
    struct AVBitStreamFilterContext *next;
4087
} AVBitStreamFilterContext;
4088

    
4089

    
4090
typedef struct AVBitStreamFilter {
4091
    const char *name;
4092
    int priv_data_size;
4093
    int (*filter)(AVBitStreamFilterContext *bsfc,
4094
                  AVCodecContext *avctx, const char *args,
4095
                  uint8_t **poutbuf, int *poutbuf_size,
4096
                  const uint8_t *buf, int buf_size, int keyframe);
4097
    void (*close)(AVBitStreamFilterContext *bsfc);
4098
    struct AVBitStreamFilter *next;
4099
} AVBitStreamFilter;
4100

    
4101
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4102
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4103
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4104
                               AVCodecContext *avctx, const char *args,
4105
                               uint8_t **poutbuf, int *poutbuf_size,
4106
                               const uint8_t *buf, int buf_size, int keyframe);
4107
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4108

    
4109
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4110

    
4111
/* memory */
4112

    
4113
/**
4114
 * Reallocate the given block if it is not large enough, otherwise do nothing.
4115
 *
4116
 * @see av_realloc
4117
 */
4118
void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4119

    
4120
/**
4121
 * Allocate a buffer, reusing the given one if large enough.
4122
 *
4123
 * Contrary to av_fast_realloc the current buffer contents might not be
4124
 * preserved and on error the old buffer is freed, thus no special
4125
 * handling to avoid memleaks is necessary.
4126
 *
4127
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4128
 * @param size size of the buffer *ptr points to
4129
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4130
 *                 *size 0 if an error occurred.
4131
 */
4132
void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4133

    
4134
/**
4135
 * Copy image src to dst. Wraps av_picture_data_copy() above.
4136
 */
4137
void av_picture_copy(AVPicture *dst, const AVPicture *src,
4138
                     enum PixelFormat pix_fmt, int width, int height);
4139

    
4140
/**
4141
 * Crop image top and left side.
4142
 */
4143
int av_picture_crop(AVPicture *dst, const AVPicture *src,
4144
                    enum PixelFormat pix_fmt, int top_band, int left_band);
4145

    
4146
/**
4147
 * Pad image.
4148
 */
4149
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4150
            int padtop, int padbottom, int padleft, int padright, int *color);
4151

    
4152
/**
4153
 * Encode extradata length to a buffer. Used by xiph codecs.
4154
 *
4155
 * @param s buffer to write to; must be at least (v/255+1) bytes long
4156
 * @param v size of extradata in bytes
4157
 * @return number of bytes written to the buffer.
4158
 */
4159
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4160

    
4161
/**
4162
 * Logs a generic warning message about a missing feature. This function is
4163
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4164
 * only, and would normally not be used by applications.
4165
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4166
 * a pointer to an AVClass struct
4167
 * @param[in] feature string containing the name of the missing feature
4168
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4169
 * If want_sample is non-zero, additional verbage will be added to the log
4170
 * message which tells the user how to report samples to the development
4171
 * mailing list.
4172
 */
4173
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4174

    
4175
/**
4176
 * Log a generic warning message asking for a sample. This function is
4177
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4178
 * only, and would normally not be used by applications.
4179
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4180
 * a pointer to an AVClass struct
4181
 * @param[in] msg string containing an optional message, or NULL if no message
4182
 */
4183
void av_log_ask_for_sample(void *avc, const char *msg, ...);
4184

    
4185
/**
4186
 * Register the hardware accelerator hwaccel.
4187
 */
4188
void av_register_hwaccel(AVHWAccel *hwaccel);
4189

    
4190
/**
4191
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4192
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4193
 * after hwaccel, or NULL if hwaccel is the last one.
4194
 */
4195
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4196

    
4197

    
4198
/**
4199
 * Lock operation used by lockmgr
4200
 */
4201
enum AVLockOp {
4202
  AV_LOCK_CREATE,  ///< Create a mutex
4203
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4204
  AV_LOCK_RELEASE, ///< Unlock the mutex
4205
  AV_LOCK_DESTROY, ///< Free mutex resources
4206
};
4207

    
4208
/**
4209
 * Register a user provided lock manager supporting the operations
4210
 * specified by AVLockOp. mutex points to a (void *) where the
4211
 * lockmgr should store/get a pointer to a user allocated mutex. It's
4212
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4213
 *
4214
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4215
 *           callback during the call to av_lockmgr_register().
4216
 *           Thus, the application must be prepared to handle that.
4217
 *           If cb is set to NULL the lockmgr will be unregistered.
4218
 *           Also note that during unregistration the previously registered
4219
 *           lockmgr callback may also be invoked.
4220
 */
4221
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4222

    
4223
#endif /* AVCODEC_AVCODEC_H */