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