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

int _grffile_count;

    39

static int _cur_spriteid;

    40

static int _cur_stage;

    41

    42

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

    43

static uint32 _ttdpatch_flags[8];

    44

    45

    46

typedef enum grfspec_feature {

    47

	GSF_TRAIN,

    48

	GSF_ROAD,

    49

	GSF_SHIP,

    50

	GSF_AIRCRAFT,

    51

	GSF_STATION,

    52

	GSF_CANAL,

    53

	GSF_BRIDGE,

    54

	GSF_TOWNHOUSE,

    55

	GSF_GLOBALVAR,

    56

} grfspec_feature;

    57

    58

    59

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

    60

    61

static const int _vehcounts[4] = {

    62

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    63

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    64

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    65

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    66

};

    67

    68

static const int _vehshifts[4] = {

    69

	/* GSF_TRAIN */    0,

    70

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    71

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    72

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    73

};

    74

    75

    76

/* Debugging messages policy:

    77

 *

    78

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

    79

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

    80

 *

    81

 * 0..2 - dedicated to grfmsg()

    82

 * 3

    83

 * 4

    84

 * 5

    85

 * 6 - action handler entry reporting - one per action

    86

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

    87

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

    88

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

    89

 */

    90

    91

    92

typedef enum grfmsg_severity {

    93

	GMS_NOTICE,

    94

	GMS_WARN,

    95

	GMS_ERROR,

    96

	GMS_FATAL,

    97

} grfmsg_severity;

    98

    99

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

   100

{

   101

	static const char* const severitystr[] = {

   102

		"Notice",

   103

		"Warning",

   104

		"Error",

   105

		"Fatal"

   106

	};

   107

	int export_severity = 0;

   108

	char buf[1024];

   109

	va_list va;

   110

   111

	va_start(va, str);

   112

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

   113

	va_end(va);

   114

   115

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

   116

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

   117

}

   118

   119

   120

#define check_length(real, wanted, where) \

   121

do { \

   122

	if (real < wanted) { \

   123

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

   124

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

   125

		return; \

   126

	} \

   127

} while (0)

   128

   129

   130

static inline byte grf_load_byte(byte **buf)

   131

{

   132

	return *(*buf)++;

   133

}

   134

   135

static uint16 grf_load_word(byte **buf)

   136

{

   137

	uint16 val;

   138

	byte *p = *buf;

   139

	val = p[0];

   140

	val |= p[1] << 8;

   141

	*buf = p + 2;

   142

	return val;

   143

}

   144

   145

static uint16 grf_load_extended(byte** buf)

   146

{

   147

	uint16 val;

   148

	val = grf_load_byte(buf);

   149

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

   150

	return val;

   151

}

   152

   153

static uint32 grf_load_dword(byte **buf)

   154

{

   155

	uint32 val;

   156

	byte *p = *buf;

   157

	val = p[0];

   158

	val |= p[1] << 8;

   159

	val |= p[2] << 16;

   160

	val |= p[3] << 24;

   161

	*buf = p + 4;

   162

	return val;

   163

}

   164

   165

   166

static GRFFile *GetFileByGRFID(uint32 grfid)

   167

{

   168

	GRFFile *file;

   169

   170

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

   171

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

   172

	}

   173

	return file;

   174

}

   175

   176

static GRFFile *GetFileByFilename(const char *filename)

   177

{

   178

	GRFFile *file;

   179

   180

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

   181

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

   182

	}

   183

	return file;

   184

}

   185

   186

   187

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

   188

   189

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

   190

   191

static void dewagonize(int condition, int engine)

   192

{

   193

	EngineInfo *ei = &_engine_info[engine];

   194

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   195

   196

	if (condition != 0) {

   197

		ei->unk2 &= ~0x80;

   198

		rvi->flags &= ~2;

   199

	} else {

   200

		ei->unk2 |= 0x80;

   201

		rvi->flags |= 2;

   202

	}

   203

}

   204

   205

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

   206

