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