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

#include "newgrf_engine.h"

    21

    22

/* TTDPatch extended GRF format codec

    23

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

    24

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

    25

 *

    26

 * Contains portions of documentation by TTDPatch team.

    27

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

    28

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

    29

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

    30

    31

    32

uint16 _custom_sprites_base;

    33

static int _skip_sprites; // XXX

    34

static uint _file_index; // XXX

    35

extern int _traininfo_vehicle_pitch;

    36

    37

static GRFFile *_cur_grffile;

    38

GRFFile *_first_grffile;

    39

static int _cur_spriteid;

    40

static int _cur_stage;

    41

static int nfo_line;

    42

    43

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

    44

static uint32 _ttdpatch_flags[8];

    45

    46

    47

typedef enum grfspec_feature {

    48

	GSF_TRAIN,

    49

	GSF_ROAD,

    50

	GSF_SHIP,

    51

	GSF_AIRCRAFT,

    52

	GSF_STATION,

    53

	GSF_CANAL,

    54

	GSF_BRIDGE,

    55

	GSF_TOWNHOUSE,

    56

	GSF_GLOBALVAR,

    57

} grfspec_feature;

    58

    59

    60

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

    61

    62

static const int _vehcounts[4] = {

    63

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    64

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    65

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    66

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    67

};

    68

    69

static const int _vehshifts[4] = {

    70

	/* GSF_TRAIN */    0,

    71

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    72

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    73

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    74

};

    75

    76

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    77

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    78

    79

/* Debugging messages policy:

    80

 *

    81

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

    82

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

    83

 *

    84

 * 0..2 - dedicated to grfmsg()

    85

 * 3

    86

 * 4

    87

 * 5

    88

 * 6 - action handler entry reporting - one per action

    89

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

    90

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

    91

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

    92

 */

    93

    94

    95

typedef enum grfmsg_severity {

    96

	GMS_NOTICE,

    97

	GMS_WARN,

    98

	GMS_ERROR,

    99

	GMS_FATAL,

   100

} grfmsg_severity;

   101

   102

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

   103

{

   104

	static const char* const severitystr[] = {

   105

		"Notice",

   106

		"Warning",

   107

		"Error",

   108

		"Fatal"

   109

	};

   110

	int export_severity = 0;

   111

	char buf[1024];

   112

	va_list va;

   113

   114

	va_start(va, str);

   115

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

   116

	va_end(va);

   117

   118

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

   119

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

   120

}

   121

   122

   123

#define check_length(real, wanted, where) \

   124

do { \

   125

	if (real < wanted) { \

   126

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

   127

		       where, real, wanted); \

   128

		return; \

   129

	} \

   130

} while (0)

   131

   132

   133

static inline byte grf_load_byte(byte **buf)

   134

{

   135

	return *(*buf)++;

   136

}

   137

   138

static uint16 grf_load_word(byte **buf)

   139

{

   140

	uint16 val;

   141

	byte *p = *buf;

   142

	val = p[0];

   143

	val |= p[1] << 8;

   144

	*buf = p + 2;

   145

	return val;

   146

}

   147

   148

static uint16 grf_load_extended(byte** buf)

   149

{

   150

	uint16 val;

   151

	val = grf_load_byte(buf);

   152

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

   153

	return val;

   154

}

   155

   156

static uint32 grf_load_dword(byte **buf)

   157

{

   158

	uint32 val;

   159

	byte *p = *buf;

   160

	val = p[0];

   161

	val |= p[1] << 8;

   162

	val |= p[2] << 16;

   163

	val |= p[3] << 24;

   164

	*buf = p + 4;

   165

	return val;

   166

}

   167

   168

   169

static GRFFile *GetFileByGRFID(uint32 grfid)

   170

{

   171

	GRFFile *file;

   172

   173

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

   174

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

   175

	}

   176

	return file;

   177

}

   178

   179

static GRFFile *GetFileByFilename(const char *filename)

   180

{

   181

	GRFFile *file;

   182

   183

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

   184

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

   185

	}

   186

	return file;

   187

}

   188

   189

   190

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

   191

   192

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

   193

   194

