lavfi/curves: move alloc and init of LUTs inside config_input()
[ffmpeg.git] / libswscale / swscale.h
1 /*
2  * Copyright (C) 2001-2011 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  * @ingroup libsws
27  * external API header
28  */
29
30 #include <stdint.h>
31
32 #include "libavutil/avutil.h"
33 #include "libavutil/log.h"
34 #include "libavutil/pixfmt.h"
35 #include "version.h"
36
37 /**
38  * @defgroup libsws Color conversion and scaling
39  * @{
40  *
41  * Return the LIBSWSCALE_VERSION_INT constant.
42  */
43 unsigned swscale_version(void);
44
45 /**
46  * Return the libswscale build-time configuration.
47  */
48 const char *swscale_configuration(void);
49
50 /**
51  * Return the libswscale license.
52  */
53 const char *swscale_license(void);
54
55 /* values for the flags, the stuff on the command line is different */
56 #define SWS_FAST_BILINEAR     1
57 #define SWS_BILINEAR          2
58 #define SWS_BICUBIC           4
59 #define SWS_X                 8
60 #define SWS_POINT          0x10
61 #define SWS_AREA           0x20
62 #define SWS_BICUBLIN       0x40
63 #define SWS_GAUSS          0x80
64 #define SWS_SINC          0x100
65 #define SWS_LANCZOS       0x200
66 #define SWS_SPLINE        0x400
67
68 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
69 #define SWS_SRC_V_CHR_DROP_SHIFT    16
70
71 #define SWS_PARAM_DEFAULT           123456
72
73 #define SWS_PRINT_INFO              0x1000
74
75 //the following 3 flags are not completely implemented
76 //internal chrominance subsampling info
77 #define SWS_FULL_CHR_H_INT    0x2000
78 //input subsampling info
79 #define SWS_FULL_CHR_H_INP    0x4000
80 #define SWS_DIRECT_BGR        0x8000
81 #define SWS_ACCURATE_RND      0x40000
82 #define SWS_BITEXACT          0x80000
83 #define SWS_ERROR_DIFFUSION  0x800000
84
85 #define SWS_MAX_REDUCE_CUTOFF 0.002
86
87 #define SWS_CS_ITU709         1
88 #define SWS_CS_FCC            4
89 #define SWS_CS_ITU601         5
90 #define SWS_CS_ITU624         5
91 #define SWS_CS_SMPTE170M      5
92 #define SWS_CS_SMPTE240M      7
93 #define SWS_CS_DEFAULT        5
94 #define SWS_CS_BT2020         9
95
96 /**
97  * Return a pointer to yuv<->rgb coefficients for the given colorspace
98  * suitable for sws_setColorspaceDetails().
99  *
100  * @param colorspace One of the SWS_CS_* macros. If invalid,
101  * SWS_CS_DEFAULT is used.
102  */
103 const int *sws_getCoefficients(int colorspace);
104
105 // when used for filters they must have an odd number of elements
106 // coeffs cannot be shared between vectors
107 typedef struct SwsVector {
108     double *coeff;              ///< pointer to the list of coefficients
109     int length;                 ///< number of coefficients in the vector
110 } SwsVector;
111
112 // vectors can be shared
113 typedef struct SwsFilter {
114     SwsVector *lumH;
115     SwsVector *lumV;
116     SwsVector *chrH;
117     SwsVector *chrV;
118 } SwsFilter;
119
120 struct SwsContext;
121
122 /**
123  * Return a positive value if pix_fmt is a supported input format, 0
124  * otherwise.
125  */
126 int sws_isSupportedInput(enum AVPixelFormat pix_fmt);
127
128 /**
129  * Return a positive value if pix_fmt is a supported output format, 0
130  * otherwise.
131  */
132 int sws_isSupportedOutput(enum AVPixelFormat pix_fmt);
133
134 /**
135  * @param[in]  pix_fmt the pixel format
136  * @return a positive value if an endianness conversion for pix_fmt is
137  * supported, 0 otherwise.
138  */
139 int sws_isSupportedEndiannessConversion(enum AVPixelFormat pix_fmt);
140
141 /**
142  * Allocate an empty SwsContext. This must be filled and passed to
143  * sws_init_context(). For filling see AVOptions, options.c and
144  * sws_setColorspaceDetails().
145  */
146 struct SwsContext *sws_alloc_context(void);
147
148 /**
149  * Initialize the swscaler context sws_context.
150  *
151  * @return zero or positive value on success, a negative value on
152  * error
153  */
154 av_warn_unused_result
155 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
156
157 /**
158  * Free the swscaler context swsContext.
159  * If swsContext is NULL, then does nothing.
160  */
161 void sws_freeContext(struct SwsContext *swsContext);
162
163 /**
164  * Allocate and return an 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  * @param param extra parameters to tune the used scaler
175  *              For SWS_BICUBIC param[0] and [1] tune the shape of the basis
176  *              function, param[0] tunes f(1) and param[1] f´(1)
177  *              For SWS_GAUSS param[0] tunes the exponent and thus cutoff
178  *              frequency
179  *              For SWS_LANCZOS param[0] tunes the width of the window function
180  * @return a pointer to an allocated context, or NULL in case of error
181  * @note this function is to be removed after a saner alternative is
182  *       written
183  */
184 struct SwsContext *sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat,
185                                   int dstW, int dstH, enum AVPixelFormat dstFormat,
186                                   int flags, SwsFilter *srcFilter,
187                                   SwsFilter *dstFilter, const double *param);
188
189 /**
190  * Scale the image slice in srcSlice and put the resulting scaled
191  * slice in the image in dst. A slice is a sequence of consecutive
192  * rows in an image.
193  *
194  * Slices have to be provided in sequential order, either in
195  * top-bottom or bottom-top order. If slices are provided in
196  * non-sequential order the behavior of the function is undefined.
197  *
198  * @param c         the scaling context previously created with
199  *                  sws_getContext()
200  * @param srcSlice  the array containing the pointers to the planes of
201  *                  the source slice
202  * @param srcStride the array containing the strides for each plane of
203  *                  the source image
204  * @param srcSliceY the position in the source image of the slice to
205  *                  process, that is the number (counted starting from
206  *                  zero) in the image of the first row of the slice
207  * @param srcSliceH the height of the source slice, that is the number
208  *                  of rows in the slice
209  * @param dst       the array containing the pointers to the planes of
210  *                  the destination image
211  * @param dstStride the array containing the strides for each plane of
212  *                  the destination image
213  * @return          the height of the output slice
214  */
215 int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
216               const int srcStride[], int srcSliceY, int srcSliceH,
217               uint8_t *const dst[], const int dstStride[]);
218
219 /**
220  * @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg)
221  * @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg)
222  * @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]
223  * @param inv_table the yuv2rgb coefficients describing the input yuv space, normally ff_yuv2rgb_coeffs[x]
224  * @param brightness 16.16 fixed point brightness correction
225  * @param contrast 16.16 fixed point contrast correction
226  * @param saturation 16.16 fixed point saturation correction
227  * @return -1 if not supported
228  */
229 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
230                              int srcRange, const int table[4], int dstRange,
231                              int brightness, int contrast, int saturation);
232
233 /**
234  * @return -1 if not supported
235  */
236 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
237                              int *srcRange, int **table, int *dstRange,
238                              int *brightness, int *contrast, int *saturation);
239
240 /**
241  * Allocate and return an uninitialized vector with length coefficients.
242  */
243 SwsVector *sws_allocVec(int length);
244
245 /**
246  * Return a normalized Gaussian curve used to filter stuff
247  * quality = 3 is high quality, lower is lower quality.
248  */
249 SwsVector *sws_getGaussianVec(double variance, double quality);
250
251 /**
252  * Scale all the coefficients of a by the scalar value.
253  */
254 void sws_scaleVec(SwsVector *a, double scalar);
255
256 /**
257  * Scale all the coefficients of a so that their sum equals height.
258  */
259 void sws_normalizeVec(SwsVector *a, double height);
260
261 #if FF_API_SWS_VECTOR
262 attribute_deprecated SwsVector *sws_getConstVec(double c, int length);
263 attribute_deprecated SwsVector *sws_getIdentityVec(void);
264 attribute_deprecated void sws_convVec(SwsVector *a, SwsVector *b);
265 attribute_deprecated void sws_addVec(SwsVector *a, SwsVector *b);
266 attribute_deprecated void sws_subVec(SwsVector *a, SwsVector *b);
267 attribute_deprecated void sws_shiftVec(SwsVector *a, int shift);
268 attribute_deprecated SwsVector *sws_cloneVec(SwsVector *a);
269 attribute_deprecated void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
270 #endif
271
272 void sws_freeVec(SwsVector *a);
273
274 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
275                                 float lumaSharpen, float chromaSharpen,
276                                 float chromaHShift, float chromaVShift,
277                                 int verbose);
278 void sws_freeFilter(SwsFilter *filter);
279
280 /**
281  * Check if context can be reused, otherwise reallocate a new one.
282  *
283  * If context is NULL, just calls sws_getContext() to get a new
284  * context. Otherwise, checks if the parameters are the ones already
285  * saved in context. If that is the case, returns the current
286  * context. Otherwise, frees context and gets a new context with
287  * the new parameters.
288  *
289  * Be warned that srcFilter and dstFilter are not checked, they
290  * are assumed to remain the same.
291  */
292 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
293                                         int srcW, int srcH, enum AVPixelFormat srcFormat,
294                                         int dstW, int dstH, enum AVPixelFormat dstFormat,
295                                         int flags, SwsFilter *srcFilter,
296                                         SwsFilter *dstFilter, const double *param);
297
298 /**
299  * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
300  *
301  * The output frame will have the same packed format as the palette.
302  *
303  * @param src        source frame buffer
304  * @param dst        destination frame buffer
305  * @param num_pixels number of pixels to convert
306  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
307  */
308 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
309
310 /**
311  * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
312  *
313  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
314  *
315  * @param src        source frame buffer
316  * @param dst        destination frame buffer
317  * @param num_pixels number of pixels to convert
318  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
319  */
320 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
321
322 /**
323  * Get the AVClass for swsContext. It can be used in combination with
324  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
325  *
326  * @see av_opt_find().
327  */
328 const AVClass *sws_get_class(void);
329
330 /**
331  * @}
332  */
333
334 #endif /* SWSCALE_SWSCALE_H */