d940e8227134748c48a2941726e73a276aadecff
[libav.git] / libswscale / swscale.h
1 /*
2 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
3 *
4 * This file is part of FFmpeg.
5 *
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.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
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
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21 #ifndef SWSCALE_SWSCALE_H
22 #define SWSCALE_SWSCALE_H
23
24 /**
25 * @file libswscale/swscale.h
26 * @brief
27 * external api for the swscale stuff
28 */
29
30 #include "libavutil/avutil.h"
31
32 #define LIBSWSCALE_VERSION_MAJOR 0
33 #define LIBSWSCALE_VERSION_MINOR 7
34 #define LIBSWSCALE_VERSION_MICRO 2
35
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)
42 #define LIBSWSCALE_BUILD LIBSWSCALE_VERSION_INT
43
44 #define LIBSWSCALE_IDENT "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
45
46 /**
47 * Returns the LIBSWSCALE_VERSION_INT constant.
48 */
49 unsigned swscale_version(void);
50
51 /**
52 * Returns the libswscale build-time configuration.
53 */
54 const char * swscale_configuration(void);
55
56 /**
57 * Returns the libswscale license.
58 */
59 const char * swscale_license(void);
60
61 /* values for the flags, the stuff on the command line is different */
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
73
74 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
75 #define SWS_SRC_V_CHR_DROP_SHIFT 16
76
77 #define SWS_PARAM_DEFAULT 123456
78
79 #define SWS_PRINT_INFO 0x1000
80
81 //the following 3 flags are not completely implemented
82 //internal chrominace subsampling info
83 #define SWS_FULL_CHR_H_INT 0x2000
84 //input subsampling info
85 #define SWS_FULL_CHR_H_INP 0x4000
86 #define SWS_DIRECT_BGR 0x8000
87 #define SWS_ACCURATE_RND 0x40000
88 #define SWS_BITEXACT 0x80000
89
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
94 #define SWS_CPU_CAPS_BFIN 0x01000000
95
96 #define SWS_MAX_REDUCE_CUTOFF 0.002
97
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
105
106
107
108 // when used for filters they must have an odd number of elements
109 // coeffs cannot be shared between vectors
110 typedef struct {
111 double *coeff; ///< pointer to the list of coefficients
112 int length; ///< number of coefficients in the vector
113 } SwsVector;
114
115 // vectors can be shared
116 typedef struct {
117 SwsVector *lumH;
118 SwsVector *lumV;
119 SwsVector *chrH;
120 SwsVector *chrV;
121 } SwsFilter;
122
123 struct SwsContext;
124
125 /**
126 * Frees the swscaler context swsContext.
127 * If swsContext is NULL, then does nothing.
128 */
129 void sws_freeContext(struct SwsContext *swsContext);
130
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 */
144 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
145 int dstW, int dstH, enum PixelFormat dstFormat,
146 int flags, SwsFilter *srcFilter,
147 SwsFilter *dstFilter, const double *param);
148
149 /**
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
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.
157 *
158 * @param context the scaling context previously created with
159 * sws_getContext()
160 * @param srcSlice the array containing the pointers to the planes of
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 */
175 int sws_scale(struct SwsContext *context, uint8_t* srcSlice[], int srcStride[],
176 int srcSliceY, int srcSliceH, uint8_t* dst[], int dstStride[]);
177 #if LIBSWSCALE_VERSION_MAJOR < 1
178 /**
179 * @deprecated Use sws_scale() instead.
180 */
181 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[],
182 int srcStride[], int srcSliceY, int srcSliceH,
183 uint8_t* dst[], int dstStride[]) attribute_deprecated;
184 #endif
185
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 */
191 int 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);
194
195 /**
196 * @return -1 if not supported
197 */
198 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
199 int *srcRange, int **table, int *dstRange,
200 int *brightness, int *contrast, int *saturation);
201
202 /**
203 * Allocates and returns an uninitialized vector with length coefficients.
204 */
205 SwsVector *sws_allocVec(int length);
206
207 /**
208 * Returns a normalized Gaussian curve used to filter stuff
209 * quality=3 is high quality, lower is lower quality.
210 */
211 SwsVector *sws_getGaussianVec(double variance, double quality);
212
213 /**
214 * Allocates and returns a vector with length coefficients, all
215 * with the same value c.
216 */
217 SwsVector *sws_getConstVec(double c, int length);
218
219 /**
220 * Allocates and returns a vector with just one coefficient, with
221 * value 1.0.
222 */
223 SwsVector *sws_getIdentityVec(void);
224
225 /**
226 * Scales all the coefficients of a by the scalar value.
227 */
228 void sws_scaleVec(SwsVector *a, double scalar);
229
230 /**
231 * Scales all the coefficients of a so that their sum equals height.
232 */
233 void sws_normalizeVec(SwsVector *a, double height);
234 void sws_convVec(SwsVector *a, SwsVector *b);
235 void sws_addVec(SwsVector *a, SwsVector *b);
236 void sws_subVec(SwsVector *a, SwsVector *b);
237 void sws_shiftVec(SwsVector *a, int shift);
238
239 /**
240 * Allocates and returns a clone of the vector a, that is a vector
241 * with the same coefficients as a.
242 */
243 SwsVector *sws_cloneVec(SwsVector *a);
244
245 #if LIBSWSCALE_VERSION_MAJOR < 1
246 /**
247 * @deprecated Use sws_printVec2() instead.
248 */
249 attribute_deprecated void sws_printVec(SwsVector *a);
250 #endif
251
252 /**
253 * Prints with av_log() a textual representation of the vector a
254 * if log_level <= av_log_level.
255 */
256 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
257
258 void sws_freeVec(SwsVector *a);
259
260 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
261 float lumaSharpen, float chromaSharpen,
262 float chromaHShift, float chromaVShift,
263 int verbose);
264 void sws_freeFilter(SwsFilter *filter);
265
266 /**
267 * Checks if context can be reused, otherwise reallocates a new
268 * one.
269 *
270 * If context is NULL, just calls sws_getContext() to get a new
271 * context. Otherwise, checks if the parameters are the ones already
272 * saved in context. If that is the case, returns the current
273 * context. Otherwise, frees context and gets a new context with
274 * the new parameters.
275 *
276 * Be warned that srcFilter and dstFilter are not checked, they
277 * are assumed to remain the same.
278 */
279 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
280 int srcW, int srcH, enum PixelFormat srcFormat,
281 int dstW, int dstH, enum PixelFormat dstFormat,
282 int flags, SwsFilter *srcFilter,
283 SwsFilter *dstFilter, const double *param);
284
285 #endif /* SWSCALE_SWSCALE_H */