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

    29

#include "newgrf_sound.h"

    30

#include "newgrf_spritegroup.h"

    31

    32

/* TTDPatch extended GRF format codec

    33

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

    34

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

    35

 *

    36

 * Contains portions of documentation by TTDPatch team.

    37

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

    38

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

    39

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

    40

    41

    42

static int _skip_sprites; // XXX

    43

static uint _file_index; // XXX

    44

SpriteID _signal_base = 0;

    45

    46

static GRFFile *_cur_grffile;

    47

GRFFile *_first_grffile;

    48

GRFConfig *_first_grfconfig;

    49

static SpriteID _cur_spriteid;

    50

static int _cur_stage;

    51

static uint32 _nfo_line;

    52

    53

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

    54

static byte _misc_grf_features = 0;

    55

    56

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

    57

static uint32 _ttdpatch_flags[8];

    58

    59

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

    60

static byte *_preload_sprite = NULL;

    61

    62

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

    63

bool _have_2cc = false;

    64

    65

    66

typedef enum GrfDataType {

    67

	GDT_SOUND,

    68

} GrfDataType;

    69

    70

static byte _grf_data_blocks;

    71

static GrfDataType _grf_data_type;

    72

    73

    74

typedef enum grfspec_feature {

    75

	GSF_TRAIN,

    76

	GSF_ROAD,

    77

	GSF_SHIP,

    78

	GSF_AIRCRAFT,

    79

	GSF_STATION,

    80

	GSF_CANAL,

    81

	GSF_BRIDGE,

    82

	GSF_TOWNHOUSE,

    83

	GSF_GLOBALVAR,

    84

	GSF_INDUSTRYTILES,

    85

	GSF_INDUSTRIES,

    86

	GSF_CARGOS,

    87

	GSF_SOUNDFX,

    88

} grfspec_feature;

    89

    90

    91

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

    92

    93

static const int _vehcounts[4] = {

    94

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

    95

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

    96

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

    97

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

    98

};

    99

   100

static const int _vehshifts[4] = {

   101

	/* GSF_TRAIN */    0,

   102

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   103

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   104

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   105

};

   106

   107

enum {

   108

	MAX_STATIONS = 256,

   109

};

   110

   111

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   112

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   113

   114

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

   115

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   116

   117

/* Debugging messages policy:

   118

 *

   119

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

   120

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

   121

 *

   122

 * 0..2 - dedicated to grfmsg()

   123

 * 3

   124

 * 4

   125

 * 5

   126

 * 6 - action handler entry reporting - one per action

   127

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

   128

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

   129

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

   130

 */

   131

   132

   133

typedef enum grfmsg_severity {

   134

	GMS_NOTICE,

   135

	GMS_WARN,

   136

	GMS_ERROR,

   137

	GMS_FATAL,

   138

} grfmsg_severity;

   139

   140

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

   141

{

   142

	static const char* const severitystr[] = {

   143

		"Notice",

   144

		"Warning",

   145

		"Error",

   146

		"Fatal"

   147

	};

   148

	int export_severity = 0;

   149

	char buf[1024];

   150

	va_list va;

   151

   152

	va_start(va, str);

   153

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

   154

	va_end(va);

   155

   156

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

   157

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

   158

}

   159

   160

   161

#define check_length(real, wanted, where) \

   162

do { \

   163

	if (real < wanted) { \

   164

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

   165

		       where, real, wanted); \

   166

		return; \

   167

	} \

   168

} while (0)

   169

   170

   171

static inline byte grf_load_byte(byte **buf)

   172

{

   173

	return *(*buf)++;

   174

}

   175

   176

static uint16 grf_load_word(byte **buf)

   177

{

   178

	uint16 val = grf_load_byte(buf);

   179

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

   180

}

   181

   182

static uint16 grf_load_extended(byte** buf)

   183

{

   184

	uint16 val;

   185

	val = grf_load_byte(buf);

   186

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

   187

	return val;

   188

}

   189

   190

