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

    24

/* TTDPatch extended GRF format codec

    25

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

    26

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

    27

 *

    28

 * Contains portions of documentation by TTDPatch team.

    29

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

    30

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

    31

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

    32

    33

    34

uint16 _custom_sprites_base;

    35

static int _skip_sprites; // XXX

    36

static uint _file_index; // XXX

    37

extern int _traininfo_vehicle_pitch;

    38

    39

static GRFFile *_cur_grffile;

    40

GRFFile *_first_grffile;

    41

static int _cur_spriteid;

    42

static int _cur_stage;

    43

static uint32 _nfo_line;

    44

    45

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

    46

static uint32 _ttdpatch_flags[8];

    47

    48

    49

typedef enum grfspec_feature {

    50

	GSF_TRAIN,

    51

	GSF_ROAD,

    52

	GSF_SHIP,

    53

	GSF_AIRCRAFT,

    54

	GSF_STATION,

    55

	GSF_CANAL,

    56

	GSF_BRIDGE,

    57

	GSF_TOWNHOUSE,

    58

	GSF_GLOBALVAR,

    59

} grfspec_feature;

    60

    61

    62

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

    63

    64

static const int _vehcounts[4] = {

    65

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    66

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    67

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    68

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    69

};

    70

    71

static const int _vehshifts[4] = {

    72

	/* GSF_TRAIN */    0,

    73

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    74

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    75

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    76

};

    77

    78

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    79

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    80

    81

/* Debugging messages policy:

    82

 *

    83

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

    84

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

    85

 *

    86

 * 0..2 - dedicated to grfmsg()

    87

 * 3

    88

 * 4

    89

 * 5

    90

 * 6 - action handler entry reporting - one per action

    91

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

    92

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

    93

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

    94

 */

    95

    96

    97

typedef enum grfmsg_severity {

    98

	GMS_NOTICE,

    99

	GMS_WARN,

   100

	GMS_ERROR,

   101

	GMS_FATAL,

   102

} grfmsg_severity;

   103

   104

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

   105

{

   106

	static const char* const severitystr[] = {

   107

		"Notice",

   108

		"Warning",

   109

		"Error",

   110

		"Fatal"

   111

	};

   112

	int export_severity = 0;

   113

	char buf[1024];

   114

	va_list va;

   115

   116

	va_start(va, str);

   117

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

   118

	va_end(va);

   119

   120

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

   121

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

   122

}

   123

   124

   125

#define check_length(real, wanted, where) \

   126

do { \

   127

	if (real < wanted) { \

   128

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

   129

		       where, real, wanted); \

   130

		return; \

   131

	} \

   132

} while (0)

   133

   134

   135

static inline byte grf_load_byte(byte **buf)

   136

{

   137

	return *(*buf)++;

   138

}

   139

   140

static uint16 grf_load_word(byte **buf)

   141

{

   142

	uint16 val;

   143

	byte *p = *buf;

   144

	val = p[0];

   145

	val |= p[1] << 8;

   146

	*buf = p + 2;

   147

	return val;

   148

}

   149

   150

static uint16 grf_load_extended(byte** buf)

   151

{

   152

	uint16 val;

   153

	val = grf_load_byte(buf);

   154

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

   155

	return val;

   156

}

   157

   158

static uint32 grf_load_dword(byte **buf)

   159

{

   160

	uint32 val;

   161

	byte *p = *buf;

   162

	val = p[0];

   163

	val |= p[1] << 8;

   164

	val |= p[2] << 16;

   165

	val |= p[3] << 24;

   166

	*buf = p + 4;

   167

	return val;

   168

}

   169

   170

   171

static GRFFile *GetFileByGRFID(uint32 grfid)

   172

{

   173

	GRFFile *file;

   174

   175

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

   176

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

   177

	}

   178

	return file;

   179

}

   180

   181

static GRFFile *GetFileByFilename(const char *filename)

   182

{

   183

	GRFFile *file;

   184

   185

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

   186

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

   187

	}

   188

	return file;

   189

}

   190

   191

   192

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

   193

   194

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

   195

   196

static void dewagonize(int condition, int engine)

   197

