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

#include "helpers.hpp"

    12

    13

#ifndef SPRITE_CACHE_SIZE

    14

# define SPRITE_CACHE_SIZE 2*1024*1024

    15

#endif /* SPRITE_CACHE_SIZE */

    16

    17

    18

typedef struct SpriteCache {

    19

	void *ptr;

    20

	uint32 file_pos;

    21

	int16 lru;

    22

} SpriteCache;

    23

    24

    25

static uint _spritecache_items = 0;

    26

static SpriteCache *_spritecache = NULL;

    27

    28

    29

static inline SpriteCache *GetSpriteCache(uint index)

    30

{

    31

	return &_spritecache[index];

    32

}

    33

    34

    35

static SpriteCache *AllocateSpriteCache(uint index)

    36

{

    37

	if (index >= _spritecache_items) {

    38

		/* Add another 1024 items to the 'pool' */

    39

		uint items = ALIGN(index + 1, 1024);

    40

    41

		DEBUG(sprite, 4, "Increasing sprite cache to %d items (%d bytes)", items, items * sizeof(*_spritecache));

    42

    43

		_spritecache = ReallocT(_spritecache, items);

    44

    45

		if (_spritecache == NULL) {

    46

			error("Unable to allocate sprite cache of %d items (%d bytes)", items, items * sizeof(*_spritecache));

    47

		}

    48

    49

		/* Reset the new items and update the count */

    50

		memset(_spritecache + _spritecache_items, 0, (items - _spritecache_items) * sizeof(*_spritecache));

    51

		_spritecache_items = items;

    52

	}

    53

    54

	return GetSpriteCache(index);

    55

}

    56

    57

    58

typedef struct MemBlock {

    59

	uint32 size;

    60

	byte data[VARARRAY_SIZE];

    61

} MemBlock;

    62

    63

static uint _sprite_lru_counter;

    64

static MemBlock *_spritecache_ptr;

    65

static int _compact_cache_counter;

    66

    67

static void CompactSpriteCache(void);

    68

    69

static bool ReadSpriteHeaderSkipData(void)

    70

{

    71

	uint16 num = FioReadWord();

    72

	byte type;

    73

    74

	if (num == 0) return false;

    75

    76

	type = FioReadByte();

    77

	if (type == 0xFF) {

    78

		FioSkipBytes(num);

    79

		/* Some NewGRF files have "empty" pseudo-sprites which are 1

    80

		 * byte long. Catch these so the sprites won't be displayed. */

    81

		return num != 1;

    82

	}

    83

    84

	FioSkipBytes(7);

    85

	num -= 8;

    86

	if (num == 0) return true;

    87

    88

	if (type & 2) {

    89

		FioSkipBytes(num);

    90

	} else {

    91

		while (num > 0) {

    92

			int8 i = FioReadByte();

    93

			if (i >= 0) {

    94

				num -= i;

    95

				FioSkipBytes(i);

    96

			} else {

    97

				i = -(i >> 3);

    98

				num -= i;

    99

				FioReadByte();

   100

			}

   101

		}

   102

	}

   103

   104

	return true;

   105

}

   106

   107

/* Check if the given Sprite ID exists */

   108

bool SpriteExists(SpriteID id)

   109

{

   110

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

   111

	if (id == 0) return true;

   112

	if (id >= _spritecache_items) return false;

   113

	return GetSpriteCache(id)->file_pos != 0;

   114

}

   115

   116

static void* AllocSprite(size_t);

   117

   118

static void* ReadSprite(SpriteCache *sc, SpriteID id)

   119

