From 990b12945088a770da08ac36c5a745143a323854 Mon Sep 17 00:00:00 2001
From: Raphael Forment <raphael.forment@gmail.com>
Date: Thu, 31 Aug 2023 13:59:37 +0200
Subject: [PATCH] abbreviate parameters

---
 src/API.ts                |  36 +++--
 src/classes/SoundEvent.ts | 299 +++++++++-----------------------------
 2 files changed, 94 insertions(+), 241 deletions(-)

diff --git a/src/API.ts b/src/API.ts
index 4d4b373..cb9ab61 100644
--- a/src/API.ts
+++ b/src/API.ts
@@ -12,6 +12,7 @@ import {
   samples,
   initAudioOnFirstClick,
   registerSynthSounds,
+  registerZZFXSounds,
   soundMap,
   // @ts-ignore
 } from "superdough";
@@ -29,6 +30,7 @@ export async function loadSamples() {
     samples("github:tidalcycles/Dirt-Samples/master").then(() =>
       registerSynthSounds()
     ),
+    registerZZFXSounds(),
     samples("github:Bubobubobubobubo/Topos-Samples/main"),
   ]);
 }
@@ -359,7 +361,7 @@ export class UserAPI {
     input: string,
     options: InputOptions = {},
     id: number | string = ""
-  ): Player =>  {
+  ): Player => {
     const zid = "z" + id.toString();
     const key = id === "" ? this.generateCacheKey(input, options) : zid;
 
@@ -1288,26 +1290,40 @@ export class UserAPI {
 
   abs = Math.abs;
 
-
   // =============================================================
   // Speech synthesis
   // =============================================================
 
-  speak = (text: string, lang: string = "en-US", voice: number = 0, rate: number = 1, pitch: number = 1): void => {
-    /* 
+  speak = (
+    text: string,
+    lang: string = "en-US",
+    voice: number = 0,
+    rate: number = 1,
+    pitch: number = 1
+  ): void => {
+    /*
      * Speaks the given text using the browser's speech synthesis API.
      * @param text - The text to speak
      * @param voice - The index of the voice to use
      * @param rate - The rate at which to speak the text
      * @param pitch - The pitch at which to speak the text
-     * 
+     *
      */
-    const speaker = new Speaker({text: text, lang: lang, voice: voice, rate: rate, pitch: pitch});
-    speaker.speak().then(() => {
-      // Done speaking
-    }).catch((err) => {
-      console.log(err);
+    const speaker = new Speaker({
+      text: text,
+      lang: lang,
+      voice: voice,
+      rate: rate,
+      pitch: pitch,
     });
+    speaker
+      .speak()
+      .then(() => {
+        // Done speaking
+      })
+      .catch((err) => {
+        console.log(err);
+      });
   };
 
   // =============================================================
diff --git a/src/classes/SoundEvent.ts b/src/classes/SoundEvent.ts
index a830c22..18dd02f 100644
--- a/src/classes/SoundEvent.ts
+++ b/src/classes/SoundEvent.ts
@@ -14,76 +14,52 @@ export class SoundEvent extends AudibleEvent {
     else this.values = sound;
   }
 
-  fmenv = (value: "lin" | "exp"): this => {
-    this.values["fmenv"] = value;
+  private updateValue<T>(key: string, value: T): this {
+    this.values[key] = value;
     return this;
-  };
+  }
 
-  fmattack = (value: number): this => {
-    this.values["fmattack"] = value;
-    return this;
-  };
+  // ================================================================================
+  // ZZFX Sound Parameters
+  // ================================================================================
+
+  volume = (value: number) => this.updateValue("volume", value);
+  vol = this.volume;
+  zrand = (value: number) => this.updateValue("zrand", value);
+
+  // ================================================================================
+  // Basic Audio Engine Parameters
+  // ================================================================================
+
+  fmi = (value: number) => this.updateValue("fmi", value);
+  fmh = (value: number) => this.updateValue("fmh", value);
+  fmenv = (value: "lin" | "exp") => this.updateValue("fmenv", value);
+  fmattack = (value: number) => this.updateValue("fmattack", value);
   fmatk = this.fmattack;
-
-  fmdecay = (value: number): this => {
-    this.values["fmdecay"] = value;
-    return this;
-  };
+  fmdecay = (value: number) => this.updateValue("fmdecay", value);
   fmdec = this.fmdecay;
-
-  fmsustain = (value: number): this => {
-    this.values["fmsustain"] = value;
-    return this;
-  };
+  fmsustain = (value: number) => this.updateValue("fmsustain", value);
   fmsus = this.fmsustain;
-
-  fmrelease = (value: number): this => {
-    this.values["fmrelease"] = value;
-    return this;
-  };
+  fmrelease = (value: number) => this.updateValue("fmrelease", value);
   fmrel = this.fmrelease;
-
-  fmvelocity = (value: number): this => {
-    this.values["fmvelocity"] = value;
-    return this;
-  };
+  fmvelocity = (value: number) => this.updateValue("fmvelocity", value);
   fmvel = this.fmvelocity;
-
-  fmwave = (value: "sine" | "triangle" | "sawtooth" | "square"): this => {
-    this.values["fmwave"] = value;
-    return this;
-  };
+  fmwave = (value: "sine" | "triangle" | "sawtooth" | "square") =>
+    this.updateValue("fmwave", value);
   fmw = this.fmwave;
-
-  attack = (value: number): this => {
-    this.values["attack"] = value;
-    return this;
-  };
+  attack = (value: number) => this.updateValue("attack", value);
   atk = this.attack;
-
-  decay = (value: number): this => {
-    this.values["decay"] = value;
-    return this;
-  };
+  decay = (value: number) => this.updateValue("decay", value);
   dec = this.decay;
-
-  release = (value: number): this => {
-    this.values["release"] = value;
-    return this;
-  };
+  release = (value: number) => this.updateValue("release", value);
   rel = this.release;
-
-  unit = (value: number): this => {
-    this.values["unit"] = value;
-    return this;
-  };
-
-  freq = (value: number): this => {
-    this.values["freq"] = value;
-    return this;
-  };
-
-  fm = (value: number | string): this => {
+  sustain = (value: number) => this.updateValue("sustain", value);
+  sus = this.sustain;
+  unit = (value: number) => this.updateValue("unit", value);
+  u = this.unit;
+  freq = (value: number) => this.updateValue("freq", value);
+  f = this.freq;
+  fm = (value: number | string) => {
     if (typeof value === "number") {
       this.values["fmi"] = value;
     } else {
@@ -93,191 +69,52 @@ export class SoundEvent extends AudibleEvent {
     }
     return this;
   };
-
-  sound = (value: string): this => {
-    this.values["s"] = value;
-    return this;
-  };
-
-  fmi = (value: number): this => {
-    this.values["fmi"] = value;
-    return this;
-  };
-
-  fmh = (value: number): this => {
-    this.values["fmh"] = value;
-    return this;
-  };
-
-  nudge = (value: number): this => {
-    this.values["nudge"] = value;
-    return this;
-  };
-
-  cut = (value: number): this => {
-    this.values["cut"] = value;
-    return this;
-  };
-
-  loop = (value: number): this => {
-    this.values["loop"] = value;
-    return this;
-  };
-
-  clip = (value: number): this => {
-    this.values["clip"] = value;
-    return this;
-  };
-
-  n = (value: number): this => {
-    this.values["n"] = value;
-    return this;
-  };
-
-  note = (value: number): this => {
-    this.values["note"] = value;
-    return this;
-  };
-
-  speed = (value: number): this => {
-    this.values["speed"] = value;
-    return this;
-  };
-
-  begin = (value: number): this => {
-    this.values["begin"] = value;
-    return this;
-  };
-
-  end = (value: number): this => {
-    this.values["end"] = value;
-    return this;
-  };
-
-  gain = (value: number): this => {
-    this.values["gain"] = value;
-    return this;
-  };
-
-  cutoff = (value: number): this => {
-    this.values["cutoff"] = value;
-    return this;
-  };
+  sound = (value: string) => this.updateValue("s", value);
+  snd = this.sound;
+  nudge = (value: number) => this.updateValue("nudge", value);
+  cut = (value: number) => this.updateValue("cut", value);
+  loop = (value: number) => this.updateValue("loop", value);
+  clip = (value: number) => this.updateValue("clip", value);
+  n = (value: number) => this.updateValue("n", value);
+  note = (value: number) => this.updateValue("note", value);
+  speed = (value: number) => this.updateValue("speed", value);
+  spd = this.speed;
+  begin = (value: number) => this.updateValue("begin", value);
+  end = (value: number) => this.updateValue("end", value);
+  gain = (value: number) => this.updateValue("gain", value);
+  cutoff = (value: number) => this.updateValue("cutoff", value);
   lpf = this.cutoff;
-
-  resonance = (value: number): this => {
-    this.values["resonance"] = value;
-    return this;
-  };
+  resonance = (value: number) => this.updateValue("resonance", value);
   lpq = this.resonance;
-
-  hcutoff = (value: number): this => {
-    this.values["hcutoff"] = value;
-    return this;
-  };
+  hcutoff = (value: number) => this.updateValue("hcutoff", value);
   hpf = this.hcutoff;
-
-  hresonance = (value: number): this => {
-    this.values["hresonance"] = value;
-    return this;
-  };
+  hresonance = (value: number) => this.updateValue("hresonance", value);
   hpq = this.hresonance;
-
-  bandf = (value: number): this => {
-    this.values["bandf"] = value;
-    return this;
-  };
+  bandf = (value: number) => this.updateValue("bandf", value);
   bpf = this.bandf;
-
-  bandq = (value: number): this => {
-    this.values["bandq"] = value;
-    return this;
-  };
+  bandq = (value: number) => this.updateValue("bandq", value);
   bpq = this.bandq;
-
-  coarse = (value: number): this => {
-    this.values["coarse"] = value;
-    return this;
-  };
-
-  crush = (value: number): this => {
-    this.values["crush"] = value;
-    return this;
-  };
-
-  shape = (value: number): this => {
-    this.values["shape"] = value;
-    return this;
-  };
-
-  pan = (value: number): this => {
-    this.values["pan"] = value;
-    return this;
-  };
-
-  vowel = (value: number): this => {
-    this.values["vowel"] = value;
-    return this;
-  };
-
-  delay = (value: number): this => {
-    this.values["delay"] = value;
-    return this;
-  };
+  coarse = (value: number) => this.updateValue("coarse", value);
+  crush = (value: number) => this.updateValue("crush", value);
+  shape = (value: number) => this.updateValue("shape", value);
+  pan = (value: number) => this.updateValue("pan", value);
+  vowel = (value: number) => this.updateValue("vowel", value);
+  vow = this.vowel;
+  delay = (value: number) => this.updateValue("delay", value);
   del = this.delay;
-
-  delayfeedback = (value: number): this => {
-    this.values["delayfeedback"] = value;
-    return this;
-  };
+  delayfeedback = (value: number) => this.updateValue("delayfeedback", value);
   delayfb = this.delayfeedback;
-
-  delaytime = (value: number): this => {
-    this.values["delaytime"] = value;
-    return this;
-  };
+  delaytime = (value: number) => this.updateValue("delaytime", value);
   delayt = this.delaytime;
-
-  orbit = (value: number): this => {
-    this.values["orbit"] = value;
-    return this;
-  };
+  orbit = (value: number) => this.updateValue("orbit", value);
   o = this.orbit;
-
-  room = (value: number): this => {
-    this.values["room"] = value;
-    return this;
-  };
-
-  size = (value: number): this => {
-    this.values["size"] = value;
-    return this;
-  };
+  room = (value: number) => this.updateValue("room", value);
+  rm = this.room;
+  size = (value: number) => this.updateValue("size", value);
   sz = this.size;
-
-  velocity = (value: number): this => {
-    this.values["velocity"] = value;
-    return this;
-  };
+  velocity = (value: number) => this.updateValue("velocity", value);
   vel = this.velocity;
 
-  modify = (func: Function): this => {
-    const funcResult = func(this);
-    if (funcResult instanceof Object) return funcResult;
-    else {
-      func(this.values);
-      this.update();
-      return this;
-    }
-  };
-
-  // NOTE: Sustain of the sound. duration() from the superclass Event is used to change the note length.
-  sustain = (value: number): this => {
-    this.values["dur"] = value;
-    return this;
-  };
-  sus = this.sustain;
-
   update = (): void => {
     const [note, _] = noteFromPc(
       this.values.key || "C4",