Statistics
| Branch: | Revision:

ffmpeg / libavcodec / avcodec.h @ 393cbb96

History | View | Annotate | Download (134 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 105
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

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

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

    
322
    /* AMR */
323
    CODEC_ID_AMR_NB= 0x12000,
324
    CODEC_ID_AMR_WB,
325

    
326
    /* RealAudio codecs*/
327
    CODEC_ID_RA_144= 0x13000,
328
    CODEC_ID_RA_288,
329

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

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

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

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

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

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

    
412
#if LIBAVCODEC_VERSION_MAJOR < 53
413
#define CodecType AVMediaType
414

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

    
424
#if FF_API_OLD_SAMPLE_FMT
425
#define SampleFormat AVSampleFormat
426

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

    
436
#if FF_API_OLD_AUDIOCONVERT
437
#include "libavcore/audioconvert.h"
438

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

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

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

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

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

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

    
502

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

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

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

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

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

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

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

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

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

    
602
#define FF_MAX_B_FRAMES 16
603

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

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

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

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

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

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

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

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

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

    
1020

    
1021
#define FF_QSCALE_TYPE_MPEG1 0
1022
#define FF_QSCALE_TYPE_MPEG2 1
1023
#define FF_QSCALE_TYPE_H264  2
1024
#define FF_QSCALE_TYPE_VP56  3
1025

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

    
1031

    
1032
#define FF_I_TYPE  1 ///< Intra
1033
#define FF_P_TYPE  2 ///< Predicted
1034
#define FF_B_TYPE  3 ///< Bi-dir predicted
1035
#define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
1036
#define FF_SI_TYPE 5 ///< Switching Intra
1037
#define FF_SP_TYPE 6 ///< Switching Predicted
1038
#define FF_BI_TYPE 7
1039

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

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

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

    
1099
/**
1100
 * Audio Video Frame.
1101
 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1102
 * bumps.
1103
 * Removal, reordering and changes to existing fields require a major
1104
 * version bump. No fields should be added into AVFrame before or after
1105
 * FF_COMMON_FRAME!
1106
 * sizeof(AVFrame) must not be used outside libav*.
1107
 */
1108
typedef struct AVFrame {
1109
    FF_COMMON_FRAME
1110
} AVFrame;
1111

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

    
1132
    /**
1133
     * number of bits the bitstream is allowed to diverge from the reference.
1134
     *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1135
     * - encoding: Set by user; unused for constant quantizer encoding.
1136
     * - decoding: unused
1137
     */
1138
    int bit_rate_tolerance;
1139

    
1140
    /**
1141
     * CODEC_FLAG_*.
1142
     * - encoding: Set by user.
1143
     * - decoding: Set by user.
1144
     */
1145
    int flags;
1146

    
1147
    /**
1148
     * Some codecs need additional format info. It is stored here.
1149
     * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1150
     * specific codec MUST set it correctly otherwise stream copy breaks.
1151
     * In general use of this field by muxers is not recommanded.
1152
     * - encoding: Set by libavcodec.
1153
     * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1154
     */
1155
    int sub_id;
1156

    
1157
    /**
1158
     * Motion estimation algorithm used for video coding.
1159
     * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1160
     * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1161
     * - encoding: MUST be set by user.
1162
     * - decoding: unused
1163
     */
1164
    int me_method;
1165

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

    
1180
    /**
1181
     * This is the fundamental unit of time (in seconds) in terms
1182
     * of which frame timestamps are represented. For fixed-fps content,
1183
     * timebase should be 1/framerate and timestamp increments should be
1184
     * identically 1.
1185
     * - encoding: MUST be set by user.
1186
     * - decoding: Set by libavcodec.
1187
     */
1188
    AVRational time_base;
1189

    
1190
    /* video only */
1191
    /**
1192
     * picture width / height.
1193
     * - encoding: MUST be set by user.
1194
     * - decoding: Set by libavcodec.
1195
     * Note: For compatibility it is possible to set this instead of
1196
     * coded_width/height before decoding.
1197
     */
1198
    int width, height;
1199

    
1200
#define FF_ASPECT_EXTENDED 15
1201

    
1202
    /**
1203
     * the number of pictures in a group of pictures, or 0 for intra_only
1204
     * - encoding: Set by user.
1205
     * - decoding: unused
1206
     */
1207
    int gop_size;
1208

    
1209
    /**
1210
     * Pixel format, see PIX_FMT_xxx.
1211
     * May be set by the demuxer if known from headers.
1212
     * May be overriden by the decoder if it knows better.
1213
     * - encoding: Set by user.
1214
     * - decoding: Set by user if known, overridden by libavcodec if known
1215
     */
1216
    enum PixelFormat pix_fmt;
1217

    
1218
    /**
1219
     * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1220
     * has to read frames at native frame rate.
1221
     * - encoding: Set by user.
1222
     * - decoding: unused
1223
     */
1224
    int rate_emu;
1225

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

    
1249
    /* audio only */
1250
    int sample_rate; ///< samples per second
1251
    int channels;    ///< number of audio channels
1252

    
1253
    /**
1254
     * audio sample format
1255
     * - encoding: Set by user.
1256
     * - decoding: Set by libavcodec.
1257
     */
1258
    enum AVSampleFormat sample_fmt;  ///< sample format
1259

    
1260
    /* The following data should not be initialized. */
1261
    /**
1262
     * Samples per packet, initialized when calling 'init'.
1263
     */
1264
    int frame_size;
1265
    int frame_number;   ///< audio or video frame number
1266
#if LIBAVCODEC_VERSION_MAJOR < 53
1267
    int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1268
#endif
1269

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

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

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

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

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

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

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

    
1320
    /** obsolete FIXME remove */
1321
    int rc_strategy;
1322
#define FF_RC_STRATEGY_XVID 1
1323

    
1324
    int b_frame_strategy;
1325

    
1326
    /**
1327
     * hurry up amount
1328
     * - encoding: unused
1329
     * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1330
     * @deprecated Deprecated in favor of skip_idct and skip_frame.
1331
     */
1332
    int hurry_up;
1333

    
1334
    struct AVCodec *codec;
1335

    
1336
    void *priv_data;
1337

    
1338
    int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1339
                            /* do its best to deliver a chunk with size     */
1340
                            /* below rtp_payload_size, the chunk will start */
1341
                            /* with a start code on some codecs like H.263. */
1342
                            /* This doesn't take account of any particular  */
1343
                            /* headers inside the transmitted RTP payload.  */
1344

    
1345

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

    
1354
    /* statistics, used for 2-pass encoding */
1355
    int mv_bits;
1356
    int header_bits;
1357
    int i_tex_bits;
1358
    int p_tex_bits;
1359
    int i_count;
1360
    int p_count;
1361
    int skip_count;
1362
    int misc_bits;
1363

    
1364
    /**
1365
     * number of bits used for the previously encoded frame
1366
     * - encoding: Set by libavcodec.
1367
     * - decoding: unused
1368
     */
1369
    int frame_bits;
1370

    
1371
    /**
1372
     * Private data of the user, can be used to carry app specific stuff.
1373
     * - encoding: Set by user.
1374
     * - decoding: Set by user.
1375
     */
1376
    void *opaque;
1377

    
1378
    char codec_name[32];
1379
    enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1380
    enum CodecID codec_id; /* see CODEC_ID_xxx */
1381

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

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

    
1421
    /**
1422
     * luma single coefficient elimination threshold
1423
     * - encoding: Set by user.
1424
     * - decoding: unused
1425
     */
1426
    int luma_elim_threshold;
1427

    
1428
    /**
1429
     * chroma single coeff elimination threshold
1430
     * - encoding: Set by user.
1431
     * - decoding: unused
1432
     */
1433
    int chroma_elim_threshold;
1434

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

    
1457
    /**
1458
     * qscale offset between IP and B-frames
1459
     * - encoding: Set by user.
1460
     * - decoding: unused
1461
     */
1462
    float b_quant_offset;
1463

    
1464
    /**
1465
     * Error recognization; higher values will detect more errors but may
1466
     * misdetect some more or less valid parts as errors.
1467
     * - encoding: unused
1468
     * - decoding: Set by user.
1469
     */
1470
    int error_recognition;
1471
#define FF_ER_CAREFUL         1
1472
#define FF_ER_COMPLIANT       2
1473
#define FF_ER_AGGRESSIVE      3
1474
#define FF_ER_VERY_AGGRESSIVE 4
1475

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

    
1489
    /**
1490
     * Called to release buffers which were allocated with get_buffer.
1491
     * A released buffer can be reused in get_buffer().
1492
     * pic.data[*] must be set to NULL.
1493
     * - encoding: unused
1494
     * - decoding: Set by libavcodec, user can override.
1495
     */
1496
    void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1497

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

    
1506
    /**
1507
     * number of bytes per packet if constant and known or 0
1508
     * Used by some WAV based audio codecs.
1509
     */
1510
    int block_align;
1511

    
1512
    int parse_only; /* - decoding only: If true, only parsing is done
1513
                       (function avcodec_parse_frame()). The frame
1514
                       data is returned. Only MPEG codecs support this now. */
1515

    
1516
    /**
1517
     * 0-> h263 quant 1-> mpeg quant
1518
     * - encoding: Set by user.
1519
     * - decoding: unused
1520
     */
1521
    int mpeg_quant;
1522

    
1523
    /**
1524
     * pass1 encoding statistics output buffer
1525
     * - encoding: Set by libavcodec.
1526
     * - decoding: unused
1527
     */
1528
    char *stats_out;
1529

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

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

    
1546
    float rc_qmod_amp;
1547
    int rc_qmod_freq;
1548

    
1549
    /**
1550
     * ratecontrol override, see RcOverride
1551
     * - encoding: Allocated/set/freed by user.
1552
     * - decoding: unused
1553
     */
1554
    RcOverride *rc_override;
1555
    int rc_override_count;
1556

    
1557
    /**
1558
     * rate control equation
1559
     * - encoding: Set by user
1560
     * - decoding: unused
1561
     */
1562
    const char *rc_eq;
1563

    
1564
    /**
1565
     * maximum bitrate
1566
     * - encoding: Set by user.
1567
     * - decoding: unused
1568
     */
1569
    int rc_max_rate;
1570

    
1571
    /**
1572
     * minimum bitrate
1573
     * - encoding: Set by user.
1574
     * - decoding: unused
1575
     */
1576
    int rc_min_rate;
1577

    
1578
    /**
1579
     * decoder bitstream buffer size
1580
     * - encoding: Set by user.
1581
     * - decoding: unused
1582
     */
1583
    int rc_buffer_size;
1584
    float rc_buffer_aggressivity;
1585

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

    
1595
    /**
1596
     * qscale offset between P and I-frames
1597
     * - encoding: Set by user.
1598
     * - decoding: unused
1599
     */
1600
    float i_quant_offset;
1601

    
1602
    /**
1603
     * initial complexity for pass1 ratecontrol
1604
     * - encoding: Set by user.
1605
     * - decoding: unused
1606
     */
1607
    float rc_initial_cplx;
1608

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

    
1623
    /**
1624
     * luminance masking (0-> disabled)
1625
     * - encoding: Set by user.
1626
     * - decoding: unused
1627
     */
1628
    float lumi_masking;
1629

    
1630
    /**
1631
     * temporary complexity masking (0-> disabled)
1632
     * - encoding: Set by user.
1633
     * - decoding: unused
1634
     */
1635
    float temporal_cplx_masking;
1636

    
1637
    /**
1638
     * spatial complexity masking (0-> disabled)
1639
     * - encoding: Set by user.
1640
     * - decoding: unused
1641
     */
1642
    float spatial_cplx_masking;
1643

    
1644
    /**
1645
     * p block masking (0-> disabled)
1646
     * - encoding: Set by user.
1647
     * - decoding: unused
1648
     */
1649
    float p_masking;
1650

    
1651
    /**
1652
     * darkness masking (0-> disabled)
1653
     * - encoding: Set by user.
1654
     * - decoding: unused
1655
     */
1656
    float dark_masking;
1657

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

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

    
1703
    /**
1704
     * error concealment flags
1705
     * - encoding: unused
1706
     * - decoding: Set by user.
1707
     */
1708
    int error_concealment;
1709
#define FF_EC_GUESS_MVS   1
1710
#define FF_EC_DEBLOCK     2
1711

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

    
1722
#if FF_API_MM_FLAGS
1723
#define FF_MM_FORCE      AV_CPU_FLAG_FORCE
1724
#define FF_MM_MMX        AV_CPU_FLAG_MMX
1725
#define FF_MM_3DNOW      AV_CPU_FLAG_3DNOW
1726
#define FF_MM_MMXEXT     AV_CPU_FLAG_MMX2
1727
#define FF_MM_MMX2       AV_CPU_FLAG_MMX2
1728
#define FF_MM_SSE        AV_CPU_FLAG_SSE
1729
#define FF_MM_SSE2       AV_CPU_FLAG_SSE2
1730
#define FF_MM_SSE2SLOW   AV_CPU_FLAG_SSE2SLOW
1731
#define FF_MM_3DNOWEXT   AV_CPU_FLAG_3DNOWEXT
1732
#define FF_MM_SSE3       AV_CPU_FLAG_SSE3
1733
#define FF_MM_SSE3SLOW   AV_CPU_FLAG_SSE3SLOW
1734
#define FF_MM_SSSE3      AV_CPU_FLAG_SSSE3
1735
#define FF_MM_SSE4       AV_CPU_FLAG_SSE4
1736
#define FF_MM_SSE42      AV_CPU_FLAG_SSE42
1737
#define FF_MM_IWMMXT     AV_CPU_FLAG_IWMMXT
1738
#define FF_MM_ALTIVEC    AV_CPU_FLAG_ALTIVEC
1739
#endif
1740

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

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

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

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

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

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

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

    
1814
    /**
1815
     * minimum MB quantizer
1816
     * - encoding: unused
1817
     * - decoding: unused
1818
     */
1819
    int mb_qmin;
1820

    
1821
    /**
1822
     * maximum MB quantizer
1823
     * - encoding: unused
1824
     * - decoding: unused
1825
     */
1826
    int mb_qmax;
1827

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

    
1869
    /**
1870
     * ME diamond size & shape
1871
     * - encoding: Set by user.
1872
     * - decoding: unused
1873
     */
1874
    int dia_size;
1875

    
1876
    /**
1877
     * amount of previous MV predictors (2a+1 x 2a+1 square)
1878
     * - encoding: Set by user.
1879
     * - decoding: unused
1880
     */
1881
    int last_predictor_count;
1882

    
1883
    /**
1884
     * prepass for motion estimation
1885
     * - encoding: Set by user.
1886
     * - decoding: unused
1887
     */
1888
    int pre_me;
1889

    
1890
    /**
1891
     * motion estimation prepass comparison function
1892
     * - encoding: Set by user.
1893
     * - decoding: unused
1894
     */
1895
    int me_pre_cmp;
1896

    
1897
    /**
1898
     * ME prepass diamond size & shape
1899
     * - encoding: Set by user.
1900
     * - decoding: unused
1901
     */
1902
    int pre_dia_size;
1903

    
1904
    /**
1905
     * subpel ME quality
1906
     * - encoding: Set by user.
1907
     * - decoding: unused
1908
     */
1909
    int me_subpel_quality;
1910

    
1911
    /**
1912
     * callback to negotiate the pixelFormat
1913
     * @param fmt is the list of formats which are supported by the codec,
1914
     * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1915
     * The first is always the native one.
1916
     * @return the chosen format
1917
     * - encoding: unused
1918
     * - decoding: Set by user, if not set the native format will be chosen.
1919
     */
1920
    enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1921

    
1922
    /**
1923
     * DTG active format information (additional aspect ratio
1924
     * information only used in DVB MPEG-2 transport streams)
1925
     * 0 if not set.
1926
     *
1927
     * - encoding: unused
1928
     * - decoding: Set by decoder.
1929
     */
1930
    int dtg_active_format;
1931
#define FF_DTG_AFD_SAME         8
1932
#define FF_DTG_AFD_4_3          9
1933
#define FF_DTG_AFD_16_9         10
1934
#define FF_DTG_AFD_14_9         11
1935
#define FF_DTG_AFD_4_3_SP_14_9  13
1936
#define FF_DTG_AFD_16_9_SP_14_9 14
1937
#define FF_DTG_AFD_SP_4_3       15
1938

    
1939
    /**
1940
     * maximum motion estimation search range in subpel units
1941
     * If 0 then no limit.
1942
     *
1943
     * - encoding: Set by user.
1944
     * - decoding: unused
1945
     */
1946
    int me_range;
1947

    
1948
    /**
1949
     * intra quantizer bias
1950
     * - encoding: Set by user.
1951
     * - decoding: unused
1952
     */
1953
    int intra_quant_bias;
1954
#define FF_DEFAULT_QUANT_BIAS 999999
1955

    
1956
    /**
1957
     * inter quantizer bias
1958
     * - encoding: Set by user.
1959
     * - decoding: unused
1960
     */
1961
    int inter_quant_bias;
1962

    
1963
    /**
1964
     * color table ID
1965
     * - encoding: unused
1966
     * - decoding: Which clrtable should be used for 8bit RGB images.
1967
     *             Tables have to be stored somewhere. FIXME
1968
     */
1969
    int color_table_id;
1970

    
1971
    /**
1972
     * internal_buffer count
1973
     * Don't touch, used by libavcodec default_get_buffer().
1974
     */
1975
    int internal_buffer_count;
1976

    
1977
    /**
1978
     * internal_buffers
1979
     * Don't touch, used by libavcodec default_get_buffer().
1980
     */
1981
    void *internal_buffer;
1982

    
1983
    /**
1984
     * Global quality for codecs which cannot change it per frame.
1985
     * This should be proportional to MPEG-1/2/4 qscale.
1986
     * - encoding: Set by user.
1987
     * - decoding: unused
1988
     */
1989
    int global_quality;
1990

    
1991
#define FF_CODER_TYPE_VLC       0
1992
#define FF_CODER_TYPE_AC        1
1993
#define FF_CODER_TYPE_RAW       2
1994
#define FF_CODER_TYPE_RLE       3
1995
#define FF_CODER_TYPE_DEFLATE   4
1996
    /**
1997
     * coder type
1998
     * - encoding: Set by user.
1999
     * - decoding: unused
2000
     */
2001
    int coder_type;
2002

    
2003
    /**
2004
     * context model
2005
     * - encoding: Set by user.
2006
     * - decoding: unused
2007
     */
2008
    int context_model;
2009
#if 0
2010
    /**
2011
     *
2012
     * - encoding: unused
2013
     * - decoding: Set by user.
2014
     */
2015
    uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2016
#endif
2017

    
2018
    /**
2019
     * slice flags
2020
     * - encoding: unused
2021
     * - decoding: Set by user.
2022
     */
2023
    int slice_flags;
2024
#define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2025
#define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2026
#define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2027

    
2028
    /**
2029
     * XVideo Motion Acceleration
2030
     * - encoding: forbidden
2031
     * - decoding: set by decoder
2032
     */
2033
    int xvmc_acceleration;
2034

    
2035
    /**
2036
     * macroblock decision mode
2037
     * - encoding: Set by user.
2038
     * - decoding: unused
2039
     */
2040
    int mb_decision;
2041
#define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2042
#define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2043
#define FF_MB_DECISION_RD     2        ///< rate distortion
2044

    
2045
    /**
2046
     * custom intra quantization matrix
2047
     * - encoding: Set by user, can be NULL.
2048
     * - decoding: Set by libavcodec.
2049
     */
2050
    uint16_t *intra_matrix;
2051

    
2052
    /**
2053
     * custom inter quantization matrix
2054
     * - encoding: Set by user, can be NULL.
2055
     * - decoding: Set by libavcodec.
2056
     */
2057
    uint16_t *inter_matrix;
2058

    
2059
    /**
2060
     * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2061
     * This is used to work around some encoder bugs.
2062
     * - encoding: unused
2063
     * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2064
     */
2065
    unsigned int stream_codec_tag;
2066

    
2067
    /**
2068
     * scene change detection threshold
2069
     * 0 is default, larger means fewer detected scene changes.
2070
     * - encoding: Set by user.
2071
     * - decoding: unused
2072
     */
2073
    int scenechange_threshold;
2074

    
2075
    /**
2076
     * minimum Lagrange multipler
2077
     * - encoding: Set by user.
2078
     * - decoding: unused
2079
     */
2080
    int lmin;
2081

    
2082
    /**
2083
     * maximum Lagrange multipler
2084
     * - encoding: Set by user.
2085
     * - decoding: unused
2086
     */
2087
    int lmax;
2088

    
2089
#if FF_API_PALETTE_CONTROL
2090
    /**
2091
     * palette control structure
2092
     * - encoding: ??? (no palette-enabled encoder yet)
2093
     * - decoding: Set by user.
2094
     */
2095
    struct AVPaletteControl *palctrl;
2096
#endif
2097

    
2098
    /**
2099
     * noise reduction strength
2100
     * - encoding: Set by user.
2101
     * - decoding: unused
2102
     */
2103
    int noise_reduction;
2104

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

    
2119
    /**
2120
     * Number of bits which should be loaded into the rc buffer before decoding starts.
2121
     * - encoding: Set by user.
2122
     * - decoding: unused
2123
     */
2124
    int rc_initial_buffer_occupancy;
2125

    
2126
    /**
2127
     *
2128
     * - encoding: Set by user.
2129
     * - decoding: unused
2130
     */
2131
    int inter_threshold;
2132

    
2133
    /**
2134
     * CODEC_FLAG2_*
2135
     * - encoding: Set by user.
2136
     * - decoding: Set by user.
2137
     */
2138
    int flags2;
2139

    
2140
    /**
2141
     * Simulates errors in the bitstream to test error concealment.
2142
     * - encoding: Set by user.
2143
     * - decoding: unused
2144
     */
2145
    int error_rate;
2146

    
2147
    /**
2148
     * MP3 antialias algorithm, see FF_AA_* below.
2149
     * - encoding: unused
2150
     * - decoding: Set by user.
2151
     */
2152
    int antialias_algo;
2153
#define FF_AA_AUTO    0
2154
#define FF_AA_FASTINT 1 //not implemented yet
2155
#define FF_AA_INT     2
2156
#define FF_AA_FLOAT   3
2157
    /**
2158
     * quantizer noise shaping
2159
     * - encoding: Set by user.
2160
     * - decoding: unused
2161
     */
2162
    int quantizer_noise_shaping;
2163

    
2164
    /**
2165
     * thread count
2166
     * is used to decide how many independent tasks should be passed to execute()
2167
     * - encoding: Set by user.
2168
     * - decoding: Set by user.
2169
     */
2170
    int thread_count;
2171

    
2172
    /**
2173
     * The codec may call this to execute several independent things.
2174
     * It will return only after finishing all tasks.
2175
     * The user may replace this with some multithreaded implementation,
2176
     * the default implementation will execute the parts serially.
2177
     * @param count the number of things to execute
2178
     * - encoding: Set by libavcodec, user can override.
2179
     * - decoding: Set by libavcodec, user can override.
2180
     */
2181
    int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2182

    
2183
    /**
2184
     * thread opaque
2185
     * Can be used by execute() to store some per AVCodecContext stuff.
2186
     * - encoding: set by execute()
2187
     * - decoding: set by execute()
2188
     */
2189
    void *thread_opaque;
2190

    
2191
    /**
2192
     * Motion estimation threshold below which no motion estimation is
2193
     * performed, but instead the user specified motion vectors are used.
2194
     *
2195
     * - encoding: Set by user.
2196
     * - decoding: unused
2197
     */
2198
     int me_threshold;
2199

    
2200
    /**
2201
     * Macroblock threshold below which the user specified macroblock types will be used.
2202
     * - encoding: Set by user.
2203
     * - decoding: unused
2204
     */
2205
     int mb_threshold;
2206

    
2207
    /**
2208
     * precision of the intra DC coefficient - 8
2209
     * - encoding: Set by user.
2210
     * - decoding: unused
2211
     */
2212
     int intra_dc_precision;
2213

    
2214
    /**
2215
     * noise vs. sse weight for the nsse comparsion function
2216
     * - encoding: Set by user.
2217
     * - decoding: unused
2218
     */
2219
     int nsse_weight;
2220

    
2221
    /**
2222
     * Number of macroblock rows at the top which are skipped.
2223
     * - encoding: unused
2224
     * - decoding: Set by user.
2225
     */
2226
     int skip_top;
2227

    
2228
    /**
2229
     * Number of macroblock rows at the bottom which are skipped.
2230
     * - encoding: unused
2231
     * - decoding: Set by user.
2232
     */
2233
     int skip_bottom;
2234

    
2235
    /**
2236
     * profile
2237
     * - encoding: Set by user.
2238
     * - decoding: Set by libavcodec.
2239
     */
2240
     int profile;
2241
#define FF_PROFILE_UNKNOWN -99
2242

    
2243
#define FF_PROFILE_AAC_MAIN 0
2244
#define FF_PROFILE_AAC_LOW  1
2245
#define FF_PROFILE_AAC_SSR  2
2246
#define FF_PROFILE_AAC_LTP  3
2247

    
2248
#define FF_PROFILE_DTS         20
2249
#define FF_PROFILE_DTS_ES      30
2250
#define FF_PROFILE_DTS_96_24   40
2251
#define FF_PROFILE_DTS_HD_HRA  50
2252
#define FF_PROFILE_DTS_HD_MA   60
2253

    
2254
#define FF_PROFILE_H264_BASELINE    66
2255
#define FF_PROFILE_H264_MAIN        77
2256
#define FF_PROFILE_H264_EXTENDED    88
2257
#define FF_PROFILE_H264_HIGH        100
2258
#define FF_PROFILE_H264_HIGH_10     110
2259
#define FF_PROFILE_H264_HIGH_422    122
2260
#define FF_PROFILE_H264_HIGH_444    244
2261
#define FF_PROFILE_H264_CAVLC_444   44
2262

    
2263
    /**
2264
     * level
2265
     * - encoding: Set by user.
2266
     * - decoding: Set by libavcodec.
2267
     */
2268
     int level;
2269
#define FF_LEVEL_UNKNOWN -99
2270

    
2271
    /**
2272
     * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2273
     * - encoding: unused
2274
     * - decoding: Set by user.
2275
     */
2276
     int lowres;
2277

    
2278
    /**
2279
     * Bitstream width / height, may be different from width/height if lowres
2280
     * or other things are used.
2281
     * - encoding: unused
2282
     * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2283
     */
2284
    int coded_width, coded_height;
2285

    
2286
    /**
2287
     * frame skip threshold
2288
     * - encoding: Set by user.
2289
     * - decoding: unused
2290
     */
2291
    int frame_skip_threshold;
2292

    
2293
    /**
2294
     * frame skip factor
2295
     * - encoding: Set by user.
2296
     * - decoding: unused
2297
     */
2298
    int frame_skip_factor;
2299

    
2300
    /**
2301
     * frame skip exponent
2302
     * - encoding: Set by user.
2303
     * - decoding: unused
2304
     */
2305
    int frame_skip_exp;
2306

    
2307
    /**
2308
     * frame skip comparison function
2309
     * - encoding: Set by user.
2310
     * - decoding: unused
2311
     */
2312
    int frame_skip_cmp;
2313

    
2314
    /**
2315
     * Border processing masking, raises the quantizer for mbs on the borders
2316
     * of the picture.
2317
     * - encoding: Set by user.
2318
     * - decoding: unused
2319
     */
2320
    float border_masking;
2321

    
2322
    /**
2323
     * minimum MB lagrange multipler
2324
     * - encoding: Set by user.
2325
     * - decoding: unused
2326
     */
2327
    int mb_lmin;
2328

    
2329
    /**
2330
     * maximum MB lagrange multipler
2331
     * - encoding: Set by user.
2332
     * - decoding: unused
2333
     */
2334
    int mb_lmax;
2335

    
2336
    /**
2337
     *
2338
     * - encoding: Set by user.
2339
     * - decoding: unused
2340
     */
2341
    int me_penalty_compensation;
2342

    
2343
    /**
2344
     *
2345
     * - encoding: unused
2346
     * - decoding: Set by user.
2347
     */
2348
    enum AVDiscard skip_loop_filter;
2349

    
2350
    /**
2351
     *
2352
     * - encoding: unused
2353
     * - decoding: Set by user.
2354
     */
2355
    enum AVDiscard skip_idct;
2356

    
2357
    /**
2358
     *
2359
     * - encoding: unused
2360
     * - decoding: Set by user.
2361
     */
2362
    enum AVDiscard skip_frame;
2363

    
2364
    /**
2365
     *
2366
     * - encoding: Set by user.
2367
     * - decoding: unused
2368
     */
2369
    int bidir_refine;
2370

    
2371
    /**
2372
     *
2373
     * - encoding: Set by user.
2374
     * - decoding: unused
2375
     */
2376
    int brd_scale;
2377

    
2378
    /**
2379
     * constant rate factor - quality-based VBR - values ~correspond to qps
2380
     * - encoding: Set by user.
2381
     * - decoding: unused
2382
     */
2383
    float crf;
2384

    
2385
    /**
2386
     * constant quantization parameter rate control method
2387
     * - encoding: Set by user.
2388
     * - decoding: unused
2389
     */
2390
    int cqp;
2391

    
2392
    /**
2393
     * minimum GOP size
2394
     * - encoding: Set by user.
2395
     * - decoding: unused
2396
     */
2397
    int keyint_min;
2398

    
2399
    /**
2400
     * number of reference frames
2401
     * - encoding: Set by user.
2402
     * - decoding: Set by lavc.
2403
     */
2404
    int refs;
2405

    
2406
    /**
2407
     * chroma qp offset from luma
2408
     * - encoding: Set by user.
2409
     * - decoding: unused
2410
     */
2411
    int chromaoffset;
2412

    
2413
    /**
2414
     * Influences how often B-frames are used.
2415
     * - encoding: Set by user.
2416
     * - decoding: unused
2417
     */
2418
    int bframebias;
2419

    
2420
    /**
2421
     * trellis RD quantization
2422
     * - encoding: Set by user.
2423
     * - decoding: unused
2424
     */
2425
    int trellis;
2426

    
2427
    /**
2428
     * Reduce fluctuations in qp (before curve compression).
2429
     * - encoding: Set by user.
2430
     * - decoding: unused
2431
     */
2432
    float complexityblur;
2433

    
2434
    /**
2435
     * in-loop deblocking filter alphac0 parameter
2436
     * alpha is in the range -6...6
2437
     * - encoding: Set by user.
2438
     * - decoding: unused
2439
     */
2440
    int deblockalpha;
2441

    
2442
    /**
2443
     * in-loop deblocking filter beta parameter
2444
     * beta is in the range -6...6
2445
     * - encoding: Set by user.
2446
     * - decoding: unused
2447
     */
2448
    int deblockbeta;
2449

    
2450
    /**
2451
     * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2452
     * - encoding: Set by user.
2453
     * - decoding: unused
2454
     */
2455
    int partitions;
2456
#define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2457
#define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2458
#define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2459
#define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2460
#define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2461

    
2462
    /**
2463
     * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2464
     * - encoding: Set by user.
2465
     * - decoding: unused
2466
     */
2467
    int directpred;
2468

    
2469
    /**
2470
     * Audio cutoff bandwidth (0 means "automatic")
2471
     * - encoding: Set by user.
2472
     * - decoding: unused
2473
     */
2474
    int cutoff;
2475

    
2476
    /**
2477
     * Multiplied by qscale for each frame and added to scene_change_score.
2478
     * - encoding: Set by user.
2479
     * - decoding: unused
2480
     */
2481
    int scenechange_factor;
2482

    
2483
    /**
2484
     *
2485
     * Note: Value depends upon the compare function used for fullpel ME.
2486
     * - encoding: Set by user.
2487
     * - decoding: unused
2488
     */
2489
    int mv0_threshold;
2490

    
2491
    /**
2492
     * Adjusts sensitivity of b_frame_strategy 1.
2493
     * - encoding: Set by user.
2494
     * - decoding: unused
2495
     */
2496
    int b_sensitivity;
2497

    
2498
    /**
2499
     * - encoding: Set by user.
2500
     * - decoding: unused
2501
     */
2502
    int compression_level;
2503
#define FF_COMPRESSION_DEFAULT -1
2504

    
2505
#if FF_API_USE_LPC
2506
    /**
2507
     * Sets whether to use LPC mode - used by FLAC encoder.
2508
     * - encoding: Set by user.
2509
     * - decoding: unused
2510
     * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2511
     */
2512
    int use_lpc;
2513
#endif
2514

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    
2766
    int log_level_offset;
2767

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

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

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

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

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

    
2812
/**
2813
 * AVProfile.
2814
 */
2815
typedef struct AVProfile {
2816
    int profile;
2817
    const char *name; ///< short name for the profile
2818
} AVProfile;
2819

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

    
2864
/**
2865
 * AVHWAccel.
2866
 */
2867
typedef struct AVHWAccel {
2868
    /**
2869
     * Name of the hardware accelerated codec.
2870
     * The name is globally unique among encoders and among decoders (but an
2871
     * encoder and a decoder can share the same name).
2872
     */
2873
    const char *name;
2874

    
2875
    /**
2876
     * Type of codec implemented by the hardware accelerator.
2877
     *
2878
     * See AVMEDIA_TYPE_xxx
2879
     */
2880
    enum AVMediaType type;
2881

    
2882
    /**
2883
     * Codec implemented by the hardware accelerator.
2884
     *
2885
     * See CODEC_ID_xxx
2886
     */
2887
    enum CodecID id;
2888

    
2889
    /**
2890
     * Supported pixel format.
2891
     *
2892
     * Only hardware accelerated formats are supported here.
2893
     */
2894
    enum PixelFormat pix_fmt;
2895

    
2896
    /**
2897
     * Hardware accelerated codec capabilities.
2898
     * see FF_HWACCEL_CODEC_CAP_*
2899
     */
2900
    int capabilities;
2901

    
2902
    struct AVHWAccel *next;
2903

    
2904
    /**
2905
     * Called at the beginning of each frame or field picture.
2906
     *
2907
     * Meaningful frame information (codec specific) is guaranteed to
2908
     * be parsed at this point. This function is mandatory.
2909
     *
2910
     * Note that buf can be NULL along with buf_size set to 0.
2911
     * Otherwise, this means the whole frame is available at this point.
2912
     *
2913
     * @param avctx the codec context
2914
     * @param buf the frame data buffer base
2915
     * @param buf_size the size of the frame in bytes
2916
     * @return zero if successful, a negative value otherwise
2917
     */
2918
    int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2919

    
2920
    /**
2921
     * Callback for each slice.
2922
     *
2923
     * Meaningful slice information (codec specific) is guaranteed to
2924
     * be parsed at this point. This function is mandatory.
2925
     *
2926
     * @param avctx the codec context
2927
     * @param buf the slice data buffer base
2928
     * @param buf_size the size of the slice in bytes
2929
     * @return zero if successful, a negative value otherwise
2930
     */
2931
    int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2932

    
2933
    /**
2934
     * Called at the end of each frame or field picture.
2935
     *
2936
     * The whole picture is parsed at this point and can now be sent
2937
     * to the hardware accelerator. This function is mandatory.
2938
     *
2939
     * @param avctx the codec context
2940
     * @return zero if successful, a negative value otherwise
2941
     */
2942
    int (*end_frame)(AVCodecContext *avctx);
2943

    
2944
    /**
2945
     * Size of HW accelerator private data.
2946
     *
2947
     * Private data is allocated with av_mallocz() before
2948
     * AVCodecContext.get_buffer() and deallocated after
2949
     * AVCodecContext.release_buffer().
2950
     */
2951
    int priv_data_size;
2952
} AVHWAccel;
2953

    
2954
/**
2955
 * four components are given, that's all.
2956
 * the last component is alpha
2957
 */
2958
typedef struct AVPicture {
2959
    uint8_t *data[4];
2960
    int linesize[4];       ///< number of bytes per line
2961
} AVPicture;
2962

    
2963
#if FF_API_PALETTE_CONTROL
2964
/**
2965
 * AVPaletteControl
2966
 * This structure defines a method for communicating palette changes
2967
 * between and demuxer and a decoder.
2968
 *
2969
 * @deprecated Use AVPacket to send palette changes instead.
2970
 * This is totally broken.
2971
 */
2972
#define AVPALETTE_SIZE 1024
2973
#define AVPALETTE_COUNT 256
2974
typedef struct AVPaletteControl {
2975

    
2976
    /* Demuxer sets this to 1 to indicate the palette has changed;
2977
     * decoder resets to 0. */
2978
    int palette_changed;
2979

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

    
2986
} AVPaletteControl attribute_deprecated;
2987
#endif
2988

    
2989
enum AVSubtitleType {
2990
    SUBTITLE_NONE,
2991

    
2992
    SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2993

    
2994
    /**
2995
     * Plain text, the text field must be set by the decoder and is
2996
     * authoritative. ass and pict fields may contain approximations.
2997
     */
2998
    SUBTITLE_TEXT,
2999

    
3000
    /**
3001
     * Formatted text, the ass field must be set by the decoder and is
3002
     * authoritative. pict and text fields may contain approximations.
3003
     */
3004
    SUBTITLE_ASS,
3005
};
3006

    
3007
typedef struct AVSubtitleRect {
3008
    int x;         ///< top left corner  of pict, undefined when pict is not set
3009
    int y;         ///< top left corner  of pict, undefined when pict is not set
3010
    int w;         ///< width            of pict, undefined when pict is not set
3011
    int h;         ///< height           of pict, undefined when pict is not set
3012
    int nb_colors; ///< number of colors in pict, undefined when pict is not set
3013

    
3014
    /**
3015
     * data+linesize for the bitmap of this subtitle.
3016
     * can be set for text/ass as well once they where rendered
3017
     */
3018
    AVPicture pict;
3019
    enum AVSubtitleType type;
3020

    
3021
    char *text;                     ///< 0 terminated plain UTF-8 text
3022

    
3023
    /**
3024
     * 0 terminated ASS/SSA compatible event line.
3025
     * The pressentation of this is unaffected by the other values in this
3026
     * struct.
3027
     */
3028
    char *ass;
3029
} AVSubtitleRect;
3030

    
3031
typedef struct AVSubtitle {
3032
    uint16_t format; /* 0 = graphics */
3033
    uint32_t start_display_time; /* relative to packet pts, in ms */
3034
    uint32_t end_display_time; /* relative to packet pts, in ms */
3035
    unsigned num_rects;
3036
    AVSubtitleRect **rects;
3037
    int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3038
} AVSubtitle;
3039

    
3040
/* packet functions */
3041

    
3042
/**
3043
 * @deprecated use NULL instead
3044
 */
3045
attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3046

    
3047
/**
3048
 * Default packet destructor.
3049
 */
3050
void av_destruct_packet(AVPacket *pkt);
3051

    
3052
/**
3053
 * Initialize optional fields of a packet with default values.
3054
 *
3055
 * @param pkt packet
3056
 */
3057
void av_init_packet(AVPacket *pkt);
3058

    
3059
/**
3060
 * Allocate the payload of a packet and initialize its fields with
3061
 * default values.
3062
 *
3063
 * @param pkt packet
3064
 * @param size wanted payload size
3065
 * @return 0 if OK, AVERROR_xxx otherwise
3066
 */
3067
int av_new_packet(AVPacket *pkt, int size);
3068

    
3069
/**
3070
 * Reduce packet size, correctly zeroing padding
3071
 *
3072
 * @param pkt packet
3073
 * @param size new size
3074
 */
3075
void av_shrink_packet(AVPacket *pkt, int size);
3076

    
3077
/**
3078
 * Increase packet size, correctly zeroing padding
3079
 *
3080
 * @param pkt packet
3081
 * @param grow_by number of bytes by which to increase the size of the packet
3082
 */
3083
int av_grow_packet(AVPacket *pkt, int grow_by);
3084

    
3085
/**
3086
 * @warning This is a hack - the packet memory allocation stuff is broken. The
3087
 * packet is allocated if it was not really allocated.
3088
 */
3089
int av_dup_packet(AVPacket *pkt);
3090

    
3091
/**
3092
 * Free a packet.
3093
 *
3094
 * @param pkt packet to free
3095
 */
3096
void av_free_packet(AVPacket *pkt);
3097

    
3098
/* resample.c */
3099

    
3100
struct ReSampleContext;
3101
struct AVResampleContext;
3102

    
3103
typedef struct ReSampleContext ReSampleContext;
3104

    
3105
#if FF_API_AUDIO_OLD
3106
/**
3107
 * @deprecated Use av_audio_resample_init() instead.
3108
 */
3109
attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3110
                                                          int output_rate, int input_rate);
