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

    19

#include "bridge.h"

    20

#include "economy.h"

    21

#include "newgrf_engine.h"

    22

#include "vehicle.h"

    23

    24

#include "newgrf_spritegroup.h"

    25

    26

/* TTDPatch extended GRF format codec

    27

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

    28

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

    29

 *

    30

 * Contains portions of documentation by TTDPatch team.

    31

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

    32

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

    33

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

    34

    35

    36

uint16 _custom_sprites_base;

    37

static int _skip_sprites; // XXX

    38

static uint _file_index; // XXX

    39

extern int _traininfo_vehicle_pitch;

    40

    41

static GRFFile *_cur_grffile;

    42

GRFFile *_first_grffile;

    43

static int _cur_spriteid;

    44

static int _cur_stage;

    45

static uint32 _nfo_line;

    46

    47

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

    48

static uint32 _ttdpatch_flags[8];

    49

    50

    51

typedef enum grfspec_feature {

    52

	GSF_TRAIN,

    53

	GSF_ROAD,

    54

	GSF_SHIP,

    55

	GSF_AIRCRAFT,

    56

	GSF_STATION,

    57

	GSF_CANAL,

    58

	GSF_BRIDGE,

    59

	GSF_TOWNHOUSE,

    60

	GSF_GLOBALVAR,

    61

} grfspec_feature;

    62

    63

    64

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

    65

    66

static const int _vehcounts[4] = {

    67

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    68

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    69

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    70

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    71

};

    72

    73

static const int _vehshifts[4] = {

    74

	/* GSF_TRAIN */    0,

    75

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    76

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    77

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    78

};

    79

    80

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    81

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

    82

    83

/* Debugging messages policy:

    84

 *

    85

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

    86

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

    87

 *

    88

 * 0..2 - dedicated to grfmsg()

    89

 * 3

    90

 * 4

    91

 * 5

    92

 * 6 - action handler entry reporting - one per action

    93

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

    94

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

    95

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

    96

 */

    97

    98

    99

typedef enum grfmsg_severity {

   100

	GMS_NOTICE,

   101

	GMS_WARN,

   102

	GMS_ERROR,

   103

	GMS_FATAL,

   104

} grfmsg_severity;

   105

   106

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

   107

{

   108

	static const char* const severitystr[] = {

   109

		"Notice",

   110

		"Warning",

   111

		"Error",

   112

		"Fatal"

   113

	};

   114

	int export_severity = 0;

   115

	char buf[1024];

   116

	va_list va;

   117

   118

	va_start(va, str);

   119

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

   120

	va_end(va);

   121

   122

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

   123

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

   124

}

   125

   126

   127

#define check_length(real, wanted, where) \

   128

do { \

   129

	if (real < wanted) { \

   130

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

   131

		       where, real, wanted); \

   132

		return; \

   133

	} \

   134

} while (0)

   135

   136

   137

static inline byte grf_load_byte(byte **buf)

   138

{

   139

	return *(*buf)++;

   140

}

   141

   142

static uint16 grf_load_word(byte **buf)

   143

{

   144

	uint16 val;

   145

	byte *p = *buf;

   146

	val = p[0];

   147

	val |= p[1] << 8;

   148

	*buf = p + 2;

   149

	return val;

   150

}

   151

   152

static uint16 grf_load_extended(byte** buf)

   153

{

   154

	uint16 val;

   155

	val = grf_load_byte(buf);

   156

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

   157

	return val;

   158

}

   159

   160

static uint32 grf_load_dword(byte **buf)

   161

{

   162

	uint32 val;

   163

	byte *p = *buf;

   164

	val = p[0];

   165

	val |= p[1] << 8;

   166

	val |= p[2] << 16;

   167

	val |= p[3] << 24;

   168

	*buf = p + 4;

   169

	return val;

   170

}

   171

   172

   173

static GRFFile *GetFileByGRFID(uint32 grfid)

   174

{

   175

	GRFFile *file;

   176

   177

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

   178

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

   179

	}

   180

	return file;

   181

}

   182

   183

static GRFFile *GetFileByFilename(const char *filename)

   184

