avcodec.h 129 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 AVCODEC_AVCODEC_H
#define AVCODEC_AVCODEC_H
Fabrice Bellard's avatar
Fabrice Bellard committed
23

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

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

32
#define LIBAVCODEC_VERSION_MAJOR 52
33
#define LIBAVCODEC_VERSION_MINOR 77
34
#define LIBAVCODEC_VERSION_MICRO  1
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
#if LIBAVCODEC_VERSION_MAJOR < 53
129
    CODEC_ID_XVID,
130
#endif
131 132 133 134 135 136
    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
137
    CODEC_ID_FFVHUFF,
138 139
    CODEC_ID_RV30,
    CODEC_ID_RV40,
140
    CODEC_ID_VC1,
141
    CODEC_ID_WMV3,
142
    CODEC_ID_LOCO,
143
    CODEC_ID_WNV1,
144
    CODEC_ID_AASC,
145
    CODEC_ID_INDEO2,
146
    CODEC_ID_FRAPS,
147
    CODEC_ID_TRUEMOTION2,
Måns Rullgård's avatar
Måns Rullgård committed
148
    CODEC_ID_BMP,
149
    CODEC_ID_CSCD,
150
    CODEC_ID_MMVIDEO,
151
    CODEC_ID_ZMBV,
152
    CODEC_ID_AVS,
Kostya Shishkov's avatar
Kostya Shishkov committed
153
    CODEC_ID_SMACKVIDEO,
154
    CODEC_ID_NUV,
155
    CODEC_ID_KMVC,
156
    CODEC_ID_FLASHSV,
157
    CODEC_ID_CAVS,
158
    CODEC_ID_JPEG2000,
159
    CODEC_ID_VMNC,
Aurelien Jacobs's avatar
Aurelien Jacobs committed
160 161 162
    CODEC_ID_VP5,
    CODEC_ID_VP6,
    CODEC_ID_VP6F,
Kostya Shishkov's avatar
Kostya Shishkov committed
163
    CODEC_ID_TARGA,
164
    CODEC_ID_DSICINVIDEO,
165
    CODEC_ID_TIERTEXSEQVIDEO,
Kostya Shishkov's avatar
Kostya Shishkov committed
166
    CODEC_ID_TIFF,
167
    CODEC_ID_GIF,
168
    CODEC_ID_FFH264,
Kostya Shishkov's avatar
Kostya Shishkov committed
169
    CODEC_ID_DXA,
Baptiste Coudurier's avatar
Baptiste Coudurier committed
170
    CODEC_ID_DNXHD,
171
    CODEC_ID_THP,
172
    CODEC_ID_SGI,
173
    CODEC_ID_C93,
174
    CODEC_ID_BETHSOFTVID,
Ivo van Poorten's avatar
Ivo van Poorten committed
175
    CODEC_ID_PTX,
Ivo van Poorten's avatar
Ivo van Poorten committed
176
    CODEC_ID_TXD,
177
    CODEC_ID_VP6A,
Vladimir Voroshilov's avatar
Vladimir Voroshilov committed
178
    CODEC_ID_AMV,
179
    CODEC_ID_VB,
180
    CODEC_ID_PCX,
Ivo van Poorten's avatar
Ivo van Poorten committed
181
    CODEC_ID_SUNRAST,
182 183
    CODEC_ID_INDEO4,
    CODEC_ID_INDEO5,
Ramiro Polla's avatar
Ramiro Polla committed
184
    CODEC_ID_MIMIC,
Sascha Sommer's avatar
Sascha Sommer committed
185
    CODEC_ID_RL2,
Jai Menon's avatar
Jai Menon committed
186 187
    CODEC_ID_8SVX_EXP,
    CODEC_ID_8SVX_FIB,
Eli Friedman's avatar
Eli Friedman committed
188
    CODEC_ID_ESCAPE124,
Michael Niedermayer's avatar
Michael Niedermayer committed
189
    CODEC_ID_DIRAC,
