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