1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "gfx.h"

     8

#include "spritecache.h"

     9

#include "table/sprites.h"

    10

#include "fileio.h"

    11

#include "newgrf.h"

    12

#include "md5.h"

    13

#include "variables.h"

    14

#include <ctype.h>

    15

    16

#define SPRITE_CACHE_SIZE 1024*1024

    17

    18

#define WANT_NEW_LRU

    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 void* _sprite_ptr[MAX_SPRITES];

    35

static uint32 _sprite_file_pos[MAX_SPRITES];

    36

    37

#if defined(WANT_NEW_LRU)

    38

static int16 _sprite_lru_new[MAX_SPRITES];

    39

#else

    40

static uint16 _sprite_lru[MAX_SPRITES];

    41

static uint16 _sprite_lru_cur[MAX_SPRITES];

    42

#endif

    43

    44

typedef struct MemBlock {

    45

	uint32 size;

    46

	byte data[VARARRAY_SIZE];

    47

} MemBlock;

    48

    49

static uint _sprite_lru_counter;

    50

static MemBlock *_spritecache_ptr;

    51

static int _compact_cache_counter;

    52

    53

typedef struct MD5File {

    54

	const char * const filename;     // filename

    55

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

    56

} MD5File;

    57

    58

typedef struct FileList {

    59

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

    60

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

    61

} FileList;

    62

    63

#include "table/files.h"

    64

#include "table/landscape_sprite.h"

    65

    66

static const SpriteID * const _landscape_spriteindexes[] = {

    67

	_landscape_spriteindexes_1,

    68

	_landscape_spriteindexes_2,

    69

	_landscape_spriteindexes_3,

    70

};

    71

    72

static const SpriteID * const _slopes_spriteindexes[] = {

    73

	_slopes_spriteindexes_0,

    74

	_slopes_spriteindexes_1,

    75

	_slopes_spriteindexes_2,

    76

	_slopes_spriteindexes_3,

    77

};

    78

    79

static void CompactSpriteCache(void);

    80

    82

{

    84

	byte type;

    85

	int deaf = 0;

    86

    89

	if (_skip_sprites) {

    90

		if (_skip_sprites > 0)

    91

			_skip_sprites--;

    92

		deaf = 1;

    93

	}

    94

    95

	type = FioReadByte();

    96

	_cur_sprite.info = type;

    97

	if (type == 0xFF) {

    98

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

    99

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

   100

		 * because if no special sprite referencing to them is

   101

		 * processed, they themselves are never referenced and loaded

   102

		 * on their own. */

   103

		if (_skip_specials || deaf) {

   104

			FioSkipBytes(num);

   105

		} else {

   106

			DecodeSpecialSprite(_cur_grffile, num, load_index, _loading_stage);

   107

		}

   109

	}

   110

   111

	FioSkipBytes(7);

   112

	num -= 8;

   114

   115

	if (type & 2) {

   116

		FioSkipBytes(num);

   117

	} else {

   118

		while (num > 0) {

   119

			int8 i = FioReadByte();

   120

			if (i >= 0) {

   121

				num -= i;

   122

				FioSkipBytes(i);

   123

			} else {

   124

				i = -(i >> 3);

   125

				num -= i;

   126

				FioReadByte();

   127

			}

   128

		}

   129

	}

   132

}

   133

   134

static void* AllocSprite(size_t);

   135

   136

static void* ReadSprite(SpriteID id)

   137

{

   138

	uint num;

   139

	byte type;

   140

   141

	DEBUG(spritecache, 9) ("load sprite %d", id);

   142

   143

	if (_sprite_file_pos[id] == 0 && id != 0) {

   144

		error(

   145

			"Tried to load non-existing sprite #%d.\n"

   146

			"Probable cause: Wrong/missing NewGRFs",

   147

			id

   148

		);

   149

	}

   150

   151

	FioSeekToFile(_sprite_file_pos[id]);

   152

   153

	num  = FioReadWord();

   154

	type = FioReadByte();

   155

	if (type == 0xFF) {

   156

		byte* dest = AllocSprite(num);

   157

   158

		_sprite_ptr[id] = dest;

   159

		FioReadBlock(dest, num);

   160

   161

		return dest;

   162

	} else {

   163

		uint height = FioReadByte();

   164

		uint width  = FioReadWord();

   165

		Sprite* sprite;

   166

		byte* dest;

   167

   168

		num = (type & 0x02) ? width * height : num - 8;

   169

		sprite = AllocSprite(sizeof(*sprite) + num);

   170

		_sprite_ptr[id] = sprite;

   171

		sprite->info   = type;

   172

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

   173

		sprite->width  = width;

   174

		sprite->x_offs = FioReadWord();

   175

		sprite->y_offs = FioReadWord();

   176

   177

		dest = sprite->data;

   178

		while (num > 0) {

   179

			int8 i = FioReadByte();

   180

   181

			if (i >= 0) {

   182

				num -= i;

   183

				for (; i > 0; --i) *dest++ = FioReadByte();

   184

			} else {

   185

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

   186

   187

				i = -(i >> 3);

   188

				num -= i;

   189

   190

				for (; i > 0; --i) *dest++ = *rel++;

   191

			}

   192

		}

   193

   194

		return sprite;

   195

	}

   196

}

   197

   198

   199

