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

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