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