Sisir Koppaka's avatar
Sisir Koppaka committed
190
    CODEC_ID_BFI,
Peter Ross's avatar
Peter Ross committed
191
    CODEC_ID_CMV,
Gregory Montoir's avatar
Gregory Montoir committed
192
    CODEC_ID_MOTIONPIXELS,
Peter Ross's avatar
Peter Ross committed
193
    CODEC_ID_TGV,
Peter Ross's avatar
Peter Ross committed
194
    CODEC_ID_TGQ,
Peter Ross's avatar
Peter Ross committed
195
    CODEC_ID_TQI,
196 197
    CODEC_ID_AURA,
    CODEC_ID_AURA2,
198
    CODEC_ID_V210X,
199
    CODEC_ID_TMV,
200
    CODEC_ID_V210,
201
    CODEC_ID_DPX,
Peter Ross's avatar
Peter Ross committed
202
    CODEC_ID_MAD,
203
    CODEC_ID_FRWU,
204
    CODEC_ID_FLASHSV2,
Michael Tison's avatar
Michael Tison committed
205
    CODEC_ID_CDGRAPHICS,
206
    CODEC_ID_R210,
Peter Ross's avatar
Peter Ross committed
207
    CODEC_ID_ANM,
Daniel Verkamp's avatar
Daniel Verkamp committed
208
    CODEC_ID_BINKVIDEO,
Peter Ross's avatar
Peter Ross committed
209 210
    CODEC_ID_IFF_ILBM,
    CODEC_ID_IFF_BYTERUN1,
211
    CODEC_ID_KGV1,
212
    CODEC_ID_YOP,
Google's avatar
Google committed
213
    CODEC_ID_VP8,
Peter Ross's avatar
Peter Ross committed
214
    CODEC_ID_PICTOR,
Fabrice Bellard's avatar
Fabrice Bellard committed
215

Diego Biurrun's avatar
Diego Biurrun committed
216
    /* various PCM "codecs" */
217
    CODEC_ID_PCM_S16LE= 0x10000,
Fabrice Bellard's avatar
Fabrice Bellard committed
218 219 220 221 222 223 224
    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,
225 226 227 228 229 230 231 232 233
    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,
234
    CODEC_ID_PCM_ZORK,
235
    CODEC_ID_PCM_S16LE_PLANAR,
236
    CODEC_ID_PCM_DVD,
237
    CODEC_ID_PCM_F32BE,
238 239 240
    CODEC_ID_PCM_F32LE,
    CODEC_ID_PCM_F64BE,
    CODEC_ID_PCM_F64LE,
241
    CODEC_ID_PCM_BLURAY,
242

Diego Biurrun's avatar
Diego Biurrun committed
243
    /* various ADPCM codecs */
244
    CODEC_ID_ADPCM_IMA_QT= 0x11000,
245
    CODEC_ID_ADPCM_IMA_WAV,
246 247
    CODEC_ID_ADPCM_IMA_DK3,
    CODEC_ID_ADPCM_IMA_DK4,
248
    CODEC_ID_ADPCM_IMA_WS,
249
    CODEC_ID_ADPCM_IMA_SMJPEG,
250
    CODEC_ID_ADPCM_MS,
251
    CODEC_ID_ADPCM_4XM,
252 253
    CODEC_ID_ADPCM_XA,
    CODEC_ID_ADPCM_ADX,
254
    CODEC_ID_ADPCM_EA,
255
    CODEC_ID_ADPCM_G726,
256
    CODEC_ID_ADPCM_CT,
257
    CODEC_ID_ADPCM_SWF,
258
    CODEC_ID_ADPCM_YAMAHA,
259 260 261
    CODEC_ID_ADPCM_SBPRO_4,
    CODEC_ID_ADPCM_SBPRO_3,
    CODEC_ID_ADPCM_SBPRO_2,
262
    CODEC_ID_ADPCM_THP,
