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

    57

typedef enum grfspec_feature {

    58

	GSF_TRAIN,

    59

	GSF_ROAD,

    60

	GSF_SHIP,

    61

	GSF_AIRCRAFT,

    62

	GSF_STATION,

    63

	GSF_CANAL,

    64

	GSF_BRIDGE,

    65

	GSF_TOWNHOUSE,

    66

	GSF_GLOBALVAR,

    67

	GSF_INDUSTRYTILES,

    68

	GSF_INDUSTRIES,

    69

	GSF_CARGOS,

    70

	GSF_SOUNDFX,

    71

} grfspec_feature;

    72

    73

    74

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

    75

    76

static const int _vehcounts[4] = {

    77

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    78

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    79

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    80

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    81

};

    82

    83

static const int _vehshifts[4] = {

    84

	/* GSF_TRAIN */    0,

    85

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    86

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    87

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    88

};

    89

    90

enum {

    91

	MAX_STATIONS = 256,

    92

};

    93

    94

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    95

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    96

    97

/* Debugging messages policy:

    98

 *

    99

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

   100

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

   101

 *

   102

 * 0..2 - dedicated to grfmsg()

   103

 * 3

   104

 * 4

   105

 * 5

   106

 * 6 - action handler entry reporting - one per action

   107

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

   108

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

   109

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

   110

 */

   111

   112

   113

typedef enum grfmsg_severity {

   114

	GMS_NOTICE,

   115

	GMS_WARN,

   116

	GMS_ERROR,

   117

	GMS_FATAL,

   118

} grfmsg_severity;

   119

   120

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

   121

{

   122

	static const char* const severitystr[] = {

   123

		"Notice",

   124

		"Warning",

   125

		"Error",

   126

		"Fatal"

   127

	};

   128

	int export_severity = 0;

   129

	char buf[1024];

   130

	va_list va;

   131

   132

	va_start(va, str);

   133

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

   134

	va_end(va);

   135

   136

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

   137

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

   138

}

   139

   140

   141

#define check_length(real, wanted, where) \

   142

do { \

   143

	if (real < wanted) { \

   144

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

   145

		       where, real, wanted); \

   146

		return; \

   147

	} \

   148

} while (0)

   149

   150

   151

static inline byte grf_load_byte(byte **buf)

   152

{

   153

	return *(*buf)++;

   154

}

   155

   156

static uint16 grf_load_word(byte **buf)

   157

{

   158

	uint16 val = grf_load_byte(buf);

   159

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

   160

}

   161

   162

static uint16 grf_load_extended(byte** buf)

   163

{

   164

	uint16 val;

   165

	val = grf_load_byte(buf);

   166

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

   167

	return val;

   168

}

   169

   170

static uint32 grf_load_dword(byte **buf)

   171

{

   172

	uint32 val = grf_load_word(buf);

   173

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

   174

}

   175

   176

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

   177

{

   178

	switch (size) {

   179

		case 1: return grf_load_byte(buf);

   180

		case 2: return grf_load_word(buf);

   181

		case 4: return grf_load_dword(buf);

   182

		default:

   183

			NOT_REACHED();

   184

			return 0;

   185

	}

   186

}

   187

   188

static GRFFile *GetFileByGRFID(uint32 grfid)

   189

{

   190

	GRFFile *file;

   191

   192

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

   193

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

   194

	}

   195

	return file;

   196

}

   197

   198

static GRFFile *GetFileByFilename(const char *filename)

   199

{

   200

	GRFFile *file;

   201

   202

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

   203

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

   204

	}

   205

	return file;

   206

}

   207

   208

   209

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

   210

   211

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

   212

   213

static void dewagonize(int condition, int engine)

   214

{

   215

	EngineInfo *ei = &_engine_info[engine];

   216

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   217

   218

	if (condition != 0) {

   219

		ei->unk2 &= ~0x80;

   220

		rvi->flags &= ~2;

   221

	} else {

   222

		ei->unk2 |= 0x80;

   223

		rvi->flags |= 2;

   224

	}

   225

}

   226

   227

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

   228

