swscale.h 11.3 KB
Newer Older
1
/*
2 3 4 5
 * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
 *
 * This file is part of FFmpeg.
 *
6 7 8 9
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
10 11 12
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
15
 *
16 17
 * You should have received a copy of the GNU Lesser General Public
 * 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
 */
Arpi's avatar
Arpi committed
20

21 22
#ifndef SWSCALE_SWSCALE_H
#define SWSCALE_SWSCALE_H
23

24
/**
25
 * @file
26
 * @brief
27 28 29
 *     external api for the swscale stuff
 */

30
#include "libavutil/avutil.h"
31

32
#define LIBSWSCALE_VERSION_MAJOR 0
33
#define LIBSWSCALE_VERSION_MINOR 11
34
#define LIBSWSCALE_VERSION_MICRO 0
35

36 37 38 39 40 41
#define LIBSWSCALE_VERSION_INT  AV_VERSION_INT(LIBSWSCALE_VERSION_MAJOR, \
                                               LIBSWSCALE_VERSION_MINOR, \
                                               LIBSWSCALE_VERSION_MICRO)
#define LIBSWSCALE_VERSION      AV_VERSION(LIBSWSCALE_VERSION_MAJOR, \
                                           LIBSWSCALE_VERSION_MINOR, \
                                           LIBSWSCALE_VERSION_MICRO)
42 43 44 45
#define LIBSWSCALE_BUILD        LIBSWSCALE_VERSION_INT

#define LIBSWSCALE_IDENT        "SwS" AV_STRINGIFY(LIBSWSCALE_VERSION)

46
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
47
 * Returns the LIBSWSCALE_VERSION_INT constant.
48 49 50
 */
unsigned swscale_version(void);

51
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
52
 * Returns the libswscale build-time configuration.
53
 */
54
const char *swscale_configuration(void);
55 56

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
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 63 64 65 66 67 68 69 70 71 72
#define SWS_FAST_BILINEAR     1
#define SWS_BILINEAR          2
#define SWS_BICUBIC           4
#define SWS_X                 8
#define SWS_POINT          0x10
#define SWS_AREA           0x20
#define SWS_BICUBLIN       0x40
#define SWS_GAUSS          0x80
#define SWS_SINC          0x100
#define SWS_LANCZOS       0x200
#define SWS_SPLINE        0x400
73

74 75
#define SWS_SRC_V_CHR_DROP_MASK     0x30000
#define SWS_SRC_V_CHR_DROP_SHIFT    16
76

77
#define SWS_PARAM_DEFAULT           123456
Michael Niedermayer's avatar
Michael Niedermayer committed
78

79
#define SWS_PRINT_INFO              0x1000
Michael Niedermayer's avatar
Michael Niedermayer committed
80

Diego Biurrun's avatar
Diego Biurrun committed
81 82
//the following 3 flags are not completely implemented
//internal chrominace subsampling info
83
#define SWS_FULL_CHR_H_INT    0x2000
84
//input subsampling info
85 86 87
#define SWS_FULL_CHR_H_INP    0x4000
#define SWS_DIRECT_BGR        0x8000
#define SWS_ACCURATE_RND      0x40000
Michael Niedermayer's avatar
Michael Niedermayer committed
88
#define SWS_BITEXACT          0x80000
89

90 91 92 93
#define SWS_CPU_CAPS_MMX      0x80000000
#define SWS_CPU_CAPS_MMX2     0x20000000
#define SWS_CPU_CAPS_3DNOW    0x40000000
#define SWS_CPU_CAPS_ALTIVEC  0x10000000
94
#define SWS_CPU_CAPS_BFIN     0x01000000
Ramiro Polla's avatar
Ramiro Polla committed
95
#define SWS_CPU_CAPS_SSE2     0x02000000
96

97
#define SWS_MAX_REDUCE_CUTOFF 0.002
98

99 100 101 102 103 104 105
#define SWS_CS_ITU709         1
#define SWS_CS_FCC            4
#define SWS_CS_ITU601         5
#define SWS_CS_ITU624         5
#define SWS_CS_SMPTE170M      5
#define SWS_CS_SMPTE240M      7
#define SWS_CS_DEFAULT        5
106

107
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
108
 * Returns a pointer to yuv<->rgb coefficients for the given colorspace
