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