9a088af3fc87f527d95973c2f5a44f76ca1e82c2
[ffmpeg.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 1
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 /* values for the flags, the stuff on the command line is different */
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
63
64 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
65 #define SWS_SRC_V_CHR_DROP_SHIFT    16
66
67 #define SWS_PARAM_DEFAULT           123456
68
69 #define SWS_PRINT_INFO              0x1000
70
71 //the following 3 flags are not completely implemented
72 //internal chrominace subsampling info
73 #define SWS_FULL_CHR_H_INT    0x2000
74 //input subsampling info
75 #define SWS_FULL_CHR_H_INP    0x4000
76 #define SWS_DIRECT_BGR        0x8000
77 #define SWS_ACCURATE_RND      0x40000
78 #define SWS_BITEXACT          0x80000
79
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
84 #define SWS_CPU_CAPS_BFIN     0x01000000
85
86 #define SWS_MAX_REDUCE_CUTOFF 0.002
87
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
95
96
97
98 // when used for filters they must have an odd number of elements
99 // coeffs cannot be shared between vectors
100 typedef struct {
101     double *coeff;              ///< pointer to the list of coefficients
102     int length;                 ///< number of coefficients in the vector
103 } SwsVector;
104
105 // vectors can be shared
106 typedef struct {
107     SwsVector *lumH;
108     SwsVector *lumV;
109     SwsVector *chrH;
110     SwsVector *chrV;
111 } SwsFilter;
112
113 struct SwsContext;
114
115 /**
116  * Frees the swscaler context swsContext.
117  * If swsContext is NULL, then does nothing.
118  */
119 void sws_freeContext(struct SwsContext *swsContext);
120
121 /**
122  * Allocates and returns a SwsContext. You need it to perform
123  * scaling/conversion operations using sws_scale().
124  *
125  * @param srcW the width of the source image
126  * @param srcH the height of the source image
127  * @param srcFormat the source image format
128  * @param dstW the width of the destination image
129  * @param dstH the height of the destination image
130  * @param dstFormat the destination image format
131  * @param flags specify which algorithm and options to use for rescaling
132  * @return a pointer to an allocated context, or NULL in case of error
133  */
134 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
135                                   int dstW, int dstH, enum PixelFormat dstFormat,
136                                   int flags, SwsFilter *srcFilter,
137                                   SwsFilter *dstFilter, const double *param);
138
139 /**
140  * Scales the image slice in srcSlice and puts the resulting scaled
141  * slice in the image in dst. A slice is a sequence of consecutive
142  * rows in an image.
143  *
144  * Slices have to be provided in sequential order, either in
145  * top-bottom or bottom-top order. If slices are provided in
146  * non-sequential order the behavior of the function is undefined.
147  *
148  * @param context   the scaling context previously created with
149  *                  sws_getContext()
150  * @param srcSlice  the array containing the pointers to the planes of
151  *                  the source slice
152  * @param srcStride the array containing the strides for each plane of
153  *                  the source image
154  * @param srcSliceY the position in the source image of the slice to
155  *                  process, that is the number (counted starting from
156  *                  zero) in the image of the first row of the slice
157  * @param srcSliceH the height of the source slice, that is the number
158  *                  of rows in the slice
159  * @param dst       the array containing the pointers to the planes of
160  *                  the destination image
161  * @param dstStride the array containing the strides for each plane of
162  *                  the destination image
163  * @return          the height of the output slice
164  */
165 int sws_scale(struct SwsContext *context, uint8_t* srcSlice[], int srcStride[],
166               int srcSliceY, int srcSliceH, uint8_t* dst[], int dstStride[]);
167 #if LIBSWSCALE_VERSION_MAJOR < 1
168 /**
169  * @deprecated Use sws_scale() instead.
170  */
171 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[],
172                       int srcStride[], int srcSliceY, int srcSliceH,
173                       uint8_t* dst[], int dstStride[]) attribute_deprecated;
174 #endif
175
176 /**
177  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
178  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
179  * @return -1 if not supported
180  */
181 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
182                              int srcRange, const int table[4], int dstRange,
183                              int brightness, int contrast, int saturation);
184
185 /**
186  * @return -1 if not supported
187  */
188 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
189                              int *srcRange, int **table, int *dstRange,
190                              int *brightness, int *contrast, int *saturation);
191
192 /**
193  * Allocates and returns an uninitialized vector with length coefficients.
194  */
195 SwsVector *sws_allocVec(int length);
196
197 /**
198  * Returns a normalized Gaussian curve used to filter stuff
199  * quality=3 is high quality, lower is lower quality.
200  */
201 SwsVector *sws_getGaussianVec(double variance, double quality);
202
203 /**
204  * Allocates and returns a vector with length coefficients, all
205  * with the same value c.
206  */
207 SwsVector *sws_getConstVec(double c, int length);
208
209 /**
210  * Allocates and returns a vector with just one coefficient, with
211  * value 1.0.
212  */
213 SwsVector *sws_getIdentityVec(void);
214
215 /**
216  * Scales all the coefficients of a by the scalar value.
217  */
218 void sws_scaleVec(SwsVector *a, double scalar);
219
220 /**
221  * Scales all the coefficients of a so that their sum equals height.
222  */
223 void sws_normalizeVec(SwsVector *a, double height);
224 void sws_convVec(SwsVector *a, SwsVector *b);
225 void sws_addVec(SwsVector *a, SwsVector *b);
226 void sws_subVec(SwsVector *a, SwsVector *b);
227 void sws_shiftVec(SwsVector *a, int shift);
228
229 /**
230  * Allocates and returns a clone of the vector a, that is a vector
231  * with the same coefficients as a.
232  */
233 SwsVector *sws_cloneVec(SwsVector *a);
234
235 #if LIBSWSCALE_VERSION_MAJOR < 1
236 /**
237  * @deprecated Use sws_printVec2() instead.
238  */
239 attribute_deprecated void sws_printVec(SwsVector *a);
240 #endif
241
242 /**
243  * Prints with av_log() a textual representation of the vector a
244  * if log_level <= av_log_level.
245  */
246 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
247
248 void sws_freeVec(SwsVector *a);
249
250 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
251                                 float lumaSharpen, float chromaSharpen,
252                                 float chromaHShift, float chromaVShift,
253                                 int verbose);
254 void sws_freeFilter(SwsFilter *filter);
255
256 /**
257  * Checks if context can be reused, otherwise reallocates a new
258  * one.
259  *
260  * If context is NULL, just calls sws_getContext() to get a new
261  * context. Otherwise, checks if the parameters are the ones already
262  * saved in context. If that is the case, returns the current
263  * context. Otherwise, frees context and gets a new context with
264  * the new parameters.
265  *
266  * Be warned that srcFilter and dstFilter are not checked, they
267  * are assumed to remain the same.
268  */
269 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
270                                         int srcW, int srcH, enum PixelFormat srcFormat,
271                                         int dstW, int dstH, enum PixelFormat dstFormat,
272                                         int flags, SwsFilter *srcFilter,
273                                         SwsFilter *dstFilter, const double *param);
274
275 #endif /* SWSCALE_SWSCALE_H */