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