Reindent after last commit.
[libav.git] / libswscale / swscale.h
CommitLineData
fe8054c0 1/*
d026b45e
DB
2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
807e0c66
LA
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.
d026b45e
DB
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
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
LA
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
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
6a4970ab 26 * @brief
d4e24275
MN
27 * external api for the swscale stuff
28 */
29
88517699 30#include "libavutil/avutil.h"
d28ef270 31
e08e6bb6 32#define LIBSWSCALE_VERSION_MAJOR 0
2b991422 33#define LIBSWSCALE_VERSION_MINOR 11
8e9767f6 34#define LIBSWSCALE_VERSION_MICRO 0
ccf95ef1 35
e08e6bb6
MR
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)
94c4def2
LA
42#define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT
43
44#define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
45
b3e03fa7 46/**
5b9eb687 47 * Return the LIBSWSCALE_VERSION_INT constant.
b3e03fa7
SS
48 */
49unsigned swscale_version(void);
50
bd381fd3 51/**
5b9eb687 52 * Return the libswscale build-time configuration.
bd381fd3 53 */
997980f0 54const char *swscale_configuration(void);
bd381fd3
DB
55
56/**
5b9eb687 57 * Return the libswscale license.
bd381fd3 58 */
997980f0 59const char *swscale_license(void);
bd381fd3 60
28bf81c9 61/* values for the flags, the stuff on the command line is different */
221b804f
DB
62#define SWS_FAST_BILINEAR 1
63#define SWS_BILINEAR 2
64#define SWS_BICUBIC 4
65#define SWS_X 8
66#define SWS_POINT 0x10
67#define SWS_AREA 0x20
68#define SWS_BICUBLIN 0x40
69#define SWS_GAUSS 0x80
70#define SWS_SINC 0x100
71#define SWS_LANCZOS 0x200
72#define SWS_SPLINE 0x400
1e621b18 73
221b804f
DB
74#define SWS_SRC_V_CHR_DROP_MASK 0x30000
75#define SWS_SRC_V_CHR_DROP_SHIFT 16
5859233b 76
221b804f 77#define SWS_PARAM_DEFAULT 123456
a86c461c 78
221b804f 79#define SWS_PRINT_INFO 0x1000
a86c461c 80
86bdf3fd
DB
81//the following 3 flags are not completely implemented
82//internal chrominace subsampling info
221b804f 83#define SWS_FULL_CHR_H_INT 0x2000
1e621b18 84//input subsampling info
221b804f
DB
85#define SWS_FULL_CHR_H_INP 0x4000
86#define SWS_DIRECT_BGR 0x8000
87#define SWS_ACCURATE_RND 0x40000
ceb700ba 88#define SWS_BITEXACT 0x80000
1e621b18 89
221b804f
DB
90#define SWS_CPU_CAPS_MMX 0x80000000
91#define SWS_CPU_CAPS_MMX2 0x20000000
92#define SWS_CPU_CAPS_3DNOW 0x40000000
93#define SWS_CPU_CAPS_ALTIVEC 0x10000000
d3f3eea9 94#define SWS_CPU_CAPS_BFIN 0x01000000
516b1f82 95
c7f822d9 96#define SWS_MAX_REDUCE_CUTOFF 0.002
28bf81c9 97
221b804f
DB
98#define SWS_CS_ITU709 1
99#define SWS_CS_FCC 4
100#define SWS_CS_ITU601 5
101#define SWS_CS_ITU624 5
102#define SWS_CS_SMPTE170M 5
103#define SWS_CS_SMPTE240M 7
104#define SWS_CS_DEFAULT 5
0481412a 105
3f3dc76c 106/**
5b9eb687 107 * Return a pointer to yuv<->rgb coefficients for the given colorspace
fbc0f6a9
SS
108 * suitable for sws_setColorspaceDetails().
109 *
110 * @param colorspace One of the SWS_CS_* macros. If invalid,
111 * SWS_CS_DEFAULT is used.
3f3dc76c 112 */
89ee5c68 113const int *sws_getCoefficients(int colorspace);
77a49659 114
28bf81c9 115
c7f822d9
MN
116// when used for filters they must have an odd number of elements
117// coeffs cannot be shared between vectors
28bf81c9 118typedef struct {
edbdf77e
SS
119 double *coeff; ///< pointer to the list of coefficients
120 int length; ///< number of coefficients in the vector
c7f822d9
MN
121} SwsVector;
122
123// vectors can be shared
124typedef struct {
221b804f
DB
125 SwsVector *lumH;
126 SwsVector *lumV;
127 SwsVector *chrH;
128 SwsVector *chrV;
28bf81c9
MN
129} SwsFilter;
130
d4e24275 131struct SwsContext;
077ea8a7 132
2e0a80a1 133/**
5b9eb687 134 * Return a positive value if pix_fmt is a supported input format, 0
8e9767f6
SS
135 * otherwise.
136 */
137int sws_isSupportedInput(enum PixelFormat pix_fmt);
138
139/**
5b9eb687 140 * Return a positive value if pix_fmt is a supported output format, 0
8e9767f6
SS
141 * otherwise.
142 */
143int sws_isSupportedOutput(enum PixelFormat pix_fmt);
144
145/**
5b9eb687
SS
146 * Free the swscaler context swsContext.
147 * If swsContext is NULL, then do nothing.
2e0a80a1 148 */
d4e24275 149void sws_freeContext(struct SwsContext *swsContext);
28bf81c9 150
a1588654 151/**
5b9eb687 152 * Allocate and return a SwsContext. You need it to perform
a1588654
SS
153 * scaling/conversion operations using sws_scale().
154 *
155 * @param srcW the width of the source image
156 * @param srcH the height of the source image
157 * @param srcFormat the source image format
158 * @param dstW the width of the destination image
159 * @param dstH the height of the destination image
160 * @param dstFormat the destination image format
161 * @param flags specify which algorithm and options to use for rescaling
162 * @return a pointer to an allocated context, or NULL in case of error
163 */
d648c720
DB
164struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
165 int dstW, int dstH, enum PixelFormat dstFormat,
166 int flags, SwsFilter *srcFilter,
0020c54c 167 SwsFilter *dstFilter, const double *param);
583799c4
SS
168
169/**
5b9eb687 170 * Scale the image slice in srcSlice and put the resulting scaled
532ec283 171 * slice in the image in dst. A slice is a sequence of consecutive
a520e9f2
SS
172 * rows in an image.
173 *
174 * Slices have to be provided in sequential order, either in
175 * top-bottom or bottom-top order. If slices are provided in
176 * non-sequential order the behavior of the function is undefined.
583799c4
SS
177 *
178 * @param context the scaling context previously created with
179 * sws_getContext()
15239b7f 180 * @param srcSlice the array containing the pointers to the planes of
583799c4
SS
181 * the source slice
182 * @param srcStride the array containing the strides for each plane of
183 * the source image
184 * @param srcSliceY the position in the source image of the slice to
185 * process, that is the number (counted starting from
186 * zero) in the image of the first row of the slice
187 * @param srcSliceH the height of the source slice, that is the number
188 * of rows in the slice
189 * @param dst the array containing the pointers to the planes of
190 * the destination image
191 * @param dstStride the array containing the strides for each plane of
192 * the destination image
193 * @return the height of the output slice
194 */
01cc47dc
DC
195int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
196 int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
d458b7d4 197
c099766f 198#if LIBSWSCALE_VERSION_MAJOR < 1
1eeded39
SS
199/**
200 * @deprecated Use sws_scale() instead.
201 */
f28cc577 202int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
d648c720
DB
203 int srcStride[], int srcSliceY, int srcSliceH,
204 uint8_t* dst[], int dstStride[]) attribute_deprecated;
c099766f 205#endif
d4e24275 206
2d26fa28
SS
207/**
208 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
209 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
210 * @return -1 if not supported
211 */
d648c720
DB
212int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
213 int srcRange, const int table[4], int dstRange,
214 int brightness, int contrast, int saturation);
2d26fa28
SS
215
216/**
217 * @return -1 if not supported
218 */
d648c720
DB
219int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
220 int *srcRange, int **table, int *dstRange,
221 int *brightness, int *contrast, int *saturation);
6d3cf67c
SS
222
223/**
1aff375d
RP
224 * Allocates and returns an uninitialized vector with length coefficients.
225 */
226SwsVector *sws_allocVec(int length);
227
228/**
5b9eb687 229 * Return a normalized Gaussian curve used to filter stuff
6d3cf67c
SS
230 * quality=3 is high quality, lower is lower quality.
231 */
d4e24275 232SwsVector *sws_getGaussianVec(double variance, double quality);
c326825e
SS
233
234/**
5b9eb687 235 * Allocate and return a vector with length coefficients, all
532ec283 236 * with the same value c.
c326825e 237 */
d4e24275 238SwsVector *sws_getConstVec(double c, int length);
b5fdaebb
SS
239
240/**
5b9eb687 241 * Allocate and return a vector with just one coefficient, with
b5fdaebb
SS
242 * value 1.0.
243 */
d4e24275 244SwsVector *sws_getIdentityVec(void);
0bcb5b39
SS
245
246/**
5b9eb687 247 * Scale all the coefficients of a by the scalar value.
0bcb5b39 248 */
d4e24275 249void sws_scaleVec(SwsVector *a, double scalar);
a26b51cd
SS
250
251/**
5b9eb687 252 * Scale all the coefficients of a so that their sum equals height.
a26b51cd 253 */
d4e24275
MN
254void sws_normalizeVec(SwsVector *a, double height);
255void sws_convVec(SwsVector *a, SwsVector *b);
256void sws_addVec(SwsVector *a, SwsVector *b);
257void sws_subVec(SwsVector *a, SwsVector *b);
258void sws_shiftVec(SwsVector *a, int shift);
89b74647
SS
259
260/**
5b9eb687 261 * Allocate and return a clone of the vector a, that is a vector
532ec283 262 * with the same coefficients as a.
89b74647 263 */
d4e24275
MN
264SwsVector *sws_cloneVec(SwsVector *a);
265
26b40a65
SS
266#if LIBSWSCALE_VERSION_MAJOR < 1
267/**
268 * @deprecated Use sws_printVec2() instead.
269 */
270attribute_deprecated void sws_printVec(SwsVector *a);
271#endif
272
273/**
5b9eb687 274 * Print with av_log() a textual representation of the vector a
532ec283 275 * if log_level <= av_log_level.
26b40a65
SS
276 */
277void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
278
d4e24275
MN
279void sws_freeVec(SwsVector *a);
280
6a4970ab 281SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
b534f73d 282 float lumaSharpen, float chromaSharpen,
221b804f
DB
283 float chromaHShift, float chromaVShift,
284 int verbose);
e21206a8
MN
285void sws_freeFilter(SwsFilter *filter);
286
b954b34a 287/**
5b9eb687 288 * Check if context can be reused, otherwise reallocate a new
39e80e6c 289 * one.
b954b34a 290 *
5b9eb687
SS
291 * If context is NULL, just call sws_getContext() to get a new
292 * context. Otherwise, check if the parameters are the ones already
293 * saved in context. If that is the case, return the current
294 * context. Otherwise, free context and get a new context with
39e80e6c
SS
295 * the new parameters.
296 *
532ec283 297 * Be warned that srcFilter and dstFilter are not checked, they
39e80e6c 298 * are assumed to remain the same.
b954b34a 299 */
22e46959 300struct SwsContext *sws_getCachedContext(struct SwsContext *context,
96b27045 301 int srcW, int srcH, enum PixelFormat srcFormat,
d648c720
DB
302 int dstW, int dstH, enum PixelFormat dstFormat,
303 int flags, SwsFilter *srcFilter,
0020c54c 304 SwsFilter *dstFilter, const double *param);
22e46959 305
2b991422 306/**
5b9eb687 307 * Convert an 8bit paletted frame into a frame with a color depth of 32-bits.
2b991422
RT
308 *
309 * The output frame will have the same packed format as the palette.
310 *
311 * @param src source frame buffer
312 * @param dst destination frame buffer
313 * @param num_pixels number of pixels to convert
314 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
315 */
316void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
317
318/**
5b9eb687 319 * Convert an 8bit paletted frame into a frame with a color depth of 24 bits.
2b991422
RT
320 *
321 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
322 *
323 * @param src source frame buffer
324 * @param dst destination frame buffer
325 * @param num_pixels number of pixels to convert
326 * @param palette array with [256] entries, which must match color arrangement (RGB or BGR) of src
327 */
328void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
329
330
0eaf5235 331#endif /* SWSCALE_SWSCALE_H */