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 |
f0cebf51 AK |
26 | * @ingroup libavc |
27 | * Libavcodec external API header | |
36df8805 MN |
28 | */ |
29 | ||
c60208e7 | 30 | #include <errno.h> |
737eb597 | 31 | #include "libavutil/samplefmt.h" |
bf4b0ed1 | 32 | #include "libavutil/attributes.h" |
76a448ed | 33 | #include "libavutil/avutil.h" |
1afddbe5 | 34 | #include "libavutil/buffer.h" |
7160bb71 | 35 | #include "libavutil/cpu.h" |
0b950fe2 | 36 | #include "libavutil/dict.h" |
7ecc2d40 | 37 | #include "libavutil/frame.h" |
abc78a5a | 38 | #include "libavutil/log.h" |
d49ea4af | 39 | #include "libavutil/pixfmt.h" |
e91709ca | 40 | #include "libavutil/rational.h" |
de6d9b64 | 41 | |
a0b901a3 DB |
42 | #include "version.h" |
43 | ||
6f1ec8ed VG |
44 | #if FF_API_FAST_MALLOC |
45 | // to provide fast_*alloc | |
46 | #include "libavutil/mem.h" | |
47 | #endif | |
48 | ||
e97e5a2e LB |
49 | /** |
50 | * @defgroup libavc Encoding/Decoding Library | |
51 | * @{ | |
52 | * | |
53 | * @defgroup lavc_decoding Decoding | |
54 | * @{ | |
55 | * @} | |
56 | * | |
57 | * @defgroup lavc_encoding Encoding | |
58 | * @{ | |
59 | * @} | |
60 | * | |
61 | * @defgroup lavc_codec Codecs | |
62 | * @{ | |
63 | * @defgroup lavc_codec_native Native Codecs | |
64 | * @{ | |
65 | * @} | |
66 | * @defgroup lavc_codec_wrappers External library wrappers | |
67 | * @{ | |
68 | * @} | |
69 | * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge | |
70 | * @{ | |
71 | * @} | |
72 | * @} | |
73 | * @defgroup lavc_internal Internal | |
74 | * @{ | |
75 | * @} | |
76 | * @} | |
77 | * | |
78 | */ | |
79 | ||
294b3a50 AK |
80 | /** |
81 | * @defgroup lavc_core Core functions/structures. | |
82 | * @ingroup libavc | |
83 | * | |
84 | * Basic definitions, functions for querying libavcodec capabilities, | |
85 | * allocating core structures, etc. | |
86 | * @{ | |
87 | */ | |
eda7c983 | 88 | |
104e10fb | 89 | |
7ebf5927 | 90 | /** |
48966b02 | 91 | * Identify the syntax and semantics of the bitstream. |
6b0cdb6e NG |
92 | * The principle is roughly: |
93 | * Two decoders with the same ID can decode the same streams. | |
94 | * Two encoders with the same ID can encode compatible streams. | |
95 | * There may be slight deviations from the principle due to implementation | |
96 | * details. | |
7ebf5927 | 97 | * |
f5bccd85 DB |
98 | * If you add a codec ID to this list, add it so that |
99 | * 1. no value of a existing codec ID changes (that would break ABI), | |
100 | * 2. it is as close as possible to similar codecs. | |
bbabeb56 AK |
101 | * |
102 | * After adding new codec IDs, do not forget to add an entry to the codec | |
103 | * descriptor list and bump libavcodec minor version. | |
7ebf5927 | 104 | */ |
104e10fb AK |
105 | enum AVCodecID { |
106 | AV_CODEC_ID_NONE, | |
ba0dabbf DB |
107 | |
108 | /* video codecs */ | |
104e10fb AK |
109 | AV_CODEC_ID_MPEG1VIDEO, |
110 | AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding | |
19e30a58 | 111 | #if FF_API_XVMC |
104e10fb | 112 | AV_CODEC_ID_MPEG2VIDEO_XVMC, |
19e30a58 | 113 | #endif /* FF_API_XVMC */ |
104e10fb AK |
114 | AV_CODEC_ID_H261, |
115 | AV_CODEC_ID_H263, | |
116 | AV_CODEC_ID_RV10, | |
117 | AV_CODEC_ID_RV20, | |
118 | AV_CODEC_ID_MJPEG, | |
119 | AV_CODEC_ID_MJPEGB, | |
120 | AV_CODEC_ID_LJPEG, | |
121 | AV_CODEC_ID_SP5X, | |
122 | AV_CODEC_ID_JPEGLS, | |
123 | AV_CODEC_ID_MPEG4, | |
124 | AV_CODEC_ID_RAWVIDEO, | |
125 | AV_CODEC_ID_MSMPEG4V1, | |
126 | AV_CODEC_ID_MSMPEG4V2, | |
127 | AV_CODEC_ID_MSMPEG4V3, | |
128 | AV_CODEC_ID_WMV1, | |
129 | AV_CODEC_ID_WMV2, | |
130 | AV_CODEC_ID_H263P, | |
131 | AV_CODEC_ID_H263I, | |
132 | AV_CODEC_ID_FLV1, | |
133 | AV_CODEC_ID_SVQ1, | |
134 | AV_CODEC_ID_SVQ3, | |
135 | AV_CODEC_ID_DVVIDEO, | |
136 | AV_CODEC_ID_HUFFYUV, | |
137 | AV_CODEC_ID_CYUV, | |
138 | AV_CODEC_ID_H264, | |
139 | AV_CODEC_ID_INDEO3, | |
140 | AV_CODEC_ID_VP3, | |
141 | AV_CODEC_ID_THEORA, | |
142 | AV_CODEC_ID_ASV1, | |
143 | AV_CODEC_ID_ASV2, | |
144 | AV_CODEC_ID_FFV1, | |
145 | AV_CODEC_ID_4XM, | |
146 | AV_CODEC_ID_VCR1, | |
147 | AV_CODEC_ID_CLJR, | |
148 | AV_CODEC_ID_MDEC, | |
149 | AV_CODEC_ID_ROQ, | |
150 | AV_CODEC_ID_INTERPLAY_VIDEO, | |
151 | AV_CODEC_ID_XAN_WC3, | |
152 | AV_CODEC_ID_XAN_WC4, | |
153 | AV_CODEC_ID_RPZA, | |
154 | AV_CODEC_ID_CINEPAK, | |
155 | AV_CODEC_ID_WS_VQA, | |
156 | AV_CODEC_ID_MSRLE, | |
157 | AV_CODEC_ID_MSVIDEO1, | |
158 | AV_CODEC_ID_IDCIN, | |
159 | AV_CODEC_ID_8BPS, | |
160 | AV_CODEC_ID_SMC, | |
161 | AV_CODEC_ID_FLIC, | |
162 | AV_CODEC_ID_TRUEMOTION1, | |
163 | AV_CODEC_ID_VMDVIDEO, | |
164 | AV_CODEC_ID_MSZH, | |
165 | AV_CODEC_ID_ZLIB, | |
166 | AV_CODEC_ID_QTRLE, | |
104e10fb AK |
167 | AV_CODEC_ID_TSCC, |
168 | AV_CODEC_ID_ULTI, | |
169 | AV_CODEC_ID_QDRAW, | |
170 | AV_CODEC_ID_VIXL, | |
171 | AV_CODEC_ID_QPEG, | |
172 | AV_CODEC_ID_PNG, | |
173 | AV_CODEC_ID_PPM, | |
174 | AV_CODEC_ID_PBM, | |
175 | AV_CODEC_ID_PGM, | |
176 | AV_CODEC_ID_PGMYUV, | |
177 | AV_CODEC_ID_PAM, | |
178 | AV_CODEC_ID_FFVHUFF, | |
179 | AV_CODEC_ID_RV30, | |
180 | AV_CODEC_ID_RV40, | |
181 | AV_CODEC_ID_VC1, | |
182 | AV_CODEC_ID_WMV3, | |
183 | AV_CODEC_ID_LOCO, | |
184 | AV_CODEC_ID_WNV1, | |
185 | AV_CODEC_ID_AASC, | |
186 | AV_CODEC_ID_INDEO2, | |
187 | AV_CODEC_ID_FRAPS, | |
188 | AV_CODEC_ID_TRUEMOTION2, | |
189 | AV_CODEC_ID_BMP, | |
190 | AV_CODEC_ID_CSCD, | |
191 | AV_CODEC_ID_MMVIDEO, | |
192 | AV_CODEC_ID_ZMBV, | |
193 | AV_CODEC_ID_AVS, | |
194 | AV_CODEC_ID_SMACKVIDEO, | |
195 | AV_CODEC_ID_NUV, | |
196 | AV_CODEC_ID_KMVC, | |
197 | AV_CODEC_ID_FLASHSV, | |
198 | AV_CODEC_ID_CAVS, | |
199 | AV_CODEC_ID_JPEG2000, | |
200 | AV_CODEC_ID_VMNC, | |
201 | AV_CODEC_ID_VP5, | |
202 | AV_CODEC_ID_VP6, | |
203 | AV_CODEC_ID_VP6F, | |
204 | AV_CODEC_ID_TARGA, | |
205 | AV_CODEC_ID_DSICINVIDEO, | |
206 | AV_CODEC_ID_TIERTEXSEQVIDEO, | |
207 | AV_CODEC_ID_TIFF, | |
208 | AV_CODEC_ID_GIF, | |
209 | AV_CODEC_ID_DXA, | |
210 | AV_CODEC_ID_DNXHD, | |
211 | AV_CODEC_ID_THP, | |
212 | AV_CODEC_ID_SGI, | |
213 | AV_CODEC_ID_C93, | |
214 | AV_CODEC_ID_BETHSOFTVID, | |
215 | AV_CODEC_ID_PTX, | |
216 | AV_CODEC_ID_TXD, | |
217 | AV_CODEC_ID_VP6A, | |
218 | AV_CODEC_ID_AMV, | |
219 | AV_CODEC_ID_VB, | |
220 | AV_CODEC_ID_PCX, | |
221 | AV_CODEC_ID_SUNRAST, | |
222 | AV_CODEC_ID_INDEO4, | |
223 | AV_CODEC_ID_INDEO5, | |
224 | AV_CODEC_ID_MIMIC, | |
225 | AV_CODEC_ID_RL2, | |
226 | AV_CODEC_ID_ESCAPE124, | |
227 | AV_CODEC_ID_DIRAC, | |
228 | AV_CODEC_ID_BFI, | |
229 | AV_CODEC_ID_CMV, | |
230 | AV_CODEC_ID_MOTIONPIXELS, | |
231 | AV_CODEC_ID_TGV, | |
232 | AV_CODEC_ID_TGQ, | |
233 | AV_CODEC_ID_TQI, | |
234 | AV_CODEC_ID_AURA, | |
235 | AV_CODEC_ID_AURA2, | |
236 | AV_CODEC_ID_V210X, | |
237 | AV_CODEC_ID_TMV, | |
238 | AV_CODEC_ID_V210, | |
239 | AV_CODEC_ID_DPX, | |
240 | AV_CODEC_ID_MAD, | |
241 | AV_CODEC_ID_FRWU, | |
242 | AV_CODEC_ID_FLASHSV2, | |
243 | AV_CODEC_ID_CDGRAPHICS, | |
244 | AV_CODEC_ID_R210, | |
245 | AV_CODEC_ID_ANM, | |
246 | AV_CODEC_ID_BINKVIDEO, | |
247 | AV_CODEC_ID_IFF_ILBM, | |
248 | AV_CODEC_ID_IFF_BYTERUN1, | |
249 | AV_CODEC_ID_KGV1, | |
250 | AV_CODEC_ID_YOP, | |
251 | AV_CODEC_ID_VP8, | |
252 | AV_CODEC_ID_PICTOR, | |
253 | AV_CODEC_ID_ANSI, | |
254 | AV_CODEC_ID_A64_MULTI, | |
255 | AV_CODEC_ID_A64_MULTI5, | |
256 | AV_CODEC_ID_R10K, | |
257 | AV_CODEC_ID_MXPEG, | |
258 | AV_CODEC_ID_LAGARITH, | |
259 | AV_CODEC_ID_PRORES, | |
260 | AV_CODEC_ID_JV, | |
261 | AV_CODEC_ID_DFA, | |
262 | AV_CODEC_ID_WMV3IMAGE, | |
263 | AV_CODEC_ID_VC1IMAGE, | |
264 | AV_CODEC_ID_UTVIDEO, | |
265 | AV_CODEC_ID_BMV_VIDEO, | |
266 | AV_CODEC_ID_VBLE, | |
267 | AV_CODEC_ID_DXTORY, | |
268 | AV_CODEC_ID_V410, | |
269 | AV_CODEC_ID_XWD, | |
270 | AV_CODEC_ID_CDXL, | |
271 | AV_CODEC_ID_XBM, | |
272 | AV_CODEC_ID_ZEROCODEC, | |
273 | AV_CODEC_ID_MSS1, | |
274 | AV_CODEC_ID_MSA1, | |
275 | AV_CODEC_ID_TSCC2, | |
276 | AV_CODEC_ID_MTS2, | |
277 | AV_CODEC_ID_CLLC, | |
ee769c6a | 278 | AV_CODEC_ID_MSS2, |
66aabd76 | 279 | AV_CODEC_ID_VP9, |
1232a164 | 280 | AV_CODEC_ID_AIC, |
350914fc | 281 | AV_CODEC_ID_ESCAPE130, |
2d66a58c | 282 | AV_CODEC_ID_G2M, |
c4bfa098 | 283 | AV_CODEC_ID_WEBP, |
9af7a852 | 284 | AV_CODEC_ID_HNM4_VIDEO, |
064698d3 | 285 | AV_CODEC_ID_HEVC, |
cde7df25 | 286 | AV_CODEC_ID_FIC, |
e50f5d3c | 287 | AV_CODEC_ID_ALIAS_PIX, |
ae17878f | 288 | AV_CODEC_ID_BRENDER_PIX, |
70daeacd | 289 | AV_CODEC_ID_PAF_VIDEO, |
38389058 | 290 | AV_CODEC_ID_EXR, |
ac4b32df | 291 | AV_CODEC_ID_VP7, |
a420ccd4 | 292 | AV_CODEC_ID_SANM, |
07761294 | 293 | AV_CODEC_ID_SGIRLE, |
86a04326 PR |
294 | AV_CODEC_ID_MVC1, |
295 | AV_CODEC_ID_MVC2, | |
40c5ee99 | 296 | |
f5bccd85 | 297 | /* various PCM "codecs" */ |
104e10fb AK |
298 | AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs |
299 | AV_CODEC_ID_PCM_S16LE = 0x10000, | |
300 | AV_CODEC_ID_PCM_S16BE, | |
301 | AV_CODEC_ID_PCM_U16LE, | |
302 | AV_CODEC_ID_PCM_U16BE, | |
303 | AV_CODEC_ID_PCM_S8, | |
304 | AV_CODEC_ID_PCM_U8, | |
305 | AV_CODEC_ID_PCM_MULAW, | |
306 | AV_CODEC_ID_PCM_ALAW, | |
307 | AV_CODEC_ID_PCM_S32LE, | |
308 | AV_CODEC_ID_PCM_S32BE, | |
309 | AV_CODEC_ID_PCM_U32LE, | |
310 | AV_CODEC_ID_PCM_U32BE, | |
311 | AV_CODEC_ID_PCM_S24LE, | |
312 | AV_CODEC_ID_PCM_S24BE, | |
313 | AV_CODEC_ID_PCM_U24LE, | |
314 | AV_CODEC_ID_PCM_U24BE, | |
315 | AV_CODEC_ID_PCM_S24DAUD, | |
316 | AV_CODEC_ID_PCM_ZORK, | |
317 | AV_CODEC_ID_PCM_S16LE_PLANAR, | |
318 | AV_CODEC_ID_PCM_DVD, | |
319 | AV_CODEC_ID_PCM_F32BE, | |
320 | AV_CODEC_ID_PCM_F32LE, | |
321 | AV_CODEC_ID_PCM_F64BE, | |
322 | AV_CODEC_ID_PCM_F64LE, | |
323 | AV_CODEC_ID_PCM_BLURAY, | |
324 | AV_CODEC_ID_PCM_LXF, | |
325 | AV_CODEC_ID_S302M, | |
326 | AV_CODEC_ID_PCM_S8_PLANAR, | |
7e52080c PM |
327 | AV_CODEC_ID_PCM_S24LE_PLANAR, |
328 | AV_CODEC_ID_PCM_S32LE_PLANAR, | |
0147f198 | 329 | |
f5bccd85 | 330 | /* various ADPCM codecs */ |
104e10fb AK |
331 | AV_CODEC_ID_ADPCM_IMA_QT = 0x11000, |
332 | AV_CODEC_ID_ADPCM_IMA_WAV, | |
333 | AV_CODEC_ID_ADPCM_IMA_DK3, | |
334 | AV_CODEC_ID_ADPCM_IMA_DK4, | |
335 | AV_CODEC_ID_ADPCM_IMA_WS, | |
336 | AV_CODEC_ID_ADPCM_IMA_SMJPEG, | |
337 | AV_CODEC_ID_ADPCM_MS, | |
338 | AV_CODEC_ID_ADPCM_4XM, | |
339 | AV_CODEC_ID_ADPCM_XA, | |
340 | AV_CODEC_ID_ADPCM_ADX, | |
341 | AV_CODEC_ID_ADPCM_EA, | |
342 | AV_CODEC_ID_ADPCM_G726, | |
343 | AV_CODEC_ID_ADPCM_CT, | |
344 | AV_CODEC_ID_ADPCM_SWF, | |
345 | AV_CODEC_ID_ADPCM_YAMAHA, | |
346 | AV_CODEC_ID_ADPCM_SBPRO_4, | |
347 | AV_CODEC_ID_ADPCM_SBPRO_3, | |
348 | AV_CODEC_ID_ADPCM_SBPRO_2, | |
349 | AV_CODEC_ID_ADPCM_THP, | |
350 | AV_CODEC_ID_ADPCM_IMA_AMV, | |
351 | AV_CODEC_ID_ADPCM_EA_R1, | |
352 | AV_CODEC_ID_ADPCM_EA_R3, | |
353 | AV_CODEC_ID_ADPCM_EA_R2, | |
354 | AV_CODEC_ID_ADPCM_IMA_EA_SEAD, | |
355 | AV_CODEC_ID_ADPCM_IMA_EA_EACS, | |
356 | AV_CODEC_ID_ADPCM_EA_XAS, | |
357 | AV_CODEC_ID_ADPCM_EA_MAXIS_XA, | |
358 | AV_CODEC_ID_ADPCM_IMA_ISS, | |
359 | AV_CODEC_ID_ADPCM_G722, | |
360 | AV_CODEC_ID_ADPCM_IMA_APC, | |
6f273093 | 361 | AV_CODEC_ID_ADPCM_VIMA, |
891f64b3 | 362 | |
17179d2d | 363 | /* AMR */ |
104e10fb AK |
364 | AV_CODEC_ID_AMR_NB = 0x12000, |
365 | AV_CODEC_ID_AMR_WB, | |
d663a1fd | 366 | |
b8414bbd | 367 | /* RealAudio codecs*/ |
104e10fb AK |
368 | AV_CODEC_ID_RA_144 = 0x13000, |
369 | AV_CODEC_ID_RA_288, | |
3ef8be2b MM |
370 | |
371 | /* various DPCM codecs */ | |
104e10fb AK |
372 | AV_CODEC_ID_ROQ_DPCM = 0x14000, |
373 | AV_CODEC_ID_INTERPLAY_DPCM, | |
374 | AV_CODEC_ID_XAN_DPCM, | |
375 | AV_CODEC_ID_SOL_DPCM, | |
115329f1 | 376 | |
ba0dabbf | 377 | /* audio codecs */ |
104e10fb AK |
378 | AV_CODEC_ID_MP2 = 0x15000, |
379 | AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3 | |
380 | AV_CODEC_ID_AAC, | |
381 | AV_CODEC_ID_AC3, | |
382 | AV_CODEC_ID_DTS, | |
383 | AV_CODEC_ID_VORBIS, | |
384 | AV_CODEC_ID_DVAUDIO, | |
385 | AV_CODEC_ID_WMAV1, | |
386 | AV_CODEC_ID_WMAV2, | |
387 | AV_CODEC_ID_MACE3, | |
388 | AV_CODEC_ID_MACE6, | |
389 | AV_CODEC_ID_VMDAUDIO, | |
390 | AV_CODEC_ID_FLAC, | |
391 | AV_CODEC_ID_MP3ADU, | |
392 | AV_CODEC_ID_MP3ON4, | |
393 | AV_CODEC_ID_SHORTEN, | |
394 | AV_CODEC_ID_ALAC, | |
395 | AV_CODEC_ID_WESTWOOD_SND1, | |
396 | AV_CODEC_ID_GSM, ///< as in Berlin toast format | |
397 | AV_CODEC_ID_QDM2, | |
398 | AV_CODEC_ID_COOK, | |
399 | AV_CODEC_ID_TRUESPEECH, | |
400 | AV_CODEC_ID_TTA, | |
401 | AV_CODEC_ID_SMACKAUDIO, | |
402 | AV_CODEC_ID_QCELP, | |
403 | AV_CODEC_ID_WAVPACK, | |
404 | AV_CODEC_ID_DSICINAUDIO, | |
405 | AV_CODEC_ID_IMC, | |
406 | AV_CODEC_ID_MUSEPACK7, | |
407 | AV_CODEC_ID_MLP, | |
408 | AV_CODEC_ID_GSM_MS, /* as found in WAV */ | |
409 | AV_CODEC_ID_ATRAC3, | |
f544c586 | 410 | #if FF_API_VOXWARE |
104e10fb | 411 | AV_CODEC_ID_VOXWARE, |
f544c586 | 412 | #endif |
104e10fb AK |
413 | AV_CODEC_ID_APE, |
414 | AV_CODEC_ID_NELLYMOSER, | |
415 | AV_CODEC_ID_MUSEPACK8, | |
416 | AV_CODEC_ID_SPEEX, | |
417 | AV_CODEC_ID_WMAVOICE, | |
418 | AV_CODEC_ID_WMAPRO, | |
419 | AV_CODEC_ID_WMALOSSLESS, | |
420 | AV_CODEC_ID_ATRAC3P, | |
421 | AV_CODEC_ID_EAC3, | |
422 | AV_CODEC_ID_SIPR, | |
423 | AV_CODEC_ID_MP1, | |
424 | AV_CODEC_ID_TWINVQ, | |
425 | AV_CODEC_ID_TRUEHD, | |
426 | AV_CODEC_ID_MP4ALS, | |
427 | AV_CODEC_ID_ATRAC1, | |
428 | AV_CODEC_ID_BINKAUDIO_RDFT, | |
429 | AV_CODEC_ID_BINKAUDIO_DCT, | |
430 | AV_CODEC_ID_AAC_LATM, | |
431 | AV_CODEC_ID_QDMC, | |
432 | AV_CODEC_ID_CELT, | |
433 | AV_CODEC_ID_G723_1, | |
434 | AV_CODEC_ID_G729, | |
435 | AV_CODEC_ID_8SVX_EXP, | |
436 | AV_CODEC_ID_8SVX_FIB, | |
437 | AV_CODEC_ID_BMV_AUDIO, | |
438 | AV_CODEC_ID_RALF, | |
439 | AV_CODEC_ID_IAC, | |
440 | AV_CODEC_ID_ILBC, | |
2a3d82ab | 441 | AV_CODEC_ID_OPUS, |
9b500b8f | 442 | AV_CODEC_ID_COMFORT_NOISE, |
57231e4d | 443 | AV_CODEC_ID_TAK, |
f544c586 | 444 | AV_CODEC_ID_METASOUND, |
70daeacd | 445 | AV_CODEC_ID_PAF_AUDIO, |
e2834567 | 446 | AV_CODEC_ID_ON2AVC, |
115329f1 | 447 | |
240c1657 | 448 | /* subtitle codecs */ |
104e10fb AK |
449 | AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs. |
450 | AV_CODEC_ID_DVD_SUBTITLE = 0x17000, | |
451 | AV_CODEC_ID_DVB_SUBTITLE, | |
452 | AV_CODEC_ID_TEXT, ///< raw UTF-8 text | |
453 | AV_CODEC_ID_XSUB, | |
454 | AV_CODEC_ID_SSA, | |
455 | AV_CODEC_ID_MOV_TEXT, | |
456 | AV_CODEC_ID_HDMV_PGS_SUBTITLE, | |
457 | AV_CODEC_ID_DVB_TELETEXT, | |
458 | AV_CODEC_ID_SRT, | |
115329f1 | 459 | |
7ce68923 | 460 | /* other specific kind of codecs (generally used for attachments) */ |
104e10fb AK |
461 | AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs. |
462 | AV_CODEC_ID_TTF = 0x18000, | |
f8d7c9d3 | 463 | |
104e10fb | 464 | AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it |
0bef08e5 | 465 | |
104e10fb | 466 | AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS |
f5bccd85 | 467 | * stream (only used by libavformat) */ |
104e10fb | 468 | AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems |
77b5c82b | 469 | * stream (only used by libavformat) */ |
104e10fb | 470 | AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information. |
de6d9b64 | 471 | }; |
dcedf586 | 472 | |
c223d799 AK |
473 | /** |
474 | * This struct describes the properties of a single codec described by an | |
475 | * AVCodecID. | |
d07ddc93 | 476 | * @see avcodec_descriptor_get() |
c223d799 AK |
477 | */ |
478 | typedef struct AVCodecDescriptor { | |
479 | enum AVCodecID id; | |
480 | enum AVMediaType type; | |
481 | /** | |
482 | * Name of the codec described by this descriptor. It is non-empty and | |
483 | * unique for each codec descriptor. It should contain alphanumeric | |
484 | * characters and '_' only. | |
485 | */ | |
486 | const char *name; | |
487 | /** | |
488 | * A more descriptive name for this codec. May be NULL. | |
489 | */ | |
490 | const char *long_name; | |
51efed15 AK |
491 | /** |
492 | * Codec properties, a combination of AV_CODEC_PROP_* flags. | |
493 | */ | |
494 | int props; | |
c223d799 AK |
495 | } AVCodecDescriptor; |
496 | ||
51efed15 AK |
497 | /** |
498 | * Codec uses only intra compression. | |
499 | * Video codecs only. | |
500 | */ | |
501 | #define AV_CODEC_PROP_INTRA_ONLY (1 << 0) | |
a2318326 AK |
502 | /** |
503 | * Codec supports lossy compression. Audio and video codecs only. | |
504 | * @note a codec may support both lossy and lossless | |
505 | * compression modes | |
506 | */ | |
507 | #define AV_CODEC_PROP_LOSSY (1 << 1) | |
508 | /** | |
509 | * Codec supports lossless compression. Audio and video codecs only. | |
510 | */ | |
511 | #define AV_CODEC_PROP_LOSSLESS (1 << 2) | |
c5fca017 AK |
512 | /** |
513 | * Codec supports frame reordering. That is, the coded order (the order in which | |
514 | * the encoded packets are output by the encoders / stored / input to the | |
515 | * decoders) may be different from the presentation order of the corresponding | |
516 | * frames. | |
517 | * | |
518 | * For codecs that do not have this property set, PTS and DTS should always be | |
519 | * equal. | |
520 | */ | |
521 | #define AV_CODEC_PROP_REORDER (1 << 3) | |
51efed15 | 522 | |
d7425f59 | 523 | /** |
c8ef8464 | 524 | * @ingroup lavc_decoding |
cf713bb8 | 525 | * Required number of additionally allocated bytes at the end of the input bitstream for decoding. |
171b7b91 AC |
526 | * This is mainly needed because some optimized bitstream readers read |
527 | * 32 or 64 bit at once and could read over the end.<br> | |
f5bccd85 DB |
528 | * Note: If the first 23 bits of the additional bytes are not 0, then damaged |
529 | * MPEG bitstreams could cause overread and segfault. | |
d7425f59 | 530 | */ |
171b7b91 | 531 | #define FF_INPUT_BUFFER_PADDING_SIZE 8 |
d7425f59 | 532 | |
0ecca7a4 | 533 | /** |
f038515f | 534 | * @ingroup lavc_encoding |
f5bccd85 DB |
535 | * minimum encoding buffer size |
536 | * Used to avoid some checks during header writing. | |
0ecca7a4 MN |
537 | */ |
538 | #define FF_MIN_BUFFER_SIZE 16384 | |
539 | ||
47146dfb | 540 | |
0e373b95 | 541 | /** |
f038515f | 542 | * @ingroup lavc_encoding |
bafc102b | 543 | * motion estimation type. |
0e373b95 | 544 | */ |
e4986da9 | 545 | enum Motion_Est_ID { |
9b4dd1b8 | 546 | ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed |
e4986da9 J |
547 | ME_FULL, |
548 | ME_LOG, | |
549 | ME_PHODS, | |
9b4dd1b8 MN |
550 | ME_EPZS, ///< enhanced predictive zonal search |
551 | ME_X1, ///< reserved for experiments | |
552 | ME_HEX, ///< hexagon based search | |
553 | ME_UMH, ///< uneven multi-hexagon search | |
359bbdab | 554 | ME_TESA, ///< transformed exhaustive search algorithm |
e4986da9 J |
555 | }; |
556 | ||
c8ef8464 AK |
557 | /** |
558 | * @ingroup lavc_decoding | |
559 | */ | |
8c3eba7c | 560 | enum AVDiscard{ |
f5bccd85 DB |
561 | /* We leave some space between them for extensions (drop some |
562 | * keyframes for intra-only or drop just some bidir frames). */ | |
ccc2dfbc LB |
563 | AVDISCARD_NONE =-16, ///< discard nothing |
564 | AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi | |
565 | AVDISCARD_NONREF = 8, ///< discard all non reference | |
566 | AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames | |
567 | AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes | |
568 | AVDISCARD_ALL = 48, ///< discard all | |
8c3eba7c MN |
569 | }; |
570 | ||
34b47d7c JR |
571 | enum AVAudioServiceType { |
572 | AV_AUDIO_SERVICE_TYPE_MAIN = 0, | |
573 | AV_AUDIO_SERVICE_TYPE_EFFECTS = 1, | |
574 | AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2, | |
575 | AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3, | |
576 | AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4, | |
577 | AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5, | |
578 | AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6, | |
579 | AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7, | |
580 | AV_AUDIO_SERVICE_TYPE_KARAOKE = 8, | |
581 | AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI | |
582 | }; | |
583 | ||
f038515f AK |
584 | /** |
585 | * @ingroup lavc_encoding | |
586 | */ | |
ce980a95 MN |
587 | typedef struct RcOverride{ |
588 | int start_frame; | |
589 | int end_frame; | |
f5bccd85 | 590 | int qscale; // If this is 0 then quality_factor will be used instead. |
ce980a95 MN |
591 | float quality_factor; |
592 | } RcOverride; | |
593 | ||
aa241229 AK |
594 | #if FF_API_MAX_BFRAMES |
595 | /** | |
596 | * @deprecated there is no libavcodec-wide limit on the number of B-frames | |
597 | */ | |
b0ec9efd | 598 | #define FF_MAX_B_FRAMES 16 |
aa241229 | 599 | #endif |
9dbcbd92 | 600 | |
a949d72e | 601 | /* encoding support |
f5bccd85 DB |
602 | These flags can be passed in AVCodecContext.flags before initialization. |
603 | Note: Not everything is supported yet. | |
a949d72e | 604 | */ |
de6d9b64 | 605 | |
5e83d9ac AK |
606 | /** |
607 | * Allow decoders to produce frames with data planes that are not aligned | |
608 | * to CPU requirements (e.g. due to cropping). | |
609 | */ | |
610 | #define CODEC_FLAG_UNALIGNED 0x0001 | |
f5bccd85 DB |
611 | #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale. |
612 | #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263. | |
28096e0a | 613 | #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted |
f5bccd85 | 614 | #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC. |
64841491 AK |
615 | #if FF_API_GMC |
616 | /** | |
617 | * @deprecated use the "gmc" private option of the libxvid encoder | |
618 | */ | |
f5bccd85 | 619 | #define CODEC_FLAG_GMC 0x0020 ///< Use GMC. |
64841491 | 620 | #endif |
a2941c8c AK |
621 | #if FF_API_MV0 |
622 | /** | |
623 | * @deprecated use the flag "mv0" in the "mpv_flags" private option of the | |
624 | * mpegvideo encoders | |
625 | */ | |
626 | #define CODEC_FLAG_MV0 0x0040 | |
627 | #endif | |
5fccedaa | 628 | #if FF_API_INPUT_PRESERVED |
1ba8f5eb | 629 | /** |
5fccedaa AK |
630 | * @deprecated passing reference-counted frames to the encoders replaces this |
631 | * flag | |
1ba8f5eb | 632 | */ |
8b4c7dbc | 633 | #define CODEC_FLAG_INPUT_PRESERVED 0x0100 |
5fccedaa | 634 | #endif |
273b0cd3 DB |
635 | #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode. |
636 | #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode. | |
273b0cd3 | 637 | #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale. |
93c553c7 AK |
638 | #if FF_API_EMU_EDGE |
639 | /** | |
640 | * @deprecated edges are not used/required anymore. I.e. this flag is now always | |
641 | * set. | |
642 | */ | |
643 | #define CODEC_FLAG_EMU_EDGE 0x4000 | |
644 | #endif | |
273b0cd3 DB |
645 | #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding. |
646 | #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random | |
647 | location instead of only at frame boundaries. */ | |
b2c31710 AK |
648 | #if FF_API_NORMALIZE_AQP |
649 | /** | |
650 | * @deprecated use the flag "naq" in the "mpv_flags" private option of the | |
651 | * mpegvideo encoders | |
652 | */ | |
653 | #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 | |
654 | #endif | |
f5bccd85 DB |
655 | #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT. |
656 | #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay. | |
f5bccd85 DB |
657 | #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe. |
658 | #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT). | |
21e59552 | 659 | /* Fx : Flag for h263+ extra options */ |
f5bccd85 | 660 | #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction |
332f9ac4 | 661 | #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter |
bb198e19 | 662 | #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation |
f3eec1cf | 663 | #define CODEC_FLAG_CLOSED_GOP 0x80000000 |
f5bccd85 | 664 | #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks. |
f5bccd85 DB |
665 | #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding. |
666 | #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata. | |
a84fb6e0 VG |
667 | #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS. |
668 | ||
f013cb81 | 669 | #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries. |
6fc5b059 | 670 | |
21e59552 | 671 | /* Unsupported options : |
bb270c08 DB |
672 | * Syntax Arithmetic coding (SAC) |
673 | * Reference Picture Selection | |
eafcac6a | 674 | * Independent Segment Decoding */ |
21e59552 | 675 | /* /Fx */ |
bf89e6b1 FB |
676 | /* codec capabilities */ |
677 | ||
f5bccd85 | 678 | #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback. |
6814a25c | 679 | /** |
9b489e02 RD |
680 | * Codec uses get_buffer() for allocating buffers and supports custom allocators. |
681 | * If not set, it might not use get_buffer() at all or use operations that | |
682 | * assume the buffer was allocated by avcodec_default_get_buffer. | |
6814a25c MN |
683 | */ |
684 | #define CODEC_CAP_DR1 0x0002 | |
d7425f59 | 685 | #define CODEC_CAP_TRUNCATED 0x0008 |
19e30a58 | 686 | #if FF_API_XVMC |
f5bccd85 | 687 | /* Codec can export data for HW decoding (XvMC). */ |
5e5c247a | 688 | #define CODEC_CAP_HWACCEL 0x0010 |
19e30a58 | 689 | #endif /* FF_API_XVMC */ |
115329f1 | 690 | /** |
3f6aa85e JR |
691 | * Encoder or decoder requires flushing with NULL input at the end in order to |
692 | * give the complete and correct output. | |
693 | * | |
694 | * NOTE: If this flag is not set, the codec is guaranteed to never be fed with | |
695 | * with NULL data. The user can still send NULL data to the public encode | |
696 | * or decode function, but libavcodec will not pass it along to the codec | |
697 | * unless this flag is set. | |
698 | * | |
699 | * Decoders: | |
700 | * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL, | |
ffeeae92 | 701 | * avpkt->size=0 at the end to get the delayed data until the decoder no longer |
3f6aa85e JR |
702 | * returns frames. |
703 | * | |
704 | * Encoders: | |
705 | * The encoder needs to be fed with NULL data at the end of encoding until the | |
706 | * encoder no longer returns data. | |
b2c75b6e JR |
707 | * |
708 | * NOTE: For encoders implementing the AVCodec.encode2() function, setting this | |
709 | * flag also means that the encoder must set the pts and duration for | |
710 | * each output packet. If this flag is not set, the pts and duration will | |
711 | * be determined by libavcodec from the input frame. | |
934982c4 | 712 | */ |
6f824977 | 713 | #define CODEC_CAP_DELAY 0x0020 |
cef7cc72 JR |
714 | /** |
715 | * Codec can be fed a final frame with a smaller size. | |
716 | * This can be used to prevent truncation of the last audio samples. | |
717 | */ | |
718 | #define CODEC_CAP_SMALL_LAST_FRAME 0x0040 | |
549294fb | 719 | #if FF_API_CAP_VDPAU |
369122dd NC |
720 | /** |
721 | * Codec can export data for HW decoding (VDPAU). | |
722 | */ | |
723 | #define CODEC_CAP_HWACCEL_VDPAU 0x0080 | |
549294fb | 724 | #endif |
d859bb1d SS |
725 | /** |
726 | * Codec can output multiple frames per AVPacket | |
e9e949cf MN |
727 | * Normally demuxers return one frame at a time, demuxers which do not do |
728 | * are connected to a parser to split what they return into proper frames. | |
729 | * This flag is reserved to the very rare category of codecs which have a | |
730 | * bitstream that cannot be split into frames without timeconsuming | |
731 | * operations like full decoding. Demuxers carring such bitstreams thus | |
732 | * may return multiple frames in a packet. This has many disadvantages like | |
733 | * prohibiting stream copy in many cases thus it should only be considered | |
734 | * as a last resort. | |
d859bb1d SS |
735 | */ |
736 | #define CODEC_CAP_SUBFRAMES 0x0100 | |
93ebfeea JG |
737 | /** |
738 | * Codec is experimental and is thus avoided in favor of non experimental | |
739 | * encoders | |
740 | */ | |
741 | #define CODEC_CAP_EXPERIMENTAL 0x0200 | |
62784e37 BL |
742 | /** |
743 | * Codec should fill in channel configuration and samplerate instead of container | |
744 | */ | |
745 | #define CODEC_CAP_CHANNEL_CONF 0x0400 | |
b068660f | 746 | #if FF_API_NEG_LINESIZES |
16cfc961 | 747 | /** |
b068660f | 748 | * @deprecated no codecs use this capability |
16cfc961 SS |
749 | */ |
750 | #define CODEC_CAP_NEG_LINESIZES 0x0800 | |
b068660f | 751 | #endif |
37b00b47 AS |
752 | /** |
753 | * Codec supports frame-level multithreading. | |
754 | */ | |
755 | #define CODEC_CAP_FRAME_THREADS 0x1000 | |
94f7451a RB |
756 | /** |
757 | * Codec supports slice-based (or partition-based) multithreading. | |
758 | */ | |
759 | #define CODEC_CAP_SLICE_THREADS 0x2000 | |
fe75dc85 MS |
760 | /** |
761 | * Codec supports changed parameters at any point. | |
762 | */ | |
763 | #define CODEC_CAP_PARAM_CHANGE 0x4000 | |
b4d44a45 JG |
764 | /** |
765 | * Codec supports avctx->thread_count == 0 (auto). | |
766 | */ | |
767 | #define CODEC_CAP_AUTO_THREADS 0x8000 | |
b2c75b6e JR |
768 | /** |
769 | * Audio encoder supports receiving a different number of samples in each call. | |
770 | */ | |
771 | #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000 | |
bf89e6b1 | 772 | |
b6094811 | 773 | #if FF_API_MB_TYPE |
f5bccd85 | 774 | //The following defines may change, don't expect compatibility if you use them. |
8d7ec294 | 775 | #define MB_TYPE_INTRA4x4 0x0001 |
f5bccd85 DB |
776 | #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific |
777 | #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific | |
8d7ec294 WH |
778 | #define MB_TYPE_16x16 0x0008 |
779 | #define MB_TYPE_16x8 0x0010 | |
780 | #define MB_TYPE_8x16 0x0020 | |
781 | #define MB_TYPE_8x8 0x0040 | |
782 | #define MB_TYPE_INTERLACED 0x0080 | |
273b0cd3 | 783 | #define MB_TYPE_DIRECT2 0x0100 //FIXME |
8d7ec294 WH |
784 | #define MB_TYPE_ACPRED 0x0200 |
785 | #define MB_TYPE_GMC 0x0400 | |
786 | #define MB_TYPE_SKIP 0x0800 | |
787 | #define MB_TYPE_P0L0 0x1000 | |
788 | #define MB_TYPE_P1L0 0x2000 | |
789 | #define MB_TYPE_P0L1 0x4000 | |
790 | #define MB_TYPE_P1L1 0x8000 | |
791 | #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0) | |
792 | #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1) | |
793 | #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1) | |
794 | #define MB_TYPE_QUANT 0x00010000 | |
795 | #define MB_TYPE_CBP 0x00020000 | |
796 | //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...) | |
b6094811 | 797 | #endif |
8d7ec294 | 798 | |
fa384dcc MN |
799 | /** |
800 | * Pan Scan area. | |
f5bccd85 DB |
801 | * This specifies the area which should be displayed. |
802 | * Note there may be multiple such areas for one frame. | |
fa384dcc MN |
803 | */ |
804 | typedef struct AVPanScan{ | |
805 | /** | |
f5bccd85 DB |
806 | * id |
807 | * - encoding: Set by user. | |
808 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
809 | */ |
810 | int id; | |
811 | ||
812 | /** | |
813 | * width and height in 1/16 pel | |
f5bccd85 DB |
814 | * - encoding: Set by user. |
815 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
816 | */ |
817 | int width; | |
818 | int height; | |
819 | ||
820 | /** | |
f5bccd85 DB |
821 | * position of the top left corner in 1/16 pel for up to 3 fields/frames |
822 | * - encoding: Set by user. | |
823 | * - decoding: Set by libavcodec. | |
fa384dcc MN |
824 | */ |
825 | int16_t position[3][2]; | |
826 | }AVPanScan; | |
827 | ||
b45c8708 | 828 | #if FF_API_QSCALE_TYPE |
bb270c08 DB |
829 | #define FF_QSCALE_TYPE_MPEG1 0 |
830 | #define FF_QSCALE_TYPE_MPEG2 1 | |
831 | #define FF_QSCALE_TYPE_H264 2 | |
800274f8 | 832 | #define FF_QSCALE_TYPE_VP56 3 |
b45c8708 | 833 | #endif |
4e00e76b | 834 | |
759001c5 | 835 | #if FF_API_GET_BUFFER |
4e00e76b | 836 | #define FF_BUFFER_TYPE_INTERNAL 1 |
f5bccd85 DB |
837 | #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user) |
838 | #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared. | |
839 | #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything. | |
4e00e76b | 840 | |
f5bccd85 DB |
841 | #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore). |
842 | #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer. | |
843 | #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content. | |
844 | #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update). | |
759001c5 AK |
845 | #endif |
846 | ||
847 | /** | |
848 | * The decoder will keep a reference to the frame and may reuse it later. | |
849 | */ | |
850 | #define AV_GET_BUFFER_FLAG_REF (1 << 0) | |
074c4ca7 | 851 | |
30f3f625 AK |
852 | /** |
853 | * @defgroup lavc_packet AVPacket | |
854 | * | |
855 | * Types and functions for working with AVPacket. | |
856 | * @{ | |
857 | */ | |
4de339e2 KS |
858 | enum AVPacketSideDataType { |
859 | AV_PKT_DATA_PALETTE, | |
195c123c | 860 | AV_PKT_DATA_NEW_EXTRADATA, |
30f3f625 AK |
861 | |
862 | /** | |
863 | * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows: | |
199ada49 | 864 | * @code |
30f3f625 AK |
865 | * u32le param_flags |
866 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) | |
867 | * s32le channel_count | |
868 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) | |
869 | * u64le channel_layout | |
870 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) | |
871 | * s32le sample_rate | |
872 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) | |
873 | * s32le width | |
874 | * s32le height | |
199ada49 | 875 | * @endcode |
30f3f625 | 876 | */ |
fe75dc85 | 877 | AV_PKT_DATA_PARAM_CHANGE, |
30f3f625 AK |
878 | |
879 | /** | |
880 | * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of | |
881 | * structures with info about macroblocks relevant to splitting the | |
882 | * packet into smaller packets on macroblock edges (e.g. as for RFC 2190). | |
883 | * That is, it does not necessarily contain info about all macroblocks, | |
884 | * as long as the distance between macroblocks in the info is smaller | |
885 | * than the target payload size. | |
886 | * Each MB info structure is 12 bytes, and is laid out as follows: | |
199ada49 | 887 | * @code |
30f3f625 AK |
888 | * u32le bit offset from the start of the packet |
889 | * u8 current quantizer at the start of the macroblock | |
890 | * u8 GOB number | |
891 | * u16le macroblock address within the GOB | |
892 | * u8 horizontal MV predictor | |
893 | * u8 vertical MV predictor | |
894 | * u8 horizontal MV predictor for block number 3 | |
895 | * u8 vertical MV predictor for block number 3 | |
199ada49 | 896 | * @endcode |
30f3f625 | 897 | */ |
bdc1220e | 898 | AV_PKT_DATA_H263_MB_INFO, |
5a7e35dd AK |
899 | |
900 | /** | |
901 | * This side data should be associated with an audio stream and contains | |
902 | * ReplayGain information in form of the AVReplayGain struct. | |
903 | */ | |
904 | AV_PKT_DATA_REPLAYGAIN, | |
bddd8cbf VG |
905 | |
906 | /** | |
907 | * This side data contains a 3x3 transformation matrix describing an affine | |
908 | * transformation that needs to be applied to the decoded video frames for | |
909 | * correct presentation. | |
910 | * | |
911 | * See libavutil/display.h for a detailed description of the data. | |
912 | */ | |
913 | AV_PKT_DATA_DISPLAYMATRIX, | |
93014864 | 914 | |
37c46743 | 915 | /** |
93014864 VG |
916 | * This side data should be associated with a video stream and contains |
917 | * Stereoscopic 3D information in form of the AVStereo3D struct. | |
918 | */ | |
919 | AV_PKT_DATA_STEREO3D, | |
4de339e2 KS |
920 | }; |
921 | ||
0e2c3ee9 AK |
922 | typedef struct AVPacketSideData { |
923 | uint8_t *data; | |
924 | int size; | |
925 | enum AVPacketSideDataType type; | |
926 | } AVPacketSideData; | |
927 | ||
0876c280 AK |
928 | /** |
929 | * This structure stores compressed data. It is typically exported by demuxers | |
930 | * and then passed as input to decoders, or received as output from encoders and | |
931 | * then passed to muxers. | |
932 | * | |
933 | * For video, it should typically contain one compressed frame. For audio it may | |
934 | * contain several compressed frames. | |
935 | * | |
936 | * AVPacket is one of the few structs in Libav, whose size is a part of public | |
937 | * ABI. Thus it may be allocated on stack and no new fields can be added to it | |
938 | * without libavcodec and libavformat major bump. | |
939 | * | |
1afddbe5 AK |
940 | * The semantics of data ownership depends on the buf or destruct (deprecated) |
941 | * fields. If either is set, the packet data is dynamically allocated and is | |
942 | * valid indefinitely until av_free_packet() is called (which in turn calls | |
943 | * av_buffer_unref()/the destruct callback to free the data). If neither is set, | |
944 | * the packet data is typically backed by some static buffer somewhere and is | |
945 | * only valid for a limited time (e.g. until the next read call when demuxing). | |
0876c280 AK |
946 | * |
947 | * The side data is always allocated with av_malloc() and is freed in | |
948 | * av_free_packet(). | |
949 | */ | |
18c915ee TB |
950 | typedef struct AVPacket { |
951 | /** | |
1afddbe5 AK |
952 | * A reference to the reference-counted buffer where the packet data is |
953 | * stored. | |
954 | * May be NULL, then the packet data is not reference-counted. | |
955 | */ | |
956 | AVBufferRef *buf; | |
957 | /** | |
7b356d39 RS |
958 | * Presentation timestamp in AVStream->time_base units; the time at which |
959 | * the decompressed packet will be presented to the user. | |
18c915ee TB |
960 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
961 | * pts MUST be larger or equal to dts as presentation cannot happen before | |
962 | * decompression, unless one wants to view hex dumps. Some formats misuse | |
963 | * the terms dts and pts/cts to mean something different. Such timestamps | |
964 | * must be converted to true pts/dts before they are stored in AVPacket. | |
965 | */ | |
966 | int64_t pts; | |
967 | /** | |
7b356d39 RS |
968 | * Decompression timestamp in AVStream->time_base units; the time at which |
969 | * the packet is decompressed. | |
18c915ee TB |
970 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
971 | */ | |
972 | int64_t dts; | |
973 | uint8_t *data; | |
974 | int size; | |
975 | int stream_index; | |
9d39cbf6 LB |
976 | /** |
977 | * A combination of AV_PKT_FLAG values | |
978 | */ | |
18c915ee TB |
979 | int flags; |
980 | /** | |
4de339e2 KS |
981 | * Additional packet data that can be provided by the container. |
982 | * Packet can contain several types of side information. | |
983 | */ | |
0e2c3ee9 | 984 | AVPacketSideData *side_data; |
4de339e2 KS |
985 | int side_data_elems; |
986 | ||
987 | /** | |
7b356d39 | 988 | * Duration of this packet in AVStream->time_base units, 0 if unknown. |
18c915ee TB |
989 | * Equals next_pts - this_pts in presentation order. |
990 | */ | |
991 | int duration; | |
1afddbe5 AK |
992 | #if FF_API_DESTRUCT_PACKET |
993 | attribute_deprecated | |
18c915ee | 994 | void (*destruct)(struct AVPacket *); |
1afddbe5 | 995 | attribute_deprecated |
18c915ee | 996 | void *priv; |
1afddbe5 | 997 | #endif |
18c915ee TB |
998 | int64_t pos; ///< byte position in stream, -1 if unknown |
999 | ||
1000 | /** | |
7b356d39 | 1001 | * Time difference in AVStream->time_base units from the pts of this |
18c915ee TB |
1002 | * packet to the point at which the output from the decoder has converged |
1003 | * independent from the availability of previous frames. That is, the | |
1004 | * frames are virtually identical no matter if decoding started from | |
1005 | * the very first frame or from this keyframe. | |
1006 | * Is AV_NOPTS_VALUE if unknown. | |
1007 | * This field is not the display duration of the current packet. | |
8ee82f40 AJ |
1008 | * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY |
1009 | * set. | |
18c915ee TB |
1010 | * |
1011 | * The purpose of this field is to allow seeking in streams that have no | |
1012 | * keyframes in the conventional sense. It corresponds to the | |
1013 | * recovery point SEI in H.264 and match_time_delta in NUT. It is also | |
1014 | * essential for some types of subtitle streams to ensure that all | |
1015 | * subtitles are correctly displayed after seeking. | |
1016 | */ | |
1017 | int64_t convergence_duration; | |
1018 | } AVPacket; | |
9d39cbf6 LB |
1019 | #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe |
1020 | #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted | |
18c915ee | 1021 | |
fe75dc85 MS |
1022 | enum AVSideDataParamChangeFlags { |
1023 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001, | |
1024 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002, | |
1025 | AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004, | |
1026 | AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008, | |
1027 | }; | |
30f3f625 AK |
1028 | /** |
1029 | * @} | |
1030 | */ | |
fe75dc85 | 1031 | |
f3a29b75 JR |
1032 | struct AVCodecInternal; |
1033 | ||
4bf3c8f2 AC |
1034 | enum AVFieldOrder { |
1035 | AV_FIELD_UNKNOWN, | |
1036 | AV_FIELD_PROGRESSIVE, | |
1037 | AV_FIELD_TT, //< Top coded_first, top displayed first | |
1038 | AV_FIELD_BB, //< Bottom coded first, bottom displayed first | |
1039 | AV_FIELD_TB, //< Top coded first, bottom displayed first | |
1040 | AV_FIELD_BT, //< Bottom coded first, top displayed first | |
1041 | }; | |
1042 | ||
d33c949c | 1043 | /** |
252f17e2 MN |
1044 | * main external API structure. |
1045 | * New fields can be added to the end with minor version bumps. | |
8bfb108b | 1046 | * Removal, reordering and changes to existing fields require a major |
252f17e2 | 1047 | * version bump. |
8bfb108b | 1048 | * sizeof(AVCodecContext) must not be used outside libav*. |
d33c949c | 1049 | */ |
de6d9b64 | 1050 | typedef struct AVCodecContext { |
b71901e6 | 1051 | /** |
f5bccd85 | 1052 | * information on struct for av_log |
488eec10 | 1053 | * - set by avcodec_alloc_context3 |
bc874dae | 1054 | */ |
d42a814e | 1055 | const AVClass *av_class; |
b1edfce0 AK |
1056 | int log_level_offset; |
1057 | ||
1058 | enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */ | |
0a0f19b5 | 1059 | const struct AVCodec *codec; |
ba71c740 AK |
1060 | #if FF_API_CODEC_NAME |
1061 | /** | |
1062 | * @deprecated this field is not used for anything in libavcodec | |
1063 | */ | |
1064 | attribute_deprecated | |
b1edfce0 | 1065 | char codec_name[32]; |
ba71c740 | 1066 | #endif |
36ef5369 | 1067 | enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */ |
b1edfce0 AK |
1068 | |
1069 | /** | |
1070 | * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). | |
1071 | * This is used to work around some encoder bugs. | |
1072 | * A demuxer should set this to what is stored in the field used to identify the codec. | |
1073 | * If there are multiple such fields in a container then the demuxer should choose the one | |
1074 | * which maximizes the information about the used codec. | |
1075 | * If the codec tag field in a container is larger than 32 bits then the demuxer should | |
1076 | * remap the longer ID to 32 bits with a table or other structure. Alternatively a new | |
1077 | * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated | |
1078 | * first. | |
1079 | * - encoding: Set by user, if not then the default based on codec_id will be used. | |
1080 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. | |
1081 | */ | |
1082 | unsigned int codec_tag; | |
1083 | ||
1084 | /** | |
1085 | * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). | |
1086 | * This is used to work around some encoder bugs. | |
1087 | * - encoding: unused | |
1088 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. | |
1089 | */ | |
1090 | unsigned int stream_codec_tag; | |
1091 | ||
b1edfce0 AK |
1092 | void *priv_data; |
1093 | ||
1094 | /** | |
1095 | * Private context used for internal data. | |
1096 | * | |
1097 | * Unlike priv_data, this is not codec-specific. It is used in general | |
1098 | * libavcodec functions. | |
1099 | */ | |
1100 | struct AVCodecInternal *internal; | |
1101 | ||
1102 | /** | |
1103 | * Private data of the user, can be used to carry app specific stuff. | |
1104 | * - encoding: Set by user. | |
1105 | * - decoding: Set by user. | |
1106 | */ | |
1107 | void *opaque; | |
1108 | ||
bc874dae | 1109 | /** |
f5bccd85 DB |
1110 | * the average bitrate |
1111 | * - encoding: Set by user; unused for constant quantizer encoding. | |
1112 | * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream. | |
b71901e6 | 1113 | */ |
de6d9b64 | 1114 | int bit_rate; |
b71901e6 MN |
1115 | |
1116 | /** | |
64863965 | 1117 | * number of bits the bitstream is allowed to diverge from the reference. |
b71901e6 | 1118 | * the reference can be CBR (for CBR pass1) or VBR (for pass2) |
f5bccd85 | 1119 | * - encoding: Set by user; unused for constant quantizer encoding. |
64863965 | 1120 | * - decoding: unused |
b71901e6 | 1121 | */ |
115329f1 | 1122 | int bit_rate_tolerance; |
b71901e6 MN |
1123 | |
1124 | /** | |
b1edfce0 AK |
1125 | * Global quality for codecs which cannot change it per frame. |
1126 | * This should be proportional to MPEG-1/2/4 qscale. | |
f5bccd85 | 1127 | * - encoding: Set by user. |
b1edfce0 | 1128 | * - decoding: unused |
b71901e6 | 1129 | */ |
b1edfce0 | 1130 | int global_quality; |
b71901e6 MN |
1131 | |
1132 | /** | |
b1edfce0 AK |
1133 | * - encoding: Set by user. |
1134 | * - decoding: unused | |
b71901e6 | 1135 | */ |
b1edfce0 AK |
1136 | int compression_level; |
1137 | #define FF_COMPRESSION_DEFAULT -1 | |
b71901e6 MN |
1138 | |
1139 | /** | |
b1edfce0 AK |
1140 | * CODEC_FLAG_*. |
1141 | * - encoding: Set by user. | |
1142 | * - decoding: Set by user. | |
b71901e6 | 1143 | */ |
b1edfce0 AK |
1144 | int flags; |
1145 | ||
1146 | /** | |
1147 | * CODEC_FLAG2_* | |
1148 | * - encoding: Set by user. | |
1149 | * - decoding: Set by user. | |
1150 | */ | |
1151 | int flags2; | |
b71901e6 MN |
1152 | |
1153 | /** | |
f5bccd85 DB |
1154 | * some codecs need / can use extradata like Huffman tables. |
1155 | * mjpeg: Huffman tables | |
b71901e6 | 1156 | * rv10: additional flags |
b704e742 | 1157 | * mpeg4: global headers (they can be in the bitstream or here) |
f5bccd85 DB |
1158 | * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger |
1159 | * than extradata_size to avoid prolems if it is read with the bitstream reader. | |
1160 | * The bytewise contents of extradata must not depend on the architecture or CPU endianness. | |
1161 | * - encoding: Set/allocated/freed by libavcodec. | |
1162 | * - decoding: Set/allocated/freed by user. | |
b71901e6 | 1163 | */ |
58f2a4b0 | 1164 | uint8_t *extradata; |
e84c31dc | 1165 | int extradata_size; |
115329f1 | 1166 | |
b71901e6 | 1167 | /** |
f5bccd85 DB |
1168 | * This is the fundamental unit of time (in seconds) in terms |
1169 | * of which frame timestamps are represented. For fixed-fps content, | |
5b28c8c3 MN |
1170 | * timebase should be 1/framerate and timestamp increments should be |
1171 | * identically 1. | |
f5bccd85 | 1172 | * - encoding: MUST be set by user. |
7ea1b347 AK |
1173 | * - decoding: the use of this field for decoding is deprecated. |
1174 | * Use framerate instead. | |
b71901e6 | 1175 | */ |
c0df9d75 | 1176 | AVRational time_base; |
115329f1 | 1177 | |
b1edfce0 AK |
1178 | /** |
1179 | * For some codecs, the time base is closer to the field rate than the frame rate. | |
1180 | * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration | |
1181 | * if no telecine is used ... | |
1182 | * | |
1183 | * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2. | |
1184 | */ | |
1185 | int ticks_per_frame; | |
1186 | ||
1187 | /** | |
c68317eb | 1188 | * Codec delay. |
b1edfce0 AK |
1189 | * |
1190 | * Video: | |
1191 | * Number of frames the decoded output will be delayed relative to the | |
1192 | * encoded input. | |
1193 | * | |
1194 | * Audio: | |
2df0c32e | 1195 | * For encoding, this field is unused (see initial_padding). |
b19a5e51 | 1196 | * |
e4aa3831 NC |
1197 | * For decoding, this is the number of samples the decoder needs to |
1198 | * output before the decoder's output is valid. When seeking, you should | |
1199 | * start decoding this many samples prior to your desired seek point. | |
b1edfce0 AK |
1200 | * |
1201 | * - encoding: Set by libavcodec. | |
e4aa3831 | 1202 | * - decoding: Set by libavcodec. |
b1edfce0 AK |
1203 | */ |
1204 | int delay; | |
1205 | ||
1206 | ||
5b28c8c3 | 1207 | /* video only */ |
14bea432 | 1208 | /** |
21adafec | 1209 | * picture width / height. |
115329f1 | 1210 | * - encoding: MUST be set by user. |
2d6edb2b AK |
1211 | * - decoding: May be set by the user before opening the decoder if known e.g. |
1212 | * from the container. Some decoders will require the dimensions | |
1213 | * to be set by the caller. During decoding, the decoder may | |
1214 | * overwrite those values as required. | |
b71901e6 | 1215 | */ |
de6d9b64 | 1216 | int width, height; |
115329f1 | 1217 | |
b1edfce0 | 1218 | /** |
2d6edb2b AK |
1219 | * Bitstream width / height, may be different from width/height e.g. when |
1220 | * the decoded frame is cropped before being output. | |
b1edfce0 | 1221 | * - encoding: unused |
2d6edb2b AK |
1222 | * - decoding: May be set by the user before opening the decoder if known |
1223 | * e.g. from the container. During decoding, the decoder may | |
1224 | * overwrite those values as required. | |
b1edfce0 AK |
1225 | */ |
1226 | int coded_width, coded_height; | |
1227 | ||
28240a60 | 1228 | #if FF_API_ASPECT_EXTENDED |
e769f053 | 1229 | #define FF_ASPECT_EXTENDED 15 |
28240a60 | 1230 | #endif |
b71901e6 MN |
1231 | |
1232 | /** | |
f5bccd85 DB |
1233 | * the number of pictures in a group of pictures, or 0 for intra_only |
1234 | * - encoding: Set by user. | |
64863965 | 1235 | * - decoding: unused |
b71901e6 MN |
1236 | */ |
1237 | int gop_size; | |
1238 | ||
1239 | /** | |
716d413c | 1240 | * Pixel format, see AV_PIX_FMT_xxx. |
c1bdc930 TH |
1241 | * May be set by the demuxer if known from headers. |
1242 | * May be overriden by the decoder if it knows better. | |
f5bccd85 | 1243 | * - encoding: Set by user. |
c1bdc930 | 1244 | * - decoding: Set by user if known, overridden by libavcodec if known |
b71901e6 | 1245 | */ |
716d413c | 1246 | enum AVPixelFormat pix_fmt; |
115329f1 | 1247 | |
b71901e6 | 1248 | /** |
b1edfce0 AK |
1249 | * Motion estimation algorithm used for video coding. |
1250 | * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex), | |
a0c5917f | 1251 | * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific] |
b1edfce0 AK |
1252 | * - encoding: MUST be set by user. |
1253 | * - decoding: unused | |
1254 | */ | |
1255 | int me_method; | |
1256 | ||
1257 | /** | |
f5bccd85 DB |
1258 | * If non NULL, 'draw_horiz_band' is called by the libavcodec |
1259 | * decoder to draw a horizontal band. It improves cache usage. Not | |
b71901e6 | 1260 | * all codecs can do that. You must check the codec capabilities |
f5bccd85 | 1261 | * beforehand. |
37b00b47 AS |
1262 | * When multithreading is used, it may be called from multiple threads |
1263 | * at the same time; threads might draw different parts of the same AVFrame, | |
1264 | * or multiple AVFrames, and there is no guarantee that slices will be drawn | |
1265 | * in order. | |
24b1583a IK |
1266 | * The function is also used by hardware acceleration APIs. |
1267 | * It is called at least once during frame decoding to pass | |
1268 | * the data needed for hardware render. | |
1269 | * In that mode instead of pixel data, AVFrame points to | |
1270 | * a structure specific to the acceleration API. The application | |
1271 | * reads the structure and can change some fields to indicate progress | |
1272 | * or mark state. | |
64863965 | 1273 | * - encoding: unused |
f5bccd85 | 1274 | * - decoding: Set by user. |
3bb07d61 MN |
1275 | * @param height the height of the slice |
1276 | * @param y the y position of the slice | |
1277 | * @param type 1->top field, 2->bottom field, 3->frame | |
1278 | * @param offset offset into the AVFrame.data from which the slice should be read | |
b71901e6 | 1279 | */ |
bf89e6b1 | 1280 | void (*draw_horiz_band)(struct AVCodecContext *s, |
560f773c | 1281 | const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], |
3bb07d61 | 1282 | int y, int type, int height); |
bf89e6b1 | 1283 | |
a3a5f4d6 | 1284 | /** |
b1edfce0 AK |
1285 | * callback to negotiate the pixelFormat |
1286 | * @param fmt is the list of formats which are supported by the codec, | |
1287 | * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality. | |
1288 | * The first is always the native one. | |
1c80c9d7 RDC |
1289 | * @note The callback may be called again immediately if initialization for |
1290 | * the selected (hardware-accelerated) pixel format failed. | |
1291 | * @warning Behavior is undefined if the callback returns a value not | |
1292 | * in the fmt list of formats. | |
b1edfce0 AK |
1293 | * @return the chosen format |
1294 | * - encoding: unused | |
1295 | * - decoding: Set by user, if not set the native format will be chosen. | |
a3a5f4d6 | 1296 | */ |
716d413c | 1297 | enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt); |
de6d9b64 | 1298 | |
718b27a7 | 1299 | /** |
b1edfce0 AK |
1300 | * maximum number of B-frames between non-B-frames |
1301 | * Note: The output will be delayed by max_b_frames+1 relative to the input. | |
1302 | * - encoding: Set by user. | |
1303 | * - decoding: unused | |
718b27a7 | 1304 | */ |
b1edfce0 | 1305 | int max_b_frames; |
115329f1 | 1306 | |
b71901e6 | 1307 | /** |
b1edfce0 AK |
1308 | * qscale factor between IP and B-frames |
1309 | * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset). | |
1310 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). | |
1311 | * - encoding: Set by user. | |
64863965 | 1312 | * - decoding: unused |
b71901e6 | 1313 | */ |
b1edfce0 | 1314 | float b_quant_factor; |
115329f1 | 1315 | |
b1edfce0 AK |
1316 | /** obsolete FIXME remove */ |
1317 | int rc_strategy; | |
1318 | #define FF_RC_STRATEGY_XVID 1 | |
1319 | ||
1320 | int b_frame_strategy; | |
115329f1 | 1321 | |
b71901e6 | 1322 | /** |
b1edfce0 | 1323 | * qscale offset between IP and B-frames |
f5bccd85 | 1324 | * - encoding: Set by user. |
64863965 | 1325 | * - decoding: unused |
b71901e6 | 1326 | */ |
b1edfce0 | 1327 | float b_quant_offset; |
b71901e6 MN |
1328 | |
1329 | /** | |
b1edfce0 AK |
1330 | * Size of the frame reordering buffer in the decoder. |
1331 | * For MPEG-2 it is 1 IPB or 0 low delay IP. | |
1332 | * - encoding: Set by libavcodec. | |
1333 | * - decoding: Set by libavcodec. | |
1334 | */ | |
1335 | int has_b_frames; | |
1336 | ||
1337 | /** | |
1338 | * 0-> h263 quant 1-> mpeg quant | |
f5bccd85 | 1339 | * - encoding: Set by user. |
64863965 | 1340 | * - decoding: unused |
b71901e6 | 1341 | */ |
b1edfce0 | 1342 | int mpeg_quant; |
b71901e6 MN |
1343 | |
1344 | /** | |
b1edfce0 AK |
1345 | * qscale factor between P and I-frames |
1346 | * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset). | |
662e5411 | 1347 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). |
f5bccd85 | 1348 | * - encoding: Set by user. |
64863965 | 1349 | * - decoding: unused |
b71901e6 | 1350 | */ |
b1edfce0 | 1351 | float i_quant_factor; |
64b7c5b6 | 1352 | |
b1edfce0 AK |
1353 | /** |
1354 | * qscale offset between P and I-frames | |
1355 | * - encoding: Set by user. | |
1356 | * - decoding: unused | |
1357 | */ | |
1358 | float i_quant_offset; | |
9dbcbd92 | 1359 | |
b1edfce0 AK |
1360 | /** |
1361 | * luminance masking (0-> disabled) | |
1362 | * - encoding: Set by user. | |
1363 | * - decoding: unused | |
1364 | */ | |
1365 | float lumi_masking; | |
115329f1 | 1366 | |
b1edfce0 AK |
1367 | /** |
1368 | * temporary complexity masking (0-> disabled) | |
1369 | * - encoding: Set by user. | |
1370 | * - decoding: unused | |
1371 | */ | |
1372 | float temporal_cplx_masking; | |
de6d9b64 | 1373 | |
b1edfce0 AK |
1374 | /** |
1375 | * spatial complexity masking (0-> disabled) | |
1376 | * - encoding: Set by user. | |
1377 | * - decoding: unused | |
1378 | */ | |
1379 | float spatial_cplx_masking; | |
115329f1 | 1380 | |
b71901e6 | 1381 | /** |
b1edfce0 | 1382 | * p block masking (0-> disabled) |
f5bccd85 | 1383 | * - encoding: Set by user. |
64863965 | 1384 | * - decoding: unused |
b71901e6 | 1385 | */ |
b1edfce0 | 1386 | float p_masking; |
115329f1 | 1387 | |
b71901e6 | 1388 | /** |
b1edfce0 | 1389 | * darkness masking (0-> disabled) |
f5bccd85 | 1390 | * - encoding: Set by user. |
64863965 | 1391 | * - decoding: unused |
b71901e6 | 1392 | */ |
b1edfce0 | 1393 | float dark_masking; |
115329f1 | 1394 | |
b71901e6 | 1395 | /** |
b1edfce0 AK |
1396 | * slice count |
1397 | * - encoding: Set by libavcodec. | |
1398 | * - decoding: Set by user (or 0). | |
b71901e6 | 1399 | */ |
b1edfce0 | 1400 | int slice_count; |
b71901e6 | 1401 | /** |
b1edfce0 | 1402 | * prediction method (needed for huffyuv) |
f5bccd85 | 1403 | * - encoding: Set by user. |
64863965 | 1404 | * - decoding: unused |
b71901e6 | 1405 | */ |
b1edfce0 AK |
1406 | int prediction_method; |
1407 | #define FF_PRED_LEFT 0 | |
1408 | #define FF_PRED_PLANE 1 | |
1409 | #define FF_PRED_MEDIAN 2 | |
115329f1 | 1410 | |
b71901e6 | 1411 | /** |
b1edfce0 AK |
1412 | * slice offsets in the frame in bytes |
1413 | * - encoding: Set/allocated by libavcodec. | |
1414 | * - decoding: Set/allocated by user (or NULL). | |
b71901e6 | 1415 | */ |
b1edfce0 | 1416 | int *slice_offset; |
0fd90455 | 1417 | |
b71901e6 | 1418 | /** |
b1edfce0 AK |
1419 | * sample aspect ratio (0 if unknown) |
1420 | * That is the width of a pixel divided by the height of the pixel. | |
1421 | * Numerator and denominator must be relatively prime and smaller than 256 for some video standards. | |
1422 | * - encoding: Set by user. | |
f5bccd85 | 1423 | * - decoding: Set by libavcodec. |
b71901e6 | 1424 | */ |
b1edfce0 | 1425 | AVRational sample_aspect_ratio; |
115329f1 | 1426 | |
b71901e6 | 1427 | /** |
b1edfce0 | 1428 | * motion estimation comparison function |
f5bccd85 | 1429 | * - encoding: Set by user. |
64863965 | 1430 | * - decoding: unused |
b71901e6 | 1431 | */ |
b1edfce0 | 1432 | int me_cmp; |
b71901e6 | 1433 | /** |
b1edfce0 | 1434 | * subpixel motion estimation comparison function |
f5bccd85 | 1435 | * - encoding: Set by user. |
64863965 | 1436 | * - decoding: unused |
b71901e6 | 1437 | */ |
b1edfce0 | 1438 | int me_sub_cmp; |
b71901e6 | 1439 | /** |
b1edfce0 | 1440 | * macroblock comparison function (not supported yet) |
f5bccd85 | 1441 | * - encoding: Set by user. |
64863965 | 1442 | * - decoding: unused |
b71901e6 | 1443 | */ |
b1edfce0 | 1444 | int mb_cmp; |
b71901e6 | 1445 | /** |
b1edfce0 | 1446 | * interlaced DCT comparison function |
f5bccd85 | 1447 | * - encoding: Set by user. |
64863965 | 1448 | * - decoding: unused |
b71901e6 | 1449 | */ |
b1edfce0 AK |
1450 | int ildct_cmp; |
1451 | #define FF_CMP_SAD 0 | |
1452 | #define FF_CMP_SSE 1 | |
1453 | #define FF_CMP_SATD 2 | |
1454 | #define FF_CMP_DCT 3 | |
1455 | #define FF_CMP_PSNR 4 | |
1456 | #define FF_CMP_BIT 5 | |
1457 | #define FF_CMP_RD 6 | |
1458 | #define FF_CMP_ZERO 7 | |
1459 | #define FF_CMP_VSAD 8 | |
1460 | #define FF_CMP_VSSE 9 | |
1461 | #define FF_CMP_NSSE 10 | |
b1edfce0 AK |
1462 | #define FF_CMP_DCTMAX 13 |
1463 | #define FF_CMP_DCT264 14 | |
1464 | #define FF_CMP_CHROMA 256 | |
115329f1 | 1465 | |
b71901e6 | 1466 | /** |
b1edfce0 | 1467 | * ME diamond size & shape |
f5bccd85 | 1468 | * - encoding: Set by user. |
64863965 | 1469 | * - decoding: unused |
b71901e6 | 1470 | */ |
b1edfce0 | 1471 | int dia_size; |
b71901e6 MN |
1472 | |
1473 | /** | |
b1edfce0 | 1474 | * amount of previous MV predictors (2a+1 x 2a+1 square) |
f5bccd85 | 1475 | * - encoding: Set by user. |
64863965 | 1476 | * - decoding: unused |
b71901e6 | 1477 | */ |
b1edfce0 | 1478 | int last_predictor_count; |
115329f1 | 1479 | |
b71901e6 | 1480 | /** |
b1edfce0 | 1481 | * prepass for motion estimation |
f5bccd85 | 1482 | * - encoding: Set by user. |
64863965 | 1483 | * - decoding: unused |
b71901e6 | 1484 | */ |
b1edfce0 | 1485 | int pre_me; |
115329f1 | 1486 | |
b71901e6 | 1487 | /** |
b1edfce0 | 1488 | * motion estimation prepass comparison function |
f5bccd85 | 1489 | * - encoding: Set by user. |
64863965 | 1490 | * - decoding: unused |
b71901e6 | 1491 | */ |
b1edfce0 | 1492 | int me_pre_cmp; |
917e06c8 | 1493 | |
b71901e6 | 1494 | /** |
b1edfce0 | 1495 | * ME prepass diamond size & shape |
f5bccd85 | 1496 | * - encoding: Set by user. |
64863965 | 1497 | * - decoding: unused |
b71901e6 | 1498 | */ |
b1edfce0 | 1499 | int pre_dia_size; |
115329f1 | 1500 | |
c5d309f2 | 1501 | /** |
b1edfce0 | 1502 | * subpel ME quality |
f5bccd85 | 1503 | * - encoding: Set by user. |
64863965 | 1504 | * - decoding: unused |
c5d309f2 | 1505 | */ |
b1edfce0 | 1506 | int me_subpel_quality; |
115329f1 | 1507 | |
1ef9e837 | 1508 | #if FF_API_AFD |
c5d309f2 | 1509 | /** |
b1edfce0 AK |
1510 | * DTG active format information (additional aspect ratio |
1511 | * information only used in DVB MPEG-2 transport streams) | |
1512 | * 0 if not set. | |
1513 | * | |
1514 | * - encoding: unused | |
1515 | * - decoding: Set by decoder. | |
1ef9e837 | 1516 | * @deprecated Deprecated in favor of AVSideData |
c5d309f2 | 1517 | */ |
1ef9e837 | 1518 | attribute_deprecated int dtg_active_format; |
b1edfce0 AK |
1519 | #define FF_DTG_AFD_SAME 8 |
1520 | #define FF_DTG_AFD_4_3 9 | |
1521 | #define FF_DTG_AFD_16_9 10 | |
1522 | #define FF_DTG_AFD_14_9 11 | |
1523 | #define FF_DTG_AFD_4_3_SP_14_9 13 | |
1524 | #define FF_DTG_AFD_16_9_SP_14_9 14 | |
1525 | #define FF_DTG_AFD_SP_4_3 15 | |
1ef9e837 | 1526 | #endif /* FF_API_AFD */ |
115329f1 | 1527 | |
c5d309f2 | 1528 | /** |
b1edfce0 AK |
1529 | * maximum motion estimation search range in subpel units |
1530 | * If 0 then no limit. | |
1531 | * | |
f5bccd85 | 1532 | * - encoding: Set by user. |
64863965 | 1533 | * - decoding: unused |
c5d309f2 | 1534 | */ |
b1edfce0 | 1535 | int me_range; |
115329f1 | 1536 | |
c5d309f2 | 1537 | /** |
b1edfce0 | 1538 | * intra quantizer bias |
f5bccd85 | 1539 | * - encoding: Set by user. |
64863965 | 1540 | * - decoding: unused |
c5d309f2 | 1541 | */ |
b1edfce0 AK |
1542 | int intra_quant_bias; |
1543 | #define FF_DEFAULT_QUANT_BIAS 999999 | |
15415af4 | 1544 | |
5e746b99 | 1545 | /** |
b1edfce0 | 1546 | * inter quantizer bias |
f5bccd85 | 1547 | * - encoding: Set by user. |
64863965 | 1548 | * - decoding: unused |
5e746b99 | 1549 | */ |
b1edfce0 | 1550 | int inter_quant_bias; |
115329f1 | 1551 | |
144f0625 | 1552 | /** |
b1edfce0 AK |
1553 | * slice flags |
1554 | * - encoding: unused | |
1555 | * - decoding: Set by user. | |
144f0625 | 1556 | */ |
b1edfce0 AK |
1557 | int slice_flags; |
1558 | #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display | |
1559 | #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics) | |
1560 | #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1) | |
1561 | ||
19e30a58 | 1562 | #if FF_API_XVMC |
144f0625 | 1563 | /** |
b1edfce0 AK |
1564 | * XVideo Motion Acceleration |
1565 | * - encoding: forbidden | |
1566 | * - decoding: set by decoder | |
19e30a58 | 1567 | * @deprecated XvMC support is slated for removal. |
144f0625 | 1568 | */ |
19e30a58 DB |
1569 | attribute_deprecated int xvmc_acceleration; |
1570 | #endif /* FF_API_XVMC */ | |
144f0625 | 1571 | |
4d2858de | 1572 | /** |
b1edfce0 AK |
1573 | * macroblock decision mode |
1574 | * - encoding: Set by user. | |
1575 | * - decoding: unused | |
4d2858de | 1576 | */ |
b1edfce0 AK |
1577 | int mb_decision; |
1578 | #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp | |
1579 | #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits | |
1580 | #define FF_MB_DECISION_RD 2 ///< rate distortion | |
4d2858de | 1581 | |
6b72ac63 | 1582 | /** |
b1edfce0 AK |
1583 | * custom intra quantization matrix |
1584 | * - encoding: Set by user, can be NULL. | |
1585 | * - decoding: Set by libavcodec. | |
bec89a84 | 1586 | */ |
b1edfce0 | 1587 | uint16_t *intra_matrix; |
7160bb71 | 1588 | |
11f18faf | 1589 | /** |
b1edfce0 AK |
1590 | * custom inter quantization matrix |
1591 | * - encoding: Set by user, can be NULL. | |
1592 | * - decoding: Set by libavcodec. | |
11f18faf | 1593 | */ |
b1edfce0 | 1594 | uint16_t *inter_matrix; |
115329f1 | 1595 | |
11f18faf | 1596 | /** |
b1edfce0 AK |
1597 | * scene change detection threshold |
1598 | * 0 is default, larger means fewer detected scene changes. | |
f5bccd85 | 1599 | * - encoding: Set by user. |
64863965 | 1600 | * - decoding: unused |
11f18faf | 1601 | */ |
b1edfce0 | 1602 | int scenechange_threshold; |
115329f1 | 1603 | |
5d3cea3a | 1604 | /** |
b1edfce0 | 1605 | * noise reduction strength |
f5bccd85 | 1606 | * - encoding: Set by user. |
b1edfce0 | 1607 | * - decoding: unused |
5d3cea3a | 1608 | */ |
b1edfce0 | 1609 | int noise_reduction; |
1e491e29 | 1610 | |
59b55c49 | 1611 | #if FF_API_MPV_OPT |
140cb663 | 1612 | /** |
59b55c49 | 1613 | * @deprecated this field is unused |
0c9bbaec | 1614 | */ |
59b55c49 | 1615 | attribute_deprecated |
b1edfce0 | 1616 | int me_threshold; |
0c9bbaec WH |
1617 | |
1618 | /** | |
c4f7bee0 | 1619 | * @deprecated this field is unused |
140cb663 | 1620 | */ |
c4f7bee0 | 1621 | attribute_deprecated |
b1edfce0 | 1622 | int mb_threshold; |
c4f7bee0 | 1623 | #endif |
115329f1 | 1624 | |
1457ab52 | 1625 | /** |
b1edfce0 | 1626 | * precision of the intra DC coefficient - 8 |
f5bccd85 | 1627 | * - encoding: Set by user. |
64863965 | 1628 | * - decoding: unused |
1457ab52 | 1629 | */ |
b1edfce0 AK |
1630 | int intra_dc_precision; |
1631 | ||
1457ab52 | 1632 | /** |
b1edfce0 AK |
1633 | * Number of macroblock rows at the top which are skipped. |
1634 | * - encoding: unused | |
1635 | * - decoding: Set by user. | |
1457ab52 | 1636 | */ |
b1edfce0 AK |
1637 | int skip_top; |
1638 | ||
1457ab52 | 1639 | /** |
b1edfce0 AK |
1640 | * Number of macroblock rows at the bottom which are skipped. |
1641 | * - encoding: unused | |
1642 | * - decoding: Set by user. | |
1457ab52 | 1643 | */ |
b1edfce0 AK |
1644 | int skip_bottom; |
1645 | ||
622348f9 | 1646 | /** |
b1edfce0 AK |
1647 | * Border processing masking, raises the quantizer for mbs on the borders |
1648 | * of the picture. | |
f5bccd85 | 1649 | * - encoding: Set by user. |
622348f9 MN |
1650 | * - decoding: unused |
1651 | */ | |
b1edfce0 | 1652 | float border_masking; |
115329f1 | 1653 | |
1457ab52 | 1654 | /** |
b1edfce0 | 1655 | * minimum MB lagrange multipler |
f5bccd85 | 1656 | * - encoding: Set by user. |
64863965 | 1657 | * - decoding: unused |
1457ab52 | 1658 | */ |
b1edfce0 | 1659 | int mb_lmin; |
b07a5980 MN |
1660 | |
1661 | /** | |
b1edfce0 | 1662 | * maximum MB lagrange multipler |
f5bccd85 | 1663 | * - encoding: Set by user. |
64863965 | 1664 | * - decoding: unused |
b07a5980 | 1665 | */ |
b1edfce0 | 1666 | int mb_lmax; |
70ac76c0 | 1667 | |
f5fb6b34 | 1668 | /** |
b1edfce0 | 1669 | * |
f5bccd85 | 1670 | * - encoding: Set by user. |
64863965 | 1671 | * - decoding: unused |
f5fb6b34 | 1672 | */ |
b1edfce0 | 1673 | int me_penalty_compensation; |
b07a5980 | 1674 | |
70ac76c0 | 1675 | /** |
b1edfce0 | 1676 | * |
f5bccd85 | 1677 | * - encoding: Set by user. |
64863965 | 1678 | * - decoding: unused |
70ac76c0 | 1679 | */ |
b1edfce0 | 1680 | int bidir_refine; |
826f429a | 1681 | |
70ac76c0 | 1682 | /** |
b1edfce0 | 1683 | * |
f5bccd85 | 1684 | * - encoding: Set by user. |
64863965 | 1685 | * - decoding: unused |
70ac76c0 | 1686 | */ |
b1edfce0 | 1687 | int brd_scale; |
70ac76c0 | 1688 | |
826f429a | 1689 | /** |
b1edfce0 | 1690 | * minimum GOP size |
f5bccd85 | 1691 | * - encoding: Set by user. |
64863965 | 1692 | * - decoding: unused |
826f429a | 1693 | */ |
b1edfce0 | 1694 | int keyint_min; |
826f429a | 1695 | |
a33c7159 | 1696 | /** |
b1edfce0 AK |
1697 | * number of reference frames |
1698 | * - encoding: Set by user. | |
1699 | * - decoding: Set by lavc. | |
a33c7159 | 1700 | */ |
b1edfce0 | 1701 | int refs; |
e2f9490e FB |
1702 | |
1703 | /** | |
b1edfce0 AK |
1704 | * chroma qp offset from luma |
1705 | * - encoding: Set by user. | |
1706 | * - decoding: unused | |
e2f9490e | 1707 | */ |
b1edfce0 | 1708 | int chromaoffset; |
e2f9490e | 1709 | |
9f17685d | 1710 | #if FF_API_UNUSED_MEMBERS |
ebbcdc9a | 1711 | /** |
b1edfce0 | 1712 | * Multiplied by qscale for each frame and added to scene_change_score. |
f5bccd85 DB |
1713 | * - encoding: Set by user. |
1714 | * - decoding: unused | |
ebbcdc9a | 1715 | */ |
9f17685d DB |
1716 | attribute_deprecated int scenechange_factor; |
1717 | #endif | |
ebbcdc9a | 1718 | |
65f7062d | 1719 | /** |
b1edfce0 AK |
1720 | * |
1721 | * Note: Value depends upon the compare function used for fullpel ME. | |
f5bccd85 | 1722 | * - encoding: Set by user. |
1984f635 MN |
1723 | * - decoding: unused |
1724 | */ | |
b1edfce0 | 1725 | int mv0_threshold; |
115329f1 | 1726 | |
1984f635 | 1727 | /** |
b1edfce0 | 1728 | * Adjust sensitivity of b_frame_strategy 1. |
f5bccd85 | 1729 | * - encoding: Set by user. |
1984f635 MN |
1730 | * - decoding: unused |
1731 | */ | |
b1edfce0 | 1732 | int b_sensitivity; |
5cd62665 ZK |
1733 | |
1734 | /** | |
b1edfce0 AK |
1735 | * Chromaticity coordinates of the source primaries. |
1736 | * - encoding: Set by user | |
1737 | * - decoding: Set by libavcodec | |
5cd62665 | 1738 | */ |
b1edfce0 | 1739 | enum AVColorPrimaries color_primaries; |
115329f1 | 1740 | |
3d2e8cce | 1741 | /** |
b1edfce0 AK |
1742 | * Color Transfer Characteristic. |
1743 | * - encoding: Set by user | |
1744 | * - decoding: Set by libavcodec | |
3d2e8cce | 1745 | */ |
b1edfce0 | 1746 | enum AVColorTransferCharacteristic color_trc; |
115329f1 | 1747 | |
11e659c2 | 1748 | /** |
b1edfce0 AK |
1749 | * YUV colorspace type. |
1750 | * - encoding: Set by user | |
1751 | * - decoding: Set by libavcodec | |
1752 | */ | |
1753 | enum AVColorSpace colorspace; | |
1754 | ||
1755 | /** | |
1756 | * MPEG vs JPEG YUV range. | |
1757 | * - encoding: Set by user | |
1758 | * - decoding: Set by libavcodec | |
1759 | */ | |
1760 | enum AVColorRange color_range; | |
1761 | ||
1762 | /** | |
1763 | * This defines the location of chroma samples. | |
1764 | * - encoding: Set by user | |
1765 | * - decoding: Set by libavcodec | |
1766 | */ | |
1767 | enum AVChromaLocation chroma_sample_location; | |
1768 | ||
1769 | /** | |
1770 | * Number of slices. | |
1771 | * Indicates number of picture subdivisions. Used for parallelized | |
1772 | * decoding. | |
1773 | * - encoding: Set by user | |
11e659c2 MN |
1774 | * - decoding: unused |
1775 | */ | |
b1edfce0 AK |
1776 | int slices; |
1777 | ||
1778 | /** Field order | |
1779 | * - encoding: set by libavcodec | |
1780 | * - decoding: Set by libavcodec | |
1781 | */ | |
1782 | enum AVFieldOrder field_order; | |
1783 | ||
1784 | /* audio only */ | |
1785 | int sample_rate; ///< samples per second | |
1786 | int channels; ///< number of audio channels | |
11e659c2 MN |
1787 | |
1788 | /** | |
b1edfce0 | 1789 | * audio sample format |
f5bccd85 | 1790 | * - encoding: Set by user. |
b1edfce0 | 1791 | * - decoding: Set by libavcodec. |
11e659c2 | 1792 | */ |
b1edfce0 | 1793 | enum AVSampleFormat sample_fmt; ///< sample format |
115329f1 | 1794 | |
b1edfce0 | 1795 | /* The following data should not be initialized. */ |
3bb07d61 | 1796 | /** |
d6f4fe68 AK |
1797 | * Number of samples per channel in an audio frame. |
1798 | * | |
1799 | * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame | |
1800 | * except the last must contain exactly frame_size samples per channel. | |
1801 | * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the | |
1802 | * frame size is not restricted. | |
1803 | * - decoding: may be set by some decoders to indicate constant frame size | |
3bb07d61 | 1804 | */ |
b1edfce0 | 1805 | int frame_size; |
c179c9e1 AK |
1806 | |
1807 | /** | |
1808 | * Frame counter, set by libavcodec. | |
1809 | * | |
1810 | * - decoding: total number of frames returned from the decoder so far. | |
1811 | * - encoding: total number of frames passed to the encoder so far. | |
1812 | * | |
1813 | * @note the counter is not incremented if encoding/decoding resulted in | |
1814 | * an error. | |
1815 | */ | |
1816 | int frame_number; | |
3bb07d61 | 1817 | |
fb364ada | 1818 | /** |
b1edfce0 AK |
1819 | * number of bytes per packet if constant and known or 0 |
1820 | * Used by some WAV based audio codecs. | |
fb364ada | 1821 | */ |
b1edfce0 | 1822 | int block_align; |
115329f1 | 1823 | |
7d1c3fc1 | 1824 | /** |
b1edfce0 | 1825 | * Audio cutoff bandwidth (0 means "automatic") |
f5bccd85 | 1826 | * - encoding: Set by user. |
7d1c3fc1 MN |
1827 | * - decoding: unused |
1828 | */ | |
b1edfce0 | 1829 | int cutoff; |
d6eb3c50 | 1830 | |
b1edfce0 | 1831 | #if FF_API_REQUEST_CHANNELS |
d6eb3c50 | 1832 | /** |
b1edfce0 AK |
1833 | * Decoder should decode to this many channels if it can (0 for default) |
1834 | * - encoding: unused | |
1835 | * - decoding: Set by user. | |
1836 | * @deprecated Deprecated in favor of request_channel_layout. | |
d6eb3c50 | 1837 | */ |
bf4b0ed1 | 1838 | attribute_deprecated int request_channels; |
b1edfce0 | 1839 | #endif |
d6eb3c50 MN |
1840 | |
1841 | /** | |
b1edfce0 AK |
1842 | * Audio channel layout. |
1843 | * - encoding: set by user. | |
1844 | * - decoding: set by libavcodec. | |
d6eb3c50 | 1845 | */ |
b1edfce0 | 1846 | uint64_t channel_layout; |
115329f1 | 1847 | |
541ae140 | 1848 | /** |
b1edfce0 | 1849 | * Request decoder to use this channel layout if it can (0 for default) |
541ae140 | 1850 | * - encoding: unused |
b1edfce0 | 1851 | * - decoding: Set by user. |
541ae140 | 1852 | */ |
b1edfce0 | 1853 | uint64_t request_channel_layout; |
05fbd0a2 MN |
1854 | |
1855 | /** | |
b1edfce0 | 1856 | * Type of service that the audio stream conveys. |
f5bccd85 | 1857 | * - encoding: Set by user. |
b1edfce0 | 1858 | * - decoding: Set by libavcodec. |
05fbd0a2 | 1859 | */ |
b1edfce0 | 1860 | enum AVAudioServiceType audio_service_type; |
158c7f05 MN |
1861 | |
1862 | /** | |
b1edfce0 AK |
1863 | * Used to request a sample format from the decoder. |
1864 | * - encoding: unused. | |
1865 | * - decoding: Set by user. | |
158c7f05 | 1866 | */ |
b1edfce0 | 1867 | enum AVSampleFormat request_sample_fmt; |
158c7f05 | 1868 | |
759001c5 | 1869 | #if FF_API_GET_BUFFER |
158c7f05 | 1870 | /** |
b1edfce0 AK |
1871 | * Called at the beginning of each frame to get a buffer for it. |
1872 | * | |
1873 | * The function will set AVFrame.data[], AVFrame.linesize[]. | |
1874 | * AVFrame.extended_data[] must also be set, but it should be the same as | |
1875 | * AVFrame.data[] except for planar audio with more channels than can fit | |
1876 | * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as | |
1877 | * many data pointers as it can hold. | |
1878 | * | |
1879 | * if CODEC_CAP_DR1 is not set then get_buffer() must call | |
1880 | * avcodec_default_get_buffer() instead of providing buffers allocated by | |
1881 | * some other means. | |
1882 | * | |
1883 | * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't | |
1884 | * need it. avcodec_default_get_buffer() aligns the output buffer properly, | |
1885 | * but if get_buffer() is overridden then alignment considerations should | |
1886 | * be taken into account. | |
1887 | * | |
1888 | * @see avcodec_default_get_buffer() | |
1889 | * | |
1890 | * Video: | |
1891 | * | |
1892 | * If pic.reference is set then the frame will be read later by libavcodec. | |
1893 | * avcodec_align_dimensions2() should be used to find the required width and | |
1894 | * height, as they normally need to be rounded up to the next multiple of 16. | |
1895 | * | |
1896 | * If frame multithreading is used and thread_safe_callbacks is set, | |
1897 | * it may be called from a different thread, but not from more than one at | |
1898 | * once. Does not need to be reentrant. | |
1899 | * | |
1900 | * @see release_buffer(), reget_buffer() | |
1901 | * @see avcodec_align_dimensions2() | |
1902 | * | |
1903 | * Audio: | |
1904 | * | |
1905 | * Decoders request a buffer of a particular size by setting | |
1906 | * AVFrame.nb_samples prior to calling get_buffer(). The decoder may, | |
1907 | * however, utilize only part of the buffer by setting AVFrame.nb_samples | |
1908 | * to a smaller value in the output frame. | |
1909 | * | |
1910 | * Decoders cannot use the buffer after returning from | |
1911 | * avcodec_decode_audio4(), so they will not call release_buffer(), as it | |
8e134e51 JR |
1912 | * is assumed to be released immediately upon return. In some rare cases, |
1913 | * a decoder may need to call get_buffer() more than once in a single | |
1914 | * call to avcodec_decode_audio4(). In that case, when get_buffer() is | |
1915 | * called again after it has already been called once, the previously | |
1916 | * acquired buffer is assumed to be released at that time and may not be | |
1917 | * reused by the decoder. | |
b1edfce0 AK |
1918 | * |
1919 | * As a convenience, av_samples_get_buffer_size() and | |
1920 | * av_samples_fill_arrays() in libavutil may be used by custom get_buffer() | |
1921 | * functions to find the required data size and to fill data pointers and | |
1922 | * linesize. In AVFrame.linesize, only linesize[0] may be set for audio | |
1923 | * since all planes must be the same size. | |
1924 | * | |
1925 | * @see av_samples_get_buffer_size(), av_samples_fill_arrays() | |
1926 | * | |
1927 | * - encoding: unused | |
1928 | * - decoding: Set by libavcodec, user can override. | |
759001c5 AK |
1929 | * |
1930 | * @deprecated use get_buffer2() | |
158c7f05 | 1931 | */ |
759001c5 | 1932 | attribute_deprecated |
b1edfce0 | 1933 | int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic); |
2a2bbcb0 | 1934 | |
821cb11f | 1935 | /** |
b1edfce0 AK |
1936 | * Called to release buffers which were allocated with get_buffer. |
1937 | * A released buffer can be reused in get_buffer(). | |
1938 | * pic.data[*] must be set to NULL. | |
1939 | * May be called from a different thread if frame multithreading is used, | |
1940 | * but not by more than one thread at once, so does not need to be reentrant. | |
1941 | * - encoding: unused | |
1942 | * - decoding: Set by libavcodec, user can override. | |
759001c5 AK |
1943 | * |
1944 | * @deprecated custom freeing callbacks should be set from get_buffer2() | |
821cb11f | 1945 | */ |
759001c5 | 1946 | attribute_deprecated |
b1edfce0 | 1947 | void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic); |
115329f1 | 1948 | |
074c4ca7 | 1949 | /** |
f5bccd85 DB |
1950 | * Called at the beginning of a frame to get cr buffer for it. |
1951 | * Buffer type (size, hints) must be the same. libavcodec won't check it. | |
1952 | * libavcodec will pass previous buffer in pic, function should return | |
e1c2a5a0 | 1953 | * same buffer or new buffer with old frame "painted" into it. |
f5bccd85 | 1954 | * If pic.data[0] == NULL must behave like get_buffer(). |
f1b99cc6 MN |
1955 | * if CODEC_CAP_DR1 is not set then reget_buffer() must call |
1956 | * avcodec_default_reget_buffer() instead of providing buffers allocated by | |
1957 | * some other means. | |
074c4ca7 | 1958 | * - encoding: unused |
53128bc3 | 1959 | * - decoding: Set by libavcodec, user can override. |
074c4ca7 | 1960 | */ |
759001c5 | 1961 | attribute_deprecated |
e1c2a5a0 | 1962 | int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic); |
759001c5 | 1963 | #endif |
ba58dabc | 1964 | |
759001c5 AK |
1965 | /** |
1966 | * This callback is called at the beginning of each frame to get data | |
1967 | * buffer(s) for it. There may be one contiguous buffer for all the data or | |
00b8e650 DB |
1968 | * there may be a buffer per each data plane or anything in between. What |
1969 | * this means is, you may set however many entries in buf[] you feel necessary. | |
1970 | * Each buffer must be reference-counted using the AVBuffer API (see description | |
1971 | * of buf[] below). | |
759001c5 AK |
1972 | * |
1973 | * The following fields will be set in the frame before this callback is | |
1974 | * called: | |
1975 | * - format | |
1976 | * - width, height (video only) | |
1977 | * - sample_rate, channel_layout, nb_samples (audio only) | |
1978 | * Their values may differ from the corresponding values in | |
1979 | * AVCodecContext. This callback must use the frame values, not the codec | |
1980 | * context values, to calculate the required buffer size. | |
1981 | * | |
1982 | * This callback must fill the following fields in the frame: | |
1983 | * - data[] | |
1984 | * - linesize[] | |
1985 | * - extended_data: | |
1986 | * * if the data is planar audio with more than 8 channels, then this | |
1987 | * callback must allocate and fill extended_data to contain all pointers | |
1988 | * to all data planes. data[] must hold as many pointers as it can. | |
1989 | * extended_data must be allocated with av_malloc() and will be freed in | |
1990 | * av_frame_unref(). | |
1991 | * * otherwise exended_data must point to data | |
4cdb3c50 DB |
1992 | * - buf[] must contain one or more pointers to AVBufferRef structures. Each of |
1993 | * the frame's data and extended_data pointers must be contained in these. That | |
1994 | * is, one AVBufferRef for each allocated chunk of memory, not necessarily one | |
1995 | * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(), | |
1996 | * and av_buffer_ref(). | |
759001c5 AK |
1997 | * - extended_buf and nb_extended_buf must be allocated with av_malloc() by |
1998 | * this callback and filled with the extra buffers if there are more | |
1999 | * buffers than buf[] can hold. extended_buf will be freed in | |
2000 | * av_frame_unref(). | |
2001 | * | |
2002 | * If CODEC_CAP_DR1 is not set then get_buffer2() must call | |
2003 | * avcodec_default_get_buffer2() instead of providing buffers allocated by | |
2004 | * some other means. | |
2005 | * | |
2006 | * Each data plane must be aligned to the maximum required by the target | |
2007 | * CPU. | |
2008 | * | |
2009 | * @see avcodec_default_get_buffer2() | |
2010 | * | |
2011 | * Video: | |
2012 | * | |
2013 | * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused | |
2014 | * (read and/or written to if it is writable) later by libavcodec. | |
2015 | * | |
759001c5 AK |
2016 | * avcodec_align_dimensions2() should be used to find the required width and |
2017 | * height, as they normally need to be rounded up to the next multiple of 16. | |
2018 | * | |
2019 | * If frame multithreading is used and thread_safe_callbacks is set, | |
2020 | * this callback may be called from a different thread, but not from more | |
2021 | * than one at once. Does not need to be reentrant. | |
2022 | * | |
2023 | * @see avcodec_align_dimensions2() | |
2024 | * | |
2025 | * Audio: | |
2026 | * | |
2027 | * Decoders request a buffer of a particular size by setting | |
2028 | * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may, | |
2029 | * however, utilize only part of the buffer by setting AVFrame.nb_samples | |
2030 | * to a smaller value in the output frame. | |
2031 | * | |
2032 | * As a convenience, av_samples_get_buffer_size() and | |
2033 | * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2() | |
2034 | * functions to find the required data size and to fill data pointers and | |
2035 | * linesize. In AVFrame.linesize, only linesize[0] may be set for audio | |
2036 | * since all planes must be the same size. | |
2037 | * | |
2038 | * @see av_samples_get_buffer_size(), av_samples_fill_arrays() | |
2039 | * | |
2040 | * - encoding: unused | |
2041 | * - decoding: Set by libavcodec, user can override. | |
2042 | */ | |
2043 | int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags); | |
2044 | ||
2045 | /** | |
2046 | * If non-zero, the decoded audio and video frames returned from | |
2047 | * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted | |
2048 | * and are valid indefinitely. The caller must free them with | |
2049 | * av_frame_unref() when they are not needed anymore. | |
2050 | * Otherwise, the decoded frames must not be freed by the caller and are | |
2051 | * only valid until the next decode call. | |
2052 | * | |
2053 | * - encoding: unused | |
2054 | * - decoding: set by the caller before avcodec_open2(). | |
2055 | */ | |
2056 | int refcounted_frames; | |
ba58dabc | 2057 | |
b1edfce0 AK |
2058 | /* - encoding parameters */ |
2059 | float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0) | |
2060 | float qblur; ///< amount of qscale smoothing over time (0.0-1.0) | |
ba58dabc MN |
2061 | |
2062 | /** | |
b1edfce0 | 2063 | * minimum quantizer |
f5bccd85 | 2064 | * - encoding: Set by user. |
b1edfce0 | 2065 | * - decoding: unused |
ba58dabc | 2066 | */ |
b1edfce0 | 2067 | int qmin; |
7ebfc0ea MN |
2068 | |
2069 | /** | |
b1edfce0 | 2070 | * maximum quantizer |
f5bccd85 DB |
2071 | * - encoding: Set by user. |
2072 | * - decoding: unused | |
7ebfc0ea | 2073 | */ |
b1edfce0 | 2074 | int qmax; |
115329f1 | 2075 | |
77ea0d4b | 2076 | /** |
b1edfce0 | 2077 | * maximum quantizer difference between frames |
f5bccd85 | 2078 | * - encoding: Set by user. |
77ea0d4b MN |
2079 | * - decoding: unused |
2080 | */ | |
b1edfce0 | 2081 | int max_qdiff; |
9c3d33d6 | 2082 | |
a6e4ce9f | 2083 | #if FF_API_MPV_OPT |
9c3d33d6 | 2084 | /** |
a6e4ce9f | 2085 | * @deprecated use encoder private options instead |
9c3d33d6 | 2086 | */ |
a6e4ce9f | 2087 | attribute_deprecated |
b1edfce0 | 2088 | float rc_qsquish; |
115329f1 | 2089 | |
946f9535 | 2090 | attribute_deprecated |
b1edfce0 | 2091 | float rc_qmod_amp; |
946f9535 | 2092 | attribute_deprecated |
b1edfce0 | 2093 | int rc_qmod_freq; |
946f9535 | 2094 | #endif |
a4d36c11 MN |
2095 | |
2096 | /** | |
b1edfce0 | 2097 | * decoder bitstream buffer size |
f5bccd85 | 2098 | * - encoding: Set by user. |
f20f8a8b | 2099 | * - decoding: unused |
a4d36c11 | 2100 | */ |
b1edfce0 | 2101 | int rc_buffer_size; |
f20f8a8b MN |
2102 | |
2103 | /** | |
b1edfce0 AK |
2104 | * ratecontrol override, see RcOverride |
2105 | * - encoding: Allocated/set/freed by user. | |
f20f8a8b MN |
2106 | * - decoding: unused |
2107 | */ | |
b1edfce0 AK |
2108 | int rc_override_count; |
2109 | RcOverride *rc_override; | |
bf266e19 | 2110 | |
a75c2eb2 | 2111 | #if FF_API_MPV_OPT |
bf266e19 | 2112 | /** |
a75c2eb2 | 2113 | * @deprecated use encoder private options instead |
bf266e19 | 2114 | */ |
a75c2eb2 | 2115 | attribute_deprecated |
b1edfce0 | 2116 | const char *rc_eq; |
a75c2eb2 | 2117 | #endif |
d4c5d2ad MN |
2118 | |
2119 | /** | |
b1edfce0 | 2120 | * maximum bitrate |
f5bccd85 | 2121 | * - encoding: Set by user. |
d4c5d2ad MN |
2122 | * - decoding: unused |
2123 | */ | |
b1edfce0 | 2124 | int rc_max_rate; |
baced9f5 MN |
2125 | |
2126 | /** | |
b1edfce0 | 2127 | * minimum bitrate |
f5bccd85 | 2128 | * - encoding: Set by user. |
b1edfce0 | 2129 | * - decoding: unused |
baced9f5 | 2130 | */ |
b1edfce0 | 2131 | int rc_min_rate; |
0215006a | 2132 | |
66a68ddd | 2133 | #if FF_API_MPV_OPT |
baced9f5 | 2134 | /** |
66a68ddd | 2135 | * @deprecated use encoder private options instead |
178fcca8 | 2136 | */ |
66a68ddd AK |
2137 | attribute_deprecated |
2138 | float rc_buffer_aggressivity; | |
2139 | ||
2140 | attribute_deprecated | |
b1edfce0 | 2141 | float rc_initial_cplx; |
66a68ddd | 2142 | #endif |
21adafec MN |
2143 | |
2144 | /** | |
b1edfce0 AK |
2145 | * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow. |
2146 | * - encoding: Set by user. | |
2147 | * - decoding: unused. | |
21adafec | 2148 | */ |
b1edfce0 | 2149 | float rc_max_available_vbv_use; |
bbf18b21 MN |
2150 | |
2151 | /** | |
b1edfce0 | 2152 | * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow. |
f5bccd85 | 2153 | * - encoding: Set by user. |
b1edfce0 | 2154 | * - decoding: unused. |
bbf18b21 | 2155 | */ |
b1edfce0 | 2156 | float rc_min_vbv_overflow_use; |
bbf18b21 MN |
2157 | |
2158 | /** | |
b1edfce0 | 2159 | * Number of bits which should be loaded into the rc buffer before decoding starts. |
f5bccd85 | 2160 | * - encoding: Set by user. |
bbf18b21 MN |
2161 | * - decoding: unused |
2162 | */ | |
b1edfce0 | 2163 | int rc_initial_buffer_occupancy; |
0fd6aea1 | 2164 | |
b1edfce0 AK |
2165 | #define FF_CODER_TYPE_VLC 0 |
2166 | #define FF_CODER_TYPE_AC 1 | |
2167 | #define FF_CODER_TYPE_RAW 2 | |
2168 | #define FF_CODER_TYPE_RLE 3 | |
9f17685d | 2169 | #if FF_API_UNUSED_MEMBERS |
b1edfce0 | 2170 | #define FF_CODER_TYPE_DEFLATE 4 |
9f17685d | 2171 | #endif /* FF_API_UNUSED_MEMBERS */ |
0fd6aea1 | 2172 | /** |
b1edfce0 | 2173 | * coder type |
f5bccd85 | 2174 | * - encoding: Set by user. |
0fd6aea1 MN |
2175 | * - decoding: unused |
2176 | */ | |
b1edfce0 | 2177 | int coder_type; |
0fd6aea1 MN |
2178 | |
2179 | /** | |
b1edfce0 | 2180 | * context model |
f5bccd85 | 2181 | * - encoding: Set by user. |
0fd6aea1 MN |
2182 | * - decoding: unused |
2183 | */ | |
b1edfce0 | 2184 | int context_model; |
957c743a CM |
2185 | |
2186 | /** | |
b1edfce0 | 2187 | * minimum Lagrange multipler |
f5bccd85 | 2188 | * - encoding: Set by user. |
957c743a CM |
2189 | * - decoding: unused |
2190 | */ | |
b1edfce0 | 2191 | int lmin; |
6e0d8c06 MN |
2192 | |
2193 | /** | |
b1edfce0 | 2194 | * maximum Lagrange multipler |
f5bccd85 | 2195 | * - encoding: Set by user. |
6e0d8c06 MN |
2196 | * - decoding: unused |
2197 | */ | |
b1edfce0 | 2198 | int lmax; |
6e0d8c06 MN |
2199 | |
2200 | /** | |
b1edfce0 | 2201 | * frame skip threshold |
f5bccd85 | 2202 | * - encoding: Set by user. |
6e0d8c06 MN |
2203 | * - decoding: unused |
2204 | */ | |
b1edfce0 | 2205 | int frame_skip_threshold; |
09c3e44e MN |
2206 | |
2207 | /** | |
b1edfce0 | 2208 | * frame skip factor |
f5bccd85 | 2209 | * - encoding: Set by user. |
09c3e44e MN |
2210 | * - decoding: unused |
2211 | */ | |
b1edfce0 | 2212 | int frame_skip_factor; |
316a2ec8 MN |
2213 | |
2214 | /** | |
b1edfce0 | 2215 | * frame skip exponent |
f5bccd85 | 2216 | * - encoding: Set by user. |
316a2ec8 MN |
2217 | * - decoding: unused |
2218 | */ | |
b1edfce0 | 2219 | int frame_skip_exp; |
e8501c93 MN |
2220 | |
2221 | /** | |
b1edfce0 | 2222 | * frame skip comparison function |
f5bccd85 | 2223 | * - encoding: Set by user. |
e8501c93 MN |
2224 | * - decoding: unused |
2225 | */ | |
b1edfce0 | 2226 | int frame_skip_cmp; |
58f7833e | 2227 | |
58f7833e | 2228 | /** |
b1edfce0 | 2229 | * trellis RD quantization |
f5bccd85 | 2230 | * - encoding: Set by user. |
58f7833e RS |
2231 | * - decoding: unused |
2232 | */ | |
b1edfce0 | 2233 | int trellis; |
58f7833e RS |
2234 | |
2235 | /** | |
f5bccd85 | 2236 | * - encoding: Set by user. |
b1edfce0 | 2237 | * - decoding: unused |
58f7833e | 2238 | */ |
b1edfce0 | 2239 | int min_prediction_order; |
58f7833e RS |
2240 | |
2241 | /** | |
f5bccd85 | 2242 | * - encoding: Set by user. |
58f7833e RS |
2243 | * - decoding: unused |
2244 | */ | |
b1edfce0 | 2245 | int max_prediction_order; |
58f7833e | 2246 | |
58f7833e | 2247 | /** |
b1edfce0 | 2248 | * GOP timecode frame start number, in non drop frame format |
f5bccd85 | 2249 | * - encoding: Set by user. |
58f7833e RS |
2250 | * - decoding: unused |
2251 | */ | |
b1edfce0 AK |
2252 | int64_t timecode_frame_start; |
2253 | ||
2254 | /* The RTP callback: This function is called */ | |
2255 | /* every time the encoder has a packet to send. */ | |
2256 | /* It depends on the encoder if the data starts */ | |
2257 | /* with a Start Code (it should). H.263 does. */ | |
2258 | /* mb_nb contains the number of macroblocks */ | |
2259 | /* encoded in the RTP payload. */ | |
2260 | void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb); | |
2261 | ||
2262 | int rtp_payload_size; /* The size of the RTP payload: the coder will */ | |
2263 | /* do its best to deliver a chunk with size */ | |
2264 | /* below rtp_payload_size, the chunk will start */ | |
2265 | /* with a start code on some codecs like H.263. */ | |
2266 | /* This doesn't take account of any particular */ | |
2267 | /* headers inside the transmitted RTP payload. */ | |
2268 | ||
2269 | /* statistics, used for 2-pass encoding */ | |
2270 | int mv_bits; | |
2271 | int header_bits; | |
2272 | int i_tex_bits; | |
2273 | int p_tex_bits; | |
2274 | int i_count; | |
2275 | int p_count; | |
2276 | int skip_count; | |
2277 | int misc_bits; | |
58f7833e | 2278 | |
14f0c8e2 | 2279 | /** |
b1edfce0 AK |
2280 | * number of bits used for the previously encoded frame |
2281 | * - encoding: Set by libavcodec. | |
14f0c8e2 LA |
2282 | * - decoding: unused |
2283 | */ | |
b1edfce0 | 2284 | int frame_bits; |
39a64e30 CH |
2285 | |
2286 | /** | |
b1edfce0 AK |
2287 | * pass1 encoding statistics output buffer |
2288 | * - encoding: Set by libavcodec. | |
39a64e30 CH |
2289 | * - decoding: unused |
2290 | */ | |
b1edfce0 | 2291 | char *stats_out; |
1dd509b1 MN |
2292 | |
2293 | /** | |
b1edfce0 AK |
2294 | * pass2 encoding statistics input buffer |
2295 | * Concatenated stuff from stats_out of pass1 should be placed here. | |
2296 | * - encoding: Allocated/set/freed by user. | |
1dd509b1 MN |
2297 | * - decoding: unused |
2298 | */ | |
b1edfce0 | 2299 | char *stats_in; |
f9243d34 CH |
2300 | |
2301 | /** | |
b1edfce0 AK |
2302 | * Work around bugs in encoders which sometimes cannot be detected automatically. |
2303 | * - encoding: Set by user | |
2304 | * - decoding: Set by user | |
f9243d34 | 2305 | */ |
b1edfce0 AK |
2306 | int workaround_bugs; |
2307 | #define FF_BUG_AUTODETECT 1 ///< autodetection | |
eb5920c1 | 2308 | #if FF_API_OLD_MSMPEG4 |
b1edfce0 | 2309 | #define FF_BUG_OLD_MSMPEG4 2 |
eb5920c1 | 2310 | #endif |
b1edfce0 AK |
2311 | #define FF_BUG_XVID_ILACE 4 |
2312 | #define FF_BUG_UMP4 8 | |
2313 | #define FF_BUG_NO_PADDING 16 | |
2314 | #define FF_BUG_AMV 32 | |
0300962b | 2315 | #if FF_API_AC_VLC |
b1edfce0 | 2316 | #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default. |
0300962b | 2317 | #endif |
b1edfce0 AK |
2318 | #define FF_BUG_QPEL_CHROMA 64 |
2319 | #define FF_BUG_STD_QPEL 128 | |
2320 | #define FF_BUG_QPEL_CHROMA2 256 | |
2321 | #define FF_BUG_DIRECT_BLOCKSIZE 512 | |
2322 | #define FF_BUG_EDGE 1024 | |
2323 | #define FF_BUG_HPEL_CHROMA 2048 | |
2324 | #define FF_BUG_DC_CLIP 4096 | |
2325 | #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders. | |
2326 | #define FF_BUG_TRUNCATED 16384 | |
a403fc03 JR |
2327 | |
2328 | /** | |
b1edfce0 | 2329 | * strictly follow the standard (MPEG4, ...). |
f5bccd85 | 2330 | * - encoding: Set by user. |
b1edfce0 AK |
2331 | * - decoding: Set by user. |
2332 | * Setting this to STRICT or higher means the encoder and decoder will | |
2333 | * generally do stupid things, whereas setting it to unofficial or lower | |
2334 | * will mean the encoder might produce output that is not supported by all | |
2335 | * spec-compliant decoders. Decoders don't differentiate between normal, | |
2336 | * unofficial and experimental (that is, they always try to decode things | |
2337 | * when they can) unless they are explicitly asked to behave stupidly | |
2338 | * (=strictly conform to the specs) | |
a403fc03 | 2339 | */ |
b1edfce0 AK |
2340 | int strict_std_compliance; |
2341 | #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software. | |
2342 | #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences. | |
2343 | #define FF_COMPLIANCE_NORMAL 0 | |
2344 | #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions | |
2345 | #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things. | |
a403fc03 | 2346 | |
a403fc03 | 2347 | /** |
b1edfce0 AK |
2348 | * error concealment flags |
2349 | * - encoding: unused | |
2350 | * - decoding: Set by user. | |
a403fc03 | 2351 | */ |
b1edfce0 AK |
2352 | int error_concealment; |
2353 | #define FF_EC_GUESS_MVS 1 | |
2354 | #define FF_EC_DEBLOCK 2 | |
a403fc03 JR |
2355 | |
2356 | /** | |
b1edfce0 | 2357 | * debug |
f5bccd85 | 2358 | * - encoding: Set by user. |
b1edfce0 | 2359 | * - decoding: Set by user. |
a403fc03 | 2360 | */ |
b1edfce0 AK |
2361 | int debug; |
2362 | #define FF_DEBUG_PICT_INFO 1 | |
2363 | #define FF_DEBUG_RC 2 | |
2364 | #define FF_DEBUG_BITSTREAM 4 | |
2365 | #define FF_DEBUG_MB_TYPE 8 | |
2366 | #define FF_DEBUG_QP 16 | |
ccc71298 AK |
2367 | #if FF_API_DEBUG_MV |
2368 | /** | |
2369 | * @deprecated this option does nothing | |
2370 | */ | |
b1edfce0 | 2371 | #define FF_DEBUG_MV 32 |
ccc71298 | 2372 | #endif |
b1edfce0 AK |
2373 | #define FF_DEBUG_DCT_COEFF 0x00000040 |
2374 | #define FF_DEBUG_SKIP 0x00000080 | |
2375 | #define FF_DEBUG_STARTCODE 0x00000100 | |
9f17685d | 2376 | #if FF_API_UNUSED_MEMBERS |
b1edfce0 | 2377 | #define FF_DEBUG_PTS 0x00000200 |
9f17685d | 2378 | #endif /* FF_API_UNUSED_MEMBERS */ |
b1edfce0 AK |
2379 | #define FF_DEBUG_ER 0x00000400 |
2380 | #define FF_DEBUG_MMCO 0x00000800 | |
2381 | #define FF_DEBUG_BUGS 0x00001000 | |
f8b2bcd2 | 2382 | #if FF_API_DEBUG_MV |
b1edfce0 AK |
2383 | #define FF_DEBUG_VIS_QP 0x00002000 |
2384 | #define FF_DEBUG_VIS_MB_TYPE 0x00004000 | |
f8b2bcd2 | 2385 | #endif |
b1edfce0 AK |
2386 | #define FF_DEBUG_BUFFERS 0x00008000 |
2387 | #define FF_DEBUG_THREADS 0x00010000 | |
188dea1d | 2388 | |
a1504eee | 2389 | #if FF_API_DEBUG_MV |
80d617f5 | 2390 | /** |
a1504eee | 2391 | * @deprecated this option does not have any effect |
80d617f5 | 2392 | */ |
a1504eee | 2393 | attribute_deprecated |
b1edfce0 AK |
2394 | int debug_mv; |
2395 | #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames | |
2396 | #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames | |
2397 | #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames | |
a1504eee | 2398 | #endif |
b1ec601f RD |
2399 | |
2400 | /** | |
b1edfce0 | 2401 | * Error recognition; may misdetect some more or less valid parts as errors. |
85947156 VS |
2402 | * - encoding: unused |
2403 | * - decoding: Set by user. | |
b1ec601f | 2404 | */ |
b1edfce0 | 2405 | int err_recognition; |
23a211cb AK |
2406 | |
2407 | /** | |
2408 | * Verify checksums embedded in the bitstream (could be of either encoded or | |
2409 | * decoded data, depending on the codec) and print an error message on mismatch. | |
2410 | * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the | |
2411 | * decoder returning an error. | |
2412 | */ | |
b1edfce0 AK |
2413 | #define AV_EF_CRCCHECK (1<<0) |
2414 | #define AV_EF_BITSTREAM (1<<1) | |
2415 | #define AV_EF_BUFFER (1<<2) | |
2416 | #define AV_EF_EXPLODE (1<<3) | |
1408352a | 2417 | |
79de84f2 MN |
2418 | /** |
2419 | * opaque 64bit number (generally a PTS) that will be reordered and | |
2420 | * output in AVFrame.reordered_opaque | |
2421 | * - encoding: unused | |
2422 | * - decoding: Set by user. | |
2423 | */ | |
2424 | int64_t reordered_opaque; | |
312420f3 PR |
2425 | |
2426 | /** | |
b1edfce0 AK |
2427 | * Hardware accelerator in use |
2428 | * - encoding: unused. | |
2429 | * - decoding: Set by libavcodec | |
312420f3 | 2430 | */ |
b1edfce0 | 2431 | struct AVHWAccel *hwaccel; |
0d72e7d0 PR |
2432 | |
2433 | /** | |
b1edfce0 AK |
2434 | * Hardware accelerator context. |
2435 | * For some hardware accelerators, a global context needs to be | |
2436 | * provided by the user. In that case, this holds display-dependent | |
2437 | * data Libav cannot instantiate itself. Please refer to the | |
2438 | * Libav HW accelerator documentation to know how to fill this | |
2439 | * is. e.g. for VA API, this is a struct vaapi_context. | |
2440 | * - encoding: unused | |
2441 | * - decoding: Set by user | |
0d72e7d0 | 2442 | */ |
b1edfce0 | 2443 | void *hwaccel_context; |
0d72e7d0 PR |
2444 | |
2445 | /** | |
b1edfce0 AK |
2446 | * error |
2447 | * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR. | |
2448 | * - decoding: unused | |
0d72e7d0 | 2449 | */ |
b1edfce0 | 2450 | uint64_t error[AV_NUM_DATA_POINTERS]; |
3bff4d8b BC |
2451 | |
2452 | /** | |
b1edfce0 | 2453 | * DCT algorithm, see FF_DCT_* below |
3bff4d8b | 2454 | * - encoding: Set by user. |
b1edfce0 | 2455 | * - decoding: unused |
3bff4d8b | 2456 | */ |
b1edfce0 AK |
2457 | int dct_algo; |
2458 | #define FF_DCT_AUTO 0 | |
2459 | #define FF_DCT_FASTINT 1 | |
9f17685d | 2460 | #if FF_API_UNUSED_MEMBERS |
b1edfce0 | 2461 | #define FF_DCT_INT 2 |
9f17685d | 2462 | #endif /* FF_API_UNUSED_MEMBERS */ |
b1edfce0 AK |
2463 | #define FF_DCT_MMX 3 |
2464 | #define FF_DCT_ALTIVEC 5 | |
2465 | #define FF_DCT_FAAN 6 | |
3bff4d8b BC |
2466 | |
2467 | /** | |
b1edfce0 | 2468 | * IDCT algorithm, see FF_IDCT_* below. |
3bff4d8b | 2469 | * - encoding: Set by user. |
b1edfce0 | 2470 | * - decoding: Set by user. |
3bff4d8b | 2471 | */ |
b1edfce0 AK |
2472 | int idct_algo; |
2473 | #define FF_IDCT_AUTO 0 | |
2474 | #define FF_IDCT_INT 1 | |
2475 | #define FF_IDCT_SIMPLE 2 | |
2476 | #define FF_IDCT_SIMPLEMMX 3 | |
b1edfce0 AK |
2477 | #define FF_IDCT_ARM 7 |
2478 | #define FF_IDCT_ALTIVEC 8 | |
d6096a67 | 2479 | #if FF_API_ARCH_SH4 |
b1edfce0 | 2480 | #define FF_IDCT_SH4 9 |
d6096a67 | 2481 | #endif |
b1edfce0 | 2482 | #define FF_IDCT_SIMPLEARM 10 |
9f17685d | 2483 | #if FF_API_UNUSED_MEMBERS |
b1edfce0 | 2484 | #define FF_IDCT_IPP 13 |
9f17685d | 2485 | #endif /* FF_API_UNUSED_MEMBERS */ |
d35b94fb DB |
2486 | #define FF_IDCT_XVID 14 |
2487 | #if FF_API_IDCT_XVIDMMX | |
b1edfce0 | 2488 | #define FF_IDCT_XVIDMMX 14 |
d35b94fb | 2489 | #endif /* FF_API_IDCT_XVIDMMX */ |
b1edfce0 AK |
2490 | #define FF_IDCT_SIMPLEARMV5TE 16 |
2491 | #define FF_IDCT_SIMPLEARMV6 17 | |
b4dd424d | 2492 | #if FF_API_ARCH_SPARC |
b1edfce0 | 2493 | #define FF_IDCT_SIMPLEVIS 18 |
b4dd424d | 2494 | #endif |
b1edfce0 | 2495 | #define FF_IDCT_FAAN 20 |
b1edfce0 | 2496 | #define FF_IDCT_SIMPLENEON 22 |
c7f7bfc9 | 2497 | #if FF_API_ARCH_ALPHA |
b1edfce0 | 2498 | #define FF_IDCT_SIMPLEALPHA 23 |
c7f7bfc9 | 2499 | #endif |
40e5d31b | 2500 | |
b1edfce0 AK |
2501 | /** |
2502 | * bits per sample/pixel from the demuxer (needed for huffyuv). | |
2503 | * - encoding: Set by libavcodec. | |
2504 | * - decoding: Set by user. | |
2505 | */ | |
2506 | int bits_per_coded_sample; | |
2507 | ||
2508 | /** | |
2509 | * Bits per sample/pixel of internal libavcodec pixel/sample format. | |
2510 | * - encoding: set by user. | |
2511 | * - decoding: set by libavcodec. | |
2512 | */ | |
2513 | int bits_per_raw_sample; | |
3797c74b | 2514 | |
803d21f3 | 2515 | #if FF_API_LOWRES |
3797c74b | 2516 | /** |
b1edfce0 AK |
2517 | * low resolution decoding, 1-> 1/2 size, 2->1/4 size |
2518 | * - encoding: unused | |
2519 | * - decoding: Set by user. | |
803d21f3 AK |
2520 | * |
2521 | * @deprecated use decoder private options instead | |
3797c74b | 2522 | */ |
2bcbd984 | 2523 | attribute_deprecated int lowres; |
803d21f3 | 2524 | #endif |
1aea7018 GB |
2525 | |
2526 | /** | |
b1edfce0 AK |
2527 | * the picture in the bitstream |
2528 | * - encoding: Set by libavcodec. | |
2ff302cb | 2529 | * - decoding: unused |
1aea7018 | 2530 | */ |
b1edfce0 | 2531 | AVFrame *coded_frame; |
4ee6a5c1 MN |
2532 | |
2533 | /** | |
b1edfce0 AK |
2534 | * thread count |
2535 | * is used to decide how many independent tasks should be passed to execute() | |
2536 | * - encoding: Set by user. | |
2537 | * - decoding: Set by user. | |
4ee6a5c1 | 2538 | */ |
b1edfce0 | 2539 | int thread_count; |
4ee6a5c1 MN |
2540 | |
2541 | /** | |
b1edfce0 AK |
2542 | * Which multithreading methods to use. |
2543 | * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread, | |
2544 | * so clients which cannot provide future frames should not use it. | |
2545 | * | |
2546 | * - encoding: Set by user, otherwise the default is used. | |
2547 | * - decoding: Set by user, otherwise the default is used. | |
4ee6a5c1 | 2548 | */ |
b1edfce0 AK |
2549 | int thread_type; |
2550 | #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once | |
2551 | #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once | |
4ee6a5c1 MN |
2552 | |
2553 | /** | |
b1edfce0 AK |
2554 | * Which multithreading methods are in use by the codec. |
2555 | * - encoding: Set by libavcodec. | |
2556 | * - decoding: Set by libavcodec. | |
4ee6a5c1 | 2557 | */ |
b1edfce0 | 2558 | int active_thread_type; |
4ee6a5c1 MN |
2559 | |
2560 | /** | |
b1edfce0 | 2561 | * Set by the client if its custom get_buffer() callback can be called |
ad027866 | 2562 | * synchronously from another thread, which allows faster multithreaded decoding. |
b1edfce0 AK |
2563 | * draw_horiz_band() will be called from other threads regardless of this setting. |
2564 | * Ignored if the default get_buffer() is used. | |
2565 | * - encoding: Set by user. | |
2566 | * - decoding: Set by user. | |
4ee6a5c1 | 2567 | */ |
b1edfce0 | 2568 | int thread_safe_callbacks; |
580a7465 DC |
2569 | |
2570 | /** | |
b1edfce0 AK |
2571 | * The codec may call this to execute several independent things. |
2572 | * It will return only after finishing all tasks. | |
2573 | * The user may replace this with some multithreaded implementation, | |
2574 | * the default implementation will execute the parts serially. | |
2575 | * @param count the number of things to execute | |
2576 | * - encoding: Set by libavcodec, user can override. | |
2577 | * - decoding: Set by libavcodec, user can override. | |
580a7465 | 2578 | */ |
b1edfce0 | 2579 | int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size); |
8d23a86f RD |
2580 | |
2581 | /** | |
2582 | * The codec may call this to execute several independent things. | |
2583 | * It will return only after finishing all tasks. | |
2584 | * The user may replace this with some multithreaded implementation, | |
2585 | * the default implementation will execute the parts serially. | |
2586 | * Also see avcodec_thread_init and e.g. the --enable-pthread configure option. | |
2587 | * @param c context passed also to func | |
2588 | * @param count the number of things to execute | |
2589 | * @param arg2 argument passed unchanged to func | |
2590 | * @param ret return values of executed functions, must have space for "count" values. May be NULL. | |
2591 | * @param func function that will be called count times, with jobnr from 0 to count-1. | |
2592 | * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no | |
2593 | * two instances of func executing at the same time will have the same threadnr. | |
2594 | * @return always 0 currently, but code should handle a future improvement where when any call to func | |
2595 | * returns < 0 no further calls to func may be done and < 0 is returned. | |
2596 | * - encoding: Set by libavcodec, user can override. | |
2597 | * - decoding: Set by libavcodec, user can override. | |
2598 | */ | |
2599 | int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count); | |
096c87f6 | 2600 | |
38ecc370 | 2601 | #if FF_API_THREAD_OPAQUE |
b1edfce0 | 2602 | /** |
38ecc370 | 2603 | * @deprecated this field should not be used from outside of lavc |
b1edfce0 | 2604 | */ |
38ecc370 | 2605 | attribute_deprecated |
b1edfce0 | 2606 | void *thread_opaque; |
38ecc370 | 2607 | #endif |
23940f14 | 2608 | |
2aa72ecc | 2609 | /** |
b1edfce0 AK |
2610 | * noise vs. sse weight for the nsse comparsion function |
2611 | * - encoding: Set by user. | |
2aa72ecc JZ |
2612 | * - decoding: unused |
2613 | */ | |
b1edfce0 | 2614 | int nsse_weight; |
cb2c971d AJ |
2615 | |
2616 | /** | |
b1edfce0 AK |
2617 | * profile |
2618 | * - encoding: Set by user. | |
2619 | * - decoding: Set by libavcodec. | |
cb2c971d | 2620 | */ |
b1edfce0 AK |
2621 | int profile; |
2622 | #define FF_PROFILE_UNKNOWN -99 | |
2623 | #define FF_PROFILE_RESERVED -100 | |
2624 | ||
2625 | #define FF_PROFILE_AAC_MAIN 0 | |
2626 | #define FF_PROFILE_AAC_LOW 1 | |
2627 | #define FF_PROFILE_AAC_SSR 2 | |
2628 | #define FF_PROFILE_AAC_LTP 3 | |
372597e5 MS |
2629 | #define FF_PROFILE_AAC_HE 4 |
2630 | #define FF_PROFILE_AAC_HE_V2 28 | |
2631 | #define FF_PROFILE_AAC_LD 22 | |
2632 | #define FF_PROFILE_AAC_ELD 38 | |
95d52464 KK |
2633 | #define FF_PROFILE_MPEG2_AAC_LOW 128 |
2634 | #define FF_PROFILE_MPEG2_AAC_HE 131 | |
b1edfce0 AK |
2635 | |
2636 | #define FF_PROFILE_DTS 20 | |
2637 | #define FF_PROFILE_DTS_ES 30 | |
2638 | #define FF_PROFILE_DTS_96_24 40 | |
2639 | #define FF_PROFILE_DTS_HD_HRA 50 | |
2640 | #define FF_PROFILE_DTS_HD_MA 60 | |
2641 | ||
2642 | #define FF_PROFILE_MPEG2_422 0 | |
2643 | #define FF_PROFILE_MPEG2_HIGH 1 | |
2644 | #define FF_PROFILE_MPEG2_SS 2 | |
2645 | #define FF_PROFILE_MPEG2_SNR_SCALABLE 3 | |
2646 | #define FF_PROFILE_MPEG2_MAIN 4 | |
2647 | #define FF_PROFILE_MPEG2_SIMPLE 5 | |
2648 | ||
2649 | #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag | |
2650 | #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag | |
2651 | ||
2652 | #define FF_PROFILE_H264_BASELINE 66 | |
2653 | #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED) | |
2654 | #define FF_PROFILE_H264_MAIN 77 | |
2655 | #define FF_PROFILE_H264_EXTENDED 88 | |
2656 | #define FF_PROFILE_H264_HIGH 100 | |
2657 | #define FF_PROFILE_H264_HIGH_10 110 | |
2658 | #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA) | |
2659 | #define FF_PROFILE_H264_HIGH_422 122 | |
2660 | #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA) | |
2661 | #define FF_PROFILE_H264_HIGH_444 144 | |
2662 | #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244 | |
2663 | #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA) | |
2664 | #define FF_PROFILE_H264_CAVLC_444 44 | |
2665 | ||
2666 | #define FF_PROFILE_VC1_SIMPLE 0 | |
2667 | #define FF_PROFILE_VC1_MAIN 1 | |
2668 | #define FF_PROFILE_VC1_COMPLEX 2 | |
2669 | #define FF_PROFILE_VC1_ADVANCED 3 | |
2670 | ||
2671 | #define FF_PROFILE_MPEG4_SIMPLE 0 | |
2672 | #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1 | |
2673 | #define FF_PROFILE_MPEG4_CORE 2 | |
2674 | #define FF_PROFILE_MPEG4_MAIN 3 | |
2675 | #define FF_PROFILE_MPEG4_N_BIT 4 | |
2676 | #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5 | |
2677 | #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6 | |
2678 | #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7 | |
2679 | #define FF_PROFILE_MPEG4_HYBRID 8 | |
2680 | #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9 | |
2681 | #define FF_PROFILE_MPEG4_CORE_SCALABLE 10 | |
2682 | #define FF_PROFILE_MPEG4_ADVANCED_CODING 11 | |
2683 | #define FF_PROFILE_MPEG4_ADVANCED_CORE 12 | |
2684 | #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13 | |
2685 | #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14 | |
2686 | #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15 | |
393cbb96 | 2687 | |
c81a7063 NB |
2688 | #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0 |
2689 | #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1 | |
2690 | #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2 | |
2691 | #define FF_PROFILE_JPEG2000_DCINEMA_2K 3 | |
2692 | #define FF_PROFILE_JPEG2000_DCINEMA_4K 4 | |
2693 | ||
2a41826b GC |
2694 | |
2695 | #define FF_PROFILE_HEVC_MAIN 1 | |
2696 | #define FF_PROFILE_HEVC_MAIN_10 2 | |
2697 | #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3 | |
2698 | ||
393cbb96 | 2699 | /** |
b1edfce0 AK |
2700 | * level |
2701 | * - encoding: Set by user. | |
2702 | * - decoding: Set by libavcodec. | |
393cbb96 | 2703 | */ |
b1edfce0 AK |
2704 | int level; |
2705 | #define FF_LEVEL_UNKNOWN -99 | |
37b00b47 | 2706 | |
37b00b47 | 2707 | /** |
37b00b47 | 2708 | * |
b1edfce0 AK |
2709 | * - encoding: unused |
2710 | * - decoding: Set by user. | |
37b00b47 | 2711 | */ |
b1edfce0 | 2712 | enum AVDiscard skip_loop_filter; |
37b00b47 AS |
2713 | |
2714 | /** | |
b1edfce0 AK |
2715 | * |
2716 | * - encoding: unused | |
2717 | * - decoding: Set by user. | |
37b00b47 | 2718 | */ |
b1edfce0 | 2719 | enum AVDiscard skip_idct; |
37b00b47 AS |
2720 | |
2721 | /** | |
b1edfce0 AK |
2722 | * |
2723 | * - encoding: unused | |
37b00b47 AS |
2724 | * - decoding: Set by user. |
2725 | */ | |
b1edfce0 | 2726 | enum AVDiscard skip_frame; |
55bad0c6 CM |
2727 | |
2728 | /** | |
b1edfce0 AK |
2729 | * Header containing style information for text subtitles. |
2730 | * For SUBTITLE_ASS subtitle type, it should contain the whole ASS | |
2731 | * [Script Info] and [V4+ Styles] section, plus the [Events] line and | |
2732 | * the Format line following. It shouldn't include any Dialogue line. | |
2733 | * - encoding: Set/allocated/freed by user (before avcodec_open2()) | |
2734 | * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2()) | |
55bad0c6 | 2735 | */ |
b1edfce0 AK |
2736 | uint8_t *subtitle_header; |
2737 | int subtitle_header_size; | |
34b47d7c | 2738 | |
8941971a | 2739 | #if FF_API_ERROR_RATE |
34b47d7c | 2740 | /** |
8941971a AK |
2741 | * @deprecated use the 'error_rate' private AVOption of the mpegvideo |
2742 | * encoders | |
64150ff0 | 2743 | */ |
8941971a | 2744 | attribute_deprecated |
b1edfce0 | 2745 | int error_rate; |
8941971a | 2746 | #endif |
582f2311 | 2747 | |
da6506c6 | 2748 | #if FF_API_CODEC_PKT |
582f2311 | 2749 | /** |
da6506c6 | 2750 | * @deprecated this field is not supposed to be accessed from outside lavc |
582f2311 | 2751 | */ |
da6506c6 | 2752 | attribute_deprecated |
b1edfce0 | 2753 | AVPacket *pkt; |
da6506c6 | 2754 | #endif |
f3a29b75 JR |
2755 | |
2756 | /** | |
b1edfce0 AK |
2757 | * VBV delay coded in the last frame (in periods of a 27 MHz clock). |
2758 | * Used for compliant TS muxing. | |
2759 | * - encoding: Set by libavcodec. | |
2760 | * - decoding: unused. | |
4bf3c8f2 | 2761 | */ |
b1edfce0 | 2762 | uint64_t vbv_delay; |
0957b274 AK |
2763 | |
2764 | /** | |
2765 | * Encoding only. Allow encoders to output packets that do not contain any | |
2766 | * encoded data, only side data. | |
2767 | * | |
2768 | * Some encoders need to output such packets, e.g. to update some stream | |
2769 | * parameters at the end of encoding. | |
2770 | * | |
2771 | * All callers are strongly recommended to set this option to 1 and update | |
2772 | * their code to deal with such packets, since this behaviour may become | |
2773 | * always enabled in the future (then this option will be deprecated and | |
2774 | * later removed). To avoid ABI issues when this happens, the callers should | |
2775 | * use AVOptions to set this field. | |
2776 | */ | |
2777 | int side_data_only_packets; | |
2df0c32e AK |
2778 | |
2779 | /** | |
2780 | * Audio only. The number of "priming" samples (padding) inserted by the | |
2781 | * encoder at the beginning of the audio. I.e. this number of leading | |
2782 | * decoded samples must be discarded by the caller to get the original audio | |
2783 | * without leading padding. | |
2784 | * | |
2785 | * - decoding: unused | |
2786 | * - encoding: Set by libavcodec. The timestamps on the output packets are | |
2787 | * adjusted by the encoder so that they always refer to the | |
2788 | * first sample of the data actually contained in the packet, | |
2789 | * including any added padding. E.g. if the timebase is | |
2790 | * 1/samplerate and the timestamp of the first input sample is | |
2791 | * 0, the timestamp of the first output packet will be | |
2792 | * -initial_padding. | |
2793 | */ | |
2794 | int initial_padding; | |
7ea1b347 AK |
2795 | |
2796 | /* | |
2797 | * - decoding: For codecs that store a framerate value in the compressed | |
2798 | * bitstream, the decoder may export it here. { 0, 1} when | |
2799 | * unknown. | |
2800 | * - encoding: unused | |
2801 | */ | |
2802 | AVRational framerate; | |
de6d9b64 FB |
2803 | } AVCodecContext; |
2804 | ||
64863965 | 2805 | /** |
060ec0a8 AH |
2806 | * AVProfile. |
2807 | */ | |
2808 | typedef struct AVProfile { | |
2809 | int profile; | |
2810 | const char *name; ///< short name for the profile | |
2811 | } AVProfile; | |
2812 | ||
84626b36 AK |
2813 | typedef struct AVCodecDefault AVCodecDefault; |
2814 | ||
466b39ef AK |
2815 | struct AVSubtitle; |
2816 | ||
060ec0a8 | 2817 | /** |
64863965 MN |
2818 | * AVCodec. |
2819 | */ | |
de6d9b64 | 2820 | typedef struct AVCodec { |
6b0cdb6e NG |
2821 | /** |
2822 | * Name of the codec implementation. | |
2823 | * The name is globally unique among encoders and among decoders (but an | |
2824 | * encoder and a decoder can share the same name). | |
2825 | * This is the primary way to find a codec from the user perspective. | |
2826 | */ | |
18f77016 | 2827 | const char *name; |
f5f49a66 AK |
2828 | /** |
2829 | * Descriptive name for the codec, meant to be more human readable than name. | |
2830 | * You should use the NULL_IF_CONFIG_SMALL() macro to define it. | |
2831 | */ | |
2832 | const char *long_name; | |
72415b2a | 2833 | enum AVMediaType type; |
36ef5369 | 2834 | enum AVCodecID id; |
a2d11246 MN |
2835 | /** |
2836 | * Codec capabilities. | |
2837 | * see CODEC_CAP_* | |
2838 | */ | |
bf89e6b1 | 2839 | int capabilities; |
716e31ea | 2840 | const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0} |
716d413c | 2841 | const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1 |
3ade5d56 | 2842 | const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0 |
5d6e4c16 | 2843 | const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1 |
cc276c85 | 2844 | const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0 |
451606f7 | 2845 | #if FF_API_LOWRES |
2bcbd984 | 2846 | attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder |
451606f7 | 2847 | #endif |
567ad0e3 | 2848 | const AVClass *priv_class; ///< AVClass for the private context |
060ec0a8 | 2849 | const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN} |
37b00b47 | 2850 | |
f5f49a66 AK |
2851 | /***************************************************************** |
2852 | * No fields below this line are part of the public API. They | |
2853 | * may not be used outside of libavcodec and can be changed and | |
2854 | * removed at will. | |
2855 | * New public fields should be added right above. | |
2856 | ***************************************************************** | |
2857 | */ | |
2858 | int priv_data_size; | |
2859 | struct AVCodec *next; | |
37b00b47 | 2860 | /** |
21a19b79 | 2861 | * @name Frame-level threading support functions |
37b00b47 AS |
2862 | * @{ |
2863 | */ | |
2864 | /** | |
2865 | * If defined, called on thread contexts when they are created. | |
2866 | * If the codec allocates writable tables in init(), re-allocate them here. | |
2867 | * priv_data will be set to a copy of the original. | |
2868 | */ | |
2869 | int (*init_thread_copy)(AVCodecContext *); | |
2870 | /** | |
2871 | * Copy necessary context variables from a previous thread context to the current one. | |
2872 | * If not defined, the next thread will start automatically; otherwise, the codec | |
2873 | * must call ff_thread_finish_setup(). | |
2874 | * | |
2875 | * dst and src will (rarely) point to the same context, in which case memcpy should be skipped. | |
2876 | */ | |
2877 | int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src); | |
2878 | /** @} */ | |
84626b36 AK |
2879 | |
2880 | /** | |
2881 | * Private codec-specific defaults. | |
2882 | */ | |
2883 | const AVCodecDefault *defaults; | |
d97efd7f AK |
2884 | |
2885 | /** | |
2886 | * Initialize codec static data, called from avcodec_register(). | |
2887 | */ | |
2888 | void (*init_static_data)(struct AVCodec *codec); | |
b2c75b6e | 2889 | |
f5f49a66 | 2890 | int (*init)(AVCodecContext *); |
466b39ef AK |
2891 | int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size, |
2892 | const struct AVSubtitle *sub); | |
b2c75b6e JR |
2893 | /** |
2894 | * Encode data to an AVPacket. | |
2895 | * | |
2896 | * @param avctx codec context | |
2897 | * @param avpkt output AVPacket (may contain a user-provided buffer) | |
2898 | * @param[in] frame AVFrame containing the raw data to be encoded | |
2899 | * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a | |
2900 | * non-empty packet was returned in avpkt. | |
2901 | * @return 0 on success, negative error code on failure | |
2902 | */ | |
2903 | int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, | |
2904 | int *got_packet_ptr); | |
f5f49a66 AK |
2905 | int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt); |
2906 | int (*close)(AVCodecContext *); | |
2907 | /** | |
2908 | * Flush buffers. | |
2909 | * Will be called when seeking | |
2910 | */ | |
2911 | void (*flush)(AVCodecContext *); | |
de6d9b64 FB |
2912 | } AVCodec; |
2913 | ||
97d96aaa | 2914 | /** |
d565fef1 RDC |
2915 | * @defgroup lavc_hwaccel AVHWAccel |
2916 | * @{ | |
40e5d31b GB |
2917 | */ |
2918 | typedef struct AVHWAccel { | |
2919 | /** | |
2920 | * Name of the hardware accelerated codec. | |
2921 | * The name is globally unique among encoders and among decoders (but an | |
2922 | * encoder and a decoder can share the same name). | |
2923 | */ | |
2924 | const char *name; | |
2925 | ||
2926 | /** | |
2927 | * Type of codec implemented by the hardware accelerator. | |
2928 | * | |
72415b2a | 2929 | * See AVMEDIA_TYPE_xxx |
40e5d31b | 2930 | */ |
72415b2a | 2931 | enum AVMediaType type; |
40e5d31b GB |
2932 | |
2933 | /** | |
2934 | * Codec implemented by the hardware accelerator. | |
2935 | * | |
36ef5369 | 2936 | * See AV_CODEC_ID_xxx |
40e5d31b | 2937 | */ |
36ef5369 | 2938 | enum AVCodecID id; |
40e5d31b GB |
2939 | |
2940 | /** | |
2941 | * Supported pixel format. | |
2942 | * | |
2943 | * Only hardware accelerated formats are supported here. | |
2944 | */ | |
716d413c | 2945 | enum AVPixelFormat pix_fmt; |
40e5d31b GB |
2946 | |
2947 | /** | |
2948 | * Hardware accelerated codec capabilities. | |
2949 | * see FF_HWACCEL_CODEC_CAP_* | |
2950 | */ | |
2951 | int capabilities; | |
2952 | ||
08bb2567 AK |
2953 | /***************************************************************** |
2954 | * No fields below this line are part of the public API. They | |
2955 | * may not be used outside of libavcodec and can be changed and | |
2956 | * removed at will. | |
2957 | * New public fields should be added right above. | |
2958 | ***************************************************************** | |
2959 | */ | |
40e5d31b GB |
2960 | struct AVHWAccel *next; |
2961 | ||
2962 | /** | |
ebc29519 LB |
2963 | * Allocate a custom buffer |
2964 | */ | |
2965 | int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame); | |
2966 | ||
2967 | /** | |
40e5d31b GB |
2968 | * Called at the beginning of each frame or field picture. |
2969 | * | |
2970 | * Meaningful frame information (codec specific) is guaranteed to | |
2971 | * be parsed at this point. This function is mandatory. | |
2972 | * | |
bf7e799c | 2973 | * Note that buf can be NULL along with buf_size set to 0. |
40e5d31b GB |
2974 | * Otherwise, this means the whole frame is available at this point. |
2975 | * | |
2976 | * @param avctx the codec context | |
2977 | * @param buf the frame data buffer base | |
2978 | * @param buf_size the size of the frame in bytes | |
2979 | * @return zero if successful, a negative value otherwise | |
2980 | */ | |
2981 | int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); | |
2982 | ||
2983 | /** | |
2984 | * Callback for each slice. | |
2985 | * | |
2986 | * Meaningful slice information (codec specific) is guaranteed to | |
2987 | * be parsed at this point. This function is mandatory. | |
2988 | * | |
2989 | * @param avctx the codec context | |
2990 | * @param buf the slice data buffer base | |
2991 | * @param buf_size the size of the slice in bytes | |
2992 | * @return zero if successful, a negative value otherwise | |
2993 | */ | |
2994 | int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); | |
2995 | ||
2996 | /** | |
2997 | * Called at the end of each frame or field picture. | |
2998 | * | |
2999 | * The whole picture is parsed at this point and can now be sent | |
3000 | * to the hardware accelerator. This function is mandatory. | |
3001 | * | |
3002 | * @param avctx the codec context | |
3003 | * @return zero if successful, a negative value otherwise | |
3004 | */ | |
3005 | int (*end_frame)(AVCodecContext *avctx); | |
68e5d523 GB |
3006 | |
3007 | /** | |
a871ef0c | 3008 | * Size of per-frame hardware accelerator private data. |
68e5d523 | 3009 | * |
cd823ff9 GB |
3010 | * Private data is allocated with av_mallocz() before |
3011 | * AVCodecContext.get_buffer() and deallocated after | |
3012 | * AVCodecContext.release_buffer(). | |
68e5d523 | 3013 | */ |
a871ef0c | 3014 | int frame_priv_data_size; |
dd2d3b76 AK |
3015 | |
3016 | /** | |
3017 | * Initialize the hwaccel private data. | |
3018 | * | |
3019 | * This will be called from ff_get_format(), after hwaccel and | |
3020 | * hwaccel_context are set and the hwaccel private data in AVCodecInternal | |
3021 | * is allocated. | |
3022 | */ | |
3023 | int (*init)(AVCodecContext *avctx); | |
3024 | ||
3025 | /** | |
3026 | * Uninitialize the hwaccel private data. | |
3027 | * | |
3028 | * This will be called from get_format() or avcodec_close(), after hwaccel | |
3029 | * and hwaccel_context are already uninitialized. | |
3030 | */ | |
3031 | int (*uninit)(AVCodecContext *avctx); | |
3032 | ||
3033 | /** | |
3034 | * Size of the private data to allocate in | |
3035 | * AVCodecInternal.hwaccel_priv_data. | |
3036 | */ | |
3037 | int priv_data_size; | |
40e5d31b GB |
3038 | } AVHWAccel; |
3039 | ||
3040 | /** | |
d565fef1 RDC |
3041 | * Hardware acceleration should be used for decoding even if the codec level |
3042 | * used is unknown or higher than the maximum supported level reported by the | |
3043 | * hardware driver. | |
3044 | */ | |
3045 | #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0) | |
3046 | ||
3047 | /** | |
3048 | * @} | |
3049 | */ | |
3050 | ||
3051 | /** | |
6aadfbda AK |
3052 | * @defgroup lavc_picture AVPicture |
3053 | * | |
3054 | * Functions for working with AVPicture | |
3055 | * @{ | |
3056 | */ | |
3057 | ||
3058 | /** | |
d7425f59 MN |
3059 | * four components are given, that's all. |
3060 | * the last component is alpha | |
3061 | */ | |
de6d9b64 | 3062 | typedef struct AVPicture { |
560f773c JR |
3063 | uint8_t *data[AV_NUM_DATA_POINTERS]; |
3064 | int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line | |
de6d9b64 FB |
3065 | } AVPicture; |
3066 | ||
6aadfbda AK |
3067 | /** |
3068 | * @} | |
3069 | */ | |
3070 | ||
63e4c8a6 AK |
3071 | #define AVPALETTE_SIZE 1024 |
3072 | #define AVPALETTE_COUNT 256 | |
ba118447 | 3073 | |
c66216ed MN |
3074 | enum AVSubtitleType { |
3075 | SUBTITLE_NONE, | |
3076 | ||
3077 | SUBTITLE_BITMAP, ///< A bitmap, pict will be set | |
3078 | ||
3079 | /** | |
3080 | * Plain text, the text field must be set by the decoder and is | |
3081 | * authoritative. ass and pict fields may contain approximations. | |
3082 | */ | |
3083 | SUBTITLE_TEXT, | |
3084 | ||
3085 | /** | |
3086 | * Formatted text, the ass field must be set by the decoder and is | |
3087 | * authoritative. pict and text fields may contain approximations. | |
3088 | */ | |
3089 | SUBTITLE_ASS, | |
3090 | }; | |
3091 | ||
85f67c48 JS |
3092 | #define AV_SUBTITLE_FLAG_FORCED 0x00000001 |
3093 | ||
c6ec28b1 | 3094 | typedef struct AVSubtitleRect { |
ebc466bb MN |
3095 | int x; ///< top left corner of pict, undefined when pict is not set |
3096 | int y; ///< top left corner of pict, undefined when pict is not set | |
3097 | int w; ///< width of pict, undefined when pict is not set | |
3098 | int h; ///< height of pict, undefined when pict is not set | |
3099 | int nb_colors; ///< number of colors in pict, undefined when pict is not set | |
25b4c651 MN |
3100 | |
3101 | /** | |
3102 | * data+linesize for the bitmap of this subtitle. | |
3103 | * can be set for text/ass as well once they where rendered | |
3104 | */ | |
3105 | AVPicture pict; | |
f656106f MN |
3106 | enum AVSubtitleType type; |
3107 | ||
3108 | char *text; ///< 0 terminated plain UTF-8 text | |
3109 | ||
3110 | /** | |
3111 | * 0 terminated ASS/SSA compatible event line. | |
3112 | * The pressentation of this is unaffected by the other values in this | |
3113 | * struct. | |
3114 | */ | |
3115 | char *ass; | |
85f67c48 | 3116 | int flags; |
c6ec28b1 MN |
3117 | } AVSubtitleRect; |
3118 | ||
3119 | typedef struct AVSubtitle { | |
3120 | uint16_t format; /* 0 = graphics */ | |
3121 | uint32_t start_display_time; /* relative to packet pts, in ms */ | |
3122 | uint32_t end_display_time; /* relative to packet pts, in ms */ | |
ebc466bb | 3123 | unsigned num_rects; |
db4fac64 | 3124 | AVSubtitleRect **rects; |
4bbe788a | 3125 | int64_t pts; ///< Same as packet pts, in AV_TIME_BASE |
240c1657 FB |
3126 | } AVSubtitle; |
3127 | ||
294b3a50 AK |
3128 | /** |
3129 | * If c is NULL, returns the first registered codec, | |
3130 | * if c is non-NULL, returns the next registered codec after c, | |
3131 | * or NULL if c is the last one. | |
3132 | */ | |
0a0f19b5 | 3133 | AVCodec *av_codec_next(const AVCodec *c); |
294b3a50 AK |
3134 | |
3135 | /** | |
3136 | * Return the LIBAVCODEC_VERSION_INT constant. | |
3137 | */ | |
3138 | unsigned avcodec_version(void); | |
3139 | ||
3140 | /** | |
3141 | * Return the libavcodec build-time configuration. | |
3142 | */ | |
3143 | const char *avcodec_configuration(void); | |
3144 | ||
3145 | /** | |
3146 | * Return the libavcodec license. | |
3147 | */ | |
3148 | const char *avcodec_license(void); | |
3149 | ||
3150 | /** | |
3151 | * Register the codec codec and initialize libavcodec. | |
3152 | * | |
3153 | * @warning either this function or avcodec_register_all() must be called | |
3154 | * before any other libavcodec functions. | |
3155 | * | |
3156 | * @see avcodec_register_all() | |
3157 | */ | |
3158 | void avcodec_register(AVCodec *codec); | |
3159 | ||
3160 | /** | |
3161 | * Register all the codecs, parsers and bitstream filters which were enabled at | |
3162 | * configuration time. If you do not call this function you can select exactly | |
3163 | * which formats you want to support, by using the individual registration | |
3164 | * functions. | |
3165 | * | |
3166 | * @see avcodec_register | |
3167 | * @see av_register_codec_parser | |
3168 | * @see av_register_bitstream_filter | |
3169 | */ | |
3170 | void avcodec_register_all(void); | |
3171 | ||
3172 | /** | |
fd056029 AK |
3173 | * Allocate an AVCodecContext and set its fields to default values. The |
3174 | * resulting struct should be freed with avcodec_free_context(). | |
294b3a50 AK |
3175 | * |
3176 | * @param codec if non-NULL, allocate private data and initialize defaults | |
3177 | * for the given codec. It is illegal to then call avcodec_open2() | |
3178 | * with a different codec. | |
3179 | * If NULL, then the codec-specific defaults won't be initialized, | |
3180 | * which may result in suboptimal default settings (this is | |
3181 | * important mainly for encoders, e.g. libx264). | |
3182 | * | |
3183 | * @return An AVCodecContext filled with default values or NULL on failure. | |
3184 | * @see avcodec_get_context_defaults | |
3185 | */ | |
0a0f19b5 | 3186 | AVCodecContext *avcodec_alloc_context3(const AVCodec *codec); |
294b3a50 AK |
3187 | |
3188 | /** | |
fd056029 AK |
3189 | * Free the codec context and everything associated with it and write NULL to |
3190 | * the provided pointer. | |
3191 | */ | |
3192 | void avcodec_free_context(AVCodecContext **avctx); | |
3193 | ||
3194 | /** | |
294b3a50 AK |
3195 | * Set the fields of the given AVCodecContext to default values corresponding |
3196 | * to the given codec (defaults may be codec-dependent). | |
3197 | * | |
3198 | * Do not call this function if a non-NULL codec has been passed | |
3199 | * to avcodec_alloc_context3() that allocated this AVCodecContext. | |
3200 | * If codec is non-NULL, it is illegal to call avcodec_open2() with a | |
3201 | * different codec on this AVCodecContext. | |
3202 | */ | |
0a0f19b5 | 3203 | int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec); |
294b3a50 AK |
3204 | |
3205 | /** | |
3206 | * Get the AVClass for AVCodecContext. It can be used in combination with | |
3207 | * AV_OPT_SEARCH_FAKE_OBJ for examining options. | |
3208 | * | |
3209 | * @see av_opt_find(). | |
3210 | */ | |
3211 | const AVClass *avcodec_get_class(void); | |
3212 | ||
3213 | /** | |
3214 | * Copy the settings of the source AVCodecContext into the destination | |
3215 | * AVCodecContext. The resulting destination codec context will be | |
3216 | * unopened, i.e. you are required to call avcodec_open2() before you | |
3217 | * can use this AVCodecContext to decode/encode video/audio data. | |
3218 | * | |
3219 | * @param dest target codec context, should be initialized with | |
3220 | * avcodec_alloc_context3(), but otherwise uninitialized | |
3221 | * @param src source codec context | |
3222 | * @return AVERROR() on error (e.g. memory allocation error), 0 on success | |
3223 | */ | |
3224 | int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src); | |
3225 | ||
b9fb59d2 | 3226 | #if FF_API_AVFRAME_LAVC |
294b3a50 | 3227 | /** |
b9fb59d2 | 3228 | * @deprecated use av_frame_alloc() |
294b3a50 | 3229 | */ |
b9fb59d2 | 3230 | attribute_deprecated |
294b3a50 AK |
3231 | AVFrame *avcodec_alloc_frame(void); |
3232 | ||
3233 | /** | |
3234 | * Set the fields of the given AVFrame to default values. | |
3235 | * | |
a83499b1 | 3236 | * @param frame The AVFrame of which the fields should be set to default values. |
d7b3ee9a AK |
3237 | * |
3238 | * @deprecated use av_frame_unref() | |
294b3a50 | 3239 | */ |
d7b3ee9a | 3240 | attribute_deprecated |
a83499b1 | 3241 | void avcodec_get_frame_defaults(AVFrame *frame); |
294b3a50 AK |
3242 | |
3243 | /** | |
a42aadab AK |
3244 | * Free the frame and any dynamically allocated objects in it, |
3245 | * e.g. extended_data. | |
3246 | * | |
3247 | * @param frame frame to be freed. The pointer will be set to NULL. | |
3248 | * | |
3249 | * @warning this function does NOT free the data buffers themselves | |
3250 | * (it does not know how, since they might have been allocated with | |
3251 | * a custom get_buffer()). | |
94313562 AK |
3252 | * |
3253 | * @deprecated use av_frame_free() | |
a42aadab | 3254 | */ |
94313562 | 3255 | attribute_deprecated |
a42aadab | 3256 | void avcodec_free_frame(AVFrame **frame); |
94313562 | 3257 | #endif |
a42aadab AK |
3258 | |
3259 | /** | |
294b3a50 AK |
3260 | * Initialize the AVCodecContext to use the given AVCodec. Prior to using this |
3261 | * function the context has to be allocated with avcodec_alloc_context3(). | |
3262 | * | |
3263 | * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), | |
3264 | * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for | |
3265 | * retrieving a codec. | |
3266 | * | |
3267 | * @warning This function is not thread safe! | |
3268 | * | |
3269 | * @code | |
3270 | * avcodec_register_all(); | |
3271 | * av_dict_set(&opts, "b", "2.5M", 0); | |
104e10fb | 3272 | * codec = avcodec_find_decoder(AV_CODEC_ID_H264); |
294b3a50 AK |
3273 | * if (!codec) |
3274 | * exit(1); | |
3275 | * | |
3276 | * context = avcodec_alloc_context3(codec); | |
3277 | * | |
3278 | * if (avcodec_open2(context, codec, opts) < 0) | |
3279 | * exit(1); | |
3280 | * @endcode | |
3281 | * | |
3282 | * @param avctx The context to initialize. | |
3283 | * @param codec The codec to open this context for. If a non-NULL codec has been | |
3284 | * previously passed to avcodec_alloc_context3() or | |
3285 |