Xteink-X4-crosspoint-reader/lib/ExternalFont/ExternalFont.cpp
aber0724 895fe470c6 feat: Add CJK UI font support and complete I18N implementation
## Major Features

### 1. CJK UI Font System
- Implemented external font loading system for CJK characters
- Added Source Han Sans (思源黑体) as base font for UI rendering
- Support for multiple font sizes (20pt, 22pt, 24pt)
- Font selection UI for both reader and UI fonts
- Automatic fallback to built-in fonts when external fonts unavailable
- External UI font now renders ALL characters (including ASCII) for consistent style
- Proportional spacing for external fonts (variable width per character)

### 2. Complete I18N Implementation
- Added comprehensive internationalization system
- Support for English, Chinese Simplified, and Japanese
- Translated all UI strings across the entire application
- Language selection UI in settings with native language names
  - English displayed as "English"
  - Chinese displayed as "简体中文"
  - Japanese displayed as "日本語"
- Dynamic language switching without restart

### 3. Bug Fixes

#### Rendering Race Conditions
- Fixed race condition where parent and child Activity rendering tasks run simultaneously
- Added 500ms delay in child Activity displayTaskLoop() to wait for parent rendering completion
- Unified displayTaskLoop() logic: `if (updateRequired && !subActivity)`
- Prevents duplicate RED RAM writes and incomplete screen refreshes

**Affected Activities:**
- CategorySettingsActivity: Unified displayTaskLoop check logic
- KOReaderSettingsActivity: Added 500ms delay before first render
- CalibreSettingsActivity: Added 500ms delay before first render
- FontSelectActivity: Added 500ms delay before first render
- ClearCacheActivity: Added 500ms delay and subActivity check
- LanguageSelectActivity: Added 500ms delay in displayTaskLoop (not onEnter)

#### Button Response Issues
- Fixed CrossPointWebServer exit button requiring long press
- Added MappedInputManager::update() method
- Call update() before wasPressed() in tight HTTP processing loop
- Button presses during loop are now properly detected

#### ClearCache Crash
- Fixed FreeRTOS mutex deadlock when exiting ClearCache activity
- Added isExiting flag to prevent operations during exit
- Added clearCacheTaskHandle tracking
- Wait for clearCache task completion before deleting mutex

#### External UI Font Rendering
- Fixed ASCII characters not using external UI font (was using built-in EPD font)
- Fixed character spacing too wide (now uses proportional spacing via getGlyphMetrics)

## Technical Details

**Files Added:**
- lib/ExternalFont/: External font loading system
- lib/I18n/: Internationalization system
- lib/GfxRenderer/cjk_ui_font*.h: Pre-rendered CJK font data
- scripts/generate_cjk_ui_font.py: Font generation script
- src/activities/settings/FontSelectActivity.*: Font selection UI
- src/activities/settings/LanguageSelectActivity.*: Language selection UI
- docs/cjk-fonts.md: CJK font documentation
- docs/i18n.md: I18N documentation

**Files Modified:**
- lib/GfxRenderer/: Added CJK font rendering support with proportional spacing
- src/activities/: I18N integration across all activities
- src/MappedInputManager.*: Added update() method
- src/CrossPointSettings.cpp: Added language and font settings

**Memory Usage:**
- Flash: 94.7% (6204434 bytes / 6553600 bytes)
- RAM: 66.4% (217556 bytes / 327680 bytes)

## Testing Notes

All rendering race conditions and button response issues have been fixed and tested.
ClearCache no longer crashes when exiting.
File transfer page now responds to short press on exit button.
External UI font now renders all characters with proper proportional spacing.
Language selection page displays language names in their native scripts.

Co-authored-by: Claude (Anthropic AI Assistant)
2026-01-23 16:54:56 +09:00

346 lines
9.0 KiB
C++

