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