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