1

/* $Id$ */

     2

     3

/** @file fontcache.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "table/sprites.h"

     9

#include "table/control_codes.h"

    10

#include "spritecache.h"

    11

#include "string.h"

    12

#include "fontcache.h"

    13

#include "spriteloader/spriteloader.hpp"

    14

#include "blitter/factory.hpp"

    15

#include "gfx_func.h"

    16

#include "core/alloc_func.hpp"

    18

    19

#ifdef WITH_FREETYPE

    20

    21

#include <ft2build.h>

    22

#include FT_FREETYPE_H

    23

#include FT_GLYPH_H

    24

    25

#ifdef WITH_FONTCONFIG

    26

#include <fontconfig/fontconfig.h>

    27

#endif

    28

    29

static FT_Library _library = NULL;

    30

static FT_Face _face_small = NULL;

    31

static FT_Face _face_medium = NULL;

    32

static FT_Face _face_large = NULL;

    33

    34

FreeTypeSettings _freetype;

    35

    36

enum {

    37

	FACE_COLOUR = 1,

    38

	SHADOW_COLOUR = 2,

    39

};

    40

    41

/** Get the font loaded into a Freetype face by using a font-name.

    42

 * If no appropiate font is found, the function returns an error */

    43

#ifdef WIN32

    44

#include <windows.h>

    45

#include <tchar.h>

    46

#include <shlobj.h> // SHGetFolderPath

    47

#include "win32.h"

    48

    49

/* Get the font file to be loaded into Freetype by looping the registry

    50

 * location where windows lists all installed fonts. Not very nice, will

    51

 * surely break if the registry path changes, but it works. Much better

    52

 * solution would be to use CreateFont, and extract the font data from it

    53

 * by GetFontData. The problem with this is that the font file needs to be

    54

 * kept in memory then until the font is no longer needed. This could mean

    55

 * an additional memory usage of 30MB (just for fonts!) when using an eastern

    56

 * font for all font sizes */

    57

#define FONT_DIR_NT "SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Fonts"

    58

#define FONT_DIR_9X "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Fonts"

    59

static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)

    60

{

    61

	FT_Error err = FT_Err_Cannot_Open_Resource;

    62

	HKEY hKey;

    63

	LONG ret;

    64

	TCHAR vbuffer[MAX_PATH], dbuffer[256];

    65

	TCHAR *font_namep;

    66

	char *font_path;

    67

	uint index;

    68

    69

	/* On windows NT (2000, NT3.5, XP, etc.) the fonts are stored in the

    70

	 * "Windows NT" key, on Windows 9x in the Windows key. To save us having

    71

	 * to retrieve the windows version, we'll just query both */

    72

	ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_NT), 0, KEY_READ, &hKey);

    73

	if (ret != ERROR_SUCCESS) ret = RegOpenKeyEx(HKEY_LOCAL_MACHINE, _T(FONT_DIR_9X), 0, KEY_READ, &hKey);

    74

    75

	if (ret != ERROR_SUCCESS) {

    76

		DEBUG(freetype, 0, "Cannot open registry key HKLM\\SOFTWARE\\Microsoft\\Windows (NT)\\CurrentVersion\\Fonts");

    77

		return err;

    78

	}

    79

    80

	/* For Unicode we need some conversion between widechar and

    81

	 * normal char to match the data returned by RegEnumValue,

    82

	 * otherwise just use parameter */

    83

#if defined(UNICODE)

    84

	font_namep = MallocT<TCHAR>(MAX_PATH);

    85

	MB_TO_WIDE_BUFFER(font_name, font_namep, MAX_PATH * sizeof(TCHAR));

    86

#else

    87

	font_namep = (char*)font_name; // only cast because in unicode pointer is not const

    88

