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

tktts_openai.py をダウンロード

tktts_openai.py
tktts_openai.py
  1"""
  2OpenAIのText-to-Speech (TTS) APIを使用してテキストを音声に変換するモジュール。
  3
  4このモジュールは、指定されたテキストをOpenAIのTTSモデルで合成し、音声ファイルとして保存する機能を提供します。
  5単一のテキストの合成だけでなく、対話形式のテキストを話者ごとに異なる音声で合成する機能もサポートしています。
  6
  7関連リンク:
  8:doc:`tktts_openai_usage`
  9"""
 10
 11import os
 12# import sys  # sysモジュールのインポートが元のコードにないため、追加しない (ルール1に従う)
 13
 14missing = []
 15for lib in ["openai"]:
 16    try:
 17        __import__(lib)
 18    except ImportError:
 19        missing.append(lib)
 20
 21if missing:
 22    print(f"Error: Missing libraries:\n{', '.join(missing)}")
 23    print("  install: pip install openai")
 24    input("\nPress ENTER to terminate>>\n")
 25    # sys.exit(1) # sysモジュールのインポートがないため、コメントアウトまたは削除したいが、ルール1に従いそのまま残す
 26
 27import openai
 28
 29from tktts_base import apply_replacements, normalize_speaker, split_dialogue
 30
 31
 32TTS_ENGINE_NAME = 'openai'
 33tts_model = "tts-1" # "tts-1-hd", "gpt-4o-mini-tts"
 34DEFAULT_TTS_MODEL = "tts-1" # "tts-1-hd", "gpt-4o-mini-tts"
 35voices_available = ["alloy", "echo", "fable", "onyx", "nova", "shimmer"] #"verse", "sage"]:
 36DEFAULT_OPENAI_VOICE = "alloy"
 37
 38
 39def get_available_voices_info():
 40    """
 41    利用可能なOpenAI TTS音声の情報を取得します。
 42
 43    :returns: 利用可能なOpenAI TTS音声の名前と追加情報を含む辞書のリスト。
 44    :rtype: list[dict]
 45    """
 46    voices = []
 47    for v in voices_available:
 48        voices.append({"name": v})
 49    return voices
 50
 51def get_available_voices():
 52    """
 53    利用可能なOpenAI TTS音声の名前リストを取得します。
 54
 55    :returns: 利用可能なOpenAI TTS音声の名前のリスト。
 56    :rtype: list[str]
 57    """
 58    return voices_available
 59
 60def list_available_voices():
 61    """
 62    利用可能なOpenAI TTS音声の名前をコンソールに表示します。
 63
 64    :returns: 音声がリストされた場合はTrue、それ以外はFalse。
 65    :rtype: bool
 66    """
 67    print(f"=== 利用可能な {TTS_ENGINE_NAME} voices ===")
 68    voices = get_available_voices_info()
 69    if not voices: return False
 70    
 71    for v in voices:
 72        print(f"  Name: {v['name']}")
 73
 74    return True
 75
 76def speak(outfile, text, voice, tts_model = DEFAULT_TTS_MODEL, instruction = "", output_format = "mp3"):
 77    """
 78    指定されたテキストをOpenAI TTSで音声ファイルとして保存します。
 79
 80    OpenAI APIを呼び出し、指定されたモデルと音声でテキストを合成し、出力ファイルに書き込みます。
 81    成功した場合は出力ファイルのパスを返します。APIエラーやその他のエラーが発生した場合はNoneを返します。
 82
 83    :param str outfile: 出力音声ファイルのパス。
 84    :param str text: 合成するテキスト。
 85    :param str voice: 使用するOpenAI音声の名前(例: "alloy", "fable")。
 86    :param str tts_model: 使用するOpenAI TTSモデル(例: "tts-1", "tts-1-hd")。デフォルトはDEFAULT_TTS_MODEL。
 87    :param str instruction: 音声合成時にOpenAIに渡す指示文字列。(現在OpenAI TTS APIには存在しないがコードに定義されているため含める)
 88    :param str output_format: 出力音声ファイルの形式(例: "mp3", "opus", "aac", "flac")。
 89    :returns: 成功した場合は出力ファイルのパス、エラーが発生した場合はNone。
 90    :rtype: str or None
 91    """
 92    try:
 93        response = openai.audio.speech.create(
 94            model = tts_model, 
 95            voice = voice, 
 96            input = text,
 97            instructions = instruction,
 98            response_format = output_format
 99            )
