← Back to branch summary

~ubuntu-branches/ubuntu/raring/libav/raring-security

« back to all changes in this revision

Viewing changes to .pc/post-0.7.1/0028-Remove-incorrect-info-in-documentation-of-AVCodecCon.patch/libavcodec/avcodec.h

  • Committer: Package Import Robot
  • Author(s): Reinhard Tartler
  • Date: 2011-09-28 09:18:34 UTC
  • mfrom: (1.3.7 sid)
  • Revision ID: package-import@ubuntu.com-20110928091834-w415mnuh06h4zpvc
Tags: 4:0.7.1-7ubuntu2
Revert "Convert package to include multiarch support."

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/post-0.7.1/0028-Remove-incorrect-info-in-documentation-of-AVCodecCon.patch/libavcodec/avcodec.h
 
1
/*
 
2
 * copyright (c) 2001 Fabrice Bellard
 
3
 *
 
4
 * This file is part of Libav.
 
5
 *
 
6
 * Libav 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
 * Libav 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 Libav; 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
    CODEC_ID_S302M,
 
236
 
 
237
    /* various ADPCM codecs */
 
238
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
 
239
    CODEC_ID_ADPCM_IMA_WAV,
 
240
    CODEC_ID_ADPCM_IMA_DK3,
 
241
    CODEC_ID_ADPCM_IMA_DK4,
 
242
    CODEC_ID_ADPCM_IMA_WS,
 
243
    CODEC_ID_ADPCM_IMA_SMJPEG,
 
244
    CODEC_ID_ADPCM_MS,
 
245
    CODEC_ID_ADPCM_4XM,
 
246
    CODEC_ID_ADPCM_XA,
 
247
    CODEC_ID_ADPCM_ADX,
 
248
    CODEC_ID_ADPCM_EA,
 
249
    CODEC_ID_ADPCM_G726,
 
250
    CODEC_ID_ADPCM_CT,
 
251
    CODEC_ID_ADPCM_SWF,
 
252
    CODEC_ID_ADPCM_YAMAHA,
 
253
    CODEC_ID_ADPCM_SBPRO_4,
 
254
    CODEC_ID_ADPCM_SBPRO_3,
 
255
    CODEC_ID_ADPCM_SBPRO_2,
 
256
    CODEC_ID_ADPCM_THP,
 
257
    CODEC_ID_ADPCM_IMA_AMV,
 
258
    CODEC_ID_ADPCM_EA_R1,
 
259
    CODEC_ID_ADPCM_EA_R3,
 
260
    CODEC_ID_ADPCM_EA_R2,
 
261
    CODEC_ID_ADPCM_IMA_EA_SEAD,
 
262
    CODEC_ID_ADPCM_IMA_EA_EACS,
 
263
    CODEC_ID_ADPCM_EA_XAS,
 
264
    CODEC_ID_ADPCM_EA_MAXIS_XA,
 
265
    CODEC_ID_ADPCM_IMA_ISS,
 
266
    CODEC_ID_ADPCM_G722,
 
267
 
 
268
    /* AMR */
 
269
    CODEC_ID_AMR_NB= 0x12000,
 
270
    CODEC_ID_AMR_WB,
 
271
 
 
272
    /* RealAudio codecs*/
 
273
    CODEC_ID_RA_144= 0x13000,
 
274
    CODEC_ID_RA_288,
 
275
 
 
276
    /* various DPCM codecs */
 
277
    CODEC_ID_ROQ_DPCM= 0x14000,
 
278
    CODEC_ID_INTERPLAY_DPCM,
 
279
    CODEC_ID_XAN_DPCM,
 
280
    CODEC_ID_SOL_DPCM,
 
281
 
 
282
    /* audio codecs */
 
283
    CODEC_ID_MP2= 0x15000,
 
284
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
 
285
    CODEC_ID_AAC,
 
286
    CODEC_ID_AC3,
 
287
    CODEC_ID_DTS,
 
288
    CODEC_ID_VORBIS,
 
289
    CODEC_ID_DVAUDIO,
 
290
    CODEC_ID_WMAV1,
 
291
    CODEC_ID_WMAV2,
 
292
    CODEC_ID_MACE3,
 
293
    CODEC_ID_MACE6,
 
294
    CODEC_ID_VMDAUDIO,
 
295
    CODEC_ID_SONIC,
 
296
    CODEC_ID_SONIC_LS,
 
297
    CODEC_ID_FLAC,
 
298
    CODEC_ID_MP3ADU,
 
299
    CODEC_ID_MP3ON4,
 
300
    CODEC_ID_SHORTEN,
 
301
    CODEC_ID_ALAC,
 
302
    CODEC_ID_WESTWOOD_SND1,
 
303
    CODEC_ID_GSM, ///< as in Berlin toast format
 
304
    CODEC_ID_QDM2,
 
305
    CODEC_ID_COOK,
 
306
    CODEC_ID_TRUESPEECH,
 
307
    CODEC_ID_TTA,
 
308
    CODEC_ID_SMACKAUDIO,
 
309
    CODEC_ID_QCELP,
 
310
    CODEC_ID_WAVPACK,
 
311
    CODEC_ID_DSICINAUDIO,
 
312
    CODEC_ID_IMC,
 
313
    CODEC_ID_MUSEPACK7,
 
314
    CODEC_ID_MLP,
 
315
    CODEC_ID_GSM_MS, /* as found in WAV */
 
316
    CODEC_ID_ATRAC3,
 
317
    CODEC_ID_VOXWARE,
 
318
    CODEC_ID_APE,
 
319
    CODEC_ID_NELLYMOSER,
 
320
    CODEC_ID_MUSEPACK8,
 
321
    CODEC_ID_SPEEX,
 
322
    CODEC_ID_WMAVOICE,
 
323
    CODEC_ID_WMAPRO,
 
324
    CODEC_ID_WMALOSSLESS,
 
325
    CODEC_ID_ATRAC3P,
 
326
    CODEC_ID_EAC3,
 
327
    CODEC_ID_SIPR,
 
328
    CODEC_ID_MP1,
 
329
    CODEC_ID_TWINVQ,
 
330
    CODEC_ID_TRUEHD,
 
331
    CODEC_ID_MP4ALS,
 
332
    CODEC_ID_ATRAC1,
 
333
    CODEC_ID_BINKAUDIO_RDFT,
 
334
    CODEC_ID_BINKAUDIO_DCT,
 
335
    CODEC_ID_AAC_LATM,
 
336
    CODEC_ID_QDMC,
 
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
 
 
349
    /* other specific kind of codecs (generally used for attachments) */
 
350
    CODEC_ID_TTF= 0x18000,
 
351
 
 
352
    CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
 
353
 
 
354
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 
355
                                * stream (only used by libavformat) */
 
356
    CODEC_ID_FFMETADATA=0x21000,   ///< Dummy codec for streams containing only metadata information.
 
357
};
 
358
 
 
359
#if FF_API_OLD_SAMPLE_FMT
 
360
#define SampleFormat AVSampleFormat
 
361
 
 
362
#define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
 
363
#define SAMPLE_FMT_U8   AV_SAMPLE_FMT_U8
 
364
#define SAMPLE_FMT_S16  AV_SAMPLE_FMT_S16
 
365
#define SAMPLE_FMT_S32  AV_SAMPLE_FMT_S32
 
366
#define SAMPLE_FMT_FLT  AV_SAMPLE_FMT_FLT
 
367
#define SAMPLE_FMT_DBL  AV_SAMPLE_FMT_DBL
 
368
#define SAMPLE_FMT_NB   AV_SAMPLE_FMT_NB
 
369
#endif
 
370
 
 
371
#if FF_API_OLD_AUDIOCONVERT
 
372
#include "libavutil/audioconvert.h"
 
373
 
 
374
/* Audio channel masks */
 
375
#define CH_FRONT_LEFT            AV_CH_FRONT_LEFT
 
376
#define CH_FRONT_RIGHT           AV_CH_FRONT_RIGHT
 
377
#define CH_FRONT_CENTER          AV_CH_FRONT_CENTER
 
378
#define CH_LOW_FREQUENCY         AV_CH_LOW_FREQUENCY
 
379
#define CH_BACK_LEFT             AV_CH_BACK_LEFT
 
380
#define CH_BACK_RIGHT            AV_CH_BACK_RIGHT
 
381
#define CH_FRONT_LEFT_OF_CENTER  AV_CH_FRONT_LEFT_OF_CENTER
 
382
#define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
 
383
#define CH_BACK_CENTER           AV_CH_BACK_CENTER
 
384
#define CH_SIDE_LEFT             AV_CH_SIDE_LEFT
 
385
#define CH_SIDE_RIGHT            AV_CH_SIDE_RIGHT
 
386
#define CH_TOP_CENTER            AV_CH_TOP_CENTER
 
387
#define CH_TOP_FRONT_LEFT        AV_CH_TOP_FRONT_LEFT
 
388
#define CH_TOP_FRONT_CENTER      AV_CH_TOP_FRONT_CENTER
 
389
#define CH_TOP_FRONT_RIGHT       AV_CH_TOP_FRONT_RIGHT
 
390
#define CH_TOP_BACK_LEFT         AV_CH_TOP_BACK_LEFT
 
391
#define CH_TOP_BACK_CENTER       AV_CH_TOP_BACK_CENTER
 
392
#define CH_TOP_BACK_RIGHT        AV_CH_TOP_BACK_RIGHT
 
393
#define CH_STEREO_LEFT           AV_CH_STEREO_LEFT
 
394
#define CH_STEREO_RIGHT          AV_CH_STEREO_RIGHT
 
395
 
 
396
/** Channel mask value used for AVCodecContext.request_channel_layout
 
397
    to indicate that the user requests the channel order of the decoder output
 
398
    to be the native codec channel order. */
 
399
#define CH_LAYOUT_NATIVE         AV_CH_LAYOUT_NATIVE
 
400
 
 
401
/* Audio channel convenience macros */
 
402
#define CH_LAYOUT_MONO           AV_CH_LAYOUT_MONO
 
403
#define CH_LAYOUT_STEREO         AV_CH_LAYOUT_STEREO
 
404
#define CH_LAYOUT_2_1            AV_CH_LAYOUT_2_1
 
405
#define CH_LAYOUT_SURROUND       AV_CH_LAYOUT_SURROUND
 
406
#define CH_LAYOUT_4POINT0        AV_CH_LAYOUT_4POINT0
 
407
#define CH_LAYOUT_2_2            AV_CH_LAYOUT_2_2
 
408
#define CH_LAYOUT_QUAD           AV_CH_LAYOUT_QUAD
 
409
#define CH_LAYOUT_5POINT0        AV_CH_LAYOUT_5POINT0
 
410
#define CH_LAYOUT_5POINT1        AV_CH_LAYOUT_5POINT1
 
411
#define CH_LAYOUT_5POINT0_BACK   AV_CH_LAYOUT_5POINT0_BACK
 
412
#define CH_LAYOUT_5POINT1_BACK   AV_CH_LAYOUT_5POINT1_BACK
 
413
#define CH_LAYOUT_7POINT0        AV_CH_LAYOUT_7POINT0
 
414
#define CH_LAYOUT_7POINT1        AV_CH_LAYOUT_7POINT1
 
415
#define CH_LAYOUT_7POINT1_WIDE   AV_CH_LAYOUT_7POINT1_WIDE
 
416
#define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
 
417
#endif
 
418
 
 
419
/* in bytes */
 
420
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
 
421
 
 
422
/**
 
423
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 
424
 * This is mainly needed because some optimized bitstream readers read
 
425
 * 32 or 64 bit at once and could read over the end.<br>
 
426
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 
427
 * MPEG bitstreams could cause overread and segfault.
 
428
 */
 
429
#define FF_INPUT_BUFFER_PADDING_SIZE 8
 
430
 
 
431
/**
 
432
 * minimum encoding buffer size
 
433
 * Used to avoid some checks during header writing.
 
434
 */
 
435
#define FF_MIN_BUFFER_SIZE 16384
 
436
 
 
437
 
 
438
/**
 
439
 * motion estimation type.
 
440
 */
 
441
enum Motion_Est_ID {
 
442
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 
443
    ME_FULL,
 
444
    ME_LOG,
 
445
    ME_PHODS,
 
446
    ME_EPZS,        ///< enhanced predictive zonal search
 
447
    ME_X1,          ///< reserved for experiments
 
448
    ME_HEX,         ///< hexagon based search
 
449
    ME_UMH,         ///< uneven multi-hexagon search
 
450
    ME_ITER,        ///< iterative search
 
451
    ME_TESA,        ///< transformed exhaustive search algorithm
 
452
};
 
453
 
 
454
enum AVDiscard{
 
455
    /* We leave some space between them for extensions (drop some
 
456
     * keyframes for intra-only or drop just some bidir frames). */
 
457
    AVDISCARD_NONE   =-16, ///< discard nothing
 
458
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
 
459
    AVDISCARD_NONREF =  8, ///< discard all non reference
 
460
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
 
461
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
 
462
    AVDISCARD_ALL    = 48, ///< discard all
 
463
};
 
464
 
 
465
enum AVColorPrimaries{
 
466
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
 
467
    AVCOL_PRI_UNSPECIFIED=2,
 
468
    AVCOL_PRI_BT470M     =4,
 
469
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
 
470
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
 
471
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
 
472
    AVCOL_PRI_FILM       =8,
 
473
    AVCOL_PRI_NB           , ///< Not part of ABI
 
474
};
 
475
 
 
476
enum AVColorTransferCharacteristic{
 
477
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
 
478
    AVCOL_TRC_UNSPECIFIED=2,
 
479
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
 
480
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
 
481
    AVCOL_TRC_NB           , ///< Not part of ABI
 
482
};
 
483
 
 
484
enum AVColorSpace{
 
485
    AVCOL_SPC_RGB        =0,
 
486
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
 
487
    AVCOL_SPC_UNSPECIFIED=2,
 
488
    AVCOL_SPC_FCC        =4,
 
489
    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
 
490
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
 
491
    AVCOL_SPC_SMPTE240M  =7,
 
492
    AVCOL_SPC_NB           , ///< Not part of ABI
 
493
};
 
494
 
 
495
enum AVColorRange{
 
496
    AVCOL_RANGE_UNSPECIFIED=0,
 
497
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
 
498
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
 
499
    AVCOL_RANGE_NB           , ///< Not part of ABI
 
500
};
 
501
 
 
502
/**
 
503
 *  X   X      3 4 X      X are luma samples,
 
504
 *             1 2        1-6 are possible chroma positions
 
505
 *  X   X      5 6 X      0 is undefined/unknown position
 
506
 */
 
507
enum AVChromaLocation{
 
508
    AVCHROMA_LOC_UNSPECIFIED=0,
 
509
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
 
510
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
 
511
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
 
512
    AVCHROMA_LOC_TOP        =4,
 
513
    AVCHROMA_LOC_BOTTOMLEFT =5,
 
514
    AVCHROMA_LOC_BOTTOM     =6,
 
515
    AVCHROMA_LOC_NB           , ///< Not part of ABI
 
516
};
 
517
 
 
518
#if FF_API_FLAC_GLOBAL_OPTS
 
519
/**
 
520
 * LPC analysis type
 
521
 */
 
522
attribute_deprecated 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
#endif
 
531
 
 
532
enum AVAudioServiceType {
 
533
    AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
 
534
    AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
 
535
    AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
 
536
    AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
 
537
    AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
 
538
    AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
 
539
    AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
 
540
    AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
 
541
    AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
 
542
    AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
 
543
};
 
544
 
 
545
typedef struct RcOverride{
 
546
    int start_frame;
 
547
    int end_frame;
 
548
    int qscale; // If this is 0 then quality_factor will be used instead.
 
549
    float quality_factor;
 
550
} RcOverride;
 
551
 
 
552
#define FF_MAX_B_FRAMES 16
 
553
 
 
554
/* encoding support
 
555
   These flags can be passed in AVCodecContext.flags before initialization.
 
556
   Note: Not everything is supported yet.
 
557
*/
 
558
 
 
559
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 
560
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 
561
#define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 
562
#define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 
563
#define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 
564
#define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
 
565
/**
 
566
 * The parent program guarantees that the input for B-frames containing
 
567
 * streams is not written to for at least s->max_b_frames+1 frames, if
 
568
 * this is not set the input will be copied.
 
569
 */
 
570
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
 
571
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 
572
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 
573
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
 
574
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 
575
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
 
576
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 
577
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 
578
                                                  location instead of only at frame boundaries. */
 
579
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 
580
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 
581
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 
582
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
 
583
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 
584
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 
585
/* Fx : Flag for h263+ extra options */
 
586
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 
587
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
 
588
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
 
589
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
 
590
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
 
591
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 
592
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 
593
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 
594
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 
595
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
 
596
#define CODEC_FLAG_CLOSED_GOP     0x80000000
 
597
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 
598
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
 
599
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 
600
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 
601
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
 
602
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
 
603
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
 
604
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
 
605
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
 
606
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
 
607
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
 
608
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
 
609
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
 
610
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
 
611
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
 
612
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 
613
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
 
614
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
 
615
#define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
 
616
#define CODEC_FLAG2_PSY           0x00080000 ///< Use psycho visual optimizations.
 
617
#define CODEC_FLAG2_SSIM          0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
 
618
#define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
 
619
 
 
620
/* Unsupported options :
 
621
 *              Syntax Arithmetic coding (SAC)
 
622
 *              Reference Picture Selection
 
623
 *              Independent Segment Decoding */
 
624
/* /Fx */
 
625
/* codec capabilities */
 
626
 
 
627
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
 
628
/**
 
629
 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
 
630
 * If not set, it might not use get_buffer() at all or use operations that
 
631
 * assume the buffer was allocated by avcodec_default_get_buffer.
 
632
 */
 
633
#define CODEC_CAP_DR1             0x0002
 
634
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
 
635
#define CODEC_CAP_PARSE_ONLY      0x0004
 
636
#define CODEC_CAP_TRUNCATED       0x0008
 
637
/* Codec can export data for HW decoding (XvMC). */
 
638
#define CODEC_CAP_HWACCEL         0x0010
 
639
/**
 
640
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 
641
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
 
642
 */
 
643
#define CODEC_CAP_DELAY           0x0020
 
644
/**
 
645
 * Codec can be fed a final frame with a smaller size.
 
646
 * This can be used to prevent truncation of the last audio samples.
 
647
 */
 
648
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
 
649
/**
 
650
 * Codec can export data for HW decoding (VDPAU).
 
651
 */
 
652
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
 
653
/**
 
654
 * Codec can output multiple frames per AVPacket
 
655
 * Normally demuxers return one frame at a time, demuxers which do not do
 
656
 * are connected to a parser to split what they return into proper frames.
 
657
 * This flag is reserved to the very rare category of codecs which have a
 
658
 * bitstream that cannot be split into frames without timeconsuming
 
659
 * operations like full decoding. Demuxers carring such bitstreams thus
 
660
 * may return multiple frames in a packet. This has many disadvantages like
 
661
 * prohibiting stream copy in many cases thus it should only be considered
 
662
 * as a last resort.
 
663
 */
 