#include "ExternalFont.h"
#include <HardwareSerial.h>
#include <algorithm>
#include <cstring>
#include <vector>
ExternalFont::~ExternalFont() { unload(); }
void ExternalFont::unload() {
if (_fontFile) {
_fontFile.close();
}
_isLoaded = false;
_fontName[0] = '\0';
_fontSize = 0;
_charWidth = 0;
_charHeight = 0;
_bytesPerRow = 0;
_bytesPerChar = 0;
_accessCounter = 0;
// Clear cache and hash table
for (int i = 0; i < CACHE_SIZE; i++) {
_cache[i].codepoint = 0xFFFFFFFF;
_cache[i].lastUsed = 0;
_cache[i].notFound = false;
_hashTable[i] = -1;
}
}
bool ExternalFont::parseFilename(const char *filepath) {
// Extract filename from path
const char *filename = strrchr(filepath, '/');
if (filename) {
filename++; // Skip '/'
} else {
filename = filepath;
}
// Parse format: FontName_size_WxH.bin
// Example: KingHwaOldSong_38_33x39.bin
char nameCopy[64];
strncpy(nameCopy, filename, sizeof(nameCopy) - 1);
nameCopy[sizeof(nameCopy) - 1] = '\0';
// Remove .bin extension
char *ext = strstr(nameCopy, ".bin");
if (!ext) {
Serial.printf("[EXT_FONT] Invalid filename: no .bin extension\n");
return false;
}
*ext = '\0';
// Find _WxH part from the end
char *lastUnderscore = strrchr(nameCopy, '_');
if (!lastUnderscore) {
Serial.printf("[EXT_FONT] Invalid filename format\n");
return false;
}
// Parse WxH
int w, h;
if (sscanf(lastUnderscore + 1, "%dx%d", &w, &h) != 2) {
Serial.printf("[EXT_FONT] Failed to parse dimensions\n");
return false;
}
_charWidth = (uint8_t)w;
_charHeight = (uint8_t)h;
*lastUnderscore = '\0';
// Find size
lastUnderscore = strrchr(nameCopy, '_');
if (!lastUnderscore) {
Serial.printf("[EXT_FONT] Invalid filename format: no size\n");
return false;
}
int size;
if (sscanf(lastUnderscore + 1, "%d", &size) != 1) {
Serial.printf("[EXT_FONT] Failed to parse size\n");
return false;
}
_fontSize = (uint8_t)size;
*lastUnderscore = '\0';
// Remaining part is font name
strncpy(_fontName, nameCopy, sizeof(_fontName) - 1);
_fontName[sizeof(_fontName) - 1] = '\0';
// Calculate bytes per char
_bytesPerRow = (_charWidth + 7) / 8;
_bytesPerChar = _bytesPerRow * _charHeight;
if (_bytesPerChar > MAX_GLYPH_BYTES) {
Serial.printf("[EXT_FONT] Glyph too large: %d bytes (max %d)\n",
_bytesPerChar, MAX_GLYPH_BYTES);
return false;
}
Serial.printf("[EXT_FONT] Parsed: name=%s, size=%d, %dx%d, %d bytes/char\n",
_fontName, _fontSize, _charWidth, _charHeight, _bytesPerChar);
return true;
}
bool ExternalFont::load(const char *filepath) {
unload();
if (!parseFilename(filepath)) {
return false;
}
if (!SdMan.openFileForRead("EXT_FONT", filepath, _fontFile)) {
Serial.printf("[EXT_FONT] Failed to open: %s\n", filepath);
return false;
}
_isLoaded = true;
Serial.printf("[EXT_FONT] Loaded: %s\n", filepath);
return true;
}
int ExternalFont::findInCache(uint32_t codepoint) {
// O(1) hash table lookup with linear probing for collisions
int hash = hashCodepoint(codepoint);
for (int i = 0; i < CACHE_SIZE; i++) {
int idx = (hash + i) % CACHE_SIZE;
int16_t cacheIdx = _hashTable[idx];
if (cacheIdx == -1) {
// Empty slot, not found
return -1;
}
if (_cache[cacheIdx].codepoint == codepoint) {
return cacheIdx;
}
}
return -1;
}
int ExternalFont::getLruSlot() {
int lruIndex = 0;
uint32_t minUsed = _cache[0].lastUsed;
for (int i = 1; i < CACHE_SIZE; i++) {
// Prefer unused slots
if (_cache[i].codepoint == 0xFFFFFFFF) {
return i;
}
if (_cache[i].lastUsed < minUsed) {
minUsed = _cache[i].lastUsed;
lruIndex = i;
}
}
return lruIndex;
}
bool ExternalFont::readGlyphFromSD(uint32_t codepoint, uint8_t *buffer) {
if (!_fontFile) {
return false;
}
// Calculate offset
uint32_t offset = codepoint * _bytesPerChar;
// Seek and read
if (!_fontFile.seek(offset)) {
return false;
}
size_t bytesRead = _fontFile.read(buffer, _bytesPerChar);
if (bytesRead != _bytesPerChar) {
// May be end of file or other error, fill with zeros
memset(buffer, 0, _bytesPerChar);
}
return true;
}
const uint8_t *ExternalFont::getGlyph(uint32_t codepoint) {
if (!_isLoaded) {
return nullptr;
}
// First check cache (O(1) with hash table)
int cacheIndex = findInCache(codepoint);
if (cacheIndex >= 0) {
_cache[cacheIndex].lastUsed = ++_accessCounter;
// Return nullptr if this codepoint was previously marked as not found
if (_cache[cacheIndex].notFound) {
return nullptr;
}
return _cache[cacheIndex].bitmap;
}
// Cache miss, need to read from SD card
int slot = getLruSlot();
// If replacing an existing entry, remove it from hash table
if (_cache[slot].codepoint != 0xFFFFFFFF) {
int oldHash = hashCodepoint(_cache[slot].codepoint);
for (int i = 0; i < CACHE_SIZE; i++) {
int idx = (oldHash + i) % CACHE_SIZE;
if (_hashTable[idx] == slot) {
_hashTable[idx] = -1;
break;
}
}
}
// Read glyph from SD card
bool readSuccess = readGlyphFromSD(codepoint, _cache[slot].bitmap);
// Calculate metrics and check if glyph is empty
uint8_t minX = _charWidth;
uint8_t maxX = 0;
bool isEmpty = true;
if (readSuccess && _bytesPerChar > 0) {
for (int y = 0; y < _charHeight; y++) {
for (int x = 0; x < _charWidth; x++) {
int byteIndex = y * _bytesPerRow + (x / 8);
int bitIndex = 7 - (x % 8);
if ((_cache[slot].bitmap[byteIndex] >> bitIndex) & 1) {
isEmpty = false;
if (x < minX)
minX = x;
if (x > maxX)
maxX = x;
}
}
}
}
// Update cache entry
_cache[slot].codepoint = codepoint;
_cache[slot].lastUsed = ++_accessCounter;
// Check if this is a whitespace character (U+2000-U+200F: various spaces)
bool isWhitespace = (codepoint >= 0x2000 && codepoint <= 0x200F);
// Mark as notFound only if read failed or (empty AND not whitespace AND non-ASCII)
// Whitespace characters are expected to be empty but should still be rendered
_cache[slot].notFound = !readSuccess || (isEmpty && !isWhitespace && codepoint > 0x7F);
// Store metrics
if (!isEmpty) {
_cache[slot].minX = minX;
// Variable width: content width + 2px padding
_cache[slot].advanceX = (maxX - minX + 1) + 2;
} else {
_cache[slot].minX = 0;
// Special handling for whitespace characters
if (isWhitespace) {
// em-space (U+2003) and similar should be full-width (same as CJK char)
// en-space (U+2002) should be half-width
// Other spaces use appropriate widths
if (codepoint == 0x2003) {
// em-space: full CJK character width
_cache[slot].advanceX = _charWidth;
} else if (codepoint == 0x2002) {
// en-space: half CJK character width
_cache[slot].advanceX = _charWidth / 2;
} else if (codepoint == 0x3000) {
// Ideographic space (CJK full-width space): full width
_cache[slot].advanceX = _charWidth;
} else {
// Other spaces: use standard space width
_cache[slot].advanceX = _charWidth / 3;
}
} else {
// Fallback for other empty glyphs
_cache[slot].advanceX = _charWidth / 3;
}
}
// Add to hash table
int hash = hashCodepoint(codepoint);
for (int i = 0; i < CACHE_SIZE; i++) {
int idx = (hash + i) % CACHE_SIZE;
if (_hashTable[idx] == -1) {
_hashTable[idx] = slot;
break;
}
}
if (_cache[slot].notFound) {
return nullptr;
}
return _cache[slot].bitmap;
}
bool ExternalFont::getGlyphMetrics(uint32_t codepoint, uint8_t *outMinX,
uint8_t *outAdvanceX) {
int idx = findInCache(codepoint);
if (idx >= 0 && !_cache[idx].notFound) {
if (outMinX)
*outMinX = _cache[idx].minX;
if (outAdvanceX)
*outAdvanceX = _cache[idx].advanceX;
return true;
}
return false;
}
void ExternalFont::preloadGlyphs(const uint32_t *codepoints, size_t count) {
if (!_isLoaded || !codepoints || count == 0) {
return;
}
// Limit to cache size to avoid thrashing
const size_t maxLoad = std::min(count, static_cast<size_t>(CACHE_SIZE));
// Create a sorted copy for sequential SD card access
// Sequential reads are much faster than random seeks
std::vector<uint32_t> sorted(codepoints, codepoints + maxLoad);
std::sort(sorted.begin(), sorted.end());
// Remove duplicates
sorted.erase(std::unique(sorted.begin(), sorted.end()), sorted.end());
Serial.printf("[EXT_FONT] Preloading %zu unique glyphs\n", sorted.size());
const unsigned long startTime = millis();
size_t loaded = 0;
size_t skipped = 0;
for (uint32_t cp : sorted) {
// Skip if already in cache
if (findInCache(cp) >= 0) {
skipped++;
continue;
}
// Load into cache (getGlyph handles all the cache management)
getGlyph(cp);
loaded++;
}
Serial.printf(
"[EXT_FONT] Preload done: %zu loaded, %zu already cached, took %lums\n",
loaded, skipped, millis() - startTime);
}