blob: 3a40c4b287ba3db02637c4487032db10bd9bc4f5
1 | /* |
2 | * copyright (c) 2001 Fabrice Bellard |
3 | * |
4 | * This file is part of FFmpeg. |
5 | * |
6 | * FFmpeg is free software; you can redistribute it and/or |
7 | * modify it under the terms of the GNU Lesser General Public |
8 | * License as published by the Free Software Foundation; either |
9 | * version 2.1 of the License, or (at your option) any later version. |
10 | * |
11 | * FFmpeg is distributed in the hope that it will be useful, |
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 |
17 | * License along with FFmpeg; if not, write to the Free Software |
18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
19 | */ |
20 | |
21 | #ifndef AVCODEC_AVCODEC_H |
22 | #define AVCODEC_AVCODEC_H |
23 | |
24 | /** |
25 | * @file |
26 | * @ingroup libavc |
27 | * Libavcodec external API header |
28 | */ |
29 | |
30 | #include <errno.h> |
31 | #include "libavutil/samplefmt.h" |
32 | #include "libavutil/attributes.h" |
33 | #include "libavutil/avutil.h" |
34 | #include "libavutil/buffer.h" |
35 | #include "libavutil/cpu.h" |
36 | #include "libavutil/channel_layout.h" |
37 | #include "libavutil/dict.h" |
38 | #include "libavutil/frame.h" |
39 | #include "libavutil/log.h" |
40 | #include "libavutil/pixfmt.h" |
41 | #include "libavutil/rational.h" |
42 | |
43 | #include "version.h" |
44 | |
45 | /** |
46 | * @defgroup libavc Encoding/Decoding Library |
47 | * @{ |
48 | * |
49 | * @defgroup lavc_decoding Decoding |
50 | * @{ |
51 | * @} |
52 | * |
53 | * @defgroup lavc_encoding Encoding |
54 | * @{ |
55 | * @} |
56 | * |
57 | * @defgroup lavc_codec Codecs |
58 | * @{ |
59 | * @defgroup lavc_codec_native Native Codecs |
60 | * @{ |
61 | * @} |
62 | * @defgroup lavc_codec_wrappers External library wrappers |
63 | * @{ |
64 | * @} |
65 | * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge |
66 | * @{ |
67 | * @} |
68 | * @} |
69 | * @defgroup lavc_internal Internal |
70 | * @{ |
71 | * @} |
72 | * @} |
73 | * |
74 | */ |
75 | |
76 | /** |
77 | * @defgroup lavc_core Core functions/structures. |
78 | * @ingroup libavc |
79 | * |
80 | * Basic definitions, functions for querying libavcodec capabilities, |
81 | * allocating core structures, etc. |
82 | * @{ |
83 | */ |
84 | |
85 | |
86 | /** |
87 | * Identify the syntax and semantics of the bitstream. |
88 | * The principle is roughly: |
89 | * Two decoders with the same ID can decode the same streams. |
90 | * Two encoders with the same ID can encode compatible streams. |
91 | * There may be slight deviations from the principle due to implementation |
92 | * details. |
93 | * |
94 | * If you add a codec ID to this list, add it so that |
95 | * 1. no value of a existing codec ID changes (that would break ABI), |
96 | * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec. |
97 | * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts. |
98 | * |
99 | * After adding new codec IDs, do not forget to add an entry to the codec |
100 | * descriptor list and bump libavcodec minor version. |
101 | */ |
102 | enum AVCodecID { |
103 | AV_CODEC_ID_NONE, |
104 | |
105 | /* video codecs */ |
106 | AV_CODEC_ID_MPEG1VIDEO, |
107 | AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding |
108 | AV_CODEC_ID_MPEG2VIDEO_XVMC, |
109 | AV_CODEC_ID_H261, |
110 | AV_CODEC_ID_H263, |
111 | AV_CODEC_ID_RV10, |
112 | AV_CODEC_ID_RV20, |
113 | AV_CODEC_ID_MJPEG, |
114 | AV_CODEC_ID_MJPEGB, |
115 | AV_CODEC_ID_LJPEG, |
116 | AV_CODEC_ID_SP5X, |
117 | AV_CODEC_ID_JPEGLS, |
118 | AV_CODEC_ID_MPEG4, |
119 | AV_CODEC_ID_RAWVIDEO, |
120 | AV_CODEC_ID_MSMPEG4V1, |
121 | AV_CODEC_ID_MSMPEG4V2, |
122 | AV_CODEC_ID_MSMPEG4V3, |
123 | AV_CODEC_ID_WMV1, |
124 | AV_CODEC_ID_WMV2, |
125 | AV_CODEC_ID_H263P, |
126 | AV_CODEC_ID_H263I, |
127 | AV_CODEC_ID_FLV1, |
128 | AV_CODEC_ID_SVQ1, |
129 | AV_CODEC_ID_SVQ3, |
130 | AV_CODEC_ID_DVVIDEO, |
131 | AV_CODEC_ID_HUFFYUV, |
132 | AV_CODEC_ID_CYUV, |
133 | AV_CODEC_ID_H264, |
134 | AV_CODEC_ID_INDEO3, |
135 | AV_CODEC_ID_VP3, |
136 | AV_CODEC_ID_THEORA, |
137 | AV_CODEC_ID_ASV1, |
138 | AV_CODEC_ID_ASV2, |
139 | AV_CODEC_ID_FFV1, |
140 | AV_CODEC_ID_4XM, |
141 | AV_CODEC_ID_VCR1, |
142 | AV_CODEC_ID_CLJR, |
143 | AV_CODEC_ID_MDEC, |
144 | AV_CODEC_ID_ROQ, |
145 | AV_CODEC_ID_INTERPLAY_VIDEO, |
146 | AV_CODEC_ID_XAN_WC3, |
147 | AV_CODEC_ID_XAN_WC4, |
148 | AV_CODEC_ID_RPZA, |
149 | AV_CODEC_ID_CINEPAK, |
150 | AV_CODEC_ID_WS_VQA, |
151 | AV_CODEC_ID_MSRLE, |
152 | AV_CODEC_ID_MSVIDEO1, |
153 | AV_CODEC_ID_IDCIN, |
154 | AV_CODEC_ID_8BPS, |
155 | AV_CODEC_ID_SMC, |
156 | AV_CODEC_ID_FLIC, |
157 | AV_CODEC_ID_TRUEMOTION1, |
158 | AV_CODEC_ID_VMDVIDEO, |
159 | AV_CODEC_ID_MSZH, |
160 | AV_CODEC_ID_ZLIB, |
161 | AV_CODEC_ID_QTRLE, |
162 | AV_CODEC_ID_TSCC, |
163 | AV_CODEC_ID_ULTI, |
164 | AV_CODEC_ID_QDRAW, |
165 | AV_CODEC_ID_VIXL, |
166 | AV_CODEC_ID_QPEG, |
167 | AV_CODEC_ID_PNG, |
168 | AV_CODEC_ID_PPM, |
169 | AV_CODEC_ID_PBM, |
170 | AV_CODEC_ID_PGM, |
171 | AV_CODEC_ID_PGMYUV, |
172 | AV_CODEC_ID_PAM, |
173 | AV_CODEC_ID_FFVHUFF, |
174 | AV_CODEC_ID_RV30, |
175 | AV_CODEC_ID_RV40, |
176 | AV_CODEC_ID_VC1, |
177 | AV_CODEC_ID_WMV3, |
178 | AV_CODEC_ID_LOCO, |
179 | AV_CODEC_ID_WNV1, |
180 | AV_CODEC_ID_AASC, |
181 | AV_CODEC_ID_INDEO2, |
182 | AV_CODEC_ID_FRAPS, |
183 | AV_CODEC_ID_TRUEMOTION2, |
184 | AV_CODEC_ID_BMP, |
185 | AV_CODEC_ID_CSCD, |
186 | AV_CODEC_ID_MMVIDEO, |
187 | AV_CODEC_ID_ZMBV, |
188 | AV_CODEC_ID_AVS, |
189 | AV_CODEC_ID_SMACKVIDEO, |
190 | AV_CODEC_ID_NUV, |
191 | AV_CODEC_ID_KMVC, |
192 | AV_CODEC_ID_FLASHSV, |
193 | AV_CODEC_ID_CAVS, |
194 | AV_CODEC_ID_JPEG2000, |
195 | AV_CODEC_ID_VMNC, |
196 | AV_CODEC_ID_VP5, |
197 | AV_CODEC_ID_VP6, |
198 | AV_CODEC_ID_VP6F, |
199 | AV_CODEC_ID_TARGA, |
200 | AV_CODEC_ID_DSICINVIDEO, |
201 | AV_CODEC_ID_TIERTEXSEQVIDEO, |
202 | AV_CODEC_ID_TIFF, |
203 | AV_CODEC_ID_GIF, |
204 | AV_CODEC_ID_DXA, |
205 | AV_CODEC_ID_DNXHD, |
206 | AV_CODEC_ID_THP, |
207 | AV_CODEC_ID_SGI, |
208 | AV_CODEC_ID_C93, |
209 | AV_CODEC_ID_BETHSOFTVID, |
210 | AV_CODEC_ID_PTX, |
211 | AV_CODEC_ID_TXD, |
212 | AV_CODEC_ID_VP6A, |
213 | AV_CODEC_ID_AMV, |
214 | AV_CODEC_ID_VB, |
215 | AV_CODEC_ID_PCX, |
216 | AV_CODEC_ID_SUNRAST, |
217 | AV_CODEC_ID_INDEO4, |
218 | AV_CODEC_ID_INDEO5, |
219 | AV_CODEC_ID_MIMIC, |
220 | AV_CODEC_ID_RL2, |
221 | AV_CODEC_ID_ESCAPE124, |
222 | AV_CODEC_ID_DIRAC, |
223 | AV_CODEC_ID_BFI, |
224 | AV_CODEC_ID_CMV, |
225 | AV_CODEC_ID_MOTIONPIXELS, |
226 | AV_CODEC_ID_TGV, |
227 | AV_CODEC_ID_TGQ, |
228 | AV_CODEC_ID_TQI, |
229 | AV_CODEC_ID_AURA, |
230 | AV_CODEC_ID_AURA2, |
231 | AV_CODEC_ID_V210X, |
232 | AV_CODEC_ID_TMV, |
233 | AV_CODEC_ID_V210, |
234 | AV_CODEC_ID_DPX, |
235 | AV_CODEC_ID_MAD, |
236 | AV_CODEC_ID_FRWU, |
237 | AV_CODEC_ID_FLASHSV2, |
238 | AV_CODEC_ID_CDGRAPHICS, |
239 | AV_CODEC_ID_R210, |
240 | AV_CODEC_ID_ANM, |
241 | AV_CODEC_ID_BINKVIDEO, |
242 | AV_CODEC_ID_IFF_ILBM, |
243 | AV_CODEC_ID_IFF_BYTERUN1, |
244 | AV_CODEC_ID_KGV1, |
245 | AV_CODEC_ID_YOP, |
246 | AV_CODEC_ID_VP8, |
247 | AV_CODEC_ID_PICTOR, |
248 | AV_CODEC_ID_ANSI, |
249 | AV_CODEC_ID_A64_MULTI, |
250 | AV_CODEC_ID_A64_MULTI5, |
251 | AV_CODEC_ID_R10K, |
252 | AV_CODEC_ID_MXPEG, |
253 | AV_CODEC_ID_LAGARITH, |
254 | AV_CODEC_ID_PRORES, |
255 | AV_CODEC_ID_JV, |
256 | AV_CODEC_ID_DFA, |
257 | AV_CODEC_ID_WMV3IMAGE, |
258 | AV_CODEC_ID_VC1IMAGE, |
259 | AV_CODEC_ID_UTVIDEO, |
260 | AV_CODEC_ID_BMV_VIDEO, |
261 | AV_CODEC_ID_VBLE, |
262 | AV_CODEC_ID_DXTORY, |
263 | AV_CODEC_ID_V410, |
264 | AV_CODEC_ID_XWD, |
265 | AV_CODEC_ID_CDXL, |
266 | AV_CODEC_ID_XBM, |
267 | AV_CODEC_ID_ZEROCODEC, |
268 | AV_CODEC_ID_MSS1, |
269 | AV_CODEC_ID_MSA1, |
270 | AV_CODEC_ID_TSCC2, |
271 | AV_CODEC_ID_MTS2, |
272 | AV_CODEC_ID_CLLC, |
273 | AV_CODEC_ID_MSS2, |
274 | AV_CODEC_ID_VP9, |
275 | AV_CODEC_ID_AIC, |
276 | AV_CODEC_ID_ESCAPE130_DEPRECATED, |
277 | AV_CODEC_ID_G2M_DEPRECATED, |
278 | AV_CODEC_ID_WEBP_DEPRECATED, |
279 | |
280 | AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'), |
281 | AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'), |
282 | AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'), |
283 | AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'), |
284 | AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'), |
285 | |
286 | AV_CODEC_ID_012V = MKBETAG('0','1','2','V'), |
287 | AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'), |
288 | AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'), |
289 | AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'), |
290 | AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'), |
291 | AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'), |
292 | AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'), |
293 | AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'), |
294 | AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'), |
295 | AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'), |
296 | AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'), |
297 | AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'), |
298 | AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'), |
299 | AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'), |
300 | AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'), |
301 | AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'), |
302 | AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'), |
303 | AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'), |
304 | AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'), |
305 | AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'), |
306 | #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC |
307 | |
308 | /* various PCM "codecs" */ |
309 | AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs |
310 | AV_CODEC_ID_PCM_S16LE = 0x10000, |
311 | AV_CODEC_ID_PCM_S16BE, |
312 | AV_CODEC_ID_PCM_U16LE, |
313 | AV_CODEC_ID_PCM_U16BE, |
314 | AV_CODEC_ID_PCM_S8, |
315 | AV_CODEC_ID_PCM_U8, |
316 | AV_CODEC_ID_PCM_MULAW, |
317 | AV_CODEC_ID_PCM_ALAW, |
318 | AV_CODEC_ID_PCM_S32LE, |
319 | AV_CODEC_ID_PCM_S32BE, |
320 | AV_CODEC_ID_PCM_U32LE, |
321 | AV_CODEC_ID_PCM_U32BE, |
322 | AV_CODEC_ID_PCM_S24LE, |
323 | AV_CODEC_ID_PCM_S24BE, |
324 | AV_CODEC_ID_PCM_U24LE, |
325 | AV_CODEC_ID_PCM_U24BE, |
326 | AV_CODEC_ID_PCM_S24DAUD, |
327 | AV_CODEC_ID_PCM_ZORK, |
328 | AV_CODEC_ID_PCM_S16LE_PLANAR, |
329 | AV_CODEC_ID_PCM_DVD, |
330 | AV_CODEC_ID_PCM_F32BE, |
331 | AV_CODEC_ID_PCM_F32LE, |
332 | AV_CODEC_ID_PCM_F64BE, |
333 | AV_CODEC_ID_PCM_F64LE, |
334 | AV_CODEC_ID_PCM_BLURAY, |
335 | AV_CODEC_ID_PCM_LXF, |
336 | AV_CODEC_ID_S302M, |
337 | AV_CODEC_ID_PCM_S8_PLANAR, |
338 | AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED, |
339 | AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED, |
340 | AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'), |
341 | AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'), |
342 | AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16), |
343 | |
344 | /* various ADPCM codecs */ |
345 | AV_CODEC_ID_ADPCM_IMA_QT = 0x11000, |
346 | AV_CODEC_ID_ADPCM_IMA_WAV, |
347 | AV_CODEC_ID_ADPCM_IMA_DK3, |
348 | AV_CODEC_ID_ADPCM_IMA_DK4, |
349 | AV_CODEC_ID_ADPCM_IMA_WS, |
350 | AV_CODEC_ID_ADPCM_IMA_SMJPEG, |
351 | AV_CODEC_ID_ADPCM_MS, |
352 | AV_CODEC_ID_ADPCM_4XM, |
353 | AV_CODEC_ID_ADPCM_XA, |
354 | AV_CODEC_ID_ADPCM_ADX, |
355 | AV_CODEC_ID_ADPCM_EA, |
356 | AV_CODEC_ID_ADPCM_G726, |
357 | AV_CODEC_ID_ADPCM_CT, |
358 | AV_CODEC_ID_ADPCM_SWF, |
359 | AV_CODEC_ID_ADPCM_YAMAHA, |
360 | AV_CODEC_ID_ADPCM_SBPRO_4, |
361 | AV_CODEC_ID_ADPCM_SBPRO_3, |
362 | AV_CODEC_ID_ADPCM_SBPRO_2, |
363 | AV_CODEC_ID_ADPCM_THP, |
364 | AV_CODEC_ID_ADPCM_IMA_AMV, |
365 | AV_CODEC_ID_ADPCM_EA_R1, |
366 | AV_CODEC_ID_ADPCM_EA_R3, |
367 | AV_CODEC_ID_ADPCM_EA_R2, |
368 | AV_CODEC_ID_ADPCM_IMA_EA_SEAD, |
369 | AV_CODEC_ID_ADPCM_IMA_EA_EACS, |
370 | AV_CODEC_ID_ADPCM_EA_XAS, |
371 | AV_CODEC_ID_ADPCM_EA_MAXIS_XA, |
372 | AV_CODEC_ID_ADPCM_IMA_ISS, |
373 | AV_CODEC_ID_ADPCM_G722, |
374 | AV_CODEC_ID_ADPCM_IMA_APC, |
375 | AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'), |
376 | AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '), |
377 | AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '), |
378 | AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '), |
379 | AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '), |
380 | AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'), |
381 | |
382 | /* AMR */ |
383 | AV_CODEC_ID_AMR_NB = 0x12000, |
384 | AV_CODEC_ID_AMR_WB, |
385 | |
386 | /* RealAudio codecs*/ |
387 | AV_CODEC_ID_RA_144 = 0x13000, |
388 | AV_CODEC_ID_RA_288, |
389 | |
390 | /* various DPCM codecs */ |
391 | AV_CODEC_ID_ROQ_DPCM = 0x14000, |
392 | AV_CODEC_ID_INTERPLAY_DPCM, |
393 | AV_CODEC_ID_XAN_DPCM, |
394 | AV_CODEC_ID_SOL_DPCM, |
395 | |
396 | /* audio codecs */ |
397 | AV_CODEC_ID_MP2 = 0x15000, |
398 | AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3 |
399 | AV_CODEC_ID_AAC, |
400 | AV_CODEC_ID_AC3, |
401 | AV_CODEC_ID_DTS, |
402 | AV_CODEC_ID_VORBIS, |
403 | AV_CODEC_ID_DVAUDIO, |
404 | AV_CODEC_ID_WMAV1, |
405 | AV_CODEC_ID_WMAV2, |
406 | AV_CODEC_ID_MACE3, |
407 | AV_CODEC_ID_MACE6, |
408 | AV_CODEC_ID_VMDAUDIO, |
409 | AV_CODEC_ID_FLAC, |
410 | AV_CODEC_ID_MP3ADU, |
411 | AV_CODEC_ID_MP3ON4, |
412 | AV_CODEC_ID_SHORTEN, |
413 | AV_CODEC_ID_ALAC, |
414 | AV_CODEC_ID_WESTWOOD_SND1, |
415 | AV_CODEC_ID_GSM, ///< as in Berlin toast format |
416 | AV_CODEC_ID_QDM2, |
417 | AV_CODEC_ID_COOK, |
418 | AV_CODEC_ID_TRUESPEECH, |
419 | AV_CODEC_ID_TTA, |
420 | AV_CODEC_ID_SMACKAUDIO, |
421 | AV_CODEC_ID_QCELP, |
422 | AV_CODEC_ID_WAVPACK, |
423 | AV_CODEC_ID_DSICINAUDIO, |
424 | AV_CODEC_ID_IMC, |
425 | AV_CODEC_ID_MUSEPACK7, |
426 | AV_CODEC_ID_MLP, |
427 | AV_CODEC_ID_GSM_MS, /* as found in WAV */ |
428 | AV_CODEC_ID_ATRAC3, |
429 | #if FF_API_VOXWARE |
430 | AV_CODEC_ID_VOXWARE, |
431 | #endif |
432 | AV_CODEC_ID_APE, |
433 | AV_CODEC_ID_NELLYMOSER, |
434 | AV_CODEC_ID_MUSEPACK8, |
435 | AV_CODEC_ID_SPEEX, |
436 | AV_CODEC_ID_WMAVOICE, |
437 | AV_CODEC_ID_WMAPRO, |
438 | AV_CODEC_ID_WMALOSSLESS, |
439 | AV_CODEC_ID_ATRAC3P, |
440 | AV_CODEC_ID_EAC3, |
441 | AV_CODEC_ID_SIPR, |
442 | AV_CODEC_ID_MP1, |
443 | AV_CODEC_ID_TWINVQ, |
444 | AV_CODEC_ID_TRUEHD, |
445 | AV_CODEC_ID_MP4ALS, |
446 | AV_CODEC_ID_ATRAC1, |
447 | AV_CODEC_ID_BINKAUDIO_RDFT, |
448 | AV_CODEC_ID_BINKAUDIO_DCT, |
449 | AV_CODEC_ID_AAC_LATM, |
450 | AV_CODEC_ID_QDMC, |
451 | AV_CODEC_ID_CELT, |
452 | AV_CODEC_ID_G723_1, |
453 | AV_CODEC_ID_G729, |
454 | AV_CODEC_ID_8SVX_EXP, |
455 | AV_CODEC_ID_8SVX_FIB, |
456 | AV_CODEC_ID_BMV_AUDIO, |
457 | AV_CODEC_ID_RALF, |
458 | AV_CODEC_ID_IAC, |
459 | AV_CODEC_ID_ILBC, |
460 | AV_CODEC_ID_OPUS_DEPRECATED, |
461 | AV_CODEC_ID_COMFORT_NOISE, |
462 | AV_CODEC_ID_TAK_DEPRECATED, |
463 | AV_CODEC_ID_METASOUND, |
464 | AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'), |
465 | AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'), |
466 | AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'), |
467 | AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'), |
468 | AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'), |
469 | AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'), |
470 | AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'), |
471 | AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'), |
472 | AV_CODEC_ID_DRA = MKBETAG('D','A','R','1'), |
473 | |
474 | /* subtitle codecs */ |
475 | AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs. |
476 | AV_CODEC_ID_DVD_SUBTITLE = 0x17000, |
477 | AV_CODEC_ID_DVB_SUBTITLE, |
478 | AV_CODEC_ID_TEXT, ///< raw UTF-8 text |
479 | AV_CODEC_ID_XSUB, |
480 | AV_CODEC_ID_SSA, |
481 | AV_CODEC_ID_MOV_TEXT, |
482 | AV_CODEC_ID_HDMV_PGS_SUBTITLE, |
483 | AV_CODEC_ID_DVB_TELETEXT, |
484 | AV_CODEC_ID_SRT, |
485 | AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'), |
486 | AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'), |
487 | AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'), |
488 | AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'), |
489 | AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'), |
490 | AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'), |
491 | AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'), |
492 | AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'), |
493 | AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'), |
494 | AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'), |
495 | AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'), |
496 | AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'), |
497 | AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska |
498 | |
499 | /* other specific kind of codecs (generally used for attachments) */ |
500 | AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs. |
501 | AV_CODEC_ID_TTF = 0x18000, |
502 | AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'), |
503 | AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'), |
504 | AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'), |
505 | AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'), |
506 | AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'), |
507 | AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'), |
508 | |
509 | |
510 | AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it |
511 | |
512 | AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS |
513 | * stream (only used by libavformat) */ |
514 | AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems |
515 | * stream (only used by libavformat) */ |
516 | AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information. |
517 | |
518 | #if FF_API_CODEC_ID |
519 | #include "old_codec_ids.h" |
520 | #endif |
521 | }; |
522 | |
523 | /** |
524 | * This struct describes the properties of a single codec described by an |
525 | * AVCodecID. |
526 | * @see avcodec_get_descriptor() |
527 | */ |
528 | typedef struct AVCodecDescriptor { |
529 | enum AVCodecID id; |
530 | enum AVMediaType type; |
531 | /** |
532 | * Name of the codec described by this descriptor. It is non-empty and |
533 | * unique for each codec descriptor. It should contain alphanumeric |
534 | * characters and '_' only. |
535 | */ |
536 | const char *name; |
537 | /** |
538 | * A more descriptive name for this codec. May be NULL. |
539 | */ |
540 | const char *long_name; |
541 | /** |
542 | * Codec properties, a combination of AV_CODEC_PROP_* flags. |
543 | */ |
544 | int props; |
545 | } AVCodecDescriptor; |
546 | |
547 | /** |
548 | * Codec uses only intra compression. |
549 | * Video codecs only. |
550 | */ |
551 | #define AV_CODEC_PROP_INTRA_ONLY (1 << 0) |
552 | /** |
553 | * Codec supports lossy compression. Audio and video codecs only. |
554 | * @note a codec may support both lossy and lossless |
555 | * compression modes |
556 | */ |
557 | #define AV_CODEC_PROP_LOSSY (1 << 1) |
558 | /** |
559 | * Codec supports lossless compression. Audio and video codecs only. |
560 | */ |
561 | #define AV_CODEC_PROP_LOSSLESS (1 << 2) |
562 | /** |
563 | * Subtitle codec is bitmap based |
564 | * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field. |
565 | */ |
566 | #define AV_CODEC_PROP_BITMAP_SUB (1 << 16) |
567 | /** |
568 | * Subtitle codec is text based. |
569 | * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field. |
570 | */ |
571 | #define AV_CODEC_PROP_TEXT_SUB (1 << 17) |
572 | |
573 | /** |
574 | * @ingroup lavc_decoding |
575 | * Required number of additionally allocated bytes at the end of the input bitstream for decoding. |
576 | * This is mainly needed because some optimized bitstream readers read |
577 | * 32 or 64 bit at once and could read over the end.<br> |
578 | * Note: If the first 23 bits of the additional bytes are not 0, then damaged |
579 | * MPEG bitstreams could cause overread and segfault. |
580 | */ |
581 | #define FF_INPUT_BUFFER_PADDING_SIZE 16 |
582 | |
583 | /** |
584 | * @ingroup lavc_encoding |
585 | * minimum encoding buffer size |
586 | * Used to avoid some checks during header writing. |
587 | */ |
588 | #define FF_MIN_BUFFER_SIZE 16384 |
589 | |
590 | |
591 | /** |
592 | * @ingroup lavc_encoding |
593 | * motion estimation type. |
594 | */ |
595 | enum Motion_Est_ID { |
596 | ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed |
597 | ME_FULL, |
598 | ME_LOG, |
599 | ME_PHODS, |
600 | ME_EPZS, ///< enhanced predictive zonal search |
601 | ME_X1, ///< reserved for experiments |
602 | ME_HEX, ///< hexagon based search |
603 | ME_UMH, ///< uneven multi-hexagon search |
604 | ME_TESA, ///< transformed exhaustive search algorithm |
605 | ME_ITER=50, ///< iterative search |
606 | }; |
607 | |
608 | /** |
609 | * @ingroup lavc_decoding |
610 | */ |
611 | enum AVDiscard{ |
612 | /* We leave some space between them for extensions (drop some |
613 | * keyframes for intra-only or drop just some bidir frames). */ |
614 | AVDISCARD_NONE =-16, ///< discard nothing |
615 | AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi |
616 | AVDISCARD_NONREF = 8, ///< discard all non reference |
617 | AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames |
618 | AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes |
619 | AVDISCARD_ALL = 48, ///< discard all |
620 | }; |
621 | |
622 | enum AVColorPrimaries{ |
623 | AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B |
624 | AVCOL_PRI_UNSPECIFIED = 2, |
625 | AVCOL_PRI_BT470M = 4, |
626 | AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM |
627 | AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC |
628 | AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above |
629 | AVCOL_PRI_FILM = 8, |
630 | AVCOL_PRI_NB , ///< Not part of ABI |
631 | }; |
632 | |
633 | enum AVColorTransferCharacteristic{ |
634 | AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361 |
635 | AVCOL_TRC_UNSPECIFIED = 2, |
636 | AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM |
637 | AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG |
638 | AVCOL_TRC_SMPTE240M = 7, |
639 | AVCOL_TRC_NB , ///< Not part of ABI |
640 | }; |
641 | |
642 | /** |
643 | * X X 3 4 X X are luma samples, |
644 | * 1 2 1-6 are possible chroma positions |
645 | * X X 5 6 X 0 is undefined/unknown position |
646 | */ |
647 | enum AVChromaLocation{ |
648 | AVCHROMA_LOC_UNSPECIFIED = 0, |
649 | AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default |
650 | AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263 |
651 | AVCHROMA_LOC_TOPLEFT = 3, ///< DV |
652 | AVCHROMA_LOC_TOP = 4, |
653 | AVCHROMA_LOC_BOTTOMLEFT = 5, |
654 | AVCHROMA_LOC_BOTTOM = 6, |
655 | AVCHROMA_LOC_NB , ///< Not part of ABI |
656 | }; |
657 | |
658 | enum AVAudioServiceType { |
659 | AV_AUDIO_SERVICE_TYPE_MAIN = 0, |
660 | AV_AUDIO_SERVICE_TYPE_EFFECTS = 1, |
661 | AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2, |
662 | AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3, |
663 | AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4, |
664 | AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5, |
665 | AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6, |
666 | AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7, |
667 | AV_AUDIO_SERVICE_TYPE_KARAOKE = 8, |
668 | AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI |
669 | }; |
670 | |
671 | /** |
672 | * @ingroup lavc_encoding |
673 | */ |
674 | typedef struct RcOverride{ |
675 | int start_frame; |
676 | int end_frame; |
677 | int qscale; // If this is 0 then quality_factor will be used instead. |
678 | float quality_factor; |
679 | } RcOverride; |
680 | |
681 | #define FF_MAX_B_FRAMES 16 |
682 | |
683 | /* encoding support |
684 | These flags can be passed in AVCodecContext.flags before initialization. |
685 | Note: Not everything is supported yet. |
686 | */ |
687 | |
688 | /** |
689 | * Allow decoders to produce frames with data planes that are not aligned |
690 | * to CPU requirements (e.g. due to cropping). |
691 | */ |
692 | #define CODEC_FLAG_UNALIGNED 0x0001 |
693 | #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale. |
694 | #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263. |
695 | #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC. |
696 | #define CODEC_FLAG_GMC 0x0020 ///< Use GMC. |
697 | #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>. |
698 | /** |
699 | * The parent program guarantees that the input for B-frames containing |
700 | * streams is not written to for at least s->max_b_frames+1 frames, if |
701 | * this is not set the input will be copied. |
702 | */ |
703 | #define CODEC_FLAG_INPUT_PRESERVED 0x0100 |
704 | #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode. |
705 | #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode. |
706 | #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale. |
707 | #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges. |
708 | #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding. |
709 | #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random |
710 | location instead of only at frame boundaries. */ |
711 | #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization. |
712 | #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT. |
713 | #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay. |
714 | #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe. |
715 | #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT). |
716 | /* Fx : Flag for h263+ extra options */ |
717 | #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction |
718 | #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter |
719 | #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation |
720 | #define CODEC_FLAG_CLOSED_GOP 0x80000000 |
721 | #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks. |
722 | #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding. |
723 | #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata. |
724 | #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!! |
725 | #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS. |
726 | |
727 | #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries. |
728 | #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe |
729 | |
730 | /* Unsupported options : |
731 | * Syntax Arithmetic coding (SAC) |
732 | * Reference Picture Selection |
733 | * Independent Segment Decoding */ |
734 | /* /Fx */ |
735 | /* codec capabilities */ |
736 | |
737 | #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback. |
738 | /** |
739 | * Codec uses get_buffer() for allocating buffers and supports custom allocators. |
740 | * If not set, it might not use get_buffer() at all or use operations that |
741 | * assume the buffer was allocated by avcodec_default_get_buffer. |
742 | */ |
743 | #define CODEC_CAP_DR1 0x0002 |
744 | #define CODEC_CAP_TRUNCATED 0x0008 |
745 | /* Codec can export data for HW decoding (XvMC). */ |
746 | #define CODEC_CAP_HWACCEL 0x0010 |
747 | /** |
748 | * Encoder or decoder requires flushing with NULL input at the end in order to |
749 | * give the complete and correct output. |
750 | * |
751 | * NOTE: If this flag is not set, the codec is guaranteed to never be fed with |
752 | * with NULL data. The user can still send NULL data to the public encode |
753 | * or decode function, but libavcodec will not pass it along to the codec |
754 | * unless this flag is set. |
755 | * |
756 | * Decoders: |
757 | * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL, |
758 | * avpkt->size=0 at the end to get the delayed data until the decoder no longer |
759 | * returns frames. |
760 | * |
761 | * Encoders: |
762 | * The encoder needs to be fed with NULL data at the end of encoding until the |
763 | * encoder no longer returns data. |
764 | * |
765 | * NOTE: For encoders implementing the AVCodec.encode2() function, setting this |
766 | * flag also means that the encoder must set the pts and duration for |
767 | * each output packet. If this flag is not set, the pts and duration will |
768 | * be determined by libavcodec from the input frame. |
769 | */ |
770 | #define CODEC_CAP_DELAY 0x0020 |
771 | /** |
772 | * Codec can be fed a final frame with a smaller size. |
773 | * This can be used to prevent truncation of the last audio samples. |
774 | */ |
775 | #define CODEC_CAP_SMALL_LAST_FRAME 0x0040 |
776 | #if FF_API_CAP_VDPAU |
777 | /** |
778 | * Codec can export data for HW decoding (VDPAU). |
779 | */ |
780 | #define CODEC_CAP_HWACCEL_VDPAU 0x0080 |
781 | #endif |
782 | /** |
783 | * Codec can output multiple frames per AVPacket |
784 | * Normally demuxers return one frame at a time, demuxers which do not do |
785 | * are connected to a parser to split what they return into proper frames. |
786 | * This flag is reserved to the very rare category of codecs which have a |
787 | * bitstream that cannot be split into frames without timeconsuming |
788 | * operations like full decoding. Demuxers carring such bitstreams thus |
789 | * may return multiple frames in a packet. This has many disadvantages like |
790 | * prohibiting stream copy in many cases thus it should only be considered |
791 | * as a last resort. |
792 | */ |
793 | #define CODEC_CAP_SUBFRAMES 0x0100 |
794 | /** |
795 | * Codec is experimental and is thus avoided in favor of non experimental |
796 | * encoders |
797 | */ |
798 | #define CODEC_CAP_EXPERIMENTAL 0x0200 |
799 | /** |
800 | * Codec should fill in channel configuration and samplerate instead of container |
801 | */ |
802 | #define CODEC_CAP_CHANNEL_CONF 0x0400 |
803 | |
804 | /** |
805 | * Codec is able to deal with negative linesizes |
806 | */ |
807 | #define CODEC_CAP_NEG_LINESIZES 0x0800 |
808 | |
809 | /** |
810 | * Codec supports frame-level multithreading. |
811 | */ |
812 | #define CODEC_CAP_FRAME_THREADS 0x1000 |
813 | /** |
814 | * Codec supports slice-based (or partition-based) multithreading. |
815 | */ |
816 | #define CODEC_CAP_SLICE_THREADS 0x2000 |
817 | /** |
818 | * Codec supports changed parameters at any point. |
819 | */ |
820 | #define CODEC_CAP_PARAM_CHANGE 0x4000 |
821 | /** |
822 | * Codec supports avctx->thread_count == 0 (auto). |
823 | */ |
824 | #define CODEC_CAP_AUTO_THREADS 0x8000 |
825 | /** |
826 | * Audio encoder supports receiving a different number of samples in each call. |
827 | */ |
828 | #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000 |
829 | /** |
830 | * Codec is intra only. |
831 | */ |
832 | #define CODEC_CAP_INTRA_ONLY 0x40000000 |
833 | /** |
834 | * Codec is lossless. |
835 | */ |
836 | #define CODEC_CAP_LOSSLESS 0x80000000 |
837 | |
838 | //The following defines may change, don't expect compatibility if you use them. |
839 | #define MB_TYPE_INTRA4x4 0x0001 |
840 | #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific |
841 | #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific |
842 | #define MB_TYPE_16x16 0x0008 |
843 | #define MB_TYPE_16x8 0x0010 |
844 | #define MB_TYPE_8x16 0x0020 |
845 | #define MB_TYPE_8x8 0x0040 |
846 | #define MB_TYPE_INTERLACED 0x0080 |
847 | #define MB_TYPE_DIRECT2 0x0100 //FIXME |
848 | #define MB_TYPE_ACPRED 0x0200 |
849 | #define MB_TYPE_GMC 0x0400 |
850 | #define MB_TYPE_SKIP 0x0800 |
851 | #define MB_TYPE_P0L0 0x1000 |
852 | #define MB_TYPE_P1L0 0x2000 |
853 | #define MB_TYPE_P0L1 0x4000 |
854 | #define MB_TYPE_P1L1 0x8000 |
855 | #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0) |
856 | #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1) |
857 | #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1) |
858 | #define MB_TYPE_QUANT 0x00010000 |
859 | #define MB_TYPE_CBP 0x00020000 |
860 | //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...) |
861 | |
862 | /** |
863 | * Pan Scan area. |
864 | * This specifies the area which should be displayed. |
865 | * Note there may be multiple such areas for one frame. |
866 | */ |
867 | typedef struct AVPanScan{ |
868 | /** |
869 | * id |
870 | * - encoding: Set by user. |
871 | * - decoding: Set by libavcodec. |
872 | */ |
873 | int id; |
874 | |
875 | /** |
876 | * width and height in 1/16 pel |
877 | * - encoding: Set by user. |
878 | * - decoding: Set by libavcodec. |
879 | */ |
880 | int width; |
881 | int height; |
882 | |
883 | /** |
884 | * position of the top left corner in 1/16 pel for up to 3 fields/frames |
885 | * - encoding: Set by user. |
886 | * - decoding: Set by libavcodec. |
887 | */ |
888 | int16_t position[3][2]; |
889 | }AVPanScan; |
890 | |
891 | #define FF_QSCALE_TYPE_MPEG1 0 |
892 | #define FF_QSCALE_TYPE_MPEG2 1 |
893 | #define FF_QSCALE_TYPE_H264 2 |
894 | #define FF_QSCALE_TYPE_VP56 3 |
895 | |
896 | #if FF_API_GET_BUFFER |
897 | #define FF_BUFFER_TYPE_INTERNAL 1 |
898 | #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user) |
899 | #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared. |
900 | #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything. |
901 | |
902 | #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore). |
903 | #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer. |
904 | #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content. |
905 | #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update). |
906 | #endif |
907 | |
908 | /** |
909 | * The decoder will keep a reference to the frame and may reuse it later. |
910 | */ |
911 | #define AV_GET_BUFFER_FLAG_REF (1 << 0) |
912 | |
913 | /** |
914 | * @defgroup lavc_packet AVPacket |
915 | * |
916 | * Types and functions for working with AVPacket. |
917 | * @{ |
918 | */ |
919 | enum AVPacketSideDataType { |
920 | AV_PKT_DATA_PALETTE, |
921 | AV_PKT_DATA_NEW_EXTRADATA, |
922 | |
923 | /** |
924 | * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows: |
925 | * @code |
926 | * u32le param_flags |
927 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT) |
928 | * s32le channel_count |
929 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT) |
930 | * u64le channel_layout |
931 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE) |
932 | * s32le sample_rate |
933 | * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS) |
934 | * s32le width |
935 | * s32le height |
936 | * @endcode |
937 | */ |
938 | AV_PKT_DATA_PARAM_CHANGE, |
939 | |
940 | /** |
941 | * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of |
942 | * structures with info about macroblocks relevant to splitting the |
943 | * packet into smaller packets on macroblock edges (e.g. as for RFC 2190). |
944 | * That is, it does not necessarily contain info about all macroblocks, |
945 | * as long as the distance between macroblocks in the info is smaller |
946 | * than the target payload size. |
947 | * Each MB info structure is 12 bytes, and is laid out as follows: |
948 | * @code |
949 | * u32le bit offset from the start of the packet |
950 | * u8 current quantizer at the start of the macroblock |
951 | * u8 GOB number |
952 | * u16le macroblock address within the GOB |
953 | * u8 horizontal MV predictor |
954 | * u8 vertical MV predictor |
955 | * u8 horizontal MV predictor for block number 3 |
956 | * u8 vertical MV predictor for block number 3 |
957 | * @endcode |
958 | */ |
959 | AV_PKT_DATA_H263_MB_INFO, |
960 | |
961 | /** |
962 | * Recommmends skipping the specified number of samples |
963 | * @code |
964 | * u32le number of samples to skip from start of this packet |
965 | * u32le number of samples to skip from end of this packet |
966 | * u8 reason for start skip |
967 | * u8 reason for end skip (0=padding silence, 1=convergence) |
968 | * @endcode |
969 | */ |
970 | AV_PKT_DATA_SKIP_SAMPLES=70, |
971 | |
972 | /** |
973 | * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that |
974 | * the packet may contain "dual mono" audio specific to Japanese DTV |
975 | * and if it is true, recommends only the selected channel to be used. |
976 | * @code |
977 | * u8 selected channels (0=mail/left, 1=sub/right, 2=both) |
978 | * @endcode |
979 | */ |
980 | AV_PKT_DATA_JP_DUALMONO, |
981 | |
982 | /** |
983 | * A list of zero terminated key/value strings. There is no end marker for |
984 | * the list, so it is required to rely on the side data size to stop. |
985 | */ |
986 | AV_PKT_DATA_STRINGS_METADATA, |
987 | |
988 | /** |
989 | * Subtitle event position |
990 | * @code |
991 | * u32le x1 |
992 | * u32le y1 |
993 | * u32le x2 |
994 | * u32le y2 |
995 | * @endcode |
996 | */ |
997 | AV_PKT_DATA_SUBTITLE_POSITION, |
998 | |
999 | /** |
1000 | * Data found in BlockAdditional element of matroska container. There is |
1001 | * no end marker for the data, so it is required to rely on the side data |
1002 | * size to recognize the end. 8 byte id (as found in BlockAddId) followed |
1003 | * by data. |
1004 | */ |
1005 | AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL, |
1006 | |
1007 | /** |
1008 | * The optional first identifier line of a WebVTT cue. |
1009 | */ |
1010 | AV_PKT_DATA_WEBVTT_IDENTIFIER, |
1011 | |
1012 | /** |
1013 | * The optional settings (rendering instructions) that immediately |
1014 | * follow the timestamp specifier of a WebVTT cue. |
1015 | */ |
1016 | AV_PKT_DATA_WEBVTT_SETTINGS, |
1017 | }; |
1018 | |
1019 | /** |
1020 | * This structure stores compressed data. It is typically exported by demuxers |
1021 | * and then passed as input to decoders, or received as output from encoders and |
1022 | * then passed to muxers. |
1023 | * |
1024 | * For video, it should typically contain one compressed frame. For audio it may |
1025 | * contain several compressed frames. |
1026 | * |
1027 | * AVPacket is one of the few structs in FFmpeg, whose size is a part of public |
1028 | * ABI. Thus it may be allocated on stack and no new fields can be added to it |
1029 | * without libavcodec and libavformat major bump. |
1030 | * |
1031 | * The semantics of data ownership depends on the buf or destruct (deprecated) |
1032 | * fields. If either is set, the packet data is dynamically allocated and is |
1033 | * valid indefinitely until av_free_packet() is called (which in turn calls |
1034 | * av_buffer_unref()/the destruct callback to free the data). If neither is set, |
1035 | * the packet data is typically backed by some static buffer somewhere and is |
1036 | * only valid for a limited time (e.g. until the next read call when demuxing). |
1037 | * |
1038 | * The side data is always allocated with av_malloc() and is freed in |
1039 | * av_free_packet(). |
1040 | */ |
1041 | typedef struct AVPacket { |
1042 | /** |
1043 | * A reference to the reference-counted buffer where the packet data is |
1044 | * stored. |
1045 | * May be NULL, then the packet data is not reference-counted. |
1046 | */ |
1047 | AVBufferRef *buf; |
1048 | /** |
1049 | * Presentation timestamp in AVStream->time_base units; the time at which |
1050 | * the decompressed packet will be presented to the user. |
1051 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
1052 | * pts MUST be larger or equal to dts as presentation cannot happen before |
1053 | * decompression, unless one wants to view hex dumps. Some formats misuse |
1054 | * the terms dts and pts/cts to mean something different. Such timestamps |
1055 | * must be converted to true pts/dts before they are stored in AVPacket. |
1056 | */ |
1057 | int64_t pts; |
1058 | /** |
1059 | * Decompression timestamp in AVStream->time_base units; the time at which |
1060 | * the packet is decompressed. |
1061 | * Can be AV_NOPTS_VALUE if it is not stored in the file. |
1062 | */ |
1063 | int64_t dts; |
1064 | uint8_t *data; |
1065 | int size; |
1066 | int stream_index; |
1067 | /** |
1068 | * A combination of AV_PKT_FLAG values |
1069 | */ |
1070 | int flags; |
1071 | /** |
1072 | * Additional packet data that can be provided by the container. |
1073 | * Packet can contain several types of side information. |
1074 | */ |
1075 | struct { |
1076 | uint8_t *data; |
1077 | int size; |
1078 | enum AVPacketSideDataType type; |
1079 | } *side_data; |
1080 | int side_data_elems; |
1081 | |
1082 | /** |
1083 | * Duration of this packet in AVStream->time_base units, 0 if unknown. |
1084 | * Equals next_pts - this_pts in presentation order. |
1085 | */ |
1086 | int duration; |
1087 | #if FF_API_DESTRUCT_PACKET |
1088 | attribute_deprecated |
1089 | void (*destruct)(struct AVPacket *); |
1090 | attribute_deprecated |
1091 | void *priv; |
1092 | #endif |
1093 | int64_t pos; ///< byte position in stream, -1 if unknown |
1094 | |
1095 | /** |
1096 | * Time difference in AVStream->time_base units from the pts of this |
1097 | * packet to the point at which the output from the decoder has converged |
1098 | * independent from the availability of previous frames. That is, the |
1099 | * frames are virtually identical no matter if decoding started from |
1100 | * the very first frame or from this keyframe. |
1101 | * Is AV_NOPTS_VALUE if unknown. |
1102 | * This field is not the display duration of the current packet. |
1103 | * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY |
1104 | * set. |
1105 | * |
1106 | * The purpose of this field is to allow seeking in streams that have no |
1107 | * keyframes in the conventional sense. It corresponds to the |
1108 | * recovery point SEI in H.264 and match_time_delta in NUT. It is also |
1109 | * essential for some types of subtitle streams to ensure that all |
1110 | * subtitles are correctly displayed after seeking. |
1111 | */ |
1112 | int64_t convergence_duration; |
1113 | } AVPacket; |
1114 | #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe |
1115 | #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted |
1116 | |
1117 | enum AVSideDataParamChangeFlags { |
1118 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001, |
1119 | AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002, |
1120 | AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004, |
1121 | AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008, |
1122 | }; |
1123 | /** |
1124 | * @} |
1125 | */ |
1126 | |
1127 | struct AVCodecInternal; |
1128 | |
1129 | enum AVFieldOrder { |
1130 | AV_FIELD_UNKNOWN, |
1131 | AV_FIELD_PROGRESSIVE, |
1132 | AV_FIELD_TT, //< Top coded_first, top displayed first |
1133 | AV_FIELD_BB, //< Bottom coded first, bottom displayed first |
1134 | AV_FIELD_TB, //< Top coded first, bottom displayed first |
1135 | AV_FIELD_BT, //< Bottom coded first, top displayed first |
1136 | }; |
1137 | |
1138 | /** |
1139 | * main external API structure. |
1140 | * New fields can be added to the end with minor version bumps. |
1141 | * Removal, reordering and changes to existing fields require a major |
1142 | * version bump. |
1143 | * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user |
1144 | * applications. |
1145 | * sizeof(AVCodecContext) must not be used outside libav*. |
1146 | */ |
1147 | typedef struct AVCodecContext { |
1148 | /** |
1149 | * information on struct for av_log |
1150 | * - set by avcodec_alloc_context3 |
1151 | */ |
1152 | const AVClass *av_class; |
1153 | int log_level_offset; |
1154 | |
1155 | enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */ |
1156 | const struct AVCodec *codec; |
1157 | char codec_name[32]; |
1158 | enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */ |
1159 | |
1160 | /** |
1161 | * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). |
1162 | * This is used to work around some encoder bugs. |
1163 | * A demuxer should set this to what is stored in the field used to identify the codec. |
1164 | * If there are multiple such fields in a container then the demuxer should choose the one |
1165 | * which maximizes the information about the used codec. |
1166 | * If the codec tag field in a container is larger than 32 bits then the demuxer should |
1167 | * remap the longer ID to 32 bits with a table or other structure. Alternatively a new |
1168 | * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated |
1169 | * first. |
1170 | * - encoding: Set by user, if not then the default based on codec_id will be used. |
1171 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. |
1172 | */ |
1173 | unsigned int codec_tag; |
1174 | |
1175 | /** |
1176 | * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A'). |
1177 | * This is used to work around some encoder bugs. |
1178 | * - encoding: unused |
1179 | * - decoding: Set by user, will be converted to uppercase by libavcodec during init. |
1180 | */ |
1181 | unsigned int stream_codec_tag; |
1182 | |
1183 | void *priv_data; |
1184 | |
1185 | /** |
1186 | * Private context used for internal data. |
1187 | * |
1188 | * Unlike priv_data, this is not codec-specific. It is used in general |
1189 | * libavcodec functions. |
1190 | */ |
1191 | struct AVCodecInternal *internal; |
1192 | |
1193 | /** |
1194 | * Private data of the user, can be used to carry app specific stuff. |
1195 | * - encoding: Set by user. |
1196 | * - decoding: Set by user. |
1197 | */ |
1198 | void *opaque; |
1199 | |
1200 | /** |
1201 | * the average bitrate |
1202 | * - encoding: Set by user; unused for constant quantizer encoding. |
1203 | * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream. |
1204 | */ |
1205 | int bit_rate; |
1206 | |
1207 | /** |
1208 | * number of bits the bitstream is allowed to diverge from the reference. |
1209 | * the reference can be CBR (for CBR pass1) or VBR (for pass2) |
1210 | * - encoding: Set by user; unused for constant quantizer encoding. |
1211 | * - decoding: unused |
1212 | */ |
1213 | int bit_rate_tolerance; |
1214 | |
1215 | /** |
1216 | * Global quality for codecs which cannot change it per frame. |
1217 | * This should be proportional to MPEG-1/2/4 qscale. |
1218 | * - encoding: Set by user. |
1219 | * - decoding: unused |
1220 | */ |
1221 | int global_quality; |
1222 | |
1223 | /** |
1224 | * - encoding: Set by user. |
1225 | * - decoding: unused |
1226 | */ |
1227 | int compression_level; |
1228 | #define FF_COMPRESSION_DEFAULT -1 |
1229 | |
1230 | /** |
1231 | * CODEC_FLAG_*. |
1232 | * - encoding: Set by user. |
1233 | * - decoding: Set by user. |
1234 | */ |
1235 | int flags; |
1236 | |
1237 | /** |
1238 | * CODEC_FLAG2_* |
1239 | * - encoding: Set by user. |
1240 | * - decoding: Set by user. |
1241 | */ |
1242 | int flags2; |
1243 | |
1244 | /** |
1245 | * some codecs need / can use extradata like Huffman tables. |
1246 | * mjpeg: Huffman tables |
1247 | * rv10: additional flags |
1248 | * mpeg4: global headers (they can be in the bitstream or here) |
1249 | * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger |
1250 | * than extradata_size to avoid problems if it is read with the bitstream reader. |
1251 | * The bytewise contents of extradata must not depend on the architecture or CPU endianness. |
1252 | * - encoding: Set/allocated/freed by libavcodec. |
1253 | * - decoding: Set/allocated/freed by user. |
1254 | */ |
1255 | uint8_t *extradata; |
1256 | int extradata_size; |
1257 | |
1258 | /** |
1259 | * This is the fundamental unit of time (in seconds) in terms |
1260 | * of which frame timestamps are represented. For fixed-fps content, |
1261 | * timebase should be 1/framerate and timestamp increments should be |
1262 | * identically 1. |
1263 | * - encoding: MUST be set by user. |
1264 | * - decoding: Set by libavcodec. |
1265 | */ |
1266 | AVRational time_base; |
1267 | |
1268 | /** |
1269 | * For some codecs, the time base is closer to the field rate than the frame rate. |
1270 | * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration |
1271 | * if no telecine is used ... |
1272 | * |
1273 | * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2. |
1274 | */ |
1275 | int ticks_per_frame; |
1276 | |
1277 | /** |
1278 | * Codec delay. |
1279 | * |
1280 | * Encoding: Number of frames delay there will be from the encoder input to |
1281 | * the decoder output. (we assume the decoder matches the spec) |
1282 | * Decoding: Number of frames delay in addition to what a standard decoder |
1283 | * as specified in the spec would produce. |
1284 | * |
1285 | * Video: |
1286 | * Number of frames the decoded output will be delayed relative to the |
1287 | * encoded input. |
1288 | * |
1289 | * Audio: |
1290 | * For encoding, this is the number of "priming" samples added to the |
1291 | * beginning of the stream. The decoded output will be delayed by this |
1292 | * many samples relative to the input to the encoder. Note that this |
1293 | * field is purely informational and does not directly affect the pts |
1294 | * output by the encoder, which should always be based on the actual |
1295 | * presentation time, including any delay. |
1296 | * For decoding, this is the number of samples the decoder needs to |
1297 | * output before the decoder's output is valid. When seeking, you should |
1298 | * start decoding this many samples prior to your desired seek point. |
1299 | * |
1300 | * - encoding: Set by libavcodec. |
1301 | * - decoding: Set by libavcodec. |
1302 | */ |
1303 | int delay; |
1304 | |
1305 | |
1306 | /* video only */ |
1307 | /** |
1308 | * picture width / height. |
1309 | * - encoding: MUST be set by user. |
1310 | * - decoding: May be set by the user before opening the decoder if known e.g. |
1311 | * from the container. Some decoders will require the dimensions |
1312 | * to be set by the caller. During decoding, the decoder may |
1313 | * overwrite those values as required. |
1314 | */ |
1315 | int width, height; |
1316 | |
1317 | /** |
1318 | * Bitstream width / height, may be different from width/height e.g. when |
1319 | * the decoded frame is cropped before being output or lowres is enabled. |
1320 | * - encoding: unused |
1321 | * - decoding: May be set by the user before opening the decoder if known |
1322 | * e.g. from the container. During decoding, the decoder may |
1323 | * overwrite those values as required. |
1324 | */ |
1325 | int coded_width, coded_height; |
1326 | |
1327 | #define FF_ASPECT_EXTENDED 15 |
1328 | |
1329 | /** |
1330 | * the number of pictures in a group of pictures, or 0 for intra_only |
1331 | * - encoding: Set by user. |
1332 | * - decoding: unused |
1333 | */ |
1334 | int gop_size; |
1335 | |
1336 | /** |
1337 | * Pixel format, see AV_PIX_FMT_xxx. |
1338 | * May be set by the demuxer if known from headers. |
1339 | * May be overridden by the decoder if it knows better. |
1340 | * - encoding: Set by user. |
1341 | * - decoding: Set by user if known, overridden by libavcodec if known |
1342 | */ |
1343 | enum AVPixelFormat pix_fmt; |
1344 | |
1345 | /** |
1346 | * Motion estimation algorithm used for video coding. |
1347 | * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex), |
1348 | * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific] |
1349 | * - encoding: MUST be set by user. |
1350 | * - decoding: unused |
1351 | */ |
1352 | int me_method; |
1353 | |
1354 | /** |
1355 | * If non NULL, 'draw_horiz_band' is called by the libavcodec |
1356 | * decoder to draw a horizontal band. It improves cache usage. Not |
1357 | * all codecs can do that. You must check the codec capabilities |
1358 | * beforehand. |
1359 | * When multithreading is used, it may be called from multiple threads |
1360 | * at the same time; threads might draw different parts of the same AVFrame, |
1361 | * or multiple AVFrames, and there is no guarantee that slices will be drawn |
1362 | * in order. |
1363 | * The function is also used by hardware acceleration APIs. |
1364 | * It is called at least once during frame decoding to pass |
1365 | * the data needed for hardware render. |
1366 | * In that mode instead of pixel data, AVFrame points to |
1367 | * a structure specific to the acceleration API. The application |
1368 | * reads the structure and can change some fields to indicate progress |
1369 | * or mark state. |
1370 | * - encoding: unused |
1371 | * - decoding: Set by user. |
1372 | * @param height the height of the slice |
1373 | * @param y the y position of the slice |
1374 | * @param type 1->top field, 2->bottom field, 3->frame |
1375 | * @param offset offset into the AVFrame.data from which the slice should be read |
1376 | */ |
1377 | void (*draw_horiz_band)(struct AVCodecContext *s, |
1378 | const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], |
1379 | int y, int type, int height); |
1380 | |
1381 | /** |
1382 | * callback to negotiate the pixelFormat |
1383 | * @param fmt is the list of formats which are supported by the codec, |
1384 | * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality. |
1385 | * The first is always the native one. |
1386 | * @return the chosen format |
1387 | * - encoding: unused |
1388 | * - decoding: Set by user, if not set the native format will be chosen. |
1389 | */ |
1390 | enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt); |
1391 | |
1392 | /** |
1393 | * maximum number of B-frames between non-B-frames |
1394 | * Note: The output will be delayed by max_b_frames+1 relative to the input. |
1395 | * - encoding: Set by user. |
1396 | * - decoding: unused |
1397 | */ |
1398 | int max_b_frames; |
1399 | |
1400 | /** |
1401 | * qscale factor between IP and B-frames |
1402 | * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset). |
1403 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). |
1404 | * - encoding: Set by user. |
1405 | * - decoding: unused |
1406 | */ |
1407 | float b_quant_factor; |
1408 | |
1409 | /** obsolete FIXME remove */ |
1410 | int rc_strategy; |
1411 | #define FF_RC_STRATEGY_XVID 1 |
1412 | |
1413 | int b_frame_strategy; |
1414 | |
1415 | /** |
1416 | * qscale offset between IP and B-frames |
1417 | * - encoding: Set by user. |
1418 | * - decoding: unused |
1419 | */ |
1420 | float b_quant_offset; |
1421 | |
1422 | /** |
1423 | * Size of the frame reordering buffer in the decoder. |
1424 | * For MPEG-2 it is 1 IPB or 0 low delay IP. |
1425 | * - encoding: Set by libavcodec. |
1426 | * - decoding: Set by libavcodec. |
1427 | */ |
1428 | int has_b_frames; |
1429 | |
1430 | /** |
1431 | * 0-> h263 quant 1-> mpeg quant |
1432 | * - encoding: Set by user. |
1433 | * - decoding: unused |
1434 | */ |
1435 | int mpeg_quant; |
1436 | |
1437 | /** |
1438 | * qscale factor between P and I-frames |
1439 | * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset). |
1440 | * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset). |
1441 | * - encoding: Set by user. |
1442 | * - decoding: unused |
1443 | */ |
1444 | float i_quant_factor; |
1445 | |
1446 | /** |
1447 | * qscale offset between P and I-frames |
1448 | * - encoding: Set by user. |
1449 | * - decoding: unused |
1450 | */ |
1451 | float i_quant_offset; |
1452 | |
1453 | /** |
1454 | * luminance masking (0-> disabled) |
1455 | * - encoding: Set by user. |
1456 | * - decoding: unused |
1457 | */ |
1458 | float lumi_masking; |
1459 | |
1460 | /** |
1461 | * temporary complexity masking (0-> disabled) |
1462 | * - encoding: Set by user. |
1463 | * - decoding: unused |
1464 | */ |
1465 | float temporal_cplx_masking; |
1466 | |
1467 | /** |
1468 | * spatial complexity masking (0-> disabled) |
1469 | * - encoding: Set by user. |
1470 | * - decoding: unused |
1471 | */ |
1472 | float spatial_cplx_masking; |
1473 | |
1474 | /** |
1475 | * p block masking (0-> disabled) |
1476 | * - encoding: Set by user. |
1477 | * - decoding: unused |
1478 | */ |
1479 | float p_masking; |
1480 | |
1481 | /** |
1482 | * darkness masking (0-> disabled) |
1483 | * - encoding: Set by user. |
1484 | * - decoding: unused |
1485 | */ |
1486 | float dark_masking; |
1487 | |
1488 | /** |
1489 | * slice count |
1490 | * - encoding: Set by libavcodec. |
1491 | * - decoding: Set by user (or 0). |
1492 | */ |
1493 | int slice_count; |
1494 | /** |
1495 | * prediction method (needed for huffyuv) |
1496 | * - encoding: Set by user. |
1497 | * - decoding: unused |
1498 | */ |
1499 | int prediction_method; |
1500 | #define FF_PRED_LEFT 0 |
1501 | #define FF_PRED_PLANE 1 |
1502 | #define FF_PRED_MEDIAN 2 |
1503 | |
1504 | /** |
1505 | * slice offsets in the frame in bytes |
1506 | * - encoding: Set/allocated by libavcodec. |
1507 | * - decoding: Set/allocated by user (or NULL). |
1508 | */ |
1509 | int *slice_offset; |
1510 | |
1511 | /** |
1512 | * sample aspect ratio (0 if unknown) |
1513 | * That is the width of a pixel divided by the height of the pixel. |
1514 | * Numerator and denominator must be relatively prime and smaller than 256 for some video standards. |
1515 | * - encoding: Set by user. |
1516 | * - decoding: Set by libavcodec. |
1517 | */ |
1518 | AVRational sample_aspect_ratio; |
1519 | |
1520 | /** |
1521 | * motion estimation comparison function |
1522 | * - encoding: Set by user. |
1523 | * - decoding: unused |
1524 | */ |
1525 | int me_cmp; |
1526 | /** |
1527 | * subpixel motion estimation comparison function |
1528 | * - encoding: Set by user. |
1529 | * - decoding: unused |
1530 | */ |
1531 | int me_sub_cmp; |
1532 | /** |
1533 | * macroblock comparison function (not supported yet) |
1534 | * - encoding: Set by user. |
1535 | * - decoding: unused |
1536 | */ |
1537 | int mb_cmp; |
1538 | /** |
1539 | * interlaced DCT comparison function |
1540 | * - encoding: Set by user. |
1541 | * - decoding: unused |
1542 | */ |
1543 | int ildct_cmp; |
1544 | #define FF_CMP_SAD 0 |
1545 | #define FF_CMP_SSE 1 |
1546 | #define FF_CMP_SATD 2 |
1547 | #define FF_CMP_DCT 3 |
1548 | #define FF_CMP_PSNR 4 |
1549 | #define FF_CMP_BIT 5 |
1550 | #define FF_CMP_RD 6 |
1551 | #define FF_CMP_ZERO 7 |
1552 | #define FF_CMP_VSAD 8 |
1553 | #define FF_CMP_VSSE 9 |
1554 | #define FF_CMP_NSSE 10 |
1555 | #define FF_CMP_W53 11 |
1556 | #define FF_CMP_W97 12 |
1557 | #define FF_CMP_DCTMAX 13 |
1558 | #define FF_CMP_DCT264 14 |
1559 | #define FF_CMP_CHROMA 256 |
1560 | |
1561 | /** |
1562 | * ME diamond size & shape |
1563 | * - encoding: Set by user. |
1564 | * - decoding: unused |
1565 | */ |
1566 | int dia_size; |
1567 | |
1568 | /** |
1569 | * amount of previous MV predictors (2a+1 x 2a+1 square) |
1570 | * - encoding: Set by user. |
1571 | * - decoding: unused |
1572 | */ |
1573 | int last_predictor_count; |
1574 | |
1575 | /** |
1576 | * prepass for motion estimation |
1577 | * - encoding: Set by user. |
1578 | * - decoding: unused |
1579 | */ |
1580 | int pre_me; |
1581 | |
1582 | /** |
1583 | * motion estimation prepass comparison function |
1584 | * - encoding: Set by user. |
1585 | * - decoding: unused |
1586 | */ |
1587 | int me_pre_cmp; |
1588 | |
1589 | /** |
1590 | * ME prepass diamond size & shape |
1591 | * - encoding: Set by user. |
1592 | * - decoding: unused |
1593 | */ |
1594 | int pre_dia_size; |
1595 | |
1596 | /** |
1597 | * subpel ME quality |
1598 | * - encoding: Set by user. |
1599 | * - decoding: unused |
1600 | */ |
1601 | int me_subpel_quality; |
1602 | |
1603 | /** |
1604 | * DTG active format information (additional aspect ratio |
1605 | * information only used in DVB MPEG-2 transport streams) |
1606 | * 0 if not set. |
1607 | * |
1608 | * - encoding: unused |
1609 | * - decoding: Set by decoder. |
1610 | */ |
1611 | int dtg_active_format; |
1612 | #define FF_DTG_AFD_SAME 8 |
1613 | #define FF_DTG_AFD_4_3 9 |
1614 | #define FF_DTG_AFD_16_9 10 |
1615 | #define FF_DTG_AFD_14_9 11 |
1616 | #define FF_DTG_AFD_4_3_SP_14_9 13 |
1617 | #define FF_DTG_AFD_16_9_SP_14_9 14 |
1618 | #define FF_DTG_AFD_SP_4_3 15 |
1619 | |
1620 | /** |
1621 | * maximum motion estimation search range in subpel units |
1622 | * If 0 then no limit. |
1623 | * |
1624 | * - encoding: Set by user. |
1625 | * - decoding: unused |
1626 | */ |
1627 | int me_range; |
1628 | |
1629 | /** |
1630 | * intra quantizer bias |
1631 | * - encoding: Set by user. |
1632 | * - decoding: unused |
1633 | */ |
1634 | int intra_quant_bias; |
1635 | #define FF_DEFAULT_QUANT_BIAS 999999 |
1636 | |
1637 | /** |
1638 | * inter quantizer bias |
1639 | * - encoding: Set by user. |
1640 | * - decoding: unused |
1641 | */ |
1642 | int inter_quant_bias; |
1643 | |
1644 | /** |
1645 | * slice flags |
1646 | * - encoding: unused |
1647 | * - decoding: Set by user. |
1648 | */ |
1649 | int slice_flags; |
1650 | #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display |
1651 | #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics) |
1652 | #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1) |
1653 | |
1654 | /** |
1655 | * XVideo Motion Acceleration |
1656 | * - encoding: forbidden |
1657 | * - decoding: set by decoder |
1658 | */ |
1659 | int xvmc_acceleration; |
1660 | |
1661 | /** |
1662 | * macroblock decision mode |
1663 | * - encoding: Set by user. |
1664 | * - decoding: unused |
1665 | */ |
1666 | int mb_decision; |
1667 | #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp |
1668 | #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits |
1669 | #define FF_MB_DECISION_RD 2 ///< rate distortion |
1670 | |
1671 | /** |
1672 | * custom intra quantization matrix |
1673 | * - encoding: Set by user, can be NULL. |
1674 | * - decoding: Set by libavcodec. |
1675 | */ |
1676 | uint16_t *intra_matrix; |
1677 | |
1678 | /** |
1679 | * custom inter quantization matrix |
1680 | * - encoding: Set by user, can be NULL. |
1681 | * - decoding: Set by libavcodec. |
1682 | */ |
1683 | uint16_t *inter_matrix; |
1684 | |
1685 | /** |
1686 | * scene change detection threshold |
1687 | * 0 is default, larger means fewer detected scene changes. |
1688 | * - encoding: Set by user. |
1689 | * - decoding: unused |
1690 | */ |
1691 | int scenechange_threshold; |
1692 | |
1693 | /** |
1694 | * noise reduction strength |
1695 | * - encoding: Set by user. |
1696 | * - decoding: unused |
1697 | */ |
1698 | int noise_reduction; |
1699 | |
1700 | /** |
1701 | * Motion estimation threshold below which no motion estimation is |
1702 | * performed, but instead the user specified motion vectors are used. |
1703 | * |
1704 | * - encoding: Set by user. |
1705 | * - decoding: unused |
1706 | */ |
1707 | int me_threshold; |
1708 | |
1709 | /** |
1710 | * Macroblock threshold below which the user specified macroblock types will be used. |
1711 | * - encoding: Set by user. |
1712 | * - decoding: unused |
1713 | */ |
1714 | int mb_threshold; |
1715 | |
1716 | /** |
1717 | * precision of the intra DC coefficient - 8 |
1718 | * - encoding: Set by user. |
1719 | * - decoding: unused |
1720 | */ |
1721 | int intra_dc_precision; |
1722 | |
1723 | /** |
1724 | * Number of macroblock rows at the top which are skipped. |
1725 | * - encoding: unused |
1726 | * - decoding: Set by user. |
1727 | */ |
1728 | int skip_top; |
1729 | |
1730 | /** |
1731 | * Number of macroblock rows at the bottom which are skipped. |
1732 | * - encoding: unused |
1733 | * - decoding: Set by user. |
1734 | */ |
1735 | int skip_bottom; |
1736 | |
1737 | /** |
1738 | * Border processing masking, raises the quantizer for mbs on the borders |
1739 | * of the picture. |
1740 | * - encoding: Set by user. |
1741 | * - decoding: unused |
1742 | */ |
1743 | float border_masking; |
1744 | |
1745 | /** |
1746 | * minimum MB lagrange multipler |
1747 | * - encoding: Set by user. |
1748 | * - decoding: unused |
1749 | */ |
1750 | int mb_lmin; |
1751 | |
1752 | /** |
1753 | * maximum MB lagrange multipler |
1754 | * - encoding: Set by user. |
1755 | * - decoding: unused |
1756 | */ |
1757 | int mb_lmax; |
1758 | |
1759 | /** |
1760 | * |
1761 | * - encoding: Set by user. |
1762 | * - decoding: unused |
1763 | */ |
1764 | int me_penalty_compensation; |
1765 | |
1766 | /** |
1767 | * |
1768 | * - encoding: Set by user. |
1769 | * - decoding: unused |
1770 | */ |
1771 | int bidir_refine; |
1772 | |
1773 | /** |
1774 | * |
1775 | * - encoding: Set by user. |
1776 | * - decoding: unused |
1777 | */ |
1778 | int brd_scale; |
1779 | |
1780 | /** |
1781 | * minimum GOP size |
1782 | * - encoding: Set by user. |
1783 | * - decoding: unused |
1784 | */ |
1785 | int keyint_min; |
1786 | |
1787 | /** |
1788 | * number of reference frames |
1789 | * - encoding: Set by user. |
1790 | * - decoding: Set by lavc. |
1791 | */ |
1792 | int refs; |
1793 | |
1794 | /** |
1795 | * chroma qp offset from luma |
1796 | * - encoding: Set by user. |
1797 | * - decoding: unused |
1798 | */ |
1799 | int chromaoffset; |
1800 | |
1801 | /** |
1802 | * Multiplied by qscale for each frame and added to scene_change_score. |
1803 | * - encoding: Set by user. |
1804 | * - decoding: unused |
1805 | */ |
1806 | int scenechange_factor; |
1807 | |
1808 | /** |
1809 | * |
1810 | * Note: Value depends upon the compare function used for fullpel ME. |
1811 | * - encoding: Set by user. |
1812 | * - decoding: unused |
1813 | */ |
1814 | int mv0_threshold; |
1815 | |
1816 | /** |
1817 | * Adjust sensitivity of b_frame_strategy 1. |
1818 | * - encoding: Set by user. |
1819 | * - decoding: unused |
1820 | */ |
1821 | int b_sensitivity; |
1822 | |
1823 | /** |
1824 | * Chromaticity coordinates of the source primaries. |
1825 | * - encoding: Set by user |
1826 | * - decoding: Set by libavcodec |
1827 | */ |
1828 | enum AVColorPrimaries color_primaries; |
1829 | |
1830 | /** |
1831 | * Color Transfer Characteristic. |
1832 | * - encoding: Set by user |
1833 | * - decoding: Set by libavcodec |
1834 | */ |
1835 | enum AVColorTransferCharacteristic color_trc; |
1836 | |
1837 | /** |
1838 | * YUV colorspace type. |
1839 | * - encoding: Set by user |
1840 | * - decoding: Set by libavcodec |
1841 | */ |
1842 | enum AVColorSpace colorspace; |
1843 | |
1844 | /** |
1845 | * MPEG vs JPEG YUV range. |
1846 | * - encoding: Set by user |
1847 | * - decoding: Set by libavcodec |
1848 | */ |
1849 | enum AVColorRange color_range; |
1850 | |
1851 | /** |
1852 | * This defines the location of chroma samples. |
1853 | * - encoding: Set by user |
1854 | * - decoding: Set by libavcodec |
1855 | */ |
1856 | enum AVChromaLocation chroma_sample_location; |
1857 | |
1858 | /** |
1859 | * Number of slices. |
1860 | * Indicates number of picture subdivisions. Used for parallelized |
1861 | * decoding. |
1862 | * - encoding: Set by user |
1863 | * - decoding: unused |
1864 | */ |
1865 | int slices; |
1866 | |
1867 | /** Field order |
1868 | * - encoding: set by libavcodec |
1869 | * - decoding: Set by user. |
1870 | */ |
1871 | enum AVFieldOrder field_order; |
1872 | |
1873 | /* audio only */ |
1874 | int sample_rate; ///< samples per second |
1875 | int channels; ///< number of audio channels |
1876 | |
1877 | /** |
1878 | * audio sample format |
1879 | * - encoding: Set by user. |
1880 | * - decoding: Set by libavcodec. |
1881 | */ |
1882 | enum AVSampleFormat sample_fmt; ///< sample format |
1883 | |
1884 | /* The following data should not be initialized. */ |
1885 | /** |
1886 | * Number of samples per channel in an audio frame. |
1887 | * |
1888 | * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame |
1889 | * except the last must contain exactly frame_size samples per channel. |
1890 | * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the |
1891 | * frame size is not restricted. |
1892 | * - decoding: may be set by some decoders to indicate constant frame size |
1893 | */ |
1894 | int frame_size; |
1895 | |
1896 | /** |
1897 | * Frame counter, set by libavcodec. |
1898 | * |
1899 | * - decoding: total number of frames returned from the decoder so far. |
1900 | * - encoding: total number of frames passed to the encoder so far. |
1901 | * |
1902 | * @note the counter is not incremented if encoding/decoding resulted in |
1903 | * an error. |
1904 | */ |
1905 | int frame_number; |
1906 | |
1907 | /** |
1908 | * number of bytes per packet if constant and known or 0 |
1909 | * Used by some WAV based audio codecs. |
1910 | */ |
1911 | int block_align; |
1912 | |
1913 | /** |
1914 | * Audio cutoff bandwidth (0 means "automatic") |
1915 | * - encoding: Set by user. |
1916 | * - decoding: unused |
1917 | */ |
1918 | int cutoff; |
1919 | |
1920 | #if FF_API_REQUEST_CHANNELS |
1921 | /** |
1922 | * Decoder should decode to this many channels if it can (0 for default) |
1923 | * - encoding: unused |
1924 | * - decoding: Set by user. |
1925 | * @deprecated Deprecated in favor of request_channel_layout. |
1926 | */ |
1927 | attribute_deprecated int request_channels; |
1928 | #endif |
1929 | |
1930 | /** |
1931 | * Audio channel layout. |
1932 | * - encoding: set by user. |
1933 | * - decoding: set by user, may be overwritten by libavcodec. |
1934 | */ |
1935 | uint64_t channel_layout; |
1936 | |
1937 | /** |
1938 | * Request decoder to use this channel layout if it can (0 for default) |
1939 | * - encoding: unused |
1940 | * - decoding: Set by user. |
1941 | */ |
1942 | uint64_t request_channel_layout; |
1943 | |
1944 | /** |
1945 | * Type of service that the audio stream conveys. |
1946 | * - encoding: Set by user. |
1947 | * - decoding: Set by libavcodec. |
1948 | */ |
1949 | enum AVAudioServiceType audio_service_type; |
1950 | |
1951 | /** |
1952 | * desired sample format |
1953 | * - encoding: Not used. |
1954 | * - decoding: Set by user. |
1955 | * Decoder will decode to this format if it can. |
1956 | */ |
1957 | enum AVSampleFormat request_sample_fmt; |
1958 | |
1959 | #if FF_API_GET_BUFFER |
1960 | /** |
1961 | * Called at the beginning of each frame to get a buffer for it. |
1962 | * |
1963 | * The function will set AVFrame.data[], AVFrame.linesize[]. |
1964 | * AVFrame.extended_data[] must also be set, but it should be the same as |
1965 | * AVFrame.data[] except for planar audio with more channels than can fit |
1966 | * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as |
1967 | * many data pointers as it can hold. |
1968 | * |
1969 | * if CODEC_CAP_DR1 is not set then get_buffer() must call |
1970 | * avcodec_default_get_buffer() instead of providing buffers allocated by |
1971 | * some other means. |
1972 | * |
1973 | * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't |
1974 | * need it. avcodec_default_get_buffer() aligns the output buffer properly, |
1975 | * but if get_buffer() is overridden then alignment considerations should |
1976 | * be taken into account. |
1977 | * |
1978 | * @see avcodec_default_get_buffer() |
1979 | * |
1980 | * Video: |
1981 | * |
1982 | * If pic.reference is set then the frame will be read later by libavcodec. |
1983 | * avcodec_align_dimensions2() should be used to find the required width and |
1984 | * height, as they normally need to be rounded up to the next multiple of 16. |
1985 | * |
1986 | * If frame multithreading is used and thread_safe_callbacks is set, |
1987 | * it may be called from a different thread, but not from more than one at |
1988 | * once. Does not need to be reentrant. |
1989 | * |
1990 | * @see release_buffer(), reget_buffer() |
1991 | * @see avcodec_align_dimensions2() |
1992 | * |
1993 | * Audio: |
1994 | * |
1995 | * Decoders request a buffer of a particular size by setting |
1996 | * AVFrame.nb_samples prior to calling get_buffer(). The decoder may, |
1997 | * however, utilize only part of the buffer by setting AVFrame.nb_samples |
1998 | * to a smaller value in the output frame. |
1999 | * |
2000 | * Decoders cannot use the buffer after returning from |
2001 | * avcodec_decode_audio4(), so they will not call release_buffer(), as it |
2002 | * is assumed to be released immediately upon return. In some rare cases, |
2003 | * a decoder may need to call get_buffer() more than once in a single |
2004 | * call to avcodec_decode_audio4(). In that case, when get_buffer() is |
2005 | * called again after it has already been called once, the previously |
2006 | * acquired buffer is assumed to be released at that time and may not be |
2007 | * reused by the decoder. |
2008 | * |
2009 | * As a convenience, av_samples_get_buffer_size() and |
2010 | * av_samples_fill_arrays() in libavutil may be used by custom get_buffer() |
2011 | * functions to find the required data size and to fill data pointers and |
2012 | * linesize. In AVFrame.linesize, only linesize[0] may be set for audio |
2013 | * since all planes must be the same size. |
2014 | * |
2015 | * @see av_samples_get_buffer_size(), av_samples_fill_arrays() |
2016 | * |
2017 | * - encoding: unused |
2018 | * - decoding: Set by libavcodec, user can override. |
2019 | * |
2020 | * @deprecated use get_buffer2() |
2021 | */ |
2022 | attribute_deprecated |
2023 | int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic); |
2024 | |
2025 | /** |
2026 | * Called to release buffers which were allocated with get_buffer. |
2027 | * A released buffer can be reused in get_buffer(). |
2028 | * pic.data[*] must be set to NULL. |
2029 | * May be called from a different thread if frame multithreading is used, |
2030 | * but not by more than one thread at once, so does not need to be reentrant. |
2031 | * - encoding: unused |
2032 | * - decoding: Set by libavcodec, user can override. |
2033 | * |
2034 | * @deprecated custom freeing callbacks should be set from get_buffer2() |
2035 | */ |
2036 | attribute_deprecated |
2037 | void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic); |
2038 | |
2039 | /** |
2040 | * Called at the beginning of a frame to get cr buffer for it. |
2041 | * Buffer type (size, hints) must be the same. libavcodec won't check it. |
2042 | * libavcodec will pass previous buffer in pic, function should return |
2043 | * same buffer or new buffer with old frame "painted" into it. |
2044 | * If pic.data[0] == NULL must behave like get_buffer(). |
2045 | * if CODEC_CAP_DR1 is not set then reget_buffer() must call |
2046 | * avcodec_default_reget_buffer() instead of providing buffers allocated by |
2047 | * some other means. |
2048 | * - encoding: unused |
2049 | * - decoding: Set by libavcodec, user can override. |
2050 | */ |
2051 | attribute_deprecated |
2052 | int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic); |
2053 | #endif |
2054 | |
2055 | /** |
2056 | * This callback is called at the beginning of each frame to get data |
2057 | * buffer(s) for it. There may be one contiguous buffer for all the data or |
2058 | * there may be a buffer per each data plane or anything in between. What |
2059 | * this means is, you may set however many entries in buf[] you feel necessary. |
2060 | * Each buffer must be reference-counted using the AVBuffer API (see description |
2061 | * of buf[] below). |
2062 | * |
2063 | * The following fields will be set in the frame before this callback is |
2064 | * called: |
2065 | * - format |
2066 | * - width, height (video only) |
2067 | * - sample_rate, channel_layout, nb_samples (audio only) |
2068 | * Their values may differ from the corresponding values in |
2069 | * AVCodecContext. This callback must use the frame values, not the codec |
2070 | * context values, to calculate the required buffer size. |
2071 | * |
2072 | * This callback must fill the following fields in the frame: |
2073 | * - data[] |
2074 | * - linesize[] |
2075 | * - extended_data: |
2076 | * * if the data is planar audio with more than 8 channels, then this |
2077 | * callback must allocate and fill extended_data to contain all pointers |
2078 | * to all data planes. data[] must hold as many pointers as it can. |
2079 | * extended_data must be allocated with av_malloc() and will be freed in |
2080 | * av_frame_unref(). |
2081 | * * otherwise exended_data must point to data |
2082 | * - buf[] must contain one or more pointers to AVBufferRef structures. Each of |
2083 | * the frame's data and extended_data pointers must be contained in these. That |
2084 | * is, one AVBufferRef for each allocated chunk of memory, not necessarily one |
2085 | * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(), |
2086 | * and av_buffer_ref(). |
2087 | * - extended_buf and nb_extended_buf must be allocated with av_malloc() by |
2088 | * this callback and filled with the extra buffers if there are more |
2089 | * buffers than buf[] can hold. extended_buf will be freed in |
2090 | * av_frame_unref(). |
2091 | * |
2092 | * If CODEC_CAP_DR1 is not set then get_buffer2() must call |
2093 | * avcodec_default_get_buffer2() instead of providing buffers allocated by |
2094 | * some other means. |
2095 | * |
2096 | * Each data plane must be aligned to the maximum required by the target |
2097 | * CPU. |
2098 | * |
2099 | * @see avcodec_default_get_buffer2() |
2100 | * |
2101 | * Video: |
2102 | * |
2103 | * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused |
2104 | * (read and/or written to if it is writable) later by libavcodec. |
2105 | * |
2106 | * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an |
2107 | * edge of the size returned by avcodec_get_edge_width() on all sides. |
2108 | * |
2109 | * avcodec_align_dimensions2() should be used to find the required width and |
2110 | * height, as they normally need to be rounded up to the next multiple of 16. |
2111 | * |
2112 | * If frame multithreading is used and thread_safe_callbacks is set, |
2113 | * this callback may be called from a different thread, but not from more |
2114 | * than one at once. Does not need to be reentrant. |
2115 | * |
2116 | * @see avcodec_align_dimensions2() |
2117 | * |
2118 | * Audio: |
2119 | * |
2120 | * Decoders request a buffer of a particular size by setting |
2121 | * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may, |
2122 | * however, utilize only part of the buffer by setting AVFrame.nb_samples |
2123 | * to a smaller value in the output frame. |
2124 | * |
2125 | * As a convenience, av_samples_get_buffer_size() and |
2126 | * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2() |
2127 | * functions to find the required data size and to fill data pointers and |
2128 | * linesize. In AVFrame.linesize, only linesize[0] may be set for audio |
2129 | * since all planes must be the same size. |
2130 | * |
2131 | * @see av_samples_get_buffer_size(), av_samples_fill_arrays() |
2132 | * |
2133 | * - encoding: unused |
2134 | * - decoding: Set by libavcodec, user can override. |
2135 | */ |
2136 | int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags); |
2137 | |
2138 | /** |
2139 | * If non-zero, the decoded audio and video frames returned from |
2140 | * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted |
2141 | * and are valid indefinitely. The caller must free them with |
2142 | * av_frame_unref() when they are not needed anymore. |
2143 | * Otherwise, the decoded frames must not be freed by the caller and are |
2144 | * only valid until the next decode call. |
2145 | * |
2146 | * - encoding: unused |
2147 | * - decoding: set by the caller before avcodec_open2(). |
2148 | */ |
2149 | int refcounted_frames; |
2150 | |
2151 | /* - encoding parameters */ |
2152 | float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0) |
2153 | float qblur; ///< amount of qscale smoothing over time (0.0-1.0) |
2154 | |
2155 | /** |
2156 | * minimum quantizer |
2157 | * - encoding: Set by user. |
2158 | * - decoding: unused |
2159 | */ |
2160 | int qmin; |
2161 | |
2162 | /** |
2163 | * maximum quantizer |
2164 | * - encoding: Set by user. |
2165 | * - decoding: unused |
2166 | */ |
2167 | int qmax; |
2168 | |
2169 | /** |
2170 | * maximum quantizer difference between frames |
2171 | * - encoding: Set by user. |
2172 | * - decoding: unused |
2173 | */ |
2174 | int max_qdiff; |
2175 | |
2176 | /** |
2177 | * ratecontrol qmin qmax limiting method |
2178 | * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax. |
2179 | * - encoding: Set by user. |
2180 | * - decoding: unused |
2181 | */ |
2182 | float rc_qsquish; |
2183 | |
2184 | float rc_qmod_amp; |
2185 | int rc_qmod_freq; |
2186 | |
2187 | /** |
2188 | * decoder bitstream buffer size |
2189 | * - encoding: Set by user. |
2190 | * - decoding: unused |
2191 | */ |
2192 | int rc_buffer_size; |
2193 | |
2194 | /** |
2195 | * ratecontrol override, see RcOverride |
2196 | * - encoding: Allocated/set/freed by user. |
2197 | * - decoding: unused |
2198 | */ |
2199 | int rc_override_count; |
2200 | RcOverride *rc_override; |
2201 | |
2202 | /** |
2203 | * rate control equation |
2204 | * - encoding: Set by user |
2205 | * - decoding: unused |
2206 | */ |
2207 | const char *rc_eq; |
2208 | |
2209 | /** |
2210 | * maximum bitrate |
2211 | * - encoding: Set by user. |
2212 | * - decoding: unused |
2213 | */ |
2214 | int rc_max_rate; |
2215 | |
2216 | /** |
2217 | * minimum bitrate |
2218 | * - encoding: Set by user. |
2219 | * - decoding: unused |
2220 | */ |
2221 | int rc_min_rate; |
2222 | |
2223 | float rc_buffer_aggressivity; |
2224 | |
2225 | /** |
2226 | * initial complexity for pass1 ratecontrol |
2227 | * - encoding: Set by user. |
2228 | * - decoding: unused |
2229 | */ |
2230 | float rc_initial_cplx; |
2231 | |
2232 | /** |
2233 | * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow. |
2234 | * - encoding: Set by user. |
2235 | * - decoding: unused. |
2236 | */ |
2237 | float rc_max_available_vbv_use; |
2238 | |
2239 | /** |
2240 | * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow. |
2241 | * - encoding: Set by user. |
2242 | * - decoding: unused. |
2243 | */ |
2244 | float rc_min_vbv_overflow_use; |
2245 | |
2246 | /** |
2247 | * Number of bits which should be loaded into the rc buffer before decoding starts. |
2248 | * - encoding: Set by user. |
2249 | * - decoding: unused |
2250 | */ |
2251 | int rc_initial_buffer_occupancy; |
2252 | |
2253 | #define FF_CODER_TYPE_VLC 0 |
2254 | #define FF_CODER_TYPE_AC 1 |
2255 | #define FF_CODER_TYPE_RAW 2 |
2256 | #define FF_CODER_TYPE_RLE 3 |
2257 | #define FF_CODER_TYPE_DEFLATE 4 |
2258 | /** |
2259 | * coder type |
2260 | * - encoding: Set by user. |
2261 | * - decoding: unused |
2262 | */ |
2263 | int coder_type; |
2264 | |
2265 | /** |
2266 | * context model |
2267 | * - encoding: Set by user. |
2268 | * - decoding: unused |
2269 | */ |
2270 | int context_model; |
2271 | |
2272 | /** |
2273 | * minimum Lagrange multipler |
2274 | * - encoding: Set by user. |
2275 | * - decoding: unused |
2276 | */ |
2277 | int lmin; |
2278 | |
2279 | /** |
2280 | * maximum Lagrange multipler |
2281 | * - encoding: Set by user. |
2282 | * - decoding: unused |
2283 | */ |
2284 | int lmax; |
2285 | |
2286 | /** |
2287 | * frame skip threshold |
2288 | * - encoding: Set by user. |
2289 | * - decoding: unused |
2290 | */ |
2291 | int frame_skip_threshold; |
2292 | |
2293 | /** |
2294 | * frame skip factor |
2295 | * - encoding: Set by user. |
2296 | * - decoding: unused |
2297 | */ |
2298 | int frame_skip_factor; |
2299 | |
2300 | /** |
2301 | * frame skip exponent |
2302 | * - encoding: Set by user. |
2303 | * - decoding: unused |
2304 | */ |
2305 | int frame_skip_exp; |
2306 | |
2307 | /** |
2308 | * frame skip comparison function |
2309 | * - encoding: Set by user. |
2310 | * - decoding: unused |
2311 | */ |
2312 | int frame_skip_cmp; |
2313 | |
2314 | /** |
2315 | * trellis RD quantization |
2316 | * - encoding: Set by user. |
2317 | * - decoding: unused |
2318 | */ |
2319 | int trellis; |
2320 | |
2321 | /** |
2322 | * - encoding: Set by user. |
2323 | * - decoding: unused |
2324 | */ |
2325 | int min_prediction_order; |
2326 | |
2327 | /** |
2328 | * - encoding: Set by user. |
2329 | * - decoding: unused |
2330 | */ |
2331 | int max_prediction_order; |
2332 | |
2333 | /** |
2334 | * GOP timecode frame start number |
2335 | * - encoding: Set by user, in non drop frame format |
2336 | * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset) |
2337 | */ |
2338 | int64_t timecode_frame_start; |
2339 | |
2340 | /* The RTP callback: This function is called */ |
2341 | /* every time the encoder has a packet to send. */ |
2342 | /* It depends on the encoder if the data starts */ |
2343 | /* with a Start Code (it should). H.263 does. */ |
2344 | /* mb_nb contains the number of macroblocks */ |
2345 | /* encoded in the RTP payload. */ |
2346 | void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb); |
2347 | |
2348 | int rtp_payload_size; /* The size of the RTP payload: the coder will */ |
2349 | /* do its best to deliver a chunk with size */ |
2350 | /* below rtp_payload_size, the chunk will start */ |
2351 | /* with a start code on some codecs like H.263. */ |
2352 | /* This doesn't take account of any particular */ |
2353 | /* headers inside the transmitted RTP payload. */ |
2354 | |
2355 | /* statistics, used for 2-pass encoding */ |
2356 | int mv_bits; |
2357 | int header_bits; |
2358 | int i_tex_bits; |
2359 | int p_tex_bits; |
2360 | int i_count; |
2361 | int p_count; |
2362 | int skip_count; |
2363 | int misc_bits; |
2364 | |
2365 | /** |
2366 | * number of bits used for the previously encoded frame |
2367 | * - encoding: Set by libavcodec. |
2368 | * - decoding: unused |
2369 | */ |
2370 | int frame_bits; |
2371 | |
2372 | /** |
2373 | * pass1 encoding statistics output buffer |
2374 | * - encoding: Set by libavcodec. |
2375 | * - decoding: unused |
2376 | */ |
2377 | char *stats_out; |
2378 | |
2379 | /** |
2380 | * pass2 encoding statistics input buffer |
2381 | * Concatenated stuff from stats_out of pass1 should be placed here. |
2382 | * - encoding: Allocated/set/freed by user. |
2383 | * - decoding: unused |
2384 | */ |
2385 | char *stats_in; |
2386 | |
2387 | /** |
2388 | * Work around bugs in encoders which sometimes cannot be detected automatically. |
2389 | * - encoding: Set by user |
2390 | * - decoding: Set by user |
2391 | */ |
2392 | int workaround_bugs; |
2393 | #define FF_BUG_AUTODETECT 1 ///< autodetection |
2394 | #define FF_BUG_OLD_MSMPEG4 2 |
2395 | #define FF_BUG_XVID_ILACE 4 |
2396 | #define FF_BUG_UMP4 8 |
2397 | #define FF_BUG_NO_PADDING 16 |
2398 | #define FF_BUG_AMV 32 |
2399 | #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default. |
2400 | #define FF_BUG_QPEL_CHROMA 64 |
2401 | #define FF_BUG_STD_QPEL 128 |
2402 | #define FF_BUG_QPEL_CHROMA2 256 |
2403 | #define FF_BUG_DIRECT_BLOCKSIZE 512 |
2404 | #define FF_BUG_EDGE 1024 |
2405 | #define FF_BUG_HPEL_CHROMA 2048 |
2406 | #define FF_BUG_DC_CLIP 4096 |
2407 | #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders. |
2408 | #define FF_BUG_TRUNCATED 16384 |
2409 | |
2410 | /** |
2411 | * strictly follow the standard (MPEG4, ...). |
2412 | * - encoding: Set by user. |
2413 | * - decoding: Set by user. |
2414 | * Setting this to STRICT or higher means the encoder and decoder will |
2415 | * generally do stupid things, whereas setting it to unofficial or lower |
2416 | * will mean the encoder might produce output that is not supported by all |
2417 | * spec-compliant decoders. Decoders don't differentiate between normal, |
2418 | * unofficial and experimental (that is, they always try to decode things |
2419 | * when they can) unless they are explicitly asked to behave stupidly |
2420 | * (=strictly conform to the specs) |
2421 | */ |
2422 | int strict_std_compliance; |
2423 | #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software. |
2424 | #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences. |
2425 | #define FF_COMPLIANCE_NORMAL 0 |
2426 | #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions |
2427 | #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things. |
2428 | |
2429 | /** |
2430 | * error concealment flags |
2431 | * - encoding: unused |
2432 | * - decoding: Set by user. |
2433 | */ |
2434 | int error_concealment; |
2435 | #define FF_EC_GUESS_MVS 1 |
2436 | #define FF_EC_DEBLOCK 2 |
2437 | |
2438 | /** |
2439 | * debug |
2440 | * - encoding: Set by user. |
2441 | * - decoding: Set by user. |
2442 | */ |
2443 | int debug; |
2444 | #define FF_DEBUG_PICT_INFO 1 |
2445 | #define FF_DEBUG_RC 2 |
2446 | #define FF_DEBUG_BITSTREAM 4 |
2447 | #define FF_DEBUG_MB_TYPE 8 |
2448 | #define FF_DEBUG_QP 16 |
2449 | #define FF_DEBUG_MV 32 |
2450 | #define FF_DEBUG_DCT_COEFF 0x00000040 |
2451 | #define FF_DEBUG_SKIP 0x00000080 |
2452 | #define FF_DEBUG_STARTCODE 0x00000100 |
2453 | #define FF_DEBUG_PTS 0x00000200 |
2454 | #define FF_DEBUG_ER 0x00000400 |
2455 | #define FF_DEBUG_MMCO 0x00000800 |
2456 | #define FF_DEBUG_BUGS 0x00001000 |
2457 | #define FF_DEBUG_VIS_QP 0x00002000 |
2458 | #define FF_DEBUG_VIS_MB_TYPE 0x00004000 |
2459 | #define FF_DEBUG_BUFFERS 0x00008000 |
2460 | #define FF_DEBUG_THREADS 0x00010000 |
2461 | |
2462 | /** |
2463 | * debug |
2464 | * - encoding: Set by user. |
2465 | * - decoding: Set by user. |
2466 | */ |
2467 | int debug_mv; |
2468 | #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames |
2469 | #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames |
2470 | #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames |
2471 | |
2472 | /** |
2473 | * Error recognition; may misdetect some more or less valid parts as errors. |
2474 | * - encoding: unused |
2475 | * - decoding: Set by user. |
2476 | */ |
2477 | int err_recognition; |
2478 | |
2479 | /** |
2480 | * Verify checksums embedded in the bitstream (could be of either encoded or |
2481 | * decoded data, depending on the codec) and print an error message on mismatch. |
2482 | * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the |
2483 | * decoder returning an error. |
2484 | */ |
2485 | #define AV_EF_CRCCHECK (1<<0) |
2486 | #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations |
2487 | #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length |
2488 | #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection |
2489 | |
2490 | #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors |
2491 | #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors |
2492 | #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error |
2493 | |
2494 | |
2495 | /** |
2496 | * opaque 64bit number (generally a PTS) that will be reordered and |
2497 | * output in AVFrame.reordered_opaque |
2498 | * @deprecated in favor of pkt_pts |
2499 | * - encoding: unused |
2500 | * - decoding: Set by user. |
2501 | */ |
2502 | int64_t reordered_opaque; |
2503 | |
2504 | /** |
2505 | * Hardware accelerator in use |
2506 | * - encoding: unused. |
2507 | * - decoding: Set by libavcodec |
2508 | */ |
2509 | struct AVHWAccel *hwaccel; |
2510 | |
2511 | /** |
2512 | * Hardware accelerator context. |
2513 | * For some hardware accelerators, a global context needs to be |
2514 | * provided by the user. In that case, this holds display-dependent |
2515 | * data FFmpeg cannot instantiate itself. Please refer to the |
2516 | * FFmpeg HW accelerator documentation to know how to fill this |
2517 | * is. e.g. for VA API, this is a struct vaapi_context. |
2518 | * - encoding: unused |
2519 | * - decoding: Set by user |
2520 | */ |
2521 | void *hwaccel_context; |
2522 | |
2523 | /** |
2524 | * error |
2525 | * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR. |
2526 | * - decoding: unused |
2527 | */ |
2528 | uint64_t error[AV_NUM_DATA_POINTERS]; |
2529 | |
2530 | /** |
2531 | * DCT algorithm, see FF_DCT_* below |
2532 | * - encoding: Set by user. |
2533 | * - decoding: unused |
2534 | */ |
2535 | int dct_algo; |
2536 | #define FF_DCT_AUTO 0 |
2537 | #define FF_DCT_FASTINT 1 |
2538 | #define FF_DCT_INT 2 |
2539 | #define FF_DCT_MMX 3 |
2540 | #define FF_DCT_ALTIVEC 5 |
2541 | #define FF_DCT_FAAN 6 |
2542 | |
2543 | /** |
2544 | * IDCT algorithm, see FF_IDCT_* below. |
2545 | * - encoding: Set by user. |
2546 | * - decoding: Set by user. |
2547 | */ |
2548 | int idct_algo; |
2549 | #define FF_IDCT_AUTO 0 |
2550 | #define FF_IDCT_INT 1 |
2551 | #define FF_IDCT_SIMPLE 2 |
2552 | #define FF_IDCT_SIMPLEMMX 3 |
2553 | #define FF_IDCT_ARM 7 |
2554 | #define FF_IDCT_ALTIVEC 8 |
2555 | #define FF_IDCT_SH4 9 |
2556 | #define FF_IDCT_SIMPLEARM 10 |
2557 | #define FF_IDCT_IPP 13 |
2558 | #define FF_IDCT_XVIDMMX 14 |
2559 | #define FF_IDCT_SIMPLEARMV5TE 16 |
2560 | #define FF_IDCT_SIMPLEARMV6 17 |
2561 | #define FF_IDCT_SIMPLEVIS 18 |
2562 | #define FF_IDCT_FAAN 20 |
2563 | #define FF_IDCT_SIMPLENEON 22 |
2564 | #define FF_IDCT_SIMPLEALPHA 23 |
2565 | |
2566 | /** |
2567 | * bits per sample/pixel from the demuxer (needed for huffyuv). |
2568 | * - encoding: Set by libavcodec. |
2569 | * - decoding: Set by user. |
2570 | */ |
2571 | int bits_per_coded_sample; |
2572 | |
2573 | /** |
2574 | * Bits per sample/pixel of internal libavcodec pixel/sample format. |
2575 | * - encoding: set by user. |
2576 | * - decoding: set by libavcodec. |
2577 | */ |
2578 | int bits_per_raw_sample; |
2579 | |
2580 | #if FF_API_LOWRES |
2581 | /** |
2582 | * low resolution decoding, 1-> 1/2 size, 2->1/4 size |
2583 | * - encoding: unused |
2584 | * - decoding: Set by user. |
2585 | * Code outside libavcodec should access this field using: |
2586 | * av_codec_{get,set}_lowres(avctx) |
2587 | */ |
2588 | int lowres; |
2589 | #endif |
2590 | |
2591 | /** |
2592 | * the picture in the bitstream |
2593 | * - encoding: Set by libavcodec. |
2594 | * - decoding: Set by libavcodec. |
2595 | */ |
2596 | AVFrame *coded_frame; |
2597 | |
2598 | /** |
2599 | * thread count |
2600 | * is used to decide how many independent tasks should be passed to execute() |
2601 | * - encoding: Set by user. |
2602 | * - decoding: Set by user. |
2603 | */ |
2604 | int thread_count; |
2605 | |
2606 | /** |
2607 | * Which multithreading methods to use. |
2608 | * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread, |
2609 | * so clients which cannot provide future frames should not use it. |
2610 | * |
2611 | * - encoding: Set by user, otherwise the default is used. |
2612 | * - decoding: Set by user, otherwise the default is used. |
2613 | */ |
2614 | int thread_type; |
2615 | #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once |
2616 | #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once |
2617 | |
2618 | /** |
2619 | * Which multithreading methods are in use by the codec. |
2620 | * - encoding: Set by libavcodec. |
2621 | * - decoding: Set by libavcodec. |
2622 | */ |
2623 | int active_thread_type; |
2624 | |
2625 | /** |
2626 | * Set by the client if its custom get_buffer() callback can be called |
2627 | * synchronously from another thread, which allows faster multithreaded decoding. |
2628 | * draw_horiz_band() will be called from other threads regardless of this setting. |
2629 | * Ignored if the default get_buffer() is used. |
2630 | * - encoding: Set by user. |
2631 | * - decoding: Set by user. |
2632 | */ |
2633 | int thread_safe_callbacks; |
2634 | |
2635 | /** |
2636 | * The codec may call this to execute several independent things. |
2637 | * It will return only after finishing all tasks. |
2638 | * The user may replace this with some multithreaded implementation, |
2639 | * the default implementation will execute the parts serially. |
2640 | * @param count the number of things to execute |
2641 | * - encoding: Set by libavcodec, user can override. |
2642 | * - decoding: Set by libavcodec, user can override. |
2643 | */ |
2644 | int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size); |
2645 | |
2646 | /** |
2647 | * The codec may call this to execute several independent things. |
2648 | * It will return only after finishing all tasks. |
2649 | * The user may replace this with some multithreaded implementation, |
2650 | * the default implementation will execute the parts serially. |
2651 | * Also see avcodec_thread_init and e.g. the --enable-pthread configure option. |
2652 | * @param c context passed also to func |
2653 | * @param count the number of things to execute |
2654 | * @param arg2 argument passed unchanged to func |
2655 | * @param ret return values of executed functions, must have space for "count" values. May be NULL. |
2656 | * @param func function that will be called count times, with jobnr from 0 to count-1. |
2657 | * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no |
2658 | * two instances of func executing at the same time will have the same threadnr. |
2659 | * @return always 0 currently, but code should handle a future improvement where when any call to func |
2660 | * returns < 0 no further calls to func may be done and < 0 is returned. |
2661 | * - encoding: Set by libavcodec, user can override. |
2662 | * - decoding: Set by libavcodec, user can override. |
2663 | */ |
2664 | int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count); |
2665 | |
2666 | /** |
2667 | * thread opaque |
2668 | * Can be used by execute() to store some per AVCodecContext stuff. |
2669 | * - encoding: set by execute() |
2670 | * - decoding: set by execute() |
2671 | */ |
2672 | void *thread_opaque; |
2673 | |
2674 | /** |
2675 | * noise vs. sse weight for the nsse comparsion function |
2676 | * - encoding: Set by user. |
2677 | * - decoding: unused |
2678 | */ |
2679 | int nsse_weight; |
2680 | |
2681 | /** |
2682 | * profile |
2683 | * - encoding: Set by user. |
2684 | * - decoding: Set by libavcodec. |
2685 | */ |
2686 | int profile; |
2687 | #define FF_PROFILE_UNKNOWN -99 |
2688 | #define FF_PROFILE_RESERVED -100 |
2689 | |
2690 | #define FF_PROFILE_AAC_MAIN 0 |
2691 | #define FF_PROFILE_AAC_LOW 1 |
2692 | #define FF_PROFILE_AAC_SSR 2 |
2693 | #define FF_PROFILE_AAC_LTP 3 |
2694 | #define FF_PROFILE_AAC_HE 4 |
2695 | #define FF_PROFILE_AAC_HE_V2 28 |
2696 | #define FF_PROFILE_AAC_LD 22 |
2697 | #define FF_PROFILE_AAC_ELD 38 |
2698 | #define FF_PROFILE_MPEG2_AAC_LOW 128 |
2699 | #define FF_PROFILE_MPEG2_AAC_HE 131 |
2700 | |
2701 | #define FF_PROFILE_DTS 20 |
2702 | #define FF_PROFILE_DTS_ES 30 |
2703 | #define FF_PROFILE_DTS_96_24 40 |
2704 | #define FF_PROFILE_DTS_HD_HRA 50 |
2705 | #define FF_PROFILE_DTS_HD_MA 60 |
2706 | |
2707 | #define FF_PROFILE_MPEG2_422 0 |
2708 | #define FF_PROFILE_MPEG2_HIGH 1 |
2709 | #define FF_PROFILE_MPEG2_SS 2 |
2710 | #define FF_PROFILE_MPEG2_SNR_SCALABLE 3 |
2711 | #define FF_PROFILE_MPEG2_MAIN 4 |
2712 | #define FF_PROFILE_MPEG2_SIMPLE 5 |
2713 | |
2714 | #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag |
2715 | #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag |
2716 | |
2717 | #define FF_PROFILE_H264_BASELINE 66 |
2718 | #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED) |
2719 | #define FF_PROFILE_H264_MAIN 77 |
2720 | #define FF_PROFILE_H264_EXTENDED 88 |
2721 | #define FF_PROFILE_H264_HIGH 100 |
2722 | #define FF_PROFILE_H264_HIGH_10 110 |
2723 | #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA) |
2724 | #define FF_PROFILE_H264_HIGH_422 122 |
2725 | #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA) |
2726 | #define FF_PROFILE_H264_HIGH_444 144 |
2727 | #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244 |
2728 | #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA) |
2729 | #define FF_PROFILE_H264_CAVLC_444 44 |
2730 | |
2731 | #define FF_PROFILE_VC1_SIMPLE 0 |
2732 | #define FF_PROFILE_VC1_MAIN 1 |
2733 | #define FF_PROFILE_VC1_COMPLEX 2 |
2734 | #define FF_PROFILE_VC1_ADVANCED 3 |
2735 | |
2736 | #define FF_PROFILE_MPEG4_SIMPLE 0 |
2737 | #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1 |
2738 | #define FF_PROFILE_MPEG4_CORE 2 |
2739 | #define FF_PROFILE_MPEG4_MAIN 3 |
2740 | #define FF_PROFILE_MPEG4_N_BIT 4 |
2741 | #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5 |
2742 | #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6 |
2743 | #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7 |
2744 | #define FF_PROFILE_MPEG4_HYBRID 8 |
2745 | #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9 |
2746 | #define FF_PROFILE_MPEG4_CORE_SCALABLE 10 |
2747 | #define FF_PROFILE_MPEG4_ADVANCED_CODING 11 |
2748 | #define FF_PROFILE_MPEG4_ADVANCED_CORE 12 |
2749 | #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13 |
2750 | #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14 |
2751 | #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15 |
2752 | |
2753 | #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0 |
2754 | #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1 |
2755 | #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2 |
2756 | #define FF_PROFILE_JPEG2000_DCINEMA_2K 3 |
2757 | #define FF_PROFILE_JPEG2000_DCINEMA_4K 4 |
2758 | |
2759 | /** |
2760 | * level |
2761 | * - encoding: Set by user. |
2762 | * - decoding: Set by libavcodec. |
2763 | */ |
2764 | int level; |
2765 | #define FF_LEVEL_UNKNOWN -99 |
2766 | |
2767 | /** |
2768 | * Skip loop filtering for selected frames. |
2769 | * - encoding: unused |
2770 | * - decoding: Set by user. |
2771 | */ |
2772 | enum AVDiscard skip_loop_filter; |
2773 | |
2774 | /** |
2775 | * Skip IDCT/dequantization for selected frames. |
2776 | * - encoding: unused |
2777 | * - decoding: Set by user. |
2778 | */ |
2779 | enum AVDiscard skip_idct; |
2780 | |
2781 | /** |
2782 | * Skip decoding for selected frames. |
2783 | * - encoding: unused |
2784 | * - decoding: Set by user. |
2785 | */ |
2786 | enum AVDiscard skip_frame; |
2787 | |
2788 | /** |
2789 | * Header containing style information for text subtitles. |
2790 | * For SUBTITLE_ASS subtitle type, it should contain the whole ASS |
2791 | * [Script Info] and [V4+ Styles] section, plus the [Events] line and |
2792 | * the Format line following. It shouldn't include any Dialogue line. |
2793 | * - encoding: Set/allocated/freed by user (before avcodec_open2()) |
2794 | * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2()) |
2795 | */ |
2796 | uint8_t *subtitle_header; |
2797 | int subtitle_header_size; |
2798 | |
2799 | /** |
2800 | * Simulates errors in the bitstream to test error concealment. |
2801 | * - encoding: Set by user. |
2802 | * - decoding: unused |
2803 | */ |
2804 | int error_rate; |
2805 | |
2806 | /** |
2807 | * Current packet as passed into the decoder, to avoid having |
2808 | * to pass the packet into every function. Currently only valid |
2809 | * inside lavc and get/release_buffer callbacks. |
2810 | * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts |
2811 | * - encoding: unused |
2812 | */ |
2813 | AVPacket *pkt; |
2814 | |
2815 | /** |
2816 | * VBV delay coded in the last frame (in periods of a 27 MHz clock). |
2817 | * Used for compliant TS muxing. |
2818 | * - encoding: Set by libavcodec. |
2819 | * - decoding: unused. |
2820 | */ |
2821 | uint64_t vbv_delay; |
2822 | |
2823 | /** |
2824 | * Timebase in which pkt_dts/pts and AVPacket.dts/pts are. |
2825 | * Code outside libavcodec should access this field using: |
2826 | * av_codec_{get,set}_pkt_timebase(avctx) |
2827 | * - encoding unused. |
2828 | * - decoding set by user. |
2829 | */ |
2830 | AVRational pkt_timebase; |
2831 | |
2832 | /** |
2833 | * AVCodecDescriptor |
2834 | * Code outside libavcodec should access this field using: |
2835 | * av_codec_{get,set}_codec_descriptor(avctx) |
2836 | * - encoding: unused. |
2837 | * - decoding: set by libavcodec. |
2838 | */ |
2839 | const AVCodecDescriptor *codec_descriptor; |
2840 | |
2841 | #if !FF_API_LOWRES |
2842 | /** |
2843 | * low resolution decoding, 1-> 1/2 size, 2->1/4 size |
2844 | * - encoding: unused |
2845 | * - decoding: Set by user. |
2846 | * Code outside libavcodec should access this field using: |
2847 | * av_codec_{get,set}_lowres(avctx) |
2848 | */ |
2849 | int lowres; |
2850 | #endif |
2851 | |
2852 | /** |
2853 | * Current statistics for PTS correction. |
2854 | * - decoding: maintained and used by libavcodec, not intended to be used by user apps |
2855 | * - encoding: unused |
2856 | */ |
2857 | int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far |
2858 | int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far |
2859 | int64_t pts_correction_last_pts; /// PTS of the last frame |
2860 | int64_t pts_correction_last_dts; /// DTS of the last frame |
2861 | |
2862 | /** |
2863 | * Character encoding of the input subtitles file. |
2864 | * - decoding: set by user |
2865 | * - encoding: unused |
2866 | */ |
2867 | char *sub_charenc; |
2868 | |
2869 | /** |
2870 | * Subtitles character encoding mode. Formats or codecs might be adjusting |
2871 | * this setting (if they are doing the conversion themselves for instance). |
2872 | * - decoding: set by libavcodec |
2873 | * - encoding: unused |
2874 | */ |
2875 | int sub_charenc_mode; |
2876 | #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance) |
2877 | #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself |
2878 | #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv |
2879 | |
2880 | /** |
2881 | * Skip processing alpha if supported by codec. |
2882 | * Note that if the format uses pre-multiplied alpha (common with VP6, |
2883 | * and recommended due to better video quality/compression) |
2884 | * the image will look as if alpha-blended onto a black background. |
2885 | * However for formats that do not use pre-multiplied alpha |
2886 | * there might be serious artefacts (though e.g. libswscale currently |
2887 | * assumes pre-multiplied alpha anyway). |
2888 | * Code outside libavcodec should access this field using AVOptions |
2889 | * |
2890 | * - decoding: set by user |
2891 | * - encoding: unused |
2892 | */ |
2893 | int skip_alpha; |
2894 | |
2895 | /** |
2896 | * Number of samples to skip after a discontinuity |
2897 | * - decoding: unused |
2898 | * - encoding: set by libavcodec |
2899 | */ |
2900 | int seek_preroll; |
2901 | } AVCodecContext; |
2902 | |
2903 | AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx); |
2904 | void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val); |
2905 | |
2906 | const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx); |
2907 | void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc); |
2908 | |
2909 | int av_codec_get_lowres(const AVCodecContext *avctx); |
2910 | void av_codec_set_lowres(AVCodecContext *avctx, int val); |
2911 | |
2912 | int av_codec_get_seek_preroll(const AVCodecContext *avctx); |
2913 | void av_codec_set_seek_preroll(AVCodecContext *avctx, int val); |
2914 | |
2915 | /** |
2916 | * AVProfile. |
2917 | */ |
2918 | typedef struct AVProfile { |
2919 | int profile; |
2920 | const char *name; ///< short name for the profile |
2921 | } AVProfile; |
2922 | |
2923 | typedef struct AVCodecDefault AVCodecDefault; |
2924 | |
2925 | struct AVSubtitle; |
2926 | |
2927 | /** |
2928 | * AVCodec. |
2929 | */ |
2930 | typedef struct AVCodec { |
2931 | /** |
2932 | * Name of the codec implementation. |
2933 | * The name is globally unique among encoders and among decoders (but an |
2934 | * encoder and a decoder can share the same name). |
2935 | * This is the primary way to find a codec from the user perspective. |
2936 | */ |
2937 | const char *name; |
2938 | /** |
2939 | * Descriptive name for the codec, meant to be more human readable than name. |
2940 | * You should use the NULL_IF_CONFIG_SMALL() macro to define it. |
2941 | */ |
2942 | const char *long_name; |
2943 | enum AVMediaType type; |
2944 | enum AVCodecID id; |
2945 | /** |
2946 | * Codec capabilities. |
2947 | * see CODEC_CAP_* |
2948 | */ |
2949 | int capabilities; |
2950 | const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0} |
2951 | const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1 |
2952 | const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0 |
2953 | const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1 |
2954 | const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0 |
2955 | #if FF_API_LOWRES |
2956 | uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres() |
2957 | #endif |
2958 | const AVClass *priv_class; ///< AVClass for the private context |
2959 | const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN} |
2960 | |
2961 | /***************************************************************** |
2962 | * No fields below this line are part of the public API. They |
2963 | * may not be used outside of libavcodec and can be changed and |
2964 | * removed at will. |
2965 | * New public fields should be added right above. |
2966 | ***************************************************************** |
2967 | */ |
2968 | int priv_data_size; |
2969 | struct AVCodec *next; |
2970 | /** |
2971 | * @name Frame-level threading support functions |
2972 | * @{ |
2973 | */ |
2974 | /** |
2975 | * If defined, called on thread contexts when they are created. |
2976 | * If the codec allocates writable tables in init(), re-allocate them here. |
2977 | * priv_data will be set to a copy of the original. |
2978 | */ |
2979 | int (*init_thread_copy)(AVCodecContext *); |
2980 | /** |
2981 | * Copy necessary context variables from a previous thread context to the current one. |
2982 | * If not defined, the next thread will start automatically; otherwise, the codec |
2983 | * must call ff_thread_finish_setup(). |
2984 | * |
2985 | * dst and src will (rarely) point to the same context, in which case memcpy should be skipped. |
2986 | */ |
2987 | int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src); |
2988 | /** @} */ |
2989 | |
2990 | /** |
2991 | * Private codec-specific defaults. |
2992 | */ |
2993 | const AVCodecDefault *defaults; |
2994 | |
2995 | /** |
2996 | * Initialize codec static data, called from avcodec_register(). |
2997 | */ |
2998 | void (*init_static_data)(struct AVCodec *codec); |
2999 | |
3000 | int (*init)(AVCodecContext *); |
3001 | int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size, |
3002 | const struct AVSubtitle *sub); |
3003 | /** |
3004 | * Encode data to an AVPacket. |
3005 | * |
3006 | * @param avctx codec context |
3007 | * @param avpkt output AVPacket (may contain a user-provided buffer) |
3008 | * @param[in] frame AVFrame containing the raw data to be encoded |
3009 | * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a |
3010 | * non-empty packet was returned in avpkt. |
3011 | * @return 0 on success, negative error code on failure |
3012 | */ |
3013 | int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, |
3014 | int *got_packet_ptr); |
3015 | int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt); |
3016 | int (*close)(AVCodecContext *); |
3017 | /** |
3018 | * Flush buffers. |
3019 | * Will be called when seeking |
3020 | */ |
3021 | void (*flush)(AVCodecContext *); |
3022 | } AVCodec; |
3023 | |
3024 | int av_codec_get_max_lowres(const AVCodec *codec); |
3025 | |
3026 | /** |
3027 | * AVHWAccel. |
3028 | */ |
3029 | typedef struct AVHWAccel { |
3030 | /** |
3031 | * Name of the hardware accelerated codec. |
3032 | * The name is globally unique among encoders and among decoders (but an |
3033 | * encoder and a decoder can share the same name). |
3034 | */ |
3035 | const char *name; |
3036 | |
3037 | /** |
3038 | * Type of codec implemented by the hardware accelerator. |
3039 | * |
3040 | * See AVMEDIA_TYPE_xxx |
3041 | */ |
3042 | enum AVMediaType type; |
3043 | |
3044 | /** |
3045 | * Codec implemented by the hardware accelerator. |
3046 | * |
3047 | * See AV_CODEC_ID_xxx |
3048 | */ |
3049 | enum AVCodecID id; |
3050 | |
3051 | /** |
3052 | * Supported pixel format. |
3053 | * |
3054 | * Only hardware accelerated formats are supported here. |
3055 | */ |
3056 | enum AVPixelFormat pix_fmt; |
3057 | |
3058 | /** |
3059 | * Hardware accelerated codec capabilities. |
3060 | * see FF_HWACCEL_CODEC_CAP_* |
3061 | */ |
3062 | int capabilities; |
3063 | |
3064 | struct AVHWAccel *next; |
3065 | |
3066 | /** |
3067 | * Called at the beginning of each frame or field picture. |
3068 | * |
3069 | * Meaningful frame information (codec specific) is guaranteed to |
3070 | * be parsed at this point. This function is mandatory. |
3071 | * |
3072 | * Note that buf can be NULL along with buf_size set to 0. |
3073 | * Otherwise, this means the whole frame is available at this point. |
3074 | * |
3075 | * @param avctx the codec context |
3076 | * @param buf the frame data buffer base |
3077 | * @param buf_size the size of the frame in bytes |
3078 | * @return zero if successful, a negative value otherwise |
3079 | */ |
3080 | int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); |
3081 | |
3082 | /** |
3083 | * Callback for each slice. |
3084 | * |
3085 | * Meaningful slice information (codec specific) is guaranteed to |
3086 | * be parsed at this point. This function is mandatory. |
3087 | * |
3088 | * @param avctx the codec context |
3089 | * @param buf the slice data buffer base |
3090 | * @param buf_size the size of the slice in bytes |
3091 | * @return zero if successful, a negative value otherwise |
3092 | */ |
3093 | int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size); |
3094 | |
3095 | /** |
3096 | * Called at the end of each frame or field picture. |
3097 | * |
3098 | * The whole picture is parsed at this point and can now be sent |
3099 | * to the hardware accelerator. This function is mandatory. |
3100 | * |
3101 | * @param avctx the codec context |
3102 | * @return zero if successful, a negative value otherwise |
3103 | */ |
3104 | int (*end_frame)(AVCodecContext *avctx); |
3105 | |
3106 | /** |
3107 | * Size of HW accelerator private data. |
3108 | * |
3109 | * Private data is allocated with av_mallocz() before |
3110 | * AVCodecContext.get_buffer() and deallocated after |
3111 | * AVCodecContext.release_buffer(). |
3112 | */ |
3113 | int priv_data_size; |
3114 | } AVHWAccel; |
3115 | |
3116 | /** |
3117 | * @defgroup lavc_picture AVPicture |
3118 | * |
3119 | * Functions for working with AVPicture |
3120 | * @{ |
3121 | */ |
3122 | |
3123 | /** |
3124 | * Picture data structure. |
3125 | * |
3126 | * Up to four components can be stored into it, the last component is |
3127 | * alpha. |
3128 | */ |
3129 | typedef struct AVPicture { |
3130 | uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes |
3131 | int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line |
3132 | } AVPicture; |
3133 | |
3134 | /** |
3135 | * @} |
3136 | */ |
3137 | |
3138 | enum AVSubtitleType { |
3139 | SUBTITLE_NONE, |
3140 | |
3141 | SUBTITLE_BITMAP, ///< A bitmap, pict will be set |
3142 | |
3143 | /** |
3144 | * Plain text, the text field must be set by the decoder and is |
3145 | * authoritative. ass and pict fields may contain approximations. |
3146 | */ |
3147 | SUBTITLE_TEXT, |
3148 | |
3149 | /** |
3150 | * Formatted text, the ass field must be set by the decoder and is |
3151 | * authoritative. pict and text fields may contain approximations. |
3152 | */ |
3153 | SUBTITLE_ASS, |
3154 | }; |
3155 | |
3156 | #define AV_SUBTITLE_FLAG_FORCED 0x00000001 |
3157 | |
3158 | typedef struct AVSubtitleRect { |
3159 | int x; ///< top left corner of pict, undefined when pict is not set |
3160 | int y; ///< top left corner of pict, undefined when pict is not set |
3161 | int w; ///< width of pict, undefined when pict is not set |
3162 | int h; ///< height of pict, undefined when pict is not set |
3163 | int nb_colors; ///< number of colors in pict, undefined when pict is not set |
3164 | |
3165 | /** |
3166 | * data+linesize for the bitmap of this subtitle. |
3167 | * can be set for text/ass as well once they where rendered |
3168 | */ |
3169 | AVPicture pict; |
3170 | enum AVSubtitleType type; |
3171 | |
3172 | char *text; ///< 0 terminated plain UTF-8 text |
3173 | |
3174 | /** |
3175 | * 0 terminated ASS/SSA compatible event line. |
3176 | * The presentation of this is unaffected by the other values in this |
3177 | * struct. |
3178 | */ |
3179 | char *ass; |
3180 | |
3181 | int flags; |
3182 | } AVSubtitleRect; |
3183 | |
3184 | typedef struct AVSubtitle { |
3185 | uint16_t format; /* 0 = graphics */ |
3186 | uint32_t start_display_time; /* relative to packet pts, in ms */ |
3187 | uint32_t end_display_time; /* relative to packet pts, in ms */ |
3188 | unsigned num_rects; |
3189 | AVSubtitleRect **rects; |
3190 | int64_t pts; ///< Same as packet pts, in AV_TIME_BASE |
3191 | } AVSubtitle; |
3192 | |
3193 | /** |
3194 | * If c is NULL, returns the first registered codec, |
3195 | * if c is non-NULL, returns the next registered codec after c, |
3196 | * or NULL if c is the last one. |
3197 | */ |
3198 | AVCodec *av_codec_next(const AVCodec *c); |
3199 | |
3200 | /** |
3201 | * Return the LIBAVCODEC_VERSION_INT constant. |
3202 | */ |
3203 | unsigned avcodec_version(void); |
3204 | |
3205 | /** |
3206 | * Return the libavcodec build-time configuration. |
3207 | */ |
3208 | const char *avcodec_configuration(void); |
3209 | |
3210 | /** |
3211 | * Return the libavcodec license. |
3212 | */ |
3213 | const char *avcodec_license(void); |
3214 | |
3215 | /** |
3216 | * Register the codec codec and initialize libavcodec. |
3217 | * |
3218 | * @warning either this function or avcodec_register_all() must be called |
3219 | * before any other libavcodec functions. |
3220 | * |
3221 | * @see avcodec_register_all() |
3222 | */ |
3223 | void avcodec_register(AVCodec *codec); |
3224 | |
3225 | /** |
3226 | * Register all the codecs, parsers and bitstream filters which were enabled at |
3227 | * configuration time. If you do not call this function you can select exactly |
3228 | * which formats you want to support, by using the individual registration |
3229 | * functions. |
3230 | * |
3231 | * @see avcodec_register |
3232 | * @see av_register_codec_parser |
3233 | * @see av_register_bitstream_filter |
3234 | */ |
3235 | void avcodec_register_all(void); |
3236 | |
3237 | |
3238 | #if FF_API_ALLOC_CONTEXT |
3239 | /** |
3240 | * Allocate an AVCodecContext and set its fields to default values. The |
3241 | * resulting struct can be deallocated by simply calling av_free(). |
3242 | * |
3243 | * @return An AVCodecContext filled with default values or NULL on failure. |
3244 | * @see avcodec_get_context_defaults |
3245 | * |
3246 | * @deprecated use avcodec_alloc_context3() |
3247 | */ |
3248 | attribute_deprecated |
3249 | AVCodecContext *avcodec_alloc_context(void); |
3250 | |
3251 | /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API! |
3252 | * we WILL change its arguments and name a few times! */ |
3253 | attribute_deprecated |
3254 | AVCodecContext *avcodec_alloc_context2(enum AVMediaType); |
3255 | |
3256 | /** |
3257 | * Set the fields of the given AVCodecContext to default values. |
3258 | * |
3259 | * @param s The AVCodecContext of which the fields should be set to default values. |
3260 | * @deprecated use avcodec_get_context_defaults3 |
3261 | */ |
3262 | attribute_deprecated |
3263 | void avcodec_get_context_defaults(AVCodecContext *s); |
3264 | |
3265 | /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API! |
3266 | * we WILL change its arguments and name a few times! */ |
3267 | attribute_deprecated |
3268 | void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType); |
3269 | #endif |
3270 | |
3271 | /** |
3272 | * Allocate an AVCodecContext and set its fields to default values. The |
3273 | * resulting struct can be deallocated by calling avcodec_close() on it followed |
3274 | * by av_free(). |
3275 | * |
3276 | * @param codec if non-NULL, allocate private data and initialize defaults |
3277 | * for the given codec. It is illegal to then call avcodec_open2() |
3278 | * with a different codec. |
3279 | * If NULL, then the codec-specific defaults won't be initialized, |
3280 | * which may result in suboptimal default settings (this is |
3281 | * important mainly for encoders, e.g. libx264). |
3282 | * |
3283 | * @return An AVCodecContext filled with default values or NULL on failure. |
3284 | * @see avcodec_get_context_defaults |
3285 | */ |
3286 | AVCodecContext *avcodec_alloc_context3(const AVCodec *codec); |
3287 | |
3288 | /** |
3289 | * Set the fields of the given AVCodecContext to default values corresponding |
3290 | * to the given codec (defaults may be codec-dependent). |
3291 | * |
3292 | * Do not call this function if a non-NULL codec has been passed |
3293 | * to avcodec_alloc_context3() that allocated this AVCodecContext. |
3294 | * If codec is non-NULL, it is illegal to call avcodec_open2() with a |
3295 | * different codec on this AVCodecContext. |
3296 | */ |
3297 | int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec); |
3298 | |
3299 | /** |
3300 | * Get the AVClass for AVCodecContext. It can be used in combination with |
3301 | * AV_OPT_SEARCH_FAKE_OBJ for examining options. |
3302 | * |
3303 | * @see av_opt_find(). |
3304 | */ |
3305 | const AVClass *avcodec_get_class(void); |
3306 | |
3307 | /** |
3308 | * Get the AVClass for AVFrame. It can be used in combination with |
3309 | * AV_OPT_SEARCH_FAKE_OBJ for examining options. |
3310 | * |
3311 | * @see av_opt_find(). |
3312 | */ |
3313 | const AVClass *avcodec_get_frame_class(void); |
3314 | |
3315 | /** |
3316 | * Get the AVClass for AVSubtitleRect. It can be used in combination with |
3317 | * AV_OPT_SEARCH_FAKE_OBJ for examining options. |
3318 | * |
3319 | * @see av_opt_find(). |
3320 | */ |
3321 | const AVClass *avcodec_get_subtitle_rect_class(void); |
3322 | |
3323 | /** |
3324 | * Copy the settings of the source AVCodecContext into the destination |
3325 | * AVCodecContext. The resulting destination codec context will be |
3326 | * unopened, i.e. you are required to call avcodec_open2() before you |
3327 | * can use this AVCodecContext to decode/encode video/audio data. |
3328 | * |
3329 | * @param dest target codec context, should be initialized with |
3330 | * avcodec_alloc_context3(NULL), but otherwise uninitialized |
3331 | * @param src source codec context |
3332 | * @return AVERROR() on error (e.g. memory allocation error), 0 on success |
3333 | */ |
3334 | int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src); |
3335 | |
3336 | /** |
3337 | * Allocate an AVFrame and set its fields to default values. The resulting |
3338 | * struct must be freed using avcodec_free_frame(). |
3339 | * |
3340 | * @return An AVFrame filled with default values or NULL on failure. |
3341 | * @see avcodec_get_frame_defaults |
3342 | */ |
3343 | AVFrame *avcodec_alloc_frame(void); |
3344 | |
3345 | /** |
3346 | * Set the fields of the given AVFrame to default values. |
3347 | * |
3348 | * @param frame The AVFrame of which the fields should be set to default values. |
3349 | */ |
3350 | void avcodec_get_frame_defaults(AVFrame *frame); |
3351 | |
3352 | /** |
3353 | * Free the frame and any dynamically allocated objects in it, |
3354 | * e.g. extended_data. |
3355 | * |
3356 | * @param frame frame to be freed. The pointer will be set to NULL. |
3357 | * |
3358 | * @warning this function does NOT free the data buffers themselves |
3359 | * (it does not know how, since they might have been allocated with |
3360 | * a custom get_buffer()). |
3361 | */ |
3362 | void avcodec_free_frame(AVFrame **frame); |
3363 | |
3364 | #if FF_API_AVCODEC_OPEN |
3365 | /** |
3366 | * Initialize the AVCodecContext to use the given AVCodec. Prior to using this |
3367 | * function the context has to be allocated. |
3368 | * |
3369 | * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), |
3370 | * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for |
3371 | * retrieving a codec. |
3372 | * |
3373 | * @warning This function is not thread safe! |
3374 | * |
3375 | * @code |
3376 | * avcodec_register_all(); |
3377 | * codec = avcodec_find_decoder(AV_CODEC_ID_H264); |
3378 | * if (!codec) |
3379 | * exit(1); |
3380 | * |
3381 | * context = avcodec_alloc_context3(codec); |
3382 | * |
3383 | * if (avcodec_open(context, codec) < 0) |
3384 | * exit(1); |
3385 | * @endcode |
3386 | * |
3387 | * @param avctx The context which will be set up to use the given codec. |
3388 | * @param codec The codec to use within the context. |
3389 | * @return zero on success, a negative value on error |
3390 | * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close |
3391 | * |
3392 | * @deprecated use avcodec_open2 |
3393 | */ |
3394 | attribute_deprecated |
3395 | int avcodec_open(AVCodecContext *avctx, AVCodec *codec); |
3396 | #endif |
3397 | |
3398 | /** |
3399 | * Initialize the AVCodecContext to use the given AVCodec. Prior to using this |
3400 | * function the context has to be allocated with avcodec_alloc_context3(). |
3401 | * |
3402 | * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(), |
3403 | * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for |
3404 | * retrieving a codec. |
3405 | * |
3406 | * @warning This function is not thread safe! |
3407 | * |
3408 | * @code |
3409 | * avcodec_register_all(); |
3410 | * av_dict_set(&opts, "b", "2.5M", 0); |
3411 | * codec = avcodec_find_decoder(AV_CODEC_ID_H264); |
3412 | * if (!codec) |
3413 | * exit(1); |
3414 | * |
3415 | * context = avcodec_alloc_context3(codec); |
3416 | * |
3417 | * if (avcodec_open2(context, codec, opts) < 0) |
3418 | * exit(1); |
3419 | * @endcode |
3420 | * |
3421 | * @param avctx The context to initialize. |
3422 | * @param codec The codec to open this context for. If a non-NULL codec has been |
3423 | * previously passed to avcodec_alloc_context3() or |
3424 | * avcodec_get_context_defaults3() for this context, then this |
3425 | * parameter MUST be either NULL or equal to the previously passed |
3426 | * codec. |
3427 | * @param options A dictionary filled with AVCodecContext and codec-private options. |
3428 | * On return this object will be filled with options that were not found. |
3429 | * |
3430 | * @return zero on success, a negative value on error |
3431 | * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(), |
3432 | * av_dict_set(), av_opt_find(). |
3433 | */ |
3434 | int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options); |
3435 | |
3436 | /** |
3437 | * Close a given AVCodecContext and free all the data associated with it |
3438 | * (but not the AVCodecContext itself). |
3439 | * |
3440 | * Calling this function on an AVCodecContext that hasn't been opened will free |
3441 | * the codec-specific data allocated in avcodec_alloc_context3() / |
3442 | * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will |
3443 | * do nothing. |
3444 | */ |
3445 | int avcodec_close(AVCodecContext *avctx); |
3446 | |
3447 | /** |
3448 | * Free all allocated data in the given subtitle struct. |
3449 | * |
3450 | * @param sub AVSubtitle to free. |
3451 | */ |
3452 | void avsubtitle_free(AVSubtitle *sub); |
3453 | |
3454 | /** |
3455 | * @} |
3456 | */ |
3457 | |
3458 | /** |
3459 | * @addtogroup lavc_packet |
3460 | * @{ |
3461 | */ |
3462 | |
3463 | #if FF_API_DESTRUCT_PACKET |
3464 | /** |
3465 | * Default packet destructor. |
3466 | * @deprecated use the AVBuffer API instead |
3467 | */ |
3468 | attribute_deprecated |
3469 | void av_destruct_packet(AVPacket *pkt); |
3470 | #endif |
3471 | |
3472 | /** |
3473 | * Initialize optional fields of a packet with default values. |
3474 | * |
3475 | * Note, this does not touch the data and size members, which have to be |
3476 | * initialized separately. |
3477 | * |
3478 | * @param pkt packet |
3479 | */ |
3480 | void av_init_packet(AVPacket *pkt); |
3481 | |
3482 | /** |
3483 | * Allocate the payload of a packet and initialize its fields with |
3484 | * default values. |
3485 | * |
3486 | * @param pkt packet |
3487 | * @param size wanted payload size |
3488 | * @return 0 if OK, AVERROR_xxx otherwise |
3489 | */ |
3490 | int av_new_packet(AVPacket *pkt, int size); |
3491 | |
3492 | /** |
3493 | * Reduce packet size, correctly zeroing padding |
3494 | * |
3495 | * @param pkt packet |
3496 | * @param size new size |
3497 | */ |
3498 | void av_shrink_packet(AVPacket *pkt, int size); |
3499 | |
3500 | /** |
3501 | * Increase packet size, correctly zeroing padding |
3502 | * |
3503 | * @param pkt packet |
3504 | * @param grow_by number of bytes by which to increase the size of the packet |
3505 | */ |
3506 | int av_grow_packet(AVPacket *pkt, int grow_by); |
3507 | |
3508 | /** |
3509 | * Initialize a reference-counted packet from av_malloc()ed data. |
3510 | * |
3511 | * @param pkt packet to be initialized. This function will set the data, size, |
3512 | * buf and destruct fields, all others are left untouched. |
3513 | * @param data Data allocated by av_malloc() to be used as packet data. If this |
3514 | * function returns successfully, the data is owned by the underlying AVBuffer. |
3515 | * The caller may not access the data through other means. |
3516 | * @param size size of data in bytes, without the padding. I.e. the full buffer |
3517 | * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE. |
3518 | * |
3519 | * @return 0 on success, a negative AVERROR on error |
3520 | */ |
3521 | int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size); |
3522 | |
3523 | /** |
3524 | * @warning This is a hack - the packet memory allocation stuff is broken. The |
3525 | * packet is allocated if it was not really allocated. |
3526 | */ |
3527 | int av_dup_packet(AVPacket *pkt); |
3528 | |
3529 | /** |
3530 | * Copy packet, including contents |
3531 | * |
3532 | * @return 0 on success, negative AVERROR on fail |
3533 | */ |
3534 | int av_copy_packet(AVPacket *dst, AVPacket *src); |
3535 | |
3536 | /** |
3537 | * Copy packet side data |
3538 | * |
3539 | * @return 0 on success, negative AVERROR on fail |
3540 | */ |
3541 | int av_copy_packet_side_data(AVPacket *dst, AVPacket *src); |
3542 | |
3543 | /** |
3544 | * Free a packet. |
3545 | * |
3546 | * @param pkt packet to free |
3547 | */ |
3548 | void av_free_packet(AVPacket *pkt); |
3549 | |
3550 | /** |
3551 | * Allocate new information of a packet. |
3552 | * |
3553 | * @param pkt packet |
3554 | * @param type side information type |
3555 | * @param size side information size |
3556 | * @return pointer to fresh allocated data or NULL otherwise |
3557 | */ |
3558 | uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, |
3559 | int size); |
3560 | |
3561 | /** |
3562 | * Shrink the already allocated side data buffer |
3563 | * |
3564 | * @param pkt packet |
3565 | * @param type side information type |
3566 | * @param size new side information size |
3567 | * @return 0 on success, < 0 on failure |
3568 | */ |
3569 | int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type, |
3570 | int size); |
3571 | |
3572 | /** |
3573 | * Get side information from packet. |
3574 | * |
3575 | * @param pkt packet |
3576 | * @param type desired side information type |
3577 | * @param size pointer for side information size to store (optional) |
3578 | * @return pointer to data if present or NULL otherwise |
3579 | */ |
3580 | uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type, |
3581 | int *size); |
3582 | |
3583 | int av_packet_merge_side_data(AVPacket *pkt); |
3584 | |
3585 | int av_packet_split_side_data(AVPacket *pkt); |
3586 | |
3587 | |
3588 | /** |
3589 | * Convenience function to free all the side data stored. |
3590 | * All the other fields stay untouched. |
3591 | * |
3592 | * @param pkt packet |
3593 | */ |
3594 | void av_packet_free_side_data(AVPacket *pkt); |
3595 | |
3596 | /** |
3597 | * Setup a new reference to the data described by a given packet |
3598 | * |
3599 | * If src is reference-counted, setup dst as a new reference to the |
3600 | * buffer in src. Otherwise allocate a new buffer in dst and copy the |
3601 | * data from src into it. |
3602 | * |
3603 | * All the other fields are copied from src. |
3604 | * |
3605 | * @see av_packet_unref |
3606 | * |
3607 | * @param dst Destination packet |
3608 | * @param src Source packet |
3609 | * |
3610 | * @return 0 on success, a negative AVERROR on error. |
3611 | */ |
3612 | int av_packet_ref(AVPacket *dst, AVPacket *src); |
3613 | |
3614 | /** |
3615 | * Wipe the packet. |
3616 | * |
3617 | * Unreference the buffer referenced by the packet and reset the |
3618 | * remaining packet fields to their default values. |
3619 | * |
3620 | * @param pkt The packet to be unreferenced. |
3621 | */ |
3622 | void av_packet_unref(AVPacket *pkt); |
3623 | |
3624 | /** |
3625 | * Move every field in src to dst and reset src. |
3626 | * |
3627 | * @see av_packet_unref |
3628 | * |
3629 | * @param src Source packet, will be reset |
3630 | * @param dst Destination packet |
3631 | */ |
3632 | void av_packet_move_ref(AVPacket *dst, AVPacket *src); |
3633 | |
3634 | /** |
3635 | * Copy only "properties" fields from src to dst. |
3636 | * |
3637 | * Properties for the purpose of this function are all the fields |
3638 | * beside those related to the packet data (buf, data, size) |
3639 | * |
3640 | * @param dst Destination packet |
3641 | * @param src Source packet |
3642 | * |
3643 | * @return 0 on success AVERROR on failure. |
3644 | * |
3645 | */ |
3646 | int av_packet_copy_props(AVPacket *dst, const AVPacket *src); |
3647 | |
3648 | /** |
3649 | * @} |
3650 | */ |
3651 | |
3652 | /** |
3653 | * @addtogroup lavc_decoding |
3654 | * @{ |
3655 | */ |
3656 | |
3657 | /** |
3658 | * Find a registered decoder with a matching codec ID. |
3659 | * |
3660 | * @param id AVCodecID of the requested decoder |
3661 | * @return A decoder if one was found, NULL otherwise. |
3662 | */ |
3663 | AVCodec *avcodec_find_decoder(enum AVCodecID id); |
3664 | |
3665 | /** |
3666 | * Find a registered decoder with the specified name. |
3667 | * |
3668 | * @param name name of the requested decoder |
3669 | * @return A decoder if one was found, NULL otherwise. |
3670 | */ |
3671 | AVCodec *avcodec_find_decoder_by_name(const char *name); |
3672 | |
3673 | #if FF_API_GET_BUFFER |
3674 | attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic); |
3675 | attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic); |
3676 | attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic); |
3677 | #endif |
3678 | |
3679 | /** |
3680 | * The default callback for AVCodecContext.get_buffer2(). It is made public so |
3681 | * it can be called by custom get_buffer2() implementations for decoders without |
3682 | * CODEC_CAP_DR1 set. |
3683 | */ |
3684 | int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags); |
3685 | |
3686 | /** |
3687 | * Return the amount of padding in pixels which the get_buffer callback must |
3688 | * provide around the edge of the image for codecs which do not have the |
3689 | * CODEC_FLAG_EMU_EDGE flag. |
3690 | * |
3691 | * @return Required padding in pixels. |
3692 | */ |
3693 | unsigned avcodec_get_edge_width(void); |
3694 | |
3695 | /** |
3696 | * Modify width and height values so that they will result in a memory |
3697 | * buffer that is acceptable for the codec if you do not use any horizontal |
3698 | * padding. |
3699 | * |
3700 | * May only be used if a codec with CODEC_CAP_DR1 has been opened. |
3701 | * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased |
3702 | * according to avcodec_get_edge_width() before. |
3703 | */ |
3704 | void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height); |
3705 | |
3706 | /** |
3707 | * Modify width and height values so that they will result in a memory |
3708 | * buffer that is acceptable for the codec if you also ensure that all |
3709 | * line sizes are a multiple of the respective linesize_align[i]. |
3710 | * |
3711 | * May only be used if a codec with CODEC_CAP_DR1 has been opened. |
3712 | * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased |
3713 | * according to avcodec_get_edge_width() before. |
3714 | */ |
3715 | void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, |
3716 | int linesize_align[AV_NUM_DATA_POINTERS]); |
3717 | |
3718 | /** |
3719 | * Converts AVChromaLocation to swscale x/y chroma position. |
3720 | * |
3721 | * The positions represent the chroma (0,0) position in a coordinates system |
3722 | * with luma (0,0) representing the origin and luma(1,1) representing 256,256 |
3723 | * |
3724 | * @param xpos horizontal chroma sample position |
3725 | * @param ypos vertical chroma sample position |
3726 | */ |
3727 | int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos); |
3728 | |
3729 | /** |
3730 | * Converts swscale x/y chroma position to AVChromaLocation. |
3731 | * |
3732 | * The positions represent the chroma (0,0) position in a coordinates system |
3733 | * with luma (0,0) representing the origin and luma(1,1) representing 256,256 |
3734 | * |
3735 | * @param xpos horizontal chroma sample position |
3736 | * @param ypos vertical chroma sample position |
3737 | */ |
3738 | enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos); |
3739 | |
3740 | #if FF_API_OLD_DECODE_AUDIO |
3741 | /** |
3742 | * Wrapper function which calls avcodec_decode_audio4. |
3743 | * |
3744 | * @deprecated Use avcodec_decode_audio4 instead. |
3745 | * |
3746 | * Decode the audio frame of size avpkt->size from avpkt->data into samples. |
3747 | * Some decoders may support multiple frames in a single AVPacket, such |
3748 | * decoders would then just decode the first frame. In this case, |
3749 | * avcodec_decode_audio3 has to be called again with an AVPacket that contains |
3750 | * the remaining data in order to decode the second frame etc. |
3751 | * If no frame |
3752 | * could be outputted, frame_size_ptr is zero. Otherwise, it is the |
3753 | * decompressed frame size in bytes. |
3754 | * |
3755 | * @warning You must set frame_size_ptr to the allocated size of the |
3756 | * output buffer before calling avcodec_decode_audio3(). |
3757 | * |
3758 | * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than |
3759 | * the actual read bytes because some optimized bitstream readers read 32 or 64 |
3760 | * bits at once and could read over the end. |
3761 | * |
3762 | * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that |
3763 | * no overreading happens for damaged MPEG streams. |
3764 | * |
3765 | * @warning You must not provide a custom get_buffer() when using |
3766 | * avcodec_decode_audio3(). Doing so will override it with |
3767 | * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead, |
3768 | * which does allow the application to provide a custom get_buffer(). |
3769 | * |
3770 | * @note You might have to align the input buffer avpkt->data and output buffer |
3771 | * samples. The alignment requirements depend on the CPU: On some CPUs it isn't |
3772 | * necessary at all, on others it won't work at all if not aligned and on others |
3773 | * it will work but it will have an impact on performance. |
3774 | * |
3775 | * In practice, avpkt->data should have 4 byte alignment at minimum and |
3776 | * samples should be 16 byte aligned unless the CPU doesn't need it |
3777 | * (AltiVec and SSE do). |
3778 | * |
3779 | * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay |
3780 | * between input and output, these need to be fed with avpkt->data=NULL, |
3781 | * avpkt->size=0 at the end to return the remaining frames. |
3782 | * |
3783 | * @param avctx the codec context |
3784 | * @param[out] samples the output buffer, sample type in avctx->sample_fmt |
3785 | * If the sample format is planar, each channel plane will |
3786 | * be the same size, with no padding between channels. |
3787 | * @param[in,out] frame_size_ptr the output buffer size in bytes |
3788 | * @param[in] avpkt The input AVPacket containing the input buffer. |
3789 | * You can create such packet with av_init_packet() and by then setting |
3790 | * data and size, some decoders might in addition need other fields. |
3791 | * All decoders are designed to use the least fields possible though. |
3792 | * @return On error a negative value is returned, otherwise the number of bytes |
3793 | * used or zero if no frame data was decompressed (used) from the input AVPacket. |
3794 | */ |
3795 | attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples, |
3796 | int *frame_size_ptr, |
3797 | AVPacket *avpkt); |
3798 | #endif |
3799 | |
3800 | /** |
3801 | * Decode the audio frame of size avpkt->size from avpkt->data into frame. |
3802 | * |
3803 | * Some decoders may support multiple frames in a single AVPacket. Such |
3804 | * decoders would then just decode the first frame and the return value would be |
3805 | * less than the packet size. In this case, avcodec_decode_audio4 has to be |
3806 | * called again with an AVPacket containing the remaining data in order to |
3807 | * decode the second frame, etc... Even if no frames are returned, the packet |
3808 | * needs to be fed to the decoder with remaining data until it is completely |
3809 | * consumed or an error occurs. |
3810 | * |
3811 | * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input |
3812 | * and output. This means that for some packets they will not immediately |
3813 | * produce decoded output and need to be flushed at the end of decoding to get |
3814 | * all the decoded data. Flushing is done by calling this function with packets |
3815 | * with avpkt->data set to NULL and avpkt->size set to 0 until it stops |
3816 | * returning samples. It is safe to flush even those decoders that are not |
3817 | * marked with CODEC_CAP_DELAY, then no samples will be returned. |
3818 | * |
3819 | * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE |
3820 | * larger than the actual read bytes because some optimized bitstream |
3821 | * readers read 32 or 64 bits at once and could read over the end. |
3822 | * |
3823 | * @param avctx the codec context |
3824 | * @param[out] frame The AVFrame in which to store decoded audio samples. |
3825 | * The decoder will allocate a buffer for the decoded frame by |
3826 | * calling the AVCodecContext.get_buffer2() callback. |
3827 | * When AVCodecContext.refcounted_frames is set to 1, the frame is |
3828 | * reference counted and the returned reference belongs to the |
3829 | * caller. The caller must release the frame using av_frame_unref() |
3830 | * when the frame is no longer needed. The caller may safely write |
3831 | * to the frame if av_frame_is_writable() returns 1. |
3832 | * When AVCodecContext.refcounted_frames is set to 0, the returned |
3833 | * reference belongs to the decoder and is valid only until the |
3834 | * next call to this function or until closing or flushing the |
3835 | * decoder. The caller may not write to it. |
3836 | * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is |
3837 | * non-zero. Note that this field being set to zero |
3838 | * does not mean that an error has occurred. For |
3839 | * decoders with CODEC_CAP_DELAY set, no given decode |
3840 | * call is guaranteed to produce a frame. |
3841 | * @param[in] avpkt The input AVPacket containing the input buffer. |
3842 | * At least avpkt->data and avpkt->size should be set. Some |
3843 | * decoders might also require additional fields to be set. |
3844 | * @return A negative error code is returned if an error occurred during |
3845 | * decoding, otherwise the number of bytes consumed from the input |
3846 | * AVPacket is returned. |
3847 | */ |
3848 | int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame, |
3849 | int *got_frame_ptr, const AVPacket *avpkt); |
3850 | |
3851 | /** |
3852 | * Decode the video frame of size avpkt->size from avpkt->data into picture. |
3853 | * Some decoders may support multiple frames in a single AVPacket, such |
3854 | * decoders would then just decode the first frame. |
3855 | * |
3856 | * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than |
3857 | * the actual read bytes because some optimized bitstream readers read 32 or 64 |
3858 | * bits at once and could read over the end. |
3859 | * |
3860 | * @warning The end of the input buffer buf should be set to 0 to ensure that |
3861 | * no overreading happens for damaged MPEG streams. |
3862 | * |
3863 | * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay |
3864 | * between input and output, these need to be fed with avpkt->data=NULL, |
3865 | * avpkt->size=0 at the end to return the remaining frames. |
3866 | * |
3867 | * @param avctx the codec context |
3868 | * @param[out] picture The AVFrame in which the decoded video frame will be stored. |
3869 | * Use av_frame_alloc() to get an AVFrame. The codec will |
3870 | * allocate memory for the actual bitmap by calling the |
3871 | * AVCodecContext.get_buffer2() callback. |
3872 | * When AVCodecContext.refcounted_frames is set to 1, the frame is |
3873 | * reference counted and the returned reference belongs to the |
3874 | * caller. The caller must release the frame using av_frame_unref() |
3875 | * when the frame is no longer needed. The caller may safely write |
3876 | * to the frame if av_frame_is_writable() returns 1. |
3877 | * When AVCodecContext.refcounted_frames is set to 0, the returned |
3878 | * reference belongs to the decoder and is valid only until the |
3879 | * next call to this function or until closing or flushing the |
3880 | * decoder. The caller may not write to it. |
3881 | * |
3882 | * @param[in] avpkt The input AVPacket containing the input buffer. |
3883 | * You can create such packet with av_init_packet() and by then setting |
3884 | * data and size, some decoders might in addition need other fields like |
3885 | * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least |
3886 | * fields possible. |
3887 | * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero. |
3888 | * @return On error a negative value is returned, otherwise the number of bytes |
3889 | * used or zero if no frame could be decompressed. |
3890 | */ |
3891 | int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture, |
3892 | int *got_picture_ptr, |
3893 | const AVPacket *avpkt); |
3894 | |
3895 | /** |
3896 | * Decode a subtitle message. |
3897 | * Return a negative value on error, otherwise return the number of bytes used. |
3898 | * If no subtitle could be decompressed, got_sub_ptr is zero. |
3899 | * Otherwise, the subtitle is stored in *sub. |
3900 | * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for |
3901 | * simplicity, because the performance difference is expect to be negligible |
3902 | * and reusing a get_buffer written for video codecs would probably perform badly |
3903 | * due to a potentially very different allocation pattern. |
3904 | * |
3905 | * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input |
3906 | * and output. This means that for some packets they will not immediately |
3907 | * produce decoded output and need to be flushed at the end of decoding to get |
3908 | * all the decoded data. Flushing is done by calling this function with packets |
3909 | * with avpkt->data set to NULL and avpkt->size set to 0 until it stops |
3910 | * returning subtitles. It is safe to flush even those decoders that are not |
3911 | * marked with CODEC_CAP_DELAY, then no subtitles will be returned. |
3912 | * |
3913 | * @param avctx the codec context |
3914 | * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be |
3915 | freed with avsubtitle_free if *got_sub_ptr is set. |
3916 | * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero. |
3917 | * @param[in] avpkt The input AVPacket containing the input buffer. |
3918 | */ |
3919 | int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, |
3920 | int *got_sub_ptr, |
3921 | AVPacket *avpkt); |
3922 | |
3923 | /** |
3924 | * @defgroup lavc_parsing Frame parsing |
3925 | * @{ |
3926 | */ |
3927 | |
3928 | enum AVPictureStructure { |
3929 | AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown |
3930 | AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field |
3931 | AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field |
3932 | AV_PICTURE_STRUCTURE_FRAME, //< coded as frame |
3933 | }; |
3934 | |
3935 | typedef struct AVCodecParserContext { |
3936 | void *priv_data; |
3937 | struct AVCodecParser *parser; |
3938 | int64_t frame_offset; /* offset of the current frame */ |
3939 | int64_t cur_offset; /* current offset |
3940 | (incremented by each av_parser_parse()) */ |
3941 | int64_t next_frame_offset; /* offset of the next frame */ |
3942 | /* video info */ |
3943 | int pict_type; /* XXX: Put it back in AVCodecContext. */ |
3944 | /** |
3945 | * This field is used for proper frame duration computation in lavf. |
3946 | * It signals, how much longer the frame duration of the current frame |
3947 | * is compared to normal frame duration. |
3948 | * |
3949 | * frame_duration = (1 + repeat_pict) * time_base |
3950 | * |
3951 | * It is used by codecs like H.264 to display telecined material. |
3952 | */ |
3953 | int repeat_pict; /* XXX: Put it back in AVCodecContext. */ |
3954 | int64_t pts; /* pts of the current frame */ |
3955 | int64_t dts; /* dts of the current frame */ |
3956 | |
3957 | /* private data */ |
3958 | int64_t last_pts; |
3959 | int64_t last_dts; |
3960 | int fetch_timestamp; |
3961 | |
3962 | #define AV_PARSER_PTS_NB 4 |
3963 | int cur_frame_start_index; |
3964 | int64_t cur_frame_offset[AV_PARSER_PTS_NB]; |
3965 | int64_t cur_frame_pts[AV_PARSER_PTS_NB]; |
3966 | int64_t cur_frame_dts[AV_PARSER_PTS_NB]; |
3967 | |
3968 | int flags; |
3969 | #define PARSER_FLAG_COMPLETE_FRAMES 0x0001 |
3970 | #define PARSER_FLAG_ONCE 0x0002 |
3971 | /// Set if the parser has a valid file offset |
3972 | #define PARSER_FLAG_FETCHED_OFFSET 0x0004 |
3973 | #define PARSER_FLAG_USE_CODEC_TS 0x1000 |
3974 | |
3975 | int64_t offset; ///< byte offset from starting packet start |
3976 | int64_t cur_frame_end[AV_PARSER_PTS_NB]; |
3977 | |
3978 | /** |
3979 | * Set by parser to 1 for key frames and 0 for non-key frames. |
3980 | * It is initialized to -1, so if the parser doesn't set this flag, |
3981 | * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames |
3982 | * will be used. |
3983 | */ |
3984 | int key_frame; |
3985 | |
3986 | /** |
3987 | * Time difference in stream time base units from the pts of this |
3988 | * packet to the point at which the output from the decoder has converged |
3989 | * independent from the availability of previous frames. That is, the |
3990 | * frames are virtually identical no matter if decoding started from |
3991 | * the very first frame or from this keyframe. |
3992 | * Is AV_NOPTS_VALUE if unknown. |
3993 | * This field is not the display duration of the current frame. |
3994 | * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY |
3995 | * set. |
3996 | * |
3997 | * The purpose of this field is to allow seeking in streams that have no |
3998 | * keyframes in the conventional sense. It corresponds to the |
3999 | * recovery point SEI in H.264 and match_time_delta in NUT. It is also |
4000 | * essential for some types of subtitle streams to ensure that all |
4001 | * subtitles are correctly displayed after seeking. |
4002 | */ |
4003 | int64_t convergence_duration; |
4004 | |
4005 | // Timestamp generation support: |
4006 | /** |
4007 | * Synchronization point for start of timestamp generation. |
4008 | * |
4009 | * Set to >0 for sync point, 0 for no sync point and <0 for undefined |
4010 | * (default). |
4011 | * |
4012 | * For example, this corresponds to presence of H.264 buffering period |
4013 | * SEI message. |
4014 | */ |
4015 | int dts_sync_point; |
4016 | |
4017 | /** |
4018 | * Offset of the current timestamp against last timestamp sync point in |
4019 | * units of AVCodecContext.time_base. |
4020 | * |
4021 | * Set to INT_MIN when dts_sync_point unused. Otherwise, it must |
4022 | * contain a valid timestamp offset. |
4023 | * |
4024 | * Note that the timestamp of sync point has usually a nonzero |
4025 | * dts_ref_dts_delta, which refers to the previous sync point. Offset of |
4026 | * the next frame after timestamp sync point will be usually 1. |
4027 | * |
4028 | * For example, this corresponds to H.264 cpb_removal_delay. |
4029 | */ |
4030 | int dts_ref_dts_delta; |
4031 | |
4032 | /** |
4033 | * Presentation delay of current frame in units of AVCodecContext.time_base. |
4034 | * |
4035 | * Set to INT_MIN when dts_sync_point unused. Otherwise, it must |
4036 | * contain valid non-negative timestamp delta (presentation time of a frame |
4037 | * must not lie in the past). |
4038 | * |
4039 | * This delay represents the difference between decoding and presentation |
4040 | * time of the frame. |
4041 | * |
4042 | * For example, this corresponds to H.264 dpb_output_delay. |
4043 | */ |
4044 | int pts_dts_delta; |
4045 | |
4046 | /** |
4047 | * Position of the packet in file. |
4048 | * |
4049 | * Analogous to cur_frame_pts/dts |
4050 | */ |
4051 | int64_t cur_frame_pos[AV_PARSER_PTS_NB]; |
4052 | |
4053 | /** |
4054 | * Byte position of currently parsed frame in stream. |
4055 | */ |
4056 | int64_t pos; |
4057 | |
4058 | /** |
4059 | * Previous frame byte position. |
4060 | */ |
4061 | int64_t last_pos; |
4062 | |
4063 | /** |
4064 | * Duration of the current frame. |
4065 | * For audio, this is in units of 1 / AVCodecContext.sample_rate. |
4066 | * For all other types, this is in units of AVCodecContext.time_base. |
4067 | */ |
4068 | int duration; |
4069 | |
4070 | enum AVFieldOrder field_order; |
4071 | |
4072 | /** |
4073 | * Indicate whether a picture is coded as a frame, top field or bottom field. |
4074 | * |
4075 | * For example, H.264 field_pic_flag equal to 0 corresponds to |
4076 | * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag |
4077 | * equal to 1 and bottom_field_flag equal to 0 corresponds to |
4078 | * AV_PICTURE_STRUCTURE_TOP_FIELD. |
4079 | */ |
4080 | enum AVPictureStructure picture_structure; |
4081 | |
4082 | /** |
4083 | * Picture number incremented in presentation or output order. |
4084 | * This field may be reinitialized at the first picture of a new sequence. |
4085 | * |
4086 | * For example, this corresponds to H.264 PicOrderCnt. |
4087 | */ |
4088 | int output_picture_number; |
4089 | } AVCodecParserContext; |
4090 | |
4091 | typedef struct AVCodecParser { |
4092 | int codec_ids[5]; /* several codec IDs are permitted */ |
4093 | int priv_data_size; |
4094 | int (*parser_init)(AVCodecParserContext *s); |
4095 | int (*parser_parse)(AVCodecParserContext *s, |
4096 | AVCodecContext *avctx, |
4097 | const uint8_t **poutbuf, int *poutbuf_size, |
4098 | const uint8_t *buf, int buf_size); |
4099 | void (*parser_close)(AVCodecParserContext *s); |
4100 | int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size); |
4101 | struct AVCodecParser *next; |
4102 | } AVCodecParser; |
4103 | |
4104 | AVCodecParser *av_parser_next(AVCodecParser *c); |
4105 | |
4106 | void av_register_codec_parser(AVCodecParser *parser); |
4107 | AVCodecParserContext *av_parser_init(int codec_id); |
4108 | |
4109 | /** |
4110 | * Parse a packet. |
4111 | * |
4112 | * @param s parser context. |
4113 | * @param avctx codec context. |
4114 | * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished. |
4115 | * @param poutbuf_size set to size of parsed buffer or zero if not yet finished. |
4116 | * @param buf input buffer. |
4117 | * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output). |
4118 | * @param pts input presentation timestamp. |
4119 | * @param dts input decoding timestamp. |
4120 | * @param pos input byte position in stream. |
4121 | * @return the number of bytes of the input bitstream used. |
4122 | * |
4123 | * Example: |
4124 | * @code |
4125 | * while(in_len){ |
4126 | * len = av_parser_parse2(myparser, AVCodecContext, &data, &size, |
4127 | * in_data, in_len, |
4128 | * pts, dts, pos); |
4129 | * in_data += len; |
4130 | * in_len -= len; |
4131 | * |
4132 | * if(size) |
4133 | * decode_frame(data, size); |
4134 | * } |
4135 | * @endcode |
4136 | */ |
4137 | int av_parser_parse2(AVCodecParserContext *s, |
4138 | AVCodecContext *avctx, |
4139 | uint8_t **poutbuf, int *poutbuf_size, |
4140 | const uint8_t *buf, int buf_size, |
4141 | int64_t pts, int64_t dts, |
4142 | int64_t pos); |
4143 | |
4144 | /** |
4145 | * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed |
4146 | * @deprecated use AVBitStreamFilter |
4147 | */ |
4148 | int av_parser_change(AVCodecParserContext *s, |
4149 | AVCodecContext *avctx, |
4150 | uint8_t **poutbuf, int *poutbuf_size, |
4151 | const uint8_t *buf, int buf_size, int keyframe); |
4152 | void av_parser_close(AVCodecParserContext *s); |
4153 | |
4154 | /** |
4155 | * @} |
4156 | * @} |
4157 | */ |
4158 | |
4159 | /** |
4160 | * @addtogroup lavc_encoding |
4161 | * @{ |
4162 | */ |
4163 | |
4164 | /** |
4165 | * Find a registered encoder with a matching codec ID. |
4166 | * |
4167 | * @param id AVCodecID of the requested encoder |
4168 | * @return An encoder if one was found, NULL otherwise. |
4169 | */ |
4170 | AVCodec *avcodec_find_encoder(enum AVCodecID id); |
4171 | |
4172 | /** |
4173 | * Find a registered encoder with the specified name. |
4174 | * |
4175 | * @param name name of the requested encoder |
4176 | * @return An encoder if one was found, NULL otherwise. |
4177 | */ |
4178 | AVCodec *avcodec_find_encoder_by_name(const char *name); |
4179 | |
4180 | #if FF_API_OLD_ENCODE_AUDIO |
4181 | /** |
4182 | * Encode an audio frame from samples into buf. |
4183 | * |
4184 | * @deprecated Use avcodec_encode_audio2 instead. |
4185 | * |
4186 | * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large. |
4187 | * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user |
4188 | * will know how much space is needed because it depends on the value passed |
4189 | * in buf_size as described below. In that case a lower value can be used. |
4190 | * |
4191 | * @param avctx the codec context |
4192 | * @param[out] buf the output buffer |
4193 | * @param[in] buf_size the output buffer size |
4194 | * @param[in] samples the input buffer containing the samples |
4195 | * The number of samples read from this buffer is frame_size*channels, |
4196 | * both of which are defined in avctx. |
4197 | * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of |
4198 | * samples read from samples is equal to: |
4199 | * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id)) |
4200 | * This also implies that av_get_bits_per_sample() must not return 0 for these |
4201 | * codecs. |
4202 | * @return On error a negative value is returned, on success zero or the number |
4203 | * of bytes used to encode the data read from the input buffer. |
4204 | */ |
4205 | int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx, |
4206 | uint8_t *buf, int buf_size, |
4207 | const short *samples); |
4208 | #endif |
4209 | |
4210 | /** |
4211 | * Encode a frame of audio. |
4212 | * |
4213 | * Takes input samples from frame and writes the next output packet, if |
4214 | * available, to avpkt. The output packet does not necessarily contain data for |
4215 | * the most recent frame, as encoders can delay, split, and combine input frames |
4216 | * internally as needed. |
4217 | * |
4218 | * @param avctx codec context |
4219 | * @param avpkt output AVPacket. |
4220 | * The user can supply an output buffer by setting |
4221 | * avpkt->data and avpkt->size prior to calling the |
4222 | * function, but if the size of the user-provided data is not |
4223 | * large enough, encoding will fail. If avpkt->data and |
4224 | * avpkt->size are set, avpkt->destruct must also be set. All |
4225 | * other AVPacket fields will be reset by the encoder using |
4226 | * av_init_packet(). If avpkt->data is NULL, the encoder will |
4227 | * allocate it. The encoder will set avpkt->size to the size |
4228 | * of the output packet. |
4229 | * |
4230 | * If this function fails or produces no output, avpkt will be |
4231 | * freed using av_free_packet() (i.e. avpkt->destruct will be |
4232 | * called to free the user supplied buffer). |
4233 | * @param[in] frame AVFrame containing the raw audio data to be encoded. |
4234 | * May be NULL when flushing an encoder that has the |
4235 | * CODEC_CAP_DELAY capability set. |
4236 | * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame |
4237 | * can have any number of samples. |
4238 | * If it is not set, frame->nb_samples must be equal to |
4239 | * avctx->frame_size for all frames except the last. |
4240 | * The final frame may be smaller than avctx->frame_size. |
4241 | * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the |
4242 | * output packet is non-empty, and to 0 if it is |
4243 | * empty. If the function returns an error, the |
4244 | * packet can be assumed to be invalid, and the |
4245 | * value of got_packet_ptr is undefined and should |
4246 | * not be used. |
4247 | * @return 0 on success, negative error code on failure |
4248 | */ |
4249 | int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt, |
4250 | const AVFrame *frame, int *got_packet_ptr); |
4251 | |
4252 | #if FF_API_OLD_ENCODE_VIDEO |
4253 | /** |
4254 | * @deprecated use avcodec_encode_video2() instead. |
4255 | * |
4256 | * Encode a video frame from pict into buf. |
4257 | * The input picture should be |
4258 | * stored using a specific format, namely avctx.pix_fmt. |
4259 | * |
4260 | * @param avctx the codec context |
4261 | * @param[out] buf the output buffer for the bitstream of encoded frame |
4262 | * @param[in] buf_size the size of the output buffer in bytes |
4263 | * @param[in] pict the input picture to encode |
4264 | * @return On error a negative value is returned, on success zero or the number |
4265 | * of bytes used from the output buffer. |
4266 | */ |
4267 | attribute_deprecated |
4268 | int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size, |
4269 | const AVFrame *pict); |
4270 | #endif |
4271 | |
4272 | /** |
4273 | * Encode a frame of video. |
4274 | * |
4275 | * Takes input raw video data from frame and writes the next output packet, if |
4276 | * available, to avpkt. The output packet does not necessarily contain data for |
4277 | * the most recent frame, as encoders can delay and reorder input frames |
4278 | * internally as needed. |
4279 | * |
4280 | * @param avctx codec context |
4281 | * @param avpkt output AVPacket. |
4282 | * The user can supply an output buffer by setting |
4283 | * avpkt->data and avpkt->size prior to calling the |
4284 | * function, but if the size of the user-provided data is not |
4285 | * large enough, encoding will fail. All other AVPacket fields |
4286 | * will be reset by the encoder using av_init_packet(). If |
4287 | * avpkt->data is NULL, the encoder will allocate it. |
4288 | * The encoder will set avpkt->size to the size of the |
4289 | * output packet. The returned data (if any) belongs to the |
4290 | * caller, he is responsible for freeing it. |
4291 | * |
4292 | * If this function fails or produces no output, avpkt will be |
4293 | * freed using av_free_packet() (i.e. avpkt->destruct will be |
4294 | * called to free the user supplied buffer). |
4295 | * @param[in] frame AVFrame containing the raw video data to be encoded. |
4296 | * May be NULL when flushing an encoder that has the |
4297 | * CODEC_CAP_DELAY capability set. |
4298 | * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the |
4299 | * output packet is non-empty, and to 0 if it is |
4300 | * empty. If the function returns an error, the |
4301 | * packet can be assumed to be invalid, and the |
4302 | * value of got_packet_ptr is undefined and should |
4303 | * not be used. |
4304 | * @return 0 on success, negative error code on failure |
4305 | */ |
4306 | int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, |
4307 | const AVFrame *frame, int *got_packet_ptr); |
4308 | |
4309 | int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, |
4310 | const AVSubtitle *sub); |
4311 | |
4312 | |
4313 | /** |
4314 | * @} |
4315 | */ |
4316 | |
4317 | #if FF_API_AVCODEC_RESAMPLE |
4318 | /** |
4319 | * @defgroup lavc_resample Audio resampling |
4320 | * @ingroup libavc |
4321 | * @deprecated use libswresample instead |
4322 | * |
4323 | * @{ |
4324 | */ |
4325 | struct ReSampleContext; |
4326 | struct AVResampleContext; |
4327 | |
4328 | typedef struct ReSampleContext ReSampleContext; |
4329 | |
4330 | /** |
4331 | * Initialize audio resampling context. |
4332 | * |
4333 | * @param output_channels number of output channels |
4334 | * @param input_channels number of input channels |
4335 | * @param output_rate output sample rate |
4336 | * @param input_rate input sample rate |
4337 | * @param sample_fmt_out requested output sample format |
4338 | * @param sample_fmt_in input sample format |
4339 | * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency |
4340 | * @param log2_phase_count log2 of the number of entries in the polyphase filterbank |
4341 | * @param linear if 1 then the used FIR filter will be linearly interpolated |
4342 | between the 2 closest, if 0 the closest will be used |
4343 | * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate |
4344 | * @return allocated ReSampleContext, NULL if error occurred |
4345 | */ |
4346 | attribute_deprecated |
4347 | ReSampleContext *av_audio_resample_init(int output_channels, int input_channels, |
4348 | int output_rate, int input_rate, |
4349 | enum AVSampleFormat sample_fmt_out, |
4350 | enum AVSampleFormat sample_fmt_in, |
4351 | int filter_length, int log2_phase_count, |
4352 | int linear, double cutoff); |
4353 | |
4354 | attribute_deprecated |
4355 | int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples); |
4356 | |
4357 | /** |
4358 | * Free resample context. |
4359 | * |
4360 | * @param s a non-NULL pointer to a resample context previously |
4361 | * created with av_audio_resample_init() |
4362 | */ |
4363 | attribute_deprecated |
4364 | void audio_resample_close(ReSampleContext *s); |
4365 | |
4366 | |
4367 | /** |
4368 | * Initialize an audio resampler. |
4369 | * Note, if either rate is not an integer then simply scale both rates up so they are. |
4370 | * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq |
4371 | * @param log2_phase_count log2 of the number of entries in the polyphase filterbank |
4372 | * @param linear If 1 then the used FIR filter will be linearly interpolated |
4373 | between the 2 closest, if 0 the closest will be used |
4374 | * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate |
4375 | */ |
4376 | attribute_deprecated |
4377 | struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff); |
4378 | |
4379 | /** |
4380 | * Resample an array of samples using a previously configured context. |
4381 | * @param src an array of unconsumed samples |
4382 | * @param consumed the number of samples of src which have been consumed are returned here |
4383 | * @param src_size the number of unconsumed samples available |
4384 | * @param dst_size the amount of space in samples available in dst |
4385 | * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context. |
4386 | * @return the number of samples written in dst or -1 if an error occurred |
4387 | */ |
4388 | attribute_deprecated |
4389 | int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx); |
4390 | |
4391 | |
4392 | /** |
4393 | * Compensate samplerate/timestamp drift. The compensation is done by changing |
4394 | * the resampler parameters, so no audible clicks or similar distortions occur |
4395 | * @param compensation_distance distance in output samples over which the compensation should be performed |
4396 | * @param sample_delta number of output samples which should be output less |
4397 | * |
4398 | * example: av_resample_compensate(c, 10, 500) |
4399 | * here instead of 510 samples only 500 samples would be output |
4400 | * |
4401 | * note, due to rounding the actual compensation might be slightly different, |
4402 | * especially if the compensation_distance is large and the in_rate used during init is small |
4403 | */ |
4404 | attribute_deprecated |
4405 | void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance); |
4406 | attribute_deprecated |
4407 | void av_resample_close(struct AVResampleContext *c); |
4408 | |
4409 | /** |
4410 | * @} |
4411 | */ |
4412 | #endif |
4413 | |
4414 | /** |
4415 | * @addtogroup lavc_picture |
4416 | * @{ |
4417 | */ |
4418 | |
4419 | /** |
4420 | * Allocate memory for the pixels of a picture and setup the AVPicture |
4421 | * fields for it. |
4422 | * |
4423 | * Call avpicture_free() to free it. |
4424 | * |
4425 | * @param picture the picture structure to be filled in |
4426 | * @param pix_fmt the pixel format of the picture |
4427 | * @param width the width of the picture |
4428 | * @param height the height of the picture |
4429 | * @return zero if successful, a negative error code otherwise |
4430 | * |
4431 | * @see av_image_alloc(), avpicture_fill() |
4432 | */ |
4433 | int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height); |
4434 | |
4435 | /** |
4436 | * Free a picture previously allocated by avpicture_alloc(). |
4437 | * The data buffer used by the AVPicture is freed, but the AVPicture structure |
4438 | * itself is not. |
4439 | * |
4440 | * @param picture the AVPicture to be freed |
4441 | */ |
4442 | void avpicture_free(AVPicture *picture); |
4443 | |
4444 | /** |
4445 | * Setup the picture fields based on the specified image parameters |
4446 | * and the provided image data buffer. |
4447 | * |
4448 | * The picture fields are filled in by using the image data buffer |
4449 | * pointed to by ptr. |
4450 | * |
4451 | * If ptr is NULL, the function will fill only the picture linesize |
4452 | * array and return the required size for the image buffer. |
4453 | * |
4454 | * To allocate an image buffer and fill the picture data in one call, |
4455 | * use avpicture_alloc(). |
4456 | * |
4457 | * @param picture the picture to be filled in |
4458 | * @param ptr buffer where the image data is stored, or NULL |
4459 | * @param pix_fmt the pixel format of the image |
4460 | * @param width the width of the image in pixels |
4461 | * @param height the height of the image in pixels |
4462 | * @return the size in bytes required for src, a negative error code |
4463 | * in case of failure |
4464 | * |
4465 | * @see av_image_fill_arrays() |
4466 | */ |
4467 | int avpicture_fill(AVPicture *picture, const uint8_t *ptr, |
4468 | enum AVPixelFormat pix_fmt, int width, int height); |
4469 | |
4470 | /** |
4471 | * Copy pixel data from an AVPicture into a buffer. |
4472 | * |
4473 | * avpicture_get_size() can be used to compute the required size for |
4474 | * the buffer to fill. |
4475 | * |
4476 | * @param src source picture with filled data |
4477 | * @param pix_fmt picture pixel format |
4478 | * @param width picture width |
4479 | * @param height picture height |
4480 | * @param dest destination buffer |
4481 | * @param dest_size destination buffer size in bytes |
4482 | * @return the number of bytes written to dest, or a negative value |
4483 | * (error code) on error, for example if the destination buffer is not |
4484 | * big enough |
4485 | * |
4486 | * @see av_image_copy_to_buffer() |
4487 | */ |
4488 | int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt, |
4489 | int width, int height, |
4490 | unsigned char *dest, int dest_size); |
4491 | |
4492 | /** |
4493 | * Calculate the size in bytes that a picture of the given width and height |
4494 | * would occupy if stored in the given picture format. |
4495 | * |
4496 | * @param pix_fmt picture pixel format |
4497 | * @param width picture width |
4498 | * @param height picture height |
4499 | * @return the computed picture buffer size or a negative error code |
4500 | * in case of error |
4501 | * |
4502 | * @see av_image_get_buffer_size(). |
4503 | */ |
4504 | int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height); |
4505 | |
4506 | #if FF_API_DEINTERLACE |
4507 | /** |
4508 | * deinterlace - if not supported return -1 |
4509 | * |
4510 | * @deprecated - use yadif (in libavfilter) instead |
4511 | */ |
4512 | attribute_deprecated |
4513 | int avpicture_deinterlace(AVPicture *dst, const AVPicture *src, |
4514 | enum AVPixelFormat pix_fmt, int width, int height); |
4515 | #endif |
4516 | /** |
4517 | * Copy image src to dst. Wraps av_image_copy(). |
4518 | */ |
4519 | void av_picture_copy(AVPicture *dst, const AVPicture *src, |
4520 | enum AVPixelFormat pix_fmt, int width, int height); |
4521 | |
4522 | /** |
4523 | * Crop image top and left side. |
4524 | */ |
4525 | int av_picture_crop(AVPicture *dst, const AVPicture *src, |
4526 | enum AVPixelFormat pix_fmt, int top_band, int left_band); |
4527 | |
4528 | /** |
4529 | * Pad image. |
4530 | */ |
4531 | int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt, |
4532 | int padtop, int padbottom, int padleft, int padright, int *color); |
4533 | |
4534 | /** |
4535 | * @} |
4536 | */ |
4537 | |
4538 | /** |
4539 | * @defgroup lavc_misc Utility functions |
4540 | * @ingroup libavc |
4541 | * |
4542 | * Miscellaneous utility functions related to both encoding and decoding |
4543 | * (or neither). |
4544 | * @{ |
4545 | */ |
4546 | |
4547 | /** |
4548 | * @defgroup lavc_misc_pixfmt Pixel formats |
4549 | * |
4550 | * Functions for working with pixel formats. |
4551 | * @{ |
4552 | */ |
4553 | |
4554 | /** |
4555 | * Utility function to access log2_chroma_w log2_chroma_h from |
4556 | * the pixel format AVPixFmtDescriptor. |
4557 | * |
4558 | * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample |
4559 | * for one that returns a failure code and continues in case of invalid |
4560 | * pix_fmts. |
4561 | * |
4562 | * @param[in] pix_fmt the pixel format |
4563 | * @param[out] h_shift store log2_chroma_w |
4564 | * @param[out] v_shift store log2_chroma_h |
4565 | * |
4566 | * @see av_pix_fmt_get_chroma_sub_sample |
4567 | */ |
4568 | |
4569 | void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift); |
4570 | |
4571 | /** |
4572 | * Return a value representing the fourCC code associated to the |
4573 | * pixel format pix_fmt, or 0 if no associated fourCC code can be |
4574 | * found. |
4575 | */ |
4576 | unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt); |
4577 | |
4578 | #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */ |
4579 | #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */ |
4580 | #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */ |
4581 | #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */ |
4582 | #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */ |
4583 | #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */ |
4584 | |
4585 | /** |
4586 | * Compute what kind of losses will occur when converting from one specific |
4587 | * pixel format to another. |
4588 | * When converting from one pixel format to another, information loss may occur. |
4589 | * For example, when converting from RGB24 to GRAY, the color information will |
4590 | * be lost. Similarly, other losses occur when converting from some formats to |
4591 | * other formats. These losses can involve loss of chroma, but also loss of |
4592 | * resolution, loss of color depth, loss due to the color space conversion, loss |
4593 | * of the alpha bits or loss due to color quantization. |
4594 | * avcodec_get_fix_fmt_loss() informs you about the various types of losses |
4595 | * which will occur when converting from one pixel format to another. |
4596 | * |
4597 | * @param[in] dst_pix_fmt destination pixel format |
4598 | * @param[in] src_pix_fmt source pixel format |
4599 | * @param[in] has_alpha Whether the source pixel format alpha channel is used. |
4600 | * @return Combination of flags informing you what kind of losses will occur |
4601 | * (maximum loss for an invalid dst_pix_fmt). |
4602 | */ |
4603 | int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, |
4604 | int has_alpha); |
4605 | |
4606 | /** |
4607 | * Find the best pixel format to convert to given a certain source pixel |
4608 | * format. When converting from one pixel format to another, information loss |
4609 | * may occur. For example, when converting from RGB24 to GRAY, the color |
4610 | * information will be lost. Similarly, other losses occur when converting from |
4611 | * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of |
4612 | * the given pixel formats should be used to suffer the least amount of loss. |
4613 | * The pixel formats from which it chooses one, are determined by the |
4614 | * pix_fmt_list parameter. |
4615 | * |
4616 | * |
4617 | * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from |
4618 | * @param[in] src_pix_fmt source pixel format |
4619 | * @param[in] has_alpha Whether the source pixel format alpha channel is used. |
4620 | * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur. |
4621 | * @return The best pixel format to convert to or -1 if none was found. |
4622 | */ |
4623 | enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, |
4624 | enum AVPixelFormat src_pix_fmt, |
4625 | int has_alpha, int *loss_ptr); |
4626 | |
4627 | /** |
4628 | * Find the best pixel format to convert to given a certain source pixel |
4629 | * format and a selection of two destination pixel formats. When converting from |
4630 | * one pixel format to another, information loss may occur. For example, when converting |
4631 | * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when |
4632 | * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of |
4633 | * the given pixel formats should be used to suffer the least amount of loss. |
4634 | * |
4635 | * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be |
4636 | * returned. |
4637 | * |
4638 | * @code |
4639 | * src_pix_fmt = AV_PIX_FMT_YUV420P; |
4640 | * dst_pix_fmt1= AV_PIX_FMT_RGB24; |
4641 | * dst_pix_fmt2= AV_PIX_FMT_GRAY8; |
4642 | * dst_pix_fmt3= AV_PIX_FMT_RGB8; |
4643 | * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored. |
4644 | * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss); |
4645 | * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss); |
4646 | * @endcode |
4647 | * |
4648 | * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from |
4649 | * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from |
4650 | * @param[in] src_pix_fmt Source pixel format |
4651 | * @param[in] has_alpha Whether the source pixel format alpha channel is used. |
4652 | * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e. |
4653 | * NULL or value of zero means we care about all losses. Out: the loss |
4654 | * that occurs when converting from src to selected dst pixel format. |
4655 | * @return The best pixel format to convert to or -1 if none was found. |
4656 | */ |
4657 | enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, |
4658 | enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr); |
4659 | |
4660 | attribute_deprecated |
4661 | #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI |
4662 | enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list, |
4663 | enum AVPixelFormat src_pix_fmt, |
4664 | int has_alpha, int *loss_ptr); |
4665 | #else |
4666 | enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, |
4667 | enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr); |
4668 | #endif |
4669 | |
4670 | |
4671 | enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt); |
4672 | |
4673 | /** |
4674 | * @} |
4675 | */ |
4676 | |
4677 | void avcodec_set_dimensions(AVCodecContext *s, int width, int height); |
4678 | |
4679 | /** |
4680 | * Put a string representing the codec tag codec_tag in buf. |
4681 | * |
4682 | * @param buf_size size in bytes of buf |
4683 | * @return the length of the string that would have been generated if |
4684 | * enough space had been available, excluding the trailing null |
4685 | */ |
4686 | size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag); |
4687 | |
4688 | void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode); |
4689 | |
4690 | /** |
4691 | * Return a name for the specified profile, if available. |
4692 | * |
4693 | * @param codec the codec that is searched for the given profile |
4694 | * @param profile the profile value for which a name is requested |
4695 | * @return A name for the profile if found, NULL otherwise. |
4696 | */ |
4697 | const char *av_get_profile_name(const AVCodec *codec, int profile); |
4698 | |
4699 | int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size); |
4700 | int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count); |
4701 | //FIXME func typedef |
4702 | |
4703 | /** |
4704 | * Fill AVFrame audio data and linesize pointers. |
4705 | * |
4706 | * The buffer buf must be a preallocated buffer with a size big enough |
4707 | * to contain the specified samples amount. The filled AVFrame data |
4708 | * pointers will point to this buffer. |
4709 | * |
4710 | * AVFrame extended_data channel pointers are allocated if necessary for |
4711 | * planar audio. |
4712 | * |
4713 | * @param frame the AVFrame |
4714 | * frame->nb_samples must be set prior to calling the |
4715 | * function. This function fills in frame->data, |
4716 | * frame->extended_data, frame->linesize[0]. |
4717 | * @param nb_channels channel count |
4718 | * @param sample_fmt sample format |
4719 | * @param buf buffer to use for frame data |
4720 | * @param buf_size size of buffer |
4721 | * @param align plane size sample alignment (0 = default) |
4722 | * @return >=0 on success, negative error code on failure |
4723 | * @todo return the size in bytes required to store the samples in |
4724 | * case of success, at the next libavutil bump |
4725 | */ |
4726 | int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, |
4727 | enum AVSampleFormat sample_fmt, const uint8_t *buf, |
4728 | int buf_size, int align); |
4729 | |
4730 | /** |
4731 | * Reset the internal decoder state / flush internal buffers. Should be called |
4732 | * e.g. when seeking or when switching to a different stream. |
4733 | * |
4734 | * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0), |
4735 | * this invalidates the frames previously returned from the decoder. When |
4736 | * refcounted frames are used, the decoder just releases any references it might |
4737 | * keep internally, but the caller's reference remains valid. |
4738 | */ |
4739 | void avcodec_flush_buffers(AVCodecContext *avctx); |
4740 | |
4741 | /** |
4742 | * Return codec bits per sample. |
4743 | * |
4744 | * @param[in] codec_id the codec |
4745 | * @return Number of bits per sample or zero if unknown for the given codec. |
4746 | */ |
4747 | int av_get_bits_per_sample(enum AVCodecID codec_id); |
4748 | |
4749 | /** |
4750 | * Return the PCM codec associated with a sample format. |
4751 | * @param be endianness, 0 for little, 1 for big, |
4752 | * -1 (or anything else) for native |
4753 | * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE |
4754 | */ |
4755 | enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be); |
4756 | |
4757 | /** |
4758 | * Return codec bits per sample. |
4759 | * Only return non-zero if the bits per sample is exactly correct, not an |
4760 | * approximation. |
4761 | * |
4762 | * @param[in] codec_id the codec |
4763 | * @return Number of bits per sample or zero if unknown for the given codec. |
4764 | */ |
4765 | int av_get_exact_bits_per_sample(enum AVCodecID codec_id); |
4766 | |
4767 | /** |
4768 | * Return audio frame duration. |
4769 | * |
4770 | * @param avctx codec context |
4771 | * @param frame_bytes size of the frame, or 0 if unknown |
4772 | * @return frame duration, in samples, if known. 0 if not able to |
4773 | * determine. |
4774 | */ |
4775 | int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes); |
4776 | |
4777 | |
4778 | typedef struct AVBitStreamFilterContext { |
4779 | void *priv_data; |
4780 | struct AVBitStreamFilter *filter; |
4781 | AVCodecParserContext *parser; |
4782 | struct AVBitStreamFilterContext *next; |
4783 | } AVBitStreamFilterContext; |
4784 | |
4785 | |
4786 | typedef struct AVBitStreamFilter { |
4787 | const char *name; |
4788 | int priv_data_size; |
4789 | int (*filter)(AVBitStreamFilterContext *bsfc, |
4790 | AVCodecContext *avctx, const char *args, |
4791 | uint8_t **poutbuf, int *poutbuf_size, |
4792 | const uint8_t *buf, int buf_size, int keyframe); |
4793 | void (*close)(AVBitStreamFilterContext *bsfc); |
4794 | struct AVBitStreamFilter *next; |
4795 | } AVBitStreamFilter; |
4796 | |
4797 | /** |
4798 | * Register a bitstream filter. |
4799 | * |
4800 | * The filter will be accessible to the application code through |
4801 | * av_bitstream_filter_next() or can be directly initialized with |
4802 | * av_bitstream_filter_init(). |
4803 | * |
4804 | * @see avcodec_register_all() |
4805 | */ |
4806 | void av_register_bitstream_filter(AVBitStreamFilter *bsf); |
4807 | |
4808 | /** |
4809 | * Create and initialize a bitstream filter context given a bitstream |
4810 | * filter name. |
4811 | * |
4812 | * The returned context must be freed with av_bitstream_filter_close(). |
4813 | * |
4814 | * @param name the name of the bitstream filter |
4815 | * @return a bitstream filter context if a matching filter was found |
4816 | * and successfully initialized, NULL otherwise |
4817 | */ |
4818 | AVBitStreamFilterContext *av_bitstream_filter_init(const char *name); |
4819 | |
4820 | /** |
4821 | * Filter bitstream. |
4822 | * |
4823 | * This function filters the buffer buf with size buf_size, and places the |
4824 | * filtered buffer in the buffer pointed to by poutbuf. |
4825 | * |
4826 | * The output buffer must be freed by the caller. |
4827 | * |
4828 | * @param bsfc bitstream filter context created by av_bitstream_filter_init() |
4829 | * @param avctx AVCodecContext accessed by the filter, may be NULL. |
4830 | * If specified, this must point to the encoder context of the |
4831 | * output stream the packet is sent to. |
4832 | * @param args arguments which specify the filter configuration, may be NULL |
4833 | * @param poutbuf pointer which is updated to point to the filtered buffer |
4834 | * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes |
4835 | * @param buf buffer containing the data to filter |
4836 | * @param buf_size size in bytes of buf |
4837 | * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data |
4838 | * @return >= 0 in case of success, or a negative error code in case of failure |
4839 | * |
4840 | * If the return value is positive, an output buffer is allocated and |
4841 | * is availble in *poutbuf, and is distinct from the input buffer. |
4842 | * |
4843 | * If the return value is 0, the output buffer is not allocated and |
4844 | * should be considered identical to the input buffer, or in case |
4845 | * *poutbuf was set it points to the input buffer (not necessarily to |
4846 | * its starting address). |
4847 | */ |
4848 | int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, |
4849 | AVCodecContext *avctx, const char *args, |
4850 | uint8_t **poutbuf, int *poutbuf_size, |
4851 | const uint8_t *buf, int buf_size, int keyframe); |
4852 | |
4853 | /** |
4854 | * Release bitstream filter context. |
4855 | * |
4856 | * @param bsf the bitstream filter context created with |
4857 | * av_bitstream_filter_init(), can be NULL |
4858 | */ |
4859 | void av_bitstream_filter_close(AVBitStreamFilterContext *bsf); |
4860 | |
4861 | /** |
4862 | * If f is NULL, return the first registered bitstream filter, |
4863 | * if f is non-NULL, return the next registered bitstream filter |
4864 | * after f, or NULL if f is the last one. |
4865 | * |
4866 | * This function can be used to iterate over all registered bitstream |
4867 | * filters. |
4868 | */ |
4869 | AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f); |
4870 | |
4871 | /* memory */ |
4872 | |
4873 | /** |
4874 | * Reallocate the given block if it is not large enough, otherwise do nothing. |
4875 | * |
4876 | * @see av_realloc |
4877 | */ |
4878 | void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size); |
4879 | |
4880 | /** |
4881 | * Allocate a buffer, reusing the given one if large enough. |
4882 | * |
4883 | * Contrary to av_fast_realloc the current buffer contents might not be |
4884 | * preserved and on error the old buffer is freed, thus no special |
4885 | * handling to avoid memleaks is necessary. |
4886 | * |
4887 | * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer |
4888 | * @param size size of the buffer *ptr points to |
4889 | * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and |
4890 | * *size 0 if an error occurred. |
4891 | */ |
4892 | void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size); |
4893 | |
4894 | /** |
4895 | * Same behaviour av_fast_malloc but the buffer has additional |
4896 | * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0. |
4897 | * |
4898 | * In addition the whole buffer will initially and after resizes |
4899 | * be 0-initialized so that no uninitialized data will ever appear. |
4900 | */ |
4901 | void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size); |
4902 | |
4903 | /** |
4904 | * Same behaviour av_fast_padded_malloc except that buffer will always |
4905 | * be 0-initialized after call. |
4906 | */ |
4907 | void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size); |
4908 | |
4909 | /** |
4910 | * Encode extradata length to a buffer. Used by xiph codecs. |
4911 | * |
4912 | * @param s buffer to write to; must be at least (v/255+1) bytes long |
4913 | * @param v size of extradata in bytes |
4914 | * @return number of bytes written to the buffer. |
4915 | */ |
4916 | unsigned int av_xiphlacing(unsigned char *s, unsigned int v); |
4917 | |
4918 | #if FF_API_MISSING_SAMPLE |
4919 | /** |
4920 | * Log a generic warning message about a missing feature. This function is |
4921 | * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.) |
4922 | * only, and would normally not be used by applications. |
4923 | * @param[in] avc a pointer to an arbitrary struct of which the first field is |
4924 | * a pointer to an AVClass struct |
4925 | * @param[in] feature string containing the name of the missing feature |
4926 | * @param[in] want_sample indicates if samples are wanted which exhibit this feature. |
4927 | * If want_sample is non-zero, additional verbage will be added to the log |
4928 | * message which tells the user how to report samples to the development |
4929 | * mailing list. |
4930 | * @deprecated Use avpriv_report_missing_feature() instead. |
4931 | */ |
4932 | attribute_deprecated |
4933 | void av_log_missing_feature(void *avc, const char *feature, int want_sample); |
4934 | |
4935 | /** |
4936 | * Log a generic warning message asking for a sample. This function is |
4937 | * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.) |
4938 | * only, and would normally not be used by applications. |
4939 | * @param[in] avc a pointer to an arbitrary struct of which the first field is |
4940 | * a pointer to an AVClass struct |
4941 | * @param[in] msg string containing an optional message, or NULL if no message |
4942 | * @deprecated Use avpriv_request_sample() instead. |
4943 | */ |
4944 | attribute_deprecated |
4945 | void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3); |
4946 | #endif /* FF_API_MISSING_SAMPLE */ |
4947 | |
4948 | /** |
4949 | * Register the hardware accelerator hwaccel. |
4950 | */ |
4951 | void av_register_hwaccel(AVHWAccel *hwaccel); |
4952 | |
4953 | /** |
4954 | * If hwaccel is NULL, returns the first registered hardware accelerator, |
4955 | * if hwaccel is non-NULL, returns the next registered hardware accelerator |
4956 | * after hwaccel, or NULL if hwaccel is the last one. |
4957 | */ |
4958 | AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel); |
4959 | |
4960 | |
4961 | /** |
4962 | * Lock operation used by lockmgr |
4963 | */ |
4964 | enum AVLockOp { |
4965 | AV_LOCK_CREATE, ///< Create a mutex |
4966 | AV_LOCK_OBTAIN, ///< Lock the mutex |
4967 | AV_LOCK_RELEASE, ///< Unlock the mutex |
4968 | AV_LOCK_DESTROY, ///< Free mutex resources |
4969 | }; |
4970 | |
4971 | /** |
4972 | * Register a user provided lock manager supporting the operations |
4973 | * specified by AVLockOp. mutex points to a (void *) where the |
4974 | * lockmgr should store/get a pointer to a user allocated mutex. It's |
4975 | * NULL upon AV_LOCK_CREATE and != NULL for all other ops. |
4976 | * |
4977 | * @param cb User defined callback. Note: FFmpeg may invoke calls to this |
4978 | * callback during the call to av_lockmgr_register(). |
4979 | * Thus, the application must be prepared to handle that. |
4980 | * If cb is set to NULL the lockmgr will be unregistered. |
4981 | * Also note that during unregistration the previously registered |
4982 | * lockmgr callback may also be invoked. |
4983 | */ |
4984 | int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op)); |
4985 | |
4986 | /** |
4987 | * Get the type of the given codec. |
4988 | */ |
4989 | enum AVMediaType avcodec_get_type(enum AVCodecID codec_id); |
4990 | |
4991 | /** |
4992 | * Get the name of a codec. |
4993 | * @return a static string identifying the codec; never NULL |
4994 | */ |
4995 | const char *avcodec_get_name(enum AVCodecID id); |
4996 | |
4997 | /** |
4998 | * @return a positive value if s is open (i.e. avcodec_open2() was called on it |
4999 | * with no corresponding avcodec_close()), 0 otherwise. |
5000 | */ |
5001 | int avcodec_is_open(AVCodecContext *s); |
5002 | |
5003 | /** |
5004 | * @return a non-zero number if codec is an encoder, zero otherwise |
5005 | */ |
5006 | int av_codec_is_encoder(const AVCodec *codec); |
5007 | |
5008 | /** |
5009 | * @return a non-zero number if codec is a decoder, zero otherwise |
5010 | */ |
5011 | int av_codec_is_decoder(const AVCodec *codec); |
5012 | |
5013 | /** |
5014 | * @return descriptor for given codec ID or NULL if no descriptor exists. |
5015 | */ |
5016 | const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id); |
5017 | |
5018 | /** |
5019 | * Iterate over all codec descriptors known to libavcodec. |
5020 | * |
5021 | * @param prev previous descriptor. NULL to get the first descriptor. |
5022 | * |
5023 | * @return next descriptor or NULL after the last descriptor |
5024 | */ |
5025 | const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev); |
5026 | |
5027 | /** |
5028 | * @return codec descriptor with the given name or NULL if no such descriptor |
5029 | * exists. |
5030 | */ |
5031 | const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name); |
5032 | |
5033 | /** |
5034 | * @} |
5035 | */ |
5036 | |
5037 | #endif /* AVCODEC_AVCODEC_H */ |
5038 |