Split out font code into sindarin-inc/tiny-font (#1151)

Author: johnboiles

.gitmodules

@@ -16,9 +16,9 @@
 [submodule "components/astubs"]
 	path = components/astubs
 	url = git@github.com:sindarin-inc/astubs.git
-[submodule "components/freetype/freetype"]
-	path = components/freetype/freetype
-	url = git@github.com:sindarin-inc/freetype.git
 [submodule "lib/mbedtls"]
 	path = lib/mbedtls
 	url = https://github.com/Mbed-TLS/mbedtls.git
+[submodule "components/tiny-font"]
+	path = components/tiny-font
+	url = git@github.com:sindarin-inc/tiny-font.git

Makefile

@@ -42,7 +42,7 @@ endif
 IDF_PROFILE = -B build-$(TARGET) -DSDKCONFIG_DEFAULTS="$(SDKCONFIG_DEFAULTS)"
 
 # Optional variables for the Simulator builds
-CMAKE_SIM_DISPLAY_OPTIONS := $(if $(DISPLAY_WIDTH),-DDISPLAY_WIDTH=$(DISPLAY_WIDTH)) $(if $(DISPLAY_HEIGHT),-DDISPLAY_HEIGHT=$(DISPLAY_HEIGHT)) $(if $(DISPLAY_SCALE),-DDISPLAY_SCALE=$(DISPLAY_SCALE)) $(if $(SIM_LAYOUT_DEBUG),-DSIM_LAYOUT_DEBUG=$(SIM_LAYOUT_DEBUG)) $(if $(DISPLAY_TYPE),-DDISPLAY_TYPE=$(DISPLAY_TYPE)) $(if $(TTF_SCREEN_RES_PER_INCH),-DTTF_SCREEN_RES_PER_INCH=$(TTF_SCREEN_RES_PER_INCH))
+CMAKE_SIM_DISPLAY_OPTIONS := $(if $(DISPLAY_WIDTH),-DDISPLAY_WIDTH=$(DISPLAY_WIDTH)) $(if $(DISPLAY_HEIGHT),-DDISPLAY_HEIGHT=$(DISPLAY_HEIGHT)) $(if $(DISPLAY_SCALE),-DDISPLAY_SCALE=$(DISPLAY_SCALE)) $(if $(SIM_LAYOUT_DEBUG),-DSIM_LAYOUT_DEBUG=$(SIM_LAYOUT_DEBUG)) $(if $(DISPLAY_TYPE),-DDISPLAY_TYPE=$(DISPLAY_TYPE)) $(if $(TTF_SCREEN_RES_PER_INCH),-DCONFIG_TINYFONT_DISPLAY_DPI=$(TTF_SCREEN_RES_PER_INCH))
 
 .PHONY: sim-build
 sim-build:

components/freetype/CMakeLists.txt

@@ -43,6 +43,28 @@ add_subdirectory(${REPO_ROOT_DIR}/components/miniz ${CMAKE_CURRENT_BINARY_DIR}/m
 
 add_subdirectory(${REPO_ROOT_DIR}/components/Adafruit-GFX-Library ${CMAKE_CURRENT_BINARY_DIR}/Adafruit-GFX-Library)
 
+add_subdirectory(${REPO_ROOT_DIR}/components/tiny-font ${CMAKE_CURRENT_BINARY_DIR}/tiny-font)
+
+# Conditionally link freetype if we're using 8-bit or 16-bit display
+if(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_24BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_16BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_8BIT")
+    # Set FreeType options before adding the subdirectory
+    set(FT_DISABLE_PNG ON CACHE BOOL "Disable PNG support in FreeType" FORCE)
+    set(FT_DISABLE_HARFBUZZ ON CACHE BOOL "Disable HarfBuzz support in FreeType" FORCE)
+    set(FT_DISABLE_BROTLI ON CACHE BOOL "Disable Brotli support in FreeType" FORCE)
+    add_subdirectory(${REPO_ROOT_DIR}/components/tiny-font/freetype/freetype ${CMAKE_CURRENT_BINARY_DIR}/freetype)
+    target_link_libraries(tiny-font PUBLIC freetype)
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_TTF=1
+        CONFIG_TINYFONT_IBMF=0
+        CONFIG_TINYFONT_DISPLAY_DPI=${TTF_SCREEN_RES_PER_INCH}
+    )
+else()
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_TTF=0
+        CONFIG_TINYFONT_IBMF=1
+    )
+endif()
+
 add_subdirectory(${REPO_ROOT_DIR}/lib/esp_ringbuf ${CMAKE_CURRENT_BINARY_DIR}/esp_ringbuf)
 
 # Before adding mbedtls, set options to disable tests and programs
@@ -59,7 +81,7 @@ endif()
 
 add_library(${PROJECT_NAME} STATIC ${SOURCES} ${HTTP_CLIENT_SOURCE})
 
-target_link_libraries(${PROJECT_NAME} PUBLIC pugixml ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library mbedtls mbedx509 mbedcrypto esp_ringbuf)
+target_link_libraries(${PROJECT_NAME} PUBLIC pugixml ArduinoJson miniz astubs esp-idf-stubs nvs_flash Adafruit-GFX-Library tiny-font mbedtls mbedx509 mbedcrypto esp_ringbuf)
 
 target_include_directories(${PROJECT_NAME} PUBLIC
     "${REPO_ROOT_DIR}/src"
@@ -71,46 +93,42 @@ target_include_directories(${PROJECT_NAME} PUBLIC
     "${REPO_ROOT_DIR}/lib/argparse"
 )
 
-# Conditionally link freetype if we're using 8-bit or 16-bit display
-if(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_24BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_16BIT" OR DISPLAY_TYPE STREQUAL "DISPLAY_SIM_8BIT")
-    # Set FreeType options before adding the subdirectory
-    set(FT_DISABLE_PNG ON CACHE BOOL "Disable PNG support in FreeType" FORCE)
-    set(FT_DISABLE_HARFBUZZ ON CACHE BOOL "Disable HarfBuzz support in FreeType" FORCE)
-    set(FT_DISABLE_BROTLI ON CACHE BOOL "Disable Brotli support in FreeType" FORCE)
-    add_subdirectory(${REPO_ROOT_DIR}/components/freetype/freetype ${CMAKE_CURRENT_BINARY_DIR}/freetype)
-    target_link_libraries(${PROJECT_NAME} PUBLIC freetype)
-    target_compile_definitions(${PROJECT_NAME} PUBLIC
-        CONFIG_FONT_TTF=1
-        CONFIG_FONT_IBMF=0
-    )
-else()
-    target_compile_definitions(${PROJECT_NAME} PUBLIC
-        CONFIG_FONT_TTF=0
-        CONFIG_FONT_IBMF=1
-    )
-endif()
-
 # Set compile definitions based on the selected DISPLAY_TYPE
 if(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_24BIT")
     target_compile_definitions(${PROJECT_NAME} PUBLIC
         CONFIG_DISPLAY_SIM_24BIT=1
     )
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_PIXEL_RESOLUTION_TWENTY_FOUR_BIT=1
+    )
 elseif(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_16BIT")
     target_compile_definitions(${PROJECT_NAME} PUBLIC
         CONFIG_DISPLAY_SIM_16BIT=1
     )
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_PIXEL_RESOLUTION_SIXTEEN_BIT=1
+    )
 elseif(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_8BIT")
     target_compile_definitions(${PROJECT_NAME} PUBLIC
         CONFIG_DISPLAY_SIM_8BIT=1
     )
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_PIXEL_RESOLUTION_EIGHT_BIT=1
+    )
 elseif(DISPLAY_TYPE STREQUAL "DISPLAY_SIM_1BIT")
     target_compile_definitions(${PROJECT_NAME} PUBLIC
         CONFIG_DISPLAY_SIM_1BIT=1
     )
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_PIXEL_RESOLUTION_ONE_BIT=1
+    )
 elseif(DISPLAY_TYPE STREQUAL "DISPLAY_EINKET013TT1")
     target_compile_definitions(${PROJECT_NAME} PUBLIC
         CONFIG_DISPLAY_EINKET013TT1=1
     )
+    target_compile_definitions(tiny-font PUBLIC
+        CONFIG_TINYFONT_PIXEL_RESOLUTION_ONE_BIT=1
+    )
 else()
     message(FATAL_ERROR "Invalid DISPLAY_TYPE: ${DISPLAY_TYPE}")
 endif()
@@ -145,7 +163,6 @@ target_compile_definitions(${PROJECT_NAME} PUBLIC
     CONFIG_DISABLE_POWER_MANAGEMENT=1
     RTC_SLOW_ATTR=
     RTC_NOINIT_ATTR=
-    CONFIG_TTF_SCREEN_RES_PER_INCH=${TTF_SCREEN_RES_PER_INCH}
     CONFIG_DEFAULT_INACTIVITY_MINUTES=10
     CONFIG_DISPLAY_POWER=-1
     CONFIG_DISPLAY_WIDTH=${DISPLAY_WIDTH}

components/freetype/freetype

@@ -13,7 +13,7 @@
 #include "DisplayUtil.hpp"
 #include "EPub/EPubFile.hpp"
 #include "Renderers/Renderer.hpp"
-#include "UI/Fonts/Fonts.hpp"
+#include "UI/Fonts.hpp"
 
 int main(int argc, char **argv) {
     argparse::ArgumentParser program("epub-render");

components/tiny-font

@@ -2,3 +2,5 @@
 # Espressif IoT Development Framework (ESP-IDF) 5.5.0 Project Minimal Configuration
 #
 CONFIG_DISPLAY_ESP32_P4_FUNCTION_EV=y
+CONFIG_TINYFONT_TTF=y
+CONFIG_TINYFONT_PIXEL_RESOLUTION_SIXTEEN_BIT=y

lib/Simulator/Common/CMakeLists.txt

@@ -2,6 +2,8 @@
 # Espressif IoT Development Framework (ESP-IDF) 5.5.0 Project Minimal Configuration
 #
 CONFIG_DISPLAY_ESP32_P4_FUNCTION_EV_R0=y
+CONFIG_TINYFONT_TTF=y
+CONFIG_TINYFONT_PIXEL_RESOLUTION_SIXTEEN_BIT=y
 CONFIG_ESP32P4_REV_MIN_0=y
 CONFIG_ESP_HOSTED_SDIO_PIN_D0=49
 # NOTE: This doesn't take from the defaults for some reason and needs to be set manually from menuconfig

scripts/epub-render/main.cpp

@@ -2,3 +2,5 @@
 # Espressif IoT Development Framework (ESP-IDF) 5.5.0 Project Minimal Configuration
 #
 CONFIG_DISPLAY_ESP32_P4_SEEYA_049=y
+CONFIG_TINYFONT_TTF=y
+CONFIG_TINYFONT_PIXEL_RESOLUTION_TWENTY_FOUR_BIT=y