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