mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-29 04:53:10 +00:00
120 lines
2.8 KiB
JavaScript
120 lines
2.8 KiB
JavaScript
import Tone from "../core/Tone";
|
|
import "../core/Param";
|
|
import "../core/AudioNode";
|
|
|
|
/**
|
|
* @class Tone.Compressor is a thin wrapper around the Web Audio
|
|
* [DynamicsCompressorNode](http://webaudio.github.io/web-audio-api/#the-dynamicscompressornode-interface).
|
|
* Compression reduces the volume of loud sounds or amplifies quiet sounds
|
|
* by narrowing or "compressing" an audio signal's dynamic range.
|
|
* Read more on [Wikipedia](https://en.wikipedia.org/wiki/Dynamic_range_compression).
|
|
*
|
|
* @extends {Tone.AudioNode}
|
|
* @constructor
|
|
* @param {Decibels|Object} [threshold] The value above which the compression starts to be applied.
|
|
* @param {Positive} [ratio] The gain reduction ratio.
|
|
* @example
|
|
* var comp = new Tone.Compressor(-30, 3);
|
|
*/
|
|
Tone.Compressor = function(){
|
|
|
|
var options = Tone.defaults(arguments, ["threshold", "ratio"], Tone.Compressor);
|
|
Tone.AudioNode.call(this);
|
|
|
|
/**
|
|
* the compressor node
|
|
* @type {DynamicsCompressorNode}
|
|
* @private
|
|
*/
|
|
this._compressor = this.input = this.output = this.context.createDynamicsCompressor();
|
|
|
|
/**
|
|
* the threshold vaue
|
|
* @type {Decibels}
|
|
* @signal
|
|
*/
|
|
this.threshold = new Tone.Param({
|
|
"param" : this._compressor.threshold,
|
|
"units" : Tone.Type.Decibels,
|
|
"convert" : false
|
|
});
|
|
|
|
/**
|
|
* The attack parameter
|
|
* @type {Time}
|
|
* @signal
|
|
*/
|
|
this.attack = new Tone.Param(this._compressor.attack, Tone.Type.Time);
|
|
|
|
/**
|
|
* The release parameter
|
|
* @type {Time}
|
|
* @signal
|
|
*/
|
|
this.release = new Tone.Param(this._compressor.release, Tone.Type.Time);
|
|
|
|
/**
|
|
* The knee parameter
|
|
* @type {Decibels}
|
|
* @signal
|
|
*/
|
|
this.knee = new Tone.Param({
|
|
"param" : this._compressor.knee,
|
|
"units" : Tone.Type.Decibels,
|
|
"convert" : false
|
|
});
|
|
|
|
/**
|
|
* The ratio value
|
|
* @type {Number}
|
|
* @signal
|
|
*/
|
|
this.ratio = new Tone.Param({
|
|
"param" : this._compressor.ratio,
|
|
"convert" : false
|
|
});
|
|
|
|
//set the defaults
|
|
this._readOnly(["knee", "release", "attack", "ratio", "threshold"]);
|
|
this.set(options);
|
|
};
|
|
|
|
Tone.extend(Tone.Compressor, Tone.AudioNode);
|
|
|
|
/**
|
|
* @static
|
|
* @const
|
|
* @type {Object}
|
|
*/
|
|
Tone.Compressor.defaults = {
|
|
"ratio" : 12,
|
|
"threshold" : -24,
|
|
"release" : 0.25,
|
|
"attack" : 0.003,
|
|
"knee" : 30
|
|
};
|
|
|
|
/**
|
|
* clean up
|
|
* @returns {Tone.Compressor} this
|
|
*/
|
|
Tone.Compressor.prototype.dispose = function(){
|
|
Tone.AudioNode.prototype.dispose.call(this);
|
|
this._writable(["knee", "release", "attack", "ratio", "threshold"]);
|
|
this._compressor.disconnect();
|
|
this._compressor = null;
|
|
this.attack.dispose();
|
|
this.attack = null;
|
|
this.release.dispose();
|
|
this.release = null;
|
|
this.threshold.dispose();
|
|
this.threshold = null;
|
|
this.ratio.dispose();
|
|
this.ratio = null;
|
|
this.knee.dispose();
|
|
this.knee = null;
|
|
return this;
|
|
};
|
|
|
|
export default Tone.Compressor;
|
|
|