@tspro/web-music-score 5.0.0 → 5.2.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## [5.2.0] - 2025-10-10
+## Fixed
+- Beam not created correctly near tuplet.
+- Create beam only if all beam notes are visible.
+- Not all beams in group were created.
+- play() on empty music document crashed.
+
+## Changed
+- Renamed audio-cg iife global name to Audio_CG but also support old name Audio_ClassicalGuitar.
+
+## [5.1.0] - 2025-10-08
+## Added
+- Audio functions: mute(), unmute() and isMuted().
+- Added audio-synth as an own module.
+- Added PlaybackButtons properties singlePlayStop, playStop and playPauseStop (deprecated buttonLayout).
+- Added grandId property to staff config, deprecated isGrand property.
+- Added tab signature (show tempo, measure number and time siganture).
+- Draw rhythms above tab.
+
+## Fixed
+- Documentation errors.
+- Correctly apply NoteOptions.string for each note when using addNote with arrya of notes.
+- Incorrect detection upbeat beams.
+- Increase beam separation by angle.
+- Better tempo position above staff.
+- Distance between staff and tab.
+
 ## [5.0.0] - 2025-10-05
 Major update required to enable independent browser iife instrument modules.
 

package/README.md

@@ -71,19 +71,19 @@ React module `react-ui` is not included available for browser usage.
     It is recommended to use exact version number and direct link to the bundle so
     that if something breaks between versions then your web site does not stop working.
 -->
-<script src="https://unpkg.com/@tspro/web-music-score@5.0.0/dist/iife/index.global.js"></script>
+<script src="https://unpkg.com/@tspro/web-music-score@5.2.0/dist/iife/index.global.js"></script>
 
 <!--
     Classical guitar now also available for browser module.
 -->
-<script src="https://unpkg.com/@tspro/web-music-score@5.0.0/dist/iife/audio-cg.global.js"></script>
+<script src="https://unpkg.com/@tspro/web-music-score@5.2.0/dist/iife/audio-cg.global.js"></script>
 
 <script>
     // The lib is available via global name WebMusicScore.
     const { Core, Audio, Theory, Score, Pieces } = window.WebMusicScore;
 
-    // Classical guitar audio is available via global name Audio_ClassicalGuitar.
-    const { ClassicalGuitar } = window.Audio_ClassicalGuitar;
+    // Classical guitar instrument is available via global name Audio_CG.
+    const { ClassicalGuitar } = window.Audio_CG;
 
     // Add and use classical guitar instrument.
     Audio.addInstrument(ClassicalGuitar);
