abcjs 6.4.3 → 6.5.0

package/src/synth/create-synth.js

@@ -26,7 +26,7 @@ function CreateSynth() {
 	self.audioBuffers = []; // cache of the buffers so starting play can be fast.
 	self.duration = undefined; // the duration of the tune in seconds.
 	self.isRunning = false; // whether there is currently a sound buffer running.
-	self.options = undefined
+	self.options = {} // Thx tomohirohiratsuka
 	self.pickupLength = 0
 
 	// Load and cache all needed sounds
@@ -299,82 +299,91 @@ function CreateSynth() {
 			return Promise.reject(new Error(notSupportedMessage));
 		if (self.debugCallback)
 			self.debugCallback("prime called");
-		return new Promise(function(resolve) {
-			var startTime = activeAudioContext().currentTime;
-			var tempoMultiplier = self.millisecondsPerMeasure / 1000 / self.meterSize;
-			self.duration = self.flattened.totalDuration * tempoMultiplier;
-			if(self.duration <= 0) {
-				self.audioBuffers = [];
-				return resolve({ status: "empty", seconds: 0});
-			}
-			self.duration += fadeTimeSec;
-			var totalSamples = Math.floor(activeAudioContext().sampleRate * self.duration);
 
-			// There might be a previous run that needs to be turned off.
-			self.stop();
+		return new Promise(function(resolve, reject) {
+			try {
+				var startTime = activeAudioContext().currentTime;
+				var tempoMultiplier = self.millisecondsPerMeasure / 1000 / self.meterSize;
+				self.duration = self.flattened.totalDuration * tempoMultiplier;
+				if (self.duration <= 0) {
+					self.audioBuffers = [];
+					return resolve({status: "empty", seconds: 0});
+				}
+				self.duration += fadeTimeSec;
+				var totalSamples = Math.floor(activeAudioContext().sampleRate * self.duration);
 
-			var noteMapTracks = createNoteMap(self.flattened);
+				// There might be a previous run that needs to be turned off.
+				self.stop();
 
-			if (self.options.swing)
-				addSwing(noteMapTracks, self.options.swing, self.meterFraction, self.pickupLength)
+				var noteMapTracks = createNoteMap(self.flattened);
 
-			if (self.sequenceCallback)
-				self.sequenceCallback(noteMapTracks, self.callbackContext);
+				if (self.options.swing)
+					addSwing(noteMapTracks, self.options.swing, self.meterFraction, self.pickupLength)
 
-			var panDistances = setPan(noteMapTracks.length, self.pan);
+				if (self.sequenceCallback)
+					self.sequenceCallback(noteMapTracks, self.callbackContext);
 
-			// Create a simple list of all the unique sounds in this music and where they should be placed.
-			// There appears to be a limit on how many audio buffers can be created at once so this technique limits the number needed.
-			var uniqueSounds = {};
-			noteMapTracks.forEach(function(noteMap, trackNumber) {
-				var panDistance = panDistances && panDistances.length > trackNumber ? panDistances[trackNumber] : 0;
-				noteMap.forEach(function(note) {
-					var key = note.instrument + ':' + note.pitch + ':' +note.volume + ':' + Math.round((note.end-note.start)*1000)/1000 + ':' + panDistance + ':' + tempoMultiplier + ':' + (note.cents ? note.cents : 0);
-					if (self.debugCallback)
-						self.debugCallback("noteMapTrack "+key)
-					if (!uniqueSounds[key])
-						uniqueSounds[key] = [];
-					uniqueSounds[key].push(note.start);
+				var panDistances = setPan(noteMapTracks.length, self.pan);
+
+				// Create a simple list of all the unique sounds in this music and where they should be placed.
+				// There appears to be a limit on how many audio buffers can be created at once so this technique limits the number needed.
+				var uniqueSounds = {};
+				noteMapTracks.forEach(function (noteMap, trackNumber) {
+					var panDistance = panDistances && panDistances.length > trackNumber ? panDistances[trackNumber] : 0;
+					noteMap.forEach(function (note) {
+						var key = note.instrument + ':' + note.pitch + ':' + note.volume + ':' + Math.round((note.end - note.start) * 1000) / 1000 + ':' + panDistance + ':' + tempoMultiplier + ':' + (note.cents ? note.cents : 0);
+						if (self.debugCallback)
+							self.debugCallback("noteMapTrack " + key)
+						if (!uniqueSounds[key])
+							uniqueSounds[key] = [];
+						uniqueSounds[key].push(note.start);
+					});
 				});
-			});
 
-			// Now that we know what we are trying to create, construct the audio buffer by creating each sound and placing it.
-			var allPromises = [];
-			var audioBuffer = activeAudioContext().createBuffer(2, totalSamples, activeAudioContext().sampleRate);
-			for (var key2 = 0; key2 < Object.keys(uniqueSounds).length; key2++) {
-				var k = Object.keys(uniqueSounds)[key2];
-				var parts = k.split(":");
-				var cents = parts[6] !== undefined ? parseFloat(parts[6]) : 0;
-				parts = {instrument: parts[0], pitch: parseInt(parts[1], 10), volume: parseInt(parts[2], 10), len: parseFloat(parts[3]), pan: parseFloat(parts[4]), tempoMultiplier: parseFloat(parts[5]), cents: cents};
-				allPromises.push(placeNote(audioBuffer, activeAudioContext().sampleRate, parts, uniqueSounds[k], self.soundFontVolumeMultiplier, self.programOffsets[parts.instrument], fadeTimeSec, self.noteEnd/1000, self.debugCallback));
-			}
-			self.audioBuffers = [audioBuffer];
+				// Now that we know what we are trying to create, construct the audio buffer by creating each sound and placing it.
+				var allPromises = [];
+				var audioBuffer = activeAudioContext().createBuffer(2, totalSamples, activeAudioContext().sampleRate);
+				for (var key2 = 0; key2 < Object.keys(uniqueSounds).length; key2++) {
+					var k = Object.keys(uniqueSounds)[key2];
+					var parts = k.split(":");
+					var cents = parts[6] !== undefined ? parseFloat(parts[6]) : 0;
+					parts = {instrument: parts[0], pitch: parseInt(parts[1], 10), volume: parseInt(parts[2], 10), len: parseFloat(parts[3]), pan: parseFloat(parts[4]), tempoMultiplier: parseFloat(parts[5]), cents: cents};
+					allPromises.push(placeNote(audioBuffer, activeAudioContext().sampleRate, parts, uniqueSounds[k], self.soundFontVolumeMultiplier, self.programOffsets[parts.instrument], fadeTimeSec, self.noteEnd / 1000, self.debugCallback));
+				}
+				self.audioBuffers = [audioBuffer];
 
-			if (self.debugCallback) {
-				self.debugCallback("sampleRate = " + activeAudioContext().sampleRate);
-				self.debugCallback("totalSamples = " + totalSamples);
-				self.debugCallback("creationTime = " + Math.floor((activeAudioContext().currentTime - startTime)*1000) + "ms");
-			}
-			function resolveData(me) {
-				var duration = me && me.audioBuffers && me.audioBuffers.length > 0 ? me.audioBuffers[0].duration : 0;
-				return { status: activeAudioContext().state, duration: duration}
-			}
-			Promise.all(allPromises).then(function() {
-				// Safari iOS can mess with the audioContext state, so resume if needed.
-				if (activeAudioContext().state === "suspended") {
-					activeAudioContext().resume().then(function () {
-						resolve(resolveData(self));
-					})
-				} else if (activeAudioContext().state === "interrupted") {
-					activeAudioContext().suspend().then(function () {
+				if (self.debugCallback) {
+					self.debugCallback("sampleRate = " + activeAudioContext().sampleRate);
+					self.debugCallback("totalSamples = " + totalSamples);
+					self.debugCallback("creationTime = " + Math.floor((activeAudioContext().currentTime - startTime) * 1000) + "ms");
+				}
+
+				function resolveData(me) {
+					var duration = me && me.audioBuffers && me.audioBuffers.length > 0 ? me.audioBuffers[0].duration : 0;
+					return {status: activeAudioContext().state, duration: duration}
+				}
+
+				Promise.all(allPromises).then(function () {
+					// Safari iOS can mess with the audioContext state, so resume if needed.
+					if (activeAudioContext().state === "suspended") {
 						activeAudioContext().resume().then(function () {
 							resolve(resolveData(self));
 						})
-					})
-				} else {
-					resolve(resolveData(self));
-				}
-			});
+					} else if (activeAudioContext().state === "interrupted") {
+						activeAudioContext().suspend().then(function () {
+							activeAudioContext().resume().then(function () {
+								resolve(resolveData(self));
+							})
+						})
+					} else {
+						resolve(resolveData(self));
+					}
+				}).catch(function (error) {
+					reject(error)
+				});
+			} catch (error) {
+				reject(error)
+			}
 		});
 	};
 

package/src/synth/place-note.js

@@ -101,7 +101,7 @@ function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMulti
 		.catch(function (error) {
 			if (debugCallback)
 				debugCallback('placeNote catch: '+error.message)
-			return Promise.resolve()
+			return Promise.reject(error)
 		});
 }
 

package/src/test/abc_midi_sequencer_lint.js

@@ -104,7 +104,7 @@ var midiSequencerLint = function(tune) {
 					ret += element.channel;
 					ret += '\n';
 					break;
-				case "gchord":
+				case "gchordOn":
 					ret += "\t\t";
 					ret += element.tacet ? 'tacet' : 'on';
 					ret += '\n';

package/src/test/abc_parser_lint.js

@@ -53,7 +53,7 @@ var JSONSchema = require('./jsonschema-b4');
 var ParserLint = function() {
 	"use strict";
 	var decorationList = { type: 'array', optional: true, items: { type: 'string', Enum: [
-		"trill", "lowermordent", "uppermordent", "mordent", "pralltriller", "accent",
+		"trill", "trillh", "lowermordent", "uppermordent", "mordent", "pralltriller", "accent",
 		"fermata", "invertedfermata", "tenuto", "0", "1", "2", "3", "4", "5", "+", "wedge",
 		"open", "thumb", "snap", "turn", "roll", "irishroll", "breath", "shortphrase", "mediumphrase", "longphrase",
 		"segno", "coda", "D.S.", "D.C.", "fine", "crescendo(", "crescendo)", "diminuendo(", "diminuendo)", "glissando(", "glissando)",

package/src/write/creation/abstract-engraver.js

@@ -943,7 +943,8 @@ AbstractEngraver.prototype.addMeasureNumber = function (number, abselem) {
 	var dx = 0;
 	if (abselem.isClef) // If this is a clef rather than bar line, then the number shouldn't be centered because it could overlap the left side. This is an easy way to let it be centered but move it over, too.
 		dx += measureNumDim.width / 2
-	var vert = measureNumDim.width > 10 && abselem.abcelem.type === "treble" ? 13 : 11
+	// MAE 1 Oct 2024 - Change 13 to 13.5 since previously bar numbers were very slightly overlapping the top of the clef
+	var vert = measureNumDim.width > 10 && abselem.abcelem.type === "treble" ? 13.5 : 11
 	abselem.addFixed(new RelativeElement(number, dx, measureNumDim.width, vert + measureNumDim.height / spacing.STEP, { type: "barNumber", dim: this.getTextSize.attr("measurefont", 'bar-number') }));
 };
 
@@ -1025,13 +1026,16 @@ AbstractEngraver.prototype.createBarLine = function (voice, elem, isFirstStaff)
 		abselem.addRight(new RelativeElement("dots.dot", dx, 1, 5));
 	} // 2 is hardcoded
 
-	if (elem.startEnding && isFirstStaff) { // only put the first & second ending marks on the first staff
-		var textWidth = this.getTextSize.calc(elem.startEnding, "repeatfont", '').width;
-		abselem.minspacing += textWidth + 10; // Give plenty of room for the ending number.
-		this.partstartelem = new EndingElem(elem.startEnding, anchor, null);
-		voice.addOther(this.partstartelem);
+	if (elem.startEnding && isFirstStaff) {
+		// MAE 17 May 2025 - Fixes drawing issue
+		if (voice.voicenumber === 0){
+			// only put the first & second ending marks on the first staff
+			var textWidth = this.getTextSize.calc(elem.startEnding, "repeatfont", '').width;
+			abselem.minspacing += textWidth + 10; // Give plenty of room for the ending number.
+			this.partstartelem = new EndingElem(elem.startEnding, anchor, null);
+			voice.addOther(this.partstartelem);
+		}
 	}
-
 	// Add a little space to the left of the bar line so that nothing can crowd it.
 	abselem.extraw -= 5;
 

package/src/write/creation/decoration.js

@@ -175,6 +175,7 @@ var stackedDecoration = function (decoration, width, abselem, yPos, positioning,
 		"mediumphrase": "scripts.mediumphrase",
 		"longphrase": "scripts.longphrase",
 		"trill": "scripts.trill",
+		"trillh": "scripts.trill",
 		"roll": "scripts.roll",
 		"irishroll": "scripts.roll",
 		"marcato": "scripts.umarcato",
@@ -237,6 +238,7 @@ var stackedDecoration = function (decoration, width, abselem, yPos, positioning,
 			case "mediumphrase":
 			case "longphrase":
 			case "trill":
+			case "trillh":
 			case "roll":
 			case "irishroll":
 			case "marcato":

package/src/write/creation/elements/absolute-element.js

@@ -177,22 +177,33 @@ AbsoluteElement.prototype.setLimit = function (member, child) {
 };
 
 AbsoluteElement.prototype._addChild = function (child) {
-	//	console.log("Relative:",child);
-	child.parent = this;
-	this.children[this.children.length] = child;
-	this.pushTop(child.top);
-	this.pushBottom(child.bottom);
-	this.setLimit('tempoHeightAbove', child);
-	this.setLimit('partHeightAbove', child);
-	this.setLimit('volumeHeightAbove', child);
-	this.setLimit('dynamicHeightAbove', child);
-	this.setLimit('endingHeightAbove', child);
-	this.setLimit('chordHeightAbove', child);
-	this.setLimit('lyricHeightAbove', child);
-	this.setLimit('lyricHeightBelow', child);
-	this.setLimit('chordHeightBelow', child);
-	this.setLimit('volumeHeightBelow', child);
-	this.setLimit('dynamicHeightBelow', child);
+  //  console.log("Relative:",child);
+  
+  // MAE 30 Sep 2024 - To avoid extra space for chords if there is only a bar number on the clef
+  var okToPushTop = true;
+  if ((this.abcelem.el_type == "clef") && (child.type == "barNumber")){
+    okToPushTop = false;
+  }
+
+  child.parent = this;
+  this.children[this.children.length] = child;
+
+  if (okToPushTop){
+    this.pushTop(child.top);
+  }
+  
+  this.pushBottom(child.bottom);
+  this.setLimit('tempoHeightAbove', child);
+  this.setLimit('partHeightAbove', child);
+  this.setLimit('volumeHeightAbove', child);
+  this.setLimit('dynamicHeightAbove', child);
+  this.setLimit('endingHeightAbove', child);
+  this.setLimit('chordHeightAbove', child);
+  this.setLimit('lyricHeightAbove', child);
+  this.setLimit('lyricHeightBelow', child);
+  this.setLimit('chordHeightBelow', child);
+  this.setLimit('volumeHeightBelow', child);
+  this.setLimit('dynamicHeightBelow', child);
 };
 
 AbsoluteElement.prototype.pushTop = function (top) {

package/src/write/creation/elements/free-text.js

@@ -10,7 +10,12 @@ function FreeText(info, vskip, getFontAndAttr, paddingLeft, width, getTextSize)
 	} else if (typeof text === 'string') {
 		this.rows.push({ move: hash.attr['font-size'] / 2 }); // TODO-PER: move down some - the y location should be the top of the text, but we output text specifying the center line.
 		this.rows.push({ left: paddingLeft, text: text, font: 'textfont', klass: 'defined-text', anchor: "start", startChar: info.startChar, endChar: info.endChar, absElemType: "freeText", name: "free-text" });
-		size = getTextSize.calc(text, 'textfont', 'defined-text');
+	    // MAE 9 May 2025 - Force blank text lines in a text block to have height
+	    function replaceStandaloneNewlinesForTextBlocks(input) {
+	      return input.replace(/^[ \t]*\n/gm, 'X\n');;
+	    }
+	    var textForSize = replaceStandaloneNewlinesForTextBlocks(text);
+	    size = getTextSize.calc(textForSize, 'textfont', 'defined-text'); // was text
 		this.rows.push({ move: size.height });
 	} else if (text) {
 		var maxHeight = 0;

package/src/write/draw/draw.js

@@ -15,10 +15,18 @@ function draw(renderer, classes, abcTune, width, maxWidth, responsive, scale, se
 	renderer.paper.closeGroup()
 	renderer.moveY(renderer.spacing.music);
 	var staffgroups = [];
+	var nStaves = 0;
 	for (var line = 0; line < abcTune.lines.length; line++) {
 		classes.incrLine();
 		var abcLine = abcTune.lines[line];
 		if (abcLine.staff) {
+			// MAE 26 May 2025 - for incipits staff count limiting
+			nStaves++;
+			if (abcTune.formatting.maxStaves){
+				if (nStaves > abcTune.formatting.maxStaves){
+					break;
+				}
+			}
 			if (classes.shouldAddClasses)
 				groupClasses.klass = "abcjs-staff-wrapper abcjs-l" + classes.lineNumber
 			renderer.paper.openGroup(groupClasses)

package/src/write/draw/ending.js

@@ -24,9 +24,18 @@ function drawEnding(renderer, params, linestartx, lineendx, selectables) {
 
 	pathString += sprintf("M %f %f L %f %f ",
 		linestartx, y, lineendx, y);
-
-	renderer.paper.openGroup({ klass: renderer.controller.classes.generate("ending"), "data-name": "ending" });
-	printPath(renderer, { path: pathString, stroke: renderer.foregroundColor, fill: renderer.foregroundColor, "data-name": "line" });
+	renderer.paper.openGroup({
+		klass: renderer.controller.classes.generate("ending"),
+		// MAE 17 May 2025 - Ending numbers not being drawn in correct color
+		fill: renderer.foregroundColor,
+		"data-name": "ending"
+	});
+	printPath(renderer, {
+		path: pathString,
+		stroke: renderer.foregroundColor,
+		fill: renderer.foregroundColor,
+		"data-name": "line"
+	});
 	if (params.anchor1)
 		renderText(renderer, {
 			x: roundNumber(linestartx + 5),

package/src/write/draw/text.js

@@ -37,7 +37,14 @@ function renderText(renderer, params, alreadyInGroup) {
 		hash.attr.cursor = params.cursor;
 	}
 
-	var text = params.text.replace(/\n\n/g, "\n \n");
+	// MAE 9 May 2025 for free text blocks
+	var text;
+	if (params.name == "free-text"){
+		text = params.text.replace(/^[ \t]*\n/gm, ' \n');
+	}
+	else{
+		text = params.text.replace(/\n\n/g, "\n \n");
+	}
 	text = text.replace(/^\n/, "\xA0\n");
 
 	if (hash.font.box) {

package/src/write/interactive/selection.js

@@ -130,8 +130,14 @@ function keyboardSelection(ev) {
 function findElementInHistory(selectables, el) {
 	if (!el)
 		return -1;
+	// This should always exist, but it occasionally causes an exception, so check first.
+	var dataset = el.dataset
+	if (!dataset)
+		return -1
+	var index = dataset.index
 	for (var i = 0; i < selectables.length; i++) {
-		if (el.dataset.index === selectables[i].svgEl.dataset.index)
+		var svgDataset = selectables[i].svgEl.dataset
+		if (svgDataset && index === svgDataset.index)
 			return i;
 	}
 	return -1;

package/src/write/svg.js

@@ -176,8 +176,14 @@ Svg.prototype.text = function (text, attr, target) {
 			el.setAttribute(key, attr[key]);
 		}
 	}
+	var isFreeText = (attr["data-name"] == "free-text");
 	var lines = ("" + text).split("\n");
 	for (var i = 0; i < lines.length; i++) {
+		if (isFreeText && (lines[i] == "")){
+	      // Don't draw empty lines
+	      continue;
+	    }
+
 		var line = document.createElementNS(svgNS, 'tspan');
 		line.setAttribute("x", attr.x ? attr.x : 0);
 		if (i !== 0)
@@ -200,8 +206,23 @@ Svg.prototype.text = function (text, attr, target) {
 				ts3.textContent = parts[2];
 				line.appendChild(ts3);
 			}
-		} else
-			line.textContent = lines[i];
+		}     
+		else 
+    	{
+	      // MAE 9 May 2025 - For improved block text
+	      if (isFreeText){
+	        // Fixes issue where blank lines in text blocks didn't take up any vertical
+	        if (lines[i].trim() == ""){
+	          line.innerHTML = "&nbsp;";
+	        }
+	        else{
+	          line.textContent = lines[i];
+	        }
+	      }
+	      else{
+	        line.textContent = lines[i];
+	      }
+    	}	
 		el.appendChild(line);
 	}
 	if (target)

package/types/index.d.ts

@@ -61,7 +61,7 @@ declare module 'abcjs' {
 
 	export type NoteHeadType = 'normal' | 'harmonic' | 'rhythm' | 'x' | 'triangle';
 
-	export type Decorations = "trill" | "lowermordent" | "uppermordent" | "mordent" | "pralltriller" | "accent" |
+	export type Decorations = "trill" | "trillh" | "lowermordent" | "uppermordent" | "mordent" | "pralltriller" | "accent" |
 		"fermata" | "invertedfermata" | "tenuto" | "0" | "1" | "2" | "3" | "4" | "5" | "+" | "wedge" |
 		"open" | "thumb" | "snap" | "turn" | "roll" | "irishroll" | "breath" | "shortphrase" | "mediumphrase" | "longphrase" |
 		"segno" | "coda" | "D.S." | "D.C." | "fine" | "crescendo(" | "crescendo)" | "diminuendo(" | "diminuendo)" |"glissando(" | "glissando)" |

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.4.3';
+var version = '6.5.0';
 
 module.exports = version;