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