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

    27

#include "date.h"

    28

#include "currency.h"

    29

#include "sound.h"

    30

#include "newgrf_config.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_spritegroup.h"

    33

    34

/* TTDPatch extended GRF format codec

    35

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

    36

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

    37

 *

    38

 * Contains portions of documentation by TTDPatch team.

    39

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

    40

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

    41

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

    42

    43

    44

static int _skip_sprites; // XXX

    45

static uint _file_index; // XXX

    46

SpriteID _signal_base;

    47

SpriteID _coast_base;

    48

    49

static GRFFile *_cur_grffile;

    50

GRFFile *_first_grffile;

    51

static SpriteID _cur_spriteid;

    52

static GrfLoadingStage _cur_stage;

    53

static uint32 _nfo_line;

    54

    55

static GRFConfig *_cur_grfconfig;

    56

    57

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

    58

static byte _misc_grf_features = 0;

    59

    60

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

    61

static uint32 _ttdpatch_flags[8];

    62

    63

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

    64

static byte *_preload_sprite = NULL;

    65

    66

/* Set if any vehicle is loaded which uses 2cc (two company colours) */

    67

bool _have_2cc = false;

    68

    69

    70

typedef enum GrfDataType {

    71

	GDT_SOUND,

    72

} GrfDataType;

    73

    74

static byte _grf_data_blocks;

    75

static GrfDataType _grf_data_type;

    76

    77

    78

typedef enum grfspec_feature {

    79

	GSF_TRAIN,

    80

	GSF_ROAD,

    81

	GSF_SHIP,

    82

	GSF_AIRCRAFT,

    83

	GSF_STATION,

    84

	GSF_CANAL,

    85

	GSF_BRIDGE,

    86

	GSF_TOWNHOUSE,

    87

	GSF_GLOBALVAR,

    88

	GSF_INDUSTRYTILES,

    89

	GSF_INDUSTRIES,

    90

	GSF_CARGOS,

    91

	GSF_SOUNDFX,

    92

} grfspec_feature;

    93

    94

    95

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

    96

    97

static const int _vehcounts[4] = {

    98

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    99

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   100

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   101

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   102

};

   103

   104

static const int _vehshifts[4] = {

   105

	/* GSF_TRAIN */    0,

   106

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   107

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   108

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   109

};

   110

   111

enum {

   112

	MAX_STATIONS = 256,

   113

};

   114

   115

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   116

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   117

   118

/* Contains the GRF ID of the owner of a vehicle if it has been reserved */

   119

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   120

   121

/* Debugging messages policy:

   122

 *

   123

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

   124

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

   125

 *

   126

 * 0..2 - dedicated to grfmsg()

   127

 * 3

   128

 * 4

   129

 * 5

   130

 * 6 - action handler entry reporting - one per action

   131

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

   132

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

   133

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

   134

 */

   135

   136

   137

typedef enum grfmsg_severity {

   138

	GMS_NOTICE,

   139

	GMS_WARN,

   140

	GMS_ERROR,

   141

	GMS_FATAL,

   142

} grfmsg_severity;

   143

   144

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

   145

{

   146

	static const char* const severitystr[] = {

   147

		"Notice",

   148

		"Warning",

   149

		"Error",

   150

		"Fatal"

   151

	};

   152

	int export_severity = 0;

   153

	char buf[1024];

   154

	va_list va;

   155

   156

	va_start(va, str);

   157

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

   158

	va_end(va);

   159

   160

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

   161

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

   162

}

   163

   164

   165

#define check_length(real, wanted, where) \

   166

do { \

   167

	if (real < wanted) { \

   168

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

   169

		       where, real, wanted); \

   170

		return; \

   171

	} \

   172

} while (0)

   173

   174

   175

static inline byte grf_load_byte(byte **buf)

   176

{

   177

	return *(*buf)++;

   178

}

   179

   180

static uint16 grf_load_word(byte **buf)

   181

{

   182

	uint16 val = grf_load_byte(buf);

   183

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

   184

}

   185

   186

static uint16 grf_load_extended(byte** buf)

   187

{

   188

	uint16 val;

   189

	val = grf_load_byte(buf);

   190

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

   191

	return val;

   192

}

   193

   194

