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
  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 12
  34 #define LIBSWSCALE_VERSION_MICRO 0
  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 #define SWS_CPU_CAPS_SSE2     0x02000000
  96
  97 #define SWS_MAX_REDUCE_CUTOFF 0.002
  98
  99 #define SWS_CS_ITU709         1
 100 #define SWS_CS_FCC            4
 101 #define SWS_CS_ITU601         5
 102 #define SWS_CS_ITU624         5
 103 #define SWS_CS_SMPTE170M      5
 104 #define SWS_CS_SMPTE240M      7
 105 #define SWS_CS_DEFAULT        5
 106
 107 /**
 108  * Returns a pointer to yuv<->rgb coefficients for the given colorspace
 109  * suitable for sws_setColorspaceDetails().
 110  *
 111  * @param colorspace One of the SWS_CS_* macros. If invalid,
 112  * SWS_CS_DEFAULT is used.
 113  */
 114 const int *sws_getCoefficients(int colorspace);
 115
 116
 117 // when used for filters they must have an odd number of elements
 118 // coeffs cannot be shared between vectors
 119 typedef struct {
 120     double *coeff;              ///< pointer to the list of coefficients
 121     int length;                 ///< number of coefficients in the vector
 122 } SwsVector;
 123
 124 // vectors can be shared
 125 typedef struct {
 126     SwsVector *lumH;
 127     SwsVector *lumV;
 128     SwsVector *chrH;
 129     SwsVector *chrV;
 130 } SwsFilter;
 131
 132 struct SwsContext;
 133
 134 /**
 135  * Returns a positive value if pix_fmt is a supported input format, 0
 136  * otherwise.
 137  */
 138 int sws_isSupportedInput(enum PixelFormat pix_fmt);
 139
 140 /**
 141  * Returns a positive value if pix_fmt is a supported output format, 0
 142  * otherwise.
 143  */
 144 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
 145
 146 /**
 147  * Allocates an empty SwsContext. This must be filled and passed to
 148  * sws_init_context(). For filling see AVOptions, options.c and
 149  * sws_setColorspaceDetails().
 150  */
 151 struct SwsContext *sws_alloc_context(void);
 152
 153 /**
 154  * Initializes the swscaler context sws_context.
 155  */
 156 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
 157
 158 /**
 159  * Frees the swscaler context swsContext.
 160  * If swsContext is NULL, then does nothing.
 161  */
 162 void sws_freeContext(struct SwsContext *swsContext);
 163
 164 /**
 165  * Allocates and returns a SwsContext. You need it to perform
 166  * scaling/conversion operations using sws_scale().
 167  *
 168  * @param srcW the width of the source image
 169  * @param srcH the height of the source image
 170  * @param srcFormat the source image format
 171  * @param dstW the width of the destination image
 172  * @param dstH the height of the destination image
 173  * @param dstFormat the destination image format
 174  * @param flags specify which algorithm and options to use for rescaling
 175  * @return a pointer to an allocated context, or NULL in case of error
 176  * @deprecated use sws_alloc_context() and sws_init_context()
 177  */
 178 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
 179                                   int dstW, int dstH, enum PixelFormat dstFormat,
 180                                   int flags, SwsFilter *srcFilter,
 181                                   SwsFilter *dstFilter, const double *param);
 182
 183 /**
 184  * Scales the image slice in srcSlice and puts the resulting scaled
 185  * slice in the image in dst. A slice is a sequence of consecutive
 186  * rows in an image.
 187  *
 188  * Slices have to be provided in sequential order, either in
 189  * top-bottom or bottom-top order. If slices are provided in
 190  * non-sequential order the behavior of the function is undefined.
 191  *
 192  * @param context   the scaling context previously created with
 193  *                  sws_getContext()
 194  * @param srcSlice  the array containing the pointers to the planes of
 195  *                  the source slice
 196  * @param srcStride the array containing the strides for each plane of
 197  *                  the source image
 198  * @param srcSliceY the position in the source image of the slice to
 199  *                  process, that is the number (counted starting from
 200  *                  zero) in the image of the first row of the slice
 201  * @param srcSliceH the height of the source slice, that is the number
 202  *                  of rows in the slice
 203  * @param dst       the array containing the pointers to the planes of
 204  *                  the destination image
 205  * @param dstStride the array containing the strides for each plane of
 206  *                  the destination image
 207  * @return          the height of the output slice
 208  */
 209 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
 210               int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
 211
 212 #if LIBSWSCALE_VERSION_MAJOR < 1
 213 /**
 214  * @deprecated Use sws_scale() instead.
 215  */
 216 int sws_scale_ordered(struct SwsContext *context, const uint8_t* const src[],
 217                       int srcStride[], int srcSliceY, int srcSliceH,
 218                       uint8_t* dst[], int dstStride[]) attribute_deprecated;
 219 #endif
 220
 221 /**
 222  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
 223  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
 224  * @return -1 if not supported
 225  */
 226 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
 227                              int srcRange, const int table[4], int dstRange,
 228                              int brightness, int contrast, int saturation);
 229
 230 /**
 231  * @return -1 if not supported
 232  */
 233 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
 234                              int *srcRange, int **table, int *dstRange,
 235                              int *brightness, int *contrast, int *saturation);
 236
 237 /**
 238  * Allocates and returns an uninitialized vector with length coefficients.
 239  */
 240 SwsVector *sws_allocVec(int length);
 241
 242 /**
 243  * Returns a normalized Gaussian curve used to filter stuff
 244  * quality=3 is high quality, lower is lower quality.
 245  */
 246 SwsVector *sws_getGaussianVec(double variance, double quality);
 247
 248 /**
 249  * Allocates and returns a vector with length coefficients, all
 250  * with the same value c.
 251  */
 252 SwsVector *sws_getConstVec(double c, int length);
 253
 254 /**
 255  * Allocates and returns a vector with just one coefficient, with
 256  * value 1.0.
 257  */
 258 SwsVector *sws_getIdentityVec(void);
 259
 260 /**
 261  * Scales all the coefficients of a by the scalar value.
 262  */
 263 void sws_scaleVec(SwsVector *a, double scalar);
 264
 265 /**
 266  * Scales all the coefficients of a so that their sum equals height.
 267  */
 268 void sws_normalizeVec(SwsVector *a, double height);
 269 void sws_convVec(SwsVector *a, SwsVector *b);
 270 void sws_addVec(SwsVector *a, SwsVector *b);
 271 void sws_subVec(SwsVector *a, SwsVector *b);
 272 void sws_shiftVec(SwsVector *a, int shift);
 273
 274 /**
 275  * Allocates and returns a clone of the vector a, that is a vector
 276  * with the same coefficients as a.
 277  */
 278 SwsVector *sws_cloneVec(SwsVector *a);
 279
 280 #if LIBSWSCALE_VERSION_MAJOR < 1
 281 /**
 282  * @deprecated Use sws_printVec2() instead.
 283  */
 284 attribute_deprecated void sws_printVec(SwsVector *a);
 285 #endif
 286
 287 /**
 288  * Prints with av_log() a textual representation of the vector a
 289  * if log_level <= av_log_level.
 290  */
 291 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
 292
 293 void sws_freeVec(SwsVector *a);
 294
 295 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
 296                                 float lumaSharpen, float chromaSharpen,
 297                                 float chromaHShift, float chromaVShift,
 298                                 int verbose);
 299 void sws_freeFilter(SwsFilter *filter);
 300
 301 /**
 302  * Checks if context can be reused, otherwise reallocates a new
 303  * one.
 304  *
 305  * If context is NULL, just calls sws_getContext() to get a new
 306  * context. Otherwise, checks if the parameters are the ones already
 307  * saved in context. If that is the case, returns the current
 308  * context. Otherwise, frees context and gets a new context with
 309  * the new parameters.
 310  *
 311  * Be warned that srcFilter and dstFilter are not checked, they
 312  * are assumed to remain the same.
 313  */
 314 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
 315                                         int srcW, int srcH, enum PixelFormat srcFormat,
 316                                         int dstW, int dstH, enum PixelFormat dstFormat,
 317                                         int flags, SwsFilter *srcFilter,
 318                                         SwsFilter *dstFilter, const double *param);
 319
 320 /**
 321  * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
 322  *
 323  * The output frame will have the same packed format as the palette.
 324  *
 325  * @param src        source frame buffer
 326  * @param dst        destination frame buffer
 327  * @param num_pixels number of pixels to convert
 328  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 329  */
 330 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
 331
 332 /**
 333  * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
 334  *
 335  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
 336  *
 337  * @param src        source frame buffer
 338  * @param dst        destination frame buffer
 339  * @param num_pixels number of pixels to convert
 340  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 341  */
 342 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, long num_pixels, const uint8_t *palette);
 343
 344
 345 #endif /* SWSCALE_SWSCALE_H */