#endif

    89

    90

	for (index = 0;; index++) {

    91

		TCHAR *s;

    92

		DWORD vbuflen = lengthof(vbuffer);

    93

		DWORD dbuflen = lengthof(dbuffer);

    94

    95

		ret = RegEnumValue(hKey, index, vbuffer, &vbuflen, NULL, NULL, (byte*)dbuffer, &dbuflen);

    96

		if (ret != ERROR_SUCCESS) goto registry_no_font_found;

    97

    98

		/* The font names in the registry are of the following 3 forms:

    99

		 * - ADMUI3.fon

   100

		 * - Book Antiqua Bold (TrueType)

   101

		 * - Batang & BatangChe & Gungsuh & GungsuhChe (TrueType)

   102

		 * We will strip the font-type '()' if any and work with the font name

   103

		 * itself, which must match exactly; if...

   104

		 * TTC files, font files which contain more than one font are seperated

   105

		 * byt '&'. Our best bet will be to do substr match for the fontname

   106

		 * and then let FreeType figure out which index to load */

   107

		s = _tcschr(vbuffer, _T('('));

   108

		if (s != NULL) s[-1] = '\0';

   109

   110

		if (_tcschr(vbuffer, _T('&')) == NULL) {

   111

			if (_tcsicmp(vbuffer, font_namep) == 0) break;

   112

		} else {

   113

			if (_tcsstr(vbuffer, font_namep) != NULL) break;

   114

		}

   115

	}

   116

   117

	if (!SUCCEEDED(SHGetFolderPath(NULL, CSIDL_FONTS, NULL, SHGFP_TYPE_CURRENT, vbuffer))) {

   118

		DEBUG(freetype, 0, "SHGetFolderPath cannot return fonts directory");

   119

		goto folder_error;

   120

	}

   121

   122

	/* Some fonts are contained in .ttc files, TrueType Collection fonts. These

   123

	 * contain multiple fonts inside this single file. GetFontData however

   124

	 * returns the whole file, so we need to check each font inside to get the

   125

	 * proper font.

   126

	 * Also note that FreeType does not support UNICODE filesnames! */

   127

#if defined(UNICODE)

   128

	/* We need a cast here back from wide because FreeType doesn't support

   129

	 * widechar filenames. Just use the buffer we allocated before for the

   130

	 * font_name search */

   131

	font_path = (char*)font_namep;

   132

	WIDE_TO_MB_BUFFER(vbuffer, font_path, MAX_PATH * sizeof(TCHAR));

   133

#else

   134

	font_path = vbuffer;

   135

#endif

   136

   137

	ttd_strlcat(font_path, "\\", MAX_PATH * sizeof(TCHAR));

   138

	ttd_strlcat(font_path, WIDE_TO_MB(dbuffer), MAX_PATH * sizeof(TCHAR));

   139

	index = 0;

   140

	do {

   141

		err = FT_New_Face(_library, font_path, index, face);

   142

		if (err != FT_Err_Ok) break;

   143

   144

		if (strncasecmp(font_name, (*face)->family_name, strlen((*face)->family_name)) == 0) break;

   145

		err = FT_Err_Cannot_Open_Resource;

   146

   147

	} while ((FT_Long)++index != (*face)->num_faces);

   148

   149

   150

folder_error:

   151

registry_no_font_found:

   152

#if defined(UNICODE)

   153

	free(font_namep);

   154

#endif

   155

	RegCloseKey(hKey);

   156

	return err;

   157

}

   158

#else

   159

# ifdef WITH_FONTCONFIG

   160

static FT_Error GetFontByFaceName(const char *font_name, FT_Face *face)

   161

{

   162

	FT_Error err = FT_Err_Cannot_Open_Resource;

   163

   164

	if (!FcInit()) {

   165

		ShowInfoF("Unable to load font configuration");

   166

	} else {

   167

		FcPattern *match;

   168

		FcPattern *pat;

   169

		FcFontSet *fs;

   170

		FcResult  result;

   171

		char *font_style;

   172

		char *font_family;

   173

   174

		/* Split & strip the font's style */

   175

		font_family = strdup(font_name);

   176

		font_style = strchr(font_family, ',');

   177

		if (font_style != NULL) {

   178

			font_style[0] = '\0';

   179

			font_style++;

   180

			while (*font_style == ' ' || *font_style == '\t') font_style++;

   181

		}

   182

   183

		/* Resolve the name and populate the information structure */

   184

		pat = FcNameParse((FcChar8*)font_family);

   185

		if (font_style != NULL) FcPatternAddString(pat, FC_STYLE, (FcChar8*)font_style);

   186

		FcConfigSubstitute(0, pat, FcMatchPattern);

   187

		FcDefaultSubstitute(pat);

   188

		fs = FcFontSetCreate();

   189

		match = FcFontMatch(0, pat, &result);

   190

   191

		if (fs != NULL && match != NULL) {

   192

			int i;

   193

			FcChar8 *family;

   194

			FcChar8 *style;

   195

			FcChar8 *file;

   196

			FcFontSetAdd(fs, match);

   197

   198

			for (i = 0; err != FT_Err_Ok && i < fs->nfont; i++) {

   199

				/* Try the new filename */

   200

				if (FcPatternGetString(fs->fonts[i], FC_FILE,   0, &file)   == FcResultMatch &&

   201

						FcPatternGetString(fs->fonts[i], FC_FAMILY, 0, &family) == FcResultMatch &&

   202

						FcPatternGetString(fs->fonts[i], FC_STYLE,  0, &style)  == FcResultMatch) {

   203

   204

					/* The correct style? */

   205

					if (font_style != NULL && strcasecmp(font_style, (char*)style) != 0) continue;

   206

   207

					/* Font config takes the best shot, which, if the family name is spelled

   208

					* wrongly a 'random' font, so check whether the family name is the

   209

					* same as the supplied name */

   210

					if (strcasecmp(font_family, (char*)family) == 0) {

   211

						err = FT_New_Face(_library, (char *)file, 0, face);

   212

					}

   213

				}

   214

			}

   215

		}

   216

   217

		free(font_family);

   218

		FcPatternDestroy(pat);

   219

		FcFontSetDestroy(fs);

   220

		FcFini();

   221

	}

   222

   223

	return err;

   224

}

   225

