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

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    89

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    90

    91

/* Debugging messages policy:

    92

 *

    93

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

    94

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

    95

 *

    96

 * 0..2 - dedicated to grfmsg()

    97

 * 3

    98

 * 4

    99

 * 5

   100

 * 6 - action handler entry reporting - one per action

   101

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

   102

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

   103

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

   104

 */

   105

   106

   107

typedef enum grfmsg_severity {

   108

	GMS_NOTICE,

   109

	GMS_WARN,

   110

	GMS_ERROR,

   111

	GMS_FATAL,

   112

} grfmsg_severity;

   113

   114

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

   115

{

   116

	static const char* const severitystr[] = {

   117

		"Notice",

   118

		"Warning",

   119

		"Error",

   120

		"Fatal"

   121

	};

   122

	int export_severity = 0;

   123

	char buf[1024];

   124

	va_list va;

   125

   126

	va_start(va, str);

   127

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

   128

	va_end(va);

   129

   130

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

   131

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

   132

}

   133

   134

   135

#define check_length(real, wanted, where) \

   136

do { \

   137

	if (real < wanted) { \

   138

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

   139

		       where, real, wanted); \

   140

		return; \

   141

	} \

   142

} while (0)

   143

   144

   145

static inline byte grf_load_byte(byte **buf)

   146

{

   147

	return *(*buf)++;

   148

}

   149

   150

static uint16 grf_load_word(byte **buf)

   151

{

   152

	uint16 val = grf_load_byte(buf);

   153

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

   154

}

   155

   156

static uint16 grf_load_extended(byte** buf)

   157

{

   158

	uint16 val;

   159

	val = grf_load_byte(buf);

   160

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

   161

	return val;

   162

}

   163

   164

static uint32 grf_load_dword(byte **buf)

   165

{

   166

	uint32 val = grf_load_word(buf);

   167

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

   168

}

   169

   170

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

   171

{

   172

	switch (size) {

   173

		case 1: return grf_load_byte(buf);

   174

		case 2: return grf_load_word(buf);

   175

		case 4: return grf_load_dword(buf);

   176

		default:

   177

			NOT_REACHED();

   178

			return 0;

   179

	}

   180

}

   181

   182

static GRFFile *GetFileByGRFID(uint32 grfid)

   183

{

   184

	GRFFile *file;

   185

   186

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

   187

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

   188

	}

   189

	return file;

   190

}

   191

   192

static GRFFile *GetFileByFilename(const char *filename)

   193

{

   194

	GRFFile *file;

   195

   196

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

   197

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

   198

	}

   199

	return file;

   200

}

   201

   202

   203

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

   204

   205

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

   206

   207

static void dewagonize(int condition, int engine)

   208

{

   209

	EngineInfo *ei = &_engine_info[engine];

   210

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   211

   212

	if (condition != 0) {

   213

		ei->unk2 &= ~0x80;

   214

		rvi->flags &= ~2;

   215

	} else {

   216

		ei->unk2 |= 0x80;

   217

		rvi->flags |= 2;

   218

	}

   219

}

   220

   221

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

   222