664
#define CODEC_CAP_SUBFRAMES        0x0100
 
665
/**
 
666
 * Codec is experimental and is thus avoided in favor of non experimental
 
667
 * encoders
 
668
 */
 
669
#define CODEC_CAP_EXPERIMENTAL     0x0200
 
670
/**
 
671
 * Codec should fill in channel configuration and samplerate instead of container
 
672
 */
 
673
#define CODEC_CAP_CHANNEL_CONF     0x0400
 
674
/**
 
675
 * Codec is able to deal with negative linesizes
 
676
 */
 
677
#define CODEC_CAP_NEG_LINESIZES    0x0800
 
678
/**
 
679
 * Codec supports frame-level multithreading.
 
680
 */
 
681
#define CODEC_CAP_FRAME_THREADS    0x1000
 
682
/**
 
683
 * Codec supports slice-based (or partition-based) multithreading.
 
684
 */
 
685
#define CODEC_CAP_SLICE_THREADS    0x2000
 
686
 
 
687
//The following defines may change, don't expect compatibility if you use them.
 
688
#define MB_TYPE_INTRA4x4   0x0001
 
689
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 
690
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
 
691
#define MB_TYPE_16x16      0x0008
 
692
#define MB_TYPE_16x8       0x0010
 
693
#define MB_TYPE_8x16       0x0020
 
694
#define MB_TYPE_8x8        0x0040
 
695
#define MB_TYPE_INTERLACED 0x0080
 
696
#define MB_TYPE_DIRECT2    0x0100 //FIXME
 
697
#define MB_TYPE_ACPRED     0x0200
 
698
#define MB_TYPE_GMC        0x0400
 
699
#define MB_TYPE_SKIP       0x0800
 
700
#define MB_TYPE_P0L0       0x1000
 
701
#define MB_TYPE_P1L0       0x2000
 
702
#define MB_TYPE_P0L1       0x4000
 
703
#define MB_TYPE_P1L1       0x8000
 
704
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 
705
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 
706
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 
707
#define MB_TYPE_QUANT      0x00010000
 
708
#define MB_TYPE_CBP        0x00020000
 
709
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 
710
 
 
711
/**
 
712
 * Pan Scan area.
 
713
 * This specifies the area which should be displayed.
 
714
 * Note there may be multiple such areas for one frame.
 
715
 */
 
716
typedef struct AVPanScan{
 
717
    /**
 
718
     * id
 
719
     * - encoding: Set by user.
 
720
     * - decoding: Set by libavcodec.
 
721
     */
 
722
    int id;
 
723
 
 
724
    /**
 
725
     * width and height in 1/16 pel
 
726
     * - encoding: Set by user.
 
727
     * - decoding: Set by libavcodec.
 
728
     */
 
729
    int width;
 
730
    int height;
 
731
 
 
732
    /**
 
733
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
 
734
     * - encoding: Set by user.
 
735
     * - decoding: Set by libavcodec.
 
736
     */
 
737
    int16_t position[3][2];
 
738
}AVPanScan;
 
739
 
 
740
#define FF_COMMON_FRAME \
 
741
    /**\
 
742
     * pointer to the picture planes.\
 
743
     * This might be different from the first allocated byte\
 
744
     * - encoding: \
 
745
     * - decoding: \
 
746
     */\
 
747
    uint8_t *data[4];\
 
748
    int linesize[4];\
 
749
    /**\
 
750
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
 
751
     * This isn't used by libavcodec unless the default get/release_buffer() is used.\
 
752
     * - encoding: \
 
753
     * - decoding: \
 
754
     */\
 
755
    uint8_t *base[4];\
 
756
    /**\
 
757
     * 1 -> keyframe, 0-> not\
 
758
     * - encoding: Set by libavcodec.\
 
759
     * - decoding: Set by libavcodec.\
 
760
     */\
 
761
    int key_frame;\
 
762
\
 
763
    /**\
 
764
     * Picture type of the frame, see ?_TYPE below.\
 
765
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 
766
     * - decoding: Set by libavcodec.\
 
767
     */\
 
768
    enum AVPictureType pict_type;\
 
769
\
 
770
    /**\
 
771
     * presentation timestamp in time_base units (time when frame should be shown to user)\
 
772
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
 
773
     * - encoding: MUST be set by user.\
 
774
     * - decoding: Set by libavcodec.\
 
775
     */\
 
776
    int64_t pts;\
 
777
\
 
778
    /**\
 
779
     * picture number in bitstream order\
 
780
     * - encoding: set by\
 
781
     * - decoding: Set by libavcodec.\
 
782
     */\
 
783
    int coded_picture_number;\
 
784
    /**\
 
785
     * picture number in display order\
 
786
     * - encoding: set by\
 
787
     * - decoding: Set by libavcodec.\
 
788
     */\
 
789
    int display_picture_number;\
 
790
\
 
791
    /**\
 
792
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
 
793
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 
794
     * - decoding: Set by libavcodec.\
 
795
     */\
 
796
    int quality; \
 
797
\
 
798
    /**\
 
799
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
 
800
     * Set to INT_MAX if the buffer has not been used yet.\
 
801
     * - encoding: unused\
 
802
     * - decoding: MUST be set by get_buffer().\
 
803
     */\
 
804
    int age;\
 
805
\
 
806
    /**\
 
807
     * is this picture used as reference\
 
808
     * The values for this are the same as the MpegEncContext.picture_structure\
 
809
     * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
 
810
     * Set to 4 for delayed, non-reference frames.\
 
811
     * - encoding: unused\
 
812
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
 
813
     */\
 
814
    int reference;\
 
815
\
 
816
    /**\
 
817
     * QP table\
 
818
     * - encoding: unused\
 
819
     * - decoding: Set by libavcodec.\
 
820
     */\
 
821
    int8_t *qscale_table;\
 
822
    /**\
 
823
     * QP store stride\
 
824
     * - encoding: unused\
 
825
     * - decoding: Set by libavcodec.\
 
826
     */\
 
827
    int qstride;\
 
828
\
 
829
    /**\
 
830
     * mbskip_table[mb]>=1 if MB didn't change\
 
831
     * stride= mb_width = (width+15)>>4\
 
832
     * - encoding: unused\
 
833
     * - decoding: Set by libavcodec.\
 
834
     */\
 
835
    uint8_t *mbskip_table;\
 
836
\
 
837
    /**\
 
838
     * motion vector table\
 
839
     * @code\
 
840
     * example:\
 
841
     * int mv_sample_log2= 4 - motion_subsample_log2;\
 
842
     * int mb_width= (width+15)>>4;\
 
843
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
 
844
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
 
845
     * @endcode\
 
846
     * - encoding: Set by user.\
 
847
     * - decoding: Set by libavcodec.\
 
848
     */\
 
849
    int16_t (*motion_val[2])[2];\
 
850
\
 
851
    /**\
 
852
     * macroblock type table\
 
853
     * mb_type_base + mb_width + 2\
 
854
     * - encoding: Set by user.\
 
855
     * - decoding: Set by libavcodec.\
 
856
     */\
 
857
    uint32_t *mb_type;\
 
858
\
 
859
    /**\
 
860
     * log2 of the size of the block which a single vector in motion_val represents: \
 
861
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
 
862
     * - encoding: unused\
 
863
     * - decoding: Set by libavcodec.\
 
864
     */\
 
865
    uint8_t motion_subsample_log2;\
 
866
\
 
867
    /**\
 
868
     * for some private data of the user\
 
869
     * - encoding: unused\
 
870
     * - decoding: Set by user.\
 
871
     */\
 
872
    void *opaque;\
 
873
\
 
874
    /**\
 
875
     * error\
 
876
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
 
877
     * - decoding: unused\
 
878
     */\
 
879
    uint64_t error[4];\
 
880
\
 
881
    /**\
 
882
     * type of the buffer (to keep track of who has to deallocate data[*])\
 
883
     * - encoding: Set by the one who allocates it.\
 
884
     * - decoding: Set by the one who allocates it.\
 
885
     * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
 
886
     */\
 
887
    int type;\
 
888
    \
 
889
    /**\
 
890
     * When decoding, this signals how much the picture must be delayed.\
 
891
     * extra_delay = repeat_pict / (2*fps)\
 
892
     * - encoding: unused\
 
893
     * - decoding: Set by libavcodec.\
 
894
     */\
 
895
    int repeat_pict;\
 
896
    \
 
897
    /**\
 
898
     * \
 
899
     */\
 
900
    int qscale_type;\
 
901
    \
 
902
    /**\
 
903
     * The content of the picture is interlaced.\
 
904
     * - encoding: Set by user.\
 
905
     * - decoding: Set by libavcodec. (default 0)\
 
906
     */\
 
907
    int interlaced_frame;\
 
908
    \
 
909
    /**\
 
910
     * If the content is interlaced, is top field displayed first.\
 
911
     * - encoding: Set by user.\
 
912
     * - decoding: Set by libavcodec.\
 
913
     */\
 
914
    int top_field_first;\
 
915
    \
 
916
    /**\
 
917
     * Pan scan.\
 
918
     * - encoding: Set by user.\
 
919
     * - decoding: Set by libavcodec.\
 
920
     */\
 
921
    AVPanScan *pan_scan;\
 
922
    \
 
923
    /**\
 
924
     * Tell user application that palette has changed from previous frame.\
 
925
     * - encoding: ??? (no palette-enabled encoder yet)\
 
926
     * - decoding: Set by libavcodec. (default 0).\
 
927
     */\
 
928
    int palette_has_changed;\
 
929
    \
 
930
    /**\
 
931
     * codec suggestion on buffer type if != 0\
 
932
     * - encoding: unused\
 
933
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
 
934
     */\
 
935
    int buffer_hints;\
 
936
\
 
937
    /**\
 
938
     * DCT coefficients\
 
939
     * - encoding: unused\
 
940
     * - decoding: Set by libavcodec.\
 
941
     */\
 
942
    short *dct_coeff;\
 
943
\
 
944
    /**\
 
945
     * motion reference frame index\
 
946
     * the order in which these are stored can depend on the codec.\
 
947
     * - encoding: Set by user.\
 
948
     * - decoding: Set by libavcodec.\
 
949
     */\
 
950
    int8_t *ref_index[2];\
 
951
\
 
952
    /**\
 
953
     * reordered opaque 64bit (generally an integer or a double precision float\
 
954
     * PTS but can be anything). \
 
955
     * The user sets AVCodecContext.reordered_opaque to represent the input at\
 
956
     * that time,\
 
957
     * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
 
958
     * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
 
959
     * @deprecated in favor of pkt_pts\
 
960
     * - encoding: unused\
 
961
     * - decoding: Read by user.\
 
962
     */\
 
963
    int64_t reordered_opaque;\
 
964
\
 
965
    /**\
 
966
     * hardware accelerator private data (Libav-allocated)\
 
967
     * - encoding: unused\
 
968
     * - decoding: Set by libavcodec\
 
969
     */\
 
970
    void *hwaccel_picture_private;\
 
971
\
 
972
    /**\
 
973
     * reordered pts from the last AVPacket that has been input into the decoder\
 
974
     * - encoding: unused\
 
975
     * - decoding: Read by user.\
 
976
     */\
 
977
    int64_t pkt_pts;\
 
978
\
 
979
    /**\
 
980
     * dts from the last AVPacket that has been input into the decoder\
 
981
     * - encoding: unused\
 
982
     * - decoding: Read by user.\
 
983
     */\
 
984
    int64_t pkt_dts;\
 
985
\
 
986
    /**\
 
987
     * the AVCodecContext which ff_thread_get_buffer() was last called on\
 
988
     * - encoding: Set by libavcodec.\
 
989
     * - decoding: Set by libavcodec.\
 
990
     */\
 
991
    struct AVCodecContext *owner;\
 
992
\
 
993
    /**\
 
994
     * used by multithreading to store frame-specific info\
 
995
     * - encoding: Set by libavcodec.\
 
996
     * - decoding: Set by libavcodec.\
 
997
     */\
 
998
    void *thread_opaque;\
 
999
 
 
1000
#define FF_QSCALE_TYPE_MPEG1 0
 
1001
#define FF_QSCALE_TYPE_MPEG2 1
 
1002
#define FF_QSCALE_TYPE_H264  2
 
1003
#define FF_QSCALE_TYPE_VP56  3
 
1004
 
 
1005
#define FF_BUFFER_TYPE_INTERNAL 1
 
1006
#define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 
1007
#define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 
1008
#define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
 
1009
 
 
1010
#if FF_API_OLD_FF_PICT_TYPES
 
1011
/* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
 
1012
#define FF_I_TYPE  AV_PICTURE_TYPE_I  ///< Intra
 
1013
#define FF_P_TYPE  AV_PICTURE_TYPE_P  ///< Predicted
 
1014
#define FF_B_TYPE  AV_PICTURE_TYPE_B  ///< Bi-dir predicted
 
1015
#define FF_S_TYPE  AV_PICTURE_TYPE_S  ///< S(GMC)-VOP MPEG4
 
1016
#define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
 
1017
#define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
 
1018
#define FF_BI_TYPE AV_PICTURE_TYPE_BI
 
1019
#endif
 
1020
 
 
1021
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 
1022
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 
1023
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 
1024
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
 
1025
 
 
1026
enum AVPacketSideDataType {
 
1027
    AV_PKT_DATA_PALETTE,
 
1028
};
 
1029
 
 
1030
typedef struct AVPacket {
 
1031
    /**
 
1032
     * Presentation timestamp in AVStream->time_base units; the time at which
 
1033
     * the decompressed packet will be presented to the user.
 
1034
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
 
1035
     * pts MUST be larger or equal to dts as presentation cannot happen before
 
1036
     * decompression, unless one wants to view hex dumps. Some formats misuse
 
1037
     * the terms dts and pts/cts to mean something different. Such timestamps
 
1038
     * must be converted to true pts/dts before they are stored in AVPacket.
 
1039
     */
 
1040
    int64_t pts;
 
1041
    /**
 
1042
     * Decompression timestamp in AVStream->time_base units; the time at which
 
1043
     * the packet is decompressed.
 
1044
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
 
1045
     */
 
1046
    int64_t dts;
 
1047
    uint8_t *data;
 
1048
    int   size;
 
1049
    int   stream_index;
 
1050
    int   flags;
 
1051
    /**
 
1052
     * Additional packet data that can be provided by the container.
 
1053
     * Packet can contain several types of side information.
 
1054
     */
 
1055
    struct {
 
1056
        uint8_t *data;
 
1057
        int      size;
 
1058
        enum AVPacketSideDataType type;
 
1059
    } *side_data;
 
1060
    int side_data_elems;
 
1061
 
 
1062
    /**
 
1063
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
 
1064
     * Equals next_pts - this_pts in presentation order.
 
1065
     */
 
1066
    int   duration;
 
1067
    void  (*destruct)(struct AVPacket *);
 
1068
    void  *priv;
 
1069
    int64_t pos;                            ///< byte position in stream, -1 if unknown
 
1070
 
 
1071
    /**
 
1072
     * Time difference in AVStream->time_base units from the pts of this
 
1073
     * packet to the point at which the output from the decoder has converged
 
1074
     * independent from the availability of previous frames. That is, the
 
1075
     * frames are virtually identical no matter if decoding started from
 
1076
     * the very first frame or from this keyframe.
 
1077
     * Is AV_NOPTS_VALUE if unknown.
 
1078
     * This field is not the display duration of the current packet.
 
1079
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
 
1080
     * set.
 
1081
     *
 
1082
     * The purpose of this field is to allow seeking in streams that have no
 
1083
     * keyframes in the conventional sense. It corresponds to the
 
1084
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
 
1085
     * essential for some types of subtitle streams to ensure that all
 
1086
     * subtitles are correctly displayed after seeking.
 
1087
     */
 
1088
    int64_t convergence_duration;
 
1089
} AVPacket;
 
1090
#define AV_PKT_FLAG_KEY   0x0001
 
1091
 
 
1092
/**
 
1093
 * Audio Video Frame.
 
1094
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
 
1095
 * bumps.
 
1096
 * Removal, reordering and changes to existing fields require a major
 
1097
 * version bump. No fields should be added into AVFrame before or after
 
1098
 * FF_COMMON_FRAME!
 
1099
 * sizeof(AVFrame) must not be used outside libav*.
 
1100
 */
 
1101
typedef struct AVFrame {
 
1102
    FF_COMMON_FRAME
 
1103
} AVFrame;
 
1104
 
 
1105
/**
 
1106
 * main external API structure.
 
1107
 * New fields can be added to the end with minor version bumps.
 
1108
 * Removal, reordering and changes to existing fields require a major
 
1109
 * version bump.
 
1110
 * sizeof(AVCodecContext) must not be used outside libav*.
 
1111
 */
 
