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 "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 0
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 
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 
62 unsigned swscale_version(void);
63 
67 const char *swscale_configuration(void);
68 
72 const char *swscale_license(void);
73 
74 /* values for the flags, the stuff on the command line is different */
75 #define SWS_FAST_BILINEAR 1
76 #define SWS_BILINEAR 2
77 #define SWS_BICUBIC 4
78 #define SWS_X 8
79 #define SWS_POINT 0x10
80 #define SWS_AREA 0x20
81 #define SWS_BICUBLIN 0x40
82 #define SWS_GAUSS 0x80
83 #define SWS_SINC 0x100
84 #define SWS_LANCZOS 0x200
85 #define SWS_SPLINE 0x400
86 
87 #define SWS_SRC_V_CHR_DROP_MASK 0x30000
88 #define SWS_SRC_V_CHR_DROP_SHIFT 16
89 
90 #define SWS_PARAM_DEFAULT 123456
91 
92 #define SWS_PRINT_INFO 0x1000
93 
94 //the following 3 flags are not completely implemented
95 //internal chrominace subsampling info
96 #define SWS_FULL_CHR_H_INT 0x2000
97 //input subsampling info
98 #define SWS_FULL_CHR_H_INP 0x4000
99 #define SWS_DIRECT_BGR 0x8000
100 #define SWS_ACCURATE_RND 0x40000
101 #define SWS_BITEXACT 0x80000
102 
103 #if FF_API_SWS_CPU_CAPS
104 
108 #define SWS_CPU_CAPS_MMX 0x80000000
109 #define SWS_CPU_CAPS_MMX2 0x20000000
110 #define SWS_CPU_CAPS_3DNOW 0x40000000
111 #define SWS_CPU_CAPS_ALTIVEC 0x10000000
112 #define SWS_CPU_CAPS_BFIN 0x01000000
113 #define SWS_CPU_CAPS_SSE2 0x02000000
114 #endif
115 
116 #define SWS_MAX_REDUCE_CUTOFF 0.002
117 
118 #define SWS_CS_ITU709 1
119 #define SWS_CS_FCC 4
120 #define SWS_CS_ITU601 5
121 #define SWS_CS_ITU624 5
122 #define SWS_CS_SMPTE170M 5
123 #define SWS_CS_SMPTE240M 7
124 #define SWS_CS_DEFAULT 5
125 
133 const int *sws_getCoefficients(int colorspace);
134 
135 // when used for filters they must have an odd number of elements
136 // coeffs cannot be shared between vectors
137 typedef struct {
138  double *coeff;
139  int length;
140 } SwsVector;
141 
142 // vectors can be shared
143 typedef struct {
148 } SwsFilter;
149 
150 struct SwsContext;
151 
157 
163 
169 struct SwsContext *sws_alloc_context(void);
170 
177 int sws_init_context(struct SwsContext *sws_context, SwsFilter *srcFilter, SwsFilter *dstFilter);
178 
183 void sws_freeContext(struct SwsContext *swsContext);
184 
185 #if FF_API_SWS_GETCONTEXT
186 
202 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat,
203  int dstW, int dstH, enum PixelFormat dstFormat,
204  int flags, SwsFilter *srcFilter,
205  SwsFilter *dstFilter, const double *param);
206 #endif
207 
234 int sws_scale(struct SwsContext *c, const uint8_t *const srcSlice[],
235  const int srcStride[], int srcSliceY, int srcSliceH,
236  uint8_t *const dst[], const int dstStride[]);
237 
242 int sws_setColorspaceDetails(struct SwsContext *c, const int inv_table[4],
243  int srcRange, const int table[4], int dstRange,
244  int brightness, int contrast, int saturation);
245 
249 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table,
250  int *srcRange, int **table, int *dstRange,
251  int *brightness, int *contrast, int *saturation);
252 
256 SwsVector *sws_allocVec(int length);
257 
262 SwsVector *sws_getGaussianVec(double variance, double quality);
263 
268 SwsVector *sws_getConstVec(double c, int length);
269 
275 
279 void sws_scaleVec(SwsVector *a, double scalar);
280 
284 void sws_normalizeVec(SwsVector *a, double height);
285 void sws_convVec(SwsVector *a, SwsVector *b);
286 void sws_addVec(SwsVector *a, SwsVector *b);
287 void sws_subVec(SwsVector *a, SwsVector *b);
288 void sws_shiftVec(SwsVector *a, int shift);
289 
295 
300 void sws_printVec2(SwsVector *a, AVClass *log_ctx, int log_level);
301 
302 void sws_freeVec(SwsVector *a);
303 
304 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
305  float lumaSharpen, float chromaSharpen,
306  float chromaHShift, float chromaVShift,
307  int verbose);
309 
322 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
323  int srcW, int srcH, enum PixelFormat srcFormat,
324  int dstW, int dstH, enum PixelFormat dstFormat,
325  int flags, SwsFilter *srcFilter,
326  SwsFilter *dstFilter, const double *param);
327 
338 void sws_convertPalette8ToPacked32(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
339 
350 void sws_convertPalette8ToPacked24(const uint8_t *src, uint8_t *dst, int num_pixels, const uint8_t *palette);
351 
358 const AVClass *sws_get_class(void);
359 
360 #endif /* SWSCALE_SWSCALE_H */