3111
#endif
3112
/**
3113
 *  Initialize audio resampling context
3114
 *
3115
 * @param output_channels  number of output channels
3116
 * @param input_channels   number of input channels
3117
 * @param output_rate      output sample rate
3118
 * @param input_rate       input sample rate
3119
 * @param sample_fmt_out   requested output sample format
3120
 * @param sample_fmt_in    input sample format
3121
 * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
3122
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3123
 * @param linear           If 1 then the used FIR filter will be linearly interpolated
3124
                           between the 2 closest, if 0 the closest will be used
3125
 * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3126
 * @return allocated ReSampleContext, NULL if error occured
3127
 */
3128
ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3129
                                        int output_rate, int input_rate,
3130
                                        enum AVSampleFormat sample_fmt_out,
3131
                                        enum AVSampleFormat sample_fmt_in,
3132
                                        int filter_length, int log2_phase_count,
3133
                                        int linear, double cutoff);
3134

    
3135
int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3136
void audio_resample_close(ReSampleContext *s);
3137

    
3138

    
3139
/**
3140
 * Initialize an audio resampler.
3141
 * Note, if either rate is not an integer then simply scale both rates up so they are.
3142
 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3143
 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3144
 * @param linear If 1 then the used FIR filter will be linearly interpolated
3145
                 between the 2 closest, if 0 the closest will be used
3146
 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3147
 */
