C#でVoicevoxのAPIを操作する方法

C#でVoicevoxのAPIを操作

C#でVoicevoxのAPIを操作

半年ほど前に話題になったVOICEVOXについて、気になったのでインストールして遊んでみた。
普通に使用する場合は、こちらのリンクに記載のダウンロード方法や使い方を参考にGUIで操作が可能です。
GUI操作の場合は、そこまで使い方に悩むことなく合成音声を作成して遊ぶことが可能です。

ただしかし、GUI操作だと他プログラムから操作することができないので、今回はVOICEVOXを立ち上げると使用できるAPIを活用する方法を紹介します。
なお、今回は私が使い慣れているC#で構築してみます。


下準備

先程APIを利用すると言いましたが、VOICEVOXはexeを起動するとデフォルトでLoaclhostの50021ポートでサーバを立てます。
この状態であれば、localhost:50021宛に通信を行うとレスポンスを得ることができるのです。
ちなみに起動オプションでIPアドレスを指定してあげれば、そのIPアドレスでサーバ起動することができます。

VOICEVOXをダウンロードしたら、下記コマンドをコンソールで実行します。
※通常は「C:\Users\ユーザー名\AppData\Local\Programs\VOICEVOX」にダウンロードされているはず。 

 C:\Users\ユーザー名\AppData\Local\Programs\VOICEVOX\run.exe --host 192.168.0.5
「--host」以降はIPを指定しない場合は不要です。

起動ができたら、ブラウザを立ち上げ下記リンクでアクセスしてみてください。 

  http://192.168.0.5:50021/docs
するとAPI情報を確認することができるページが開くはずです。必要となるAPIはこの画面で調べます。
※なおアプリ起動の際に「--host」以降を指定していない場合は「htpp://localhost:50021/docs」になります。以降必要に応じて「192.168.0.5」と「localhost」を読み替えてください。


APIを呼び出すコードを作成

準備ができたので、いよいよC#でコードを記載していきます。この記事の最後にサンプルを載せているGitのリンクを貼っているので参考にしてみてください。
先程のAPI一覧の画面で最低限必要になるAPIを確認すると「audio_query」と「synthesis」であることがわかります。
それぞれのAPI詳細に必要になるパラメータとリクエストの記載が確認できるので、1つ1つ作成をしていきます。

  • audio_queryの作成

    • 必要になるパラメータは「読み上げるテキスト」と「話者番号」です。
    話者番号は一覧などが確認できていないので、どの値でどのキャラクターなのかは1回ずつ確認するしかない気がします。
    ちなみに「1」はずんだもんです。笑

    仮に「こんにちは」を「ずんだもん」に読み上げさせるためのクエリ作成は、下記リクエストになります。

     curl -X 'POST' \
 'http://192.168.0.5:50021/audio_query?text=%E3%81%93%E3%82%93%E3%81%AB%E3%81%A1%E3%81%AF&speaker=1' \
 -H 'accept: application/json' \
 -d ''
    これをC#用に変換します。すると 
     using (var httpClient = new HttpClient())
 {
    using (var request = new HttpRequestMessage(new HttpMethod("POST"), "http://192.168.0.5:50021/audio_query?text=こんにちは&speaker=1"))
    {
        request.Headers.TryAddWithoutValidation("accept", "application/json"); 

        request.Content = new StringContent("");
        request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/x-www-form-urlencoded"); 

        var response = await httpClient.SendAsync(request);
    }
 }
    になります。

  • synthesisの作成

    • 続いて先程のクエリ作成リクエスト出えたJSONをもとに作成リクエストを作成します。
    必要になるパラメータは「話者番号」と「疑問形の語尾調整」です。
    個人的にまた話者番号を指定するのか。。と思いましたが、再度パラメータに組み込みます。

    再度ずんだもんで読み上げさせる場合のリクエストは下記になります。
    ※-dの"JsonData"には先程audio_queryで入手したデータを投入します 

     curl -X 'POST' \
 'http://192.168.0.5:50021/synthesis?speaker=1&enable_interrogative_upspeak=true' \
 -H 'accept: audio/wav' \
 -H 'Content-Type: application/json' \
 -d '"JSOLData"'
    これをC#用に変換します。 
    　using (var httpClient = new HttpClient())
　{
    using (var request = new HttpRequestMessage(new HttpMethod("POST"), "http://192.168.0.5:50021/synthesis?speaker=1&enable_interrogative_upspeak=true"))
    {
        request.Headers.TryAddWithoutValidation("accept", "audio/wav"); 

        request.Content = new StringContent("\"JSOLData\"");
        request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json"); 

        var response = await httpClient.SendAsync(request);
    }
　}
    です。なお、「response.StatusCode」で条件分岐しているところは、Voicevoxで作成した音声データをファイル化する処理を組み込んでいます。