{

   207

	EngineInfo *ei = &_engine_info[engine];

   208

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   209

	byte *buf = *bufp;

   210

	int i;

   211

	bool ret = false;

   212

   213

	switch (prop) {

   214

		case 0x05: { /* Track type */

   215

			FOR_EACH_OBJECT {

   216

				uint8 tracktype = grf_load_byte(&buf);

   217

   218

				ei[i].railtype_climates &= 0xf;

   219

				ei[i].railtype_climates |= tracktype << 4;

   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:

   263

					rvi[i].engclass = 0;

   264

					break;

   265

				case 0x4C36:

   266

					rvi[i].engclass = 1;

   267

					break;

   268

				case 0x4C3C:

   269

					rvi[i].engclass = 2;

   270

					break;

   271

				}

   272

				dewagonize(base, engine + i);

   273

			}

   274

		} break;

   275

		case 0x12: { /* Sprite ID */

   276

			FOR_EACH_OBJECT {

   277

				uint8 spriteid = grf_load_byte(&buf);

   278

   279

				rvi[i].image_index = spriteid;

   280

			}

   281

		} break;

   282

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

   283

			FOR_EACH_OBJECT {

   284

				uint8 dual = grf_load_byte(&buf);

   285

   286

				if (dual != 0) {

   287

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

   288

						rvi[i].power /= 2;

   289

					rvi[i].flags |= RVI_MULTIHEAD;

   290

				} else {

   291

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

   292

						rvi[i].power *= 2;

   293

					rvi[i].flags &= ~RVI_MULTIHEAD;

   294

				}

   295

			}

   296

		} break;

   297

		case 0x14: { /* Cargo capacity */

   298

			FOR_EACH_OBJECT {

   299

				uint8 capacity = grf_load_byte(&buf);

   300

   301

				rvi[i].capacity = capacity;

   302

			}

   303

		} break;

   304

		case 0x15: { /* Cargo type */

   305

			FOR_EACH_OBJECT {

   306

				uint8 ctype = grf_load_byte(&buf);

   307

   308

				rvi[i].cargo_type = ctype;

   309

			}

   310

		} break;

   311

		case 0x16: { /* Weight */

   312

			FOR_EACH_OBJECT {

   313

				uint8 weight = grf_load_byte(&buf);

   314

   315

				rvi[i].weight = weight;

   316

			}

   317

		} break;

   318

		case 0x17: { /* Cost factor */

   319

			FOR_EACH_OBJECT {

   320

				uint8 cfactor = grf_load_byte(&buf);

   321

   322

				rvi[i].base_cost = cfactor;

   323

			}

   324

		} break;

   325

		case 0x18: { /* AI rank */

   326

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

   327

			FOR_EACH_OBJECT {

   328

				grf_load_byte(&buf);

   329

			}

   330

			ret = true;

   331

		} break;

   332

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

   333

			/* TODO: What do the individual numbers mean?

   334

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

   335

			FOR_EACH_OBJECT {

   336

				uint8 traction = grf_load_byte(&buf);

   337

				int engclass;

   338

   339

				if (traction <= 0x07)

   340

					engclass = 0;

   341

				else if (traction <= 0x27)

   342

					engclass = 1;

   343

				else if (traction <= 0x31)

   344

					engclass = 2;

   345

				else

   346

					break;

   347

   348

				rvi[i].engclass = engclass;

   349

			}

   350

		} break;

   351

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

   352

			FOR_EACH_OBJECT {

   353

				uint16 wag_power = grf_load_word(&buf);

   354

   355

				rvi[i].pow_wag_power = wag_power;

   356

			}

   357

		} break;

   358

		case 0x1D: { /* Refit cargo */

   359

			FOR_EACH_OBJECT {

   360

				uint32 refit_mask = grf_load_dword(&buf);

   361

   362

				_engine_refit_masks[engine + i] = refit_mask;

   363

			}

   364

		} break;

   365

		case 0x1E: { /* Callback */

   366

			FOR_EACH_OBJECT {

   367

				byte callbacks = grf_load_byte(&buf);

   368

   369

				rvi[i].callbackmask = callbacks;

   370

			}

   371

		} break;

   372

		case 0x21: { /* Shorter vehicle */

   373

			FOR_EACH_OBJECT {

   374

				byte shorten_factor = grf_load_byte(&buf);

   375

   376

				rvi[i].shorten_factor = shorten_factor;

   377

			}

   378

		} break;

   379

		case 0x22: { /* Visual effect */

   380

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

   381

			FOR_EACH_OBJECT {

   382

				byte visual = grf_load_byte(&buf);

   383

   384

				rvi[i].visual_effect = visual;

   385

			}

   386

		} break;

   387

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

   388

			FOR_EACH_OBJECT {

   389

				byte wag_weight = grf_load_byte(&buf);

   390

   391

				rvi[i].pow_wag_weight = wag_weight;

   392

			}

   393

		} break;

   394

		/* TODO */

   395

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

   396

		case 0x1A:	/* Sort order */

   397

		case 0x1C:	/* Refit cost */

   398

		case 0x1F:	/* Tractive effort */

   399

		case 0x20:	/* Air drag */

   400

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

   401

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

   402

		case 0x26:	/* Retire vehicle early */

   403

			{

   404

			/* TODO */

   405

			FOR_EACH_OBJECT {

   406

				grf_load_byte(&buf);

   407

			}

   408

			ret = true;

   409

		}	break;

   410

		default:

   411

			ret = true;

   412

	}

   413

	*bufp = buf;

   414

	return ret;

   415

}

   416

   417

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

   418

