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