Fix some mismatches between function parameter and doxygen parameter names.
[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 typedef struct AVPacketSideData {
1295 uint8_t *data;
1296 int size;
1297 enum AVPacketSideDataType type;
1298 } AVPacketSideData;
1299
1300 /**
1301 * This structure stores compressed data. It is typically exported by demuxers
1302 * and then passed as input to decoders, or received as output from encoders and
1303 * then passed to muxers.
1304 *
1305 * For video, it should typically contain one compressed frame. For audio it may
1306 * contain several compressed frames. Encoders are allowed to output empty
1307 * packets, with no compressed data, containing only side data
1308 * (e.g. to update some stream parameters at the end of encoding).
1309 *
1310 * AVPacket is one of the few structs in Libav, whose size is a part of public
1311 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1312 * without libavcodec and libavformat major bump.
1313 *
1314 * The semantics of data ownership depends on the buf field.
1315 * If it is set, the packet data is dynamically allocated and is
1316 * valid indefinitely until a call to av_packet_unref() reduces the
1317 * reference count to 0.
1318 *
1319 * If the buf field is not set av_packet_ref() would make a copy instead
1320 * of increasing the reference count.
1321 *
1322 * The side data is always allocated with av_malloc(), copied by
1323 * av_packet_ref() and freed by av_packet_unref().
1324 *
1325 * @see av_packet_ref
1326 * @see av_packet_unref
1327 */
1328 typedef struct AVPacket {
1329 /**
1330 * A reference to the reference-counted buffer where the packet data is
1331 * stored.
1332 * May be NULL, then the packet data is not reference-counted.
1333 */
1334 AVBufferRef *buf;
1335 /**
1336 * Presentation timestamp in AVStream->time_base units; the time at which
1337 * the decompressed packet will be presented to the user.
1338 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1339 * pts MUST be larger or equal to dts as presentation cannot happen before
1340 * decompression, unless one wants to view hex dumps. Some formats misuse
1341 * the terms dts and pts/cts to mean something different. Such timestamps
1342 * must be converted to true pts/dts before they are stored in AVPacket.
1343 */
1344 int64_t pts;
1345 /**
1346 * Decompression timestamp in AVStream->time_base units; the time at which
1347 * the packet is decompressed.
1348 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1349 */
1350 int64_t dts;
1351 uint8_t *data;
1352 int size;
1353 int stream_index;
1354 /**
1355 * A combination of AV_PKT_FLAG values
1356 */
1357 int flags;
1358 /**
1359 * Additional packet data that can be provided by the container.
1360 * Packet can contain several types of side information.
1361 */
1362 AVPacketSideData *side_data;
1363 int side_data_elems;
1364
1365 /**
1366 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1367 * Equals next_pts - this_pts in presentation order.
1368 */
1369 int64_t duration;
1370
1371 int64_t pos; ///< byte position in stream, -1 if unknown
1372
1373 #if FF_API_CONVERGENCE_DURATION
1374 /**
1375 * @deprecated Same as the duration field, but as int64_t. This was required
1376 * for Matroska subtitles, whose duration values could overflow when the
1377 * duration field was still an int.
1378 */
1379 attribute_deprecated
1380 int64_t convergence_duration;
1381 #endif
1382 } AVPacket;
1383 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1384 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1385
1386 enum AVSideDataParamChangeFlags {
1387 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1388 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1389 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1390 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1391 };
1392 /**
1393 * @}
1394 */
1395
1396 struct AVCodecInternal;
1397
1398 enum AVFieldOrder {
1399 AV_FIELD_UNKNOWN,
1400 AV_FIELD_PROGRESSIVE,
1401 AV_FIELD_TT, //< Top coded_first, top displayed first
1402 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1403 AV_FIELD_TB, //< Top coded first, bottom displayed first
1404 AV_FIELD_BT, //< Bottom coded first, top displayed first
1405 };
1406
1407 /**
1408 * main external API structure.
1409 * New fields can be added to the end with minor version bumps.
1410 * Removal, reordering and changes to existing fields require a major
1411 * version bump.
1412 * sizeof(AVCodecContext) must not be used outside libav*.
1413 */
1414 typedef struct AVCodecContext {
1415 /**
1416 * information on struct for av_log
1417 * - set by avcodec_alloc_context3
1418 */
1419 const AVClass *av_class;
1420 int log_level_offset;
1421
1422 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1423 const struct AVCodec *codec;
1424 #if FF_API_CODEC_NAME
1425 /**
1426 * @deprecated this field is not used for anything in libavcodec
1427 */
1428 attribute_deprecated
1429 char codec_name[32];
1430 #endif
1431 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1432
1433 /**
1434 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1435 * This is used to work around some encoder bugs.
1436 * A demuxer should set this to what is stored in the field used to identify the codec.
1437 * If there are multiple such fields in a container then the demuxer should choose the one
1438 * which maximizes the information about the used codec.
1439 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1440 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1441 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1442 * first.
1443 * - encoding: Set by user, if not then the default based on codec_id will be used.
1444 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1445 */
1446 unsigned int codec_tag;
1447
1448 #if FF_API_STREAM_CODEC_TAG
1449 /**
1450 * @deprecated this field is unused
1451 */
1452 attribute_deprecated
1453 unsigned int stream_codec_tag;
1454 #endif
1455
1456 void *priv_data;
1457
1458 /**
1459 * Private context used for internal data.
1460 *
1461 * Unlike priv_data, this is not codec-specific. It is used in general
1462 * libavcodec functions.
1463 */
1464 struct AVCodecInternal *internal;
1465
1466 /**
1467 * Private data of the user, can be used to carry app specific stuff.
1468 * - encoding: Set by user.
1469 * - decoding: Set by user.
1470 */
1471 void *opaque;
1472
1473 /**
1474 * the average bitrate
1475 * - encoding: Set by user; unused for constant quantizer encoding.
1476 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1477 */
1478 int bit_rate;
1479
1480 /**
1481 * number of bits the bitstream is allowed to diverge from the reference.
1482 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1483 * - encoding: Set by user; unused for constant quantizer encoding.
1484 * - decoding: unused
1485 */
1486 int bit_rate_tolerance;
1487
1488 /**
1489 * Global quality for codecs which cannot change it per frame.
1490 * This should be proportional to MPEG-1/2/4 qscale.
1491 * - encoding: Set by user.
1492 * - decoding: unused
1493 */
1494 int global_quality;
1495
1496 /**
1497 * - encoding: Set by user.
1498 * - decoding: unused
1499 */
1500 int compression_level;
1501 #define FF_COMPRESSION_DEFAULT -1
1502
1503 /**
1504 * AV_CODEC_FLAG_*.
1505 * - encoding: Set by user.
1506 * - decoding: Set by user.
1507 */
1508 int flags;
1509
1510 /**
1511 * AV_CODEC_FLAG2_*
1512 * - encoding: Set by user.
1513 * - decoding: Set by user.
1514 */
1515 int flags2;
1516
1517 /**
1518 * some codecs need / can use extradata like Huffman tables.
1519 * MJPEG: Huffman tables
1520 * rv10: additional flags
1521 * MPEG-4: global headers (they can be in the bitstream or here)
1522 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1523 * than extradata_size to avoid problems if it is read with the bitstream reader.
1524 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1525 * - encoding: Set/allocated/freed by libavcodec.
1526 * - decoding: Set/allocated/freed by user.
1527 */
1528 uint8_t *extradata;
1529 int extradata_size;
1530
1531 /**
1532 * This is the fundamental unit of time (in seconds) in terms
1533 * of which frame timestamps are represented. For fixed-fps content,
1534 * timebase should be 1/framerate and timestamp increments should be
1535 * identically 1.
1536 * - encoding: MUST be set by user.
1537 * - decoding: the use of this field for decoding is deprecated.
1538 * Use framerate instead.
1539 */
1540 AVRational time_base;
1541
1542 /**
1543 * For some codecs, the time base is closer to the field rate than the frame rate.
1544 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1545 * if no telecine is used ...
1546 *
1547 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1548 */
1549 int ticks_per_frame;
1550
1551 /**
1552 * Codec delay.
1553 *
1554 * Video:
1555 * Number of frames the decoded output will be delayed relative to the
1556 * encoded input.
1557 *
1558 * Audio:
1559 * For encoding, this field is unused (see initial_padding).
1560 *
1561 * For decoding, this is the number of samples the decoder needs to
1562 * output before the decoder's output is valid. When seeking, you should
1563 * start decoding this many samples prior to your desired seek point.
1564 *
1565 * - encoding: Set by libavcodec.
1566 * - decoding: Set by libavcodec.
1567 */
1568 int delay;
1569
1570
1571 /* video only */
1572 /**
1573 * picture width / height.
1574 *
1575 * @note Those fields may not match the values of the last
1576 * AVFrame output by avcodec_decode_video2 due frame
1577 * reordering.
1578 *
1579 * - encoding: MUST be set by user.
1580 * - decoding: May be set by the user before opening the decoder if known e.g.
1581 * from the container. Some decoders will require the dimensions
1582 * to be set by the caller. During decoding, the decoder may
1583 * overwrite those values as required while parsing the data.
1584 */
1585 int width, height;
1586
1587 /**
1588 * Bitstream width / height, may be different from width/height e.g. when
1589 * the decoded frame is cropped before being output.
1590 *
1591 * @note Those field may not match the value of the last
1592 * AVFrame output by avcodec_receive_frame() due frame
1593 * reordering.
1594 *
1595 * - encoding: unused
1596 * - decoding: May be set by the user before opening the decoder if known
1597 * e.g. from the container. During decoding, the decoder may
1598 * overwrite those values as required while parsing the data.
1599 */
1600 int coded_width, coded_height;
1601
1602 #if FF_API_ASPECT_EXTENDED
1603 #define FF_ASPECT_EXTENDED 15
1604 #endif
1605
1606 /**
1607 * the number of pictures in a group of pictures, or 0 for intra_only
1608 * - encoding: Set by user.
1609 * - decoding: unused
1610 */
1611 int gop_size;
1612
1613 /**
1614 * Pixel format, see AV_PIX_FMT_xxx.
1615 * May be set by the demuxer if known from headers.
1616 * May be overridden by the decoder if it knows better.
1617 *
1618 * @note This field may not match the value of the last
1619 * AVFrame output by avcodec_receive_frame() due frame
1620 * reordering.
1621 *
1622 * - encoding: Set by user.
1623 * - decoding: Set by user if known, overridden by libavcodec while
1624 * parsing the data.
1625 */
1626 enum AVPixelFormat pix_fmt;
1627
1628 #if FF_API_MOTION_EST
1629 /**
1630 * This option does nothing
1631 * @deprecated use codec private options instead
1632 */
1633 attribute_deprecated int me_method;
1634 #endif
1635
1636 /**
1637 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1638 * decoder to draw a horizontal band. It improves cache usage. Not
1639 * all codecs can do that. You must check the codec capabilities
1640 * beforehand.
1641 * When multithreading is used, it may be called from multiple threads
1642 * at the same time; threads might draw different parts of the same AVFrame,
1643 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1644 * in order.
1645 * The function is also used by hardware acceleration APIs.
1646 * It is called at least once during frame decoding to pass
1647 * the data needed for hardware render.
1648 * In that mode instead of pixel data, AVFrame points to
1649 * a structure specific to the acceleration API. The application
1650 * reads the structure and can change some fields to indicate progress
1651 * or mark state.
1652 * - encoding: unused
1653 * - decoding: Set by user.
1654 * @param height the height of the slice
1655 * @param y the y position of the slice
1656 * @param type 1->top field, 2->bottom field, 3->frame
1657 * @param offset offset into the AVFrame.data from which the slice should be read
1658 */
1659 void (*draw_horiz_band)(struct AVCodecContext *s,
1660 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1661 int y, int type, int height);
1662
1663 /**
1664 * callback to negotiate the pixelFormat
1665 * @param fmt is the list of formats which are supported by the codec,
1666 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1667 * The first is always the native one.
1668 * @note The callback may be called again immediately if initialization for
1669 * the selected (hardware-accelerated) pixel format failed.
1670 * @warning Behavior is undefined if the callback returns a value not
1671 * in the fmt list of formats.
1672 * @return the chosen format
1673 * - encoding: unused
1674 * - decoding: Set by user, if not set the native format will be chosen.
1675 */
1676 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1677
1678 /**
1679 * maximum number of B-frames between non-B-frames
1680 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1681 * - encoding: Set by user.
1682 * - decoding: unused
1683 */
1684 int max_b_frames;
1685
1686 /**
1687 * qscale factor between IP and B-frames
1688 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1689 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1690 * - encoding: Set by user.
1691 * - decoding: unused
1692 */
1693 float b_quant_factor;
1694
1695 #if FF_API_RC_STRATEGY
1696 /** @deprecated use codec private option instead */
1697 attribute_deprecated int rc_strategy;
1698 #define FF_RC_STRATEGY_XVID 1
1699 #endif
1700
1701 #if FF_API_PRIVATE_OPT
1702 /** @deprecated use encoder private options instead */
1703 attribute_deprecated
1704 int b_frame_strategy;
1705 #endif
1706
1707 /**
1708 * qscale offset between IP and B-frames
1709 * - encoding: Set by user.
1710 * - decoding: unused
1711 */
1712 float b_quant_offset;
1713
1714 /**
1715 * Size of the frame reordering buffer in the decoder.
1716 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1717 * - encoding: Set by libavcodec.
1718 * - decoding: Set by libavcodec.
1719 */
1720 int has_b_frames;
1721
1722 #if FF_API_PRIVATE_OPT
1723 /** @deprecated use encoder private options instead */
1724 attribute_deprecated
1725 int mpeg_quant;
1726 #endif
1727
1728 /**
1729 * qscale factor between P- and I-frames
1730 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1731 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1732 * - encoding: Set by user.
1733 * - decoding: unused
1734 */
1735 float i_quant_factor;
1736
1737 /**
1738 * qscale offset between P and I-frames
1739 * - encoding: Set by user.
1740 * - decoding: unused
1741 */
1742 float i_quant_offset;
1743
1744 /**
1745 * luminance masking (0-> disabled)
1746 * - encoding: Set by user.
1747 * - decoding: unused
1748 */
1749 float lumi_masking;
1750
1751 /**
1752 * temporary complexity masking (0-> disabled)
1753 * - encoding: Set by user.
1754 * - decoding: unused
1755 */
1756 float temporal_cplx_masking;
1757
1758 /**
1759 * spatial complexity masking (0-> disabled)
1760 * - encoding: Set by user.
1761 * - decoding: unused
1762 */
1763 float spatial_cplx_masking;
1764
1765 /**
1766 * p block masking (0-> disabled)
1767 * - encoding: Set by user.
1768 * - decoding: unused
1769 */
1770 float p_masking;
1771
1772 /**
1773 * darkness masking (0-> disabled)
1774 * - encoding: Set by user.
1775 * - decoding: unused
1776 */
1777 float dark_masking;
1778
1779 /**
1780 * slice count
1781 * - encoding: Set by libavcodec.
1782 * - decoding: Set by user (or 0).
1783 */
1784 int slice_count;
1785
1786 #if FF_API_PRIVATE_OPT
1787 /** @deprecated use encoder private options instead */
1788 attribute_deprecated
1789 int prediction_method;
1790 #define FF_PRED_LEFT 0
1791 #define FF_PRED_PLANE 1
1792 #define FF_PRED_MEDIAN 2
1793 #endif
1794
1795 /**
1796 * slice offsets in the frame in bytes
1797 * - encoding: Set/allocated by libavcodec.
1798 * - decoding: Set/allocated by user (or NULL).
1799 */
1800 int *slice_offset;
1801
1802 /**
1803 * sample aspect ratio (0 if unknown)
1804 * That is the width of a pixel divided by the height of the pixel.
1805 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1806 * - encoding: Set by user.
1807 * - decoding: Set by libavcodec.
1808 */
1809 AVRational sample_aspect_ratio;
1810
1811 /**
1812 * motion estimation comparison function
1813 * - encoding: Set by user.
1814 * - decoding: unused
1815 */
1816 int me_cmp;
1817 /**
1818 * subpixel motion estimation comparison function
1819 * - encoding: Set by user.
1820 * - decoding: unused
1821 */
1822 int me_sub_cmp;
1823 /**
1824 * macroblock comparison function (not supported yet)
1825 * - encoding: Set by user.
1826 * - decoding: unused
1827 */
1828 int mb_cmp;
1829 /**
1830 * interlaced DCT comparison function
1831 * - encoding: Set by user.
1832 * - decoding: unused
1833 */
1834 int ildct_cmp;
1835 #define FF_CMP_SAD 0
1836 #define FF_CMP_SSE 1
1837 #define FF_CMP_SATD 2
1838 #define FF_CMP_DCT 3
1839 #define FF_CMP_PSNR 4
1840 #define FF_CMP_BIT 5
1841 #define FF_CMP_RD 6
1842 #define FF_CMP_ZERO 7
1843 #define FF_CMP_VSAD 8
1844 #define FF_CMP_VSSE 9
1845 #define FF_CMP_NSSE 10
1846 #define FF_CMP_DCTMAX 13
1847 #define FF_CMP_DCT264 14
1848 #define FF_CMP_CHROMA 256
1849
1850 /**
1851 * ME diamond size & shape
1852 * - encoding: Set by user.
1853 * - decoding: unused
1854 */
1855 int dia_size;
1856
1857 /**
1858 * amount of previous MV predictors (2a+1 x 2a+1 square)
1859 * - encoding: Set by user.
1860 * - decoding: unused
1861 */
1862 int last_predictor_count;
1863
1864 #if FF_API_PRIVATE_OPT
1865 /** @deprecated use encoder private options instead */
1866 attribute_deprecated
1867 int pre_me;
1868 #endif
1869
1870 /**
1871 * motion estimation prepass comparison function
1872 * - encoding: Set by user.
1873 * - decoding: unused
1874 */
1875 int me_pre_cmp;
1876
1877 /**
1878 * ME prepass diamond size & shape
1879 * - encoding: Set by user.
1880 * - decoding: unused
1881 */
1882 int pre_dia_size;
1883
1884 /**
1885 * subpel ME quality
1886 * - encoding: Set by user.
1887 * - decoding: unused
1888 */
1889 int me_subpel_quality;
1890
1891 #if FF_API_AFD
1892 /**
1893 * DTG active format information (additional aspect ratio
1894 * information only used in DVB MPEG-2 transport streams)
1895 * 0 if not set.
1896 *
1897 * - encoding: unused
1898 * - decoding: Set by decoder.
1899 * @deprecated Deprecated in favor of AVSideData
1900 */
1901 attribute_deprecated int dtg_active_format;
1902 #define FF_DTG_AFD_SAME 8
1903 #define FF_DTG_AFD_4_3 9
1904 #define FF_DTG_AFD_16_9 10
1905 #define FF_DTG_AFD_14_9 11
1906 #define FF_DTG_AFD_4_3_SP_14_9 13
1907 #define FF_DTG_AFD_16_9_SP_14_9 14
1908 #define FF_DTG_AFD_SP_4_3 15
1909 #endif /* FF_API_AFD */
1910
1911 /**
1912 * maximum motion estimation search range in subpel units
1913 * If 0 then no limit.
1914 *
1915 * - encoding: Set by user.
1916 * - decoding: unused
1917 */
1918 int me_range;
1919
1920 #if FF_API_QUANT_BIAS
1921 /**
1922 * @deprecated use encoder private option instead
1923 */
1924 attribute_deprecated int intra_quant_bias;
1925 #define FF_DEFAULT_QUANT_BIAS 999999
1926
1927 /**
1928 * @deprecated use encoder private option instead
1929 */
1930 attribute_deprecated int inter_quant_bias;
1931 #endif
1932
1933 /**
1934 * slice flags
1935 * - encoding: unused
1936 * - decoding: Set by user.
1937 */
1938 int slice_flags;
1939 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1940 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1941 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1942
1943 #if FF_API_XVMC
1944 /**
1945 * XVideo Motion Acceleration
1946 * - encoding: forbidden
1947 * - decoding: set by decoder
1948 * @deprecated XvMC support is slated for removal.
1949 */
1950 attribute_deprecated int xvmc_acceleration;
1951 #endif /* FF_API_XVMC */
1952
1953 /**
1954 * macroblock decision mode
1955 * - encoding: Set by user.
1956 * - decoding: unused
1957 */
1958 int mb_decision;
1959 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1960 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1961 #define FF_MB_DECISION_RD 2 ///< rate distortion
1962
1963 /**
1964 * custom intra quantization matrix
1965 * - encoding: Set by user, can be NULL.
1966 * - decoding: Set by libavcodec.
1967 */
1968 uint16_t *intra_matrix;
1969
1970 /**
1971 * custom inter quantization matrix
1972 * - encoding: Set by user, can be NULL.
1973 * - decoding: Set by libavcodec.
1974 */
1975 uint16_t *inter_matrix;
1976
1977 #if FF_API_PRIVATE_OPT
1978 /** @deprecated use encoder private options instead */
1979 attribute_deprecated
1980 int scenechange_threshold;
1981
1982 /** @deprecated use encoder private options instead */
1983 attribute_deprecated
1984 int noise_reduction;
1985 #endif
1986
1987 #if FF_API_MPV_OPT
1988 /**
1989 * @deprecated this field is unused
1990 */
1991 attribute_deprecated
1992 int me_threshold;
1993
1994 /**
1995 * @deprecated this field is unused
1996 */
1997 attribute_deprecated
1998 int mb_threshold;
1999 #endif
2000
2001 /**
2002 * precision of the intra DC coefficient - 8
2003 * - encoding: Set by user.
2004 * - decoding: unused
2005 */
2006 int intra_dc_precision;
2007
2008 /**
2009 * Number of macroblock rows at the top which are skipped.
2010 * - encoding: unused
2011 * - decoding: Set by user.
2012 */
2013 int skip_top;
2014
2015 /**
2016 * Number of macroblock rows at the bottom which are skipped.
2017 * - encoding: unused
2018 * - decoding: Set by user.
2019 */
2020 int skip_bottom;
2021
2022 #if FF_API_MPV_OPT
2023 /**
2024 * @deprecated use encoder private options instead
2025 */
2026 attribute_deprecated
2027 float border_masking;
2028 #endif
2029
2030 /**
2031 * minimum MB Lagrange multiplier
2032 * - encoding: Set by user.
2033 * - decoding: unused
2034 */
2035 int mb_lmin;
2036
2037 /**
2038 * maximum MB Lagrange multiplier
2039 * - encoding: Set by user.
2040 * - decoding: unused
2041 */
2042 int mb_lmax;
2043
2044 #if FF_API_PRIVATE_OPT
2045 /**
2046 * @deprecated use encoder private options instead
2047 */
2048 attribute_deprecated
2049 int me_penalty_compensation;
2050 #endif
2051
2052 /**
2053 * - encoding: Set by user.
2054 * - decoding: unused
2055 */
2056 int bidir_refine;
2057
2058 #if FF_API_PRIVATE_OPT
2059 /** @deprecated use encoder private options instead */
2060 attribute_deprecated
2061 int brd_scale;
2062 #endif
2063
2064 /**
2065 * minimum GOP size
2066 * - encoding: Set by user.
2067 * - decoding: unused
2068 */
2069 int keyint_min;
2070
2071 /**
2072 * number of reference frames
2073 * - encoding: Set by user.
2074 * - decoding: Set by lavc.
2075 */
2076 int refs;
2077
2078 #if FF_API_PRIVATE_OPT
2079 /** @deprecated use encoder private options instead */
2080 attribute_deprecated
2081 int chromaoffset;
2082 #endif
2083
2084 #if FF_API_UNUSED_MEMBERS
2085 /**
2086 * Multiplied by qscale for each frame and added to scene_change_score.
2087 * - encoding: Set by user.
2088 * - decoding: unused
2089 */
2090 attribute_deprecated int scenechange_factor;
2091 #endif
2092
2093 /**
2094 * Note: Value depends upon the compare function used for fullpel ME.
2095 * - encoding: Set by user.
2096 * - decoding: unused
2097 */
2098 int mv0_threshold;
2099
2100 #if FF_API_PRIVATE_OPT
2101 /** @deprecated use encoder private options instead */
2102 attribute_deprecated
2103 int b_sensitivity;
2104 #endif
2105
2106 /**
2107 * Chromaticity coordinates of the source primaries.
2108 * - encoding: Set by user
2109 * - decoding: Set by libavcodec
2110 */
2111 enum AVColorPrimaries color_primaries;
2112
2113 /**
2114 * Color Transfer Characteristic.
2115 * - encoding: Set by user
2116 * - decoding: Set by libavcodec
2117 */
2118 enum AVColorTransferCharacteristic color_trc;
2119
2120 /**
2121 * YUV colorspace type.
2122 * - encoding: Set by user
2123 * - decoding: Set by libavcodec
2124 */
2125 enum AVColorSpace colorspace;
2126
2127 /**
2128 * MPEG vs JPEG YUV range.
2129 * - encoding: Set by user
2130 * - decoding: Set by libavcodec
2131 */
2132 enum AVColorRange color_range;
2133
2134 /**
2135 * This defines the location of chroma samples.
2136 * - encoding: Set by user
2137 * - decoding: Set by libavcodec
2138 */
2139 enum AVChromaLocation chroma_sample_location;
2140
2141 /**
2142 * Number of slices.
2143 * Indicates number of picture subdivisions. Used for parallelized
2144 * decoding.
2145 * - encoding: Set by user
2146 * - decoding: unused
2147 */
2148 int slices;
2149
2150 /** Field order
2151 * - encoding: set by libavcodec
2152 * - decoding: Set by libavcodec
2153 */
2154 enum AVFieldOrder field_order;
2155
2156 /* audio only */
2157 int sample_rate; ///< samples per second
2158 int channels; ///< number of audio channels
2159
2160 /**
2161 * audio sample format
2162 * - encoding: Set by user.
2163 * - decoding: Set by libavcodec.
2164 */
2165 enum AVSampleFormat sample_fmt; ///< sample format
2166
2167 /* The following data should not be initialized. */
2168 /**
2169 * Number of samples per channel in an audio frame.
2170 *
2171 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2172 * except the last must contain exactly frame_size samples per channel.
2173 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2174 * frame size is not restricted.
2175 * - decoding: may be set by some decoders to indicate constant frame size
2176 */
2177 int frame_size;
2178
2179 /**
2180 * Frame counter, set by libavcodec.
2181 *
2182 * - decoding: total number of frames returned from the decoder so far.
2183 * - encoding: total number of frames passed to the encoder so far.
2184 *
2185 * @note the counter is not incremented if encoding/decoding resulted in
2186 * an error.
2187 */
2188 int frame_number;
2189
2190 /**
2191 * number of bytes per packet if constant and known or 0
2192 * Used by some WAV based audio codecs.
2193 */
2194 int block_align;
2195
2196 /**
2197 * Audio cutoff bandwidth (0 means "automatic")
2198 * - encoding: Set by user.
2199 * - decoding: unused
2200 */
2201 int cutoff;
2202
2203 /**
2204 * Audio channel layout.
2205 * - encoding: set by user.
2206 * - decoding: set by libavcodec.
2207 */
2208 uint64_t channel_layout;
2209
2210 /**
2211 * Request decoder to use this channel layout if it can (0 for default)
2212 * - encoding: unused
2213 * - decoding: Set by user.
2214 */
2215 uint64_t request_channel_layout;
2216
2217 /**
2218 * Type of service that the audio stream conveys.
2219 * - encoding: Set by user.
2220 * - decoding: Set by libavcodec.
2221 */
2222 enum AVAudioServiceType audio_service_type;
2223
2224 /**
2225 * Used to request a sample format from the decoder.
2226 * - encoding: unused.
2227 * - decoding: Set by user.
2228 */
2229 enum AVSampleFormat request_sample_fmt;
2230
2231 /**
2232 * This callback is called at the beginning of each frame to get data
2233 * buffer(s) for it. There may be one contiguous buffer for all the data or
2234 * there may be a buffer per each data plane or anything in between. What
2235 * this means is, you may set however many entries in buf[] you feel necessary.
2236 * Each buffer must be reference-counted using the AVBuffer API (see description
2237 * of buf[] below).
2238 *
2239 * The following fields will be set in the frame before this callback is
2240 * called:
2241 * - format
2242 * - width, height (video only)
2243 * - sample_rate, channel_layout, nb_samples (audio only)
2244 * Their values may differ from the corresponding values in
2245 * AVCodecContext. This callback must use the frame values, not the codec
2246 * context values, to calculate the required buffer size.
2247 *
2248 * This callback must fill the following fields in the frame:
2249 * - data[]
2250 * - linesize[]
2251 * - extended_data:
2252 * * if the data is planar audio with more than 8 channels, then this
2253 * callback must allocate and fill extended_data to contain all pointers
2254 * to all data planes. data[] must hold as many pointers as it can.
2255 * extended_data must be allocated with av_malloc() and will be freed in
2256 * av_frame_unref().
2257 * * otherwise extended_data must point to data
2258 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2259 * the frame's data and extended_data pointers must be contained in these. That
2260 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2261 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2262 * and av_buffer_ref().
2263 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2264 * this callback and filled with the extra buffers if there are more
2265 * buffers than buf[] can hold. extended_buf will be freed in
2266 * av_frame_unref().
2267 *
2268 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2269 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2270 * some other means.
2271 *
2272 * Each data plane must be aligned to the maximum required by the target
2273 * CPU.
2274 *
2275 * @see avcodec_default_get_buffer2()
2276 *
2277 * Video:
2278 *
2279 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2280 * (read and/or written to if it is writable) later by libavcodec.
2281 *
2282 * avcodec_align_dimensions2() should be used to find the required width and
2283 * height, as they normally need to be rounded up to the next multiple of 16.
2284 *
2285 * If frame multithreading is used and thread_safe_callbacks is set,
2286 * this callback may be called from a different thread, but not from more
2287 * than one at once. Does not need to be reentrant.
2288 *
2289 * @see avcodec_align_dimensions2()
2290 *
2291 * Audio:
2292 *
2293 * Decoders request a buffer of a particular size by setting
2294 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2295 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2296 * to a smaller value in the output frame.
2297 *
2298 * As a convenience, av_samples_get_buffer_size() and
2299 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2300 * functions to find the required data size and to fill data pointers and
2301 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2302 * since all planes must be the same size.
2303 *
2304 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2305 *
2306 * - encoding: unused
2307 * - decoding: Set by libavcodec, user can override.
2308 */
2309 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2310
2311 /**
2312 * If non-zero, the decoded audio and video frames returned from
2313 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2314 * and are valid indefinitely. The caller must free them with
2315 * av_frame_unref() when they are not needed anymore.
2316 * Otherwise, the decoded frames must not be freed by the caller and are
2317 * only valid until the next decode call.
2318 *
2319 * This is always automatically enabled if avcodec_receive_frame() is used.
2320 *
2321 * - encoding: unused
2322 * - decoding: set by the caller before avcodec_open2().
2323 */
2324 int refcounted_frames;
2325
2326 /* - encoding parameters */
2327 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2328 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2329
2330 /**
2331 * minimum quantizer
2332 * - encoding: Set by user.
2333 * - decoding: unused
2334 */
2335 int qmin;
2336
2337 /**
2338 * maximum quantizer
2339 * - encoding: Set by user.
2340 * - decoding: unused
2341 */
2342 int qmax;
2343
2344 /**
2345 * maximum quantizer difference between frames
2346 * - encoding: Set by user.
2347 * - decoding: unused
2348 */
2349 int max_qdiff;
2350
2351 #if FF_API_MPV_OPT
2352 /**
2353 * @deprecated use encoder private options instead
2354 */
2355 attribute_deprecated
2356 float rc_qsquish;
2357
2358 attribute_deprecated
2359 float rc_qmod_amp;
2360 attribute_deprecated
2361 int rc_qmod_freq;
2362 #endif
2363
2364 /**
2365 * decoder bitstream buffer size
2366 * - encoding: Set by user.
2367 * - decoding: unused
2368 */
2369 int rc_buffer_size;
2370
2371 /**
2372 * ratecontrol override, see RcOverride
2373 * - encoding: Allocated/set/freed by user.
2374 * - decoding: unused
2375 */
2376 int rc_override_count;
2377 RcOverride *rc_override;
2378
2379 #if FF_API_MPV_OPT
2380 /**
2381 * @deprecated use encoder private options instead
2382 */
2383 attribute_deprecated
2384 const char *rc_eq;
2385 #endif
2386
2387 /**
2388 * maximum bitrate
2389 * - encoding: Set by user.
2390 * - decoding: unused
2391 */
2392 int rc_max_rate;
2393
2394 /**
2395 * minimum bitrate
2396 * - encoding: Set by user.
2397 * - decoding: unused
2398 */
2399 int rc_min_rate;
2400
2401 #if FF_API_MPV_OPT
2402 /**
2403 * @deprecated use encoder private options instead
2404 */
2405 attribute_deprecated
2406 float rc_buffer_aggressivity;
2407
2408 attribute_deprecated
2409 float rc_initial_cplx;
2410 #endif
2411
2412 /**
2413 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2414 * - encoding: Set by user.
2415 * - decoding: unused.
2416 */
2417 float rc_max_available_vbv_use;
2418
2419 /**
2420 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2421 * - encoding: Set by user.
2422 * - decoding: unused.
2423 */
2424 float rc_min_vbv_overflow_use;
2425
2426 /**
2427 * Number of bits which should be loaded into the rc buffer before decoding starts.
2428 * - encoding: Set by user.
2429 * - decoding: unused
2430 */
2431 int rc_initial_buffer_occupancy;
2432
2433 #if FF_API_CODER_TYPE
2434 #define FF_CODER_TYPE_VLC 0
2435 #define FF_CODER_TYPE_AC 1
2436 #define FF_CODER_TYPE_RAW 2
2437 #define FF_CODER_TYPE_RLE 3
2438 #if FF_API_UNUSED_MEMBERS
2439 #define FF_CODER_TYPE_DEFLATE 4
2440 #endif /* FF_API_UNUSED_MEMBERS */
2441 /**
2442 * @deprecated use encoder private options instead
2443 */
2444 attribute_deprecated
2445 int coder_type;
2446 #endif /* FF_API_CODER_TYPE */
2447
2448 #if FF_API_PRIVATE_OPT
2449 /** @deprecated use encoder private options instead */
2450 attribute_deprecated
2451 int context_model;
2452 #endif
2453
2454 #if FF_API_MPV_OPT
2455 /**
2456 * @deprecated use encoder private options instead
2457 */
2458 attribute_deprecated
2459 int lmin;
2460
2461 /**
2462 * @deprecated use encoder private options instead
2463 */
2464 attribute_deprecated
2465 int lmax;
2466 #endif
2467
2468 #if FF_API_PRIVATE_OPT
2469 /** @deprecated use encoder private options instead */
2470 attribute_deprecated
2471 int frame_skip_threshold;
2472
2473 /** @deprecated use encoder private options instead */
2474 attribute_deprecated
2475 int frame_skip_factor;
2476
2477 /** @deprecated use encoder private options instead */
2478 attribute_deprecated
2479 int frame_skip_exp;
2480
2481 /** @deprecated use encoder private options instead */
2482 attribute_deprecated
2483 int frame_skip_cmp;
2484 #endif /* FF_API_PRIVATE_OPT */
2485
2486 /**
2487 * trellis RD quantization
2488 * - encoding: Set by user.
2489 * - decoding: unused
2490 */
2491 int trellis;
2492
2493 #if FF_API_PRIVATE_OPT
2494 /** @deprecated use encoder private options instead */
2495 attribute_deprecated
2496 int min_prediction_order;
2497
2498 /** @deprecated use encoder private options instead */
2499 attribute_deprecated
2500 int max_prediction_order;
2501
2502 /** @deprecated use encoder private options instead */
2503 attribute_deprecated
2504 int64_t timecode_frame_start;
2505 #endif
2506
2507 #if FF_API_RTP_CALLBACK
2508 /**
2509 * @deprecated unused
2510 */
2511 /* The RTP callback: This function is called */
2512 /* every time the encoder has a packet to send. */
2513 /* It depends on the encoder if the data starts */
2514 /* with a Start Code (it should). H.263 does. */
2515 /* mb_nb contains the number of macroblocks */
2516 /* encoded in the RTP payload. */
2517 attribute_deprecated
2518 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2519 #endif
2520
2521 #if FF_API_PRIVATE_OPT
2522 /** @deprecated use encoder private options instead */
2523 attribute_deprecated
2524 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2525 /* do its best to deliver a chunk with size */
2526 /* below rtp_payload_size, the chunk will start */
2527 /* with a start code on some codecs like H.263. */
2528 /* This doesn't take account of any particular */
2529 /* headers inside the transmitted RTP payload. */
2530 #endif
2531
2532 #if FF_API_STAT_BITS
2533 /* statistics, used for 2-pass encoding */
2534 attribute_deprecated
2535 int mv_bits;
2536 attribute_deprecated
2537 int header_bits;
2538 attribute_deprecated
2539 int i_tex_bits;
2540 attribute_deprecated
2541 int p_tex_bits;
2542 attribute_deprecated
2543 int i_count;
2544 attribute_deprecated
2545 int p_count;
2546 attribute_deprecated
2547 int skip_count;
2548 attribute_deprecated
2549 int misc_bits;
2550
2551 /** @deprecated this field is unused */
2552 attribute_deprecated
2553 int frame_bits;
2554 #endif
2555
2556 /**
2557 * pass1 encoding statistics output buffer
2558 * - encoding: Set by libavcodec.
2559 * - decoding: unused
2560 */
2561 char *stats_out;
2562
2563 /**
2564 * pass2 encoding statistics input buffer
2565 * Concatenated stuff from stats_out of pass1 should be placed here.
2566 * - encoding: Allocated/set/freed by user.
2567 * - decoding: unused
2568 */
2569 char *stats_in;
2570
2571 /**
2572 * Work around bugs in encoders which sometimes cannot be detected automatically.
2573 * - encoding: Set by user
2574 * - decoding: Set by user
2575 */
2576 int workaround_bugs;
2577 #define FF_BUG_AUTODETECT 1 ///< autodetection
2578 #if FF_API_OLD_MSMPEG4
2579 #define FF_BUG_OLD_MSMPEG4 2
2580 #endif
2581 #define FF_BUG_XVID_ILACE 4
2582 #define FF_BUG_UMP4 8
2583 #define FF_BUG_NO_PADDING 16
2584 #define FF_BUG_AMV 32
2585 #if FF_API_AC_VLC
2586 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2587 #endif
2588 #define FF_BUG_QPEL_CHROMA 64
2589 #define FF_BUG_STD_QPEL 128
2590 #define FF_BUG_QPEL_CHROMA2 256
2591 #define FF_BUG_DIRECT_BLOCKSIZE 512
2592 #define FF_BUG_EDGE 1024
2593 #define FF_BUG_HPEL_CHROMA 2048
2594 #define FF_BUG_DC_CLIP 4096
2595 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2596 #define FF_BUG_TRUNCATED 16384
2597
2598 /**
2599 * strictly follow the standard (MPEG-4, ...).
2600 * - encoding: Set by user.
2601 * - decoding: Set by user.
2602 * Setting this to STRICT or higher means the encoder and decoder will
2603 * generally do stupid things, whereas setting it to unofficial or lower
2604 * will mean the encoder might produce output that is not supported by all
2605 * spec-compliant decoders. Decoders don't differentiate between normal,
2606 * unofficial and experimental (that is, they always try to decode things
2607 * when they can) unless they are explicitly asked to behave stupidly
2608 * (=strictly conform to the specs)
2609 */
2610 int strict_std_compliance;
2611 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2612 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2613 #define FF_COMPLIANCE_NORMAL 0
2614 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2615 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2616
2617 /**
2618 * error concealment flags
2619 * - encoding: unused
2620 * - decoding: Set by user.
2621 */
2622 int error_concealment;
2623 #define FF_EC_GUESS_MVS 1
2624 #define FF_EC_DEBLOCK 2
2625
2626 /**
2627 * debug
2628 * - encoding: Set by user.
2629 * - decoding: Set by user.
2630 */
2631 int debug;
2632 #define FF_DEBUG_PICT_INFO 1
2633 #define FF_DEBUG_RC 2
2634 #define FF_DEBUG_BITSTREAM 4
2635 #define FF_DEBUG_MB_TYPE 8
2636 #define FF_DEBUG_QP 16
2637 #if FF_API_DEBUG_MV
2638 /**
2639 * @deprecated this option does nothing
2640 */
2641 #define FF_DEBUG_MV 32
2642 #endif
2643 #define FF_DEBUG_DCT_COEFF 0x00000040
2644 #define FF_DEBUG_SKIP 0x00000080
2645 #define FF_DEBUG_STARTCODE 0x00000100
2646 #if FF_API_UNUSED_MEMBERS
2647 #define FF_DEBUG_PTS 0x00000200
2648 #endif /* FF_API_UNUSED_MEMBERS */
2649 #define FF_DEBUG_ER 0x00000400
2650 #define FF_DEBUG_MMCO 0x00000800
2651 #define FF_DEBUG_BUGS 0x00001000
2652 #if FF_API_DEBUG_MV
2653 #define FF_DEBUG_VIS_QP 0x00002000
2654 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2655 #endif
2656 #define FF_DEBUG_BUFFERS 0x00008000
2657 #define FF_DEBUG_THREADS 0x00010000
2658
2659 #if FF_API_DEBUG_MV
2660 /**
2661 * @deprecated this option does not have any effect
2662 */
2663 attribute_deprecated
2664 int debug_mv;
2665 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2666 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2667 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2668 #endif
2669
2670 /**
2671 * Error recognition; may misdetect some more or less valid parts as errors.
2672 * - encoding: unused
2673 * - decoding: Set by user.
2674 */
2675 int err_recognition;
2676
2677 /**
2678 * Verify checksums embedded in the bitstream (could be of either encoded or
2679 * decoded data, depending on the codec) and print an error message on mismatch.
2680 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2681 * decoder returning an error.
2682 */
2683 #define AV_EF_CRCCHECK (1<<0)
2684 #define AV_EF_BITSTREAM (1<<1)
2685 #define AV_EF_BUFFER (1<<2)
2686 #define AV_EF_EXPLODE (1<<3)
2687
2688 /**
2689 * opaque 64-bit number (generally a PTS) that will be reordered and
2690 * output in AVFrame.reordered_opaque
2691 * - encoding: unused
2692 * - decoding: Set by user.
2693 */
2694 int64_t reordered_opaque;
2695
2696 /**
2697 * Hardware accelerator in use
2698 * - encoding: unused.
2699 * - decoding: Set by libavcodec
2700 */
2701 struct AVHWAccel *hwaccel;
2702
2703 /**
2704 * Hardware accelerator context.
2705 * For some hardware accelerators, a global context needs to be
2706 * provided by the user. In that case, this holds display-dependent
2707 * data Libav cannot instantiate itself. Please refer to the
2708 * Libav HW accelerator documentation to know how to fill this
2709 * is. e.g. for VA API, this is a struct vaapi_context.
2710 * - encoding: unused
2711 * - decoding: Set by user
2712 */
2713 void *hwaccel_context;
2714
2715 /**
2716 * error
2717 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2718 * - decoding: unused
2719 */
2720 uint64_t error[AV_NUM_DATA_POINTERS];
2721
2722 /**
2723 * DCT algorithm, see FF_DCT_* below
2724 * - encoding: Set by user.
2725 * - decoding: unused
2726 */
2727 int dct_algo;
2728 #define FF_DCT_AUTO 0
2729 #define FF_DCT_FASTINT 1
2730 #define FF_DCT_INT 2
2731 #define FF_DCT_MMX 3
2732 #define FF_DCT_ALTIVEC 5
2733 #define FF_DCT_FAAN 6
2734
2735 /**
2736 * IDCT algorithm, see FF_IDCT_* below.
2737 * - encoding: Set by user.
2738 * - decoding: Set by user.
2739 */
2740 int idct_algo;
2741 #define FF_IDCT_AUTO 0
2742 #define FF_IDCT_INT 1
2743 #define FF_IDCT_SIMPLE 2
2744 #define FF_IDCT_SIMPLEMMX 3
2745 #define FF_IDCT_ARM 7
2746 #define FF_IDCT_ALTIVEC 8
2747 #if FF_API_ARCH_SH4
2748 #define FF_IDCT_SH4 9
2749 #endif
2750 #define FF_IDCT_SIMPLEARM 10
2751 #if FF_API_UNUSED_MEMBERS
2752 #define FF_IDCT_IPP 13
2753 #endif /* FF_API_UNUSED_MEMBERS */
2754 #define FF_IDCT_XVID 14
2755 #if FF_API_IDCT_XVIDMMX
2756 #define FF_IDCT_XVIDMMX 14
2757 #endif /* FF_API_IDCT_XVIDMMX */
2758 #define FF_IDCT_SIMPLEARMV5TE 16
2759 #define FF_IDCT_SIMPLEARMV6 17
2760 #if FF_API_ARCH_SPARC
2761 #define FF_IDCT_SIMPLEVIS 18
2762 #endif
2763 #define FF_IDCT_FAAN 20
2764 #define FF_IDCT_SIMPLENEON 22
2765 #if FF_API_ARCH_ALPHA
2766 #define FF_IDCT_SIMPLEALPHA 23
2767 #endif
2768
2769 /**
2770 * bits per sample/pixel from the demuxer (needed for huffyuv).
2771 * - encoding: Set by libavcodec.
2772 * - decoding: Set by user.
2773 */
2774 int bits_per_coded_sample;
2775
2776 /**
2777 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2778 * - encoding: set by user.
2779 * - decoding: set by libavcodec.
2780 */
2781 int bits_per_raw_sample;
2782
2783 #if FF_API_LOWRES
2784 /**
2785 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2786 * - encoding: unused
2787 * - decoding: Set by user.
2788 *
2789 * @deprecated use decoder private options instead
2790 */
2791 attribute_deprecated int lowres;
2792 #endif
2793
2794 #if FF_API_CODED_FRAME
2795 /**
2796 * the picture in the bitstream
2797 * - encoding: Set by libavcodec.
2798 * - decoding: unused
2799 *
2800 * @deprecated use the quality factor packet side data instead
2801 */
2802 attribute_deprecated AVFrame *coded_frame;
2803 #endif
2804
2805 /**
2806 * thread count
2807 * is used to decide how many independent tasks should be passed to execute()
2808 * - encoding: Set by user.
2809 * - decoding: Set by user.
2810 */
2811 int thread_count;
2812
2813 /**
2814 * Which multithreading methods to use.
2815 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2816 * so clients which cannot provide future frames should not use it.
2817 *
2818 * - encoding: Set by user, otherwise the default is used.
2819 * - decoding: Set by user, otherwise the default is used.
2820 */
2821 int thread_type;
2822 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2823 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2824
2825 /**
2826 * Which multithreading methods are in use by the codec.
2827 * - encoding: Set by libavcodec.
2828 * - decoding: Set by libavcodec.
2829 */
2830 int active_thread_type;
2831
2832 /**
2833 * Set by the client if its custom get_buffer() callback can be called
2834 * synchronously from another thread, which allows faster multithreaded decoding.
2835 * draw_horiz_band() will be called from other threads regardless of this setting.
2836 * Ignored if the default get_buffer() is used.
2837 * - encoding: Set by user.
2838 * - decoding: Set by user.
2839 */
2840 int thread_safe_callbacks;
2841
2842 /**
2843 * The codec may call this to execute several independent things.
2844 * It will return only after finishing all tasks.
2845 * The user may replace this with some multithreaded implementation,
2846 * the default implementation will execute the parts serially.
2847 * @param count the number of things to execute
2848 * - encoding: Set by libavcodec, user can override.
2849 * - decoding: Set by libavcodec, user can override.
2850 */
2851 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2852
2853 /**
2854 * The codec may call this to execute several independent things.
2855 * It will return only after finishing all tasks.
2856 * The user may replace this with some multithreaded implementation,
2857 * the default implementation will execute the parts serially.
2858 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2859 * @param c context passed also to func
2860 * @param count the number of things to execute
2861 * @param arg2 argument passed unchanged to func
2862 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2863 * @param func function that will be called count times, with jobnr from 0 to count-1.
2864 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2865 * two instances of func executing at the same time will have the same threadnr.
2866 * @return always 0 currently, but code should handle a future improvement where when any call to func
2867 * returns < 0 no further calls to func may be done and < 0 is returned.
2868 * - encoding: Set by libavcodec, user can override.
2869 * - decoding: Set by libavcodec, user can override.
2870 */
2871 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2872
2873 /**
2874 * noise vs. sse weight for the nsse comparison function
2875 * - encoding: Set by user.
2876 * - decoding: unused
2877 */
2878 int nsse_weight;
2879
2880 /**
2881 * profile
2882 * - encoding: Set by user.
2883 * - decoding: Set by libavcodec.
2884 */
2885 int profile;
2886 #define FF_PROFILE_UNKNOWN -99
2887 #define FF_PROFILE_RESERVED -100
2888
2889 #define FF_PROFILE_AAC_MAIN 0
2890 #define FF_PROFILE_AAC_LOW 1
2891 #define FF_PROFILE_AAC_SSR 2
2892 #define FF_PROFILE_AAC_LTP 3
2893 #define FF_PROFILE_AAC_HE 4
2894 #define FF_PROFILE_AAC_HE_V2 28
2895 #define FF_PROFILE_AAC_LD 22
2896 #define FF_PROFILE_AAC_ELD 38
2897 #define FF_PROFILE_MPEG2_AAC_LOW 128
2898 #define FF_PROFILE_MPEG2_AAC_HE 131
2899
2900 #define FF_PROFILE_DTS 20
2901 #define FF_PROFILE_DTS_ES 30
2902 #define FF_PROFILE_DTS_96_24 40
2903 #define FF_PROFILE_DTS_HD_HRA 50
2904 #define FF_PROFILE_DTS_HD_MA 60
2905 #define FF_PROFILE_DTS_EXPRESS 70
2906
2907 #define FF_PROFILE_MPEG2_422 0
2908 #define FF_PROFILE_MPEG2_HIGH 1
2909 #define FF_PROFILE_MPEG2_SS 2
2910 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2911 #define FF_PROFILE_MPEG2_MAIN 4
2912 #define FF_PROFILE_MPEG2_SIMPLE 5
2913
2914 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2915 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2916
2917 #define FF_PROFILE_H264_BASELINE 66
2918 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2919 #define FF_PROFILE_H264_MAIN 77
2920 #define FF_PROFILE_H264_EXTENDED 88
2921 #define FF_PROFILE_H264_HIGH 100
2922 #define FF_PROFILE_H264_HIGH_10 110
2923 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2924 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2925 #define FF_PROFILE_H264_HIGH_422 122
2926 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2927 #define FF_PROFILE_H264_STEREO_HIGH 128
2928 #define FF_PROFILE_H264_HIGH_444 144
2929 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2930 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2931 #define FF_PROFILE_H264_CAVLC_444 44
2932
2933 #define FF_PROFILE_VC1_SIMPLE 0
2934 #define FF_PROFILE_VC1_MAIN 1
2935 #define FF_PROFILE_VC1_COMPLEX 2
2936 #define FF_PROFILE_VC1_ADVANCED 3
2937
2938 #define FF_PROFILE_MPEG4_SIMPLE 0
2939 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2940 #define FF_PROFILE_MPEG4_CORE 2
2941 #define FF_PROFILE_MPEG4_MAIN 3
2942 #define FF_PROFILE_MPEG4_N_BIT 4
2943 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2944 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2945 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2946 #define FF_PROFILE_MPEG4_HYBRID 8
2947 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2948 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2949 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2950 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2951 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2952 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2953 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2954
2955 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2956 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2957 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2958 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2959 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2960
2961 #define FF_PROFILE_VP9_0 0
2962 #define FF_PROFILE_VP9_1 1
2963 #define FF_PROFILE_VP9_2 2
2964 #define FF_PROFILE_VP9_3 3
2965
2966 #define FF_PROFILE_HEVC_MAIN 1
2967 #define FF_PROFILE_HEVC_MAIN_10 2
2968 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2969 #define FF_PROFILE_HEVC_REXT 4
2970
2971 /**
2972 * level
2973 * - encoding: Set by user.
2974 * - decoding: Set by libavcodec.
2975 */
2976 int level;
2977 #define FF_LEVEL_UNKNOWN -99
2978
2979 /**
2980 * - encoding: unused
2981 * - decoding: Set by user.
2982 */
2983 enum AVDiscard skip_loop_filter;
2984
2985 /**
2986 * - encoding: unused
2987 * - decoding: Set by user.
2988 */
2989 enum AVDiscard skip_idct;
2990
2991 /**
2992 * - encoding: unused
2993 * - decoding: Set by user.
2994 */
2995 enum AVDiscard skip_frame;
2996
2997 /**
2998 * Header containing style information for text subtitles.
2999 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3000 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3001 * the Format line following. It shouldn't include any Dialogue line.
3002 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3003 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3004 */
3005 uint8_t *subtitle_header;
3006 int subtitle_header_size;
3007
3008 #if FF_API_ERROR_RATE
3009 /**
3010 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3011 * encoders
3012 */
3013 attribute_deprecated
3014 int error_rate;
3015 #endif
3016
3017 #if FF_API_VBV_DELAY
3018 /**
3019 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3020 * Used for compliant TS muxing.
3021 * - encoding: Set by libavcodec.
3022 * - decoding: unused.
3023 * @deprecated this value is now exported as a part of
3024 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3025 */
3026 attribute_deprecated
3027 uint64_t vbv_delay;
3028 #endif
3029
3030 #if FF_API_SIDEDATA_ONLY_PKT
3031 /**
3032 * Encoding only and set by default. Allow encoders to output packets
3033 * that do not contain any encoded data, only side data.
3034 *
3035 * Some encoders need to output such packets, e.g. to update some stream
3036 * parameters at the end of encoding.
3037 *
3038 * @deprecated this field disables the default behaviour and
3039 * it is kept only for compatibility.
3040 */
3041 attribute_deprecated
3042 int side_data_only_packets;
3043 #endif
3044
3045 /**
3046 * Audio only. The number of "priming" samples (padding) inserted by the
3047 * encoder at the beginning of the audio. I.e. this number of leading
3048 * decoded samples must be discarded by the caller to get the original audio
3049 * without leading padding.
3050 *
3051 * - decoding: unused
3052 * - encoding: Set by libavcodec. The timestamps on the output packets are
3053 * adjusted by the encoder so that they always refer to the
3054 * first sample of the data actually contained in the packet,
3055 * including any added padding. E.g. if the timebase is
3056 * 1/samplerate and the timestamp of the first input sample is
3057 * 0, the timestamp of the first output packet will be
3058 * -initial_padding.
3059 */
3060 int initial_padding;
3061
3062 /*
3063 * - decoding: For codecs that store a framerate value in the compressed
3064 * bitstream, the decoder may export it here. { 0, 1} when
3065 * unknown.
3066 * - encoding: May be used to signal the framerate of CFR content to an
3067 * encoder.
3068 */
3069 AVRational framerate;
3070
3071 /**
3072 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3073 * - encoding: unused.
3074 * - decoding: Set by libavcodec before calling get_format()
3075 */
3076 enum AVPixelFormat sw_pix_fmt;
3077
3078 /**
3079 * Additional data associated with the entire coded stream.
3080 *
3081 * - decoding: unused
3082 * - encoding: may be set by libavcodec after avcodec_open2().
3083 */
3084 AVPacketSideData *coded_side_data;
3085 int nb_coded_side_data;
3086
3087 /**
3088 * A reference to the AVHWFramesContext describing the input (for encoding)
3089 * or output (decoding) frames. The reference is set by the caller and
3090 * afterwards owned (and freed) by libavcodec.
3091 *
3092 * - decoding: This field should be set by the caller from the get_format()
3093 * callback. The previous reference (if any) will always be
3094 * unreffed by libavcodec before the get_format() call.
3095 *
3096 * If the default get_buffer2() is used with a hwaccel pixel
3097 * format, then this AVHWFramesContext will be used for
3098 * allocating the frame buffers.
3099 *
3100 * - encoding: For hardware encoders configured to use a hwaccel pixel
3101 * format, this field should be set by the caller to a reference
3102 * to the AVHWFramesContext describing input frames.
3103 * AVHWFramesContext.format must be equal to
3104 * AVCodecContext.pix_fmt.
3105 *
3106 * This field should be set before avcodec_open2() is called.
3107 */
3108 AVBufferRef *hw_frames_ctx;
3109 } AVCodecContext;
3110
3111 /**
3112 * AVProfile.
3113 */
3114 typedef struct AVProfile {
3115 int profile;
3116 const char *name; ///< short name for the profile
3117 } AVProfile;
3118
3119 typedef struct AVCodecDefault AVCodecDefault;
3120
3121 struct AVSubtitle;
3122
3123 /**
3124 * AVCodec.
3125 */
3126 typedef struct AVCodec {
3127 /**
3128 * Name of the codec implementation.
3129 * The name is globally unique among encoders and among decoders (but an
3130 * encoder and a decoder can share the same name).
3131 * This is the primary way to find a codec from the user perspective.
3132 */
3133 const char *name;
3134 /**
3135 * Descriptive name for the codec, meant to be more human readable than name.
3136 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3137 */
3138 const char *long_name;
3139 enum AVMediaType type;
3140 enum AVCodecID id;
3141 /**
3142 * Codec capabilities.
3143 * see AV_CODEC_CAP_*
3144 */
3145 int capabilities;
3146 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3147 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3148 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3149 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3150 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3151 #if FF_API_LOWRES
3152 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3153 #endif
3154 const AVClass *priv_class; ///< AVClass for the private context
3155 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3156
3157 /*****************************************************************
3158 * No fields below this line are part of the public API. They
3159 * may not be used outside of libavcodec and can be changed and
3160 * removed at will.
3161 * New public fields should be added right above.
3162 *****************************************************************
3163 */
3164 int priv_data_size;
3165 struct AVCodec *next;
3166 /**
3167 * @name Frame-level threading support functions
3168 * @{
3169 */
3170 /**
3171 * If defined, called on thread contexts when they are created.
3172 * If the codec allocates writable tables in init(), re-allocate them here.
3173 * priv_data will be set to a copy of the original.
3174 */
3175 int (*init_thread_copy)(AVCodecContext *);
3176 /**
3177 * Copy necessary context variables from a previous thread context to the current one.
3178 * If not defined, the next thread will start automatically; otherwise, the codec
3179 * must call ff_thread_finish_setup().
3180 *
3181 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3182 */
3183 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3184 /** @} */
3185
3186 /**
3187 * Private codec-specific defaults.
3188 */
3189 const AVCodecDefault *defaults;
3190
3191 /**
3192 * Initialize codec static data, called from avcodec_register().
3193 */
3194 void (*init_static_data)(struct AVCodec *codec);
3195
3196 int (*init)(AVCodecContext *);
3197 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3198 const struct AVSubtitle *sub);
3199 /**
3200 * Encode data to an AVPacket.
3201 *
3202 * @param avctx codec context
3203 * @param avpkt output AVPacket (may contain a user-provided buffer)
3204 * @param[in] frame AVFrame containing the raw data to be encoded
3205 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3206 * non-empty packet was returned in avpkt.
3207 * @return 0 on success, negative error code on failure
3208 */
3209 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3210 int *got_packet_ptr);
3211 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3212 int (*close)(AVCodecContext *);
3213 /**
3214 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3215 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3216 * that:
3217 * - never called if the codec is closed or the wrong type,
3218 * - AVPacket parameter change side data is applied right before calling
3219 * AVCodec->send_packet,
3220 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3221 * - only one drain packet is ever passed down (until the next flush()),
3222 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3223 */
3224 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3225 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3226 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3227 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3228 /**
3229 * Flush buffers.
3230 * Will be called when seeking
3231 */
3232 void (*flush)(AVCodecContext *);
3233 /**
3234 * Internal codec capabilities.
3235 * See FF_CODEC_CAP_* in internal.h
3236 */
3237 int caps_internal;
3238 } AVCodec;
3239
3240 /**
3241 * @defgroup lavc_hwaccel AVHWAccel
3242 * @{
3243 */
3244 typedef struct AVHWAccel {
3245 /**
3246 * Name of the hardware accelerated codec.
3247 * The name is globally unique among encoders and among decoders (but an
3248 * encoder and a decoder can share the same name).
3249 */
3250 const char *name;
3251
3252 /**
3253 * Type of codec implemented by the hardware accelerator.
3254 *
3255 * See AVMEDIA_TYPE_xxx
3256 */
3257 enum AVMediaType type;
3258
3259 /**
3260 * Codec implemented by the hardware accelerator.
3261 *
3262 * See AV_CODEC_ID_xxx
3263 */
3264 enum AVCodecID id;
3265
3266 /**
3267 * Supported pixel format.
3268 *
3269 * Only hardware accelerated formats are supported here.
3270 */
3271 enum AVPixelFormat pix_fmt;
3272
3273 /**
3274 * Hardware accelerated codec capabilities.
3275 * see FF_HWACCEL_CODEC_CAP_*
3276 */
3277 int capabilities;
3278
3279 /*****************************************************************
3280 * No fields below this line are part of the public API. They
3281 * may not be used outside of libavcodec and can be changed and
3282 * removed at will.
3283 * New public fields should be added right above.
3284 *****************************************************************
3285 */
3286 struct AVHWAccel *next;
3287
3288 /**
3289 * Allocate a custom buffer
3290 */
3291 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3292
3293 /**
3294 * Called at the beginning of each frame or field picture.
3295 *
3296 * Meaningful frame information (codec specific) is guaranteed to
3297 * be parsed at this point. This function is mandatory.
3298 *
3299 * Note that buf can be NULL along with buf_size set to 0.
3300 * Otherwise, this means the whole frame is available at this point.
3301 *
3302 * @param avctx the codec context
3303 * @param buf the frame data buffer base
3304 * @param buf_size the size of the frame in bytes
3305 * @return zero if successful, a negative value otherwise
3306 */
3307 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3308
3309 /**
3310 * Callback for each slice.
3311 *
3312 * Meaningful slice information (codec specific) is guaranteed to
3313 * be parsed at this point. This function is mandatory.
3314 *
3315 * @param avctx the codec context
3316 * @param buf the slice data buffer base
3317 * @param buf_size the size of the slice in bytes
3318 * @return zero if successful, a negative value otherwise
3319 */
3320 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3321
3322 /**
3323 * Called at the end of each frame or field picture.
3324 *
3325 * The whole picture is parsed at this point and can now be sent
3326 * to the hardware accelerator. This function is mandatory.
3327 *
3328 * @param avctx the codec context
3329 * @return zero if successful, a negative value otherwise
3330 */
3331 int (*end_frame)(AVCodecContext *avctx);
3332
3333 /**
3334 * Size of per-frame hardware accelerator private data.
3335 *
3336 * Private data is allocated with av_mallocz() before
3337 * AVCodecContext.get_buffer() and deallocated after
3338 * AVCodecContext.release_buffer().
3339 */
3340 int frame_priv_data_size;
3341
3342 /**
3343 * Initialize the hwaccel private data.
3344 *
3345 * This will be called from ff_get_format(), after hwaccel and
3346 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3347 * is allocated.
3348 */
3349 int (*init)(AVCodecContext *avctx);
3350
3351 /**
3352 * Uninitialize the hwaccel private data.
3353 *
3354 * This will be called from get_format() or avcodec_close(), after hwaccel
3355 * and hwaccel_context are already uninitialized.
3356 */
3357 int (*uninit)(AVCodecContext *avctx);
3358
3359 /**
3360 * Size of the private data to allocate in
3361 * AVCodecInternal.hwaccel_priv_data.
3362 */
3363 int priv_data_size;
3364 } AVHWAccel;
3365
3366 /**
3367 * Hardware acceleration should be used for decoding even if the codec level
3368 * used is unknown or higher than the maximum supported level reported by the
3369 * hardware driver.
3370 */
3371 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3372
3373 /**
3374 * Hardware acceleration can output YUV pixel formats with a different chroma
3375 * sampling than 4:2:0 and/or other than 8 bits per component.
3376 */
3377 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3378
3379 /**
3380 * @}
3381 */
3382
3383 #if FF_API_AVPICTURE
3384 /**
3385 * @defgroup lavc_picture AVPicture
3386 *
3387 * Functions for working with AVPicture
3388 * @{
3389 */
3390
3391 /**
3392 * four components are given, that's all.
3393 * the last component is alpha
3394 * @deprecated Use the imgutils functions
3395 */
3396 typedef struct AVPicture {
3397 attribute_deprecated
3398 uint8_t *data[AV_NUM_DATA_POINTERS];
3399 attribute_deprecated
3400 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3401 } AVPicture;
3402
3403 /**
3404 * @}
3405 */
3406 #endif
3407
3408 #define AVPALETTE_SIZE 1024
3409 #define AVPALETTE_COUNT 256
3410
3411 enum AVSubtitleType {
3412 SUBTITLE_NONE,
3413
3414 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3415
3416 /**
3417 * Plain text, the text field must be set by the decoder and is
3418 * authoritative. ass and pict fields may contain approximations.
3419 */
3420 SUBTITLE_TEXT,
3421
3422 /**
3423 * Formatted text, the ass field must be set by the decoder and is
3424 * authoritative. pict and text fields may contain approximations.
3425 */
3426 SUBTITLE_ASS,
3427 };
3428
3429 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3430
3431 typedef struct AVSubtitleRect {
3432 int x; ///< top left corner of pict, undefined when pict is not set
3433 int y; ///< top left corner of pict, undefined when pict is not set
3434 int w; ///< width of pict, undefined when pict is not set
3435 int h; ///< height of pict, undefined when pict is not set
3436 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3437
3438 #if FF_API_AVPICTURE
3439 /**
3440 * @deprecated unused
3441 */
3442 attribute_deprecated
3443 AVPicture pict;
3444 #endif
3445 /**
3446 * data+linesize for the bitmap of this subtitle.
3447 * Can be set for text/ass as well once they are rendered.
3448 */
3449 uint8_t *data[4];
3450 int linesize[4];
3451
3452 enum AVSubtitleType type;
3453
3454 char *text; ///< 0 terminated plain UTF-8 text
3455
3456 /**
3457 * 0 terminated ASS/SSA compatible event line.
3458 * The presentation of this is unaffected by the other values in this
3459 * struct.
3460 */
3461 char *ass;
3462 int flags;
3463 } AVSubtitleRect;
3464
3465 typedef struct AVSubtitle {
3466 uint16_t format; /* 0 = graphics */
3467 uint32_t start_display_time; /* relative to packet pts, in ms */
3468 uint32_t end_display_time; /* relative to packet pts, in ms */
3469 unsigned num_rects;
3470 AVSubtitleRect **rects;
3471 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3472 } AVSubtitle;
3473
3474 /**
3475 * This struct describes the properties of an encoded stream.
3476 *
3477 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3478 * be allocated with avcodec_parameters_alloc() and freed with
3479 * avcodec_parameters_free().
3480 */
3481 typedef struct AVCodecParameters {
3482 /**
3483 * General type of the encoded data.
3484 */
3485 enum AVMediaType codec_type;
3486 /**
3487 * Specific type of the encoded data (the codec used).
3488 */
3489 enum AVCodecID codec_id;
3490 /**
3491 * Additional information about the codec (corresponds to the AVI FOURCC).
3492 */
3493 uint32_t codec_tag;
3494
3495 /**
3496 * Extra binary data needed for initializing the decoder, codec-dependent.
3497 *
3498 * Must be allocated with av_malloc() and will be freed by
3499 * avcodec_parameters_free(). The allocated size of extradata must be at
3500 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3501 * bytes zeroed.
3502 */
3503 uint8_t *extradata;
3504 /**
3505 * Size of the extradata content in bytes.
3506 */
3507 int extradata_size;
3508
3509 /**
3510 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3511 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3512 */
3513 int format;
3514
3515 /**
3516 * The average bitrate of the encoded data (in bits per second).
3517 */
3518 int bit_rate;
3519
3520 int bits_per_coded_sample;
3521
3522 /**
3523 * Codec-specific bitstream restrictions that the stream conforms to.
3524 */
3525 int profile;
3526 int level;
3527
3528 /**
3529 * Video only. The dimensions of the video frame in pixels.
3530 */
3531 int width;
3532 int height;
3533
3534 /**
3535 * Video only. The aspect ratio (width / height) which a single pixel
3536 * should have when displayed.
3537 *
3538 * When the aspect ratio is unknown / undefined, the numerator should be
3539 * set to 0 (the denominator may have any value).
3540 */
3541 AVRational sample_aspect_ratio;
3542
3543 /**
3544 * Video only. The order of the fields in interlaced video.
3545 */
3546 enum AVFieldOrder field_order;
3547
3548 /**
3549 * Video only. Additional colorspace characteristics.
3550 */
3551 enum AVColorRange color_range;
3552 enum AVColorPrimaries color_primaries;
3553 enum AVColorTransferCharacteristic color_trc;
3554 enum AVColorSpace color_space;
3555 enum AVChromaLocation chroma_location;
3556
3557 /**
3558 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3559 * unknown or unspecified, otherwise the number of bits set must be equal to
3560 * the channels field.
3561 */
3562 uint64_t channel_layout;
3563 /**
3564 * Audio only. The number of audio channels.
3565 */
3566 int channels;
3567 /**
3568 * Audio only. The number of audio samples per second.
3569 */
3570 int sample_rate;
3571 /**
3572 * Audio only. The number of bytes per coded audio frame, required by some
3573 * formats.
3574 *
3575 * Corresponds to nBlockAlign in WAVEFORMATEX.
3576 */
3577 int block_align;
3578
3579 /**
3580 * Audio only. The amount of padding (in samples) inserted by the encoder at
3581 * the beginning of the audio. I.e. this number of leading decoded samples
3582 * must be discarded by the caller to get the original audio without leading
3583 * padding.
3584 */
3585 int initial_padding;
3586 /**
3587 * Audio only. The amount of padding (in samples) appended by the encoder to
3588 * the end of the audio. I.e. this number of decoded samples must be
3589 * discarded by the caller from the end of the stream to get the original
3590 * audio without any trailing padding.
3591 */
3592 int trailing_padding;
3593 } AVCodecParameters;
3594
3595 /**
3596 * If c is NULL, returns the first registered codec,
3597 * if c is non-NULL, returns the next registered codec after c,
3598 * or NULL if c is the last one.
3599 */
3600 AVCodec *av_codec_next(const AVCodec *c);
3601
3602 /**
3603 * Return the LIBAVCODEC_VERSION_INT constant.
3604 */
3605 unsigned avcodec_version(void);
3606
3607 /**
3608 * Return the libavcodec build-time configuration.
3609 */
3610 const char *avcodec_configuration(void);
3611
3612 /**
3613 * Return the libavcodec license.
3614 */
3615 const char *avcodec_license(void);
3616
3617 /**
3618 * Register the codec codec and initialize libavcodec.
3619 *
3620 * @warning either this function or avcodec_register_all() must be called
3621 * before any other libavcodec functions.
3622 *
3623 * @see avcodec_register_all()
3624 */
3625 void avcodec_register(AVCodec *codec);
3626
3627 /**
3628 * Register all the codecs, parsers and bitstream filters which were enabled at
3629 * configuration time. If you do not call this function you can select exactly
3630 * which formats you want to support, by using the individual registration
3631 * functions.
3632 *
3633 * @see avcodec_register
3634 * @see av_register_codec_parser
3635 * @see av_register_bitstream_filter
3636 */
3637 void avcodec_register_all(void);
3638
3639 /**
3640 * Allocate an AVCodecContext and set its fields to default values. The
3641 * resulting struct should be freed with avcodec_free_context().
3642 *
3643 * @param codec if non-NULL, allocate private data and initialize defaults
3644 * for the given codec. It is illegal to then call avcodec_open2()
3645 * with a different codec.
3646 * If NULL, then the codec-specific defaults won't be initialized,
3647 * which may result in suboptimal default settings (this is
3648 * important mainly for encoders, e.g. libx264).
3649 *
3650 * @return An AVCodecContext filled with default values or NULL on failure.
3651 */
3652 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3653
3654 /**
3655 * Free the codec context and everything associated with it and write NULL to
3656 * the provided pointer.
3657 */
3658 void avcodec_free_context(AVCodecContext **avctx);
3659
3660 #if FF_API_GET_CONTEXT_DEFAULTS
3661 /**
3662 * @deprecated This function should not be used, as closing and opening a codec
3663 * context multiple time is not supported. A new codec context should be
3664 * allocated for each new use.
3665 */
3666 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3667 #endif
3668
3669 /**
3670 * Get the AVClass for AVCodecContext. It can be used in combination with
3671 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3672 *
3673 * @see av_opt_find().
3674 */
3675 const AVClass *avcodec_get_class(void);
3676
3677 #if FF_API_COPY_CONTEXT
3678 /**
3679 * Copy the settings of the source AVCodecContext into the destination
3680 * AVCodecContext. The resulting destination codec context will be
3681 * unopened, i.e. you are required to call avcodec_open2() before you
3682 * can use this AVCodecContext to decode/encode video/audio data.
3683 *
3684 * @param dest target codec context, should be initialized with
3685 * avcodec_alloc_context3(), but otherwise uninitialized
3686 * @param src source codec context
3687 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3688 *
3689 * @deprecated The semantics of this function are ill-defined and it should not
3690 * be used. If you need to transfer the stream parameters from one codec context
3691 * to another, use an intermediate AVCodecParameters instance and the
3692 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3693 * functions.
3694 */
3695 attribute_deprecated
3696 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3697 #endif
3698
3699 /**
3700 * Allocate a new AVCodecParameters and set its fields to default values
3701 * (unknown/invalid/0). The returned struct must be freed with
3702 * avcodec_parameters_free().
3703 */
3704 AVCodecParameters *avcodec_parameters_alloc(void);
3705
3706 /**
3707 * Free an AVCodecParameters instance and everything associated with it and
3708 * write NULL to the supplied pointer.
3709 */
3710 void avcodec_parameters_free(AVCodecParameters **par);
3711
3712 /**
3713 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3714 * replaced with newly allocated duplicates of the corresponding fields in src.
3715 *
3716 * @return >= 0 on success, a negative AVERROR code on failure.
3717 */
3718 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3719
3720 /**
3721 * Fill the parameters struct based on the values from the supplied codec
3722 * context. Any allocated fields in par are freed and replaced with duplicates
3723 * of the corresponding fields in codec.
3724 *
3725 * @return >= 0 on success, a negative AVERROR code on failure
3726 */
3727 int avcodec_parameters_from_context(AVCodecParameters *par,
3728 const AVCodecContext *codec);
3729
3730 /**
3731 * Fill the codec context based on the values from the supplied codec
3732 * parameters. Any allocated fields in codec that have a corresponding field in
3733 * par are freed and replaced with duplicates of the corresponding field in par.
3734 * Fields in codec that do not have a counterpart in par are not touched.
3735 *
3736 * @return >= 0 on success, a negative AVERROR code on failure.
3737 */
3738 int avcodec_parameters_to_context(AVCodecContext *codec,
3739 const AVCodecParameters *par);
3740
3741 /**
3742 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3743 * function the context has to be allocated with avcodec_alloc_context3().
3744 *
3745 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3746 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3747 * retrieving a codec.
3748 *
3749 * @warning This function is not thread safe!
3750 *
3751 * @note Always call this function before using decoding routines (such as
3752 * @ref avcodec_receive_frame()).
3753 *
3754 * @code
3755 * avcodec_register_all();
3756 * av_dict_set(&opts, "b", "2.5M", 0);
3757 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3758 * if (!codec)
3759 * exit(1);
3760 *
3761 * context = avcodec_alloc_context3(codec);
3762 *
3763 * if (avcodec_open2(context, codec, opts) < 0)
3764 * exit(1);
3765 * @endcode
3766 *
3767 * @param avctx The context to initialize.
3768 * @param codec The codec to open this context for. If a non-NULL codec has been
3769 * previously passed to avcodec_alloc_context3() or
3770 * for this context, then this parameter MUST be either NULL or
3771 * equal to the previously passed codec.
3772 * @param options A dictionary filled with AVCodecContext and codec-private options.
3773 * On return this object will be filled with options that were not found.
3774 *
3775 * @return zero on success, a negative value on error
3776 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3777 * av_dict_set(), av_opt_find().
3778 */
3779 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3780
3781 /**
3782 * Close a given AVCodecContext and free all the data associated with it
3783 * (but not the AVCodecContext itself).
3784 *
3785 * Calling this function on an AVCodecContext that hasn't been opened will free
3786 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3787 * codec. Subsequent calls will do nothing.
3788 *
3789 * @note Do not use this function. Use avcodec_free_context() to destroy a
3790 * codec context (either open or closed). Opening and closing a codec context
3791 * multiple times is not supported anymore -- use multiple codec contexts
3792 * instead.
3793 */
3794 int avcodec_close(AVCodecContext *avctx);
3795
3796 /**
3797 * Free all allocated data in the given subtitle struct.
3798 *
3799 * @param sub AVSubtitle to free.
3800 */
3801 void avsubtitle_free(AVSubtitle *sub);
3802
3803 /**
3804 * @}
3805 */
3806
3807 /**
3808 * @addtogroup lavc_packet
3809 * @{
3810 */
3811
3812 /**
3813 * Allocate an AVPacket and set its fields to default values. The resulting
3814 * struct must be freed using av_packet_free().
3815 *
3816 * @return An AVPacket filled with default values or NULL on failure.
3817 *
3818 * @note this only allocates the AVPacket itself, not the data buffers. Those
3819 * must be allocated through other means such as av_new_packet.
3820 *
3821 * @see av_new_packet
3822 */
3823 AVPacket *av_packet_alloc(void);
3824
3825 /**
3826 * Create a new packet that references the same data as src.
3827 *
3828 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3829 *
3830 * @return newly created AVPacket on success, NULL on error.
3831 *
3832 * @see av_packet_alloc
3833 * @see av_packet_ref
3834 */
3835 AVPacket *av_packet_clone(const AVPacket *src);
3836
3837 /**
3838 * Free the packet, if the packet is reference counted, it will be
3839 * unreferenced first.
3840 *
3841 * @param pkt packet to be freed. The pointer will be set to NULL.
3842 * @note passing NULL is a no-op.
3843 */
3844 void av_packet_free(AVPacket **pkt);
3845
3846 /**
3847 * Initialize optional fields of a packet with default values.
3848 *
3849 * Note, this does not touch the data and size members, which have to be
3850 * initialized separately.
3851 *
3852 * @param pkt packet
3853 */
3854 void av_init_packet(AVPacket *pkt);
3855
3856 /**
3857 * Allocate the payload of a packet and initialize its fields with
3858 * default values.
3859 *
3860 * @param pkt packet
3861 * @param size wanted payload size
3862 * @return 0 if OK, AVERROR_xxx otherwise
3863 */
3864 int av_new_packet(AVPacket *pkt, int size);
3865
3866 /**
3867 * Reduce packet size, correctly zeroing padding
3868 *
3869 * @param pkt packet
3870 * @param size new size
3871 */
3872 void av_shrink_packet(AVPacket *pkt, int size);
3873
3874 /**
3875 * Increase packet size, correctly zeroing padding
3876 *
3877 * @param pkt packet
3878 * @param grow_by number of bytes by which to increase the size of the packet
3879 */
3880 int av_grow_packet(AVPacket *pkt, int grow_by);
3881
3882 /**
3883 * Initialize a reference-counted packet from av_malloc()ed data.
3884 *
3885 * @param pkt packet to be initialized. This function will set the data, size,
3886 * buf and destruct fields, all others are left untouched.
3887 * @param data Data allocated by av_malloc() to be used as packet data. If this
3888 * function returns successfully, the data is owned by the underlying AVBuffer.
3889 * The caller may not access the data through other means.
3890 * @param size size of data in bytes, without the padding. I.e. the full buffer
3891 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3892 *
3893 * @return 0 on success, a negative AVERROR on error
3894 */
3895 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3896
3897 #if FF_API_AVPACKET_OLD_API
3898 /**
3899 * @warning This is a hack - the packet memory allocation stuff is broken. The
3900 * packet is allocated if it was not really allocated.
3901 *
3902 * @deprecated Use av_packet_ref
3903 */
3904 attribute_deprecated
3905 int av_dup_packet(AVPacket *pkt);
3906 /**
3907 * Free a packet.
3908 *
3909 * @deprecated Use av_packet_unref
3910 *
3911 * @param pkt packet to free
3912 */
3913 attribute_deprecated
3914 void av_free_packet(AVPacket *pkt);
3915 #endif
3916 /**
3917 * Allocate new information of a packet.
3918 *
3919 * @param pkt packet
3920 * @param type side information type
3921 * @param size side information size
3922 * @return pointer to fresh allocated data or NULL otherwise
3923 */
3924 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3925 int size);
3926
3927 /**
3928 * Wrap an existing array as a packet side data.
3929 *
3930 * @param pkt packet
3931 * @param type side information type
3932 * @param data the side data array. It must be allocated with the av_malloc()
3933 * family of functions. The ownership of the data is transferred to
3934 * pkt.
3935 * @param size side information size
3936 * @return a non-negative number on success, a negative AVERROR code on
3937 * failure. On failure, the packet is unchanged and the data remains
3938 * owned by the caller.
3939 */
3940 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3941 uint8_t *data, size_t size);
3942
3943 /**
3944 * Shrink the already allocated side data buffer
3945 *
3946 * @param pkt packet
3947 * @param type side information type
3948 * @param size new side information size
3949 * @return 0 on success, < 0 on failure
3950 */
3951 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3952 int size);
3953
3954 /**
3955 * Get side information from packet.
3956 *
3957 * @param pkt packet
3958 * @param type desired side information type
3959 * @param size pointer for side information size to store (optional)
3960 * @return pointer to data if present or NULL otherwise
3961 */
3962 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3963 int *size);
3964
3965 /**
3966 * Convenience function to free all the side data stored.
3967 * All the other fields stay untouched.
3968 *
3969 * @param pkt packet
3970 */
3971 void av_packet_free_side_data(AVPacket *pkt);
3972
3973 /**
3974 * Setup a new reference to the data described by a given packet
3975 *
3976 * If src is reference-counted, setup dst as a new reference to the
3977 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3978 * data from src into it.
3979 *
3980 * All the other fields are copied from src.
3981 *
3982 * @see av_packet_unref
3983 *
3984 * @param dst Destination packet
3985 * @param src Source packet
3986 *
3987 * @return 0 on success, a negative AVERROR on error.
3988 */
3989 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3990
3991 /**
3992 * Wipe the packet.
3993 *
3994 * Unreference the buffer referenced by the packet and reset the
3995 * remaining packet fields to their default values.
3996 *
3997 * @param pkt The packet to be unreferenced.
3998 */
3999 void av_packet_unref(AVPacket *pkt);
4000
4001 /**
4002 * Move every field in src to dst and reset src.
4003 *
4004 * @see av_packet_unref
4005 *
4006 * @param src Source packet, will be reset
4007 * @param dst Destination packet
4008 */
4009 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4010
4011 /**
4012 * Copy only "properties" fields from src to dst.
4013 *
4014 * Properties for the purpose of this function are all the fields
4015 * beside those related to the packet data (buf, data, size)
4016 *
4017 * @param dst Destination packet
4018 * @param src Source packet
4019 *
4020 * @return 0 on success AVERROR on failure.
4021 */
4022 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4023
4024 /**
4025 * Convert valid timing fields (timestamps / durations) in a packet from one
4026 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4027 * ignored.
4028 *
4029 * @param pkt packet on which the conversion will be performed
4030 * @param tb_src source timebase, in which the timing fields in pkt are
4031 * expressed
4032 * @param tb_dst destination timebase, to which the timing fields will be
4033 * converted
4034 */
4035 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4036
4037 /**
4038 * @}
4039 */
4040
4041 /**
4042 * @addtogroup lavc_decoding
4043 * @{
4044 */
4045
4046 /**
4047 * Find a registered decoder with a matching codec ID.
4048 *
4049 * @param id AVCodecID of the requested decoder
4050 * @return A decoder if one was found, NULL otherwise.
4051 */
4052 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4053
4054 /**
4055 * Find a registered decoder with the specified name.
4056 *
4057 * @param name name of the requested decoder
4058 * @return A decoder if one was found, NULL otherwise.
4059 */
4060 AVCodec *avcodec_find_decoder_by_name(const char *name);
4061
4062 /**
4063 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4064 * it can be called by custom get_buffer2() implementations for decoders without
4065 * AV_CODEC_CAP_DR1 set.
4066 */
4067 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4068
4069 #if FF_API_EMU_EDGE
4070 /**
4071 * Return the amount of padding in pixels which the get_buffer callback must
4072 * provide around the edge of the image for codecs which do not have the
4073 * CODEC_FLAG_EMU_EDGE flag.
4074 *
4075 * @return Required padding in pixels.
4076 *
4077 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4078 * needed
4079 */
4080 attribute_deprecated
4081 unsigned avcodec_get_edge_width(void);
4082 #endif
4083
4084 /**
4085 * Modify width and height values so that they will result in a memory
4086 * buffer that is acceptable for the codec if you do not use any horizontal
4087 * padding.
4088 *
4089 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4090 */
4091 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4092
4093 /**
4094 * Modify width and height values so that they will result in a memory
4095 * buffer that is acceptable for the codec if you also ensure that all
4096 * line sizes are a multiple of the respective linesize_align[i].
4097 *
4098 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4099 */
4100 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4101 int linesize_align[AV_NUM_DATA_POINTERS]);
4102
4103 /**
4104 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4105 *
4106 * Some decoders may support multiple frames in a single AVPacket. Such
4107 * decoders would then just decode the first frame and the return value would be
4108 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4109 * called again with an AVPacket containing the remaining data in order to
4110 * decode the second frame, etc... Even if no frames are returned, the packet
4111 * needs to be fed to the decoder with remaining data until it is completely
4112 * consumed or an error occurs.
4113 *
4114 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4115 * and output. This means that for some packets they will not immediately
4116 * produce decoded output and need to be flushed at the end of decoding to get
4117 * all the decoded data. Flushing is done by calling this function with packets
4118 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4119 * returning samples. It is safe to flush even those decoders that are not
4120 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4121 *
4122 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4123 * larger than the actual read bytes because some optimized bitstream
4124 * readers read 32 or 64 bits at once and could read over the end.
4125 *
4126 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4127 * before packets may be fed to the decoder.
4128 *
4129 * @param avctx the codec context
4130 * @param[out] frame The AVFrame in which to store decoded audio samples.
4131 * The decoder will allocate a buffer for the decoded frame by
4132 * calling the AVCodecContext.get_buffer2() callback.
4133 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4134 * reference counted and the returned reference belongs to the
4135 * caller. The caller must release the frame using av_frame_unref()
4136 * when the frame is no longer needed. The caller may safely write
4137 * to the frame if av_frame_is_writable() returns 1.
4138 * When AVCodecContext.refcounted_frames is set to 0, the returned
4139 * reference belongs to the decoder and is valid only until the
4140 * next call to this function or until closing or flushing the
4141 * decoder. The caller may not write to it.
4142 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4143 * non-zero. Note that this field being set to zero
4144 * does not mean that an error has occurred. For
4145 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4146 * call is guaranteed to produce a frame.
4147 * @param[in] avpkt The input AVPacket containing the input buffer.
4148 * At least avpkt->data and avpkt->size should be set. Some
4149 * decoders might also require additional fields to be set.
4150 * @return A negative error code is returned if an error occurred during
4151 * decoding, otherwise the number of bytes consumed from the input
4152 * AVPacket is returned.
4153 *
4154 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4155 */
4156 attribute_deprecated
4157 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4158 int *got_frame_ptr, AVPacket *avpkt);
4159
4160 /**
4161 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4162 * Some decoders may support multiple frames in a single AVPacket, such
4163 * decoders would then just decode the first frame.
4164 *
4165 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4166 * the actual read bytes because some optimized bitstream readers read 32 or 64
4167 * bits at once and could read over the end.
4168 *
4169 * @warning The end of the input buffer buf should be set to 0 to ensure that
4170 * no overreading happens for damaged MPEG streams.
4171 *
4172 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4173 * between input and output, these need to be fed with avpkt->data=NULL,
4174 * avpkt->size=0 at the end to return the remaining frames.
4175 *
4176 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4177 * before packets may be fed to the decoder.
4178 *
4179 * @param avctx the codec context
4180 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4181 * Use av_frame_alloc() to get an AVFrame. The codec will
4182 * allocate memory for the actual bitmap by calling the
4183 * AVCodecContext.get_buffer2() callback.
4184 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4185 * reference counted and the returned reference belongs to the
4186 * caller. The caller must release the frame using av_frame_unref()
4187 * when the frame is no longer needed. The caller may safely write
4188 * to the frame if av_frame_is_writable() returns 1.
4189 * When AVCodecContext.refcounted_frames is set to 0, the returned
4190 * reference belongs to the decoder and is valid only until the
4191 * next call to this function or until closing or flushing the
4192 * decoder. The caller may not write to it.
4193 *
4194 * @param[in] avpkt The input AVPacket containing the input buffer.
4195 * You can create such packet with av_init_packet() and by then setting
4196 * data and size, some decoders might in addition need other fields like
4197 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4198 * fields possible.
4199 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4200 * @return On error a negative value is returned, otherwise the number of bytes
4201 * used or zero if no frame could be decompressed.
4202 *
4203 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4204 */
4205 attribute_deprecated
4206 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4207 int *got_picture_ptr,
4208 AVPacket *avpkt);
4209
4210 /**
4211 * Decode a subtitle message.
4212 * Return a negative value on error, otherwise return the number of bytes used.
4213 * If no subtitle could be decompressed, got_sub_ptr is zero.
4214 * Otherwise, the subtitle is stored in *sub.
4215 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4216 * simplicity, because the performance difference is expect to be negligible
4217 * and reusing a get_buffer written for video codecs would probably perform badly
4218 * due to a potentially very different allocation pattern.
4219 *
4220 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4221 * before packets may be fed to the decoder.
4222 *
4223 * @param avctx the codec context
4224 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4225 freed with avsubtitle_free if *got_sub_ptr is set.
4226 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4227 * @param[in] avpkt The input AVPacket containing the input buffer.
4228 */
4229 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4230 int *got_sub_ptr,
4231 AVPacket *avpkt);
4232
4233 /**
4234 * Supply raw packet data as input to a decoder.
4235 *
4236 * Internally, this call will copy relevant AVCodecContext fields, which can
4237 * influence decoding per-packet, and apply them when the packet is actually
4238 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4239 * decoder to drop the frame contained by the packet sent with this function.)
4240 *
4241 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4242 * larger than the actual read bytes because some optimized bitstream
4243 * readers read 32 or 64 bits at once and could read over the end.
4244 *
4245 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4246 * on the same AVCodecContext. It will return unexpected results now
4247 * or in future libavcodec versions.
4248 *
4249 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4250 * before packets may be fed to the decoder.
4251 *
4252 * @param avctx codec context
4253 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4254 * frame, or several complete audio frames.
4255 * Ownership of the packet remains with the caller, and the
4256 * decoder will not write to the packet. The decoder may create
4257 * a reference to the packet data (or copy it if the packet is
4258 * not reference-counted).
4259 * Unlike with older APIs, the packet is always fully consumed,
4260 * and if it contains multiple frames (e.g. some audio codecs),
4261 * will require you to call avcodec_receive_frame() multiple
4262 * times afterwards before you can send a new packet.
4263 * It can be NULL (or an AVPacket with data set to NULL and
4264 * size set to 0); in this case, it is considered a flush
4265 * packet, which signals the end of the stream. Sending the
4266 * first flush packet will return success. Subsequent ones are
4267 * unnecessary and will return AVERROR_EOF. If the decoder
4268 * still has frames buffered, it will return them after sending
4269 * a flush packet.
4270 *
4271 * @return 0 on success, otherwise negative error code:
4272 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4273 * resent after trying to read output
4274 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4275 * be sent to it (also returned if more than 1 flush
4276 * packet is sent)
4277 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4278 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4279 * other errors: legitimate decoding errors
4280 */
4281 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4282
4283 /**
4284 * Return decoded output data from a decoder.
4285 *
4286 * @param avctx codec context
4287 * @param frame This will be set to a reference-counted video or audio
4288 * frame (depending on the decoder type) allocated by the
4289 * decoder. Note that the function will always call
4290 * av_frame_unref(frame) before doing anything else.
4291 *
4292 * @return
4293 * 0: success, a frame was returned
4294 * AVERROR(EAGAIN): output is not available right now - user must try
4295 * to send new input
4296 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4297 * no more output frames
4298 * AVERROR(EINVAL): codec not opened, or it is an encoder
4299 * other negative values: legitimate decoding errors
4300 */
4301 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4302
4303 /**
4304 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4305 * to retrieve buffered output packets.
4306 *
4307 * @param avctx codec context
4308 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4309 * Ownership of the frame remains with the caller, and the
4310 * encoder will not write to the frame. The encoder may create
4311 * a reference to the frame data (or copy it if the frame is
4312 * not reference-counted).
4313 * It can be NULL, in which case it is considered a flush
4314 * packet. This signals the end of the stream. If the encoder
4315 * still has packets buffered, it will return them after this
4316 * call. Once flushing mode has been entered, additional flush
4317 * packets are ignored, and sending frames will return
4318 * AVERROR_EOF.
4319 *
4320 * For audio:
4321 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4322 * can have any number of samples.
4323 * If it is not set, frame->nb_samples must be equal to
4324 * avctx->frame_size for all frames except the last.
4325 * The final frame may be smaller than avctx->frame_size.
4326 * @return 0 on success, otherwise negative error code:
4327 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4328 * resent after trying to read output packets
4329 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4330 * be sent to it
4331 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4332 * decoder, or requires flush
4333 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4334 * other errors: legitimate decoding errors
4335 */
4336 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4337
4338 /**
4339 * Read encoded data from the encoder.
4340 *
4341 * @param avctx codec context
4342 * @param avpkt This will be set to a reference-counted packet allocated by the
4343 * encoder. Note that the function will always call
4344 * av_frame_unref(frame) before doing anything else.
4345 * @return 0 on success, otherwise negative error code:
4346 * AVERROR(EAGAIN): output is not available right now - user must try
4347 * to send input
4348 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4349 * no more output packets
4350 * AVERROR(EINVAL): codec not opened, or it is an encoder
4351 * other errors: legitimate decoding errors
4352 */
4353 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4354
4355
4356 /**
4357 * @defgroup lavc_parsing Frame parsing
4358 * @{
4359 */
4360
4361 enum AVPictureStructure {
4362 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4363 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4364 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4365 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4366 };
4367
4368 typedef struct AVCodecParserContext {
4369 void *priv_data;
4370 struct AVCodecParser *parser;
4371 int64_t frame_offset; /* offset of the current frame */
4372 int64_t cur_offset; /* current offset
4373 (incremented by each av_parser_parse()) */
4374 int64_t next_frame_offset; /* offset of the next frame */
4375 /* video info */
4376 int pict_type; /* XXX: Put it back in AVCodecContext. */
4377 /**
4378 * This field is used for proper frame duration computation in lavf.
4379 * It signals, how much longer the frame duration of the current frame
4380 * is compared to normal frame duration.
4381 *
4382 * frame_duration = (1 + repeat_pict) * time_base
4383 *
4384 * It is used by codecs like H.264 to display telecined material.
4385 */
4386 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4387 int64_t pts; /* pts of the current frame */
4388 int64_t dts; /* dts of the current frame */
4389
4390 /* private data */
4391 int64_t last_pts;
4392 int64_t last_dts;
4393 int fetch_timestamp;
4394
4395 #define AV_PARSER_PTS_NB 4
4396 int cur_frame_start_index;
4397 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4398 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4399 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4400
4401 int flags;
4402 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4403 #define PARSER_FLAG_ONCE 0x0002
4404 /// Set if the parser has a valid file offset
4405 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4406
4407 int64_t offset; ///< byte offset from starting packet start
4408 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4409
4410 /**
4411 * Set by parser to 1 for key frames and 0 for non-key frames.
4412 * It is initialized to -1, so if the parser doesn't set this flag,
4413 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4414 * will be used.
4415 */
4416 int key_frame;
4417
4418 #if FF_API_CONVERGENCE_DURATION
4419 /**
4420 * @deprecated unused
4421 */
4422 attribute_deprecated
4423 int64_t convergence_duration;
4424 #endif
4425
4426 // Timestamp generation support:
4427 /**
4428 * Synchronization point for start of timestamp generation.
4429 *
4430 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4431 * (default).
4432 *
4433 * For example, this corresponds to presence of H.264 buffering period
4434 * SEI message.
4435 */
4436 int dts_sync_point;
4437
4438 /**
4439 * Offset of the current timestamp against last timestamp sync point in
4440 * units of AVCodecContext.time_base.
4441 *
4442 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4443 * contain a valid timestamp offset.
4444 *
4445 * Note that the timestamp of sync point has usually a nonzero
4446 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4447 * the next frame after timestamp sync point will be usually 1.
4448 *
4449 * For example, this corresponds to H.264 cpb_removal_delay.
4450 */
4451 int dts_ref_dts_delta;
4452
4453 /**
4454 * Presentation delay of current frame in units of AVCodecContext.time_base.
4455 *
4456 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4457 * contain valid non-negative timestamp delta (presentation time of a frame
4458 * must not lie in the past).
4459 *
4460 * This delay represents the difference between decoding and presentation
4461 * time of the frame.
4462 *
4463 * For example, this corresponds to H.264 dpb_output_delay.
4464 */
4465 int pts_dts_delta;
4466
4467 /**
4468 * Position of the packet in file.
4469 *
4470 * Analogous to cur_frame_pts/dts
4471 */
4472 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4473
4474 /**
4475 * Byte position of currently parsed frame in stream.
4476 */
4477 int64_t pos;
4478
4479 /**
4480 * Previous frame byte position.
4481 */
4482 int64_t last_pos;
4483
4484 /**
4485 * Duration of the current frame.
4486 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4487 * For all other types, this is in units of AVCodecContext.time_base.
4488 */
4489 int duration;
4490
4491 enum AVFieldOrder field_order;
4492
4493 /**
4494 * Indicate whether a picture is coded as a frame, top field or bottom field.
4495 *
4496 * For example, H.264 field_pic_flag equal to 0 corresponds to
4497 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4498 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4499 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4500 */
4501 enum AVPictureStructure picture_structure;
4502
4503 /**
4504 * Picture number incremented in presentation or output order.
4505 * This field may be reinitialized at the first picture of a new sequence.
4506 *
4507 * For example, this corresponds to H.264 PicOrderCnt.
4508 */
4509 int output_picture_number;
4510
4511 /**
4512 * Dimensions of the decoded video intended for presentation.
4513 */
4514 int width;
4515 int height;
4516
4517 /**
4518 * Dimensions of the coded video.
4519 */
4520 int coded_width;
4521 int coded_height;
4522
4523 /**
4524 * The format of the coded data, corresponds to enum AVPixelFormat for video
4525 * and for enum AVSampleFormat for audio.
4526 *
4527 * Note that a decoder can have considerable freedom in how exactly it
4528 * decodes the data, so the format reported here might be different from the
4529 * one returned by a decoder.
4530 */
4531 int format;
4532 } AVCodecParserContext;
4533
4534 typedef struct AVCodecParser {
4535 int codec_ids[5]; /* several codec IDs are permitted */
4536 int priv_data_size;
4537 int (*parser_init)(AVCodecParserContext *s);
4538 /* This callback never returns an error, a negative value means that
4539 * the frame start was in a previous packet. */
4540 int (*parser_parse)(AVCodecParserContext *s,
4541 AVCodecContext *avctx,
4542 const uint8_t **poutbuf, int *poutbuf_size,
4543 const uint8_t *buf, int buf_size);
4544 void (*parser_close)(AVCodecParserContext *s);
4545 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4546 struct AVCodecParser *next;
4547 } AVCodecParser;
4548
4549 AVCodecParser *av_parser_next(const AVCodecParser *c);
4550
4551 void av_register_codec_parser(AVCodecParser *parser);
4552 AVCodecParserContext *av_parser_init(int codec_id);
4553
4554 /**
4555 * Parse a packet.
4556 *
4557 * @param s parser context.
4558 * @param avctx codec context.
4559 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4560 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4561 * @param buf input buffer.
4562 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4563 * @param pts input presentation timestamp.
4564 * @param dts input decoding timestamp.
4565 * @param pos input byte position in stream.
4566 * @return the number of bytes of the input bitstream used.
4567 *
4568 * Example:
4569 * @code
4570 * while(in_len){
4571 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4572 * in_data, in_len,
4573 * pts, dts, pos);
4574 * in_data += len;