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 "bridge.h"

    20

#include "economy.h"

    21

#include "newgrf_engine.h"

    22

    23

/* TTDPatch extended GRF format codec

    24

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

    25

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

    26

 *

    27

 * Contains portions of documentation by TTDPatch team.

    28

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

    29

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

    30

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

    31

    32

    33

uint16 _custom_sprites_base;

    34

static int _skip_sprites; // XXX

    35

static uint _file_index; // XXX

    36

extern int _traininfo_vehicle_pitch;

    37

    38

static GRFFile *_cur_grffile;

    39

GRFFile *_first_grffile;

    40

static int _cur_spriteid;

    41

static int _cur_stage;

    42

static uint32 _nfo_line;

    43

    44

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

    45

static uint32 _ttdpatch_flags[8];

    46

    47

    48

typedef enum grfspec_feature {

    49

	GSF_TRAIN,

    50

	GSF_ROAD,

    51

	GSF_SHIP,

    52

	GSF_AIRCRAFT,

    53

	GSF_STATION,

    54

	GSF_CANAL,

    55

	GSF_BRIDGE,

    56

	GSF_TOWNHOUSE,

    57

	GSF_GLOBALVAR,

    58

} grfspec_feature;

    59

    60

    61

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

    62

    63

static const int _vehcounts[4] = {

    64

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    65

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    66

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    67

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    68

};

    69

    70

static const int _vehshifts[4] = {

    71

	/* GSF_TRAIN */    0,

    72

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    73

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    74

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    75

};

    76

    77

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    78

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    79

    80

/* Debugging messages policy:

    81

 *

    82

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

    83

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

    84

 *

    85

 * 0..2 - dedicated to grfmsg()

    86

 * 3

    87

 * 4

    88

 * 5

    89

 * 6 - action handler entry reporting - one per action

    90

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

    91

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

    92

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

    93

 */

    94

    95

    96

typedef enum grfmsg_severity {

    97

	GMS_NOTICE,

    98

	GMS_WARN,

    99

	GMS_ERROR,

   100

	GMS_FATAL,

   101

} grfmsg_severity;

   102

   103

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

   104

{

   105

	static const char* const severitystr[] = {

   106

		"Notice",

   107

		"Warning",

   108

		"Error",

   109

		"Fatal"

   110

	};

   111

	int export_severity = 0;

   112

	char buf[1024];

   113

	va_list va;

   114

   115

	va_start(va, str);

   116

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

   117

	va_end(va);

   118

   119

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

   120

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

   121

}

   122

   123

   124

#define check_length(real, wanted, where) \

   125

do { \

   126

	if (real < wanted) { \

   127

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

   128

		       where, real, wanted); \

   129

		return; \

   130

	} \

   131

} while (0)

   132

   133

   134

static inline byte grf_load_byte(byte **buf)

   135

{

   136

	return *(*buf)++;

   137

}

   138

   139

static uint16 grf_load_word(byte **buf)

   140

{

   141

	uint16 val;

   142

	byte *p = *buf;

   143

	val = p[0];

   144

	val |= p[1] << 8;

   145

	*buf = p + 2;

   146

	return val;

   147

}

   148

   149

static uint16 grf_load_extended(byte** buf)

   150

{

   151

	uint16 val;

   152

	val = grf_load_byte(buf);

   153

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

   154

	return val;

   155

}

   156

   157

static uint32 grf_load_dword(byte **buf)

   158

{

   159

	uint32 val;

   160

	byte *p = *buf;

   161

	val = p[0];

   162

	val |= p[1] << 8;

   163

	val |= p[2] << 16;

   164

	val |= p[3] << 24;

   165

	*buf = p + 4;

   166

	return val;

   167

}

   168

   169

   170

static GRFFile *GetFileByGRFID(uint32 grfid)

   171

{

   172

	GRFFile *file;

   173

   174

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

   175

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

   176

	}

   177

	return file;

   178

}

   179

   180

static GRFFile *GetFileByFilename(const char *filename)

   181

