effect nodes extend P5SoundEffectNode

Author: pparocza

src/nodes/core/effect/P5SoundDelay.js renamed to src/nodes/effect/P5SoundDelay.js

@@ -5,8 +5,8 @@
  */
 
 import { FeedbackDelay as ToneFeedbackDelay } from "tone/build/esm/effect/FeedbackDelay.js";
-import { P5SoundParameter } from "../P5SoundParameter.js";
-import { P5SoundMixEffectNode } from "../P5SoundMixEffectNode.js";
+import { P5SoundParameter } from "../../P5SoundParameter.js";
+import { P5SoundMixEffectNode } from "../core/P5SoundMixEffectNode.js";
 
 /**
  * A delay effect with parameters for feedback, and delay time.
@@ -52,14 +52,16 @@ export class P5SoundDelay extends P5SoundMixEffectNode
   {
     super();
 
-    this._delayNode = new ToneFeedbackDelay();
+    this._toneFeedbackDelayNode = new ToneFeedbackDelay();
 
-    this._delayTime = new P5SoundParameter(this._delayNode.delayTime, delayTime);
-    this._feedback = new P5SoundParameter(this._delayNode.feedback, feedback);
+    this._delayTime = new P5SoundParameter(this._toneFeedbackDelayNode.delayTime, delayTime);
+    this._feedback = new P5SoundParameter(this._toneFeedbackDelayNode.feedback, feedback);
 
-    this.configureMixIO(this._delayNode, this._delayNode);
+    this.configureMixIO(this._toneFeedbackDelayNode, this._toneFeedbackDelayNode);
   }
 
+  isP5SoundDelay = true;
+
   /**
    * Set the delay time in seconds.
    * @method delayTime
@@ -82,7 +84,7 @@ export class P5SoundDelay extends P5SoundMixEffectNode
    * 
    *   osc = new p5.P5SoundOscillator('sawtooth');
    *   osc.amp(0.74);
-   *   env = new p5.Envelope(0.01);
+   *   env = new p5.P5SoundEnvelope(0.01);
    *   delay = new p5.P5SoundDelay(0.12, 0.7);
    *   
    *   osc.disconnect();

src/nodes/core/effect/P5SoundGain.js renamed to src/nodes/effect/P5SoundGain.js

@@ -4,8 +4,8 @@
  *  @for p5.sound
  */
 import { Gain as ToneGain } from "tone/build/esm/core/context/Gain.js";
-import { P5SoundEffectNode } from "../P5SoundEffectNode.js";
-import { P5SoundParameter } from "../P5SoundParameter.js";
+import { P5SoundEffectNode } from "../core/P5SoundEffectNode.js";
+import { P5SoundParameter } from "../../P5SoundParameter.js";
 
 /**
  * Generate a gain node to use for mixing and main volume.
@@ -55,12 +55,12 @@ export class P5SoundGain extends P5SoundEffectNode
   {
     super();
 
-    this._gainNode = new ToneGain(gainValue);
+    this._toneGainNode = new ToneGain(gainValue);
 
-    this._gain = new P5SoundParameter(this._gainNode.gain);
+    this._gain = new P5SoundParameter(this._toneGainNode.gain);
 
-    this.configureInput(this._gainNode);
-    this.configureOutput(this._gainNode);
+    this.configureInput(this._toneGainNode);
+    this.configureOutput(this._toneGainNode);
   }
 
   isP5SoundGain = true;

src/nodes/core/effect/P5SoundPanner.js renamed to src/nodes/effect/P5SoundPanner.js

@@ -4,8 +4,8 @@
  *  @for p5.sound
  */
 
-import { P5SoundEffectNode } from "../P5SoundEffectNode.js";
-import { P5SoundParameter } from "../P5SoundParameter.js";
+import { P5SoundEffectNode } from "../core/P5SoundEffectNode.js";
+import { P5SoundParameter } from "../../P5SoundParameter.js";
 import { Panner as TonePanner} from "tone/build/esm/component/channel/Panner.js";
 
 /**
@@ -51,12 +51,12 @@ export class P5SoundPanner extends P5SoundEffectNode
   {
     super();
 
-    this._pannerNode = new TonePanner();
+    this._tonePannerNode = new TonePanner();
 
-    this._pan = new P5SoundParameter(this._pannerNode.pan, panAmount);
+    this._pan = new P5SoundParameter(this._tonePannerNode.pan, panAmount);
 
-    this.configureInput(this._pannerNode);
-    this.configureOutput(this._pannerNode);
+    this.configureInput(this._tonePannerNode);
+    this.configureOutput(this._tonePannerNode);
   }
 
   isP5SoundPanner = true;

src/Panner3D.js renamed to src/nodes/effect/P5SoundPanner3D.js

@@ -4,12 +4,13 @@
  *  @for p5.sound
  */
 
