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 GrfLoadingStage {

    67

	GLS_LABELSCAN,

    68

	GLS_INIT,

    69

	GLS_ACTIVATION,

    70

	GLS_END,

    71

} GrfLoadingStage;

    72

    73

    74

typedef enum GrfDataType {

    75

	GDT_SOUND,

    76

} GrfDataType;

    77

    78

static byte _grf_data_blocks;

    79

static GrfDataType _grf_data_type;

    80

    81

    82

typedef enum grfspec_feature {

    83

	GSF_TRAIN,

    84

	GSF_ROAD,

    85

	GSF_SHIP,

    86

	GSF_AIRCRAFT,

    87

	GSF_STATION,

    88

	GSF_CANAL,

    89

	GSF_BRIDGE,

    90

	GSF_TOWNHOUSE,

    91

	GSF_GLOBALVAR,

    92

	GSF_INDUSTRYTILES,

    93

	GSF_INDUSTRIES,

    94

	GSF_CARGOS,

    95

	GSF_SOUNDFX,

    96

} grfspec_feature;

    97

    98

    99

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

   100

   101

static const int _vehcounts[4] = {

   102

	/* GSF_TRAIN */    NUM_TRAIN_ENGINES,

   103

	/* GSF_ROAD */     NUM_ROAD_ENGINES,

   104

	/* GSF_SHIP */     NUM_SHIP_ENGINES,

   105

	/* GSF_AIRCRAFT */ NUM_AIRCRAFT_ENGINES

   106

};

   107

   108

static const int _vehshifts[4] = {

   109

	/* GSF_TRAIN */    0,

   110

	/* GSF_ROAD */     ROAD_ENGINES_INDEX,

   111

	/* GSF_SHIP */     SHIP_ENGINES_INDEX,

   112

	/* GSF_AIRCRAFT */ AIRCRAFT_ENGINES_INDEX,

   113

};

   114

   115

enum {

   116

	MAX_STATIONS = 256,

   117

};

   118

   119

static uint16 cargo_allowed[TOTAL_NUM_ENGINES];

   120

static uint16 cargo_disallowed[TOTAL_NUM_ENGINES];

   121

   122

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

   123

static uint32 _grm_engines[TOTAL_NUM_ENGINES];

   124

   125

/* Debugging messages policy:

   126

 *

   127

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

   128

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

   129

 *

   130

 * 0..2 - dedicated to grfmsg()

   131

 * 3

   132

 * 4

   133

 * 5

   134

 * 6 - action handler entry reporting - one per action

   135

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

   136

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

   137

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

   138

 */

   139

   140

   141

typedef enum grfmsg_severity {

   142

	GMS_NOTICE,

   143

	GMS_WARN,

   144

	GMS_ERROR,

   145

	GMS_FATAL,

   146

} grfmsg_severity;

   147

   148

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

   149

{

   150

	static const char* const severitystr[] = {

   151

		"Notice",

   152

		"Warning",

   153

		"Error",

   154

		"Fatal"

   155

	};

   156

	int export_severity = 0;

   157

	char buf[1024];

   158

	va_list va;

   159

   160

	va_start(va, str);

   161

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

   162

	va_end(va);

   163

   164

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

   165

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

   166

}

   167

   168

   169

#define check_length(real, wanted, where) \

   170

do { \

   171

	if (real < wanted) { \

   172

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

   173

		       where, real, wanted); \

   174

		return; \

   175

	} \

   176

} while (0)

   177

   178

   179

static inline byte grf_load_byte(byte **buf)

   180

{

   181

	return *(*buf)++;

   182

}

   183

   184

static uint16 grf_load_word(byte **buf)

   185

{

   186

	uint16 val = grf_load_byte(buf);

   187

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

   188

}

   189

   190

static uint16 grf_load_extended(byte** buf)

   191

{

   192

	uint16 val;

   193

	val = grf_load_byte(buf);

   194

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

   195

	return val;

   196

}

   197

   198