1112
typedef struct AVCodecContext {
 
1113
    /**
 
1114
     * information on struct for av_log
 
1115
     * - set by avcodec_alloc_context
 
1116
     */
 
1117
    const AVClass *av_class;
 
1118
    /**
 
1119
     * the average bitrate
 
1120
     * - encoding: Set by user; unused for constant quantizer encoding.
 
1121
     * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
 
1122
     */
 
1123
    int bit_rate;
 
1124
 
 
1125
    /**
 
1126
     * number of bits the bitstream is allowed to diverge from the reference.
 
1127
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
 
1128
     * - encoding: Set by user; unused for constant quantizer encoding.
 
1129
     * - decoding: unused
 
1130
     */
 
1131
    int bit_rate_tolerance;
 
1132
 
 
1133
    /**
 
1134
     * CODEC_FLAG_*.
 
1135
     * - encoding: Set by user.
 
1136
     * - decoding: Set by user.
 
1137
     */
 
1138
    int flags;
 
1139
 
 
1140
    /**
 
1141
     * Some codecs need additional format info. It is stored here.
 
1142
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
 
1143
     * specific codec MUST set it correctly otherwise stream copy breaks.
 
1144
     * In general use of this field by muxers is not recommanded.
 
1145
     * - encoding: Set by libavcodec.
 
1146
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
 
1147
     */
 
1148
    int sub_id;
 
1149
 
 
1150
    /**
 
1151
     * Motion estimation algorithm used for video coding.
 
1152
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
 
1153
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
 
1154
     * - encoding: MUST be set by user.
 
1155
     * - decoding: unused
 
1156
     */
 
1157
    int me_method;
 
1158
 
 
1159
    /**
 
1160
     * some codecs need / can use extradata like Huffman tables.
 
1161
     * mjpeg: Huffman tables
 
1162
     * rv10: additional flags
 
1163
     * mpeg4: global headers (they can be in the bitstream or here)
 
1164
     * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
 
1165
     * than extradata_size to avoid prolems if it is read with the bitstream reader.
 
1166
     * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
 
1167
     * - encoding: Set/allocated/freed by libavcodec.
 
1168
     * - decoding: Set/allocated/freed by user.
 
1169
     */
 
1170
    uint8_t *extradata;
 
1171
    int extradata_size;
 
1172
 
 
1173
    /**
 
1174
     * This is the fundamental unit of time (in seconds) in terms
 
1175
     * of which frame timestamps are represented. For fixed-fps content,
 
1176
     * timebase should be 1/framerate and timestamp increments should be
 
1177
     * identically 1.
 
1178
     * - encoding: MUST be set by user.
 
1179
     * - decoding: Set by libavcodec.
 
1180
     */
 
1181
    AVRational time_base;
 
1182
 
 
1183
    /* video only */
 
1184
    /**
 
1185
     * picture width / height.
 
1186
     * - encoding: MUST be set by user.
 
1187
     * - decoding: Set by libavcodec.
 
1188
     * Note: For compatibility it is possible to set this instead of
 
1189
     * coded_width/height before decoding.
 
1190
     */
 
1191
    int width, height;
 
1192
 
 
1193
#define FF_ASPECT_EXTENDED 15
 
1194
 
 
1195
    /**
 
1196
     * the number of pictures in a group of pictures, or 0 for intra_only
 
1197
     * - encoding: Set by user.
 
1198
     * - decoding: unused
 
1199
     */
 
1200
    int gop_size;
 
1201
 
 
1202
    /**
 
1203
     * Pixel format, see PIX_FMT_xxx.
 
1204
     * May be set by the demuxer if known from headers.
 
1205
     * May be overriden by the decoder if it knows better.
 
1206
     * - encoding: Set by user.
 
1207
     * - decoding: Set by user if known, overridden by libavcodec if known
 
1208
     */
 
1209
    enum PixelFormat pix_fmt;
 
1210
 
 
1211
    /**
 
1212
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
 
1213
     * decoder to draw a horizontal band. It improves cache usage. Not
 
1214
     * all codecs can do that. You must check the codec capabilities
 
1215
     * beforehand.
 
1216
     * When multithreading is used, it may be called from multiple threads
 
1217
     * at the same time; threads might draw different parts of the same AVFrame,
 
1218
     * or multiple AVFrames, and there is no guarantee that slices will be drawn
 
1219
     * in order.
 
1220
     * The function is also used by hardware acceleration APIs.
 
1221
     * It is called at least once during frame decoding to pass
 
1222
     * the data needed for hardware render.
 
1223
     * In that mode instead of pixel data, AVFrame points to
 
1224
     * a structure specific to the acceleration API. The application
 
1225
     * reads the structure and can change some fields to indicate progress
 
1226
     * or mark state.
 
1227
     * - encoding: unused
 
1228
     * - decoding: Set by user.
 
1229
     * @param height the height of the slice
 
1230
     * @param y the y position of the slice
 
1231
     * @param type 1->top field, 2->bottom field, 3->frame
 
1232
     * @param offset offset into the AVFrame.data from which the slice should be read
 
1233
     */
 
1234
    void (*draw_horiz_band)(struct AVCodecContext *s,
 
1235
                            const AVFrame *src, int offset[4],
 
1236
                            int y, int type, int height);
 
1237
 
 
1238
    /* audio only */
 
1239
    int sample_rate; ///< samples per second
 
1240
    int channels;    ///< number of audio channels
 
1241
 
 
1242
    /**
 
1243
     * audio sample format
 
1244
     * - encoding: Set by user.
 
1245
     * - decoding: Set by libavcodec.
 
1246
     */
 
1247
    enum AVSampleFormat sample_fmt;  ///< sample format
 
1248
 
 
1249
    /* The following data should not be initialized. */
 
1250
    /**
 
1251
     * Samples per packet, initialized when calling 'init'.
 
1252
     */
 
1253
    int frame_size;
 
1254
    int frame_number;   ///< audio or video frame number
 
1255
 
 
1256
    /**
 
1257
     * Number of frames the decoded output will be delayed relative to
 
1258
     * the encoded input.
 
1259
     * - encoding: Set by libavcodec.
 
1260
     * - decoding: unused
 
1261
     */
 
1262
    int delay;
 
1263
 
 
1264
    /* - encoding parameters */
 
1265
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
 
1266
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
 
1267
 
 
1268
    /**
 
1269
     * minimum quantizer
 
1270
     * - encoding: Set by user.
 
1271
     * - decoding: unused
 
1272
     */
 
1273
    int qmin;
 
1274
 
 
1275
    /**
 
1276
     * maximum quantizer
 
1277
     * - encoding: Set by user.
 
1278
     * - decoding: unused
 
1279
     */
 
1280
    int qmax;
 
1281
 
 
1282
    /**
 
1283
     * maximum quantizer difference between frames
 
1284
     * - encoding: Set by user.
 
1285
     * - decoding: unused
 
1286
     */
 
1287
    int max_qdiff;
 
1288
 
 
1289
    /**
 
1290
     * maximum number of B-frames between non-B-frames
 
1291
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
 
1292
     * - encoding: Set by user.
 
1293
     * - decoding: unused
 
1294
     */
 
1295
    int max_b_frames;
 
1296
 
 
1297
    /**
 
1298
     * qscale factor between IP and B-frames
 
1299
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
 
1300
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
 
1301
     * - encoding: Set by user.
 
1302
     * - decoding: unused
 
1303
     */
 
1304
    float b_quant_factor;
 
1305
 
 
1306
    /** obsolete FIXME remove */
 
1307
    int rc_strategy;
 
1308
#define FF_RC_STRATEGY_XVID 1
 
1309
 
 
1310
    int b_frame_strategy;
 
1311
 
 
1312
    struct AVCodec *codec;
 
1313
 
 
1314
    void *priv_data;
 
1315
 
 
1316
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
 
1317
                            /* do its best to deliver a chunk with size     */
 
1318
                            /* below rtp_payload_size, the chunk will start */
 
1319
                            /* with a start code on some codecs like H.263. */
 
1320
                            /* This doesn't take account of any particular  */
 
1321
                            /* headers inside the transmitted RTP payload.  */
 
1322
 
 
1323
 
 
1324
    /* The RTP callback: This function is called    */
 
1325
    /* every time the encoder has a packet to send. */
 
1326
    /* It depends on the encoder if the data starts */
 
1327
    /* with a Start Code (it should). H.263 does.   */
 
1328
    /* mb_nb contains the number of macroblocks     */
 
1329
    /* encoded in the RTP payload.                  */
 
1330
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
 
1331
 
 
1332
    /* statistics, used for 2-pass encoding */
 
1333
    int mv_bits;
 
1334
    int header_bits;
 
1335
    int i_tex_bits;
 
1336
    int p_tex_bits;
 
1337
    int i_count;
 
1338
    int p_count;
 
1339
    int skip_count;
 
1340
    int misc_bits;
 
1341
 
 
1342
    /**
 
1343
     * number of bits used for the previously encoded frame
 
1344
     * - encoding: Set by libavcodec.
 
1345
     * - decoding: unused
 
1346
     */
 
1347
    int frame_bits;
 
1348
 
 
1349
    /**
 
1350
     * Private data of the user, can be used to carry app specific stuff.
 
1351
     * - encoding: Set by user.
 
1352
     * - decoding: Set by user.
 
1353
     */
 
1354
    void *opaque;
 
1355
 
 
1356
    char codec_name[32];
 
1357
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
 
1358
    enum CodecID codec_id; /* see CODEC_ID_xxx */
 
1359
 
 
1360
    /**
 
1361
     * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
 
1362
     * This is used to work around some encoder bugs.
 
1363
     * A demuxer should set this to what is stored in the field used to identify the codec.
 
1364
     * If there are multiple such fields in a container then the demuxer should choose the one
 
1365
     * which maximizes the information about the used codec.
 
1366
     * If the codec tag field in a container is larger then 32 bits then the demuxer should
 
1367
     * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
 
1368
     * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
 
1369
     * first.
 
1370
     * - encoding: Set by user, if not then the default based on codec_id will be used.
 
1371
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
 
1372
     */
 
1373
    unsigned int codec_tag;
 
1374
 
 
1375
    /**
 
1376
     * Work around bugs in encoders which sometimes cannot be detected automatically.
 
1377
     * - encoding: Set by user
 
1378
     * - decoding: Set by user
 
1379
     */
 
1380
    int workaround_bugs;
 
1381
#define FF_BUG_AUTODETECT       1  ///< autodetection
 
1382
#define FF_BUG_OLD_MSMPEG4      2
 
1383
#define FF_BUG_XVID_ILACE       4
 
1384
#define FF_BUG_UMP4             8
 
1385
#define FF_BUG_NO_PADDING       16
 
1386
#define FF_BUG_AMV              32
 
1387
#define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
 
1388
#define FF_BUG_QPEL_CHROMA      64
 
1389
#define FF_BUG_STD_QPEL         128
 
1390
#define FF_BUG_QPEL_CHROMA2     256
 
1391
#define FF_BUG_DIRECT_BLOCKSIZE 512
 
1392
#define FF_BUG_EDGE             1024
 
1393
#define FF_BUG_HPEL_CHROMA      2048
 
1394
#define FF_BUG_DC_CLIP          4096
 
1395
#define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
 
1396
#define FF_BUG_TRUNCATED       16384
 
1397
//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
 
1398
 
 
1399
    /**
 
1400
     * luma single coefficient elimination threshold
 
1401
     * - encoding: Set by user.
 
1402
     * - decoding: unused
 
1403
     */
 
1404
    int luma_elim_threshold;
 
1405
 
 
1406
    /**
 
1407
     * chroma single coeff elimination threshold
 
1408
     * - encoding: Set by user.
 
1409
     * - decoding: unused
 
1410
     */
 
1411
    int chroma_elim_threshold;
 
1412
 
 
1413
    /**
 
1414
     * strictly follow the standard (MPEG4, ...).
 
1415
     * - encoding: Set by user.
 
1416
     * - decoding: Set by user.
 
1417
     * Setting this to STRICT or higher means the encoder and decoder will
 
1418
     * generally do stupid things, whereas setting it to unofficial or lower
 
1419
     * will mean the encoder might produce output that is not supported by all
 
1420
     * spec-compliant decoders. Decoders don't differentiate between normal,
 
1421
     * unofficial and experimental (that is, they always try to decode things
 
1422
     * when they can) unless they are explicitly asked to behave stupidly
 
1423
     * (=strictly conform to the specs)
 
1424
     */
 
1425
    int strict_std_compliance;
 
1426
#define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
 
1427
#define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
 
1428
#define FF_COMPLIANCE_NORMAL        0
 
1429
#define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
 
1430
#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
 
1431
 
 
1432
    /**
 
1433
     * qscale offset between IP and B-frames
 
1434
     * - encoding: Set by user.
 
1435
     * - decoding: unused
 
1436
     */
 
1437
    float b_quant_offset;
 
1438
 
 
1439
    /**
 
1440
     * Error recognization; higher values will detect more errors but may
 
1441
     * misdetect some more or less valid parts as errors.
 
1442
     * - encoding: unused
 
1443
     * - decoding: Set by user.
 
1444
     */
 
1445
    int error_recognition;
 
1446
#define FF_ER_CAREFUL         1
 
1447
#define FF_ER_COMPLIANT       2
 
1448
#define FF_ER_AGGRESSIVE      3
 
1449
#define FF_ER_VERY_AGGRESSIVE 4
 
1450
 
 
1451
    /**
 
1452
     * Called at the beginning of each frame to get a buffer for it.
 
1453
     * If pic.reference is set then the frame will be read later by libavcodec.
 
1454
     * avcodec_align_dimensions2() should be used to find the required width and
 
1455
     * height, as they normally need to be rounded up to the next multiple of 16.
 
1456
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
 
1457
     * avcodec_default_get_buffer() instead of providing buffers allocated by
 
1458
     * some other means.
 
1459
     * If frame multithreading is used and thread_safe_callbacks is set,
 
1460
     * it may be called from a different thread, but not from more than one at once.
 
1461
     * Does not need to be reentrant.
 
1462
     * - encoding: unused
 
1463
     * - decoding: Set by libavcodec, user can override.
 
1464
     */
 
1465
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
 
1466
 
 
1467
    /**
 
1468
     * Called to release buffers which were allocated with get_buffer.
 
1469
     * A released buffer can be reused in get_buffer().
 
1470
     * pic.data[*] must be set to NULL.
 
1471
     * May be called from a different thread if frame multithreading is used,
 
1472
     * but not by more than one thread at once, so does not need to be reentrant.
 
1473
     * - encoding: unused
 
1474
     * - decoding: Set by libavcodec, user can override.
 
1475
     */
 
1476
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
 
1477
 
 
1478
    /**
 
1479
     * Size of the frame reordering buffer in the decoder.
 
1480
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
 
1481
     * - encoding: Set by libavcodec.
 
1482
     * - decoding: Set by libavcodec.
 
1483
     */
 
1484
    int has_b_frames;
 
1485
 
 
1486
    /**
 
1487
     * number of bytes per packet if constant and known or 0
 
1488
     * Used by some WAV based audio codecs.
 
1489
     */
 
1490
    int block_align;
 
1491
 
 
1492
    int parse_only; /* - decoding only: If true, only parsing is done
 
1493
                       (function avcodec_parse_frame()). The frame
 
1494
                       data is returned. Only MPEG codecs support this now. */
 
1495
 
 
1496
    /**
 
1497
     * 0-> h263 quant 1-> mpeg quant
 
1498
     * - encoding: Set by user.
 
1499
     * - decoding: unused
 
1500
     */
 
1501
    int mpeg_quant;
 
1502
 
 
1503
    /**
 
1504
     * pass1 encoding statistics output buffer
 
1505
     * - encoding: Set by libavcodec.
 
1506
     * - decoding: unused
 
1507
     */
 
1508
    char *stats_out;
 
1509
 
 
1510
    /**
 
1511
     * pass2 encoding statistics input buffer
 
1512
     * Concatenated stuff from stats_out of pass1 should be placed here.
 
1513
     * - encoding: Allocated/set/freed by user.
 
1514
     * - decoding: unused
 
1515
     */
 
1516
    char *stats_in;
 
1517
 
 
1518
    /**
 
1519
     * ratecontrol qmin qmax limiting method
 
1520
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
 
1521
     * - encoding: Set by user.
 
1522
     * - decoding: unused
 
1523
     */
 
1524
    float rc_qsquish;
 
1525
 
 
1526
    float rc_qmod_amp;
 
1527
    int rc_qmod_freq;
 
1528
 
 
1529
    /**
 
1530
     * ratecontrol override, see RcOverride
 
1531
     * - encoding: Allocated/set/freed by user.
 
1532
     * - decoding: unused
 
1533
     */
 
1534
    RcOverride *rc_override;
 
1535
    int rc_override_count;
 
1536
 
 
1537
    /**
 
1538
     * rate control equation
 
1539
     * - encoding: Set by user
 
1540
     * - decoding: unused
 
1541
     */
 
1542
    const char *rc_eq;
 
1543
 
 
1544
    /**
 
1545
     * maximum bitrate
 
1546
     * - encoding: Set by user.
 
1547
     * - decoding: unused
 
1548
     */
 
1549
    int rc_max_rate;
 
1550
 
 
1551
    /**
 
1552
     * minimum bitrate
 
1553
     * - encoding: Set by user.
 
1554
     * - decoding: unused
 
1555
     */
 
1556
    int rc_min_rate;
 
1557
 
 
1558
    /**
 
1559
     * decoder bitstream buffer size
 
1560
     * - encoding: Set by user.
 
1561
     * - decoding: unused
 
1562
     */
 
1563
    int rc_buffer_size;
 
1564
    float rc_buffer_aggressivity;
 
1565
 
 
1566
    /**
 
1567
     * qscale factor between P and I-frames
 
1568
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
 
1569
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
 
1570
     * - encoding: Set by user.
 
1571
     * - decoding: unused
 
1572
     */
 
1573
    float i_quant_factor;
 
1574
 
 
1575
    /**
 
1576
     * qscale offset between P and I-frames
 
1577
     * - encoding: Set by user.
 
1578
     * - decoding: unused
 
1579
     */
 
1580
    float i_quant_offset;
 
1581
 
 
1582
    /**
 
1583
     * initial complexity for pass1 ratecontrol
 
1584
     * - encoding: Set by user.
 
1585
     * - decoding: unused
 
1586
     */
 
1587
    float rc_initial_cplx;
 
1588
 
 
1589
    /**
 
1590
     * DCT algorithm, see FF_DCT_* below
 
1591
     * - encoding: Set by user.
 
1592
     * - decoding: unused
 
1593
     */
 
1594
    int dct_algo;
 
1595
#define FF_DCT_AUTO    0
 
1596
#define FF_DCT_FASTINT 1
 
1597
#define FF_DCT_INT     2
 
1598
#define FF_DCT_MMX     3
 
1599
#define FF_DCT_MLIB    4
 
1600
#define FF_DCT_ALTIVEC 5
 
1601
#define FF_DCT_FAAN    6
 
1602
 
 
1603
    /**
 
1604
     * luminance masking (0-> disabled)
 
1605
     * - encoding: Set by user.
 
1606
     * - decoding: unused
 
1607
     */
 
1608
    float lumi_masking;
 
1609
 
 
1610
    /**
 
1611
     * temporary complexity masking (0-> disabled)
 
1612
     * - encoding: Set by user.
 
1613
     * - decoding: unused
 
1614
     */
 
1615
    float temporal_cplx_masking;
 
1616
 
 
1617
    /**
 
1618
     * spatial complexity masking (0-> disabled)
 
1619
     * - encoding: Set by user.
 
1620
     * - decoding: unused
 
1621
     */
 
1622
    float spatial_cplx_masking;
 
1623
 
 
1624
    /**
 
1625
     * p block masking (0-> disabled)
 
1626
     * - encoding: Set by user.
 
1627
     * - decoding: unused
 
1628
     */
 
1629
    float p_masking;
 
1630
 
 
1631
    /**
 
1632
     * darkness masking (0-> disabled)
 
1633
     * - encoding: Set by user.
 
1634
     * - decoding: unused
 
1635
     */
 
1636
    float dark_masking;
 
1637
 
 
1638
    /**
 
1639
     * IDCT algorithm, see FF_IDCT_* below.
 
1640
     * - encoding: Set by user.
 
1641
     * - decoding: Set by user.
 
1642
     */
 
1643
    int idct_algo;
 
1644
#define FF_IDCT_AUTO          0
 
1645
#define FF_IDCT_INT           1
 
1646
#define FF_IDCT_SIMPLE        2
 
1647
#define FF_IDCT_SIMPLEMMX     3
 
1648
#define FF_IDCT_LIBMPEG2MMX   4
 
1649
#define FF_IDCT_PS2           5
 
1650
#define FF_IDCT_MLIB          6
 
1651
#define FF_IDCT_ARM           7
 
1652
#define FF_IDCT_ALTIVEC       8
 
1653
#define FF_IDCT_SH4           9
 
1654
#define FF_IDCT_SIMPLEARM     10
 
1655
#define FF_IDCT_H264          11
 
1656
#define FF_IDCT_VP3           12
 
1657
#define FF_IDCT_IPP           13
 
1658
#define FF_IDCT_XVIDMMX       14
 
1659
#define FF_IDCT_CAVS          15
 
1660
#define FF_IDCT_SIMPLEARMV5TE 16
 
1661
#define FF_IDCT_SIMPLEARMV6   17
 
1662
#define FF_IDCT_SIMPLEVIS     18
 
1663
#define FF_IDCT_WMV2          19
 
1664
#define FF_IDCT_FAAN          20
 
1665
#define FF_IDCT_EA            21
 
1666
#define FF_IDCT_SIMPLENEON    22
 
1667
#define FF_IDCT_SIMPLEALPHA   23
 
1668
#define FF_IDCT_BINK          24
 
1669
 
 
1670
    /**
 
1671
     * slice count
 
1672
     * - encoding: Set by libavcodec.
 
1673
     * - decoding: Set by user (or 0).
 
1674
     */
 
1675
    int slice_count;
 
1676
    /**
 
1677
     * slice offsets in the frame in bytes
 
1678
     * - encoding: Set/allocated by libavcodec.
 
1679
     * - decoding: Set/allocated by user (or NULL).
 
1680
     */
 
1681
    int *slice_offset;
 
1682
 
 
1683
    /**
 
1684
     * error concealment flags
 
1685
     * - encoding: unused
 
1686
     * - decoding: Set by user.
 
1687
     */
 
1688
    int error_concealment;
 
1689
#define FF_EC_GUESS_MVS   1
 
1690
#define FF_EC_DEBLOCK     2
 
1691
 
 
1692
    /**
 
1693
     * dsp_mask could be add used to disable unwanted CPU features
 
1694
     * CPU features (i.e. MMX, SSE. ...)
 
1695
     *
 
1696
     * With the FORCE flag you may instead enable given CPU features.
 
1697
     * (Dangerous: Usable in case of misdetection, improper usage however will
 
1698
     * result into program crash.)
 
1699
     */
 
1700
    unsigned dsp_mask;
 
1701
 
 
1702
    /**
 
1703
     * bits per sample/pixel from the demuxer (needed for huffyuv).
 
1704
     * - encoding: Set by libavcodec.
 
1705
     * - decoding: Set by user.
 
1706
     */
 
1707
     int bits_per_coded_sample;
 
1708
 
 
1709
    /**
 
1710
     * prediction method (needed for huffyuv)
 
1711
     * - encoding: Set by user.
 
1712
     * - decoding: unused
 
1713
     */
 
1714
     int prediction_method;
 
1715
#define FF_PRED_LEFT   0
 
1716
#define FF_PRED_PLANE  1
 
1717
#define FF_PRED_MEDIAN 2
 
1718
 
 
1719
    /**
 
1720
     * sample aspect ratio (0 if unknown)
 
1721
     * That is the width of a pixel divided by the height of the pixel.
 
1722
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
 
1723
     * - encoding: Set by user.
 
1724
     * - decoding: Set by libavcodec.
 
1725
     */
 
1726
    AVRational sample_aspect_ratio;
 
1727
 
 
1728
    /**
 
1729
     * the picture in the bitstream
 
1730
     * - encoding: Set by libavcodec.
 
1731
     * - decoding: Set by libavcodec.
 
1732
     */
 
1733
    AVFrame *coded_frame;
 
1734
 
 
1735
    /**
 
1736
     * debug
 
1737
     * - encoding: Set by user.
 
1738
     * - decoding: Set by user.
 
1739
     */
 
1740
    int debug;
 
1741
#define FF_DEBUG_PICT_INFO   1
 
1742
#define FF_DEBUG_RC          2
 
1743
#define FF_DEBUG_BITSTREAM   4
 
1744
#define FF_DEBUG_MB_TYPE     8
 
1745
#define FF_DEBUG_QP          16
 
1746
#define FF_DEBUG_MV          32
 
1747
#define FF_DEBUG_DCT_COEFF   0x00000040
 
1748
#define FF_DEBUG_SKIP        0x00000080
 
1749
#define FF_DEBUG_STARTCODE   0x00000100
 
1750
#define FF_DEBUG_PTS         0x00000200
 
1751
#define FF_DEBUG_ER          0x00000400
 
1752
#define FF_DEBUG_MMCO        0x00000800
 
1753
#define FF_DEBUG_BUGS        0x00001000
 
1754
#define FF_DEBUG_VIS_QP      0x00002000
 
1755
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
 
1756
#define FF_DEBUG_BUFFERS     0x00008000
 
1757
#define FF_DEBUG_THREADS     0x00010000
 
1758
 
 
1759
    /**
 
1760
     * debug
 
1761
     * - encoding: Set by user.
 
1762
     * - decoding: Set by user.
 
1763
     */
 
1764
    int debug_mv;
 
1765
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
 
1766
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
 
1767
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
 
1768
 
 
1769
    /**
 
1770
     * error
 
1771
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
 
1772
     * - decoding: unused
 
1773
     */
 
1774
    uint64_t error[4];
 
1775
 
 
1776
    /**
 
1777
     * motion estimation comparison function
 
1778
     * - encoding: Set by user.
 
1779
     * - decoding: unused
 
1780
     */
 
1781
    int me_cmp;
 
1782
    /**
 
1783
     * subpixel motion estimation comparison function
 
1784
     * - encoding: Set by user.
 
1785
     * - decoding: unused
 
1786
     */
 
1787
    int me_sub_cmp;
 
1788
    /**
 
1789
     * macroblock comparison function (not supported yet)
 
1790
     * - encoding: Set by user.
 
1791
     * - decoding: unused
 
1792
     */
 
1793
    int mb_cmp;
 
1794
    /**
 
1795
     * interlaced DCT comparison function
 
1796
     * - encoding: Set by user.
 
1797
     * - decoding: unused
 
1798
     */
 
1799
    int ildct_cmp;
 
1800
#define FF_CMP_SAD    0
 
1801
#define FF_CMP_SSE    1
 
1802
#define FF_CMP_SATD   2
 
1803
#define FF_CMP_DCT    3
 
1804
#define FF_CMP_PSNR   4
 
1805
#define FF_CMP_BIT    5
 
1806
#define FF_CMP_RD     6
 
1807
#define FF_CMP_ZERO   7
 
1808
#define FF_CMP_VSAD   8
 
1809
#define FF_CMP_VSSE   9
 
1810
#define FF_CMP_NSSE   10
 
1811
#define FF_CMP_W53    11
 
1812
#define FF_CMP_W97    12
 
1813
#define FF_CMP_DCTMAX 13
 
1814
#define FF_CMP_DCT264 14
 
1815
#define FF_CMP_CHROMA 256
 
1816
 
 
1817
    /**
 
1818
     * ME diamond size & shape
 
1819
     * - encoding: Set by user.
 
1820
     * - decoding: unused
 
1821
     */
 
1822
    int dia_size;
 
1823
 
 
1824
    /**
 
1825
     * amount of previous MV predictors (2a+1 x 2a+1 square)
 
1826
     * - encoding: Set by user.
 
1827
     * - decoding: unused
 
1828
     */
 
1829
    int last_predictor_count;
 
1830
 
 
1831
    /**
 
1832
     * prepass for motion estimation
 
1833
     * - encoding: Set by user.
 
1834
     * - decoding: unused
 
1835
     */
 
1836
    int pre_me;
 
1837
 
 
1838
    /**
 
1839
     * motion estimation prepass comparison function
 
1840
     * - encoding: Set by user.
 
1841
     * - decoding: unused
 
1842
     */
 
1843
    int me_pre_cmp;
 
1844
 
 
1845
    /**
 
1846
     * ME prepass diamond size & shape
 
1847
     * - encoding: Set by user.
 
1848
     * - decoding: unused
 
1849
     */
 
1850
    int pre_dia_size;
 
1851
 
 
1852
    /**
 
1853
     * subpel ME quality
 
1854
     * - encoding: Set by user.
 
1855
     * - decoding: unused
 
1856
     */
 
1857
    int me_subpel_quality;
 
1858
 
 
1859
    /**
 
1860
     * callback to negotiate the pixelFormat
 
1861
     * @param fmt is the list of formats which are supported by the codec,
 
1862
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
 
1863
     * The first is always the native one.
 
1864
     * @return the chosen format
 
1865
     * - encoding: unused
 
1866
     * - decoding: Set by user, if not set the native format will be chosen.
 
1867
     */
 
1868
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
 
1869
 
 
1870
    /**
 
1871
     * DTG active format information (additional aspect ratio
 
1872
     * information only used in DVB MPEG-2 transport streams)
 
1873
     * 0 if not set.
 
1874
     *
 
1875
     * - encoding: unused
 
1876
     * - decoding: Set by decoder.
 
1877
     */
 
1878
    int dtg_active_format;
 
1879
#define FF_DTG_AFD_SAME         8
 
1880
#define FF_DTG_AFD_4_3          9
 
1881
#define FF_DTG_AFD_16_9         10
 
1882
#define FF_DTG_AFD_14_9         11
 
1883
#define FF_DTG_AFD_4_3_SP_14_9  13
 
1884
#define FF_DTG_AFD_16_9_SP_14_9 14
 
1885
#define FF_DTG_AFD_SP_4_3       15
 
1886
 
 
1887
    /**
 
1888
     * maximum motion estimation search range in subpel units
 
1889
     * If 0 then no limit.
 
1890
     *
 
1891
     * - encoding: Set by user.
 
1892
     * - decoding: unused
 
1893
     */
 
1894
    int me_range;
 
1895
 
 
1896
    /**
 
1897
     * intra quantizer bias
 
1898
     * - encoding: Set by user.
 
1899
     * - decoding: unused
 
1900
     */
 
1901
    int intra_quant_bias;
 
1902
#define FF_DEFAULT_QUANT_BIAS 999999
 
1903
 
 
1904
    /**
 
1905
     * inter quantizer bias
 
1906
     * - encoding: Set by user.
 
1907
     * - decoding: unused
 
1908
     */
 
1909
    int inter_quant_bias;
 
1910
 
 
1911
    /**
 
1912
     * color table ID
 
1913
     * - encoding: unused
 
1914
     * - decoding: Which clrtable should be used for 8bit RGB images.
 
1915
     *             Tables have to be stored somewhere. FIXME
 
1916
     */
 
1917
    int color_table_id;
 
1918
 
 
1919
    /**
 
1920
     * internal_buffer count
 
1921
     * Don't touch, used by libavcodec default_get_buffer().
 
1922
     */
 
1923
    int internal_buffer_count;
 
1924
 
 
1925
    /**
 
1926
     * internal_buffers
 
1927
     * Don't touch, used by libavcodec default_get_buffer().
 
1928
     */
 
1929
    void *internal_buffer;
 
1930
 
 
1931
    /**
 
1932
     * Global quality for codecs which cannot change it per frame.
 
1933
     * This should be proportional to MPEG-1/2/4 qscale.
 
1934
     * - encoding: Set by user.
 
1935
     * - decoding: unused
 
1936
     */
 
1937
    int global_quality;
 
1938
 
 
1939
#define FF_CODER_TYPE_VLC       0
 
1940
#define FF_CODER_TYPE_AC        1
 
1941
#define FF_CODER_TYPE_RAW       2
 
1942
#define FF_CODER_TYPE_RLE       3
 
1943
#define FF_CODER_TYPE_DEFLATE   4
 
1944
    /**
 
1945
     * coder type
 
1946
     * - encoding: Set by user.
 
1947
     * - decoding: unused
 
1948
     */
 
1949
    int coder_type;
 
1950
 
 
1951
    /**
 
1952
     * context model
 
1953
     * - encoding: Set by user.
 
1954
     * - decoding: unused
 
1955
     */
 
1956
    int context_model;
 
1957
#if 0
 
1958
    /**
 
1959
     *
 
1960
     * - encoding: unused
 
1961
     * - decoding: Set by user.
 
1962
     */
 
1963
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
 
1964
#endif
 
1965
 
 
1966
    /**
 
1967
     * slice flags
 
1968
     * - encoding: unused
 
1969
     * - decoding: Set by user.
 
1970
     */
 
1971
    int slice_flags;
 
1972
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
 
1973
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
 
1974
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
 
1975
 
 
1976
    /**
 
1977
     * XVideo Motion Acceleration
 
1978
     * - encoding: forbidden
 
1979
     * - decoding: set by decoder
 
1980
     */
 
1981
    int xvmc_acceleration;
 
1982
 
 
1983
    /**
 
1984
     * macroblock decision mode
 
1985
     * - encoding: Set by user.
 
1986
     * - decoding: unused
 
1987
     */
 
1988
    int mb_decision;
 
1989
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
 
1990
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
 
1991
#define FF_MB_DECISION_RD     2        ///< rate distortion
 
1992
 
 
1993
    /**
 
1994
     * custom intra quantization matrix
 
1995
     * - encoding: Set by user, can be NULL.
 
1996
     * - decoding: Set by libavcodec.
 
1997
     */
 
1998
    uint16_t *intra_matrix;
 
1999
 
 
2000
    /**
 
2001
     * custom inter quantization matrix
 
2002
     * - encoding: Set by user, can be NULL.
 
2003
     * - decoding: Set by libavcodec.
 
2004
     */
 
2005
    uint16_t *inter_matrix;
 
2006
 
 
2007
    /**
 
2008
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
 
2009
     * This is used to work around some encoder bugs.
 
2010
     * - encoding: unused
 
2011
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
 
2012
     */
 
2013
    unsigned int stream_codec_tag;
 
2014
 
 
2015
    /**
 
2016
     * scene change detection threshold
 
2017
     * 0 is default, larger means fewer detected scene changes.
 
2018
     * - encoding: Set by user.
 
2019
     * - decoding: unused
 
2020
     */
 
2021
    int scenechange_threshold;
 
2022
 
 
2023
    /**
 
2024
     * minimum Lagrange multipler
 
2025
     * - encoding: Set by user.
 
2026
     * - decoding: unused
 
2027
     */
 
2028
    int lmin;
 
2029
 
 
2030
    /**
 
2031
     * maximum Lagrange multipler
 
2032
     * - encoding: Set by user.
 
2033
     * - decoding: unused
 
2034
     */
 
2035
    int lmax;
 
2036
 
 
2037
#if FF_API_PALETTE_CONTROL
 
2038
    /**
 
2039
     * palette control structure
 
2040
     * - encoding: ??? (no palette-enabled encoder yet)
 
2041
     * - decoding: Set by user.
 
2042
     */
 
2043
    struct AVPaletteControl *palctrl;
 
2044
#endif
 
2045
 
 
2046
    /**
 
2047
     * noise reduction strength
 
2048
     * - encoding: Set by user.
 
2049
     * - decoding: unused
 
2050
     */
 
2051
    int noise_reduction;
 
2052
 
 
2053
    /**
 
2054
     * Called at the beginning of a frame to get cr buffer for it.
 
2055
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
 
2056
     * libavcodec will pass previous buffer in pic, function should return
 
2057
     * same buffer or new buffer with old frame "painted" into it.
 
2058
     * If pic.data[0] == NULL must behave like get_buffer().
 
2059
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
 
2060
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
 
2061
     * some other means.
 
2062
     * - encoding: unused
 
2063
     * - decoding: Set by libavcodec, user can override.
 
2064
     */
 
2065
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
 
2066
 
 
2067
    /**
 
2068
     * Number of bits which should be loaded into the rc buffer before decoding starts.
 
2069
     * - encoding: Set by user.
 
2070
     * - decoding: unused
 
2071
     */
 
2072
    int rc_initial_buffer_occupancy;
 
2073
 
 
2074
    /**
 
2075
     *
 
2076
     * - encoding: Set by user.
 
2077
     * - decoding: unused
 
2078
     */
 
2079
    int inter_threshold;
 
2080
 
 
2081
    /**
 
2082
     * CODEC_FLAG2_*
 
2083
     * - encoding: Set by user.
 
2084
     * - decoding: Set by user.
 
2085
     */
 
2086
    int flags2;
 
2087
 
 
2088
    /**
 
2089
     * Simulates errors in the bitstream to test error concealment.
 
2090
     * - encoding: Set by user.
 
2091
     * - decoding: unused
 
2092
     */
 
2093
    int error_rate;
 
2094
 
 
2095
#if FF_API_ANTIALIAS_ALGO
 
2096
    /**
 
2097
     * MP3 antialias algorithm, see FF_AA_* below.
 
2098
     * - encoding: unused
 
2099
     * - decoding: Set by user.
 
2100
     */
 
2101
    attribute_deprecated int antialias_algo;
 
2102
#define FF_AA_AUTO    0
 
2103
#define FF_AA_FASTINT 1 //not implemented yet
 
2104
#define FF_AA_INT     2
 
2105
#define FF_AA_FLOAT   3
 
2106
#endif
 
2107
 
 
2108
    /**
 
2109
     * quantizer noise shaping
 
2110
     * - encoding: Set by user.
 
2111
     * - decoding: unused
 
2112
     */
 
2113
    int quantizer_noise_shaping;
 
2114
 
 
2115
    /**
 
2116
     * thread count
 
2117
     * is used to decide how many independent tasks should be passed to execute()
 
2118
     * - encoding: Set by user.
 
2119
     * - decoding: Set by user.
 
2120
     */
 
2121
    int thread_count;
 
2122
 
 
2123
    /**
 
2124
     * The codec may call this to execute several independent things.
 
2125
     * It will return only after finishing all tasks.
 
2126
     * The user may replace this with some multithreaded implementation,
 
2127
     * the default implementation will execute the parts serially.
 
2128
     * @param count the number of things to execute
 
2129
     * - encoding: Set by libavcodec, user can override.
 
2130
     * - decoding: Set by libavcodec, user can override.
 
2131
     */
 
2132
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
 
2133
 
 
2134
    /**
 
2135
     * thread opaque
 
2136
     * Can be used by execute() to store some per AVCodecContext stuff.
 
2137
     * - encoding: set by execute()
 
2138
     * - decoding: set by execute()
 
2139
     */
 
2140
    void *thread_opaque;
 
2141
 
 
2142
    /**
 
2143
     * Motion estimation threshold below which no motion estimation is
 
2144
     * performed, but instead the user specified motion vectors are used.
 
2145
     *
 
2146
     * - encoding: Set by user.
 
2147
     * - decoding: unused
 
2148
     */
 
2149
     int me_threshold;
 
2150
 
 
2151
    /**
 
2152
     * Macroblock threshold below which the user specified macroblock types will be used.
 
2153
     * - encoding: Set by user.
 
2154
     * - decoding: unused
 
2155
     */
 
2156
     int mb_threshold;
 
2157
 
 
2158
    /**
 
2159
     * precision of the intra DC coefficient - 8
 
2160
     * - encoding: Set by user.
 
2161
     * - decoding: unused
 
2162
     */
 
2163
     int intra_dc_precision;
 
2164
 
 
2165
    /**
 
2166
     * noise vs. sse weight for the nsse comparsion function
 
2167
     * - encoding: Set by user.
 
2168
     * - decoding: unused
 
2169
     */
 
2170
     int nsse_weight;
 
2171
 
 
2172
    /**
 
2173
     * Number of macroblock rows at the top which are skipped.
 
2174
     * - encoding: unused
 
2175
     * - decoding: Set by user.
 
2176
     */
 
2177
     int skip_top;
 
2178
 
 
2179
    /**
 
2180
     * Number of macroblock rows at the bottom which are skipped.
 
2181
     * - encoding: unused
 
2182
     * - decoding: Set by user.
 
2183
     */
 
2184
     int skip_bottom;
 
2185
 
 
2186
    /**
 
2187
     * profile
 
2188
     * - encoding: Set by user.
 
2189
     * - decoding: Set by libavcodec.
 
2190
     */
 
2191
     int profile;
 
2192
#define FF_PROFILE_UNKNOWN -99
 
2193
#define FF_PROFILE_RESERVED -100
 
2194
 
 
2195
#define FF_PROFILE_AAC_MAIN 0
 
2196
#define FF_PROFILE_AAC_LOW  1
 
2197
#define FF_PROFILE_AAC_SSR  2
 
2198
#define FF_PROFILE_AAC_LTP  3
 
2199
 
 
2200
#define FF_PROFILE_DTS         20
 
2201
#define FF_PROFILE_DTS_ES      30
 
2202
#define FF_PROFILE_DTS_96_24   40
 
2203
#define FF_PROFILE_DTS_HD_HRA  50
 
2204
#define FF_PROFILE_DTS_HD_MA   60
 
2205
 
 
2206
#define FF_PROFILE_MPEG2_422    0
 
2207
#define FF_PROFILE_MPEG2_HIGH   1
 
2208
#define FF_PROFILE_MPEG2_SS     2
 
2209
#define FF_PROFILE_MPEG2_SNR_SCALABLE  3
 
2210
#define FF_PROFILE_MPEG2_MAIN   4
 
2211
#define FF_PROFILE_MPEG2_SIMPLE 5
 
2212
 
 
2213
#define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
 
2214
#define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
 
2215
 
 
2216
#define FF_PROFILE_H264_BASELINE             66
 
2217
#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
 
2218
#define FF_PROFILE_H264_MAIN                 77
 
2219
#define FF_PROFILE_H264_EXTENDED             88
 
2220
#define FF_PROFILE_H264_HIGH                 100
 
2221
#define FF_PROFILE_H264_HIGH_10              110
 
2222
#define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
 
2223
#define FF_PROFILE_H264_HIGH_422             122
 
2224
#define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
 
2225
#define FF_PROFILE_H264_HIGH_444             144
 
2226
#define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
 
2227
#define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
 
2228
#define FF_PROFILE_H264_CAVLC_444            44
 
2229
 
 
2230
#define FF_PROFILE_VC1_SIMPLE   0
 
2231
#define FF_PROFILE_VC1_MAIN     1
 
2232
#define FF_PROFILE_VC1_COMPLEX  2
 
2233
#define FF_PROFILE_VC1_ADVANCED 3
 
2234
 
 
2235
    /**
 
2236
     * level
 
2237
     * - encoding: Set by user.
 
2238
     * - decoding: Set by libavcodec.
 
2239
     */
 
2240
     int level;
 
2241
#define FF_LEVEL_UNKNOWN -99
 
2242
 
 
2243
    /**
 
2244
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
 
2245
     * - encoding: unused
 
2246
     * - decoding: Set by user.
 
2247
     */
 
2248
     int lowres;
 
2249
 
 
2250
    /**
 
2251
     * Bitstream width / height, may be different from width/height if lowres
 
2252
     * or other things are used.
 
2253
     * - encoding: unused
 
2254
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
 
2255
     */
 
2256
    int coded_width, coded_height;
 
2257
 
 
2258
    /**
 
2259
     * frame skip threshold
 
2260
     * - encoding: Set by user.
 
2261
     * - decoding: unused
 
2262
     */
 
2263
    int frame_skip_threshold;
 
2264
 
 
2265
    /**
 
2266
     * frame skip factor
 
2267
     * - encoding: Set by user.
 
2268
     * - decoding: unused
 
2269
     */
 
2270
    int frame_skip_factor;
 
2271
 
 
2272
    /**
 
2273
     * frame skip exponent
 
2274
     * - encoding: Set by user.
 
2275
     * - decoding: unused
 
2276
     */
 
2277
    int frame_skip_exp;
 
2278
 
 
2279
    /**
 
2280
     * frame skip comparison function
 
2281
     * - encoding: Set by user.
 
2282
     * - decoding: unused
 
2283
     */
 
2284
    int frame_skip_cmp;
 
2285
 
 
2286
    /**
 
2287
     * Border processing masking, raises the quantizer for mbs on the borders
 
2288
     * of the picture.
 
2289
     * - encoding: Set by user.
 
2290
     * - decoding: unused
 
2291
     */
 
2292
    float border_masking;
 
2293
 
 
2294
    /**
 
2295
     * minimum MB lagrange multipler
 
2296
     * - encoding: Set by user.
 
2297
     * - decoding: unused
 
2298
     */
 
2299
    int mb_lmin;
 
2300
 
 
2301
    /**
 
2302
     * maximum MB lagrange multipler
 
2303
     * - encoding: Set by user.
 
2304
     * - decoding: unused
 
2305
     */
 
2306
    int mb_lmax;
 
2307
 
 
2308
    /**
 
2309
     *
 
2310
     * - encoding: Set by user.
 
2311
     * - decoding: unused
 
2312
     */
 
2313
    int me_penalty_compensation;
 
2314
 
 
2315
    /**
 
2316
     *
 
2317
     * - encoding: unused
 
2318
     * - decoding: Set by user.
 
2319
     */
 
2320
    enum AVDiscard skip_loop_filter;
 
2321
 
 
2322
    /**
 
2323
     *
 
2324
     * - encoding: unused
 
2325
     * - decoding: Set by user.
 
2326
     */
 
2327
    enum AVDiscard skip_idct;
 
2328
 
 
2329
    /**
 
2330
     *
 
2331
     * - encoding: unused
 
2332
     * - decoding: Set by user.
 
2333
     */
 
2334
    enum AVDiscard skip_frame;
 
2335
 
 
2336
    /**
 
2337
     *
 
2338
     * - encoding: Set by user.
 
2339
     * - decoding: unused
 
2340
     */
 
2341
    int bidir_refine;
 
2342
 
 
2343
    /**
 
2344
     *
 
2345
     * - encoding: Set by user.
 
2346
     * - decoding: unused
 
2347
     */
 
2348
    int brd_scale;
 
2349
 
 
2350
    /**
 
2351
     * constant rate factor - quality-based VBR - values ~correspond to qps
 
2352
     * - encoding: Set by user.
 
2353
     * - decoding: unused
 
2354
     */
 
2355
    float crf;
 
2356
 
 
2357
    /**
 
2358
     * constant quantization parameter rate control method
 
2359
     * - encoding: Set by user.
 
2360
     * - decoding: unused
 
2361
     */
 
2362
    int cqp;
 
2363
 
 
2364
    /**
 
2365
     * minimum GOP size
 
2366
     * - encoding: Set by user.
 
2367
     * - decoding: unused
 
2368
     */
 
2369
    int keyint_min;
 
2370
 
 
2371
    /**
 
2372
     * number of reference frames
 
2373
     * - encoding: Set by user.
 
2374
     * - decoding: Set by lavc.
 
2375
     */
 
2376
    int refs;
 
2377
 
 
2378
    /**
 
2379
     * chroma qp offset from luma
 
2380
     * - encoding: Set by user.
 
2381
     * - decoding: unused
 
2382
     */
 
2383
    int chromaoffset;
 
2384
 
 
2385
    /**
 
2386
     * Influences how often B-frames are used.
 
2387
     * - encoding: Set by user.
 
2388
     * - decoding: unused
 
2389
     */
 
2390
    int bframebias;
 
2391
 
 
2392
    /**
 
2393
     * trellis RD quantization
 
2394
     * - encoding: Set by user.
 
2395
     * - decoding: unused
 
2396
     */
 
2397
    int trellis;
 
2398
 
 
2399
    /**
 
2400
     * Reduce fluctuations in qp (before curve compression).
 
2401
     * - encoding: Set by user.
 
2402
     * - decoding: unused
 
2403
     */
 
2404
    float complexityblur;
 
2405
 
 
2406
    /**
 
2407
     * in-loop deblocking filter alphac0 parameter
 
2408
     * alpha is in the range -6...6
 
2409
     * - encoding: Set by user.
 
2410
     * - decoding: unused
 
2411
     */
 
2412
    int deblockalpha;
 
2413
 
 
2414
    /**
 
2415
     * in-loop deblocking filter beta parameter
 
2416
     * beta is in the range -6...6
 
2417
     * - encoding: Set by user.
 
2418
     * - decoding: unused
 
2419
     */
 
2420
    int deblockbeta;
 
2421
 
 
2422
    /**
 
2423
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
 
2424
     * - encoding: Set by user.
 
2425
     * - decoding: unused
 
2426
     */
 
2427
    int partitions;
 
2428
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
 
2429
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
 
2430
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
 
2431
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
 
2432
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
 
2433
 
 
2434
    /**
 
2435
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
 
2436
     * - encoding: Set by user.
 
2437
     * - decoding: unused
 
2438
     */
 
2439
    int directpred;
 
2440
 
 
2441
    /**
 
2442
     * Audio cutoff bandwidth (0 means "automatic")
 
2443
     * - encoding: Set by user.
 
2444
     * - decoding: unused
 
2445
     */
 
2446
    int cutoff;
 
2447
 
 
2448
    /**
 
2449
     * Multiplied by qscale for each frame and added to scene_change_score.
 
2450
     * - encoding: Set by user.
 
2451
     * - decoding: unused
 
2452
     */
 
2453
    int scenechange_factor;
 
2454
 
 
2455
    /**
 
2456
     *
 
2457
     * Note: Value depends upon the compare function used for fullpel ME.
 
2458
     * - encoding: Set by user.
 
2459
     * - decoding: unused
 
2460
     */
 
2461
    int mv0_threshold;
 
2462
 
 
2463
    /**
 
2464
     * Adjusts sensitivity of b_frame_strategy 1.
 
2465
     * - encoding: Set by user.
 
2466
     * - decoding: unused
 
2467
     */
 
2468
    int b_sensitivity;
 
2469
 
 
2470
    /**
 
2471
     * - encoding: Set by user.
 
2472
     * - decoding: unused
 
2473
     */
 
2474
    int compression_level;
 
2475
#define FF_COMPRESSION_DEFAULT -1
 
2476
 
 
2477
    /**
 
2478
     * - encoding: Set by user.
 
2479
     * - decoding: unused
 
2480
     */
 
2481
    int min_prediction_order;
 
2482
 
 
2483
    /**
 
2484
     * - encoding: Set by user.
 
2485
     * - decoding: unused
 
2486
     */
 
2487
    int max_prediction_order;
 
2488
 
 
2489
#if FF_API_FLAC_GLOBAL_OPTS
 
2490
    /**
 
2491
     * @name FLAC options
 
2492
     * @deprecated Use FLAC encoder private options instead.
 
2493
     * @{
 
2494
     */
 
2495
 
 
2496
    /**
 
2497
     * LPC coefficient precision - used by FLAC encoder
 
2498
     * - encoding: Set by user.
 
2499
     * - decoding: unused
 
2500
     */
 
2501
    attribute_deprecated int lpc_coeff_precision;
 
2502
 
 
2503
    /**
 
2504
     * search method for selecting prediction order
 
2505
     * - encoding: Set by user.
 
2506
     * - decoding: unused
 
2507
     */
 
2508
    attribute_deprecated int prediction_order_method;
 
2509
 
 
2510
    /**
 
2511
     * - encoding: Set by user.
 
2512
     * - decoding: unused
 
2513
     */
 
2514
    attribute_deprecated int min_partition_order;
 
2515
 
 
2516
    /**
 
2517
     * - encoding: Set by user.
 
2518
     * - decoding: unused
 
2519
     */
 
2520
    attribute_deprecated int max_partition_order;
 
2521
    /**
 
2522
     * @}
 
2523
     */
 
2524
#endif
 
2525
 
 
2526
    /**
 
2527
     * GOP timecode frame start number, in non drop frame format
 
2528
     * - encoding: Set by user.
 
2529
     * - decoding: unused
 
2530
     */
 
2531
    int64_t timecode_frame_start;
 
2532
 
 
2533
#if FF_API_REQUEST_CHANNELS
 
2534
    /**
 
2535
     * Decoder should decode to this many channels if it can (0 for default)
 
2536
     * - encoding: unused
 
2537
     * - decoding: Set by user.
 
2538
     * @deprecated Deprecated in favor of request_channel_layout.
 
2539
     */
 
2540
    int request_channels;
 
2541
#endif
 
2542
 
 
2543
    /**
 
2544
     * Percentage of dynamic range compression to be applied by the decoder.
 
2545
     * The default value is 1.0, corresponding to full compression.
 
2546
     * - encoding: unused
 
2547
     * - decoding: Set by user.
 
2548
     */
 
2549
    float drc_scale;
 
2550
 
 
2551
    /**
 
2552
     * opaque 64bit number (generally a PTS) that will be reordered and
 
2553
     * output in AVFrame.reordered_opaque
 
2554
     * @deprecated in favor of pkt_pts
 
2555
     * - encoding: unused
 
2556
     * - decoding: Set by user.
 
2557
     */
 
2558
    int64_t reordered_opaque;
 
2559
 
 
2560
    /**
 
2561
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
 
2562
     * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
 
2563
     * - encoding: set by user.
 
2564
     * - decoding: set by libavcodec.
 
2565
     */
 
2566
    int bits_per_raw_sample;
 
2567
 
 
2568
    /**
 
2569
     * Audio channel layout.
 
2570
     * - encoding: set by user.
 
2571
     * - decoding: set by libavcodec.
 
2572
     */
 
2573
    int64_t channel_layout;
 
2574
 
 
2575
    /**
 
2576
     * Request decoder to use this channel layout if it can (0 for default)
 
2577
     * - encoding: unused
 
2578
     * - decoding: Set by user.
 
2579
     */
 
2580
    int64_t request_channel_layout;
 
2581
 
 
2582
    /**
 
2583
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
 
2584
     * - encoding: Set by user.
 
2585
     * - decoding: unused.
 
2586
     */
 
2587
    float rc_max_available_vbv_use;
 
2588
 
 
2589
    /**
 
2590
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
 
2591
     * - encoding: Set by user.
 
2592
     * - decoding: unused.
 
2593
     */
 
2594
    float rc_min_vbv_overflow_use;
 
2595
 
 
2596
    /**
 
2597
     * Hardware accelerator in use
 
2598
     * - encoding: unused.
 
2599
     * - decoding: Set by libavcodec
 
2600
     */
 
2601
    struct AVHWAccel *hwaccel;
 
2602
 
 
2603
    /**
 
2604
     * For some codecs, the time base is closer to the field rate than the frame rate.
 
2605
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
 
2606
     * if no telecine is used ...
 
2607
     *
 
2608
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
 
2609
     */
 
2610
    int ticks_per_frame;
 
2611
 
 
2612
    /**
 
2613
     * Hardware accelerator context.
 
2614
     * For some hardware accelerators, a global context needs to be
 
2615
     * provided by the user. In that case, this holds display-dependent
 
2616
     * data Libav cannot instantiate itself. Please refer to the
 
2617
     * Libav HW accelerator documentation to know how to fill this
 
2618
     * is. e.g. for VA API, this is a struct vaapi_context.
 
2619
     * - encoding: unused
 
2620
     * - decoding: Set by user
 
2621
     */
 
2622
    void *hwaccel_context;
 
2623
 
 
2624
    /**
 
2625
     * Chromaticity coordinates of the source primaries.
 
2626
     * - encoding: Set by user
 
2627
     * - decoding: Set by libavcodec
 
2628
     */
 
2629
    enum AVColorPrimaries color_primaries;
 
2630
 
 
2631
    /**
 
2632
     * Color Transfer Characteristic.
 
2633
     * - encoding: Set by user
 
2634
     * - decoding: Set by libavcodec
 
2635
     */
 
2636
    enum AVColorTransferCharacteristic color_trc;
 
2637
 
 
2638
    /**
 
2639
     * YUV colorspace type.
 
2640
     * - encoding: Set by user
 
2641
     * - decoding: Set by libavcodec
 
2642
     */
 
2643
    enum AVColorSpace colorspace;
 
2644
 
 
2645
    /**
 
2646
     * MPEG vs JPEG YUV range.
 
2647
     * - encoding: Set by user
 
2648
     * - decoding: Set by libavcodec
 
2649
     */
 
2650
    enum AVColorRange color_range;
 
2651
 
 
2652
    /**
 
2653
     * This defines the location of chroma samples.
 
2654
     * - encoding: Set by user
 
2655
     * - decoding: Set by libavcodec
 
2656
     */
 
2657
    enum AVChromaLocation chroma_sample_location;
 
2658
 
 
2659
    /**
 
2660
     * The codec may call this to execute several independent things.
 
2661
     * It will return only after finishing all tasks.
 
2662
     * The user may replace this with some multithreaded implementation,
 
2663
     * the default implementation will execute the parts serially.
 
2664
     * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
 
2665
     * @param c context passed also to func
 
2666
     * @param count the number of things to execute
 
2667
     * @param arg2 argument passed unchanged to func
 
2668
     * @param ret return values of executed functions, must have space for "count" values. May be NULL.
 
2669
     * @param func function that will be called count times, with jobnr from 0 to count-1.
 
2670
     *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
 
2671
     *             two instances of func executing at the same time will have the same threadnr.
 
2672
     * @return always 0 currently, but code should handle a future improvement where when any call to func
 
2673
     *         returns < 0 no further calls to func may be done and < 0 is returned.
 
2674
     * - encoding: Set by libavcodec, user can override.
 
2675
     * - decoding: Set by libavcodec, user can override.
 
2676
     */
 
2677
    int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
 
2678
 
 
2679
    /**
 
2680
     * explicit P-frame weighted prediction analysis method
 
2681
     * 0: off
 
2682
     * 1: fast blind weighting (one reference duplicate with -1 offset)
 
2683
     * 2: smart weighting (full fade detection analysis)
 
2684
     * - encoding: Set by user.
 
2685
     * - decoding: unused
 
2686
     */
 
2687
    int weighted_p_pred;
 
2688
 
 
2689
    /**
 
2690
     * AQ mode
 
2691
     * 0: Disabled
 
2692
     * 1: Variance AQ (complexity mask)
 
2693
     * 2: Auto-variance AQ (experimental)
 
2694
     * - encoding: Set by user
 
2695
     * - decoding: unused
 
2696
     */
 
2697
    int aq_mode;
 
2698
 
 
2699
    /**
 
2700
     * AQ strength
 
2701
     * Reduces blocking and blurring in flat and textured areas.
 
2702
     * - encoding: Set by user
 
2703
     * - decoding: unused
 
2704
     */
 
2705
    float aq_strength;
 
2706
 
 
2707
    /**
 
2708
     * PSY RD
 
2709
     * Strength of psychovisual optimization
 
2710
     * - encoding: Set by user
 
2711
     * - decoding: unused
 
2712
     */
 
2713
    float psy_rd;
 
2714
 
 
2715
    /**
 
2716
     * PSY trellis
 
2717
     * Strength of psychovisual optimization
 
2718
     * - encoding: Set by user
 
2719
     * - decoding: unused
 
2720
     */
 
2721
    float psy_trellis;
 
2722
 
 
2723
    /**
 
2724
     * RC lookahead
 
2725
     * Number of frames for frametype and ratecontrol lookahead
 
2726
     * - encoding: Set by user
 
2727
     * - decoding: unused
 
2728
     */
 
2729
    int rc_lookahead;
 
2730
 
 
2731
    /**
 
2732
     * Constant rate factor maximum
 
2733
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
 
2734
     * than crf_max, even if doing so would violate VBV restrictions.
 
2735
     * - encoding: Set by user.
 
2736
     * - decoding: unused
 
2737
     */
 
2738
    float crf_max;
 
2739
 
 
2740
    int log_level_offset;
 
2741
 
 
2742
#if FF_API_FLAC_GLOBAL_OPTS
 
2743
    /**
 
2744
     * Determines which LPC analysis algorithm to use.
 
2745
     * - encoding: Set by user
 
2746
     * - decoding: unused
 
2747
     */
 
2748
    attribute_deprecated enum AVLPCType lpc_type;
 
2749
 
 
2750
    /**
 
2751
     * Number of passes to use for Cholesky factorization during LPC analysis
 
2752
     * - encoding: Set by user
 
2753
     * - decoding: unused
 
2754
     */
 
2755
    attribute_deprecated int lpc_passes;
 
2756
#endif
 
2757
 
 
2758
    /**
 
2759
     * Number of slices.
 
2760
     * Indicates number of picture subdivisions. Used for parallelized
 
2761
     * decoding.
 
2762
     * - encoding: Set by user
 
2763
     * - decoding: unused
 
2764
     */
 
2765
    int slices;
 
2766
 
 
2767
    /**
 
2768
     * Header containing style information for text subtitles.
 
2769
     * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
 
2770
     * [Script Info] and [V4+ Styles] section, plus the [Events] line and
 
2771
     * the Format line following. It shouldn't include any Dialogue line.
 
2772
     * - encoding: Set/allocated/freed by user (before avcodec_open())
 
2773
     * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
 
2774
     */
 
2775
    uint8_t *subtitle_header;
 
2776
    int subtitle_header_size;
 
2777
 
 
2778
    /**
 
2779
     * Current packet as passed into the decoder, to avoid having
 
2780
     * to pass the packet into every function. Currently only valid
 
2781
     * inside lavc and get/release_buffer callbacks.
 
2782
     * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
 
2783
     * - encoding: unused
 
2784
     */
 
2785
    AVPacket *pkt;
 
2786
 
 
2787
    /**
 
2788
     * Whether this is a copy of the context which had init() called on it.
 
2789
     * This is used by multithreading - shared tables and picture pointers
 
2790
     * should be freed from the original context only.
 
2791
     * - encoding: Set by libavcodec.
 
2792
     * - decoding: Set by libavcodec.
 
2793
     */
 
2794
    int is_copy;
 
2795
 
 
2796
    /**
 
2797
     * Which multithreading methods to use.
 
2798
     * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
 
2799
     * so clients which cannot provide future frames should not use it.
 
2800
     *
 
2801
     * - encoding: Set by user, otherwise the default is used.
 
2802
     * - decoding: Set by user, otherwise the default is used.
 
2803
     */
 
2804
    int thread_type;
 
2805
#define FF_THREAD_FRAME   1 //< Decode more than one frame at once
 
2806
#define FF_THREAD_SLICE   2 //< Decode more than one part of a single frame at once
 
2807
 
 
2808
    /**
 
2809
     * Which multithreading methods are in use by the codec.
 
2810
     * - encoding: Set by libavcodec.
 
2811
     * - decoding: Set by libavcodec.
 
2812
     */
 
2813
    int active_thread_type;
 
2814
 
 
2815
    /**
 
2816
     * Set by the client if its custom get_buffer() callback can be called
 
2817
     * from another thread, which allows faster multithreaded decoding.
 
2818
     * draw_horiz_band() will be called from other threads regardless of this setting.
 
2819
     * Ignored if the default get_buffer() is used.
 
2820
     * - encoding: Set by user.
 
2821
     * - decoding: Set by user.
 
2822
     */
 
2823
    int thread_safe_callbacks;
 
2824
 
 
2825
    /**
 
2826
     * VBV delay coded in the last frame (in periods of a 27 MHz clock).
 
2827
     * Used for compliant TS muxing.
 
2828
     * - encoding: Set by libavcodec.
 
2829
     * - decoding: unused.
 
2830
     */
 
2831
    uint64_t vbv_delay;
 
2832
 
 
2833
    /**
 
2834
     * Type of service that the audio stream conveys.
 
2835
     * - encoding: Set by user.
 
2836
     * - decoding: Set by libavcodec.
 
2837
     */
 
2838
    enum AVAudioServiceType audio_service_type;
 
2839
 
 
2840
    /**
 
2841
     * Used to request a sample format from the decoder.
 
2842
     * - encoding: unused.
 
2843
     * - decoding: Set by user.
 
2844
     */
 
2845
    enum AVSampleFormat request_sample_fmt;
 
2846
} AVCodecContext;
 
