git.sesse.net Git - ffmpeg/blob - libswscale/swscale.h

   1 /*
   2  * Copyright (C) 2001-2003 Michael Niedermayer <michaelni@gmx.at>
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; 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 1
  33 #define LIBSWSCALE_VERSION_MINOR 1
  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  * Those FF_API_* defines are not part of public API.
  48  * They may change, break or disappear at any time.
  49  */
  50 #ifndef FF_API_SWS_GETCONTEXT
  51 #define FF_API_SWS_GETCONTEXT  (LIBSWSCALE_VERSION_MAJOR < 2)
  52 #endif
  53 #ifndef FF_API_SWS_CPU_CAPS
  54 #define FF_API_SWS_CPU_CAPS    (LIBSWSCALE_VERSION_MAJOR < 2)
  55 #endif
  56
  57 /**
  58  * Returns the LIBSWSCALE_VERSION_INT constant.
  59  */
  60 unsigned swscale_version(void);
  61
  62 /**
  63  * Returns the libswscale build-time configuration.
  64  */
  65 const char *swscale_configuration(void);
  66
  67 /**
  68  * Returns the libswscale license.
  69  */
  70 const char *swscale_license(void);
  71
  72 /* values for the flags, the stuff on the command line is different */
  73 #define SWS_FAST_BILINEAR     1
  74 #define SWS_BILINEAR          2
  75 #define SWS_BICUBIC           4
  76 #define SWS_X                 8
  77 #define SWS_POINT          0x10
  78 #define SWS_AREA           0x20
  79 #define SWS_BICUBLIN       0x40
  80 #define SWS_GAUSS          0x80
  81 #define SWS_SINC          0x100
  82 #define SWS_LANCZOS       0x200
  83 #define SWS_SPLINE        0x400
  84
  85 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
  86 #define SWS_SRC_V_CHR_DROP_SHIFT    16
  87
  88 #define SWS_PARAM_DEFAULT           123456
  89
  90 #define SWS_PRINT_INFO              0x1000
  91
  92 //the following 3 flags are not completely implemented
  93 //internal chrominace subsampling info
  94 #define SWS_FULL_CHR_H_INT    0x2000
  95 //input subsampling info
  96 #define SWS_FULL_CHR_H_INP    0x4000
  97 #define SWS_DIRECT_BGR        0x8000
  98 #define SWS_ACCURATE_RND      0x40000
  99 #define SWS_BITEXACT          0x80000
 100
 101 #if FF_API_SWS_CPU_CAPS
 102 /**
 103  * CPU caps are autodetected now, those flags
 104  * are only provided for API compatibility.
 105  */
 106 #define SWS_CPU_CAPS_MMX      0x80000000
 107 #define SWS_CPU_CAPS_MMX2     0x20000000
 108 #define SWS_CPU_CAPS_3DNOW    0x40000000
 109 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
 110 #define SWS_CPU_CAPS_BFIN     0x01000000
 111 #define SWS_CPU_CAPS_SSE2     0x02000000
 112 #endif
 113
 114 #define SWS_MAX_REDUCE_CUTOFF 0.002
 115
 116 #define SWS_CS_ITU709         1
 117 #define SWS_CS_FCC            4
 118 #define SWS_CS_ITU601         5
 119 #define SWS_CS_ITU624         5
 120 #define SWS_CS_SMPTE170M      5
 121 #define SWS_CS_SMPTE240M      7
 122 #define SWS_CS_DEFAULT        5
 123
 124 /**
 125  * Returns a pointer to yuv<->rgb coefficients for the given colorspace
 126  * suitable for sws_setColorspaceDetails().
 127  *
 128  * @param colorspace One of the SWS_CS_* macros. If invalid,
 129  * SWS_CS_DEFAULT is used.
 130  */
 131 const int *sws_getCoefficients(int colorspace);
 132
 133
 134 // when used for filters they must have an odd number of elements
 135 // coeffs cannot be shared between vectors
 136 typedef struct {
 137     double *coeff;              ///< pointer to the list of coefficients
 138     int length;                 ///< number of coefficients in the vector
 139 } SwsVector;
 140
 141 // vectors can be shared
 142 typedef struct {
 143     SwsVector *lumH;
 144     SwsVector *lumV;
 145     SwsVector *chrH;
 146     SwsVector *chrV;
 147 } SwsFilter;
 148
 149 struct SwsContext;
 150
 151 /**
 152  * Returns a positive value if pix_fmt is a supported input format, 0
 153  * otherwise.
 154  */
 155 int sws_isSupportedInput(enum PixelFormat pix_fmt);
 156
 157 /**
 158  * Returns a positive value if pix_fmt is a supported output format, 0
 159  * otherwise.
 160  */
 161 int sws_isSupportedOutput(enum PixelFormat pix_fmt);
 162
 163 /**
 164  * Allocates an empty SwsContext. This must be filled and passed to
 165  * sws_init_context(). For filling see AVOptions, options.c and
 166  * sws_setColorspaceDetails().
 167  */
 168 struct SwsContext *sws_alloc_context(void);
 169
 170 /**
 171  * Initializes the swscaler context sws_context.
 172  *
 173  * @return zero or positive value on success, a negative value on
 174  * error
 175  */
 176 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
 177
 178 /**
 179  * Frees the swscaler context swsContext.
 180  * If swsContext is NULL, then does nothing.
 181  */
 182 void sws_freeContext(struct SwsContext *swsContext);
 183
 184 #if FF_API_SWS_GETCONTEXT
 185 /**
 186  * Allocates and returns a SwsContext. You need it to perform
 187  * scaling/conversion operations using sws_scale().
 188  *
 189  * @param srcW the width of the source image
 190  * @param srcH the height of the source image
 191  * @param srcFormat the source image format
 192  * @param dstW the width of the destination image
 193  * @param dstH the height of the destination image
 194  * @param dstFormat the destination image format
 195  * @param flags specify which algorithm and options to use for rescaling
 196  * @return a pointer to an allocated context, or NULL in case of error
 197  * @note this function is to be removed after a saner alternative is
 198  *       written
 199  * @deprecated Use sws_getCachedContext() instead.
 200  */
 201 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
 202                                   int dstW, int dstH, enum PixelFormat dstFormat,
 203                                   int flags, SwsFilter *srcFilter,
 204                                   SwsFilter *dstFilter, const double *param);
 205 #endif
 206
 207 /**
 208  * Scales the image slice in srcSlice and puts the resulting scaled
 209  * slice in the image in dst. A slice is a sequence of consecutive
 210  * rows in an image.
 211  *
 212  * Slices have to be provided in sequential order, either in
 213  * top-bottom or bottom-top order. If slices are provided in
 214  * non-sequential order the behavior of the function is undefined.
 215  *
 216  * @param context   the scaling context previously created with
 217  *                  sws_getContext()
 218  * @param srcSlice  the array containing the pointers to the planes of
 219  *                  the source slice
 220  * @param srcStride the array containing the strides for each plane of
 221  *                  the source image
 222  * @param srcSliceY the position in the source image of the slice to
 223  *                  process, that is the number (counted starting from
 224  *                  zero) in the image of the first row of the slice
 225  * @param srcSliceH the height of the source slice, that is the number
 226  *                  of rows in the slice
 227  * @param dst       the array containing the pointers to the planes of
 228  *                  the destination image
 229  * @param dstStride the array containing the strides for each plane of
 230  *                  the destination image
 231  * @return          the height of the output slice
 232  */
 233 int sws_scale(struct SwsContext *context, const uint8_t* const srcSlice[], const int srcStride[],
 234               int srcSliceY, int srcSliceH, uint8_t* const dst[], const int dstStride[]);
 235
 236 /**
 237  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
 238  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
 239  * @return -1 if not supported
 240  */
 241 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
 242                              int srcRange, const int table[4], int dstRange,
 243                              int brightness, int contrast, int saturation);
 244
 245 /**
 246  * @return -1 if not supported
 247  */
 248 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
 249                              int *srcRange, int **table, int *dstRange,
 250                              int *brightness, int *contrast, int *saturation);
 251
 252 /**
 253  * Allocates and returns an uninitialized vector with length coefficients.
 254  */
 255 SwsVector *sws_allocVec(int length);
 256
 257 /**
 258  * Returns a normalized Gaussian curve used to filter stuff
 259  * quality=3 is high quality, lower is lower quality.
 260  */
 261 SwsVector *sws_getGaussianVec(double variance, double quality);
 262
 263 /**
 264  * Allocates and returns a vector with length coefficients, all
 265  * with the same value c.
 266  */
 267 SwsVector *sws_getConstVec(double c, int length);
 268
 269 /**
 270  * Allocates and returns a vector with just one coefficient, with
 271  * value 1.0.
 272  */
 273 SwsVector *sws_getIdentityVec(void);
 274
 275 /**
 276  * Scales all the coefficients of a by the scalar value.
 277  */
 278 void sws_scaleVec(SwsVector *a, double scalar);
 279
 280 /**
 281  * Scales all the coefficients of a so that their sum equals height.
 282  */
 283 void sws_normalizeVec(SwsVector *a, double height);
 284 void sws_convVec(SwsVector *a, SwsVector *b);
 285 void sws_addVec(SwsVector *a, SwsVector *b);
 286 void sws_subVec(SwsVector *a, SwsVector *b);
 287 void sws_shiftVec(SwsVector *a, int shift);
 288
 289 /**
 290  * Allocates and returns a clone of the vector a, that is a vector
 291  * with the same coefficients as a.
 292  */
 293 SwsVector *sws_cloneVec(SwsVector *a);
 294
 295 /**
 296  * Prints with av_log() a textual representation of the vector a
 297  * if log_level <= av_log_level.
 298  */
 299 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
 300
 301 void sws_freeVec(SwsVector *a);
 302
 303 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
 304                                 float lumaSharpen, float chromaSharpen,
 305                                 float chromaHShift, float chromaVShift,
 306                                 int verbose);
 307 void sws_freeFilter(SwsFilter *filter);
 308
 309 /**
 310  * Checks if context can be reused, otherwise reallocates a new
 311  * one.
 312  *
 313  * If context is NULL, just calls sws_getContext() to get a new
 314  * context. Otherwise, checks if the parameters are the ones already
 315  * saved in context. If that is the case, returns the current
 316  * context. Otherwise, frees context and gets a new context with
 317  * the new parameters.
 318  *
 319  * Be warned that srcFilter and dstFilter are not checked, they
 320  * are assumed to remain the same.
 321  */
 322 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
 323                                         int srcW, int srcH, enum PixelFormat srcFormat,
 324                                         int dstW, int dstH, enum PixelFormat dstFormat,
 325                                         int flags, SwsFilter *srcFilter,
 326                                         SwsFilter *dstFilter, const double *param);
 327
 328 /**
 329  * Converts an 8bit paletted frame into a frame with a color depth of 32-bits.
 330  *
 331  * The output frame will have the same packed format as the palette.
 332  *
 333  * @param src        source frame buffer
 334  * @param dst        destination frame buffer
 335  * @param num_pixels number of pixels to convert
 336  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 337  */
 338 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
 339
 340 /**
 341  * Converts an 8bit paletted frame into a frame with a color depth of 24 bits.
 342  *
 343  * With the palette format "ABCD", the destination frame ends up with the format "ABC".
 344  *
 345  * @param src        source frame buffer
 346  * @param dst        destination frame buffer
 347  * @param num_pixels number of pixels to convert
 348  * @param palette    array with [256] entries, which must match color arrangement (RGB or BGR) of src
 349  */
 350 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
 351
 352
 353 #endif /* SWSCALE_SWSCALE_H */