tktts_voicevox.py ダウンロード/コピー

tktts_voicevox.py をダウンロード

tktts_voicevox.py
tktts_voicevox.py
  1"""
  2tktts_voicevox.py - tktts用のVOICEVOXエンジン統合モジュール
  3
  4このモジュールは、VOICEVOX REST APIを通じて音声合成を行う機能を提供します。
  5VOICEVOXエンジンと連携し、利用可能な話者の取得、テキストの音声合成、
  6およびダイアログ形式のテキスト処理に対応しています。
  7
  8関連リンク: :doc:`tktts_voicevox_usage`
  9"""
 10
 11import os
 12import sys
 13import re
 14import requests
 15
 16missing = []
 17for lib in ["requests"]:
 18    try:
 19        __import__(lib)
 20    except ImportError:
 21        missing.append(lib)
 22
 23if missing:
 24    print(f"Error: Missing libraries:\n{', '.join(missing)}")
 25    print("  install: pip install requests")
 26    input("\nPress ENTER to terminate>>\n")
 27    sys.exit(1)
 28
 29from tktts_base import apply_replacements, normalize_speaker, split_dialogue
 30
 31
 32# VOICEVOXエンジンの設定
 33TTS_ENGINE_NAME = 'voicevox'
 34DEFAULT_VOICEVOX_VOICE = "四国めたん"
 35DEFAULT_ENDPOINT = "http://127.0.0.1:50021"  # エンジン起動時のデフォルトURL
 36
 37
 38def get_available_voices_info(endpoint=DEFAULT_ENDPOINT):
 39    """
 40    VOICEVOXエンジンから利用可能な話者情報(名前、スタイル、ID)のリストを取得します。
 41
 42    詳細説明:
 43        VOICEVOXエンジンの `/speakers` エンドポイントにGETリクエストを送信し、その応答をJSON形式で解析します。
 44        各話者のスタイル情報も抽出して、扱いやすい辞書のリストとして返します。
 45
 46    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
 47    :returns: list[dict]: 話者情報を含む辞書のリスト。各辞書は'name', 'style', 'id'キーを持ちます。
 48    """
 49    response = requests.get(f"{endpoint}/speakers")
 50    response.raise_for_status()
 51    speakers = response.json()
 52    speakers_dict = []
 53
 54    voices = []
 55    for sp in speakers:
 56        name = sp["name"]
 57        for style in sp["styles"]:
 58#            print(f"{name} - {style['name']} (id={style['id']})")
 59#            speakers_dict.append(sp)
 60            voices.append({"name": name, "style": style['name'], "id": style['id']})
 61
 62    return voices
 63
 64def get_available_voices(endpoint=DEFAULT_ENDPOINT):
 65    """
 66    利用可能なVOICEVOX話者のフルネーム(名前とスタイル)のリストを取得します。
 67
 68    詳細説明:
 69        `get_available_voices_info` 関数を呼び出して詳細な話者情報を取得し、
 70        それらを「話者名(スタイル名)」の形式の文字列リストに変換します。
 71
 72    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
 73    :returns: list[str] or bool: 利用可能な話者名のリスト。話者が見つからない場合はFalse。
 74    """
 75    voices = get_available_voices_info(endpoint)
 76    if not voices: return False
 77
 78    voice_names = []
 79    for v in voices:
 80        voice_names.append(f"{v['name']}({v['style']})")
 81
 82    return voice_names
 83
 84def list_available_voices(endpoint=DEFAULT_ENDPOINT):
 85    """
 86    利用可能なVOICEVOX話者の一覧をコンソールに表示します。
 87
 88    詳細説明:
 89        `get_available_voices_info` 関数を使用して話者情報を取得し、
 90        話者の名前、スタイル、IDを整形して標準出力に表示します。
 91
 92    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
 93    :returns: bool: 話者の一覧表示が成功した場合はTrue、話者が見つからない場合はFalse。
 94    """
 95    print(f"=== 利用可能な {TTS_ENGINE_NAME} voices ===")
 96    voices = get_available_voices_info()
 97    if not voices: return False
 98    
 99    for v in voices:
