less preprocessor magic in version number macros
[ffmpeg.git] / 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 FFMPEG_SWSCALE_H
22 #define FFMPEG_SWSCALE_H
23
24 /**
25  * @file 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 5
34 #define LIBSWSCALE_VERSION_MICRO 0
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 /* values for the flags, the stuff on the command line is different */
47 #define SWS_FAST_BILINEAR     1
48 #define SWS_BILINEAR          2
49 #define SWS_BICUBIC           4
50 #define SWS_X                 8
51 #define SWS_POINT          0x10
52 #define SWS_AREA           0x20
53 #define SWS_BICUBLIN       0x40
54 #define SWS_GAUSS          0x80
55 #define SWS_SINC          0x100
56 #define SWS_LANCZOS       0x200
57 #define SWS_SPLINE        0x400
58
59 #define SWS_SRC_V_CHR_DROP_MASK     0x30000
60 #define SWS_SRC_V_CHR_DROP_SHIFT    16
61
62 #define SWS_PARAM_DEFAULT           123456
63
64 #define SWS_PRINT_INFO              0x1000
65
66 //the following 3 flags are not completely implemented
67 //internal chrominace subsampling info
68 #define SWS_FULL_CHR_H_INT    0x2000
69 //input subsampling info
70 #define SWS_FULL_CHR_H_INP    0x4000
71 #define SWS_DIRECT_BGR        0x8000
72 #define SWS_ACCURATE_RND      0x40000
73
74 #define SWS_CPU_CAPS_MMX      0x80000000
75 #define SWS_CPU_CAPS_MMX2     0x20000000
76 #define SWS_CPU_CAPS_3DNOW    0x40000000
77 #define SWS_CPU_CAPS_ALTIVEC  0x10000000
78 #define SWS_CPU_CAPS_BFIN     0x01000000
79
80 #define SWS_MAX_REDUCE_CUTOFF 0.002
81
82 #define SWS_CS_ITU709         1
83 #define SWS_CS_FCC            4
84 #define SWS_CS_ITU601         5
85 #define SWS_CS_ITU624         5
86 #define SWS_CS_SMPTE170M      5
87 #define SWS_CS_SMPTE240M      7
88 #define SWS_CS_DEFAULT        5
89
90
91
92 // when used for filters they must have an odd number of elements
93 // coeffs cannot be shared between vectors
94 typedef struct {
95     double *coeff;
96     int length;
97 } SwsVector;
98
99 // vectors can be shared
100 typedef struct {
101     SwsVector *lumH;
102     SwsVector *lumV;
103     SwsVector *chrH;
104     SwsVector *chrV;
105 } SwsFilter;
106
107 struct SwsContext;
108
109 void sws_freeContext(struct SwsContext *swsContext);
110
111 struct SwsContext *sws_getContext(int srcW, int srcH, int srcFormat, int dstW, int dstH, int dstFormat, int flags,
112                                   SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
113 int sws_scale(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
114               int srcSliceH, uint8_t* dst[], int dstStride[]);
115 int sws_scale_ordered(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,
116                       int srcSliceH, uint8_t* dst[], int dstStride[]) attribute_deprecated;
117
118
119 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);
120 int sws_getColorspaceDetails(struct SwsContext *c, int **inv_table, int *srcRange, int **table, int *dstRange, int *brightness, int *contrast, int *saturation);
121 SwsVector *sws_getGaussianVec(double variance, double quality);
122 SwsVector *sws_getConstVec(double c, int length);
123 SwsVector *sws_getIdentityVec(void);
124 void sws_scaleVec(SwsVector *a, double scalar);
125 void sws_normalizeVec(SwsVector *a, double height);
126 void sws_convVec(SwsVector *a, SwsVector *b);
127 void sws_addVec(SwsVector *a, SwsVector *b);
128 void sws_subVec(SwsVector *a, SwsVector *b);
129 void sws_shiftVec(SwsVector *a, int shift);
130 SwsVector *sws_cloneVec(SwsVector *a);
131
132 void sws_printVec(SwsVector *a);
133 void sws_freeVec(SwsVector *a);
134
135 SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
136                                 float lumaSarpen, float chromaSharpen,
137                                 float chromaHShift, float chromaVShift,
138                                 int verbose);
139 void sws_freeFilter(SwsFilter *filter);
140
141 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
142                                         int srcW, int srcH, int srcFormat,
143                                         int dstW, int dstH, int dstFormat, int flags,
144                                         SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
145
146 #endif /* FFMPEG_SWSCALE_H */