2847
 
 
2848
/**
 
2849
 * AVProfile.
 
2850
 */
 
2851
typedef struct AVProfile {
 
2852
    int profile;
 
2853
    const char *name; ///< short name for the profile
 
2854
} AVProfile;
 
2855
 
 
2856
/**
 
2857
 * AVCodec.
 
2858
 */
 
2859
typedef struct AVCodec {
 
2860
    /**
 
2861
     * Name of the codec implementation.
 
2862
     * The name is globally unique among encoders and among decoders (but an
 
2863
     * encoder and a decoder can share the same name).
 
2864
     * This is the primary way to find a codec from the user perspective.
 
2865
     */
 
2866
    const char *name;
 
2867
    enum AVMediaType type;
 
2868
    enum CodecID id;
 
2869
    int priv_data_size;
 
2870
    int (*init)(AVCodecContext *);
 
2871
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
 
2872
    int (*close)(AVCodecContext *);
 
2873
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
 
2874
    /**
 
2875
     * Codec capabilities.
 
2876
     * see CODEC_CAP_*
 
2877
     */
 
2878
    int capabilities;
 
2879
    struct AVCodec *next;
 
2880
    /**
 
2881
     * Flush buffers.
 
2882
     * Will be called when seeking
 
2883
     */
 
2884
    void (*flush)(AVCodecContext *);
 
2885
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
 
2886
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
 
2887
    /**
 
2888
     * Descriptive name for the codec, meant to be more human readable than name.
 
2889
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
 
2890
     */
 
2891
    const char *long_name;
 
2892
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
 
2893
    const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
 
2894
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
 
2895
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
 
2896
    const AVClass *priv_class;              ///< AVClass for the private context
 
2897
    const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
 
2898
 
 
2899
    /**
 
2900
     * @name Frame-level threading support functions
 
2901
     * @{
 
2902
     */
 
2903
    /**
 
2904
     * If defined, called on thread contexts when they are created.
 
2905
     * If the codec allocates writable tables in init(), re-allocate them here.
 
2906
     * priv_data will be set to a copy of the original.
 
2907
     */
 
2908
    int (*init_thread_copy)(AVCodecContext *);
 
2909
    /**
 
2910
     * Copy necessary context variables from a previous thread context to the current one.
 
2911
     * If not defined, the next thread will start automatically; otherwise, the codec
 
2912
     * must call ff_thread_finish_setup().
 
2913
     *
 
2914
     * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
 
2915
     */
 
2916
    int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
 
2917
    /** @} */
 
2918
} AVCodec;
 
