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