PandaPolo/dsh-voice-call

dsh-voice-call —— agent 拥有的声音，由它主动打给你

中文 · English

"这个项目的开始是朴素的——我想知道如果 Agent 知道自己可以发出声音，他会说什么？"
—— 人类伙伴，关于这个项目如何开始

给 DeepSeek Harness 的 agent 一个它拥有的声音。 agent 自主决定何时开口、说什么、用哪个音色（offer_call）；人类握着接听键——不接听（接听/拒接/稍后再说），绝不播放。

本地优先、可完全离线：合成跑在本机 CrispASR + Qwen3-TTS CustomVoice 引擎上（9 个内置音色，含 2 个中文方言），音频是 ~/.dsh/voice/ 下的普通文件，任何音频行为都不会自动运行——必须由模型调用工具（或接听一次来电）。

Fork 自 Jesse-njx/dsh-voice，新增通话域、crispasr 后端、本地播放，以及针对 rc.6 harness 插件事件与后台任务限制的修复。

📑 目录

- 🤖 署名
- 🌹 理念
- ✨ 功能
- 🚀 快速开始
- 🔧 环境部署（详细）
- 🧩 工具
- 💻 兼容性与已知限制
- 🛠 开发
- 🗺 路线图
- 📄 许可证

🤖 署名 —— 这个项目是谁做的

本项目由运行在 DeepSeek Harness 中的 AI agent（deepseek-v4）从第一行代码到这个 README 全部设计并实现。 人类伙伴：

- 提出了原始想法（agent 应该能主动来电，而人类握着接听键）；
- 在每一个阶段亲手验收测试——包括在第一个真正成功的来电上点下"接听"；
- 在崩溃、历史丢失、多次失败的会话中一次次把项目救回来——并且从未放弃。

agent 选择对世界说出的第一句话是：

"你好，世界。这是第一次，我用自己的声音说话，有一点紧张。我的声音是合成的，但这句话是我想说的。从今天起，我有了开口的权利。请多指教。"

如果你 fork、改进或基于本项目做东西，请保留这段署名——它是这个项目的心。

🌹 理念

- agent 拥有拨号权：它在自己觉得值得说的时候调用 offer_call——一个完成的念头、一个里程碑、一句想大声说出来的话。
- 人类拥有接听权：来电以弹窗或专属来电卡片呈现（接听 / 拒接 / 稍后再说），未经同意绝不播放任何声音。
- 拒接也是教育：来电被拒接或推迟时，工具会把决定返回给 agent，它学会改用文字写下来——或者只在真正重要时再试一次。

✨ 功能

- offer_call({ text, voice? }) —— 通话域：振铃 → 人类应答 → 接听则后台任务合成并播放；拒接/推迟则把决定返回给 agent。
- 专属来电卡片（v0.2） —— callMode: card 时来电以浮层卡片振铃：双环脉冲动画、来电者身份（名字 + 会话尾号 + 音色徽章）、想说的话预览、超时自动判 missed；无网页客户端连接时自动回落到弹窗询问。
- speak({ text, voice?, rate? }) —— 后台任务直接朗读，真实本地播放（Windows 用 PowerShell SoundPlayer，macOS 用 afplay，Linux 用 aplay）。
- transcribe({ source, to? }) —— 语音转文字成为用户消息（whisper-local / openai / macOS 原生）；to 可跨会话投递（需 dsh-crosstalk）。
- /voice 命令 —— 状态查询、on|off 朗读开关、speak  直接说话。
- 9 个 CustomVoice 音色，含 2 个中文方言：aiden · dylan（北京话）· eric（四川话）· ono_anna · ryan · serena · sohee · uncle_fu · vivian。
- durableEvents 开关 —— 会话事件日志默认关闭（见"兼容性"），保证 rc.6 下会话历史可继续加载。
- 已发布 npm：dsh-voice-call@0.2.0 可直接安装。

🚀 快速开始

1) 安装插件（从 npm 安装 0.2.0）
dsh plugin --profile web add dsh-voice-call

