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