swscale.h
Go to the documentation of this file.
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 
30 #include <stdint.h>
31 
32 #include "libavutil/avutil.h"
33 #include "libavutil/log.h"
34 #include "libavutil/pixfmt.h"
35 #include "version.h"
36 
40 unsigned swscale_version(void);
41 
45 const char *swscale_configuration(void);
46 
50 const char *swscale_license(void);
51 
52 /* values for the flags, the stuff on the command line is different */
53 #define SWS_FAST_BILINEAR 1
54 #define SWS_BILINEAR 2
55 #define SWS_BICUBIC 4
56 #define SWS_X 8
57 #define SWS_POINT 0x10
58 #define SWS_AREA 0x20
59 #define SWS_BICUBLIN 0x40
60 #define SWS_GAUSS 0x80
61 #define SWS_SINC 0x100
62 #define SWS_LANCZOS 0x200
63 #define SWS_SPLINE 0x400
64 
65 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
66 #define SWS_SRC_V_CHR_DROP_SHIFT 16
67 
68 #define SWS_PARAM_DEFAULT 123456
69 
70 #define SWS_PRINT_INFO 0x1000
71 
72 //the following 3 flags are not completely implemented
73 //internal chrominace subsampling info
74 #define SWS_FULL_CHR_H_INT 0x2000
75 //input subsampling info
76 #define SWS_FULL_CHR_H_INP 0x4000
77 #define SWS_DIRECT_BGR 0x8000
78 #define SWS_ACCURATE_RND 0x40000
79 #define SWS_BITEXACT 0x80000
80 
81 #if FF_API_SWS_CPU_CAPS
82 
86 #define SWS_CPU_CAPS_MMX 0x80000000
87 #define SWS_CPU_CAPS_MMXEXT 0x20000000
88 #define SWS_CPU_CAPS_MMX2 0x20000000
89 #define SWS_CPU_CAPS_3DNOW 0x40000000
90 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
91 #define SWS_CPU_CAPS_BFIN 0x01000000
92 #define SWS_CPU_CAPS_SSE2 0x02000000
93 #endif
94 
95 #define SWS_MAX_REDUCE_CUTOFF 0.002
96 
97 #define SWS_CS_ITU709 1
98 #define SWS_CS_FCC 4
99 #define SWS_CS_ITU601 5
100 #define SWS_CS_ITU624 5
101 #define SWS_CS_SMPTE170M 5
102 #define SWS_CS_SMPTE240M 7
103 #define SWS_CS_DEFAULT 5
104 
112 const int *sws_getCoefficients(int colorspace);
113 
114 // when used for filters they must have an odd number of elements
115 // coeffs cannot be shared between vectors
116 typedef struct SwsVector {
117  double *coeff;
118  int length;
119 } SwsVector;
120 
121 // vectors can be shared
122 typedef struct SwsFilter {
127 } SwsFilter;
128 
129 struct SwsContext;
130 
136 
142 
148 struct SwsContext *sws_alloc_context(void);
149 
156 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
157 
162 void sws_freeContext(struct SwsContext *swsContext);
163 
164 #if FF_API_SWS_GETCONTEXT
165 
182  int dstW, int dstH, enum AVPixelFormat dstFormat,
183  int flags, SwsFilter *srcFilter,
184  SwsFilter *dstFilter, const double *param);
185 #endif
186 
213 int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
214  const int srcStride[], int srcSliceY, int srcSliceH,
215  uint8_t *const dst[], const int dstStride[]);
216 
221 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
222  int srcRange, const int table[4], int dstRange,
223  int brightness, int contrast, int saturation);
224 
228 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
229  int *srcRange, int **table, int *dstRange,
230  int *brightness, int *contrast, int *saturation);
231 
235 SwsVector *sws_allocVec(int length);
236 
241 SwsVector *sws_getGaussianVec(double variance, double quality);
242 
247 SwsVector *sws_getConstVec(double c, int length);
248 
254 
258 void sws_scaleVec(SwsVector *a, double scalar);
259 
263 void sws_normalizeVec(SwsVector *a, double height);
265 void sws_addVec(SwsVector *a, SwsVector *b);
266 void sws_subVec(SwsVector *a, SwsVector *b);
267 void sws_shiftVec(SwsVector *a, int shift);
268 
274 
279 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
280 
281 void sws_freeVec(SwsVector *a);
282 
283 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
284  float lumaSharpen, float chromaSharpen,
285  float chromaHShift, float chromaVShift,
286  int verbose);
288 
301 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
302  int srcW, int srcH, enum AVPixelFormat srcFormat,
303  int dstW, int dstH, enum AVPixelFormat dstFormat,
304  int flags, SwsFilter *srcFilter,
305  SwsFilter *dstFilter, const double *param);
306 
317 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
318 
329 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
330 
337 const AVClass *sws_get_class(void);
338 
339 #endif /* SWSCALE_SWSCALE_H */
SwsVector * chrV
Definition: swscale.h:126
void sws_freeContext(struct SwsContext *swsContext)
Free the swscaler context swsContext.
Definition: utils.c:1628
SwsVector * lumV
Definition: swscale.h:124
int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[], const int srcStride[], int srcSliceY, int srcSliceH, uint8_t *const dst[], const int dstStride[])
Scale the image slice in srcSlice and put the resulting scaled slice in the image in dst...
external API header
void sws_freeVec(SwsVector *a)
Definition: utils.c:1603
SwsVector * sws_getConstVec(double c, int length)
Allocate and return a vector with length coefficients, all with the same value c. ...
Definition: utils.c:1414
int srcRange
0 = MPG YUV range, 1 = JPG YUV range (source image).
swscale version macros
void sws_freeFilter(SwsFilter *filter)
Definition: utils.c:1612
int srcH
Height of source luma/alpha planes.
uint8_t
int length
number of coefficients in the vector
Definition: swscale.h:118
#define b
Definition: input.c:52
static int flags
Definition: log.c:42
struct SwsContext * sws_alloc_context(void)
Allocate an empty SwsContext.
Definition: utils.c:843
enum AVPixelFormat dstFormat
Destination pixel format.
int dstH
Height of destination luma/alpha planes.
SwsFilter * sws_getDefaultFilter(float lumaGBlur, float chromaGBlur, float lumaSharpen, float chromaSharpen, float chromaHShift, float chromaVShift, int verbose)
Definition: utils.c:1319
struct SwsContext * sws_getContext(int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
Allocate and return an SwsContext.
Definition: utils.c:1282
SwsVector * sws_getGaussianVec(double variance, double quality)
Return a normalized Gaussian curve used to filter stuff quality = 3 is high quality, lower is lower quality.
Definition: utils.c:1393
void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette)
Convert an 8-bit paletted frame into a frame with a color depth of 24 bits.
void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette)
Convert an 8-bit paletted frame into a frame with a color depth of 32 bits.
SwsVector * lumH
Definition: swscale.h:123
static void filter(MpegAudioContext *s, int ch, const short *samples, int incr)
Definition: mpegaudioenc.c:318
int dstRange
0 = MPG YUV range, 1 = JPG YUV range (destination image).
void sws_subVec(SwsVector *a, SwsVector *b)
Definition: utils.c:1545
SwsVector * chrH
Definition: swscale.h:125
struct SwsVector SwsVector
int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4], int srcRange, const int table[4], int dstRange, int brightness, int contrast, int saturation)
Definition: utils.c:775
void sws_shiftVec(SwsVector *a, int shift)
Definition: utils.c:1527
enum AVPixelFormat pix_fmt
Definition: movenc.c:801
int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation)
Definition: utils.c:805
int dstW
Width of destination luma/alpha planes.
struct SwsFilter SwsFilter
unsigned swscale_version(void)
Return the LIBSWSCALE_VERSION_INT constant.
Definition: utils.c:54
double * coeff
pointer to the list of coefficients
Definition: swscale.h:117
const int * sws_getCoefficients(int colorspace)
Return a pointer to yuv<->rgb coefficients for the given colorspace suitable for sws_setColorspaceDet...
Definition: yuv2rgb.c:54
SwsVector * sws_cloneVec(SwsVector *a)
Allocate and return a clone of the vector a, that is a vector with the same coefficients as a...
Definition: utils.c:1563
void sws_normalizeVec(SwsVector *a, double height)
Scale all the coefficients of a so that their sum equals height.
Definition: utils.c:1452
Describe the class of an AVClass context structure.
Definition: log.h:33
int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter)
Initialize the swscaler context sws_context.
Definition: utils.c:855
const char * swscale_configuration(void)
Return the libswscale build-time configuration.
Definition: utils.c:59
int height
Definition: gxfenc.c:72
SwsVector * sws_allocVec(int length)
Allocate and return an uninitialized vector with length coefficients.
Definition: utils.c:1381
double param[2]
Input parameters for scaling algorithms that need them.
const AVClass * sws_get_class(void)
Get the AVClass for swsContext.
Definition: options.c:71
int sws_isSupportedOutput(enum AVPixelFormat pix_fmt)
Return a positive value if pix_fmt is a supported output format, 0 otherwise.
Definition: utils.c:181
int sws_isSupportedInput(enum AVPixelFormat pix_fmt)
Return a positive value if pix_fmt is a supported input format, 0 otherwise.
Definition: utils.c:175
enum AVPixelFormat srcFormat
Source pixel format.
SwsVector * sws_getIdentityVec(void)
Allocate and return a vector with just one coefficient, with value 1.0.
Definition: utils.c:1428
pixel format definitions
const char * swscale_license(void)
Return the libswscale license.
Definition: utils.c:64
struct SwsContext * sws_getCachedContext(struct SwsContext *context, int srcW, int srcH, enum AVPixelFormat srcFormat, int dstW, int dstH, enum AVPixelFormat dstFormat, int flags, SwsFilter *srcFilter, SwsFilter *dstFilter, const double *param)
Check if context can be reused, otherwise reallocate a new one.
Definition: utils.c:1692
void sws_convVec(SwsVector *a, SwsVector *b)
Definition: utils.c:1554
void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level)
Print with av_log() a textual representation of the vector a if log_level <= av_log_level.
Definition: utils.c:1577
void sws_addVec(SwsVector *a, SwsVector *b)
Definition: utils.c:1536
enum AVColorSpace colorspace
Definition: dirac.c:99
void sws_scaleVec(SwsVector *a, double scalar)
Scale all the coefficients of a by the scalar value.
Definition: utils.c:1444
int srcW
Width of source luma/alpha planes.
AVPixelFormat
Pixel format.
Definition: pixfmt.h:63