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