mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-17 02:30:43 +00:00
fix(tts): pre-transcode synthesized audio to opus-in-CAF for native iMessage voice-memo bubbles via BlueBubbles (#72586)
End-to-end testing on macOS + BlueBubbles + ElevenLabs walked through three CAF flavors before landing on the format Apple's Messages.app actually emits when a user records a native iMessage voice memo: - PCM int16 @ 44.1 kHz CAF: BlueBubbles' internal `afconvert -f m4af -d aac` conversion fails; the original CAF reaches iMessage but renders with 0 s duration. - AAC @ 22.05 kHz mono CAF: BlueBubbles' conversion succeeds and the server silently downgrades the delivery, sending the converted MP3 as a generic audio attachment. - **Opus @ 24 kHz mono CAF**: byte-identical to the descriptor block Apple's Messages.app produces; BlueBubbles passes it through unchanged and iMessage renders a native voice-memo bubble with proper duration and waveform UI. Adds an opt-in `tts.voice.preferAudioFileFormat` channel capability and a macOS `afconvert`-backed pre-transcode in the speech-core pipeline. BlueBubbles declares `preferAudioFileFormat: "caf"`. Other channels are unaffected. Falls back to the original buffer when the host platform, the source/target pair, or the transcoder process can't produce the preferred container — so non-Darwin hosts and unsupported provider combinations are unchanged. Also adds a `caff` magic-byte sniff in `src/media/mime.ts` so the auto-reply host-local-media validator (which uses `file-type` and didn't recognize CAF natively) accepts the buffer instead of dropping it as "⚠️ Media failed." Fixes #72506. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
134
extensions/speech-core/src/audio-transcode.ts
Normal file
134
extensions/speech-core/src/audio-transcode.ts
Normal file
@@ -0,0 +1,134 @@
|
||||
import { spawn } from "node:child_process";
|
||||
import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { join } from "node:path";
|
||||
import { resolvePreferredOpenClawTmpDir } from "openclaw/plugin-sdk/sandbox";
|
||||
|
||||
/** Container token (file-extension shape, no leading dot) the host knows how
|
||||
* to pre-transcode into. Update in lockstep with `pickAfconvertRecipe`. */
|
||||
export type HostTranscodableContainer = "caf";
|
||||
|
||||
export type TranscodeOutcome =
|
||||
| { ok: true; buffer: Buffer }
|
||||
| {
|
||||
ok: false;
|
||||
reason:
|
||||
| "platform-unsupported"
|
||||
| "invalid-extension"
|
||||
| "noop-same-container"
|
||||
| "no-recipe"
|
||||
| "transcoder-failed";
|
||||
detail?: string;
|
||||
};
|
||||
|
||||
/**
|
||||
* Best-effort audio container transcode using macOS `afconvert`.
|
||||
*
|
||||
* Used by the TTS pipeline to pre-encode synthesized audio into a channel's
|
||||
* preferred container (see `ChannelTtsVoiceDeliveryCapabilities.preferAudioFileFormat`)
|
||||
* so the channel's downstream does not have to perform a container
|
||||
* conversion of its own. Returns a discriminated outcome so callers can
|
||||
* distinguish "we didn't try" (platform/recipe/noop) from "we tried and the
|
||||
* transcoder failed", which is the case worth logging.
|
||||
*
|
||||
* Currently only macOS is supported because `afconvert` is the only widely
|
||||
* available encoder we ship a recipe for.
|
||||
*/
|
||||
export async function transcodeAudioBuffer(params: {
|
||||
audioBuffer: Buffer;
|
||||
sourceExtension: string;
|
||||
targetExtension: string;
|
||||
timeoutMs?: number;
|
||||
}): Promise<TranscodeOutcome> {
|
||||
// Validate inputs first so callers get a specific reason regardless of
|
||||
// host platform. Platform-unsupported is the gate immediately before the
|
||||
// actual `afconvert` invocation.
|
||||
const source = normalizeExt(params.sourceExtension);
|
||||
const target = normalizeExt(params.targetExtension);
|
||||
if (!source || !target) {
|
||||
return { ok: false, reason: "invalid-extension" };
|
||||
}
|
||||
if (source === target) {
|
||||
return { ok: false, reason: "noop-same-container" };
|
||||
}
|
||||
const recipe = pickAfconvertRecipe(source, target);
|
||||
if (!recipe) {
|
||||
return { ok: false, reason: "no-recipe" };
|
||||
}
|
||||
if (process.platform !== "darwin") {
|
||||
return { ok: false, reason: "platform-unsupported" };
|
||||
}
|
||||
|
||||
const tmpRoot = resolvePreferredOpenClawTmpDir();
|
||||
mkdirSync(tmpRoot, { recursive: true, mode: 0o700 });
|
||||
const tmpDir = mkdtempSync(join(tmpRoot, "tts-transcode-"));
|
||||
const inPath = join(tmpDir, `in.${source}`);
|
||||
const outPath = join(tmpDir, `out.${target}`);
|
||||
try {
|
||||
writeFileSync(inPath, params.audioBuffer, { mode: 0o600 });
|
||||
const result = await runAfconvert({
|
||||
args: [...recipe, inPath, outPath],
|
||||
timeoutMs: params.timeoutMs ?? 5000,
|
||||
});
|
||||
if (!result.ok) {
|
||||
return { ok: false, reason: "transcoder-failed", detail: result.detail };
|
||||
}
|
||||
return { ok: true, buffer: readFileSync(outPath) };
|
||||
} catch (err) {
|
||||
return { ok: false, reason: "transcoder-failed", detail: (err as Error).message };
|
||||
} finally {
|
||||
try {
|
||||
rmSync(tmpDir, { recursive: true, force: true });
|
||||
} catch {
|
||||
// best-effort cleanup
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function normalizeExt(ext: string): string | undefined {
|
||||
// Pattern matches the sibling helper in src/media/audio-transcode.ts: a short
|
||||
// alphanumeric extension token. Keeps the value safe to interpolate into
|
||||
// tmp-file names below without introducing a path-traversal surface.
|
||||
const trimmed = ext.trim().toLowerCase().replace(/^\./, "");
|
||||
return /^[a-z0-9]{1,12}$/.test(trimmed) ? trimmed : undefined;
|
||||
}
|
||||
|
||||
function pickAfconvertRecipe(source: string, target: string): string[] | undefined {
|
||||
// Currently only the MP3→CAF path used by BlueBubbles voice memos. Keep
|
||||
// this in lockstep with `HostTranscodableContainer` above so a typo at the
|
||||
// channel-capability declaration site is a compile-time error.
|
||||
if (target === "caf") {
|
||||
// Opus-in-CAF, mono, 24 kHz. Validated against macOS 15.x Messages.app's
|
||||
// native voice-memo CAF descriptor (1 ch, 24000 Hz, opus); other CAF
|
||||
// flavors (PCM, AAC) get downgraded to plain audio attachments along the
|
||||
// BlueBubbles → Messages.app path. If iMessage stops rendering the result
|
||||
// as a voice memo after a system update, try forcing frames-per-packet
|
||||
// explicitly via `opus@24000#480` and re-validate. See #72506.
|
||||
return ["-f", "caff", "-d", "opus@24000", "-c", "1"];
|
||||
}
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function runAfconvert(params: {
|
||||
args: string[];
|
||||
timeoutMs: number;
|
||||
}): Promise<{ ok: true } | { ok: false; detail: string }> {
|
||||
return new Promise((resolve) => {
|
||||
const child = spawn("/usr/bin/afconvert", params.args, { stdio: "ignore" });
|
||||
const timer = setTimeout(() => {
|
||||
child.kill("SIGKILL");
|
||||
resolve({ ok: false, detail: `timeout-${params.timeoutMs}ms` });
|
||||
}, params.timeoutMs);
|
||||
child.once("error", (err) => {
|
||||
clearTimeout(timer);
|
||||
resolve({ ok: false, detail: err.message });
|
||||
});
|
||||
child.once("exit", (code) => {
|
||||
clearTimeout(timer);
|
||||
if (code === 0) {
|
||||
resolve({ ok: true });
|
||||
} else {
|
||||
resolve({ ok: false, detail: `exit-${code ?? "unknown"}` });
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user