Overview

Wax is a browser-based audio synthesis environment inspired by Max and other data-flow programming systems.

By adding devices to a virtual workspace and connecting them together, you can create custom digital signal processing algorithms.

All devices communicate to each other with audio signals, similar to a modular synthesizer.

Here is a walkthrough video as a supplement to this documentation.

Getting started

Wax runs entirely in the browser. When you load the web page, the virtual workspace is empty except for two output devices at the bottom.

To view a list of all objects, press the "all devices" button. This will list each device along with a link to its below documentation.

Examples

In the top-left corner of the web app, there is an examples folder containing several pre-patched system states to demonstrate how elements can be connected together. Select any element from the dropdown to load that state.

Adding devices

Double-click or press 'n' to open the interface for adding a device to the workspace. Then begin typing to find the object you want to add. Press enter or click the add button to add the device to the workspace.

For device documentation, click the i button at the top of the device.

Creating connections

Creating connections between two devices will create a data flow between them at audio rate, from the output of the source device to the input of the target device. Device outputs are listed as buttons on the right of the device, and device inputs are listed as buttons on the left.

Deleting connections

On mouse-based devices, double-click on a connection to delete it. You can also single-click on a connection, and once it's highlighted, press delete to delete the connection. You an also delete multiple connections at once by click-dragging on the workspace to select them, and then pressing delete.

On touchscreen devices, a swipe action deletes connections. Touch the connection and once it's highlighted, while continuing to sustain the touch, swipe up or down to delete the connection.

Manipulating devices

Click-drag on the workspace to select multiple devices at once. Selected devices have a bold, white border. Selected devices are draggable to anywhere the workspace.

Deleting devices

When a device is selected, press delete or click the x button to delete the device.

Device parameters

Some devices have text inputs which allow the user to type in values to control the device. These text inputs accept numbers, JavaScript expressions that resolve to a number, or expressions in Facet that resolve to a number. Press enter to transmit the number or expression into the device, or if on a mobile device, press the regen button.

IMPORTANT: Many parameters are available via both the text input and as an audio rate data flow connection. In this case, the signal input takes precedence, and the corresponding text input will have no effect until the signal is disconnected.

As an example, here are several useful Facet commands, which allow you add tunable randomness to device parameters:

• choose(). For example: choose([1,2,34]) // each time it's regenerated, it will choose either 1,2,3, or 4
• rf(). For example: rf(-1,1) // random float between -1 and 1
• ri(). For example: ri(10,60) // random integer between 10 and 60

Regenerating device parameters

Some devices have a regen button which causes all device parameters to regenerate every time a signal connected to regen goes above 0.5. For static numbers, this will have no effect, but if the device parameter is written as Facet code, the resulting can be different each time it's generated.

For example, if you have a number device, and you enter ri(10,1000) for its value, then each time the regen signal goes above 0.5, the output from number will be a new, random integer between 10 and 1000. If you entered choose([2,3,4,6,8]) as its value, then the output from number would be either 2, 3, 4, 6, or 8.

IMPORTANT: inputs will not regenerate while the cursor is inside of it (unless you press [enter]). After modifying an input, click outside of it to begin regenerating.

Key combinations

• create new device: n
• duplicate selected device(s): [command] + d
• delete selected device(s): delete
• create number device: f
• create comment device: c
• create toggle device: t
• create slider device: s
• create button device: b

Managing state

In Wax, system states can be saved, reloaded, and shared.

Sharing a state

Press the share URL button to copy the system state to your clipboard as a URL. NOTE: audio files will not be included and need to be sent separately.

Saving a state

Press the save button to save the system state as a zip file, including all audio files that were loaded.

Loading state

Press the load button to load a previously saved .zip file, including all audio files.

Collaboration

Wax supports real-time collaboration, allowing multiple users to work together on the same workspace in real time. This feature is ideal for collaborative sound design, teaching, or sharing ideas with others.