# else

   226

FT_Error GetFontByFaceName(const char *font_name, FT_Face *face) {return FT_Err_Cannot_Open_Resource;}

   227

# endif /* WITH_FONTCONFIG */

   228

   229

#endif

   230

   231

/**

   232

 * Loads the freetype font.

   233

 * First type to load the fontname as if it were a path. If that fails,

   234

 * try to resolve the filename of the font using fontconfig, where the

   235

 * format is 'font family name' or 'font family name, font style'.

   236

 */

   237

static void LoadFreeTypeFont(const char *font_name, FT_Face *face, const char *type)

   238

{

   239

	FT_Error error;

   240

   241

	if (StrEmpty(font_name)) return;

   242

   243

	error = FT_New_Face(_library, font_name, 0, face);

   244

   245

	if (error != FT_Err_Ok) error = GetFontByFaceName(font_name, face);

   246

   247

	if (error == FT_Err_Ok) {

   248

		DEBUG(freetype, 2, "Requested '%s', using '%s %s'", font_name, (*face)->family_name, (*face)->style_name);

   249

   250

		/* Attempt to select the unicode character map */

   251

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   252

		if (error == FT_Err_Ok) return; // Success

   253

   254

		if (error == FT_Err_Invalid_CharMap_Handle) {

   255

			/* Try to pick a different character map instead. We default to

   256

			 * the first map, but platform_id 0 encoding_id 0 should also

   257

			 * be unicode (strange system...) */

   258

			FT_CharMap found = (*face)->charmaps[0];

   259

			int i;

   260

   261

			for (i = 0; i < (*face)->num_charmaps; i++) {

   262

				FT_CharMap charmap = (*face)->charmaps[i];

   263

				if (charmap->platform_id == 0 && charmap->encoding_id == 0) {

   264

					found = charmap;

   265

				}

   266

			}

   267

   268

			if (found != NULL) {

   269

				error = FT_Set_Charmap(*face, found);

   270

				if (error == FT_Err_Ok) return;

   271

			}

   272

		}

   273

	}

   274

   275

	FT_Done_Face(*face);

   276

	*face = NULL;

   277

   278

	ShowInfoF("Unable to use '%s' for %s font, FreeType reported error 0x%X, using sprite font instead", font_name, type, error);

   279

}

   280

   281

   282

void InitFreeType()

   283

{

   284

	if (StrEmpty(_freetype.small_font) && StrEmpty(_freetype.medium_font) && StrEmpty(_freetype.large_font)) {

   285

		DEBUG(freetype, 1, "No font faces specified, using sprite fonts instead");

   286

		return;

   287

	}

   288

   289

	if (FT_Init_FreeType(&_library) != FT_Err_Ok) {

   290

		ShowInfoF("Unable to initialize FreeType, using sprite fonts instead");

   291

		return;

   292

	}

   293

   294

	DEBUG(freetype, 2, "Initialized");

   295

   296

	/* Load each font */

   297

	LoadFreeTypeFont(_freetype.small_font,  &_face_small,  "small");

   298

	LoadFreeTypeFont(_freetype.medium_font, &_face_medium, "medium");

   299

	LoadFreeTypeFont(_freetype.large_font,  &_face_large,  "large");

   300

   301

	/* Set each font size */

   302

	if (_face_small  != NULL) FT_Set_Pixel_Sizes(_face_small,  0, _freetype.small_size);

   303

	if (_face_medium != NULL) FT_Set_Pixel_Sizes(_face_medium, 0, _freetype.medium_size);

   304

	if (_face_large  != NULL) FT_Set_Pixel_Sizes(_face_large,  0, _freetype.large_size);

   305

}

   306

   307

   308

