summaryrefslogtreecommitdiff
path: root/libavcodec/avcodec.h (plain)
blob: 14d7aa1947f7b454bf52369915a439063fa676ed
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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/channel_layout.h"
37#include "libavutil/dict.h"
38#include "libavutil/frame.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 libavcodec
47 * Encoding/Decoding Library
48 *
49 * @{
50 *
51 * @defgroup lavc_decoding Decoding
52 * @{
53 * @}
54 *
55 * @defgroup lavc_encoding Encoding
56 * @{
57 * @}
58 *
59 * @defgroup lavc_codec Codecs
60 * @{
61 * @defgroup lavc_codec_native Native Codecs
62 * @{
63 * @}
64 * @defgroup lavc_codec_wrappers External library wrappers
65 * @{
66 * @}
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68 * @{
69 * @}
70 * @}
71 * @defgroup lavc_internal Internal
72 * @{
73 * @}
74 * @}
75 */
76
77/**
78 * @ingroup libavc
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
80 * @{
81 *
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
85 *
86 * The API is very similar for encoding/decoding and audio/video, and works as
87 * follows:
88 * - Set up and open the AVCodecContext as usual.
89 * - Send valid input:
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
109 *
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
113 * outlined above.
114 *
115 * In theory, sending input can result in EAGAIN - this should happen only if
116 * not all output was received. You can use this to structure alternative decode
117 * or encode loops other than the one suggested above. For example, you could
118 * try sending new input on each iteration, and try to receive output if that
119 * returns EAGAIN.
120 *
121 * End of stream situations. These require "flushing" (aka draining) the codec,
122 * as the codec might buffer multiple frames or packets internally for
123 * performance or out of necessity (consider B-frames).
124 * This is handled as follows:
125 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126 * or avcodec_send_frame() (encoding) functions. This will enter draining
127 * mode.
128 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
130 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131 * - Before decoding can be resumed again, the codec has to be reset with
132 * avcodec_flush_buffers().
133 *
134 * Using the API as outlined above is highly recommended. But it is also
135 * possible to call functions outside of this rigid schema. For example, you can
136 * call avcodec_send_packet() repeatedly without calling
137 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138 * until the codec's internal buffer has been filled up (which is typically of
139 * size 1 per output frame, after initial input), and then reject input with
140 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141 * read at least some output.
142 *
143 * Not all codecs will follow a rigid and predictable dataflow; the only
144 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145 * one end implies that a receive/send call on the other end will succeed, or
146 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147 * permit unlimited buffering of input or output.
148 *
149 * This API replaces the following legacy functions:
150 * - avcodec_decode_video2() and avcodec_decode_audio4():
151 * Use avcodec_send_packet() to feed input to the decoder, then use
152 * avcodec_receive_frame() to receive decoded frames after each packet.
153 * Unlike with the old video decoding API, multiple frames might result from
154 * a packet. For audio, splitting the input packet into frames by partially
155 * decoding packets becomes transparent to the API user. You never need to
156 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157 * no data was read from the packet).
158 * Additionally, sending a flush/draining packet is required only once.
159 * - avcodec_encode_video2()/avcodec_encode_audio2():
160 * Use avcodec_send_frame() to feed input to the encoder, then use
161 * avcodec_receive_packet() to receive encoded packets.
162 * Providing user-allocated buffers for avcodec_receive_packet() is not
163 * possible.
164 * - The new API does not handle subtitles yet.
165 *
166 * Mixing new and old function calls on the same AVCodecContext is not allowed,
167 * and will result in undefined behavior.
168 *
169 * Some codecs might require using the new API; using the old API will return
170 * an error when calling it. All codecs support the new API.
171 *
172 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173 * would be an invalid state, which could put the codec user into an endless
174 * loop. The API has no concept of time either: it cannot happen that trying to
175 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176 * later accepts the packet (with no other receive/flush API calls involved).
177 * The API is a strict state machine, and the passage of time is not supposed
178 * to influence it. Some timing-dependent behavior might still be deemed
179 * acceptable in certain cases. But it must never result in both send/receive
180 * returning EAGAIN at the same time at any point. It must also absolutely be
181 * avoided that the current state is "unstable" and can "flip-flop" between
182 * the send/receive APIs allowing progress. For example, it's not allowed that
183 * the codec randomly decides that it actually wants to consume a packet now
184 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185 * avcodec_send_packet() call.
186 * @}
187 */
188
189/**
190 * @defgroup lavc_core Core functions/structures.
191 * @ingroup libavc
192 *
193 * Basic definitions, functions for querying libavcodec capabilities,
194 * allocating core structures, etc.
195 * @{
196 */
197
198
199/**
200 * Identify the syntax and semantics of the bitstream.
201 * The principle is roughly:
202 * Two decoders with the same ID can decode the same streams.
203 * Two encoders with the same ID can encode compatible streams.
204 * There may be slight deviations from the principle due to implementation
205 * details.
206 *
207 * If you add a codec ID to this list, add it so that
208 * 1. no value of an existing codec ID changes (that would break ABI),
209 * 2. it is as close as possible to similar codecs
210 *
211 * After adding new codec IDs, do not forget to add an entry to the codec
212 * descriptor list and bump libavcodec minor version.
213 */
214enum AVCodecID {
215 AV_CODEC_ID_NONE,
216
217 /* video codecs */
218 AV_CODEC_ID_MPEG1VIDEO,
219 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220#if FF_API_XVMC
221 AV_CODEC_ID_MPEG2VIDEO_XVMC,
222#endif /* FF_API_XVMC */
223 AV_CODEC_ID_H261,
224 AV_CODEC_ID_H263,
225 AV_CODEC_ID_RV10,
226 AV_CODEC_ID_RV20,
227 AV_CODEC_ID_MJPEG,
228 AV_CODEC_ID_MJPEGB,
229 AV_CODEC_ID_LJPEG,
230 AV_CODEC_ID_SP5X,
231 AV_CODEC_ID_JPEGLS,
232 AV_CODEC_ID_MPEG4,
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
237 AV_CODEC_ID_WMV1,
238 AV_CODEC_ID_WMV2,
239 AV_CODEC_ID_H263P,
240 AV_CODEC_ID_H263I,
241 AV_CODEC_ID_FLV1,
242 AV_CODEC_ID_SVQ1,
243 AV_CODEC_ID_SVQ3,
244 AV_CODEC_ID_DVVIDEO,
245 AV_CODEC_ID_HUFFYUV,
246 AV_CODEC_ID_CYUV,
247 AV_CODEC_ID_H264,
248 AV_CODEC_ID_INDEO3,
249 AV_CODEC_ID_VP3,
250 AV_CODEC_ID_THEORA,
251 AV_CODEC_ID_ASV1,
252 AV_CODEC_ID_ASV2,
253 AV_CODEC_ID_FFV1,
254 AV_CODEC_ID_4XM,
255 AV_CODEC_ID_VCR1,
256 AV_CODEC_ID_CLJR,
257 AV_CODEC_ID_MDEC,
258 AV_CODEC_ID_ROQ,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
260 AV_CODEC_ID_XAN_WC3,
261 AV_CODEC_ID_XAN_WC4,
262 AV_CODEC_ID_RPZA,
263 AV_CODEC_ID_CINEPAK,
264 AV_CODEC_ID_WS_VQA,
265 AV_CODEC_ID_MSRLE,
266 AV_CODEC_ID_MSVIDEO1,
267 AV_CODEC_ID_IDCIN,
268 AV_CODEC_ID_8BPS,
269 AV_CODEC_ID_SMC,
270 AV_CODEC_ID_FLIC,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
273 AV_CODEC_ID_MSZH,
274 AV_CODEC_ID_ZLIB,
275 AV_CODEC_ID_QTRLE,
276 AV_CODEC_ID_TSCC,
277 AV_CODEC_ID_ULTI,
278 AV_CODEC_ID_QDRAW,
279 AV_CODEC_ID_VIXL,
280 AV_CODEC_ID_QPEG,
281 AV_CODEC_ID_PNG,
282 AV_CODEC_ID_PPM,
283 AV_CODEC_ID_PBM,
284 AV_CODEC_ID_PGM,
285 AV_CODEC_ID_PGMYUV,
286 AV_CODEC_ID_PAM,
287 AV_CODEC_ID_FFVHUFF,
288 AV_CODEC_ID_RV30,
289 AV_CODEC_ID_RV40,
290 AV_CODEC_ID_VC1,
291 AV_CODEC_ID_WMV3,
292 AV_CODEC_ID_LOCO,
293 AV_CODEC_ID_WNV1,
294 AV_CODEC_ID_AASC,
295 AV_CODEC_ID_INDEO2,
296 AV_CODEC_ID_FRAPS,
297 AV_CODEC_ID_TRUEMOTION2,
298 AV_CODEC_ID_BMP,
299 AV_CODEC_ID_CSCD,
300 AV_CODEC_ID_MMVIDEO,
301 AV_CODEC_ID_ZMBV,
302 AV_CODEC_ID_AVS,
303 AV_CODEC_ID_SMACKVIDEO,
304 AV_CODEC_ID_NUV,
305 AV_CODEC_ID_KMVC,
306 AV_CODEC_ID_FLASHSV,
307 AV_CODEC_ID_CAVS,
308 AV_CODEC_ID_JPEG2000,
309 AV_CODEC_ID_VMNC,
310 AV_CODEC_ID_VP5,
311 AV_CODEC_ID_VP6,
312 AV_CODEC_ID_VP6F,
313 AV_CODEC_ID_TARGA,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
316 AV_CODEC_ID_TIFF,
317 AV_CODEC_ID_GIF,
318 AV_CODEC_ID_DXA,
319 AV_CODEC_ID_DNXHD,
320 AV_CODEC_ID_THP,
321 AV_CODEC_ID_SGI,
322 AV_CODEC_ID_C93,
323 AV_CODEC_ID_BETHSOFTVID,
324 AV_CODEC_ID_PTX,
325 AV_CODEC_ID_TXD,
326 AV_CODEC_ID_VP6A,
327 AV_CODEC_ID_AMV,
328 AV_CODEC_ID_VB,
329 AV_CODEC_ID_PCX,
330 AV_CODEC_ID_SUNRAST,
331 AV_CODEC_ID_INDEO4,
332 AV_CODEC_ID_INDEO5,
333 AV_CODEC_ID_MIMIC,
334 AV_CODEC_ID_RL2,
335 AV_CODEC_ID_ESCAPE124,
336 AV_CODEC_ID_DIRAC,
337 AV_CODEC_ID_BFI,
338 AV_CODEC_ID_CMV,
339 AV_CODEC_ID_MOTIONPIXELS,
340 AV_CODEC_ID_TGV,
341 AV_CODEC_ID_TGQ,
342 AV_CODEC_ID_TQI,
343 AV_CODEC_ID_AURA,
344 AV_CODEC_ID_AURA2,
345 AV_CODEC_ID_V210X,
346 AV_CODEC_ID_TMV,
347 AV_CODEC_ID_V210,
348 AV_CODEC_ID_DPX,
349 AV_CODEC_ID_MAD,
350 AV_CODEC_ID_FRWU,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
353 AV_CODEC_ID_R210,
354 AV_CODEC_ID_ANM,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357#define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
358 AV_CODEC_ID_KGV1,
359 AV_CODEC_ID_YOP,
360 AV_CODEC_ID_VP8,
361 AV_CODEC_ID_PICTOR,
362 AV_CODEC_ID_ANSI,
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
365 AV_CODEC_ID_R10K,
366 AV_CODEC_ID_MXPEG,
367 AV_CODEC_ID_LAGARITH,
368 AV_CODEC_ID_PRORES,
369 AV_CODEC_ID_JV,
370 AV_CODEC_ID_DFA,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
373 AV_CODEC_ID_UTVIDEO,
374 AV_CODEC_ID_BMV_VIDEO,
375 AV_CODEC_ID_VBLE,
376 AV_CODEC_ID_DXTORY,
377 AV_CODEC_ID_V410,
378 AV_CODEC_ID_XWD,
379 AV_CODEC_ID_CDXL,
380 AV_CODEC_ID_XBM,
381 AV_CODEC_ID_ZEROCODEC,
382 AV_CODEC_ID_MSS1,
383 AV_CODEC_ID_MSA1,
384 AV_CODEC_ID_TSCC2,
385 AV_CODEC_ID_MTS2,
386 AV_CODEC_ID_CLLC,
387 AV_CODEC_ID_MSS2,
388 AV_CODEC_ID_VP9,
389 AV_CODEC_ID_AIC,
390 AV_CODEC_ID_ESCAPE130,
391 AV_CODEC_ID_G2M,
392 AV_CODEC_ID_WEBP,
393 AV_CODEC_ID_HNM4_VIDEO,
394 AV_CODEC_ID_HEVC,
395#define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396 AV_CODEC_ID_FIC,
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
400 AV_CODEC_ID_EXR,
401 AV_CODEC_ID_VP7,
402 AV_CODEC_ID_SANM,
403 AV_CODEC_ID_SGIRLE,
404 AV_CODEC_ID_MVC1,
405 AV_CODEC_ID_MVC2,
406 AV_CODEC_ID_HQX,
407 AV_CODEC_ID_TDSC,
408 AV_CODEC_ID_HQ_HQA,
409 AV_CODEC_ID_HAP,
410 AV_CODEC_ID_DDS,
411 AV_CODEC_ID_DXV,
412 AV_CODEC_ID_SCREENPRESSO,
413 AV_CODEC_ID_RSCC,
414
415 AV_CODEC_ID_Y41P = 0x8000,
416 AV_CODEC_ID_AVRP,
417 AV_CODEC_ID_012V,
418 AV_CODEC_ID_AVUI,
419 AV_CODEC_ID_AYUV,
420 AV_CODEC_ID_TARGA_Y216,
421 AV_CODEC_ID_V308,
422 AV_CODEC_ID_V408,
423 AV_CODEC_ID_YUV4,
424 AV_CODEC_ID_AVRN,
425 AV_CODEC_ID_CPIA,
426 AV_CODEC_ID_XFACE,
427 AV_CODEC_ID_SNOW,
428 AV_CODEC_ID_SMVJPEG,
429 AV_CODEC_ID_APNG,
430 AV_CODEC_ID_DAALA,
431 AV_CODEC_ID_CFHD,
432 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_M101,
434 AV_CODEC_ID_MAGICYUV,
435 AV_CODEC_ID_SHEERVIDEO,
436 AV_CODEC_ID_YLC,
437 AV_CODEC_ID_PSD,
438 AV_CODEC_ID_PIXLET,
439 AV_CODEC_ID_SPEEDHQ,
440 AV_CODEC_ID_FMVC,
441 AV_CODEC_ID_SCPR,
442 AV_CODEC_ID_CLEARVIDEO,
443 AV_CODEC_ID_XPM,
444 AV_CODEC_ID_AV1,
445
446 /* various PCM "codecs" */
447 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
448 AV_CODEC_ID_PCM_S16LE = 0x10000,
449 AV_CODEC_ID_PCM_S16BE,
450 AV_CODEC_ID_PCM_U16LE,
451 AV_CODEC_ID_PCM_U16BE,
452 AV_CODEC_ID_PCM_S8,
453 AV_CODEC_ID_PCM_U8,
454 AV_CODEC_ID_PCM_MULAW,
455 AV_CODEC_ID_PCM_ALAW,
456 AV_CODEC_ID_PCM_S32LE,
457 AV_CODEC_ID_PCM_S32BE,
458 AV_CODEC_ID_PCM_U32LE,
459 AV_CODEC_ID_PCM_U32BE,
460 AV_CODEC_ID_PCM_S24LE,
461 AV_CODEC_ID_PCM_S24BE,
462 AV_CODEC_ID_PCM_U24LE,
463 AV_CODEC_ID_PCM_U24BE,
464 AV_CODEC_ID_PCM_S24DAUD,
465 AV_CODEC_ID_PCM_ZORK,
466 AV_CODEC_ID_PCM_S16LE_PLANAR,
467 AV_CODEC_ID_PCM_DVD,
468 AV_CODEC_ID_PCM_F32BE,
469 AV_CODEC_ID_PCM_F32LE,
470 AV_CODEC_ID_PCM_F64BE,
471 AV_CODEC_ID_PCM_F64LE,
472 AV_CODEC_ID_PCM_BLURAY,
473 AV_CODEC_ID_PCM_LXF,
474 AV_CODEC_ID_S302M,
475 AV_CODEC_ID_PCM_S8_PLANAR,
476 AV_CODEC_ID_PCM_S24LE_PLANAR,
477 AV_CODEC_ID_PCM_S32LE_PLANAR,
478 AV_CODEC_ID_PCM_S16BE_PLANAR,
479
480 AV_CODEC_ID_PCM_S64LE = 0x10800,
481 AV_CODEC_ID_PCM_S64BE,
482 AV_CODEC_ID_PCM_F16LE,
483 AV_CODEC_ID_PCM_F24LE,
484
485 /* various ADPCM codecs */
486 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
487 AV_CODEC_ID_ADPCM_IMA_WAV,
488 AV_CODEC_ID_ADPCM_IMA_DK3,
489 AV_CODEC_ID_ADPCM_IMA_DK4,
490 AV_CODEC_ID_ADPCM_IMA_WS,
491 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
492 AV_CODEC_ID_ADPCM_MS,
493 AV_CODEC_ID_ADPCM_4XM,
494 AV_CODEC_ID_ADPCM_XA,
495 AV_CODEC_ID_ADPCM_ADX,
496 AV_CODEC_ID_ADPCM_EA,
497 AV_CODEC_ID_ADPCM_G726,
498 AV_CODEC_ID_ADPCM_CT,
499 AV_CODEC_ID_ADPCM_SWF,
500 AV_CODEC_ID_ADPCM_YAMAHA,
501 AV_CODEC_ID_ADPCM_SBPRO_4,
502 AV_CODEC_ID_ADPCM_SBPRO_3,
503 AV_CODEC_ID_ADPCM_SBPRO_2,
504 AV_CODEC_ID_ADPCM_THP,
505 AV_CODEC_ID_ADPCM_IMA_AMV,
506 AV_CODEC_ID_ADPCM_EA_R1,
507 AV_CODEC_ID_ADPCM_EA_R3,
508 AV_CODEC_ID_ADPCM_EA_R2,
509 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
510 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
511 AV_CODEC_ID_ADPCM_EA_XAS,
512 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
513 AV_CODEC_ID_ADPCM_IMA_ISS,
514 AV_CODEC_ID_ADPCM_G722,
515 AV_CODEC_ID_ADPCM_IMA_APC,
516 AV_CODEC_ID_ADPCM_VIMA,
517#if FF_API_VIMA_DECODER
518 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
519#endif
520
521 AV_CODEC_ID_ADPCM_AFC = 0x11800,
522 AV_CODEC_ID_ADPCM_IMA_OKI,
523 AV_CODEC_ID_ADPCM_DTK,
524 AV_CODEC_ID_ADPCM_IMA_RAD,
525 AV_CODEC_ID_ADPCM_G726LE,
526 AV_CODEC_ID_ADPCM_THP_LE,
527 AV_CODEC_ID_ADPCM_PSX,
528 AV_CODEC_ID_ADPCM_AICA,
529 AV_CODEC_ID_ADPCM_IMA_DAT4,
530 AV_CODEC_ID_ADPCM_MTAF,
531
532 /* AMR */
533 AV_CODEC_ID_AMR_NB = 0x12000,
534 AV_CODEC_ID_AMR_WB,
535
536 /* RealAudio codecs*/
537 AV_CODEC_ID_RA_144 = 0x13000,
538 AV_CODEC_ID_RA_288,
539
540 /* various DPCM codecs */
541 AV_CODEC_ID_ROQ_DPCM = 0x14000,
542 AV_CODEC_ID_INTERPLAY_DPCM,
543 AV_CODEC_ID_XAN_DPCM,
544 AV_CODEC_ID_SOL_DPCM,
545
546 AV_CODEC_ID_SDX2_DPCM = 0x14800,
547
548 /* audio codecs */
549 AV_CODEC_ID_MP2 = 0x15000,
550 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
551 AV_CODEC_ID_AAC,
552 AV_CODEC_ID_AC3,
553 AV_CODEC_ID_DTS,
554 AV_CODEC_ID_VORBIS,
555 AV_CODEC_ID_DVAUDIO,
556 AV_CODEC_ID_WMAV1,
557 AV_CODEC_ID_WMAV2,
558 AV_CODEC_ID_MACE3,
559 AV_CODEC_ID_MACE6,
560 AV_CODEC_ID_VMDAUDIO,
561 AV_CODEC_ID_FLAC,
562 AV_CODEC_ID_MP3ADU,
563 AV_CODEC_ID_MP3ON4,
564 AV_CODEC_ID_SHORTEN,
565 AV_CODEC_ID_ALAC,
566 AV_CODEC_ID_WESTWOOD_SND1,
567 AV_CODEC_ID_GSM, ///< as in Berlin toast format
568 AV_CODEC_ID_QDM2,
569 AV_CODEC_ID_COOK,
570 AV_CODEC_ID_TRUESPEECH,
571 AV_CODEC_ID_TTA,
572 AV_CODEC_ID_SMACKAUDIO,
573 AV_CODEC_ID_QCELP,
574 AV_CODEC_ID_WAVPACK,
575 AV_CODEC_ID_DSICINAUDIO,
576 AV_CODEC_ID_IMC,
577 AV_CODEC_ID_MUSEPACK7,
578 AV_CODEC_ID_MLP,
579 AV_CODEC_ID_GSM_MS, /* as found in WAV */
580 AV_CODEC_ID_ATRAC3,
581#if FF_API_VOXWARE
582 AV_CODEC_ID_VOXWARE,
583#endif
584 AV_CODEC_ID_APE,
585 AV_CODEC_ID_NELLYMOSER,
586 AV_CODEC_ID_MUSEPACK8,
587 AV_CODEC_ID_SPEEX,
588 AV_CODEC_ID_WMAVOICE,
589 AV_CODEC_ID_WMAPRO,
590 AV_CODEC_ID_WMALOSSLESS,
591 AV_CODEC_ID_ATRAC3P,
592 AV_CODEC_ID_EAC3,
593 AV_CODEC_ID_SIPR,
594 AV_CODEC_ID_MP1,
595 AV_CODEC_ID_TWINVQ,
596 AV_CODEC_ID_TRUEHD,
597 AV_CODEC_ID_MP4ALS,
598 AV_CODEC_ID_ATRAC1,
599 AV_CODEC_ID_BINKAUDIO_RDFT,
600 AV_CODEC_ID_BINKAUDIO_DCT,
601 AV_CODEC_ID_AAC_LATM,
602 AV_CODEC_ID_QDMC,
603 AV_CODEC_ID_CELT,
604 AV_CODEC_ID_G723_1,
605 AV_CODEC_ID_G729,
606 AV_CODEC_ID_8SVX_EXP,
607 AV_CODEC_ID_8SVX_FIB,
608 AV_CODEC_ID_BMV_AUDIO,
609 AV_CODEC_ID_RALF,
610 AV_CODEC_ID_IAC,
611 AV_CODEC_ID_ILBC,
612 AV_CODEC_ID_OPUS,
613 AV_CODEC_ID_COMFORT_NOISE,
614 AV_CODEC_ID_TAK,
615 AV_CODEC_ID_METASOUND,
616 AV_CODEC_ID_PAF_AUDIO,
617 AV_CODEC_ID_ON2AVC,
618 AV_CODEC_ID_DSS_SP,
619
620 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
621 AV_CODEC_ID_SONIC,
622 AV_CODEC_ID_SONIC_LS,
623 AV_CODEC_ID_EVRC,
624 AV_CODEC_ID_SMV,
625 AV_CODEC_ID_DSD_LSBF,
626 AV_CODEC_ID_DSD_MSBF,
627 AV_CODEC_ID_DSD_LSBF_PLANAR,
628 AV_CODEC_ID_DSD_MSBF_PLANAR,
629 AV_CODEC_ID_4GV,
630 AV_CODEC_ID_INTERPLAY_ACM,
631 AV_CODEC_ID_XMA1,
632 AV_CODEC_ID_XMA2,
633 AV_CODEC_ID_DST,
634 AV_CODEC_ID_ATRAC3AL,
635 AV_CODEC_ID_ATRAC3PAL,
636
637 AV_CODEC_ID_DRA = MKBETAG('D','A','R','1'),
638
639 /* subtitle codecs */
640 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
641 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
642 AV_CODEC_ID_DVB_SUBTITLE,
643 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
644 AV_CODEC_ID_XSUB,
645 AV_CODEC_ID_SSA,
646 AV_CODEC_ID_MOV_TEXT,
647 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
648 AV_CODEC_ID_DVB_TELETEXT,
649 AV_CODEC_ID_SRT,
650
651 AV_CODEC_ID_MICRODVD = 0x17800,
652 AV_CODEC_ID_EIA_608,
653 AV_CODEC_ID_JACOSUB,
654 AV_CODEC_ID_SAMI,
655 AV_CODEC_ID_REALTEXT,
656 AV_CODEC_ID_STL,
657 AV_CODEC_ID_SUBVIEWER1,
658 AV_CODEC_ID_SUBVIEWER,
659 AV_CODEC_ID_SUBRIP,
660 AV_CODEC_ID_WEBVTT,
661 AV_CODEC_ID_MPL2,
662 AV_CODEC_ID_VPLAYER,
663 AV_CODEC_ID_PJS,
664 AV_CODEC_ID_ASS,
665 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
666
667 /* other specific kind of codecs (generally used for attachments) */
668 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
669 AV_CODEC_ID_TTF = 0x18000,
670
671 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
672 AV_CODEC_ID_BINTEXT = 0x18800,
673 AV_CODEC_ID_XBIN,
674 AV_CODEC_ID_IDF,
675 AV_CODEC_ID_OTF,
676 AV_CODEC_ID_SMPTE_KLV,
677 AV_CODEC_ID_DVD_NAV,
678 AV_CODEC_ID_TIMED_ID3,
679 AV_CODEC_ID_BIN_DATA,
680
681
682 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
683
684 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
685 * stream (only used by libavformat) */
686 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
687 * stream (only used by libavformat) */
688 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
689 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
690};
691
692/**
693 * This struct describes the properties of a single codec described by an
694 * AVCodecID.
695 * @see avcodec_descriptor_get()
696 */
697typedef struct AVCodecDescriptor {
698 enum AVCodecID id;
699 enum AVMediaType type;
700 /**
701 * Name of the codec described by this descriptor. It is non-empty and
702 * unique for each codec descriptor. It should contain alphanumeric
703 * characters and '_' only.
704 */
705 const char *name;
706 /**
707 * A more descriptive name for this codec. May be NULL.
708 */
709 const char *long_name;
710 /**
711 * Codec properties, a combination of AV_CODEC_PROP_* flags.
712 */
713 int props;
714 /**
715 * MIME type(s) associated with the codec.
716 * May be NULL; if not, a NULL-terminated array of MIME types.
717 * The first item is always non-NULL and is the preferred MIME type.
718 */
719 const char *const *mime_types;
720 /**
721 * If non-NULL, an array of profiles recognized for this codec.
722 * Terminated with FF_PROFILE_UNKNOWN.
723 */
724 const struct AVProfile *profiles;
725} AVCodecDescriptor;
726
727/**
728 * Codec uses only intra compression.
729 * Video codecs only.
730 */
731#define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
732/**
733 * Codec supports lossy compression. Audio and video codecs only.
734 * @note a codec may support both lossy and lossless
735 * compression modes
736 */
737#define AV_CODEC_PROP_LOSSY (1 << 1)
738/**
739 * Codec supports lossless compression. Audio and video codecs only.
740 */
741#define AV_CODEC_PROP_LOSSLESS (1 << 2)
742/**
743 * Codec supports frame reordering. That is, the coded order (the order in which
744 * the encoded packets are output by the encoders / stored / input to the
745 * decoders) may be different from the presentation order of the corresponding
746 * frames.
747 *
748 * For codecs that do not have this property set, PTS and DTS should always be
749 * equal.
750 */
751#define AV_CODEC_PROP_REORDER (1 << 3)
752/**
753 * Subtitle codec is bitmap based
754 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
755 */
756#define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
757/**
758 * Subtitle codec is text based.
759 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
760 */
761#define AV_CODEC_PROP_TEXT_SUB (1 << 17)
762
763/**
764 * @ingroup lavc_decoding
765 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
766 * This is mainly needed because some optimized bitstream readers read
767 * 32 or 64 bit at once and could read over the end.<br>
768 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
769 * MPEG bitstreams could cause overread and segfault.
770 */
771#define AV_INPUT_BUFFER_PADDING_SIZE 32
772
773/**
774 * @ingroup lavc_encoding
775 * minimum encoding buffer size
776 * Used to avoid some checks during header writing.
777 */
778#define AV_INPUT_BUFFER_MIN_SIZE 16384
779
780#if FF_API_WITHOUT_PREFIX
781/**
782 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
783 */
784#define FF_INPUT_BUFFER_PADDING_SIZE 32
785
786/**
787 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
788 */
789#define FF_MIN_BUFFER_SIZE 16384
790#endif /* FF_API_WITHOUT_PREFIX */
791
792/**
793 * @ingroup lavc_encoding
794 * motion estimation type.
795 * @deprecated use codec private option instead
796 */
797#if FF_API_MOTION_EST
798enum Motion_Est_ID {
799 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
800 ME_FULL,
801 ME_LOG,
802 ME_PHODS,
803 ME_EPZS, ///< enhanced predictive zonal search
804 ME_X1, ///< reserved for experiments
805 ME_HEX, ///< hexagon based search
806 ME_UMH, ///< uneven multi-hexagon search
807 ME_TESA, ///< transformed exhaustive search algorithm
808 ME_ITER=50, ///< iterative search
809};
810#endif
811
812/**
813 * @ingroup lavc_decoding
814 */
815enum AVDiscard{
816 /* We leave some space between them for extensions (drop some
817 * keyframes for intra-only or drop just some bidir frames). */
818 AVDISCARD_NONE =-16, ///< discard nothing
819 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
820 AVDISCARD_NONREF = 8, ///< discard all non reference
821 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
822 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
823 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
824 AVDISCARD_ALL = 48, ///< discard all
825};
826
827enum AVAudioServiceType {
828 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
829 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
830 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
831 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
832 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
833 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
834 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
835 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
836 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
837 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
838};
839
840/**
841 * @ingroup lavc_encoding
842 */
843typedef struct RcOverride{
844 int start_frame;
845 int end_frame;
846 int qscale; // If this is 0 then quality_factor will be used instead.
847 float quality_factor;
848} RcOverride;
849
850#if FF_API_MAX_BFRAMES
851/**
852 * @deprecated there is no libavcodec-wide limit on the number of B-frames
853 */
854#define FF_MAX_B_FRAMES 16
855#endif
856
857/* encoding support
858 These flags can be passed in AVCodecContext.flags before initialization.
859 Note: Not everything is supported yet.
860*/
861
862/**
863 * Allow decoders to produce frames with data planes that are not aligned
864 * to CPU requirements (e.g. due to cropping).
865 */
866#define AV_CODEC_FLAG_UNALIGNED (1 << 0)
867/**
868 * Use fixed qscale.
869 */
870#define AV_CODEC_FLAG_QSCALE (1 << 1)
871/**
872 * 4 MV per MB allowed / advanced prediction for H.263.
873 */
874#define AV_CODEC_FLAG_4MV (1 << 2)
875/**
876 * Output even those frames that might be corrupted.
877 */
878#define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
879/**
880 * Use qpel MC.
881 */
882#define AV_CODEC_FLAG_QPEL (1 << 4)
883/**
884 * Use internal 2pass ratecontrol in first pass mode.
885 */
886#define AV_CODEC_FLAG_PASS1 (1 << 9)
887/**
888 * Use internal 2pass ratecontrol in second pass mode.
889 */
890#define AV_CODEC_FLAG_PASS2 (1 << 10)
891/**
892 * loop filter.
893 */
894#define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
895/**
896 * Only decode/encode grayscale.
897 */
898#define AV_CODEC_FLAG_GRAY (1 << 13)
899/**
900 * error[?] variables will be set during encoding.
901 */
902#define AV_CODEC_FLAG_PSNR (1 << 15)
903/**
904 * Input bitstream might be truncated at a random location
905 * instead of only at frame boundaries.
906 */
907#define AV_CODEC_FLAG_TRUNCATED (1 << 16)
908/**
909 * Use interlaced DCT.
910 */
911#define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
912/**
913 * Force low delay.
914 */
915#define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
916/**
917 * Place global headers in extradata instead of every keyframe.
918 */
919#define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
920/**
921 * Use only bitexact stuff (except (I)DCT).
922 */
923#define AV_CODEC_FLAG_BITEXACT (1 << 23)
924/* Fx : Flag for H.263+ extra options */
925/**
926 * H.263 advanced intra coding / MPEG-4 AC prediction
927 */
928#define AV_CODEC_FLAG_AC_PRED (1 << 24)
929/**
930 * interlaced motion estimation
931 */
932#define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
933#define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
934
935/**
936 * Allow non spec compliant speedup tricks.
937 */
938#define AV_CODEC_FLAG2_FAST (1 << 0)
939/**
940 * Skip bitstream encoding.
941 */
942#define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
943/**
944 * Place global headers at every keyframe instead of in extradata.
945 */
946#define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
947
948/**
949 * timecode is in drop frame format. DEPRECATED!!!!
950 */
951#define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
952
953/**
954 * Input bitstream might be truncated at a packet boundaries
955 * instead of only at frame boundaries.
956 */
957#define AV_CODEC_FLAG2_CHUNKS (1 << 15)
958/**
959 * Discard cropping information from SPS.
960 */
961#define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
962
963/**
964 * Show all frames before the first keyframe
965 */
966#define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
967/**
968 * Export motion vectors through frame side data
969 */
970#define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
971/**
972 * Do not skip samples and export skip information as frame side data
973 */
974#define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
975/**
976 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
977 */
978#define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
979
980/* Unsupported options :
981 * Syntax Arithmetic coding (SAC)
982 * Reference Picture Selection
983 * Independent Segment Decoding */
984/* /Fx */
985/* codec capabilities */
986
987/**
988 * Decoder can use draw_horiz_band callback.
989 */
990#define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
991/**
992 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
993 * If not set, it might not use get_buffer() at all or use operations that
994 * assume the buffer was allocated by avcodec_default_get_buffer.
995 */
996#define AV_CODEC_CAP_DR1 (1 << 1)
997#define AV_CODEC_CAP_TRUNCATED (1 << 3)
998/**
999 * Encoder or decoder requires flushing with NULL input at the end in order to
1000 * give the complete and correct output.
1001 *
1002 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1003 * with NULL data. The user can still send NULL data to the public encode
1004 * or decode function, but libavcodec will not pass it along to the codec
1005 * unless this flag is set.
1006 *
1007 * Decoders:
1008 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1009 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1010 * returns frames.
1011 *
1012 * Encoders:
1013 * The encoder needs to be fed with NULL data at the end of encoding until the
1014 * encoder no longer returns data.
1015 *
1016 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1017 * flag also means that the encoder must set the pts and duration for
1018 * each output packet. If this flag is not set, the pts and duration will
1019 * be determined by libavcodec from the input frame.
1020 */
1021#define AV_CODEC_CAP_DELAY (1 << 5)
1022/**
1023 * Codec can be fed a final frame with a smaller size.
1024 * This can be used to prevent truncation of the last audio samples.
1025 */
1026#define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1027
1028#if FF_API_CAP_VDPAU
1029/**
1030 * Codec can export data for HW decoding (VDPAU).
1031 */
1032#define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1033#endif
1034
1035/**
1036 * Codec can output multiple frames per AVPacket
1037 * Normally demuxers return one frame at a time, demuxers which do not do
1038 * are connected to a parser to split what they return into proper frames.
1039 * This flag is reserved to the very rare category of codecs which have a
1040 * bitstream that cannot be split into frames without timeconsuming
1041 * operations like full decoding. Demuxers carrying such bitstreams thus
1042 * may return multiple frames in a packet. This has many disadvantages like
1043 * prohibiting stream copy in many cases thus it should only be considered
1044 * as a last resort.
1045 */
1046#define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1047/**
1048 * Codec is experimental and is thus avoided in favor of non experimental
1049 * encoders
1050 */
1051#define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1052/**
1053 * Codec should fill in channel configuration and samplerate instead of container
1054 */
1055#define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1056/**
1057 * Codec supports frame-level multithreading.
1058 */
1059#define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1060/**
1061 * Codec supports slice-based (or partition-based) multithreading.
1062 */
1063#define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1064/**
1065 * Codec supports changed parameters at any point.
1066 */
1067#define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1068/**
1069 * Codec supports avctx->thread_count == 0 (auto).
1070 */
1071#define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1072/**
1073 * Audio encoder supports receiving a different number of samples in each call.
1074 */
1075#define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1076/**
1077 * Decoder is not a preferred choice for probing.
1078 * This indicates that the decoder is not a good choice for probing.
1079 * It could for example be an expensive to spin up hardware decoder,
1080 * or it could simply not provide a lot of useful information about
1081 * the stream.
1082 * A decoder marked with this flag should only be used as last resort
1083 * choice for probing.
1084 */
1085#define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1086/**
1087 * Codec is intra only.
1088 */
1089#define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1090/**
1091 * Codec is lossless.
1092 */
1093#define AV_CODEC_CAP_LOSSLESS 0x80000000
1094
1095
1096#if FF_API_WITHOUT_PREFIX
1097/**
1098 * Allow decoders to produce frames with data planes that are not aligned
1099 * to CPU requirements (e.g. due to cropping).
1100 */
1101#define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1102#define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1103#define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1104#define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1105#define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1106#if FF_API_GMC
1107/**
1108 * @deprecated use the "gmc" private option of the libxvid encoder
1109 */
1110#define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1111#endif
1112#if FF_API_MV0
1113/**
1114 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1115 * mpegvideo encoders
1116 */
1117#define CODEC_FLAG_MV0 0x0040
1118#endif
1119#if FF_API_INPUT_PRESERVED
1120/**
1121 * @deprecated passing reference-counted frames to the encoders replaces this
1122 * flag
1123 */
1124#define CODEC_FLAG_INPUT_PRESERVED 0x0100
1125#endif
1126#define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1127#define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1128#define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1129#if FF_API_EMU_EDGE
1130/**
1131 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1132 * set.
1133 */
1134#define CODEC_FLAG_EMU_EDGE 0x4000
1135#endif
1136#define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1137#define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1138
1139#if FF_API_NORMALIZE_AQP
1140/**
1141 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1142 * mpegvideo encoders
1143 */
1144#define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1145#endif
1146#define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1147#define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1148#define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1149#define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1150#define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1151#define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1152#define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1153#define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1154#define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1155#define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1156#define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1157#define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1158#define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1159
1160#define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1161#define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1162#define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1163#define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1164
1165/* Unsupported options :
1166 * Syntax Arithmetic coding (SAC)
1167 * Reference Picture Selection
1168 * Independent Segment Decoding */
1169/* /Fx */
1170/* codec capabilities */
1171
1172#define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1173/**
1174 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1175 * If not set, it might not use get_buffer() at all or use operations that
1176 * assume the buffer was allocated by avcodec_default_get_buffer.
1177 */
1178#define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1179#define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1180#if FF_API_XVMC
1181/* Codec can export data for HW decoding. This flag indicates that
1182 * the codec would call get_format() with list that might contain HW accelerated
1183 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1184 * including raw image format.
1185 * The application can use the passed context to determine bitstream version,
1186 * chroma format, resolution etc.
1187 */
1188#define CODEC_CAP_HWACCEL 0x0010
1189#endif /* FF_API_XVMC */
1190/**
1191 * Encoder or decoder requires flushing with NULL input at the end in order to
1192 * give the complete and correct output.
1193 *
1194 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1195 * with NULL data. The user can still send NULL data to the public encode
1196 * or decode function, but libavcodec will not pass it along to the codec
1197 * unless this flag is set.
1198 *
1199 * Decoders:
1200 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1201 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1202 * returns frames.
1203 *
1204 * Encoders:
1205 * The encoder needs to be fed with NULL data at the end of encoding until the
1206 * encoder no longer returns data.
1207 *
1208 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1209 * flag also means that the encoder must set the pts and duration for
1210 * each output packet. If this flag is not set, the pts and duration will
1211 * be determined by libavcodec from the input frame.
1212 */
1213#define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1214/**
1215 * Codec can be fed a final frame with a smaller size.
1216 * This can be used to prevent truncation of the last audio samples.
1217 */
1218#define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1219#if FF_API_CAP_VDPAU
1220/**
1221 * Codec can export data for HW decoding (VDPAU).
1222 */
1223#define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1224#endif
1225/**
1226 * Codec can output multiple frames per AVPacket
1227 * Normally demuxers return one frame at a time, demuxers which do not do
1228 * are connected to a parser to split what they return into proper frames.
1229 * This flag is reserved to the very rare category of codecs which have a
1230 * bitstream that cannot be split into frames without timeconsuming
1231 * operations like full decoding. Demuxers carrying such bitstreams thus
1232 * may return multiple frames in a packet. This has many disadvantages like
1233 * prohibiting stream copy in many cases thus it should only be considered
1234 * as a last resort.
1235 */
1236#define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1237/**
1238 * Codec is experimental and is thus avoided in favor of non experimental
1239 * encoders
1240 */
1241#define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1242/**
1243 * Codec should fill in channel configuration and samplerate instead of container
1244 */
1245#define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1246#if FF_API_NEG_LINESIZES
1247/**
1248 * @deprecated no codecs use this capability
1249 */
1250#define CODEC_CAP_NEG_LINESIZES 0x0800
1251#endif
1252/**
1253 * Codec supports frame-level multithreading.
1254 */
1255#define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1256/**
1257 * Codec supports slice-based (or partition-based) multithreading.
1258 */
1259#define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1260/**
1261 * Codec supports changed parameters at any point.
1262 */
1263#define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1264/**
1265 * Codec supports avctx->thread_count == 0 (auto).
1266 */
1267#define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1268/**
1269 * Audio encoder supports receiving a different number of samples in each call.
1270 */
1271#define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1272/**
1273 * Codec is intra only.
1274 */
1275#define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1276/**
1277 * Codec is lossless.
1278 */
1279#define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1280
1281/**
1282 * HWAccel is experimental and is thus avoided in favor of non experimental
1283 * codecs
1284 */
1285#define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1286#endif /* FF_API_WITHOUT_PREFIX */
1287
1288#if FF_API_MB_TYPE
1289//The following defines may change, don't expect compatibility if you use them.
1290#define MB_TYPE_INTRA4x4 0x0001
1291#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1292#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1293#define MB_TYPE_16x16 0x0008
1294#define MB_TYPE_16x8 0x0010
1295#define MB_TYPE_8x16 0x0020
1296#define MB_TYPE_8x8 0x0040
1297#define MB_TYPE_INTERLACED 0x0080
1298#define MB_TYPE_DIRECT2 0x0100 //FIXME
1299#define MB_TYPE_ACPRED 0x0200
1300#define MB_TYPE_GMC 0x0400
1301#define MB_TYPE_SKIP 0x0800
1302#define MB_TYPE_P0L0 0x1000
1303#define MB_TYPE_P1L0 0x2000
1304#define MB_TYPE_P0L1 0x4000
1305#define MB_TYPE_P1L1 0x8000
1306#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1307#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1308#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1309#define MB_TYPE_QUANT 0x00010000
1310#define MB_TYPE_CBP 0x00020000
1311// Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1312#endif
1313
1314/**
1315 * Pan Scan area.
1316 * This specifies the area which should be displayed.
1317 * Note there may be multiple such areas for one frame.
1318 */
1319typedef struct AVPanScan{
1320 /**
1321 * id
1322 * - encoding: Set by user.
1323 * - decoding: Set by libavcodec.
1324 */
1325 int id;
1326
1327 /**
1328 * width and height in 1/16 pel
1329 * - encoding: Set by user.
1330 * - decoding: Set by libavcodec.
1331 */
1332 int width;
1333 int height;
1334
1335 /**
1336 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1337 * - encoding: Set by user.
1338 * - decoding: Set by libavcodec.
1339 */
1340 int16_t position[3][2];
1341}AVPanScan;
1342
1343/**
1344 * This structure describes the bitrate properties of an encoded bitstream. It
1345 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1346 * parameters for H.264/HEVC.
1347 */
1348typedef struct AVCPBProperties {
1349 /**
1350 * Maximum bitrate of the stream, in bits per second.
1351 * Zero if unknown or unspecified.
1352 */
1353 int max_bitrate;
1354 /**
1355 * Minimum bitrate of the stream, in bits per second.
1356 * Zero if unknown or unspecified.
1357 */
1358 int min_bitrate;
1359 /**
1360 * Average bitrate of the stream, in bits per second.
1361 * Zero if unknown or unspecified.
1362 */
1363 int avg_bitrate;
1364
1365 /**
1366 * The size of the buffer to which the ratecontrol is applied, in bits.
1367 * Zero if unknown or unspecified.
1368 */
1369 int buffer_size;
1370
1371 /**
1372 * The delay between the time the packet this structure is associated with
1373 * is received and the time when it should be decoded, in periods of a 27MHz
1374 * clock.
1375 *
1376 * UINT64_MAX when unknown or unspecified.
1377 */
1378 uint64_t vbv_delay;
1379} AVCPBProperties;
1380
1381#if FF_API_QSCALE_TYPE
1382#define FF_QSCALE_TYPE_MPEG1 0
1383#define FF_QSCALE_TYPE_MPEG2 1
1384#define FF_QSCALE_TYPE_H264 2
1385#define FF_QSCALE_TYPE_VP56 3
1386#endif
1387
1388/**
1389 * The decoder will keep a reference to the frame and may reuse it later.
1390 */
1391#define AV_GET_BUFFER_FLAG_REF (1 << 0)
1392
1393/**
1394 * @defgroup lavc_packet AVPacket
1395 *
1396 * Types and functions for working with AVPacket.
1397 * @{
1398 */
1399enum AVPacketSideDataType {
1400 /**
1401 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1402 * bytes worth of palette. This side data signals that a new palette is
1403 * present.
1404 */
1405 AV_PKT_DATA_PALETTE,
1406
1407 /**
1408 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1409 * that the extradata buffer was changed and the receiving side should
1410 * act upon it appropriately. The new extradata is embedded in the side
1411 * data buffer and should be immediately used for processing the current
1412 * frame or packet.
1413 */
1414 AV_PKT_DATA_NEW_EXTRADATA,
1415
1416 /**
1417 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1418 * @code
1419 * u32le param_flags
1420 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1421 * s32le channel_count
1422 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1423 * u64le channel_layout
1424 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1425 * s32le sample_rate
1426 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1427 * s32le width
1428 * s32le height
1429 * @endcode
1430 */
1431 AV_PKT_DATA_PARAM_CHANGE,
1432
1433 /**
1434 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1435 * structures with info about macroblocks relevant to splitting the
1436 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1437 * That is, it does not necessarily contain info about all macroblocks,
1438 * as long as the distance between macroblocks in the info is smaller
1439 * than the target payload size.
1440 * Each MB info structure is 12 bytes, and is laid out as follows:
1441 * @code
1442 * u32le bit offset from the start of the packet
1443 * u8 current quantizer at the start of the macroblock
1444 * u8 GOB number
1445 * u16le macroblock address within the GOB
1446 * u8 horizontal MV predictor
1447 * u8 vertical MV predictor
1448 * u8 horizontal MV predictor for block number 3
1449 * u8 vertical MV predictor for block number 3
1450 * @endcode
1451 */
1452 AV_PKT_DATA_H263_MB_INFO,
1453
1454 /**
1455 * This side data should be associated with an audio stream and contains
1456 * ReplayGain information in form of the AVReplayGain struct.
1457 */
1458 AV_PKT_DATA_REPLAYGAIN,
1459
1460 /**
1461 * This side data contains a 3x3 transformation matrix describing an affine
1462 * transformation that needs to be applied to the decoded video frames for
1463 * correct presentation.
1464 *
1465 * See libavutil/display.h for a detailed description of the data.
1466 */
1467 AV_PKT_DATA_DISPLAYMATRIX,
1468
1469 /**
1470 * This side data should be associated with a video stream and contains
1471 * Stereoscopic 3D information in form of the AVStereo3D struct.
1472 */
1473 AV_PKT_DATA_STEREO3D,
1474
1475 /**
1476 * This side data should be associated with an audio stream and corresponds
1477 * to enum AVAudioServiceType.
1478 */
1479 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1480
1481 /**
1482 * This side data contains quality related information from the encoder.
1483 * @code
1484 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1485 * u8 picture type
1486 * u8 error count
1487 * u16 reserved
1488 * u64le[error count] sum of squared differences between encoder in and output
1489 * @endcode
1490 */
1491 AV_PKT_DATA_QUALITY_STATS,
1492
1493 /**
1494 * This side data contains an integer value representing the stream index
1495 * of a "fallback" track. A fallback track indicates an alternate
1496 * track to use when the current track can not be decoded for some reason.
1497 * e.g. no decoder available for codec.
1498 */
1499 AV_PKT_DATA_FALLBACK_TRACK,
1500
1501 /**
1502 * This side data corresponds to the AVCPBProperties struct.
1503 */
1504 AV_PKT_DATA_CPB_PROPERTIES,
1505
1506 /**
1507 * Recommmends skipping the specified number of samples
1508 * @code
1509 * u32le number of samples to skip from start of this packet
1510 * u32le number of samples to skip from end of this packet
1511 * u8 reason for start skip
1512 * u8 reason for end skip (0=padding silence, 1=convergence)
1513 * @endcode
1514 */
1515 AV_PKT_DATA_SKIP_SAMPLES=70,
1516
1517 /**
1518 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1519 * the packet may contain "dual mono" audio specific to Japanese DTV
1520 * and if it is true, recommends only the selected channel to be used.
1521 * @code
1522 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1523 * @endcode
1524 */
1525 AV_PKT_DATA_JP_DUALMONO,
1526
1527 /**
1528 * A list of zero terminated key/value strings. There is no end marker for
1529 * the list, so it is required to rely on the side data size to stop.
1530 */
1531 AV_PKT_DATA_STRINGS_METADATA,
1532
1533 /**
1534 * Subtitle event position
1535 * @code
1536 * u32le x1
1537 * u32le y1
1538 * u32le x2
1539 * u32le y2
1540 * @endcode
1541 */
1542 AV_PKT_DATA_SUBTITLE_POSITION,
1543
1544 /**
1545 * Data found in BlockAdditional element of matroska container. There is
1546 * no end marker for the data, so it is required to rely on the side data
1547 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1548 * by data.
1549 */
1550 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1551
1552 /**
1553 * The optional first identifier line of a WebVTT cue.
1554 */
1555 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1556
1557 /**
1558 * The optional settings (rendering instructions) that immediately
1559 * follow the timestamp specifier of a WebVTT cue.
1560 */
1561 AV_PKT_DATA_WEBVTT_SETTINGS,
1562
1563 /**
1564 * A list of zero terminated key/value strings. There is no end marker for
1565 * the list, so it is required to rely on the side data size to stop. This
1566 * side data includes updated metadata which appeared in the stream.
1567 */
1568 AV_PKT_DATA_METADATA_UPDATE,
1569
1570 /**
1571 * MPEGTS stream ID, this is required to pass the stream ID
1572 * information from the demuxer to the corresponding muxer.
1573 */
1574 AV_PKT_DATA_MPEGTS_STREAM_ID,
1575
1576 /**
1577 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1578 * should be associated with a video stream and containts data in the form
1579 * of the AVMasteringDisplayMetadata struct.
1580 */
1581 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1582
1583 /**
1584 * This side data should be associated with a video stream and corresponds
1585 * to the AVSphericalMapping structure.
1586 */
1587 AV_PKT_DATA_SPHERICAL,
1588};
1589
1590#define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1591
1592typedef struct AVPacketSideData {
1593 uint8_t *data;
1594 int size;
1595 enum AVPacketSideDataType type;
1596} AVPacketSideData;
1597
1598/**
1599 * This structure stores compressed data. It is typically exported by demuxers
1600 * and then passed as input to decoders, or received as output from encoders and
1601 * then passed to muxers.
1602 *
1603 * For video, it should typically contain one compressed frame. For audio it may
1604 * contain several compressed frames. Encoders are allowed to output empty
1605 * packets, with no compressed data, containing only side data
1606 * (e.g. to update some stream parameters at the end of encoding).
1607 *
1608 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1609 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1610 * without libavcodec and libavformat major bump.
1611 *
1612 * The semantics of data ownership depends on the buf field.
1613 * If it is set, the packet data is dynamically allocated and is
1614 * valid indefinitely until a call to av_packet_unref() reduces the
1615 * reference count to 0.
1616 *
1617 * If the buf field is not set av_packet_ref() would make a copy instead
1618 * of increasing the reference count.
1619 *
1620 * The side data is always allocated with av_malloc(), copied by
1621 * av_packet_ref() and freed by av_packet_unref().
1622 *
1623 * @see av_packet_ref
1624 * @see av_packet_unref
1625 */
1626typedef struct AVPacket {
1627 /**
1628 * A reference to the reference-counted buffer where the packet data is
1629 * stored.
1630 * May be NULL, then the packet data is not reference-counted.
1631 */
1632 AVBufferRef *buf;
1633 /**
1634 * Presentation timestamp in AVStream->time_base units; the time at which
1635 * the decompressed packet will be presented to the user.
1636 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1637 * pts MUST be larger or equal to dts as presentation cannot happen before
1638 * decompression, unless one wants to view hex dumps. Some formats misuse
1639 * the terms dts and pts/cts to mean something different. Such timestamps
1640 * must be converted to true pts/dts before they are stored in AVPacket.
1641 */
1642 int64_t pts;
1643 /**
1644 * Decompression timestamp in AVStream->time_base units; the time at which
1645 * the packet is decompressed.
1646 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1647 */
1648 int64_t dts;
1649 uint8_t *data;
1650 int size;
1651 int stream_index;
1652 /**
1653 * A combination of AV_PKT_FLAG values
1654 */
1655 int flags;
1656 /**
1657 * Additional packet data that can be provided by the container.
1658 * Packet can contain several types of side information.
1659 */
1660 AVPacketSideData *side_data;
1661 int side_data_elems;
1662
1663 /**
1664 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1665 * Equals next_pts - this_pts in presentation order.
1666 */
1667 int64_t duration;
1668
1669 int64_t pos; ///< byte position in stream, -1 if unknown
1670
1671#if FF_API_CONVERGENCE_DURATION
1672 /**
1673 * @deprecated Same as the duration field, but as int64_t. This was required
1674 * for Matroska subtitles, whose duration values could overflow when the
1675 * duration field was still an int.
1676 */
1677 attribute_deprecated
1678 int64_t convergence_duration;
1679#endif
1680} AVPacket;
1681#define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1682#define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1683/**
1684 * Flag is used to discard packets which are required to maintain valid
1685 * decoder state but are not required for output and should be dropped
1686 * after decoding.
1687 **/
1688#define AV_PKT_FLAG_DISCARD 0x0004
1689
1690enum AVSideDataParamChangeFlags {
1691 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1692 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1693 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1694 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1695};
1696/**
1697 * @}
1698 */
1699
1700struct AVCodecInternal;
1701
1702enum AVFieldOrder {
1703 AV_FIELD_UNKNOWN,
1704 AV_FIELD_PROGRESSIVE,
1705 AV_FIELD_TT, //< Top coded_first, top displayed first
1706 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1707 AV_FIELD_TB, //< Top coded first, bottom displayed first
1708 AV_FIELD_BT, //< Bottom coded first, top displayed first
1709};
1710
1711/**
1712 * main external API structure.
1713 * New fields can be added to the end with minor version bumps.
1714 * Removal, reordering and changes to existing fields require a major
1715 * version bump.
1716 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1717 * applications.
1718 * The name string for AVOptions options matches the associated command line
1719 * parameter name and can be found in libavcodec/options_table.h
1720 * The AVOption/command line parameter names differ in some cases from the C
1721 * structure field names for historic reasons or brevity.
1722 * sizeof(AVCodecContext) must not be used outside libav*.
1723 */
1724typedef struct AVCodecContext {
1725 /**
1726 * information on struct for av_log
1727 * - set by avcodec_alloc_context3
1728 */
1729 const AVClass *av_class;
1730 int log_level_offset;
1731
1732 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1733 const struct AVCodec *codec;
1734#if FF_API_CODEC_NAME
1735 /**
1736 * @deprecated this field is not used for anything in libavcodec
1737 */
1738 attribute_deprecated
1739 char codec_name[32];
1740#endif
1741 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1742
1743 /**
1744 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1745 * This is used to work around some encoder bugs.
1746 * A demuxer should set this to what is stored in the field used to identify the codec.
1747 * If there are multiple such fields in a container then the demuxer should choose the one
1748 * which maximizes the information about the used codec.
1749 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1750 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1751 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1752 * first.
1753 * - encoding: Set by user, if not then the default based on codec_id will be used.
1754 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1755 */
1756 unsigned int codec_tag;
1757
1758#if FF_API_STREAM_CODEC_TAG
1759 /**
1760 * @deprecated this field is unused
1761 */
1762 attribute_deprecated
1763 unsigned int stream_codec_tag;
1764#endif
1765
1766 void *priv_data;
1767
1768 /**
1769 * Private context used for internal data.
1770 *
1771 * Unlike priv_data, this is not codec-specific. It is used in general
1772 * libavcodec functions.
1773 */
1774 struct AVCodecInternal *internal;
1775
1776 /**
1777 * Private data of the user, can be used to carry app specific stuff.
1778 * - encoding: Set by user.
1779 * - decoding: Set by user.
1780 */
1781 void *opaque;
1782
1783 /**
1784 * the average bitrate
1785 * - encoding: Set by user; unused for constant quantizer encoding.
1786 * - decoding: Set by user, may be overwritten by libavcodec
1787 * if this info is available in the stream
1788 */
1789 int64_t bit_rate;
1790
1791 /**
1792 * number of bits the bitstream is allowed to diverge from the reference.
1793 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1794 * - encoding: Set by user; unused for constant quantizer encoding.
1795 * - decoding: unused
1796 */
1797 int bit_rate_tolerance;
1798
1799 /**
1800 * Global quality for codecs which cannot change it per frame.
1801 * This should be proportional to MPEG-1/2/4 qscale.
1802 * - encoding: Set by user.
1803 * - decoding: unused
1804 */
1805 int global_quality;
1806
1807 /**
1808 * - encoding: Set by user.
1809 * - decoding: unused
1810 */
1811 int compression_level;
1812#define FF_COMPRESSION_DEFAULT -1
1813
1814 /**
1815 * AV_CODEC_FLAG_*.
1816 * - encoding: Set by user.
1817 * - decoding: Set by user.
1818 */
1819 int flags;
1820
1821 /**
1822 * AV_CODEC_FLAG2_*
1823 * - encoding: Set by user.
1824 * - decoding: Set by user.
1825 */
1826 int flags2;
1827
1828 /**
1829 * some codecs need / can use extradata like Huffman tables.
1830 * MJPEG: Huffman tables
1831 * rv10: additional flags
1832 * MPEG-4: global headers (they can be in the bitstream or here)
1833 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1834 * than extradata_size to avoid problems if it is read with the bitstream reader.
1835 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1836 * - encoding: Set/allocated/freed by libavcodec.
1837 * - decoding: Set/allocated/freed by user.
1838 */
1839 uint8_t *extradata;
1840 int extradata_size;
1841
1842 /**
1843 * This is the fundamental unit of time (in seconds) in terms
1844 * of which frame timestamps are represented. For fixed-fps content,
1845 * timebase should be 1/framerate and timestamp increments should be
1846 * identically 1.
1847 * This often, but not always is the inverse of the frame rate or field rate
1848 * for video. 1/time_base is not the average frame rate if the frame rate is not
1849 * constant.
1850 *
1851 * Like containers, elementary streams also can store timestamps, 1/time_base
1852 * is the unit in which these timestamps are specified.
1853 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1854 * vop_time_increment_resolution and fixed_vop_rate
1855 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1856 *
1857 * - encoding: MUST be set by user.
1858 * - decoding: the use of this field for decoding is deprecated.
1859 * Use framerate instead.
1860 */
1861 AVRational time_base;
1862
1863 /**
1864 * For some codecs, the time base is closer to the field rate than the frame rate.
1865 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1866 * if no telecine is used ...
1867 *
1868 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1869 */
1870 int ticks_per_frame;
1871
1872 /**
1873 * Codec delay.
1874 *
1875 * Encoding: Number of frames delay there will be from the encoder input to
1876 * the decoder output. (we assume the decoder matches the spec)
1877 * Decoding: Number of frames delay in addition to what a standard decoder
1878 * as specified in the spec would produce.
1879 *
1880 * Video:
1881 * Number of frames the decoded output will be delayed relative to the
1882 * encoded input.
1883 *
1884 * Audio:
1885 * For encoding, this field is unused (see initial_padding).
1886 *
1887 * For decoding, this is the number of samples the decoder needs to
1888 * output before the decoder's output is valid. When seeking, you should
1889 * start decoding this many samples prior to your desired seek point.
1890 *
1891 * - encoding: Set by libavcodec.
1892 * - decoding: Set by libavcodec.
1893 */
1894 int delay;
1895
1896
1897 /* video only */
1898 /**
1899 * picture width / height.
1900 *
1901 * @note Those fields may not match the values of the last
1902 * AVFrame output by avcodec_decode_video2 due frame
1903 * reordering.
1904 *
1905 * - encoding: MUST be set by user.
1906 * - decoding: May be set by the user before opening the decoder if known e.g.
1907 * from the container. Some decoders will require the dimensions
1908 * to be set by the caller. During decoding, the decoder may
1909 * overwrite those values as required while parsing the data.
1910 */
1911 int width, height;
1912
1913 /**
1914 * Bitstream width / height, may be different from width/height e.g. when
1915 * the decoded frame is cropped before being output or lowres is enabled.
1916 *
1917 * @note Those field may not match the value of the last
1918 * AVFrame output by avcodec_receive_frame() due frame
1919 * reordering.
1920 *
1921 * - encoding: unused
1922 * - decoding: May be set by the user before opening the decoder if known
1923 * e.g. from the container. During decoding, the decoder may
1924 * overwrite those values as required while parsing the data.
1925 */
1926 int coded_width, coded_height;
1927
1928#if FF_API_ASPECT_EXTENDED
1929#define FF_ASPECT_EXTENDED 15
1930#endif
1931
1932 /**
1933 * the number of pictures in a group of pictures, or 0 for intra_only
1934 * - encoding: Set by user.
1935 * - decoding: unused
1936 */
1937 int gop_size;
1938
1939 /**
1940 * Pixel format, see AV_PIX_FMT_xxx.
1941 * May be set by the demuxer if known from headers.
1942 * May be overridden by the decoder if it knows better.
1943 *
1944 * @note This field may not match the value of the last
1945 * AVFrame output by avcodec_receive_frame() due frame
1946 * reordering.
1947 *
1948 * - encoding: Set by user.
1949 * - decoding: Set by user if known, overridden by libavcodec while
1950 * parsing the data.
1951 */
1952 enum AVPixelFormat pix_fmt;
1953
1954#if FF_API_MOTION_EST
1955 /**
1956 * This option does nothing
1957 * @deprecated use codec private options instead
1958 */
1959 attribute_deprecated int me_method;
1960#endif
1961
1962 /**
1963 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1964 * decoder to draw a horizontal band. It improves cache usage. Not
1965 * all codecs can do that. You must check the codec capabilities
1966 * beforehand.
1967 * When multithreading is used, it may be called from multiple threads
1968 * at the same time; threads might draw different parts of the same AVFrame,
1969 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1970 * in order.
1971 * The function is also used by hardware acceleration APIs.
1972 * It is called at least once during frame decoding to pass
1973 * the data needed for hardware render.
1974 * In that mode instead of pixel data, AVFrame points to
1975 * a structure specific to the acceleration API. The application
1976 * reads the structure and can change some fields to indicate progress
1977 * or mark state.
1978 * - encoding: unused
1979 * - decoding: Set by user.
1980 * @param height the height of the slice
1981 * @param y the y position of the slice
1982 * @param type 1->top field, 2->bottom field, 3->frame
1983 * @param offset offset into the AVFrame.data from which the slice should be read
1984 */
1985 void (*draw_horiz_band)(struct AVCodecContext *s,
1986 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1987 int y, int type, int height);
1988
1989 /**
1990 * callback to negotiate the pixelFormat
1991 * @param fmt is the list of formats which are supported by the codec,
1992 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1993 * The first is always the native one.
1994 * @note The callback may be called again immediately if initialization for
1995 * the selected (hardware-accelerated) pixel format failed.
1996 * @warning Behavior is undefined if the callback returns a value not
1997 * in the fmt list of formats.
1998 * @return the chosen format
1999 * - encoding: unused
2000 * - decoding: Set by user, if not set the native format will be chosen.
2001 */
2002 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2003
2004 /**
2005 * maximum number of B-frames between non-B-frames
2006 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2007 * - encoding: Set by user.
2008 * - decoding: unused
2009 */
2010 int max_b_frames;
2011
2012 /**
2013 * qscale factor between IP and B-frames
2014 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2015 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2016 * - encoding: Set by user.
2017 * - decoding: unused
2018 */
2019 float b_quant_factor;
2020
2021#if FF_API_RC_STRATEGY
2022 /** @deprecated use codec private option instead */
2023 attribute_deprecated int rc_strategy;
2024#define FF_RC_STRATEGY_XVID 1
2025#endif
2026
2027#if FF_API_PRIVATE_OPT
2028 /** @deprecated use encoder private options instead */
2029 attribute_deprecated
2030 int b_frame_strategy;
2031#endif
2032
2033 /**
2034 * qscale offset between IP and B-frames
2035 * - encoding: Set by user.
2036 * - decoding: unused
2037 */
2038 float b_quant_offset;
2039
2040 /**
2041 * Size of the frame reordering buffer in the decoder.
2042 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2043 * - encoding: Set by libavcodec.
2044 * - decoding: Set by libavcodec.
2045 */
2046 int has_b_frames;
2047
2048#if FF_API_PRIVATE_OPT
2049 /** @deprecated use encoder private options instead */
2050 attribute_deprecated
2051 int mpeg_quant;
2052#endif
2053
2054 /**
2055 * qscale factor between P- and I-frames
2056 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2057 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2058 * - encoding: Set by user.
2059 * - decoding: unused
2060 */
2061 float i_quant_factor;
2062
2063 /**
2064 * qscale offset between P and I-frames
2065 * - encoding: Set by user.
2066 * - decoding: unused
2067 */
2068 float i_quant_offset;
2069
2070 /**
2071 * luminance masking (0-> disabled)
2072 * - encoding: Set by user.
2073 * - decoding: unused
2074 */
2075 float lumi_masking;
2076
2077 /**
2078 * temporary complexity masking (0-> disabled)
2079 * - encoding: Set by user.
2080 * - decoding: unused
2081 */
2082 float temporal_cplx_masking;
2083
2084 /**
2085 * spatial complexity masking (0-> disabled)
2086 * - encoding: Set by user.
2087 * - decoding: unused
2088 */
2089 float spatial_cplx_masking;
2090
2091 /**
2092 * p block masking (0-> disabled)
2093 * - encoding: Set by user.
2094 * - decoding: unused
2095 */
2096 float p_masking;
2097
2098 /**
2099 * darkness masking (0-> disabled)
2100 * - encoding: Set by user.
2101 * - decoding: unused
2102 */
2103 float dark_masking;
2104
2105 /**
2106 * slice count
2107 * - encoding: Set by libavcodec.
2108 * - decoding: Set by user (or 0).
2109 */
2110 int slice_count;
2111
2112#if FF_API_PRIVATE_OPT
2113 /** @deprecated use encoder private options instead */
2114 attribute_deprecated
2115 int prediction_method;
2116#define FF_PRED_LEFT 0
2117#define FF_PRED_PLANE 1
2118#define FF_PRED_MEDIAN 2
2119#endif
2120
2121 /**
2122 * slice offsets in the frame in bytes
2123 * - encoding: Set/allocated by libavcodec.
2124 * - decoding: Set/allocated by user (or NULL).
2125 */
2126 int *slice_offset;
2127
2128 /**
2129 * sample aspect ratio (0 if unknown)
2130 * That is the width of a pixel divided by the height of the pixel.
2131 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2132 * - encoding: Set by user.
2133 * - decoding: Set by libavcodec.
2134 */
2135 AVRational sample_aspect_ratio;
2136
2137 /**
2138 * motion estimation comparison function
2139 * - encoding: Set by user.
2140 * - decoding: unused
2141 */
2142 int me_cmp;
2143 /**
2144 * subpixel motion estimation comparison function
2145 * - encoding: Set by user.
2146 * - decoding: unused
2147 */
2148 int me_sub_cmp;
2149 /**
2150 * macroblock comparison function (not supported yet)
2151 * - encoding: Set by user.
2152 * - decoding: unused
2153 */
2154 int mb_cmp;
2155 /**
2156 * interlaced DCT comparison function
2157 * - encoding: Set by user.
2158 * - decoding: unused
2159 */
2160 int ildct_cmp;
2161#define FF_CMP_SAD 0
2162#define FF_CMP_SSE 1
2163#define FF_CMP_SATD 2
2164#define FF_CMP_DCT 3
2165#define FF_CMP_PSNR 4
2166#define FF_CMP_BIT 5
2167#define FF_CMP_RD 6
2168#define FF_CMP_ZERO 7
2169#define FF_CMP_VSAD 8
2170#define FF_CMP_VSSE 9
2171#define FF_CMP_NSSE 10
2172#define FF_CMP_W53 11
2173#define FF_CMP_W97 12
2174#define FF_CMP_DCTMAX 13
2175#define FF_CMP_DCT264 14
2176#define FF_CMP_MEDIAN_SAD 15
2177#define FF_CMP_CHROMA 256
2178
2179 /**
2180 * ME diamond size & shape
2181 * - encoding: Set by user.
2182 * - decoding: unused
2183 */
2184 int dia_size;
2185
2186 /**
2187 * amount of previous MV predictors (2a+1 x 2a+1 square)
2188 * - encoding: Set by user.
2189 * - decoding: unused
2190 */
2191 int last_predictor_count;
2192
2193#if FF_API_PRIVATE_OPT
2194 /** @deprecated use encoder private options instead */
2195 attribute_deprecated
2196 int pre_me;
2197#endif
2198
2199 /**
2200 * motion estimation prepass comparison function
2201 * - encoding: Set by user.
2202 * - decoding: unused
2203 */
2204 int me_pre_cmp;
2205
2206 /**
2207 * ME prepass diamond size & shape
2208 * - encoding: Set by user.
2209 * - decoding: unused
2210 */
2211 int pre_dia_size;
2212
2213 /**
2214 * subpel ME quality
2215 * - encoding: Set by user.
2216 * - decoding: unused
2217 */
2218 int me_subpel_quality;
2219
2220#if FF_API_AFD
2221 /**
2222 * DTG active format information (additional aspect ratio
2223 * information only used in DVB MPEG-2 transport streams)
2224 * 0 if not set.
2225 *
2226 * - encoding: unused
2227 * - decoding: Set by decoder.
2228 * @deprecated Deprecated in favor of AVSideData
2229 */
2230 attribute_deprecated int dtg_active_format;
2231#define FF_DTG_AFD_SAME 8
2232#define FF_DTG_AFD_4_3 9
2233#define FF_DTG_AFD_16_9 10
2234#define FF_DTG_AFD_14_9 11
2235#define FF_DTG_AFD_4_3_SP_14_9 13
2236#define FF_DTG_AFD_16_9_SP_14_9 14
2237#define FF_DTG_AFD_SP_4_3 15
2238#endif /* FF_API_AFD */
2239
2240 /**
2241 * maximum motion estimation search range in subpel units
2242 * If 0 then no limit.
2243 *
2244 * - encoding: Set by user.
2245 * - decoding: unused
2246 */
2247 int me_range;
2248
2249#if FF_API_QUANT_BIAS
2250 /**
2251 * @deprecated use encoder private option instead
2252 */
2253 attribute_deprecated int intra_quant_bias;
2254#define FF_DEFAULT_QUANT_BIAS 999999
2255
2256 /**
2257 * @deprecated use encoder private option instead
2258 */
2259 attribute_deprecated int inter_quant_bias;
2260#endif
2261
2262 /**
2263 * slice flags
2264 * - encoding: unused
2265 * - decoding: Set by user.
2266 */
2267 int slice_flags;
2268#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2269#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2270#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2271
2272#if FF_API_XVMC
2273 /**
2274 * XVideo Motion Acceleration
2275 * - encoding: forbidden
2276 * - decoding: set by decoder
2277 * @deprecated XvMC doesn't need it anymore.
2278 */
2279 attribute_deprecated int xvmc_acceleration;
2280#endif /* FF_API_XVMC */
2281
2282 /**
2283 * macroblock decision mode
2284 * - encoding: Set by user.
2285 * - decoding: unused
2286 */
2287 int mb_decision;
2288#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2289#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2290#define FF_MB_DECISION_RD 2 ///< rate distortion
2291
2292 /**
2293 * custom intra quantization matrix
2294 * - encoding: Set by user, can be NULL.
2295 * - decoding: Set by libavcodec.
2296 */
2297 uint16_t *intra_matrix;
2298
2299 /**
2300 * custom inter quantization matrix
2301 * - encoding: Set by user, can be NULL.
2302 * - decoding: Set by libavcodec.
2303 */
2304 uint16_t *inter_matrix;
2305
2306#if FF_API_PRIVATE_OPT
2307 /** @deprecated use encoder private options instead */
2308 attribute_deprecated
2309 int scenechange_threshold;
2310
2311 /** @deprecated use encoder private options instead */
2312 attribute_deprecated
2313 int noise_reduction;
2314#endif
2315
2316#if FF_API_MPV_OPT
2317 /**
2318 * @deprecated this field is unused
2319 */
2320 attribute_deprecated
2321 int me_threshold;
2322
2323 /**
2324 * @deprecated this field is unused
2325 */
2326 attribute_deprecated
2327 int mb_threshold;
2328#endif
2329
2330 /**
2331 * precision of the intra DC coefficient - 8
2332 * - encoding: Set by user.
2333 * - decoding: Set by libavcodec
2334 */
2335 int intra_dc_precision;
2336
2337 /**
2338 * Number of macroblock rows at the top which are skipped.
2339 * - encoding: unused
2340 * - decoding: Set by user.
2341 */
2342 int skip_top;
2343
2344 /**
2345 * Number of macroblock rows at the bottom which are skipped.
2346 * - encoding: unused
2347 * - decoding: Set by user.
2348 */
2349 int skip_bottom;
2350
2351#if FF_API_MPV_OPT
2352 /**
2353 * @deprecated use encoder private options instead
2354 */
2355 attribute_deprecated
2356 float border_masking;
2357#endif
2358
2359 /**
2360 * minimum MB Lagrange multiplier
2361 * - encoding: Set by user.
2362 * - decoding: unused
2363 */
2364 int mb_lmin;
2365
2366 /**
2367 * maximum MB Lagrange multiplier
2368 * - encoding: Set by user.
2369 * - decoding: unused
2370 */
2371 int mb_lmax;
2372
2373#if FF_API_PRIVATE_OPT
2374 /**
2375 * @deprecated use encoder private options instead
2376 */
2377 attribute_deprecated
2378 int me_penalty_compensation;
2379#endif
2380
2381 /**
2382 * - encoding: Set by user.
2383 * - decoding: unused
2384 */
2385 int bidir_refine;
2386
2387#if FF_API_PRIVATE_OPT
2388 /** @deprecated use encoder private options instead */
2389 attribute_deprecated
2390 int brd_scale;
2391#endif
2392
2393 /**
2394 * minimum GOP size
2395 * - encoding: Set by user.
2396 * - decoding: unused
2397 */
2398 int keyint_min;
2399
2400 /**
2401 * number of reference frames
2402 * - encoding: Set by user.
2403 * - decoding: Set by lavc.
2404 */
2405 int refs;
2406
2407#if FF_API_PRIVATE_OPT
2408 /** @deprecated use encoder private options instead */
2409 attribute_deprecated
2410 int chromaoffset;
2411#endif
2412
2413#if FF_API_UNUSED_MEMBERS
2414 /**
2415 * Multiplied by qscale for each frame and added to scene_change_score.
2416 * - encoding: Set by user.
2417 * - decoding: unused
2418 */
2419 attribute_deprecated int scenechange_factor;
2420#endif
2421
2422 /**
2423 * Note: Value depends upon the compare function used for fullpel ME.
2424 * - encoding: Set by user.
2425 * - decoding: unused
2426 */
2427 int mv0_threshold;
2428
2429#if FF_API_PRIVATE_OPT
2430 /** @deprecated use encoder private options instead */
2431 attribute_deprecated
2432 int b_sensitivity;
2433#endif
2434
2435 /**
2436 * Chromaticity coordinates of the source primaries.
2437 * - encoding: Set by user
2438 * - decoding: Set by libavcodec
2439 */
2440 enum AVColorPrimaries color_primaries;
2441
2442 /**
2443 * Color Transfer Characteristic.
2444 * - encoding: Set by user
2445 * - decoding: Set by libavcodec
2446 */
2447 enum AVColorTransferCharacteristic color_trc;
2448
2449 /**
2450 * YUV colorspace type.
2451 * - encoding: Set by user
2452 * - decoding: Set by libavcodec
2453 */
2454 enum AVColorSpace colorspace;
2455
2456 /**
2457 * MPEG vs JPEG YUV range.
2458 * - encoding: Set by user
2459 * - decoding: Set by libavcodec
2460 */
2461 enum AVColorRange color_range;
2462
2463 /**
2464 * This defines the location of chroma samples.
2465 * - encoding: Set by user
2466 * - decoding: Set by libavcodec
2467 */
2468 enum AVChromaLocation chroma_sample_location;
2469
2470 /**
2471 * Number of slices.
2472 * Indicates number of picture subdivisions. Used for parallelized
2473 * decoding.
2474 * - encoding: Set by user
2475 * - decoding: unused
2476 */
2477 int slices;
2478
2479 /** Field order
2480 * - encoding: set by libavcodec
2481 * - decoding: Set by user.
2482 */
2483 enum AVFieldOrder field_order;
2484
2485 /* audio only */
2486 int sample_rate; ///< samples per second
2487 int channels; ///< number of audio channels
2488
2489 /**
2490 * audio sample format
2491 * - encoding: Set by user.
2492 * - decoding: Set by libavcodec.
2493 */
2494 enum AVSampleFormat sample_fmt; ///< sample format
2495
2496 /* The following data should not be initialized. */
2497 /**
2498 * Number of samples per channel in an audio frame.
2499 *
2500 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2501 * except the last must contain exactly frame_size samples per channel.
2502 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2503 * frame size is not restricted.
2504 * - decoding: may be set by some decoders to indicate constant frame size
2505 */
2506 int frame_size;
2507
2508 /**
2509 * Frame counter, set by libavcodec.
2510 *
2511 * - decoding: total number of frames returned from the decoder so far.
2512 * - encoding: total number of frames passed to the encoder so far.
2513 *
2514 * @note the counter is not incremented if encoding/decoding resulted in
2515 * an error.
2516 */
2517 int frame_number;
2518
2519 /**
2520 * number of bytes per packet if constant and known or 0
2521 * Used by some WAV based audio codecs.
2522 */
2523 int block_align;
2524
2525 /**
2526 * Audio cutoff bandwidth (0 means "automatic")
2527 * - encoding: Set by user.
2528 * - decoding: unused
2529 */
2530 int cutoff;
2531
2532 /**
2533 * Audio channel layout.
2534 * - encoding: set by user.
2535 * - decoding: set by user, may be overwritten by libavcodec.
2536 */
2537 uint64_t channel_layout;
2538
2539 /**
2540 * Request decoder to use this channel layout if it can (0 for default)
2541 * - encoding: unused
2542 * - decoding: Set by user.
2543 */
2544 uint64_t request_channel_layout;
2545
2546 /**
2547 * Type of service that the audio stream conveys.
2548 * - encoding: Set by user.
2549 * - decoding: Set by libavcodec.
2550 */
2551 enum AVAudioServiceType audio_service_type;
2552
2553 /**
2554 * desired sample format
2555 * - encoding: Not used.
2556 * - decoding: Set by user.
2557 * Decoder will decode to this format if it can.
2558 */
2559 enum AVSampleFormat request_sample_fmt;
2560
2561 /**
2562 * This callback is called at the beginning of each frame to get data
2563 * buffer(s) for it. There may be one contiguous buffer for all the data or
2564 * there may be a buffer per each data plane or anything in between. What
2565 * this means is, you may set however many entries in buf[] you feel necessary.
2566 * Each buffer must be reference-counted using the AVBuffer API (see description
2567 * of buf[] below).
2568 *
2569 * The following fields will be set in the frame before this callback is
2570 * called:
2571 * - format
2572 * - width, height (video only)
2573 * - sample_rate, channel_layout, nb_samples (audio only)
2574 * Their values may differ from the corresponding values in
2575 * AVCodecContext. This callback must use the frame values, not the codec
2576 * context values, to calculate the required buffer size.
2577 *
2578 * This callback must fill the following fields in the frame:
2579 * - data[]
2580 * - linesize[]
2581 * - extended_data:
2582 * * if the data is planar audio with more than 8 channels, then this
2583 * callback must allocate and fill extended_data to contain all pointers
2584 * to all data planes. data[] must hold as many pointers as it can.
2585 * extended_data must be allocated with av_malloc() and will be freed in
2586 * av_frame_unref().
2587 * * otherwise extended_data must point to data
2588 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2589 * the frame's data and extended_data pointers must be contained in these. That
2590 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2591 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2592 * and av_buffer_ref().
2593 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2594 * this callback and filled with the extra buffers if there are more
2595 * buffers than buf[] can hold. extended_buf will be freed in
2596 * av_frame_unref().
2597 *
2598 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2599 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2600 * some other means.
2601 *
2602 * Each data plane must be aligned to the maximum required by the target
2603 * CPU.
2604 *
2605 * @see avcodec_default_get_buffer2()
2606 *
2607 * Video:
2608 *
2609 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2610 * (read and/or written to if it is writable) later by libavcodec.
2611 *
2612 * avcodec_align_dimensions2() should be used to find the required width and
2613 * height, as they normally need to be rounded up to the next multiple of 16.
2614 *
2615 * Some decoders do not support linesizes changing between frames.
2616 *
2617 * If frame multithreading is used and thread_safe_callbacks is set,
2618 * this callback may be called from a different thread, but not from more
2619 * than one at once. Does not need to be reentrant.
2620 *
2621 * @see avcodec_align_dimensions2()
2622 *
2623 * Audio:
2624 *
2625 * Decoders request a buffer of a particular size by setting
2626 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2627 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2628 * to a smaller value in the output frame.
2629 *
2630 * As a convenience, av_samples_get_buffer_size() and
2631 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2632 * functions to find the required data size and to fill data pointers and
2633 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2634 * since all planes must be the same size.
2635 *
2636 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2637 *
2638 * - encoding: unused
2639 * - decoding: Set by libavcodec, user can override.
2640 */
2641 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2642
2643 /**
2644 * If non-zero, the decoded audio and video frames returned from
2645 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2646 * and are valid indefinitely. The caller must free them with
2647 * av_frame_unref() when they are not needed anymore.
2648 * Otherwise, the decoded frames must not be freed by the caller and are
2649 * only valid until the next decode call.
2650 *
2651 * This is always automatically enabled if avcodec_receive_frame() is used.
2652 *
2653 * - encoding: unused
2654 * - decoding: set by the caller before avcodec_open2().
2655 */
2656 int refcounted_frames;
2657
2658 /* - encoding parameters */
2659 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2660 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2661
2662 /**
2663 * minimum quantizer
2664 * - encoding: Set by user.
2665 * - decoding: unused
2666 */
2667 int qmin;
2668
2669 /**
2670 * maximum quantizer
2671 * - encoding: Set by user.
2672 * - decoding: unused
2673 */
2674 int qmax;
2675
2676 /**
2677 * maximum quantizer difference between frames
2678 * - encoding: Set by user.
2679 * - decoding: unused
2680 */
2681 int max_qdiff;
2682
2683#if FF_API_MPV_OPT
2684 /**
2685 * @deprecated use encoder private options instead
2686 */
2687 attribute_deprecated
2688 float rc_qsquish;
2689
2690 attribute_deprecated
2691 float rc_qmod_amp;
2692 attribute_deprecated
2693 int rc_qmod_freq;
2694#endif
2695
2696 /**
2697 * decoder bitstream buffer size
2698 * - encoding: Set by user.
2699 * - decoding: unused
2700 */
2701 int rc_buffer_size;
2702
2703 /**
2704 * ratecontrol override, see RcOverride
2705 * - encoding: Allocated/set/freed by user.
2706 * - decoding: unused
2707 */
2708 int rc_override_count;
2709 RcOverride *rc_override;
2710
2711#if FF_API_MPV_OPT
2712 /**
2713 * @deprecated use encoder private options instead
2714 */
2715 attribute_deprecated
2716 const char *rc_eq;
2717#endif
2718
2719 /**
2720 * maximum bitrate
2721 * - encoding: Set by user.
2722 * - decoding: Set by user, may be overwritten by libavcodec.
2723 */
2724 int64_t rc_max_rate;
2725
2726 /**
2727 * minimum bitrate
2728 * - encoding: Set by user.
2729 * - decoding: unused
2730 */
2731 int64_t rc_min_rate;
2732
2733#if FF_API_MPV_OPT
2734 /**
2735 * @deprecated use encoder private options instead
2736 */
2737 attribute_deprecated
2738 float rc_buffer_aggressivity;
2739
2740 attribute_deprecated
2741 float rc_initial_cplx;
2742#endif
2743
2744 /**
2745 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2746 * - encoding: Set by user.
2747 * - decoding: unused.
2748 */
2749 float rc_max_available_vbv_use;
2750
2751 /**
2752 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2753 * - encoding: Set by user.
2754 * - decoding: unused.
2755 */
2756 float rc_min_vbv_overflow_use;
2757
2758 /**
2759 * Number of bits which should be loaded into the rc buffer before decoding starts.
2760 * - encoding: Set by user.
2761 * - decoding: unused
2762 */
2763 int rc_initial_buffer_occupancy;
2764
2765#if FF_API_CODER_TYPE
2766#define FF_CODER_TYPE_VLC 0
2767#define FF_CODER_TYPE_AC 1
2768#define FF_CODER_TYPE_RAW 2
2769#define FF_CODER_TYPE_RLE 3
2770#if FF_API_UNUSED_MEMBERS
2771#define FF_CODER_TYPE_DEFLATE 4
2772#endif /* FF_API_UNUSED_MEMBERS */
2773 /**
2774 * @deprecated use encoder private options instead
2775 */
2776 attribute_deprecated
2777 int coder_type;
2778#endif /* FF_API_CODER_TYPE */
2779
2780#if FF_API_PRIVATE_OPT
2781 /** @deprecated use encoder private options instead */
2782 attribute_deprecated
2783 int context_model;
2784#endif
2785
2786#if FF_API_MPV_OPT
2787 /**
2788 * @deprecated use encoder private options instead
2789 */
2790 attribute_deprecated
2791 int lmin;
2792
2793 /**
2794 * @deprecated use encoder private options instead
2795 */
2796 attribute_deprecated
2797 int lmax;
2798#endif
2799
2800#if FF_API_PRIVATE_OPT
2801 /** @deprecated use encoder private options instead */
2802 attribute_deprecated
2803 int frame_skip_threshold;
2804
2805 /** @deprecated use encoder private options instead */
2806 attribute_deprecated
2807 int frame_skip_factor;
2808
2809 /** @deprecated use encoder private options instead */
2810 attribute_deprecated
2811 int frame_skip_exp;
2812
2813 /** @deprecated use encoder private options instead */
2814 attribute_deprecated
2815 int frame_skip_cmp;
2816#endif /* FF_API_PRIVATE_OPT */
2817
2818 /**
2819 * trellis RD quantization
2820 * - encoding: Set by user.
2821 * - decoding: unused
2822 */
2823 int trellis;
2824
2825#if FF_API_PRIVATE_OPT
2826 /** @deprecated use encoder private options instead */
2827 attribute_deprecated
2828 int min_prediction_order;
2829
2830 /** @deprecated use encoder private options instead */
2831 attribute_deprecated
2832 int max_prediction_order;
2833
2834 /** @deprecated use encoder private options instead */
2835 attribute_deprecated
2836 int64_t timecode_frame_start;
2837#endif
2838
2839#if FF_API_RTP_CALLBACK
2840 /**
2841 * @deprecated unused
2842 */
2843 /* The RTP callback: This function is called */
2844 /* every time the encoder has a packet to send. */
2845 /* It depends on the encoder if the data starts */
2846 /* with a Start Code (it should). H.263 does. */
2847 /* mb_nb contains the number of macroblocks */
2848 /* encoded in the RTP payload. */
2849 attribute_deprecated
2850 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2851#endif
2852
2853#if FF_API_PRIVATE_OPT
2854 /** @deprecated use encoder private options instead */
2855 attribute_deprecated
2856 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2857 /* do its best to deliver a chunk with size */
2858 /* below rtp_payload_size, the chunk will start */
2859 /* with a start code on some codecs like H.263. */
2860 /* This doesn't take account of any particular */
2861 /* headers inside the transmitted RTP payload. */
2862#endif
2863
2864#if FF_API_STAT_BITS
2865 /* statistics, used for 2-pass encoding */
2866 attribute_deprecated
2867 int mv_bits;
2868 attribute_deprecated
2869 int header_bits;
2870 attribute_deprecated
2871 int i_tex_bits;
2872 attribute_deprecated
2873 int p_tex_bits;
2874 attribute_deprecated
2875 int i_count;
2876 attribute_deprecated
2877 int p_count;
2878 attribute_deprecated
2879 int skip_count;
2880 attribute_deprecated
2881 int misc_bits;
2882
2883 /** @deprecated this field is unused */
2884 attribute_deprecated
2885 int frame_bits;
2886#endif
2887
2888 /**
2889 * pass1 encoding statistics output buffer
2890 * - encoding: Set by libavcodec.
2891 * - decoding: unused
2892 */
2893 char *stats_out;
2894
2895 /**
2896 * pass2 encoding statistics input buffer
2897 * Concatenated stuff from stats_out of pass1 should be placed here.
2898 * - encoding: Allocated/set/freed by user.
2899 * - decoding: unused
2900 */
2901 char *stats_in;
2902
2903 /**
2904 * Work around bugs in encoders which sometimes cannot be detected automatically.
2905 * - encoding: Set by user
2906 * - decoding: Set by user
2907 */
2908 int workaround_bugs;
2909#define FF_BUG_AUTODETECT 1 ///< autodetection
2910#if FF_API_OLD_MSMPEG4
2911#define FF_BUG_OLD_MSMPEG4 2
2912#endif
2913#define FF_BUG_XVID_ILACE 4
2914#define FF_BUG_UMP4 8
2915#define FF_BUG_NO_PADDING 16
2916#define FF_BUG_AMV 32
2917#if FF_API_AC_VLC
2918#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2919#endif
2920#define FF_BUG_QPEL_CHROMA 64
2921#define FF_BUG_STD_QPEL 128
2922#define FF_BUG_QPEL_CHROMA2 256
2923#define FF_BUG_DIRECT_BLOCKSIZE 512
2924#define FF_BUG_EDGE 1024
2925#define FF_BUG_HPEL_CHROMA 2048
2926#define FF_BUG_DC_CLIP 4096
2927#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2928#define FF_BUG_TRUNCATED 16384
2929#define FF_BUG_IEDGE 32768
2930
2931 /**
2932 * strictly follow the standard (MPEG-4, ...).
2933 * - encoding: Set by user.
2934 * - decoding: Set by user.
2935 * Setting this to STRICT or higher means the encoder and decoder will
2936 * generally do stupid things, whereas setting it to unofficial or lower
2937 * will mean the encoder might produce output that is not supported by all
2938 * spec-compliant decoders. Decoders don't differentiate between normal,
2939 * unofficial and experimental (that is, they always try to decode things
2940 * when they can) unless they are explicitly asked to behave stupidly
2941 * (=strictly conform to the specs)
2942 */
2943 int strict_std_compliance;
2944#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2945#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2946#define FF_COMPLIANCE_NORMAL 0
2947#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2948#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2949
2950 /**
2951 * error concealment flags
2952 * - encoding: unused
2953 * - decoding: Set by user.
2954 */
2955 int error_concealment;
2956#define FF_EC_GUESS_MVS 1
2957#define FF_EC_DEBLOCK 2
2958#define FF_EC_FAVOR_INTER 256
2959
2960 /**
2961 * debug
2962 * - encoding: Set by user.
2963 * - decoding: Set by user.
2964 */
2965 int debug;
2966#define FF_DEBUG_PICT_INFO 1
2967#define FF_DEBUG_RC 2
2968#define FF_DEBUG_BITSTREAM 4
2969#define FF_DEBUG_MB_TYPE 8
2970#define FF_DEBUG_QP 16
2971#if FF_API_DEBUG_MV
2972/**
2973 * @deprecated this option does nothing
2974 */
2975#define FF_DEBUG_MV 32
2976#endif
2977#define FF_DEBUG_DCT_COEFF 0x00000040
2978#define FF_DEBUG_SKIP 0x00000080
2979#define FF_DEBUG_STARTCODE 0x00000100
2980#if FF_API_UNUSED_MEMBERS
2981#define FF_DEBUG_PTS 0x00000200
2982#endif /* FF_API_UNUSED_MEMBERS */
2983#define FF_DEBUG_ER 0x00000400
2984#define FF_DEBUG_MMCO 0x00000800
2985#define FF_DEBUG_BUGS 0x00001000
2986#if FF_API_DEBUG_MV
2987#define FF_DEBUG_VIS_QP 0x00002000
2988#define FF_DEBUG_VIS_MB_TYPE 0x00004000
2989#endif
2990#define FF_DEBUG_BUFFERS 0x00008000
2991#define FF_DEBUG_THREADS 0x00010000
2992#define FF_DEBUG_GREEN_MD 0x00800000
2993#define FF_DEBUG_NOMC 0x01000000
2994
2995#if FF_API_DEBUG_MV
2996 /**
2997 * debug
2998 * - encoding: Set by user.
2999 * - decoding: Set by user.
3000 */
3001 int debug_mv;
3002#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3003#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3004#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3005#endif
3006
3007 /**
3008 * Error recognition; may misdetect some more or less valid parts as errors.
3009 * - encoding: unused
3010 * - decoding: Set by user.
3011 */
3012 int err_recognition;
3013
3014/**
3015 * Verify checksums embedded in the bitstream (could be of either encoded or
3016 * decoded data, depending on the codec) and print an error message on mismatch.
3017 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3018 * decoder returning an error.
3019 */
3020#define AV_EF_CRCCHECK (1<<0)
3021#define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3022#define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3023#define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3024
3025#define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3026#define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
3027#define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3028#define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3029
3030
3031 /**
3032 * opaque 64-bit number (generally a PTS) that will be reordered and
3033 * output in AVFrame.reordered_opaque
3034 * - encoding: unused
3035 * - decoding: Set by user.
3036 */
3037 int64_t reordered_opaque;
3038
3039 /**
3040 * Hardware accelerator in use
3041 * - encoding: unused.
3042 * - decoding: Set by libavcodec
3043 */
3044 struct AVHWAccel *hwaccel;
3045
3046 /**
3047 * Hardware accelerator context.
3048 * For some hardware accelerators, a global context needs to be
3049 * provided by the user. In that case, this holds display-dependent
3050 * data FFmpeg cannot instantiate itself. Please refer to the
3051 * FFmpeg HW accelerator documentation to know how to fill this
3052 * is. e.g. for VA API, this is a struct vaapi_context.
3053 * - encoding: unused
3054 * - decoding: Set by user
3055 */
3056 void *hwaccel_context;
3057
3058 /**
3059 * error
3060 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3061 * - decoding: unused
3062 */
3063 uint64_t error[AV_NUM_DATA_POINTERS];
3064
3065 /**
3066 * DCT algorithm, see FF_DCT_* below
3067 * - encoding: Set by user.
3068 * - decoding: unused
3069 */
3070 int dct_algo;
3071#define FF_DCT_AUTO 0
3072#define FF_DCT_FASTINT 1
3073#define FF_DCT_INT 2
3074#define FF_DCT_MMX 3
3075#define FF_DCT_ALTIVEC 5
3076#define FF_DCT_FAAN 6
3077
3078 /**
3079 * IDCT algorithm, see FF_IDCT_* below.
3080 * - encoding: Set by user.
3081 * - decoding: Set by user.
3082 */
3083 int idct_algo;
3084#define FF_IDCT_AUTO 0
3085#define FF_IDCT_INT 1
3086#define FF_IDCT_SIMPLE 2
3087#define FF_IDCT_SIMPLEMMX 3
3088#define FF_IDCT_ARM 7
3089#define FF_IDCT_ALTIVEC 8
3090#if FF_API_ARCH_SH4
3091#define FF_IDCT_SH4 9
3092#endif
3093#define FF_IDCT_SIMPLEARM 10
3094#if FF_API_UNUSED_MEMBERS
3095#define FF_IDCT_IPP 13
3096#endif /* FF_API_UNUSED_MEMBERS */
3097#define FF_IDCT_XVID 14
3098#if FF_API_IDCT_XVIDMMX
3099#define FF_IDCT_XVIDMMX 14
3100#endif /* FF_API_IDCT_XVIDMMX */
3101#define FF_IDCT_SIMPLEARMV5TE 16
3102#define FF_IDCT_SIMPLEARMV6 17
3103#if FF_API_ARCH_SPARC
3104#define FF_IDCT_SIMPLEVIS 18
3105#endif
3106#define FF_IDCT_FAAN 20
3107#define FF_IDCT_SIMPLENEON 22
3108#if FF_API_ARCH_ALPHA
3109#define FF_IDCT_SIMPLEALPHA 23
3110#endif
3111#define FF_IDCT_SIMPLEAUTO 128
3112
3113 /**
3114 * bits per sample/pixel from the demuxer (needed for huffyuv).
3115 * - encoding: Set by libavcodec.
3116 * - decoding: Set by user.
3117 */
3118 int bits_per_coded_sample;
3119
3120 /**
3121 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3122 * - encoding: set by user.
3123 * - decoding: set by libavcodec.
3124 */
3125 int bits_per_raw_sample;
3126
3127#if FF_API_LOWRES
3128 /**
3129 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3130 * - encoding: unused
3131 * - decoding: Set by user.
3132 */
3133 int lowres;
3134#endif
3135
3136#if FF_API_CODED_FRAME
3137 /**
3138 * the picture in the bitstream
3139 * - encoding: Set by libavcodec.
3140 * - decoding: unused
3141 *
3142 * @deprecated use the quality factor packet side data instead
3143 */
3144 attribute_deprecated AVFrame *coded_frame;
3145#endif
3146
3147 /**
3148 * thread count
3149 * is used to decide how many independent tasks should be passed to execute()
3150 * - encoding: Set by user.
3151 * - decoding: Set by user.
3152 */
3153 int thread_count;
3154
3155 /**
3156 * Which multithreading methods to use.
3157 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3158 * so clients which cannot provide future frames should not use it.
3159 *
3160 * - encoding: Set by user, otherwise the default is used.
3161 * - decoding: Set by user, otherwise the default is used.
3162 */
3163 int thread_type;
3164#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3165#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3166
3167 /**
3168 * Which multithreading methods are in use by the codec.
3169 * - encoding: Set by libavcodec.
3170 * - decoding: Set by libavcodec.
3171 */
3172 int active_thread_type;
3173
3174 /**
3175 * Set by the client if its custom get_buffer() callback can be called
3176 * synchronously from another thread, which allows faster multithreaded decoding.
3177 * draw_horiz_band() will be called from other threads regardless of this setting.
3178 * Ignored if the default get_buffer() is used.
3179 * - encoding: Set by user.
3180 * - decoding: Set by user.
3181 */
3182 int thread_safe_callbacks;
3183
3184 /**
3185 * The codec may call this to execute several independent things.
3186 * It will return only after finishing all tasks.
3187 * The user may replace this with some multithreaded implementation,
3188 * the default implementation will execute the parts serially.
3189 * @param count the number of things to execute
3190 * - encoding: Set by libavcodec, user can override.
3191 * - decoding: Set by libavcodec, user can override.
3192 */
3193 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3194
3195 /**
3196 * The codec may call this to execute several independent things.
3197 * It will return only after finishing all tasks.
3198 * The user may replace this with some multithreaded implementation,
3199 * the default implementation will execute the parts serially.
3200 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3201 * @param c context passed also to func
3202 * @param count the number of things to execute
3203 * @param arg2 argument passed unchanged to func
3204 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3205 * @param func function that will be called count times, with jobnr from 0 to count-1.
3206 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3207 * two instances of func executing at the same time will have the same threadnr.
3208 * @return always 0 currently, but code should handle a future improvement where when any call to func
3209 * returns < 0 no further calls to func may be done and < 0 is returned.
3210 * - encoding: Set by libavcodec, user can override.
3211 * - decoding: Set by libavcodec, user can override.
3212 */
3213 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3214
3215 /**
3216 * noise vs. sse weight for the nsse comparison function
3217 * - encoding: Set by user.
3218 * - decoding: unused
3219 */
3220 int nsse_weight;
3221
3222 /**
3223 * profile
3224 * - encoding: Set by user.
3225 * - decoding: Set by libavcodec.
3226 */
3227 int profile;
3228#define FF_PROFILE_UNKNOWN -99
3229#define FF_PROFILE_RESERVED -100
3230
3231#define FF_PROFILE_AAC_MAIN 0
3232#define FF_PROFILE_AAC_LOW 1
3233#define FF_PROFILE_AAC_SSR 2
3234#define FF_PROFILE_AAC_LTP 3
3235#define FF_PROFILE_AAC_HE 4
3236#define FF_PROFILE_AAC_HE_V2 28
3237#define FF_PROFILE_AAC_LD 22
3238#define FF_PROFILE_AAC_ELD 38
3239#define FF_PROFILE_MPEG2_AAC_LOW 128
3240#define FF_PROFILE_MPEG2_AAC_HE 131
3241
3242#define FF_PROFILE_DNXHD 0
3243#define FF_PROFILE_DNXHR_LB 1
3244#define FF_PROFILE_DNXHR_SQ 2
3245#define FF_PROFILE_DNXHR_HQ 3
3246#define FF_PROFILE_DNXHR_HQX 4
3247#define FF_PROFILE_DNXHR_444 5
3248
3249#define FF_PROFILE_DTS 20
3250#define FF_PROFILE_DTS_ES 30
3251#define FF_PROFILE_DTS_96_24 40
3252#define FF_PROFILE_DTS_HD_HRA 50
3253#define FF_PROFILE_DTS_HD_MA 60
3254#define FF_PROFILE_DTS_EXPRESS 70
3255
3256#define FF_PROFILE_MPEG2_422 0
3257#define FF_PROFILE_MPEG2_HIGH 1
3258#define FF_PROFILE_MPEG2_SS 2
3259#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3260#define FF_PROFILE_MPEG2_MAIN 4
3261#define FF_PROFILE_MPEG2_SIMPLE 5
3262
3263#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3264#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3265
3266#define FF_PROFILE_H264_BASELINE 66
3267#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3268#define FF_PROFILE_H264_MAIN 77
3269#define FF_PROFILE_H264_EXTENDED 88
3270#define FF_PROFILE_H264_HIGH 100
3271#define FF_PROFILE_H264_HIGH_10 110
3272#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3273#define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3274#define FF_PROFILE_H264_HIGH_422 122
3275#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3276#define FF_PROFILE_H264_STEREO_HIGH 128
3277#define FF_PROFILE_H264_HIGH_444 144
3278#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3279#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3280#define FF_PROFILE_H264_CAVLC_444 44
3281
3282#define FF_PROFILE_VC1_SIMPLE 0
3283#define FF_PROFILE_VC1_MAIN 1
3284#define FF_PROFILE_VC1_COMPLEX 2
3285#define FF_PROFILE_VC1_ADVANCED 3
3286
3287#define FF_PROFILE_MPEG4_SIMPLE 0
3288#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3289#define FF_PROFILE_MPEG4_CORE 2
3290#define FF_PROFILE_MPEG4_MAIN 3
3291#define FF_PROFILE_MPEG4_N_BIT 4
3292#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3293#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3294#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3295#define FF_PROFILE_MPEG4_HYBRID 8
3296#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3297#define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3298#define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3299#define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3300#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3301#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3302#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3303
3304#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3305#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3306#define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3307#define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3308#define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3309
3310#define FF_PROFILE_VP9_0 0
3311#define FF_PROFILE_VP9_1 1
3312#define FF_PROFILE_VP9_2 2
3313#define FF_PROFILE_VP9_3 3
3314
3315#define FF_PROFILE_HEVC_MAIN 1
3316#define FF_PROFILE_HEVC_MAIN_10 2
3317#define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3318#define FF_PROFILE_HEVC_REXT 4
3319
3320 /**
3321 * level
3322 * - encoding: Set by user.
3323 * - decoding: Set by libavcodec.
3324 */
3325 int level;
3326#define FF_LEVEL_UNKNOWN -99
3327
3328 /**
3329 * Skip loop filtering for selected frames.
3330 * - encoding: unused
3331 * - decoding: Set by user.
3332 */
3333 enum AVDiscard skip_loop_filter;
3334
3335 /**
3336 * Skip IDCT/dequantization for selected frames.
3337 * - encoding: unused
3338 * - decoding: Set by user.
3339 */
3340 enum AVDiscard skip_idct;
3341
3342 /**
3343 * Skip decoding for selected frames.
3344 * - encoding: unused
3345 * - decoding: Set by user.
3346 */
3347 enum AVDiscard skip_frame;
3348
3349 /**
3350 * Header containing style information for text subtitles.
3351 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3352 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3353 * the Format line following. It shouldn't include any Dialogue line.
3354 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3355 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3356 */
3357 uint8_t *subtitle_header;
3358 int subtitle_header_size;
3359
3360#if FF_API_ERROR_RATE
3361 /**
3362 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3363 * encoders
3364 */
3365 attribute_deprecated
3366 int error_rate;
3367#endif
3368
3369#if FF_API_VBV_DELAY
3370 /**
3371 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3372 * Used for compliant TS muxing.
3373 * - encoding: Set by libavcodec.
3374 * - decoding: unused.
3375 * @deprecated this value is now exported as a part of
3376 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3377 */
3378 attribute_deprecated
3379 uint64_t vbv_delay;
3380#endif
3381
3382#if FF_API_SIDEDATA_ONLY_PKT
3383 /**
3384 * Encoding only and set by default. Allow encoders to output packets
3385 * that do not contain any encoded data, only side data.
3386 *
3387 * Some encoders need to output such packets, e.g. to update some stream
3388 * parameters at the end of encoding.
3389 *
3390 * @deprecated this field disables the default behaviour and
3391 * it is kept only for compatibility.
3392 */
3393 attribute_deprecated
3394 int side_data_only_packets;
3395#endif
3396
3397 /**
3398 * Audio only. The number of "priming" samples (padding) inserted by the
3399 * encoder at the beginning of the audio. I.e. this number of leading
3400 * decoded samples must be discarded by the caller to get the original audio
3401 * without leading padding.
3402 *
3403 * - decoding: unused
3404 * - encoding: Set by libavcodec. The timestamps on the output packets are
3405 * adjusted by the encoder so that they always refer to the
3406 * first sample of the data actually contained in the packet,
3407 * including any added padding. E.g. if the timebase is
3408 * 1/samplerate and the timestamp of the first input sample is
3409 * 0, the timestamp of the first output packet will be
3410 * -initial_padding.
3411 */
3412 int initial_padding;
3413
3414 /**
3415 * - decoding: For codecs that store a framerate value in the compressed
3416 * bitstream, the decoder may export it here. { 0, 1} when
3417 * unknown.
3418 * - encoding: May be used to signal the framerate of CFR content to an
3419 * encoder.
3420 */
3421 AVRational framerate;
3422
3423 /**
3424 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3425 * - encoding: unused.
3426 * - decoding: Set by libavcodec before calling get_format()
3427 */
3428 enum AVPixelFormat sw_pix_fmt;
3429
3430 /**
3431 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3432 * - encoding unused.
3433 * - decoding set by user.
3434 */
3435 AVRational pkt_timebase;
3436
3437 /**
3438 * AVCodecDescriptor
3439 * - encoding: unused.
3440 * - decoding: set by libavcodec.
3441 */
3442 const AVCodecDescriptor *codec_descriptor;
3443
3444#if !FF_API_LOWRES
3445 /**
3446 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3447 * - encoding: unused
3448 * - decoding: Set by user.
3449 */
3450 int lowres;
3451#endif
3452
3453 /**
3454 * Current statistics for PTS correction.
3455 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3456 * - encoding: unused
3457 */
3458 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3459 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3460 int64_t pts_correction_last_pts; /// PTS of the last frame
3461 int64_t pts_correction_last_dts; /// DTS of the last frame
3462
3463 /**
3464 * Character encoding of the input subtitles file.
3465 * - decoding: set by user
3466 * - encoding: unused
3467 */
3468 char *sub_charenc;
3469
3470 /**
3471 * Subtitles character encoding mode. Formats or codecs might be adjusting
3472 * this setting (if they are doing the conversion themselves for instance).
3473 * - decoding: set by libavcodec
3474 * - encoding: unused
3475 */
3476 int sub_charenc_mode;
3477#define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3478#define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3479#define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3480
3481 /**
3482 * Skip processing alpha if supported by codec.
3483 * Note that if the format uses pre-multiplied alpha (common with VP6,
3484 * and recommended due to better video quality/compression)
3485 * the image will look as if alpha-blended onto a black background.
3486 * However for formats that do not use pre-multiplied alpha
3487 * there might be serious artefacts (though e.g. libswscale currently
3488 * assumes pre-multiplied alpha anyway).
3489 *
3490 * - decoding: set by user
3491 * - encoding: unused
3492 */
3493 int skip_alpha;
3494
3495 /**
3496 * Number of samples to skip after a discontinuity
3497 * - decoding: unused
3498 * - encoding: set by libavcodec
3499 */
3500 int seek_preroll;
3501
3502#if !FF_API_DEBUG_MV
3503 /**
3504 * debug motion vectors
3505 * - encoding: Set by user.
3506 * - decoding: Set by user.
3507 */
3508 int debug_mv;
3509#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3510#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3511#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3512#endif
3513
3514 /**
3515 * custom intra quantization matrix
3516 * - encoding: Set by user, can be NULL.
3517 * - decoding: unused.
3518 */
3519 uint16_t *chroma_intra_matrix;
3520
3521 /**
3522 * dump format separator.
3523 * can be ", " or "\n " or anything else
3524 * - encoding: Set by user.
3525 * - decoding: Set by user.
3526 */
3527 uint8_t *dump_separator;
3528
3529 /**
3530 * ',' separated list of allowed decoders.
3531 * If NULL then all are allowed
3532 * - encoding: unused
3533 * - decoding: set by user
3534 */
3535 char *codec_whitelist;
3536
3537 /*
3538 * Properties of the stream that gets decoded
3539 * - encoding: unused
3540 * - decoding: set by libavcodec
3541 */
3542 unsigned properties;
3543#define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3544#define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3545
3546 /**
3547 * Additional data associated with the entire coded stream.
3548 *
3549 * - decoding: unused
3550 * - encoding: may be set by libavcodec after avcodec_open2().
3551 */
3552 AVPacketSideData *coded_side_data;
3553 int nb_coded_side_data;
3554
3555 /**
3556 * A reference to the AVHWFramesContext describing the input (for encoding)
3557 * or output (decoding) frames. The reference is set by the caller and
3558 * afterwards owned (and freed) by libavcodec - it should never be read by
3559 * the caller after being set.
3560 *
3561 * - decoding: This field should be set by the caller from the get_format()
3562 * callback. The previous reference (if any) will always be
3563 * unreffed by libavcodec before the get_format() call.
3564 *
3565 * If the default get_buffer2() is used with a hwaccel pixel
3566 * format, then this AVHWFramesContext will be used for
3567 * allocating the frame buffers.
3568 *
3569 * - encoding: For hardware encoders configured to use a hwaccel pixel
3570 * format, this field should be set by the caller to a reference
3571 * to the AVHWFramesContext describing input frames.
3572 * AVHWFramesContext.format must be equal to
3573 * AVCodecContext.pix_fmt.
3574 *
3575 * This field should be set before avcodec_open2() is called.
3576 */
3577 AVBufferRef *hw_frames_ctx;
3578
3579 /**
3580 * Control the form of AVSubtitle.rects[N]->ass
3581 * - decoding: set by user
3582 * - encoding: unused
3583 */
3584 int sub_text_format;
3585#define FF_SUB_TEXT_FMT_ASS 0
3586#if FF_API_ASS_TIMING
3587#define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3588#endif
3589
3590 /**
3591 * Audio only. The amount of padding (in samples) appended by the encoder to
3592 * the end of the audio. I.e. this number of decoded samples must be
3593 * discarded by the caller from the end of the stream to get the original
3594 * audio without any trailing padding.
3595 *
3596 * - decoding: unused
3597 * - encoding: unused
3598 */
3599 int trailing_padding;
3600
3601 /**
3602 * The number of pixels per image to maximally accept.
3603 *
3604 * - decoding: set by user
3605 * - encoding: set by user
3606 */
3607 int64_t max_pixels;
3608
3609 /**
3610 * A reference to the AVHWDeviceContext describing the device which will
3611 * be used by a hardware encoder/decoder. The reference is set by the
3612 * caller and afterwards owned (and freed) by libavcodec.
3613 *
3614 * This should be used if either the codec device does not require
3615 * hardware frames or any that are used are to be allocated internally by
3616 * libavcodec. If the user wishes to supply any of the frames used as
3617 * encoder input or decoder output then hw_frames_ctx should be used
3618 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3619 * field will be ignored while decoding the associated stream segment, but
3620 * may again be used on a following one after another get_format() call.
3621 *
3622 * For both encoders and decoders this field should be set before
3623 * avcodec_open2() is called and must not be written to thereafter.
3624 *
3625 * Note that some decoders may require this field to be set initially in
3626 * order to support hw_frames_ctx at all - in that case, all frames
3627 * contexts used must be created on the same device.
3628 */
3629 AVBufferRef *hw_device_ctx;
3630
3631 /**
3632 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3633 * decoding (if active).
3634 * - encoding: unused
3635 * - decoding: Set by user (either before avcodec_open2(), or in the
3636 * AVCodecContext.get_format callback)
3637 */
3638 int hwaccel_flags;
3639} AVCodecContext;
3640
3641AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3642void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3643
3644const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3645void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3646
3647unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3648
3649int av_codec_get_lowres(const AVCodecContext *avctx);
3650void av_codec_set_lowres(AVCodecContext *avctx, int val);
3651
3652int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3653void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3654
3655uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3656void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3657
3658/**
3659 * AVProfile.
3660 */
3661typedef struct AVProfile {
3662 int profile;
3663 const char *name; ///< short name for the profile
3664} AVProfile;
3665
3666typedef struct AVCodecDefault AVCodecDefault;
3667
3668struct AVSubtitle;
3669
3670/**
3671 * AVCodec.
3672 */
3673typedef struct AVCodec {
3674 /**
3675 * Name of the codec implementation.
3676 * The name is globally unique among encoders and among decoders (but an
3677 * encoder and a decoder can share the same name).
3678 * This is the primary way to find a codec from the user perspective.
3679 */
3680 const char *name;
3681 /**
3682 * Descriptive name for the codec, meant to be more human readable than name.
3683 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3684 */
3685 const char *long_name;
3686 enum AVMediaType type;
3687 enum AVCodecID id;
3688 /**
3689 * Codec capabilities.
3690 * see AV_CODEC_CAP_*
3691 */
3692 int capabilities;
3693 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3694 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3695 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3696 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3697 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3698 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3699 const AVClass *priv_class; ///< AVClass for the private context
3700 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3701
3702 /*****************************************************************
3703 * No fields below this line are part of the public API. They
3704 * may not be used outside of libavcodec and can be changed and
3705 * removed at will.
3706 * New public fields should be added right above.
3707 *****************************************************************
3708 */
3709 int priv_data_size;
3710 struct AVCodec *next;
3711 /**
3712 * @name Frame-level threading support functions
3713 * @{
3714 */
3715 /**
3716 * If defined, called on thread contexts when they are created.
3717 * If the codec allocates writable tables in init(), re-allocate them here.
3718 * priv_data will be set to a copy of the original.
3719 */
3720 int (*init_thread_copy)(AVCodecContext *);
3721 /**
3722 * Copy necessary context variables from a previous thread context to the current one.
3723 * If not defined, the next thread will start automatically; otherwise, the codec
3724 * must call ff_thread_finish_setup().
3725 *
3726 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3727 */
3728 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3729 /** @} */
3730
3731 /**
3732 * Private codec-specific defaults.
3733 */
3734 const AVCodecDefault *defaults;
3735
3736 /**
3737 * Initialize codec static data, called from avcodec_register().
3738 */
3739 void (*init_static_data)(struct AVCodec *codec);
3740
3741 int (*init)(AVCodecContext *);
3742 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3743 const struct AVSubtitle *sub);
3744 /**
3745 * Encode data to an AVPacket.
3746 *
3747 * @param avctx codec context
3748 * @param avpkt output AVPacket (may contain a user-provided buffer)
3749 * @param[in] frame AVFrame containing the raw data to be encoded
3750 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3751 * non-empty packet was returned in avpkt.
3752 * @return 0 on success, negative error code on failure
3753 */
3754 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3755 int *got_packet_ptr);
3756 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3757 int (*close)(AVCodecContext *);
3758 /**
3759 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3760 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3761 * that:
3762 * - never called if the codec is closed or the wrong type,
3763 * - AVPacket parameter change side data is applied right before calling
3764 * AVCodec->send_packet,
3765 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3766 * - only one drain packet is ever passed down (until the next flush()),
3767 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3768 */
3769 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3770 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3771 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3772 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3773 /**
3774 * Flush buffers.
3775 * Will be called when seeking
3776 */
3777 void (*flush)(AVCodecContext *);
3778 /**
3779 * Internal codec capabilities.
3780 * See FF_CODEC_CAP_* in internal.h
3781 */
3782 int caps_internal;
3783} AVCodec;
3784
3785int av_codec_get_max_lowres(const AVCodec *codec);
3786
3787struct MpegEncContext;
3788
3789/**
3790 * @defgroup lavc_hwaccel AVHWAccel
3791 * @{
3792 */
3793typedef struct AVHWAccel {
3794 /**
3795 * Name of the hardware accelerated codec.
3796 * The name is globally unique among encoders and among decoders (but an
3797 * encoder and a decoder can share the same name).
3798 */
3799 const char *name;
3800
3801 /**
3802 * Type of codec implemented by the hardware accelerator.
3803 *
3804 * See AVMEDIA_TYPE_xxx
3805 */
3806 enum AVMediaType type;
3807
3808 /**
3809 * Codec implemented by the hardware accelerator.
3810 *
3811 * See AV_CODEC_ID_xxx
3812 */
3813 enum AVCodecID id;
3814
3815 /**
3816 * Supported pixel format.
3817 *
3818 * Only hardware accelerated formats are supported here.
3819 */
3820 enum AVPixelFormat pix_fmt;
3821
3822 /**
3823 * Hardware accelerated codec capabilities.
3824 * see HWACCEL_CODEC_CAP_*
3825 */
3826 int capabilities;
3827
3828 /*****************************************************************
3829 * No fields below this line are part of the public API. They
3830 * may not be used outside of libavcodec and can be changed and
3831 * removed at will.
3832 * New public fields should be added right above.
3833 *****************************************************************
3834 */
3835 struct AVHWAccel *next;
3836
3837 /**
3838 * Allocate a custom buffer
3839 */
3840 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3841
3842 /**
3843 * Called at the beginning of each frame or field picture.
3844 *
3845 * Meaningful frame information (codec specific) is guaranteed to
3846 * be parsed at this point. This function is mandatory.
3847 *
3848 * Note that buf can be NULL along with buf_size set to 0.
3849 * Otherwise, this means the whole frame is available at this point.
3850 *
3851 * @param avctx the codec context
3852 * @param buf the frame data buffer base
3853 * @param buf_size the size of the frame in bytes
3854 * @return zero if successful, a negative value otherwise
3855 */
3856 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3857
3858 /**
3859 * Callback for each slice.
3860 *
3861 * Meaningful slice information (codec specific) is guaranteed to
3862 * be parsed at this point. This function is mandatory.
3863 * The only exception is XvMC, that works on MB level.
3864 *
3865 * @param avctx the codec context
3866 * @param buf the slice data buffer base
3867 * @param buf_size the size of the slice in bytes
3868 * @return zero if successful, a negative value otherwise
3869 */
3870 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3871
3872 /**
3873 * Called at the end of each frame or field picture.
3874 *
3875 * The whole picture is parsed at this point and can now be sent
3876 * to the hardware accelerator. This function is mandatory.
3877 *
3878 * @param avctx the codec context
3879 * @return zero if successful, a negative value otherwise
3880 */
3881 int (*end_frame)(AVCodecContext *avctx);
3882
3883 /**
3884 * Size of per-frame hardware accelerator private data.
3885 *
3886 * Private data is allocated with av_mallocz() before
3887 * AVCodecContext.get_buffer() and deallocated after
3888 * AVCodecContext.release_buffer().
3889 */
3890 int frame_priv_data_size;
3891
3892 /**
3893 * Called for every Macroblock in a slice.
3894 *
3895 * XvMC uses it to replace the ff_mpv_decode_mb().
3896 * Instead of decoding to raw picture, MB parameters are
3897 * stored in an array provided by the video driver.
3898 *
3899 * @param s the mpeg context
3900 */
3901 void (*decode_mb)(struct MpegEncContext *s);
3902
3903 /**
3904 * Initialize the hwaccel private data.
3905 *
3906 * This will be called from ff_get_format(), after hwaccel and
3907 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3908 * is allocated.
3909 */
3910 int (*init)(AVCodecContext *avctx);
3911
3912 /**
3913 * Uninitialize the hwaccel private data.
3914 *
3915 * This will be called from get_format() or avcodec_close(), after hwaccel
3916 * and hwaccel_context are already uninitialized.
3917 */
3918 int (*uninit)(AVCodecContext *avctx);
3919
3920 /**
3921 * Size of the private data to allocate in
3922 * AVCodecInternal.hwaccel_priv_data.
3923 */
3924 int priv_data_size;
3925
3926 /**
3927 * Internal hwaccel capabilities.
3928 */
3929 int caps_internal;
3930} AVHWAccel;
3931
3932/**
3933 * Hardware acceleration should be used for decoding even if the codec level
3934 * used is unknown or higher than the maximum supported level reported by the
3935 * hardware driver.
3936 *
3937 * It's generally a good idea to pass this flag unless you have a specific
3938 * reason not to, as hardware tends to under-report supported levels.
3939 */
3940#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3941
3942/**
3943 * Hardware acceleration can output YUV pixel formats with a different chroma
3944 * sampling than 4:2:0 and/or other than 8 bits per component.
3945 */
3946#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3947
3948/**
3949 * @}
3950 */
3951
3952#if FF_API_AVPICTURE
3953/**
3954 * @defgroup lavc_picture AVPicture
3955 *
3956 * Functions for working with AVPicture
3957 * @{
3958 */
3959
3960/**
3961 * Picture data structure.
3962 *
3963 * Up to four components can be stored into it, the last component is
3964 * alpha.
3965 * @deprecated use AVFrame or imgutils functions instead
3966 */
3967typedef struct AVPicture {
3968 attribute_deprecated
3969 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3970 attribute_deprecated
3971 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3972} AVPicture;
3973
3974/**
3975 * @}
3976 */
3977#endif
3978
3979enum AVSubtitleType {
3980 SUBTITLE_NONE,
3981
3982 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3983
3984 /**
3985 * Plain text, the text field must be set by the decoder and is
3986 * authoritative. ass and pict fields may contain approximations.
3987 */
3988 SUBTITLE_TEXT,
3989
3990 /**
3991 * Formatted text, the ass field must be set by the decoder and is
3992 * authoritative. pict and text fields may contain approximations.
3993 */
3994 SUBTITLE_ASS,
3995};
3996
3997#define AV_SUBTITLE_FLAG_FORCED 0x00000001
3998
3999typedef struct AVSubtitleRect {
4000 int x; ///< top left corner of pict, undefined when pict is not set
4001 int y; ///< top left corner of pict, undefined when pict is not set
4002 int w; ///< width of pict, undefined when pict is not set
4003 int h; ///< height of pict, undefined when pict is not set
4004 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4005
4006#if FF_API_AVPICTURE
4007 /**
4008 * @deprecated unused
4009 */
4010 attribute_deprecated
4011 AVPicture pict;
4012#endif
4013 /**
4014 * data+linesize for the bitmap of this subtitle.
4015 * Can be set for text/ass as well once they are rendered.
4016 */
4017 uint8_t *data[4];
4018 int linesize[4];
4019
4020 enum AVSubtitleType type;
4021
4022 char *text; ///< 0 terminated plain UTF-8 text
4023
4024 /**
4025 * 0 terminated ASS/SSA compatible event line.
4026 * The presentation of this is unaffected by the other values in this
4027 * struct.
4028 */
4029 char *ass;
4030
4031 int flags;
4032} AVSubtitleRect;
4033
4034typedef struct AVSubtitle {
4035 uint16_t format; /* 0 = graphics */
4036 uint32_t start_display_time; /* relative to packet pts, in ms */
4037 uint32_t end_display_time; /* relative to packet pts, in ms */
4038 unsigned num_rects;
4039 AVSubtitleRect **rects;
4040 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4041} AVSubtitle;
4042
4043/**
4044 * This struct describes the properties of an encoded stream.
4045 *
4046 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4047 * be allocated with avcodec_parameters_alloc() and freed with
4048 * avcodec_parameters_free().
4049 */
4050typedef struct AVCodecParameters {
4051 /**
4052 * General type of the encoded data.
4053 */
4054 enum AVMediaType codec_type;
4055 /**
4056 * Specific type of the encoded data (the codec used).
4057 */
4058 enum AVCodecID codec_id;
4059 /**
4060 * Additional information about the codec (corresponds to the AVI FOURCC).
4061 */
4062 uint32_t codec_tag;
4063
4064 /**
4065 * Extra binary data needed for initializing the decoder, codec-dependent.
4066 *
4067 * Must be allocated with av_malloc() and will be freed by
4068 * avcodec_parameters_free(). The allocated size of extradata must be at
4069 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4070 * bytes zeroed.
4071 */
4072 uint8_t *extradata;
4073 /**
4074 * Size of the extradata content in bytes.
4075 */
4076 int extradata_size;
4077
4078 /**
4079 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4080 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4081 */
4082 int format;
4083
4084 /**
4085 * The average bitrate of the encoded data (in bits per second).
4086 */
4087 int64_t bit_rate;
4088
4089 /**
4090 * The number of bits per sample in the codedwords.
4091 *
4092 * This is basically the bitrate per sample. It is mandatory for a bunch of
4093 * formats to actually decode them. It's the number of bits for one sample in
4094 * the actual coded bitstream.
4095 *
4096 * This could be for example 4 for ADPCM
4097 * For PCM formats this matches bits_per_raw_sample
4098 * Can be 0
4099 */
4100 int bits_per_coded_sample;
4101
4102 /**
4103 * This is the number of valid bits in each output sample. If the
4104 * sample format has more bits, the least significant bits are additional
4105 * padding bits, which are always 0. Use right shifts to reduce the sample
4106 * to its actual size. For example, audio formats with 24 bit samples will
4107 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4108 * To get the original sample use "(int32_t)sample >> 8"."
4109 *
4110 * For ADPCM this might be 12 or 16 or similar
4111 * Can be 0
4112 */
4113 int bits_per_raw_sample;
4114
4115 /**
4116 * Codec-specific bitstream restrictions that the stream conforms to.
4117 */
4118 int profile;
4119 int level;
4120
4121 /**
4122 * Video only. The dimensions of the video frame in pixels.
4123 */
4124 int width;
4125 int height;
4126
4127 /**
4128 * Video only. The aspect ratio (width / height) which a single pixel
4129 * should have when displayed.
4130 *
4131 * When the aspect ratio is unknown / undefined, the numerator should be
4132 * set to 0 (the denominator may have any value).
4133 */
4134 AVRational sample_aspect_ratio;
4135
4136 /**
4137 * Video only. The order of the fields in interlaced video.
4138 */
4139 enum AVFieldOrder field_order;
4140
4141 /**
4142 * Video only. Additional colorspace characteristics.
4143 */
4144 enum AVColorRange color_range;
4145 enum AVColorPrimaries color_primaries;
4146 enum AVColorTransferCharacteristic color_trc;
4147 enum AVColorSpace color_space;
4148 enum AVChromaLocation chroma_location;
4149
4150 /**
4151 * Video only. Number of delayed frames.
4152 */
4153 int video_delay;
4154
4155 /**
4156 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4157 * unknown or unspecified, otherwise the number of bits set must be equal to
4158 * the channels field.
4159 */
4160 uint64_t channel_layout;
4161 /**
4162 * Audio only. The number of audio channels.
4163 */
4164 int channels;
4165 /**
4166 * Audio only. The number of audio samples per second.
4167 */
4168 int sample_rate;
4169 /**
4170 * Audio only. The number of bytes per coded audio frame, required by some
4171 * formats.
4172 *
4173 * Corresponds to nBlockAlign in WAVEFORMATEX.
4174 */
4175 int block_align;
4176 /**
4177 * Audio only. Audio frame size, if known. Required by some formats to be static.
4178 */
4179 int frame_size;
4180
4181 /**
4182 * Audio only. The amount of padding (in samples) inserted by the encoder at
4183 * the beginning of the audio. I.e. this number of leading decoded samples
4184 * must be discarded by the caller to get the original audio without leading
4185 * padding.
4186 */
4187 int initial_padding;
4188 /**
4189 * Audio only. The amount of padding (in samples) appended by the encoder to
4190 * the end of the audio. I.e. this number of decoded samples must be
4191 * discarded by the caller from the end of the stream to get the original
4192 * audio without any trailing padding.
4193 */
4194 int trailing_padding;
4195 /**
4196 * Audio only. Number of samples to skip after a discontinuity.
4197 */
4198 int seek_preroll;
4199} AVCodecParameters;
4200
4201/**
4202 * If c is NULL, returns the first registered codec,
4203 * if c is non-NULL, returns the next registered codec after c,
4204 * or NULL if c is the last one.
4205 */
4206AVCodec *av_codec_next(const AVCodec *c);
4207
4208/**
4209 * Return the LIBAVCODEC_VERSION_INT constant.
4210 */
4211unsigned avcodec_version(void);
4212
4213/**
4214 * Return the libavcodec build-time configuration.
4215 */
4216const char *avcodec_configuration(void);
4217
4218/**
4219 * Return the libavcodec license.
4220 */
4221const char *avcodec_license(void);
4222
4223/**
4224 * Register the codec codec and initialize libavcodec.
4225 *
4226 * @warning either this function or avcodec_register_all() must be called
4227 * before any other libavcodec functions.
4228 *
4229 * @see avcodec_register_all()
4230 */
4231void avcodec_register(AVCodec *codec);
4232
4233/**
4234 * Register all the codecs, parsers and bitstream filters which were enabled at
4235 * configuration time. If you do not call this function you can select exactly
4236 * which formats you want to support, by using the individual registration
4237 * functions.
4238 *
4239 * @see avcodec_register
4240 * @see av_register_codec_parser
4241 * @see av_register_bitstream_filter
4242 */
4243void avcodec_register_all(void);
4244
4245/**
4246 * Allocate an AVCodecContext and set its fields to default values. The
4247 * resulting struct should be freed with avcodec_free_context().
4248 *
4249 * @param codec if non-NULL, allocate private data and initialize defaults
4250 * for the given codec. It is illegal to then call avcodec_open2()
4251 * with a different codec.
4252 * If NULL, then the codec-specific defaults won't be initialized,
4253 * which may result in suboptimal default settings (this is
4254 * important mainly for encoders, e.g. libx264).
4255 *
4256 * @return An AVCodecContext filled with default values or NULL on failure.
4257 */
4258AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4259
4260/**
4261 * Free the codec context and everything associated with it and write NULL to
4262 * the provided pointer.
4263 */
4264void avcodec_free_context(AVCodecContext **avctx);
4265
4266#if FF_API_GET_CONTEXT_DEFAULTS
4267/**
4268 * @deprecated This function should not be used, as closing and opening a codec
4269 * context multiple time is not supported. A new codec context should be
4270 * allocated for each new use.
4271 */
4272int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4273#endif
4274
4275/**
4276 * Get the AVClass for AVCodecContext. It can be used in combination with
4277 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4278 *
4279 * @see av_opt_find().
4280 */
4281const AVClass *avcodec_get_class(void);
4282
4283#if FF_API_COPY_CONTEXT
4284/**
4285 * Get the AVClass for AVFrame. It can be used in combination with
4286 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4287 *
4288 * @see av_opt_find().
4289 */
4290const AVClass *avcodec_get_frame_class(void);
4291
4292/**
4293 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4294 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4295 *
4296 * @see av_opt_find().
4297 */
4298const AVClass *avcodec_get_subtitle_rect_class(void);
4299
4300/**
4301 * Copy the settings of the source AVCodecContext into the destination
4302 * AVCodecContext. The resulting destination codec context will be
4303 * unopened, i.e. you are required to call avcodec_open2() before you
4304 * can use this AVCodecContext to decode/encode video/audio data.
4305 *
4306 * @param dest target codec context, should be initialized with
4307 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4308 * @param src source codec context
4309 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4310 *
4311 * @deprecated The semantics of this function are ill-defined and it should not
4312 * be used. If you need to transfer the stream parameters from one codec context
4313 * to another, use an intermediate AVCodecParameters instance and the
4314 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4315 * functions.
4316 */
4317attribute_deprecated
4318int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4319#endif
4320
4321/**
4322 * Allocate a new AVCodecParameters and set its fields to default values
4323 * (unknown/invalid/0). The returned struct must be freed with
4324 * avcodec_parameters_free().
4325 */
4326AVCodecParameters *avcodec_parameters_alloc(void);
4327
4328/**
4329 * Free an AVCodecParameters instance and everything associated with it and
4330 * write NULL to the supplied pointer.
4331 */
4332void avcodec_parameters_free(AVCodecParameters **par);
4333
4334/**
4335 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4336 * replaced with newly allocated duplicates of the corresponding fields in src.
4337 *
4338 * @return >= 0 on success, a negative AVERROR code on failure.
4339 */
4340int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4341
4342/**
4343 * Fill the parameters struct based on the values from the supplied codec
4344 * context. Any allocated fields in par are freed and replaced with duplicates
4345 * of the corresponding fields in codec.
4346 *
4347 * @return >= 0 on success, a negative AVERROR code on failure
4348 */
4349int avcodec_parameters_from_context(AVCodecParameters *par,
4350 const AVCodecContext *codec);
4351
4352/**
4353 * Fill the codec context based on the values from the supplied codec
4354 * parameters. Any allocated fields in codec that have a corresponding field in
4355 * par are freed and replaced with duplicates of the corresponding field in par.
4356 * Fields in codec that do not have a counterpart in par are not touched.
4357 *
4358 * @return >= 0 on success, a negative AVERROR code on failure.
4359 */
4360int avcodec_parameters_to_context(AVCodecContext *codec,
4361 const AVCodecParameters *par);
4362
4363/**
4364 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4365 * function the context has to be allocated with avcodec_alloc_context3().
4366 *
4367 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4368 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4369 * retrieving a codec.
4370 *
4371 * @warning This function is not thread safe!
4372 *
4373 * @note Always call this function before using decoding routines (such as
4374 * @ref avcodec_receive_frame()).
4375 *
4376 * @code
4377 * avcodec_register_all();
4378 * av_dict_set(&opts, "b", "2.5M", 0);
4379 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4380 * if (!codec)
4381 * exit(1);
4382 *
4383 * context = avcodec_alloc_context3(codec);
4384 *
4385 * if (avcodec_open2(context, codec, opts) < 0)
4386 * exit(1);
4387 * @endcode
4388 *
4389 * @param avctx The context to initialize.
4390 * @param codec The codec to open this context for. If a non-NULL codec has been
4391 * previously passed to avcodec_alloc_context3() or
4392 * for this context, then this parameter MUST be either NULL or
4393 * equal to the previously passed codec.
4394 * @param options A dictionary filled with AVCodecContext and codec-private options.
4395 * On return this object will be filled with options that were not found.
4396 *
4397 * @return zero on success, a negative value on error
4398 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4399 * av_dict_set(), av_opt_find().
4400 */
4401int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4402
4403/**
4404 * Close a given AVCodecContext and free all the data associated with it
4405 * (but not the AVCodecContext itself).
4406 *
4407 * Calling this function on an AVCodecContext that hasn't been opened will free
4408 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4409 * codec. Subsequent calls will do nothing.
4410 *
4411 * @note Do not use this function. Use avcodec_free_context() to destroy a
4412 * codec context (either open or closed). Opening and closing a codec context
4413 * multiple times is not supported anymore -- use multiple codec contexts
4414 * instead.
4415 */
4416int avcodec_close(AVCodecContext *avctx);
4417
4418/**
4419 * Free all allocated data in the given subtitle struct.
4420 *
4421 * @param sub AVSubtitle to free.
4422 */
4423void avsubtitle_free(AVSubtitle *sub);
4424
4425/**
4426 * @}
4427 */
4428
4429/**
4430 * @addtogroup lavc_packet
4431 * @{
4432 */
4433
4434/**
4435 * Allocate an AVPacket and set its fields to default values. The resulting
4436 * struct must be freed using av_packet_free().
4437 *
4438 * @return An AVPacket filled with default values or NULL on failure.
4439 *
4440 * @note this only allocates the AVPacket itself, not the data buffers. Those
4441 * must be allocated through other means such as av_new_packet.
4442 *
4443 * @see av_new_packet
4444 */
4445AVPacket *av_packet_alloc(void);
4446
4447/**
4448 * Create a new packet that references the same data as src.
4449 *
4450 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4451 *
4452 * @return newly created AVPacket on success, NULL on error.
4453 *
4454 * @see av_packet_alloc
4455 * @see av_packet_ref
4456 */
4457AVPacket *av_packet_clone(const AVPacket *src);
4458
4459/**
4460 * Free the packet, if the packet is reference counted, it will be
4461 * unreferenced first.
4462 *
4463 * @param packet packet to be freed. The pointer will be set to NULL.
4464 * @note passing NULL is a no-op.
4465 */
4466void av_packet_free(AVPacket **pkt);
4467
4468/**
4469 * Initialize optional fields of a packet with default values.
4470 *
4471 * Note, this does not touch the data and size members, which have to be
4472 * initialized separately.
4473 *
4474 * @param pkt packet
4475 */
4476void av_init_packet(AVPacket *pkt);
4477
4478/**
4479 * Allocate the payload of a packet and initialize its fields with
4480 * default values.
4481 *
4482 * @param pkt packet
4483 * @param size wanted payload size
4484 * @return 0 if OK, AVERROR_xxx otherwise
4485 */
4486int av_new_packet(AVPacket *pkt, int size);
4487
4488/**
4489 * Reduce packet size, correctly zeroing padding
4490 *
4491 * @param pkt packet
4492 * @param size new size
4493 */
4494void av_shrink_packet(AVPacket *pkt, int size);
4495
4496/**
4497 * Increase packet size, correctly zeroing padding
4498 *
4499 * @param pkt packet
4500 * @param grow_by number of bytes by which to increase the size of the packet
4501 */
4502int av_grow_packet(AVPacket *pkt, int grow_by);
4503
4504/**
4505 * Initialize a reference-counted packet from av_malloc()ed data.
4506 *
4507 * @param pkt packet to be initialized. This function will set the data, size,
4508 * buf and destruct fields, all others are left untouched.
4509 * @param data Data allocated by av_malloc() to be used as packet data. If this
4510 * function returns successfully, the data is owned by the underlying AVBuffer.
4511 * The caller may not access the data through other means.
4512 * @param size size of data in bytes, without the padding. I.e. the full buffer
4513 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4514 *
4515 * @return 0 on success, a negative AVERROR on error
4516 */
4517int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4518
4519#if FF_API_AVPACKET_OLD_API
4520/**
4521 * @warning This is a hack - the packet memory allocation stuff is broken. The
4522 * packet is allocated if it was not really allocated.
4523 *
4524 * @deprecated Use av_packet_ref
4525 */
4526attribute_deprecated
4527int av_dup_packet(AVPacket *pkt);
4528/**
4529 * Copy packet, including contents
4530 *
4531 * @return 0 on success, negative AVERROR on fail
4532 */
4533int av_copy_packet(AVPacket *dst, const AVPacket *src);
4534
4535/**
4536 * Copy packet side data
4537 *
4538 * @return 0 on success, negative AVERROR on fail
4539 */
4540int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4541
4542/**
4543 * Free a packet.
4544 *
4545 * @deprecated Use av_packet_unref
4546 *
4547 * @param pkt packet to free
4548 */
4549attribute_deprecated
4550void av_free_packet(AVPacket *pkt);
4551#endif
4552/**
4553 * Allocate new information of a packet.
4554 *
4555 * @param pkt packet
4556 * @param type side information type
4557 * @param size side information size
4558 * @return pointer to fresh allocated data or NULL otherwise
4559 */
4560uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4561 int size);
4562
4563/**
4564 * Wrap an existing array as a packet side data.
4565 *
4566 * @param pkt packet
4567 * @param type side information type
4568 * @param data the side data array. It must be allocated with the av_malloc()
4569 * family of functions. The ownership of the data is transferred to
4570 * pkt.
4571 * @param size side information size
4572 * @return a non-negative number on success, a negative AVERROR code on
4573 * failure. On failure, the packet is unchanged and the data remains
4574 * owned by the caller.
4575 */
4576int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4577 uint8_t *data, size_t size);
4578
4579/**
4580 * Shrink the already allocated side data buffer
4581 *
4582 * @param pkt packet
4583 * @param type side information type
4584 * @param size new side information size
4585 * @return 0 on success, < 0 on failure
4586 */
4587int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4588 int size);
4589
4590/**
4591 * Get side information from packet.
4592 *
4593 * @param pkt packet
4594 * @param type desired side information type
4595 * @param size pointer for side information size to store (optional)
4596 * @return pointer to data if present or NULL otherwise
4597 */
4598uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4599 int *size);
4600
4601#if FF_API_MERGE_SD_API
4602attribute_deprecated
4603int av_packet_merge_side_data(AVPacket *pkt);
4604
4605attribute_deprecated
4606int av_packet_split_side_data(AVPacket *pkt);
4607#endif
4608
4609const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4610
4611/**
4612 * Pack a dictionary for use in side_data.
4613 *
4614 * @param dict The dictionary to pack.
4615 * @param size pointer to store the size of the returned data
4616 * @return pointer to data if successful, NULL otherwise
4617 */
4618uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4619/**
4620 * Unpack a dictionary from side_data.
4621 *
4622 * @param data data from side_data
4623 * @param size size of the data
4624 * @param dict the metadata storage dictionary
4625 * @return 0 on success, < 0 on failure
4626 */
4627int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4628
4629
4630/**
4631 * Convenience function to free all the side data stored.
4632 * All the other fields stay untouched.
4633 *
4634 * @param pkt packet
4635 */
4636void av_packet_free_side_data(AVPacket *pkt);
4637
4638/**
4639 * Setup a new reference to the data described by a given packet
4640 *
4641 * If src is reference-counted, setup dst as a new reference to the
4642 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4643 * data from src into it.
4644 *
4645 * All the other fields are copied from src.
4646 *
4647 * @see av_packet_unref
4648 *
4649 * @param dst Destination packet
4650 * @param src Source packet
4651 *
4652 * @return 0 on success, a negative AVERROR on error.
4653 */
4654int av_packet_ref(AVPacket *dst, const AVPacket *src);
4655
4656/**
4657 * Wipe the packet.
4658 *
4659 * Unreference the buffer referenced by the packet and reset the
4660 * remaining packet fields to their default values.
4661 *
4662 * @param pkt The packet to be unreferenced.
4663 */
4664void av_packet_unref(AVPacket *pkt);
4665
4666/**
4667 * Move every field in src to dst and reset src.
4668 *
4669 * @see av_packet_unref
4670 *
4671 * @param src Source packet, will be reset
4672 * @param dst Destination packet
4673 */
4674void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4675
4676/**
4677 * Copy only "properties" fields from src to dst.
4678 *
4679 * Properties for the purpose of this function are all the fields
4680 * beside those related to the packet data (buf, data, size)
4681 *
4682 * @param dst Destination packet
4683 * @param src Source packet
4684 *
4685 * @return 0 on success AVERROR on failure.
4686 */
4687int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4688
4689/**
4690 * Convert valid timing fields (timestamps / durations) in a packet from one
4691 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4692 * ignored.
4693 *
4694 * @param pkt packet on which the conversion will be performed
4695 * @param tb_src source timebase, in which the timing fields in pkt are
4696 * expressed
4697 * @param tb_dst destination timebase, to which the timing fields will be
4698 * converted
4699 */
4700void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4701
4702/**
4703 * @}
4704 */
4705
4706/**
4707 * @addtogroup lavc_decoding
4708 * @{
4709 */
4710
4711/**
4712 * Find a registered decoder with a matching codec ID.
4713 *
4714 * @param id AVCodecID of the requested decoder
4715 * @return A decoder if one was found, NULL otherwise.
4716 */
4717AVCodec *avcodec_find_decoder(enum AVCodecID id);
4718
4719/**
4720 * Find a registered decoder with the specified name.
4721 *
4722 * @param name name of the requested decoder
4723 * @return A decoder if one was found, NULL otherwise.
4724 */
4725AVCodec *avcodec_find_decoder_by_name(const char *name);
4726
4727/**
4728 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4729 * it can be called by custom get_buffer2() implementations for decoders without
4730 * AV_CODEC_CAP_DR1 set.
4731 */
4732int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4733
4734#if FF_API_EMU_EDGE
4735/**
4736 * Return the amount of padding in pixels which the get_buffer callback must
4737 * provide around the edge of the image for codecs which do not have the
4738 * CODEC_FLAG_EMU_EDGE flag.
4739 *
4740 * @return Required padding in pixels.
4741 *
4742 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4743 * needed
4744 */
4745attribute_deprecated
4746unsigned avcodec_get_edge_width(void);
4747#endif
4748
4749/**
4750 * Modify width and height values so that they will result in a memory
4751 * buffer that is acceptable for the codec if you do not use any horizontal
4752 * padding.
4753 *
4754 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4755 */
4756void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4757
4758/**
4759 * Modify width and height values so that they will result in a memory
4760 * buffer that is acceptable for the codec if you also ensure that all
4761 * line sizes are a multiple of the respective linesize_align[i].
4762 *
4763 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4764 */
4765void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4766 int linesize_align[AV_NUM_DATA_POINTERS]);
4767
4768/**
4769 * Converts AVChromaLocation to swscale x/y chroma position.
4770 *
4771 * The positions represent the chroma (0,0) position in a coordinates system
4772 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4773 *
4774 * @param xpos horizontal chroma sample position
4775 * @param ypos vertical chroma sample position
4776 */
4777int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4778
4779/**
4780 * Converts swscale x/y chroma position to AVChromaLocation.
4781 *
4782 * The positions represent the chroma (0,0) position in a coordinates system
4783 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4784 *
4785 * @param xpos horizontal chroma sample position
4786 * @param ypos vertical chroma sample position
4787 */
4788enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4789
4790/**
4791 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4792 *
4793 * Some decoders may support multiple frames in a single AVPacket. Such
4794 * decoders would then just decode the first frame and the return value would be
4795 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4796 * called again with an AVPacket containing the remaining data in order to
4797 * decode the second frame, etc... Even if no frames are returned, the packet
4798 * needs to be fed to the decoder with remaining data until it is completely
4799 * consumed or an error occurs.
4800 *
4801 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4802 * and output. This means that for some packets they will not immediately
4803 * produce decoded output and need to be flushed at the end of decoding to get
4804 * all the decoded data. Flushing is done by calling this function with packets
4805 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4806 * returning samples. It is safe to flush even those decoders that are not
4807 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4808 *
4809 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4810 * larger than the actual read bytes because some optimized bitstream
4811 * readers read 32 or 64 bits at once and could read over the end.
4812 *
4813 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4814 * before packets may be fed to the decoder.
4815 *
4816 * @param avctx the codec context
4817 * @param[out] frame The AVFrame in which to store decoded audio samples.
4818 * The decoder will allocate a buffer for the decoded frame by
4819 * calling the AVCodecContext.get_buffer2() callback.
4820 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4821 * reference counted and the returned reference belongs to the
4822 * caller. The caller must release the frame using av_frame_unref()
4823 * when the frame is no longer needed. The caller may safely write
4824 * to the frame if av_frame_is_writable() returns 1.
4825 * When AVCodecContext.refcounted_frames is set to 0, the returned
4826 * reference belongs to the decoder and is valid only until the
4827 * next call to this function or until closing or flushing the
4828 * decoder. The caller may not write to it.
4829 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4830 * non-zero. Note that this field being set to zero
4831 * does not mean that an error has occurred. For
4832 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4833 * call is guaranteed to produce a frame.
4834 * @param[in] avpkt The input AVPacket containing the input buffer.
4835 * At least avpkt->data and avpkt->size should be set. Some
4836 * decoders might also require additional fields to be set.
4837 * @return A negative error code is returned if an error occurred during
4838 * decoding, otherwise the number of bytes consumed from the input
4839 * AVPacket is returned.
4840 *
4841* @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4842 */
4843attribute_deprecated
4844int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4845 int *got_frame_ptr, const AVPacket *avpkt);
4846
4847/**
4848 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4849 * Some decoders may support multiple frames in a single AVPacket, such
4850 * decoders would then just decode the first frame.
4851 *
4852 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4853 * the actual read bytes because some optimized bitstream readers read 32 or 64
4854 * bits at once and could read over the end.
4855 *
4856 * @warning The end of the input buffer buf should be set to 0 to ensure that
4857 * no overreading happens for damaged MPEG streams.
4858 *
4859 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4860 * between input and output, these need to be fed with avpkt->data=NULL,
4861 * avpkt->size=0 at the end to return the remaining frames.
4862 *
4863 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4864 * before packets may be fed to the decoder.
4865 *
4866 * @param avctx the codec context
4867 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4868 * Use av_frame_alloc() to get an AVFrame. The codec will
4869 * allocate memory for the actual bitmap by calling the
4870 * AVCodecContext.get_buffer2() callback.
4871 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4872 * reference counted and the returned reference belongs to the
4873 * caller. The caller must release the frame using av_frame_unref()
4874 * when the frame is no longer needed. The caller may safely write
4875 * to the frame if av_frame_is_writable() returns 1.
4876 * When AVCodecContext.refcounted_frames is set to 0, the returned
4877 * reference belongs to the decoder and is valid only until the
4878 * next call to this function or until closing or flushing the
4879 * decoder. The caller may not write to it.
4880 *
4881 * @param[in] avpkt The input AVPacket containing the input buffer.
4882 * You can create such packet with av_init_packet() and by then setting
4883 * data and size, some decoders might in addition need other fields like
4884 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4885 * fields possible.
4886 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4887 * @return On error a negative value is returned, otherwise the number of bytes
4888 * used or zero if no frame could be decompressed.
4889 *
4890 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4891 */
4892attribute_deprecated
4893int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4894 int *got_picture_ptr,
4895 const AVPacket *avpkt);
4896
4897/**
4898 * Decode a subtitle message.
4899 * Return a negative value on error, otherwise return the number of bytes used.
4900 * If no subtitle could be decompressed, got_sub_ptr is zero.
4901 * Otherwise, the subtitle is stored in *sub.
4902 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4903 * simplicity, because the performance difference is expect to be negligible
4904 * and reusing a get_buffer written for video codecs would probably perform badly
4905 * due to a potentially very different allocation pattern.
4906 *
4907 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4908 * and output. This means that for some packets they will not immediately
4909 * produce decoded output and need to be flushed at the end of decoding to get
4910 * all the decoded data. Flushing is done by calling this function with packets
4911 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4912 * returning subtitles. It is safe to flush even those decoders that are not
4913 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4914 *
4915 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4916 * before packets may be fed to the decoder.
4917 *
4918 * @param avctx the codec context
4919 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4920 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4921 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4922 * @param[in] avpkt The input AVPacket containing the input buffer.
4923 */
4924int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4925 int *got_sub_ptr,
4926 AVPacket *avpkt);
4927
4928/**
4929 * Supply raw packet data as input to a decoder.
4930 *
4931 * Internally, this call will copy relevant AVCodecContext fields, which can
4932 * influence decoding per-packet, and apply them when the packet is actually
4933 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4934 * decoder to drop the frame contained by the packet sent with this function.)
4935 *
4936 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4937 * larger than the actual read bytes because some optimized bitstream
4938 * readers read 32 or 64 bits at once and could read over the end.
4939 *
4940 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4941 * on the same AVCodecContext. It will return unexpected results now
4942 * or in future libavcodec versions.
4943 *
4944 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4945 * before packets may be fed to the decoder.
4946 *
4947 * @param avctx codec context
4948 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4949 * frame, or several complete audio frames.
4950 * Ownership of the packet remains with the caller, and the
4951 * decoder will not write to the packet. The decoder may create
4952 * a reference to the packet data (or copy it if the packet is
4953 * not reference-counted).
4954 * Unlike with older APIs, the packet is always fully consumed,
4955 * and if it contains multiple frames (e.g. some audio codecs),
4956 * will require you to call avcodec_receive_frame() multiple
4957 * times afterwards before you can send a new packet.
4958 * It can be NULL (or an AVPacket with data set to NULL and
4959 * size set to 0); in this case, it is considered a flush
4960 * packet, which signals the end of the stream. Sending the
4961 * first flush packet will return success. Subsequent ones are
4962 * unnecessary and will return AVERROR_EOF. If the decoder
4963 * still has frames buffered, it will return them after sending
4964 * a flush packet.
4965 *
4966 * @return 0 on success, otherwise negative error code:
4967 * AVERROR(EAGAIN): input is not accepted in the current state - user
4968 * must read output with avcodec_receive_frame() (once
4969 * all output is read, the packet should be resent, and
4970 * the call will not fail with EAGAIN).
4971 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4972 * be sent to it (also returned if more than 1 flush
4973 * packet is sent)
4974 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4975 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4976 * other errors: legitimate decoding errors
4977 */
4978int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4979
4980/**
4981 * Return decoded output data from a decoder.
4982 *
4983 * @param avctx codec context
4984 * @param frame This will be set to a reference-counted video or audio
4985 * frame (depending on the decoder type) allocated by the
4986 * decoder. Note that the function will always call
4987 * av_frame_unref(frame) before doing anything else.
4988 *
4989 * @return
4990 * 0: success, a frame was returned
4991 * AVERROR(EAGAIN): output is not available in this state - user must try
4992 * to send new input
4993 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4994 * no more output frames
4995 * AVERROR(EINVAL): codec not opened, or it is an encoder
4996 * other negative values: legitimate decoding errors
4997 */
4998int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4999
5000/**
5001 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5002 * to retrieve buffered output packets.
5003 *
5004 * @param avctx codec context
5005 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5006 * Ownership of the frame remains with the caller, and the
5007 * encoder will not write to the frame. The encoder may create
5008 * a reference to the frame data (or copy it if the frame is
5009 * not reference-counted).
5010 * It can be NULL, in which case it is considered a flush
5011 * packet. This signals the end of the stream. If the encoder
5012 * still has packets buffered, it will return them after this
5013 * call. Once flushing mode has been entered, additional flush
5014 * packets are ignored, and sending frames will return
5015 * AVERROR_EOF.
5016 *
5017 * For audio:
5018 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5019 * can have any number of samples.
5020 * If it is not set, frame->nb_samples must be equal to
5021 * avctx->frame_size for all frames except the last.
5022 * The final frame may be smaller than avctx->frame_size.
5023 * @return 0 on success, otherwise negative error code:
5024 * AVERROR(EAGAIN): input is not accepted in the current state - user
5025 * must read output with avcodec_receive_packet() (once
5026 * all output is read, the packet should be resent, and
5027 * the call will not fail with EAGAIN).
5028 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5029 * be sent to it
5030 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5031 * decoder, or requires flush
5032 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5033 * other errors: legitimate decoding errors
5034 */
5035int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5036
5037/**
5038 * Read encoded data from the encoder.
5039 *
5040 * @param avctx codec context
5041 * @param avpkt This will be set to a reference-counted packet allocated by the
5042 * encoder. Note that the function will always call
5043 * av_frame_unref(frame) before doing anything else.
5044 * @return 0 on success, otherwise negative error code:
5045 * AVERROR(EAGAIN): output is not available in the current state - user
5046 * must try to send input
5047 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5048 * no more output packets
5049 * AVERROR(EINVAL): codec not opened, or it is an encoder
5050 * other errors: legitimate decoding errors
5051 */
5052int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5053
5054
5055/**
5056 * @defgroup lavc_parsing Frame parsing
5057 * @{
5058 */
5059
5060enum AVPictureStructure {
5061 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5062 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5063 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5064 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5065};
5066
5067typedef struct AVCodecParserContext {
5068 void *priv_data;
5069 struct AVCodecParser *parser;
5070 int64_t frame_offset; /* offset of the current frame */
5071 int64_t cur_offset; /* current offset
5072 (incremented by each av_parser_parse()) */
5073 int64_t next_frame_offset; /* offset of the next frame */
5074 /* video info */
5075 int pict_type; /* XXX: Put it back in AVCodecContext. */
5076 /**
5077 * This field is used for proper frame duration computation in lavf.
5078 * It signals, how much longer the frame duration of the current frame
5079 * is compared to normal frame duration.
5080 *
5081 * frame_duration = (1 + repeat_pict) * time_base
5082 *
5083 * It is used by codecs like H.264 to display telecined material.
5084 */
5085 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5086 int64_t pts; /* pts of the current frame */
5087 int64_t dts; /* dts of the current frame */
5088
5089 /* private data */
5090 int64_t last_pts;
5091 int64_t last_dts;
5092 int fetch_timestamp;
5093
5094#define AV_PARSER_PTS_NB 4
5095 int cur_frame_start_index;
5096 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5097 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5098 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5099
5100 int flags;
5101#define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5102#define PARSER_FLAG_ONCE 0x0002
5103/// Set if the parser has a valid file offset
5104#define PARSER_FLAG_FETCHED_OFFSET 0x0004
5105#define PARSER_FLAG_USE_CODEC_TS 0x1000
5106
5107 int64_t offset; ///< byte offset from starting packet start
5108 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5109
5110 /**
5111 * Set by parser to 1 for key frames and 0 for non-key frames.
5112 * It is initialized to -1, so if the parser doesn't set this flag,
5113 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5114 * will be used.
5115 */
5116 int key_frame;
5117
5118#if FF_API_CONVERGENCE_DURATION
5119 /**
5120 * @deprecated unused
5121 */
5122 attribute_deprecated
5123 int64_t convergence_duration;
5124#endif
5125
5126 // Timestamp generation support:
5127 /**
5128 * Synchronization point for start of timestamp generation.
5129 *
5130 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5131 * (default).
5132 *
5133 * For example, this corresponds to presence of H.264 buffering period
5134 * SEI message.
5135 */
5136 int dts_sync_point;
5137
5138 /**
5139 * Offset of the current timestamp against last timestamp sync point in
5140 * units of AVCodecContext.time_base.
5141 *
5142 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5143 * contain a valid timestamp offset.
5144 *
5145 * Note that the timestamp of sync point has usually a nonzero
5146 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5147 * the next frame after timestamp sync point will be usually 1.
5148 *
5149 * For example, this corresponds to H.264 cpb_removal_delay.
5150 */
5151 int dts_ref_dts_delta;
5152
5153 /**
5154 * Presentation delay of current frame in units of AVCodecContext.time_base.
5155 *
5156 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5157 * contain valid non-negative timestamp delta (presentation time of a frame
5158 * must not lie in the past).
5159 *
5160 * This delay represents the difference between decoding and presentation
5161 * time of the frame.
5162 *
5163 * For example, this corresponds to H.264 dpb_output_delay.
5164 */
5165 int pts_dts_delta;
5166
5167 /**
5168 * Position of the packet in file.
5169 *
5170 * Analogous to cur_frame_pts/dts
5171 */
5172 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5173
5174 /**
5175 * Byte position of currently parsed frame in stream.
5176 */
5177 int64_t pos;
5178
5179 /**
5180 * Previous frame byte position.
5181 */
5182 int64_t last_pos;
5183
5184 /**
5185 * Duration of the current frame.
5186 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5187 * For all other types, this is in units of AVCodecContext.time_base.
5188 */
5189 int duration;
5190
5191 enum AVFieldOrder field_order;
5192
5193 /**
5194 * Indicate whether a picture is coded as a frame, top field or bottom field.
5195 *
5196 * For example, H.264 field_pic_flag equal to 0 corresponds to
5197 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5198 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5199 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5200 */
5201 enum AVPictureStructure picture_structure;
5202
5203 /**
5204 * Picture number incremented in presentation or output order.
5205 * This field may be reinitialized at the first picture of a new sequence.
5206 *
5207 * For example, this corresponds to H.264 PicOrderCnt.
5208 */
5209 int output_picture_number;
5210
5211 /**
5212 * Dimensions of the decoded video intended for presentation.
5213 */
5214 int width;
5215 int height;
5216
5217 /**
5218 * Dimensions of the coded video.
5219 */
5220 int coded_width;
5221 int coded_height;
5222
5223 /**
5224 * The format of the coded data, corresponds to enum AVPixelFormat for video
5225 * and for enum AVSampleFormat for audio.
5226 *
5227 * Note that a decoder can have considerable freedom in how exactly it
5228 * decodes the data, so the format reported here might be different from the
5229 * one returned by a decoder.
5230 */
5231 int format;
5232} AVCodecParserContext;
5233
5234typedef struct AVCodecParser {
5235 int codec_ids[5]; /* several codec IDs are permitted */
5236 int priv_data_size;
5237 int (*parser_init)(AVCodecParserContext *s);
5238 /* This callback never returns an error, a negative value means that
5239 * the frame start was in a previous packet. */
5240 int (*parser_parse)(AVCodecParserContext *s,
5241 AVCodecContext *avctx,
5242 const uint8_t **poutbuf, int *poutbuf_size,
5243 const uint8_t *buf, int buf_size);
5244 void (*parser_close)(AVCodecParserContext *s);
5245 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5246 struct AVCodecParser *next;
5247} AVCodecParser;
5248
5249AVCodecParser *av_parser_next(const AVCodecParser *c);
5250
5251void av_register_codec_parser(AVCodecParser *parser);
5252AVCodecParserContext *av_parser_init(int codec_id);
5253
5254/**
5255 * Parse a packet.
5256 *
5257 * @param s parser context.
5258 * @param avctx codec context.
5259 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5260 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5261 * @param buf input buffer.
5262 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5263 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5264 To signal EOF, this should be 0 (so that the last frame
5265 can be output).
5266 * @param pts input presentation timestamp.
5267 * @param dts input decoding timestamp.
5268 * @param pos input byte position in stream.
5269 * @return the number of bytes of the input bitstream used.
5270 *
5271 * Example:
5272 * @code
5273 * while(in_len){
5274 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5275 * in_data, in_len,
5276 * pts, dts, pos);
5277 * in_data += len;
5278 * in_len -= len;
5279 *
5280 * if(size)
5281 * decode_frame(data, size);
5282 * }
5283 * @endcode
5284 */
5285int av_parser_parse2(AVCodecParserContext *s,
5286 AVCodecContext *avctx,
5287 uint8_t **poutbuf, int *poutbuf_size,
5288 const uint8_t *buf, int buf_size,
5289 int64_t pts, int64_t dts,
5290 int64_t pos);
5291
5292/**
5293 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5294 * @deprecated use AVBitStreamFilter
5295 */
5296int av_parser_change(AVCodecParserContext *s,
5297 AVCodecContext *avctx,
5298 uint8_t **poutbuf, int *poutbuf_size,
5299 const uint8_t *buf, int buf_size, int keyframe);
5300void av_parser_close(AVCodecParserContext *s);
5301
5302/**
5303 * @}
5304 * @}
5305 */
5306
5307/**
5308 * @addtogroup lavc_encoding
5309 * @{
5310 */
5311
5312/**
5313 * Find a registered encoder with a matching codec ID.
5314 *
5315 * @param id AVCodecID of the requested encoder
5316 * @return An encoder if one was found, NULL otherwise.
5317 */
5318AVCodec *avcodec_find_encoder(enum AVCodecID id);
5319
5320/**
5321 * Find a registered encoder with the specified name.
5322 *
5323 * @param name name of the requested encoder
5324 * @return An encoder if one was found, NULL otherwise.
5325 */
5326AVCodec *avcodec_find_encoder_by_name(const char *name);
5327
5328/**
5329 * Encode a frame of audio.
5330 *
5331 * Takes input samples from frame and writes the next output packet, if
5332 * available, to avpkt. The output packet does not necessarily contain data for
5333 * the most recent frame, as encoders can delay, split, and combine input frames
5334 * internally as needed.
5335 *
5336 * @param avctx codec context
5337 * @param avpkt output AVPacket.
5338 * The user can supply an output buffer by setting
5339 * avpkt->data and avpkt->size prior to calling the
5340 * function, but if the size of the user-provided data is not
5341 * large enough, encoding will fail. If avpkt->data and
5342 * avpkt->size are set, avpkt->destruct must also be set. All
5343 * other AVPacket fields will be reset by the encoder using
5344 * av_init_packet(). If avpkt->data is NULL, the encoder will
5345 * allocate it. The encoder will set avpkt->size to the size
5346 * of the output packet.
5347 *
5348 * If this function fails or produces no output, avpkt will be
5349 * freed using av_packet_unref().
5350 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5351 * May be NULL when flushing an encoder that has the
5352 * AV_CODEC_CAP_DELAY capability set.
5353 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5354 * can have any number of samples.
5355 * If it is not set, frame->nb_samples must be equal to
5356 * avctx->frame_size for all frames except the last.
5357 * The final frame may be smaller than avctx->frame_size.
5358 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5359 * output packet is non-empty, and to 0 if it is
5360 * empty. If the function returns an error, the
5361 * packet can be assumed to be invalid, and the
5362 * value of got_packet_ptr is undefined and should
5363 * not be used.
5364 * @return 0 on success, negative error code on failure
5365 *
5366 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5367 */
5368attribute_deprecated
5369int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5370 const AVFrame *frame, int *got_packet_ptr);
5371
5372/**
5373 * Encode a frame of video.
5374 *
5375 * Takes input raw video data from frame and writes the next output packet, if
5376 * available, to avpkt. The output packet does not necessarily contain data for
5377 * the most recent frame, as encoders can delay and reorder input frames
5378 * internally as needed.
5379 *
5380 * @param avctx codec context
5381 * @param avpkt output AVPacket.
5382 * The user can supply an output buffer by setting
5383 * avpkt->data and avpkt->size prior to calling the
5384 * function, but if the size of the user-provided data is not
5385 * large enough, encoding will fail. All other AVPacket fields
5386 * will be reset by the encoder using av_init_packet(). If
5387 * avpkt->data is NULL, the encoder will allocate it.
5388 * The encoder will set avpkt->size to the size of the
5389 * output packet. The returned data (if any) belongs to the
5390 * caller, he is responsible for freeing it.
5391 *
5392 * If this function fails or produces no output, avpkt will be
5393 * freed using av_packet_unref().
5394 * @param[in] frame AVFrame containing the raw video data to be encoded.
5395 * May be NULL when flushing an encoder that has the
5396 * AV_CODEC_CAP_DELAY capability set.
5397 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5398 * output packet is non-empty, and to 0 if it is
5399 * empty. If the function returns an error, the
5400 * packet can be assumed to be invalid, and the
5401 * value of got_packet_ptr is undefined and should
5402 * not be used.
5403 * @return 0 on success, negative error code on failure
5404 *
5405 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5406 */
5407attribute_deprecated
5408int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5409 const AVFrame *frame, int *got_packet_ptr);
5410
5411int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5412 const AVSubtitle *sub);
5413
5414
5415/**
5416 * @}
5417 */
5418
5419#if FF_API_AVCODEC_RESAMPLE
5420/**
5421 * @defgroup lavc_resample Audio resampling
5422 * @ingroup libavc
5423 * @deprecated use libswresample instead
5424 *
5425 * @{
5426 */
5427struct ReSampleContext;
5428struct AVResampleContext;
5429
5430typedef struct ReSampleContext ReSampleContext;
5431
5432/**
5433 * Initialize audio resampling context.
5434 *
5435 * @param output_channels number of output channels
5436 * @param input_channels number of input channels
5437 * @param output_rate output sample rate
5438 * @param input_rate input sample rate
5439 * @param sample_fmt_out requested output sample format
5440 * @param sample_fmt_in input sample format
5441 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5442 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5443 * @param linear if 1 then the used FIR filter will be linearly interpolated
5444 between the 2 closest, if 0 the closest will be used
5445 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5446 * @return allocated ReSampleContext, NULL if error occurred
5447 */
5448attribute_deprecated
5449ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5450 int output_rate, int input_rate,
5451 enum AVSampleFormat sample_fmt_out,
5452 enum AVSampleFormat sample_fmt_in,
5453 int filter_length, int log2_phase_count,
5454 int linear, double cutoff);
5455
5456attribute_deprecated
5457int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5458
5459/**
5460 * Free resample context.
5461 *
5462 * @param s a non-NULL pointer to a resample context previously
5463 * created with av_audio_resample_init()
5464 */
5465attribute_deprecated
5466void audio_resample_close(ReSampleContext *s);
5467
5468
5469/**
5470 * Initialize an audio resampler.
5471 * Note, if either rate is not an integer then simply scale both rates up so they are.
5472 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5473 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5474 * @param linear If 1 then the used FIR filter will be linearly interpolated
5475 between the 2 closest, if 0 the closest will be used
5476 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5477 */
5478attribute_deprecated
5479struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5480
5481/**
5482 * Resample an array of samples using a previously configured context.
5483 * @param src an array of unconsumed samples
5484 * @param consumed the number of samples of src which have been consumed are returned here
5485 * @param src_size the number of unconsumed samples available
5486 * @param dst_size the amount of space in samples available in dst
5487 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5488 * @return the number of samples written in dst or -1 if an error occurred
5489 */
5490attribute_deprecated
5491int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5492
5493
5494/**
5495 * Compensate samplerate/timestamp drift. The compensation is done by changing
5496 * the resampler parameters, so no audible clicks or similar distortions occur
5497 * @param compensation_distance distance in output samples over which the compensation should be performed
5498 * @param sample_delta number of output samples which should be output less
5499 *
5500 * example: av_resample_compensate(c, 10, 500)
5501 * here instead of 510 samples only 500 samples would be output
5502 *
5503 * note, due to rounding the actual compensation might be slightly different,
5504 * especially if the compensation_distance is large and the in_rate used during init is small
5505 */
5506attribute_deprecated
5507void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5508attribute_deprecated
5509void av_resample_close(struct AVResampleContext *c);
5510
5511/**
5512 * @}
5513 */
5514#endif
5515
5516#if FF_API_AVPICTURE
5517/**
5518 * @addtogroup lavc_picture
5519 * @{
5520 */
5521
5522/**
5523 * @deprecated unused
5524 */
5525attribute_deprecated
5526int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5527
5528/**
5529 * @deprecated unused
5530 */
5531attribute_deprecated
5532void avpicture_free(AVPicture *picture);
5533
5534/**
5535 * @deprecated use av_image_fill_arrays() instead.
5536 */
5537attribute_deprecated
5538int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5539 enum AVPixelFormat pix_fmt, int width, int height);
5540
5541/**
5542 * @deprecated use av_image_copy_to_buffer() instead.
5543 */
5544attribute_deprecated
5545int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5546 int width, int height,
5547 unsigned char *dest, int dest_size);
5548
5549/**
5550 * @deprecated use av_image_get_buffer_size() instead.
5551 */
5552attribute_deprecated
5553int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5554
5555/**
5556 * @deprecated av_image_copy() instead.
5557 */
5558attribute_deprecated
5559void av_picture_copy(AVPicture *dst, const AVPicture *src,
5560 enum AVPixelFormat pix_fmt, int width, int height);
5561
5562/**
5563 * @deprecated unused
5564 */
5565attribute_deprecated
5566int av_picture_crop(AVPicture *dst, const AVPicture *src,
5567 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5568
5569/**
5570 * @deprecated unused
5571 */
5572attribute_deprecated
5573int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5574 int padtop, int padbottom, int padleft, int padright, int *color);
5575
5576/**
5577 * @}
5578 */
5579#endif
5580
5581/**
5582 * @defgroup lavc_misc Utility functions
5583 * @ingroup libavc
5584 *
5585 * Miscellaneous utility functions related to both encoding and decoding
5586 * (or neither).
5587 * @{
5588 */
5589
5590/**
5591 * @defgroup lavc_misc_pixfmt Pixel formats
5592 *
5593 * Functions for working with pixel formats.
5594 * @{
5595 */
5596
5597/**
5598 * Utility function to access log2_chroma_w log2_chroma_h from
5599 * the pixel format AVPixFmtDescriptor.
5600 *
5601 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5602 * for one that returns a failure code and continues in case of invalid
5603 * pix_fmts.
5604 *
5605 * @param[in] pix_fmt the pixel format
5606 * @param[out] h_shift store log2_chroma_w
5607 * @param[out] v_shift store log2_chroma_h
5608 *
5609 * @see av_pix_fmt_get_chroma_sub_sample
5610 */
5611
5612void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5613
5614/**
5615 * Return a value representing the fourCC code associated to the
5616 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5617 * found.
5618 */
5619unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5620
5621/**
5622 * @deprecated see av_get_pix_fmt_loss()
5623 */
5624int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5625 int has_alpha);
5626
5627/**
5628 * Find the best pixel format to convert to given a certain source pixel
5629 * format. When converting from one pixel format to another, information loss
5630 * may occur. For example, when converting from RGB24 to GRAY, the color
5631 * information will be lost. Similarly, other losses occur when converting from
5632 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5633 * the given pixel formats should be used to suffer the least amount of loss.
5634 * The pixel formats from which it chooses one, are determined by the
5635 * pix_fmt_list parameter.
5636 *
5637 *
5638 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5639 * @param[in] src_pix_fmt source pixel format
5640 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5641 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5642 * @return The best pixel format to convert to or -1 if none was found.
5643 */
5644enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5645 enum AVPixelFormat src_pix_fmt,
5646 int has_alpha, int *loss_ptr);
5647
5648/**
5649 * @deprecated see av_find_best_pix_fmt_of_2()
5650 */
5651enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5652 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5653
5654attribute_deprecated
5655enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5656 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5657
5658enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5659
5660/**
5661 * @}
5662 */
5663
5664#if FF_API_SET_DIMENSIONS
5665/**
5666 * @deprecated this function is not supposed to be used from outside of lavc
5667 */
5668attribute_deprecated
5669void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5670#endif
5671
5672#if FF_API_TAG_STRING
5673/**
5674 * Put a string representing the codec tag codec_tag in buf.
5675 *
5676 * @param buf buffer to place codec tag in
5677 * @param buf_size size in bytes of buf
5678 * @param codec_tag codec tag to assign
5679 * @return the length of the string that would have been generated if
5680 * enough space had been available, excluding the trailing null
5681 *
5682 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5683 */
5684attribute_deprecated
5685size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5686#endif
5687
5688void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5689
5690/**
5691 * Return a name for the specified profile, if available.
5692 *
5693 * @param codec the codec that is searched for the given profile
5694 * @param profile the profile value for which a name is requested
5695 * @return A name for the profile if found, NULL otherwise.
5696 */
5697const char *av_get_profile_name(const AVCodec *codec, int profile);
5698
5699/**
5700 * Return a name for the specified profile, if available.
5701 *
5702 * @param codec_id the ID of the codec to which the requested profile belongs
5703 * @param profile the profile value for which a name is requested
5704 * @return A name for the profile if found, NULL otherwise.
5705 *
5706 * @note unlike av_get_profile_name(), which searches a list of profiles
5707 * supported by a specific decoder or encoder implementation, this
5708 * function searches the list of profiles from the AVCodecDescriptor
5709 */
5710const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5711
5712int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5713int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5714//FIXME func typedef
5715
5716/**
5717 * Fill AVFrame audio data and linesize pointers.
5718 *
5719 * The buffer buf must be a preallocated buffer with a size big enough
5720 * to contain the specified samples amount. The filled AVFrame data
5721 * pointers will point to this buffer.
5722 *
5723 * AVFrame extended_data channel pointers are allocated if necessary for
5724 * planar audio.
5725 *
5726 * @param frame the AVFrame
5727 * frame->nb_samples must be set prior to calling the
5728 * function. This function fills in frame->data,
5729 * frame->extended_data, frame->linesize[0].
5730 * @param nb_channels channel count
5731 * @param sample_fmt sample format
5732 * @param buf buffer to use for frame data
5733 * @param buf_size size of buffer
5734 * @param align plane size sample alignment (0 = default)
5735 * @return >=0 on success, negative error code on failure
5736 * @todo return the size in bytes required to store the samples in
5737 * case of success, at the next libavutil bump
5738 */
5739int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5740 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5741 int buf_size, int align);
5742
5743/**
5744 * Reset the internal decoder state / flush internal buffers. Should be called
5745 * e.g. when seeking or when switching to a different stream.
5746 *
5747 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5748 * this invalidates the frames previously returned from the decoder. When
5749 * refcounted frames are used, the decoder just releases any references it might
5750 * keep internally, but the caller's reference remains valid.
5751 */
5752void avcodec_flush_buffers(AVCodecContext *avctx);
5753
5754/**
5755 * Return codec bits per sample.
5756 *
5757 * @param[in] codec_id the codec
5758 * @return Number of bits per sample or zero if unknown for the given codec.
5759 */
5760int av_get_bits_per_sample(enum AVCodecID codec_id);
5761
5762/**
5763 * Return the PCM codec associated with a sample format.
5764 * @param be endianness, 0 for little, 1 for big,
5765 * -1 (or anything else) for native
5766 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5767 */
5768enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5769
5770/**
5771 * Return codec bits per sample.
5772 * Only return non-zero if the bits per sample is exactly correct, not an
5773 * approximation.
5774 *
5775 * @param[in] codec_id the codec
5776 * @return Number of bits per sample or zero if unknown for the given codec.
5777 */
5778int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5779
5780/**
5781 * Return audio frame duration.
5782 *
5783 * @param avctx codec context
5784 * @param frame_bytes size of the frame, or 0 if unknown
5785 * @return frame duration, in samples, if known. 0 if not able to
5786 * determine.
5787 */
5788int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5789
5790/**
5791 * This function is the same as av_get_audio_frame_duration(), except it works
5792 * with AVCodecParameters instead of an AVCodecContext.
5793 */
5794int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5795
5796#if FF_API_OLD_BSF
5797typedef struct AVBitStreamFilterContext {
5798 void *priv_data;
5799 const struct AVBitStreamFilter *filter;
5800 AVCodecParserContext *parser;
5801 struct AVBitStreamFilterContext *next;
5802 /**
5803 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5804 * Not for access by library users.
5805 */
5806 char *args;
5807} AVBitStreamFilterContext;
5808#endif
5809
5810typedef struct AVBSFInternal AVBSFInternal;
5811
5812/**
5813 * The bitstream filter state.
5814 *
5815 * This struct must be allocated with av_bsf_alloc() and freed with
5816 * av_bsf_free().
5817 *
5818 * The fields in the struct will only be changed (by the caller or by the
5819 * filter) as described in their documentation, and are to be considered
5820 * immutable otherwise.
5821 */
5822typedef struct AVBSFContext {
5823 /**
5824 * A class for logging and AVOptions
5825 */
5826 const AVClass *av_class;
5827
5828 /**
5829 * The bitstream filter this context is an instance of.
5830 */
5831 const struct AVBitStreamFilter *filter;
5832
5833 /**
5834 * Opaque libavcodec internal data. Must not be touched by the caller in any
5835 * way.
5836 */
5837 AVBSFInternal *internal;
5838
5839 /**
5840 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5841 * this is an AVOptions-enabled struct.
5842 */
5843 void *priv_data;
5844
5845 /**
5846 * Parameters of the input stream. This field is allocated in
5847 * av_bsf_alloc(), it needs to be filled by the caller before
5848 * av_bsf_init().
5849 */
5850 AVCodecParameters *par_in;
5851
5852 /**
5853 * Parameters of the output stream. This field is allocated in
5854 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5855 */
5856 AVCodecParameters *par_out;
5857
5858 /**
5859 * The timebase used for the timestamps of the input packets. Set by the
5860 * caller before av_bsf_init().
5861 */
5862 AVRational time_base_in;
5863
5864 /**
5865 * The timebase used for the timestamps of the output packets. Set by the
5866 * filter in av_bsf_init().
5867 */
5868 AVRational time_base_out;
5869} AVBSFContext;
5870
5871typedef struct AVBitStreamFilter {
5872 const char *name;
5873
5874 /**
5875 * A list of codec ids supported by the filter, terminated by
5876 * AV_CODEC_ID_NONE.
5877 * May be NULL, in that case the bitstream filter works with any codec id.
5878 */
5879 const enum AVCodecID *codec_ids;
5880
5881 /**
5882 * A class for the private data, used to declare bitstream filter private
5883 * AVOptions. This field is NULL for bitstream filters that do not declare
5884 * any options.
5885 *
5886 * If this field is non-NULL, the first member of the filter private data
5887 * must be a pointer to AVClass, which will be set by libavcodec generic
5888 * code to this class.
5889 */
5890 const AVClass *priv_class;
5891
5892 /*****************************************************************
5893 * No fields below this line are part of the public API. They
5894 * may not be used outside of libavcodec and can be changed and
5895 * removed at will.
5896 * New public fields should be added right above.
5897 *****************************************************************
5898 */
5899
5900 int priv_data_size;
5901 int (*init)(AVBSFContext *ctx);
5902 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5903 void (*close)(AVBSFContext *ctx);
5904} AVBitStreamFilter;
5905
5906#if FF_API_OLD_BSF
5907/**
5908 * Register a bitstream filter.
5909 *
5910 * The filter will be accessible to the application code through
5911 * av_bitstream_filter_next() or can be directly initialized with
5912 * av_bitstream_filter_init().
5913 *
5914 * @see avcodec_register_all()
5915 */
5916attribute_deprecated
5917void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5918
5919/**
5920 * Create and initialize a bitstream filter context given a bitstream
5921 * filter name.
5922 *
5923 * The returned context must be freed with av_bitstream_filter_close().
5924 *
5925 * @param name the name of the bitstream filter
5926 * @return a bitstream filter context if a matching filter was found
5927 * and successfully initialized, NULL otherwise
5928 */
5929attribute_deprecated
5930AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5931
5932/**
5933 * Filter bitstream.
5934 *
5935 * This function filters the buffer buf with size buf_size, and places the
5936 * filtered buffer in the buffer pointed to by poutbuf.
5937 *
5938 * The output buffer must be freed by the caller.
5939 *
5940 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5941 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5942 * If specified, this must point to the encoder context of the
5943 * output stream the packet is sent to.
5944 * @param args arguments which specify the filter configuration, may be NULL
5945 * @param poutbuf pointer which is updated to point to the filtered buffer
5946 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5947 * @param buf buffer containing the data to filter
5948 * @param buf_size size in bytes of buf
5949 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5950 * @return >= 0 in case of success, or a negative error code in case of failure
5951 *
5952 * If the return value is positive, an output buffer is allocated and
5953 * is available in *poutbuf, and is distinct from the input buffer.
5954 *
5955 * If the return value is 0, the output buffer is not allocated and
5956 * should be considered identical to the input buffer, or in case
5957 * *poutbuf was set it points to the input buffer (not necessarily to
5958 * its starting address). A special case is if *poutbuf was set to NULL and
5959 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5960 */
5961attribute_deprecated
5962int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5963 AVCodecContext *avctx, const char *args,
5964 uint8_t **poutbuf, int *poutbuf_size,
5965 const uint8_t *buf, int buf_size, int keyframe);
5966
5967/**
5968 * Release bitstream filter context.
5969 *
5970 * @param bsf the bitstream filter context created with
5971 * av_bitstream_filter_init(), can be NULL
5972 */
5973attribute_deprecated
5974void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5975
5976/**
5977 * If f is NULL, return the first registered bitstream filter,
5978 * if f is non-NULL, return the next registered bitstream filter
5979 * after f, or NULL if f is the last one.
5980 *
5981 * This function can be used to iterate over all registered bitstream
5982 * filters.
5983 */
5984attribute_deprecated
5985AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5986#endif
5987
5988/**
5989 * @return a bitstream filter with the specified name or NULL if no such
5990 * bitstream filter exists.
5991 */
5992const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5993
5994/**
5995 * Iterate over all registered bitstream filters.
5996 *
5997 * @param opaque a pointer where libavcodec will store the iteration state. Must
5998 * point to NULL to start the iteration.
5999 *
6000 * @return the next registered bitstream filter or NULL when the iteration is
6001 * finished
6002 */
6003const AVBitStreamFilter *av_bsf_next(void **opaque);
6004
6005/**
6006 * Allocate a context for a given bitstream filter. The caller must fill in the
6007 * context parameters as described in the documentation and then call
6008 * av_bsf_init() before sending any data to the filter.
6009 *
6010 * @param filter the filter for which to allocate an instance.
6011 * @param ctx a pointer into which the pointer to the newly-allocated context
6012 * will be written. It must be freed with av_bsf_free() after the
6013 * filtering is done.
6014 *
6015 * @return 0 on success, a negative AVERROR code on failure
6016 */
6017int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6018
6019/**
6020 * Prepare the filter for use, after all the parameters and options have been
6021 * set.
6022 */
6023int av_bsf_init(AVBSFContext *ctx);
6024
6025/**
6026 * Submit a packet for filtering.
6027 *
6028 * After sending each packet, the filter must be completely drained by calling
6029 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6030 * AVERROR_EOF.
6031 *
6032 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
6033 * side data must be present in pkt). The bitstream filter will take ownership of
6034 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6035 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6036 * packets will be sent). That will cause the filter to output any packets it
6037 * may have buffered internally.
6038 *
6039 * @return 0 on success, a negative AVERROR on error.
6040 */
6041int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6042
6043/**
6044 * Retrieve a filtered packet.
6045 *
6046 * @param[out] pkt this struct will be filled with the contents of the filtered
6047 * packet. It is owned by the caller and must be freed using
6048 * av_packet_unref() when it is no longer needed.
6049 * This parameter should be "clean" (i.e. freshly allocated
6050 * with av_packet_alloc() or unreffed with av_packet_unref())
6051 * when this function is called. If this function returns
6052 * successfully, the contents of pkt will be completely
6053 * overwritten by the returned data. On failure, pkt is not
6054 * touched.
6055 *
6056 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6057 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6058 * will be no further output from the filter. Another negative AVERROR value if
6059 * an error occurs.
6060 *
6061 * @note one input packet may result in several output packets, so after sending
6062 * a packet with av_bsf_send_packet(), this function needs to be called
6063 * repeatedly until it stops returning 0. It is also possible for a filter to
6064 * output fewer packets than were sent to it, so this function may return
6065 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6066 */
6067int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6068
6069/**
6070 * Free a bitstream filter context and everything associated with it; write NULL
6071 * into the supplied pointer.
6072 */
6073void av_bsf_free(AVBSFContext **ctx);
6074
6075/**
6076 * Get the AVClass for AVBSFContext. It can be used in combination with
6077 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6078 *
6079 * @see av_opt_find().
6080 */
6081const AVClass *av_bsf_get_class(void);
6082
6083/**
6084 * Structure for chain/list of bitstream filters.
6085 * Empty list can be allocated by av_bsf_list_alloc().
6086 */
6087typedef struct AVBSFList AVBSFList;
6088
6089/**
6090 * Allocate empty list of bitstream filters.
6091 * The list must be later freed by av_bsf_list_free()
6092 * or finalized by av_bsf_list_finalize().
6093 *
6094 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6095 */
6096AVBSFList *av_bsf_list_alloc(void);
6097
6098/**
6099 * Free list of bitstream filters.
6100 *
6101 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6102 */
6103void av_bsf_list_free(AVBSFList **lst);
6104
6105/**
6106 * Append bitstream filter to the list of bitstream filters.
6107 *
6108 * @param lst List to append to
6109 * @param bsf Filter context to be appended
6110 *
6111 * @return >=0 on success, negative AVERROR in case of failure
6112 */
6113int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6114
6115/**
6116 * Construct new bitstream filter context given it's name and options
6117 * and append it to the list of bitstream filters.
6118 *
6119 * @param lst List to append to
6120 * @param bsf_name Name of the bitstream filter
6121 * @param options Options for the bitstream filter, can be set to NULL
6122 *
6123 * @return >=0 on success, negative AVERROR in case of failure
6124 */
6125int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6126/**
6127 * Finalize list of bitstream filters.
6128 *
6129 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6130 * so the whole chain of bitstream filters can be treated as single filter
6131 * freshly allocated by av_bsf_alloc().
6132 * If the call is successful, @ref AVBSFList structure is freed and lst
6133 * will be set to NULL. In case of failure, caller is responsible for
6134 * freeing the structure by av_bsf_list_free()
6135 *
6136 * @param lst Filter list structure to be transformed
6137 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6138 * representing the chain of bitstream filters
6139 *
6140 * @return >=0 on success, negative AVERROR in case of failure
6141 */
6142int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6143
6144/**
6145 * Parse string describing list of bitstream filters and create single
6146 * @ref AVBSFContext describing the whole chain of bitstream filters.
6147 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6148 * allocated by av_bsf_alloc().
6149 *
6150 * @param str String describing chain of bitstream filters in format
6151 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6152 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6153 * representing the chain of bitstream filters
6154 *
6155 * @return >=0 on success, negative AVERROR in case of failure
6156 */
6157int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6158
6159/**
6160 * Get null/pass-through bitstream filter.
6161 *
6162 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6163 *
6164 * @return
6165 */
6166int av_bsf_get_null_filter(AVBSFContext **bsf);
6167
6168/* memory */
6169
6170/**
6171 * Same behaviour av_fast_malloc but the buffer has additional
6172 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6173 *
6174 * In addition the whole buffer will initially and after resizes
6175 * be 0-initialized so that no uninitialized data will ever appear.
6176 */
6177void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6178
6179/**
6180 * Same behaviour av_fast_padded_malloc except that buffer will always
6181 * be 0-initialized after call.
6182 */
6183void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6184
6185/**
6186 * Encode extradata length to a buffer. Used by xiph codecs.
6187 *
6188 * @param s buffer to write to; must be at least (v/255+1) bytes long
6189 * @param v size of extradata in bytes
6190 * @return number of bytes written to the buffer.
6191 */
6192unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6193
6194#if FF_API_MISSING_SAMPLE
6195/**
6196 * Log a generic warning message about a missing feature. This function is
6197 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6198 * only, and would normally not be used by applications.
6199 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6200 * a pointer to an AVClass struct
6201 * @param[in] feature string containing the name of the missing feature
6202 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6203 * If want_sample is non-zero, additional verbiage will be added to the log
6204 * message which tells the user how to report samples to the development
6205 * mailing list.
6206 * @deprecated Use avpriv_report_missing_feature() instead.
6207 */
6208attribute_deprecated
6209void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6210
6211/**
6212 * Log a generic warning message asking for a sample. This function is
6213 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6214 * only, and would normally not be used by applications.
6215 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6216 * a pointer to an AVClass struct
6217 * @param[in] msg string containing an optional message, or NULL if no message
6218 * @deprecated Use avpriv_request_sample() instead.
6219 */
6220attribute_deprecated
6221void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6222#endif /* FF_API_MISSING_SAMPLE */
6223
6224/**
6225 * Register the hardware accelerator hwaccel.
6226 */
6227void av_register_hwaccel(AVHWAccel *hwaccel);
6228
6229/**
6230 * If hwaccel is NULL, returns the first registered hardware accelerator,
6231 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6232 * after hwaccel, or NULL if hwaccel is the last one.
6233 */
6234AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6235
6236
6237/**
6238 * Lock operation used by lockmgr
6239 */
6240enum AVLockOp {
6241 AV_LOCK_CREATE, ///< Create a mutex
6242 AV_LOCK_OBTAIN, ///< Lock the mutex
6243 AV_LOCK_RELEASE, ///< Unlock the mutex
6244 AV_LOCK_DESTROY, ///< Free mutex resources
6245};
6246
6247/**
6248 * Register a user provided lock manager supporting the operations
6249 * specified by AVLockOp. The "mutex" argument to the function points
6250 * to a (void *) where the lockmgr should store/get a pointer to a user
6251 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6252 * value left by the last call for all other ops. If the lock manager is
6253 * unable to perform the op then it should leave the mutex in the same
6254 * state as when it was called and return a non-zero value. However,
6255 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6256 * have been successfully destroyed. If av_lockmgr_register succeeds
6257 * it will return a non-negative value, if it fails it will return a
6258 * negative value and destroy all mutex and unregister all callbacks.
6259 * av_lockmgr_register is not thread-safe, it must be called from a
6260 * single thread before any calls which make use of locking are used.
6261 *
6262 * @param cb User defined callback. av_lockmgr_register invokes calls
6263 * to this callback and the previously registered callback.
6264 * The callback will be used to create more than one mutex
6265 * each of which must be backed by its own underlying locking
6266 * mechanism (i.e. do not use a single static object to
6267 * implement your lock manager). If cb is set to NULL the
6268 * lockmgr will be unregistered.
6269 */
6270int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6271
6272/**
6273 * Get the type of the given codec.
6274 */
6275enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6276
6277/**
6278 * Get the name of a codec.
6279 * @return a static string identifying the codec; never NULL
6280 */
6281const char *avcodec_get_name(enum AVCodecID id);
6282
6283/**
6284 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6285 * with no corresponding avcodec_close()), 0 otherwise.
6286 */
6287int avcodec_is_open(AVCodecContext *s);
6288
6289/**
6290 * @return a non-zero number if codec is an encoder, zero otherwise
6291 */
6292int av_codec_is_encoder(const AVCodec *codec);
6293
6294/**
6295 * @return a non-zero number if codec is a decoder, zero otherwise
6296 */
6297int av_codec_is_decoder(const AVCodec *codec);
6298
6299/**
6300 * @return descriptor for given codec ID or NULL if no descriptor exists.
6301 */
6302const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6303
6304/**
6305 * Iterate over all codec descriptors known to libavcodec.
6306 *
6307 * @param prev previous descriptor. NULL to get the first descriptor.
6308 *
6309 * @return next descriptor or NULL after the last descriptor
6310 */
6311const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6312
6313/**
6314 * @return codec descriptor with the given name or NULL if no such descriptor
6315 * exists.
6316 */
6317const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6318
6319/**
6320 * Allocate a CPB properties structure and initialize its fields to default
6321 * values.
6322 *
6323 * @param size if non-NULL, the size of the allocated struct will be written
6324 * here. This is useful for embedding it in side data.
6325 *
6326 * @return the newly allocated struct or NULL on failure
6327 */
6328AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6329
6330/**
6331 * @}
6332 */
6333
6334#endif /* AVCODEC_AVCODEC_H */
6335
generated by cgit at 2024-05-12 06:43:31 (GMT)