Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libswscale / swscale.h
1 /*
2  * Copyright (C) 2001-2003 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  * @brief
27  *     external api for the swscale stuff
28  */
29
30 #include "libavutil/avutil.h"
31
32 #define LIBSWSCALE_VERSION_MAJOR 0
33 #define LIBSWSCALE_VERSION_MINOR 14
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_MAX_REDUCE_CUTOFF 0.002
99
100 #define SWS_CS_ITU709         1
101 #define SWS_CS_FCC            4
102 #define SWS_CS_ITU601         5
103 #define SWS_CS_ITU624         5
104 #define SWS_CS_SMPTE170M      5
105 #define SWS_CS_SMPTE240M      7
106 #define SWS_CS_DEFAULT        5
107
108 /**
109  * Returns a pointer to yuv<->rgb coefficients for the given colorspace
110  * suitable for sws_setColorspaceDetails().
111  *
112  * @param colorspace One of the SWS_CS_* macros. If invalid,
113  * SWS_CS_DEFAULT is used.
114  */
115 const int *sws_getCoefficients(int colorspace);
116
117
118 // when used for filters they must have an odd number of elements
119 // coeffs cannot be shared between vectors
120 typedef struct {
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 {
127     SwsVector *lumH;
128     SwsVector *lumV;
129     SwsVector *chrH;
130     SwsVector *chrV;
131 } SwsFilter;
132
133 struct SwsContext;
134
135 /**
136  * Returns a positive value if pix_fmt is a supported input format, 0
137  * otherwise.
138  */
139 int sws_isSupportedInput(enum PixelFormat pix_fmt);
140
141 /**
142  * Returns a positive value if pix_fmt is a supported output format, 0
143  * otherwise.
144  */
145 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
146
147 /**
148  * Allocates an empty SwsContext. This must be filled and passed to
149  * sws_init_context(). For filling see AVOptions, options.c and
150  * sws_setColorspaceDetails().
151  */
152 struct SwsContext *sws_alloc_context(void);
153
154 /**
155  * Initializes the swscaler context sws_context.
156  *
157  * @return zero or positive value on success, a negative value on
158  * error
159  */
160 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
161
162 /**
163  * Frees the swscaler context swsContext.
164  * If swsContext is NULL, then does nothing.
165  */
166 void sws_freeContext(struct SwsContext *swsContext);
167
168 #if FF_API_SWS_GETCONTEXT
169 /**
170  * Allocates and returns a SwsContext. You need it to perform
171  * scaling/conversion operations using sws_scale().
172  *
173  * @param srcW the width of the source image
174  * @param srcH the height of the source image
175  * @param srcFormat the source image format
176  * @param dstW the width of the destination image
177  * @param dstH the height of the destination image
178  * @param dstFormat the destination image format
179  * @param flags specify which algorithm and options to use for rescaling
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  * @deprecated Use sws_getCachedContext() instead.
184  */
185 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
186                                   int dstW, int dstH, enum PixelFormat dstFormat,
187                                   int flags, SwsFilter *srcFilter,
188                                   SwsFilter *dstFilter, const double *param);
189 #endif
190
191 /**
192  * Scales the image slice in srcSlice and puts the resulting scaled
193  * slice in the image in dst. A slice is a sequence of consecutive
194  * rows in an image.
195  *
196  * Slices have to be provided in sequential order, either in
197  * top-bottom or bottom-top order. If slices are provided in
198  * non-sequential order the behavior of the function is undefined.
199  *
200  * @param context   the scaling context previously created with
201  *                  sws_getContext()
202  * @param srcSlice  the array containing the pointers to the planes of
203  *                  the source slice
204  * @param srcStride the array containing the strides for each plane of
205  *                  the source image
206  * @param srcSliceY the position in the source image of the slice to
207  *                  process, that is the number (counted starting from
208  *                  zero) in the image of the first row of the slice
209  * @param srcSliceH the height of the source slice, that is the number
210  *                  of rows in the slice
211  * @param dst       the array containing the pointers to the planes of
212  *                  the destination image
213  * @param dstStride the array containing the strides for each plane of
214  *                  the destination image
215  * @return          the height of the output slice
216  */
217 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
218               int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
219
220 #if LIBSWSCALE_VERSION_MAJOR < 1
221 /**
222  * @deprecated Use sws_scale() instead.
223  */
224 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
225                       int srcStride[], int srcSliceY, int srcSliceH,
226                       uint8_t* dst[], int dstStride[]) attribute_deprecated;
227 #endif
228
229 /**
230  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
231  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
232  * @return -1 if not supported
233  */
234 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
235                              int srcRange, const int table[4], int dstRange,
236                              int brightness, int contrast, int saturation);
237
238 /**
239  * @return -1 if not supported
240  */
241 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
242                              int *srcRange, int **table, int *dstRange,
243                              int *brightness, int *contrast, int *saturation);
244
245 /**
246  * Allocates and returns an uninitialized vector with length coefficients.
247  */
248 SwsVector *sws_allocVec(int length);
249
250 /**
251  * Returns a normalized Gaussian curve used to filter stuff
252  * quality=3 is high quality, lower is lower quality.
253  */
254 SwsVector *sws_getGaussianVec(double variance, double quality);
255
256 /**
257  * Allocates and returns a vector with length coefficients, all
258  * with the same value c.
259  */
260 SwsVector *sws_getConstVec(double c, int length);
261
262 /**
263  * Allocates and returns a vector with just one coefficient, with
264  * value 1.0.
265  */
266 SwsVector *sws_getIdentityVec(void);
267
268 /**
269  * Scales all the coefficients of a by the scalar value.
270  */
271 void sws_scaleVec(SwsVector *a, double scalar);
272
273 /**
274  * Scales all the coefficients of a so that their sum equals height.
275  */
276 void sws_normalizeVec(SwsVector *a, double height);
277 void sws_convVec(SwsVector *a, SwsVector *b);
278 void sws_addVec(SwsVector *a, SwsVector *b);
279 void sws_subVec(SwsVector *a, SwsVector *b);
280 void sws_shiftVec(SwsVector *a, int shift);
281
282 /**
283  * Allocates and returns a clone of the vector a, that is a vector
284  * with the same coefficients as a.
285  */
286 SwsVector *sws_cloneVec(SwsVector *a);
287
288 #if LIBSWSCALE_VERSION_MAJOR < 1
289 /**
290  * @deprecated Use sws_printVec2() instead.
291  */
292 attribute_deprecated void sws_printVec(SwsVector *a);
293 #endif
294
295 /**
296  * Prints with av_log() a textual representation of the vector a
297  * if log_level <= av_log_level.
298  */
299 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
300
301 void sws_freeVec(SwsVector *a);
302
303 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
304                                 float lumaSharpen, float chromaSharpen,
305                                 float chromaHShift, float chromaVShift,
306                                 int verbose);
307 void sws_freeFilter(SwsFilter *filter);
308
309 /**
310  * Checks if context can be reused, otherwise reallocates a new
311  * one.
312  *
313  * If context is NULL, just calls sws_getContext() to get a new
314  * context. Otherwise, checks if the parameters are the ones already
315  * saved in context. If that is the case, returns the current
316  * context. Otherwise, frees context and gets a new context with
317  * the new parameters.
318  *
319  * Be warned that srcFilter and dstFilter are not checked, they
320  * are assumed to remain the same.
321  */
322 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
323                                         int srcW, int srcH, enum PixelFormat srcFormat,
324                                         int dstW, int dstH, enum PixelFormat dstFormat,
325                                         int flags, SwsFilter *srcFilter,
326                                         SwsFilter *dstFilter, const double *param);
327
328 /**
329  * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
330  *
331  * The output frame will have the same packed format as the palette.
332  *
333  * @param src        source frame buffer
334  * @param dst        destination frame buffer
335  * @param num_pixels number of pixels to convert
336  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
337  */
338 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
339
340 /**
341  * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
342  *
343  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
344  *
345  * @param src        source frame buffer
346  * @param dst        destination frame buffer
347  * @param num_pixels number of pixels to convert
348  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
349  */
350 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
351
352
353 #endif /* SWSCALE_SWSCALE_H */