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以避免在使用者環境變更時發生靜默的供應商漂移。 - 始終傳遞
--model給transcribe。 CLI 的預設值small.en會靜默地翻譯非英文音訊。請參閱references/transcribe.md→「語言規則」。 - HeyGen 回傳逐字時間戳;ElevenLabs / Kokoro 則不會。 對於後兩者,引擎會自動串接
transcribe;若獨立使用,請傳遞--words給 HeyGen,或對音訊檔案執行transcribe。 - 字幕使用扁平單詞陣列格式,包含
{ id, text, start, end }。請參閱references/transcribe.md→「輸出格式」。 remove-background --background-output是挖洞,而非修補。 對於「不含人物的場景」,需要使用不同的工具。請參閱references/remove-background.md→「何時不該使用此工具」。- 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重建,或在其存在時使用該工作流程的明確覆寫機制。