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

    19

#include "economy.h"

    20

    21

/* TTDPatch extended GRF format codec

    22

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

    23

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

    24

 *

    25

 * Contains portions of documentation by TTDPatch team.

    26

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

    27

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

    28

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

    29

    30

    31

uint16 _custom_sprites_base;

    32

static int _skip_sprites; // XXX

    33

static uint _file_index; // XXX

    34

extern int _traininfo_vehicle_pitch;

    35

    36

static GRFFile *_cur_grffile;

    37

GRFFile *_first_grffile;

    38

static int _cur_spriteid;

    39

static int _cur_stage;

    40

    41

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

    42

static uint32 _ttdpatch_flags[8];

    43

    44

    45

typedef enum grfspec_feature {

    46

	GSF_TRAIN,

    47

	GSF_ROAD,

    48

	GSF_SHIP,

    49

	GSF_AIRCRAFT,

    50

	GSF_STATION,

    51

	GSF_CANAL,

    52

	GSF_BRIDGE,

    53

	GSF_TOWNHOUSE,

    54

	GSF_GLOBALVAR,

    55

} grfspec_feature;

    56

    57

    58

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

    59

    60

static const int _vehcounts[4] = {

    61

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    62

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    63

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    64

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    65

};

    66

    67

static const int _vehshifts[4] = {

    68

	/* GSF_TRAIN */    0,

    69

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    70

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    71

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    72

};

    73

    74

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    75

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    76

    77

/* Debugging messages policy:

    78

 *

    79

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

    80

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

    81

 *

    82

 * 0..2 - dedicated to grfmsg()

    83

 * 3

    84

 * 4

    85

 * 5

    86

 * 6 - action handler entry reporting - one per action

    87

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

    88

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

    89

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

    90

 */

    91

    92

    93

typedef enum grfmsg_severity {

    94

	GMS_NOTICE,

    95

	GMS_WARN,

    96

	GMS_ERROR,

    97

	GMS_FATAL,

    98

} grfmsg_severity;

    99

   100

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

   101

{

   102

	static const char* const severitystr[] = {

   103

		"Notice",

   104

		"Warning",

   105

		"Error",

   106

		"Fatal"

   107

	};

   108

	int export_severity = 0;

   109

	char buf[1024];

   110

	va_list va;

   111

   112

	va_start(va, str);

   113

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

   114

	va_end(va);

   115

   116

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

   117

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

   118

}

   119

   120

   121

#define check_length(real, wanted, where) \

   122

do { \

   123

	if (real < wanted) { \

   124

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

   125

		       where, _cur_spriteid - _cur_grffile->sprite_offset, real, wanted); \

   126

		return; \

   127

	} \

   128

} while (0)

   129

   130

   131

static inline byte grf_load_byte(byte **buf)

   132

{

   133

	return *(*buf)++;

   134

}

   135

   136

static uint16 grf_load_word(byte **buf)

   137

{

   138

	uint16 val;

   139

	byte *p = *buf;

   140

	val = p[0];

   141

	val |= p[1] << 8;

   142

	*buf = p + 2;

   143

	return val;

   144

}

   145

   146

static uint16 grf_load_extended(byte** buf)

   147

{

   148

	uint16 val;

   149

	val = grf_load_byte(buf);

   150

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

   151

	return val;

   152

}

   153

   154

static uint32 grf_load_dword(byte **buf)

   155

{

   156

	uint32 val;

   157

	byte *p = *buf;

   158

	val = p[0];

   159

	val |= p[1] << 8;

   160

	val |= p[2] << 16;

   161

	val |= p[3] << 24;

   162

	*buf = p + 4;

   163

	return val;

   164

}

   165

   166

   167

static GRFFile *GetFileByGRFID(uint32 grfid)

   168

{

   169

	GRFFile *file;

   170

   171

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

   172

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

   173

	}

   174

	return file;

   175

}

   176

   177

static GRFFile *GetFileByFilename(const char *filename)

   178

{

   179

	GRFFile *file;

   180

   181

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

   182

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

   183

	}

   184

	return file;

   185

}

   186

   187

   188

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

   189

   190

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

   191

   192

static void dewagonize(int condition, int engine)

   193

{

   194

	EngineInfo *ei = &_engine_info[engine];

   195

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   196

   197

	if (condition != 0) {

   198

		ei->unk2 &= ~0x80;

   199

		rvi->flags &= ~2;

   200

	} else {

   201

		ei->unk2 |= 0x80;

   202

		rvi->flags |= 2;

   203

	}

   204

}

   205

   206

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

   207

