1

#include "stdafx.h"

     2

#include "ttd.h"

     3

#include "debug.h"

     4

#include "gfx.h"

     5

#include "spritecache.h"

     7

#include "fileio.h"

     8

#include "newgrf.h"

     9

#include "md5.h"

    10

#include <ctype.h>

    11

    12

#define SPRITECACHE_ID 0xF00F0006

    13

#define SPRITE_CACHE_SIZE 1024*1024

    14

    15

    16

//#define WANT_SPRITESIZES

    17

#define WANT_NEW_LRU

    18

//#define WANT_LOCKED

    19

    20

    21

/* These are used in newgrf.c: */

    22

    23

int _skip_sprites = 0;

    24

int _replace_sprites_count[16];

    25

int _replace_sprites_offset[16];

    26

    27

static const char *_cur_grffile;

    28

static int _loading_stage;

    29

static int _skip_specials;

    30

uint16 _custom_sprites_base;

    31

static Sprite _cur_sprite;

    32

    33

    34

static byte *_sprite_ptr[NUM_SPRITES];

    35

static uint16 _sprite_size[NUM_SPRITES];

    36

static uint32 _sprite_file_pos[NUM_SPRITES];

    37

    38

// This one is probably not needed.

    39

#if defined(WANT_LOCKED)

    40

static bool _sprite_locked[NUM_SPRITES];

    41

#endif

    42

    43

#if defined(WANT_NEW_LRU)

    44

static int16 _sprite_lru_new[NUM_SPRITES];

    45

#else

    46

static uint16 _sprite_lru[NUM_SPRITES];

    47

static uint16 _sprite_lru_cur[NUM_SPRITES];

    48

#endif

    49

    50

#ifdef WANT_SPRITESIZES

    51

static int8 _sprite_xoffs[NUM_SPRITES];

    52

static int8 _sprite_yoffs[NUM_SPRITES];

    53

static uint16 _sprite_xsize[NUM_SPRITES];

    54

static uint8 _sprite_ysize[NUM_SPRITES];

    55

#endif

    56

    57

typedef struct MemBlock {

    58

	uint32 size;

    59

	byte data[VARARRAY_SIZE];

    60

} MemBlock;

    61

    62

static uint _sprite_lru_counter;

    63

static MemBlock *_spritecache_ptr;

    64

static uint32 _spritecache_size;

    65

static int _compact_cache_counter;

    66

    67

typedef struct MD5File {

    68

	const char * const filename;     // filename

    69

	const md5_byte_t hash[16]; // md5 sum of the file

    70

} MD5File;

    71

    72

typedef struct FileList {

    73

	const MD5File basic[4];     // grf files that always have to be loaded

    74

	const MD5File landscape[3]; // landscape specific grf files

    75

} FileList;

    76

    77

#include "table/files.h"

    78

#include "table/landscape_sprite.h"

    79

    80

static const uint16 * const _landscape_spriteindexes[] = {

    81

	_landscape_spriteindexes_1,

    82

	_landscape_spriteindexes_2,

    83

	_landscape_spriteindexes_3,

    84

};

    85

    86

static const uint16 * const _slopes_spriteindexes[] = {

    87

	_slopes_spriteindexes_0,

    88

	_slopes_spriteindexes_1,

    89

	_slopes_spriteindexes_2,

    90

	_slopes_spriteindexes_3,

    91

};

    92

    93

static void CompactSpriteCache(void);

    94

    95

static void ReadSpriteHeaderSkipData(int num, int load_index)

    96

{

    97

	byte type;

    98

	int deaf = 0;

    99

   100

	if (_skip_sprites) {

   101

		if (_skip_sprites > 0)

   102

			_skip_sprites--;

   103

		deaf = 1;

   104

	}

   105

   106

	type = FioReadByte();

   107

	_cur_sprite.info = type;

   108

	if (type == 0xFF) {

   109

		/* We need to really skip only special sprites in the deaf

   110

		 * mode.  It won't hurt to proceed regular sprites as usual

   111

		 * because if no special sprite referencing to them is

   112

		 * processed, they themselves are never referenced and loaded

   113

		 * on their own. */

   114

		if (_skip_specials || deaf) {

   115

			FioSkipBytes(num);

   116

		} else {

   117

			DecodeSpecialSprite(_cur_grffile, num, load_index, _loading_stage);

   118

		}

   119

		return;

   120

	}

   121

   122

#ifdef WANT_SPRITESIZES

   123

	_cur_sprite.height = FioReadByte();

   124

	_cur_sprite.width = FioReadWord();

   125

	_cur_sprite.x_offs = FioReadWord();

   126

	_cur_sprite.y_offs = FioReadWord();

   127

#else

   128

	FioSkipBytes(7);

   129

#endif

   130

	num -= 8;

   131

	if (num == 0)

   132

		return;

   133

   134

	if (type & 2) {

   135

		FioSkipBytes(num);

   136

	} else {

   137

		while (num > 0) {

   138

			int8 i = FioReadByte();

   139

			if (i >= 0) {

   140

				num -= i;

   141

				FioSkipBytes(i);

   142

			} else {

   143

				i = -(i >> 3);

   144

				num -= i;

   145

				FioReadByte();

   146

			}

   147

		}

   148

	}

   149

}

   150

   151