Vitor Sessak's avatar
Vitor Sessak committed
263
    CODEC_ID_ADPCM_IMA_AMV,
Peter Ross's avatar
Peter Ross committed
264 265 266
    CODEC_ID_ADPCM_EA_R1,
    CODEC_ID_ADPCM_EA_R3,
    CODEC_ID_ADPCM_EA_R2,
Peter Ross's avatar
Peter Ross committed
267
    CODEC_ID_ADPCM_IMA_EA_SEAD,
Peter Ross's avatar
Peter Ross committed
268
    CODEC_ID_ADPCM_IMA_EA_EACS,
269
    CODEC_ID_ADPCM_EA_XAS,
Robert Marston's avatar
Robert Marston committed
270
    CODEC_ID_ADPCM_EA_MAXIS_XA,
271
    CODEC_ID_ADPCM_IMA_ISS,
272

273 274
    /* AMR */
    CODEC_ID_AMR_NB= 0x12000,
275 276
    CODEC_ID_AMR_WB,

277
    /* RealAudio codecs*/
278
    CODEC_ID_RA_144= 0x13000,
279
    CODEC_ID_RA_288,
280 281

    /* various DPCM codecs */
282
    CODEC_ID_ROQ_DPCM= 0x14000,
283
    CODEC_ID_INTERPLAY_DPCM,
284
    CODEC_ID_XAN_DPCM,
285
    CODEC_ID_SOL_DPCM,
286

287
    /* audio codecs */
288
    CODEC_ID_MP2= 0x15000,
289
    CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
290 291 292 293 294 295 296 297 298 299 300 301
    CODEC_ID_AAC,
    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
302
    CODEC_ID_FLAC,
Roberto Togni's avatar
Roberto Togni committed
303
    CODEC_ID_MP3ADU,
304
    CODEC_ID_MP3ON4,
305
    CODEC_ID_SHORTEN,
Michael Niedermayer's avatar
Michael Niedermayer committed
306
    CODEC_ID_ALAC,
307
    CODEC_ID_WESTWOOD_SND1,
308
    CODEC_ID_GSM, ///< as in Berlin toast format
Roberto Togni's avatar
Roberto Togni committed
309
    CODEC_ID_QDM2,
310
    CODEC_ID_COOK,
311
    CODEC_ID_TRUESPEECH,
312
    CODEC_ID_TTA,
Kostya Shishkov's avatar
Kostya Shishkov committed
313
    CODEC_ID_SMACKAUDIO,
Benjamin Larsson's avatar
Benjamin Larsson committed
314
    CODEC_ID_QCELP,
315
    CODEC_ID_WAVPACK,
316
    CODEC_ID_DSICINAUDIO,
Kostya Shishkov's avatar
Kostya Shishkov committed
317
    CODEC_ID_IMC,
318
    CODEC_ID_MUSEPACK7,
319
    CODEC_ID_MLP,
Diego Biurrun's avatar
Diego Biurrun committed
320
    CODEC_ID_GSM_MS, /* as found in WAV */
Benjamin Larsson's avatar
Benjamin Larsson committed
321
    CODEC_ID_ATRAC3,
322
    CODEC_ID_VOXWARE,
Kostya Shishkov's avatar
Kostya Shishkov committed
323
    CODEC_ID_APE,
Benjamin Larsson's avatar
Benjamin Larsson committed
324
    CODEC_ID_NELLYMOSER,
325
    CODEC_ID_MUSEPACK8,
326
    CODEC_ID_SPEEX,
327 328
    CODEC_ID_WMAVOICE,
    CODEC_ID_WMAPRO,
329
    CODEC_ID_WMALOSSLESS,
Benjamin Larsson's avatar
Benjamin Larsson committed
330
    CODEC_ID_ATRAC3P,
331
    CODEC_ID_EAC3,
332
    CODEC_ID_SIPR,
Michael Niedermayer's avatar
Michael Niedermayer committed
333
    CODEC_ID_MP1,
