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