{

   185

	GRFFile *file;

   186

   187

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

   188

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

   189

	}

   190

	return file;

   191

}

   192

   193

   194

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

   195

   196

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

   197

   198

static void dewagonize(int condition, int engine)

   199

{

   200

	EngineInfo *ei = &_engine_info[engine];

   201

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   202

   203

	if (condition != 0) {

   204

		ei->unk2 &= ~0x80;

   205

		rvi->flags &= ~2;

   206

	} else {

   207

		ei->unk2 |= 0x80;

   208

		rvi->flags |= 2;

   209

	}

   210

}

   211

   212

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

   213

{

   214

	EngineInfo *ei = &_engine_info[engine];

   215

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   216

	byte *buf = *bufp;

   217

	int i;

   218

	bool ret = false;

   219

   220

	switch (prop) {

   221

		case 0x05: /* Track type */

   222

			FOR_EACH_OBJECT {

   223

				uint8 tracktype = grf_load_byte(&buf);

   224

   225

				switch (tracktype) {

   226

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

   227

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

   228

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

   229

					default:

   230

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

   231

						break;

   232

				}

   233

			}

   234

			break;

   235

   236

		case 0x08: /* AI passenger service */

   237

			/* TODO */

   238

			FOR_EACH_OBJECT grf_load_byte(&buf);

   239

			ret = true;

   240

			break;

   241

   242

		case 0x09: /* Speed (1 unit is 1 kmh) */

   243

			FOR_EACH_OBJECT {

   244

				uint16 speed = grf_load_word(&buf);

   245

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

   246

   247

				rvi[i].max_speed = speed;

   248

			}

   249

			break;

   250

   251

		case 0x0B: /* Power */

   252

			FOR_EACH_OBJECT {

   253

				uint16 power = grf_load_word(&buf);

   254

   255

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

   256

   257

				rvi[i].power = power;

   258

				dewagonize(power, engine + i);

   259

			}

   260

			break;

   261

   262

		case 0x0D: /* Running cost factor */

   263

			FOR_EACH_OBJECT {

   264

				uint8 runcostfact = grf_load_byte(&buf);

   265

   266

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

   267

   268

				rvi[i].running_cost_base = runcostfact;

   269

			}

   270

			break;

   271

   272

		case 0x0E: /* Running cost base */

   273

			FOR_EACH_OBJECT {

   274

				uint32 base = grf_load_dword(&buf);

   275

   276

				switch (base) {

   277

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

   278

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

   279

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

   280

				}

   281

			}

   282

			break;

   283

   284

		case 0x12: /* Sprite ID */

   285

			FOR_EACH_OBJECT {

   286

				uint8 spriteid = grf_load_byte(&buf);

   287

   288

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

   289

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

   290

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

   291

   292

				rvi[i].image_index = spriteid;

   293

			}

   294

			break;

   295

   296

		case 0x13: /* Dual-headed */

   297

			FOR_EACH_OBJECT {

   298

				uint8 dual = grf_load_byte(&buf);

   299

   300

				if (dual != 0) {

   301

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

   302

						// adjust power and running cost if needed

   303

						rvi[i].power /= 2;

   304

						rvi[i].running_cost_base /= 2;

   305

					}

   306

					rvi[i].flags |= RVI_MULTIHEAD;

   307

				} else {

   308

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

   309

						// adjust power and running cost if needed

   310

						rvi[i].power *= 2;

   311

						rvi[i].running_cost_base *= 2;

   312

					}

   313

					rvi[i].flags &= ~RVI_MULTIHEAD;

   314

				}

   315

			}

   316

			break;

   317

   318

		case 0x14: /* Cargo capacity */

   319

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

   320

			break;

   321

   322

		case 0x15: /* Cargo type */

   323

			FOR_EACH_OBJECT {

   324

				uint8 ctype = grf_load_byte(&buf);

   325

   326

				if (ctype < NUM_CARGO) {

   327

					rvi[i].cargo_type = ctype;

   328

				} else {

   329

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

   330

				}

   331

			}

   332

			break;

   333

   334

		case 0x16: /* Weight */

   335

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

   336

			break;

   337

   338

		case 0x17: /* Cost factor */

   339

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

   340

			break;

   341

   342

		case 0x18: /* AI rank */

   343

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

   344

			break;

   345

   346

		case 0x19: /* Engine traction type */

   347

			/* What do the individual numbers mean?

   348

			 * 0x00 .. 0x07: Steam

   349

			 * 0x08 .. 0x27: Diesel

   350

			 * 0x28 .. 0x31: Electric

   351

			 * 0x32 .. 0x37: Monorail

   352

			 * 0x38 .. 0x41: Maglev

   353

			 */

   354

			FOR_EACH_OBJECT {

   355

				uint8 traction = grf_load_byte(&buf);

   356

				int engclass;

   357

   358

				if (traction <= 0x07) {

   359

					engclass = 0;

   360

				} else if (traction <= 0x27) {

   361

					engclass = 1;

   362

				} else if (traction <= 0x31) {

   363

					engclass = 2;

   364

					ei[i].railtype = RAILTYPE_ELECTRIC;

   365

				} else if (traction <= 0x41) {

   366

					engclass = 2;

   367

				} else {

   368

					break;

   369

				}

   370

   371

				rvi[i].engclass = engclass;

   372

			}

   373

			break;

   374

   375

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

   376

			FOR_EACH_OBJECT {

   377

				EngineID pos = grf_load_byte(&buf);

   378

   379

				if (pos < NUM_TRAIN_ENGINES) {

   380

					AlterRailVehListOrder(engine + i, pos);

   381

				} else {

   382

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

   383

				}

   384

			}

   385

			break;

   386

   387

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

   388

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

   389

			break;

   390

   391

		case 0x1D: /* Refit cargo */

   392

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

   393

			break;

   394

   395

		case 0x1E: /* Callback */

   396

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

   397

			break;

   398

   399

		case 0x21: /* Shorter vehicle */

   400

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

   401

			break;

   402

   403

		case 0x22: /* Visual effect */

   404

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

   405

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

   406

			break;

   407

   408

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

   409

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

   410

			break;

   411

   412

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

   413

			FOR_EACH_OBJECT {

   414

				byte weight = grf_load_byte(&buf);

   415

   416

				if (weight > 4) {

   417

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

   418

				} else {

   419

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

   420

				}

   421

			}

   422

			break;

   423

   424

		case 0x27: /* Miscellaneous flags */

   425

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

   426

			break;

   427

   428

		case 0x28: /* Cargo classes allowed */

   429

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

   430

			break;

   431

   432

		case 0x29: /* Cargo classes disallowed */

   433

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

   434

			break;

   435

   436

		/* TODO */

   437

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

   438

		case 0x1C: /* Refit cost */

   439

		case 0x1F: /* Tractive effort */

   440

		case 0x20: /* Air drag */

   441

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

   442

		case 0x26: /* Retire vehicle early */

   443

			/* TODO */

   444

			FOR_EACH_OBJECT grf_load_byte(&buf);

   445

			ret = true;

   446

			break;

   447

   448

		default:

   449

			ret = true;

   450

			break;

   451

	}

   452

	*bufp = buf;

   453

	return ret;

   454

}

   455

   456

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

   457

{

   458

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

   459

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   460

	byte *buf = *bufp;

   461

	int i;

   462

	bool ret = false;

   463

   464

	switch (prop) {

   465

		case 0x08: /* Speed (1 unit is 0.5 kmh) */

   466

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

   467

			break;

   468

   469

		case 0x09: /* Running cost factor */

   470

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

   471

			break;

   472

   473

		case 0x0A: /* Running cost base */

   474

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

   475

			FOR_EACH_OBJECT grf_load_dword(&buf);

   476

			ret = true;

   477

			break;

   478

   479

		case 0x0E: /* Sprite ID */

   480

			FOR_EACH_OBJECT {

   481

				uint8 spriteid = grf_load_byte(&buf);

   482

   483

				// cars have different custom id in the GRF file

   484

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

   485

   486

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

   487

   488

				rvi[i].image_index = spriteid;

   489

			}

   490

			break;

   491

   492

		case 0x0F: /* Cargo capacity */