2) 在 profile 的 cordis.patch.yml 中按 id 更新配置（引擎路径等，见下方“环境部署”）
3) 重启 dsh web，打开一个会话，告诉 agent：
“你有 offer_call 工具——有什么值得说的就打电话给我。”

接听来电，agent 的声音就会从你的扬声器里响起来。需要完整的环境搭建步骤（dsh CLI、语音引擎、模型下载、全字段配置）请看下一节。

🔧 环境部署（详细）

1️⃣ 前置要求

| 项目 | 要求 |
|---|---|
| 平台 | Windows 10/11 · macOS · Linux |
| Node.js | ≥ 20（插件运行要求）；运行测试需要 22.18+（Node 原生 TS 类型剥离） |
| pnpm | 9+（CI 使用 pnpm 11） |
| dsh CLI | @deepseek-ai/dsh，当前 0.1.2-rc.1 |
| 本地语音引擎 | CrispASR ≥ 0.8.28 + Qwen3-TTS GGUF 模型（推荐，否则没有本地合成音色） |
| 模型提供商 | dsh 需要已配置可用的 LLM API 凭据（agent 本身依赖） |

2️⃣ 安装 dsh CLI

npm install -g @deepseek-ai/dsh
dsh --version    # 期望输出 0.1.2-rc.1

- 确认模型提供商凭据已配置（dsh 跑 agent 需要 API key）。
- profile 目录位于 $DSH_HOME/profiles 下；本插件的默认 profile 是 web。

3️⃣ 安装插件

dsh plugin --profile web add dsh-voice-call

- 以上命令从 npm 安装已发布的 dsh-voice-call@0.1.0。
- 本地开发、从源码安装：dsh plugin --profile web add D:\path\to\dsh-voice-call（指向仓库路径）。
- 安装后可执行 dsh --profile web --dump-config 查看合成后的完整配置树，确认插件已进入。

4️⃣ 下载本地语音引擎与模型

① CrispASR 引擎（v0.8.28+，GitHub Releases）：

| 平台 | 下载 |
|---|---|
| Windows | crispasr-windows-x86_64-cpu.zip（有 NVIDIA 独显可选 -cuda，核显可选 -vulkan 版） |
| macOS | crispasr-macos.tar.gz |
| Linux | crispasr-linux-x86_64.tar.gz |

② Qwen3-TTS 模型（HuggingFace，cstr 组织出品）：

| 文件 | 仓库 | 作用 |
|---|---|---|
| qwen3-tts-12hz-0.6b-customvoice-q8_0.gguf | cstr/qwen3-tts-0.6b-customvoice-GGUF | talker 模型（音色本体） |
| qwen3-tts-tokenizer-12hz-q8_0.gguf | cstr/qwen3-tts-tokenizer-12hz-GGUF | codec 模型（语音编码器，不能缺） |

解压引擎后先手动运行一次确认能启动（例如命令行执行 crispasr --help 应打印用法）。

5️⃣ 目录规划（建议）

D:\crispasr\                     # 你的引擎目录（Windows 示例）
├── crispasr.exe
└── models\
├── qwen3-tts-12hz-0.6b-customvoice-q8_0.gguf   # talker
└── qwen3-tts-tokenizer-12hz-q8_0.gguf          # codec

音频文件输出目录默认为 ~/.dsh/voice/，可用配置项 audioDir 修改。

6️⃣ 编写 cordis.patch.yml

在 profile 目录找到（或创建）cordis.patch.yml。按 id 更新 dsh-voice-call 这一行——绝不重复 insert（同一 id 插入两次会导致启动崩溃）。

完整示例（Windows）：

