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

sample_edge_tts.py をダウンロード

sample_edge_tts.py
sample_edge_tts.py
  1#!/usr/bin/env python3
  2# -*- coding: utf-8 -*-
  3
  4"""
  5Edge TTS (Text-to-Speech) ユーティリティスクリプト。
  6
  7Edge TTS (Text-to-Speech) を利用してテキストを読み上げたり、
  8利用可能な音声リストを表示したりするコマンドラインユーティリティです。
  9
 10コマンドライン引数 ``input`` でテキストまたはファイルパスを指定し、
 11``--mode read`` (デフォルト) で読み上げを行います。
 12``--mode list`` を指定すると、利用可能な音声の一覧を表示します。
 13``--voices`` と ``--lang`` オプションで音声リストをフィルタリングできます。
 14
 15:doc:`sample_edge_tts_usage`
 16"""
 17
 18import argparse
 19import asyncio
 20import os
 21import subprocess
 22import sys
 23import tempfile
 24from typing import List, Dict, Any, Optional
 25
 26import edge_tts
 27
 28
 29DEFAULT_VOICE = "Nanami"
 30
 31
 32def parse_args() -> argparse.Namespace:
 33    """
 34    コマンドライン引数をパースする。
 35
 36    `argparse` モジュールを使用して、入力テキスト/ファイル、動作モード(`read`または`list`)、
 37    音声フィルター、言語フィルターなどのコマンドライン引数を定義し、パースします。
 38
 39    :returns: `argparse.Namespace` -- パースされた引数を含むオブジェクト。
 40    """
 41    parser = argparse.ArgumentParser(
 42        description="Edge TTS Utility"
 43    )
 44
 45    parser.add_argument(
 46        "input",
 47        nargs="?",
 48        help="Text or filename"
 49    )
 50
 51    parser.add_argument(
 52        "--mode",
 53        default="read",
 54        choices=["read", "list"],
 55        help="Operation mode"
 56    )
 57
 58    parser.add_argument(
 59        "--voices",
 60        help="Voice filter or voice name"
 61    )
 62
 63    parser.add_argument(
 64        "--lang",
 65        help="Language filter (ja, en, en-gb, fr-CH, ch ...)"
 66    )
 67
 68    return parser.parse_args()
 69
 70
 71async def get_voice_list() -> List[Dict[str, Any]]:
 72    """
 73    Edge TTSで利用可能な音声のリストを取得する。
 74
 75    `edge_tts.list_voices()` を非同期で呼び出し、
 76    利用可能な全ての音声の詳細情報を含むリストを返します。
 77    各音声は、`ShortName`, `Locale`, `Gender` などの情報を持つ辞書として表現されます。
 78
 79    :returns: `list[dict]` -- 各要素が音声の詳細情報を持つ辞書であるリスト。
 80    """
 81    return await edge_tts.list_voices()
 82
 83
 84def match_lang(locale: str, lang_filter: Optional[str]) -> bool:
 85    """
 86    指定されたロケールが言語フィルターに一致するかを判定する。
 87
 88    ロケール文字列を小文字に変換し、言語フィルターを `-` または `_` で分割したトークンが
 89    ロケールに含まれるかをチェックします。フィルターが指定されていない場合は常に `True` を返します。
 90    例えば、`locale="ja-JP"`, `lang_filter="ja"` の場合、`True` を返します。
 91
 92    :param locale: `str` -- 比較対象のロケール文字列(例: "ja-JP")。
 93    :param lang_filter: `Optional[str]` -- 適用する言語フィルター文字列(例: "ja", "en-us")。`None` の場合はフィルターなし。
 94    :returns: `bool` -- ロケールがフィルターに一致すれば `True`、そうでなければ `False`。
 95    """
 96    if not lang_filter:
 97        return True
 98
 99    locale = locale.lower()
