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

tktts_edge.py をダウンロード

tktts_edge.py
tktts_edge.py
  1"""tkttsのEdge TTSバックエンド。
  2
  3`pip install edge-tts` が必要です。Edge TTSの音声はMicrosoftのオンラインサービスから取得され、APIキーは不要です。
  4
  5詳細説明:
  6このモジュールは、`tktts` ライブラリがMicrosoft Edge TTSサービスを利用してテキストを音声に変換するためのインターフェースを提供します。
  7非同期処理を同期的な`tktts`の枠組みに統合し、利用可能な音声の取得、音声ファイルへの保存、
  8そして対話形式のスクリプトの合成をサポートします。
  9
 10:doc:`tktts_edge_usage`
 11"""
 12
 13import asyncio
 14import os
 15
 16import edge_tts
 17
 18from tktts_base import apply_replacements, split_dialogue
 19
 20
 21TTS_ENGINE_NAME = "edge"
 22DEFAULT_EDGE_VOICE = "Nanami"
 23_voices_cache = None
 24
 25
 26def _run(coro):
 27    """Edge TTSのコルーチンを同期的なtkttsインターフェースから実行します。
 28
 29    詳細説明:
 30    `asyncio.run` を使用して非同期処理を実行します。
 31    `RuntimeError` が発生した場合、特にイベントループが既に実行中のケースで、
 32    より分かりやすいエラーメッセージを提供し、ワーカーツレッドからの呼び出しを促します。
 33
 34    :param coro: 実行するコルーチンオブジェクト。
 35    :type coro: `coroutine`
 36    :returns: コルーチンの実行結果。
 37    :rtype: `Any`
 38    :raises RuntimeError: アクティブなasyncioイベントループ内で実行された場合。
 39    """
 40    try:
 41        return asyncio.run(coro)
 42    except RuntimeError as exc:
 43        # This should not occur from speak.py, but makes the error actionable
 44        # when this backend is used from a notebook or GUI event loop.
 45        if "asyncio.run() cannot be called" in str(exc):
 46            raise RuntimeError(
 47                "Edge TTS cannot run inside an active asyncio event loop. "
 48                "Call this backend from a worker thread."
 49            ) from exc
 50        raise
 51
 52
 53async def _fetch_voices():
 54    """Edge TTSで利用可能な音声情報を非同期で取得し、キャッシュします。
 55
 56    詳細説明:
 57    一度取得した音声情報は `_voices_cache` に格納され、次回の呼び出しからはキャッシュされたデータが使用されます。
 58    キャッシュが空の場合のみ、`edge_tts.list_voices()` を呼び出して最新の音声情報を取得します。
 59
 60    :returns: 利用可能な音声情報のリスト。各要素はEdge TTSのAPIから返される辞書形式です。
 61    :rtype: `list[dict]`
 62    """
 63    global _voices_cache
 64    if _voices_cache is None:
 65        _voices_cache = await edge_tts.list_voices()
 66    return _voices_cache
 67
 68
 69def _voice_info(voice):
 70    """Edge TTSの生音声情報から、tkttsが使用する共通フォーマットの音声情報ディクショナリを作成します。
 71
 72    :param voice: Edge TTSから取得した単一の音声情報ディクショナリ。
 73    :type voice: `dict`
 74    :returns: tktts形式の音声情報ディクショナリ。キーは 'name', 'locale', 'gender'。
 75    :rtype: `dict`
 76    """
 77    return {
 78        "name": voice["ShortName"],
 79        "locale": voice.get("Locale", ""),
 80        "gender": voice.get("Gender", ""),
 81    }
 82
 83
 84def get_available_voices_info():
 85    """利用可能なEdge TTS音声を、tkttsの共通音声情報フォーマットで返します。
 86
 87    詳細説明:
 88    内部で非同期関数 `_fetch_voices` を呼び出してEdge TTSの音声リストを取得し、
 89    `_voice_info` を使って `tktts` の共通フォーマットに変換します。
 90    結果はShortNameでソートされて返されます。
 91
 92    :returns: 利用可能な音声情報ディクショナリのリスト。各要素は `_voice_info` の戻り値と同じ形式です。
 93    :rtype: `list[dict]`
 94    """
 95    voices = _run(_fetch_voices())
 96    return [_voice_info(voice) for voice in sorted(voices, key=lambda v: v["ShortName"])]
 97
 98
 99def get_available_voices():