static void ReadSprite(SpriteID id, void *buffer)

   152

{

   153

	uint num = _sprite_size[id];

   154

	byte type;

   155

	byte* dest;

   156

   157

	FioSeekToFile(_sprite_file_pos[id]);

   158

   159

	type = FioReadByte();

   160

	/* We've decoded special sprites when reading headers. */

   161

	if (type != 0xFF) {

   162

		/* read sprite hdr */

   163

		Sprite* sprite = buffer;

   164

		sprite->info = type;

   165

		sprite->height = FioReadByte();

   166

		if (id == 142) sprite->height = 10; // Compensate for a TTD bug

   167

		sprite->width = FioReadWord();

   168

		sprite->x_offs = FioReadWord();

   169

		sprite->y_offs = FioReadWord();

   170

		dest = sprite->data;

   171

		num -= 8;

   172

	} else {

   173

		dest = buffer;

   174

	}

   175

   176

	if (type & 2) {

   177

		for (; num > 0; --num)

   178

			*dest++ = FioReadByte();

   179

	} else {

   180

		while (num > 0) {

   181

			int8 i = FioReadByte();

   182

   183

			if (i >= 0) {

   184

				num -= i;

   185

				for (; i > 0; --i)

   186

					*dest++ = FioReadByte();

   187

			} else {

   188

				const byte* rel = dest - (((i & 7) << 8) | FioReadByte());

   189

   190

				i = -(i >> 3);

   191

				num -= i;

   192

   193

				for (; i > 0; --i)

   194

					*dest++ = *rel++;

   195

			}

   196

		}

   197

	}

   198

}

   199

   200

   201

static bool LoadNextSprite(int load_index, byte file_index)

   202

{

   203

	uint16 size;

   204

	uint32 file_pos;

   205

   206

	size = FioReadWord();

   207

	if (size == 0)

   208

		return false;

   209

   210

	file_pos = FioGetPos() | (file_index << 24);

   211

   212

	ReadSpriteHeaderSkipData(size, load_index);

   213

   214

	if (_replace_sprites_count[0] > 0 && _cur_sprite.info != 0xFF) {

   215

		int count = _replace_sprites_count[0];

   216

		int offset = _replace_sprites_offset[0];

   217

   218

		_replace_sprites_offset[0]++;

   219

		_replace_sprites_count[0]--;

   220

   221

		if ((offset + count) <= NUM_SPRITES) {

   222

			load_index = offset;

   223

		} else {

   224

			DEBUG(spritecache, 1) ("Sprites to be replaced are out of range: %x+%x",

   225

					count, offset);

   226

			_replace_sprites_offset[0] = 0;

   227

			_replace_sprites_count[0] = 0;

   228

		}

   229

   230

		if (_replace_sprites_count[0] == 0) {

   231

			int i;

   232

   233

			for (i = 0; i < 15; i++) {

   234

				_replace_sprites_count[i] = _replace_sprites_count[i + 1];

   235

				_replace_sprites_offset[i] = _replace_sprites_offset[i + 1];

   236

			}

   237

			_replace_sprites_count[i] = 0;

   238

			_replace_sprites_offset[i] = 0;

   239

		}

   240

	}

   241

   242

	_sprite_size[load_index] = size;

   243

	_sprite_file_pos[load_index] = file_pos;

   244

   245

#ifdef WANT_SPRITESIZES

   246

	_sprite_xsize[load_index] = _cur_sprite.width;

   247

	_sprite_ysize[load_index] = _cur_sprite.height;

   248

   249

	_sprite_xoffs[load_index] = _cur_sprite.x_offs;

   250

	_sprite_yoffs[load_index] = _cur_sprite.y_offs;

   251

#endif

   252

   253

	_sprite_ptr[load_index] = NULL;

   254

#if defined(WANT_LOCKED)

   255

	_sprite_locked[load_index] = false;

   256

#endif

   257

   258

#if defined(WANT_NEW_LRU)

   259

	_sprite_lru_new[load_index] = 0;

   260

#else

   261

	_sprite_lru[load_index] = 0xFFFF;

   262

	_sprite_lru_cur[load_index] = 0;

   263

#endif

   264

   265

	return true;

   266

}

   267

   268

