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