1

/* $Id$ */

     2

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "macros.h"

    10

#include "spritecache.h"

    11

#include "table/sprites.h"

    12

#include "fileio.h"

    13

#include "helpers.hpp"

    14

    15

#ifndef SPRITE_CACHE_SIZE

    16

# define SPRITE_CACHE_SIZE 2*1024*1024

    17

#endif /* SPRITE_CACHE_SIZE */

    18

    19

    20

struct SpriteCache {

    21

	void *ptr;

    22

	uint32 file_pos;

    23

	int16 lru;

    24

};

    25

    26

    27

static uint _spritecache_items = 0;

    28

static SpriteCache *_spritecache = NULL;

    29

    30

    31

static inline SpriteCache *GetSpriteCache(uint index)

    32

{

    33

	return &_spritecache[index];

    34

}

    35

    36

    37

static SpriteCache *AllocateSpriteCache(uint index)

    38

{

    39

	if (index >= _spritecache_items) {

    40

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

    41

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

    42

    43

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

    44

    45

		_spritecache = ReallocT(_spritecache, items);

    46

    47

		if (_spritecache == NULL) {

    48

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

    49

		}

    50

    51

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

    52

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

    53

		_spritecache_items = items;

    54

	}

    55

    56

	return GetSpriteCache(index);

    57

}

    58

    59

    60

struct MemBlock {

    61

	uint32 size;

    62

	byte data[VARARRAY_SIZE];

    63

};

    64

    65

static uint _sprite_lru_counter;

    66

static MemBlock *_spritecache_ptr;

    67

static int _compact_cache_counter;

    68

    69

static void CompactSpriteCache();

    70

    71

static bool ReadSpriteHeaderSkipData()

    72

{

    73

	uint16 num = FioReadWord();

    74

	byte type;

    75

    76

	if (num == 0) return false;

    77

    78

	type = FioReadByte();

    79

	if (type == 0xFF) {

    80

		FioSkipBytes(num);

    81

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

    82

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

    83

		return num != 1;

    84

	}

    85

    86

	FioSkipBytes(7);

    87

	num -= 8;

    88

	if (num == 0) return true;

    89

    90

	if (type & 2) {

    91

		FioSkipBytes(num);

    92

	} else {

    93

		while (num > 0) {

    94

			int8 i = FioReadByte();

    95

			if (i >= 0) {

    96

				num -= i;

    97

				FioSkipBytes(i);

    98

			} else {

    99

				i = -(i >> 3);

   100

				num -= i;

   101

				FioReadByte();

   102

			}

   103

		}

   104

	}

   105

   106

	return true;

   107

}

   108

   109

/* Check if the given Sprite ID exists */

   110

bool SpriteExists(SpriteID id)

   111

{

   112

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

   113

	if (id == 0) return true;

   114

	if (id >= _spritecache_items) return false;

   115

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

   116

}

   117

   118

static void* AllocSprite(size_t);

   119

   120

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

   121

{

   122

	uint num;

   123

	byte type;

   124

   125

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

   126

   127

	if (!SpriteExists(id)) {

   128

		DEBUG(sprite, 1, "Tried to load non-existing sprite #%d. Probable cause: Wrong/missing NewGRFs", id);

   129

   130

		/* SPR_IMG_QUERY is a BIG FAT RED ? */

   131

		id = SPR_IMG_QUERY;

   132

		sc = GetSpriteCache(SPR_IMG_QUERY);

   133

	}

   134

   135

	FioSeekToFile(sc->file_pos);

   136

   137

	num  = FioReadWord();

   138

	type = FioReadByte();

   139

	if (type == 0xFF) {

   140

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

   141

   142

		sc->ptr = dest;

   143

		FioReadBlock(dest, num);

   144

   145

		return dest;

   146

	} else {

   147

		uint height = FioReadByte();

   148

		uint width  = FioReadWord();

   149

		Sprite* sprite;

   150

		byte* dest;

   151

   152

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

   153

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

   154

		sc->ptr = sprite;

   155

		sprite->info   = type;

   156

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

   157

		sprite->width  = width;

   158

		sprite->x_offs = FioReadWord();

   159

		sprite->y_offs = FioReadWord();

   160

   161

		dest = sprite->data;

   162

		while (num > 0) {

   163

			int8 i = FioReadByte();

   164

   165

			if (i >= 0) {

   166

				num -= i;

   167

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

   168

			} else {

   169

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

   170

   171

				i = -(i >> 3);

   172

				num -= i;

   173

   174

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

   175

			}

   176

		}

   177

   178

		return sprite;

   179

	}

   180

}

   181

   182

   183

bool LoadNextSprite(int load_index, byte file_index)

   184

{

   185

	SpriteCache *sc;

   186

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

   187

   188

	if (!ReadSpriteHeaderSkipData()) return false;

   189

   190

	if (load_index >= MAX_SPRITES) {

   191

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

   192

	}

   193

   194

	sc = AllocateSpriteCache(load_index);

   195

	sc->file_pos = file_pos;

   196

	sc->ptr = NULL;

   197

	sc->lru = 0;

   198

   199

	return true;

   200

}

   201

   202

   203

void DupSprite(SpriteID old_spr, SpriteID new_spr)

   204

