avcodec.h 95.6 KB
Newer Older
1 2 3
/*
 * copyright (c) 2001 Fabrice Bellard
 *
4 5 6
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * 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 13 14 15 16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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 22
#ifndef FFMPEG_AVCODEC_H
#define FFMPEG_AVCODEC_H
Fabrice Bellard's avatar
Fabrice Bellard committed
23

Michael Niedermayer's avatar
Michael Niedermayer committed
24 25
/**
 * @file avcodec.h
Diego Biurrun's avatar
Diego Biurrun committed
26
 * external API header
Michael Niedermayer's avatar
Michael Niedermayer committed
27 28 29
 */


30
#include "libavutil/avutil.h"
Fabrice Bellard's avatar
Fabrice Bellard committed
31

32
#define LIBAVCODEC_VERSION_MAJOR 51
33
#define LIBAVCODEC_VERSION_MINOR 70
Ramiro Polla's avatar
Ramiro Polla committed
34
#define LIBAVCODEC_VERSION_MICRO  0
35

36 37 38 39 40 41
#define LIBAVCODEC_VERSION_INT  AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
                                               LIBAVCODEC_VERSION_MINOR, \
                                               LIBAVCODEC_VERSION_MICRO)
#define LIBAVCODEC_VERSION      AV_VERSION(LIBAVCODEC_VERSION_MAJOR,    \
                                           LIBAVCODEC_VERSION_MINOR,    \
                                           LIBAVCODEC_VERSION_MICRO)
42
#define LIBAVCODEC_BUILD        LIBAVCODEC_VERSION_INT
Michael Niedermayer's avatar
Michael Niedermayer committed
43

44
#define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
Alex Beregszaszi's avatar
Alex Beregszaszi committed
45

46
#define AV_NOPTS_VALUE          INT64_C(0x8000000000000000)
47 48
#define AV_TIME_BASE            1000000
#define AV_TIME_BASE_Q          (AVRational){1, AV_TIME_BASE}
49

50
/**
Nicolas George's avatar
Nicolas George committed
51 52 53 54 55 56
 * Identifies the syntax and semantics of the bitstream.
 * The principle is roughly:
 * Two decoders with the same ID can decode the same streams.
 * Two encoders with the same ID can encode compatible streams.
 * There may be slight deviations from the principle due to implementation
 * details.
57
 *
Diego Biurrun's avatar
Diego Biurrun committed
58 59 60
 * If you add a codec ID to this list, add it so that
 * 1. no value of a existing codec ID changes (that would break ABI),
 * 2. it is as close as possible to similar codecs.
61
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
62
enum CodecID {
63
    CODEC_ID_NONE,
64 65

    /* video codecs */
Fabrice Bellard's avatar
Fabrice Bellard committed
66
    CODEC_ID_MPEG1VIDEO,
67
    CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
Ivan Kalvachev's avatar
Ivan Kalvachev committed
68
    CODEC_ID_MPEG2VIDEO_XVMC,
69
    CODEC_ID_H261,
Fabrice Bellard's avatar
Fabrice Bellard committed
70 71
    CODEC_ID_H263,
    CODEC_ID_RV10,
Michael Niedermayer's avatar
Michael Niedermayer committed
72
    CODEC_ID_RV20,
Fabrice Bellard's avatar
Fabrice Bellard committed
73
    CODEC_ID_MJPEG,
74
    CODEC_ID_MJPEGB,
75
    CODEC_ID_LJPEG,
76
    CODEC_ID_SP5X,
77
    CODEC_ID_JPEGLS,
Fabrice Bellard's avatar
Fabrice Bellard committed
78
    CODEC_ID_MPEG4,
Fabrice Bellard's avatar
Fabrice Bellard committed
79
    CODEC_ID_RAWVIDEO,
80 81 82
    CODEC_ID_MSMPEG4V1,
    CODEC_ID_MSMPEG4V2,
    CODEC_ID_MSMPEG4V3,
83
    CODEC_ID_WMV1,
Michael Niedermayer's avatar
Michael Niedermayer committed
84
    CODEC_ID_WMV2,
Fabrice Bellard's avatar
Fabrice Bellard committed
85 86
    CODEC_ID_H263P,
    CODEC_ID_H263I,
