nalulululuna

Beat Saber mod 用シリアライザの検討

Added 2023-11-30 14:35:37 +0000 UTC

はじめに

シリアライザ、シリアライズに使うもの、という意味ですが、シリアライズとはなにかというところから…。

簡単に言えば、ここでのシリアライズとは、データをファイルとして保存する、ということだと思ってください。厳密な定義としてはファイルの形として保存するかどうかは関係ないのですが、今回はファイルの読み書きで使用します。

JSON

データを簡単にファイル読み書きするフォーマットとしては JSON が挙げられます。Beat Saber の設定ファイルでもこの形式が使用されており、ファイルの中身は下記のようになっています。

{

"enabled": true,

"position": {

"x": 0.0,

"y": 1.0,

"z": 4.0

}

このように人間が見てわかる内容で、テキストエディタで開いて編集することもでき便利です。一方で、コンピューターが扱う形としては、人間向けの形として読み込み、書き込みする分、不要な処理が入るため、速度や効率に関しては最適とは言えません。

高速シリアライザ

人間が手動で中身を読み書きする必要がないフォーマットの場合、JSON を使用する必要はありません (実使用上に問題がなければ使用する選択肢もあります)。このような場合によく使われるのが、高速シリアライザの類です。

Beat Saber ModAssistant の Libraries のところには protobuf-net というものが入っていますが、これも高速シリアライザのひとつで、Beat Saber に限定されたものではなく、さまざまなプログラミング言語で使用できる汎用的なシリアライザです。

https://github.com/protobuf-net/protobuf-net

今回はこれと、もうひとつ、protobuf-net の後にでてきた、MessagePack というものを比較検討していきます。

https://github.com/MessagePack-CSharp/MessagePack-CSharp

MessagePack 配布元によるベンチマークでは、protobuf-net よりも高速でバイナリサイズも小さくなる、という触れ込みですが、このあたりは条件により変わる部分も大きいので、実際に Beat Saber 内の実使用条件で比較してみようと思います。

ちなみに、MessagePack の後にでた、さらに高速という触れ込みの MemoryPack も検討したのですが、こちらは Beat Saber 1.29.1 がベースとしている Unity 2019.4.28 では動作させることができなかったため断念しました。Unity 2021.3.16 がベースの Beat Saber 1.29.4 以降なら動くかもしれませんが…、まだ当分は Beat Saber 1.29.1 の対応を放棄することはできないため、採用できません。

https://github.com/Cysharp/MemoryPack

シリアライザの使用例

これらのシリアライザが具体的にどのようにいかされているかというと、たとえば、NalulunaAnimator は起動時に内蔵のアニメーションと、外部ファイルに用意されたアニメーション、これらを読み込む処理があります。

なにも工夫をしないと、内蔵のアニメーションの読み込みだけで 2 秒、また、1 曲分のダンスアニメーションのような巨大な anim ファイルをたくさん用意していた場合は、読み込み時間はさらに 10秒、20秒と増える可能性があります。Beat Saber の起動にそんなに時間がかかるようになってしまっては耐えられませんよね。

そこで、これらのアニメーションを初回に読み込んだあと、高速に読み込むことのできる別の形式として保存しなおしておくことで、次回起動時の読み込み時間を短縮することが可能になります。

それでは、どの程度高速化されるのでしょうか。次のテストをご覧ください。