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