74c03a89fb16037e079f67bfedc6b9925c6ec15d
[libav.git] / libswscale / swscale.h
1 /*
2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
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 SWSCALE_SWSCALE_H
22 #define SWSCALE_SWSCALE_H
23
24 /**
25 * @file
26 * @brief
27 * external api for the swscale stuff
28 */
29
30 #include "libavutil/avutil.h"
31
32 #define LIBSWSCALE_VERSION_MAJOR 0
33 #define LIBSWSCALE_VERSION_MINOR 11
34 #define LIBSWSCALE_VERSION_MICRO 0
35
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
43
44 #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
45
46 /**
47 * Return the LIBSWSCALE_VERSION_INT constant.
48 */
49 unsigned swscale_version(void);
50
51 /**
52 * Return the libswscale build-time configuration.
53 */
54 const char *swscale_configuration(void);
55
56 /**
57 * Return the libswscale license.
58 */
59 const char *swscale_license(void);
60
61 /* values for the flags, the stuff on the command line is different */
62 #define SWS_FAST_BILINEAR 1
63 #define SWS_BILINEAR 2
64 #define SWS_BICUBIC 4
65 #define SWS_X 8
66 #define SWS_POINT 0x10
67 #define SWS_AREA 0x20
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
73
74 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
75 #define SWS_SRC_V_CHR_DROP_SHIFT 16
76
77 #define SWS_PARAM_DEFAULT 123456
78
79 #define SWS_PRINT_INFO 0x1000
80
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
89
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
95
96 #define SWS_MAX_REDUCE_CUTOFF 0.002
97
98 #define SWS_CS_ITU709 1
99 #define SWS_CS_FCC 4
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
105
106 /**
107 * Return a pointer to yuv<->rgb coefficients for the given colorspace
108 * suitable for sws_setColorspaceDetails().
109 *
110 * @param colorspace One of the SWS_CS_* macros. If invalid,
111 * SWS_CS_DEFAULT is used.
112 */
113 const int *sws_getCoefficients(int colorspace);
114
115
116 // when used for filters they must have an odd number of elements
117 // coeffs cannot be shared between vectors
118 typedef struct {
119 double *coeff; ///< pointer to the list of coefficients
120 int length; ///< number of coefficients in the vector
121 } SwsVector;
122
123 // vectors can be shared
124 typedef struct {
125 SwsVector *lumH;
126 SwsVector *lumV;
127 SwsVector *chrH;
128 SwsVector *chrV;
129 } SwsFilter;
130
131 struct SwsContext;
132
133 /**
134 * Return a positive value if pix_fmt is a supported input format, 0
135 * otherwise.
136 */
137 int sws_isSupportedInput(enum PixelFormat pix_fmt);
138
139 /**
140 * Return a positive value if pix_fmt is a supported output format, 0
141 * otherwise.
142 */
143 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
144
145 /**
146 * Free the swscaler context swsContext.
147 * If swsContext is NULL, then do nothing.
148 */
149 void sws_freeContext(struct SwsContext *swsContext);
150
151 /**
152 * Allocate and return a SwsContext. You need it to perform
153 * scaling/conversion operations using sws_scale().
154 *
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
163 */
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);
168
169 /**
170 * Scale the image slice in srcSlice and put the resulting scaled
171 * slice in the image in dst. A slice is a sequence of consecutive
172 * rows in an image.
173 *
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.
177 *
178 * @param context the scaling context previously created with
179 * sws_getContext()
180 * @param srcSlice the array containing the pointers to the planes of
181 * the source slice
182 * @param srcStride the array containing the strides for each plane of
183 * the source image
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
194 */
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
198 #if LIBSWSCALE_VERSION_MAJOR < 1
199 /**
200 * @deprecated Use sws_scale() instead.
201 */
202 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
203 int srcStride[], int srcSliceY, int srcSliceH,
204 uint8_t* dst[], int dstStride[]) attribute_deprecated;
205 #endif
206
207 /**
208 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
209 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
210 * @return -1 if not supported
211 */
212 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
213 int srcRange, const int table[4], int dstRange,
214 int brightness, int contrast, int saturation);
215
216 /**
217 * @return -1 if not supported
218 */
219 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
220 int *srcRange, int **table, int *dstRange,
221 int *brightness, int *contrast, int *saturation);
222
223 /**
224 * Allocates and returns an uninitialized vector with length coefficients.
225 */
226 SwsVector *sws_allocVec(int length);
227
228 /**
229 * Return a normalized Gaussian curve used to filter stuff
230 * quality=3 is high quality, lower is lower quality.
231 */
232 SwsVector *sws_getGaussianVec(double variance, double quality);
233
234 /**
235 * Allocate and return a vector with length coefficients, all
236 * with the same value c.
237 */
238 SwsVector *sws_getConstVec(double c, int length);
239
240 /**
241 * Allocate and return a vector with just one coefficient, with
242 * value 1.0.
243 */
244 SwsVector *sws_getIdentityVec(void);
245
246 /**
247 * Scale all the coefficients of a by the scalar value.
248 */
249 void sws_scaleVec(SwsVector *a, double scalar);
250
251 /**
252 * Scale all the coefficients of a so that their sum equals height.
253 */
254 void sws_normalizeVec(SwsVector *a, double height);
255 void sws_convVec(SwsVector *a, SwsVector *b);
256 void sws_addVec(SwsVector *a, SwsVector *b);
257 void sws_subVec(SwsVector *a, SwsVector *b);
258 void sws_shiftVec(SwsVector *a, int shift);
259
260 /**
261 * Allocate and return a clone of the vector a, that is a vector
262 * with the same coefficients as a.
263 */
264 SwsVector *sws_cloneVec(SwsVector *a);
265
266 #if LIBSWSCALE_VERSION_MAJOR < 1
267 /**
268 * @deprecated Use sws_printVec2() instead.
269 */
270 attribute_deprecated void sws_printVec(SwsVector *a);
271 #endif
272
273 /**
274 * Print with av_log() a textual representation of the vector a
275 * if log_level <= av_log_level.
276 */
277 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
278
279 void sws_freeVec(SwsVector *a);
280
281 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
282 float lumaSharpen, float chromaSharpen,
283 float chromaHShift, float chromaVShift,
284 int verbose);
285 void sws_freeFilter(SwsFilter *filter);
286
287 /**
288 * Check if context can be reused, otherwise reallocate a new
289 * one.
290 *
291 * If context is NULL, just call sws_getContext() to get a new
292 * context. Otherwise, check if the parameters are the ones already
293 * saved in context. If that is the case, return the current
294 * context. Otherwise, free context and get a new context with
295 * the new parameters.
296 *
297 * Be warned that srcFilter and dstFilter are not checked, they
298 * are assumed to remain the same.
299 */
300 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
301 int srcW, int srcH, enum PixelFormat srcFormat,
302 int dstW, int dstH, enum PixelFormat dstFormat,
303 int flags, SwsFilter *srcFilter,
304 SwsFilter *dstFilter, const double *param);
305
306 /**
307 * Convert an 8bit paletted frame into a frame with a color depth of 32-bits.
308 *
309 * The output frame will have the same packed format as the palette.
310 *
311 * @param src source frame buffer
312 * @param dst destination frame buffer
313 * @param num_pixels number of pixels to convert
314 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
315 */
316 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
317
318 /**
319 * Convert an 8bit paletted frame into a frame with a color depth of 24 bits.
320 *
321 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
322 *
323 * @param src source frame buffer
324 * @param dst destination frame buffer
325 * @param num_pixels number of pixels to convert
326 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
327 */
328 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
329
330
331 #endif /* SWSCALE_SWSCALE_H */