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