mirror of
https://github.com/Tonejs/Tone.js
synced 2024-11-15 08:17:07 +00:00
updated examples and descriptions
This commit is contained in:
Yotam Mann
parent
3e14c63313
commit
1910ab842e
1 changed files with 107 additions and 38 deletions
145
README.md
145
README.md
|
|
@ -12,9 +12,9 @@ Tone.js is a Web Audio framework for creating interactive music in the browser.
|
|||
* [Jazz.Computer - Yotam Mann](http://jazz.computer/)
|
||||
* [motionEmotion - Karen Peng, Jason Sigal](http://motionemotion.herokuapp.com/)
|
||||
* [p5.sound - build with Tone.js](https://github.com/processing/p5.js-sound)
|
||||
* [Hypercube by @eddietree](http://eddietree.github.io/hypercube/)
|
||||
* [randomcommander.io by Jake Albaugh](http://randomcommander.io/)
|
||||
* [Tone.js + NexusUI by taylorbf](http://taylorbf.github.io/Tone-Rack/)
|
||||
* [Hypercube - @eddietree](http://eddietree.github.io/hypercube/)
|
||||
* [randomcommander.io - Jake Albaugh](http://randomcommander.io/)
|
||||
* [Tone.js + NexusUI - Ben Taylor](http://taylorbf.github.io/Tone-Rack/)
|
||||
* [Solarbeat - Luke Twyman](http://www.whitevinyldesign.com/solarbeat/)
|
||||
* [Wind - João Costa](http://wind.joaocosta.co)
|
||||
* [Block Chords - Abe Rubenstein](http://dev.abe.sh/block-chords/)
|
||||
|
|
@ -23,88 +23,157 @@ Tone.js is a Web Audio framework for creating interactive music in the browser.
|
|||
* [Calculaural - Matthew Hasbach](https://github.com/mjhasbach/calculaural)
|
||||
* [Scratch + Tone.js - Eric Rosenbaum](http://ericrosenbaum.github.io/tone-synth-extension/)
|
||||
* [Game of Reich - Ben Taylor](http://nexusosc.com/gameofreich/)
|
||||
* [Yume - Helios + Luke Twyman](http://www.unseen-music.com/yume/)
|
||||
|
||||
Using Tone.js? I'd love to hear it: yotammann@gmail.com
|
||||
|
||||
# Installation
|
||||
|
||||
Tone can be installed in a few of ways:
|
||||
|
||||
* Download Tone.js from Github - [full](https://raw.githubusercontent.com/Tonejs/Tone.js/master/build/Tone.js) | [min](https://raw.githubusercontent.com/Tonejs/Tone.js/master/build/Tone.min.js)
|
||||
* CDN - [full](http://cdn.tonejs.org/latest/Tone.js) | [min](http://cdn.tonejs.org/latest/Tone.min.js)
|
||||
* [bower](http://bower.io/) - `bower install tone`
|
||||
* [npm](https://www.npmjs.org/) - `npm install tone`
|
||||
|
||||
The fastest way to include Tone.js on your page is to use the CDN (hosted by [github pages](https://pages.github.com/)).
|
||||
|
||||
```html
|
||||
<script type="text/javascript" src="http://cdn.tonejs.org/latest/Tone.min.js"></script>
|
||||
```
|
||||
|
||||
It's always much safer to use a specific version rather than just "latest".
|
||||
|
||||
[Full Installation Instruction](https://github.com/Tonejs/Tone.js/wiki/Installation)
|
||||
|
||||
# Hello World
|
||||
# Hello Tone
|
||||
|
||||
```javascript
|
||||
//create one of Tone's built-in synthesizers and connect it to the master output
|
||||
var synth = new Tone.SimpleSynth().toMaster();
|
||||
|
||||
//play a middle c for the duratino of an 8th note
|
||||
//play a middle C for the duration of an 8th note
|
||||
synth.triggerAttackRelease("C4", "8n");
|
||||
```
|
||||
|
||||
# Tone.Transport
|
||||
|
||||
A unique feature of the library is the Transport which allows for application-wide synchronization of sources and signals with tempo curves and automation. The Transport allows you to register callbacks at precise moments along the timeline which are invoked right before the event with the exact time of the event.
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Transport).
|
||||
[SimpleSynth](http://tonejs.org/docs/#SimpleSynth) is a single oscillator, single envelope synthesizer. It's [ADSR envelope](https://en.wikipedia.org/wiki/Synthesizer#ADSR_envelope) has two phases: the attack and the release. These can be triggered by calling `triggerAttack` and `triggerRelease` separately, or combined as shown above. The first argument of `triggerAttackRelease` is the frequency, which can be given either a number (like `440`) or as "pitch-octave" notation (like `"D#2"`). The second argument is the duration of the envelope's sustain (i.e. how long the note is held for). The third (optional) argument of `triggerAttackRelease` is the time the attack should start. With no argument, the time will evaluate to "now" and play immediately. Passing in a time value let's you schedule the event in the future.
|
||||
|
||||
### Time
|
||||
|
||||
In the Tone library, time can be described in a number of ways. Any method which takes a time as a parameter will accept the number in seconds as well as a tempo-relative form.
|
||||
Any method which takes a time as a parameter will accept either 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. Any value prefixed with `"+"` will be added to the current time. To trigger the same note one measure from now:
|
||||
|
||||
For example to `"4n"` is a quarter-note and "4:2:0" is the third beat of the fifth measure (remember we're counting from 0).
|
||||
```javascript
|
||||
synth.triggerAttackRelease("C4", "8n", "+1m");
|
||||
```
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Time).
|
||||
[Read about Time encodings.](https://github.com/Tonejs/Tone.js/wiki/Time)
|
||||
|
||||
# Sources
|
||||
### Transport
|
||||
|
||||
Aside from the 4 basic oscillator types (sine, square, triangle, sawtooth), Tone.js provides a few other sources such as a buffer player (Tone.Player), a noise generator, and two additional oscillator types (pwm, pulse).
|
||||
Time expressions are evaluated against the Transport's BPM. [Tone.Transport](http://tonejs.org/docs/#Transport) is the master timekeeper, allowing for application-wide synchronization of sources, signals and events along a shared timeline. Callbacks scheduled with Tone.Transport will be invoked right before the scheduled time with the exact time of the event is passed in as the first parameter to the callback.
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Sources).
|
||||
```javascript
|
||||
//schedule a callback on the second beat of the first measure
|
||||
Tone.Transport.schedule(function(time){
|
||||
//schedule the synth's attackRelease using the passed-in time
|
||||
synth.triggerAttackRelease("C4", "8n", time);
|
||||
}, "1:2:0");
|
||||
|
||||
//start the transport
|
||||
Tone.Transport.start();
|
||||
```
|
||||
[Read more about scheduling events with the Transport.](https://github.com/Tonejs/Tone.js/wiki/Transport)
|
||||
|
||||
### Loops
|
||||
|
||||
Instead of scheduling events directly on the Transport, Tone.js provides a few higher-level classes for working with events. [Tone.Loop](http://tonejs.org/docs/#Loop) is a simple way to create a looped callback that can be scheduled to start and stop.
|
||||
|
||||
```javascript
|
||||
//play a note every quarter-note
|
||||
var loop = new Tone.Loop(function(time){
|
||||
synth.triggerAttackRelease("C2", "8n", time);
|
||||
}, "4n");
|
||||
|
||||
//loop between the first and fourth measures of the Transport's timeline
|
||||
loop.start("1m").stop("4m");
|
||||
```
|
||||
|
||||
Start the Transport to hear the looped notes:
|
||||
|
||||
```javascript
|
||||
Transport.start();
|
||||
```
|
||||
|
||||
[Read about Tone.js' Event classes.](https://github.com/Tonejs/Tone.js/wiki/Events)
|
||||
|
||||
# Instruments
|
||||
|
||||
Tone has a number of instruments which all inherit from Tone.Instrument, giving them the same API for triggering notes. These instruments are all monophonic and can be made polyphonic if they are passed into the second argument of [Tone.PolySynth](http://tonejs.org/docs/#PolySynth).
|
||||
Tone has a number of instruments which all inherit from the same [Instrument base class](http://tonejs.org/docs/#Instrument), giving them a common API for playing notes. [Tone.MonoSynth](http://tonejs.org/docs/#MonoSynth) is composed of one oscillator, one filter, and two envelopes connected to the amplitude and the filter frequency.
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Instruments).
|
||||
```javascript
|
||||
//pass in some initial values for the filter and filter envelope
|
||||
var monoSynth = new Tone.MonoSynth({
|
||||
"filter" : {
|
||||
"type" : "lowpass",
|
||||
"Q" : 7
|
||||
},
|
||||
"filterEnvelope" : {
|
||||
"attack" : 0.02,
|
||||
"decay" : 0.1,
|
||||
"sustain" : 0.2,
|
||||
"release" : 0.9,
|
||||
}
|
||||
}).toMaster();
|
||||
|
||||
//start the note "D3" one second from now
|
||||
simpleSynth.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](http://tonejs.org/docs/#PolySynth).
|
||||
|
||||
```javascript
|
||||
//a 4 voice MonoSynth
|
||||
var polySynth = new Tone.PolySynth(4, Tone.MonoSynth).toMaster();
|
||||
//play a chord
|
||||
polySimpleSynth.triggerAttackRelease(["C4", "E4", "G4", "B4"], "2n");
|
||||
```
|
||||
|
||||
[Read more about Instruments.](https://github.com/Tonejs/Tone.js/wiki/Instruments)
|
||||
|
||||
# Effects
|
||||
|
||||
Tone.js also has many stereo and mono effects. Each effect lets you change the ratio between the dry (unaffected) and wet signal.
|
||||
In the above examples, the synthesizer was always connected directly to the [master output](http://tonejs.org/docs/#Master), but the output of the synth could also be routed through one (or more) effects before going to the speakers.
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Effects).
|
||||
```javascript
|
||||
//create a distortion effect
|
||||
var distortion = new Tone.Distortion(0.4).toMaster();
|
||||
//connect a synth to the distortion
|
||||
synth.connect(distortion);
|
||||
```
|
||||
|
||||
[Read more about Effects](https://github.com/Tonejs/Tone.js/wiki/Effects)
|
||||
|
||||
# Sources
|
||||
|
||||
Tone has a few basic audio sources like [Tone.Oscillator](http://tonejs.org/docs/#Oscillator) which has sine, square, triangle, and sawtooth waveforms, a buffer player ([Tone.Player](http://tonejs.org/docs/#Player)), a noise generator ([Tone.Noise]((http://tonejs.org/docs/#Noise))), two additional oscillator types ([pwm](http://tonejs.org/docs/#PWMOscillator), [pulse](http://tonejs.org/docs/#PulseOscillator)) and [external audio input](http://tonejs.org/docs/#Microphone) (when [WebRTC is supported](http://caniuse.com/#feat=stream)).
|
||||
|
||||
```javascript
|
||||
//a pwm oscillator which is connected to the speaker and started right away
|
||||
var pwm = new Tone.PWMOscillator("Bb3").toMaster().start();
|
||||
```
|
||||
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Sources)
|
||||
|
||||
# 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 much latency and processing overhead. Instead, all signal math and logic let GainNodes and WaveShaperNodes do all of the work so that 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.
|
||||
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.
|
||||
|
||||
Read more about [signals](https://github.com/Tonejs/Tone.js/wiki/Signals).
|
||||
[Read more](https://github.com/Tonejs/Tone.js/wiki/Signals)
|
||||
|
||||
# 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 from within any Object extending Tone as `this.context`.
|
||||
|
||||
Tone also let's you set your own AudioContext using `Tone.setContext`.
|
||||
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](tonejs.github.io/MidiConvert/).
|
||||
To use MIDI files, you'll first need to convert them into a JSON format which Tone.js can understand using [MidiConvert](http://tonejs.github.io/MidiConvert/).
|
||||
|
||||
# Performance
|
||||
|
||||
Tone.js uses very few ScriptProcessorNodes. Nearly all of the Tone Modules find a native Web Audio component workaround, making extensive use of the GainNode and WaveShaperNode especially, which enables Tone.js to work well on both desktop and mobile browsers. While the ScriptProcessorNode is extremely powerful, it introduces a lot of latency and the potential for glitches more than any other node.
|
||||
Tone.js uses only one ScriptProcessorNode (in Tone.Meter). The rest of Tone's modules find a native Web Audio component workaround, making extensive use of the GainNode and WaveShaperNode especially, which enables Tone.js to work well on both desktop and mobile browsers. While the ScriptProcessorNode is extremely powerful, it introduces a lot of latency and the potential for glitches more than any other node.
|
||||
|
||||
# Contributing
|
||||
|
||||
There are many ways to contribute to Tone.js. Check out [this wiki](https://github.com/Tonejs/Tone.js/wiki/Contributing) if you're interested.
|
||||
|
||||
# References and Inspiration
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue