1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "macros.h"

     8

#include "spritecache.h"

     9

#include "table/sprites.h"

    10

#include "fileio.h"

    11

    12

#define SPRITE_CACHE_SIZE 1024*1024

    13

    14

#define WANT_NEW_LRU

    15

    16

    17

static void* _sprite_ptr[MAX_SPRITES];

    18

static uint32 _sprite_file_pos[MAX_SPRITES];

    19

    20

#if defined(WANT_NEW_LRU)

    21

static int16 _sprite_lru_new[MAX_SPRITES];

    22

#else

    23

static uint16 _sprite_lru[MAX_SPRITES];

    24

static uint16 _sprite_lru_cur[MAX_SPRITES];

    25

#endif

    26

    27

typedef struct MemBlock {

    28

	uint32 size;

    29

	byte data[VARARRAY_SIZE];

    30

} MemBlock;

    31

    32

static uint _sprite_lru_counter;

    33

static MemBlock *_spritecache_ptr;

    34

static int _compact_cache_counter;

    35

    36

static void CompactSpriteCache(void);

    37

    38

static bool ReadSpriteHeaderSkipData(void)

    39

{

    40

	uint16 num = FioReadWord();

    41

	byte type;

    42

    43

	if (num == 0) return false;

    44

    45

	type = FioReadByte();

    46

	if (type == 0xFF) {

    47

		FioSkipBytes(num);

    48

		return true;

    49

	}

    50

    51

	FioSkipBytes(7);

    52

	num -= 8;

    53

	if (num == 0) return true;

    54

    55

	if (type & 2) {

    56

		FioSkipBytes(num);

    57

	} else {

    58

		while (num > 0) {

    59

			int8 i = FioReadByte();

    60

			if (i >= 0) {

    61

				num -= i;

    62

				FioSkipBytes(i);

    63

			} else {

    64

				i = -(i >> 3);

    65

				num -= i;

    66

				FioReadByte();

    67

			}

    68

		}

    69

	}

    70

    71

	return true;

    72

}

    73

    74

/* Check if the given Sprite ID exists */

    75

bool SpriteExists(SpriteID id)

    76

{

    77

	/* Special case for Sprite ID zero -- its position is also 0... */

    78

	return _sprite_file_pos[id] != 0 || id == 0;

    79

}

    80

    81

static void* AllocSprite(size_t);

    82

    83

static void* ReadSprite(SpriteID id)

    84

{

    85

	uint num;

    86

	byte type;

    87

    88

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

    89

    90

	if (!SpriteExists(id)) {

    91

		error(

    92

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

    93

			"Probable cause: Wrong/missing NewGRFs",

    94

			id

    95

		);

    96

	}

    97

    98

	FioSeekToFile(_sprite_file_pos[id]);

    99

   100

	num  = FioReadWord();

   101

	type = FioReadByte();

   102

	if (type == 0xFF) {

   103

		byte* dest = AllocSprite(num);

   104

   105

		_sprite_ptr[id] = dest;

   106

		FioReadBlock(dest, num);

   107

   108

		return dest;

   109

	} else {

   110

		uint height = FioReadByte();

   111

		uint width  = FioReadWord();

   112

		Sprite* sprite;

   113

		byte* dest;

   114

   115

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

   116

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

   117

		_sprite_ptr[id] = sprite;

   118

		sprite->info   = type;

   119

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

   120

		sprite->width  = width;

   121

		sprite->x_offs = FioReadWord();

   122

		sprite->y_offs = FioReadWord();

   123

   124

		dest = sprite->data;

   125

		while (num > 0) {

   126

			int8 i = FioReadByte();

   127

   128

			if (i >= 0) {

   129

				num -= i;

   130

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

   131

			} else {

   132

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

   133

   134

				i = -(i >> 3);

   135

				num -= i;

   136

   137

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

   138

			}

   139

		}

   140

   141

		return sprite;

   142

	}

   143

}

   144

   145

   146

bool LoadNextSprite(int load_index, byte file_index)

   147

{

   148

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

   149

   150

	if (!ReadSpriteHeaderSkipData()) return false;

   151

   152

	_sprite_file_pos[load_index] = file_pos;

   153

   154

	_sprite_ptr[load_index] = NULL;

   155

   156

#if defined(WANT_NEW_LRU)

   157

	_sprite_lru_new[load_index] = 0;

   158

#else

   159

	_sprite_lru[load_index] = 0xFFFF;

   160

	_sprite_lru_cur[load_index] = 0;

   161

#endif

   162

   163

	return true;

   164

}

   165

   166

   167