87
    CODEC_ID_FLV1,
Nick Kurshev's avatar
Nick Kurshev committed
88
    CODEC_ID_SVQ1,
89
    CODEC_ID_SVQ3,
Fabrice Bellard's avatar
Fabrice Bellard committed
90
    CODEC_ID_DVVIDEO,
Michael Niedermayer's avatar
huffyuv  
Michael Niedermayer committed
91
    CODEC_ID_HUFFYUV,
92
    CODEC_ID_CYUV,
Michael Niedermayer's avatar
Michael Niedermayer committed
93
    CODEC_ID_H264,
94
    CODEC_ID_INDEO3,
95
    CODEC_ID_VP3,
96
    CODEC_ID_THEORA,
Michael Niedermayer's avatar
Michael Niedermayer committed
97
    CODEC_ID_ASV1,
Michael Niedermayer's avatar
Michael Niedermayer committed
98
    CODEC_ID_ASV2,
99
    CODEC_ID_FFV1,
100
    CODEC_ID_4XM,
Michael Niedermayer's avatar
Michael Niedermayer committed
101
    CODEC_ID_VCR1,
Alex Beregszaszi's avatar
Alex Beregszaszi committed
102
    CODEC_ID_CLJR,
103
    CODEC_ID_MDEC,
104 105
    CODEC_ID_ROQ,
    CODEC_ID_INTERPLAY_VIDEO,
106 107
    CODEC_ID_XAN_WC3,
    CODEC_ID_XAN_WC4,
108 109 110 111 112
    CODEC_ID_RPZA,
    CODEC_ID_CINEPAK,
    CODEC_ID_WS_VQA,
    CODEC_ID_MSRLE,
    CODEC_ID_MSVIDEO1,
113
    CODEC_ID_IDCIN,
Roberto Togni's avatar
Roberto Togni committed
114
    CODEC_ID_8BPS,
115
    CODEC_ID_SMC,
Mike Melanson's avatar
Mike Melanson committed
116
    CODEC_ID_FLIC,
117
    CODEC_ID_TRUEMOTION1,
118
    CODEC_ID_VMDVIDEO,
Roberto Togni's avatar
Roberto Togni committed
119 120
    CODEC_ID_MSZH,
    CODEC_ID_ZLIB,
121
    CODEC_ID_QTRLE,
122
    CODEC_ID_SNOW,
123
    CODEC_ID_TSCC,
124
    CODEC_ID_ULTI,
125
    CODEC_ID_QDRAW,
126
    CODEC_ID_VIXL,
127
    CODEC_ID_QPEG,
128 129 130 131 132 133 134
    CODEC_ID_XVID,
    CODEC_ID_PNG,
    CODEC_ID_PPM,
    CODEC_ID_PBM,
    CODEC_ID_PGM,
    CODEC_ID_PGMYUV,
    CODEC_ID_PAM,
Loren Merritt's avatar
Loren Merritt committed
135
    CODEC_ID_FFVHUFF,
136 137
    CODEC_ID_RV30,
    CODEC_ID_RV40,
138
    CODEC_ID_VC1,
139
    CODEC_ID_WMV3,
140
    CODEC_ID_LOCO,
141
    CODEC_ID_WNV1,
142
    CODEC_ID_AASC,
143
    CODEC_ID_INDEO2,
144
    CODEC_ID_FRAPS,
145
    CODEC_ID_TRUEMOTION2,
Måns Rullgård's avatar
Måns Rullgård committed
146
    CODEC_ID_BMP,
147
    CODEC_ID_CSCD,
148
    CODEC_ID_MMVIDEO,
149
    CODEC_ID_ZMBV,
150
    CODEC_ID_AVS,
Kostya Shishkov's avatar
Kostya Shishkov committed
151
    CODEC_ID_SMACKVIDEO,
152
    CODEC_ID_NUV,
153
    CODEC_ID_KMVC,
154
    CODEC_ID_FLASHSV,
155
    CODEC_ID_CAVS,
156
    CODEC_ID_JPEG2000,
157
    CODEC_ID_VMNC,
