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