Creating a New Room

1. Click the Collab button in the top navigation bar.
2. In the modal window that appears, click the Create Room button.
3. A new room will be created with a randomly generated name, and you will automatically join it.
4. Share the URL of the room with others to invite them to collaborate.

Joining an Existing Room

1. Click the Collab button in the top navigation bar.
2. In the modal window that appears, enter the name of the room you want to join in the Join Room input field.
3. Click the Join Room button to connect to the room.
4. Alternatively, you can join a room directly by appending ?room=<roomName> to the URL and loading the page.

Locking the workspace

Press the Lock button to lock all objects in place and prevent accidental dragging. You can still interact with all UI elements but cannot create and delete connections or objects. This is especially helpful when interacting with UI elements on touchscreen devices. Whether a workspace is locked is stored as part of the system state which is shareable as a URL or zip file.

Creating custom devices

It is possible to create custom Wax devices that run as Web Audio API AudioWorklets. The js/customWorklets directory has two examples: complexity and fftshift, which are both available as Wax devices.

1. Add a new entry to the js/wasmDeviceURLs.js array, including a worklet property for your device. For example:

{
        "fileName": "fftshift",
        "displayName": "fftshift",
        "worklet": "fftshift"
}

2. Add your AudioWorklet file to the js/customWorklets directory. The file's class name (e.g., complexity, fftshift) should be the same as its worklet property in the js/wasmDeviceURLs.js entry from step 1. Be sure to include the numberOfInputs(), numberOfOutputs(), inputNames(), outputNames(), processorName(), constructor(), and registerProcessor() functions as they are implemented in the example files. These are necessary for the device to show up and function properly in the Wax workspace. Then, implement the core DSP of the AudioWorklet in the process() function.

Device reference

absolute

Computes the absolute value of the input signal.

add

Adds input 1 to input 2.

envelope

Generates an attack-decay-release envelope every time trigger in goes above 0.5.

• attack (ms): the number of milliseconds to reach the envelope peak.
• decay (ms): the number of miliseconds to go from the envelope peak to the level value.
• level: the maximum value that the envelope reaches.
• release (ms): the number of milliseconds to go from the levelvalue to silence.

allpass

Applies an allpass filter to input.

• delay (ms) controls the delay of the allpass filter.

and

Computes the logical AND of input 1 input 2.

bandpass

Applies a band-pass filter to input.

• cutoff controls the center frequency of the filter.
• q controls the resonance of the filter at the cutoff.

buffer

Loads an audio buffer into the workpace so it can be accessed by the pattern object via the sample() Facet method.

button

Outputs a 1 while the button is pressed and otherwise outputs 0.

change

Compares the current sample with the previous sample value in input and returns 1 if the current sample value increased, -1 if it decreased, and 0 if it stayed the same. difference outputs the difference between the current input and the input 1 sample ago.

clip

Clips any values in input 1 below minimum or above maximum to be equal to minimum and maximum, respectively.

clock

Returns metronomic subdivisions of tempo (ms). Each outlet runs at a different, increasingly faster speed.

comb

Applies a comb filter effect to input. feedback expect a range of floats 0 - 1.

comment

Stores text in the workspace which can be saved and loaded as part of system presets.

complexity

Outputs a signal that represents the complexity of the input signal. Complexity is measured by counting the iterations neded to reduce the signal to a constant sequence, thereby indicating the signal's compressibility. Highly repetitive signals such as silence and oscillations produce lower values, whereas audio samples, noise, and systems with high feedback levels produce higher values.

cross

Imparts the spectral envelope of modulator onto carrier.

counter

Counts upwards from 0 to maximum, incrementing every time trigger goes above 0.5. hit maximum will output a 1 while the counter is at its maximum and a 0 otherwise.

delay

Applies a delay effect to input, lasting delay time (ms) and feeding back based on feedback.

• wet controls dry/wet balance and expects a range of floats 0 - 1.

