SuperCollider scsynth WebAssembly port for AudioWorklet - Run SuperCollider synthesis in the browser
npm install supersonic-scsynth> Note: Still Alpha Status: _SuperSonic is in active development._ The API may continue to evolve, but the core synthesis engine is solid and ready for experimentation. _Feedback and ideas are most welcome._
``
░█▀▀░█░█░█▀█░█▀▀░█▀▄░█▀▀░█▀█░█▀█░▀█▀░█▀▀
░▀▀█░█░█░█▀▀░█▀▀░█▀▄░▀▀█░█░█░█░█░░█░░█░░
░▀▀▀░▀▀▀░▀░░░▀▀▀░▀░▀░▀▀▀░▀▀▀░▀░▀░▀▀▀░▀▀▀
Back in the late 90s James McCartney designed a series of live audio programming environments called SuperCollider. These were systems with both programming languages and audio runtimes carefully designed for live realtime modification at every level - from high sweeping programming language abstractions all the way down to the fine control of the low-level synthesis components of the audio chain.
One of the many gifts from this work is scsynth - the core synthesis engine James created for version 3 of SuperCollider. It was at this point when he _formally separated the language from the synth engine_.
This split made it possible to combine scsynth's powerful audio synthesis capabilities with any existing - or yet to exist - programming language.
This then led to a suite of powerful new live coding languages using scsynth for audio synthesis.
_What if you didn't just bring your language to scsynth? What if you brought scsynth to your environment?_
This is SuperSonic. All the synthesis power of scsynth - modified and augmented to run in your web browser.
SuperSonic is SuperCollider's powerful audio synthesis engine scsynth running in the browser as an AudioWorklet.
Highlights:
- AudioWorklet - runs in a dedicated high priority audio thread
- WebAssembly - scsynth's original C++ code compiled for the web
- OSC API - talk to the scsynth server through its native OSC API
- Zero Config via CDN - no installation necessary - works directly from CDNs such as unpkg.
- Optional SAB mode - can use a SharedArrayBuffer (SAB) for lower latency and reduced jitter with internal comms. Requires COOP/COEP headers to enable browsers to use the SAB
Try the live demo: sonic-pi.net/supersonic/demo.html
`html`
`javascript
import { SuperSonic } from 'supersonic-scsynth';
const sonic = new SuperSonic({
baseURL: '/assets/supersonic/' // Where you serve the WASM/workers
});
`
| Option | Description |
|--------|-------------|
| baseURL | Base path for all assets (convenience shorthand) |coreBaseURL
| | Path to WASM and workers (overrides baseURL) |wasmUrl
| | Direct URL to scsynth-nrt.wasm |workletUrl
| | Direct URL to audio worklet JS |sampleBaseURL
| | Path to sample files |synthdefBaseURL
| | Path to synthdef files |mode
| | 'sab' or 'postMessage' - transport mode (defaults to 'postMessage') - see Modes |
For the full list of configuration options, see the API Reference. For installation options see the Installation Guide. Once installed, head to the Quick Start to make your first sound.
SuperSonic supports two communication modes: postMessage (default, works everywhere including CDNs) and SAB (SharedArrayBuffer, lower latency but requires server headers).
See Communication Modes for details on choosing a mode, server configuration, and technical implementation.
- Installation - CDN, npm, self-hosting, browser requirements
- Quick Start - Boot and play your first synth
- API Reference - Methods, callbacks, and configuration
- Communication Modes - SAB vs postMessage, server configuration
- scsynth Command Reference - OSC commands for controlling scsynth
- Workers Guide - Sending OSC from Web Workers
- Metrics - Performance monitoring and debugging
- Building from Source - Compiling the WASM yourself
SuperSonic is brought to you by Sam Aaron. Please consider joining the community of supporters enabling Sam's work on creative coding projects like this, Sonic Pi and Tau5.
SuperSonic uses a tiered licensing model - see LICENSE for details.
| Package | License | Contains |
|---------|---------|----------|
| supersonic-scsynth | MIT | Client API |supersonic-scsynth-core
| | GPL-3.0-or-later | WASM engine + workers |supersonic-scsynth-synthdefs
| | MIT | Synth definitions |supersonic-scsynth-samples` | CC0 | Audio samples |
|
Based on SuperCollider by James McCartney and the SuperCollider community. This AudioWorklet port was inspired by Hanns Holger Rutz who started the first port of scsynth to WASM and Dennis Scheiba who continued this work. Thank you to everyone in the SuperCollider community!