mirror of
https://github.com/Tonejs/Tone.js
synced 2024-11-16 16:48:00 +00:00
94 lines
No EOL
2.3 KiB
JavaScript
94 lines
No EOL
2.3 KiB
JavaScript
define(["Tone/core/Tone", "Tone/core/Master", "Tone/core/Note"], function(Tone){
|
|
|
|
"use strict";
|
|
|
|
/**
|
|
* @class Base-class for all instruments
|
|
*
|
|
* @constructor
|
|
* @extends {Tone}
|
|
*/
|
|
Tone.Instrument = function(options){
|
|
|
|
//get the defaults
|
|
options = this.defaultArg(options, Tone.Instrument.defaults);
|
|
|
|
/**
|
|
* the output
|
|
* @type {GainNode}
|
|
* @private
|
|
*/
|
|
this.output = this.context.createGain();
|
|
|
|
/**
|
|
* The volume of the instrument.
|
|
* @type {Decibels}
|
|
* @signal
|
|
*/
|
|
this.volume = new Tone.Signal({
|
|
"param" : this.output.gain,
|
|
"units" : Tone.Type.Decibels,
|
|
"value" : options.volume
|
|
});
|
|
this._readOnly(["volume"]);
|
|
};
|
|
|
|
Tone.extend(Tone.Instrument);
|
|
|
|
/**
|
|
* the default attributes
|
|
* @type {object}
|
|
*/
|
|
Tone.Instrument.defaults = {
|
|
/** the volume of the output in decibels */
|
|
"volume" : 0
|
|
};
|
|
|
|
/**
|
|
* @abstract
|
|
* @param {string|number} note the note to trigger
|
|
* @param {Time} [time=now] the time to trigger the ntoe
|
|
* @param {number} [velocity=1] the velocity to trigger the note
|
|
*/
|
|
Tone.Instrument.prototype.triggerAttack = Tone.noOp;
|
|
|
|
/**
|
|
* @abstract
|
|
* @param {Time} [time=now] when to trigger the release
|
|
*/
|
|
Tone.Instrument.prototype.triggerRelease = Tone.noOp;
|
|
|
|
/**
|
|
* Trigger the attack and then the release after the duration.
|
|
* @param {Frequency} note The note to trigger.
|
|
* @param {Time} duration How long the note should be held for before
|
|
* triggering the release.
|
|
* @param {Time} [time=now] When the note should be triggered.
|
|
* @param {NormalRange} [velocity=1] The velocity the note should be triggered at.
|
|
* @returns {Tone.Instrument} this
|
|
* @example
|
|
* //trigger "C4" for the duration of an 8th note
|
|
* synth.triggerAttackRelease("C4", "8n");
|
|
*/
|
|
Tone.Instrument.prototype.triggerAttackRelease = function(note, duration, time, velocity){
|
|
time = this.toSeconds(time);
|
|
duration = this.toSeconds(duration);
|
|
this.triggerAttack(note, time, velocity);
|
|
this.triggerRelease(time + duration);
|
|
return this;
|
|
};
|
|
|
|
/**
|
|
* clean up
|
|
* @returns {Tone.Instrument} this
|
|
*/
|
|
Tone.Instrument.prototype.dispose = function(){
|
|
Tone.prototype.dispose.call(this);
|
|
this._writable(["volume"]);
|
|
this.volume.dispose();
|
|
this.volume = null;
|
|
return this;
|
|
};
|
|
|
|
return Tone.Instrument;
|
|
}); |