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

#include "vehicle.h"

    23

#include "newgrf_text.h"

    24

#include "table/sprites.h"

    25

    26

#include "newgrf_spritegroup.h"

    27

    28

/* TTDPatch extended GRF format codec

    29

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

    30

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

    31

 *

    32

 * Contains portions of documentation by TTDPatch team.

    33

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

    34

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

    35

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

    36

    37

    38

uint16 _custom_sprites_base;

    39

static int _skip_sprites; // XXX

    40

static uint _file_index; // XXX

    41

extern int _traininfo_vehicle_pitch;

    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

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

    52

static uint32 _ttdpatch_flags[8];

    53

    54

    55

typedef enum grfspec_feature {

    56

	GSF_TRAIN,

    57

	GSF_ROAD,

    58

	GSF_SHIP,

    59

	GSF_AIRCRAFT,

    60

	GSF_STATION,

    61

	GSF_CANAL,

    62

	GSF_BRIDGE,

    63

	GSF_TOWNHOUSE,

    64

	GSF_GLOBALVAR,

    65

	GSF_INDUSTRYTILES,

    66

	GSF_INDUSTRIES,

    67

	GSF_CARGOS,

    68

	GSF_SOUNDFX,

    69

} grfspec_feature;

    70

    71

    72

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

    73

    74

static const int _vehcounts[4] = {

    75

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    76

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    77

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    78

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    79

};

    80

    81

static const int _vehshifts[4] = {

    82

	/* GSF_TRAIN */    0,

    83

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    84

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    85

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    86

};

    87

    88

enum {

    89

	MAX_STATIONS = 256,

    90

};

    91

    92

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    93

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    94

    95

/* Debugging messages policy:

    96

 *

    97

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

    98

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

    99

 *

   100

 * 0..2 - dedicated to grfmsg()

   101

 * 3

   102

 * 4

   103

 * 5

   104

 * 6 - action handler entry reporting - one per action

   105

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

   106

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

   107

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

   108

 */

   109

   110

   111

typedef enum grfmsg_severity {

   112

	GMS_NOTICE,

   113

	GMS_WARN,

   114

	GMS_ERROR,

   115

	GMS_FATAL,

   116

} grfmsg_severity;

   117

   118

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

   119

{

   120

	static const char* const severitystr[] = {

   121

		"Notice",

   122

		"Warning",

   123

		"Error",

   124

		"Fatal"

   125

	};

   126

	int export_severity = 0;

   127

	char buf[1024];

   128

	va_list va;

   129

   130

	va_start(va, str);

   131

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

   132

	va_end(va);

   133

   134

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

   135

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

   136

}

   137

   138

   139

#define check_length(real, wanted, where) \

   140

do { \

   141

	if (real < wanted) { \

   142

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

   143

		       where, real, wanted); \

   144

		return; \

   145

	} \

   146

} while (0)

   147

   148

   149

static inline byte grf_load_byte(byte **buf)

   150

{

   151

	return *(*buf)++;

   152

}

   153

   154

static uint16 grf_load_word(byte **buf)

   155

{

   156

	uint16 val = grf_load_byte(buf);

   157

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

   158

}

   159

   160

static uint16 grf_load_extended(byte** buf)

   161

{

   162

	uint16 val;

   163

	val = grf_load_byte(buf);

   164

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

   165

	return val;

   166

}

   167

   168

static uint32 grf_load_dword(byte **buf)

   169

{

   170

	uint32 val = grf_load_word(buf);

   171

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

   172

}

   173

   174

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

   175

{

   176

	switch (size) {

   177

		case 1: return grf_load_byte(buf);

   178

		case 2: return grf_load_word(buf);

   179

		case 4: return grf_load_dword(buf);

   180

		default:

   181

			NOT_REACHED();

   182

			return 0;

   183

	}

   184

}

   185

   186

static GRFFile *GetFileByGRFID(uint32 grfid)

   187

{

   188

	GRFFile *file;

   189

   190

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

   191

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

   192

	}

   193

	return file;

   194

}

   195

   196

