2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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"
31 #include "libavutil/log.h"
32 #include "libavutil/pixfmt.h"
34 #define LIBSWSCALE_VERSION_MAJOR 2
35 #define LIBSWSCALE_VERSION_MINOR 1
36 #define LIBSWSCALE_VERSION_MICRO 0
38 #define LIBSWSCALE_VERSION_INT AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \
39 LIBSWSCALE_VERSION_MINOR, \
40 LIBSWSCALE_VERSION_MICRO)
41 #define LIBSWSCALE_VERSION AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \
42 LIBSWSCALE_VERSION_MINOR, \
43 LIBSWSCALE_VERSION_MICRO)
44 #define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT
46 #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
49 * Those FF_API_* defines are not part of public API.
50 * They may change, break or disappear at any time.
52 #ifndef FF_API_SWS_GETCONTEXT
53 #define FF_API_SWS_GETCONTEXT (LIBSWSCALE_VERSION_MAJOR < 3)
55 #ifndef FF_API_SWS_CPU_CAPS
56 #define FF_API_SWS_CPU_CAPS (LIBSWSCALE_VERSION_MAJOR < 3)
60 * Return the LIBSWSCALE_VERSION_INT constant.
62 unsigned swscale_version(void);
65 * Return the libswscale build-time configuration.
67 const char *swscale_configuration(void);
70 * Return the libswscale license.
72 const char *swscale_license(void);
74 /* values for the flags, the stuff on the command line is different */
75 #define SWS_FAST_BILINEAR 1
76 #define SWS_BILINEAR 2
79 #define SWS_POINT 0x10
81 #define SWS_BICUBLIN 0x40
82 #define SWS_GAUSS 0x80
83 #define SWS_SINC 0x100
84 #define SWS_LANCZOS 0x200
85 #define SWS_SPLINE 0x400
87 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
88 #define SWS_SRC_V_CHR_DROP_SHIFT 16
90 #define SWS_PARAM_DEFAULT 123456
92 #define SWS_PRINT_INFO 0x1000
94 //the following 3 flags are not completely implemented
95 //internal chrominace subsampling info
96 #define SWS_FULL_CHR_H_INT 0x2000
97 //input subsampling info
98 #define SWS_FULL_CHR_H_INP 0x4000
99 #define SWS_DIRECT_BGR 0x8000
100 #define SWS_ACCURATE_RND 0x40000
101 #define SWS_BITEXACT 0x80000
103 #if FF_API_SWS_CPU_CAPS
105 * CPU caps are autodetected now, those flags
106 * are only provided for API compatibility.
108 #define SWS_CPU_CAPS_MMX 0x80000000
109 #define SWS_CPU_CAPS_MMX2 0x20000000
110 #define SWS_CPU_CAPS_3DNOW 0x40000000
111 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
112 #define SWS_CPU_CAPS_BFIN 0x01000000
113 #define SWS_CPU_CAPS_SSE2 0x02000000
116 #define SWS_MAX_REDUCE_CUTOFF 0.002
118 #define SWS_CS_ITU709 1
120 #define SWS_CS_ITU601 5
121 #define SWS_CS_ITU624 5
122 #define SWS_CS_SMPTE170M 5
123 #define SWS_CS_SMPTE240M 7
124 #define SWS_CS_DEFAULT 5
127 * Return a pointer to yuv<->rgb coefficients for the given colorspace
128 * suitable for sws_setColorspaceDetails().
130 * @param colorspace One of the SWS_CS_* macros. If invalid,
131 * SWS_CS_DEFAULT is used.
133 const int *sws_getCoefficients(int colorspace);
135 // when used for filters they must have an odd number of elements
136 // coeffs cannot be shared between vectors
138 double *coeff; ///< pointer to the list of coefficients
139 int length; ///< number of coefficients in the vector
142 // vectors can be shared
153 * Return a positive value if pix_fmt is a supported input format, 0
156 int sws_isSupportedInput(enum PixelFormat pix_fmt);
159 * Return a positive value if pix_fmt is a supported output format, 0
162 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
165 * Allocate an empty SwsContext. This must be filled and passed to
166 * sws_init_context(). For filling see AVOptions, options.c and
167 * sws_setColorspaceDetails().
169 struct SwsContext *sws_alloc_context(void);
172 * Initialize the swscaler context sws_context.
174 * @return zero or positive value on success, a negative value on
177 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
180 * Free the swscaler context swsContext.
181 * If swsContext is NULL, then does nothing.
183 void sws_freeContext(struct SwsContext *swsContext);
185 #if FF_API_SWS_GETCONTEXT
187 * Allocate and return an SwsContext. You need it to perform
188 * scaling/conversion operations using sws_scale().
190 * @param srcW the width of the source image
191 * @param srcH the height of the source image
192 * @param srcFormat the source image format
193 * @param dstW the width of the destination image
194 * @param dstH the height of the destination image
195 * @param dstFormat the destination image format
196 * @param flags specify which algorithm and options to use for rescaling
197 * @return a pointer to an allocated context, or NULL in case of error
198 * @note this function is to be removed after a saner alternative is
200 * @deprecated Use sws_getCachedContext() instead.
202 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
203 int dstW, int dstH, enum PixelFormat dstFormat,
204 int flags, SwsFilter *srcFilter,
205 SwsFilter *dstFilter, const double *param);
209 * Scale the image slice in srcSlice and put the resulting scaled
210 * slice in the image in dst. A slice is a sequence of consecutive
213 * Slices have to be provided in sequential order, either in
214 * top-bottom or bottom-top order. If slices are provided in
215 * non-sequential order the behavior of the function is undefined.
217 * @param c the scaling context previously created with
219 * @param srcSlice the array containing the pointers to the planes of
221 * @param srcStride the array containing the strides for each plane of
223 * @param srcSliceY the position in the source image of the slice to
224 * process, that is the number (counted starting from
225 * zero) in the image of the first row of the slice
226 * @param srcSliceH the height of the source slice, that is the number
227 * of rows in the slice
228 * @param dst the array containing the pointers to the planes of
229 * the destination image
230 * @param dstStride the array containing the strides for each plane of
231 * the destination image
232 * @return the height of the output slice
234 int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
235 const int srcStride[], int srcSliceY, int srcSliceH,
236 uint8_t *const dst[], const int dstStride[]);
239 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
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 * Allocate and return an uninitialized vector with length coefficients.
256 SwsVector *sws_allocVec(int length);
259 * Return 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 * Allocate and return a vector with length coefficients, all
266 * with the same value c.
268 SwsVector *sws_getConstVec(double c, int length);
271 * Allocate and return a vector with just one coefficient, with
274 SwsVector *sws_getIdentityVec(void);
277 * Scale all the coefficients of a by the scalar value.
279 void sws_scaleVec(SwsVector *a, double scalar);
282 * Scale 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 * Allocate and return a clone of the vector a, that is a vector
292 * with the same coefficients as a.
294 SwsVector *sws_cloneVec(SwsVector *a);
297 * Print with av_log() a textual representation of the vector a
298 * if log_level <= av_log_level.
300 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
302 void sws_freeVec(SwsVector *a);
304 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
305 float lumaSharpen, float chromaSharpen,
306 float chromaHShift, float chromaVShift,
308 void sws_freeFilter(SwsFilter *filter);
311 * Check if context can be reused, otherwise reallocate a new one.
313 * If context is NULL, just calls sws_getContext() to get a new
314 * context. Otherwise, checks if the parameters are the ones already
315 * saved in context. If that is the case, returns the current
316 * context. Otherwise, frees context and gets a new context with
317 * the new parameters.
319 * Be warned that srcFilter and dstFilter are not checked, they
320 * are assumed to remain the same.
322 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
323 int srcW, int srcH, enum PixelFormat srcFormat,
324 int dstW, int dstH, enum PixelFormat dstFormat,
325 int flags, SwsFilter *srcFilter,
326 SwsFilter *dstFilter, const double *param);
329 * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
331 * The output frame will have the same packed format as the palette.
333 * @param src source frame buffer
334 * @param dst destination frame buffer
335 * @param num_pixels number of pixels to convert
336 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
338 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
341 * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
343 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
345 * @param src source frame buffer
346 * @param dst destination frame buffer
347 * @param num_pixels number of pixels to convert
348 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
350 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
353 * Get the AVClass for swsContext. It can be used in combination with
354 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
356 * @see av_opt_find().
358 const AVClass *sws_get_class(void);
360 #endif /* SWSCALE_SWSCALE_H */