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 "table/strings.h"

    20

#include "bridge.h"

    21

#include "economy.h"

    22

#include "newgrf_engine.h"

    23

#include "vehicle.h"

    24

#include "newgrf_text.h"

    25

#include "table/sprites.h"

    26

#include "date.h"

    27

#include "currency.h"

    28

#include "newgrf_spritegroup.h"

    29

    30

/* TTDPatch extended GRF format codec

    31

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

    32

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

    33

 *

    34

 * Contains portions of documentation by TTDPatch team.

    35

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

    36

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

    37

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

    38

    39

    40

static int _skip_sprites; // XXX

    41

static uint _file_index; // XXX

    42

SpriteID _signal_base = 0;

    43

    44

static GRFFile *_cur_grffile;

    45

GRFFile *_first_grffile;

    46

GRFConfig *_first_grfconfig;

    47

static SpriteID _cur_spriteid;

    48

static int _cur_stage;

    49

static uint32 _nfo_line;

    50

    51

/* Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E */

    52

static byte _misc_grf_features = 0;

    53

    54

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

    55

static uint32 _ttdpatch_flags[8];

    56

    57

/* Used by Action 0x06 to preload a pseudo sprite and modify its content */

    58

static byte *_preload_sprite = NULL;

    59

    60

    61

typedef enum grfspec_feature {

    62

	GSF_TRAIN,

    63

	GSF_ROAD,

    64

	GSF_SHIP,

    65

	GSF_AIRCRAFT,

    66

	GSF_STATION,

    67

	GSF_CANAL,

    68

	GSF_BRIDGE,

    69

	GSF_TOWNHOUSE,

    70

	GSF_GLOBALVAR,

    71

	GSF_INDUSTRYTILES,

    72

	GSF_INDUSTRIES,

    73

	GSF_CARGOS,

    74

	GSF_SOUNDFX,

    75

} grfspec_feature;

    76

    77

    78

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

    79

    80

static const int _vehcounts[4] = {

    81

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    82

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    83

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    84

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    85

};

    86

    87

static const int _vehshifts[4] = {

    88

	/* GSF_TRAIN */    0,

    89

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

    90

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

    91

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

    92

};

    93

    94

enum {

    95

	MAX_STATIONS = 256,

    96

};

    97

    98

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

    99

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   100

   101

/* Debugging messages policy:

   102

 *

   103

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

   104

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

   105

 *

   106

 * 0..2 - dedicated to grfmsg()

   107

 * 3

   108

 * 4

   109

 * 5

   110

 * 6 - action handler entry reporting - one per action

   111

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

   112

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

   113

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

   114

 */

   115

   116

   117

typedef enum grfmsg_severity {

   118

	GMS_NOTICE,

   119

	GMS_WARN,

   120

	GMS_ERROR,

   121

	GMS_FATAL,

   122

} grfmsg_severity;

   123

   124

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

   125

{

   126

	static const char* const severitystr[] = {

   127

		"Notice",

   128

		"Warning",

   129

		"Error",

   130

		"Fatal"

   131

	};

   132

	int export_severity = 0;

   133

	char buf[1024];

   134

	va_list va;

   135

   136

	va_start(va, str);

   137

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

   138

	va_end(va);

   139

   140

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

   141

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

   142

}

   143

   144

   145

#define check_length(real, wanted, where) \

   146

do { \

   147

	if (real < wanted) { \

   148

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

   149

		       where, real, wanted); \

   150

		return; \

   151

	} \

   152

} while (0)

   153

   154

   155

static inline byte grf_load_byte(byte **buf)

   156

{

   157

	return *(*buf)++;

   158

}

   159

   160

static uint16 grf_load_word(byte **buf)

   161

{

   162

	uint16 val = grf_load_byte(buf);

   163

	return val | (grf_load_byte(buf) << 8);

   164

}

   165

   166

static uint16 grf_load_extended(byte** buf)

   167

{

   168

	uint16 val;

   169

	val = grf_load_byte(buf);

   170

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

   171

	return val;

   172

}

   173

   174

static uint32 grf_load_dword(byte **buf)

   175

{

   176

	uint32 val = grf_load_word(buf);

   177

	return val | (grf_load_word(buf) << 16);

   178

}

   179

   180