{

   120

	uint num;

   121

	byte type;

   122

   123

	DEBUG(sprite, 9, "Load sprite %d", id);

   124

   125

	if (!SpriteExists(id)) {

   131

	}

   132

   133

	FioSeekToFile(sc->file_pos);

   134

   135

	num  = FioReadWord();

   136

	type = FioReadByte();

   137

	if (type == 0xFF) {

   138

		byte* dest = (byte*)AllocSprite(num);

   139

   140

		sc->ptr = dest;

   141

		FioReadBlock(dest, num);

   142

   143

		return dest;

   144

	} else {

   145

		uint height = FioReadByte();

   146

		uint width  = FioReadWord();

   147

		Sprite* sprite;

   148

		byte* dest;

   149

   150

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

   151

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

   152

		sc->ptr = sprite;

   153

		sprite->info   = type;

   154

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

   155

		sprite->width  = width;

   156

		sprite->x_offs = FioReadWord();

   157

		sprite->y_offs = FioReadWord();

   158

   159

		dest = sprite->data;

   160

		while (num > 0) {

   161

			int8 i = FioReadByte();

   162

   163

			if (i >= 0) {

   164

				num -= i;

   165

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

   166

			} else {

   167

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

   168

   169

				i = -(i >> 3);

   170

				num -= i;

   171

   172

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

   173

			}

   174

		}

   175

   176

		return sprite;

   177

	}

   178

}

   179

   180

   181

bool LoadNextSprite(int load_index, byte file_index)

   182

{

   183

	SpriteCache *sc;

   184

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

   185

   186

	if (!ReadSpriteHeaderSkipData()) return false;

   187

   188

	if (load_index >= MAX_SPRITES) {

   189

		error("Tried to load too many sprites (#%d; max %d)", load_index, MAX_SPRITES);

   190

	}

   191

   192

	sc = AllocateSpriteCache(load_index);

   193

	sc->file_pos = file_pos;

   194

	sc->ptr = NULL;

   195

	sc->lru = 0;

   196

   197

	return true;

   198

}

   199

   200

   201

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   202

{

   203

	SpriteCache *scold = GetSpriteCache(old_spr);

   204

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   205

   206

	scnew->file_pos = scold->file_pos;

   207

	scnew->ptr = NULL;

   208

}

   209

   210

   211

void SkipSprites(uint count)

   212

{

   213

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

   214

		if (!ReadSpriteHeaderSkipData()) return;

   215

	}

   216

}

   217

   218

   219

#define S_FREE_MASK 1

   220

   221

static inline MemBlock* NextBlock(MemBlock* block)

   222

{

   223

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

   224

}

   225

   226

static uint32 GetSpriteCacheUsage(void)

   227

{

   228

	uint32 tot_size = 0;

   229

	MemBlock* s;

   230

   231

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

   232

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

   233

   234

	return tot_size;

   235

}

   236

   237

   238

void IncreaseSpriteLRU(void)

   239

{

   240

	// Increase all LRU values

   241

	if (_sprite_lru_counter > 16384) {

   242

		SpriteID i;

   243

   244

		DEBUG(sprite, 3, "Fixing lru %d, inuse=%d", _sprite_lru_counter, GetSpriteCacheUsage());

   245

   246

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

   247

			SpriteCache *sc = GetSpriteCache(i);

   248

			if (sc->ptr != NULL) {

   249

				if (sc->lru >= 0) {

   250

					sc->lru = -1;

   251

				} else if (sc->lru != -32768) {

   252

					sc->lru--;

   253

				}

   254

			}

   255

		}

   256

		_sprite_lru_counter = 0;

   257

	}

   258

   259

	// Compact sprite cache every now and then.

   260

	if (++_compact_cache_counter >= 740) {

   261

		CompactSpriteCache();

   262

		_compact_cache_counter = 0;

   263

	}

   264

}

   265

   266

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

   267

// That is accomplished by moving the cached data.

   268

static void CompactSpriteCache(void)

   269