{

   419

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   420

	byte *buf = *bufp;

   421

	int i;

   422

	bool ret = false;

   423

   424

	switch (prop) {

   425

		case 0x08: { /* Speed */

   426

			FOR_EACH_OBJECT {

   427

				uint8 speed = grf_load_byte(&buf);

   428

   429

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

   430

			}

   431

		} break;

   432

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

   433

			FOR_EACH_OBJECT {

   434

				uint8 runcost = grf_load_byte(&buf);

   435

   436

				rvi[i].running_cost = runcost;

   437

			}

   438

		} break;

   439

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

   440

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

   441

			FOR_EACH_OBJECT {

   442

				grf_load_dword(&buf);

   443

			}

   444

			ret = true;

   445

		} break;

   446

		case 0x0E: { /* Sprite ID */

   447

			FOR_EACH_OBJECT {

   448

				uint8 spriteid = grf_load_byte(&buf);

   449

   450

				if (spriteid == 0xFF)

   451

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

   452

   453

				rvi[i].image_index = spriteid;

   454

			}

   455

		} break;

   456

		case 0x0F: { /* Cargo capacity */

   457

			FOR_EACH_OBJECT {

   458

				uint16 capacity = grf_load_byte(&buf);

   459

   460

				rvi[i].capacity = capacity;

   461

			}

   462

		} break;

   463

		case 0x10: { /* Cargo type */

   464

			FOR_EACH_OBJECT {

   465

				uint8 cargo = grf_load_byte(&buf);

   466

   467

				rvi[i].cargo_type = cargo;

   468

			}

   469

		} break;

   470

		case 0x11: { /* Cost factor */

   471

			FOR_EACH_OBJECT {

   472

				uint8 cost_factor = grf_load_byte(&buf);

   473

   474

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

   475

			}

   476

		} break;

   477

		case 0x12: { /* SFX */

   478

			FOR_EACH_OBJECT {

   479

				uint8 sfx = grf_load_byte(&buf);

   480

   481

				rvi[i].sfx = sfx;

   482

			}

   483

		} break;

   484

		case 0x13:      /* Power in 10hp */

   485

		case 0x14:      /* Weight in 1/4 tons */

   486

		case 0x15:      /* Speed in mph*0.8 */

   487

			/* TODO: Support for road vehicles realistic power

   488

			 * computations (called rvpower in TTDPatch) is just

   489

			 * missing in OTTD yet. --pasky */

   490

			FOR_EACH_OBJECT {

   491

				grf_load_byte(&buf);

   492

			}

   493

			ret = true;

   494

			break;

   495

		case 0x16: { /* Cargos available for refitting */

   496

			FOR_EACH_OBJECT {

   497

				uint32 refit_mask = grf_load_dword(&buf);

   498

   499

				_engine_refit_masks[ROAD_ENGINES_INDEX + engine + i] = refit_mask;

   500

			}

   501

		} break;

   502

		case 0x17:      /* Callback */

   503

		case 0x18:      /* Tractive effort */

   504

		case 0x19:      /* Air drag */

   505

		case 0x1A:      /* Refit cost */

   506

		case 0x1B:      /* Retire vehicle early */

   507

			{

   508

			/* TODO */

   509

			FOR_EACH_OBJECT {

   510

				grf_load_byte(&buf);