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

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

    49

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

    50

		return num != 1;

    51

	}

    52

    53

	FioSkipBytes(7);

    54

	num -= 8;

    55

	if (num == 0) return true;

    56

    57

	if (type & 2) {

    58

		FioSkipBytes(num);

    59

	} else {

    60

		while (num > 0) {

    61

			int8 i = FioReadByte();

    62

			if (i >= 0) {

    63

				num -= i;

    64

				FioSkipBytes(i);

    65

			} else {

    66

				i = -(i >> 3);

    67

				num -= i;

    68

				FioReadByte();

    69

			}

    70

		}

    71

	}

    72

    73

	return true;

    74

}

    75

    76

/* Check if the given Sprite ID exists */

    77

bool SpriteExists(SpriteID id)

    78

{

    79

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

    80

	return _sprite_file_pos[id] != 0 || id == 0;

    81

}

    82

    83

static void* AllocSprite(size_t);

    84

    85

static void* ReadSprite(SpriteID id)

    86

{

    87

	uint num;

    88

	byte type;

    89

    90

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

    91

    92

	if (!SpriteExists(id)) {

    93

		error(

    94

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

    95

			"Probable cause: Wrong/missing NewGRFs",

    96

			id

    97

		);

    98

	}

    99

   100

	FioSeekToFile(_sprite_file_pos[id]);

   101

   102

	num  = FioReadWord();

   103

	type = FioReadByte();

   104

	if (type == 0xFF) {

   105

		byte* dest = AllocSprite(num);

   106

   107

		_sprite_ptr[id] = dest;

   108

		FioReadBlock(dest, num);

   109

   110

		return dest;

   111

	} else {

   112

		uint height = FioReadByte();

   113

		uint width  = FioReadWord();

   114

		Sprite* sprite;

   115

		byte* dest;

   116

   117

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

   118

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

   119

		_sprite_ptr[id] = sprite;

   120

		sprite->info   = type;

   121

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

   122

		sprite->width  = width;

   123

		sprite->x_offs = FioReadWord();

   124

		sprite->y_offs = FioReadWord();

   125

   126

		dest = sprite->data;

   127

		while (num > 0) {

   128

			int8 i = FioReadByte();

   129

   130

			if (i >= 0) {

   131

				num -= i;

   132

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

   133

			} else {

   134

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

   135

   136

				i = -(i >> 3);

   137

				num -= i;

   138

   139

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

   140

			}

   141

		}

   142

   143

		return sprite;

   144

	}

   145

}

   146

   147

   148

bool LoadNextSprite(int load_index, byte file_index)

   149

{

   150

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

   151

   152

	if (!ReadSpriteHeaderSkipData()) return false;

   153

   154

	if (load_index >= MAX_SPRITES) {

   155

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

   156

	}

   157

   158

	_sprite_file_pos[load_index] = file_pos;

   159

   160

	_sprite_ptr[load_index] = NULL;

   161

   162

#if defined(WANT_NEW_LRU)

   163

	_sprite_lru_new[load_index] = 0;

   164

#else

   165

	_sprite_lru[load_index] = 0xFFFF;

   166

	_sprite_lru_cur[load_index] = 0;

   167

#endif

   168

   169

	return true;

   170

}

   171

   172

   173

void DupSprite(SpriteID old, SpriteID new)

   174

{

   175

	_sprite_file_pos[new] = _sprite_file_pos[old];

   176

	_sprite_ptr[new] = NULL;

   177

}

   178

   179

   180

void SkipSprites(uint count)

   181

{

   182

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

   183

		if (!ReadSpriteHeaderSkipData()) return;

   184

	}

   185

}

   186

   187

   188

#define S_FREE_MASK 1

   189

   190

static inline MemBlock* NextBlock(MemBlock* block)

   191

{

   192

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

   193

}

   194

   195

static uint32 GetSpriteCacheUsage(void)

   196

{

   197

	uint32 tot_size = 0;

   198

	MemBlock* s;

   199

   200

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

   201

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

   202

   203

	return tot_size;

   204

}

   205

   206

   207

void IncreaseSpriteLRU(void)

   208

{

   209

	int i;

   210

   211

	// Increase all LRU values

   212

#if defined(WANT_NEW_LRU)

   213

	if (_sprite_lru_counter > 16384) {

   214

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

   215

   216

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

   217

			if (_sprite_ptr[i] != NULL) {

   218

				if (_sprite_lru_new[i] >= 0) {

   219

					_sprite_lru_new[i] = -1;

   220

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

   221

					_sprite_lru_new[i]--;

   222

				}

   223

			}

   224

		_sprite_lru_counter = 0;

   225

	}

   226

#else

   227

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

   228

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

   229

			_sprite_lru[i]++;

   230

	// Reset the lru counter.

   231

	_sprite_lru_counter = 0;

   232

#endif

   233

   234

	// Compact sprite cache every now and then.

   235

	if (++_compact_cache_counter >= 740) {

   236

		CompactSpriteCache();

   237

		_compact_cache_counter = 0;

   238

	}

   239

}

   240

   241

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

   242

// That is accomplished by moving the cached data.

   243

static void CompactSpriteCache(void)

   244

