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