1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef GRAPHICS_PALETTE_H
#define GRAPHICS_PALETTE_H
#include "common/hashmap.h"
namespace Graphics {
/**
* Constants available for use in paletted code
*/
#define PALETTE_COUNT 256
#define PALETTE_SIZE (256 * 3)
/**
* @brief Simple class for handling a palette data.
*
* The palette data is specified in interleaved RGB format. That is, the
* first byte of the memory block 'colors' points at is the red component
* of the first new color; the second byte the green component of the first
* new color; the third byte the blue component, the last byte to the alpha
* (transparency) value. Then the second color starts, and so on. So memory
* looks like this: R1-G1-B1-R2-G2-B2-R3-...
*/
class Palette {
byte *_data;
uint16 _size;
public:
static const uint16 npos = 0xFFFF;
/**
* @brief Construct a new Palette object
*
* @param size the number of palette entries
*/
Palette(uint size);
/**
* @brief Construct a new Palette object
*
* @param data the palette data, in interleaved RGB format
* @param size the number of palette entries
*/
Palette(const byte *data, uint size);
Palette(const Palette &p);
~Palette();
/**
* Constructs a new palette containing the standarad EGA palette
*/
static Palette createEGAPalette();
Palette &operator=(const Palette &rhs);
bool operator==(const Palette &rhs) const { return equals(rhs); }
bool operator!=(const Palette &rhs) const { return !equals(rhs); }
bool equals(const Palette &p) const;
bool contains(const Palette &p) const;
const byte *data() const { return _data; }
uint size() const { return _size; }
void set(uint entry, byte r, byte g, byte b) {
assert(entry < _size);
_data[entry * 3 + 0] = r;
_data[entry * 3 + 1] = g;
_data[entry * 3 + 2] = b;
}
void get(uint entry, byte &r, byte &g, byte &b) const {
assert(entry < _size);
r = _data[entry * 3 + 0];
g = _data[entry * 3 + 1];
b = _data[entry * 3 + 2];
}
/**
* Finds the index of an exact color from the palette.
*
* @return the palette index or npos if not found
*/
uint find(byte r, byte g, byte b) const {
for (uint i = 0; i < _size; i++) {
if (_data[i * 3 + 0] == r && _data[i * 3 + 1] == g && _data[i * 3 + 2] == b)
return i;
}
return npos;
}
/**
* Finds the index of the closest color from the palette.
*
* @param useNaiveAlg if true, use a simpler algorithm
*
* @return the palette index
*/
byte findBestColor(byte r, byte g, byte b, bool useNaiveAlg = false) const;
void clear();
/**
* Replace the specified range of the palette with new colors.
* The palette entries from 'start' till (start+num-1) will be replaced - so
* a full palette update is accomplished via start=0, num=256.
*
* @param colors the new palette data, in interleaved RGB format
* @param start the first palette entry to be updated
* @param num the number of palette entries to be updated
*
* @note It is an error if start+num exceeds 256.
*/
void set(const byte *colors, uint start, uint num);
void set(const Palette &p, uint start, uint num);
/**
* Grabs a specified part of the currently active palette.
* The format is the same as for setPalette.
*
* @param colors the palette data, in interleaved RGB format
* @param start the first platte entry to be read
* @param num the number of palette entries to be read
*
* @note It is an error if start+num exceeds 256.
*/
void grab(byte *colors, uint start, uint num) const;
void grab(Palette &p, uint start, uint num) const;
};
class PaletteLookup {
public:
PaletteLookup();
/**
* @brief Construct a new Palette Lookup object
*
* @param palette the palette data, in interleaved RGB format
* @param len the number of palette entries to be read
*/
PaletteLookup(const byte *palette, uint len);
/**
* @brief Pass palette to the look up. It also compares given palette
* with the current one and resets cache only when their contents is different.
*
* @param palette the palette data, in interleaved RGB format
* @param len the number of palette entries to be read
*
* @return true if palette was changed and false if it was the same
*/
bool setPalette(const byte *palette, uint len);
/**
* @brief This method returns closest color from the palette
* and it uses cache for faster lookups
*
* @param useNaiveAlg if true, use a simpler algorithm
*
* @return the palette index
*/
byte findBestColor(byte r, byte g, byte b, bool useNaiveAlg = false);
/**
* @brief This method creates a map from the given palette
* that can be used by crossBlitMap().
*
* @param palette the palette data, in interleaved RGB format
* @param len the number of palette entries to be read
* @param useNaiveAlg if true, use a simpler algorithm
*
* @return the created map, or nullptr if one isn't needed.
*/
uint32 *createMap(const byte *srcPalette, uint len, bool useNaiveAlg = false);
private:
Palette _palette;
uint _paletteSize;
Common::HashMap<int, byte> _colorHash;
};
} // // end of namespace Graphics
#endif
|
