avcodec: doxy: Clarify what get_buffer2 must fill in buf[]
[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. Each
1902 * buffer must be reference-counted using the AVBuffer API.
1903 *
1904 * The following fields will be set in the frame before this callback is
1905 * called:
1906 * - format
1907 * - width, height (video only)
1908 * - sample_rate, channel_layout, nb_samples (audio only)
1909 * Their values may differ from the corresponding values in
1910 * AVCodecContext. This callback must use the frame values, not the codec
1911 * context values, to calculate the required buffer size.
1912 *
1913 * This callback must fill the following fields in the frame:
1914 * - data[]
1915 * - linesize[]
1916 * - extended_data:
1917 * * if the data is planar audio with more than 8 channels, then this
1918 * callback must allocate and fill extended_data to contain all pointers
1919 * to all data planes. data[] must hold as many pointers as it can.
1920 * extended_data must be allocated with av_malloc() and will be freed in
1921 * av_frame_unref().
1922 * * otherwise exended_data must point to data
1923 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1924 * the frame's data and extended_data pointers must be contained in these. That
1925 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1926 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1927 * and av_buffer_ref().
1928 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1929 * this callback and filled with the extra buffers if there are more
1930 * buffers than buf[] can hold. extended_buf will be freed in
1931 * av_frame_unref().
1932 *
1933 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
1934 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1935 * some other means.
1936 *
1937 * Each data plane must be aligned to the maximum required by the target
1938 * CPU.
1939 *
1940 * @see avcodec_default_get_buffer2()
1941 *
1942 * Video:
1943 *
1944 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1945 * (read and/or written to if it is writable) later by libavcodec.
1946 *
1947 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
1948 * edge of the size returned by avcodec_get_edge_width() on all sides.
1949 *
1950 * avcodec_align_dimensions2() should be used to find the required width and
1951 * height, as they normally need to be rounded up to the next multiple of 16.
1952 *
1953 * If frame multithreading is used and thread_safe_callbacks is set,
1954 * this callback may be called from a different thread, but not from more
1955 * than one at once. Does not need to be reentrant.
1956 *
1957 * @see avcodec_align_dimensions2()
1958 *
1959 * Audio:
1960 *
1961 * Decoders request a buffer of a particular size by setting
1962 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1963 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1964 * to a smaller value in the output frame.
1965 *
1966 * As a convenience, av_samples_get_buffer_size() and
1967 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1968 * functions to find the required data size and to fill data pointers and
1969 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1970 * since all planes must be the same size.
1971 *
1972 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1973 *
1974 * - encoding: unused
1975 * - decoding: Set by libavcodec, user can override.
1976 */
1977 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1978
1979 /**
1980 * If non-zero, the decoded audio and video frames returned from
1981 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1982 * and are valid indefinitely. The caller must free them with
1983 * av_frame_unref() when they are not needed anymore.
1984 * Otherwise, the decoded frames must not be freed by the caller and are
1985 * only valid until the next decode call.
1986 *
1987 * - encoding: unused
1988 * - decoding: set by the caller before avcodec_open2().
1989 */
1990 int refcounted_frames;
1991
1992 /* - encoding parameters */
1993 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1994 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1995
1996 /**
1997 * minimum quantizer
1998 * - encoding: Set by user.
1999 * - decoding: unused
2000 */
2001 int qmin;
2002
2003 /**
2004 * maximum quantizer
2005 * - encoding: Set by user.
2006 * - decoding: unused
2007 */
2008 int qmax;
2009
2010 /**
2011 * maximum quantizer difference between frames
2012 * - encoding: Set by user.
2013 * - decoding: unused
2014 */
2015 int max_qdiff;
2016
2017 /**
2018 * ratecontrol qmin qmax limiting method
2019 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2020 * - encoding: Set by user.
2021 * - decoding: unused
2022 */
2023 float rc_qsquish;
2024
2025 float rc_qmod_amp;
2026 int rc_qmod_freq;
2027
2028 /**
2029 * decoder bitstream buffer size
2030 * - encoding: Set by user.
2031 * - decoding: unused
2032 */
2033 int rc_buffer_size;
2034
2035 /**
2036 * ratecontrol override, see RcOverride
2037 * - encoding: Allocated/set/freed by user.
2038 * - decoding: unused
2039 */
2040 int rc_override_count;
2041 RcOverride *rc_override;
2042
2043 /**
2044 * rate control equation
2045 * - encoding: Set by user
2046 * - decoding: unused
2047 */
2048 const char *rc_eq;
2049
2050 /**
2051 * maximum bitrate
2052 * - encoding: Set by user.
2053 * - decoding: unused
2054 */
2055 int rc_max_rate;
2056
2057 /**
2058 * minimum bitrate
2059 * - encoding: Set by user.
2060 * - decoding: unused
2061 */
2062 int rc_min_rate;
2063
2064 float rc_buffer_aggressivity;
2065
2066 /**
2067 * initial complexity for pass1 ratecontrol
2068 * - encoding: Set by user.
2069 * - decoding: unused
2070 */
2071 float rc_initial_cplx;
2072
2073 /**
2074 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2075 * - encoding: Set by user.
2076 * - decoding: unused.
2077 */
2078 float rc_max_available_vbv_use;
2079
2080 /**
2081 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2082 * - encoding: Set by user.
2083 * - decoding: unused.
2084 */
2085 float rc_min_vbv_overflow_use;
2086
2087 /**
2088 * Number of bits which should be loaded into the rc buffer before decoding starts.
2089 * - encoding: Set by user.
2090 * - decoding: unused
2091 */
2092 int rc_initial_buffer_occupancy;
2093
2094 #define FF_CODER_TYPE_VLC 0
2095 #define FF_CODER_TYPE_AC 1
2096 #define FF_CODER_TYPE_RAW 2
2097 #define FF_CODER_TYPE_RLE 3
2098 #define FF_CODER_TYPE_DEFLATE 4
2099 /**
2100 * coder type
2101 * - encoding: Set by user.
2102 * - decoding: unused
2103 */
2104 int coder_type;
2105
2106 /**
2107 * context model
2108 * - encoding: Set by user.
2109 * - decoding: unused
2110 */
2111 int context_model;
2112
2113 /**
2114 * minimum Lagrange multipler
2115 * - encoding: Set by user.
2116 * - decoding: unused
2117 */
2118 int lmin;
2119
2120 /**
2121 * maximum Lagrange multipler
2122 * - encoding: Set by user.
2123 * - decoding: unused
2124 */
2125 int lmax;
2126
2127 /**
2128 * frame skip threshold
2129 * - encoding: Set by user.
2130 * - decoding: unused
2131 */
2132 int frame_skip_threshold;
2133
2134 /**
2135 * frame skip factor
2136 * - encoding: Set by user.
2137 * - decoding: unused
2138 */
2139 int frame_skip_factor;
2140
2141 /**
2142 * frame skip exponent
2143 * - encoding: Set by user.
2144 * - decoding: unused
2145 */
2146 int frame_skip_exp;
2147
2148 /**
2149 * frame skip comparison function
2150 * - encoding: Set by user.
2151 * - decoding: unused
2152 */
2153 int frame_skip_cmp;
2154
2155 /**
2156 * trellis RD quantization
2157 * - encoding: Set by user.
2158 * - decoding: unused
2159 */
2160 int trellis;
2161
2162 /**
2163 * - encoding: Set by user.
2164 * - decoding: unused
2165 */
2166 int min_prediction_order;
2167
2168 /**
2169 * - encoding: Set by user.
2170 * - decoding: unused
2171 */
2172 int max_prediction_order;
2173
2174 /**
2175 * GOP timecode frame start number, in non drop frame format
2176 * - encoding: Set by user.
2177 * - decoding: unused
2178 */
2179 int64_t timecode_frame_start;
2180
2181 /* The RTP callback: This function is called */
2182 /* every time the encoder has a packet to send. */
2183 /* It depends on the encoder if the data starts */
2184 /* with a Start Code (it should). H.263 does. */
2185 /* mb_nb contains the number of macroblocks */
2186 /* encoded in the RTP payload. */
2187 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2188
2189 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2190 /* do its best to deliver a chunk with size */
2191 /* below rtp_payload_size, the chunk will start */
2192 /* with a start code on some codecs like H.263. */
2193 /* This doesn't take account of any particular */
2194 /* headers inside the transmitted RTP payload. */
2195
2196 /* statistics, used for 2-pass encoding */
2197 int mv_bits;
2198 int header_bits;
2199 int i_tex_bits;
2200 int p_tex_bits;
2201 int i_count;
2202 int p_count;
2203 int skip_count;
2204 int misc_bits;
2205
2206 /**
2207 * number of bits used for the previously encoded frame
2208 * - encoding: Set by libavcodec.
2209 * - decoding: unused
2210 */
2211 int frame_bits;
2212
2213 /**
2214 * pass1 encoding statistics output buffer
2215 * - encoding: Set by libavcodec.
2216 * - decoding: unused
2217 */
2218 char *stats_out;
2219
2220 /**
2221 * pass2 encoding statistics input buffer
2222 * Concatenated stuff from stats_out of pass1 should be placed here.
2223 * - encoding: Allocated/set/freed by user.
2224 * - decoding: unused
2225 */
2226 char *stats_in;
2227
2228 /**
2229 * Work around bugs in encoders which sometimes cannot be detected automatically.
2230 * - encoding: Set by user
2231 * - decoding: Set by user
2232 */
2233 int workaround_bugs;
2234 #define FF_BUG_AUTODETECT 1 ///< autodetection
2235 #define FF_BUG_OLD_MSMPEG4 2
2236 #define FF_BUG_XVID_ILACE 4
2237 #define FF_BUG_UMP4 8
2238 #define FF_BUG_NO_PADDING 16
2239 #define FF_BUG_AMV 32
2240 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2241 #define FF_BUG_QPEL_CHROMA 64
2242 #define FF_BUG_STD_QPEL 128
2243 #define FF_BUG_QPEL_CHROMA2 256
2244 #define FF_BUG_DIRECT_BLOCKSIZE 512
2245 #define FF_BUG_EDGE 1024
2246 #define FF_BUG_HPEL_CHROMA 2048
2247 #define FF_BUG_DC_CLIP 4096
2248 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2249 #define FF_BUG_TRUNCATED 16384
2250
2251 /**
2252 * strictly follow the standard (MPEG4, ...).
2253 * - encoding: Set by user.
2254 * - decoding: Set by user.
2255 * Setting this to STRICT or higher means the encoder and decoder will
2256 * generally do stupid things, whereas setting it to unofficial or lower
2257 * will mean the encoder might produce output that is not supported by all
2258 * spec-compliant decoders. Decoders don't differentiate between normal,
2259 * unofficial and experimental (that is, they always try to decode things
2260 * when they can) unless they are explicitly asked to behave stupidly
2261 * (=strictly conform to the specs)
2262 */
2263 int strict_std_compliance;
2264 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2265 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2266 #define FF_COMPLIANCE_NORMAL 0
2267 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2268 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2269
2270 /**
2271 * error concealment flags
2272 * - encoding: unused
2273 * - decoding: Set by user.
2274 */
2275 int error_concealment;
2276 #define FF_EC_GUESS_MVS 1
2277 #define FF_EC_DEBLOCK 2
2278
2279 /**
2280 * debug
2281 * - encoding: Set by user.
2282 * - decoding: Set by user.
2283 */
2284 int debug;
2285 #define FF_DEBUG_PICT_INFO 1
2286 #define FF_DEBUG_RC 2
2287 #define FF_DEBUG_BITSTREAM 4
2288 #define FF_DEBUG_MB_TYPE 8
2289 #define FF_DEBUG_QP 16
2290 #define FF_DEBUG_MV 32
2291 #define FF_DEBUG_DCT_COEFF 0x00000040
2292 #define FF_DEBUG_SKIP 0x00000080
2293 #define FF_DEBUG_STARTCODE 0x00000100
2294 #define FF_DEBUG_PTS 0x00000200
2295 #define FF_DEBUG_ER 0x00000400
2296 #define FF_DEBUG_MMCO 0x00000800
2297 #define FF_DEBUG_BUGS 0x00001000
2298 #define FF_DEBUG_VIS_QP 0x00002000
2299 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2300 #define FF_DEBUG_BUFFERS 0x00008000
2301 #define FF_DEBUG_THREADS 0x00010000
2302
2303 /**
2304 * debug
2305 * - encoding: Set by user.
2306 * - decoding: Set by user.
2307 */
2308 int debug_mv;
2309 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2310 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2311 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2312
2313 /**
2314 * Error recognition; may misdetect some more or less valid parts as errors.
2315 * - encoding: unused
2316 * - decoding: Set by user.
2317 */
2318 int err_recognition;
2319 #define AV_EF_CRCCHECK (1<<0)
2320 #define AV_EF_BITSTREAM (1<<1)
2321 #define AV_EF_BUFFER (1<<2)
2322 #define AV_EF_EXPLODE (1<<3)
2323
2324 /**
2325 * opaque 64bit number (generally a PTS) that will be reordered and
2326 * output in AVFrame.reordered_opaque
2327 * @deprecated in favor of pkt_pts
2328 * - encoding: unused
2329 * - decoding: Set by user.
2330 */
2331 int64_t reordered_opaque;
2332
2333 /**
2334 * Hardware accelerator in use
2335 * - encoding: unused.
2336 * - decoding: Set by libavcodec
2337 */
2338 struct AVHWAccel *hwaccel;
2339
2340 /**
2341 * Hardware accelerator context.
2342 * For some hardware accelerators, a global context needs to be
2343 * provided by the user. In that case, this holds display-dependent
2344 * data Libav cannot instantiate itself. Please refer to the
2345 * Libav HW accelerator documentation to know how to fill this
2346 * is. e.g. for VA API, this is a struct vaapi_context.
2347 * - encoding: unused
2348 * - decoding: Set by user
2349 */
2350 void *hwaccel_context;
2351
2352 /**
2353 * error
2354 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2355 * - decoding: unused
2356 */
2357 uint64_t error[AV_NUM_DATA_POINTERS];
2358
2359 /**
2360 * DCT algorithm, see FF_DCT_* below
2361 * - encoding: Set by user.
2362 * - decoding: unused
2363 */
2364 int dct_algo;
2365 #define FF_DCT_AUTO 0
2366 #define FF_DCT_FASTINT 1
2367 #define FF_DCT_INT 2
2368 #define FF_DCT_MMX 3
2369 #define FF_DCT_ALTIVEC 5
2370 #define FF_DCT_FAAN 6
2371
2372 /**
2373 * IDCT algorithm, see FF_IDCT_* below.
2374 * - encoding: Set by user.
2375 * - decoding: Set by user.
2376 */
2377 int idct_algo;
2378 #define FF_IDCT_AUTO 0
2379 #define FF_IDCT_INT 1
2380 #define FF_IDCT_SIMPLE 2
2381 #define FF_IDCT_SIMPLEMMX 3
2382 #define FF_IDCT_ARM 7
2383 #define FF_IDCT_ALTIVEC 8
2384 #define FF_IDCT_SH4 9
2385 #define FF_IDCT_SIMPLEARM 10
2386 #define FF_IDCT_IPP 13
2387 #define FF_IDCT_XVIDMMX 14
2388 #define FF_IDCT_SIMPLEARMV5TE 16
2389 #define FF_IDCT_SIMPLEARMV6 17
2390 #define FF_IDCT_SIMPLEVIS 18
2391 #define FF_IDCT_FAAN 20
2392 #define FF_IDCT_SIMPLENEON 22
2393 #define FF_IDCT_SIMPLEALPHA 23
2394
2395 /**
2396 * bits per sample/pixel from the demuxer (needed for huffyuv).
2397 * - encoding: Set by libavcodec.
2398 * - decoding: Set by user.
2399 */
2400 int bits_per_coded_sample;
2401
2402 /**
2403 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2404 * - encoding: set by user.
2405 * - decoding: set by libavcodec.
2406 */
2407 int bits_per_raw_sample;
2408
2409 /**
2410 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2411 * - encoding: unused
2412 * - decoding: Set by user.
2413 */
2414 attribute_deprecated int lowres;
2415
2416 /**
2417 * the picture in the bitstream
2418 * - encoding: Set by libavcodec.
2419 * - decoding: Set by libavcodec.
2420 */
2421 AVFrame *coded_frame;
2422
2423 /**
2424 * thread count
2425 * is used to decide how many independent tasks should be passed to execute()
2426 * - encoding: Set by user.
2427 * - decoding: Set by user.
2428 */
2429 int thread_count;
2430
2431 /**
2432 * Which multithreading methods to use.
2433 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2434 * so clients which cannot provide future frames should not use it.
2435 *
2436 * - encoding: Set by user, otherwise the default is used.
2437 * - decoding: Set by user, otherwise the default is used.
2438 */
2439 int thread_type;
2440 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2441 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2442
2443 /**
2444 * Which multithreading methods are in use by the codec.
2445 * - encoding: Set by libavcodec.
2446 * - decoding: Set by libavcodec.
2447 */
2448 int active_thread_type;
2449
2450 /**
2451 * Set by the client if its custom get_buffer() callback can be called
2452 * synchronously from another thread, which allows faster multithreaded decoding.
2453 * draw_horiz_band() will be called from other threads regardless of this setting.
2454 * Ignored if the default get_buffer() is used.
2455 * - encoding: Set by user.
2456 * - decoding: Set by user.
2457 */
2458 int thread_safe_callbacks;
2459
2460 /**
2461 * The codec may call this to execute several independent things.
2462 * It will return only after finishing all tasks.
2463 * The user may replace this with some multithreaded implementation,
2464 * the default implementation will execute the parts serially.
2465 * @param count the number of things to execute
2466 * - encoding: Set by libavcodec, user can override.
2467 * - decoding: Set by libavcodec, user can override.
2468 */
2469 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2470
2471 /**
2472 * The codec may call this to execute several independent things.
2473 * It will return only after finishing all tasks.
2474 * The user may replace this with some multithreaded implementation,
2475 * the default implementation will execute the parts serially.
2476 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2477 * @param c context passed also to func
2478 * @param count the number of things to execute
2479 * @param arg2 argument passed unchanged to func
2480 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2481 * @param func function that will be called count times, with jobnr from 0 to count-1.
2482 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2483 * two instances of func executing at the same time will have the same threadnr.
2484 * @return always 0 currently, but code should handle a future improvement where when any call to func
2485 * returns < 0 no further calls to func may be done and < 0 is returned.
2486 * - encoding: Set by libavcodec, user can override.
2487 * - decoding: Set by libavcodec, user can override.
2488 */
2489 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2490
2491 /**
2492 * thread opaque
2493 * Can be used by execute() to store some per AVCodecContext stuff.
2494 * - encoding: set by execute()
2495 * - decoding: set by execute()
2496 */
2497 void *thread_opaque;
2498
2499 /**
2500 * noise vs. sse weight for the nsse comparsion function
2501 * - encoding: Set by user.
2502 * - decoding: unused
2503 */
2504 int nsse_weight;
2505
2506 /**
2507 * profile
2508 * - encoding: Set by user.
2509 * - decoding: Set by libavcodec.
2510 */
2511 int profile;
2512 #define FF_PROFILE_UNKNOWN -99
2513 #define FF_PROFILE_RESERVED -100
2514
2515 #define FF_PROFILE_AAC_MAIN 0
2516 #define FF_PROFILE_AAC_LOW 1
2517 #define FF_PROFILE_AAC_SSR 2
2518 #define FF_PROFILE_AAC_LTP 3
2519 #define FF_PROFILE_AAC_HE 4
2520 #define FF_PROFILE_AAC_HE_V2 28
2521 #define FF_PROFILE_AAC_LD 22
2522 #define FF_PROFILE_AAC_ELD 38
2523
2524 #define FF_PROFILE_DTS 20
2525 #define FF_PROFILE_DTS_ES 30
2526 #define FF_PROFILE_DTS_96_24 40
2527 #define FF_PROFILE_DTS_HD_HRA 50
2528 #define FF_PROFILE_DTS_HD_MA 60
2529
2530 #define FF_PROFILE_MPEG2_422 0
2531 #define FF_PROFILE_MPEG2_HIGH 1
2532 #define FF_PROFILE_MPEG2_SS 2
2533 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2534 #define FF_PROFILE_MPEG2_MAIN 4
2535 #define FF_PROFILE_MPEG2_SIMPLE 5
2536
2537 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2538 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2539
2540 #define FF_PROFILE_H264_BASELINE 66
2541 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2542 #define FF_PROFILE_H264_MAIN 77
2543 #define FF_PROFILE_H264_EXTENDED 88
2544 #define FF_PROFILE_H264_HIGH 100
2545 #define FF_PROFILE_H264_HIGH_10 110
2546 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2547 #define FF_PROFILE_H264_HIGH_422 122
2548 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2549 #define FF_PROFILE_H264_HIGH_444 144
2550 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2551 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2552 #define FF_PROFILE_H264_CAVLC_444 44
2553
2554 #define FF_PROFILE_VC1_SIMPLE 0
2555 #define FF_PROFILE_VC1_MAIN 1
2556 #define FF_PROFILE_VC1_COMPLEX 2
2557 #define FF_PROFILE_VC1_ADVANCED 3
2558
2559 #define FF_PROFILE_MPEG4_SIMPLE 0
2560 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2561 #define FF_PROFILE_MPEG4_CORE 2
2562 #define FF_PROFILE_MPEG4_MAIN 3
2563 #define FF_PROFILE_MPEG4_N_BIT 4
2564 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2565 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2566 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2567 #define FF_PROFILE_MPEG4_HYBRID 8
2568 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2569 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2570 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2571 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2572 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2573 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2574 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2575
2576 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2577 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2578 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2579 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2580 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2581
2582 /**
2583 * level
2584 * - encoding: Set by user.
2585 * - decoding: Set by libavcodec.
2586 */
2587 int level;
2588 #define FF_LEVEL_UNKNOWN -99
2589
2590 /**
2591 *
2592 * - encoding: unused
2593 * - decoding: Set by user.
2594 */
2595 enum AVDiscard skip_loop_filter;
2596
2597 /**
2598 *
2599 * - encoding: unused
2600 * - decoding: Set by user.
2601 */
2602 enum AVDiscard skip_idct;
2603
2604 /**
2605 *
2606 * - encoding: unused
2607 * - decoding: Set by user.
2608 */
2609 enum AVDiscard skip_frame;
2610
2611 /**
2612 * Header containing style information for text subtitles.
2613 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2614 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2615 * the Format line following. It shouldn't include any Dialogue line.
2616 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2617 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2618 */
2619 uint8_t *subtitle_header;
2620 int subtitle_header_size;
2621
2622 /**
2623 * Simulates errors in the bitstream to test error concealment.
2624 * - encoding: Set by user.
2625 * - decoding: unused
2626 */
2627 int error_rate;
2628
2629 /**
2630 * Current packet as passed into the decoder, to avoid having
2631 * to pass the packet into every function. Currently only valid
2632 * inside lavc and get/release_buffer callbacks.
2633 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2634 * - encoding: unused
2635 */
2636 AVPacket *pkt;
2637
2638 /**
2639 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2640 * Used for compliant TS muxing.
2641 * - encoding: Set by libavcodec.
2642 * - decoding: unused.
2643 */
2644 uint64_t vbv_delay;
2645 } AVCodecContext;
2646
2647 /**
2648 * AVProfile.
2649 */
2650 typedef struct AVProfile {
2651 int profile;
2652 const char *name; ///< short name for the profile
2653 } AVProfile;
2654
2655 typedef struct AVCodecDefault AVCodecDefault;
2656
2657 struct AVSubtitle;
2658
2659 /**
2660 * AVCodec.
2661 */
2662 typedef struct AVCodec {
2663 /**
2664 * Name of the codec implementation.
2665 * The name is globally unique among encoders and among decoders (but an
2666 * encoder and a decoder can share the same name).
2667 * This is the primary way to find a codec from the user perspective.
2668 */
2669 const char *name;
2670 /**
2671 * Descriptive name for the codec, meant to be more human readable than name.
2672 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2673 */
2674 const char *long_name;
2675 enum AVMediaType type;
2676 enum AVCodecID id;
2677 /**
2678 * Codec capabilities.
2679 * see CODEC_CAP_*
2680 */
2681 int capabilities;
2682 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2683 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2684 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2685 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2686 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2687 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2688 const AVClass *priv_class; ///< AVClass for the private context
2689 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2690
2691 /*****************************************************************
2692 * No fields below this line are part of the public API. They
2693 * may not be used outside of libavcodec and can be changed and
2694 * removed at will.
2695 * New public fields should be added right above.
2696 *****************************************************************
2697 */
2698 int priv_data_size;
2699 struct AVCodec *next;
2700 /**
2701 * @name Frame-level threading support functions
2702 * @{
2703 */
2704 /**
2705 * If defined, called on thread contexts when they are created.
2706 * If the codec allocates writable tables in init(), re-allocate them here.
2707 * priv_data will be set to a copy of the original.
2708 */
2709 int (*init_thread_copy)(AVCodecContext *);
2710 /**
2711 * Copy necessary context variables from a previous thread context to the current one.
2712 * If not defined, the next thread will start automatically; otherwise, the codec
2713 * must call ff_thread_finish_setup().
2714 *
2715 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2716 */
2717 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2718 /** @} */
2719
2720 /**
2721 * Private codec-specific defaults.
2722 */
2723 const AVCodecDefault *defaults;
2724
2725 /**
2726 * Initialize codec static data, called from avcodec_register().
2727 */
2728 void (*init_static_data)(struct AVCodec *codec);
2729
2730 int (*init)(AVCodecContext *);
2731 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2732 const struct AVSubtitle *sub);
2733 /**
2734 * Encode data to an AVPacket.
2735 *
2736 * @param avctx codec context
2737 * @param avpkt output AVPacket (may contain a user-provided buffer)
2738 * @param[in] frame AVFrame containing the raw data to be encoded
2739 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2740 * non-empty packet was returned in avpkt.
2741 * @return 0 on success, negative error code on failure
2742 */
2743 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2744 int *got_packet_ptr);
2745 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2746 int (*close)(AVCodecContext *);
2747 /**
2748 * Flush buffers.
2749 * Will be called when seeking
2750 */
2751 void (*flush)(AVCodecContext *);
2752 } AVCodec;
2753
2754 /**
2755 * AVHWAccel.
2756 */
2757 typedef struct AVHWAccel {
2758 /**
2759 * Name of the hardware accelerated codec.
2760 * The name is globally unique among encoders and among decoders (but an
2761 * encoder and a decoder can share the same name).
2762 */
2763 const char *name;
2764
2765 /**
2766 * Type of codec implemented by the hardware accelerator.
2767 *
2768 * See AVMEDIA_TYPE_xxx
2769 */
2770 enum AVMediaType type;
2771
2772 /**
2773 * Codec implemented by the hardware accelerator.
2774 *
2775 * See AV_CODEC_ID_xxx
2776 */
2777 enum AVCodecID id;
2778
2779 /**
2780 * Supported pixel format.
2781 *
2782 * Only hardware accelerated formats are supported here.
2783 */
2784 enum AVPixelFormat pix_fmt;
2785
2786 /**
2787 * Hardware accelerated codec capabilities.
2788 * see FF_HWACCEL_CODEC_CAP_*
2789 */
2790 int capabilities;
2791
2792 struct AVHWAccel *next;
2793
2794 /**
2795 * Called at the beginning of each frame or field picture.
2796 *
2797 * Meaningful frame information (codec specific) is guaranteed to
2798 * be parsed at this point. This function is mandatory.
2799 *
2800 * Note that buf can be NULL along with buf_size set to 0.
2801 * Otherwise, this means the whole frame is available at this point.
2802 *
2803 * @param avctx the codec context
2804 * @param buf the frame data buffer base
2805 * @param buf_size the size of the frame in bytes
2806 * @return zero if successful, a negative value otherwise
2807 */
2808 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2809
2810 /**
2811 * Callback for each slice.
2812 *
2813 * Meaningful slice information (codec specific) is guaranteed to
2814 * be parsed at this point. This function is mandatory.
2815 *
2816 * @param avctx the codec context
2817 * @param buf the slice data buffer base
2818 * @param buf_size the size of the slice in bytes
2819 * @return zero if successful, a negative value otherwise
2820 */
2821 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2822
2823 /**
2824 * Called at the end of each frame or field picture.
2825 *
2826 * The whole picture is parsed at this point and can now be sent
2827 * to the hardware accelerator. This function is mandatory.
2828 *
2829 * @param avctx the codec context
2830 * @return zero if successful, a negative value otherwise
2831 */
2832 int (*end_frame)(AVCodecContext *avctx);
2833
2834 /**
2835 * Size of HW accelerator private data.
2836 *
2837 * Private data is allocated with av_mallocz() before
2838 * AVCodecContext.get_buffer() and deallocated after
2839 * AVCodecContext.release_buffer().
2840 */
2841 int priv_data_size;
2842 } AVHWAccel;
2843
2844 /**
2845 * @defgroup lavc_picture AVPicture
2846 *
2847 * Functions for working with AVPicture
2848 * @{
2849 */
2850
2851 /**
2852 * four components are given, that's all.
2853 * the last component is alpha
2854 */
2855 typedef struct AVPicture {
2856 uint8_t *data[AV_NUM_DATA_POINTERS];
2857 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2858 } AVPicture;
2859
2860 /**
2861 * @}
2862 */
2863
2864 #define AVPALETTE_SIZE 1024
2865 #define AVPALETTE_COUNT 256
2866
2867 enum AVSubtitleType {
2868 SUBTITLE_NONE,
2869
2870 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2871
2872 /**
2873 * Plain text, the text field must be set by the decoder and is
2874 * authoritative. ass and pict fields may contain approximations.
2875 */
2876 SUBTITLE_TEXT,
2877
2878 /**
2879 * Formatted text, the ass field must be set by the decoder and is
2880 * authoritative. pict and text fields may contain approximations.
2881 */
2882 SUBTITLE_ASS,
2883 };
2884
2885 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2886
2887 typedef struct AVSubtitleRect {
2888 int x; ///< top left corner of pict, undefined when pict is not set
2889 int y; ///< top left corner of pict, undefined when pict is not set
2890 int w; ///< width of pict, undefined when pict is not set
2891 int h; ///< height of pict, undefined when pict is not set
2892 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2893
2894 /**
2895 * data+linesize for the bitmap of this subtitle.
2896 * can be set for text/ass as well once they where rendered
2897 */
2898 AVPicture pict;
2899 enum AVSubtitleType type;
2900
2901 char *text; ///< 0 terminated plain UTF-8 text
2902
2903 /**
2904 * 0 terminated ASS/SSA compatible event line.
2905 * The pressentation of this is unaffected by the other values in this
2906 * struct.
2907 */
2908 char *ass;
2909 int flags;
2910 } AVSubtitleRect;
2911
2912 typedef struct AVSubtitle {
2913 uint16_t format; /* 0 = graphics */
2914 uint32_t start_display_time; /* relative to packet pts, in ms */
2915 uint32_t end_display_time; /* relative to packet pts, in ms */
2916 unsigned num_rects;
2917 AVSubtitleRect **rects;
2918 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2919 } AVSubtitle;
2920
2921 /**
2922 * If c is NULL, returns the first registered codec,
2923 * if c is non-NULL, returns the next registered codec after c,
2924 * or NULL if c is the last one.
2925 */
2926 AVCodec *av_codec_next(const AVCodec *c);
2927
2928 /**
2929 * Return the LIBAVCODEC_VERSION_INT constant.
2930 */
2931 unsigned avcodec_version(void);
2932
2933 /**
2934 * Return the libavcodec build-time configuration.
2935 */
2936 const char *avcodec_configuration(void);
2937
2938 /**
2939 * Return the libavcodec license.
2940 */
2941 const char *avcodec_license(void);
2942
2943 /**
2944 * Register the codec codec and initialize libavcodec.
2945 *
2946 * @warning either this function or avcodec_register_all() must be called
2947 * before any other libavcodec functions.
2948 *
2949 * @see avcodec_register_all()
2950 */
2951 void avcodec_register(AVCodec *codec);
2952
2953 /**
2954 * Register all the codecs, parsers and bitstream filters which were enabled at
2955 * configuration time. If you do not call this function you can select exactly
2956 * which formats you want to support, by using the individual registration
2957 * functions.
2958 *
2959 * @see avcodec_register
2960 * @see av_register_codec_parser
2961 * @see av_register_bitstream_filter
2962 */
2963 void avcodec_register_all(void);
2964
2965 /**
2966 * Allocate an AVCodecContext and set its fields to default values. The
2967 * resulting struct can be deallocated by calling avcodec_close() on it followed
2968 * by av_free().
2969 *
2970 * @param codec if non-NULL, allocate private data and initialize defaults
2971 * for the given codec. It is illegal to then call avcodec_open2()
2972 * with a different codec.
2973 * If NULL, then the codec-specific defaults won't be initialized,
2974 * which may result in suboptimal default settings (this is
2975 * important mainly for encoders, e.g. libx264).
2976 *
2977 * @return An AVCodecContext filled with default values or NULL on failure.
2978 * @see avcodec_get_context_defaults
2979 */
2980 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
2981
2982 /**
2983 * Set the fields of the given AVCodecContext to default values corresponding
2984 * to the given codec (defaults may be codec-dependent).
2985 *
2986 * Do not call this function if a non-NULL codec has been passed
2987 * to avcodec_alloc_context3() that allocated this AVCodecContext.
2988 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
2989 * different codec on this AVCodecContext.
2990 */
2991 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
2992
2993 /**
2994 * Get the AVClass for AVCodecContext. It can be used in combination with
2995 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2996 *
2997 * @see av_opt_find().
2998 */
2999 const AVClass *avcodec_get_class(void);
3000
3001 /**
3002 * Copy the settings of the source AVCodecContext into the destination
3003 * AVCodecContext. The resulting destination codec context will be
3004 * unopened, i.e. you are required to call avcodec_open2() before you
3005 * can use this AVCodecContext to decode/encode video/audio data.
3006 *
3007 * @param dest target codec context, should be initialized with
3008 * avcodec_alloc_context3(), but otherwise uninitialized
3009 * @param src source codec context
3010 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3011 */
3012 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3013
3014 /**
3015 * Allocate an AVFrame and set its fields to default values. The resulting
3016 * struct must be freed using avcodec_free_frame().
3017 *
3018 * @return An AVFrame filled with default values or NULL on failure.
3019 * @see avcodec_get_frame_defaults
3020 */
3021 AVFrame *avcodec_alloc_frame(void);
3022
3023 /**
3024 * Set the fields of the given AVFrame to default values.
3025 *
3026 * @param frame The AVFrame of which the fields should be set to default values.
3027 */
3028 void avcodec_get_frame_defaults(AVFrame *frame);
3029
3030 /**
3031 * Free the frame and any dynamically allocated objects in it,
3032 * e.g. extended_data.
3033 *
3034 * @param frame frame to be freed. The pointer will be set to NULL.
3035 *
3036 * @warning this function does NOT free the data buffers themselves
3037 * (it does not know how, since they might have been allocated with
3038 * a custom get_buffer()).
3039 */
3040 void avcodec_free_frame(AVFrame **frame);
3041
3042 /**
3043 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3044 * function the context has to be allocated with avcodec_alloc_context3().
3045 *
3046 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3047 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3048 * retrieving a codec.
3049 *
3050 * @warning This function is not thread safe!
3051 *
3052 * @code
3053 * avcodec_register_all();
3054 * av_dict_set(&opts, "b", "2.5M", 0);
3055 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3056 * if (!codec)
3057 * exit(1);
3058 *
3059 * context = avcodec_alloc_context3(codec);
3060 *
3061 * if (avcodec_open2(context, codec, opts) < 0)
3062 * exit(1);
3063 * @endcode
3064 *
3065 * @param avctx The context to initialize.
3066 * @param codec The codec to open this context for. If a non-NULL codec has been
3067 * previously passed to avcodec_alloc_context3() or
3068 * avcodec_get_context_defaults3() for this context, then this
3069 * parameter MUST be either NULL or equal to the previously passed
3070 * codec.
3071 * @param options A dictionary filled with AVCodecContext and codec-private options.
3072 * On return this object will be filled with options that were not found.
3073 *
3074 * @return zero on success, a negative value on error
3075 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3076 * av_dict_set(), av_opt_find().
3077 */
3078 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3079
3080 /**
3081 * Close a given AVCodecContext and free all the data associated with it
3082 * (but not the AVCodecContext itself).
3083 *
3084 * Calling this function on an AVCodecContext that hasn't been opened will free
3085 * the codec-specific data allocated in avcodec_alloc_context3() /
3086 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3087 * do nothing.
3088 */
3089 int avcodec_close(AVCodecContext *avctx);
3090
3091 /**
3092 * Free all allocated data in the given subtitle struct.
3093 *
3094 * @param sub AVSubtitle to free.
3095 */
3096 void avsubtitle_free(AVSubtitle *sub);
3097
3098 /**
3099 * @}
3100 */
3101
3102 /**
3103 * @addtogroup lavc_packet
3104 * @{
3105 */
3106
3107 #if FF_API_DESTRUCT_PACKET
3108 /**
3109 * Default packet destructor.
3110 * @deprecated use the AVBuffer API instead
3111 */
3112 attribute_deprecated
3113 void av_destruct_packet(AVPacket *pkt);
3114 #endif
3115
3116 /**
3117 * Initialize optional fields of a packet with default values.
3118 *
3119 * Note, this does not touch the data and size members, which have to be
3120 * initialized separately.
3121 *
3122 * @param pkt packet
3123 */
3124 void av_init_packet(AVPacket *pkt);
3125
3126 /**
3127 * Allocate the payload of a packet and initialize its fields with
3128 * default values.
3129 *
3130 * @param pkt packet
3131 * @param size wanted payload size
3132 * @return 0 if OK, AVERROR_xxx otherwise
3133 */
3134 int av_new_packet(AVPacket *pkt, int size);
3135
3136 /**
3137 * Reduce packet size, correctly zeroing padding
3138 *
3139 * @param pkt packet
3140 * @param size new size
3141 */
3142 void av_shrink_packet(AVPacket *pkt, int size);
3143
3144 /**
3145 * Increase packet size, correctly zeroing padding
3146 *
3147 * @param pkt packet
3148 * @param grow_by number of bytes by which to increase the size of the packet
3149 */
3150 int av_grow_packet(AVPacket *pkt, int grow_by);
3151
3152 /**
3153 * Initialize a reference-counted packet from av_malloc()ed data.
3154 *
3155 * @param pkt packet to be initialized. This function will set the data, size,
3156 * buf and destruct fields, all others are left untouched.
3157 * @param data Data allocated by av_malloc() to be used as packet data. If this
3158 * function returns successfully, the data is owned by the underlying AVBuffer.
3159 * The caller may not access the data through other means.
3160 * @param size size of data in bytes, without the padding. I.e. the full buffer
3161 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3162 *
3163 * @return 0 on success, a negative AVERROR on error
3164 */
3165 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3166
3167 /**
3168 * @warning This is a hack - the packet memory allocation stuff is broken. The
3169 * packet is allocated if it was not really allocated.
3170 */
3171 int av_dup_packet(AVPacket *pkt);
3172
3173 /**
3174 * Free a packet.
3175 *
3176 * @param pkt packet to free
3177 */
3178 void av_free_packet(AVPacket *pkt);
3179
3180 /**
3181 * Allocate new information of a packet.
3182 *
3183 * @param pkt packet
3184 * @param type side information type
3185 * @param size side information size
3186 * @return pointer to fresh allocated data or NULL otherwise
3187 */
3188 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3189 int size);
3190
3191 /**
3192 * Shrink the already allocated side data buffer
3193 *
3194 * @param pkt packet
3195 * @param type side information type
3196 * @param size new side information size
3197 * @return 0 on success, < 0 on failure
3198 */
3199 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3200 int size);
3201
3202 /**
3203 * Get side information from packet.
3204 *
3205 * @param pkt packet
3206 * @param type desired side information type
3207 * @param size pointer for side information size to store (optional)
3208 * @return pointer to data if present or NULL otherwise
3209 */
3210 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3211 int *size);
3212
3213 /**
3214 * @}
3215 */
3216
3217 /**
3218 * @addtogroup lavc_decoding
3219 * @{
3220 */
3221
3222 /**
3223 * Find a registered decoder with a matching codec ID.
3224 *
3225 * @param id AVCodecID of the requested decoder
3226 * @return A decoder if one was found, NULL otherwise.
3227 */
3228 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3229
3230 /**
3231 * Find a registered decoder with the specified name.
3232 *
3233 * @param name name of the requested decoder
3234 * @return A decoder if one was found, NULL otherwise.
3235 */
3236 AVCodec *avcodec_find_decoder_by_name(const char *name);
3237
3238 #if FF_API_GET_BUFFER
3239 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3240 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3241 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3242 #endif
3243
3244 /**
3245 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3246 * it can be called by custom get_buffer2() implementations for decoders without
3247 * CODEC_CAP_DR1 set.
3248 */
3249 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3250
3251 /**
3252 * Return the amount of padding in pixels which the get_buffer callback must
3253 * provide around the edge of the image for codecs which do not have the
3254 * CODEC_FLAG_EMU_EDGE flag.
3255 *
3256 * @return Required padding in pixels.
3257 */
3258 unsigned avcodec_get_edge_width(void);
3259
3260 /**
3261 * Modify width and height values so that they will result in a memory
3262 * buffer that is acceptable for the codec if you do not use any horizontal
3263 * padding.
3264 *
3265 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3266 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3267 * according to avcodec_get_edge_width() before.
3268 */
3269 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3270
3271 /**
3272 * Modify width and height values so that they will result in a memory
3273 * buffer that is acceptable for the codec if you also ensure that all
3274 * line sizes are a multiple of the respective linesize_align[i].
3275 *
3276 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3277 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3278 * according to avcodec_get_edge_width() before.
3279 */
3280 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3281 int linesize_align[AV_NUM_DATA_POINTERS]);
3282
3283 /**
3284 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3285 *
3286 * Some decoders may support multiple frames in a single AVPacket. Such
3287 * decoders would then just decode the first frame. In this case,
3288 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3289 * the remaining data in order to decode the second frame, etc...
3290 * Even if no frames are returned, the packet needs to be fed to the decoder
3291 * with remaining data until it is completely consumed or an error occurs.
3292 *
3293 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3294 * larger than the actual read bytes because some optimized bitstream
3295 * readers read 32 or 64 bits at once and could read over the end.
3296 *
3297 * @note You might have to align the input buffer. The alignment requirements
3298 * depend on the CPU and the decoder.
3299 *
3300 * @param avctx the codec context
3301 * @param[out] frame The AVFrame in which to store decoded audio samples.
3302 * The decoder will allocate a buffer for the decoded frame by
3303 * calling the AVCodecContext.get_buffer2() callback.
3304 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3305 * reference counted and the returned reference belongs to the
3306 * caller. The caller must release the frame using av_frame_unref()
3307 * when the frame is no longer needed. The caller may safely write
3308 * to the frame if av_frame_is_writable() returns 1.
3309 * When AVCodecContext.refcounted_frames is set to 0, the returned
3310 * reference belongs to the decoder and is valid only until the
3311 * next call to this function or until closing the decoder.
3312 * The caller may not write to it.
3313 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3314 * non-zero.
3315 * @param[in] avpkt The input AVPacket containing the input buffer.
3316 * At least avpkt->data and avpkt->size should be set. Some
3317 * decoders might also require additional fields to be set.
3318 * @return A negative error code is returned if an error occurred during
3319 * decoding, otherwise the number of bytes consumed from the input
3320 * AVPacket is returned.
3321 */
3322 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3323 int *got_frame_ptr, AVPacket *avpkt);
3324
3325 /**
3326 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3327 * Some decoders may support multiple frames in a single AVPacket, such
3328 * decoders would then just decode the first frame.
3329 *
3330 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3331 * the actual read bytes because some optimized bitstream readers read 32 or 64
3332 * bits at once and could read over the end.
3333 *
3334 * @warning The end of the input buffer buf should be set to 0 to ensure that
3335 * no overreading happens for damaged MPEG streams.
3336 *
3337 * @note You might have to align the input buffer avpkt->data.
3338 * The alignment requirements depend on the CPU: on some CPUs it isn't
3339 * necessary at all, on others it won't work at all if not aligned and on others
3340 * it will work but it will have an impact on performance.
3341 *
3342 * In practice, avpkt->data should have 4 byte alignment at minimum.
3343 *
3344 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3345 * between input and output, these need to be fed with avpkt->data=NULL,
3346 * avpkt->size=0 at the end to return the remaining frames.
3347 *
3348 * @param avctx the codec context
3349 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3350 * Use av_frame_alloc() to get an AVFrame. The codec will
3351 * allocate memory for the actual bitmap by calling the
3352 * AVCodecContext.get_buffer2() callback.
3353 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3354 * reference counted and the returned reference belongs to the
3355 * caller. The caller must release the frame using av_frame_unref()
3356 * when the frame is no longer needed. The caller may safely write
3357 * to the frame if av_frame_is_writable() returns 1.
3358 * When AVCodecContext.refcounted_frames is set to 0, the returned
3359 * reference belongs to the decoder and is valid only until the
3360 * next call to this function or until closing the decoder. The
3361 * caller may not write to it.
3362 *
3363 * @param[in] avpkt The input AVpacket containing the input buffer.
3364 * You can create such packet with av_init_packet() and by then setting
3365 * data and size, some decoders might in addition need other fields like
3366 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3367 * fields possible.
3368 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3369 * @return On error a negative value is returned, otherwise the number of bytes
3370 * used or zero if no frame could be decompressed.
3371 */
3372 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3373 int *got_picture_ptr,
3374 AVPacket *avpkt);
3375
3376 /**
3377 * Decode a subtitle message.
3378 * Return a negative value on error, otherwise return the number of bytes used.
3379 * If no subtitle could be decompressed, got_sub_ptr is zero.
3380 * Otherwise, the subtitle is stored in *sub.
3381 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3382 * simplicity, because the performance difference is expect to be negligible
3383 * and reusing a get_buffer written for video codecs would probably perform badly
3384 * due to a potentially very different allocation pattern.
3385 *
3386 * @param avctx the codec context
3387 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3388 freed with avsubtitle_free if *got_sub_ptr is set.
3389 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3390 * @param[in] avpkt The input AVPacket containing the input buffer.
3391 */
3392 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3393 int *got_sub_ptr,
3394 AVPacket *avpkt);
3395
3396 /**
3397 * @defgroup lavc_parsing Frame parsing
3398 * @{
3399 */
3400
3401 typedef struct AVCodecParserContext {
3402 void *priv_data;
3403 struct AVCodecParser *parser;
3404 int64_t frame_offset; /* offset of the current frame */
3405 int64_t cur_offset; /* current offset
3406 (incremented by each av_parser_parse()) */
3407 int64_t next_frame_offset; /* offset of the next frame */
3408 /* video info */
3409 int pict_type; /* XXX: Put it back in AVCodecContext. */
3410 /**
3411 * This field is used for proper frame duration computation in lavf.
3412 * It signals, how much longer the frame duration of the current frame
3413 * is compared to normal frame duration.
3414 *
3415 * frame_duration = (1 + repeat_pict) * time_base
3416 *
3417 * It is used by codecs like H.264 to display telecined material.
3418 */
3419 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3420 int64_t pts; /* pts of the current frame */
3421 int64_t dts; /* dts of the current frame */
3422
3423 /* private data */
3424 int64_t last_pts;
3425 int64_t last_dts;
3426 int fetch_timestamp;
3427
3428 #define AV_PARSER_PTS_NB 4
3429 int cur_frame_start_index;
3430 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3431 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3432 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3433
3434 int flags;
3435 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3436 #define PARSER_FLAG_ONCE 0x0002
3437 /// Set if the parser has a valid file offset
3438 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3439
3440 int64_t offset; ///< byte offset from starting packet start
3441 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3442
3443 /**
3444 * Set by parser to 1 for key frames and 0 for non-key frames.
3445 * It is initialized to -1, so if the parser doesn't set this flag,
3446 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3447 * will be used.
3448 */
3449 int key_frame;
3450
3451 /**
3452 * Time difference in stream time base units from the pts of this
3453 * packet to the point at which the output from the decoder has converged
3454 * independent from the availability of previous frames. That is, the
3455 * frames are virtually identical no matter if decoding started from
3456 * the very first frame or from this keyframe.
3457 * Is AV_NOPTS_VALUE if unknown.
3458 * This field is not the display duration of the current frame.
3459 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3460 * set.
3461 *
3462 * The purpose of this field is to allow seeking in streams that have no
3463 * keyframes in the conventional sense. It corresponds to the
3464 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3465 * essential for some types of subtitle streams to ensure that all
3466 * subtitles are correctly displayed after seeking.
3467 */
3468 int64_t convergence_duration;
3469
3470 // Timestamp generation support:
3471 /**
3472 * Synchronization point for start of timestamp generation.
3473 *
3474 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3475 * (default).
3476 *
3477 * For example, this corresponds to presence of H.264 buffering period
3478 * SEI message.
3479 */
3480 int dts_sync_point;
3481
3482 /**
3483 * Offset of the current timestamp against last timestamp sync point in
3484 * units of AVCodecContext.time_base.
3485 *
3486 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3487 * contain a valid timestamp offset.
3488 *
3489 * Note that the timestamp of sync point has usually a nonzero
3490 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3491 * the next frame after timestamp sync point will be usually 1.
3492 *
3493 * For example, this corresponds to H.264 cpb_removal_delay.
3494 */
3495 int dts_ref_dts_delta;
3496
3497 /**
3498 * Presentation delay of current frame in units of AVCodecContext.time_base.
3499 *
3500 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3501 * contain valid non-negative timestamp delta (presentation time of a frame
3502 * must not lie in the past).
3503 *
3504 * This delay represents the difference between decoding and presentation
3505 * time of the frame.
3506 *
3507 * For example, this corresponds to H.264 dpb_output_delay.
3508 */
3509 int pts_dts_delta;
3510
3511 /**
3512 * Position of the packet in file.
3513 *
3514 * Analogous to cur_frame_pts/dts
3515 */
3516 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3517
3518 /**
3519 * Byte position of currently parsed frame in stream.
3520 */
3521 int64_t pos;
3522
3523 /**
3524 * Previous frame byte position.
3525 */
3526 int64_t last_pos;
3527
3528 /**
3529 * Duration of the current frame.
3530 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3531 * For all other types, this is in units of AVCodecContext.time_base.
3532 */
3533 int duration;
3534 } AVCodecParserContext;
3535
3536 typedef struct AVCodecParser {
3537 int codec_ids[5]; /* several codec IDs are permitted */
3538 int priv_data_size;
3539 int (*parser_init)(AVCodecParserContext *s);
3540 int (*parser_parse)(AVCodecParserContext *s,
3541 AVCodecContext *avctx,
3542 const uint8_t **poutbuf, int *poutbuf_size,
3543 const uint8_t *buf, int buf_size);
3544 void (*parser_close)(AVCodecParserContext *s);
3545 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3546 struct AVCodecParser *next;
3547 } AVCodecParser;
3548
3549 AVCodecParser *av_parser_next(AVCodecParser *c);
3550
3551 void av_register_codec_parser(AVCodecParser *parser);
3552 AVCodecParserContext *av_parser_init(int codec_id);
3553
3554 /**
3555 * Parse a packet.
3556 *
3557 * @param s parser context.
3558 * @param avctx codec context.
3559 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3560 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3561 * @param buf input buffer.
3562 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3563 * @param pts input presentation timestamp.
3564 * @param dts input decoding timestamp.
3565 * @param pos input byte position in stream.
3566 * @return the number of bytes of the input bitstream used.
3567 *
3568 * Example:
3569 * @code
3570 * while(in_len){
3571 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3572 * in_data, in_len,
3573 * pts, dts, pos);
3574 * in_data += len;
3575 * in_len -= len;
3576 *
3577 * if(size)
3578 * decode_frame(data, size);
3579 * }
3580 * @endcode
3581 */
3582 int av_parser_parse2(AVCodecParserContext *s,
3583 AVCodecContext *avctx,
3584 uint8_t **poutbuf, int *poutbuf_size,
3585 const uint8_t *buf, int buf_size,
3586 int64_t pts, int64_t dts,
3587 int64_t pos);
3588
3589 /**
3590 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3591 * @deprecated use AVBitstreamFilter
3592 */
3593 int av_parser_change(AVCodecParserContext *s,
3594 AVCodecContext *avctx,
3595 uint8_t **poutbuf, int *poutbuf_size,
3596 const uint8_t *buf, int buf_size, int keyframe);
3597 void av_parser_close(AVCodecParserContext *s);
3598
3599 /**
3600 * @}
3601 * @}
3602 */
3603
3604 /**
3605 * @addtogroup lavc_encoding
3606 * @{
3607 */
3608
3609 /**
3610 * Find a registered encoder with a matching codec ID.
3611 *
3612 * @param id AVCodecID of the requested encoder
3613 * @return An encoder if one was found, NULL otherwise.
3614 */
3615 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3616
3617 /**
3618 * Find a registered encoder with the specified name.
3619 *
3620 * @param name name of the requested encoder
3621 * @return An encoder if one was found, NULL otherwise.
3622 */
3623 AVCodec *avcodec_find_encoder_by_name(const char *name);
3624
3625 /**
3626 * Encode a frame of audio.
3627 *
3628 * Takes input samples from frame and writes the next output packet, if
3629 * available, to avpkt. The output packet does not necessarily contain data for
3630 * the most recent frame, as encoders can delay, split, and combine input frames
3631 * internally as needed.
3632 *
3633 * @param avctx codec context
3634 * @param avpkt output AVPacket.
3635 * The user can supply an output buffer by setting
3636 * avpkt->data and avpkt->size prior to calling the
3637 * function, but if the size of the user-provided data is not
3638 * large enough, encoding will fail. All other AVPacket fields
3639 * will be reset by the encoder using av_init_packet(). If
3640 * avpkt->data is NULL, the encoder will allocate it.
3641 * The encoder will set avpkt->size to the size of the
3642 * output packet.
3643 *
3644 * If this function fails or produces no output, avpkt will be
3645 * freed using av_free_packet() (i.e. avpkt->destruct will be
3646 * called to free the user supplied buffer).
3647 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3648 * May be NULL when flushing an encoder that has the
3649 * CODEC_CAP_DELAY capability set.
3650 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3651 * can have any number of samples.
3652 * If it is not set, frame->nb_samples must be equal to
3653 * avctx->frame_size for all frames except the last.
3654 * The final frame may be smaller than avctx->frame_size.
3655 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3656 * output packet is non-empty, and to 0 if it is
3657 * empty. If the function returns an error, the
3658 * packet can be assumed to be invalid, and the
3659 * value of got_packet_ptr is undefined and should
3660 * not be used.
3661 * @return 0 on success, negative error code on failure
3662 */
3663 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3664 const AVFrame *frame, int *got_packet_ptr);
3665
3666 /**
3667 * Encode a frame of video.
3668 *
3669 * Takes input raw video data from frame and writes the next output packet, if
3670 * available, to avpkt. The output packet does not necessarily contain data for
3671 * the most recent frame, as encoders can delay and reorder input frames
3672 * internally as needed.
3673 *
3674 * @param avctx codec context
3675 * @param avpkt output AVPacket.
3676 * The user can supply an output buffer by setting
3677 * avpkt->data and avpkt->size prior to calling the
3678 * function, but if the size of the user-provided data is not
3679 * large enough, encoding will fail. All other AVPacket fields
3680 * will be reset by the encoder using av_init_packet(). If
3681 * avpkt->data is NULL, the encoder will allocate it.
3682 * The encoder will set avpkt->size to the size of the
3683 * output packet. The returned data (if any) belongs to the
3684 * caller, he is responsible for freeing it.
3685 *
3686 * If this function fails or produces no output, avpkt will be
3687 * freed using av_free_packet() (i.e. avpkt->destruct will be
3688 * called to free the user supplied buffer).
3689 * @param[in] frame AVFrame containing the raw video data to be encoded.
3690 * May be NULL when flushing an encoder that has the
3691 * CODEC_CAP_DELAY capability set.
3692 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3693 * output packet is non-empty, and to 0 if it is
3694 * empty. If the function returns an error, the
3695 * packet can be assumed to be invalid, and the
3696 * value of got_packet_ptr is undefined and should
3697 * not be used.
3698 * @return 0 on success, negative error code on failure
3699 */
3700 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3701 const AVFrame *frame, int *got_packet_ptr);
3702
3703 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3704 const AVSubtitle *sub);
3705
3706
3707 /**
3708 * @}
3709 */
3710
3711 /**
3712 * @addtogroup lavc_picture
3713 * @{
3714 */
3715
3716 /**
3717 * Allocate memory for a picture. Call avpicture_free() to free it.
3718 *
3719 * @see avpicture_fill()
3720 *
3721 * @param picture the picture to be filled in
3722 * @param pix_fmt the format of the picture
3723 * @param width the width of the picture
3724 * @param height the height of the picture
3725 * @return zero if successful, a negative value if not
3726 */
3727 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3728
3729 /**
3730 * Free a picture previously allocated by avpicture_alloc().
3731 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3732 * itself is not.
3733 *
3734 * @param picture the AVPicture to be freed
3735 */
3736 void avpicture_free(AVPicture *picture);
3737
3738 /**
3739 * Fill in the AVPicture fields.
3740 * The fields of the given AVPicture are filled in by using the 'ptr' address
3741 * which points to the image data buffer. Depending on the specified picture
3742 * format, one or multiple image data pointers and line sizes will be set.
3743 * If a planar format is specified, several pointers will be set pointing to
3744 * the different picture planes and the line sizes of the different planes
3745 * will be stored in the lines_sizes array.
3746 * Call with ptr == NULL to get the required size for the ptr buffer.
3747 *
3748 * To allocate the buffer and fill in the AVPicture fields in one call,
3749 * use avpicture_alloc().
3750 *
3751 * @param picture AVPicture whose fields are to be filled in
3752 * @param ptr Buffer which will contain or contains the actual image data
3753 * @param pix_fmt The format in which the picture data is stored.
3754 * @param width the width of the image in pixels
3755 * @param height the height of the image in pixels
3756 * @return size of the image data in bytes
3757 */
3758 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3759 enum AVPixelFormat pix_fmt, int width, int height);
3760
3761 /**
3762 * Copy pixel data from an AVPicture into a buffer.
3763 * The data is stored compactly, without any gaps for alignment or padding
3764 * which may be applied by avpicture_fill().
3765 *
3766 * @see avpicture_get_size()
3767 *
3768 * @param[in] src AVPicture containing image data
3769 * @param[in] pix_fmt The format in which the picture data is stored.
3770 * @param[in] width the width of the image in pixels.
3771 * @param[in] height the height of the image in pixels.
3772 * @param[out] dest A buffer into which picture data will be copied.
3773 * @param[in] dest_size The size of 'dest'.
3774 * @return The number of bytes written to dest, or a negative value (error code) on error.
3775 */
3776 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3777 int width, int height,
3778 unsigned char *dest, int dest_size);
3779
3780 /**
3781 * Calculate the size in bytes that a picture of the given width and height
3782 * would occupy if stored in the given picture format.
3783 * Note that this returns the size of a compact representation as generated
3784 * by avpicture_layout(), which can be smaller than the size required for e.g.
3785 * avpicture_fill().
3786 *
3787 * @param pix_fmt the given picture format
3788 * @param width the width of the image
3789 * @param height the height of the image
3790 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3791 */
3792 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3793
3794 #if FF_API_DEINTERLACE
3795 /**
3796 * deinterlace - if not supported return -1
3797 *
3798 * @deprecated - use yadif (in libavfilter) instead
3799 */
3800 attribute_deprecated
3801 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3802 enum AVPixelFormat pix_fmt, int width, int height);
3803 #endif
3804 /**
3805 * Copy image src to dst. Wraps av_picture_data_copy() above.
3806 */
3807 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3808 enum AVPixelFormat pix_fmt, int width, int height);
3809
3810 /**
3811 * Crop image top and left side.
3812 */
3813 int av_picture_crop