109 110 111 112
 * suitable for sws_setColorspaceDetails().
 *
 * @param colorspace One of the SWS_CS_* macros. If invalid,
 * SWS_CS_DEFAULT is used.
113
 */
Stefano Sabatini's avatar
Stefano Sabatini committed
114
const int *sws_getCoefficients(int colorspace);
Michael Niedermayer's avatar
cleanup  
Michael Niedermayer committed
115

116

117 118
// when used for filters they must have an odd number of elements
// coeffs cannot be shared between vectors
119
typedef struct {
120 121
    double *coeff;              ///< pointer to the list of coefficients
    int length;                 ///< number of coefficients in the vector
122 123 124 125
} SwsVector;

// vectors can be shared
typedef struct {
126 127 128 129
    SwsVector *lumH;
    SwsVector *lumV;
    SwsVector *chrH;
    SwsVector *chrV;
130 131
} SwsFilter;

132
struct SwsContext;
133

134
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
135
 * Returns a positive value if pix_fmt is a supported input format, 0
136 137 138 139 140
 * otherwise.
 */
int sws_isSupportedInput(enum PixelFormat pix_fmt);

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
141
 * Returns a positive value if pix_fmt is a supported output format, 0
142 143 144 145
 * otherwise.
 */
int sws_isSupportedOutput(enum PixelFormat pix_fmt);

Stefano Sabatini's avatar
Stefano Sabatini committed
146
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
147 148
 * Frees the swscaler context swsContext.
 * If swsContext is NULL, then does nothing.
Stefano Sabatini's avatar
Stefano Sabatini committed
149
 */
150
void sws_freeContext(struct SwsContext *swsContext);
151

Stefano Sabatini's avatar
Stefano Sabatini committed
152
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
153
 * Allocates and returns a SwsContext. You need it to perform
Stefano Sabatini's avatar
Stefano Sabatini committed
154 155 156 157 158 159 160 161 162 163 164
 * scaling/conversion operations using sws_scale().
 *
 * @param srcW the width of the source image
 * @param srcH the height of the source image
 * @param srcFormat the source image format
 * @param dstW the width of the destination image
 * @param dstH the height of the destination image
 * @param dstFormat the destination image format
 * @param flags specify which algorithm and options to use for rescaling
 * @return a pointer to an allocated context, or NULL in case of error
 */
165 166 167
struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
                                  int dstW, int dstH, enum PixelFormat dstFormat,
                                  int flags, SwsFilter *srcFilter,
168
                                  SwsFilter *dstFilter, const double *param);
Stefano Sabatini's avatar
Stefano Sabatini committed
169 170

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
171
 * Scales the image slice in srcSlice and puts the resulting scaled
172
 * slice in the image in dst. A slice is a sequence of consecutive
173 174 175 176 177
 * rows in an image.
 *
 * Slices have to be provided in sequential order, either in
 * top-bottom or bottom-top order. If slices are provided in
 * non-sequential order the behavior of the function is undefined.
Stefano Sabatini's avatar
Stefano Sabatini committed
178 179 180
 *
 * @param context   the scaling context previously created with
 *                  sws_getContext()
181
 * @param srcSlice  the array containing the pointers to the planes of
Stefano Sabatini's avatar
Stefano Sabatini committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195
 *                  the source slice
 * @param srcStride the array containing the strides for each plane of
 *                  the source image
 * @param srcSliceY the position in the source image of the slice to
 *                  process, that is the number (counted starting from
 *                  zero) in the image of the first row of the slice
 * @param srcSliceH the height of the source slice, that is the number
 *                  of rows in the slice
 * @param dst       the array containing the pointers to the planes of
 *                  the destination image
 * @param dstStride the array containing the strides for each plane of
 *                  the destination image
 * @return          the height of the output slice
 */
196 197
int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
              int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
198

199
#if LIBSWSCALE_VERSION_MAJOR < 1
200 201 202
/**
 * @deprecated Use sws_scale() instead.
 */
203
int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
204 205
                      int srcStride[], int srcSliceY, int srcSliceH,
                      uint8_t* dst[], int dstStride[]) attribute_deprecated;
206
#endif
207

208 209 210 211 212
/**
 * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
 * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
 * @return -1 if not supported
 */
213 214 215
int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
                             int srcRange, const int table[4], int dstRange,
                             int brightness, int contrast, int saturation);
216 217 218 219

/**
 * @return -1 if not supported
 */
