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