@hraness/dawg 0.6.1 → 0.8.0

package/core/chords.ts

@@ -49,6 +49,7 @@ export const QUALITIES = [
   "mb6",
   "b6",
   "7#9",
+  "b5",
 ] as const;
 export type Quality = (typeof QUALITIES)[number];
 
@@ -65,6 +66,7 @@ const QUALITY_INTERVALS: Readonly<Record<Quality, readonly number[]>> =
     mb6: [0, 3, 7, 8],
     b6: [0, 4, 7, 8],
     "7#9": [0, 4, 7, 10, 15],
+    b5: [0, 4, 6],
   });
 
 /**
@@ -117,6 +119,11 @@ export type Chord = Readonly<{
    * such as `C11`, `G13` or `A7b9` carry them (0.6.1).
    */
   tensions?: readonly number[] | undefined;
+  /**
+   * The root's letter, 0..6 for C..B, when a roman numeral spelled it:
+   * `bVII` in C names Bb (not A#) and `vii` in F# names E# (not F).
+   */
+  letter?: number | undefined;
 }>;
 
 export function makeChord(
@@ -195,6 +202,25 @@ export function noteName(pc: number, flats = false): string {
   return (flats ? FLAT_NAMES : SHARP_NAMES)[mod12(pc)]!;
 }
 
+const LETTERS = "CDEFGAB";
+const LETTER_PCS = [0, 2, 4, 5, 7, 9, 11] as const;
+
+/**
+ * `pc` spelled on letter `letter` (0..6, C..B) with one accidental at
+ * most (E#, Cb, Bb); undefined when that would need a double accidental.
+ */
+export function spellOnLetter(pc: number, letter: number): string | undefined {
+  const l = ((Math.trunc(letter) % 7) + 7) % 7;
+  const diff = ((mod12(pc) - LETTER_PCS[l]! + 18) % 12) - 6;
+  if (Math.abs(diff) > 1) return undefined;
+  return `${LETTERS[l]}${diff === 1 ? "#" : diff === -1 ? "b" : ""}`;
+}
+
+/** The letter (0..6, C..B) a key's tonic is spelled on. */
+function tonicLetter(key: Key): number {
+  return LETTERS.indexOf(noteName(key.tonic, keyUsesFlats(key))[0]!);
+}
+
 const SECRET_SUFFIX: Readonly<Partial<Record<Quality, string>>> = Object.freeze(
   { madd4: "m(add4)", mb6: "m(b6)", b6: "(b6)", "7#9": "7#9" },
 );
@@ -273,6 +299,9 @@ export function chordSuffix(chord: Chord): string {
         base = `${seventh}(no3)`;
         if (nine) extras.push("9");
         break;
+      case "b5":
+        base = `${ninth}b5`;
+        break;
       default:
         base = seventh; // secret qualities returned above
     }
@@ -291,6 +320,7 @@ export function chordSuffix(chord: Chord): string {
     mb6: "m(b6)",
     b6: "(b6)",
     "7#9": "7#9",
+    b5: "(b5)",
   };
   base = triad[q];
   if (six && nine && (q === "maj" || q === "min")) return `${base}6/9`;
@@ -310,7 +340,11 @@ export function chordSuffix(chord: Chord): string {
 export function chordName(chord: Chord, flats = false): string {
   const slash =
     chord.bass === undefined ? "" : `/${noteName(chord.bass, flats)}`;
-  return `${noteName(chord.root, flats)}${chordSuffix(chord)}${slash}`;
+  const root =
+    (chord.letter === undefined
+      ? undefined
+      : spellOnLetter(chord.root, chord.letter)) ?? noteName(chord.root, flats);
+  return `${root}${chordSuffix(chord)}${slash}`;
 }
 
 /** Suffix → quality and extensions, longest first when parsing. */
@@ -375,6 +409,31 @@ const SUFFIXES: readonly (readonly [string, Quality, readonly Extension[]])[] =
     ["(b6)", "b6", []],
     ["addb6", "b6", []],
     ["7#9", "7#9", []],
+    // 0.7: more spellings of the same chords.
+    ["-maj7", "min", ["M7"]],
+    ["mmaj7", "min", ["M7"]],
+    ["mMaj7", "min", ["M7"]],
+    ["m(maj7)", "min", ["M7"]],
+    ["-Δ7", "min", ["M7"]],
+    ["mΔ7", "min", ["M7"]],
+    ["add2", "maj", ["9"]],
+    ["2", "maj", ["9"]],
+    ["madd2", "min", ["9"]],
+    ["6add9", "maj", ["6", "9"]],
+    ["m6add9", "min", ["6", "9"]],
+    ["-6", "min", ["6"]],
+    ["-9", "min", ["m7", "9"]],
+    ["dom9", "maj", ["m7", "9"]],
+    ["aug(maj7)", "aug", ["M7"]],
+    ["augmaj7", "aug", ["M7"]],
+    ["+maj7", "aug", ["M7"]],
+    ["aug9", "aug", ["m7", "9"]],
+    ["+9", "aug", ["m7", "9"]],
+    ["m(maj9)", "min", ["M7", "9"]],
+    ["mmaj9", "min", ["M7", "9"]],
+    ["dim(maj7)", "dim", ["M7"]],
+    ["7(no3)", "5", ["m7"]],
+    ["maj7(no3)", "5", ["M7"]],
   ];
 
 /** Typed upper-tension chords (0.6.1): suffix, quality, buttons, tensions. */
@@ -409,10 +468,7 @@ const TENSION_NAMES: Readonly<Record<number, string>> = Object.freeze({
   21: "13",
 });
 
-const SUFFIX_TABLE = new Map<
-  string,
-  { quality: Quality; ext: readonly Extension[]; tensions?: readonly number[] }
->([
+const SUFFIX_TABLE = new Map<string, SuffixEntry>([
   ...SUFFIXES.map(
     ([suffix, quality, ext]) => [suffix, { quality, ext }] as const,
   ),
@@ -445,6 +501,81 @@ export function parsePitchClass(text: string): number | undefined {
   return mod12(LETTER[match[1]!.toLowerCase()]! + accidental);
 }
 
+/** Alteration → upper tension (semitones above the root). */
+const ALTERATION_TENSION: Readonly<Record<string, number>> = Object.freeze({
+  b9: 13,
+  "#9": 15,
+  "11": 17,
+  "#11": 18,
+  "+11": 18,
+  b13: 20,
+  "13": 21,
+});
+
+const TOKEN = "b5|#5|\\+5|b9|#9|#11|\\+11|b13|alt|add9|add11|add13|11|13|9|6";
+/** Bare alterations or parenthesized comma lists of them, in any order. */
+const ALTERATIONS = new RegExp(
+  `^(?:(?:${TOKEN})|\\((?:${TOKEN})(?:,(?:${TOKEN}))*\\))+$`,
+);
+
+type SuffixEntry = {
+  quality: Quality;
+  ext: readonly Extension[];
+  tensions?: readonly number[];
+};
+
+/**
+ * A suffix the table does not list, read as a listed base followed by
+ * alterations, bare or in parentheses: `7#5`, `9#11`, `13#11`, `7b9b13`,
+ * `9b5`, `maj7+5`, `7alt`, `7(b9,#9)`. A raised fifth makes the triad
+ * augmented, a lowered one makes a major triad `b5` (a minor one
+ * diminished); `alt` is b9, #9, #11 and b13 over a dominant seventh.
+ */
+function parseAlteredSuffix(suffix: string): SuffixEntry | undefined {
+  for (let cut = suffix.length - 1; cut >= 0; cut -= 1) {
+    const base = SUFFIX_TABLE.get(suffix.slice(0, cut));
+    if (!base) continue;
+    const raw = suffix.slice(cut);
+    if (!ALTERATIONS.test(raw)) continue;
+    const rest = raw.replace(/[(),]/g, "");
+    const tokens = rest.match(
+      /b5|#5|\+5|b9|#9|#11|\+11|b13|alt|add9|add11|add13|11|13|9|6/g,
+    );
+    if (!tokens || tokens.join("") !== rest) continue;
+    let quality: Quality = base.quality;
+    const ext = new Set<Extension>(base.ext);
+    const tensions = new Set<number>(base.tensions ?? []);
+    let ok = true;
+    for (const token of tokens) {
+      if (token === "#5" || token === "+5") {
+        if (quality === "maj" || quality === "aug") quality = "aug";
+        else ok = false;
+      } else if (token === "b5") {
+        if (quality === "maj" || quality === "b5") quality = "b5";
+        else if (quality === "min" || quality === "dim") quality = "dim";
+        else ok = false;
+      } else if (token === "alt") {
+        if (quality !== "maj") ok = false;
+        ext.add("m7");
+        for (const step of [13, 15, 18, 20]) tensions.add(step);
+      } else if (token === "9" || token === "add9") ext.add("9");
+      else if (token === "6") ext.add("6");
+      else {
+        const step = ALTERATION_TENSION[token.replace(/^add/, "")];
+        if (step === undefined) ok = false;
+        else tensions.add(step);
+      }
+    }
+    if (!ok) continue;
+    return {
+      quality,
+      ext: [...ext],
+      tensions: [...tensions].sort((a, b) => a - b),
+    };
+  }
+  return undefined;
+}
+
 /** Parse a chord symbol (`Cm7`, `F#dim`, `Bbmaj9`, `G7sus4`, `C/E`). */
 export function parseChord(symbol: string): Chord | undefined {
   if (typeof symbol !== "string" || symbol.length > 24) return undefined;
@@ -455,7 +586,8 @@ export function parseChord(symbol: string): Chord | undefined {
   const match = trimmed.match(/^([A-Ga-g])(#|b|♯|♭)?([^/]*)(?:\/(.+))?$/);
   if (!match) return undefined;
   const root = parsePitchClass(`${match[1]}${match[2] ?? ""}`);
-  const entry = SUFFIX_TABLE.get(match[3] ?? "");
+  const entry =
+    SUFFIX_TABLE.get(match[3] ?? "") ?? parseAlteredSuffix(match[3] ?? "");
   if (root === undefined || !entry) return undefined;
   let bass: number | undefined;
   if (match[4] !== undefined) {
@@ -515,7 +647,15 @@ const MODE_ALIASES: Readonly<Record<string, ModeName>> = Object.freeze({
 });
 
 export type ScaleFamily =
-  "pentatonic" | "blues" | "maqam" | "dastgah" | "raga" | "messiaen";
+  | "pentatonic"
+  | "blues"
+  | "maqam"
+  | "dastgah"
+  | "raga"
+  | "messiaen"
+  | "chromatic"
+  | "overtone"
+  | "quarter-tone";
 
 /**
  * Scales beyond the chord modes, for keys such as `D bayati`, `C yaman` or
@@ -562,6 +702,12 @@ export const SCALES = Object.freeze({
     family: "blues",
     aliases: ["major blues"],
   },
+  "yonanuki-minor": {
+    steps: [0, 2, 3, 7, 8],
+    mode: "minor",
+    family: "pentatonic",
+    aliases: ["yonanuki", "yonanuki minor", "enka minor"],
+  },
   hijaz: {
     steps: [0, 1, 4, 5, 7, 8, 10],
     mode: "phrygian-dominant",
@@ -738,6 +884,32 @@ export const SCALES = Object.freeze({
     mode: "harmonic-minor",
     family: "messiaen",
   },
+  // All twelve pitch classes: the field of free atonality and the row.
+  chromatic: {
+    steps: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
+    mode: "minor",
+    family: "chromatic",
+    aliases: ["twelve-tone", "aggregate"],
+  },
+  // Partials 8 to 15 of the harmonic series over the tonic (Grisey,
+  // Murail): the acoustic scale with the 11th and 13th partials' and the
+  // 7th's just pitches, which its named tuning applies.
+  "harmonic-series": {
+    steps: [0, 2, 4, 6, 7, 9, 10, 11],
+    mode: "mixolydian",
+    family: "overtone",
+    intonation: [0, 204, 386, 551, 702, 841, 969, 1088],
+    aliases: ["overtone", "overtone-scale", "partials"],
+  },
+  // Each tempered degree of the major scale beside its quarter-tone
+  // shadow (Haba, Wyschnegradsky): neutral 2nd, 3rd, 6th and 7th and a
+  // quarter-sharp 4th, sounded as note cents over twelve-tone keys.
+  "quarter-tone": {
+    steps: [0, 1.5, 2, 3.5, 4, 5, 5.5, 7, 8.5, 9, 10.5],
+    mode: "major",
+    family: "quarter-tone",
+    aliases: ["quartertone", "24-tone"],
+  },
 } as const satisfies Record<string, ScaleInfo>);
 export type ScaleName = keyof typeof SCALES;
 export const SCALE_NAMES = Object.keys(SCALES) as ScaleName[];
@@ -944,9 +1116,14 @@ export function romanOf(key: Key, chord: Chord): string {
   if (degree < 0) {
     // Name chromatic roots against the major scale: bIII, #iv°.
     const major = MODES.major.map((step) => mod12(key.tonic + step));
+    const natural = major.indexOf(chord.root);
     const flat = major.indexOf(mod12(chord.root + 1));
     const sharp = major.indexOf(mod12(chord.root - 1));
-    if (flat >= 0) {
+    if (natural >= 0) {
+      // A major-scale note the mode alters: ♮II in Phrygian.
+      degree = natural;
+      accidental = "♮";
+    } else if (flat >= 0) {
       degree = flat;
       accidental = "b";
     } else {
@@ -957,7 +1134,6 @@ export function romanOf(key: Key, chord: Chord): string {
   const lower =
     chord.quality === "min" ||
     chord.quality === "dim" ||
-    chord.quality === "5" ||
     chord.quality === "madd4" ||
     chord.quality === "mb6";
   const numeral = NUMERALS[degree]!;
@@ -974,7 +1150,33 @@ export function romanOf(key: Key, chord: Chord): string {
         : ext.has("M7")
           ? "maj7"
           : "";
-  return `${accidental}${body}${mark}${seventh}`;
+  // The short numeral when it reads back as this chord; else the chord's
+  // own suffix in brackets (`I[7]`, `i[m6]`, `V[7#9]`), which is exact.
+  const plain = `${accidental}${body}${mark}${seventh}`;
+  const bare = makeChord(
+    chord.root,
+    chord.quality,
+    chord.extensions,
+    undefined,
+    chord.tensions,
+  );
+  for (const candidate of [
+    plain,
+    `${accidental}${body}${mark}${seventh === "7" ? "dom7" : seventh}`,
+  ])
+    if (sameChord(parseRoman(key, candidate), bare)) return candidate;
+  return `${accidental}${body}[${chordSuffix(bare)}]`;
+}
+
+function sameChord(a: Chord | undefined, b: Chord): boolean {
+  return (
+    a !== undefined &&
+    a.root === b.root &&
+    a.quality === b.quality &&
+    a.bass === b.bass &&
+    a.extensions.join() === b.extensions.join() &&
+    (a.tensions ?? []).join() === (b.tensions ?? []).join()
+  );
 }
 
 /**
@@ -987,31 +1189,64 @@ export function romanOf(key: Key, chord: Chord): string {
  * major). `7` adds the diatonic seventh; `maj7`/`M7` and `dom7` are exact.
  */
 export function parseRoman(key: Key, text: string): Chord | undefined {
-  if (typeof text !== "string" || text.length > 16) return undefined;
+  return romanIn(key, text, tonicLetter(key));
+}
+
+/** `parseRoman` with the tonic spelled on `tonic` (0..6, C..B). */
+function romanIn(key: Key, text: string, tonic: number): Chord | undefined {
+  if (typeof text !== "string" || text.length > 32) return undefined;
   const trimmed = text.trim();
+  const exact = trimmed.match(
+    /^(b|#|♭|♯|♮)?(vii|vi|v|iv|iii|ii|i|VII|VI|V|IV|III|II|I)\[([^\]]*)\]$/,
+  );
+  if (exact) {
+    // `I[7]`: the numeral names the root, the bracket is a chord suffix.
+    const degree = NUMERALS.indexOf(exact[2]!.toLowerCase());
+    const shift =
+      exact[1] === "b" || exact[1] === "♭"
+        ? -1
+        : exact[1] === "♮" || !exact[1]
+          ? 0
+          : 1;
+    const root = !exact[1]
+      ? scaleOf(key)[degree]
+      : mod12(key.tonic + MODES.major[degree]! + shift);
+    if (root === undefined) return undefined;
+    const letter = (tonic + degree) % 7;
+    const chord = parseChord(
+      `${spellOnLetter(root, letter) ?? noteName(root)}${exact[3]!}`,
+    );
+    return chord && Object.freeze({ ...chord, letter });
+  }
   const slash = trimmed.match(/^(.+)\/(.+)$/);
   if (slash) {
     // V/x: the chord built on the degree of x in the key (secondary function).
-    const target = parseRoman(key, slash[2]!);
+    const target = romanIn(key, slash[2]!, tonic);
     if (!target) return undefined;
-    const sub = parseRoman({ tonic: target.root, mode: "major" }, slash[1]!);
-    return sub;
+    return romanIn(
+      { tonic: target.root, mode: "major" },
+      slash[1]!,
+      target.letter ?? tonic,
+    );
   }
   const match = trimmed.match(
-    /^(b|#|♭|♯)?(vii|vi|v|iv|iii|ii|i|VII|VI|V|IV|III|II|I)(°|o|ø|\+)?(maj7|M7|dom7|7|9|maj9|6|sus4|sus2|sus|add9)?$/,
+    /^(b|#|♭|♯|♮)?(vii|vi|v|iv|iii|ii|i|VII|VI|V|IV|III|II|I)(°|o|ø|\+)?(maj7|M7|dom7|7|9|maj9|6|sus4|sus2|sus|add9)?$/,
   );
   if (!match) return undefined;
   const accidental =
-    match[1] === "b" || match[1] === "♭" ? -1 : match[1] ? 1 : 0;
+    match[1] === "b" || match[1] === "♭"
+      ? -1
+      : match[1] === "#" || match[1] === "♯"
+        ? 1
+        : 0;
   const numeral = match[2]!;
   const lower = numeral === numeral.toLowerCase();
   const degree = NUMERALS.indexOf(numeral.toLowerCase());
   const mark = match[3];
   const suffix = match[4] ?? "";
-  const root =
-    accidental === 0
-      ? scaleOf(key)[degree]!
-      : mod12(key.tonic + MODES.major[degree]! + accidental);
+  const root = !match[1]
+    ? scaleOf(key)[degree]!
+    : mod12(key.tonic + MODES.major[degree]! + accidental);
   const inKey = degreeOf(key, root);
   const triad = inKey === undefined ? undefined : diatonicChord(key, inKey);
   const seventh =
@@ -1065,7 +1300,10 @@ export function parseRoman(key: Key, text: string): Chord | undefined {
       quality = "sus2";
       break;
   }
-  return makeChord(root, quality, ext);
+  return Object.freeze({
+    ...makeChord(root, quality, ext),
+    letter: (tonic + degree) % 7,
+  });
 }
 
 // ---------------------------------------------------------------------------
@@ -1107,7 +1345,17 @@ export function rotate(pitches: readonly number[], steps: number): number[] {
 
 export function rootPosition(chord: Chord, anchor = 60): number[] {
   const rootPitch = anchor + mod12(chord.root - anchor);
-  return chordIntervals(chord).map((step) => rootPitch + step);
+  const steps = chordIntervals(chord);
+  // A natural 11 over a major 3rd and a 7th is the avoid-note clash (E
+  // under F a minor 9th up in C11), so the voicing drops the 3rd: C11 is
+  // C G Bb D F, the sus voicing; C13 already leaves the 11 out.
+  const clash =
+    steps.includes(4) &&
+    steps.includes(17) &&
+    (steps.includes(10) || steps.includes(11));
+  return steps
+    .filter((step) => !(clash && step === 4))
+    .map((step) => rootPitch + step);
 }
 
 /** Open voicings: `open` drops the second voice from the top an octave
@@ -2488,6 +2736,6 @@ export function renderProgression(options: RenderOptions): RenderedProgression {
 export const CHORD_PROCESS = [
   "Chords (Orchid-style): pick chords from the song key's diatonic set (in C major: C Dm Em F G Am Bdim; minor keys i ii° III iv v VI VII, V major for cadences).",
   "Move tonic (I vi iii) → predominant (IV ii) → dominant (V vii°) → tonic; loops end on V or IV to lead home.",
-  "Add sevenths/9ths as colour (6, m7, M7, 9 extensions); voice-lead each chord to the inversion nearest the previous one in C3–G5 so common tones hold; put the root an octave or two below as bass.",
+  "Add sevenths/9ths as color (6, m7, M7, 9 extensions); voice-lead each chord to the inversion nearest the previous one in C3–G5 so common tones hold; put the root an octave or two below as bass.",
   "Use suggest_progression to get voice-led chords and write_chords to write them (block, strum, arpeggio, harp, slop or a rhythm pattern; bassMode chords|unison|single|solo), instead of hand-placing chord notes with add_notes.",
 ].join(" ");