1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

     5

#include <stdarg.h>

     6

     7

#include "openttd.h"

     8

#include "debug.h"

     9

#include "gfx.h"

    10

#include "fileio.h"

    11

#include "functions.h"

    12

#include "engine.h"

    13

#include "spritecache.h"

    14

#include "station.h"

    15

#include "sprite.h"

    16

#include "newgrf.h"

    17

#include "variables.h"

    18

#include "string.h"

    19

#include "table/strings.h"

    20

#include "bridge.h"

    21

#include "economy.h"

    22

#include "newgrf_engine.h"

    23

#include "vehicle.h"

    24

#include "newgrf_text.h"

    25

#include "table/sprites.h"

    26

    27

#include "newgrf_spritegroup.h"

    28

    29

/* TTDPatch extended GRF format codec

    30

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

    31

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

    32

 *

    33

 * Contains portions of documentation by TTDPatch team.

    34

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

    35

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

    36

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

    37

    38

    39

static int _skip_sprites; // XXX

    40

static uint _file_index; // XXX

    41

SpriteID _signal_base = 0;

    42

    43

static GRFFile *_cur_grffile;

    44

GRFFile *_first_grffile;

    45

GRFConfig *_first_grfconfig;

    46

static SpriteID _cur_spriteid;

    47

static int _cur_stage;

    48

static uint32 _nfo_line;

    49

    50

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

    51

static byte _misc_grf_features = 0;

    52

    53

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

    54

static uint32 _ttdpatch_flags[8];

    55

    56

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

    57

static byte *_preload_sprite = NULL;

    58

    59

    60

typedef enum grfspec_feature {

    61

	GSF_TRAIN,

    62

	GSF_ROAD,

    63

	GSF_SHIP,

    64

	GSF_AIRCRAFT,

    65

	GSF_STATION,

    66

	GSF_CANAL,

    67

	GSF_BRIDGE,

    68

	GSF_TOWNHOUSE,

    69

	GSF_GLOBALVAR,

    70

	GSF_INDUSTRYTILES,

    71

	GSF_INDUSTRIES,

    72

	GSF_CARGOS,

    73

	GSF_SOUNDFX,

    74

} grfspec_feature;

    75

    76

    77

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

    78

    79

static const int _vehcounts[4] = {

    80

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    81

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    82

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    83

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    84

};

    85

    86

static const int _vehshifts[4] = {

    87

	/* GSF_TRAIN */    0,

    88

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    89

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    90

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    91

};

    92

    93

enum {

    94

	MAX_STATIONS = 256,

    95

};

    96

    97

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    98

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    99

   100

/* Debugging messages policy:

   101

 *

   102

 * These should be the severities used for direct DEBUG() calls

   103

 * (there is room for exceptions, but you have to have a good cause):

   104

 *

   105

 * 0..2 - dedicated to grfmsg()

   106

 * 3

   107

 * 4

   108

 * 5

   109

 * 6 - action handler entry reporting - one per action

   110

 * 7 - basic action progress reporting - in loops, only single one allowed

   111

 * 8 - more detailed progress reporting - less important stuff, in deep loops etc

   112

 * 9 - extremely detailed progress reporting - detailed reports inside of deep loops and so

   113

 */

   114

   115

   116

typedef enum grfmsg_severity {

   117

	GMS_NOTICE,

   118

	GMS_WARN,

   119

	GMS_ERROR,

   120

	GMS_FATAL,

   121

} grfmsg_severity;

   122

   123

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

   124

{

   125

	static const char* const severitystr[] = {

   126

		"Notice",

   127

		"Warning",

   128

		"Error",

   129

		"Fatal"

   130

	};

   131

	int export_severity = 0;

   132

	char buf[1024];

   133

	va_list va;

   134

   135

	va_start(va, str);

   136

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

   137

	va_end(va);

   138

   139

	export_severity = 2 - (severity == GMS_FATAL ? 2 : severity);

   140

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

   141

}

   142

   143

   144

#define check_length(real, wanted, where) \

   145

do { \

   146

	if (real < wanted) { \

   147

		grfmsg(GMS_ERROR, "%s: Invalid special sprite length %d (expected %d)!", \

   148

		       where, real, wanted); \

   149

		return; \

   150

	} \

   151

} while (0)

   152

   153

   154

static inline byte grf_load_byte(byte **buf)

   155

{

   156

	return *(*buf)++;

   157

}

   158

   159

static uint16 grf_load_word(byte **buf)

   160

{

   161

	uint16 val = grf_load_byte(buf);

   162

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

   163

}

   164

   165

static uint16 grf_load_extended(byte** buf)

   166

{

   167

	uint16 val;

   168

	val = grf_load_byte(buf);

   169

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

   170

	return val;

   171

}

   172

   173

static uint32 grf_load_dword(byte **buf)

   174