static uint32 grf_load_dword(byte **buf)

   199

{

   200

	uint32 val = grf_load_word(buf);

   201

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

   202

}

   203

   204

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

   205

{

   206

	switch (size) {

   207

		case 1: return grf_load_byte(buf);

   208

		case 2: return grf_load_word(buf);

   209

		case 4: return grf_load_dword(buf);

   210

		default:

   211

			NOT_REACHED();

   212

			return 0;

   213

	}

   214

}

   215

   216

static GRFFile *GetFileByGRFID(uint32 grfid)

   217

{

   218

	GRFFile *file;

   219

   220

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

   221

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

   222

	}

   223

	return file;

   224

}

   225

   226

static GRFFile *GetFileByFilename(const char *filename)

   227

{

   228

	GRFFile *file;

   229

   230

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

   231

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

   232

	}

   233

	return file;

   234

}

   235

   236

   237

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

   238

   239

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

   240

   241

static void dewagonize(int condition, int engine)

   242

{

   243

	EngineInfo *ei = &_engine_info[engine];

   244

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   245

   246

	if (condition != 0) {

   247

		ei->unk2 &= ~0x80;

   248

		rvi->flags &= ~2;

   249

	} else {

   250

		ei->unk2 |= 0x80;

   251

		rvi->flags |= 2;

   252

	}

   253

}

   254

   255

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

   256

