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