Cosmetics : reindent after last commit and remove redundant comment.
[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
e76709d8 34#define LIBSWSCALE_VERSION_MICRO 1
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
28bf81c9 51/* values for the flags, the stuff on the command line is different */
221b804f
DB
52#define SWS_FAST_BILINEAR 1
53#define SWS_BILINEAR 2
54#define SWS_BICUBIC 4
55#define SWS_X 8
56#define SWS_POINT 0x10
57#define SWS_AREA 0x20
58#define SWS_BICUBLIN 0x40
59#define SWS_GAUSS 0x80
60#define SWS_SINC 0x100
61#define SWS_LANCZOS 0x200
62#define SWS_SPLINE 0x400
1e621b18 63
221b804f
DB
64#define SWS_SRC_V_CHR_DROP_MASK 0x30000
65#define SWS_SRC_V_CHR_DROP_SHIFT 16
5859233b 66
221b804f 67#define SWS_PARAM_DEFAULT 123456
a86c461c 68
221b804f 69#define SWS_PRINT_INFO 0x1000
a86c461c 70
86bdf3fd
DB
71//the following 3 flags are not completely implemented
72//internal chrominace subsampling info
221b804f 73#define SWS_FULL_CHR_H_INT 0x2000
1e621b18 74//input subsampling info
221b804f
DB
75#define SWS_FULL_CHR_H_INP 0x4000
76#define SWS_DIRECT_BGR 0x8000
77#define SWS_ACCURATE_RND 0x40000
ceb700ba 78#define SWS_BITEXACT 0x80000
1e621b18 79
221b804f
DB
80#define SWS_CPU_CAPS_MMX 0x80000000
81#define SWS_CPU_CAPS_MMX2 0x20000000
82#define SWS_CPU_CAPS_3DNOW 0x40000000
83#define SWS_CPU_CAPS_ALTIVEC 0x10000000
d3f3eea9 84#define SWS_CPU_CAPS_BFIN 0x01000000
516b1f82 85
c7f822d9 86#define SWS_MAX_REDUCE_CUTOFF 0.002
28bf81c9 87
221b804f
DB
88#define SWS_CS_ITU709 1
89#define SWS_CS_FCC 4
90#define SWS_CS_ITU601 5
91#define SWS_CS_ITU624 5
92#define SWS_CS_SMPTE170M 5
93#define SWS_CS_SMPTE240M 7
94#define SWS_CS_DEFAULT 5
0481412a 95
77a49659 96
28bf81c9 97
c7f822d9
MN
98// when used for filters they must have an odd number of elements
99// coeffs cannot be shared between vectors
28bf81c9 100typedef struct {
edbdf77e
SS
101 double *coeff; ///< pointer to the list of coefficients
102 int length; ///< number of coefficients in the vector
c7f822d9
MN
103} SwsVector;
104
105// vectors can be shared
106typedef struct {
221b804f
DB
107 SwsVector *lumH;
108 SwsVector *lumV;
109 SwsVector *chrH;
110 SwsVector *chrV;
28bf81c9
MN
111} SwsFilter;
112
d4e24275 113struct SwsContext;
077ea8a7 114
d4e24275 115void sws_freeContext(struct SwsContext *swsContext);
28bf81c9 116
a1588654
SS
117/**
118 * Allocates and returns a SwsContext. You need it to perform
119 * scaling/conversion operations using sws_scale().
120 *
121 * @param srcW the width of the source image
122 * @param srcH the height of the source image
123 * @param srcFormat the source image format
124 * @param dstW the width of the destination image
125 * @param dstH the height of the destination image
126 * @param dstFormat the destination image format
127 * @param flags specify which algorithm and options to use for rescaling
128 * @return a pointer to an allocated context, or NULL in case of error
129 */
d648c720
DB
130struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
131 int dstW, int dstH, enum PixelFormat dstFormat,
132 int flags, SwsFilter *srcFilter,
133 SwsFilter *dstFilter, double *param);
583799c4
SS
134
135/**
15239b7f 136 * Scales the image slice in \p srcSlice and puts the resulting scaled
583799c4
SS
137 * slice in the image in \p dst. A slice is a sequence of consecutive
138 * rows in an image.
139 *
140 * @param context the scaling context previously created with
141 * sws_getContext()
15239b7f 142 * @param srcSlice the array containing the pointers to the planes of
583799c4
SS
143 * the source slice
144 * @param srcStride the array containing the strides for each plane of
145 * the source image
146 * @param srcSliceY the position in the source image of the slice to
147 * process, that is the number (counted starting from
148 * zero) in the image of the first row of the slice
149 * @param srcSliceH the height of the source slice, that is the number
150 * of rows in the slice
151 * @param dst the array containing the pointers to the planes of
152 * the destination image
153 * @param dstStride the array containing the strides for each plane of
154 * the destination image
155 * @return the height of the output slice
156 */
d648c720
DB
157int sws_scale(struct SwsContext *context, uint8_t* srcSlice[], int srcStride[],
158 int srcSliceY, int srcSliceH, uint8_t* dst[], int dstStride[]);
c099766f 159#if LIBSWSCALE_VERSION_MAJOR < 1
1eeded39
SS
160/**
161 * @deprecated Use sws_scale() instead.
162 */
d648c720
DB
163int sws_scale_ordered(struct SwsContext *context, uint8_t* src[],
164 int srcStride[], int srcSliceY, int srcSliceH,
165 uint8_t* dst[], int dstStride[]) attribute_deprecated;
c099766f 166#endif
d4e24275 167
d4e24275 168
d648c720
DB
169int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
170 int srcRange, const int table[4], int dstRange,
171 int brightness, int contrast, int saturation);
172int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
173 int *srcRange, int **table, int *dstRange,
174 int *brightness, int *contrast, int *saturation);
6d3cf67c
SS
175
176/**
177 * Returns a normalized Gaussian curve used to filter stuff
178 * quality=3 is high quality, lower is lower quality.
179 */
d4e24275 180SwsVector *sws_getGaussianVec(double variance, double quality);
c326825e
SS
181
182/**
70838eef 183 * Allocates and returns a vector with \p length coefficients, all
c326825e
SS
184 * with the same value \p c.
185 */
d4e24275 186SwsVector *sws_getConstVec(double c, int length);
b5fdaebb
SS
187
188/**
189 * Allocates and returns a vector with just one coefficient, with
190 * value 1.0.
191 */
d4e24275 192SwsVector *sws_getIdentityVec(void);
0bcb5b39
SS
193
194/**
195 * Scales all the coefficients of \p a by the \p scalar value.
196 */
d4e24275 197void sws_scaleVec(SwsVector *a, double scalar);
a26b51cd
SS
198
199/**
200 * Scales all the coefficients of \p a so that their sum equals \p
201 * height."
202 */
d4e24275
MN
203void sws_normalizeVec(SwsVector *a, double height);
204void sws_convVec(SwsVector *a, SwsVector *b);
205void sws_addVec(SwsVector *a, SwsVector *b);
206void sws_subVec(SwsVector *a, SwsVector *b);
207void sws_shiftVec(SwsVector *a, int shift);
89b74647
SS
208
209/**
210 * Allocates and returns a clone of the vector \p a, that is a vector
211 * with the same coefficients as \p a.
212 */
d4e24275
MN
213SwsVector *sws_cloneVec(SwsVector *a);
214
26b40a65
SS
215#if LIBSWSCALE_VERSION_MAJOR < 1
216/**
217 * @deprecated Use sws_printVec2() instead.
218 */
219attribute_deprecated void sws_printVec(SwsVector *a);
220#endif
221
222/**
223 * Prints with av_log() a textual representation of the vector \p a
224 * if \p log_level <= av_log_level.
225 */
226void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
227
d4e24275
MN
228void sws_freeVec(SwsVector *a);
229
6a4970ab 230SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
b534f73d 231 float lumaSharpen, float chromaSharpen,
221b804f
DB
232 float chromaHShift, float chromaVShift,
233 int verbose);
e21206a8
MN
234void sws_freeFilter(SwsFilter *filter);
235
b954b34a 236/**
39e80e6c
SS
237 * Checks if \p context can be reused, otherwise reallocates a new
238 * one.
b954b34a 239 *
39e80e6c
SS
240 * If \p context is NULL, just calls sws_getContext() to get a new
241 * context. Otherwise, checks if the parameters are the ones already
242 * saved in \p context. If that is the case, returns the current
243 * context. Otherwise, frees \p context and gets a new context with
244 * the new parameters.
245 *
246 * Be warned that \p srcFilter and \p dstFilter are not checked, they
247 * are assumed to remain the same.
b954b34a 248 */
22e46959 249struct SwsContext *sws_getCachedContext(struct SwsContext *context,
96b27045 250 int srcW, int srcH, enum PixelFormat srcFormat,
d648c720
DB
251 int dstW, int dstH, enum PixelFormat dstFormat,
252 int flags, SwsFilter *srcFilter,
253 SwsFilter *dstFilter, double *param);
22e46959 254
0eaf5235 255#endif /* SWSCALE_SWSCALE_H */