static FT_Face GetFontFace(FontSize size)

   309

{

   310

	switch (size) {

   311

		default: NOT_REACHED();

   312

		case FS_NORMAL: return _face_medium;

   313

		case FS_SMALL:  return _face_small;

   314

		case FS_LARGE:  return _face_large;

   315

	}

   316

}

   317

   318

   319

struct GlyphEntry {

   320

	Sprite *sprite;

   321

	byte width;

   322

};

   323

   324

   325

/* The glyph cache. This is structured to reduce memory consumption.

   326

 * 1) There is a 'segment' table for each font size.

   327

 * 2) Each segment table is a discrete block of characters.

   328

 * 3) Each block contains 256 (aligned) characters sequential characters.

   329

 *

   330

 * The cache is accessed in the following way:

   331

 * For character 0x0041  ('A'): _glyph_ptr[FS_NORMAL][0x00][0x41]

   332

 * For character 0x20AC (Euro): _glyph_ptr[FS_NORMAL][0x20][0xAC]

   333

 *

   334

 * Currently only 256 segments are allocated, "limiting" us to 65536 characters.

   335

 * This can be simply changed in the two functions Get & SetGlyphPtr.

   336

 */

   337

static GlyphEntry **_glyph_ptr[FS_END];

   338

   339

   340

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   341

{

   342

	if (_glyph_ptr[size] == NULL) return NULL;

   343

	if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) return NULL;

   344

	return &_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)];

   345

}

   346

   347

   348

static void SetGlyphPtr(FontSize size, WChar key, const GlyphEntry *glyph)

   349

{

   350

	if (_glyph_ptr[size] == NULL) {

   351

		DEBUG(freetype, 3, "Allocating root glyph cache for size %u", size);

   352

		_glyph_ptr[size] = CallocT<GlyphEntry*>(256);

   353

	}

   354

   355

	if (_glyph_ptr[size][GB(key, 8, 8)] == NULL) {

   356

		DEBUG(freetype, 3, "Allocating glyph cache for range 0x%02X00, size %u", GB(key, 8, 8), size);

   357

		_glyph_ptr[size][GB(key, 8, 8)] = CallocT<GlyphEntry>(256);

   358

	}

   359

   360

	DEBUG(freetype, 4, "Set glyph for unicode character 0x%04X, size %u", key, size);

   361

	_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].sprite = glyph->sprite;

   362

	_glyph_ptr[size][GB(key, 8, 8)][GB(key, 0, 8)].width  = glyph->width;

   363

}

   364

   365

void *AllocateFont(size_t size)

   366

{

   367

	return MallocT<byte>(size);

   368

}

   369

   370

   371

/* Check if a glyph should be rendered with antialiasing */

   372

static bool GetFontAAState(FontSize size)

   373

{

   374

	/* AA is only supported for 32 bpp */

   375

	if (BlitterFactoryBase::GetCurrentBlitter()->GetScreenDepth() != 32) return false;

   376

   377

	switch (size) {

   378

		default: NOT_REACHED();

   379

		case FS_NORMAL: return _freetype.medium_aa;

   380

		case FS_SMALL:  return _freetype.small_aa;

   381

		case FS_LARGE:  return _freetype.large_aa;

   382

	}

   383

}

   384

   385

   386

const Sprite *GetGlyph(FontSize size, WChar key)

   387