{

   257

	EngineInfo *ei = &_engine_info[engine];

   258

	RailVehicleInfo *rvi = &_rail_vehicle_info[engine];

   259

	byte *buf = *bufp;

   260

	int i;

   261

	bool ret = false;

   262

   263

	switch (prop) {

   264

		case 0x05: /* Track type */

   265

			FOR_EACH_OBJECT {

   266

				uint8 tracktype = grf_load_byte(&buf);

   267

   268

				switch (tracktype) {

   269

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

   270

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

   271

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

   272

					default:

   273

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

   274

						break;

   275

				}

   276

			}

   277

			break;

   278

   279

		case 0x08: /* AI passenger service */

   280

			/* TODO */

   281

			FOR_EACH_OBJECT grf_load_byte(&buf);

   282

			ret = true;

   283

			break;

   284

   285

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

   286

			FOR_EACH_OBJECT {

   287

				uint16 speed = grf_load_word(&buf);

   288

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

   289

   290

				rvi[i].max_speed = speed;

   291

			}

   292

			break;

   293

   294

		case 0x0B: /* Power */

   295

			FOR_EACH_OBJECT {

   296

				uint16 power = grf_load_word(&buf);

   297

   298

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

   299

   300

				rvi[i].power = power;

   301

				dewagonize(power, engine + i);

   302

			}

   303

			break;

   304

   305

		case 0x0D: /* Running cost factor */

   306

			FOR_EACH_OBJECT {

   307

				uint8 runcostfact = grf_load_byte(&buf);

   308

   309

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

   310

   311

				rvi[i].running_cost_base = runcostfact;

   312

			}

   313

			break;

   314

   315

		case 0x0E: /* Running cost base */

   316

			FOR_EACH_OBJECT {

   317

				uint32 base = grf_load_dword(&buf);

   318

   319

				switch (base) {

   320

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

   321

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

   322

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

   323

				}

   324

			}

   325

			break;

   326

   327

		case 0x12: /* Sprite ID */

   328

			FOR_EACH_OBJECT {

   329

				uint8 spriteid = grf_load_byte(&buf);

   330

   331

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

   332

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

   333

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

   334

   335

				rvi[i].image_index = spriteid;

   336

			}

   337

			break;

   338

   339

		case 0x13: /* Dual-headed */

   340

			FOR_EACH_OBJECT {

   341

				uint8 dual = grf_load_byte(&buf);

   342

   343

				if (dual != 0) {

   344

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

   345

						// adjust power and running cost if needed

   346

						rvi[i].power /= 2;

   347

						rvi[i].running_cost_base /= 2;

   348

					}

   349

					rvi[i].flags |= RVI_MULTIHEAD;

   350

				} else {

   351

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

   352

						// adjust power and running cost if needed

   353

						rvi[i].power *= 2;

   354

						rvi[i].running_cost_base *= 2;

   355

					}

   356

					rvi[i].flags &= ~RVI_MULTIHEAD;

   357

				}

   358

			}

   359

			break;

   360

   361

		case 0x14: /* Cargo capacity */

   362

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

   363

			break;

   364

   365

		case 0x15: /* Cargo type */

   366

			FOR_EACH_OBJECT {

   367

				uint8 ctype = grf_load_byte(&buf);

   368

   369

				if (ctype < NUM_CARGO) {

   370

					rvi[i].cargo_type = ctype;

   371

				} else {

   372

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

   373

				}

   374

			}

   375

			break;

   376

   377

		case 0x16: /* Weight */

   378

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

   379

			break;

   380

   381

		case 0x17: /* Cost factor */

   382

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

   383

			break;

   384

   385

		case 0x18: /* AI rank */

   386

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

   387

			break;

   388

   389

		case 0x19: /* Engine traction type */

   390

			/* What do the individual numbers mean?

   391

			 * 0x00 .. 0x07: Steam

   392

			 * 0x08 .. 0x27: Diesel

   393

			 * 0x28 .. 0x31: Electric

   394

			 * 0x32 .. 0x37: Monorail

   395

			 * 0x38 .. 0x41: Maglev

   396

			 */

   397

			FOR_EACH_OBJECT {

   398

				uint8 traction = grf_load_byte(&buf);

   399

				int engclass;

   400

   401

				if (traction <= 0x07) {

   402

					engclass = 0;

   403

				} else if (traction <= 0x27) {

   404

					engclass = 1;

   405

				} else if (traction <= 0x31) {

   406

					engclass = 2;

   407

					ei[i].railtype = RAILTYPE_ELECTRIC;

   408

				} else if (traction <= 0x41) {

   409

					engclass = 2;

   410

				} else {

   411

					break;

   412

				}

   413

   414

				rvi[i].engclass = engclass;

   415

			}

   416

			break;

   417

   418

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

   419

			FOR_EACH_OBJECT {

   420

				EngineID pos = grf_load_byte(&buf);

   421

   422

				if (pos < NUM_TRAIN_ENGINES) {

   423

					AlterRailVehListOrder(engine + i, pos);

   424

				} else {

   425

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

   426

				}

   427

			}

   428

			break;

   429

   430

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

   431

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

   432

			break;

   433

   434

		case 0x1C: /* Refit cost */

   435

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

   436

			break;

   437

   438

		case 0x1D: /* Refit cargo */

   439

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

   440

			break;

   441

   442

		case 0x1E: /* Callback */

   443

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

   444

			break;

   445

   446

		case 0x21: /* Shorter vehicle */

   447

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

   448

			break;

   449

   450

		case 0x22: /* Visual effect */

   451

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

   452

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

   453

			break;

   454

   455

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

   456

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

   457

			break;

   458

   459

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

   460

			FOR_EACH_OBJECT {

   461

				byte weight = grf_load_byte(&buf);

   462

   463

				if (weight > 4) {

   464

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

   465

				} else {

   466

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

   467

				}

   468

			}

   469

			break;

   470

   471

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

   472

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

   473

			break;

   474

   475

		case 0x27: /* Miscellaneous flags */

   476

			FOR_EACH_OBJECT {

   477

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

   478

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

   479

			}

   480

			break;

   481

   482

		case 0x28: /* Cargo classes allowed */

   483

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

   484

			break;

   485

   486

		case 0x29: /* Cargo classes disallowed */

   487

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

   488

			break;

   489

   490

		/* TODO */