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