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

static int nfo_line;

    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

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    76

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    77

    78

/* Debugging messages policy:

    79

 *

    80

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

    81

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

    82

 *

    83

 * 0..2 - dedicated to grfmsg()

    84

 * 3

    85

 * 4

    86

 * 5

    87

 * 6 - action handler entry reporting - one per action

    88

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

    89

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

    90

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

    91

 */

    92

    93

    94

typedef enum grfmsg_severity {

    95

	GMS_NOTICE,

    96

	GMS_WARN,

    97

	GMS_ERROR,

    98

	GMS_FATAL,

    99

} grfmsg_severity;

   100

   101

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

   102

{

   103

	static const char* const severitystr[] = {

   104

		"Notice",

   105

		"Warning",

   106

		"Error",

   107

		"Fatal"

   108

	};

   109

	int export_severity = 0;

   110

	char buf[1024];

   111

	va_list va;

   112

   113

	va_start(va, str);

   114

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

   115

	va_end(va);

   116

   117

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

   118

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

   119

}

   120

   121

   122

#define check_length(real, wanted, where) \

   123

do { \

   124

	if (real < wanted) { \

   125

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

   126

		       where, real, wanted); \

   127

		return; \

   128

	} \

   129

} while (0)

   130

   131

   132

static inline byte grf_load_byte(byte **buf)

   133

{

   134

	return *(*buf)++;

   135

}

   136

   137

static uint16 grf_load_word(byte **buf)

   138

{

   139

	uint16 val;

   140

	byte *p = *buf;

   141

	val = p[0];

   142

	val |= p[1] << 8;

   143

	*buf = p + 2;

   144

	return val;

   145

}

   146

   147

static uint16 grf_load_extended(byte** buf)

   148

{

   149

	uint16 val;

   150

	val = grf_load_byte(buf);

   151

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

   152

	return val;

   153

}

   154

   155

static uint32 grf_load_dword(byte **buf)

   156

{

   157

	uint32 val;

   158

	byte *p = *buf;

   159

	val = p[0];

   160

	val |= p[1] << 8;

   161

	val |= p[2] << 16;

   162

	val |= p[3] << 24;

   163

	*buf = p + 4;

   164

	return val;

   165

}

   166

   167

   168

static GRFFile *GetFileByGRFID(uint32 grfid)

   169

{

   170

	GRFFile *file;

   171

   172

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

   173

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

   174

	}

   175

	return file;

   176

}

   177

   178

static GRFFile *GetFileByFilename(const char *filename)

   179

{

   180

	GRFFile *file;

   181

   182

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

   183

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

   184

	}

   185

	return file;

   186

}

   187

   188

   189

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

   190

   191

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

   192

   193

static void dewagonize(int condition, int engine)

   194

{

   195

	EngineInfo *ei = &_engine_info[engine];

   196

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   197

   198

	if (condition != 0) {

   199

		ei->unk2 &= ~0x80;

   200

		rvi->flags &= ~2;

   201

	} else {

   202

		ei->unk2 |= 0x80;

   203

		rvi->flags |= 2;

   204

	}

   205

}

   206

   207

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

   208

