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