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