@@ -150,8 +150,8 @@ or corresponding string values (e.g. `"treble"`).
     voiceIds: [0, 1]     // (optional) only present voices 0 and 1 in this staff
 })
 .setScoreConfiguration([
-    { type: "staff", clef: "G", isGrand: true },
-    { type: "staff", clef: "F", isGrand: true }
+    { type: "staff", clef: "G", grandId: "grand1" },
+    { type: "staff", clef: "F", grandId: "grand1" }
 ]) // Grand staff
 .setScoreConfiguration([
     { type: "staff", clef: "G", isOctaveDown: true },
@@ -469,13 +469,16 @@ Score.MPlayer.stopAll();
 // Draw document
 <ScoreUI.MusicScoreView doc={doc} />
 
-// Add playback buttons
-<ScoreUI.PlaybackButtons doc={doc} buttonLayout={ScoreUI.PlaybackButtonsLayout.PlayStopSingle}/> // Single Play/Stopo button
-<ScoreUI.PlaybackButtons doc={doc} buttonLayout={ScoreUI.PlaybackButtonsLayout.PlayStop}/>       // Play and Stop buttons
-<ScoreUI.PlaybackButtons doc={doc} buttonLayout={ScoreUI.PlaybackButtonsLayout.PlayPauseStop}/>  // Play, Pause and Stop buttons
+// Show playback buttons
+<ScoreUI.PlaybackButtons doc={doc} singlePlayStop /> // Single play/stop button.
+<ScoreUI.PlaybackButtons doc={doc} playStop />       // Play and stop buttons.
+<ScoreUI.PlaybackButtons doc={doc} playPauseStop />  // Play, pause and Stop buttons.
+<ScoreUI.PlaybackButtons doc={doc} />                // Default is play, pause and Stop buttons.
 ```
 
-Bootstrap is used for better visual appearance, but it needs to be installed and loaded.
+Hint! Bootstrap is used for better visual appearance.
+- Install bootstrap: `npm install bootstrap`
+- Import in app entry: `import "bootstrap/dist/css/bootstrap.min.css";`
 
 ### Viewing Using Plain JS/TS
 
@@ -508,10 +511,10 @@ let p = new Score.MPlaybackButtons().
     setDocument(doc);
 
 // You can also set combined play/stop button.
-p.setPlayStopButton("playStopButtonId")
+p.setPlayStopButton("playStopButtonId");
 
 // You can also pass HTMLButtonElement instead of element id.
-p.setPlayButton(playButtonElement)
+p.setPlayButton(playButtonElement);
 ```
 
 ### MusicError

package/dist/audio/index.d.mts

@@ -30,8 +30,21 @@ declare function useInstrument(instrumentName: string): void;
  */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
 /**
- * Stop playing on current instrument.
+ * Stop playback on current instrument.
  */
 declare function stop(): void;
+/**
+ * Mute playback on current instrument.
+ */
+declare function mute(): void;
+/**
+ * Unmute playback on current instrument.
+ */
+declare function unmute(): void;
+/**
+ * Is playback muted?
+ * @returns True/false.
+ */
+declare function isMuted(): boolean;
 
-export { Instrument, addInstrument, getCurrentInstrument, getInstrumentList, playNote, stop, useInstrument };
+export { Instrument, addInstrument, getCurrentInstrument, getInstrumentList, isMuted, mute, playNote, stop, unmute, useInstrument };

package/dist/audio/index.d.ts

@@ -1,4 +1,4 @@
-import { N as Note } from '../note-eA2xPPiG.js';
+import { N as Note } from '../note-CgCIBwvR.js';
 import { I as Instrument } from '../instrument-DYboobMW.js';
 export { l as linearToDecibels } from '../instrument-DYboobMW.js';
 
@@ -30,8 +30,21 @@ declare function useInstrument(instrumentName: string): void;
  */
 declare function playNote(note: Note | string | number, duration?: number, linearVolume?: number): void;
 /**
- * Stop playing on current instrument.
+ * Stop playback on current instrument.
  */
 declare function stop(): void;
+/**
+ * Mute playback on current instrument.
+ */
+declare function mute(): void;
+/**
+ * Unmute playback on current instrument.
+ */
+declare function unmute(): void;
+/**
+ * Is playback muted?
+ * @returns True/false.
+ */
+declare function isMuted(): boolean;
 
-export { Instrument, addInstrument, getCurrentInstrument, getInstrumentList, playNote, stop, useInstrument };
+export { Instrument, addInstrument, getCurrentInstrument, getInstrumentList, isMuted, mute, playNote, stop, unmute, useInstrument };

package/dist/audio/index.js

@@ -1,12 +1,9 @@
-/* WebMusicScore v5.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v5.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -19,16 +16,7 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 
 // src/audio/index.ts
 var audio_exports = {};
@@ -36,70 +24,25 @@ __export(audio_exports, {
   addInstrument: () => addInstrument,
   getCurrentInstrument: () => getCurrentInstrument,
   getInstrumentList: () => getInstrumentList,
+  isMuted: () => isMuted,
   linearToDecibels: () => linearToDecibels,
+  mute: () => mute,
   playNote: () => playNote,
   stop: () => stop,
+  unmute: () => unmute,
   useInstrument: () => useInstrument
 });
 module.exports = __toCommonJS(audio_exports);
 var import_theory = require("@tspro/web-music-score/theory");
-
-// src/audio/audio-synth.ts
-var Tone = __toESM(require("tone"));
+var import_core = require("@tspro/web-music-score/core");
+var import_audio_synth = require("@tspro/web-music-score/audio-synth");
 
 // src/audio/instrument.ts
 function linearToDecibels(linearVolume) {
   return !isFinite(linearVolume) || linearVolume <= 0 ? -Infinity : 20 * Math.log10(linearVolume);
 }
 
-// src/audio/audio-synth.ts
-var SynthesizerInstr = class {
-  constructor() {
-    __publicField(this, "audioSource");
-    try {
-      const reverb = new Tone.Reverb({ decay: 3, wet: 0.4 }).toDestination();
-      const filter = new Tone.Filter(800, "lowpass").connect(reverb);
-      this.audioSource = new Tone.PolySynth(Tone.Synth, {
-        oscillator: {
-          type: "triangle"
-        },
-        envelope: {
-          attack: 1e-3,
-          decay: 2,
-          sustain: 0.1,
-          release: 1.2
-        }
-      }).connect(filter);
-    } catch (err) {
-      this.audioSource = void 0;
-      console.error(err);
-    }
-  }
-  getName() {
-    return "Synthesizer";
-  }
-  playNote(note, duration, linearVolume) {
-    try {
-      if (this.audioSource) {
-        this.audioSource.volume.value = linearToDecibels(linearVolume);
-        this.audioSource.triggerAttackRelease(note, duration);
-      }
-    } catch (err) {
-    }
-  }
-  stop() {
-    try {
-      if (this.audioSource) {
-        this.audioSource.releaseAll();
-      }
-    } catch (err) {
-    }
-  }
-};
-var Synthesizer = new SynthesizerInstr();
-
 // src/audio/index.ts
-var import_core = require("@tspro/web-music-score/core");
 var import_ts_utils_lib = require("@tspro/ts-utils-lib");
 (0, import_core.init)();
 function getNoteName(note) {
@@ -110,13 +53,20 @@ function getNoteName(note) {
   }
   return note.format(import_theory.PitchNotation.Scientific, import_theory.SymbolSet.Ascii);
 }
-var InstrumentList = [Synthesizer];
-var CurrentInstrument = Synthesizer;
+var InstrumentList = [import_audio_synth.Synthesizer];
+var currentInstrument = import_audio_synth.Synthesizer;
+var DefaultDuration = (function calcDuration(noteSize, beatsPerMinute, timeTisgnature) {
+  var _a;
+  let beatSize = parseInt((_a = timeTisgnature.split("/")[1]) != null ? _a : "4");
+  return 60 * (1 / noteSize) / (beatsPerMinute * (1 / beatSize));
+})(2, 80, "4/4");
+var DefaultVolume = 1;
+var mutePlayback = false;
 function getInstrumentList() {
   return InstrumentList.map((instr) => instr.getName());
 }
 function getCurrentInstrument() {
-  return CurrentInstrument.getName();
+  return currentInstrument.getName();
 }
 function addInstrument(instrument) {
   (import_ts_utils_lib.Utils.Is.isArray(instrument) ? instrument : [instrument]).forEach((instr) => {
@@ -124,7 +74,7 @@ function addInstrument(instrument) {
       throw new import_core.MusicError(import_core.MusicErrorType.Audio, "Invalid instrument object: " + instr);
     }
     if (InstrumentList.some((instr2) => instr2.getName() === instr.getName())) {
-      console.warn(`Instrument "${instr.getName()}" already registered!`);
+      console.warn(`Instrument "${instr.getName()}" already added!`);
     } else {
       InstrumentList.push(instr);
     }
@@ -132,35 +82,44 @@ function addInstrument(instrument) {
   });
 }
 function useInstrument(instrumentName) {
-  if (instrumentName === CurrentInstrument.getName()) {
+  if (instrumentName === currentInstrument.getName()) {
     return;
   }
-  CurrentInstrument.stop();
+  currentInstrument.stop();
   let instr = InstrumentList.find((instr2) => instr2.getName() === instrumentName);
   if (instr) {
-    CurrentInstrument = instr;
+    currentInstrument = instr;
   }
 }
-var DefaultDuration = (function calcDuration(noteSize, beatsPerMinute, timeTisgnature) {
-  var _a;
-  let beatSize = parseInt((_a = timeTisgnature.split("/")[1]) != null ? _a : "4");
-  return 60 * (1 / noteSize) / (beatsPerMinute * (1 / beatSize));
-})(2, 80, "4/4");
-var DefaultVolume = 1;
 function playNote(note, duration, linearVolume) {
-  CurrentInstrument.playNote(getNoteName(note), duration != null ? duration : DefaultDuration, linearVolume != null ? linearVolume : DefaultVolume);
+  if (!mutePlayback) {
+    currentInstrument.playNote(getNoteName(note), duration != null ? duration : DefaultDuration, linearVolume != null ? linearVolume : DefaultVolume);
+  }
 }
 function stop() {
-  CurrentInstrument.stop();
+  currentInstrument.stop();
+}
+function mute() {
+  stop();
+  mutePlayback = true;
+}
+function unmute() {
+  mutePlayback = false;
+}
+function isMuted() {
+  return mutePlayback;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   addInstrument,
   getCurrentInstrument,
   getInstrumentList,
+  isMuted,
   linearToDecibels,
+  mute,
   playNote,
   stop,
+  unmute,
   useInstrument
 });
 //# sourceMappingURL=index.js.map

package/dist/audio/index.mjs

@@ -1,63 +1,13 @@
-/* WebMusicScore v5.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v5.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 import {
   linearToDecibels
-} from "../chunk-AAL3CMRO.mjs";
-import {
-  __publicField
-} from "../chunk-J3KU3U4W.mjs";
+} from "../chunk-6S5BDSCM.mjs";
+import "../chunk-LC5JMIVF.mjs";
 
 // src/audio/index.ts
 import { Note, PitchNotation, SymbolSet } from "@tspro/web-music-score/theory";
-
-// src/audio/audio-synth.ts
-import * as Tone from "tone";
-var SynthesizerInstr = class {
-  constructor() {
-    __publicField(this, "audioSource");
-    try {
-      const reverb = new Tone.Reverb({ decay: 3, wet: 0.4 }).toDestination();
-      const filter = new Tone.Filter(800, "lowpass").connect(reverb);
-      this.audioSource = new Tone.PolySynth(Tone.Synth, {
-        oscillator: {
-          type: "triangle"
-        },
-        envelope: {
-          attack: 1e-3,
-          decay: 2,
-          sustain: 0.1,
-          release: 1.2
-        }
-      }).connect(filter);
-    } catch (err) {
-      this.audioSource = void 0;
-      console.error(err);
-    }
-  }
-  getName() {
-    return "Synthesizer";
-  }
-  playNote(note, duration, linearVolume) {
-    try {
-      if (this.audioSource) {
-        this.audioSource.volume.value = linearToDecibels(linearVolume);
-        this.audioSource.triggerAttackRelease(note, duration);
-      }
-    } catch (err) {
-    }
-  }
-  stop() {
-    try {
-      if (this.audioSource) {
-        this.audioSource.releaseAll();
-      }
-    } catch (err) {
-    }
-  }
-};
-var Synthesizer = new SynthesizerInstr();
-
-// src/audio/index.ts
 import { init as initCore, MusicError, MusicErrorType } from "@tspro/web-music-score/core";
+import { Synthesizer } from "@tspro/web-music-score/audio-synth";
 import { Utils } from "@tspro/ts-utils-lib";
 initCore();
 function getNoteName(note) {
@@ -69,12 +19,19 @@ function getNoteName(note) {
   return note.format(PitchNotation.Scientific, SymbolSet.Ascii);
 }
 var InstrumentList = [Synthesizer];
-var CurrentInstrument = Synthesizer;
+var currentInstrument = Synthesizer;
+var DefaultDuration = (function calcDuration(noteSize, beatsPerMinute, timeTisgnature) {
+  var _a;
+  let beatSize = parseInt((_a = timeTisgnature.split("/")[1]) != null ? _a : "4");
+  return 60 * (1 / noteSize) / (beatsPerMinute * (1 / beatSize));
+})(2, 80, "4/4");
+var DefaultVolume = 1;
+var mutePlayback = false;
 function getInstrumentList() {
   return InstrumentList.map((instr) => instr.getName());
 }
 function getCurrentInstrument() {
-  return CurrentInstrument.getName();
+  return currentInstrument.getName();
 }
 function addInstrument(instrument) {
   (Utils.Is.isArray(instrument) ? instrument : [instrument]).forEach((instr) => {
@@ -82,7 +39,7 @@ function addInstrument(instrument) {
       throw new MusicError(MusicErrorType.Audio, "Invalid instrument object: " + instr);
     }
     if (InstrumentList.some((instr2) => instr2.getName() === instr.getName())) {
-      console.warn(`Instrument "${instr.getName()}" already registered!`);
+      console.warn(`Instrument "${instr.getName()}" already added!`);
     } else {
       InstrumentList.push(instr);
     }
@@ -90,34 +47,43 @@ function addInstrument(instrument) {
   });
 }
 function useInstrument(instrumentName) {
-  if (instrumentName === CurrentInstrument.getName()) {
+  if (instrumentName === currentInstrument.getName()) {
     return;
   }
-  CurrentInstrument.stop();
+  currentInstrument.stop();
   let instr = InstrumentList.find((instr2) => instr2.getName() === instrumentName);
   if (instr) {
-    CurrentInstrument = instr;
+    currentInstrument = instr;
   }
 }
-var DefaultDuration = (function calcDuration(noteSize, beatsPerMinute, timeTisgnature) {
-  var _a;
-  let beatSize = parseInt((_a = timeTisgnature.split("/")[1]) != null ? _a : "4");
-  return 60 * (1 / noteSize) / (beatsPerMinute * (1 / beatSize));
-})(2, 80, "4/4");
-var DefaultVolume = 1;
 function playNote(note, duration, linearVolume) {
-  CurrentInstrument.playNote(getNoteName(note), duration != null ? duration : DefaultDuration, linearVolume != null ? linearVolume : DefaultVolume);
+  if (!mutePlayback) {
+    currentInstrument.playNote(getNoteName(note), duration != null ? duration : DefaultDuration, linearVolume != null ? linearVolume : DefaultVolume);
+  }
 }
 function stop() {
-  CurrentInstrument.stop();
+  currentInstrument.stop();
+}
+function mute() {
+  stop();
+  mutePlayback = true;
+}
+function unmute() {
+  mutePlayback = false;
+}
+function isMuted() {
+  return mutePlayback;
 }
 export {
   addInstrument,
   getCurrentInstrument,
   getInstrumentList,
+  isMuted,
   linearToDecibels,
+  mute,
   playNote,
   stop,
+  unmute,
   useInstrument
 };
 //# sourceMappingURL=index.mjs.map

package/dist/audio-cg/index.d.mts

@@ -1,7 +1,12 @@
 import { I as Instrument } from '../instrument-DYboobMW.mjs';
 
 /**
- * Default export is the classical guitar instrument object.
+ * Make this module "audio-cg" in typedoc instead of "audio-instruments/audio-cg".
+ * @module audio-cg
+ */
+
+/**
+ * Export classical guitar instrument object.
  *
  * ```ts
  *   // Usage

package/dist/audio-cg/index.d.ts

@@ -1,7 +1,12 @@
 import { I as Instrument } from '../instrument-DYboobMW.js';
 
 /**
- * Default export is the classical guitar instrument object.
+ * Make this module "audio-cg" in typedoc instead of "audio-instruments/audio-cg".
+ * @module audio-cg
+ */
+
+/**
+ * Export classical guitar instrument object.
  *
  * ```ts
  *   // Usage

package/dist/audio-cg/index.js

@@ -1,4 +1,4 @@
-/* WebMusicScore v5.0.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
+/* WebMusicScore v5.2.0 | (c) 2023 PahkaSoft | MIT License | Includes: Tone.js (MIT License) */
 "use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;