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