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