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