727e1c411d83addfb9eea47269a898458363e81a
[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 * This codec takes the reordered_opaque field from input AVFrames
904 * and returns it in the corresponding field in AVCodecContext after
905 * encoding.
906 */
907 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 19)
908
909 /**
910 * Pan Scan area.
911 * This specifies the area which should be displayed.
912 * Note there may be multiple such areas for one frame.
913 */
914 typedef struct AVPanScan{
915 /**
916 * id
917 * - encoding: Set by user.
918 * - decoding: Set by libavcodec.
919 */
920 int id;
921
922 /**
923 * width and height in 1/16 pel
924 * - encoding: Set by user.
925 * - decoding: Set by libavcodec.
926 */
927 int width;
928 int height;
929
930 /**
931 * position of the top left corner in 1/16 pel for up to 3 fields/frames
932 * - encoding: Set by user.
933 * - decoding: Set by libavcodec.
934 */
935 int16_t position[3][2];
936 }AVPanScan;
937
938 /**
939 * This structure describes the bitrate properties of an encoded bitstream. It
940 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
941 * parameters for H.264/HEVC.
942 */
943 typedef struct AVCPBProperties {
944 /**
945 * Maximum bitrate of the stream, in bits per second.
946 * Zero if unknown or unspecified.
947 */
948 int max_bitrate;
949 /**
950 * Minimum bitrate of the stream, in bits per second.
951 * Zero if unknown or unspecified.
952 */
953 int min_bitrate;
954 /**
955 * Average bitrate of the stream, in bits per second.
956 * Zero if unknown or unspecified.
957 */
958 int avg_bitrate;
959
960 /**
961 * The size of the buffer to which the ratecontrol is applied, in bits.
962 * Zero if unknown or unspecified.
963 */
964 int buffer_size;
965
966 /**
967 * The delay between the time the packet this structure is associated with
968 * is received and the time when it should be decoded, in periods of a 27MHz
969 * clock.
970 *
971 * UINT64_MAX when unknown or unspecified.
972 */
973 uint64_t vbv_delay;
974 } AVCPBProperties;
975
976 /**
977 * The decoder will keep a reference to the frame and may reuse it later.
978 */
979 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
980
981 /**
982 * @defgroup lavc_packet AVPacket
983 *
984 * Types and functions for working with AVPacket.
985 * @{
986 */
987 enum AVPacketSideDataType {
988 /**
989 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
990 * bytes worth of palette. This side data signals that a new palette is
991 * present.
992 */
993 AV_PKT_DATA_PALETTE,
994
995 /**
996 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
997 * that the extradata buffer was changed and the receiving side should
998 * act upon it appropriately. The new extradata is embedded in the side
999 * data buffer and should be immediately used for processing the current
1000 * frame or packet.
1001 */
1002 AV_PKT_DATA_NEW_EXTRADATA,
1003
1004 /**
1005 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1006 * @code
1007 * u32le param_flags
1008 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1009 * s32le channel_count
1010 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1011 * u64le channel_layout
1012 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1013 * s32le sample_rate
1014 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1015 * s32le width
1016 * s32le height
1017 * @endcode
1018 */
1019 AV_PKT_DATA_PARAM_CHANGE,
1020
1021 /**
1022 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1023 * structures with info about macroblocks relevant to splitting the
1024 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1025 * That is, it does not necessarily contain info about all macroblocks,
1026 * as long as the distance between macroblocks in the info is smaller
1027 * than the target payload size.
1028 * Each MB info structure is 12 bytes, and is laid out as follows:
1029 * @code
1030 * u32le bit offset from the start of the packet
1031 * u8 current quantizer at the start of the macroblock
1032 * u8 GOB number
1033 * u16le macroblock address within the GOB
1034 * u8 horizontal MV predictor
1035 * u8 vertical MV predictor
1036 * u8 horizontal MV predictor for block number 3
1037 * u8 vertical MV predictor for block number 3
1038 * @endcode
1039 */
1040 AV_PKT_DATA_H263_MB_INFO,
1041
1042 /**
1043 * This side data should be associated with an audio stream and contains
1044 * ReplayGain information in form of the AVReplayGain struct.
1045 */
1046 AV_PKT_DATA_REPLAYGAIN,
1047
1048 /**
1049 * This side data contains a 3x3 transformation matrix describing an affine
1050 * transformation that needs to be applied to the decoded video frames for
1051 * correct presentation.
1052 *
1053 * See libavutil/display.h for a detailed description of the data.
1054 */
1055 AV_PKT_DATA_DISPLAYMATRIX,
1056
1057 /**
1058 * This side data should be associated with a video stream and contains
1059 * Stereoscopic 3D information in form of the AVStereo3D struct.
1060 */
1061 AV_PKT_DATA_STEREO3D,
1062
1063 /**
1064 * This side data should be associated with an audio stream and corresponds
1065 * to enum AVAudioServiceType.
1066 */
1067 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1068
1069 /**
1070 * This side data contains an integer value representing the quality
1071 * factor of the compressed frame. Allowed range is between 1 (good)
1072 * and FF_LAMBDA_MAX (bad).
1073 */
1074 AV_PKT_DATA_QUALITY_FACTOR,
1075
1076 /**
1077 * This side data contains an integer value representing the stream index
1078 * of a "fallback" track. A fallback track indicates an alternate
1079 * track to use when the current track can not be decoded for some reason.
1080 * e.g. no decoder available for codec.
1081 */
1082 AV_PKT_DATA_FALLBACK_TRACK,
1083
1084 /**
1085 * This side data corresponds to the AVCPBProperties struct.
1086 */
1087 AV_PKT_DATA_CPB_PROPERTIES,
1088
1089 /**
1090 * This side data should be associated with a video stream and corresponds
1091 * to the AVSphericalMapping structure.
1092 */
1093 AV_PKT_DATA_SPHERICAL,
1094 };
1095
1096 typedef struct AVPacketSideData {
1097 uint8_t *data;
1098 int size;
1099 enum AVPacketSideDataType type;
1100 } AVPacketSideData;
1101
1102 /**
1103 * This structure stores compressed data. It is typically exported by demuxers
1104 * and then passed as input to decoders, or received as output from encoders and
1105 * then passed to muxers.
1106 *
1107 * For video, it should typically contain one compressed frame. For audio it may
1108 * contain several compressed frames. Encoders are allowed to output empty
1109 * packets, with no compressed data, containing only side data
1110 * (e.g. to update some stream parameters at the end of encoding).
1111 *
1112 * AVPacket is one of the few structs in Libav, whose size is a part of public
1113 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1114 * without libavcodec and libavformat major bump.
1115 *
1116 * The semantics of data ownership depends on the buf field.
1117 * If it is set, the packet data is dynamically allocated and is
1118 * valid indefinitely until a call to av_packet_unref() reduces the
1119 * reference count to 0.
1120 *
1121 * If the buf field is not set av_packet_ref() would make a copy instead
1122 * of increasing the reference count.
1123 *
1124 * The side data is always allocated with av_malloc(), copied by
1125 * av_packet_ref() and freed by av_packet_unref().
1126 *
1127 * @see av_packet_ref
1128 * @see av_packet_unref
1129 */
1130 typedef struct AVPacket {
1131 /**
1132 * A reference to the reference-counted buffer where the packet data is
1133 * stored.
1134 * May be NULL, then the packet data is not reference-counted.
1135 */
1136 AVBufferRef *buf;
1137 /**
1138 * Presentation timestamp in AVStream->time_base units; the time at which
1139 * the decompressed packet will be presented to the user.
1140 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1141 * pts MUST be larger or equal to dts as presentation cannot happen before
1142 * decompression, unless one wants to view hex dumps. Some formats misuse
1143 * the terms dts and pts/cts to mean something different. Such timestamps
1144 * must be converted to true pts/dts before they are stored in AVPacket.
1145 */
1146 int64_t pts;
1147 /**
1148 * Decompression timestamp in AVStream->time_base units; the time at which
1149 * the packet is decompressed.
1150 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1151 */
1152 int64_t dts;
1153 uint8_t *data;
1154 int size;
1155 int stream_index;
1156 /**
1157 * A combination of AV_PKT_FLAG values
1158 */
1159 int flags;
1160 /**
1161 * Additional packet data that can be provided by the container.
1162 * Packet can contain several types of side information.
1163 */
1164 AVPacketSideData *side_data;
1165 int side_data_elems;
1166
1167 /**
1168 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1169 * Equals next_pts - this_pts in presentation order.
1170 */
1171 int64_t duration;
1172
1173 int64_t pos; ///< byte position in stream, -1 if unknown
1174
1175 #if FF_API_CONVERGENCE_DURATION
1176 /**
1177 * @deprecated Same as the duration field, but as int64_t. This was required
1178 * for Matroska subtitles, whose duration values could overflow when the
1179 * duration field was still an int.
1180 */
1181 attribute_deprecated
1182 int64_t convergence_duration;
1183 #endif
1184 } AVPacket;
1185 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1186 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1187
1188 enum AVSideDataParamChangeFlags {
1189 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1190 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1191 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1192 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1193 };
1194 /**
1195 * @}
1196 */
1197
1198 struct AVCodecInternal;
1199
1200 enum AVFieldOrder {
1201 AV_FIELD_UNKNOWN,
1202 AV_FIELD_PROGRESSIVE,
1203 AV_FIELD_TT, //< Top coded_first, top displayed first
1204 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1205 AV_FIELD_TB, //< Top coded first, bottom displayed first
1206 AV_FIELD_BT, //< Bottom coded first, top displayed first
1207 };
1208
1209 /**
1210 * main external API structure.
1211 * New fields can be added to the end with minor version bumps.
1212 * Removal, reordering and changes to existing fields require a major
1213 * version bump.
1214 * sizeof(AVCodecContext) must not be used outside libav*.
1215 */
1216 typedef struct AVCodecContext {
1217 /**
1218 * information on struct for av_log
1219 * - set by avcodec_alloc_context3
1220 */
1221 const AVClass *av_class;
1222 int log_level_offset;
1223
1224 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1225 const struct AVCodec *codec;
1226 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1227
1228 /**
1229 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1230 * This is used to work around some encoder bugs.
1231 * A demuxer should set this to what is stored in the field used to identify the codec.
1232 * If there are multiple such fields in a container then the demuxer should choose the one
1233 * which maximizes the information about the used codec.
1234 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1235 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1236 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1237 * first.
1238 * - encoding: Set by user, if not then the default based on codec_id will be used.
1239 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1240 */
1241 unsigned int codec_tag;
1242
1243 void *priv_data;
1244
1245 /**
1246 * Private context used for internal data.
1247 *
1248 * Unlike priv_data, this is not codec-specific. It is used in general
1249 * libavcodec functions.
1250 */
1251 struct AVCodecInternal *internal;
1252
1253 /**
1254 * Private data of the user, can be used to carry app specific stuff.
1255 * - encoding: Set by user.
1256 * - decoding: Set by user.
1257 */
1258 void *opaque;
1259
1260 /**
1261 * the average bitrate
1262 * - encoding: Set by user; unused for constant quantizer encoding.
1263 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1264 */
1265 int bit_rate;
1266
1267 /**
1268 * number of bits the bitstream is allowed to diverge from the reference.
1269 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1270 * - encoding: Set by user; unused for constant quantizer encoding.
1271 * - decoding: unused
1272 */
1273 int bit_rate_tolerance;
1274
1275 /**
1276 * Global quality for codecs which cannot change it per frame.
1277 * This should be proportional to MPEG-1/2/4 qscale.
1278 * - encoding: Set by user.
1279 * - decoding: unused
1280 */
1281 int global_quality;
1282
1283 /**
1284 * - encoding: Set by user.
1285 * - decoding: unused
1286 */
1287 int compression_level;
1288 #define FF_COMPRESSION_DEFAULT -1
1289
1290 /**
1291 * AV_CODEC_FLAG_*.
1292 * - encoding: Set by user.
1293 * - decoding: Set by user.
1294 */
1295 int flags;
1296
1297 /**
1298 * AV_CODEC_FLAG2_*
1299 * - encoding: Set by user.
1300 * - decoding: Set by user.
1301 */
1302 int flags2;
1303
1304 /**
1305 * some codecs need / can use extradata like Huffman tables.
1306 * MJPEG: Huffman tables
1307 * rv10: additional flags
1308 * MPEG-4: global headers (they can be in the bitstream or here)
1309 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1310 * than extradata_size to avoid problems if it is read with the bitstream reader.
1311 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1312 * - encoding: Set/allocated/freed by libavcodec.
1313 * - decoding: Set/allocated/freed by user.
1314 */
1315 uint8_t *extradata;
1316 int extradata_size;
1317
1318 /**
1319 * This is the fundamental unit of time (in seconds) in terms
1320 * of which frame timestamps are represented. For fixed-fps content,
1321 * timebase should be 1/framerate and timestamp increments should be
1322 * identically 1.
1323 * - encoding: MUST be set by user.
1324 * - decoding: the use of this field for decoding is deprecated.
1325 * Use framerate instead.
1326 */
1327 AVRational time_base;
1328
1329 /**
1330 * For some codecs, the time base is closer to the field rate than the frame rate.
1331 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1332 * if no telecine is used ...
1333 *
1334 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1335 */
1336 int ticks_per_frame;
1337
1338 /**
1339 * Codec delay.
1340 *
1341 * Video:
1342 * Number of frames the decoded output will be delayed relative to the
1343 * encoded input.
1344 *
1345 * Audio:
1346 * For encoding, this field is unused (see initial_padding).
1347 *
1348 * For decoding, this is the number of samples the decoder needs to
1349 * output before the decoder's output is valid. When seeking, you should
1350 * start decoding this many samples prior to your desired seek point.
1351 *
1352 * - encoding: Set by libavcodec.
1353 * - decoding: Set by libavcodec.
1354 */
1355 int delay;
1356
1357
1358 /* video only */
1359 /**
1360 * picture width / height.
1361 *
1362 * @note Those fields may not match the values of the last
1363 * AVFrame output by avcodec_decode_video2 due frame
1364 * reordering.
1365 *
1366 * - encoding: MUST be set by user.
1367 * - decoding: May be set by the user before opening the decoder if known e.g.
1368 * from the container. Some decoders will require the dimensions
1369 * to be set by the caller. During decoding, the decoder may
1370 * overwrite those values as required while parsing the data.
1371 */
1372 int width, height;
1373
1374 /**
1375 * Bitstream width / height, may be different from width/height e.g. when
1376 * the decoded frame is cropped before being output.
1377 *
1378 * @note Those field may not match the value of the last
1379 * AVFrame output by avcodec_receive_frame() due frame
1380 * reordering.
1381 *
1382 * - encoding: unused
1383 * - decoding: May be set by the user before opening the decoder if known
1384 * e.g. from the container. During decoding, the decoder may
1385 * overwrite those values as required while parsing the data.
1386 */
1387 int coded_width, coded_height;
1388
1389 /**
1390 * the number of pictures in a group of pictures, or 0 for intra_only
1391 * - encoding: Set by user.
1392 * - decoding: unused
1393 */
1394 int gop_size;
1395
1396 /**
1397 * Pixel format, see AV_PIX_FMT_xxx.
1398 * May be set by the demuxer if known from headers.
1399 * May be overridden by the decoder if it knows better.
1400 *
1401 * @note This field may not match the value of the last
1402 * AVFrame output by avcodec_receive_frame() due frame
1403 * reordering.
1404 *
1405 * - encoding: Set by user.
1406 * - decoding: Set by user if known, overridden by libavcodec while
1407 * parsing the data.
1408 */
1409 enum AVPixelFormat pix_fmt;
1410
1411 /**
1412 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1413 * decoder to draw a horizontal band. It improves cache usage. Not
1414 * all codecs can do that. You must check the codec capabilities
1415 * beforehand.
1416 * When multithreading is used, it may be called from multiple threads
1417 * at the same time; threads might draw different parts of the same AVFrame,
1418 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1419 * in order.
1420 * The function is also used by hardware acceleration APIs.
1421 * It is called at least once during frame decoding to pass
1422 * the data needed for hardware render.
1423 * In that mode instead of pixel data, AVFrame points to
1424 * a structure specific to the acceleration API. The application
1425 * reads the structure and can change some fields to indicate progress
1426 * or mark state.
1427 * - encoding: unused
1428 * - decoding: Set by user.
1429 * @param height the height of the slice
1430 * @param y the y position of the slice
1431 * @param type 1->top field, 2->bottom field, 3->frame
1432 * @param offset offset into the AVFrame.data from which the slice should be read
1433 */
1434 void (*draw_horiz_band)(struct AVCodecContext *s,
1435 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1436 int y, int type, int height);
1437
1438 /**
1439 * callback to negotiate the pixelFormat
1440 * @param fmt is the list of formats which are supported by the codec,
1441 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1442 * The first is always the native one.
1443 * @note The callback may be called again immediately if initialization for
1444 * the selected (hardware-accelerated) pixel format failed.
1445 * @warning Behavior is undefined if the callback returns a value not
1446 * in the fmt list of formats.
1447 * @return the chosen format
1448 * - encoding: unused
1449 * - decoding: Set by user, if not set the native format will be chosen.
1450 */
1451 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1452
1453 /**
1454 * maximum number of B-frames between non-B-frames
1455 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1456 * - encoding: Set by user.
1457 * - decoding: unused
1458 */
1459 int max_b_frames;
1460
1461 /**
1462 * qscale factor between IP and B-frames
1463 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1464 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1465 * - encoding: Set by user.
1466 * - decoding: unused
1467 */
1468 float b_quant_factor;
1469
1470 #if FF_API_PRIVATE_OPT
1471 /** @deprecated use encoder private options instead */
1472 attribute_deprecated
1473 int b_frame_strategy;
1474 #endif
1475
1476 /**
1477 * qscale offset between IP and B-frames
1478 * - encoding: Set by user.
1479 * - decoding: unused
1480 */
1481 float b_quant_offset;
1482
1483 /**
1484 * Size of the frame reordering buffer in the decoder.
1485 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1486 * - encoding: Set by libavcodec.
1487 * - decoding: Set by libavcodec.
1488 */
1489 int has_b_frames;
1490
1491 #if FF_API_PRIVATE_OPT
1492 /** @deprecated use encoder private options instead */
1493 attribute_deprecated
1494 int mpeg_quant;
1495 #endif
1496
1497 /**
1498 * qscale factor between P- and I-frames
1499 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1500 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1501 * - encoding: Set by user.
1502 * - decoding: unused
1503 */
1504 float i_quant_factor;
1505
1506 /**
1507 * qscale offset between P and I-frames
1508 * - encoding: Set by user.
1509 * - decoding: unused
1510 */
1511 float i_quant_offset;
1512
1513 /**
1514 * luminance masking (0-> disabled)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1517 */
1518 float lumi_masking;
1519
1520 /**
1521 * temporary complexity masking (0-> disabled)
1522 * - encoding: Set by user.
1523 * - decoding: unused
1524 */
1525 float temporal_cplx_masking;
1526
1527 /**
1528 * spatial complexity masking (0-> disabled)
1529 * - encoding: Set by user.
1530 * - decoding: unused
1531 */
1532 float spatial_cplx_masking;
1533
1534 /**
1535 * p block masking (0-> disabled)
1536 * - encoding: Set by user.
1537 * - decoding: unused
1538 */
1539 float p_masking;
1540
1541 /**
1542 * darkness masking (0-> disabled)
1543 * - encoding: Set by user.
1544 * - decoding: unused
1545 */
1546 float dark_masking;
1547
1548 /**
1549 * slice count
1550 * - encoding: Set by libavcodec.
1551 * - decoding: Set by user (or 0).
1552 */
1553 int slice_count;
1554
1555 #if FF_API_PRIVATE_OPT
1556 /** @deprecated use encoder private options instead */
1557 attribute_deprecated
1558 int prediction_method;
1559 #define FF_PRED_LEFT 0
1560 #define FF_PRED_PLANE 1
1561 #define FF_PRED_MEDIAN 2
1562 #endif
1563
1564 /**
1565 * slice offsets in the frame in bytes
1566 * - encoding: Set/allocated by libavcodec.
1567 * - decoding: Set/allocated by user (or NULL).
1568 */
1569 int *slice_offset;
1570
1571 /**
1572 * sample aspect ratio (0 if unknown)
1573 * That is the width of a pixel divided by the height of the pixel.
1574 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1575 * - encoding: Set by user.
1576 * - decoding: Set by libavcodec.
1577 */
1578 AVRational sample_aspect_ratio;
1579
1580 /**
1581 * motion estimation comparison function
1582 * - encoding: Set by user.
1583 * - decoding: unused
1584 */
1585 int me_cmp;
1586 /**
1587 * subpixel motion estimation comparison function
1588 * - encoding: Set by user.
1589 * - decoding: unused
1590 */
1591 int me_sub_cmp;
1592 /**
1593 * macroblock comparison function (not supported yet)
1594 * - encoding: Set by user.
1595 * - decoding: unused
1596 */
1597 int mb_cmp;
1598 /**
1599 * interlaced DCT comparison function
1600 * - encoding: Set by user.
1601 * - decoding: unused
1602 */
1603 int ildct_cmp;
1604 #define FF_CMP_SAD 0
1605 #define FF_CMP_SSE 1
1606 #define FF_CMP_SATD 2
1607 #define FF_CMP_DCT 3
1608 #define FF_CMP_PSNR 4
1609 #define FF_CMP_BIT 5
1610 #define FF_CMP_RD 6
1611 #define FF_CMP_ZERO 7
1612 #define FF_CMP_VSAD 8
1613 #define FF_CMP_VSSE 9
1614 #define FF_CMP_NSSE 10
1615 #define FF_CMP_DCTMAX 13
1616 #define FF_CMP_DCT264 14
1617 #define FF_CMP_CHROMA 256
1618
1619 /**
1620 * ME diamond size & shape
1621 * - encoding: Set by user.
1622 * - decoding: unused
1623 */
1624 int dia_size;
1625
1626 /**
1627 * amount of previous MV predictors (2a+1 x 2a+1 square)
1628 * - encoding: Set by user.
1629 * - decoding: unused
1630 */
1631 int last_predictor_count;
1632
1633 #if FF_API_PRIVATE_OPT
1634 /** @deprecated use encoder private options instead */
1635 attribute_deprecated
1636 int pre_me;
1637 #endif
1638
1639 /**
1640 * motion estimation prepass comparison function
1641 * - encoding: Set by user.
1642 * - decoding: unused
1643 */
1644 int me_pre_cmp;
1645
1646 /**
1647 * ME prepass diamond size & shape
1648 * - encoding: Set by user.
1649 * - decoding: unused
1650 */
1651 int pre_dia_size;
1652
1653 /**
1654 * subpel ME quality
1655 * - encoding: Set by user.
1656 * - decoding: unused
1657 */
1658 int me_subpel_quality;
1659
1660 /**
1661 * maximum motion estimation search range in subpel units
1662 * If 0 then no limit.
1663 *
1664 * - encoding: Set by user.
1665 * - decoding: unused
1666 */
1667 int me_range;
1668
1669 /**
1670 * slice flags
1671 * - encoding: unused
1672 * - decoding: Set by user.
1673 */
1674 int slice_flags;
1675 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1676 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1677 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1678
1679 /**
1680 * macroblock decision mode
1681 * - encoding: Set by user.
1682 * - decoding: unused
1683 */
1684 int mb_decision;
1685 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1686 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1687 #define FF_MB_DECISION_RD 2 ///< rate distortion
1688
1689 /**
1690 * custom intra quantization matrix
1691 * - encoding: Set by user, can be NULL.
1692 * - decoding: Set by libavcodec.
1693 */
1694 uint16_t *intra_matrix;
1695
1696 /**
1697 * custom inter quantization matrix
1698 * - encoding: Set by user, can be NULL.
1699 * - decoding: Set by libavcodec.
1700 */
1701 uint16_t *inter_matrix;
1702
1703 #if FF_API_PRIVATE_OPT
1704 /** @deprecated use encoder private options instead */
1705 attribute_deprecated
1706 int scenechange_threshold;
1707
1708 /** @deprecated use encoder private options instead */
1709 attribute_deprecated
1710 int noise_reduction;
1711 #endif
1712
1713 /**
1714 * precision of the intra DC coefficient - 8
1715 * - encoding: Set by user.
1716 * - decoding: unused
1717 */
1718 int intra_dc_precision;
1719
1720 /**
1721 * Number of macroblock rows at the top which are skipped.
1722 * - encoding: unused
1723 * - decoding: Set by user.
1724 */
1725 int skip_top;
1726
1727 /**
1728 * Number of macroblock rows at the bottom which are skipped.
1729 * - encoding: unused
1730 * - decoding: Set by user.
1731 */
1732 int skip_bottom;
1733
1734 /**
1735 * minimum MB Lagrange multiplier
1736 * - encoding: Set by user.
1737 * - decoding: unused
1738 */
1739 int mb_lmin;
1740
1741 /**
1742 * maximum MB Lagrange multiplier
1743 * - encoding: Set by user.
1744 * - decoding: unused
1745 */
1746 int mb_lmax;
1747
1748 #if FF_API_PRIVATE_OPT
1749 /**
1750 * @deprecated use encoder private options instead
1751 */
1752 attribute_deprecated
1753 int me_penalty_compensation;
1754 #endif
1755
1756 /**
1757 * - encoding: Set by user.
1758 * - decoding: unused
1759 */
1760 int bidir_refine;
1761
1762 #if FF_API_PRIVATE_OPT
1763 /** @deprecated use encoder private options instead */
1764 attribute_deprecated
1765 int brd_scale;
1766 #endif
1767
1768 /**
1769 * minimum GOP size
1770 * - encoding: Set by user.
1771 * - decoding: unused
1772 */
1773 int keyint_min;
1774
1775 /**
1776 * number of reference frames
1777 * - encoding: Set by user.
1778 * - decoding: Set by lavc.
1779 */
1780 int refs;
1781
1782 #if FF_API_PRIVATE_OPT
1783 /** @deprecated use encoder private options instead */
1784 attribute_deprecated
1785 int chromaoffset;
1786 #endif
1787
1788 /**
1789 * Note: Value depends upon the compare function used for fullpel ME.
1790 * - encoding: Set by user.
1791 * - decoding: unused
1792 */
1793 int mv0_threshold;
1794
1795 #if FF_API_PRIVATE_OPT
1796 /** @deprecated use encoder private options instead */
1797 attribute_deprecated
1798 int b_sensitivity;
1799 #endif
1800
1801 /**
1802 * Chromaticity coordinates of the source primaries.
1803 * - encoding: Set by user
1804 * - decoding: Set by libavcodec
1805 */
1806 enum AVColorPrimaries color_primaries;
1807
1808 /**
1809 * Color Transfer Characteristic.
1810 * - encoding: Set by user
1811 * - decoding: Set by libavcodec
1812 */
1813 enum AVColorTransferCharacteristic color_trc;
1814
1815 /**
1816 * YUV colorspace type.
1817 * - encoding: Set by user
1818 * - decoding: Set by libavcodec
1819 */
1820 enum AVColorSpace colorspace;
1821
1822 /**
1823 * MPEG vs JPEG YUV range.
1824 * - encoding: Set by user
1825 * - decoding: Set by libavcodec
1826 */
1827 enum AVColorRange color_range;
1828
1829 /**
1830 * This defines the location of chroma samples.
1831 * - encoding: Set by user
1832 * - decoding: Set by libavcodec
1833 */
1834 enum AVChromaLocation chroma_sample_location;
1835
1836 /**
1837 * Number of slices.
1838 * Indicates number of picture subdivisions. Used for parallelized
1839 * decoding.
1840 * - encoding: Set by user
1841 * - decoding: unused
1842 */
1843 int slices;
1844
1845 /** Field order
1846 * - encoding: set by libavcodec
1847 * - decoding: Set by libavcodec
1848 */
1849 enum AVFieldOrder field_order;
1850
1851 /* audio only */
1852 int sample_rate; ///< samples per second
1853 int channels; ///< number of audio channels
1854
1855 /**
1856 * audio sample format
1857 * - encoding: Set by user.
1858 * - decoding: Set by libavcodec.
1859 */
1860 enum AVSampleFormat sample_fmt; ///< sample format
1861
1862 /* The following data should not be initialized. */
1863 /**
1864 * Number of samples per channel in an audio frame.
1865 *
1866 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1867 * except the last must contain exactly frame_size samples per channel.
1868 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1869 * frame size is not restricted.
1870 * - decoding: may be set by some decoders to indicate constant frame size
1871 */
1872 int frame_size;
1873
1874 /**
1875 * Frame counter, set by libavcodec.
1876 *
1877 * - decoding: total number of frames returned from the decoder so far.
1878 * - encoding: total number of frames passed to the encoder so far.
1879 *
1880 * @note the counter is not incremented if encoding/decoding resulted in
1881 * an error.
1882 */
1883 int frame_number;
1884
1885 /**
1886 * number of bytes per packet if constant and known or 0
1887 * Used by some WAV based audio codecs.
1888 */
1889 int block_align;
1890
1891 /**
1892 * Audio cutoff bandwidth (0 means "automatic")
1893 * - encoding: Set by user.
1894 * - decoding: unused
1895 */
1896 int cutoff;
1897
1898 /**
1899 * Audio channel layout.
1900 * - encoding: set by user.
1901 * - decoding: set by libavcodec.
1902 */
1903 uint64_t channel_layout;
1904
1905 /**
1906 * Request decoder to use this channel layout if it can (0 for default)
1907 * - encoding: unused
1908 * - decoding: Set by user.
1909 */
1910 uint64_t request_channel_layout;
1911
1912 /**
1913 * Type of service that the audio stream conveys.
1914 * - encoding: Set by user.
1915 * - decoding: Set by libavcodec.
1916 */
1917 enum AVAudioServiceType audio_service_type;
1918
1919 /**
1920 * Used to request a sample format from the decoder.
1921 * - encoding: unused.
1922 * - decoding: Set by user.
1923 */
1924 enum AVSampleFormat request_sample_fmt;
1925
1926 /**
1927 * This callback is called at the beginning of each frame to get data
1928 * buffer(s) for it. There may be one contiguous buffer for all the data or
1929 * there may be a buffer per each data plane or anything in between. What
1930 * this means is, you may set however many entries in buf[] you feel necessary.
1931 * Each buffer must be reference-counted using the AVBuffer API (see description
1932 * of buf[] below).
1933 *
1934 * The following fields will be set in the frame before this callback is
1935 * called:
1936 * - format
1937 * - width, height (video only)
1938 * - sample_rate, channel_layout, nb_samples (audio only)
1939 * Their values may differ from the corresponding values in
1940 * AVCodecContext. This callback must use the frame values, not the codec
1941 * context values, to calculate the required buffer size.
1942 *
1943 * This callback must fill the following fields in the frame:
1944 * - data[]
1945 * - linesize[]
1946 * - extended_data:
1947 * * if the data is planar audio with more than 8 channels, then this
1948 * callback must allocate and fill extended_data to contain all pointers
1949 * to all data planes. data[] must hold as many pointers as it can.
1950 * extended_data must be allocated with av_malloc() and will be freed in
1951 * av_frame_unref().
1952 * * otherwise extended_data must point to data
1953 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1954 * the frame's data and extended_data pointers must be contained in these. That
1955 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1956 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1957 * and av_buffer_ref().
1958 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1959 * this callback and filled with the extra buffers if there are more
1960 * buffers than buf[] can hold. extended_buf will be freed in
1961 * av_frame_unref().
1962 *
1963 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1964 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1965 * some other means.
1966 *
1967 * Each data plane must be aligned to the maximum required by the target
1968 * CPU.
1969 *
1970 * @see avcodec_default_get_buffer2()
1971 *
1972 * Video:
1973 *
1974 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1975 * (read and/or written to if it is writable) later by libavcodec.
1976 *
1977 * avcodec_align_dimensions2() should be used to find the required width and
1978 * height, as they normally need to be rounded up to the next multiple of 16.
1979 *
1980 * If frame multithreading is used and thread_safe_callbacks is set,
1981 * this callback may be called from a different thread, but not from more
1982 * than one at once. Does not need to be reentrant.
1983 *
1984 * @see avcodec_align_dimensions2()
1985 *
1986 * Audio:
1987 *
1988 * Decoders request a buffer of a particular size by setting
1989 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1990 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1991 * to a smaller value in the output frame.
1992 *
1993 * As a convenience, av_samples_get_buffer_size() and
1994 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1995 * functions to find the required data size and to fill data pointers and
1996 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1997 * since all planes must be the same size.
1998 *
1999 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2000 *
2001 * - encoding: unused
2002 * - decoding: Set by libavcodec, user can override.
2003 */
2004 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2005
2006 /**
2007 * If non-zero, the decoded audio and video frames returned from
2008 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2009 * and are valid indefinitely. The caller must free them with
2010 * av_frame_unref() when they are not needed anymore.
2011 * Otherwise, the decoded frames must not be freed by the caller and are
2012 * only valid until the next decode call.
2013 *
2014 * This is always automatically enabled if avcodec_receive_frame() is used.
2015 *
2016 * - encoding: unused
2017 * - decoding: set by the caller before avcodec_open2().
2018 */
2019 attribute_deprecated int refcounted_frames;
2020
2021 /* - encoding parameters */
2022 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2023 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2024
2025 /**
2026 * minimum quantizer
2027 * - encoding: Set by user.
2028 * - decoding: unused
2029 */
2030 int qmin;
2031
2032 /**
2033 * maximum quantizer
2034 * - encoding: Set by user.
2035 * - decoding: unused
2036 */
2037 int qmax;
2038
2039 /**
2040 * maximum quantizer difference between frames
2041 * - encoding: Set by user.
2042 * - decoding: unused
2043 */
2044 int max_qdiff;
2045
2046 /**
2047 * decoder bitstream buffer size
2048 * - encoding: Set by user.
2049 * - decoding: unused
2050 */
2051 int rc_buffer_size;
2052
2053 /**
2054 * ratecontrol override, see RcOverride
2055 * - encoding: Allocated/set/freed by user.
2056 * - decoding: unused
2057 */
2058 int rc_override_count;
2059 RcOverride *rc_override;
2060
2061 /**
2062 * maximum bitrate
2063 * - encoding: Set by user.
2064 * - decoding: unused
2065 */
2066 int rc_max_rate;
2067
2068 /**
2069 * minimum bitrate
2070 * - encoding: Set by user.
2071 * - decoding: unused
2072 */
2073 int rc_min_rate;
2074
2075 /**
2076 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2077 * - encoding: Set by user.
2078 * - decoding: unused.
2079 */
2080 float rc_max_available_vbv_use;
2081
2082 /**
2083 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2084 * - encoding: Set by user.
2085 * - decoding: unused.
2086 */
2087 float rc_min_vbv_overflow_use;
2088
2089 /**
2090 * Number of bits which should be loaded into the rc buffer before decoding starts.
2091 * - encoding: Set by user.
2092 * - decoding: unused
2093 */
2094 int rc_initial_buffer_occupancy;
2095
2096 #if FF_API_CODER_TYPE
2097 #define FF_CODER_TYPE_VLC 0
2098 #define FF_CODER_TYPE_AC 1
2099 #define FF_CODER_TYPE_RAW 2
2100 #define FF_CODER_TYPE_RLE 3
2101 /**
2102 * @deprecated use encoder private options instead
2103 */
2104 attribute_deprecated
2105 int coder_type;
2106 #endif /* FF_API_CODER_TYPE */
2107
2108 #if FF_API_PRIVATE_OPT
2109 /** @deprecated use encoder private options instead */
2110 attribute_deprecated
2111 int context_model;
2112 #endif
2113
2114 #if FF_API_PRIVATE_OPT
2115 /** @deprecated use encoder private options instead */
2116 attribute_deprecated
2117 int frame_skip_threshold;
2118
2119 /** @deprecated use encoder private options instead */
2120 attribute_deprecated
2121 int frame_skip_factor;
2122
2123 /** @deprecated use encoder private options instead */
2124 attribute_deprecated
2125 int frame_skip_exp;
2126
2127 /** @deprecated use encoder private options instead */
2128 attribute_deprecated
2129 int frame_skip_cmp;
2130 #endif /* FF_API_PRIVATE_OPT */
2131
2132 /**
2133 * trellis RD quantization
2134 * - encoding: Set by user.
2135 * - decoding: unused
2136 */
2137 int trellis;
2138
2139 #if FF_API_PRIVATE_OPT
2140 /** @deprecated use encoder private options instead */
2141 attribute_deprecated
2142 int min_prediction_order;
2143
2144 /** @deprecated use encoder private options instead */
2145 attribute_deprecated
2146 int max_prediction_order;
2147
2148 /** @deprecated use encoder private options instead */
2149 attribute_deprecated
2150 int64_t timecode_frame_start;
2151 #endif
2152
2153 #if FF_API_RTP_CALLBACK
2154 /**
2155 * @deprecated unused
2156 */
2157 /* The RTP callback: This function is called */
2158 /* every time the encoder has a packet to send. */
2159 /* It depends on the encoder if the data starts */
2160 /* with a Start Code (it should). H.263 does. */
2161 /* mb_nb contains the number of macroblocks */
2162 /* encoded in the RTP payload. */
2163 attribute_deprecated
2164 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2165 #endif
2166
2167 #if FF_API_PRIVATE_OPT
2168 /** @deprecated use encoder private options instead */
2169 attribute_deprecated
2170 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2171 /* do its best to deliver a chunk with size */
2172 /* below rtp_payload_size, the chunk will start */
2173 /* with a start code on some codecs like H.263. */
2174 /* This doesn't take account of any particular */
2175 /* headers inside the transmitted RTP payload. */
2176 #endif
2177
2178 #if FF_API_STAT_BITS
2179 /* statistics, used for 2-pass encoding */
2180 attribute_deprecated
2181 int mv_bits;
2182 attribute_deprecated
2183 int header_bits;
2184 attribute_deprecated
2185 int i_tex_bits;
2186 attribute_deprecated
2187 int p_tex_bits;
2188 attribute_deprecated
2189 int i_count;
2190 attribute_deprecated
2191 int p_count;
2192 attribute_deprecated
2193 int skip_count;
2194 attribute_deprecated
2195 int misc_bits;
2196
2197 /** @deprecated this field is unused */
2198 attribute_deprecated
2199 int frame_bits;
2200 #endif
2201
2202 /**
2203 * pass1 encoding statistics output buffer
2204 * - encoding: Set by libavcodec.
2205 * - decoding: unused
2206 */
2207 char *stats_out;
2208
2209 /**
2210 * pass2 encoding statistics input buffer
2211 * Concatenated stuff from stats_out of pass1 should be placed here.
2212 * - encoding: Allocated/set/freed by user.
2213 * - decoding: unused
2214 */
2215 char *stats_in;
2216
2217 /**
2218 * Work around bugs in encoders which sometimes cannot be detected automatically.
2219 * - encoding: Set by user
2220 * - decoding: Set by user
2221 */
2222 int workaround_bugs;
2223 #define FF_BUG_AUTODETECT 1 ///< autodetection
2224 #define FF_BUG_XVID_ILACE 4
2225 #define FF_BUG_UMP4 8
2226 #define FF_BUG_NO_PADDING 16
2227 #define FF_BUG_AMV 32
2228 #define FF_BUG_QPEL_CHROMA 64
2229 #define FF_BUG_STD_QPEL 128
2230 #define FF_BUG_QPEL_CHROMA2 256
2231 #define FF_BUG_DIRECT_BLOCKSIZE 512
2232 #define FF_BUG_EDGE 1024
2233 #define FF_BUG_HPEL_CHROMA 2048
2234 #define FF_BUG_DC_CLIP 4096
2235 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2236 #define FF_BUG_TRUNCATED 16384
2237
2238 /**
2239 * strictly follow the standard (MPEG-4, ...).
2240 * - encoding: Set by user.
2241 * - decoding: Set by user.
2242 * Setting this to STRICT or higher means the encoder and decoder will
2243 * generally do stupid things, whereas setting it to unofficial or lower
2244 * will mean the encoder might produce output that is not supported by all
2245 * spec-compliant decoders. Decoders don't differentiate between normal,
2246 * unofficial and experimental (that is, they always try to decode things
2247 * when they can) unless they are explicitly asked to behave stupidly
2248 * (=strictly conform to the specs)
2249 */
2250 int strict_std_compliance;
2251 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2252 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2253 #define FF_COMPLIANCE_NORMAL 0
2254 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2255 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2256
2257 /**
2258 * error concealment flags
2259 * - encoding: unused
2260 * - decoding: Set by user.
2261 */
2262 int error_concealment;
2263 #define FF_EC_GUESS_MVS 1
2264 #define FF_EC_DEBLOCK 2
2265
2266 /**
2267 * debug
2268 * - encoding: Set by user.
2269 * - decoding: Set by user.
2270 */
2271 int debug;
2272 #define FF_DEBUG_PICT_INFO 1
2273 #define FF_DEBUG_RC 2
2274 #define FF_DEBUG_BITSTREAM 4
2275 #define FF_DEBUG_MB_TYPE 8
2276 #define FF_DEBUG_QP 16
2277 #define FF_DEBUG_DCT_COEFF 0x00000040
2278 #define FF_DEBUG_SKIP 0x00000080
2279 #define FF_DEBUG_STARTCODE 0x00000100
2280 #define FF_DEBUG_ER 0x00000400
2281 #define FF_DEBUG_MMCO 0x00000800
2282 #define FF_DEBUG_BUGS 0x00001000
2283 #define FF_DEBUG_BUFFERS 0x00008000
2284 #define FF_DEBUG_THREADS 0x00010000
2285
2286 /**
2287 * Error recognition; may misdetect some more or less valid parts as errors.
2288 * - encoding: unused
2289 * - decoding: Set by user.
2290 */
2291 int err_recognition;
2292
2293 /**
2294 * Verify checksums embedded in the bitstream (could be of either encoded or
2295 * decoded data, depending on the codec) and print an error message on mismatch.
2296 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2297 * decoder returning an error.
2298 */
2299 #define AV_EF_CRCCHECK (1<<0)
2300 #define AV_EF_BITSTREAM (1<<1)
2301 #define AV_EF_BUFFER (1<<2)
2302 #define AV_EF_EXPLODE (1<<3)
2303
2304 /**
2305 * opaque 64-bit number (generally a PTS) that will be reordered and
2306 * output in AVFrame.reordered_opaque
2307 * - encoding: Set by libavcodec to the reordered_opaque of the input
2308 * frame corresponding to the last returned packet. Only
2309 * supported by encoders with the
2310 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2311 * - decoding: Set by user.
2312 */
2313 int64_t reordered_opaque;
2314
2315 /**
2316 * Hardware accelerator in use
2317 * - encoding: unused.
2318 * - decoding: Set by libavcodec
2319 */
2320 const struct AVHWAccel *hwaccel;
2321
2322 /**
2323 * Hardware accelerator context.
2324 * For some hardware accelerators, a global context needs to be
2325 * provided by the user. In that case, this holds display-dependent
2326 * data Libav cannot instantiate itself. Please refer to the
2327 * Libav HW accelerator documentation to know how to fill this
2328 * is. e.g. for VA API, this is a struct vaapi_context.
2329 * - encoding: unused
2330 * - decoding: Set by user
2331 */
2332 void *hwaccel_context;
2333
2334 /**
2335 * error
2336 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2337 * - decoding: unused
2338 */
2339 uint64_t error[AV_NUM_DATA_POINTERS];
2340
2341 /**
2342 * DCT algorithm, see FF_DCT_* below
2343 * - encoding: Set by user.
2344 * - decoding: unused
2345 */
2346 int dct_algo;
2347 #define FF_DCT_AUTO 0
2348 #define FF_DCT_FASTINT 1
2349 #define FF_DCT_INT 2
2350 #define FF_DCT_MMX 3
2351 #define FF_DCT_ALTIVEC 5
2352 #define FF_DCT_FAAN 6
2353
2354 /**
2355 * IDCT algorithm, see FF_IDCT_* below.
2356 * - encoding: Set by user.
2357 * - decoding: Set by user.
2358 */
2359 int idct_algo;
2360 #define FF_IDCT_AUTO 0
2361 #define FF_IDCT_INT 1
2362 #define FF_IDCT_SIMPLE 2
2363 #define FF_IDCT_SIMPLEMMX 3
2364 #define FF_IDCT_ARM 7
2365 #define FF_IDCT_ALTIVEC 8
2366 #define FF_IDCT_SIMPLEARM 10
2367 #define FF_IDCT_XVID 14
2368 #define FF_IDCT_SIMPLEARMV5TE 16
2369 #define FF_IDCT_SIMPLEARMV6 17
2370 #define FF_IDCT_FAAN 20
2371 #define FF_IDCT_SIMPLENEON 22
2372
2373 /**
2374 * bits per sample/pixel from the demuxer (needed for huffyuv).
2375 * - encoding: Set by libavcodec.
2376 * - decoding: Set by user.
2377 */
2378 int bits_per_coded_sample;
2379
2380 /**
2381 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2382 * - encoding: set by user.
2383 * - decoding: set by libavcodec.
2384 */
2385 int bits_per_raw_sample;
2386
2387 #if FF_API_CODED_FRAME
2388 /**
2389 * the picture in the bitstream
2390 * - encoding: Set by libavcodec.
2391 * - decoding: unused
2392 *
2393 * @deprecated use the quality factor packet side data instead
2394 */
2395 attribute_deprecated AVFrame *coded_frame;
2396 #endif
2397
2398 /**
2399 * thread count
2400 * is used to decide how many independent tasks should be passed to execute()
2401 * - encoding: Set by user.
2402 * - decoding: Set by user.
2403 */
2404 int thread_count;
2405
2406 /**
2407 * Which multithreading methods to use.
2408 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2409 * so clients which cannot provide future frames should not use it.
2410 *
2411 * - encoding: Set by user, otherwise the default is used.
2412 * - decoding: Set by user, otherwise the default is used.
2413 */
2414 int thread_type;
2415 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2416 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2417
2418 /**
2419 * Which multithreading methods are in use by the codec.
2420 * - encoding: Set by libavcodec.
2421 * - decoding: Set by libavcodec.
2422 */
2423 int active_thread_type;
2424
2425 /**
2426 * Set by the client if its custom get_buffer() callback can be called
2427 * synchronously from another thread, which allows faster multithreaded decoding.
2428 * draw_horiz_band() will be called from other threads regardless of this setting.
2429 * Ignored if the default get_buffer() is used.
2430 * - encoding: Set by user.
2431 * - decoding: Set by user.
2432 */
2433 int thread_safe_callbacks;
2434
2435 /**
2436 * The codec may call this to execute several independent things.
2437 * It will return only after finishing all tasks.
2438 * The user may replace this with some multithreaded implementation,
2439 * the default implementation will execute the parts serially.
2440 * @param count the number of things to execute
2441 * - encoding: Set by libavcodec, user can override.
2442 * - decoding: Set by libavcodec, user can override.
2443 */
2444 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2445
2446 /**
2447 * The codec may call this to execute several independent things.
2448 * It will return only after finishing all tasks.
2449 * The user may replace this with some multithreaded implementation,
2450 * the default implementation will execute the parts serially.
2451 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2452 * @param c context passed also to func
2453 * @param count the number of things to execute
2454 * @param arg2 argument passed unchanged to func
2455 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2456 * @param func function that will be called count times, with jobnr from 0 to count-1.
2457 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2458 * two instances of func executing at the same time will have the same threadnr.
2459 * @return always 0 currently, but code should handle a future improvement where when any call to func
2460 * returns < 0 no further calls to func may be done and < 0 is returned.
2461 * - encoding: Set by libavcodec, user can override.
2462 * - decoding: Set by libavcodec, user can override.
2463 */
2464 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2465
2466 /**
2467 * noise vs. sse weight for the nsse comparison function
2468 * - encoding: Set by user.
2469 * - decoding: unused
2470 */
2471 int nsse_weight;
2472
2473 /**
2474 * profile
2475 * - encoding: Set by user.
2476 * - decoding: Set by libavcodec.
2477 */
2478 int profile;
2479 #define FF_PROFILE_UNKNOWN -99
2480 #define FF_PROFILE_RESERVED -100
2481
2482 #define FF_PROFILE_AAC_MAIN 0
2483 #define FF_PROFILE_AAC_LOW 1
2484 #define FF_PROFILE_AAC_SSR 2
2485 #define FF_PROFILE_AAC_LTP 3
2486 #define FF_PROFILE_AAC_HE 4
2487 #define FF_PROFILE_AAC_HE_V2 28
2488 #define FF_PROFILE_AAC_LD 22
2489 #define FF_PROFILE_AAC_ELD 38
2490 #define FF_PROFILE_MPEG2_AAC_LOW 128
2491 #define FF_PROFILE_MPEG2_AAC_HE 131
2492
2493 #define FF_PROFILE_DTS 20
2494 #define FF_PROFILE_DTS_ES 30
2495 #define FF_PROFILE_DTS_96_24 40
2496 #define FF_PROFILE_DTS_HD_HRA 50
2497 #define FF_PROFILE_DTS_HD_MA 60
2498 #define FF_PROFILE_DTS_EXPRESS 70
2499
2500 #define FF_PROFILE_MPEG2_422 0
2501 #define FF_PROFILE_MPEG2_HIGH 1
2502 #define FF_PROFILE_MPEG2_SS 2
2503 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2504 #define FF_PROFILE_MPEG2_MAIN 4
2505 #define FF_PROFILE_MPEG2_SIMPLE 5
2506
2507 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2508 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2509
2510 #define FF_PROFILE_H264_BASELINE 66
2511 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2512 #define FF_PROFILE_H264_MAIN 77
2513 #define FF_PROFILE_H264_EXTENDED 88
2514 #define FF_PROFILE_H264_HIGH 100
2515 #define FF_PROFILE_H264_HIGH_10 110
2516 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2517 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2518 #define FF_PROFILE_H264_HIGH_422 122
2519 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2520 #define FF_PROFILE_H264_STEREO_HIGH 128
2521 #define FF_PROFILE_H264_HIGH_444 144
2522 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2523 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2524 #define FF_PROFILE_H264_CAVLC_444 44
2525
2526 #define FF_PROFILE_VC1_SIMPLE 0
2527 #define FF_PROFILE_VC1_MAIN 1
2528 #define FF_PROFILE_VC1_COMPLEX 2
2529 #define FF_PROFILE_VC1_ADVANCED 3
2530
2531 #define FF_PROFILE_MPEG4_SIMPLE 0
2532 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2533 #define FF_PROFILE_MPEG4_CORE 2
2534 #define FF_PROFILE_MPEG4_MAIN 3
2535 #define FF_PROFILE_MPEG4_N_BIT 4
2536 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2537 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2538 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2539 #define FF_PROFILE_MPEG4_HYBRID 8
2540 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2541 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2542 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2543 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2544 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2545 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2546 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2547
2548 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2549 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2550 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2551 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2552 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2553
2554 #define FF_PROFILE_VP9_0 0
2555 #define FF_PROFILE_VP9_1 1
2556 #define FF_PROFILE_VP9_2 2
2557 #define FF_PROFILE_VP9_3 3
2558
2559 #define FF_PROFILE_HEVC_MAIN 1
2560 #define FF_PROFILE_HEVC_MAIN_10 2
2561 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2562 #define FF_PROFILE_HEVC_REXT 4
2563
2564 #define FF_PROFILE_AV1_MAIN 0
2565 #define FF_PROFILE_AV1_HIGH 1
2566 #define FF_PROFILE_AV1_PROFESSIONAL 2
2567
2568 /**
2569 * level
2570 * - encoding: Set by user.
2571 * - decoding: Set by libavcodec.
2572 */
2573 int level;
2574 #define FF_LEVEL_UNKNOWN -99
2575
2576 /**
2577 * - encoding: unused
2578 * - decoding: Set by user.
2579 */
2580 enum AVDiscard skip_loop_filter;
2581
2582 /**
2583 * - encoding: unused
2584 * - decoding: Set by user.
2585 */
2586 enum AVDiscard skip_idct;
2587
2588 /**
2589 * - encoding: unused
2590 * - decoding: Set by user.
2591 */
2592 enum AVDiscard skip_frame;
2593
2594 /**
2595 * Header containing style information for text subtitles.
2596 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2597 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2598 * the Format line following. It shouldn't include any Dialogue line.
2599 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2600 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2601 */
2602 uint8_t *subtitle_header;
2603 int subtitle_header_size;
2604
2605 #if FF_API_VBV_DELAY
2606 /**
2607 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2608 * Used for compliant TS muxing.
2609 * - encoding: Set by libavcodec.
2610 * - decoding: unused.
2611 * @deprecated this value is now exported as a part of
2612 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2613 */
2614 attribute_deprecated
2615 uint64_t vbv_delay;
2616 #endif
2617
2618 #if FF_API_SIDEDATA_ONLY_PKT
2619 /**
2620 * Encoding only and set by default. Allow encoders to output packets
2621 * that do not contain any encoded data, only side data.
2622 *
2623 * Some encoders need to output such packets, e.g. to update some stream
2624 * parameters at the end of encoding.
2625 *
2626 * @deprecated this field disables the default behaviour and
2627 * it is kept only for compatibility.
2628 */
2629 attribute_deprecated
2630 int side_data_only_packets;
2631 #endif
2632
2633 /**
2634 * Audio only. The number of "priming" samples (padding) inserted by the
2635 * encoder at the beginning of the audio. I.e. this number of leading
2636 * decoded samples must be discarded by the caller to get the original audio
2637 * without leading padding.
2638 *
2639 * - decoding: unused
2640 * - encoding: Set by libavcodec. The timestamps on the output packets are
2641 * adjusted by the encoder so that they always refer to the
2642 * first sample of the data actually contained in the packet,
2643 * including any added padding. E.g. if the timebase is
2644 * 1/samplerate and the timestamp of the first input sample is
2645 * 0, the timestamp of the first output packet will be
2646 * -initial_padding.
2647 */
2648 int initial_padding;
2649
2650 /*
2651 * - decoding: For codecs that store a framerate value in the compressed
2652 * bitstream, the decoder may export it here. { 0, 1} when
2653 * unknown.
2654 * - encoding: May be used to signal the framerate of CFR content to an
2655 * encoder.
2656 */
2657 AVRational framerate;
2658
2659 /**
2660 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2661 * - encoding: unused.
2662 * - decoding: Set by libavcodec before calling get_format()
2663 */
2664 enum AVPixelFormat sw_pix_fmt;
2665
2666 /**
2667 * Additional data associated with the entire coded stream.
2668 *
2669 * - decoding: unused
2670 * - encoding: may be set by libavcodec after avcodec_open2().
2671 */
2672 AVPacketSideData *coded_side_data;
2673 int nb_coded_side_data;
2674
2675 /**
2676 * A reference to the AVHWFramesContext describing the input (for encoding)
2677 * or output (decoding) frames. The reference is set by the caller and
2678 * afterwards owned (and freed) by libavcodec - it should never be read by
2679 * the caller after being set.
2680 *
2681 * - decoding: This field should be set by the caller from the get_format()
2682 * callback. The previous reference (if any) will always be
2683 * unreffed by libavcodec before the get_format() call.
2684 *
2685 * If the default get_buffer2() is used with a hwaccel pixel
2686 * format, then this AVHWFramesContext will be used for
2687 * allocating the frame buffers.
2688 *
2689 * - encoding: For hardware encoders configured to use a hwaccel pixel
2690 * format, this field should be set by the caller to a reference
2691 * to the AVHWFramesContext describing input frames.
2692 * AVHWFramesContext.format must be equal to
2693 * AVCodecContext.pix_fmt.
2694 *
2695 * This field should be set before avcodec_open2() is called.
2696 */
2697 AVBufferRef *hw_frames_ctx;
2698
2699 /**
2700 * Video decoding only. Certain video codecs support cropping, meaning that
2701 * only a sub-rectangle of the decoded frame is intended for display. This
2702 * option controls how cropping is handled by libavcodec.
2703 *
2704 * When set to 1 (the default), libavcodec will apply cropping internally.
2705 * I.e. it will modify the output frame width/height fields and offset the
2706 * data pointers (only by as much as possible while preserving alignment, or
2707 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2708 * the frames output by the decoder refer only to the cropped area. The
2709 * crop_* fields of the output frames will be zero.
2710 *
2711 * When set to 0, the width/height fields of the output frames will be set
2712 * to the coded dimensions and the crop_* fields will describe the cropping
2713 * rectangle. Applying the cropping is left to the caller.
2714 *
2715 * @warning When hardware acceleration with opaque output frames is used,
2716 * libavcodec is unable to apply cropping from the top/left border.
2717 *
2718 * @note when this option is set to zero, the width/height fields of the
2719 * AVCodecContext and output AVFrames have different meanings. The codec
2720 * context fields store display dimensions (with the coded dimensions in
2721 * coded_width/height), while the frame fields store the coded dimensions
2722 * (with the display dimensions being determined by the crop_* fields).
2723 */
2724 int apply_cropping;
2725
2726 /**
2727 * A reference to the AVHWDeviceContext describing the device which will
2728 * be used by a hardware encoder/decoder. The reference is set by the
2729 * caller and afterwards owned (and freed) by libavcodec.
2730 *
2731 * This should be used if either the codec device does not require
2732 * hardware frames or any that are used are to be allocated internally by
2733 * libavcodec. If the user wishes to supply any of the frames used as
2734 * encoder input or decoder output then hw_frames_ctx should be used
2735 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2736 * field will be ignored while decoding the associated stream segment, but
2737 * may again be used on a following one after another get_format() call.
2738 *
2739 * For both encoders and decoders this field should be set before
2740 * avcodec_open2() is called and must not be written to thereafter.
2741 *
2742 * Note that some decoders may require this field to be set initially in
2743 * order to support hw_frames_ctx at all - in that case, all frames
2744 * contexts used must be created on the same device.
2745 */
2746 AVBufferRef *hw_device_ctx;
2747
2748 /**
2749 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2750 * decoding (if active).
2751 * - encoding: unused
2752 * - decoding: Set by user (either before avcodec_open2(), or in the
2753 * AVCodecContext.get_format callback)
2754 */
2755 int hwaccel_flags;
2756
2757 /**
2758 * Video decoding only. Sets the number of extra hardware frames which
2759 * the decoder will allocate for use by the caller. This must be set
2760 * before avcodec_open2() is called.
2761 *
2762 * Some hardware decoders require all frames that they will use for
2763 * output to be defined in advance before decoding starts. For such
2764 * decoders, the hardware frame pool must therefore be of a fixed size.
2765 * The extra frames set here are on top of any number that the decoder
2766 * needs internally in order to operate normally (for example, frames
2767 * used as reference pictures).
2768 */
2769 int extra_hw_frames;
2770 } AVCodecContext;
2771
2772 /**
2773 * AVProfile.
2774 */
2775 typedef struct AVProfile {
2776 int profile;
2777 const char *name; ///< short name for the profile
2778 } AVProfile;
2779
2780 enum {
2781 /**
2782 * The codec supports this format via the hw_device_ctx interface.
2783 *
2784 * When selecting this format, AVCodecContext.hw_device_ctx should
2785 * have been set to a device of the specified type before calling
2786 * avcodec_open2().
2787 */
2788 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2789 /**
2790 * The codec supports this format via the hw_frames_ctx interface.
2791 *
2792 * When selecting this format for a decoder,
2793 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2794 * context inside the get_format() callback. The frames context
2795 * must have been created on a device of the specified type.
2796 */
2797 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2798 /**
2799 * The codec supports this format by some internal method.
2800 *
2801 * This format can be selected without any additional configuration -
2802 * no device or frames context is required.
2803 */
2804 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2805 /**
2806 * The codec supports this format by some ad-hoc method.
2807 *
2808 * Additional settings and/or function calls are required. See the
2809 * codec-specific documentation for details. (Methods requiring
2810 * this sort of configuration are deprecated and others should be
2811 * used in preference.)
2812 */
2813 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2814 };
2815
2816 typedef struct AVCodecHWConfig {
2817 /**
2818 * A hardware pixel format which the codec can use.
2819 */
2820 enum AVPixelFormat pix_fmt;
2821 /**
2822 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2823 * setup methods which can be used with this configuration.
2824 */
2825 int methods;
2826 /**
2827 * The device type associated with the configuration.
2828 *
2829 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2830 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2831 */
2832 enum AVHWDeviceType device_type;
2833 } AVCodecHWConfig;
2834
2835 typedef struct AVCodecDefault AVCodecDefault;
2836
2837 struct AVSubtitle;
2838
2839 /**
2840 * AVCodec.
2841 */
2842 typedef struct AVCodec {
2843 /**
2844 * Name of the codec implementation.
2845 * The name is globally unique among encoders and among decoders (but an
2846 * encoder and a decoder can share the same name).
2847 * This is the primary way to find a codec from the user perspective.
2848 */
2849 const char *name;
2850 /**
2851 * Descriptive name for the codec, meant to be more human readable than name.
2852 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2853 */
2854 const char *long_name;
2855 enum AVMediaType type;
2856 enum AVCodecID id;
2857 /**
2858 * Codec capabilities.
2859 * see AV_CODEC_CAP_*
2860 */
2861 int capabilities;
2862 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2863 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2864 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2865 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2866 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2867 const AVClass *priv_class; ///< AVClass for the private context
2868 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2869
2870 /**
2871 * Group name of the codec implementation.
2872 * This is a short symbolic name of the wrapper backing this codec. A
2873 * wrapper uses some kind of external implementation for the codec, such
2874 * as an external library, or a codec implementation provided by the OS or
2875 * the hardware.
2876 * If this field is NULL, this is a builtin, libavcodec native decoder.
2877 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2878 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2879 */
2880 const char *wrapper_name;
2881
2882 /*****************************************************************
2883 * No fields below this line are part of the public API. They
2884 * may not be used outside of libavcodec and can be changed and
2885 * removed at will.
2886 * New public fields should be added right above.
2887 *****************************************************************
2888 */
2889 int priv_data_size;
2890 struct AVCodec *next;
2891 /**
2892 * @name Frame-level threading support functions
2893 * @{
2894 */
2895 /**
2896 * If defined, called on thread contexts when they are created.
2897 * If the codec allocates writable tables in init(), re-allocate them here.
2898 * priv_data will be set to a copy of the original.
2899 */
2900 int (*init_thread_copy)(AVCodecContext *);
2901 /**
2902 * Copy necessary context variables from a previous thread context to the current one.
2903 * If not defined, the next thread will start automatically; otherwise, the codec
2904 * must call ff_thread_finish_setup().
2905 *
2906 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2907 */
2908 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2909 /** @} */
2910
2911 /**
2912 * Private codec-specific defaults.
2913 */
2914 const AVCodecDefault *defaults;
2915
2916 /**
2917 * Initialize codec static data, called from avcodec_register().
2918 */
2919 void (*init_static_data)(struct AVCodec *codec);
2920
2921 int (*init)(AVCodecContext *);
2922 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2923 const struct AVSubtitle *sub);
2924 /**
2925 * Encode data to an AVPacket.
2926 *
2927 * @param avctx codec context
2928 * @param avpkt output AVPacket (may contain a user-provided buffer)
2929 * @param[in] frame AVFrame containing the raw data to be encoded
2930 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2931 * non-empty packet was returned in avpkt.
2932 * @return 0 on success, negative error code on failure
2933 */
2934 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2935 int *got_packet_ptr);
2936 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2937 int (*close)(AVCodecContext *);
2938 /**
2939 * Encode API with decoupled packet/frame dataflow. The API is the
2940 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2941 * that:
2942 * - never called if the codec is closed or the wrong type,
2943 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2944 * - only one drain frame is ever passed down,
2945 */
2946 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2947 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2948
2949 /**
2950 * Decode API with decoupled packet/frame dataflow. This function is called
2951 * to get one output frame. It should call ff_decode_get_packet() to obtain
2952 * input data.
2953 */
2954 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2955 /**
2956 * Flush buffers.
2957 * Will be called when seeking
2958 */
2959 void (*flush)(AVCodecContext *);
2960 /**
2961 * Internal codec capabilities.
2962 * See FF_CODEC_CAP_* in internal.h
2963 */
2964 int caps_internal;
2965
2966 /**
2967 * Decoding only, a comma-separated list of bitstream filters to apply to
2968 * packets before decoding.
2969 */
2970 const char *bsfs;
2971
2972 /**
2973 * Array of pointers to hardware configurations supported by the codec,
2974 * or NULL if no hardware supported. The array is terminated by a NULL
2975 * pointer.
2976 *
2977 * The user can only access this field via avcodec_get_hw_config().
2978 */
2979 const struct AVCodecHWConfigInternal **hw_configs;
2980 } AVCodec;
2981
2982 /**
2983 * Retrieve supported hardware configurations for a codec.
2984 *
2985 * Values of index from zero to some maximum return the indexed configuration
2986 * descriptor; all other values return NULL. If the codec does not support
2987 * any hardware configurations then it will always return NULL.
2988 */
2989 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2990
2991 /**
2992 * @defgroup lavc_hwaccel AVHWAccel
2993 *
2994 * @note Nothing in this structure should be accessed by the user. At some
2995 * point in future it will not be externally visible at all.
2996 *
2997 * @{
2998 */
2999 typedef struct AVHWAccel {
3000 /**
3001 * Name of the hardware accelerated codec.
3002 * The name is globally unique among encoders and among decoders (but an
3003 * encoder and a decoder can share the same name).
3004 */
3005 const char *name;
3006
3007 /**
3008 * Type of codec implemented by the hardware accelerator.
3009 *
3010 * See AVMEDIA_TYPE_xxx
3011 */
3012 enum AVMediaType type;
3013
3014 /**
3015 * Codec implemented by the hardware accelerator.
3016 *
3017 * See AV_CODEC_ID_xxx
3018 */
3019 enum AVCodecID id;
3020
3021 /**
3022 * Supported pixel format.
3023 *
3024 * Only hardware accelerated formats are supported here.
3025 */
3026 enum AVPixelFormat pix_fmt;
3027
3028 /**
3029 * Hardware accelerated codec capabilities.
3030 * see FF_HWACCEL_CODEC_CAP_*
3031 */
3032 int capabilities;
3033
3034 /*****************************************************************
3035 * No fields below this line are part of the public API. They
3036 * may not be used outside of libavcodec and can be changed and
3037 * removed at will.
3038 * New public fields should be added right above.
3039 *****************************************************************
3040 */
3041 struct AVHWAccel *next;
3042
3043 /**
3044 * Allocate a custom buffer
3045 */
3046 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3047
3048 /**
3049 * Called at the beginning of each frame or field picture.
3050 *
3051 * Meaningful frame information (codec specific) is guaranteed to
3052 * be parsed at this point. This function is mandatory.
3053 *
3054 * Note that buf can be NULL along with buf_size set to 0.
3055 * Otherwise, this means the whole frame is available at this point.
3056 *
3057 * @param avctx the codec context
3058 * @param buf the frame data buffer base
3059 * @param buf_size the size of the frame in bytes
3060 * @return zero if successful, a negative value otherwise
3061 */
3062 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3063
3064 /**
3065 * Callback for each slice.
3066 *
3067 * Meaningful slice information (codec specific) is guaranteed to
3068 * be parsed at this point. This function is mandatory.
3069 *
3070 * @param avctx the codec context
3071 * @param buf the slice data buffer base
3072 * @param buf_size the size of the slice in bytes
3073 * @return zero if successful, a negative value otherwise
3074 */
3075 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3076
3077 /**
3078 * Called at the end of each frame or field picture.
3079 *
3080 * The whole picture is parsed at this point and can now be sent
3081 * to the hardware accelerator. This function is mandatory.
3082 *
3083 * @param avctx the codec context
3084 * @return zero if successful, a negative value otherwise
3085 */
3086 int (*end_frame)(AVCodecContext *avctx);
3087
3088 /**
3089 * Size of per-frame hardware accelerator private data.
3090 *
3091 * Private data is allocated with av_mallocz() before
3092 * AVCodecContext.get_buffer() and deallocated after
3093 * AVCodecContext.release_buffer().
3094 */
3095 int frame_priv_data_size;
3096
3097 /**
3098 * Initialize the hwaccel private data.
3099 *
3100 * This will be called from ff_get_format(), after hwaccel and
3101 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3102 * is allocated.
3103 */
3104 int (*init)(AVCodecContext *avctx);
3105
3106 /**
3107 * Uninitialize the hwaccel private data.
3108 *
3109 * This will be called from get_format() or avcodec_close(), after hwaccel
3110 * and hwaccel_context are already uninitialized.
3111 */
3112 int (*uninit)(AVCodecContext *avctx);
3113
3114 /**
3115 * Size of the private data to allocate in
3116 * AVCodecInternal.hwaccel_priv_data.
3117 */
3118 int priv_data_size;
3119
3120 /**
3121 * Internal hwaccel capabilities.
3122 */
3123 int caps_internal;
3124
3125 /**
3126 * Fill the given hw_frames context with current codec parameters. Called
3127 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3128 * details.
3129 *
3130 * This CAN be called before AVHWAccel.init is called, and you must assume
3131 * that avctx->hwaccel_priv_data is invalid.
3132 */
3133 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3134 } AVHWAccel;
3135
3136 /**
3137 * Hardware acceleration should be used for decoding even if the codec level
3138 * used is unknown or higher than the maximum supported level reported by the
3139 * hardware driver.
3140 */
3141 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3142
3143 /**
3144 * Hardware acceleration can output YUV pixel formats with a different chroma
3145 * sampling than 4:2:0 and/or other than 8 bits per component.
3146 */
3147 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3148
3149 /**
3150 * Hardware acceleration should still be attempted for decoding when the
3151 * codec profile does not match the reported capabilities of the hardware.
3152 *
3153 * For example, this can be used to try to decode baseline profile H.264
3154 * streams in hardware - it will often succeed, because many streams marked
3155 * as baseline profile actually conform to constrained baseline profile.
3156 *
3157 * @warning If the stream is actually not supported then the behaviour is
3158 * undefined, and may include returning entirely incorrect output
3159 * while indicating success.
3160 */
3161 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3162
3163 /**
3164 * @}
3165 */
3166
3167 #if FF_API_AVPICTURE
3168 /**
3169 * @defgroup lavc_picture AVPicture
3170 *
3171 * Functions for working with AVPicture
3172 * @{
3173 */
3174
3175 /**
3176 * four components are given, that's all.
3177 * the last component is alpha
3178 * @deprecated Use the imgutils functions
3179 */
3180 typedef struct AVPicture {
3181 attribute_deprecated
3182 uint8_t *data[AV_NUM_DATA_POINTERS];
3183 attribute_deprecated
3184 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3185 } AVPicture;
3186
3187 /**
3188 * @}
3189 */
3190 #endif
3191
3192 #define AVPALETTE_SIZE 1024
3193 #define AVPALETTE_COUNT 256
3194
3195 enum AVSubtitleType {
3196 SUBTITLE_NONE,
3197
3198 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3199
3200 /**
3201 * Plain text, the text field must be set by the decoder and is
3202 * authoritative. ass and pict fields may contain approximations.
3203 */
3204 SUBTITLE_TEXT,
3205
3206 /**
3207 * Formatted text, the ass field must be set by the decoder and is
3208 * authoritative. pict and text fields may contain approximations.
3209 */
3210 SUBTITLE_ASS,
3211 };
3212
3213 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3214
3215 typedef struct AVSubtitleRect {
3216 int x; ///< top left corner of pict, undefined when pict is not set
3217 int y; ///< top left corner of pict, undefined when pict is not set
3218 int w; ///< width of pict, undefined when pict is not set
3219 int h; ///< height of pict, undefined when pict is not set
3220 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3221
3222 #if FF_API_AVPICTURE
3223 /**
3224 * @deprecated unused
3225 */
3226 attribute_deprecated
3227 AVPicture pict;
3228 #endif
3229 /**
3230 * data+linesize for the bitmap of this subtitle.
3231 * Can be set for text/ass as well once they are rendered.
3232 */
3233 uint8_t *data[4];
3234 int linesize[4];
3235
3236 enum AVSubtitleType type;
3237
3238 char *text; ///< 0 terminated plain UTF-8 text
3239
3240 /**
3241 * 0 terminated ASS/SSA compatible event line.
3242 * The presentation of this is unaffected by the other values in this
3243 * struct.
3244 */
3245 char *ass;
3246 int flags;
3247 } AVSubtitleRect;
3248
3249 typedef struct AVSubtitle {
3250 uint16_t format; /* 0 = graphics */
3251 uint32_t start_display_time; /* relative to packet pts, in ms */
3252 uint32_t end_display_time; /* relative to packet pts, in ms */
3253 unsigned num_rects;
3254 AVSubtitleRect **rects;
3255 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3256 } AVSubtitle;
3257
3258 /**
3259 * This struct describes the properties of an encoded stream.
3260 *
3261 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3262 * be allocated with avcodec_parameters_alloc() and freed with
3263 * avcodec_parameters_free().
3264 */
3265 typedef struct AVCodecParameters {
3266 /**
3267 * General type of the encoded data.
3268 */
3269 enum AVMediaType codec_type;
3270 /**
3271 * Specific type of the encoded data (the codec used).
3272 */
3273 enum AVCodecID codec_id;
3274 /**
3275 * Additional information about the codec (corresponds to the AVI FOURCC).
3276 */
3277 uint32_t codec_tag;
3278
3279 /**
3280 * Extra binary data needed for initializing the decoder, codec-dependent.
3281 *
3282 * Must be allocated with av_malloc() and will be freed by
3283 * avcodec_parameters_free(). The allocated size of extradata must be at
3284 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3285 * bytes zeroed.
3286 */
3287 uint8_t *extradata;
3288 /**
3289 * Size of the extradata content in bytes.
3290 */
3291 int extradata_size;
3292
3293 /**
3294 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3295 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3296 */
3297 int format;
3298
3299 /**
3300 * The average bitrate of the encoded data (in bits per second).
3301 */
3302 int bit_rate;
3303
3304 int bits_per_coded_sample;
3305
3306 /**
3307 * Codec-specific bitstream restrictions that the stream conforms to.
3308 */
3309 int profile;
3310 int level;
3311
3312 /**
3313 * Video only. The dimensions of the video frame in pixels.
3314 */
3315 int width;
3316 int height;
3317
3318 /**
3319 * Video only. The aspect ratio (width / height) which a single pixel
3320 * should have when displayed.
3321 *
3322 * When the aspect ratio is unknown / undefined, the numerator should be
3323 * set to 0 (the denominator may have any value).
3324 */
3325 AVRational sample_aspect_ratio;
3326
3327 /**
3328 * Video only. The order of the fields in interlaced video.
3329 */
3330 enum AVFieldOrder field_order;
3331
3332 /**
3333 * Video only. Additional colorspace characteristics.
3334 */
3335 enum AVColorRange color_range;
3336 enum AVColorPrimaries color_primaries;
3337 enum AVColorTransferCharacteristic color_trc;
3338 enum AVColorSpace color_space;
3339 enum AVChromaLocation chroma_location;
3340
3341 /**
3342 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3343 * unknown or unspecified, otherwise the number of bits set must be equal to
3344 * the channels field.
3345 */
3346 uint64_t channel_layout;
3347 /**
3348 * Audio only. The number of audio channels.
3349 */
3350 int channels;
3351 /**
3352 * Audio only. The number of audio samples per second.
3353 */
3354 int sample_rate;
3355 /**
3356 * Audio only. The number of bytes per coded audio frame, required by some
3357 * formats.
3358 *
3359 * Corresponds to nBlockAlign in WAVEFORMATEX.
3360 */
3361 int block_align;
3362
3363 /**
3364 * Audio only. The amount of padding (in samples) inserted by the encoder at
3365 * the beginning of the audio. I.e. this number of leading decoded samples
3366 * must be discarded by the caller to get the original audio without leading
3367 * padding.
3368 */
3369 int initial_padding;
3370 /**
3371 * Audio only. The amount of padding (in samples) appended by the encoder to
3372 * the end of the audio. I.e. this number of decoded samples must be
3373 * discarded by the caller from the end of the stream to get the original
3374 * audio without any trailing padding.
3375 */
3376 int trailing_padding;
3377 } AVCodecParameters;
3378
3379 /**
3380 * If c is NULL, returns the first registered codec,
3381 * if c is non-NULL, returns the next registered codec after c,
3382 * or NULL if c is the last one.
3383 */
3384 AVCodec *av_codec_next(const AVCodec *c);
3385
3386 /**
3387 * Return the LIBAVCODEC_VERSION_INT constant.
3388 */
3389 unsigned avcodec_version(void);
3390
3391 /**
3392 * Return the libavcodec build-time configuration.
3393 */
3394 const char *avcodec_configuration(void);
3395
3396 /**
3397 * Return the libavcodec license.
3398 */
3399 const char *avcodec_license(void);
3400
3401 /**
3402 * Register the codec codec and initialize libavcodec.
3403 *
3404 * @warning either this function or avcodec_register_all() must be called
3405 * before any other libavcodec functions.
3406 *
3407 * @see avcodec_register_all()
3408 */
3409 void avcodec_register(AVCodec *codec);
3410
3411 /**
3412 * Register all the codecs, parsers and bitstream filters which were enabled at
3413 * configuration time. If you do not call this function you can select exactly
3414 * which formats you want to support, by using the individual registration
3415 * functions.
3416 *
3417 * @see avcodec_register
3418 * @see av_register_codec_parser
3419 * @see av_register_bitstream_filter
3420 */
3421 void avcodec_register_all(void);
3422
3423 /**
3424 * Allocate an AVCodecContext and set its fields to default values. The
3425 * resulting struct should be freed with avcodec_free_context().
3426 *
3427 * @param codec if non-NULL, allocate private data and initialize defaults
3428 * for the given codec. It is illegal to then call avcodec_open2()
3429 * with a different codec.
3430 * If NULL, then the codec-specific defaults won't be initialized,
3431 * which may result in suboptimal default settings (this is
3432 * important mainly for encoders, e.g. libx264).
3433 *
3434 * @return An AVCodecContext filled with default values or NULL on failure.
3435 */
3436 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3437
3438 /**
3439 * Free the codec context and everything associated with it and write NULL to
3440 * the provided pointer.
3441 */
3442 void avcodec_free_context(AVCodecContext **avctx);
3443
3444 #if FF_API_GET_CONTEXT_DEFAULTS
3445 /**
3446 * @deprecated This function should not be used, as closing and opening a codec
3447 * context multiple time is not supported. A new codec context should be
3448 * allocated for each new use.
3449 */
3450 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3451 #endif
3452
3453 /**
3454 * Get the AVClass for AVCodecContext. It can be used in combination with
3455 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3456 *
3457 * @see av_opt_find().
3458 */
3459 const AVClass *avcodec_get_class(void);
3460
3461 #if FF_API_COPY_CONTEXT
3462 /**
3463 * Copy the settings of the source AVCodecContext into the destination
3464 * AVCodecContext. The resulting destination codec context will be
3465 * unopened, i.e. you are required to call avcodec_open2() before you
3466 * can use this AVCodecContext to decode/encode video/audio data.
3467 *
3468 * @param dest target codec context, should be initialized with
3469 * avcodec_alloc_context3(), but otherwise uninitialized
3470 * @param src source codec context
3471 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3472 *
3473 * @deprecated The semantics of this function are ill-defined and it should not
3474 * be used. If you need to transfer the stream parameters from one codec context
3475 * to another, use an intermediate AVCodecParameters instance and the
3476 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3477 * functions.
3478 */
3479 attribute_deprecated
3480 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3481 #endif
3482
3483 /**
3484 * Allocate a new AVCodecParameters and set its fields to default values
3485 * (unknown/invalid/0). The returned struct must be freed with
3486 * avcodec_parameters_free().
3487 */
3488 AVCodecParameters *avcodec_parameters_alloc(void);
3489
3490 /**
3491 * Free an AVCodecParameters instance and everything associated with it and
3492 * write NULL to the supplied pointer.
3493 */
3494 void avcodec_parameters_free(AVCodecParameters **par);
3495
3496 /**
3497 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3498 * replaced with newly allocated duplicates of the corresponding fields in src.
3499 *
3500 * @return >= 0 on success, a negative AVERROR code on failure.
3501 */
3502 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3503
3504 /**
3505 * Fill the parameters struct based on the values from the supplied codec
3506 * context. Any allocated fields in par are freed and replaced with duplicates
3507 * of the corresponding fields in codec.
3508 *
3509 * @return >= 0 on success, a negative AVERROR code on failure
3510 */
3511 int avcodec_parameters_from_context(AVCodecParameters *par,
3512 const AVCodecContext *codec);
3513
3514 /**
3515 * Fill the codec context based on the values from the supplied codec
3516 * parameters. Any allocated fields in codec that have a corresponding field in
3517 * par are freed and replaced with duplicates of the corresponding field in par.
3518 * Fields in codec that do not have a counterpart in par are not touched.
3519 *
3520 * @return >= 0 on success, a negative AVERROR code on failure.
3521 */
3522 int avcodec_parameters_to_context(AVCodecContext *codec,
3523 const AVCodecParameters *par);
3524
3525 /**
3526 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3527 * function the context has to be allocated with avcodec_alloc_context3().
3528 *
3529 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3530 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3531 * retrieving a codec.
3532 *
3533 * @warning This function is not thread safe!
3534 *
3535 * @note Always call this function before using decoding routines (such as
3536 * @ref avcodec_receive_frame()).
3537 *
3538 * @code
3539 * avcodec_register_all();
3540 * av_dict_set(&opts, "b", "2.5M", 0);
3541 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3542 * if (!codec)
3543 * exit(1);
3544 *
3545 * context = avcodec_alloc_context3(codec);
3546 *
3547 * if (avcodec_open2(context, codec, opts) < 0)
3548 * exit(1);
3549 * @endcode
3550 *
3551 * @param avctx The context to initialize.
3552 * @param codec The codec to open this context for. If a non-NULL codec has been
3553 * previously passed to avcodec_alloc_context3() or
3554 * for this context, then this parameter MUST be either NULL or
3555 * equal to the previously passed codec.
3556 * @param options A dictionary filled with AVCodecContext and codec-private options.
3557 * On return this object will be filled with options that were not found.
3558 *
3559 * @return zero on success, a negative value on error
3560 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3561 * av_dict_set(), av_opt_find().
3562 */
3563 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3564
3565 /**
3566 * Close a given AVCodecContext and free all the data associated with it
3567 * (but not the AVCodecContext itself).
3568 *
3569 * Calling this function on an AVCodecContext that hasn't been opened will free
3570 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3571 * codec. Subsequent calls will do nothing.
3572 *
3573 * @note Do not use this function. Use avcodec_free_context() to destroy a
3574 * codec context (either open or closed). Opening and closing a codec context
3575 * multiple times is not supported anymore -- use multiple codec contexts
3576 * instead.
3577 */
3578 int avcodec_close(AVCodecContext *avctx);
3579
3580 /**
3581 * Free all allocated data in the given subtitle struct.
3582 *
3583 * @param sub AVSubtitle to free.
3584 */
3585 void avsubtitle_free(AVSubtitle *sub);
3586
3587 /**
3588 * @}
3589 */
3590
3591 /**
3592 * @addtogroup lavc_packet
3593 * @{
3594 */
3595
3596 /**
3597 * Allocate an AVPacket and set its fields to default values. The resulting
3598 * struct must be freed using av_packet_free().
3599 *
3600 * @return An AVPacket filled with default values or NULL on failure.
3601 *
3602 * @note this only allocates the AVPacket itself, not the data buffers. Those
3603 * must be allocated through other means such as av_new_packet.
3604 *
3605 * @see av_new_packet
3606 */
3607 AVPacket *av_packet_alloc(void);
3608
3609 /**
3610 * Create a new packet that references the same data as src.
3611 *
3612 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3613 *
3614 * @return newly created AVPacket on success, NULL on error.
3615 *
3616 * @see av_packet_alloc
3617 * @see av_packet_ref
3618 */
3619 AVPacket *av_packet_clone(const AVPacket *src);
3620
3621 /**
3622 * Free the packet, if the packet is reference counted, it will be
3623 * unreferenced first.
3624 *
3625 * @param pkt packet to be freed. The pointer will be set to NULL.
3626 * @note passing NULL is a no-op.
3627 */
3628 void av_packet_free(AVPacket **pkt);
3629
3630 /**
3631 * Initialize optional fields of a packet with default values.
3632 *
3633 * Note, this does not touch the data and size members, which have to be
3634 * initialized separately.
3635 *
3636 * @param pkt packet
3637 */
3638 void av_init_packet(AVPacket *pkt);
3639
3640 /**
3641 * Allocate the payload of a packet and initialize its fields with
3642 * default values.
3643 *
3644 * @param pkt packet
3645 * @param size wanted payload size
3646 * @return 0 if OK, AVERROR_xxx otherwise
3647 */
3648 int av_new_packet(AVPacket *pkt, int size);
3649
3650 /**
3651 * Reduce packet size, correctly zeroing padding
3652 *
3653 * @param pkt packet
3654 * @param size new size
3655 */
3656 void av_shrink_packet(AVPacket *pkt, int size);
3657
3658 /**
3659 * Increase packet size, correctly zeroing padding
3660 *
3661 * @param pkt packet
3662 * @param grow_by number of bytes by which to increase the size of the packet
3663 */
3664 int av_grow_packet(AVPacket *pkt, int grow_by);
3665
3666 /**
3667 * Initialize a reference-counted packet from av_malloc()ed data.
3668 *
3669 * @param pkt packet to be initialized. This function will set the data, size,
3670 * buf and destruct fields, all others are left untouched.
3671 * @param data Data allocated by av_malloc() to be used as packet data. If this
3672 * function returns successfully, the data is owned by the underlying AVBuffer.
3673 * The caller may not access the data through other means.
3674 * @param size size of data in bytes, without the padding. I.e. the full buffer
3675 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3676 *
3677 * @return 0 on success, a negative AVERROR on error
3678 */
3679 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3680
3681 #if FF_API_AVPACKET_OLD_API
3682 /**
3683 * @warning This is a hack - the packet memory allocation stuff is broken. The
3684 * packet is allocated if it was not really allocated.
3685 *
3686 * @deprecated Use av_packet_ref
3687 */
3688 attribute_deprecated
3689 int av_dup_packet(AVPacket *pkt);
3690 /**
3691 * Free a packet.
3692 *
3693 * @deprecated Use av_packet_unref
3694 *
3695 * @param pkt packet to free
3696 */
3697 attribute_deprecated
3698 void av_free_packet(AVPacket *pkt);
3699 #endif
3700 /**
3701 * Allocate new information of a packet.
3702 *
3703 * @param pkt packet
3704 * @param type side information type
3705 * @param size side information size
3706 * @return pointer to fresh allocated data or NULL otherwise
3707 */
3708 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3709 int size);
3710
3711 /**
3712 * Wrap an existing array as a packet side data.
3713 *
3714 * @param pkt packet
3715 * @param type side information type
3716 * @param data the side data array. It must be allocated with the av_malloc()
3717 * family of functions. The ownership of the data is transferred to
3718 * pkt.
3719 * @param size side information size
3720 * @return a non-negative number on success, a negative AVERROR code on
3721 * failure. On failure, the packet is unchanged and the data remains
3722 * owned by the caller.
3723 */
3724 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3725 uint8_t *data, size_t size);
3726
3727 /**
3728 * Shrink the already allocated side data buffer
3729 *
3730 * @param pkt packet
3731 * @param type side information type
3732 * @param size new side information size
3733 * @return 0 on success, < 0 on failure
3734 */
3735 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3736 int size);
3737
3738 /**
3739 * Get side information from packet.
3740 *
3741 * @param pkt packet
3742 * @param type desired side information type
3743 * @param size pointer for side information size to store (optional)
3744 * @return pointer to data if present or NULL otherwise
3745 */
3746 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3747 int *size);
3748
3749 /**
3750 * Convenience function to free all the side data stored.
3751 * All the other fields stay untouched.
3752 *
3753 * @param pkt packet
3754 */
3755 void av_packet_free_side_data(AVPacket *pkt);
3756
3757 /**
3758 * Setup a new reference to the data described by a given packet
3759 *
3760 * If src is reference-counted, setup dst as a new reference to the
3761 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3762 * data from src into it.
3763 *
3764 * All the other fields are copied from src.
3765 *
3766 * @see av_packet_unref
3767 *
3768 * @param dst Destination packet
3769 * @param src Source packet
3770 *
3771 * @return 0 on success, a negative AVERROR on error.
3772 */
3773 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3774
3775 /**
3776 * Wipe the packet.
3777 *
3778 * Unreference the buffer referenced by the packet and reset the
3779 * remaining packet fields to their default values.
3780 *
3781 * @param pkt The packet to be unreferenced.
3782 */
3783 void av_packet_unref(AVPacket *pkt);
3784
3785 /**
3786 * Move every field in src to dst and reset src.
3787 *
3788 * @see av_packet_unref
3789 *
3790 * @param src Source packet, will be reset
3791 * @param dst Destination packet
3792 */
3793 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3794
3795 /**
3796 * Copy only "properties" fields from src to dst.
3797 *
3798 * Properties for the purpose of this function are all the fields
3799 * beside those related to the packet data (buf, data, size)
3800 *
3801 * @param dst Destination packet
3802 * @param src Source packet
3803 *
3804 * @return 0 on success AVERROR on failure.
3805 */
3806 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3807
3808 /**
3809 * Convert valid timing fields (timestamps / durations) in a packet from one
3810 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3811 * ignored.
3812 *
3813 * @param pkt packet on which the conversion will be performed
3814 * @param tb_src source timebase, in which the timing fields in pkt are
3815 * expressed
3816 * @param tb_dst destination timebase, to which the timing fields will be
3817 * converted
3818 */
3819 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3820
3821 /**
3822 * @}
3823 */
3824
3825 /**
3826 * @addtogroup lavc_decoding
3827 * @{
3828 */
3829
3830 /**
3831 * Find a registered decoder with a matching codec ID.
3832 *
3833 * @param id AVCodecID of the requested decoder
3834 * @return A decoder if one was found, NULL otherwise.
3835 */
3836 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3837
3838 /**
3839 * Find a registered decoder with the specified name.
3840 *
3841 * @param name name of the requested decoder
3842 * @return A decoder if one was found, NULL otherwise.
3843 */
3844 AVCodec *avcodec_find_decoder_by_name(const char *name);
3845
3846 /**
3847 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3848 * it can be called by custom get_buffer2() implementations for decoders without
3849 * AV_CODEC_CAP_DR1 set.
3850 */
3851 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3852
3853 /**
3854 * Modify width and height values so that they will result in a memory
3855 * buffer that is acceptable for the codec if you do not use any horizontal
3856 * padding.
3857 *
3858 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3859 */
3860 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3861
3862 /**
3863 * Modify width and height values so that they will result in a memory
3864 * buffer that is acceptable for the codec if you also ensure that all
3865 * line sizes are a multiple of the respective linesize_align[i].
3866 *
3867 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3868 */
3869 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3870 int linesize_align[AV_NUM_DATA_POINTERS]);
3871
3872 /**
3873 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3874 *
3875 * Some decoders may support multiple frames in a single AVPacket. Such
3876 * decoders would then just decode the first frame and the return value would be
3877 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3878 * called again with an AVPacket containing the remaining data in order to
3879 * decode the second frame, etc... Even if no frames are returned, the packet
3880 * needs to be fed to the decoder with remaining data until it is completely
3881 * consumed or an error occurs.
3882 *
3883 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3884 * and output. This means that for some packets they will not immediately
3885 * produce decoded output and need to be flushed at the end of decoding to get
3886 * all the decoded data. Flushing is done by calling this function with packets
3887 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3888 * returning samples. It is safe to flush even those decoders that are not
3889 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3890 *
3891 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3892 * larger than the actual read bytes because some optimized bitstream
3893 * readers read 32 or 64 bits at once and could read over the end.
3894 *
3895 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3896 * before packets may be fed to the decoder.
3897 *
3898 * @param avctx the codec context
3899 * @param[out] frame The AVFrame in which to store decoded audio samples.
3900 * The decoder will allocate a buffer for the decoded frame by
3901 * calling the AVCodecContext.get_buffer2() callback.
3902 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3903 * reference counted and the returned reference belongs to the
3904 * caller. The caller must release the frame using av_frame_unref()
3905 * when the frame is no longer needed. The caller may safely write
3906 * to the frame if av_frame_is_writable() returns 1.
3907 * When AVCodecContext.refcounted_frames is set to 0, the returned
3908 * reference belongs to the decoder and is valid only until the
3909 * next call to this function or until closing or flushing the
3910 * decoder. The caller may not write to it.
3911 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3912 * non-zero. Note that this field being set to zero
3913 * does not mean that an error has occurred. For
3914 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3915 * call is guaranteed to produce a frame.
3916 * @param[in] avpkt The input AVPacket containing the input buffer.
3917 * At least avpkt->data and avpkt->size should be set. Some
3918 * decoders might also require additional fields to be set.
3919 * @return A negative error code is returned if an error occurred during
3920 * decoding, otherwise the number of bytes consumed from the input
3921 * AVPacket is returned.
3922 *
3923 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3924 */
3925 attribute_deprecated
3926 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3927 int *got_frame_ptr, AVPacket *avpkt);
3928
3929 /**
3930 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3931 * Some decoders may support multiple frames in a single AVPacket, such
3932 * decoders would then just decode the first frame.
3933 *
3934 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3935 * the actual read bytes because some optimized bitstream readers read 32 or 64
3936 * bits at once and could read over the end.
3937 *
3938 * @warning The end of the input buffer buf should be set to 0 to ensure that
3939 * no overreading happens for damaged MPEG streams.
3940 *
3941 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3942 * between input and output, these need to be fed with avpkt->data=NULL,
3943 * avpkt->size=0 at the end to return the remaining frames.
3944 *
3945 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3946 * before packets may be fed to the decoder.
3947 *
3948 * @param avctx the codec context
3949 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3950 * Use av_frame_alloc() to get an AVFrame. The codec will
3951 * allocate memory for the actual bitmap by calling the
3952 * AVCodecContext.get_buffer2() callback.
3953 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3954 * reference counted and the returned reference belongs to the
3955 * caller. The caller must release the frame using av_frame_unref()
3956 * when the frame is no longer needed. The caller may safely write
3957 * to the frame if av_frame_is_writable() returns 1.
3958 * When AVCodecContext.refcounted_frames is set to 0, the returned
3959 * reference belongs to the decoder and is valid only until the
3960 * next call to this function or until closing or flushing the
3961 * decoder. The caller may not write to it.
3962 *
3963 * @param[in] avpkt The input AVPacket containing the input buffer.
3964 * You can create such packet with av_init_packet() and by then setting
3965 * data and size, some decoders might in addition need other fields like
3966 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3967 * fields possible.
3968 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3969 * @return On error a negative value is returned, otherwise the number of bytes
3970 * used or zero if no frame could be decompressed.
3971 *
3972 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3973 */
3974 attribute_deprecated
3975 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3976 int *got_picture_ptr,
3977 AVPacket *avpkt);
3978
3979 /**
3980 * Decode a subtitle message.
3981 * Return a negative value on error, otherwise return the number of bytes used.
3982 * If no subtitle could be decompressed, got_sub_ptr is zero.
3983 * Otherwise, the subtitle is stored in *sub.
3984 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3985 * simplicity, because the performance difference is expect to be negligible
3986 * and reusing a get_buffer written for video codecs would probably perform badly
3987 * due to a potentially very different allocation pattern.
3988 *
3989 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3990 * before packets may be fed to the decoder.
3991 *
3992 * @param avctx the codec context
3993 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3994 freed with avsubtitle_free if *got_sub_ptr is set.
3995 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3996 * @param[in] avpkt The input AVPacket containing the input buffer.
3997 */
3998 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3999 int *got_sub_ptr,
4000 AVPacket *avpkt);
4001
4002 /**
4003 * Supply raw packet data as input to a decoder.
4004 *
4005 * Internally, this call will copy relevant AVCodecContext fields, which can
4006 * influence decoding per-packet, and apply them when the packet is actually
4007 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4008 * decoder to drop the frame contained by the packet sent with this function.)
4009 *
4010 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4011 * larger than the actual read bytes because some optimized bitstream
4012 * readers read 32 or 64 bits at once and could read over the end.
4013 *
4014 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4015 * on the same AVCodecContext. It will return unexpected results now
4016 * or in future libavcodec versions.
4017 *
4018 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4019 * before packets may be fed to the decoder.
4020 *
4021 * @param avctx codec context
4022 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4023 * frame, or several complete audio frames.
4024 * Ownership of the packet remains with the caller, and the
4025 * decoder will not write to the packet. The decoder may create
4026 * a reference to the packet data (or copy it if the packet is
4027 * not reference-counted).
4028 * Unlike with older APIs, the packet is always fully consumed,
4029 * and if it contains multiple frames (e.g. some audio codecs),
4030 * will require you to call avcodec_receive_frame() multiple
4031 * times afterwards before you can send a new packet.
4032 * It can be NULL (or an AVPacket with data set to NULL and
4033 * size set to 0); in this case, it is considered a flush
4034 * packet, which signals the end of the stream. Sending the
4035 * first flush packet will return success. Subsequent ones are
4036 * unnecessary and will return AVERROR_EOF. If the decoder
4037 * still has frames buffered, it will return them after sending
4038 * a flush packet.
4039 *
4040 * @return 0 on success, otherwise negative error code:
4041 * AVERROR(EAGAIN): input is not accepted in the current state - user
4042 * must read output with avcodec_receive_frame() (once
4043 * all output is read, the packet should be resent, and
4044 * the call will not fail with EAGAIN).
4045 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4046 * be sent to it (also returned if more than 1 flush
4047 * packet is sent)
4048 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4049 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4050 * other errors: legitimate decoding errors
4051 */
4052 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4053
4054 /**
4055 * Return decoded output data from a decoder.
4056 *
4057 * @param avctx codec context
4058 * @param frame This will be set to a reference-counted video or audio
4059 * frame (depending on the decoder type) allocated by the
4060 * decoder. Note that the function will always call
4061 * av_frame_unref(frame) before doing anything else.
4062 *
4063 * @return
4064 * 0: success, a frame was returned
4065 * AVERROR(EAGAIN): output is not available in this state - user must try
4066 * to send new input
4067 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4068 * no more output frames
4069 * AVERROR(EINVAL): codec not opened, or it is an encoder
4070 * other negative values: legitimate decoding errors
4071 */
4072 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4073
4074 /**
4075 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4076 * to retrieve buffered output packets.
4077 *
4078 * @param avctx codec context
4079 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4080 * Ownership of the frame remains with the caller, and the
4081 * encoder will not write to the frame. The encoder may create
4082 * a reference to the frame data (or copy it if the frame is
4083 * not reference-counted).
4084 * It can be NULL, in which case it is considered a flush
4085 * packet. This signals the end of the stream. If the encoder
4086 * still has packets buffered, it will return them after this
4087 * call. Once flushing mode has been entered, additional flush
4088 * packets are ignored, and sending frames will return
4089 * AVERROR_EOF.
4090 *
4091 * For audio:
4092 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4093 * can have any number of samples.
4094 * If it is not set, frame->nb_samples must be equal to
4095 * avctx->frame_size for all frames except the last.
4096 * The final frame may be smaller than avctx->frame_size.
4097 * @return 0 on success, otherwise negative error code:
4098 * AVERROR(EAGAIN): input is not accepted in the current state - user
4099 * must read output with avcodec_receive_packet() (once
4100 * all output is read, the packet should be resent, and
4101 * the call will not fail with EAGAIN).
4102 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4103 * be sent to it
4104 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4105 * decoder, or requires flush
4106 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4107 * other errors: legitimate decoding errors
4108 */
4109 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4110
4111 /**
4112 * Read encoded data from the encoder.
4113 *
4114 * @param avctx codec context
4115 * @param avpkt This will be set to a reference-counted packet allocated by the
4116 * encoder. Note that the function will always call
4117 * av_frame_unref(frame) before doing anything else.
4118 * @return 0 on success, otherwise negative error code:
4119 * AVERROR(EAGAIN): output is not available in the current state - user
4120 * must try to send input
4121 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4122 * no more output packets
4123 * AVERROR(EINVAL): codec not opened, or it is an encoder
4124 * other errors: legitimate decoding errors
4125 */
4126 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4127
4128 /**
4129 * Create and return a AVHWFramesContext with values adequate for hardware
4130 * decoding. This is meant to get called from the get_format callback, and is
4131 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4132 * This API is for decoding with certain hardware acceleration modes/APIs only.
4133 *
4134 * The returned AVHWFramesContext is not initialized. The caller must do this
4135 * with av_hwframe_ctx_init().
4136 *
4137 * Calling this function is not a requirement, but makes it simpler to avoid
4138 * codec or hardware API specific details when manually allocating frames.
4139 *
4140 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4141 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4142 * it unnecessary to call this function or having to care about
4143 * AVHWFramesContext initialization at all.
4144 *
4145 * There are a number of requirements for calling this function:
4146 *
4147 * - It must be called from get_format with the same avctx parameter that was
4148 * passed to get_format. Calling it outside of get_format is not allowed, and
4149 * can trigger undefined behavior.
4150 * - The function is not always supported (see description of return values).
4151 * Even if this function returns successfully, hwaccel initialization could
4152 * fail later. (The degree to which implementations check whether the stream
4153 * is actually supported varies. Some do this check only after the user's
4154 * get_format callback returns.)
4155 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4156 * user decides to use a AVHWFramesContext prepared with this API function,
4157 * the user must return the same hw_pix_fmt from get_format.
4158 * - The device_ref passed to this function must support the given hw_pix_fmt.
4159 * - After calling this API function, it is the user's responsibility to
4160 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4161 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4162 * before returning from get_format (this is implied by the normal
4163 * AVCodecContext.hw_frames_ctx API rules).
4164 * - The AVHWFramesContext parameters may change every time time get_format is
4165 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4166 * you are inherently required to go through this process again on every
4167 * get_format call.
4168 * - It is perfectly possible to call this function without actually using
4169 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4170 * previously initialized AVHWFramesContext, and calling this API function
4171 * only to test whether the required frame parameters have changed.
4172 * - Fields that use dynamically allocated values of any kind must not be set
4173 * by the user unless setting them is explicitly allowed by the documentation.
4174 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4175 * the new free callback must call the potentially set previous free callback.
4176 * This API call may set any dynamically allocated fields, including the free
4177 * callback.
4178 *
4179 * The function will set at least the following fields on AVHWFramesContext
4180 * (potentially more, depending on hwaccel API):
4181 *
4182 * - All fields set by av_hwframe_ctx_alloc().
4183 * - Set the format field to hw_pix_fmt.
4184 * - Set the sw_format field to the most suited and most versatile format. (An
4185 * implication is that this will prefer generic formats over opaque formats
4186 * with arbitrary restrictions, if possible.)
4187 * - Set the width/height fields to the coded frame size, rounded up to the
4188 * API-specific minimum alignment.
4189 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4190 * field to the number of maximum reference surfaces possible with the codec,
4191 * plus 1 surface for the user to work (meaning the user can safely reference
4192 * at most 1 decoded surface at a time), plus additional buffering introduced
4193 * by frame threading. If the hwaccel does not require pre-allocation, the
4194 * field is left to 0, and the decoder will allocate new surfaces on demand
4195 * during decoding.
4196 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4197 * hardware API.
4198 *
4199 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4200 * with basic frame parameters set.
4201 *
4202 * The function is stateless, and does not change the AVCodecContext or the
4203 * device_ref AVHWDeviceContext.
4204 *
4205 * @param avctx The context which is currently calling get_format, and which
4206 * implicitly contains all state needed for filling the returned
4207 * AVHWFramesContext properly.
4208 * @param device_ref A reference to the AVHWDeviceContext describing the device
4209 * which will be used by the hardware decoder.
4210 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
4211 * @param out_frames_ref On success, set to a reference to an _uninitialized_
4212 * AVHWFramesContext, created from the given device_ref.
4213 * Fields will be set to values required for decoding.
4214 * Not changed if an error is returned.
4215 * @return zero on success, a negative value on error. The following error codes
4216 * have special semantics:
4217 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
4218 * is always manual, or it is a decoder which does not
4219 * support setting AVCodecContext.hw_frames_ctx at all,
4220 * or it is a software format.
4221 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
4222 * this configuration, or the device_ref is not supported
4223 * for the hwaccel referenced by hw_pix_fmt.
4224 */
4225 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
4226 AVBufferRef *device_ref,
4227 enum AVPixelFormat hw_pix_fmt,
4228 AVBufferRef **out_frames_ref);
4229
4230
4231
4232 /**
4233 * @defgroup lavc_parsing Frame parsing
4234 * @{
4235 */
4236
4237 enum AVPictureStructure {
4238 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4239 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4240 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4241 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4242 };
4243
4244 typedef struct AVCodecParserContext {
4245 void *priv_data;
4246 struct AVCodecParser *parser;
4247 int64_t frame_offset; /* offset of the current frame */
4248 int64_t cur_offset; /* current offset
4249 (incremented by each av_parser_parse()) */
4250 int64_t next_frame_offset; /* offset of the next frame */
4251 /* video info */
4252 int pict_type; /* XXX: Put it back in AVCodecContext. */
4253 /**
4254 * This field is used for proper frame duration computation in lavf.
4255 * It signals, how much longer the frame duration of the current frame
4256 * is compared to normal frame duration.
4257 *
4258 * frame_duration = (1 + repeat_pict) * time_base
4259 *
4260 * It is used by codecs like H.264 to display telecined material.
4261 */
4262 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4263 int64_t pts; /* pts of the current frame */
4264 int64_t dts; /* dts of the current frame */
4265
4266 /* private data */
4267 int64_t last_pts;
4268 int64_t last_dts;
4269 int fetch_timestamp;
4270
4271 #define AV_PARSER_PTS_NB 4
4272 int cur_frame_start_index;
4273 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4274 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4275 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4276
4277 int flags;
4278 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4279 #define PARSER_FLAG_ONCE 0x0002
4280 /// Set if the parser has a valid file offset
4281 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4282
4283 int64_t offset; ///< byte offset from starting packet start
4284 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4285
4286 /**
4287 * Set by parser to 1 for key frames and 0 for non-key frames.
4288 * It is initialized to -1, so if the parser doesn't set this flag,
4289 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4290 * will be used.
4291 */
4292 int key_frame;
4293
4294 #if FF_API_CONVERGENCE_DURATION
4295 /**
4296 * @deprecated unused
4297 */
4298 attribute_deprecated
4299 int64_t convergence_duration;
4300 #endif
4301
4302 // Timestamp generation support:
4303 /**
4304 * Synchronization point for start of timestamp generation.
4305 *
4306 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4307 * (default).
4308 *
4309 * For example, this corresponds to presence of H.264 buffering period
4310 * SEI message.
4311 */
4312 int dts_sync_point;
4313
4314 /**
4315 * Offset of the current timestamp against last timestamp sync point in
4316 * units of AVCodecContext.time_base.
4317 *
4318 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4319 * contain a valid timestamp offset.
4320 *
4321 * Note that the timestamp of sync point has usually a nonzero
4322 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4323 * the next frame after timestamp sync point will be usually 1.
4324 *
4325 * For example, this corresponds to H.264 cpb_removal_delay.
4326 */
4327 int dts_ref_dts_delta;
4328
4329 /**
4330 * Presentation delay of current frame in units of AVCodecContext.time_base.
4331 *
4332 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4333 * contain valid non-negative timestamp delta (presentation time of a frame
4334 * must not lie in the past).
4335 *
4336 * This delay represents the difference between decoding and presentation
4337 * time of the frame.
4338 *
4339 * For example, this corresponds to H.264 dpb_output_delay.
4340 */
4341 int pts_dts_delta;
4342
4343 /**
4344 * Position of the packet in file.
4345 *
4346 * Analogous to cur_frame_pts/dts
4347 */
4348 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4349
4350 /**
4351 * Byte position of currently parsed frame in stream.
4352 */
4353 int64_t pos;
4354
4355 /**
4356 * Previous frame byte position.
4357 */
4358 int64_t last_pos;
4359
4360 /**
4361 * Duration of the current frame.
4362 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4363 * For all other types, this is in units of AVCodecContext.time_base.
4364 */
4365 int duration;
4366
4367 enum AVFieldOrder field_order;
4368
4369 /**
4370 * Indicate whether a picture is coded as a frame, top field or bottom field.
4371 *
4372 * For example, H.264 field_pic_flag equal to 0 corresponds to
4373 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4374 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4375 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4376 */
4377 enum AVPictureStructure picture_structure;
4378
4379 /**
4380 * Picture number incremented in presentation or output order.
4381 * This field may be reinitialized at the first picture of a new sequence.
4382 *
4383 * For example, this corresponds to H.264 PicOrderCnt.
4384 */
4385 int output_picture_number;
4386
4387 /**
4388 * Dimensions of the decoded video intended for presentation.
4389 */
4390 int width;
4391 int height;
4392
4393 /**
4394 * Dimensions of the coded video.
4395 */
4396 int coded_width;
4397 int coded_height;
4398
4399 /**
4400 * The format of the coded data, corresponds to enum AVPixelFormat for video
4401 * and for enum AVSampleFormat for audio.
4402 *
4403 * Note that a decoder can have considerable freedom in how exactly it
4404 * decodes the data, so the format reported here might be different from the
4405 * one returned by a decoder.
4406 */
4407 int format;
4408 } AVCodecParserContext;
4409
4410 typedef struct AVCodecParser {
4411 int codec_ids[5]; /* several codec IDs are permitted */
4412 int priv_data_size;
4413 int (*parser_init)(AVCodecParserContext *s);
4414 /* This callback never returns an error, a negative value means that
4415 * the frame start was in a previous packet. */
4416 int (*parser_parse)(AVCodecParserContext *s,
4417 AVCodecContext *avctx,
4418 const uint8_t **poutbuf, int *poutbuf_size,
4419 const uint8_t *buf, int buf_size);
4420 void (*parser_close)(AVCodecParserContext *s);
4421 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4422 struct AVCodecParser *next;
4423 } AVCodecParser;
4424
4425 AVCodecParser *av_parser_next(const AVCodecParser *c);
4426
4427 void av_register_codec_parser(AVCodecParser *parser);
4428 AVCodecParserContext *av_parser_init(int codec_id);
4429
4430 /**
4431 * Parse a packet.
4432 *
4433 * @param s parser context.
4434 * @param avctx codec context.
4435 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4436 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4437 * @param buf input buffer.
4438 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4439 * @param pts input presentation timestamp.
4440 * @param dts input decoding timestamp.
4441 * @param pos input byte position in stream.
4442 * @return the number of bytes of the input bitstream used.
4443 *
4444 * Example:
4445 * @code
4446 * while(in_len){
4447 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4448 * in_data, in_len,
4449 * pts, dts, pos);
4450 * in_data += len;
4451 * in_len -= len;
4452 *
4453 * if(size)
4454 * decode_frame(data, size);
4455 * }
4456 * @endcode
4457 */
4458 int av_parser_parse2(AVCodecParserContext *s,
4459 AVCodecContext *avctx,
4460 uint8_t **poutbuf, int *poutbuf_size,
4461 const uint8_t *buf, int buf_size,
4462 int64_t pts, int64_t dts,
4463 int64_t pos);
4464
4465 /**
4466 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4467 * @deprecated use AVBitstreamFilter
4468 */
4469 int av_parser_change(AVCodecParserContext *s,
4470 AVCodecContext *avctx,
4471 uint8_t **poutbuf, int *poutbuf_size,
4472 const uint8_t *buf, int buf_size, int keyframe);
4473 void av_parser_close(AVCodecParserContext *s);
4474
4475 /**
4476 * @}
4477 * @}
4478 */
4479
4480 /**
4481 * @addtogroup lavc_encoding
4482 * @{
4483 */
4484
4485 /**
4486 * Find a registered encoder with a matching codec ID.
4487 *
4488 * @param id AVCodecID of the requested encoder
4489 * @return An encoder if one was found, NULL otherwise.
4490 */
4491 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4492
4493 /**
4494 * Find a registered encoder with the specified name.
4495 *
4496 * @param name name of the requested encoder
4497 * @return An encoder if one was found, NULL otherwise.
4498 */
4499 AVCodec *avcodec_find_encoder_by_name(const char *name);
4500
4501 /**
4502 * Encode a frame of audio.
4503 *
4504 * Takes input samples from frame and writes the next output packet, if
4505 * available, to avpkt. The output packet does not necessarily contain data for
4506 * the most recent frame, as encoders can delay, split, and combine input frames
4507 * internally as needed.
4508 *
4509 * @param avctx codec context
4510 * @param avpkt output AVPacket.
4511 * The user can supply an output buffer by setting
4512 * avpkt->data and avpkt->size prior to calling the
4513 * function, but if the size of the user-provided data is not
4514 * large enough, encoding will fail. All other AVPacket fields
4515 * will be reset by the encoder using av_init_packet(). If
4516 * avpkt->data is NULL, the encoder will allocate it.
4517 * The encoder will set avpkt->size to the size of the
4518 * output packet.
4519 *
4520 * If this function fails or produces no output, avpkt will be
4521 * freed using av_packet_unref().
4522 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4523 * May be NULL when flushing an encoder that has the
4524 * AV_CODEC_CAP_DELAY capability set.
4525 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4526 * can have any number of samples.
4527 * If it is not set, frame->nb_samples must be equal to
4528 * avctx->frame_size for all frames except the last.
4529 * The final frame may be smaller than avctx->frame_size.
4530 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4531 * output packet is non-empty, and to 0 if it is
4532 * empty. If the function returns an error, the
4533 * packet can be assumed to be invalid, and the
4534 * value of got_packet_ptr is undefined and should
4535 * not be used.
4536 * @return 0 on success, negative error code on failure
4537 *
4538 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4539 */
4540 attribute_deprecated
4541 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4542 const AVFrame *frame, int *got_packet_ptr);
4543
4544 /**
4545 * Encode a frame of video.
4546 *
4547 * Takes input raw video data from frame and writes the next output packet, if
4548 * available, to avpkt. The output packet does not necessarily contain data for
4549 * the most recent frame, as encoders can delay and reorder input frames
4550 * internally as needed.
4551 *
4552 * @param avctx codec context
4553 * @param avpkt output AVPacket.
4554 * The user can supply an output buffer by setting
4555 * avpkt->data and avpkt->size prior to calling the
4556 * function, but if the size of the user-provided data is not
4557 * large enough, encoding will fail. All other AVPacket fields
4558 * will be reset by the encoder using av_init_packet(). If
4559 * avpkt->data is NULL, the encoder will allocate it.
4560 * The encoder will set avpkt->size to the size of the
4561 * output packet. The returned data (if any) belongs to the
4562 * caller, he is responsible for freeing it.
4563 *
4564 * If this function fails or produces no output, avpkt will be
4565 * freed using av_packet_unref().
4566 * @param[in] frame AVFrame containing the raw video data to be encoded.
4567 * May be NULL when flushing an encoder that has the
4568 * AV_CODEC_CAP_DELAY capability set.
4569 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4570 * output packet is non-empty, and to 0 if it is
4571 * empty. If the function returns an error, the
4572 * packet can be assumed to be invalid, and the
4573 * value of got_packet_ptr is undefined and should
4574 * not be used.
4575 * @return 0 on success, negative error code on failure
4576 *
4577 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4578 */
4579 attribute_deprecated
4580 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4581 const AVFrame *frame, int *got_packet_ptr);
4582
4583 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4584 const AVSubtitle *sub);
4585
4586
4587 /**
4588 * @}
4589 */
4590
4591 #if FF_API_AVPICTURE
4592 /**
4593 * @addtogroup lavc_picture
4594 * @{
4595 */
4596
4597 /**
4598 * @deprecated unused
4599 */
4600 attribute_deprecated
4601 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4602
4603 /**
4604 * @deprecated unused
4605 */
4606 attribute_deprecated
4607 void avpicture_free(AVPicture *picture);
4608
4609 /**
4610 * @deprecated use av_image_fill_arrays() instead.
4611 */
4612 attribute_deprecated
4613 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4614 enum AVPixelFormat pix_fmt, int width, int height);
4615
4616 /**
4617 * @deprecated use av_image_copy_to_buffer() instead.
4618 */
4619 attribute_deprecated
4620 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4621 int width, int height,
4622 unsigned char *dest, int dest_size);
4623
4624 /**
4625 * @deprecated use av_image_get_buffer_size() instead.
4626 */
4627 attribute_deprecated
4628 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4629
4630 /**
4631 * @deprecated av_image_copy() instead.
4632 */
4633 attribute_deprecated
4634 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4635 enum AVPixelFormat pix_fmt, int width, int height);
4636
4637 /**
4638 * @deprecated unused
4639 */
4640 attribute_deprecated
4641 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4642 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4643
4644 /**
4645 * @deprecated unused
4646 */
4647 attribute_deprecated
4648 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4649 int padtop, int padbottom, int padleft, int padright, int *color);
4650
4651 /**
4652 * @}
4653 */
4654 #endif
4655
4656 /**
4657 * @defgroup lavc_misc Utility functions
4658 * @ingroup libavc
4659 *
4660 * Miscellaneous utility functions related to both encoding and decoding
4661 * (or neither).
4662 * @{
4663 */
4664
4665 /**
4666 * @defgroup lavc_misc_pixfmt Pixel formats
4667 *
4668 * Functions for working with pixel formats.
4669 * @{
4670 */
4671
4672 /**
4673 * Return a value representing the fourCC code associated to the
4674 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4675 * found.
4676 */
4677 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4678
4679 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4680 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4681 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4682 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4683 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4684 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4685
4686 /**
4687 * Compute what kind of losses will occur when converting from one specific
4688 * pixel format to another.
4689 * When converting from one pixel format to another, information loss may occur.
4690 * For example, when converting from RGB24 to GRAY, the color information will
4691 * be lost. Similarly, other losses occur when converting from some formats to
4692 * other formats. These losses can involve loss of chroma, but also loss of
4693 * resolution, loss of color depth, loss due to the color space conversion, loss
4694 * of the alpha bits or loss due to color quantization.
4695 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4696 * which will occur when converting from one pixel format to another.
4697 *
4698 * @param[in] dst_pix_fmt destination pixel format
4699 * @param[in] src_pix_fmt source pixel format
4700 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4701 * @return Combination of flags informing you what kind of losses will occur.
4702 */
4703 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4704 int has_alpha);
4705
4706 /**
4707 * Find the best pixel format to convert to given a certain source pixel
4708 * format. When converting from one pixel format to another, information loss
4709 * may occur. For example, when converting from RGB24 to GRAY, the color
4710 * information will be lost. Similarly, other losses occur when converting from
4711 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4712 * the given pixel formats should be used to suffer the least amount of loss.
4713 * The pixel formats from which it chooses one, are determined by the
4714 * pix_fmt_list parameter.
4715 *
4716 *
4717 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4718 * @param[in] src_pix_fmt source pixel format
4719 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4720 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4721 * @return The best pixel format to convert to or -1 if none was found.
4722 */
4723 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4724 enum AVPixelFormat src_pix_fmt,
4725 int has_alpha, int *loss_ptr);
4726
4727 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4728
4729 /**
4730 * @}
4731 */
4732
4733 /**
4734 * Put a string representing the codec tag codec_tag in buf.
4735 *
4736 * @param buf buffer to place codec tag in
4737 * @param buf_size size in bytes of buf
4738 * @param codec_tag codec tag to assign
4739 * @return the length of the string that would have been generated if
4740 * enough space had been available, excluding the trailing null
4741 */
4742 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4743
4744 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4745
4746 /**
4747 * Return a name for the specified profile, if available.
4748 *
4749 * @param codec the codec that is searched for the given profile
4750 * @param profile the profile value for which a name is requested
4751 * @return A name for the profile if found, NULL otherwise.
4752 */
4753 const char *av_get_profile_name(const AVCodec *codec, int profile);
4754
4755 /**
4756 * Return a name for the specified profile, if available.
4757 *
4758 * @param codec_id the ID of the codec to which the requested profile belongs
4759 * @param profile the profile value for which a name is requested
4760 * @return A name for the profile if found, NULL otherwise.
4761 *
4762 * @note unlike av_get_profile_name(), which searches a list of profiles
4763 * supported by a specific decoder or encoder implementation, this
4764 * function searches the list of profiles from the AVCodecDescriptor
4765 */
4766 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4767
4768 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4769 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4770 //FIXME func typedef
4771
4772 /**
4773 * Fill audio frame data and linesize.
4774 * AVFrame extended_data channel pointers are allocated if necessary for
4775 * planar audio.
4776 *
4777 * @param frame the AVFrame
4778 * frame->nb_samples must be set prior to calling the
4779 * function. This function fills in frame->data,
4780 * frame->extended_data, frame->linesize[0].
4781 * @param nb_channels channel count
4782 * @param sample_fmt sample format
4783 * @param buf buffer to use for frame data
4784 * @param buf_size size of buffer
4785 * @param align plane size sample alignment (0 = default)
4786 * @return 0 on success, negative error code on failure
4787 */
4788 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4789 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4790 int buf_size, int align);
4791
4792 /**
4793 * Reset the internal decoder state / flush internal buffers. Should be called
4794 * e.g. when seeking or when switching to a different stream.
4795 *
4796 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4797 * this invalidates the frames previously returned from the decoder. When
4798 * refcounted frames are used, the decoder just releases any references it might
4799 * keep internally, but the caller's reference remains valid.
4800 */
4801 void avcodec_flush_buffers(AVCodecContext *avctx);
4802
4803 /**
4804 * Return codec bits per sample.
4805 *
4806 * @param[in] codec_id the codec
4807 * @return Number of bits per sample or zero if unknown for the given codec.
4808 */
4809 int av_get_bits_per_sample(enum AVCodecID codec_id);
4810
4811 /**
4812 * Return codec bits per sample.
4813 * Only return non-zero if the bits per sample is exactly correct, not an
4814 * approximation.
4815 *
4816 * @param[in] codec_id the codec
4817 * @return Number of bits per sample or zero if unknown for the given codec.
4818 */
4819 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4820
4821 /**
4822 * Return audio frame duration.
4823 *
4824 * @param avctx codec context
4825 * @param frame_bytes size of the frame, or 0 if unknown
4826 * @return frame duration, in samples, if known. 0 if not able to
4827 * determine.
4828 */
4829 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4830
4831 /**
4832 * This function is the same as av_get_audio_frame_duration(), except it works
4833 * with AVCodecParameters instead of an AVCodecContext.
4834 */
4835 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4836
4837 #if FF_API_OLD_BSF
4838 typedef struct AVBitStreamFilterContext {
4839 void *priv_data;
4840 struct AVBitStreamFilter *filter;
4841 AVCodecParserContext *parser;
4842 struct AVBitStreamFilterContext *next;
4843 } AVBitStreamFilterContext;
4844 #endif
4845
4846 typedef struct AVBSFInternal AVBSFInternal;
4847
4848 /**
4849 * The bitstream filter state.
4850 *
4851 * This struct must be allocated with av_bsf_alloc() and freed with
4852 * av_bsf_free().
4853 *
4854 * The fields in the struct will only be changed (by the caller or by the
4855 * filter) as described in their documentation, and are to be considered
4856 * immutable otherwise.
4857 */
4858 typedef struct AVBSFContext {
4859 /**
4860 * A class for logging and AVOptions
4861 */
4862 const AVClass *av_class;
4863
4864 /**
4865 * The bitstream filter this context is an instance of.
4866 */
4867 const struct AVBitStreamFilter *filter;
4868
4869 /**
4870 * Opaque libavcodec internal data. Must not be touched by the caller in any
4871 * way.
4872 */
4873 AVBSFInternal *internal;
4874
4875 /**
4876 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4877 * this is an AVOptions-enabled struct.
4878 */
4879 void *priv_data;
4880
4881 /**
4882 * Parameters of the input stream. This field is allocated in
4883 * av_bsf_alloc(), it needs to be filled by the caller before
4884 * av_bsf_init().
4885 */
4886 AVCodecParameters *par_in;
4887
4888 /**
4889 * Parameters of the output stream. This field is allocated in
4890 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4891 */
4892 AVCodecParameters *par_out;
4893
4894 /**
4895 * The timebase used for the timestamps of the input packets. Set by the
4896 * caller before av_bsf_init().
4897 */
4898 AVRational time_base_in;
4899
4900 /**
4901 * The timebase used for the timestamps of the output packets. Set by the
4902 * filter in av_bsf_init().
4903 */
4904 AVRational time_base_out;
4905 } AVBSFContext;
4906
4907 typedef struct AVBitStreamFilter {
4908 const char *name;
4909
4910 /**
4911 * A list of codec ids supported by the filter, terminated by
4912 * AV_CODEC_ID_NONE.
4913 * May be NULL, in that case the bitstream filter works with any codec id.
4914 */
4915 const enum AVCodecID *codec_ids;
4916
4917 /**
4918 * A class for the private data, used to declare bitstream filter private
4919 * AVOptions. This field is NULL for bitstream filters that do not declare
4920 * any options.
4921 *
4922 * If this field is non-NULL, the first member of the filter private data
4923 * must be a pointer to AVClass, which will be set by libavcodec generic
4924 * code to this class.
4925 */
4926 const AVClass *priv_class;
4927
4928 /*****************************************************************
4929 * No fields below this line are part of the public API. They
4930 * may not be used outside of libavcodec and can be changed and
4931 * removed at will.
4932 * New public fields should be added right above.
4933 *****************************************************************
4934 */
4935
4936 int priv_data_size;
4937 int (*init)(AVBSFContext *ctx);
4938 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4939 void (*close)(AVBSFContext *ctx);
4940 void (*flush)(AVBSFContext *ctx);
4941 } AVBitStreamFilter;
4942
4943 #if FF_API_OLD_BSF
4944 /**
4945 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4946 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4947 */
4948 attribute_deprecated
4949 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4950 attribute_deprecated
4951 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4952 attribute_deprecated
4953 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4954 AVCodecContext *avctx, const char *args,
4955 uint8_t **poutbuf, int *poutbuf_size,
4956 const uint8_t *buf, int buf_size, int keyframe);
4957 attribute_deprecated
4958 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4959 attribute_deprecated
4960 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4961 #endif
4962
4963 /**
4964 * @return a bitstream filter with the specified name or NULL if no such
4965 * bitstream filter exists.
4966 */
4967 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4968
4969 /**
4970 * Iterate over all registered bitstream filters.
4971 *
4972 * @param opaque a pointer where libavcodec will store the iteration state. Must
4973 * point to NULL to start the iteration.
4974 *
4975 * @return the next registered bitstream filter or NULL when the iteration is
4976 * finished
4977 */
4978 const AVBitStreamFilter *av_bsf_next(void **opaque);
4979
4980 /**
4981 * Allocate a context for a given bitstream filter. The caller must fill in the
4982 * context parameters as described in the documentation and then call
4983 * av_bsf_init() before sending any data to the filter.
4984 *
4985 * @param filter the filter for which to allocate an instance.
4986 * @param ctx a pointer into which the pointer to the newly-allocated context
4987 * will be written. It must be freed with av_bsf_free() after the
4988 * filtering is done.
4989 *
4990 * @return 0 on success, a negative AVERROR code on failure
4991 */
4992 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4993
4994 /**
4995 * Prepare the filter for use, after all the parameters and options have been
4996 * set.
4997 */
4998 int av_bsf_init(AVBSFContext *ctx);
4999
5000 /**
5001 * Submit a packet for filtering.
5002 *
5003 * After sending each packet, the filter must be completely drained by calling
5004 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5005 * AVERROR_EOF.
5006 *
5007 * @param pkt the packet to filter. The bitstream filter will take ownership of
5008 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5009 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5010 * packets will be sent). That will cause the filter to output any packets it
5011 * may have buffered internally.
5012 *
5013 * @return 0 on success, a negative AVERROR on error.
5014 */
5015 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5016
5017 /**
5018 * Retrieve a filtered packet.
5019 *
5020 * @param[out] pkt this struct will be filled with the contents of the filtered
5021 * packet. It is owned by the caller and must be freed using
5022 * av_packet_unref() when it is no longer needed.
5023 * This parameter should be "clean" (i.e. freshly allocated
5024 * with av_packet_alloc() or unreffed with av_packet_unref())
5025 * when this function is called. If this function returns
5026 * successfully, the contents of pkt will be completely
5027 * overwritten by the returned data. On failure, pkt is not
5028 * touched.
5029 *
5030 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5031 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5032 * will be no further output from the filter. Another negative AVERROR value if
5033 * an error occurs.
5034 *
5035 * @note one input packet may result in several output packets, so after sending
5036 * a packet with av_bsf_send_packet(), this function needs to be called
5037 * repeatedly until it stops returning 0. It is also possible for a filter to
5038 * output fewer packets than were sent to it, so this function may return
5039 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5040 */
5041 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5042
5043 /**
5044 * Reset the internal bitstream filter state / flush internal buffers.
5045 */
5046 void av_bsf_flush(AVBSFContext *ctx);
5047
5048 /**
5049 * Free a bitstream filter context and everything associated with it; write NULL
5050 * into the supplied pointer.
5051 */
5052 void av_bsf_free(AVBSFContext **ctx);
5053
5054 /**
5055 * Get the AVClass for AVBSFContext. It can be used in combination with
5056 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5057 *
5058 * @see av_opt_find().
5059 */
5060 const AVClass *av_bsf_get_class(void);
5061
5062 /* memory */
5063
5064 /**
5065 * Allocate a buffer with padding, reusing the given one if large enough.
5066 *
5067 * Same behaviour av_fast_malloc but the buffer has additional
5068 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
5069 */
5070 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5071
5072 /**
5073 * Encode extradata length to a buffer. Used by xiph codecs.
5074 *
5075 * @param s buffer to write to; must be at least (v/255+1) bytes long
5076 * @param v size of extradata in bytes
5077 * @return number of bytes written to the buffer.
5078 */
5079 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5080
5081 #if FF_API_USER_VISIBLE_AVHWACCEL
5082 /**
5083 * Register the hardware accelerator hwaccel.
5084 *
5085 * @deprecated This function doesn't do anything.
5086 */
5087 attribute_deprecated
5088 void av_register_hwaccel(AVHWAccel *hwaccel);
5089
5090 /**
5091 * If hwaccel is NULL, returns the first registered hardware accelerator,
5092 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5093 * after hwaccel, or NULL if hwaccel is the last one.
5094 *
5095 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
5096 * this function should not be used.
5097 */
5098 attribute_deprecated
5099 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5100 #endif
5101
5102
5103 /**
5104 * Lock operation used by lockmgr
5105 */
5106 enum AVLockOp {
5107 AV_LOCK_CREATE, ///< Create a mutex
5108 AV_LOCK_OBTAIN, ///< Lock the mutex
5109 AV_LOCK_RELEASE, ///< Unlock the mutex
5110 AV_LOCK_DESTROY, ///< Free mutex resources
5111 };
5112
5113 /**
5114 * Register a user provided lock manager supporting the operations
5115 * specified by AVLockOp. The "mutex" argument to the function points
5116 * to a (void *) where the lockmgr should store/get a pointer to a user
5117 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5118 * value left by the last call for all other ops. If the lock manager is
5119 * unable to perform the op then it should leave the mutex in the same
5120 * state as when it was called and return a non-zero value. However,
5121 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5122 * have been successfully destroyed. If av_lockmgr_register succeeds
5123 * it will return a non-negative value, if it fails it will return a
5124 * negative value and destroy all mutex and unregister all callbacks.
5125 * av_lockmgr_register is not thread-safe, it must be called from a
5126 * single thread before any calls which make use of locking are used.
5127 *
5128 * @param cb User defined callback. av_lockmgr_register invokes calls
5129 * to this callback and the previously registered callback.
5130 * The callback will be used to create more than one mutex
5131 * each of which must be backed by its own underlying locking
5132 * mechanism (i.e. do not use a single static object to
5133 * implement your lock manager). If cb is set to NULL the
5134 * lockmgr will be unregistered.
5135 */
5136 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5137
5138 /**
5139 * Get the type of the given codec.
5140 */
5141 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5142
5143 /**
5144 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5145 * with no corresponding avcodec_close()), 0 otherwise.
5146 */
5147 int avcodec_is_open(AVCodecContext *s);
5148
5149 /**
5150 * @return a non-zero number if codec is an encoder, zero otherwise
5151 */
5152 int av_codec_is_encoder(const AVCodec *codec);
5153
5154 /**
5155 * @return a non-zero number if codec is a decoder, zero otherwise
5156 */
5157 int av_codec_is_decoder(const AVCodec *codec);
5158
5159 /**
5160 * @return descriptor for given codec ID or NULL if no descriptor exists.
5161 */
5162 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5163
5164 /**
5165 * Iterate over all codec descriptors known to libavcodec.
5166 *
5167 * @param prev previous descriptor. NULL to get the first descriptor.
5168 *
5169 * @return next descriptor or NULL after the last descriptor
5170 */
5171 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5172
5173 /**
5174 * @return codec descriptor with the given name or NULL if no such descriptor
5175 * exists.
5176 */
5177 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5178
5179 /**
5180 * Allocate a CPB properties structure and initialize its fields to default
5181 * values.
5182 *
5183 * @param size if non-NULL, the size of the allocated struct will be written
5184 * here. This is useful for embedding it in side data.
5185 *
5186 * @return the newly allocated struct or NULL on failure
5187 */
5188 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5189
5190 /**
5191 * @}
5192 */
5193
5194 #endif /* AVCODEC_AVCODEC_H */