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

    20

    21

    24

    54

    55

typedef struct MemBlock {

    56

	uint32 size;

    57

	byte data[VARARRAY_SIZE];

    58

} MemBlock;

    59

    60

static uint _sprite_lru_counter;

    61

static MemBlock *_spritecache_ptr;

    62

static int _compact_cache_counter;

    63

    64

static void CompactSpriteCache(void);

    65

    66

static bool ReadSpriteHeaderSkipData(void)

    67

{

    68

	uint16 num = FioReadWord();

    69

	byte type;

    70

    71

	if (num == 0) return false;

    72

    73

	type = FioReadByte();

    74

	if (type == 0xFF) {

    75

		FioSkipBytes(num);

    76

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

    77

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

    78

		return num != 1;

    79

	}

    80

    81

	FioSkipBytes(7);

    82

	num -= 8;

    83

	if (num == 0) return true;

    84

    85

	if (type & 2) {

    86

		FioSkipBytes(num);

    87

	} else {

    88

		while (num > 0) {

    89

			int8 i = FioReadByte();

    90

			if (i >= 0) {

    91

				num -= i;

    92

				FioSkipBytes(i);

    93

			} else {

    94

				i = -(i >> 3);

    95

				num -= i;

    96

				FioReadByte();

    97

			}

    98

		}

    99

	}

   100

   101

	return true;

   102

}

   103

   104

/* Check if the given Sprite ID exists */

   105

bool SpriteExists(SpriteID id)

   106

{

   107

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

   111

}

   112

   113

static void* AllocSprite(size_t);

   114

   116

{

   117

	uint num;

   118

	byte type;

   119

   120

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

   121

   122

	if (!SpriteExists(id)) {

   123

		error(

   124

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

   125

			"Probable cause: Wrong/missing NewGRFs",

   126

			id

   127

		);

   128

	}

   129

   131

   132

	num  = FioReadWord();

   133

	type = FioReadByte();

   134

	if (type == 0xFF) {

   135

		byte* dest = AllocSprite(num);

   136

   138

		FioReadBlock(dest, num);

   139

   140

		return dest;

   141

	} else {

   142

		uint height = FioReadByte();

   143

		uint width  = FioReadWord();

   144

		Sprite* sprite;

   145

		byte* dest;

   146

   147

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

   148

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

   150

		sprite->info   = type;

   151

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

   152

		sprite->width  = width;

   153

		sprite->x_offs = FioReadWord();

   154

		sprite->y_offs = FioReadWord();

   155

   156

		dest = sprite->data;

   157

		while (num > 0) {

   158

			int8 i = FioReadByte();

   159

   160

			if (i >= 0) {

   161

				num -= i;

   162

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

   163

			} else {

   164

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

   165

   166

				i = -(i >> 3);

   167

				num -= i;

   168

   169

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

   170

			}

   171

		}

   172

   173

		return sprite;

   174

	}

   175

}

   176

   177

   178

bool LoadNextSprite(int load_index, byte file_index)

   179

{

   181

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

   182

   183

	if (!ReadSpriteHeaderSkipData()) return false;

   184

   185

	if (load_index >= MAX_SPRITES) {

   186

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

   187

	}

   188

   193

   194

	return true;

   195

}

   196

   197

   198

void DupSprite(SpriteID old, SpriteID new)

   199

{

   205

}

   206

   207

   208

void SkipSprites(uint count)

   209

{

   210

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

   211

		if (!ReadSpriteHeaderSkipData()) return;

   212

	}

   213

}

   214

   215

   216

#define S_FREE_MASK 1

   217

   218

static inline MemBlock* NextBlock(MemBlock* block)

   219

{

   220

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

   221

}

   222

   223

static uint32 GetSpriteCacheUsage(void)

   224

{

   225

	uint32 tot_size = 0;

   226

	MemBlock* s;

   227

   228

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

   229

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

   230

   231

	return tot_size;

   232

}

   233

   234

   235

void IncreaseSpriteLRU(void)

   236

{

   240

   241

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

   242

   250

				}

   251

			}

   253

		_sprite_lru_counter = 0;

   254

	}

   255

   256

	// Compact sprite cache every now and then.

   257

	if (++_compact_cache_counter >= 740) {

   258

		CompactSpriteCache();

   259

		_compact_cache_counter = 0;

   260

	}

   261

}

   262

   263

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

   264

// That is accomplished by moving the cached data.

   265

static void CompactSpriteCache(void)

   266

{

   267

	MemBlock *s;

   268

   269

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

   270

   271

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

   272

		if (s->size & S_FREE_MASK) {

   273

			MemBlock* next = NextBlock(s);

   274

			MemBlock temp;

   276

   277

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

   278

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

   279

   280

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

   281

			if (next->size == 0)

   282

				break;

   283

   284

			// Locate the sprite belonging to the next pointer.

   287

			}

   288

   290

			// Swap this and the next block

   291

			temp = *s;

   292

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

   293

			s = NextBlock(s);

   294

			*s = temp;

   295

   296

			// Coalesce free blocks

   297

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

   298

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

   299

			}

   300

		} else {

   301

			s = NextBlock(s);

   302

		}

   303

	}

   304

}

   305

   306

static void DeleteEntryFromSpriteCache(void)

   307

{

   310

	MemBlock* s;

   311

	int cur_lru;

   312

   313

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

   314

   315

	cur_lru = 0xffff;

   320

			best = i;

   321

		}

   322

	}

   323

   324

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

   325

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

   327

		error("Out of sprite memory");

   328

   329

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

   331

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

   332

	s->size |= S_FREE_MASK;

   334

   335

	// And coalesce adjacent free blocks

   336

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

   337

		if (s->size & S_FREE_MASK) {

   338

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

   339

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

   340

			}

   341

		}

   342

	}

   343

}

   344

   345

static void* AllocSprite(size_t mem_req)

   346

{

   347

	mem_req += sizeof(MemBlock);

   348

   349

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

   350

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

   351

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

   352

   353

	for (;;) {

   354

		MemBlock* s;

   355

   356

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

   357

			if (s->size & S_FREE_MASK) {

   358

				size_t cur_size = s->size & ~S_FREE_MASK;

   359

   360

				/* Is the block exactly the size we need or

   361

				 * big enough for an additional free block? */

   362

				if (cur_size == mem_req ||

   363

						cur_size >= mem_req + sizeof(MemBlock)) {

   364

					// Set size and in use

   365

					s->size = mem_req;

   366

   367

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

   368

					if (cur_size != mem_req) {

   369

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

   370

					}

   371

   372

					return s->data;

   373

				}

   374

			}

   375

		}

   376

   377

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

   378

		DeleteEntryFromSpriteCache();

   379

	}

   380

}

   381

   382

   383

const void *GetRawSprite(SpriteID sprite)

   384

{

   386

	void* p;

   387

   388

	assert(sprite < MAX_SPRITES);

   389

   391

   392

	// Update LRU

   394

   397

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

   399

	return p;

   400

}

   401

   402

   403

void GfxInitSpriteMem(void)

   404

{

   405

	// initialize sprite cache heap

   406

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

   407

   408

	// A big free block

   409

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

   410

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

   411

	NextBlock(_spritecache_ptr)->size = 0;

   412

   417

   418

	_compact_cache_counter = 0;

   419

}