{

   229

	EngineInfo *ei = &_engine_info[engine];

   230

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   231

	byte *buf = *bufp;

   232

	int i;

   233

	bool ret = false;

   234

   235

	switch (prop) {

   236

		case 0x05: /* Track type */

   237

			FOR_EACH_OBJECT {

   238

				uint8 tracktype = grf_load_byte(&buf);

   239

   240

				switch (tracktype) {

   241

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

   242

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

   243

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

   244

					default:

   245

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

   246

						break;

   247

				}

   248

			}

   249

			break;

   250

   251

		case 0x08: /* AI passenger service */

   252

			/* TODO */

   253

			FOR_EACH_OBJECT grf_load_byte(&buf);

   254

			ret = true;

   255

			break;

   256

   257

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

   258

			FOR_EACH_OBJECT {

   259

				uint16 speed = grf_load_word(&buf);

   260

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

   261

   262

				rvi[i].max_speed = speed;

   263

			}

   264

			break;

   265

   266

		case 0x0B: /* Power */

   267

			FOR_EACH_OBJECT {

   268

				uint16 power = grf_load_word(&buf);

   269

   270

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

   271

   272

				rvi[i].power = power;

   273

				dewagonize(power, engine + i);

   274

			}

   275

			break;

   276

   277

		case 0x0D: /* Running cost factor */

   278

			FOR_EACH_OBJECT {

   279

				uint8 runcostfact = grf_load_byte(&buf);

   280

   281

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

   282

   283

				rvi[i].running_cost_base = runcostfact;

   284

			}

   285

			break;

   286

   287

		case 0x0E: /* Running cost base */

   288

			FOR_EACH_OBJECT {

   289

				uint32 base = grf_load_dword(&buf);

   290

   291

				switch (base) {

   292

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

   293

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

   294

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

   295

				}

   296

			}

   297

			break;

   298

   299

		case 0x12: /* Sprite ID */

   300

			FOR_EACH_OBJECT {

   301

				uint8 spriteid = grf_load_byte(&buf);

   302

   303

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

   304

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

   305

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

   306

   307

				rvi[i].image_index = spriteid;

   308

			}

   309

			break;

   310

   311

		case 0x13: /* Dual-headed */

   312

			FOR_EACH_OBJECT {

   313

				uint8 dual = grf_load_byte(&buf);

   314

   315

				if (dual != 0) {

   316

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

   317

						// adjust power and running cost if needed

   318

						rvi[i].power /= 2;

   319

						rvi[i].running_cost_base /= 2;

   320

					}

   321

					rvi[i].flags |= RVI_MULTIHEAD;

   322

				} else {

   323

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

   324

						// adjust power and running cost if needed

   325

						rvi[i].power *= 2;

   326

						rvi[i].running_cost_base *= 2;

   327

					}

   328

					rvi[i].flags &= ~RVI_MULTIHEAD;

   329

				}

   330

			}

   331

			break;

   332

   333

		case 0x14: /* Cargo capacity */

   334

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

   335

			break;

   336

   337

		case 0x15: /* Cargo type */

   338

			FOR_EACH_OBJECT {

   339

				uint8 ctype = grf_load_byte(&buf);

   340

   341

				if (ctype < NUM_CARGO) {

   342

					rvi[i].cargo_type = ctype;

   343

				} else {

   344

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

   345

				}

   346

			}

   347

			break;

   348

   349

		case 0x16: /* Weight */

   350

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

   351

			break;

   352

   353

		case 0x17: /* Cost factor */

   354

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

   355

			break;

   356

   357

		case 0x18: /* AI rank */

   358

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

   359

			break;

   360

   361

		case 0x19: /* Engine traction type */

   362

			/* What do the individual numbers mean?

   363

			 * 0x00 .. 0x07: Steam

   364

			 * 0x08 .. 0x27: Diesel

   365

			 * 0x28 .. 0x31: Electric

   366

			 * 0x32 .. 0x37: Monorail

   367

			 * 0x38 .. 0x41: Maglev

   368

			 */

   369

			FOR_EACH_OBJECT {

   370

				uint8 traction = grf_load_byte(&buf);

   371

				int engclass;

   372

   373

				if (traction <= 0x07) {

   374

					engclass = 0;

   375

				} else if (traction <= 0x27) {

   376

					engclass = 1;

   377

				} else if (traction <= 0x31) {

   378

					engclass = 2;

   379

					ei[i].railtype = RAILTYPE_ELECTRIC;

   380

				} else if (traction <= 0x41) {

   381

					engclass = 2;

   382

				} else {

   383

					break;

   384

				}

   385

   386

				rvi[i].engclass = engclass;

   387

			}

   388

			break;

   389

   390

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

   391

			FOR_EACH_OBJECT {

   392

				EngineID pos = grf_load_byte(&buf);

   393

   394

				if (pos < NUM_TRAIN_ENGINES) {

   395

					AlterRailVehListOrder(engine + i, pos);

   396

				} else {

   397

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

   398

				}

   399

			}

   400

			break;

   401

   402

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

   403

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

   404

			break;

   405

   406

		case 0x1D: /* Refit cargo */

   407

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

   408

			break;

   409

   410

		case 0x1E: /* Callback */

   411

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

   412

			break;

   413

   414

		case 0x21: /* Shorter vehicle */

   415

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

   416

			break;

   417

   418

		case 0x22: /* Visual effect */

   419

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

   420

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

   421

			break;

   422

   423

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

   424

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

   425

			break;

   426

   427

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

   428

			FOR_EACH_OBJECT {

   429

				byte weight = grf_load_byte(&buf);

   430

   431

				if (weight > 4) {

   432

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

   433

				} else {

   434

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

   435

				}

   436

			}

   437

			break;

   438

   439

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

   440

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

   441

			break;

   442

   443

		case 0x27: /* Miscellaneous flags */

   444

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

   445

			break;

   446

   447

		case 0x28: /* Cargo classes allowed */

   448

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

   449

			break;

   450

   451

		case 0x29: /* Cargo classes disallowed */

   452

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

   453

			break;

   454

   455

		/* TODO */

   456

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

   457

		case 0x1C: /* Refit cost */

   458

		case 0x1F: /* Tractive effort */

   459

		case 0x20: /* Air drag */

   460

		case 0x26: /* Retire vehicle early */

   461

			/* TODO */

   462

			FOR_EACH_OBJECT grf_load_byte(&buf);

   463

			ret = true;

   464

			break;

   465

   466

		default:

   467

			ret = true;

   468

			break;

   469

	}

   470

	*bufp = buf;

   471

	return ret;

   472

}

   473

   474

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

   475

{

   476

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

   477

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   478

	byte *buf = *bufp;

   479

	int i;

   480

	bool ret = false;

   481

   482

	switch (prop) {

   483

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

   484

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

   485

			break;

   486

   487

		case 0x09: /* Running cost factor */

   488

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

   489

			break;

   490

   491