Tone.js/Tone/component/DryWet.js

define(["Tone/core/Tone", "Tone/signal/Signal", "Tone/signal/Expr"], function(Tone){

	"use strict";

	/**
	 * @class  dry/wet knob.
	 *         equal power fading control values:
	 * 	       0 = 100% wet  -    0% dry
	 * 	       1 =   0% wet  -  100% dry
	 *
	 * @constructor
	 * @extends {Tone}
	 * @param {number} [initialDry=0.5]
	 */		
	Tone.DryWet = function(initialDry){
		Tone.call(this);

		/**
		 *  connect this input to the dry signal
		 *  the dry signal is also the default input
		 *  
		 *  @type {GainNode}
		 */
		this.dry = this.input;

		/**
		 *  connect this input to the wet signal
		 *  
		 *  @type {GainNode}
		 */
		this.wet = this.context.createGain();

		/**
		 *  controls the amount of wet signal 
		 *  which is mixed into the dry signal
		 *  
		 *  @type {Tone.Signal}
		 */
		this.wetness = new Tone.Signal();
		
		/**
		 *  invert the incoming signal
		 *  @private
		 *  @type {Tone}
		 */
		this._invert = new Tone.Expr("1 - $0");

		//connections
		this.dry.connect(this.output);
		this.wet.connect(this.output);
		//wet control
		this.wetness.connect(this.wet.gain);
		//dry control is the inverse of the wet
		this.wetness.chain(this._invert, this.dry.gain);
		this.setDry(this.defaultArg(initialDry, 0.5));
	};

	Tone.extend(Tone.DryWet);

	/**
	 * Set the dry value 
	 * 
	 * @param {number} val
	 * @param {Tone.Time=} rampTime
	 */
	Tone.DryWet.prototype.setDry = function(val, rampTime){
		this.setWet(1-val, rampTime);
	};

	/**
	 * Set the wet value
	 * 
	 * @param {number} val
	 * @param {Tone.Time=} rampTime
	 */
	Tone.DryWet.prototype.setWet = function(val, rampTime){
		if (rampTime){
			this.wetness.linearRampToValueNow(val, rampTime);
		} else {
			this.wetness.setValue(val);
		}
	};

	/**
	 *  clean up
	 */
	Tone.DryWet.prototype.dispose = function(){
		Tone.prototype.dispose.call(this);
		this.dry.disconnect();
		this.wet.disconnect();
		this.wetness.dispose();
		this._invert.dispose();
		this.dry = null;
		this.wet = null;
		this.wetness = null;
		this._invert = null;
	};

	return Tone.DryWet;
});