3148
struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3149

    
3150
/**
3151
 * Resample an array of samples using a previously configured context.
3152
 * @param src an array of unconsumed samples
3153
 * @param consumed the number of samples of src which have been consumed are returned here
3154
 * @param src_size the number of unconsumed samples available
3155
 * @param dst_size the amount of space in samples available in dst
3156
 * @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.
3157
 * @return the number of samples written in dst or -1 if an error occurred
3158
 */
3159
int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3160

    
3161

    
3162
/**
3163
 * Compensate samplerate/timestamp drift. The compensation is done by changing
3164
 * the resampler parameters, so no audible clicks or similar distortions occur
3165
 * @param compensation_distance distance in output samples over which the compensation should be performed
3166
 * @param sample_delta number of output samples which should be output less
3167
 *
3168
 * example: av_resample_compensate(c, 10, 500)
3169
 * here instead of 510 samples only 500 samples would be output
3170
 *
3171
 * note, due to rounding the actual compensation might be slightly different,
3172
 * especially if the compensation_distance is large and the in_rate used during init is small
3173
 */
3174
void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3175
void av_resample_close(struct AVResampleContext *c);
3176

    
3177
/**
3178
 * Allocate memory for a picture.  Call avpicture_free to free it.
3179
 *
3180
 * @param picture the picture to be filled in
3181
 * @param pix_fmt the format of the picture
3182
 * @param width the width of the picture
3183
 * @param height the height of the picture
3184
 * @return zero if successful, a negative value if not
3185
 */
