Skip to content

Latest commit

 

History

History
161 lines (121 loc) · 6.6 KB

effects.md

File metadata and controls

161 lines (121 loc) · 6.6 KB

The effects

level, reverb, echo, lpf, hpf, distortion, pan, slicer, compressor, chorus, bitcrusher, tremolo, rlpf, bpf, flanger, wobble, ping_pong, pitch_shift.

What every effect takes

Besides its own options, every effect takes these.

Option Takes Default What it does
mix a number, 0 to 1 1 How much of the processed sound replaces the dry one.
pre_amp a number, 0 to 16 1 The level the sound is scaled by before the effect.
amp a number, 0 to 16 1 The level the blend is scaled by.

level

reverb

Option Takes Default What it does
room a number, 0 to 1 0.6 How big the room is.
damp a number, 0 to 1 0.5 How much the room dulls the high frequencies.

echo

Option Takes Default What it does
phase seconds, 0 or more 0.25 The time between echoes.
decay seconds 2 How long the echoes take to die away.
max_phase seconds, 0 to 60 2 The longest phase it can change to.

lpf

Option Takes Default What it does
cutoff a MIDI note 100 The MIDI note above which it cuts.

hpf

Option Takes Default What it does
cutoff a MIDI note 100 The MIDI note below which it cuts.

distortion

Option Takes Default What it does
distort a number, 0 to 1 0.5 How hard it drives the sound.

pan

Option Takes Default What it does
pan a number, -1 to 1 0 Where it turns the sound, from -1, left, to 1, right.

slicer

Option Takes Default What it does
phase seconds, 0 or more 0.25 The length of a cycle.
phase_offset a number, 0 to 1 0 Where in the cycle it starts.
pulse_width a number, 0 to 1 0.5 The part of the cycle that is on.
amp_min a number 0 The level while off.
amp_max a number 1 The level while on.
smooth seconds, 0 or more 0 How many seconds each change takes.

compressor

Option Takes Default What it does
threshold a number, 0.0001 or more 0.2 The level above which it lowers the sound.
slope_below a number 1 How much the level changes below the threshold.
slope_above a number 0.5 How much the level changes above the threshold.
clamp_time seconds, 0 or more 0.01 How many seconds it takes to lower the sound.
relax_time seconds, 0 or more 0.01 How many seconds it takes to let go.

chorus

Option Takes Default What it does
phase seconds, 0 or more 0.25 How long the delay takes to sweep back and forth.
decay seconds 0.00001 How long the delayed sound feeds back.
max_phase seconds, 0 to 60 1 The longest phase it can change to.

bitcrusher

Option Takes Default What it does
sample_rate hertz, 1 or more 10000 The rate in Hz it holds samples at.
bits a number, 1 to 24 8 How many bits it rounds each sample to.
cutoff a MIDI note 0 A MIDI note for a low-pass after it, off at 0.

tremolo

Option Takes Default What it does
phase seconds, 0 or more 4 How long one sweep takes.
wave a number, 0 to 4 2 The sweep's shape: 0 saw, 1 pulse, 2 triangle, 3 sine and 4 cubic.
invert_wave a number, 0 to 1 0 1 flips the sweep.
phase_offset a number, 0 to 1 0 Where in the sweep it starts.
depth a number, 0 to 1 0.5 How far it turns the sound down.

rlpf

Option Takes Default What it does
cutoff a MIDI note 100 The MIDI note above which it cuts.
res a number, 0 to 1 0.5 How much it rings at its cutoff.

bpf

Option Takes Default What it does
centre a MIDI note 100 The MIDI note of the band it keeps.
res a number, 0 to 1 0.6 How narrow the band is.

flanger

Option Takes Default What it does
phase seconds, 0 or more 4 How long one sweep takes.
wave a number, 0 to 4 4 The sweep's shape: 0 saw, 1 pulse, 2 triangle, 3 sine and 4 cubic.
invert_wave a number, 0 to 1 0 1 flips the sweep.
phase_offset a number, 0 to 1 0 Where in the sweep it starts.
stereo_invert_wave a number, 0 to 1 0 1 sweeps the left channel the other way.
delay a number 5 The delay in milliseconds it sweeps up from.
depth a number 5 How far in milliseconds it sweeps.
max_delay a number, 1 to 1000 20 The longest delay in milliseconds.
feedback a number, 0 to 1 0 How strongly the delayed sound feeds back.
decay seconds 2 How long the delayed sound feeds back.
invert_flange a number, 0 to 1 0 1 subtracts the delayed sound instead.

wobble

Option Takes Default What it does
phase seconds, 0 or more 0.5 How long one sweep takes.
wave a number, 0 to 4 0 The sweep's shape: 0 saw, 1 pulse, 2 triangle, 3 sine and 4 cubic.
invert_wave a number, 0 to 1 0 1 flips the sweep.
phase_offset a number, 0 to 1 0 Where in the sweep it starts.
pulse_width a number, 0 to 1 0.5 The part of a cycle that is up, for wave 1.
cutoff_min a MIDI note 60 The MIDI note the filter sweeps down to.
cutoff_max a MIDI note 120 The MIDI note the filter sweeps up to.
res a number, 0 to 1 0.8 How much the filter rings at its cutoff.
filter a number, 0 to 1 0 0 for a low-pass and 1 for a high-pass.

ping_pong

Option Takes Default What it does
phase seconds, 0.001 or more 0.25 The time between echoes.
feedback a number, 0 to 0.999 0.5 How much of each echo the next keeps.
max_phase seconds, 0.01 to 60 1 The longest phase it can change to.
pan_start a number, -1 to 1 1 The side of the first echo, from -1, left, to 1, right.

pitch_shift

Option Takes Default What it does
pitch a number, -24 to 24 0 How many semitones the sound is shifted by; the effect delays the sound by up to 40 ms.