void DupSprite(SpriteID old, SpriteID new)

   168

{

   169

	_sprite_file_pos[new] = _sprite_file_pos[old];

   170

	_sprite_ptr[new] = NULL;

   171

}

   172

   173

   174

void SkipSprites(uint count)

   175

{

   176

	for (; count > 0; --count) {

   177

		if (!ReadSpriteHeaderSkipData()) return;

   178

	}

   179

}

   180

   181

   182

#define S_FREE_MASK 1

   183

   184

static inline MemBlock* NextBlock(MemBlock* block)

   185

{

   186

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

   187

}

   188

   189

static uint32 GetSpriteCacheUsage(void)

   190

{

   191

	size_t tot_size = 0;

   192

	MemBlock* s;

   193

   194

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

   195

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

   196

   197

	return tot_size;

   198

}

   199

   200

   201

void IncreaseSpriteLRU(void)

   202

{

   203

	int i;

   204

   205

	// Increase all LRU values

   206

#if defined(WANT_NEW_LRU)

   207

	if (_sprite_lru_counter > 16384) {

   208

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

   209

   210

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

   211

			if (_sprite_ptr[i] != NULL) {

   212

				if (_sprite_lru_new[i] >= 0) {

   213

					_sprite_lru_new[i] = -1;

   214

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

   215

					_sprite_lru_new[i]--;

   216

				}

   217

			}

   218

		_sprite_lru_counter = 0;

   219

	}

   220

#else

   221

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

   222

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

   223

			_sprite_lru[i]++;

   224

	// Reset the lru counter.

   225

	_sprite_lru_counter = 0;

   226

#endif

   227

   228

	// Compact sprite cache every now and then.

   229

	if (++_compact_cache_counter >= 740) {

   230

		CompactSpriteCache();

   231

		_compact_cache_counter = 0;

   232

	}

   233

}

   234

   235

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

   236

// That is accomplished by moving the cached data.

   237

static void CompactSpriteCache(void)

   238

{

   239

	MemBlock *s;

   240

   241

	DEBUG(spritecache, 2) (

   242

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

   243

	);

   244

   245

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

   246

		if (s->size & S_FREE_MASK) {

   247

			MemBlock* next = NextBlock(s);

   248

			MemBlock temp;

   249

			void** i;

   250

   251

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

   252

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

   253

   254

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

   255

			if (next->size == 0)

   256

				break;

   257

   258

			// Locate the sprite belonging to the next pointer.

   259

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

   260

				assert(i != endof(_sprite_ptr));

   261

			}

   262

   263

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

   264

			// Swap this and the next block

   265

			temp = *s;

   266

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

   267

			s = NextBlock(s);

   268

			*s = temp;

   269

   270

			// Coalesce free blocks

   271

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

   272

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

   273

			}

   274

		} else {

   275

			s = NextBlock(s);

   276

		}

   277

	}

   278

}

   279

   280

static void DeleteEntryFromSpriteCache(void)

   281

{

   282

	int i;

   283

	int best = -1;

   284

	MemBlock* s;

   285

	int cur_lru;

   286

   287

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

   288

   289

#if defined(WANT_NEW_LRU)

   290

	cur_lru = 0xffff;

   291

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

   292

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

   293

			cur_lru = _sprite_lru_new[i];

   294

			best = i;

   295

		}

   296

	}

   297

#else

   298

	{

   299

	uint16 cur_lru = 0, cur_lru_cur = 0xffff;

   300

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

   301

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

   302

   303

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

   304

		if (_sprite_lru[i] != cur_lru) {

   305

			cur_lru = _sprite_lru[i];

   306

			best = i;

   307

   308

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

   309

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

   310

			cur_lru_cur = _sprite_lru_cur[i];

   311

			cur_lru = _sprite_lru[i];

   312

			best = i;

   313

		}

   314

	}

   315

	}

   316

#endif

   317

   318

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

   319

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

   320

	if (best == -1)

   321

		error("Out of sprite memory");

   322

   323

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

   324

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

   325

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

   326

	s->size |= S_FREE_MASK;

   327

	_sprite_ptr[best] = NULL;

   328

   329

	// And coalesce adjacent free blocks

   330

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

   331

		if (s->size & S_FREE_MASK) {

   332

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

   333

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

   334

			}

   335

		}

   336

	}

   337

}

   338

   339

static void* AllocSprite(size_t mem_req)

   340

