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