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