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

   219

			}

   220

		} break;

   221

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

   222

			/* TODO */

   223

			FOR_EACH_OBJECT {

   224

				grf_load_byte(&buf);

   225

			}

   226

			ret = true;

   227

		} break;

   228

		case 0x09: { /* Speed */

   229

			FOR_EACH_OBJECT {

   230

				uint16 speed = grf_load_word(&buf);

   231

				if (speed == 0xFFFF)

   232

					speed = 0;

   233

   234

				rvi[i].max_speed = speed;

   235

			}

   236

		} break;

   237

		case 0x0B: { /* Power */

   238

			FOR_EACH_OBJECT {

   239

				uint16 power = grf_load_word(&buf);

   240

   241

				if (rvi[i].flags & RVI_MULTIHEAD)

   242

					power /= 2;

   243

   244

				rvi[i].power = power;

   245

				dewagonize(power, engine + i);

   246

			}

   247

		} break;

   248

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

   249

			FOR_EACH_OBJECT {

   250

				uint8 runcostfact = grf_load_byte(&buf);

   251

   252

				rvi[i].running_cost_base = runcostfact;

   253

				dewagonize(runcostfact, engine + i);

   254

			}

   255

		} break;

   256

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

   257

			FOR_EACH_OBJECT {

   258

				uint32 base = grf_load_dword(&buf);

   259

   260

				switch (base) {

   261

				case 0x4C30:

   262

					rvi[i].engclass = 0;

   263

					break;

   264

				case 0x4C36:

   265

					rvi[i].engclass = 1;

   266

					break;

   267

				case 0x4C3C:

   268

					rvi[i].engclass = 2;

   269

					break;

   270

				}

   271

				dewagonize(base, engine + i);

   272

			}

   273

		} break;

   274

		case 0x12: { /* Sprite ID */

   275

			FOR_EACH_OBJECT {

   276

				uint8 spriteid = grf_load_byte(&buf);

   277

   278

				rvi[i].image_index = spriteid;

   279

			}

   280

		} break;

   281

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

   282

			FOR_EACH_OBJECT {

   283

				uint8 dual = grf_load_byte(&buf);

   284

   285

				if (dual != 0) {

   286

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

   287

						rvi[i].power /= 2;

   288

					rvi[i].flags |= RVI_MULTIHEAD;

   289

				} else {

   290

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

   291

						rvi[i].power *= 2;

   292

					rvi[i].flags &= ~RVI_MULTIHEAD;

   293

				}

   294

			}

   295

		} break;

   296

		case 0x14: { /* Cargo capacity */

   297

			FOR_EACH_OBJECT {

   298

				uint8 capacity = grf_load_byte(&buf);

   299

   300

				rvi[i].capacity = capacity;

   301

			}

   302

		} break;

   303

		case 0x15: { /* Cargo type */

   304

			FOR_EACH_OBJECT {

   305

				uint8 ctype = grf_load_byte(&buf);

   306

   307

				rvi[i].cargo_type = ctype;

   308

			}

   309

		} break;

   310

		case 0x16: { /* Weight */

   311

			FOR_EACH_OBJECT {

   312

				uint8 weight = grf_load_byte(&buf);

   313

   314

				rvi[i].weight = weight;

   315

			}

   316

		} break;

   317

		case 0x17: { /* Cost factor */

   318

			FOR_EACH_OBJECT {

   319

				uint8 cfactor = grf_load_byte(&buf);

   320

   321

				rvi[i].base_cost = cfactor;

   322

			}

   323

		} break;

   324

		case 0x18: { /* AI rank */

   325

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

   326

			FOR_EACH_OBJECT {

   327

				grf_load_byte(&buf);

   328

			}

   329

			ret = true;

   330

		} break;

   331

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

   332

			/* TODO: What do the individual numbers mean?

   333

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

   334

			FOR_EACH_OBJECT {

   335

				uint8 traction = grf_load_byte(&buf);

   336

				int engclass;

   337

   338

				if (traction <= 0x07)

   339

					engclass = 0;

   340

				else if (traction <= 0x27)

   341

					engclass = 1;

   342

				else if (traction <= 0x31)

   343

					engclass = 2;

   344

				else

   345

					break;

   346

   347

				rvi[i].engclass = engclass;

   348

			}

   349

		} break;

   350

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

   351

			FOR_EACH_OBJECT {

   352

				uint16 wag_power = grf_load_word(&buf);

   353

   354

				rvi[i].pow_wag_power = wag_power;

   355

			}

   356

		} break;

   357

		case 0x1D: { /* Refit cargo */

   358

			FOR_EACH_OBJECT {

   359

				uint32 refit_mask = grf_load_dword(&buf);

   360

   361

				_engine_refit_masks[engine + i] = refit_mask;

   362

			}

   363

		} break;

   364

		case 0x1E: { /* Callback */

   365

			FOR_EACH_OBJECT {

   366

				byte callbacks = grf_load_byte(&buf);

   367

   368

				rvi[i].callbackmask = callbacks;

   369

			}

   370

		} break;

   371

		case 0x21: { /* Shorter vehicle */

   372

			FOR_EACH_OBJECT {

   373

				byte shorten_factor = grf_load_byte(&buf);

   374

   375

				rvi[i].shorten_factor = shorten_factor;

   376

			}

   377

		} break;

   378

		case 0x22: { /* Visual effect */

   379

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

   380

			FOR_EACH_OBJECT {

   381

				byte visual = grf_load_byte(&buf);

   382

   383

				rvi[i].visual_effect = visual;

   384

			}

   385

		} break;

   386

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

   387

			FOR_EACH_OBJECT {

   388

				byte wag_weight = grf_load_byte(&buf);

   389

   390

				rvi[i].pow_wag_weight = wag_weight;

   391

			}

   392

		} break;

   393

		/* TODO */

   394

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

   395

		case 0x1A:	/* Sort order */

   396

		case 0x1C:	/* Refit cost */

   397

		case 0x1F:	/* Tractive effort */

   398

		case 0x20:	/* Air drag */

   399

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

   400

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

   401

		case 0x26:	/* Retire vehicle early */

   402

			{

   403

			/* TODO */

   404

			FOR_EACH_OBJECT {

   405

				grf_load_byte(&buf);

   406

			}

   407

			ret = true;

   408

		}	break;

   409

		default:

   410

			ret = true;

   411

	}

   412

	*bufp = buf;

   413

	return ret;

   414

}

   415

   416

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

   417