3186
int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3187

    
3188
/**
3189
 * Free a picture previously allocated by avpicture_alloc().
3190
 *
3191
 * @param picture the AVPicture to be freed
3192
 */
3193
void avpicture_free(AVPicture *picture);
3194

    
3195
/**
3196
 * Fill in the AVPicture fields.
3197
 * The fields of the given AVPicture are filled in by using the 'ptr' address
3198
 * which points to the image data buffer. Depending on the specified picture
3199
 * format, one or multiple image data pointers and line sizes will be set.
3200
 * If a planar format is specified, several pointers will be set pointing to
3201
 * the different picture planes and the line sizes of the different planes
3202
 * will be stored in the lines_sizes array.
3203
 * Call with ptr == NULL to get the required size for the ptr buffer.
3204
 *
3205
 * @param picture AVPicture whose fields are to be filled in
3206
 * @param ptr Buffer which will contain or contains the actual image data
3207
 * @param pix_fmt The format in which the picture data is stored.
3208
 * @param width the width of the image in pixels
3209
 * @param height the height of the image in pixels
3210
 * @return size of the image data in bytes
3211
 */
3212
int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3213
                   enum PixelFormat pix_fmt, int width, int height);
3214
int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3215
                     unsigned char *dest, int dest_size);
3216

    
3217
/**
3218
 * Calculate the size in bytes that a picture of the given width and height
3219
 * would occupy if stored in the given picture format.
3220
 * Note that this returns the size of a compact representation as generated
3221
 * by avpicture_layout, which can be smaller than the size required for e.g.
3222
 * avpicture_fill.
3223
 *
3224
 * @param pix_fmt the given picture format
3225
 * @param width the width of the image
3226
 * @param height the height of the image
3227
 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3228
 */
