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