Vitor Sessak's avatar
Vitor Sessak committed
334
    CODEC_ID_TWINVQ,
Ramiro Polla's avatar
Ramiro Polla committed
335
    CODEC_ID_TRUEHD,
336
    CODEC_ID_MP4ALS,
Benjamin Larsson's avatar
Benjamin Larsson committed
337
    CODEC_ID_ATRAC1,
Daniel Verkamp's avatar
Daniel Verkamp committed
338 339
    CODEC_ID_BINKAUDIO_RDFT,
    CODEC_ID_BINKAUDIO_DCT,
340

Fabrice Bellard's avatar
Fabrice Bellard committed
341
    /* subtitle codecs */
342 343
    CODEC_ID_DVD_SUBTITLE= 0x17000,
    CODEC_ID_DVB_SUBTITLE,
344
    CODEC_ID_TEXT,  ///< raw UTF-8 text
345
    CODEC_ID_XSUB,
346
    CODEC_ID_SSA,
347
    CODEC_ID_MOV_TEXT,
Stephen Backway's avatar
Stephen Backway committed
348
    CODEC_ID_HDMV_PGS_SUBTITLE,
349
    CODEC_ID_DVB_TELETEXT,
350

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

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

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

360 361 362 363 364 365 366 367 368 369 370 371
#if LIBAVCODEC_VERSION_MAJOR < 53
#define CodecType AVMediaType

#define CODEC_TYPE_UNKNOWN    AVMEDIA_TYPE_UNKNOWN
#define CODEC_TYPE_VIDEO      AVMEDIA_TYPE_VIDEO
#define CODEC_TYPE_AUDIO      AVMEDIA_TYPE_AUDIO
#define CODEC_TYPE_DATA       AVMEDIA_TYPE_DATA
#define CODEC_TYPE_SUBTITLE   AVMEDIA_TYPE_SUBTITLE
#define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
#define CODEC_TYPE_NB         AVMEDIA_TYPE_NB
#endif

372 373 374
/**
 * all in native-endian format
 */
Fabrice Bellard's avatar
Fabrice Bellard committed
375
enum SampleFormat {
376
    SAMPLE_FMT_NONE = -1,
377 378
    SAMPLE_FMT_U8,              ///< unsigned 8 bits
    SAMPLE_FMT_S16,             ///< signed 16 bits
379
    SAMPLE_FMT_S32,             ///< signed 32 bits
380
    SAMPLE_FMT_FLT,             ///< float
Peter Ross's avatar
Peter Ross committed
381
    SAMPLE_FMT_DBL,             ///< double
382
    SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
Fabrice Bellard's avatar
Fabrice Bellard committed
383 384
};

385
/* Audio channel masks */
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
#define CH_FRONT_LEFT             0x00000001
#define CH_FRONT_RIGHT            0x00000002
#define CH_FRONT_CENTER           0x00000004
#define CH_LOW_FREQUENCY          0x00000008
#define CH_BACK_LEFT              0x00000010
#define CH_BACK_RIGHT             0x00000020
#define CH_FRONT_LEFT_OF_CENTER   0x00000040
#define CH_FRONT_RIGHT_OF_CENTER  0x00000080
#define CH_BACK_CENTER            0x00000100
#define CH_SIDE_LEFT              0x00000200
#define CH_SIDE_RIGHT             0x00000400
#define CH_TOP_CENTER             0x00000800
#define CH_TOP_FRONT_LEFT         0x00001000
#define CH_TOP_FRONT_CENTER       0x00002000
#define CH_TOP_FRONT_RIGHT        0x00004000
#define CH_TOP_BACK_LEFT          0x00008000
#define CH_TOP_BACK_CENTER        0x00010000
#define CH_TOP_BACK_RIGHT         0x00020000
#define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
#define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
406

407 408 409 410 411
/** Channel mask value used for AVCodecContext.request_channel_layout
    to indicate that the user requests the channel order of the decoder output
    to be the native codec channel order. */
#define CH_LAYOUT_NATIVE          0x8000000000000000LL