static uint32 grf_load_dword(byte **buf)

   191

{

   192

	uint32 val = grf_load_word(buf);

   193

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

   194

}

   195

   196

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

   197

{

   198

	switch (size) {

   199

		case 1: return grf_load_byte(buf);

   200

		case 2: return grf_load_word(buf);

   201

		case 4: return grf_load_dword(buf);

   202

		default:

   203

			NOT_REACHED();

   204

			return 0;

   205

	}

   206

}

   207

   208

static GRFFile *GetFileByGRFID(uint32 grfid)

   209

{

   210

	GRFFile *file;

   211

   212

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

   213

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

   214

	}

   215

	return file;

   216

}

   217

   218

static GRFFile *GetFileByFilename(const char *filename)

   219

{

   220

	GRFFile *file;

   221

   222

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

   223

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

   224

	}

   225

	return file;

   226

}

   227

   228

   229

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

   230

   231

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

   232

   233

static void dewagonize(int condition, int engine)

   234

{

   235

	EngineInfo *ei = &_engine_info[engine];

   236

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   237

   238

	if (condition != 0) {

   239

		ei->unk2 &= ~0x80;

   240

		rvi->flags &= ~2;

   241

	} else {

   242

		ei->unk2 |= 0x80;

   243

		rvi->flags |= 2;

   244

	}

   245

}

   246

   247

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

   248

