Statistics
| Branch: | Revision:

ffmpeg / libswscale / swscale.h @ 22b6a24c

History | View | Annotate | Download (10.3 KB)

1 fe8054c0 Michael Niedermayer
/*
2 d026b45e Diego Biurrun
 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
3
 *
4
 * This file is part of FFmpeg.
5
 *
6 807e0c66 Luca Abeni
 * 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 d026b45e Diego Biurrun
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 807e0c66 Luca Abeni
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15 d026b45e Diego Biurrun
 *
16 807e0c66 Luca Abeni
 * 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 b19bcbaa Diego Biurrun
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 d026b45e Diego Biurrun
 */
20 3db822b0 Arpi
21 0eaf5235 Stefano Sabatini
#ifndef SWSCALE_SWSCALE_H
22
#define SWSCALE_SWSCALE_H
23 5427e242 Michael Niedermayer
24 d4e24275 Michael Niedermayer
/**
25 82aaa790 Diego Biurrun
 * @file libswscale/swscale.h
26 6a4970ab Diego Biurrun
 * @brief
27 d4e24275 Michael Niedermayer
 *     external api for the swscale stuff
28
 */
29
30 88517699 Måns Rullgård
#include "libavutil/avutil.h"
31 d28ef270 Luca Abeni
32 e08e6bb6 Måns Rullgård
#define LIBSWSCALE_VERSION_MAJOR 0
33 3f3dc76c David Conrad
#define LIBSWSCALE_VERSION_MINOR 10
34 8e9767f6 Stefano Sabatini
#define LIBSWSCALE_VERSION_MICRO 0
35 ccf95ef1 Måns Rullgård
36 e08e6bb6 Måns Rullgård
#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 94c4def2 Luca Abeni
#define LIBSWSCALE_BUILD        LIBSWSCALE_VERSION_INT
43
44
#define LIBSWSCALE_IDENT        "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)
45
46 b3e03fa7 Stefano Sabatini
/**
47
 * Returns the LIBSWSCALE_VERSION_INT constant.
48
 */
49
unsigned swscale_version(void);
50
51 bd381fd3 Diego Biurrun
/**
52
 * Returns the libswscale build-time configuration.
53
 */
54 997980f0 Stefano Sabatini
const char *swscale_configuration(void);
55 bd381fd3 Diego Biurrun
56
/**
57
 * Returns the libswscale license.
58
 */
59 997980f0 Stefano Sabatini
const char *swscale_license(void);
60 bd381fd3 Diego Biurrun
61 28bf81c9 Michael Niedermayer
/* values for the flags, the stuff on the command line is different */
62 221b804f Diego Biurrun
#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 1e621b18 Michael Niedermayer
74 221b804f Diego Biurrun
#define SWS_SRC_V_CHR_DROP_MASK     0x30000
75
#define SWS_SRC_V_CHR_DROP_SHIFT    16
76 5859233b Michael Niedermayer
77 221b804f Diego Biurrun
#define SWS_PARAM_DEFAULT           123456
78 a86c461c Michael Niedermayer
79 221b804f Diego Biurrun
#define SWS_PRINT_INFO              0x1000
80 a86c461c Michael Niedermayer
81 86bdf3fd Diego Biurrun
//the following 3 flags are not completely implemented
82
//internal chrominace subsampling info
83 221b804f Diego Biurrun
#define SWS_FULL_CHR_H_INT    0x2000
84 1e621b18 Michael Niedermayer
//input subsampling info
85 221b804f Diego Biurrun
#define SWS_FULL_CHR_H_INP    0x4000
86
#define SWS_DIRECT_BGR        0x8000
87
#define SWS_ACCURATE_RND      0x40000
88 ceb700ba Michael Niedermayer
#define SWS_BITEXACT          0x80000
89 1e621b18 Michael Niedermayer
90 221b804f Diego Biurrun
#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 d3f3eea9 Marc Hoffman
#define SWS_CPU_CAPS_BFIN     0x01000000
95 516b1f82 Michael Niedermayer
96 c7f822d9 Michael Niedermayer
#define SWS_MAX_REDUCE_CUTOFF 0.002
97 28bf81c9 Michael Niedermayer
98 221b804f Diego Biurrun
#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 0481412a Michael Niedermayer
106 3f3dc76c David Conrad
/**
107
 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
108 fbc0f6a9 Stefano Sabatini
 * suitable for sws_setColorspaceDetails().
109
 *
110
 * @param colorspace One of the SWS_CS_* macros. If invalid,
111
 * SWS_CS_DEFAULT is used.
112 3f3dc76c David Conrad
 */
