Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ f5b82f45

History | View | Annotate | Download (135 KB)

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

    
21
#ifndef AVCODEC_AVCODEC_H
22
#define AVCODEC_AVCODEC_H
23

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

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

    
34
#define LIBAVCODEC_VERSION_MAJOR 52
35
#define LIBAVCODEC_VERSION_MINOR 109
36
#define LIBAVCODEC_VERSION_MICRO  0
37

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

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

    
48
/**
49
 * Those FF_API_* defines are not part of public API.
50
 * They may change, break or disappear at any time.
51
 */
52
#ifndef FF_API_PALETTE_CONTROL
53
#define FF_API_PALETTE_CONTROL  (LIBAVCODEC_VERSION_MAJOR < 54)
54
#endif
55
#ifndef FF_API_MM_FLAGS
56
#define FF_API_MM_FLAGS         (LIBAVCODEC_VERSION_MAJOR < 53)
57
#endif
58
#ifndef FF_API_OPT_SHOW
59
#define FF_API_OPT_SHOW         (LIBAVCODEC_VERSION_MAJOR < 53)
60
#endif
61
#ifndef FF_API_AUDIO_OLD
62
#define FF_API_AUDIO_OLD        (LIBAVCODEC_VERSION_MAJOR < 53)
63
#endif
64
#ifndef FF_API_VIDEO_OLD
65
#define FF_API_VIDEO_OLD        (LIBAVCODEC_VERSION_MAJOR < 53)
66
#endif
67
#ifndef FF_API_SUBTITLE_OLD
68
#define FF_API_SUBTITLE_OLD     (LIBAVCODEC_VERSION_MAJOR < 53)
69
#endif
70
#ifndef FF_API_USE_LPC
71
#define FF_API_USE_LPC          (LIBAVCODEC_VERSION_MAJOR < 53)
72
#endif
73
#ifndef FF_API_SET_STRING_OLD
74
#define FF_API_SET_STRING_OLD   (LIBAVCODEC_VERSION_MAJOR < 53)
75
#endif
76
#ifndef FF_API_INOFFICIAL
77
#define FF_API_INOFFICIAL       (LIBAVCODEC_VERSION_MAJOR < 53)
78
#endif
79
#ifndef FF_API_OLD_SAMPLE_FMT
80
#define FF_API_OLD_SAMPLE_FMT   (LIBAVCODEC_VERSION_MAJOR < 53)
81
#endif
82
#ifndef FF_API_OLD_AUDIOCONVERT
83
#define FF_API_OLD_AUDIOCONVERT (LIBAVCODEC_VERSION_MAJOR < 53)
84
#endif
85

    
86
#if LIBAVCODEC_VERSION_MAJOR < 53
87
#   define FF_INTERNALC_MEM_TYPE unsigned int
88
#else
89
#   define FF_INTERNALC_MEM_TYPE size_t
90
#endif
91

    
92
/**
93
 * Identify the syntax and semantics of the bitstream.
94
 * The principle is roughly:
95
 * Two decoders with the same ID can decode the same streams.
96
 * Two encoders with the same ID can encode compatible streams.
97
 * There may be slight deviations from the principle due to implementation
98
 * details.
99
 *
100
 * If you add a codec ID to this list, add it so that
101
 * 1. no value of a existing codec ID changes (that would break ABI),
102
 * 2. it is as close as possible to similar codecs.
103
 */
104
enum CodecID {
105
    CODEC_ID_NONE,
106

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

    
265
    /* various PCM "codecs" */
266
    CODEC_ID_PCM_S16LE= 0x10000,
267
    CODEC_ID_PCM_S16BE,
268
    CODEC_ID_PCM_U16LE,
269
    CODEC_ID_PCM_U16BE,
270
    CODEC_ID_PCM_S8,
271
    CODEC_ID_PCM_U8,
272
    CODEC_ID_PCM_MULAW,
273
    CODEC_ID_PCM_ALAW,
274
    CODEC_ID_PCM_S32LE,
275
    CODEC_ID_PCM_S32BE,
276
    CODEC_ID_PCM_U32LE,
277
    CODEC_ID_PCM_U32BE,
278
    CODEC_ID_PCM_S24LE,
279
    CODEC_ID_PCM_S24BE,
280
    CODEC_ID_PCM_U24LE,
281
    CODEC_ID_PCM_U24BE,
282
    CODEC_ID_PCM_S24DAUD,
283
    CODEC_ID_PCM_ZORK,
284
    CODEC_ID_PCM_S16LE_PLANAR,
285
    CODEC_ID_PCM_DVD,
286
    CODEC_ID_PCM_F32BE,
287
    CODEC_ID_PCM_F32LE,
288
    CODEC_ID_PCM_F64BE,
289
    CODEC_ID_PCM_F64LE,
290
    CODEC_ID_PCM_BLURAY,
291
    CODEC_ID_PCM_LXF,
292

    
293
    /* various ADPCM codecs */
294
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
295
    CODEC_ID_ADPCM_IMA_WAV,
296
    CODEC_ID_ADPCM_IMA_DK3,
297
    CODEC_ID_ADPCM_IMA_DK4,
298
    CODEC_ID_ADPCM_IMA_WS,
299
    CODEC_ID_ADPCM_IMA_SMJPEG,
300
    CODEC_ID_ADPCM_MS,
301
    CODEC_ID_ADPCM_4XM,
302
    CODEC_ID_ADPCM_XA,
303
    CODEC_ID_ADPCM_ADX,
304
    CODEC_ID_ADPCM_EA,
305
    CODEC_ID_ADPCM_G726,
306
    CODEC_ID_ADPCM_CT,
307
    CODEC_ID_ADPCM_SWF,
308
    CODEC_ID_ADPCM_YAMAHA,
309
    CODEC_ID_ADPCM_SBPRO_4,
310
    CODEC_ID_ADPCM_SBPRO_3,
311
    CODEC_ID_ADPCM_SBPRO_2,
312
    CODEC_ID_ADPCM_THP,
313
    CODEC_ID_ADPCM_IMA_AMV,
314
    CODEC_ID_ADPCM_EA_R1,
315
    CODEC_ID_ADPCM_EA_R3,
316
    CODEC_ID_ADPCM_EA_R2,
317
    CODEC_ID_ADPCM_IMA_EA_SEAD,
318
    CODEC_ID_ADPCM_IMA_EA_EACS,
319
    CODEC_ID_ADPCM_EA_XAS,
320
    CODEC_ID_ADPCM_EA_MAXIS_XA,
321
    CODEC_ID_ADPCM_IMA_ISS,
322
    CODEC_ID_ADPCM_G722,
323

    
324
    /* AMR */
325
    CODEC_ID_AMR_NB= 0x12000,
326
    CODEC_ID_AMR_WB,
327

    
328
    /* RealAudio codecs*/
329
    CODEC_ID_RA_144= 0x13000,
330
    CODEC_ID_RA_288,
331

    
332
    /* various DPCM codecs */
333
    CODEC_ID_ROQ_DPCM= 0x14000,
334
    CODEC_ID_INTERPLAY_DPCM,
335
    CODEC_ID_XAN_DPCM,
336
    CODEC_ID_SOL_DPCM,
337

    
338
    /* audio codecs */
339
    CODEC_ID_MP2= 0x15000,
340
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
341
    CODEC_ID_AAC,
342
    CODEC_ID_AC3,
343
    CODEC_ID_DTS,
344
    CODEC_ID_VORBIS,
345
    CODEC_ID_DVAUDIO,
346
    CODEC_ID_WMAV1,
347
    CODEC_ID_WMAV2,
348
    CODEC_ID_MACE3,
349
    CODEC_ID_MACE6,
350
    CODEC_ID_VMDAUDIO,
351
    CODEC_ID_SONIC,
352
    CODEC_ID_SONIC_LS,
353
    CODEC_ID_FLAC,
354
    CODEC_ID_MP3ADU,
355
    CODEC_ID_MP3ON4,
356
    CODEC_ID_SHORTEN,
357
    CODEC_ID_ALAC,
358
    CODEC_ID_WESTWOOD_SND1,
359
    CODEC_ID_GSM, ///< as in Berlin toast format
360
    CODEC_ID_QDM2,
361
    CODEC_ID_COOK,
362
    CODEC_ID_TRUESPEECH,
363
    CODEC_ID_TTA,
364
    CODEC_ID_SMACKAUDIO,
365
    CODEC_ID_QCELP,
366
    CODEC_ID_WAVPACK,
367
    CODEC_ID_DSICINAUDIO,
368
    CODEC_ID_IMC,
369
    CODEC_ID_MUSEPACK7,
370
    CODEC_ID_MLP,
371
    CODEC_ID_GSM_MS, /* as found in WAV */
372
    CODEC_ID_ATRAC3,
373
    CODEC_ID_VOXWARE,
374
    CODEC_ID_APE,
375
    CODEC_ID_NELLYMOSER,
376
    CODEC_ID_MUSEPACK8,
377
    CODEC_ID_SPEEX,
378
    CODEC_ID_WMAVOICE,
379
    CODEC_ID_WMAPRO,
380
    CODEC_ID_WMALOSSLESS,
381
    CODEC_ID_ATRAC3P,
382
    CODEC_ID_EAC3,
383
    CODEC_ID_SIPR,
384
    CODEC_ID_MP1,
385
    CODEC_ID_TWINVQ,
386
    CODEC_ID_TRUEHD,
387
    CODEC_ID_MP4ALS,
388
    CODEC_ID_ATRAC1,
389
    CODEC_ID_BINKAUDIO_RDFT,
390
    CODEC_ID_BINKAUDIO_DCT,
391
    CODEC_ID_AAC_LATM,
392

    
393
    /* subtitle codecs */
394
    CODEC_ID_DVD_SUBTITLE= 0x17000,
395
    CODEC_ID_DVB_SUBTITLE,
396
    CODEC_ID_TEXT,  ///< raw UTF-8 text
397
    CODEC_ID_XSUB,
398
    CODEC_ID_SSA,
399
    CODEC_ID_MOV_TEXT,
400
    CODEC_ID_HDMV_PGS_SUBTITLE,
401
    CODEC_ID_DVB_TELETEXT,
402
    CODEC_ID_SRT,
403

    
404
    /* other specific kind of codecs (generally used for attachments) */
405
    CODEC_ID_TTF= 0x18000,
406

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

    
409
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
410
                                * stream (only used by libavformat) */
411
    CODEC_ID_FFMETADATA=0x21000,   ///< Dummy codec for streams containing only metadata information.
412
};
413

    
414
#if LIBAVCODEC_VERSION_MAJOR < 53
415
#define CodecType AVMediaType
416

    
417
#define CODEC_TYPE_UNKNOWN    AVMEDIA_TYPE_UNKNOWN
418
#define CODEC_TYPE_VIDEO      AVMEDIA_TYPE_VIDEO
419
#define CODEC_TYPE_AUDIO      AVMEDIA_TYPE_AUDIO
420
#define CODEC_TYPE_DATA       AVMEDIA_TYPE_DATA
421
#define CODEC_TYPE_SUBTITLE   AVMEDIA_TYPE_SUBTITLE
422
#define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
423
#define CODEC_TYPE_NB         AVMEDIA_TYPE_NB
424
#endif
425

    
426
#if FF_API_OLD_SAMPLE_FMT
427
#define SampleFormat AVSampleFormat
428

    
429
#define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
430
#define SAMPLE_FMT_U8   AV_SAMPLE_FMT_U8
431
#define SAMPLE_FMT_S16  AV_SAMPLE_FMT_S16
432
#define SAMPLE_FMT_S32  AV_SAMPLE_FMT_S32
433
#define SAMPLE_FMT_FLT  AV_SAMPLE_FMT_FLT
434
#define SAMPLE_FMT_DBL  AV_SAMPLE_FMT_DBL
435
#define SAMPLE_FMT_NB   AV_SAMPLE_FMT_NB
436
#endif
437

    
438
#if FF_API_OLD_AUDIOCONVERT
439
#include "libavcore/audioconvert.h"
440

    
441
/* Audio channel masks */
442
#define CH_FRONT_LEFT            AV_CH_FRONT_LEFT
443
#define CH_FRONT_RIGHT           AV_CH_FRONT_RIGHT
444
#define CH_FRONT_CENTER          AV_CH_FRONT_CENTER
445
#define CH_LOW_FREQUENCY         AV_CH_LOW_FREQUENCY
446
#define CH_BACK_LEFT             AV_CH_BACK_LEFT
447
#define CH_BACK_RIGHT            AV_CH_BACK_RIGHT
448
#define CH_FRONT_LEFT_OF_CENTER  AV_CH_FRONT_LEFT_OF_CENTER
449
#define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
450
#define CH_BACK_CENTER           AV_CH_BACK_CENTER
451
#define CH_SIDE_LEFT             AV_CH_SIDE_LEFT
452
#define CH_SIDE_RIGHT            AV_CH_SIDE_RIGHT
453
#define CH_TOP_CENTER            AV_CH_TOP_CENTER
454
#define CH_TOP_FRONT_LEFT        AV_CH_TOP_FRONT_LEFT
455
#define CH_TOP_FRONT_CENTER      AV_CH_TOP_FRONT_CENTER
456
#define CH_TOP_FRONT_RIGHT       AV_CH_TOP_FRONT_RIGHT
457
#define CH_TOP_BACK_LEFT         AV_CH_TOP_BACK_LEFT
458
#define CH_TOP_BACK_CENTER       AV_CH_TOP_BACK_CENTER
459
#define CH_TOP_BACK_RIGHT        AV_CH_TOP_BACK_RIGHT
460
#define CH_STEREO_LEFT           AV_CH_STEREO_LEFT
461
#define CH_STEREO_RIGHT          AV_CH_STEREO_RIGHT
462

    
463
/** Channel mask value used for AVCodecContext.request_channel_layout
464
    to indicate that the user requests the channel order of the decoder output
465
    to be the native codec channel order. */