{

   198

	EngineInfo *ei = &_engine_info[engine];

   199

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   200

   201

	if (condition != 0) {

   202

		ei->unk2 &= ~0x80;

   203

		rvi->flags &= ~2;

   204

	} else {

   205

		ei->unk2 |= 0x80;

   206

		rvi->flags |= 2;

   207

	}

   208

}

   209

   210

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

   211

{

   212

	EngineInfo *ei = &_engine_info[engine];

   213

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   214

	byte *buf = *bufp;

   215

	int i;

   216

	bool ret = false;

   217

   218

	switch (prop) {

   219

		case 0x05: /* Track type */

   220

			FOR_EACH_OBJECT {

   221

				uint8 tracktype = grf_load_byte(&buf);

   222

   223

				switch (tracktype) {

   224

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

   225

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

   226

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

   227

					default:

   228

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

   229

						break;

   230

				}

   231

			}

   232

			break;

   233

   234

		case 0x08: /* AI passenger service */

   235

			/* TODO */

   236

			FOR_EACH_OBJECT grf_load_byte(&buf);

   237

			ret = true;

   238

			break;

   239

   240

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

   241

			FOR_EACH_OBJECT {

   242

				uint16 speed = grf_load_word(&buf);

   243

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

   244

   245

				rvi[i].max_speed = speed;

   246

			}

   247

			break;

   248

   249

		case 0x0B: /* Power */

   250

			FOR_EACH_OBJECT {

   251

				uint16 power = grf_load_word(&buf);

   252

   253

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

   254

   255

				rvi[i].power = power;

   256

				dewagonize(power, engine + i);

   257

			}

   258

			break;

   259

   260

		case 0x0D: /* Running cost factor */

   261

			FOR_EACH_OBJECT {

   262

				uint8 runcostfact = grf_load_byte(&buf);

   263

   264

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

   265

   266

				rvi[i].running_cost_base = runcostfact;

   267

			}

   268

			break;

   269

   270

		case 0x0E: /* Running cost base */

   271

			FOR_EACH_OBJECT {

   272

				uint32 base = grf_load_dword(&buf);

   273

   274

				switch (base) {

   275

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

   276

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

   277

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

   278

				}

   279

			}

   280

			break;

   281

   282

		case 0x12: /* Sprite ID */

   283

			FOR_EACH_OBJECT {

   284

				uint8 spriteid = grf_load_byte(&buf);

   285

   286

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

   287

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

   288

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

   289

   290

				rvi[i].image_index = spriteid;

   291

			}

   292

			break;

   293

   294

		case 0x13: /* Dual-headed */

   295

			FOR_EACH_OBJECT {

   296

				uint8 dual = grf_load_byte(&buf);

   297

   298

				if (dual != 0) {

   299

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

   300

						// adjust power and running cost if needed

   301

						rvi[i].power /= 2;

   302

						rvi[i].running_cost_base /= 2;

   303

					}

   304

					rvi[i].flags |= RVI_MULTIHEAD;

   305

				} else {

   306

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

   307

						// adjust power and running cost if needed

   308

						rvi[i].power *= 2;

   309

						rvi[i].running_cost_base *= 2;

   310

					}

   311

					rvi[i].flags &= ~RVI_MULTIHEAD;

   312

				}

   313

			}

   314

			break;

   315

   316

		case 0x14: /* Cargo capacity */

   317

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

   318

			break;

   319

   320

		case 0x15: /* Cargo type */

   321

			FOR_EACH_OBJECT {

   322

				uint8 ctype = grf_load_byte(&buf);

   323

   324

				if (ctype < NUM_CARGO) {

   325

					rvi[i].cargo_type = ctype;

   326

				} else {

   327

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

   328

				}

   329

			}

   330

			break;

   331

   332

		case 0x16: /* Weight */

   333

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

   334

			break;

   335

   336

		case 0x17: /* Cost factor */

   337

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

   338

			break;

   339

   340

		case 0x18: /* AI rank */

   341

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

   342

			break;

   343

   344

		case 0x19: /* Engine traction type */

   345

			/* What do the individual numbers mean?

   346

			 * 0x00 .. 0x07: Steam

   347

			 * 0x08 .. 0x27: Diesel

   348

			 * 0x28 .. 0x31: Electric

   349

			 * 0x32 .. 0x37: Monorail

   350

			 * 0x38 .. 0x41: Maglev

   351

			 */

   352

			FOR_EACH_OBJECT {

   353

				uint8 traction = grf_load_byte(&buf);

   354

				int engclass;

   355

   356

				if (traction <= 0x07) {

   357

					engclass = 0;

   358

				} else if (traction <= 0x27) {

   359

					engclass = 1;

   360

				} else if (traction <= 0x31) {

   361

					engclass = 2;

   362

					ei[i].railtype = RAILTYPE_ELECTRIC;

   363

				} else if (traction <= 0x41) {

   364

					engclass = 2;

   365

				} else {

   366

					break;

   367

				}

   368

   369

				rvi[i].engclass = engclass;

   370

			}

   371

			break;

   372

   373

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

   374

			FOR_EACH_OBJECT {

   375

				EngineID pos = grf_load_byte(&buf);

   376

   377

				if (pos < NUM_TRAIN_ENGINES) {

   378

					AlterRailVehListOrder(engine + i, pos);

   379

				} else {

   380

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

   381

				}

   382

			}

   383

			break;

   384

   385

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

   386

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

   387

			break;

   388

   389

		case 0x1D: /* Refit cargo */

   390

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

   391

			break;

   392

   393

		case 0x1E: /* Callback */

   394

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

   395

			break;

   396

   397

		case 0x21: /* Shorter vehicle */

   398

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

   399

			break;

   400

   401

		case 0x22: /* Visual effect */

   402

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

   403

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

   404

			break;

   405

   406

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

   407

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

   408

			break;

   409

   410

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

   411

			FOR_EACH_OBJECT {

   412

				byte weight = grf_load_byte(&buf);

   413

   414

				if (weight > 4) {

   415

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

   416

				} else {

   417

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

   418

				}

   419

			}

   420

			break;

   421

   422

		case 0x27: /* Miscellaneous flags */

   423

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

   424

			break;

   425

   426

		case 0x28: /* Cargo classes allowed */

   427

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

   428

			break;

   429

   430

		case 0x29: /* Cargo classes disallowed */

   431

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

   432

			break;

   433

   434

		/* TODO */

   435

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

   436

		case 0x1C: /* Refit cost */

   437

		case 0x1F: /* Tractive effort */

   438

		case 0x20: /* Air drag */

   439

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

   440

		case 0x26: /* Retire vehicle early */

   441

			/* TODO */

   442

			FOR_EACH_OBJECT grf_load_byte(&buf);

   443

			ret = true;

   444

			break;

   445

   446

		default:

   447

			ret = true;

   448

			break;

   449

	}

   450

	*bufp = buf;

   451

	return ret;

   452

}

   453

   454

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

   455

{

   456

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

   457

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   458

	byte *buf = *bufp;

   459

	int i;

   460

	bool ret = false;

   461

   462

	switch (prop) {

   463

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

   464

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

   465

			break;

   466

   467

		case 0x09: /* Running cost factor */

   468

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

   469

			break;

   470

   471

		case 0x0A: /* Running cost base */

   472

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

   473

			FOR_EACH_OBJECT grf_load_dword(&buf);

   474

			ret = true;

   475

			break;

   476

   477

		case 0x0E: /* Sprite ID */

   478

			FOR_EACH_OBJECT {

   479

				uint8 spriteid = grf_load_byte(&buf);

   480

   481

				// cars have different custom id in the GRF file

   482

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

   483

   484

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

   485

   486

				rvi[i].image_index = spriteid;

   487

			}

   488

			break;

   489

   490

		case 0x0F: /* Cargo capacity */

   491

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

   492

			break;

   493

   494

		case 0x10: /* Cargo type */

   495

			FOR_EACH_OBJECT {

   496

				uint8 cargo = grf_load_byte(&buf);

   497

   498

				if (cargo < NUM_CARGO) {

   499

					rvi[i].cargo_type = cargo;

   500

				} else {

   501

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