static uint32 grf_load_var(byte size, byte **buf)

   181

{

   182

	switch (size) {

   183

		case 1: return grf_load_byte(buf);

   184

		case 2: return grf_load_word(buf);

   185

		case 4: return grf_load_dword(buf);

   186

		default:

   187

			NOT_REACHED();

   188

			return 0;

   189

	}

   190

}

   191

   192

static GRFFile *GetFileByGRFID(uint32 grfid)

   193

{

   194

	GRFFile *file;

   195

   196

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

   197

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

   198

	}

   199

	return file;

   200

}

   201

   202

static GRFFile *GetFileByFilename(const char *filename)

   203

{

   204

	GRFFile *file;

   205

   206

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

   207

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

   208

	}

   209

	return file;

   210

}

   211

   212

   213

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

   214

   215

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

   216

   217

static void dewagonize(int condition, int engine)

   218

{

   219

	EngineInfo *ei = &_engine_info[engine];

   220

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   221

   222

	if (condition != 0) {

   223

		ei->unk2 &= ~0x80;

   224

		rvi->flags &= ~2;

   225

	} else {

   226

		ei->unk2 |= 0x80;

   227

		rvi->flags |= 2;

   228

	}

   229

}

   230

   231

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

   232

{

   233

	EngineInfo *ei = &_engine_info[engine];

   234

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   235

	byte *buf = *bufp;

   236

	int i;

   237

	bool ret = false;

   238

   239

	switch (prop) {

   240

		case 0x05: /* Track type */

   241

			FOR_EACH_OBJECT {

   242

				uint8 tracktype = grf_load_byte(&buf);

   243

   244

				switch (tracktype) {

   245

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

   246

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

   247

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

   248

					default:

   249

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

   250

						break;

   251

				}

   252

			}

   253

			break;

   254

   255

		case 0x08: /* AI passenger service */

   256

			/* TODO */

   257

			FOR_EACH_OBJECT grf_load_byte(&buf);

   258

			ret = true;

   259

			break;

   260

   261

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

   262

			FOR_EACH_OBJECT {

   263

				uint16 speed = grf_load_word(&buf);

   264

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

   265

   266

				rvi[i].max_speed = speed;

   267

			}

   268

			break;

   269

   270

		case 0x0B: /* Power */

   271

			FOR_EACH_OBJECT {

   272

				uint16 power = grf_load_word(&buf);

   273

   274

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

   275

   276

				rvi[i].power = power;

   277

				dewagonize(power, engine + i);

   278

			}

   279

			break;

   280

   281

		case 0x0D: /* Running cost factor */

   282

			FOR_EACH_OBJECT {

   283

				uint8 runcostfact = grf_load_byte(&buf);

   284

   285

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

   286

   287

				rvi[i].running_cost_base = runcostfact;

   288

			}

   289

			break;

   290

   291

		case 0x0E: /* Running cost base */

   292

			FOR_EACH_OBJECT {

   293

				uint32 base = grf_load_dword(&buf);

   294

   295

				switch (base) {

   296

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

   297

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

   298

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

   299

				}

   300

			}

   301

			break;

   302

   303

		case 0x12: /* Sprite ID */

   304

			FOR_EACH_OBJECT {

   305

				uint8 spriteid = grf_load_byte(&buf);

   306

   307

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

   308

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

   309

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

   310

   311

				rvi[i].image_index = spriteid;

   312

			}

   313

			break;

   314

   315

		case 0x13: /* Dual-headed */

   316

			FOR_EACH_OBJECT {

   317

				uint8 dual = grf_load_byte(&buf);

   318

   319

				if (dual != 0) {

   320

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

   321

						// adjust power and running cost if needed

   322

						rvi[i].power /= 2;

   323

						rvi[i].running_cost_base /= 2;

   324

					}

   325

					rvi[i].flags |= RVI_MULTIHEAD;

   326

				} else {

   327

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

   328

						// adjust power and running cost if needed

   329

						rvi[i].power *= 2;

   330

						rvi[i].running_cost_base *= 2;

   331

					}

   332

					rvi[i].flags &= ~RVI_MULTIHEAD;

   333

				}

   334

			}

   335

			break;

   336

   337

		case 0x14: /* Cargo capacity */

   338

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

   339

			break;

   340

   341

		case 0x15: /* Cargo type */

   342

			FOR_EACH_OBJECT {

   343

				uint8 ctype = grf_load_byte(&buf);

   344

   345

				if (ctype < NUM_CARGO) {

   346

					rvi[i].cargo_type = ctype;

   347

				} else {

   348

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

   349

				}

   350

			}

   351

			break;

   352

   353

		case 0x16: /* Weight */

   354

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

   355

			break;

   356

   357

		case 0x17: /* Cost factor */

   358

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

   359

			break;

   360

   361

		case 0x18: /* AI rank */

   362

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

   363

			break;

   364

   365

		case 0x19: /* Engine traction type */

   366

			/* What do the individual numbers mean?

   367

			 * 0x00 .. 0x07: Steam

   368

			 * 0x08 .. 0x27: Diesel

   369

			 * 0x28 .. 0x31: Electric

   370

			 * 0x32 .. 0x37: Monorail

   371

			 * 0x38 .. 0x41: Maglev

   372

			 */

   373

			FOR_EACH_OBJECT {

   374

				uint8 traction = grf_load_byte(&buf);

   375

				int engclass;

   376

   377

				if (traction <= 0x07) {

   378

					engclass = 0;

   379

				} else if (traction <= 0x27) {

   380

					engclass = 1;

   381

				} else if (traction <= 0x31) {

   382

					engclass = 2;

   383

					ei[i].railtype = RAILTYPE_ELECTRIC;

   384

				} else if (traction <= 0x41) {

   385

					engclass = 2;

   386

				} else {

   387

					break;

   388

				}

   389

   390

				rvi[i].engclass = engclass;

   391

			}

   392

			break;

   393

   394

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

   395

			FOR_EACH_OBJECT {

   396

				EngineID pos = grf_load_byte(&buf);

   397

   398

				if (pos < NUM_TRAIN_ENGINES) {

   399

					AlterRailVehListOrder(engine + i, pos);

   400

				} else {

   401

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

   402

				}

   403

			}

   404

			break;

   405

   406

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

   407

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

   408

			break;

   409

   410

		case 0x1C: /* Refit cost */

   411

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

   412

			break;

   413

   414

		case 0x1D: /* Refit cargo */

   415

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

   416

			break;

   417

   418

		case 0x1E: /* Callback */

   419

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

   420

			break;

   421

   422

		case 0x21: /* Shorter vehicle */

   423

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

   424

			break;

   425

   426

		case 0x22: /* Visual effect */

   427

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

   428

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

   429

			break;

   430

   431

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

   432

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

   433

			break;

   434

   435

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

   436

			FOR_EACH_OBJECT {

   437

				byte weight = grf_load_byte(&buf);

   438

   439

				if (weight > 4) {

   440

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

   441

				} else {

   442

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

   443

				}

   444

			}

   445

			break;

   446

   447

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

   448

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

   449

			break;

   450

   451

		case 0x27: /* Miscellaneous flags */

   452

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

   453

			break;

   454

   455

		case 0x28: /* Cargo classes allowed */

   456

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

   457

			break;

   458

   459

		case 0x29: /* Cargo classes disallowed */

   460

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

   461

			break;

   462

   463

		/* TODO */

   464

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

   465

		case 0x1F: /* Tractive effort */

   466

		case 0x20: /* Air drag */

   467

		case 0x26: /* Retire vehicle early */

   468

			/* TODO */

   469

			FOR_EACH_OBJECT grf_load_byte(&buf);

   470

			ret = true;

   471

			break;

   472

   473

		default:

   474

			ret = true;

   475

			break;

   476

	}

   477

	*bufp = buf;

   478

	return ret;

   479

}

   480

   481

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

   482

{

   483

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

   484

	RoadVehicleInfo *rvi = &_road_vehicle_info[engine];

   485

	byte *buf = *bufp;

   486

	int i;

   487

	bool ret = false;

   488

   489

	switch (prop) {

   490

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

   491

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

   492

			break;

   493

   494

		case 0x09: /* Running cost factor */

   495

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

   496

			break;

   497

   498

		case 0x0A: /* Running cost base */

   499