Add windows cpp sample #112

shigobu · 2022-04-01T16:07:58Z

内容

Windowsで動くC++用のサンプルコードを追加します。
Microsoft Visual Studio Community 2022 で作成しています。

core.dllを暗黙的リンクするために、core.libが必要です。
自分のリポジトリでbuild.ymlを編集してlibファイルを作成するようにして使っています。後でPR出します。

出力ディレクトリにcore.dllとOpen JTalk辞書フォルダの配置が必要です。
lib\x64(or Win32)にcore.libを配置する必要があります。
出力ディレクトリとlibディレクトリはビルドすると生成されます。

OnnxRuntimeはNuGetで取得します。

その他

shigobu · 2022-04-04T01:11:28Z

完成したので、レビューをお願いします。

Yosshi999 · 2022-04-05T13:24:22Z

いまVS2022が手元にないのでとりあえずVS2019 (v142)でビルドしてみましたが、core.dllの序数5が見つからないといわれて実行できませんでした。多分こっちのローカル環境がごちゃごちゃしてるせいなのでもうちょっと調べてみますが、@shigobuさんなにか心当たりありますか？

Yosshi999

[SHOULD] 実行までの手順をまとめたREADME(具体的にはこのPRの冒頭の内容)をexample/cpp/windows/のところに欲しいです。

[QUESTION] あとcore.libについてはどうしましょうか。releasesに含めるべき(cc. @Hiroshiba )か dllからlibを生成するバッチファイルを復活させるか...
動的なロードならlibファイルは要らないんでしたっけ？この選択肢はこういったVC++プロジェクトでもアリなんでしょうか

すみません。詳しいレビューはもう少し待ってください 🙇

Oyaki122 · 2022-04-05T15:22:37Z

[QUESTION] あとcore.libについてはどうしましょうか。releasesに含めるべき(cc. @Hiroshiba )か dllからlibを生成するバッチファイルを復活させるか... 動的なロードならlibファイルは要らないんでしたっけ？この選択肢はこういったVC++プロジェクトでもアリなんでしょうか

.libに関しては #111 でRelease対象に含まれるようになったため問題ないと思います

shigobu · 2022-04-06T00:44:23Z

いまVS2022が手元にないのでとりあえずVS2019 (v142)でビルドしてみましたが、core.dllの序数5が見つからないといわれて実行できませんでした。多分こっちのローカル環境がごちゃごちゃしてるせいなのでもうちょっと調べてみますが、@shigobuさんなにか心当たりありますか？

initialize関数の定義がRelease（0.12.0-preview.1）に上がっているものから変更になっています。
DLLにモデルファイルを埋め込んだのでパスを指定する引数が削除されています。
ActionsのArtifactsからダウンロードしたものを使用してください。
https://github.com/VOICEVOX/voicevox_core/actions/runs/2082324805

心当たりがあるといえばこのくらいです。
すでに、Actionsからダウンロードしたものを使用していたらすみません。

shigobu · 2022-04-06T12:14:32Z

README追加しました。

Yosshi999 · 2022-04-06T13:33:07Z

core.dllの序数5が見つからないといわれて実行できませんでした

この件解決しました。core.dllのビルドに使っていたonnxruntimeとsimple_ttsが読み込んでいたonnxruntimeのバージョンが一致していませんでした。

確認ですが、

出力ディレクトリに現れるonnxruntime.dllとonnxruntime_providers_shared.dllはNuGetでダウンロードしてきたMicrosoft.ML.OnnxRuntime.1.11.0 であるという認識であってますか？
今のvoicevox_coreリポジトリを見る限りcore.dllがリンクするonnxruntimeは1.10.0のはずですが、@shigobuさんの環境ではbin/x64/Debug (or Release) にあるonnxruntime.dllの出所はどうなっていますか？

shigobu · 2022-04-06T13:57:34Z

出力ディレクトリに現れるonnxruntime.dllとonnxruntime_providers_shared.dllはNuGetでダウンロードしてきたMicrosoft.ML.OnnxRuntime.1.11.0 であるという認識であってますか？

あっています。

今のvoicevox_coreリポジトリを見る限りcore.dllがリンクするonnxruntimeは1.10.0のはずですが、@shigobuさんの環境ではbin/x64/Debug (or Release) にあるonnxruntime.dllの出所はどうなっていますか？