466
#define CH_LAYOUT_NATIVE         AV_CH_LAYOUT_NATIVE
467

    
468
/* Audio channel convenience macros */
469
#define CH_LAYOUT_MONO           AV_CH_LAYOUT_MONO
470
#define CH_LAYOUT_STEREO         AV_CH_LAYOUT_STEREO
471
#define CH_LAYOUT_2_1            AV_CH_LAYOUT_2_1
472
#define CH_LAYOUT_SURROUND       AV_CH_LAYOUT_SURROUND
473
#define CH_LAYOUT_4POINT0        AV_CH_LAYOUT_4POINT0
474
#define CH_LAYOUT_2_2            AV_CH_LAYOUT_2_2
475
#define CH_LAYOUT_QUAD           AV_CH_LAYOUT_QUAD
476
#define CH_LAYOUT_5POINT0        AV_CH_LAYOUT_5POINT0
477
#define CH_LAYOUT_5POINT1        AV_CH_LAYOUT_5POINT1
478
#define CH_LAYOUT_5POINT0_BACK   AV_CH_LAYOUT_5POINT0_BACK
479
#define CH_LAYOUT_5POINT1_BACK   AV_CH_LAYOUT_5POINT1_BACK
480
#define CH_LAYOUT_7POINT0        AV_CH_LAYOUT_7POINT0
481
#define CH_LAYOUT_7POINT1        AV_CH_LAYOUT_7POINT1
482
#define CH_LAYOUT_7POINT1_WIDE   AV_CH_LAYOUT_7POINT1_WIDE
483
#define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
484
#endif
485

    
486
/* in bytes */
487
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
488

    
489
/**
490
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
491
 * This is mainly needed because some optimized bitstream readers read
492
 * 32 or 64 bit at once and could read over the end.<br>
493
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
494
 * MPEG bitstreams could cause overread and segfault.
495
 */
496
#define FF_INPUT_BUFFER_PADDING_SIZE 8
497

    
498
/**
499
 * minimum encoding buffer size
500
 * Used to avoid some checks during header writing.
501
 */
502
#define FF_MIN_BUFFER_SIZE 16384
503

    
504

    
505
/**
506
 * motion estimation type.
507
 */
508
enum Motion_Est_ID {
509
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
510
    ME_FULL,
511
    ME_LOG,
512
    ME_PHODS,
513
    ME_EPZS,        ///< enhanced predictive zonal search
514
    ME_X1,          ///< reserved for experiments
515
    ME_HEX,         ///< hexagon based search
516
    ME_UMH,         ///< uneven multi-hexagon search
517
    ME_ITER,        ///< iterative search
518
    ME_TESA,        ///< transformed exhaustive search algorithm
519
};
520

    
521
enum AVDiscard{
522
    /* We leave some space between them for extensions (drop some
523
     * keyframes for intra-only or drop just some bidir frames). */
524
    AVDISCARD_NONE   =-16, ///< discard nothing
525
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
526
    AVDISCARD_NONREF =  8, ///< discard all non reference
527
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
528
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
529
    AVDISCARD_ALL    = 48, ///< discard all
530
};
531

    
532
enum AVColorPrimaries{
533
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
534
    AVCOL_PRI_UNSPECIFIED=2,
535
    AVCOL_PRI_BT470M     =4,
536
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
537
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
538
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
539
    AVCOL_PRI_FILM       =8,
540
    AVCOL_PRI_NB           , ///< Not part of ABI
541
};
542

    
543
enum AVColorTransferCharacteristic{
544
    AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
545
    AVCOL_TRC_UNSPECIFIED=2,
546
    AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
547
    AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
548
    AVCOL_TRC_NB           , ///< Not part of ABI
549
};
550

    
551
enum AVColorSpace{
552
    AVCOL_SPC_RGB        =0,
553
    AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
554
    AVCOL_SPC_UNSPECIFIED=2,
555
    AVCOL_SPC_FCC        =4,
556
    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
557
    AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
558
    AVCOL_SPC_SMPTE240M  =7,
559
    AVCOL_SPC_NB           , ///< Not part of ABI
560
};
561

    
562
enum AVColorRange{
563
    AVCOL_RANGE_UNSPECIFIED=0,
564
    AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
565
    AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
566
    AVCOL_RANGE_NB           , ///< Not part of ABI
567
};
568

    
569
/**
570
 *  X   X      3 4 X      X are luma samples,
571
 *             1 2        1-6 are possible chroma positions
572
 *  X   X      5 6 X      0 is undefined/unknown position
573
 */
574
enum AVChromaLocation{
575
    AVCHROMA_LOC_UNSPECIFIED=0,
576
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
577
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
578
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
579
    AVCHROMA_LOC_TOP        =4,
580
    AVCHROMA_LOC_BOTTOMLEFT =5,
581
    AVCHROMA_LOC_BOTTOM     =6,
582
    AVCHROMA_LOC_NB           , ///< Not part of ABI
583
};
584

    
585
/**
586
 * LPC analysis type
587
 */
588
enum AVLPCType {
589
    AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
590
    AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
591
    AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
592
    AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
593
    AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
594
    AV_LPC_TYPE_NB              , ///< Not part of ABI
595
};
596

    
597
typedef struct RcOverride{
598
    int start_frame;
599
    int end_frame;
600
    int qscale; // If this is 0 then quality_factor will be used instead.
601
    float quality_factor;
602
} RcOverride;
603

    
604
#define FF_MAX_B_FRAMES 16
605

    
606
/* encoding support
607
   These flags can be passed in AVCodecContext.flags before initialization.
608
   Note: Not everything is supported yet.
609
*/
610

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

    
672
/* Unsupported options :
673
 *              Syntax Arithmetic coding (SAC)
674
 *              Reference Picture Selection
675
 *              Independent Segment Decoding */
676
/* /Fx */
677
/* codec capabilities */
678

    
679
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
680
/**
681
 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
682
 * If not set, it might not use get_buffer() at all or use operations that
683
 * assume the buffer was allocated by avcodec_default_get_buffer.
684
 */
685
#define CODEC_CAP_DR1             0x0002
686
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
687
#define CODEC_CAP_PARSE_ONLY      0x0004
688
#define CODEC_CAP_TRUNCATED       0x0008
689
/* Codec can export data for HW decoding (XvMC). */
690
#define CODEC_CAP_HWACCEL         0x0010
691
/**
692
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
693
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
694
 */
695
#define CODEC_CAP_DELAY           0x0020
696
/**
697
 * Codec can be fed a final frame with a smaller size.
698
 * This can be used to prevent truncation of the last audio samples.
699
 */
700
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
701
/**
702
 * Codec can export data for HW decoding (VDPAU).
703
 */
704
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
705
/**
706
 * Codec can output multiple frames per AVPacket
707
 * Normally demuxers return one frame at a time, demuxers which do not do
708
 * are connected to a parser to split what they return into proper frames.
709
 * This flag is reserved to the very rare category of codecs which have a
710
 * bitstream that cannot be split into frames without timeconsuming
711
 * operations like full decoding. Demuxers carring such bitstreams thus
712
 * may return multiple frames in a packet. This has many disadvantages like
713
 * prohibiting stream copy in many cases thus it should only be considered
714
 * as a last resort.
715
 */
716
#define CODEC_CAP_SUBFRAMES        0x0100
717
/**
718
 * Codec is experimental and is thus avoided in favor of non experimental
719
 * encoders
720
 */
721
#define CODEC_CAP_EXPERIMENTAL     0x0200
722
/**
723
 * Codec should fill in channel configuration and samplerate instead of container
724
 */
725
#define CODEC_CAP_CHANNEL_CONF     0x0400
726
/**
727
 * Codec is able to deal with negative linesizes
728
 */
729
#define CODEC_CAP_NEG_LINESIZES    0x0800
730

    
731
//The following defines may change, don't expect compatibility if you use them.
732
#define MB_TYPE_INTRA4x4   0x0001
733
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
734
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
735
#define MB_TYPE_16x16      0x0008
736
#define MB_TYPE_16x8       0x0010
737
#define MB_TYPE_8x16       0x0020
738
#define MB_TYPE_8x8        0x0040
739
#define MB_TYPE_INTERLACED 0x0080
740
#define MB_TYPE_DIRECT2    0x0100 //FIXME
741
#define MB_TYPE_ACPRED     0x0200
742
#define MB_TYPE_GMC        0x0400
743
#define MB_TYPE_SKIP       0x0800
744
#define MB_TYPE_P0L0       0x1000
745
#define MB_TYPE_P1L0       0x2000
746
#define MB_TYPE_P0L1       0x4000
747
#define MB_TYPE_P1L1       0x8000
748
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
749
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
750
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
751
#define MB_TYPE_QUANT      0x00010000
752
#define MB_TYPE_CBP        0x00020000
753
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
754

    
755
/**
756
 * Pan Scan area.
757
 * This specifies the area which should be displayed.
758
 * Note there may be multiple such areas for one frame.
759
 */
