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