Satisfy consistency need:
[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/**
82aaa790 25 * @file libswscale/swscale.h
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
3f3dc76c 33#define LIBSWSCALE_VERSION_MINOR 10
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
SS
46/**
47 * Returns the LIBSWSCALE_VERSION_INT constant.
48 */
49unsigned swscale_version(void);
50
bd381fd3
DB
51/**
52 * Returns the libswscale build-time configuration.
53 */
997980f0 54const char *swscale_configuration(void);
bd381fd3
DB
55
56/**
57 * Returns the libswscale license.
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
DC
106/**
107 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
108 * suitable for sws_setColorspaceDetails()
109 * @colorspace one of SWS_CS_* If invalid, SWS_CS_DEFAULT is used.
110 */
89ee5c68 111const int *sws_getCoefficients(int colorspace);
77a49659 112
28bf81c9 113
c7f822d9
MN
114// when used for filters they must have an odd number of elements
115// coeffs cannot be shared between vectors
28bf81c9 116typedef struct {
edbdf77e
SS
117 double *coeff; ///< pointer to the list of coefficients
118 int length; ///< number of coefficients in the vector
c7f822d9
MN
119} SwsVector;
120
121// vectors can be shared
122typedef struct {
221b804f
DB
123 SwsVector *lumH;
124 SwsVector *lumV;
125 SwsVector *chrH;
126 SwsVector *chrV;
28bf81c9
MN
127} SwsFilter;
128
d4e24275 129struct SwsContext;
077ea8a7 130
2e0a80a1 131/**
8e9767f6
SS
132 * Returns a positive value if pix_fmt is a supported input format, 0
133 * otherwise.
134 */
135int sws_isSupportedInput(enum PixelFormat pix_fmt);
136
137/**
138 * Returns a positive value if pix_fmt is a supported output format, 0
139 * otherwise.
140 */
141int sws_isSupportedOutput(enum PixelFormat pix_fmt);
142
143/**
2e0a80a1
SS
144 * Frees the swscaler context swsContext.
145 * If swsContext is NULL, then does nothing.
146 */
d4e24275 147void sws_freeContext(struct SwsContext *swsContext);
28bf81c9 148
a1588654
SS
149/**
150 * Allocates and returns a SwsContext. You need it to perform
151 * scaling/conversion operations using sws_scale().
152 *
153 * @param srcW the width of the source image
154 * @param srcH the height of the source image
155 * @param srcFormat the source image format
156 * @param dstW the width of the destination image
157 * @param dstH the height of the destination image
158 * @param dstFormat the destination image format
159 * @param flags specify which algorithm and options to use for rescaling
160 * @return a pointer to an allocated context, or NULL in case of error
161 */
d648c720
DB
162struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
163 int dstW, int dstH, enum PixelFormat dstFormat,
164 int flags, SwsFilter *srcFilter,
0020c54c 165 SwsFilter *dstFilter, const double *param);
583799c4
SS
166
167/**
532ec283
SS
168 * Scales the image slice in srcSlice and puts the resulting scaled
169 * slice in the image in dst. A slice is a sequence of consecutive
a520e9f2
SS
170 * rows in an image.
171 *
172 * Slices have to be provided in sequential order, either in
173 * top-bottom or bottom-top order. If slices are provided in
174 * non-sequential order the behavior of the function is undefined.
583799c4
SS
175 *
176 * @param context the scaling context previously created with
177 * sws_getContext()
15239b7f 178 * @param srcSlice the array containing the pointers to the planes of
583799c4
SS
179 * the source slice
180 * @param srcStride the array containing the strides for each plane of
181 * the source image
182 * @param srcSliceY the position in the source image of the slice to
183 * process, that is the number (counted starting from
184 * zero) in the image of the first row of the slice
185 * @param srcSliceH the height of the source slice, that is the number
186 * of rows in the slice
187 * @param dst the array containing the pointers to the planes of
188 * the destination image
189 * @param dstStride the array containing the strides for each plane of
190 * the destination image
191 * @return the height of the output slice
192 */
01cc47dc
DC
193int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
194 int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
c099766f 195#if LIBSWSCALE_VERSION_MAJOR < 1
1eeded39
SS
196/**
197 * @deprecated Use sws_scale() instead.
198 */
f28cc577 199int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
d648c720
DB
200 int srcStride[], int srcSliceY, int srcSliceH,
201 uint8_t* dst[], int dstStride[]) attribute_deprecated;
c099766f 202#endif
d4e24275 203
2d26fa28
SS
204/**
205 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
206 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
207 * @return -1 if not supported
208 */
d648c720
DB
209int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
210 int srcRange, const int table[4], int dstRange,
211 int brightness, int contrast, int saturation);
2d26fa28
SS
212
213/**
214 * @return -1 if not supported
215 */
d648c720
DB
216int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
217 int *srcRange, int **table, int *dstRange,
218 int *brightness, int *contrast, int *saturation);
6d3cf67c
SS
219
220/**
1aff375d
RP
221 * Allocates and returns an uninitialized vector with length coefficients.
222 */
223SwsVector *sws_allocVec(int length);
224
225/**
6d3cf67c
SS
226 * Returns a normalized Gaussian curve used to filter stuff
227 * quality=3 is high quality, lower is lower quality.
228 */
d4e24275 229SwsVector *sws_getGaussianVec(double variance, double quality);
c326825e
SS
230
231/**
532ec283
SS
232 * Allocates and returns a vector with length coefficients, all
233 * with the same value c.
c326825e 234 */
d4e24275 235SwsVector *sws_getConstVec(double c, int length);
b5fdaebb
SS
236
237/**
238 * Allocates and returns a vector with just one coefficient, with
239 * value 1.0.
240 */
d4e24275 241SwsVector *sws_getIdentityVec(void);
0bcb5b39
SS
242
243/**
532ec283 244 * Scales all the coefficients of a by the scalar value.
0bcb5b39 245 */
d4e24275 246void sws_scaleVec(SwsVector *a, double scalar);
a26b51cd
SS
247
248/**
532ec283 249 * Scales all the coefficients of a so that their sum equals height.
a26b51cd 250 */
d4e24275
MN
251void sws_normalizeVec(SwsVector *a, double height);
252void sws_convVec(SwsVector *a, SwsVector *b);
253void sws_addVec(SwsVector *a, SwsVector *b);
254void sws_subVec(SwsVector *a, SwsVector *b);
255void sws_shiftVec(SwsVector *a, int shift);
89b74647
SS
256
257/**
532ec283
SS
258 * Allocates and returns a clone of the vector a, that is a vector
259 * with the same coefficients as a.
89b74647 260 */
d4e24275
MN
261SwsVector *sws_cloneVec(SwsVector *a);
262
26b40a65
SS
263#if LIBSWSCALE_VERSION_MAJOR < 1
264/**
265 * @deprecated Use sws_printVec2() instead.
266 */
267attribute_deprecated void sws_printVec(SwsVector *a);
268#endif
269
270/**
532ec283
SS
271 * Prints with av_log() a textual representation of the vector a
272 * if log_level <= av_log_level.
26b40a65
SS
273 */
274void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
275
d4e24275
MN
276void sws_freeVec(SwsVector *a);
277
6a4970ab 278SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
b534f73d 279 float lumaSharpen, float chromaSharpen,
221b804f
DB
280 float chromaHShift, float chromaVShift,
281 int verbose);
e21206a8
MN
282void sws_freeFilter(SwsFilter *filter);
283
b954b34a 284/**
532ec283 285 * Checks if context can be reused, otherwise reallocates a new
39e80e6c 286 * one.
b954b34a 287 *
532ec283 288 * If context is NULL, just calls sws_getContext() to get a new
39e80e6c 289 * context. Otherwise, checks if the parameters are the ones already
532ec283
SS
290 * saved in context. If that is the case, returns the current
291 * context. Otherwise, frees context and gets a new context with
39e80e6c
SS
292 * the new parameters.
293 *
532ec283 294 * Be warned that srcFilter and dstFilter are not checked, they
39e80e6c 295 * are assumed to remain the same.
b954b34a 296 */
22e46959 297struct SwsContext *sws_getCachedContext(struct SwsContext *context,
96b27045 298 int srcW, int srcH, enum PixelFormat srcFormat,
d648c720
DB
299 int dstW, int dstH, enum PixelFormat dstFormat,
300 int flags, SwsFilter *srcFilter,
0020c54c 301 SwsFilter *dstFilter, const double *param);
22e46959 302
0eaf5235 303#endif /* SWSCALE_SWSCALE_H */