Skip to content

Commit

Permalink
マルチエンジン周りのドキュメントを追加 (#617)
Browse files Browse the repository at this point in the history
* マルチエンジン周りのドキュメントを追加

* vvppp追記

* Update README.md
  • Loading branch information
Hiroshiba authored Feb 11, 2023
1 parent da60a0c commit 39f062c
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,43 @@ poetry export --without-hashes --with license -o requirements-license.txt
python -c "import pyopenjtalk; pyopenjtalk.create_user_dict('default.csv','user.dic')"
```

## マルチエンジン機能に関して

VOICEVOX エディターでは、複数のエンジンを同時に起動することができます。
この機能を利用することで、自作の音声合成エンジンや既存の音声合成エンジンを VOICEVOX エディター上で動かすことが可能です。

<details>

### マルチエンジン機能の仕組み

VOICEVOX API に準拠した複数のエンジンを統一的に扱います。それぞれのエンジンは EngineID で管理されます。

<img src="./docs/res/マルチエンジン概念図.svg" width="320">

### マルチエンジン機能への対応方法

VOICEVOX API に準拠することで対応が可能です。
API のうちどのエンドポイントに対応すればよいかはまだ明確に定めていませんが、基本的にこの VOICEVOX ENGINE リポジトリを fork し、一部の機能を改造することでの開発をおすすめします。

エンジンの情報はエンジンマニフェスト(`engine_manifest.json`)で管理されています。
マニフェストファイル内の情報を見て適宜変更してください。

音声合成エンジンによっては、例えばモーフィング機能など、VOICEVOX と同じ機能を持つことができない場合があります。
その場合はマニフェストファイル内の`supported_features`内の情報を適宜変更してください。

### マルチエンジン機能対応エンジンの配布方法

VVPP ファイルとして配布するのがおすすめです。
VVPP は「VOICEVOX プラグインパッケージ」の略で、ビルドしたエンジンをディレクトリごと Zip 化して拡張子を`.vvpp`に変更したものです。

VOICEVOX エディターは VVPP をローカルディスク上に展開したあと、ルートの直下にある`engine_manifest.json`に従ってファイルを探査します。
VOICEVOX エディターにうまく読み込ませられないときは、エディターのエラーログを参照してください。

また、`xxx.vvpp`は分割して連番を付けた`xxx.0.vvppp`ファイルとして配布することも可能です。
これはファイル容量が大きくて配布が困難な場合に有用です。

</details>

## GitHub Actions

### Secrets
Expand Down
Loading

0 comments on commit 39f062c

Please sign in to comment.