Fast fonts

Author: mark9064

doc/ExternalResources.md

@@ -53,18 +53,17 @@ lv_obj_t* logo = lv_img_create(lv_scr_act(), nullptr);
 lv_img_set_src(logo, "F:/images/logo.bin");
 ```
 
-Load a font from the external resources: you first need to check that the file actually exists. LVGL will crash when trying to open a font that doesn't exist.
+Load a font from the external resources. 
+
+You don't need to check if it exists in the constructor as LVGL can handle the font not existing gracefully (nothing will render).
+However, do check that it exists in the `IsAvailable()` method so users can see when resources are missing (the watchface will not be selectable in the list if `IsAvailable()` returns `false`).
+Remember to free any loaded fonts (with `free()`) in the screen destructor.
 
 ```
 lv_font_t* font_teko = nullptr;
-if (filesystem.FileOpen(&f, "/fonts/font.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_teko = lv_font_load("F:/fonts/font.bin");
-}
+font_teko = Pinetime::Components::FastFont::LoadFont(filesystem, "/fastfonts/teko.bin");
 
-if(font != nullptr) {
-    lv_obj_set_style_local_text_font(label, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, font);
-}
+lv_obj_set_style_local_text_font(label, LV_LABEL_PART_MAIN, LV_STATE_DEFAULT, font_teko);
 
 ```
 

doc/buildAndProgram.md

@@ -7,6 +7,7 @@ To build this project, you'll need:
 - A cross-compiler : [ARM-GCC (10.3-2021.10)](https://developer.arm.com/downloads/-/gnu-rm)
 - The NRF52 SDK 15.3.0 : [nRF-SDK v15.3.0](https://nsscprodmedia.blob.core.windows.net/prod/software-and-other-downloads/sdks/nrf5/binaries/nrf5sdk153059ac345.zip)
 - The Python 3 modules `cbor`, `intelhex`, `click` and `cryptography` modules for the `mcuboot` tool (see [requirements.txt](../tools/mcuboot/requirements.txt))
+- The Python 3 module `pyelftools` to build external resources
   - To keep the system clean, you can install python modules into a python virtual environment (`venv`)
     ```sh
     python -m venv .venv

docker/Dockerfile

@@ -49,6 +49,7 @@ RUN apt-get update -qq \
 RUN pip3 install adafruit-nrfutil
 RUN pip3 install -Iv cryptography==3.3
 RUN pip3 install cbor
+RUN pip3 install pyelftools
 RUN npm i lv_font_conv@1.5.2 -g
 
 # build.sh knows how to compile

src/CMakeLists.txt

@@ -479,6 +479,7 @@ list(APPEND SOURCE_FILES
         FreeRTOS/port_cmsis.c
 
         displayapp/LittleVgl.cpp
+        displayapp/fonts/FastFont.cpp
         displayapp/InfiniTimeTheme.cpp
 
         systemtask/SystemTask.cpp
@@ -666,6 +667,7 @@ set(INCLUDE_FILES
         FreeRTOS/portmacro.h
         FreeRTOS/portmacro_cmsis.h
         displayapp/LittleVgl.h
+        displayapp/fonts/FastFont.h
         displayapp/InfiniTimeTheme.h
         systemtask/SystemTask.h
         systemtask/SystemMonitor.h
@@ -1142,5 +1144,13 @@ endif()
 
 if(BUILD_RESOURCES)
   add_subdirectory(resources)
+  target_compile_options(compiled_fonts PUBLIC
+        ${COMMON_FLAGS}
+        $<$<CONFIG:DEBUG>: ${DEBUG_FLAGS}>
+        $<$<CONFIG:RELEASE>: ${RELEASE_FLAGS}>
+        $<$<COMPILE_LANGUAGE:CXX>: ${CXX_FLAGS}>
+        $<$<COMPILE_LANGUAGE:ASM>: ${ASM_FLAGS}>
+        )
+  set_property(TARGET compiled_fonts PROPERTY INTERPROCEDURAL_OPTIMIZATION FALSE)
 endif()
 

src/displayapp/fonts/FastFont.cpp

@@ -0,0 +1,79 @@
+#include "displayapp/fonts/FastFont.h"
+
+#include "components/fs/FS.h"
+
+#include <type_traits>
+
+using namespace Pinetime::Components;
+
+namespace {
+  template <typename T>
+  void FixPointer(T** ptr, uintptr_t base) {
+    // extremely naughty generic const removal
+    using ConstFreeBase = std::remove_const_t<T>;
+    using ConstFreePtr = std::add_pointer_t<std::add_pointer_t<ConstFreeBase>>;
+    auto ptrStripped = const_cast<ConstFreePtr>(ptr);
+    // reinterpret as a pointer to a pointer, which we can safely add to
+    auto* ptrRaw = reinterpret_cast<uintptr_t*>(ptrStripped);
+    *ptrRaw += base;
+  }
+}
+
+lv_font_t* FastFont::LoadFont(Pinetime::Controllers::FS& filesystem, const char* fontPath) {
+  int ret;
+  lfs_file_t file;
+  ret = filesystem.FileOpen(&file, fontPath, LFS_O_RDONLY);
+  if (ret < 0) {
+    return nullptr;
+  }
+  // Can use stat to get the size, but since the file is open we can grab it from there
+  lfs_size_t size = file.ctz.size;
+  void* fontData = malloc(size);
+  if (fontData == nullptr) {
+    filesystem.FileClose(&file);
+    return nullptr;
+  }
+  ret = filesystem.FileRead(&file, static_cast<uint8_t*>(fontData), size);
+  filesystem.FileClose(&file);
+  if (ret != static_cast<int>(size)) {
+    free(fontData);
+    return nullptr;
+  }
+  auto* font = static_cast<lv_font_t*>(fontData);
+  auto base = reinterpret_cast<uintptr_t>(fontData);
+
+  // Fix LVGL fetch pointers
+  font->get_glyph_dsc = lv_font_get_glyph_dsc_fmt_txt;
+  font->get_glyph_bitmap = lv_font_get_bitmap_fmt_txt;
+
+  // Fix internal pointers
+  FixPointer(&font->dsc, base);
+  auto* font_dsc = static_cast<lv_font_fmt_txt_dsc_t*>(font->dsc);
+  FixPointer(&font_dsc->glyph_bitmap, base);
+  FixPointer(&font_dsc->glyph_dsc, base);
+  FixPointer(&font_dsc->cmaps, base);
+  // cmaps are in RAM, so we can cast away const safely
+  auto* cmaps = const_cast<lv_font_fmt_txt_cmap_t*>(font_dsc->cmaps);
+  for (uint16_t i = 0; i < font_dsc->cmap_num; i++) {
+    if (cmaps[i].glyph_id_ofs_list != nullptr) {
+      FixPointer(&cmaps[i].glyph_id_ofs_list, base);
+    }
+    if (cmaps[i].unicode_list != nullptr) {
+      FixPointer(&cmaps[i].unicode_list, base);
+    }
+  }
+  if (font_dsc->kern_dsc != nullptr) {
+    if (font_dsc->kern_classes == 0) {
+      auto* kern_dsc = static_cast<lv_font_fmt_txt_kern_pair_t*>(const_cast<void*>(font_dsc->kern_dsc));
+      FixPointer(&kern_dsc->glyph_ids, base);
+      FixPointer(&kern_dsc->values, base);
+    } else {
+      auto* kern_dsc = static_cast<lv_font_fmt_txt_kern_classes_t*>(const_cast<void*>(font_dsc->kern_dsc));
+      FixPointer(&kern_dsc->class_pair_values, base);
+      FixPointer(&kern_dsc->left_class_mapping, base);
+      FixPointer(&kern_dsc->right_class_mapping, base);
+    }
+  }
+
+  return font;
+}

src/displayapp/fonts/FastFont.h

@@ -0,0 +1,9 @@
+#include "displayapp/LittleVgl.h"
+
+namespace Pinetime {
+  namespace Components {
+    namespace FastFont {
+      lv_font_t* LoadFont(Pinetime::Controllers::FS& filesystem, const char* fontPath);
+    }
+  }
+}

src/displayapp/screens/WatchFaceCasioStyleG7710.cpp

@@ -12,6 +12,7 @@
 #include "components/heartrate/HeartRateController.h"
 #include "components/motion/MotionController.h"
 #include "components/settings/Settings.h"
+#include "displayapp/fonts/FastFont.h"
 using namespace Pinetime::Applications::Screens;
 
 WatchFaceCasioStyleG7710::WatchFaceCasioStyleG7710(Controllers::DateTime& dateTimeController,
@@ -32,21 +33,9 @@ WatchFaceCasioStyleG7710::WatchFaceCasioStyleG7710(Controllers::DateTime& dateTi
     heartRateController {heartRateController},
     motionController {motionController} {
 
-  lfs_file f = {};
-  if (filesystem.FileOpen(&f, "/fonts/lv_font_dots_40.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_dot40 = lv_font_load("F:/fonts/lv_font_dots_40.bin");
-  }
-
-  if (filesystem.FileOpen(&f, "/fonts/7segments_40.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_segment40 = lv_font_load("F:/fonts/7segments_40.bin");
-  }
-
-  if (filesystem.FileOpen(&f, "/fonts/7segments_115.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_segment115 = lv_font_load("F:/fonts/7segments_115.bin");
-  }
+  font_dot40 = Components::FastFont::LoadFont(filesystem, "/fastfonts/lv_font_dots_40.bin");
+  font_segment40 = Components::FastFont::LoadFont(filesystem, "/fastfonts/seven_segments_40.bin");
+  font_segment115 = Components::FastFont::LoadFont(filesystem, "/fastfonts/seven_segments_115.bin");
 
   label_battery_value = lv_label_create(lv_scr_act(), nullptr);
   lv_obj_align(label_battery_value, lv_scr_act(), LV_ALIGN_IN_TOP_RIGHT, 0, 0);
@@ -179,15 +168,15 @@ WatchFaceCasioStyleG7710::~WatchFaceCasioStyleG7710() {
   lv_style_reset(&style_border);
 
   if (font_dot40 != nullptr) {
-    lv_font_free(font_dot40);
+    free(font_dot40);
   }
 
   if (font_segment40 != nullptr) {
-    lv_font_free(font_segment40);
+    free(font_segment40);
   }
 
   if (font_segment115 != nullptr) {
-    lv_font_free(font_segment115);
+    free(font_segment115);
   }
 
   lv_obj_clean(lv_scr_act());
@@ -315,17 +304,17 @@ void WatchFaceCasioStyleG7710::Refresh() {
 bool WatchFaceCasioStyleG7710::IsAvailable(Pinetime::Controllers::FS& filesystem) {
   lfs_file file = {};
 
-  if (filesystem.FileOpen(&file, "/fonts/lv_font_dots_40.bin", LFS_O_RDONLY) < 0) {
+  if (filesystem.FileOpen(&file, "/fastfonts/lv_font_dots_40.bin", LFS_O_RDONLY) < 0) {
     return false;
   }
 
   filesystem.FileClose(&file);
-  if (filesystem.FileOpen(&file, "/fonts/7segments_40.bin", LFS_O_RDONLY) < 0) {
+  if (filesystem.FileOpen(&file, "/fastfonts/seven_segments_40.bin", LFS_O_RDONLY) < 0) {
     return false;
   }
 
   filesystem.FileClose(&file);
-  if (filesystem.FileOpen(&file, "/fonts/7segments_115.bin", LFS_O_RDONLY) < 0) {
+  if (filesystem.FileOpen(&file, "/fastfonts/seven_segments_115.bin", LFS_O_RDONLY) < 0) {
     return false;
   }
 

src/displayapp/screens/WatchFaceInfineat.cpp

@@ -9,6 +9,7 @@
 #include "components/ble/BleController.h"
 #include "components/ble/NotificationManager.h"
 #include "components/motion/MotionController.h"
+#include "displayapp/fonts/FastFont.h"
 
 using namespace Pinetime::Applications::Screens;
 
@@ -133,16 +134,8 @@ WatchFaceInfineat::WatchFaceInfineat(Controllers::DateTime& dateTimeController,
     notificationManager {notificationManager},
     settingsController {settingsController},
     motionController {motionController} {
-  lfs_file f = {};
-  if (filesystem.FileOpen(&f, "/fonts/teko.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_teko = lv_font_load("F:/fonts/teko.bin");
-  }
-
-  if (filesystem.FileOpen(&f, "/fonts/bebas.bin", LFS_O_RDONLY) >= 0) {
-    filesystem.FileClose(&f);
-    font_bebas = lv_font_load("F:/fonts/bebas.bin");
-  }
+  font_teko = Components::FastFont::LoadFont(filesystem, "/fastfonts/teko.bin");
+  font_bebas = Components::FastFont::LoadFont(filesystem, "/fastfonts/bebas.bin");
 
   // Side Cover
   static constexpr lv_point_t linePoints[nLines][2] = {{{30, 25}, {68, -8}},
@@ -304,10 +297,10 @@ WatchFaceInfineat::~WatchFaceInfineat() {
   lv_task_del(taskRefresh);
 
   if (font_bebas != nullptr) {
-    lv_font_free(font_bebas);
+    free(font_bebas);
   }
   if (font_teko != nullptr) {
-    lv_font_free(font_teko);
+    free(font_teko);
   }
 
   lv_obj_clean(lv_scr_act());
@@ -493,12 +486,12 @@ void WatchFaceInfineat::ToggleBatteryIndicatorColor(bool showSideCover) {
 bool WatchFaceInfineat::IsAvailable(Pinetime::Controllers::FS& filesystem) {
   lfs_file file = {};
 
-  if (filesystem.FileOpen(&file, "/fonts/teko.bin", LFS_O_RDONLY) < 0) {
+  if (filesystem.FileOpen(&file, "/fastfonts/teko.bin", LFS_O_RDONLY) < 0) {
     return false;
   }
 
   filesystem.FileClose(&file);
-  if (filesystem.FileOpen(&file, "/fonts/bebas.bin", LFS_O_RDONLY) < 0) {
+  if (filesystem.FileOpen(&file, "/fastfonts/bebas.bin", LFS_O_RDONLY) < 0) {
     return false;
   }
 

src/resources/CMakeLists.txt

@@ -1,3 +1,5 @@
+set(FONTS teko bebas lv_font_dots_40
+seven_segments_40 seven_segments_115)
 
 find_program(LV_FONT_CONV "lv_font_conv" NO_CACHE REQUIRED
     HINTS "${CMAKE_SOURCE_DIR}/node_modules/.bin")
@@ -16,15 +18,37 @@ else()
    set(Python3_EXECUTABLE "python")
 endif()
 
+add_library(compiled_fonts OBJECT)
+# add include directory to lvgl headers needed to compile the font files on its own
+target_include_directories(compiled_fonts PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}/../../libs")
+foreach(FONT ${FONTS})
+   add_custom_command(
+      OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/${FONT}.c
+      COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-font-c.py
+      --lv-font-conv "${LV_FONT_CONV}"
+      --font ${FONT} ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
+      DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
+      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+   )
+   add_custom_target(compiled_fonts_${FONT}
+      DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/${FONT}.c
+   )
+   target_sources(compiled_fonts PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/${FONT}.c")
+   add_dependencies(compiled_fonts compiled_fonts_${FONT})
+endforeach()
+
+
 # generate fonts
 add_custom_target(GenerateResources
-    COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-fonts.py  --lv-font-conv "${LV_FONT_CONV}" ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
     COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-img.py  --lv-img-conv "${LV_IMG_CONV}" ${CMAKE_CURRENT_SOURCE_DIR}/images.json
+    COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-font-bin.py $<TARGET_OBJECTS:compiled_fonts>
     COMMAND "${Python3_EXECUTABLE}" ${CMAKE_CURRENT_SOURCE_DIR}/generate-package.py --config  ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json --config  ${CMAKE_CURRENT_SOURCE_DIR}/images.json --obsolete obsolete_files.json --output infinitime-resources-${pinetime_VERSION_MAJOR}.${pinetime_VERSION_MINOR}.${pinetime_VERSION_PATCH}.zip
+    COMMAND_EXPAND_LISTS
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/fonts.json
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/images.json
     WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
 
     COMMENT "Generate fonts and images for resource package"
 )
 
+add_dependencies(GenerateResources compiled_fonts)

src/resources/fonts.json

@@ -8,8 +8,7 @@
       ],
       "bpp": 1,
       "size": 28,
-      "format": "bin",
-      "target_path": "/fonts/"
+      "target_path": "/fastfonts/"
    },
    "bebas" : {
       "sources": [
@@ -20,8 +19,7 @@
       ],
       "bpp": 1,
       "size": 120,
-      "format": "bin",
-      "target_path": "/fonts/"
+      "target_path": "/fastfonts/"
    },
    "lv_font_dots_40": {
       "sources": [
@@ -32,10 +30,9 @@
       ],
       "bpp": 1,
       "size": 40,
-      "format": "bin",
-      "target_path": "/fonts/"
+      "target_path": "/fastfonts/"
    },
-   "7segments_40" : {
+   "seven_segments_40" : {
       "sources": [
          {
             "file": "fonts/7segment.woff",
@@ -44,10 +41,9 @@
       ],
       "bpp": 1,
       "size": 40,
-      "format": "bin",
-      "target_path": "/fonts/"
+      "target_path": "/fastfonts/"
    },
-   "7segments_115" : {
+   "seven_segments_115" : {
       "sources": [
          {
             "file": "fonts/7segment.woff",
@@ -56,7 +52,6 @@
       ],
       "bpp": 1,
       "size": 115,
-      "format": "bin",
-      "target_path": "/fonts/"
+      "target_path": "/fastfonts/"
    }
 }