1

/* $Id$ */

     2

     5

#include "stdafx.h"

     6

     7

#include <stdarg.h>

     8

     9

#include "openttd.h"

    10

#include "debug.h"

    11

#include "gfx.h"

    12

#include "fileio.h"

    13

#include "functions.h"

    14

#include "engine.h"

    15

#include "spritecache.h"

    16

#include "station.h"

    17

#include "sprite.h"

    18

#include "newgrf.h"

    19

#include "variables.h"

    20

#include "string.h"

    21

#include "table/strings.h"

    22

#include "bridge.h"

    23

#include "town.h"

    24

#include "economy.h"

    25

#include "newgrf_engine.h"

    26

#include "vehicle.h"

    27

#include "newgrf_text.h"

    28

#include "table/sprites.h"

    29

#include "fontcache.h"

    30

#include "date.h"

    31

#include "currency.h"

    32

#include "landscape.h"

    33

#include "sound.h"

    34

#include "newgrf_config.h"

    35

#include "newgrf_house.h"

    36

#include "newgrf_sound.h"

    37

#include "newgrf_spritegroup.h"

    38

#include "helpers.hpp"

    39

#include "table/town_land.h"

    40

#include "cargotype.h"

    41

    42

/* TTDPatch extended GRF format codec

    43

 * (c) Petr Baudis 2004 (GPL'd)

    44

 * Changes by Florian octo Forster are (c) by the OpenTTD development team.

    45

 *

    46

 * Contains portions of documentation by TTDPatch team.

    47

 * Thanks especially to Josef Drexler for the documentation as well as a lot

    48

 * of help at #tycoon. Also thanks to Michael Blunck for is GRF files which

    49

 * served as subject to the initial testing of this codec. */

    50

    51

    52

static int _skip_sprites; // XXX

    53

static uint _file_index; // XXX

    54

SpriteID _signal_base;

    55

SpriteID _coast_base;

    56

    57

static GRFFile *_cur_grffile;

    58

GRFFile *_first_grffile;

    59

static SpriteID _cur_spriteid;

    60

static GrfLoadingStage _cur_stage;

    61

static uint32 _nfo_line;

    62

    63

static GRFConfig *_cur_grfconfig;

    64

    65

/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */

    66

static byte _misc_grf_features = 0;

    67

    68

/* 32 * 8 = 256 flags. Apparently TTDPatch uses this many.. */

    69

static uint32 _ttdpatch_flags[8];

    70

    71

/* Used by Action 0x06 to preload a pseudo sprite and modify its content */

    72

static byte *_preload_sprite = NULL;

    73

    74

/* Set if any vehicle is loaded which uses 2cc (two company colours) */

    75

bool _have_2cc = false;

    76

    77

/* Set if there are any newhouses loaded. */

    78

bool _have_newhouses = false;

    79

    80

/* Default cargo translation table. By default there are 27 possible cargo types */

    81

static const uint _default_cargo_max = 27;

    82

static CargoLabel _default_cargo_list[_default_cargo_max];

    83

    84

    85

enum GrfDataType {

    86

	GDT_SOUND,

    87

};

    88

    89

static byte _grf_data_blocks;

    90

static GrfDataType _grf_data_type;

    91

    92

    93

enum grfspec_feature {

    94

	GSF_TRAIN,

    95

	GSF_ROAD,

    96

	GSF_SHIP,

    97

	GSF_AIRCRAFT,

    98

	GSF_STATION,

    99

	GSF_CANAL,

   100

	GSF_BRIDGE,

   101

	GSF_TOWNHOUSE,

   102

	GSF_GLOBALVAR,

   103

	GSF_INDUSTRYTILES,

   104

	GSF_INDUSTRIES,

   105

	GSF_CARGOS,

   106

	GSF_SOUNDFX,

   107

};

   108

   109

   110

typedef void (*SpecialSpriteHandler)(byte *buf, int len);

   111

   112

static const uint _vehcounts[4] = {

   113

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   114

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   115

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   116

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   117

};

   118

   119

static const uint _vehshifts[4] = {

   120

	/* GSF_TRAIN */    0,

   121

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   122

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   123

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   124

};

   125

   126

enum {

   127

	MAX_STATIONS = 256,

   128

};

   129

   130

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   131

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   132

   133

