Add font index, support font family variants depending on language

Add `fonts/index.json` which specifies:

- List of all font files that should be loaded (filenames).
- Default font (specified by family name or by family and style name).
- Font variants for different languages, using the name of the language file as key.
- Fallback fonts.
- Icon font.

There are characters (e.g. all in `刃直海角骨入`) that look different depending on the language of the content being Japanese, Simplified Chinese, Traditional Chinese and Hangul, because Unicode uses the same codepoint for characters regardless of the language. To render these characters correctly, the active variant font is switched depending on the selected language.

The `ITextRender` interface is changed so the current language variant can be set using `SetFontLanguageVariant` and the default and icon fonts can be toggled using `SetFontPreset`. The class `CFont` is removed entirely.

The text render is restructured: The font faces and font atlas are now managed by a separate class `CGlyphMap` like on upstream. As the text fill and outline textures always have the same size, the texture skyline only needs to be stored once and free positions in the atlas only need to be calculated once for each glyph instead of separately for the fill and outline textures.

The font files and their licenses are also updated:

- Update Source Han Sans to version 2.001.
- Update Glow Sans Japanese Compressed to version 0.93.
- Update Deja Vu Sans to version 2.37.
- Update Font Awesome icons font to March 2023 version.

Closes ddnet#6881.

.gitignore

@@ -119,7 +119,6 @@ tags
 *.exe
 *.fifo
 *.filters
-*.json
 *.lnk
 *.log
 *.opensdf

CMakeLists.txt

@@ -1451,9 +1451,10 @@ set(EXPECTED_DATA
  emoticons.png
  extras.png
  fonts/DejaVuSans.ttf
- fonts/GlowSansJCompressed-Book.otf
- fonts/Icons.otf
- fonts/SourceHanSansSC-Regular.otf
+ fonts/Font_Awesome_6_Free-Solid-900.otf
+ fonts/GlowSansJ-Compressed-Book.otf
+ fonts/SourceHanSans.ttc
+ fonts/index.json
  game.png
  gui_buttons.png
  gui_cursor.png
@@ -1731,7 +1732,7 @@ set(EXPECTED_DATA
  wordlist.txt
 )
 
-set_glob(DATA GLOB_RECURSE "cfg;frag;json;map;otf;png;rules;ttf;txt;vert;wv" data ${EXPECTED_DATA})
+set_glob(DATA GLOB_RECURSE "cfg;frag;json;map;otf;png;rules;ttc;ttf;txt;vert;wv" data ${EXPECTED_DATA})
 
 ########################################################################
 # COPY DATA AND SHARED LIBS

data/fonts/index.json

@@ -0,0 +1,19 @@
+{
+ "font files": [
+ "DejaVuSans.ttf",
+ "Font_Awesome_6_Free-Solid-900.otf",
+ "GlowSansJ-Compressed-Book.otf",
+ "SourceHanSans.ttc"
+ ],
+ "default": "DejaVu Sans",
+ "language variants": {
+ "japanese": "Glow Sans J Compressed Book",
+ "korean": "Source Han Sans K",
+ "simplified_chinese": "Source Han Sans SC",
+ "traditional_chinese": "Source Han Sans TC"
+ },
+ "fallbacks": [
+ "Source Han Sans"
+ ],
+ "icon": "Font Awesome 6 Free"
+}

license.txt

@@ -23,19 +23,44 @@ freely, subject to the following restrictions:
 All content under 'data' except the assets, font, language & skin files,
 (which have their own licenses) are released under
 CC-BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0/).
-SIL OFL 1.1 License for the 'Icon.otf' ('Font Awesome 6 Free-Solid-900.otf') file:
 