{

   245

	MemBlock *s;

   246

   247

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

   248

   249

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

   250

		if (s->size & S_FREE_MASK) {

   251

			MemBlock* next = NextBlock(s);

   252

			MemBlock temp;

   253

			void** i;

   254

   255

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

   256

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

   257

   258

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

   259

			if (next->size == 0)

   260

				break;

   261

   262

			// Locate the sprite belonging to the next pointer.

   263

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

   264

				assert(i != endof(_sprite_ptr));

   265

			}

   266

   267

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

   268

			// Swap this and the next block

   269

			temp = *s;

   270

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

   271

			s = NextBlock(s);

   272

			*s = temp;

   273

   274

			// Coalesce free blocks

   275

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

   276

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

   277

			}

   278

		} else {

   279

			s = NextBlock(s);

   280

		}

   281

	}

   282

}

   283

   284

static void DeleteEntryFromSpriteCache(void)

   285

{

   286

	int i;

   287

	int best = -1;

   288

	MemBlock* s;

   289

	int cur_lru;

   290

   291

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

   292

   293

#if defined(WANT_NEW_LRU)

   294

	cur_lru = 0xffff;

   295

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

   296

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

   297

			cur_lru = _sprite_lru_new[i];

   298

			best = i;

   299

		}

   300

	}

   301

#else

   302

	{

   303

	uint16 cur_lru = 0, cur_lru_cur = 0xffff;

   304

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

   305

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

   306

   307

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

   308

		if (_sprite_lru[i] != cur_lru) {

   309

			cur_lru = _sprite_lru[i];

   310

			best = i;

   311

   312

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

   313

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

   314

			cur_lru_cur = _sprite_lru_cur[i];

   315

			cur_lru = _sprite_lru[i];

   316

			best = i;

   317

		}

   318

	}

   319

	}

   320

#endif

   321

   322

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

   323

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

   324

	if (best == -1)

   325

		error("Out of sprite memory");

   326

   327

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

   328

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

   329

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

   330

	s->size |= S_FREE_MASK;

   331

	_sprite_ptr[best] = NULL;

   332

   333

	// And coalesce adjacent free blocks

   334

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

   335

		if (s->size & S_FREE_MASK) {

   336

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

   337

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

   338

			}

   339

		}

   340

	}

   341

}

   342

   343

static void* AllocSprite(size_t mem_req)

   344

{

   345

	mem_req += sizeof(MemBlock);

   346

   347

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

   348

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

   349

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

   350

   351

	for (;;) {

   352

		MemBlock* s;

   353

   354

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

   355

			if (s->size & S_FREE_MASK) {

   356

				size_t cur_size = s->size & ~S_FREE_MASK;

   357

   358

				/* Is the block exactly the size we need or

   359

				 * big enough for an additional free block? */

   360

				if (cur_size == mem_req ||

   361

						cur_size >= mem_req + sizeof(MemBlock)) {

   362

					// Set size and in use

   363

					s->size = mem_req;

   364

   365

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

   366

					if (cur_size != mem_req) {

   367

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

   368

					}

   369

   370

					return s->data;

   371

				}

   372

			}

   373

		}

   374

   375

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

   376

		DeleteEntryFromSpriteCache();

   377

	}

   378

}

   379

   380

#if defined(NEW_ROTATION)

   381

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

   382

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

   383

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

   384

   385

   386

static uint RotateSprite(uint s)

   387

{

   388

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

   389

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

   390

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

   391

   392

	if (0);

   393

	X19(752)

   394

	X15(990-1)

   395

	X19(3924)

   396

	X19(3943)

   397

	X19(3962)

   398

	X19(3981)

   399

	X19(4000)

   400

	X19(4023)

   401

	X19(4042)

   402

	MAP(4061, 4069, _coast_map)

   403

	X19(4126)

   404

	X19(4145)

   405

	X19(4164)

   406

	X19(4183)

   407

	X19(4202)

   408

	X19(4221)

   409

	X19(4240)

   410

	X19(4259)

   411

	X19(4259)

   412

	X19(4278)

   413

	MAP(4090, 4095, _fence_map)

   414

	MAP(4096, 4101, _fence_map)

   415

	MAP(4102, 4107, _fence_map)

   416

	MAP(4108, 4113, _fence_map)

   417

	MAP(4114, 4119, _fence_map)

   418

	MAP(4120, 4125, _fence_map)

   419

	return s;

   420

}

   421

#endif

   422

   423

const void *GetRawSprite(SpriteID sprite)

   424

{

   425

	void* p;

   426

   427

	assert(sprite < MAX_SPRITES);

   428

   429

#if defined(NEW_ROTATION)

   430

	sprite = RotateSprite(sprite);

   431

#endif

   432

   433

	// Update LRU

   434

#if defined(WANT_NEW_LRU)

   435

	_sprite_lru_new[sprite] = ++_sprite_lru_counter;

   436

#else

   437

	_sprite_lru_cur[sprite] = ++_sprite_lru_counter;

   438

	_sprite_lru[sprite] = 0;

   439

#endif

   440

   441

	p = _sprite_ptr[sprite];

   442

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

   443

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

   444

	return p;

   445

}

   446

   447

   448

void GfxInitSpriteMem(void)

   449

{

   450

	// initialize sprite cache heap

   451

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

   452

   453

	// A big free block

   454

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

   455

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

   456

	NextBlock(_spritecache_ptr)->size = 0;

   457

   458

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

   459

   460

	_compact_cache_counter = 0;

   461

}