2919
 
 
2920
/**
 
2921
 * AVHWAccel.
 
2922
 */
 
2923
typedef struct AVHWAccel {
 
2924
    /**
 
2925
     * Name of the hardware accelerated codec.
 
2926
     * The name is globally unique among encoders and among decoders (but an
 
2927
     * encoder and a decoder can share the same name).
 
2928
     */
 
2929
    const char *name;
 
2930
 
 
2931
    /**
 
2932
     * Type of codec implemented by the hardware accelerator.
 
2933
     *
 
2934
     * See AVMEDIA_TYPE_xxx
 
2935
     */
 
2936
    enum AVMediaType type;
 
2937
 
 
2938
    /**
 
2939
     * Codec implemented by the hardware accelerator.
 
2940
     *
 
2941
     * See CODEC_ID_xxx
 
2942
     */
 
2943
    enum CodecID id;
 
2944
 
 
2945
    /**
 
2946
     * Supported pixel format.
 
2947
     *
 
2948
     * Only hardware accelerated formats are supported here.
 
2949
     */
 
2950
    enum PixelFormat pix_fmt;
 
2951
 
 
2952
    /**
 
2953
     * Hardware accelerated codec capabilities.
 
2954
     * see FF_HWACCEL_CODEC_CAP_*
 
2955
     */
 
2956
    int capabilities;
 
2957
 
 
2958
    struct AVHWAccel *next;
 
2959
 
 
2960
    /**
 
2961
     * Called at the beginning of each frame or field picture.
 
2962
     *
 
2963
     * Meaningful frame information (codec specific) is guaranteed to
 
2964
     * be parsed at this point. This function is mandatory.
 
2965
     *
 
2966
     * Note that buf can be NULL along with buf_size set to 0.
 
2967
     * Otherwise, this means the whole frame is available at this point.
 
2968
     *
 
2969
     * @param avctx the codec context
 
2970
     * @param buf the frame data buffer base
 
2971
     * @param buf_size the size of the frame in bytes
 
2972
     * @return zero if successful, a negative value otherwise
 
2973
     */
 
2974
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
 
2975
 
 
2976
    /**
 
2977
     * Callback for each slice.
 
2978
     *
 
2979
     * Meaningful slice information (codec specific) is guaranteed to
 
2980
     * be parsed at this point. This function is mandatory.
 
2981
     *
 
2982
     * @param avctx the codec context
 
2983
     * @param buf the slice data buffer base
 
2984
     * @param buf_size the size of the slice in bytes
 
2985
     * @return zero if successful, a negative value otherwise
 
2986
     */
 
2987
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
 
2988
 
 
2989
    /**
 
2990
     * Called at the end of each frame or field picture.
 
2991
     *
 
2992
     * The whole picture is parsed at this point and can now be sent
 
2993
     * to the hardware accelerator. This function is mandatory.
 
2994
     *
 
2995
     * @param avctx the codec context
 
2996
     * @return zero if successful, a negative value otherwise
 
2997
     */
 
2998
    int (*end_frame)(AVCodecContext *avctx);
 
2999
 
 
3000
    /**
 
3001
     * Size of HW accelerator private data.
 
3002
     *
 
3003
     * Private data is allocated with av_mallocz() before
 
3004
     * AVCodecContext.get_buffer() and deallocated after
 
3005
     * AVCodecContext.release_buffer().
 
3006
     */
 
3007
    int priv_data_size;
 
3008
} AVHWAccel;
 
