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