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