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