{

   270

	MemBlock *s;

   271

   272

	DEBUG(sprite, 3, "Compacting sprite cache, inuse=%d", GetSpriteCacheUsage());

   273

   274

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

   275

		if (s->size & S_FREE_MASK) {

   276

			MemBlock* next = NextBlock(s);

   277

			MemBlock temp;

   278

			SpriteID i;

   279

   280

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

   281

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

   282

   283

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

   284

			if (next->size == 0)

   285

				break;

   286

   287

			// Locate the sprite belonging to the next pointer.

   288

			for (i = 0; GetSpriteCache(i)->ptr != next->data; i++) {

   289

				assert(i != _spritecache_items);

   290

			}

   291

   292

			GetSpriteCache(i)->ptr = s->data; // Adjust sprite array entry

   293

			// Swap this and the next block

   294

			temp = *s;

   295

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

   296

			s = NextBlock(s);

   297

			*s = temp;

   298

   299

			// Coalesce free blocks

   300

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

   301

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

   302

			}

   303

		} else {

   304

			s = NextBlock(s);

   305

		}

   306

	}

   307

}

   308

   309

static void DeleteEntryFromSpriteCache(void)

   310

{

   311

	SpriteID i;

   312

	uint best = UINT_MAX;

   313

	MemBlock* s;

   314

	int cur_lru;

   315

   316

	DEBUG(sprite, 3, "DeleteEntryFromSpriteCache, inuse=%d", GetSpriteCacheUsage());

   317

   318

	cur_lru = 0xffff;

   319

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

   320

		SpriteCache *sc = GetSpriteCache(i);

   321

		if (sc->ptr != NULL && sc->lru < cur_lru) {

   322

			cur_lru = sc->lru;

   323

			best = i;

   324

		}

   325

	}

   326

   327

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

   328

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

   329

	if (best == (uint)-1)

   330

		error("Out of sprite memory");

   331

   332

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

   333

	s = (MemBlock*)GetSpriteCache(best)->ptr - 1;

   334

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

   335

	s->size |= S_FREE_MASK;

   336

	GetSpriteCache(best)->ptr = NULL;

   337

   338

	// And coalesce adjacent free blocks

   339

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

   340

		if (s->size & S_FREE_MASK) {

   341

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

   342

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

   343

			}

   344

		}

   345

	}

   346

}

   347

   348

static void* AllocSprite(size_t mem_req)

   349

{

   350

	mem_req += sizeof(MemBlock);

   351

   352

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

   353

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

   354

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

   355

   356

	for (;;) {

   357

		MemBlock* s;

   358

   359

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

   360

			if (s->size & S_FREE_MASK) {

   361

				size_t cur_size = s->size & ~S_FREE_MASK;

   362

   363

				/* Is the block exactly the size we need or

   364

				 * big enough for an additional free block? */

   365

				if (cur_size == mem_req ||

   366

						cur_size >= mem_req + sizeof(MemBlock)) {

   367

					// Set size and in use

   368

					s->size = mem_req;

   369

   370

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

   371

					if (cur_size != mem_req) {

   372

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

   373

					}

   374

   375

					return s->data;

   376

				}

   377

			}

   378

		}

   379

   380

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

   381

		DeleteEntryFromSpriteCache();

   382

	}

   383

}

   384

   385

   386

const void *GetRawSprite(SpriteID sprite)

   387

{

   388

	SpriteCache *sc;

   389

	void* p;

   390

   391

	assert(sprite < _spritecache_items);

   392

   393

	sc = GetSpriteCache(sprite);

   394

   395

	// Update LRU

   396

	sc->lru = ++_sprite_lru_counter;

   397

   398

	p = sc->ptr;

   399

   400

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

   401

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

   402

	return p;

   403

}

   404

   405

   406

void GfxInitSpriteMem(void)

   407

{

   408

	// initialize sprite cache heap

   409

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

   410

   411

	// A big free block

   412

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

   413

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

   414

	NextBlock(_spritecache_ptr)->size = 0;

   415

   416

	/* Reset the spritecache 'pool' */

   417

	free(_spritecache);

   418

	_spritecache_items = 0;

   419

	_spritecache = NULL;

   420

   421

	_compact_cache_counter = 0;

   422

}