diff --git a/src/newgrf.c b/src/newgrf.c deleted file mode 100644 --- a/src/newgrf.c +++ /dev/null @@ -1,3772 +0,0 @@ -/* $Id$ */ - -#include "stdafx.h" - -#include - -#include "openttd.h" -#include "debug.h" -#include "gfx.h" -#include "fileio.h" -#include "functions.h" -#include "engine.h" -#include "spritecache.h" -#include "station.h" -#include "sprite.h" -#include "newgrf.h" -#include "variables.h" -#include "string.h" -#include "table/strings.h" -#include "bridge.h" -#include "economy.h" -#include "newgrf_engine.h" -#include "vehicle.h" -#include "newgrf_text.h" -#include "table/sprites.h" -#include "fontcache.h" -#include "date.h" -#include "currency.h" -#include "sound.h" -#include "newgrf_config.h" -#include "newgrf_sound.h" -#include "newgrf_spritegroup.h" - -/* TTDPatch extended GRF format codec - * (c) Petr Baudis 2004 (GPL'd) - * Changes by Florian octo Forster are (c) by the OpenTTD development team. - * - * Contains portions of documentation by TTDPatch team. - * Thanks especially to Josef Drexler for the documentation as well as a lot - * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which - * served as subject to the initial testing of this codec. */ - - -static int _skip_sprites; // XXX -static uint _file_index; // XXX -SpriteID _signal_base; -SpriteID _coast_base; - -static GRFFile *_cur_grffile; -GRFFile *_first_grffile; -static SpriteID _cur_spriteid; -static GrfLoadingStage _cur_stage; -static uint32 _nfo_line; - -static GRFConfig *_cur_grfconfig; - -/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */ -static byte _misc_grf_features = 0; - -/* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */ -static uint32 _ttdpatch_flags[8]; - -/* Used by Action 0x06 to preload a pseudo sprite and modify its content */ -static byte *_preload_sprite = NULL; - -/* Set if any vehicle is loaded which uses 2cc (two company colours) */ -bool _have_2cc = false; - - -typedef enum GrfDataType { - GDT_SOUND, -} GrfDataType; - -static byte _grf_data_blocks; -static GrfDataType _grf_data_type; - - -typedef enum grfspec_feature { - GSF_TRAIN, - GSF_ROAD, - GSF_SHIP, - GSF_AIRCRAFT, - GSF_STATION, - GSF_CANAL, - GSF_BRIDGE, - GSF_TOWNHOUSE, - GSF_GLOBALVAR, - GSF_INDUSTRYTILES, - GSF_INDUSTRIES, - GSF_CARGOS, - GSF_SOUNDFX, -} grfspec_feature; - - -typedef void (*SpecialSpriteHandler)(byte *buf, int len); - -static const int _vehcounts[4] = { - /* GSF_TRAIN */ NUM_TRAIN_ENGINES, - /* GSF_ROAD */ NUM_ROAD_ENGINES, - /* GSF_SHIP */ NUM_SHIP_ENGINES, - /* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES -}; - -static const int _vehshifts[4] = { - /* GSF_TRAIN */ 0, - /* GSF_ROAD */ ROAD_ENGINES_INDEX, - /* GSF_SHIP */ SHIP_ENGINES_INDEX, - /* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX, -}; - -enum { - MAX_STATIONS = 256, -}; - -static uint16 cargo_allowed[TOTAL_NUM_ENGINES]; -static uint16 cargo_disallowed[TOTAL_NUM_ENGINES]; - -/* Contains the GRF ID of the owner of a vehicle if it has been reserved */ -static uint32 _grm_engines[TOTAL_NUM_ENGINES]; - -/** DEBUG() function dedicated to newGRF debugging messages - * Function is essentialy the same as DEBUG(grf, severity, ...) with the - * addition of file:line information when parsing grf files. - * NOTE: for the above reason(s) grfmsg() should ONLY be used for - * loading/parsing grf files, not for runtime debug messages as there - * is no file information available during that time. - * @param severity debugging severity level, see debug.h - * @param debugging message in printf() format */ -void CDECL grfmsg(int severity, const char *str, ...) -{ - char buf[1024]; - va_list va; - - va_start(va, str); - vsnprintf(buf, sizeof(buf), str, va); - va_end(va); - - DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf); -} - -static inline void check_length(int real, int wanted, const char *str) -{ - if (real >= wanted) return; - grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted); -} - -static inline byte grf_load_byte(byte **buf) -{ - return *(*buf)++; -} - -static uint16 grf_load_word(byte **buf) -{ - uint16 val = grf_load_byte(buf); - return val | (grf_load_byte(buf) << 8); -} - -static uint16 grf_load_extended(byte** buf) -{ - uint16 val; - val = grf_load_byte(buf); - if (val == 0xFF) val = grf_load_word(buf); - return val; -} - -static uint32 grf_load_dword(byte **buf) -{ - uint32 val = grf_load_word(buf); - return val | (grf_load_word(buf) << 16); -} - -static uint32 grf_load_var(byte size, byte **buf) -{ - switch (size) { - case 1: return grf_load_byte(buf); - case 2: return grf_load_word(buf); - case 4: return grf_load_dword(buf); - default: - NOT_REACHED(); - return 0; - } -} - -static GRFFile *GetFileByGRFID(uint32 grfid) -{ - GRFFile *file; - - for (file = _first_grffile; file != NULL; file = file->next) { - if (file->grfid == grfid) break; - } - return file; -} - -static GRFFile *GetFileByFilename(const char *filename) -{ - GRFFile *file; - - for (file = _first_grffile; file != NULL; file = file->next) { - if (strcmp(file->filename, filename) == 0) break; - } - return file; -} - - -typedef bool (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len); - -#define FOR_EACH_OBJECT for (i = 0; i < numinfo; i++) - -static void dewagonize(int condition, int engine) -{ - EngineInfo *ei = &_engine_info[engine]; - RailVehicleInfo *rvi = &_rail_vehicle_info[engine]; - - if (condition != 0) { - ei->unk2 &= ~0x80; - rvi->flags &= ~2; - } else { - ei->unk2 |= 0x80; - rvi->flags |= 2; - } -} - -static bool RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) -{ - EngineInfo *ei = &_engine_info[engine]; - RailVehicleInfo *rvi = &_rail_vehicle_info[engine]; - byte *buf = *bufp; - int i; - bool ret = false; - - switch (prop) { - case 0x05: /* Track type */ - FOR_EACH_OBJECT { - uint8 tracktype = grf_load_byte(&buf); - - switch (tracktype) { - case 0: ei[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break; - case 1: ei[i].railtype = RAILTYPE_MONO; break; - case 2: ei[i].railtype = RAILTYPE_MAGLEV; break; - default: - grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype); - break; - } - } - break; - - case 0x08: /* AI passenger service */ - /* TODO */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - case 0x09: /* Speed (1 unit is 1 kmh) */ - FOR_EACH_OBJECT { - uint16 speed = grf_load_word(&buf); - if (speed == 0xFFFF) speed = 0; - - rvi[i].max_speed = speed; - } - break; - - case 0x0B: /* Power */ - FOR_EACH_OBJECT { - uint16 power = grf_load_word(&buf); - - if (rvi[i].flags & RVI_MULTIHEAD) power /= 2; - - rvi[i].power = power; - dewagonize(power, engine + i); - } - break; - - case 0x0D: /* Running cost factor */ - FOR_EACH_OBJECT { - uint8 runcostfact = grf_load_byte(&buf); - - if (rvi[i].flags & RVI_MULTIHEAD) runcostfact /= 2; - - rvi[i].running_cost_base = runcostfact; - } - break; - - case 0x0E: /* Running cost base */ - FOR_EACH_OBJECT { - uint32 base = grf_load_dword(&buf); - - switch (base) { - case 0x4C30: rvi[i].running_cost_class = 0; break; - case 0x4C36: rvi[i].running_cost_class = 1; break; - case 0x4C3C: rvi[i].running_cost_class = 2; break; - case 0: break; /* Used by wagons */ - default: - grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base); - break; - } - } - break; - - case 0x12: /* Sprite ID */ - FOR_EACH_OBJECT { - uint8 spriteid = grf_load_byte(&buf); - - /* TTD sprite IDs point to a location in a 16bit array, but we use it - * as an array index, so we need it to be half the original value. */ - if (spriteid < 0xFD) spriteid >>= 1; - - rvi[i].image_index = spriteid; - } - break; - - case 0x13: /* Dual-headed */ - FOR_EACH_OBJECT { - uint8 dual = grf_load_byte(&buf); - - if (dual != 0) { - if (!(rvi[i].flags & RVI_MULTIHEAD)) { - // adjust power and running cost if needed - rvi[i].power /= 2; - rvi[i].running_cost_base /= 2; - } - rvi[i].flags |= RVI_MULTIHEAD; - } else { - if (rvi[i].flags & RVI_MULTIHEAD) { - // adjust power and running cost if needed - rvi[i].power *= 2; - rvi[i].running_cost_base *= 2; - } - rvi[i].flags &= ~RVI_MULTIHEAD; - } - } - break; - - case 0x14: /* Cargo capacity */ - FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf); - break; - - case 0x15: /* Cargo type */ - FOR_EACH_OBJECT { - uint8 ctype = grf_load_byte(&buf); - - if (ctype < NUM_CARGO) { - rvi[i].cargo_type = ctype; - } else { - grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, ignoring", ctype); - } - } - break; - - case 0x16: /* Weight */ - FOR_EACH_OBJECT SB(rvi[i].weight, 0, 8, grf_load_byte(&buf)); - break; - - case 0x17: /* Cost factor */ - FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf); - break; - - case 0x18: /* AI rank */ - FOR_EACH_OBJECT rvi[i].ai_rank = grf_load_byte(&buf); - break; - - case 0x19: /* Engine traction type */ - /* What do the individual numbers mean? - * 0x00 .. 0x07: Steam - * 0x08 .. 0x27: Diesel - * 0x28 .. 0x31: Electric - * 0x32 .. 0x37: Monorail - * 0x38 .. 0x41: Maglev - */ - FOR_EACH_OBJECT { - uint8 traction = grf_load_byte(&buf); - int engclass; - - if (traction <= 0x07) { - engclass = 0; - } else if (traction <= 0x27) { - engclass = 1; - } else if (traction <= 0x31) { - engclass = 2; - } else if (traction <= 0x41) { - engclass = 2; - } else { - break; - } - if (ei[i].railtype == RAILTYPE_RAIL && engclass == 2) ei[i].railtype = RAILTYPE_ELECTRIC; - if (ei[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) ei[i].railtype = RAILTYPE_RAIL; - - rvi[i].engclass = engclass; - } - break; - - case 0x1A: /* Alter purchase list sort order */ - FOR_EACH_OBJECT { - EngineID pos = grf_load_byte(&buf); - - if (pos < NUM_TRAIN_ENGINES) { - AlterRailVehListOrder(engine + i, pos); - } else { - grfmsg(2, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring", pos); - } - } - break; - - case 0x1B: /* Powered wagons power bonus */ - FOR_EACH_OBJECT rvi[i].pow_wag_power = grf_load_word(&buf); - break; - - case 0x1C: /* Refit cost */ - FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf); - break; - - case 0x1D: /* Refit cargo */ - FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf); - break; - - case 0x1E: /* Callback */ - FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf); - break; - - case 0x1F: /* Tractive effort coefficient */ - FOR_EACH_OBJECT rvi[i].tractive_effort = grf_load_byte(&buf); - break; - - case 0x21: /* Shorter vehicle */ - FOR_EACH_OBJECT rvi[i].shorten_factor = grf_load_byte(&buf); - break; - - case 0x22: /* Visual effect */ - // see note in engine.h about rvi->visual_effect - FOR_EACH_OBJECT rvi[i].visual_effect = grf_load_byte(&buf); - break; - - case 0x23: /* Powered wagons weight bonus */ - FOR_EACH_OBJECT rvi[i].pow_wag_weight = grf_load_byte(&buf); - break; - - case 0x24: /* High byte of vehicle weight */ - FOR_EACH_OBJECT { - byte weight = grf_load_byte(&buf); - - if (weight > 4) { - grfmsg(2, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring", weight << 8); - } else { - SB(rvi[i].weight, 8, 8, weight); - } - } - break; - - case 0x25: /* User-defined bit mask to set when checking veh. var. 42 */ - FOR_EACH_OBJECT rvi[i].user_def_data = grf_load_byte(&buf); - break; - - case 0x27: /* Miscellaneous flags */ - FOR_EACH_OBJECT { - ei[i].misc_flags = grf_load_byte(&buf); - if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true; - } - break; - - case 0x28: /* Cargo classes allowed */ - FOR_EACH_OBJECT cargo_allowed[engine + i] = grf_load_word(&buf); - break; - - case 0x29: /* Cargo classes disallowed */ - FOR_EACH_OBJECT cargo_disallowed[engine + i] = grf_load_word(&buf); - break; - - case 0x2A: /* Long format introduction date (days since year 0) */ - FOR_EACH_OBJECT ei[i].base_intro = grf_load_dword(&buf); - break; - - /* TODO */ - /* Fall-through for unimplemented one byte long properties. */ - case 0x20: /* Air drag */ - case 0x26: /* Retire vehicle early */ - /* TODO */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - default: - ret = true; - break; - } - *bufp = buf; - return ret; -} - -static bool RoadVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) -{ - EngineInfo *ei = &_engine_info[ROAD_ENGINES_INDEX + engine]; - RoadVehicleInfo *rvi = &_road_vehicle_info[engine]; - byte *buf = *bufp; - int i; - bool ret = false; - - switch (prop) { - case 0x08: /* Speed (1 unit is 0.5 kmh) */ - FOR_EACH_OBJECT rvi[i].max_speed = grf_load_byte(&buf); - break; - - case 0x09: /* Running cost factor */ - FOR_EACH_OBJECT rvi[i].running_cost = grf_load_byte(&buf); - break; - - case 0x0A: /* Running cost base */ - /* TODO: I have no idea. --pasky */ - FOR_EACH_OBJECT grf_load_dword(&buf); - ret = true; - break; - - case 0x0E: /* Sprite ID */ - FOR_EACH_OBJECT { - uint8 spriteid = grf_load_byte(&buf); - - // cars have different custom id in the GRF file - if (spriteid == 0xFF) spriteid = 0xFD; - - if (spriteid < 0xFD) spriteid >>= 1; - - rvi[i].image_index = spriteid; - } - break; - - case 0x0F: /* Cargo capacity */ - FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf); - break; - - case 0x10: /* Cargo type */ - FOR_EACH_OBJECT { - uint8 cargo = grf_load_byte(&buf); - - if (cargo < NUM_CARGO) { - rvi[i].cargo_type = cargo; - } else { - grfmsg(2, "RoadVehicleChangeInfo: Invalid cargo type %d, ignoring", cargo); - } - } - break; - - case 0x11: /* Cost factor */ - FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf); // ?? is it base_cost? - break; - - case 0x12: /* SFX */ - FOR_EACH_OBJECT rvi[i].sfx = grf_load_byte(&buf); - break; - - case 0x13: /* Power in 10hp */ - case 0x14: /* Weight in 1/4 tons */ - case 0x15: /* Speed in mph*0.8 */ - /* TODO: Support for road vehicles realistic power - * computations (called rvpower in TTDPatch) is just - * missing in OTTD yet. --pasky */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - case 0x16: /* Cargos available for refitting */ - FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf); - break; - - case 0x17: /* Callback mask */ - FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf); - break; - - case 0x1A: /* Refit cost */ - FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf); - break; - - case 0x1C: /* Miscellaneous flags */ - FOR_EACH_OBJECT { - ei[i].misc_flags = grf_load_byte(&buf); - if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true; - } - break; - - case 0x1D: /* Cargo classes allowed */ - FOR_EACH_OBJECT cargo_allowed[ROAD_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x1E: /* Cargo classes disallowed */ - FOR_EACH_OBJECT cargo_disallowed[ROAD_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x1F: /* Long format introduction date (days since year 0) */ - FOR_EACH_OBJECT ei[i].base_intro = grf_load_dword(&buf); - break; - - case 0x18: /* Tractive effort */ - case 0x19: /* Air drag */ - case 0x1B: /* Retire vehicle early */ - /* TODO */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - default: - ret = true; - break; - } - - *bufp = buf; - return ret; -} - -static bool ShipVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) -{ - EngineInfo *ei = &_engine_info[SHIP_ENGINES_INDEX + engine]; - ShipVehicleInfo *svi = &_ship_vehicle_info[engine]; - byte *buf = *bufp; - int i; - bool ret = false; - - //printf("e %x prop %x?\n", engine, prop); - switch (prop) { - case 0x08: /* Sprite ID */ - FOR_EACH_OBJECT { - uint8 spriteid = grf_load_byte(&buf); - - // ships have different custom id in the GRF file - if (spriteid == 0xFF) spriteid = 0xFD; - - if (spriteid < 0xFD) spriteid >>= 1; - - svi[i].image_index = spriteid; - } - break; - - case 0x09: /* Refittable */ - FOR_EACH_OBJECT svi[i].refittable = grf_load_byte(&buf); - break; - - case 0x0A: /* Cost factor */ - FOR_EACH_OBJECT svi[i].base_cost = grf_load_byte(&buf); // ?? is it base_cost? - break; - - case 0x0B: /* Speed (1 unit is 0.5 kmh) */ - FOR_EACH_OBJECT svi[i].max_speed = grf_load_byte(&buf); - break; - - case 0x0C: /* Cargo type */ - FOR_EACH_OBJECT { - uint8 cargo = grf_load_byte(&buf); - - // XXX: Need to consult this with patchman yet. -#if 0 - // Documentation claims this is already the - // per-landscape cargo type id, but newships.grf - // assume otherwise. - cargo = local_cargo_id_ctype[cargo]; -#endif - if (cargo < NUM_CARGO) { - svi[i].cargo_type = cargo; - } else { - grfmsg(2, "ShipVehicleChangeInfo: Invalid cargo type %d, ignoring", cargo); - } - } - break; - - case 0x0D: /* Cargo capacity */ - FOR_EACH_OBJECT svi[i].capacity = grf_load_word(&buf); - break; - - case 0x0F: /* Running cost factor */ - FOR_EACH_OBJECT svi[i].running_cost = grf_load_byte(&buf); - break; - - case 0x10: /* SFX */ - FOR_EACH_OBJECT svi[i].sfx = grf_load_byte(&buf); - break; - - case 0x11: /* Cargos available for refitting */ - FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf); - break; - - case 0x12: /* Callback mask */ - FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf); - break; - - case 0x13: /* Refit cost */ - FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf); - break; - - case 0x17: /* Miscellaneous flags */ - FOR_EACH_OBJECT { - ei[i].misc_flags = grf_load_byte(&buf); - if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true; - } - break; - - case 0x18: /* Cargo classes allowed */ - FOR_EACH_OBJECT cargo_allowed[SHIP_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x19: /* Cargo classes disallowed */ - FOR_EACH_OBJECT cargo_disallowed[SHIP_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x1A: /* Long format introduction date (days since year 0) */ - FOR_EACH_OBJECT ei[i].base_intro = grf_load_dword(&buf); - break; - - case 0x14: /* Ocean speed fraction */ - case 0x15: /* Canal speed fraction */ - case 0x16: /* Retire vehicle early */ - /* TODO */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - default: - ret = true; - break; - } - - *bufp = buf; - return ret; -} - -static bool AircraftVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len) -{ - EngineInfo *ei = &_engine_info[AIRCRAFT_ENGINES_INDEX + engine]; - AircraftVehicleInfo *avi = &_aircraft_vehicle_info[engine]; - byte *buf = *bufp; - int i; - bool ret = false; - - //printf("e %x prop %x?\n", engine, prop); - switch (prop) { - case 0x08: /* Sprite ID */ - FOR_EACH_OBJECT { - uint8 spriteid = grf_load_byte(&buf); - - // aircraft have different custom id in the GRF file - if (spriteid == 0xFF) spriteid = 0xFD; - - if (spriteid < 0xFD) spriteid >>= 1; - - avi[i].image_index = spriteid; - } - break; - - case 0x09: /* Helicopter */ - FOR_EACH_OBJECT { - if (grf_load_byte(&buf) == 0) { - avi[i].subtype = 0; - } else { - SB(avi[i].subtype, 0, 1, 1); - } - } - break; - - case 0x0A: /* Large */ - FOR_EACH_OBJECT SB(avi[i].subtype, 1, 1, (grf_load_byte(&buf) != 0 ? 1 : 0)); - break; - - case 0x0B: /* Cost factor */ - FOR_EACH_OBJECT avi[i].base_cost = grf_load_byte(&buf); // ?? is it base_cost? - break; - - case 0x0C: /* Speed (1 unit is 8 mph) */ - FOR_EACH_OBJECT avi[i].max_speed = grf_load_byte(&buf); - break; - - case 0x0D: /* Acceleration */ - FOR_EACH_OBJECT avi[i].acceleration = grf_load_byte(&buf); - break; - - case 0x0E: /* Running cost factor */ - FOR_EACH_OBJECT avi[i].running_cost = grf_load_byte(&buf); - break; - - case 0x0F: /* Passenger capacity */ - FOR_EACH_OBJECT avi[i].passenger_capacity = grf_load_word(&buf); - break; - - case 0x11: /* Mail capacity */ - FOR_EACH_OBJECT avi[i].mail_capacity = grf_load_byte(&buf); - break; - - case 0x12: /* SFX */ - FOR_EACH_OBJECT avi[i].sfx = grf_load_byte(&buf); - break; - - case 0x13: /* Cargos available for refitting */ - FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf); - break; - - case 0x14: /* Callback mask */ - FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf); - break; - - case 0x15: /* Refit cost */ - FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf); - break; - - case 0x17: /* Miscellaneous flags */ - FOR_EACH_OBJECT { - ei[i].misc_flags = grf_load_byte(&buf); - if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true; - } - break; - - case 0x18: /* Cargo classes allowed */ - FOR_EACH_OBJECT cargo_allowed[AIRCRAFT_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x19: /* Cargo classes disallowed */ - FOR_EACH_OBJECT cargo_disallowed[AIRCRAFT_ENGINES_INDEX + engine + i] = grf_load_word(&buf); - break; - - case 0x1A: /* Long format introduction date (days since year 0) */ - FOR_EACH_OBJECT ei[i].base_intro = grf_load_dword(&buf); - break; - - case 0x16: /* Retire vehicle early */ - /* TODO */ - FOR_EACH_OBJECT grf_load_byte(&buf); - ret = true; - break; - - default: - ret = true; - break; - } - - *bufp = buf; - return ret; -} - -static bool StationChangeInfo(uint stid, int numinfo, int prop, byte **bufp, int len) -{ - StationSpec **statspec; - byte *buf = *bufp; - int i; - bool ret = false; - - if (stid + numinfo > MAX_STATIONS) { - grfmsg(1, "StationChangeInfo: Station %u is invalid, max %u, ignoring", stid + numinfo, MAX_STATIONS); - return false; - } - - /* Allocate station specs if necessary */ - if (_cur_grffile->stations == NULL) _cur_grffile->stations = calloc(MAX_STATIONS, sizeof(*_cur_grffile->stations)); - - statspec = &_cur_grffile->stations[stid]; - - if (prop != 0x08) { - /* Check that all stations we are modifying are defined. */ - FOR_EACH_OBJECT { - if (statspec[i] == NULL) { - grfmsg(2, "StationChangeInfo: Attempt to modify undefined station %u, ignoring", stid + i); - return false; - } - } - } - - switch (prop) { - case 0x08: /* Class ID */ - FOR_EACH_OBJECT { - uint32 classid; - - /* Property 0x08 is special; it is where the station is allocated */ - if (statspec[i] == NULL) statspec[i] = calloc(1, sizeof(*statspec[i])); - - /* Swap classid because we read it in BE meaning WAYP or DFLT */ - classid = grf_load_dword(&buf); - statspec[i]->sclass = AllocateStationClass(BSWAP32(classid)); - } - break; - - case 0x09: /* Define sprite layout */ - FOR_EACH_OBJECT { - StationSpec *statspec = _cur_grffile->stations[stid + i]; - uint t; - - statspec->tiles = grf_load_extended(&buf); - statspec->renderdata = calloc(statspec->tiles, sizeof(*statspec->renderdata)); - statspec->copied_renderdata = false; - - for (t = 0; t < statspec->tiles; t++) { - DrawTileSprites *dts = &statspec->renderdata[t]; - uint seq_count = 0; - - dts->seq = NULL; - dts->ground_sprite = grf_load_dword(&buf); - if (dts->ground_sprite == 0) continue; - - while (buf < *bufp + len) { - DrawTileSeqStruct *dtss; - - // no relative bounding box support - dts->seq = realloc((void*)dts->seq, ++seq_count * sizeof(DrawTileSeqStruct)); - dtss = (DrawTileSeqStruct*) &dts->seq[seq_count - 1]; - - dtss->delta_x = grf_load_byte(&buf); - if ((byte) dtss->delta_x == 0x80) break; - dtss->delta_y = grf_load_byte(&buf); - dtss->delta_z = grf_load_byte(&buf); - dtss->size_x = grf_load_byte(&buf); - dtss->size_y = grf_load_byte(&buf); - dtss->size_z = grf_load_byte(&buf); - dtss->image = grf_load_dword(&buf); - - /* Remap flags as ours collide */ - if (HASBIT(dtss->image, 31)) { - CLRBIT(dtss->image, 31); - SETBIT(dtss->image, 30); - } - if (HASBIT(dtss->image, 14)) { - CLRBIT(dtss->image, 14); - SETBIT(dtss->image, 31); - } - } - } - } - break; - - case 0x0A: /* Copy sprite layout */ - FOR_EACH_OBJECT { - StationSpec *statspec = _cur_grffile->stations[stid + i]; - byte srcid = grf_load_byte(&buf); - const StationSpec *srcstatspec = _cur_grffile->stations[srcid]; - - statspec->tiles = srcstatspec->tiles; - statspec->renderdata = srcstatspec->renderdata; - statspec->copied_renderdata = true; - } - break; - - case 0x0B: /* Callback mask */ - FOR_EACH_OBJECT statspec[i]->callbackmask = grf_load_byte(&buf); - break; - - case 0x0C: /* Disallowed number of platforms */ - FOR_EACH_OBJECT statspec[i]->disallowed_platforms = grf_load_byte(&buf); - break; - - case 0x0D: /* Disallowed platform lengths */ - FOR_EACH_OBJECT statspec[i]->disallowed_lengths = grf_load_byte(&buf); - break; - - case 0x0E: /* Define custom layout */ - FOR_EACH_OBJECT { - StationSpec *statspec = _cur_grffile->stations[stid + i]; - - statspec->copied_layouts = false; - - while (buf < *bufp + len) { - byte length = grf_load_byte(&buf); - byte number = grf_load_byte(&buf); - StationLayout layout; - uint l, p; - - if (length == 0 || number == 0) break; - - //debug("l %d > %d ?", length, stat->lengths); - if (length > statspec->lengths) { - statspec->platforms = realloc(statspec->platforms, length); - memset(statspec->platforms + statspec->lengths, 0, length - statspec->lengths); - - statspec->layouts = realloc(statspec->layouts, length * sizeof(*statspec->layouts)); - memset(statspec->layouts + statspec->lengths, 0, - (length - statspec->lengths) * sizeof(*statspec->layouts)); - - statspec->lengths = length; - } - l = length - 1; // index is zero-based - - //debug("p %d > %d ?", number, stat->platforms[l]); - if (number > statspec->platforms[l]) { - statspec->layouts[l] = realloc(statspec->layouts[l], - number * sizeof(**statspec->layouts)); - // We expect NULL being 0 here, but C99 guarantees that. - memset(statspec->layouts[l] + statspec->platforms[l], 0, - (number - statspec->platforms[l]) * sizeof(**statspec->layouts)); - - statspec->platforms[l] = number; - } - - p = 0; - layout = malloc(length * number); - for (l = 0; l < length; l++) { - for (p = 0; p < number; p++) { - layout[l * number + p] = grf_load_byte(&buf); - } - } - - l--; - p--; - free(statspec->layouts[l][p]); - statspec->layouts[l][p] = layout; - } - } - break; - - case 0x0F: /* Copy custom layout */ - FOR_EACH_OBJECT { - StationSpec *statspec = _cur_grffile->stations[stid + i]; - byte srcid = grf_load_byte(&buf); - const StationSpec *srcstatspec = _cur_grffile->stations[srcid]; - - statspec->lengths = srcstatspec->lengths; - statspec->platforms = srcstatspec->platforms; - statspec->layouts = srcstatspec->layouts; - statspec->copied_layouts = true; - } - break; - - case 0x10: /* Little/lots cargo threshold */ - FOR_EACH_OBJECT statspec[i]->cargo_threshold = grf_load_word(&buf); - break; - - case 0x11: /* Pylon placement */ - FOR_EACH_OBJECT statspec[i]->pylons = grf_load_byte(&buf); - break; - - case 0x12: /* Cargo types for random triggers */ - FOR_EACH_OBJECT statspec[i]->cargo_triggers = grf_load_dword(&buf); - break; - - case 0x13: /* General flags */ - FOR_EACH_OBJECT statspec[i]->flags = grf_load_byte(&buf); - break; - - case 0x14: /* Overhead wire placement */ - FOR_EACH_OBJECT statspec[i]->wires = grf_load_byte(&buf); - break; - - case 0x15: /* Blocked tiles */ - FOR_EACH_OBJECT statspec[i]->blocked = grf_load_byte(&buf); - break; - - default: - ret = true; - break; - } - - *bufp = buf; - return ret; -} - -static bool BridgeChangeInfo(uint brid, int numinfo, int prop, byte **bufp, int len) -{ - byte *buf = *bufp; - int i; - bool ret = false; - - switch (prop) { - case 0x08: /* Year of availability */ - FOR_EACH_OBJECT _bridge[brid + i].avail_year = ORIGINAL_BASE_YEAR + grf_load_byte(&buf); - break; - - case 0x09: /* Minimum length */ - FOR_EACH_OBJECT _bridge[brid + i].min_length = grf_load_byte(&buf); - break; - - case 0x0A: /* Maximum length */ - FOR_EACH_OBJECT _bridge[brid + i].max_length = grf_load_byte(&buf); - break; - - case 0x0B: /* Cost factor */ - FOR_EACH_OBJECT _bridge[brid + i].price = grf_load_byte(&buf); - break; - - case 0x0C: /* Maximum speed */ - FOR_EACH_OBJECT _bridge[brid + i].speed = grf_load_word(&buf); - break; - - case 0x0D: /* Bridge sprite tables */ - FOR_EACH_OBJECT { - Bridge *bridge = &_bridge[brid + i]; - byte tableid = grf_load_byte(&buf); - byte numtables = grf_load_byte(&buf); - - if (bridge->sprite_table == NULL) { - /* Allocate memory for sprite table pointers and zero out */ - bridge->sprite_table = calloc(7, sizeof(*bridge->sprite_table)); - } - - for (; numtables-- != 0; tableid++) { - byte sprite; - - if (tableid >= 7) { // skip invalid data - grfmsg(1, "BridgeChangeInfo: Table %d >= 7, skipping", tableid); - for (sprite = 0; sprite < 32; sprite++) grf_load_dword(&buf); - continue; - } - - if (bridge->sprite_table[tableid] == NULL) { - bridge->sprite_table[tableid] = malloc(32 * sizeof(**bridge->sprite_table)); - } - - for (sprite = 0; sprite < 32; sprite++) - bridge->sprite_table[tableid][sprite] = grf_load_dword(&buf); - } - } - break; - - case 0x0E: /* Flags; bit 0 - disable far pillars */ - FOR_EACH_OBJECT _bridge[brid + i].flags = grf_load_byte(&buf); - break; - - case 0x0F: /* Long format year of availability (year since year 0) */ - FOR_EACH_OBJECT _bridge[brid + i].avail_year = clamp(grf_load_dword(&buf), MIN_YEAR, MAX_YEAR); - break; - - default: - ret = true; - } - - *bufp = buf; - return ret; -} - -static bool GlobalVarChangeInfo(uint gvid, int numinfo, int prop, byte **bufp, int len) -{ - byte *buf = *bufp; - int i; - bool ret = false; - - switch (prop) { - case 0x08: /* Cost base factor */ - FOR_EACH_OBJECT { - byte factor = grf_load_byte(&buf); - uint price = gvid + i; - - if (price < NUM_PRICES) { - SetPriceBaseMultiplier(price, factor); - } else { - grfmsg(1, "GlobalVarChangeInfo: Price %d out of range, ignoring", price); - } - } - break; - - case 0x0A: // Currency display names - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - StringID newone = GetGRFStringID(_cur_grffile->grfid, grf_load_word(&buf)); - - if ((newone != STR_UNDEFINED) && (curidx < NUM_CURRENCY)) { - _currency_specs[curidx].name = newone; - } - } - break; - - case 0x0B: // Currency multipliers - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - uint32 rate = grf_load_dword(&buf); - - if (curidx < NUM_CURRENCY) { - /* TTDPatch uses a multiple of 1000 for its conversion calculations, - * which OTTD does not. For this reason, divide grf value by 1000, - * to be compatible */ - _currency_specs[curidx].rate = rate / 1000; - } else { - grfmsg(1, "GlobalVarChangeInfo: Currency multipliers %d out of range, ignoring", curidx); - } - } - break; - - case 0x0C: // Currency options - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - uint16 options = grf_load_word(&buf); - - if (curidx < NUM_CURRENCY) { - _currency_specs[curidx].separator = GB(options, 0, 8); - /* By specifying only one bit, we prevent errors, - * since newgrf specs said that only 0 and 1 can be set for symbol_pos */ - _currency_specs[curidx].symbol_pos = GB(options, 8, 1); - } else { - grfmsg(1, "GlobalVarChangeInfo: Currency option %d out of range, ignoring", curidx); - } - } - break; - - case 0x0D: // Currency prefix symbol - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - uint32 tempfix = grf_load_dword(&buf); - - if (curidx < NUM_CURRENCY) { - memcpy(_currency_specs[curidx].prefix,&tempfix,4); - _currency_specs[curidx].prefix[4] = 0; - } else { - grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx); - } - } - break; - - case 0x0E: // Currency suffix symbol - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - uint32 tempfix = grf_load_dword(&buf); - - if (curidx < NUM_CURRENCY) { - memcpy(&_currency_specs[curidx].suffix,&tempfix,4); - _currency_specs[curidx].suffix[4] = 0; - } else { - grfmsg(1, "GlobalVarChangeInfo: Currency symbol %d out of range, ignoring", curidx); - } - } - break; - - case 0x0F: // Euro introduction dates - FOR_EACH_OBJECT { - uint curidx = GetNewgrfCurrencyIdConverted(gvid + i); - Year year_euro = grf_load_word(&buf); - - if (curidx < NUM_CURRENCY) { - _currency_specs[curidx].to_euro = year_euro; - } else { - grfmsg(1, "GlobalVarChangeInfo: Euro intro date %d out of range, ignoring", curidx); - } - } - break; - - case 0x09: // Cargo translation table - case 0x10: // 12 * 32 * B Snow line height table - default: - ret = true; - } - - *bufp = buf; - return ret; -} - -static bool SoundEffectChangeInfo(uint sid, int numinfo, int prop, byte **bufp, int len) -{ - byte *buf = *bufp; - int i; - bool ret = false; - - if (_cur_grffile->sound_offset == 0) { - grfmsg(1, "SoundEffectChangeInfo: No effects defined, skipping"); - return false; - } - - switch (prop) { - case 0x08: /* Relative volume */ - FOR_EACH_OBJECT { - uint sound = sid + i + _cur_grffile->sound_offset - GetNumOriginalSounds(); - - if (sound >= GetNumSounds()) { - grfmsg(1, "SoundEffectChangeInfo: Sound %d not defined (max %d)", sound, GetNumSounds()); - } else { - GetSound(sound)->volume = grf_load_byte(&buf); - } - } - break; - - case 0x09: /* Priority */ - FOR_EACH_OBJECT { - uint sound = sid + i + _cur_grffile->sound_offset - GetNumOriginalSounds(); - - if (sound >= GetNumSounds()) { - grfmsg(1, "SoundEffectChangeInfo: Sound %d not defined (max %d)", sound, GetNumSounds()); - } else { - GetSound(sound)->priority = grf_load_byte(&buf); - } - } - break; - - case 0x0A: /* Override old sound */ - FOR_EACH_OBJECT { - uint sound = sid + i + _cur_grffile->sound_offset - GetNumOriginalSounds(); - uint orig_sound = grf_load_byte(&buf); - - if (sound >= GetNumSounds() || orig_sound >= GetNumSounds()) { - grfmsg(1, "SoundEffectChangeInfo: Sound %d or %d not defined (max %d)", sound, orig_sound, GetNumSounds()); - } else { - FileEntry *newfe = GetSound(sound); - FileEntry *oldfe = GetSound(orig_sound); - - /* Literally copy the data of the new sound over the original */ - *oldfe = *newfe; - } - } - break; - - default: - ret = true; - } - - *bufp = buf; - return ret; -} - -/* Action 0x00 */ -static void FeatureChangeInfo(byte *buf, int len) -{ - byte *bufend = buf + len; - int i; - - /* <00> ()... - * - * B feature 0, 1, 2 or 3 for trains, road vehicles, ships or planes - * 4 for defining new train station sets - * B num-props how many properties to change per vehicle/station - * B num-info how many vehicles/stations to change - * B id ID of first vehicle/station to change, if num-info is - * greater than one, this one and the following - * vehicles/stations will be changed - * B property what property to change, depends on the feature - * V new-info new bytes of info (variable size; depends on properties) */ - /* TODO: Bridges, town houses. */ - - static const VCI_Handler handler[] = { - /* GSF_TRAIN */ RailVehicleChangeInfo, - /* GSF_ROAD */ RoadVehicleChangeInfo, - /* GSF_SHIP */ ShipVehicleChangeInfo, - /* GSF_AIRCRAFT */ AircraftVehicleChangeInfo, - /* GSF_STATION */ StationChangeInfo, - /* GSF_CANAL */ NULL, - /* GSF_BRIDGE */ BridgeChangeInfo, - /* GSF_TOWNHOUSE */ NULL, - /* GSF_GLOBALVAR */ GlobalVarChangeInfo, - /* GSF_INDUSTRYTILES */NULL, - /* GSF_INDUSTRIES */ NULL, - /* GSF_CARGOS */ NULL, - /* GSF_SOUNDFX */ SoundEffectChangeInfo, - }; - - uint8 feature; - uint8 numprops; - uint8 numinfo; - byte engine; - EngineInfo *ei = NULL; - - if (len == 1) { - grfmsg(8, "Silently ignoring one-byte special sprite 0x00"); - return; - } - - check_length(len, 6, "FeatureChangeInfo"); - buf++; - feature = grf_load_byte(&buf); - numprops = grf_load_byte(&buf); - numinfo = grf_load_byte(&buf); - engine = grf_load_byte(&buf); - - grfmsg(6, "FeatureChangeInfo: feature %d, %d properties, to apply to %d+%d", - feature, numprops, engine, numinfo); - - if (feature >= lengthof(handler) || handler[feature] == NULL) { - grfmsg(1, "FeatureChangeInfo: Unsupported feature %d, skipping", feature); - return; - } - - if (feature <= GSF_AIRCRAFT) { - if (engine + numinfo > _vehcounts[feature]) { - grfmsg(0, "FeatureChangeInfo: Last engine ID %d out of bounds (max %d), skipping", engine + numinfo, _vehcounts[feature]); - return; - } - ei = &_engine_info[engine + _vehshifts[feature]]; - } - - while (numprops-- && buf < bufend) { - uint8 prop = grf_load_byte(&buf); - bool ignoring = false; - - switch (feature) { - case GSF_TRAIN: - case GSF_ROAD: - case GSF_SHIP: - case GSF_AIRCRAFT: - /* Common properties for vehicles */ - switch (prop) { - case 0x00: /* Introduction date */ - FOR_EACH_OBJECT ei[i].base_intro = grf_load_word(&buf) + DAYS_TILL_ORIGINAL_BASE_YEAR; - break; - - case 0x02: /* Decay speed */ - FOR_EACH_OBJECT SB(ei[i].unk2, 0, 7, grf_load_byte(&buf) & 0x7F); - break; - - case 0x03: /* Vehicle life */ - FOR_EACH_OBJECT ei[i].lifelength = grf_load_byte(&buf); - break; - - case 0x04: /* Model life */ - FOR_EACH_OBJECT ei[i].base_life = grf_load_byte(&buf); - break; - - case 0x06: /* Climates available */ - FOR_EACH_OBJECT ei[i].climates = grf_load_byte(&buf); - break; - - case 0x07: /* Loading speed */ - /* Hyronymus explained me what does - * this mean and insists on having a - * credit ;-). --pasky */ - FOR_EACH_OBJECT ei[i].load_amount = grf_load_byte(&buf); - break; - - default: - if (handler[feature](engine, numinfo, prop, &buf, bufend - buf)) - ignoring = true; - break; - } - break; - - default: - if (handler[feature](engine, numinfo, prop, &buf, bufend - buf)) - ignoring = true; - break; - } - - if (ignoring) grfmsg(2, "FeatureChangeInfo: Ignoring property 0x%02X (not implemented)", prop); - } -} - -/* Action 0x00 (GLS_SAFETYSCAN) */ -static void SafeChangeInfo(byte *buf, int len) -{ - uint8 feature; - uint8 numprops; - uint8 numinfo; - uint8 index; - - check_length(len, 6, "SafeChangeInfo"); - buf++; - feature = grf_load_byte(&buf); - numprops = grf_load_byte(&buf); - numinfo = grf_load_byte(&buf); - index = grf_load_byte(&buf); - - if (feature == GSF_BRIDGE && numprops == 1) { - uint8 prop = grf_load_byte(&buf); - /* Bridge property 0x0D is redefinition of sprite layout tables, which - * is considered safe. */ - if (prop == 0x0D) return; - } - - SETBIT(_cur_grfconfig->flags, GCF_UNSAFE); - - /* Skip remainder of GRF */ - _skip_sprites = -1; -} - -#undef FOR_EACH_OBJECT - -/** - * Creates a spritegroup representing a callback result - * @param value The value that was used to represent this callback result - * @return A spritegroup representing that callback result - */ -static const SpriteGroup* NewCallBackResultSpriteGroup(uint16 value) -{ - SpriteGroup *group = AllocateSpriteGroup(); - - group->type = SGT_CALLBACK; - - // Old style callback results have the highest byte 0xFF so signify it is a callback result - // New style ones only have the highest bit set (allows 15-bit results, instead of just 8) - if ((value >> 8) == 0xFF) { - value &= ~0xFF00; - } else { - value &= ~0x8000; - } - - group->g.callback.result = value; - - return group; -} - -/** - * Creates a spritegroup representing a sprite number result. - * @param value The sprite number. - * @param sprites The number of sprites per set. - * @return A spritegroup representing the sprite number result. - */ -static const SpriteGroup* NewResultSpriteGroup(SpriteID sprite, byte num_sprites) -{ - SpriteGroup *group = AllocateSpriteGroup(); - group->type = SGT_RESULT; - group->g.result.sprite = sprite; - group->g.result.num_sprites = num_sprites; - return group; -} - -/* Action 0x01 */ -static void NewSpriteSet(byte *buf, int len) -{ - /* <01> - * - * B feature feature to define sprites for - * 0, 1, 2, 3: veh-type, 4: train stations - * B num-sets number of sprite sets - * E num-ent how many entries per sprite set - * For vehicles, this is the number of different - * vehicle directions in each sprite set - * Set num-dirs=8, unless your sprites are symmetric. - * In that case, use num-dirs=4. - * For stations, must be 12 (hex) for the eighteen - * different sprites that make up a station */ - /* TODO: No stations support. */ - uint8 feature; - uint num_sets; - uint num_ents; - uint i; - - check_length(len, 4, "NewSpriteSet"); - buf++; - feature = grf_load_byte(&buf); - num_sets = grf_load_byte(&buf); - num_ents = grf_load_extended(&buf); - - _cur_grffile->spriteset_start = _cur_spriteid; - _cur_grffile->spriteset_feature = feature; - _cur_grffile->spriteset_numsets = num_sets; - _cur_grffile->spriteset_numents = num_ents; - - grfmsg(7, "New sprite set at %d of type %d, consisting of %d sets with %d views each (total %d)", - _cur_spriteid, feature, num_sets, num_ents, num_sets * num_ents - ); - - for (i = 0; i < num_sets * num_ents; i++) { - LoadNextSprite(_cur_spriteid++, _file_index); - _nfo_line++; - } -} - -/* Helper function to either create a callback or link to a previously - * defined spritegroup. */ -static const SpriteGroup* GetGroupFromGroupID(byte setid, byte type, uint16 groupid) -{ - if (HASBIT(groupid, 15)) return NewCallBackResultSpriteGroup(groupid); - - if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { - grfmsg(1, "NewSpriteGroup(0x%02X:0x%02X): Groupid 0x%04X does not exist, leaving empty", setid, type, groupid); - return NULL; - } - - return _cur_grffile->spritegroups[groupid]; -} - -/* Helper function to either create a callback or a result sprite group. */ -static const SpriteGroup* CreateGroupFromGroupID(byte feature, byte setid, byte type, uint16 spriteid, uint16 num_sprites) -{ - if (HASBIT(spriteid, 15)) return NewCallBackResultSpriteGroup(spriteid); - - if (spriteid >= _cur_grffile->spriteset_numsets) { - grfmsg(1, "NewSpriteGroup(0x%02X:0x%02X): Sprite set %u invalid, max %u", setid, type, spriteid, _cur_grffile->spriteset_numsets); - return NULL; - } - - /* Check if the sprite is within range. This can fail if the Action 0x01 - * is skipped, as TTDPatch mandates that Action 0x02s must be processed. - * We don't have that rule, but must live by the Patch... */ - if (_cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites > _cur_spriteid) { - grfmsg(1, "NewSpriteGroup(0x%02X:0x%02X): Real Sprite IDs 0x%04X - 0x%04X do not (all) exist (max 0x%04X), leaving empty", - setid, type, - _cur_grffile->spriteset_start + spriteid * num_sprites, - _cur_grffile->spriteset_start + spriteid * num_sprites + num_sprites - 1, _cur_spriteid - 1); - return NULL; - } - - if (feature != _cur_grffile->spriteset_feature) { - grfmsg(1, "NewSpriteGroup(0x%02X:0x%02X): Sprite set feature 0x%02X does not match action feature 0x%02X, skipping", - _cur_grffile->spriteset_feature, feature); - return NULL; - } - - return NewResultSpriteGroup(_cur_grffile->spriteset_start + spriteid * num_sprites, num_sprites); -} - -/* Action 0x02 */ -static void NewSpriteGroup(byte *buf, int len) -{ - /* <02> - * - * B feature see action 1 - * B set-id ID of this particular definition - * B type/num-entries - * if 80 or greater, this is a randomized or variational - * list definition, see below - * otherwise it specifies a number of entries, the exact - * meaning depends on the feature - * V feature-specific-data (huge mess, don't even look it up --pasky) */ - uint8 feature; - uint8 setid; - uint8 type; - SpriteGroup *group = NULL; - byte *bufend = buf + len; - - check_length(len, 5, "NewSpriteGroup"); - buf++; - - feature = grf_load_byte(&buf); - setid = grf_load_byte(&buf); - type = grf_load_byte(&buf); - - if (setid >= _cur_grffile->spritegroups_count) { - // Allocate memory for new sprite group references. - _cur_grffile->spritegroups = realloc(_cur_grffile->spritegroups, (setid + 1) * sizeof(*_cur_grffile->spritegroups)); - // Initialise new space to NULL - for (; _cur_grffile->spritegroups_count < (setid + 1); _cur_grffile->spritegroups_count++) - _cur_grffile->spritegroups[_cur_grffile->spritegroups_count] = NULL; - } - - switch (type) { - /* Deterministic Sprite Group */ - case 0x81: // Self scope, byte - case 0x82: // Parent scope, byte - case 0x85: // Self scope, word - case 0x86: // Parent scope, word - case 0x89: // Self scope, dword - case 0x8A: // Parent scope, dword - { - byte varadjust; - byte varsize; - uint i; - - /* Check we can load the var size parameter */ - check_length(bufend - buf, 1, "NewSpriteGroup (Deterministic) (1)"); - - group = AllocateSpriteGroup(); - group->type = SGT_DETERMINISTIC; - group->g.determ.var_scope = HASBIT(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF; - - switch (GB(type, 2, 2)) { - default: NOT_REACHED(); - case 0: group->g.determ.size = DSG_SIZE_BYTE; varsize = 1; break; - case 1: group->g.determ.size = DSG_SIZE_WORD; varsize = 2; break; - case 2: group->g.determ.size = DSG_SIZE_DWORD; varsize = 4; break; - } - - check_length(bufend - buf, 5 + varsize, "NewSpriteGroup (Deterministic) (2)"); - - /* Loop through the var adjusts. Unfortunately we don't know how many we have - * from the outset, so we shall have to keep reallocing. */ - do { - DeterministicSpriteGroupAdjust *adjust; - - if (group->g.determ.num_adjusts > 0) { - check_length(bufend - buf, 2 + varsize + 3, "NewSpriteGroup (Deterministic) (3)"); - } - - group->g.determ.num_adjusts++; - group->g.determ.adjusts = realloc(group->g.determ.adjusts, group->g.determ.num_adjusts * sizeof(*group->g.determ.adjusts)); - - adjust = &group->g.determ.adjusts[group->g.determ.num_adjusts - 1]; - - /* The first var adjust doesn't have an operation specified, so we set it to add. */ - adjust->operation = group->g.determ.num_adjusts == 1 ? DSGA_OP_ADD : grf_load_byte(&buf); - adjust->variable = grf_load_byte(&buf); - adjust->parameter = IS_BYTE_INSIDE(adjust->variable, 0x60, 0x80) ? grf_load_byte(&buf) : 0; - - varadjust = grf_load_byte(&buf); - adjust->shift_num = GB(varadjust, 0, 5); - adjust->type = GB(varadjust, 6, 2); - adjust->and_mask = grf_load_var(varsize, &buf); - - if (adjust->type != DSGA_TYPE_NONE) { - adjust->add_val = grf_load_var(varsize, &buf); - adjust->divmod_val = grf_load_var(varsize, &buf); - } else { - adjust->add_val = 0; - adjust->divmod_val = 0; - } - - /* Continue reading var adjusts while bit 5 is set. */ - } while (HASBIT(varadjust, 5)); - - group->g.determ.num_ranges = grf_load_byte(&buf); - group->g.determ.ranges = calloc(group->g.determ.num_ranges, sizeof(*group->g.determ.ranges)); - - check_length(bufend - buf, 2 + (2 + 2 * varsize) * group->g.determ.num_ranges, "NewSpriteGroup (Deterministic)"); - - for (i = 0; i < group->g.determ.num_ranges; i++) { - group->g.determ.ranges[i].group = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); - group->g.determ.ranges[i].low = grf_load_var(varsize, &buf); - group->g.determ.ranges[i].high = grf_load_var(varsize, &buf); - } - - group->g.determ.default_group = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); - break; - } - - /* Randomized Sprite Group */ - case 0x80: // Self scope - case 0x83: // Parent scope - { - byte triggers; - uint i; - - check_length(bufend - buf, 7, "NewSpriteGroup (Randomized) (1)"); - - group = AllocateSpriteGroup(); - group->type = SGT_RANDOMIZED; - group->g.random.var_scope = HASBIT(type, 1) ? VSG_SCOPE_PARENT : VSG_SCOPE_SELF; - - triggers = grf_load_byte(&buf); - group->g.random.triggers = GB(triggers, 0, 7); - group->g.random.cmp_mode = HASBIT(triggers, 7) ? RSG_CMP_ALL : RSG_CMP_ANY; - group->g.random.lowest_randbit = grf_load_byte(&buf); - group->g.random.num_groups = grf_load_byte(&buf); - group->g.random.groups = calloc(group->g.random.num_groups, sizeof(*group->g.random.groups)); - - check_length(bufend - buf, 2 * group->g.random.num_groups, "NewSpriteGroup (Randomized) (2)"); - - for (i = 0; i < group->g.random.num_groups; i++) { - group->g.random.groups[i] = GetGroupFromGroupID(setid, type, grf_load_word(&buf)); - } - - break; - } - - /* Neither a variable or randomized sprite group... must be a real group */ - default: - { - - - switch (feature) { - case GSF_TRAIN: - case GSF_ROAD: - case GSF_SHIP: - case GSF_AIRCRAFT: - case GSF_STATION: - { - byte sprites = _cur_grffile->spriteset_numents; - byte num_loaded = type; - byte num_loading = grf_load_byte(&buf); - uint i; - - if (_cur_grffile->spriteset_start == 0) { - grfmsg(0, "NewSpriteGroup: No sprite set to work on! Skipping"); - return; - } - - check_length(bufend - buf, 2 * num_loaded + 2 * num_loading, "NewSpriteGroup (Real) (1)"); - - group = AllocateSpriteGroup(); - group->type = SGT_REAL; - - group->g.real.num_loaded = num_loaded; - group->g.real.num_loading = num_loading; - if (num_loaded > 0) group->g.real.loaded = calloc(num_loaded, sizeof(*group->g.real.loaded)); - if (num_loading > 0) group->g.real.loading = calloc(num_loading, sizeof(*group->g.real.loading)); - - grfmsg(6, "NewSpriteGroup: New SpriteGroup 0x%02X, %u views, %u loaded, %u loading", - setid, sprites, num_loaded, num_loading); - - for (i = 0; i < num_loaded; i++) { - uint16 spriteid = grf_load_word(&buf); - group->g.real.loaded[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites); - grfmsg(8, "NewSpriteGroup: + rg->loaded[%i] = subset %u", i, spriteid); - } - - for (i = 0; i < num_loading; i++) { - uint16 spriteid = grf_load_word(&buf); - group->g.real.loading[i] = CreateGroupFromGroupID(feature, setid, type, spriteid, sprites); - grfmsg(8, "NewSpriteGroup: + rg->loading[%i] = subset %u", i, spriteid); - } - - break; - } - - /* Loading of Tile Layout and Production Callback groups would happen here */ - default: grfmsg(1, "NewSpriteGroup: Unsupported feature %d, skipping", feature); - } - } - } - - _cur_grffile->spritegroups[setid] = group; -} - -/* Action 0x03 */ -static void FeatureMapSpriteGroup(byte *buf, int len) -{ - /* <03> ... [ ]... - * id-list := [] [id-list] - * cargo-list := [cargo-list] - * - * B feature see action 0 - * B n-id bits 0-6: how many IDs this definition applies to - * bit 7: if set, this is a wagon override definition (see below) - * B ids the IDs for which this definition applies - * B num-cid number of cargo IDs (sprite group IDs) in this definition - * can be zero, in that case the def-cid is used always - * B cargo-type type of this cargo type (e.g. mail=2, wood=7, see below) - * W cid cargo ID (sprite group ID) for this type of cargo - * W def-cid default cargo ID (sprite group ID) */ - /* TODO: Bridges, town houses. */ - /* TODO: Multiple cargo support could be useful even for trains/cars - - * cargo id 0xff is used for showing images in the build train list. */ - - static byte *last_engines; - static int last_engines_count; - uint8 feature; - uint8 idcount; - bool wagover; - uint8 cidcount; - int c, i; - - check_length(len, 6, "FeatureMapSpriteGroup"); - feature = buf[1]; - idcount = buf[2] & 0x7F; - wagover = (buf[2] & 0x80) == 0x80; - check_length(len, 3 + idcount, "FeatureMapSpriteGroup"); - - /* If ``n-id'' (or ``idcount'') is zero, this is a ``feature - * callback''. */ - if (idcount == 0) { - grfmsg(2, "FeatureMapSpriteGroup: Feature callbacks not implemented yet"); - return; - } - - cidcount = buf[3 + idcount]; - check_length(len, 4 + idcount + cidcount * 3, "FeatureMapSpriteGroup"); - - grfmsg(6, "FeatureMapSpriteGroup: Feature %d, %d ids, %d cids, wagon override %d", - feature, idcount, cidcount, wagover); - - if (feature > GSF_STATION) { - grfmsg(1, "FeatureMapSpriteGroup: Unsupported feature %d, skipping", feature); - return; - } - - - if (feature == GSF_STATION) { - // We do things differently for stations. - - for (i = 0; i < idcount; i++) { - uint8 stid = buf[3 + i]; - StationSpec *statspec = _cur_grffile->stations[stid]; - byte *bp = &buf[4 + idcount]; - - for (c = 0; c < cidcount; c++) { - uint8 ctype = grf_load_byte(&bp); - uint16 groupid = grf_load_word(&bp); - - if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { - grfmsg(1, "FeatureMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", - groupid, _cur_grffile->spritegroups_count); - return; - } - - if (ctype == 0xFE) ctype = GC_DEFAULT_NA; - if (ctype == 0xFF) ctype = GC_PURCHASE; - - if (ctype >= NUM_GLOBAL_CID) { - grfmsg(1, "FeatureMapSpriteGroup: Cargo type %d out of range, skipping.", ctype); - continue; - } - - statspec->spritegroup[ctype] = _cur_grffile->spritegroups[groupid]; - } - } - - { - byte *bp = buf + 4 + idcount + cidcount * 3; - uint16 groupid = grf_load_word(&bp); - - if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { - grfmsg(1, "FeatureMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", - groupid, _cur_grffile->spritegroups_count); - return; - } - - for (i = 0; i < idcount; i++) { - uint8 stid = buf[3 + i]; - StationSpec *statspec = _cur_grffile->stations[stid]; - - statspec->spritegroup[GC_DEFAULT] = _cur_grffile->spritegroups[groupid]; - statspec->grfid = _cur_grffile->grfid; - statspec->localidx = stid; - SetCustomStationSpec(statspec); - } - } - return; - } - - // FIXME: Tropicset contains things like: - // 03 00 01 19 01 00 00 00 00 - this is missing one 00 at the end, - // what should we exactly do with that? --pasky - - if (_cur_grffile->spriteset_start == 0 || _cur_grffile->spritegroups == 0) { - grfmsg(1, "FeatureMapSpriteGroup: No sprite set to work on! Skipping"); - return; - } - - if (!wagover && last_engines_count != idcount) { - last_engines = realloc(last_engines, idcount); - last_engines_count = idcount; - } - - if (wagover) { - if (last_engines_count == 0) { - grfmsg(0, "FeatureMapSpriteGroup: WagonOverride: No engine to do override with"); - return; - } - grfmsg(6, "FeatureMapSpriteGroup: WagonOverride: %u engines, %u wagons", - last_engines_count, idcount); - } - - - for (i = 0; i < idcount; i++) { - uint8 engine_id = buf[3 + i]; - uint8 engine = engine_id + _vehshifts[feature]; - byte *bp = &buf[4 + idcount]; - - if (engine_id > _vehcounts[feature]) { - grfmsg(0, "Id %u for feature 0x%02X is out of bounds", engine_id, feature); - return; - } - - grfmsg(7, "FeatureMapSpriteGroup: [%d] Engine %d...", i, engine); - - for (c = 0; c < cidcount; c++) { - uint8 ctype = grf_load_byte(&bp); - uint16 groupid = grf_load_word(&bp); - - grfmsg(8, "FeatureMapSpriteGroup: * [%d] Cargo type 0x%X, group id 0x%02X", c, ctype, groupid); - - if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { - grfmsg(1, "FeatureMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); - return; - } - - if (ctype == GC_INVALID) ctype = GC_PURCHASE; - - if (ctype >= NUM_GLOBAL_CID) { - grfmsg(1, "FeatureMapSpriteGroup: Cargo type %d out of range, skipping.", ctype); - continue; - } - - if (wagover) { - SetWagonOverrideSprites(engine, ctype, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count); - } else { - SetCustomEngineSprites(engine, ctype, _cur_grffile->spritegroups[groupid]); - last_engines[i] = engine; - } - } - } - - { - byte *bp = buf + 4 + idcount + cidcount * 3; - uint16 groupid = grf_load_word(&bp); - - grfmsg(8, "-- Default group id 0x%04X", groupid); - - for (i = 0; i < idcount; i++) { - uint8 engine = buf[3 + i] + _vehshifts[feature]; - - // Don't tell me you don't love duplicated code! - if (groupid >= _cur_grffile->spritegroups_count || _cur_grffile->spritegroups[groupid] == NULL) { - grfmsg(1, "FeatureMapSpriteGroup: Spriteset 0x%04X out of range 0x%X or empty, skipping", groupid, _cur_grffile->spritegroups_count); - return; - } - - if (wagover) { - /* If the ID for this action 3 is the same as the vehicle ID, - * this indicates we have a helicopter rotor override. */ - if (feature == GSF_AIRCRAFT && engine == last_engines[i]) { - SetRotorOverrideSprites(engine, _cur_grffile->spritegroups[groupid]); - } else { - // TODO: No multiple cargo types per vehicle yet. --pasky - SetWagonOverrideSprites(engine, GC_DEFAULT, _cur_grffile->spritegroups[groupid], last_engines, last_engines_count); - } - } else { - SetCustomEngineSprites(engine, GC_DEFAULT, _cur_grffile->spritegroups[groupid]); - SetEngineGRF(engine, _cur_grffile); - last_engines[i] = engine; - } - } - } -} - -/* Action 0x04 */ -static void FeatureNewName(byte *buf, int len) -{ - /* <04> - * - * B veh-type see action 0 (as 00..07, + 0A - * But IF veh-type = 48, then generic text - * B language-id If bit 6 is set, This is the extended language scheme, - with up to 64 language. - Otherwise, it is a mapping where set bits have meaning - 0 = american, 1 = english, 2 = german, 3 = french, 4 = spanish - Bit 7 set means this is a generic text, not a vehicle one (or else) - * B num-veh number of vehicles which are getting a new name - * B/W offset number of the first vehicle that gets a new name - * Byte : ID of vehicle to change - * Word : ID of string to change/add - * S data new texts, each of them zero-terminated, after - * which the next name begins. */ - /* TODO: No support for changing non-vehicle text. Perhaps we shouldn't - * implement it at all, but it could be useful for some "modpacks" - * (completely new scenarios changing all graphics and logically also - * factory names etc). We should then also support all languages (by - * name), not only the original four ones. --pasky - * All of the above are coming. In Time. Some sooner than others :)*/ - - uint8 feature; - uint8 lang; - uint8 num; - uint16 id; - uint16 endid; - const char* name; - bool new_scheme = _cur_grffile->grf_version >= 7; - bool generic; - - check_length(len, 6, "FeatureNewName"); - buf++; - feature = grf_load_byte(&buf); - lang = grf_load_byte(&buf); - num = grf_load_byte(&buf); - generic = HASBIT(lang, 7); - id = generic ? grf_load_word(&buf) : grf_load_byte(&buf); - - CLRBIT(lang, 7); - - if (feature <= GSF_AIRCRAFT && id < _vehcounts[feature]) { - id += _vehshifts[feature]; - } - endid = id + num; - - grfmsg(6, "FeatureNewName: About to rename engines %d..%d (feature %d) in language 0x%02X", - id, endid, feature, lang); - - name = (const char*)buf; /*transfer read value*/ - len -= generic ? 6 : 5; - - for (; id < endid && len > 0; id++) { - size_t ofs = strlen(name) + 1; - - if (ofs < 128) { - grfmsg(8, "FeatureNewName: %d <- %s", id, name); - - switch (feature) { - case GSF_TRAIN: - case GSF_ROAD: - case GSF_SHIP: - case GSF_AIRCRAFT: { - if (id < TOTAL_NUM_ENGINES) { - StringID string = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_8000_KIRBY_PAUL_TANK_STEAM + id); - SetCustomEngineName(id, string); - } else { - AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, id); - } - break; - } - - default: - switch (GB(id, 8, 8)) { - case 0xC4: /* Station class name */ - if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) { - grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8)); - } else { - StationClassID sclass = _cur_grffile->stations[GB(id, 0, 8)]->sclass; - SetStationClassName(sclass, AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED)); - } - break; - - case 0xC5: /* Station name */ - if (_cur_grffile->stations == NULL || _cur_grffile->stations[GB(id, 0, 8)] == NULL) { - grfmsg(1, "FeatureNewName: Attempt to name undefined station 0x%X, ignoring", GB(id, 0, 8)); - } else { - _cur_grffile->stations[GB(id, 0, 8)]->name = AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); - } - break; - - case 0xC9: - case 0xD0: - case 0xDC: - AddGRFString(_cur_grffile->grfid, id, lang, new_scheme, name, STR_UNDEFINED); - break; - - default: - grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id); - break; - } - break; - -#if 0 - case GSF_CANAL : - case GSF_BRIDGE : - case GSF_TOWNHOUSE : - AddGRFString(_cur_spriteid, id, lang, name); - switch (GB(id, 8,8)) { - case 0xC9: /* House name */ - default: - grfmsg(7, "FeatureNewName: Unsupported ID (0x%04X)", id); - } - break; - - case GSF_INDUSTRIES : - case 0x48 : /* for generic strings */ - AddGRFString(_cur_spriteid, id, lang, name); - break; - default : - grfmsg(7, "FeatureNewName: Unsupported feature (0x%02X)", feature); - break; -#endif - } - } else { - /* ofs is the string length + 1, so if the string is empty, ofs - * is 1 */ - if (ofs == 1) { - grfmsg(7, "FeatureNewName: Can't add empty name"); - } else { - grfmsg(7, "FeatureNewName: Too long a name (%d)", ofs); - } - } - name += ofs; - len -= (int)ofs; - } -} - -/* Action 0x05 */ -static void GraphicsNew(byte *buf, int len) -{ - /* <05> - * - * B graphics-type What set of graphics the sprites define. - * E num-sprites How many sprites are in this set? - * V other data Graphics type specific data. Currently unused. */ - /* TODO */ - - uint8 type; - uint16 num; - SpriteID replace = 0; - - check_length(len, 2, "GraphicsNew"); - buf++; - type = grf_load_byte(&buf); - num = grf_load_extended(&buf); - - switch (type) { - case 0x04: /* Signal graphics */ - if (num != 112 && num != 240) { - grfmsg(1, "GraphicsNews: Signal graphics sprite count must be 112 or 240, skipping"); - return; - } - _signal_base = _cur_spriteid; - break; - - case 0x05: /* Catenary graphics */ - if (num != 48) { - grfmsg(1, "GraphicsNews: Catenary graphics sprite count must be 48, skipping"); - return; - } - replace = SPR_ELRAIL_BASE + 3; - break; - - case 0x06: /* Foundations */ - if (num != 74) { - grfmsg(1, "GraphicsNews: Foundation graphics sprite count must be 74, skipping"); - return; - } - replace = SPR_SLOPES_BASE; - break; - - case 0x08: /* Canal graphics */ - if (num != 65) { - grfmsg(1, "GraphicsNews: Canal graphics sprite count must be 65, skipping"); - return; - } - replace = SPR_CANALS_BASE + 5; - break; - - case 0x0D: /* Coast graphics */ - if (num != 16) { - grfmsg(1, "GraphicsNews: Coast graphics sprite count must be 16, skipping"); - return; - } - _coast_base = _cur_spriteid; - break; - - default: - grfmsg(2, "GraphicsNew: Custom graphics (type 0x%02X) sprite block of length %u (unimplemented, ignoring)", - type, num); - return; - } - - if (replace == 0) { - grfmsg(2, "GraphicsNew: Loading %u sprites of type 0x%02X at SpriteID 0x%04X", num, type, _cur_spriteid); - } else { - grfmsg(2, "GraphicsNew: Replacing %u sprites of type 0x%02X at SpriteID 0x%04X", num, type, replace); - } - - for (; num > 0; num--) { - LoadNextSprite(replace == 0 ? _cur_spriteid++ : replace++, _file_index); - _nfo_line++; - } -} - -static uint32 GetParamVal(byte param, uint32 *cond_val) -{ - switch (param) { - case 0x81: /* current year */ - return clamp(_cur_year, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR) - ORIGINAL_BASE_YEAR; - - case 0x83: /* current climate, 0=temp, 1=arctic, 2=trop, 3=toyland */ - return _opt.landscape; - - case 0x84: /* GRF loading stage */ - return (_cur_stage > GLS_INIT) | ((_cur_stage == GLS_ACTIVATION) << 9); - - case 0x85: /* TTDPatch flags, only for bit tests */ - if (cond_val == NULL) { - /* Supported in Action 0x07 and 0x09, not 0x0D */ - return 0; - } else { - uint32 param_val = _ttdpatch_flags[*cond_val / 0x20]; - *cond_val %= 0x20; - return param_val; - } - - case 0x86: /* road traffic side, bit 4 clear=left, set=right */ - return _opt.road_side << 4; - - case 0x88: /* GRF ID check */ - return 0; - - case 0x8B: { /* TTDPatch version */ - uint major = 2; - uint minor = 6; - uint revision = 0; // special case: 2.0.1 is 2.0.10 - uint build = 1168; - return (major << 24) | (minor << 20) | (revision << 16) | build; - } - - case 0x8D: /* TTD Version, 00=DOS, 01=Windows */ - return !_use_dos_palette; - - case 0x8E: /* Y-offset for train sprites */ - return _traininfo_vehicle_pitch; - - case 0x92: /* Game mode */ - return _game_mode; - - case 0x9A: /* Always -1 */ - return -1; - - case 0x9D: /* TTD Platform, 00=TTDPatch, 01=OpenTTD */ - return 1; - - case 0x9E: /* Miscellaneous GRF features */ - return _misc_grf_features; - - default: - /* GRF Parameter */ - if (param < 0x80) return _cur_grffile->param[param]; - - /* In-game variable. */ - grfmsg(1, "Unsupported in-game variable 0x%02X", param); - return -1; - } -} - -/* Action 0x06 */ -static void CfgApply(byte *buf, int len) -{ - /* <06> ... - * - * B param-num Number of parameter to substitute (First = "zero") - * Ignored if that parameter was not specified in newgrf.cfg - * B param-size How many bytes to replace. If larger than 4, the - * bytes of the following parameter are used. In that - * case, nothing is applied unless *all* parameters - * were specified. - * B offset Offset into data from beginning of next sprite - * to place where parameter is to be stored. */ - - /* Preload the next sprite */ - uint32 pos = FioGetPos(); - uint16 num = FioReadWord(); - uint8 type = FioReadByte(); - - /* Check if the sprite is a pseudo sprite. We can't operate on real sprites. */ - if (type == 0xFF) { - _preload_sprite = malloc(num); - FioReadBlock(_preload_sprite, num); - } - - /* Reset the file position to the start of the next sprite */ - FioSeekTo(pos, SEEK_SET); - - if (type != 0xFF) { - grfmsg(2, "CfgApply: Ignoring (next sprite is real, unsupported)"); - return; - } - - /* Now perform the Action 0x06 on our data. */ - buf++; - - for (;;) { - uint i; - uint param_num; - uint param_size; - uint offset; - bool add_value; - - /* Read the parameter to apply. 0xFF indicates no more data to change. */ - param_num = grf_load_byte(&buf); - if (param_num == 0xFF) break; - - /* Get the size of the parameter to use. If the size covers multiple - * double words, sequential parameter values are used. */ - param_size = grf_load_byte(&buf); - - /* Bit 7 of param_size indicates we should add to the original value - * instead of replacing it. */ - add_value = HASBIT(param_size, 7); - param_size = GB(param_size, 0, 7); - - /* Where to apply the data to within the pseudo sprite data. */ - offset = grf_load_extended(&buf); - - /* If the parameter is a GRF parameter (not an internal variable) check - * if it (and all further sequential parameters) has been defined. */ - if (param_num < 0x80 && (param_num + (param_size - 1) / 4) >= _cur_grffile->param_end) { - grfmsg(2, "CfgApply: Ignoring (param %d not set)", (param_num + (param_size - 1) / 4)); - break; - } - - grfmsg(8, "CfgApply: Applying %u bytes from parameter 0x%02X at offset 0x%04X", param_size, param_num, offset); - - for (i = 0; i < param_size; i++) { - uint32 value = GetParamVal(param_num + i / 4, NULL); - - if (add_value) { - _preload_sprite[offset + i] += GB(value, (i % 4) * 8, 8); - } else { - _preload_sprite[offset + i] = GB(value, (i % 4) * 8, 8); - } - } - } -} - -/* Action 0x07 */ -/* Action 0x09 */ -static void SkipIf(byte *buf, int len) -{ - /* <07/09> - * - * B param-num - * B param-size - * B condition-type - * V value - * B num-sprites */ - /* TODO: More params. More condition types. */ - uint8 param; - uint8 paramsize; - uint8 condtype; - uint8 numsprites; - uint32 param_val = 0; - uint32 cond_val = 0; - uint32 mask = 0; - bool result; - GRFLabel *label; - GRFLabel *choice = NULL; - - check_length(len, 6, "SkipIf"); - buf++; - param = grf_load_byte(&buf); - paramsize = grf_load_byte(&buf); - condtype = grf_load_byte(&buf); - - if (condtype < 2) { - /* Always 1 for bit tests, the given value should be ignored. */ - paramsize = 1; - } - - switch (paramsize) { - case 4: cond_val = grf_load_dword(&buf); mask = 0xFFFFFFFF; break; - case 2: cond_val = grf_load_word(&buf); mask = 0x0000FFFF; break; - case 1: cond_val = grf_load_byte(&buf); mask = 0x000000FF; break; - default: break; - } - - if (param < 0x80 && _cur_grffile->param_end <= param) { - grfmsg(7, "Param %d undefined, skipping test", param); - return; - } - - param_val = GetParamVal(param, &cond_val); - - grfmsg(7, "Test condtype %d, param 0x%08X, condval 0x%08X", condtype, param_val, cond_val); - - if (param == 0x88) { - /* GRF ID checks */ - - const GRFConfig *c = GetGRFConfig(cond_val); - - if (condtype != 10 && c == NULL) { - grfmsg(7, "GRFID 0x%08X unknown, skipping test", BSWAP32(cond_val)); - return; - } - - switch (condtype) { - /* Tests 6 to 10 are only for param 0x88, GRFID checks */ - case 6: /* Is GRFID active? */ - result = HASBIT(c->flags, GCF_ACTIVATED); - break; - - case 7: /* Is GRFID non-active? */ - result = !HASBIT(c->flags, GCF_ACTIVATED); - break; - - case 8: /* GRFID is not but will be active? */ - result = !HASBIT(c->flags, GCF_ACTIVATED) && !HASBIT(c->flags, GCF_DISABLED); - break; - - case 9: /* GRFID is or will be active? */ - result = !HASBIT(c->flags, GCF_NOT_FOUND) && !HASBIT(c->flags, GCF_DISABLED); - break; - - case 10: /* GRFID is not nor will be active */ - /* This is the only condtype that doesn't get ignored if the GRFID is not found */ - result = c == NULL || HASBIT(c->flags, GCF_DISABLED) || HASBIT(c->flags, GCF_NOT_FOUND); - break; - - default: grfmsg(1, "Unsupported GRF test %d. Ignoring", condtype); return; - } - } else { - /* Parameter or variable tests */ - switch (condtype) { - case 0: result = !!(param_val & (1 << cond_val)); - break; - case 1: result = !(param_val & (1 << cond_val)); - break; - case 2: result = (param_val & mask) == cond_val; - break; - case 3: result = (param_val & mask) != cond_val; - break; - case 4: result = (param_val & mask) < cond_val; - break; - case 5: result = (param_val & mask) > cond_val; - break; - - default: grfmsg(1, "Unsupported test %d. Ignoring", condtype); return; - } - } - - if (!result) { - grfmsg(2, "Not skipping sprites, test was false"); - return; - } - - numsprites = grf_load_byte(&buf); - - /* numsprites can be a GOTO label if it has been defined in the GRF - * file. The jump will always be the first matching label that follows - * the current nfo_line. If no matching label is found, the first matching - * label in the file is used. */ - for (label = _cur_grffile->label; label != NULL; label = label->next) { - if (label->label != numsprites) continue; - - /* Remember a goto before the current line */ - if (choice == NULL) choice = label; - /* If we find a label here, this is definitely good */ - if (label->nfo_line > _nfo_line) { - choice = label; - break; - } - } - - if (choice != NULL) { - grfmsg(2, "Jumping to label 0x%0X at line %d, test was true", choice->label, choice->nfo_line); - FioSeekTo(choice->pos, SEEK_SET); - _nfo_line = choice->nfo_line; - return; - } - - grfmsg(2, "Skipping %d sprites, test was true", numsprites); - _skip_sprites = numsprites; - if (_skip_sprites == 0) { - /* Zero means there are no sprites to skip, so - * we use -1 to indicate that all further - * sprites should be skipped. */ - _skip_sprites = -1; - } -} - - -/* Action 0x08 (GLS_FILESCAN) */ -static void ScanInfo(byte *buf, int len) -{ - uint8 version; - uint32 grfid; - const char *name; - const char *info; - int name_len; - int info_len; - - check_length(len, 8, "Info"); buf++; - version = grf_load_byte(&buf); - grfid = grf_load_dword(&buf); - - _cur_grfconfig->grfid = grfid; - - /* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */ - if (GB(grfid, 24, 8) == 0xFF) SETBIT(_cur_grfconfig->flags, GCF_SYSTEM); - - len -= 6; - name = (const char*)buf; - name_len = ttd_strnlen(name, len); - - if (name_len < len) { - _cur_grfconfig->name = TranslateTTDPatchCodes(name); - - len -= name_len + 1; - info = name + name_len + 1; - info_len = ttd_strnlen(info, len); - - if (info_len < len) _cur_grfconfig->info = TranslateTTDPatchCodes(info); - } - - /* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */ - _skip_sprites = -1; -} - -/* Action 0x08 */ -static void GRFInfo(byte *buf, int len) -{ - /* <08> - * - * B version newgrf version, currently 06 - * 4*B grf-id globally unique ID of this .grf file - * S name name of this .grf set - * S info string describing the set, and e.g. author and copyright */ - /* TODO: Check version. (We should have own versioning done somehow.) */ - uint8 version; - uint32 grfid; - const char *name; - - check_length(len, 8, "GRFInfo"); buf++; - version = grf_load_byte(&buf); - grfid = grf_load_dword(&buf); - name = (const char*)buf; - - _cur_grffile->grfid = grfid; - _cur_grffile->grf_version = version; - SETBIT(_cur_grfconfig->flags, GCF_ACTIVATED); - - /* Do swap the GRFID for displaying purposes since people expect that */ - DEBUG(grf, 1, "Loaded GRFv%d set %08lX - %s", version, BSWAP32(grfid), name); -} - -/* Action 0x0A */ -static void SpriteReplace(byte *buf, int len) -{ - /* <0A> [ ...] - * : - * - * B num-sets How many sets of sprites to replace. - * Each set: - * B num-sprites How many sprites are in this set - * W first-sprite First sprite number to replace */ - uint8 num_sets; - uint i; - - buf++; /* skip action byte */ - num_sets = grf_load_byte(&buf); - - for (i = 0; i < num_sets; i++) { - uint8 num_sprites = grf_load_byte(&buf); - uint16 first_sprite = grf_load_word(&buf); - uint j; - - grfmsg(2, "SpriteReplace: [Set %d] Changing %d sprites, beginning with %d", - i, num_sprites, first_sprite - ); - - for (j = 0; j < num_sprites; j++) { - LoadNextSprite(first_sprite + j, _file_index); // XXX - _nfo_line++; - } - } -} - -/* Action 0x0B */ -static void GRFError(byte *buf, int len) -{ - /* <0B> [ 00] [] 00 [] - * - * B severity 00: notice, contine loading grf file - * 01: warning, continue loading grf file - * 02: error, but continue loading grf file, and attempt - * loading grf again when loading or starting next game - * 03: error, abort loading and prevent loading again in - * the future (only when restarting the patch) - * B language-id see action 4, use 1F for built-in error messages - * B message-id message to show, see below - * S message for custom messages (message-id FF), text of the message - * not present for built-in messages. - * V data additional data for built-in (or custom) messages - * B parnum see action 6, only used with built-in message 03 */ - /* TODO: For now we just show the message, sometimes incomplete and never translated. */ - - static const char *const msgstr[] = { - "%sRequires at least pseudo-TTDPatch version %s", - "%sThis file is for %s version of TTD", - "%sDesigned to be used with %s", - "%sInvalid parameter %s", - "%sMust be loaded before %s", - "%sMust be loaded after %s", - "%s%s" - }; - - static const char *const sevstr[] = { - "", - "Warning: ", - "Error: ", - "Fatal: ", - }; - uint8 sevid; - uint8 msgid; - - check_length(len, 6, "GRFError"); - sevid = buf[1]; - msgid = buf[3]; - - // Undocumented TTDPatch feature. - if (!HASBIT(sevid, 7) && _cur_stage < GLS_ACTIVATION) { - grfmsg(7, "Skipping non-fatal GRFError in stage 1"); - return; - } - - sevid = GB(sevid, 0, 2); - grfmsg(0, msgstr[(msgid == 0xFF) ? lengthof(msgstr) - 1 : msgid], sevstr[sevid], &buf[4]); -} - -/* Action 0x0C */ -static void GRFComment(byte *buf, int len) -{ - /* <0C> [] - * - * V ignored Anything following the 0C is ignored */ - - static char comment[256]; - if (len == 1) return; - - ttd_strlcpy(comment, (char*)(buf + 1), minu(sizeof(comment), len)); - grfmsg(2, "GRFComment: %s", comment); -} - -/* Action 0x0D (GLS_SAFETYSCAN) */ -static void SafeParamSet(byte *buf, int len) -{ - uint8 target; - - check_length(len, 5, "SafeParamSet"); - buf++; - target = grf_load_byte(&buf); - - /* Only writing GRF parameters is considered safe */ - if (target < 0x80) return; - - /* GRM could be unsafe, but as here it can only happen after other GRFs - * are loaded, it should be okay. If the GRF tried to use the slots it - * reserved, it would be marked unsafe anyway. GRM for (e.g. bridge) - * sprites is considered safe. */ - - SETBIT(_cur_grfconfig->flags, GCF_UNSAFE); - - /* Skip remainder of GRF */ - _skip_sprites = -1; -} - -/* Action 0x0D */ -static void ParamSet(byte *buf, int len) -{ - /* <0D> [] - * - * B target parameter number where result is stored - * B operation operation to perform, see below - * B source1 first source operand - * B source2 second source operand - * D data data to use in the calculation, not necessary - * if both source1 and source2 refer to actual parameters - * - * Operations - * 00 Set parameter equal to source1 - * 01 Addition, source1 + source2 - * 02 Subtraction, source1 - source2 - * 03 Unsigned multiplication, source1 * source2 (both unsigned) - * 04 Signed multiplication, source1 * source2 (both signed) - * 05 Unsigned bit shift, source1 by source2 (source2 taken to be a - * signed quantity; left shift if positive and right shift if - * negative, source1 is unsigned) - * 06 Signed bit shift, source1 by source2 - * (source2 like in 05, and source1 as well) - */ - - byte target; - byte oper; - uint32 src1; - uint32 src2; - uint32 data = 0; - uint32 res; - - check_length(len, 5, "ParamSet"); - buf++; - target = grf_load_byte(&buf); - oper = grf_load_byte(&buf); - src1 = grf_load_byte(&buf); - src2 = grf_load_byte(&buf); - - if (len >= 8) data = grf_load_dword(&buf); - - /* You can add 80 to the operation to make it apply only if the target - * is not defined yet. In this respect, a parameter is taken to be - * defined if any of the following applies: - * - it has been set to any value in the newgrf(w).cfg parameter list - * - it OR A PARAMETER WITH HIGHER NUMBER has been set to any value by - * an earlier action D */ - if (oper & 0x80) { - if (target < 0x80 && target < _cur_grffile->param_end) { - grfmsg(7, "Param %u already defined, skipping", target); - return; - } - - oper &= 0x7F; - } - - if (src2 == 0xFE) { - if (GB(data, 0, 8) == 0xFF) { - if (data == 0x0000FFFF) { - /* Patch variables */ - grfmsg(2, "ParamSet: Reading Patch variables unsupported"); - return; - } else { - /* GRF Resource Management */ - if (_cur_stage != GLS_ACTIVATION) { - /* Ignore GRM during initialization */ - src1 = 0; - } else { - uint8 op = src1; - uint8 feature = GB(data, 8, 8); - uint16 count = GB(data, 16, 16); - - switch (feature) { - case 0x00: /* Trains */ - case 0x01: /* Road Vehicles */ - case 0x02: /* Ships */ - case 0x03: /* Aircraft */ - { - uint start = 0; - uint size = 0; - uint shift = _vehshifts[feature]; - int i; - - if (op == 6) { - /* Return GRFID of set that reserved ID */ - src1 = _grm_engines[shift + _cur_grffile->param[target]]; - break; - } - - /* With an operation of 2 or 3, we want to reserve a specific block of IDs */ - if (op == 2 || op == 3) start = _cur_grffile->param[target]; - - for (i = start; i < _vehcounts[feature]; i++) { - if (_grm_engines[shift + i] == 0) { - size++; - } else { - if (op == 2 || op == 3) break; - start = i + 1; - size = 0; - } - - if (size == count) break; - } - - if (size == count) { - /* Got the slot... */ - if (op == 0 || op == 3) { - grfmsg(2, "GRM: Reserving %d vehicles at %d", count, start); - for (i = 0; i < count; i++) _grm_engines[shift + start + i] = _cur_grffile->grfid; - } - src1 = start; - } else { - /* Unable to allocate */ - if (op != 4 && op != 5) { - /* Deactivate GRF */ - grfmsg(0, "GRM: Unable to allocate %d vehicles, deactivating", count); - SETBIT(_cur_grfconfig->flags, GCF_DISABLED); - CLRBIT(_cur_grfconfig->flags, GCF_ACTIVATED); - - _skip_sprites = -1; - return; - } - - grfmsg(1, "GRM: Unable to allocate %d vehicles", count); - src1 = -1; - } - break; - } - - case 0x08: /* General sprites */ - switch (op) { - case 0: - /* 'Reserve' space at the current sprite ID */ - src1 = _cur_spriteid; - _cur_spriteid += count; - break; - - case 1: - src1 = _cur_spriteid; - break; - - default: - grfmsg(1, "GRM: Unsupported operation %d for general sprites", op); - return; - } - break; - - default: grfmsg(1, "GRM: Unsupported feature 0x%X", feature); return; - } - } - } - } else { - /* Read another GRF File's parameter */ - const GRFFile *file = GetFileByGRFID(data); - if (file == NULL || src1 >= file->param_end) { - src1 = 0; - } else { - src1 = file->param[src1]; - } - } - } else { - /* The source1 and source2 operands refer to the grf parameter number - * like in action 6 and 7. In addition, they can refer to the special - * variables available in action 7, or they can be FF to use the value - * of . If referring to parameters that are undefined, a value - * of 0 is used instead. */ - src1 = (src1 == 0xFF) ? data : GetParamVal(src1, NULL); - src2 = (src2 == 0xFF) ? data : GetParamVal(src2, NULL); - } - - /* TODO: You can access the parameters of another GRF file by using - * source2=FE, source1=the other GRF's parameter number and data=GRF - * ID. This is only valid with operation 00 (set). If the GRF ID - * cannot be found, a value of 0 is used for the parameter value - * instead. */ - - switch (oper) { - case 0x00: - res = src1; - break; - - case 0x01: - res = src1 + src2; - break; - - case 0x02: - res = src1 - src2; - break; - - case 0x03: - res = src1 * src2; - break; - - case 0x04: - res = (int32)src1 * (int32)src2; - break; - - case 0x05: - if ((int32)src2 < 0) { - res = src1 >> -(int32)src2; - } else { - res = src1 << src2; - } - break; - - case 0x06: - if ((int32)src2 < 0) { - res = (int32)src1 >> -(int32)src2; - } else { - res = (int32)src1 << src2; - } - break; - - case 0x07: /* Bitwise AND */ - res = src1 & src2; - break; - - case 0x08: /* Bitwise OR */ - res = src1 | src2; - break; - - case 0x09: /* Unsigned division */ - if (src2 == 0) { - res = src1; - } else { - res = src1 / src2; - } - break; - - case 0x0A: /* Signed divison */ - if (src2 == 0) { - res = src1; - } else { - res = (int32)src1 / (int32)src2; - } - break; - - case 0x0B: /* Unsigned modulo */ - if (src2 == 0) { - res = src1; - } else { - res = src1 % src2; - } - break; - - case 0x0C: /* Signed modulo */ - if (src2 == 0) { - res = src1; - } else { - res = (int32)src1 % (int32)src2; - } - break; - - default: grfmsg(0, "ParamSet: Unknown operation %d, skipping", oper); return; - } - - switch (target) { - case 0x8E: // Y-Offset for train sprites - _traininfo_vehicle_pitch = res; - break; - - // TODO implement - case 0x8F: // Rail track type cost factors - case 0x93: // Tile refresh offset to left - case 0x94: // Tile refresh offset to right - case 0x95: // Tile refresh offset upwards - case 0x96: // Tile refresh offset downwards - case 0x97: // Snow line height - case 0x99: // Global ID offset - grfmsg(7, "ParamSet: Skipping unimplemented target 0x%02X", target); - break; - - case 0x9E: /* Miscellaneous GRF features */ - _misc_grf_features = res; - /* Set train list engine width */ - _traininfo_vehicle_width = HASBIT(res, 3) ? 32 : 29; - break; - - default: - if (target < 0x80) { - _cur_grffile->param[target] = res; - if (target + 1U > _cur_grffile->param_end) _cur_grffile->param_end = target + 1; - } else { - grfmsg(7, "ParamSet: Skipping unknown target 0x%02X", target); - } - break; - } -} - -/* Action 0x0E (GLS_SAFETYSCAN) */ -static void SafeGRFInhibit(byte *buf, int len) -{ - /* <0E> - * - * B num Number of GRFIDs that follow - * D grfids GRFIDs of the files to deactivate */ - - byte num; - int i; - - check_length(len, 1, "GRFInhibit"); - buf++, len--; - num = grf_load_byte(&buf); len--; - check_length(len, 4 * num, "GRFInhibit"); - - for (i = 0; i < num; i++) { - uint32 grfid = grf_load_dword(&buf); - - /* GRF is unsafe it if tries to deactivate other GRFs */ - if (grfid != _cur_grfconfig->grfid) { - SETBIT(_cur_grfconfig->flags, GCF_UNSAFE); - - /* Skip remainder of GRF */ - _skip_sprites = -1; - - return; - } - } -} - -/* Action 0x0E */ -static void GRFInhibit(byte *buf, int len) -{ - /* <0E> - * - * B num Number of GRFIDs that follow - * D grfids GRFIDs of the files to deactivate */ - - byte num; - int i; - - check_length(len, 1, "GRFInhibit"); - buf++, len--; - num = grf_load_byte(&buf); len--; - check_length(len, 4 * num, "GRFInhibit"); - - for (i = 0; i < num; i++) { - uint32 grfid = grf_load_dword(&buf); - GRFConfig *file = GetGRFConfig(grfid); - - /* Unset activation flag */ - if (file != NULL && file != _cur_grfconfig) { - grfmsg(2, "GRFInhibit: Deactivating file '%s'", file->filename); - SETBIT(file->flags, GCF_DISABLED); - CLRBIT(file->flags, GCF_ACTIVATED); - } - } -} - -/* Action 0x10 */ -static void DefineGotoLabel(byte *buf, int len) -{ - /* <10>