以上でVoicevoxのAPIを呼び出すコードの作成は完了です。
さいごにこれをそれっぽくクラス化しておきます。 
　public class VoicevoxFunction
　{
    private readonly string ipPort;

    public VoicevoxFunction(string _ipAdress, string _port)
    {
        ipPort = "http://" + _ipAdress + ":" + _port;
    }

    private async Task MakeQuery(string _text, int _speakerId)
    {
        string jsonQuery;
        using (var httpClient = new HttpClient())
        {
            string url = ipPort + "/audio_query?text=" + _text + "&speaker=" + _speakerId;
            using (var request = new HttpRequestMessage(new HttpMethod("POST"), url))
            {
                request.Headers.TryAddWithoutValidation("accept", "application/json");

                request.Content = new StringContent("");
                request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/x-www-form-urlencoded");

                var response = await httpClient.SendAsync(request);
                jsonQuery = await response.Content.ReadAsStringAsync();
            }
        }
        return jsonQuery;
    }

    public async Task MakeSound(string _title, string _text, bool _upspeak, int _speakerId)
    {
        using (var httpClient = new HttpClient())
        {
            string url = ipPort + "/synthesis?speaker=" + _speakerId + "&enable_interrogative_upspeak=" + _upspeak;
            using (var request = new HttpRequestMessage(new HttpMethod("POST"), url))
            {
                request.Headers.TryAddWithoutValidation("accept", "audio/wav");

                request.Content = new StringContent(await MakeQuery(_text, _speakerId));

                request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json");

                var response = await httpClient.SendAsync(request);

                if (response.StatusCode == HttpStatusCode.OK)
                {
                    string fileName = _title + ".wav";
                    using (var fileStream = File.Create(fileName))
                    {
                        using (var httpStream = await response.Content.ReadAsStreamAsync())
                        {
                            httpStream.CopyTo(fileStream);
                            fileStream.Flush();
                        }
                    }
                }
                else
                {
                    Console.WriteLine("Error");
                }
            }
        }
    }
 }
VoicevoxFunctionのインスタンス化時にアクセス先のIPアドレスとポート番号を指定します。
これでいちいちメソッド呼び出しの際にIP情報を記載する必要性がなくなります。

稼働確認

先程作成したコードを呼び出す処理をメインメソッドに記載して稼働確認を行います。
稼働確認なので簡単な記載で済ませます。 

 VoicevoxFunction voicevoxFunction = new("192.168.0.5", "50021");
 await voicevoxFunction.MakeSound("sample", "こんにちは世界", true, 1);
これを実行すると、所定のフォルダにWAVファイルが作成されていることがわかります。
あとはこれを再生して合成音声が作成できているかの確認を行って完了です。

現状「MakeSoundメソッド」を呼び出すだけなので、引数をいじってあげれば読み上げテキストや話者を変更することが可能です。

さいごに

今回はVoicevoxのAPIを使う方法。特にC#で呼び出す方法をまとめました。
作成したコードの全量はGitに公開しているので合わせて参考にしてみてください。そのままVisualStudioにクローンすれば最低限の動きはするはずです。
必要に応じてIPなどの情報を更新してください。
・https://github.com/flying-YT/Voicevox4net

今回はこのへんで。ではまた。

小話

スペック面の話。。
私はVoicevox用のサーバをHyper-v上のWindowsに立てています。そのためVoicevoxはGPUなし版を使っています。そのためか読み上げ処理作成時にCPU使用率が70%を超えます。
また動的メモリで特段上限を設定していないので、このサーバだけで20GB以上確保しています。。しかも処理が終了しても開放してくれないので、日次再起動を入れています。

コメント

コメントを投稿

このブログの人気の投稿

Power Automateでファイル名から拡張子を取得

