mirror of
https://github.com/Tonejs/Tone.js
synced 2024-11-16 16:48:00 +00:00
149 lines
4.1 KiB
JavaScript
149 lines
4.1 KiB
JavaScript
import Tone from "../core/Tone";
|
|
import "../component/AmplitudeEnvelope";
|
|
import "../component/FrequencyEnvelope";
|
|
import "../source/Noise";
|
|
import "../signal/Signal";
|
|
import "../component/Filter";
|
|
import "../instrument/Instrument";
|
|
|
|
/**
|
|
* @class Tone.NoiseSynth is composed of a noise generator (Tone.Noise), one filter (Tone.Filter),
|
|
* and two envelopes (Tone.Envelop). One envelope controls the amplitude
|
|
* of the noise and the other is controls the cutoff frequency of the filter.
|
|
* <img src="https://docs.google.com/drawings/d/1rqzuX9rBlhT50MRvD2TKml9bnZhcZmzXF1rf_o7vdnE/pub?w=918&h=242">
|
|
*
|
|
* @constructor
|
|
* @extends {Tone.Instrument}
|
|
* @param {Object} [options] the options available for the synth
|
|
* see defaults below
|
|
* @example
|
|
* var noiseSynth = new Tone.NoiseSynth().toMaster();
|
|
* noiseSynth.triggerAttackRelease("8n");
|
|
*/
|
|
Tone.NoiseSynth = function(options){
|
|
|
|
//get the defaults
|
|
options = Tone.defaultArg(options, Tone.NoiseSynth.defaults);
|
|
Tone.Instrument.call(this, options);
|
|
|
|
/**
|
|
* The noise source.
|
|
* @type {Tone.Noise}
|
|
* @example
|
|
* noiseSynth.set("noise.type", "brown");
|
|
*/
|
|
this.noise = new Tone.Noise(options.noise);
|
|
|
|
/**
|
|
* The amplitude envelope.
|
|
* @type {Tone.AmplitudeEnvelope}
|
|
*/
|
|
this.envelope = new Tone.AmplitudeEnvelope(options.envelope);
|
|
|
|
//connect the noise to the output
|
|
this.noise.chain(this.envelope, this.output);
|
|
this._readOnly(["noise", "envelope"]);
|
|
};
|
|
|
|
Tone.extend(Tone.NoiseSynth, Tone.Instrument);
|
|
|
|
/**
|
|
* @const
|
|
* @static
|
|
* @type {Object}
|
|
*/
|
|
Tone.NoiseSynth.defaults = {
|
|
"noise" : {
|
|
"type" : "white"
|
|
},
|
|
"envelope" : {
|
|
"attack" : 0.005,
|
|
"decay" : 0.1,
|
|
"sustain" : 0.0,
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Start the attack portion of the envelopes. Unlike other
|
|
* instruments, Tone.NoiseSynth doesn't have a note.
|
|
* @param {Time} [time=now] the time the attack should start
|
|
* @param {number} [velocity=1] the velocity of the note (0-1)
|
|
* @returns {Tone.NoiseSynth} this
|
|
* @example
|
|
* noiseSynth.triggerAttack();
|
|
*/
|
|
Tone.NoiseSynth.prototype.triggerAttack = function(time, velocity){
|
|
time = this.toSeconds(time);
|
|
//the envelopes
|
|
this.envelope.triggerAttack(time, velocity);
|
|
//start the noise
|
|
this.noise.start(time);
|
|
if (this.envelope.sustain === 0){
|
|
this.noise.stop(time + this.envelope.attack + this.envelope.decay);
|
|
}
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* Start the release portion of the envelopes.
|
|
* @param {Time} [time=now] the time the release should start
|
|
* @returns {Tone.NoiseSynth} this
|
|
*/
|
|
Tone.NoiseSynth.prototype.triggerRelease = function(time){
|
|
time = this.toSeconds(time);
|
|
this.envelope.triggerRelease(time);
|
|
this.noise.stop(time + this.envelope.release);
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* Sync the instrument to the Transport. All subsequent calls of
|
|
* [triggerAttack](#triggerattack) and [triggerRelease](#triggerrelease)
|
|
* will be scheduled along the transport.
|
|
* @example
|
|
* synth.sync()
|
|
* //schedule 3 notes when the transport first starts
|
|
* synth.triggerAttackRelease('8n', 0)
|
|
* synth.triggerAttackRelease('8n', '8n')
|
|
* synth.triggerAttackRelease('8n', '4n')
|
|
* //start the transport to hear the notes
|
|
* Transport.start()
|
|
* @returns {Tone.Instrument} this
|
|
*/
|
|
Tone.NoiseSynth.prototype.sync = function(){
|
|
this._syncMethod("triggerAttack", 0);
|
|
this._syncMethod("triggerRelease", 0);
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* Trigger the attack and then the release.
|
|
* @param {Time} duration the duration of the note
|
|
* @param {Time} [time=now] the time of the attack
|
|
* @param {number} [velocity=1] the velocity
|
|
* @returns {Tone.NoiseSynth} this
|
|
*/
|
|
Tone.NoiseSynth.prototype.triggerAttackRelease = function(duration, time, velocity){
|
|
time = this.toSeconds(time);
|
|
duration = this.toSeconds(duration);
|
|
this.triggerAttack(time, velocity);
|
|
this.triggerRelease(time + duration);
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* Clean up.
|
|
* @returns {Tone.NoiseSynth} this
|
|
*/
|
|
Tone.NoiseSynth.prototype.dispose = function(){
|
|
Tone.Instrument.prototype.dispose.call(this);
|
|
this._writable(["noise", "envelope"]);
|
|
this.noise.dispose();
|
|
this.noise = null;
|
|
this.envelope.dispose();
|
|
this.envelope = null;
|
|
return this;
|
|
};
|
|
|
|
export default Tone.NoiseSynth;
|
|
|