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