{

   175

	uint32 val = grf_load_word(buf);

   176

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

   177

}

   178

   179

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

   180

{

   181

	switch (size) {

   182

		case 1: return grf_load_byte(buf);

   183

		case 2: return grf_load_word(buf);

   184

		case 4: return grf_load_dword(buf);

   185

		default:

   186

			NOT_REACHED();

   187

			return 0;

   188

	}

   189

}

   190

   191

static GRFFile *GetFileByGRFID(uint32 grfid)

   192

{

   193

	GRFFile *file;

   194

   195

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

   196

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

   197

	}

   198

	return file;

   199

}

   200

   201

static GRFFile *GetFileByFilename(const char *filename)

   202

{

   203

	GRFFile *file;

   204

   205

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

   206

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

   207

	}

   208

	return file;

   209

}

   210

   211

   212

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

   213

   214

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

   215

   216

static void dewagonize(int condition, int engine)

   217

{

   218

	EngineInfo *ei = &_engine_info[engine];

   219

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   220

   221

	if (condition != 0) {

   222

		ei->unk2 &= ~0x80;

   223

		rvi->flags &= ~2;

   224

	} else {

   225

		ei->unk2 |= 0x80;

   226

		rvi->flags |= 2;

   227

	}

   228

}

   229

   230

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

   231