760
typedef struct AVPanScan{
761
    /**
762
     * id
763
     * - encoding: Set by user.
764
     * - decoding: Set by libavcodec.
765
     */
766
    int id;
767

    
768
    /**
769
     * width and height in 1/16 pel
770
     * - encoding: Set by user.
771
     * - decoding: Set by libavcodec.
772
     */
773
    int width;
774
    int height;
775

    
776
    /**
777
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
778
     * - encoding: Set by user.
779
     * - decoding: Set by libavcodec.
780
     */
781
    int16_t position[3][2];
782
}AVPanScan;
783

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

    
1030

    
1031
#define FF_QSCALE_TYPE_MPEG1 0
1032
#define FF_QSCALE_TYPE_MPEG2 1
1033
#define FF_QSCALE_TYPE_H264  2
1034
#define FF_QSCALE_TYPE_VP56  3
1035

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

    
1041

    
1042
#define FF_I_TYPE  1 ///< Intra
1043
#define FF_P_TYPE  2 ///< Predicted
1044
#define FF_B_TYPE  3 ///< Bi-dir predicted
1045
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
1046
#define FF_SI_TYPE 5 ///< Switching Intra
1047
#define FF_SP_TYPE 6 ///< Switching Predicted
1048
#define FF_BI_TYPE 7
1049

    
1050
#define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
1051
#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1052
#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1053
#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1054

    
1055
typedef struct AVPacket {
1056
    /**
1057
     * Presentation timestamp in AVStream->time_base units; the time at which
1058
     * the decompressed packet will be presented to the user.
1059
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1060
     * pts MUST be larger or equal to dts as presentation cannot happen before
1061
     * decompression, unless one wants to view hex dumps. Some formats misuse
1062
     * the terms dts and pts/cts to mean something different. Such timestamps
1063
     * must be converted to true pts/dts before they are stored in AVPacket.
1064
     */
1065
    int64_t pts;
1066
    /**
1067
     * Decompression timestamp in AVStream->time_base units; the time at which
1068
     * the packet is decompressed.
1069
     * Can be AV_NOPTS_VALUE if it is not stored in the file.
1070
     */
1071
    int64_t dts;
1072
    uint8_t *data;
1073
    int   size;
1074
    int   stream_index;
1075
    int   flags;
1076
    /**
1077
     * Duration of this packet in AVStream->time_base units, 0 if unknown.
1078
     * Equals next_pts - this_pts in presentation order.
1079
     */
1080
    int   duration;
1081
    void  (*destruct)(struct AVPacket *);
1082
    void  *priv;
1083
    int64_t pos;                            ///< byte position in stream, -1 if unknown
1084

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

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

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

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

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

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

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

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

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

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

    
1210
#define FF_ASPECT_EXTENDED 15
1211

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

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

    
1228
    /**
1229
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1230
     * has to read frames at native frame rate.
1231
     * - encoding: Set by user.
1232
     * - decoding: unused
1233
     */
1234
    int rate_emu;
1235

    
1236
    /**
1237
     * If non NULL, 'draw_horiz_band' is called by the libavcodec
1238
     * decoder to draw a horizontal band. It improves cache usage. Not
1239
     * all codecs can do that. You must check the codec capabilities
1240
     * beforehand.
1241
     * The function is also used by hardware acceleration APIs.
1242
     * It is called at least once during frame decoding to pass
1243
     * the data needed for hardware render.
1244
     * In that mode instead of pixel data, AVFrame points to
1245
     * a structure specific to the acceleration API. The application
1246
     * reads the structure and can change some fields to indicate progress
1247
     * or mark state.
1248
     * - encoding: unused
1249
     * - decoding: Set by user.
1250
     * @param height the height of the slice
1251
     * @param y the y position of the slice
1252
     * @param type 1->top field, 2->bottom field, 3->frame
1253
     * @param offset offset into the AVFrame.data from which the slice should be read
1254
     */
1255
    void (*draw_horiz_band)(struct AVCodecContext *s,
1256
                            const AVFrame *src, int offset[4],
1257
                            int y, int type, int height);
1258

    
1259
    /* audio only */
1260
    int sample_rate; ///< samples per second
1261
    int channels;    ///< number of audio channels
1262

    
1263
    /**
1264
     * audio sample format
1265
     * - encoding: Set by user.
1266
     * - decoding: Set by libavcodec.
1267
     */
1268
    enum AVSampleFormat sample_fmt;  ///< sample format
1269

    
1270
    /* The following data should not be initialized. */
1271
    /**
1272
     * Samples per packet, initialized when calling 'init'.
1273
     */
1274
    int frame_size;
1275
    int frame_number;   ///< audio or video frame number
1276
#if LIBAVCODEC_VERSION_MAJOR < 53
1277
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1278
#endif
1279

    
1280
    /**
1281
     * Number of frames the decoded output will be delayed relative to
1282
     * the encoded input.
1283
     * - encoding: Set by libavcodec.
1284
     * - decoding: unused
1285
     */
1286
    int delay;
1287

    
1288
    /* - encoding parameters */
1289
    float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1290
    float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1291

    
1292
    /**
1293
     * minimum quantizer
1294
     * - encoding: Set by user.
1295
     * - decoding: unused
1296
     */
1297
    int qmin;
1298

    
1299
    /**
1300
     * maximum quantizer
1301
     * - encoding: Set by user.
1302
     * - decoding: unused
1303
     */
1304
    int qmax;
1305

    
1306
    /**
1307
     * maximum quantizer difference between frames
1308
     * - encoding: Set by user.
1309
     * - decoding: unused
1310
     */
1311
    int max_qdiff;
1312

    
1313
    /**
1314
     * maximum number of B-frames between non-B-frames
1315
     * Note: The output will be delayed by max_b_frames+1 relative to the input.
1316
     * - encoding: Set by user.
1317
     * - decoding: unused
1318
     */
1319
    int max_b_frames;
1320

    
1321
    /**
1322
     * qscale factor between IP and B-frames
1323
     * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1324
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1325
     * - encoding: Set by user.
1326
     * - decoding: unused
1327
     */
1328
    float b_quant_factor;
1329

    
1330
    /** obsolete FIXME remove */
1331
    int rc_strategy;
1332
#define FF_RC_STRATEGY_XVID 1
1333

    
1334
    int b_frame_strategy;
1335

    
1336
    /**
1337
     * hurry up amount
1338
     * - encoding: unused
1339
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1340
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1341
     */
1342
    int hurry_up;
1343

    
1344
    struct AVCodec *codec;
1345

    
1346
    void *priv_data;
1347

    
1348
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1349
                            /* do its best to deliver a chunk with size     */
1350
                            /* below rtp_payload_size, the chunk will start */
1351
                            /* with a start code on some codecs like H.263. */
1352
                            /* This doesn't take account of any particular  */
1353
                            /* headers inside the transmitted RTP payload.  */
1354

    
1355

    
1356
    /* The RTP callback: This function is called    */
1357
    /* every time the encoder has a packet to send. */
1358
    /* It depends on the encoder if the data starts */
1359
    /* with a Start Code (it should). H.263 does.   */
1360
    /* mb_nb contains the number of macroblocks     */
1361
    /* encoded in the RTP payload.                  */
1362
    void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1363

    
1364
    /* statistics, used for 2-pass encoding */
1365
    int mv_bits;
1366
    int header_bits;
1367
    int i_tex_bits;
1368
    int p_tex_bits;
1369
    int i_count;
1370
    int p_count;
1371
    int skip_count;
1372
    int misc_bits;
1373

    
1374
    /**
1375
     * number of bits used for the previously encoded frame
1376
     * - encoding: Set by libavcodec.
1377
     * - decoding: unused
1378
     */
1379
    int frame_bits;
1380

    
1381
    /**
1382
     * Private data of the user, can be used to carry app specific stuff.
1383
     * - encoding: Set by user.
1384
     * - decoding: Set by user.
1385
     */
1386
    void *opaque;
1387

    
1388
    char codec_name[32];
1389
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1390
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1391

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

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

    
1431
    /**
1432
     * luma single coefficient elimination threshold
1433
     * - encoding: Set by user.
1434
     * - decoding: unused
1435
     */
1436
    int luma_elim_threshold;
1437

    
1438
    /**
1439
     * chroma single coeff elimination threshold
1440
     * - encoding: Set by user.
1441
     * - decoding: unused
1442
     */
1443
    int chroma_elim_threshold;
1444

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

    
1467
    /**
1468
     * qscale offset between IP and B-frames
1469
     * - encoding: Set by user.
1470
     * - decoding: unused
1471
     */
1472
    float b_quant_offset;
1473

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

    
1486
    /**
1487
     * Called at the beginning of each frame to get a buffer for it.
1488
     * If pic.reference is set then the frame will be read later by libavcodec.
1489
     * avcodec_align_dimensions2() should be used to find the required width and
1490
     * height, as they normally need to be rounded up to the next multiple of 16.
1491
     * if CODEC_CAP_DR1 is not set then get_buffer() must call
1492
     * avcodec_default_get_buffer() instead of providing buffers allocated by
1493
     * some other means.
1494
     * - encoding: unused
1495
     * - decoding: Set by libavcodec, user can override.
1496
     */
1497
    int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1498

    
1499
    /**
1500
     * Called to release buffers which were allocated with get_buffer.
1501
     * A released buffer can be reused in get_buffer().
1502
     * pic.data[*] must be set to NULL.
1503
     * - encoding: unused
1504
     * - decoding: Set by libavcodec, user can override.
1505
     */
1506
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1507

    
1508
    /**
1509
     * Size of the frame reordering buffer in the decoder.
1510
     * For MPEG-2 it is 1 IPB or 0 low delay IP.
1511
     * - encoding: Set by libavcodec.
1512
     * - decoding: Set by libavcodec.
1513
     */
1514
    int has_b_frames;
1515

    
1516
    /**
1517
     * number of bytes per packet if constant and known or 0
1518
     * Used by some WAV based audio codecs.
1519
     */
1520
    int block_align;
1521

    
1522
    int parse_only; /* - decoding only: If true, only parsing is done
1523
                       (function avcodec_parse_frame()). The frame
1524
                       data is returned. Only MPEG codecs support this now. */
1525

    
1526
    /**
1527
     * 0-> h263 quant 1-> mpeg quant
1528
     * - encoding: Set by user.
1529
     * - decoding: unused
1530
     */
1531
    int mpeg_quant;
1532

    
1533
    /**
1534
     * pass1 encoding statistics output buffer
1535
     * - encoding: Set by libavcodec.
1536
     * - decoding: unused
1537
     */
1538
    char *stats_out;
1539

    
1540
    /**
1541
     * pass2 encoding statistics input buffer
1542
     * Concatenated stuff from stats_out of pass1 should be placed here.
1543
     * - encoding: Allocated/set/freed by user.
1544
     * - decoding: unused
1545
     */
1546
    char *stats_in;
1547

    
1548
    /**
1549
     * ratecontrol qmin qmax limiting method
1550
     * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1551
     * - encoding: Set by user.
1552
     * - decoding: unused
1553
     */
1554
    float rc_qsquish;
1555

    
1556
    float rc_qmod_amp;
1557
    int rc_qmod_freq;
1558

    
1559
    /**
1560
     * ratecontrol override, see RcOverride
1561
     * - encoding: Allocated/set/freed by user.
1562
     * - decoding: unused
1563
     */
1564
    RcOverride *rc_override;
1565
    int rc_override_count;
1566

    
1567
    /**
1568
     * rate control equation
1569
     * - encoding: Set by user
1570
     * - decoding: unused
1571
     */
1572
    const char *rc_eq;
1573

    
1574
    /**
1575
     * maximum bitrate
1576
     * - encoding: Set by user.
1577
     * - decoding: unused
1578
     */
1579
    int rc_max_rate;
1580

    
1581
    /**
1582
     * minimum bitrate
1583
     * - encoding: Set by user.
1584
     * - decoding: unused
1585
     */
1586
    int rc_min_rate;
1587

    
1588
    /**
1589
     * decoder bitstream buffer size
1590
     * - encoding: Set by user.
1591
     * - decoding: unused
1592
     */
1593
    int rc_buffer_size;
1594
    float rc_buffer_aggressivity;
1595

    
1596
    /**
1597
     * qscale factor between P and I-frames
1598
     * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1599
     * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1600
     * - encoding: Set by user.
1601
     * - decoding: unused
1602
     */
1603
    float i_quant_factor;
1604

    
1605
    /**
1606
     * qscale offset between P and I-frames
1607
     * - encoding: Set by user.
1608
     * - decoding: unused
1609
     */
1610
    float i_quant_offset;
1611

    
1612
    /**
1613
     * initial complexity for pass1 ratecontrol
1614
     * - encoding: Set by user.
1615
     * - decoding: unused
1616
     */
1617
    float rc_initial_cplx;
1618

    
1619
    /**
1620
     * DCT algorithm, see FF_DCT_* below
1621
     * - encoding: Set by user.
1622
     * - decoding: unused
1623
     */
1624
    int dct_algo;
1625
#define FF_DCT_AUTO    0
1626
#define FF_DCT_FASTINT 1
1627
#define FF_DCT_INT     2
1628
#define FF_DCT_MMX     3
1629
#define FF_DCT_MLIB    4
1630
#define FF_DCT_ALTIVEC 5
1631
#define FF_DCT_FAAN    6
1632

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

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

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

    
1654
    /**
1655
     * p block masking (0-> disabled)
1656
     * - encoding: Set by user.
1657
     * - decoding: unused
1658
     */
1659
    float p_masking;
1660

    
1661
    /**
1662
     * darkness masking (0-> disabled)
1663
     * - encoding: Set by user.
1664
     * - decoding: unused
1665
     */
1666
    float dark_masking;
1667

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

    
1700
    /**
1701
     * slice count
1702
     * - encoding: Set by libavcodec.
1703
     * - decoding: Set by user (or 0).
1704
     */
1705
    int slice_count;
1706
    /**
1707
     * slice offsets in the frame in bytes
1708
     * - encoding: Set/allocated by libavcodec.
1709
     * - decoding: Set/allocated by user (or NULL).
1710
     */
1711
    int *slice_offset;
1712

    
1713
    /**
1714
     * error concealment flags
1715
     * - encoding: unused
1716
     * - decoding: Set by user.
1717
     */
1718
    int error_concealment;
1719
#define FF_EC_GUESS_MVS   1
1720
#define FF_EC_DEBLOCK     2
1721

    
1722
    /**
1723
     * dsp_mask could be add used to disable unwanted CPU features
1724
     * CPU features (i.e. MMX, SSE. ...)
1725
     *
1726
     * With the FORCE flag you may instead enable given CPU features.
1727
     * (Dangerous: Usable in case of misdetection, improper usage however will
1728
     * result into program crash.)
1729
     */
1730
    unsigned dsp_mask;
1731

    
1732
#if FF_API_MM_FLAGS
1733
#define FF_MM_FORCE      AV_CPU_FLAG_FORCE
1734
#define FF_MM_MMX        AV_CPU_FLAG_MMX
1735
#define FF_MM_3DNOW      AV_CPU_FLAG_3DNOW
1736
#define FF_MM_MMXEXT     AV_CPU_FLAG_MMX2
1737
#define FF_MM_MMX2       AV_CPU_FLAG_MMX2
1738
#define FF_MM_SSE        AV_CPU_FLAG_SSE
1739
#define FF_MM_SSE2       AV_CPU_FLAG_SSE2
1740
#define FF_MM_SSE2SLOW   AV_CPU_FLAG_SSE2SLOW
1741
#define FF_MM_3DNOWEXT   AV_CPU_FLAG_3DNOWEXT
1742
#define FF_MM_SSE3       AV_CPU_FLAG_SSE3
1743
#define FF_MM_SSE3SLOW   AV_CPU_FLAG_SSE3SLOW
1744
#define FF_MM_SSSE3      AV_CPU_FLAG_SSSE3
1745
#define FF_MM_SSE4       AV_CPU_FLAG_SSE4
1746
#define FF_MM_SSE42      AV_CPU_FLAG_SSE42
1747
#define FF_MM_IWMMXT     AV_CPU_FLAG_IWMMXT
1748
#define FF_MM_ALTIVEC    AV_CPU_FLAG_ALTIVEC
1749
#endif
1750

    
1751
    /**
1752
     * bits per sample/pixel from the demuxer (needed for huffyuv).
1753
     * - encoding: Set by libavcodec.
1754
     * - decoding: Set by user.
1755
     */
1756
     int bits_per_coded_sample;
1757

    
1758
    /**
1759
     * prediction method (needed for huffyuv)
1760
     * - encoding: Set by user.
1761
     * - decoding: unused
1762
     */
1763
     int prediction_method;
1764
#define FF_PRED_LEFT   0
1765
#define FF_PRED_PLANE  1
1766
#define FF_PRED_MEDIAN 2
1767

    
1768
    /**
1769
     * sample aspect ratio (0 if unknown)
1770
     * That is the width of a pixel divided by the height of the pixel.
1771
     * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1772
     * - encoding: Set by user.
1773
     * - decoding: Set by libavcodec.
1774
     */
1775
    AVRational sample_aspect_ratio;
1776

    
1777
    /**
1778
     * the picture in the bitstream
1779
     * - encoding: Set by libavcodec.
1780
     * - decoding: Set by libavcodec.
1781
     */
1782
    AVFrame *coded_frame;
1783

    
1784
    /**
1785
     * debug
1786
     * - encoding: Set by user.
1787
     * - decoding: Set by user.
1788
     */
1789
    int debug;
1790
#define FF_DEBUG_PICT_INFO   1
1791
#define FF_DEBUG_RC          2
1792
#define FF_DEBUG_BITSTREAM   4
1793
#define FF_DEBUG_MB_TYPE     8
1794
#define FF_DEBUG_QP          16
1795
#define FF_DEBUG_MV          32
1796
#define FF_DEBUG_DCT_COEFF   0x00000040
1797
#define FF_DEBUG_SKIP        0x00000080
1798
#define FF_DEBUG_STARTCODE   0x00000100
1799
#define FF_DEBUG_PTS         0x00000200
1800
#define FF_DEBUG_ER          0x00000400
1801
#define FF_DEBUG_MMCO        0x00000800
1802
#define FF_DEBUG_BUGS        0x00001000
1803
#define FF_DEBUG_VIS_QP      0x00002000
1804
#define FF_DEBUG_VIS_MB_TYPE 0x00004000
1805
#define FF_DEBUG_BUFFERS     0x00008000
1806

    
1807
    /**
1808
     * debug
1809
     * - encoding: Set by user.
1810
     * - decoding: Set by user.
1811
     */
1812
    int debug_mv;
1813
#define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1814
#define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1815
#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1816

    
1817
    /**
1818
     * error
1819
     * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1820
     * - decoding: unused
1821
     */
1822
    uint64_t error[4];
1823

    
1824
    /**
1825
     * minimum MB quantizer
1826
     * - encoding: unused
1827
     * - decoding: unused
1828
     */
1829
    int mb_qmin;
1830

    
1831
    /**
1832
     * maximum MB quantizer
1833
     * - encoding: unused
1834
     * - decoding: unused
1835
     */
1836
    int mb_qmax;
1837

    
1838
    /**
1839
     * motion estimation comparison function
1840
     * - encoding: Set by user.
1841
     * - decoding: unused
1842
     */
1843
    int me_cmp;
1844
    /**
1845
     * subpixel motion estimation comparison function
1846
     * - encoding: Set by user.
1847
     * - decoding: unused
1848
     */
1849
    int me_sub_cmp;
1850
    /**
1851
     * macroblock comparison function (not supported yet)
1852
     * - encoding: Set by user.
1853
     * - decoding: unused
1854
     */
1855
    int mb_cmp;
1856
    /**
1857
     * interlaced DCT comparison function
1858
     * - encoding: Set by user.
1859
     * - decoding: unused
1860
     */
1861
    int ildct_cmp;
1862
#define FF_CMP_SAD    0
1863
#define FF_CMP_SSE    1
1864
#define FF_CMP_SATD   2
1865
#define FF_CMP_DCT    3
1866
#define FF_CMP_PSNR   4
1867
#define FF_CMP_BIT    5
1868
#define FF_CMP_RD     6
1869
#define FF_CMP_ZERO   7
1870
#define FF_CMP_VSAD   8
1871
#define FF_CMP_VSSE   9
1872
#define FF_CMP_NSSE   10
1873
#define FF_CMP_W53    11
1874
#define FF_CMP_W97    12
1875
#define FF_CMP_DCTMAX 13
1876
#define FF_CMP_DCT264 14
1877
#define FF_CMP_CHROMA 256
1878

    
1879
    /**
1880
     * ME diamond size & shape
1881
     * - encoding: Set by user.
1882
     * - decoding: unused
1883
     */
1884
    int dia_size;
1885

    
1886
    /**
1887
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1888
     * - encoding: Set by user.
1889
     * - decoding: unused
1890
     */
1891
    int last_predictor_count;
1892

    
1893
    /**
1894
     * prepass for motion estimation
1895
     * - encoding: Set by user.
1896
     * - decoding: unused
1897
     */
1898
    int pre_me;
1899

    
1900
    /**
1901
     * motion estimation prepass comparison function
1902
     * - encoding: Set by user.
1903
     * - decoding: unused
1904
     */
1905
    int me_pre_cmp;
1906

    
1907
    /**
1908
     * ME prepass diamond size & shape
1909
     * - encoding: Set by user.
1910
     * - decoding: unused
1911
     */
1912
    int pre_dia_size;
1913

    
1914
    /**
1915
     * subpel ME quality
1916
     * - encoding: Set by user.
1917
     * - decoding: unused
1918
     */
1919
    int me_subpel_quality;
1920

    
1921
    /**
1922
     * callback to negotiate the pixelFormat
1923
     * @param fmt is the list of formats which are supported by the codec,
1924
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1925
     * The first is always the native one.
1926
     * @return the chosen format
1927
     * - encoding: unused
1928
     * - decoding: Set by user, if not set the native format will be chosen.
1929
     */
1930
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1931

    
1932
    /**
1933
     * DTG active format information (additional aspect ratio
1934
     * information only used in DVB MPEG-2 transport streams)
1935
     * 0 if not set.
1936
     *
1937
     * - encoding: unused
1938
     * - decoding: Set by decoder.
1939
     */
1940
    int dtg_active_format;
1941
#define FF_DTG_AFD_SAME         8
1942
#define FF_DTG_AFD_4_3          9
1943
#define FF_DTG_AFD_16_9         10
1944
#define FF_DTG_AFD_14_9         11
1945
#define FF_DTG_AFD_4_3_SP_14_9  13
1946
#define FF_DTG_AFD_16_9_SP_14_9 14
1947
#define FF_DTG_AFD_SP_4_3       15
1948

    
1949
    /**
1950
     * maximum motion estimation search range in subpel units
1951
     * If 0 then no limit.
1952
     *
1953
     * - encoding: Set by user.
1954
     * - decoding: unused
1955
     */
1956
    int me_range;
1957

    
1958
    /**
1959
     * intra quantizer bias
1960
     * - encoding: Set by user.
1961
     * - decoding: unused
1962
     */
1963
    int intra_quant_bias;
1964
#define FF_DEFAULT_QUANT_BIAS 999999
1965

    
1966
    /**
1967
     * inter quantizer bias
1968
     * - encoding: Set by user.
1969
     * - decoding: unused
1970
     */
1971
    int inter_quant_bias;
1972

    
1973
    /**
1974
     * color table ID
1975
     * - encoding: unused
1976
     * - decoding: Which clrtable should be used for 8bit RGB images.
1977
     *             Tables have to be stored somewhere. FIXME
1978
     */
1979
    int color_table_id;
1980

    
1981
    /**
1982
     * internal_buffer count
1983
     * Don't touch, used by libavcodec default_get_buffer().
1984
     */
1985
    int internal_buffer_count;
1986

    
1987
    /**
1988
     * internal_buffers
1989
     * Don't touch, used by libavcodec default_get_buffer().
1990
     */
1991
    void *internal_buffer;
1992

    
1993
    /**
1994
     * Global quality for codecs which cannot change it per frame.
1995
     * This should be proportional to MPEG-1/2/4 qscale.
1996
     * - encoding: Set by user.
1997
     * - decoding: unused
1998
     */
1999
    int global_quality;
2000

    
2001
#define FF_CODER_TYPE_VLC       0
2002
#define FF_CODER_TYPE_AC        1
2003
#define FF_CODER_TYPE_RAW       2
2004
#define FF_CODER_TYPE_RLE       3
2005
#define FF_CODER_TYPE_DEFLATE   4
2006
    /**
2007
     * coder type
2008
     * - encoding: Set by user.
2009
     * - decoding: unused
2010
     */
2011
    int coder_type;
2012

    
2013
    /**
2014
     * context model
2015
     * - encoding: Set by user.
2016
     * - decoding: unused
2017
     */
2018
    int context_model;
2019
#if 0
2020
    /**
2021
     *
2022
     * - encoding: unused
2023
     * - decoding: Set by user.
2024
     */
2025
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2026
#endif
2027

    
2028
    /**
2029
     * slice flags
2030
     * - encoding: unused
2031
     * - decoding: Set by user.
2032
     */
2033
    int slice_flags;
2034
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2035
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2036
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2037

    
2038
    /**
2039
     * XVideo Motion Acceleration
2040
     * - encoding: forbidden
2041
     * - decoding: set by decoder
2042
     */
2043
    int xvmc_acceleration;
2044

    
2045
    /**
2046
     * macroblock decision mode
2047
     * - encoding: Set by user.
2048
     * - decoding: unused
2049
     */
2050
    int mb_decision;
2051
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2052
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2053
#define FF_MB_DECISION_RD     2        ///< rate distortion
2054

    
2055
    /**
2056
     * custom intra quantization matrix
2057
     * - encoding: Set by user, can be NULL.
2058
     * - decoding: Set by libavcodec.
2059
     */
2060
    uint16_t *intra_matrix;
2061

    
2062
    /**
2063
     * custom inter quantization matrix
2064
     * - encoding: Set by user, can be NULL.
2065
     * - decoding: Set by libavcodec.
2066
     */
2067
    uint16_t *inter_matrix;
2068

    
2069
    /**
2070
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2071
     * This is used to work around some encoder bugs.
2072
     * - encoding: unused
2073
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2074
     */
2075
    unsigned int stream_codec_tag;
2076

    
2077
    /**
2078
     * scene change detection threshold
2079
     * 0 is default, larger means fewer detected scene changes.
2080
     * - encoding: Set by user.
2081
     * - decoding: unused
2082
     */
2083
    int scenechange_threshold;
2084

    
2085
    /**
2086
     * minimum Lagrange multipler
2087
     * - encoding: Set by user.
2088
     * - decoding: unused
2089
     */
2090
    int lmin;
2091

    
2092
    /**
2093
     * maximum Lagrange multipler
2094
     * - encoding: Set by user.
2095
     * - decoding: unused
2096
     */
2097
    int lmax;
2098

    
2099
#if FF_API_PALETTE_CONTROL
2100
    /**
2101
     * palette control structure
2102
     * - encoding: ??? (no palette-enabled encoder yet)
2103
     * - decoding: Set by user.
2104
     */
2105
    struct AVPaletteControl *palctrl;
2106
#endif
2107

    
2108
    /**
2109
     * noise reduction strength
2110
     * - encoding: Set by user.
2111
     * - decoding: unused
2112
     */
2113
    int noise_reduction;
2114

    
2115
    /**
2116
     * Called at the beginning of a frame to get cr buffer for it.
2117
     * Buffer type (size, hints) must be the same. libavcodec won't check it.
2118
     * libavcodec will pass previous buffer in pic, function should return
2119
     * same buffer or new buffer with old frame "painted" into it.
2120
     * If pic.data[0] == NULL must behave like get_buffer().
2121
     * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2122
     * avcodec_default_reget_buffer() instead of providing buffers allocated by
2123
     * some other means.
2124
     * - encoding: unused
2125
     * - decoding: Set by libavcodec, user can override.
2126
     */
2127
    int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2128

    
2129
    /**
2130
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2131
     * - encoding: Set by user.
2132
     * - decoding: unused
2133
     */
2134
    int rc_initial_buffer_occupancy;
2135

    
2136
    /**
2137
     *
2138
     * - encoding: Set by user.
2139
     * - decoding: unused
2140
     */
2141
    int inter_threshold;
2142

    
2143
    /**
2144
     * CODEC_FLAG2_*
2145
     * - encoding: Set by user.
2146
     * - decoding: Set by user.
2147
     */
2148
    int flags2;
2149

    
2150
    /**
2151
     * Simulates errors in the bitstream to test error concealment.
2152
     * - encoding: Set by user.
2153
     * - decoding: unused
2154
     */
2155
    int error_rate;
2156

    
2157
    /**
2158
     * MP3 antialias algorithm, see FF_AA_* below.
2159
     * - encoding: unused
2160
     * - decoding: Set by user.
2161
     */
2162
    int antialias_algo;
2163
#define FF_AA_AUTO    0
2164
#define FF_AA_FASTINT 1 //not implemented yet
2165
#define FF_AA_INT     2
2166
#define FF_AA_FLOAT   3
2167
    /**
2168
     * quantizer noise shaping
2169
     * - encoding: Set by user.
2170
     * - decoding: unused
2171
     */
2172
    int quantizer_noise_shaping;
2173

    
2174
    /**
2175
     * thread count
2176
     * is used to decide how many independent tasks should be passed to execute()
2177
     * - encoding: Set by user.
2178
     * - decoding: Set by user.
2179
     */
2180
    int thread_count;
2181

    
2182
    /**
2183
     * The codec may call this to execute several independent things.
2184
     * It will return only after finishing all tasks.
2185
     * The user may replace this with some multithreaded implementation,
2186
     * the default implementation will execute the parts serially.
2187
     * @param count the number of things to execute
2188
     * - encoding: Set by libavcodec, user can override.
2189
     * - decoding: Set by libavcodec, user can override.
2190
     */
2191
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2192

    
2193
    /**
2194
     * thread opaque
2195
     * Can be used by execute() to store some per AVCodecContext stuff.
2196
     * - encoding: set by execute()
2197
     * - decoding: set by execute()
2198
     */
2199
    void *thread_opaque;
2200

    
2201
    /**
2202
     * Motion estimation threshold below which no motion estimation is
2203
     * performed, but instead the user specified motion vectors are used.
2204
     *
2205
     * - encoding: Set by user.
2206
     * - decoding: unused
2207
     */
2208
     int me_threshold;
2209

    
2210
    /**
2211
     * Macroblock threshold below which the user specified macroblock types will be used.
2212
     * - encoding: Set by user.
2213
     * - decoding: unused
2214
     */
2215
     int mb_threshold;
2216

    
2217
    /**
2218
     * precision of the intra DC coefficient - 8
2219
     * - encoding: Set by user.
2220
     * - decoding: unused
2221
     */
2222
     int intra_dc_precision;
2223

    
2224
    /**
2225
     * noise vs. sse weight for the nsse comparsion function
2226
     * - encoding: Set by user.
2227
     * - decoding: unused
2228
     */
2229
     int nsse_weight;
2230

    
2231
    /**
2232
     * Number of macroblock rows at the top which are skipped.
2233
     * - encoding: unused
2234
     * - decoding: Set by user.
2235
     */
2236
     int skip_top;
2237

    
2238
    /**
2239
     * Number of macroblock rows at the bottom which are skipped.
2240
     * - encoding: unused
2241
     * - decoding: Set by user.
2242
     */
2243
     int skip_bottom;
2244

    
2245
    /**
2246
     * profile
2247
     * - encoding: Set by user.
2248
     * - decoding: Set by libavcodec.
2249
     */
2250
     int profile;
2251
#define FF_PROFILE_UNKNOWN -99
2252

    
2253
#define FF_PROFILE_AAC_MAIN 0
2254
#define FF_PROFILE_AAC_LOW  1
2255
#define FF_PROFILE_AAC_SSR  2
2256
#define FF_PROFILE_AAC_LTP  3
2257

    
2258
#define FF_PROFILE_DTS         20
2259
#define FF_PROFILE_DTS_ES      30
2260
#define FF_PROFILE_DTS_96_24   40
2261
#define FF_PROFILE_DTS_HD_HRA  50
2262
#define FF_PROFILE_DTS_HD_MA   60
2263

    
2264
#define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2265
#define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2266

    
2267
#define FF_PROFILE_H264_BASELINE             66
2268
#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2269
#define FF_PROFILE_H264_MAIN                 77
2270
#define FF_PROFILE_H264_EXTENDED             88
2271
#define FF_PROFILE_H264_HIGH                 100
2272
#define FF_PROFILE_H264_HIGH_10              110
2273
#define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2274
#define FF_PROFILE_H264_HIGH_422             122
2275
#define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2276
#define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2277
#define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2278
#define FF_PROFILE_H264_CAVLC_444            44
2279

    
2280
    /**
2281
     * level
2282
     * - encoding: Set by user.
2283
     * - decoding: Set by libavcodec.
2284
     */
2285
     int level;
2286
#define FF_LEVEL_UNKNOWN -99
2287

    
2288
    /**
2289
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2290
     * - encoding: unused
2291
     * - decoding: Set by user.
2292
     */
2293
     int lowres;
2294

    
2295
    /**
2296
     * Bitstream width / height, may be different from width/height if lowres
2297
     * or other things are used.
2298
     * - encoding: unused
2299
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2300
     */
2301
    int coded_width, coded_height;
2302

    
2303
    /**
2304
     * frame skip threshold
2305
     * - encoding: Set by user.
2306
     * - decoding: unused
2307
     */
2308
    int frame_skip_threshold;
2309

    
2310
    /**
2311
     * frame skip factor
2312
     * - encoding: Set by user.
2313
     * - decoding: unused
2314
     */
2315
    int frame_skip_factor;
2316

    
2317
    /**
2318
     * frame skip exponent
2319
     * - encoding: Set by user.
2320
     * - decoding: unused
2321
     */
2322
    int frame_skip_exp;
2323

    
2324
    /**
2325
     * frame skip comparison function
2326
     * - encoding: Set by user.
2327
     * - decoding: unused
2328
     */
2329
    int frame_skip_cmp;
2330

    
2331
    /**
2332
     * Border processing masking, raises the quantizer for mbs on the borders
2333
     * of the picture.
2334
     * - encoding: Set by user.
2335
     * - decoding: unused
2336
     */
2337
    float border_masking;
2338

    
2339
    /**
2340
     * minimum MB lagrange multipler
2341
     * - encoding: Set by user.
2342
     * - decoding: unused
2343
     */
2344
    int mb_lmin;
2345

    
2346
    /**
2347
     * maximum MB lagrange multipler
2348
     * - encoding: Set by user.
2349
     * - decoding: unused
2350
     */
2351
    int mb_lmax;
2352

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

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

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

    
2374
    /**
2375
     *
2376
     * - encoding: unused
2377
     * - decoding: Set by user.
2378
     */
2379
    enum AVDiscard skip_frame;
2380

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

    
2388
    /**
2389
     *
2390
     * - encoding: Set by user.
2391
     * - decoding: unused
2392
     */
2393
    int brd_scale;
2394

    
2395
    /**
2396
     * constant rate factor - quality-based VBR - values ~correspond to qps
2397
     * - encoding: Set by user.
2398
     * - decoding: unused
2399
     */
2400
    float crf;
2401

    
2402
    /**
2403
     * constant quantization parameter rate control method
2404
     * - encoding: Set by user.
2405
     * - decoding: unused
2406
     */
2407
    int cqp;
2408

    
2409
    /**
2410
     * minimum GOP size
2411
     * - encoding: Set by user.
2412
     * - decoding: unused
2413
     */
2414
    int keyint_min;
2415

    
2416
    /**
2417
     * number of reference frames
2418
     * - encoding: Set by user.
2419
     * - decoding: Set by lavc.
2420
     */
2421
    int refs;
2422

    
2423
    /**
2424
     * chroma qp offset from luma
2425
     * - encoding: Set by user.
2426
     * - decoding: unused
2427
     */
2428
    int chromaoffset;
2429

    
2430
    /**
2431
     * Influences how often B-frames are used.
2432
     * - encoding: Set by user.
2433
     * - decoding: unused
2434
     */
2435
    int bframebias;
2436

    
2437
    /**
2438
     * trellis RD quantization
2439
     * - encoding: Set by user.
2440
     * - decoding: unused
2441
     */
2442
    int trellis;
2443

    
2444
    /**
2445
     * Reduce fluctuations in qp (before curve compression).
2446
     * - encoding: Set by user.
2447
     * - decoding: unused
2448
     */
2449
    float complexityblur;
2450

    
2451
    /**
2452
     * in-loop deblocking filter alphac0 parameter
2453
     * alpha is in the range -6...6
2454
     * - encoding: Set by user.
2455
     * - decoding: unused
2456
     */
2457
    int deblockalpha;
2458

    
2459
    /**
2460
     * in-loop deblocking filter beta parameter
2461
     * beta is in the range -6...6
2462
     * - encoding: Set by user.
2463
     * - decoding: unused
2464
     */
2465
    int deblockbeta;
2466

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

    
2479
    /**
2480
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2481
     * - encoding: Set by user.
2482
     * - decoding: unused
2483
     */
2484
    int directpred;
2485

    
2486
    /**
2487
     * Audio cutoff bandwidth (0 means "automatic")
2488
     * - encoding: Set by user.
2489
     * - decoding: unused
2490
     */
2491
    int cutoff;
2492

    
2493
    /**
2494
     * Multiplied by qscale for each frame and added to scene_change_score.
2495
     * - encoding: Set by user.
2496
     * - decoding: unused
2497
     */
2498
    int scenechange_factor;
2499

    
2500
    /**
2501
     *
2502
     * Note: Value depends upon the compare function used for fullpel ME.
2503
     * - encoding: Set by user.
2504
     * - decoding: unused
2505
     */
2506
    int mv0_threshold;
2507

    
2508
    /**
2509
     * Adjusts sensitivity of b_frame_strategy 1.
2510
     * - encoding: Set by user.
2511
     * - decoding: unused
2512
     */
2513
    int b_sensitivity;
2514

    
2515
    /**
2516
     * - encoding: Set by user.
2517
     * - decoding: unused
2518
     */
2519
    int compression_level;
2520
#define FF_COMPRESSION_DEFAULT -1
2521

    
2522
#if FF_API_USE_LPC
2523
    /**
2524
     * Sets whether to use LPC mode - used by FLAC encoder.
2525
     * - encoding: Set by user.
2526
     * - decoding: unused
2527
     * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2528
     */
2529
    int use_lpc;
2530
#endif
2531

    
2532
    /**
2533
     * LPC coefficient precision - used by FLAC encoder
2534
     * - encoding: Set by user.
2535
     * - decoding: unused
2536
     */
2537
    int lpc_coeff_precision;
2538

    
2539
    /**
2540
     * - encoding: Set by user.
2541
     * - decoding: unused
2542
     */
2543
    int min_prediction_order;
2544

    
2545
    /**
2546
     * - encoding: Set by user.
2547
     * - decoding: unused
2548
     */
2549
    int max_prediction_order;
2550

    
2551
    /**
2552
     * search method for selecting prediction order
2553
     * - encoding: Set by user.
2554
     * - decoding: unused
2555
     */
2556
    int prediction_order_method;
2557

    
2558
    /**
2559
     * - encoding: Set by user.
2560
     * - decoding: unused
2561
     */
2562
    int min_partition_order;
2563

    
2564
    /**
2565
     * - encoding: Set by user.
2566
     * - decoding: unused
2567
     */
2568
    int max_partition_order;
2569

    
2570
    /**
2571
     * GOP timecode frame start number, in non drop frame format
2572
     * - encoding: Set by user.
2573
     * - decoding: unused
2574
     */
2575
    int64_t timecode_frame_start;
2576

    
2577
#if LIBAVCODEC_VERSION_MAJOR < 53
2578
    /**
2579
     * Decoder should decode to this many channels if it can (0 for default)
2580
     * - encoding: unused
2581
     * - decoding: Set by user.
2582
     * @deprecated Deprecated in favor of request_channel_layout.
2583
     */
2584
    int request_channels;
2585
#endif
2586

    
2587
    /**
2588
     * Percentage of dynamic range compression to be applied by the decoder.
2589
     * The default value is 1.0, corresponding to full compression.
2590
     * - encoding: unused
2591
     * - decoding: Set by user.
2592
     */
2593
    float drc_scale;
2594

    
2595
    /**
2596
     * opaque 64bit number (generally a PTS) that will be reordered and
2597
     * output in AVFrame.reordered_opaque
2598
     * @deprecated in favor of pkt_pts
2599
     * - encoding: unused
2600
     * - decoding: Set by user.
2601
     */
2602
    int64_t reordered_opaque;
2603

    
2604
    /**
2605
     * Bits per sample/pixel of internal libavcodec pixel/sample format.
2606
     * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2607
     * - encoding: set by user.
2608
     * - decoding: set by libavcodec.
2609
     */
2610
    int bits_per_raw_sample;
2611

    
2612
    /**
2613
     * Audio channel layout.
2614
     * - encoding: set by user.
2615
     * - decoding: set by libavcodec.
2616
     */
2617
    int64_t channel_layout;
2618

    
2619
    /**
2620
     * Request decoder to use this channel layout if it can (0 for default)
2621
     * - encoding: unused
2622
     * - decoding: Set by user.
2623
     */
2624
    int64_t request_channel_layout;
2625

    
2626
    /**
2627
     * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2628
     * - encoding: Set by user.
2629
     * - decoding: unused.
2630
     */
2631
    float rc_max_available_vbv_use;
2632

    
2633
    /**
2634
     * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2635
     * - encoding: Set by user.
2636
     * - decoding: unused.
2637
     */
2638
    float rc_min_vbv_overflow_use;
2639

    
2640
    /**
2641
     * Hardware accelerator in use
2642
     * - encoding: unused.
2643
     * - decoding: Set by libavcodec
2644
     */
2645
    struct AVHWAccel *hwaccel;
2646

    
2647
    /**
2648
     * For some codecs, the time base is closer to the field rate than the frame rate.
2649
     * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2650
     * if no telecine is used ...
2651
     *
2652
     * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2653
     */
2654
    int ticks_per_frame;
2655

    
2656
    /**
2657
     * Hardware accelerator context.
2658
     * For some hardware accelerators, a global context needs to be
2659
     * provided by the user. In that case, this holds display-dependent
2660
     * data FFmpeg cannot instantiate itself. Please refer to the
2661
     * FFmpeg HW accelerator documentation to know how to fill this
2662
     * is. e.g. for VA API, this is a struct vaapi_context.
2663
     * - encoding: unused
2664
     * - decoding: Set by user
2665
     */
2666
    void *hwaccel_context;
2667

    
2668
    /**
2669
     * Chromaticity coordinates of the source primaries.
2670
     * - encoding: Set by user
2671
     * - decoding: Set by libavcodec
2672
     */
2673
    enum AVColorPrimaries color_primaries;
2674

    
2675
    /**
2676
     * Color Transfer Characteristic.
2677
     * - encoding: Set by user
2678
     * - decoding: Set by libavcodec
2679
     */
2680
    enum AVColorTransferCharacteristic color_trc;
2681

    
2682
    /**
2683
     * YUV colorspace type.
2684
     * - encoding: Set by user
2685
     * - decoding: Set by libavcodec
2686
     */
2687
    enum AVColorSpace colorspace;
2688

    
2689
    /**
2690
     * MPEG vs JPEG YUV range.
2691
     * - encoding: Set by user
2692
     * - decoding: Set by libavcodec
2693
     */
2694
    enum AVColorRange color_range;
2695

    
2696
    /**
2697
     * This defines the location of chroma samples.
2698
     * - encoding: Set by user
2699
     * - decoding: Set by libavcodec
2700
     */
2701
    enum AVChromaLocation chroma_sample_location;
2702

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

    
2723
    /**
2724
     * explicit P-frame weighted prediction analysis method
2725
     * 0: off
2726
     * 1: fast blind weighting (one reference duplicate with -1 offset)
2727
     * 2: smart weighting (full fade detection analysis)
2728
     * - encoding: Set by user.
2729
     * - decoding: unused
2730
     */
2731
    int weighted_p_pred;
2732

    
2733
    /**
2734
     * AQ mode
2735
     * 0: Disabled
2736
     * 1: Variance AQ (complexity mask)
2737
     * 2: Auto-variance AQ (experimental)
2738
     * - encoding: Set by user
2739
     * - decoding: unused
2740
     */
2741
    int aq_mode;
2742

    
2743
    /**
2744
     * AQ strength
2745
     * Reduces blocking and blurring in flat and textured areas.
2746
     * - encoding: Set by user
2747
     * - decoding: unused
2748
     */
2749
    float aq_strength;
2750

    
2751
    /**
2752
     * PSY RD
2753
     * Strength of psychovisual optimization
2754
     * - encoding: Set by user
2755
     * - decoding: unused
2756
     */
2757
    float psy_rd;
2758

    
2759
    /**
2760
     * PSY trellis
2761
     * Strength of psychovisual optimization
2762
     * - encoding: Set by user
2763
     * - decoding: unused
2764
     */
2765
    float psy_trellis;
2766

    
2767
    /**
2768
     * RC lookahead
2769
     * Number of frames for frametype and ratecontrol lookahead
2770
     * - encoding: Set by user
2771
     * - decoding: unused
2772
     */
2773
    int rc_lookahead;
2774

    
2775
    /**
2776
     * Constant rate factor maximum
2777
     * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2778
     * than crf_max, even if doing so would violate VBV restrictions.
2779
     * - encoding: Set by user.
2780
     * - decoding: unused
2781
     */
2782
    float crf_max;
2783

    
2784
    int log_level_offset;
2785

    
2786
    /**
2787
     * Determines which LPC analysis algorithm to use.
2788
     * - encoding: Set by user
2789
     * - decoding: unused
2790
     */
2791
    enum AVLPCType lpc_type;
2792

    
2793
    /**
2794
     * Number of passes to use for Cholesky factorization during LPC analysis
2795
     * - encoding: Set by user
2796
     * - decoding: unused
2797
     */
2798
    int lpc_passes;
2799

    
2800
    /**
2801
     * Number of slices.
2802
     * Indicates number of picture subdivisions. Used for parallelized
2803
     * decoding.
2804
     * - encoding: Set by user
2805
     * - decoding: unused
2806
     */
2807
    int slices;
2808

    
2809
    /**
2810
     * Header containing style information for text subtitles.
2811
     * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2812
     * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2813
     * the Format line following. It shouldn't include any Dialogue line.
2814
     * - encoding: Set/allocated/freed by user (before avcodec_open())
2815
     * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2816
     */
2817
    uint8_t *subtitle_header;
2818
    int subtitle_header_size;
2819

    
2820
    /**
2821
     * Current packet as passed into the decoder, to avoid having
2822
     * to pass the packet into every function. Currently only valid
2823
     * inside lavc and get/release_buffer callbacks.
2824
     * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2825
     * - encoding: unused
2826
     */
2827
    AVPacket *pkt;
2828
} AVCodecContext;
2829

    
2830
/**
2831
 * AVProfile.
2832
 */
