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 11
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
* Returns the LIBSWSCALE_VERSION_INT constant.
49
unsigned swscale_version(void);
52
* Returns the libswscale build-time configuration.
54
const char *swscale_configuration(void);
57
* Returns the libswscale license.
59
const char *swscale_license(void);
61
/* values for the flags, the stuff on the command line is different */
62
#define SWS_FAST_BILINEAR 1
63
#define SWS_BILINEAR 2
66
#define SWS_POINT 0x10
68
#define SWS_BICUBLIN 0x40
69
#define SWS_GAUSS 0x80
70
#define SWS_SINC 0x100
71
#define SWS_LANCZOS 0x200
72
#define SWS_SPLINE 0x400
74
#define SWS_SRC_V_CHR_DROP_MASK 0x30000
75
#define SWS_SRC_V_CHR_DROP_SHIFT 16
77
#define SWS_PARAM_DEFAULT 123456
79
#define SWS_PRINT_INFO 0x1000
81
//the following 3 flags are not completely implemented
82
//internal chrominace subsampling info
83
#define SWS_FULL_CHR_H_INT 0x2000
84
//input subsampling info
85
#define SWS_FULL_CHR_H_INP 0x4000
86
#define SWS_DIRECT_BGR 0x8000
87
#define SWS_ACCURATE_RND 0x40000
88
#define SWS_BITEXACT 0x80000
90
#define SWS_CPU_CAPS_MMX 0x80000000
91
#define SWS_CPU_CAPS_MMX2 0x20000000
92
#define SWS_CPU_CAPS_3DNOW 0x40000000
93
#define SWS_CPU_CAPS_ALTIVEC 0x10000000
94
#define SWS_CPU_CAPS_BFIN 0x01000000
96
#define SWS_MAX_REDUCE_CUTOFF 0.002
98
#define SWS_CS_ITU709 1
100
#define SWS_CS_ITU601 5
101
#define SWS_CS_ITU624 5
102
#define SWS_CS_SMPTE170M 5
103
#define SWS_CS_SMPTE240M 7
104
#define SWS_CS_DEFAULT 5
107
* Returns a pointer to yuv<->rgb coefficients for the given colorspace
108
* suitable for sws_setColorspaceDetails().
110
* @param colorspace One of the SWS_CS_* macros. If invalid,
111
* SWS_CS_DEFAULT is used.
113
const int *sws_getCoefficients(int colorspace);
116
// when used for filters they must have an odd number of elements
117
// coeffs cannot be shared between vectors
119
double *coeff; ///< pointer to the list of coefficients
120
int length; ///< number of coefficients in the vector
123
// vectors can be shared
134
* Returns a positive value if pix_fmt is a supported input format, 0
137
int sws_isSupportedInput(enum PixelFormat pix_fmt);
140
* Returns a positive value if pix_fmt is a supported output format, 0
143
int sws_isSupportedOutput(enum PixelFormat pix_fmt);
146
* Frees the swscaler context swsContext.
147
* If swsContext is NULL, then does nothing.
149
void sws_freeContext(struct SwsContext *swsContext);
152
* Allocates and returns a SwsContext. You need it to perform
153
* scaling/conversion operations using sws_scale().
155
* @param srcW the width of the source image
156
* @param srcH the height of the source image
157
* @param srcFormat the source image format
158
* @param dstW the width of the destination image
159
* @param dstH the height of the destination image
160
* @param dstFormat the destination image format
161
* @param flags specify which algorithm and options to use for rescaling
162
* @return a pointer to an allocated context, or NULL in case of error
164
struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
165
int dstW, int dstH, enum PixelFormat dstFormat,
166
int flags, SwsFilter *srcFilter,
167
SwsFilter *dstFilter, const double *param);
170
* Scales the image slice in srcSlice and puts the resulting scaled
171
* slice in the image in dst. A slice is a sequence of consecutive
174
* Slices have to be provided in sequential order, either in
175
* top-bottom or bottom-top order. If slices are provided in
176
* non-sequential order the behavior of the function is undefined.
178
* @param context the scaling context previously created with
180
* @param srcSlice the array containing the pointers to the planes of
182
* @param srcStride the array containing the strides for each plane of
184
* @param srcSliceY the position in the source image of the slice to
185
* process, that is the number (counted starting from
186
* zero) in the image of the first row of the slice
187
* @param srcSliceH the height of the source slice, that is the number
188
* of rows in the slice
189
* @param dst the array containing the pointers to the planes of
190
* the destination image
191
* @param dstStride the array containing the strides for each plane of
192
* the destination image
193
* @return the height of the output slice
195
int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
196
int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
197
#if LIBSWSCALE_VERSION_MAJOR < 1
199
* @deprecated Use sws_scale() instead.
201
int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
202
int srcStride[], int srcSliceY, int srcSliceH,
203
uint8_t* dst[], int dstStride[]) attribute_deprecated;
207
* @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
208
* @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
209
* @return -1 if not supported
211
int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
212
int srcRange, const int table[4], int dstRange,
213
int brightness, int contrast, int saturation);
216
* @return -1 if not supported
218
int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
219
int *srcRange, int **table, int *dstRange,
220
int *brightness, int *contrast, int *saturation);
223
* Allocates and returns an uninitialized vector with length coefficients.
225
SwsVector *sws_allocVec(int length);
228
* Returns a normalized Gaussian curve used to filter stuff
229
* quality=3 is high quality, lower is lower quality.
231
SwsVector *sws_getGaussianVec(double variance, double quality);
234
* Allocates and returns a vector with length coefficients, all
235
* with the same value c.
237
SwsVector *sws_getConstVec(double c, int length);
240
* Allocates and returns a vector with just one coefficient, with
243
SwsVector *sws_getIdentityVec(void);
246
* Scales all the coefficients of a by the scalar value.
248
void sws_scaleVec(SwsVector *a, double scalar);
251
* Scales all the coefficients of a so that their sum equals height.
253
void sws_normalizeVec(SwsVector *a, double height);
254
void sws_convVec(SwsVector *a, SwsVector *b);
255
void sws_addVec(SwsVector *a, SwsVector *b);
256
void sws_subVec(SwsVector *a, SwsVector *b);
257
void sws_shiftVec(SwsVector *a, int shift);
260
* Allocates and returns a clone of the vector a, that is a vector
261
* with the same coefficients as a.
263
SwsVector *sws_cloneVec(SwsVector *a);
265
#if LIBSWSCALE_VERSION_MAJOR < 1
267
* @deprecated Use sws_printVec2() instead.
269
attribute_deprecated void sws_printVec(SwsVector *a);
273
* Prints with av_log() a textual representation of the vector a
274
* if log_level <= av_log_level.
276
void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
278
void sws_freeVec(SwsVector *a);
280
SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
281
float lumaSharpen, float chromaSharpen,
282
float chromaHShift, float chromaVShift,
284
void sws_freeFilter(SwsFilter *filter);
287
* Checks if context can be reused, otherwise reallocates a new
290
* If context is NULL, just calls sws_getContext() to get a new
291
* context. Otherwise, checks if the parameters are the ones already
292
* saved in context. If that is the case, returns the current
293
* context. Otherwise, frees context and gets a new context with
294
* the new parameters.
296
* Be warned that srcFilter and dstFilter are not checked, they
297
* are assumed to remain the same.
299
struct SwsContext *sws_getCachedContext(struct SwsContext *context,
300
int srcW, int srcH, enum PixelFormat srcFormat,
301
int dstW, int dstH, enum PixelFormat dstFormat,
302
int flags, SwsFilter *srcFilter,
303
SwsFilter *dstFilter, const double *param);
306
* Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
308
* The output frame will have the same packed format as the palette.
310
* @param src source frame buffer
311
* @param dst destination frame buffer
312
* @param num_pixels number of pixels to convert
313
* @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
315
void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
318
* Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
320
* With the palette format "ABCD", the destination frame ends up with the format "ABC".
322
* @param src source frame buffer
323
* @param dst destination frame buffer
324
* @param num_pixels number of pixels to convert
325
* @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
327
void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
330
#endif /* SWSCALE_SWSCALE_H */