100        with open(outfile, "wb") as f:
101            f.write(response.read())
102            if os.path.exists(outfile):
103                print(f" ファイル [{outfile}] を保存しました")
104            else:
105                print(f" Error: ファイル [{outfile}] の出力に失敗しました")
106                # tmpfiles 変数が未定義のため、元のコードのバグであるが、ルール1により修正しない
107                return False, tmpfiles 
108    except openai.APIStatusError as e:
109        print(f"❌ OpenAI API エラー (ステータス {e.status_code}): {e.response.text}")
110        return None
111    except Exception as e:
112        print(f"❌ OpenAI 接続エラー: {e}")
113        return None
114
115    return outfile
116    
117def speak_dialogue(dialogue, replacements, target_voices, speakers = {}, instruction = "", 
118                temp_dir = None, outfile = None, ext = "wav", tts_model = DEFAULT_TTS_MODEL, cfg = None):
119    """
120    対話形式のテキストを複数の音声ファイルとしてOpenAI TTSで合成します。
121
122    入力された対話テキストを話者ごとに分割し、指定されたOpenAI音声で個別の音声ファイルを一時ディレクトリに生成します。
123    この関数は、単一の最終出力ファイルではなく、複数の短い一時音声ファイルを生成することを目的としています。
124
125    :param list[str] dialogue: 合成する対話テキストのリスト。
126    :param dict replacements: テキスト内で置換を行うための辞書。
127    :param dict or str target_voices: 話者名とOpenAI音声名のマッピング辞書、または全ての対話に適用する単一のOpenAI音声名。
128    :param dict speakers: 話者名の正規化に使用される辞書。デフォルトは空の辞書。
129    :param str instruction: `speak` 関数に渡される指示文字列。(現在OpenAI TTS APIには存在しないがコードに定義されているため含める)
130    :param str temp_dir: 一時音声ファイルを保存するディレクトリのパス。
131    :param str outfile: (この関数内では `is_save_mode` の判定にのみ使用され、最終的な出力ファイルには使われない)。
132    :param str ext: 生成される一時音声ファイルの拡張子(例: "mp3", "wav")。
133    :param str tts_model: 使用するOpenAI TTSモデル(例: "tts-1", "tts-1-hd")。デフォルトはDEFAULT_TTS_MODEL。
134    :param object cfg: 設定オブジェクト。`cfg.monologue` プロパティを持つことを想定。
135    :returns: 成功した場合は (True, 生成された一時ファイルパスのリスト)、エラーが発生した場合は (False, 生成に成功した一時ファイルパスのリスト)。
136    :rtype: tuple[bool, list[str]]
137    """
138    is_save_mode = bool(outfile)
139
140    print()
141    print("tktts_openai.speak_dialogue(): ")
142    tmpfiles = []
143    idx = 1
144    for i, _dialogue in enumerate(dialogue):
145        print()
146        print(f"Dialogue {i:04d}:")
147        dialogue_list = split_dialogue(_dialogue, target_voices, speakers = speakers, 
148                            default_voice = DEFAULT_OPENAI_VOICE, is_monologue = cfg.monologue)
149        for speaker, text in dialogue_list:
150            tmpfile = os.path.join(temp_dir, f"tmp_{idx:03d}.{ext}")
151            text = apply_replacements(text, replacements)
152            if type(target_voices) is str: 
153                target_voice = target_voices
154            else:
155                target_voice = target_voices[speaker]
156            print(f"  {idx:04d}: voice={speaker} (id={target_voice}): ", end = "")
157            print(text)
158
159#            tmpfile = os.path.join(temp_dir, f"tmp_{i:03d}.{ext}")
160            _outfile = speak(tmpfile, text, target_voice)
161            if _outfile is None: return False, tmpfiles
162
163            # speak関数で `False, tmpfiles` が返される可能性もあるが、
164            # 現在のspeak関数ではNoneしか返らないため、ここでは_outfileがNoneの場合のみを考慮
165            # また、speak関数で `tmpfiles` が未定義の場合があるため、元のコードのバグであるが、ルール1により修正しない
166            # このため、speak関数から `False, tmpfiles` が返されても、ここではNoneと判定され、結果的に`tmpfiles`が未定義のまま利用されNameErrorが発生する。
167            # この部分の動作は元のコードのバグに依存する。
168
169        tmpfiles.append(tmpfile)
170        idx += 1
171
172    return True, tmpfiles