2833
typedef struct AVProfile {
2834
    int profile;
2835
    const char *name; ///< short name for the profile
2836
} AVProfile;
2837

    
2838
/**
2839
 * AVCodec.
2840
 */
2841
typedef struct AVCodec {
2842
    /**
2843
     * Name of the codec implementation.
2844
     * The name is globally unique among encoders and among decoders (but an
2845
     * encoder and a decoder can share the same name).
2846
     * This is the primary way to find a codec from the user perspective.
2847
     */
2848
    const char *name;
2849
    enum AVMediaType type;
2850
    enum CodecID id;
2851
    int priv_data_size;
2852
    int (*init)(AVCodecContext *);
2853
    int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2854
    int (*close)(AVCodecContext *);
2855
    int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2856
    /**
2857
     * Codec capabilities.
2858
     * see CODEC_CAP_*
2859
     */
2860
    int capabilities;
2861
    struct AVCodec *next;
2862
    /**
2863
     * Flush buffers.
2864
     * Will be called when seeking
2865
     */
2866
    void (*flush)(AVCodecContext *);
2867
    const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2868
    const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2869
    /**
2870
     * Descriptive name for the codec, meant to be more human readable than name.
2871
     * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2872
     */
2873
    const char *long_name;
2874
    const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2875
    const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2876
    const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2877
    uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2878
    AVClass *priv_class;                    ///< AVClass for the private context
2879
    const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2880
} AVCodec;
2881

    
2882
/**
2883
 * AVHWAccel.
2884
 */
