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