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