Use Lato on MacOS and Windows (#580)

As described in #214, we want to use the OFL-licensed font
Lato for all components in Surge with the constraint that we
want to ship the font with the DLL and not require it to be installed
on an end users system.

To do this cross platforms, introduce a new C++ file
"RuntimeFont.h" which defines Surge::GUI::initializeRuntimeFontFromDistribution
and implement that in src/mac/RuntimeFontMac.cpp, Windows, etc.
This PR implements for Mac and Win and neither implements
nor references the symbol in Linux.

This change implements that in macOS by doing the following

1: Introducing the font to resources/fonts
2: Moving the fonts to the bundle with scripts/macOS/package*
3: Moving the font initiation for minifont and patchfont to
   runtime rather than surge dll load time (but only do this
   for fonts which USE_RUNTIME_LOADED_FONTS, which right now
   is only MAC. Once all platforms are done, that switch will
   disappear)
4: Write the MacOS specific CoreText code to load a font from
   memory into the system

This change implements that in Windows by doing the following

1: Including the font in the .rc file and subsequent res bundle
as a binary
2: Load the font and place it in a well known temp file
3: Load that temp file into the font registry using AddFontResource
4: Following the subsequent standard cfont implementation.

Closes #214

premake5.lua

@@ -283,6 +283,7 @@ function plugincommon()
             "CoreAudio.framework",
             "CoreAudioKit.framework",
             "CoreServices.framework",
+            "CoreText.framework",
             "Cocoa.framework",
             "CoreFoundation.framework",
             "OpenGL.framework",
@@ -350,6 +351,7 @@ function plugincommon()
             "src/windows/scalableui.rc",
             "resources/bitmaps/*.png",
             "assets/original-vector/exported/*.png",
+            "resources/fonts/**.ttf",
             VSTGUI .. "vstgui_win32.cpp",
             VSTGUI .. "vstgui_uidescription_win32.cpp",
         }
@@ -596,7 +598,7 @@ if (os.istarget("macosx")) then
     files
     {
         "src/au/**.cpp",
-                "src/au/**.mm",
+        "src/au/**.mm",
         "src/au/**.h",
         "libs/AUPublic/**.cpp",
         "libs/AUPublic/**.h",
@@ -714,6 +716,8 @@ if (os.istarget("macosx")) then
       VSTGUI .. "vstgui_uidescription_mac.mm",
       "src/mac/DisplayInfoMac.mm",
       "src/mac/UserInteractionsMac.cpp",
+      "src/mac/cocoa_utils.mm",
+      "src/mac/RuntimeFontMac.cpp"
    }
 end
 
@@ -724,6 +728,7 @@ if (os.istarget("windows")) then
       VSTGUI .. "vstgui_uidescription_win32.cpp",
       "src/windows/DisplayInfoWin.cpp",
       "src/windows/UserInteractionsWin.cpp",
+      "src/windows/RuntimeFontWin.cpp"
    }
 end
 

resources/fonts/OFL.txt

@@ -0,0 +1,94 @@
+Copyright (c) 2010-2015, Łukasz Dziedzic ([email protected]),
+with Reserved Font Name Lato.
+
+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
+-----------------------------------------------------------
+
+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.

resources/fonts/README.txt

@@ -0,0 +1,72 @@
+
+Lato font family (Desktop version)
+
+==================================
+
+Version 2.015; Latin+Cyrillic+Greek+IPA opensource
+
+Created by: tyPoland Lukasz Dziedzic
+Creation year: 2015
+
+Copyright (c) 2010-2015 by tyPoland Lukasz Dziedzic with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1.
+
+Lato is a trademark of tyPoland Lukasz Dziedzic.
+
+Source URL: http://www.latofonts.com/
+License URL: http://scripts.sil.org/OFL
+
+================
+
+Lato is a sanserif typeface family designed in the Summer 2010 and extended in the Summer 2013 by Warsaw-based designer Lukasz Dziedzic ("Lato" means "Summer" in Polish). It tries to carefully balance some potentially conflicting priorities: it should seem quite "transparent" when used in body text but would display some original traits when used in larger sizes. The classical proportions, particularly visible in the uppercase, give the letterforms familiar harmony and elegance. At the same time, its sleek sanserif look makes evident the fact that Lato was designed in the 2010s, even though it does not follow any current trend. The semi-rounded details of the letters give Lato a feeling of warmth, while the strong structure provides stability and seriousness. In 2013-2014, the family was greatly extended (with the help of Adam Twardoch and Botio Nikoltchev) to cover 3000+ glyphs over nine weights with italics. It now supports 100+ Latin-based languages, 50+ Cyrillic-based languages as well as Greek and IPA phonetics. The Lato fonts are available free of charge under the SIL Open Font License from http://www.latofonts.com/
+
+================
+
+CONTENTS: 
+
+This folder contains 18 font files in OpenType TT (.ttf) format. You can install these fonts on your computer and use in any desktop applications (such as Word, InDesign, Illustrator, Photoshop, Keynote or Pages). 
+
+================
+
+REVISION LOG:
+
+# Version 2.015 (2015-08-06)
+Initial implementation of mark positioning (should work for most glyphs)
+Autohinted using ttfautohint 1.3.
+
+# Version 2.010 (2014-09-01)
+Improved some contour bugs and diacritics positioning. 
+Improved outline quality.
+Revised OTL features so that they work in browsers (ot-sanitise).
+Autohinted using ttfautohint 1.1.
+Interpolated the Medium weight differently so it provides more visual difference from Regular.
+
+# Version 2.007 (2014-02-27)
+Greatly expanded character set, revised metrics, four additional weights.
+
+# Version 1.104 (2011-11-08)
+Merged the distribution again
+Autohinted with updated ttfautohint 0.4 (which no longer causes Adobe and iOS problems) 
+except the Hai and Lig weights which are hinted in FLS 5.1.
+
+# Version 1.102 (2011-10-28)
+Added OpenType Layout features
+Ssplit between desktop and web versions
+Desktop version: all weights autohinted with FontLab Studio
+Web version autohinted with ttfautohint 0.4 except the Hai and Lig weights
+
+# Version 1.101 (2011-09-30)
+Fixed OS/2 table Unicode and codepage entries
+
+# Version 1.100 (2011-09-12)
+Added Polish diacritics to the character set
+Weights Hai and Lig autohinted with FontLab Studio
+Other weights autohinted with ttfautohint 0.3
+
+# Version 1.011 (2010-12-29)
+Added the soft hyphen glyph
+
+# Version 1.010 (2010-12-13)
+Initial version released under SIL Open Font License
+Western character set
+
+================

