| build | ||
| examples | ||
| gulp | ||
| test | ||
| Tone | ||
| .gitignore | ||
| .jshintrc | ||
| .travis.yml | ||
| bower.json | ||
| CHANGELOG.md | ||
| LICENSE.md | ||
| package.json | ||
| README.md | ||
Tone.js
Tone.js is a Web Audio framework for creating interactive music in the browser. The architecture of Tone.js aims to be familiar to both musicians and audio programmers looking to create web-based audio applications. On the high-level, Tone offers common DAW (digital audio workstation) features like a global transport for scheduling events and prebuilt synths and effects. For signal-processing programmers (coming from languages like Max/MSP), Tone provides a wealth of high performance, low latency building blocks and DSP modules to build your own synthesizers, effects, and complex control signals.
Demos
- Chrome Music Lab - Google Creative Lab
- Groove Pizza - NYU Music Experience Design Lab
- Jazz.Computer - Yotam Mann
- motionEmotion - Karen Peng, Jason Sigal
- p5.sound - build with Tone.js
- Hypercube - @eddietree
- Musical Chord Progression Arpeggiator - Jake Albaugh
- Tone.js + NexusUI - Ben Taylor
- Solarbeat - Luke Twyman
- Block Chords - Abe Rubenstein
- This is Not a Machine Learning - David Karam
- Calculaural - Matthew Hasbach
- Scratch + Tone.js - Eric Rosenbaum
- Game of Reich - Ben Taylor
- Yume - Helios + Luke Twyman
- TR-808 - Gregor Adams
- Tweet FM - Mike Mitchell
- TextXoX - Damon Holzborn
- Stepping - John Hussey
- Limp Body Beat
- MsCompose 95 - Autotel
- Pedalboard - Micha Hanselmann
- Keyboard Boogie - Douglas Tarr
- Reflect - Sydneyzh
- Anxiety - Eve Weinberg, Aaron Montoya-Moraga
- Ramsophone - Robert Vinluan
Using Tone.js? I'd love to hear it: yotam@tonejs.org
Installation
Hello Tone
//create a synth and connect it to the master output (your speakers)
var synth = new Tone.Synth().toMaster();
//play a middle 'C' for the duration of an 8th note
synth.triggerAttackRelease("C4", "8n");
Tone.Synth
Tone.Synth is a basic synthesizer with a single oscillator and an ADSR envelope.
triggerAttackRelease
The "attack" of an envelope is the period when the amplitude is rising, and the "release" is when it is falling back to 0. These two methods can be invoked separately as triggerAttack and triggerRelease, or combined as shown above. The first argument is the frequency which can either be a number (like 440) or as "pitch-octave" notation (like "D#2"). The second argument is how long the note should be held before triggering the release phases. An optional third argument schedules the event for some time in the future. With no third argument, the note will play immediately.
Time
In the examples above, instead of using the time in seconds (for an 8th note at 120 BPM it would be 0.25 seconds), any method which takes time as an argument can accept a number or a string. Numbers will be taken literally as the time in seconds and strings can encode time expressions in terms of the current tempo. For example "4n" is a quarter-note, "8t" is an eighth-note triplet, and "1m" is one measure.
Scheduling
Transport
Tone.Transport is the master timekeeper, allowing for application-wide synchronization of sources, signals and events along a shared timeline. Time expressions (like the ones above) are evaluated against the Transport's BPM which can be set like this: Tone.Transport.bpm.value = 120.
Loops
Tone.js provides higher-level abstractions for scheduling events. Tone.Loop is a simple way to create a looped callback that can be scheduled to start and stop.
//play a note every quarter-note
var loop = new Tone.Loop(function(time){
synth.triggerAttackRelease("C2", "8n", time);
}, "4n");
Since Javascript timing is not sample-accurate, the precise time of the event is passed into the callback function. This time should be used to schedule events within the loop.
You can then start and stop the loop along the Transport's timeline.
//loop between the first and fourth measures of the Transport's timeline
loop.start("1m").stop("4m");
Then start the Transport to hear the loop:
Tone.Transport.start();
Read about Tone.js' Event classes and scheduling events with the Transport.
Instruments
Tone has a number of instruments which all inherit from the same Instrument base class, giving them a common API for playing notes. Tone.Synth is composed of one oscillator and an amplitude envelope.
//pass in some initial values for the filter and filter envelope
var synth = new Tone.Synth({
"oscillator" : {
"type" : "pwm",
"modulationFrequency" : 0.2
},
"envelope" : {
"attack" : 0.02,
"decay" : 0.1,
"sustain" : 0.2,
"release" : 0.9,
}
}).toMaster();
//start the note "D3" one second from now
synth.triggerAttack("D3", "+1");
All instruments are monophonic (one voice) but can be made polyphonic when the constructor is passed in as the second argument to Tone.PolySynth.
//a 4 voice Synth
var polySynth = new Tone.PolySynth(4, Tone.Synth).toMaster();
//play a chord
polySynth.triggerAttackRelease(["C4", "E4", "G4", "B4"], "2n");
Effects
In the above examples, the synthesizer was always connected directly to the master output, but the output of the synth could also be routed through one (or more) effects before going to the speakers.
//create a distortion effect
var distortion = new Tone.Distortion(0.4).toMaster();
//connect a synth to the distortion
synth.connect(distortion);
Sources
Tone has a few basic audio sources like Tone.Oscillator which has sine, square, triangle, and sawtooth waveforms, a buffer player (Tone.Player), a noise generator (Tone.Noise), a few additional oscillator types (pwm, pulse, fat, fm) and external audio input (when WebRTC is supported).
//a pwm oscillator which is connected to the speaker and started right away
var pwm = new Tone.PWMOscillator("Bb3").toMaster().start();
Signals
Like the underlying Web Audio API, Tone.js is built with audio-rate signal control over nearly everything. This is a powerful feature which allows for sample-accurate synchronization of multiple parameters with a single signal. Signals are built entirely without the ScriptProcessorNode so they do not introduce minimal processing overhead and no latency. Instead, this signal math and logic lets the native Web Audio GainNodes and WaveShaperNodes do all of the work meaning all processing is done in the underlying Assembly/C/C++ provided by the API. Signals are used extensively internally and are also useful for general DSP and control signal logic and transformations.
AudioContext
Tone.js creates an AudioContext when it loads and shims it for maximum browser compatibility. The AudioContext can be found at Tone.context. Or set your own AudioContext using Tone.setContext(audioContext).
MIDI
To use MIDI files, you'll first need to convert them into a JSON format which Tone.js can understand using MidiConvert.
Performance
Tone.js makes extensive use of the native Web Audio Nodes such as the GainNode and WaveShaperNode for all signal processing, which enables Tone.js to work well on both desktop and mobile browsers. It uses no ScriptProcessorNodes.
Contributing
There are many ways to contribute to Tone.js. Check out this wiki if you're interested.
If you have questions (or answers) that are not necessarily bugs/issues, please post them to the forum.