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

#define SPRITE_CACHE_SIZE 1024*1024

    14

    15

    16

typedef struct SpriteCache {

    17

	void *ptr;

    18

	uint32 file_pos;

    19

	int16 lru;

    20

} SpriteCache;

    21

    22

    23

static uint _spritecache_items = 0;

    24

static SpriteCache *_spritecache = NULL;

    25

    26

    27

static inline SpriteCache *GetSpriteCache(uint index)

    28

{

    29

	return &_spritecache[index];

    30

}

    31

    32

    33

static SpriteCache *AllocateSpriteCache(uint index)

    34

{

    35

	if (index >= _spritecache_items) {

    36

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

    37

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

    38

    39

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

    40

    41

		ReallocT(&_spritecache, items);

    42

    43

		if (_spritecache == NULL) {

    44

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

    45

		}

    46

    47

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

    48

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

    49

		_spritecache_items = items;

    50

	}

    51

    52

	return GetSpriteCache(index);

    53

}

    54

    55

    56

typedef struct MemBlock {

    57

	uint32 size;

    58

	byte data[VARARRAY_SIZE];

    59

} MemBlock;

    60

    61

static uint _sprite_lru_counter;

    62

static MemBlock *_spritecache_ptr;

    63

static int _compact_cache_counter;

    64

    65

static void CompactSpriteCache(void);

    66

    67

static bool ReadSpriteHeaderSkipData(void)

    68

{

    69

	uint16 num = FioReadWord();

    70

	byte type;

    71

    72

	if (num == 0) return false;

    73

    74

	type = FioReadByte();

    75

	if (type == 0xFF) {

    76

		FioSkipBytes(num);

    77

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

    78

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

    79

		return num != 1;

    80

	}

    81

    82

	FioSkipBytes(7);

    83

	num -= 8;

    84

	if (num == 0) return true;

    85

    86

	if (type & 2) {

    87

		FioSkipBytes(num);

    88

	} else {

    89

		while (num > 0) {

    90

			int8 i = FioReadByte();

    91

			if (i >= 0) {

    92

				num -= i;

    93

				FioSkipBytes(i);

    94

			} else {

    95

				i = -(i >> 3);

    96

				num -= i;

    97

				FioReadByte();

    98

			}

    99

		}

   100

	}

   101

   102

	return true;

   103

}

   104

   105

/* Check if the given Sprite ID exists */

   106

bool SpriteExists(SpriteID id)

   107

{

   108

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

   109

	if (id == 0) return true;

   110

   111

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

   112

}

   113

   114

static void* AllocSprite(size_t);

   115

   116

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

   117

{

   118

	uint num;

   119

	byte type;

   120

   121

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

   122

   123

	if (!SpriteExists(id)) {

   124

		error(

   125

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

   126

			"Probable cause: Wrong/missing NewGRFs",

   127

			id

   128

		);

   129

	}

   130

   131

	FioSeekToFile(sc->file_pos);

   132

   133

	num  = FioReadWord();

   134

	type = FioReadByte();

   135

	if (type == 0xFF) {

   136

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

   137

   138

		sc->ptr = dest;

   139

		FioReadBlock(dest, num);

   140

   141

		return dest;

   142

	} else {

   143

		uint height = FioReadByte();

   144

		uint width  = FioReadWord();

   145

		Sprite* sprite;

   146

		byte* dest;

   147

   148

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

   149

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

   150

		sc->ptr = sprite;

   151

		sprite->info   = type;

   152

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

   153

		sprite->width  = width;

   154

		sprite->x_offs = FioReadWord();

   155

		sprite->y_offs = FioReadWord();

   156

   157

		dest = sprite->data;

   158

		while (num > 0) {

   159

			int8 i = FioReadByte();

   160

   161

			if (i >= 0) {

   162

				num -= i;

   163

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

   164

			} else {

   165

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

   166

   167

				i = -(i >> 3);

   168

				num -= i;

   169

   170

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

   171

			}

   172

		}

   173

   174

		return sprite;

   175

	}

   176

}

   177

   178

   179

bool LoadNextSprite(int load_index, byte file_index)

   180

{

   181

	SpriteCache *sc;

   182

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

   183

   184

	if (!ReadSpriteHeaderSkipData()) return false;

   185

   186

	if (load_index >= MAX_SPRITES) {

   187

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

   188

	}

   189

   190

	sc = AllocateSpriteCache(load_index);

   191

	sc->file_pos = file_pos;

   192

	sc->ptr = NULL;

   193

	sc->lru = 0;

   194

   195

	return true;

   196

}

   197

   198

   199

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   200

{

   201

	SpriteCache *scold = GetSpriteCache(old_spr);

   202

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   203

   204

	scnew->file_pos = scold->file_pos;

   205

	scnew->ptr = NULL;

   206

}

   207

   208

   209

void SkipSprites(uint count)

   210

{

   211

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

   212

		if (!ReadSpriteHeaderSkipData()) return;

   213

	}

   214

}

   215

   216

   217

