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