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

uint16 _custom_sprites_base;

    40

static int _skip_sprites; // XXX

    41

static uint _file_index; // XXX

    42

SpriteID _signal_base = 0;

    43

    44

static GRFFile *_cur_grffile;

    45

GRFFile *_first_grffile;

    46

GRFConfig *_first_grfconfig;

    47

static SpriteID _cur_spriteid;

    48

static int _cur_stage;

    49

static uint32 _nfo_line;

    50

    51

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

    52

static byte _misc_grf_features = 0;

    53

    54

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

    55

static uint32 _ttdpatch_flags[8];

    56

    57

    58

typedef enum grfspec_feature {

    59

	GSF_TRAIN,

    60

	GSF_ROAD,

    61

	GSF_SHIP,

    62

	GSF_AIRCRAFT,

    63

	GSF_STATION,

    64

	GSF_CANAL,

    65

	GSF_BRIDGE,

    66

	GSF_TOWNHOUSE,

    67

	GSF_GLOBALVAR,

    68

	GSF_INDUSTRYTILES,

    69

	GSF_INDUSTRIES,

    70

	GSF_CARGOS,

    71

	GSF_SOUNDFX,

    72

} grfspec_feature;

    73

    74

    75

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

    76

    77

static const int _vehcounts[4] = {

    78

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    79

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    80

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    81

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    82

};

    83

    84

static const int _vehshifts[4] = {

    85

	/* GSF_TRAIN */    0,

    86

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    87

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    88

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    89

};

    90

    91

enum {

    92

	MAX_STATIONS = 256,

    93

};

    94

    95

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    96

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    97

    98

/* Debugging messages policy:

    99

 *

   100

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

   101

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

   102

 *

   103

 * 0..2 - dedicated to grfmsg()

   104

 * 3

   105

 * 4

   106

 * 5

   107

 * 6 - action handler entry reporting - one per action

   108

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

   109

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

   110

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

   111

 */

   112

   113

   114

typedef enum grfmsg_severity {

   115

	GMS_NOTICE,

   116

	GMS_WARN,

   117

	GMS_ERROR,

   118

	GMS_FATAL,

   119

} grfmsg_severity;

   120

   121

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

   122

{

   123

	static const char* const severitystr[] = {

   124

		"Notice",

   125

		"Warning",

   126

		"Error",

   127

		"Fatal"

   128

	};

   129

	int export_severity = 0;

   130

	char buf[1024];

   131

	va_list va;

   132

   133

	va_start(va, str);

   134

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

   135

	va_end(va);

   136

   137

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

   138

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

   139

}

   140

   141

   142

#define check_length(real, wanted, where) \

   143

do { \

   144

	if (real < wanted) { \

   145

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

   146

		       where, real, wanted); \

   147

		return; \

   148

	} \

   149

} while (0)

   150

   151

   152

static inline byte grf_load_byte(byte **buf)

   153

{

   154

	return *(*buf)++;

   155

}

   156

   157

static uint16 grf_load_word(byte **buf)

   158

{

   159

	uint16 val = grf_load_byte(buf);

   160

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

   161

}

   162

   163

static uint16 grf_load_extended(byte** buf)

   164

{

   165

	uint16 val;

   166

	val = grf_load_byte(buf);

   167

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

   168

	return val;

   169

}

   170

   171

static uint32 grf_load_dword(byte **buf)

   172

{

   173

	uint32 val = grf_load_word(buf);

   174

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

   175

}

   176

   177

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

   178

{

   179

	switch (size) {

   180

		case 1: return grf_load_byte(buf);

   181

		case 2: return grf_load_word(buf);

   182

		case 4: return grf_load_dword(buf);

   183

		default:

   184

			NOT_REACHED();

   185

			return 0;

   186

	}

   187

}

   188

   189

static GRFFile *GetFileByGRFID(uint32 grfid)

   190

{

   191

	GRFFile *file;

   192

   193

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

   194

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

   195

	}

   196

	return file;

   197

}

   198

   199