2885
typedef struct AVHWAccel {
2886
    /**
2887
     * Name of the hardware accelerated codec.
2888
     * The name is globally unique among encoders and among decoders (but an
2889
     * encoder and a decoder can share the same name).
2890
     */
2891
    const char *name;
2892

    
2893
    /**
2894
     * Type of codec implemented by the hardware accelerator.
2895
     *
2896
     * See AVMEDIA_TYPE_xxx
2897
     */
2898
    enum AVMediaType type;
2899

    
2900
    /**
2901
     * Codec implemented by the hardware accelerator.
2902
     *
2903
     * See CODEC_ID_xxx
2904
     */
2905
    enum CodecID id;
2906

    
2907
    /**
2908
     * Supported pixel format.
2909
     *
2910
     * Only hardware accelerated formats are supported here.
2911
     */
2912
    enum PixelFormat pix_fmt;
2913

    
2914
    /**
2915
     * Hardware accelerated codec capabilities.
2916
     * see FF_HWACCEL_CODEC_CAP_*
2917
     */
2918
    int capabilities;
2919

    
2920
    struct AVHWAccel *next;
2921

    
2922
    /**
2923
     * Called at the beginning of each frame or field picture.
2924
     *
2925
     * Meaningful frame information (codec specific) is guaranteed to
2926
     * be parsed at this point. This function is mandatory.
2927
     *
2928
     * Note that buf can be NULL along with buf_size set to 0.
2929
     * Otherwise, this means the whole frame is available at this point.
2930
     *
2931
     * @param avctx the codec context
2932
     * @param buf the frame data buffer base
2933
     * @param buf_size the size of the frame in bytes
2934
     * @return zero if successful, a negative value otherwise
2935
     */
2936
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2937

    
2938
    /**
2939
     * Callback for each slice.
2940
     *
2941
     * Meaningful slice information (codec specific) is guaranteed to
2942
     * be parsed at this point. This function is mandatory.
2943
     *
2944
     * @param avctx the codec context
2945
     * @param buf the slice data buffer base
2946
     * @param buf_size the size of the slice in bytes
2947
     * @return zero if successful, a negative value otherwise
2948
     */
2949
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2950

    
2951
    /**
2952
     * Called at the end of each frame or field picture.
2953
     *
2954
     * The whole picture is parsed at this point and can now be sent
2955
     * to the hardware accelerator. This function is mandatory.
2956
     *
2957
     * @param avctx the codec context
2958
     * @return zero if successful, a negative value otherwise
2959
     */
2960
    int (*end_frame)(AVCodecContext *avctx);
2961

    
2962
    /**
2963
     * Size of HW accelerator private data.
2964
     *
2965
     * Private data is allocated with av_mallocz() before
2966
     * AVCodecContext.get_buffer() and deallocated after
2967
     * AVCodecContext.release_buffer().
2968
     */
2969
    int priv_data_size;
2970
} AVHWAccel;
2971

    
2972
/**
2973
 * four components are given, that's all.
2974
 * the last component is alpha
2975
 */