Aurelien Jacobs's avatar
Aurelien Jacobs committed
158 159 160
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
Kostya Shishkov's avatar
Kostya Shishkov committed
161
    CODEC_ID_TARGA,
162
    CODEC_ID_DSICINVIDEO,
163
    CODEC_ID_TIERTEXSEQVIDEO,
Kostya Shishkov's avatar
Kostya Shishkov committed
164
    CODEC_ID_TIFF,
165
    CODEC_ID_GIF,
166
    CODEC_ID_FFH264,
Kostya Shishkov's avatar
Kostya Shishkov committed
167
    CODEC_ID_DXA,
Baptiste Coudurier's avatar
Baptiste Coudurier committed
168
    CODEC_ID_DNXHD,
169
    CODEC_ID_THP,
170
    CODEC_ID_SGI,
171
    CODEC_ID_C93,
172
    CODEC_ID_BETHSOFTVID,
Ivo van Poorten's avatar
Ivo van Poorten committed
173
    CODEC_ID_PTX,
Ivo van Poorten's avatar
Ivo van Poorten committed
174
    CODEC_ID_TXD,
175
    CODEC_ID_VP6A,
Vladimir Voroshilov's avatar
Vladimir Voroshilov committed
176
    CODEC_ID_AMV,
177
    CODEC_ID_VB,
178
    CODEC_ID_PCX,
Ivo van Poorten's avatar
Ivo van Poorten committed
179
    CODEC_ID_SUNRAST,
180 181
    CODEC_ID_INDEO4,
    CODEC_ID_INDEO5,
Ramiro Polla's avatar
Ramiro Polla committed
182
    CODEC_ID_MIMIC,
Sascha Sommer's avatar
Sascha Sommer committed
183
    CODEC_ID_RL2,
Jai Menon's avatar
Jai Menon committed
184 185
    CODEC_ID_8SVX_EXP,
    CODEC_ID_8SVX_FIB,
Eli Friedman's avatar
Eli Friedman committed
186
    CODEC_ID_ESCAPE124,
Michael Niedermayer's avatar
Michael Niedermayer committed
187
    CODEC_ID_DIRAC,
Sisir Koppaka's avatar
Sisir Koppaka committed
188
    CODEC_ID_BFI,
Peter Ross's avatar
Peter Ross committed
189
    CODEC_ID_CMV,
Gregory Montoir's avatar
Gregory Montoir committed
190
    CODEC_ID_MOTIONPIXELS,
Peter Ross's avatar
Peter Ross committed
191
    CODEC_ID_TGV,
Fabrice Bellard's avatar
Fabrice Bellard committed
192

Diego Biurrun's avatar
Diego Biurrun committed
193
    /* various PCM "codecs" */
194
    CODEC_ID_PCM_S16LE= 0x10000,
Fabrice Bellard's avatar
Fabrice Bellard committed
195 196 197 198 199 200 201
    CODEC_ID_PCM_S16BE,
    CODEC_ID_PCM_U16LE,
    CODEC_ID_PCM_U16BE,
    CODEC_ID_PCM_S8,
    CODEC_ID_PCM_U8,
    CODEC_ID_PCM_MULAW,
    CODEC_ID_PCM_ALAW,
202 203 204 205 206 207 208 209 210
    CODEC_ID_PCM_S32LE,
    CODEC_ID_PCM_S32BE,
    CODEC_ID_PCM_U32LE,
    CODEC_ID_PCM_U32BE,
    CODEC_ID_PCM_S24LE,
    CODEC_ID_PCM_S24BE,
    CODEC_ID_PCM_U24LE,
    CODEC_ID_PCM_U24BE,
    CODEC_ID_PCM_S24DAUD,
211
    CODEC_ID_PCM_ZORK,
212
    CODEC_ID_PCM_S16LE_PLANAR,
213
    CODEC_ID_PCM_DVD,
214
    CODEC_ID_PCM_F32BE,
215 216 217
    CODEC_ID_PCM_F32LE,
    CODEC_ID_PCM_F64BE,
    CODEC_ID_PCM_F64LE,
218

Diego Biurrun's avatar
Diego Biurrun committed
219
    /* various ADPCM codecs */
220
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
221
    CODEC_ID_ADPCM_IMA_WAV,