static GRFFile *GetFileByFilename(const char *filename)

   197

{

   198

	GRFFile *file;

   199

   200

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

   201

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

   202

	}

   203

	return file;

   204

}

   205

   206

   207

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

   208

   209

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

   210

   211

static void dewagonize(int condition, int engine)

   212

{

   213

	EngineInfo *ei = &_engine_info[engine];

   214

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   215

   216

	if (condition != 0) {

   217

		ei->unk2 &= ~0x80;

   218

		rvi->flags &= ~2;

   219

	} else {

   220

		ei->unk2 |= 0x80;

   221

		rvi->flags |= 2;

   222

	}

   223

}

   224

   225

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

   226

{

   227

	EngineInfo *ei = &_engine_info[engine];

   228

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   229

	byte *buf = *bufp;

   230

	int i;

   231

	bool ret = false;

   232

   233

	switch (prop) {

   234

		case 0x05: /* Track type */

   235

			FOR_EACH_OBJECT {

   236

				uint8 tracktype = grf_load_byte(&buf);

   237

   238

				switch (tracktype) {

   239

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

   240

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

   241

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

   242

					default:

   243

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

   244

						break;

   245

				}

   246

			}

   247

			break;

   248

   249

		case 0x08: /* AI passenger service */

   250

			/* TODO */

   251

			FOR_EACH_OBJECT grf_load_byte(&buf);

   252

			ret = true;

   253

			break;

   254

   255

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

   256

			FOR_EACH_OBJECT {

   257

				uint16 speed = grf_load_word(&buf);

   258

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

   259

   260

				rvi[i].max_speed = speed;

   261

			}

   262

			break;

   263

   264

		case 0x0B: /* Power */

   265

			FOR_EACH_OBJECT {

   266

				uint16 power = grf_load_word(&buf);

   267

   268

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

   269

   270

				rvi[i].power = power;

   271

				dewagonize(power, engine + i);

   272

			}

   273

			break;

   274

   275

		case 0x0D: /* Running cost factor */

   276

			FOR_EACH_OBJECT {

   277

				uint8 runcostfact = grf_load_byte(&buf);

   278

   279

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

   280

   281

				rvi[i].running_cost_base = runcostfact;

   282

			}

   283

			break;

   284

   285

		case 0x0E: /* Running cost base */

   286

			FOR_EACH_OBJECT {

   287

				uint32 base = grf_load_dword(&buf);

   288

   289

				switch (base) {

   290

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

   291

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

   292

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

   293

				}

   294

			}

   295

			break;

   296

   297

		case 0x12: /* Sprite ID */

   298

			FOR_EACH_OBJECT {

   299

				uint8 spriteid = grf_load_byte(&buf);

   300

   301

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

   302

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

   303

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

   304

   305

				rvi[i].image_index = spriteid;

   306

			}

   307

			break;

   308

   309

		case 0x13: /* Dual-headed */

   310

			FOR_EACH_OBJECT {

   311

				uint8 dual = grf_load_byte(&buf);

   312

   313

				if (dual != 0) {

   314

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

   315

						// adjust power and running cost if needed

   316

						rvi[i].power /= 2;

   317

						rvi[i].running_cost_base /= 2;

   318

					}

   319

					rvi[i].flags |= RVI_MULTIHEAD;

   320

				} else {

   321

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

   322

						// adjust power and running cost if needed

   323

						rvi[i].power *= 2;

   324

						rvi[i].running_cost_base *= 2;

   325

					}

   326

					rvi[i].flags &= ~RVI_MULTIHEAD;

   327

				}

   328

			}

   329

			break;

   330

   331

		case 0x14: /* Cargo capacity */

   332

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

   333

			break;

   334

   335

		case 0x15: /* Cargo type */

   336

			FOR_EACH_OBJECT {

   337

				uint8 ctype = grf_load_byte(&buf);

   338

   339

				if (ctype < NUM_CARGO) {

   340

					rvi[i].cargo_type = ctype;

   341

				} else {

   342

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

   343

				}

   344

			}

   345

			break;

   346

   347

		case 0x16: /* Weight */

   348

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

   349

			break;

   350

   351

		case 0x17: /* Cost factor */

   352

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

   353

			break;

   354

   355

		case 0x18: /* AI rank */

   356

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

   357

			break;

   358

   359

		case 0x19: /* Engine traction type */

   360

			/* What do the individual numbers mean?

   361

			 * 0x00 .. 0x07: Steam

   362

			 * 0x08 .. 0x27: Diesel

   363

			 * 0x28 .. 0x31: Electric

   364

			 * 0x32 .. 0x37: Monorail

   365

			 * 0x38 .. 0x41: Maglev

   366

			 */

   367

			FOR_EACH_OBJECT {

   368

				uint8 traction = grf_load_byte(&buf);

   369

				int engclass;

   370

   371

				if (traction <= 0x07) {

   372

					engclass = 0;

   373

				} else if (traction <= 0x27) {

   374

					engclass = 1;

   375

				} else if (traction <= 0x31) {

   376

					engclass = 2;

   377

					ei[i].railtype = RAILTYPE_ELECTRIC;

   378

				} else if (traction <= 0x41) {

   379

					engclass = 2;

   380

				} else {

   381

					break;

   382

				}

   383

   384

				rvi[i].engclass = engclass;

   385

			}

   386

			break;

   387

   388

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

   389

			FOR_EACH_OBJECT {

   390

				EngineID pos = grf_load_byte(&buf);

   391

   392

				if (pos < NUM_TRAIN_ENGINES) {

   393

					AlterRailVehListOrder(engine + i, pos);

   394

				} else {

   395

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

   396

				}

   397

			}

   398

			break;

   399

   400

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

   401

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

   402

			break;

   403

   404

		case 0x1D: /* Refit cargo */

   405

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

   406

			break;

   407

   408

		case 0x1E: /* Callback */

   409

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

   410

			break;

   411

   412

		case 0x21: /* Shorter vehicle */

   413

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

   414

			break;

   415

   416

		case 0x22: /* Visual effect */

   417

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

   418

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

   419

			break;

   420

   421

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

   422

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

   423

			break;

   424

   425

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

   426

			FOR_EACH_OBJECT {

   427

				byte weight = grf_load_byte(&buf);

   428

   429

				if (weight > 4) {

   430

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

   431

				} else {

   432

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

   433

				}

   434

			}

   435

			break;

   436

   437

		case 0x27: /* Miscellaneous flags */

   438

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

   439

			break;

   440

   441

		case 0x28: /* Cargo classes allowed */

   442

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

   443

			break;

   444

   445

		case 0x29: /* Cargo classes disallowed */

   446

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

   447

			break;

   448

   449

		/* TODO */

   450

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

   451

		case 0x1C: /* Refit cost */

   452

		case 0x1F: /* Tractive effort */

   453

		case 0x20: /* Air drag */

   454

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

   455

		case 0x26: /* Retire vehicle early */

   456

			/* TODO */

   457

			FOR_EACH_OBJECT grf_load_byte(&buf);

   458

			ret = true;

   459

			break;

   460

   461

		default:

   462

			ret = true;

   463

			break;

   464

	}

   465

	*bufp = buf;

   466

	return ret;

   467

}

   468

   469

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

   470

{

   471

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

   472

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   473

	byte *buf = *bufp;

   474

	int i;

   475

	bool ret = false;

   476

   477

	switch (prop) {

   478

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

   479

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

   480

			break;

   481

   482

		case 0x09: /* Running cost factor */

   483

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

   484

			break;

   485

   486

		case 0x0A: /* Running cost base */

   487

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

   488

			FOR_EACH_OBJECT grf_load_dword(&buf);

   489

			ret = true;

   490

			break;

   491

   492

		case 0x0E: /* Sprite ID */

   493

			FOR_EACH_OBJECT {

   494

				uint8 spriteid = grf_load_byte(&buf);

   495

   496

				// cars have different custom id in the GRF file

   497

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

   498

   499

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