Commit | Line | Data |
---|---|---|
04d7f601 DB |
1 | /* |
2 | * copyright (c) 2001 Fabrice Bellard | |
3 | * | |
2912e87a | 4 | * This file is part of Libav. |
b78e7197 | 5 | * |
2912e87a | 6 | * Libav 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 | * |
2912e87a | 11 | * Libav 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 | |
2912e87a | 17 | * License along with Libav; 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 | /** |
ba87f080 | 25 | * @file |
f5bccd85 | 26 | * external API header |
36df8805 MN |
27 | */ |
28 | ||
c60208e7 | 29 | #include <errno.h> |
737eb597 | 30 | #include "libavutil/samplefmt.h" |
76a448ed | 31 | #include "libavutil/avutil.h" |
7160bb71 | 32 | #include "libavutil/cpu.h" |
0b950fe2 | 33 | #include "libavutil/dict.h" |
abc78a5a | 34 | #include "libavutil/log.h" |
d49ea4af | 35 | #include "libavutil/pixfmt.h" |
e91709ca | 36 | #include "libavutil/rational.h" |
de6d9b64 | 37 | |
3dd851c4 | 38 | #include "libavcodec/version.h" |
e97e5a2e LB |
39 | /** |
40 | * @defgroup libavc Encoding/Decoding Library | |
41 | * @{ | |
42 | * | |
43 | * @defgroup lavc_decoding Decoding | |
44 | * @{ | |
45 | * @} | |
46 | * | |
47 | * @defgroup lavc_encoding Encoding | |
48 | * @{ | |
49 | * @} | |
50 | * | |
51 | * @defgroup lavc_codec Codecs | |
52 | * @{ | |
53 | * @defgroup lavc_codec_native Native Codecs | |
54 | * @{ | |
55 | * @} | |
56 | * @defgroup lavc_codec_wrappers External library wrappers | |
57 | * @{ | |
58 | * @} | |
59 | * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge | |
60 | * @{ | |
61 | * @} | |
62 | * @} | |
63 | * @defgroup lavc_internal Internal | |
64 | * @{ | |
65 | * @} | |
66 | * @} | |
67 | * | |
68 | */ | |
69 | ||
eda7c983 | 70 | |
7ebf5927 | 71 | /** |
48966b02 | 72 | * Identify the syntax and semantics of the bitstream. |
6b0cdb6e NG |
73 | * The principle is roughly: |
74 | * Two decoders with the same ID can decode the same streams. | |
75 | * Two encoders with the same ID can encode compatible streams. | |
76 | * There may be slight deviations from the principle due to implementation | |
77 | * details. | |
7ebf5927 | 78 | * |
f5bccd85 DB |
79 | * If you add a codec ID to this list, add it so that |
80 | * 1. no value of a existing codec ID changes (that would break ABI), | |
81 | * 2. it is as close as possible to similar codecs. | |
7ebf5927 | 82 | */ |
de6d9b64 | 83 | enum CodecID { |
115329f1 | 84 | CODEC_ID_NONE, |
ba0dabbf DB |
85 | |
86 | /* video codecs */ | |
de6d9b64 | 87 | CODEC_ID_MPEG1VIDEO, |
0e373b95 | 88 | CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding |
fb364ada | 89 | CODEC_ID_MPEG2VIDEO_XVMC, |
c6148de2 | 90 | CODEC_ID_H261, |
de6d9b64 FB |
91 | CODEC_ID_H263, |
92 | CODEC_ID_RV10, | |
68b94c35 | 93 | CODEC_ID_RV20, |
de6d9b64 | 94 | CODEC_ID_MJPEG, |
b135d9fb | 95 | CODEC_ID_MJPEGB, |
b1e6b355 | 96 | CODEC_ID_LJPEG, |
5e83dec4 | 97 | CODEC_ID_SP5X, |
5639729b | 98 | CODEC_ID_JPEGLS, |
bf89e6b1 | 99 | CODEC_ID_MPEG4, |
de6d9b64 | 100 | CODEC_ID_RAWVIDEO, |
84afee34 MN |
101 | CODEC_ID_MSMPEG4V1, |
102 | CODEC_ID_MSMPEG4V2, | |
103 | CODEC_ID_MSMPEG4V3, | |
e1a9dbff | 104 | CODEC_ID_WMV1, |
b50eef3a | 105 | CODEC_ID_WMV2, |
de6d9b64 FB |
106 | CODEC_ID_H263P, |
107 | CODEC_ID_H263I, | |
d4f5d74a | 108 | CODEC_ID_FLV1, |
be8ffec9 | 109 | CODEC_ID_SVQ1, |
8b82a956 | 110 | CODEC_ID_SVQ3, |
020fcc94 | 111 | CODEC_ID_DVVIDEO, |
11f18faf | 112 | CODEC_ID_HUFFYUV, |
f70f7c6d | 113 | CODEC_ID_CYUV, |
0da71265 | 114 | CODEC_ID_H264, |
deabd4fd | 115 | CODEC_ID_INDEO3, |
d86053a4 | 116 | CODEC_ID_VP3, |
f44ee2c3 | 117 | CODEC_ID_THEORA, |
3d2e8cce | 118 | CODEC_ID_ASV1, |
9b56edf5 | 119 | CODEC_ID_ASV2, |
5e20f836 | 120 | CODEC_ID_FFV1, |
e2a7bb28 | 121 | CODEC_ID_4XM, |
be3564ed | 122 | CODEC_ID_VCR1, |
3aff069b | 123 | CODEC_ID_CLJR, |
c3bf0288 | 124 | CODEC_ID_MDEC, |
3ef8be2b MM |
125 | CODEC_ID_ROQ, |
126 | CODEC_ID_INTERPLAY_VIDEO, | |
9937e686 MM |
127 | CODEC_ID_XAN_WC3, |
128 | CODEC_ID_XAN_WC4, | |
2fdf638b MM |
129 | CODEC_ID_RPZA, |
130 | CODEC_ID_CINEPAK, | |
131 | CODEC_ID_WS_VQA, | |
132 | CODEC_ID_MSRLE, | |
133 | CODEC_ID_MSVIDEO1, | |
4120a53a | 134 | CODEC_ID_IDCIN, |
1dc1ed99 | 135 | CODEC_ID_8BPS, |
11e29a41 | 136 | CODEC_ID_SMC, |
42cad81a | 137 | CODEC_ID_FLIC, |
9a4117d5 | 138 | CODEC_ID_TRUEMOTION1, |
fafa0b75 | 139 | CODEC_ID_VMDVIDEO, |
a273bbfb RT |
140 | CODEC_ID_MSZH, |
141 | CODEC_ID_ZLIB, | |
070ed1bc | 142 | CODEC_ID_QTRLE, |
791e7b83 | 143 | CODEC_ID_SNOW, |
9d53d58e | 144 | CODEC_ID_TSCC, |
d0a0bbd2 | 145 | CODEC_ID_ULTI, |
d08d7142 | 146 | CODEC_ID_QDRAW, |
ab711b3c | 147 | CODEC_ID_VIXL, |
acfd8f0f | 148 | CODEC_ID_QPEG, |
17179d2d MN |
149 | CODEC_ID_PNG, |
150 | CODEC_ID_PPM, | |
151 | CODEC_ID_PBM, | |
152 | CODEC_ID_PGM, | |
153 | CODEC_ID_PGMYUV, | |
154 | CODEC_ID_PAM, | |
f37b9768 | 155 | CODEC_ID_FFVHUFF, |
3f05305d MN |
156 | CODEC_ID_RV30, |
157 | CODEC_ID_RV40, | |
10b9c374 | 158 | CODEC_ID_VC1, |
21aa398f | 159 | CODEC_ID_WMV3, |
9c7fb608 | 160 | CODEC_ID_LOCO, |
a8a15e9d | 161 | CODEC_ID_WNV1, |
589f8220 | 162 | CODEC_ID_AASC, |
856dbbff | 163 | CODEC_ID_INDEO2, |
b81f8949 | 164 | CODEC_ID_FRAPS, |
64af6168 | 165 | CODEC_ID_TRUEMOTION2, |
9fa62f2a | 166 | CODEC_ID_BMP, |
e0f80bd7 | 167 | CODEC_ID_CSCD, |
4e114829 | 168 | CODEC_ID_MMVIDEO, |
9c8d8e84 | 169 | CODEC_ID_ZMBV, |
26376701 | 170 | CODEC_ID_AVS, |
348efc18 | 171 | CODEC_ID_SMACKVIDEO, |
dfca23e3 | 172 | CODEC_ID_NUV, |
fd7b1991 | 173 | CODEC_ID_KMVC, |
0919e788 | 174 | CODEC_ID_FLASHSV, |
20ffddb9 | 175 | CODEC_ID_CAVS, |
f31065f6 | 176 | CODEC_ID_JPEG2000, |
eb57c889 | 177 | CODEC_ID_VMNC, |
5ce117c3 AJ |
178 | CODEC_ID_VP5, |
179 | CODEC_ID_VP6, | |
180 | CODEC_ID_VP6F, | |
3689cf16 | 181 | CODEC_ID_TARGA, |
72450e50 | 182 | CODEC_ID_DSICINVIDEO, |
29f86228 | 183 | CODEC_ID_TIERTEXSEQVIDEO, |
a991b1fe | 184 | CODEC_ID_TIFF, |
06d392a7 | 185 | CODEC_ID_GIF, |
33a0dd37 | 186 | CODEC_ID_DXA, |
52b6bad2 | 187 | CODEC_ID_DNXHD, |
efb0c399 | 188 | CODEC_ID_THP, |
2d99eed1 | 189 | CODEC_ID_SGI, |
9a0ddd09 | 190 | CODEC_ID_C93, |
1e6c6759 | 191 | CODEC_ID_BETHSOFTVID, |
b46d68c6 | 192 | CODEC_ID_PTX, |
1ca779e7 | 193 | CODEC_ID_TXD, |
91fc2cf1 | 194 | CODEC_ID_VP6A, |
8787d837 | 195 | CODEC_ID_AMV, |
66f7679c | 196 | CODEC_ID_VB, |
b4abe1d1 | 197 | CODEC_ID_PCX, |
d43df959 | 198 | CODEC_ID_SUNRAST, |
800b9c24 BL |
199 | CODEC_ID_INDEO4, |
200 | CODEC_ID_INDEO5, | |
a7129de5 | 201 | CODEC_ID_MIMIC, |
975cdc8f | 202 | CODEC_ID_RL2, |
40d26273 | 203 | CODEC_ID_ESCAPE124, |
782a58ec | 204 | CODEC_ID_DIRAC, |
b64c096b | 205 | CODEC_ID_BFI, |
495900f7 | 206 | CODEC_ID_CMV, |
974e0eee | 207 | CODEC_ID_MOTIONPIXELS, |
cfc78718 | 208 | CODEC_ID_TGV, |
42b30357 | 209 | CODEC_ID_TGQ, |
d8964f3a | 210 | CODEC_ID_TQI, |
c21fbefb KS |
211 | CODEC_ID_AURA, |
212 | CODEC_ID_AURA2, | |
97f92143 | 213 | CODEC_ID_V210X, |
a1fd2bc3 | 214 | CODEC_ID_TMV, |
ca0bb1c4 | 215 | CODEC_ID_V210, |
94d3d6a4 | 216 | CODEC_ID_DPX, |
c63ea92b | 217 | CODEC_ID_MAD, |
d8b35b85 | 218 | CODEC_ID_FRWU, |
0aa6a518 | 219 | CODEC_ID_FLASHSV2, |
a3d995c1 | 220 | CODEC_ID_CDGRAPHICS, |
4aaab0a3 | 221 | CODEC_ID_R210, |
a1ae40fd | 222 | CODEC_ID_ANM, |
4e5f42dd | 223 | CODEC_ID_BINKVIDEO, |
b9e06ddd PR |
224 | CODEC_ID_IFF_ILBM, |
225 | CODEC_ID_IFF_BYTERUN1, | |
bf354122 | 226 | CODEC_ID_KGV1, |
148bcae9 | 227 | CODEC_ID_YOP, |
a98c2dfa | 228 | CODEC_ID_VP8, |
a526d619 | 229 | CODEC_ID_PICTOR, |
beaa963c | 230 | CODEC_ID_ANSI, |
40c5ee99 TB |
231 | CODEC_ID_A64_MULTI, |
232 | CODEC_ID_A64_MULTI5, | |
43836928 | 233 | CODEC_ID_R10K, |
9d09ebf1 | 234 | CODEC_ID_MXPEG, |
d267b339 | 235 | CODEC_ID_LAGARITH, |
f5b82f45 | 236 | CODEC_ID_PRORES, |
0697440c | 237 | CODEC_ID_JV, |
42315dab | 238 | CODEC_ID_DFA, |
45ecda85 AD |
239 | CODEC_ID_WMV3IMAGE, |
240 | CODEC_ID_VC1IMAGE, | |
0d8506b8 | 241 | CODEC_ID_UTVIDEO, |
f545e006 | 242 | CODEC_ID_BMV_VIDEO, |
c433a3f9 | 243 | CODEC_ID_VBLE, |
19341c58 | 244 | CODEC_ID_DXTORY, |
80f6c0bb | 245 | CODEC_ID_V410, |
27ed027b | 246 | CODEC_ID_XWD, |
dc4e5748 | 247 | CODEC_ID_CDXL, |
40c5ee99 | 248 | |
f5bccd85 | 249 | /* various PCM "codecs" */ |
bca06e77 | 250 | CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs |
66760b30 | 251 | CODEC_ID_PCM_S16LE = 0x10000, |
a96b68b7 FB |
252 | CODEC_ID_PCM_S16BE, |
253 | CODEC_ID_PCM_U16LE, | |
254 | CODEC_ID_PCM_U16BE, | |
255 | CODEC_ID_PCM_S8, | |
256 | CODEC_ID_PCM_U8, | |
257 | CODEC_ID_PCM_MULAW, | |
258 | CODEC_ID_PCM_ALAW, | |
b461b3bc RD |
259 | CODEC_ID_PCM_S32LE, |
260 | CODEC_ID_PCM_S32BE, | |
261 | CODEC_ID_PCM_U32LE, | |
262 | CODEC_ID_PCM_U32BE, | |
263 | CODEC_ID_PCM_S24LE, | |
264 | CODEC_ID_PCM_S24BE, | |
265 | CODEC_ID_PCM_U24LE, | |
266 | CODEC_ID_PCM_U24BE, | |
267 | CODEC_ID_PCM_S24DAUD, | |
a11c2a2c | 268 | CODEC_ID_PCM_ZORK, |
725d86bf | 269 | CODEC_ID_PCM_S16LE_PLANAR, |
1472b7dd | 270 | CODEC_ID_PCM_DVD, |
aa29709e | 271 | CODEC_ID_PCM_F32BE, |
143a5d6f PR |
272 | CODEC_ID_PCM_F32LE, |
273 | CODEC_ID_PCM_F64BE, | |
274 | CODEC_ID_PCM_F64LE, | |
5dd3707b | 275 | CODEC_ID_PCM_BLURAY, |
fbeabfca | 276 | CODEC_ID_PCM_LXF, |
9aa91043 | 277 | CODEC_ID_S302M, |
f1f6d361 | 278 | CODEC_ID_PCM_S8_PLANAR, |
0147f198 | 279 | |
f5bccd85 | 280 | /* various ADPCM codecs */ |
66760b30 | 281 | CODEC_ID_ADPCM_IMA_QT = 0x11000, |
0147f198 | 282 | CODEC_ID_ADPCM_IMA_WAV, |
9937e686 MM |
283 | CODEC_ID_ADPCM_IMA_DK3, |
284 | CODEC_ID_ADPCM_IMA_DK4, | |
2fdf638b | 285 | CODEC_ID_ADPCM_IMA_WS, |
7d8379f2 | 286 | CODEC_ID_ADPCM_IMA_SMJPEG, |
0147f198 | 287 | CODEC_ID_ADPCM_MS, |
e2a7bb28 | 288 | CODEC_ID_ADPCM_4XM, |
fc384777 MM |
289 | CODEC_ID_ADPCM_XA, |
290 | CODEC_ID_ADPCM_ADX, | |
7d8379f2 | 291 | CODEC_ID_ADPCM_EA, |
e5966052 | 292 | CODEC_ID_ADPCM_G726, |
b3bfb299 | 293 | CODEC_ID_ADPCM_CT, |
659c3692 | 294 | CODEC_ID_ADPCM_SWF, |
2ff4524e | 295 | CODEC_ID_ADPCM_YAMAHA, |
2433f24f AJ |
296 | CODEC_ID_ADPCM_SBPRO_4, |
297 | CODEC_ID_ADPCM_SBPRO_3, | |
298 | CODEC_ID_ADPCM_SBPRO_2, | |
d1e0d21f | 299 | CODEC_ID_ADPCM_THP, |
3a7f5d07 | 300 | CODEC_ID_ADPCM_IMA_AMV, |
e7583962 PR |
301 | CODEC_ID_ADPCM_EA_R1, |
302 | CODEC_ID_ADPCM_EA_R3, | |
303 | CODEC_ID_ADPCM_EA_R2, | |
7bb65d89 | 304 | CODEC_ID_ADPCM_IMA_EA_SEAD, |
fac84d3c | 305 | CODEC_ID_ADPCM_IMA_EA_EACS, |
271b4095 | 306 | CODEC_ID_ADPCM_EA_XAS, |
861c63a2 | 307 | CODEC_ID_ADPCM_EA_MAXIS_XA, |
055dc116 | 308 | CODEC_ID_ADPCM_IMA_ISS, |
58e37eaf | 309 | CODEC_ID_ADPCM_G722, |
220506d2 | 310 | CODEC_ID_ADPCM_IMA_APC, |
891f64b3 | 311 | |
17179d2d | 312 | /* AMR */ |
66760b30 | 313 | CODEC_ID_AMR_NB = 0x12000, |
d663a1fd MN |
314 | CODEC_ID_AMR_WB, |
315 | ||
b8414bbd | 316 | /* RealAudio codecs*/ |
66760b30 | 317 | CODEC_ID_RA_144 = 0x13000, |
b8414bbd | 318 | CODEC_ID_RA_288, |
3ef8be2b MM |
319 | |
320 | /* various DPCM codecs */ | |
66760b30 | 321 | CODEC_ID_ROQ_DPCM = 0x14000, |
3ef8be2b | 322 | CODEC_ID_INTERPLAY_DPCM, |
9937e686 | 323 | CODEC_ID_XAN_DPCM, |
d08d7142 | 324 | CODEC_ID_SOL_DPCM, |
115329f1 | 325 | |
ba0dabbf | 326 | /* audio codecs */ |
66760b30 | 327 | CODEC_ID_MP2 = 0x15000, |
0e373b95 | 328 | CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3 |
17179d2d | 329 | CODEC_ID_AAC, |
17179d2d MN |
330 | CODEC_ID_AC3, |
331 | CODEC_ID_DTS, | |
332 | CODEC_ID_VORBIS, | |
333 | CODEC_ID_DVAUDIO, | |
334 | CODEC_ID_WMAV1, | |
335 | CODEC_ID_WMAV2, | |
336 | CODEC_ID_MACE3, | |
337 | CODEC_ID_MACE6, | |
338 | CODEC_ID_VMDAUDIO, | |
ac2570a8 | 339 | CODEC_ID_FLAC, |
1ede228a | 340 | CODEC_ID_MP3ADU, |
d2a7718d | 341 | CODEC_ID_MP3ON4, |
85ad5695 | 342 | CODEC_ID_SHORTEN, |
5df8a0c6 | 343 | CODEC_ID_ALAC, |
034eeaa1 | 344 | CODEC_ID_WESTWOOD_SND1, |
0e373b95 | 345 | CODEC_ID_GSM, ///< as in Berlin toast format |
d9b1c197 | 346 | CODEC_ID_QDM2, |
e0f7e329 | 347 | CODEC_ID_COOK, |
bf3027c8 | 348 | CODEC_ID_TRUESPEECH, |
a24c4a2a | 349 | CODEC_ID_TTA, |
348efc18 | 350 | CODEC_ID_SMACKAUDIO, |
6c496518 | 351 | CODEC_ID_QCELP, |
730581f3 | 352 | CODEC_ID_WAVPACK, |
72450e50 | 353 | CODEC_ID_DSICINAUDIO, |
84ed36da | 354 | CODEC_ID_IMC, |
185c7b6b | 355 | CODEC_ID_MUSEPACK7, |
aad512b4 | 356 | CODEC_ID_MLP, |
f5bccd85 | 357 | CODEC_ID_GSM_MS, /* as found in WAV */ |
10e26bc7 | 358 | CODEC_ID_ATRAC3, |
8950f828 | 359 | CODEC_ID_VOXWARE, |
bf4a1f17 | 360 | CODEC_ID_APE, |
636b13c5 | 361 | CODEC_ID_NELLYMOSER, |
12877faf | 362 | CODEC_ID_MUSEPACK8, |
cb4ddf77 | 363 | CODEC_ID_SPEEX, |
7bb8d51c BL |
364 | CODEC_ID_WMAVOICE, |
365 | CODEC_ID_WMAPRO, | |
800b9c24 | 366 | CODEC_ID_WMALOSSLESS, |
b339f0c6 | 367 | CODEC_ID_ATRAC3P, |
2988c93d | 368 | CODEC_ID_EAC3, |
faeedbbb | 369 | CODEC_ID_SIPR, |
7f507b2d | 370 | CODEC_ID_MP1, |
616e899c | 371 | CODEC_ID_TWINVQ, |
9ba4821d | 372 | CODEC_ID_TRUEHD, |
b24bbbb4 | 373 | CODEC_ID_MP4ALS, |
223e8df1 | 374 | CODEC_ID_ATRAC1, |
4e5f42dd DV |
375 | CODEC_ID_BINKAUDIO_RDFT, |
376 | CODEC_ID_BINKAUDIO_DCT, | |
136e19e1 | 377 | CODEC_ID_AAC_LATM, |
ed19fafd | 378 | CODEC_ID_QDMC, |
4ca59d19 | 379 | CODEC_ID_CELT, |
463ea05a DB |
380 | CODEC_ID_G723_1, |
381 | CODEC_ID_G729, | |
19900d60 KS |
382 | CODEC_ID_8SVX_EXP, |
383 | CODEC_ID_8SVX_FIB, | |
f545e006 | 384 | CODEC_ID_BMV_AUDIO, |
115329f1 | 385 | |
240c1657 | 386 | /* subtitle codecs */ |
bca06e77 | 387 | CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs. |
66760b30 | 388 | CODEC_ID_DVD_SUBTITLE = 0x17000, |
115329f1 | 389 | CODEC_ID_DVB_SUBTITLE, |
0e373b95 | 390 | CODEC_ID_TEXT, ///< raw UTF-8 text |
7e2643ae | 391 | CODEC_ID_XSUB, |
f9a9b350 | 392 | CODEC_ID_SSA, |
cc8c2c6a | 393 | CODEC_ID_MOV_TEXT, |
c58b82a2 | 394 | CODEC_ID_HDMV_PGS_SUBTITLE, |
e58992e4 | 395 | CODEC_ID_DVB_TELETEXT, |
ba2c508d | 396 | CODEC_ID_SRT, |
115329f1 | 397 | |
7ce68923 | 398 | /* other specific kind of codecs (generally used for attachments) */ |
bca06e77 | 399 | CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs. |
66760b30 | 400 | CODEC_ID_TTF = 0x18000, |
f8d7c9d3 | 401 | |
66760b30 | 402 | CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it |
0bef08e5 | 403 | |
66760b30 | 404 | CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS |
f5bccd85 | 405 | * stream (only used by libavformat) */ |
77b5c82b AC |
406 | CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems |
407 | * stream (only used by libavformat) */ | |
66760b30 | 408 | CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information. |
de6d9b64 | 409 | }; |
dcedf586 | 410 | |
0eea2129 | 411 | #if FF_API_OLD_DECODE_AUDIO |
de6d9b64 | 412 | /* in bytes */ |
8170e5fb | 413 | #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio |
0eea2129 | 414 | #endif |
de6d9b64 | 415 | |
d7425f59 | 416 | /** |
cf713bb8 | 417 | * Required number of additionally allocated bytes at the end of the input bitstream for decoding. |
171b7b91 AC |
418 | * This is mainly needed because some optimized bitstream readers read |
419 | * 32 or 64 bit at once and could read over the end.<br> | |
f5bccd85 DB |
420 | * Note: If the first 23 bits of the additional bytes are not 0, then damaged |
421 | * MPEG bitstreams could cause overread and segfault. | |
d7425f59 | 422 | */ |
171b7b91 | 423 | #define FF_INPUT_BUFFER_PADDING_SIZE 8 |
d7425f59 | 424 | |
0ecca7a4 | 425 | /** |
f5bccd85 DB |
426 | * minimum encoding buffer size |
427 | * Used to avoid some checks during header writing. | |
0ecca7a4 MN |
428 | */ |
429 | #define FF_MIN_BUFFER_SIZE 16384 | |
430 | ||
47146dfb | 431 | |
0e373b95 | 432 | /** |
bafc102b | 433 | * motion estimation type. |
0e373b95 | 434 | */ |
e4986da9 | 435 | enum Motion_Est_ID { |
9b4dd1b8 | 436 | ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed |
e4986da9 J |
437 | ME_FULL, |
438 | ME_LOG, | |
439 | ME_PHODS, | |
9b4dd1b8 MN |
440 | ME_EPZS, ///< enhanced predictive zonal search |
441 | ME_X1, ///< reserved for experiments | |
442 | ME_HEX, ///< hexagon based search | |
443 | ME_UMH, ///< uneven multi-hexagon search | |
444 | ME_ITER, ///< iterative search | |
359bbdab | 445 | ME_TESA, ///< transformed exhaustive search algorithm |
e4986da9 J |
446 | }; |
447 | ||
8c3eba7c | 448 | enum AVDiscard{ |
f5bccd85 DB |
449 | /* We leave some space between them for extensions (drop some |
450 | * keyframes for intra-only or drop just some bidir frames). */ | |
8c3eba7c MN |
451 | AVDISCARD_NONE =-16, ///< discard nothing |
452 | AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi | |
453 | AVDISCARD_NONREF = 8, ///< discard all non reference | |
454 | AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames | |
455 | AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes | |
456 | AVDISCARD_ALL = 48, ///< discard all | |
457 | }; | |
458 | ||
4ee6a5c1 MN |
459 | enum AVColorPrimaries{ |
460 | AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B | |
461 | AVCOL_PRI_UNSPECIFIED=2, | |
462 | AVCOL_PRI_BT470M =4, | |
463 | AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM | |
464 | AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC | |
465 | AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above | |
466 | AVCOL_PRI_FILM =8, | |
467 | AVCOL_PRI_NB , ///< Not part of ABI | |
468 | }; | |
469 | ||
470 | enum AVColorTransferCharacteristic{ | |
471 | AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361 | |
472 | AVCOL_TRC_UNSPECIFIED=2, | |
473 | AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM | |
474 | AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG | |
475 | AVCOL_TRC_NB , ///< Not part of ABI | |
476 | }; | |
477 | ||
478 | enum AVColorSpace{ | |
479 | AVCOL_SPC_RGB =0, | |
480 | AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B | |
481 | AVCOL_SPC_UNSPECIFIED=2, | |
482 | AVCOL_SPC_FCC =4, | |
483 | AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601 | |
484 | AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above | |
485 | AVCOL_SPC_SMPTE240M =7, | |
486 | AVCOL_SPC_NB , ///< Not part of ABI | |
487 | }; | |
488 | ||
489 | enum AVColorRange{ | |
490 | AVCOL_RANGE_UNSPECIFIED=0, | |
491 | AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges | |
492 | AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges | |
493 | AVCOL_RANGE_NB , ///< Not part of ABI | |
494 | }; | |
495 | ||
580a7465 DC |
496 | /** |
497 | * X X 3 4 X X are luma samples, | |
498 | * 1 2 1-6 are possible chroma positions | |
499 | * X X 5 6 X 0 is undefined/unknown position | |
500 | */ | |
501 | enum AVChromaLocation{ | |
502 | AVCHROMA_LOC_UNSPECIFIED=0, | |
503 | AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default | |
504 | AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263 | |
505 | AVCHROMA_LOC_TOPLEFT =3, ///< DV | |
506 | AVCHROMA_LOC_TOP =4, | |
507 | AVCHROMA_LOC_BOTTOMLEFT =5, | |
508 | AVCHROMA_LOC_BOTTOM =6, | |
509 | AVCHROMA_LOC_NB , ///< Not part of ABI | |
510 | }; | |
511 | ||
34b47d7c JR |
512 | enum AVAudioServiceType { |
513 | AV_AUDIO_SERVICE_TYPE_MAIN = 0, | |
514 | AV_AUDIO_SERVICE_TYPE_EFFECTS = 1, | |
515 | AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2, | |
516 | AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3, | |
517 | AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4, | |
518 | AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5, | |
519 | AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6, | |
520 | AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7, | |
521 | AV_AUDIO_SERVICE_TYPE_KARAOKE = 8, | |
522 | AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI | |
523 | }; | |
524 | ||
ce980a95 MN |
525 | typedef struct RcOverride{ |
526 | int start_frame; | |
527 | int end_frame; | |
f5bccd85 | 528 | int qscale; // If this is 0 then quality_factor will be used instead. |
ce980a95 MN |
529 | float quality_factor; |
530 | } RcOverride; | |
531 | ||
b0ec9efd | 532 | #define FF_MAX_B_FRAMES 16 |
9dbcbd92 | 533 | |
a949d72e | 534 | /* encoding support |
f5bccd85 DB |
535 | These flags can be passed in AVCodecContext.flags before initialization. |
536 | Note: Not everything is supported yet. | |
a949d72e | 537 | */ |
de6d9b64 | 538 | |
f5bccd85 DB |
539 | #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale. |
540 | #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263. | |
541 | #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC. | |
542 | #define CODEC_FLAG_GMC 0x0020 ///< Use GMC. | |
543 | #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>. | |
1ba8f5eb MN |
544 | /** |
545 | * The parent program guarantees that the input for B-frames containing | |
f5bccd85 | 546 | * streams is not written to for at least s->max_b_frames+1 frames, if |
1ba8f5eb MN |
547 | * this is not set the input will be copied. |
548 | */ | |
8b4c7dbc | 549 | #define CODEC_FLAG_INPUT_PRESERVED 0x0100 |
273b0cd3 DB |
550 | #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode. |
551 | #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode. | |
273b0cd3 DB |
552 | #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale. |
553 | #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges. | |
554 | #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding. | |
555 | #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random | |
556 | location instead of only at frame boundaries. */ | |
f5bccd85 DB |
557 | #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization. |
558 | #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT. | |
559 | #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay. | |
f5bccd85 DB |
560 | #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe. |
561 | #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT). | |
21e59552 | 562 | /* Fx : Flag for h263+ extra options */ |
f5bccd85 | 563 | #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction |
f5bccd85 DB |
564 | #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp. |
565 | #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon. | |
332f9ac4 | 566 | #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter |
bb198e19 | 567 | #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation |
f3eec1cf | 568 | #define CODEC_FLAG_CLOSED_GOP 0x80000000 |
f5bccd85 DB |
569 | #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks. |
570 | #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size. | |
571 | #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding. | |
572 | #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata. | |
f013cb81 AK |
573 | #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping |
574 | #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries. | |
6fc5b059 | 575 | |
21e59552 | 576 | /* Unsupported options : |
bb270c08 DB |
577 | * Syntax Arithmetic coding (SAC) |
578 | * Reference Picture Selection | |
eafcac6a | 579 | * Independent Segment Decoding */ |
21e59552 | 580 | /* /Fx */ |
bf89e6b1 FB |
581 | /* codec capabilities */ |
582 | ||
f5bccd85 | 583 | #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback. |
6814a25c | 584 | /** |
9b489e02 RD |
585 | * Codec uses get_buffer() for allocating buffers and supports custom allocators. |
586 | * If not set, it might not use get_buffer() at all or use operations that | |
587 | * assume the buffer was allocated by avcodec_default_get_buffer. | |
6814a25c MN |
588 | */ |
589 | #define CODEC_CAP_DR1 0x0002 | |
d7425f59 | 590 | #define CODEC_CAP_TRUNCATED 0x0008 |
f5bccd85 | 591 | /* Codec can export data for HW decoding (XvMC). */ |
5e5c247a | 592 | #define CODEC_CAP_HWACCEL 0x0010 |
115329f1 | 593 | /** |
3f6aa85e JR |
594 | * Encoder or decoder requires flushing with NULL input at the end in order to |
595 | * give the complete and correct output. | |
596 | * | |
597 | * NOTE: If this flag is not set, the codec is guaranteed to never be fed with | |
598 | * with NULL data. The user can still send NULL data to the public encode | |
599 | * or decode function, but libavcodec will not pass it along to the codec | |
600 | * unless this flag is set. | |
601 | * | |
602 | * Decoders: | |
603 | * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL, | |
ffeeae92 | 604 | * avpkt->size=0 at the end to get the delayed data until the decoder no longer |
3f6aa85e JR |
605 | * returns frames. |
606 | * | |
607 | * Encoders: | |
608 | * The encoder needs to be fed with NULL data at the end of encoding until the | |
609 | * encoder no longer returns data. | |
b2c75b6e JR |
610 | * |
611 | * NOTE: For encoders implementing the AVCodec.encode2() function, setting this | |
612 | * flag also means that the encoder must set the pts and duration for | |
613 | * each output packet. If this flag is not set, the pts and duration will | |
614 | * be determined by libavcodec from the input frame. | |
934982c4 | 615 | */ |
6f824977 | 616 | #define CODEC_CAP_DELAY 0x0020 |
cef7cc72 JR |
617 | /** |
618 | * Codec can be fed a final frame with a smaller size. | |
619 | * This can be used to prevent truncation of the last audio samples. | |
620 | */ | |
621 | #define CODEC_CAP_SMALL_LAST_FRAME 0x0040 | |
369122dd NC |
622 | /** |
623 | * Codec can export data for HW decoding (VDPAU). | |
624 | */ | |
625 | #define CODEC_CAP_HWACCEL_VDPAU 0x0080 | |
d859bb1d SS |
626 | /** |
627 | * Codec can output multiple frames per AVPacket | |
e9e949cf MN |
628 | * Normally demuxers return one frame at a time, demuxers which do not do |
629 | * are connected to a parser to split what they return into proper frames. | |
630 | * This flag is reserved to the very rare category of codecs which have a | |
631 | * bitstream that cannot be split into frames without timeconsuming | |
632 | * operations like full decoding. Demuxers carring such bitstreams thus | |
633 | * may return multiple frames in a packet. This has many disadvantages like | |
634 | * prohibiting stream copy in many cases thus it should only be considered | |
635 | * as a last resort. | |
d859bb1d SS |
636 | */ |
637 | #define CODEC_CAP_SUBFRAMES 0x0100 | |
93ebfeea JG |
638 | /** |
639 | * Codec is experimental and is thus avoided in favor of non experimental | |
640 | * encoders | |
641 | */ | |
642 | #define CODEC_CAP_EXPERIMENTAL 0x0200 | |
62784e37 BL |
643 | /** |
644 | * Codec should fill in channel configuration and samplerate instead of container | |
645 | */ | |
646 | #define CODEC_CAP_CHANNEL_CONF 0x0400 | |
16cfc961 SS |
647 | /** |
648 | * Codec is able to deal with negative linesizes | |
649 | */ | |
650 | #define CODEC_CAP_NEG_LINESIZES 0x0800 | |
37b00b47 AS |
651 | /** |
652 | * Codec supports frame-level multithreading. | |
653 | */ | |
654 | #define CODEC_CAP_FRAME_THREADS 0x1000 | |
94f7451a RB |
655 | /** |
656 | * Codec supports slice-based (or partition-based) multithreading. | |
657 | */ | |
658 | #define CODEC_CAP_SLICE_THREADS 0x2000 | |
fe75dc85 MS |
659 | /** |
660 | * Codec supports changed parameters at any point. | |
661 | */ | |
662 | #define CODEC_CAP_PARAM_CHANGE 0x4000 | |
b4d44a45 JG |
663 | /** |
664 | * Codec supports avctx->thread_count == 0 (auto). | |
665 | */ | |
666 | #define CODEC_CAP_AUTO_THREADS 0x8000 | |
b2c75b6e JR |
667 | /** |
668 | * Audio encoder supports receiving a different number of samples in each call. | |
669 | */ | |
670 | #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000 | |
bf89e6b1 | 671 | |
f5bccd85 | 672 | //The following defines may change, don't expect compatibility if you use them. |
8d7ec294 | 673 | #define MB_TYPE_INTRA4x4 0x0001 |
f5bccd85 DB |
674 | #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific |
675 | #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific | |
8d7ec294 WH |
676 | #define MB_TYPE_16x16 0x0008 |
677 | #define MB_TYPE_16x8 0x0010 | |
678 | #define MB_TYPE_8x16 0x0020 | |
679 | #define MB_TYPE_8x8 0x0040 | |
680 | #define MB_TYPE_INTERLACED 0x0080 | |
273b0cd3 | 681 | #define MB_TYPE_DIRECT2 0x0100 //FIXME |
8d7ec294 WH |
682 | #define MB_TYPE_ACPRED 0x0200 |
683 | #define MB_TYPE_GMC 0x0400 | |
684 | #define MB_TYPE_SKIP 0x0800 | |
685 | #define MB_TYPE_P0L0 0x1000 | |
686 | #define MB_TYPE_P1L0 0x2000 | |
687 | #define MB_TYPE_P0L1 0x4000 | |
688 | #define MB_TYPE_P1L1 0x8000 | |
689 | #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0) | |
690 | #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1) | |
691 | #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1) | |
692 | #define MB_TYPE_QUANT 0x00010000 | |
693 | #define MB_TYPE_CBP 0x00020000 | |
694 | //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...) | |
695 | ||
fa384dcc MN |
696 | /** |
697 | * Pan Scan area. | |
f5bccd85 DB |
698 | * This specifies the area which should be displayed. |
699 | * Note there may be multiple such areas for one frame. | |
fa384dcc MN |
700 | */ |
701 | typedef struct AVPanScan{ | |
702 | /** | |
f5bccd85 DB |
703 | * id |
704 | * - encoding: Set by user. | |
705 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
706 | */ |
707 | int id; | |
708 | ||
709 | /** | |
710 | * width and height in 1/16 pel | |
f5bccd85 DB |
711 | * - encoding: Set by user. |
712 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
713 | */ |
714 | int width; | |
715 | int height; | |
716 | ||
717 | /** | |
f5bccd85 DB |
718 | * position of the top left corner in 1/16 pel for up to 3 fields/frames |
719 | * - encoding: Set by user. | |
720 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
721 | */ |
722 | int16_t position[3][2]; | |
723 | }AVPanScan; | |
724 | ||
bb270c08 DB |
725 | #define FF_QSCALE_TYPE_MPEG1 0 |
726 | #define FF_QSCALE_TYPE_MPEG2 1 | |
727 | #define FF_QSCALE_TYPE_H264 2 | |
800274f8 | 728 | #define FF_QSCALE_TYPE_VP56 3 |
4e00e76b MN |
729 | |
730 | #define FF_BUFFER_TYPE_INTERNAL 1 | |
f5bccd85 DB |
731 | #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user) |
732 | #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared. | |
733 | #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything. | |
4e00e76b | 734 | |
f5bccd85 DB |
735 | #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore). |
736 | #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer. | |
737 | #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content. | |
738 | #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update). | |
074c4ca7 | 739 | |
4de339e2 KS |
740 | enum AVPacketSideDataType { |
741 | AV_PKT_DATA_PALETTE, | |
195c123c | 742 | AV_PKT_DATA_NEW_EXTRADATA, |
fe75dc85 | 743 | AV_PKT_DATA_PARAM_CHANGE, |
4de339e2 KS |
744 | }; |
745 | ||
18c915ee TB |
746 | typedef struct AVPacket { |
747 | /** | |
7b356d39 RS |
748 | * Presentation timestamp in AVStream->time_base units; the time at which |
749 | * the decompressed packet will be presented to the user. | |
18c915ee TB |
750 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
751 | * pts MUST be larger or equal to dts as presentation cannot happen before | |
752 | * decompression, unless one wants to view hex dumps. Some formats misuse | |
753 | * the terms dts and pts/cts to mean something different. Such timestamps | |
754 | * must be converted to true pts/dts before they are stored in AVPacket. | |
755 | */ | |
756 | int64_t pts; | |
757 | /** | |
7b356d39 RS |
758 | * Decompression timestamp in AVStream->time_base units; the time at which |
759 | * the packet is decompressed. | |
18c915ee TB |
760 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
761 | */ | |
762 | int64_t dts; | |
763 | uint8_t *data; | |
764 | int size; | |
765 | int stream_index; | |
9d39cbf6 LB |
766 | /** |
767 | * A combination of AV_PKT_FLAG values | |
768 | */ | |
18c915ee TB |
769 | int flags; |
770 | /** | |
4de339e2 KS |
771 | * Additional packet data that can be provided by the container. |
772 | * Packet can contain several types of side information. | |
773 | */ | |
774 | struct { | |
775 | uint8_t *data; | |
776 | int size; | |
777 | enum AVPacketSideDataType type; | |
778 | } *side_data; | |
779 | int side_data_elems; | |
780 | ||
781 | /** | |
7b356d39 | 782 | * Duration of this packet in AVStream->time_base units, 0 if unknown. |
18c915ee TB |
783 | * Equals next_pts - this_pts in presentation order. |
784 | */ | |
785 | int duration; | |
786 | void (*destruct)(struct AVPacket *); | |
787 | void *priv; | |
788 | int64_t pos; ///< byte position in stream, -1 if unknown | |
789 | ||
790 | /** | |
7b356d39 | 791 | * Time difference in AVStream->time_base units from the pts of this |
18c915ee TB |
792 | * packet to the point at which the output from the decoder has converged |
793 | * independent from the availability of previous frames. That is, the | |
794 | * frames are virtually identical no matter if decoding started from | |
795 | * the very first frame or from this keyframe. | |
796 | * Is AV_NOPTS_VALUE if unknown. | |
797 | * This field is not the display duration of the current packet. | |
8ee82f40 AJ |
798 | * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY |
799 | * set. | |
18c915ee TB |
800 | * |
801 | * The purpose of this field is to allow seeking in streams that have no | |
802 | * keyframes in the conventional sense. It corresponds to the | |
803 | * recovery point SEI in H.264 and match_time_delta in NUT. It is also | |
804 | * essential for some types of subtitle streams to ensure that all | |
805 | * subtitles are correctly displayed after seeking. | |
806 | */ | |
807 | int64_t convergence_duration; | |
808 | } AVPacket; | |
9d39cbf6 LB |
809 | #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe |
810 | #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted | |
18c915ee | 811 | |
0da71265 | 812 | /** |
fe75dc85 MS |
813 | * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows: |
814 | * u32le param_flags | |
815 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) | |
816 | * s32le channel_count | |
817 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) | |
818 | * u64le channel_layout | |
819 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) | |
820 | * s32le sample_rate | |
821 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) | |
822 | * s32le width | |
823 | * s32le height | |
824 | */ | |
825 | ||
826 | enum AVSideDataParamChangeFlags { | |
827 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001, | |
828 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002, | |
829 | AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004, | |
830 | AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008, | |
831 | }; | |
832 | ||
833 | /** | |
0da71265 | 834 | * Audio Video Frame. |
657ccb5a DB |
835 | * New fields can be added to the end of AVFRAME with minor version |
836 | * bumps. Removal, reordering and changes to existing fields require | |
837 | * a major version bump. | |
8bfb108b | 838 | * sizeof(AVFrame) must not be used outside libav*. |
0da71265 | 839 | */ |
492cd3a9 | 840 | typedef struct AVFrame { |
560f773c | 841 | #define AV_NUM_DATA_POINTERS 8 |
657ccb5a | 842 | /** |
0eea2129 | 843 | * pointer to the picture/channel planes. |
657ccb5a | 844 | * This might be different from the first allocated byte |
0eea2129 JR |
845 | * - encoding: Set by user |
846 | * - decoding: set by AVCodecContext.get_buffer() | |
657ccb5a | 847 | */ |
560f773c | 848 | uint8_t *data[AV_NUM_DATA_POINTERS]; |
0eea2129 JR |
849 | |
850 | /** | |
851 | * Size, in bytes, of the data for each picture/channel plane. | |
852 | * | |
853 | * For audio, only linesize[0] may be set. For planar audio, each channel | |
854 | * plane must be the same size. | |
855 | * | |
9814974d | 856 | * - encoding: Set by user |
0eea2129 JR |
857 | * - decoding: set by AVCodecContext.get_buffer() |
858 | */ | |
560f773c | 859 | int linesize[AV_NUM_DATA_POINTERS]; |
0eea2129 | 860 | |
657ccb5a | 861 | /** |
1d428004 AK |
862 | * pointers to the data planes/channels. |
863 | * | |
864 | * For video, this should simply point to data[]. | |
865 | * | |
866 | * For planar audio, each channel has a separate data pointer, and | |
867 | * linesize[0] contains the size of each channel buffer. | |
868 | * For packed audio, there is just one data pointer, and linesize[0] | |
869 | * contains the total size of the buffer for all channels. | |
870 | * | |
871 | * Note: Both data and extended_data will always be set by get_buffer(), | |
872 | * but for planar audio with more channels that can fit in data, | |
873 | * extended_data must be used by the decoder in order to access all | |
874 | * channels. | |
875 | * | |
876 | * encoding: unused | |
877 | * decoding: set by AVCodecContext.get_buffer() | |
657ccb5a | 878 | */ |
1d428004 AK |
879 | uint8_t **extended_data; |
880 | ||
881 | /** | |
882 | * width and height of the video frame | |
883 | * - encoding: unused | |
884 | * - decoding: Read by user. | |
885 | */ | |
886 | int width, height; | |
887 | ||
888 | /** | |
889 | * number of audio samples (per channel) described by this frame | |
890 | * - encoding: Set by user | |
891 | * - decoding: Set by libavcodec | |
892 | */ | |
893 | int nb_samples; | |
894 | ||
895 | /** | |
896 | * format of the frame, -1 if unknown or unset | |
897 | * Values correspond to enum PixelFormat for video frames, | |
898 | * enum AVSampleFormat for audio) | |
899 | * - encoding: unused | |
900 | * - decoding: Read by user. | |
901 | */ | |
902 | int format; | |
903 | ||
657ccb5a DB |
904 | /** |
905 | * 1 -> keyframe, 0-> not | |
906 | * - encoding: Set by libavcodec. | |
907 | * - decoding: Set by libavcodec. | |
908 | */ | |
909 | int key_frame; | |
910 | ||
911 | /** | |
912 | * Picture type of the frame, see ?_TYPE below. | |
913 | * - encoding: Set by libavcodec. for coded_picture (and set by user for input). | |
914 | * - decoding: Set by libavcodec. | |
915 | */ | |
916 | enum AVPictureType pict_type; | |
917 | ||
918 | /** | |
1d428004 AK |
919 | * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer. |
920 | * This isn't used by libavcodec unless the default get/release_buffer() is used. | |
921 | * - encoding: | |
922 | * - decoding: | |
923 | */ | |
924 | uint8_t *base[AV_NUM_DATA_POINTERS]; | |
925 | ||
926 | /** | |
927 | * sample aspect ratio for the video frame, 0/1 if unknown\unspecified | |
928 | * - encoding: unused | |
929 | * - decoding: Read by user. | |
930 | */ | |
931 | AVRational sample_aspect_ratio; | |
932 | ||
933 | /** | |
657ccb5a DB |
934 | * presentation timestamp in time_base units (time when frame should be shown to user) |
935 | * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed. | |
936 | * - encoding: MUST be set by user. | |
937 | * - decoding: Set by libavcodec. | |
938 | */ | |
939 | int64_t pts; | |
940 | ||
941 | /** | |
1d428004 AK |
942 | * reordered pts from the last AVPacket that has been input into the decoder |
943 | * - encoding: unused | |
944 | * - decoding: Read by user. | |
945 | */ | |
946 | int64_t pkt_pts; | |
947 | ||
948 | /** | |
949 | * dts from the last AVPacket that has been input into the decoder | |
950 | * - encoding: unused | |
951 | * - decoding: Read by user. | |
952 | */ | |
953 | int64_t pkt_dts; | |
954 | ||
955 | /** | |
657ccb5a DB |
956 | * picture number in bitstream order |
957 | * - encoding: set by | |
958 | * - decoding: Set by libavcodec. | |
959 | */ | |
960 | int coded_picture_number; | |
961 | /** | |
962 | * picture number in display order | |
963 | * - encoding: set by | |
964 | * - decoding: Set by libavcodec. | |
965 | */ | |
966 | int display_picture_number; | |
967 | ||
968 | /** | |
969 | * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) | |
970 | * - encoding: Set by libavcodec. for coded_picture (and set by user for input). | |
971 | * - decoding: Set by libavcodec. | |
972 | */ | |
973 | int quality; | |
974 | ||
657ccb5a DB |
975 | /** |
976 | * is this picture used as reference | |
977 | * The values for this are the same as the MpegEncContext.picture_structure | |
978 | * variable, that is 1->top field, 2->bottom field, 3->frame/both fields. | |
979 | * Set to 4 for delayed, non-reference frames. | |
980 | * - encoding: unused | |
981 | * - decoding: Set by libavcodec. (before get_buffer() call)). | |
982 | */ | |
983 | int reference; | |
984 | ||
985 | /** | |
986 | * QP table | |
987 | * - encoding: unused | |
988 | * - decoding: Set by libavcodec. | |
989 | */ | |
990 | int8_t *qscale_table; | |
991 | /** | |
992 | * QP store stride | |
993 | * - encoding: unused | |
994 | * - decoding: Set by libavcodec. | |
995 | */ | |
996 | int qstride; | |
997 | ||
998 | /** | |
1d428004 AK |
999 | * |
1000 | */ | |
1001 | int qscale_type; | |
1002 | ||
1003 | /** | |
657ccb5a DB |
1004 | * mbskip_table[mb]>=1 if MB didn't change |
1005 | * stride= mb_width = (width+15)>>4 | |
1006 | * - encoding: unused | |
1007 | * - decoding: Set by libavcodec. | |
1008 | */ | |
1009 | uint8_t *mbskip_table; | |
1010 | ||
1011 | /** | |
1012 | * motion vector table | |
1013 | * @code | |
1014 | * example: | |
1015 | * int mv_sample_log2= 4 - motion_subsample_log2; | |
1016 | * int mb_width= (width+15)>>4; | |
1017 | * int mv_stride= (mb_width << mv_sample_log2) + 1; | |
1018 | * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y]; | |
1019 | * @endcode | |
1020 | * - encoding: Set by user. | |
1021 | * - decoding: Set by libavcodec. | |
1022 | */ | |
1023 | int16_t (*motion_val[2])[2]; | |
1024 | ||
1025 | /** | |
1026 | * macroblock type table | |
1027 | * mb_type_base + mb_width + 2 | |
1028 | * - encoding: Set by user. | |
1029 | * - decoding: Set by libavcodec. | |
1030 | */ | |
1031 | uint32_t *mb_type; | |
1032 | ||
1033 | /** | |
1d428004 | 1034 | * DCT coefficients |
657ccb5a DB |
1035 | * - encoding: unused |
1036 | * - decoding: Set by libavcodec. | |
1037 | */ | |
1d428004 AK |
1038 | short *dct_coeff; |
1039 | ||
1040 | /** | |
1041 | * motion reference frame index | |
1042 | * the order in which these are stored can depend on the codec. | |
1043 | * - encoding: Set by user. | |
1044 | * - decoding: Set by libavcodec. | |
1045 | */ | |
1046 | int8_t *ref_index[2]; | |
657ccb5a DB |
1047 | |
1048 | /** | |
1049 | * for some private data of the user | |
1050 | * - encoding: unused | |
1051 | * - decoding: Set by user. | |
1052 | */ | |
1053 | void *opaque; | |
1054 | ||
1055 | /** | |
1056 | * error | |
1057 | * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR. | |
1058 | * - decoding: unused | |
1059 | */ | |
560f773c | 1060 | uint64_t error[AV_NUM_DATA_POINTERS]; |
657ccb5a DB |
1061 | |
1062 | /** | |
1063 | * type of the buffer (to keep track of who has to deallocate data[*]) | |
1064 | * - encoding: Set by the one who allocates it. | |
1065 | * - decoding: Set by the one who allocates it. | |
1066 | * Note: User allocated (direct rendering) & internal buffers cannot coexist currently. | |
1067 | */ | |
1068 | int type; | |
1069 | ||
1070 | /** | |
1071 | * When decoding, this signals how much the picture must be delayed. | |
1072 | * extra_delay = repeat_pict / (2*fps) | |
1073 | * - encoding: unused | |
1074 | * - decoding: Set by libavcodec. | |
1075 | */ | |
1076 | int repeat_pict; | |
1077 | ||
1078 | /** | |
657ccb5a DB |
1079 | * The content of the picture is interlaced. |
1080 | * - encoding: Set by user. | |
1081 | * - decoding: Set by libavcodec. (default 0) | |
1082 | */ | |
1083 | int interlaced_frame; | |
1084 | ||
1085 | /** | |
1086 | * If the content is interlaced, is top field displayed first. | |
1087 | * - encoding: Set by user. | |
1088 | * - decoding: Set by libavcodec. | |
1089 | */ | |
1090 | int top_field_first; | |
1091 | ||
1092 | /** | |
657ccb5a DB |
1093 | * Tell user application that palette has changed from previous frame. |
1094 | * - encoding: ??? (no palette-enabled encoder yet) | |
1095 | * - decoding: Set by libavcodec. (default 0). | |
1096 | */ | |
1097 | int palette_has_changed; | |
1098 | ||
1099 | /** | |
1100 | * codec suggestion on buffer type if != 0 | |
1101 | * - encoding: unused | |
1102 | * - decoding: Set by libavcodec. (before get_buffer() call)). | |
1103 | */ | |
1104 | int buffer_hints; | |
1105 | ||
1106 | /** | |
1d428004 | 1107 | * Pan scan. |
657ccb5a DB |
1108 | * - encoding: Set by user. |
1109 | * - decoding: Set by libavcodec. | |
1110 | */ | |
1d428004 | 1111 | AVPanScan *pan_scan; |
657ccb5a DB |
1112 | |
1113 | /** | |
1114 | * reordered opaque 64bit (generally an integer or a double precision float | |
1115 | * PTS but can be anything). | |
1116 | * The user sets AVCodecContext.reordered_opaque to represent the input at | |
1117 | * that time, | |
1118 | * the decoder reorders values as needed and sets AVFrame.reordered_opaque | |
1119 | * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque | |
1120 | * @deprecated in favor of pkt_pts | |
1121 | * - encoding: unused | |
1122 | * - decoding: Read by user. | |
1123 | */ | |
1124 | int64_t reordered_opaque; | |
1125 | ||
1126 | /** | |
1127 | * hardware accelerator private data (Libav-allocated) | |
1128 | * - encoding: unused | |
1129 | * - decoding: Set by libavcodec | |
1130 | */ | |
1131 | void *hwaccel_picture_private; | |
1132 | ||
1133 | /** | |
657ccb5a DB |
1134 | * the AVCodecContext which ff_thread_get_buffer() was last called on |
1135 | * - encoding: Set by libavcodec. | |
1136 | * - decoding: Set by libavcodec. | |
1137 | */ | |
1138 | struct AVCodecContext *owner; | |
1139 | ||
1140 | /** | |
1141 | * used by multithreading to store frame-specific info | |
1142 | * - encoding: Set by libavcodec. | |
1143 | * - decoding: Set by libavcodec. | |
1144 | */ | |
1145 | void *thread_opaque; | |
0eea2129 JR |
1146 | |
1147 | /** | |
1d428004 AK |
1148 | * log2 of the size of the block which a single vector in motion_val represents: |
1149 | * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2) | |
8a4a5f6f | 1150 | * - encoding: unused |
1d428004 | 1151 | * - decoding: Set by libavcodec. |
8a4a5f6f | 1152 | */ |
1d428004 | 1153 | uint8_t motion_subsample_log2; |
492cd3a9 | 1154 | } AVFrame; |
1e491e29 | 1155 | |
f3a29b75 JR |
1156 | struct AVCodecInternal; |
1157 | ||
4bf3c8f2 AC |
1158 | enum AVFieldOrder { |
1159 | AV_FIELD_UNKNOWN, | |
1160 | AV_FIELD_PROGRESSIVE, | |
1161 | AV_FIELD_TT, //< Top coded_first, top displayed first | |
1162 | AV_FIELD_BB, //< Bottom coded first, bottom displayed first | |
1163 | AV_FIELD_TB, //< Top coded first, bottom displayed first | |
1164 | AV_FIELD_BT, //< Bottom coded first, top displayed first | |
1165 | }; | |
1166 | ||
d33c949c | 1167 | /** |
252f17e2 MN |
1168 | * main external API structure. |
1169 | * New fields can be added to the end with minor version bumps. | |
8bfb108b | 1170 | * Removal, reordering and changes to existing fields require a major |
252f17e2 | 1171 | * version bump. |
8bfb108b | 1172 | * sizeof(AVCodecContext) must not be used outside libav*. |
d33c949c | 1173 | */ |
de6d9b64 | 1174 | typedef struct AVCodecContext { |
b71901e6 | 1175 | /** |
f5bccd85 | 1176 | * information on struct for av_log |
488eec10 | 1177 | * - set by avcodec_alloc_context3 |
bc874dae | 1178 | */ |
d42a814e | 1179 | const AVClass *av_class; |
bc874dae | 1180 | /** |
f5bccd85 DB |
1181 | * the average bitrate |
1182 | * - encoding: Set by user; unused for constant quantizer encoding. | |
1183 | * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream. | |
b71901e6 | 1184 | */ |
de6d9b64 | 1185 | int bit_rate; |
b71901e6 MN |
1186 | |
1187 | /** | |
64863965 | 1188 | * number of bits the bitstream is allowed to diverge from the reference. |
b71901e6 | 1189 | * the reference can be CBR (for CBR pass1) or VBR (for pass2) |
f5bccd85 | 1190 | * - encoding: Set by user; unused for constant quantizer encoding. |
64863965 | 1191 | * - decoding: unused |
b71901e6 | 1192 | */ |
115329f1 | 1193 | int bit_rate_tolerance; |
b71901e6 MN |
1194 | |
1195 | /** | |
64863965 | 1196 | * CODEC_FLAG_*. |
f5bccd85 DB |
1197 | * - encoding: Set by user. |
1198 | * - decoding: Set by user. | |
b71901e6 | 1199 | */ |
de6d9b64 | 1200 | int flags; |
b71901e6 MN |
1201 | |
1202 | /** | |
f5bccd85 DB |
1203 | * Some codecs need additional format info. It is stored here. |
1204 | * If any muxer uses this then ALL demuxers/parsers AND encoders for the | |
1205 | * specific codec MUST set it correctly otherwise stream copy breaks. | |
da9cea77 | 1206 | * In general use of this field by muxers is not recommended. |
f5bccd85 DB |
1207 | * - encoding: Set by libavcodec. |
1208 | * - decoding: Set by libavcodec. (FIXME: Is this OK?) | |
b71901e6 MN |
1209 | */ |
1210 | int sub_id; | |
1211 | ||
1212 | /** | |
f5bccd85 | 1213 | * Motion estimation algorithm used for video coding. |
58f7833e | 1214 | * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex), |
89223ef6 | 1215 | * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific] |
64863965 MN |
1216 | * - encoding: MUST be set by user. |
1217 | * - decoding: unused | |
b71901e6 MN |
1218 | */ |
1219 | int me_method; | |
1220 | ||
1221 | /** | |
f5bccd85 DB |
1222 | * some codecs need / can use extradata like Huffman tables. |
1223 | * mjpeg: Huffman tables | |
b71901e6 | 1224 | * rv10: additional flags |
b704e742 | 1225 | * mpeg4: global headers (they can be in the bitstream or here) |
f5bccd85 DB |
1226 | * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger |
1227 | * than extradata_size to avoid prolems if it is read with the bitstream reader. | |
1228 | * The bytewise contents of extradata must not depend on the architecture or CPU endianness. | |
1229 | * - encoding: Set/allocated/freed by libavcodec. | |
1230 | * - decoding: Set/allocated/freed by user. | |
b71901e6 | 1231 | */ |
58f2a4b0 | 1232 | uint8_t *extradata; |
e84c31dc | 1233 | int extradata_size; |
115329f1 | 1234 | |
b71901e6 | 1235 | /** |
f5bccd85 DB |
1236 | * This is the fundamental unit of time (in seconds) in terms |
1237 | * of which frame timestamps are represented. For fixed-fps content, | |
5b28c8c3 MN |
1238 | * timebase should be 1/framerate and timestamp increments should be |
1239 | * identically 1. | |
f5bccd85 DB |
1240 | * - encoding: MUST be set by user. |
1241 | * - decoding: Set by libavcodec. | |
b71901e6 | 1242 | */ |
c0df9d75 | 1243 | AVRational time_base; |
115329f1 | 1244 | |
5b28c8c3 | 1245 | /* video only */ |
14bea432 | 1246 | /** |
21adafec | 1247 | * picture width / height. |
115329f1 | 1248 | * - encoding: MUST be set by user. |
f5bccd85 DB |
1249 | * - decoding: Set by libavcodec. |
1250 | * Note: For compatibility it is possible to set this instead of | |
1251 | * coded_width/height before decoding. | |
b71901e6 | 1252 | */ |
de6d9b64 | 1253 | int width, height; |
115329f1 | 1254 | |
e769f053 | 1255 | #define FF_ASPECT_EXTENDED 15 |
b71901e6 MN |
1256 | |
1257 | /** | |
f5bccd85 DB |
1258 | * the number of pictures in a group of pictures, or 0 for intra_only |
1259 | * - encoding: Set by user. | |
64863965 | 1260 | * - decoding: unused |
b71901e6 MN |
1261 | */ |
1262 | int gop_size; | |
1263 | ||
1264 | /** | |
f5bccd85 | 1265 | * Pixel format, see PIX_FMT_xxx. |
c1bdc930 TH |
1266 | * May be set by the demuxer if known from headers. |
1267 | * May be overriden by the decoder if it knows better. | |
f5bccd85 | 1268 | * - encoding: Set by user. |
c1bdc930 | 1269 | * - decoding: Set by user if known, overridden by libavcodec if known |
b71901e6 | 1270 | */ |
e4eadb4b | 1271 | enum PixelFormat pix_fmt; |
115329f1 | 1272 | |
b71901e6 | 1273 | /** |
f5bccd85 DB |
1274 | * If non NULL, 'draw_horiz_band' is called by the libavcodec |
1275 | * decoder to draw a horizontal band. It improves cache usage. Not | |
b71901e6 | 1276 | * all codecs can do that. You must check the codec capabilities |
f5bccd85 | 1277 | * beforehand. |
37b00b47 AS |
1278 | * When multithreading is used, it may be called from multiple threads |
1279 | * at the same time; threads might draw different parts of the same AVFrame, | |
1280 | * or multiple AVFrames, and there is no guarantee that slices will be drawn | |
1281 | * in order. | |
24b1583a IK |
1282 | * The function is also used by hardware acceleration APIs. |
1283 | * It is called at least once during frame decoding to pass | |
1284 | * the data needed for hardware render. | |
1285 | * In that mode instead of pixel data, AVFrame points to | |
1286 | * a structure specific to the acceleration API. The application | |
1287 | * reads the structure and can change some fields to indicate progress | |
1288 | * or mark state. | |
64863965 | 1289 | * - encoding: unused |
f5bccd85 | 1290 | * - decoding: Set by user. |
3bb07d61 MN |
1291 | * @param height the height of the slice |
1292 | * @param y the y position of the slice | |
1293 | * @param type 1->top field, 2->bottom field, 3->frame | |
1294 | * @param offset offset into the AVFrame.data from which the slice should be read | |
b71901e6 | 1295 | */ |
bf89e6b1 | 1296 | void (*draw_horiz_band)(struct AVCodecContext *s, |
560f773c | 1297 | const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], |
3bb07d61 | 1298 | int y, int type, int height); |
bf89e6b1 | 1299 | |
de6d9b64 | 1300 | /* audio only */ |
f5bccd85 | 1301 | int sample_rate; ///< samples per second |
5fcc4a23 | 1302 | int channels; ///< number of audio channels |
a3a5f4d6 MN |
1303 | |
1304 | /** | |
f5bccd85 DB |
1305 | * audio sample format |
1306 | * - encoding: Set by user. | |
1307 | * - decoding: Set by libavcodec. | |
a3a5f4d6 | 1308 | */ |
5d6e4c16 | 1309 | enum AVSampleFormat sample_fmt; ///< sample format |
de6d9b64 | 1310 | |
f5bccd85 | 1311 | /* The following data should not be initialized. */ |
718b27a7 | 1312 | /** |
f5bccd85 | 1313 | * Samples per packet, initialized when calling 'init'. |
718b27a7 MN |
1314 | */ |
1315 | int frame_size; | |
115329f1 | 1316 | int frame_number; ///< audio or video frame number |
115329f1 | 1317 | |
b71901e6 | 1318 | /** |
7600e5c5 JR |
1319 | * Encoder delay. |
1320 | * | |
1321 | * Video: | |
1322 | * Number of frames the decoded output will be delayed relative to the | |
1323 | * encoded input. | |
1324 | * | |
1325 | * Audio: | |
1326 | * Number of "priming" samples added to the beginning of the stream | |
1327 | * during encoding. The decoded output will be delayed by this many | |
1328 | * samples relative to the input to the encoder. Note that this field is | |
1329 | * purely informational and does not directly affect the pts output by | |
1330 | * the encoder, which should always be based on the actual presentation | |
1331 | * time, including any delay. | |
1332 | * | |
f5bccd85 | 1333 | * - encoding: Set by libavcodec. |
64863965 | 1334 | * - decoding: unused |
b71901e6 MN |
1335 | */ |
1336 | int delay; | |
115329f1 | 1337 | |
64863965 MN |
1338 | /* - encoding parameters */ |
1339 | float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0) | |
115329f1 DB |
1340 | float qblur; ///< amount of qscale smoothing over time (0.0-1.0) |
1341 | ||
b71901e6 | 1342 | /** |
f5bccd85 DB |
1343 | * minimum quantizer |
1344 | * - encoding: Set by user. | |
64863965 | 1345 | * - decoding: unused |
b71901e6 MN |
1346 | */ |
1347 | int qmin; | |
1348 | ||
1349 | /** | |
f5bccd85 DB |
1350 | * maximum quantizer |
1351 | * - encoding: Set by user. | |
64863965 | 1352 | * - decoding: unused |
b71901e6 MN |
1353 | */ |
1354 | int qmax; | |
1355 | ||
1356 | /** | |
f5bccd85 DB |
1357 | * maximum quantizer difference between frames |
1358 | * - encoding: Set by user. | |
64863965 | 1359 | * - decoding: unused |
b71901e6 MN |
1360 | */ |
1361 | int max_qdiff; | |
1362 | ||
1363 | /** | |
f5bccd85 DB |
1364 | * maximum number of B-frames between non-B-frames |
1365 | * Note: The output will be delayed by max_b_frames+1 relative to the input. | |
1366 | * - encoding: Set by user. | |
64863965 | 1367 | * - decoding: unused |
b71901e6 MN |
1368 | */ |
1369 | int max_b_frames; | |
1370 | ||
1371 | /** | |
f5bccd85 | 1372 | * qscale factor between IP and B-frames |
662e5411 | 1373 | * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset). |
1374 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). | |
f5bccd85 | 1375 | * - encoding: Set by user. |
64863965 | 1376 | * - decoding: unused |
b71901e6 MN |
1377 | */ |
1378 | float b_quant_factor; | |
115329f1 | 1379 | |
b71901e6 MN |
1380 | /** obsolete FIXME remove */ |
1381 | int rc_strategy; | |
64b7c5b6 MN |
1382 | #define FF_RC_STRATEGY_XVID 1 |
1383 | ||
8b4c7dbc | 1384 | int b_frame_strategy; |
9dbcbd92 | 1385 | |
de6d9b64 | 1386 | struct AVCodec *codec; |
115329f1 | 1387 | |
de6d9b64 FB |
1388 | void *priv_data; |
1389 | ||
bb628dae | 1390 | int rtp_payload_size; /* The size of the RTP payload: the coder will */ |
f5bccd85 | 1391 | /* do its best to deliver a chunk with size */ |
644d98a4 | 1392 | /* below rtp_payload_size, the chunk will start */ |
f5bccd85 | 1393 | /* with a start code on some codecs like H.263. */ |
644d98a4 | 1394 | /* This doesn't take account of any particular */ |
f5bccd85 | 1395 | /* headers inside the transmitted RTP payload. */ |
81401c1f | 1396 | |
115329f1 | 1397 | |
f5bccd85 DB |
1398 | /* The RTP callback: This function is called */ |
1399 | /* every time the encoder has a packet to send. */ | |
1400 | /* It depends on the encoder if the data starts */ | |
1401 | /* with a Start Code (it should). H.263 does. */ | |
1402 | /* mb_nb contains the number of macroblocks */ | |
1403 | /* encoded in the RTP payload. */ | |
115329f1 | 1404 | void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb); |
81401c1f | 1405 | |
098eefe1 MN |
1406 | /* statistics, used for 2-pass encoding */ |
1407 | int mv_bits; | |
1408 | int header_bits; | |
1409 | int i_tex_bits; | |
1410 | int p_tex_bits; | |
1411 | int i_count; | |
1412 | int p_count; | |
1413 | int skip_count; | |
b71901e6 | 1414 | int misc_bits; |
115329f1 | 1415 | |
b71901e6 | 1416 | /** |
f5bccd85 DB |
1417 | * number of bits used for the previously encoded frame |
1418 | * - encoding: Set by libavcodec. | |
7004ffb3 | 1419 | * - decoding: unused |
b71901e6 | 1420 | */ |
098eefe1 | 1421 | int frame_bits; |
7004ffb3 | 1422 | |
b71901e6 | 1423 | /** |
f5bccd85 DB |
1424 | * Private data of the user, can be used to carry app specific stuff. |
1425 | * - encoding: Set by user. | |
1426 | * - decoding: Set by user. | |
b71901e6 MN |
1427 | */ |
1428 | void *opaque; | |
1429 | ||
de6d9b64 | 1430 | char codec_name[32]; |
72415b2a | 1431 | enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */ |
4a663d80 | 1432 | enum CodecID codec_id; /* see CODEC_ID_xxx */ |
115329f1 | 1433 | |
7004ffb3 MN |
1434 | /** |
1435 | * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). | |
f5bccd85 DB |
1436 | * This is used to work around some encoder bugs. |
1437 | * A demuxer should set this to what is stored in the field used to identify the codec. | |
1438 | * If there are multiple such fields in a container then the demuxer should choose the one | |
1439 | * which maximizes the information about the used codec. | |
be73d76b | 1440 | * If the codec tag field in a container is larger than 32 bits then the demuxer should |
f5bccd85 | 1441 | * remap the longer ID to 32 bits with a table or other structure. Alternatively a new |
47bbf8a7 | 1442 | * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated |
f5bccd85 DB |
1443 | * first. |
1444 | * - encoding: Set by user, if not then the default based on codec_id will be used. | |
1445 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. | |
7004ffb3 MN |
1446 | */ |
1447 | unsigned int codec_tag; | |
115329f1 | 1448 | |
b71901e6 | 1449 | /** |
f5bccd85 DB |
1450 | * Work around bugs in encoders which sometimes cannot be detected automatically. |
1451 | * - encoding: Set by user | |
1452 | * - decoding: Set by user | |
b71901e6 MN |
1453 | */ |
1454 | int workaround_bugs; | |
64863965 | 1455 | #define FF_BUG_AUTODETECT 1 ///< autodetection |
4d2858de MN |
1456 | #define FF_BUG_OLD_MSMPEG4 2 |
1457 | #define FF_BUG_XVID_ILACE 4 | |
1458 | #define FF_BUG_UMP4 8 | |
1459 | #define FF_BUG_NO_PADDING 16 | |
3116cb14 | 1460 | #define FF_BUG_AMV 32 |
f5bccd85 | 1461 | #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default. |
03e93d35 | 1462 | #define FF_BUG_QPEL_CHROMA 64 |
db794953 | 1463 | #define FF_BUG_STD_QPEL 128 |
36df8805 | 1464 | #define FF_BUG_QPEL_CHROMA2 256 |
c40c3482 | 1465 | #define FF_BUG_DIRECT_BLOCKSIZE 512 |
1c6dcb0f | 1466 | #define FF_BUG_EDGE 1024 |
b44bdf7e | 1467 | #define FF_BUG_HPEL_CHROMA 2048 |
4ccde216 | 1468 | #define FF_BUG_DC_CLIP 4096 |
f5bccd85 | 1469 | #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders. |
3566042a | 1470 | #define FF_BUG_TRUNCATED 16384 |
115329f1 | 1471 | |
b71901e6 | 1472 | /** |
f5bccd85 DB |
1473 | * luma single coefficient elimination threshold |
1474 | * - encoding: Set by user. | |
64863965 | 1475 | * - decoding: unused |
b71901e6 | 1476 | */ |
1f6b6e50 | 1477 | int luma_elim_threshold; |
115329f1 | 1478 | |
b71901e6 | 1479 | /** |
f5bccd85 DB |
1480 | * chroma single coeff elimination threshold |
1481 | * - encoding: Set by user. | |
64863965 | 1482 | * - decoding: unused |
b71901e6 | 1483 | */ |
1f6b6e50 | 1484 | int chroma_elim_threshold; |
115329f1 | 1485 | |
b71901e6 | 1486 | /** |
f5bccd85 DB |
1487 | * strictly follow the standard (MPEG4, ...). |
1488 | * - encoding: Set by user. | |
5771b2c3 MN |
1489 | * - decoding: Set by user. |
1490 | * Setting this to STRICT or higher means the encoder and decoder will | |
2d525ef4 | 1491 | * generally do stupid things, whereas setting it to unofficial or lower |
538c0e13 RB |
1492 | * will mean the encoder might produce output that is not supported by all |
1493 | * spec-compliant decoders. Decoders don't differentiate between normal, | |
2d525ef4 | 1494 | * unofficial and experimental (that is, they always try to decode things |
538c0e13 | 1495 | * when they can) unless they are explicitly asked to behave stupidly |
5771b2c3 | 1496 | * (=strictly conform to the specs) |
b71901e6 MN |
1497 | */ |
1498 | int strict_std_compliance; | |
538c0e13 | 1499 | #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software. |
f5bccd85 | 1500 | #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences. |
9cd81798 | 1501 | #define FF_COMPLIANCE_NORMAL 0 |
2d525ef4 | 1502 | #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions |
f5bccd85 | 1503 | #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things. |
9cd81798 | 1504 | |
b71901e6 | 1505 | /** |
f5bccd85 | 1506 | * qscale offset between IP and B-frames |
f5bccd85 | 1507 | * - encoding: Set by user. |
64863965 | 1508 | * - decoding: unused |
b71901e6 MN |
1509 | */ |
1510 | float b_quant_offset; | |
115329f1 | 1511 | |
6b72ac63 | 1512 | /** |
f5bccd85 | 1513 | * Called at the beginning of each frame to get a buffer for it. |
0eea2129 JR |
1514 | * |
1515 | * The function will set AVFrame.data[], AVFrame.linesize[]. | |
1516 | * AVFrame.extended_data[] must also be set, but it should be the same as | |
1517 | * AVFrame.data[] except for planar audio with more channels than can fit | |
1518 | * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as | |
1519 | * many data pointers as it can hold. | |
1520 | * | |
f1b99cc6 MN |
1521 | * if CODEC_CAP_DR1 is not set then get_buffer() must call |
1522 | * avcodec_default_get_buffer() instead of providing buffers allocated by | |
1523 | * some other means. | |
0eea2129 JR |
1524 | * |
1525 | * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't | |
1526 | * need it. avcodec_default_get_buffer() aligns the output buffer properly, | |
1527 | * but if get_buffer() is overridden then alignment considerations should | |
1528 | * be taken into account. | |
1529 | * | |
1530 | * @see avcodec_default_get_buffer() | |
1531 | * | |
1532 | * Video: | |
1533 | * | |
1534 | * If pic.reference is set then the frame will be read later by libavcodec. | |
1535 | * avcodec_align_dimensions2() should be used to find the required width and | |
1536 | * height, as they normally need to be rounded up to the next multiple of 16. | |
1537 | * | |
37b00b47 | 1538 | * If frame multithreading is used and thread_safe_callbacks is set, |
0eea2129 JR |
1539 | * it may be called from a different thread, but not from more than one at |
1540 | * once. Does not need to be reentrant. | |
1541 | * | |
1542 | * @see release_buffer(), reget_buffer() | |
1543 | * @see avcodec_align_dimensions2() | |
1544 | * | |
1545 | * Audio: | |
1546 | * | |
1547 | * Decoders request a buffer of a particular size by setting | |
1548 | * AVFrame.nb_samples prior to calling get_buffer(). The decoder may, | |
1549 | * however, utilize only part of the buffer by setting AVFrame.nb_samples | |
1550 | * to a smaller value in the output frame. | |
1551 | * | |
1552 | * Decoders cannot use the buffer after returning from | |
1553 | * avcodec_decode_audio4(), so they will not call release_buffer(), as it | |
1554 | * is assumed to be released immediately upon return. | |
1555 | * | |
1556 | * As a convenience, av_samples_get_buffer_size() and | |
1557 | * av_samples_fill_arrays() in libavutil may be used by custom get_buffer() | |
1558 | * functions to find the required data size and to fill data pointers and | |
1559 | * linesize. In AVFrame.linesize, only linesize[0] may be set for audio | |
1560 | * since all planes must be the same size. | |
1561 | * | |
1562 | * @see av_samples_get_buffer_size(), av_samples_fill_arrays() | |
1563 | * | |
64863965 | 1564 | * - encoding: unused |
53128bc3 | 1565 | * - decoding: Set by libavcodec, user can override. |
b71901e6 | 1566 | */ |
492cd3a9 | 1567 | int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic); |
115329f1 | 1568 | |
b71901e6 | 1569 | /** |
69b192ac | 1570 | * Called to release buffers which were allocated with get_buffer. |
f5bccd85 DB |
1571 | * A released buffer can be reused in get_buffer(). |
1572 | * pic.data[*] must be set to NULL. | |
37b00b47 AS |
1573 | * May be called from a different thread if frame multithreading is used, |
1574 | * but not by more than one thread at once, so does not need to be reentrant. | |
64863965 | 1575 | * - encoding: unused |
53128bc3 | 1576 | * - decoding: Set by libavcodec, user can override. |
b71901e6 | 1577 | */ |
492cd3a9 | 1578 | void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic); |
0fd90455 | 1579 | |
b71901e6 | 1580 | /** |
eb8a25c8 | 1581 | * Size of the frame reordering buffer in the decoder. |
2d7b0560 | 1582 | * For MPEG-2 it is 1 IPB or 0 low delay IP. |
f5bccd85 DB |
1583 | * - encoding: Set by libavcodec. |
1584 | * - decoding: Set by libavcodec. | |
b71901e6 MN |
1585 | */ |
1586 | int has_b_frames; | |
718b27a7 MN |
1587 | |
1588 | /** | |
1589 | * number of bytes per packet if constant and known or 0 | |
f5bccd85 | 1590 | * Used by some WAV based audio codecs. |
718b27a7 MN |
1591 | */ |
1592 | int block_align; | |
115329f1 | 1593 | |
b71901e6 | 1594 | /** |
f5bccd85 DB |
1595 | * 0-> h263 quant 1-> mpeg quant |
1596 | * - encoding: Set by user. | |
64863965 | 1597 | * - decoding: unused |
b71901e6 MN |
1598 | */ |
1599 | int mpeg_quant; | |
115329f1 | 1600 | |
b71901e6 | 1601 | /** |
f5bccd85 DB |
1602 | * pass1 encoding statistics output buffer |
1603 | * - encoding: Set by libavcodec. | |
64863965 | 1604 | * - decoding: unused |
b71901e6 | 1605 | */ |
64863965 | 1606 | char *stats_out; |
115329f1 | 1607 | |
b71901e6 | 1608 | /** |
f5bccd85 DB |
1609 | * pass2 encoding statistics input buffer |
1610 | * Concatenated stuff from stats_out of pass1 should be placed here. | |
1611 | * - encoding: Allocated/set/freed by user. | |
64863965 | 1612 | * - decoding: unused |
b71901e6 MN |
1613 | */ |
1614 | char *stats_in; | |
115329f1 | 1615 | |
b71901e6 | 1616 | /** |
f5bccd85 DB |
1617 | * ratecontrol qmin qmax limiting method |
1618 | * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax. | |
1619 | * - encoding: Set by user. | |
64863965 | 1620 | * - decoding: unused |
b71901e6 | 1621 | */ |
ce980a95 | 1622 | float rc_qsquish; |
b71901e6 | 1623 | |
ce980a95 MN |
1624 | float rc_qmod_amp; |
1625 | int rc_qmod_freq; | |
115329f1 | 1626 | |
b71901e6 | 1627 | /** |
f5bccd85 DB |
1628 | * ratecontrol override, see RcOverride |
1629 | * - encoding: Allocated/set/freed by user. | |
64863965 | 1630 | * - decoding: unused |
b71901e6 | 1631 | */ |
ce980a95 MN |
1632 | RcOverride *rc_override; |
1633 | int rc_override_count; | |
115329f1 | 1634 | |
b71901e6 | 1635 | /** |
f5bccd85 DB |
1636 | * rate control equation |
1637 | * - encoding: Set by user | |
64863965 | 1638 | * - decoding: unused |
b71901e6 | 1639 | */ |
6881b8e5 | 1640 | const char *rc_eq; |
115329f1 | 1641 | |
b71901e6 | 1642 | /** |
f5bccd85 DB |
1643 | * maximum bitrate |
1644 | * - encoding: Set by user. | |
64863965 | 1645 | * - decoding: unused |
b71901e6 | 1646 | */ |
ce980a95 | 1647 | int rc_max_rate; |
115329f1 | 1648 | |
b71901e6 | 1649 | /** |
f5bccd85 DB |
1650 | * minimum bitrate |
1651 | * - encoding: Set by user. | |
64863965 | 1652 | * - decoding: unused |
b71901e6 | 1653 | */ |
ce980a95 | 1654 | int rc_min_rate; |
115329f1 | 1655 | |
b71901e6 | 1656 | /** |
f5bccd85 DB |
1657 | * decoder bitstream buffer size |
1658 | * - encoding: Set by user. | |
64863965 | 1659 | * - decoding: unused |
b71901e6 | 1660 | */ |
ce980a95 MN |
1661 | int rc_buffer_size; |
1662 | float rc_buffer_aggressivity; | |
b71901e6 MN |
1663 | |
1664 | /** | |
f5bccd85 DB |
1665 | * qscale factor between P and I-frames |
1666 | * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset). | |
1667 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). | |
1668 | * - encoding: Set by user. | |
64863965 | 1669 | * - decoding: unused |
b71901e6 MN |
1670 | */ |
1671 | float i_quant_factor; | |
115329f1 | 1672 | |
b71901e6 | 1673 | /** |
f5bccd85 DB |
1674 | * qscale offset between P and I-frames |
1675 | * - encoding: Set by user. | |
64863965 | 1676 | * - decoding: unused |
b71901e6 MN |
1677 | */ |
1678 | float i_quant_offset; | |
115329f1 | 1679 | |
b71901e6 | 1680 | /** |
f5bccd85 DB |
1681 | * initial complexity for pass1 ratecontrol |
1682 | * - encoding: Set by user. | |
64863965 | 1683 | * - decoding: unused |
b71901e6 | 1684 | */ |
ce980a95 | 1685 | float rc_initial_cplx; |
917e06c8 | 1686 | |
b71901e6 | 1687 | /** |
f5bccd85 DB |
1688 | * DCT algorithm, see FF_DCT_* below |
1689 | * - encoding: Set by user. | |
64863965 | 1690 | * - decoding: unused |
b71901e6 | 1691 | */ |
28db7fce | 1692 | int dct_algo; |
c7e07931 | 1693 | #define FF_DCT_AUTO 0 |
28db7fce | 1694 | #define FF_DCT_FASTINT 1 |
c7e07931 MO |
1695 | #define FF_DCT_INT 2 |
1696 | #define FF_DCT_MMX 3 | |
05c4072b | 1697 | #define FF_DCT_ALTIVEC 5 |
65e4c8c9 | 1698 | #define FF_DCT_FAAN 6 |
115329f1 | 1699 | |
c5d309f2 | 1700 | /** |
f5bccd85 DB |
1701 | * luminance masking (0-> disabled) |
1702 | * - encoding: Set by user. | |
64863965 | 1703 | * - decoding: unused |
c5d309f2 MN |
1704 | */ |
1705 | float lumi_masking; | |
115329f1 | 1706 | |
c5d309f2 | 1707 | /** |
f5bccd85 DB |
1708 | * temporary complexity masking (0-> disabled) |
1709 | * - encoding: Set by user. | |
64863965 | 1710 | * - decoding: unused |
c5d309f2 MN |
1711 | */ |
1712 | float temporal_cplx_masking; | |
115329f1 | 1713 | |
c5d309f2 | 1714 | /** |
f5bccd85 DB |
1715 | * spatial complexity masking (0-> disabled) |
1716 | * - encoding: Set by user. | |
64863965 | 1717 | * - decoding: unused |
c5d309f2 MN |
1718 | */ |
1719 | float spatial_cplx_masking; | |
115329f1 | 1720 | |
c5d309f2 | 1721 | /** |
f5bccd85 DB |
1722 | * p block masking (0-> disabled) |
1723 | * - encoding: Set by user. | |
64863965 | 1724 | * - decoding: unused |
c5d309f2 MN |
1725 | */ |
1726 | float p_masking; | |
15415af4 | 1727 | |
5e746b99 | 1728 | /** |
f5bccd85 DB |
1729 | * darkness masking (0-> disabled) |
1730 | * - encoding: Set by user. | |
64863965 | 1731 | * - decoding: unused |
5e746b99 MN |
1732 | */ |
1733 | float dark_masking; | |
115329f1 | 1734 | |
0c2dd16e | 1735 | /** |
f5bccd85 DB |
1736 | * IDCT algorithm, see FF_IDCT_* below. |
1737 | * - encoding: Set by user. | |
1738 | * - decoding: Set by user. | |
2ad1516a MN |
1739 | */ |
1740 | int idct_algo; | |
273b0cd3 DB |
1741 | #define FF_IDCT_AUTO 0 |
1742 | #define FF_IDCT_INT 1 | |
1743 | #define FF_IDCT_SIMPLE 2 | |
1744 | #define FF_IDCT_SIMPLEMMX 3 | |
1745 | #define FF_IDCT_LIBMPEG2MMX 4 | |
0bf184e5 | 1746 | #define FF_IDCT_MMI 5 |
273b0cd3 DB |
1747 | #define FF_IDCT_ARM 7 |
1748 | #define FF_IDCT_ALTIVEC 8 | |
1749 | #define FF_IDCT_SH4 9 | |
1750 | #define FF_IDCT_SIMPLEARM 10 | |
1751 | #define FF_IDCT_H264 11 | |
1752 | #define FF_IDCT_VP3 12 | |
1753 | #define FF_IDCT_IPP 13 | |
1754 | #define FF_IDCT_XVIDMMX 14 | |
1755 | #define FF_IDCT_CAVS 15 | |
a0403006 | 1756 | #define FF_IDCT_SIMPLEARMV5TE 16 |
273b0cd3 | 1757 | #define FF_IDCT_SIMPLEARMV6 17 |
d9420d4d | 1758 | #define FF_IDCT_SIMPLEVIS 18 |
9abc7e0f | 1759 | #define FF_IDCT_WMV2 19 |
6f08c541 | 1760 | #define FF_IDCT_FAAN 20 |
42b30357 | 1761 | #define FF_IDCT_EA 21 |
7eec4328 | 1762 | #define FF_IDCT_SIMPLENEON 22 |
74c47463 | 1763 | #define FF_IDCT_SIMPLEALPHA 23 |
342c7dfd | 1764 | #define FF_IDCT_BINK 24 |
2ad1516a | 1765 | |
144f0625 | 1766 | /** |
f5bccd85 DB |
1767 | * slice count |
1768 | * - encoding: Set by libavcodec. | |
1769 | * - decoding: Set by user (or 0). | |
144f0625 MN |
1770 | */ |
1771 | int slice_count; | |
1772 | /** | |
f5bccd85 DB |
1773 | * slice offsets in the frame in bytes |
1774 | * - encoding: Set/allocated by libavcodec. | |
1775 | * - decoding: Set/allocated by user (or NULL). | |
144f0625 MN |
1776 | */ |
1777 | int *slice_offset; | |
1778 | ||
4d2858de | 1779 | /** |
f5bccd85 | 1780 | * error concealment flags |
64863965 | 1781 | * - encoding: unused |
f5bccd85 | 1782 | * - decoding: Set by user. |
4d2858de MN |
1783 | */ |
1784 | int error_concealment; | |
1785 | #define FF_EC_GUESS_MVS 1 | |
1786 | #define FF_EC_DEBLOCK 2 | |
1787 | ||
6b72ac63 | 1788 | /** |
bec89a84 | 1789 | * dsp_mask could be add used to disable unwanted CPU features |
8350df97 | 1790 | * CPU features (i.e. MMX, SSE. ...) |
bec89a84 | 1791 | * |
f5bccd85 DB |
1792 | * With the FORCE flag you may instead enable given CPU features. |
1793 | * (Dangerous: Usable in case of misdetection, improper usage however will | |
1794 | * result into program crash.) | |
bec89a84 ZK |
1795 | */ |
1796 | unsigned dsp_mask; | |
7160bb71 | 1797 | |
11f18faf | 1798 | /** |
64863965 | 1799 | * bits per sample/pixel from the demuxer (needed for huffyuv). |
f5bccd85 DB |
1800 | * - encoding: Set by libavcodec. |
1801 | * - decoding: Set by user. | |
11f18faf | 1802 | */ |
46a73068 | 1803 | int bits_per_coded_sample; |
115329f1 | 1804 | |
11f18faf | 1805 | /** |
f5bccd85 DB |
1806 | * prediction method (needed for huffyuv) |
1807 | * - encoding: Set by user. | |
64863965 | 1808 | * - decoding: unused |
11f18faf MN |
1809 | */ |
1810 | int prediction_method; | |
1811 | #define FF_PRED_LEFT 0 | |
1812 | #define FF_PRED_PLANE 1 | |
1813 | #define FF_PRED_MEDIAN 2 | |
115329f1 | 1814 | |
5d3cea3a | 1815 | /** |
f5bccd85 | 1816 | * sample aspect ratio (0 if unknown) |
8e5af7a6 | 1817 | * That is the width of a pixel divided by the height of the pixel. |
f5bccd85 DB |
1818 | * Numerator and denominator must be relatively prime and smaller than 256 for some video standards. |
1819 | * - encoding: Set by user. | |
1820 | * - decoding: Set by libavcodec. | |
5d3cea3a | 1821 | */ |
5ff85f1d | 1822 | AVRational sample_aspect_ratio; |
1e491e29 MN |
1823 | |
1824 | /** | |
f5bccd85 DB |
1825 | * the picture in the bitstream |
1826 | * - encoding: Set by libavcodec. | |
1827 | * - decoding: Set by libavcodec. | |
1e491e29 | 1828 | */ |
492cd3a9 | 1829 | AVFrame *coded_frame; |
c8c437bc MN |
1830 | |
1831 | /** | |
f5bccd85 DB |
1832 | * debug |
1833 | * - encoding: Set by user. | |
1834 | * - decoding: Set by user. | |
c8c437bc MN |
1835 | */ |
1836 | int debug; | |
273b0cd3 DB |
1837 | #define FF_DEBUG_PICT_INFO 1 |
1838 | #define FF_DEBUG_RC 2 | |
1839 | #define FF_DEBUG_BITSTREAM 4 | |
1840 | #define FF_DEBUG_MB_TYPE 8 | |
1841 | #define FF_DEBUG_QP 16 | |
1842 | #define FF_DEBUG_MV 32 | |
1843 | #define FF_DEBUG_DCT_COEFF 0x00000040 | |
1844 | #define FF_DEBUG_SKIP 0x00000080 | |
1845 | #define FF_DEBUG_STARTCODE 0x00000100 | |
1846 | #define FF_DEBUG_PTS 0x00000200 | |
1847 | #define FF_DEBUG_ER 0x00000400 | |
1848 | #define FF_DEBUG_MMCO 0x00000800 | |
1849 | #define FF_DEBUG_BUGS 0x00001000 | |
1850 | #define FF_DEBUG_VIS_QP 0x00002000 | |
864119b6 | 1851 | #define FF_DEBUG_VIS_MB_TYPE 0x00004000 |
385c820b | 1852 | #define FF_DEBUG_BUFFERS 0x00008000 |
37b00b47 | 1853 | #define FF_DEBUG_THREADS 0x00010000 |
115329f1 | 1854 | |
140cb663 | 1855 | /** |
f5bccd85 DB |
1856 | * debug |
1857 | * - encoding: Set by user. | |
1858 | * - decoding: Set by user. | |
0c9bbaec WH |
1859 | */ |
1860 | int debug_mv; | |
1861 | #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames | |
1862 | #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames | |
1863 | #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames | |
1864 | ||
1865 | /** | |
f5bccd85 DB |
1866 | * error |
1867 | * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR. | |
64863965 | 1868 | * - decoding: unused |
140cb663 | 1869 | */ |
560f773c | 1870 | uint64_t error[AV_NUM_DATA_POINTERS]; |
115329f1 | 1871 | |
1457ab52 | 1872 | /** |
f5bccd85 DB |
1873 | * motion estimation comparison function |
1874 | * - encoding: Set by user. | |
64863965 | 1875 | * - decoding: unused |
1457ab52 MN |
1876 | */ |
1877 | int me_cmp; | |
1878 | /** | |
f5bccd85 DB |
1879 | * subpixel motion estimation comparison function |
1880 | * - encoding: Set by user. | |
64863965 | 1881 | * - decoding: unused |
1457ab52 MN |
1882 | */ |
1883 | int me_sub_cmp; | |
1884 | /** | |
f5bccd85 DB |
1885 | * macroblock comparison function (not supported yet) |
1886 | * - encoding: Set by user. | |
64863965 | 1887 | * - decoding: unused |
1457ab52 MN |
1888 | */ |
1889 | int mb_cmp; | |
622348f9 | 1890 | /** |
f5bccd85 DB |
1891 | * interlaced DCT comparison function |
1892 | * - encoding: Set by user. | |
622348f9 MN |
1893 | * - decoding: unused |
1894 | */ | |
1895 | int ildct_cmp; | |
273b0cd3 DB |
1896 | #define FF_CMP_SAD 0 |
1897 | #define FF_CMP_SSE 1 | |
1898 | #define FF_CMP_SATD 2 | |
1899 | #define FF_CMP_DCT 3 | |
1900 | #define FF_CMP_PSNR 4 | |
1901 | #define FF_CMP_BIT 5 | |
1902 | #define FF_CMP_RD 6 | |
1903 | #define FF_CMP_ZERO 7 | |
1904 | #define FF_CMP_VSAD 8 | |
1905 | #define FF_CMP_VSSE 9 | |
1906 | #define FF_CMP_NSSE 10 | |
1907 | #define FF_CMP_W53 11 | |
1908 | #define FF_CMP_W97 12 | |
0fd6aea1 | 1909 | #define FF_CMP_DCTMAX 13 |
27c61ac5 | 1910 | #define FF_CMP_DCT264 14 |
1457ab52 | 1911 | #define FF_CMP_CHROMA 256 |
115329f1 | 1912 | |
1457ab52 | 1913 | /** |
f5bccd85 DB |
1914 | * ME diamond size & shape |
1915 | * - encoding: Set by user. | |
64863965 | 1916 | * - decoding: unused |
1457ab52 MN |
1917 | */ |
1918 | int dia_size; | |
b07a5980 MN |
1919 | |
1920 | /** | |
f5bccd85 DB |
1921 | * amount of previous MV predictors (2a+1 x 2a+1 square) |
1922 | * - encoding: Set by user. | |
64863965 | 1923 | * - decoding: unused |
b07a5980 MN |
1924 | */ |
1925 | int last_predictor_count; | |
70ac76c0 | 1926 | |
f5fb6b34 | 1927 | /** |
f5bccd85 DB |
1928 | * prepass for motion estimation |
1929 | * - encoding: Set by user. | |
64863965 | 1930 | * - decoding: unused |
f5fb6b34 MN |
1931 | */ |
1932 | int pre_me; | |
b07a5980 | 1933 | |
70ac76c0 | 1934 | /** |
f5bccd85 DB |
1935 | * motion estimation prepass comparison function |
1936 | * - encoding: Set by user. | |
64863965 | 1937 | * - decoding: unused |
70ac76c0 MN |
1938 | */ |
1939 | int me_pre_cmp; | |
826f429a | 1940 | |
70ac76c0 | 1941 | /** |
f5bccd85 DB |
1942 | * ME prepass diamond size & shape |
1943 | * - encoding: Set by user. | |
64863965 | 1944 | * - decoding: unused |
70ac76c0 MN |
1945 | */ |
1946 | int pre_dia_size; | |
1947 | ||
826f429a | 1948 | /** |
f5bccd85 DB |
1949 | * subpel ME quality |
1950 | * - encoding: Set by user. | |
64863965 | 1951 | * - decoding: unused |
826f429a MN |
1952 | */ |
1953 | int me_subpel_quality; | |
1954 | ||
a33c7159 | 1955 | /** |
f5bccd85 | 1956 | * callback to negotiate the pixelFormat |
a33c7159 | 1957 | * @param fmt is the list of formats which are supported by the codec, |
f5bccd85 DB |
1958 | * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality. |
1959 | * The first is always the native one. | |
1960 | * @return the chosen format | |
64863965 | 1961 | * - encoding: unused |
f5bccd85 | 1962 | * - decoding: Set by user, if not set the native format will be chosen. |
a33c7159 | 1963 | */ |
494c56d3 | 1964 | enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt); |
e2f9490e FB |
1965 | |
1966 | /** | |
f5bccd85 DB |
1967 | * DTG active format information (additional aspect ratio |
1968 | * information only used in DVB MPEG-2 transport streams) | |
1969 | * 0 if not set. | |
115329f1 | 1970 | * |
f5bccd85 DB |
1971 | * - encoding: unused |
1972 | * - decoding: Set by decoder. | |
e2f9490e FB |
1973 | */ |
1974 | int dtg_active_format; | |
1975 | #define FF_DTG_AFD_SAME 8 | |
1976 | #define FF_DTG_AFD_4_3 9 | |
1977 | #define FF_DTG_AFD_16_9 10 | |
1978 | #define FF_DTG_AFD_14_9 11 | |
1979 | #define FF_DTG_AFD_4_3_SP_14_9 13 | |
1980 | #define FF_DTG_AFD_16_9_SP_14_9 14 | |
1981 | #define FF_DTG_AFD_SP_4_3 15 | |
1982 | ||
ebbcdc9a | 1983 | /** |
f5bccd85 DB |
1984 | * maximum motion estimation search range in subpel units |
1985 | * If 0 then no limit. | |
115329f1 | 1986 | * |
f5bccd85 DB |
1987 | * - encoding: Set by user. |
1988 | * - decoding: unused | |
ebbcdc9a | 1989 | */ |
59e0ac8e | 1990 | int me_range; |
ebbcdc9a | 1991 | |
65f7062d | 1992 | /** |
f5bccd85 DB |
1993 | * intra quantizer bias |
1994 | * - encoding: Set by user. | |
1984f635 MN |
1995 | * - decoding: unused |
1996 | */ | |
1997 | int intra_quant_bias; | |
1998 | #define FF_DEFAULT_QUANT_BIAS 999999 | |
115329f1 | 1999 | |
1984f635 | 2000 | /** |
f5bccd85 DB |
2001 | * inter quantizer bias |
2002 | * - encoding: Set by user. | |
1984f635 MN |
2003 | * - decoding: unused |
2004 | */ | |
2005 | int inter_quant_bias; | |
5cd62665 ZK |
2006 | |
2007 | /** | |
f5bccd85 DB |
2008 | * color table ID |
2009 | * - encoding: unused | |
2010 | * - decoding: Which clrtable should be used for 8bit RGB images. | |
2011 | * Tables have to be stored somewhere. FIXME | |
5cd62665 ZK |
2012 | */ |
2013 | int color_table_id; | |
115329f1 | 2014 | |
3d2e8cce | 2015 | /** |
f5bccd85 DB |
2016 | * Global quality for codecs which cannot change it per frame. |
2017 | * This should be proportional to MPEG-1/2/4 qscale. | |
2018 | * - encoding: Set by user. | |
3d2e8cce MN |
2019 | * - decoding: unused |
2020 | */ | |
2021 | int global_quality; | |
115329f1 | 2022 | |
bd446bb1 MN |
2023 | #define FF_CODER_TYPE_VLC 0 |
2024 | #define FF_CODER_TYPE_AC 1 | |
f87459e4 KN |
2025 | #define FF_CODER_TYPE_RAW 2 |
2026 | #define FF_CODER_TYPE_RLE 3 | |
2027 | #define FF_CODER_TYPE_DEFLATE 4 | |
11e659c2 MN |
2028 | /** |
2029 | * coder type | |
f5bccd85 | 2030 | * - encoding: Set by user. |
11e659c2 MN |
2031 | * - decoding: unused |
2032 | */ | |
2033 | int coder_type; | |
2034 | ||
2035 | /** | |
2036 | * context model | |
f5bccd85 | 2037 | * - encoding: Set by user. |
11e659c2 MN |
2038 | * - decoding: unused |
2039 | */ | |
2040 | int context_model; | |
115329f1 | 2041 | |
3bb07d61 MN |
2042 | /** |
2043 | * slice flags | |
2044 | * - encoding: unused | |
f5bccd85 | 2045 | * - decoding: Set by user. |
3bb07d61 MN |
2046 | */ |
2047 | int slice_flags; | |
2048 | #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display | |
2049 | #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics) | |
2050 | #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1) | |
2051 | ||
fb364ada IK |
2052 | /** |
2053 | * XVideo Motion Acceleration | |
2054 | * - encoding: forbidden | |
2055 | * - decoding: set by decoder | |
2056 | */ | |
2057 | int xvmc_acceleration; | |
115329f1 | 2058 | |
7d1c3fc1 MN |
2059 | /** |
2060 | * macroblock decision mode | |
f5bccd85 | 2061 | * - encoding: Set by user. |
7d1c3fc1 MN |
2062 | * - decoding: unused |
2063 | */ | |
2064 | int mb_decision; | |
2065 | #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp | |
2066 | #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits | |
e6dba5df | 2067 | #define FF_MB_DECISION_RD 2 ///< rate distortion |
d6eb3c50 MN |
2068 | |
2069 | /** | |
2070 | * custom intra quantization matrix | |
f5bccd85 DB |
2071 | * - encoding: Set by user, can be NULL. |
2072 | * - decoding: Set by libavcodec. | |
d6eb3c50 MN |
2073 | */ |
2074 | uint16_t *intra_matrix; | |
2075 | ||
2076 | /** | |
2077 | * custom inter quantization matrix | |
f5bccd85 DB |
2078 | * - encoding: Set by user, can be NULL. |
2079 | * - decoding: Set by libavcodec. | |
d6eb3c50 MN |
2080 | */ |
2081 | uint16_t *inter_matrix; | |
115329f1 | 2082 | |
541ae140 MN |
2083 | /** |
2084 | * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). | |
f5bccd85 | 2085 | * This is used to work around some encoder bugs. |
541ae140 | 2086 | * - encoding: unused |
f5bccd85 | 2087 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. |
541ae140 MN |
2088 | */ |
2089 | unsigned int stream_codec_tag; | |
05fbd0a2 MN |
2090 | |
2091 | /** | |
f5bccd85 DB |
2092 | * scene change detection threshold |
2093 | * 0 is default, larger means fewer detected scene changes. | |
2094 | * - encoding: Set by user. | |
05fbd0a2 MN |
2095 | * - decoding: unused |
2096 | */ | |
2097 | int scenechange_threshold; | |
158c7f05 MN |
2098 | |
2099 | /** | |
f5bccd85 DB |
2100 | * minimum Lagrange multipler |
2101 | * - encoding: Set by user. | |
158c7f05 MN |
2102 | * - decoding: unused |
2103 | */ | |
2104 | int lmin; | |
2105 | ||
2106 | /** | |
f5bccd85 DB |
2107 | * maximum Lagrange multipler |
2108 | * - encoding: Set by user. | |
158c7f05 MN |
2109 | * - decoding: unused |
2110 | */ | |
2111 | int lmax; | |
2a2bbcb0 | 2112 | |
821cb11f MN |
2113 | /** |
2114 | * noise reduction strength | |
f5bccd85 | 2115 | * - encoding: Set by user. |
821cb11f MN |
2116 | * - decoding: unused |
2117 | */ | |
2118 | int noise_reduction; | |
115329f1 | 2119 | |
074c4ca7 | 2120 | /** |
f5bccd85 DB |
2121 | * Called at the beginning of a frame to get cr buffer for it. |
2122 | * Buffer type (size, hints) must be the same. libavcodec won't check it. | |
2123 | * libavcodec will pass previous buffer in pic, function should return | |
e1c2a5a0 | 2124 | * same buffer or new buffer with old frame "painted" into it. |
f5bccd85 | 2125 | * If pic.data[0] == NULL must behave like get_buffer(). |
f1b99cc6 MN |
2126 | * if CODEC_CAP_DR1 is not set then reget_buffer() must call |
2127 | * avcodec_default_reget_buffer() instead of providing buffers allocated by | |
2128 | * some other means. | |
074c4ca7 | 2129 | * - encoding: unused |
53128bc3 | 2130 | * - decoding: Set by libavcodec, user can override. |
074c4ca7 | 2131 | */ |
e1c2a5a0 | 2132 | int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic); |
ba58dabc MN |
2133 | |
2134 | /** | |
f5bccd85 DB |
2135 | * Number of bits which should be loaded into the rc buffer before decoding starts. |
2136 | * - encoding: Set by user. | |
ba58dabc MN |
2137 | * - decoding: unused |
2138 | */ | |
2139 | int rc_initial_buffer_occupancy; | |
2140 | ||
2141 | /** | |
2142 | * | |
f5bccd85 | 2143 | * - encoding: Set by user. |
ba58dabc MN |
2144 | * - decoding: unused |
2145 | */ | |
2146 | int inter_threshold; | |
2147 | ||
2148 | /** | |
f5bccd85 DB |
2149 | * CODEC_FLAG2_* |
2150 | * - encoding: Set by user. | |
2151 | * - decoding: Set by user. | |
ba58dabc MN |
2152 | */ |
2153 | int flags2; | |
7ebfc0ea MN |
2154 | |
2155 | /** | |
f5bccd85 DB |
2156 | * Simulates errors in the bitstream to test error concealment. |
2157 | * - encoding: Set by user. | |
2158 | * - decoding: unused | |
7ebfc0ea MN |
2159 | */ |
2160 | int error_rate; | |
115329f1 | 2161 | |
77ea0d4b | 2162 | /** |
f5bccd85 DB |
2163 | * quantizer noise shaping |
2164 | * - encoding: Set by user. | |
77ea0d4b MN |
2165 | * - decoding: unused |
2166 | */ | |
2167 | int quantizer_noise_shaping; | |
9c3d33d6 MN |
2168 | |
2169 | /** | |
f5bccd85 | 2170 | * thread count |
eafcac6a | 2171 | * is used to decide how many independent tasks should be passed to execute() |
f5bccd85 DB |
2172 | * - encoding: Set by user. |
2173 | * - decoding: Set by user. | |
9c3d33d6 MN |
2174 | */ |
2175 | int thread_count; | |
115329f1 | 2176 | |
9c3d33d6 | 2177 | /** |
f5bccd85 DB |
2178 | * The codec may call this to execute several independent things. |
2179 | * It will return only after finishing all tasks. | |
2180 | * The user may replace this with some multithreaded implementation, | |
2181 | * the default implementation will execute the parts serially. | |
399cec2f | 2182 | * @param count the number of things to execute |
f5bccd85 DB |
2183 | * - encoding: Set by libavcodec, user can override. |
2184 | * - decoding: Set by libavcodec, user can override. | |
9c3d33d6 | 2185 | */ |
3a84713a | 2186 | int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size); |
115329f1 | 2187 | |
9c3d33d6 | 2188 | /** |
f5bccd85 DB |
2189 | * thread opaque |
2190 | * Can be used by execute() to store some per AVCodecContext stuff. | |
9c3d33d6 MN |
2191 | * - encoding: set by execute() |
2192 | * - decoding: set by execute() | |
2193 | */ | |
2194 | void *thread_opaque; | |
a4d36c11 MN |
2195 | |
2196 | /** | |
f5bccd85 DB |
2197 | * Motion estimation threshold below which no motion estimation is |
2198 | * performed, but instead the user specified motion vectors are used. | |
115329f1 | 2199 | * |
f5bccd85 | 2200 | * - encoding: Set by user. |
f20f8a8b | 2201 | * - decoding: unused |
a4d36c11 | 2202 | */ |
2750b827 | 2203 | int me_threshold; |
f20f8a8b MN |
2204 | |
2205 | /** | |
f5bccd85 DB |
2206 | * Macroblock threshold below which the user specified macroblock types will be used. |
2207 | * - encoding: Set by user. | |
f20f8a8b MN |
2208 | * - decoding: unused |
2209 | */ | |
2210 | int mb_threshold; | |
bf266e19 MN |
2211 | |
2212 | /** | |
f5bccd85 DB |
2213 | * precision of the intra DC coefficient - 8 |
2214 | * - encoding: Set by user. | |
bf266e19 MN |
2215 | * - decoding: unused |
2216 | */ | |
2217 | int intra_dc_precision; | |
d4c5d2ad MN |
2218 | |
2219 | /** | |
f5bccd85 DB |
2220 | * noise vs. sse weight for the nsse comparsion function |
2221 | * - encoding: Set by user. | |
d4c5d2ad MN |
2222 | * - decoding: unused |
2223 | */ | |
2224 | int nsse_weight; | |
0dfd33c3 MN |
2225 | |
2226 | /** | |
f5bccd85 | 2227 | * Number of macroblock rows at the top which are skipped. |
0dfd33c3 | 2228 | * - encoding: unused |
f5bccd85 | 2229 | * - decoding: Set by user. |
0dfd33c3 MN |
2230 | */ |
2231 | int skip_top; | |
2232 | ||
2233 | /** | |
f5bccd85 | 2234 | * Number of macroblock rows at the bottom which are skipped. |
0dfd33c3 | 2235 | * - encoding: unused |
f5bccd85 | 2236 | * - decoding: Set by user. |
0dfd33c3 MN |
2237 | */ |
2238 | int skip_bottom; | |
baced9f5 MN |
2239 | |
2240 | /** | |
2241 | * profile | |
f5bccd85 DB |
2242 | * - encoding: Set by user. |
2243 | * - decoding: Set by libavcodec. | |
baced9f5 MN |
2244 | */ |
2245 | int profile; | |
2246 | #define FF_PROFILE_UNKNOWN -99 | |
aecd0a44 | 2247 | #define FF_PROFILE_RESERVED -100 |
dd0cd3d2 | 2248 | |
4f2c36ac | 2249 | #define FF_PROFILE_AAC_MAIN 0 |
273b0cd3 DB |
2250 | #define FF_PROFILE_AAC_LOW 1 |
2251 | #define FF_PROFILE_AAC_SSR 2 | |
2252 | #define FF_PROFILE_AAC_LTP 3 | |
baced9f5 | 2253 | |
f5a2d285 AH |
2254 | #define FF_PROFILE_DTS 20 |
2255 | #define FF_PROFILE_DTS_ES 30 | |
2256 | #define FF_PROFILE_DTS_96_24 40 | |
2257 | #define FF_PROFILE_DTS_HD_HRA 50 | |
2258 | #define FF_PROFILE_DTS_HD_MA 60 | |
2259 | ||
aecd0a44 BL |
2260 | #define FF_PROFILE_MPEG2_422 0 |
2261 | #define FF_PROFILE_MPEG2_HIGH 1 | |
2262 | #define FF_PROFILE_MPEG2_SS 2 | |
2263 | #define FF_PROFILE_MPEG2_SNR_SCALABLE 3 | |
2264 | #define FF_PROFILE_MPEG2_MAIN 4 | |
2265 | #define FF_PROFILE_MPEG2_SIMPLE 5 | |
2266 | ||
fe9a3fbe JG |
2267 | #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag |
2268 | #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag | |
2269 | ||
2270 | #define FF_PROFILE_H264_BASELINE 66 | |
2271 | #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED) | |
2272 | #define FF_PROFILE_H264_MAIN 77 | |
2273 | #define FF_PROFILE_H264_EXTENDED 88 | |
2274 | #define FF_PROFILE_H264_HIGH 100 | |
2275 | #define FF_PROFILE_H264_HIGH_10 110 | |
2276 | #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA) | |
2277 | #define FF_PROFILE_H264_HIGH_422 122 | |
2278 | #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA) | |
440b6169 | 2279 | #define FF_PROFILE_H264_HIGH_444 144 |
fe9a3fbe JG |
2280 | #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244 |
2281 | #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA) | |
2282 | #define FF_PROFILE_H264_CAVLC_444 44 | |
dd0cd3d2 | 2283 | |
0215006a HL |
2284 | #define FF_PROFILE_VC1_SIMPLE 0 |
2285 | #define FF_PROFILE_VC1_MAIN 1 | |
2286 | #define FF_PROFILE_VC1_COMPLEX 2 | |
2287 | #define FF_PROFILE_VC1_ADVANCED 3 | |
2288 | ||
c4ab43ff TF |
2289 | #define FF_PROFILE_MPEG4_SIMPLE 0 |
2290 | #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1 | |
2291 | #define FF_PROFILE_MPEG4_CORE 2 | |
2292 | #define FF_PROFILE_MPEG4_MAIN 3 | |
2293 | #define FF_PROFILE_MPEG4_N_BIT 4 | |
2294 | #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5 | |
2295 | #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6 | |
2296 | #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7 | |
2297 | #define FF_PROFILE_MPEG4_HYBRID 8 | |
2298 | #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9 | |
2299 | #define FF_PROFILE_MPEG4_CORE_SCALABLE 10 | |
2300 | #define FF_PROFILE_MPEG4_ADVANCED_CODING 11 | |
2301 | #define FF_PROFILE_MPEG4_ADVANCED_CORE 12 | |
2302 | #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13 | |
2303 | #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14 | |
2304 | #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15 | |
2305 | ||
baced9f5 MN |
2306 | /** |
2307 | * level | |
f5bccd85 DB |
2308 | * - encoding: Set by user. |
2309 | * - decoding: Set by libavcodec. | |
baced9f5 MN |
2310 | */ |
2311 | int level; | |
2312 | #define FF_LEVEL_UNKNOWN -99 | |
178fcca8 MN |
2313 | |
2314 | /** | |
f5bccd85 | 2315 | * low resolution decoding, 1-> 1/2 size, 2->1/4 size |
178fcca8 | 2316 | * - encoding: unused |
f5bccd85 | 2317 | * - decoding: Set by user. |
178fcca8 MN |
2318 | */ |
2319 | int lowres; | |
21adafec MN |
2320 | |
2321 | /** | |
dde37293 | 2322 | * Bitstream width / height, may be different from width/height if lowres enabled. |
21adafec | 2323 | * - encoding: unused |
f5bccd85 | 2324 | * - decoding: Set by user before init if known. Codec should override / dynamically change if needed. |
21adafec MN |
2325 | */ |
2326 | int coded_width, coded_height; | |
bbf18b21 MN |
2327 | |
2328 | /** | |
2329 | * frame skip threshold | |
f5bccd85 | 2330 | * - encoding: Set by user. |
bbf18b21 MN |
2331 | * - decoding: unused |
2332 | */ | |
2333 | int frame_skip_threshold; | |
2334 | ||
2335 | /** | |
2336 | * frame skip factor | |
f5bccd85 | 2337 | * - encoding: Set by user. |
bbf18b21 MN |
2338 | * - decoding: unused |
2339 | */ | |
2340 | int frame_skip_factor; | |
0fd6aea1 MN |
2341 | |
2342 | /** | |
2343 | * frame skip exponent | |
f5bccd85 | 2344 | * - encoding: Set by user. |
0fd6aea1 MN |
2345 | * - decoding: unused |
2346 | */ | |
2347 | int frame_skip_exp; | |
2348 | ||
2349 | /** | |
f5bccd85 DB |
2350 | * frame skip comparison function |
2351 | * - encoding: Set by user. | |
0fd6aea1 MN |
2352 | * - decoding: unused |
2353 | */ | |
2354 | int frame_skip_cmp; | |
957c743a CM |
2355 | |
2356 | /** | |
f5bccd85 | 2357 | * Border processing masking, raises the quantizer for mbs on the borders |
957c743a | 2358 | * of the picture. |
f5bccd85 | 2359 | * - encoding: Set by user. |
957c743a CM |
2360 | * - decoding: unused |
2361 | */ | |
2362 | float border_masking; | |
6e0d8c06 MN |
2363 | |
2364 | /** | |
f5bccd85 DB |
2365 | * minimum MB lagrange multipler |
2366 | * - encoding: Set by user. | |
6e0d8c06 MN |
2367 | * - decoding: unused |
2368 | */ | |
2369 | int mb_lmin; | |
2370 | ||
2371 | /** | |
f5bccd85 DB |
2372 | * maximum MB lagrange multipler |
2373 | * - encoding: Set by user. | |
6e0d8c06 MN |
2374 | * - decoding: unused |
2375 | */ | |
2376 | int mb_lmax; | |
09c3e44e MN |
2377 | |
2378 | /** | |
115329f1 | 2379 | * |
f5bccd85 | 2380 | * - encoding: Set by user. |
09c3e44e MN |
2381 | * - decoding: unused |
2382 | */ | |
2383 | int me_penalty_compensation; | |
8c3eba7c MN |
2384 | |
2385 | /** | |
115329f1 | 2386 | * |
8c3eba7c | 2387 | * - encoding: unused |
f5bccd85 | 2388 | * - decoding: Set by user. |
8c3eba7c MN |
2389 | */ |
2390 | enum AVDiscard skip_loop_filter; | |
2391 | ||
2392 | /** | |
115329f1 | 2393 | * |
8c3eba7c | 2394 | * - encoding: unused |
f5bccd85 | 2395 | * - decoding: Set by user. |
8c3eba7c MN |
2396 | */ |
2397 | enum AVDiscard skip_idct; | |
2398 | ||
2399 | /** | |
115329f1 | 2400 | * |
8c3eba7c | 2401 | * - encoding: unused |
f5bccd85 | 2402 | * - decoding: Set by user. |
8c3eba7c MN |
2403 | */ |
2404 | enum AVDiscard skip_frame; | |
316a2ec8 MN |
2405 | |
2406 | /** | |
2407 | * | |
f5bccd85 | 2408 | * - encoding: Set by user. |
316a2ec8 MN |
2409 | * - decoding: unused |
2410 | */ | |
2411 | int bidir_refine; | |
e8501c93 MN |
2412 | |
2413 | /** | |
2414 | * | |
f5bccd85 | 2415 | * - encoding: Set by user. |
e8501c93 MN |
2416 | * - decoding: unused |
2417 | */ | |
2418 | int brd_scale; | |
58f7833e | 2419 | |
58f7833e | 2420 | /** |
f5bccd85 DB |
2421 | * minimum GOP size |
2422 | * - encoding: Set by user. | |
58f7833e RS |
2423 | * - decoding: unused |
2424 | */ | |
2425 | int keyint_min; | |
2426 | ||
2427 | /** | |
2428 | * number of reference frames | |
f5bccd85 | 2429 | * - encoding: Set by user. |
53d55e9e | 2430 | * - decoding: Set by lavc. |
58f7833e RS |
2431 | */ |
2432 | int refs; | |
2433 | ||
2434 | /** | |
2435 | * chroma qp offset from luma | |
f5bccd85 | 2436 | * - encoding: Set by user. |
58f7833e RS |
2437 | * - decoding: unused |
2438 | */ | |
2439 | int chromaoffset; | |
2440 | ||
58f7833e RS |
2441 | /** |
2442 | * trellis RD quantization | |
f5bccd85 | 2443 | * - encoding: Set by user. |
58f7833e RS |
2444 | * - decoding: unused |
2445 | */ | |
2446 | int trellis; | |
2447 | ||
14f0c8e2 | 2448 | /** |
02c164c1 | 2449 | * Audio cutoff bandwidth (0 means "automatic") |
f5bccd85 | 2450 | * - encoding: Set by user. |
14f0c8e2 LA |
2451 | * - decoding: unused |
2452 | */ | |
2453 | int cutoff; | |
39a64e30 CH |
2454 | |
2455 | /** | |
f5bccd85 DB |
2456 | * Multiplied by qscale for each frame and added to scene_change_score. |
2457 | * - encoding: Set by user. | |
39a64e30 CH |
2458 | * - decoding: unused |
2459 | */ | |
2460 | int scenechange_factor; | |
1dd509b1 MN |
2461 | |
2462 | /** | |
2463 | * | |
f5bccd85 DB |
2464 | * Note: Value depends upon the compare function used for fullpel ME. |
2465 | * - encoding: Set by user. | |
1dd509b1 MN |
2466 | * - decoding: unused |
2467 | */ | |
2468 | int mv0_threshold; | |
f9243d34 CH |
2469 | |
2470 | /** | |
58c42af7 | 2471 | * Adjust sensitivity of b_frame_strategy 1. |
f5bccd85 | 2472 | * - encoding: Set by user. |
f9243d34 CH |
2473 | * - decoding: unused |
2474 | */ | |
2475 | int b_sensitivity; | |
a403fc03 JR |
2476 | |
2477 | /** | |
f5bccd85 | 2478 | * - encoding: Set by user. |
a403fc03 JR |
2479 | * - decoding: unused |
2480 | */ | |
2481 | int compression_level; | |
2482 | #define FF_COMPRESSION_DEFAULT -1 | |
2483 | ||
a403fc03 | 2484 | /** |
f5bccd85 DB |
2485 | * - encoding: Set by user. |
2486 | * - decoding: unused | |
a403fc03 | 2487 | */ |
188dea1d | 2488 | int min_prediction_order; |
a403fc03 JR |
2489 | |
2490 | /** | |
f5bccd85 DB |
2491 | * - encoding: Set by user. |
2492 | * - decoding: unused | |
a403fc03 | 2493 | */ |
188dea1d AK |
2494 | int max_prediction_order; |
2495 | ||
80d617f5 BC |
2496 | /** |
2497 | * GOP timecode frame start number, in non drop frame format | |
f5bccd85 DB |
2498 | * - encoding: Set by user. |
2499 | * - decoding: unused | |
80d617f5 BC |
2500 | */ |
2501 | int64_t timecode_frame_start; | |
b1ec601f | 2502 | |
9f5ddd1e | 2503 | #if FF_API_REQUEST_CHANNELS |
b1ec601f | 2504 | /** |
85947156 VS |
2505 | * Decoder should decode to this many channels if it can (0 for default) |
2506 | * - encoding: unused | |
2507 | * - decoding: Set by user. | |
0d72e7d0 | 2508 | * @deprecated Deprecated in favor of request_channel_layout. |
b1ec601f RD |
2509 | */ |
2510 | int request_channels; | |
0d72e7d0 | 2511 | #endif |
1408352a | 2512 | |
79de84f2 MN |
2513 | /** |
2514 | * opaque 64bit number (generally a PTS) that will be reordered and | |
2515 | * output in AVFrame.reordered_opaque | |
81c623fa | 2516 | * @deprecated in favor of pkt_pts |
79de84f2 MN |
2517 | * - encoding: unused |
2518 | * - decoding: Set by user. | |
2519 | */ | |
2520 | int64_t reordered_opaque; | |
312420f3 PR |
2521 | |
2522 | /** | |
2523 | * Bits per sample/pixel of internal libavcodec pixel/sample format. | |
312420f3 PR |
2524 | * - encoding: set by user. |
2525 | * - decoding: set by libavcodec. | |
2526 | */ | |
2527 | int bits_per_raw_sample; | |
0d72e7d0 PR |
2528 | |
2529 | /** | |
2530 | * Audio channel layout. | |
2531 | * - encoding: set by user. | |
2532 | * - decoding: set by libavcodec. | |
2533 | */ | |
cc276c85 | 2534 | uint64_t channel_layout; |
0d72e7d0 PR |
2535 | |
2536 | /** | |
2537 | * Request decoder to use this channel layout if it can (0 for default) | |
2538 | * - encoding: unused | |
2539 | * - decoding: Set by user. | |
2540 | */ | |
cc276c85 | 2541 | uint64_t request_channel_layout; |
3bff4d8b BC |
2542 | |
2543 | /** | |
2544 | * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow. | |
2545 | * - encoding: Set by user. | |
2546 | * - decoding: unused. | |
2547 | */ | |
2548 | float rc_max_available_vbv_use; | |
2549 | ||
2550 | /** | |
2551 | * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow. | |
2552 | * - encoding: Set by user. | |
2553 | * - decoding: unused. | |
2554 | */ | |
2555 | float rc_min_vbv_overflow_use; | |
40e5d31b GB |
2556 | |
2557 | /** | |
2558 | * Hardware accelerator in use | |
2559 | * - encoding: unused. | |
2560 | * - decoding: Set by libavcodec | |
2561 | */ | |
2562 | struct AVHWAccel *hwaccel; | |
3797c74b MN |
2563 | |
2564 | /** | |
2565 | * For some codecs, the time base is closer to the field rate than the frame rate. | |
2566 | * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration | |
2567 | * if no telecine is used ... | |
2568 | * | |
2569 | * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2. | |
2570 | */ | |
2571 | int ticks_per_frame; | |
1aea7018 GB |
2572 | |
2573 | /** | |
2574 | * Hardware accelerator context. | |
2575 | * For some hardware accelerators, a global context needs to be | |
2576 | * provided by the user. In that case, this holds display-dependent | |
43fb279f DB |
2577 | * data Libav cannot instantiate itself. Please refer to the |
2578 | * Libav HW accelerator documentation to know how to fill this | |
1aea7018 GB |
2579 | * is. e.g. for VA API, this is a struct vaapi_context. |
2580 | * - encoding: unused | |
2581 | * - decoding: Set by user | |
2582 | */ | |
2583 | void *hwaccel_context; | |
4ee6a5c1 MN |
2584 | |
2585 | /** | |
2586 | * Chromaticity coordinates of the source primaries. | |
2587 | * - encoding: Set by user | |
2588 | * - decoding: Set by libavcodec | |
2589 | */ | |
2590 | enum AVColorPrimaries color_primaries; | |
2591 | ||
2592 | /** | |
2593 | * Color Transfer Characteristic. | |
2594 | * - encoding: Set by user | |
2595 | * - decoding: Set by libavcodec | |
2596 | */ | |
2597 | enum AVColorTransferCharacteristic color_trc; | |
2598 | ||
2599 | /** | |
2600 | * YUV colorspace type. | |
2601 | * - encoding: Set by user | |
2602 | * - decoding: Set by libavcodec | |
2603 | */ | |
2604 | enum AVColorSpace colorspace; | |
2605 | ||
2606 | /** | |
2607 | * MPEG vs JPEG YUV range. | |
2608 | * - encoding: Set by user | |
2609 | * - decoding: Set by libavcodec | |
2610 | */ | |
2611 | enum AVColorRange color_range; | |
580a7465 DC |
2612 | |
2613 | /** | |
2614 | * This defines the location of chroma samples. | |
2615 | * - encoding: Set by user | |
2616 | * - decoding: Set by libavcodec | |
2617 | */ | |
8ea08bec | 2618 | enum AVChromaLocation chroma_sample_location; |
8d23a86f RD |
2619 | |
2620 | /** | |
2621 | * The codec may call this to execute several independent things. | |
2622 | * It will return only after finishing all tasks. | |
2623 | * The user may replace this with some multithreaded implementation, | |
2624 | * the default implementation will execute the parts serially. | |
2625 | * Also see avcodec_thread_init and e.g. the --enable-pthread configure option. | |
2626 | * @param c context passed also to func | |
2627 | * @param count the number of things to execute | |
2628 | * @param arg2 argument passed unchanged to func | |
2629 | * @param ret return values of executed functions, must have space for "count" values. May be NULL. | |
2630 | * @param func function that will be called count times, with jobnr from 0 to count-1. | |
2631 | * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no | |
2632 | * two instances of func executing at the same time will have the same threadnr. | |
2633 | * @return always 0 currently, but code should handle a future improvement where when any call to func | |
2634 | * returns < 0 no further calls to func may be done and < 0 is returned. | |
2635 | * - encoding: Set by libavcodec, user can override. | |
2636 | * - decoding: Set by libavcodec, user can override. | |
2637 | */ | |
2638 | int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count); | |
096c87f6 | 2639 | |
fecd7b45 | 2640 | int log_level_offset; |
23940f14 | 2641 | |
2aa72ecc JZ |
2642 | /** |
2643 | * Number of slices. | |
2644 | * Indicates number of picture subdivisions. Used for parallelized | |
2645 | * decoding. | |
2646 | * - encoding: Set by user | |
2647 | * - decoding: unused | |
2648 | */ | |
2649 | int slices; | |
cb2c971d AJ |
2650 | |
2651 | /** | |
2652 | * Header containing style information for text subtitles. | |
2653 | * For SUBTITLE_ASS subtitle type, it should contain the whole ASS | |
2654 | * [Script Info] and [V4+ Styles] section, plus the [Events] line and | |
2655 | * the Format line following. It shouldn't include any Dialogue line. | |
488eec10 AK |
2656 | * - encoding: Set/allocated/freed by user (before avcodec_open2()) |
2657 | * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2()) | |
cb2c971d AJ |
2658 | */ |
2659 | uint8_t *subtitle_header; | |
2660 | int subtitle_header_size; | |
393cbb96 MN |
2661 | |
2662 | /** | |
2663 | * Current packet as passed into the decoder, to avoid having | |
2664 | * to pass the packet into every function. Currently only valid | |
2665 | * inside lavc and get/release_buffer callbacks. | |
2666 | * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts | |
2667 | * - encoding: unused | |
2668 | */ | |
2669 | AVPacket *pkt; | |
37b00b47 | 2670 | |
37b00b47 AS |
2671 | /** |
2672 | * Which multithreading methods to use. | |
2673 | * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread, | |
2674 | * so clients which cannot provide future frames should not use it. | |
2675 | * | |
2676 | * - encoding: Set by user, otherwise the default is used. | |
2677 | * - decoding: Set by user, otherwise the default is used. | |
2678 | */ | |
2679 | int thread_type; | |
02494787 DB |
2680 | #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once |
2681 | #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once | |
37b00b47 AS |
2682 | |
2683 | /** | |
2684 | * Which multithreading methods are in use by the codec. | |
2685 | * - encoding: Set by libavcodec. | |
2686 | * - decoding: Set by libavcodec. | |
2687 | */ | |
2688 | int active_thread_type; | |
2689 | ||
2690 | /** | |
2691 | * Set by the client if its custom get_buffer() callback can be called | |
2692 | * from another thread, which allows faster multithreaded decoding. | |
2693 | * draw_horiz_band() will be called from other threads regardless of this setting. | |
2694 | * Ignored if the default get_buffer() is used. | |
2695 | * - encoding: Set by user. | |
2696 | * - decoding: Set by user. | |
2697 | */ | |
2698 | int thread_safe_callbacks; | |
55bad0c6 CM |
2699 | |
2700 | /** | |
2701 | * VBV delay coded in the last frame (in periods of a 27 MHz clock). | |
2702 | * Used for compliant TS muxing. | |
2703 | * - encoding: Set by libavcodec. | |
2704 | * - decoding: unused. | |
2705 | */ | |
2706 | uint64_t vbv_delay; | |
34b47d7c JR |
2707 | |
2708 | /** | |
2709 | * Type of service that the audio stream conveys. | |
2710 | * - encoding: Set by user. | |
2711 | * - decoding: Set by libavcodec. | |
2712 | */ | |
2713 | enum AVAudioServiceType audio_service_type; | |
64150ff0 JR |
2714 | |
2715 | /** | |
2716 | * Used to request a sample format from the decoder. | |
2717 | * - encoding: unused. | |
2718 | * - decoding: Set by user. | |
2719 | */ | |
2720 | enum AVSampleFormat request_sample_fmt; | |
582f2311 DB |
2721 | |
2722 | /** | |
2723 | * Error recognition; may misdetect some more or less valid parts as errors. | |
2724 | * - encoding: unused | |
2725 | * - decoding: Set by user. | |
2726 | */ | |
204e6132 | 2727 | int err_recognition; |
6b1f93fa DB |
2728 | #define AV_EF_CRCCHECK (1<<0) |
2729 | #define AV_EF_BITSTREAM (1<<1) | |
2730 | #define AV_EF_BUFFER (1<<2) | |
2731 | #define AV_EF_EXPLODE (1<<3) | |
f3a29b75 JR |
2732 | |
2733 | /** | |
2734 | * Private context used for internal data. | |
2735 | * | |
2736 | * Unlike priv_data, this is not codec-specific. It is used in general | |
2737 | * libavcodec functions. | |
2738 | */ | |
2739 | struct AVCodecInternal *internal; | |
4bf3c8f2 AC |
2740 | |
2741 | /** Field order | |
2742 | * - encoding: set by libavcodec | |
2743 | * - decoding: Set by libavcodec | |
2744 | */ | |
2745 | enum AVFieldOrder field_order; | |
de6d9b64 FB |
2746 | } AVCodecContext; |
2747 | ||
64863965 | 2748 | /** |
060ec0a8 AH |
2749 | * AVProfile. |
2750 | */ | |
2751 | typedef struct AVProfile { | |
2752 | int profile; | |
2753 | const char *name; ///< short name for the profile | |
2754 | } AVProfile; | |
2755 | ||
84626b36 AK |
2756 | typedef struct AVCodecDefault AVCodecDefault; |
2757 | ||
060ec0a8 | 2758 | /** |
64863965 MN |
2759 | * AVCodec. |
2760 | */ | |
de6d9b64 | 2761 | typedef struct AVCodec { |
6b0cdb6e NG |
2762 | /** |
2763 | * Name of the codec implementation. | |
2764 | * The name is globally unique among encoders and among decoders (but an | |
2765 | * encoder and a decoder can share the same name). | |
2766 | * This is the primary way to find a codec from the user perspective. | |
2767 | */ | |
18f77016 | 2768 | const char *name; |
f5f49a66 AK |
2769 | /** |
2770 | * Descriptive name for the codec, meant to be more human readable than name. | |
2771 | * You should use the NULL_IF_CONFIG_SMALL() macro to define it. | |
2772 | */ | |
2773 | const char *long_name; | |
72415b2a | 2774 | enum AVMediaType type; |
9297ddd3 | 2775 | enum CodecID id; |
a2d11246 MN |
2776 | /** |
2777 | * Codec capabilities. | |
2778 | * see CODEC_CAP_* | |
2779 | */ | |
bf89e6b1 | 2780 | int capabilities; |
716e31ea | 2781 | const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0} |
1beb670a | 2782 | const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1 |
3ade5d56 | 2783 | const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0 |
5d6e4c16 | 2784 | const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1 |
cc276c85 | 2785 | const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0 |
0fd0ef79 | 2786 | uint8_t max_lowres; ///< maximum value for lowres supported by the decoder |
567ad0e3 | 2787 | const AVClass *priv_class; ///< AVClass for the private context |
060ec0a8 | 2788 | const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN} |
37b00b47 | 2789 | |
f5f49a66 AK |
2790 | /***************************************************************** |
2791 | * No fields below this line are part of the public API. They | |
2792 | * may not be used outside of libavcodec and can be changed and | |
2793 | * removed at will. | |
2794 | * New public fields should be added right above. | |
2795 | ***************************************************************** | |
2796 | */ | |
2797 | int priv_data_size; | |
2798 | struct AVCodec *next; | |
37b00b47 | 2799 | /** |
21a19b79 | 2800 | * @name Frame-level threading support functions |
37b00b47 AS |
2801 | * @{ |
2802 | */ | |
2803 | /** | |
2804 | * If defined, called on thread contexts when they are created. | |
2805 | * If the codec allocates writable tables in init(), re-allocate them here. | |
2806 | * priv_data will be set to a copy of the original. | |
2807 | */ | |
2808 | int (*init_thread_copy)(AVCodecContext *); | |
2809 | /** | |
2810 | * Copy necessary context variables from a previous thread context to the current one. | |
2811 | * If not defined, the next thread will start automatically; otherwise, the codec | |
2812 | * must call ff_thread_finish_setup(). | |
2813 | * | |
2814 | * dst and src will (rarely) point to the same context, in which case memcpy should be skipped. | |
2815 | */ | |
2816 | int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src); | |
2817 | /** @} */ | |
84626b36 AK |
2818 | |
2819 | /** | |
2820 | * Private codec-specific defaults. | |
2821 | */ | |
2822 | const AVCodecDefault *defaults; | |
d97efd7f AK |
2823 | |
2824 | /** | |
2825 | * Initialize codec static data, called from avcodec_register(). | |
2826 | */ | |
2827 | void (*init_static_data)(struct AVCodec *codec); | |
b2c75b6e | 2828 | |
f5f49a66 AK |
2829 | int (*init)(AVCodecContext *); |
2830 | int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data); | |
b2c75b6e JR |
2831 | /** |
2832 | * Encode data to an AVPacket. | |
2833 | * | |
2834 | * @param avctx codec context | |
2835 | * @param avpkt output AVPacket (may contain a user-provided buffer) | |
2836 | * @param[in] frame AVFrame containing the raw data to be encoded | |
2837 | * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a | |
2838 | * non-empty packet was returned in avpkt. | |
2839 | * @return 0 on success, negative error code on failure | |
2840 | */ | |
2841 | int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, | |
2842 | int *got_packet_ptr); | |
f5f49a66 AK |
2843 | int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt); |
2844 | int (*close)(AVCodecContext *); | |
2845 | /** | |
2846 | * Flush buffers. | |
2847 | * Will be called when seeking | |
2848 | */ | |
2849 | void (*flush)(AVCodecContext *); | |
de6d9b64 FB |
2850 | } AVCodec; |
2851 | ||
97d96aaa | 2852 | /** |
40e5d31b GB |
2853 | * AVHWAccel. |
2854 | */ | |
2855 | typedef struct AVHWAccel { | |
2856 | /** | |
2857 | * Name of the hardware accelerated codec. | |
2858 | * The name is globally unique among encoders and among decoders (but an | |
2859 | * encoder and a decoder can share the same name). | |
2860 | */ | |
2861 | const char *name; | |
2862 | ||
2863 | /** | |
2864 | * Type of codec implemented by the hardware accelerator. | |
2865 | * | |
72415b2a | 2866 | * See AVMEDIA_TYPE_xxx |
40e5d31b | 2867 | */ |
72415b2a | 2868 | enum AVMediaType type; |
40e5d31b GB |
2869 | |
2870 | /** | |
2871 | * Codec implemented by the hardware accelerator. | |
2872 | * | |
2873 | * See CODEC_ID_xxx | |
2874 | */ | |
2875 | enum CodecID id; | |
2876 | ||
2877 | /** | |
2878 | * Supported pixel format. | |
2879 | * | |
2880 | * Only hardware accelerated formats are supported here. | |
2881 | */ | |
2882 | enum PixelFormat pix_fmt; | |
2883 | ||
2884 | /** | |
2885 | * Hardware accelerated codec capabilities. | |
2886 | * see FF_HWACCEL_CODEC_CAP_* | |
2887 | */ | |
2888 | int capabilities; | |
2889 | ||
2890 | struct AVHWAccel *next; | |
2891 | ||
2892 | /** | |
2893 | * Called at the beginning of each frame or field picture. | |
2894 | * | |
2895 | * Meaningful frame information (codec specific) is guaranteed to | |
2896 | * be parsed at this point. This function is mandatory. | |
2897 | * | |
bf7e799c | 2898 | * Note that buf can be NULL along with buf_size set to 0. |
40e5d31b GB |
2899 | * Otherwise, this means the whole frame is available at this point. |
2900 | * | |
2901 | * @param avctx the codec context | |
2902 | * @param buf the frame data buffer base | |
2903 | * @param buf_size the size of the frame in bytes | |
2904 | * @return zero if successful, a negative value otherwise | |
2905 | */ | |
2906 | int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); | |
2907 | ||
2908 | /** | |
2909 | * Callback for each slice. | |
2910 | * | |
2911 | * Meaningful slice information (codec specific) is guaranteed to | |
2912 | * be parsed at this point. This function is mandatory. | |
2913 | * | |
2914 | * @param avctx the codec context | |
2915 | * @param buf the slice data buffer base | |
2916 | * @param buf_size the size of the slice in bytes | |
2917 | * @return zero if successful, a negative value otherwise | |
2918 | */ | |
2919 | int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); | |
2920 | ||
2921 | /** | |
2922 | * Called at the end of each frame or field picture. | |
2923 | * | |
2924 | * The whole picture is parsed at this point and can now be sent | |
2925 | * to the hardware accelerator. This function is mandatory. | |
2926 | * | |
2927 | * @param avctx the codec context | |
2928 | * @return zero if successful, a negative value otherwise | |
2929 | */ | |
2930 | int (*end_frame)(AVCodecContext *avctx); | |
68e5d523 GB |
2931 | |
2932 | /** | |
2933 | * Size of HW accelerator private data. | |
2934 | * | |
cd823ff9 GB |
2935 | * Private data is allocated with av_mallocz() before |
2936 | * AVCodecContext.get_buffer() and deallocated after | |
2937 | * AVCodecContext.release_buffer(). | |
68e5d523 GB |
2938 | */ |
2939 | int priv_data_size; | |
40e5d31b GB |
2940 | } AVHWAccel; |
2941 | ||
2942 | /** | |
d7425f59 MN |
2943 | * four components are given, that's all. |
2944 | * the last component is alpha | |
2945 | */ | |
de6d9b64 | 2946 | typedef struct AVPicture { |
560f773c JR |
2947 | uint8_t *data[AV_NUM_DATA_POINTERS]; |
2948 | int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line | |
de6d9b64 FB |
2949 | } AVPicture; |
2950 | ||
63e4c8a6 AK |
2951 | #define AVPALETTE_SIZE 1024 |
2952 | #define AVPALETTE_COUNT 256 | |
ba118447 | 2953 | |
c66216ed MN |
2954 | enum AVSubtitleType { |
2955 | SUBTITLE_NONE, | |
2956 | ||
2957 | SUBTITLE_BITMAP, ///< A bitmap, pict will be set | |
2958 | ||
2959 | /** | |
2960 | * Plain text, the text field must be set by the decoder and is | |
2961 | * authoritative. ass and pict fields may contain approximations. | |
2962 | */ | |
2963 | SUBTITLE_TEXT, | |
2964 | ||
2965 | /** | |
2966 | * Formatted text, the ass field must be set by the decoder and is | |
2967 | * authoritative. pict and text fields may contain approximations. | |
2968 | */ | |
2969 | SUBTITLE_ASS, | |
2970 | }; | |
2971 | ||
c6ec28b1 | 2972 | typedef struct AVSubtitleRect { |
ebc466bb MN |
2973 | int x; ///< top left corner of pict, undefined when pict is not set |
2974 | int y; ///< top left corner of pict, undefined when pict is not set | |
2975 | int w; ///< width of pict, undefined when pict is not set | |
2976 | int h; ///< height of pict, undefined when pict is not set | |
2977 | int nb_colors; ///< number of colors in pict, undefined when pict is not set | |
25b4c651 MN |
2978 | |
2979 | /** | |
2980 | * data+linesize for the bitmap of this subtitle. | |
2981 | * can be set for text/ass as well once they where rendered | |
2982 | */ | |
2983 | AVPicture pict; | |
f656106f MN |
2984 | enum AVSubtitleType type; |
2985 | ||
2986 | char *text; ///< 0 terminated plain UTF-8 text | |
2987 | ||
2988 | /** | |
2989 | * 0 terminated ASS/SSA compatible event line. | |
2990 | * The pressentation of this is unaffected by the other values in this | |
2991 | * struct. | |
2992 | */ | |
2993 | char *ass; | |
c6ec28b1 MN |
2994 | } AVSubtitleRect; |
2995 | ||
2996 | typedef struct AVSubtitle { | |
2997 | uint16_t format; /* 0 = graphics */ | |
2998 | uint32_t start_display_time; /* relative to packet pts, in ms */ | |
2999 | uint32_t end_display_time; /* relative to packet pts, in ms */ | |
ebc466bb | 3000 | unsigned num_rects; |
db4fac64 | 3001 | AVSubtitleRect **rects; |
4bbe788a | 3002 | int64_t pts; ///< Same as packet pts, in AV_TIME_BASE |
240c1657 FB |
3003 | } AVSubtitle; |
3004 | ||
cdd8930e TB |
3005 | /* packet functions */ |
3006 | ||
80d403fc RD |
3007 | /** |
3008 | * @deprecated use NULL instead | |
3009 | */ | |
3010 | attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt); | |
cdd8930e TB |
3011 | |
3012 | /** | |
3013 | * Default packet destructor. | |
3014 | */ | |
3015 | void av_destruct_packet(AVPacket *pkt); | |
3016 | ||
3017 | /** | |
3018 | * Initialize optional fields of a packet with default values. | |
3019 | * | |
3020 | * @param pkt packet | |
3021 | */ | |
3022 | void av_init_packet(AVPacket *pkt); | |
3023 | ||
3024 | /** | |
3025 | * Allocate the payload of a packet and initialize its fields with | |
3026 | * default values. | |
3027 | * | |
3028 | * @param pkt packet | |
3029 | * @param size wanted payload size | |
3030 | * @return 0 if OK, AVERROR_xxx otherwise | |
3031 | */ | |
3032 | int av_new_packet(AVPacket *pkt, int size); | |
3033 | ||
3034 | /** | |
feb993e5 RD |
3035 | * Reduce packet size, correctly zeroing padding |
3036 | * | |
3037 | * @param pkt packet | |
3038 | * @param size new size | |
3039 | */ | |
3040 | void av_shrink_packet(AVPacket *pkt, int size); | |
3041 | ||
3042 | /** | |
a08d918e RD |
3043 | * Increase packet size, correctly zeroing padding |
3044 | * | |
3045 | * @param pkt packet | |
3046 | * @param grow_by number of bytes by which to increase the size of the packet | |
3047 | */ | |
3048 | int av_grow_packet(AVPacket *pkt, int grow_by); | |
3049 | ||
3050 | /** | |
cdd8930e TB |
3051 | * @warning This is a hack - the packet memory allocation stuff is broken. The |
3052 | * packet is allocated if it was not really allocated. | |
3053 | */ | |
3054 | int av_dup_packet(AVPacket *pkt); | |
3055 | ||
3056 | /** | |
3057 | * Free a packet. | |
3058 | * | |
3059 | * @param pkt packet to free | |
3060 | */ | |
ce1d9c85 | 3061 | void av_free_packet(AVPacket *pkt); |
240c1657 | 3062 | |
4de339e2 KS |
3063 | /** |
3064 | * Allocate new information of a packet. | |
3065 | * | |
3066 | * @param pkt packet | |
3067 | * @param type side information type | |
3068 | * @param size side information size | |
3069 | * @return pointer to fresh allocated data or NULL otherwise | |
3070 | */ | |
3071 | uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, | |
3072 | int size); | |
3073 | ||
3074 | /** | |
3075 | * Get side information from packet. | |
3076 | * | |
3077 | * @param pkt packet | |
3078 | * @param type desired side information type | |
3079 | * @param size pointer for side information size to store (optional) | |
3080 | * @return pointer to data if present or NULL otherwise | |
3081 | */ | |
3082 | uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type, | |
3083 | int *size); | |
3084 | ||
de6d9b64 FB |
3085 | /* resample.c */ |
3086 | ||
3087 | struct ReSampleContext; | |
aaaf1635 | 3088 | struct AVResampleContext; |
de6d9b64 FB |
3089 | |
3090 | typedef struct ReSampleContext ReSampleContext; | |
3091 | ||
d1e3c6fd | 3092 | /** |
54955283 | 3093 | * Initialize audio resampling context. |
d1e3c6fd BC |
3094 | * |
3095 | * @param output_channels number of output channels | |
3096 | * @param input_channels number of input channels | |
3097 | * @param output_rate output sample rate | |
3098 | * @param input_rate input sample rate | |
3099 | * @param sample_fmt_out requested output sample format | |
3100 | * @param sample_fmt_in input sample format | |
54955283 | 3101 | * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency |
d1e3c6fd | 3102 | * @param log2_phase_count log2 of the number of entries in the polyphase filterbank |
54955283 | 3103 | * @param linear if 1 then the used FIR filter will be linearly interpolated |
d1e3c6fd BC |
3104 | between the 2 closest, if 0 the closest will be used |
3105 | * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate | |
da9cea77 | 3106 | * @return allocated ReSampleContext, NULL if error occurred |
d1e3c6fd BC |
3107 | */ |
3108 | ReSampleContext *av_audio_resample_init(int output_channels, int input_channels, | |
3109 | int output_rate, int input_rate, | |
5d6e4c16 SS |
3110 | enum AVSampleFormat sample_fmt_out, |
3111 | enum AVSampleFormat sample_fmt_in, | |
d1e3c6fd BC |
3112 | int filter_length, int log2_phase_count, |
3113 | int linear, double cutoff); | |
3114 | ||
de6d9b64 | 3115 | int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples); |
938b6253 SS |
3116 | |
3117 | /** | |
3118 | * Free resample context. | |
3119 | * | |
3120 | * @param s a non-NULL pointer to a resample context previously | |
3121 | * created with av_audio_resample_init() | |
3122 | */ | |
de6d9b64 FB |
3123 | void audio_resample_close(ReSampleContext *s); |
3124 | ||
3136fcf4 MN |
3125 | |
3126 | /** | |
49bd8e4b | 3127 | * Initialize an audio resampler. |
3136fcf4 | 3128 | * Note, if either rate is not an integer then simply scale both rates up so they are. |
990058bd MN |
3129 | * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq |
3130 | * @param log2_phase_count log2 of the number of entries in the polyphase filterbank | |
3131 | * @param linear If 1 then the used FIR filter will be linearly interpolated | |
3132 | between the 2 closest, if 0 the closest will be used | |
3133 | * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate | |
3136fcf4 | 3134 | */ |
6e225de2 | 3135 | struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff); |
3136fcf4 MN |
3136 | |
3137 | /** | |
1782460b | 3138 | * Resample an array of samples using a previously configured context. |
3136fcf4 MN |
3139 | * @param src an array of unconsumed samples |
3140 | * @param consumed the number of samples of src which have been consumed are returned here | |
3141 | * @param src_size the number of unconsumed samples available | |
3142 | * @param dst_size the amount of space in samples available in dst | |
3143 | * @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. | |
3144 | * @return the number of samples written in dst or -1 if an error occurred | |
3145 | */ | |
aaaf1635 | 3146 | int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx); |
3136fcf4 MN |
3147 | |
3148 | ||
3149 | /** | |
49bd8e4b | 3150 | * Compensate samplerate/timestamp drift. The compensation is done by changing |
3136fcf4 MN |
3151 | * the resampler parameters, so no audible clicks or similar distortions occur |
3152 | * @param compensation_distance distance in output samples over which the compensation should be performed | |
3153 | * @param sample_delta number of output samples which should be output less | |
3154 | * | |
3155 | * example: av_resample_compensate(c, 10, 500) | |
3156 | * here instead of 510 samples only 500 samples would be output | |
3157 | * | |
3158 | * note, due to rounding the actual compensation might be slightly different, | |
3159 | * especially if the compensation_distance is large and the in_rate used during init is small | |
3160 | */ | |
2d48eddd | 3161 | void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance); |
d88443ae | 3162 | void av_resample_close(struct AVResampleContext *c); |
aaaf1635 | 3163 | |
75917b88 | 3164 | /** |
3de33b00 WL |
3165 | * Allocate memory for a picture. Call avpicture_free() to free it. |
3166 | * | |
adbfc605 | 3167 | * @see avpicture_fill() |
75917b88 | 3168 | * |
f5bccd85 DB |
3169 | * @param picture the picture to be filled in |
3170 | * @param pix_fmt the format of the picture | |
3171 | * @param width the width of the picture | |
3172 | * @param height the height of the picture | |
3173 | * @return zero if successful, a negative value if not | |
75917b88 | 3174 | */ |
a61ec8e7 | 3175 | int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height); |
75917b88 | 3176 | |
8fc3d25c PI |
3177 | /** |
3178 | * Free a picture previously allocated by avpicture_alloc(). | |
3de33b00 WL |
3179 | * The data buffer used by the AVPicture is freed, but the AVPicture structure |
3180 | * itself is not. | |
8fc3d25c | 3181 | * |
f5bccd85 | 3182 | * @param picture the AVPicture to be freed |
8fc3d25c | 3183 | */ |
75917b88 DH |
3184 | void avpicture_free(AVPicture *picture); |
3185 | ||
392cf77a | 3186 | /** |
f5bccd85 | 3187 | * Fill in the AVPicture fields. |
392cf77a PI |
3188 | * The fields of the given AVPicture are filled in by using the 'ptr' address |
3189 | * which points to the image data buffer. Depending on the specified picture | |
3190 | * format, one or multiple image data pointers and line sizes will be set. | |
3191 | * If a planar format is specified, several pointers will be set pointing to | |
3192 | * the different picture planes and the line sizes of the different planes | |
3193 | * will be stored in the lines_sizes array. | |
899a8fa1 | 3194 | * Call with ptr == NULL to get the required size for the ptr buffer. |
392cf77a | 3195 | * |
3de33b00 WL |
3196 | * To allocate the buffer and fill in the AVPicture fields in one call, |
3197 | * use avpicture_alloc(). | |
3198 | * | |
f5bccd85 | 3199 | * @param picture AVPicture whose fields are to be filled in |
392cf77a | 3200 | * @param ptr Buffer which will contain or contains the actual image data |
f5bccd85 DB |
3201 | * @param pix_fmt The format in which the picture data is stored. |
3202 | * @param width the width of the image in pixels | |
3203 | * @param height the height of the image in pixels | |
3204 | * @return size of the image data in bytes | |
392cf77a | 3205 | */ |
0c1a9eda | 3206 | int avpicture_fill(AVPicture *picture, uint8_t *ptr, |
4a30fff6 | 3207 | enum PixelFormat pix_fmt, int width, int height); |
3de33b00 WL |
3208 | |
3209 | /** | |
3210 | * Copy pixel data from an AVPicture into a buffer. | |
3211 | * The data is stored compactly, without any gaps for alignment or padding | |
3212 | * which may be applied by avpicture_fill(). | |
3213 | * | |
adbfc605 | 3214 | * @see avpicture_get_size() |
3de33b00 WL |
3215 | * |
3216 | * @param[in] src AVPicture containing image data | |
3217 | * @param[in] pix_fmt The format in which the picture data is stored. | |
3218 | * @param[in] width the width of the image in pixels. | |
3219 | * @param[in] height the height of the image in pixels. | |
3220 | * @param[out] dest A buffer into which picture data will be copied. | |
3221 | * @param[in] dest_size The size of 'dest'. | |
3222 | * @return The number of bytes written to dest, or a negative value (error code) on error. | |
3223 | */ | |
a61ec8e7 | 3224 | int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height, |
63167088 | 3225 | unsigned char *dest, int dest_size); |
392cf77a PI |
3226 | |
3227 | /** | |
3228 | * Calculate the size in bytes that a picture of the given width and height | |
3229 | * would occupy if stored in the given picture format. | |
899a8fa1 | 3230 | * Note that this returns the size of a compact representation as generated |
3de33b00 WL |
3231 | * by avpicture_layout(), which can be smaller than the size required for e.g. |
3232 | * avpicture_fill(). | |
392cf77a | 3233 | * |
f5bccd85 DB |
3234 | * @param pix_fmt the given picture format |
3235 | * @param width the width of the image | |
3236 | * @param height the height of the image | |
899a8fa1 | 3237 | * @return Image data size in bytes or -1 on error (e.g. too large dimensions). |
392cf77a | 3238 | */ |
a61ec8e7 |