{

   209

	EngineInfo *ei = &_engine_info[engine];

   210

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   211

	byte *buf = *bufp;

   212

	int i;

   213

	bool ret = false;

   214

   215

	switch (prop) {

   216

		case 0x05: { /* Track type */

   217

			FOR_EACH_OBJECT {

   218

				uint8 tracktype = grf_load_byte(&buf);

   219

   220

				ei[i].railtype = tracktype;

   221

			}

   222

		} break;

   223

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

   224

			/* TODO */

   225

			FOR_EACH_OBJECT {

   226

				grf_load_byte(&buf);

   227

			}

   228

			ret = true;

   229

		} break;

   230

		case 0x09: { /* Speed */

   231

			FOR_EACH_OBJECT {

   232

				uint16 speed = grf_load_word(&buf);

   233

				if (speed == 0xFFFF)

   234

					speed = 0;

   235

   236

				rvi[i].max_speed = speed;

   237

			}

   238

		} break;

   239

		case 0x0B: { /* Power */

   240

			FOR_EACH_OBJECT {

   241

				uint16 power = grf_load_word(&buf);

   242

   243

				if (rvi[i].flags & RVI_MULTIHEAD)

   244

					power /= 2;

   245

   246

				rvi[i].power = power;

   247

				dewagonize(power, engine + i);

   248

			}

   249

		} break;

   250

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

   251

			FOR_EACH_OBJECT {

   252

				uint8 runcostfact = grf_load_byte(&buf);

   253

   254

				if (rvi[i].flags & RVI_MULTIHEAD)

   255

					runcostfact /= 2;

   256

   257

				rvi[i].running_cost_base = runcostfact;

   258

			}

   259

		} break;

   260

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

   261

			FOR_EACH_OBJECT {

   262

				uint32 base = grf_load_dword(&buf);

   263

   264

				switch (base) {

   265

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

   266

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

   267

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

   268

				}

   269

			}

   270

		} break;

   271

		case 0x12: { /* Sprite ID */

   272

			FOR_EACH_OBJECT {

   273

				uint8 spriteid = grf_load_byte(&buf);

   274

   275

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

   276

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

   277

				if (spriteid < 0xFD)

   278

					spriteid >>= 1;

   279

   280

				rvi[i].image_index = spriteid;

   281

			}

   282

		} break;

   283

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

   284

			FOR_EACH_OBJECT {

   285

				uint8 dual = grf_load_byte(&buf);

   286

   287

				if (dual != 0) {

   288

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

   289

						// adjust power and running cost if needed

   290

						rvi[i].power /= 2;

   291

						rvi[i].running_cost_base /= 2;

   292

					}

   293

					rvi[i].flags |= RVI_MULTIHEAD;

   294

				} else {

   295

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

   296

						// adjust power and running cost if needed

   297

						rvi[i].power *= 2;

   298

						rvi[i].running_cost_base *= 2;

   299

					}

   300

					rvi[i].flags &= ~RVI_MULTIHEAD;

   301

				}

   302

			}

   303

		} break;

   304

		case 0x14: { /* Cargo capacity */

   305

			FOR_EACH_OBJECT {

   306

				uint8 capacity = grf_load_byte(&buf);

   307

   308

				rvi[i].capacity = capacity;

   309

			}

   310

		} break;

   311

		case 0x15: { /* Cargo type */

   312

			FOR_EACH_OBJECT {

   313

				uint8 ctype = grf_load_byte(&buf);

   314

   315

				if (ctype < NUM_CARGO) {

   316

					rvi[i].cargo_type = ctype;

   317

				} else {

   318

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

   319

				}

   320

			}

   321

		} break;

   322

		case 0x16: { /* Weight */

   323

			FOR_EACH_OBJECT {

   324

				uint8 weight = grf_load_byte(&buf);

   325

   326

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

   327

			}

   328

		} break;

   329

		case 0x17: { /* Cost factor */

   330

			FOR_EACH_OBJECT {

   331

				uint8 cfactor = grf_load_byte(&buf);

   332

   333

				rvi[i].base_cost = cfactor;

   334

			}

   335

		} break;

   336

		case 0x18: { /* AI rank */

   337

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

   338

			FOR_EACH_OBJECT {

   339

				grf_load_byte(&buf);

   340

			}

   341

			ret = true;

   342

		} break;

   343

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

   344

			/* What do the individual numbers mean?

   345

			 * 0x00 .. 0x07: Steam

   346

			 * 0x08 .. 0x27: Diesel

   347

			 * 0x28 .. 0x31: Electric

   348

			 * 0x32 .. 0x37: Monorail

   349

			 * 0x38 .. 0x41: Maglev

   350

			 */

   351

			FOR_EACH_OBJECT {

   352

				uint8 traction = grf_load_byte(&buf);

   353

				int engclass;

   354

   355

				if (traction <= 0x07)

   356

					engclass = 0;

   357

				else if (traction <= 0x27)

   358

					engclass = 1;

   359

				else if (traction <= 0x41)

   360

					engclass = 2;

   361

				else

   362

					break;

   363

   364

				rvi[i].engclass = engclass;

   365

			}

   366

		} break;

   367

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

   368

			FOR_EACH_OBJECT {

   369

				uint16 wag_power = grf_load_word(&buf);

   370

   371

				rvi[i].pow_wag_power = wag_power;

   372

			}

   373

		} break;

   374

		case 0x1D: { /* Refit cargo */

   375

			FOR_EACH_OBJECT {

   376

				uint32 refit_mask = grf_load_dword(&buf);

   377

   378

				_engine_info[engine + i].refit_mask = refit_mask;

   379

			}

   380

		} break;

   381

		case 0x1E: { /* Callback */

   382

			FOR_EACH_OBJECT {

   383

				byte callbacks = grf_load_byte(&buf);

   384

   385

				rvi[i].callbackmask = callbacks;

   386

			}

   387

		} break;

   388

		case 0x21: { /* Shorter vehicle */

   389

			FOR_EACH_OBJECT {

   390

				byte shorten_factor = grf_load_byte(&buf);

   391

   392

				rvi[i].shorten_factor = shorten_factor;

   393

			}

   394

		} break;

   395

		case 0x22: { /* Visual effect */

   396

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

   397

			FOR_EACH_OBJECT {

   398

				byte visual = grf_load_byte(&buf);

   399

   400

				rvi[i].visual_effect = visual;

   401

			}

   402

		} break;

   403

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

   404

			FOR_EACH_OBJECT {

   405

				byte wag_weight = grf_load_byte(&buf);

   406

   407

				rvi[i].pow_wag_weight = wag_weight;

   408

			}

   409

		} break;

   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

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

   422

			FOR_EACH_OBJECT {

   423

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

   424

			}

   425

		} break;

   426

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

   427

			FOR_EACH_OBJECT {

   428

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

   429

			}

   430

		} break;

   431

		/* TODO */

   432

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

   433

		case 0x1A:	/* Sort order */

   434

		case 0x1C:	/* Refit cost */

   435

		case 0x1F:	/* Tractive effort */

   436

		case 0x20:	/* Air drag */

   437

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

   438

		case 0x26:	/* Retire vehicle early */

   439

		case 0x27:	/* Miscellaneous flags */

   440

			{

   441

			/* TODO */

   442

			FOR_EACH_OBJECT {

   443

				grf_load_byte(&buf);

   444

			}

   445

			ret = true;

   446

		}	break;

   447

		default:

   448

			ret = true;

   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

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   457

	byte *buf = *bufp;

   458

	int i;

   459

	bool ret = false;

   460

   461

	switch (prop) {

   462

		case 0x08: { /* Speed */

   463

			FOR_EACH_OBJECT {

   464

				uint8 speed = grf_load_byte(&buf);

   465

   466

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

   467

			}

   468

		} break;

   469

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

   470

			FOR_EACH_OBJECT {

   471

				uint8 runcost = grf_load_byte(&buf);

   472

   473

				rvi[i].running_cost = runcost;

   474

			}

   475

		} break;

   476

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

   477

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

   478

			FOR_EACH_OBJECT {

   479

				grf_load_dword(&buf);

   480

			}

   481

			ret = true;

   482

		} break;

   483

		case 0x0E: { /* Sprite ID */

   484

			FOR_EACH_OBJECT {

   485

				uint8 spriteid = grf_load_byte(&buf);

   486

   487

				if (spriteid == 0xFF)

   488

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

   489

   490

				if (spriteid < 0xFD)

   491

					spriteid >>= 1;

   492