Files
openchamber/packages/ui/src/hooks/useLocalTTS.ts
T
Bohdan Triapitsyn de1b85ac56 feat(voice): first-class voice input and local TTS across web, desktop, and mobile (#2018)
Complete rebuild of voice input on a server-authoritative streaming
architecture, replacing the legacy Web Speech / whole-blob / WASM engines
and the dead voice-agent layer (~4k lines removed).

Speech-to-text (dictation):
- Client streams 16 kHz mono PCM16 chunks over /api/dictation/ws with
  seq/ack ordering; buffered audio is retained and replayed on reconnect
- Server transcribes and streams live partial transcripts back;
  segments auto-commit every ~15s with silence suppression and adaptive
  finalization timeouts
- Local provider (default, zero config): sherpa-onnx models in a forked
  worker process — auto-download with progress, staged extraction with
  verification, corrupt-model auto-recovery, idle shutdown after 5 min
- Model catalog with settings picker (accuracy/speed ratings, sizes,
  download/delete): Parakeet TDT v2 (English) and v3 (25 European
  languages, auto-detected), Whisper base and tiny (multilingual, light)
- OpenAI-compatible provider for any Whisper endpoint
- Composer overlay with live transcript, volume meter, timer, and
  cancel / insert / insert-and-send actions; failed transcriptions keep
  their audio for retry or accepting the partial text as-is
- Configurable keyboard shortcut (default mod+alt+v) toggles dictation;
  Enter confirms and Escape cancels while recording
- Overlay is pixel-aligned with the composer (measured footer height,
  matching paddings/typography/gaps) — no layout shift when toggling

Text-to-speech:
- Local Kokoro provider (English, 11 voices) synthesized in the same
  worker via /api/dictation/tts/speak, managed by the shared model
  pipeline; sentence-pipelined playback keeps time-to-first-audio at
  ~1 sentence regardless of message length, and stop cancels in-flight
  synthesis
- Sanitizer keeps inline-code content (strips backticks only), reads
  interword slashes aloud, and removes only absolute file paths

Settings:
- Voice page unified: a single read-aloud toggle owns all playback
  options (the confusing "Enable Voice Mode" is gone); a new "Enable
  voice input" toggle (default on, persisted to settings.json) hides
  the composer mic entirely when disabled

Mobile and transport:
- iOS/Android microphone permissions added (dictation was previously
  impossible on mobile)
- Fixed Android WebSocket upgrades: the Capacitor WebView origin
  (https://localhost) was missing from the packaged-client allowlist,
  403-ing every WS connection — root cause of the old mobile SSE lock,
  which is now removed for all transports

Security and conventions:
- All HTTP routes sit behind the global /api auth gate; the WS upgrade
  explicitly validates the UI session and origin, with oc_url_token
  narrowly allowlisted and covered by tests; the dictation socket mints
  a fresh URL token before connecting
- Routes register before the generic OpenCode proxy; the client goes
  through runtimeFetch/getRuntimeUrlResolver, and runtime switches
  reset the dictation socket
- VS Code deliberately reports dictation as unavailable (no server
  process in that runtime)

CI: workflow Node bumped 20 -> 22 to match the repo engines and fix
better-sqlite3 installs broken by node-gyp@latest on Node 20.

New dependency: sherpa-onnx-node (prebuilt N-API; macOS/Linux x64+arm64,
Windows x64 — Windows-on-ARM falls back to the OpenAI-compatible provider)
2026-07-04 02:48:07 +03:00

267 lines
8.8 KiB
TypeScript

/**
* useLocalTTS Hook
*
* React hook for local (Kokoro via sherpa-onnx) text-to-speech playback.
* Synthesis runs on the OpenChamber server in the dictation worker.
*
* Long texts are pipelined by sentence chunks: the first chunk starts playing
* as soon as it is synthesized while the next chunk synthesizes in the
* background, so time-to-first-audio stays ~1 chunk regardless of message
* length.
*/
import { useCallback, useEffect, useRef, useState } from 'react';
import { runtimeFetch } from '@/lib/runtime-fetch';
export interface LocalTTSSpeakOptions {
/** Kokoro speaker id (0-10) */
speakerId?: number;
/** Playback speed multiplier (1.0 = normal) */
speed?: number;
onStart?: () => void;
onEnd?: () => void;
onError?: (error: string) => void;
}
export interface UseLocalTTSReturn {
isPlaying: boolean;
error: string | null;
speak: (text: string, options?: LocalTTSSpeakOptions) => Promise<void>;
stop: () => void;
/** Unlock audio for mobile Safari - call this on user gesture */
unlockAudio: () => Promise<void>;
}
/** Target chunk size: big enough to amortize requests, small enough for low latency. */
const MIN_CHUNK_CHARS = 60;
const MAX_CHUNK_CHARS = 400;
/**
* Split text into sentence-aligned chunks for pipelined synthesis.
* Sentences are merged until MIN_CHUNK_CHARS and hard-split at
* MAX_CHUNK_CHARS so a single run-on sentence cannot stall the pipeline.
*/
export function splitTextForSynthesis(text: string): string[] {
const normalized = text.replace(/\s+/g, ' ').trim();
if (!normalized) {
return [];
}
const sentences = normalized.match(/[^.!?…]+[.!?…]+["')\]]*\s*|[^.!?…]+$/g) ?? [normalized];
const chunks: string[] = [];
let current = '';
for (const sentence of sentences) {
for (let offset = 0; offset < sentence.length; offset += MAX_CHUNK_CHARS) {
const piece = sentence.slice(offset, offset + MAX_CHUNK_CHARS);
if (current && current.length + piece.length > MAX_CHUNK_CHARS) {
chunks.push(current.trim());
current = '';
}
current += piece;
if (current.length >= MIN_CHUNK_CHARS && /[.!?…]["')\]]*\s*$/.test(current)) {
chunks.push(current.trim());
current = '';
}
}
}
if (current.trim()) {
chunks.push(current.trim());
}
// Latency trim for the FIRST chunk only: if the opening sentence is long,
// split it at a clause boundary (comma/semicolon/colon) so the first
// audio starts sooner. Only the first chunk gets this treatment — comma
// splits inside every sentence would chop the prosody, and after playback
// starts the pipeline hides synthesis time anyway.
if (chunks.length > 0 && chunks[0].length > 120) {
const first = chunks[0];
const clauseBreak = /[,;:]\s/g;
let bestBreak = -1;
let match: RegExpExecArray | null;
while ((match = clauseBreak.exec(first)) !== null) {
const end = match.index + 1;
if (end < 40) {
continue;
}
if (end > 160) {
break;
}
bestBreak = end;
break;
}
if (bestBreak > 0) {
const head = first.slice(0, bestBreak).trim();
const tail = first.slice(bestBreak).trim();
chunks.splice(0, 1, head, tail);
}
}
return chunks;
}
let sharedAudioContext: AudioContext | null = null;
function getAudioContext(): AudioContext {
if (!sharedAudioContext) {
sharedAudioContext = new (window.AudioContext || (window as unknown as { webkitAudioContext: typeof AudioContext }).webkitAudioContext)();
}
return sharedAudioContext;
}
interface PlaybackSession {
cancelled: boolean;
abort: AbortController;
}
export function useLocalTTS(): UseLocalTTSReturn {
const [isPlaying, setIsPlaying] = useState(false);
const [error, setError] = useState<string | null>(null);
const audioSourceRef = useRef<AudioBufferSourceNode | null>(null);
const sessionRef = useRef<PlaybackSession | null>(null);
const unlockAudio = useCallback(async (): Promise<void> => {
try {
const ctx = getAudioContext();
if (ctx.state === 'suspended') {
await ctx.resume();
}
const buffer = ctx.createBuffer(1, 1, 22050);
const source = ctx.createBufferSource();
source.buffer = buffer;
source.connect(ctx.destination);
source.start(0);
} catch {
// Unlocking is best-effort.
}
}, []);
const stop = useCallback(() => {
const session = sessionRef.current;
if (session) {
session.cancelled = true;
session.abort.abort();
sessionRef.current = null;
}
if (audioSourceRef.current) {
try {
audioSourceRef.current.onended = null;
audioSourceRef.current.stop();
} catch {
// Already stopped
}
audioSourceRef.current = null;
}
setIsPlaying(false);
}, []);
const speak = useCallback(async (text: string, options?: LocalTTSSpeakOptions): Promise<void> => {
stop();
const chunks = splitTextForSynthesis(text);
if (chunks.length === 0) {
setError('No text to speak');
options?.onError?.('No text to speak');
return;
}
setError(null);
const session: PlaybackSession = { cancelled: false, abort: new AbortController() };
sessionRef.current = session;
const fetchChunk = async (chunk: string): Promise<ArrayBuffer> => {
const response = await runtimeFetch('/api/dictation/tts/speak', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
text: chunk,
...(typeof options?.speakerId === 'number' ? { speakerId: options.speakerId } : {}),
...(typeof options?.speed === 'number' ? { speed: options.speed } : {}),
}),
signal: session.abort.signal,
});
if (!response.ok) {
const errorData = await response.json().catch(() => ({ error: 'Unknown error' }));
throw new Error(errorData.error || `HTTP ${response.status}`);
}
return (await response.blob()).arrayBuffer();
};
const playBuffer = async (arrayBuffer: ArrayBuffer): Promise<void> => {
const ctx = getAudioContext();
if (ctx.state === 'suspended') {
await ctx.resume();
}
const audioBuffer = await ctx.decodeAudioData(arrayBuffer);
if (session.cancelled) {
return;
}
await new Promise<void>((resolve) => {
const source = ctx.createBufferSource();
source.buffer = audioBuffer;
source.connect(ctx.destination);
audioSourceRef.current = source;
source.onended = () => {
if (audioSourceRef.current === source) {
audioSourceRef.current = null;
}
resolve();
};
source.start(0);
});
};
try {
setIsPlaying(true);
options?.onStart?.();
// Pipelined: synthesize chunk N+1 while chunk N is playing.
let nextFetch: Promise<ArrayBuffer> = fetchChunk(chunks[0]);
for (let i = 0; i < chunks.length; i += 1) {
const buffer = await nextFetch;
if (session.cancelled) {
return;
}
if (i + 1 < chunks.length) {
nextFetch = fetchChunk(chunks[i + 1]);
}
await playBuffer(buffer);
if (session.cancelled) {
return;
}
}
setIsPlaying(false);
options?.onEnd?.();
} catch (err) {
if ((err as Error).name === 'AbortError' || session.cancelled) {
return;
}
const errorMsg = err instanceof Error ? err.message : 'Failed to speak';
setError(errorMsg);
options?.onError?.(errorMsg);
setIsPlaying(false);
} finally {
if (sessionRef.current === session) {
sessionRef.current = null;
}
}
}, [stop]);
useEffect(() => {
return () => {
stop();
};
}, [stop]);
return {
isPlaying,
error,
speak,
stop,
unlockAudio,
};
}