@hraness/dawg 0.6.0 → 0.7.0

package/src/commands/fx.ts

@@ -4,11 +4,12 @@
  *   fx                                   list the focused track's effects
  *   fx <effect> on|off|reset             enable with defaults, remove, reset
  *   fx <effect> preset <name>            load a named preset (FX_PRESETS)
+ *   fx <effect>                          turn it on (same as `on`)
  *   fx <effect> <param> <value>          set one parameter (enables it)
  *   fx <effect> <number>                 set its first parameter (`fx orbit 2`)
  *   fx <effect> <param> <value> <param> <value>…   several at once
  *   fx reverb ir <impulse>|off           convolution reverb (Strudel `ir`):
- *                                        room|hall|plate, a pack sound or a
+ *                                        room|hall|plate|reverse|gate|spring, a pack sound or a
  *                                        project file; `fx ir hall` too
  *
  * Effects are every `FX_CHAIN` stage except pan (see core/fx.ts), plus
@@ -18,7 +19,7 @@
  * on/off/true/false; enums take one of their values. Each command is one
  * `updateTrack` revision and one undo step.
  */
-import { nearestWord } from "../audio/instrument-check.ts";
+import { nearest } from "./nearest.ts";
 import {
   EFFECT_NAMES,
   FX_PRESETS,
@@ -28,6 +29,7 @@ import {
   isEffectName,
   normalizeParam,
   FxValidationError,
+  VOWEL_VALUES,
   type EffectName,
   type FxName,
   type FxValues,
@@ -56,37 +58,69 @@ export type FxCommand =
       type: "fx-set";
       effect: EffectName;
       values: Readonly<Record<string, number | string | boolean>>;
+    }
+  /** Store exactly these values (`/vowel a` drops a previous morph). */
+  | {
+      type: "fx-replace";
+      effect: EffectName;
+      values: Readonly<Record<string, number | string | boolean>>;
     };
 
-const EFFECT_ALIASES: Readonly<Record<string, EffectName>> = Object.freeze({
-  lpf: "filter",
-  hpf: "filter",
-  bpf: "filter",
-  dj: "djf",
-  "dj-filter": "djf",
-  "auto-filter": "autofilter",
-  autof: "autofilter",
-  formant: "vowel",
-  bitcrush: "crush",
-  bitcrusher: "crush",
-  coarse: "crush",
-  distortion: "distort",
-  dist: "distort",
-  drive: "distort",
-  shape: "distort",
-  trem: "tremolo",
-  comp: "compressor",
-  compress: "compressor",
-  rotary: "leslie",
-  gain: "postgain",
-  echo: "delay",
-  bus: "orbit",
-  o: "orbit",
-  sidechain: "duck",
-  duckorbit: "duck",
-  room: "reverb",
-  verb: "reverb",
-});
+export const EFFECT_ALIASES: Readonly<Record<string, EffectName>> =
+  Object.freeze({
+    lpf: "filter",
+    hpf: "filter",
+    bpf: "filter",
+    dj: "djf",
+    "dj-filter": "djf",
+    "auto-filter": "autofilter",
+    autof: "autofilter",
+    bitcrush: "crush",
+    bitcrusher: "crush",
+    coarse: "crush",
+    distortion: "distort",
+    dist: "distort",
+    drive: "distort",
+    shape: "distort",
+    trem: "tremolo",
+    comp: "compressor",
+    compress: "compressor",
+    rotary: "leslie",
+    gain: "postgain",
+    echo: "delay",
+    bus: "orbit",
+    o: "orbit",
+    sidechain: "duck",
+    duckorbit: "duck",
+    room: "reverb",
+    verb: "reverb",
+  });
+
+/**
+ * 0.7: `formant` was an alias of the vowel filter; it now shifts formants.
+ * A vowel given to it gets this answer instead of a silent change.
+ */
+export const FORMANT_FX_USAGE =
+  "formant · shift -12..12 st, mix 0..1 · presets deep giant bright tiny";
+
+/** `/vowel morph`, `fx vowel morph` and set_fx all refuse a morph with no target. */
+export const VOWEL_MORPH_NEEDS_TO =
+  "set a target first: /vowel a o 0.5 or /vowel to o";
+
+export const FORMANT_VOWEL_HINT =
+  "formant now shifts formants at constant pitch; the vowel filter is `vowel`";
+
+/** Whether `fx formant …` words or set_fx params name a vowel. */
+export function formantGotVowel(
+  words: readonly (string | number | boolean)[],
+): boolean {
+  return words.some(
+    (word) =>
+      typeof word === "string" &&
+      (word.toLowerCase() === "vowel" ||
+        (VOWEL_VALUES as readonly string[]).includes(word.toLowerCase())),
+  );
+}
 
 export function parseEffectName(name: string): EffectName | undefined {
   const lower = name.toLowerCase();
@@ -133,10 +167,25 @@ export function parseParamValue(
   }
 }
 
+/** The effects people reach for first, for the empty `fx` read. */
+const COMMON_FIRST: readonly string[] = [
+  "reverb",
+  "delay",
+  "filter",
+  "distort",
+  "chorus",
+  "compressor",
+];
+
+const FX_LIST_WORDS: readonly string[] = ["list", "ls", "presets"];
+
 export function parseFxCommand(prompt: string): FxCommand | undefined {
   const words = prompt.trim().split(/\s+/);
   if (words[0]?.toLowerCase() !== "fx") return undefined;
   if (words.length === 1) return { type: "fx-list" };
+  // `fx list`, `fx ls`, `fx presets`: the same read as bare `fx`.
+  if (words.length === 2 && FX_LIST_WORDS.includes(words[1]!.toLowerCase()))
+    return { type: "fx-list" };
   if (prompt.length > 1_024) return undefined;
   const irWord = (word: string | undefined) =>
     word !== undefined && ["ir", "iresponse"].includes(word.toLowerCase());
@@ -147,6 +196,8 @@ export function parseFxCommand(prompt: string): FxCommand | undefined {
   if (effect === "reverb" && irWord(words[2]) && words.length === 4)
     return irCommand(words[3]!);
   const rest = words.slice(2).map((word) => word.toLowerCase());
+  // `fx wobble`, `fx double`: a bare effect name turns it on.
+  if (rest.length === 0) return { type: "fx-on", effect };
   if (rest.length === 1 && (rest[0] === "on" || rest[0] === "off"))
     return { type: rest[0] === "on" ? "fx-on" : "fx-off", effect };
   if (rest.length === 1 && rest[0] === "reset")
@@ -200,9 +251,16 @@ export function unknownFxMessage(prompt: string): string | undefined {
   const words = prompt.trim().split(/\s+/);
   if (words[0]?.toLowerCase() !== "fx" || words.length < 2) return undefined;
   const name = words[1]!.toLowerCase();
+  if (name === "formant" && formantGotVowel(words.slice(2)))
+    return FORMANT_VOWEL_HINT;
+  // A new numeric-first effect: out-of-range values and preset typos get its
+  // ranges and presets instead of the generic unknown-command path.
+  if (name === "formant" && words.length <= 6 && !parseFxCommand(prompt))
+    return FORMANT_FX_USAGE;
   if (parseEffectName(name) || ["ir", "iresponse", "amp"].includes(name))
     return undefined;
-  const near = nearestWord(name, [
+  if (words.length === 2 && FX_LIST_WORDS.includes(name)) return undefined;
+  const near = nearest(name, [
     ...EFFECT_NAMES,
     ...Object.keys(EFFECT_ALIASES),
     "reverb",
@@ -239,6 +297,11 @@ export function effectDefaults(effect: EffectName): FxValues {
     delete out.sag;
     delete out.gate;
   }
+  // The vowel morph stays absent until set: `fx vowel on` stores 0.6 data.
+  if (effect === "vowel") {
+    delete out.to;
+    delete out.morph;
+  }
   return out;
 }
 
@@ -301,7 +364,7 @@ export function applyFxCommand(
       ok: true,
       message: on.length
         ? `fx · ${on.map((effect) => `${effect} (${describe(effect, effectValues(track, effect)!)})`).join(" → ")}`
-        : `fx · none · chain ${FX_CHAIN.join(" → ")}`,
+        : `fx · none · ${COMMON_FIRST.join(" ")} … · fx list`,
     };
   }
   if (command.type === "fx-ir")
@@ -321,7 +384,16 @@ export function applyFxCommand(
       ...effectDefaults(effect),
       ...FX_PRESETS[effect]![command.preset],
     };
+  else if (command.type === "fx-replace") values = { ...command.values };
   else values = { ...(current ?? effectDefaults(effect)), ...command.values };
+  if (
+    values &&
+    effect === "vowel" &&
+    command.type === "fx-set" &&
+    command.values.morph !== undefined &&
+    values.to === undefined
+  )
+    return { ok: false, message: `vowel · ${VOWEL_MORPH_NEEDS_TO}` };
   if (values && effect === "delay" && values.time === 0) {
     const { time: _time, ...rest } = values;
     values = rest;