static uint32 grf_load_dword(byte **buf)

   195

{

   196

	uint32 val = grf_load_word(buf);

   197

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

   198

}

   199

   200

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

   201

{

   202

	switch (size) {

   203

		case 1: return grf_load_byte(buf);

   204

		case 2: return grf_load_word(buf);

   205

		case 4: return grf_load_dword(buf);

   206

		default:

   207

			NOT_REACHED();

   208

			return 0;

   209

	}

   210

}

   211

   212

static GRFFile *GetFileByGRFID(uint32 grfid)

   213

{

   214

	GRFFile *file;

   215

   216

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

   217

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

   218

	}

   219

	return file;

   220

}

   221

   222

static GRFFile *GetFileByFilename(const char *filename)

   223

{

   224

	GRFFile *file;

   225

   226

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

   227

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

   228

	}

   229

	return file;

   230

}

   231

   232

   233

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

   234

   235

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

   236

   237

static void dewagonize(int condition, int engine)

   238

{

   239

	EngineInfo *ei = &_engine_info[engine];

   240

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   241

   242

	if (condition != 0) {

   243

		ei->unk2 &= ~0x80;

   244

		rvi->flags &= ~2;

   245

	} else {

   246

		ei->unk2 |= 0x80;

   247

		rvi->flags |= 2;

   248

	}

   249

}

   250

   251

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

   252

