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