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