412
/* Audio channel convenience macros */
413 414
#define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
#define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
415
#define CH_LAYOUT_2_1               (CH_LAYOUT_STEREO|CH_BACK_CENTER)
416
#define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
417 418
#define CH_LAYOUT_4POINT0           (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
#define CH_LAYOUT_2_2               (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
419 420 421
#define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
#define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
#define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
422 423
#define CH_LAYOUT_5POINT0_BACK      (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
#define CH_LAYOUT_5POINT1_BACK      (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
424
#define CH_LAYOUT_7POINT0           (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
425
#define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
426
#define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_5POINT1_BACK|\
427 428
                                          CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
#define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
429

Fabrice Bellard's avatar
Fabrice Bellard committed
430
/* in bytes */
431
#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
Fabrice Bellard's avatar
Fabrice Bellard committed
432

433
/**
434
 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
435 436
 * This is mainly needed because some optimized bitstream readers read
 * 32 or 64 bit at once and could read over the end.<br>
Diego Biurrun's avatar
Diego Biurrun committed
437 438
 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 * MPEG bitstreams could cause overread and segfault.
439
 */
440
#define FF_INPUT_BUFFER_PADDING_SIZE 8
441

442
/**
Diego Biurrun's avatar
Diego Biurrun committed
443 444
 * minimum encoding buffer size
 * Used to avoid some checks during header writing.
445 446 447
 */
#define FF_MIN_BUFFER_SIZE 16384

Michael Niedermayer's avatar
Michael Niedermayer committed
448

449
/**
450
 * motion estimation type.
451
 */
452
enum Motion_Est_ID {
Michael Niedermayer's avatar
Michael Niedermayer committed
453
    ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
454 455 456
    ME_FULL,
    ME_LOG,
    ME_PHODS,
Michael Niedermayer's avatar
Michael Niedermayer committed
457 458 459 460 461
    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
462
    ME_TESA,        ///< transformed exhaustive search algorithm
463 464
};