-Copyright (c) 2022 Fonticons, Inc. (https://fontawesome.com)
+DejaVuSans.ttf:
+---------------
+
+Fonts are (c) Bitstream (see below). DejaVu changes are in public domain.
+Glyphs imported from Arev fonts are (c) Tavmjong Bah (see below)
+
+Font_Awesome_6_Free-Solid-900.otf:
+----------------------------------
+
+Copyright (c) 2023 Fonticons, Inc. (https://fontawesome.com)
 with Reserved Font Name: "Font Awesome".
 
 This Font Software is licensed under the SIL Open Font License, Version 1.1.
 This license is copied below, and is also available with a FAQ at:
 http://scripts.sil.org/OFL
 
-SIL OPEN FONT LICENSE
-Version 1.1 - 26 February 2007
+GlowSansJ-Compressed-Book.otf:
+------------------------------
+
+© 2020 Project Wêlai
+
+Developer: Celestial Phineas
 
-The other fonts are released under CC-BY-SA 3.0 (https://creativecommons.org/licenses/by-sa/3.0/).
+Glow Sans fonts are released under SIL Open Font License 1.1.
+
+SourceHanSans.ttc:
+------------------
+
+Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font
+Name 'Source'. Source is a trademark of Adobe in the United States
+and/or other countries.
+
+This Font Software is licensed under the SIL Open Font License,
+Version 1.1.
+
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
 
 ------------------------------------------------------------------------
 
@@ -47,3 +72,189 @@ check the individual libraries.
 
 With that being said, contact us if there is anything you want to do
 that the license does not permit.
+
+------------------------------------------------------------------------
+
+
+SIL OPEN FONT LICENSE
+---------------------
+Version 1.1 - 26 February 2007
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting — in part or in whole — any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
+
+
+Bitstream Vera Fonts Copyright
+------------------------------
+
+Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream Vera is
+a trademark of Bitstream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of the fonts accompanying this license ("Fonts") and associated
+documentation files (the "Font Software"), to reproduce and distribute the
+Font Software, including without limitation the rights to use, copy, merge,
+publish, distribute, and/or sell copies of the Font Software, and to permit
+persons to whom the Font Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright and trademark notices and this permission notice shall
+be included in all copies of one or more of the Font Software typefaces.
+
+The Font Software may be modified, altered, or added to, and in particular
+the designs of glyphs or characters in the Fonts may be modified and
+additional glyphs or characters may be added to the Fonts, only if the fonts
+are renamed to names not containing either the words "Bitstream" or the word
+"Vera".
+
+This License becomes null and void to the extent applicable to Fonts or Font
+Software that has been modified and is distributed under the "Bitstream
+Vera" names.
+
+The Font Software may be sold as part of a larger software package but no
+copy of one or more of the Font Software typefaces may be sold by itself.
+
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT,
+TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME
+FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING
+ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
+THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE
+FONT SOFTWARE.
+
+Except as contained in this notice, the names of Gnome, the Gnome
+Foundation, and Bitstream Inc., shall not be used in advertising or
+otherwise to promote the sale, use or other dealings in this Font Software
+without prior written authorization from the Gnome Foundation or Bitstream
+Inc., respectively. For further information, contact: fonts at gnome dot
+org.
+
+Arev Fonts Copyright
+------------------------------
+
+Copyright (c) 2006 by Tavmjong Bah. All Rights Reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the fonts accompanying this license ("Fonts") and
+associated documentation files (the "Font Software"), to reproduce
+and distribute the modifications to the Bitstream Vera Font Software,
+including without limitation the rights to use, copy, merge, publish,
+distribute, and/or sell copies of the Font Software, and to permit
+persons to whom the Font Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright and trademark notices and this permission notice
+shall be included in all copies of one or more of the Font Software
+typefaces.
+
+The Font Software may be modified, altered, or added to, and in
+particular the designs of glyphs or characters in the Fonts may be
+modified and additional glyphs or characters may be added to the
+Fonts, only if the fonts are renamed to names not containing either
+the words "Tavmjong Bah" or the word "Arev".
+
+This License becomes null and void to the extent applicable to Fonts
+or Font Software that has been modified and is distributed under the
+"Tavmjong Bah Arev" names.
+
+The Font Software may be sold as part of a larger software package but
+no copy of one or more of the Font Software typefaces may be sold by
+itself.
+
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL
+TAVMJONG BAH BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
+
+Except as contained in this notice, the name of Tavmjong Bah shall not
+be used in advertising or otherwise to promote the sale, use or other
+dealings in this Font Software without prior written authorization
+from Tavmjong Bah. For further information, contact: tavmjong @ free
+. fr.

src/engine/client.h

@@ -180,7 +180,6 @@ class IClient : public IInterface
  virtual void SwitchWindowScreen(int Index) = 0;
  virtual void SetWindowParams(int FullscreenMode, bool IsBorderless, bool AllowResizing) = 0;
  virtual void ToggleWindowVSync() = 0;
- virtual void LoadFont() = 0;
  virtual void Notify(const char *pTitle, const char *pMessage) = 0;
 
  virtual void UpdateAndSwap() = 0;

src/engine/client/client.cpp

@@ -3035,8 +3035,9 @@ void CClient::Run()
  }
 #endif
 
- // init font rendering
- Kernel()->RequestInterface<IEngineTextRender>()->Init();
+ // init text render
+ IEngineTextRender *pTextRender = Kernel()->RequestInterface<IEngineTextRender>();
+ pTextRender->Init();
 
  // init the input
  Input()->Init();
@@ -3393,6 +3394,9 @@ void CClient::Run()
  m_aNetClient[i].Close();
 
  delete m_pEditor;
+
+ // shutdown text render while graphics are still available
+ pTextRender->Shutdown();
 }
 
 bool CClient::InitNetworkClient(char *pError, size_t ErrorSize)
@@ -4272,61 +4276,6 @@ void CClient::ToggleWindowVSync()
  g_Config.m_GfxVsync ^= 1;
 }
 
