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