222 223
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
224
    CODEC_ID_ADPCM_IMA_WS,
225
    CODEC_ID_ADPCM_IMA_SMJPEG,
226
    CODEC_ID_ADPCM_MS,
227
    CODEC_ID_ADPCM_4XM,
228 229
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
230
    CODEC_ID_ADPCM_EA,
231
    CODEC_ID_ADPCM_G726,
232
    CODEC_ID_ADPCM_CT,
233
    CODEC_ID_ADPCM_SWF,
234
    CODEC_ID_ADPCM_YAMAHA,
235 236 237
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
238
    CODEC_ID_ADPCM_THP,
Vitor Sessak's avatar
Vitor Sessak committed
239
    CODEC_ID_ADPCM_IMA_AMV,
Peter Ross's avatar
Peter Ross committed
240 241 242
    CODEC_ID_ADPCM_EA_R1,
    CODEC_ID_ADPCM_EA_R3,
    CODEC_ID_ADPCM_EA_R2,
Peter Ross's avatar
Peter Ross committed
243
    CODEC_ID_ADPCM_IMA_EA_SEAD,
Peter Ross's avatar
Peter Ross committed
244
    CODEC_ID_ADPCM_IMA_EA_EACS,
245
    CODEC_ID_ADPCM_EA_XAS,
Robert Marston's avatar
Robert Marston committed
246
    CODEC_ID_ADPCM_EA_MAXIS_XA,
247

248 249
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
250 251
    CODEC_ID_AMR_WB,

252
    /* RealAudio codecs*/
253
    CODEC_ID_RA_144= 0x13000,
254
    CODEC_ID_RA_288,
255 256

    /* various DPCM codecs */
257
    CODEC_ID_ROQ_DPCM= 0x14000,
258
    CODEC_ID_INTERPLAY_DPCM,
259
    CODEC_ID_XAN_DPCM,
260
    CODEC_ID_SOL_DPCM,
261

262
    /* audio codecs */
263
    CODEC_ID_MP2= 0x15000,
264
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
265
    CODEC_ID_AAC,
266
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
267
    CODEC_ID_MPEG4AAC,
268
#endif
269 270 271 272 273 274 275 276 277 278 279
    CODEC_ID_AC3,
    CODEC_ID_DTS,
    CODEC_ID_VORBIS,
    CODEC_ID_DVAUDIO,
    CODEC_ID_WMAV1,
    CODEC_ID_WMAV2,
    CODEC_ID_MACE3,
    CODEC_ID_MACE6,
    CODEC_ID_VMDAUDIO,
    CODEC_ID_SONIC,
    CODEC_ID_SONIC_LS,
Michael Niedermayer's avatar
Michael Niedermayer committed
280
    CODEC_ID_FLAC,
Roberto Togni's avatar
Roberto Togni committed
281
    CODEC_ID_MP3ADU,
282
    CODEC_ID_MP3ON4,
283
    CODEC_ID_SHORTEN,
Michael Niedermayer's avatar
Michael Niedermayer committed
284
    CODEC_ID_ALAC,
285
    CODEC_ID_WESTWOOD_SND1,
286
    CODEC_ID_GSM, ///< as in Berlin toast format
Roberto Togni's avatar
Roberto Togni committed
287
    CODEC_ID_QDM2,
288
    CODEC_ID_COOK,
289
    CODEC_ID_TRUESPEECH,
290
    CODEC_ID_TTA,
Kostya Shishkov's avatar
Kostya Shishkov committed
291
    CODEC_ID_SMACKAUDIO,
Benjamin Larsson's avatar
Benjamin Larsson committed
292
    CODEC_ID_QCELP,
293
    CODEC_ID_WAVPACK,
294
    CODEC_ID_DSICINAUDIO,
Kostya Shishkov's avatar
Kostya Shishkov committed
295
    CODEC_ID_IMC,
296
    CODEC_ID_MUSEPACK7,
297
    CODEC_ID_MLP,
Diego Biurrun's avatar
Diego Biurrun committed
298
    CODEC_ID_GSM_MS, /* as found in WAV */
Benjamin Larsson's avatar
Benjamin Larsson committed
299
    CODEC_ID_ATRAC3,