static void dewagonize(int condition, int engine)

   195

{

   196

	EngineInfo *ei = &_engine_info[engine];

   197

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   198

   199

	if (condition != 0) {

   200

		ei->unk2 &= ~0x80;

   201

		rvi->flags &= ~2;

   202

	} else {

   203

		ei->unk2 |= 0x80;

   204

		rvi->flags |= 2;

   205

	}

   206

}

   207

   208

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

   209

{

   210

	EngineInfo *ei = &_engine_info[engine];

   211

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   212

	byte *buf = *bufp;

   213

	int i;

   214

	bool ret = false;

   215

   216

	switch (prop) {

   217

		case 0x05: /* Track type */

   218

			FOR_EACH_OBJECT {

   219

				uint8 tracktype = grf_load_byte(&buf);

   220

   221

				switch (tracktype) {

   222

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

   223

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

   224

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

   225

					default:

   226

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

   227

						break;

   228

				}

   229

			}

   230

			break;

   231

   232

		case 0x08: /* AI passenger service */

   233

			/* TODO */

   234

			FOR_EACH_OBJECT grf_load_byte(&buf);

   235

			ret = true;

   236

			break;

   237

   238

		case 0x09: /* Speed */

   239

			FOR_EACH_OBJECT {

   240

				uint16 speed = grf_load_word(&buf);

   241

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

   242

   243

				rvi[i].max_speed = speed;

   244

			}

   245

			break;

   246

   247

		case 0x0B: /* Power */

   248

			FOR_EACH_OBJECT {

   249

				uint16 power = grf_load_word(&buf);

   250

   251

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

   252

   253

				rvi[i].power = power;

   254

				dewagonize(power, engine + i);

   255

			}

   256

			break;

   257

   258

		case 0x0D: /* Running cost factor */

   259

			FOR_EACH_OBJECT {

   260

				uint8 runcostfact = grf_load_byte(&buf);

   261

   262

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

   263

   264

				rvi[i].running_cost_base = runcostfact;

   265

			}

   266

			break;

   267

   268

		case 0x0E: /* Running cost base */

   269

			FOR_EACH_OBJECT {

   270

				uint32 base = grf_load_dword(&buf);

   271

   272

				switch (base) {

   273

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

   274

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

   275

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

   276

				}

   277

			}

   278

			break;

   279

   280

		case 0x12: /* Sprite ID */

   281

			FOR_EACH_OBJECT {

   282

				uint8 spriteid = grf_load_byte(&buf);

   283

   284

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

   285

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

   286

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

   287

   288

				rvi[i].image_index = spriteid;

   289

			}

   290

			break;

   291

   292

		case 0x13: /* Dual-headed */

   293

			FOR_EACH_OBJECT {

   294

				uint8 dual = grf_load_byte(&buf);

   295

   296

				if (dual != 0) {

   297

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

   298

						// adjust power and running cost if needed

   299

						rvi[i].power /= 2;

   300

						rvi[i].running_cost_base /= 2;

   301

					}

   302

					rvi[i].flags |= RVI_MULTIHEAD;

   303

				} else {

   304

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

   305

						// adjust power and running cost if needed

   306

						rvi[i].power *= 2;

   307

						rvi[i].running_cost_base *= 2;

   308

					}

   309

					rvi[i].flags &= ~RVI_MULTIHEAD;

   310

				}

   311

			}

   312

			break;

   313

   314

		case 0x14: /* Cargo capacity */

   315

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

   316

			break;

   317

   318

		case 0x15: /* Cargo type */

   319

			FOR_EACH_OBJECT {

   320

				uint8 ctype = grf_load_byte(&buf);

   321

   322

				if (ctype < NUM_CARGO) {

   323

					rvi[i].cargo_type = ctype;

   324

				} else {

   325

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

   326

				}

   327

			}

   328

			break;

   329

   330

		case 0x16: /* Weight */

   331

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

   332

			break;

   333

   334

		case 0x17: /* Cost factor */

   335

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

   336

			break;

   337

   338

		case 0x18: /* AI rank */

   339

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

   340

			break;

   341

   342

		case 0x19: /* Engine traction type */

   343

			/* What do the individual numbers mean?

   344

			 * 0x00 .. 0x07: Steam

   345

			 * 0x08 .. 0x27: Diesel

   346

			 * 0x28 .. 0x31: Electric

   347

			 * 0x32 .. 0x37: Monorail

   348

			 * 0x38 .. 0x41: Maglev

   349

			 */

   350

			FOR_EACH_OBJECT {

   351

				uint8 traction = grf_load_byte(&buf);

   352

				int engclass;

   353

   354

				if (traction <= 0x07) {

   355

					engclass = 0;

   356

				} else if (traction <= 0x27) {

   357

					engclass = 1;

   358

				} else if (traction <= 0x31) {

   359

					engclass = 2;

   360

					ei[i].railtype = RAILTYPE_ELECTRIC;

   361

				} else if (traction <= 0x41) {

   362

					engclass = 2;

   363

				} else {

   364

					break;

   365

				}

   366

   367

				rvi[i].engclass = engclass;

   368

			}

   369

			break;

   370

   371

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

   372

			FOR_EACH_OBJECT {

   373

				EngineID pos = grf_load_byte(&buf);

   374

   375

				if (pos < NUM_TRAIN_ENGINES) {

   376

					AlterRailVehListOrder(engine + i, pos);

   377

				} else {

   378

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

   379

				}

   380

			}

   381

			break;

   382

   383

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

   384

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

   385

			break;

   386

   387

		case 0x1D: /* Refit cargo */

   388

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

   389

			break;

   390

   391

		case 0x1E: /* Callback */

   392

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

   393

			break;

   394

   395

		case 0x21: /* Shorter vehicle */

   396

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

   397

			break;

   398

   399

		case 0x22: /* Visual effect */

   400

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

   401

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

   402

			break;

   403

   404

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

   405

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

   406

			break;

   407

   408

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

   409

			FOR_EACH_OBJECT {

   410

				byte weight = grf_load_byte(&buf);

   411

   412

				if (weight > 4) {

   413

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

   414

				} else {

   415

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

   416

				}

   417

			}

   418

			break;

   419

   420

		case 0x27: /* Miscellaneous flags */

   421

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

   422

			break;

   423

   424

		case 0x28: /* Cargo classes allowed */

   425

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

   426

			break;

   427

   428

		case 0x29: /* Cargo classes disallowed */

   429

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

   430

			break;

   431

   432

		/* TODO */

   433

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

   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

			/* TODO */

   440

			FOR_EACH_OBJECT grf_load_byte(&buf);

   441

			ret = true;

   442

			break;

   443

   444

		default:

   445

			ret = true;

   446

			break;

   447

	}

   448

	*bufp = buf;

   449

	return ret;

   450

}

   451

   452

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

   453

