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