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