-import { Context as ToneContext } from "tone/build/esm/core/context/Context.js";
-import { Panner3D as TonePanner3D} from "tone/build/esm/component/channel/Panner3D.js";
+import { Panner3D as TonePanner3D } from "tone/build/esm/component/channel/Panner3D.js";
+import { P5SoundEffectNode } from "../core/P5SoundEffectNode.js";
+import { P5SoundParameter } from "../../P5SoundParameter.js";
 
 /**
  * A 3D sound spatializer.
- * @class Panner3D
+ * @class P5SoundPanner3D
  * @constructor
  * @example
  * <div>
@@ -34,7 +35,7 @@ import { Panner3D as TonePanner3D} from "tone/build/esm/component/channel/Panner
  * 
  * function setup() {
  *   describe(
- *     'A 3D shape with a sound source attached to it. The sound source is spatialized using the Panner3D class. Click to play the sound.'
+ *     'A 3D shape with a sound source attached to it. The sound source is spatialized using the P5SoundPanner3D class. Click to play the sound.'
  *   );
  *   cnv = createCanvas(100, 100, WEBGL);
  *   cnv.mousePressed(playSound);
@@ -50,7 +51,7 @@ import { Panner3D as TonePanner3D} from "tone/build/esm/component/channel/Panner
  *   vY = random(-0.5, 0.5);
  *   vZ = random(-0.5, 0.5) * 1.5;
  * 
- *   spatializer = new p5.Panner3D();
+ *   spatializer = new p5.P5SoundPanner3D();
  *   spatializer.maxDist(100);
  *   soundSource.loop();
  *   soundSource.disconnect();
@@ -101,119 +102,101 @@ import { Panner3D as TonePanner3D} from "tone/build/esm/component/channel/Panner
  * </code>
  * </div>
  */
