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