tktts_aquestalkplayer.py

このドキュメントは、Pythonライブラリ tktts_aquestalkplayer.py について説明します。

ライブラリの機能や目的

このライブラリは、WindowsアプリケーションであるAquesTalkPlayerを利用して、テキストから音声ファイルを生成するText-to-Speech (TTS) エンジンです。主な目的は、AquesTalkPlayerをPythonプログラムから簡単に制御し、指定されたテキストを多様な話者(音声プリセット)で音声ファイルとして出力することです。

主な機能:

  • AquesTalkPlayerが提供する複数の音声プリセット(例: 「れいむ」「男声1」など)の利用。

  • 指定されたテキストを単一の音声ファイルとして出力。

  • 対話形式のテキストを解析し、話者ごとに異なる音声プリセットで複数の音声ファイルを生成。

  • テキスト置換ルールを適用して、音声合成前にテキストを加工する機能。

このライブラリは、特にテキストベースのアプリケーションやゲームにおいて、動的にキャラクターのセリフを音声化する必要がある場合に役立ちます。

importする方法

このライブラリを使用するには、Pythonスクリプトの冒頭で以下のようにimportします。

import tktts_aquestalkplayer

または、特定の関数のみをimportすることも可能です。

from tktts_aquestalkplayer import speak, get_available_voices

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

このライブラリは、標準ライブラリ以外に以下の依存関係があります。

  1. AquesTalkPlayer.exe:

    • 種類: Windowsアプリケーション(Pythonライブラリではありません)

    • 説明: このライブラリが音声合成を行うために不可欠な外部プログラムです。別途インストールし、実行可能ファイル (aquestalkplayer.exe) がアクセス可能なパスに存在する必要があります。デフォルトでは、Pythonスクリプトと同じディレクトリ、またはシステムPATHに登録されていることを期待します。

    • インストール方法: AquesTalkPlayerの公式サイトからダウンロードし、インストールしてください。

  2. tktts_base モジュール:

    • 種類: ローカル依存モジュール

    • 説明: tktts_base は、apply_replacements, normalize_speaker, split_dialogue といった共通のユーティリティ関数を提供します。このモジュールは tktts_aquestalkplayer.py と同じプロジェクト内にあり、通常は同じディレクトリまたはPythonのモジュール探索パスが通っている場所に配置されていることを想定しています。

    • インストール方法: これは pip でインストールするような外部ライブラリではなく、プロジェクト内部のモジュールです。tktts_base.py ファイルが tktts_aquestalkplayer.py と同じディレクトリ、または PYTHONPATH に含まれるディレクトリに存在することを確認してください。

importできる変数と関数

変数

  • TTS_ENGINE_NAME

    • このTTSエンジンの名前を定義する文字列。値は 'aquestalkplayer' です。

  • tts_model

    • TTSモデル名を指定する文字列。現在 'tts-1' に設定されていますが、コードでは直接使用されていません。利用可能なモデルの例として 'tts-1-hd', 'gpt-4o-mini-tts' などがコメントで示されています。

  • voices_available

    • AquesTalkPlayerで利用可能な音声プリセット名のリストです。 例: ["れいむ", "まりさ", "こいし", ...]

  • DEFAULT_ATP_VOICE

    • AquesTalkPlayerでデフォルトとして使用される音声プリセット名です。現在 'れいむ' に設定されています。

関数

  • get_available_voices_info()

    • 動作: 利用可能なAquesTalkPlayerの音声情報を取得します。各音声は辞書形式で 'name' キーを持ちます。

    • 引数: なし

    • 戻り値: 利用可能な音声の名前を含む辞書のリスト。 例: [{"name": "れいむ"}, {"name": "まりさ"}]

    • 戻り値の型: list[dict]

  • get_available_voices()

    • 動作: 利用可能なAquesTalkPlayerの音声名のリストを返します。

    • 引数: なし

    • 戻り値: 利用可能な音声名のリスト。 例: ["れいむ", "まりさ", "こいし"]

    • 戻り値の型: list[str]

  • list_available_voices()

    • 動作: 利用可能なAquesTalkPlayerの音声をコンソールに一覧表示します。

    • 引数: なし

    • 戻り値: 音声情報が正常に取得され表示された場合は True、それ以外は False。

    • 戻り値の型: bool

  • speak(outfile, text, voice, aquestalk_path = "aquestalkplayer.exe")

    • 動作: 指定されたテキストをAquesTalkPlayerで音声合成し、ファイルに保存します。AquesTalkPlayerの実行可能ファイル (aquestalkplayer.exe) をサブプロセスとして呼び出し、与えられたテキストと音声設定で音声ファイルを生成します。処理の成功・失敗はコンソールに表示されます。 注: subprocess.run の shell=True はセキュリティ上のリスクがあるため、使用には注意が必要です。

    • 引数:

      • outfile (str): 出力する音声ファイルのパス。

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

      • voice (str): 使用する音声プリセット名(例: "れいむ", "男声1")。

      • aquestalk_path (str, オプション): AquesTalkPlayer.exe へのパス。デフォルトはカレントディレクトリの 'aquestalkplayer.exe'。

    • 戻り値: 音声ファイルが正常に保存された場合はそのパス、失敗した場合は None。

    • 戻り値の型: str または None

  • speak_dialogue(dialogue, replacements, target_voices, speakers = {}, aquestalk_path = None, temp_dir = None, outfile = None, ext = "wav", cfg = None)

    • 動作: 対話形式のテキストをAquesTalkPlayerで音声合成し、複数のテンポラリファイルに保存します。与えられた対話リストを話者ごとに分割し、各テキストに対して speak 関数を呼び出して個別の音声ファイルを生成します。テキストの置換処理も適用されます。この関数は、最終的な単一の outfile への結合は行わず、生成された個別のテンポラリファイルのパスのリストを返します。

    • 引数:

      • dialogue (list[str] または list[dict]): 対話のリスト。各要素は文字列、または話者情報を含む辞書。

      • replacements (dict): テキスト置換ルールを定義する辞書。

      • target_voices (dict または str): 話者名とAquesTalkPlayerの音声プリセット名のマッピング、または単一の音声プリセット名。

      • speakers (dict, オプション): 話者IDと話者名のマッピング。デフォルトは空の辞書。

      • aquestalk_path (str または None, オプション): AquesTalkPlayer.exe へのパス。指定がない場合はデフォルト値が使用される。

      • temp_dir (str または None, オプション): テンポラリ音声ファイルを保存するディレクトリのパス。

      • outfile (str または None, オプション): (未使用) 最終的に結合される出力ファイルのパス。この関数では個別のテンポラリファイルを生成するため、None を推奨します。

      • ext (str, オプション): 出力する音声ファイルの拡張子。デフォルトは 'wav'。実際のコード内では 'wav' に固定されています。

      • cfg (object または None, オプション): 設定オブジェクト。cfg.monologue でモノローグモードが指定される場合がある。

    • 戻り値: 成功フラグ (True または False) と、生成されたテンポラリ音声ファイルのパスのリスト。

    • 戻り値の型: tuple[bool, list[str]]

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

このライブラリ tktts_aquestalkplayer.py には、if __name__ == "__main__": ブロックが実装されていません。 そのため、このファイルを直接Pythonインタプリタで実行しても、特別な処理は行われません。通常は他のスクリプトやアプリケーションからimportして利用されることを想定しています。