-class Panner3D {
-  constructor() {
-    this.panner3d= new TonePanner3D({
-      coneInnerAngle:360,
-      coneOuterAngle:360,
-      coneOuterGain:1,
-      positionX:0,
-      positionY:0,
-      positionZ:0,
-    }).toDestination();
+export class P5SoundPanner3D extends P5SoundEffectNode
+{
+  constructor()
+  {
+    super();
+
+    this._tonePanner3DNode = new TonePanner3D
+    (
+      {
+        coneInnerAngle: 360,
+        coneOuterAngle: 360,
+        coneOuterGain: 1
+      }
+    );
+
+    this._positionX = new P5SoundParameter(this._tonePanner3DNode.positionX, 0);
+    this._positionY = new P5SoundParameter(this._tonePanner3DNode.positionY, 0);
+    this._positionZ = new P5SoundParameter(this._tonePanner3DNode.positionZ, 0);
+
+    this.configureInput(this._tonePanner3DNode);
+    this.configureOutput(this._tonePanner3DNode);
   }
 
+  isP5SoundPanner3D = true;
+
+  get positionX() { return this._positionX; }
   /**
-   * Connects an input source to the 3D panner.
-   * @method process
-   * @for Panner3D
-   * @param {Object} input an input source to process with the 3D panner.
+   * Set the X position of the sound source.
+   * @method positionX
+   * @for P5SoundPanner3D
+   * @param {Number} positionX the x position of the sound source.
    */
-  process(input) {
-    input.getNode().connect(this.panner3d);
-  }
+  set positionX(positionX) { this._positionX.value = positionX; }
+
+  get positionY() { return this._positionY; }
+  /**
+   * Set the Y position of the sound source.
+   * @method positionY
+   * @for P5SoundPanner3D
+   * @param {Number} positionY the y position of the sound source.
+   */
+  set positionY(positionY) { this._positionY.value = positionY; }
+
+  get positionZ() { return this._positionZ; }
+  /**
+   * Set the Z position of the sound source.
+   * @method positionZ
+   * @for P5SoundPanner3D
+   * @param {Number} positionZ the z position of the sound source.
+   */
+  set positionZ(positionZ) { this._positionZ.value = positionZ; }
 
   /**
    * Set the x, y, and z position of the 3D panner.
-   * @method set
-   * @for Panner3D
+   * @method setPositionXYZ
+   * @for P5SoundPanner3D
    * @param {Number} xPosition the x coordinate of the panner.
    * @param {Number} yPosition the y coordinate of the panner.
    * @param {Number} zPosition the z coordinate of the panner.
    */
-  set(x, y, z) {
-    this.panner3d.positionX.rampTo(x, 0.01);
-    this.panner3d.positionY.rampTo(y, 0.01);
-    this.panner3d.positionZ.rampTo(z, 0.01);
+  setPositionXYZ(xPosition, yPosition, zPosition)
+  {
+    this.positionX.rampTo(xPosition, 0.01);
+    this.positionY.rampTo(yPosition, 0.01);
+    this.positionZ.rampTo(zPosition, 0.01);
   }
 
   /**
    * The rolloff rate of the panner.
    * @method setFalloff
-   * @for Panner3D
+   * @for P5SoundPanner3D
    * @param {Number} rolloffFactor 
    * @param {Number} maxDistance 
    */
-  setFalloff(rolloffFactor, maxDistance) {
-    this.panner3d.rolloffFactor = rolloffFactor;
-    this.panner3d.maxDistance = maxDistance;
+  setFalloff(rolloffFactor, maxDistance)
+  {
+    this._tonePanner3DNode.rolloffFactor = rolloffFactor;
+    this._tonePanner3DNode.maxDistance = maxDistance;
   }
 
+  get maxDistance() { return this._tonePanner3DNode.maxDistance; }
   /**
    * Set the maximum distance of the panner.
    * @method maxDist
-   * @for Panner3D
+   * @for P5SoundPanner3D
    * @param {Number} distance the maximum distance that the sound source can be heard from.
    */
-  maxDist(d) {
-    this.panner3d.maxDistance = d;
-  }
+  set maxDistance(distance) { this._tonePanner3DNode.maxDistance = distance; }
 
+  get rolloff() { return this._tonePanner3DNode.rolloffFactor; }
   /**
    * Set the rolloff rate of the panner.
    * @method rolloff
-   * @for Panner3D
-   * @param {Number} r the rolloff rate of the panner.
-   */
-  rolloff(r) {
-    this.panner3d.rolloffFactor = r;
-  }
-
-  /**
-   * Set the X position of the sound source.
-   * @method positionX
-   * @for Panner3D
-   * @param {Number} positionX the x position of the sound source.
+   * @for P5SoundPanner3D
+   * @param {Number} rolloff the rolloff rate of the panner.
    */
-  positionX(p) {
-    this.panner3d.positionX.rampTo(p, 0.01);
-  }
-
-  /**
-   * Set the Y position of the sound source.
-   * @method positionY
-   * @for Panner3D
-   * @param {Number} positionY the y position of the sound source.
-   */
-  positionY(p) {
-    this.panner3d.positionY.rampTo(p, 0.01);
-  }
-
-  /**
-   * Set the Z position of the sound source.
-   * @method positionZ
-   * @for Panner3D
-   * @param {Number} positionZ the z position of the sound source.
-   */
-  positionZ(p) {
-    this.panner3d.positionZ.rampTo(p, 0.01);
-  }
-
-  connect(destination) {
-    if(typeof destination.getNode === 'function') {
-      this.panner3d.connect(destination.getNode());
-    } else {
-      this.panner3d.connect(destination);
-    } 
-  }
-
-  disconnect() {
-    this.panner3d.disconnect(ToneContext.destination);
-  }
-
-  getNode() {
-    return this.panner3d;
-  }
+  set rolloff(rolloff) { this._tonePanner3DNode.rolloffFactor = rolloff; }
 }
-
-export default Panner3D;

src/PitchShifter.js renamed to src/nodes/effect/P5SoundPitchShifter.js

@@ -4,12 +4,12 @@
  *  @for p5.sound
  */
 
-import { Context as ToneContext } from "tone/build/esm/core/context/Context.js";
 import { PitchShift as TonePitchShift } from "tone/build/esm/effect/PitchShift.js";
+import { P5SoundMixEffectNode } from "../core/P5SoundMixEffectNode.js";
 
 /**
  * Change the pitch of a sound.
- * @class PitchShifter
+ * @class P5SoundPitchShifter
  * @constructor
  * @example
  * <div>
@@ -27,7 +27,7 @@ import { PitchShift as TonePitchShift } from "tone/build/esm/effect/PitchShift.j
  *   textAlign(CENTER);
  *   textSize(9);
  *   text('click to play sound', width/2, height/2);
- *   pitchShifter = new p5.PitchShifter();
+ *   pitchShifter = new p5.P5SoundPitchShifter();
  *   
  *   soundFile.disconnect();
  *   soundFile.connect(pitchShifter);
@@ -47,38 +47,26 @@ import { PitchShift as TonePitchShift } from "tone/build/esm/effect/PitchShift.j
  * </code>
  * </div>
  */
-class PitchShifter {
-    constructor(shiftValue = 1) {
-        this.pitchshifter = new TonePitchShift(shiftValue).toDestination();
+export class P5SoundPitchShifter extends P5SoundMixEffectNode
+{
+    constructor(shiftValue = 1)
+    {
+        super();
+
+        this._tonePitchShifterNode = new TonePitchShift(shiftValue);
+
+        this.configureMixIO(this._tonePitchShifterNode, this._tonePitchShifterNode);
     }
-    
+
+    isP5SoundPitchShifter = true;
+
+    get shift() { return this._tonePitchShifterNode.pitch.value; }
+
     /**
      * Shift the pitch of the source audio.
      * @method shift
-     * @for PitchShifter
+     * @for P5SoundPitchShifter
      * @param {Number} pitchValue amount of semitones to shift the pitch
      */
-    shift (value) {
-        if (value !== undefined) {
-            this.pitchshifter.pitch = value;
-        }
-    }
-    
-    connect(destination) {
-        if(typeof destination.getNode === 'function') {
-            this.pitchshifter.connect(destination.getNode());
-        } else {
-            this.pitchshifter.connect(destination);
-        } 
-    }
-
-    disconnect() {
-        this.pitchshifter.disconnect(ToneContext.destination);
-    }
-
-    getNode() {
-        return this.pitchshifter;
-    }
+    set shift(pitchValue) { this._tonePitchShifterNode.pitch.value = value;}
 }
-
-export default PitchShifter;