avcodec: rename the AV1 profiles
[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/**
fa384dcc 903 * Pan Scan area.
f5bccd85
DB
904 * This specifies the area which should be displayed.
905 * Note there may be multiple such areas for one frame.
fa384dcc
MN
906 */
907typedef struct AVPanScan{
908 /**
f5bccd85
DB
909 * id
910 * - encoding: Set by user.
911 * - decoding: Set by libavcodec.
fa384dcc
MN
912 */
913 int id;
914
915 /**
916 * width and height in 1/16 pel
f5bccd85
DB
917 * - encoding: Set by user.
918 * - decoding: Set by libavcodec.
fa384dcc
MN
919 */
920 int width;
921 int height;
922
923 /**
f5bccd85
DB
924 * position of the top left corner in 1/16 pel for up to 3 fields/frames
925 * - encoding: Set by user.
926 * - decoding: Set by libavcodec.
fa384dcc
MN
927 */
928 int16_t position[3][2];
929}AVPanScan;
930
f0b769c1
AK
931/**
932 * This structure describes the bitrate properties of an encoded bitstream. It
933 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
934 * parameters for H.264/HEVC.
935 */
936typedef struct AVCPBProperties {
937 /**
938 * Maximum bitrate of the stream, in bits per second.
939 * Zero if unknown or unspecified.
940 */
941 int max_bitrate;
942 /**
943 * Minimum bitrate of the stream, in bits per second.
944 * Zero if unknown or unspecified.
945 */
946 int min_bitrate;
947 /**
948 * Average bitrate of the stream, in bits per second.
949 * Zero if unknown or unspecified.
950 */
951 int avg_bitrate;
952
953 /**
954 * The size of the buffer to which the ratecontrol is applied, in bits.
955 * Zero if unknown or unspecified.
956 */
957 int buffer_size;
958
959 /**
960 * The delay between the time the packet this structure is associated with
961 * is received and the time when it should be decoded, in periods of a 27MHz
962 * clock.
963 *
964 * UINT64_MAX when unknown or unspecified.
965 */
966 uint64_t vbv_delay;
967} AVCPBProperties;
968
759001c5
AK
969/**
970 * The decoder will keep a reference to the frame and may reuse it later.
971 */
972#define AV_GET_BUFFER_FLAG_REF (1 << 0)
074c4ca7 973
30f3f625
AK
974/**
975 * @defgroup lavc_packet AVPacket
976 *
977 * Types and functions for working with AVPacket.
978 * @{
979 */
4de339e2 980enum AVPacketSideDataType {
b8d5070d
VG
981 /**
982 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
983 * bytes worth of palette. This side data signals that a new palette is
984 * present.
985 */
4de339e2 986 AV_PKT_DATA_PALETTE,
75872d77
VG
987
988 /**
989 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
990 * that the extradata buffer was changed and the receiving side should
991 * act upon it appropriately. The new extradata is embedded in the side
992 * data buffer and should be immediately used for processing the current
993 * frame or packet.
994 */
195c123c 995 AV_PKT_DATA_NEW_EXTRADATA,
30f3f625
AK
996
997 /**
998 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
199ada49 999 * @code
30f3f625
AK
1000 * u32le param_flags
1001 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1002 * s32le channel_count
1003 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1004 * u64le channel_layout
1005 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1006 * s32le sample_rate
1007 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1008 * s32le width
1009 * s32le height
199ada49 1010 * @endcode
30f3f625 1011 */
fe75dc85 1012 AV_PKT_DATA_PARAM_CHANGE,
30f3f625
AK
1013
1014 /**
1015 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1016 * structures with info about macroblocks relevant to splitting the
1017 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1018 * That is, it does not necessarily contain info about all macroblocks,
1019 * as long as the distance between macroblocks in the info is smaller
1020 * than the target payload size.
1021 * Each MB info structure is 12 bytes, and is laid out as follows:
199ada49 1022 * @code
30f3f625
AK
1023 * u32le bit offset from the start of the packet
1024 * u8 current quantizer at the start of the macroblock
1025 * u8 GOB number
1026 * u16le macroblock address within the GOB
1027 * u8 horizontal MV predictor
1028 * u8 vertical MV predictor
1029 * u8 horizontal MV predictor for block number 3
1030 * u8 vertical MV predictor for block number 3
199ada49 1031 * @endcode
30f3f625 1032 */
bdc1220e 1033 AV_PKT_DATA_H263_MB_INFO,
5a7e35dd
AK
1034
1035 /**
1036 * This side data should be associated with an audio stream and contains
1037 * ReplayGain information in form of the AVReplayGain struct.
1038 */
1039 AV_PKT_DATA_REPLAYGAIN,
bddd8cbf
VG
1040
1041 /**
1042 * This side data contains a 3x3 transformation matrix describing an affine
1043 * transformation that needs to be applied to the decoded video frames for
1044 * correct presentation.
1045 *
1046 * See libavutil/display.h for a detailed description of the data.
1047 */
1048 AV_PKT_DATA_DISPLAYMATRIX,
93014864 1049
37c46743 1050 /**
93014864
VG
1051 * This side data should be associated with a video stream and contains
1052 * Stereoscopic 3D information in form of the AVStereo3D struct.
1053 */
1054 AV_PKT_DATA_STEREO3D,
728685f3
AK
1055
1056 /**
1057 * This side data should be associated with an audio stream and corresponds
1058 * to enum AVAudioServiceType.
1059 */
1060 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
5d3addb9
VG
1061
1062 /**
1063 * This side data contains an integer value representing the quality
1064 * factor of the compressed frame. Allowed range is between 1 (good)
1065 * and FF_LAMBDA_MAX (bad).
1066 */
1067 AV_PKT_DATA_QUALITY_FACTOR,
79ae1e63
JS
1068
1069 /**
1070 * This side data contains an integer value representing the stream index
1071 * of a "fallback" track. A fallback track indicates an alternate
1072 * track to use when the current track can not be decoded for some reason.
1073 * e.g. no decoder available for codec.
1074 */
1075 AV_PKT_DATA_FALLBACK_TRACK,
f0b769c1
AK
1076
1077 /**
1078 * This side data corresponds to the AVCPBProperties struct.
1079 */
1080 AV_PKT_DATA_CPB_PROPERTIES,
2fb6acd9
VG
1081
1082 /**
1083 * This side data should be associated with a video stream and corresponds
1084 * to the AVSphericalMapping structure.
1085 */
1086 AV_PKT_DATA_SPHERICAL,
4de339e2
KS
1087};
1088
0e2c3ee9
AK
1089typedef struct AVPacketSideData {
1090 uint8_t *data;
1091 int size;
1092 enum AVPacketSideDataType type;
1093} AVPacketSideData;
1094
0876c280
AK
1095/**
1096 * This structure stores compressed data. It is typically exported by demuxers
1097 * and then passed as input to decoders, or received as output from encoders and
1098 * then passed to muxers.
1099 *
1100 * For video, it should typically contain one compressed frame. For audio it may
6064f697
VG
1101 * contain several compressed frames. Encoders are allowed to output empty
1102 * packets, with no compressed data, containing only side data
1103 * (e.g. to update some stream parameters at the end of encoding).
0876c280
AK
1104 *
1105 * AVPacket is one of the few structs in Libav, whose size is a part of public
1106 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1107 * without libavcodec and libavformat major bump.
1108 *
ce70f28a
LB
1109 * The semantics of data ownership depends on the buf field.
1110 * If it is set, the packet data is dynamically allocated and is
1111 * valid indefinitely until a call to av_packet_unref() reduces the
1112 * reference count to 0.
0876c280 1113 *
ce70f28a
LB
1114 * If the buf field is not set av_packet_ref() would make a copy instead
1115 * of increasing the reference count.
1116 *
1117 * The side data is always allocated with av_malloc(), copied by
1118 * av_packet_ref() and freed by av_packet_unref().
1119 *
1120 * @see av_packet_ref
1121 * @see av_packet_unref
0876c280 1122 */
18c915ee
TB
1123typedef struct AVPacket {
1124 /**
1afddbe5
AK
1125 * A reference to the reference-counted buffer where the packet data is
1126 * stored.
1127 * May be NULL, then the packet data is not reference-counted.
1128 */
1129 AVBufferRef *buf;
1130 /**
7b356d39
RS
1131 * Presentation timestamp in AVStream->time_base units; the time at which
1132 * the decompressed packet will be presented to the user.
18c915ee
TB
1133 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1134 * pts MUST be larger or equal to dts as presentation cannot happen before
1135 * decompression, unless one wants to view hex dumps. Some formats misuse
1136 * the terms dts and pts/cts to mean something different. Such timestamps
1137 * must be converted to true pts/dts before they are stored in AVPacket.
1138 */
1139 int64_t pts;
1140 /**
7b356d39
RS
1141 * Decompression timestamp in AVStream->time_base units; the time at which
1142 * the packet is decompressed.
18c915ee
TB
1143 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1144 */
1145 int64_t dts;
1146 uint8_t *data;
1147 int size;
1148 int stream_index;
9d39cbf6
LB
1149 /**
1150 * A combination of AV_PKT_FLAG values
1151 */
18c915ee
TB
1152 int flags;
1153 /**
4de339e2
KS
1154 * Additional packet data that can be provided by the container.
1155 * Packet can contain several types of side information.
1156 */
0e2c3ee9 1157 AVPacketSideData *side_data;
4de339e2
KS
1158 int side_data_elems;
1159
1160 /**
7b356d39 1161 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
1162 * Equals next_pts - this_pts in presentation order.
1163 */
948f3c19 1164 int64_t duration;
01bcc2d5 1165
18c915ee
TB
1166 int64_t pos; ///< byte position in stream, -1 if unknown
1167
948f3c19 1168#if FF_API_CONVERGENCE_DURATION
18c915ee 1169 /**
948f3c19 1170 * @deprecated Same as the duration field, but as int64_t. This was required
1171 * for Matroska subtitles, whose duration values could overflow when the
1172 * duration field was still an int.
18c915ee 1173 */
948f3c19 1174 attribute_deprecated
18c915ee 1175 int64_t convergence_duration;
948f3c19 1176#endif
18c915ee 1177} AVPacket;
9d39cbf6
LB
1178#define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1179#define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
18c915ee 1180
fe75dc85
MS
1181enum AVSideDataParamChangeFlags {
1182 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1183 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1184 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1185 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1186};
30f3f625
AK
1187/**
1188 * @}
1189 */
fe75dc85 1190
f3a29b75
JR
1191struct AVCodecInternal;
1192
4bf3c8f2
AC
1193enum AVFieldOrder {
1194 AV_FIELD_UNKNOWN,
1195 AV_FIELD_PROGRESSIVE,
1196 AV_FIELD_TT, //< Top coded_first, top displayed first
1197 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1198 AV_FIELD_TB, //< Top coded first, bottom displayed first
1199 AV_FIELD_BT, //< Bottom coded first, top displayed first
1200};
1201
d33c949c 1202/**
252f17e2
MN
1203 * main external API structure.
1204 * New fields can be added to the end with minor version bumps.
8bfb108b 1205 * Removal, reordering and changes to existing fields require a major
252f17e2 1206 * version bump.
8bfb108b 1207 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1208 */
de6d9b64 1209typedef struct AVCodecContext {
b71901e6 1210 /**
f5bccd85 1211 * information on struct for av_log
488eec10 1212 * - set by avcodec_alloc_context3
bc874dae 1213 */
d42a814e 1214 const AVClass *av_class;
b1edfce0
AK
1215 int log_level_offset;
1216
1217 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
0a0f19b5 1218 const struct AVCodec *codec;
36ef5369 1219 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
b1edfce0
AK
1220
1221 /**
1222 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1223 * This is used to work around some encoder bugs.
1224 * A demuxer should set this to what is stored in the field used to identify the codec.
1225 * If there are multiple such fields in a container then the demuxer should choose the one
1226 * which maximizes the information about the used codec.
1227 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1228 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1229 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1230 * first.
1231 * - encoding: Set by user, if not then the default based on codec_id will be used.
1232 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1233 */
1234 unsigned int codec_tag;
1235
b1edfce0
AK
1236 void *priv_data;
1237
1238 /**
1239 * Private context used for internal data.
1240 *
1241 * Unlike priv_data, this is not codec-specific. It is used in general
1242 * libavcodec functions.
1243 */
1244 struct AVCodecInternal *internal;
1245
1246 /**
1247 * Private data of the user, can be used to carry app specific stuff.
1248 * - encoding: Set by user.
1249 * - decoding: Set by user.
1250 */
1251 void *opaque;
1252
bc874dae 1253 /**
f5bccd85
DB
1254 * the average bitrate
1255 * - encoding: Set by user; unused for constant quantizer encoding.
1256 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1257 */
de6d9b64 1258 int bit_rate;
b71901e6
MN
1259
1260 /**
64863965 1261 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1262 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1263 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1264 * - decoding: unused
b71901e6 1265 */
115329f1 1266 int bit_rate_tolerance;
b71901e6
MN
1267
1268 /**
b1edfce0
AK
1269 * Global quality for codecs which cannot change it per frame.
1270 * This should be proportional to MPEG-1/2/4 qscale.
f5bccd85 1271 * - encoding: Set by user.
b1edfce0 1272 * - decoding: unused
b71901e6 1273 */
b1edfce0 1274 int global_quality;
b71901e6
MN
1275
1276 /**
b1edfce0
AK
1277 * - encoding: Set by user.
1278 * - decoding: unused
b71901e6 1279 */
b1edfce0
AK
1280 int compression_level;
1281#define FF_COMPRESSION_DEFAULT -1
b71901e6
MN
1282
1283 /**
7c6eb0a1 1284 * AV_CODEC_FLAG_*.
b1edfce0
AK
1285 * - encoding: Set by user.
1286 * - decoding: Set by user.
b71901e6 1287 */
b1edfce0
AK
1288 int flags;
1289
1290 /**
7c6eb0a1 1291 * AV_CODEC_FLAG2_*
b1edfce0
AK
1292 * - encoding: Set by user.
1293 * - decoding: Set by user.
1294 */
1295 int flags2;
b71901e6
MN
1296
1297 /**
f5bccd85 1298 * some codecs need / can use extradata like Huffman tables.
41ed7ab4 1299 * MJPEG: Huffman tables
b71901e6 1300 * rv10: additional flags
41ed7ab4 1301 * MPEG-4: global headers (they can be in the bitstream or here)
059a9348 1302 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
41ed7ab4 1303 * than extradata_size to avoid problems if it is read with the bitstream reader.
f5bccd85
DB
1304 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1305 * - encoding: Set/allocated/freed by libavcodec.
1306 * - decoding: Set/allocated/freed by user.
b71901e6 1307 */
58f2a4b0 1308 uint8_t *extradata;
e84c31dc 1309 int extradata_size;
115329f1 1310
b71901e6 1311 /**
f5bccd85
DB
1312 * This is the fundamental unit of time (in seconds) in terms
1313 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1314 * timebase should be 1/framerate and timestamp increments should be
1315 * identically 1.
f5bccd85 1316 * - encoding: MUST be set by user.
7ea1b347
AK
1317 * - decoding: the use of this field for decoding is deprecated.
1318 * Use framerate instead.
b71901e6 1319 */
c0df9d75 1320 AVRational time_base;
115329f1 1321
b1edfce0
AK
1322 /**
1323 * For some codecs, the time base is closer to the field rate than the frame rate.
1324 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1325 * if no telecine is used ...
1326 *
1327 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1328 */
1329 int ticks_per_frame;
1330
1331 /**
c68317eb 1332 * Codec delay.
b1edfce0
AK
1333 *
1334 * Video:
1335 * Number of frames the decoded output will be delayed relative to the
1336 * encoded input.
1337 *
1338 * Audio:
2df0c32e 1339 * For encoding, this field is unused (see initial_padding).
b19a5e51 1340 *
e4aa3831
NC
1341 * For decoding, this is the number of samples the decoder needs to
1342 * output before the decoder's output is valid. When seeking, you should
1343 * start decoding this many samples prior to your desired seek point.
b1edfce0
AK
1344 *
1345 * - encoding: Set by libavcodec.
e4aa3831 1346 * - decoding: Set by libavcodec.
b1edfce0
AK
1347 */
1348 int delay;
1349
1350
5b28c8c3 1351 /* video only */
14bea432 1352 /**
21adafec 1353 * picture width / height.
9af7e804
LB
1354 *
1355 * @note Those fields may not match the values of the last
41ed7ab4 1356 * AVFrame output by avcodec_decode_video2 due frame
9af7e804
LB
1357 * reordering.
1358 *
115329f1 1359 * - encoding: MUST be set by user.
2d6edb2b
AK
1360 * - decoding: May be set by the user before opening the decoder if known e.g.
1361 * from the container. Some decoders will require the dimensions
1362 * to be set by the caller. During decoding, the decoder may
9af7e804 1363 * overwrite those values as required while parsing the data.
b71901e6 1364 */
de6d9b64 1365 int width, height;
115329f1 1366
b1edfce0 1367 /**
2d6edb2b
AK
1368 * Bitstream width / height, may be different from width/height e.g. when
1369 * the decoded frame is cropped before being output.
9af7e804
LB
1370 *
1371 * @note Those field may not match the value of the last
41ed7ab4 1372 * AVFrame output by avcodec_receive_frame() due frame
9af7e804
LB
1373 * reordering.
1374 *
b1edfce0 1375 * - encoding: unused
2d6edb2b
AK
1376 * - decoding: May be set by the user before opening the decoder if known
1377 * e.g. from the container. During decoding, the decoder may
9af7e804 1378 * overwrite those values as required while parsing the data.
b1edfce0
AK
1379 */
1380 int coded_width, coded_height;
1381
b71901e6 1382 /**
f5bccd85
DB
1383 * the number of pictures in a group of pictures, or 0 for intra_only
1384 * - encoding: Set by user.
64863965 1385 * - decoding: unused
b71901e6
MN
1386 */
1387 int gop_size;
1388
1389 /**
716d413c 1390 * Pixel format, see AV_PIX_FMT_xxx.
c1bdc930 1391 * May be set by the demuxer if known from headers.
41ed7ab4 1392 * May be overridden by the decoder if it knows better.
9af7e804
LB
1393 *
1394 * @note This field may not match the value of the last
41ed7ab4 1395 * AVFrame output by avcodec_receive_frame() due frame
9af7e804
LB
1396 * reordering.
1397 *
f5bccd85 1398 * - encoding: Set by user.
9af7e804
LB
1399 * - decoding: Set by user if known, overridden by libavcodec while
1400 * parsing the data.
b71901e6 1401 */
716d413c 1402 enum AVPixelFormat pix_fmt;
115329f1 1403
b1edfce0 1404 /**
f5bccd85
DB
1405 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1406 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1407 * all codecs can do that. You must check the codec capabilities
f5bccd85 1408 * beforehand.
37b00b47
AS
1409 * When multithreading is used, it may be called from multiple threads
1410 * at the same time; threads might draw different parts of the same AVFrame,
1411 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1412 * in order.
24b1583a
IK
1413 * The function is also used by hardware acceleration APIs.
1414 * It is called at least once during frame decoding to pass
1415 * the data needed for hardware render.
1416 * In that mode instead of pixel data, AVFrame points to
1417 * a structure specific to the acceleration API. The application
1418 * reads the structure and can change some fields to indicate progress
1419 * or mark state.
64863965 1420 * - encoding: unused
f5bccd85 1421 * - decoding: Set by user.
3bb07d61
MN
1422 * @param height the height of the slice
1423 * @param y the y position of the slice
1424 * @param type 1->top field, 2->bottom field, 3->frame
1425 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1426 */
bf89e6b1 1427 void (*draw_horiz_band)(struct AVCodecContext *s,
560f773c 1428 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
3bb07d61 1429 int y, int type, int height);
bf89e6b1 1430
a3a5f4d6 1431 /**
b1edfce0
AK
1432 * callback to negotiate the pixelFormat
1433 * @param fmt is the list of formats which are supported by the codec,
1434 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1435 * The first is always the native one.
1c80c9d7
RDC
1436 * @note The callback may be called again immediately if initialization for
1437 * the selected (hardware-accelerated) pixel format failed.
1438 * @warning Behavior is undefined if the callback returns a value not
1439 * in the fmt list of formats.
b1edfce0
AK
1440 * @return the chosen format
1441 * - encoding: unused
1442 * - decoding: Set by user, if not set the native format will be chosen.
a3a5f4d6 1443 */
716d413c 1444 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
de6d9b64 1445
718b27a7 1446 /**
b1edfce0
AK
1447 * maximum number of B-frames between non-B-frames
1448 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1449 * - encoding: Set by user.
1450 * - decoding: unused
718b27a7 1451 */
b1edfce0 1452 int max_b_frames;
115329f1 1453
b71901e6 1454 /**
b1edfce0
AK
1455 * qscale factor between IP and B-frames
1456 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1457 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1458 * - encoding: Set by user.
64863965 1459 * - decoding: unused
b71901e6 1460 */
b1edfce0 1461 float b_quant_factor;
115329f1 1462
0e6c8532
VG
1463#if FF_API_PRIVATE_OPT
1464 /** @deprecated use encoder private options instead */
1465 attribute_deprecated
b1edfce0 1466 int b_frame_strategy;
0e6c8532 1467#endif
115329f1 1468
b71901e6 1469 /**
b1edfce0 1470 * qscale offset between IP and B-frames
f5bccd85 1471 * - encoding: Set by user.
64863965 1472 * - decoding: unused
b71901e6 1473 */
b1edfce0 1474 float b_quant_offset;
b71901e6
MN
1475
1476 /**
b1edfce0
AK
1477 * Size of the frame reordering buffer in the decoder.
1478 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1479 * - encoding: Set by libavcodec.
1480 * - decoding: Set by libavcodec.
1481 */
1482 int has_b_frames;
1483
12b49769
VG
1484#if FF_API_PRIVATE_OPT
1485 /** @deprecated use encoder private options instead */
1486 attribute_deprecated
b1edfce0 1487 int mpeg_quant;
12b49769 1488#endif
b71901e6
MN
1489
1490 /**
41ed7ab4
VG
1491 * qscale factor between P- and I-frames
1492 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
662e5411 1493 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1494 * - encoding: Set by user.
64863965 1495 * - decoding: unused
b71901e6 1496 */
b1edfce0 1497 float i_quant_factor;
64b7c5b6 1498
b1edfce0
AK
1499 /**
1500 * qscale offset between P and I-frames
1501 * - encoding: Set by user.
1502 * - decoding: unused
1503 */
1504 float i_quant_offset;
9dbcbd92 1505
b1edfce0
AK
1506 /**
1507 * luminance masking (0-> disabled)
1508 * - encoding: Set by user.
1509 * - decoding: unused
1510 */
1511 float lumi_masking;
115329f1 1512
b1edfce0
AK
1513 /**
1514 * temporary complexity masking (0-> disabled)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1517 */
1518 float temporal_cplx_masking;
de6d9b64 1519
b1edfce0
AK
1520 /**
1521 * spatial complexity masking (0-> disabled)
1522 * - encoding: Set by user.
1523 * - decoding: unused
1524 */
1525 float spatial_cplx_masking;
115329f1 1526
b71901e6 1527 /**
b1edfce0 1528 * p block masking (0-> disabled)
f5bccd85 1529 * - encoding: Set by user.
64863965 1530 * - decoding: unused
b71901e6 1531 */
b1edfce0 1532 float p_masking;
115329f1 1533
b71901e6 1534 /**
b1edfce0 1535 * darkness masking (0-> disabled)
f5bccd85 1536 * - encoding: Set by user.
64863965 1537 * - decoding: unused
b71901e6 1538 */
b1edfce0 1539 float dark_masking;
115329f1 1540
b71901e6 1541 /**
b1edfce0
AK
1542 * slice count
1543 * - encoding: Set by libavcodec.
1544 * - decoding: Set by user (or 0).
b71901e6 1545 */
b1edfce0 1546 int slice_count;
2862b637
VG
1547
1548#if FF_API_PRIVATE_OPT
1549 /** @deprecated use encoder private options instead */
1550 attribute_deprecated
b1edfce0
AK
1551 int prediction_method;
1552#define FF_PRED_LEFT 0
1553#define FF_PRED_PLANE 1
1554#define FF_PRED_MEDIAN 2
2862b637 1555#endif
115329f1 1556
b71901e6 1557 /**
b1edfce0
AK
1558 * slice offsets in the frame in bytes
1559 * - encoding: Set/allocated by libavcodec.
1560 * - decoding: Set/allocated by user (or NULL).
b71901e6 1561 */
b1edfce0 1562 int *slice_offset;
0fd90455 1563
b71901e6 1564 /**
b1edfce0
AK
1565 * sample aspect ratio (0 if unknown)
1566 * That is the width of a pixel divided by the height of the pixel.
1567 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1568 * - encoding: Set by user.
f5bccd85 1569 * - decoding: Set by libavcodec.
b71901e6 1570 */
b1edfce0 1571 AVRational sample_aspect_ratio;
115329f1 1572
b71901e6 1573 /**
b1edfce0 1574 * motion estimation comparison function
f5bccd85 1575 * - encoding: Set by user.
64863965 1576 * - decoding: unused
b71901e6 1577 */
b1edfce0 1578 int me_cmp;
b71901e6 1579 /**
b1edfce0 1580 * subpixel motion estimation comparison function
f5bccd85 1581 * - encoding: Set by user.
64863965 1582 * - decoding: unused
b71901e6 1583 */
b1edfce0 1584 int me_sub_cmp;
b71901e6 1585 /**
b1edfce0 1586 * macroblock comparison function (not supported yet)
f5bccd85 1587 * - encoding: Set by user.
64863965 1588 * - decoding: unused
b71901e6 1589 */
b1edfce0 1590 int mb_cmp;
b71901e6 1591 /**
b1edfce0 1592 * interlaced DCT comparison function
f5bccd85 1593 * - encoding: Set by user.
64863965 1594 * - decoding: unused
b71901e6 1595 */
b1edfce0
AK
1596 int ildct_cmp;
1597#define FF_CMP_SAD 0
1598#define FF_CMP_SSE 1
1599#define FF_CMP_SATD 2
1600#define FF_CMP_DCT 3
1601#define FF_CMP_PSNR 4
1602#define FF_CMP_BIT 5
1603#define FF_CMP_RD 6
1604#define FF_CMP_ZERO 7
1605#define FF_CMP_VSAD 8
1606#define FF_CMP_VSSE 9
1607#define FF_CMP_NSSE 10
b1edfce0
AK
1608#define FF_CMP_DCTMAX 13
1609#define FF_CMP_DCT264 14
1610#define FF_CMP_CHROMA 256
115329f1 1611
b71901e6 1612 /**
b1edfce0 1613 * ME diamond size & shape
f5bccd85 1614 * - encoding: Set by user.
64863965 1615 * - decoding: unused
b71901e6 1616 */
b1edfce0 1617 int dia_size;
b71901e6
MN
1618
1619 /**
b1edfce0 1620 * amount of previous MV predictors (2a+1 x 2a+1 square)
f5bccd85 1621 * - encoding: Set by user.
64863965 1622 * - decoding: unused
b71901e6 1623 */
b1edfce0 1624 int last_predictor_count;
115329f1 1625
0e9c4fe2
VG
1626#if FF_API_PRIVATE_OPT
1627 /** @deprecated use encoder private options instead */
1628 attribute_deprecated
b1edfce0 1629 int pre_me;
0e9c4fe2 1630#endif
115329f1 1631
b71901e6 1632 /**
b1edfce0 1633 * motion estimation prepass comparison function
f5bccd85 1634 * - encoding: Set by user.
64863965 1635 * - decoding: unused
b71901e6 1636 */
b1edfce0 1637 int me_pre_cmp;
917e06c8 1638
b71901e6 1639 /**
b1edfce0 1640 * ME prepass diamond size & shape
f5bccd85 1641 * - encoding: Set by user.
64863965 1642 * - decoding: unused
b71901e6 1643 */
b1edfce0 1644 int pre_dia_size;
115329f1 1645
c5d309f2 1646 /**
b1edfce0 1647 * subpel ME quality
f5bccd85 1648 * - encoding: Set by user.
64863965 1649 * - decoding: unused
c5d309f2 1650 */
b1edfce0 1651 int me_subpel_quality;
115329f1 1652
c5d309f2 1653 /**
b1edfce0
AK
1654 * maximum motion estimation search range in subpel units
1655 * If 0 then no limit.
1656 *
f5bccd85 1657 * - encoding: Set by user.
64863965 1658 * - decoding: unused
c5d309f2 1659 */
b1edfce0 1660 int me_range;
115329f1 1661
144f0625 1662 /**
b1edfce0
AK
1663 * slice flags
1664 * - encoding: unused
1665 * - decoding: Set by user.
144f0625 1666 */
b1edfce0
AK
1667 int slice_flags;
1668#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
41ed7ab4 1669#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
b1edfce0
AK
1670#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1671
4d2858de 1672 /**
b1edfce0
AK
1673 * macroblock decision mode
1674 * - encoding: Set by user.
1675 * - decoding: unused
4d2858de 1676 */
b1edfce0
AK
1677 int mb_decision;
1678#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1679#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1680#define FF_MB_DECISION_RD 2 ///< rate distortion
4d2858de 1681
6b72ac63 1682 /**
b1edfce0
AK
1683 * custom intra quantization matrix
1684 * - encoding: Set by user, can be NULL.
1685 * - decoding: Set by libavcodec.
bec89a84 1686 */
b1edfce0 1687 uint16_t *intra_matrix;
7160bb71 1688
11f18faf 1689 /**
b1edfce0
AK
1690 * custom inter quantization matrix
1691 * - encoding: Set by user, can be NULL.
1692 * - decoding: Set by libavcodec.
11f18faf 1693 */
b1edfce0 1694 uint16_t *inter_matrix;
115329f1 1695
7c79587d
VG
1696#if FF_API_PRIVATE_OPT
1697 /** @deprecated use encoder private options instead */
1698 attribute_deprecated
b1edfce0 1699 int scenechange_threshold;
115329f1 1700
1482aff2
VG
1701 /** @deprecated use encoder private options instead */
1702 attribute_deprecated
b1edfce0 1703 int noise_reduction;
1482aff2 1704#endif
1e491e29 1705
1457ab52 1706 /**
b1edfce0 1707 * precision of the intra DC coefficient - 8
f5bccd85 1708 * - encoding: Set by user.
64863965 1709 * - decoding: unused
1457ab52 1710 */
b1edfce0
AK
1711 int intra_dc_precision;
1712
1457ab52 1713 /**
b1edfce0
AK
1714 * Number of macroblock rows at the top which are skipped.
1715 * - encoding: unused
1716 * - decoding: Set by user.
1457ab52 1717 */
b1edfce0
AK
1718 int skip_top;
1719
1457ab52 1720 /**
b1edfce0
AK
1721 * Number of macroblock rows at the bottom which are skipped.
1722 * - encoding: unused
1723 * - decoding: Set by user.
1457ab52 1724 */
b1edfce0
AK
1725 int skip_bottom;
1726
1457ab52 1727 /**
41ed7ab4 1728 * minimum MB Lagrange multiplier
f5bccd85 1729 * - encoding: Set by user.
64863965 1730 * - decoding: unused
1457ab52 1731 */
b1edfce0 1732 int mb_lmin;
b07a5980
MN
1733
1734 /**
41ed7ab4 1735 * maximum MB Lagrange multiplier
f5bccd85 1736 * - encoding: Set by user.
64863965 1737 * - decoding: unused
b07a5980 1738 */
b1edfce0 1739 int mb_lmax;
70ac76c0 1740
5b6f42da 1741#if FF_API_PRIVATE_OPT
f5fb6b34 1742 /**
5b6f42da 1743 * @deprecated use encoder private options instead
f5fb6b34 1744 */
5b6f42da 1745 attribute_deprecated
b1edfce0 1746 int me_penalty_compensation;
5b6f42da 1747#endif
b07a5980 1748
70ac76c0 1749 /**
f5bccd85 1750 * - encoding: Set by user.
64863965 1751 * - decoding: unused
70ac76c0 1752 */
b1edfce0 1753 int bidir_refine;
826f429a 1754
84c4714f
VG
1755#if FF_API_PRIVATE_OPT
1756 /** @deprecated use encoder private options instead */
1757 attribute_deprecated
b1edfce0 1758 int brd_scale;
84c4714f 1759#endif
70ac76c0 1760
826f429a 1761 /**
b1edfce0 1762 * minimum GOP size
f5bccd85 1763 * - encoding: Set by user.
64863965 1764 * - decoding: unused
826f429a 1765 */
b1edfce0 1766 int keyint_min;
826f429a 1767
a33c7159 1768 /**
b1edfce0
AK
1769 * number of reference frames
1770 * - encoding: Set by user.
1771 * - decoding: Set by lavc.
a33c7159 1772 */
b1edfce0 1773 int refs;
e2f9490e 1774
5764d381
VG
1775#if FF_API_PRIVATE_OPT
1776 /** @deprecated use encoder private options instead */
1777 attribute_deprecated
b1edfce0 1778 int chromaoffset;
5764d381 1779#endif
e2f9490e 1780
65f7062d 1781 /**
b1edfce0 1782 * Note: Value depends upon the compare function used for fullpel ME.
f5bccd85 1783 * - encoding: Set by user.
1984f635
MN
1784 * - decoding: unused
1785 */
b1edfce0 1786 int mv0_threshold;
115329f1 1787
0e6c8532
VG
1788#if FF_API_PRIVATE_OPT
1789 /** @deprecated use encoder private options instead */
1790 attribute_deprecated
b1edfce0 1791 int b_sensitivity;
0e6c8532 1792#endif
5cd62665
ZK
1793
1794 /**
b1edfce0
AK
1795 * Chromaticity coordinates of the source primaries.
1796 * - encoding: Set by user
1797 * - decoding: Set by libavcodec
5cd62665 1798 */
b1edfce0 1799 enum AVColorPrimaries color_primaries;
115329f1 1800
3d2e8cce 1801 /**
b1edfce0
AK
1802 * Color Transfer Characteristic.
1803 * - encoding: Set by user
1804 * - decoding: Set by libavcodec
3d2e8cce 1805 */
b1edfce0 1806 enum AVColorTransferCharacteristic color_trc;
115329f1 1807
11e659c2 1808 /**
b1edfce0
AK
1809 * YUV colorspace type.
1810 * - encoding: Set by user
1811 * - decoding: Set by libavcodec
1812 */
1813 enum AVColorSpace colorspace;
1814
1815 /**
1816 * MPEG vs JPEG YUV range.
1817 * - encoding: Set by user
1818 * - decoding: Set by libavcodec
1819 */
1820 enum AVColorRange color_range;
1821
1822 /**
1823 * This defines the location of chroma samples.
1824 * - encoding: Set by user
1825 * - decoding: Set by libavcodec
1826 */
1827 enum AVChromaLocation chroma_sample_location;
1828
1829 /**
1830 * Number of slices.
1831 * Indicates number of picture subdivisions. Used for parallelized
1832 * decoding.
1833 * - encoding: Set by user
11e659c2
MN
1834 * - decoding: unused
1835 */
b1edfce0
AK
1836 int slices;
1837
1838 /** Field order
1839 * - encoding: set by libavcodec
1840 * - decoding: Set by libavcodec
1841 */
1842 enum AVFieldOrder field_order;
1843
1844 /* audio only */
1845 int sample_rate; ///< samples per second
1846 int channels; ///< number of audio channels
11e659c2
MN
1847
1848 /**
b1edfce0 1849 * audio sample format
f5bccd85 1850 * - encoding: Set by user.
b1edfce0 1851 * - decoding: Set by libavcodec.
11e659c2 1852 */
b1edfce0 1853 enum AVSampleFormat sample_fmt; ///< sample format
115329f1 1854
b1edfce0 1855 /* The following data should not be initialized. */
3bb07d61 1856 /**
d6f4fe68
AK
1857 * Number of samples per channel in an audio frame.
1858 *
1859 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1860 * except the last must contain exactly frame_size samples per channel.
def97856 1861 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
d6f4fe68
AK
1862 * frame size is not restricted.
1863 * - decoding: may be set by some decoders to indicate constant frame size
3bb07d61 1864 */
b1edfce0 1865 int frame_size;
c179c9e1
AK
1866
1867 /**
1868 * Frame counter, set by libavcodec.
1869 *
1870 * - decoding: total number of frames returned from the decoder so far.
1871 * - encoding: total number of frames passed to the encoder so far.
1872 *
1873 * @note the counter is not incremented if encoding/decoding resulted in
1874 * an error.
1875 */
1876 int frame_number;
3bb07d61 1877
fb364ada 1878 /**
b1edfce0
AK
1879 * number of bytes per packet if constant and known or 0
1880 * Used by some WAV based audio codecs.
fb364ada 1881 */
b1edfce0 1882 int block_align;
115329f1 1883
7d1c3fc1 1884 /**
b1edfce0 1885 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 1886 * - encoding: Set by user.
7d1c3fc1
MN
1887 * - decoding: unused
1888 */
b1edfce0 1889 int cutoff;
d6eb3c50 1890
d6eb3c50 1891 /**
b1edfce0
AK
1892 * Audio channel layout.
1893 * - encoding: set by user.
1894 * - decoding: set by libavcodec.
d6eb3c50 1895 */
b1edfce0 1896 uint64_t channel_layout;
115329f1 1897
541ae140 1898 /**
b1edfce0 1899 * Request decoder to use this channel layout if it can (0 for default)
541ae140 1900 * - encoding: unused
b1edfce0 1901 * - decoding: Set by user.
541ae140 1902 */
b1edfce0 1903 uint64_t request_channel_layout;
05fbd0a2
MN
1904
1905 /**
b1edfce0 1906 * Type of service that the audio stream conveys.
f5bccd85 1907 * - encoding: Set by user.
b1edfce0 1908 * - decoding: Set by libavcodec.
05fbd0a2 1909 */
b1edfce0 1910 enum AVAudioServiceType audio_service_type;
158c7f05
MN
1911
1912 /**
b1edfce0
AK
1913 * Used to request a sample format from the decoder.
1914 * - encoding: unused.
1915 * - decoding: Set by user.
158c7f05 1916 */
b1edfce0 1917 enum AVSampleFormat request_sample_fmt;
158c7f05 1918
759001c5
AK
1919 /**
1920 * This callback is called at the beginning of each frame to get data
1921 * buffer(s) for it. There may be one contiguous buffer for all the data or
00b8e650
DB
1922 * there may be a buffer per each data plane or anything in between. What
1923 * this means is, you may set however many entries in buf[] you feel necessary.
1924 * Each buffer must be reference-counted using the AVBuffer API (see description
1925 * of buf[] below).
759001c5
AK
1926 *
1927 * The following fields will be set in the frame before this callback is
1928 * called:
1929 * - format
1930 * - width, height (video only)
1931 * - sample_rate, channel_layout, nb_samples (audio only)
1932 * Their values may differ from the corresponding values in
1933 * AVCodecContext. This callback must use the frame values, not the codec
1934 * context values, to calculate the required buffer size.
1935 *
1936 * This callback must fill the following fields in the frame:
1937 * - data[]
1938 * - linesize[]
1939 * - extended_data:
1940 * * if the data is planar audio with more than 8 channels, then this
1941 * callback must allocate and fill extended_data to contain all pointers
1942 * to all data planes. data[] must hold as many pointers as it can.
1943 * extended_data must be allocated with av_malloc() and will be freed in
1944 * av_frame_unref().
41ed7ab4 1945 * * otherwise extended_data must point to data
4cdb3c50
DB
1946 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1947 * the frame's data and extended_data pointers must be contained in these. That
1948 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1949 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1950 * and av_buffer_ref().
759001c5
AK
1951 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1952 * this callback and filled with the extra buffers if there are more
1953 * buffers than buf[] can hold. extended_buf will be freed in
1954 * av_frame_unref().
1955 *
def97856 1956 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
759001c5
AK
1957 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1958 * some other means.
1959 *
1960 * Each data plane must be aligned to the maximum required by the target
1961 * CPU.
1962 *
1963 * @see avcodec_default_get_buffer2()
1964 *
1965 * Video:
1966 *
1967 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1968 * (read and/or written to if it is writable) later by libavcodec.
1969 *
759001c5
AK
1970 * avcodec_align_dimensions2() should be used to find the required width and
1971 * height, as they normally need to be rounded up to the next multiple of 16.
1972 *
1973 * If frame multithreading is used and thread_safe_callbacks is set,
1974 * this callback may be called from a different thread, but not from more
1975 * than one at once. Does not need to be reentrant.
1976 *
1977 * @see avcodec_align_dimensions2()
1978 *
1979 * Audio:
1980 *
1981 * Decoders request a buffer of a particular size by setting
1982 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1983 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1984 * to a smaller value in the output frame.
1985 *
1986 * As a convenience, av_samples_get_buffer_size() and
1987 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1988 * functions to find the required data size and to fill data pointers and
1989 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1990 * since all planes must be the same size.
1991 *
1992 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1993 *
1994 * - encoding: unused
1995 * - decoding: Set by libavcodec, user can override.
1996 */
1997 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1998
1999 /**
2000 * If non-zero, the decoded audio and video frames returned from
2001 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2002 * and are valid indefinitely. The caller must free them with
2003 * av_frame_unref() when they are not needed anymore.
2004 * Otherwise, the decoded frames must not be freed by the caller and are
2005 * only valid until the next decode call.
2006 *
05f66706 2007 * This is always automatically enabled if avcodec_receive_frame() is used.
2008 *
759001c5
AK
2009 * - encoding: unused
2010 * - decoding: set by the caller before avcodec_open2().
2011 */
577326d4 2012 attribute_deprecated int refcounted_frames;
ba58dabc 2013
b1edfce0
AK
2014 /* - encoding parameters */
2015 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2016 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
ba58dabc
MN
2017
2018 /**
b1edfce0 2019 * minimum quantizer
f5bccd85 2020 * - encoding: Set by user.
b1edfce0 2021 * - decoding: unused
ba58dabc 2022 */
b1edfce0 2023 int qmin;
7ebfc0ea
MN
2024
2025 /**
b1edfce0 2026 * maximum quantizer
f5bccd85
DB
2027 * - encoding: Set by user.
2028 * - decoding: unused
7ebfc0ea 2029 */
b1edfce0 2030 int qmax;
115329f1 2031
77ea0d4b 2032 /**
b1edfce0 2033 * maximum quantizer difference between frames
f5bccd85 2034 * - encoding: Set by user.
77ea0d4b
MN
2035 * - decoding: unused
2036 */
b1edfce0 2037 int max_qdiff;
9c3d33d6 2038
a4d36c11 2039 /**
b1edfce0 2040 * decoder bitstream buffer size
f5bccd85 2041 * - encoding: Set by user.
f20f8a8b 2042 * - decoding: unused
a4d36c11 2043 */
b1edfce0 2044 int rc_buffer_size;
f20f8a8b
MN
2045
2046 /**
b1edfce0
AK
2047 * ratecontrol override, see RcOverride
2048 * - encoding: Allocated/set/freed by user.
f20f8a8b
MN
2049 * - decoding: unused
2050 */
b1edfce0
AK
2051 int rc_override_count;
2052 RcOverride *rc_override;
bf266e19 2053
d4c5d2ad 2054 /**
b1edfce0 2055 * maximum bitrate
f5bccd85 2056 * - encoding: Set by user.
d4c5d2ad
MN
2057 * - decoding: unused
2058 */
b1edfce0 2059 int rc_max_rate;
baced9f5
MN
2060
2061 /**
b1edfce0 2062 * minimum bitrate
f5bccd85 2063 * - encoding: Set by user.
b1edfce0 2064 * - decoding: unused
baced9f5 2065 */
b1edfce0 2066 int rc_min_rate;
0215006a 2067
21adafec 2068 /**
b1edfce0
AK
2069 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2070 * - encoding: Set by user.
2071 * - decoding: unused.
21adafec 2072 */
b1edfce0 2073 float rc_max_available_vbv_use;
bbf18b21
MN
2074
2075 /**
b1edfce0 2076 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
f5bccd85 2077 * - encoding: Set by user.
b1edfce0 2078 * - decoding: unused.
bbf18b21 2079 */
b1edfce0 2080 float rc_min_vbv_overflow_use;
bbf18b21
MN
2081
2082 /**
b1edfce0 2083 * Number of bits which should be loaded into the rc buffer before decoding starts.
f5bccd85 2084 * - encoding: Set by user.
bbf18b21
MN
2085 * - decoding: unused
2086 */
b1edfce0 2087 int rc_initial_buffer_occupancy;
0fd6aea1 2088
be00ec83 2089#if FF_API_CODER_TYPE
b1edfce0
AK
2090#define FF_CODER_TYPE_VLC 0
2091#define FF_CODER_TYPE_AC 1
2092#define FF_CODER_TYPE_RAW 2
2093#define FF_CODER_TYPE_RLE 3
0fd6aea1 2094 /**
be00ec83 2095 * @deprecated use encoder private options instead
0fd6aea1 2096 */
be00ec83 2097 attribute_deprecated
b1edfce0 2098 int coder_type;
be00ec83 2099#endif /* FF_API_CODER_TYPE */
0fd6aea1 2100
96c373c7
VG
2101#if FF_API_PRIVATE_OPT
2102 /** @deprecated use encoder private options instead */
2103 attribute_deprecated
b1edfce0 2104 int context_model;
96c373c7 2105#endif
957c743a 2106
0ac9f33a
VG
2107#if FF_API_PRIVATE_OPT
2108 /** @deprecated use encoder private options instead */
2109 attribute_deprecated
b1edfce0 2110 int frame_skip_threshold;
09c3e44e 2111
0ac9f33a
VG
2112 /** @deprecated use encoder private options instead */
2113 attribute_deprecated
b1edfce0 2114 int frame_skip_factor;
316a2ec8 2115
0ac9f33a
VG
2116 /** @deprecated use encoder private options instead */
2117 attribute_deprecated
b1edfce0 2118 int frame_skip_exp;
e8501c93 2119
0ac9f33a
VG
2120 /** @deprecated use encoder private options instead */
2121 attribute_deprecated
b1edfce0 2122 int frame_skip_cmp;
0ac9f33a 2123#endif /* FF_API_PRIVATE_OPT */
58f7833e 2124
58f7833e 2125 /**
b1edfce0 2126 * trellis RD quantization
f5bccd85 2127 * - encoding: Set by user.
58f7833e
RS
2128 * - decoding: unused
2129 */
b1edfce0 2130 int trellis;
58f7833e 2131
243df135
VG
2132#if FF_API_PRIVATE_OPT
2133 /** @deprecated use encoder private options instead */
2134 attribute_deprecated
b1edfce0 2135 int min_prediction_order;
58f7833e 2136
243df135
VG
2137 /** @deprecated use encoder private options instead */
2138 attribute_deprecated
b1edfce0 2139 int max_prediction_order;
58f7833e 2140
d7496153
VG
2141 /** @deprecated use encoder private options instead */
2142 attribute_deprecated
b1edfce0 2143 int64_t timecode_frame_start;
d7496153 2144#endif
b1edfce0 2145
462a54e2
VG
2146#if FF_API_RTP_CALLBACK
2147 /**
2148 * @deprecated unused
2149 */
b1edfce0
AK
2150 /* The RTP callback: This function is called */
2151 /* every time the encoder has a packet to send. */
2152 /* It depends on the encoder if the data starts */
2153 /* with a Start Code (it should). H.263 does. */
2154 /* mb_nb contains the number of macroblocks */
2155 /* encoded in the RTP payload. */
462a54e2 2156 attribute_deprecated
b1edfce0 2157 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
462a54e2 2158#endif
b1edfce0 2159
936f0d98
VG
2160#if FF_API_PRIVATE_OPT
2161 /** @deprecated use encoder private options instead */
2162 attribute_deprecated
b1edfce0
AK
2163 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2164 /* do its best to deliver a chunk with size */
2165 /* below rtp_payload_size, the chunk will start */
2166 /* with a start code on some codecs like H.263. */
2167 /* This doesn't take account of any particular */
2168 /* headers inside the transmitted RTP payload. */
936f0d98 2169#endif
b1edfce0 2170
16216b71 2171#if FF_API_STAT_BITS
b1edfce0 2172 /* statistics, used for 2-pass encoding */
16216b71 2173 attribute_deprecated
b1edfce0 2174 int mv_bits;
16216b71 2175 attribute_deprecated
b1edfce0 2176 int header_bits;
16216b71 2177 attribute_deprecated
b1edfce0 2178 int i_tex_bits;
16216b71 2179 attribute_deprecated
b1edfce0 2180 int p_tex_bits;
16216b71 2181 attribute_deprecated
b1edfce0 2182 int i_count;
16216b71 2183 attribute_deprecated
b1edfce0 2184 int p_count;
16216b71 2185 attribute_deprecated
b1edfce0 2186 int skip_count;
16216b71 2187 attribute_deprecated
b1edfce0 2188 int misc_bits;
58f7833e 2189
16216b71
VG
2190 /** @deprecated this field is unused */
2191 attribute_deprecated
b1edfce0 2192 int frame_bits;
16216b71 2193#endif
39a64e30
CH
2194
2195 /**
b1edfce0
AK
2196 * pass1 encoding statistics output buffer
2197 * - encoding: Set by libavcodec.
39a64e30
CH
2198 * - decoding: unused
2199 */
b1edfce0 2200 char *stats_out;
1dd509b1
MN
2201
2202 /**
b1edfce0
AK
2203 * pass2 encoding statistics input buffer
2204 * Concatenated stuff from stats_out of pass1 should be placed here.
2205 * - encoding: Allocated/set/freed by user.
1dd509b1
MN
2206 * - decoding: unused
2207 */
b1edfce0 2208 char *stats_in;
f9243d34
CH
2209
2210 /**
b1edfce0
AK
2211 * Work around bugs in encoders which sometimes cannot be detected automatically.
2212 * - encoding: Set by user
2213 * - decoding: Set by user
f9243d34 2214 */
b1edfce0
AK
2215 int workaround_bugs;
2216#define FF_BUG_AUTODETECT 1 ///< autodetection
b1edfce0
AK
2217#define FF_BUG_XVID_ILACE 4
2218#define FF_BUG_UMP4 8
2219#define FF_BUG_NO_PADDING 16
2220#define FF_BUG_AMV 32
b1edfce0
AK
2221#define FF_BUG_QPEL_CHROMA 64
2222#define FF_BUG_STD_QPEL 128
2223#define FF_BUG_QPEL_CHROMA2 256
2224#define FF_BUG_DIRECT_BLOCKSIZE 512
2225#define FF_BUG_EDGE 1024
2226#define FF_BUG_HPEL_CHROMA 2048
2227#define FF_BUG_DC_CLIP 4096
2228#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2229#define FF_BUG_TRUNCATED 16384
a403fc03
JR
2230
2231 /**
41ed7ab4 2232 * strictly follow the standard (MPEG-4, ...).
f5bccd85 2233 * - encoding: Set by user.
b1edfce0
AK
2234 * - decoding: Set by user.
2235 * Setting this to STRICT or higher means the encoder and decoder will
2236 * generally do stupid things, whereas setting it to unofficial or lower
2237 * will mean the encoder might produce output that is not supported by all
2238 * spec-compliant decoders. Decoders don't differentiate between normal,
2239 * unofficial and experimental (that is, they always try to decode things
2240 * when they can) unless they are explicitly asked to behave stupidly
2241 * (=strictly conform to the specs)
a403fc03 2242 */
b1edfce0
AK
2243 int strict_std_compliance;
2244#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2245#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2246#define FF_COMPLIANCE_NORMAL 0
2247#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2248#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
a403fc03 2249
a403fc03 2250 /**
b1edfce0
AK
2251 * error concealment flags
2252 * - encoding: unused
2253 * - decoding: Set by user.
a403fc03 2254 */
b1edfce0
AK
2255 int error_concealment;
2256#define FF_EC_GUESS_MVS 1
2257#define FF_EC_DEBLOCK 2
a403fc03
JR
2258
2259 /**
b1edfce0 2260 * debug
f5bccd85 2261 * - encoding: Set by user.
b1edfce0 2262 * - decoding: Set by user.
a403fc03 2263 */
b1edfce0
AK
2264 int debug;
2265#define FF_DEBUG_PICT_INFO 1
2266#define FF_DEBUG_RC 2
2267#define FF_DEBUG_BITSTREAM 4
2268#define FF_DEBUG_MB_TYPE 8
2269#define FF_DEBUG_QP 16
b1edfce0
AK
2270#define FF_DEBUG_DCT_COEFF 0x00000040
2271#define FF_DEBUG_SKIP 0x00000080
2272#define FF_DEBUG_STARTCODE 0x00000100
b1edfce0
AK
2273#define FF_DEBUG_ER 0x00000400
2274#define FF_DEBUG_MMCO 0x00000800
2275#define FF_DEBUG_BUGS 0x00001000
b1edfce0
AK
2276#define FF_DEBUG_BUFFERS 0x00008000
2277#define FF_DEBUG_THREADS 0x00010000
188dea1d 2278
b1ec601f 2279 /**
b1edfce0 2280 * Error recognition; may misdetect some more or less valid parts as errors.
85947156
VS
2281 * - encoding: unused
2282 * - decoding: Set by user.
b1ec601f 2283 */
b1edfce0 2284 int err_recognition;
23a211cb
AK
2285
2286/**
2287 * Verify checksums embedded in the bitstream (could be of either encoded or
2288 * decoded data, depending on the codec) and print an error message on mismatch.
2289 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2290 * decoder returning an error.
2291 */
b1edfce0
AK
2292#define AV_EF_CRCCHECK (1<<0)
2293#define AV_EF_BITSTREAM (1<<1)
2294#define AV_EF_BUFFER (1<<2)
2295#define AV_EF_EXPLODE (1<<3)
1408352a 2296
79de84f2 2297 /**
41ed7ab4 2298 * opaque 64-bit number (generally a PTS) that will be reordered and
79de84f2
MN
2299 * output in AVFrame.reordered_opaque
2300 * - encoding: unused
2301 * - decoding: Set by user.
2302 */
2303 int64_t reordered_opaque;
312420f3
PR
2304
2305 /**
b1edfce0
AK
2306 * Hardware accelerator in use
2307 * - encoding: unused.
2308 * - decoding: Set by libavcodec
312420f3 2309 */
2117725d 2310 const struct AVHWAccel *hwaccel;
0d72e7d0
PR
2311
2312 /**
b1edfce0
AK
2313 * Hardware accelerator context.
2314 * For some hardware accelerators, a global context needs to be
2315 * provided by the user. In that case, this holds display-dependent
2316 * data Libav cannot instantiate itself. Please refer to the
2317 * Libav HW accelerator documentation to know how to fill this
2318 * is. e.g. for VA API, this is a struct vaapi_context.
2319 * - encoding: unused
2320 * - decoding: Set by user
0d72e7d0 2321 */
b1edfce0 2322 void *hwaccel_context;
0d72e7d0
PR
2323
2324 /**
b1edfce0 2325 * error
7c6eb0a1 2326 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
b1edfce0 2327 * - decoding: unused
0d72e7d0 2328 */
b1edfce0 2329 uint64_t error[AV_NUM_DATA_POINTERS];
3bff4d8b
BC
2330
2331 /**
b1edfce0 2332 * DCT algorithm, see FF_DCT_* below
3bff4d8b 2333 * - encoding: Set by user.
b1edfce0 2334 * - decoding: unused
3bff4d8b 2335 */
b1edfce0
AK
2336 int dct_algo;
2337#define FF_DCT_AUTO 0
2338#define FF_DCT_FASTINT 1
2339#define FF_DCT_INT 2
2340#define FF_DCT_MMX 3
2341#define FF_DCT_ALTIVEC 5
2342#define FF_DCT_FAAN 6
3bff4d8b
BC
2343
2344 /**
b1edfce0 2345 * IDCT algorithm, see FF_IDCT_* below.
3bff4d8b 2346 * - encoding: Set by user.
b1edfce0 2347 * - decoding: Set by user.
3bff4d8b 2348 */
b1edfce0
AK
2349 int idct_algo;
2350#define FF_IDCT_AUTO 0
2351#define FF_IDCT_INT 1
2352#define FF_IDCT_SIMPLE 2
2353#define FF_IDCT_SIMPLEMMX 3
b1edfce0
AK
2354#define FF_IDCT_ARM 7
2355#define FF_IDCT_ALTIVEC 8
b1edfce0 2356#define FF_IDCT_SIMPLEARM 10
d35b94fb 2357#define FF_IDCT_XVID 14
b1edfce0
AK
2358#define FF_IDCT_SIMPLEARMV5TE 16
2359#define FF_IDCT_SIMPLEARMV6 17
b1edfce0 2360#define FF_IDCT_FAAN 20
b1edfce0 2361#define FF_IDCT_SIMPLENEON 22
40e5d31b 2362
b1edfce0
AK
2363 /**
2364 * bits per sample/pixel from the demuxer (needed for huffyuv).
2365 * - encoding: Set by libavcodec.
2366 * - decoding: Set by user.
2367 */
2368 int bits_per_coded_sample;
2369
2370 /**
2371 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2372 * - encoding: set by user.
2373 * - decoding: set by libavcodec.
2374 */
2375 int bits_per_raw_sample;
3797c74b 2376
40cf1bba 2377#if FF_API_CODED_FRAME
1aea7018 2378 /**
b1edfce0
AK
2379 * the picture in the bitstream
2380 * - encoding: Set by libavcodec.
2ff302cb 2381 * - decoding: unused
40cf1bba
VG
2382 *
2383 * @deprecated use the quality factor packet side data instead
1aea7018 2384 */
40cf1bba
VG
2385 attribute_deprecated AVFrame *coded_frame;
2386#endif
4ee6a5c1
MN
2387
2388 /**
b1edfce0
AK
2389 * thread count
2390 * is used to decide how many independent tasks should be passed to execute()
2391 * - encoding: Set by user.
2392 * - decoding: Set by user.
4ee6a5c1 2393 */
b1edfce0 2394 int thread_count;
4ee6a5c1
MN
2395
2396 /**
b1edfce0
AK
2397 * Which multithreading methods to use.
2398 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2399 * so clients which cannot provide future frames should not use it.
2400 *
2401 * - encoding: Set by user, otherwise the default is used.
2402 * - decoding: Set by user, otherwise the default is used.
4ee6a5c1 2403 */
b1edfce0
AK
2404 int thread_type;
2405#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2406#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
4ee6a5c1
MN
2407
2408 /**
b1edfce0
AK
2409 * Which multithreading methods are in use by the codec.
2410 * - encoding: Set by libavcodec.
2411 * - decoding: Set by libavcodec.
4ee6a5c1 2412 */
b1edfce0 2413 int active_thread_type;
4ee6a5c1
MN
2414
2415 /**
b1edfce0 2416 * Set by the client if its custom get_buffer() callback can be called
ad027866 2417 * synchronously from another thread, which allows faster multithreaded decoding.
b1edfce0
AK
2418 * draw_horiz_band() will be called from other threads regardless of this setting.
2419 * Ignored if the default get_buffer() is used.
2420 * - encoding: Set by user.
2421 * - decoding: Set by user.
4ee6a5c1 2422 */
b1edfce0 2423 int thread_safe_callbacks;
580a7465
DC
2424
2425 /**
b1edfce0
AK
2426 * The codec may call this to execute several independent things.
2427 * It will return only after finishing all tasks.
2428 * The user may replace this with some multithreaded implementation,
2429 * the default implementation will execute the parts serially.
2430 * @param count the number of things to execute
2431 * - encoding: Set by libavcodec, user can override.
2432 * - decoding: Set by libavcodec, user can override.
580a7465 2433 */
b1edfce0 2434 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
8d23a86f
RD
2435
2436 /**
2437 * The codec may call this to execute several independent things.
2438 * It will return only after finishing all tasks.
2439 * The user may replace this with some multithreaded implementation,
2440 * the default implementation will execute the parts serially.
2441 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2442 * @param c context passed also to func
2443 * @param count the number of things to execute
2444 * @param arg2 argument passed unchanged to func
2445 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2446 * @param func function that will be called count times, with jobnr from 0 to count-1.
2447 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2448 * two instances of func executing at the same time will have the same threadnr.
2449 * @return always 0 currently, but code should handle a future improvement where when any call to func
2450 * returns < 0 no further calls to func may be done and < 0 is returned.
2451 * - encoding: Set by libavcodec, user can override.
2452 * - decoding: Set by libavcodec, user can override.
2453 */
2454 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6 2455
2aa72ecc 2456 /**
41ed7ab4 2457 * noise vs. sse weight for the nsse comparison function
b1edfce0 2458 * - encoding: Set by user.
2aa72ecc
JZ
2459 * - decoding: unused
2460 */
b1edfce0 2461 int nsse_weight;
cb2c971d
AJ
2462
2463 /**
b1edfce0
AK
2464 * profile
2465 * - encoding: Set by user.
2466 * - decoding: Set by libavcodec.
cb2c971d 2467 */
b1edfce0
AK
2468 int profile;
2469#define FF_PROFILE_UNKNOWN -99
2470#define FF_PROFILE_RESERVED -100
2471
2472#define FF_PROFILE_AAC_MAIN 0
2473#define FF_PROFILE_AAC_LOW 1
2474#define FF_PROFILE_AAC_SSR 2
2475#define FF_PROFILE_AAC_LTP 3
372597e5
MS
2476#define FF_PROFILE_AAC_HE 4
2477#define FF_PROFILE_AAC_HE_V2 28
2478#define FF_PROFILE_AAC_LD 22
2479#define FF_PROFILE_AAC_ELD 38
95d52464
KK
2480#define FF_PROFILE_MPEG2_AAC_LOW 128
2481#define FF_PROFILE_MPEG2_AAC_HE 131
b1edfce0
AK
2482
2483#define FF_PROFILE_DTS 20
2484#define FF_PROFILE_DTS_ES 30
2485#define FF_PROFILE_DTS_96_24 40
2486#define FF_PROFILE_DTS_HD_HRA 50
2487#define FF_PROFILE_DTS_HD_MA 60
6fe2641d 2488#define FF_PROFILE_DTS_EXPRESS 70
b1edfce0
AK
2489
2490#define FF_PROFILE_MPEG2_422 0
2491#define FF_PROFILE_MPEG2_HIGH 1
2492#define FF_PROFILE_MPEG2_SS 2
2493#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2494#define FF_PROFILE_MPEG2_MAIN 4
2495#define FF_PROFILE_MPEG2_SIMPLE 5
2496
2497#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2498#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2499
2500#define FF_PROFILE_H264_BASELINE 66
2501#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2502#define FF_PROFILE_H264_MAIN 77
2503#define FF_PROFILE_H264_EXTENDED 88
2504#define FF_PROFILE_H264_HIGH 100
2505#define FF_PROFILE_H264_HIGH_10 110
2506#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
90f469aa 2507#define FF_PROFILE_H264_MULTIVIEW_HIGH 118
b1edfce0
AK
2508#define FF_PROFILE_H264_HIGH_422 122
2509#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
90f469aa 2510#define FF_PROFILE_H264_STEREO_HIGH 128
b1edfce0
AK
2511#define FF_PROFILE_H264_HIGH_444 144
2512#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2513#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2514#define FF_PROFILE_H264_CAVLC_444 44
2515
2516#define FF_PROFILE_VC1_SIMPLE 0
2517#define FF_PROFILE_VC1_MAIN 1
2518#define FF_PROFILE_VC1_COMPLEX 2
2519#define FF_PROFILE_VC1_ADVANCED 3
2520
2521#define FF_PROFILE_MPEG4_SIMPLE 0
2522#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2523#define FF_PROFILE_MPEG4_CORE 2
2524#define FF_PROFILE_MPEG4_MAIN 3
2525#define FF_PROFILE_MPEG4_N_BIT 4
2526#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2527#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2528#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2529#define FF_PROFILE_MPEG4_HYBRID 8
2530#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2531#define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2532#define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2533#define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2534#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2535#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2536#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
393cbb96 2537
ad61da05
FC
2538#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2539#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2540#define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
c81a7063
NB
2541#define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2542#define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2543
8655c541
LB
2544#define FF_PROFILE_VP9_0 0
2545#define FF_PROFILE_VP9_1 1
2546#define FF_PROFILE_VP9_2 2
2547#define FF_PROFILE_VP9_3 3
2a41826b
GC
2548
2549#define FF_PROFILE_HEVC_MAIN 1
2550#define FF_PROFILE_HEVC_MAIN_10 2
2551#define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
de64dd13 2552#define FF_PROFILE_HEVC_REXT 4
2a41826b 2553
f6171471
JA
2554#define FF_PROFILE_AV1_MAIN 0
2555#define FF_PROFILE_AV1_HIGH 1
2556#define FF_PROFILE_AV1_PROFESSIONAL 2
43778a50 2557
393cbb96 2558 /**
b1edfce0
AK
2559 * level
2560 * - encoding: Set by user.
2561 * - decoding: Set by libavcodec.
393cbb96 2562 */
b1edfce0
AK
2563 int level;
2564#define FF_LEVEL_UNKNOWN -99
37b00b47 2565
37b00b47 2566 /**
b1edfce0
AK
2567 * - encoding: unused
2568 * - decoding: Set by user.
37b00b47 2569 */
b1edfce0 2570 enum AVDiscard skip_loop_filter;
37b00b47
AS
2571
2572 /**
b1edfce0
AK
2573 * - encoding: unused
2574 * - decoding: Set by user.
37b00b47 2575 */
b1edfce0 2576 enum AVDiscard skip_idct;
37b00b47
AS
2577
2578 /**
b1edfce0 2579 * - encoding: unused
37b00b47
AS
2580 * - decoding: Set by user.
2581 */
b1edfce0 2582 enum AVDiscard skip_frame;
55bad0c6
CM
2583
2584 /**
b1edfce0
AK
2585 * Header containing style information for text subtitles.
2586 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2587 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2588 * the Format line following. It shouldn't include any Dialogue line.
2589 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2590 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
55bad0c6 2591 */
b1edfce0
AK
2592 uint8_t *subtitle_header;
2593 int subtitle_header_size;
34b47d7c 2594
2507b5dd 2595#if FF_API_VBV_DELAY
f3a29b75 2596 /**
b1edfce0
AK
2597 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2598 * Used for compliant TS muxing.
2599 * - encoding: Set by libavcodec.
2600 * - decoding: unused.
2507b5dd
AK
2601 * @deprecated this value is now exported as a part of
2602 * AV_PKT_DATA_CPB_PROPERTIES packet side data
4bf3c8f2 2603 */
2507b5dd 2604 attribute_deprecated
b1edfce0 2605 uint64_t vbv_delay;
2507b5dd 2606#endif
0957b274 2607
6064f697 2608#if FF_API_SIDEDATA_ONLY_PKT
0957b274 2609 /**
6064f697
VG
2610 * Encoding only and set by default. Allow encoders to output packets
2611 * that do not contain any encoded data, only side data.
0957b274
AK
2612 *
2613 * Some encoders need to output such packets, e.g. to update some stream
2614 * parameters at the end of encoding.
2615 *
6064f697
VG
2616 * @deprecated this field disables the default behaviour and
2617 * it is kept only for compatibility.
0957b274 2618 */
6064f697 2619 attribute_deprecated
0957b274 2620 int side_data_only_packets;
6064f697 2621#endif
2df0c32e
AK
2622
2623 /**
2624 * Audio only. The number of "priming" samples (padding) inserted by the
2625 * encoder at the beginning of the audio. I.e. this number of leading
2626 * decoded samples must be discarded by the caller to get the original audio
2627 * without leading padding.
2628 *
2629 * - decoding: unused
2630 * - encoding: Set by libavcodec. The timestamps on the output packets are
2631 * adjusted by the encoder so that they always refer to the
2632 * first sample of the data actually contained in the packet,
2633 * including any added padding. E.g. if the timebase is
2634 * 1/samplerate and the timestamp of the first input sample is
2635 * 0, the timestamp of the first output packet will be
2636 * -initial_padding.
2637 */
2638 int initial_padding;
7ea1b347
AK
2639
2640 /*
2641 * - decoding: For codecs that store a framerate value in the compressed
2642 * bitstream, the decoder may export it here. { 0, 1} when
2643 * unknown.
9d4d9be5
MS
2644 * - encoding: May be used to signal the framerate of CFR content to an
2645 * encoder.
7ea1b347
AK
2646 */
2647 AVRational framerate;
57b6704e
RDC
2648
2649 /**
2650 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2651 * - encoding: unused.
2652 * - decoding: Set by libavcodec before calling get_format()
2653 */
2654 enum AVPixelFormat sw_pix_fmt;
84adab33
AK
2655
2656 /**
2657 * Additional data associated with the entire coded stream.
2658 *
2659 * - decoding: unused
2660 * - encoding: may be set by libavcodec after avcodec_open2().
2661 */
2662 AVPacketSideData *coded_side_data;
2663 int nb_coded_side_data;
2664
7b3214d0 2665 /**
e85f6f7f
AK
2666 * A reference to the AVHWFramesContext describing the input (for encoding)
2667 * or output (decoding) frames. The reference is set by the caller and
44f2eda3
MT
2668 * afterwards owned (and freed) by libavcodec - it should never be read by
2669 * the caller after being set.
7b3214d0 2670 *
e85f6f7f
AK
2671 * - decoding: This field should be set by the caller from the get_format()
2672 * callback. The previous reference (if any) will always be
2673 * unreffed by libavcodec before the get_format() call.
7b3214d0 2674 *
e85f6f7f
AK
2675 * If the default get_buffer2() is used with a hwaccel pixel
2676 * format, then this AVHWFramesContext will be used for
2677 * allocating the frame buffers.
2678 *
2679 * - encoding: For hardware encoders configured to use a hwaccel pixel
2680 * format, this field should be set by the caller to a reference
2681 * to the AVHWFramesContext describing input frames.
2682 * AVHWFramesContext.format must be equal to
2683 * AVCodecContext.pix_fmt.
2684 *
2685 * This field should be set before avcodec_open2() is called.
7b3214d0
AK
2686 */
2687 AVBufferRef *hw_frames_ctx;
019ab88a
AK
2688
2689 /**
2690 * Video decoding only. Certain video codecs support cropping, meaning that
2691 * only a sub-rectangle of the decoded frame is intended for display. This
2692 * option controls how cropping is handled by libavcodec.
2693 *
2694 * When set to 1 (the default), libavcodec will apply cropping internally.
2695 * I.e. it will modify the output frame width/height fields and offset the
2696 * data pointers (only by as much as possible while preserving alignment, or
2697 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2698 * the frames output by the decoder refer only to the cropped area. The
2699 * crop_* fields of the output frames will be zero.
2700 *
2701 * When set to 0, the width/height fields of the output frames will be set
2702 * to the coded dimensions and the crop_* fields will describe the cropping
2703 * rectangle. Applying the cropping is left to the caller.
2704 *
2705 * @warning When hardware acceleration with opaque output frames is used,
2706 * libavcodec is unable to apply cropping from the top/left border.
2707 *
2708 * @note when this option is set to zero, the width/height fields of the
2709 * AVCodecContext and output AVFrames have different meanings. The codec
2710 * context fields store display dimensions (with the coded dimensions in
2711 * coded_width/height), while the frame fields store the coded dimensions
2712 * (with the display dimensions being determined by the crop_* fields).
2713 */
2714 int apply_cropping;
44f2eda3
MT
2715
2716 /**
2717 * A reference to the AVHWDeviceContext describing the device which will
2718 * be used by a hardware encoder/decoder. The reference is set by the
2719 * caller and afterwards owned (and freed) by libavcodec.
2720 *
2721 * This should be used if either the codec device does not require
2722 * hardware frames or any that are used are to be allocated internally by
2723 * libavcodec. If the user wishes to supply any of the frames used as
2724 * encoder input or decoder output then hw_frames_ctx should be used
2725 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2726 * field will be ignored while decoding the associated stream segment, but
2727 * may again be used on a following one after another get_format() call.
2728 *
2729 * For both encoders and decoders this field should be set before
2730 * avcodec_open2() is called and must not be written to thereafter.
2731 *
2732 * Note that some decoders may require this field to be set initially in
2733 * order to support hw_frames_ctx at all - in that case, all frames
2734 * contexts used must be created on the same device.
2735 */
2736 AVBufferRef *hw_device_ctx;
16a163b5 2737
2738 /**
2739 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2740 * decoding (if active).
2741 * - encoding: unused
2742 * - decoding: Set by user (either before avcodec_open2(), or in the
2743 * AVCodecContext.get_format callback)
2744 */
2745 int hwaccel_flags;
5b145290
MT
2746
2747 /**
2748 * Video decoding only. Sets the number of extra hardware frames which
2749 * the decoder will allocate for use by the caller. This must be set
2750 * before avcodec_open2() is called.
2751 *
2752 * Some hardware decoders require all frames that they will use for
2753 * output to be defined in advance before decoding starts. For such
2754 * decoders, the hardware frame pool must therefore be of a fixed size.
2755 * The extra frames set here are on top of any number that the decoder
2756 * needs internally in order to operate normally (for example, frames
2757 * used as reference pictures).
2758 */
2759 int extra_hw_frames;
de6d9b64
FB
2760} AVCodecContext;
2761
64863965 2762/**
060ec0a8
AH
2763 * AVProfile.
2764 */
2765typedef struct AVProfile {
2766 int profile;
2767 const char *name; ///< short name for the profile
2768} AVProfile;
2769
720cf4e6
MT
2770enum {
2771 /**
2772 * The codec supports this format via the hw_device_ctx interface.
2773 *
2774 * When selecting this format, AVCodecContext.hw_device_ctx should
2775 * have been set to a device of the specified type before calling
2776 * avcodec_open2().
2777 */
2778 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2779 /**
2780 * The codec supports this format via the hw_frames_ctx interface.
2781 *
2782 * When selecting this format for a decoder,
2783 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2784 * context inside the get_format() callback. The frames context
2785 * must have been created on a device of the specified type.
2786 */
2787 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2788 /**
2789 * The codec supports this format by some internal method.
2790 *
2791 * This format can be selected without any additional configuration -
2792 * no device or frames context is required.
2793 */
2794 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2795 /**
2796 * The codec supports this format by some ad-hoc method.
2797 *
2798 * Additional settings and/or function calls are required. See the
2799 * codec-specific documentation for details. (Methods requiring
2800 * this sort of configuration are deprecated and others should be
2801 * used in preference.)
2802 */
2803 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2804};
2805
2806typedef struct AVCodecHWConfig {
2807 /**
2808 * A hardware pixel format which the codec can use.
2809 */
2810 enum AVPixelFormat pix_fmt;
2811 /**
2812 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2813 * setup methods which can be used with this configuration.
2814 */
2815 int methods;
2816 /**
2817 * The device type associated with the configuration.
2818 *
2819 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2820 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2821 */
2822 enum AVHWDeviceType device_type;
2823} AVCodecHWConfig;
2824
84626b36
AK
2825typedef struct AVCodecDefault AVCodecDefault;
2826
466b39ef
AK
2827struct AVSubtitle;
2828
060ec0a8 2829/**
64863965
MN
2830 * AVCodec.
2831 */
de6d9b64 2832typedef struct AVCodec {
6b0cdb6e
NG
2833 /**
2834 * Name of the codec implementation.
2835 * The name is globally unique among encoders and among decoders (but an
2836 * encoder and a decoder can share the same name).
2837 * This is the primary way to find a codec from the user perspective.
2838 */
18f77016 2839 const char *name;
f5f49a66
AK
2840 /**
2841 * Descriptive name for the codec, meant to be more human readable than name.
2842 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2843 */
2844 const char *long_name;
72415b2a 2845 enum AVMediaType type;
36ef5369 2846 enum AVCodecID id;
a2d11246
MN
2847 /**
2848 * Codec capabilities.
def97856 2849 * see AV_CODEC_CAP_*
a2d11246 2850 */
bf89e6b1 2851 int capabilities;
716e31ea 2852 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
716d413c 2853 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3ade5d56 2854 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
5d6e4c16 2855 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
cc276c85 2856 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
567ad0e3 2857 const AVClass *priv_class; ///< AVClass for the private context
060ec0a8 2858 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
37b00b47 2859
47687a2f 2860 /**
2861 * Group name of the codec implementation.
2862 * This is a short symbolic name of the wrapper backing this codec. A
2863 * wrapper uses some kind of external implementation for the codec, such
2864 * as an external library, or a codec implementation provided by the OS or
2865 * the hardware.
2866 * If this field is NULL, this is a builtin, libavcodec native decoder.
2867 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2868 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2869 */
2870 const char *wrapper_name;
2871
f5f49a66
AK
2872 /*****************************************************************
2873 * No fields below this line are part of the public API. They
2874 * may not be used outside of libavcodec and can be changed and
2875 * removed at will.
2876 * New public fields should be added right above.
2877 *****************************************************************
2878 */
2879 int priv_data_size;
2880 struct AVCodec *next;
37b00b47 2881 /**
21a19b79 2882 * @name Frame-level threading support functions
37b00b47
AS
2883 * @{
2884 */
2885 /**
2886 * If defined, called on thread contexts when they are created.
2887 * If the codec allocates writable tables in init(), re-allocate them here.
2888 * priv_data will be set to a copy of the original.
2889 */
2890 int (*init_thread_copy)(AVCodecContext *);
2891 /**
2892 * Copy necessary context variables from a previous thread context to the current one.
2893 * If not defined, the next thread will start automatically; otherwise, the codec
2894 * must call ff_thread_finish_setup().
2895 *
2896 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2897 */
2898 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2899 /** @} */
84626b36
AK
2900
2901 /**
2902 * Private codec-specific defaults.
2903 */
2904 const AVCodecDefault *defaults;
d97efd7f
AK
2905
2906 /**
2907 * Initialize codec static data, called from avcodec_register().
2908 */
2909 void (*init_static_data)(struct AVCodec *codec);
b2c75b6e 2910
f5f49a66 2911 int (*init)(AVCodecContext *);
466b39ef
AK
2912 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2913 const struct AVSubtitle *sub);
b2c75b6e
JR
2914 /**
2915 * Encode data to an AVPacket.
2916 *
2917 * @param avctx codec context
2918 * @param avpkt output AVPacket (may contain a user-provided buffer)
2919 * @param[in] frame AVFrame containing the raw data to be encoded
2920 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2921 * non-empty packet was returned in avpkt.
2922 * @return 0 on success, negative error code on failure
2923 */
2924 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2925 int *got_packet_ptr);
f5f49a66
AK
2926 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2927 int (*close)(AVCodecContext *);
2928 /**
061a0c14 2929 * Encode API with decoupled packet/frame dataflow. The API is the
05f66706 2930 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2931 * that:
2932 * - never called if the codec is closed or the wrong type,
061a0c14
AK
2933 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2934 * - only one drain frame is ever passed down,
05f66706 2935 */
2936 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
05f66706 2937 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
061a0c14
AK
2938
2939 /**
2940 * Decode API with decoupled packet/frame dataflow. This function is called
2941 * to get one output frame. It should call ff_decode_get_packet() to obtain
2942 * input data.
2943 */
2944 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
05f66706 2945 /**
f5f49a66
AK
2946 * Flush buffers.
2947 * Will be called when seeking
2948 */
2949 void (*flush)(AVCodecContext *);
117b4327
VG
2950 /**
2951 * Internal codec capabilities.
2952 * See FF_CODEC_CAP_* in internal.h
2953 */
2954 int caps_internal;
972c71e9
AK
2955
2956 /**
2957 * Decoding only, a comma-separated list of bitstream filters to apply to
2958 * packets before decoding.
2959 */
2960 const char *bsfs;
720cf4e6
MT
2961
2962 /**
2963 * Array of pointers to hardware configurations supported by the codec,
2964 * or NULL if no hardware supported. The array is terminated by a NULL
2965 * pointer.
2966 *
2967 * The user can only access this field via avcodec_get_hw_config().
2968 */
2969 const struct AVCodecHWConfigInternal **hw_configs;
de6d9b64
FB
2970} AVCodec;
2971
97d96aaa 2972/**
720cf4e6
MT
2973 * Retrieve supported hardware configurations for a codec.
2974 *
2975 * Values of index from zero to some maximum return the indexed configuration
2976 * descriptor; all other values return NULL. If the codec does not support
2977 * any hardware configurations then it will always return NULL.
2978 */
2979const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2980
2981/**
d565fef1 2982 * @defgroup lavc_hwaccel AVHWAccel
e2d57554
MT
2983 *
2984 * @note Nothing in this structure should be accessed by the user. At some
2985 * point in future it will not be externally visible at all.
2986 *
d565fef1 2987 * @{
40e5d31b
GB
2988 */
2989typedef struct AVHWAccel {
2990 /**
2991 * Name of the hardware accelerated codec.
2992 * The name is globally unique among encoders and among decoders (but an
2993 * encoder and a decoder can share the same name).
2994 */
2995 const char *name;
2996
2997 /**
2998 * Type of codec implemented by the hardware accelerator.
2999 *
72415b2a 3000 * See AVMEDIA_TYPE_xxx
40e5d31b 3001 */
72415b2a 3002 enum AVMediaType type;
40e5d31b
GB
3003
3004 /**
3005 * Codec implemented by the hardware accelerator.
3006 *
36ef5369 3007 * See AV_CODEC_ID_xxx
40e5d31b 3008 */
36ef5369 3009 enum AVCodecID id;
40e5d31b
GB
3010
3011 /**
3012 * Supported pixel format.
3013 *
3014 * Only hardware accelerated formats are supported here.
3015 */
716d413c 3016 enum AVPixelFormat pix_fmt;
40e5d31b
GB
3017
3018 /**
3019 * Hardware accelerated codec capabilities.
3020 * see FF_HWACCEL_CODEC_CAP_*
3021 */
3022 int capabilities;
3023
08bb2567
AK
3024 /*****************************************************************
3025 * No fields below this line are part of the public API. They
3026 * may not be used outside of libavcodec and can be changed and
3027 * removed at will.
3028 * New public fields should be added right above.
3029 *****************************************************************
3030 */
40e5d31b
GB
3031 struct AVHWAccel *next;
3032
3033 /**
ebc29519
LB
3034 * Allocate a custom buffer
3035 */
3036 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3037
3038 /**
40e5d31b
GB
3039 * Called at the beginning of each frame or field picture.
3040 *
3041 * Meaningful frame information (codec specific) is guaranteed to
3042 * be parsed at this point. This function is mandatory.
3043 *
bf7e799c 3044 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
3045 * Otherwise, this means the whole frame is available at this point.
3046 *
3047 * @param avctx the codec context
3048 * @param buf the frame data buffer base
3049 * @param buf_size the size of the frame in bytes
3050 * @return zero if successful, a negative value otherwise
3051 */
3052 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3053
3054 /**
3055 * Callback for each slice.
3056 *
3057 * Meaningful slice information (codec specific) is guaranteed to
3058 * be parsed at this point. This function is mandatory.
3059 *
3060 * @param avctx the codec context
3061 * @param buf the slice data buffer base
3062 * @param buf_size the size of the slice in bytes
3063 * @return zero if successful, a negative value otherwise
3064 */
3065 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3066
3067 /**
3068 * Called at the end of each frame or field picture.
3069 *
3070 * The whole picture is parsed at this point and can now be sent
3071 * to the hardware accelerator. This function is mandatory.
3072 *
3073 * @param avctx the codec context
3074 * @return zero if successful, a negative value otherwise
3075 */
3076 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
3077
3078 /**
a871ef0c 3079 * Size of per-frame hardware accelerator private data.
68e5d523 3080 *
cd823ff9
GB
3081 * Private data is allocated with av_mallocz() before
3082 * AVCodecContext.get_buffer() and deallocated after
3083 * AVCodecContext.release_buffer().
68e5d523 3084 */
a871ef0c 3085 int frame_priv_data_size;
dd2d3b76
AK
3086
3087 /**
3088 * Initialize the hwaccel private data.
3089 *
3090 * This will be called from ff_get_format(), after hwaccel and
3091 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3092 * is allocated.
3093 */
3094 int (*init)(AVCodecContext *avctx);
3095
3096 /**
3097 * Uninitialize the hwaccel private data.
3098 *
3099 * This will be called from get_format() or avcodec_close(), after hwaccel
3100 * and hwaccel_context are already uninitialized.
3101 */
3102 int (*uninit)(AVCodecContext *avctx);
3103
3104 /**
3105 * Size of the private data to allocate in
3106 * AVCodecInternal.hwaccel_priv_data.
3107 */
3108 int priv_data_size;
d4a91e65
AK
3109
3110 /**
3111 * Internal hwaccel capabilities.
3112 */
3113 int caps_internal;
b46a77f1 3114
3115 /**
3116 * Fill the given hw_frames context with current codec parameters. Called
3117 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3118 * details.
3119 *
3120 * This CAN be called before AVHWAccel.init is called, and you must assume
3121 * that avctx->hwaccel_priv_data is invalid.
3122 */
3123 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
40e5d31b
GB
3124} AVHWAccel;
3125
3126/**
d565fef1
RDC
3127 * Hardware acceleration should be used for decoding even if the codec level
3128 * used is unknown or higher than the maximum supported level reported by the
3129 * hardware driver.
3130 */
3131#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3132
3133/**
6c99c92a
RDC
3134 * Hardware acceleration can output YUV pixel formats with a different chroma
3135 * sampling than 4:2:0 and/or other than 8 bits per component.
3136 */
3137#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3138
3139/**
64a5260c
MT
3140 * Hardware acceleration should still be attempted for decoding when the
3141 * codec profile does not match the reported capabilities of the hardware.
3142 *
3143 * For example, this can be used to try to decode baseline profile H.264
3144 * streams in hardware - it will often succeed, because many streams marked
3145 * as baseline profile actually conform to constrained baseline profile.
3146 *
3147 * @warning If the stream is actually not supported then the behaviour is
3148 * undefined, and may include returning entirely incorrect output
3149 * while indicating success.
3150 */
3151#define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3152
3153/**
d565fef1
RDC
3154 * @}
3155 */
3156
dca23ffb 3157#if FF_API_AVPICTURE
d565fef1 3158/**
6aadfbda
AK
3159 * @defgroup lavc_picture AVPicture
3160 *
3161 * Functions for working with AVPicture
3162 * @{
3163 */
3164
3165/**
d7425f59
MN
3166 * four components are given, that's all.
3167 * the last component is alpha
f3aff31e 3168 * @deprecated Use the imgutils functions
d7425f59 3169 */
de6d9b64 3170typedef struct AVPicture {
f3aff31e 3171 attribute_deprecated
560f773c 3172 uint8_t *data[AV_NUM_DATA_POINTERS];
f3aff31e 3173 attribute_deprecated
560f773c 3174 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
de6d9b64
FB
3175} AVPicture;
3176
6aadfbda
AK
3177/**
3178 * @}
3179 */
dca23ffb 3180#endif
6aadfbda 3181
63e4c8a6
AK
3182#define AVPALETTE_SIZE 1024
3183#define AVPALETTE_COUNT 256
ba118447 3184
c66216ed
MN
3185enum AVSubtitleType {
3186 SUBTITLE_NONE,
3187
3188 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3189
3190 /**
3191 * Plain text, the text field must be set by the decoder and is
3192 * authoritative. ass and pict fields may contain approximations.
3193 */
3194 SUBTITLE_TEXT,
3195
3196 /**
3197 * Formatted text, the ass field must be set by the decoder and is
3198 * authoritative. pict and text fields may contain approximations.
3199 */
3200 SUBTITLE_ASS,
3201};
3202
85f67c48
JS
3203#define AV_SUBTITLE_FLAG_FORCED 0x00000001
3204
c6ec28b1 3205typedef struct AVSubtitleRect {
ebc466bb
MN
3206 int x; ///< top left corner of pict, undefined when pict is not set
3207 int y; ///< top left corner of pict, undefined when pict is not set
3208 int w; ///< width of pict, undefined when pict is not set
3209 int h; ///< height of pict, undefined when pict is not set
3210 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651 3211
a17a7661 3212#if FF_API_AVPICTURE
25b4c651 3213 /**
a17a7661 3214 * @deprecated unused
25b4c651 3215 */
a17a7661 3216 attribute_deprecated
25b4c651 3217 AVPicture pict;
a17a7661
VG
3218#endif
3219 /**
3220 * data+linesize for the bitmap of this subtitle.
3221 * Can be set for text/ass as well once they are rendered.
3222 */
3223 uint8_t *data[4];
3224 int linesize[4];
3225
f656106f
MN
3226 enum AVSubtitleType type;
3227
3228 char *text; ///< 0 terminated plain UTF-8 text
3229
3230 /**
3231 * 0 terminated ASS/SSA compatible event line.
41ed7ab4 3232 * The presentation of this is unaffected by the other values in this
f656106f
MN
3233 * struct.
3234 */
3235 char *ass;
85f67c48 3236 int flags;
c6ec28b1
MN
3237} AVSubtitleRect;
3238
3239typedef struct AVSubtitle {
3240 uint16_t format; /* 0 = graphics */
3241 uint32_t start_display_time; /* relative to packet pts, in ms */
3242 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 3243 unsigned num_rects;
db4fac64 3244 AVSubtitleRect **rects;
4bbe788a 3245 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
3246} AVSubtitle;
3247
294b3a50 3248/**
998e1b8f
AK
3249 * This struct describes the properties of an encoded stream.
3250 *
3251 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3252 * be allocated with avcodec_parameters_alloc() and freed with
3253 * avcodec_parameters_free().
3254 */
3255typedef struct AVCodecParameters {
3256 /**
3257 * General type of the encoded data.
3258 */
3259 enum AVMediaType codec_type;
3260 /**
3261 * Specific type of the encoded data (the codec used).
3262 */
3263 enum AVCodecID codec_id;
3264 /**
3265 * Additional information about the codec (corresponds to the AVI FOURCC).
3266 */
3267 uint32_t codec_tag;
3268
3269 /**
3270 * Extra binary data needed for initializing the decoder, codec-dependent.
3271 *
3272 * Must be allocated with av_malloc() and will be freed by
3273 * avcodec_parameters_free(). The allocated size of extradata must be at
3274 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3275 * bytes zeroed.
3276 */
3277 uint8_t *extradata;
3278 /**
3279 * Size of the extradata content in bytes.
3280 */
3281 int extradata_size;
3282
3283 /**
3284 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3285 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3286 */
3287 int format;
3288
3289 /**
3290 * The average bitrate of the encoded data (in bits per second).
3291 */
3292 int bit_rate;
3293
3294 int bits_per_coded_sample;
3295
3296 /**
3297 * Codec-specific bitstream restrictions that the stream conforms to.
3298 */
3299 int profile;
3300 int level;
3301
3302 /**
3303 * Video only. The dimensions of the video frame in pixels.
3304 */
3305 int width;
3306 int height;
3307
3308 /**
3309 * Video only. The aspect ratio (width / height) which a single pixel
3310 * should have when displayed.
3311 *
3312 * When the aspect ratio is unknown / undefined, the numerator should be
3313 * set to 0 (the denominator may have any value).
3314 */
3315 AVRational sample_aspect_ratio;
3316
3317 /**
3318 * Video only. The order of the fields in interlaced video.
3319 */
3320 enum AVFieldOrder field_order;
3321
3322 /**
3323 * Video only. Additional colorspace characteristics.
3324 */
3325 enum AVColorRange color_range;
3326 enum AVColorPrimaries color_primaries;
3327 enum AVColorTransferCharacteristic color_trc;
3328 enum AVColorSpace color_space;
3329 enum AVChromaLocation chroma_location;
3330
3331 /**
3332 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3333 * unknown or unspecified, otherwise the number of bits set must be equal to
3334 * the channels field.
3335 */
3336 uint64_t channel_layout;
3337 /**
3338 * Audio only. The number of audio channels.
3339 */
3340 int channels;
3341 /**
3342 * Audio only. The number of audio samples per second.
3343 */
3344 int sample_rate;
3345 /**
3346 * Audio only. The number of bytes per coded audio frame, required by some
3347 * formats.
3348 *
3349 * Corresponds to nBlockAlign in WAVEFORMATEX.
3350 */
3351 int block_align;
3352
3353 /**
3354 * Audio only. The amount of padding (in samples) inserted by the encoder at
3355 * the beginning of the audio. I.e. this number of leading decoded samples
3356 * must be discarded by the caller to get the original audio without leading
3357 * padding.
3358 */
3359 int initial_padding;
3360 /**
3361 * Audio only. The amount of padding (in samples) appended by the encoder to
3362 * the end of the audio. I.e. this number of decoded samples must be
3363 * discarded by the caller from the end of the stream to get the original
3364 * audio without any trailing padding.
3365 */
3366 int trailing_padding;
3367} AVCodecParameters;
3368
3369/**
294b3a50
AK
3370 * If c is NULL, returns the first registered codec,
3371 * if c is non-NULL, returns the next registered codec after c,
3372 * or NULL if c is the last one.
3373 */
0a0f19b5 3374AVCodec *av_codec_next(const AVCodec *c);
294b3a50
AK
3375
3376/**
3377 * Return the LIBAVCODEC_VERSION_INT constant.
3378 */
3379unsigned avcodec_version(void);
3380
3381/**
3382 * Return the libavcodec build-time configuration.
3383 */
3384const char *avcodec_configuration(void);
3385
3386/**
3387 * Return the libavcodec license.
3388 */
3389const char *avcodec_license(void);
3390
3391/**
3392 * Register the codec codec and initialize libavcodec.
3393 *
3394 * @warning either this function or avcodec_register_all() must be called
3395 * before any other libavcodec functions.
3396 *
3397 * @see avcodec_register_all()
3398 */
3399void avcodec_register(AVCodec *codec);
3400
3401/**
3402 * Register all the codecs, parsers and bitstream filters which were enabled at
3403 * configuration time. If you do not call this function you can select exactly
3404 * which formats you want to support, by using the individual registration
3405 * functions.
3406 *
3407 * @see avcodec_register
3408 * @see av_register_codec_parser
3409 * @see av_register_bitstream_filter