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