{

   232

	EngineInfo *ei = &_engine_info[engine];

   233

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   234

	byte *buf = *bufp;

   235

	int i;

   236

	bool ret = false;

   237

   238

	switch (prop) {

   239

		case 0x05: /* Track type */

   240

			FOR_EACH_OBJECT {

   241

				uint8 tracktype = grf_load_byte(&buf);

   242

   243

				switch (tracktype) {

   244

					case 0: ei[i].railtype = RAILTYPE_RAIL; break;

   245

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

   246

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

   247

					default:

   248

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

   249

						break;

   250

				}

   251

			}

   252

			break;

   253

   254

		case 0x08: /* AI passenger service */

   255

			/* TODO */

   256

			FOR_EACH_OBJECT grf_load_byte(&buf);

   257

			ret = true;

   258

			break;

   259

   260

		case 0x09: /* Speed (1 unit is 1 kmh) */

   261

			FOR_EACH_OBJECT {

   262

				uint16 speed = grf_load_word(&buf);

   263

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

   264

   265

				rvi[i].max_speed = speed;

   266

			}

   267

			break;

   268

   269

		case 0x0B: /* Power */

   270

			FOR_EACH_OBJECT {

   271

				uint16 power = grf_load_word(&buf);

   272

   273

				if (rvi[i].flags & RVI_MULTIHEAD) power /= 2;

   274

   275

				rvi[i].power = power;

   276

				dewagonize(power, engine + i);

   277

			}

   278

			break;

   279

   280

		case 0x0D: /* Running cost factor */

   281

			FOR_EACH_OBJECT {

   282

				uint8 runcostfact = grf_load_byte(&buf);

   283

   284

				if (rvi[i].flags & RVI_MULTIHEAD) runcostfact /= 2;

   285

   286

				rvi[i].running_cost_base = runcostfact;

   287

			}

   288

			break;

   289

   290

		case 0x0E: /* Running cost base */

   291

			FOR_EACH_OBJECT {

   292

				uint32 base = grf_load_dword(&buf);

   293

   294

				switch (base) {

   295

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

   296

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

   297

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

   298

				}

   299

			}

   300

			break;

   301

   302

		case 0x12: /* Sprite ID */

   303

			FOR_EACH_OBJECT {

   304

				uint8 spriteid = grf_load_byte(&buf);

   305

   306

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

   307

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

   308

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

   309

   310

				rvi[i].image_index = spriteid;

   311

			}

   312

			break;

   313

   314

		case 0x13: /* Dual-headed */

   315

			FOR_EACH_OBJECT {

   316

				uint8 dual = grf_load_byte(&buf);

   317

   318

				if (dual != 0) {

   319

					if (!(rvi[i].flags & RVI_MULTIHEAD)) {

   320

						// adjust power and running cost if needed

   321

						rvi[i].power /= 2;

   322

						rvi[i].running_cost_base /= 2;

   323

					}

   324

					rvi[i].flags |= RVI_MULTIHEAD;

   325

				} else {

   326

					if (rvi[i].flags & RVI_MULTIHEAD) {

   327

						// adjust power and running cost if needed

   328

						rvi[i].power *= 2;

   329

						rvi[i].running_cost_base *= 2;

   330

					}

   331

					rvi[i].flags &= ~RVI_MULTIHEAD;

   332

				}

   333

			}

   334

			break;

   335

   336

		case 0x14: /* Cargo capacity */

   337

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

   338

			break;

   339

   340

		case 0x15: /* Cargo type */

   341

			FOR_EACH_OBJECT {

   342

				uint8 ctype = grf_load_byte(&buf);

   343

   344

				if (ctype < NUM_CARGO) {

   345

					rvi[i].cargo_type = ctype;

   346

				} else {

   347

					grfmsg(GMS_NOTICE, "RailVehicleChangeInfo: Invalid cargo type %d, ignoring.", ctype);

   348

				}

   349

			}

   350

			break;

   351

   352

		case 0x16: /* Weight */

   353

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

   354

			break;

   355

   356

		case 0x17: /* Cost factor */

   357

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

   358

			break;

   359

   360

		case 0x18: /* AI rank */

   361

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

   362

			break;

   363

   364

		case 0x19: /* Engine traction type */

   365

			/* What do the individual numbers mean?

   366

			 * 0x00 .. 0x07: Steam

   367

			 * 0x08 .. 0x27: Diesel

   368

			 * 0x28 .. 0x31: Electric

   369

			 * 0x32 .. 0x37: Monorail

   370

			 * 0x38 .. 0x41: Maglev

   371

			 */

   372

			FOR_EACH_OBJECT {

   373

				uint8 traction = grf_load_byte(&buf);

   374

				int engclass;

   375

   376

				if (traction <= 0x07) {

   377

					engclass = 0;

   378

				} else if (traction <= 0x27) {

   379

					engclass = 1;

   380

				} else if (traction <= 0x31) {

   381

					engclass = 2;

   382

					ei[i].railtype = RAILTYPE_ELECTRIC;

   383

				} else if (traction <= 0x41) {

   384

					engclass = 2;

   385

				} else {

   386

					break;

   387

				}

   388

   389

				rvi[i].engclass = engclass;

   390

			}

   391

			break;

   392

   393

		case 0x1A: /* Alter purchase list sort order */

   394

			FOR_EACH_OBJECT {

   395

				EngineID pos = grf_load_byte(&buf);

   396

   397

				if (pos < NUM_TRAIN_ENGINES) {

   398

					AlterRailVehListOrder(engine + i, pos);

   399

				} else {

   400

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

   401

				}

   402

			}

   403

			break;

   404

   405

		case 0x1B: /* Powered wagons power bonus */

   406

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

   407

			break;

   408

   409

		case 0x1C: /* Refit cost */

   410

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

   411

			break;

   412

   413

		case 0x1D: /* Refit cargo */

   414

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

   415

			break;

   416

   417

		case 0x1E: /* Callback */

   418

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

   419

			break;

   420

   421

		case 0x21: /* Shorter vehicle */

   422

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

   423

			break;

   424

   425

		case 0x22: /* Visual effect */

   426

			// see note in engine.h about rvi->visual_effect

   427

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

   428

			break;

   429

   430

		case 0x23: /* Powered wagons weight bonus */

   431

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

   432

			break;

   433

   434

		case 0x24: /* High byte of vehicle weight */

   435

			FOR_EACH_OBJECT {

   436

				byte weight = grf_load_byte(&buf);

   437

   438

				if (weight > 4) {

   439

					grfmsg(GMS_NOTICE, "RailVehicleChangeInfo: Nonsensical weight of %d tons, ignoring.", weight << 8);

   440

				} else {

   441

					SB(rvi[i].weight, 8, 8, weight);

   442

				}

   443

			}

   444

			break;

   445

   446

		case 0x25: /* User-defined bit mask to set when checking veh. var. 42 */

   447

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

   448

			break;

   449

   450

		case 0x27: /* Miscellaneous flags */

   451

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

   452

			break;

   453

   454

		case 0x28: /* Cargo classes allowed */

   455

			FOR_EACH_OBJECT cargo_allowed[engine + i] = grf_load_word(&buf);

   456

			break;

   457

   458

		case 0x29: /* Cargo classes disallowed */

   459

			FOR_EACH_OBJECT cargo_disallowed[engine + i] = grf_load_word(&buf);

   460

			break;

   461

   462

		/* TODO */

   463

		/* Fall-through for unimplemented one byte long properties. */

   464

		case 0x1F: /* Tractive effort */

   465

		case 0x20: /* Air drag */

   466

		case 0x26: /* Retire vehicle early */

   467

			/* TODO */

   468

			FOR_EACH_OBJECT grf_load_byte(&buf);

   469

			ret = true;

   470

			break;

   471

   472

		default:

   473

			ret = true;

   474

			break;

   475

	}

   476

	*bufp = buf;

   477

	return ret;

   478

}

   479

   480

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

   481

{

   482

	EngineInfo *ei = &_engine_info[ROAD_ENGINES_INDEX + engine];

   483

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   484

	byte *buf = *bufp;

   485

	int i;

   486

	bool ret = false;

   487

   488

	switch (prop) {

   489

		case 0x08: /* Speed (1 unit is 0.5 kmh) */

   490

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