ZMod

let patch = `fm(200).amp(#e).pan().bus(0,1)`

s0.set({inst: 'zmod', patch, dur: 100})
s0.e.every(8)

patch = `stack(bus(0,1))`
s1.set({inst: 'zmod', patch, dur: 100, out: 2})
s1.e.every(12)

Basic Usage

const ZM = new ZMod() 

// pass a line of the Zen Modular scripting language
ZM.set(`sine(100).amp(env(0.1,0.1,0.5,0.8)).pan().out()`)
ZM.start() // start the transport
ZM.stop() // stop the transport
ZM.clear() // clear patch and dispose of all resources

External Control

// pass a string as the first argument of a node...
ZM.set(`sine(sig('f')).amp(env('e')).pan().out()`)

// ...to make the node controllable from outside the patch
console.log(ZM.inputs)
// returns {e: ƒ(), f: ƒ()}

// you can also do this shorthand to create signals for external control
ZM.set(`sine(#f).pan(#pan).out()`) // is equivalent to
ZM.set(`sine(sig('f')).pan(sig('pan')).out()`) // this

// whilst #e, #e1, #e2 ... are always handled as envelopes
ZM.set(`sine(100).amp(adsr('e')).pan().out()`) // is equivalent to
ZM.set(`sine(100).amp(#e).pan().out()`) // this


// interact with patch whilst it is running
ZM.inputs.e() // trigger envelope
ZM.inputs.f(1000, 1000) // ramp frequency to 1000Hz over 1s

// clear patch and dispose of all resources
ZM.clear()

Routing

const ZM = new ZMod() // by default connects to destination
// TODO
ZM.disconnect() // clear routing
ZM.connect(destination, [0,1], [0,1]) // dest / node, outputs, inputs

Signals

Signal

sig(value: number): ControlSignal

Creates a new ControlSignal with the specified value.

Signal Operators

Each of the following methods can be applied to a ControlSignal, and passed one or more number arguments:

ControlSignal.fn(...args: number[]): ControlSignal

Available functions:

• abs
• add
• multiply
• subtract
• greaterthan
• greaterthanzero
• negate
• gaintoaudio
• audiotogain
• pow
• scale
• scaleexp

sine(lfo(0.5,100,200).multiply(2)).out()

---

Oscillators

Basic Waveforms

(freq: ControlSignal = 220): AudioSignal

• sine
• tri
• square
• saw

sine(100).out()

FM Oscillators

(freq: ControlSignal = 220, harm: ControlSignal = 1, modi: ControlSignal = 1): AudioSignal

• fm
• fmsine
• fmtri
• fmsquare
• fmsaw

fmsaw(
    100,
    lfosaw(0.5,0.5,10),
    lfosine(0.25,1,10)
).out()

AM Oscillators

(freq: ControlSignal = 220, harm: ControlSignal = 1): AudioSignal

• am
• amsine
• amtri
• amsquare
• amsaw

fmsaw(
    lfosaw(0.125,100,1000),
    lfosaw(0.5,0.5,10),
    lfosine(0.25,1,10)
).out()

Pulse & PWM

• pulse(freq: ControlSignal, width: ControlSignal): AudioSignal
• pwm(freq: ControlSignal, modFreq: ControlSignal): AudioSignal

pwm(100, lfo(0.125,0.5,2)).out()

Fat Oscillators

(freq: ControlSignal = 220, spread: number = 10): AudioSignal

• fat
• fatsine
• fattri
• fatsquare
• fatsaw

---

Noise

(): AudioSignal

• white
• pink
• brown

---

LFOs

(frequency: ControlSignal, min: number = 0, max: number = 1): ControlSignal

• lfo
• lfosine
• lfotri
• lfosquare
• lfosaw

---

Envelopes

adsr

adsr(attack?: number, decay?: number, sustain?: number, release?: number): ControlSignal

Creates a ControlSignal controlled by an adsr envelope (all time values in milliseconds).

sine(100).amp(env()).out()

Envelopes must be triggered from outside the patch. See Basic Usage above.

---

Modifiers

amp

AudioSignal.amp(value: ControlSignal): Gain

Applies gain (amplitude) modulation.

sine(100).amp(lfo()).out()

---

Filters

saw(100).lpf(lfo(0.5,100,1000)).out()

hpf

AudioSignal.hpf(frequency?: ControlSignal, q?: ControlSignal, rolloff?: FilterRollOff): AudioSignal

High-pass filter.

lpf

AudioSignal.lpf(frequency?: ControlSignal, q?: ControlSignal, rolloff?: FilterRollOff): AudioSignal

Low-pass filter.

bpf

AudioSignal.bpf(frequency?: ControlSignal, q?: ControlSignal, rolloff?: FilterRollOff): AudioSignal

Band-pass filter.

fbf

AudioSignal.fbf(delayTime?: ControlSignal, resonance?: ControlSignal): AudioSignal

Feedback comb filter.

---

Effects

reverb

AudioSignal.reverb(wet?: ControlSignal, decay?: ControlSignal): AudioSignal

Reverb effect.

delay

AudioSignal.delay(wet?: ControlSignal, delayTime?: ControlSignal, feedback?: ControlSignal): AudioSignal

Feedback delay effect.

dist

AudioSignal.dist(wet?: ControlSignal, distortion?: ControlSignal): AudioSignal

Distortion effect.

chorus

AudioSignal.chorus(wet?: ControlSignal, frequency?: ControlSignal, feedback?: ControlSignal, depth?: ControlSignal): AudioSignal

Chorus effect.

---

Metering

---

follow

Envelope follower. In this example, we use the amplitude of the signal in the left channel to modulate the pitch of signal in the right channel.

stack(
    sine(100).amp(lfo()).out(0),
    sine(out(0).follow().multiply(1000).add(100)).amp(0.5).out(1),
)

Routing

pan

AudioSignal.pan(value?: ControlSignal): AudioSignal

Stereo panner. Values between -1 and 1. Converts the signal to stereo.

fm(100).pan(lfo(0.5,-1,1)).out()

out

AudioSignal.out(...channels: number[]): AudioSignal

Connects the parent node to the output at the given channel(s). All audio sources are mono until you use pan().

sine(200).amp(0.5).out() // uses channels 0 and 1 by default, but you only hear 1 channel
sine(200).amp(0.5).pan().out() // now you hear 2.
sine(200).pan(lfosquare(0.5,-1,1)).amp(0.5).out(0,1) // uses channels 0 and 1
sine(200).pan(lfosquare(0.5,-1,1)).amp(0.5).out(2,3) // use channels 2 and 3... etc.

Bus

AudioSignal.bus(...channels: number[]): AudioSignal When used as method, routes the signal to the bus at a given channel, then returns the original mode. out(...channels: number[]): AudioSignal

When used as a function, bus() uses audio routed through that bus as a source. A 10ms delay is applied to prevent feedback.

stack(
    sine(100).bus(0).out(0), // mono signal routed to bus 0 then played out of the left channel
    bus(0).out(1) // bus 0 as a source, routed out of the right channel
)

stack

(...nodes: AudioSignal[]): AudioSignal

Stack multiple audio graphs.

stack(...Array.from(Array(10).keys()).map(i => sine((i+1)*100).amp(0.1 / (i+1)))).pan().out()

---

s0.set({inst: 'zmod', graph: 'sine(100).amp(env(e)).out()', voices: 4})
s0.e.every(4)