Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Conversation

qryxip
Copy link
Member

@qryxip qryxip commented Oct 6, 2024

内容

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)

関連 Issue

#836

その他

CC: @yamachu

`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)
@qryxip qryxip requested a review from Hiroshiba October 6, 2024 17:22
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

ちょっと確認です!

確か文字列の管理は、freeが必要なやつと必要じゃないやつの2パターンあった気がします。
バージョン情報の取得とかはfree不要なタイプだった記憶。
で、そのfree不要の文字列を間違えてfreeしてしまわないように、確か何かしらの安全策を講じていた記憶があります。

今回でそのfreeしなくていいタイプの文字列が全部なくなった感じでしょうか? 👀
それともまだ一部残ってる感じでしょうか。

これを確認している意図としては、もし全部消えた場合はその安全用のコードを削除できるなーと。
もし削除していなかったら、のちに削除が必要だな~と認識しておきたい感じです!

@qryxip
Copy link
Member Author

qryxip commented Oct 6, 2024

以下の三つが、.rodataに置かれるような完全に静的な文字列を返します。

const char *voicevox_get_version(void);
const char *voicevox_get_onnxruntime_lib_versioned_filename(void);
const char *voicevox_get_onnxruntime_lib_unversioned_filename(void);

で、そのfree不要の文字列を間違えてfreeしてしまわないように、確か何かしらの安全策を講じていた記憶があります。

はい。この三つが返す静的な文字列はちゃんと追跡してるはずです。

@qryxip qryxip merged commit a55b013 into VOICEVOX:main Oct 6, 2024
30 checks passed
@qryxip qryxip deleted the change-get-rid-of-getters-from-voicevox-voice-model-file branch October 6, 2024 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants