Skip to content

Reference

CommandWhat it tests
npm testFull suite — all tests
npm run test:meaningCommunicative behavior guardrails
npm run test:determinismHash-based regression tests
npm run bench:rtfReal-time factor benchmark
npm run smokeEnd-to-end smoke test

Primary docs live in packages/voice-engine-dsp/docs/:

DocumentContents
STREAMING_ARCHITECTURE.mdCausal processing model, snapshot/restore, state management
MEANING_CONTRACT.mdProsody behavior specification — what the engine promises
DEBUGGING.mdHow to diagnose pitch issues, event ordering problems, and style drift
Reference_Handbook.md (root)Full API reference and concept guide
PERF_CONTRACT.md (root)Real-time factor and latency guarantees
PackagePathContents
voice-engine-dsppackages/voice-engine-dsp/Core DSP, streaming prosody engine, meaning tests, determinism tests, RTF benchmarks
AspectDetail
Data touchedIn-memory float arrays (audio samples), configuration objects
Data NOT touchedNo file system writes, no network, no telemetry
PermissionsNone — pure computation library with no I/O side effects
NetworkNone — fully offline

See SECURITY.md for vulnerability reporting.