change: `VoiceModel` → `VoiceModelFile` #832

qryxip · 2024-09-15T17:42:38Z

内容

#829 を行います。変更は大体こんな感じです。

変更前	変更後
音声モデル。	音声モデルファイル。
`VoiceModel` (C以外)	`VoiceModelFile` (C以外)
`VoicevoxVoiceModel` (C)	`VoicevoxVoiceModelFile` (C)

変更前	変更後
VVMファイルから`VoiceModel`をコンストラクトする。	VVMファイルを開く。
`VoiceModel::from_path` (Rust, Python)	`VoiceModelFile::open` (Rust, Python)
`voicevox_voice_model_new_from_path` (C)	`voicevox_voice_model_file_open` (C)

変更前	変更後
N/A	VVMファイルを閉じる。
N/A	`VoiceModelFile::close` (Rust, Python, Java)
N/A	`VoiceModelFile.__a{enter,exit}__` (Python, Java)
`voicevox_voice_model_delete` (C)	`voicevox_voice_model_file_close` (C)

Synthesizer::load_voice_model中にVoiceModelFile::closeしたときの挙動はこんな感じになっているはずです。ただしまだこれらについてのテストは書いてませんし手動での確認もやってません。

言語	`Synthesizer::load_voice_model`中に`close`したときの挙動
Rust (同期版 & 非同期版)	そもそも起こり得ない
Python (同期版 & 非同期版)	~~例外（`Exception`）を発する~~ Javaと同様にロックして待つ
Java	`load_voice_model`が終わるまでロックして待つ
C	（ユーザーに課してる規約上）そもそも起こり得ない

[追記1] Python APIでload_voice_modelが終わるまでロックして待つのが面倒そうに感じたのでこうなってしまったのですが、よく考えたらそんなに難しくなかった。それよりもロックするようなデザインにするか例外を発するようなデザインにするかですね。

[追記2] ロックする方のデザインの方がいいかもですね。reader-writer lockが一つあれば実装できますし、C APIにもAPIをシンプルにしたまま仕込める。

[追記3] Python APIをロックするデザインにしてしまいました。こんな感じになります。

    async with await VoiceModelFile.open(vvm_path) as model:
        _ = synthesizer.load_voice_model(model) # awaitしない

[WARNING] voicevox_core_python_api: The `VoiceModelFile` is still in use. Waiting before closing
[DEBUG] voicevox_core_python_api: Closing a VoiceModelFile
# load_voice_modelが無事完了している

その他

Hiroshiba

なるほどな設計に思いました！！

すみません、インターフェイスを見て今更思いついたのですが、これってc api等で２つ以上のSynthesizerにopen済みのModelFileを登録（ロード？）した場合に問題などは生じそうでしょうか？
（どうするかはさておき、一旦問題が起きそうかだけお聞きしてる感じです！）

qryxip · 2024-09-17T01:09:37Z

現行実装と変わらず、特に問題無く並行実行できるはずです。close時に1箇所以上からのアクセスがまだ走ってるなら、そのすべてが終わるまでロックするという感じです。私がreader writer lockと言ったやつについては（呼び方は違いますが）以下リンクで解説されています。
共有／排他ミューテックス(Shared-Exclusive Mutex) - マルチスレッド・プログラミングの道具箱 - Zenn

(まあ並行実行のテストは無いです。が、並行実行のテストというのも難しいのでこういう感じのベンチのコードを管理して手軽に確認できるようにするという感じがよさそう)
#746 (comment)

Hiroshiba · 2024-09-18T04:59:40Z

おおなるほどです！！問題なさそう！
レビュー始めたいと思います🙏

Hiroshiba

良さそう！！！
いくつか細かいコメントをさせていただきました！

ほぼLGTMなのですが、Python版に関してちょっと気になることがあったのでそこだけという感じです！

crates/voicevox_core/src/asyncs.rs

crates/voicevox_core_python_api/python/voicevox_core/_rust/blocking.pyi

qryxip · 2024-09-18T08:07:04Z

