Fix teh typos
[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 chrominace 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 #if FF_API_SWS_CPU_CAPS
86 /**
87  * CPU caps are autodetected now, those flags
88  * are only provided for API compatibility.
89  */
90 #define SWS_CPU_CAPS_MMX      0x80000000
91 #define SWS_CPU_CAPS_MMXEXT   0x20000000
92 #define SWS_CPU_CAPS_MMX2     0x20000000
93 #define SWS_CPU_CAPS_3DNOW    0x40000000
94 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
95 #define SWS_CPU_CAPS_BFIN     0x01000000
96 #define SWS_CPU_CAPS_SSE2     0x02000000
97 #endif
98
99 #define SWS_MAX_REDUCE_CUTOFF 0.002
100
101 #define SWS_CS_ITU709         1
102 #define SWS_CS_FCC            4
103 #define SWS_CS_ITU601         5
104 #define SWS_CS_ITU624         5
105 #define SWS_CS_SMPTE170M      5
106 #define SWS_CS_SMPTE240M      7
107 #define SWS_CS_DEFAULT        5
108
109 /**
110  * Return a pointer to yuv<->rgb coefficients for the given colorspace
111  * suitable for sws_setColorspaceDetails().
112  *
113  * @param colorspace One of the SWS_CS_* macros. If invalid,
114  * SWS_CS_DEFAULT is used.
115  */
116 const int *sws_getCoefficients(int colorspace);
117
118 // when used for filters they must have an odd number of elements
119 // coeffs cannot be shared between vectors
120 typedef struct SwsVector {
121     double *coeff;              ///< pointer to the list of coefficients
122     int length;                 ///< number of coefficients in the vector
123 } SwsVector;
124
125 // vectors can be shared
126 typedef struct SwsFilter {
127     SwsVector *lumH;
128     SwsVector *lumV;
129     SwsVector *chrH;
130     SwsVector *chrV;
131 } SwsFilter;
132
133 struct SwsContext;
134
135 /**
136  * Return a positive value if pix_fmt is a supported input format, 0
137  * otherwise.
138  */
139 int sws_isSupportedInput(enum AVPixelFormat pix_fmt);
140
141 /**
142  * Return a positive value if pix_fmt is a supported output format, 0
143  * otherwise.
144  */
145 int sws_isSupportedOutput(enum AVPixelFormat pix_fmt);
146
147 /**
148  * @param[in]  pix_fmt the pixel format
149  * @return a positive value if an endianness conversion for pix_fmt is
150  * supported, 0 otherwise.
151  */
152 int sws_isSupportedEndiannessConversion(enum AVPixelFormat pix_fmt);
153
154 /**
155  * Allocate 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  * Initialize 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  * Free 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  * Allocate and return an 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 AVPixelFormat srcFormat,
193                                   int dstW, int dstH, enum AVPixelFormat dstFormat,
194                                   int flags, SwsFilter *srcFilter,
195                                   SwsFilter *dstFilter, const double *param);
196 #endif
197
198 /**
199  * Scale the image slice in srcSlice and put 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 c         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 *c, const uint8_t *const srcSlice[],
225               const int srcStride[], int srcSliceY, int srcSliceH,
226               uint8_t *const dst[], const int dstStride[]);
227
228 /**
229  * @param dstRange flag indicating the while-black range of the output (1=jpeg / 0=mpeg)
230  * @param srcRange flag indicating the while-black range of the input (1=jpeg / 0=mpeg)
231  * @param table the yuv2rgb coefficients describing the output yuv space, normally ff_yuv2rgb_coeffs[x]
232  * @param inv_table the yuv2rgb coefficients describing the input yuv space, normally ff_yuv2rgb_coeffs[x]
233  * @param brightness 16.16 fixed point brightness correction
234  * @param contrast 16.16 fixed point contrast correction
235  * @param saturation 16.16 fixed point saturation correction
236  * @return -1 if not supported
237  */
238 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
239                              int srcRange, const int table[4], int dstRange,
240                              int brightness, int contrast, int saturation);
241
242 /**
243  * @return -1 if not supported
244  */
245 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
246                              int *srcRange, int **table, int *dstRange,
247                              int *brightness, int *contrast, int *saturation);
248
249 /**
250  * Allocate and return an uninitialized vector with length coefficients.
251  */
252 SwsVector *sws_allocVec(int length);
253
254 /**
255  * Return a normalized Gaussian curve used to filter stuff
256  * quality = 3 is high quality, lower is lower quality.
257  */
258 SwsVector *sws_getGaussianVec(double variance, double quality);
259
260 /**
261  * Allocate and return a vector with length coefficients, all
262  * with the same value c.
263  */
264 SwsVector *sws_getConstVec(double c, int length);
265
266 /**
267  * Allocate and return a vector with just one coefficient, with
268  * value 1.0.
269  */
270 SwsVector *sws_getIdentityVec(void);
271
272 /**
273  * Scale all the coefficients of a by the scalar value.
274  */
275 void sws_scaleVec(SwsVector *a, double scalar);
276
277 /**
278  * Scale all the coefficients of a so that their sum equals height.
279  */
280 void sws_normalizeVec(SwsVector *a, double height);
281 void sws_convVec(SwsVector *a, SwsVector *b);
282 void sws_addVec(SwsVector *a, SwsVector *b);
283 void sws_subVec(SwsVector *a, SwsVector *b);
284 void sws_shiftVec(SwsVector *a, int shift);
285
286 /**
287  * Allocate and return a clone of the vector a, that is a vector
288  * with the same coefficients as a.
289  */
290 SwsVector *sws_cloneVec(SwsVector *a);
291
292 /**
293  * Print with av_log() a textual representation of the vector a
294  * if log_level <= av_log_level.
295  */
296 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
297
298 void sws_freeVec(SwsVector *a);
299
300 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
301                                 float lumaSharpen, float chromaSharpen,
302                                 float chromaHShift, float chromaVShift,
303                                 int verbose);
304 void sws_freeFilter(SwsFilter *filter);
305
306 /**
307  * Check if context can be reused, otherwise reallocate a new one.
308  *
309  * If context is NULL, just calls sws_getContext() to get a new
310  * context. Otherwise, checks if the parameters are the ones already
311  * saved in context. If that is the case, returns the current
312  * context. Otherwise, frees context and gets a new context with
313  * the new parameters.
314  *
315  * Be warned that srcFilter and dstFilter are not checked, they
316  * are assumed to remain the same.
317  */
318 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
319                                         int srcW, int srcH, enum AVPixelFormat srcFormat,
320                                         int dstW, int dstH, enum AVPixelFormat dstFormat,
321                                         int flags, SwsFilter *srcFilter,
322                                         SwsFilter *dstFilter, const double *param);
323
324 /**
325  * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
326  *
327  * The output frame will have the same packed format as the palette.
328  *
329  * @param src        source frame buffer
330  * @param dst        destination frame buffer
331  * @param num_pixels number of pixels to convert
332  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
333  */
334 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
335
336 /**
337  * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
338  *
339  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
340  *
341  * @param src        source frame buffer
342  * @param dst        destination frame buffer
343  * @param num_pixels number of pixels to convert
344  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
345  */
346 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
347
348 /**
349  * Get the AVClass for swsContext. It can be used in combination with
350  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
351  *
352  * @see av_opt_find().
353  */
354 const AVClass *sws_get_class(void);
355
356 /**
357  * @}
358  */
359
360 #endif /* SWSCALE_SWSCALE_H */