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