@tspro/web-music-score 4.0.1 → 4.2.0

package/dist/theory/index.mjs

@@ -1,7 +1,15 @@
-/* WebMusicScore v4.0.1 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v4.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+import {
+  NoteLength,
+  NoteLengthProps,
+  RhythmProps,
+  Tuplet,
+  validateNoteLength,
+  validateTupletRatio
+} from "../chunk-7MNV5JN6.mjs";
 import {
   __publicField
-} from "../chunk-YFPLOHP2.mjs";
+} from "../chunk-5NWLGWHS.mjs";
 
 // src/theory/chord.ts
 import { Utils as Utils6 } from "@tspro/ts-utils-lib";
@@ -1808,260 +1816,27 @@ function getTuningStrings(tuningName) {
 }
 
 // src/theory/time-signature.ts
-import { Utils as Utils9 } from "@tspro/ts-utils-lib";
-
-// src/theory/rhythm.ts
 import { Utils as Utils8 } from "@tspro/ts-utils-lib";
 import { MusicError as MusicError8, MusicErrorType as MusicErrorType8 } from "@tspro/web-music-score/core";
-var cmp = (a, b) => a === b ? 0 : a < b ? -1 : 1;
-var MaxTupletRatioValue = 12;
-var TicksMultiplier = 12 * 11 * 9 * 7 * 5;
-var NoteLength = /* @__PURE__ */ ((NoteLength3) => {
-  NoteLength3["Whole"] = "1n";
-  NoteLength3["WholeTriplet"] = "1t";
-  NoteLength3["WholeDot"] = "1.";
-  NoteLength3["Whole2Dots"] = "1..";
-  NoteLength3["Whole12Dots"] = "1..";
-  NoteLength3["Whole3Dots"] = "1...";
-  NoteLength3["Whole4Dots"] = "1....";
-  NoteLength3["Whole5Dots"] = "1.....";
-  NoteLength3["Whole6Dots"] = "1......";
-  NoteLength3["Half"] = "2n";
-  NoteLength3["HalfTriplet"] = "2t";
-  NoteLength3["HalfDot"] = "2.";
-  NoteLength3["Half2Dots"] = "2..";
-  NoteLength3["Half3Dots"] = "2...";
-  NoteLength3["Half4Dots"] = "2....";
-  NoteLength3["Half5Dots"] = "2.....";
-  NoteLength3["Quarter"] = "4n";
-  NoteLength3["QuarterTriplet"] = "4t";
-  NoteLength3["QuarterDot"] = "4.";
-  NoteLength3["Quarter2Dots"] = "4..";
-  NoteLength3["Quarter3Dots"] = "4...";
-  NoteLength3["Quarter4Dots"] = "4....";
-  NoteLength3["Eighth"] = "8n";
-  NoteLength3["EighthTriplet"] = "8t";
-  NoteLength3["EighthDot"] = "8.";
-  NoteLength3["Eighth2Dots"] = "8..";
-  NoteLength3["Eighth3Dots"] = "8...";
-  NoteLength3["Sixteenth"] = "16n";
-  NoteLength3["SixteenthTriplet"] = "16t";
-  NoteLength3["SixteenthDot"] = "16.";
-  NoteLength3["Sixteenth2Dots"] = "16..";
-  NoteLength3["ThirtySecond"] = "32n";
-  NoteLength3["ThirtySecondTriplet"] = "32t";
-  NoteLength3["ThirtySecondDot"] = "32.";
-  NoteLength3["SixtyFourth"] = "64n";
-  NoteLength3["SixtyFourthTriplet"] = "64t";
-  return NoteLength3;
-})(NoteLength || {});
-function validateNoteLength(noteLength) {
-  if (Utils8.Is.isEnumValue(noteLength, NoteLength)) {
-    return noteLength;
-  } else {
-    throw new MusicError8(MusicErrorType8.InvalidArg, `Invalid noteLength: ${noteLength}`);
-  }
-}
-var _NoteLengthProps = class _NoteLengthProps {
-  constructor(noteLength) {
-    /** Note length. */
-    __publicField(this, "noteLength");
-    /** Note size (whole=1, half=2, quarter=4, ...). */
-    __publicField(this, "noteSize");
-    /** Number of ticks (not altered by isTriplet). */
-    __publicField(this, "ticks");
-    /** Flag count. */
-    __publicField(this, "flagCount");
-    /** Dot count. */
-    __publicField(this, "dotCount");
-    /** Max dot count. */
-    __publicField(this, "maxDotCount");
-    /** Is triplet? */
-    __publicField(this, "isTriplet");
-    /** Has note stem. */
-    __publicField(this, "hasStem");
-    /** Is note head solid (black)? */
-    __publicField(this, "isSolid");
-    this.noteLength = validateNoteLength(noteLength);
-    this.noteSize = parseInt(noteLength);
-    this.isTriplet = noteLength.endsWith("t");
-    this.maxDotCount = this.isTriplet ? 0 : Math.floor(Math.log2(_NoteLengthProps.ShortestNoteSize / this.noteSize));
-    this.dotCount = Utils8.Str.charCount(noteLength, ".");
-    this.flagCount = this.noteSize > 4 ? Math.floor(Math.log2(this.noteSize / 4)) : 0;
-    this.ticks = TicksMultiplier * _NoteLengthProps.ShortestNoteSize / this.noteSize;
-    this.hasStem = this.noteSize > 1;
-    this.isSolid = this.noteSize > 2;
-    if (this.dotCount > this.maxDotCount) {
-      throw new MusicError8(MusicErrorType8.Note, `dotCount ${this.dotCount} > maxDotCount ${this.maxDotCount}, for noteLength "${this.noteLength}".`);
-    } else if (this.isTriplet && this.dotCount > 0) {
-      throw new MusicError8(MusicErrorType8.Note, `noteLength "${this.noteLength}" is both triplet and dotted!`);
-    }
-  }
-  /**
-   * Get note length props.
-   * @param noteLength - Note length.
-   * @returns - Note length props.
-   */
-  static get(noteLength) {
-    let p = this.cache.get(noteLength);
-    if (!p) {
-      this.cache.set(noteLength, p = new _NoteLengthProps(noteLength));
-    }
-    return p;
-  }
-  /**
-   * Create note length props.
-   * @param noteLength - Note length or note size.
-   * @param dotCount - Dot count.
-   * @returns - Note length props.
-   */
-  static create(noteLength, dotCount = 0) {
-    let noteSize = typeof noteLength === "number" ? noteLength : this.get(noteLength).noteSize;
-    return this.get(noteSize + (Utils8.Is.isIntegerGte(dotCount, 1) ? ".".repeat(dotCount) : "n"));
-  }
-  /**
-   * Compare note lengths/sizes. Whole (1) > half (2) > quarter (4), etc.
-   * Ignores possible triplet property of note length.
-   * @param a - NoteLengthProps, NoteLength/Str or noteSize
-   * @param b - NoteLengthProps, NoteLength/Str or noteSize
-   * @returns - -1: a < b, 0: a === b, +1: a > b (note length/size comparisons)
-   */
-  static cmp(a, b) {
-    let aNoteSize = a instanceof _NoteLengthProps ? a.noteSize : typeof a === "number" ? a : _NoteLengthProps.get(a).noteSize;
-    let bNoteSize = b instanceof _NoteLengthProps ? b.noteSize : typeof b === "number" ? b : _NoteLengthProps.get(b).noteSize;
-    return cmp(bNoteSize, aNoteSize);
-  }
-  /**
-   * Compare note lengths/sizes for equality.
-   * Ignores possible triplet property of note length.
-   * @param a - NoteLengthProps, NoteLength/Str or noteSize
-   * @param b - NoteLengthProps, NoteLength/Str or noteSize
-   * @returns - true: a === b, false: a !== b (note length/size comparisons)
-   */
-  static equals(a, b) {
-    let aNoteSize = a instanceof _NoteLengthProps ? a.noteSize : typeof a === "number" ? a : _NoteLengthProps.get(a).noteSize;
-    let bNoteSize = b instanceof _NoteLengthProps ? b.noteSize : typeof b === "number" ? b : _NoteLengthProps.get(b).noteSize;
-    return aNoteSize === bNoteSize;
-  }
-};
-/** Longest note size (e.g. 1 = whole note). */
-__publicField(_NoteLengthProps, "LongestNoteSize", Math.min(...Utils8.Enum.getEnumValues(NoteLength).map((noteLength) => parseInt(noteLength))));
-/** Shortest note size (e.g. 64 = sixtyfourth note). */
-__publicField(_NoteLengthProps, "ShortestNoteSize", Math.max(...Utils8.Enum.getEnumValues(NoteLength).map((noteLength) => parseInt(noteLength))));
-__publicField(_NoteLengthProps, "cache", /* @__PURE__ */ new Map());
-var NoteLengthProps = _NoteLengthProps;
-function validateTupletRatio(tupletRatio) {
-  if (Utils8.Is.isObject(tupletRatio) && Utils8.Is.isIntegerBetween(tupletRatio.parts, 2, MaxTupletRatioValue) && Utils8.Is.isIntegerBetween(tupletRatio.inTimeOf, 2, MaxTupletRatioValue)) {
-    return tupletRatio;
-  } else {
-    throw new MusicError8(MusicErrorType8.Note, `Invalid tupletRatio ${JSON.stringify(tupletRatio)}`);
-  }
-}
-var Tuplet = {
-  /** Duplet: 2 in the time of 3 */
-  Duplet: { parts: 2, inTimeOf: 3 },
-  /** Triplet: 3 in the time of 2 */
-  Triplet: { parts: 3, inTimeOf: 2 },
-  /** Quadruplet: 4 in the time of 3 */
-  Quadruplet: { parts: 4, inTimeOf: 3 }
-};
-var _RhythmProps = class _RhythmProps {
-  constructor(noteLength, dotCount, tupletRatio) {
-    /** Note length. */
-    __publicField(this, "noteLength");
-    /** Note size (whole=1, half=2, quarter=4, ...). */
-    __publicField(this, "noteSize");
-    /** Dot count. */
-    __publicField(this, "dotCount");
-    /** Tuplet ratio. */
-    __publicField(this, "tupletRatio");
-    /** Number of ticks. */
-    __publicField(this, "ticks");
-    /** Flag count. */
-    __publicField(this, "flagCount");
-    /** Has note stem. */
-    __publicField(this, "hasStem");
-    /** Is note head solid (black)? */
-    __publicField(this, "isSolidNoteHead");
-    this.noteLength = validateNoteLength(noteLength);
-    let p = NoteLengthProps.get(noteLength);
-    this.noteSize = p.noteSize;
-    this.ticks = p.ticks;
-    this.flagCount = p.flagCount;
-    this.dotCount = dotCount != null ? dotCount : p.dotCount;
-    this.hasStem = p.hasStem;
-    this.isSolidNoteHead = p.isSolid;
-    if (Utils8.Is.isObject(tupletRatio)) {
-      this.tupletRatio = validateTupletRatio(tupletRatio);
-    } else if (p.isTriplet) {
-      this.tupletRatio = Tuplet.Triplet;
-    } else {
-      this.tupletRatio = void 0;
-    }
-    if (this.dotCount > 0 && this.tupletRatio !== void 0) {
-      throw new MusicError8(MusicErrorType8.Note, `Note cannot be both dotted and tuplet!`);
-    } else if (this.dotCount > p.maxDotCount) {
-      throw new MusicError8(MusicErrorType8.Note, `Too big dot count ${this.dotCount} for note length ${this.noteLength}.`);
-    }
-    for (let add = this.ticks / 2, i = 1; i <= this.dotCount; i++, add /= 2) {
-      this.ticks += add;
-    }
-    if (this.tupletRatio) {
-      this.ticks *= this.tupletRatio.inTimeOf / this.tupletRatio.parts;
-    }
-  }
-  /**
-   * Get string presentation of rhythm props.
-   * @returns - String presentation.
-   */
-  toString() {
-    let sym = _RhythmProps.NoteSymbolMap.get(this.noteSize);
-    let dots = ".".repeat(this.dotCount);
-    return sym ? sym + dots : "" + this.noteSize + (dots.length > 0 ? dots : "n");
-  }
-  /**
-   * Get rhythm props with given arguments.
-   * @param noteLength - Note length.
-   * @param dotCount - Dot count.
-   * @param tupletRatio - Tuplet ratio.
-   * @returns - Rhythm props.
-   */
-  static get(noteLength, dotCount, tupletRatio) {
-    if (dotCount !== void 0 || tupletRatio !== void 0) {
-      return new _RhythmProps(noteLength, dotCount, tupletRatio);
-    } else {
-      let rhythmProps = this.cache.get(noteLength);
-      if (!rhythmProps) {
-        this.cache.set(noteLength, rhythmProps = new _RhythmProps(noteLength));
-      }
-      return rhythmProps;
-    }
-  }
-  /**
-   * Compare duration of rhythm props.
-   * @param a - RhythmProps
-   * @param b - RhythmProps
-   * @returns - -1: a < b, 0: a === b, +1: a > b (duration comparisons)
-   */
-  static cmp(a, b) {
-    return cmp(a.ticks, b.ticks);
-  }
-  /**
-   * Compare duration equality of rhythm props.
-   * @param a - RhythmProps
-   * @param b - RhythmProps
-   * @returns - true: a === b, false: a !== b (duration comparisons)
-   */
-  static equals(a, b) {
-    return a.ticks === b.ticks;
-  }
-};
-__publicField(_RhythmProps, "NoteSymbolMap", /* @__PURE__ */ new Map([[1, "\u{1D15D}"], [2, "\u{1D15E}"], [4, "\u{1D15F}"], [8, "\u{1D160}"], [16, "\u{1D161}"], [32, "\u{1D162}"], [64, "\u{1D163}"], [128, "\u{1D164}"]]));
-__publicField(_RhythmProps, "cache", /* @__PURE__ */ new Map());
-var RhythmProps = _RhythmProps;
-
-// src/theory/time-signature.ts
-import { MusicError as MusicError9, MusicErrorType as MusicErrorType9 } from "@tspro/web-music-score/core";
+var TimeSignatures = /* @__PURE__ */ ((TimeSignatures2) => {
+  TimeSignatures2["_2_4"] = "2/4";
+  TimeSignatures2["_3_4"] = "3/4";
+  TimeSignatures2["_4_4"] = "4/4";
+  TimeSignatures2["_3_8"] = "3/8";
+  TimeSignatures2["_5_8"] = "5/8";
+  TimeSignatures2["_6_8"] = "6/8";
+  TimeSignatures2["_7_8"] = "7/8";
+  TimeSignatures2["_9_8"] = "9/8";
+  TimeSignatures2["_12_8"] = "12/8";
+  return TimeSignatures2;
+})(TimeSignatures || {});
+var BeamGrouping = /* @__PURE__ */ ((BeamGrouping2) => {
+  BeamGrouping2["_2_3"] = "2-3";
+  BeamGrouping2["_3_2"] = "3-2";
+  BeamGrouping2["_2_2_3"] = "2-2-3";
+  BeamGrouping2["_3_2_2"] = "3-2-2";
+  return BeamGrouping2;
+})(BeamGrouping || {});
 var TimeSignature = class {
   constructor(...args) {
     /** Number of beats in measure, upper value (e.g. "3" in "3/4"). */
@@ -2072,39 +1847,66 @@ var TimeSignature = class {
     __publicField(this, "beatLength");
     /** Number of ticks in measure. */
     __publicField(this, "measureTicks");
-    /** Number of beam groups in measure. */
-    __publicField(this, "beamGroupCount");
-    /** Length of one beam group. */
-    __publicField(this, "beamGroupLength");
-    if (args.length === 1 && typeof args[0] === "string") {
+    /** Beam groups (e.g. [[2], [2]] or [[2, 2], [2, 2]] (first try as [[4], [4]])). */
+    __publicField(this, "beamGroupSizes", []);
+    let beamGrouping;
+    if (Utils8.Is.isEnumValue(args[0], TimeSignatures)) {
       let parts = args[0].split("/");
       this.beatCount = +parts[0];
       this.beatSize = +parts[1];
-    } else if (args.length === 2 && typeof args[0] === "number" && typeof args[1] === "number") {
+      if (Utils8.Is.isEnumValue(args[1], BeamGrouping)) {
+        beamGrouping = args[1];
+      }
+    } else if (Utils8.Is.isIntegerGte(args[0], 2) && Utils8.Is.isIntegerGte(args[1], 2)) {
       this.beatCount = args[0];
       this.beatSize = args[1];
+      if (Utils8.Is.isEnumValue(args[2], BeamGrouping)) {
+        beamGrouping = args[2];
+      }
     } else {
-      throw new MusicError9(MusicErrorType9.Timesignature, `Invalid args: ${args}`);
-    }
-    if (!Utils9.Is.isIntegerGte(this.beatCount, 1)) {
-      throw new MusicError9(MusicErrorType9.Timesignature, `Invalid beatCount: ${this.beatCount}`);
-    } else if (!Utils9.Is.isIntegerGte(this.beatSize, 1)) {
-      throw new MusicError9(MusicErrorType9.Timesignature, `Invalid beatSize: ${this.beatSize}`);
-    }
-    let props = NoteLengthProps.create(this.beatSize);
-    this.beatLength = props.noteLength;
-    this.measureTicks = this.beatCount * props.ticks;
-    if (this.is(2, 4) || this.is(3, 4) || this.is(4, 4)) {
-      this.beamGroupCount = this.beatCount;
-    } else if (this.is(6, 8) || this.is(9, 8)) {
-      this.beamGroupCount = this.beatCount / 3;
-    } else {
-      console.warn("Not necessarily an error, but unsupported time signature: " + this.toString());
-      this.beamGroupCount = 1;
+      throw new MusicError8(MusicErrorType8.Timesignature, `Invalid args: ${args}`);
+    }
+    if (!Utils8.Is.isIntegerGte(this.beatCount, 1)) {
+      throw new MusicError8(MusicErrorType8.Timesignature, `Invalid beatCount: ${this.beatCount}`);
+    } else if (!Utils8.Is.isIntegerGte(this.beatSize, 1)) {
+      throw new MusicError8(MusicErrorType8.Timesignature, `Invalid beatSize: ${this.beatSize}`);
+    }
+    let { noteLength, ticks } = NoteLengthProps.create(this.beatSize);
+    this.beatLength = noteLength;
+    this.measureTicks = this.beatCount * ticks;
+    if (this.is(2, 4)) {
+      this.beamGroupSizes = [[2], [2]];
+    } else if (this.is(3, 4)) {
+      this.beamGroupSizes = [[2], [2], [2]];
+    } else if (this.is(4, 4)) {
+      this.beamGroupSizes = [[2, 2], [2, 2]];
+    } else if (this.is(3, 8)) {
+      this.beamGroupSizes = [[3]];
+    } else if (this.is(5, 8)) {
+      if (!Utils8.Is.isUndefined(beamGrouping) && beamGrouping !== "2-3" /* _2_3 */ && beamGrouping !== "3-2" /* _3_2 */) {
+        throw new MusicError8(MusicErrorType8.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
+      } else {
+        this.beamGroupSizes = beamGrouping === "3-2" /* _3_2 */ ? [[3], [2]] : [[2], [3]];
+        beamGrouping = void 0;
+      }
+    } else if (this.is(6, 8)) {
+      this.beamGroupSizes = [[3], [3]];
+    } else if (this.is(7, 8)) {
+      if (!Utils8.Is.isUndefined(beamGrouping) && beamGrouping !== "2-2-3" /* _2_2_3 */ && beamGrouping !== "3-2-2" /* _3_2_2 */) {
+        throw new MusicError8(MusicErrorType8.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
+      } else {
+        this.beamGroupSizes = beamGrouping === "3-2-2" /* _3_2_2 */ ? [[3], [2], [2]] : [[2], [2], [3]];
+        beamGrouping = void 0;
+      }
+    } else if (this.is(9, 8)) {
+      this.beamGroupSizes = [[3], [3], [3]];
+    } else if (this.is(12, 8)) {
+      this.beamGroupSizes = [[3], [3], [3], [3]];
     }
-    this.beamGroupLength = this.measureTicks / this.beamGroupCount;
-    if (!Utils9.Is.isIntegerGte(this.beamGroupLength, 1)) {
-      throw new MusicError9(MusicErrorType9.Timesignature, `Invalid beamGroupLength: ${this.beamGroupLength}`);
+    if (this.beamGroupSizes.length === 0) {
+      throw new MusicError8(MusicErrorType8.Timesignature, `Unimplemented time signature "${this.toString()}".`);
+    } else if (beamGrouping !== void 0) {
+      throw new MusicError8(MusicErrorType8.Timesignature, `Invalid beam grouping "${beamGrouping}" for time signature "${this.toString()}".`);
     }
   }
   /**
@@ -2155,6 +1957,7 @@ import { init as initCore } from "@tspro/web-music-score/core";
 initCore();
 export {
   AccidentalType,
+  BeamGrouping,
   Chord,
   DefaultGuitarNoteLabel,
   DefaultHandedness,
@@ -2177,6 +1980,7 @@ export {
   ScaleType,
   SymbolSet,
   TimeSignature,
+  TimeSignatures,
   TuningNameList,
   Tuplet,
   alterTempoSpeed,

package/package.json

@@ -1,11 +1,15 @@
 {
     "name": "@tspro/web-music-score",
-    "version": "4.0.1",
+    "version": "4.2.0",
     "author": "PahkaSoft",
     "license": "MIT",
     "private": false,
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/pahkasoft/web-music-score.git"
+    },
     "bugs": {
-        "url": "https://github.com/pahkasoft/issues/issues/new"
+        "url": "https://github.com/pahkasoft/web-music-score/issues/new/choose"
     },
     "description": "TS/JS component for rendering and playing music scores in the browser.",
     "exports": {
@@ -102,6 +106,7 @@
         "@tspro/tsup-plugin-inline-assets": "^1.0.0",
         "@types/react": "^18.0.0",
         "@types/react-dom": "^18.0.0",
+        "rimraf": "^6.0.1",
         "tsup": "^8.5.0",
         "typedoc": "^0.28.6",
         "typescript": "latest"
@@ -117,4 +122,4 @@
         "build:prod (all workspaces)": "npm run build && npm run build:prod --workspaces --if-present",
         "docs": "typedoc"
     }
-}
+}