abcjs 6.2.0 → 6.2.2

package/dist/abcjs-plugin-min.js.LICENSE

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/index.js

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/license.js

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abcjs",
-  "version": "6.2.0",
+  "version": "6.2.2",
   "description": "Renderer for abc music notation",
   "main": "index.js",
   "types": "types/index.d.ts",

package/plugin.js

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/src/api/abc_tablatures.js

@@ -13,6 +13,8 @@ var GuitarTablature = require('../tablatures/instruments/guitar/tab-guitar');
 // Existing tab classes 
 var pluginTab = {
   'violin': 'ViolinTab',
+  'fiddle': 'ViolinTab',
+  'mandolin': 'ViolinTab',
   'guitar': 'GuitarTab'
 };
 

package/src/api/abc_timing_callbacks.js

@@ -17,7 +17,7 @@ var TimingCallbacks = function(target, params) {
 	self.replaceTarget = function(newTarget) {
 		self.noteTimings = newTarget.setTiming(self.qpm, self.extraMeasuresAtBeginning);
 		if (newTarget.noteTimings.length === 0)
-			newTarget.setTiming(0,0);
+			self.noteTimings = newTarget.setTiming(0,0);
 		if (self.lineEndCallback) {
 			self.lineEndTimings = getLineEndTimings(newTarget.noteTimings, self.lineEndAnticipation);
 		}

package/src/data/abc_tune.js

@@ -572,7 +572,7 @@ var Tune = function() {
 		if (!this.engraver || !this.engraver.staffgroups) {
 			console.log("setTiming cannot be called before the tune is drawn.");
 			this.noteTimings = [];
-			return;
+			return this.noteTimings;
 		}
 
 		var tempo = this.metaText ? this.metaText.tempo : null;

package/src/synth/create-synth.js

@@ -165,6 +165,9 @@ function CreateSynth() {
 				notes.push({ instrument: instrument, note: note });
 			});
 		});
+		if (self.debugCallback)
+			self.debugCallback("notes "+JSON.stringify(notes));
+
 		// If there are lots of notes, load them in batches
 		var batches = [];
 		var CHUNK = 256;
@@ -181,8 +184,13 @@ function CreateSynth() {
 
 			var index = 0;
 			var next = function() {
+				if (self.debugCallback)
+					self.debugCallback("loadBatch idx="+index+ " len="+batches.length);
+	
 				if (index < batches.length) {
 					self._loadBatch(batches[index], self.soundFontUrl, startTime).then(function(data) {
+						if (self.debugCallback)
+							self.debugCallback("loadBatch then");
 						startTime = activeAudioContext().currentTime;
 						if (data) {
 							if (data.error)
@@ -194,6 +202,9 @@ function CreateSynth() {
 						next();
 					}, reject);
 				} else {
+					if (self.debugCallback)
+						self.debugCallback("resolve init");
+		
 					resolve(results);
 				}
 			};
@@ -205,6 +216,8 @@ function CreateSynth() {
 		// This is called recursively to see if the sounds have loaded. The "delay" parameter is how long it has been since the original call.
 		var promises = [];
 		batch.forEach(function(item) {
+			if (self.debugCallback)
+				self.debugCallback("getNote " + item.instrument+':'+item.note);
 			promises.push(getNote(soundFontUrl, item.instrument, item.note, activeAudioContext()));
 		});
 		return Promise.all(promises).then(function(response) {
@@ -227,6 +240,8 @@ function CreateSynth() {
 					error.push(which + ' ' + oneResponse.message);
 			}
 			if (pending.length > 0) {
+				if (self.debugCallback)
+					self.debugCallback("pending " + JSON.stringify(pending));
 				// There was probably a second call for notes before the first one finished, so just retry a few times to see if they stop being pending.
 				// Retry quickly at first so that there isn't an unnecessary delay, but increase the delay each time.
 				if (!delay)
@@ -241,7 +256,9 @@ function CreateSynth() {
 								which = pending[i].split(":");
 								newBatch.push({instrument: which[0], note: which[1]});
 							}
-							self._loadBatch(newBatch, soundFontUrl, startTime, delay).then(function (response) {
+							if (self.debugCallback)
+								self.debugCallback("retry " + JSON.stringify(newBatch));
+									self._loadBatch(newBatch, soundFontUrl, startTime, delay).then(function (response) {
 								resolve(response);
 							}).catch(function (error) {
 								reject(error);
@@ -252,11 +269,18 @@ function CreateSynth() {
 					var list = [];
 					for (var j = 0; j < batch.length; j++)
 						list.push(batch[j].instrument+'/'+batch[j].note)
-					return Promise.reject(new Error("timeout attempting to load: " + list.join(", ")));
+						if (self.debugCallback)
+							self.debugCallback("loadBatch timeout")
+						return Promise.reject(new Error("timeout attempting to load: " + list.join(", ")));
 				}
-			} else
+			} else {
+				if (self.debugCallback)
+					self.debugCallback("loadBatch resolve")
 				return Promise.resolve({loaded: loaded, cached: cached, error: error});
+			}
 		}).catch(function (error) {
+			if (self.debugCallback)
+				self.debugCallback("loadBatch catch "+error.message)
 		});
 	});
 
@@ -299,6 +323,8 @@ function CreateSynth() {
 				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);
@@ -313,7 +339,7 @@ function CreateSynth() {
 				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));
+				allPromises.push(placeNote(audioBuffer, activeAudioContext().sampleRate, parts, uniqueSounds[k], self.soundFontVolumeMultiplier, self.programOffsets[parts.instrument], fadeTimeSec, self.noteEnd/1000, self.debugCallback));
 			}
 			self.audioBuffers = [audioBuffer];
 

package/src/synth/load-note.js

@@ -16,7 +16,7 @@ var getNote = function (url, instrument, name, audioContext) {
 			xhr.responseType = "arraybuffer";
 			xhr.onload = function () {
 				if (xhr.status !== 200) {
-					reject(Error("Can't load sound at " + noteUrl));
+					reject(Error("Can't load sound at " + noteUrl + ' status=' + xhr.status));
 					return
 				}
 				var noteDecoded = function(audioBuffer) {

package/src/synth/place-note.js

@@ -2,7 +2,7 @@ var soundsCache = require('./sounds-cache');
 var pitchToNoteName = require('./pitch-to-note-name');
 var centsToFactor = require("./cents-to-factor");
 
-function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMultiplier, ofsMs, fadeTimeSec, noteEndSec) {
+function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMultiplier, ofsMs, fadeTimeSec, noteEndSec, debugCallback) {
 	// sound contains { instrument, pitch, volume, len, pan, tempoMultiplier
 	// len is in whole notes. Multiply by tempoMultiplier to get seconds.
 	// ofsMs is an offset to subtract from the note to line up programs that have different length onsets.
@@ -21,6 +21,8 @@ function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMulti
 
 	if (!noteBufferPromise) {
 		// if the note isn't present then just skip it - it will leave a blank spot in the audio.
+		if (debugCallback)
+			debugCallback('placeNote skipped: '+sound.instrument+':'+noteName)
 		return Promise.resolve();
 	}
 
@@ -81,6 +83,8 @@ function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMulti
 						copyToChannel(outputAudioBuffer, e.renderedBuffer, start);
 					}
 				}
+				if (debugCallback)
+					debugCallback('placeNote: '+sound.instrument+':'+noteName)
 				fnResolve();
 			};
 			offlineCtx.startRendering();
@@ -88,7 +92,11 @@ function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMulti
 				fnResolve = resolve;
 			});
 		})