static void SkipSprites(uint count)

   269

{

   270

	for (; count > 0; --count)

   271

	{

   272

		uint16 size = FioReadWord();

   273

   274

		if (size == 0)

   275

			return;

   276

   277

		ReadSpriteHeaderSkipData(size, NUM_SPRITES - 1);

   278

	}

   279

}

   280

   281

static int LoadGrfFile(const char *filename, int load_index, int file_index)

   282

{

   283

	int load_index_org = load_index;

   284

   285

	FioOpenFile(file_index, filename);

   286

   287

	/* Thou shalt use LoadNewGrfFile() if thou loadeth a GRF file that

   288

	 * might contain some special sprites. */

   289

	_skip_specials = 1;

   290

	_skip_sprites = 0;

   291

   292

	DEBUG(spritecache, 2) ("Reading grf-file ``%s''", filename);

   293

   294

	while (LoadNextSprite(load_index, file_index)) {

   295

		load_index++;

   296

		if (load_index >= NUM_SPRITES) {

   297

			error("Too many sprites. Recompile with higher NUM_SPRITES value or remove some custom GRF files.");

   298

		}

   299

	}

   300

   301

	return load_index - load_index_org;

   302

}

   303

   304

static int LoadNewGrfFile(const char *filename, int load_index, int file_index)

   305

{

   306

	int i;

   307

   308

	FioOpenFile(file_index, filename);

   309

	_cur_grffile = filename;

   310

	_skip_specials = 0;

   311

	_skip_sprites = 0;

   312

   313

	DEBUG(spritecache, 2) ("Reading newgrf-file ``%s'' [offset: %u]",

   314

			filename, load_index);

   315

   316

	/* Skip the first sprite; we don't care about how many sprites this

   317

	 * does contain; newest TTDPatches and George's longvehicles don't

   318

	 * neither, apparently. */

   319

	{

   320

		int length;

   321

		byte type;

   322

   323

		length = FioReadWord();

   324

		type = FioReadByte();

   325

   326

		if (length == 4 && type == 0xFF) {

   327

			FioReadDword();

   328

		} else {

   329

			error("Custom .grf has invalid format.");

   330

		}

   331

	}

   332

   333

	for (i = 0; LoadNextSprite(load_index + i, file_index); i++) {

   334

		if (load_index + i >= NUM_SPRITES)

   335

			error("Too many sprites (%x). Recompile with higher NUM_SPRITES value or remove some custom GRF files.",

   336

			      load_index + i);

   337

	}

   338

   339

	/* Clean up. */

   340

	_skip_sprites = 0;

   341

	memset(_replace_sprites_count, 0, 16 * sizeof(*_replace_sprites_count));

   342

	memset(_replace_sprites_offset, 0, 16 * sizeof(*_replace_sprites_offset));

   343

   344

	return i;

   345

}

   346

   347

static void LoadGrfIndexed(const char *filename, const uint16 *index_tbl, int file_index)

   348

{

   349

	int start;

   350

   351

	FioOpenFile(file_index, filename);

   352

	_skip_specials = 1;

   353

	_skip_sprites = 0;

   354

   355

	DEBUG(spritecache, 2) ("Reading indexed grf-file ``%s''", filename);

   356

   357

	for (; (start = *index_tbl++) != 0xffff;) {

   358

		int end = *index_tbl++;

   359

		if(start == 0xfffe) { // skip sprites (amount in second var)

   360

			SkipSprites(end);

   361

		} else { // load sprites and use indexes from start to end

   362

			do {

   363

				bool b = LoadNextSprite(start, file_index);

   364

				assert(b);

   365

			} while (++start <= end);

   366

		}

   367

	}

   368

}

   369

   370

typedef size_t CDECL fread_t(void*, size_t, size_t, FILE*);

   371

   372

static bool HandleCachedSpriteHeaders(const char *filename, bool read)

   373