100        print(f"  Name: {v['name']}, Style: {v['style']}, ID: {v['id']}")
101
102    return True
103
104def resolve_speaker_id(speaker_name, endpoint=DEFAULT_ENDPOINT, speakers_dict = None):
105    """
106    話者名からVOICEVOXのspeaker_idを解決します。
107
108    詳細説明:
109        渡された`speaker_name`(フルネームまたは部分文字列)に一致する最初の話者のspeaker_idを検索して返します。
110        大文字小文字を区別しない検索を行います。`speakers_dict`がNoneの場合、
111        `get_available_voices_info`を呼び出して話者情報を取得します。
112
113    :param speaker_name: str: 検索する話者の名前またはスタイルの一部。
114    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
115    :param speakers_dict: list[dict] or None: 事前に取得した話者情報の辞書リスト。Noneの場合、内部で取得します。
116    :returns: tuple[list[dict], int]: 更新された話者情報の辞書リストと、見つかったspeaker_id。
117    :raises ValueError: 指定された話者が見つからない場合。
118    """
119
120    if speakers_dict is None: speakers_dict = get_available_voices_info(endpoint)
121    speaker_name = normalize_speaker(speaker_name) #.lower())
122#    print(f"  search for [{speaker_name}]")
123#    print(f"  speakers_dict:", speakers_dict)
124    for voice in speakers_dict:
125        full_name = voice['name'].lower()
126        style = voice['style'].lower()
127        if speaker_name in full_name or speaker_name in style:
128            return speakers_dict, voice["id"]
129
130    raise ValueError(f"❌ Error in tktts_voicevox.resolve_speaker_id(): 話者 [{speaker_name}] が見つかりませんでした")
131
132def speak(outfile, text, voice, speak_rate = None, speak_pitch = None, endpoint = DEFAULT_ENDPOINT):
133    """
134    指定されたテキストをVOICEVOXエンジンで音声合成し、WAVファイルとして保存します。
135
136    詳細説明:
137        まず`/audio_query`エンドポイントで音声合成クエリを作成し、
138        そのクエリに対して話速(`speedScale`)や音高(`pitchScale`)を適用します。
139        次に`/synthesis`エンドポイントで実際の音声データを生成し、
140        指定されたファイルパスにバイナリ形式で書き込みます。
141
142    :param outfile: str: 音声データが保存されるファイルパス。
143    :param text: str: 合成するテキスト。
144    :param voice: int: 使用するVOICEVOX話者のspeaker_id。
145    :param speak_rate: float or None: 音声の再生速度スケール。Noneの場合はデフォルト値を使用。
146    :param speak_pitch: float or None: 音声のピッチスケール。Noneの場合はデフォルト値を使用。
147    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
148    :returns: str or None: 保存されたファイルパス。エラーが発生した場合はNone。
149    """
150    query = requests.post(
151        f"{endpoint}/audio_query",
152        params={"text": text, "speaker": voice}
153        )
154    query.raise_for_status()
155    query_json = query.json()
156
157    if speak_rate is not None:
158        query_json["speedScale"] = speak_rate
159    if speak_pitch is not None:
160        query_json["pitchScale"] = speak_pitch
161
162    try:
163        synthesis = requests.post(
164            f"{endpoint}/synthesis",
165            params={"speaker": voice},
166            json=query_json
167            )
168        synthesis.raise_for_status()
169    except requests.exceptions.RequestException as e:
170        print(f"❌ VOICEVOX 接続エラー: {e}")
171        return None
172
173    with open(outfile, "wb") as f:
174        f.write(synthesis.content)
175
176    if os.path.exists(outfile):
177        print(f"    ** 一時ファイル [{outfile}] を保存しました")
178    else:
179        print(f"    ** Error: ファイル [{outfile}] の出力に失敗しました")
180        return None
181
182    return outfile
183
184# target_voicesが文字列型の場合、speakerを強制的に置き換える
185def speak_dialogue(dialogue, replacements, target_voices, speakers = {}, temp_dir=".",
186                   outfile=None, ext="wav", endpoint=DEFAULT_ENDPOINT, 
187                   cfg = None):
188    """
189    ダイアログリストの各セグメントをVOICEVOXで音声合成し、一時ファイルに保存します。
190
191    詳細説明:
192        入力された`dialogue`(通常は複数の会話セグメントのリスト)を`split_dialogue`関数で個々の発言に分割します。
193        各発言について、話者名からspeaker_idを解決し、`speak`関数を呼び出して音声合成を行います。
194        生成された一時ファイルのパスをリストとして返します。
195        `target_voices`が文字列の場合、全てのセグメントでその話者が強制的に使用されます。
196
197    :param dialogue: list[str]: 会話テキストのリスト。
198    :param replacements: dict: テキスト置換ルールを定義する辞書。
199    :param target_voices: str or list[str]: 使用する話者。文字列の場合、全てのセグメントでその話者が強制されます。リストの場合、`split_dialogue`が話者を決定します。
200    :param speakers: dict: 話者ごとの追加設定を含む辞書。
201    :param temp_dir: str: 一時ファイルを保存するディレクトリパス。
202    :param outfile: str or None: 最終的な出力ファイルパス(保存モードの場合)。Noneの場合、一時ファイルを生成します。
203    :param ext: str: 生成される音声ファイルの拡張子(例: 'wav')。
204    :param endpoint: str: VOICEVOXエンジンのAPIエンドポイントURL。
205    :param cfg: object or None: 設定オブジェクト。`fspeak_rate`や`fspeak_pitch`などの属性を持つ場合があります。
206    :returns: tuple[bool, list[str]]: 処理が成功したかを示す真偽値と、生成された一時ファイルのパスリスト。
207    """
208    is_save_mode = bool(outfile)
209
210#    print()
211    print("tktts_voicevox.speak_dialogue(): target_voices:", target_voices)
212
213    tmpfiles = []
214    speakers_dict = None   # 同じspekaerを何度も検索しなくて済むようにglobalな辞書を作る
215    idx = 1
216    for i, _dialogue in enumerate(dialogue):
217        print()
218        print(f"Dialogue {i:04d}:")
219        dialogue_list = split_dialogue(_dialogue, target_voices, speakers = speakers, 
220                            default_voice = DEFAULT_VOICEVOX_VOICE, is_monologue = cfg.monologue)
221        for speaker, text in dialogue_list:
222            tmpfile = os.path.join(temp_dir, f"tmp_{idx:03d}.{ext}")
223            text = apply_replacements(text, replacements)
224            if type(target_voices) is str: speaker = target_voices
225
226            try:
227                speakers_dict, target_voice = resolve_speaker_id(speaker, endpoint, speakers_dict = speakers_dict)
228            except ValueError as e:
229                print(e)
230                return False, tmpfiles
231
232            print(f"  {idx:04d}: voice={speaker} (id={target_voice}): ", end = "")
233            print(text)
234
235            speedScale = cfg.fspeak_rate  if hasattr(cfg, 'fspeak_rate') else None
236            pitchScale = cfg.fspeak_pitch if hasattr(cfg, 'fspeak_pitch') else None
237            _outfile = speak(outfile = tmpfile,text = text, voice = target_voice,
238                        speak_rate = speedScale, speak_pitch = pitchScale,
239                        endpoint = endpoint)
240            
241            if _outfile is None:
242                return False, tmpfiles
243
244            tmpfiles.append(_outfile)
245            idx += 1
246
247    return True, tmpfiles