scripts/macOS/package-au.sh

@@ -9,6 +9,7 @@ fi
 RES_SRC_LOCATION="resources"
 PACKAGE_SRC_LOCATION="$RES_SRC_LOCATION/osx-au"
 BITMAP_SRC_LOCATION="$RES_SRC_LOCATION/bitmaps"
+FONT_SRC_LOCATION="$RES_SRC_LOCATION/fonts"
 VECTOR_BITMAP_SRC_LOCATION="assets/${SURGE_USE_VECTOR_SKIN}/exported"
 BUNDLE_RES_SRC_LOCATION="$RES_SRC_LOCATION/osx-resources"
 EXEC_LOCATION="target/au/Release/Surge.dylib"
@@ -48,3 +49,6 @@ else
     cp $VECTOR_BITMAP_SRC_LOCATION/*png "$BUNDLE_DIR/Contents/Resources/scalable"
 fi
 
+
+mkdir "$BUNDLE_DIR/Contents/Resources/fonts";
+cp $FONT_SRC_LOCATION/* "$BUNDLE_DIR/Contents/Resources/fonts";

scripts/macOS/package-vst.sh

@@ -10,6 +10,7 @@ RES_SRC_LOCATION="resources"
 PACKAGE_SRC_LOCATION="$RES_SRC_LOCATION/osx-vst2"
 BITMAP_SRC_LOCATION="$RES_SRC_LOCATION/bitmaps"
 VECTOR_BITMAP_SRC_LOCATION="assets/${SURGE_USE_VECTOR_SKIN}/exported"
+FONT_SRC_LOCATION="$RES_SRC_LOCATION/fonts"
 BUNDLE_RES_SRC_LOCATION="$RES_SRC_LOCATION/osx-resources"
 EXEC_LOCATION="target/vst2/Release/Surge.dylib"
 #EXEC_LOCATION="target/vst2/Debug/Surge-Debug.dylib"
@@ -48,4 +49,6 @@ else
     cp $VECTOR_BITMAP_SRC_LOCATION/*png "$BUNDLE_DIR/Contents/Resources/scalable"
 fi
 
+mkdir "$BUNDLE_DIR/Contents/Resources/fonts";
+cp $FONT_SRC_LOCATION/* "$BUNDLE_DIR/Contents/Resources/fonts";
 

scripts/macOS/package-vst3.sh

@@ -9,6 +9,7 @@ fi
 RES_SRC_LOCATION="resources"
 PACKAGE_SRC_LOCATION="$RES_SRC_LOCATION/osx-vst3"
 BITMAP_SRC_LOCATION="$RES_SRC_LOCATION/bitmaps"
+FONT_SRC_LOCATION="$RES_SRC_LOCATION/fonts"
 VECTOR_BITMAP_SRC_LOCATION="assets/${SURGE_USE_VECTOR_SKIN}/exported"
 BUNDLE_RES_SRC_LOCATION="$RES_SRC_LOCATION/osx-resources"
 EXEC_LOCATION="target/vst3/Release/Surge.dylib"
@@ -48,3 +49,5 @@ else
     cp $VECTOR_BITMAP_SRC_LOCATION/*png "$BUNDLE_DIR/Contents/Resources/scalable"
 fi
 
+mkdir "$BUNDLE_DIR/Contents/Resources/fonts";
+cp $FONT_SRC_LOCATION/* "$BUNDLE_DIR/Contents/Resources/fonts";

src/common/gui/RuntimeFont.h

@@ -0,0 +1,33 @@
+#pragma once
+
+#include "vstgui/vstgui.h"
+#include "vstgui/lib/cfont.h"
+#include "vstgui/lib/platform/iplatformfont.h"
+
+namespace Surge
+{
+namespace GUI
+{
+
+/**
+ * initializeRuntimeFont
+ *
+ * The role of this function is to load a font from the bundle, dll, or some other
+ * source. Once the font file is loaded, it is used to create the VSTGUI 9 and 14 point 
+ * fonts in global variables "surge_minifont" and "surge_patchfont" if they are NULL
+ * at calltime. The "surge_minifont" is used for most text rendering and the
+ * "surge_patchfont" is used for the patchname.
+ *
+ * The implementation is OS Specific.
+ */
+void initializeRuntimeFont();
+
+}
+}
+
+/*
+** The two extern globals we need to initialize, which are defined/created
+** in SurgeGuieditor
+*/
+extern VSTGUI::CFontRef surge_minifont;
+extern VSTGUI::CFontRef surge_patchfont;

