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