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