Michael Niedermayer's avatar
Michael Niedermayer committed
465
enum AVDiscard{
Diego Biurrun's avatar
Diego Biurrun committed
466 467
    /* 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
468 469 470 471 472 473 474 475
    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
};

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
enum AVColorPrimaries{
    AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
    AVCOL_PRI_UNSPECIFIED=2,
    AVCOL_PRI_BT470M     =4,
    AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
    AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
    AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
    AVCOL_PRI_FILM       =8,
    AVCOL_PRI_NB           , ///< Not part of ABI
};

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

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

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

513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
/**
 *  X   X      3 4 X      X are luma samples,
 *             1 2        1-6 are possible chroma positions
 *  X   X      5 6 X      0 is undefined/unknown position
 */
enum AVChromaLocation{
    AVCHROMA_LOC_UNSPECIFIED=0,
    AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
    AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
    AVCHROMA_LOC_TOPLEFT    =3, ///< DV
    AVCHROMA_LOC_TOP        =4,
    AVCHROMA_LOC_BOTTOMLEFT =5,
    AVCHROMA_LOC_BOTTOM     =6,
    AVCHROMA_LOC_NB           , ///< Not part of ABI
};

Michael Niedermayer's avatar
Michael Niedermayer committed
529 530 531
typedef struct RcOverride{
    int start_frame;
    int end_frame;
Diego Biurrun's avatar
Diego Biurrun committed
532
    int qscale; // If this is 0 then quality_factor will be used instead.
Michael Niedermayer's avatar
Michael Niedermayer committed
533 534 535
    float quality_factor;
} RcOverride;

536
#define FF_MAX_B_FRAMES 16
537

Michael Niedermayer's avatar
Michael Niedermayer committed
538
/* encoding support
Diego Biurrun's avatar
Diego Biurrun committed
539 540
   These flags can be passed in AVCodecContext.flags before initialization.
   Note: Not everything is supported yet.
Michael Niedermayer's avatar
Michael Niedermayer committed
541
*/
Fabrice Bellard's avatar
Fabrice Bellard committed
542

Diego Biurrun's avatar
Diego Biurrun committed
543 544 545 546 547 548
#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
549 550
/**
 * The parent program guarantees that the input for B-frames containing
Diego Biurrun's avatar
Diego Biurrun committed
551
 * streams is not written to for at least s->max_b_frames+1 frames, if
Michael Niedermayer's avatar
Michael Niedermayer committed
552 553
 * this is not set the input will be copied.
 */
554
#define CODEC_FLAG_INPUT_PRESERVED 0x0100
Diego Biurrun's avatar
Diego Biurrun committed
555 556 557 558 559 560 561 562
#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
563 564 565 566 567 568
#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.
#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).
569
/* Fx : Flag for h263+ extra options */
Diego Biurrun's avatar
Diego Biurrun committed
570 571 572 573 574
#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
575 576
#define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
#define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
577 578
#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
#define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
Diego Biurrun's avatar
Diego Biurrun committed
579
#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
580
#define CODEC_FLAG_CLOSED_GOP     0x80000000
Diego Biurrun's avatar
Diego Biurrun committed
581 582 583 584 585 586
#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
587
#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
588 589 590
#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
591 592 593 594 595 596 597
#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.
598
#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
Erik Slagter's avatar
Erik Slagter committed
599
#define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
600 601
#define CODEC_FLAG2_PSY           0x00080000 ///< Use psycho visual optimizations.
#define CODEC_FLAG2_SSIM          0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
602
#define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
603

604
/* Unsupported options :
605 606
 *              Syntax Arithmetic coding (SAC)
 *              Reference Picture Selection
607
 *              Independent Segment Decoding */
608
/* /Fx */
Fabrice Bellard's avatar
Fabrice Bellard committed
609 610
/* codec capabilities */

Diego Biurrun's avatar
Diego Biurrun committed
611
#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
Michael Niedermayer's avatar
Michael Niedermayer committed
612
/**
613 614 615
 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
 * If not set, it might not use get_buffer() at all or use operations that
 * assume the buffer was allocated by avcodec_default_get_buffer.
Michael Niedermayer's avatar
Michael Niedermayer committed
616 617
 */
#define CODEC_CAP_DR1             0x0002
Diego Biurrun's avatar
Diego Biurrun committed
618
/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
619
#define CODEC_CAP_PARSE_ONLY      0x0004
620
#define CODEC_CAP_TRUNCATED       0x0008
Diego Biurrun's avatar
Diego Biurrun committed
621
/* Codec can export data for HW decoding (XvMC). */
622
#define CODEC_CAP_HWACCEL         0x0010
623
/**
Diego Biurrun's avatar
Diego Biurrun committed
624 625
 * 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.
626
 */
627
#define CODEC_CAP_DELAY           0x0020
628 629 630 631 632
/**
 * 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
633 634 635 636
/**
 * Codec can export data for HW decoding (VDPAU).
 */
#define CODEC_CAP_HWACCEL_VDPAU    0x0080
637 638
/**
 * Codec can output multiple frames per AVPacket
639 640 641 642 643 644 645 646
 * Normally demuxers return one frame at a time, demuxers which do not do
 * are connected to a parser to split what they return into proper frames.
 * This flag is reserved to the very rare category of codecs which have a
 * bitstream that cannot be split into frames without timeconsuming
 * operations like full decoding. Demuxers carring such bitstreams thus
 * may return multiple frames in a packet. This has many disadvantages like
 * prohibiting stream copy in many cases thus it should only be considered
 * as a last resort.
647 648
 */
#define CODEC_CAP_SUBFRAMES        0x0100
649 650 651 652 653
/**
 * Codec is experimental and is thus avoided in favor of non experimental
 * encoders
 */
#define CODEC_CAP_EXPERIMENTAL     0x0200
Fabrice Bellard's avatar
Fabrice Bellard committed
654

Diego Biurrun's avatar
Diego Biurrun committed
655
//The following defines may change, don't expect compatibility if you use them.
656
#define MB_TYPE_INTRA4x4   0x0001
Diego Biurrun's avatar
Diego Biurrun committed
657 658
#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
#define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
659 660 661 662 663
#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
664
#define MB_TYPE_DIRECT2    0x0100 //FIXME
665 666 667 668 669 670 671 672 673 674 675 676 677 678
#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, ...)

679 680
/**
 * Pan Scan area.
Diego Biurrun's avatar
Diego Biurrun committed
681 682
 * This specifies the area which should be displayed.
 * Note there may be multiple such areas for one frame.
683 684 685
 */
typedef struct AVPanScan{
    /**
Diego Biurrun's avatar
Diego Biurrun committed
686 687 688
     * id
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
689 690 691 692 693
     */
    int id;

    /**
     * width and height in 1/16 pel
Diego Biurrun's avatar
Diego Biurrun committed
694 695
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
696 697 698 699 700
     */
    int width;
    int height;

    /**
Diego Biurrun's avatar
Diego Biurrun committed
701 702 703
     * position of the top left corner in 1/16 pel for up to 3 fields/frames
     * - encoding: Set by user.
     * - decoding: Set by libavcodec.
704 705 706 707
     */
    int16_t position[3][2];
}AVPanScan;

Michael Niedermayer's avatar
Michael Niedermayer committed
708
#define FF_COMMON_FRAME \
709 710
    /**\
     * pointer to the picture planes.\
Diego Biurrun's avatar
Diego Biurrun committed
711
     * This might be different from the first allocated byte\
712 713 714
     * - encoding: \
     * - decoding: \
     */\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
715 716 717
    uint8_t *data[4];\
    int linesize[4];\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
718 719
     * 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.\
720 721
     * - encoding: \
     * - decoding: \
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
722 723 724 725
     */\
    uint8_t *base[4];\
    /**\
     * 1 -> keyframe, 0-> not\
Diego Biurrun's avatar
Diego Biurrun committed
726 727
     * - encoding: Set by libavcodec.\
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
728 729 730 731
     */\
    int key_frame;\
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
732 733 734
     * 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
735 736 737 738
     */\
    int pict_type;\
\
    /**\
739
     * presentation timestamp in time_base units (time when frame should be shown to user)\
Diego Biurrun's avatar
Diego Biurrun committed
740 741 742
     * 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
743
     */\
744
    int64_t pts;\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
745 746
\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
747
     * picture number in bitstream order\
748
     * - encoding: set by\
Diego Biurrun's avatar
Diego Biurrun committed
749
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
750 751 752
     */\
    int coded_picture_number;\
    /**\
Diego Biurrun's avatar
Diego Biurrun committed
753
     * picture number in display order\
754
     * - encoding: set by\
Diego Biurrun's avatar
Diego Biurrun committed
755
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
756 757 758 759
     */\
    int display_picture_number;\
\
    /**\
760
     * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
Diego Biurrun's avatar
Diego Biurrun committed
761 762
     * - 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
763
     */\
764
    int quality; \
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
765 766 767
\
    /**\
     * buffer age (1->was last buffer and dint change, 2->..., ...).\
Diego Biurrun's avatar
Diego Biurrun committed
768
     * Set to INT_MAX if the buffer has not been used yet.\
769
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
770
     * - decoding: MUST be set by get_buffer().\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
771 772 773 774 775
     */\
    int age;\
\
    /**\
     * is this picture used as reference\
776 777
     * 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.\
778
     * Set to 4 for delayed, non-reference frames.\
779
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
780
     * - decoding: Set by libavcodec. (before get_buffer() call)).\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
781 782 783 784 785
     */\
    int reference;\
\
    /**\
     * QP table\
786
     * - encoding: unused\
Diego Biurrun's avatar
Diego Biurrun committed
787
     * - decoding: Set by libavcodec.\
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
788