/* Contains the GRF ID of the owner of a vehicle if it has been reserved */

   134

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   135

   136

/** DEBUG() function dedicated to newGRF debugging messages

   137

 * Function is essentialy the same as DEBUG(grf, severity, ...) with the

   138

 * addition of file:line information when parsing grf files.

   139

 * NOTE: for the above reason(s) grfmsg() should ONLY be used for

   140

 * loading/parsing grf files, not for runtime debug messages as there

   141

 * is no file information available during that time.

   142

 * @param severity debugging severity level, see debug.h

   143

 * @param debugging message in printf() format */

   144

void CDECL grfmsg(int severity, const char *str, ...)

   145

{

   146

	char buf[1024];

   147

	va_list va;

   148

   149

	va_start(va, str);

   150

	vsnprintf(buf, sizeof(buf), str, va);

   151

	va_end(va);

   152

   153

	DEBUG(grf, severity, "[%s:%d] %s", _cur_grfconfig->filename, _nfo_line, buf);

   154

}

   155

   156

static inline bool check_length(int real, int wanted, const char *str)

   157

{

   158

	if (real >= wanted) return true;

   159

	grfmsg(0, "%s: Invalid pseudo sprite length %d (expected %d)!", str, real, wanted);

   160

	return false;

   161

}

   162

   163

static inline byte grf_load_byte(byte **buf)

   164

{

   165

	return *(*buf)++;

   166

}

   167

   168

static uint16 grf_load_word(byte **buf)

   169

{

   170

	uint16 val = grf_load_byte(buf);

   171

	return val | (grf_load_byte(buf) << 8);

   172

}

   173

   174

static uint16 grf_load_extended(byte** buf)

   175

{

   176

	uint16 val;

   177

	val = grf_load_byte(buf);

   178

	if (val == 0xFF) val = grf_load_word(buf);

   179

	return val;

   180

}

   181

   182

static uint32 grf_load_dword(byte **buf)

   183

{

   184

	uint32 val = grf_load_word(buf);

   185

	return val | (grf_load_word(buf) << 16);

   186

}

   187

   188

static uint32 grf_load_var(byte size, byte **buf)

   189

{

   190

	switch (size) {

   191

		case 1: return grf_load_byte(buf);

   192

		case 2: return grf_load_word(buf);

   193

		case 4: return grf_load_dword(buf);

   194

		default:

   195

			NOT_REACHED();

   196

			return 0;

   197

	}

   198

}

   199

   200

static const char *grf_load_string(byte **buf, size_t max_len)

   201

{

   202

	const char *string   = *(const char **)buf;

   203

	size_t string_length = ttd_strnlen(string, max_len);

   204

   205

	if (string_length == max_len) {

   206

		/* String was not NUL terminated, so make sure it is now. */

   207

		(*buf)[string_length - 1] = '\0';

   208

		grfmsg(7, "String was not terminated with a zero byte.");

   209

	} else {

   210

		/* Increase the string length to include the NUL byte. */

   211

		string_length++;

   212

	}

   213

	*buf += string_length;

   214

   215

	return string;

   216

}

   217

   218

static GRFFile *GetFileByGRFID(uint32 grfid)

   219

{

   220

	GRFFile *file;

   221

   222

	for (file = _first_grffile; file != NULL; file = file->next) {

   223

		if (file->grfid == grfid) break;

   224

	}

   225

	return file;

   226

}

   227

   228

static GRFFile *GetFileByFilename(const char *filename)

   229

{

   230

	GRFFile *file;

   231

   232

	for (file = _first_grffile; file != NULL; file = file->next) {

   233

		if (strcmp(file->filename, filename) == 0) break;

   234

	}

   235

	return file;

   236

}

   237

   238

   239

/** Used when setting an object's property to map to the GRF's strings

   240

 * while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one

   241

 * @param str StringID that we want to have the equivalent in OoenTTD

   242

 * @return the properly adjusted StringID

   243

 */

   244

static StringID MapGRFStringID(StringID str)

   245

