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

    15

static void* _sprite_ptr[MAX_SPRITES];

    16

static uint32 _sprite_file_pos[MAX_SPRITES];

    17

static int16 _sprite_lru_new[MAX_SPRITES];

    18

    19

typedef struct MemBlock {

    20

	uint32 size;

    21

	byte data[VARARRAY_SIZE];

    22

} MemBlock;

    23

    24

static uint _sprite_lru_counter;

    25

static MemBlock *_spritecache_ptr;

    26

static int _compact_cache_counter;

    27

    28

static void CompactSpriteCache(void);

    29

    30

static bool ReadSpriteHeaderSkipData(void)

    31

{

    32

	uint16 num = FioReadWord();

    33

	byte type;

    34

    35

	if (num == 0) return false;

    36

    37

	type = FioReadByte();

    38

	if (type == 0xFF) {

    39

		FioSkipBytes(num);

    40

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

    41

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

    42

		return num != 1;

    43

	}

    44

    45

	FioSkipBytes(7);

    46

	num -= 8;

    47

	if (num == 0) return true;

    48

    49

	if (type & 2) {

    50

		FioSkipBytes(num);

    51

	} else {

    52

		while (num > 0) {

    53

			int8 i = FioReadByte();

    54

			if (i >= 0) {

    55

				num -= i;

    56

				FioSkipBytes(i);

    57

			} else {

    58

				i = -(i >> 3);

    59

				num -= i;

    60

				FioReadByte();

    61

			}

    62

		}

    63

	}

    64

    65

	return true;

    66

}

    67

    68

/* Check if the given Sprite ID exists */

    69

bool SpriteExists(SpriteID id)

    70

{

    71

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

    72

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

    73

}

    74

    75

static void* AllocSprite(size_t);

    76

    77

static void* ReadSprite(SpriteID id)

    78

{

    79

	uint num;

    80

	byte type;

    81

    82

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

    83

    84

	if (!SpriteExists(id)) {

    85

		error(

    86

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

    87

			"Probable cause: Wrong/missing NewGRFs",

    88

			id

    89

		);

    90

	}

    91

    92

	FioSeekToFile(_sprite_file_pos[id]);

    93

    94

	num  = FioReadWord();

    95

	type = FioReadByte();

    96

	if (type == 0xFF) {

    97

		byte* dest = AllocSprite(num);

    98

    99

		_sprite_ptr[id] = dest;

   100

		FioReadBlock(dest, num);

   101

   102

		return dest;

   103

	} else {

   104

		uint height = FioReadByte();

   105

		uint width  = FioReadWord();

   106

		Sprite* sprite;

   107

		byte* dest;

   108

   109

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

   110

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

   111

		_sprite_ptr[id] = sprite;

   112

		sprite->info   = type;

   113

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

   114

		sprite->width  = width;

   115

		sprite->x_offs = FioReadWord();

   116

		sprite->y_offs = FioReadWord();

   117

   118

		dest = sprite->data;

   119

		while (num > 0) {

   120

			int8 i = FioReadByte();

   121

   122

			if (i >= 0) {

   123

				num -= i;

   124

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

   125

			} else {

   126

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

   127

   128

				i = -(i >> 3);

   129

				num -= i;

   130

   131

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

   132

			}

   133

		}

   134

   135

		return sprite;

   136

	}

   137

}

   138

   139

   140

bool LoadNextSprite(int load_index, byte file_index)

   141

{

   142

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

   143

   144

	if (!ReadSpriteHeaderSkipData()) return false;

   145

   146

	if (load_index >= MAX_SPRITES) {

   147

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

   148

	}

   149

   150

	_sprite_file_pos[load_index] = file_pos;

   151

   152

	_sprite_ptr[load_index] = NULL;

   153

   154

	_sprite_lru_new[load_index] = 0;

   155

   156

	return true;

   157

}

   158

   159

   160

void DupSprite(SpriteID old, SpriteID new)

   161

{

   162

	_sprite_file_pos[new] = _sprite_file_pos[old];

   163

	_sprite_ptr[new] = NULL;

   164

}

   165

   166

   167

void SkipSprites(uint count)

   168

{

   169

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

   170

		if (!ReadSpriteHeaderSkipData()) return;

   171

	}

   172

}

   173

   174

   175

#define S_FREE_MASK 1

   176

   177

static inline MemBlock* NextBlock(MemBlock* block)

   178

{

   179

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

   180

}

   181

   182

static uint32 GetSpriteCacheUsage(void)

   183

{

   184

	uint32 tot_size = 0;

   185

	MemBlock* s;

   186

   187

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

   188

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

   189

   190

	return tot_size;

   191

}

   192

   193

   194

void IncreaseSpriteLRU(void)

   195

{

   196

	int i;

   197

   198

	// Increase all LRU values

   199

	if (_sprite_lru_counter > 16384) {

   200

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

   201

   202

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

   203

			if (_sprite_ptr[i] != NULL) {

   204

				if (_sprite_lru_new[i] >= 0) {

   205

					_sprite_lru_new[i] = -1;

   206

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

   207

					_sprite_lru_new[i]--;

   208

				}

   209

			}

   210

		_sprite_lru_counter = 0;

   211

	}

   212

   213

	// Compact sprite cache every now and then.

   214

	if (++_compact_cache_counter >= 740) {

   215

		CompactSpriteCache();

   216

		_compact_cache_counter = 0;

   217

	}

   218

}

   219

   220

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

   221

