Cleanup: Grey --> Gray
[blender.git] / source / gameengine / VideoTexture / FilterColor.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Copyright (c) 2007 The Zdeno Ash Miklas
19  *
20  * This source file is part of blendTex library
21  *
22  * Contributor(s):
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file FilterColor.h
28  *  \ingroup bgevideotex
29  */
30
31 #ifndef __FILTERCOLOR_H__
32 #define __FILTERCOLOR_H__
33
34 #include "Common.h"
35
36 #include "FilterBase.h"
37
38
39 /// pixel filter for grayscale
40 class FilterGray : public FilterBase
41 {
42 public:
43         /// constructor
44         FilterGray (void) {}
45         /// destructor
46         virtual ~FilterGray (void) {}
47
48 protected:
49         /// filter pixel template, source int buffer
50         template <class SRC> unsigned int tFilter (SRC src, short x, short y,
51                 short * size, unsigned int pixSize, unsigned int val)
52         {
53                 // calculate gray value
54                 unsigned int gray = (28 * (VT_B(val)) + 151 * (VT_G(val))
55                         + 77 * (VT_R(val))) >> 8;
56                 // return grayscale value
57                 VT_R(val) = gray;
58                 VT_G(val) = gray;
59                 VT_B(val) = gray;
60                 return val;
61         }
62
63         /// virtual filtering function for byte source
64         virtual unsigned int filter (unsigned char * src, short x, short y,
65                 short * size, unsigned int pixSize, unsigned int val = 0)
66         { return tFilter(src, x, y, size, pixSize, val); }
67         /// virtual filtering function for unsigned int source
68         virtual unsigned int filter (unsigned int * src, short x, short y,
69                 short * size, unsigned int pixSize, unsigned int val = 0)
70         { return tFilter(src, x, y, size, pixSize, val); }
71 };
72
73
74 /// type for color matrix
75 typedef short ColorMatrix[4][5];
76
77 /// pixel filter for color calculation
78 class FilterColor : public FilterBase
79 {
80 public:
81         /// constructor
82         FilterColor (void);
83         /// destructor
84         virtual ~FilterColor (void) {}
85
86         /// get color matrix
87         ColorMatrix & getMatrix (void) { return m_matrix; }
88         /// set color matrix
89         void setMatrix (ColorMatrix & mat);
90
91 protected:
92         ///  color calculation matrix
93         ColorMatrix m_matrix;
94
95         /// calculate one color component
96         unsigned char calcColor (unsigned int val, short idx)
97         {
98                 return (((m_matrix[idx][0]  * (VT_R(val)) + m_matrix[idx][1] * (VT_G(val)) +
99                           m_matrix[idx][2] * (VT_B(val)) + m_matrix[idx][3] * (VT_A(val)) +
100                           m_matrix[idx][4]) >> 8) & 0xFF);
101         }
102
103         /// filter pixel template, source int buffer
104         template <class SRC> unsigned int tFilter (SRC src, short x, short y,
105                 short * size, unsigned int pixSize, unsigned int val)
106         {
107                 // return calculated color
108                 int color;
109                 VT_RGBA(color, calcColor(val, 0), calcColor(val, 1), calcColor(val, 2), calcColor(val, 3));
110                 return color;
111         }
112
113         /// virtual filtering function for byte source
114         virtual unsigned int filter (unsigned char * src, short x, short y,
115                 short * size, unsigned int pixSize, unsigned int val = 0)
116         { return tFilter(src, x, y, size, pixSize, val); }
117         /// virtual filtering function for unsigned int source
118         virtual unsigned int filter (unsigned int * src, short x, short y,
119                 short * size, unsigned int pixSize, unsigned int val = 0)
120         { return tFilter(src, x, y, size, pixSize, val); }
121 };
122
123
124 /// type for color levels
125 typedef unsigned short ColorLevel[4][3];
126
127 /// pixel filter for color calculation
128 class FilterLevel : public FilterBase
129 {
130 public:
131         /// constructor
132         FilterLevel (void);
133         /// destructor
134         virtual ~FilterLevel (void) {}
135
136         /// get color matrix
137         ColorLevel & getLevels (void) { return levels; }
138         /// set color matrix
139         void setLevels (ColorLevel & lev);
140
141 protected:
142         ///  color calculation matrix
143         ColorLevel levels;
144
145         /// calculate one color component
146         unsigned int calcColor (unsigned int val, short idx)
147         {
148                 unsigned int col = VT_C(val,idx);
149                 if (col <= levels[idx][0]) col = 0;
150                 else if (col >= levels[idx][1]) col = 0xFF;
151                 else col = (((col - levels[idx][0]) << 8) / levels[idx][2]) & 0xFF;
152                 return col; 
153         }
154
155         /// filter pixel template, source int buffer
156         template <class SRC> unsigned int tFilter (SRC src, short x, short y,
157                 short * size, unsigned int pixSize, unsigned int val)
158         {
159                 // return calculated color
160                 int color;
161                 VT_RGBA(color, calcColor(val, 0), calcColor(val, 1), calcColor(val, 2), calcColor(val, 3));
162                 return color;
163         }
164
165         /// virtual filtering function for byte source
166         virtual unsigned int filter (unsigned char * src, short x, short y,
167                 short * size, unsigned int pixSize, unsigned int val = 0)
168         { return tFilter(src, x, y, size, pixSize, val); }
169         /// virtual filtering function for unsigned int source
170         virtual unsigned int filter (unsigned int * src, short x, short y,
171                 short * size, unsigned int pixSize, unsigned int val = 0)
172         { return tFilter(src, x, y, size, pixSize, val); }
173 };
174
175
176 #endif