divide

Divides input 1 and input 2.

downsample

Downsamples input by amount, which expects a range of floats 0 - 1. Higher amount values produce more downsampling.

drunk

Generates a new value in a random walk of values between 0 and maximum, with step being the maximum value between each step, every time trigger goes above 0.5.

equals

Computes the logical EQUALS of input 1 input 2.

fftfilter

Applies a FFT-based bandpass filter to input, passing only frequencies between low and high.

fftgate

Applies a FFT-based bin threshold gate to input, passing only FFT bin frequencies higher than threshold. Values for threshold are normalized and clipped between 0 and 1.

fftfilter

Applies FFT-based bin shifting to input, moving all frequency bins upwards or downwards by shiftAmount bins.

fold

Folds any values in input 1 below minimum or above maximum. If the input value exceeds maximum, the output will be the amount above subtracted from maximum. If the input value is below minimum, the output will be the amount below added to from minimum.

ftom

Converts an input value of frequency in hz to its corresponding MIDI note number.

granular

Generates grains lasting size (ms) from a loaded audio file, starting at the position point, which expects a float between 0 - 1. A new grain will generate every time trigger goes above 0.5.

greater

Computes the boolean representation of whether input 1 is greater than input 2.

highpass

Applies a high-pass filter to input.

• cutoff controls the center frequency of the filter.
• q controls the resonance of the filter at the cutoff.

hztoms

Converts an input value in hz to its equivalent number in milliseconds.

hztosamps

Converts an input value in hz to its equivalent number in samples.

input

Returns the first two channels of the browser's default audio input device as a signal. If the microphone has one output channel, that channel will be available on output 1.

This feature is experimental because each browser's implementation of the web audio API is different. Some combinations of browser and audio input device may not work. Before loading the page, set the default audio input device for the browser.

NOTE: if audio is muted when a microphone is added, audio will resume so that the microphone is created correctly.

keyboard

Outputs the frequency (in Hz) of the selected note. The root note defaults to 60 (middle C) but can be configured to any MIDI note number. Click-drag or touch a key to select a new note.

The trigger output generates a 100ms trigger every time a new note is played.

less

Computes the boolean representation of whether input 1 is greater than input 2.

limiter

Applies a peak-limiter to input 1.

lowpass

Applies a low-pass filter to input.

• cutoff controls the center frequency of the filter.
• q controls the resonance of the filter at the cutoff.

midicc

Receives MIDI Control Change (CC) messages at the specified CC# on the specified channel. CC values are automatically scaled between 0 and 1.

midinote

Receives MIDI Note messages on the specified channel. Note values are transmitted at the corresponding frequency in Hz; e.g., a MIDI note of 69 produces a 440.

The midinote device supports up to 8 voices. When a new note is received, it will be assigned to the first unoccupied voice. If all voices are occupied, the device will steal the first voice (voice 1) and assign the new note to it. This ensures that new notes are always played, even if it means interrupting an existing note.

Each voice has a corresponding gate outlet, which transmits a 1 when the note is on (sustained) and a value of 0 when the note is off.

midipitchbend

Receives MIDI Pitch Bend messages on the specified channel. Pitch bend values are automatically scaled between -1 and 1.

mix

Mixes input 1 and input 2 together using a crossfade parameter between 0 and 1. A crossfade value of 0.5 will mix the signals together equally, and a crossfade value of 0 or 1 will return only the signal at that input.

motion

Outputs two floats between 0 and 1 corresponding to the orientation in space of the computer on which Wax is running.

• The pitch outlet returns the computer's tilt upwards or downwards. Resting flat with the screen facing up produces a 0. A vertical position either in either direction produces a 0.5. Resting flat with the screen facing down produces a 1.
• The roll outlet returns the computer's rotational position around its front-to-back axis and works similarly to pitch.
• NOTE: this device is only available on mobile devices which report device motion data via DeviceMotionEvents.