{

   223

	EngineInfo *ei = &_engine_info[engine];

   224

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   225

	byte *buf = *bufp;

   226

	int i;

   227

	bool ret = false;

   228

   229

	switch (prop) {

   230

		case 0x05: /* Track type */

   231

			FOR_EACH_OBJECT {

   232

				uint8 tracktype = grf_load_byte(&buf);

   233

   234

				switch (tracktype) {

   235

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

   236

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

   237

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

   238

					default:

   239

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

   240

						break;

   241

				}

   242

			}

   243

			break;

   244

   245

		case 0x08: /* AI passenger service */

   246

			/* TODO */

   247

			FOR_EACH_OBJECT grf_load_byte(&buf);

   248

			ret = true;

   249

			break;

   250

   251

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

   252

			FOR_EACH_OBJECT {

   253

				uint16 speed = grf_load_word(&buf);

   254

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

   255

   256

				rvi[i].max_speed = speed;

   257

			}

   258

			break;

   259

   260

		case 0x0B: /* Power */

   261

			FOR_EACH_OBJECT {

   262

				uint16 power = grf_load_word(&buf);

   263

   264

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

   265

   266

				rvi[i].power = power;

   267

				dewagonize(power, engine + i);

   268

			}

   269

			break;

   270

   271

		case 0x0D: /* Running cost factor */

   272

			FOR_EACH_OBJECT {

   273

				uint8 runcostfact = grf_load_byte(&buf);

   274

   275

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

   276

   277

				rvi[i].running_cost_base = runcostfact;

   278

			}

   279

			break;

   280

   281

		case 0x0E: /* Running cost base */

   282

			FOR_EACH_OBJECT {

   283

				uint32 base = grf_load_dword(&buf);

   284

   285

				switch (base) {

   286

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

   287

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

   288

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

   289

				}

   290

			}

   291

			break;

   292

   293

		case 0x12: /* Sprite ID */

   294

			FOR_EACH_OBJECT {

   295

				uint8 spriteid = grf_load_byte(&buf);

   296

   297

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

   298

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

   299

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

   300

   301

				rvi[i].image_index = spriteid;

   302

			}

   303

			break;

   304

   305

		case 0x13: /* Dual-headed */

   306

			FOR_EACH_OBJECT {

   307

				uint8 dual = grf_load_byte(&buf);

   308

   309

				if (dual != 0) {

   310

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

   311

						// adjust power and running cost if needed

   312

						rvi[i].power /= 2;

   313

						rvi[i].running_cost_base /= 2;

   314

					}

   315

					rvi[i].flags |= RVI_MULTIHEAD;

   316

				} else {

   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

				}

   324

			}

   325

			break;

   326

   327

		case 0x14: /* Cargo capacity */

   328

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

   329

			break;

   330

   331

		case 0x15: /* Cargo type */

   332

			FOR_EACH_OBJECT {

   333

				uint8 ctype = grf_load_byte(&buf);

   334

   335

				if (ctype < NUM_CARGO) {

   336

					rvi[i].cargo_type = ctype;

   337

				} else {

   338

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

   339

				}

   340

			}

   341

			break;

   342

   343

		case 0x16: /* Weight */

   344

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

   345

			break;

   346

   347

		case 0x17: /* Cost factor */

   348

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

   349

			break;

   350

   351

		case 0x18: /* AI rank */

   352

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

   353

			break;

   354

   355

		case 0x19: /* Engine traction type */

   356

			/* What do the individual numbers mean?

   357

			 * 0x00 .. 0x07: Steam

   358

			 * 0x08 .. 0x27: Diesel

   359

			 * 0x28 .. 0x31: Electric

   360

			 * 0x32 .. 0x37: Monorail

   361

			 * 0x38 .. 0x41: Maglev

   362

			 */

   363

			FOR_EACH_OBJECT {

   364

				uint8 traction = grf_load_byte(&buf);

   365

				int engclass;

   366

   367

				if (traction <= 0x07) {

   368

					engclass = 0;

   369

				} else if (traction <= 0x27) {

   370

					engclass = 1;

   371

				} else if (traction <= 0x31) {

   372

					engclass = 2;

   373

					ei[i].railtype = RAILTYPE_ELECTRIC;

   374

				} else if (traction <= 0x41) {

   375

					engclass = 2;

   376

				} else {

   377

					break;

   378

				}

   379

   380

				rvi[i].engclass = engclass;

   381

			}

   382

			break;

   383

   384

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

   385

			FOR_EACH_OBJECT {

   386

				EngineID pos = grf_load_byte(&buf);

   387

   388

				if (pos < NUM_TRAIN_ENGINES) {

   389

					AlterRailVehListOrder(engine + i, pos);

   390

				} else {

   391

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

   392

				}

   393

			}

   394

			break;

   395

   396

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

   397

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

   398

			break;

   399

   400

		case 0x1D: /* Refit cargo */

   401

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

   402

			break;

   403

   404

		case 0x1E: /* Callback */

   405

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

   406

			break;

   407

   408

		case 0x21: /* Shorter vehicle */

   409

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

   410

			break;

   411

   412

		case 0x22: /* Visual effect */

   413

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

   414

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

   415

			break;

   416

   417

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

   418

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

   419

			break;

   420

   421

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

   422

			FOR_EACH_OBJECT {

   423

				byte weight = grf_load_byte(&buf);

   424

   425

				if (weight > 4) {

   426

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

   427

				} else {

   428

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

   429

				}

   430

			}

   431

			break;

   432

   433

		case 0x27: /* Miscellaneous flags */

   434

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

   435

			break;

   436

   437

		case 0x28: /* Cargo classes allowed */

   438

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

   439

			break;

   440

   441

		case 0x29: /* Cargo classes disallowed */

   442

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

   443

			break;

   444

   445

		/* TODO */

   446

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

   447

		case 0x1C: /* Refit cost */

   448

		case 0x1F: /* Tractive effort */

   449

		case 0x20: /* Air drag */

   450

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

   451

		case 0x26: /* Retire vehicle early */

   452

			/* TODO */

   453

			FOR_EACH_OBJECT grf_load_byte(&buf);

   454

			ret = true;

   455

			break;

   456

   457

		default:

   458

			ret = true;

   459

			break;

   460

	}

   461

	*bufp = buf;

   462

	return ret;

   463

}

   464

   465

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

   466

{

   467

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

   468

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   469

	byte *buf = *bufp;

   470

	int i;

   471

	bool ret = false;

   472

   473

	switch (prop) {

   474

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

   475

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

   476

			break;

   477

   478

		case 0x09: /* Running cost factor */

   479

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

   480

			break;

   481

   482

		case 0x0A: /* Running cost base */

   483

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

   484

			FOR_EACH_OBJECT grf_load_dword(&buf);

   485

			ret = true;

   486

			break;

   487

   488

		case 0x0E: /* Sprite ID */

   489

			FOR_EACH_OBJECT {

   490

				uint8 spriteid = grf_load_byte(&buf);

   491

   492

				// cars have different custom id in the GRF file

   493

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

   494

   495

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

   496

   497

				rvi[i].image_index = spriteid;

   498

			}

   499

			break;