220 221 222
int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
                             int *srcRange, int **table, int *dstRange,
                             int *brightness, int *contrast, int *saturation);
223

224 225 226 227 228
/**
 * Allocates and returns an uninitialized vector with length coefficients.
 */
SwsVector *sws_allocVec(int length);

229
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
230
 * Returns a normalized Gaussian curve used to filter stuff
231 232
 * quality=3 is high quality, lower is lower quality.
 */
233
SwsVector *sws_getGaussianVec(double variance, double quality);
Stefano Sabatini's avatar
Stefano Sabatini committed
234 235

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
236
 * Allocates and returns a vector with length coefficients, all
237
 * with the same value c.
Stefano Sabatini's avatar
Stefano Sabatini committed
238
 */
239
SwsVector *sws_getConstVec(double c, int length);
240 241

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
242
 * Allocates and returns a vector with just one coefficient, with
243 244
 * value 1.0.
 */
245
SwsVector *sws_getIdentityVec(void);
Stefano Sabatini's avatar
Stefano Sabatini committed
246 247

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
248
 * Scales all the coefficients of a by the scalar value.
Stefano Sabatini's avatar
Stefano Sabatini committed
249
 */
250
void sws_scaleVec(SwsVector *a, double scalar);
251 252

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
253
 * Scales all the coefficients of a so that their sum equals height.
254
 */
255 256 257 258 259
void sws_normalizeVec(SwsVector *a, double height);
void sws_convVec(SwsVector *a, SwsVector *b);
void sws_addVec(SwsVector *a, SwsVector *b);
void sws_subVec(SwsVector *a, SwsVector *b);
void sws_shiftVec(SwsVector *a, int shift);
Stefano Sabatini's avatar
Stefano Sabatini committed
260 261

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
262
 * Allocates and returns a clone of the vector a, that is a vector
263
 * with the same coefficients as a.
Stefano Sabatini's avatar
Stefano Sabatini committed
264
 */
265 266
SwsVector *sws_cloneVec(SwsVector *a);

267 268 269 270 271 272 273 274
#if LIBSWSCALE_VERSION_MAJOR < 1
/**
 * @deprecated Use sws_printVec2() instead.
 */
attribute_deprecated void sws_printVec(SwsVector *a);
#endif

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
275
 * Prints with av_log() a textual representation of the vector a
276
 * if log_level <= av_log_level.
277 278 279
 */
void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);

280 281
void sws_freeVec(SwsVector *a);

282
SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
283
                                float lumaSharpen, float chromaSharpen,
284 285
                                float chromaHShift, float chromaVShift,
                                int verbose);
286 287
void sws_freeFilter(SwsFilter *filter);

288
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
289
 * Checks if context can be reused, otherwise reallocates a new
290
 * one.
291
 *
Stefano Sabatini's avatar
Stefano Sabatini committed
292 293 294 295
 * If context is NULL, just calls sws_getContext() to get a new
 * context. Otherwise, checks if the parameters are the ones already
 * saved in context. If that is the case, returns the current
 * context. Otherwise, frees context and gets a new context with
296 297
 * the new parameters.
 *
298
 * Be warned that srcFilter and dstFilter are not checked, they
299
 * are assumed to remain the same.
300
 */
301
struct SwsContext *sws_getCachedContext(struct SwsContext *context,
302
                                        int srcW, int srcH, enum PixelFormat srcFormat,
303 304
                                        int dstW, int dstH, enum PixelFormat dstFormat,
                                        int flags, SwsFilter *srcFilter,
305
                                        SwsFilter *dstFilter, const double *param);
306

307
/**
Stefano Sabatini's avatar
Stefano Sabatini committed
308
 * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
309 310 311 312 313 314 315 316 317 318 319
 *
 * The output frame will have the same packed format as the palette.
 *
 * @param src        source frame buffer
 * @param dst        destination frame buffer
 * @param num_pixels number of pixels to convert
 * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 */
void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);

/**
Stefano Sabatini's avatar
Stefano Sabatini committed
320
 * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
321 322 323 324 325 326 327 328 329 330 331
 *
 * With the palette format "ABCD", the destination frame ends up with the format "ABC".
 *
 * @param src        source frame buffer
 * @param dst        destination frame buffer
 * @param num_pixels number of pixels to convert
 * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 */
void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);


332
#endif /* SWSCALE_SWSCALE_H */