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

static void* AllocSprite(size_t);

    75

    76

static void* ReadSprite(SpriteID id)

    77

{

    78

	uint num;

    79

	byte type;

    80

    81

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

    82

    83

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

    84

		error(

    85

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

    86

			"Probable cause: Wrong/missing NewGRFs",

    87

			id

    88

		);

    89

	}

    90

    91

	FioSeekToFile(_sprite_file_pos[id]);

    92

    93

	num  = FioReadWord();

    94

	type = FioReadByte();

    95

	if (type == 0xFF) {

    96

		byte* dest = AllocSprite(num);

    97

    98

		_sprite_ptr[id] = dest;

    99

		FioReadBlock(dest, num);

   100

   101

		return dest;

   102

	} else {

   103

		uint height = FioReadByte();

   104

		uint width  = FioReadWord();

   105

		Sprite* sprite;

   106

		byte* dest;

   107

   108

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

   109

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

   110

		_sprite_ptr[id] = sprite;

   111

		sprite->info   = type;

   112

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

   113

		sprite->width  = width;

   114

		sprite->x_offs = FioReadWord();

   115

		sprite->y_offs = FioReadWord();

   116

   117

		dest = sprite->data;

   118

		while (num > 0) {

   119

			int8 i = FioReadByte();

   120

   121

			if (i >= 0) {

   122

				num -= i;

   123

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

   124

			} else {

   125

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

   126

   127

				i = -(i >> 3);

   128

				num -= i;

   129

   130

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

   131

			}

   132

		}

   133

   134

		return sprite;

   135

	}

   136

}

   137

   138

   139

bool LoadNextSprite(int load_index, byte file_index)

   140

{

   141

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

   142

   143

	if (!ReadSpriteHeaderSkipData()) return false;

   144

   145

	_sprite_file_pos[load_index] = file_pos;

   146

   147

	_sprite_ptr[load_index] = NULL;

   148

   149

#if defined(WANT_NEW_LRU)

   150

	_sprite_lru_new[load_index] = 0;

   151

#else

   152

	_sprite_lru[load_index] = 0xFFFF;

   153

	_sprite_lru_cur[load_index] = 0;

   154

#endif

   155

   156

	return true;

   157

}

   158

   159

   160

void DupSprite(SpriteID old, SpriteID new)

   161

{

   162

	_sprite_file_pos[new] = _sprite_file_pos[old];

   163

	_sprite_ptr[new] = NULL;

   164

}

   165

   166

   167

void SkipSprites(uint count)

   168

{

   169

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

   170

		if (!ReadSpriteHeaderSkipData()) return;

   171

	}

   172

}

   173

   174

   175

#define S_FREE_MASK 1

   176

   177

static inline MemBlock* NextBlock(MemBlock* block)

   178

{

   179

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

   180

}

   181

   182

static uint32 GetSpriteCacheUsage(void)

   183

{

   184

	size_t tot_size = 0;

   185

	MemBlock* s;

   186

   187

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

   188

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

   189

   190

	return tot_size;

   191

}

   192

   193

   194

void IncreaseSpriteLRU(void)

   195

{

   196

	int i;

   197

   198

	// Increase all LRU values

   199

#if defined(WANT_NEW_LRU)

   200

	if (_sprite_lru_counter > 16384) {

   201

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

   202

   203

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

   204

			if (_sprite_ptr[i] != NULL) {

   205

				if (_sprite_lru_new[i] >= 0) {

   206

					_sprite_lru_new[i] = -1;

   207

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

   208

					_sprite_lru_new[i]--;

   209

				}

   210

			}

   211

		_sprite_lru_counter = 0;

   212

	}

   213

#else

   214

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

   215

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

   216

			_sprite_lru[i]++;

   217

	// Reset the lru counter.

   218

	_sprite_lru_counter = 0;

   219

#endif

   220

   221

	// Compact sprite cache every now and then.

   222

	if (++_compact_cache_counter >= 740) {

   223

		CompactSpriteCache();

   224

		_compact_cache_counter = 0;

   225

	}

   226

}

   227

   228

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

   229

// That is accomplished by moving the cached data.

   230

static void CompactSpriteCache(void)

   231

{

   232

	MemBlock *s;

   233

   234

	DEBUG(spritecache, 2) (

   235

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

   236

	);

   237

   238

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

   239

		if (s->size & S_FREE_MASK) {

   240

			MemBlock* next = NextBlock(s);

   241

			MemBlock temp;

   242

			void** i;

   243

   244

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

   245

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

   246

   247

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

   248

			if (next->size == 0)

   249

				break;

   250

   251

			// Locate the sprite belonging to the next pointer.

   252

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

   253

				assert(i != endof(_sprite_ptr));

   254

			}

   255

   256

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

   257

			// Swap this and the next block

   258

			temp = *s;

   259

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

   260

			s = NextBlock(s);

   261

			*s = temp;

   262

   263

			// Coalesce free blocks

   264

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

   265

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

   266

			}

   267

		} else {

   268

			s = NextBlock(s);

   269

		}

   270

	}

   271

}

   272

   273