300
    CODEC_ID_VOXWARE,
Kostya Shishkov's avatar
Kostya Shishkov committed
301
    CODEC_ID_APE,
Benjamin Larsson's avatar
Benjamin Larsson committed
302
    CODEC_ID_NELLYMOSER,
303
    CODEC_ID_MUSEPACK8,
304
    CODEC_ID_SPEEX,
305 306
    CODEC_ID_WMAVOICE,
    CODEC_ID_WMAPRO,
307
    CODEC_ID_WMALOSSLESS,
Benjamin Larsson's avatar
Benjamin Larsson committed
308
    CODEC_ID_ATRAC3P,
309

Fabrice Bellard's avatar
Fabrice Bellard committed
310
    /* subtitle codecs */
311 312
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
313
    CODEC_ID_TEXT,  ///< raw UTF-8 text
314
    CODEC_ID_XSUB,
315
    CODEC_ID_SSA,
316
    CODEC_ID_MOV_TEXT,
317

Diego Biurrun's avatar
Diego Biurrun committed
318
    /* other specific kind of codecs (generally used for attachments) */
319 320
    CODEC_ID_TTF= 0x18000,

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

323
    CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
Diego Biurrun's avatar
Diego Biurrun committed
324
                                * stream (only used by libavformat) */
Fabrice Bellard's avatar
Fabrice Bellard committed
325
};
326

327
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
Diego Biurrun's avatar
Diego Biurrun committed
328
/* CODEC_ID_MP3LAME is obsolete */
329
#define CODEC_ID_MP3LAME CODEC_ID_MP3
330 331
#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
#endif
Fabrice Bellard's avatar
Fabrice Bellard committed
332 333

enum CodecType {
334
    CODEC_TYPE_UNKNOWN = -1,
Fabrice Bellard's avatar
Fabrice Bellard committed
335 336
    CODEC_TYPE_VIDEO,
    CODEC_TYPE_AUDIO,
337
    CODEC_TYPE_DATA,
Fabrice Bellard's avatar
Fabrice Bellard committed
338
    CODEC_TYPE_SUBTITLE,
339
    CODEC_TYPE_ATTACHMENT,
340
    CODEC_TYPE_NB
Fabrice Bellard's avatar
Fabrice Bellard committed
341 342
};

343 344 345
/**
 * all in native-endian format
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
346
enum SampleFormat {
347
    SAMPLE_FMT_NONE = -1,
348 349
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
350
    SAMPLE_FMT_S24,             ///< signed 24 bits @deprecated Deprecated in favor of SAMPLE_FMT_S32
351
    SAMPLE_FMT_S32,             ///< signed 32 bits
352
    SAMPLE_FMT_FLT,             ///< float
Peter Ross's avatar
Peter Ross committed
353
    SAMPLE_FMT_DBL,             ///< double
354
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
Fabrice Bellard's avatar
Fabrice Bellard committed
355 356
};

Fabrice Bellard's avatar
Fabrice Bellard committed
357
/* in bytes */
358
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
Fabrice Bellard's avatar
Fabrice Bellard committed
359

360
/**
361
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
Diego Biurrun's avatar
Diego Biurrun committed
362 363 364 365
 * This is mainly needed because some optimized bitstream readers read
 * 32 or 64 bit at once and could read over the end.<br>
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 * MPEG bitstreams could cause overread and segfault.
366 367 368
 */
#define FF_INPUT_BUFFER_PADDING_SIZE 8

369
/**
Diego Biurrun's avatar
Diego Biurrun committed
370 371
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
372 373 374
 */
#define FF_MIN_BUFFER_SIZE 16384

375
/**
376
 * motion estimation type.
377
 */
378
enum Motion_Est_ID {
Michael Niedermayer's avatar
Michael Niedermayer committed
379
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
380 381 382
    ME_FULL,
    ME_LOG,
    ME_PHODS,
Michael Niedermayer's avatar
Michael Niedermayer committed
383 384 385 386 387
    ME_EPZS,        ///< enhanced predictive zonal search
    ME_X1,          ///< reserved for experiments
    ME_HEX,         ///< hexagon based search
    ME_UMH,         ///< uneven multi-hexagon search
    ME_ITER,        ///< iterative search
Loren Merritt's avatar
Loren Merritt committed
388
    ME_TESA,        ///< transformed exhaustive search algorithm
389 390
};

