abcjs 6.2.3 → 6.4.0

package/src/synth/create-synth.js

@@ -26,13 +26,15 @@ 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 = undefined
+	self.pickupLength = 0
 
 	// Load and cache all needed sounds
 	self.init = function(options) {
 		if (!options)
 			options = {};
-//		self.options = options
+		if (options.options)
+			self.options = options.options
 		registerAudioContext(options.audioContext); // This works no matter what - if there is already an ac it is a nop; if the context is not passed in, then it creates one.
 		var startTime = activeAudioContext().currentTime;
 		self.debugCallback = options.debugCallback;
@@ -115,6 +117,7 @@ function CreateSynth() {
 			var meter = options.visualObj.getMeterFraction();
 			if (meter.den)
 				self.meterSize = options.visualObj.getMeterFraction().num / options.visualObj.getMeterFraction().den;
+			self.pickupLength = options.visualObj.getPickupLength()
 		} else if (options.sequence)
 			self.flattened = options.sequence;
 		else
@@ -124,6 +127,7 @@ function CreateSynth() {
 		self.sequenceCallback = params.sequenceCallback;
 		self.callbackContext = params.callbackContext;
 		self.onEnded = params.onEnded;
+		self.meterFraction = options.visualObj.getMeterFraction();
 
 		var allNotes = {};
 		var cached = [];
@@ -136,18 +140,19 @@ function CreateSynth() {
 				if (event.pitch !== undefined) {
 					var pitchNumber = event.pitch;
 					var noteName = pitchToNoteName[pitchNumber];
+					var inst = event.instrument !== undefined ? instrumentIndexToName[event.instrument] : currentInstrument
 					if (noteName) {
-						if (!allNotes[currentInstrument])
-							allNotes[currentInstrument] = {};
-						if (!soundsCache[currentInstrument] || !soundsCache[currentInstrument][noteName])
-							allNotes[currentInstrument][noteName] = true;
+						if (!allNotes[inst])
+							allNotes[inst] = {};
+						if (!soundsCache[inst] || !soundsCache[inst][noteName])
+							allNotes[inst][noteName] = true;
 						else {
-							var label2 = currentInstrument+":"+noteName
+							var label2 = inst+":"+noteName
 							if (cached.indexOf(label2) < 0)
 								cached.push(label2);
 						}
 					} else {
-						var label = currentInstrument+":"+noteName
+						var label = inst+":"+noteName
 						console.log("Can't find note: ", pitchNumber, label);
 						if (errorNotes.indexOf(label) < 0)
 							errorNotes.push(label)
@@ -309,8 +314,10 @@ function CreateSynth() {
 			self.stop();
 
 			var noteMapTracks = createNoteMap(self.flattened);
-			// if (self.options.swing)
-			// 	addSwing(noteMapTracks, self.options.swing, self.beatsPerMeasure)
+
+			if (self.options.swing)
+				addSwing(noteMapTracks, self.options.swing, self.meterFraction, self.pickupLength)
+
 			if (self.sequenceCallback)
 				self.sequenceCallback(noteMapTracks, self.callbackContext);
 
@@ -545,38 +552,80 @@ function CreateSynth() {
 		}
 	};
 
-	// // this is a first attempt at adding a little bit of swing to the output, but the algorithm isn't correct.
-	// function addSwing(noteMapTracks, swing, beatsPerMeasure) {
-	// 	console.log("addSwing", noteMapTracks, swing, beatsPerMeasure)
-	// 	// Swing should be between -0.9 and 0.9. Make sure the input is between them.
-	// 	// Then that is the percentage to add to the first beat, so a negative number moves the second beat earlier.
-	// 	// A value of zero is the same as no swing at all.
-	// 	// This only works when there are an even number of beats in a measure.
-	// 	if (beatsPerMeasure % 2 !== 0)
-	// 		return;
-	// 	swing = parseFloat(swing)
-	// 	if (isNaN(swing))
-	// 		return
-	// 	if (swing < -0.9)
-	// 		swing = -0.9
-	// 	if (swing > 0.9)
-	// 		swing = 0.9
-	// 	var beatLength = (1 / beatsPerMeasure)*2
-	// 	swing = beatLength * swing
-	// 	for (var t = 0; t < noteMapTracks.length; t++) {
-	// 		var track = noteMapTracks[t];
-	// 		for (var i = 0; i < track.length; i++) {
-	// 			var event = track[i];
-	// 			if (event.start % beatLength) {
-	// 				// This is the off beat
-	// 				event.start += swing;
-	// 			} else {
-	// 				// This is the beat
-	// 				event.end += swing;
-	// 			}
-	// 		}
-	// 	}
-	// }
+	function addSwing(noteMapTracks, swing, meterFraction, pickupLength) {
+
+		// we can only swing in X/4 and X/8 meters.
+		if (meterFraction.den != 4 && meterFraction.den != 8)
+			return;
+
+		swing = parseFloat(swing);
+
+		// 50 (or less) is no swing, 
+		if (isNaN(swing) || swing <= 50)
+			return;
+
+		// 66 is triplet swing 2:1, and 
+		// 60 is swing with a ratio of 3:2. 
+		// 75 is the maximum swing where the first eight is played as a dotted eight and the second as a sixteenth. 
+		if (swing > 75)
+			swing = 75;
+
+		// convert the swing percentage to a percentage of increase for the first half of the beat
+		swing = swing/50 - 1;
+
+		// The volume of the swung notes is increased by this factor
+		// could be also in the settings. Try out values such 0.1, 0.2
+		var volumeIncrease = 0.0;
+
+		// the beatLength in X/8 meters
+		var beatLength = 0.25; 
+
+		// in X/8 meters the 16s swing so the beatLength is halved
+		if (meterFraction.den === 8) 
+			beatLength = beatLength/2; 
+
+		// duration of a half beat
+		var halfbeatLength = beatLength/2;
+
+		// the extra duration of the first swung notes and the delay of the second notes
+		var swingDuration = halfbeatLength * swing;
+
+		for (var t = 0; t < noteMapTracks.length; t++) {
+			var track = noteMapTracks[t];
+			for (var i = 0; i < track.length; i++) {
+				var event = track[i];
+				if (
+					// is halfbeat
+					(event.start-pickupLength) % halfbeatLength == 0 && (event.start-pickupLength) % beatLength != 0 
+					&& (
+						// the previous note is on the beat or before OR there is no previous note 
+						i == 0 
+						|| track[i-1].start <= track[i].start - halfbeatLength
+					)
+					&& (
+						// the next note is on the beat or after OR there is no next note
+						i == track.length - 1 
+						|| track[i+1].start >= track[i].start + halfbeatLength
+					)
+				) {
+					var oldEventStart = event.start;
+
+					event.start += swingDuration;
+
+					// Increase volume of swung notes
+					event.volume *= 1 + volumeIncrease;
+
+					// if there is a previous note ending at the start of this note, extend its end
+					// and decrease its volume
+					if (i > 0 && track[i-1].end == oldEventStart) {
+						track[i-1].end = event.start;
+						track[i-1].volume *= 1 - volumeIncrease;
+					}
+				}
+			}
+		}
+	}
+	
 }
 
 module.exports = CreateSynth;

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/{violin/violin-patterns.js → tab-string-patterns.js}

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

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,8 +242,10 @@ 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);
@@ -242,5 +256,4 @@ TabRenderer.prototype.doLayout = function () {
   linkStaffAndTabs(staffGroup.staffs); // crossreference tabs and staff
 };
 
-
 module.exports = TabRenderer;

package/src/test/abc_parser_lint.js

@@ -51,18 +51,18 @@
 var parseCommon = require('../parse/abc_common');
 var JSONSchema = require('./jsonschema-b4');
 
-var { legalAccents } = require('../parse/abc_parse_settings');
-
-var ParserLint = function () {
-  'use strict';
-  var decorationList = {
-    type: 'array',
-    optional: true,
-    items: {
-      type: 'string',
-      Enum: legalAccents
-    }
-  };
+var ParserLint = function() {
+	"use strict";
+	var decorationList = { type: 'array', optional: true, items: { type: 'string', Enum: [
+		"trill", "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)",
+		"p", "pp", "f", "ff", "mf", "mp", "ppp", "pppp",  "fff", "ffff", "sfz", "repeatbar", "repeatbar2", "slide",
+		"upbow", "downbow", "staccato", "trem1", "trem2", "trem3", "trem4",
+		"/", "//", "///", "////", "turnx", "invertedturn", "invertedturnx", "arpeggio", "trill(", "trill)", "xstem",
+		"mark", "marcato", "umarcato", "D.C.alcoda", "D.C.alfine", "D.S.alcoda", "D.S.alfine", "editorial", "courtesy"
+	] } };
 
 	var tempoProperties =  {
 		duration: { type: "array", optional: true, output: "join", requires: [ 'bpm'], items: { type: "number"} },
@@ -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,
@@ -555,6 +556,7 @@ var ParserLint = function () {
 			subtitlespace: { type: "number", optional: true },
 			sysstaffsep: { type: "number", optional: true },
 			systemsep: { type: "number", optional: true },
+			stafftopmargin: { type: "number", optional: true },
 			tabgracefont: fontType,
 			tablabelfont: fontType,
 			tabnumberfont: 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();
 };
@@ -830,7 +831,10 @@ 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);
+		// TODO-PER: nostem is true if this is beamed. In that case we don't know where to place the decoration yet so just make a guess. This should be refactored to not place decorations until after the beams are determined.
+		// This should probably be combined with moveDecorations()
+		var bottom = nostem ? Math.min(-3, abselem.bottom - 6) : abselem.bottom
+		this.decoration.createDecoration(voice, elem.decoration, abselem.top, (notehead) ? notehead.w : 0, abselem, roomtaken, dir, bottom, elem.positioning, this.hasVocals, this.accentAbove);
 	}
 
 	if (elem.barNumber) {
@@ -989,7 +993,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) {