NuGetでダウンロードしたMicrosoft.ML.OnnxRuntime.1.11.0です。
製品版からコピーしたかもと思って、ファイルバージョンを比較してみました。
製品版は1.10で、bin/x64/Debugにあるのは1.11でした。

shigobu · 2022-04-06T14:05:04Z

私の環境では正常にダミー音声が再生されたので、そのままにしてたのですが、
Microsoft.ML.OnnxRuntimeのバージョンは、1.10.0にしたほうが良さそうですね。

Yosshi999 · 2022-04-06T14:14:56Z

Microsoft.ML.OnnxRuntimeのバージョンは、1.10.0に

お願いします 🙇

将来にわたってこのexampleのバージョンを揃える必要があるので出来ればこのNuGetなしで完結するのがいいんですが、その作業は製品版にDirectMLが同梱されてからでよさそうですかね

…oicevox_core into add_windows_cpp_sample

shigobu · 2022-04-06T14:28:52Z

OnnxRuntimeのバージョンを1.10.0に変更しました。

Yosshi999 · 2022-04-06T15:18:34Z

すみません。対応してもらって申し訳ないのですが、versionを揃えてもまだ序数のエラーが出てしまいました。

いまonnxruntime.dllのexportsを確認したところ、python configure.pyで拾ってくるものとNuGetが拾ってくるものが違っているようでした。もう少し調べてみます。

dumpbin /exports の結果

Dump of file example\cpp\windows\packages\Microsoft.ML.OnnxRuntime.1.10.0\runtimes\win-x64\native\onnxruntime.dll

File Type: DLL

  Section contains the following exports for onnxruntime.dll

    00000000 characteristics
    FFFFFFFF time date stamp
        0.00 version
           1 ordinal base
           2 number of functions
           2 number of names

    ordinal hint RVA      name

          1    0 00018740 OrtGetApiBase = OrtGetApiBase
          2    1 00101630 OrtSessionOptionsAppendExecutionProvider_CPU = OrtSessionOptionsAppendExecutionProvider_CPU

  Summary

       11000 .data
       31000 .pdata
       F8000 .rdata
        7000 .reloc
        1000 .rsrc
      5CB000 .text
        1000 _RDATA

-----------------------------------------------------------------------------
Dump of file onnxruntime\runtimes\win-x64\native\onnxruntime.dll

File Type: DLL

  Section contains the following exports for onnxruntime.dll

    00000000 characteristics
    FFFFFFFF time date stamp
        0.00 version
           1 ordinal base
           5 number of functions
           5 number of names

    ordinal hint RVA      name

          1    0 00018BC0 OrtGetApiBase = OrtGetApiBase
          2    1 00133560 OrtGetWinMLAdapter = ?OrtGetWinMLAdapter@@YAPEBUWinmlAdapterApi@@I@Z (struct WinmlAdapterApi const * __cdecl OrtGetWinMLAdapter(unsigned int))
          3    2 0007A8A0 OrtSessionOptionsAppendExecutionProviderEx_DML = OrtSessionOptionsAppendExecutionProviderEx_DML
          4    3 001CE670 OrtSessionOptionsAppendExecutionProvider_CPU = OrtSessionOptionsAppendExecutionProvider_CPU
          5    4 0007A810 OrtSessionOptionsAppendExecutionProvider_DML = OrtSessionOptionsAppendExecutionProvider_DML

  Summary

       49000 .data
        1000 .didat
       39000 .pdata
      17C000 .rdata
        C000 .reloc
        1000 .rsrc
      6A3000 .text
        1000 _RDATA

</details>

Yosshi999 · 2022-04-06T22:26:28Z

すみませんずっと勘違いしていてDirectML版のcore.dllを使っていました。
cpu版のcore.dllにしたところちゃんと動作することを確認しました

Yosshi999

日本語パスでも動作を確認しました！
いくつかコメント残したので対応お願いします。

Yosshi999 · 2022-04-07T09:17:36Z

example/cpp/windows/simple_tts/simple_tts.cpp

+  int64_t speaker_id = 0;
+  int output_binary_size = 0;
+  uint8_t* output_wav = nullptr;
+  result = voicevox_tts(wide_to_utf8_cppapi(speak_words).c_str(), speaker_id, &output_binary_size, &output_wav);