{

   454

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

   455

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   456

	byte *buf = *bufp;

   457

	int i;

   458

	bool ret = false;

   459

   460

	switch (prop) {

   461

		case 0x08: /* Speed */

   462

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

   463

			break;

   464

   465

		case 0x09: /* Running cost factor */

   466

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

   467

			break;

   468

   469

		case 0x0A: /* Running cost base */

   470

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

   471

			FOR_EACH_OBJECT grf_load_dword(&buf);

   472

			ret = true;

   473

			break;

   474

   475

		case 0x0E: /* Sprite ID */

   476

			FOR_EACH_OBJECT {

   477

				uint8 spriteid = grf_load_byte(&buf);

   478

   479

				// cars have different custom id in the GRF file

   480

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

   481

   482

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

   483

   484

				rvi[i].image_index = spriteid;

   485

			}

   486

			break;

   487

   488

		case 0x0F: /* Cargo capacity */

   489

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

   490

			break;

   491

   492

		case 0x10: /* Cargo type */

   493

			FOR_EACH_OBJECT {

   494

				uint8 cargo = grf_load_byte(&buf);

   495

   496

				if (cargo < NUM_CARGO) {

   497

					rvi[i].cargo_type = cargo;

   498

				} else {

   499

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

   500

				}

   501

			}