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