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