Michael Niedermayer's avatar
Michael Niedermayer committed
391
enum AVDiscard{
Diego Biurrun's avatar
Diego Biurrun committed
392 393
    /* We leave some space between them for extensions (drop some
     * keyframes for intra-only or drop just some bidir frames). */
Michael Niedermayer's avatar
Michael Niedermayer committed
394 395 396 397 398 399 400 401
    AVDISCARD_NONE   =-16, ///< discard nothing
    AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
    AVDISCARD_NONREF =  8, ///< discard all non reference
    AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
    AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
    AVDISCARD_ALL    = 48, ///< discard all
};

Michael Niedermayer's avatar
Michael Niedermayer committed
402 403 404
typedef struct RcOverride{
    int start_frame;
    int end_frame;
Diego Biurrun's avatar
Diego Biurrun committed
405
    int qscale; // If this is 0 then quality_factor will be used instead.
Michael Niedermayer's avatar
Michael Niedermayer committed
406 407 408
    float quality_factor;
} RcOverride;

409
#define FF_MAX_B_FRAMES 16
410

Michael Niedermayer's avatar
Michael Niedermayer committed
411
/* encoding support
Diego Biurrun's avatar
Diego Biurrun committed
412 413
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
Michael Niedermayer's avatar
Michael Niedermayer committed
414
*/
Fabrice Bellard's avatar
Fabrice Bellard committed
415

Diego Biurrun's avatar
Diego Biurrun committed
416 417 418 419 420 421
#define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
#define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
#define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
#define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
#define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
#define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
Michael Niedermayer's avatar
Michael Niedermayer committed
422 423
/**
 * The parent program guarantees that the input for B-frames containing
Diego Biurrun's avatar
Diego Biurrun committed
424
 * streams is not written to for at least s->max_b_frames+1 frames, if
Michael Niedermayer's avatar
Michael Niedermayer committed
425 426
 * this is not set the input will be copied.
 */
427
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
Diego Biurrun's avatar
Diego Biurrun committed
428 429 430 431 432 433 434 435
#define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
#define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
#define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
#define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
#define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
#define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
#define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
                                                  location instead of only at frame boundaries. */
Diego Biurrun's avatar
Diego Biurrun committed
436 437 438 439
#define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
#define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
#define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
440
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
Diego Biurrun's avatar
Diego Biurrun committed
441
#define CODEC_FLAG_TRELLIS_QUANT  0x00200000 ///< Use trellis quantization.
442
#endif
Diego Biurrun's avatar
Diego Biurrun committed
443 444
#define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
#define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
445
/* Fx : Flag for h263+ extra options */
446
#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
Diego Biurrun's avatar
Diego Biurrun committed
447
#define CODEC_FLAG_H263P_AIC      0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
448
#endif
Diego Biurrun's avatar
Diego Biurrun committed
449 450 451 452 453
#define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
#define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
#define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
#define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
#define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
Michael Niedermayer's avatar
Michael Niedermayer committed
454 455
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
456 457
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
Diego Biurrun's avatar
Diego Biurrun committed
458
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
459
#define CODEC_FLAG_CLOSED_GOP     0x80000000
Diego Biurrun's avatar
Diego Biurrun committed
460 461 462 463 464 465
#define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
#define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
#define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
#define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
#define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
#define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
466
#define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
Robert Swain's avatar
Robert Swain committed
467 468 469
#define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
#define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
#define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
Diego Biurrun's avatar
Diego Biurrun committed
470 471 472 473 474 475 476
#define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
#define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
#define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
#define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
#define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
477
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
478

479
/* Unsupported options :
480 481
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
482
 *              Independent Segment Decoding */
483
/* /Fx */
Fabrice Bellard's avatar
Fabrice Bellard committed
484 485
/* codec capabilities */

Diego Biurrun's avatar
Diego Biurrun committed
486
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
Michael Niedermayer's avatar
Michael Niedermayer committed
487 488 489 490 491
/**
 * Codec uses get_buffer() for allocating buffers.
 * direct rendering method 1
 */