// That is accomplished by moving the cached data.

   222

static void CompactSpriteCache(void)

   223

{

   224

	MemBlock *s;

   225

   226

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

   227

   228

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

   229

		if (s->size & S_FREE_MASK) {

   230

			MemBlock* next = NextBlock(s);

   231

			MemBlock temp;

   232

			void** i;

   233

   234

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

   235

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

   236

   237

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

   238

			if (next->size == 0)

   239

				break;

   240

   241

			// Locate the sprite belonging to the next pointer.

   242

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

   243

				assert(i != endof(_sprite_ptr));

   244

			}

   245

   246

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

   247

			// Swap this and the next block

   248

			temp = *s;

   249

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

   250

			s = NextBlock(s);

   251

			*s = temp;

   252

   253

			// Coalesce free blocks

   254

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

   255

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

   256

			}

   257

		} else {

   258

			s = NextBlock(s);

   259

		}

   260

	}

   261

}

   262

   263

static void DeleteEntryFromSpriteCache(void)

   264

{

   265

	int i;

   266

	int best = -1;

   267

	MemBlock* s;

   268

	int cur_lru;

   269

   270

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

   271

   272

	cur_lru = 0xffff;

   273

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

   274

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

   275

			cur_lru = _sprite_lru_new[i];

   276

			best = i;

   277

		}

   278

	}

   279

   280

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

   281

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

   282

	if (best == -1)

   283

		error("Out of sprite memory");

   284

   285

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

   286

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

   287

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

   288

	s->size |= S_FREE_MASK;

   289

	_sprite_ptr[best] = NULL;

   290

   291

	// And coalesce adjacent free blocks

   292

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

   293

		if (s->size & S_FREE_MASK) {

   294

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

   295

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

   296

			}

   297

		}

   298

	}

   299

}

   300

   301

static void* AllocSprite(size_t mem_req)

   302

{

   303

	mem_req += sizeof(MemBlock);

   304

   305

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

   306

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

   307

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

   308

   309

	for (;;) {

   310

		MemBlock* s;

   311

   312

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

   313

			if (s->size & S_FREE_MASK) {

   314

				size_t cur_size = s->size & ~S_FREE_MASK;

   315

   316

				/* Is the block exactly the size we need or

   317

				 * big enough for an additional free block? */

   318

				if (cur_size == mem_req ||

   319

						cur_size >= mem_req + sizeof(MemBlock)) {

   320

					// Set size and in use

   321

					s->size = mem_req;

   322

   323

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

   324

					if (cur_size != mem_req) {

   325

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

   326

					}

   327

   328

					return s->data;

   329

				}

   330

			}

   331

		}

   332

   333

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

   334

		DeleteEntryFromSpriteCache();

   335

	}

   336

}

   337

   338

#if defined(NEW_ROTATION)

   339

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

   340

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

   341

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

   342

   343

   344

static uint RotateSprite(uint s)

   345

{

   346

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

   347

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

   348

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

   349

   350

	if (0);

   351

	X19(752)

   352

	X15(990-1)

   353

	X19(3924)

   354

	X19(3943)

   355

	X19(3962)

   356

	X19(3981)

   357

	X19(4000)

   358

	X19(4023)

   359

	X19(4042)

   360

	MAP(4061, 4069, _coast_map)

   361

	X19(4126)

   362

	X19(4145)

   363

	X19(4164)

   364

	X19(4183)

   365

	X19(4202)

   366

	X19(4221)

   367

	X19(4240)

   368

	X19(4259)

   369

	X19(4259)

   370

	X19(4278)

   371

	MAP(4090, 4095, _fence_map)

   372

	MAP(4096, 4101, _fence_map)

   373

	MAP(4102, 4107, _fence_map)

   374

	MAP(4108, 4113, _fence_map)

   375

	MAP(4114, 4119, _fence_map)

   376

	MAP(4120, 4125, _fence_map)

   377

	return s;

   378

}

   379

#endif

   380

   381

const void *GetRawSprite(SpriteID sprite)

   382

{

   383

	void* p;

   384

   385

	assert(sprite < MAX_SPRITES);

   386

   387

#if defined(NEW_ROTATION)

   388

	sprite = RotateSprite(sprite);

   389

#endif

   390

   391

	// Update LRU

   392

	_sprite_lru_new[sprite] = ++_sprite_lru_counter;

   393

   394

	p = _sprite_ptr[sprite];

   395

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

   396

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

   397

	return p;

   398

}

   399

   400

   401

void GfxInitSpriteMem(void)

   402

{

   403

	// initialize sprite cache heap

   404

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

   405

   406

	// A big free block

   407

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

   408

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

   409

	NextBlock(_spritecache_ptr)->size = 0;

   410

   411

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

   412

   413

	_compact_cache_counter = 0;

   414

}