mstohz

Converts an input value in ms to its equivalent number in hz.

mstosamps

Converts an input value in ms to its equivalent number in samples.

mtof

Converts an input value of a MIDI note number to its corresponding frequency in hz.

modulo

Computes the modulo operand of input.

multiply

Multiplies input 1 and input 2.

noise

Generates white noise.

not

Computes the logical NOT of input 1.

number

Returns value as a signal.

or

Computes the logical OR of input 1 input 2.

overdrive

Overdrives input by amount, which expects a range of floats 0 - 1. Higher amount values produce more distortion.

output

Connects the audio stream to the computer's selected audio output device on channel channel. NOTE: if you change want to use a different audio output device, you will need to reload the page. Make sure to save your state beforehand so you can reload it.

pattern

Generates a customizable wavetable using Facet, a live coding language based in JavaScript.

• phase values between 0 and 1 select a corresponding relative position in the wavetable. That data is outputted via the output (phase) outlet.
• Every time trigger goes above 0.5, the entire wavetable will be outputted at audio-rate via the output (trigger) outlet.
• Every time the [ctrl] + enter key combonation is pressed, the pattern will reevaluate.
• [ctrl] + f will reformat the code.
• The size outlet returns a signal corresponding to the number of samples in the pattern.
• NOTE: FacetPatterns must be initialized with _. So the all pattern devices should have code looking like the following examples, which are all valid:
  • _.noise(16)
  • _.ramp(100,30,32).key('c','minor').mtof()
  • _.from([20,40,40,80,80,80,80,160,160,160,160,160,160,160,160]).shuffle().palindrome()

phasor

Generates a phasor between 0 and 1, oscillating at frequency.

pitchshift

Applies a time-domain frequency shift effect of shift amt to input. A shift amt of 2 will be twice as high frequency.

play

Plays a loaded audio file at rate every time trigger goes above 0.5.

• The sync outlet signal is the current playback position normalized between 0 and 1. A nonzero loop input will loop file playback.
• The start pos and end pos values control the relative start and end point of audio file playback and expect values between 0 and 1.

pluck

Generates a synthetic string pluck at frequency Hz using Karplus-Strong synthesis. damping controls how long the string resonates and expects values between 0 and 1.

print

Displays the current value of input every 10ms, along with a side-scrolling representation of values over the last few seconds. scope min and scope max control the range of the visualation.

quantizer

Scales an incoming signal of MIDI note numbers (0-127) onto the the scale defined in the user interface.

random

Returns a random number between minimum and maximum, every time trigger goes above 0.5.

record

Records input 1 and input 2 to a stereo audio buffer for length (seconds) seconds.

• A signal that rises above 0.5 in start/stop will start the recording, and a signal that falls below 0.5 will stop it. You can use a toggle UI element to control start/stop.
• To export the last recording, send a signal that rises above 0.5 to save. You can use a button UI element to control save.

rectangle

Generates a rectangle wave between -1 and 1, oscillating at frequency and with configurable pulsewidth.

reverb

Applies a reverb effect to input.

• feedback controls feedback of the delay lines.
• size functions as a coefficient, multiplying all delay line times and expects a range of floats 0 - 1.
• wet controls dry/wet balance and expects a range of floats 0 - 1.

rotator

Rotates the 4 input signals rightwards every time trigger goes above 0.5. In other words, input 1 will cyclically move from its initial output position at output 1, to output 2, then output 3, and finally output 4 before wrapping back to output 1 again.

round

Rounds input to the nearest integer.

samp&hold

Applies a sample-and-hold effect to input, holding its value every time trigger goes above 0.5.

sampstohz

Converts an input value in samples to its equivalent number in hz.

sampstoms

Converts an input value in samples to its equivalent number in ms.

sawtooth

Generates a sawtooth wave between -1 and 1, oscillating at frequency.

scale