{

   253

	EngineInfo *ei = &_engine_info[engine];

   254

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   255

	byte *buf = *bufp;

   256

	int i;

   257

	bool ret = false;

   258

   259

	switch (prop) {

   260

		case 0x05: /* Track type */

   261

			FOR_EACH_OBJECT {

   262

				uint8 tracktype = grf_load_byte(&buf);

   263

   264

				switch (tracktype) {

   265

					case 0: ei[i].railtype = rvi[i].engclass == 2 ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL; break;

   266

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

   267

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

   268

					default:

   269

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

   270

						break;

   271

				}

   272

			}

   273

			break;

   274

   275

		case 0x08: /* AI passenger service */

   276

			/* TODO */

   277

			FOR_EACH_OBJECT grf_load_byte(&buf);

   278

			ret = true;

   279

			break;

   280

   281

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

   282

			FOR_EACH_OBJECT {

   283

				uint16 speed = grf_load_word(&buf);

   284

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

   285

   286

				rvi[i].max_speed = speed;

   287

			}

   288

			break;

   289

   290

		case 0x0B: /* Power */

   291

			FOR_EACH_OBJECT {

   292

				uint16 power = grf_load_word(&buf);

   293

   294

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

   295

   296

				rvi[i].power = power;

   297

				dewagonize(power, engine + i);

   298

			}

   299

			break;

   300

   301

		case 0x0D: /* Running cost factor */

   302

			FOR_EACH_OBJECT {

   303

				uint8 runcostfact = grf_load_byte(&buf);

   304

   305

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

   306

   307

				rvi[i].running_cost_base = runcostfact;

   308

			}

   309

			break;

   310

   311

		case 0x0E: /* Running cost base */

   312

			FOR_EACH_OBJECT {

   313

				uint32 base = grf_load_dword(&buf);

   314

   315

				switch (base) {

   316

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

   317

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

   318

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

   319

				}

   320

			}

   321

			break;

   322

   323

		case 0x12: /* Sprite ID */

   324

			FOR_EACH_OBJECT {

   325

				uint8 spriteid = grf_load_byte(&buf);

   326

   327

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

   328

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

   329

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

   330

   331

				rvi[i].image_index = spriteid;

   332

			}

   333

			break;

   334

   335

		case 0x13: /* Dual-headed */

   336

			FOR_EACH_OBJECT {

   337

				uint8 dual = grf_load_byte(&buf);

   338

   339

				if (dual != 0) {

   340

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

   341

						// adjust power and running cost if needed

   342

						rvi[i].power /= 2;

   343

						rvi[i].running_cost_base /= 2;

   344

					}

   345

					rvi[i].flags |= RVI_MULTIHEAD;

   346

				} else {

   347

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

   348

						// adjust power and running cost if needed

   349

						rvi[i].power *= 2;

   350

						rvi[i].running_cost_base *= 2;

   351

					}

   352

					rvi[i].flags &= ~RVI_MULTIHEAD;

   353

				}

   354

			}

   355

			break;

   356

   357

		case 0x14: /* Cargo capacity */

   358

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

   359

			break;

   360

   361

		case 0x15: /* Cargo type */

   362

			FOR_EACH_OBJECT {

   363

				uint8 ctype = grf_load_byte(&buf);

   364

   365

				if (ctype < NUM_CARGO) {

   366

					rvi[i].cargo_type = ctype;

   367

				} else {

   368

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

   369

				}

   370

			}

   371

			break;

   372

   373

		case 0x16: /* Weight */

   374

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

   375

			break;

   376

   377

		case 0x17: /* Cost factor */

   378

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

   379

			break;

   380

   381

		case 0x18: /* AI rank */

   382

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

   383

			break;

   384

   385

		case 0x19: /* Engine traction type */

   386

			/* What do the individual numbers mean?

   387

			 * 0x00 .. 0x07: Steam

   388

			 * 0x08 .. 0x27: Diesel

   389

			 * 0x28 .. 0x31: Electric

   390

			 * 0x32 .. 0x37: Monorail

   391

			 * 0x38 .. 0x41: Maglev

   392

			 */

   393

			FOR_EACH_OBJECT {

   394

				uint8 traction = grf_load_byte(&buf);

   395

				int engclass;

   396

   397

				if (traction <= 0x07) {

   398

					engclass = 0;

   399

				} else if (traction <= 0x27) {

   400

					engclass = 1;

   401

				} else if (traction <= 0x31) {

   402

					engclass = 2;

   403

				} else if (traction <= 0x41) {

   404

					engclass = 2;

   405

				} else {

   406

					break;

   407

				}

   408

				if (ei[i].railtype == RAILTYPE_RAIL     && engclass == 2) ei[i].railtype = RAILTYPE_ELECTRIC;

   409

				if (ei[i].railtype == RAILTYPE_ELECTRIC && engclass != 2) ei[i].railtype = RAILTYPE_RAIL;

   410

   411

				rvi[i].engclass = engclass;

   412

			}

   413

			break;

   414

   415

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

   416

			FOR_EACH_OBJECT {

   417

				EngineID pos = grf_load_byte(&buf);

   418

   419

				if (pos < NUM_TRAIN_ENGINES) {

   420

					AlterRailVehListOrder(engine + i, pos);

   421

				} else {

   422

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

   423

				}

   424

			}

   425

			break;

   426

   427

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

   428

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

   429

			break;

   430

   431

		case 0x1C: /* Refit cost */

   432

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

   433

			break;

   434

   435

		case 0x1D: /* Refit cargo */

   436

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

   437

			break;

   438

   439

		case 0x1E: /* Callback */

   440

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

   441

			break;

   442

   443

		case 0x21: /* Shorter vehicle */

   444

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

   445

			break;

   446

   447

		case 0x22: /* Visual effect */

   448

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

   449

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

   450

			break;

   451

   452

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

   453

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

   454

			break;

   455

   456

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

   457

			FOR_EACH_OBJECT {

   458

				byte weight = grf_load_byte(&buf);

   459

   460

				if (weight > 4) {

   461

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

   462

				} else {

   463

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

   464

				}

   465

			}

   466

			break;

   467

   468

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

   469

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

   470

			break;

   471

   472

		case 0x27: /* Miscellaneous flags */

   473

			FOR_EACH_OBJECT {

   474

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

   475

				if (HASBIT(ei[i].misc_flags, EF_USES_2CC)) _have_2cc = true;

   476

			}

   477

			break;

   478

   479

		case 0x28: /* Cargo classes allowed */

   480

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

   481

			break;

   482

   483

		case 0x29: /* Cargo classes disallowed */

   484

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

   485

			break;

   486

   487

		case 0x2A: /* Long format introduction date (days since year 0) */

   488

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

   489

			break;

   490

   491

		/* TODO */

   492

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

   493

		case 0x1F: /* Tractive effort */

   494

		case 0x20: /* Air drag */

   495

		case 0x26: /* Retire vehicle early */

   496

			/* TODO */

   497

			FOR_EACH_OBJECT grf_load_byte(&buf);