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