2976
typedef struct AVPicture {
2977
    uint8_t *data[4];
2978
    int linesize[4];       ///< number of bytes per line
2979
} AVPicture;
2980

    
2981
#if FF_API_PALETTE_CONTROL
2982
/**
2983
 * AVPaletteControl
2984
 * This structure defines a method for communicating palette changes
2985
 * between and demuxer and a decoder.
2986
 *
2987
 * @deprecated Use AVPacket to send palette changes instead.
2988
 * This is totally broken.
2989
 */
2990
#define AVPALETTE_SIZE 1024
2991
#define AVPALETTE_COUNT 256
2992
typedef struct AVPaletteControl {
2993

    
2994
    /* Demuxer sets this to 1 to indicate the palette has changed;
2995
     * decoder resets to 0. */
2996
    int palette_changed;
2997

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

    
3004
} AVPaletteControl attribute_deprecated;
3005
#endif
3006

    
3007
enum AVSubtitleType {
3008
    SUBTITLE_NONE,
3009

    
3010
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3011

    
3012
    /**
3013
     * Plain text, the text field must be set by the decoder and is
3014
     * authoritative. ass and pict fields may contain approximations.
3015
     */
3016
    SUBTITLE_TEXT,
3017

    
3018
    /**
3019
     * Formatted text, the ass field must be set by the decoder and is
3020
     * authoritative. pict and text fields may contain approximations.
3021
     */
3022
    SUBTITLE_ASS,
3023
};
3024

    
3025
typedef struct AVSubtitleRect {
3026
    int x;         ///< top left corner  of pict, undefined when pict is not set
3027
    int y;         ///< top left corner  of pict, undefined when pict is not set
3028
    int w;         ///< width            of pict, undefined when pict is not set
3029
    int h;         ///< height           of pict, undefined when pict is not set
3030
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
3031

    
3032
    /**
3033
     * data+linesize for the bitmap of this subtitle.
3034
     * can be set for text/ass as well once they where rendered
3035
     */
3036
    AVPicture pict;
3037
    enum AVSubtitleType type;
3038

    
3039
    char *text;                     ///< 0 terminated plain UTF-8 text
3040

    
3041
    /**
3042
     * 0 terminated ASS/SSA compatible event line.
3043
     * The pressentation of this is unaffected by the other values in this
3044
     * struct.
3045
     */
3046
    char *ass;
3047
} AVSubtitleRect;
3048

    
3049
typedef struct AVSubtitle {
3050
    uint16_t format; /* 0 = graphics */
3051
    uint32_t start_display_time; /* relative to packet pts, in ms */
3052
    uint32_t end_display_time; /* relative to packet pts, in ms */
3053
    unsigned num_rects;
3054
    AVSubtitleRect **rects;
3055
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3056
} AVSubtitle;
3057

    
3058
/* packet functions */
3059

    
3060
/**
3061
 * @deprecated use NULL instead
3062
 */
3063
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3064

    
3065
/**
3066
 * Default packet destructor.
3067
 */
3068
void av_destruct_packet(AVPacket *pkt);
3069

    
3070
/**
3071
 * Initialize optional fields of a packet with default values.
3072
 *
3073
 * @param pkt packet
3074
 */
3075
void av_init_packet(AVPacket *pkt);
3076

    
3077
/**
3078
 * Allocate the payload of a packet and initialize its fields with
3079
 * default values.
3080
 *
3081
 * @param pkt packet
3082
 * @param size wanted payload size
3083
 * @return 0 if OK, AVERROR_xxx otherwise
3084
 */
3085
int av_new_packet(AVPacket *pkt, int size);
3086

    
3087
/**
3088
 * Reduce packet size, correctly zeroing padding
3089
 *
3090
 * @param pkt packet
3091
 * @param size new size
3092
 */
3093
void av_shrink_packet(AVPacket *pkt, int size);
3094

    
3095
/**
3096
 * Increase packet size, correctly zeroing padding
3097
 *
3098
 * @param pkt packet
3099
 * @param grow_by number of bytes by which to increase the size of the packet
3100
 */
3101
int av_grow_packet(AVPacket *pkt, int grow_by);
3102

    
3103
/**
3104
 * @warning This is a hack - the packet memory allocation stuff is broken. The
3105
 * packet is allocated if it was not really allocated.
3106
 */
3107
int av_dup_packet(AVPacket *pkt);
3108

    
3109
/**
3110
 * Free a packet.
3111
 *
3112
 * @param pkt packet to free
3113
 */
3114
void av_free_packet(AVPacket *pkt);
3115

    
3116
/* resample.c */
3117

    
3118
struct ReSampleContext;
3119
struct AVResampleContext;
3120

    
3121
typedef struct ReSampleContext ReSampleContext;
3122

    
3123
#if FF_API_AUDIO_OLD
3124
/**
3125
 * @deprecated Use av_audio_resample_init() instead.
3126
 */
3127
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3128
                                                          int output_rate, int input_rate);
3129
#endif
3130
/**
3131
 *  Initialize audio resampling context
3132
 *
3133
 * @param output_channels  number of output channels
3134
 * @param input_channels   number of input channels
3135
 * @param output_rate      output sample rate
3136
 * @param input_rate       input sample rate
3137
 * @param sample_fmt_out   requested output sample format
3138
 * @param sample_fmt_in    input sample format
3139
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
3140
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3141
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
3142
                           between the 2 closest, if 0 the closest will be used
3143
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3144
 * @return allocated ReSampleContext, NULL if error occured
3145
 */
3146
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3147
                                        int output_rate, int input_rate,
3148
                                        enum AVSampleFormat sample_fmt_out,
3149
                                        enum AVSampleFormat sample_fmt_in,
3150
                                        int filter_length, int log2_phase_count,
3151
                                        int linear, double cutoff);
3152

    
3153
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3154
void audio_resample_close(ReSampleContext *s);
3155

    
3156

    
3157
/**
3158
 * Initialize an audio resampler.
3159
 * Note, if either rate is not an integer then simply scale both rates up so they are.
3160
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3161
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3162
 * @param linear If 1 then the used FIR filter will be linearly interpolated
3163
                 between the 2 closest, if 0 the closest will be used
3164
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3165
 */
3166
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3167

    
3168
/**
3169
 * Resample an array of samples using a previously configured context.
3170
 * @param src an array of unconsumed samples
3171
 * @param consumed the number of samples of src which have been consumed are returned here
3172
 * @param src_size the number of unconsumed samples available
3173
 * @param dst_size the amount of space in samples available in dst
3174
 * @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.
3175
 * @return the number of samples written in dst or -1 if an error occurred
3176
 */
3177
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3178

    
3179

    
3180
/**
3181
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3182
 * the resampler parameters, so no audible clicks or similar distortions occur
3183
 * @param compensation_distance distance in output samples over which the compensation should be performed
3184
 * @param sample_delta number of output samples which should be output less
3185
 *
3186
 * example: av_resample_compensate(c, 10, 500)
3187
 * here instead of 510 samples only 500 samples would be output
3188
 *
3189
 * note, due to rounding the actual compensation might be slightly different,
3190
 * especially if the compensation_distance is large and the in_rate used during init is small
3191
 */
3192
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3193
void av_resample_close(struct AVResampleContext *c);
3194

    
3195
/**
3196
 * Allocate memory for a picture.  Call avpicture_free to free it.
3197
 *
3198
 * @param picture the picture to be filled in
3199
 * @param pix_fmt the format of the picture
3200
 * @param width the width of the picture
3201
 * @param height the height of the picture
3202
 * @return zero if successful, a negative value if not
3203
 */
3204
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3205

    
3206
/**
3207
 * Free a picture previously allocated by avpicture_alloc().
3208
 *
3209
 * @param picture the AVPicture to be freed
3210
 */
3211
void avpicture_free(AVPicture *picture);
3212

    
3213
/**
3214
 * Fill in the AVPicture fields.
3215
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3216
 * which points to the image data buffer. Depending on the specified picture
3217
 * format, one or multiple image data pointers and line sizes will be set.
3218
 * If a planar format is specified, several pointers will be set pointing to
3219
 * the different picture planes and the line sizes of the different planes
3220
 * will be stored in the lines_sizes array.
3221
 * Call with ptr == NULL to get the required size for the ptr buffer.
3222
 *
3223
 * @param picture AVPicture whose fields are to be filled in
3224
 * @param ptr Buffer which will contain or contains the actual image data
3225
 * @param pix_fmt The format in which the picture data is stored.
3226
 * @param width the width of the image in pixels
3227
 * @param height the height of the image in pixels
3228
 * @return size of the image data in bytes
3229
 */
3230
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3231
                   enum PixelFormat pix_fmt, int width, int height);
3232
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3233
                     unsigned char *dest, int dest_size);
3234

    
3235
/**
3236
 * Calculate the size in bytes that a picture of the given width and height
3237
 * would occupy if stored in the given picture format.
3238
 * Note that this returns the size of a compact representation as generated
3239
 * by avpicture_layout, which can be smaller than the size required for e.g.
3240
 * avpicture_fill.
3241
 *
3242
 * @param pix_fmt the given picture format
3243
 * @param width the width of the image
3244
 * @param height the height of the image
3245
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3246
 */
3247
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3248
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3249
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3250
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3251

    
3252
#if LIBAVCODEC_VERSION_MAJOR < 53
3253
/**
3254
 * Return the pixel format corresponding to the name name.
3255
 *
3256
 * If there is no pixel format with name name, then look for a
3257
 * pixel format with the name corresponding to the native endian
3258
 * format of name.
3259
 * For example in a little-endian system, first look for "gray16",
3260
 * then for "gray16le".
3261
 *
3262
 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3263
 *
3264
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3265
 */
3266
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3267
#endif
3268

    
3269
/**
3270
 * Return a value representing the fourCC code associated to the
3271
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3272
 * found.
3273
 */
3274
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3275

    
3276
/**
3277
 * Put a string representing the codec tag codec_tag in buf.
3278
 *
3279
 * @param buf_size size in bytes of buf
3280
 * @return the length of the string that would have been generated if
3281
 * enough space had been available, excluding the trailing null
3282
 */
3283
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3284

    
3285
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3286
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3287
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3288
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3289
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3290
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3291

    
3292
/**
3293
 * Compute what kind of losses will occur when converting from one specific
3294
 * pixel format to another.
3295
 * When converting from one pixel format to another, information loss may occur.
3296
 * For example, when converting from RGB24 to GRAY, the color information will
3297
 * be lost. Similarly, other losses occur when converting from some formats to
3298
 * other formats. These losses can involve loss of chroma, but also loss of
3299
 * resolution, loss of color depth, loss due to the color space conversion, loss
3300
 * of the alpha bits or loss due to color quantization.
3301
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3302
 * which will occur when converting from one pixel format to another.
3303
 *
3304
 * @param[in] dst_pix_fmt destination pixel format
3305
 * @param[in] src_pix_fmt source pixel format
3306
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3307
 * @return Combination of flags informing you what kind of losses will occur.
3308
 */
3309
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3310
                             int has_alpha);
