Split alloc and init of context so that parameters can be set in the context
[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 * Returns the LIBSWSCALE_VERSION_INT constant.
48 */
49 unsigned swscale_version(void);
50
51 /**
52 * Returns the libswscale build-time configuration.
53 */
54 const char *swscale_configuration(void);
55
56 /**
57 * Returns 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 #define SWS_CPU_CAPS_SSE2 0x02000000
96
97 #define SWS_MAX_REDUCE_CUTOFF 0.002
98
99 #define SWS_CS_ITU709 1
100 #define SWS_CS_FCC 4
101 #define SWS_CS_ITU601 5
102 #define SWS_CS_ITU624 5
103 #define SWS_CS_SMPTE170M 5
104 #define SWS_CS_SMPTE240M 7
105 #define SWS_CS_DEFAULT 5
106
107 /**
108 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
109 * suitable for sws_setColorspaceDetails().
110 *
111 * @param colorspace One of the SWS_CS_* macros. If invalid,
112 * SWS_CS_DEFAULT is used.
113 */
114 const int *sws_getCoefficients(int colorspace);
115
116
117 // when used for filters they must have an odd number of elements
118 // coeffs cannot be shared between vectors
119 typedef struct {
120 double *coeff; ///< pointer to the list of coefficients
121 int length; ///< number of coefficients in the vector
122 } SwsVector;
123
124 // vectors can be shared
125 typedef struct {
126 SwsVector *lumH;
127 SwsVector *lumV;
128 SwsVector *chrH;
129 SwsVector *chrV;
130 } SwsFilter;
131
132 struct SwsContext;
133
134 /**
135 * Returns a positive value if pix_fmt is a supported input format, 0
136 * otherwise.
137 */
138 int sws_isSupportedInput(enum PixelFormat pix_fmt);
139
140 /**
141 * Returns a positive value if pix_fmt is a supported output format, 0
142 * otherwise.
143 */
144 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
145
146 /**
147 * Alloctaes an empty SwsContext, this must be filled and passed to sws_init_context().
148 * For filling see AVOptions, options.c and sws_setColorspaceDetails().
149 */
150 struct SwsContext *sws_alloc_context(void);
151
152 /**
153 * Initializs the swscaler context sws_context.
154 */
155 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
156
157 /**
158 * Frees the swscaler context swsContext.
159 * If swsContext is NULL, then does nothing.
160 */
161 void sws_freeContext(struct SwsContext *swsContext);
162
163 /**
164 * Allocates and returns a SwsContext. You need it to perform
165 * scaling/conversion operations using sws_scale().
166 *
167 * @param srcW the width of the source image
168 * @param srcH the height of the source image
169 * @param srcFormat the source image format
170 * @param dstW the width of the destination image
171 * @param dstH the height of the destination image
172 * @param dstFormat the destination image format
173 * @param flags specify which algorithm and options to use for rescaling
174 * @return a pointer to an allocated context, or NULL in case of error
175 * @deprecated use sws_alloc_context() and sws_init_context()
176 */
177 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
178 int dstW, int dstH, enum PixelFormat dstFormat,
179 int flags, SwsFilter *srcFilter,
180 SwsFilter *dstFilter, const double *param);
181
182 /**
183 * Scales the image slice in srcSlice and puts the resulting scaled
184 * slice in the image in dst. A slice is a sequence of consecutive
185 * rows in an image.
186 *
187 * Slices have to be provided in sequential order, either in
188 * top-bottom or bottom-top order. If slices are provided in
189 * non-sequential order the behavior of the function is undefined.
190 *
191 * @param context the scaling context previously created with
192 * sws_getContext()
193 * @param srcSlice the array containing the pointers to the planes of
194 * the source slice
195 * @param srcStride the array containing the strides for each plane of
196 * the source image
197 * @param srcSliceY the position in the source image of the slice to
198 * process, that is the number (counted starting from
199 * zero) in the image of the first row of the slice
200 * @param srcSliceH the height of the source slice, that is the number
201 * of rows in the slice
202 * @param dst the array containing the pointers to the planes of
203 * the destination image
204 * @param dstStride the array containing the strides for each plane of
205 * the destination image
206 * @return the height of the output slice
207 */
208 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
209 int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
210
211 #if LIBSWSCALE_VERSION_MAJOR < 1
212 /**
213 * @deprecated Use sws_scale() instead.
214 */
215 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
216 int srcStride[], int srcSliceY, int srcSliceH,
217 uint8_t* dst[], int dstStride[]) attribute_deprecated;
218 #endif
219
220 /**
221 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
222 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
223 * @return -1 if not supported
224 */
225 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
226 int srcRange, const int table[4], int dstRange,
227 int brightness, int contrast, int saturation);
228
229 /**
230 * @return -1 if not supported
231 */
232 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
233 int *srcRange, int **table, int *dstRange,
234 int *brightness, int *contrast, int *saturation);
235
236 /**
237 * Allocates and returns an uninitialized vector with length coefficients.
238 */
239 SwsVector *sws_allocVec(int length);
240
241 /**
242 * Returns a normalized Gaussian curve used to filter stuff
243 * quality=3 is high quality, lower is lower quality.
244 */
245 SwsVector *sws_getGaussianVec(double variance, double quality);
246
247 /**
248 * Allocates and returns a vector with length coefficients, all
249 * with the same value c.
250 */
251 SwsVector *sws_getConstVec(double c, int length);
252
253 /**
254 * Allocates and returns a vector with just one coefficient, with
255 * value 1.0.
256 */
257 SwsVector *sws_getIdentityVec(void);
258
259 /**
260 * Scales all the coefficients of a by the scalar value.
261 */
262 void sws_scaleVec(SwsVector *a, double scalar);
263
264 /**
265 * Scales all the coefficients of a so that their sum equals height.
266 */
267 void sws_normalizeVec(SwsVector *a, double height);
268 void sws_convVec(SwsVector *a, SwsVector *b);
269 void sws_addVec(SwsVector *a, SwsVector *b);
270 void sws_subVec(SwsVector *a, SwsVector *b);
271 void sws_shiftVec(SwsVector *a, int shift);
272
273 /**
274 * Allocates and returns a clone of the vector a, that is a vector
275 * with the same coefficients as a.
276 */
277 SwsVector *sws_cloneVec(SwsVector *a);
278
279 #if LIBSWSCALE_VERSION_MAJOR < 1
280 /**
281 * @deprecated Use sws_printVec2() instead.
282 */
283 attribute_deprecated void sws_printVec(SwsVector *a);
284 #endif
285
286 /**
287 * Prints with av_log() a textual representation of the vector a
288 * if log_level <= av_log_level.
289 */
290 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
291
292 void sws_freeVec(SwsVector *a);
293
294 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
295 float lumaSharpen, float chromaSharpen,
296 float chromaHShift, float chromaVShift,
297 int verbose);
298 void sws_freeFilter(SwsFilter *filter);
299
300 /**
301 * Checks if context can be reused, otherwise reallocates a new
302 * one.
303 *
304 * If context is NULL, just calls sws_getContext() to get a new
305 * context. Otherwise, checks if the parameters are the ones already
306 * saved in context. If that is the case, returns the current
307 * context. Otherwise, frees context and gets a new context with
308 * the new parameters.
309 *
310 * Be warned that srcFilter and dstFilter are not checked, they
311 * are assumed to remain the same.
312 */
313 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
314 int srcW, int srcH, enum PixelFormat srcFormat,
315 int dstW, int dstH, enum PixelFormat dstFormat,
316 int flags, SwsFilter *srcFilter,
317 SwsFilter *dstFilter, const double *param);
318
319 /**
320 * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
321 *
322 * The output frame will have the same packed format as the palette.
323 *
324 * @param src source frame buffer
325 * @param dst destination frame buffer
326 * @param num_pixels number of pixels to convert
327 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
328 */
329 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
330
331 /**
332 * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
333 *
334 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
335 *
336 * @param src source frame buffer
337 * @param dst destination frame buffer
338 * @param num_pixels number of pixels to convert
339 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
340 */
341 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
342
343
344 #endif /* SWSCALE_SWSCALE_H */