113 89ee5c68 Stefano Sabatini
const int *sws_getCoefficients(int colorspace);
114 77a49659 Michael Niedermayer
115 28bf81c9 Michael Niedermayer
116 c7f822d9 Michael Niedermayer
// when used for filters they must have an odd number of elements
117
// coeffs cannot be shared between vectors
118 28bf81c9 Michael Niedermayer
typedef struct {
119 edbdf77e Stefano Sabatini
    double *coeff;              ///< pointer to the list of coefficients
120
    int length;                 ///< number of coefficients in the vector
121 c7f822d9 Michael Niedermayer
} SwsVector;
122
123
// vectors can be shared
124
typedef struct {
125 221b804f Diego Biurrun
    SwsVector *lumH;
126
    SwsVector *lumV;
127
    SwsVector *chrH;
128
    SwsVector *chrV;
129 28bf81c9 Michael Niedermayer
} SwsFilter;
130
131 d4e24275 Michael Niedermayer
struct SwsContext;
132 077ea8a7 Michael Niedermayer
133 2e0a80a1 Stefano Sabatini
/**
134 8e9767f6 Stefano Sabatini
 * Returns a positive value if pix_fmt is a supported input format, 0
135
 * otherwise.
136
 */
137
int sws_isSupportedInput(enum PixelFormat pix_fmt);
138
139
/**
140
 * Returns a positive value if pix_fmt is a supported output format, 0
141
 * otherwise.
142
 */
143
int sws_isSupportedOutput(enum PixelFormat pix_fmt);
144
145
/**
146 2e0a80a1 Stefano Sabatini
 * Frees the swscaler context swsContext.
147
 * If swsContext is NULL, then does nothing.
148
 */
149 d4e24275 Michael Niedermayer
void sws_freeContext(struct SwsContext *swsContext);
150 28bf81c9 Michael Niedermayer
151 a1588654 Stefano Sabatini
/**
152
 * Allocates and returns a SwsContext. You need it to perform
153
 * scaling/conversion operations using sws_scale().
154
 *
155
 * @param srcW the width of the source image
156
 * @param srcH the height of the source image
157
 * @param srcFormat the source image format
158
 * @param dstW the width of the destination image
159
 * @param dstH the height of the destination image
160
 * @param dstFormat the destination image format
161
 * @param flags specify which algorithm and options to use for rescaling
162
 * @return a pointer to an allocated context, or NULL in case of error
163
 */
164 d648c720 Diego Biurrun
struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
165
                                  int dstW, int dstH, enum PixelFormat dstFormat,
166
                                  int flags, SwsFilter *srcFilter,
167 0020c54c Diego Biurrun
                                  SwsFilter *dstFilter, const double *param);
168 583799c4 Stefano Sabatini
169
/**
170 532ec283 Stefano Sabatini
 * Scales the image slice in srcSlice and puts the resulting scaled
171
 * slice in the image in dst. A slice is a sequence of consecutive
172 a520e9f2 Stefano Sabatini
 * rows in an image.
173
 *
174
 * Slices have to be provided in sequential order, either in
175
 * top-bottom or bottom-top order. If slices are provided in
176
 * non-sequential order the behavior of the function is undefined.
177 583799c4 Stefano Sabatini
 *
178
 * @param context   the scaling context previously created with
179
 *                  sws_getContext()
180 15239b7f Stefano Sabatini
 * @param srcSlice  the array containing the pointers to the planes of
181 583799c4 Stefano Sabatini
 *                  the source slice
182
 * @param srcStride the array containing the strides for each plane of
183
 *                  the source image
184
 * @param srcSliceY the position in the source image of the slice to
185
 *                  process, that is the number (counted starting from
186
 *                  zero) in the image of the first row of the slice
187
 * @param srcSliceH the height of the source slice, that is the number
188
 *                  of rows in the slice
189
 * @param dst       the array containing the pointers to the planes of
190
 *                  the destination image
191
 * @param dstStride the array containing the strides for each plane of
192
 *                  the destination image
193
 * @return          the height of the output slice
194
 */
195 01cc47dc David Conrad
int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
196
              int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
197 c099766f Stefano Sabatini
#if LIBSWSCALE_VERSION_MAJOR < 1
198 1eeded39 Stefano Sabatini
/**
199
 * @deprecated Use sws_scale() instead.
200
 */
201 f28cc577 Alexis Ballier
int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
202 d648c720 Diego Biurrun
                      int srcStride[], int srcSliceY, int srcSliceH,
203
                      uint8_t* dst[], int dstStride[]) attribute_deprecated;
204 c099766f Stefano Sabatini
#endif
205 d4e24275 Michael Niedermayer
206 2d26fa28 Stefano Sabatini
/**
207
 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
208
 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
209
 * @return -1 if not supported
210
 */
211 d648c720 Diego Biurrun
int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
212
                             int srcRange, const int table[4], int dstRange,
213
                             int brightness, int contrast, int saturation);
214 2d26fa28 Stefano Sabatini
215
/**
216
 * @return -1 if not supported
217
 */
218 d648c720 Diego Biurrun
int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
219
                             int *srcRange, int **table, int *dstRange,
220
                             int *brightness, int *contrast, int *saturation);
