2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef SWSCALE_SWSCALE_H
22 #define SWSCALE_SWSCALE_H
27 * external api for the swscale stuff
30 #include "libavutil/avutil.h"
32 #define LIBSWSCALE_VERSION_MAJOR 0
33 #define LIBSWSCALE_VERSION_MINOR 14
34 #define LIBSWSCALE_VERSION_MICRO 0
36 #define LIBSWSCALE_VERSION_INT AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \
37 LIBSWSCALE_VERSION_MINOR, \
38 LIBSWSCALE_VERSION_MICRO)
39 #define LIBSWSCALE_VERSION AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \
40 LIBSWSCALE_VERSION_MINOR, \
41 LIBSWSCALE_VERSION_MICRO)
42 #define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT
44 #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
47 * Those FF_API_* defines are not part of public API.
48 * They may change, break or disappear at any time.
50 #ifndef FF_API_SWS_GETCONTEXT
51 #define FF_API_SWS_GETCONTEXT (LIBSWSCALE_VERSION_MAJOR < 2)
53 #ifndef FF_API_SWS_CPU_CAPS
54 #define FF_API_SWS_CPU_CAPS (LIBSWSCALE_VERSION_MAJOR < 2)
58 * Returns the LIBSWSCALE_VERSION_INT constant.
60 unsigned swscale_version(void);
63 * Returns the libswscale build-time configuration.
65 const char *swscale_configuration(void);
68 * Returns the libswscale license.
70 const char *swscale_license(void);
72 /* values for the flags, the stuff on the command line is different */
73 #define SWS_FAST_BILINEAR 1
74 #define SWS_BILINEAR 2
77 #define SWS_POINT 0x10
79 #define SWS_BICUBLIN 0x40
80 #define SWS_GAUSS 0x80
81 #define SWS_SINC 0x100
82 #define SWS_LANCZOS 0x200
83 #define SWS_SPLINE 0x400
85 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
86 #define SWS_SRC_V_CHR_DROP_SHIFT 16
88 #define SWS_PARAM_DEFAULT 123456
90 #define SWS_PRINT_INFO 0x1000
92 //the following 3 flags are not completely implemented
93 //internal chrominace subsampling info
94 #define SWS_FULL_CHR_H_INT 0x2000
95 //input subsampling info
96 #define SWS_FULL_CHR_H_INP 0x4000
97 #define SWS_DIRECT_BGR 0x8000
98 #define SWS_ACCURATE_RND 0x40000
99 #define SWS_BITEXACT 0x80000
101 #if FF_API_SWS_CPU_CAPS
103 * CPU caps are autodetected now, those flags
104 * are only provided for API compatibility.
106 #define SWS_CPU_CAPS_MMX 0x80000000
107 #define SWS_CPU_CAPS_MMX2 0x20000000
108 #define SWS_CPU_CAPS_3DNOW 0x40000000
109 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
110 #define SWS_CPU_CAPS_BFIN 0x01000000
111 #define SWS_CPU_CAPS_SSE2 0x02000000
114 #define SWS_MAX_REDUCE_CUTOFF 0.002
116 #define SWS_CS_ITU709 1
118 #define SWS_CS_ITU601 5
119 #define SWS_CS_ITU624 5
120 #define SWS_CS_SMPTE170M 5
121 #define SWS_CS_SMPTE240M 7
122 #define SWS_CS_DEFAULT 5
125 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
126 * suitable for sws_setColorspaceDetails().
128 * @param colorspace One of the SWS_CS_* macros. If invalid,
129 * SWS_CS_DEFAULT is used.
131 const int *sws_getCoefficients(int colorspace);
134 // when used for filters they must have an odd number of elements
135 // coeffs cannot be shared between vectors
137 double *coeff; ///< pointer to the list of coefficients
138 int length; ///< number of coefficients in the vector
141 // vectors can be shared
152 * Returns a positive value if pix_fmt is a supported input format, 0
155 int sws_isSupportedInput(enum PixelFormat pix_fmt);
158 * Returns a positive value if pix_fmt is a supported output format, 0
161 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
164 * Allocates an empty SwsContext. This must be filled and passed to
165 * sws_init_context(). For filling see AVOptions, options.c and
166 * sws_setColorspaceDetails().
168 struct SwsContext *sws_alloc_context(void);
171 * Initializes the swscaler context sws_context.
173 * @return zero or positive value on success, a negative value on
176 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
179 * Frees the swscaler context swsContext.
180 * If swsContext is NULL, then does nothing.
182 void sws_freeContext(struct SwsContext *swsContext);
184 #if FF_API_SWS_GETCONTEXT
186 * Allocates and returns a SwsContext. You need it to perform
187 * scaling/conversion operations using sws_scale().
189 * @param srcW the width of the source image
190 * @param srcH the height of the source image
191 * @param srcFormat the source image format
192 * @param dstW the width of the destination image
193 * @param dstH the height of the destination image
194 * @param dstFormat the destination image format
195 * @param flags specify which algorithm and options to use for rescaling
196 * @return a pointer to an allocated context, or NULL in case of error
197 * @note this function is to be removed after a saner alternative is
199 * @deprecated Use sws_getCachedContext() instead.
201 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
202 int dstW, int dstH, enum PixelFormat dstFormat,
203 int flags, SwsFilter *srcFilter,
204 SwsFilter *dstFilter, const double *param);
208 * Scales the image slice in srcSlice and puts the resulting scaled
209 * slice in the image in dst. A slice is a sequence of consecutive
212 * Slices have to be provided in sequential order, either in
213 * top-bottom or bottom-top order. If slices are provided in
214 * non-sequential order the behavior of the function is undefined.
216 * @param context the scaling context previously created with
218 * @param srcSlice the array containing the pointers to the planes of
220 * @param srcStride the array containing the strides for each plane of
222 * @param srcSliceY the position in the source image of the slice to
223 * process, that is the number (counted starting from
224 * zero) in the image of the first row of the slice
225 * @param srcSliceH the height of the source slice, that is the number
226 * of rows in the slice
227 * @param dst the array containing the pointers to the planes of
228 * the destination image
229 * @param dstStride the array containing the strides for each plane of
230 * the destination image
231 * @return the height of the output slice
233 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
234 int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
236 #if LIBSWSCALE_VERSION_MAJOR < 1
238 * @deprecated Use sws_scale() instead.
240 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
241 int srcStride[], int srcSliceY, int srcSliceH,
242 uint8_t* dst[], int dstStride[]) attribute_deprecated;
246 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
247 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
248 * @return -1 if not supported
250 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
251 int srcRange, const int table[4], int dstRange,
252 int brightness, int contrast, int saturation);
255 * @return -1 if not supported
257 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
258 int *srcRange, int **table, int *dstRange,
259 int *brightness, int *contrast, int *saturation);
262 * Allocates and returns an uninitialized vector with length coefficients.
264 SwsVector *sws_allocVec(int length);
267 * Returns a normalized Gaussian curve used to filter stuff
268 * quality=3 is high quality, lower is lower quality.
270 SwsVector *sws_getGaussianVec(double variance, double quality);
273 * Allocates and returns a vector with length coefficients, all
274 * with the same value c.
276 SwsVector *sws_getConstVec(double c, int length);
279 * Allocates and returns a vector with just one coefficient, with
282 SwsVector *sws_getIdentityVec(void);
285 * Scales all the coefficients of a by the scalar value.
287 void sws_scaleVec(SwsVector *a, double scalar);
290 * Scales all the coefficients of a so that their sum equals height.
292 void sws_normalizeVec(SwsVector *a, double height);
293 void sws_convVec(SwsVector *a, SwsVector *b);
294 void sws_addVec(SwsVector *a, SwsVector *b);
295 void sws_subVec(SwsVector *a, SwsVector *b);
296 void sws_shiftVec(SwsVector *a, int shift);
299 * Allocates and returns a clone of the vector a, that is a vector
300 * with the same coefficients as a.
302 SwsVector *sws_cloneVec(SwsVector *a);
304 #if LIBSWSCALE_VERSION_MAJOR < 1
306 * @deprecated Use sws_printVec2() instead.
308 attribute_deprecated void sws_printVec(SwsVector *a);
312 * Prints with av_log() a textual representation of the vector a
313 * if log_level <= av_log_level.
315 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
317 void sws_freeVec(SwsVector *a);
319 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
320 float lumaSharpen, float chromaSharpen,
321 float chromaHShift, float chromaVShift,
323 void sws_freeFilter(SwsFilter *filter);
326 * Checks if context can be reused, otherwise reallocates a new
329 * If context is NULL, just calls sws_getContext() to get a new
330 * context. Otherwise, checks if the parameters are the ones already
331 * saved in context. If that is the case, returns the current
332 * context. Otherwise, frees context and gets a new context with
333 * the new parameters.
335 * Be warned that srcFilter and dstFilter are not checked, they
336 * are assumed to remain the same.
338 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
339 int srcW, int srcH, enum PixelFormat srcFormat,
340 int dstW, int dstH, enum PixelFormat dstFormat,
341 int flags, SwsFilter *srcFilter,
342 SwsFilter *dstFilter, const double *param);
345 * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
347 * The output frame will have the same packed format as the palette.
349 * @param src source frame buffer
350 * @param dst destination frame buffer
351 * @param num_pixels number of pixels to convert
352 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
354 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
357 * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
359 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
361 * @param src source frame buffer
362 * @param dst destination frame buffer
363 * @param num_pixels number of pixels to convert
364 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
366 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
369 #endif /* SWSCALE_SWSCALE_H */