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)
55 * Returns the LIBSWSCALE_VERSION_INT constant.
57 unsigned swscale_version(void);
60 * Returns the libswscale build-time configuration.
62 const char *swscale_configuration(void);
65 * Returns the libswscale license.
67 const char *swscale_license(void);
69 /* values for the flags, the stuff on the command line is different */
70 #define SWS_FAST_BILINEAR 1
71 #define SWS_BILINEAR 2
74 #define SWS_POINT 0x10
76 #define SWS_BICUBLIN 0x40
77 #define SWS_GAUSS 0x80
78 #define SWS_SINC 0x100
79 #define SWS_LANCZOS 0x200
80 #define SWS_SPLINE 0x400
82 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
83 #define SWS_SRC_V_CHR_DROP_SHIFT 16
85 #define SWS_PARAM_DEFAULT 123456
87 #define SWS_PRINT_INFO 0x1000
89 //the following 3 flags are not completely implemented
90 //internal chrominace subsampling info
91 #define SWS_FULL_CHR_H_INT 0x2000
92 //input subsampling info
93 #define SWS_FULL_CHR_H_INP 0x4000
94 #define SWS_DIRECT_BGR 0x8000
95 #define SWS_ACCURATE_RND 0x40000
96 #define SWS_BITEXACT 0x80000
98 //The following flags are only provided for API/ABI compatibility they have no effect anymore
99 #define SWS_CPU_CAPS_MMX 0x80000000
100 #define SWS_CPU_CAPS_MMX2 0x20000000
101 #define SWS_CPU_CAPS_3DNOW 0x40000000
102 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
103 #define SWS_CPU_CAPS_BFIN 0x01000000
104 #define SWS_CPU_CAPS_SSE2 0x02000000
106 #define SWS_MAX_REDUCE_CUTOFF 0.002
108 #define SWS_CS_ITU709 1
110 #define SWS_CS_ITU601 5
111 #define SWS_CS_ITU624 5
112 #define SWS_CS_SMPTE170M 5
113 #define SWS_CS_SMPTE240M 7
114 #define SWS_CS_DEFAULT 5
117 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
118 * suitable for sws_setColorspaceDetails().
120 * @param colorspace One of the SWS_CS_* macros. If invalid,
121 * SWS_CS_DEFAULT is used.
123 const int *sws_getCoefficients(int colorspace);
126 // when used for filters they must have an odd number of elements
127 // coeffs cannot be shared between vectors
129 double *coeff; ///< pointer to the list of coefficients
130 int length; ///< number of coefficients in the vector
133 // vectors can be shared
144 * Returns a positive value if pix_fmt is a supported input format, 0
147 int sws_isSupportedInput(enum PixelFormat pix_fmt);
150 * Returns a positive value if pix_fmt is a supported output format, 0
153 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
156 * Allocates an empty SwsContext. This must be filled and passed to
157 * sws_init_context(). For filling see AVOptions, options.c and
158 * sws_setColorspaceDetails().
160 struct SwsContext *sws_alloc_context(void);
163 * Initializes the swscaler context sws_context.
165 * @return zero or positive value on success, a negative value on
168 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
171 * Frees the swscaler context swsContext.
172 * If swsContext is NULL, then does nothing.
174 void sws_freeContext(struct SwsContext *swsContext);
176 #if FF_API_SWS_GETCONTEXT
178 * Allocates and returns a SwsContext. You need it to perform
179 * scaling/conversion operations using sws_scale().
181 * @param srcW the width of the source image
182 * @param srcH the height of the source image
183 * @param srcFormat the source image format
184 * @param dstW the width of the destination image
185 * @param dstH the height of the destination image
186 * @param dstFormat the destination image format
187 * @param flags specify which algorithm and options to use for rescaling
188 * @return a pointer to an allocated context, or NULL in case of error
189 * @note this function is to be removed after a saner alternative is
191 * @deprecated Use sws_getCachedContext() instead.
193 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
194 int dstW, int dstH, enum PixelFormat dstFormat,
195 int flags, SwsFilter *srcFilter,
196 SwsFilter *dstFilter, const double *param);
200 * Scales the image slice in srcSlice and puts the resulting scaled
201 * slice in the image in dst. A slice is a sequence of consecutive
204 * Slices have to be provided in sequential order, either in
205 * top-bottom or bottom-top order. If slices are provided in
206 * non-sequential order the behavior of the function is undefined.
208 * @param context the scaling context previously created with
210 * @param srcSlice the array containing the pointers to the planes of
212 * @param srcStride the array containing the strides for each plane of
214 * @param srcSliceY the position in the source image of the slice to
215 * process, that is the number (counted starting from
216 * zero) in the image of the first row of the slice
217 * @param srcSliceH the height of the source slice, that is the number
218 * of rows in the slice
219 * @param dst the array containing the pointers to the planes of
220 * the destination image
221 * @param dstStride the array containing the strides for each plane of
222 * the destination image
223 * @return the height of the output slice
225 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
226 int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
228 #if LIBSWSCALE_VERSION_MAJOR < 1
230 * @deprecated Use sws_scale() instead.
232 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
233 int srcStride[], int srcSliceY, int srcSliceH,
234 uint8_t* dst[], int dstStride[]) attribute_deprecated;
238 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
239 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
240 * @return -1 if not supported
242 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
243 int srcRange, const int table[4], int dstRange,
244 int brightness, int contrast, int saturation);
247 * @return -1 if not supported
249 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
250 int *srcRange, int **table, int *dstRange,
251 int *brightness, int *contrast, int *saturation);
254 * Allocates and returns an uninitialized vector with length coefficients.
256 SwsVector *sws_allocVec(int length);
259 * Returns a normalized Gaussian curve used to filter stuff
260 * quality=3 is high quality, lower is lower quality.
262 SwsVector *sws_getGaussianVec(double variance, double quality);
265 * Allocates and returns a vector with length coefficients, all
266 * with the same value c.
268 SwsVector *sws_getConstVec(double c, int length);
271 * Allocates and returns a vector with just one coefficient, with
274 SwsVector *sws_getIdentityVec(void);
277 * Scales all the coefficients of a by the scalar value.
279 void sws_scaleVec(SwsVector *a, double scalar);
282 * Scales all the coefficients of a so that their sum equals height.
284 void sws_normalizeVec(SwsVector *a, double height);
285 void sws_convVec(SwsVector *a, SwsVector *b);
286 void sws_addVec(SwsVector *a, SwsVector *b);
287 void sws_subVec(SwsVector *a, SwsVector *b);
288 void sws_shiftVec(SwsVector *a, int shift);
291 * Allocates and returns a clone of the vector a, that is a vector
292 * with the same coefficients as a.
294 SwsVector *sws_cloneVec(SwsVector *a);
296 #if LIBSWSCALE_VERSION_MAJOR < 1
298 * @deprecated Use sws_printVec2() instead.
300 attribute_deprecated void sws_printVec(SwsVector *a);
304 * Prints with av_log() a textual representation of the vector a
305 * if log_level <= av_log_level.
307 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
309 void sws_freeVec(SwsVector *a);
311 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
312 float lumaSharpen, float chromaSharpen,
313 float chromaHShift, float chromaVShift,
315 void sws_freeFilter(SwsFilter *filter);
318 * Checks if context can be reused, otherwise reallocates a new
321 * If context is NULL, just calls sws_getContext() to get a new
322 * context. Otherwise, checks if the parameters are the ones already
323 * saved in context. If that is the case, returns the current
324 * context. Otherwise, frees context and gets a new context with
325 * the new parameters.
327 * Be warned that srcFilter and dstFilter are not checked, they
328 * are assumed to remain the same.
330 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
331 int srcW, int srcH, enum PixelFormat srcFormat,
332 int dstW, int dstH, enum PixelFormat dstFormat,
333 int flags, SwsFilter *srcFilter,
334 SwsFilter *dstFilter, const double *param);
337 * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
339 * The output frame will have the same packed format as the palette.
341 * @param src source frame buffer
342 * @param dst destination frame buffer
343 * @param num_pixels number of pixels to convert
344 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
346 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
349 * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
351 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
353 * @param src source frame buffer
354 * @param dst destination frame buffer
355 * @param num_pixels number of pixels to convert
356 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
358 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
361 #endif /* SWSCALE_SWSCALE_H */