M5StackでもTTFフォントが使いたい

### 追記（2021/08/18）

M5Stack 以外のマイコンにも対応した [OpenFontRender](https://github.com/takkaO/OpenFontRender) をリリースしました。
今後はこちらの利用を推奨します。使い方はほとんど同じです。

## はじめに
**皆さん，M5Stackシリーズ使っていますか～？**
お手頃なお値段で豊富なIOがあり，開発ペースも早くコミュニティが活発，
更に Arduino IDE が使える（＝豊富なライブラリが流用可能）という
素晴らしい ~~おもちゃ~~ ガジェットですが，一つだけ不満なことがありました．


そう，**フォント**です．


多くの偉大な先人達のおかげで M5Stack でも任意のフォントを使う方法はあります．

- [M5Stack の LCD に TFT_eSPI を使って日本語フォント "源真ゴシック" で表示する](https://qiita.com/ma2shita/items/fef1608fc9cf3a7bd46a)
- [M5Stackで好きなフォントを使う](https://watako-lab.com/2018/10/31/m5_font/)
- [M5Stackで日本語表示](https://qiita.com/taront/items/7900c88b9e9782c33b08)

しかし，これらの方法には以下のような制約が少なくとも1つは存在しています．

- **VLWフォントファイルを用意する必要がある．**
- **フォントサイズが固定．**
- **SDカードが必要．**
- **アンチエイリアスが効かない．**

特にフォントサイズが固定というのが厄介だなぁと思っていました．
しかし，2020年11月25日に転機が訪れます．

## M5Paper では TTFフォントが使える

<blockquote class="twitter-tweet"><p lang="en" dir="ltr">TTF Unicode support for M5Paper. <a href="https://t.co/ycf8jjyRUg">pic.twitter.com/ycf8jjyRUg</a></p>&mdash; M5Stack (@M5Stack) <a href="https://twitter.com/M5Stack/status/1331556592957808641?ref_src=twsrc%5Etfw">November 25, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

このツイートを見たときはとても興奮しました．
M5Stackのフォント周りの不満がすべて消し飛ぶ可能性を感じました．

M5Paperの発売後に[Githubのコード](https://github.com/m5stack/M5EPD)を眺めていると，どうやら [FreeType](https://www.freetype.org/) という有名なフォントレンダリングライブラリを組み込んでいるようでした．
2020年12月現在，公式がサポートしているのは M5EPD (M5Paper) だけのようですが，
これを M5Stack に移植すれば M5Stack でも TTFフォントを扱えるようになるはずです．

そう思っていたら早速 M5Stack Core2 に移植した方がいました．

<blockquote class="twitter-tweet"><p lang="ja" dir="ltr">M5Paper が買えなくて悲しかったので、M5Stack Core 2 に M5EPD の FreeType レンダラーを持ってきてみました。とても綺麗です🎊 <a href="https://twitter.com/hashtag/M5Stack?src=hash&amp;ref_src=twsrc%5Etfw">#M5Stack</a><a href="https://t.co/Irr924UxVh">https://t.co/Irr924UxVh</a> <a href="https://t.co/pznQRx3MTG">pic.twitter.com/pznQRx3MTG</a></p>&mdash; ひろましゃ🎩 (@h1romas4) <a href="https://twitter.com/h1romas4/status/1332686007632728066?ref_src=twsrc%5Etfw">November 28, 2020</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

**素晴らしい！！！！**
しかし，どうやら esp-idf で作っているようです．
私は Arduino IDE で使いたいので，Arduino IDE 用に M5EPD を移植して（ついでにちょっと改造もして）みました．

## M5FontRender
今回作成した M5Stack / M5Core2 用 TTF 描画ライブラリはこちらです．
https://github.com/takkaO/M5FontRender.git

### 準備（インストール）
上記のリポジトリから Arduino IDE のライブラリフォルダへクローンします．
Windowsであればデフォルトは ```ドキュメント/Arduino/libraries``` の中です．

### SDカードからフォントを読み込む
```M5FontRender/example/load_from_sd/load_from_sd.ino``` の中身です．
プログラム中の ```/JKG-M_3.ttf``` が SDカード内のフォントファイルへのパスです．
```/JKG-M_3.ttf```は ```load_from_sd``` ディレクトリ内に同梱されています．

```c++
#include "M5Core2.h"
#include "M5FontRender.h" // Include after M5Stack.h / M5Core2.h

M5FontRender render;

void setup() {
	// put your setup code here, to run once:
	M5.begin();
	M5.Lcd.fillScreen(BLACK);
	
	if (!render.loadFont("/JKG-M_3.ttf")) {
		Serial.println("Render initialize error");
		return;
	}

	render.setTextColor(WHITE);
	render.printf("Hello World\n");
	render.seekCursor(0, 10);
	render.setTextSize(30);
	render.setTextColor(GREEN);
	render.printf("完全なUnicodeサポート\n");
	render.seekCursor(0, 10);
	render.setTextSize(40);
	render.setTextColor(ORANGE);
	render.printf("こんにちは世界\n");
}

void loop() {
	// put your main code here, to run repeatedly:
}
```

### プログラム内に埋め込んだフォントを読み込む
```M5FontRender/example/load_from_binary/load_from_binary.ino``` の中身です．
```binaryttf.h``` の中に展開されたTTFファイルが格納されています．
```binaryttf.h``` の作成方法は[ページ下を参照](#埋め込みフォントファイルの作成方法)して下さい．

```c++
#include "M5Core2.h"
#include "binaryttf.h"
#include "M5FontRender.h" // Include after M5Stack.h / M5Core2.h

M5FontRender render;

void setup() {
	// put your setup code here, to run once:
	M5.begin();
	M5.Lcd.fillScreen(BLACK);
	
	if (!render.loadFont(binaryttf, sizeof(binaryttf))) {
		Serial.println("Render initialize error");
		return;
	}

	render.setTextColor(WHITE);
	render.printf("Hello World\n");
	render.seekCursor(0, 10);
	render.setTextSize(30);
	render.setTextColor(GREEN);
	render.printf("完全なUnicodeサポート\n");
	render.seekCursor(0, 10);
	render.setTextSize(40);
	render.setTextColor(ORANGE);
	render.printf("こんにちは世界\n");
}

void loop() {
	// put your main code here, to run repeatedly:

}
```

### 実行結果例
サンプルプログラムを実行した結果が下の画像です．
アンチエイリアスも効いており、とても綺麗にフォントを描画できています．
今回は私の独断と偏見で，勝手ながら[「かわいいフォント箱」様が配布している「JKゴシックM」](http://font.cutegirl.jp/jk-font-medium.html)というフォントを使用させていただきました．この場を借りてお礼申し上げます．
![result_sample](https://github.com/takkaO/M5FontRender/blob/images/sample.jpg?raw=true)

## まとめ
これで任意のフォントファイルを好きなだけ使い倒すことができますね．
もちろん**フォントサイズの変更は自由自在**です．もうフォントサイズごとにフォントファイルを用意する必要はありません！
フォントファイルをプログラム中に埋め込むことも可能なので，複数台運用する場合でも**SDカードを用意せずに済みます**．また，TTFフォントを圧縮して必要な文字だけのファイルを作成すればメモリの節約もできます．



## おまけ
### フォントファイルの圧縮方法
TTFファイルの圧縮（不要文字削除）ソフトはたくさんあるので，
お好きなものを利用して下さい．
私は[「武蔵システム」様の「サブセットフォントメーカー」](https://opentype.jp/subsetfontmk.htm)をオススメします．
基本的には使いたい文字をひたすら打ち込んで，生成ボタンを押すだけです．
よく利用しそうな文字一覧を下に用意したので，適宜ご利用下さい．

<details>
<summary>アルファベット/数字/記号（ASCII）</summary>
<div>

```
abcdefghijklmnopqrstuvwxyz
ABCDEFGHIJKLMNOPQRSTUVWXYZ
0123456789
!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
```

</div>
</details>

<details>
<summary>ひらがな</summary>
<div>

```
あいうえおかきくけこさしすせそたちつてとなにぬねのはひふへほまみむめもやゆよらりるれろわゐゑをん
がぎぐげござじずぜぞだぢづでどばびぶべぼぱぴぷぺぽ
ぁぃぅぇぉっゃゅょ
```

</div>
</details>

<details>
<summary>カタカナ</summary>
<div>

```
アイウエオカキクケコサシスセソタチツテトナニヌネノハヒフヘホマミムメモヤユヨラリルレロワヰヱヲン
ガギグゲゴザジズゼゾダヂズデドバビブベボパピプペポヴ
ァィゥェォッャュョ
```

</div>
</details>

<details>
<summary>常用漢字（2136字）</summary>
<div>

```
亜哀挨愛曖悪握圧扱宛嵐安案暗以衣位囲医依委威為畏胃尉異移萎偉椅彙意違維慰遺緯域育一壱逸茨芋引印因
咽姻員院淫陰飲隠韻右宇羽雨唄鬱畝浦運雲永泳英映栄営詠影鋭衛易疫益液駅悦越謁閲円延沿炎怨宴媛援園煙
猿遠鉛塩演縁艶汚王凹央応往押旺欧殴桜翁奥横岡屋億憶臆虞乙俺卸音恩温穏下化火加可仮何花佳価果河苛科
架夏家荷華菓貨渦過嫁暇禍靴寡歌箇稼課蚊牙瓦我画芽賀雅餓介回灰会快戒改怪拐悔海界皆械絵開階塊楷解潰
壊懐諧貝外劾害崖涯街慨蓋該概骸垣柿各角拡革格核殻郭覚較隔閣確獲嚇穫学岳楽額顎掛潟括活喝渇割葛滑褐
轄且株釜鎌刈干刊甘汗缶完肝官冠巻看陥乾勘患貫寒喚堪換敢棺款間閑勧寛幹感漢慣管関歓監緩憾還館環簡観
韓艦鑑丸含岸岩玩眼頑顔願企伎危机気岐希忌汽奇祈季紀軌既記起飢鬼帰基寄規亀喜幾揮期棋貴棄毀旗器畿輝
機騎技宜偽欺義疑儀戯擬犠議菊吉喫詰却客脚逆虐九久及弓丘旧休吸朽臼求究泣急級糾宮救球給嗅窮牛去巨居
拒拠挙虚許距魚御漁凶共叫狂京享供協況峡挟狭恐恭胸脅強教郷境橋矯鏡競響驚仰暁業凝曲局極玉巾斤均近金
菌勤琴筋僅禁緊錦謹襟吟銀区句苦駆具惧愚空偶遇隅串屈掘窟熊繰君訓勲薫軍郡群兄刑形系径茎係型契計恵啓
掲渓経蛍敬景軽傾携継詣慶憬稽憩警鶏芸迎鯨隙劇撃激桁欠穴血決結傑潔月犬件見券肩建研県倹兼剣拳軒健険
圏堅検嫌献絹遣権憲賢謙鍵繭顕験懸元幻玄言弦限原現舷減源厳己戸古呼固股虎孤弧故枯個庫湖雇誇鼓錮顧五
互午呉後娯悟碁語誤護口工公勾孔功巧広甲交光向后好江考行坑孝抗攻更効幸拘肯侯厚恒洪皇紅荒郊香候校耕
航貢降高康控梗黄喉慌港硬絞項溝鉱構綱酵稿興衡鋼講購乞号合拷剛傲豪克告谷刻国黒穀酷獄骨駒込頃今困昆
恨根婚混痕紺魂墾懇左佐沙査砂唆差詐鎖座挫才再災妻采砕宰栽彩採済祭斎細菜最裁債催塞歳載際埼在材剤財
罪崎作削昨柵索策酢搾錯咲冊札刷刹拶殺察撮擦雑皿三山参桟蚕惨産傘散算酸賛残斬暫士子支止氏仕史司四市
矢旨死糸至伺志私使刺始姉枝祉肢姿思指施師恣紙脂視紫詞歯嗣試詩資飼誌雌摯賜諮示字寺次耳自似児事侍治
持時滋慈辞磁餌璽鹿式識軸七叱失室疾執湿嫉漆質実芝写社車舎者射捨赦斜煮遮謝邪蛇尺借酌釈爵若弱寂手主
守朱取狩首殊珠酒腫種趣寿受呪授需儒樹収囚州舟秀周宗拾秋臭修袖終羞習週就衆集愁酬醜蹴襲十汁充住柔重
従渋銃獣縦叔祝宿淑粛縮塾熟出述術俊春瞬旬巡盾准殉純循順準潤遵処初所書庶暑署緒諸女如助序叙徐除小升
少召匠床抄肖尚招承昇松沼昭宵将消症祥称笑唱商渉章紹訟勝掌晶焼焦硝粧詔証象傷奨照詳彰障憧衝賞償礁鐘
上丈冗条状乗城浄剰常情場畳蒸縄壌嬢錠譲醸色拭食植殖飾触嘱織職辱尻心申伸臣芯身辛侵信津神唇娠振浸真
針深紳進森診寝慎新審震薪親人刃仁尽迅甚陣尋腎須図水吹垂炊帥粋衰推酔遂睡穂随髄枢崇数据杉裾寸瀬是井
世正生成西声制姓征性青斉政星牲省凄逝清盛婿晴勢聖誠精製誓静請整醒税夕斥石赤昔析席脊隻惜戚責跡積績
籍切折拙窃接設雪摂節説舌絶千川仙占先宣専泉浅洗染扇栓旋船戦煎羨腺詮践箋銭潜線遷選薦繊鮮全前善然禅
漸膳繕狙阻祖租素措粗組疎訴塑遡礎双壮早争走奏相荘草送倉捜挿桑巣掃曹曽爽窓創喪痩葬装僧想層総遭槽踪
操燥霜騒藻造像増憎蔵贈臓即束足促則息捉速側測俗族属賊続卒率存村孫尊損遜他多汰打妥唾堕惰駄太対体耐
待怠胎退帯泰堆袋逮替貸隊滞態戴大代台第題滝宅択沢卓拓託濯諾濁但達脱奪棚誰丹旦担単炭胆探淡短嘆端綻
誕鍛団男段断弾暖談壇地池知値恥致遅痴稚置緻竹畜逐蓄築秩窒茶着嫡中仲虫沖宙忠抽注昼柱衷酎鋳駐著貯丁
弔庁兆町長挑帳張彫眺釣頂鳥朝貼超腸跳徴嘲潮澄調聴懲直勅捗沈珍朕陳賃鎮追椎墜通痛塚漬坪爪鶴低呈廷弟
定底抵邸亭貞帝訂庭逓停偵堤提程艇締諦泥的笛摘滴適敵溺迭哲鉄徹撤天典店点展添転填田伝殿電斗吐妬徒途
都渡塗賭土奴努度怒刀冬灯当投豆東到逃倒凍唐島桃討透党悼盗陶塔搭棟湯痘登答等筒統稲踏糖頭謄藤闘騰同
洞胴動堂童道働銅導瞳峠匿特得督徳篤毒独読栃凸突届屯豚頓貪鈍曇丼那奈内梨謎鍋南軟難二尼弐匂肉虹日入
乳尿任妊忍認寧熱年念捻粘燃悩納能脳農濃把波派破覇馬婆罵拝杯背肺俳配排敗廃輩売倍梅培陪媒買賠白伯拍
泊迫剥舶博薄麦漠縛爆箱箸畑肌八鉢発髪伐抜罰閥反半氾犯帆汎伴判坂阪板版班畔般販斑飯搬煩頒範繁藩晩番
蛮盤比皮妃否批彼披肥非卑飛疲秘被悲扉費碑罷避尾眉美備微鼻膝肘匹必泌筆姫百氷表俵票評漂標苗秒病描猫
品浜貧賓頻敏瓶不夫父付布扶府怖阜附訃負赴浮婦符富普腐敷膚賦譜侮武部舞封風伏服副幅復福腹複覆払沸仏
物粉紛雰噴墳憤奮分文聞丙平兵併並柄陛閉塀幣弊蔽餅米壁璧癖別蔑片辺返変偏遍編弁便勉歩保哺捕補舗母募
墓慕暮簿方包芳邦奉宝抱放法泡胞俸倣峰砲崩訪報蜂豊飽褒縫亡乏忙坊妨忘防房肪某冒剖紡望傍帽棒貿貌暴膨
謀頬北木朴牧睦僕墨撲没勃堀本奔翻凡盆麻摩磨魔毎妹枚昧埋幕膜枕又末抹万満慢漫未味魅岬密蜜脈妙民眠矛
務無夢霧娘名命明迷冥盟銘鳴滅免面綿麺茂模毛妄盲耗猛網目黙門紋問冶夜野弥厄役約訳薬躍闇由油喩愉諭輸
癒唯友有勇幽悠郵湧猶裕遊雄誘憂融優与予余誉預幼用羊妖洋要容庸揚揺葉陽溶腰様瘍踊窯養擁謡曜抑沃浴欲
翌翼拉裸羅来雷頼絡落酪辣乱卵覧濫藍欄吏利里理痢裏履璃離陸立律慄略柳流留竜粒隆硫侶旅虜慮了両良料涼
猟陵量僚領寮療瞭糧力緑林厘倫輪隣臨瑠涙累塁類令礼冷励戻例鈴零霊隷齢麗暦歴列劣烈裂恋連廉練錬呂炉賂
路露老労弄郎朗浪廊楼漏籠六録麓論和話賄脇惑枠湾腕
```

</div>
</details>

### 埋め込みフォントファイルの作成方法
埋め込みフォントの作成には ```binary2ttf.py``` を利用します．
```binary2ttf.py```は M5EPD のライブラリで提供されており，同じプログラムを M5FontRender 内の```tools```に同梱しています．
使用方法は ```binary2ttf.py``` があるディレクトリで以下のコマンドを実行するだけです．

```bash
python3 binary2ttf.py your_font_file.ttf
```

実行後、同フォルダ内に埋め込み用のCヘッダファイルが生成されます．

## 参考文献
- [m5stack/M5EPD - github](https://github.com/m5stack/M5EPD)
- [h1romas4/m5stack-core2-template at freetype - github](https://github.com/h1romas4/m5stack-core2-template/tree/freetype)
- [文字一覧 (ASCII) - instant tools](https://tools.m-bsys.com/data/charlist_ascii.php)
- [パンダコノート: 五十音のテキストデータ（ひらがな・カタカナの一覧）](http://note.pandako.com/2015/01/blog-post.html)
- [rime-aca/常用漢字表.txt - github](https://github.com/rime-aca/character_set/blob/master/%E5%B8%B8%E7%94%A8%E6%BC%A2%E5%AD%97%E8%A1%A8.txt)