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