Translates input into a different number range.

• low in is the minimum value in input.
• high in is the maximum value in input.
• low out is the minimum value desired in the output.
• high out is the minimum value desired in the output.
• exponent scales the output range according to an exponential curve and should be greater than or equal to 1.

scope

Displays the input signal as a waveform in an oscilloscope. scope min and scope max control the amplitude range of the oscilloscope. block size controls the number of samples in the total history of the oscilloscope, and it must be a power of 2 between 32 and 32768.

sequencer

Advances to the next step in a sequence of sliders every time a signal connected to the clock inlet goes above 0.5. When a signal connected to the reset inlet goes above 0.5, the sequence will immediately reset to the first step. The output (clock) signal produces the slider value for the current step, with slider ranges between 0 - 1. The step index outlet outputs the current step number. Steps are zero-based, so the first step = step 0. The step trigger outlet outputs an impulse if the checkbox for the current step is checked.

The phase inlet expects a signal between 0 and 1 and outputs the slider value in that relative position via the output (phase) outlet. In other words, a 0 outputs the first slider's value; a 0.5 outputs the middle slider; a 1 outputs the last slider; etc.

The steps control changes the number of steps in the sequence.

The random inlet controls a slider randomization process that can also be run manually via the randomize button. % random controls the percentage of sliders that will randomize. % intensity controls the intensity of randomization.

sine

Generates a sine wave between -1 and 1, oscillating at frequency. The phase of the sine wave can be modified at signal-rate with phase,which will be added to the frequency parameter.

skipper

Decides whether to pass or mute input every time input goes above 0.1, based on prob.

slider

Outputs a float between 0 and 1. Move the slider to change the offset.

smooth

Smooths input by ramping from its previous value to its new value, ramping up over up (ms) and down over down (ms). exponent controls the contour of the ramp: at 0, the ramp moves linearly to the new value, and at 1, the ramp moves logarithmically.

snapshot

Slows input down so it only changes once for every interval (ms) that passes.

spectrogram

Displays the input signal in the frequency domain as a spectrogram. block size controls the frequency resolution of the spectrogram, and it must be a power of 2 between 32 and 32768.

squareroot

Computes the square root of input 1.

steptrig

Generates a 30ms trigger impulse whenever the step value matches a value in the text input. Values can be entered as integers, arrays, or FacetPatterns (for more information on Facet, please see the pattern object and Facet documentation.

A value of [1,2,7] will generate a trigger when the step input receives a 1, 2, or 7 signal.

A value of 4 will generate a trigger when the step input receives a 4 signal.

A value of _.ramp(0,8,8).shuffle().reduce(4) will generate triggers for a random group of 4 integers between 0 and 7.

stutter

Repeats chunks of the incoming audio signal. Every time a signal connected to trigger goes above 0.5, a new grain will play back from the recent incoming audio stream with a duration of grain (ms). memory (ms) controls the length of the buffer of incoming audio that just happened and is clipped to a range of 500ms - 1000ms. Grains are clipped to a maximum value equal to memory (ms). If loop to a nonzero value, the last-generated grain will repeat itself until the next grain is generated by another trigger.

subtract

Subtracts input 2 from input 1.

toggle

Outputs a 0 when the button is off and outputs a 1 when the button is on. Click the button to switch states.

touchpad

Outputs two floats between 0 and 1, corresponding to the selected x/y position in a 2D touchpad.

triangle

Generates a triangle wave between -1 and 1, oscillating at frequency and with configurable slope.

wavetable

Reads through a loaded audio file like a wavetable, with phase values between 0 and 1 selecting a corresponding relative position in the audio file.

wrap

Wraps any values in input 1 below minimum or above maximum. If the input value exceeds maximum, the output will be the amount exceeded plus minimum . If the input value is below minimum, the output will be the amount below subtracted from maximum.

• The size outlet returns a signal corresponding to the number of samples in the pattern.