{

   341

	mem_req += sizeof(MemBlock);

   342

   343

	/* Align this to an uint32 boundary. This also makes sure that the 2 least

   344

	 * bits are not used, so we could use those for other things. */

   345

	mem_req = ALIGN(mem_req, sizeof(uint32));

   346

   347

	for (;;) {

   348

		MemBlock* s;

   349

   350

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

   351

			if (s->size & S_FREE_MASK) {

   352

				size_t cur_size = s->size & ~S_FREE_MASK;

   353

   354

				/* Is the block exactly the size we need or

   355

				 * big enough for an additional free block? */

   356

				if (cur_size == mem_req ||

   357

						cur_size >= mem_req + sizeof(MemBlock)) {

   358

					// Set size and in use

   359

					s->size = mem_req;

   360

   361

					// Do we need to inject a free block too?

   362

					if (cur_size != mem_req) {

   363

						NextBlock(s)->size = (cur_size - mem_req) | S_FREE_MASK;

   364

					}

   365

   366

					return s->data;

   367

				}

   368

			}

   369

		}

   370

   371

		// Reached sentinel, but no block found yet. Delete some old entry.

   372

		DeleteEntryFromSpriteCache();

   373

	}

   374

}

   375

   376

#if defined(NEW_ROTATION)

   377

#define X15(x) else if (s >= x && s < (x+15)) { s = _rotate_tile_sprite[s - x] + x; }

   378

#define X19(x) else if (s >= x && s < (x+19)) { s = _rotate_tile_sprite[s - x] + x; }

   379

#define MAP(from,to,map) else if (s >= from && s <= to) { s = map[s - from] + from; }

   380

   381

   382

static uint RotateSprite(uint s)

   383

{

   384

	static const byte _rotate_tile_sprite[19] = { 0,2,4,6,8,10,12,14,1,3,5,7,9,11,13,17,18,16,15 };

   385

	static const byte _coast_map[9] = {0, 4, 3, 1, 2, 6, 8, 5, 7};

   386

	static const byte _fence_map[6] = {1, 0, 5, 4, 3, 2};

   387

   388

	if (0);

   389

	X19(752)

   390

	X15(990-1)

   391

	X19(3924)

   392

	X19(3943)

   393

	X19(3962)

   394

	X19(3981)

   395

	X19(4000)

   396

	X19(4023)

   397

	X19(4042)

   398

	MAP(4061,4069,_coast_map)

   399

	X19(4126)

   400

	X19(4145)

   401

	X19(4164)

   402

	X19(4183)

   403

	X19(4202)

   404

	X19(4221)

   405

	X19(4240)

   406

	X19(4259)

   407

	X19(4259)

   408

	X19(4278)

   409

	MAP(4090, 4095, _fence_map)

   410

	MAP(4096, 4101, _fence_map)

   411

	MAP(4102, 4107, _fence_map)

   412

	MAP(4108, 4113, _fence_map)

   413

	MAP(4114, 4119, _fence_map)

   414

	MAP(4120, 4125, _fence_map)

   415

	return s;

   416

}

   417

#endif

   418

   419

const void *GetRawSprite(SpriteID sprite)

   420

{

   421

	void* p;

   422

   423

	assert(sprite < MAX_SPRITES);

   424

   425

#if defined(NEW_ROTATION)

   426

	sprite = RotateSprite(sprite);

   427

#endif

   428

   429

	// Update LRU

   430

#if defined(WANT_NEW_LRU)

   431

	_sprite_lru_new[sprite] = ++_sprite_lru_counter;

   432

#else

   433

	_sprite_lru_cur[sprite] = ++_sprite_lru_counter;

   434

	_sprite_lru[sprite] = 0;

   435

#endif

   436

   437

	p = _sprite_ptr[sprite];

   438

	// Load the sprite, if it is not loaded, yet

   439

	if (p == NULL) p = ReadSprite(sprite);

   440

	return p;

   441

}

   442

   443

   444

void GfxInitSpriteMem(void)

   445

{

   446

	// initialize sprite cache heap

   447

	if (_spritecache_ptr == NULL) _spritecache_ptr = malloc(SPRITE_CACHE_SIZE);

   448

   449

	// A big free block

   450

	_spritecache_ptr->size = (SPRITE_CACHE_SIZE - sizeof(MemBlock)) | S_FREE_MASK;

   451

	// Sentinel block (identified by size == 0)

   452

	NextBlock(_spritecache_ptr)->size = 0;

   453

   454

	memset(_sprite_ptr, 0, sizeof(_sprite_ptr));

   455

   456

	_compact_cache_counter = 0;

   457

}