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