3229
int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3230
void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3231
const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3232
void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3233

    
3234
#if LIBAVCODEC_VERSION_MAJOR < 53
3235
/**
3236
 * Return the pixel format corresponding to the name name.
3237
 *
3238
 * If there is no pixel format with name name, then look for a
3239
 * pixel format with the name corresponding to the native endian
3240
 * format of name.
3241
 * For example in a little-endian system, first look for "gray16",
3242
 * then for "gray16le".
3243
 *
3244
 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3245
 *
3246
 * @deprecated Deprecated in favor of av_get_pix_fmt().
3247
 */
3248
attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3249
#endif
3250

    
3251
/**
3252
 * Return a value representing the fourCC code associated to the
3253
 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3254
 * found.
3255
 */
3256
unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3257

    
3258
/**
3259
 * Put a string representing the codec tag codec_tag in buf.
3260
 *
3261
 * @param buf_size size in bytes of buf
3262
 * @return the length of the string that would have been generated if
3263
 * enough space had been available, excluding the trailing null
3264
 */
3265
size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3266

    
3267
#define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3268
#define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3269
#define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3270
#define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3271
#define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3272
#define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3273

    
3274
/**
3275
 * Compute what kind of losses will occur when converting from one specific
3276
 * pixel format to another.
3277
 * When converting from one pixel format to another, information loss may occur.
3278
 * For example, when converting from RGB24 to GRAY, the color information will
3279
 * be lost. Similarly, other losses occur when converting from some formats to
3280
 * other formats. These losses can involve loss of chroma, but also loss of
3281
 * resolution, loss of color depth, loss due to the color space conversion, loss
3282
 * of the alpha bits or loss due to color quantization.
3283
 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3284
 * which will occur when converting from one pixel format to another.
3285
 *
3286
 * @param[in] dst_pix_fmt destination pixel format
3287
 * @param[in] src_pix_fmt source pixel format
3288
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3289
 * @return Combination of flags informing you what kind of losses will occur.
3290
 */
