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