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