3311

    
3312
/**
3313
 * Find the best pixel format to convert to given a certain source pixel
3314
 * format.  When converting from one pixel format to another, information loss
3315
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3316
 * information will be lost. Similarly, other losses occur when converting from
3317
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3318
 * the given pixel formats should be used to suffer the least amount of loss.
3319
 * The pixel formats from which it chooses one, are determined by the
3320
 * pix_fmt_mask parameter.
3321
 *
3322
 * @code
3323
 * src_pix_fmt = PIX_FMT_YUV420P;
3324
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3325
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3326
 * @endcode
3327
 *
3328
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3329
 * @param[in] src_pix_fmt source pixel format
3330
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3331
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3332
 * @return The best pixel format to convert to or -1 if none was found.
3333
 */
3334
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3335
                              int has_alpha, int *loss_ptr);
3336

    
3337
#if LIBAVCODEC_VERSION_MAJOR < 53
3338
/**
3339
 * @deprecated Use av_get_pix_fmt_string() instead.
3340
 */
3341
attribute_deprecated
3342
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3343
#endif
3344

    
3345
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3346
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3347

    
3348
/**
3349
 * Tell if an image really has transparent alpha values.
3350
 * @return ored mask of FF_ALPHA_xxx constants
3351
 */
3352
int img_get_alpha_info(const AVPicture *src,
3353
                       enum PixelFormat pix_fmt, int width, int height);
3354

    
3355
/* deinterlace a picture */
3356
/* deinterlace - if not supported return -1 */
3357
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3358
                          enum PixelFormat pix_fmt, int width, int height);
3359

    
3360
/* external high level API */
3361

    
3362
/**
3363
 * If c is NULL, returns the first registered codec,
3364
 * if c is non-NULL, returns the next registered codec after c,
3365
 * or NULL if c is the last one.
3366
 */
3367
AVCodec *av_codec_next(AVCodec *c);
3368

    
3369
/**
3370
 * Return the LIBAVCODEC_VERSION_INT constant.
3371
 */
3372
unsigned avcodec_version(void);
3373

    
3374
/**
3375
 * Return the libavcodec build-time configuration.
3376
 */
3377
const char *avcodec_configuration(void);
3378

    
3379
/**
3380
 * Return the libavcodec license.
3381
 */
3382
const char *avcodec_license(void);
3383

    
3384
/**
3385
 * Initialize libavcodec.
3386
 *
3387
 * @warning This function must be called before any other libavcodec
3388
 * function.
3389
 */
3390
void avcodec_init(void);
3391

    
3392
#if LIBAVCODEC_VERSION_MAJOR < 53
3393
/**
3394
 * @deprecated Deprecated in favor of avcodec_register().
3395
 */
3396
attribute_deprecated void register_avcodec(AVCodec *codec);
3397
#endif
3398

    
3399
/**
3400
 * Register the codec codec and initialize libavcodec.
3401
 *
3402
 * @see avcodec_init()
3403
 */
3404
void avcodec_register(AVCodec *codec);
3405

    
3406
/**
3407
 * Find a registered encoder with a matching codec ID.
3408
 *
3409
 * @param id CodecID of the requested encoder
3410
 * @return An encoder if one was found, NULL otherwise.
3411
 */
3412
AVCodec *avcodec_find_encoder(enum CodecID id);
3413

    
3414
/**
3415
 * Find a registered encoder with the specified name.
3416
 *
3417
 * @param name name of the requested encoder
3418
 * @return An encoder if one was found, NULL otherwise.
3419
 */
3420
AVCodec *avcodec_find_encoder_by_name(const char *name);
3421

    
3422
/**
3423
 * Find a registered decoder with a matching codec ID.
3424
 *
3425
 * @param id CodecID of the requested decoder
3426
 * @return A decoder if one was found, NULL otherwise.
3427
 */
3428
AVCodec *avcodec_find_decoder(enum CodecID id);
3429

    
3430
/**
3431
 * Find a registered decoder with the specified name.
3432
 *
3433
 * @param name name of the requested decoder
3434
 * @return A decoder if one was found, NULL otherwise.
3435
 */
3436
AVCodec *avcodec_find_decoder_by_name(const char *name);
3437
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3438

    
3439
/**
3440
 * Return a name for the specified profile, if available.
3441
 *
3442
 * @param codec the codec that is searched for the given profile
3443
 * @param profile the profile value for which a name is requested
3444
 * @return A name for the profile if found, NULL otherwise.
3445
 */
3446
const char *av_get_profile_name(const AVCodec *codec, int profile);
3447

    
3448
/**
3449
 * Set the fields of the given AVCodecContext to default values.
3450
 *
3451
 * @param s The AVCodecContext of which the fields should be set to default values.
3452
 */
3453
void avcodec_get_context_defaults(AVCodecContext *s);
3454

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

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

    
3463
/**
3464
 * Allocate an AVCodecContext and set its fields to default values.  The
3465
 * resulting struct can be deallocated by simply calling av_free().
3466
 *
3467
 * @return An AVCodecContext filled with default values or NULL on failure.
3468
 * @see avcodec_get_context_defaults
3469
 */
3470
AVCodecContext *avcodec_alloc_context(void);
3471

    
3472
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3473
 *  we WILL change its arguments and name a few times! */
3474
AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3475

    
3476
/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3477
 *  we WILL change its arguments and name a few times! */
3478
AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3479

    
3480
/**
3481
 * Copy the settings of the source AVCodecContext into the destination
3482
 * AVCodecContext. The resulting destination codec context will be
3483
 * unopened, i.e. you are required to call avcodec_open() before you
3484
 * can use this AVCodecContext to decode/encode video/audio data.
3485
 *
3486
 * @param dest target codec context, should be initialized with
3487
 *             avcodec_alloc_context(), but otherwise uninitialized
3488
 * @param src source codec context
3489
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3490
 */
3491
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3492

    
3493
/**
3494
 * Set the fields of the given AVFrame to default values.
3495
 *
3496
 * @param pic The AVFrame of which the fields should be set to default values.
3497
 */
3498
void avcodec_get_frame_defaults(AVFrame *pic);
3499

    
3500
/**
3501
 * Allocate an AVFrame and set its fields to default values.  The resulting
3502
 * struct can be deallocated by simply calling av_free().
3503
 *
3504
 * @return An AVFrame filled with default values or NULL on failure.
3505
 * @see avcodec_get_frame_defaults
3506
 */
3507
AVFrame *avcodec_alloc_frame(void);
3508

    
3509
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3510
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3511
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3512

    
3513
/**
3514
 * Return the amount of padding in pixels which the get_buffer callback must
3515
 * provide around the edge of the image for codecs which do not have the
3516
 * CODEC_FLAG_EMU_EDGE flag.
3517
 *
3518
 * @return Required padding in pixels.
3519
 */
3520
unsigned avcodec_get_edge_width(void);
3521
/**
3522
 * Modify width and height values so that they will result in a memory
3523
 * buffer that is acceptable for the codec if you do not use any horizontal
3524
 * padding.
3525
 *
3526
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3527
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3528
 * according to avcodec_get_edge_width() before.
3529
 */
3530
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3531
/**
3532
 * Modify width and height values so that they will result in a memory
3533
 * buffer that is acceptable for the codec if you also ensure that all
3534
 * line sizes are a multiple of the respective linesize_align[i].
3535
 *
3536
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3537
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3538
 * according to avcodec_get_edge_width() before.
3539
 */
3540
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3541
                               int linesize_align[4]);
3542

    
3543
#if LIBAVCODEC_VERSION_MAJOR < 53
3544
/**
3545
 * @deprecated Deprecated in favor of av_check_image_size().
3546
 */
3547
attribute_deprecated
3548
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3549
#endif
3550

    
3551
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3552

    
3553
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3554
void avcodec_thread_free(AVCodecContext *s);
3555
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3556
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3557
//FIXME func typedef
3558

    
3559
/**
3560
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3561
 * function the context has to be allocated.
3562
 *
3563
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3564
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3565
 * retrieving a codec.
3566
 *
3567
 * @warning This function is not thread safe!
3568
 *
3569
 * @code
3570
 * avcodec_register_all();
3571
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3572
 * if (!codec)
3573
 *     exit(1);
3574
 *
3575
 * context = avcodec_alloc_context();
3576
 *
3577
 * if (avcodec_open(context, codec) < 0)
3578
 *     exit(1);
3579
 * @endcode
3580
 *
3581
 * @param avctx The context which will be set up to use the given codec.
3582
 * @param codec The codec to use within the context.
3583
 * @return zero on success, a negative value on error
3584
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3585
 */
3586
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3587

    
3588
#if FF_API_AUDIO_OLD
3589
/**
3590
 * Decode an audio frame from buf into samples.
3591
 * Wrapper function which calls avcodec_decode_audio3.
3592
 *
3593
 * @deprecated Use avcodec_decode_audio3 instead.
3594
 * @param avctx the codec context
3595
 * @param[out] samples the output buffer
3596
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3597
 * @param[in] buf the input buffer
3598
 * @param[in] buf_size the input buffer size in bytes
3599
 * @return On error a negative value is returned, otherwise the number of bytes
3600
 * used or zero if no frame could be decompressed.
3601
 */
3602
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3603
                         int *frame_size_ptr,
3604
                         const uint8_t *buf, int buf_size);
3605
#endif
3606

    
3607
/**
3608
 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3609
 * Some decoders may support multiple frames in a single AVPacket, such
3610
 * decoders would then just decode the first frame. In this case,
3611
 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3612
 * the remaining data in order to decode the second frame etc.
3613
 * If no frame
3614
 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3615
 * decompressed frame size in bytes.
3616
 *
3617
 * @warning You must set frame_size_ptr to the allocated size of the
3618
 * output buffer before calling avcodec_decode_audio3().
3619
 *
3620
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3621
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3622
 * bits at once and could read over the end.
3623
 *
3624
 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3625
 * no overreading happens for damaged MPEG streams.
3626
 *
3627
 * @note You might have to align the input buffer avpkt->data and output buffer
3628
 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3629
 * necessary at all, on others it won't work at all if not aligned and on others
3630
 * it will work but it will have an impact on performance.
3631
 *
3632
 * In practice, avpkt->data should have 4 byte alignment at minimum and
3633
 * samples should be 16 byte aligned unless the CPU doesn't need it
3634
 * (AltiVec and SSE do).
3635
 *
3636
 * @param avctx the codec context
3637
 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3638
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3639
 * @param[in] avpkt The input AVPacket containing the input buffer.
3640
 *            You can create such packet with av_init_packet() and by then setting
3641
 *            data and size, some decoders might in addition need other fields.
3642
 *            All decoders are designed to use the least fields possible though.
3643
 * @return On error a negative value is returned, otherwise the number of bytes
3644
 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3645
 */
3646
int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3647
                         int *frame_size_ptr,
3648
                         AVPacket *avpkt);
3649

    
3650
#if FF_API_VIDEO_OLD
3651
/**
3652
 * Decode a video frame from buf into picture.
3653
 * Wrapper function which calls avcodec_decode_video2.
3654
 *
3655
 * @deprecated Use avcodec_decode_video2 instead.
3656
 * @param avctx the codec context
3657
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3658
 * @param[in] buf the input buffer
3659
 * @param[in] buf_size the size of the input buffer in bytes
3660
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3661
 * @return On error a negative value is returned, otherwise the number of bytes
3662
 * used or zero if no frame could be decompressed.
3663
 */
3664
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3665
                         int *got_picture_ptr,
3666
                         const uint8_t *buf, int buf_size);
3667
#endif
3668

    
3669
/**
3670
 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3671
 * Some decoders may support multiple frames in a single AVPacket, such
3672
 * decoders would then just decode the first frame.
3673
 *
3674
 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3675
 * the actual read bytes because some optimized bitstream readers read 32 or 64
3676
 * bits at once and could read over the end.
3677
 *
3678
 * @warning The end of the input buffer buf should be set to 0 to ensure that
3679
 * no overreading happens for damaged MPEG streams.
3680
 *
3681
 * @note You might have to align the input buffer avpkt->data.
3682
 * The alignment requirements depend on the CPU: on some CPUs it isn't
3683
 * necessary at all, on others it won't work at all if not aligned and on others
3684
 * it will work but it will have an impact on performance.
3685
 *
3686
 * In practice, avpkt->data should have 4 byte alignment at minimum.
3687
 *
3688
 * @note Some codecs have a delay between input and output, these need to be
3689
 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3690
 *
3691
 * @param avctx the codec context
3692
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3693
 *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3694
 *             allocate memory for the actual bitmap.
3695
 *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3696
 *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3697
 *                   decodes and the decoder tells the user once it does not need the data anymore,
3698
 *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3699
 *
3700
 * @param[in] avpkt The input AVpacket containing the input buffer.
3701
 *            You can create such packet with av_init_packet() and by then setting
3702
 *            data and size, some decoders might in addition need other fields like
3703
 *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3704
 *            fields possible.
3705
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3706
 * @return On error a negative value is returned, otherwise the number of bytes
3707
 * used or zero if no frame could be decompressed.
3708
 */
3709
int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3710
                         int *got_picture_ptr,
3711
                         AVPacket *avpkt);
3712

    
3713
#if FF_API_SUBTITLE_OLD
3714
/* Decode a subtitle message. Return -1 if error, otherwise return the
3715
 * number of bytes used. If no subtitle could be decompressed,
3716
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3717
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3718
                            int *got_sub_ptr,
3719
                            const uint8_t *buf, int buf_size);
3720
#endif
3721

    
3722
/**
3723
 * Decode a subtitle message.
3724
 * Return a negative value on error, otherwise return the number of bytes used.
3725
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3726
 * Otherwise, the subtitle is stored in *sub.
3727
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3728
 * simplicity, because the performance difference is expect to be negligible
3729
 * and reusing a get_buffer written for video codecs would probably perform badly
3730
 * due to a potentially very different allocation pattern.
3731
 *
3732
 * @param avctx the codec context
3733
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3734
                   freed with avsubtitle_free if *got_sub_ptr is set.
3735
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3736
 * @param[in] avpkt The input AVPacket containing the input buffer.
3737
 */
3738
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3739
                            int *got_sub_ptr,
3740
                            AVPacket *avpkt);
3741

    
3742
/**
3743
 * Frees all allocated data in the given subtitle struct.
3744
 *
3745
 * @param sub AVSubtitle to free.
3746
 */
3747
void avsubtitle_free(AVSubtitle *sub);
3748

    
3749
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3750
                        int *data_size_ptr,
