tktts_voicevox.py - tktts用のVOICEVOXエンジン統合モジュール

このモジュールは、VOICEVOX REST APIを通じて音声合成を行う機能を提供します。 VOICEVOXエンジンと連携し、利用可能な話者の取得、テキストの音声合成、 およびダイアログ形式のテキスト処理に対応しています。 このライブラリは、tktts (おそらく「Tkinter Text-to-Speech」の略) の一部として設計されており、 音声合成エンジンのバックエンドとしてVOICEVOXを利用します。

ライブラリの機能や目的

tktts_voicevox.py ライブラリは、VOICEVOXエンジンとの連携を目的としています。 主な機能と解決する課題は以下の通りです。

  • VOICEVOX APIラッパー: VOICEVOXエンジンのREST APIをPythonから簡単に利用できるインターフェースを提供します。

  • 話者情報の取得: VOICEVOXエンジンが提供する利用可能な話者(キャラクターおよびスタイル)のリストを取得し、その情報を整形して提供します。

  • テキスト音声合成: 指定されたテキストを指定されたVOICEVOX話者で音声合成し、WAVファイルとして保存します。 話速や音高の調整も可能です。

  • ダイアログ処理: 複数の会話セグメント(ダイアログ)を効率的に処理し、各セグメントを適切に音声合成して一時ファイルとして保存します。 これにより、複雑な会話シーンの音声生成をサポートします。

  • 依存関係チェック: 必要な非標準ライブラリ (requests) がインストールされているかを確認し、不足している場合はユーザーにインストールを促します。

このライブラリは、tktts のような上位アプリケーションがVOICEVOXを音声合成バックエンドとして利用する際の共通インターフェースを提供し、VOICEVOXエンジンの複雑なAPI呼び出しを抽象化することで、開発者がより簡単に音声合成機能を組み込めるようにします。

importする方法

このライブラリを他のPythonプログラムから利用するには、標準的な import 文を使用します。

import tktts_voicevox

あるいは、特定の関数のみをインポートすることも可能です。

from tktts_voicevox import speak, get_available_voices

必要な非標準ライブラリとインストール方法

このライブラリは、VOICEVOXエンジンのREST APIと通信するために requests ライブラリに依存しています。 requests はPythonの標準ライブラリには含まれていないため、別途インストールが必要です。

以下の pip コマンドを使用してインストールできます。

pip install requests

もし requests がインストールされていない状態で tktts_voicevox.py をインポートしようとすると、エラーメッセージが表示され、プログラムは終了します。

importできる変数と関数

変数

  • TTS_ENGINE_NAME:

    • 型: str

    • 説明: このTTSエンジンの名前を示す文字列。常に 'voicevox' が設定されています。

  • DEFAULT_VOICEVOX_VOICE:

    • 型: str

    • 説明: VOICEVOXエンジン使用時のデフォルト話者名。初期値は "四国めたん" です。

  • DEFAULT_ENDPOINT:

    • 型: str

    • 説明: VOICEVOXエンジンのAPIエンドポイントのデフォルトURL。通常、VOICEVOXエンジン起動時にローカルで提供される "http://127.0.0.1:50021" が設定されています。

関数

get_available_voices_info(endpoint=DEFAULT_ENDPOINT)

VOICEVOXエンジンから利用可能な話者情報(名前、スタイル、ID)のリストを取得します。

  • 動作: VOICEVOXエンジンの /speakers エンドポイントにGETリクエストを送信し、その応答をJSON形式で解析します。 各話者のスタイル情報も抽出し、扱いやすい辞書のリストとして返します。

  • 引数:

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

  • 戻り値:

    • list[dict]: 話者情報を含む辞書のリスト。各辞書は 'name', 'style', 'id' キーを持ちます。 例: [{'name': '四国めたん', 'style': 'あまあま', 'id': 2}, {'name': '四国めたん', 'style': 'ツンツン', 'id': 3}, ...]

get_available_voices(endpoint=DEFAULT_ENDPOINT)

利用可能なVOICEVOX話者のフルネーム(名前とスタイル)のリストを取得します。

  • 動作: get_available_voices_info 関数を呼び出して詳細な話者情報を取得し、 それらを「話者名(スタイル名)」の形式の文字列リストに変換します。

  • 引数:

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

  • 戻り値:

    • list[str] または bool: 利用可能な話者名のリスト。話者が見つからない場合は False。 例: ['四国めたん(あまあま)', '四国めたん(ツンツン)', ...]

list_available_voices(endpoint=DEFAULT_ENDPOINT)

利用可能なVOICEVOX話者の一覧をコンソールに表示します。

  • 動作: get_available_voices_info 関数を使用して話者情報を取得し、 話者の名前、スタイル、IDを整形して標準出力に表示します。

  • 引数:

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

  • 戻り値:

    • bool: 話者の一覧表示が成功した場合は True、話者が見つからない場合は False。

resolve_speaker_id(speaker_name, endpoint=DEFAULT_ENDPOINT, speakers_dict = None)

