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