sample_edge_tts.py ドキュメント

プログラムの動作

sample_edge_tts.py は、Microsoft EdgeのText-to-Speech (TTS) サービスを利用して、テキストを音声に変換し再生する、または利用可能な音声リストを表示するPythonユーティリティです。

本プログラムの主な機能は以下の2つのモードに分けられます。

  1. 読み上げ (read) モード: 指定されたテキスト(コマンドライン引数またはファイルから読み込み)を音声に変換し、MP3ファイルとして一時ディレクトリに保存後、オペレーティングシステム標準のプレイヤーで自動再生します。音声は自動的に選択されますが、--voices オプションで特定の音声を指定することも可能です。

  2. 音声リスト表示 (list) モード: Edge TTSで利用可能なすべての音声のリストを表示します。--lang および --voices オプションを使用して、特定の言語や音声名でフィルタリングできます。

このプログラムは、手軽に高品質なテキスト読み上げ音声を利用したい、または利用可能な音声の一覧を確認したいというニーズに応えます。

原理

本プログラムは、Pythonの edge_tts ライブラリを介してMicrosoft EdgeのText-to-Speechサービスと通信します。非同期処理には asyncio ライブラリが使用されています。

音声の選択アルゴリズム (find_voice 関数)

read モードで音声が明示的に指定されない場合、または指定された音声が見つからない場合、以下の優先順位で最適な音声が自動的に選択されます。

  1. 完全一致: 指定されたキーワードと音声の ShortName が大文字小文字を区別せず完全に一致するものを探します。

  2. 部分一致: 指定されたキーワードが音声の ShortName のどこかに大文字小文字を区別せず含まれるものを探します。

  3. 「Nanami」の検索: ShortName に「nanami」を含む音声(通常は日本語の女性音声)を探します。

  4. 日本語女性音声の検索: Locale が「ja」で始まり、かつ Gender が「Female」である音声を探します。

  5. 最終保険: 上記のいずれにも該当しない場合、利用可能な音声リストの最初の音声を選択します。

音声リストのフィルタリングアルゴリズム (list_mode, match_lang, match_voice 関数)

list モードでは、利用可能な音声リストを以下のロジックでフィルタリングします。

  • 言語フィルタリング (match_lang):

    • --lang オプションで指定された言語フィルター(例: ja, en-gb)は、ハイフン (-) またはアンダースコア (_) で区切られたトークンに分割されます。

    • 音声の Locale (例: ja-JP) が、フィルターのすべてのトークンを大文字小文字を区別せずに含んでいる場合にマッチします。 例: フィルターが en-gb の場合、Locale が en-GB の音声にマッチします。

  • 音声名フィルタリング (match_voice):

    • --voices オプションで指定された音声フィルターが、音声の ShortName (例: ja-JP-NanamiNeural) のどこかに大文字小文字を区別せずに含まれている場合にマッチします。

音声の再生

生成されたMP3音声ファイルは、一時ディレクトリに保存されます。その後、オペレーティングシステムに応じたコマンドを使用して自動的に再生されます。

  • Windows: os.startfile(output_file)

  • macOS: subprocess.run(["open", output_file])

  • Linux: subprocess.run(["xdg-open", output_file])

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

本プログラムは、edge_tts ライブラリに依存しています。 以下のコマンドでインストールできます。

pip install edge_tts

必要な入力ファイル

read モードでテキストファイルを指定する場合、以下の形式が期待されます。

  • ファイル形式: UTF-8でエンコードされたプレーンテキストファイル

  • データ構造: 特に規定はありません。ファイル内の全てのテキストが読み上げの対象となります。

テキストファイルを指定しない場合は、コマンドライン引数として直接テキスト文字列を渡すことも可能です。

生成される出力ファイル

read モードでテキストを読み上げる際に、以下の出力ファイルが生成されます。

  • ファイル名: edge_tts_output.mp3

  • 保存場所: オペレーティングシステムの一時ディレクトリに保存されます。

    • Windows: 通常 %TEMP% ディレクトリ (例: C:\Users\<UserName>\AppData\Local\Temp)

    • macOS/Linux: 通常 /tmp ディレクトリ

  • 内容: 指定されたテキストが edge_tts サービスによって変換された音声データ(MP3形式)。

