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/>.
8 /** @file gfxinit.cpp Initializing of the (GRF) graphics. */
13 #include "3rdparty/md5/md5.h"
14 #include "fontcache.h"
16 #include "transparency.h"
17 #include "blitter/factory.hpp"
18 #include "video/video_driver.hpp"
19 #include "window_func.h"
21 /* The type of set we're replacing */
22 #define SET_TYPE "graphics"
23 #include "base_media_func.h"
25 #include "table/sprites.h"
27 #include "safeguards.h"
29 /** Whether the given NewGRFs must get a palette remap from windows to DOS or not. */
30 bool _palette_remap_grf
[MAX_FILE_SLOTS
];
32 #include "table/landscape_sprite.h"
34 /** Offsets for loading the different "replacement" sprites in the files. */
35 static const SpriteID
* const _landscape_spriteindexes
[] = {
36 _landscape_spriteindexes_arctic
,
37 _landscape_spriteindexes_tropic
,
38 _landscape_spriteindexes_toyland
,
42 * Load an old fashioned GRF file.
43 * @param filename The name of the file to open.
44 * @param load_index The offset of the first sprite.
45 * @param file_index The Fio offset to load the file in.
46 * @return The number of loaded sprites.
48 static uint
LoadGrfFile(const char *filename
, uint load_index
, int file_index
)
50 uint load_index_org
= load_index
;
53 FioOpenFile(file_index
, filename
, BASESET_DIR
);
55 DEBUG(sprite
, 2, "Reading grf-file '%s'", filename
);
57 byte container_ver
= GetGRFContainerVersion();
58 if (container_ver
== 0) usererror("Base grf '%s' is corrupt", filename
);
59 ReadGRFSpriteOffsets(container_ver
);
60 if (container_ver
>= 2) {
61 /* Read compression. */
62 byte compression
= FioReadByte();
63 if (compression
!= 0) usererror("Unsupported compression format");
66 while (LoadNextSprite(load_index
, file_index
, sprite_id
, container_ver
)) {
69 if (load_index
>= MAX_SPRITES
) {
70 usererror("Too many sprites. Recompile with higher MAX_SPRITES value or remove some custom GRF files.");
73 DEBUG(sprite
, 2, "Currently %i sprites are loaded", load_index
);
75 return load_index
- load_index_org
;
79 * Load an old fashioned GRF file to replace already loaded sprites.
80 * @param filename The name of the file to open.
81 * @param index_tbl The offsets of each of the sprites.
82 * @param file_index The Fio offset to load the file in.
83 * @return The number of loaded sprites.
85 static void LoadGrfFileIndexed(const char *filename
, const SpriteID
*index_tbl
, int file_index
)
90 FioOpenFile(file_index
, filename
, BASESET_DIR
);
92 DEBUG(sprite
, 2, "Reading indexed grf-file '%s'", filename
);
94 byte container_ver
= GetGRFContainerVersion();
95 if (container_ver
== 0) usererror("Base grf '%s' is corrupt", filename
);
96 ReadGRFSpriteOffsets(container_ver
);
97 if (container_ver
>= 2) {
98 /* Read compression. */
99 byte compression
= FioReadByte();
100 if (compression
!= 0) usererror("Unsupported compression format");
103 while ((start
= *index_tbl
++) != END
) {
104 uint end
= *index_tbl
++;
107 bool b
= LoadNextSprite(start
, file_index
, sprite_id
, container_ver
);
108 (void)b
; // Unused without asserts
111 } while (++start
<= end
);
116 * Checks whether the MD5 checksums of the files are correct.
118 * @note Also checks sample.cat and other required non-NewGRF GRFs for corruption.
120 void CheckExternalFiles()
122 if (BaseGraphics::GetUsedSet() == nullptr || BaseSounds::GetUsedSet() == nullptr) return;
124 const GraphicsSet
*used_set
= BaseGraphics::GetUsedSet();
126 DEBUG(grf
, 1, "Using the %s base graphics set", used_set
->name
.c_str());
128 static const size_t ERROR_MESSAGE_LENGTH
= 256;
129 static const size_t MISSING_FILE_MESSAGE_LENGTH
= 128;
131 /* Allocate for a message for each missing file and for one error
134 char error_msg
[MISSING_FILE_MESSAGE_LENGTH
* (GraphicsSet::NUM_FILES
+ SoundsSet::NUM_FILES
) + 2 * ERROR_MESSAGE_LENGTH
];
136 char *add_pos
= error_msg
;
137 const char *last
= lastof(error_msg
);
139 if (used_set
->GetNumInvalid() != 0) {
140 /* Not all files were loaded successfully, see which ones */
141 add_pos
+= seprintf(add_pos
, last
, "Trying to load graphics set '%s', but it is incomplete. The game will probably not run correctly until you properly install this set or select another one. See section 4.1 of README.md.\n\nThe following files are corrupted or missing:\n", used_set
->name
.c_str());
142 for (uint i
= 0; i
< GraphicsSet::NUM_FILES
; i
++) {
143 MD5File::ChecksumResult res
= GraphicsSet::CheckMD5(&used_set
->files
[i
], BASESET_DIR
);
144 if (res
!= MD5File::CR_MATCH
) add_pos
+= seprintf(add_pos
, last
, "\t%s is %s (%s)\n", used_set
->files
[i
].filename
, res
== MD5File::CR_MISMATCH
? "corrupt" : "missing", used_set
->files
[i
].missing_warning
);
146 add_pos
+= seprintf(add_pos
, last
, "\n");
149 const SoundsSet
*sounds_set
= BaseSounds::GetUsedSet();
150 if (sounds_set
->GetNumInvalid() != 0) {
151 add_pos
+= seprintf(add_pos
, last
, "Trying to load sound set '%s', but it is incomplete. The game will probably not run correctly until you properly install this set or select another one. See section 4.1 of README.md.\n\nThe following files are corrupted or missing:\n", sounds_set
->name
.c_str());
153 static_assert(SoundsSet::NUM_FILES
== 1);
154 /* No need to loop each file, as long as there is only a single
156 add_pos
+= seprintf(add_pos
, last
, "\t%s is %s (%s)\n", sounds_set
->files
->filename
, SoundsSet::CheckMD5(sounds_set
->files
, BASESET_DIR
) == MD5File::CR_MISMATCH
? "corrupt" : "missing", sounds_set
->files
->missing_warning
);
159 if (add_pos
!= error_msg
) ShowInfoF("%s", error_msg
);
162 /** Actually load the sprite tables. */
163 static void LoadSpriteTables()
165 memset(_palette_remap_grf
, 0, sizeof(_palette_remap_grf
));
166 uint i
= FIRST_GRF_SLOT
;
167 const GraphicsSet
*used_set
= BaseGraphics::GetUsedSet();
169 _palette_remap_grf
[i
] = (PAL_DOS
!= used_set
->palette
);
170 LoadGrfFile(used_set
->files
[GFT_BASE
].filename
, 0, i
++);
173 * The second basic file always starts at the given location and does
174 * contain a different amount of sprites depending on the "type"; DOS
175 * has a few sprites less. However, we do not care about those missing
176 * sprites as they are not shown anyway (logos in intro game).
178 _palette_remap_grf
[i
] = (PAL_DOS
!= used_set
->palette
);
179 LoadGrfFile(used_set
->files
[GFT_LOGOS
].filename
, 4793, i
++);
182 * Load additional sprites for climates other than temperate.
183 * This overwrites some of the temperate sprites, such as foundations
184 * and the ground sprites.
186 if (_settings_game
.game_creation
.landscape
!= LT_TEMPERATE
) {
187 _palette_remap_grf
[i
] = (PAL_DOS
!= used_set
->palette
);
189 used_set
->files
[GFT_ARCTIC
+ _settings_game
.game_creation
.landscape
- 1].filename
,
190 _landscape_spriteindexes
[_settings_game
.game_creation
.landscape
- 1],
195 /* Initialize the unicode to sprite mapping table */
196 InitializeUnicodeGlyphMap();
199 * Load the base and extra NewGRF with OTTD required graphics as first NewGRF.
200 * However, we do not want it to show up in the list of used NewGRFs,
201 * so we have to manually add it, and then remove it later.
203 GRFConfig
*top
= _grfconfig
;
205 /* Default extra graphics */
206 GRFConfig
*master
= new GRFConfig("OPENTTD.GRF");
207 master
->palette
|= GRFP_GRF_DOS
;
208 FillGRFDetails(master
, false, BASESET_DIR
);
209 ClrBit(master
->flags
, GCF_INIT_ONLY
);
211 /* Baseset extra graphics */
212 GRFConfig
*extra
= new GRFConfig(used_set
->files
[GFT_EXTRA
].filename
);
214 /* We know the palette of the base set, so if the base NewGRF is not
215 * setting one, use the palette of the base set and not the global
216 * one which might be the wrong palette for this base NewGRF.
217 * The value set here might be overridden via action14 later. */
218 switch (used_set
->palette
) {
219 case PAL_DOS
: extra
->palette
|= GRFP_GRF_DOS
; break;
220 case PAL_WINDOWS
: extra
->palette
|= GRFP_GRF_WINDOWS
; break;
223 FillGRFDetails(extra
, false, BASESET_DIR
);
224 ClrBit(extra
->flags
, GCF_INIT_ONLY
);
227 master
->next
= extra
;
230 LoadNewGRF(SPR_NEWGRFS_BASE
, i
, 2);
232 uint total_extra_graphics
= SPR_NEWGRFS_BASE
- SPR_OPENTTD_BASE
;
233 _missing_extra_graphics
= GetSpriteCountForSlot(i
, SPR_OPENTTD_BASE
, SPR_NEWGRFS_BASE
);
234 DEBUG(sprite
, 1, "%u extra sprites, %u from baseset, %u from fallback", total_extra_graphics
, total_extra_graphics
- _missing_extra_graphics
, _missing_extra_graphics
);
236 /* The original baseset extra graphics intentionally make use of the fallback graphics.
237 * Let's say everything which provides less than 500 sprites misses the rest intentionally. */
238 if (500 + _missing_extra_graphics
> total_extra_graphics
) _missing_extra_graphics
= 0;
240 /* Free and remove the top element. */
248 * Check blitter needed by NewGRF config and switch if needed.
249 * @return False when nothing changed, true otherwise.
251 static bool SwitchNewGRFBlitter()
253 /* Never switch if the blitter was specified by the user. */
254 if (!_blitter_autodetected
) return false;
256 /* Null driver => dedicated server => do nothing. */
257 if (BlitterFactory::GetCurrentBlitter()->GetScreenDepth() == 0) return false;
259 /* Get preferred depth.
260 * - depth_wanted_by_base: Depth required by the baseset, i.e. the majority of the sprites.
261 * - depth_wanted_by_grf: Depth required by some NewGRF.
262 * Both can force using a 32bpp blitter. depth_wanted_by_base is used to select
263 * between multiple 32bpp blitters, which perform differently with 8bpp sprites.
265 uint depth_wanted_by_base
= BaseGraphics::GetUsedSet()->blitter
== BLT_32BPP
? 32 : 8;
266 uint depth_wanted_by_grf
= _support8bpp
== S8BPP_NONE
? 32 : 8;
267 for (GRFConfig
*c
= _grfconfig
; c
!= nullptr; c
= c
->next
) {
268 if (c
->status
== GCS_DISABLED
|| c
->status
== GCS_NOT_FOUND
|| HasBit(c
->flags
, GCF_INIT_ONLY
)) continue;
269 if (c
->palette
& GRFP_BLT_32BPP
) depth_wanted_by_grf
= 32;
272 /* Search the best blitter. */
273 static const struct {
275 uint animation
; ///< 0: no support, 1: do support, 2: both
276 uint min_base_depth
, max_base_depth
, min_grf_depth
, max_grf_depth
;
277 } replacement_blitters
[] = {
279 { "32bpp-sse4", 0, 32, 32, 8, 32 },
280 { "32bpp-ssse3", 0, 32, 32, 8, 32 },
281 { "32bpp-sse2", 0, 32, 32, 8, 32 },
282 { "32bpp-sse4-anim", 1, 32, 32, 8, 32 },
284 { "8bpp-optimized", 2, 8, 8, 8, 8 },
285 { "32bpp-optimized", 0, 8, 32, 8, 32 },
287 { "32bpp-sse2-anim", 1, 8, 32, 8, 32 },
289 { "32bpp-anim", 1, 8, 32, 8, 32 },
292 const bool animation_wanted
= HasBit(_display_opt
, DO_FULL_ANIMATION
);
293 const char *cur_blitter
= BlitterFactory::GetCurrentBlitter()->GetName();
295 VideoDriver::GetInstance()->AcquireBlitterLock();
297 for (uint i
= 0; i
< lengthof(replacement_blitters
); i
++) {
298 if (animation_wanted
&& (replacement_blitters
[i
].animation
== 0)) continue;
299 if (!animation_wanted
&& (replacement_blitters
[i
].animation
== 1)) continue;
301 if (!IsInsideMM(depth_wanted_by_base
, replacement_blitters
[i
].min_base_depth
, replacement_blitters
[i
].max_base_depth
+ 1)) continue;
302 if (!IsInsideMM(depth_wanted_by_grf
, replacement_blitters
[i
].min_grf_depth
, replacement_blitters
[i
].max_grf_depth
+ 1)) continue;
303 const char *repl_blitter
= replacement_blitters
[i
].name
;
305 if (strcmp(repl_blitter
, cur_blitter
) == 0) {
306 VideoDriver::GetInstance()->ReleaseBlitterLock();
309 if (BlitterFactory::GetBlitterFactory(repl_blitter
) == nullptr) continue;
311 DEBUG(misc
, 1, "Switching blitter from '%s' to '%s'... ", cur_blitter
, repl_blitter
);
312 Blitter
*new_blitter
= BlitterFactory::SelectBlitter(repl_blitter
);
313 if (new_blitter
== nullptr) NOT_REACHED();
314 DEBUG(misc
, 1, "Successfully switched to %s.", repl_blitter
);
318 if (!VideoDriver::GetInstance()->AfterBlitterChange()) {
319 /* Failed to switch blitter, let's hope we can return to the old one. */
320 if (BlitterFactory::SelectBlitter(cur_blitter
) == nullptr || !VideoDriver::GetInstance()->AfterBlitterChange()) usererror("Failed to reinitialize video driver. Specify a fixed blitter in the config");
323 VideoDriver::GetInstance()->ReleaseBlitterLock();
328 /** Check whether we still use the right blitter, or use another (better) one. */
331 if (!SwitchNewGRFBlitter()) return;
334 GfxClearSpriteCache();
338 /** Initialise and load all the sprites. */
339 void GfxLoadSprites()
341 DEBUG(sprite
, 2, "Loading sprite set %d", _settings_game
.game_creation
.landscape
);
343 SwitchNewGRFBlitter();
352 bool GraphicsSet::FillSetDetails(IniFile
*ini
, const char *path
, const char *full_filename
)
354 bool ret
= this->BaseSet
<GraphicsSet
, MAX_GFT
, true>::FillSetDetails(ini
, path
, full_filename
, false);
356 IniGroup
*metadata
= ini
->GetGroup("metadata");
359 fetch_metadata("palette");
360 this->palette
= ((*item
->value
)[0] == 'D' || (*item
->value
)[0] == 'd') ? PAL_DOS
: PAL_WINDOWS
;
362 /* Get optional blitter information. */
363 item
= metadata
->GetItem("blitter", false);
364 this->blitter
= (item
!= nullptr && (*item
->value
)[0] == '3') ? BLT_32BPP
: BLT_8BPP
;
370 * Calculate and check the MD5 hash of the supplied GRF.
371 * @param file The file get the hash of.
372 * @param subdir The sub directory to get the files from.
374 * - #CR_MATCH if the MD5 hash matches
375 * - #CR_MISMATCH if the MD5 does not match
376 * - #CR_NO_FILE if the file misses
378 /* static */ MD5File::ChecksumResult
GraphicsSet::CheckMD5(const MD5File
*file
, Subdirectory subdir
)
381 FILE *f
= FioFOpenFile(file
->filename
, "rb", subdir
, &size
);
382 if (f
== nullptr) return MD5File::CR_NO_FILE
;
384 size_t max
= GRFGetSizeOfDataSection(f
);
388 return file
->CheckMD5(subdir
, max
);
393 * Calculate and check the MD5 hash of the supplied filename.
394 * @param subdir The sub directory to get the files from
395 * @param max_size Only calculate the hash for this many bytes from the file start.
397 * - #CR_MATCH if the MD5 hash matches
398 * - #CR_MISMATCH if the MD5 does not match
399 * - #CR_NO_FILE if the file misses
401 MD5File::ChecksumResult
MD5File::CheckMD5(Subdirectory subdir
, size_t max_size
) const
404 FILE *f
= FioFOpenFile(this->filename
, "rb", subdir
, &size
);
406 if (f
== nullptr) return CR_NO_FILE
;
408 size
= std::min(size
, max_size
);
415 while ((len
= fread(buffer
, 1, (size
> sizeof(buffer
)) ? sizeof(buffer
) : size
, f
)) != 0 && size
!= 0) {
417 checksum
.Append(buffer
, len
);
422 checksum
.Finish(digest
);
423 return memcmp(this->hash
, digest
, sizeof(this->hash
)) == 0 ? CR_MATCH
: CR_MISMATCH
;
426 /** Names corresponding to the GraphicsFileType */
427 static const char * const _graphics_file_names
[] = { "base", "logos", "arctic", "tropical", "toyland", "extra" };
429 /** Implementation */
430 template <class T
, size_t Tnum_files
, bool Tsearch_in_tars
>
431 /* static */ const char * const *BaseSet
<T
, Tnum_files
, Tsearch_in_tars
>::file_names
= _graphics_file_names
;
433 template <class Tbase_set
>
434 /* static */ bool BaseMedia
<Tbase_set
>::DetermineBestSet()
436 if (BaseMedia
<Tbase_set
>::used_set
!= nullptr) return true;
438 const Tbase_set
*best
= nullptr;
439 for (const Tbase_set
*c
= BaseMedia
<Tbase_set
>::available_sets
; c
!= nullptr; c
= c
->next
) {
440 /* Skip unusable sets */
441 if (c
->GetNumMissing() != 0) continue;
443 if (best
== nullptr ||
444 (best
->fallback
&& !c
->fallback
) ||
445 best
->valid_files
< c
->valid_files
||
446 (best
->valid_files
== c
->valid_files
&& (
447 (best
->shortname
== c
->shortname
&& best
->version
< c
->version
) ||
448 (best
->palette
!= PAL_DOS
&& c
->palette
== PAL_DOS
)))) {
453 BaseMedia
<Tbase_set
>::used_set
= best
;
454 return BaseMedia
<Tbase_set
>::used_set
!= nullptr;
457 template <class Tbase_set
>
458 /* static */ const char *BaseMedia
<Tbase_set
>::GetExtension()
460 return ".obg"; // OpenTTD Base Graphics
463 INSTANTIATE_BASE_MEDIA_METHODS(BaseMedia
<GraphicsSet
>, GraphicsSet
)