3009
 
 
3010
/**
 
3011
 * four components are given, that's all.
 
3012
 * the last component is alpha
 
3013
 */
 
3014
typedef struct AVPicture {
 
3015
    uint8_t *data[4];
 
3016
    int linesize[4];       ///< number of bytes per line
 
3017
} AVPicture;
 
3018
 
 
3019
#if FF_API_PALETTE_CONTROL
 
3020
/**
 
3021
 * AVPaletteControl
 
3022
 * This structure defines a method for communicating palette changes
 
3023
 * between and demuxer and a decoder.
 
3024
 *
 
3025
 * @deprecated Use AVPacket to send palette changes instead.
 
3026
 * This is totally broken.
 
3027
 */
 
3028
#define AVPALETTE_SIZE 1024
 
3029
#define AVPALETTE_COUNT 256
 
3030
typedef struct AVPaletteControl {
 
3031
 
 
3032
    /* Demuxer sets this to 1 to indicate the palette has changed;
 
3033
     * decoder resets to 0. */
 
3034
    int palette_changed;
 
3035
 
 
3036
    /* 4-byte ARGB palette entries, stored in native byte order; note that
 
3037
     * the individual palette components should be on a 8-bit scale; if
 
3038
     * the palette data comes from an IBM VGA native format, the component
 
3039
     * data is probably 6 bits in size and needs to be scaled. */
 
3040
    unsigned int palette[AVPALETTE_COUNT];
 
3041
 
 
3042
} AVPaletteControl attribute_deprecated;
 
3043
#endif
 
3044
 
 
3045
enum AVSubtitleType {
 
3046
    SUBTITLE_NONE,
 
3047
 
 
3048
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
 
3049
 
 
3050
    /**
 
3051
     * Plain text, the text field must be set by the decoder and is
 
3052
     * authoritative. ass and pict fields may contain approximations.
 
3053
     */
 
3054
    SUBTITLE_TEXT,
 
3055
 
 
3056
    /**
 
3057
     * Formatted text, the ass field must be set by the decoder and is
 
3058
     * authoritative. pict and text fields may contain approximations.
 
3059
     */
 
3060
    SUBTITLE_ASS,
 
3061
};
 
3062
 
 
3063
typedef struct AVSubtitleRect {
 
3064
    int x;         ///< top left corner  of pict, undefined when pict is not set
 
3065
    int y;         ///< top left corner  of pict, undefined when pict is not set
 
3066
    int w;         ///< width            of pict, undefined when pict is not set
 
3067
    int h;         ///< height           of pict, undefined when pict is not set
 
3068
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
 
3069
 
 
3070
    /**
 
3071
     * data+linesize for the bitmap of this subtitle.
 
3072
     * can be set for text/ass as well once they where rendered
 
3073
     */
 
3074
    AVPicture pict;
 
3075
    enum AVSubtitleType type;
 
3076
 
 
3077
    char *text;                     ///< 0 terminated plain UTF-8 text
 
3078
 
 
3079
    /**
 
3080
     * 0 terminated ASS/SSA compatible event line.
 
3081
     * The pressentation of this is unaffected by the other values in this
 
3082
     * struct.
 
3083
     */
 
3084
    char *ass;
 
3085
} AVSubtitleRect;
 
3086
 
 
3087
typedef struct AVSubtitle {
 
3088
    uint16_t format; /* 0 = graphics */
 
3089
    uint32_t start_display_time; /* relative to packet pts, in ms */
 
3090
    uint32_t end_display_time; /* relative to packet pts, in ms */
 
3091
    unsigned num_rects;
 
3092
    AVSubtitleRect **rects;
 
3093
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
 
3094
} AVSubtitle;
 
3095
 
 
3096
/* packet functions */
 
3097
 
 
3098
/**
 
3099
 * @deprecated use NULL instead
 
3100
 */
 
3101
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
 
3102
 
 
3103
/**
 
3104
 * Default packet destructor.
 
3105
 */
 
3106
void av_destruct_packet(AVPacket *pkt);
 
3107
 
 
3108
/**
 
3109
 * Initialize optional fields of a packet with default values.
 
3110
 *
 
3111
 * @param pkt packet
 
3112
 */
 
3113
void av_init_packet(AVPacket *pkt);
 
3114
 
 
3115
/**
 
3116
 * Allocate the payload of a packet and initialize its fields with
 
3117
 * default values.
 
3118
 *
 
3119
 * @param pkt packet
 
3120
 * @param size wanted payload size
 
3121
 * @return 0 if OK, AVERROR_xxx otherwise
 
3122
 */
 
3123
int av_new_packet(AVPacket *pkt, int size);
 
3124
 
 
3125
/**
 
3126
 * Reduce packet size, correctly zeroing padding
 
3127
 *
 
3128
 * @param pkt packet
 
3129
 * @param size new size
 
3130
 */
 
3131
void av_shrink_packet(AVPacket *pkt, int size);
 
3132
 
 
3133
/**
 
3134
 * Increase packet size, correctly zeroing padding
 
3135
 *
 
3136
 * @param pkt packet
 
3137
 * @param grow_by number of bytes by which to increase the size of the packet
 
3138
 */
 
3139
int av_grow_packet(AVPacket *pkt, int grow_by);
 
3140
 
 
3141
/**
 
3142
 * @warning This is a hack - the packet memory allocation stuff is broken. The
 
3143
 * packet is allocated if it was not really allocated.
 
3144
 */
 
3145
int av_dup_packet(AVPacket *pkt);
 
3146
 
 
3147
/**
 
3148
 * Free a packet.
 
3149
 *
 
3150
 * @param pkt packet to free
 
3151
 */
 
3152
void av_free_packet(AVPacket *pkt);
 
3153
 
 
3154
/**
 
3155
 * Allocate new information of a packet.
 
3156
 *
 
3157
 * @param pkt packet
 
3158
 * @param type side information type
 
3159
 * @param size side information size
 
3160
 * @return pointer to fresh allocated data or NULL otherwise
 
3161
 */
 
3162
uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
 
3163
                                 int size);
 
3164
 
 
3165
/**
 
3166
 * Get side information from packet.
 
3167
 *
 
3168
 * @param pkt packet
 
3169
 * @param type desired side information type
 
3170
 * @param size pointer for side information size to store (optional)
 
3171
 * @return pointer to data if present or NULL otherwise
 
3172
 */
 
3173
uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
 
3174
                                 int *size);
 
3175
 
 
3176
/* resample.c */
 
3177
 
 
3178
struct ReSampleContext;
 
3179
struct AVResampleContext;
 
3180
 
 
3181
typedef struct ReSampleContext ReSampleContext;
 
3182
 
 
3183
/**
 
3184
 *  Initialize audio resampling context.
 
3185
 *
 
3186
 * @param output_channels  number of output channels
 
3187
 * @param input_channels   number of input channels
 
3188
 * @param output_rate      output sample rate
 
3189
 * @param input_rate       input sample rate
 
3190
 * @param sample_fmt_out   requested output sample format
 
3191
 * @param sample_fmt_in    input sample format
 
3192
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
 
3193
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
 
3194
 * @param linear           if 1 then the used FIR filter will be linearly interpolated
 
3195
                           between the 2 closest, if 0 the closest will be used
 
3196
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
 
3197
 * @return allocated ReSampleContext, NULL if error occured
 
3198
 */
 
3199
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
 
3200
                                        int output_rate, int input_rate,
 
3201
                                        enum AVSampleFormat sample_fmt_out,
 
3202
                                        enum AVSampleFormat sample_fmt_in,
 
3203
                                        int filter_length, int log2_phase_count,
 
3204
                                        int linear, double cutoff);
 
3205
 
 
3206
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
 
3207
 
 
3208
/**
 
3209
 * Free resample context.
 
3210
 *
 
3211
 * @param s a non-NULL pointer to a resample context previously
 
3212
 *          created with av_audio_resample_init()
 
3213
 */
 
3214
void audio_resample_close(ReSampleContext *s);
 
3215
 
 
3216
 
 
3217
/**
 
3218
 * Initialize an audio resampler.
 
3219
 * Note, if either rate is not an integer then simply scale both rates up so they are.
 
3220
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
 
3221
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
 
3222
 * @param linear If 1 then the used FIR filter will be linearly interpolated
 
3223
                 between the 2 closest, if 0 the closest will be used
 
3224
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
 
3225
 */
 
3226
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
 