[SHOULD] 現在のcore.dll実装には voicevox_tts に長すぎる文字列を与えるとbuffer overflowでクラッシュするというバグが存在するので、入力する文字列のbyte数に制限を与えてほしいです。
VOICEVOX/voicevox_engine#384 ここの議論にあるように2560文字くらいにするのがよさそうです。

[MAY] voicevox_tts は std::runtime 例外が飛びうる(あと多分bad_allocも)のでcatchしてほしいです。

これ思ったんですがどっちもcore実装の方を直すべきですかね...

これ思ったんですがどっちもcore実装の方を直すべきですかね...

そうだと思います！ #93 の時点で自分も #93 (comment) のように質問したことがあったのですが、例外処理を core 内で完結させる作業は別 PR に分けたほうが良さそうという意見に落ち着き、それ以来これについて特に進捗はない、というステートにある感じな気がします。なのでサンプル側で catch する必要はなくて、今後 core 側での作業が必要そうです。

とりあえず、現状維持しときます。

example/cpp/windows/simple_tts/simple_tts.cpp

example/cpp/windows/README.md

Yosshi999

LGTM!

Hiroshiba

あ、もし余力があれば、サンプルコードがビルドできるかのテストCIをGithub Actionsで回しておくと良いかもとちょっと思いました！
たぶんcd example/cpp/windows/simple_ttsしてmsbuildをいい感じに実行すればOKかなと･･･！

Oyaki122

実装いただきありがとうございます
遅れましたが確認させていただきました

こちらの方で再生に関して問題がありましたが、それ以外に関しては問題ないと思います

再生の件についてはよくわかりませんでした…
とりあえず一旦Request changesにしますが、他の方で同様の事例がなさそうであればApproveします

example/cpp/windows/simple_tts/simple_tts.cpp

ワークフロー名変更

# Conflicts: # .github/workflows/build.yml

shigobu · 2022-04-11T04:15:28Z

あ、もし余力があれば、サンプルコードがビルドできるかのテストCIをGithub Actionsで回しておくと良いかもとちょっと思いました！たぶんcd example/cpp/windows/simple_ttsしてmsbuildをいい感じに実行すればOKかなと･･･！

build.ymlにjobを追加する形で良いでしょうか？
ビルドする時にcore.libが必要なので、どこからか持ってくる必要があります。build.ymlの中でcore.dllのビルド後に実行するのが簡単だと思いました。

私のリポジトリでブランチ分けて試しに作ってみたところ、ビルドに成功しました。

Hiroshiba · 2022-04-11T22:35:51Z

build.ymlにjobを追加する形で良いでしょうか？

良いと思います！！
releaseにuploadする前にエラーになるとリリース作業に支障が出てしまうので、そのあとに実行される形だと利便性が損なわれず嬉しそうです！

shigobu · 2022-04-12T02:41:43Z

build.ymlに、サンプルコードをビルドするjobを追加しました。
needs: [build-cpp-shared]を指定しているので、リリースにアップロードするjobと並列で動くはずです。

Oyaki122

LGTM!

shigobu and others added 4 commits April 1, 2022 14:55

ソシューション追加

d8d3b0a

voicevox_load_openjtalk_dictまで作成

57ad5ad

整形

e79a80e

音声生成と再生の実装

b87a616

shigobu mentioned this pull request Apr 2, 2022

libファイルをArtifactsのzipに含める #113

Merged

shigobu marked this pull request as ready for review April 2, 2022 03:32

shigobu added 2 commits April 2, 2022 12:40

初期化コメントをコンソール画面出力へ変更

6401dd0

メモリ解放を忘れていたので追加

c798380

Yosshi999 self-requested a review April 5, 2022 12:33

Yosshi999 requested changes Apr 5, 2022

View reviewed changes

Windows C++README.mdを追加

9f8c60e

shigobu added 2 commits April 6, 2022 23:23

OnnxRuntimeのバージョンを1.10.0に変更

0e4c86f

Merge branch 'add_windows_cpp_sample' of https://github.com/shigobu/v…

fee5dc1

…oicevox_core into add_windows_cpp_sample

Yosshi999 requested changes Apr 7, 2022

