Add support for speex in ogg
[libav.git] / libavcodec / avcodec.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
b78e7197 11 * FFmpeg is distributed in the hope that it will be useful,
04d7f601
DB
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
b78e7197 17 * License along with FFmpeg; if not, write to the Free Software
e5a389a1 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
04d7f601
DB
19 */
20
5b21bdab
DB
21#ifndef FFMPEG_AVCODEC_H
22#define FFMPEG_AVCODEC_H
a96b68b7 23
36df8805
MN
24/**
25 * @file avcodec.h
f5bccd85 26 * external API header
36df8805
MN
27 */
28
29
c11c2bc2 30#include "avutil.h"
4b813d5c 31#include <sys/types.h> /* size_t */
de6d9b64 32
bb270c08 33#define AV_STRINGIFY(s) AV_TOSTRING(s)
7b7d86f1 34#define AV_TOSTRING(s) #s
5aa083ee 35
f8d7c9d3
ES
36#define LIBAVCODEC_VERSION_INT ((51<<16)+(50<<8)+0)
37#define LIBAVCODEC_VERSION 51.50.0
bb270c08 38#define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
5aa083ee 39
bb270c08 40#define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
ce2749d2 41
8da9266c 42#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
bb270c08
DB
43#define AV_TIME_BASE 1000000
44#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
9740beff 45
7ebf5927 46/**
6b0cdb6e
NG
47 * Identifies the syntax and semantics of the bitstream.
48 * The principle is roughly:
49 * Two decoders with the same ID can decode the same streams.
50 * Two encoders with the same ID can encode compatible streams.
51 * There may be slight deviations from the principle due to implementation
52 * details.
7ebf5927 53 *
f5bccd85
DB
54 * If you add a codec ID to this list, add it so that
55 * 1. no value of a existing codec ID changes (that would break ABI),
56 * 2. it is as close as possible to similar codecs.
7ebf5927 57 */
de6d9b64 58enum CodecID {
115329f1 59 CODEC_ID_NONE,
de6d9b64 60 CODEC_ID_MPEG1VIDEO,
0e373b95 61 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
fb364ada 62 CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2 63 CODEC_ID_H261,
de6d9b64
FB
64 CODEC_ID_H263,
65 CODEC_ID_RV10,
68b94c35 66 CODEC_ID_RV20,
de6d9b64 67 CODEC_ID_MJPEG,
b135d9fb 68 CODEC_ID_MJPEGB,
b1e6b355 69 CODEC_ID_LJPEG,
5e83dec4 70 CODEC_ID_SP5X,
5639729b 71 CODEC_ID_JPEGLS,
bf89e6b1 72 CODEC_ID_MPEG4,
de6d9b64 73 CODEC_ID_RAWVIDEO,
84afee34
MN
74 CODEC_ID_MSMPEG4V1,
75 CODEC_ID_MSMPEG4V2,
76 CODEC_ID_MSMPEG4V3,
e1a9dbff 77 CODEC_ID_WMV1,
b50eef3a 78 CODEC_ID_WMV2,
de6d9b64
FB
79 CODEC_ID_H263P,
80 CODEC_ID_H263I,
d4f5d74a 81 CODEC_ID_FLV1,
be8ffec9 82 CODEC_ID_SVQ1,
8b82a956 83 CODEC_ID_SVQ3,
020fcc94 84 CODEC_ID_DVVIDEO,
11f18faf 85 CODEC_ID_HUFFYUV,
f70f7c6d 86 CODEC_ID_CYUV,
0da71265 87 CODEC_ID_H264,
deabd4fd 88 CODEC_ID_INDEO3,
d86053a4 89 CODEC_ID_VP3,
f44ee2c3 90 CODEC_ID_THEORA,
3d2e8cce 91 CODEC_ID_ASV1,
9b56edf5 92 CODEC_ID_ASV2,
5e20f836 93 CODEC_ID_FFV1,
e2a7bb28 94 CODEC_ID_4XM,
be3564ed 95 CODEC_ID_VCR1,
3aff069b 96 CODEC_ID_CLJR,
c3bf0288 97 CODEC_ID_MDEC,
3ef8be2b
MM
98 CODEC_ID_ROQ,
99 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
100 CODEC_ID_XAN_WC3,
101 CODEC_ID_XAN_WC4,
2fdf638b
MM
102 CODEC_ID_RPZA,
103 CODEC_ID_CINEPAK,
104 CODEC_ID_WS_VQA,
105 CODEC_ID_MSRLE,
106 CODEC_ID_MSVIDEO1,
4120a53a 107 CODEC_ID_IDCIN,
1dc1ed99 108 CODEC_ID_8BPS,
11e29a41 109 CODEC_ID_SMC,
42cad81a 110 CODEC_ID_FLIC,
9a4117d5 111 CODEC_ID_TRUEMOTION1,
fafa0b75 112 CODEC_ID_VMDVIDEO,
a273bbfb
RT
113 CODEC_ID_MSZH,
114 CODEC_ID_ZLIB,
070ed1bc 115 CODEC_ID_QTRLE,
791e7b83 116 CODEC_ID_SNOW,
9d53d58e 117 CODEC_ID_TSCC,
d0a0bbd2 118 CODEC_ID_ULTI,
d08d7142 119 CODEC_ID_QDRAW,
ab711b3c 120 CODEC_ID_VIXL,
acfd8f0f 121 CODEC_ID_QPEG,
17179d2d
MN
122 CODEC_ID_XVID,
123 CODEC_ID_PNG,
124 CODEC_ID_PPM,
125 CODEC_ID_PBM,
126 CODEC_ID_PGM,
127 CODEC_ID_PGMYUV,
128 CODEC_ID_PAM,
f37b9768 129 CODEC_ID_FFVHUFF,
3f05305d
MN
130 CODEC_ID_RV30,
131 CODEC_ID_RV40,
10b9c374 132 CODEC_ID_VC1,
21aa398f 133 CODEC_ID_WMV3,
9c7fb608 134 CODEC_ID_LOCO,
a8a15e9d 135 CODEC_ID_WNV1,
589f8220 136 CODEC_ID_AASC,
856dbbff 137 CODEC_ID_INDEO2,
b81f8949 138 CODEC_ID_FRAPS,
64af6168 139 CODEC_ID_TRUEMOTION2,
9fa62f2a 140 CODEC_ID_BMP,
e0f80bd7 141 CODEC_ID_CSCD,
4e114829 142 CODEC_ID_MMVIDEO,
9c8d8e84 143 CODEC_ID_ZMBV,
26376701 144 CODEC_ID_AVS,
348efc18 145 CODEC_ID_SMACKVIDEO,
dfca23e3 146 CODEC_ID_NUV,
fd7b1991 147 CODEC_ID_KMVC,
0919e788 148 CODEC_ID_FLASHSV,
20ffddb9 149 CODEC_ID_CAVS,
f31065f6 150 CODEC_ID_JPEG2000,
eb57c889 151 CODEC_ID_VMNC,
5ce117c3
AJ
152 CODEC_ID_VP5,
153 CODEC_ID_VP6,
154 CODEC_ID_VP6F,
3689cf16 155 CODEC_ID_TARGA,
72450e50 156 CODEC_ID_DSICINVIDEO,
29f86228 157 CODEC_ID_TIERTEXSEQVIDEO,
a991b1fe 158 CODEC_ID_TIFF,
06d392a7 159 CODEC_ID_GIF,
3edeab82 160 CODEC_ID_FFH264,
33a0dd37 161 CODEC_ID_DXA,
52b6bad2 162 CODEC_ID_DNXHD,
efb0c399 163 CODEC_ID_THP,
2d99eed1 164 CODEC_ID_SGI,
9a0ddd09 165 CODEC_ID_C93,
1e6c6759 166 CODEC_ID_BETHSOFTVID,
b46d68c6 167 CODEC_ID_PTX,
1ca779e7 168 CODEC_ID_TXD,
91fc2cf1 169 CODEC_ID_VP6A,
8787d837 170 CODEC_ID_AMV,
66f7679c 171 CODEC_ID_VB,
b4abe1d1 172 CODEC_ID_PCX,
d43df959 173 CODEC_ID_SUNRAST,
a96b68b7 174
f5bccd85 175 /* various PCM "codecs" */
17179d2d 176 CODEC_ID_PCM_S16LE= 0x10000,
a96b68b7
FB
177 CODEC_ID_PCM_S16BE,
178 CODEC_ID_PCM_U16LE,
179 CODEC_ID_PCM_U16BE,
180 CODEC_ID_PCM_S8,
181 CODEC_ID_PCM_U8,
182 CODEC_ID_PCM_MULAW,
183 CODEC_ID_PCM_ALAW,
b461b3bc
RD
184 CODEC_ID_PCM_S32LE,
185 CODEC_ID_PCM_S32BE,
186 CODEC_ID_PCM_U32LE,
187 CODEC_ID_PCM_U32BE,
188 CODEC_ID_PCM_S24LE,
189 CODEC_ID_PCM_S24BE,
190 CODEC_ID_PCM_U24LE,
191 CODEC_ID_PCM_U24BE,
192 CODEC_ID_PCM_S24DAUD,
a11c2a2c 193 CODEC_ID_PCM_ZORK,
725d86bf 194 CODEC_ID_PCM_S16LE_PLANAR,
0147f198 195
f5bccd85 196 /* various ADPCM codecs */
17179d2d 197 CODEC_ID_ADPCM_IMA_QT= 0x11000,
0147f198 198 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
199 CODEC_ID_ADPCM_IMA_DK3,
200 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 201 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 202 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 203 CODEC_ID_ADPCM_MS,
e2a7bb28 204 CODEC_ID_ADPCM_4XM,
fc384777
MM
205 CODEC_ID_ADPCM_XA,
206 CODEC_ID_ADPCM_ADX,
7d8379f2 207 CODEC_ID_ADPCM_EA,
e5966052 208 CODEC_ID_ADPCM_G726,
b3bfb299 209 CODEC_ID_ADPCM_CT,
659c3692 210 CODEC_ID_ADPCM_SWF,
2ff4524e 211 CODEC_ID_ADPCM_YAMAHA,
2433f24f
AJ
212 CODEC_ID_ADPCM_SBPRO_4,
213 CODEC_ID_ADPCM_SBPRO_3,
214 CODEC_ID_ADPCM_SBPRO_2,
d1e0d21f 215 CODEC_ID_ADPCM_THP,
3a7f5d07 216 CODEC_ID_ADPCM_IMA_AMV,
e7583962
PR
217 CODEC_ID_ADPCM_EA_R1,
218 CODEC_ID_ADPCM_EA_R3,
219 CODEC_ID_ADPCM_EA_R2,
7bb65d89 220 CODEC_ID_ADPCM_IMA_EA_SEAD,
fac84d3c 221 CODEC_ID_ADPCM_IMA_EA_EACS,
271b4095 222 CODEC_ID_ADPCM_EA_XAS,
891f64b3 223
17179d2d
MN
224 /* AMR */
225 CODEC_ID_AMR_NB= 0x12000,
d663a1fd
MN
226 CODEC_ID_AMR_WB,
227
b8414bbd 228 /* RealAudio codecs*/
17179d2d 229 CODEC_ID_RA_144= 0x13000,
b8414bbd 230 CODEC_ID_RA_288,
3ef8be2b
MM
231
232 /* various DPCM codecs */
17179d2d 233 CODEC_ID_ROQ_DPCM= 0x14000,
3ef8be2b 234 CODEC_ID_INTERPLAY_DPCM,
9937e686 235 CODEC_ID_XAN_DPCM,
d08d7142 236 CODEC_ID_SOL_DPCM,
115329f1 237
17179d2d 238 CODEC_ID_MP2= 0x15000,
0e373b95 239 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
17179d2d 240 CODEC_ID_AAC,
cbee7a69 241#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
17179d2d 242 CODEC_ID_MPEG4AAC,
cbee7a69 243#endif
17179d2d
MN
244 CODEC_ID_AC3,
245 CODEC_ID_DTS,
246 CODEC_ID_VORBIS,
247 CODEC_ID_DVAUDIO,
248 CODEC_ID_WMAV1,
249 CODEC_ID_WMAV2,
250 CODEC_ID_MACE3,
251 CODEC_ID_MACE6,
252 CODEC_ID_VMDAUDIO,
253 CODEC_ID_SONIC,
254 CODEC_ID_SONIC_LS,
ac2570a8 255 CODEC_ID_FLAC,
1ede228a 256 CODEC_ID_MP3ADU,
d2a7718d 257 CODEC_ID_MP3ON4,
85ad5695 258 CODEC_ID_SHORTEN,
5df8a0c6 259 CODEC_ID_ALAC,
034eeaa1 260 CODEC_ID_WESTWOOD_SND1,
0e373b95 261 CODEC_ID_GSM, ///< as in Berlin toast format
d9b1c197 262 CODEC_ID_QDM2,
e0f7e329 263 CODEC_ID_COOK,
bf3027c8 264 CODEC_ID_TRUESPEECH,
a24c4a2a 265 CODEC_ID_TTA,
348efc18 266 CODEC_ID_SMACKAUDIO,
6c496518 267 CODEC_ID_QCELP,
730581f3 268 CODEC_ID_WAVPACK,
72450e50 269 CODEC_ID_DSICINAUDIO,
84ed36da 270 CODEC_ID_IMC,
185c7b6b 271 CODEC_ID_MUSEPACK7,
aad512b4 272 CODEC_ID_MLP,
f5bccd85 273 CODEC_ID_GSM_MS, /* as found in WAV */
10e26bc7 274 CODEC_ID_ATRAC3,
8950f828 275 CODEC_ID_VOXWARE,
bf4a1f17 276 CODEC_ID_APE,
636b13c5 277 CODEC_ID_NELLYMOSER,
12877faf 278 CODEC_ID_MUSEPACK8,
cb4ddf77 279 CODEC_ID_SPEEX,
115329f1 280
240c1657 281 /* subtitle codecs */
115329f1
DB
282 CODEC_ID_DVD_SUBTITLE= 0x17000,
283 CODEC_ID_DVB_SUBTITLE,
0e373b95 284 CODEC_ID_TEXT, ///< raw UTF-8 text
7e2643ae 285 CODEC_ID_XSUB,
f9a9b350 286 CODEC_ID_SSA,
cc8c2c6a 287 CODEC_ID_MOV_TEXT,
115329f1 288
f8d7c9d3
ES
289 /* other specific kind of codecs (generaly used for attachments) */
290 CODEC_ID_TTF= 0x18000,
291
0e373b95 292 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85 293 * stream (only used by libavformat) */
de6d9b64 294};
dcedf586 295
abd6a4fc 296#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
f5bccd85 297/* CODEC_ID_MP3LAME is obsolete */
dcedf586 298#define CODEC_ID_MP3LAME CODEC_ID_MP3
abd6a4fc
BC
299#define CODEC_ID_MPEG4AAC CODEC_ID_AAC
300#endif
de6d9b64
FB
301
302enum CodecType {
4a663d80 303 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
304 CODEC_TYPE_VIDEO,
305 CODEC_TYPE_AUDIO,
985180a1 306 CODEC_TYPE_DATA,
240c1657 307 CODEC_TYPE_SUBTITLE,
f8d7c9d3 308 CODEC_TYPE_ATTACHMENT,
9ff77d17 309 CODEC_TYPE_NB
de6d9b64
FB
310};
311
0e373b95
MN
312/**
313 * Currently unused, may be used if 24/32 bits samples are ever supported.
314 * all in native-endian format
315 */
a96b68b7 316enum SampleFormat {
9076fee4 317 SAMPLE_FMT_NONE = -1,
1319a77b
AB
318 SAMPLE_FMT_U8, ///< unsigned 8 bits
319 SAMPLE_FMT_S16, ///< signed 16 bits
320 SAMPLE_FMT_S24, ///< signed 24 bits
115329f1 321 SAMPLE_FMT_S32, ///< signed 32 bits
a3a5f4d6 322 SAMPLE_FMT_FLT, ///< float
a96b68b7
FB
323};
324
de6d9b64 325/* in bytes */
8170e5fb 326#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
de6d9b64 327
d7425f59 328/**
cf713bb8 329 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
f5bccd85
DB
330 * This is mainly needed because some optimized bitstream readers read
331 * 32 or 64 bit at once and could read over the end.<br>
332 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
333 * MPEG bitstreams could cause overread and segfault.
d7425f59
MN
334 */
335#define FF_INPUT_BUFFER_PADDING_SIZE 8
336
0ecca7a4 337/**
f5bccd85
DB
338 * minimum encoding buffer size
339 * Used to avoid some checks during header writing.
0ecca7a4
MN
340 */
341#define FF_MIN_BUFFER_SIZE 16384
342
0e373b95 343/**
bafc102b 344 * motion estimation type.
0e373b95 345 */
e4986da9 346enum Motion_Est_ID {
9b4dd1b8 347 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
e4986da9
J
348 ME_FULL,
349 ME_LOG,
350 ME_PHODS,
9b4dd1b8
MN
351 ME_EPZS, ///< enhanced predictive zonal search
352 ME_X1, ///< reserved for experiments
353 ME_HEX, ///< hexagon based search
354 ME_UMH, ///< uneven multi-hexagon search
355 ME_ITER, ///< iterative search
e4986da9
J
356};
357
8c3eba7c 358enum AVDiscard{
f5bccd85
DB
359 /* We leave some space between them for extensions (drop some
360 * keyframes for intra-only or drop just some bidir frames). */
8c3eba7c
MN
361 AVDISCARD_NONE =-16, ///< discard nothing
362 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
363 AVDISCARD_NONREF = 8, ///< discard all non reference
364 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
365 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
366 AVDISCARD_ALL = 48, ///< discard all
367};
368
ce980a95
MN
369typedef struct RcOverride{
370 int start_frame;
371 int end_frame;
f5bccd85 372 int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
MN
373 float quality_factor;
374} RcOverride;
375
b0ec9efd 376#define FF_MAX_B_FRAMES 16
9dbcbd92 377
a949d72e 378/* encoding support
f5bccd85
DB
379 These flags can be passed in AVCodecContext.flags before initialization.
380 Note: Not everything is supported yet.
a949d72e 381*/
de6d9b64 382
f5bccd85
DB
383#define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
384#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
385#define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
386#define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
387#define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
388#define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
1ba8f5eb
MN
389/**
390 * The parent program guarantees that the input for B-frames containing
f5bccd85 391 * streams is not written to for at least s->max_b_frames+1 frames, if
1ba8f5eb
MN
392 * this is not set the input will be copied.
393 */
8b4c7dbc 394#define CODEC_FLAG_INPUT_PRESERVED 0x0100
273b0cd3
DB
395#define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
396#define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
397#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
398#define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
399#define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
400#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
401#define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
402 location instead of only at frame boundaries. */
f5bccd85
DB
403#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
404#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
405#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
406#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
407#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
408#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
409#define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
21e59552 410/* Fx : Flag for h263+ extra options */
6b936ec6 411#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
f5bccd85 412#define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
6b936ec6 413#endif
f5bccd85
DB
414#define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
415#define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
416#define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
417#define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
418#define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
332f9ac4
MN
419#define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
420#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19
MN
421#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
422#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
f5bccd85 423#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
f2cf4a6b 424#define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
f5bccd85
DB
425#define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
426#define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
427#define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
428#define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
429#define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
430#define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
d3075ed5 431#define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
58f7833e
RS
432#define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
433#define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
434#define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
f5bccd85
DB
435#define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
436#define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
437#define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
438#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
439#define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
440#define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
441#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
6fc5b059 442
21e59552 443/* Unsupported options :
bb270c08
DB
444 * Syntax Arithmetic coding (SAC)
445 * Reference Picture Selection
eafcac6a 446 * Independent Segment Decoding */
21e59552 447/* /Fx */
bf89e6b1
FB
448/* codec capabilities */
449
f5bccd85 450#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
6814a25c
MN
451/**
452 * Codec uses get_buffer() for allocating buffers.
453 * direct rendering method 1
454 */
455#define CODEC_CAP_DR1 0x0002
f5bccd85 456/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
917e06c8 457#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 458#define CODEC_CAP_TRUNCATED 0x0008
f5bccd85 459/* Codec can export data for HW decoding (XvMC). */
5e5c247a 460#define CODEC_CAP_HWACCEL 0x0010
115329f1 461/**
f5bccd85
DB
462 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
463 * If this is not set, the codec is guaranteed to never be fed with NULL data.
934982c4 464 */
6f824977 465#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
466/**
467 * Codec can be fed a final frame with a smaller size.
468 * This can be used to prevent truncation of the last audio samples.
469 */
470#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
bf89e6b1 471
f5bccd85 472//The following defines may change, don't expect compatibility if you use them.
8d7ec294 473#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
474#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
475#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
476#define MB_TYPE_16x16 0x0008
477#define MB_TYPE_16x8 0x0010
478#define MB_TYPE_8x16 0x0020
479#define MB_TYPE_8x8 0x0040
480#define MB_TYPE_INTERLACED 0x0080
273b0cd3 481#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
482#define MB_TYPE_ACPRED 0x0200
483#define MB_TYPE_GMC 0x0400
484#define MB_TYPE_SKIP 0x0800
485#define MB_TYPE_P0L0 0x1000
486#define MB_TYPE_P1L0 0x2000
487#define MB_TYPE_P0L1 0x4000
488#define MB_TYPE_P1L1 0x8000
489#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
490#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
491#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
492#define MB_TYPE_QUANT 0x00010000
493#define MB_TYPE_CBP 0x00020000
494//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
495
fa384dcc
MN
496/**
497 * Pan Scan area.
f5bccd85
DB
498 * This specifies the area which should be displayed.
499 * Note there may be multiple such areas for one frame.
fa384dcc
MN
500 */
501typedef struct AVPanScan{
502 /**
f5bccd85
DB
503 * id
504 * - encoding: Set by user.
505 * - decoding: Set by libavcodec.
fa384dcc
MN
506 */
507 int id;
508
509 /**
510 * width and height in 1/16 pel
f5bccd85
DB
511 * - encoding: Set by user.
512 * - decoding: Set by libavcodec.
fa384dcc
MN
513 */
514 int width;
515 int height;
516
517 /**
f5bccd85
DB
518 * position of the top left corner in 1/16 pel for up to 3 fields/frames
519 * - encoding: Set by user.
520 * - decoding: Set by libavcodec.
fa384dcc
MN
521 */
522 int16_t position[3][2];
523}AVPanScan;
524
492cd3a9 525#define FF_COMMON_FRAME \
b536d0aa
MN
526 /**\
527 * pointer to the picture planes.\
f5bccd85 528 * This might be different from the first allocated byte\
b536d0aa
MN
529 * - encoding: \
530 * - decoding: \
531 */\
1e491e29
MN
532 uint8_t *data[4];\
533 int linesize[4];\
534 /**\
f5bccd85
DB
535 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
536 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
MN
537 * - encoding: \
538 * - decoding: \
1e491e29
MN
539 */\
540 uint8_t *base[4];\
541 /**\
542 * 1 -> keyframe, 0-> not\
f5bccd85
DB
543 * - encoding: Set by libavcodec.\
544 * - decoding: Set by libavcodec.\
1e491e29
MN
545 */\
546 int key_frame;\
547\
548 /**\
f5bccd85
DB
549 * Picture type of the frame, see ?_TYPE below.\
550 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
551 * - decoding: Set by libavcodec.\
1e491e29
MN
552 */\
553 int pict_type;\
554\
555 /**\
c0df9d75 556 * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
DB
557 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
558 * - encoding: MUST be set by user.\
559 * - decoding: Set by libavcodec.\
1e491e29 560 */\
be6784dc 561 int64_t pts;\
1e491e29
MN
562\
563 /**\
f5bccd85 564 * picture number in bitstream order\
64863965 565 * - encoding: set by\
f5bccd85 566 * - decoding: Set by libavcodec.\
1e491e29
MN
567 */\
568 int coded_picture_number;\
569 /**\
f5bccd85 570 * picture number in display order\
64863965 571 * - encoding: set by\
f5bccd85 572 * - decoding: Set by libavcodec.\
1e491e29
MN
573 */\
574 int display_picture_number;\
575\
576 /**\
158c7f05 577 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
DB
578 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
579 * - decoding: Set by libavcodec.\
1e491e29 580 */\
158c7f05 581 int quality; \
1e491e29
MN
582\
583 /**\
584 * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85 585 * Set to INT_MAX if the buffer has not been used yet.\
64863965 586 * - encoding: unused\
f5bccd85 587 * - decoding: MUST be set by get_buffer().\
1e491e29
MN
588 */\
589 int age;\
590\
591 /**\
592 * is this picture used as reference\
64863965 593 * - encoding: unused\
f5bccd85 594 * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
MN
595 */\
596 int reference;\
597\
598 /**\
599 * QP table\
64863965 600 * - encoding: unused\
f5bccd85 601 * - decoding: Set by libavcodec.\
1e491e29
MN
602 */\
603 int8_t *qscale_table;\
604 /**\
605 * QP store stride\
64863965 606 * - encoding: unused\
f5bccd85 607 * - decoding: Set by libavcodec.\
1e491e29
MN
608 */\
609 int qstride;\
610\
611 /**\
f5bccd85 612 * mbskip_table[mb]>=1 if MB didn't change\
1e491e29 613 * stride= mb_width = (width+15)>>4\
64863965 614 * - encoding: unused\
f5bccd85 615 * - decoding: Set by libavcodec.\
1e491e29
MN
616 */\
617 uint8_t *mbskip_table;\
618\
619 /**\
f5bccd85 620 * motion vector table\
61436073
MN
621 * @code\
622 * example:\
623 * int mv_sample_log2= 4 - motion_subsample_log2;\
624 * int mb_width= (width+15)>>4;\
625 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
626 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
627 * @endcode\
f5bccd85
DB
628 * - encoding: Set by user.\
629 * - decoding: Set by libavcodec.\
8d7ec294
WH
630 */\
631 int16_t (*motion_val[2])[2];\
632\
633 /**\
f5bccd85 634 * macroblock type table\
8d7ec294 635 * mb_type_base + mb_width + 2\
f5bccd85
DB
636 * - encoding: Set by user.\
637 * - decoding: Set by libavcodec.\
8d7ec294
WH
638 */\
639 uint32_t *mb_type;\
640\
641 /**\
f0b77c69
MN
642 * log2 of the size of the block which a single vector in motion_val represents: \
643 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294 644 * - encoding: unused\
f5bccd85 645 * - decoding: Set by libavcodec.\
8d7ec294
WH
646 */\
647 uint8_t motion_subsample_log2;\
648\
649 /**\
1e491e29 650 * for some private data of the user\
64863965 651 * - encoding: unused\
f5bccd85 652 * - decoding: Set by user.\
1e491e29
MN
653 */\
654 void *opaque;\
140cb663
MN
655\
656 /**\
657 * error\
f5bccd85 658 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965 659 * - decoding: unused\
140cb663
MN
660 */\
661 uint64_t error[4];\
4e00e76b
MN
662\
663 /**\
f5bccd85
DB
664 * type of the buffer (to keep track of who has to deallocate data[*])\
665 * - encoding: Set by the one who allocates it.\
666 * - decoding: Set by the one who allocates it.\
667 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
MN
668 */\
669 int type;\
2ec23b6d
MN
670 \
671 /**\
f5bccd85 672 * When decoding, this signals how much the picture must be delayed.\
2ec23b6d 673 * extra_delay = repeat_pict / (2*fps)\
64863965 674 * - encoding: unused\
f5bccd85 675 * - decoding: Set by libavcodec.\
2ec23b6d 676 */\
0426af31
MN
677 int repeat_pict;\
678 \
679 /**\
680 * \
681 */\
682 int qscale_type;\
2744ca9a
RS
683 \
684 /**\
685 * The content of the picture is interlaced.\
f5bccd85
DB
686 * - encoding: Set by user.\
687 * - decoding: Set by libavcodec. (default 0)\
2744ca9a
RS
688 */\
689 int interlaced_frame;\
690 \
691 /**\
f5bccd85
DB
692 * If the content is interlaced, is top field displayed first.\
693 * - encoding: Set by user.\
694 * - decoding: Set by libavcodec.\
2744ca9a 695 */\
9dad924e 696 int top_field_first;\
fa384dcc
MN
697 \
698 /**\
699 * Pan scan.\
f5bccd85
DB
700 * - encoding: Set by user.\
701 * - decoding: Set by libavcodec.\
fa384dcc
MN
702 */\
703 AVPanScan *pan_scan;\
2a2bbcb0
MM
704 \
705 /**\
f5bccd85 706 * Tell user application that palette has changed from previous frame.\
2a2bbcb0 707 * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85 708 * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
MM
709 */\
710 int palette_has_changed;\
074c4ca7
RT
711 \
712 /**\
f5bccd85 713 * codec suggestion on buffer type if != 0\
074c4ca7 714 * - encoding: unused\
f5bccd85 715 * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
RT
716 */\
717 int buffer_hints;\
8289c6fa
WH
718\
719 /**\
f5bccd85 720 * DCT coefficients\
8289c6fa 721 * - encoding: unused\
f5bccd85 722 * - decoding: Set by libavcodec.\
8289c6fa
WH
723 */\
724 short *dct_coeff;\
a4d36c11
MN
725\
726 /**\
f5bccd85
DB
727 * motion referece frame index\
728 * - encoding: Set by user.\
729 * - decoding: Set by libavcodec.\
a4d36c11
MN
730 */\
731 int8_t *ref_index[2];
2ec23b6d 732
bb270c08
DB
733#define FF_QSCALE_TYPE_MPEG1 0
734#define FF_QSCALE_TYPE_MPEG2 1
735#define FF_QSCALE_TYPE_H264 2
4e00e76b
MN
736
737#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
738#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
739#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
740#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 741
1e491e29 742
273b0cd3
DB
743#define FF_I_TYPE 1 // Intra
744#define FF_P_TYPE 2 // Predicted
745#define FF_B_TYPE 3 // Bi-dir predicted
746#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
0da71265
MN
747#define FF_SI_TYPE 5
748#define FF_SP_TYPE 6
1e491e29 749
f5bccd85
DB
750#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
751#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
752#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
753#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 754
0da71265
MN
755/**
756 * Audio Video Frame.
ba66ae94
MN
757 * New fields can be added to the end of FF_COMMON_FRAME with minor version
758 * bumps.
8bfb108b 759 * Removal, reordering and changes to existing fields require a major
ba66ae94
MN
760 * version bump. No fields should be added into AVFrame before or after
761 * FF_COMMON_FRAME!
8bfb108b 762 * sizeof(AVFrame) must not be used outside libav*.
0da71265 763 */
492cd3a9
MN
764typedef struct AVFrame {
765 FF_COMMON_FRAME
766} AVFrame;
1e491e29 767
14bea432 768#define DEFAULT_FRAME_RATE_BASE 1001000
d33c949c
MN
769
770/**
252f17e2
MN
771 * main external API structure.
772 * New fields can be added to the end with minor version bumps.
8bfb108b 773 * Removal, reordering and changes to existing fields require a major
252f17e2 774 * version bump.
8bfb108b 775 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 776 */
de6d9b64 777typedef struct AVCodecContext {
b71901e6 778 /**
f5bccd85 779 * information on struct for av_log
bc874dae
MB
780 * - set by avcodec_alloc_context
781 */
43465395 782 AVClass *av_class;
bc874dae 783 /**
f5bccd85
DB
784 * the average bitrate
785 * - encoding: Set by user; unused for constant quantizer encoding.
786 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 787 */
de6d9b64 788 int bit_rate;
b71901e6
MN
789
790 /**
64863965 791 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 792 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 793 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 794 * - decoding: unused
b71901e6 795 */
115329f1 796 int bit_rate_tolerance;
b71901e6
MN
797
798 /**
64863965 799 * CODEC_FLAG_*.
f5bccd85
DB
800 * - encoding: Set by user.
801 * - decoding: Set by user.
b71901e6 802 */
de6d9b64 803 int flags;
b71901e6
MN
804
805 /**
f5bccd85
DB
806 * Some codecs need additional format info. It is stored here.
807 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
808 * specific codec MUST set it correctly otherwise stream copy breaks.
809 * In general use of this field by muxers is not recommanded.
810 * - encoding: Set by libavcodec.
811 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
MN
812 */
813 int sub_id;
814
815 /**
f5bccd85 816 * Motion estimation algorithm used for video coding.
58f7833e
RS
817 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
818 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
64863965
MN
819 * - encoding: MUST be set by user.
820 * - decoding: unused
b71901e6
MN
821 */
822 int me_method;
823
824 /**
f5bccd85
DB
825 * some codecs need / can use extradata like Huffman tables.
826 * mjpeg: Huffman tables
b71901e6 827 * rv10: additional flags
b704e742 828 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
829 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
830 * than extradata_size to avoid prolems if it is read with the bitstream reader.
831 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
832 * - encoding: Set/allocated/freed by libavcodec.
833 * - decoding: Set/allocated/freed by user.
b71901e6 834 */
58f2a4b0 835 uint8_t *extradata;
e84c31dc 836 int extradata_size;
115329f1 837
b71901e6 838 /**
f5bccd85
DB
839 * This is the fundamental unit of time (in seconds) in terms
840 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
841 * timebase should be 1/framerate and timestamp increments should be
842 * identically 1.
f5bccd85
DB
843 * - encoding: MUST be set by user.
844 * - decoding: Set by libavcodec.
b71901e6 845 */
c0df9d75 846 AVRational time_base;
115329f1 847
5b28c8c3 848 /* video only */
14bea432 849 /**
21adafec 850 * picture width / height.
115329f1 851 * - encoding: MUST be set by user.
f5bccd85
DB
852 * - decoding: Set by libavcodec.
853 * Note: For compatibility it is possible to set this instead of
854 * coded_width/height before decoding.
b71901e6 855 */
de6d9b64 856 int width, height;
115329f1 857
e769f053 858#define FF_ASPECT_EXTENDED 15
b71901e6
MN
859
860 /**
f5bccd85
DB
861 * the number of pictures in a group of pictures, or 0 for intra_only
862 * - encoding: Set by user.
64863965 863 * - decoding: unused
b71901e6
MN
864 */
865 int gop_size;
866
867 /**
f5bccd85
DB
868 * Pixel format, see PIX_FMT_xxx.
869 * - encoding: Set by user.
870 * - decoding: Set by libavcodec.
b71901e6 871 */
e4eadb4b 872 enum PixelFormat pix_fmt;
115329f1 873
bdfcbbed 874 /**
f5bccd85 875 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed 876 * has to read frames at native frame rate.
f5bccd85
DB
877 * - encoding: Set by user.
878 * - decoding: unused
bdfcbbed
MK
879 */
880 int rate_emu;
115329f1 881
b71901e6 882 /**
f5bccd85
DB
883 * If non NULL, 'draw_horiz_band' is called by the libavcodec
884 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 885 * all codecs can do that. You must check the codec capabilities
f5bccd85 886 * beforehand.
64863965 887 * - encoding: unused
f5bccd85 888 * - decoding: Set by user.
3bb07d61
MN
889 * @param height the height of the slice
890 * @param y the y position of the slice
891 * @param type 1->top field, 2->bottom field, 3->frame
892 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 893 */
bf89e6b1 894 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 895 const AVFrame *src, int offset[4],
3bb07d61 896 int y, int type, int height);
bf89e6b1 897
de6d9b64 898 /* audio only */
f5bccd85 899 int sample_rate; ///< samples per second
de6d9b64 900 int channels;
a3a5f4d6
MN
901
902 /**
f5bccd85
DB
903 * audio sample format
904 * - encoding: Set by user.
905 * - decoding: Set by libavcodec.
a3a5f4d6 906 */
f5bccd85 907 enum SampleFormat sample_fmt; ///< sample format, currently unused
de6d9b64 908
f5bccd85 909 /* The following data should not be initialized. */
718b27a7 910 /**
f5bccd85 911 * Samples per packet, initialized when calling 'init'.
718b27a7
MN
912 */
913 int frame_size;
115329f1 914 int frame_number; ///< audio or video frame number
f5bccd85 915 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
115329f1 916
b71901e6 917 /**
f5bccd85 918 * Number of frames the decoded output will be delayed relative to
64863965 919 * the encoded input.
f5bccd85 920 * - encoding: Set by libavcodec.
64863965 921 * - decoding: unused
b71901e6
MN
922 */
923 int delay;
115329f1 924
64863965
MN
925 /* - encoding parameters */
926 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
927 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
928
b71901e6 929 /**
f5bccd85
DB
930 * minimum quantizer
931 * - encoding: Set by user.
64863965 932 * - decoding: unused
b71901e6
MN
933 */
934 int qmin;
935
936 /**
f5bccd85
DB
937 * maximum quantizer
938 * - encoding: Set by user.
64863965 939 * - decoding: unused
b71901e6
MN
940 */
941 int qmax;
942
943 /**
f5bccd85
DB
944 * maximum quantizer difference between frames
945 * - encoding: Set by user.
64863965 946 * - decoding: unused
b71901e6
MN
947 */
948 int max_qdiff;
949
950 /**
f5bccd85
DB
951 * maximum number of B-frames between non-B-frames
952 * Note: The output will be delayed by max_b_frames+1 relative to the input.
953 * - encoding: Set by user.
64863965 954 * - decoding: unused
b71901e6
MN
955 */
956 int max_b_frames;
957
958 /**
f5bccd85
DB
959 * qscale factor between IP and B-frames
960 * - encoding: Set by user.
64863965 961 * - decoding: unused
b71901e6
MN
962 */
963 float b_quant_factor;
115329f1 964
b71901e6
MN
965 /** obsolete FIXME remove */
966 int rc_strategy;
64b7c5b6
MN
967#define FF_RC_STRATEGY_XVID 1
968
8b4c7dbc 969 int b_frame_strategy;
9dbcbd92 970
b71901e6 971 /**
f5bccd85 972 * hurry up amount
64863965 973 * - encoding: unused
f5bccd85 974 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1 975 * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6
MN
976 */
977 int hurry_up;
115329f1 978
de6d9b64 979 struct AVCodec *codec;
115329f1 980
de6d9b64
FB
981 void *priv_data;
982
ccec0f4f 983#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
ba58dabc
MN
984 /* unused, FIXME remove*/
985 int rtp_mode;
ccec0f4f 986#endif
115329f1 987
bb628dae 988 int rtp_payload_size; /* The size of the RTP payload: the coder will */
f5bccd85 989 /* do its best to deliver a chunk with size */
644d98a4 990 /* below rtp_payload_size, the chunk will start */
f5bccd85 991 /* with a start code on some codecs like H.263. */
644d98a4 992 /* This doesn't take account of any particular */
f5bccd85 993 /* headers inside the transmitted RTP payload. */
81401c1f 994
115329f1 995
f5bccd85
DB
996 /* The RTP callback: This function is called */
997 /* every time the encoder has a packet to send. */
998 /* It depends on the encoder if the data starts */
999 /* with a Start Code (it should). H.263 does. */
1000 /* mb_nb contains the number of macroblocks */
1001 /* encoded in the RTP payload. */
115329f1 1002 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 1003
098eefe1
MN
1004 /* statistics, used for 2-pass encoding */
1005 int mv_bits;
1006 int header_bits;
1007 int i_tex_bits;
1008 int p_tex_bits;
1009 int i_count;
1010 int p_count;
1011 int skip_count;
b71901e6 1012 int misc_bits;
115329f1 1013
b71901e6 1014 /**
f5bccd85
DB
1015 * number of bits used for the previously encoded frame
1016 * - encoding: Set by libavcodec.
7004ffb3 1017 * - decoding: unused
b71901e6 1018 */
098eefe1 1019 int frame_bits;
7004ffb3 1020
b71901e6 1021 /**
f5bccd85
DB
1022 * Private data of the user, can be used to carry app specific stuff.
1023 * - encoding: Set by user.
1024 * - decoding: Set by user.
b71901e6
MN
1025 */
1026 void *opaque;
1027
de6d9b64 1028 char codec_name[32];
4a663d80
PG
1029 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1030 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 1031
7004ffb3
MN
1032 /**
1033 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
DB
1034 * This is used to work around some encoder bugs.
1035 * A demuxer should set this to what is stored in the field used to identify the codec.
1036 * If there are multiple such fields in a container then the demuxer should choose the one
1037 * which maximizes the information about the used codec.
1038 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1039 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7 1040 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
DB
1041 * first.
1042 * - encoding: Set by user, if not then the default based on codec_id will be used.
1043 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
MN
1044 */
1045 unsigned int codec_tag;
115329f1 1046
b71901e6 1047 /**
f5bccd85
DB
1048 * Work around bugs in encoders which sometimes cannot be detected automatically.
1049 * - encoding: Set by user
1050 * - decoding: Set by user
b71901e6
MN
1051 */
1052 int workaround_bugs;
64863965 1053#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
1054#define FF_BUG_OLD_MSMPEG4 2
1055#define FF_BUG_XVID_ILACE 4
1056#define FF_BUG_UMP4 8
1057#define FF_BUG_NO_PADDING 16
3116cb14 1058#define FF_BUG_AMV 32
f5bccd85 1059#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35 1060#define FF_BUG_QPEL_CHROMA 64
db794953 1061#define FF_BUG_STD_QPEL 128
36df8805 1062#define FF_BUG_QPEL_CHROMA2 256
c40c3482 1063#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 1064#define FF_BUG_EDGE 1024
b44bdf7e 1065#define FF_BUG_HPEL_CHROMA 2048
4ccde216 1066#define FF_BUG_DC_CLIP 4096
f5bccd85
DB
1067#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1068//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1 1069
b71901e6 1070 /**
f5bccd85
DB
1071 * luma single coefficient elimination threshold
1072 * - encoding: Set by user.
64863965 1073 * - decoding: unused
b71901e6 1074 */
1f6b6e50 1075 int luma_elim_threshold;
115329f1 1076
b71901e6 1077 /**
f5bccd85
DB
1078 * chroma single coeff elimination threshold
1079 * - encoding: Set by user.
64863965 1080 * - decoding: unused
b71901e6 1081 */
1f6b6e50 1082 int chroma_elim_threshold;
115329f1 1083
b71901e6 1084 /**
f5bccd85
DB
1085 * strictly follow the standard (MPEG4, ...).
1086 * - encoding: Set by user.
64863965 1087 * - decoding: unused
b71901e6
MN
1088 */
1089 int strict_std_compliance;
f5bccd85
DB
1090#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1091#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798 1092#define FF_COMPLIANCE_NORMAL 0
f5bccd85
DB
1093#define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1094#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798 1095
b71901e6 1096 /**
f5bccd85
DB
1097 * qscale offset between IP and B-frames
1098 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1099 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1100 * - encoding: Set by user.
64863965 1101 * - decoding: unused
b71901e6
MN
1102 */
1103 float b_quant_offset;
115329f1 1104
b71901e6 1105 /**
f5bccd85
DB
1106 * Error resilience; higher values will detect more errors but may
1107 * misdetect some more or less valid parts as errors.
64863965 1108 * - encoding: unused
f5bccd85 1109 * - decoding: Set by user.
b71901e6 1110 */
1f6b6e50 1111 int error_resilience;
1471c6c2 1112#define FF_ER_CAREFUL 1
ce3bcaed
MN
1113#define FF_ER_COMPLIANT 2
1114#define FF_ER_AGGRESSIVE 3
1115#define FF_ER_VERY_AGGRESSIVE 4
115329f1 1116
6b72ac63 1117 /**
f5bccd85
DB
1118 * Called at the beginning of each frame to get a buffer for it.
1119 * If pic.reference is set then the frame will be read later by libavcodec.
2b5296d2 1120 * avcodec_align_dimensions() should be used to find the required width and
f5bccd85 1121 * height, as they normally need to be rounded up to the next multiple of 16.
64863965 1122 * - encoding: unused
f5bccd85 1123 * - decoding: Set by libavcodec., user can override.
b71901e6 1124 */
492cd3a9 1125 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1126
b71901e6 1127 /**
f5bccd85
DB
1128 * Called to release buffers which where allocated with get_buffer.
1129 * A released buffer can be reused in get_buffer().
1130 * pic.data[*] must be set to NULL.
64863965 1131 * - encoding: unused
f5bccd85 1132 * - decoding: Set by libavcodec., user can override.
b71901e6 1133 */
492cd3a9 1134 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1135
b71901e6 1136 /**
f5bccd85
DB
1137 * If 1 the stream has a 1 frame delay during decoding.
1138 * - encoding: Set by libavcodec.
1139 * - decoding: Set by libavcodec.
b71901e6
MN
1140 */
1141 int has_b_frames;
718b27a7
MN
1142
1143 /**
1144 * number of bytes per packet if constant and known or 0
f5bccd85 1145 * Used by some WAV based audio codecs.
718b27a7
MN
1146 */
1147 int block_align;
115329f1 1148
f5bccd85 1149 int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
FB
1150 (function avcodec_parse_frame()). The frame
1151 data is returned. Only MPEG codecs support this now. */
115329f1 1152
b71901e6 1153 /**
f5bccd85
DB
1154 * 0-> h263 quant 1-> mpeg quant
1155 * - encoding: Set by user.
64863965 1156 * - decoding: unused
b71901e6
MN
1157 */
1158 int mpeg_quant;
115329f1 1159
b71901e6 1160 /**
f5bccd85
DB
1161 * pass1 encoding statistics output buffer
1162 * - encoding: Set by libavcodec.
64863965 1163 * - decoding: unused
b71901e6 1164 */
64863965 1165 char *stats_out;
115329f1 1166
b71901e6 1167 /**
f5bccd85
DB
1168 * pass2 encoding statistics input buffer
1169 * Concatenated stuff from stats_out of pass1 should be placed here.
1170 * - encoding: Allocated/set/freed by user.
64863965 1171 * - decoding: unused
b71901e6
MN
1172 */
1173 char *stats_in;
115329f1 1174
b71901e6 1175 /**
f5bccd85
DB
1176 * ratecontrol qmin qmax limiting method
1177 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1178 * - encoding: Set by user.
64863965 1179 * - decoding: unused
b71901e6 1180 */
ce980a95 1181 float rc_qsquish;
b71901e6 1182
ce980a95
MN
1183 float rc_qmod_amp;
1184 int rc_qmod_freq;
115329f1 1185
b71901e6 1186 /**
f5bccd85
DB
1187 * ratecontrol override, see RcOverride
1188 * - encoding: Allocated/set/freed by user.
64863965 1189 * - decoding: unused
b71901e6 1190 */
ce980a95
MN
1191 RcOverride *rc_override;
1192 int rc_override_count;
115329f1 1193
b71901e6 1194 /**
f5bccd85
DB
1195 * rate control equation
1196 * - encoding: Set by user
64863965 1197 * - decoding: unused
b71901e6 1198 */
ce980a95 1199 char *rc_eq;
115329f1 1200
b71901e6 1201 /**
f5bccd85
DB
1202 * maximum bitrate
1203 * - encoding: Set by user.
64863965 1204 * - decoding: unused
b71901e6 1205 */
ce980a95 1206 int rc_max_rate;
115329f1 1207
b71901e6 1208 /**
f5bccd85
DB
1209 * minimum bitrate
1210 * - encoding: Set by user.
64863965 1211 * - decoding: unused
b71901e6 1212 */
ce980a95 1213 int rc_min_rate;
115329f1 1214
b71901e6 1215 /**
f5bccd85
DB
1216 * decoder bitstream buffer size
1217 * - encoding: Set by user.
64863965 1218 * - decoding: unused
b71901e6 1219 */
ce980a95
MN
1220 int rc_buffer_size;
1221 float rc_buffer_aggressivity;
b71901e6
MN
1222
1223 /**
f5bccd85
DB
1224 * qscale factor between P and I-frames
1225 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1226 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1227 * - encoding: Set by user.
64863965 1228 * - decoding: unused
b71901e6
MN
1229 */
1230 float i_quant_factor;
115329f1 1231
b71901e6 1232 /**
f5bccd85
DB
1233 * qscale offset between P and I-frames
1234 * - encoding: Set by user.
64863965 1235 * - decoding: unused
b71901e6
MN
1236 */
1237 float i_quant_offset;
115329f1 1238
b71901e6 1239 /**
f5bccd85
DB
1240 * initial complexity for pass1 ratecontrol
1241 * - encoding: Set by user.
64863965 1242 * - decoding: unused
b71901e6 1243 */
ce980a95 1244 float rc_initial_cplx;
917e06c8 1245
b71901e6 1246 /**
f5bccd85
DB
1247 * DCT algorithm, see FF_DCT_* below
1248 * - encoding: Set by user.
64863965 1249 * - decoding: unused
b71901e6 1250 */
28db7fce 1251 int dct_algo;
c7e07931 1252#define FF_DCT_AUTO 0
28db7fce 1253#define FF_DCT_FASTINT 1
c7e07931
MO
1254#define FF_DCT_INT 2
1255#define FF_DCT_MMX 3
1256#define FF_DCT_MLIB 4
05c4072b 1257#define FF_DCT_ALTIVEC 5
65e4c8c9 1258#define FF_DCT_FAAN 6
115329f1 1259
c5d309f2 1260 /**
f5bccd85
DB
1261 * luminance masking (0-> disabled)
1262 * - encoding: Set by user.
64863965 1263 * - decoding: unused
c5d309f2
MN
1264 */
1265 float lumi_masking;
115329f1 1266
c5d309f2 1267 /**
f5bccd85
DB
1268 * temporary complexity masking (0-> disabled)
1269 * - encoding: Set by user.
64863965 1270 * - decoding: unused
c5d309f2
MN
1271 */
1272 float temporal_cplx_masking;
115329f1 1273
c5d309f2 1274 /**
f5bccd85
DB
1275 * spatial complexity masking (0-> disabled)
1276 * - encoding: Set by user.
64863965 1277 * - decoding: unused
c5d309f2
MN
1278 */
1279 float spatial_cplx_masking;
115329f1 1280
c5d309f2 1281 /**
f5bccd85
DB
1282 * p block masking (0-> disabled)
1283 * - encoding: Set by user.
64863965 1284 * - decoding: unused
c5d309f2
MN
1285 */
1286 float p_masking;
15415af4 1287
5e746b99 1288 /**
f5bccd85
DB
1289 * darkness masking (0-> disabled)
1290 * - encoding: Set by user.
64863965 1291 * - decoding: unused
5e746b99
MN
1292 */
1293 float dark_masking;
115329f1
DB
1294
1295
3e0b7b56 1296#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
3a694b04
NK
1297 /* for binary compatibility */
1298 int unused;
3e0b7b56 1299#endif
115329f1 1300
0c2dd16e 1301 /**
f5bccd85
DB
1302 * IDCT algorithm, see FF_IDCT_* below.
1303 * - encoding: Set by user.
1304 * - decoding: Set by user.
2ad1516a
MN
1305 */
1306 int idct_algo;
273b0cd3
DB
1307#define FF_IDCT_AUTO 0
1308#define FF_IDCT_INT 1
1309#define FF_IDCT_SIMPLE 2
1310#define FF_IDCT_SIMPLEMMX 3
1311#define FF_IDCT_LIBMPEG2MMX 4
1312#define FF_IDCT_PS2 5
1313#define FF_IDCT_MLIB 6
1314#define FF_IDCT_ARM 7
1315#define FF_IDCT_ALTIVEC 8
1316#define FF_IDCT_SH4 9
1317#define FF_IDCT_SIMPLEARM 10
1318#define FF_IDCT_H264 11
1319#define FF_IDCT_VP3 12
1320#define FF_IDCT_IPP 13
1321#define FF_IDCT_XVIDMMX 14
1322#define FF_IDCT_CAVS 15
a0403006 1323#define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3 1324#define FF_IDCT_SIMPLEARMV6 17
d9420d4d 1325#define FF_IDCT_SIMPLEVIS 18
9abc7e0f 1326#define FF_IDCT_WMV2 19
2ad1516a 1327
144f0625 1328 /**
f5bccd85
DB
1329 * slice count
1330 * - encoding: Set by libavcodec.
1331 * - decoding: Set by user (or 0).
144f0625
MN
1332 */
1333 int slice_count;
1334 /**
f5bccd85
DB
1335 * slice offsets in the frame in bytes
1336 * - encoding: Set/allocated by libavcodec.
1337 * - decoding: Set/allocated by user (or NULL).
144f0625
MN
1338 */
1339 int *slice_offset;
1340
4d2858de 1341 /**
f5bccd85 1342 * error concealment flags
64863965 1343 * - encoding: unused
f5bccd85 1344 * - decoding: Set by user.
4d2858de
MN
1345 */
1346 int error_concealment;
1347#define FF_EC_GUESS_MVS 1
1348#define FF_EC_DEBLOCK 2
1349
6b72ac63 1350 /**
bec89a84 1351 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1352 * CPU features (i.e. MMX, SSE. ...)
bec89a84 1353 *
f5bccd85
DB
1354 * With the FORCE flag you may instead enable given CPU features.
1355 * (Dangerous: Usable in case of misdetection, improper usage however will
1356 * result into program crash.)
bec89a84
ZK
1357 */
1358 unsigned dsp_mask;
f5bccd85 1359#define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
bec89a84 1360 /* lower 16 bits - CPU features */
0cd60abf
MN
1361#define FF_MM_MMX 0x0001 ///< standard MMX
1362#define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1363#define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1364#define FF_MM_SSE 0x0008 ///< SSE functions
1365#define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1366#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1367#define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1368#define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1369#define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
11f18faf
MN
1370
1371 /**
64863965 1372 * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
DB
1373 * - encoding: Set by libavcodec.
1374 * - decoding: Set by user.
11f18faf
MN
1375 */
1376 int bits_per_sample;
115329f1 1377
11f18faf 1378 /**
f5bccd85
DB
1379 * prediction method (needed for huffyuv)
1380 * - encoding: Set by user.
64863965 1381 * - decoding: unused
11f18faf
MN
1382 */
1383 int prediction_method;
1384#define FF_PRED_LEFT 0
1385#define FF_PRED_PLANE 1
1386#define FF_PRED_MEDIAN 2
115329f1 1387
5d3cea3a 1388 /**
f5bccd85
DB
1389 * sample aspect ratio (0 if unknown)
1390 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1391 * - encoding: Set by user.
1392 * - decoding: Set by libavcodec.
5d3cea3a 1393 */
5ff85f1d 1394 AVRational sample_aspect_ratio;
1e491e29
MN
1395
1396 /**
f5bccd85
DB
1397 * the picture in the bitstream
1398 * - encoding: Set by libavcodec.
1399 * - decoding: Set by libavcodec.
1e491e29 1400 */
492cd3a9 1401 AVFrame *coded_frame;
c8c437bc
MN
1402
1403 /**
f5bccd85
DB
1404 * debug
1405 * - encoding: Set by user.
1406 * - decoding: Set by user.
c8c437bc
MN
1407 */
1408 int debug;
273b0cd3
DB
1409#define FF_DEBUG_PICT_INFO 1
1410#define FF_DEBUG_RC 2
1411#define FF_DEBUG_BITSTREAM 4
1412#define FF_DEBUG_MB_TYPE 8
1413#define FF_DEBUG_QP 16
1414#define FF_DEBUG_MV 32
1415#define FF_DEBUG_DCT_COEFF 0x00000040
1416#define FF_DEBUG_SKIP 0x00000080
1417#define FF_DEBUG_STARTCODE 0x00000100
1418#define FF_DEBUG_PTS 0x00000200
1419#define FF_DEBUG_ER 0x00000400
1420#define FF_DEBUG_MMCO 0x00000800
1421#define FF_DEBUG_BUGS 0x00001000
1422#define FF_DEBUG_VIS_QP 0x00002000
864119b6 1423#define FF_DEBUG_VIS_MB_TYPE 0x00004000
115329f1 1424
140cb663 1425 /**
f5bccd85
DB
1426 * debug
1427 * - encoding: Set by user.
1428 * - decoding: Set by user.
0c9bbaec
WH
1429 */
1430 int debug_mv;
1431#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1432#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1433#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1434
1435 /**
f5bccd85
DB
1436 * error
1437 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965 1438 * - decoding: unused
140cb663
MN
1439 */
1440 uint64_t error[4];
115329f1 1441
17a70fde 1442 /**
f5bccd85 1443 * minimum MB quantizer
6e0d8c06 1444 * - encoding: unused
64863965 1445 * - decoding: unused
17a70fde
MN
1446 */
1447 int mb_qmin;
1448
1449 /**
f5bccd85 1450 * maximum MB quantizer
6e0d8c06 1451 * - encoding: unused
64863965 1452 * - decoding: unused
17a70fde
MN
1453 */
1454 int mb_qmax;
115329f1 1455
1457ab52 1456 /**
f5bccd85
DB
1457 * motion estimation comparison function
1458 * - encoding: Set by user.
64863965 1459 * - decoding: unused
1457ab52
MN
1460 */
1461 int me_cmp;
1462 /**
f5bccd85
DB
1463 * subpixel motion estimation comparison function
1464 * - encoding: Set by user.
64863965 1465 * - decoding: unused
1457ab52
MN
1466 */
1467 int me_sub_cmp;
1468 /**
f5bccd85
DB
1469 * macroblock comparison function (not supported yet)
1470 * - encoding: Set by user.
64863965 1471 * - decoding: unused
1457ab52
MN
1472 */
1473 int mb_cmp;
622348f9 1474 /**
f5bccd85
DB
1475 * interlaced DCT comparison function
1476 * - encoding: Set by user.
622348f9
MN
1477 * - decoding: unused
1478 */
1479 int ildct_cmp;
273b0cd3
DB
1480#define FF_CMP_SAD 0
1481#define FF_CMP_SSE 1
1482#define FF_CMP_SATD 2
1483#define FF_CMP_DCT 3
1484#define FF_CMP_PSNR 4
1485#define FF_CMP_BIT 5
1486#define FF_CMP_RD 6
1487#define FF_CMP_ZERO 7
1488#define FF_CMP_VSAD 8
1489#define FF_CMP_VSSE 9
1490#define FF_CMP_NSSE 10
1491#define FF_CMP_W53 11
1492#define FF_CMP_W97 12
0fd6aea1 1493#define FF_CMP_DCTMAX 13
27c61ac5 1494#define FF_CMP_DCT264 14
1457ab52 1495#define FF_CMP_CHROMA 256
115329f1 1496
1457ab52 1497 /**
f5bccd85
DB
1498 * ME diamond size & shape
1499 * - encoding: Set by user.
64863965 1500 * - decoding: unused
1457ab52
MN
1501 */
1502 int dia_size;
b07a5980
MN
1503
1504 /**
f5bccd85
DB
1505 * amount of previous MV predictors (2a+1 x 2a+1 square)
1506 * - encoding: Set by user.
64863965 1507 * - decoding: unused
b07a5980
MN
1508 */
1509 int last_predictor_count;
70ac76c0 1510
f5fb6b34 1511 /**
f5bccd85
DB
1512 * prepass for motion estimation
1513 * - encoding: Set by user.
64863965 1514 * - decoding: unused
f5fb6b34
MN
1515 */
1516 int pre_me;
b07a5980 1517
70ac76c0 1518 /**
f5bccd85
DB
1519 * motion estimation prepass comparison function
1520 * - encoding: Set by user.
64863965 1521 * - decoding: unused
70ac76c0
MN
1522 */
1523 int me_pre_cmp;
826f429a 1524
70ac76c0 1525 /**
f5bccd85
DB
1526 * ME prepass diamond size & shape
1527 * - encoding: Set by user.
64863965 1528 * - decoding: unused
70ac76c0
MN
1529 */
1530 int pre_dia_size;
1531
826f429a 1532 /**
f5bccd85
DB
1533 * subpel ME quality
1534 * - encoding: Set by user.
64863965 1535 * - decoding: unused
826f429a
MN
1536 */
1537 int me_subpel_quality;
1538
a33c7159 1539 /**
f5bccd85 1540 * callback to negotiate the pixelFormat
a33c7159 1541 * @param fmt is the list of formats which are supported by the codec,
f5bccd85
DB
1542 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1543 * The first is always the native one.
1544 * @return the chosen format
64863965 1545 * - encoding: unused
f5bccd85 1546 * - decoding: Set by user, if not set the native format will be chosen.
a33c7159 1547 */
494c56d3 1548 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1549
1550 /**
f5bccd85
DB
1551 * DTG active format information (additional aspect ratio
1552 * information only used in DVB MPEG-2 transport streams)
1553 * 0 if not set.
115329f1 1554 *
f5bccd85
DB
1555 * - encoding: unused
1556 * - decoding: Set by decoder.
e2f9490e
FB
1557 */
1558 int dtg_active_format;
1559#define FF_DTG_AFD_SAME 8
1560#define FF_DTG_AFD_4_3 9
1561#define FF_DTG_AFD_16_9 10
1562#define FF_DTG_AFD_14_9 11
1563#define FF_DTG_AFD_4_3_SP_14_9 13
1564#define FF_DTG_AFD_16_9_SP_14_9 14
1565#define FF_DTG_AFD_SP_4_3 15
1566
ebbcdc9a 1567 /**
f5bccd85
DB
1568 * maximum motion estimation search range in subpel units
1569 * If 0 then no limit.
115329f1 1570 *
f5bccd85
DB
1571 * - encoding: Set by user.
1572 * - decoding: unused
ebbcdc9a 1573 */
59e0ac8e 1574 int me_range;
ebbcdc9a 1575
65f7062d 1576 /**
f5bccd85
DB
1577 * intra quantizer bias
1578 * - encoding: Set by user.
1984f635
MN
1579 * - decoding: unused
1580 */
1581 int intra_quant_bias;
1582#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1583
1984f635 1584 /**
f5bccd85
DB
1585 * inter quantizer bias
1586 * - encoding: Set by user.
1984f635
MN
1587 * - decoding: unused
1588 */
1589 int inter_quant_bias;
5cd62665
ZK
1590
1591 /**
f5bccd85
DB
1592 * color table ID
1593 * - encoding: unused
1594 * - decoding: Which clrtable should be used for 8bit RGB images.
1595 * Tables have to be stored somewhere. FIXME
5cd62665
ZK
1596 */
1597 int color_table_id;
115329f1 1598
d90cf87b 1599 /**
f5bccd85
DB
1600 * internal_buffer count
1601 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1602 */
1603 int internal_buffer_count;
115329f1 1604
d90cf87b 1605 /**
f5bccd85
DB
1606 * internal_buffers
1607 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1608 */
1609 void *internal_buffer;
158c7f05
MN
1610
1611#define FF_LAMBDA_SHIFT 7
1612#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1613#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1614#define FF_LAMBDA_MAX (256*128-1)
1615
1616#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce 1617 /**
f5bccd85
DB
1618 * Global quality for codecs which cannot change it per frame.
1619 * This should be proportional to MPEG-1/2/4 qscale.
1620 * - encoding: Set by user.
3d2e8cce
MN
1621 * - decoding: unused
1622 */
1623 int global_quality;
115329f1 1624
bd446bb1
MN
1625#define FF_CODER_TYPE_VLC 0
1626#define FF_CODER_TYPE_AC 1
f87459e4
KN
1627#define FF_CODER_TYPE_RAW 2
1628#define FF_CODER_TYPE_RLE 3
1629#define FF_CODER_TYPE_DEFLATE 4
11e659c2
MN
1630 /**
1631 * coder type
f5bccd85 1632 * - encoding: Set by user.
11e659c2
MN
1633 * - decoding: unused
1634 */
1635 int coder_type;
1636
1637 /**
1638 * context model
f5bccd85 1639 * - encoding: Set by user.
11e659c2
MN
1640 * - decoding: unused
1641 */
1642 int context_model;
5639729b
MN
1643#if 0
1644 /**
1645 *
1646 * - encoding: unused
f5bccd85 1647 * - decoding: Set by user.
5639729b
MN
1648 */
1649 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1650#endif
115329f1 1651
3bb07d61
MN
1652 /**
1653 * slice flags
1654 * - encoding: unused
f5bccd85 1655 * - decoding: Set by user.
3bb07d61
MN
1656 */
1657 int slice_flags;
1658#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1659#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1660#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1661
fb364ada
IK
1662 /**
1663 * XVideo Motion Acceleration
1664 * - encoding: forbidden
1665 * - decoding: set by decoder
1666 */
1667 int xvmc_acceleration;
115329f1 1668
7d1c3fc1
MN
1669 /**
1670 * macroblock decision mode
f5bccd85 1671 * - encoding: Set by user.
7d1c3fc1
MN
1672 * - decoding: unused
1673 */
1674 int mb_decision;
1675#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1676#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1677#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1678
1679 /**
1680 * custom intra quantization matrix
f5bccd85
DB
1681 * - encoding: Set by user, can be NULL.
1682 * - decoding: Set by libavcodec.
d6eb3c50
MN
1683 */
1684 uint16_t *intra_matrix;
1685
1686 /**
1687 * custom inter quantization matrix
f5bccd85
DB
1688 * - encoding: Set by user, can be NULL.
1689 * - decoding: Set by libavcodec.
d6eb3c50
MN
1690 */
1691 uint16_t *inter_matrix;
115329f1 1692
541ae140
MN
1693 /**
1694 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85 1695 * This is used to work around some encoder bugs.
541ae140 1696 * - encoding: unused
f5bccd85 1697 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
MN
1698 */
1699 unsigned int stream_codec_tag;
05fbd0a2
MN
1700
1701 /**
f5bccd85
DB
1702 * scene change detection threshold
1703 * 0 is default, larger means fewer detected scene changes.
1704 * - encoding: Set by user.
05fbd0a2
MN
1705 * - decoding: unused
1706 */
1707 int scenechange_threshold;
158c7f05
MN
1708
1709 /**
f5bccd85
DB
1710 * minimum Lagrange multipler
1711 * - encoding: Set by user.
158c7f05
MN
1712 * - decoding: unused
1713 */
1714 int lmin;
1715
1716 /**
f5bccd85
DB
1717 * maximum Lagrange multipler
1718 * - encoding: Set by user.
158c7f05
MN
1719 * - decoding: unused
1720 */
1721 int lmax;
2a2bbcb0
MM
1722
1723 /**
f5bccd85 1724 * palette control structure
2a2bbcb0 1725 * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85 1726 * - decoding: Set by user.
2a2bbcb0
MM
1727 */
1728 struct AVPaletteControl *palctrl;
821cb11f
MN
1729
1730 /**
1731 * noise reduction strength
f5bccd85 1732 * - encoding: Set by user.
821cb11f
MN
1733 * - decoding: unused
1734 */
1735 int noise_reduction;
115329f1 1736
074c4ca7 1737 /**
f5bccd85
DB
1738 * Called at the beginning of a frame to get cr buffer for it.
1739 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1740 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 1741 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 1742 * If pic.data[0] == NULL must behave like get_buffer().
074c4ca7 1743 * - encoding: unused
f5bccd85 1744 * - decoding: Set by libavcodec., user can override
074c4ca7 1745 */
e1c2a5a0 1746 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
1747
1748 /**
f5bccd85
DB
1749 * Number of bits which should be loaded into the rc buffer before decoding starts.
1750 * - encoding: Set by user.
ba58dabc
MN
1751 * - decoding: unused
1752 */
1753 int rc_initial_buffer_occupancy;
1754
1755 /**
1756 *
f5bccd85 1757 * - encoding: Set by user.
ba58dabc
MN
1758 * - decoding: unused
1759 */
1760 int inter_threshold;
1761
1762 /**
f5bccd85
DB
1763 * CODEC_FLAG2_*
1764 * - encoding: Set by user.
1765 * - decoding: Set by user.
ba58dabc
MN
1766 */
1767 int flags2;
7ebfc0ea
MN
1768
1769 /**
f5bccd85
DB
1770 * Simulates errors in the bitstream to test error concealment.
1771 * - encoding: Set by user.
1772 * - decoding: unused
7ebfc0ea
MN
1773 */
1774 int error_rate;
115329f1 1775
a1e257b2
MN
1776 /**
1777 * MP3 antialias algorithm, see FF_AA_* below.
1778 * - encoding: unused
f5bccd85 1779 * - decoding: Set by user.
a1e257b2
MN
1780 */
1781 int antialias_algo;
1782#define FF_AA_AUTO 0
1783#define FF_AA_FASTINT 1 //not implemented yet
1784#define FF_AA_INT 2
1785#define FF_AA_FLOAT 3
77ea0d4b 1786 /**
f5bccd85
DB
1787 * quantizer noise shaping
1788 * - encoding: Set by user.
77ea0d4b
MN
1789 * - decoding: unused
1790 */
1791 int quantizer_noise_shaping;
9c3d33d6
MN
1792
1793 /**
f5bccd85 1794 * thread count
eafcac6a 1795 * is used to decide how many independent tasks should be passed to execute()
f5bccd85
DB
1796 * - encoding: Set by user.
1797 * - decoding: Set by user.
9c3d33d6
MN
1798 */
1799 int thread_count;
115329f1 1800
9c3d33d6 1801 /**
f5bccd85
DB
1802 * The codec may call this to execute several independent things.
1803 * It will return only after finishing all tasks.
1804 * The user may replace this with some multithreaded implementation,
1805 * the default implementation will execute the parts serially.
399cec2f 1806 * @param count the number of things to execute
f5bccd85
DB
1807 * - encoding: Set by libavcodec, user can override.
1808 * - decoding: Set by libavcodec, user can override.
9c3d33d6
MN
1809 */
1810 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
115329f1 1811
9c3d33d6 1812 /**
f5bccd85
DB
1813 * thread opaque
1814 * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
MN
1815 * - encoding: set by execute()
1816 * - decoding: set by execute()
1817 */
1818 void *thread_opaque;
a4d36c11
MN
1819
1820 /**
f5bccd85
DB
1821 * Motion estimation threshold below which no motion estimation is
1822 * performed, but instead the user specified motion vectors are used.
115329f1 1823 *
f5bccd85 1824 * - encoding: Set by user.
f20f8a8b 1825 * - decoding: unused
a4d36c11 1826 */
2750b827 1827 int me_threshold;
f20f8a8b
MN
1828
1829 /**
f5bccd85
DB
1830 * Macroblock threshold below which the user specified macroblock types will be used.
1831 * - encoding: Set by user.
f20f8a8b
MN
1832 * - decoding: unused
1833 */
1834 int mb_threshold;
bf266e19
MN
1835
1836 /**
f5bccd85
DB
1837 * precision of the intra DC coefficient - 8
1838 * - encoding: Set by user.
bf266e19
MN
1839 * - decoding: unused
1840 */
1841 int intra_dc_precision;
d4c5d2ad
MN
1842
1843 /**
f5bccd85
DB
1844 * noise vs. sse weight for the nsse comparsion function
1845 * - encoding: Set by user.
d4c5d2ad
MN
1846 * - decoding: unused
1847 */
1848 int nsse_weight;
0dfd33c3
MN
1849
1850 /**
f5bccd85 1851 * Number of macroblock rows at the top which are skipped.
0dfd33c3 1852 * - encoding: unused
f5bccd85 1853 * - decoding: Set by user.
0dfd33c3
MN
1854 */
1855 int skip_top;
1856
1857 /**
f5bccd85 1858 * Number of macroblock rows at the bottom which are skipped.
0dfd33c3 1859 * - encoding: unused
f5bccd85 1860 * - decoding: Set by user.
0dfd33c3
MN
1861 */
1862 int skip_bottom;
baced9f5
MN
1863
1864 /**
1865 * profile
f5bccd85
DB
1866 * - encoding: Set by user.
1867 * - decoding: Set by libavcodec.
baced9f5
MN
1868 */
1869 int profile;
1870#define FF_PROFILE_UNKNOWN -99
4f2c36ac 1871#define FF_PROFILE_AAC_MAIN 0
273b0cd3
DB
1872#define FF_PROFILE_AAC_LOW 1
1873#define FF_PROFILE_AAC_SSR 2
1874#define FF_PROFILE_AAC_LTP 3
baced9f5
MN
1875
1876 /**
1877 * level
f5bccd85
DB
1878 * - encoding: Set by user.
1879 * - decoding: Set by libavcodec.
baced9f5
MN
1880 */
1881 int level;
1882#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
1883
1884 /**
f5bccd85 1885 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8 1886 * - encoding: unused
f5bccd85 1887 * - decoding: Set by user.
178fcca8
MN
1888 */
1889 int lowres;
21adafec
MN
1890
1891 /**
f5bccd85
DB
1892 * Bitstream width / height, may be different from width/height if lowres
1893 * or other things are used.
21adafec 1894 * - encoding: unused
f5bccd85 1895 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
MN
1896 */
1897 int coded_width, coded_height;
bbf18b21
MN
1898
1899 /**
1900 * frame skip threshold
f5bccd85 1901 * - encoding: Set by user.
bbf18b21
MN
1902 * - decoding: unused
1903 */
1904 int frame_skip_threshold;
1905
1906 /**
1907 * frame skip factor
f5bccd85 1908 * - encoding: Set by user.
bbf18b21
MN
1909 * - decoding: unused
1910 */
1911 int frame_skip_factor;
0fd6aea1
MN
1912
1913 /**
1914 * frame skip exponent
f5bccd85 1915 * - encoding: Set by user.
0fd6aea1
MN
1916 * - decoding: unused
1917 */
1918 int frame_skip_exp;
1919
1920 /**
f5bccd85
DB
1921 * frame skip comparison function
1922 * - encoding: Set by user.
0fd6aea1
MN
1923 * - decoding: unused
1924 */
1925 int frame_skip_cmp;
957c743a
CM
1926
1927 /**
f5bccd85 1928 * Border processing masking, raises the quantizer for mbs on the borders
957c743a 1929 * of the picture.
f5bccd85 1930 * - encoding: Set by user.
957c743a
CM
1931 * - decoding: unused
1932 */
1933 float border_masking;
6e0d8c06
MN
1934
1935 /**
f5bccd85
DB
1936 * minimum MB lagrange multipler
1937 * - encoding: Set by user.
6e0d8c06
MN
1938 * - decoding: unused
1939 */
1940 int mb_lmin;
1941
1942 /**
f5bccd85
DB
1943 * maximum MB lagrange multipler
1944 * - encoding: Set by user.
6e0d8c06
MN
1945 * - decoding: unused
1946 */
1947 int mb_lmax;
09c3e44e
MN
1948
1949 /**
115329f1 1950 *
f5bccd85 1951 * - encoding: Set by user.
09c3e44e
MN
1952 * - decoding: unused
1953 */
1954 int me_penalty_compensation;
8c3eba7c
MN
1955
1956 /**
115329f1 1957 *
8c3eba7c 1958 * - encoding: unused
f5bccd85 1959 * - decoding: Set by user.
8c3eba7c
MN
1960 */
1961 enum AVDiscard skip_loop_filter;
1962
1963 /**
115329f1 1964 *
8c3eba7c 1965 * - encoding: unused
f5bccd85 1966 * - decoding: Set by user.
8c3eba7c
MN
1967 */
1968 enum AVDiscard skip_idct;
1969
1970 /**
115329f1 1971 *
8c3eba7c 1972 * - encoding: unused
f5bccd85 1973 * - decoding: Set by user.
8c3eba7c
MN
1974 */
1975 enum AVDiscard skip_frame;
316a2ec8
MN
1976
1977 /**
1978 *
f5bccd85 1979 * - encoding: Set by user.
316a2ec8
MN
1980 * - decoding: unused
1981 */
1982 int bidir_refine;
e8501c93
MN
1983
1984 /**
1985 *
f5bccd85 1986 * - encoding: Set by user.
e8501c93
MN
1987 * - decoding: unused
1988 */
1989 int brd_scale;
58f7833e
RS
1990
1991 /**
1992 * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85 1993 * - encoding: Set by user.
58f7833e
RS
1994 * - decoding: unused
1995 */
9f1c1c99 1996 float crf;
58f7833e
RS
1997
1998 /**
1999 * constant quantization parameter rate control method
f5bccd85 2000 * - encoding: Set by user.
58f7833e
RS
2001 * - decoding: unused
2002 */
2003 int cqp;
2004
2005 /**
f5bccd85
DB
2006 * minimum GOP size
2007 * - encoding: Set by user.
58f7833e
RS
2008 * - decoding: unused
2009 */
2010 int keyint_min;
2011
2012 /**
2013 * number of reference frames
f5bccd85 2014 * - encoding: Set by user.
58f7833e
RS
2015 * - decoding: unused
2016 */
2017 int refs;
2018
2019 /**
2020 * chroma qp offset from luma
f5bccd85 2021 * - encoding: Set by user.
58f7833e
RS
2022 * - decoding: unused
2023 */
2024 int chromaoffset;
2025
2026 /**
f5bccd85
DB
2027 * Influences how often B-frames are used.
2028 * - encoding: Set by user.
58f7833e
RS
2029 * - decoding: unused
2030 */
2031 int bframebias;
2032
2033 /**
2034 * trellis RD quantization
f5bccd85 2035 * - encoding: Set by user.
58f7833e
RS
2036 * - decoding: unused
2037 */
2038 int trellis;
2039
2040 /**
f5bccd85
DB
2041 * Reduce fluctuations in qp (before curve compression).
2042 * - encoding: Set by user.
58f7833e
RS
2043 * - decoding: unused
2044 */
2045 float complexityblur;
2046
2047 /**
2048 * in-loop deblocking filter alphac0 parameter
2049 * alpha is in the range -6...6
f5bccd85 2050 * - encoding: Set by user.
58f7833e
RS
2051 * - decoding: unused
2052 */
2053 int deblockalpha;
2054
2055 /**
2056 * in-loop deblocking filter beta parameter
2057 * beta is in the range -6...6
f5bccd85 2058 * - encoding: Set by user.
58f7833e
RS
2059 * - decoding: unused
2060 */
2061 int deblockbeta;
2062
2063 /**
2064 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85 2065 * - encoding: Set by user.
58f7833e
RS
2066 * - decoding: unused
2067 */
2068 int partitions;
56cc85a0
DB
2069#define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2070#define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2071#define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2072#define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2073#define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
RS
2074
2075 /**
f5bccd85
DB
2076 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2077 * - encoding: Set by user.
58f7833e
RS
2078 * - decoding: unused
2079 */
2080 int directpred;
4f59b684 2081
14f0c8e2 2082 /**
02c164c1 2083 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2084 * - encoding: Set by user.
14f0c8e2
LA
2085 * - decoding: unused
2086 */
2087 int cutoff;
39a64e30
CH
2088
2089 /**
f5bccd85
DB
2090 * Multiplied by qscale for each frame and added to scene_change_score.
2091 * - encoding: Set by user.
39a64e30
CH
2092 * - decoding: unused
2093 */
2094 int scenechange_factor;
1dd509b1
MN
2095
2096 /**
2097 *
f5bccd85
DB
2098 * Note: Value depends upon the compare function used for fullpel ME.
2099 * - encoding: Set by user.
1dd509b1
MN
2100 * - decoding: unused
2101 */
2102 int mv0_threshold;
f9243d34
CH
2103
2104 /**
f5bccd85
DB
2105 * Adjusts sensitivity of b_frame_strategy 1.
2106 * - encoding: Set by user.
f9243d34
CH
2107 * - decoding: unused
2108 */
2109 int b_sensitivity;
a403fc03
JR
2110
2111 /**
f5bccd85 2112 * - encoding: Set by user.
a403fc03
JR
2113 * - decoding: unused
2114 */
2115 int compression_level;
2116#define FF_COMPRESSION_DEFAULT -1
2117
2118 /**
f5bccd85
DB
2119 * Sets whether to use LPC mode - used by FLAC encoder.
2120 * - encoding: Set by user.
2121 * - decoding: unused
a403fc03
JR
2122 */
2123 int use_lpc;
2124
2125 /**
2126 * LPC coefficient precision - used by FLAC encoder
f5bccd85
DB
2127 * - encoding: Set by user.
2128 * - decoding: unused
a403fc03
JR
2129 */
2130 int lpc_coeff_precision;
2131
2132 /**
f5bccd85
DB
2133 * - encoding: Set by user.
2134 * - decoding: unused
a403fc03
JR
2135 */
2136 int min_prediction_order;
2137
2138 /**
f5bccd85
DB
2139 * - encoding: Set by user.
2140 * - decoding: unused
a403fc03
JR
2141 */
2142 int max_prediction_order;
2143
2144 /**
2145 * search method for selecting prediction order
f5bccd85
DB
2146 * - encoding: Set by user.
2147 * - decoding: unused
a403fc03
JR
2148 */
2149 int prediction_order_method;
2150
2151 /**
f5bccd85
DB
2152 * - encoding: Set by user.
2153 * - decoding: unused
a403fc03
JR
2154 */
2155 int min_partition_order;
2156
2157 /**
f5bccd85
DB
2158 * - encoding: Set by user.
2159 * - decoding: unused
a403fc03
JR
2160 */
2161 int max_partition_order;
80d617f5
BC
2162
2163 /**
2164 * GOP timecode frame start number, in non drop frame format
f5bccd85
DB
2165 * - encoding: Set by user.
2166 * - decoding: unused
80d617f5
BC
2167 */
2168 int64_t timecode_frame_start;
b1ec601f
RD
2169
2170 /**
2171 * Decoder should decode to this many channels if it can (0 for default)
2172 * - encoding: unused
2173 * - decoding: Set by user.
2174 */
2175 int request_channels;
1408352a
JR
2176
2177 /**
2178 * Percentage of dynamic range compression to be applied by the decoder.
2179 * The default value is 1.0, corresponding to full compression.
2180 * - encoding: unused
2181 * - decoding: Set by user.
2182 */
2183 float drc_scale;
de6d9b64
FB
2184} AVCodecContext;
2185
64863965
MN
2186/**
2187 * AVCodec.
2188 */
de6d9b64 2189typedef struct AVCodec {
6b0cdb6e
NG
2190 /**
2191 * Name of the codec implementation.
2192 * The name is globally unique among encoders and among decoders (but an
2193 * encoder and a decoder can share the same name).
2194 * This is the primary way to find a codec from the user perspective.
2195 */
18f77016 2196 const char *name;
5d234974 2197 enum CodecType type;
9297ddd3 2198 enum CodecID id;
de6d9b64
FB
2199 int priv_data_size;
2200 int (*init)(AVCodecContext *);
0c1a9eda 2201 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2202 int (*close)(AVCodecContext *);
0fd90455 2203 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
6ddaa63c 2204 const uint8_t *buf, int buf_size);
bf89e6b1 2205 int capabilities;
de6d9b64 2206 struct AVCodec *next;
7a06ff14 2207 void (*flush)(AVCodecContext *);
b0df362b 2208 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
fcee0164 2209 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
de6d9b64
FB
2210} AVCodec;
2211
97d96aaa 2212/**
d7425f59
MN
2213 * four components are given, that's all.
2214 * the last component is alpha
2215 */
de6d9b64 2216typedef struct AVPicture {
0c1a9eda 2217 uint8_t *data[4];
cd394651 2218 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
2219} AVPicture;
2220
ba118447
MM
2221/**
2222 * AVPaletteControl
2223 * This structure defines a method for communicating palette changes
2224 * between and demuxer and a decoder.
671adb17
MC
2225 *
2226 * @deprecated Use AVPacket to send palette changes instead.
2227 * This is totally broken.
ba118447 2228 */
2e99641b 2229#define AVPALETTE_SIZE 1024
432d84c3 2230#define AVPALETTE_COUNT 256
ba118447
MM
2231typedef struct AVPaletteControl {
2232
f5bccd85
DB
2233 /* Demuxer sets this to 1 to indicate the palette has changed;
2234 * decoder resets to 0. */
ba118447
MM
2235 int palette_changed;
2236
2a2bbcb0
MM
2237 /* 4-byte ARGB palette entries, stored in native byte order; note that
2238 * the individual palette components should be on a 8-bit scale; if
f5bccd85
DB
2239 * the palette data comes from an IBM VGA native format, the component
2240 * data is probably 6 bits in size and needs to be scaled. */
2e99641b 2241 unsigned int palette[AVPALETTE_COUNT];
ba118447 2242
18239edf 2243} AVPaletteControl attribute_deprecated;
ba118447 2244
c6ec28b1 2245typedef struct AVSubtitleRect {
240c1657
FB
2246 uint16_t x;
2247 uint16_t y;
2248 uint16_t w;
2249 uint16_t h;
2250 uint16_t nb_colors;
240c1657
FB
2251 int linesize;
2252 uint32_t *rgba_palette;
2253 uint8_t *bitmap;
c6ec28b1
MN
2254} AVSubtitleRect;
2255
2256typedef struct AVSubtitle {
2257 uint16_t format; /* 0 = graphics */
2258 uint32_t start_display_time; /* relative to packet pts, in ms */
2259 uint32_t end_display_time; /* relative to packet pts, in ms */
2260 uint32_t num_rects;
2261 AVSubtitleRect *rects;
240c1657
FB
2262} AVSubtitle;
2263
240c1657 2264
de6d9b64
FB
2265/* resample.c */
2266
2267struct ReSampleContext;
aaaf1635 2268struct AVResampleContext;
de6d9b64
FB
2269
2270typedef struct ReSampleContext ReSampleContext;
2271
115329f1 2272ReSampleContext *audio_resample_init(int output_channels, int input_channels,
de6d9b64
FB
2273 int output_rate, int input_rate);
2274int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2275void audio_resample_close(ReSampleContext *s);
2276
6e225de2 2277struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
aaaf1635 2278int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2d48eddd 2279void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae 2280void av_resample_close(struct AVResampleContext *c);
aaaf1635 2281
bc2ce35b 2282#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
de6d9b64
FB
2283/* YUV420 format is assumed ! */
2284
671adb17
MC
2285/**
2286 * @deprecated Use the software scaler (swscale) instead.
2287 */
bc2ce35b 2288typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
de6d9b64 2289
671adb17
MC
2290/**
2291 * @deprecated Use the software scaler (swscale) instead.
2292 */
bc2ce35b 2293attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
de6d9b64 2294 int input_width, int input_height);
ab6d194a 2295
671adb17
MC
2296/**
2297 * @deprecated Use the software scaler (swscale) instead.
2298 */
bc2ce35b 2299attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
ab6d194a
MN
2300 int iwidth, int iheight,
2301 int topBand, int bottomBand,
1ff93ffc
TK
2302 int leftBand, int rightBand,
2303 int padtop, int padbottom,
2304 int padleft, int padright);
2305
671adb17
MC
2306/**
2307 * @deprecated Use the software scaler (swscale) instead.
2308 */
4f13e733 2309attribute_deprecated void img_resample(struct ImgReSampleContext *s,
da64ecc3 2310 AVPicture *output, const AVPicture *input);
de6d9b64 2311
671adb17
MC
2312/**
2313 * @deprecated Use the software scaler (swscale) instead.
2314 */
4f13e733 2315attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
bc2ce35b
MN
2316
2317#endif
de6d9b64 2318
75917b88
DH
2319/**
2320 * Allocate memory for a picture. Call avpicture_free to free it.
2321 *
f5bccd85
DB
2322 * @param picture the picture to be filled in
2323 * @param pix_fmt the format of the picture
2324 * @param width the width of the picture
2325 * @param height the height of the picture
2326 * @return zero if successful, a negative value if not
75917b88
DH
2327 */
2328int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2329
8fc3d25c
PI
2330/**
2331 * Free a picture previously allocated by avpicture_alloc().
2332 *
f5bccd85 2333 * @param picture the AVPicture to be freed
8fc3d25c 2334 */
75917b88
DH
2335void avpicture_free(AVPicture *picture);
2336
392cf77a 2337/**
f5bccd85 2338 * Fill in the AVPicture fields.
392cf77a
PI
2339 * The fields of the given AVPicture are filled in by using the 'ptr' address
2340 * which points to the image data buffer. Depending on the specified picture
2341 * format, one or multiple image data pointers and line sizes will be set.
2342 * If a planar format is specified, several pointers will be set pointing to
2343 * the different picture planes and the line sizes of the different planes
2344 * will be stored in the lines_sizes array.
2345 *
f5bccd85 2346 * @param picture AVPicture whose fields are to be filled in
392cf77a 2347 * @param ptr Buffer which will contain or contains the actual image data
f5bccd85
DB
2348 * @param pix_fmt The format in which the picture data is stored.
2349 * @param width the width of the image in pixels
2350 * @param height the height of the image in pixels
2351 * @return size of the image data in bytes
392cf77a 2352 */
0c1a9eda 2353int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 2354 int pix_fmt, int width, int height);
da64ecc3 2355int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
63167088 2356 unsigned char *dest, int dest_size);
392cf77a
PI
2357
2358/**
2359 * Calculate the size in bytes that a picture of the given width and height
2360 * would occupy if stored in the given picture format.
2361 *
f5bccd85
DB
2362 * @param pix_fmt the given picture format
2363 * @param width the width of the image
2364 * @param height the height of the image
392cf77a
PI
2365 * @return Image data size in bytes
2366 */
219b06c6 2367int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
2368void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2369const char *avcodec_get_pix_fmt_name(int pix_fmt);
21adafec 2370void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
63167088 2371enum PixelFormat avcodec_get_pix_fmt(const char* name);
d07730dd 2372unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
219b06c6 2373
81299d42
PI
2374#define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2375#define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2376#define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2377#define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2378#define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2379#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
fab21997 2380
392cf77a 2381/**
81299d42
PI
2382 * Computes what kind of losses will occur when converting from one specific
2383 * pixel format to another.
2384 * When converting from one pixel format to another, information loss may occur.
2385 * For example, when converting from RGB24 to GRAY, the color information will
2386 * be lost. Similarly, other losses occur when converting from some formats to
2387 * other formats. These losses can involve loss of chroma, but also loss of
2388 * resolution, loss of color depth, loss due to the color space conversion, loss
2389 * of the alpha bits or loss due to color quantization.
f5bccd85
DB
2390 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2391 * which will occur when converting from one pixel format to another.
81299d42 2392 *
f5bccd85
DB
2393 * @param[in] dst_pix_fmt destination pixel format
2394 * @param[in] src_pix_fmt source pixel format
81299d42
PI
2395 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2396 * @return Combination of flags informing you what kind of losses will occur.
392cf77a 2397 */
fab21997
FB
2398int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2399 int has_alpha);
392cf77a
PI
2400
2401/**
81299d42
PI
2402 * Finds the best pixel format to convert to given a certain source pixel
2403 * format. When converting from one pixel format to another, information loss
2404 * may occur. For example, when converting from RGB24 to GRAY, the color
2405 * information will be lost. Similarly, other losses occur when converting from
2406 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
f5bccd85
DB
2407 * the given pixel formats should be used to suffer the least amount of loss.
2408 * The pixel formats from which it chooses one, are determined by the
81299d42
PI
2409 * \p pix_fmt_mask parameter.
2410 *
2411 * @code
2412 * src_pix_fmt = PIX_FMT_YUV420P;
2413 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2414 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2415 * @endcode
2416 *
f5bccd85
DB
2417 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2418 * @param[in] src_pix_fmt source pixel format
81299d42
PI
2419 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2420 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2421 * @return The best pixel format to convert to or -1 if none was found.
392cf77a 2422 */
fab21997
FB
2423int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2424 int has_alpha, int *loss_ptr);
2425
c3b95b1d
SS
2426
2427/**
2428 * Print in buf the string corresponding to the pixel format with
2429 * number pix_fmt, or an header if pix_fmt is negative.
2430 *
9bd51b9a
PI
2431 * @param[in] buf the buffer where to write the string
2432 * @param[in] buf_size the size of buf
2433 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
c3b95b1d
SS
2434 * a negative value to print the corresponding header.
2435 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2436 */
2437void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2438
0469baf1
FB
2439#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2440#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
392cf77a
PI
2441
2442/**
2443 * Tell if an image really has transparent alpha values.
2444 * @return ored mask of FF_ALPHA_xxx constants
2445 */
da64ecc3 2446int img_get_alpha_info(const AVPicture *src,
bb270c08 2447 int pix_fmt, int width, int height);
0469baf1 2448
bc2ce35b 2449#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
671adb17
MC
2450/**
2451 * convert among pixel formats
2452 * @deprecated Use the software scaler (swscale) instead.
2453 */
bc2ce35b 2454attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
115329f1 2455 const AVPicture *src, int pix_fmt,
219b06c6 2456 int width, int height);
bc2ce35b 2457#endif
219b06c6
FB
2458
2459/* deinterlace a picture */
392cf77a 2460/* deinterlace - if not supported return -1 */
da64ecc3 2461int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
de6d9b64
FB
2462 int pix_fmt, int width, int height);
2463
2464/* external high level API */
2465
55b9e69a 2466#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
de6d9b64 2467extern AVCodec *first_avcodec;
55b9e69a
MN
2468#endif
2469AVCodec *av_codec_next(AVCodec *c);
de6d9b64 2470
156e5023 2471/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 2472unsigned avcodec_version(void);
8bceb6af 2473/* returns LIBAVCODEC_BUILD constant */
51a49663 2474unsigned avcodec_build(void);
f9ec0aa1
PI
2475
2476/**
2477 * Initializes libavcodec.
2478 *
2479 * @warning This function \e must be called before any other libavcodec
2480 * function.
2481 */
de6d9b64
FB
2482void avcodec_init(void);
2483
2484void register_avcodec(AVCodec *format);
f9ec0aa1
PI
2485
2486/**
645f7879 2487 * Finds a registered encoder with a matching codec ID.
f9ec0aa1 2488 *
f5bccd85 2489 * @param id CodecID of the requested encoder
f9ec0aa1
PI
2490 * @return An encoder if one was found, NULL otherwise.
2491 */
de6d9b64 2492AVCodec *avcodec_find_encoder(enum CodecID id);
f9ec0aa1
PI
2493
2494/**
645f7879 2495 * Finds a registered encoder with the specified name.
f9ec0aa1 2496 *
f5bccd85 2497 * @param name name of the requested encoder
f9ec0aa1
PI
2498 * @return An encoder if one was found, NULL otherwise.
2499 */
98f3b098 2500AVCodec *avcodec_find_encoder_by_name(const char *name);
f9ec0aa1
PI
2501
2502/**
645f7879 2503 * Finds a registered decoder with a matching codec ID.
f9ec0aa1 2504 *
f5bccd85 2505 * @param id CodecID of the requested decoder
f9ec0aa1
PI
2506 * @return A decoder if one was found, NULL otherwise.
2507 */
de6d9b64 2508AVCodec *avcodec_find_decoder(enum CodecID id);
f9ec0aa1
PI
2509
2510/**
645f7879 2511 * Finds a registered decoder with the specified name.
f9ec0aa1 2512 *
f5bccd85 2513 * @param name name of the requested decoder
f9ec0aa1
PI
2514 * @return A decoder if one was found, NULL otherwise.
2515 */
de6d9b64
FB
2516AVCodec *avcodec_find_decoder_by_name(const char *name);
2517void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2518
f9ec0aa1
PI
2519/**
2520 * Sets the fields of the given AVCodecContext to default values.
2521 *
2522 * @param s The AVCodecContext of which the fields should be set to default values.
2523 */
1e491e29 2524void avcodec_get_context_defaults(AVCodecContext *s);
f9ec0aa1 2525
29301573
MN
2526/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2527 * we WILL change its arguments and name a few times! */
2528void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2529
f9ec0aa1
PI
2530/**
2531 * Allocates an AVCodecContext and sets its fields to default values. The
2532 * resulting struct can be deallocated by simply calling av_free().
2533 *
2534 * @return An AVCodecContext filled with default values or NULL on failure.
2535 * @see avcodec_get_context_defaults
2536 */
7ffbb60e 2537AVCodecContext *avcodec_alloc_context(void);
f9ec0aa1 2538
29301573
MN
2539/** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2540 * we WILL change its arguments and name a few times! */
2541AVCodecContext *avcodec_alloc_context2(enum CodecType);
2542
f9ec0aa1
PI
2543/**
2544 * Sets the fields of the given AVFrame to default values.
2545 *
2546 * @param pic The AVFrame of which the fields should be set to default values.
2547 */
7906085f 2548void avcodec_get_frame_defaults(AVFrame *pic);
f9ec0aa1
PI
2549
2550/**
2551 * Allocates an AVFrame and sets its fields to default values. The resulting
2552 * struct can be deallocated by simply calling av_free().
2553 *
2554 * @return An AVFrame filled with default values or NULL on failure.
2555 * @see avcodec_get_frame_defaults
2556 */
492cd3a9 2557AVFrame *avcodec_alloc_frame(void);
1e491e29 2558
492cd3a9
MN
2559int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2560void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3a569751
MN
2561int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2562void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
f9ec0aa1
PI
2563
2564/**
2565 * Checks if the given dimension of a picture is valid, meaning that all
2566 * bytes of the picture can be addressed with a signed int.
2567 *
2568 * @param[in] w Width of the picture.
2569 * @param[in] h Height of the picture.
2570 * @return Zero if valid, a negative value if invalid.
2571 */
0ecca7a4 2572int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3a569751 2573enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
1e491e29 2574
5a815088
MN
2575int avcodec_thread_init(AVCodecContext *s, int thread_count);
2576void avcodec_thread_free(AVCodecContext *s);
2577int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
3a569751 2578int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
9c3d33d6
MN
2579//FIXME func typedef
2580
7a06ff14 2581/**
f9ec0aa1
PI
2582 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2583 * function the context has to be allocated.
2584 *
2585 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2586 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2587 * retrieving a codec.
2588 *
f5bccd85 2589 * @warning This function is not thread safe!
f9ec0aa1
PI
2590 *
2591 * @code
c9823f05 2592 * avcodec_register_all();
f9ec0aa1
PI
2593 * codec = avcodec_find_decoder(CODEC_ID_H264);
2594 * if (!codec)
2595 * exit(1);
2596 *
2597 * context = avcodec_alloc_context();
2598 *
2599 * if (avcodec_open(context, codec) < 0)
2600 * exit(1);
2601 * @endcode
2602 *
f5bccd85 2603 * @param avctx The context which will be set up to use the given codec.
f9ec0aa1 2604 * @param codec The codec to use within the context.
f5bccd85 2605 * @return zero on success, a negative value on error
f9ec0aa1 2606 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
7a06ff14 2607 */
de6d9b64 2608int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 2609
f9ec0aa1
PI
2610/**
2611 * @deprecated Use avcodec_decode_audio2() instead.
2612 */
ac66834c
MN
2613attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2614 int *frame_size_ptr,
2efa7fd1 2615 const uint8_t *buf, int buf_size);
f9ec0aa1 2616
98145875 2617/**
f9ec0aa1 2618 * Decodes an audio frame from \p buf into \p samples.
f5bccd85 2619 * The avcodec_decode_audio2() function decodes an audio frame from the input
f9ec0aa1 2620 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
f5bccd85 2621 * audio codec which was coupled with \p avctx using avcodec_open(). The
f9ec0aa1
PI
2622 * resulting decoded frame is stored in output buffer \p samples. If no frame
2623 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2624 * decompressed frame size in \e bytes.
2625 *
2626 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2627 * output buffer before calling avcodec_decode_audio2().
2628 *
2629 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2630 * the actual read bytes because some optimized bitstream readers read 32 or 64
2631 * bits at once and could read over the end.
2632 *
2633 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2634 * no overreading happens for damaged MPEG streams.
98145875 2635 *
f9ec0aa1 2636 * @note You might have to align the input buffer \p buf and output buffer \p
f5bccd85 2637 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
f9ec0aa1
PI
2638 * necessary at all, on others it won't work at all if not aligned and on others
2639 * it will work but it will have an impact on performance. In practice, the
2640 * bitstream should have 4 byte alignment at minimum and all sample data should
2641 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2642 * the linesize is not a multiple of 16 then there's no sense in aligning the
2643 * start of the buffer to 16.
2644 *
f5bccd85
DB
2645 * @param avctx the codec context
2646 * @param[out] samples the output buffer
2647 * @param[in,out] frame_size_ptr the output buffer size in bytes
2648 * @param[in] buf the input buffer
2649 * @param[in] buf_size the input buffer size in bytes
f9ec0aa1
PI
2650 * @return On error a negative value is returned, otherwise the number of bytes
2651 * used or zero if no frame could be decompressed.
98145875 2652 */
ac66834c 2653int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
de6d9b64 2654 int *frame_size_ptr,
2efa7fd1 2655 const uint8_t *buf, int buf_size);
f9ec0aa1
PI
2656
2657/**
2658 * Decodes a video frame from \p buf into \p picture.
f5bccd85 2659 * The avcodec_decode_video() function decodes a video frame from the input
f9ec0aa1 2660 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
f5bccd85 2661 * video codec which was coupled with \p avctx using avcodec_open(). The
f9ec0aa1
PI
2662 * resulting decoded frame is stored in \p picture.
2663 *
2664 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2665 * the actual read bytes because some optimized bitstream readers read 32 or 64
2666 * bits at once and could read over the end.
2667 *
2668 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2669 * no overreading happens for damaged MPEG streams.
2670 *
2671 * @note You might have to align the input buffer \p buf and output buffer \p
2672 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2673 * necessary at all, on others it won't work at all if not aligned and on others
2674 * it will work but it will have an impact on performance. In practice, the
2675 * bitstream should have 4 byte alignment at minimum and all sample data should
2676 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2677 * the linesize is not a multiple of 16 then there's no sense in aligning the
2678 * start of the buffer to 16.
2679 *
f5bccd85 2680 * @param avctx the codec context
f9ec0aa1 2681 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
f5bccd85
DB
2682 * @param[in] buf the input buffer
2683 * @param[in] buf_size the size of the input buffer in bytes
2684 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
f9ec0aa1
PI
2685 * @return On error a negative value is returned, otherwise the number of bytes
2686 * used or zero if no frame could be decompressed.
2687 */
115329f1 2688int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 2689 int *got_picture_ptr,
2efa7fd1 2690 const uint8_t *buf, int buf_size);
8ab4861c 2691
f5bccd85
DB
2692/* Decode a subtitle message. Return -1 if error, otherwise return the
2693 * number of bytes used. If no subtitle could be decompressed,
2694 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
240c1657
FB
2695int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2696 int *got_sub_ptr,
2697 const uint8_t *buf, int buf_size);
115329f1 2698int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 2699 int *data_size_ptr,
0c1a9eda 2700 uint8_t *buf, int buf_size);
f9ec0aa1
PI
2701
2702/**
2703 * Encodes an audio frame from \p samples into \p buf.
f5bccd85
DB
2704 * The avcodec_encode_audio() function encodes an audio frame from the input
2705 * buffer \p samples. To encode it, it makes use of the audio codec which was
f9ec0aa1
PI
2706 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2707 * stored in output buffer \p buf.
2708 *
2709 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2710 *
f5bccd85
DB
2711 * @param avctx the codec context
2712 * @param[out] buf the output buffer
2713 * @param[in] buf_size the output buffer size
2714 * @param[in] samples the input buffer containing the samples
0fe93f07
SS
2715 * The number of samples read from this buffer is frame_size*channels,
2716 * both of which are defined in \p avctx.
7338d368 2717 * @return On error a negative value is returned, on success zero or the number
0fe93f07 2718 * of bytes used to encode the data read from the input buffer.
f9ec0aa1 2719 */
115329f1 2720int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 2721 const short *samples);
f9ec0aa1
PI
2722
2723/**
2724 * Encodes a video frame from \p pict into \p buf.
f5bccd85
DB
2725 * The avcodec_encode_video() function encodes a video frame from the input
2726 * \p pict. To encode it, it makes use of the video codec which was coupled with
f9ec0aa1
PI
2727 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2728 * frame are stored in the output buffer \p buf. The input picture should be
2729 * stored using a specific format, namely \c avctx.pix_fmt.
2730 *
f5bccd85
DB
2731 * @param avctx the codec context
2732 * @param[out] buf the output buffer for the bitstream of encoded frame
2733 * @param[in] buf_size the size of the output buffer in bytes
2734 * @param[in] pict the input picture to encode
f9ec0aa1
PI
2735 * @return On error a negative value is returned, on success zero or the number
2736 * of bytes used from the input buffer.
2737 */
115329f1 2738int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 2739 const AVFrame *pict);
115329f1 2740int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
240c1657 2741 const AVSubtitle *sub);
de6d9b64
FB
2742
2743int avcodec_close(AVCodecContext *avctx);
2744
2745void avcodec_register_all(void);
a96b68b7 2746
8ab4861c
PI
2747/**
2748 * Flush buffers, should be called when seeking or when switching to a different stream.
2749 */
1c2a8c7f
MN
2750void avcodec_flush_buffers(AVCodecContext *avctx);
2751
88730be6
MR
2752void avcodec_default_free_buffers(AVCodecContext *s);
2753
85975aa9 2754/* misc useful functions */
d8085ea7
MN
2755
2756/**
8f6260af
PI
2757 * Returns a single letter to describe the given picture type \p pict_type.
2758 *
f5bccd85 2759 * @param[in] pict_type the picture type
8f6260af 2760 * @return A single character representing the picture type.
d8085ea7
MN
2761 */
2762char av_get_pict_type_char(int pict_type);
2763
ac3e1834 2764/**
2fa378a7
PI
2765 * Returns codec bits per sample.
2766 *
f5bccd85 2767 * @param[in] codec_id the codec
2fa378a7 2768 * @return Number of bits per sample or zero if unknown for the given codec.
ac3e1834
BC
2769 */
2770int av_get_bits_per_sample(enum CodecID codec_id);
2e8f2c20 2771
42c71907
DC
2772/**
2773 * Returns sample format bits per sample.
2774 *
2775 * @param[in] sample_fmt the sample format
2776 * @return Number of bits per sample or zero if unknown for the given sample format.
2777 */
2778int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2779
8424cf50
FB
2780/* frame parsing */
2781typedef struct AVCodecParserContext {
2782 void *priv_data;
2783 struct AVCodecParser *parser;
2784 int64_t frame_offset; /* offset of the current frame */
115329f1 2785 int64_t cur_offset; /* current offset
8424cf50
FB
2786 (incremented by each av_parser_parse()) */
2787 int64_t last_frame_offset; /* offset of the last frame */
2788 /* video info */
f5bccd85
DB
2789 int pict_type; /* XXX: Put it back in AVCodecContext. */
2790 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
b84f2a35
FB
2791 int64_t pts; /* pts of the current frame */
2792 int64_t dts; /* dts of the current frame */
2793
2794 /* private data */
2795 int64_t last_pts;
2796 int64_t last_dts;
a62aecce 2797 int fetch_timestamp;
b84f2a35
FB
2798
2799#define AV_PARSER_PTS_NB 4
2800 int cur_frame_start_index;
2801 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2802 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2803 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
115329f1 2804
7cbaa7ba
MN
2805 int flags;
2806#define PARSER_FLAG_COMPLETE_FRAMES 0x0001
a74008a4
JP
2807
2808 int64_t offset; ///< byte offset from starting packet start
2809 int64_t last_offset;
8424cf50
FB
2810} AVCodecParserContext;
2811
2812typedef struct AVCodecParser {
99f06236 2813 int codec_ids[5]; /* several codec IDs are permitted */
8424cf50
FB
2814 int priv_data_size;
2815 int (*parser_init)(AVCodecParserContext *s);
115329f1 2816 int (*parser_parse)(AVCodecParserContext *s,
8424cf50 2817 AVCodecContext *avctx,
c53d2d90 2818 const uint8_t **poutbuf, int *poutbuf_size,
8424cf50
FB
2819 const uint8_t *buf, int buf_size);
2820 void (*parser_close)(AVCodecParserContext *s);
90ad92b3 2821 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
8424cf50
FB
2822 struct AVCodecParser *next;
2823} AVCodecParser;
2824
55b9e69a 2825#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
8424cf50 2826extern AVCodecParser *av_first_parser;
55b9e69a
MN
2827#endif
2828AVCodecParser *av_parser_next(AVCodecParser *c);
8424cf50
FB
2829
2830void av_register_codec_parser(AVCodecParser *parser);
2831AVCodecParserContext *av_parser_init(int codec_id);
115329f1 2832int av_parser_parse(AVCodecParserContext *s,
8424cf50 2833 AVCodecContext *avctx,
115329f1 2834 uint8_t **poutbuf, int *poutbuf_size,
b84f2a35
FB
2835 const uint8_t *buf, int buf_size,
2836 int64_t pts, int64_t dts);
90ad92b3
MN
2837int av_parser_change(AVCodecParserContext *s,
2838 AVCodecContext *avctx,
115329f1 2839 uint8_t **poutbuf, int *poutbuf_size,
90ad92b3 2840 const uint8_t *buf, int buf_size, int keyframe);
8424cf50
FB
2841void av_parser_close(AVCodecParserContext *s);
2842
748c2fca
MN
2843
2844typedef struct AVBitStreamFilterContext {
514e0831 2845 void *priv_data;
748c2fca
MN
2846 struct AVBitStreamFilter *filter;
2847 AVCodecParserContext *parser;
2848 struct AVBitStreamFilterContext *next;
2849} AVBitStreamFilterContext;
2850
2851
2852typedef struct AVBitStreamFilter {
2853 const char *name;
514e0831 2854 int priv_data_size;
748c2fca
MN
2855 int (*filter)(AVBitStreamFilterContext *bsfc,
2856 AVCodecContext *avctx, const char *args,
2857 uint8_t **poutbuf, int *poutbuf_size,
2858 const uint8_t *buf, int buf_size, int keyframe);
0a1a0a80 2859 void (*close)(AVBitStreamFilterContext *bsfc);
748c2fca
MN
2860 struct AVBitStreamFilter *next;
2861} AVBitStreamFilter;
2862
748c2fca
MN
2863void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2864AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2865int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2866 AVCodecContext *avctx, const char *args,
2867 uint8_t **poutbuf, int *poutbuf_size,
2868 const uint8_t *buf, int buf_size, int keyframe);
2869void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2870
55b9e69a 2871AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
748c2fca 2872
544eb99c 2873/* memory */
8ab4861c
PI
2874
2875/**
4267e90d
PI
2876 * Reallocates the given block if it is not large enough, otherwise it
2877 * does nothing.
2878 *
2879 * @see av_realloc
8ab4861c 2880 */
97d96aaa 2881void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
8ab4861c 2882
855ea723 2883/* for static data only */
8ab4861c
PI
2884
2885/**
f5bccd85 2886 * Frees all static arrays and resets their pointers to 0.
8079a686 2887 * Call this function to release all statically allocated tables.
671adb17 2888 *
df3a80b5 2889 * @deprecated. Code which uses av_free_static is broken/misdesigned
671adb17
MC
2890 * and should correctly use static arrays
2891 *
8ab4861c 2892 */
ca2a0c93 2893attribute_deprecated void av_free_static(void);
8ab4861c
PI
2894
2895/**
9c5cb112
PI
2896 * Allocation of static arrays.
2897 *
2898 * @warning Do not use for normal allocation.
2899 *
2900 * @param[in] size The amount of memory you need in bytes.
f5bccd85 2901 * @return block of memory of the requested size
df3a80b5 2902 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
671adb17 2903 * and should correctly use static arrays
8ab4861c 2904 */
ca2a0c93 2905attribute_deprecated void *av_mallocz_static(unsigned int size);
8ab4861c 2906
392cf77a
PI
2907/**
2908 * Copy image 'src' to 'dst'.
2909 */
636d6a4a 2910void av_picture_copy(AVPicture *dst, const AVPicture *src,
e1c2a5a0
RT
2911 int pix_fmt, int width, int height);
2912
392cf77a 2913/**
f5bccd85 2914 * Crop image top and left side.
392cf77a 2915 */
636d6a4a 2916int av_picture_crop(AVPicture *dst, const AVPicture *src,
f2651e7a
BC
2917 int pix_fmt, int top_band, int left_band);
2918
392cf77a 2919/**
f5bccd85 2920 * Pad image.
392cf77a 2921 */
636d6a4a 2922int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
5341c209
LA
2923 int padtop, int padbottom, int padleft, int padright, int *color);
2924
636d6a4a 2925#if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
671adb17
MC
2926/**
2927 * @deprecated Use the software scaler (swscale) instead.
2928 */
636d6a4a
PI
2929attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2930 int pix_fmt, int width, int height);
2931
671adb17
MC
2932/**
2933 * @deprecated Use the software scaler (swscale) instead.
2934 */
636d6a4a
PI
2935attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2936 int pix_fmt, int top_band, int left_band);
2937
671adb17
MC
2938/**
2939 * @deprecated Use the software scaler (swscale) instead.
2940 */
636d6a4a
PI
2941attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2942 int padtop, int padbottom, int padleft, int padright, int *color);
2943#endif
2944
ad2b531d
MR
2945extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2946
26ef3220
SS
2947/**
2948 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2949 *
755bfeab 2950 * @return 0 in case of a successful parsing, a negative value otherwise
26ef3220
SS
2951 * @param[in] str the string to parse: it has to be a string in the format
2952 * <width>x<height> or a valid video frame size abbreviation.
2953 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2954 * frame width value
2955 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2956 * frame height value
2957 */
2958int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2959
2960/**
2961 * Parses \p str and put in \p frame_rate the detected values.
2962 *
755bfeab 2963 * @return 0 in case of a successful parsing, a negative value otherwise
26ef3220
SS
2964 * @param[in] str the string to parse: it has to be a string in the format
2965 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2966 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2967 * frame rate
2968 */
2969int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2970
8fa36ae0
FR
2971/* error handling */
2972#if EINVAL > 0
f5bccd85
DB
2973#define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2974#define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
8fa36ae0 2975#else
f5bccd85 2976/* Some platforms have E* and errno already negated. */
8fa36ae0
FR
2977#define AVERROR(e) (e)
2978#define AVUNERROR(e) (e)
2979#endif
2980#define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
f5bccd85
DB
2981#define AVERROR_IO AVERROR(EIO) /**< I/O error */
2982#define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
8fa36ae0
FR
2983#define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2984#define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2985#define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
f5bccd85 2986#define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
35e7f087 2987#define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
f3a3c72e 2988#define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
8fa36ae0 2989
5b21bdab 2990#endif /* FFMPEG_AVCODEC_H */