221 6d3cf67c Stefano Sabatini
222
/**
223 1aff375d Ramiro Polla
 * Allocates and returns an uninitialized vector with length coefficients.
224
 */
225
SwsVector *sws_allocVec(int length);
226
227
/**
228 6d3cf67c Stefano Sabatini
 * Returns a normalized Gaussian curve used to filter stuff
229
 * quality=3 is high quality, lower is lower quality.
230
 */
231 d4e24275 Michael Niedermayer
SwsVector *sws_getGaussianVec(double variance, double quality);
232 c326825e Stefano Sabatini
233
/**
234 532ec283 Stefano Sabatini
 * Allocates and returns a vector with length coefficients, all
235
 * with the same value c.
236 c326825e Stefano Sabatini
 */
237 d4e24275 Michael Niedermayer
SwsVector *sws_getConstVec(double c, int length);
238 b5fdaebb Stefano Sabatini
239
/**
240
 * Allocates and returns a vector with just one coefficient, with
241
 * value 1.0.
242
 */
243 d4e24275 Michael Niedermayer
SwsVector *sws_getIdentityVec(void);
244 0bcb5b39 Stefano Sabatini
245
/**
246 532ec283 Stefano Sabatini
 * Scales all the coefficients of a by the scalar value.
247 0bcb5b39 Stefano Sabatini
 */
248 d4e24275 Michael Niedermayer
void sws_scaleVec(SwsVector *a, double scalar);
249 a26b51cd Stefano Sabatini
250
/**
251 532ec283 Stefano Sabatini
 * Scales all the coefficients of a so that their sum equals height.
252 a26b51cd Stefano Sabatini
 */
253 d4e24275 Michael Niedermayer
void sws_normalizeVec(SwsVector *a, double height);
254
void sws_convVec(SwsVector *a, SwsVector *b);
255
void sws_addVec(SwsVector *a, SwsVector *b);
256
void sws_subVec(SwsVector *a, SwsVector *b);
257
void sws_shiftVec(SwsVector *a, int shift);
258 89b74647 Stefano Sabatini
259
/**
260 532ec283 Stefano Sabatini
 * Allocates and returns a clone of the vector a, that is a vector
261
 * with the same coefficients as a.
262 89b74647 Stefano Sabatini
 */
263 d4e24275 Michael Niedermayer
SwsVector *sws_cloneVec(SwsVector *a);
264
265 26b40a65 Stefano Sabatini
#if LIBSWSCALE_VERSION_MAJOR < 1
266
/**
267
 * @deprecated Use sws_printVec2() instead.
268
 */
269
attribute_deprecated void sws_printVec(SwsVector *a);
270
#endif
271
272
/**
273 532ec283 Stefano Sabatini
 * Prints with av_log() a textual representation of the vector a
274
 * if log_level <= av_log_level.
275 26b40a65 Stefano Sabatini
 */
276
void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
277
278 d4e24275 Michael Niedermayer
void sws_freeVec(SwsVector *a);
279
280 6a4970ab Diego Biurrun
SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
281 b534f73d Stefano Sabatini
                                float lumaSharpen, float chromaSharpen,
282 221b804f Diego Biurrun
                                float chromaHShift, float chromaVShift,
283
                                int verbose);
284 e21206a8 Michael Niedermayer
void sws_freeFilter(SwsFilter *filter);
285
286 b954b34a Stefano Sabatini
/**
287 532ec283 Stefano Sabatini
 * Checks if context can be reused, otherwise reallocates a new
288 39e80e6c Stefano Sabatini
 * one.
289 b954b34a Stefano Sabatini
 *
290 532ec283 Stefano Sabatini
 * If context is NULL, just calls sws_getContext() to get a new
291 39e80e6c Stefano Sabatini
 * context. Otherwise, checks if the parameters are the ones already
292 532ec283 Stefano Sabatini
 * saved in context. If that is the case, returns the current
293
 * context. Otherwise, frees context and gets a new context with
294 39e80e6c Stefano Sabatini
 * the new parameters.
295
 *
296 532ec283 Stefano Sabatini
 * Be warned that srcFilter and dstFilter are not checked, they
297 39e80e6c Stefano Sabatini
 * are assumed to remain the same.
298 b954b34a Stefano Sabatini
 */
299 22e46959 Víctor Paesa
struct SwsContext *sws_getCachedContext(struct SwsContext *context,
300 96b27045 Stefano Sabatini
                                        int srcW, int srcH, enum PixelFormat srcFormat,
301 d648c720 Diego Biurrun
                                        int dstW, int dstH, enum PixelFormat dstFormat,
302
                                        int flags, SwsFilter *srcFilter,
303 0020c54c Diego Biurrun
                                        SwsFilter *dstFilter, const double *param);
304 22e46959 Víctor Paesa
305 0eaf5235 Stefano Sabatini
#endif /* SWSCALE_SWSCALE_H */