3227
 
 
3228
/**
 
3229
 * Resample an array of samples using a previously configured context.
 
3230
 * @param src an array of unconsumed samples
 
3231
 * @param consumed the number of samples of src which have been consumed are returned here
 
3232
 * @param src_size the number of unconsumed samples available
 
3233
 * @param dst_size the amount of space in samples available in dst
 
3234
 * @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.
 
3235
 * @return the number of samples written in dst or -1 if an error occurred
 
3236
 */
 
3237
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
 
3238
 
 
3239
 
 
3240
/**
 
3241
 * Compensate samplerate/timestamp drift. The compensation is done by changing
 
3242
 * the resampler parameters, so no audible clicks or similar distortions occur
 
3243
 * @param compensation_distance distance in output samples over which the compensation should be performed
 
3244
 * @param sample_delta number of output samples which should be output less
 
3245
 *
 
3246
 * example: av_resample_compensate(c, 10, 500)
 
3247
 * here instead of 510 samples only 500 samples would be output
 
3248
 *
 
3249
 * note, due to rounding the actual compensation might be slightly different,
 
3250
 * especially if the compensation_distance is large and the in_rate used during init is small
 
3251
 */
 
3252
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
 
3253
void av_resample_close(struct AVResampleContext *c);
 
3254
 
 
3255
/**
 
3256
 * Allocate memory for a picture.  Call avpicture_free() to free it.
 
3257
 *
 
3258
 * \see avpicture_fill()
 
3259
 *
 
3260
 * @param picture the picture to be filled in
 
3261
 * @param pix_fmt the format of the picture
 
3262
 * @param width the width of the picture
 
3263
 * @param height the height of the picture
 
3264
 * @return zero if successful, a negative value if not
 
3265
 */
 
3266
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
 
3267
 
 
3268
/**
 
3269
 * Free a picture previously allocated by avpicture_alloc().
 
3270
 * The data buffer used by the AVPicture is freed, but the AVPicture structure
 
3271
 * itself is not.
 
3272
 *
 
3273
 * @param picture the AVPicture to be freed
 
3274
 */
 
3275
void avpicture_free(AVPicture *picture);
 
3276
 
 
3277
/**
 
3278
 * Fill in the AVPicture fields.
 
3279
 * The fields of the given AVPicture are filled in by using the 'ptr' address
 
3280
 * which points to the image data buffer. Depending on the specified picture
 
3281
 * format, one or multiple image data pointers and line sizes will be set.
 
3282
 * If a planar format is specified, several pointers will be set pointing to
 
3283
 * the different picture planes and the line sizes of the different planes
 
3284
 * will be stored in the lines_sizes array.
 
3285
 * Call with ptr == NULL to get the required size for the ptr buffer.
 
3286
 *
 
3287
 * To allocate the buffer and fill in the AVPicture fields in one call,
 
3288
 * use avpicture_alloc().
 
3289
 *
 
3290
 * @param picture AVPicture whose fields are to be filled in
 
3291
 * @param ptr Buffer which will contain or contains the actual image data
 
3292
 * @param pix_fmt The format in which the picture data is stored.
 
3293
 * @param width the width of the image in pixels
 
3294
 * @param height the height of the image in pixels
 
3295
 * @return size of the image data in bytes
 
3296
 */
 
3297
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
 
3298
                   enum PixelFormat pix_fmt, int width, int height);
 
3299
 
 
3300
/**
 
3301
 * Copy pixel data from an AVPicture into a buffer.
 
3302
 * The data is stored compactly, without any gaps for alignment or padding
 
3303
 * which may be applied by avpicture_fill().
 
3304
 *
 
3305
 * \see avpicture_get_size()
 
3306
 *
 
3307
 * @param[in] src AVPicture containing image data
 
3308
 * @param[in] pix_fmt The format in which the picture data is stored.
 
3309
 * @param[in] width the width of the image in pixels.
 
3310
 * @param[in] height the height of the image in pixels.
 
3311
 * @param[out] dest A buffer into which picture data will be copied.
 
3312
 * @param[in] dest_size The size of 'dest'.
 
3313
 * @return The number of bytes written to dest, or a negative value (error code) on error.
 
3314
 */
 
3315
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
 
3316
                     unsigned char *dest, int dest_size);
 
3317
 
 
3318
/**
 
3319
 * Calculate the size in bytes that a picture of the given width and height
 
3320
 * would occupy if stored in the given picture format.
 
3321
 * Note that this returns the size of a compact representation as generated
 
3322
 * by avpicture_layout(), which can be smaller than the size required for e.g.
 
3323
 * avpicture_fill().
 
3324
 *
 
3325
 * @param pix_fmt the given picture format
 
3326
 * @param width the width of the image
 
3327
 * @param height the height of the image
 
3328
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
 
3329
 */
 
3330
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
 
3331
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
 
3332
 
 
3333
#if FF_API_GET_PIX_FMT_NAME
 
3334
/**
 
3335
 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
 
3336
 */
 
3337
attribute_deprecated
 
3338
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
 
3339
#endif
 
3340
 
 
3341
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
 
3342
 
 
3343
/**
 
3344
 * Return a value representing the fourCC code associated to the
 
3345
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
 
3346
 * found.
 
3347
 */
 
3348
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
 
3349
 
 
3350
/**
 
3351
 * Put a string representing the codec tag codec_tag in buf.
 
3352
 *
 
3353
 * @param buf_size size in bytes of buf
 
3354
 * @return the length of the string that would have been generated if
 
3355
 * enough space had been available, excluding the trailing null
 
3356
 */
 
3357
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
 
3358
 
 
3359
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
 
3360
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
 
3361
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
 
3362
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
 
3363
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
 
3364
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
 
3365
 
 
3366
/**
 
3367
 * Compute what kind of losses will occur when converting from one specific
 
3368
 * pixel format to another.
 
3369
 * When converting from one pixel format to another, information loss may occur.
 
3370
 * For example, when converting from RGB24 to GRAY, the color information will
 
3371
 * be lost. Similarly, other losses occur when converting from some formats to
 
3372
 * other formats. These losses can involve loss of chroma, but also loss of
 
3373
 * resolution, loss of color depth, loss due to the color space conversion, loss
 
3374
 * of the alpha bits or loss due to color quantization.
 
3375
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
 
3376
 * which will occur when converting from one pixel format to another.
 
3377
 *
 
3378
 * @param[in] dst_pix_fmt destination pixel format
 
3379
 * @param[in] src_pix_fmt source pixel format
 
3380
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 
3381
 * @return Combination of flags informing you what kind of losses will occur.
 
3382
 */
 
3383
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
 
3384
                             int has_alpha);
 
3385
 
 
3386
/**
 
3387
 * Find the best pixel format to convert to given a certain source pixel
 
3388
 * format.  When converting from one pixel format to another, information loss
 
3389
 * may occur.  For example, when converting from RGB24 to GRAY, the color
 
3390
 * information will be lost. Similarly, other losses occur when converting from
 
3391
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
 
3392
 * the given pixel formats should be used to suffer the least amount of loss.
 
3393
 * The pixel formats from which it chooses one, are determined by the
 
3394
 * pix_fmt_mask parameter.
 
3395
 *
 
3396
 * @code
 
3397
 * src_pix_fmt = PIX_FMT_YUV420P;
 
3398
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
 
3399
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
 
3400
 * @endcode
 
3401
 *
 
3402
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
 
3403
 * @param[in] src_pix_fmt source pixel format
 
3404
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
 
3405
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
 
3406
 * @return The best pixel format to convert to or -1 if none was found.
 
3407
 */
 
3408
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
 
3409
                              int has_alpha, int *loss_ptr);
 
3410
 
 
3411
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
 
3412
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
 
3413
 
 
3414
/**
 
3415
 * Tell if an image really has transparent alpha values.
 
3416
 * @return ored mask of FF_ALPHA_xxx constants
 
3417
 */
 
3418
int img_get_alpha_info(const AVPicture *src,
 
3419
                       enum PixelFormat pix_fmt, int width, int height);
 
3420
 
 
3421
/* deinterlace a picture */
 
3422
/* deinterlace - if not supported return -1 */
 
3423
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
 
3424
                          enum PixelFormat pix_fmt, int width, int height);
 
3425
 
 
3426
/* external high level API */
 
3427
 
 
3428
/**
 
3429
 * If c is NULL, returns the first registered codec,
 
3430
 * if c is non-NULL, returns the next registered codec after c,
 
3431
 * or NULL if c is the last one.
 
3432
 */
 
3433
AVCodec *av_codec_next(AVCodec *c);
 
3434
 
 
3435
/**
 
3436
 * Return the LIBAVCODEC_VERSION_INT constant.
 
3437
 */
 
3438
unsigned avcodec_version(void);
 
3439
 
 
3440
/**
 
3441
 * Return the libavcodec build-time configuration.
 
3442
 */
 
3443
const char *avcodec_configuration(void);
 
3444
 
 
3445
/**
 
3446
 * Return the libavcodec license.
 
3447
 */
 
3448
const char *avcodec_license(void);
 
3449
 
 
3450
/**
 
3451
 * Initialize libavcodec.
 
3452
 * If called more than once, does nothing.
 
3453
 *
 
3454
 * @warning This function must be called before any other libavcodec
 
3455
 * function.
 
3456
 *
 
3457
 * @warning This function is not thread-safe.
 
3458
 */
 
3459
void avcodec_init(void);
 
3460
 
 
3461
/**
 
3462
 * Register the codec codec and initialize libavcodec.
 
3463
 *
 
3464
 * @see avcodec_init(), avcodec_register_all()
 
3465
 */
 
3466
void avcodec_register(AVCodec *codec);
 
3467
 
 
3468
/**
 
3469
 * Find a registered encoder with a matching codec ID.
 
3470
 *
 
3471
 * @param id CodecID of the requested encoder
 
3472
 * @return An encoder if one was found, NULL otherwise.
 
3473
 */
 
3474
AVCodec *avcodec_find_encoder(enum CodecID id);
 
3475
 
 
3476
/**
 
3477
 * Find a registered encoder with the specified name.
 
3478
 *
 
3479
 * @param name name of the requested encoder
 
3480
 * @return An encoder if one was found, NULL otherwise.
 
3481
 */
 
3482
AVCodec *avcodec_find_encoder_by_name(const char *name);
 
3483
 
 
3484
/**
 
3485
 * Find a registered decoder with a matching codec ID.
 
3486
 *
 
3487
 * @param id CodecID of the requested decoder
 
3488
 * @return A decoder if one was found, NULL otherwise.
 
3489
 */
 
3490
AVCodec *avcodec_find_decoder(enum CodecID id);
 
3491
 
 
3492
/**
 
3493
 * Find a registered decoder with the specified name.
 
3494
 *
 
3495
 * @param name name of the requested decoder
 
3496
 * @return A decoder if one was found, NULL otherwise.
 
3497
 */
 
3498
AVCodec *avcodec_find_decoder_by_name(const char *name);
 
3499
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
 
3500
 
 
3501
/**
 
3502
 * Return a name for the specified profile, if available.
 
3503
 *
 
3504
 * @param codec the codec that is searched for the given profile
 
3505
 * @param profile the profile value for which a name is requested
 
3506
 * @return A name for the profile if found, NULL otherwise.
 
3507
 */
 
3508
const char *av_get_profile_name(const AVCodec *codec, int profile);
 
3509
 
 
3510
/**
 
3511
 * Set the fields of the given AVCodecContext to default values.
 
3512
 *
 
3513
 * @param s The AVCodecContext of which the fields should be set to default values.
 
3514
 */
 
3515
void avcodec_get_context_defaults(AVCodecContext *s);
 
3516
 
 
3517
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 
3518
 *  we WILL change its arguments and name a few times! */
 
3519
void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
 
3520
 
 
3521
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 
3522
 *  we WILL change its arguments and name a few times! */
 
3523
int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
 
3524
 
 
3525
/**
 
3526
 * Allocate an AVCodecContext and set its fields to default values.  The
 
3527
 * resulting struct can be deallocated by simply calling av_free().
 
3528
 *
 
3529
 * @return An AVCodecContext filled with default values or NULL on failure.
 
3530
 * @see avcodec_get_context_defaults
 
3531
 */
 
3532
AVCodecContext *avcodec_alloc_context(void);
 
3533
 
 
3534
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 
3535
 *  we WILL change its arguments and name a few times! */
 
3536
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
 
3537
 
 
3538
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
 
3539
 *  we WILL change its arguments and name a few times! */
 
3540
AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
 
3541
 
 
3542
/**
 
3543
 * Copy the settings of the source AVCodecContext into the destination
 
3544
 * AVCodecContext. The resulting destination codec context will be
 
3545
 * unopened, i.e. you are required to call avcodec_open() before you
 
3546
 * can use this AVCodecContext to decode/encode video/audio data.
 
3547
 *
 
3548
 * @param dest target codec context, should be initialized with
 
3549
 *             avcodec_alloc_context(), but otherwise uninitialized
 
3550
 * @param src source codec context
 
3551
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
 
3552
 */
 
3553
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
 
3554
 
 
3555
/**
 
3556
 * Set the fields of the given AVFrame to default values.
 
3557
 *
 
3558
 * @param pic The AVFrame of which the fields should be set to default values.
 
3559
 */
 
3560
void avcodec_get_frame_defaults(AVFrame *pic);
 
3561
 
 
3562
/**
 
3563
 * Allocate an AVFrame and set its fields to default values.  The resulting
 
3564
 * struct can be deallocated by simply calling av_free().
 
3565
 *
 
3566
 * @return An AVFrame filled with default values or NULL on failure.
 
3567
 * @see avcodec_get_frame_defaults
 
3568
 */
 
3569
AVFrame *avcodec_alloc_frame(void);
 
3570
 
 
3571
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
 
3572
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
 
3573
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
 
3574
 
 
3575
/**
 
3576
 * Return the amount of padding in pixels which the get_buffer callback must
 
3577
 * provide around the edge of the image for codecs which do not have the
 
3578
 * CODEC_FLAG_EMU_EDGE flag.
 
3579
 *
 
3580
 * @return Required padding in pixels.
 
3581
 */
 
3582
unsigned avcodec_get_edge_width(void);
 
3583
/**
 
3584
 * Modify width and height values so that they will result in a memory
 
3585
 * buffer that is acceptable for the codec if you do not use any horizontal
 
3586
 * padding.
 
3587
 *
 
3588
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
 
3589
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
 
3590
 * according to avcodec_get_edge_width() before.
 
3591
 */
 
3592
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
 
3593
/**
 
3594
 * Modify width and height values so that they will result in a memory
 
3595
 * buffer that is acceptable for the codec if you also ensure that all
 
3596
 * line sizes are a multiple of the respective linesize_align[i].
 
3597
 *
 
3598
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
 
3599
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
 
3600
 * according to avcodec_get_edge_width() before.
 
3601
 */
 
3602
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
 
3603
                               int linesize_align[4]);
 
3604
 
 
3605
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
 
3606
 
 
3607
#if FF_API_THREAD_INIT
 
3608
/**
 
3609
 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
 
3610
 */
 
3611
attribute_deprecated
 
3612
int avcodec_thread_init(AVCodecContext *s, int thread_count);
 
3613
#endif
 
3614
 
 
3615
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
 
3616
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
 
3617
//FIXME func typedef
 
3618
 
 
3619
/**
 
3620
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
 
3621
 * function the context has to be allocated.
 
3622
 *
 
3623
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
 
3624
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
 
3625
 * retrieving a codec.
 
3626
 *
 
3627
 * @warning This function is not thread safe!
 
3628
 *
 
3629
 * @code
 
3630
 * avcodec_register_all();
 
3631
 * codec = avcodec_find_decoder(CODEC_ID_H264);
 
3632
 * if (!codec)
 
3633
 *     exit(1);
 
3634
 *
 
3635
 * context = avcodec_alloc_context();
 
3636
 *
 
3637
 * if (avcodec_open(context, codec) < 0)
 
3638
 *     exit(1);
 
3639
 * @endcode
 
3640
 *
 
3641
 * @param avctx The context which will be set up to use the given codec.
 
3642
 * @param codec The codec to use within the context.
 
3643
 * @return zero on success, a negative value on error
 
3644
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
 
3645
 */
 
3646
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
 
3647
 
 
3648
/**
 
3649
 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
 
3650
 * Some decoders may support multiple frames in a single AVPacket, such
 
3651
 * decoders would then just decode the first frame. In this case,
 
3652
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
 
3653
 * the remaining data in order to decode the second frame etc.
 
3654
 * If no frame
 
3655
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
 
3656
 * decompressed frame size in bytes.
 
3657
 *
 
3658
 * @warning You must set frame_size_ptr to the allocated size of the
 
3659
 * output buffer before calling avcodec_decode_audio3().
 
3660
 *
 
3661
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
 
3662
 * the actual read bytes because some optimized bitstream readers read 32 or 64
 
3663
 * bits at once and could read over the end.
 
3664
 *
 
3665
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
 
3666
 * no overreading happens for damaged MPEG streams.
 
3667
 *
 
3668
 * @note You might have to align the input buffer avpkt->data and output buffer
 
3669
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
 
3670
 * necessary at all, on others it won't work at all if not aligned and on others
 
3671
 * it will work but it will have an impact on performance.
 
3672
 *
 
3673
 * In practice, avpkt->data should have 4 byte alignment at minimum and
 
3674
 * samples should be 16 byte aligned unless the CPU doesn't need it
 
3675
 * (AltiVec and SSE do).
 
3676
 *
 
3677
 * @param avctx the codec context
 
3678
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
 
3679
 * @param[in,out] frame_size_ptr the output buffer size in bytes
 
3680
 * @param[in] avpkt The input AVPacket containing the input buffer.
 
3681
 *            You can create such packet with av_init_packet() and by then setting
 
3682
 *            data and size, some decoders might in addition need other fields.
 
3683
 *            All decoders are designed to use the least fields possible though.
 
3684
 * @return On error a negative value is returned, otherwise the number of bytes
 
3685
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
 
3686
 */
 
3687
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
 
3688
                         int *frame_size_ptr,
 
3689
                         AVPacket *avpkt);
 
3690
 
 
3691
/**
 
3692
 * Decode the video frame of size avpkt->size from avpkt->data into picture.
 
3693
 * Some decoders may support multiple frames in a single AVPacket, such
 
3694
 * decoders would then just decode the first frame.
 
3695
 *
 
3696
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
 
3697
 * the actual read bytes because some optimized bitstream readers read 32 or 64
 
3698
 * bits at once and could read over the end.
 
3699
 *
 
3700
 * @warning The end of the input buffer buf should be set to 0 to ensure that
 
3701
 * no overreading happens for damaged MPEG streams.
 
3702
 *
 
3703
 * @note You might have to align the input buffer avpkt->data.
 
3704
 * The alignment requirements depend on the CPU: on some CPUs it isn't
 
3705
 * necessary at all, on others it won't work at all if not aligned and on others
 
3706
 * it will work but it will have an impact on performance.
 
3707
 *
 
3708
 * In practice, avpkt->data should have 4 byte alignment at minimum.
 
3709
 *
 
3710
 * @note Some codecs have a delay between input and output, these need to be
 
3711
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
 
3712
 *
 
3713
 * @param avctx the codec context
 
3714
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
 
3715
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
 
3716
 *             allocate memory for the actual bitmap.
 
3717
 *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
 
3718
 *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
 
3719
 *                   decodes and the decoder tells the user once it does not need the data anymore,
 
3720
 *                   the user app can at this point free/reuse/keep the memory as it sees fit.
 
3721
 *
 
3722
 * @param[in] avpkt The input AVpacket containing the input buffer.
 
3723
 *            You can create such packet with av_init_packet() and by then setting
 
3724
 *            data and size, some decoders might in addition need other fields like
 
3725
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
 
3726
 *            fields possible.
 
3727
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
 
3728
 * @return On error a negative value is returned, otherwise the number of bytes
 
3729
 * used or zero if no frame could be decompressed.
 
3730
 */
 