#define CODEC_CAP_DR1             0x0002
Diego Biurrun's avatar
Diego Biurrun committed
492
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
493
#define CODEC_CAP_PARSE_ONLY      0x0004
494
#define CODEC_CAP_TRUNCATED       0x0008
Diego Biurrun's avatar
Diego Biurrun committed
495
/* Codec can export data for HW decoding (XvMC). */
496
#define CODEC_CAP_HWACCEL         0x0010
497
/**
Diego Biurrun's avatar
Diego Biurrun committed
498 499
 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 * If this is not set, the codec is guaranteed to never be fed with NULL data.
500
 */
501
#define CODEC_CAP_DELAY           0x0020
502 503 504 505 506
/**
 * Codec can be fed a final frame with a smaller size.
 * This can be used to prevent truncation of the last audio samples.
 */
#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
Fabrice Bellard's avatar
Fabrice Bellard committed
507

Diego Biurrun's avatar
Diego Biurrun committed
508
//The following defines may change, don't expect compatibility if you use them.
509
#define MB_TYPE_INTRA4x4   0x0001
Diego Biurrun's avatar
Diego Biurrun committed
510 511
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
512 513 514 515 516
#define MB_TYPE_16x16      0x0008
#define MB_TYPE_16x8       0x0010
#define MB_TYPE_8x16       0x0020
#define MB_TYPE_8x8        0x0040
#define MB_TYPE_INTERLACED 0x0080
Diego Biurrun's avatar
Diego Biurrun committed
517
#define MB_TYPE_DIRECT2    0x0100 //FIXME
518 519 520 521 522 523 524 525 526 527 528 529 530 531
#define MB_TYPE_ACPRED     0x0200
#define MB_TYPE_GMC        0x0400
#define MB_TYPE_SKIP       0x0800
#define MB_TYPE_P0L0       0x1000
#define MB_TYPE_P1L0       0x2000
#define MB_TYPE_P0L1       0x4000
#define MB_TYPE_P1L1       0x8000
#define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
#define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
#define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
#define MB_TYPE_QUANT      0x00010000
#define MB_TYPE_CBP        0x00020000
//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)

532 533
/**
 * Pan Scan area.
Diego Biurrun's avatar
Diego Biurrun committed
534 535
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
536 537 538
 */
typedef struct AVPanScan{
    /**
Diego Biurrun's avatar
Diego Biurrun committed
539 540 541
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
542 543 544 545 546
     */
    int id;

    /**
     * width and height in 1/16 pel
Diego Biurrun's avatar
Diego Biurrun committed
547 548
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
549 550 551 552 553
     */
    int width;
    int height;

    /**
Diego Biurrun's avatar
Diego Biurrun committed
554 555 556
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
557 558 559 560
     */
    int16_t position[3][2];
}AVPanScan;

Michael Niedermayer's avatar
Michael Niedermayer committed
561
#define FF_COMMON_FRAME \
562 563
    /**\
     * pointer to the picture planes.\
Diego Biurrun's avatar
Diego Biurrun committed
564
     * This might be different from the first allocated byte\
565 566 567
     * - encoding: \
     * - decoding: \
     */\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
568 569 570
    uint8_t *data[4];\
    int linesize[4];\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
571 572
     * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
     * This isn't used by libavcodec unless the default get/release_buffer() is used.\
573 574
     * - encoding: \
     * - decoding: \
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
575 576 577 578
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
Diego Biurrun's avatar
Diego Biurrun committed
579 580
     * - encoding: Set by libavcodec.\
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
581 582 583 584
     */\
    int key_frame;\
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
585 586 587
     * Picture type of the frame, see ?_TYPE below.\
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
588 589 590 591
     */\
    int pict_type;\
\
    /**\
592
     * presentation timestamp in time_base units (time when frame should be shown to user)\
Diego Biurrun's avatar
Diego Biurrun committed
593 594 595
     * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
     * - encoding: MUST be set by user.\
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
596
     */\
597
    int64_t pts;\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
598 599
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
600
     * picture number in bitstream order\
601
     * - encoding: set by\
