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