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