100    """利用可能なEdge TTS音声の名前のリストを返します。
101
102    詳細説明:
103    `get_available_voices_info()` を呼び出し、その結果から音声の名前(`ShortName`)のみを抽出してリストとして返します。
104
105    :returns: 利用可能な音声の名前(ShortName)のリスト。
106    :rtype: `list[str]`
107    """
108    return [voice["name"] for voice in get_available_voices_info()]
109
110
111def list_available_voices():
112    """利用可能なEdge TTS音声の一覧をコンソールに出力します。
113
114    詳細説明:
115    音声名、ロケール、性別を整形して標準出力に表示します。
116    音声の取得に失敗した場合はエラーメッセージを出力し、Falseを返します。
117
118    :returns: 音声一覧の表示に成功した場合はTrue、失敗した場合はFalse。
119    :rtype: `bool`
120    """
121    try:
122        voices = get_available_voices_info()
123    except Exception as exc:
124        print(f"❌ Edge TTS の音声一覧を取得できませんでした: {exc}")
125        return False
126
127    print(f"=== 利用可能な {TTS_ENGINE_NAME} voices ===")
128    for voice in voices:
129        print(f"  {voice['name']:<40} {voice['locale']:<10} {voice['gender']}")
130    print(f"\n{len(voices)} voice(s).")
131    return True
132
133
134async def _resolve_voice_async(keyword):
135    """キーワードに基づいて、利用可能なEdge TTS音声の中から最適なものを非同期で解決します。
136
137    詳細説明:
138    以下の優先順位でキーワードに合致する音声を検索します。
139    1. 短縮名 (e.g., `ja-JP-NanamiNeural`) と完全に一致
140    2. 短縮名 (e.g., `ja-JP-NanamiNeural`) にキーワードが部分一致
141    3. キーワードに "nanami" が含まれる音声
142    4. ロケールが "ja" で始まり、性別が "Female" の音声
143    上記のいずれにも一致しない場合、利用可能な音声リストの最初の音声が選択されます。
144
145    :param keyword: 解決したい音声名またはキーワード。`None` の場合は `DEFAULT_EDGE_VOICE` が使用されます。
146    :type keyword: `str` or `None`
147    :returns: 解決されたEdge TTSのShortName。
148    :rtype: `str`
149    """
150    voices = await _fetch_voices()
151    keyword = str(keyword or DEFAULT_EDGE_VOICE).strip()
152
153    # ShortName (e.g. ja-JP-NanamiNeural) is accepted as-is, while a short
154    # name such as Nanami remains convenient for the existing voice maps.
155    for voice in voices:
156        if keyword.lower() == voice["ShortName"].lower():
157            return voice["ShortName"]
158    for voice in voices:
159        if keyword.lower() in voice["ShortName"].lower():
160            return voice["ShortName"]
161    for voice in voices:
162        if "nanami" in voice["ShortName"].lower():
163            return voice["ShortName"]
164    for voice in voices:
165        if voice.get("Locale", "").lower().startswith("ja") and voice.get("Gender") == "Female":
166            return voice["ShortName"]
167    return voices[0]["ShortName"]
168
169
170def _normalize_prosody(value, default="+0%"):
171    """プロソディ(速さ、音量、ピッチ)の値をEdge TTSが認識する形式に正規化します。
172
173    詳細説明:
174    値が `None` または空の場合、デフォルト値を適用します。
175    値が `%` や `Hz` で終わらない数値の場合、`%` を付加します。
176
177    :param value: 正規化するプロソディの値(例: "0", "10", "+5%", "-2Hz")。
178    :type value: `str` or `int` or `float` or `None`
179    :param default: 値がNoneまたは空の場合に適用するデフォルト値(例: "+0%")。
180    :type default: `str`
181    :returns: 正規化されたプロソディ値の文字列(例: "+0%", "+5Hz")。
182    :rtype: `str`
183    """
184    value = str(value if value is not None else default).strip()
185    if not value:
186        return default
187    if value.endswith("%") or value.endswith("Hz"):
188        return value
189    return f"{value}%"
190
191
192def _select_voice(target_voices, speaker):
193    """指定されたスピーカーに基づいてEdge TTSの音声を選択します。
194
195    詳細説明:
196    `target_voices` が文字列の場合、それを直接音声として使用します。
197    `target_voices` が辞書の場合、スピーカー名に対応する音声名を検索します。
198    スピーカー名が `Neural` で終わる場合、Edge TTSのフルIDとみなし、そのまま使用します。
199    それ以外の場合、デフォルトの `DEFAULT_EDGE_VOICE` を使用します。
200
201    :param target_voices: スピーカーと音声のマップ (dict) または単一の音声名 (str)。
202    :type target_voices: `dict` or `str`
203    :param speaker: 選択するスピーカー名。
204    :type speaker: `str` or `None`
205    :returns: 選択されたEdge TTSの音声ID (ShortName)。
206    :rtype: `str`
207    """
208    if isinstance(target_voices, str):
209        return target_voices
210
211    mapped_voice = target_voices.get(speaker)
212    if mapped_voice:
213        return mapped_voice
214
215    speaker_name = str(speaker or "").strip()
216    if speaker_name.lower().endswith("neural"):
217        return speaker_name
218    return DEFAULT_EDGE_VOICE
219
220
221async def _save_async(outfile, text, voice, rate, volume, pitch):
222    """指定されたテキストをEdge TTSで音声ファイルとして非同期で保存します。
223
224    詳細説明:
225    `_resolve_voice_async` を使用して音声名を解決し、
226    `edge_tts.Communicate` インスタンスを作成して音声ファイルを指定されたパスに保存します。
227
228    :param outfile: 音声ファイルの出力パス。
229    :type outfile: `str`
230    :param text: 合成するテキスト。
231    :type text: `str`
232    :param voice: 使用する音声名またはキーワード。`_resolve_voice_async` で解決されます。
233    :type voice: `str`
234    :param rate: 音声の速さ(例: "+0%", "+10%")。`_normalize_prosody` で正規化された値。
235    :type rate: `str`
236    :param volume: 音量(例: "+0%", "-5%")。`_normalize_prosody` で正規化された値。
237    :type volume: `str`
238    :param pitch: ピッチ(例: "+0Hz", "-2Hz")。`_normalize_prosody` で正規化された値。
239    :type pitch: `str`
240    :returns: 実際に使用されたEdge TTSの音声ID (ShortName)。
241    :rtype: `str`
242    """
243    resolved_voice = await _resolve_voice_async(voice)
244    communicate = edge_tts.Communicate(
245        text=text,
246        voice=resolved_voice,
247        rate=rate,
248        volume=volume,
249        pitch=pitch,
250    )
251    await communicate.save(outfile)
252    return resolved_voice
253
254
255def speak(outfile, text, voice, rate="+0%", volume="+0%", pitch="+0Hz"):
256    """指定されたテキストをEdge TTSで音声ファイルとして同期的に生成します。
257
258    詳細説明:
259    入力テキストが空でない場合、内部で非同期関数 `_save_async` を呼び出し、
260    `_run` を使って同期的に実行します。音声生成に成功した場合はファイルパスを返し、
261    失敗した場合はエラーメッセージを出力し `None` を返します。
262
263    :param outfile: 音声ファイルの出力パス。
264    :type outfile: `str`
265    :param text: 合成するテキスト。
266    :type text: `str`
267    :param voice: 使用する音声名またはキーワード。
268    :type voice: `str`
269    :param rate: (オプション) 音声の速さ(例: "+0%", "+10%")。デフォルトは"+0%"。
270    :type rate: `str`
271    :param volume: (オプション) 音量(例: "+0%", "-5%")。デフォルトは"+0%"。
272    :type volume: `str`
273    :param pitch: (オプション) ピッチ(例: "+0Hz", "-2Hz")。デフォルトは"+0Hz"。
274    :type pitch: `str`
275    :returns: 生成された音声ファイルのパス、または失敗した場合はNone。
276    :rtype: `str` or `None`
277    """
278    if not str(text).strip():
279        return None
280    try:
281        resolved_voice = _run(_save_async(outfile, text, voice, rate, volume, pitch))
282        print(f"  Edge voice: {resolved_voice}")
283        return outfile if os.path.isfile(outfile) else None
284    except Exception as exc:
285        print(f"❌ Edge TTS の音声生成に失敗しました: {exc}")
286        return None
287
288
289def speak_dialogue(dialogue, replacements, target_voices, speakers=None,
290                   temp_dir=None, outfile=None, ext="mp3", cfg=None):
291    """対話スクリプトの全セグメントをEdge TTSで合成し、一時的なMP3ファイルのパスのリストを返します。
292
293    詳細説明:
294    `tktts_base.split_dialogue` を使用して対話をスピーカーとテキストのセグメントに分割します。
295    各セグメントに対して、テキスト置換を適用し、適切な音声を選択して `speak` 関数で音声ファイルを生成します。
296    `cfg` オブジェクトからプロソディ設定(rate, volume, pitch)が取得され適用されます。
297    一時ファイルは `temp_dir` に保存され、そのパスのリストが返されます。
298
299    :param dialogue: 合成する対話セグメントのリスト。各要素は文字列またはタプルです。
300    :type dialogue: `list`
301    :param replacements: テキスト置換ルールを定義する辞書。`{元文字列: 置換文字列}` の形式。
302    :type replacements: `dict`
303    :param target_voices: スピーカー名と対応する音声名のマッピング、またはデフォルトの音声名。
304    :type target_voices: `dict` or `str`
305    :param speakers: (オプション) スピーカー設定の辞書。デフォルトは空の辞書。
306    :type speakers: `dict` or `None`
307    :param temp_dir: (オプション) 一時ファイルを保存するディレクトリ。指定しない場合はカレントディレクトリ。
308    :type temp_dir: `str` or `None`
309    :param outfile: (無視される) `tktts.py` でファイル結合が処理されるため、この引数は使用されません。
310    :type outfile: `str` or `None`
311    :param ext: (オプション) 出力する一時音声ファイルの拡張子(デフォルトは"mp3")。
312    :type ext: `str`
313    :param cfg: (オプション) `tktts` の設定オブジェクト。プロソディ設定(`edge_rate`, `edge_volume`, `edge_pitch`)が含まれる場合がある。
314    :type cfg: `object` or `None`
315    :returns: (成功フラグ, 一時ファイルパスのリスト)。成功フラグは全セグメントの合成に成功した場合はTrue、失敗した場合はFalse。
316    :rtype: `tuple[bool, list[str]]`
317    """
318    del outfile  # File assembly is centrally handled by tktts.py.
319    speakers = speakers or {}
320    tmpfiles = []
321    rate = _normalize_prosody(getattr(cfg, "edge_rate", "+0%"))
322    volume = _normalize_prosody(getattr(cfg, "edge_volume", "+0%"))
323    pitch = _normalize_prosody(getattr(cfg, "edge_pitch", "+0Hz"), "+0Hz")
324
325    print("\ntktts_edge.speak_dialogue():")
326    index = 1
327    for i, item in enumerate(dialogue or []):
328        print(f"\nDialogue {i:04d}:")
329        parts = split_dialogue(
330            item,
331            target_voices,
332            speakers=speakers,
333            default_voice=DEFAULT_EDGE_VOICE,
334            is_monologue=bool(getattr(cfg, "monologue", False)),
335        )
336        for speaker, text in parts:
337            text = apply_replacements(text, replacements)
338            if not str(text).strip():
339                continue
340            voice = _select_voice(target_voices, speaker)
341            filename = f"tmp_{index:03d}.{ext}"
342            tmpfile = os.path.join(temp_dir, filename) if temp_dir else filename
343            print(f"  {index:04d}: speaker={speaker} (voice={voice}): {text}")
344            if speak(tmpfile, text, voice, rate=rate, volume=volume, pitch=pitch) is None:
345                return False, tmpfiles
346            tmpfiles.append(tmpfile)
347            index += 1
348
349    return True, tmpfiles