#define S_FREE_MASK 1

   218

   219

static inline MemBlock* NextBlock(MemBlock* block)

   220

{

   221

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

   222

}

   223

   224

static uint32 GetSpriteCacheUsage(void)

   225

{

   226

	uint32 tot_size = 0;

   227

	MemBlock* s;

   228

   229

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

   230

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

   231

   232

	return tot_size;

   233

}

   234

   235

   236

void IncreaseSpriteLRU(void)

   237

{

   238

	// Increase all LRU values

   239

	if (_sprite_lru_counter > 16384) {

   240

		SpriteID i;

   241

   242

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

   243

   244

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

   245

			SpriteCache *sc = GetSpriteCache(i);

   246

			if (sc->ptr != NULL) {

   247

				if (sc->lru >= 0) {

   248

					sc->lru = -1;

   249

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

   250

					sc->lru--;

   251

				}

   252

			}

   253

		}

   254

		_sprite_lru_counter = 0;

   255

	}

   256

   257

	// Compact sprite cache every now and then.

   258

	if (++_compact_cache_counter >= 740) {

   259

		CompactSpriteCache();

   260

		_compact_cache_counter = 0;

   261

	}

   262

}

   263

   264

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

   265

// That is accomplished by moving the cached data.

   266

static void CompactSpriteCache(void)

   267

{

   268

	MemBlock *s;

   269

   270

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

   271

   272

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

   273

		if (s->size & S_FREE_MASK) {

   274

			MemBlock* next = NextBlock(s);

   275

			MemBlock temp;

   276

			SpriteID i;

   277

   278

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

   279

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

   280

   281

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

   282

			if (next->size == 0)

   283

				break;

   284

   285

			// Locate the sprite belonging to the next pointer.

   286

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

   287

				assert(i != _spritecache_items);

   288

			}

   289

   290

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

   291

			// Swap this and the next block

   292

			temp = *s;

   293

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

   294

			s = NextBlock(s);

   295

			*s = temp;

   296

   297

			// Coalesce free blocks

   298

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

   299

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

   300

			}

   301

		} else {

   302

			s = NextBlock(s);

   303

		}

   304

	}

   305

}

   306

   307

static void DeleteEntryFromSpriteCache(void)

   308

{

   309

	SpriteID i;

   310

	uint best = UINT_MAX;

   311

	MemBlock* s;

   312

	int cur_lru;

   313

   314

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

   315

   316

	cur_lru = 0xffff;

   317

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

   318

		SpriteCache *sc = GetSpriteCache(i);

   319

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

   320

			cur_lru = sc->lru;

   321

			best = i;

   322

		}

   323

	}

   324

   325

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

   326

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

   327

	if (best == (uint)-1)

   328

		error("Out of sprite memory");

   329

   330

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

   331

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

   332

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

   333

	s->size |= S_FREE_MASK;

   334

	GetSpriteCache(best)->ptr = NULL;

   335

   336

	// And coalesce adjacent free blocks

   337

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

   338

		if (s->size & S_FREE_MASK) {

   339

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

   340

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

   341

			}

   342

		}

   343

	}

   344

}

   345

   346

static void* AllocSprite(size_t mem_req)

   347

{

   348

	mem_req += sizeof(MemBlock);

   349

   350

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

   351

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

   352

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

   353

   354

	for (;;) {

   355

		MemBlock* s;

   356

   357

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

   358

			if (s->size & S_FREE_MASK) {

   359

				size_t cur_size = s->size & ~S_FREE_MASK;

   360

   361

				/* Is the block exactly the size we need or

   362

				 * big enough for an additional free block? */

   363

				if (cur_size == mem_req ||

   364

						cur_size >= mem_req + sizeof(MemBlock)) {

   365

					// Set size and in use

   366

					s->size = mem_req;

   367

   368

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

   369

					if (cur_size != mem_req) {

   370

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

   371

					}

   372

   373

					return s->data;

   374

				}

   375

			}

   376

		}

   377

   378

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

   379

		DeleteEntryFromSpriteCache();

   380

	}

   381

}

   382

   383

   384

const void *GetRawSprite(SpriteID sprite)

   385

{

   386

	SpriteCache *sc;

   387

	void* p;

   388

   389

	assert(sprite < MAX_SPRITES);

   390

   391

	sc = GetSpriteCache(sprite);

   392

   393

	// Update LRU

   394

	sc->lru = ++_sprite_lru_counter;

   395

   396

	p = sc->ptr;

   397

   398

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

   399

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

   400

	return p;

   401

}

   402

   403

   404

void GfxInitSpriteMem(void)

   405

{

   406

	// initialize sprite cache heap

   407

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

   408

   409

	// A big free block

   410

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

   411

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

   412

	NextBlock(_spritecache_ptr)->size = 0;

   413

   414

	/* Reset the spritecache 'pool' */

   415

	free(_spritecache);

   416

	_spritecache_items = 0;

   417

	_spritecache = NULL;

   418

   419

	_compact_cache_counter = 0;

   420

}