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