src/common/gui/SurgeGUIEditor.cpp

@@ -30,19 +30,28 @@
 #if TARGET_AUDIOUNIT
 #include "aulayer.h"
 #endif
-/*
-#elif TARGET_VST3
-#include "surgeprocessor.h"
-#elif TARGET_VST2
-#include "vstlayer.h"
-#endif*/
-
-//#include <commctrl.h>
+
+#if MAC || WINDOWS
+#define USE_RUNTIME_LOADED_FONTS 1
+#else
+#define USE_RUNTIME_LOADED_FONTS 0
+#endif
+
+#if USE_RUNTIME_LOADED_FONTS
+#include "RuntimeFont.h"
+#endif
+
 const int yofs = 10;
 
 using namespace VSTGUI;
 using namespace std;
 
+
+#if USE_RUNTIME_LOADED_FONTS
+CFontRef surge_minifont = NULL;
+CFontRef surge_patchfont = NULL;
+#else
+
 #if MAC
 SharedPointer<CFontDesc> minifont = new CFontDesc("Lucida Grande", 9);
 SharedPointer<CFontDesc> patchfont = new CFontDesc("Lucida Grande", 14);
@@ -56,6 +65,7 @@ SharedPointer<CFontDesc> patchfont = new CFontDesc("Arial", 14);
 
 CFontRef surge_minifont = minifont;
 CFontRef surge_patchfont = patchfont;
+#endif
 
 
 enum special_tags
@@ -143,6 +153,46 @@ SurgeGUIEditor::SurgeGUIEditor(void* effect, SurgeSynthesizer* synth) : super(ef
 #endif
    zoom_callback = [](SurgeGUIEditor* f) {};
    setZoomFactor(100);
+
+
+#if USE_RUNTIME_LOADED_FONTS
+   /*
+   ** As documented in RuntimeFonts.h, the contract of this function is to side-effect
+   ** onto globals surge_minifont and surge_patchfont with valid fonts from the runtime
+   ** distribution
+   */
+   Surge::GUI::initializeRuntimeFont();
+
+   if (surge_minifont == NULL)
+   {
+       /*
+       ** OK the runtime load didn't work. Fall back to
+       ** the old defaults
+       **
+       ** FIXME: One day we will be confident enough in
+       ** our dyna loader to make this a Surge::UserInteraction::promptError
+       ** warning also.
+       ** 
+       ** For now, copy the defaults from above. (Don't factor this into
+       ** a function since the above defaults are initialized as dll
+       ** statics if we are not runtime).
+       */
+#if MAC
+       SharedPointer<CFontDesc> minifont = new CFontDesc("Lucida Grande", 9);
+       SharedPointer<CFontDesc> patchfont = new CFontDesc("Lucida Grande", 14);
+#elif LINUX
+       SharedPointer<CFontDesc> minifont = new CFontDesc("sans-serif", 9);
+       SharedPointer<CFontDesc> patchfont = new CFontDesc("sans-serif", 14);
+#else
+       SharedPointer<CFontDesc> minifont = new CFontDesc("Microsoft Sans Serif", 9);
+       SharedPointer<CFontDesc> patchfont = new CFontDesc("Arial", 14);
+#endif
+
+       surge_minifont = minifont;
+       surge_patchfont = patchfont;
+
+   }
+#endif
 }
 
 SurgeGUIEditor::~SurgeGUIEditor()

src/common/resource.h

@@ -60,6 +60,8 @@
 #define IDC_AUTHOR 1004
 #define IDC_TEDIT 1024
 
+#define IDR_LATO_FONT 501
+
 // Next default values for new objects
 //
 #ifdef APSTUDIO_INVOKED
@@ -87,4 +89,5 @@
 #define SCALABLE_400_OFFSET 74000
 
 #include "scalableresource.h" // found in src/windows
+
 #endif