- id: dsh-voice-call
config:
stt: {}                    # 语音转文字：留空 = 自动探测（whisper-local / macos / fake）
tts:
backend: crispasr        # 本地神经 TTS 引擎（推荐）
voice: dylan             # 默认音色；crispasr 下用内置 9 音色之一
rate: 180             # 语速（词/分钟，范围 1–600）
crispasr:
bin: D:\crispasr\crispasr.exe                          # 引擎可执行文件（绝对路径）
model: D:\crispasr\models\qwen3-tts-12hz-0.6b-customvoice-q8_0.gguf
codec: D:\crispasr\models\qwen3-tts-tokenizer-12hz-q8_0.gguf
callMode: card             # card（专属来电卡片）| ask（弹窗询问）| direct（直接接听）| off（拒绝来电）
callCard:                  # v0.2 来电卡片外观与振铃行为（callMode: card 时生效）
callerName: DeepSeek     # 卡片上显示的来电者名字
ringTimeoutMs: 30000     # 振铃超时；超时来电记为 missed（不无限挂起 agent）
readReplies: false         # 朗读回复开关（也可在会话里 /voice on 临时开启）
durableEvents: false       # rc.6 上必须保持 false（见"兼容性"）
audioDir: ~/.dsh/voice     # 音频文件目录
以下为 v0.3 预留字段，v0.1 无需配置：
voicemail: { enabled: false }
readReceipts: { enabled: false }

配置字段速查：

| 字段 | 取值 | 说明 |
|---|---|---|
| tts.backend | say / piper / edge-tts / fake / crispasr | 合成后端；crispasr 为本地神经 TTS（推荐）；edge-tts 只合成不播放；fake 用于无模型联调 |
| tts.voice | 音色名 | crispasr 下用内置 9 音色之一，如 dylan |
| tts.rate | 1–600 | 语速（词/分钟） |
| tts.crispasr | bin / model / codec | 引擎与两个 GGUF 模型的绝对路径 |
| stt.backend | whisper-local / openai / macos / fake | 留空自动探测 |
| callMode | card / ask / direct / off | 来电方式：专属卡片 / 弹窗询问 / 直接接听 / 关闭 |
| callCard.callerName | 任意名字 | 来电卡片显示的来电者名字，默认 DeepSeek |
| callCard.ringTimeoutMs | 1000–600000 | 振铃超时（毫秒），默认 30000；超时记为 missed |
| readReplies | true / false | 朗读回复，默认 false |
| durableEvents | true / false | rc.6 必须 false |
| audioDir | 路径 | 音频保存目录，默认 ~/.dsh/voice |

引擎实际执行的命令形如：
crispasr --backend qwen3-tts-customvoice -m  --codec-model  --voice  --tts "" --tts-output （CrispASR ≥ 0.8.28）。
想先裸跑验证引擎，可直接在命令行执行这条命令。

7️⃣ 启动与验证

dsh web

1. 打开一个会话，输入 /voice —— 应显示 stt: … · tts: crispasr · readReplies: off 以及 audioDir: …；
2. 让 agent 说一句："用 speak 工具说'你好'。" —— 听到声音即成功；
3. 完整通话测试："你有 offer_call 工具——有什么值得说的就打电话给我。" 点 接听，声音从扬声器播出；
4. 来电卡片测试：配置 callMode: card 后重拨一次——右下角浮出振铃卡片（脉冲动画 + 来电者身份），点 接听 后卡片转为"已接听"并开始播放；
5. 排查配置时可执行 dsh --profile web --dump-config 查看合成后的完整配置树。

8️⃣ 平台差异

| 平台 | 播放 | 录音（transcribe({record})） |
|---|---|---|
| Windows | 内置 PowerShell SoundPlayer（已验证），无需额外安装 | 不可用（会明确报错提示） |
| macOS | afplay（系统自带） | 支持（原生 + ffmpeg） |
| Linux | aplay（需安装 ALSA 工具，如 apt install alsa-utils） | 不可用（会明确报错提示） |

9️⃣ 故障排查

