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