static bool LoadNextSprite(int load_index, byte file_index)

   200

{

   201

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

   202

   204

   205

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

   206

		int count = _replace_sprites_count[0];

   207

		int offset = _replace_sprites_offset[0];

   208

   209

		_replace_sprites_offset[0]++;

   210

		_replace_sprites_count[0]--;

   211

   212

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

   213

			load_index = offset;

   214

		} else {

   215

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

   216

					count, offset);

   217

			_replace_sprites_offset[0] = 0;

   218

			_replace_sprites_count[0] = 0;

   219

		}

   220

   221

		if (_replace_sprites_count[0] == 0) {

   222

			int i;

   223

   224

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

   225

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

   226

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

   227

			}

   228

			_replace_sprites_count[i] = 0;

   229

			_replace_sprites_offset[i] = 0;

   230

		}

   231

	}

   232

   233

	_sprite_file_pos[load_index] = file_pos;

   234

   235

	_sprite_ptr[load_index] = NULL;

   236

   237

#if defined(WANT_NEW_LRU)

   238

	_sprite_lru_new[load_index] = 0;

   239

#else

   240

	_sprite_lru[load_index] = 0xFFFF;

   241

	_sprite_lru_cur[load_index] = 0;

   242

#endif

   243

   244

	return true;

   245

}

   246

   247

static void SkipSprites(uint count)

   248

{

   251

	}

   252

}

   253

   254

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

   255

{

   256

	int load_index_org = load_index;

   257

   258

	FioOpenFile(file_index, filename);

   259

   260

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

   261

	 * might contain some special sprites. */

   262

	_skip_specials = 1;

   263

	_skip_sprites = 0;

   264

   265

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

   266

   267

	while (LoadNextSprite(load_index, file_index)) {

   268

		load_index++;

   269

		if (load_index >= MAX_SPRITES) {

   270

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

   271

		}

   272

	}

   273

	DEBUG(spritecache, 2) ("Currently %i sprites are loaded", load_index);

   274

   275

	return load_index - load_index_org;

   276

}

   277

   278

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

   279

{

   280

	int i;

   281

   282

	FioOpenFile(file_index, filename);

   283

	_cur_grffile = filename;

   284

	_skip_specials = 0;

   285

	_skip_sprites = 0;

   286

   287

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

   288

			filename, load_index);

   289

   290

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

   291

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

   292

	 * neither, apparently. */

   293

	{

   294

		int length;

   295

		byte type;

   296

   297

		length = FioReadWord();

   298

		type = FioReadByte();

   299

   300

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

   301

			FioReadDword();

   302

		} else {

   303

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

   304

		}

   305

	}

   306

   307

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

   308

		if (load_index + i >= MAX_SPRITES)

   309

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

   310

			      load_index + i);

   311

	}

   312

   313

	/* Clean up. */

   314

	_skip_sprites = 0;

   315

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

   316

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

   317

   318

	return i;

   319

}

   320

   321

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

   322

{

   323

	int start;

   324

   325

	FioOpenFile(file_index, filename);

   326

	_skip_specials = 1;

   327

	_skip_sprites = 0;

   328

   329

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

   330

   331

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

   332

		int end = *index_tbl++;

   333

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

   334

			SkipSprites(end);

   335

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

   336

			do {

   337

			#ifdef NDEBUG

   338

				LoadNextSprite(start, file_index);

   339

			#else

   340

				bool b = LoadNextSprite(start, file_index);

   341

				assert(b);

   342

			#endif

   343

			} while (++start <= end);

   344

		}

   345

	}

   346

}

   347

   348

   349

#define S_FREE_MASK 1

   350

   351

static inline MemBlock* NextBlock(MemBlock* block)

   352

{

   353

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

   354

}

   355

   356

static uint32 GetSpriteCacheUsage(void)

   357