3291
int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3292
                             int has_alpha);
3293

    
3294
/**
3295
 * Find the best pixel format to convert to given a certain source pixel
3296
 * format.  When converting from one pixel format to another, information loss
3297
 * may occur.  For example, when converting from RGB24 to GRAY, the color
3298
 * information will be lost. Similarly, other losses occur when converting from
3299
 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3300
 * the given pixel formats should be used to suffer the least amount of loss.
3301
 * The pixel formats from which it chooses one, are determined by the
3302
 * pix_fmt_mask parameter.
3303
 *
3304
 * @code
3305
 * src_pix_fmt = PIX_FMT_YUV420P;
3306
 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3307
 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3308
 * @endcode
3309
 *
3310
 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3311
 * @param[in] src_pix_fmt source pixel format
3312
 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3313
 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3314
 * @return The best pixel format to convert to or -1 if none was found.
3315
 */
3316
enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3317
                              int has_alpha, int *loss_ptr);
3318

    
3319
#if LIBAVCODEC_VERSION_MAJOR < 53
3320
/**
3321
 * @deprecated Use av_get_pix_fmt_string() instead.
3322
 */
3323
attribute_deprecated
3324
void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3325
#endif
3326

    
3327
#define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3328
#define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3329

    
3330
/**
3331
 * Tell if an image really has transparent alpha values.
3332
 * @return ored mask of FF_ALPHA_xxx constants
3333
 */
3334
int img_get_alpha_info(const AVPicture *src,
3335
                       enum PixelFormat pix_fmt, int width, int height);
3336

    
3337
/* deinterlace a picture */
3338
/* deinterlace - if not supported return -1 */
3339
int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3340
                          enum PixelFormat pix_fmt, int width, int height);
3341

    
3342
/* external high level API */
3343

    
3344
/**
3345
 * If c is NULL, returns the first registered codec,
3346
 * if c is non-NULL, returns the next registered codec after c,
3347
 * or NULL if c is the last one.
3348
 */
3349
AVCodec *av_codec_next(AVCodec *c);
3350

    
3351
/**
3352
 * Return the LIBAVCODEC_VERSION_INT constant.
3353
 */
3354
unsigned avcodec_version(void);
3355

    
3356
/**
3357
 * Return the libavcodec build-time configuration.
3358
 */
3359
const char *avcodec_configuration(void);
3360

    
3361
/**
3362
 * Return the libavcodec license.
3363
 */
3364
const char *avcodec_license(void);
3365

    
3366
/**
3367
 * Initialize libavcodec.
3368
 *
3369
 * @warning This function must be called before any other libavcodec
3370
 * function.
3371
 */
3372
void avcodec_init(void);
3373

    
3374
#if LIBAVCODEC_VERSION_MAJOR < 53
3375
/**
3376
 * @deprecated Deprecated in favor of avcodec_register().
3377
 */
3378
attribute_deprecated void register_avcodec(AVCodec *codec);
3379
#endif
3380

    
3381
/**
3382
 * Register the codec codec and initialize libavcodec.
3383
 *
3384
 * @see avcodec_init()
3385
 */
3386
void avcodec_register(AVCodec *codec);
3387

    
3388
/**
3389
 * Find a registered encoder with a matching codec ID.
3390
 *
3391
 * @param id CodecID of the requested encoder
3392
 * @return An encoder if one was found, NULL otherwise.
3393
 */
3394
AVCodec *avcodec_find_encoder(enum CodecID id);
3395

    
3396
/**
3397
 * Find a registered encoder with the specified name.
3398
 *
3399
 * @param name name of the requested encoder
3400
 * @return An encoder if one was found, NULL otherwise.
3401
 */
3402
AVCodec *avcodec_find_encoder_by_name(const char *name);
3403

    
3404
/**
3405
 * Find a registered decoder with a matching codec ID.
3406
 *
3407
 * @param id CodecID of the requested decoder
3408
 * @return A decoder if one was found, NULL otherwise.
3409
 */
3410
AVCodec *avcodec_find_decoder(enum CodecID id);
3411

    
3412
/**
3413
 * Find a registered decoder with the specified name.
3414
 *
3415
 * @param name name of the requested decoder
3416
 * @return A decoder if one was found, NULL otherwise.
3417
 */
3418
AVCodec *avcodec_find_decoder_by_name(const char *name);
3419
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3420

    
3421
/**
3422
 * Return a name for the specified profile, if available.
3423
 *
3424
 * @param codec the codec that is searched for the given profile
3425
 * @param profile the profile value for which a name is requested
3426
 * @return A name for the profile if found, NULL otherwise.
3427
 */
3428
const char *av_get_profile_name(const AVCodec *codec, int profile);
3429

    
3430
/**
3431
 * Set the fields of the given AVCodecContext to default values.
3432
 *
3433
 * @param s The AVCodecContext of which the fields should be set to default values.
3434
 */
3435
void avcodec_get_context_defaults(AVCodecContext *s);
3436

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

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

    
3445
/**
3446
 * Allocate an AVCodecContext and set its fields to default values.  The
3447
 * resulting struct can be deallocated by simply calling av_free().
3448
 *
3449
 * @return An AVCodecContext filled with default values or NULL on failure.
3450
 * @see avcodec_get_context_defaults
3451
 */
3452
AVCodecContext *avcodec_alloc_context(void);
3453

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

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

    
3462
/**
3463
 * Copy the settings of the source AVCodecContext into the destination
3464
 * AVCodecContext. The resulting destination codec context will be
3465
 * unopened, i.e. you are required to call avcodec_open() before you
3466
 * can use this AVCodecContext to decode/encode video/audio data.
3467
 *
3468
 * @param dest target codec context, should be initialized with
3469
 *             avcodec_alloc_context(), but otherwise uninitialized
3470
 * @param src source codec context
3471
 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3472
 */
3473
int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3474

    
3475
/**
3476
 * Set the fields of the given AVFrame to default values.
3477
 *
3478
 * @param pic The AVFrame of which the fields should be set to default values.
3479
 */
3480
void avcodec_get_frame_defaults(AVFrame *pic);
3481

    
3482
/**
3483
 * Allocate an AVFrame and set its fields to default values.  The resulting
3484
 * struct can be deallocated by simply calling av_free().
3485
 *
3486
 * @return An AVFrame filled with default values or NULL on failure.
3487
 * @see avcodec_get_frame_defaults
3488
 */
3489
AVFrame *avcodec_alloc_frame(void);
3490

    
3491
int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3492
void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3493
int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3494

    
3495
/**
3496
 * Return the amount of padding in pixels which the get_buffer callback must
3497
 * provide around the edge of the image for codecs which do not have the
3498
 * CODEC_FLAG_EMU_EDGE flag.
3499
 *
3500
 * @return Required padding in pixels.
3501
 */
3502
unsigned avcodec_get_edge_width(void);
3503
/**
3504
 * Modify width and height values so that they will result in a memory
3505
 * buffer that is acceptable for the codec if you do not use any horizontal
3506
 * padding.
3507
 *
3508
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3509
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3510
 * according to avcodec_get_edge_width() before.
3511
 */
3512
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3513
/**
3514
 * Modify width and height values so that they will result in a memory
3515
 * buffer that is acceptable for the codec if you also ensure that all
3516
 * line sizes are a multiple of the respective linesize_align[i].
3517
 *
3518
 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3519
 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3520
 * according to avcodec_get_edge_width() before.
3521
 */
3522
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3523
                               int linesize_align[4]);
3524

    
3525
#if LIBAVCODEC_VERSION_MAJOR < 53
3526
/**
3527
 * @deprecated Deprecated in favor of av_check_image_size().
3528
 */
3529
attribute_deprecated
3530
int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3531
#endif
3532

    
3533
enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3534

    
3535
int avcodec_thread_init(AVCodecContext *s, int thread_count);
3536
void avcodec_thread_free(AVCodecContext *s);
3537
int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3538
int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3539
//FIXME func typedef
3540

    
3541
/**
3542
 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3543
 * function the context has to be allocated.
3544
 *
3545
 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3546
 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3547
 * retrieving a codec.
3548
 *
3549
 * @warning This function is not thread safe!
3550
 *
3551
 * @code
3552
 * avcodec_register_all();
3553
 * codec = avcodec_find_decoder(CODEC_ID_H264);
3554
 * if (!codec)
3555
 *     exit(1);
3556
 *
3557
 * context = avcodec_alloc_context();
3558
 *
3559
 * if (avcodec_open(context, codec) < 0)
3560
 *     exit(1);
3561
 * @endcode
3562
 *
3563
 * @param avctx The context which will be set up to use the given codec.
3564
 * @param codec The codec to use within the context.
3565
 * @return zero on success, a negative value on error
3566
 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3567
 */
