Русификация библиотеки UTFT - часть 1: SmallFont

Для работы с графическими TFT-дисплеями (например, ITDB02-3.2S) существует замечательная библиотека UTFT (которая совсем недавно обрела новую версию, которая существенно быстрее предыдущей).

И все в этой библиотеке замечательно - доступны необходимые графические примитивы (прямоугольники, круги, линии, точки, прямоугольники с закругленными углами и т.п.) и есть возможность использовать различные шрифты, но все шрифты, к сожалению, содержат символы латинского алфавита и стандартные символы.

Во многих случаях этого вполне достаточно (большинство тех, кто увлекается "ардуино" - владеют английским и надписи на английском воспринимаются ими вполне адекватно), но когда устройство переходит из статуса "прототип" (для разработчика) и получает некоторое движение в сторону "продакшн" (уже для реального использования) - надписи на русском языке становятся более предпочтительными.

Как оказалось, "русифицировать" данную библиотеку оказалось относительно несложно ("относительно" - только из-за кропотливости данной работы - требуется фактически попиксельно отрисовать каждый недостающий символ).

Результат русификации можно увидеть на следующем изображении (фотография с экрана TFT):

Дополнительным результатом работы по русификации стал еще один дополнительный шрифт (SmallSymbolFont), содержащий дополнительный набор символов.

Собственно теперь расскажем, как это делается (и чуть забегая вперед - предоставим инструмент для самостоятельной корректуры написания букв и создания новых служебных символов). 

Для того, чтобы сэкономить драгоценную память микроконтроллера, будем добавлять в шрифт только недостающие символы (к примеру, кириллическую букву "А" заново создавать не будем, поскольку она выглядит абсолютно идентично латинской "А").

Шрифт SmallFont описан в файле DefaultFonts.c внутри папки \libraries\UTFT - именно этот файл мы и откроем для редактирования.

В начале файла находится конструкция, которая начинается следующим образом:

fontdatatype SmallFont[1144] PROGMEM={         

0x08,0x0C,0x20,0x5F,

0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, // <Space>

0x00,0x00,0x20,0x20,0x20,0x20,0x20,0x20,0x00,0x20,0x00,0x00, // !

0x00,0x28,0x50,0x50,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, // "

0x00,0x00,0x28,0x28,0xFC,0x28,0x50,0xFC,0x50,0x50,0x00,0x00, // #

Где в первой строке объявлен массив SmallFonts, указана его длинна (1144). В следующей строке видим 4 байта:

• 0x08 - ширина знакоместа (8 точек)
• 0x0C - высота знакоместа (12 точек)
• 0x20 - "смещение" (32)
• 0x5F - количество символов в шрифте (95)

Дальше идут данные, которыми закодировано написание каждого из символов (12 байт на символ). 

1 байт = 8 бит, что позволяет закодировать как раз "строчку" в составе знакоместа.

Параметр "смещение" становится понятен, если посмотреть на таблицу ASCII-кодов (к примеру, символ "пробел" имеет код 32). 

В общем-то, то, что написано выше, дает полное представление о том, что мы будем делать:

1. Необходимо подготовить информацию по начертанию всех недостающих символов (12 байт на каждый недостающий символ).
2. Добавить полученную информацию в массив данных SmallFont.
3. Скорректировать размер массива.
4. Скорректировать количество символов в шрифте (4 байт в массиве).

Все остальные данные мы оставляем как есть (поскольку не изменяем их).

План работ понятен. Приступим к подготовке начертаний недостающих букв.

К примеру, буква "Б":

0	0	0	0	0	0	0	0
0	0	0	0	0	0	0	0
1	1	1	1	1	0	0	0
0	1	0	0	1	0	0	0
0	1	0	0	0	0	0	0
0	1	1	1	0	0	0	0
0	1	0	0	1	0	0	0
0	1	0	0	1	0	0	0
0	1	0	0	1	0	0	0
1	1	1	1	0	0	0	0
0	0	0	0	0	0	0	0
0	0	0	0	0	0	0	0

Соответственно, выше мы видим "знакоместо", размером 8х12 и "единичками" мы указываем те пикселы, которые формируют начертание символа. 

Дальше каждую строчку с "единичками" и "нулями" нужно закодировать соответствующим значением байта в шестнадцатеричной записи. К примеру, третья строчка:

B11111000 = 0xF8

В левой части видны биты (нули или единички), в первой же части - то же самое, но в шестнадцатеричной системе исчисления. Для такого преобразования можно воспользоваться программой "Калькулятор", которая входит в состав любой современной операционной системы (только необходимо переключить на вид "Для программиста").

Безусловно, это все можно делать ровно по той схеме, что описано, но это как-то совершенно не интересно - работа абсолютно рутинная и требует много "ручных" действий.

Чтобы как-то эту ситуацию улучшить, воспользуемся замечательным инструментом: Microsoft Excel (или бесплатным аналогом из OpenOffice).

Автоматизируем следующее:

1. Создадим правило для "условного форматирования" (чтобы фон ячейки менялся в зависимости от значения внутри ячейки) - тогда символ будет более явно виден.
2. Произведем вычисление и преобразование бит в байт (в шестнадцатеричном представлении).
3. Создадим строку из байтов, которая полностью описывает начертание символа (достаточно ее скопировать и вставить ее в массив SmallFont).

Получается следующее:

Внизу приведено начертание "оригинальной" буквы "В" - чтобы понимать, как распределено "пространство" в знакоместе (как организуется отступ, где находится базовая линия шрифта и т.п.). 

Теперь достаточно (в верхней части файла) в пространстве знакоместа ставить "нолики" и "единички" (при этом символ автоматически "подкрашивается", что позволяет оценить то, как он будет выглядеть) и сразу же формируется строка, описывающая начертание.

Файл для MS Excel (совместим с OpenOffice) находится в архиве вместе с уже готовым файлом шрифта для библиотеки UTFT, ссылка на который находится в конце статьи.

Собственно, таким образом и формируется информация о начертании недостающих кириллических символов.

После того, как готов массив, описывающий написание каждого символа в шрифте, не забудьте скорректировать длину массива и количество символов в шрифте (см. выше).

Теперь надо сказать несколько слов о том, как пользоваться созданным шрифтом.

Если открыть файл DefaultFonts.c (на скриншоте ниже уже скорректированный файл с русифицированным шрифтом) в текстовом редакторе можно увидеть примерно следующее:

В строчках закодировано то, как будет выглядеть соответствующий символ (текущий символ отображается в конце строки в начале комментария, за ним указан десятичный и шестнадцатеричный код символа). 

К примеру, для символа "б" это 150 и 0x96 (см. выделение на изображении выше).

Для печати текстов с помощью библиотеки UTFT используется следующая функция:

myGLCD.print(String, x, y);

Где String - строка, которую необходимо вывести, x и y - координаты, где необходимо вывести строку.

Теперь (для русского языка) необходимо сформировать правильную строку. 

К сожалению, написать что-то типа myGLCD.print("Пишем по-русски", 0, 0); не получится (для этого требуется создать полноценный шрифт в кодировке UTF-8 (именно в ней работает IDE Arduino),  но это непозволительная роскошь (из-за того, что полноценный шрифт будет занимать слишком много памяти). 

Чтобы все-таки выводить кириллические надписи, требуется немного "схитрить". 

Поясним это на примере слова "вода": в этом слове два символа - кириллические ("в" и "д") и два символа - латинские ("o" и "a"). Соответственно, для вывода результирующей строки мы воспользуемся следующей конструкцией:

myGLCD.print("\x97""o""\x99""a", x, y);

Мы оставили латинские символы без изменения, а вместо кириллических символов сделали указание на их шестнадцатеричный код.

Бонус

В процессе работы над основным кириллическим шрифтом появилась мысль, что можно было бы создать еще несколько различных символов, с помощью которых можно было бы отображать уровень заряда батареи, уровень сигнала и т.п. 

В шрифт SmallFont добавлять эти дополнительные символы посчитал нецелесообразным (они нужны не для всех случаев, а при использовании шрифта SmallFonts - просто занимали бы драгоценную память). 

Все дополнительные символы были выделены в отдельный шрифт SmallSymbolFont и теперь, если они необходимы в вашем проекте, вы можете просто подключить этот шрифт (в дополнение к тем, что используются в скетче). 

Например, чтобы вывести символ "батарейка 75%", нужна конструкция типа:

myGLCD.setFont(SmallSymbolFont);

myGLCD.print(String(char(33)), 0, 0);

В примере выше мы используем десятичное представление кода необходимого символа.

---

Тестовый скетч выводит все символы двух шрифтов, которые упоминаются в этом посте: SmallFont и SmallSymbolFont:

На этом первая часть русификации библиотеки завершена.

Все файлы (Excel, DefaultFonts.c и тестовый скетч, который выводит все символы шрифтов SmallFont и SmallSymbolFont) находятся в архиве по следующей ссылке.

С помощью информации из данного поста и excel-файла вы можете самостоятельно скорректировать написание любых символов или создать собственные уникальные символы и пиктограммы.

Следите за обновлениями, продолжение следует...