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