diff --git a/crates/voicevox_core/src/voice_model.rs b/crates/voicevox_core/src/voice_model.rs index 77e7bd784..76f692eaa 100644 --- a/crates/voicevox_core/src/voice_model.rs +++ b/crates/voicevox_core/src/voice_model.rs @@ -1,3 +1,7 @@ +//! 音声モデル( VVM ファイル)。 +//! +//! VVM ファイルの定義と形式は[ドキュメント](../../../docs/vvm.md)を参照。 + use derive_getters::Getters; use derive_new::new; use serde::Deserialize; diff --git a/docs/vvm.md b/docs/vvm.md index 572ffee1a..c2de7fb41 100644 --- a/docs/vvm.md +++ b/docs/vvm.md @@ -1,9 +1,24 @@ # VVM ファイル -音声合成するために必要な onnx モデルファイルなどがまとめられた zip 形式のファイル。 -root パスに確定で`manifest.json`を持つ。 +***VVM ファイル*** は、音声合成に必要な声情報を含むファイルである。 + +より正確には、音声合成のモデル重みファイルなどを含む zip 形式のアーカイブである。拡張子は `.vvm`。 +以下の内部ディレクトリ構造を持つ: + +- `{filename}.vvm` + - `manifest.json` + - `metas.json` + - + - + - + +model は `.onnx` や `.bin` など様々ある。例えば `sample.vvm` は `predict_duration.onnx` / `predict_intonation.onnx` / `decode.onnx` を含む。 + +VOICEVOX OSS が提供する VVM には [`sample.vvm`](https://github.com/VOICEVOX/voicevox_core/tree/main/model) がある。 +製品版 VOICEVOX で利用される VVM は [こちらのレポジトリ](https://github.com/VOICEVOX/voicevox_fat_resource/tree/main/core/model) で確認できる。 ## マニフェストファイル -ファイルの構成や、onnx モデルなどを読み込む・利用するのに必要な情報を記述した json ファイル。 -root パスに`manifest.json`として配置する。 +VVM における ***マニフェストファイル*** は、VVM ファイルの構成や、onnx モデルなどを読み込む・利用するのに必要な情報を記述したファイルである。 +json 形式で記述され、root パスに`manifest.json`として配置する。 +[VOICEVOX CORE のソースコード](https://github.com/VOICEVOX/voicevox_core/blob/main/crates/voicevox_core/src/manifest.rs) 内で `Manifest` 構造体としてスキーマが定義されている。