100
101    tokens = [
102        token.strip().lower()
103        for token in lang_filter.replace("_", "-").split("-")
104        if token.strip()
105    ]
106
107    return all(token in locale for token in tokens)
108
109
110def match_voice(short_name: str, voice_filter: Optional[str]) -> bool:
111    """
112    指定された音声の短い名前が音声フィルターに一致するかを判定する。
113
114    音声の短い名前と音声フィルターを小文字に変換し、フィルターが短い名前に含まれるかをチェックします。
115    フィルターが指定されていない場合は常に `True` を返します。
116    例えば、`short_name="ja-JP-NanamiNeural"`, `voice_filter="nanami"` の場合、`True` を返します。
117
118    :param short_name: `str` -- 比較対象の音声の短い名前(例: "ja-JP-NanamiNeural")。
119    :param voice_filter: `Optional[str]` -- 適用する音声フィルター文字列(例: "nanami")。`None` の場合はフィルターなし。
120    :returns: `bool` -- 音声がフィルターに一致すれば `True`、そうでなければ `False`。
121    """
122    if not voice_filter:
123        return True
124
125    return voice_filter.lower() in short_name.lower()
126
127
128async def list_mode(lang_filter: Optional[str] = None, voice_filter: Optional[str] = None) -> None:
129    """
130    利用可能な音声のリストを表示する。
131
132    `get_voice_list` で取得した音声リストを、言語フィルターと音声フィルターで絞り込み、
133    整形してコンソールに出力します。各音声の`ShortName`、`Locale`、`Gender`が表示され、
134    最終的に結果の音声数も表示されます。
135
136    :param lang_filter: `Optional[str]` -- 音声リストを絞り込むための言語フィルター。
137    :param voice_filter: `Optional[str]` -- 音声リストを絞り込むための音声フィルター。
138    :returns: `None`
139    """
140    voices = await get_voice_list()
141
142    count = 0
143
144    for voice in sorted(
145        voices,
146        key=lambda x: x["ShortName"]
147    ):
148
149        short_name = voice["ShortName"]
150        locale = voice["Locale"]
151        gender = voice.get("Gender", "")
152
153        if not match_lang(locale, lang_filter):
154            continue
155
156        if not match_voice(short_name, voice_filter):
157            continue
158
159        print(
160            f"{short_name:40s} "
161            f"{locale:10s} "
162            f"{gender}"
163        )
164
165        count += 1
166
167    print(f"\n{count} voice(s).")
168
169
170async def find_voice(keyword: str) -> str:
171    """
172    キーワードに基づいて最適な音声を見つける。
173
174    指定されたキーワードを使って、利用可能な音声の中から最適なものを検索し、その `ShortName` を返します。
175    検索は以下の優先順位で行われます。
176
177    1.  キーワードに完全に一致する音声。
178    2.  キーワードが部分的に含まれる音声。
179    3.  `"Nanami"` を含む音声(デフォルトの候補)。
180    4.  日本語の女性音声。
181    5.  利用可能な音声リストの最初の音声(最終保険)。
182
183    :param keyword: `str` -- 検索する音声のキーワード。
184    :returns: `str` -- 見つかった音声の `ShortName`。
185    """
186    voices = await get_voice_list()
187
188    #
189    # 完全一致
190    #
191    for voice in voices:
192
193        if keyword.lower() == voice["ShortName"].lower():
194            return voice["ShortName"]
195
196    #
197    # 部分一致
198    #
199    for voice in voices:
200
201        if keyword.lower() in voice["ShortName"].lower():
202            return voice["ShortName"]
203
204    #
205    # Nanami
206    #
207    for voice in voices:
208
209        if "nanami" in voice["ShortName"].lower():
210            return voice["ShortName"]
211
212    #
213    # 日本語女性音声
214    #
215    for voice in voices:
216
217        if (
218            voice["Locale"].lower().startswith("ja")
219            and voice.get("Gender") == "Female"
220        ):
221            return voice["ShortName"]
222
223    #
224    # 最終保険
225    #
226    return voices[0]["ShortName"]
227
228
229def load_text(arg: Optional[str]) -> str:
230    """
231    引数からテキストコンテンツを読み込む。
232
233    引数がファイルパスであれば、そのファイルをUTF-8エンコーディングで読み込み、内容を返します。
234    引数がファイルパスでなければ、それをそのままテキストとして返します。
235    引数が `None` の場合は `ValueError` を発生させます。
236
237    :param arg: `Optional[str]` -- テキスト内容、またはテキストファイルのパス。
238    :returns: `str` -- 読み込まれたテキストコンテンツ。
239    :raises ValueError: `arg` が `None` の場合。
240    """
241    if arg is None:
242
243        raise ValueError(
244            "Text or filename must be specified."
245        )
246
247    if os.path.isfile(arg):
248
249        with open(
250            arg,
251            "r",
252            encoding="utf-8"
253        ) as f:
254
255            return f.read()
256
257    return arg
258
259
260async def read_mode(text: str, voice_keyword: str) -> None:
261    """
262    指定されたテキストを読み上げ、オーディオファイルとして保存・再生する。
263
264    `find_voice` を使って最適な音声を選択します。
265    `edge_tts.Communicate` を使用してテキストを音声合成し、一時ファイルにMP3として保存します。
266    生成されたオーディオファイルは、実行環境のOSに応じて適切なコマンド
267    (`os.startfile` (Windows), `open` (macOS), `xdg-open` (Linux)) で自動的に再生されます。
268
269    :param text: `str` -- 読み上げるテキストコンテンツ。
270    :param voice_keyword: `str` -- 音声を選択するためのキーワード。
271    :returns: `None`
272    """
273    voice = await find_voice(voice_keyword)
274
275    print(f"Voice : {voice}")
276
277    output_file = os.path.join(
278        tempfile.gettempdir(),
279        "edge_tts_output.mp3"
280    )
281
282    communicate = edge_tts.Communicate(
283        text=text,
284        voice=voice
285    )
286
287    await communicate.save(output_file)
288
289    print(f"Output: {output_file}")
290
291    if sys.platform.startswith("win"):
292
293        os.startfile(output_file)
294
295    elif sys.platform == "darwin":
296
297        subprocess.run(
298            ["open", output_file],
299            check=False
300        )
301
302    else:
303
304        subprocess.run(
305            ["xdg-open", output_file],
306            check=False
307        )
308
309
310async def main() -> None:
311    """
312    スクリプトのメインエントリポイント。
313
314    `parse_args` を呼び出してコマンドライン引数を処理します。
315    引数の `mode` に応じて `list_mode` (音声リスト表示) または `read_mode` (テキスト読み上げ) を呼び出します。
316    `read` モードの場合、入力テキストの読み込みと音声選択のロジックも実行します。
317
318    :returns: `None`
319    """
320    args = parse_args()
321
322    #
323    # list
324    #
325    if args.mode == "list":
326
327        await list_mode(
328            lang_filter=args.lang,
329            voice_filter=args.voices
330        )
331
332        return
333
334    #
335    # read
336    #
337    voice_keyword = (
338        args.voices
339        if args.voices
340        else DEFAULT_VOICE
341    )
342
343    text = load_text(args.input)
344
345    await read_mode(
346        text=text,
347        voice_keyword=voice_keyword
348    )
349
350
351if __name__ == "__main__":
352
353    asyncio.run(main())