{

   182

	GRFFile *file;

   183

   184

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

   185

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

   186

	}

   187

	return file;

   188

}

   189

   190

   191

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

   192

   193

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

   194

   195

static void dewagonize(int condition, int engine)

   196

{

   197

	EngineInfo *ei = &_engine_info[engine];

   198

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   199

   200

	if (condition != 0) {

   201

		ei->unk2 &= ~0x80;

   202

		rvi->flags &= ~2;

   203

	} else {

   204

		ei->unk2 |= 0x80;

   205

		rvi->flags |= 2;

   206

	}

   207

}

   208

   209

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

   210

{

   211

	EngineInfo *ei = &_engine_info[engine];

   212

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   213

	byte *buf = *bufp;

   214

	int i;

   215

	bool ret = false;

   216

   217

	switch (prop) {

   218

		case 0x05: /* Track type */

   219

			FOR_EACH_OBJECT {

   220

				uint8 tracktype = grf_load_byte(&buf);

   221

   222

				switch (tracktype) {

   223

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

   224

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

   225

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

   226

					default:

   227

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

   228

						break;

   229

				}

   230

			}

   231

			break;

   232

   233

		case 0x08: /* AI passenger service */

   234

			/* TODO */

   235

			FOR_EACH_OBJECT grf_load_byte(&buf);

   236

			ret = true;

   237

			break;

   238

   239

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

   240

			FOR_EACH_OBJECT {

   241

				uint16 speed = grf_load_word(&buf);

   242

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

   243

   244

				rvi[i].max_speed = speed;

   245

			}

   246

			break;

   247

   248

		case 0x0B: /* Power */

   249

			FOR_EACH_OBJECT {

   250

				uint16 power = grf_load_word(&buf);

   251

   252

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

   253

   254

				rvi[i].power = power;

   255

				dewagonize(power, engine + i);

   256

			}

   257

			break;

   258

   259

		case 0x0D: /* Running cost factor */

   260

			FOR_EACH_OBJECT {

   261

				uint8 runcostfact = grf_load_byte(&buf);

   262

   263

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

   264

   265

				rvi[i].running_cost_base = runcostfact;

   266

			}

   267

			break;

   268

   269

		case 0x0E: /* Running cost base */

   270

			FOR_EACH_OBJECT {

   271

				uint32 base = grf_load_dword(&buf);

   272

   273

				switch (base) {

   274

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

   275

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

   276

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

   277

				}

   278

			}

   279

			break;

   280

   281

		case 0x12: /* Sprite ID */

   282

			FOR_EACH_OBJECT {

   283

				uint8 spriteid = grf_load_byte(&buf);

   284

   285

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

   286

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

   287

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

   288

   289

				rvi[i].image_index = spriteid;

   290

			}

   291

			break;

   292

   293

		case 0x13: /* Dual-headed */

   294

			FOR_EACH_OBJECT {

   295

				uint8 dual = grf_load_byte(&buf);

   296

   297

				if (dual != 0) {

   298

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

   299

						// adjust power and running cost if needed

   300

						rvi[i].power /= 2;

   301

						rvi[i].running_cost_base /= 2;

   302

					}

   303

					rvi[i].flags |= RVI_MULTIHEAD;

   304

				} else {

   305

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

   306

						// adjust power and running cost if needed

   307

						rvi[i].power *= 2;

   308

						rvi[i].running_cost_base *= 2;

   309

					}

   310

					rvi[i].flags &= ~RVI_MULTIHEAD;

   311

				}

   312

			}

   313

			break;

   314

   315

		case 0x14: /* Cargo capacity */

   316

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

   317

			break;

   318

   319

		case 0x15: /* Cargo type */

   320

			FOR_EACH_OBJECT {

   321

				uint8 ctype = grf_load_byte(&buf);

   322

   323

				if (ctype < NUM_CARGO) {

   324

					rvi[i].cargo_type = ctype;

   325

				} else {

   326

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

   327

				}

   328

			}

   329

			break;

   330

   331

		case 0x16: /* Weight */

   332

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

   333

			break;

   334

   335

		case 0x17: /* Cost factor */

   336

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

   337

			break;

   338

   339

		case 0x18: /* AI rank */

   340

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

   341

			break;

   342

   343

		case 0x19: /* Engine traction type */

   344

			/* What do the individual numbers mean?

   345

			 * 0x00 .. 0x07: Steam

   346

			 * 0x08 .. 0x27: Diesel

   347

			 * 0x28 .. 0x31: Electric

   348

			 * 0x32 .. 0x37: Monorail

   349

			 * 0x38 .. 0x41: Maglev

   350

			 */

   351

			FOR_EACH_OBJECT {

   352

				uint8 traction = grf_load_byte(&buf);

   353

				int engclass;

   354

   355

				if (traction <= 0x07) {

   356

					engclass = 0;

   357

				} else if (traction <= 0x27) {

   358

					engclass = 1;

   359

				} else if (traction <= 0x31) {

   360

					engclass = 2;

   361

					ei[i].railtype = RAILTYPE_ELECTRIC;

   362

				} else if (traction <= 0x41) {

   363

					engclass = 2;

   364

				} else {

   365

					break;

   366

				}

   367

   368

				rvi[i].engclass = engclass;

   369

			}

   370

			break;

   371

   372

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

   373

			FOR_EACH_OBJECT {

   374

				EngineID pos = grf_load_byte(&buf);

   375

   376

				if (pos < NUM_TRAIN_ENGINES) {

   377

					AlterRailVehListOrder(engine + i, pos);

   378

				} else {

   379

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

   380

				}

   381

			}

   382

			break;

   383

   384

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

   385

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

   386

			break;

   387

   388

		case 0x1D: /* Refit cargo */

   389

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

   390

			break;

   391

   392

		case 0x1E: /* Callback */

   393

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

   394

			break;

   395

   396

		case 0x21: /* Shorter vehicle */

   397

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

   398

			break;

   399

   400

		case 0x22: /* Visual effect */

   401

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

   402

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

   403

			break;

   404

   405

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

   406

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

   407

			break;

   408

   409

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

   410

			FOR_EACH_OBJECT {

   411

				byte weight = grf_load_byte(&buf);

   412

   413

				if (weight > 4) {

   414

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

   415

				} else {

   416

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

   417

				}

   418

			}

   419

			break;

   420

   421

		case 0x27: /* Miscellaneous flags */

   422

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

   423

			break;

   424

   425

		case 0x28: /* Cargo classes allowed */

   426

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

   427

			break;

   428

   429

		case 0x29: /* Cargo classes disallowed */

   430

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

   431

			break;

   432

   433

		/* TODO */

   434

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

   435

		case 0x1C: /* Refit cost */

   436

		case 0x1F: /* Tractive effort */

   437

		case 0x20: /* Air drag */

   438

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

   439

		case 0x26: /* Retire vehicle early */

   440

			/* TODO */

   441

			FOR_EACH_OBJECT grf_load_byte(&buf);

   442

			ret = true;

   443

			break;

   444

   445

		default:

   446

			ret = true;

   447

			break;

   448

	}

   449

	*bufp = buf;

   450

	return ret;

   451

}

   452

   453

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

   454

{

   455

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

   456

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   457

	byte *buf = *bufp;

   458

	int i;

   459

	bool ret = false;

   460

   461

	switch (prop) {

   462

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

   463

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

   464

			break;

   465

   466

		case 0x09: /* Running cost factor */

   467

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

   468

			break;

   469

   470

		case 0x0A: /* Running cost base */

   471

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

   472

			FOR_EACH_OBJECT grf_load_dword(&buf);

   473

			ret = true;

   474

			break;

   475

   476

		case 0x0E: /* Sprite ID */

   477

			FOR_EACH_OBJECT {

   478

				uint8 spriteid = grf_load_byte(&buf);

   479

   480

				// cars have different custom id in the GRF file

   481

				if (spriteid == 0xFF) spriteid = 0xFD;

   482

   483

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

   484

   485

				rvi[i].image_index = spriteid;

   486

			}

   487

			break;

   488

   489

		case 0x0F: /* Cargo capacity */

   490

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

   491

			break;

   492