{

   374

	FILE *f;

   375

	fread_t *proc;

   376

	uint32 hdr;

   377

   378

	if (!_cache_sprites)

   379

		return false;

   380

   381

	if (read) {

   382

		f = fopen(filename, "rb");

   383

		proc = fread;

   384

   385

		if (f == NULL)

   386

			return false;

   387

   388

		proc(&hdr, sizeof(hdr), 1, f);

   389

		if (hdr != SPRITECACHE_ID) {

   390

			fclose(f);

   391

			return false;

   392

		}

   393

	} else {

   394

		f = fopen(filename, "wb");

   395

		proc = (fread_t*) fwrite;

   396

   397

		if (f == NULL)

   398

			return false;

   399

   400

		hdr = SPRITECACHE_ID;

   401

		proc(&hdr, sizeof(hdr), 1, f);

   402

	}

   403

   404

	proc(_sprite_size, 1, sizeof(_sprite_size), f);

   405

	proc(_sprite_file_pos, 1, sizeof(_sprite_file_pos), f);

   406

   407

#if 0

   408

	proc(_sprite_xsize, 1, sizeof(_sprite_xsize), f);

   409

	proc(_sprite_ysize, 1, sizeof(_sprite_ysize), f);

   410

	proc(_sprite_xoffs, 1, sizeof(_sprite_xoffs), f);

   411

	proc(_sprite_yoffs, 1, sizeof(_sprite_yoffs), f);

   412

#endif

   413

   414

#if !defined(WANT_NEW_LRU)

   415

	if (read)

   416

		memset(_sprite_lru, 0xFF, sizeof(_sprite_lru));

   417

#endif

   418

   419

	fclose(f);

   420

	return true;

   421

}

   422

   423

#define S_FREE_MASK 1

   424

   425

static inline MemBlock* NextBlock(MemBlock* block)

   426

{

   427

	return (MemBlock*)((byte*)block + (block->size & ~S_FREE_MASK));

   428

}

   429

   430

static uint32 GetSpriteCacheUsage(void)

   431

{

   432

	size_t tot_size = 0;

   433

	MemBlock* s;

   434

   435

	for (s = _spritecache_ptr; s->size != 0; s = NextBlock(s))

   436

		if (!(s->size & S_FREE_MASK)) tot_size += s->size;

   437

   438

	return tot_size;

   439

}

   440

   441

   442

void IncreaseSpriteLRU(void)

   443

{

   444

	int i;

   445

   446

	// Increase all LRU values

   447

#if defined(WANT_NEW_LRU)

   448

	if (_sprite_lru_counter > 16384) {

   449

		DEBUG(spritecache, 2) ("fixing lru %d, inuse=%d", _sprite_lru_counter, GetSpriteCacheUsage());

   450

   451

		for (i = 0; i != NUM_SPRITES; i++)

   452

			if (_sprite_ptr[i] != NULL) {

   453

				if (_sprite_lru_new[i] >= 0) {

   454

					_sprite_lru_new[i] = -1;

   455

				} else if (_sprite_lru_new[i] != -32768) {

   456

					_sprite_lru_new[i]--;

   457

				}

   458

			}

   459

		_sprite_lru_counter = 0;

   460

	}

   461

#else

   462

	for (i = 0; i != NUM_SPRITES; i++)

   463

		if (_sprite_ptr[i] != NULL && _sprite_lru[i] != 65535)

   464

			_sprite_lru[i]++;

   465

	// Reset the lru counter.

   466

	_sprite_lru_counter = 0;

   467

#endif

   468

   469

	// Compact sprite cache every now and then.

   470

	if (++_compact_cache_counter >= 740) {

   471

		CompactSpriteCache();

   472

		_compact_cache_counter = 0;

   473

	}

   474

}

   475

   476

// Called when holes in the sprite cache should be removed.

   477

// That is accomplished by moving the cached data.

   478

static void CompactSpriteCache(void)

   479

{

   480

	MemBlock *s;

   481

   482

	DEBUG(spritecache, 2) (

   483

		"compacting sprite cache, inuse=%d", GetSpriteCacheUsage()

   484

	);

   485

   486

	for (s = _spritecache_ptr; s->size != 0;) {

   487

		if (s->size & S_FREE_MASK) {

   488

			MemBlock* next = NextBlock(s);

   489

			MemBlock temp;

   490

			byte** i;

   491

   492

			// Since free blocks are automatically coalesced, this should hold true.

   493

			assert(!(next->size & S_FREE_MASK));

   494

   495

			// If the next block is the sentinel block, we can safely return

   496

			if (next->size == 0)

   497

				break;

   498

   499

			// Locate the sprite belonging to the next pointer.

   500

			for (i = _sprite_ptr; *i != next->data; ++i) {

   501

				assert(i != endof(_sprite_ptr));

   502

			}

   503