{

   358

	size_t tot_size = 0;

   359

	MemBlock* s;

   360

   361

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

   362

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

   363

   364

	return tot_size;

   365

}

   366

   367

   368

void IncreaseSpriteLRU(void)

   369

{

   370

	int i;

   371

   372

	// Increase all LRU values

   373

#if defined(WANT_NEW_LRU)

   374

	if (_sprite_lru_counter > 16384) {

   375

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

   376

   377

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

   378

			if (_sprite_ptr[i] != NULL) {

   379

				if (_sprite_lru_new[i] >= 0) {

   380

					_sprite_lru_new[i] = -1;

   381

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

   382

					_sprite_lru_new[i]--;

   383

				}

   384

			}

   385

		_sprite_lru_counter = 0;

   386

	}

   387

#else

   388

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

   389

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

   390

			_sprite_lru[i]++;

   391

	// Reset the lru counter.

   392

	_sprite_lru_counter = 0;

   393

#endif

   394

   395

	// Compact sprite cache every now and then.

   396

	if (++_compact_cache_counter >= 740) {

   397

		CompactSpriteCache();

   398

		_compact_cache_counter = 0;

   399

	}

   400

}

   401

   402

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

   403

// That is accomplished by moving the cached data.

   404

static void CompactSpriteCache(void)

   405

{

   406

	MemBlock *s;

   407

   408

	DEBUG(spritecache, 2) (

   409

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

   410

	);

   411

   412

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

   413

		if (s->size & S_FREE_MASK) {

   414

			MemBlock* next = NextBlock(s);

   415

			MemBlock temp;

   416

			void** i;

   417

   418

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

   419

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

   420

   421

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

   422

			if (next->size == 0)

   423

				break;

   424

   425

			// Locate the sprite belonging to the next pointer.

   426

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

   427

				assert(i != endof(_sprite_ptr));

   428

			}

   429

   430

			*i = s->data; // Adjust sprite array entry

   431

			// Swap this and the next block

   432

			temp = *s;

   433

			memmove(s, next, next->size);

   434

			s = NextBlock(s);

   435

			*s = temp;

   436

   437

			// Coalesce free blocks

   438

			while (NextBlock(s)->size & S_FREE_MASK) {

   439

				s->size += NextBlock(s)->size & ~S_FREE_MASK;

   440

			}

   441

		} else {

   442

			s = NextBlock(s);

   443

		}

   444

	}

   445

}

   446

   447

static void DeleteEntryFromSpriteCache(void)

   448

{

   449

	int i;

   450

	int best = -1;

   451

	MemBlock* s;

   452

	int cur_lru;

   453

   454

	DEBUG(spritecache, 2) ("DeleteEntryFromSpriteCache, inuse=%d", GetSpriteCacheUsage());

   455

   456

#if defined(WANT_NEW_LRU)

   457

	cur_lru = 0xffff;

   458

	for (i = 0; i != MAX_SPRITES; i++) {

   459

		if (_sprite_ptr[i] != NULL && _sprite_lru_new[i] < cur_lru) {

   460

			cur_lru = _sprite_lru_new[i];

   461

			best = i;

   462

		}

   463

	}

   464

#else

   465

	{

   466

	uint16 cur_lru = 0, cur_lru_cur = 0xffff;

   467

	for (i = 0; i != MAX_SPRITES; i++) {

   468

		if (_sprite_ptr[i] == NULL || _sprite_lru[i] < cur_lru) continue;

   469

   470

		// Found a sprite with a higher LRU value, then remember it.

   471

		if (_sprite_lru[i] != cur_lru) {

   472

			cur_lru = _sprite_lru[i];

   473

			best = i;

   474

   475

		// Else if both sprites were very recently referenced, compare by the cur value instead.

   476

		} else if (cur_lru == 0 && _sprite_lru_cur[i] <= cur_lru_cur) {

   477

			cur_lru_cur = _sprite_lru_cur[i];

   478

			cur_lru = _sprite_lru[i];

   479

			best = i;

   480

		}

   481

	}

   482

	}

   483

#endif

   484

   485

	// Display an error message and die, in case we found no sprite at all.

   486

	// This shouldn't really happen, unless all sprites are locked.

   487

	if (best == -1)

   488

		error("Out of sprite memory");

   489

   490

	// Mark the block as free (the block must be in use)

   491

	s = (MemBlock*)_sprite_ptr[best] - 1;

   492

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

   493

	s->size |= S_FREE_MASK;

   494

	_sprite_ptr[best] = NULL;

   495

   496

	// And coalesce adjacent free blocks