-void CClient::LoadFont()
-{
- static CFont *pDefaultFont = 0;
- char aFilename[IO_MAX_PATH_LENGTH];
- char aBuff[1024];
- const char *pFontFile = "fonts/DejaVuSans.ttf";
- const char *apFallbackFontFiles[] =
- {
- "fonts/GlowSansJCompressed-Book.otf",
- "fonts/SourceHanSansSC-Regular.otf",
- };
- IOHANDLE File = Storage()->OpenFile(pFontFile, IOFLAG_READ, IStorage::TYPE_ALL, aFilename, sizeof(aFilename));
- if(File)
- {
- IEngineTextRender *pTextRender = Kernel()->RequestInterface<IEngineTextRender>();
- pDefaultFont = pTextRender->GetFont(aFilename);
- if(pDefaultFont == NULL)
- {
- void *pBuf;
- unsigned Size;
- io_read_all(File, &pBuf, &Size);
- pDefaultFont = pTextRender->LoadFont(aFilename, (unsigned char *)pBuf, Size);
- }
- io_close(File);
-
- for(auto &pFallbackFontFile : apFallbackFontFiles)
- {
- bool FontLoaded = false;
- File = Storage()->OpenFile(pFallbackFontFile, IOFLAG_READ, IStorage::TYPE_ALL, aFilename, sizeof(aFilename));
- if(File)
- {
- void *pBuf;
- unsigned Size;
- io_read_all(File, &pBuf, &Size);
- io_close(File);
- FontLoaded = pTextRender->LoadFallbackFont(pDefaultFont, aFilename, (unsigned char *)pBuf, Size);
- }
-
- if(!FontLoaded)
- {
- str_format(aBuff, std::size(aBuff), "failed to load the fallback font. filename='%s'", pFallbackFontFile);
- m_pConsole->Print(IConsole::OUTPUT_LEVEL_STANDARD, "gameclient", aBuff);
- }
- }
-
- pTextRender->SetDefaultFont(pDefaultFont);
- }
-
- if(!pDefaultFont)
- {
- str_format(aBuff, std::size(aBuff), "failed to load font. filename='%s'", pFontFile);
- m_pConsole->Print(IConsole::OUTPUT_LEVEL_STANDARD, "gameclient", aBuff);
- }
-}
-
 void CClient::Notify(const char *pTitle, const char *pMessage)
 {
  if(m_pGraphics->WindowActive() || !g_Config.m_ClShowNotifications)

src/engine/client/client.h

@@ -506,7 +506,6 @@ class CClient : public IClient, public CDemoPlayer::IListener
  void SwitchWindowScreen(int Index) override;
  void SetWindowParams(int FullscreenMode, bool IsBorderless, bool AllowResizing) override;
  void ToggleWindowVSync() override;
- void LoadFont() override;
  void Notify(const char *pTitle, const char *pMessage) override;
  void BenchmarkQuit(int Seconds, const char *pFilename);