{

   246

	/* 0xD0 and 0xDC stand for all the TextIDs in the range

   248

	 * These strings are unique to each grf file, and thus require to be used with the

   249

	 * grfid in which they are declared */

   250

	if (GB(str, 8, 8) == 0xD0 || GB(str, 8, 8) == 0xDC) {

   251

		return GetGRFStringID(_cur_grffile->grfid, str);

   252

	}

   253

   254

	/* Map building names according to our lang file changes

   255

	 * 0x200F = Tall Office Block, first house name in the original data, the one that TTDPatch stil uses

   256

	 * 0x201F = Old houses is the last house name.

   257

	 * OpenTTD does not have exactly the same order aymore, so, the code below allows

   258

	 * to compensate for the difference */

   259

	if (str >= 0x200F && str <= 0x201F) return str + (STR_200F_TALL_OFFICE_BLOCK - 0x200F);

   260

   261

	return str;

   262

}

   263

   264

   265

typedef bool (*VCI_Handler)(uint engine, int numinfo, int prop, byte **buf, int len);

   266

   267

#define FOR_EACH_OBJECT for (i = 0; i < numinfo; i++)

   268

   269

static void dewagonize(int condition, int engine)

   270

{

   271

	EngineInfo *ei = &_engine_info[engine];

   272

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   273

   274

	if (condition != 0) {

   275

		ei->unk2 &= ~0x80;

   276

		if (rvi->railveh_type == RAILVEH_WAGON)

   277

			rvi->railveh_type = RAILVEH_SINGLEHEAD;

   278

	} else {

   279

		ei->unk2 |= 0x80;

   280

		rvi->railveh_type = RAILVEH_WAGON;

   281

	}

   282

}

   283

   284

static bool RailVehicleChangeInfo(uint engine, int numinfo, int prop, byte **bufp, int len)

   285