話者名からVOICEVOXの speaker_id を解決します。

  • 動作: 渡された speaker_name(フルネームまたは部分文字列)に一致する最初の話者の speaker_id を検索して返します。 大文字小文字を区別しない検索を行います。speakers_dict が None の場合、 get_available_voices_info を呼び出して話者情報を取得します。

  • 引数:

    • speaker_name (str): 検索する話者の名前またはスタイルの一部。

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

    • speakers_dict (list[dict] または None): 事前に取得した話者情報の辞書リスト。None の場合、内部で取得します。

  • 戻り値:

    • tuple[list[dict], int]: 更新された話者情報の辞書リストと、見つかった speaker_id。

  • 例外:

    • ValueError: 指定された話者が見つからない場合。

speak(outfile, text, voice, speak_rate = None, speak_pitch = None, endpoint = DEFAULT_ENDPOINT)

指定されたテキストをVOICEVOXエンジンで音声合成し、WAVファイルとして保存します。

  • 動作: まず /audio_query エンドポイントで音声合成クエリを作成し、 そのクエリに対して話速 (speedScale) や音高 (pitchScale) を適用します。 次に /synthesis エンドポイントで実際の音声データを生成し、 指定されたファイルパスにバイナリ形式で書き込みます。

  • 引数:

    • outfile (str): 音声データが保存されるファイルパス。

    • text (str): 合成するテキスト。

    • voice (int): 使用するVOICEVOX話者の speaker_id。

    • speak_rate (float または None): 音声の再生速度スケール。None の場合はVOICEVOXエンジンのデフォルト値を使用。

    • speak_pitch (float または None): 音声のピッチスケール。None の場合はVOICEVOXエンジンのデフォルト値を使用。

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

  • 戻り値:

    • str または None: 保存されたファイルパス。エラーが発生した場合は None。

speak_dialogue(dialogue, replacements, target_voices, speakers = {}, temp_dir=".", outfile=None, ext="wav", endpoint=DEFAULT_ENDPOINT, cfg = None)

ダイアログリストの各セグメントをVOICEVOXで音声合成し、一時ファイルに保存します。

  • 動作: 入力された dialogue(通常は複数の会話セグメントのリスト)を split_dialogue 関数(tktts_base からインポート)で個々の発言に分割します。 各発言について、話者名から speaker_id を解決し、speak 関数を呼び出して音声合成を行います。 生成された一時ファイルのパスをリストとして返します。 target_voices が文字列の場合、全てのセグメントでその話者が強制的に使用されます。 cfg オブジェクトが渡された場合、fspeak_rate や fspeak_pitch 属性から話速と音高の設定を読み取ります。

  • 引数:

    • dialogue (list[str]): 会話テキストのリスト。

    • replacements (dict): テキスト置換ルールを定義する辞書。apply_replacements 関数(tktts_base からインポート)で使用されます。

    • target_voices (str または list[str]): 使用する話者。文字列の場合、全てのセグメントでその話者が強制されます。リストの場合、split_dialogue が話者を決定します。

    • speakers (dict): 話者ごとの追加設定を含む辞書。デフォルトは空の辞書。

    • temp_dir (str): 一時ファイルを保存するディレクトリパス。デフォルトは "." (カレントディレクトリ)。

    • outfile (str または None): 最終的な出力ファイルパス(保存モードの場合)。None の場合、一時ファイルを生成します。この引数は現在の実装では使用されておらず、単に一時ファイルが生成されます。

    • ext (str): 生成される音声ファイルの拡張子(例: 'wav')。デフォルトは 'wav'。

    • endpoint (str): VOICEVOXエンジンのAPIエンドポイントURL。デフォルトは DEFAULT_ENDPOINT。

    • cfg (object または None): 設定オブジェクト。fspeak_rate や fspeak_pitch などの属性を持つ場合があります。これらの属性が存在する場合、speak 関数に話速と音高の設定として渡されます。

  • 戻り値:

    • tuple[bool, list[str]]: 処理が成功したかを示す真偽値と、生成された一時ファイルのパスリスト。

main scriptとして実行したときの動作

tktts_voicevox.py は、ライブラリとして設計されており、if __name__ == "__main__": ブロックを持っていません。 そのため、このファイルを直接Pythonインタープリタで実行しても、特別なスクリプトとしての動作は定義されていません。

ただし、モジュールが初回インポートされる際に、以下の初期化処理が実行されます。

  1. 依存ライブラリのチェック: requests ライブラリがシステムにインストールされているかを確認します。

  2. エラー処理:

    • もし requests がインストールされていない場合、標準出力にエラーメッセージが表示されます。

      Error: Missing libraries:
      requests
        install: pip install requests
      
      Press ENTER to terminate>>
      
    • このメッセージの後にユーザーからのEnterキー入力を待ち、その後プログラムは終了します (sys.exit(1))。

このため、通常は他のPythonスクリプトから import tktts_voicevox を実行する形式で使用します。もし requests が不足している場合は、上記のエラーメッセージが表示されてプログラムの実行が停止します。