diff --git a/README.md b/README.md index 5dc964d8..31b853da 100644 --- a/README.md +++ b/README.md @@ -1,127 +1,137 @@ -VC Helper ----- -# VC Helperとは -[VC Helper](https://github.com/w-okada/voice-changer)は[MMVC](https://github.com/isletennos/MMVC_Trainer), [so-vits-svc](https://github.com/svc-develop-team/so-vits-svc)などのAIを使ったリアルタイムボイスチェンジャーのヘルパーアプリケーションです。リアルタイムボイスチェンジャーで必要となるトレーニング用の音声の録音(MMVC向け)とボイスチェンジャを各種プラットフォームでお手軽に実行できます。 +## VC Helper + +# VC Helper とは + +[VC Helper](https://github.com/w-okada/voice-changer)は[MMVC](https://github.com/isletennos/MMVC_Trainer), [so-vits-svc](https://github.com/svc-develop-team/so-vits-svc)などの AI を使ったリアルタイムボイスチェンジャーのクライアントソフトウェアです。また、リアルタイムボイスチェンジャーで必要となるトレーニング用の音声の録音(MMVC 向け)アプリも提供しています。 [解説動画](https://www.nicovideo.jp/watch/sm41507891) -※ MMVCのトレーニングについては[公式ノートブック](https://github.com/isletennos/MMVC_Trainer)をご利用ください。 -※ so-vits-svcのトレーニングについては[公式](https://github.com/svc-develop-team/so-vits-svc)を参考に実施してください。 - -![image](https://user-images.githubusercontent.com/48346627/201169523-836e0f9e-2aca-4023-887c-52ecc219bcca.png) - +- MMVC のトレーニングについては[公式ノートブック](https://github.com/isletennos/MMVC_Trainer)をご利用ください。 +- so-vits-svc のトレーニングについては[公式ノートブック](https://github.com/isletennos/MMVC_Trainer)をご利用ください。 # 特徴 + 1. 複数のプラットフォームで動作 -Windows, Mac(M1等Apple silicon), Linux, Google Colaboratoryでの動作をサポートしています。 + Windows, Mac(M1 等 Apple silicon), Linux, Google Colaboratory での動作をサポートしています。 2. 音声録音用アプリのインストールが不要 -音声録音をGithub Pagesにホストしてあるアプリケーション上で実行可能です。全てブラウザ上で動くため、特別なアプリケーションのインストールは不要です。また、完全にブラウザアプリケーションとして動くのでデータがサーバに送信されることもありません。 + 音声録音を Github Pages にホストしてあるアプリケーション上で実行可能です。全てブラウザ上で動くため、特別なアプリケーションのインストールは不要です。また、完全にブラウザアプリケーションとして動くのでデータがサーバに送信されることもありません。 -3. ボイチェンを別のPC上で実行して負荷を分散 -本アプリケーションのリアルタイムボイスチェンジャーは、サーバ・クライアント構成で動きます。MMVCのサーバを別のPC上で動かすことで、ゲーム実況など他の負荷の高い処理への影響を抑えながら動かすことができます。 +3. ボイチェンを別の PC 上で実行して負荷を分散 + 本アプリケーションのリアルタイムボイスチェンジャーは、サーバ・クライアント構成で動きます。MMVC のサーバを別の PC 上で動かすことで、ゲーム実況など他の負荷の高い処理への影響を抑えながら動かすことができます。 ![image](https://user-images.githubusercontent.com/48346627/206640768-53f6052d-0a96-403b-a06c-6714a0b7471d.png) # 使用方法 -詳細は[こちら(v.1.3.x)](https://zenn.dev/wok/books/0002_vc-helper-v_1_3)に纏まっています。 -(v1.5.xは[こちら](https://zenn.dev/wok/books/0003_vc-helper-v_1_5)) + +詳細は[こちら](https://zenn.dev/wok/books/0004_vc-helper-v_1_5_1_x)に纏まっています。 # (1) レコーダー（トレーニング用音声録音アプリ） -MMVCトレーニング用の音声を簡単に録音できるアプリです。 -Github Pages上で実行できるため、ブラウザのみあれば様々なプラットフォームからご利用可能です。 + +MMVC トレーニング用の音声を簡単に録音できるアプリです。 +Github Pages 上で実行できるため、ブラウザのみあれば様々なプラットフォームからご利用可能です。 録音したデータは、ブラウザ上に保存されます。外部に漏れることはありません。 [録音アプリ on Github Pages](https://w-okada.github.io/voice-changer/) [解説動画](https://youtu.be/s_GirFEGvaA) - # (2) プレイヤー（ボイスチェンジャーアプリ） -MMVCやso-vits-svcでボイチェンを行うためのアプリです。 -大きく3つの方法でご利用できます。難易度順に次の通りです。 -- Google Colaboratoryでの利用(MMVCのみ) -- 事前ビルド済みのBinaryでの利用 -- DockerやAnacondaなど環境構築を行った上での利用 +MMVC や so-vits-svc でボイチェンを行うためのアプリです。 -本ソフトウェアやMMVCになじみの薄い方は上から徐々に慣れていくとよいと思います。 +大きく 3 つの方法でご利用できます。難易度順に次の通りです。 -## (2-1) Google Colaboratoryでの利用(MMVCのみ) -Googleが提供している機械学習プラットフォームColaboratory上で実行できます。 -MMVCのモデルをトレーニングが完了している場合、既にColaboratoryを利用していると思いますので、事前準備は必要ありません。ただし、ネットワーク環境やColaboratoryの状況によってボイスチェンジャのタイムラグが大きくなる傾向があります。 +- Google Colaboratory での利用(MMVC のみ) +- 事前ビルド済みの Binary での利用 +- Docker や Anaconda など環境構築を行った上での利用 -- [超簡単バージョン](https://github.com/w-okada/voice-changer/blob/master/VoiceChangerDemo_Simple.ipynb): 事前設定なしでColabから実行できます。 -- [普通バージョン](https://github.com/w-okada/voice-changer/blob/master/VoiceChangerDemo.ipynb): Google Driveと連携してモデルを読み込むことができます。 +本ソフトウェアや MMVC になじみの薄い方は上から徐々に慣れていくとよいと思います。 + +## (2-1) Google Colaboratory での利用(MMVC のみ) + +Google が提供している機械学習プラットフォーム Colaboratory 上で実行できます。 +MMVC のモデルをトレーニングが完了している場合、既に Colaboratory を利用していると思いますので、事前準備は必要ありません。ただし、ネットワーク環境や Colaboratory の状況によってボイスチェンジャのタイムラグが大きくなる傾向があります。 + +- [超簡単バージョン](https://github.com/w-okada/voice-changer/blob/master/VoiceChangerDemo_Simple.ipynb): 事前設定なしで Colab から実行できます。 +- [普通バージョン](https://github.com/w-okada/voice-changer/blob/master/VoiceChangerDemo.ipynb): Google Drive と連携してモデルを読み込むことができます。 [解説動画](https://youtu.be/TogfMzXH1T0) -## (2-2) 事前ビルド済みのBinaryでの利用 +## (2-2) 事前ビルド済みの Binary での利用 + 実行形式のバイナリをダウンロードして実行することができます。 -Windows版とMac版を提供しています。 +Windows 版と Mac 版を提供しています。 -・Mac版はダウンロードファイルを解凍したのちに、使用するVCに応じた`startHttp_xxx.command`をダブルクリックしてください。開発元を検証できない旨が示される場合は、再度コントロールキーを押してクリックして実行してください(or 右クリックから実行してください)。（詳細下記 *1） +・Mac 版はダウンロードファイルを解凍したのちに、使用する VC に応じた`startHttp_xxx.command`をダブルクリックしてください。開発元を検証できない旨が示される場合は、再度コントロールキーを押してクリックして実行してください(or 右クリックから実行してください)。（詳細下記 \*1） -・Windows版は、ONNX版とONNX+PyTorch版を提供しています。環境に応じたzipファイルをダウンロードしてください。ダウンロードしたzipファイルを解凍して、使用するVCに応じたVCに応じた`start_http_xxx.bat`を実行してください。 +・Windows 版は、ONNX 版と ONNX+PyTorch 版を提供しています。環境に応じた zip ファイルをダウンロードしてください。ダウンロードした zip ファイルを解凍して、使用する VC に応じた VC に応じた`start_http_xxx.bat`を実行してください。 -・NvidiaのGPUをお持ちの方は多くの場合はONNX版で動きます。環境によって極まれにgpuが認識されない場合があります。その場合はONNX+PyTorch(cuda)版の方をご利用ください。（サイズが大きく違います。） +・各種`startHttp_xxx.command`ファイル(mac)、`start_http_xxx.bat`ファイル(win)で起動できるボイスチェンジャは次の通りです。 -・NvidiaのGPUをお持ちでない方は多くの場合はONNX(DirectML)版で動きます。 +| # | バッチファイル | 説明 | +| --- | ----------------------------------------- | ---------------------------------------------- | +| 1 | start_http_v13.bat | MMVC v.1.3.x 系のモデルが使用できます。 | +| 2 | start_http_v15.bat | MMVC v.1.5.x 系のモデルが使用できます。 | +| 3 | start_http_so-vits-svc_40.bat | so-vits-svc 4.0 系のモデルが使用できます。 | +| 4 | start_http_so-vits-svc_40v2.bat | so-vits-svc 4.0v2 系のモデルが使用できます。 | +| 5 | start_http_so-vits-svc_40v2_tsukuyomi.bat | つくよみちゃんのモデルを使用します。(変更不可) | -・リモートからアクセスできるようにする方法など、より詳しくは[こちら](https://zenn.dev/wok/books/0002_vc-helper-v_1_3)をご覧ください。 +・リモートから接続する場合は、各種`.command`ファイル(mac)、`.bat`ファイル(win)の http が https に置き換わっているものを使用してください。 -・so-vits-svcは[4.0-v2](https://github.com/svc-develop-team/so-vits-svc/tree/4.0-v2)に対応しています。 +・Nvidia の GPU をお持ちの方は多くの場合は ONNX 版で動きます。環境によって極まれに gpu が認識されない場合があります。その場合は ONNX+PyTorch(cuda)版の方をご利用ください。（サイズが大きく違います。） -・so-vits-svcやつくよみちゃんの動作にはcontent vecのモデルが必要となります。こちらの[リポジトリ](https://github.com/auspicious3000/contentvec)から、ContentVec_legacy 500のモデルをダウンロードして、実行する`startHttp_xxx.command`や`start_http_xxx.bat`と同じフォルダに配置してください。 +・Nvidia の GPU をお持ちでない方は多くの場合は ONNX(DirectML)版で動きます。 +・so-vits-svc やつくよみちゃんの動作には content vec のモデルが必要となります。こちらの[リポジトリ](https://github.com/auspicious3000/contentvec)から、ContentVec_legacy 500 のモデルをダウンロードして、実行する`startHttp_xxx.command`や`start_http_xxx.bat`と同じフォルダに配置してください。 -| Version | OS | フレームワーク | link | サポートVC | サイズ | -| ------------------ | ------- | ---------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------- | ------ | -| v.1.5.1.6(current) | mac(M1) | ONNX | [通常](https://drive.google.com/file/d/1espnNjLnSr4BYWL6ilb34bkvcVAbByTu/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x, so-vits-svc 4.0v2 | 571MB | -| | | | [つくよみちゃん](https://drive.google.com/file/d/1iXDowAEKudvIsyeDDrqxEEawm3IJr-Cb/view?usp=sharing) | so-vits-svc 4.0v2 | 949MB | -| | windows | ONNX | [通常](https://drive.google.com/file/d/1rHUCo-URl13TdE3v8Vb_DD4jUG_yGTuu/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 564MB | -| | | | [つくよみちゃん](https://drive.google.com/file/d/1Mjf7c558l5o8i_Y_LLmz07ozu6dSTsro/view?usp=sharing) | so-vits-svc 4.0v2 | 694MB | -| | | ONNX+PyTorch(cuda) | [通常](https://drive.google.com/file/d/1K2jkUHEDkLzbYligyVJcuVnOX1KQAQiR/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x, so-vits-svc 4.0v2 | 2.6GB | -| | | | [つくよみちゃん](https://drive.google.com/file/d/1hPxPFGNVfrK5E-K18xrSH9gPJRYztG9d/view?usp=sharing) | so-vits-svc 4.0v2 | 2.97GB | -| | | ONNX(DirectML) | [通常](https://drive.google.com/file/d/1mjhmB2plYGuw6G4qTT3IoWFDU5e8yOTR/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 452MB | -| | | ONNX(DirectML)+PyTorch(cuda) | [通常](https://drive.google.com/file/d/1KlNRQaD-hnPTo1e6sZi-9jDOq1TNI4E6/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 2.47GB | +| Version | OS | フレームワーク | link | サポート VC | サイズ | +| --------- | ------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------- | ------ | +| v.1.5.1.7 | mac(M1) | ONNX(cpu) | [通常]() | MMVC v.1.5.x, MMVC v.1.3.x, so-vits-svc 4.0v2 | 571MB | +| | | | [つくよみちゃん]() | so-vits-svc 4.0v2 | 949MB | +| | windows | ONNX(cpu,cuda),PyTorch(cpu) | [通常](https://drive.google.com/file/d/191vw7_9wF2sba4SofOaNov3f9QmMkjIb/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 597MB | +| | | | [つくよみちゃん](https://drive.google.com/file/d/19kNfGk9j3z15IuEZZn9_lmxyDd1_UjoI/view?usp=sharing) | so-vits-svc 4.0v2 | 703MB | +| | | ONNX(cpu,cuda), PyTorch(cpu,cuda) | [通常](https://drive.google.com/file/d/1_fK-U5odfk9MukMmjwWCsnBNicQcshJv/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x, so-vits-svc 4.0v2 | 2.6GB | +| | | ONNX(cpu,DirectML), PyTorch(cpu) | [通常](https://drive.google.com/file/d/1iHEC-p6mVLgDCMnWaFg3-dZfuO8njRci/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 462MB | +| | | ONNX(cpu,DirectML), PyTorch(cpu,cuda) | [通常](https://drive.google.com/file/d/1a9ChdXb7e-LVIuiDDMyVU0oKDhxhZhIT/view?usp=sharing) | MMVC v.1.5.x, MMVC v.1.3.x | 2.48GB | -※ MMVC v.1.5.xはExperimentalです。 +※ MMVC v.1.5.x は Experimental です。 ※ つくよみちゃんはフリー素材キャラクター「つくよみちゃん」が無料公開している音声データを使用しています。（利用規約など、詳細は文末） ### 過去バージョン + ページの一番下にまとめてあります。 https://user-images.githubusercontent.com/48346627/212569645-e30b7f4e-079d-4504-8cf8-7816c5f40b00.mp4 - -*1 本ソフトウェアは開発元の署名しておりません。下記のように警告が出ますが、コントロールキーを押しながらアイコンをクリックすると実行できるようになります。これはAppleのセキュリティポリシーによるものです。実行は自己責任となります。 +\*1 本ソフトウェアは開発元の署名しておりません。下記のように警告が出ますが、コントロールキーを押しながらアイコンをクリックすると実行できるようになります。これは Apple のセキュリティポリシーによるものです。実行は自己責任となります。 ![image](https://user-images.githubusercontent.com/48346627/212567711-c4a8d599-e24c-4fa3-8145-a5df7211f023.png) +## (2-3) Docker や Anaconda など環境構築を行った上での利用 -## (2-3) DockerやAnacondaなど環境構築を行った上での利用 -本リポジトリをクローンして利用します。WindowsではWSL2の環境構築が必須になります。また、WSL2上でDockerもしくはAnacondaなどの仮想環境の構築が必要となります。MacではAnacondaなどのPythonの仮想環境の構築が必要となります。事前準備が必要となりますが、多くの環境においてこの方法が一番高速で動きます。** GPUが無くてもそこそこ新しいCPUであれば十分動く可能性があります （下記のリアルタイム性の節を参照）**。 +本リポジトリをクローンして利用します。Windows では WSL2 の環境構築が必須になります。また、WSL2 上で Docker もしくは Anaconda などの仮想環境の構築が必要となります。Mac では Anaconda などの Python の仮想環境の構築が必要となります。事前準備が必要となりますが、多くの環境においてこの方法が一番高速で動きます。** GPU が無くてもそこそこ新しい CPU であれば十分動く可能性があります （下記のリアルタイム性の節を参照）**。 -[WSL2とDockerのインストールの解説動画](https://youtu.be/POo_Cg0eFMU) +[WSL2 と Docker のインストールの解説動画](https://youtu.be/POo_Cg0eFMU) -[WSL2とAnacondaのインストールの解説動画](https://youtu.be/fba9Zhsukqw) +[WSL2 と Anaconda のインストールの解説動画](https://youtu.be/fba9Zhsukqw) ## リアルタイム性 -GPUを使用するとほとんどタイムラグなく変換可能です。 +GPU を使用するとほとんどタイムラグなく変換可能です。 https://twitter.com/DannadoriYellow/status/1613483372579545088?s=20&t=7CLD79h1F3dfKiTb7M8RUQ -CPUでも最近のであればそれなりの速度で変換可能。 +CPU でも最近のであればそれなりの速度で変換可能。 https://twitter.com/DannadoriYellow/status/1613553862773997569?s=20&t=7CLD79h1F3dfKiTb7M8RUQ -古いCPU( i7-4770)だと、1000msecくらいかかってしまう。 +古い CPU( i7-4770)だと、1000msec くらいかかってしまう。 ### 過去バージョン -| Version | OS | フレームワーク | link | サポートVC | サイズ | + +| Version | OS | フレームワーク | link | サポート VC | サイズ | | ---------- | ------- | ----------------------- | ------------------------------------------------------------------------------------------ | ------------ | ------ | | v.1.5.1.4a | mac(M1) | onnx(cpu) | [通常](https://drive.google.com/file/d/1urqcB_S4lqbrxL4osKIlQ6MLhsh__W7t/view?usp=sharing) | MMVC v.1.5.x | 510MB | | | windows | onnx(cpu) | [通常](https://drive.google.com/file/d/1cQVnwenJD0vXzyThZ3iiMBUVLRXoDPBJ/view?usp=sharing) | MMVC v.1.5.x | 541MB | @@ -135,8 +145,8 @@ https://twitter.com/DannadoriYellow/status/1613553862773997569?s=20&t=7CLD79h1F3 | | | onnx(cpu+DirectML) | [通常](https://drive.google.com/file/d/14DaEPJnio-Ne50e2t1wFRgwQYnWwkh6n/view?usp=sharing) | MMVC v.1.3.x | 430MB | | | | onnx(cpu+DirectML+cuda) | [通常](https://drive.google.com/file/d/1vfZc52f0BVD8nGjsuaAhl0jb4djHBBYe/view?usp=sharing) | MMVC v.1.3.x | 2.45GB | - # Acknowledgments + - 立ちずんだもん素材：https://seiga.nicovideo.jp/seiga/im10792934 - いらすとや：https://www.irasutoya.com/ - つくよみちゃん @@ -147,7 +157,9 @@ https://twitter.com/DannadoriYellow/status/1613553862773997569?s=20&t=7CLD79h1F3 https://tyc.rei-yumesaki.net/material/corpus/ © Rei Yumesaki ``` + # 利用規約 + ``` リアルタイムボイスチェンジャーつくよみちゃんについては、つくよみちゃんコーパスの利用規約に準じ、次の目的での利用を禁止します。 @@ -160,6 +172,7 @@ https://twitter.com/DannadoriYellow/status/1613553862773997569?s=20&t=7CLD79h1F3 ■他者に対して二次利用（素材としての利用）を許可する形で公開すること。 ※鑑賞用の作品として配布・販売していただくことは問題ございません。 ``` -# 免責事項 -本ソフトウェアの使用または使用不能により生じたいかなる直接損害・間接損害・波及的損害・結果的損害 または特別損害についても、一切責任を負いません。 +# 免責事項 + +本ソフトウェアの使用または使用不能により生じたいかなる直接損害・間接損害・波及的損害・結果的損害 または特別損害についても、一切責任を負いません。