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