Files
openchamber/packages/web/server/lib/dictation/local/worker-process.js
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

198 lines
5.8 KiB
JavaScript

/**
* Dictation local-speech worker process.
*
* Hosts the sherpa-onnx native inference (Parakeet STT) in a separate process
* so ONNX decoding never blocks the main OpenChamber server. Communicates
* with the parent over child_process IPC (advanced serialization, so Buffers
* survive the trip as Uint8Array).
*
* Request/response protocol (parent -> worker):
* { type: 'session.create', requestId, sessionId, modelsDir, modelId }
* { type: 'session.append', requestId, sessionId, audio }
* { type: 'session.commit' | 'session.clear' | 'session.close', requestId, sessionId }
* Worker -> parent:
* { type: 'response', requestId, ok, result?, error? }
* { type: 'session.committed' | 'session.transcript' | 'session.error', sessionId, ... }
*/
import {
SherpaOfflineRecognizerEngine,
SherpaRealtimeTranscriptionSession,
} from './sherpa-recognizer.js';
import { SherpaTtsEngine } from './sherpa-tts.js';
import { getLocalSttModelDir, getLocalSttModelSpec } from './model-catalog.js';
import { pcm16ToWav } from '../audio.js';
import path from 'path';
process.title = 'OpenChamber Dictation';
const engines = new Map();
const ttsEngines = new Map();
const sessions = new Map();
let ipcClosing = false;
function sendToParent(message) {
if (ipcClosing || !process.connected || !process.send) {
return;
}
try {
process.send(message, (error) => {
if (error) {
ipcClosing = true;
}
});
} catch {
ipcClosing = true;
}
}
function sendOk(requestId, result) {
sendToParent({ type: 'response', requestId, ok: true, ...(result !== undefined ? { result } : {}) });
}
function getEngine(modelsDir, modelId) {
const key = `${modelsDir}:${modelId}`;
const existing = engines.get(key);
if (existing) {
return existing;
}
const modelDir = getLocalSttModelDir(modelsDir, modelId);
const spec = getLocalSttModelSpec(modelId);
const created = new SherpaOfflineRecognizerEngine({
type: spec.type,
encoder: path.join(modelDir, spec.files.encoder),
decoder: path.join(modelDir, spec.files.decoder),
...(spec.files.joiner ? { joiner: path.join(modelDir, spec.files.joiner) } : {}),
tokens: path.join(modelDir, spec.files.tokens),
numThreads: 2,
});
engines.set(key, created);
return created;
}
function cleanupSession(sessionId) {
const session = sessions.get(sessionId);
sessions.delete(sessionId);
try {
session?.close();
} catch {
// ignore
}
}
function toBuffer(audio) {
if (Buffer.isBuffer(audio)) {
return audio;
}
if (audio instanceof Uint8Array) {
return Buffer.from(audio.buffer, audio.byteOffset, audio.byteLength);
}
if (audio && typeof audio === 'object' && audio.type === 'Buffer' && Array.isArray(audio.data)) {
return Buffer.from(audio.data);
}
throw new Error('Unsupported audio payload in dictation worker');
}
function getTtsEngine(modelsDir, modelId) {
const key = `${modelsDir}:${modelId}`;
const existing = ttsEngines.get(key);
if (existing) {
return existing;
}
const spec = getLocalSttModelSpec(modelId);
const created = new SherpaTtsEngine({
modelDir: getLocalSttModelDir(modelsDir, modelId),
files: spec.files,
numThreads: 2,
});
ttsEngines.set(key, created);
return created;
}
async function handleRequest(message) {
switch (message.type) {
case 'tts.synthesize': {
const engine = getTtsEngine(message.modelsDir, message.modelId);
const { pcm16, sampleRate } = engine.synthesize(message.text, {
speakerId: message.speakerId,
speed: message.speed,
});
sendOk(message.requestId, {
audio: pcm16ToWav(pcm16, sampleRate),
format: 'audio/wav',
});
return;
}
case 'session.create': {
cleanupSession(message.sessionId);
const engine = getEngine(message.modelsDir, message.modelId);
const session = new SherpaRealtimeTranscriptionSession({ engine });
session.on('committed', (payload) => {
sendToParent({ type: 'session.committed', sessionId: message.sessionId, payload });
});
session.on('transcript', (payload) => {
sendToParent({ type: 'session.transcript', sessionId: message.sessionId, payload });
});
session.on('error', (err) => {
sendToParent({
type: 'session.error',
sessionId: message.sessionId,
error: err instanceof Error ? err.message : String(err),
});
});
await session.connect();
sessions.set(message.sessionId, session);
sendOk(message.requestId, { requiredSampleRate: session.requiredSampleRate });
return;
}
case 'session.append': {
sessions.get(message.sessionId)?.appendPcm16(toBuffer(message.audio));
sendOk(message.requestId);
return;
}
case 'session.commit': {
sessions.get(message.sessionId)?.commit();
sendOk(message.requestId);
return;
}
case 'session.clear': {
sessions.get(message.sessionId)?.clear();
sendOk(message.requestId);
return;
}
case 'session.close': {
cleanupSession(message.sessionId);
sendOk(message.requestId);
return;
}
default: {
throw new Error(`Unknown dictation worker request: ${message?.type}`);
}
}
}
process.on('message', (message) => {
void handleRequest(message).catch((error) => {
sendToParent({
type: 'response',
requestId: message?.requestId,
ok: false,
error: error instanceof Error ? error.message : 'Dictation worker request failed',
});
});
});
process.once('disconnect', () => {
ipcClosing = true;
for (const sessionId of Array.from(sessions.keys())) {
cleanupSession(sessionId);
}
for (const engine of engines.values()) {
engine.free();
}
for (const tts of ttsEngines.values()) {
tts.free();
}
process.exit(0);
});