View reviewed changes

example/cpp/windows/README.md Outdated Show resolved Hide resolved

マージされたのでREADME.mdの更新

7bd1df2

Yosshi999 approved these changes Apr 7, 2022

View reviewed changes

Hiroshiba reviewed Apr 8, 2022

View reviewed changes

Oyaki122 requested changes Apr 8, 2022

View reviewed changes

example/cpp/windows/simple_tts/simple_tts.cpp Show resolved Hide resolved

kasamatsu added 10 commits April 11, 2022 10:11

サンプルをビルドするワークフロー追加

da2b1d3

手動実行できるように変更

4474f7f

ファイル名変更

f7af5b7

ワークフロー名変更

build.ymlへ書いてみた

69a3c3d

Copyのパス修正

f8c5999

ダウンロードしたファイルのパスを確認するコードを入力

955019f

Copy元を変数を使用するように変更

9b72394

Merge branch 'main' into msbuild_test

dde5b89

# Conflicts: # .github/workflows/build.yml

mkdir追加

4018d68

個別ビルドymlを削除

a60af11

音声データをファイルに出力する処理の追加

576cabb

kasamatsu added 3 commits April 12, 2022 10:26

リリース作成後にサンプルビルドするように変更

fc45791

やっぱり、リリース作成と並列で動作するように戻す

c1669db

Merge branch 'msbuild_test' into add_windows_cpp_sample

1676c6b

Oyaki122 approved these changes Apr 12, 2022

View reviewed changes

Oyaki122 merged commit 67de47c into VOICEVOX:main Apr 14, 2022

Yosshi999 mentioned this pull request Apr 21, 2022

use safer text2mecab #119

Closed

PickledChair mentioned this pull request Apr 26, 2022

Linux・Mac向けのサンプルコードを追加 #120

Merged

y-chan pushed a commit to SHAREVOX/sharevox_core that referenced this pull request Sep 1, 2022

Add windows cpp sample (VOICEVOX#112)

25b6e6f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add windows cpp sample #112

Add windows cpp sample #112

shigobu commented Apr 1, 2022 •

edited

Loading

shigobu commented Apr 4, 2022

Yosshi999 commented Apr 5, 2022

Yosshi999 left a comment

Oyaki122 commented Apr 5, 2022

shigobu commented Apr 6, 2022

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

shigobu commented Apr 6, 2022

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022 •

edited

Loading

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

Yosshi999 left a comment

Yosshi999 Apr 7, 2022

Yosshi999 Apr 7, 2022

PickledChair Apr 7, 2022

shigobu Apr 7, 2022

Yosshi999 left a comment

Hiroshiba left a comment

Oyaki122 left a comment

shigobu commented Apr 11, 2022

Hiroshiba commented Apr 11, 2022

shigobu commented Apr 12, 2022

Oyaki122 left a comment

Add windows cpp sample #112

Add windows cpp sample #112

Conversation

shigobu commented Apr 1, 2022 • edited Loading

内容

関連 Issue

その他

shigobu commented Apr 4, 2022

Yosshi999 commented Apr 5, 2022

Yosshi999 left a comment

Choose a reason for hiding this comment

Oyaki122 commented Apr 5, 2022

shigobu commented Apr 6, 2022

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

shigobu commented Apr 6, 2022

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022 • edited Loading

shigobu commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

Yosshi999 commented Apr 6, 2022

Yosshi999 left a comment

Choose a reason for hiding this comment

Yosshi999 Apr 7, 2022

Choose a reason for hiding this comment

Yosshi999 Apr 7, 2022

Choose a reason for hiding this comment

PickledChair Apr 7, 2022

Choose a reason for hiding this comment

shigobu Apr 7, 2022

Choose a reason for hiding this comment

Yosshi999 left a comment

Choose a reason for hiding this comment

Hiroshiba left a comment

Choose a reason for hiding this comment

Oyaki122 left a comment

Choose a reason for hiding this comment

shigobu commented Apr 11, 2022

Hiroshiba commented Apr 11, 2022

shigobu commented Apr 12, 2022

Oyaki122 left a comment

Choose a reason for hiding this comment

shigobu commented Apr 1, 2022 •

edited

Loading

Yosshi999 commented Apr 6, 2022 •

edited

Loading