static GRFFile *GetFileByFilename(const char *filename)

   200

{

   201

	GRFFile *file;

   202

   203

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

   204

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

   205

	}

   206

	return file;

   207

}

   208

   209

   210

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

   211

   212

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

   213

   214

static void dewagonize(int condition, int engine)

   215

{

   216

	EngineInfo *ei = &_engine_info[engine];

   217

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   218

   219

	if (condition != 0) {

   220

		ei->unk2 &= ~0x80;

   221

		rvi->flags &= ~2;

   222

	} else {

   223

		ei->unk2 |= 0x80;

   224

		rvi->flags |= 2;

   225

	}

   226

}

   227

   228

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

   229

{

   230

	EngineInfo *ei = &_engine_info[engine];

   231

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   232

	byte *buf = *bufp;

   233

	int i;

   234

	bool ret = false;

   235

   236

	switch (prop) {

   237

		case 0x05: /* Track type */

   238

			FOR_EACH_OBJECT {

   239

				uint8 tracktype = grf_load_byte(&buf);

   240

   241

				switch (tracktype) {

   242

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

   243

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

   244

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

   245

					default:

   246

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

   247

						break;

   248

				}

   249

			}

   250

			break;

   251

   252

		case 0x08: /* AI passenger service */

   253

			/* TODO */

   254

			FOR_EACH_OBJECT grf_load_byte(&buf);

   255

			ret = true;

   256

			break;

   257

   258

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

   259

			FOR_EACH_OBJECT {

   260

				uint16 speed = grf_load_word(&buf);

   261

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

   262

   263

				rvi[i].max_speed = speed;

   264

			}

   265

			break;

   266

   267

		case 0x0B: /* Power */

   268

			FOR_EACH_OBJECT {

   269

				uint16 power = grf_load_word(&buf);

   270

   271

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

   272

   273

				rvi[i].power = power;

   274

				dewagonize(power, engine + i);

   275

			}

   276

			break;

   277

   278

		case 0x0D: /* Running cost factor */

   279

			FOR_EACH_OBJECT {

   280

				uint8 runcostfact = grf_load_byte(&buf);

   281

   282

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

   283

   284

				rvi[i].running_cost_base = runcostfact;

   285

			}

   286

			break;

   287

   288

		case 0x0E: /* Running cost base */

   289

			FOR_EACH_OBJECT {

   290

				uint32 base = grf_load_dword(&buf);

   291

   292

				switch (base) {

   293

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

   294

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

   295

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

   296

				}

   297

			}

   298

			break;

   299

   300

		case 0x12: /* Sprite ID */

   301

			FOR_EACH_OBJECT {

   302

				uint8 spriteid = grf_load_byte(&buf);

   303

   304

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

   305

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

   306

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

   307

   308

				rvi[i].image_index = spriteid;

   309

			}

   310

			break;

   311

   312

		case 0x13: /* Dual-headed */

   313

			FOR_EACH_OBJECT {

   314

				uint8 dual = grf_load_byte(&buf);

   315

   316

				if (dual != 0) {

   317

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

   318

						// adjust power and running cost if needed

   319

						rvi[i].power /= 2;

   320

						rvi[i].running_cost_base /= 2;

   321

					}

   322

					rvi[i].flags |= RVI_MULTIHEAD;

   323

				} else {

   324

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

   325

						// adjust power and running cost if needed

   326

						rvi[i].power *= 2;

   327

						rvi[i].running_cost_base *= 2;

   328

					}

   329

					rvi[i].flags &= ~RVI_MULTIHEAD;

   330

				}

   331

			}

   332

			break;

   333

   334

		case 0x14: /* Cargo capacity */

   335

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

   336

			break;

   337

   338

		case 0x15: /* Cargo type */

   339

			FOR_EACH_OBJECT {

   340

				uint8 ctype = grf_load_byte(&buf);

   341

   342

				if (ctype < NUM_CARGO) {

   343

					rvi[i].cargo_type = ctype;

   344

				} else {

   345

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

   346

				}

   347

			}

   348

			break;

   349

   350

		case 0x16: /* Weight */

   351

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

   352

			break;

   353

   354

		case 0x17: /* Cost factor */

   355

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

   356

			break;

   357

   358

		case 0x18: /* AI rank */

   359

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

   360

			break;

   361

   362

		case 0x19: /* Engine traction type */

   363

			/* What do the individual numbers mean?

   364

			 * 0x00 .. 0x07: Steam

   365

			 * 0x08 .. 0x27: Diesel

   366

			 * 0x28 .. 0x31: Electric

   367

			 * 0x32 .. 0x37: Monorail

   368

			 * 0x38 .. 0x41: Maglev

   369

			 */

   370

			FOR_EACH_OBJECT {

   371

				uint8 traction = grf_load_byte(&buf);

   372

				int engclass;

   373

   374

				if (traction <= 0x07) {

   375

					engclass = 0;

   376

				} else if (traction <= 0x27) {

   377

					engclass = 1;

   378

				} else if (traction <= 0x31) {

   379

					engclass = 2;

   380

					ei[i].railtype = RAILTYPE_ELECTRIC;

   381

				} else if (traction <= 0x41) {

   382

					engclass = 2;

   383

				} else {

   384

					break;

   385

				}

   386

   387

				rvi[i].engclass = engclass;

   388

			}

   389

			break;

   390

   391

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

   392

			FOR_EACH_OBJECT {

   393

				EngineID pos = grf_load_byte(&buf);

   394

   395

				if (pos < NUM_TRAIN_ENGINES) {

   396

					AlterRailVehListOrder(engine + i, pos);

   397

				} else {

   398

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

   399

				}

   400

			}

   401

			break;

   402

   403

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

   404

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

   405

			break;

   406

   407

		case 0x1D: /* Refit cargo */

   408

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

   409

			break;

   410

   411

		case 0x1E: /* Callback */

   412

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

   413

			break;

   414

   415

		case 0x21: /* Shorter vehicle */

   416

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

   417

			break;

   418

   419

		case 0x22: /* Visual effect */

   420

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

   421

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

   422

			break;

   423

   424

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

   425

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

   426

			break;

   427

   428

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

   429

			FOR_EACH_OBJECT {

   430

				byte weight = grf_load_byte(&buf);

   431

   432

				if (weight > 4) {

   433

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

   434

				} else {

   435

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

   436

				}

   437

			}

   438

			break;

   439

   440

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

   441

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

   442

			break;

   443

   444

		case 0x27: /* Miscellaneous flags */

   445

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

   446

			break;

   447

   448

		case 0x28: /* Cargo classes allowed */

   449

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

   450

			break;

   451

   452

		case 0x29: /* Cargo classes disallowed */

   453

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

   454

			break;

   455

   456

		/* TODO */

   457

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

   458

		case 0x1C: /* Refit cost */

   459

		case 0x1F: /* Tractive effort */

   460

		case 0x20: /* Air drag */

   461

		case 0x26: /* Retire vehicle early */

   462

			/* TODO */

   463

			FOR_EACH_OBJECT grf_load_byte(&buf);

   464

			ret = true;

   465

			break;

   466

   467

		default:

   468

			ret = true;

   469

			break;

   470

	}

   471

	*bufp = buf;

   472

	return ret;

   473

}

   474

   475

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

   476

{

   477

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

   478

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   479

	byte *buf = *bufp;

   480

	int i;

   481

	bool ret = false;

   482

   483

	switch (prop) {

   484

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

   485

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

   486

			break;

   487

   488

		case 0x09: /* Running cost factor */

   489

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

   490

			break;

   491

   492

		case 0x0A: /* Running cost base */

   493

			/* TODO: I have no idea. --pasky */

   494

			FOR_EACH_OBJECT grf_load_dword(&buf);

   495

			ret = true;

   496

			break;

   497

   498

		case 0x0E: /* Sprite ID */

   499

			FOR_EACH_OBJECT {