3568
int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3569

    
3570
#if FF_API_AUDIO_OLD
3571
/**
3572
 * Decode an audio frame from buf into samples.
3573
 * Wrapper function which calls avcodec_decode_audio3.
3574
 *
3575
 * @deprecated Use avcodec_decode_audio3 instead.
3576
 * @param avctx the codec context
3577
 * @param[out] samples the output buffer
3578
 * @param[in,out] frame_size_ptr the output buffer size in bytes
3579
 * @param[in] buf the input buffer
3580
 * @param[in] buf_size the input buffer size in bytes
3581
 * @return On error a negative value is returned, otherwise the number of bytes
3582
 * used or zero if no frame could be decompressed.
3583
 */
3584
attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3585
                         int *frame_size_ptr,
3586
                         const uint8_t *buf, int buf_size);
3587
#endif
3588

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

    
3632
#if FF_API_VIDEO_OLD
3633
/**
3634
 * Decode a video frame from buf into picture.
3635
 * Wrapper function which calls avcodec_decode_video2.
3636
 *
3637
 * @deprecated Use avcodec_decode_video2 instead.
3638
 * @param avctx the codec context
3639
 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3640
 * @param[in] buf the input buffer
3641
 * @param[in] buf_size the size of the input buffer in bytes
3642
 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3643
 * @return On error a negative value is returned, otherwise the number of bytes
3644
 * used or zero if no frame could be decompressed.
3645
 */
3646
attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3647
                         int *got_picture_ptr,
3648
                         const uint8_t *buf, int buf_size);
3649
#endif
3650

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

    
3695
#if FF_API_SUBTITLE_OLD
3696
/* Decode a subtitle message. Return -1 if error, otherwise return the
3697
 * number of bytes used. If no subtitle could be decompressed,
3698
 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3699
attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3700
                            int *got_sub_ptr,
3701
                            const uint8_t *buf, int buf_size);
3702
#endif
3703

    
3704
/**
3705
 * Decode a subtitle message.
3706
 * Return a negative value on error, otherwise return the number of bytes used.
3707
 * If no subtitle could be decompressed, got_sub_ptr is zero.
3708
 * Otherwise, the subtitle is stored in *sub.
3709
 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3710
 * simplicity, because the performance difference is expect to be negligible
3711
 * and reusing a get_buffer written for video codecs would probably perform badly
3712
 * due to a potentially very different allocation pattern.
3713
 *
3714
 * @param avctx the codec context
3715
 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3716
                   freed with avsubtitle_free if *got_sub_ptr is set.
3717
 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3718
 * @param[in] avpkt The input AVPacket containing the input buffer.
3719
 */
3720
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3721
                            int *got_sub_ptr,
3722
                            AVPacket *avpkt);
3723

    
3724
/**
3725
 * Frees all allocated data in the given subtitle struct.
3726
 *
3727
 * @param sub AVSubtitle to free.
3728
 */
3729
void avsubtitle_free(AVSubtitle *sub);
3730

    
3731
int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3732
                        int *data_size_ptr,
3733
                        uint8_t *buf, int buf_size);
3734

    
3735
/**
3736
 * Encode an audio frame from samples into buf.
3737
 *
3738
 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3739
 * However, for PCM audio the user will know how much space is needed
3740
 * because it depends on the value passed in buf_size as described
3741
 * below. In that case a lower value can be used.
3742
 *
3743
 * @param avctx the codec context
3744
 * @param[out] buf the output buffer
3745
 * @param[in] buf_size the output buffer size
3746
 * @param[in] samples the input buffer containing the samples
3747
 * The number of samples read from this buffer is frame_size*channels,
3748
 * both of which are defined in avctx.
3749
 * For PCM audio the number of samples read from samples is equal to
3750
 * buf_size * input_sample_size / output_sample_size.
3751
 * @return On error a negative value is returned, on success zero or the number
3752
 * of bytes used to encode the data read from the input buffer.
3753
 */
3754
int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3755
                         const short *samples);
3756

    
3757
/**
3758
 * Encode a video frame from pict into buf.
3759
 * The input picture should be
3760
 * stored using a specific format, namely avctx.pix_fmt.
3761
 *
3762
 * @param avctx the codec context
3763
 * @param[out] buf the output buffer for the bitstream of encoded frame
3764
 * @param[in] buf_size the size of the output buffer in bytes
3765
 * @param[in] pict the input picture to encode
3766
 * @return On error a negative value is returned, on success zero or the number
3767
 * of bytes used from the output buffer.
3768
 */
3769
int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3770
                         const AVFrame *pict);
3771
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3772
                            const AVSubtitle *sub);
3773

    
3774
int avcodec_close(AVCodecContext *avctx);
3775

    
3776
/**
3777
 * Register all the codecs, parsers and bitstream filters which were enabled at
3778
 * configuration time. If you do not call this function you can select exactly
3779
 * which formats you want to support, by using the individual registration
3780
 * functions.
3781
 *
3782
 * @see avcodec_register
3783
 * @see av_register_codec_parser
3784
 * @see av_register_bitstream_filter
3785
 */
3786
void avcodec_register_all(void);
3787

    
3788
/**
3789
 * Flush buffers, should be called when seeking or when switching to a different stream.
3790
 */
3791
void avcodec_flush_buffers(AVCodecContext *avctx);
3792

    
3793
void avcodec_default_free_buffers(AVCodecContext *s);
3794

    
3795
/* misc useful functions */
3796

    
3797
/**
3798
 * Return a single letter to describe the given picture type pict_type.
3799
 *
3800
 * @param[in] pict_type the picture type
3801
 * @return A single character representing the picture type.
3802
 */
3803
char av_get_pict_type_char(int pict_type);
3804

    
3805
/**
3806
 * Return codec bits per sample.
3807
 *
3808
 * @param[in] codec_id the codec
3809
 * @return Number of bits per sample or zero if unknown for the given codec.
3810
 */
3811
int av_get_bits_per_sample(enum CodecID codec_id);
3812

    
3813
#if FF_API_OLD_SAMPLE_FMT
3814
/**
3815
 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3816
 */
3817
attribute_deprecated
3818
int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3819
#endif
3820

    
3821
/* frame parsing */
3822
typedef struct AVCodecParserContext {
3823
    void *priv_data;
3824
    struct AVCodecParser *parser;
3825
    int64_t frame_offset; /* offset of the current frame */
3826
    int64_t cur_offset; /* current offset
3827
                           (incremented by each av_parser_parse()) */
3828
    int64_t next_frame_offset; /* offset of the next frame */
3829
    /* video info */
3830
    int pict_type; /* XXX: Put it back in AVCodecContext. */
3831
    /**
3832
     * This field is used for proper frame duration computation in lavf.
3833
     * It signals, how much longer the frame duration of the current frame
3834
     * is compared to normal frame duration.
3835
     *
3836
     * frame_duration = (1 + repeat_pict) * time_base
3837
     *
3838
     * It is used by codecs like H.264 to display telecined material.
3839
     */
3840
    int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3841
    int64_t pts;     /* pts of the current frame */
3842
    int64_t dts;     /* dts of the current frame */
3843

    
3844
    /* private data */
3845
    int64_t last_pts;
3846
    int64_t last_dts;
3847
    int fetch_timestamp;
3848

    
3849
#define AV_PARSER_PTS_NB 4
3850
    int cur_frame_start_index;
3851
    int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3852
    int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3853
    int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3854

    
3855
    int flags;
3856
#define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3857
#define PARSER_FLAG_ONCE                      0x0002
3858
/// Set if the parser has a valid file offset
3859
#define PARSER_FLAG_FETCHED_OFFSET            0x0004
3860

    
3861
    int64_t offset;      ///< byte offset from starting packet start
3862
    int64_t cur_frame_end[AV_PARSER_PTS_NB];
3863

    
3864
    /*!
3865
     * Set by parser to 1 for key frames and 0 for non-key frames.
3866
     * It is initialized to -1, so if the parser doesn't set this flag,
3867
     * old-style fallback using FF_I_TYPE picture type as key frames
3868
     * will be used.
3869
     */
3870
    int key_frame;
3871

    
3872
    /**
3873
     * Time difference in stream time base units from the pts of this
3874
     * packet to the point at which the output from the decoder has converged
3875
     * independent from the availability of previous frames. That is, the
3876
     * frames are virtually identical no matter if decoding started from
3877
     * the very first frame or from this keyframe.
3878
     * Is AV_NOPTS_VALUE if unknown.
3879
     * This field is not the display duration of the current frame.
3880
     * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3881
     * set.
3882
     *
3883
     * The purpose of this field is to allow seeking in streams that have no
3884
     * keyframes in the conventional sense. It corresponds to the
3885
     * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3886
     * essential for some types of subtitle streams to ensure that all
3887
     * subtitles are correctly displayed after seeking.
3888
     */
3889
    int64_t convergence_duration;
3890

    
3891
    // Timestamp generation support:
3892
    /**
3893
     * Synchronization point for start of timestamp generation.
3894
     *
3895
     * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3896
     * (default).
3897
     *
3898
     * For example, this corresponds to presence of H.264 buffering period
3899
     * SEI message.
3900
     */
3901
    int dts_sync_point;
3902

    
3903
    /**
3904
     * Offset of the current timestamp against last timestamp sync point in
3905
     * units of AVCodecContext.time_base.
3906
     *
3907
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3908
     * contain a valid timestamp offset.
3909
     *
3910
     * Note that the timestamp of sync point has usually a nonzero
3911
     * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3912
     * the next frame after timestamp sync point will be usually 1.
3913
     *
3914
     * For example, this corresponds to H.264 cpb_removal_delay.
3915
     */
3916
    int dts_ref_dts_delta;
3917

    
3918
    /**
3919
     * Presentation delay of current frame in units of AVCodecContext.time_base.
3920
     *
3921
     * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3922
     * contain valid non-negative timestamp delta (presentation time of a frame
3923
     * must not lie in the past).
3924
     *
3925
     * This delay represents the difference between decoding and presentation
3926
     * time of the frame.
3927
     *
3928
     * For example, this corresponds to H.264 dpb_output_delay.
3929
     */
3930
    int pts_dts_delta;
3931

    
3932
    /**
3933
     * Position of the packet in file.
3934
     *
3935
     * Analogous to cur_frame_pts/dts
3936
     */
3937
    int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3938

    
3939
    /**
3940
     * Byte position of currently parsed frame in stream.
3941
     */
3942
    int64_t pos;
3943

    
3944
    /**
3945
     * Previous frame byte position.
3946
     */
3947
    int64_t last_pos;
3948
} AVCodecParserContext;
3949

    
3950
typedef struct AVCodecParser {
3951
    int codec_ids[5]; /* several codec IDs are permitted */
3952
    int priv_data_size;
3953
    int (*parser_init)(AVCodecParserContext *s);
3954
    int (*parser_parse)(AVCodecParserContext *s,
3955
                        AVCodecContext *avctx,
3956
                        const uint8_t **poutbuf, int *poutbuf_size,
3957
                        const uint8_t *buf, int buf_size);
3958
    void (*parser_close)(AVCodecParserContext *s);
3959
    int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3960
    struct AVCodecParser *next;
3961
} AVCodecParser;
3962

    
3963
AVCodecParser *av_parser_next(AVCodecParser *c);
3964

    
3965
void av_register_codec_parser(AVCodecParser *parser);
3966
AVCodecParserContext *av_parser_init(int codec_id);
3967

    
3968
#if LIBAVCODEC_VERSION_MAJOR < 53
3969
attribute_deprecated
3970
int av_parser_parse(AVCodecParserContext *s,
3971
                    AVCodecContext *avctx,
3972
                    uint8_t **poutbuf, int *poutbuf_size,
3973
                    const uint8_t *buf, int buf_size,
3974
                    int64_t pts, int64_t dts);
