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