{

   388

	FT_Face face = GetFontFace(size);

   389

	FT_GlyphSlot slot;

   390

	GlyphEntry new_glyph;

   391

	GlyphEntry *glyph;

   392

	SpriteLoader::Sprite sprite;

   393

	int width;

   394

	int height;

   395

	int x;

   396

	int y;

   397

	int y_adj;

   398

   399

	assert(IsPrintable(key));

   400

   401

	/* Bail out if no face loaded, or for our special characters */

   402

	if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {

   403

		SpriteID sprite = GetUnicodeGlyph(size, key);

   404

		if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');

   405

		return GetSprite(sprite);

   406

	}

   407

   408

	/* Check for the glyph in our cache */

   409

	glyph = GetGlyphPtr(size, key);

   410

	if (glyph != NULL && glyph->sprite != NULL) return glyph->sprite;

   411

   412

	slot = face->glyph;

   413

   414

	bool aa = GetFontAAState(size);

   415

   416

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   417

	FT_Render_Glyph(face->glyph, aa ? FT_RENDER_MODE_NORMAL : FT_RENDER_MODE_MONO);

   418

   419

	/* Add 1 pixel for the shadow on the medium font. Our sprite must be at least 1x1 pixel */

   420

	width  = max(1, slot->bitmap.width + (size == FS_NORMAL));

   421

	height = max(1, slot->bitmap.rows  + (size == FS_NORMAL));

   422

   423

	/* FreeType has rendered the glyph, now we allocate a sprite and copy the image into it */

   424

	sprite.data = CallocT<SpriteLoader::CommonPixel>(width * height);

   425

	sprite.width = width;

   426

	sprite.height = height;

   427

	sprite.x_offs = slot->bitmap_left;

   428

	// XXX 2 should be determined somehow... it's right for the normal face

   429

	y_adj = (size == FS_NORMAL) ? 2 : 0;

   430

	sprite.y_offs = GetCharacterHeight(size) - slot->bitmap_top - y_adj;

   431

   432

	/* Draw shadow for medium size */

   433

	if (size == FS_NORMAL) {

   434

		for (y = 0; y < slot->bitmap.rows; y++) {

   435

			for (x = 0; x < slot->bitmap.width; x++) {

   436

				if (aa ? (slot->bitmap.buffer[x + y * slot->bitmap.pitch] > 0) : HasBit(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   437

					sprite.data[1 + x + (1 + y) * sprite.width].m = SHADOW_COLOUR;

   438

					sprite.data[1 + x + (1 + y) * sprite.width].a = aa ? slot->bitmap.buffer[x + y * slot->bitmap.pitch] : 0xFF;

   439

				}

   440

			}

   441

		}

   442

	}

   443

   444

	for (y = 0; y < slot->bitmap.rows; y++) {

   445

		for (x = 0; x < slot->bitmap.width; x++) {

   446

			if (aa ? (slot->bitmap.buffer[x + y * slot->bitmap.pitch] > 0) : HasBit(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   447

				sprite.data[x + y * sprite.width].m = FACE_COLOUR;

   448

				sprite.data[x + y * sprite.width].a = aa ? slot->bitmap.buffer[x + y * slot->bitmap.pitch] : 0xFF;

   449

			}

   450

		}

   451

	}

   452

   453

	new_glyph.sprite = BlitterFactoryBase::GetCurrentBlitter()->Encode(&sprite, AllocateFont);

   454

	free(sprite.data);

   455

	new_glyph.width  = (slot->advance.x >> 6) + (size != FS_NORMAL);

   456

   457

	SetGlyphPtr(size, key, &new_glyph);

   458

   459

	return new_glyph.sprite;

   460

}

   461

   462

   463

uint GetGlyphWidth(FontSize size, WChar key)

   464

{

   465

	FT_Face face = GetFontFace(size);

   466

	GlyphEntry *glyph;

   467

   468

	if (face == NULL || (key >= SCC_SPRITE_START && key <= SCC_SPRITE_END)) {

   469

		SpriteID sprite = GetUnicodeGlyph(size, key);

   470

		if (sprite == 0) sprite = GetUnicodeGlyph(size, '?');

   471

		return SpriteExists(sprite) ? GetSprite(sprite)->width + (size != FS_NORMAL) : 0;

   472

	}

   473

   474

	glyph = GetGlyphPtr(size, key);

   475

	if (glyph == NULL || glyph->sprite == NULL) {

   476

		GetGlyph(size, key);

   477

		glyph = GetGlyphPtr(size, key);

   478

	}

   479

   480

	return glyph->width;

   481

}

   482

   483

   484

#endif /* WITH_FREETYPE */

   485

   486

/* Sprite based glyph mapping */

   487

   488

#include "table/unicode.h"

   489

   490

static SpriteID **_unicode_glyph_map[FS_END];

   491

   492

   493

/** Get the SpriteID of the first glyph for the given font size */

   494

static SpriteID GetFontBase(FontSize size)

   495

{

   496

	switch (size) {

   497

		default: NOT_REACHED();

   498

		case FS_NORMAL: return SPR_ASCII_SPACE;

   499

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   500

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   501

	}

   502

}

   503

   504