{

   418

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   419

	byte *buf = *bufp;

   420

	int i;

   421

	bool ret = false;

   422

   423

	switch (prop) {

   424

		case 0x08: { /* Speed */

   425

			FOR_EACH_OBJECT {

   426

				uint8 speed = grf_load_byte(&buf);

   427

   428

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

   429

			}

   430

		} break;

   431

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

   432

			FOR_EACH_OBJECT {

   433

				uint8 runcost = grf_load_byte(&buf);

   434

   435

				rvi[i].running_cost = runcost;

   436

			}

   437

		} break;

   438

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

   439

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

   440

			FOR_EACH_OBJECT {

   441

				grf_load_dword(&buf);

   442

			}

   443

			ret = true;

   444

		} break;

   445

		case 0x0E: { /* Sprite ID */

   446

			FOR_EACH_OBJECT {

   447

				uint8 spriteid = grf_load_byte(&buf);

   448

   449

				if (spriteid == 0xFF)

   450

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

   451

   452

				rvi[i].image_index = spriteid;

   453

			}

   454

		} break;

   455

		case 0x0F: { /* Cargo capacity */

   456

			FOR_EACH_OBJECT {

   457

				uint16 capacity = grf_load_byte(&buf);

   458

   459

				rvi[i].capacity = capacity;

   460

			}

   461

		} break;

   462

		case 0x10: { /* Cargo type */

   463

			FOR_EACH_OBJECT {

   464

				uint8 cargo = grf_load_byte(&buf);

   465

   466

				rvi[i].cargo_type = cargo;

   467

			}

   468

		} break;

   469

		case 0x11: { /* Cost factor */

   470

			FOR_EACH_OBJECT {

   471

				uint8 cost_factor = grf_load_byte(&buf);

   472

   473

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

   474

			}

   475

		} break;

   476

		case 0x12: { /* SFX */

   477

			FOR_EACH_OBJECT {

   478

				uint8 sfx = grf_load_byte(&buf);

   479

   480

				rvi[i].sfx = sfx;

   481

			}

   482

		} break;

   483

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

   484

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

   485

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

   486

			/* TODO: Support for road vehicles realistic power

   487

			 * computations (called rvpower in TTDPatch) is just

   488

			 * missing in OTTD yet. --pasky */

   489

			FOR_EACH_OBJECT {

   490

				grf_load_byte(&buf);

   491

			}

   492

			ret = true;

   493

			break;

   494

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