1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "macros.h"

     7

#include "debug.h"

     8

#include "table/sprites.h"

     9

#include "table/control_codes.h"

    10

#include "spritecache.h"

    11

#include "gfx.h"

    12

#include "string.h"

    13

#include "fontcache.h"

    14

    15

#ifdef WITH_FREETYPE

    16

    17

#include <ft2build.h>

    18

#include FT_FREETYPE_H

    19

#include FT_GLYPH_H

    20

    21

#ifdef WITH_FONTCONFIG

    22

#include <fontconfig/fontconfig.h>

    23

#endif

    24

    25

static FT_Library _library = NULL;

    26

static FT_Face _face_small = NULL;

    27

static FT_Face _face_medium = NULL;

    28

static FT_Face _face_large = NULL;

    29

    30

FreeTypeSettings _freetype;

    31

    32

enum {

    33

	FACE_COLOUR = 1,

    34

	SHADOW_COLOUR = 2,

    35

};

    36

    37

    38

/**

    39

 * Loads the freetype font.

    40

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

    41

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

    42

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

    43

 */

    44

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

    45

{

    46

	FT_Error error;

    47

    48

	if (strlen(font_name) == 0) return;

    49

    50

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

    51

#ifdef WITH_FONTCONFIG

    52

	/* Failed to load the font, so try it with fontconfig */

    53

	if (error != FT_Err_Ok) {

    54

		if (!FcInit()) {

    55

 			ShowInfoF("Unable to load font configuration");

    56

		} else {

    57

			FcPattern *match;

    58

			FcPattern *pat;

    59

			FcFontSet *fs;

    60

			FcResult  result;

    61

			char *font_style;

    62

			char *font_family;

    63

    64

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

    65

			font_family = strdup(font_name);

    66

			font_style = strchr(font_family, ',');

    67

			if (font_style != NULL) {

    68

				font_style[0] = '\0';

    69

				font_style++;

    70

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

    71

			}

    72

    73

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

    74

			pat = FcNameParse((FcChar8*)font_family);

    75

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

    76

			FcConfigSubstitute(0, pat, FcMatchPattern);

    77

			FcDefaultSubstitute(pat);

    78

			fs = FcFontSetCreate();

    79

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

    80

    81

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

    82

				int i;

    83

				FcChar8 *family;

    84

				FcChar8 *style;

    85

				FcChar8 *file;

    86

				FcFontSetAdd(fs, match);

    87

    88

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

    89

					/* Try the new filename */

    90

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

    91

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

    92

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

    93

    94

						/* The correct style? */

    95

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

    96

    97

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

    98

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

    99

						* same as the supplied name */

   100

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

   101

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

   102

						}

   103

					}

   104

				}

   105

			}

   106

   107

			free(font_family);

   108

			FcPatternDestroy(pat);

   109

			FcFontSetDestroy(fs);

   110

			FcFini();

   111

		}

   112

	}

   113

#endif

   114

	if (error == FT_Err_Ok) {

   115

		/* Attempt to select the unicode character map */

   116

		error = FT_Select_Charmap(*face, ft_encoding_unicode);

   117

		if (error == FT_Err_Ok) {

   118

			/* Success */

   119

			return;

   120

		} else if (error == FT_Err_Invalid_CharMap_Handle) {

   121

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

   122

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

   123

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

   124

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

   125

			int i;

   126

   127

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

   128

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

   129

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

   130

					found = charmap;

   131

				}

   132

			}

   133

   134

			if (found != NULL) {

   135

				error = FT_Set_Charmap(*face, found);

   136

				if (error == FT_Err_Ok) return;

   137

			}

   138

		}

   139

   140

		FT_Done_Face(*face);

   141

		*face = NULL;

   142

	}

   143

   144

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

   145

}

   146

   147

   148

void InitFreeType(void)

   149

{

   150

	if (strlen(_freetype.small_font) == 0 && strlen(_freetype.medium_font) == 0 && strlen(_freetype.large_font) == 0) {

   151

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

   152

		return;

   153

	}

   154

   155

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

   156

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

   157

		return;

   158

	}

   159

   160

	DEBUG(freetype, 2) ("[FreeType] Initialized");

   161

   162

	/* Load each font */

   163

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

   164

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

   165

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

   166

   167

	/* Set each font size */

   168

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

   169

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

   170

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

   171

}

   172

   173

   174

static FT_Face GetFontFace(FontSize size)

   175

{

   176

	switch (size) {

   177

		default: NOT_REACHED();

   178

		case FS_NORMAL: return _face_medium;

   179

		case FS_SMALL:  return _face_small;

   180

		case FS_LARGE:  return _face_large;

   181

	}

   182

}

   183

   184

   185

typedef struct GlyphEntry {

   186

	Sprite *sprite;

   187

	byte width;

   188

} GlyphEntry;

   189

   190

   191

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

   192

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

   193

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

   194

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

   195

 *

   196

 * The cache is accessed in the following way:

   197

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

   198

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

   199

 *

   200

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

   201

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

   202

 */

   203

static GlyphEntry **_glyph_ptr[FS_END];

   204

   205

   206

static GlyphEntry *GetGlyphPtr(FontSize size, WChar key)

   207

{

   208

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

   209

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

   210

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

   211

}

   212

   213

   214

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

   215

{

   216

	if (_glyph_ptr[size] == NULL) {

   217

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

   218

		_glyph_ptr[size] = calloc(256, sizeof(**_glyph_ptr));

   219

	}

   220

   221

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

   222

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

   223

		_glyph_ptr[size][GB(key, 8, 8)] = calloc(256, sizeof(***_glyph_ptr));

   224

	}

   225

   226

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

   227

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

   228

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

   229

}

   230

   231

   232

