コグノスケ

何もない組み込み環境でDOOMを動かす - その2 - 組み込み環境への移植方針

目次: RISC-V

DOOMのクローン実装prboom2を組み込み環境に移植する話です。前回はLinux上で動作確認しました。今回は想定する組み込み環境と移植作戦＆移植です。

組み込み環境への移植作戦

想定する組み込み環境は下記のとおりです。

• CPU、メモリ
• I/O: UARTのみ
• 画面出力: なし
• ファイル: なし
• サウンド: なし
• ジョイスティック入力: なし

改造元にするコードは何でも良いですけど、私は動作するコードから出発した方がやりやすいので、前回Linux上で動作を確認した実装（src/SDL/*）をベースに改造します。移植にあたって障害となりそうなものは、

• SDL
• サウンド機能
• ジョイスティック入力
• ファイルアクセス機能
• 画面描画機能

この辺の機能が移植先の組み込み環境に存在しないことです。順番に対処しましょう。

SDL、サウンド機能、ジョイスティック入力への対処

SDL（Simple DirectMedia Layer、公式サイトへのリンク、リポジトリへのリンク）はC/C++から簡単にグラフィクスや音声、各種入力機能が利用できる、素敵なライブラリです。が、しかし移植先の環境にSDLなどという高等なものはないのでSDLを使用している箇所は削除します。

メイン（src/SDL/i_main.c）、サウンド（src/SDL/i_sound.c）、画面（src/SDL/i_video.c）とジョイスティック入力（src/SDL/i_joy.c）はSDL.hをインクルードか、SDLの構造体やマクロを使用していてコンパイルエラーになるので、エラーになる箇所を全て削除します。

サウンド（src/SDL/i_sound.c）、とジョイスティック入力（src/SDL/i_joy.c）は動作しなくても問題を起こさないように、常に成功もしくは無意味な値を返すように改造します。

ファイルアクセス機能への対処

ゲームエンジンを動作させるにはprboom2ビルド時に生成されるprboom.wadとIWADファイル（オリジナルのDOOMのWADを指してこのように呼ぶそうです）の2つのファイルが必要です。が、移植先の環境にファイルなどという高尚なものはないので、下記の作戦でファイルアクセスなしでも動作するように改造します。

• ファイルデータ: 静的配列に置き換え（変換ツールも作る）
• ファイルデスクリプタ: 独自の構造体に置き換え
• ファイルオープン: prboom.wadとIWADファイル以外は無視（＝常にオープン処理を失敗させる）
• ファイル読み出し: 静的配列からのコピーに置き換える
• ファイルシーク: 静的配列のポインタ移動に置き換える

ファイルアクセスを行うコードはシステム（src/SDL/i_system.c）に実装されていますので、ファイルアクセスしている実装を全部静的配列へのアクセスに書き換えます。他の場所（src/d_main.c, src/w_wad.c）のファイルアクセスしている箇所も同様に置き換えます。

ファイルから配列へ変換

ファイルアクセス機能を置き換えたので、ファイル（DOOM.WADとprboom.wad）をC言語の静的配列に変換する方法も作りましょう。

変換方法は色々あると思いますが、昔作った「CmakeでバイナリをC言語の配列に変換する」やつを使います（2023年6月16日の日記参照）。こやつは適当に作った割に意外と便利です。

画面描画への対処

画面描画を削除するとDOOMが動いているかどうかわかりません。移植先の環境に画面を描画するような高尚な機能はないので、UARTとANSIエスケープシーケンスを利用して画面描画の代わりとします。

UARTの出力を受け取る端末には文字を出力する以外にもたくさんの機能があります。端末の各種機能のなかから「背景色の設定＋空白の出力」をピクセル描画の代わりとして利用します。端末によって対応する機能は異なり（ECMA-48やANSI X3.64仕様が有名）ますが、今回の実装ではANSI X3.64のカーソル移動、文字色の変更機能を使用します。大抵の端末ソフトが実装しているはずです。たぶん。

端末の文字は縦長（縦:横＝2:1くらい、フォント依存です）が多いため、Space 2文字でだいたい正方形になります。つまり背景色変更 + Spece 2文字 = 1ピクセルとすれば画面の描画ができるという寸法です。普通の文字サイズだと1ピクセルが大きくなりすぎるので、端末側のフォントサイズ設定で調整しましょう。

背景色を変更するエスケープシーケンスはこんな感じ。

• 256-color mode: ESC[48;5;<n>m
• 24bit color mode: ESC[48;2;<r>;<g>;<b>m

24bit色モードであれば1つのピクセルを表現するために、エスケープシーケンス16バイト＋スペース2バイト = 18バイト必要になります。極めて効率が悪いですが、とりあえず動かすために先に進みましょう。

方針が決まったところで画面描画の実装（src/SDL/i_video.c）を改造します。prboom2の画面はフルカラーではなくパレット描画なので、パレット操作をする部分も合わせて改造します。

prboom2が動作している様子（ウインドウはPuTTY、画面サイズ128x120、フォントサイズ5pt）

実際描画してみるとこんな感じです。ウインドウタイトルを見るとわかりますが、SDLによる描画ではなくPuTTYという端末ソフトウェアの画面です。

とりあえず動きました。やったね。画面描画が遅い問題は、次回以降対処していこうと思います。