3751
                        uint8_t *buf, int buf_size);
3752

    
3753
/**
3754
 * Encode an audio frame from samples into buf.
3755
 *
3756
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3757
 * However, for PCM audio the user will know how much space is needed
3758
 * because it depends on the value passed in buf_size as described
3759
 * below. In that case a lower value can be used.
3760
 *
3761
 * @param avctx the codec context
3762
 * @param[out] buf the output buffer
3763
 * @param[in] buf_size the output buffer size
3764
 * @param[in] samples the input buffer containing the samples
3765
 * The number of samples read from this buffer is frame_size*channels,
3766
 * both of which are defined in avctx.
3767
 * For PCM audio the number of samples read from samples is equal to
3768
 * buf_size * input_sample_size / output_sample_size.
3769
 * @return On error a negative value is returned, on success zero or the number
3770
 * of bytes used to encode the data read from the input buffer.
3771
 */
3772
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3773
                         const short *samples);
3774

    
3775
/**
3776
 * Encode a video frame from pict into buf.
3777
 * The input picture should be
3778
 * stored using a specific format, namely avctx.pix_fmt.
3779
 *
3780
 * @param avctx the codec context
3781
 * @param[out] buf the output buffer for the bitstream of encoded frame
3782
 * @param[in] buf_size the size of the output buffer in bytes
3783
 * @param[in] pict the input picture to encode
3784
 * @return On error a negative value is returned, on success zero or the number
3785
 * of bytes used from the output buffer.
3786
 */
3787
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3788
                         const AVFrame *pict);
3789
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3790
                            const AVSubtitle *sub);
3791

    
3792
int avcodec_close(AVCodecContext *avctx);
3793

    
3794
/**
3795
 * Register all the codecs, parsers and bitstream filters which were enabled at
3796
 * configuration time. If you do not call this function you can select exactly
3797
 * which formats you want to support, by using the individual registration
3798
 * functions.
3799
 *
3800
 * @see avcodec_register
3801
 * @see av_register_codec_parser
3802
 * @see av_register_bitstream_filter
3803
 */
3804
void avcodec_register_all(void);
3805

    
3806
/**
3807
 * Flush buffers, should be called when seeking or when switching to a different stream.
3808
 */
3809
void avcodec_flush_buffers(AVCodecContext *avctx);
3810

    
3811
void avcodec_default_free_buffers(AVCodecContext *s);
3812

    
3813
/* misc useful functions */
3814

    
3815
/**
3816
 * Return a single letter to describe the given picture type pict_type.
3817
 *
3818
 * @param[in] pict_type the picture type
3819
 * @return A single character representing the picture type.
3820
 */
3821
char av_get_pict_type_char(int pict_type);
3822

    
3823
/**
3824
 * Return codec bits per sample.
3825
 *
3826
 * @param[in] codec_id the codec
3827
 * @return Number of bits per sample or zero if unknown for the given codec.
3828
 */
3829
int av_get_bits_per_sample(enum CodecID codec_id);
3830

    
3831
#if FF_API_OLD_SAMPLE_FMT
3832
/**
3833
 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3834
 */
3835
attribute_deprecated
3836
int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3837
#endif
3838

    
3839
/* frame parsing */
3840
typedef struct AVCodecParserContext {
3841
    void *priv_data;
3842
    struct AVCodecParser *parser;
3843
    int64_t frame_offset; /* offset of the current frame */
3844
    int64_t cur_offset; /* current offset
3845
                           (incremented by each av_parser_parse()) */
3846
    int64_t next_frame_offset; /* offset of the next frame */
3847
    /* video info */
3848
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3849
    /**
3850
     * This field is used for proper frame duration computation in lavf.
3851
     * It signals, how much longer the frame duration of the current frame
3852
     * is compared to normal frame duration.
3853
     *
3854
     * frame_duration = (1 + repeat_pict) * time_base
3855
     *
3856
     * It is used by codecs like H.264 to display telecined material.
3857
     */
3858
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3859
    int64_t pts;     /* pts of the current frame */
3860
    int64_t dts;     /* dts of the current frame */
3861

    
3862
    /* private data */
3863
    int64_t last_pts;
3864
    int64_t last_dts;
3865
    int fetch_timestamp;
3866

    
3867
#define AV_PARSER_PTS_NB 4
3868
    int cur_frame_start_index;
3869
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3870
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3871
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3872

    
3873
    int flags;
3874
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3875
#define PARSER_FLAG_ONCE                      0x0002
3876
/// Set if the parser has a valid file offset
3877
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
3878

    
3879
    int64_t offset;      ///< byte offset from starting packet start
3880
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3881

    
3882
    /*!
3883
     * Set by parser to 1 for key frames and 0 for non-key frames.
3884
     * It is initialized to -1, so if the parser doesn't set this flag,
3885
     * old-style fallback using FF_I_TYPE picture type as key frames
3886
     * will be used.
3887
     */
3888
    int key_frame;
3889

    
3890
    /**
3891
     * Time difference in stream time base units from the pts of this
3892
     * packet to the point at which the output from the decoder has converged
3893
     * independent from the availability of previous frames. That is, the
3894
     * frames are virtually identical no matter if decoding started from
3895
     * the very first frame or from this keyframe.
3896
     * Is AV_NOPTS_VALUE if unknown.
3897
     * This field is not the display duration of the current frame.
3898
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3899
     * set.
3900
     *
3901
     * The purpose of this field is to allow seeking in streams that have no
3902
     * keyframes in the conventional sense. It corresponds to the
3903
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3904
     * essential for some types of subtitle streams to ensure that all
3905
     * subtitles are correctly displayed after seeking.
3906
     */
3907
    int64_t convergence_duration;
3908

    
3909
    // Timestamp generation support:
3910
    /**
3911
     * Synchronization point for start of timestamp generation.
3912
     *
3913
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3914
     * (default).
3915
     *
3916
     * For example, this corresponds to presence of H.264 buffering period
3917
     * SEI message.
3918
     */
3919
    int dts_sync_point;
3920

    
3921
    /**
3922
     * Offset of the current timestamp against last timestamp sync point in
3923
     * units of AVCodecContext.time_base.
3924
     *
3925
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3926
     * contain a valid timestamp offset.
3927
     *
3928
     * Note that the timestamp of sync point has usually a nonzero
3929
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3930
     * the next frame after timestamp sync point will be usually 1.
3931
     *
3932
     * For example, this corresponds to H.264 cpb_removal_delay.
3933
     */
3934
    int dts_ref_dts_delta;
3935

    
3936
    /**
3937
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3938
     *
3939
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3940
     * contain valid non-negative timestamp delta (presentation time of a frame
3941
     * must not lie in the past).
3942
     *
3943
     * This delay represents the difference between decoding and presentation
3944
     * time of the frame.
3945
     *
3946
     * For example, this corresponds to H.264 dpb_output_delay.
3947
     */
3948
    int pts_dts_delta;
3949

    
3950
    /**
3951
     * Position of the packet in file.
3952
     *
3953
     * Analogous to cur_frame_pts/dts
3954
     */
3955
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3956

    
3957
    /**
3958
     * Byte position of currently parsed frame in stream.
3959
     */
3960
    int64_t pos;
3961

    
3962
    /**
3963
     * Previous frame byte position.
3964
     */
3965
    int64_t last_pos;
3966
} AVCodecParserContext;
3967

    
3968
typedef struct AVCodecParser {
3969
    int codec_ids[5]; /* several codec IDs are permitted */
3970
    int priv_data_size;
3971
    int (*parser_init)(AVCodecParserContext *s);
3972
    int (*parser_parse)(AVCodecParserContext *s,
3973
                        AVCodecContext *avctx,
3974
                        const uint8_t **poutbuf, int *poutbuf_size,
3975
                        const uint8_t *buf, int buf_size);
3976
    void (*parser_close)(AVCodecParserContext *s);
3977
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3978
    struct AVCodecParser *next;
3979
} AVCodecParser;
3980

    
3981
AVCodecParser *av_parser_next(AVCodecParser *c);
3982

    
3983
void av_register_codec_parser(AVCodecParser *parser);
3984
AVCodecParserContext *av_parser_init(int codec_id);
3985

    
3986
#if LIBAVCODEC_VERSION_MAJOR < 53
3987
attribute_deprecated
3988
int av_parser_parse(AVCodecParserContext *s,
3989
                    AVCodecContext *avctx,
3990
                    uint8_t **poutbuf, int *poutbuf_size,
3991
                    const uint8_t *buf, int buf_size,
3992
                    int64_t pts, int64_t dts);
3993
#endif
3994

    
3995
/**
3996
 * Parse a packet.
3997
 *
3998
 * @param s             parser context.
3999
 * @param avctx         codec context.
4000
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4001
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4002
 * @param buf           input buffer.
4003
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4004
 * @param pts           input presentation timestamp.
4005
 * @param dts           input decoding timestamp.
4006
 * @param pos           input byte position in stream.
4007
 * @return the number of bytes of the input bitstream used.
4008
 *
4009
 * Example:
4010
 * @code
4011
 *   while(in_len){
4012
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4013
 *                                        in_data, in_len,
4014
 *                                        pts, dts, pos);
4015
 *       in_data += len;
4016
 *       in_len  -= len;
4017
 *
4018
 *       if(size)
4019
 *          decode_frame(data, size);
4020
 *   }
4021
 * @endcode
4022
 */
4023
int av_parser_parse2(AVCodecParserContext *s,
4024
                     AVCodecContext *avctx,
4025
                     uint8_t **poutbuf, int *poutbuf_size,
4026
                     const uint8_t *buf, int buf_size,
4027
                     int64_t pts, int64_t dts,
4028
                     int64_t pos);
4029

    
4030
int av_parser_change(AVCodecParserContext *s,
4031
                     AVCodecContext *avctx,
4032
                     uint8_t **poutbuf, int *poutbuf_size,
4033
                     const uint8_t *buf, int buf_size, int keyframe);
4034
void av_parser_close(AVCodecParserContext *s);
4035

    
4036

    
4037
typedef struct AVBitStreamFilterContext {
4038
    void *priv_data;
4039
    struct AVBitStreamFilter *filter;
4040
    AVCodecParserContext *parser;
4041
    struct AVBitStreamFilterContext *next;
4042
} AVBitStreamFilterContext;
4043

    
4044

    
4045
typedef struct AVBitStreamFilter {
4046
    const char *name;
4047
    int priv_data_size;
4048
    int (*filter)(AVBitStreamFilterContext *bsfc,
4049
                  AVCodecContext *avctx, const char *args,
4050
                  uint8_t **poutbuf, int *poutbuf_size,
4051
                  const uint8_t *buf, int buf_size, int keyframe);
4052
    void (*close)(AVBitStreamFilterContext *bsfc);
4053
    struct AVBitStreamFilter *next;
4054
} AVBitStreamFilter;
4055

    
4056
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4057
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4058
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4059
                               AVCodecContext *avctx, const char *args,
4060
                               uint8_t **poutbuf, int *poutbuf_size,
4061
                               const uint8_t *buf, int buf_size, int keyframe);
4062
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4063

    
4064
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4065

    
4066
/* memory */
4067

    
4068
/**
4069
 * Reallocate the given block if it is not large enough, otherwise do nothing.
4070
 *
4071
 * @see av_realloc
4072
 */
4073
void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4074

    
4075
/**
4076
 * Allocate a buffer, reusing the given one if large enough.
4077
 *
4078
 * Contrary to av_fast_realloc the current buffer contents might not be
4079
 * preserved and on error the old buffer is freed, thus no special
4080
 * handling to avoid memleaks is necessary.
4081
 *
4082
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4083
 * @param size size of the buffer *ptr points to
4084
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4085
 *                 *size 0 if an error occurred.
4086
 */
4087
void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4088

    
4089
#if LIBAVCODEC_VERSION_MAJOR < 53
4090
/**
4091
 * @deprecated Deprecated in favor of av_image_copy().
4092
 */
4093
attribute_deprecated
4094
void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4095
                          uint8_t *src_data[4], int src_linesize[4],
4096
                          enum PixelFormat pix_fmt, int width, int height);
4097
#endif
4098

    
4099
/**
4100
 * Copy image src to dst. Wraps av_picture_data_copy() above.
4101
 */
4102
void av_picture_copy(AVPicture *dst, const AVPicture *src,
4103
                     enum PixelFormat pix_fmt, int width, int height);
4104

    
4105
/**
4106
 * Crop image top and left side.
4107
 */
4108
int av_picture_crop(AVPicture *dst, const AVPicture *src,
4109
                    enum PixelFormat pix_fmt, int top_band, int left_band);
4110

    
4111
/**
4112
 * Pad image.
4113
 */
4114
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4115
            int padtop, int padbottom, int padleft, int padright, int *color);
4116

    
4117
/**
4118
 * Encode extradata length to a buffer. Used by xiph codecs.
4119
 *
4120
 * @param s buffer to write to; must be at least (v/255+1) bytes long
4121
 * @param v size of extradata in bytes
4122
 * @return number of bytes written to the buffer.
4123
 */
4124
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4125

    
4126
#if LIBAVCODEC_VERSION_MAJOR < 53
4127
/**
4128
 * Parse str and put in width_ptr and height_ptr the detected values.
4129
 *
4130
 * @deprecated Deprecated in favor of av_parse_video_size().
4131
 */
4132
attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4133

    
4134
/**
4135
 * Parse str and store the detected values in *frame_rate.
4136
 *
4137
 * @deprecated Deprecated in favor of av_parse_video_rate().
4138
 */
4139
attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4140
#endif
4141

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

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

    
4166
/**
4167
 * Register the hardware accelerator hwaccel.
4168
 */
4169
void av_register_hwaccel(AVHWAccel *hwaccel);
4170

    
4171
/**
4172
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4173
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4174
 * after hwaccel, or NULL if hwaccel is the last one.
4175
 */
4176
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4177

    
4178

    
4179
/**
4180
 * Lock operation used by lockmgr
4181
 */
4182
enum AVLockOp {
4183
  AV_LOCK_CREATE,  ///< Create a mutex
4184
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4185
  AV_LOCK_RELEASE, ///< Unlock the mutex
4186
  AV_LOCK_DESTROY, ///< Free mutex resources
4187
};
4188

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

    
4204
#endif /* AVCODEC_AVCODEC_H */