{

   208

	EngineInfo *ei = &_engine_info[engine];

   209

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   210

	byte *buf = *bufp;

   211

	int i;

   212

	bool ret = false;

   213

   214

	switch (prop) {

   215

		case 0x05: { /* Track type */

   216

			FOR_EACH_OBJECT {

   217

				uint8 tracktype = grf_load_byte(&buf);

   218

   219

				ei[i].railtype = tracktype;

   220

			}

   221

		} break;

   222

		case 0x08: { /* AI passenger service */

   223

			/* TODO */

   224

			FOR_EACH_OBJECT {

   225

				grf_load_byte(&buf);

   226

			}

   227

			ret = true;

   228

		} break;

   229

		case 0x09: { /* Speed */

   230

			FOR_EACH_OBJECT {

   231

				uint16 speed = grf_load_word(&buf);

   232

				if (speed == 0xFFFF)

   233

					speed = 0;

   234

   235

				rvi[i].max_speed = speed;

   236

			}

   237

		} break;

   238

		case 0x0B: { /* Power */

   239

			FOR_EACH_OBJECT {

   240

				uint16 power = grf_load_word(&buf);

   241

   242

				if (rvi[i].flags & RVI_MULTIHEAD)

   243

					power /= 2;

   244

   245

				rvi[i].power = power;

   246

				dewagonize(power, engine + i);

   247

			}

   248

		} break;

   249

		case 0x0D: { /* Running cost factor */

   250

			FOR_EACH_OBJECT {

   251

				uint8 runcostfact = grf_load_byte(&buf);

   252

   253

				rvi[i].running_cost_base = runcostfact;

   254

				dewagonize(runcostfact, engine + i);

   255

			}

   256

		} break;

   257

		case 0x0E: { /* Running cost base */

   258

			FOR_EACH_OBJECT {

   259

				uint32 base = grf_load_dword(&buf);

   260

   261

				switch (base) {

   262

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

   263

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

   264

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

   265

				}

   266

				dewagonize(base, engine + i);

   267

			}

   268

		} break;

   269

		case 0x12: { /* Sprite ID */

   270

			FOR_EACH_OBJECT {

   271

				uint8 spriteid = grf_load_byte(&buf);

   272

   273

				rvi[i].image_index = spriteid;

   274

			}

   275

		} break;

   276

		case 0x13: { /* Dual-headed */

   277

			FOR_EACH_OBJECT {

   278

				uint8 dual = grf_load_byte(&buf);

   279

   280

				if (dual != 0) {

   281

					if (!(rvi[i].flags & RVI_MULTIHEAD)) // adjust power if needed

   282

						rvi[i].power /= 2;

   283

					rvi[i].flags |= RVI_MULTIHEAD;

   284

				} else {

   285

					if (rvi[i].flags & RVI_MULTIHEAD) // adjust power if needed

   286

						rvi[i].power *= 2;

   287

					rvi[i].flags &= ~RVI_MULTIHEAD;

   288

				}

   289

			}

   290

		} break;

   291

		case 0x14: { /* Cargo capacity */

   292

			FOR_EACH_OBJECT {

   293

				uint8 capacity = grf_load_byte(&buf);

   294

   295

				rvi[i].capacity = capacity;

   296

			}

   297

		} break;

   298

		case 0x15: { /* Cargo type */

   299

			FOR_EACH_OBJECT {

   300

				uint8 ctype = grf_load_byte(&buf);

   301

   302

				rvi[i].cargo_type = ctype;

   303

			}

   304

		} break;

   305

		case 0x16: { /* Weight */

   306

			FOR_EACH_OBJECT {

   307

				uint8 weight = grf_load_byte(&buf);

   308

   309

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

   310

			}

   311

		} break;

   312

		case 0x17: { /* Cost factor */

   313

			FOR_EACH_OBJECT {

   314

				uint8 cfactor = grf_load_byte(&buf);

   315

   316

				rvi[i].base_cost = cfactor;

   317

			}

   318

		} break;

   319

		case 0x18: { /* AI rank */

   320

			/* TODO: _railveh_score should be merged to _rail_vehicle_info. */

   321

			FOR_EACH_OBJECT {

   322

				grf_load_byte(&buf);

   323

			}

   324

			ret = true;

   325

		} break;

   326

		case 0x19: { /* Engine traction type */

   327

			/* TODO: What do the individual numbers mean?

   328

			 * XXX: And in what base are they, in fact? --pasky */

   329

			FOR_EACH_OBJECT {

   330

				uint8 traction = grf_load_byte(&buf);

   331

				int engclass;

   332

   333

				if (traction <= 0x07)

   334

					engclass = 0;

   335

				else if (traction <= 0x27)

   336

					engclass = 1;

   337

				else if (traction <= 0x31)

   338

					engclass = 2;

   339

				else

   340

					break;

   341

   342

				rvi[i].engclass = engclass;

   343

			}

   344

		} break;

   345

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

   346

			FOR_EACH_OBJECT {

   347

				uint16 wag_power = grf_load_word(&buf);

   348

   349

				rvi[i].pow_wag_power = wag_power;

   350

			}

   351

		} break;

   352

		case 0x1D: { /* Refit cargo */

   353

			FOR_EACH_OBJECT {

   354

				uint32 refit_mask = grf_load_dword(&buf);

   355

   356

				_engine_info[engine + i].refit_mask = refit_mask;

   357

			}

   358

		} break;

   359

		case 0x1E: { /* Callback */

   360

			FOR_EACH_OBJECT {

   361

				byte callbacks = grf_load_byte(&buf);

   362

   363

				rvi[i].callbackmask = callbacks;

   364

			}

   365

		} break;

   366

		case 0x21: { /* Shorter vehicle */

   367

			FOR_EACH_OBJECT {

   368

				byte shorten_factor = grf_load_byte(&buf);

   369

   370

				rvi[i].shorten_factor = shorten_factor;

   371

			}

   372

		} break;

   373

		case 0x22: { /* Visual effect */

   374

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

   375

			FOR_EACH_OBJECT {

   376

				byte visual = grf_load_byte(&buf);

   377

   378

				rvi[i].visual_effect = visual;

   379

			}

   380

		} break;

   381

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

   382

			FOR_EACH_OBJECT {

   383

				byte wag_weight = grf_load_byte(&buf);

   384

   385

				rvi[i].pow_wag_weight = wag_weight;

   386

			}

   387

		} break;

   388

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

   389

			FOR_EACH_OBJECT {

   390

				byte weight = grf_load_byte(&buf);

   391

   392

				if (weight > 4) {

   393

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

   394

				} else {

   395

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

   396

				}

   397

			}

   398

		} break;

   399

		case 0x28: { /* Cargo classes allowed */

   400

			FOR_EACH_OBJECT {

   401

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

   402

			}

   403

		} break;

   404

		case 0x29: { /* Cargo classes disallowed */

   405

			FOR_EACH_OBJECT {

   406

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

   407

			}

   408

		} break;

   409

		/* TODO */

   410

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

   411

		case 0x1A:	/* Sort order */

   412

		case 0x1C:	/* Refit cost */

   413

		case 0x1F:	/* Tractive effort */

   414

		case 0x20:	/* Air drag */

   415

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

   416

		case 0x26:	/* Retire vehicle early */

   417

			{

   418

			/* TODO */

   419

			FOR_EACH_OBJECT {

   420

				grf_load_byte(&buf);

   421

			}

   422

			ret = true;

   423

		}	break;

   424

		default:

   425

			ret = true;

   426

	}

   427

	*bufp = buf;

   428

	return ret;

   429

}

   430

   431

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

   432

