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