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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
|
#include "BMP.hpp"
#include <cstring>
#include <set>
#include "openvic-simulation/utility/Logger.hpp"
using namespace OpenVic;
BMP::~BMP() {
close();
}
bool BMP::open(fs::path const& filepath) {
reset();
file.open(filepath, std::ios::binary);
if (file.fail()) {
Logger::error("Failed to open BMP file \"", filepath, "\"");
close();
return false;
}
return true;
}
bool BMP::read_header() {
if (header_validated) {
Logger::error("BMP header already validated!");
return false;
}
if (!file.is_open()) {
Logger::error("Cannot read BMP header before opening a file");
return false;
}
file.seekg(0, std::ios::beg);
if (file.fail()) {
Logger::error("Failed to move to the beginning of the BMP file!");
return false;
}
file.read(reinterpret_cast<char*>(&header), sizeof(header));
if (file.fail()) {
Logger::error("Failed to read BMP header!");
return false;
}
header_validated = true;
// Validate constants
static constexpr uint16_t BMP_SIGNATURE = 0x4d42;
if (header.signature != BMP_SIGNATURE) {
Logger::error("Invalid BMP signature: ", header.signature, " (must be ", BMP_SIGNATURE, ")");
header_validated = false;
}
static constexpr uint32_t DIB_HEADER_SIZE = 40;
if (header.dib_header_size != DIB_HEADER_SIZE) {
Logger::error("Invalid BMP DIB header size: ", header.dib_header_size, " (must be ", DIB_HEADER_SIZE, ")");
header_validated = false;
}
static constexpr uint16_t NUM_PLANES = 1;
if (header.num_planes != NUM_PLANES) {
Logger::error("Invalid BMP plane count: ", header.num_planes, " (must be ", NUM_PLANES, ")");
header_validated = false;
}
static constexpr uint16_t COMPRESSION = 0; // Only support uncompressed BMPs
if (header.compression != COMPRESSION) {
Logger::error("Invalid BMP compression method: ", header.compression, " (must be ", COMPRESSION, ")");
header_validated = false;
}
// Validate sizes and dimensions
// TODO - image_size_bytes can be 0 for non-compressed BMPs
if (header.file_size != header.offset + header.image_size_bytes) {
Logger::error("Invalid BMP memory sizes: file size = ", header.file_size, " != ", header.offset + header.image_size_bytes,
" = ", header.offset, " + ", header.image_size_bytes, " = image data offset + image data size");
header_validated = false;
}
// TODO - support negative widths (i.e. horizontal flip)
if (header.width_px <= 0) {
Logger::error("Invalid BMP width: ", header.width_px, " (must be positive)");
header_validated = false;
}
// TODO - support negative heights (i.e. vertical flip)
if (header.height_px <= 0) {
Logger::error("Invalid BMP height: ", header.height_px, " (must be positive)");
header_validated = false;
}
// TODO - validate x_resolution_ppm
// TODO - validate y_resolution_ppm
// Validate colours
#define VALID_BITS_PER_PIXEL 1, 2, 4, 8, 16, 24, 32
#define STR(x) #x
static const std::set<uint16_t> BITS_PER_PIXEL { VALID_BITS_PER_PIXEL };
if (!BITS_PER_PIXEL.contains(header.bits_per_pixel)) {
Logger::error("Invalid BMP bits per pixel: ", header.bits_per_pixel,
" (must be one of " STR(VALID_BITS_PER_PIXEL) ")");
header_validated = false;
}
#undef VALID_BITS_PER_PIXEL
#undef STR
static constexpr uint16_t PALETTE_BITS_PER_PIXEL_LIMIT = 8;
if (header.num_colours != 0 && header.bits_per_pixel > PALETTE_BITS_PER_PIXEL_LIMIT) {
Logger::error("Invalid BMP palette size: ", header.num_colours,
" (should be 0 as bits per pixel is ", header.bits_per_pixel, " > 8)");
header_validated = false;
}
// TODO - validate important_colours
palette_size = header.bits_per_pixel > PALETTE_BITS_PER_PIXEL_LIMIT ? 0
// Use header.num_colours if it's greater than 0 and at most 1 << header.bits_per_pixel
: 0 < header.num_colours && header.num_colours - 1 >> header.bits_per_pixel == 0 ? header.num_colours
: 1 << header.bits_per_pixel;
const uint32_t expected_offset = palette_size * PALETTE_COLOUR_SIZE + sizeof(header);
if (header.offset != expected_offset) {
Logger::error("Invalid BMP image data offset: ", header.offset, " (should be ", expected_offset, ")");
header_validated = false;
}
return header_validated;
}
bool BMP::read_palette() {
if (palette_read) {
Logger::error("BMP palette already read!");
return false;
}
if (!file.is_open()) {
Logger::error("Cannot read BMP palette before opening a file");
return false;
}
if (!header_validated) {
Logger::error("Cannot read palette before BMP header is validated!");
return false;
}
if (palette_size == 0) {
Logger::error("Cannot read BMP palette - header indicates this file doesn't have one");
return false;
}
file.seekg(sizeof(header), std::ios::beg);
if (file.fail()) {
Logger::error("Failed to move to the palette in the BMP file!");
return false;
}
palette.resize(palette_size);
file.read(reinterpret_cast<char*>(palette.data()), palette_size * PALETTE_COLOUR_SIZE);
if (file.fail()) {
Logger::error("Failed to read BMP header!");
palette.clear();
return false;
}
palette_read = true;
return palette_read;
}
void BMP::close() {
if (file.is_open()) {
file.close();
}
}
void BMP::reset() {
close();
memset(&header, 0, sizeof(header));
header_validated = false;
palette_size = 0;
palette.clear();
pixel_data.clear();
}
int32_t BMP::get_width() const {
return header.width_px;
}
int32_t BMP::get_height() const {
return header.height_px;
}
uint16_t BMP::get_bits_per_pixel() const {
return header.bits_per_pixel;
}
std::vector<colour_t> const& BMP::get_palette() const {
if (!palette_read) {
Logger::warning("Trying to get BMP palette before loading");
}
return palette;
}
bool BMP::read_pixel_data() {
if (pixel_data_read) {
Logger::error("BMP pixel data already read!");
return false;
}
if (!file.is_open()) {
Logger::error("Cannot read BMP pixel data before opening a file");
return false;
}
if (!header_validated) {
Logger::error("Cannot read pixel data before BMP header is validated!");
return false;
}
file.seekg(header.offset, std::ios::beg);
if (file.fail()) {
Logger::error("Failed to move to the pixel data in the BMP file!");
return false;
}
const size_t pixel_data_size = get_width() * get_height() * header.bits_per_pixel / 8;
pixel_data.resize(pixel_data_size);
file.read(reinterpret_cast<char*>(pixel_data.data()), pixel_data_size);
if (file.fail()) {
Logger::error("Failed to read BMP pixel data!");
pixel_data.clear();
return false;
}
pixel_data_read = true;
return pixel_data_read;
}
std::vector<uint8_t> const& BMP::get_pixel_data() const {
if (!pixel_data_read) {
Logger::warning("Trying to get BMP pixel data before loading");
}
return pixel_data;
}
|
zaaarf