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