598946d807d08571d0de73dae1c9058f908e2d35
[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 #if LIBSWSCALE_VERSION_MAJOR < 3
89 #define SWS_CPU_CAPS_MMX2     0x20000000
90 #endif
91 #define SWS_CPU_CAPS_3DNOW    0x40000000
92 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
93 #define SWS_CPU_CAPS_BFIN     0x01000000
94 #define SWS_CPU_CAPS_SSE2     0x02000000
95 #endif
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  * Return 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 // when used for filters they must have an odd number of elements
117 // coeffs cannot be shared between vectors
118 typedef struct SwsVector {
119     double *coeff;              ///< pointer to the list of coefficients
120     int length;                 ///< number of coefficients in the vector
121 } SwsVector;
122
123 // vectors can be shared
124 typedef struct SwsFilter {
125     SwsVector *lumH;
126     SwsVector *lumV;
127     SwsVector *chrH;
128     SwsVector *chrV;
129 } SwsFilter;
130
131 struct SwsContext;
132
133 /**
134  * Return a positive value if pix_fmt is a supported input format, 0
135  * otherwise.
136  */
137 int sws_isSupportedInput(enum AVPixelFormat pix_fmt);
138
139 /**
140  * Return a positive value if pix_fmt is a supported output format, 0
141  * otherwise.
142  */
143 int sws_isSupportedOutput(enum AVPixelFormat pix_fmt);
144
145 /**
146  * Allocate an empty SwsContext. This must be filled and passed to
147  * sws_init_context(). For filling see AVOptions, options.c and
148  * sws_setColorspaceDetails().
149  */
150 struct SwsContext *sws_alloc_context(void);
151
152 /**
153  * Initialize the swscaler context sws_context.
154  *
155  * @return zero or positive value on success, a negative value on
156  * error
157  */
158 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
159
160 /**
161  * Free the swscaler context swsContext.
162  * If swsContext is NULL, then does nothing.
163  */
164 void sws_freeContext(struct SwsContext *swsContext);
165
166 #if FF_API_SWS_GETCONTEXT
167 /**
168  * Allocate and return an SwsContext. You need it to perform
169  * scaling/conversion operations using sws_scale().
170  *
171  * @param srcW the width of the source image
172  * @param srcH the height of the source image
173  * @param srcFormat the source image format
174  * @param dstW the width of the destination image
175  * @param dstH the height of the destination image
176  * @param dstFormat the destination image format
177  * @param flags specify which algorithm and options to use for rescaling
178  * @return a pointer to an allocated context, or NULL in case of error
179  * @note this function is to be removed after a saner alternative is
180  *       written
181  * @deprecated Use sws_getCachedContext() instead.
182  */
183 struct SwsContext *sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat,
184                                   int dstW, int dstH, enum AVPixelFormat dstFormat,
185                                   int flags, SwsFilter *srcFilter,
186                                   SwsFilter *dstFilter, const double *param);
187 #endif
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 inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
221  * @return -1 if not supported
222  */
223 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
224                              int srcRange, const int table[4], int dstRange,
225                              int brightness, int contrast, int saturation);
226
227 /**
228  * @return -1 if not supported
229  */
230 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
231                              int *srcRange, int **table, int *dstRange,
232                              int *brightness, int *contrast, int *saturation);
233
234 /**
235  * Allocate and return an uninitialized vector with length coefficients.
236  */
237 SwsVector *sws_allocVec(int length);
238
239 /**
240  * Return a normalized Gaussian curve used to filter stuff
241  * quality = 3 is high quality, lower is lower quality.
242  */
243 SwsVector *sws_getGaussianVec(double variance, double quality);
244
245 /**
246  * Allocate and return a vector with length coefficients, all
247  * with the same value c.
248  */
249 SwsVector *sws_getConstVec(double c, int length);
250
251 /**
252  * Allocate and return a vector with just one coefficient, with
253  * value 1.0.
254  */
255 SwsVector *sws_getIdentityVec(void);
256
257 /**
258  * Scale all the coefficients of a by the scalar value.
259  */
260 void sws_scaleVec(SwsVector *a, double scalar);
261
262 /**
263  * Scale all the coefficients of a so that their sum equals height.
264  */
265 void sws_normalizeVec(SwsVector *a, double height);
266 void sws_convVec(SwsVector *a, SwsVector *b);
267 void sws_addVec(SwsVector *a, SwsVector *b);
268 void sws_subVec(SwsVector *a, SwsVector *b);
269 void sws_shiftVec(SwsVector *a, int shift);
270
271 /**
272  * Allocate and return a clone of the vector a, that is a vector
273  * with the same coefficients as a.
274  */
275 SwsVector *sws_cloneVec(SwsVector *a);
276
277 /**
278  * Print with av_log() a textual representation of the vector a
279  * if log_level <= av_log_level.
280  */
281 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
282
283 void sws_freeVec(SwsVector *a);
284
285 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
286                                 float lumaSharpen, float chromaSharpen,
287                                 float chromaHShift, float chromaVShift,
288                                 int verbose);
289 void sws_freeFilter(SwsFilter *filter);
290
291 /**
292  * Check if context can be reused, otherwise reallocate a new one.
293  *
294  * If context is NULL, just calls sws_getContext() to get a new
295  * context. Otherwise, checks if the parameters are the ones already
296  * saved in context. If that is the case, returns the current
297  * context. Otherwise, frees context and gets a new context with
298  * the new parameters.
299  *
300  * Be warned that srcFilter and dstFilter are not checked, they
301  * are assumed to remain the same.
302  */
303 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
304                                         int srcW, int srcH, enum AVPixelFormat srcFormat,
305                                         int dstW, int dstH, enum AVPixelFormat dstFormat,
306                                         int flags, SwsFilter *srcFilter,
307                                         SwsFilter *dstFilter, const double *param);
308
309 /**
310  * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
311  *
312  * The output frame will have the same packed format as the palette.
313  *
314  * @param src        source frame buffer
315  * @param dst        destination frame buffer
316  * @param num_pixels number of pixels to convert
317  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
318  */
319 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
320
321 /**
322  * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
323  *
324  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
325  *
326  * @param src        source frame buffer
327  * @param dst        destination frame buffer
328  * @param num_pixels number of pixels to convert
329  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
330  */
331 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
332
333 /**
334  * Get the AVClass for swsContext. It can be used in combination with
335  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
336  *
337  * @see av_opt_find().
338  */
339 const AVClass *sws_get_class(void);
340
341 #endif /* SWSCALE_SWSCALE_H */