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