默认情况下，docker compose up --build 会创建一个不包含 ffmpeg 的最小镜像。如果您是在本地构建（克隆此仓库后），并且需要 ffmpeg 进行除 MP3 外的其他音频格式转换，可以在构建过程中将其包含进来。

这由 INSTALL_FFMPEG_ARG 构建参数控制。您可以通过以下任一方式将此环境变量设置为 true：

1. 在命令前添加：

   INSTALL_FFMPEG_ARG=true docker compose up --build
   

2. 添加到您的 .env 文件中： 将以下行添加到项目根目录下的 .env 文件中：

   INSTALL_FFMPEG_ARG=true
   

   然后运行 docker compose up --build。
3. 在您的 shell 环境中导出： 将 export INSTALL_FFMPEG_ARG=true 添加到您的 shell 配置文件（例如 ~/.zshrc、~/.bashrc），并重新加载 shell。然后 docker compose up --build 将会使用该设置。

以上适用于本地构建。对于预构建的 Docker Hub 镜像，请在版本号后添加 latest-ffmpeg 标签：

docker run -d -p 5050:5050 -e API_KEY=your_api_key_here -e PORT=5050 travisvn/openai-edge-tts:latest-ffmpeg

如果您更倾向于直接使用 Python 运行该项目，可以按照以下步骤设置虚拟环境、安装依赖项并启动服务器。

1. 克隆仓库

git clone https://github.com/travisvn/openai-edge-tts.git
cd openai-edge-tts

2. 设置虚拟环境

创建并激活虚拟环境以隔离依赖项：

# 对于 macOS/Linux
python3 -m venv venv
source venv/bin/activate

# 对于 Windows
python -m venv venv
venv\Scripts\activate

3. 安装依赖项

使用 pip 安装 requirements.txt 中列出的所需包：

pip install -r requirements.txt

4. 配置环境变量

在根目录下创建一个 .env 文件，并设置以下变量：

API_KEY=your_api_key_here
PORT=5050

DEFAULT_VOICE=en-US-AvaNeural
DEFAULT_RESPONSE_FORMAT=mp3
DEFAULT_SPEED=1.0

DEFAULT_LANGUAGE=en-US

REQUIRE_API_KEY=True
REMOVE_FILTER=False
EXPAND_API=True
DETAILED_ERROR_LOGGING=True

5. 启动服务器

配置完成后，使用以下命令启动服务器：

python app/server.py

服务器将在 http://localhost:5050 上开始运行。

6. 测试 API

现在您可以通过 http://localhost:5050/v1/audio/speech 及其他可用端点与 API 交互。请参阅【使用说明】部分获取请求示例。

端点：/v1/audio/speech

根据输入文本生成音频。可用参数如下：

必填参数：

• input（字符串）：要转换为音频的文本（最多 4096 个字符）。

可选参数：

• model（字符串）：设置为 "tts-1" 或 "tts-1-hd"（默认值为 "tts-1"）。
• voice（字符串）：OpenAI 兼容的语音之一（alloy、echo、fable、onyx、nova、shimmer），或任何有效的 edge-tts 语音（默认值为 "en-US-AvaNeural"）。
• response_format（字符串）：音频格式。选项包括：mp3、opus、aac、flac、wav、pcm（默认值为 mp3）。
• speed（数字）：播放速度（0.25 至 4.0）。默认值为 1.0。
• stream_format（字符串）：响应格式。选项有 "audio"（原始音频数据，默认）或 "sse"（使用 JSON 事件的 Server-Sent Events 流式传输）。

注意：该 API 完全兼容 OpenAI 的 TTS API 规范。目前不支持 instructions 参数（用于微调语音特征），但其他所有参数与 OpenAI 的实现完全一致。

标准音频生成

使用 curl 发送请求并将输出保存为 mp3 文件的示例：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key_here" \
  -d '{
    "input": "你好，我是你的 AI 助手！请告诉我如何帮助你将想法变为现实。",
    "voice": "echo",
    "response_format": "mp3",
    "speed": 1.1
  }' \
  --output speech.mp3

直接音频播放（类似 OpenAI）

你可以将音频直接通过管道传递给 ffplay 进行即时播放，就像 OpenAI 的 API 一样：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tts-1",
    "input": "今天是创造人们喜爱事物的美好一天！",
    "voice": "alloy",
    "response_format": "mp3"
  }' | ffplay -i -

或者，无需保存到文件即可立即播放：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "input": "这将立即播放，不会保存到磁盘！",
    "voice": "shimmer"
  }' | ffplay -autoexit -nodisp -i -

或者，为了与 OpenAI API 端点参数保持一致：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key_here" \
  -d '{
    "model": "tts-1",
    "input": "你好，我是你的 AI 助手！请告诉我如何帮助你将想法变为现实。",
    "voice": "alloy"
  }' \
  --output speech.mp3

Server-Sent Events (SSE) 流式传输

