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