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 libswscale/swscale.h
  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 7
  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  * Returns the LIBSWSCALE_VERSION_INT constant.
  48  */
  49 unsigned swscale_version(void);
  50
  51 /* values for the flags, the stuff on the command line is different */
  52 #define SWS_FAST_BILINEAR     1
  53 #define SWS_BILINEAR          2
  54 #define SWS_BICUBIC           4
  55 #define SWS_X                 8
  56 #define SWS_POINT          0x10
  57 #define SWS_AREA           0x20
  58 #define SWS_BICUBLIN       0x40
  59 #define SWS_GAUSS          0x80
  60 #define SWS_SINC          0x100
  61 #define SWS_LANCZOS       0x200
  62 #define SWS_SPLINE        0x400
  63
  64 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
  65 #define SWS_SRC_V_CHR_DROP_SHIFT    16
  66
  67 #define SWS_PARAM_DEFAULT           123456
  68
  69 #define SWS_PRINT_INFO              0x1000
  70
  71 //the following 3 flags are not completely implemented
  72 //internal chrominace subsampling info
  73 #define SWS_FULL_CHR_H_INT    0x2000
  74 //input subsampling info
  75 #define SWS_FULL_CHR_H_INP    0x4000
  76 #define SWS_DIRECT_BGR        0x8000
  77 #define SWS_ACCURATE_RND      0x40000
  78 #define SWS_BITEXACT          0x80000
  79
  80 #define SWS_CPU_CAPS_MMX      0x80000000
  81 #define SWS_CPU_CAPS_MMX2     0x20000000
  82 #define SWS_CPU_CAPS_3DNOW    0x40000000
  83 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
  84 #define SWS_CPU_CAPS_BFIN     0x01000000
  85
  86 #define SWS_MAX_REDUCE_CUTOFF 0.002
  87
  88 #define SWS_CS_ITU709         1
  89 #define SWS_CS_FCC            4
  90 #define SWS_CS_ITU601         5
  91 #define SWS_CS_ITU624         5
  92 #define SWS_CS_SMPTE170M      5
  93 #define SWS_CS_SMPTE240M      7
  94 #define SWS_CS_DEFAULT        5
  95
  96
  97
  98 // when used for filters they must have an odd number of elements
  99 // coeffs cannot be shared between vectors
 100 typedef struct {
 101     double *coeff;              ///< pointer to the list of coefficients
 102     int length;                 ///< number of coefficients in the vector
 103 } SwsVector;
 104
 105 // vectors can be shared
 106 typedef struct {
 107     SwsVector *lumH;
 108     SwsVector *lumV;
 109     SwsVector *chrH;
 110     SwsVector *chrV;
 111 } SwsFilter;
 112
 113 struct SwsContext;
 114
 115 void sws_freeContext(struct SwsContext *swsContext);
 116
 117 /**
 118  * Allocates and returns a SwsContext. You need it to perform
 119  * scaling/conversion operations using sws_scale().
 120  *
 121  * @param srcW the width of the source image
 122  * @param srcH the height of the source image
 123  * @param srcFormat the source image format
 124  * @param dstW the width of the destination image
 125  * @param dstH the height of the destination image
 126  * @param dstFormat the destination image format
 127  * @param flags specify which algorithm and options to use for rescaling
 128  * @return a pointer to an allocated context, or NULL in case of error
 129  */
 130 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
 131                                   int dstW, int dstH, enum PixelFormat dstFormat,
 132                                   int flags, SwsFilter *srcFilter,
 133                                   SwsFilter *dstFilter, const double *param);
 134
 135 /**
 136  * Scales the image slice in \p srcSlice and puts the resulting scaled
 137  * slice in the image in \p dst. A slice is a sequence of consecutive
 138  * rows in an image.
 139  *
 140  * @param context   the scaling context previously created with
 141  *                  sws_getContext()
 142  * @param srcSlice  the array containing the pointers to the planes of
 143  *                  the source slice
 144  * @param srcStride the array containing the strides for each plane of
 145  *                  the source image
 146  * @param srcSliceY the position in the source image of the slice to
 147  *                  process, that is the number (counted starting from
 148  *                  zero) in the image of the first row of the slice
 149  * @param srcSliceH the height of the source slice, that is the number
 150  *                  of rows in the slice
 151  * @param dst       the array containing the pointers to the planes of
 152  *                  the destination image
 153  * @param dstStride the array containing the strides for each plane of
 154  *                  the destination image
 155  * @return          the height of the output slice
 156  */
 157 int sws_scale(struct SwsContext *context, uint8_t* srcSlice[], int srcStride[],
 158               int srcSliceY, int srcSliceH, uint8_t* dst[], int dstStride[]);
 159 #if LIBSWSCALE_VERSION_MAJOR < 1
 160 /**
 161  * @deprecated Use sws_scale() instead.
 162  */
 163 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[],
 164                       int srcStride[], int srcSliceY, int srcSliceH,
 165                       uint8_t* dst[], int dstStride[]) attribute_deprecated;
 166 #endif
 167
 168 /**
 169  * @param inv_table the yuv2rgb coefficients, normally ff_yuv2rgb_coeffs[x]
 170  * @param fullRange if 1 then the luma range is 0..255 if 0 it is 16..235
 171  * @return -1 if not supported
 172  */
 173 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
 174                              int srcRange, const int table[4], int dstRange,
 175                              int brightness, int contrast, int saturation);
 176
 177 /**
 178  * @return -1 if not supported
 179  */
 180 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
 181                              int *srcRange, int **table, int *dstRange,
 182                              int *brightness, int *contrast, int *saturation);
 183
 184 /**
 185  * Returns a normalized Gaussian curve used to filter stuff
 186  * quality=3 is high quality, lower is lower quality.
 187  */
 188 SwsVector *sws_getGaussianVec(double variance, double quality);
 189
 190 /**
 191  * Allocates and returns a vector with \p length coefficients, all
 192  * with the same value \p c.
 193  */
 194 SwsVector *sws_getConstVec(double c, int length);
 195
 196 /**
 197  * Allocates and returns a vector with just one coefficient, with
 198  * value 1.0.
 199  */
 200 SwsVector *sws_getIdentityVec(void);
 201
 202 /**
 203  * Scales all the coefficients of \p a by the \p scalar value.
 204  */
 205 void sws_scaleVec(SwsVector *a, double scalar);
 206
 207 /**
 208  * Scales all the coefficients of \p a so that their sum equals \p
 209  * height."
 210  */
 211 void sws_normalizeVec(SwsVector *a, double height);
 212 void sws_convVec(SwsVector *a, SwsVector *b);
 213 void sws_addVec(SwsVector *a, SwsVector *b);
 214 void sws_subVec(SwsVector *a, SwsVector *b);
 215 void sws_shiftVec(SwsVector *a, int shift);
 216
 217 /**
 218  * Allocates and returns a clone of the vector \p a, that is a vector
 219  * with the same coefficients as \p a.
 220  */
 221 SwsVector *sws_cloneVec(SwsVector *a);
 222
 223 #if LIBSWSCALE_VERSION_MAJOR < 1
 224 /**
 225  * @deprecated Use sws_printVec2() instead.
 226  */
 227 attribute_deprecated void sws_printVec(SwsVector *a);
 228 #endif
 229
 230 /**
 231  * Prints with av_log() a textual representation of the vector \p a
 232  * if \p log_level <= av_log_level.
 233  */
 234 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
 235
 236 void sws_freeVec(SwsVector *a);
 237
 238 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
 239                                 float lumaSharpen, float chromaSharpen,
 240                                 float chromaHShift, float chromaVShift,
 241                                 int verbose);
 242 void sws_freeFilter(SwsFilter *filter);
 243
 244 /**
 245  * Checks if \p context can be reused, otherwise reallocates a new
 246  * one.
 247  *
 248  * If \p context is NULL, just calls sws_getContext() to get a new
 249  * context. Otherwise, checks if the parameters are the ones already
 250  * saved in \p context. If that is the case, returns the current
 251  * context. Otherwise, frees \p context and gets a new context with
 252  * the new parameters.
 253  *
 254  * Be warned that \p srcFilter and \p dstFilter are not checked, they
 255  * are assumed to remain the same.
 256  */
 257 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
 258                                         int srcW, int srcH, enum PixelFormat srcFormat,
 259                                         int dstW, int dstH, enum PixelFormat dstFormat,
 260                                         int flags, SwsFilter *srcFilter,
 261                                         SwsFilter *dstFilter, const double *param);
 262
 263 #endif /* SWSCALE_SWSCALE_H */