マルチエンジン：VVPPに7zを使えるように

[sevenc-nanashi]

内容

タイトル通り。vvppに7zを使えるようにします。

関連 Issue

• ref: エンジンのプラグイン化（複数のエンジンを同時に見れるようにする） voicevox_project#2

スクリーンショット・動画など

（なし）

その他

Mac/Linuxは未検証です。

[sevenc-nanashi]

テストビルド： https://github.com/sevenc-nanashi/voicevox/releases/tag/0.15.0-preview-7z.1

[PickledChair]

Mac で動作確認してみましたが、vvpp を読み込めないようでした。

まず、sharevox の vvpp を一度解凍して、7z で圧縮し直したもので試してみました（ 7z a sharevox_engine-macos-x64-0.2.0.vvpp sharevox_engine-macos-x64-0.2.0 しました。やり方が間違っていたらすみません……！）。その時は以下のようなダイアログが出ました：

その時のエラーログは以下です（/Users/suitcase/engines 以下に vvpp を配置しています）。一時ディレクトリのようなもの（実際に存在しているかどうかは不明）の中のファイルを開こうとしている感じでしょうか……？：

[23:12:04.674] [error] Failed to install /Users/suitcase/engines/sharevox_engine-macos-x64-0.2.0.vvpp, Error: ENOENT: no such file or directory, open '/Users/suitcase/Library/Application Support/voicevox/vvpp-engines/.tmp/1678889466823/engine_manifest.json'

また、元々の zip 版の vvpp でも試してみましたが、こちらも上手く行きませんでした。「追加中」の表示のまま次に行かなくなりました。エラーログも確認したのですがこちらはエラーの報告が出力されていませんでした……

[sevenc-nanashi]

うーん。7zがzipファイルだけを含んだ7zアーカイブになってそう？
自分はExplzhでvvppを7zに変換しました。

[sevenc-nanashi]

割れ窓の修正。

[sevenc-nanashi]

よくよく考えたら：普通のzipも7zで解凍しちゃった方がコード量も減るし速くなるので良さげ？

[PickledChair]

7z 版の vvpp に関しては、zip 解凍後の sharevox の vvpp を以下のように圧縮し直すと上手く行きました。前回上手く行かなかったのは、解凍後のディレクトリ構造が想定と違ったからのようでした。

cd sharevox_engine-macos-x64-0.2.0
7z a ../compressed.7z . -r
cd ..
mv compressed.7z sharevox_engine-macos-x64-0.2.0.vvpp

一方、なぜか元々の zip 版 vvpp の方は読み込めないままです。こちらは処理は大して変わっていないように見えるのですがなぜでしょう……。エラーログが出ていないので詳細が不明です。vvpp-engines/.tmp ディレクトリ以下にも展開中の様子が見られませんでした。Windows では こちらからダウンロードした vvpp を正常に使用できますか？

また、Linux/macOS に関しては、システムに p7zip がインストールされている想定の実装でしょうか？　もしそうでしたら、どちらの OS でも基本的にデフォルトでは p7zip がインストールされていないので、通常のユーザー環境では動作しないと思いました。 失礼しました、Windows 以外でも 7z が同梱されるようになっていますね

[Hiroshiba]

@sevenc-nanashi

よくよく考えたら：普通のzipも7zで解凍しちゃった方がコード量も減るし速くなるので良さげ？

zip側の依存減るし、普通にありだと思います。
7zr.exeじゃない7z.exe辺りがが必要になりそうですが、容量だけちょっと心配です。

[madosuki]

Windowsでもzip版vvppをインストールできませんね。
試したみた感じでは、非同期で実行されるMultiStreamが終了する前にfinallyに到達しcloseが行われているぽかったのでclose処理をawait new Promise((resolve, reject))の後に行うようにしたらインストールに成功しました。

[sevenc-nanashi]

7zr.exeじゃない7z.exe辺りがが必要になりそうですが、容量だけちょっと心配です。

必要でした。
7zr.exeは565KB、7za.exeは1229KBでした。

[sevenc-nanashi]

試したみた感じでは、非同期で実行されるMultiStreamが終了する前にfinallyに到達しcloseが行われているぽかった

結局使わなくなりました。ありがとうございます

[Hiroshiba]

• ライセンス表記周りも必要かもです
• mac・linuxで動く周りが気になりました。
  • たぶん動くんですが、Actions上の7zコマンドをパクってくることになって、なんのバイナリかわからなくてライセンス表記できない･･･。
• あとたぶんdllはいらない気がします
  • 不安な場合はwindows サンドボックス上にインストールしてみると動くか確かめられるかも

大いなる力には大いなる責任が伴うので、こういう辺りしっかり作らないといけないのが大変ですが、もしよかったら･･･！

[sevenc-nanashi]

ライセンス表記周りも必要かもです

環境に合わせた7z（7za、7zz、p7zip）を落とすスクリプトを作り、
vendored/7zみたいなところに落とし、
generateLicensesにそこからライセンスを取ってこさせるようにしてみます。

（build/のスクリプトをTypeScriptにしたい…）

[sevenc-nanashi]

レビュー反映しましたー。

[Hiroshiba]

vendoredディレクトリですが、なんのことか初学者の方にもわかりやすいようにthird_party辺りが良いかもと思いました。
雑に前例を探してみた感じ、pytorchがthird_partyでした。https://github.com/pytorch/pytorch

[sevenc-nanashi]

多分、初学者は判らなくても中のREADME.mdを見ると思います（GitHub上ではサブフォルダでもREADMEが出てくれる）

多分このフォルダの一番正しい名称はdownloaded_dependenciesだと思います

[sevenc-nanashi]

レビューを反映しましたー。

[Hiroshiba]

いろいろ書きましたがほぼLGTMです！

[sevenc-nanashi]

軽いドキュメント追加しましたー。

[Hiroshiba]

LGTM！！

なのですが、ちょっと全体的に煩雑度が上がっている印象があり、もしかしたらもっとスマートなアーキテクチャを組めるかもとちょっとだけ思いました。

ということでレビューお願いしたいです･･･！ @y-chan
（全体で900行程度の差分ですが、lock.jsonの差分が600行なのでそこまでヘビーじゃないはず･･･！）

[Hiroshiba]

@y-chan さんお忙しそうなのと、問題ないと思うのでマージします！！

[Hiroshiba]

7zがパッケージに内包されるか試すためにreleases作ってみます。

• https://github.com/VOICEVOX/voicevox/releases/tag/0.15.0-preview.0