Diego Biurrun's avatar
Diego Biurrun committed
602
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
603 604 605
     */\
    int coded_picture_number;\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
606
     * picture number in display order\
607
     * - encoding: set by\
Diego Biurrun's avatar
Diego Biurrun committed
608
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
609 610 611 612
     */\
    int display_picture_number;\
\
    /**\
613
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
Diego Biurrun's avatar
Diego Biurrun committed
614 615
     * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
616
     */\
617
    int quality; \
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
618 619 620
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
Diego Biurrun's avatar
Diego Biurrun committed
621
     * Set to INT_MAX if the buffer has not been used yet.\
622
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
623
     * - decoding: MUST be set by get_buffer().\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
624 625 626 627 628
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
629 630
     * The values for this are the same as the MpegEncContext.picture_structure\
     * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
631
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
632
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
633 634 635 636 637
     */\
    int reference;\
\
    /**\
     * QP table\
638
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
639
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
640 641 642 643
     */\
    int8_t *qscale_table;\
    /**\
     * QP store stride\
644
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
645
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
646 647 648 649
     */\
    int qstride;\
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
650
     * mbskip_table[mb]>=1 if MB didn't change\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
651
     * stride= mb_width = (width+15)>>4\
652
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
653
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
654 655
     */\
    uint8_t *mbskip_table;\
656 657
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
658
     * motion vector table\
Michael Niedermayer's avatar
Michael Niedermayer committed
659 660 661 662 663 664 665
     * @code\
     * example:\
     * int mv_sample_log2= 4 - motion_subsample_log2;\
     * int mb_width= (width+15)>>4;\
     * int mv_stride= (mb_width << mv_sample_log2) + 1;\
     * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
     * @endcode\
Diego Biurrun's avatar
Diego Biurrun committed
666 667
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
668 669 670 671
     */\
    int16_t (*motion_val[2])[2];\
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
672
     * macroblock type table\
673
     * mb_type_base + mb_width + 2\
Diego Biurrun's avatar
Diego Biurrun committed
674 675
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
676 677 678 679
     */\
    uint32_t *mb_type;\
\
    /**\
680 681
     * log2 of the size of the block which a single vector in motion_val represents: \
     * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
682
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
683
     * - decoding: Set by libavcodec.\
684 685
     */\
    uint8_t motion_subsample_log2;\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
686 687 688
\
    /**\
     * for some private data of the user\
689
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
690
     * - decoding: Set by user.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
691 692
     */\
    void *opaque;\
693 694 695
\
    /**\
     * error\
Diego Biurrun's avatar
Diego Biurrun committed
696
     * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
697
     * - decoding: unused\
698 699
     */\
    uint64_t error[4];\
Michael Niedermayer's avatar
Michael Niedermayer committed
700 701
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
702 703 704 705
     * type of the buffer (to keep track of who has to deallocate data[*])\
     * - encoding: Set by the one who allocates it.\
     * - decoding: Set by the one who allocates it.\
     * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
Michael Niedermayer's avatar
Michael Niedermayer committed
706 707
     */\
    int type;\
708 709
    \
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
710
     * When decoding, this signals how much the picture must be delayed.\
711
     * extra_delay = repeat_pict / (2*fps)\
712
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
713
     * - decoding: Set by libavcodec.\
714
     */\
Michael Niedermayer's avatar
Michael Niedermayer committed
715 716 717 718 719 720
    int repeat_pict;\
    \
    /**\
     * \
     */\
    int qscale_type;\
721 722 723
    \
    /**\
     * The content of the picture is interlaced.\
Diego Biurrun's avatar
Diego Biurrun committed
724 725
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec. (default 0)\
726 727 728 729
     */\
    int interlaced_frame;\
    \
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
730 731 732
     * If the content is interlaced, is top field displayed first.\
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
733
     */\
734
    int top_field_first;\
735 736 737
    \
    /**\
     * Pan scan.\
Diego Biurrun's avatar
Diego Biurrun committed
738 739
     * - encoding: Set by user.\
     * - decoding: Set by libavcodec.\
740 741
     */\
    AVPanScan *pan_scan;\
742 743
    \
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
744
     * Tell user application that palette has changed from previous frame.\