Commit | Line | Data |
---|---|---|
fe8054c0 | 1 | /* |
d026b45e DB |
2 | * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at> |
3 | * | |
2912e87a | 4 | * This file is part of Libav. |
d026b45e | 5 | * |
2912e87a | 6 | * Libav is free software; you can redistribute it and/or |
807e0c66 LA |
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. | |
d026b45e | 10 | * |
2912e87a | 11 | * Libav is distributed in the hope that it will be useful, |
d026b45e | 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
807e0c66 LA |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
14 | * Lesser General Public License for more details. | |
d026b45e | 15 | * |
807e0c66 | 16 | * You should have received a copy of the GNU Lesser General Public |
2912e87a | 17 | * License along with Libav; if not, write to the Free Software |
b19bcbaa | 18 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
d026b45e | 19 | */ |
3db822b0 | 20 | |
0eaf5235 SS |
21 | #ifndef SWSCALE_SWSCALE_H |
22 | #define SWSCALE_SWSCALE_H | |
5427e242 | 23 | |
d4e24275 | 24 | /** |
353285d7 | 25 | * @file |
c85aad9c | 26 | * @ingroup libsws |
6a4970ab | 27 | * @brief |
d4e24275 MN |
28 | * external api for the swscale stuff |
29 | */ | |
30 | ||
1d9c2dc8 MS |
31 | #include <stdint.h> |
32 | ||
88517699 | 33 | #include "libavutil/avutil.h" |
abc78a5a | 34 | #include "libavutil/log.h" |
d49ea4af | 35 | #include "libavutil/pixfmt.h" |
86ab7b0f | 36 | #include "version.h" |
0810a584 SS |
37 | |
38 | /** | |
c85aad9c LB |
39 | * @defgroup libsws Color conversion and scaling |
40 | * @{ | |
41 | * | |
58c42af7 | 42 | * Return the LIBSWSCALE_VERSION_INT constant. |
b3e03fa7 SS |
43 | */ |
44 | unsigned swscale_version(void); | |
45 | ||
bd381fd3 | 46 | /** |
58c42af7 | 47 | * Return the libswscale build-time configuration. |
bd381fd3 | 48 | */ |
997980f0 | 49 | const char *swscale_configuration(void); |
bd381fd3 DB |
50 | |
51 | /** | |
58c42af7 | 52 | * Return the libswscale license. |
bd381fd3 | 53 | */ |
997980f0 | 54 | const char *swscale_license(void); |
bd381fd3 | 55 | |
28bf81c9 | 56 | /* values for the flags, the stuff on the command line is different */ |
221b804f DB |
57 | #define SWS_FAST_BILINEAR 1 |
58 | #define SWS_BILINEAR 2 | |
59 | #define SWS_BICUBIC 4 | |
60 | #define SWS_X 8 | |
61 | #define SWS_POINT 0x10 | |
62 | #define SWS_AREA 0x20 | |
63 | #define SWS_BICUBLIN 0x40 | |
64 | #define SWS_GAUSS 0x80 | |
65 | #define SWS_SINC 0x100 | |
66 | #define SWS_LANCZOS 0x200 | |
67 | #define SWS_SPLINE 0x400 | |
1e621b18 | 68 | |
221b804f DB |
69 | #define SWS_SRC_V_CHR_DROP_MASK 0x30000 |
70 | #define SWS_SRC_V_CHR_DROP_SHIFT 16 | |
5859233b | 71 | |
221b804f | 72 | #define SWS_PARAM_DEFAULT 123456 |
a86c461c | 73 | |
221b804f | 74 | #define SWS_PRINT_INFO 0x1000 |
a86c461c | 75 | |
86bdf3fd DB |
76 | //the following 3 flags are not completely implemented |
77 | //internal chrominace subsampling info | |
221b804f | 78 | #define SWS_FULL_CHR_H_INT 0x2000 |
1e621b18 | 79 | //input subsampling info |
221b804f DB |
80 | #define SWS_FULL_CHR_H_INP 0x4000 |
81 | #define SWS_DIRECT_BGR 0x8000 | |
82 | #define SWS_ACCURATE_RND 0x40000 | |
ceb700ba | 83 | #define SWS_BITEXACT 0x80000 |
1e621b18 | 84 | |
c7f822d9 | 85 | #define SWS_MAX_REDUCE_CUTOFF 0.002 |
28bf81c9 | 86 | |
221b804f DB |
87 | #define SWS_CS_ITU709 1 |
88 | #define SWS_CS_FCC 4 | |
89 | #define SWS_CS_ITU601 5 | |
90 | #define SWS_CS_ITU624 5 | |
91 | #define SWS_CS_SMPTE170M 5 | |
92 | #define SWS_CS_SMPTE240M 7 | |
93 | #define SWS_CS_DEFAULT 5 | |
0481412a | 94 | |
3f3dc76c | 95 | /** |
58c42af7 | 96 | * Return a pointer to yuv<->rgb coefficients for the given colorspace |
fbc0f6a9 SS |
97 | * suitable for sws_setColorspaceDetails(). |
98 | * | |
99 | * @param colorspace One of the SWS_CS_* macros. If invalid, | |
100 | * SWS_CS_DEFAULT is used. | |
3f3dc76c | 101 | */ |
89ee5c68 | 102 | const int *sws_getCoefficients(int colorspace); |
77a49659 | 103 | |
c7f822d9 MN |
104 | // when used for filters they must have an odd number of elements |
105 | // coeffs cannot be shared between vectors | |
e4cbf752 | 106 | typedef struct SwsVector { |
edbdf77e SS |
107 | double *coeff; ///< pointer to the list of coefficients |
108 | int length; ///< number of coefficients in the vector | |
c7f822d9 MN |
109 | } SwsVector; |
110 | ||
111 | // vectors can be shared | |
e4cbf752 | 112 | typedef struct SwsFilter { |
221b804f DB |
113 | SwsVector *lumH; |
114 | SwsVector *lumV; | |
115 | SwsVector *chrH; | |
116 | SwsVector *chrV; | |
28bf81c9 MN |
117 | } SwsFilter; |
118 | ||
d4e24275 | 119 | struct SwsContext; |
077ea8a7 | 120 | |
2e0a80a1 | 121 | /** |
58c42af7 | 122 | * Return a positive value if pix_fmt is a supported input format, 0 |
8e9767f6 SS |
123 | * otherwise. |
124 | */ | |
716d413c | 125 | int sws_isSupportedInput(enum AVPixelFormat pix_fmt); |
8e9767f6 SS |
126 | |
127 | /** | |
58c42af7 | 128 | * Return a positive value if pix_fmt is a supported output format, 0 |
8e9767f6 SS |
129 | * otherwise. |
130 | */ | |
716d413c | 131 | int sws_isSupportedOutput(enum AVPixelFormat pix_fmt); |
8e9767f6 SS |
132 | |
133 | /** | |
c1eb3e7f JG |
134 | * @param[in] pix_fmt the pixel format |
135 | * @return a positive value if an endianness conversion for pix_fmt is | |
136 | * supported, 0 otherwise. | |
137 | */ | |
138 | int sws_isSupportedEndiannessConversion(enum AVPixelFormat pix_fmt); | |
139 | ||
140 | /** | |
58c42af7 | 141 | * Allocate an empty SwsContext. This must be filled and passed to |
33ce3846 RP |
142 | * sws_init_context(). For filling see AVOptions, options.c and |
143 | * sws_setColorspaceDetails(). | |
635d4aed MN |
144 | */ |
145 | struct SwsContext *sws_alloc_context(void); | |
146 | ||
147 | /** | |
58c42af7 | 148 | * Initialize the swscaler context sws_context. |
499287e0 SS |
149 | * |
150 | * @return zero or positive value on success, a negative value on | |
151 | * error | |
635d4aed MN |
152 | */ |
153 | int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter); | |
154 | ||
155 | /** | |
58c42af7 | 156 | * Free the swscaler context swsContext. |
ed80ba74 | 157 | * If swsContext is NULL, then does nothing. |
2e0a80a1 | 158 | */ |
d4e24275 | 159 | void sws_freeContext(struct SwsContext *swsContext); |
28bf81c9 | 160 | |
a1588654 | 161 | /** |
58c42af7 | 162 | * Allocate and return an SwsContext. You need it to perform |
a1588654 SS |
163 | * scaling/conversion operations using sws_scale(). |
164 | * | |
165 | * @param srcW the width of the source image | |
166 | * @param srcH the height of the source image | |
167 | * @param srcFormat the source image format | |
168 | * @param dstW the width of the destination image | |
169 | * @param dstH the height of the destination image | |
170 | * @param dstFormat the destination image format | |
171 | * @param flags specify which algorithm and options to use for rescaling | |
172 | * @return a pointer to an allocated context, or NULL in case of error | |
0464ee9a AK |
173 | * @note this function is to be removed after a saner alternative is |
174 | * written | |
a1588654 | 175 | */ |
716d413c AK |
176 | struct SwsContext *sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat, |
177 | int dstW, int dstH, enum AVPixelFormat dstFormat, | |
d648c720 | 178 | int flags, SwsFilter *srcFilter, |
0020c54c | 179 | SwsFilter *dstFilter, const double *param); |
583799c4 SS |
180 | |
181 | /** | |
58c42af7 | 182 | * Scale the image slice in srcSlice and put the resulting scaled |
532ec283 | 183 | * slice in the image in dst. A slice is a sequence of consecutive |
a520e9f2 SS |
184 | * rows in an image. |
185 | * | |
186 | * Slices have to be provided in sequential order, either in | |
187 | * top-bottom or bottom-top order. If slices are provided in | |
188 | * non-sequential order the behavior of the function is undefined. | |
583799c4 | 189 | * |
96c1e6d4 | 190 | * @param c the scaling context previously created with |
583799c4 | 191 | * sws_getContext() |
15239b7f | 192 | * @param srcSlice the array containing the pointers to the planes of |
583799c4 SS |
193 | * the source slice |
194 | * @param srcStride the array containing the strides for each plane of | |
195 | * the source image | |
196 | * @param srcSliceY the position in the source image of the slice to | |
197 | * process, that is the number (counted starting from | |
198 | * zero) in the image of the first row of the slice | |
199 | * @param srcSliceH the height of the source slice, that is the number | |
200 | * of rows in the slice | |
201 | * @param dst the array containing the pointers to the planes of | |
202 | * the destination image | |
203 | * @param dstStride the array containing the strides for each plane of | |
204 | * the destination image | |
205 | * @return the height of the output slice | |
206 | */ | |
83890c66 | 207 | int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[], |
96c1e6d4 | 208 | const int srcStride[], int srcSliceY, int srcSliceH, |
83890c66 | 209 | uint8_t *const dst[], const int dstStride[]); |
d458b7d4 | 210 | |
2d26fa28 SS |
211 | /** |
212 | * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x] | |
2d26fa28 SS |
213 | * @return -1 if not supported |
214 | */ | |
d648c720 DB |
215 | int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4], |
216 | int srcRange, const int table[4], int dstRange, | |
217 | int brightness, int contrast, int saturation); | |
2d26fa28 SS |
218 | |
219 | /** | |
220 | * @return -1 if not supported | |
221 | */ | |
d648c720 DB |
222 | int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, |
223 | int *srcRange, int **table, int *dstRange, | |
224 | int *brightness, int *contrast, int *saturation); | |
6d3cf67c SS |
225 | |
226 | /** | |
58c42af7 | 227 | * Allocate and return an uninitialized vector with length coefficients. |
1aff375d RP |
228 | */ |
229 | SwsVector *sws_allocVec(int length); | |
230 | ||
231 | /** | |
58c42af7 DB |
232 | * Return a normalized Gaussian curve used to filter stuff |
233 | * quality = 3 is high quality, lower is lower quality. | |
6d3cf67c | 234 | */ |
d4e24275 | 235 | SwsVector *sws_getGaussianVec(double variance, double quality); |
c326825e SS |
236 | |
237 | /** | |
58c42af7 | 238 | * Allocate and return a vector with length coefficients, all |
532ec283 | 239 | * with the same value c. |
c326825e | 240 | */ |
d4e24275 | 241 | SwsVector *sws_getConstVec(double c, int length); |
b5fdaebb SS |
242 | |
243 | /** | |
58c42af7 | 244 | * Allocate and return a vector with just one coefficient, with |
b5fdaebb SS |
245 | * value 1.0. |
246 | */ | |
d4e24275 | 247 | SwsVector *sws_getIdentityVec(void); |
0bcb5b39 SS |
248 | |
249 | /** | |
58c42af7 | 250 | * Scale all the coefficients of a by the scalar value. |
0bcb5b39 | 251 | */ |
d4e24275 | 252 | void sws_scaleVec(SwsVector *a, double scalar); |
a26b51cd SS |
253 | |
254 | /** | |
58c42af7 | 255 | * Scale all the coefficients of a so that their sum equals height. |
a26b51cd | 256 | */ |
d4e24275 MN |
257 | void sws_normalizeVec(SwsVector *a, double height); |
258 | void sws_convVec(SwsVector *a, SwsVector *b); | |
259 | void sws_addVec(SwsVector *a, SwsVector *b); | |
260 | void sws_subVec(SwsVector *a, SwsVector *b); | |
261 | void sws_shiftVec(SwsVector *a, int shift); | |
89b74647 SS |
262 | |
263 | /** | |
58c42af7 | 264 | * Allocate and return a clone of the vector a, that is a vector |
532ec283 | 265 | * with the same coefficients as a. |
89b74647 | 266 | */ |
d4e24275 MN |
267 | SwsVector *sws_cloneVec(SwsVector *a); |
268 | ||
26b40a65 | 269 | /** |
58c42af7 | 270 | * Print with av_log() a textual representation of the vector a |
532ec283 | 271 | * if log_level <= av_log_level. |
26b40a65 SS |
272 | */ |
273 | void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level); | |
274 | ||
d4e24275 MN |
275 | void sws_freeVec(SwsVector *a); |
276 | ||
6a4970ab | 277 | SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur, |
b534f73d | 278 | float lumaSharpen, float chromaSharpen, |
221b804f DB |
279 | float chromaHShift, float chromaVShift, |
280 | int verbose); | |
e21206a8 MN |
281 | void sws_freeFilter(SwsFilter *filter); |
282 | ||
b954b34a | 283 | /** |
58c42af7 | 284 | * Check if context can be reused, otherwise reallocate a new one. |
b954b34a | 285 | * |
ed80ba74 SS |
286 | * If context is NULL, just calls sws_getContext() to get a new |
287 | * context. Otherwise, checks if the parameters are the ones already | |
288 | * saved in context. If that is the case, returns the current | |
289 | * context. Otherwise, frees context and gets a new context with | |
39e80e6c SS |
290 | * the new parameters. |
291 | * | |
532ec283 | 292 | * Be warned that srcFilter and dstFilter are not checked, they |
39e80e6c | 293 | * are assumed to remain the same. |
b954b34a | 294 | */ |
22e46959 | 295 | struct SwsContext *sws_getCachedContext(struct SwsContext *context, |
716d413c AK |
296 | int srcW, int srcH, enum AVPixelFormat srcFormat, |
297 | int dstW, int dstH, enum AVPixelFormat dstFormat, | |
d648c720 | 298 | int flags, SwsFilter *srcFilter, |
0020c54c | 299 | SwsFilter *dstFilter, const double *param); |
22e46959 | 300 | |
2b991422 | 301 | /** |
58c42af7 | 302 | * Convert an 8-bit paletted frame into a frame with a color depth of 32 bits. |
2b991422 RT |
303 | * |
304 | * The output frame will have the same packed format as the palette. | |
305 | * | |
306 | * @param src source frame buffer | |
307 | * @param dst destination frame buffer | |
308 | * @param num_pixels number of pixels to convert | |
309 | * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src | |
310 | */ | |
b8e89339 | 311 | void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette); |
2b991422 RT |
312 | |
313 | /** | |
58c42af7 | 314 | * Convert an 8-bit paletted frame into a frame with a color depth of 24 bits. |
2b991422 RT |
315 | * |
316 | * With the palette format "ABCD", the destination frame ends up with the format "ABC". | |
317 | * | |
318 | * @param src source frame buffer | |
319 | * @param dst destination frame buffer | |
320 | * @param num_pixels number of pixels to convert | |
321 | * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src | |
322 | */ | |
b8e89339 | 323 | void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette); |
2b991422 | 324 | |
fb4ca26b AK |
325 | /** |
326 | * Get the AVClass for swsContext. It can be used in combination with | |
327 | * AV_OPT_SEARCH_FAKE_OBJ for examining options. | |
328 | * | |
329 | * @see av_opt_find(). | |
330 | */ | |
331 | const AVClass *sws_get_class(void); | |
2b991422 | 332 | |
c85aad9c LB |
333 | /** |
334 | * @} | |
335 | */ | |
336 | ||
0eaf5235 | 337 | #endif /* SWSCALE_SWSCALE_H */ |