3975
#endif
3976

    
3977
/**
3978
 * Parse a packet.
3979
 *
3980
 * @param s             parser context.
3981
 * @param avctx         codec context.
3982
 * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3983
 * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3984
 * @param buf           input buffer.
3985
 * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3986
 * @param pts           input presentation timestamp.
3987
 * @param dts           input decoding timestamp.
3988
 * @param pos           input byte position in stream.
3989
 * @return the number of bytes of the input bitstream used.
3990
 *
3991
 * Example:
3992
 * @code
3993
 *   while(in_len){
3994
 *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3995
 *                                        in_data, in_len,
3996
 *                                        pts, dts, pos);
3997
 *       in_data += len;
3998
 *       in_len  -= len;
3999
 *
4000
 *       if(size)
4001
 *          decode_frame(data, size);
4002
 *   }
4003
 * @endcode
4004
 */
4005
int av_parser_parse2(AVCodecParserContext *s,
4006
                     AVCodecContext *avctx,
4007
                     uint8_t **poutbuf, int *poutbuf_size,
4008
                     const uint8_t *buf, int buf_size,
4009
                     int64_t pts, int64_t dts,
4010
                     int64_t pos);
4011

    
4012
int av_parser_change(AVCodecParserContext *s,
4013
                     AVCodecContext *avctx,
4014
                     uint8_t **poutbuf, int *poutbuf_size,
4015
                     const uint8_t *buf, int buf_size, int keyframe);
4016
void av_parser_close(AVCodecParserContext *s);
4017

    
4018

    
4019
typedef struct AVBitStreamFilterContext {
4020
    void *priv_data;
4021
    struct AVBitStreamFilter *filter;
4022
    AVCodecParserContext *parser;
4023
    struct AVBitStreamFilterContext *next;
4024
} AVBitStreamFilterContext;
4025

    
4026

    
4027
typedef struct AVBitStreamFilter {
4028
    const char *name;
4029
    int priv_data_size;
4030
    int (*filter)(AVBitStreamFilterContext *bsfc,
4031
                  AVCodecContext *avctx, const char *args,
4032
                  uint8_t **poutbuf, int *poutbuf_size,
4033
                  const uint8_t *buf, int buf_size, int keyframe);
4034
    void (*close)(AVBitStreamFilterContext *bsfc);
4035
    struct AVBitStreamFilter *next;
4036
} AVBitStreamFilter;
4037

    
4038
void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4039
AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4040
int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4041
                               AVCodecContext *avctx, const char *args,
4042
                               uint8_t **poutbuf, int *poutbuf_size,
4043
                               const uint8_t *buf, int buf_size, int keyframe);
4044
void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4045

    
4046
AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4047

    
4048
/* memory */
4049

    
4050
/**
4051
 * Reallocate the given block if it is not large enough, otherwise do nothing.
4052
 *
4053
 * @see av_realloc
4054
 */
4055
void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4056

    
4057
/**
4058
 * Allocate a buffer, reusing the given one if large enough.
4059
 *
4060
 * Contrary to av_fast_realloc the current buffer contents might not be
4061
 * preserved and on error the old buffer is freed, thus no special
4062
 * handling to avoid memleaks is necessary.
4063
 *
4064
 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4065
 * @param size size of the buffer *ptr points to
4066
 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4067
 *                 *size 0 if an error occurred.
4068
 */
4069
void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4070

    
4071
#if LIBAVCODEC_VERSION_MAJOR < 53
4072
/**
4073
 * @deprecated Deprecated in favor of av_image_copy().
4074
 */
4075
attribute_deprecated
4076
void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4077
                          uint8_t *src_data[4], int src_linesize[4],
4078
                          enum PixelFormat pix_fmt, int width, int height);
4079
#endif
4080

    
4081
/**
4082
 * Copy image src to dst. Wraps av_picture_data_copy() above.
4083
 */
4084
void av_picture_copy(AVPicture *dst, const AVPicture *src,
4085
                     enum PixelFormat pix_fmt, int width, int height);
4086

    
4087
/**
4088
 * Crop image top and left side.
4089
 */
4090
int av_picture_crop(AVPicture *dst, const AVPicture *src,
4091
                    enum PixelFormat pix_fmt, int top_band, int left_band);
4092

    
4093
/**
4094
 * Pad image.
4095
 */
4096
int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4097
            int padtop, int padbottom, int padleft, int padright, int *color);
4098

    
4099
/**
4100
 * Encode extradata length to a buffer. Used by xiph codecs.
4101
 *
4102
 * @param s buffer to write to; must be at least (v/255+1) bytes long
4103
 * @param v size of extradata in bytes
4104
 * @return number of bytes written to the buffer.
4105
 */
4106
unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4107

    
4108
#if LIBAVCODEC_VERSION_MAJOR < 53
4109
/**
4110
 * Parse str and put in width_ptr and height_ptr the detected values.
4111
 *
4112
 * @deprecated Deprecated in favor of av_parse_video_size().
4113
 */
4114
attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4115

    
4116
/**
4117
 * Parse str and store the detected values in *frame_rate.
4118
 *
4119
 * @deprecated Deprecated in favor of av_parse_video_rate().
4120
 */
4121
attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4122
#endif
4123

    
4124
/**
4125
 * Logs a generic warning message about a missing feature. This function is
4126
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4127
 * only, and would normally not be used by applications.
4128
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4129
 * a pointer to an AVClass struct
4130
 * @param[in] feature string containing the name of the missing feature
4131
 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4132
 * If want_sample is non-zero, additional verbage will be added to the log
4133
 * message which tells the user how to report samples to the development
4134
 * mailing list.
4135
 */
4136
void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4137

    
4138
/**
4139
 * Log a generic warning message asking for a sample. This function is
4140
 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4141
 * only, and would normally not be used by applications.
4142
 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4143
 * a pointer to an AVClass struct
4144
 * @param[in] msg string containing an optional message, or NULL if no message
4145
 */
4146
void av_log_ask_for_sample(void *avc, const char *msg);
4147

    
4148
/**
4149
 * Register the hardware accelerator hwaccel.
4150
 */
4151
void av_register_hwaccel(AVHWAccel *hwaccel);
4152

    
4153
/**
4154
 * If hwaccel is NULL, returns the first registered hardware accelerator,
4155
 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4156
 * after hwaccel, or NULL if hwaccel is the last one.
4157
 */
4158
AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4159

    
4160

    
4161
/**
4162
 * Lock operation used by lockmgr
4163
 */
4164
enum AVLockOp {
4165
  AV_LOCK_CREATE,  ///< Create a mutex
4166
  AV_LOCK_OBTAIN,  ///< Lock the mutex
4167
  AV_LOCK_RELEASE, ///< Unlock the mutex
4168
  AV_LOCK_DESTROY, ///< Free mutex resources
4169
};
4170

    
4171
/**
4172
 * Register a user provided lock manager supporting the operations
4173
 * specified by AVLockOp. mutex points to a (void *) where the
4174
 * lockmgr should store/get a pointer to a user allocated mutex. It's
4175
 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4176
 *
4177
 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4178
 *           callback during the call to av_lockmgr_register().
4179
 *           Thus, the application must be prepared to handle that.
4180
 *           If cb is set to NULL the lockmgr will be unregistered.
4181
 *           Also note that during unregistration the previously registered
4182
 *           lockmgr callback may also be invoked.
4183
 */
4184
int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4185

    
4186
#endif /* AVCODEC_AVCODEC_H */