a3bfcbc4310b8bb3ba4f8d44b7008d63d1d6b3d9
[libav.git] / libavcodec / avcodec.h
1 /*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 libavcodec/avcodec.h
26 * external API header
27 */
28
29 #include <errno.h>
30 #include "libavutil/avutil.h"
31
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 19
34 #define LIBAVCODEC_VERSION_MICRO 0
35
36 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
42 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
43
44 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
45
46 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
47 #define AV_TIME_BASE 1000000
48 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
49
50 /**
51 * Identifies the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
56 * details.
57 *
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
61 */
62 enum CodecID {
63 CODEC_ID_NONE,
64
65 /* video codecs */
66 CODEC_ID_MPEG1VIDEO,
67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
68 CODEC_ID_MPEG2VIDEO_XVMC,
69 CODEC_ID_H261,
70 CODEC_ID_H263,
71 CODEC_ID_RV10,
72 CODEC_ID_RV20,
73 CODEC_ID_MJPEG,
74 CODEC_ID_MJPEGB,
75 CODEC_ID_LJPEG,
76 CODEC_ID_SP5X,
77 CODEC_ID_JPEGLS,
78 CODEC_ID_MPEG4,
79 CODEC_ID_RAWVIDEO,
80 CODEC_ID_MSMPEG4V1,
81 CODEC_ID_MSMPEG4V2,
82 CODEC_ID_MSMPEG4V3,
83 CODEC_ID_WMV1,
84 CODEC_ID_WMV2,
85 CODEC_ID_H263P,
86 CODEC_ID_H263I,
87 CODEC_ID_FLV1,
88 CODEC_ID_SVQ1,
89 CODEC_ID_SVQ3,
90 CODEC_ID_DVVIDEO,
91 CODEC_ID_HUFFYUV,
92 CODEC_ID_CYUV,
93 CODEC_ID_H264,
94 CODEC_ID_INDEO3,
95 CODEC_ID_VP3,
96 CODEC_ID_THEORA,
97 CODEC_ID_ASV1,
98 CODEC_ID_ASV2,
99 CODEC_ID_FFV1,
100 CODEC_ID_4XM,
101 CODEC_ID_VCR1,
102 CODEC_ID_CLJR,
103 CODEC_ID_MDEC,
104 CODEC_ID_ROQ,
105 CODEC_ID_INTERPLAY_VIDEO,
106 CODEC_ID_XAN_WC3,
107 CODEC_ID_XAN_WC4,
108 CODEC_ID_RPZA,
109 CODEC_ID_CINEPAK,
110 CODEC_ID_WS_VQA,
111 CODEC_ID_MSRLE,
112 CODEC_ID_MSVIDEO1,
113 CODEC_ID_IDCIN,
114 CODEC_ID_8BPS,
115 CODEC_ID_SMC,
116 CODEC_ID_FLIC,
117 CODEC_ID_TRUEMOTION1,
118 CODEC_ID_VMDVIDEO,
119 CODEC_ID_MSZH,
120 CODEC_ID_ZLIB,
121 CODEC_ID_QTRLE,
122 CODEC_ID_SNOW,
123 CODEC_ID_TSCC,
124 CODEC_ID_ULTI,
125 CODEC_ID_QDRAW,
126 CODEC_ID_VIXL,
127 CODEC_ID_QPEG,
128 CODEC_ID_XVID,
129 CODEC_ID_PNG,
130 CODEC_ID_PPM,
131 CODEC_ID_PBM,
132 CODEC_ID_PGM,
133 CODEC_ID_PGMYUV,
134 CODEC_ID_PAM,
135 CODEC_ID_FFVHUFF,
136 CODEC_ID_RV30,
137 CODEC_ID_RV40,
138 CODEC_ID_VC1,
139 CODEC_ID_WMV3,
140 CODEC_ID_LOCO,
141 CODEC_ID_WNV1,
142 CODEC_ID_AASC,
143 CODEC_ID_INDEO2,
144 CODEC_ID_FRAPS,
145 CODEC_ID_TRUEMOTION2,
146 CODEC_ID_BMP,
147 CODEC_ID_CSCD,
148 CODEC_ID_MMVIDEO,
149 CODEC_ID_ZMBV,
150 CODEC_ID_AVS,
151 CODEC_ID_SMACKVIDEO,
152 CODEC_ID_NUV,
153 CODEC_ID_KMVC,
154 CODEC_ID_FLASHSV,
155 CODEC_ID_CAVS,
156 CODEC_ID_JPEG2000,
157 CODEC_ID_VMNC,
158 CODEC_ID_VP5,
159 CODEC_ID_VP6,
160 CODEC_ID_VP6F,
161 CODEC_ID_TARGA,
162 CODEC_ID_DSICINVIDEO,
163 CODEC_ID_TIERTEXSEQVIDEO,
164 CODEC_ID_TIFF,
165 CODEC_ID_GIF,
166 CODEC_ID_FFH264,
167 CODEC_ID_DXA,
168 CODEC_ID_DNXHD,
169 CODEC_ID_THP,
170 CODEC_ID_SGI,
171 CODEC_ID_C93,
172 CODEC_ID_BETHSOFTVID,
173 CODEC_ID_PTX,
174 CODEC_ID_TXD,
175 CODEC_ID_VP6A,
176 CODEC_ID_AMV,
177 CODEC_ID_VB,
178 CODEC_ID_PCX,
179 CODEC_ID_SUNRAST,
180 CODEC_ID_INDEO4,
181 CODEC_ID_INDEO5,
182 CODEC_ID_MIMIC,
183 CODEC_ID_RL2,
184 CODEC_ID_8SVX_EXP,
185 CODEC_ID_8SVX_FIB,
186 CODEC_ID_ESCAPE124,
187 CODEC_ID_DIRAC,
188 CODEC_ID_BFI,
189 CODEC_ID_CMV,
190 CODEC_ID_MOTIONPIXELS,
191 CODEC_ID_TGV,
192 CODEC_ID_TGQ,
193 CODEC_ID_TQI,
194
195 /* various PCM "codecs" */
196 CODEC_ID_PCM_S16LE= 0x10000,
197 CODEC_ID_PCM_S16BE,
198 CODEC_ID_PCM_U16LE,
199 CODEC_ID_PCM_U16BE,
200 CODEC_ID_PCM_S8,
201 CODEC_ID_PCM_U8,
202 CODEC_ID_PCM_MULAW,
203 CODEC_ID_PCM_ALAW,
204 CODEC_ID_PCM_S32LE,
205 CODEC_ID_PCM_S32BE,
206 CODEC_ID_PCM_U32LE,
207 CODEC_ID_PCM_U32BE,
208 CODEC_ID_PCM_S24LE,
209 CODEC_ID_PCM_S24BE,
210 CODEC_ID_PCM_U24LE,
211 CODEC_ID_PCM_U24BE,
212 CODEC_ID_PCM_S24DAUD,
213 CODEC_ID_PCM_ZORK,
214 CODEC_ID_PCM_S16LE_PLANAR,
215 CODEC_ID_PCM_DVD,
216 CODEC_ID_PCM_F32BE,
217 CODEC_ID_PCM_F32LE,
218 CODEC_ID_PCM_F64BE,
219 CODEC_ID_PCM_F64LE,
220
221 /* various ADPCM codecs */
222 CODEC_ID_ADPCM_IMA_QT= 0x11000,
223 CODEC_ID_ADPCM_IMA_WAV,
224 CODEC_ID_ADPCM_IMA_DK3,
225 CODEC_ID_ADPCM_IMA_DK4,
226 CODEC_ID_ADPCM_IMA_WS,
227 CODEC_ID_ADPCM_IMA_SMJPEG,
228 CODEC_ID_ADPCM_MS,
229 CODEC_ID_ADPCM_4XM,
230 CODEC_ID_ADPCM_XA,
231 CODEC_ID_ADPCM_ADX,
232 CODEC_ID_ADPCM_EA,
233 CODEC_ID_ADPCM_G726,
234 CODEC_ID_ADPCM_CT,
235 CODEC_ID_ADPCM_SWF,
236 CODEC_ID_ADPCM_YAMAHA,
237 CODEC_ID_ADPCM_SBPRO_4,
238 CODEC_ID_ADPCM_SBPRO_3,
239 CODEC_ID_ADPCM_SBPRO_2,
240 CODEC_ID_ADPCM_THP,
241 CODEC_ID_ADPCM_IMA_AMV,
242 CODEC_ID_ADPCM_EA_R1,
243 CODEC_ID_ADPCM_EA_R3,
244 CODEC_ID_ADPCM_EA_R2,
245 CODEC_ID_ADPCM_IMA_EA_SEAD,
246 CODEC_ID_ADPCM_IMA_EA_EACS,
247 CODEC_ID_ADPCM_EA_XAS,
248 CODEC_ID_ADPCM_EA_MAXIS_XA,
249 CODEC_ID_ADPCM_IMA_ISS,
250
251 /* AMR */
252 CODEC_ID_AMR_NB= 0x12000,
253 CODEC_ID_AMR_WB,
254
255 /* RealAudio codecs*/
256 CODEC_ID_RA_144= 0x13000,
257 CODEC_ID_RA_288,
258
259 /* various DPCM codecs */
260 CODEC_ID_ROQ_DPCM= 0x14000,
261 CODEC_ID_INTERPLAY_DPCM,
262 CODEC_ID_XAN_DPCM,
263 CODEC_ID_SOL_DPCM,
264
265 /* audio codecs */
266 CODEC_ID_MP2= 0x15000,
267 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
268 CODEC_ID_AAC,
269 CODEC_ID_AC3,
270 CODEC_ID_DTS,
271 CODEC_ID_VORBIS,
272 CODEC_ID_DVAUDIO,
273 CODEC_ID_WMAV1,
274 CODEC_ID_WMAV2,
275 CODEC_ID_MACE3,
276 CODEC_ID_MACE6,
277 CODEC_ID_VMDAUDIO,
278 CODEC_ID_SONIC,
279 CODEC_ID_SONIC_LS,
280 CODEC_ID_FLAC,
281 CODEC_ID_MP3ADU,
282 CODEC_ID_MP3ON4,
283 CODEC_ID_SHORTEN,
284 CODEC_ID_ALAC,
285 CODEC_ID_WESTWOOD_SND1,
286 CODEC_ID_GSM, ///< as in Berlin toast format
287 CODEC_ID_QDM2,
288 CODEC_ID_COOK,
289 CODEC_ID_TRUESPEECH,
290 CODEC_ID_TTA,
291 CODEC_ID_SMACKAUDIO,
292 CODEC_ID_QCELP,
293 CODEC_ID_WAVPACK,
294 CODEC_ID_DSICINAUDIO,
295 CODEC_ID_IMC,
296 CODEC_ID_MUSEPACK7,
297 CODEC_ID_MLP,
298 CODEC_ID_GSM_MS, /* as found in WAV */
299 CODEC_ID_ATRAC3,
300 CODEC_ID_VOXWARE,
301 CODEC_ID_APE,
302 CODEC_ID_NELLYMOSER,
303 CODEC_ID_MUSEPACK8,
304 CODEC_ID_SPEEX,
305 CODEC_ID_WMAVOICE,
306 CODEC_ID_WMAPRO,
307 CODEC_ID_WMALOSSLESS,
308 CODEC_ID_ATRAC3P,
309 CODEC_ID_EAC3,
310 CODEC_ID_SIPR,
311 CODEC_ID_MP1,
312
313 /* subtitle codecs */
314 CODEC_ID_DVD_SUBTITLE= 0x17000,
315 CODEC_ID_DVB_SUBTITLE,
316 CODEC_ID_TEXT, ///< raw UTF-8 text
317 CODEC_ID_XSUB,
318 CODEC_ID_SSA,
319 CODEC_ID_MOV_TEXT,
320
321 /* other specific kind of codecs (generally used for attachments) */
322 CODEC_ID_TTF= 0x18000,
323
324 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
325
326 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
327 * stream (only used by libavformat) */
328 };
329
330 enum CodecType {
331 CODEC_TYPE_UNKNOWN = -1,
332 CODEC_TYPE_VIDEO,
333 CODEC_TYPE_AUDIO,
334 CODEC_TYPE_DATA,
335 CODEC_TYPE_SUBTITLE,
336 CODEC_TYPE_ATTACHMENT,
337 CODEC_TYPE_NB
338 };
339
340 /**
341 * all in native-endian format
342 */
343 enum SampleFormat {
344 SAMPLE_FMT_NONE = -1,
345 SAMPLE_FMT_U8, ///< unsigned 8 bits
346 SAMPLE_FMT_S16, ///< signed 16 bits
347 SAMPLE_FMT_S32, ///< signed 32 bits
348 SAMPLE_FMT_FLT, ///< float
349 SAMPLE_FMT_DBL, ///< double
350 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
351 };
352
353 /* Audio channel masks */
354 #define CH_FRONT_LEFT 0x00000001
355 #define CH_FRONT_RIGHT 0x00000002
356 #define CH_FRONT_CENTER 0x00000004
357 #define CH_LOW_FREQUENCY 0x00000008
358 #define CH_BACK_LEFT 0x00000010
359 #define CH_BACK_RIGHT 0x00000020
360 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
361 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
362 #define CH_BACK_CENTER 0x00000100
363 #define CH_SIDE_LEFT 0x00000200
364 #define CH_SIDE_RIGHT 0x00000400
365 #define CH_TOP_CENTER 0x00000800
366 #define CH_TOP_FRONT_LEFT 0x00001000
367 #define CH_TOP_FRONT_CENTER 0x00002000
368 #define CH_TOP_FRONT_RIGHT 0x00004000
369 #define CH_TOP_BACK_LEFT 0x00008000
370 #define CH_TOP_BACK_CENTER 0x00010000
371 #define CH_TOP_BACK_RIGHT 0x00020000
372 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
373 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
374
375 /* Audio channel convenience macros */
376 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
377 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
378 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
379 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
380 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
381 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
382 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
383 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
384 CH_BACK_LEFT|CH_BACK_RIGHT|\
385 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
386 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
387
388 /* in bytes */
389 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
390
391 /**
392 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
393 * This is mainly needed because some optimized bitstream readers read
394 * 32 or 64 bit at once and could read over the end.<br>
395 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
396 * MPEG bitstreams could cause overread and segfault.
397 */
398 #define FF_INPUT_BUFFER_PADDING_SIZE 8
399
400 /**
401 * minimum encoding buffer size
402 * Used to avoid some checks during header writing.
403 */
404 #define FF_MIN_BUFFER_SIZE 16384
405
406
407 /**
408 * motion estimation type.
409 */
410 enum Motion_Est_ID {
411 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
412 ME_FULL,
413 ME_LOG,
414 ME_PHODS,
415 ME_EPZS, ///< enhanced predictive zonal search
416 ME_X1, ///< reserved for experiments
417 ME_HEX, ///< hexagon based search
418 ME_UMH, ///< uneven multi-hexagon search
419 ME_ITER, ///< iterative search
420 ME_TESA, ///< transformed exhaustive search algorithm
421 };
422
423 enum AVDiscard{
424 /* We leave some space between them for extensions (drop some
425 * keyframes for intra-only or drop just some bidir frames). */
426 AVDISCARD_NONE =-16, ///< discard nothing
427 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
428 AVDISCARD_NONREF = 8, ///< discard all non reference
429 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
430 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
431 AVDISCARD_ALL = 48, ///< discard all
432 };
433
434 typedef struct RcOverride{
435 int start_frame;
436 int end_frame;
437 int qscale; // If this is 0 then quality_factor will be used instead.
438 float quality_factor;
439 } RcOverride;
440
441 #define FF_MAX_B_FRAMES 16
442
443 /* encoding support
444 These flags can be passed in AVCodecContext.flags before initialization.
445 Note: Not everything is supported yet.
446 */
447
448 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
449 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
450 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
451 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
452 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
453 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
454 /**
455 * The parent program guarantees that the input for B-frames containing
456 * streams is not written to for at least s->max_b_frames+1 frames, if
457 * this is not set the input will be copied.
458 */
459 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
460 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
461 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
462 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
463 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
464 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
465 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
466 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
467 location instead of only at frame boundaries. */
468 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
469 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
470 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
471 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
472 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
473 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
474 /* Fx : Flag for h263+ extra options */
475 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
476 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
477 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
478 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
479 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
480 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
481 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
482 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
483 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
484 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
485 #define CODEC_FLAG_CLOSED_GOP 0x80000000
486 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
487 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
488 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
489 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
490 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
491 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
492 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
493 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
494 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
495 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
496 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
497 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
498 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
499 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
500 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
501 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
502 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
503 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
504
505 /* Unsupported options :
506 * Syntax Arithmetic coding (SAC)
507 * Reference Picture Selection
508 * Independent Segment Decoding */
509 /* /Fx */
510 /* codec capabilities */
511
512 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
513 /**
514 * Codec uses get_buffer() for allocating buffers.
515 * direct rendering method 1
516 */
517 #define CODEC_CAP_DR1 0x0002
518 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
519 #define CODEC_CAP_PARSE_ONLY 0x0004
520 #define CODEC_CAP_TRUNCATED 0x0008
521 /* Codec can export data for HW decoding (XvMC). */
522 #define CODEC_CAP_HWACCEL 0x0010
523 /**
524 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
525 * If this is not set, the codec is guaranteed to never be fed with NULL data.
526 */
527 #define CODEC_CAP_DELAY 0x0020
528 /**
529 * Codec can be fed a final frame with a smaller size.
530 * This can be used to prevent truncation of the last audio samples.
531 */
532 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
533 /**
534 * Codec can export data for HW decoding (VDPAU).
535 */
536 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
537
538 //The following defines may change, don't expect compatibility if you use them.
539 #define MB_TYPE_INTRA4x4 0x0001
540 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
541 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
542 #define MB_TYPE_16x16 0x0008
543 #define MB_TYPE_16x8 0x0010
544 #define MB_TYPE_8x16 0x0020
545 #define MB_TYPE_8x8 0x0040
546 #define MB_TYPE_INTERLACED 0x0080
547 #define MB_TYPE_DIRECT2 0x0100 //FIXME
548 #define MB_TYPE_ACPRED 0x0200
549 #define MB_TYPE_GMC 0x0400
550 #define MB_TYPE_SKIP 0x0800
551 #define MB_TYPE_P0L0 0x1000
552 #define MB_TYPE_P1L0 0x2000
553 #define MB_TYPE_P0L1 0x4000
554 #define MB_TYPE_P1L1 0x8000
555 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
556 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
557 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
558 #define MB_TYPE_QUANT 0x00010000
559 #define MB_TYPE_CBP 0x00020000
560 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
561
562 /**
563 * Pan Scan area.
564 * This specifies the area which should be displayed.
565 * Note there may be multiple such areas for one frame.
566 */
567 typedef struct AVPanScan{
568 /**
569 * id
570 * - encoding: Set by user.
571 * - decoding: Set by libavcodec.
572 */
573 int id;
574
575 /**
576 * width and height in 1/16 pel
577 * - encoding: Set by user.
578 * - decoding: Set by libavcodec.
579 */
580 int width;
581 int height;
582
583 /**
584 * position of the top left corner in 1/16 pel for up to 3 fields/frames
585 * - encoding: Set by user.
586 * - decoding: Set by libavcodec.
587 */
588 int16_t position[3][2];
589 }AVPanScan;
590
591 #define FF_COMMON_FRAME \
592 /**\
593 * pointer to the picture planes.\
594 * This might be different from the first allocated byte\
595 * - encoding: \
596 * - decoding: \
597 */\
598 uint8_t *data[4];\
599 int linesize[4];\
600 /**\
601 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
602 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
603 * - encoding: \
604 * - decoding: \
605 */\
606 uint8_t *base[4];\
607 /**\
608 * 1 -> keyframe, 0-> not\
609 * - encoding: Set by libavcodec.\
610 * - decoding: Set by libavcodec.\
611 */\
612 int key_frame;\
613 \
614 /**\
615 * Picture type of the frame, see ?_TYPE below.\
616 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
617 * - decoding: Set by libavcodec.\
618 */\
619 int pict_type;\
620 \
621 /**\
622 * presentation timestamp in time_base units (time when frame should be shown to user)\
623 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
624 * - encoding: MUST be set by user.\
625 * - decoding: Set by libavcodec.\
626 */\
627 int64_t pts;\
628 \
629 /**\
630 * picture number in bitstream order\
631 * - encoding: set by\
632 * - decoding: Set by libavcodec.\
633 */\
634 int coded_picture_number;\
635 /**\
636 * picture number in display order\
637 * - encoding: set by\
638 * - decoding: Set by libavcodec.\
639 */\
640 int display_picture_number;\
641 \
642 /**\
643 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
644 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
645 * - decoding: Set by libavcodec.\
646 */\
647 int quality; \
648 \
649 /**\
650 * buffer age (1->was last buffer and dint change, 2->..., ...).\
651 * Set to INT_MAX if the buffer has not been used yet.\
652 * - encoding: unused\
653 * - decoding: MUST be set by get_buffer().\
654 */\
655 int age;\
656 \
657 /**\
658 * is this picture used as reference\
659 * The values for this are the same as the MpegEncContext.picture_structure\
660 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
661 * Set to 4 for delayed, non-reference frames.\
662 * - encoding: unused\
663 * - decoding: Set by libavcodec. (before get_buffer() call)).\
664 */\
665 int reference;\
666 \
667 /**\
668 * QP table\
669 * - encoding: unused\
670 * - decoding: Set by libavcodec.\
671 */\
672 int8_t *qscale_table;\
673 /**\
674 * QP store stride\
675 * - encoding: unused\
676 * - decoding: Set by libavcodec.\
677 */\
678 int qstride;\
679 \
680 /**\
681 * mbskip_table[mb]>=1 if MB didn't change\
682 * stride= mb_width = (width+15)>>4\
683 * - encoding: unused\
684 * - decoding: Set by libavcodec.\
685 */\
686 uint8_t *mbskip_table;\
687 \
688 /**\
689 * motion vector table\
690 * @code\
691 * example:\
692 * int mv_sample_log2= 4 - motion_subsample_log2;\
693 * int mb_width= (width+15)>>4;\
694 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
695 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
696 * @endcode\
697 * - encoding: Set by user.\
698 * - decoding: Set by libavcodec.\
699 */\
700 int16_t (*motion_val[2])[2];\
701 \
702 /**\
703 * macroblock type table\
704 * mb_type_base + mb_width + 2\
705 * - encoding: Set by user.\
706 * - decoding: Set by libavcodec.\
707 */\
708 uint32_t *mb_type;\
709 \
710 /**\
711 * log2 of the size of the block which a single vector in motion_val represents: \
712 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
713 * - encoding: unused\
714 * - decoding: Set by libavcodec.\
715 */\
716 uint8_t motion_subsample_log2;\
717 \
718 /**\
719 * for some private data of the user\
720 * - encoding: unused\
721 * - decoding: Set by user.\
722 */\
723 void *opaque;\
724 \
725 /**\
726 * error\
727 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
728 * - decoding: unused\
729 */\
730 uint64_t error[4];\
731 \
732 /**\
733 * type of the buffer (to keep track of who has to deallocate data[*])\
734 * - encoding: Set by the one who allocates it.\
735 * - decoding: Set by the one who allocates it.\
736 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
737 */\
738 int type;\
739 \
740 /**\
741 * When decoding, this signals how much the picture must be delayed.\
742 * extra_delay = repeat_pict / (2*fps)\
743 * - encoding: unused\
744 * - decoding: Set by libavcodec.\
745 */\
746 int repeat_pict;\
747 \
748 /**\
749 * \
750 */\
751 int qscale_type;\
752 \
753 /**\
754 * The content of the picture is interlaced.\
755 * - encoding: Set by user.\
756 * - decoding: Set by libavcodec. (default 0)\
757 */\
758 int interlaced_frame;\
759 \
760 /**\
761 * If the content is interlaced, is top field displayed first.\
762 * - encoding: Set by user.\
763 * - decoding: Set by libavcodec.\
764 */\
765 int top_field_first;\
766 \
767 /**\
768 * Pan scan.\
769 * - encoding: Set by user.\
770 * - decoding: Set by libavcodec.\
771 */\
772 AVPanScan *pan_scan;\
773 \
774 /**\
775 * Tell user application that palette has changed from previous frame.\
776 * - encoding: ??? (no palette-enabled encoder yet)\
777 * - decoding: Set by libavcodec. (default 0).\
778 */\
779 int palette_has_changed;\
780 \
781 /**\
782 * codec suggestion on buffer type if != 0\
783 * - encoding: unused\
784 * - decoding: Set by libavcodec. (before get_buffer() call)).\
785 */\
786 int buffer_hints;\
787 \
788 /**\
789 * DCT coefficients\
790 * - encoding: unused\
791 * - decoding: Set by libavcodec.\
792 */\
793 short *dct_coeff;\
794 \
795 /**\
796 * motion referece frame index\
797 * - encoding: Set by user.\
798 * - decoding: Set by libavcodec.\
799 */\
800 int8_t *ref_index[2];\
801 \
802 /**\
803 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
804 * output in AVFrame.reordered_opaque\
805 * - encoding: unused\
806 * - decoding: Read by user.\
807 */\
808 int64_t reordered_opaque;\
809
810
811 #define FF_QSCALE_TYPE_MPEG1 0
812 #define FF_QSCALE_TYPE_MPEG2 1
813 #define FF_QSCALE_TYPE_H264 2
814
815 #define FF_BUFFER_TYPE_INTERNAL 1
816 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
817 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
818 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
819
820
821 #define FF_I_TYPE 1 ///< Intra
822 #define FF_P_TYPE 2 ///< Predicted
823 #define FF_B_TYPE 3 ///< Bi-dir predicted
824 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
825 #define FF_SI_TYPE 5 ///< Switching Intra
826 #define FF_SP_TYPE 6 ///< Switching Predicted
827 #define FF_BI_TYPE 7
828
829 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
830 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
831 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
832 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
833
834 /**
835 * Audio Video Frame.
836 * New fields can be added to the end of FF_COMMON_FRAME with minor version
837 * bumps.
838 * Removal, reordering and changes to existing fields require a major
839 * version bump. No fields should be added into AVFrame before or after
840 * FF_COMMON_FRAME!
841 * sizeof(AVFrame) must not be used outside libav*.
842 */
843 typedef struct AVFrame {
844 FF_COMMON_FRAME
845 } AVFrame;
846
847 /**
848 * main external API structure.
849 * New fields can be added to the end with minor version bumps.
850 * Removal, reordering and changes to existing fields require a major
851 * version bump.
852 * sizeof(AVCodecContext) must not be used outside libav*.
853 */
854 typedef struct AVCodecContext {
855 /**
856 * information on struct for av_log
857 * - set by avcodec_alloc_context
858 */
859 const AVClass *av_class;
860 /**
861 * the average bitrate
862 * - encoding: Set by user; unused for constant quantizer encoding.
863 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
864 */
865 int bit_rate;
866
867 /**
868 * number of bits the bitstream is allowed to diverge from the reference.
869 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
870 * - encoding: Set by user; unused for constant quantizer encoding.
871 * - decoding: unused
872 */
873 int bit_rate_tolerance;
874
875 /**
876 * CODEC_FLAG_*.
877 * - encoding: Set by user.
878 * - decoding: Set by user.
879 */
880 int flags;
881
882 /**
883 * Some codecs need additional format info. It is stored here.
884 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
885 * specific codec MUST set it correctly otherwise stream copy breaks.
886 * In general use of this field by muxers is not recommanded.
887 * - encoding: Set by libavcodec.
888 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
889 */
890 int sub_id;
891
892 /**
893 * Motion estimation algorithm used for video coding.
894 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
895 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
896 * - encoding: MUST be set by user.
897 * - decoding: unused
898 */
899 int me_method;
900
901 /**
902 * some codecs need / can use extradata like Huffman tables.
903 * mjpeg: Huffman tables
904 * rv10: additional flags
905 * mpeg4: global headers (they can be in the bitstream or here)
906 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
907 * than extradata_size to avoid prolems if it is read with the bitstream reader.
908 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
909 * - encoding: Set/allocated/freed by libavcodec.
910 * - decoding: Set/allocated/freed by user.
911 */
912 uint8_t *extradata;
913 int extradata_size;
914
915 /**
916 * This is the fundamental unit of time (in seconds) in terms
917 * of which frame timestamps are represented. For fixed-fps content,
918 * timebase should be 1/framerate and timestamp increments should be
919 * identically 1.
920 * - encoding: MUST be set by user.
921 * - decoding: Set by libavcodec.
922 */
923 AVRational time_base;
924
925 /* video only */
926 /**
927 * picture width / height.
928 * - encoding: MUST be set by user.
929 * - decoding: Set by libavcodec.
930 * Note: For compatibility it is possible to set this instead of
931 * coded_width/height before decoding.
932 */
933 int width, height;
934
935 #define FF_ASPECT_EXTENDED 15
936
937 /**
938 * the number of pictures in a group of pictures, or 0 for intra_only
939 * - encoding: Set by user.
940 * - decoding: unused
941 */
942 int gop_size;
943
944 /**
945 * Pixel format, see PIX_FMT_xxx.
946 * - encoding: Set by user.
947 * - decoding: Set by libavcodec.
948 */
949 enum PixelFormat pix_fmt;
950
951 /**
952 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
953 * has to read frames at native frame rate.
954 * - encoding: Set by user.
955 * - decoding: unused
956 */
957 int rate_emu;
958
959 /**
960 * If non NULL, 'draw_horiz_band' is called by the libavcodec
961 * decoder to draw a horizontal band. It improves cache usage. Not
962 * all codecs can do that. You must check the codec capabilities
963 * beforehand.
964 * The function is also used by hardware acceleration APIs.
965 * It is called at least once during frame decoding to pass
966 * the data needed for hardware render.
967 * In that mode instead of pixel data, AVFrame points to
968 * a structure specific to the acceleration API. The application
969 * reads the structure and can change some fields to indicate progress
970 * or mark state.
971 * - encoding: unused
972 * - decoding: Set by user.
973 * @param height the height of the slice
974 * @param y the y position of the slice
975 * @param type 1->top field, 2->bottom field, 3->frame
976 * @param offset offset into the AVFrame.data from which the slice should be read
977 */
978 void (*draw_horiz_band)(struct AVCodecContext *s,
979 const AVFrame *src, int offset[4],
980 int y, int type, int height);
981
982 /* audio only */
983 int sample_rate; ///< samples per second
984 int channels; ///< number of audio channels
985
986 /**
987 * audio sample format
988 * - encoding: Set by user.
989 * - decoding: Set by libavcodec.
990 */
991 enum SampleFormat sample_fmt; ///< sample format, currently unused
992
993 /* The following data should not be initialized. */
994 /**
995 * Samples per packet, initialized when calling 'init'.
996 */
997 int frame_size;
998 int frame_number; ///< audio or video frame number
999 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1000
1001 /**
1002 * Number of frames the decoded output will be delayed relative to
1003 * the encoded input.
1004 * - encoding: Set by libavcodec.
1005 * - decoding: unused
1006 */
1007 int delay;
1008
1009 /* - encoding parameters */
1010 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1011 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1012
1013 /**
1014 * minimum quantizer
1015 * - encoding: Set by user.
1016 * - decoding: unused
1017 */
1018 int qmin;
1019
1020 /**
1021 * maximum quantizer
1022 * - encoding: Set by user.
1023 * - decoding: unused
1024 */
1025 int qmax;
1026
1027 /**
1028 * maximum quantizer difference between frames
1029 * - encoding: Set by user.
1030 * - decoding: unused
1031 */
1032 int max_qdiff;
1033
1034 /**
1035 * maximum number of B-frames between non-B-frames
1036 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1037 * - encoding: Set by user.
1038 * - decoding: unused
1039 */
1040 int max_b_frames;
1041
1042 /**
1043 * qscale factor between IP and B-frames
1044 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1045 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1046 * - encoding: Set by user.
1047 * - decoding: unused
1048 */
1049 float b_quant_factor;
1050
1051 /** obsolete FIXME remove */
1052 int rc_strategy;
1053 #define FF_RC_STRATEGY_XVID 1
1054
1055 int b_frame_strategy;
1056
1057 /**
1058 * hurry up amount
1059 * - encoding: unused
1060 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1061 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1062 */
1063 int hurry_up;
1064
1065 struct AVCodec *codec;
1066
1067 void *priv_data;
1068
1069 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1070 /* do its best to deliver a chunk with size */
1071 /* below rtp_payload_size, the chunk will start */
1072 /* with a start code on some codecs like H.263. */
1073 /* This doesn't take account of any particular */
1074 /* headers inside the transmitted RTP payload. */
1075
1076
1077 /* The RTP callback: This function is called */
1078 /* every time the encoder has a packet to send. */
1079 /* It depends on the encoder if the data starts */
1080 /* with a Start Code (it should). H.263 does. */
1081 /* mb_nb contains the number of macroblocks */
1082 /* encoded in the RTP payload. */
1083 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1084
1085 /* statistics, used for 2-pass encoding */
1086 int mv_bits;
1087 int header_bits;
1088 int i_tex_bits;
1089 int p_tex_bits;
1090 int i_count;
1091 int p_count;
1092 int skip_count;
1093 int misc_bits;
1094
1095 /**
1096 * number of bits used for the previously encoded frame
1097 * - encoding: Set by libavcodec.
1098 * - decoding: unused
1099 */
1100 int frame_bits;
1101
1102 /**
1103 * Private data of the user, can be used to carry app specific stuff.
1104 * - encoding: Set by user.
1105 * - decoding: Set by user.
1106 */
1107 void *opaque;
1108
1109 char codec_name[32];
1110 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1111 enum CodecID codec_id; /* see CODEC_ID_xxx */
1112
1113 /**
1114 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1115 * This is used to work around some encoder bugs.
1116 * A demuxer should set this to what is stored in the field used to identify the codec.
1117 * If there are multiple such fields in a container then the demuxer should choose the one
1118 * which maximizes the information about the used codec.
1119 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1120 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1121 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1122 * first.
1123 * - encoding: Set by user, if not then the default based on codec_id will be used.
1124 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1125 */
1126 unsigned int codec_tag;
1127
1128 /**
1129 * Work around bugs in encoders which sometimes cannot be detected automatically.
1130 * - encoding: Set by user
1131 * - decoding: Set by user
1132 */
1133 int workaround_bugs;
1134 #define FF_BUG_AUTODETECT 1 ///< autodetection
1135 #define FF_BUG_OLD_MSMPEG4 2
1136 #define FF_BUG_XVID_ILACE 4
1137 #define FF_BUG_UMP4 8
1138 #define FF_BUG_NO_PADDING 16
1139 #define FF_BUG_AMV 32
1140 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1141 #define FF_BUG_QPEL_CHROMA 64
1142 #define FF_BUG_STD_QPEL 128
1143 #define FF_BUG_QPEL_CHROMA2 256
1144 #define FF_BUG_DIRECT_BLOCKSIZE 512
1145 #define FF_BUG_EDGE 1024
1146 #define FF_BUG_HPEL_CHROMA 2048
1147 #define FF_BUG_DC_CLIP 4096
1148 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1149 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1150
1151 /**
1152 * luma single coefficient elimination threshold
1153 * - encoding: Set by user.
1154 * - decoding: unused
1155 */
1156 int luma_elim_threshold;
1157
1158 /**
1159 * chroma single coeff elimination threshold
1160 * - encoding: Set by user.
1161 * - decoding: unused
1162 */
1163 int chroma_elim_threshold;
1164
1165 /**
1166 * strictly follow the standard (MPEG4, ...).
1167 * - encoding: Set by user.
1168 * - decoding: Set by user.
1169 * Setting this to STRICT or higher means the encoder and decoder will
1170 * generally do stupid things. While setting it to inofficial or lower
1171 * will mean the encoder might use things that are not supported by all
1172 * spec compliant decoders. Decoders make no difference between normal,
1173 * inofficial and experimental, that is they always try to decode things
1174 * when they can unless they are explicitly asked to behave stupid
1175 * (=strictly conform to the specs)
1176 */
1177 int strict_std_compliance;
1178 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1179 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1180 #define FF_COMPLIANCE_NORMAL 0
1181 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1182 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1183
1184 /**
1185 * qscale offset between IP and B-frames
1186 * - encoding: Set by user.
1187 * - decoding: unused
1188 */
1189 float b_quant_offset;
1190
1191 /**
1192 * Error recognization; higher values will detect more errors but may
1193 * misdetect some more or less valid parts as errors.
1194 * - encoding: unused
1195 * - decoding: Set by user.
1196 */
1197 int error_recognition;
1198 #define FF_ER_CAREFUL 1
1199 #define FF_ER_COMPLIANT 2
1200 #define FF_ER_AGGRESSIVE 3
1201 #define FF_ER_VERY_AGGRESSIVE 4
1202
1203 /**
1204 * Called at the beginning of each frame to get a buffer for it.
1205 * If pic.reference is set then the frame will be read later by libavcodec.
1206 * avcodec_align_dimensions() should be used to find the required width and
1207 * height, as they normally need to be rounded up to the next multiple of 16.
1208 * - encoding: unused
1209 * - decoding: Set by libavcodec., user can override.
1210 */
1211 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1212
1213 /**
1214 * Called to release buffers which were allocated with get_buffer.
1215 * A released buffer can be reused in get_buffer().
1216 * pic.data[*] must be set to NULL.
1217 * - encoding: unused
1218 * - decoding: Set by libavcodec., user can override.
1219 */
1220 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1221
1222 /**
1223 * Size of the frame reordering buffer in the decoder.
1224 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1225 * - encoding: Set by libavcodec.
1226 * - decoding: Set by libavcodec.
1227 */
1228 int has_b_frames;
1229
1230 /**
1231 * number of bytes per packet if constant and known or 0
1232 * Used by some WAV based audio codecs.
1233 */
1234 int block_align;
1235
1236 int parse_only; /* - decoding only: If true, only parsing is done
1237 (function avcodec_parse_frame()). The frame
1238 data is returned. Only MPEG codecs support this now. */
1239
1240 /**
1241 * 0-> h263 quant 1-> mpeg quant
1242 * - encoding: Set by user.
1243 * - decoding: unused
1244 */
1245 int mpeg_quant;
1246
1247 /**
1248 * pass1 encoding statistics output buffer
1249 * - encoding: Set by libavcodec.
1250 * - decoding: unused
1251 */
1252 char *stats_out;
1253
1254 /**
1255 * pass2 encoding statistics input buffer
1256 * Concatenated stuff from stats_out of pass1 should be placed here.
1257 * - encoding: Allocated/set/freed by user.
1258 * - decoding: unused
1259 */
1260 char *stats_in;
1261
1262 /**
1263 * ratecontrol qmin qmax limiting method
1264 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1265 * - encoding: Set by user.
1266 * - decoding: unused
1267 */
1268 float rc_qsquish;
1269
1270 float rc_qmod_amp;
1271 int rc_qmod_freq;
1272
1273 /**
1274 * ratecontrol override, see RcOverride
1275 * - encoding: Allocated/set/freed by user.
1276 * - decoding: unused
1277 */
1278 RcOverride *rc_override;
1279 int rc_override_count;
1280
1281 /**
1282 * rate control equation
1283 * - encoding: Set by user
1284 * - decoding: unused
1285 */
1286 const char *rc_eq;
1287
1288 /**
1289 * maximum bitrate
1290 * - encoding: Set by user.
1291 * - decoding: unused
1292 */
1293 int rc_max_rate;
1294
1295 /**
1296 * minimum bitrate
1297 * - encoding: Set by user.
1298 * - decoding: unused
1299 */
1300 int rc_min_rate;
1301
1302 /**
1303 * decoder bitstream buffer size
1304 * - encoding: Set by user.
1305 * - decoding: unused
1306 */
1307 int rc_buffer_size;
1308 float rc_buffer_aggressivity;
1309
1310 /**
1311 * qscale factor between P and I-frames
1312 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1313 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1314 * - encoding: Set by user.
1315 * - decoding: unused
1316 */
1317 float i_quant_factor;
1318
1319 /**
1320 * qscale offset between P and I-frames
1321 * - encoding: Set by user.
1322 * - decoding: unused
1323 */
1324 float i_quant_offset;
1325
1326 /**
1327 * initial complexity for pass1 ratecontrol
1328 * - encoding: Set by user.
1329 * - decoding: unused
1330 */
1331 float rc_initial_cplx;
1332
1333 /**
1334 * DCT algorithm, see FF_DCT_* below
1335 * - encoding: Set by user.
1336 * - decoding: unused
1337 */
1338 int dct_algo;
1339 #define FF_DCT_AUTO 0
1340 #define FF_DCT_FASTINT 1
1341 #define FF_DCT_INT 2
1342 #define FF_DCT_MMX 3
1343 #define FF_DCT_MLIB 4
1344 #define FF_DCT_ALTIVEC 5
1345 #define FF_DCT_FAAN 6
1346
1347 /**
1348 * luminance masking (0-> disabled)
1349 * - encoding: Set by user.
1350 * - decoding: unused
1351 */
1352 float lumi_masking;
1353
1354 /**
1355 * temporary complexity masking (0-> disabled)
1356 * - encoding: Set by user.
1357 * - decoding: unused
1358 */
1359 float temporal_cplx_masking;
1360
1361 /**
1362 * spatial complexity masking (0-> disabled)
1363 * - encoding: Set by user.
1364 * - decoding: unused
1365 */
1366 float spatial_cplx_masking;
1367
1368 /**
1369 * p block masking (0-> disabled)
1370 * - encoding: Set by user.
1371 * - decoding: unused
1372 */
1373 float p_masking;
1374
1375 /**
1376 * darkness masking (0-> disabled)
1377 * - encoding: Set by user.
1378 * - decoding: unused
1379 */
1380 float dark_masking;
1381
1382 /**
1383 * IDCT algorithm, see FF_IDCT_* below.
1384 * - encoding: Set by user.
1385 * - decoding: Set by user.
1386 */
1387 int idct_algo;
1388 #define FF_IDCT_AUTO 0
1389 #define FF_IDCT_INT 1
1390 #define FF_IDCT_SIMPLE 2
1391 #define FF_IDCT_SIMPLEMMX 3
1392 #define FF_IDCT_LIBMPEG2MMX 4
1393 #define FF_IDCT_PS2 5
1394 #define FF_IDCT_MLIB 6
1395 #define FF_IDCT_ARM 7
1396 #define FF_IDCT_ALTIVEC 8
1397 #define FF_IDCT_SH4 9
1398 #define FF_IDCT_SIMPLEARM 10
1399 #define FF_IDCT_H264 11
1400 #define FF_IDCT_VP3 12
1401 #define FF_IDCT_IPP 13
1402 #define FF_IDCT_XVIDMMX 14
1403 #define FF_IDCT_CAVS 15
1404 #define FF_IDCT_SIMPLEARMV5TE 16
1405 #define FF_IDCT_SIMPLEARMV6 17
1406 #define FF_IDCT_SIMPLEVIS 18
1407 #define FF_IDCT_WMV2 19
1408 #define FF_IDCT_FAAN 20
1409 #define FF_IDCT_EA 21
1410 #define FF_IDCT_SIMPLENEON 22
1411 #define FF_IDCT_SIMPLEALPHA 23
1412
1413 /**
1414 * slice count
1415 * - encoding: Set by libavcodec.
1416 * - decoding: Set by user (or 0).
1417 */
1418 int slice_count;
1419 /**
1420 * slice offsets in the frame in bytes
1421 * - encoding: Set/allocated by libavcodec.
1422 * - decoding: Set/allocated by user (or NULL).
1423 */
1424 int *slice_offset;
1425
1426 /**
1427 * error concealment flags
1428 * - encoding: unused
1429 * - decoding: Set by user.
1430 */
1431 int error_concealment;
1432 #define FF_EC_GUESS_MVS 1
1433 #define FF_EC_DEBLOCK 2
1434
1435 /**
1436 * dsp_mask could be add used to disable unwanted CPU features
1437 * CPU features (i.e. MMX, SSE. ...)
1438 *
1439 * With the FORCE flag you may instead enable given CPU features.
1440 * (Dangerous: Usable in case of misdetection, improper usage however will
1441 * result into program crash.)
1442 */
1443 unsigned dsp_mask;
1444 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1445 /* lower 16 bits - CPU features */
1446 #define FF_MM_MMX 0x0001 ///< standard MMX
1447 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1448 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1449 #define FF_MM_SSE 0x0008 ///< SSE functions
1450 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1451 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1452 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1453 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1454 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1455 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1456
1457 /**
1458 * bits per sample/pixel from the demuxer (needed for huffyuv).
1459 * - encoding: Set by libavcodec.
1460 * - decoding: Set by user.
1461 */
1462 int bits_per_coded_sample;
1463
1464 /**
1465 * prediction method (needed for huffyuv)
1466 * - encoding: Set by user.
1467 * - decoding: unused
1468 */
1469 int prediction_method;
1470 #define FF_PRED_LEFT 0
1471 #define FF_PRED_PLANE 1
1472 #define FF_PRED_MEDIAN 2
1473
1474 /**
1475 * sample aspect ratio (0 if unknown)
1476 * That is the width of a pixel divided by the height of the pixel.
1477 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1478 * - encoding: Set by user.
1479 * - decoding: Set by libavcodec.
1480 */
1481 AVRational sample_aspect_ratio;
1482
1483 /**
1484 * the picture in the bitstream
1485 * - encoding: Set by libavcodec.
1486 * - decoding: Set by libavcodec.
1487 */
1488 AVFrame *coded_frame;
1489
1490 /**
1491 * debug
1492 * - encoding: Set by user.
1493 * - decoding: Set by user.
1494 */
1495 int debug;
1496 #define FF_DEBUG_PICT_INFO 1
1497 #define FF_DEBUG_RC 2
1498 #define FF_DEBUG_BITSTREAM 4
1499 #define FF_DEBUG_MB_TYPE 8
1500 #define FF_DEBUG_QP 16
1501 #define FF_DEBUG_MV 32
1502 #define FF_DEBUG_DCT_COEFF 0x00000040
1503 #define FF_DEBUG_SKIP 0x00000080
1504 #define FF_DEBUG_STARTCODE 0x00000100
1505 #define FF_DEBUG_PTS 0x00000200
1506 #define FF_DEBUG_ER 0x00000400
1507 #define FF_DEBUG_MMCO 0x00000800
1508 #define FF_DEBUG_BUGS 0x00001000
1509 #define FF_DEBUG_VIS_QP 0x00002000
1510 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1511 #define FF_DEBUG_BUFFERS 0x00008000
1512
1513 /**
1514 * debug
1515 * - encoding: Set by user.
1516 * - decoding: Set by user.
1517 */
1518 int debug_mv;
1519 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1520 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1521 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1522
1523 /**
1524 * error
1525 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1526 * - decoding: unused
1527 */
1528 uint64_t error[4];
1529
1530 /**
1531 * minimum MB quantizer
1532 * - encoding: unused
1533 * - decoding: unused
1534 */
1535 int mb_qmin;
1536
1537 /**
1538 * maximum MB quantizer
1539 * - encoding: unused
1540 * - decoding: unused
1541 */
1542 int mb_qmax;
1543
1544 /**
1545 * motion estimation comparison function
1546 * - encoding: Set by user.
1547 * - decoding: unused
1548 */
1549 int me_cmp;
1550 /**
1551 * subpixel motion estimation comparison function
1552 * - encoding: Set by user.
1553 * - decoding: unused
1554 */
1555 int me_sub_cmp;
1556 /**
1557 * macroblock comparison function (not supported yet)
1558 * - encoding: Set by user.
1559 * - decoding: unused
1560 */
1561 int mb_cmp;
1562 /**
1563 * interlaced DCT comparison function
1564 * - encoding: Set by user.
1565 * - decoding: unused
1566 */
1567 int ildct_cmp;
1568 #define FF_CMP_SAD 0
1569 #define FF_CMP_SSE 1
1570 #define FF_CMP_SATD 2
1571 #define FF_CMP_DCT 3
1572 #define FF_CMP_PSNR 4
1573 #define FF_CMP_BIT 5
1574 #define FF_CMP_RD 6
1575 #define FF_CMP_ZERO 7
1576 #define FF_CMP_VSAD 8
1577 #define FF_CMP_VSSE 9
1578 #define FF_CMP_NSSE 10
1579 #define FF_CMP_W53 11
1580 #define FF_CMP_W97 12
1581 #define FF_CMP_DCTMAX 13
1582 #define FF_CMP_DCT264 14
1583 #define FF_CMP_CHROMA 256
1584
1585 /**
1586 * ME diamond size & shape
1587 * - encoding: Set by user.
1588 * - decoding: unused
1589 */
1590 int dia_size;
1591
1592 /**
1593 * amount of previous MV predictors (2a+1 x 2a+1 square)
1594 * - encoding: Set by user.
1595 * - decoding: unused
1596 */
1597 int last_predictor_count;
1598
1599 /**
1600 * prepass for motion estimation
1601 * - encoding: Set by user.
1602 * - decoding: unused
1603 */
1604 int pre_me;
1605
1606 /**
1607 * motion estimation prepass comparison function
1608 * - encoding: Set by user.
1609 * - decoding: unused
1610 */
1611 int me_pre_cmp;
1612
1613 /**
1614 * ME prepass diamond size & shape
1615 * - encoding: Set by user.
1616 * - decoding: unused
1617 */
1618 int pre_dia_size;
1619
1620 /**
1621 * subpel ME quality
1622 * - encoding: Set by user.
1623 * - decoding: unused
1624 */
1625 int me_subpel_quality;
1626
1627 /**
1628 * callback to negotiate the pixelFormat
1629 * @param fmt is the list of formats which are supported by the codec,
1630 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1631 * The first is always the native one.
1632 * @return the chosen format
1633 * - encoding: unused
1634 * - decoding: Set by user, if not set the native format will be chosen.
1635 */
1636 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1637
1638 /**
1639 * DTG active format information (additional aspect ratio
1640 * information only used in DVB MPEG-2 transport streams)
1641 * 0 if not set.
1642 *
1643 * - encoding: unused
1644 * - decoding: Set by decoder.
1645 */
1646 int dtg_active_format;
1647 #define FF_DTG_AFD_SAME 8
1648 #define FF_DTG_AFD_4_3 9
1649 #define FF_DTG_AFD_16_9 10
1650 #define FF_DTG_AFD_14_9 11
1651 #define FF_DTG_AFD_4_3_SP_14_9 13
1652 #define FF_DTG_AFD_16_9_SP_14_9 14
1653 #define FF_DTG_AFD_SP_4_3 15
1654
1655 /**
1656 * maximum motion estimation search range in subpel units
1657 * If 0 then no limit.
1658 *
1659 * - encoding: Set by user.
1660 * - decoding: unused
1661 */
1662 int me_range;
1663
1664 /**
1665 * intra quantizer bias
1666 * - encoding: Set by user.
1667 * - decoding: unused
1668 */
1669 int intra_quant_bias;
1670 #define FF_DEFAULT_QUANT_BIAS 999999
1671
1672 /**
1673 * inter quantizer bias
1674 * - encoding: Set by user.
1675 * - decoding: unused
1676 */
1677 int inter_quant_bias;
1678
1679 /**
1680 * color table ID
1681 * - encoding: unused
1682 * - decoding: Which clrtable should be used for 8bit RGB images.
1683 * Tables have to be stored somewhere. FIXME
1684 */
1685 int color_table_id;
1686
1687 /**
1688 * internal_buffer count
1689 * Don't touch, used by libavcodec default_get_buffer().
1690 */
1691 int internal_buffer_count;
1692
1693 /**
1694 * internal_buffers
1695 * Don't touch, used by libavcodec default_get_buffer().
1696 */
1697 void *internal_buffer;
1698
1699 #define FF_LAMBDA_SHIFT 7
1700 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1701 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1702 #define FF_LAMBDA_MAX (256*128-1)
1703
1704 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1705 /**
1706 * Global quality for codecs which cannot change it per frame.
1707 * This should be proportional to MPEG-1/2/4 qscale.
1708 * - encoding: Set by user.
1709 * - decoding: unused
1710 */
1711 int global_quality;
1712
1713 #define FF_CODER_TYPE_VLC 0
1714 #define FF_CODER_TYPE_AC 1
1715 #define FF_CODER_TYPE_RAW 2
1716 #define FF_CODER_TYPE_RLE 3
1717 #define FF_CODER_TYPE_DEFLATE 4
1718 /**
1719 * coder type
1720 * - encoding: Set by user.
1721 * - decoding: unused
1722 */
1723 int coder_type;
1724
1725 /**
1726 * context model
1727 * - encoding: Set by user.
1728 * - decoding: unused
1729 */
1730 int context_model;
1731 #if 0
1732 /**
1733 *
1734 * - encoding: unused
1735 * - decoding: Set by user.
1736 */
1737 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1738 #endif
1739
1740 /**
1741 * slice flags
1742 * - encoding: unused
1743 * - decoding: Set by user.
1744 */
1745 int slice_flags;
1746 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1747 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1748 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1749
1750 /**
1751 * XVideo Motion Acceleration
1752 * - encoding: forbidden
1753 * - decoding: set by decoder
1754 */
1755 int xvmc_acceleration;
1756
1757 /**
1758 * macroblock decision mode
1759 * - encoding: Set by user.
1760 * - decoding: unused
1761 */
1762 int mb_decision;
1763 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1764 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1765 #define FF_MB_DECISION_RD 2 ///< rate distortion
1766
1767 /**
1768 * custom intra quantization matrix
1769 * - encoding: Set by user, can be NULL.
1770 * - decoding: Set by libavcodec.
1771 */
1772 uint16_t *intra_matrix;
1773
1774 /**
1775 * custom inter quantization matrix
1776 * - encoding: Set by user, can be NULL.
1777 * - decoding: Set by libavcodec.
1778 */
1779 uint16_t *inter_matrix;
1780
1781 /**
1782 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1783 * This is used to work around some encoder bugs.
1784 * - encoding: unused
1785 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1786 */
1787 unsigned int stream_codec_tag;
1788
1789 /**
1790 * scene change detection threshold
1791 * 0 is default, larger means fewer detected scene changes.
1792 * - encoding: Set by user.
1793 * - decoding: unused
1794 */
1795 int scenechange_threshold;
1796
1797 /**
1798 * minimum Lagrange multipler
1799 * - encoding: Set by user.
1800 * - decoding: unused
1801 */
1802 int lmin;
1803
1804 /**
1805 * maximum Lagrange multipler
1806 * - encoding: Set by user.
1807 * - decoding: unused
1808 */
1809 int lmax;
1810
1811 /**
1812 * palette control structure
1813 * - encoding: ??? (no palette-enabled encoder yet)
1814 * - decoding: Set by user.
1815 */
1816 struct AVPaletteControl *palctrl;
1817
1818 /**
1819 * noise reduction strength
1820 * - encoding: Set by user.
1821 * - decoding: unused
1822 */
1823 int noise_reduction;
1824
1825 /**
1826 * Called at the beginning of a frame to get cr buffer for it.
1827 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1828 * libavcodec will pass previous buffer in pic, function should return
1829 * same buffer or new buffer with old frame "painted" into it.
1830 * If pic.data[0] == NULL must behave like get_buffer().
1831 * - encoding: unused
1832 * - decoding: Set by libavcodec., user can override
1833 */
1834 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1835
1836 /**
1837 * Number of bits which should be loaded into the rc buffer before decoding starts.
1838 * - encoding: Set by user.
1839 * - decoding: unused
1840 */
1841 int rc_initial_buffer_occupancy;
1842
1843 /**
1844 *
1845 * - encoding: Set by user.
1846 * - decoding: unused
1847 */
1848 int inter_threshold;
1849
1850 /**
1851 * CODEC_FLAG2_*
1852 * - encoding: Set by user.
1853 * - decoding: Set by user.
1854 */
1855 int flags2;
1856
1857 /**
1858 * Simulates errors in the bitstream to test error concealment.
1859 * - encoding: Set by user.
1860 * - decoding: unused
1861 */
1862 int error_rate;
1863
1864 /**
1865 * MP3 antialias algorithm, see FF_AA_* below.
1866 * - encoding: unused
1867 * - decoding: Set by user.
1868 */
1869 int antialias_algo;
1870 #define FF_AA_AUTO 0
1871 #define FF_AA_FASTINT 1 //not implemented yet
1872 #define FF_AA_INT 2
1873 #define FF_AA_FLOAT 3
1874 /**
1875 * quantizer noise shaping
1876 * - encoding: Set by user.
1877 * - decoding: unused
1878 */
1879 int quantizer_noise_shaping;
1880
1881 /**
1882 * thread count
1883 * is used to decide how many independent tasks should be passed to execute()
1884 * - encoding: Set by user.
1885 * - decoding: Set by user.
1886 */
1887 int thread_count;
1888
1889 /**
1890 * The codec may call this to execute several independent things.
1891 * It will return only after finishing all tasks.
1892 * The user may replace this with some multithreaded implementation,
1893 * the default implementation will execute the parts serially.
1894 * @param count the number of things to execute
1895 * - encoding: Set by libavcodec, user can override.
1896 * - decoding: Set by libavcodec, user can override.
1897 */
1898 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1899
1900 /**
1901 * thread opaque
1902 * Can be used by execute() to store some per AVCodecContext stuff.
1903 * - encoding: set by execute()
1904 * - decoding: set by execute()
1905 */
1906 void *thread_opaque;
1907
1908 /**
1909 * Motion estimation threshold below which no motion estimation is
1910 * performed, but instead the user specified motion vectors are used.
1911 *
1912 * - encoding: Set by user.
1913 * - decoding: unused
1914 */
1915 int me_threshold;
1916
1917 /**
1918 * Macroblock threshold below which the user specified macroblock types will be used.
1919 * - encoding: Set by user.
1920 * - decoding: unused
1921 */
1922 int mb_threshold;
1923
1924 /**
1925 * precision of the intra DC coefficient - 8
1926 * - encoding: Set by user.
1927 * - decoding: unused
1928 */
1929 int intra_dc_precision;
1930
1931 /**
1932 * noise vs. sse weight for the nsse comparsion function
1933 * - encoding: Set by user.
1934 * - decoding: unused
1935 */
1936 int nsse_weight;
1937
1938 /**
1939 * Number of macroblock rows at the top which are skipped.
1940 * - encoding: unused
1941 * - decoding: Set by user.
1942 */
1943 int skip_top;
1944
1945 /**
1946 * Number of macroblock rows at the bottom which are skipped.
1947 * - encoding: unused
1948 * - decoding: Set by user.
1949 */
1950 int skip_bottom;
1951
1952 /**
1953 * profile
1954 * - encoding: Set by user.
1955 * - decoding: Set by libavcodec.
1956 */
1957 int profile;
1958 #define FF_PROFILE_UNKNOWN -99
1959 #define FF_PROFILE_AAC_MAIN 0
1960 #define FF_PROFILE_AAC_LOW 1
1961 #define FF_PROFILE_AAC_SSR 2
1962 #define FF_PROFILE_AAC_LTP 3
1963
1964 /**
1965 * level
1966 * - encoding: Set by user.
1967 * - decoding: Set by libavcodec.
1968 */
1969 int level;
1970 #define FF_LEVEL_UNKNOWN -99
1971
1972 /**
1973 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1974 * - encoding: unused
1975 * - decoding: Set by user.
1976 */
1977 int lowres;
1978
1979 /**
1980 * Bitstream width / height, may be different from width/height if lowres
1981 * or other things are used.
1982 * - encoding: unused
1983 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1984 */
1985 int coded_width, coded_height;
1986
1987 /**
1988 * frame skip threshold
1989 * - encoding: Set by user.
1990 * - decoding: unused
1991 */
1992 int frame_skip_threshold;
1993
1994 /**
1995 * frame skip factor
1996 * - encoding: Set by user.
1997 * - decoding: unused
1998 */
1999 int frame_skip_factor;
2000
2001 /**
2002 * frame skip exponent
2003 * - encoding: Set by user.
2004 * - decoding: unused
2005 */
2006 int frame_skip_exp;
2007
2008 /**
2009 * frame skip comparison function
2010 * - encoding: Set by user.
2011 * - decoding: unused
2012 */
2013 int frame_skip_cmp;
2014
2015 /**
2016 * Border processing masking, raises the quantizer for mbs on the borders
2017 * of the picture.
2018 * - encoding: Set by user.
2019 * - decoding: unused
2020 */
2021 float border_masking;
2022
2023 /**
2024 * minimum MB lagrange multipler
2025 * - encoding: Set by user.
2026 * - decoding: unused
2027 */
2028 int mb_lmin;
2029
2030 /**
2031 * maximum MB lagrange multipler
2032 * - encoding: Set by user.
2033 * - decoding: unused
2034 */
2035 int mb_lmax;
2036
2037 /**
2038 *
2039 * - encoding: Set by user.
2040 * - decoding: unused
2041 */
2042 int me_penalty_compensation;
2043
2044 /**
2045 *
2046 * - encoding: unused
2047 * - decoding: Set by user.
2048 */
2049 enum AVDiscard skip_loop_filter;
2050
2051 /**
2052 *
2053 * - encoding: unused
2054 * - decoding: Set by user.
2055 */
2056 enum AVDiscard skip_idct;
2057
2058 /**
2059 *
2060 * - encoding: unused
2061 * - decoding: Set by user.
2062 */
2063 enum AVDiscard skip_frame;
2064
2065 /**
2066 *
2067 * - encoding: Set by user.
2068 * - decoding: unused
2069 */
2070 int bidir_refine;
2071
2072 /**
2073 *
2074 * - encoding: Set by user.
2075 * - decoding: unused
2076 */
2077 int brd_scale;
2078
2079 /**
2080 * constant rate factor - quality-based VBR - values ~correspond to qps
2081 * - encoding: Set by user.
2082 * - decoding: unused
2083 */
2084 float crf;
2085
2086 /**
2087 * constant quantization parameter rate control method
2088 * - encoding: Set by user.
2089 * - decoding: unused
2090 */
2091 int cqp;
2092
2093 /**
2094 * minimum GOP size
2095 * - encoding: Set by user.
2096 * - decoding: unused
2097 */
2098 int keyint_min;
2099
2100 /**
2101 * number of reference frames
2102 * - encoding: Set by user.
2103 * - decoding: Set by lavc.
2104 */
2105 int refs;
2106
2107 /**
2108 * chroma qp offset from luma
2109 * - encoding: Set by user.
2110 * - decoding: unused
2111 */
2112 int chromaoffset;
2113
2114 /**
2115 * Influences how often B-frames are used.
2116 * - encoding: Set by user.
2117 * - decoding: unused
2118 */
2119 int bframebias;
2120
2121 /**
2122 * trellis RD quantization
2123 * - encoding: Set by user.
2124 * - decoding: unused
2125 */
2126 int trellis;
2127
2128 /**
2129 * Reduce fluctuations in qp (before curve compression).
2130 * - encoding: Set by user.
2131 * - decoding: unused
2132 */
2133 float complexityblur;
2134
2135 /**
2136 * in-loop deblocking filter alphac0 parameter
2137 * alpha is in the range -6...6
2138 * - encoding: Set by user.
2139 * - decoding: unused
2140 */
2141 int deblockalpha;
2142
2143 /**
2144 * in-loop deblocking filter beta parameter
2145 * beta is in the range -6...6
2146 * - encoding: Set by user.
2147 * - decoding: unused
2148 */
2149 int deblockbeta;
2150
2151 /**
2152 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2153 * - encoding: Set by user.
2154 * - decoding: unused
2155 */
2156 int partitions;
2157 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2158 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2159 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2160 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2161 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2162
2163 /**
2164 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2165 * - encoding: Set by user.
2166 * - decoding: unused
2167 */
2168 int directpred;
2169
2170 /**
2171 * Audio cutoff bandwidth (0 means "automatic")
2172 * - encoding: Set by user.
2173 * - decoding: unused
2174 */
2175 int cutoff;
2176
2177 /**
2178 * Multiplied by qscale for each frame and added to scene_change_score.
2179 * - encoding: Set by user.
2180 * - decoding: unused
2181 */
2182 int scenechange_factor;
2183
2184 /**
2185 *
2186 * Note: Value depends upon the compare function used for fullpel ME.
2187 * - encoding: Set by user.
2188 * - decoding: unused
2189 */
2190 int mv0_threshold;
2191
2192 /**
2193 * Adjusts sensitivity of b_frame_strategy 1.
2194 * - encoding: Set by user.
2195 * - decoding: unused
2196 */
2197 int b_sensitivity;
2198
2199 /**
2200 * - encoding: Set by user.
2201 * - decoding: unused
2202 */
2203 int compression_level;
2204 #define FF_COMPRESSION_DEFAULT -1
2205
2206 /**
2207 * Sets whether to use LPC mode - used by FLAC encoder.
2208 * - encoding: Set by user.
2209 * - decoding: unused
2210 */
2211 int use_lpc;
2212
2213 /**
2214 * LPC coefficient precision - used by FLAC encoder
2215 * - encoding: Set by user.
2216 * - decoding: unused
2217 */
2218 int lpc_coeff_precision;
2219
2220 /**
2221 * - encoding: Set by user.
2222 * - decoding: unused
2223 */
2224 int min_prediction_order;
2225
2226 /**
2227 * - encoding: Set by user.
2228 * - decoding: unused
2229 */
2230 int max_prediction_order;
2231
2232 /**
2233 * search method for selecting prediction order
2234 * - encoding: Set by user.
2235 * - decoding: unused
2236 */
2237 int prediction_order_method;
2238
2239 /**
2240 * - encoding: Set by user.
2241 * - decoding: unused
2242 */
2243 int min_partition_order;
2244
2245 /**
2246 * - encoding: Set by user.
2247 * - decoding: unused
2248 */
2249 int max_partition_order;
2250
2251 /**
2252 * GOP timecode frame start number, in non drop frame format
2253 * - encoding: Set by user.
2254 * - decoding: unused
2255 */
2256 int64_t timecode_frame_start;
2257
2258 #if LIBAVCODEC_VERSION_MAJOR < 53
2259 /**
2260 * Decoder should decode to this many channels if it can (0 for default)
2261 * - encoding: unused
2262 * - decoding: Set by user.
2263 * @deprecated Deprecated in favor of request_channel_layout.
2264 */
2265 int request_channels;
2266 #endif
2267
2268 /**
2269 * Percentage of dynamic range compression to be applied by the decoder.
2270 * The default value is 1.0, corresponding to full compression.
2271 * - encoding: unused
2272 * - decoding: Set by user.
2273 */
2274 float drc_scale;
2275
2276 /**
2277 * opaque 64bit number (generally a PTS) that will be reordered and
2278 * output in AVFrame.reordered_opaque
2279 * - encoding: unused
2280 * - decoding: Set by user.
2281 */
2282 int64_t reordered_opaque;
2283
2284 /**
2285 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2286 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2287 * - encoding: set by user.
2288 * - decoding: set by libavcodec.
2289 */
2290 int bits_per_raw_sample;
2291
2292 /**
2293 * Audio channel layout.
2294 * - encoding: set by user.
2295 * - decoding: set by libavcodec.
2296 */
2297 int64_t channel_layout;
2298
2299 /**
2300 * Request decoder to use this channel layout if it can (0 for default)
2301 * - encoding: unused
2302 * - decoding: Set by user.
2303 */
2304 int64_t request_channel_layout;
2305
2306 /**
2307 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2308 * - encoding: Set by user.
2309 * - decoding: unused.
2310 */
2311 float rc_max_available_vbv_use;
2312
2313 /**
2314 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2315 * - encoding: Set by user.
2316 * - decoding: unused.
2317 */
2318 float rc_min_vbv_overflow_use;
2319
2320 /**
2321 * Hardware accelerator in use
2322 * - encoding: unused.
2323 * - decoding: Set by libavcodec
2324 */
2325 struct AVHWAccel *hwaccel;
2326 } AVCodecContext;
2327
2328 /**
2329 * AVCodec.
2330 */
2331 typedef struct AVCodec {
2332 /**
2333 * Name of the codec implementation.
2334 * The name is globally unique among encoders and among decoders (but an
2335 * encoder and a decoder can share the same name).
2336 * This is the primary way to find a codec from the user perspective.
2337 */
2338 const char *name;
2339 enum CodecType type;
2340 enum CodecID id;
2341 int priv_data_size;
2342 int (*init)(AVCodecContext *);
2343 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2344 int (*close)(AVCodecContext *);
2345 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2346 const uint8_t *buf, int buf_size);
2347 /**
2348 * Codec capabilities.
2349 * see CODEC_CAP_*
2350 */
2351 int capabilities;
2352 struct AVCodec *next;
2353 /**
2354 * Flush buffers.
2355 * Will be called when seeking
2356 */
2357 void (*flush)(AVCodecContext *);
2358 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2359 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2360 /**
2361 * Descriptive name for the codec, meant to be more human readable than \p name.
2362 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2363 */
2364 const char *long_name;
2365 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2366 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2367 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2368 } AVCodec;
2369
2370 /**
2371 * AVHWAccel.
2372 */
2373 typedef struct AVHWAccel {
2374 /**
2375 * Name of the hardware accelerated codec.
2376 * The name is globally unique among encoders and among decoders (but an
2377 * encoder and a decoder can share the same name).
2378 */
2379 const char *name;
2380
2381 /**
2382 * Type of codec implemented by the hardware accelerator.
2383 *
2384 * See CODEC_TYPE_xxx
2385 */
2386 enum CodecType type;
2387
2388 /**
2389 * Codec implemented by the hardware accelerator.
2390 *
2391 * See CODEC_ID_xxx
2392 */
2393 enum CodecID id;
2394
2395 /**
2396 * Supported pixel format.
2397 *
2398 * Only hardware accelerated formats are supported here.
2399 */
2400 enum PixelFormat pix_fmt;
2401
2402 /**
2403 * Hardware accelerated codec capabilities.
2404 * see FF_HWACCEL_CODEC_CAP_*
2405 */
2406 int capabilities;
2407
2408 struct AVHWAccel *next;
2409
2410 /**
2411 * Called at the beginning of each frame or field picture.
2412 *
2413 * Meaningful frame information (codec specific) is guaranteed to
2414 * be parsed at this point. This function is mandatory.
2415 *
2416 * Note that \p buf can be NULL along with \p buf_size set to 0.
2417 * Otherwise, this means the whole frame is available at this point.
2418 *
2419 * @param avctx the codec context
2420 * @param buf the frame data buffer base
2421 * @param buf_size the size of the frame in bytes
2422 * @return zero if successful, a negative value otherwise
2423 */
2424 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2425
2426 /**
2427 * Callback for each slice.
2428 *
2429 * Meaningful slice information (codec specific) is guaranteed to
2430 * be parsed at this point. This function is mandatory.
2431 *
2432 * @param avctx the codec context
2433 * @param buf the slice data buffer base
2434 * @param buf_size the size of the slice in bytes
2435 * @return zero if successful, a negative value otherwise
2436 */
2437 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2438
2439 /**
2440 * Called at the end of each frame or field picture.
2441 *
2442 * The whole picture is parsed at this point and can now be sent
2443 * to the hardware accelerator. This function is mandatory.
2444 *
2445 * @param avctx the codec context
2446 * @return zero if successful, a negative value otherwise
2447 */
2448 int (*end_frame)(AVCodecContext *avctx);
2449 } AVHWAccel;
2450
2451 /**
2452 * four components are given, that's all.
2453 * the last component is alpha
2454 */
2455 typedef struct AVPicture {
2456 uint8_t *data[4];
2457 int linesize[4]; ///< number of bytes per line
2458 } AVPicture;
2459
2460 /**
2461 * AVPaletteControl
2462 * This structure defines a method for communicating palette changes
2463 * between and demuxer and a decoder.
2464 *
2465 * @deprecated Use AVPacket to send palette changes instead.
2466 * This is totally broken.
2467 */
2468 #define AVPALETTE_SIZE 1024
2469 #define AVPALETTE_COUNT 256
2470 typedef struct AVPaletteControl {
2471
2472 /* Demuxer sets this to 1 to indicate the palette has changed;
2473 * decoder resets to 0. */
2474 int palette_changed;
2475
2476 /* 4-byte ARGB palette entries, stored in native byte order; note that
2477 * the individual palette components should be on a 8-bit scale; if
2478 * the palette data comes from an IBM VGA native format, the component
2479 * data is probably 6 bits in size and needs to be scaled. */
2480 unsigned int palette[AVPALETTE_COUNT];
2481
2482 } AVPaletteControl attribute_deprecated;
2483
2484 enum AVSubtitleType {
2485 SUBTITLE_NONE,
2486
2487 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2488
2489 /**
2490 * Plain text, the text field must be set by the decoder and is
2491 * authoritative. ass and pict fields may contain approximations.
2492 */
2493 SUBTITLE_TEXT,
2494
2495 /**
2496 * Formatted text, the ass field must be set by the decoder and is
2497 * authoritative. pict and text fields may contain approximations.
2498 */
2499 SUBTITLE_ASS,
2500 };
2501
2502 typedef struct AVSubtitleRect {
2503 int x; ///< top left corner of pict, undefined when pict is not set
2504 int y; ///< top left corner of pict, undefined when pict is not set
2505 int w; ///< width of pict, undefined when pict is not set
2506 int h; ///< height of pict, undefined when pict is not set
2507 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2508
2509 /**
2510 * data+linesize for the bitmap of this subtitle.
2511 * can be set for text/ass as well once they where rendered
2512 */
2513 AVPicture pict;
2514 enum AVSubtitleType type;
2515
2516 char *text; ///< 0 terminated plain UTF-8 text
2517
2518 /**
2519 * 0 terminated ASS/SSA compatible event line.
2520 * The pressentation of this is unaffected by the other values in this
2521 * struct.
2522 */
2523 char *ass;
2524 } AVSubtitleRect;
2525
2526 typedef struct AVSubtitle {
2527 uint16_t format; /* 0 = graphics */
2528 uint32_t start_display_time; /* relative to packet pts, in ms */
2529 uint32_t end_display_time; /* relative to packet pts, in ms */
2530 unsigned num_rects;
2531 AVSubtitleRect **rects;
2532 } AVSubtitle;
2533
2534
2535 /* resample.c */
2536
2537 struct ReSampleContext;
2538 struct AVResampleContext;
2539
2540 typedef struct ReSampleContext ReSampleContext;
2541
2542 #if LIBAVCODEC_VERSION_MAJOR < 53
2543 /**
2544 * @deprecated Use av_audio_resample_init() instead.
2545 */
2546 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2547 int output_rate, int input_rate);
2548 #endif
2549 /**
2550 * Initializes audio resampling context
2551 *
2552 * @param output_channels number of output channels
2553 * @param input_channels number of input channels
2554 * @param output_rate output sample rate
2555 * @param input_rate input sample rate
2556 * @param sample_fmt_out requested output sample format
2557 * @param sample_fmt_in input sample format
2558 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2559 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2560 * @param linear If 1 then the used FIR filter will be linearly interpolated
2561 between the 2 closest, if 0 the closest will be used
2562 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2563 * @return allocated ReSampleContext, NULL if error occured
2564 */
2565 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2566 int output_rate, int input_rate,
2567 enum SampleFormat sample_fmt_out,
2568 enum SampleFormat sample_fmt_in,
2569 int filter_length, int log2_phase_count,
2570 int linear, double cutoff);
2571
2572 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2573 void audio_resample_close(ReSampleContext *s);
2574
2575
2576 /**
2577 * Initializes an audio resampler.
2578 * Note, if either rate is not an integer then simply scale both rates up so they are.
2579 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2580 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2581 * @param linear If 1 then the used FIR filter will be linearly interpolated
2582 between the 2 closest, if 0 the closest will be used
2583 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2584 */
2585 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2586
2587 /**
2588 * resamples.
2589 * @param src an array of unconsumed samples
2590 * @param consumed the number of samples of src which have been consumed are returned here
2591 * @param src_size the number of unconsumed samples available
2592 * @param dst_size the amount of space in samples available in dst
2593 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
2594 * @return the number of samples written in dst or -1 if an error occurred
2595 */
2596 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2597
2598
2599 /**
2600 * Compensates samplerate/timestamp drift. The compensation is done by changing
2601 * the resampler parameters, so no audible clicks or similar distortions occur
2602 * @param compensation_distance distance in output samples over which the compensation should be performed
2603 * @param sample_delta number of output samples which should be output less
2604 *
2605 * example: av_resample_compensate(c, 10, 500)
2606 * here instead of 510 samples only 500 samples would be output
2607 *
2608 * note, due to rounding the actual compensation might be slightly different,
2609 * especially if the compensation_distance is large and the in_rate used during init is small
2610 */
2611 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2612 void av_resample_close(struct AVResampleContext *c);
2613
2614 /**
2615 * Allocate memory for a picture. Call avpicture_free to free it.
2616 *
2617 * @param picture the picture to be filled in
2618 * @param pix_fmt the format of the picture
2619 * @param width the width of the picture
2620 * @param height the height of the picture
2621 * @return zero if successful, a negative value if not
2622 */
2623 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2624
2625 /**
2626 * Free a picture previously allocated by avpicture_alloc().
2627 *
2628 * @param picture the AVPicture to be freed
2629 */
2630 void avpicture_free(AVPicture *picture);
2631
2632 /**
2633 * Fill in the AVPicture fields.
2634 * The fields of the given AVPicture are filled in by using the 'ptr' address
2635 * which points to the image data buffer. Depending on the specified picture
2636 * format, one or multiple image data pointers and line sizes will be set.
2637 * If a planar format is specified, several pointers will be set pointing to
2638 * the different picture planes and the line sizes of the different planes
2639 * will be stored in the lines_sizes array.
2640 *
2641 * @param picture AVPicture whose fields are to be filled in
2642 * @param ptr Buffer which will contain or contains the actual image data
2643 * @param pix_fmt The format in which the picture data is stored.
2644 * @param width the width of the image in pixels
2645 * @param height the height of the image in pixels
2646 * @return size of the image data in bytes
2647 */
2648 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2649 int pix_fmt, int width, int height);
2650 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2651 unsigned char *dest, int dest_size);
2652
2653 /**
2654 * Calculate the size in bytes that a picture of the given width and height
2655 * would occupy if stored in the given picture format.
2656 *
2657 * @param pix_fmt the given picture format
2658 * @param width the width of the image
2659 * @param height the height of the image
2660 * @return Image data size in bytes
2661 */
2662 int avpicture_get_size(int pix_fmt, int width, int height);
2663 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2664 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2665 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2666 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2667 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2668
2669 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2670 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2671 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2672 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2673 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2674 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2675
2676 /**
2677 * Computes what kind of losses will occur when converting from one specific
2678 * pixel format to another.
2679 * When converting from one pixel format to another, information loss may occur.
2680 * For example, when converting from RGB24 to GRAY, the color information will
2681 * be lost. Similarly, other losses occur when converting from some formats to
2682 * other formats. These losses can involve loss of chroma, but also loss of
2683 * resolution, loss of color depth, loss due to the color space conversion, loss
2684 * of the alpha bits or loss due to color quantization.
2685 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2686 * which will occur when converting from one pixel format to another.
2687 *
2688 * @param[in] dst_pix_fmt destination pixel format
2689 * @param[in] src_pix_fmt source pixel format
2690 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2691 * @return Combination of flags informing you what kind of losses will occur.
2692 */
2693 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2694 int has_alpha);
2695
2696 /**
2697 * Finds the best pixel format to convert to given a certain source pixel
2698 * format. When converting from one pixel format to another, information loss
2699 * may occur. For example, when converting from RGB24 to GRAY, the color
2700 * information will be lost. Similarly, other losses occur when converting from
2701 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2702 * the given pixel formats should be used to suffer the least amount of loss.
2703 * The pixel formats from which it chooses one, are determined by the
2704 * \p pix_fmt_mask parameter.
2705 *
2706 * @code
2707 * src_pix_fmt = PIX_FMT_YUV420P;
2708 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2709 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2710 * @endcode
2711 *
2712 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2713 * @param[in] src_pix_fmt source pixel format
2714 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2715 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2716 * @return The best pixel format to convert to or -1 if none was found.
2717 */
2718 int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2719 int has_alpha, int *loss_ptr);
2720
2721
2722 /**
2723 * Print in buf the string corresponding to the pixel format with
2724 * number pix_fmt, or an header if pix_fmt is negative.
2725 *
2726 * @param[in] buf the buffer where to write the string
2727 * @param[in] buf_size the size of buf
2728 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2729 * a negative value to print the corresponding header.
2730 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2731 */
2732 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2733
2734 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2735 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2736
2737 /**
2738 * Tell if an image really has transparent alpha values.
2739 * @return ored mask of FF_ALPHA_xxx constants
2740 */
2741 int img_get_alpha_info(const AVPicture *src,
2742 int pix_fmt, int width, int height);
2743
2744 /* deinterlace a picture */
2745 /* deinterlace - if not supported return -1 */
2746 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2747 int pix_fmt, int width, int height);
2748
2749 /* external high level API */
2750
2751 /**
2752 * If c is NULL, returns the first registered codec,
2753 * if c is non-NULL, returns the next registered codec after c,
2754 * or NULL if c is the last one.
2755 */
2756 AVCodec *av_codec_next(AVCodec *c);
2757
2758 /**
2759 * Returns the LIBAVCODEC_VERSION_INT constant.
2760 */
2761 unsigned avcodec_version(void);
2762
2763 /**
2764 * Initializes libavcodec.
2765 *
2766 * @warning This function \e must be called before any other libavcodec
2767 * function.
2768 */
2769 void avcodec_init(void);
2770
2771 #if LIBAVCODEC_VERSION_MAJOR < 53
2772 /**
2773 * @deprecated Deprecated in favor of avcodec_register().
2774 */
2775 attribute_deprecated void register_avcodec(AVCodec *codec);
2776 #endif
2777
2778 /**
2779 * Register the codec \p codec and initialize libavcodec.
2780 *
2781 * @see avcodec_init()
2782 */
2783 void avcodec_register(AVCodec *codec);
2784
2785 /**
2786 * Finds a registered encoder with a matching codec ID.
2787 *
2788 * @param id CodecID of the requested encoder
2789 * @return An encoder if one was found, NULL otherwise.
2790 */
2791 AVCodec *avcodec_find_encoder(enum CodecID id);
2792
2793 /**
2794 * Finds a registered encoder with the specified name.
2795 *
2796 * @param name name of the requested encoder
2797 * @return An encoder if one was found, NULL otherwise.
2798 */
2799 AVCodec *avcodec_find_encoder_by_name(const char *name);
2800
2801 /**
2802 * Finds a registered decoder with a matching codec ID.
2803 *
2804 * @param id CodecID of the requested decoder
2805 * @return A decoder if one was found, NULL otherwise.
2806 */
2807 AVCodec *avcodec_find_decoder(enum CodecID id);
2808
2809 /**
2810 * Finds a registered decoder with the specified name.
2811 *
2812 * @param name name of the requested decoder
2813 * @return A decoder if one was found, NULL otherwise.
2814 */
2815 AVCodec *avcodec_find_decoder_by_name(const char *name);
2816 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2817
2818 /**
2819 * Sets the fields of the given AVCodecContext to default values.
2820 *
2821 * @param s The AVCodecContext of which the fields should be set to default values.
2822 */
2823 void avcodec_get_context_defaults(AVCodecContext *s);
2824
2825 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2826 * we WILL change its arguments and name a few times! */
2827 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2828
2829 /**
2830 * Allocates an AVCodecContext and sets its fields to default values. The
2831 * resulting struct can be deallocated by simply calling av_free().
2832 *
2833 * @return An AVCodecContext filled with default values or NULL on failure.
2834 * @see avcodec_get_context_defaults
2835 */
2836 AVCodecContext *avcodec_alloc_context(void);
2837
2838 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2839 * we WILL change its arguments and name a few times! */
2840 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2841
2842 /**
2843 * Sets the fields of the given AVFrame to default values.
2844 *
2845 * @param pic The AVFrame of which the fields should be set to default values.
2846 */
2847 void avcodec_get_frame_defaults(AVFrame *pic);
2848
2849 /**
2850 * Allocates an AVFrame and sets its fields to default values. The resulting
2851 * struct can be deallocated by simply calling av_free().
2852 *
2853 * @return An AVFrame filled with default values or NULL on failure.
2854 * @see avcodec_get_frame_defaults
2855 */
2856 AVFrame *avcodec_alloc_frame(void);
2857
2858 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2859 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2860 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2861 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2862
2863 /**
2864 * Checks if the given dimension of a picture is valid, meaning that all
2865 * bytes of the picture can be addressed with a signed int.
2866 *
2867 * @param[in] w Width of the picture.
2868 * @param[in] h Height of the picture.
2869 * @return Zero if valid, a negative value if invalid.
2870 */
2871 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2872 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2873
2874 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2875 void avcodec_thread_free(AVCodecContext *s);
2876 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2877 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2878 //FIXME func typedef
2879
2880 /**
2881 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2882 * function the context has to be allocated.
2883 *
2884 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2885 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2886 * retrieving a codec.
2887 *
2888 * @warning This function is not thread safe!
2889 *
2890 * @code
2891 * avcodec_register_all();
2892 * codec = avcodec_find_decoder(CODEC_ID_H264);
2893 * if (!codec)
2894 * exit(1);
2895 *
2896 * context = avcodec_alloc_context();
2897 *
2898 * if (avcodec_open(context, codec) < 0)
2899 * exit(1);
2900 * @endcode
2901 *
2902 * @param avctx The context which will be set up to use the given codec.
2903 * @param codec The codec to use within the context.
2904 * @return zero on success, a negative value on error
2905 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2906 */
2907 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2908
2909 /**
2910 * Decodes an audio frame from \p buf into \p samples.
2911 * The avcodec_decode_audio2() function decodes an audio frame from the input
2912 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2913 * audio codec which was coupled with \p avctx using avcodec_open(). The
2914 * resulting decoded frame is stored in output buffer \p samples. If no frame
2915 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2916 * decompressed frame size in \e bytes.
2917 *
2918 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2919 * output buffer before calling avcodec_decode_audio2().
2920 *
2921 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2922 * the actual read bytes because some optimized bitstream readers read 32 or 64
2923 * bits at once and could read over the end.
2924 *
2925 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2926 * no overreading happens for damaged MPEG streams.
2927 *
2928 * @note You might have to align the input buffer \p buf and output buffer \p
2929 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2930 * necessary at all, on others it won't work at all if not aligned and on others
2931 * it will work but it will have an impact on performance. In practice, the
2932 * bitstream should have 4 byte alignment at minimum and all sample data should
2933 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2934 * the linesize is not a multiple of 16 then there's no sense in aligning the
2935 * start of the buffer to 16.
2936 *
2937 * @param avctx the codec context
2938 * @param[out] samples the output buffer
2939 * @param[in,out] frame_size_ptr the output buffer size in bytes
2940 * @param[in] buf the input buffer
2941 * @param[in] buf_size the input buffer size in bytes
2942 * @return On error a negative value is returned, otherwise the number of bytes
2943 * used or zero if no frame could be decompressed.
2944 */
2945 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2946 int *frame_size_ptr,
2947 const uint8_t *buf, int buf_size);
2948
2949 /**
2950 * Decodes a video frame from \p buf into \p picture.
2951 * The avcodec_decode_video() function decodes a video frame from the input
2952 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2953 * video codec which was coupled with \p avctx using avcodec_open(). The
2954 * resulting decoded frame is stored in \p picture.
2955 *
2956 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2957 * the actual read bytes because some optimized bitstream readers read 32 or 64
2958 * bits at once and could read over the end.
2959 *
2960 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2961 * no overreading happens for damaged MPEG streams.
2962 *
2963 * @note You might have to align the input buffer \p buf and output buffer \p
2964 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2965 * necessary at all, on others it won't work at all if not aligned and on others
2966 * it will work but it will have an impact on performance. In practice, the
2967 * bitstream should have 4 byte alignment at minimum and all sample data should
2968 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2969 * the linesize is not a multiple of 16 then there's no sense in aligning the
2970 * start of the buffer to 16.
2971 *
2972 * @note Some codecs have a delay between input and output, these need to be
2973 * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
2974 *
2975 * @param avctx the codec context
2976 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2977 * @param[in] buf the input buffer
2978 * @param[in] buf_size the size of the input buffer in bytes
2979 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2980 * @return On error a negative value is returned, otherwise the number of bytes
2981 * used or zero if no frame could be decompressed.
2982 */
2983 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2984 int *got_picture_ptr,
2985 const uint8_t *buf, int buf_size);
2986
2987 /* Decode a subtitle message. Return -1 if error, otherwise return the
2988 * number of bytes used. If no subtitle could be decompressed,
2989 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2990 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2991 int *got_sub_ptr,
2992 const uint8_t *buf, int buf_size);
2993 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2994 int *data_size_ptr,
2995 uint8_t *buf, int buf_size);
2996
2997 /**
2998 * Encodes an audio frame from \p samples into \p buf.
2999 * The avcodec_encode_audio() function encodes an audio frame from the input
3000 * buffer \p samples. To encode it, it makes use of the audio codec which was
3001 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3002 * stored in output buffer \p buf.
3003 *
3004 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3005 *
3006 * @param avctx the codec context
3007 * @param[out] buf the output buffer
3008 * @param[in] buf_size the output buffer size
3009 * @param[in] samples the input buffer containing the samples
3010 * The number of samples read from this buffer is frame_size*channels,
3011 * both of which are defined in \p avctx.
3012 * For PCM audio the number of samples read from \p samples is equal to
3013 * \p buf_size * input_sample_size / output_sample_size.
3014 * @return On error a negative value is returned, on success zero or the number
3015 * of bytes used to encode the data read from the input buffer.
3016 */
3017 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3018 const short *samples);
3019
3020 /**
3021 * Encodes a video frame from \p pict into \p buf.
3022 * The avcodec_encode_video() function encodes a video frame from the input
3023 * \p pict. To encode it, it makes use of the video codec which was coupled with
3024 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
3025 * frame are stored in the output buffer \p buf. The input picture should be
3026 * stored using a specific format, namely \c avctx.pix_fmt.
3027 *
3028 * @param avctx the codec context
3029 * @param[out] buf the output buffer for the bitstream of encoded frame
3030 * @param[in] buf_size the size of the output buffer in bytes
3031 * @param[in] pict the input picture to encode
3032 * @return On error a negative value is returned, on success zero or the number
3033 * of bytes used from the output buffer.
3034 */
3035 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3036 const AVFrame *pict);
3037 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3038 const AVSubtitle *sub);
3039
3040 int avcodec_close(AVCodecContext *avctx);
3041
3042 /**
3043 * Register all the codecs, parsers and bitstream filters which were enabled at
3044 * configuration time. If you do not call this function you can select exactly
3045 * which formats you want to support, by using the individual registration
3046 * functions.
3047 *
3048 * @see avcodec_register
3049 * @see av_register_codec_parser
3050 * @see av_register_bitstream_filter
3051 */
3052 void avcodec_register_all(void);
3053
3054 /**
3055 * Flush buffers, should be called when seeking or when switching to a different stream.
3056 */
3057 void avcodec_flush_buffers(AVCodecContext *avctx);
3058
3059 void avcodec_default_free_buffers(AVCodecContext *s);
3060
3061 /* misc useful functions */
3062
3063 /**
3064 * Returns a single letter to describe the given picture type \p pict_type.
3065 *
3066 * @param[in] pict_type the picture type
3067 * @return A single character representing the picture type.
3068 */
3069 char av_get_pict_type_char(int pict_type);
3070
3071 /**
3072 * Returns codec bits per sample.
3073 *
3074 * @param[in] codec_id the codec
3075 * @return Number of bits per sample or zero if unknown for the given codec.
3076 */
3077 int av_get_bits_per_sample(enum CodecID codec_id);
3078
3079 /**
3080 * Returns sample format bits per sample.
3081 *
3082 * @param[in] sample_fmt the sample format
3083 * @return Number of bits per sample or zero if unknown for the given sample format.
3084 */
3085 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3086
3087 /* frame parsing */
3088 typedef struct AVCodecParserContext {
3089 void *priv_data;
3090 struct AVCodecParser *parser;
3091 int64_t frame_offset; /* offset of the current frame */
3092 int64_t cur_offset; /* current offset
3093 (incremented by each av_parser_parse()) */
3094 int64_t next_frame_offset; /* offset of the next frame */
3095 /* video info */
3096 int pict_type; /* XXX: Put it back in AVCodecContext. */
3097 /**
3098 * This field is used for proper frame duration computation in lavf.
3099 * It signals, how much longer the frame duration of the current frame
3100 * is compared to normal frame duration.
3101 *
3102 * frame_duration = (1 + repeat_pict) * time_base
3103 *
3104 * It is used by codecs like H.264 to display telecined material.
3105 */
3106 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3107 int64_t pts; /* pts of the current frame */
3108 int64_t dts; /* dts of the current frame */
3109
3110 /* private data */
3111 int64_t last_pts;
3112 int64_t last_dts;
3113 int fetch_timestamp;
3114
3115 #define AV_PARSER_PTS_NB 4
3116 int cur_frame_start_index;
3117 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3118 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3119 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3120
3121 int flags;
3122 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3123
3124 int64_t offset; ///< byte offset from starting packet start
3125 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3126
3127 /*!
3128 * Set by parser to 1 for key frames and 0 for non-key frames.
3129 * It is initialized to -1, so if the parser doesn't set this flag,
3130 * old-style fallback using FF_I_TYPE picture type as key frames
3131 * will be used.
3132 */
3133 int key_frame;
3134
3135 /**
3136 * Time difference in stream time base units from the pts of this
3137 * packet to the point at which the output from the decoder has converged
3138 * independent from the availability of previous frames. That is, the
3139 * frames are virtually identical no matter if decoding started from
3140 * the very first frame or from this keyframe.
3141 * Is AV_NOPTS_VALUE if unknown.
3142 * This field is not the display duration of the current frame.
3143 *
3144 * The purpose of this field is to allow seeking in streams that have no
3145 * keyframes in the conventional sense. It corresponds to the
3146 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3147 * essential for some types of subtitle streams to ensure that all
3148 * subtitles are correctly displayed after seeking.
3149 */
3150 int64_t convergence_duration;
3151
3152 // Timestamp generation support:
3153 /**
3154 * Synchronization point for start of timestamp generation.
3155 *
3156 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3157 * (default).
3158 *
3159 * For example, this corresponds to presence of H.264 buffering period
3160 * SEI message.
3161 */
3162 int dts_sync_point;
3163
3164 /**
3165 * Offset of the current timestamp against last timestamp sync point in
3166 * units of AVCodecContext.time_base.
3167 *
3168 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3169 * contain a valid timestamp offset.
3170 *
3171 * Note that the timestamp of sync point has usually a nonzero
3172 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3173 * the next frame after timestamp sync point will be usually 1.
3174 *
3175 * For example, this corresponds to H.264 cpb_removal_delay.
3176 */
3177 int dts_ref_dts_delta;
3178
3179 /**
3180 * Presentation delay of current frame in units of AVCodecContext.time_base.
3181 *
3182 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3183 * contain valid non-negative timestamp delta (presentation time of a frame
3184 * must not lie in the past).
3185 *
3186 * This delay represents the difference between decoding and presentation
3187 * time of the frame.
3188 *
3189 * For example, this corresponds to H.264 dpb_output_delay.
3190 */
3191 int pts_dts_delta;
3192 } AVCodecParserContext;
3193
3194 typedef struct AVCodecParser {
3195 int codec_ids[5]; /* several codec IDs are permitted */
3196 int priv_data_size;
3197 int (*parser_init)(AVCodecParserContext *s);
3198 int (*parser_parse)(AVCodecParserContext *s,
3199 AVCodecContext *avctx,
3200 const uint8_t **poutbuf, int *poutbuf_size,
3201 const uint8_t *buf, int buf_size);
3202 void (*parser_close)(AVCodecParserContext *s);
3203 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3204 struct AVCodecParser *next;
3205 } AVCodecParser;
3206
3207 AVCodecParser *av_parser_next(AVCodecParser *c);
3208
3209 void av_register_codec_parser(AVCodecParser *parser);
3210 AVCodecParserContext *av_parser_init(int codec_id);
3211 int av_parser_parse(AVCodecParserContext *s,
3212 AVCodecContext *avctx,
3213 uint8_t **poutbuf, int *poutbuf_size,
3214 const uint8_t *buf, int buf_size,
3215 int64_t pts, int64_t dts);
3216 int av_parser_change(AVCodecParserContext *s,
3217 AVCodecContext *avctx,
3218 uint8_t **poutbuf, int *poutbuf_size,
3219 const uint8_t *buf, int buf_size, int keyframe);
3220 void av_parser_close(AVCodecParserContext *s);
3221
3222
3223 typedef struct AVBitStreamFilterContext {
3224 void *priv_data;
3225 struct AVBitStreamFilter *filter;
3226 AVCodecParserContext *parser;
3227 struct AVBitStreamFilterContext *next;
3228 } AVBitStreamFilterContext;
3229
3230
3231 typedef struct AVBitStreamFilter {
3232 const char *name;
3233 int priv_data_size;
3234 int (*filter)(AVBitStreamFilterContext *bsfc,
3235 AVCodecContext *avctx, const char *args,
3236 uint8_t **poutbuf, int *poutbuf_size,
3237 const uint8_t *buf, int buf_size, int keyframe);
3238 void (*close)(AVBitStreamFilterContext *bsfc);
3239 struct AVBitStreamFilter *next;
3240 } AVBitStreamFilter;
3241
3242 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3243 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3244 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3245 AVCodecContext *avctx, const char *args,
3246 uint8_t **poutbuf, int *poutbuf_size,
3247 const uint8_t *buf, int buf_size, int keyframe);
3248 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3249
3250 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3251
3252 /* memory */
3253
3254 /**
3255 * Reallocates the given block if it is not large enough, otherwise it
3256 * does nothing.
3257 *
3258 * @see av_realloc
3259 */
3260 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3261
3262 /**
3263 * Copy image 'src' to 'dst'.
3264 */
3265 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3266 int pix_fmt, int width, int height);
3267
3268 /**
3269 * Crop image top and left side.
3270 */
3271 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3272 int pix_fmt, int top_band, int left_band);
3273
3274 /**
3275 * Pad image.
3276 */
3277 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3278 int padtop, int padbottom, int padleft, int padright, int *color);
3279
3280 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3281
3282 /**
3283 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3284 *
3285 * @return 0 in case of a successful parsing, a negative value otherwise
3286 * @param[in] str the string to parse: it has to be a string in the format
3287 * <width>x<height> or a valid video frame size abbreviation.
3288 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3289 * frame width value
3290 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3291 * frame height value
3292 */
3293 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3294
3295 /**
3296 * Parses \p str and put in \p frame_rate the detected values.
3297 *
3298 * @return 0 in case of a successful parsing, a negative value otherwise
3299 * @param[in] str the string to parse: it has to be a string in the format
3300 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3301 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3302 * frame rate
3303 */
3304 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3305
3306 /* error handling */
3307 #if EINVAL > 0
3308 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3309 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3310 #else
3311 /* Some platforms have E* and errno already negated. */
3312 #define AVERROR(e) (e)
3313 #define AVUNERROR(e) (e)
3314 #endif
3315 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3316 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3317 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3318 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3319 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3320 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3321 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3322 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3323 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3324 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3325
3326 /**
3327 * Registers the hardware accelerator \p hwaccel.
3328 */
3329 void av_register_hwaccel(AVHWAccel *hwaccel);
3330
3331 /**
3332 * If hwaccel is NULL, returns the first registered hardware accelerator,
3333 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3334 * after hwaccel, or NULL if hwaccel is the last one.
3335 */
3336 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3337
3338 #endif /* AVCODEC_AVCODEC_H */