swscale: point out an alternative to sws_getContext
[ffmpeg.git] / libswscale / swscale.h
1 /*
2  * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
3  *
4  * This file is part of Libav.
5  *
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.
10  *
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.
15  *
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
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 1
33 #define LIBSWSCALE_VERSION_MINOR 1
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  * Those FF_API_* defines are not part of public API.
48  * They may change, break or disappear at any time.
49  */
50 #ifndef FF_API_SWS_GETCONTEXT
51 #define FF_API_SWS_GETCONTEXT  (LIBSWSCALE_VERSION_MAJOR < 2)
52 #endif
53
54 /**
55  * Returns the LIBSWSCALE_VERSION_INT constant.
56  */
57 unsigned swscale_version(void);
58
59 /**
60  * Returns the libswscale build-time configuration.
61  */
62 const char *swscale_configuration(void);
63
64 /**
65  * Returns the libswscale license.
66  */
67 const char *swscale_license(void);
68
69 /* values for the flags, the stuff on the command line is different */
70 #define SWS_FAST_BILINEAR     1
71 #define SWS_BILINEAR          2
72 #define SWS_BICUBIC           4
73 #define SWS_X                 8
74 #define SWS_POINT          0x10
75 #define SWS_AREA           0x20
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
81
82 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
83 #define SWS_SRC_V_CHR_DROP_SHIFT    16
84
85 #define SWS_PARAM_DEFAULT           123456
86
87 #define SWS_PRINT_INFO              0x1000
88
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
97
98 #define SWS_CPU_CAPS_MMX      0x80000000
99 #define SWS_CPU_CAPS_MMX2     0x20000000
100 #define SWS_CPU_CAPS_3DNOW    0x40000000
101 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
102 #define SWS_CPU_CAPS_BFIN     0x01000000
103 #define SWS_CPU_CAPS_SSE2     0x02000000
104
105 #define SWS_MAX_REDUCE_CUTOFF 0.002
106
107 #define SWS_CS_ITU709         1
108 #define SWS_CS_FCC            4
109 #define SWS_CS_ITU601         5
110 #define SWS_CS_ITU624         5
111 #define SWS_CS_SMPTE170M      5
112 #define SWS_CS_SMPTE240M      7
113 #define SWS_CS_DEFAULT        5
114
115 /**
116  * Returns a pointer to yuv<->rgb coefficients for the given colorspace
117  * suitable for sws_setColorspaceDetails().
118  *
119  * @param colorspace One of the SWS_CS_* macros. If invalid,
120  * SWS_CS_DEFAULT is used.
121  */
122 const int *sws_getCoefficients(int colorspace);
123
124
125 // when used for filters they must have an odd number of elements
126 // coeffs cannot be shared between vectors
127 typedef struct {
128     double *coeff;              ///< pointer to the list of coefficients
129     int length;                 ///< number of coefficients in the vector
130 } SwsVector;
131
132 // vectors can be shared
133 typedef struct {
134     SwsVector *lumH;
135     SwsVector *lumV;
136     SwsVector *chrH;
137     SwsVector *chrV;
138 } SwsFilter;
139
140 struct SwsContext;
141
142 /**
143  * Returns a positive value if pix_fmt is a supported input format, 0
144  * otherwise.
145  */
146 int sws_isSupportedInput(enum PixelFormat pix_fmt);
147
148 /**
149  * Returns a positive value if pix_fmt is a supported output format, 0
150  * otherwise.
151  */
152 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
153
154 /**
155  * Allocates an empty SwsContext. This must be filled and passed to
156  * sws_init_context(). For filling see AVOptions, options.c and
157  * sws_setColorspaceDetails().
158  */
159 struct SwsContext *sws_alloc_context(void);
160
161 /**
162  * Initializes the swscaler context sws_context.
163  *
164  * @return zero or positive value on success, a negative value on
165  * error
166  */
167 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
168
169 /**
170  * Frees the swscaler context swsContext.
171  * If swsContext is NULL, then does nothing.
172  */
173 void sws_freeContext(struct SwsContext *swsContext);
174
175 #if FF_API_SWS_GETCONTEXT
176 /**
177  * Allocates and returns a SwsContext. You need it to perform
178  * scaling/conversion operations using sws_scale().
179  *
180  * @param srcW the width of the source image
181  * @param srcH the height of the source image
182  * @param srcFormat the source image format
183  * @param dstW the width of the destination image
184  * @param dstH the height of the destination image
185  * @param dstFormat the destination image format
186  * @param flags specify which algorithm and options to use for rescaling
187  * @return a pointer to an allocated context, or NULL in case of error
188  * @note this function is to be removed after a saner alternative is
189  *       written
190  * @deprecated Use sws_getCachedContext() instead.
191  */
192 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
193                                   int dstW, int dstH, enum PixelFormat dstFormat,
194                                   int flags, SwsFilter *srcFilter,
195                                   SwsFilter *dstFilter, const double *param);
196 #endif
197
198 /**
199  * Scales the image slice in srcSlice and puts the resulting scaled
200  * slice in the image in dst. A slice is a sequence of consecutive
201  * rows in an image.
202  *
203  * Slices have to be provided in sequential order, either in
204  * top-bottom or bottom-top order. If slices are provided in
205  * non-sequential order the behavior of the function is undefined.
206  *
207  * @param context   the scaling context previously created with
208  *                  sws_getContext()
209  * @param srcSlice  the array containing the pointers to the planes of
210  *                  the source slice
211  * @param srcStride the array containing the strides for each plane of
212  *                  the source image
213  * @param srcSliceY the position in the source image of the slice to
214  *                  process, that is the number (counted starting from
215  *                  zero) in the image of the first row of the slice
216  * @param srcSliceH the height of the source slice, that is the number
217  *                  of rows in the slice
218  * @param dst       the array containing the pointers to the planes of
219  *                  the destination image
220  * @param dstStride the array containing the strides for each plane of
221  *                  the destination image
222  * @return          the height of the output slice
223  */
224 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
225               int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
226
227 /**
228  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
229  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
230  * @return -1 if not supported
231  */
232 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
233                              int srcRange, const int table[4], int dstRange,
234                              int brightness, int contrast, int saturation);
235
236 /**
237  * @return -1 if not supported
238  */
239 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
240                              int *srcRange, int **table, int *dstRange,
241                              int *brightness, int *contrast, int *saturation);
242
243 /**
244  * Allocates and returns an uninitialized vector with length coefficients.
245  */
246 SwsVector *sws_allocVec(int length);
247
248 /**
249  * Returns a normalized Gaussian curve used to filter stuff
250  * quality=3 is high quality, lower is lower quality.
251  */
252 SwsVector *sws_getGaussianVec(double variance, double quality);
253
254 /**
255  * Allocates and returns a vector with length coefficients, all
256  * with the same value c.
257  */
258 SwsVector *sws_getConstVec(double c, int length);
259
260 /**
261  * Allocates and returns a vector with just one coefficient, with
262  * value 1.0.
263  */
264 SwsVector *sws_getIdentityVec(void);
265
266 /**
267  * Scales all the coefficients of a by the scalar value.
268  */
269 void sws_scaleVec(SwsVector *a, double scalar);
270
271 /**
272  * Scales all the coefficients of a so that their sum equals height.
273  */
274 void sws_normalizeVec(SwsVector *a, double height);
275 void sws_convVec(SwsVector *a, SwsVector *b);
276 void sws_addVec(SwsVector *a, SwsVector *b);
277 void sws_subVec(SwsVector *a, SwsVector *b);
278 void sws_shiftVec(SwsVector *a, int shift);
279
280 /**
281  * Allocates and returns a clone of the vector a, that is a vector
282  * with the same coefficients as a.
283  */
284 SwsVector *sws_cloneVec(SwsVector *a);
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 */