生成後、このファイルは自動的にシステムのメディアプレイヤーで開かれ再生されます。

コマンドラインでの使用例 (Usage)

sample_edge_tts.py は、以下の形式で実行できます。

python sample_edge_tts.py [input] [--mode {read,list}] [--voices VOICES] [--lang LANG]
  • [input]:

    • 読み上げたいテキスト文字列、またはテキストが記述されたファイルへのパス。

    • read モードの場合のみ有効。省略された場合、エラーとなります。

  • --mode {read,list}:

    • 実行モードを指定します。

      • read: テキストを読み上げます (デフォルト)。

      • list: 利用可能な音声のリストを表示します。

  • --voices VOICES:

    • read モードの場合: 読み上げに使用する音声のキーワードまたは完全な名前。

    • list モードの場合: 表示する音声をフィルタリングするためのキーワード。

  • --lang LANG:

    • list モードの場合: 表示する音声を言語でフィルタリングします (例: ja, en-gb, fr-CH)。

ヘルプメッセージを表示するには、以下のコマンドを実行します。

python sample_edge_tts.py --help

コマンドラインでの具体的な使用例

1. 利用可能な音声のリストを表示する

すべての利用可能な音声をリスト表示します。

python sample_edge_tts.py --mode list

実行結果: Edge TTSで利用可能なすべての音声が、ShortName、Locale、Gender の順に表示されます。末尾に音声の総数が表示されます。

en-US-JennyNeural                         en-US      Female
en-US-GuyNeural                           en-US      Male
ja-JP-NanamiNeural                        ja-JP      Female
... (多数の音声が続く) ...

XXX voice(s).

2. 特定の言語の音声のみをリスト表示する

日本語の音声のみをリスト表示します。

python sample_edge_tts.py --mode list --lang ja

実行結果: Locale が「ja」で始まる音声のみがフィルタリングされて表示されます。

ja-JP-AoiNeural                           ja-JP      Female
ja-JP-DaichiNeural                        ja-JP      Male
ja-JP-NanamiNeural                        ja-JP      Female
...

X voice(s).

3. 特定のキーワードを含む音声をリスト表示する

「Nanami」というキーワードを含む音声のみをリスト表示します。

python sample_edge_tts.py --mode list --voices Nanami

実行結果: ShortName に「Nanami」が含まれる音声のみがフィルタリングされて表示されます。

ja-JP-NanamiNeural                        ja-JP      Female

1 voice(s).

4. テキストをデフォルト音声で読み上げる

指定されたテキストを、システムが自動選択またはデフォルト(「Nanami」)の音声で読み上げます。

python sample_edge_tts.py "こんにちは、世界。これはテストです。"

実行結果: 「Voice : ja-JP-NanamiNeural」のようなメッセージと、一時ファイルパスが表示され、テキストが音声に変換されてシステムの一時ディレクトリに edge_tts_output.mp3 として保存され、その後自動的に再生されます。

Voice : ja-JP-NanamiNeural
Output: /tmp/edge_tts_output.mp3

(パスはOSによって異なります)

5. 特定の音声でテキストを読み上げる

ja-JP-AoiNeural という音声を使用してテキストを読み上げます。

python sample_edge_tts.py "これはAoiさんの声でのテストです。" --voices 'ja-JP-AoiNeural'

実行結果: 「Voice : ja-JP-AoiNeural」と表示され、指定された音声でテキストが読み上げられ、MP3ファイルが自動再生されます。

Voice : ja-JP-AoiNeural
Output: /tmp/edge_tts_output.mp3

(パスはOSによって異なります)

6. ファイルからテキストを読み上げる

まず、test.txt という名前のファイルを作成し、以下の内容を記述します。

test.txt の内容:

ファイルから読み込んだテキストをテストします。
これはPythonプログラムによる音声合成の例です。

次に、このファイルを指定してプログラムを実行します。

python sample_edge_tts.py test.txt

実行結果: 「Voice : ja-JP-NanamiNeural」のようなメッセージが表示され、test.txt の内容が音声に変換されてMP3ファイルが自動再生されます。

Voice : ja-JP-NanamiNeural
Output: /tmp/edge_tts_output.mp3

(パスはOSによって異なります)