{

   286

	EngineInfo *ei = &_engine_info[engine];

   287

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   288

	byte *buf = *bufp;

   289

	int i;

   290

	bool ret = false;

   291

   292

	switch (prop) {

   294

			FOR_EACH_OBJECT {

   295

				uint8 tracktype = grf_load_byte(&buf);

   296

   297

				switch (tracktype) {

   298

					case 0: rvi[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   299

					case 1: rvi[i].railtype = RAILTYPE_MONO; break;

   300

					case 2: rvi[i].railtype = RAILTYPE_MAGLEV; break;

   301

					default:

   302

						grfmsg(1, "RailVehicleChangeInfo: Invalid track type %d specified, ignoring", tracktype);

   303

						break;

   304

				}

   305

			}

   306

			break;

   307

   310

			FOR_EACH_OBJECT grf_load_byte(&buf);

   311

			ret = true;

   312

			break;

   313

   315

			FOR_EACH_OBJECT {

   316

				uint16 speed = grf_load_word(&buf);

   317

				if (speed == 0xFFFF) speed = 0;

   318

   319

				rvi[i].max_speed = speed;

   320

			}

   321

			break;

   322

   324

			FOR_EACH_OBJECT {

   325

				uint16 power = grf_load_word(&buf);

   326

   327

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) power /= 2;

   328

   329

				rvi[i].power = power;

   330

				dewagonize(power, engine + i);

   331

			}

   332

			break;

   333

   335

			FOR_EACH_OBJECT {

   336

				uint8 runcostfact = grf_load_byte(&buf);

   337

   338

				if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) runcostfact /= 2;

   339

   340

				rvi[i].running_cost_base = runcostfact;

   341

			}

   342

			break;

   343

   345

			FOR_EACH_OBJECT {

   346

				uint32 base = grf_load_dword(&buf);

   347

   348

				switch (base) {

   349

					case 0x4C30: rvi[i].running_cost_class = 0; break;

   350

					case 0x4C36: rvi[i].running_cost_class = 1; break;

   351

					case 0x4C3C: rvi[i].running_cost_class = 2; break;

   353

					default:

   354

						grfmsg(1, "RailVehicleChangeInfo: Unsupported running cost base 0x%04X, ignoring", base);

   355

						break;

   356

				}

   357

			}

   358

			break;

   359

   361

			FOR_EACH_OBJECT {

   362

				uint8 spriteid = grf_load_byte(&buf);

   363

   364

				/* TTD sprite IDs point to a location in a 16bit array, but we use it

   365

				 * as an array index, so we need it to be half the original value. */

   366

				if (spriteid < 0xFD) spriteid >>= 1;

   367

   368

				rvi[i].image_index = spriteid;

   369

			}

   370

			break;

   371

   373

			FOR_EACH_OBJECT {

   374

				uint8 dual = grf_load_byte(&buf);

   375

   376

				if (dual != 0) {

   377

					if (rvi[i].railveh_type != RAILVEH_MULTIHEAD) {

   378

						// adjust power and running cost if needed

   379

						rvi[i].power /= 2;

   380

						rvi[i].running_cost_base /= 2;

   381

					}

   382

					rvi[i].railveh_type = RAILVEH_MULTIHEAD;

   383

				} else {

   384

					if (rvi[i].railveh_type == RAILVEH_MULTIHEAD) {

   385

						// adjust power and running cost if needed

   386

						rvi[i].power *= 2;

   387

						rvi[i].running_cost_base *= 2;

   388

					}

   389

					rvi[i].railveh_type = rvi[i].power == 0 ?

   390

						RAILVEH_WAGON : RAILVEH_SINGLEHEAD;

   391

				}

   392

			}

   393

			break;

   394

   396

			FOR_EACH_OBJECT rvi[i].capacity = grf_load_byte(&buf);

   397

			break;

   398

   400

			FOR_EACH_OBJECT {

   401

				uint8 ctype = grf_load_byte(&buf);

   402

   403

				if (ctype < NUM_CARGO && HASBIT(_cargo_mask, ctype)) {

   404

					rvi[i].cargo_type = ctype;

   405

				} else {

   406

					rvi[i].cargo_type = CT_INVALID;

   407

					grfmsg(2, "RailVehicleChangeInfo: Invalid cargo type %d, using first refittable", ctype);

   408

				}

   409

			}

   410

			break;

   411

   413

			FOR_EACH_OBJECT SB(rvi[i].weight, 0, 8, grf_load_byte(&buf));

   414

			break;

   415

   417

			FOR_EACH_OBJECT rvi[i].base_cost = grf_load_byte(&buf);

   418

			break;

   419

   421

			FOR_EACH_OBJECT rvi[i].ai_rank = grf_load_byte(&buf);

   422

			break;

   423

   425

			/* What do the individual numbers mean?

   426

			 * 0x00 .. 0x07: Steam

   427

			 * 0x08 .. 0x27: Diesel

   428

			 * 0x28 .. 0x31: Electric

   429

			 * 0x32 .. 0x37: Monorail

   430

			 * 0x38 .. 0x41: Maglev

   431

			 */

   432

			FOR_EACH_OBJECT {

   433

				uint8 traction = grf_load_byte(&buf);

   434

				int engclass;

   435

   436

				if (traction <= 0x07) {

   437

					engclass = 0;

   438

				} else if (traction <= 0x27) {

   439

					engclass = 1;

   440

				} else if (traction <= 0x31) {

   441

					engclass = 2;

   442

				} else if (traction <= 0x41) {

   443

					engclass = 2;

   444

				} else {

   445

					break;

   446

				}

   447

				if (rvi[i].railtype == RAILTYPE_RAIL     && engclass == 2) rvi[i].railtype = RAILTYPE_ELECTRIC;

   448

				if (rvi[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) rvi[i].railtype = RAILTYPE_RAIL;

   449

   450

				rvi[i].engclass = engclass;

   451

			}

   452

			break;

   453

   455

			FOR_EACH_OBJECT {

   456

				EngineID pos = grf_load_byte(&buf);

   457

   458

				if (pos < NUM_TRAIN_ENGINES) {

   459

					AlterRailVehListOrder(engine + i, pos);

   460

				} else {

   461

					grfmsg(2, "RailVehicleChangeInfo: Invalid train engine ID %d, ignoring", pos);

   462

				}

   463

			}

   464

			break;

   465

   467

			FOR_EACH_OBJECT rvi[i].pow_wag_power = grf_load_word(&buf);

   468

			break;

   469

   471

			FOR_EACH_OBJECT ei[i].refit_cost = grf_load_byte(&buf);

   472

			break;

   473

   475

			FOR_EACH_OBJECT ei[i].refit_mask = grf_load_dword(&buf);

   476

			break;

   477

   479

			FOR_EACH_OBJECT ei[i].callbackmask = grf_load_byte(&buf);

   480

			break;

   481

   483

			FOR_EACH_OBJECT rvi[i].tractive_effort = grf_load_byte(&buf);

   484

			break;

   485