OpenTTD Source  1.11.0-beta2
grf.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD 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, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../stdafx.h"
11 #include "../gfx_func.h"
12 #include "../fileio_func.h"
13 #include "../debug.h"
14 #include "../strings_func.h"
15 #include "table/strings.h"
16 #include "../error.h"
17 #include "../core/math_func.hpp"
18 #include "../core/alloc_type.hpp"
19 #include "../core/bitmath_func.hpp"
20 #include "grf.hpp"
21 
22 #include "../safeguards.h"
23 
24 extern const byte _palmap_w2d[];
25 
34 static bool WarnCorruptSprite(uint8 file_slot, size_t file_pos, int line)
35 {
36  static byte warning_level = 0;
37  if (warning_level == 0) {
38  SetDParamStr(0, FioGetFilename(file_slot));
39  ShowErrorMessage(STR_NEWGRF_ERROR_CORRUPT_SPRITE, INVALID_STRING_ID, WL_ERROR);
40  }
41  DEBUG(sprite, warning_level, "[%i] Loading corrupted sprite from %s at position %i", line, FioGetFilename(file_slot), (int)file_pos);
42  warning_level = 6;
43  return false;
44 }
45 
59 bool DecodeSingleSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, int64 num, byte type, ZoomLevel zoom_lvl, byte colour_fmt, byte container_format)
60 {
61  std::unique_ptr<byte[]> dest_orig(new byte[num]);
62  byte *dest = dest_orig.get();
63  const int64 dest_size = num;
64 
65  /* Read the file, which has some kind of compression */
66  while (num > 0) {
67  int8 code = FioReadByte();
68 
69  if (code >= 0) {
70  /* Plain bytes to read */
71  int size = (code == 0) ? 0x80 : code;
72  num -= size;
73  if (num < 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);
74  for (; size > 0; size--) {
75  *dest = FioReadByte();
76  dest++;
77  }
78  } else {
79  /* Copy bytes from earlier in the sprite */
80  const uint data_offset = ((code & 7) << 8) | FioReadByte();
81  if (dest - data_offset < dest_orig.get()) return WarnCorruptSprite(file_slot, file_pos, __LINE__);
82  int size = -(code >> 3);
83  num -= size;
84  if (num < 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);
85  for (; size > 0; size--) {
86  *dest = *(dest - data_offset);
87  dest++;
88  }
89  }
90  }
91 
92  if (num != 0) return WarnCorruptSprite(file_slot, file_pos, __LINE__);
93 
94  sprite->AllocateData(zoom_lvl, sprite->width * sprite->height);
95 
96  /* Convert colour depth to pixel size. */
97  int bpp = 0;
98  if (colour_fmt & SCC_RGB) bpp += 3; // Has RGB data.
99  if (colour_fmt & SCC_ALPHA) bpp++; // Has alpha data.
100  if (colour_fmt & SCC_PAL) bpp++; // Has palette data.
101 
102  /* When there are transparency pixels, this format has another trick.. decode it */
103  if (type & 0x08) {
104  for (int y = 0; y < sprite->height; y++) {
105  bool last_item = false;
106  /* Look up in the header-table where the real data is stored for this row */
107  int offset;
108  if (container_format >= 2 && dest_size > UINT16_MAX) {
109  offset = (dest_orig[y * 4 + 3] << 24) | (dest_orig[y * 4 + 2] << 16) | (dest_orig[y * 4 + 1] << 8) | dest_orig[y * 4];
110  } else {
111  offset = (dest_orig[y * 2 + 1] << 8) | dest_orig[y * 2];
112  }
113 
114  /* Go to that row */
115  dest = dest_orig.get() + offset;
116 
117  do {
118  if (dest + (container_format >= 2 && sprite->width > 256 ? 4 : 2) > dest_orig.get() + dest_size) {
119  return WarnCorruptSprite(file_slot, file_pos, __LINE__);
120  }
121 
123  /* Read the header. */
124  int length, skip;
125  if (container_format >= 2 && sprite->width > 256) {
126  /* 0 .. 14 - length
127  * 15 - last_item
128  * 16 .. 31 - transparency bytes */
129  last_item = (dest[1] & 0x80) != 0;
130  length = ((dest[1] & 0x7F) << 8) | dest[0];
131  skip = (dest[3] << 8) | dest[2];
132  dest += 4;
133  } else {
134  /* 0 .. 6 - length
135  * 7 - last_item
136  * 8 .. 15 - transparency bytes */
137  last_item = ((*dest) & 0x80) != 0;
138  length = (*dest++) & 0x7F;
139  skip = *dest++;
140  }
141 
142  data = &sprite->data[y * sprite->width + skip];
143 
144  if (skip + length > sprite->width || dest + length * bpp > dest_orig.get() + dest_size) {
145  return WarnCorruptSprite(file_slot, file_pos, __LINE__);
146  }
147 
148  for (int x = 0; x < length; x++) {
149  if (colour_fmt & SCC_RGB) {
150  data->r = *dest++;
151  data->g = *dest++;
152  data->b = *dest++;
153  }
154  data->a = (colour_fmt & SCC_ALPHA) ? *dest++ : 0xFF;
155  if (colour_fmt & SCC_PAL) {
156  switch (sprite_type) {
157  case ST_NORMAL: data->m = _palette_remap_grf[file_slot] ? _palmap_w2d[*dest] : *dest; break;
158  case ST_FONT: data->m = std::min<uint>(*dest, 2u); break;
159  default: data->m = *dest; break;
160  }
161  /* Magic blue. */
162  if (colour_fmt == SCC_PAL && *dest == 0) data->a = 0x00;
163  dest++;
164  }
165  data++;
166  }
167  } while (!last_item);
168  }
169  } else {
170  if (dest_size < sprite->width * sprite->height * bpp) {
171  return WarnCorruptSprite(file_slot, file_pos, __LINE__);
172  }
173 
174  if (dest_size > sprite->width * sprite->height * bpp) {
175  static byte warning_level = 0;
176  DEBUG(sprite, warning_level, "Ignoring " OTTD_PRINTF64 " unused extra bytes from the sprite from %s at position %i", dest_size - sprite->width * sprite->height * bpp, FioGetFilename(file_slot), (int)file_pos);
177  warning_level = 6;
178  }
179 
180  dest = dest_orig.get();
181 
182  for (int i = 0; i < sprite->width * sprite->height; i++) {
183  byte *pixel = &dest[i * bpp];
184 
185  if (colour_fmt & SCC_RGB) {
186  sprite->data[i].r = *pixel++;
187  sprite->data[i].g = *pixel++;
188  sprite->data[i].b = *pixel++;
189  }
190  sprite->data[i].a = (colour_fmt & SCC_ALPHA) ? *pixel++ : 0xFF;
191  if (colour_fmt & SCC_PAL) {
192  switch (sprite_type) {
193  case ST_NORMAL: sprite->data[i].m = _palette_remap_grf[file_slot] ? _palmap_w2d[*pixel] : *pixel; break;
194  case ST_FONT: sprite->data[i].m = std::min<uint>(*pixel, 2u); break;
195  default: sprite->data[i].m = *pixel; break;
196  }
197  /* Magic blue. */
198  if (colour_fmt == SCC_PAL && *pixel == 0) sprite->data[i].a = 0x00;
199  pixel++;
200  }
201  }
202  }
203 
204  return true;
205 }
206 
207 uint8 LoadSpriteV1(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)
208 {
209  /* Check the requested colour depth. */
210  if (load_32bpp) return 0;
211 
212  /* Open the right file and go to the correct position */
213  FioSeekToFile(file_slot, file_pos);
214 
215  /* Read the size and type */
216  int num = FioReadWord();
217  byte type = FioReadByte();
218 
219  /* Type 0xFF indicates either a colourmap or some other non-sprite info; we do not handle them here */
220  if (type == 0xFF) return 0;
221 
222  ZoomLevel zoom_lvl = (sprite_type != ST_MAPGEN) ? ZOOM_LVL_OUT_4X : ZOOM_LVL_NORMAL;
223 
224  sprite[zoom_lvl].height = FioReadByte();
225  sprite[zoom_lvl].width = FioReadWord();
226  sprite[zoom_lvl].x_offs = FioReadWord();
227  sprite[zoom_lvl].y_offs = FioReadWord();
228  sprite[zoom_lvl].colours = SCC_PAL;
229 
230  if (sprite[zoom_lvl].width > INT16_MAX) {
231  WarnCorruptSprite(file_slot, file_pos, __LINE__);
232  return 0;
233  }
234 
235  /* 0x02 indicates it is a compressed sprite, so we can't rely on 'num' to be valid.
236  * In case it is uncompressed, the size is 'num' - 8 (header-size). */
237  num = (type & 0x02) ? sprite[zoom_lvl].width * sprite[zoom_lvl].height : num - 8;
238 
239  if (DecodeSingleSprite(&sprite[zoom_lvl], file_slot, file_pos, sprite_type, num, type, zoom_lvl, SCC_PAL, 1)) return 1 << zoom_lvl;
240 
241  return 0;
242 }
243 
244 uint8 LoadSpriteV2(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)
245 {
247 
248  /* Is the sprite not present/stripped in the GRF? */
249  if (file_pos == SIZE_MAX) return 0;
250 
251  /* Open the right file and go to the correct position */
252  FioSeekToFile(file_slot, file_pos);
253 
254  uint32 id = FioReadDword();
255 
256  uint8 loaded_sprites = 0;
257  do {
258  int64 num = FioReadDword();
259  size_t start_pos = FioGetPos();
260  byte type = FioReadByte();
261 
262  /* Type 0xFF indicates either a colourmap or some other non-sprite info; we do not handle them here. */
263  if (type == 0xFF) return 0;
264 
265  byte colour = type & SCC_MASK;
266  byte zoom = FioReadByte();
267 
268  if (colour != 0 && (load_32bpp ? colour != SCC_PAL : colour == SCC_PAL) && (sprite_type != ST_MAPGEN ? zoom < lengthof(zoom_lvl_map) : zoom == 0)) {
269  ZoomLevel zoom_lvl = (sprite_type != ST_MAPGEN) ? zoom_lvl_map[zoom] : ZOOM_LVL_NORMAL;
270 
271  if (HasBit(loaded_sprites, zoom_lvl)) {
272  /* We already have this zoom level, skip sprite. */
273  DEBUG(sprite, 1, "Ignoring duplicate zoom level sprite %u from %s", id, FioGetFilename(file_slot));
274  FioSkipBytes(num - 2);
275  continue;
276  }
277 
278  sprite[zoom_lvl].height = FioReadWord();
279  sprite[zoom_lvl].width = FioReadWord();
280  sprite[zoom_lvl].x_offs = FioReadWord();
281  sprite[zoom_lvl].y_offs = FioReadWord();
282 
283  if (sprite[zoom_lvl].width > INT16_MAX || sprite[zoom_lvl].height > INT16_MAX) {
284  WarnCorruptSprite(file_slot, file_pos, __LINE__);
285  return 0;
286  }
287 
288  /* Mask out colour information. */
289  type = type & ~SCC_MASK;
290 
291  /* Convert colour depth to pixel size. */
292  int bpp = 0;
293  if (colour & SCC_RGB) bpp += 3; // Has RGB data.
294  if (colour & SCC_ALPHA) bpp++; // Has alpha data.
295  if (colour & SCC_PAL) bpp++; // Has palette data.
296 
297  sprite[zoom_lvl].colours = (SpriteColourComponent)colour;
298 
299  /* For chunked encoding we store the decompressed size in the file,
300  * otherwise we can calculate it from the image dimensions. */
301  uint decomp_size = (type & 0x08) ? FioReadDword() : sprite[zoom_lvl].width * sprite[zoom_lvl].height * bpp;
302 
303  bool valid = DecodeSingleSprite(&sprite[zoom_lvl], file_slot, file_pos, sprite_type, decomp_size, type, zoom_lvl, colour, 2);
304  if (FioGetPos() != start_pos + num) {
305  WarnCorruptSprite(file_slot, file_pos, __LINE__);
306  return 0;
307  }
308 
309  if (valid) SetBit(loaded_sprites, zoom_lvl);
310  } else {
311  /* Not the wanted zoom level or colour depth, continue searching. */
312  FioSkipBytes(num - 2);
313  }
314 
315  } while (FioReadDword() == id);
316 
317  return loaded_sprites;
318 }
319 
320 uint8 SpriteLoaderGrf::LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)
321 {
322  if (this->container_ver >= 2) {
323  return LoadSpriteV2(sprite, file_slot, file_pos, sprite_type, load_32bpp);
324  } else {
325  return LoadSpriteV1(sprite, file_slot, file_pos, sprite_type, load_32bpp);
326  }
327 }
SpriteLoader::CommonPixel::m
uint8 m
Remap-channel.
Definition: spriteloader.hpp:38
SCC_PAL
@ SCC_PAL
Sprite has palette data.
Definition: spriteloader.hpp:24
SpriteLoader::CommonPixel::r
uint8 r
Red-channel.
Definition: spriteloader.hpp:34
ZOOM_LVL_OUT_2X
@ ZOOM_LVL_OUT_2X
Zoomed 2 times out.
Definition: zoom_type.h:25
ST_FONT
@ ST_FONT
A sprite used for fonts.
Definition: gfx_type.h:304
FioReadWord
uint16 FioReadWord()
Read a word (16 bits) from the file (in low endian format).
Definition: fileio.cpp:140
SpriteLoader::Sprite::AllocateData
void AllocateData(ZoomLevel zoom, size_t size)
Allocate the sprite data of this sprite.
Definition: spriteloader.hpp:61
ZOOM_LVL_OUT_16X
@ ZOOM_LVL_OUT_16X
Zoomed 16 times out.
Definition: zoom_type.h:28
SpriteLoaderGrf::LoadSprite
uint8 LoadSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, bool load_32bpp)
Load a sprite from the disk and return a sprite struct which is the same for all loaders.
Definition: grf.cpp:320
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
valid
uint8 valid
Bits indicating what variable is valid (for each bit, 0 is invalid, 1 is valid).
Definition: newgrf_station.cpp:248
DecodeSingleSprite
bool DecodeSingleSprite(SpriteLoader::Sprite *sprite, uint8 file_slot, size_t file_pos, SpriteType sprite_type, int64 num, byte type, ZoomLevel zoom_lvl, byte colour_fmt, byte container_format)
Decode the image data of a single sprite.
Definition: grf.cpp:59
ZoomLevel
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:21
_palmap_w2d
const byte _palmap_w2d[]
Converting from the Windows palette to the DOS palette.
ST_NORMAL
@ ST_NORMAL
The most basic (normal) sprite.
Definition: gfx_type.h:302
grf.hpp
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:372
FioReadDword
uint32 FioReadDword()
Read a double word (32 bits) from the file (in low endian format).
Definition: fileio.cpp:150
SpriteLoader::Sprite::data
SpriteLoader::CommonPixel * data
The sprite itself.
Definition: spriteloader.hpp:54
FioSkipBytes
void FioSkipBytes(int n)
Skip n bytes ahead in the file.
Definition: fileio.cpp:124
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:35
SpriteLoader::CommonPixel
Definition of a common pixel in OpenTTD's realm.
Definition: spriteloader.hpp:33
ZOOM_LVL_OUT_8X
@ ZOOM_LVL_OUT_8X
Zoomed 8 times out.
Definition: zoom_type.h:27
SpriteLoader::Sprite::x_offs
int16 x_offs
The x-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:50
WarnCorruptSprite
static bool WarnCorruptSprite(uint8 file_slot, size_t file_pos, int line)
We found a corrupted sprite.
Definition: grf.cpp:34
SpriteLoader::Sprite::colours
SpriteColourComponent colours
The colour components of the sprite with useful information.
Definition: spriteloader.hpp:53
FioGetPos
size_t FioGetPos()
Get position in the current file.
Definition: fileio.cpp:59
FioReadByte
byte FioReadByte()
Read a byte from the file.
Definition: fileio.cpp:107
SCC_RGB
@ SCC_RGB
Sprite has RGB.
Definition: spriteloader.hpp:22
SpriteLoader::CommonPixel::b
uint8 b
Blue-channel.
Definition: spriteloader.hpp:36
SpriteLoader::Sprite::width
uint16 width
Width of the sprite.
Definition: spriteloader.hpp:49
SCC_MASK
@ SCC_MASK
Mask of valid colour bits.
Definition: spriteloader.hpp:25
SpriteType
SpriteType
Types of sprites that might be loaded.
Definition: gfx_type.h:301
SCC_ALPHA
@ SCC_ALPHA
Sprite has alpha.
Definition: spriteloader.hpp:23
WL_ERROR
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:24
SpriteLoader::Sprite
Structure for passing information from the sprite loader to the blitter.
Definition: spriteloader.hpp:47
_palette_remap_grf
bool _palette_remap_grf[]
Whether the given NewGRFs must get a palette remap from windows to DOS or not.
Definition: gfxinit.cpp:30
ZOOM_LVL_OUT_32X
@ ZOOM_LVL_OUT_32X
Zoomed 32 times out.
Definition: zoom_type.h:29
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:367
SpriteLoader::CommonPixel::g
uint8 g
Green-channel.
Definition: spriteloader.hpp:35
SpriteLoader::CommonPixel::a
uint8 a
Alpha-channel.
Definition: spriteloader.hpp:37
ZOOM_LVL_NORMAL
@ ZOOM_LVL_NORMAL
The normal zoom level.
Definition: zoom_type.h:24
SpriteLoader::Sprite::y_offs
int16 y_offs
The y-offset of where the sprite will be drawn.
Definition: spriteloader.hpp:51
FioSeekToFile
void FioSeekToFile(uint8 slot, size_t pos)
Switch to a different file and seek to a position.
Definition: fileio.cpp:94
ZOOM_LVL_OUT_4X
@ ZOOM_LVL_OUT_4X
Zoomed 4 times out.
Definition: zoom_type.h:26
SpriteLoader::Sprite::height
uint16 height
Height of the sprite.
Definition: spriteloader.hpp:48
ST_MAPGEN
@ ST_MAPGEN
Special sprite for the map generator.
Definition: gfx_type.h:303
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:286
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
SpriteColourComponent
SpriteColourComponent
The different colour components a sprite can have.
Definition: spriteloader.hpp:21
FioGetFilename
const char * FioGetFilename(uint8 slot)
Get the filename associated with a slot.
Definition: fileio.cpp:69