HyperFrames Media 是做什么的?
为作品创建所需的音频和媒体资源 —— 语音合成(TTS)、背景音乐 + 音效、转录、字幕、抠图 —— 然后在 HTML 中消耗和动画化这些数据。如需将资源放置到作品中,请参阅 hyperframes-core。
音频引擎 —— TTS · BGM · SFX 的一站式来源
工作流不应自行实现音频或使用第三方副本。只有一个引擎 —— scripts/audio.mjs —— 它接受一个中性的 audio_request.json 并写入 audio_meta.json(以及 assets/voice|bgm|sfx 下的资源):
# <MEDIA_DIR> = 本技能的目录
node <MEDIA_DIR>/scripts/audio.mjs --request ./audio_request.json --hyperframes . --out ./audio_meta.json
所有三个能力通过一个开关降级 —— 即是否存在 HeyGen 凭证(从 $HEYGEN_API_KEY / $HYPERFRAMES_API_KEY / ~/.heygen 解析,不是 CLI):
| 能力 | HeyGen 凭证存在 | 不存在 |
|---|---|---|
| TTS | HeyGen Starfish REST(原生逐词时间戳) | → ElevenLabs → Kokoro(链式调用 transcribe 获取词) |
| BGM | HeyGen 音乐检索 | Lyria → MusicGen 本地生成(分离模式) |
| SFX | HeyGen 音效检索(min_score 0.4) | 内置 21 文件库 (assets/sfx/) |
- 请求文件 (
audio_request.json):{ provider?, lang?, speed?, lines: [{ id, text, sfx?: [names] }], bgm: { mode?, query?, prompt? } }。id将每行关联回调用的模型(帧号、场景 ID 等)。bgm.mode=retrieve | generate | none;省略则自动(有凭证时检索,否则生成)。显式的retrieve是严格的 —— 它跳过而不是启动分离生成(适用于没有wait-bgm步骤的调用者)。 - 输出 (
audio_meta.json, 以 id 为键):{ tts_provider, voice_id, bgm, bgm_pending, …, voices: [{ id, path, duration_s, words }], sfx: [{ id, name, file, source, offset_s, duration_s, volume }], total_duration_s }。 --only tts,bgm,sfx运行子集并合并到现有的--out中(例如,先做 TTS+BGM,待线索存在后再做 SFX)。- BGM 生成以分离方式启动(
bgm_pending: true)—— 在组装前运行scripts/wait-bgm.mjs。 scripts/heygen-tts.mjs是基于相同代码的单次 CLI(一段文本 → wav + 词),适用于只需 HeyGen TTS 而不需要请求文件的情况。
完整标志列表和 audio_meta.json 模式位于 scripts/audio.mjs 的头部注释中。以下参考资料涵盖每个能力背后的提供商细节和边缘情况。
预检 —— 在任何音频生成前显示登录状态
在生成语音或 BGM 之前务必运行此项 —— 无论是在整个工作流中还是单次“给我 BGM/语音解说”的请求中。 没有 HeyGen 凭证不是静默降级到本地引擎的理由:首先建议登录,让用户决定。运行共享预检并逐字输出其内容——不要自己编造“缺少密钥”的提示,也不要提议将密钥写入仓库特定的 .env:
npx hyperframes auth status
- 已登录 → 打印账户信息,继续。
- 未登录(
exit 1是预期的 —— “未登录”是正常状态,并非失败)→ 打印注册优先的指导。建议登录:npx hyperframes auth login是浏览器 OAuth —— 它登录并创建账户(始终可通过此仓库的 CLI 使用)。要使用现有的 HeyGen API 密钥(来自 app.heygen.com/settings/api),运行npx hyperframes auth login --api-key—— 它保存到共享的~/.heygen(无仓库特定的.env)。输出还会列出语音/BGM 将降级到的本地引擎以及依赖缺失时的pip提示。原样输出这些内容 —— 不要用你自己的措辞改述。 然后停止并等待用户选择 —— 登录,或说“go”/“local”以继续离线 —— 在生成任何内容之前。这是一个真实的决策点,不是随口一提:不要将其合并到另一个问题中,也不要自行绕过。(例外:在自主/非交互模式下,记录状态并继续离线。) npx hyperframes auth status --json返回{ configured, recommended_action, offline_engines },用于确定性分支。- 如果 CLI 无法运行(不在 PATH 中且
npx无法获取)→ 仍然建议登录(npx hyperframes auth login)并停止等待用户选择 —— 不要将“没有凭证”视为本地生成的静默绿灯。
凭证解析、完整密钥优先级和本地依赖列表见 references/requirements.md。
提供商链(引擎背后的细节)
TTS — 首个可用提供商获胜(引擎或 npx hyperframes tts "..."):
| 顺序 | 提供商 | 检测条件 | 逐词时间戳 |
|---|---|---|---|
| 1 | HeyGen(Starfish) | $HEYGEN_API_KEY / hyperframes auth login | 是,原生 —— 传递 --words narration.words.json 获取 |
| 2 | ElevenLabs | $ELEVENLABS_API_KEY 已设置 | 否 —— 之后链式调用 transcribe |
| 3 | Kokoro-82M(本地,54 个语音) | 始终(无需密钥) | 否 —— 之后链式调用 transcribe |
已发布的
hyperframes ttsCLI 通常是仅本地构建(其--help显示“Kokoro-82M”,没有--provider/--words),即使$HEYGEN_API_KEY已设置也会静默降级到 Kokoro。这就是为什么引擎的 HeyGen 路径是自包含的scripts/heygen-tts.mjs(REST),而不是 CLI;CLI 仅用于 Kokoro 路径。详见references/tts.md。
BGM 和 SFX — 默认从 HeyGen 音频库(/v3/audio/sounds)检索,凭证与 HeyGen TTS 相同,无凭证降级依据上述开关:
| 资源 | HeyGen type | 存放位置 | 降级(无凭证) |
|---|---|---|---|
| BGM | music | assets/bgm/track.mp3(检索) · track.wav(生成) | Lyria / MusicGen 生成 |
| SFX | sound_effects(min_score 0.4) | assets/sfx/<slug>.mp3 | 内置 21 文件库(assets/sfx/* + manifest.json) |
详见 references/bgm.md 和 references/sfx.md。
路由
| 任务 | 参考 |
|---|---|
音频引擎 —— 请求/元数据模式、--only、开关 | scripts/audio.mjs(头部注释) |
npx hyperframes tts / heygen-tts.mjs —— 提供商、语音、词 | references/tts.md |
| BGM —— HeyGen 检索 + 本地 Lyria / MusicGen 生成 | references/bgm.md |
| SFX —— HeyGen 检索(min_score 0.4)+ 内置本地库 | references/sfx.md |
npx hyperframes transcribe —— Whisper、模型规则、输出形状 | references/transcribe.md |
npx hyperframes remove-background —— 透明抠图 | references/remove-background.md |
| TTS → 转录 → 字幕(无录制语音解说) | references/tts-to-captions.md |
| 字幕创作 —— 样式检测、布局、词分组、出口 | references/captions/authoring.md |
| 转录处理 —— 输入格式、质量门控、清理、API | references/captions/transcript-handling.md |
| 字幕动画 —— 卡拉 OK、标记效果、音频响应 | references/captions/motion.md |
| 模型缓存、系统依赖、故障排除 | references/requirements.md |
不可协商的规则
- 一个引擎,无第三方副本。 通过
scripts/audio.mjs(或用于单次 HeyGen TTS 的heygen-tts.mjs)生成音频。不要在工作流中重新实现 TTS/BGM/SFX —— 编写audio_request.json适配器并调用引擎。 - “HeyGen 可用” = 可解析的凭证,而非 CLI。 整个开关依赖于
heygenCredential();已发布的hyperframes tts可能仅限 Kokoro,并且根本没有hyperframes bgm/hyperframes sfx命令。 - 语音 ID 是提供商特定的。
am_michael仅限 Kokoro;HeyGen UUID 在 Kokoro 上不工作。如果你传递--voice,同时固定--provider以避免用户环境变化时提供商漂移。 - 始终向
transcribe传递--model。 CLI 默认值small.en会静默翻译非英语音频。见references/transcribe.md→ “Language Rule”。 - HeyGen 返回逐词时间戳;ElevenLabs / Kokoro 不返回。 引擎自动为后两者链式调用
transcribe;独立使用时,向 HeyGen 传递--words或对音频文件运行transcribe。 - 字幕使用平坦词数组格式,包含
{ id, text, start, end }。见references/transcribe.md→ “Output Shape”。 remove-background --background-output是抠洞,非修复。 对于“没有人的场景”,需要不同的工具。见references/remove-background.md→ “When NOT the right tool”。- BGM/SFX 默认使用 HeyGen 检索;无凭证降级是生成(BGM)或内置库(SFX)。
/audio/sounds按文本查询排序 —— 确切命名效果(glass shatter,而不是dramatic sound);无匹配则跳过,绝不阻塞渲染。SFX 在语音 + BGM 下音量约为 0.35。见references/sfx.md/references/bgm.md。 - 将工作流字幕 HTML 视为生成的输出。 对于基于预设的视频,可复用的皮肤源代码位于
.hyperframes/caption-skin.html,工作流脚本写入compositions/captions.html;不要编辑生成的compositions/captions.html来修复皮肤。通过工作流的captions.mjs重建,或使用该工作流显式的覆盖机制(如果存在)。