{

   433

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   434

	byte *buf = *bufp;

   435

	int i;

   436

	bool ret = false;

   437

   438

	switch (prop) {

   439

		case 0x08: { /* Speed */

   440

			FOR_EACH_OBJECT {

   441

				uint8 speed = grf_load_byte(&buf);

   442

   443

				rvi[i].max_speed = speed; // ?? units

   444

			}

   445

		} break;

   446

		case 0x09: { /* Running cost factor */

   447

			FOR_EACH_OBJECT {

   448

				uint8 runcost = grf_load_byte(&buf);

   449

   450

				rvi[i].running_cost = runcost;

   451

			}

   452

		} break;

   453

		case 0x0A: { /* Running cost base */

   454

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

   455

			FOR_EACH_OBJECT {

   456

				grf_load_dword(&buf);

   457

			}

   458

			ret = true;

   459

		} break;

   460

		case 0x0E: { /* Sprite ID */

   461

			FOR_EACH_OBJECT {

   462

				uint8 spriteid = grf_load_byte(&buf);

   463

   464

				if (spriteid == 0xFF)

   465

					spriteid = 0xFD; // cars have different custom id in the GRF file

   466

   467

				rvi[i].image_index = spriteid;

   468

			}

   469

		} break;

   470

		case 0x0F: { /* Cargo capacity */

   471

			FOR_EACH_OBJECT {

   472

				uint16 capacity = grf_load_byte(&buf);

   473

   474

				rvi[i].capacity = capacity;

   475

			}

   476

		} break;

   477

		case 0x10: { /* Cargo type */

   478

			FOR_EACH_OBJECT {

   479

				uint8 cargo = grf_load_byte(&buf);

   480

   481

				rvi[i].cargo_type = cargo;

   482

			}

   483

		} break;

   484

		case 0x11: { /* Cost factor */

   485

			FOR_EACH_OBJECT {

   486

				uint8 cost_factor = grf_load_byte(&buf);

   487

   488

				rvi[i].base_cost = cost_factor; // ?? is it base_cost?

   489

			}

   490

		} break;

   491

		case 0x12: { /* SFX */

   492

			FOR_EACH_OBJECT {

   493

				uint8 sfx = grf_load_byte(&buf);