const Sprite *GetGlyph(FontSize size, WChar key)

   233

{

   234

	FT_Face face = GetFontFace(size);

   235

	FT_GlyphSlot slot;

   236

	GlyphEntry new_glyph;

   237

	GlyphEntry *glyph;

   238

	Sprite *sprite;

   239

	int width;

   240

	int height;

   241

	int x;

   242

	int y;

   243

	int y_adj;

   244

   245

	assert(IsPrintable(key));

   246

   247

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

   248

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

   249

		SpriteID sprite = GetUnicodeGlyph(size, key);

   250

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

   251

		return GetSprite(sprite);

   252

	}

   253

   254

	/* Check for the glyph in our cache */

   255

	glyph = GetGlyphPtr(size, key);

   256

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

   257

   258

	slot = face->glyph;

   259

   260

	FT_Load_Char(face, key, FT_LOAD_DEFAULT);

   261

	FT_Render_Glyph(face->glyph, FT_RENDER_MODE_MONO);

   262

   263

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

   264

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

   265

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

   266

   267

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

   268

	sprite = calloc(width * height + 8, 1);

   269

	sprite->info   = 1;

   270

	sprite->width  = width;

   271

	sprite->height = height;

   272

	sprite->x_offs = slot->bitmap_left;

   273

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

   274

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

   275

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

   276

   277

	/* Draw shadow for medium size */

   278

	if (size == FS_NORMAL) {

   279

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

   280

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

   281

				if (HASBIT(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   282

					sprite->data[1 + x + (1 + y) * sprite->width] = SHADOW_COLOUR;

   283

				}

   284

			}

   285

		}

   286

	}

   287

   288

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

   289

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

   290

			if (HASBIT(slot->bitmap.buffer[(x / 8) + y * slot->bitmap.pitch], 7 - (x % 8))) {

   291

				sprite->data[x + y * sprite->width] = FACE_COLOUR;

   292

			}

   293

		}

   294

	}

   295

   296

	new_glyph.sprite = sprite;

   297

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

   298

   299

	SetGlyphPtr(size, key, &new_glyph);

   300

   301

	return sprite;

   302

}

   303

   304

   305

uint GetGlyphWidth(FontSize size, WChar key)

   306

{

   307

	FT_Face face = GetFontFace(size);

   308

	GlyphEntry *glyph;

   309

   310

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

   311

		SpriteID sprite = GetUnicodeGlyph(size, key);

   312

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

   313

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

   314

	}

   315

   316

	glyph = GetGlyphPtr(size, key);

   317

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

   318

		GetGlyph(size, key);

   319

		glyph = GetGlyphPtr(size, key);

   320

	}

   321

   322

	return glyph->width;

   323

}

   324

   325

   326

#endif /* WITH_FREETYPE */

   327

   328

/* Sprite based glyph mapping */

   329

   330

#include "table/unicode.h"

   331

   332

static SpriteID **_unicode_glyph_map[FS_END];

   333

   334

   335

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

   336

static SpriteID GetFontBase(FontSize size)

   337

{

   338

	switch (size) {

   339

		default: NOT_REACHED();

   340

		case FS_NORMAL: return SPR_ASCII_SPACE;

   341

		case FS_SMALL:  return SPR_ASCII_SPACE_SMALL;

   342

		case FS_LARGE:  return SPR_ASCII_SPACE_BIG;

   343

	}

   344

}

   345

   346

   347

SpriteID GetUnicodeGlyph(FontSize size, uint32 key)

   348

{

   349

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

   350

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

   351

}

   352

   353

   354

void SetUnicodeGlyph(FontSize size, uint32 key, SpriteID sprite)

   355

{

   356

	if (_unicode_glyph_map[size] == NULL) _unicode_glyph_map[size] = calloc(256, sizeof(*_unicode_glyph_map[size]));

   357

	if (_unicode_glyph_map[size][GB(key, 8, 8)] == NULL) _unicode_glyph_map[size][GB(key, 8, 8)] = calloc(256, sizeof(**_unicode_glyph_map[size]));

   358

	_unicode_glyph_map[size][GB(key, 8, 8)][GB(key, 0, 8)] = sprite;

   359

}

   360

   361

   362

void InitializeUnicodeGlyphMap(void)

   363

{

   364

	FontSize size;

   365

	SpriteID base;

   366

	SpriteID sprite;

   367

	uint i;

   368

   369

	for (size = FS_NORMAL; size != FS_END; size++) {

   370

		/* Clear out existing glyph map if it exists */

   371

		if (_unicode_glyph_map[size] != NULL) {

   372

			for (i = 0; i < 256; i++) {

   373

				if (_unicode_glyph_map[size][i] != NULL) free(_unicode_glyph_map[size][i]);

   374

			}

   375

			free(_unicode_glyph_map[size]);

   376

			_unicode_glyph_map[size] = NULL;

   377

		}

   378

   379

		base = GetFontBase(size);

   380

		for (i = ASCII_LETTERSTART; i < 256; i++) {

   381

			sprite = base + i - ASCII_LETTERSTART;

   382

			if (!SpriteExists(sprite)) continue;

   383

			SetUnicodeGlyph(size, i, sprite);

   384

			SetUnicodeGlyph(size, i + SCC_SPRITE_START, sprite);

   385

		}

   386

		for (i = 0; i < lengthof(_default_unicode_map); i++) {

   387

			sprite = base + _default_unicode_map[i].key - ASCII_LETTERSTART;

   388

			SetUnicodeGlyph(size, _default_unicode_map[i].code, sprite);

   389

		}

   390

	}

   391

}

   392