3731
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
 
3732
                         int *got_picture_ptr,
 
3733
                         AVPacket *avpkt);
 
3734
 
 
3735
/**
 
3736
 * Decode a subtitle message.
 
3737
 * Return a negative value on error, otherwise return the number of bytes used.
 
3738
 * If no subtitle could be decompressed, got_sub_ptr is zero.
 
3739
 * Otherwise, the subtitle is stored in *sub.
 
3740
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
 
3741
 * simplicity, because the performance difference is expect to be negligible
 
3742
 * and reusing a get_buffer written for video codecs would probably perform badly
 
3743
 * due to a potentially very different allocation pattern.
 
3744
 *
 
3745
 * @param avctx the codec context
 
3746
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
 
3747
                   freed with avsubtitle_free if *got_sub_ptr is set.
 
3748
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
 
3749
 * @param[in] avpkt The input AVPacket containing the input buffer.
 
3750
 */
 
3751
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
 
3752
                            int *got_sub_ptr,
 
3753
                            AVPacket *avpkt);
 
3754
 
 
3755
/**
 
3756
 * Frees all allocated data in the given subtitle struct.
 
3757
 *
 
3758
 * @param sub AVSubtitle to free.
 
3759
 */
 
3760
void avsubtitle_free(AVSubtitle *sub);
 
3761
 
 
3762
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
 
3763
                        int *data_size_ptr,
 
3764
                        uint8_t *buf, int buf_size);
 
3765
 
 
3766
/**
 
3767
 * Encode an audio frame from samples into buf.
 
3768
 *
 
3769
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
 
3770
 * However, for PCM audio the user will know how much space is needed
 
3771
 * because it depends on the value passed in buf_size as described
 
3772
 * below. In that case a lower value can be used.
 
3773
 *
 
3774
 * @param avctx the codec context
 
3775
 * @param[out] buf the output buffer
 
3776
 * @param[in] buf_size the output buffer size
 
3777
 * @param[in] samples the input buffer containing the samples
 
3778
 * The number of samples read from this buffer is frame_size*channels,
 
3779
 * both of which are defined in avctx.
 
3780
 * For PCM audio the number of samples read from samples is equal to
 
3781
 * buf_size * input_sample_size / output_sample_size.
 
3782
 * @return On error a negative value is returned, on success zero or the number
 
3783
 * of bytes used to encode the data read from the input buffer.
 
3784
 */
 
3785
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
 
3786
                         const short *samples);
 
3787
 
 
3788
/**
 
3789
 * Encode a video frame from pict into buf.
 
3790
 * The input picture should be
 
3791
 * stored using a specific format, namely avctx.pix_fmt.
 
3792
 *
 
3793
 * @param avctx the codec context
 
3794
 * @param[out] buf the output buffer for the bitstream of encoded frame
 
3795
 * @param[in] buf_size the size of the output buffer in bytes
 
3796
 * @param[in] pict the input picture to encode
 
3797
 * @return On error a negative value is returned, on success zero or the number
 
3798
 * of bytes used from the output buffer.
 
3799
 */
 
3800
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
 
3801
                         const AVFrame *pict);
 
3802
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
 
3803
                            const AVSubtitle *sub);
 
3804
 
 
3805
int avcodec_close(AVCodecContext *avctx);
 
3806
 
 
3807
/**
 
3808
 * Register all the codecs, parsers and bitstream filters which were enabled at
 
3809
 * configuration time. If you do not call this function you can select exactly
 
3810
 * which formats you want to support, by using the individual registration
 
3811
 * functions.
 
3812
 *
 
3813
 * @see avcodec_register
 
3814
 * @see av_register_codec_parser
 
3815
 * @see av_register_bitstream_filter
 
3816
 */
 
3817
void avcodec_register_all(void);
 
3818
 
 
3819
/**
 
3820
 * Flush buffers, should be called when seeking or when switching to a different stream.
 
3821
 */
 
3822
void avcodec_flush_buffers(AVCodecContext *avctx);
 
3823
 
 
3824
void avcodec_default_free_buffers(AVCodecContext *s);
 
3825
 
 
3826
/* misc useful functions */
 
3827
 
 
3828
#if FF_API_OLD_FF_PICT_TYPES
 
3829
/**
 
3830
 * Return a single letter to describe the given picture type pict_type.
 
3831
 *
 
3832
 * @param[in] pict_type the picture type
 
3833
 * @return A single character representing the picture type.
 
3834
 * @deprecated Use av_get_picture_type_char() instead.
 
3835
 */
 
3836
attribute_deprecated
 
3837
char av_get_pict_type_char(int pict_type);
 
3838
#endif
 
3839
 
 
3840
/**
 
3841
 * Return codec bits per sample.
 
3842
 *
 
3843
 * @param[in] codec_id the codec
 
3844
 * @return Number of bits per sample or zero if unknown for the given codec.
 
3845
 */
 
3846
int av_get_bits_per_sample(enum CodecID codec_id);
 
3847
 
 
3848
#if FF_API_OLD_SAMPLE_FMT
 
3849
/**
 
3850
 * @deprecated Use av_get_bytes_per_sample() instead.
 
3851
 */
 
3852
attribute_deprecated
 
3853
int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
 
3854
#endif
 
3855
 
 
3856
/* frame parsing */
 
3857
typedef struct AVCodecParserContext {
 
3858
    void *priv_data;
 
3859
    struct AVCodecParser *parser;
 
3860
    int64_t frame_offset; /* offset of the current frame */
 
3861
    int64_t cur_offset; /* current offset
 
3862
                           (incremented by each av_parser_parse()) */
 
3863
    int64_t next_frame_offset; /* offset of the next frame */
 
3864
    /* video info */
 
3865
    int pict_type; /* XXX: Put it back in AVCodecContext. */
 
3866
    /**
 
3867
     * This field is used for proper frame duration computation in lavf.
 
3868
     * It signals, how much longer the frame duration of the current frame
 
3869
     * is compared to normal frame duration.
 
3870
     *
 
3871
     * frame_duration = (1 + repeat_pict) * time_base
 
3872
     *
 
3873
     * It is used by codecs like H.264 to display telecined material.
 
3874
     */
 
3875
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
 
3876
    int64_t pts;     /* pts of the current frame */
 
3877
    int64_t dts;     /* dts of the current frame */
 
3878
 
 
3879
    /* private data */
 
3880
    int64_t last_pts;
 
3881
    int64_t last_dts;
 
3882
    int fetch_timestamp;
 
3883
 
 
3884
#define AV_PARSER_PTS_NB 4
 
3885
    int cur_frame_start_index;
 
3886
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
 
3887
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
 
3888
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
 
3889
 
 
3890
    int flags;
 
3891
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
 
3892
#define PARSER_FLAG_ONCE                      0x0002
 
3893
/// Set if the parser has a valid file offset
 
3894
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
 
3895
 
 
3896
    int64_t offset;      ///< byte offset from starting packet start
 
3897
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
 
3898
 
 
3899
    /*!
 
3900
     * Set by parser to 1 for key frames and 0 for non-key frames.
 
3901
     * It is initialized to -1, so if the parser doesn't set this flag,
 
3902
     * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
 
3903
     * will be used.
 
3904
     */
 
3905
    int key_frame;
 
3906
 
 
3907
    /**
 
3908
     * Time difference in stream time base units from the pts of this
 
3909
     * packet to the point at which the output from the decoder has converged
 
3910
     * independent from the availability of previous frames. That is, the
 
3911
     * frames are virtually identical no matter if decoding started from
 
3912
     * the very first frame or from this keyframe.
 
3913
     * Is AV_NOPTS_VALUE if unknown.
 
3914
     * This field is not the display duration of the current frame.
 
3915
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
 
3916
     * set.
 
3917
     *
 
3918
     * The purpose of this field is to allow seeking in streams that have no
 
3919
     * keyframes in the conventional sense. It corresponds to the
 
3920
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
 
3921
     * essential for some types of subtitle streams to ensure that all
 
3922
     * subtitles are correctly displayed after seeking.
 
3923
     */
 
3924
    int64_t convergence_duration;
 
3925
 
 
3926
    // Timestamp generation support:
 
3927
    /**
 
3928
     * Synchronization point for start of timestamp generation.
 
3929
     *
 
3930
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
 
3931
     * (default).
 
3932
     *
 
3933
     * For example, this corresponds to presence of H.264 buffering period
 
3934
     * SEI message.
 
3935
     */
 
3936
    int dts_sync_point;
 
3937
 
 
3938
    /**
 
3939
     * Offset of the current timestamp against last timestamp sync point in
 
3940
     * units of AVCodecContext.time_base.
 
3941
     *
 
3942
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
 
3943
     * contain a valid timestamp offset.
 
3944
     *
 
3945
     * Note that the timestamp of sync point has usually a nonzero
 
3946
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
 
3947
     * the next frame after timestamp sync point will be usually 1.
 
3948
     *
 
3949
     * For example, this corresponds to H.264 cpb_removal_delay.
 
3950
     */
 
3951
    int dts_ref_dts_delta;
 
3952
 
 
3953
    /**
 
3954
     * Presentation delay of current frame in units of AVCodecContext.time_base.
 
3955
     *
 
3956
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
 
3957
     * contain valid non-negative timestamp delta (presentation time of a frame
 
3958
     * must not lie in the past).
 
3959
     *
 
3960
     * This delay represents the difference between decoding and presentation
 
3961
     * time of the frame.
 
3962
     *
 
3963
     * For example, this corresponds to H.264 dpb_output_delay.
 
3964
     */
 
3965
    int pts_dts_delta;
 
3966
 
 
3967
    /**
 
3968
     * Position of the packet in file.
 
3969
     *
 
3970
     * Analogous to cur_frame_pts/dts
 
3971
     */
 
3972
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
 
3973
 
 
3974
    /**
 
3975
     * Byte position of currently parsed frame in stream.
 
3976
     */
 
3977
    int64_t pos;
 
3978
 
 
3979
    /**
 
3980
     * Previous frame byte position.
 
3981
     */
 
3982
    int64_t last_pos;
 
3983
} AVCodecParserContext;
 
3984
 
 
3985
typedef struct AVCodecParser {
 
3986
    int codec_ids[5]; /* several codec IDs are permitted */
 
3987
    int priv_data_size;
 
3988
    int (*parser_init)(AVCodecParserContext *s);
 
3989
    int (*parser_parse)(AVCodecParserContext *s,
 
3990
                        AVCodecContext *avctx,
 
3991
                        const uint8_t **poutbuf, int *poutbuf_size,
 
3992
                        const uint8_t *buf, int buf_size);
 
3993
    void (*parser_close)(AVCodecParserContext *s);
 
3994
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
 
3995
    struct AVCodecParser *next;
 
3996
} AVCodecParser;
 
3997
 
 
3998
AVCodecParser *av_parser_next(AVCodecParser *c);
 
3999
 
 
4000
void av_register_codec_parser(AVCodecParser *parser);
 
4001
AVCodecParserContext *av_parser_init(int codec_id);
 
4002
 
 
4003
/**
 
4004
 * Parse a packet.
 
4005
 *
 
4006
 * @param s             parser context.
 
4007
 * @param avctx         codec context.
 
4008
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
 
4009
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
 
4010
 * @param buf           input buffer.
 
4011
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
 
4012
 * @param pts           input presentation timestamp.
 
4013
 * @param dts           input decoding timestamp.
 
4014
 * @param pos           input byte position in stream.
 
4015
 * @return the number of bytes of the input bitstream used.
 
4016
 *
 
4017
 * Example:
 
4018
 * @code
 
4019
 *   while(in_len){
 
4020
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
 
4021
 *                                        in_data, in_len,
 
4022
 *                                        pts, dts, pos);
 
4023
 *       in_data += len;
 
4024
 *       in_len  -= len;
 
4025
 *
 
4026
 *       if(size)
 
4027
 *          decode_frame(data, size);
 
4028
 *   }
 
4029
 * @endcode
 
4030
 */
 
4031
int av_parser_parse2(AVCodecParserContext *s,
 
4032
                     AVCodecContext *avctx,
 
4033
                     uint8_t **poutbuf, int *poutbuf_size,
 
4034
                     const uint8_t *buf, int buf_size,
 
4035
                     int64_t pts, int64_t dts,
 
4036
                     int64_t pos);
 
4037
 
 
4038
int av_parser_change(AVCodecParserContext *s,
 
4039
                     AVCodecContext *avctx,
 
4040
                     uint8_t **poutbuf, int *poutbuf_size,
 
4041
                     const uint8_t *buf, int buf_size, int keyframe);
 
4042
void av_parser_close(AVCodecParserContext *s);
 
4043
 
 
4044
 
 
4045
typedef struct AVBitStreamFilterContext {
 
4046
    void *priv_data;
 
4047
    struct AVBitStreamFilter *filter;
 
4048
    AVCodecParserContext *parser;
 
4049
    struct AVBitStreamFilterContext *next;
 
4050
} AVBitStreamFilterContext;
 
4051
 
 
4052
 
 
4053
typedef struct AVBitStreamFilter {
 
4054
    const char *name;
 
4055
    int priv_data_size;
 
4056
    int (*filter)(AVBitStreamFilterContext *bsfc,
 
4057
                  AVCodecContext *avctx, const char *args,
 
4058
                  uint8_t **poutbuf, int *poutbuf_size,
 
4059
                  const uint8_t *buf, int buf_size, int keyframe);
 
4060
    void (*close)(AVBitStreamFilterContext *bsfc);
 
4061
    struct AVBitStreamFilter *next;
 
4062
} AVBitStreamFilter;
 
4063
 
 
4064
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
 
4065
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
 
4066
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
 
4067
                               AVCodecContext *avctx, const char *args,
 
4068
                               uint8_t **poutbuf, int *poutbuf_size,
 
4069
                               const uint8_t *buf, int buf_size, int keyframe);
 
4070
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
 
4071
 
 
4072
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
 
4073
 
 
4074
/* memory */
 
4075
 
 
4076
/**
 
4077
 * Reallocate the given block if it is not large enough, otherwise do nothing.
 
4078
 *
 
4079
 * @see av_realloc
 
4080
 */
 
4081
void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
 
4082
 
 
4083
/**
 
4084
 * Allocate a buffer, reusing the given one if large enough.
 
4085
 *
 
4086
 * Contrary to av_fast_realloc the current buffer contents might not be
 
4087
 * preserved and on error the old buffer is freed, thus no special
 
4088
 * handling to avoid memleaks is necessary.
 
4089
 *
 
4090
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
 
4091
 * @param size size of the buffer *ptr points to
 
4092
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
 
4093
 *                 *size 0 if an error occurred.
 
4094
 */
 
4095
void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
 
4096
 
 
4097
/**
 
4098
 * Copy image src to dst. Wraps av_picture_data_copy() above.
 
4099
 */
 
4100
void av_picture_copy(AVPicture *dst, const AVPicture *src,
 
4101
                     enum PixelFormat pix_fmt, int width, int height);
 
4102
 
 
4103
/**
 
4104
 * Crop image top and left side.
 
4105
 */
 
4106
int av_picture_crop(AVPicture *dst, const AVPicture *src,
 
4107
                    enum PixelFormat pix_fmt, int top_band, int left_band);
 
4108
 
 
4109
/**
 
4110
 * Pad image.
 
4111
 */
 
4112
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
 
4113
            int padtop, int padbottom, int padleft, int padright, int *color);
 
4114
 
 
4115
/**
 
4116
 * Encode extradata length to a buffer. Used by xiph codecs.
 
4117
 *
 
4118
 * @param s buffer to write to; must be at least (v/255+1) bytes long
 
4119
 * @param v size of extradata in bytes
 
4120
 * @return number of bytes written to the buffer.
 
4121
 */
 
4122
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
 
4123
 
 
4124
/**
 
4125
 * Logs a generic warning message about a missing feature. This function is
 
4126
 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
 
4127
 * only, and would normally not be used by applications.
 
4128
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
 
4129
 * a pointer to an AVClass struct
 
4130
 * @param[in] feature string containing the name of the missing feature
 
4131
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
 
4132
 * If want_sample is non-zero, additional verbage will be added to the log
 
4133
 * message which tells the user how to report samples to the development
 
4134
 * mailing list.
 
4135
 */
 
4136
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
 
4137
 
 
4138
/**
 
4139
 * Log a generic warning message asking for a sample. This function is
 
4140
 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
 
4141
 * only, and would normally not be used by applications.
 
4142
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
 
4143
 * a pointer to an AVClass struct
 
4144
 * @param[in] msg string containing an optional message, or NULL if no message
 
4145
 */
 
4146
void av_log_ask_for_sample(void *avc, const char *msg, ...);
 
4147
 
 
4148
/**
 
4149
 * Register the hardware accelerator hwaccel.
 
4150
 */
 
4151
void av_register_hwaccel(AVHWAccel *hwaccel);
 
4152
 
 
4153
/**
 
4154
 * If hwaccel is NULL, returns the first registered hardware accelerator,
 
4155
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
 
4156
 * after hwaccel, or NULL if hwaccel is the last one.
 
4157
 */
 
4158
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
 
4159
 
 
4160
 
 
4161
/**
 
4162
 * Lock operation used by lockmgr
 
4163
 */
 
4164
enum AVLockOp {
 
4165
  AV_LOCK_CREATE,  ///< Create a mutex
 
4166
  AV_LOCK_OBTAIN,  ///< Lock the mutex
 
4167
  AV_LOCK_RELEASE, ///< Unlock the mutex
 
4168
  AV_LOCK_DESTROY, ///< Free mutex resources
 
4169
};
 
4170
 
 
4171
/**
 
4172
 * Register a user provided lock manager supporting the operations
 
4173
 * specified by AVLockOp. mutex points to a (void *) where the
 
4174
 * lockmgr should store/get a pointer to a user allocated mutex. It's
 
4175
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
 
4176
 *
 
4177
 * @param cb User defined callback. Note: Libav may invoke calls to this
 
4178
 *           callback during the call to av_lockmgr_register().
 
4179
 *           Thus, the application must be prepared to handle that.
 
4180
 *           If cb is set to NULL the lockmgr will be unregistered.
 
4181
 *           Also note that during unregistration the previously registered
 
4182
 *           lockmgr callback may also be invoked.
 
4183
 */
 
4184
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
 
4185
 
 
4186
#endif /* AVCODEC_AVCODEC_H */