イメージ
Power Automateでファイル名から拡張子を取得 Power Automateでファイル名から拡張子を取得 以前、 Power Automateで自動ファイルバックアップ（OneDrive） という記事で ファイル名から拡張子を取得する方法 をまとめました。 その際には複数の変数を用意して、かつ関数も使用して取得していましたが、これはフロー作成にかなり手間がかかるものです。 そのため、どうにか簡略化できなかと検討したところ新しい取得方法で、より簡潔に作成できることがわかったので、今回はファイル名から拡張子を取得する方法について新しい手法をまとめたいと思います。 作成方法を解説 まず取得する方法を説明する前に、以前の方法ではどのように取得していたかというと、 ファイル名から拡張子までの文字数を取得 ファイル名の拡張子部分の長さを取得する 拡張子の開始位置から、拡張子の文字数分だけ切り取って取得する といった手順を踏んでいました。 詳細は先程リンクを貼っているブログか、文字列抽出方法をまとめたブログがあるので参考にしてください。 Power Automateで文字列抽出 このように以前の方法ですと、ステップ数が増えるため作成も手間ですし、メンテナンス性も良くない状況です。 なのでもっと簡略化して実装する方法を紹介します。また2つの関数を使用するものの、シンプルなため可読性は高いです。さらに、今回の方法で実装すると事前準備していた変数3つが不要になります！！ では、いよいよ本題に入ります。 今回使用する関数は split と last の2つになります。 split関数 split関数 は文字列を指定の文字で 分割 する関数です。 ...
続きを読む

PowerAppsで座席表を作成する

イメージ
PowerAppsで座席表を作成する。 PowerAppsで座席表を作成する。 昨今、会社では指定された先がなく、自由に席を選んで仕事ができる フリーアドレス が増えてきているのではないでしょうか。 私の会社も フリーアドレス を採用しているのですが、その日の気分によって座る場所を変えることができるので私は気に入っています。 ただ自由で便利な反面、困る場面もあるかと思います。 フリーアドレス は自由に座れるのですが、だれがどこに座っているのか分からなくなる状況があります。 さらに テレワーク が重なると出社していない人もいるため、より分からなくなるかと思います。 みなさんの会社でも同様の状況になっていないでしょうか。 もちろん最近は便利なアプリなどによって改善されていたり気がしますが、そのアプリの利用料などがかかるため導入にためらってしまったりするかと思います。 なので今回は、この課題を Power Apps で改善をしていきます。 アプリの概要 アプリの概要を簡単に説明します。 Labelを複数配置していき、机や椅子、その他会議室やロッカーなどを表現 席用のLableの「OnSelect」メソッドにフロー起動の処理を追加 上記だけで簡易な座席表を作成できます。 別途データベース用のListsを作成しておきます。 それでは、Listsの作成から進めています。 下準備 今回のアプリのデータベースはMicrosoft Listsを使用します。 適当な場所にListsを下記内容で作成します。 必要なカラムは「Title(Id)」「Name」です。 今回は適当に数個座席を作成しておきます。「Name」部分は空...
続きを読む

Power AutomateでTeamsのキーワードをトリガーにする

イメージ
Power AutomateでTeamsのキーワードをトリガーにする Power AutomateでTeamsのキーワードをトリガーにする Power Automate には Teams に使えるアクションが多く存在しています。 その中でも今回は「 キーワードが言及された場合 」というトリガーを紹介していきたいと思います。 このトリガーは、グループチャットもしくはチャネルに投稿されたメッセージに、指摘のキーワードが含まれていると起動するトリガーになります。キーワードが含まれてさえいればいいので、チームなどでキーワードを取り決めておけばいつでも起動できます。 フローを作成してみる 今回はトリガーなので、起動することさえPower Automate上で確認すればよいですが、せっかくなので何かしらのメッセージをTeams上に投稿したいと思います。 トリガーを選択する フローの作成で、「自動化したクラウドフロー」を選択します。 今回のフローの名は「キーワード検知」として、フローのトリガーにはキーワードで検索し「キーワードが言及された場合」を選択します。 トリガーの設定をする このトリガーでは「グループチャット」か「チャット」のどちらかを選択することができます。 今回は設定値を下記のようにします。 メッセージの種類：グループチャット 検索キーワード：test Chat-1：テストの会議 これで、「テストの会議」のチャットでメッセージに「test」が含まれる投稿がされた際に、このフローが...
続きを読む