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