{

   249

	EngineInfo *ei = &_engine_info[engine];

   250

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   251

	byte *buf = *bufp;

   252

	int i;

   253

	bool ret = false;

   254

   255

	switch (prop) {

   256

		case 0x05: /* Track type */

   257

			FOR_EACH_OBJECT {

   258

				uint8 tracktype = grf_load_byte(&buf);

   259

   260

				switch (tracktype) {

   261

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

   262

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

   263

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

   264

					default:

   265

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

   266

						break;

   267

				}

   268

			}

   269

			break;

   270

   271

		case 0x08: /* AI passenger service */

   272

			/* TODO */

   273

			FOR_EACH_OBJECT grf_load_byte(&buf);

   274

			ret = true;

   275

			break;

   276

   277

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

   278

			FOR_EACH_OBJECT {

   279

				uint16 speed = grf_load_word(&buf);

   280

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

   281

   282

				rvi[i].max_speed = speed;

   283

			}

   284

			break;

   285

   286

		case 0x0B: /* Power */

   287

			FOR_EACH_OBJECT {

   288

				uint16 power = grf_load_word(&buf);

   289

   290

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

   291

   292

				rvi[i].power = power;

   293

				dewagonize(power, engine + i);

   294

			}

   295

			break;

   296

   297

		case 0x0D: /* Running cost factor */

   298

			FOR_EACH_OBJECT {

   299

				uint8 runcostfact = grf_load_byte(&buf);

   300

   301

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

   302

   303

				rvi[i].running_cost_base = runcostfact;

   304

			}

   305

			break;

   306

   307

		case 0x0E: /* Running cost base */

   308

			FOR_EACH_OBJECT {

   309

				uint32 base = grf_load_dword(&buf);

   310

   311

				switch (base) {

   312

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

   313

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

   314

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

   315

				}

   316

			}

   317

			break;

   318

   319

		case 0x12: /* Sprite ID */

   320

			FOR_EACH_OBJECT {

   321

				uint8 spriteid = grf_load_byte(&buf);

   322

   323

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

   324

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

   325

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

   326

   327

				rvi[i].image_index = spriteid;

   328

			}

   329

			break;

   330

   331

		case 0x13: /* Dual-headed */

   332

			FOR_EACH_OBJECT {

   333

				uint8 dual = grf_load_byte(&buf);

   334

   335

				if (dual != 0) {

   336

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

   337

						// adjust power and running cost if needed

   338

						rvi[i].power /= 2;

   339

						rvi[i].running_cost_base /= 2;

   340

					}

   341

					rvi[i].flags |= RVI_MULTIHEAD;

   342

				} else {

   343

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

   344

						// adjust power and running cost if needed

   345

						rvi[i].power *= 2;

   346

						rvi[i].running_cost_base *= 2;

   347

					}

   348

					rvi[i].flags &= ~RVI_MULTIHEAD;

   349

				}

   350

			}

   351

			break;

   352

   353

		case 0x14: /* Cargo capacity */

   354

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

   355

			break;

   356

   357

		case 0x15: /* Cargo type */

   358

			FOR_EACH_OBJECT {

   359

				uint8 ctype = grf_load_byte(&buf);

   360

   361

				if (ctype < NUM_CARGO) {

   362

					rvi[i].cargo_type = ctype;

   363

				} else {

   364

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

   365

				}

   366

			}

   367

			break;

   368

   369

		case 0x16: /* Weight */

   370

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

   371

			break;

   372

   373

		case 0x17: /* Cost factor */

   374

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

   375

			break;

   376

   377

		case 0x18: /* AI rank */

   378

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

   379

			break;

   380

   381

		case 0x19: /* Engine traction type */

   382

			/* What do the individual numbers mean?

   383

			 * 0x00 .. 0x07: Steam

   384

			 * 0x08 .. 0x27: Diesel

   385

			 * 0x28 .. 0x31: Electric

   386

			 * 0x32 .. 0x37: Monorail

   387

			 * 0x38 .. 0x41: Maglev

   388

			 */

   389

			FOR_EACH_OBJECT {

   390

				uint8 traction = grf_load_byte(&buf);

   391

				int engclass;

   392

   393

				if (traction <= 0x07) {

   394

					engclass = 0;

   395

				} else if (traction <= 0x27) {

   396

					engclass = 1;

   397

				} else if (traction <= 0x31) {

   398

					engclass = 2;

   399

					ei[i].railtype = RAILTYPE_ELECTRIC;

   400

				} else if (traction <= 0x41) {

   401

					engclass = 2;

   402

				} else {

   403

					break;

   404

				}

   405

   406

				rvi[i].engclass = engclass;

   407

			}

   408

			break;

   409

   410

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

   411

			FOR_EACH_OBJECT {

   412

				EngineID pos = grf_load_byte(&buf);

   413

   414

				if (pos < NUM_TRAIN_ENGINES) {

   415

					AlterRailVehListOrder(engine + i, pos);

   416

				} else {

   417

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

   418

				}

   419

			}

   420

			break;

   421

   422

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

   423

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

   424

			break;

   425

   426

		case 0x1C: /* Refit cost */

   427

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

   428

			break;

   429

   430

		case 0x1D: /* Refit cargo */

   431

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

   432

			break;

   433

   434

		case 0x1E: /* Callback */

   435

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

   436

			break;

   437

   438

		case 0x21: /* Shorter vehicle */

   439

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

   440

			break;

   441

   442

		case 0x22: /* Visual effect */

   443

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

   444

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

   445

			break;

   446

   447

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

   448

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

   449

			break;

   450

   451

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

   452

			FOR_EACH_OBJECT {

   453

				byte weight = grf_load_byte(&buf);

   454

   455

				if (weight > 4) {

   456

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

   457

				} else {

   458

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

   459

				}

   460

			}

   461

			break;

   462

   463

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

   464

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

   465

			break;

   466

   467

		case 0x27: /* Miscellaneous flags */

   468

			FOR_EACH_OBJECT {

   469

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

   470

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

   471

			}

   472

			break;

   473

   474

		case 0x28: /* Cargo classes allowed */

   475

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

   476

			break;

   477

   478

		case 0x29: /* Cargo classes disallowed */

   479

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

   480

			break;

   481

   482

		/* TODO */

   483

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

   484

		case 0x1F: /* Tractive effort */

   485

		case 0x20: /* Air drag */

   486

		case 0x26: /* Retire vehicle early */

   487

			/* TODO */

   488

			FOR_EACH_OBJECT grf_load_byte(&buf);

   489

			ret = true;

   490

			break;