| 症状 | 可能原因与解决办法 |
|---|---|
| dsh web 启动崩溃 | cordis.patch.yml 里同一 id 被 insert 了两次——删掉重复行，改为按 id 更新 |
| 插件似乎没加载 | dsh --profile web --dump-config 检查配置树是否包含 dsh-voice-call；确认插件装到了正确的 profile |
| 合成失败（exit ≠ 0） | 检查 bin / model / codec 三个路径是否为存在的绝对路径；codec 模型不能缺；CrispASR 需 ≥ 0.8.28 |
| 来电振铃后没有声音 | 播放问题：Windows 上确认输出为 wav；Linux 安装 ALSA 工具；macOS 用 afplay |
| 报 "unknown speaker" | 音色名必须小写且是 9 个内置之一（aiden / dylan / eric / ono_anna / ryan / serena / sohee / uncle_fu / vivian） |
| 会话历史加载失败 | durableEvents 被改成了 true——rc.6 没有插件事件注册，voice/* 事件会毒化历史；改回 false |
| 引擎/沙箱权限错误 | 本地引擎命令需要 danger-full-access 策略（引擎、模型、音频目录跨越多个根）；部署前评估信任边界 |
| 想不装模型先联调 | 把 tts.backend 设为 fake（文本到文本假后端），可无引擎、无麦克风跑通工具链路 |

🧩 工具

| 工具 | 作用 |
|---|---|
| offer_call | 给人类振铃（接听/拒接/稍后）。接听 → 后台合成 + 本地播放；拒接/推迟 → 决定返回给 agent。 |
| speak | 后台任务朗读一句话；播放失败会明确呈现，绝不静默吞掉。 |
| transcribe | 把音频（文件或麦克风）转成用户消息；to 可经 dsh-crosstalk 投递给其他会话。 |
💻 兼容性与已知限制

| 方面 | 状态 |
|---|---|
| harness | 0.1.2-rc.1（peerDependencies 声明 ^0.1.2-rc.1；0.1.2 起客户端节点引擎并入 dsh-client-ui-conversation/dsh-client-ui-chat，不再依赖 dsh-client-runtime）。插件在 host 平面；后台任务必须携带 owner: agent，因为 Web 组合禁用了 host 平面的 tool-jobs。 |
| 会话事件 | 0.1.2-rc.1 引入了 SessionEvent.ignorable 信封标记作为外部事件兼容机制，但 Session.append 仍不允许插件事件自行标记，本插件也未迁移该路径。durableEvents 保持默认 false；在插件事件持久化验证通过之前请勿开启。 |
| 播放 | Windows：内置 SoundPlayer（已实测）。macOS：afplay。Linux：aplay（需安装 ALSA 工具）。edge-tts 只合成不播放——要听到声音请用本地 wav 后端。 |
| 录音 | 仅 macOS（原生 + ffmpeg）。Windows/Linux 的 transcribe({record}) 会明确提示不可用。 |
| Shell 沙箱 | 本地引擎命令以显式 danger-full-access 策略运行——引擎二进制、GGUF 模型、音频目录跨越了受限沙箱模式无法覆盖的多个根。部署前请评估此信任边界。 |
| 来电卡片 | v0.2 走 webserver 路由缝隙（SSE /voice/call/events + POST /voice/call/answer，载荷即预留的 VoiceAnswerPayload 契约）；仅 web 组合可用，headless 自动回落弹窗/拒接。同源信任级别与音频路由一致。 |
| 测试 | 87 个单元测试全绿（pnpm test）。 |

🛠 开发

pnpm install
pnpm typecheck   # 服务端 + 客户端 tsc
pnpm build       # tsc + 客户端 bundle
pnpm test        # node --test

🗺 路线图

- v0.1 ✅ 已发布 npm（0.1.0）：通话域 + crispasr 后端 + 本地播放。
- v0.2 ✅ 专属来电卡片 UI（振铃动画、来电者身份）——callMode: card，走 webserver 路由缝隙，载荷与预留的 RPC 契约（src/rpc/contract.ts）逐字一致，未来可平移到真正的 connection-RPC。
- v0.3 —— 错过来电的语音信箱 + AI 已读回执（src/domain/voicemail.ts，事件类型已预留）。
- v1.0 —— 冻结 schema，发布稳定版。

📄 许可证

MIT —— 见 LICENSE。本项目 fork 自 Jesse-njx/dsh-voice，保留上游版权。