@vectorsize/woscillators

Woscillators

This is a WebAudio version of Mutable Instrument's Plaits module. The sources where compiled from c++ to WebAssembly and can be consumed in your WebAudio applications via this package.

Usage

You can install this package with npm or yarn as usual:

yarn add @vectorsize/woscillators

After the package is installed you register and instantiate the oscillators like so:

import { wosc, oscillatorTypes, parameters } from "@vectorsize/woscillators";

// or in browsers
// const { wosc, params, parameters } = window.woscillators;

const audioCtx = new AudioContext();
await wosc.loadOscillator(ctx);

// if no name passed uses default 'wosc-macro' name for registering worklet
const oscillator = wosc.createOscillator(audioCtx);
// optional second arguments registers the worklet with a different name to avoid clashing
const oscillator2 = wosc.createOscillator(audioCtx);

oscillator.connect(audioCtx.destination);
oscillator2.connect(audioCtx.destination);
oscillator.start();
oscillator2.start();

// ... later on
oscillator.stop();
oscillator2.stop();

// later, remove just this oscillator:
oscillator.dispose(); // ← cleans up this instance
oscillator2.dispose(); // ← cleans up this instance

// when your app/page is done with ALL worklet nodes:
wosc.teardown(); // ← revoke module URL + release ctx ref

API

The oscillator can be manipulated during runtime via the following properties:

General

• engine: int: 0-15 Sets the oscillator engine.
• note: int: 0-127 Sets the oscillator pitch.
• harmonics: float: 0-1 engine dependent parameter see the original manual for details.
• timbre: float: 0-1 engine dependent parameter see the original manual for details.
• frequencyModulationAmount (Fm): float: 0-10 engine dependent parameter see the original manual for details.
• morph: float: 0-1 engine dependent parameter see the original manual for details.
• decay: float: 0-1 Sets the decay of the internal Low Pas Gate.
• fade: float: 0-1 Crossfades between the primary and aux outputs.
• volume: float: 0-1 Sets a general gain value.

Modulations

For regular modulations it's enough to connect your modulation source to the desired parameter via the exposed AudioParameter (accessible via ${paramName}AudioParameter).

There are however two extra modulations that behave differently:

Trigger

The parameter modTrigger works in combination with modTriggerPatched. When modTriggerPatched is set to true, you can use the modTrigger parameter to trigger the internal Low Pas Gate. You can also then use the decay parameter to modify the decay and the parameter timbre to adjust the response of the LPG, from VCFA to VCA.
If modTriggerPatched is set to false, modTrigger won't have any effect.

Level

The parameter modLevel works in combination with modLevelPatched. When modLevelPatched is set to true, you can use the modLevel parameter as an envelope that will smoothly react to your changes.
If modLevelPatched is set to false, modLevel won't have any effect.

Licenses

Thi is a Mutable Instruments derivative work, and hence all the code coming from the original repository is subject to the GPL3.0/MIT license (see ./LICENSE-eurorack and the original repo for details).

The rest of the code in the repository is copyright 2020 Victor Saiz also under GPL3.0 unless specified in explicitly in the header of the files.