aebe2ea (#832): 誤字訂正
80c707b (#832) +5-5のちょっとしたリファクタ

qryxip · 2024-09-18T08:25:24Z

crates/voicevox_core/src/__internal/interop/raii.rs

このコードをそのままChatGPT 4oに投げ付けてみたら一発で満点の答えを返してくれた。こういうところではコメントでの説明を省いていきたいなーと個人的には思っている。
https://chatgpt.com/share/66ea8dce-a580-800c-b4fd-37af1084bfa5

実装の中身については、G: 'a, T: 'static (∀.'a)という制約を入れることで"T ourlives G"の関係にしてouroborosに突っ込めばSafe Rustで記述しきれる、というのが肝。

ただChatGPTがこのことに辿り着くのは難しそう。「この'aは？」って聞いてもわかってなさげな答えを返してきた。

…やっぱコメント書くべきか？いやRust詳しい人ならわかるだろうし…

11be136 (#832)

T: 'staticについてwhyのコメントが要りそうだったので、今回の場合はdocstringに入れることにしました。

あ！！！ T outlives Gの関係にするのにT: 'staticにする必要は無い！

ということで、whyのドキュメントは消えてまたコメント無しに…
74a482d (#832)

追記: さらに改修して、今はこんな感じになりました。
https://github.com/qryxip/voicevox_core/blob/aed651b9105046b37036f0178368abdf15b96f64/crates/voicevox_core/src/__internal/interop/raii.rs#L10-L43

ここについて色々考えてみて結論としては

Rust初学者には相当難しい

とはいえここはユーティリティで、ここを変更しに来る人はものすごい珍しい

なので、求めてるものはここじゃないことがわかればいい

try_map_guardという名前はwhatもわからないけど、処理を大きく変えてくるような印象はない

つまりスルーしても良さそうには感じる

総合すると、今の形で OK ！

という感じかなと！！

Hiroshiba

LGTM！！！

勉強になりました、ありがとうございます！！

まだちょこちょこコメント書いているんですが、そのままマージで問題ないと感じています！
気が向いたらくらいの気持ち！

`VoicevoxVoiceModelFile`の次のゲッター関数を、ゲッター関数ではなくする。 - `voicevox_voice_model_file_id` `uint8_t (*output_voice_model_id)[16]`に吐き出すようにする。 - `voicevox_voice_model_file_get_metas_json` `voicevox_voice_model_file_create_metas_json`に改名。ねらいとしては VOICEVOX#832 のような設計をC APIでも行うことで、サードパーティのバインディング製作者の労力を減らすため。上記のゲッター関数がゲッターではなくなれば、オブジェクトへのアクセスを完全に管理できる。 VOICEVOX#849 (comment)

`VoicevoxVoiceModelFile`の次のゲッター関数を、ゲッター関数ではなくする。 - `voicevox_voice_model_file_id` `uint8_t (*output_voice_model_id)[16]`に吐き出すようにする。 - `voicevox_voice_model_file_get_metas_json` `voicevox_voice_model_file_create_metas_json`に改名。ねらいとしては #832 のような設計をC APIでも行うことで、サードパーティのバインディング製作者の労力を減らすため。上記のゲッター関数がゲッターではなくなれば、オブジェクトへのアクセスを完全に管理できる。 #849 (comment)

qryxip requested a review from Hiroshiba September 15, 2024 17:42

change: VoiceModel → VoiceModelFile

f32872e

qryxip force-pushed the change-voice-model-to-voice-model-file branch from 0432206 to f32872e Compare September 16, 2024 04:30

qryxip added 2 commits September 17, 2024 00:08

Minor refactor

58a42aa

__aexit__をロックする実装にする

2fe40f6

Hiroshiba reviewed Sep 17, 2024

View reviewed changes

qryxip added 6 commits September 17, 2024 19:15

ドキュメントを訂正

dfc5002

クローズしててもDropが警告を出すのを修正

695c0a9

Java APIでもRwLock管理にする

d69571a

Synthesizer.__aexit__はexampleではやらない

a906bcd

Javadocを更新

6f0edf4

Minor refactor

d9c86ed

Hiroshiba reviewed Sep 18, 2024

View reviewed changes

crates/voicevox_core/src/asyncs.rs Show resolved Hide resolved

crates/voicevox_core/src/asyncs.rs Show resolved Hide resolved

crates/voicevox_core/src/asyncs.rs Show resolved Hide resolved

crates/voicevox_core_python_api/python/voicevox_core/_rust/blocking.pyi Show resolved Hide resolved

qryxip added 2 commits September 18, 2024 17:03

誤字訂正

aebe2ea

Minor refactor

80c707b

qryxip commented Sep 18, 2024

View reviewed changes

qryxip added 4 commits September 18, 2024 18:08

open_file_roにdoc

22c36e0

try_map_guardにdoc

11be136

誤字訂正

32be19f

fixup! open_file_roにdoc

752aedb

qryxip requested a review from Hiroshiba September 18, 2024 11:40

qryxip added 4 commits September 18, 2024 20:53

try_map_guardからT: 'staticを外す

74a482d

fixup! try_map_guardからT: 'staticを外す

9555cfc

fixup! try_map_guardからT: 'staticを外す

b01afb0

fixup! try_map_guardからT: 'staticを外す

aed651b

Hiroshiba approved these changes Sep 18, 2024

View reviewed changes

qryxip merged commit 967570a into VOICEVOX:main Sep 19, 2024
37 checks passed

qryxip deleted the change-voice-model-to-voice-model-file branch September 19, 2024 00:48

qryxip mentioned this pull request Sep 25, 2024

C APIの"delete"を安全なAPIにする #836

Closed

3 tasks

qryxip mentioned this pull request Oct 5, 2024

add: C APIの#[repr(Rust)]なものへのアクセスをすべて安全にする #849

Merged

qryxip mentioned this pull request Oct 6, 2024

change: C APIからゲッター関数を無くす #850

Merged

qryxip mentioned this pull request Oct 12, 2024

ストリーミング処理の対応 #853

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

change: `VoiceModel` → `VoiceModelFile` #832

change: `VoiceModel` → `VoiceModelFile` #832

qryxip commented Sep 15, 2024 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

qryxip commented Sep 17, 2024 •

edited

Loading

Hiroshiba commented Sep 18, 2024

Hiroshiba left a comment •

edited

Loading

qryxip commented Sep 18, 2024

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

Hiroshiba Sep 18, 2024

Hiroshiba left a comment

change: VoiceModel → VoiceModelFile #832

change: VoiceModel → VoiceModelFile #832

Conversation

qryxip commented Sep 15, 2024 • edited Loading

内容

関連 Issue

その他

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

qryxip commented Sep 17, 2024 • edited Loading

Hiroshiba commented Sep 18, 2024

Hiroshiba left a comment • edited Loading

Choose a reason for hiding this comment

qryxip commented Sep 18, 2024

qryxip Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

qryxip Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

qryxip Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

qryxip Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

Hiroshiba Sep 18, 2024

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

change: `VoiceModel` → `VoiceModelFile` #832

change: `VoiceModel` → `VoiceModelFile` #832

qryxip commented Sep 15, 2024 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

qryxip commented Sep 17, 2024 •

edited

Loading

Hiroshiba left a comment •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading

qryxip Sep 18, 2024 •

edited

Loading