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