{

   205

	SpriteCache *scold = GetSpriteCache(old_spr);

   206

	SpriteCache *scnew = AllocateSpriteCache(new_spr);

   207

   208

	scnew->file_pos = scold->file_pos;

   209

	scnew->ptr = NULL;

   210

}

   211

   212

   213

void SkipSprites(uint count)

   214

{

   215

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

   216

		if (!ReadSpriteHeaderSkipData()) return;

   217

	}

   218

}

   219

   220

   221

#define S_FREE_MASK 1

   222

   223

static inline MemBlock* NextBlock(MemBlock* block)

   224

{

   225

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

   226

}

   227

   228

static uint32 GetSpriteCacheUsage()

   229

{

   230

	uint32 tot_size = 0;

   231

	MemBlock* s;

   232

   233

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

   234

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

   235

   236

	return tot_size;

   237

}

   238

   239

   240

void IncreaseSpriteLRU()

   241

{

   242

	/* Increase all LRU values */

   243

	if (_sprite_lru_counter > 16384) {

   244

		SpriteID i;

   245

   246

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

   247

   248

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

   249

			SpriteCache *sc = GetSpriteCache(i);

   250

			if (sc->ptr != NULL) {

   251

				if (sc->lru >= 0) {

   252

					sc->lru = -1;

   253

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

   254

					sc->lru--;

   255

				}

   256

			}

   257

		}

   258

		_sprite_lru_counter = 0;

   259

	}

   260

   261

	/* Compact sprite cache every now and then. */

   262

	if (++_compact_cache_counter >= 740) {

   263

		CompactSpriteCache();

   264

		_compact_cache_counter = 0;

   265

	}

   266

}

   267

   268

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

   269

 * That is accomplished by moving the cached data. */

   270

static void CompactSpriteCache()

   271

{

   272

	MemBlock *s;

   273

   274

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

   275

   276

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

   277

		if (s->size & S_FREE_MASK) {

   278

			MemBlock* next = NextBlock(s);

   279

			MemBlock temp;

   280

			SpriteID i;

   281

   282

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

   283

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

   284

   285

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

   286

			if (next->size == 0)

   287

				break;

   288

   289

			/* Locate the sprite belonging to the next pointer. */

   290

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

   291

				assert(i != _spritecache_items);

   292

			}

   293

   294

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

   295

			/* Swap this and the next block */

   296

			temp = *s;

   297

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

   298

			s = NextBlock(s);

   299

			*s = temp;

   300

   301

			/* Coalesce free blocks */

   302

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

   303

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

   304

			}

   305

		} else {

   306

			s = NextBlock(s);

   307

		}

   308

	}

   309

}

   310

   311

static void DeleteEntryFromSpriteCache()

   312

{

   313

	SpriteID i;

   314

	uint best = UINT_MAX;

   315

	MemBlock* s;

   316

	int cur_lru;

   317

   318

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

   319

   320

	cur_lru = 0xffff;

   321

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

   322

		SpriteCache *sc = GetSpriteCache(i);

   323

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

   324

			cur_lru = sc->lru;

   325

			best = i;

   326

		}

   327

	}

   328

   329

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

   330

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

   331

	if (best == (uint)-1)

   332

		error("Out of sprite memory");

   333

   334

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

   335

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

   336

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

   337

	s->size |= S_FREE_MASK;

   338

	GetSpriteCache(best)->ptr = NULL;

   339

   340

	/* And coalesce adjacent free blocks */

   341

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

   342

		if (s->size & S_FREE_MASK) {

   343

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

   344

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

   345

			}

   346

		}

   347

	}

   348

}

   349

   350

static void* AllocSprite(size_t mem_req)

   351

{

   352

	mem_req += sizeof(MemBlock);

   353

   354

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

   355

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

   356

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

   357

   358

	for (;;) {

   359

		MemBlock* s;

   360

   361

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

   362

			if (s->size & S_FREE_MASK) {

   363

				size_t cur_size = s->size & ~S_FREE_MASK;

   364

   365

				/* Is the block exactly the size we need or

   366

				 * big enough for an additional free block? */

   367

				if (cur_size == mem_req ||

   368

						cur_size >= mem_req + sizeof(MemBlock)) {

   369

					/* Set size and in use */

   370

					s->size = mem_req;

   371

   372

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

   373

					if (cur_size != mem_req) {

   374

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

   375

					}

   376

   377

					return s->data;

   378

				}

   379

			}

   380

		}

   381

   382

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

   383

		DeleteEntryFromSpriteCache();

   384

	}

   385

}

   386

   387

   388

const void *GetRawSprite(SpriteID sprite)

   389

{

   390

	SpriteCache *sc;

   391

	void* p;

   392

   393

	assert(sprite < _spritecache_items);

   394

   395

	sc = GetSpriteCache(sprite);

   396

   397

	/* Update LRU */

   398

	sc->lru = ++_sprite_lru_counter;

   399

   400

	p = sc->ptr;

   401

   402

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

   403

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

   404

	return p;

   405

}

   406

   407

   408

void GfxInitSpriteMem()

   409

{

   410

	/* initialize sprite cache heap */

   411

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

   412

   413

	/* A big free block */

   414

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

   415

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

   416

	NextBlock(_spritecache_ptr)->size = 0;

   417

   418

	/* Reset the spritecache 'pool' */

   419

	free(_spritecache);

   420

	_spritecache_items = 0;

   421

	_spritecache = NULL;

   422

   423

	_compact_cache_counter = 0;

   424

}