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