对于需要结构化流式事件的应用程序（如 Web 应用程序），可以使用 SSE 格式：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key_here" \
  -d '{
    "model": "tts-1",
    "input": "这将以 Server-Sent Events 的形式进行流式传输，JSON 数据包含 base64 编码的音频片段。",
    "voice": "alloy",
    "stream_format": "sse"
  }'

SSE 响应格式：

data: {"type": "speech.audio.delta", "audio": "base64-encoded-audio-chunk"}

data: {"type": "speech.audio.delta", "audio": "base64-encoded-audio-chunk"}

data: {"type": "speech.audio.done", "usage": {"input_tokens": 12, "output_tokens": 0, "total_tokens": 12}}

JavaScript/Web 使用

使用 fetch API 进行 SSE 流式传输的示例：

async function streamTTSWithSSE(text) {
  const response = await fetch('http://localhost:5050/v1/audio/speech', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer your_api_key_here',
    },
    body: JSON.stringify({
      input: text,
      voice: 'alloy',
      stream_format: 'sse',
    }),
  });

  const reader = response.body.getReader();
  const decoder = new TextDecoder();
  const audioChunks = [];

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;

    const chunk = decoder.decode(value);
    const lines = chunk.split('\n');

    for (const line of lines) {
      if (line.startsWith('data: ')) {
        const data = JSON.parse(line.slice(6));

        if (data.type === 'speech.audio.delta') {
          // 解码 base64 编码的音频片段
          const audioData = atob(data.audio);
          const audioArray = new Uint8Array(audioData.length);
          for (let i = 0; i < audioData.length; i++) {
            audioArray[i] = audioData.charCodeAt(i);
          }
          audioChunks.push(audioArray);
        } else if (data.type === 'speech.audio.done') {
          console.log('语音合成完成：', data.usage);

          // 将所有音频片段合并并播放
          const totalLength = audioChunks.reduce(
            (sum, chunk) => sum + chunk.length,
            0
          );
          const combinedArray = new Uint8Array(totalLength);
          let offset = 0;
          for (const chunk of audioChunks) {
            combinedArray.set(chunk, offset);
            offset += chunk.length;
          }

          const audioBlob = new Blob([combinedArray], { type: 'audio/mpeg' });
          const audioUrl = URL.createObjectURL(audioBlob);
          const audio = new Audio(audioUrl);
          audio.play();
          return;
        }
      }
    }
  }
}

// 使用
streamTTSWithSSE('来自 SSE 流式传输的问候！');

国际语言示例

以下是一个非英语语言的示例：

curl -X POST http://localhost:5050/v1/audio/speech \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer your_api_key_here" \
  -d '{
    "model": "tts-1",
    "input": "じゃあ、行く。電車の時間、調べておくよ。",
    "voice": "ja-JP-KeitaNeural"
  }' \
  --output speech.mp3

JavaScript/Web 使用

使用 fetch API 进行 SSE 流式传输的示例：

async function streamTTSWithSSE(text) {
  const response = await fetch('http://localhost:5050/v1/audio/speech', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      Authorization: 'Bearer your_api_key_here',
    },
    body: JSON.stringify({
      input: text,
      voice: 'alloy',
      stream_format: 'sse',
    }),
  });

  const reader = response.body.getReader();
  const decoder = new TextDecoder();
  const audioChunks = [];

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;

    const chunk = decoder.decode(value);
    const lines = chunk.split('\n');

    for (const line of lines) {
      if (line.startsWith('data: ')) {
        const data = JSON.parse(line.slice(6));

        if (data.type === 'speech.audio.delta') {
          // 解码 base64 编码的音频片段
          const audioData = atob(data.audio);
          const audioArray = new Uint8Array(audioData.length);
          for (let i = 0; i < audioData.length; i++) {
            audioArray[i] = audioData.charCodeAt(i);
          }
          audioChunks.push(audioArray);
        } else if (data.type === 'speech.audio.done') {
          console.log('语音合成完成：', data.usage);

// 将所有分块合并并播放
          const totalLength = audioChunks.reduce(
            (sum, chunk) => sum + chunk.length,
            0
          );
          const combinedArray = new Uint8Array(totalLength);
          let offset = 0;
          for (const chunk of audioChunks) {
            combinedArray.set(chunk, offset);
            offset += chunk.length;
          }

          const audioBlob = new Blob([combinedArray], { type: 'audio/mpeg' });
          const audioUrl = URL.createObjectURL(audioBlob);
          const audio = new Audio(audioUrl);
          audio.play();
          return;
        }
      }
    }
  }
}

// 使用示例
streamTTSWithSSE('来自 SSE 流的问候！');

其他端点

• POST/GET /v1/models：列出可用的 TTS 模型。
• POST/GET /v1/voices：列出给定语言/区域设置的 edge-tts 音色。
• POST/GET /v1/voices/all：列出所有 edge-tts 音色，并提供语言支持信息。