-		.catch(function () {});
+		.catch(function (error) {
+			if (debugCallback)
+				debugCallback('placeNote catch: '+error.message)
+			return Promise.resolve()
+		});
 }
 
 var copyToChannel = function(toBuffer, fromBuffer, start) {

package/src/tablatures/instruments/string-patterns.js

@@ -285,7 +285,7 @@ function StringPatterns(plugin) {
   this.measureAccidentals = {}
   this.capo = 0;
   if (capo) {
-    this.capo = capo;
+    this.capo = parseInt(capo,10);
   }
   this.transpose = plugin.transpose ? plugin.transpose : 0
   this.tuning = tuning;

package/src/tablatures/tab-renderer.js

@@ -227,6 +227,7 @@ TabRenderer.prototype.doLayout = function () {
   this.tabStaff.voices = [];
   for (var ii = 0; ii < nbVoices; ii++) {
     var tabVoice = new VoiceElement(0, 0);
+    if (ii > 0) tabVoice.duplicate = true;
     var nameHeight = buildTabName(this, tabVoice) / spacing.STEP;
     nameHeight = Math.max(nameHeight, 1) // If there is no label for the tab line, then there needs to be a little padding
     staffGroup.staffs[this.staffIndex].top += nameHeight;

package/src/write/draw/print-line.js

@@ -7,6 +7,25 @@ function printLine(renderer, x1, x2, y, klass, name, dy) {
 	x2 = roundNumber(x2);
 	var y1 = roundNumber(y - dy);
 	var y2 = roundNumber(y + dy);
+	// TODO-PER: This fixes a firefox bug where it isn't displayed
+	if (renderer.firefox112) {
+		y += dy / 2; // Because the y coordinate is the edge of where the line goes but the width widens from the middle.
+		var attr = {
+			x1: x1,
+			x2: x2,
+			y1: y,
+			y2: y,
+			stroke: renderer.foregroundColor,
+			'stroke-width': Math.abs(dy*2)
+		}
+		if (klass)
+			attr['class'] = klass;
+		if (name)
+			attr['data-name'] = name;
+		
+		return renderer.paper.lineToBack(attr);
+	}
+
 	var pathString = sprintf("M %f %f L %f %f L %f %f L %f %f z", x1, y1, x2, y1,
 		x2, y2, x1, y2);
 	var options = { path: pathString, stroke: "none", fill: fill };

package/src/write/draw/print-stem.js

@@ -12,6 +12,24 @@ function printStem(renderer, x, dx, y1, y2, klass, name) {
 	}
 	x = roundNumber(x);
 	var x2 = roundNumber(x + dx);
+	// TODO-PER: This fixes a firefox bug where it isn't displayed
+	if (renderer.firefox112) {
+		x += dx / 2; // Because the x coordinate is the edge of where the line goes but the width widens from the middle.
+		var attr = {
+			x1: x,
+			x2: x,
+			y1: y1,
+			y2: y2,
+			stroke: renderer.foregroundColor,
+			'stroke-width': Math.abs(dx)
+		}
+		if (klass)
+			attr['class'] = klass;
+		if (name)
+			attr['data-name'] = name;
+		
+		return renderer.paper.lineToBack(attr);
+	}
 	var pathArray = [["M", x, y1], ["L", x, y2], ["L", x2, y2], ["L", x2, y1], ["z"]];
 	var attr = { path: "" };
 	for (var i = 0; i < pathArray.length; i++)

package/src/write/engraver-controller.js

@@ -256,14 +256,14 @@ EngraverController.prototype.engraveTune = function (abcTune, tuneNumber, lineOf
 
 	if (this.oneSvgPerLine) {
 		var div = this.renderer.paper.svg.parentNode
-		this.svgs = splitSvgIntoLines(div, abcTune.metaText.title, this.responsive)
+		this.svgs = splitSvgIntoLines(this.renderer, div, abcTune.metaText.title, this.responsive)
 	} else {
 		this.svgs = [this.renderer.paper.svg];
 	}
 	setupSelection(this, this.svgs);
 };
 
-function splitSvgIntoLines(output, title, responsive) {
+function splitSvgIntoLines(renderer, output, title, responsive) {
 	// Each line is a top level <g> in the svg. To split it into separate
 	// svgs iterate through each of those and put them in a new svg. Since
 	// they are placed absolutely, the viewBox needs to be manipulated to
@@ -297,7 +297,9 @@ function splitSvgIntoLines(output, title, responsive) {
 			svg.setAttribute("height", height)
 		if (responsive === 'resize')
 			svg.style.position = ''
-		svg.setAttribute("viewBox", "0 " + nextTop + " " + width + " " + height)
+		// TODO-PER: Hack! Not sure why this is needed.
+		var viewBoxHeight = renderer.firefox112 ? height+1 : height
+		svg.setAttribute("viewBox", "0 " + nextTop + " " + width + " " + viewBoxHeight)
 		svg.appendChild(style.cloneNode(true))
 		var titleEl = document.createElement("title")
 		titleEl.innerText = fullTitle

package/src/write/interactive/selection.js

@@ -362,10 +362,13 @@ function notifySelect(target, dragStep, dragMax, dragIndex, ev) {
 	var parent = ev.target;
 	while (parent && parent.dataset && !parent.dataset.index && parent.tagName.toLowerCase() !== 'svg')
 		parent = parent.parentNode;
-	analysis.name = parent.dataset.name;
-	analysis.clickedName = closest.dataset.name;
-	analysis.parentClasses = parent.classList;
-	analysis.clickedClasses = closest.classList;
+	if (parent && parent.dataset) {
+		analysis.name = parent.dataset.name;
+		analysis.clickedName = closest.dataset.name;
+		analysis.parentClasses = parent.classList;
+	}
+	if (closest && closest.classList)
+		analysis.clickedClasses = closest.classList;
 	analysis.selectableElement = target.svgEl;
 
 	for (var i = 0; i < this.listeners.length; i++) {

package/src/write/renderer.js

@@ -16,6 +16,7 @@ var Renderer = function (paper) {
 	this.space = 3 * spacing.SPACE;
 	this.padding = {}; // renderer's padding is managed by the controller
 	this.reset();
+	this.firefox112 = navigator.userAgent.indexOf('Firefox/112.0') >= 0
 };
 
 Renderer.prototype.reset = function () {

package/src/write/svg.js

@@ -345,6 +345,16 @@ Svg.prototype.pathToBack = function (attr) {
 	return el;
 };
 
+Svg.prototype.lineToBack = function (attr) {
+	var el = document.createElementNS(svgNS, 'line');
+	var keys = Object.keys(attr)
+	for (var i = 0; i < keys.length; i++)
+		el.setAttribute(keys[i], attr[keys[i]]);
+	this.prepend(el);
+	return el;
+};
+
+
 Svg.prototype.append = function (el) {
 	if (this.currentGroup.length > 0)
 		this.currentGroup[0].appendChild(el);

package/test.js

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2022 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/types/index.d.ts

@@ -259,7 +259,7 @@ declare module 'abcjs' {
 		dragColor?: string;
 		dragging?: boolean;
 		foregroundColor?: string;
-		format?: { [attr in FormatAttributes]: any };
+		format?: { [attr in FormatAttributes]?: any };
 		header_only?: boolean;
 		initialClef?: boolean;
 		jazzchords?: boolean;
@@ -1142,7 +1142,7 @@ declare module 'abcjs' {
 
 	export interface MidiBuffer {
 		init(params?: MidiBufferOptions): Promise<MidiBufferPromise>
-		prime(): Promise<void>
+		prime(): Promise<{ status: string, duration: number}>
 		start(): void
 		pause(): number
 		resume(): void

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.2.0';
+var version = '6.2.2';
 
 module.exports = version;