abcjs 6.2.2 → 6.3.0

package/src/parse/abc_tokenizer.js

@@ -639,13 +639,78 @@ var Tokenizer = function(lines, multilineVars) {
 		return {value: num/den, index: index};
 	};
 
-	this.theReverser = function(str) {
-		if (parseCommon.endsWith(str, ", The"))
-			return "The " + str.substring(0, str.length-5);
-		if (parseCommon.endsWith(str, ", A"))
-			return "A " + str.substring(0, str.length-3);
-		return str;
-	};
+//
+// MAE 10 Jan 2023 - For better handling of tunes that have tune numbers in front of them.
+//
+// Previous version would take:
+// 21. Woman of the House, The
+// and return:
+// The 21. Woman of the House
+// 
+// This fix results in:
+// 21. The Woman of the House
+//
+// Also added additional checks and handlers for lower case ", the" and ", a" since I found several tune collections with those tune name constructs
+//
+// Find an optional title number at the start of a tune title
+function getTitleNumber(str){
+
+  const regex = /^(\d+)\./;
+
+  // Use the exec method to search for the pattern in the string
+  const match = regex.exec(str);
+
+  // Check if a match is found
+  if (match) {
+
+	// The matched number is captured in the first group (index 1)
+	const foundNumber = match[1];
+	return foundNumber;
+
+  } else {
+
+	// Return null if no match is found
+	return null;
+	
+  }
+
+}
+
+var thePatterns = [
+	{ match: /,\s*[Tt]he$/, replace: "The " },
+	{ match: /,\s*[Aa]$/, replace: "A " },
+	{ match: /,\s*[Aa]n$/, replace: "An " },
+]
+
+this.theReverser = function (str) {
+
+    for (var i = 0; i < thePatterns.length; i++) {
+		var thisPattern = thePatterns[i]
+		var match = str.match(thisPattern.match)
+		if (match) {
+			var theTitleNumber = getTitleNumber(str);
+			if (theTitleNumber){
+		
+			  //console.log("theReverser The titlenumber:"+theTitleNumber); 
+		
+			  str = str.replace(theTitleNumber+".","");
+			  str = str.trim();
+			}
+			var len = match[0].length
+			var result = thisPattern.replace + str.substring(0, str.length - len);
+		
+			if (theTitleNumber){
+			  result = theTitleNumber+". "+result;
+			}
+			
+			return result;
+
+		}
+	}
+
+    return str;
+
+  };
 
 	this.stripComment = function(str) {
 		var i = str.indexOf('%');

package/src/parse/tune-builder.js

@@ -1,5 +1,6 @@
 var parseKeyVoice = require('../parse/abc_parse_key_voice');
 var parseCommon = require('../parse/abc_common');
+var parseDirective = require('./abc_parse_directive');
 
 var TuneBuilder = function(tune) {
 	var self = this;
@@ -147,6 +148,9 @@ var TuneBuilder = function(tune) {
 		this.closeLine();	// Close the last line.
 		delete tune.runningFonts;
 
+		simplifyMetaText(tune)
+		//addRichTextToAnnotationsAndLyrics(tune)
+
 		// If the tempo was created with a string like "Allegro", then the duration of a beat needs to be set at the last moment, when it is most likely known.
 		if (tune.metaText.tempo && tune.metaText.tempo.bpm && !tune.metaText.tempo.duration)
 			tune.metaText.tempo.duration = [ tune.getBeatLength() ];
@@ -878,7 +882,15 @@ var TuneBuilder = function(tune) {
 			tune.metaText[key] = value;
 			tune.metaTextInfo[key] = info;
 		} else {
-			tune.metaText[key] += "\n" + value;
+			if (typeof tune.metaText[key] === 'string' && typeof value === 'string')
+				tune.metaText[key] += "\n" + value;
+			else {
+				if (tune.metaText[key] === 'string')
+					tune.metaText[key] = [{text: tune.metaText[key]}]
+				if (typeof value === 'string')
+					value = [{text: value}]
+				tune.metaText[key] =tune.metaText[key].concat(value)
+			}
 			tune.metaTextInfo[key].endChar = info.endChar;
 		}
 	};
@@ -898,4 +910,51 @@ var TuneBuilder = function(tune) {
 	};
 };
 
+function isArrayOfStrings(arr) {
+	if (!arr) return false
+	if (typeof arr === "string") return false
+	var str = ''
+	for (var i = 0; i < arr.length; i++) {
+		if (typeof arr[i] !== 'string')
+			return false
+	}
+	return true
+}
+
+function simplifyMetaText(tune) {
+	if (isArrayOfStrings(tune.metaText.notes))
+		tune.metaText.notes = tune.metaText.notes.join("\n")
+	if (isArrayOfStrings(tune.metaText.history))
+		tune.metaText.history = tune.metaText.history.join("\n")
+}
+
+function addRichTextToAnnotationsAndLyrics(tune) {
+	var lines = tune.lines
+	for (var i = 0; i < lines.length; i++) {
+		if (lines[i].staff !== undefined) {
+			for (var s = 0; s < lines[i].staff.length; s++) {
+				for (var v = 0; v < lines[i].staff[s].voices.length; v++) {
+					var voice = lines[i].staff[s].voices[v];
+					for (var n = 0; n < voice.length; n++) {
+						var element = voice[n]
+						if (element.chord) {
+							for (var c = 0; c < element.chord.length; c++) {
+								element.chord[c].name = parseDirective.parseFontChangeLine(element.chord[c].name)
+								console.log(element.chord[c].name)
+							}
+						}
+						if (element.lyric) {
+							for (var l = 0; l < element.lyric.length; l++) {
+								element.lyric[l].syllable = parseDirective.parseFontChangeLine(element.lyric[l].syllable)
+								console.log(element.lyric[l].syllable)
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+
+}
+
 module.exports = TuneBuilder;

package/src/synth/create-synth.js

@@ -511,6 +511,10 @@ function CreateSynth() {
 		return self.audioBuffers[0];
 	};
 
+	self.getIsRunning = function() {
+		return self.isRunning;
+	}
+
 	/////////////// Private functions //////////////
 
 	self._deviceCapable = function() {

package/src/synth/place-note.js

@@ -17,6 +17,12 @@ function placeNote(outputAudioBuffer, sampleRate, sound, startArray, volumeMulti
 		len = 0.005; // Have some small audible length no matter how short the note is.
 	var offlineCtx = new OfflineAC(2,Math.floor((len+fadeTimeSec)*sampleRate),sampleRate);
 	var noteName = pitchToNoteName[sound.pitch];
+	if (!soundsCache[sound.instrument]) {
+		// It shouldn't happen that the entire instrument cache wasn't created, but this has been seen in practice, so guard against it.
+		if (debugCallback)
+			debugCallback('placeNote skipped (instrument empty): '+sound.instrument+':'+noteName)
+		return Promise.resolve();
+	}
 	var noteBufferPromise = soundsCache[sound.instrument][noteName];
 
 	if (!noteBufferPromise) {

package/src/synth/play-event.js

@@ -2,7 +2,7 @@ var SynthSequence = require('./synth-sequence');
 var CreateSynth = require('./create-synth');
 var activeAudioContext = require("./active-audio-context");
 
-function playEvent(midiPitches, midiGracePitches, millisecondsPerMeasure) {
+function playEvent(midiPitches, midiGracePitches, millisecondsPerMeasure, soundFontUrl, debugCallback) {
 	var sequence = new SynthSequence();
 
 	for (var i = 0; i < midiPitches.length; i++) {
@@ -21,18 +21,20 @@ function playEvent(midiPitches, midiGracePitches, millisecondsPerMeasure) {
 	var ac = activeAudioContext();
 	if (ac.state === "suspended") {
 		return ac.resume().then(function () {
-			return doPlay(sequence, millisecondsPerMeasure);
+			return doPlay(sequence, millisecondsPerMeasure, soundFontUrl, debugCallback);
 		});
 	} else {
-		return doPlay(sequence, millisecondsPerMeasure);
+		return doPlay(sequence, millisecondsPerMeasure, soundFontUrl, debugCallback);
 	}
 }
 
-function doPlay(sequence, millisecondsPerMeasure) {
+function doPlay(sequence, millisecondsPerMeasure, soundFontUrl, debugCallback) {
 	var buffer = new CreateSynth();
 	return buffer.init({
 		sequence: sequence,
-		millisecondsPerMeasure: millisecondsPerMeasure
+		millisecondsPerMeasure: millisecondsPerMeasure,
+		options: { soundFontUrl: soundFontUrl },
+		debugCallback: debugCallback,
 	}).then(function () {
 		return buffer.prime();
 	}).then(function () {

package/src/synth/synth-controller.js

@@ -21,6 +21,10 @@ function SynthController() {
 	self.load = function (selector, cursorControl, visualOptions) {
 		if (!visualOptions)
 			visualOptions = {};
+		if (visualOptions.displayPlay === undefined)
+			visualOptions.displayPlay = true
+		if (visualOptions.displayProgress === undefined)
+			visualOptions.displayProgress = true
 		self.control = new CreateSynthControl(selector, {
 			loopHandler: visualOptions.displayLoop ? self.toggleLoop : undefined,
 			restartHandler: visualOptions.displayRestart ? self.restart : undefined,
@@ -41,7 +45,7 @@ function SynthController() {
 	self.setTune = function(visualObj, userAction, audioParams) {
 		self.visualObj = visualObj;
 		self.disable(false);
-		self.options = audioParams;
+		self.options = audioParams ? audioParams : {};
 
 		if (self.control) {
 			self.pause();
@@ -195,7 +199,7 @@ function SynthController() {
 
 	self._randomAccess = function (ev) {
 		var background = (ev.target.classList.contains('abcjs-midi-progress-indicator')) ? ev.target.parentNode : ev.target;
-		var percent = (ev.x - background.offsetLeft) / background.offsetWidth;
+		var percent = (ev.x - background.getBoundingClientRect().left) / background.offsetWidth;
 		if (percent < 0)
 			percent = 0;
 		if (percent > 1)

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

@@ -265,6 +265,17 @@ StringPatterns.prototype.tabInfos = function (plugin) {
   return '';
 };
 
+// MAE 27 Nov 2023
+StringPatterns.prototype.suppress = function (plugin) {
+  var _super = plugin._super;
+  var suppress = _super.params.suppress;
+  if (suppress){
+    return true;
+  }
+  return false;
+};
+// MAE 27 Nov 2023 End
+
 /**
  * Common patterns for all string instruments
  * @param {} plugin

package/src/tablatures/instruments/{guitar/guitar-patterns.js → tab-string-patterns.js}

@@ -1,23 +1,23 @@
-var StringPatterns = require('../string-patterns');
+var StringPatterns = require('./string-patterns');
 
-function GuitarPatterns(plugin) {
+function TabStringPatterns(plugin, defaultTuning) {
   this.tuning = plugin._super.params.tuning;
   if (!this.tuning) {
-    this.tuning = ['E,', 'A,', 'D', 'G' , 'B' , 'e'];
+    this.tuning = defaultTuning;
   }
   plugin.tuning = this.tuning;
   this.strings = new StringPatterns(plugin);
 }
 
-GuitarPatterns.prototype.notesToNumber = function (notes, graces) {
+TabStringPatterns.prototype.notesToNumber = function (notes, graces) {
   var converter = this.strings;
   return converter.notesToNumber(notes, graces);
 };
 
-GuitarPatterns.prototype.stringToPitch = function (stringNumber) {
+TabStringPatterns.prototype.stringToPitch = function (stringNumber) {
   var converter = this.strings;
   return converter.stringToPitch(stringNumber);
 };
 
 
-module.exports = GuitarPatterns;
+module.exports = TabStringPatterns;

package/src/tablatures/instruments/{violin/tab-violin.js → tab-string.js}

@@ -1,8 +1,8 @@
 
-var StringTablature = require('../string-tablature');
-var TabCommon = require('../../tab-common');
-var TabRenderer = require('../../tab-renderer');
-var ViolinPatterns = require('./violin-patterns');
+var StringTablature = require('./string-tablature');
+var TabCommon = require('../tab-common');
+var TabRenderer = require('../tab-renderer');
+var TabStringPatterns = require('./tab-string-patterns');
 
 
 /**
@@ -11,18 +11,20 @@ var ViolinPatterns = require('./violin-patterns');
 *  @param {*} tuneNumber  the parsed tune AST tree
  * @param {*} params  complementary args provided to Tablature Plugin
  */
-Plugin.prototype.init = function (abcTune, tuneNumber, params) {
+Plugin.prototype.init = function (abcTune, tuneNumber, params, staffNumber, tabSettings) {
   var _super = new TabCommon(abcTune, tuneNumber, params);
   this.abcTune = abcTune;
   this._super = _super;
   this.linePitch = 3;
-  this.nbLines = 4;
-  this.isTabBig = false;
+  this.nbLines = tabSettings.defaultTuning.length;
+  this.isTabBig = tabSettings.isTabBig;
+  this.tabSymbolOffset = tabSettings.tabSymbolOffset;
   this.capo = params.capo;
   this.transpose = params.visualTranspose;
+  this.hideTabSymbol = params.hideTabSymbol;
   this.tablature = new StringTablature(this.nbLines,
     this.linePitch);
-  var semantics = new ViolinPatterns(this);
+  var semantics = new TabStringPatterns(this, tabSettings.defaultTuning);
   this.semantics = semantics;
 };
 
@@ -38,8 +40,8 @@ function Plugin() {}
 //
 // Tablature plugin definition
 //
-var AbcViolinTab = function () {
-  return { name: 'ViolinTab', tablature: Plugin };
+var AbcStringTab = function () {
+  return { name: 'StringTab', tablature: Plugin };
 };
 
-module.exports = AbcViolinTab;
+module.exports = AbcStringTab;

package/src/tablatures/tab-absolute-elements.js

@@ -60,13 +60,22 @@ function buildTabAbsolute(plugin, absX, relX) {
     icon: tabIcon,
     Ypos: tabYPos
   };
-  var tabAbsolute = new AbsoluteElement(element, 0, 0, "symbol", 0);
-  tabAbsolute.x = absX;
-  var tabRelative = new RelativeElement(tabIcon, 0, 0, 7.5, "tab");
-  tabRelative.x = relX;
-  tabAbsolute.children.push(tabRelative);
-  if (tabAbsolute.abcelem.el_type == 'tab') {
-    tabRelative.pitch = tabYPos;
+
+  // Offset the TAB symbol position if specified in the tab description
+  tabYPos += plugin.tabSymbolOffset;
+
+  // For tablature like whistle tab where you want the TAB symbol hidden
+  if (!plugin.hideTabSymbol){
+
+    var tabAbsolute = new AbsoluteElement(element, 0, 0, "symbol", 0);
+    tabAbsolute.x = absX;
+    var tabRelative = new RelativeElement(tabIcon, 0, 0, 7.5, "tab");
+    tabRelative.x = relX;
+    tabAbsolute.children.push(tabRelative);
+    if (tabAbsolute.abcelem.el_type == 'tab') {
+      tabRelative.pitch = tabYPos;
+    }
+    
   }
   return tabAbsolute;
 }
@@ -177,10 +186,11 @@ TabAbsoluteElements.prototype.build = function (plugin,
   tabVoice,
   voiceIndex,
   staffIndex,
-  keySig ) {
+  keySig,
+  tabVoiceIndex ) {
   var staffSize = getInitialStaffSize(staffAbsolute);
   var source = staffAbsolute[staffIndex+voiceIndex];
-  var dest = staffAbsolute[staffSize+staffIndex+voiceIndex];
+  var dest = staffAbsolute[tabVoiceIndex];
   var tabPos = null;
   var defNote = null;
   if (source.children[0].abcelem.el_type != 'clef') {

package/src/tablatures/tab-renderer.js

@@ -37,12 +37,24 @@ function buildTabName(self, dest) {
   var controller = self.renderer.controller;
   var textSize = controller.getTextSize;
   var tabName = stringSemantics.tabInfos(self.plugin);
-  var size = textSize.calc(tabName, 'tablabelfont', 'text instrumentname');
-  dest.tabNameInfos = {
-    textSize: size,
-    name: tabName
-  };
-  return size.height;
+  var suppress = stringSemantics.suppress(self.plugin);
+  var doDraw = true;
+
+  if (suppress){
+    doDraw = false
+  }
+
+  
+  if (doDraw){
+    var size = textSize.calc(tabName, 'tablabelfont', 'text instrumentname'); 
+    dest.tabNameInfos = {
+      textSize: {height:size.height,width:size.width},
+      name: tabName
+    };
+    return size.height;
+  }
+  return 0
+
 }
 
 /**
@@ -230,16 +242,18 @@ TabRenderer.prototype.doLayout = function () {
     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;
-    staffGroup.height += nameHeight * spacing.STEP;
+    // This was pushing down the top staff by the tab label height
+    //staffGroup.staffs[this.staffIndex].top += nameHeight;
+    staffGroup.staffs[this.staffIndex].top += 1;
+    staffGroup.height += nameHeight;
     tabVoice.staff = staffGroupInfos;
+    var tabVoiceIndex = voices.length
     voices.splice(voices.length, 0, tabVoice);
     var keySig = checkVoiceKeySig(voices, ii + this.staffIndex);
     this.tabStaff.voices[ii] = [];
-    this.absolutes.build(this.plugin, voices, this.tabStaff.voices[ii], ii , this.staffIndex ,keySig);
+    this.absolutes.build(this.plugin, voices, this.tabStaff.voices[ii], ii , this.staffIndex ,keySig, tabVoiceIndex);
   }
   linkStaffAndTabs(staffGroup.staffs); // crossreference tabs and staff
 };
 
-
 module.exports = TabRenderer;

package/src/test/abc_parser_lint.js

@@ -427,6 +427,7 @@ var ParserLint = function() {
 	var formattingProperties = {
 		type:"object",
 		properties: {
+			accentAbove: { type: "boolean", optional: true },
 			alignbars: { type: "number", optional: true },
 			aligncomposer: { type: "string", Enum: [ 'left', 'center','right' ], optional: true },
 			annotationfont: fontType,

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

@@ -53,6 +53,7 @@ var AbstractEngraver = function (getTextSize, tuneNumber, options) {
 	this.percmap = options.percmap;
 	this.initialClef = options.initialClef
 	this.jazzchords = !!options.jazzchords
+	this.accentAbove = !!options.accentAbove
 	this.germanAlphabet = !!options.germanAlphabet
 	this.reset();
 };
@@ -747,6 +748,12 @@ AbstractEngraver.prototype.addNoteToAbcElement = function (abselem, elem, dot, s
 			else
 				p1 += 1;
 		}
+		if (noteHead && noteHead.c === 'noteheads.triangle.quarter') {
+			if (dir === 'down')
+				p2 -= 0.7;
+			else
+				p1 -= 1.2;
+		}
 		abselem.addRight(new RelativeElement(null, dx, 0, p1, { "type": "stem", "pitch2": p2, linewidth: width, bottom: p1 - 1 }));
 		//var RelativeElement = function RelativeElement(c, dx, w, pitch, opt) {
 		min = Math.min(p1, p2);
@@ -824,7 +831,7 @@ AbstractEngraver.prototype.createNote = function (elem, nostem, isSingleLineStaf
 	}
 
 	if (elem.decoration) {
-		this.decoration.createDecoration(voice, elem.decoration, abselem.top, (notehead) ? notehead.w : 0, abselem, roomtaken, dir, abselem.bottom, elem.positioning, this.hasVocals);
+		this.decoration.createDecoration(voice, elem.decoration, abselem.top, (notehead) ? notehead.w : 0, abselem, roomtaken, dir, abselem.bottom, elem.positioning, this.hasVocals, this.accentAbove);
 	}
 
 	if (elem.barNumber) {
@@ -983,7 +990,7 @@ AbstractEngraver.prototype.createBarLine = function (voice, elem, isFirstStaff)
 	}
 
 	if (elem.decoration) {
-		this.decoration.createDecoration(voice, elem.decoration, 12, (thick) ? 3 : 1, abselem, 0, "down", 2, elem.positioning, this.hasVocals);
+		this.decoration.createDecoration(voice, elem.decoration, 12, (thick) ? 3 : 1, abselem, 0, "down", 2, elem.positioning, this.hasVocals, this.accentAbove);
 	}
 
 	if (thick) {