static void DeleteEntryFromSpriteCache(void)

   274

{

   275

	int i;

   276

	int best = -1;

   277

	MemBlock* s;

   278

	int cur_lru;

   279

   280

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

   281

   282

#if defined(WANT_NEW_LRU)

   283

	cur_lru = 0xffff;

   284

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

   285

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

   286

			cur_lru = _sprite_lru_new[i];

   287

			best = i;

   288

		}

   289

	}

   290

#else

   291

	{

   292

	uint16 cur_lru = 0, cur_lru_cur = 0xffff;

   293

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

   294

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

   295

   296

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

   297

		if (_sprite_lru[i] != cur_lru) {

   298

			cur_lru = _sprite_lru[i];

   299

			best = i;

   300

   301

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

   302

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

   303

			cur_lru_cur = _sprite_lru_cur[i];

   304

			cur_lru = _sprite_lru[i];

   305

			best = i;

   306

		}

   307

	}

   308

	}

   309

#endif

   310

   311

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

   312

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

   313

	if (best == -1)

   314

		error("Out of sprite memory");

   315

   316

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

   317

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

   318

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

   319

	s->size |= S_FREE_MASK;

   320

	_sprite_ptr[best] = NULL;

   321

   322

	// And coalesce adjacent free blocks

   323

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

   324

		if (s->size & S_FREE_MASK) {

   325

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

   326

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

   327

			}

   328

		}

   329

	}

   330

}

   331

   332

static void* AllocSprite(size_t mem_req)

   333

{

   334

	mem_req += sizeof(MemBlock);

   335

   336

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

   337

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

   338

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

   339

   340

	for (;;) {

   341

		MemBlock* s;

   342

   343

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

   344

			if (s->size & S_FREE_MASK) {

   345

				size_t cur_size = s->size & ~S_FREE_MASK;

   346

   347

				/* Is the block exactly the size we need or

   348

				 * big enough for an additional free block? */

   349

				if (cur_size == mem_req ||

   350

						cur_size >= mem_req + sizeof(MemBlock)) {

   351

					// Set size and in use

   352

					s->size = mem_req;

   353

   354

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

   355

					if (cur_size != mem_req) {

   356

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

   357

					}

   358

   359

					return s->data;

   360

				}

   361

			}

   362

		}

   363

   364

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

   365

		DeleteEntryFromSpriteCache();

   366

	}

   367

}

   368

   369

#if defined(NEW_ROTATION)

   370

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

   371

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

   372

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

   373

   374

   375

static uint RotateSprite(uint s)

   376

{

   377

	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 };

   378

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

   379

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

   380

   381

	if (0);

   382

	X19(752)

   383

	X15(990-1)

   384

	X19(3924)

   385

	X19(3943)

   386

	X19(3962)

   387

	X19(3981)

   388

	X19(4000)

   389

	X19(4023)

   390

	X19(4042)

   391

	MAP(4061,4069,_coast_map)

   392

	X19(4126)

   393

	X19(4145)

   394

	X19(4164)

   395

	X19(4183)

   396

	X19(4202)

   397

	X19(4221)

   398

	X19(4240)

   399

	X19(4259)

   400

	X19(4259)

   401

	X19(4278)

   402

	MAP(4090, 4095, _fence_map)

   403

	MAP(4096, 4101, _fence_map)

   404

	MAP(4102, 4107, _fence_map)

   405

	MAP(4108, 4113, _fence_map)

   406

	MAP(4114, 4119, _fence_map)

   407

	MAP(4120, 4125, _fence_map)

   408

	return s;

   409

}

   410

#endif

   411

   412

const void *GetRawSprite(SpriteID sprite)

   413

{

   414

	void* p;

   415

   416

	assert(sprite < MAX_SPRITES);

   417

   418

#if defined(NEW_ROTATION)

   419

	sprite = RotateSprite(sprite);

   420

#endif

   421

   422

	// Update LRU

   423

#if defined(WANT_NEW_LRU)

   424

	_sprite_lru_new[sprite] = ++_sprite_lru_counter;

   425

#else

   426

	_sprite_lru_cur[sprite] = ++_sprite_lru_counter;

   427

	_sprite_lru[sprite] = 0;

   428

#endif

   429

   430

	p = _sprite_ptr[sprite];

   431

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

   432

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

   433

	return p;

   434

}

   435

   436

   437

void GfxInitSpriteMem(void)

   438

{

   439

	// initialize sprite cache heap

   440

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

   441

   442

	// A big free block

   443

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

   444

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

   445

	NextBlock(_spritecache_ptr)->size = 0;

   446

   447

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

   448

   449

	_compact_cache_counter = 0;

   450

}