abcjs 6.4.1 → 6.4.3

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

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2024 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-2023 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2024 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-2023 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2024 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.4.1",
+  "version": "6.4.3",
   "description": "Renderer for abc music notation",
   "main": "index.js",
   "types": "types/index.d.ts",

package/plugin.js

@@ -1,5 +1,5 @@
 /**!
-Copyright (c) 2009-2023 Paul Rosen and Gregory Dyke
+Copyright (c) 2009-2024 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_tunebook.js

@@ -2,7 +2,7 @@
 
 var Parse = require('../parse/abc_parse');
 var bookParser = require('../parse/abc_parse_book');
-var tablatures = require('./abc_tablatures');
+var tablatures = require('../tablatures/abc_tablatures');
 
 
 var tunebook = {};
@@ -87,7 +87,6 @@ var tunebook = {};
 					// Init tablatures plugins
 					//
 					if (params.tablature) {
-						tablatures.init();
 						tune.tablatures = tablatures.preparePlugins(tune, currentTune, params);
 					}
 					var warnings = abcParser.getWarnings();

package/src/api/abc_tunebook_svg.js

@@ -4,7 +4,6 @@ var Tune = require('../data/abc_tune');
 var EngraverController = require('../write/engraver-controller');
 var Parse = require('../parse/abc_parse');
 var wrap = require('../parse/wrap_lines');
-// var tablatures = require('./abc_tablatures');
 
 
 var resizeDivs = {};

package/src/data/abc_tune.js

@@ -551,6 +551,8 @@ var Tune = function() {
 
 	this.getBpm = function(tempo) {
 		var bpm;
+		if (!tempo)
+			tempo = this.metaText ? this.metaText.tempo : null;
 		if (tempo) {
 			bpm = tempo.bpm;
 			var beatLength = this.getBeatLength();

package/src/midi/abc_midi_create.js

@@ -9,20 +9,35 @@ var create;
 
 	var baseDuration = 480*4; // nice and divisible, equals 1 whole note
 
-	create = function(abcTune, options) {
+	create = function create(abcTune, options) {
 		if (options === undefined) options = {};
 		var commands = abcTune.setUpAudio(options);
 		var midi = rendererFactory();
-
 		var title = abcTune.metaText ? abcTune.metaText.title : undefined;
-		if (title && title.length > 128)
-			title = title.substring(0,124) + '...';
+		if (title && title.length > 128) title = title.substring(0, 124) + '...';
 		var key = abcTune.getKeySignature();
 		var time = abcTune.getMeterFraction();
-		var beatsPerSecond = commands.tempo / 60;
-		//var beatLength = abcTune.getBeatLength();
-		midi.setGlobalInfo(commands.tempo, title, key, time);
 
+		// MAE 7 July 2024 - Fix for */8 meter tempos
+		var tempo = commands.tempo;
+
+		var beatsPerSecond = tempo / 60;
+
+		// Fix tempo for */8 meters
+		if (time.den == 8){
+
+			// Compute the tempo based on the actual milliseconds per measure, scaled by the number of eight notes and halved to get tempo in bpm.
+			var msPerMeasure = abcTune.millisecondsPerMeasure();
+			
+			tempo = (60000 / (msPerMeasure/time.num)) / 2;
+			
+			beatsPerSecond = tempo/60;
+
+		}
+
+		//var beatLength = abcTune.getBeatLength();
+		midi.setGlobalInfo(tempo, title, key, time);
+		
 		for (var i = 0; i < commands.tracks.length; i++) {
 			midi.startTrack();
 			var notePlacement = {};

package/src/parse/abc_common.js

@@ -1,19 +1,11 @@
-//    abc_parse.js: parses a string representing ABC Music Notation into a usable internal structure.
+//    abc_common.js: Some common utility functions.
 
 var parseCommon = {};
 
-parseCommon.clone = function(source) {
-	var destination = {};
-	for (var property in source)
-		if (source.hasOwnProperty(property))
-			destination[property] = source[property];
-	return destination;
-};
-
 parseCommon.cloneArray = function(source) {
 	var destination = [];
 	for (var i = 0; i < source.length; i++) {
-		destination.push(parseCommon.clone(source[i]));
+		destination.push(Object.assign({},source[i]));
 	}
 	return destination;
 };
@@ -22,7 +14,7 @@ parseCommon.cloneHashOfHash = function(source) {
 	var destination = {};
 	for (var property in source)
 		if (source.hasOwnProperty(property))
-			destination[property] = parseCommon.clone(source[property]);
+			destination[property] = Object.assign({},source[property]);
 	return destination;
 };
 

package/src/parse/abc_parse.js

@@ -440,7 +440,7 @@ var Parse = function() {
 		});
 		for (var i = 0; i < nextVoice.length; i++) {
 			var element = nextVoice[i];
-			var hint = parseCommon.clone(element);
+			var hint = Object.assign({},element);
 			voice.push(hint);
 			if (element.el_type === 'bar')
 					return;

package/src/parse/abc_parse_directive.js

@@ -485,8 +485,6 @@ var parseDirective = {};
 	var midiCmdParam1Integer = [
 		"bassvol",
 		"chordvol",
-		"bassprog",
-		"chordprog",
 		"c",
 		"channel",
 		"beatmod",
@@ -500,7 +498,8 @@ var parseDirective = {};
 		"transpose",
 		"rtranspose",
 		"vol",
-		"volinc"
+		"volinc",
+		"gchordbars"	
 	];
 	var midiCmdParam1Integer1OptionalInteger = [
 		"program"
@@ -531,6 +530,10 @@ var parseDirective = {};
 		"drum",
 		"chordname"
 	];
+  	var midiCmdParam1Integer1OptionalString = [
+  		"bassprog", "chordprog"
+  	];
+
 
 	var parseMidiCommand = function(midi, tune, restOfString) {
 		var midi_cmd = midi.shift().token;
@@ -673,6 +676,44 @@ var parseDirective = {};
 				}
 			}
 		}
+	    else if (midiCmdParam1Integer1OptionalString.indexOf(midi_cmd) >= 0){
+
+	      // ONE INT PARAMETER, ONE OPTIONAL string
+	    	if (midi.length !== 1 && midi.length !== 2) 
+				warn("Expected one or two parameters in MIDI " + midi_cmd, restOfString, 0);
+			else if (midi[0].type !== "number") 
+				warn("Expected integer parameter in MIDI " + midi_cmd, restOfString, 0);
+			else if (midi.length === 2 && midi[1].type !== "alpha") 
+				warn("Expected alpha parameter in MIDI " + midi_cmd, restOfString, 0);
+			else {
+	        	midi_params.push(midi[0].intt);
+
+	        // Currently only bassprog and chordprog with optional octave shifts use this path
+	        if (midi.length === 2){
+	          var cmd = midi[1].token;
+	          if (cmd.indexOf("octave=") != -1){
+	            cmd = cmd.replace("octave=","");
+	            cmd = parseInt(cmd);
+	            if (!isNaN(cmd)){
+	              // Limit range from -1 to 3 octaves
+	              if (cmd < -1){
+					warn("Expected octave= in MIDI " + midi_cmd + ' to be >= -1 (recv:'+cmd+')');
+	                cmd = -1;
+	              }
+	              if (cmd > 3){
+					warn("Expected octave= in MIDI " + midi_cmd + ' to be <= 3 (recv:'+cmd+')');
+	                cmd = 3;
+	              }
+	              midi_params.push(cmd);
+	            } else
+	            warn("Expected octave value in MIDI" + midi_cmd);
+	          }
+	          else{
+	            warn("Expected octave= in MIDI" + midi_cmd);
+	          }
+	        }
+	      }
+	    }
 
 		if (tuneBuilder.hasBeginMusic())
 			tuneBuilder.appendElement('midi', -1, -1, { cmd: midi_cmd, params: midi_params });

package/src/parse/abc_parse_header.js

@@ -341,6 +341,7 @@ var ParseHeader = function(tokenizer, warn, multilineVars, tune, tuneBuilder) {
 
 	this.letter_to_inline_header = function(line, i, startLine)
 	{
+		var needsNewLine = false
 		var ws = tokenizer.eatWhiteSpace(line, i);
 		i +=ws;
 		if (line.length >= i+5 && line[i] === '[' && line[i+2] === ':') {
@@ -396,9 +397,9 @@ var ParseHeader = function(tokenizer, warn, multilineVars, tune, tuneBuilder) {
 					break;
 				case "[V:":
 					if (e > 0) {
-						parseKeyVoice.parseVoice(line, i+3, e);
+						needsNewLine = parseKeyVoice.parseVoice(line, i+3, e);
 						//startNewLine();
-						return [ e-i+1+ws, line[i+1], line.substring(i+3, e)];
+						return [ e-i+1+ws, line[i+1], line.substring(i+3, e), needsNewLine];
 					}
 					break;
 				case "[r:":
@@ -413,6 +414,7 @@ var ParseHeader = function(tokenizer, warn, multilineVars, tune, tuneBuilder) {
 
 	this.letter_to_body_header = function(line, i)
 	{
+		var needsNewLine = false
 		if (line.length >= i+3) {
 			switch(line.substring(i, i+2))
 			{
@@ -447,9 +449,9 @@ var ParseHeader = function(tokenizer, warn, multilineVars, tune, tuneBuilder) {
 					else if (tempo.type === 'immediate') tuneBuilder.appendElement('tempo', multilineVars.iChar + i, multilineVars.iChar + line.length, tempo.tempo);
 				return [ e, line[i], parseCommon.strip(line.substring(i+2))];
 				case "V:":
-					parseKeyVoice.parseVoice(line, i+2, line.length);
+					needsNewLine = parseKeyVoice.parseVoice(line, i+2, line.length);
 //						startNewLine();
-					return [ line.length, line[i], parseCommon.strip(line.substring(i+2))];
+					return [ line.length, line[i], parseCommon.strip(line.substring(i+2)), needsNewLine];
 				default:
 					// TODO: complain about unhandled header
 			}

package/src/parse/abc_parse_key_voice.js

@@ -1,4 +1,3 @@
-var parseCommon = require('./abc_common');
 var parseDirective = require('./abc_parse_directive');
 var transpose = require('./abc_transpose');
 
@@ -84,7 +83,7 @@ var parseKeyVoice = {};
 	parseKeyVoice.deepCopyKey = function(key) {
 		var ret = { accidentals: [], root: key.root, acc: key.acc, mode: key.mode };
 		key.accidentals.forEach(function(k) {
-		ret.accidentals.push(parseCommon.clone(k));
+		ret.accidentals.push(Object.assign({},k));
 		});
 		return ret;
 	};
@@ -151,7 +150,7 @@ var parseKeyVoice = {};
 	};
 
 	parseKeyVoice.fixKey = function(clef, key) {
-		var fixedKey = parseCommon.clone(key);
+		var fixedKey = Object.assign({},key);
 		parseKeyVoice.addPosToKey(clef, fixedKey);
 		return fixedKey;
 	};
@@ -494,8 +493,13 @@ var parseKeyVoice = {};
 	};
 
 	var setCurrentVoice = function(id) {
-		multilineVars.currentVoice = multilineVars.voices[id];
-		tuneBuilder.setCurrentVoice(multilineVars.currentVoice.staffNum, multilineVars.currentVoice.index);
+		var currentVoice = multilineVars.voices[id]
+		if (multilineVars.currentVoice) {
+			if (multilineVars.currentVoice.index === currentVoice.index && multilineVars.currentVoice.staffNum === currentVoice.staffNum)
+				return // there was no change so don't reset it.
+		}
+		multilineVars.currentVoice = currentVoice;
+		return tuneBuilder.setCurrentVoice(currentVoice.staffNum, currentVoice.index, id);
 	};
 
 	parseKeyVoice.parseVoice = function(line, i, e) {
@@ -788,7 +792,7 @@ var parseKeyVoice = {};
 		if (staffInfo.name) {if (s.name) s.name.push(staffInfo.name); else s.name = [ staffInfo.name ];}
 		if (staffInfo.subname) {if (s.subname) s.subname.push(staffInfo.subname); else s.subname = [ staffInfo.subname ];}
 
-		setCurrentVoice(id);
+		return setCurrentVoice(id);
 	};
 
 })();

package/src/parse/abc_parse_music.js

@@ -1,4 +1,3 @@
-var parseCommon = require('./abc_common');
 var parseKeyVoice = require('./abc_parse_key_voice');
 var transpose = require('./abc_transpose');
 
@@ -145,6 +144,7 @@ MusicParser.prototype.parseMusic = function(line) {
 		var retInlineHeader = header.letter_to_inline_header(line, i, delayStartNewLine);
 		if (retInlineHeader[0] > 0) {
 			i += retInlineHeader[0];
+			//console.log("inline header", retInlineHeader)
 			if (retInlineHeader[1] === 'V')
 				delayStartNewLine = true; // fixes bug on this: c[V:2]d
 			// TODO-PER: Handle inline headers
@@ -457,6 +457,9 @@ MusicParser.prototype.parseMusic = function(line) {
 											else
 												postChordDone = true;
 											break;
+										case '0':
+											chordDuration = 0;
+											break;
 										default:
 											postChordDone = true;
 											break;
@@ -554,13 +557,17 @@ MusicParser.prototype.parseMusic = function(line) {
 						// The first item on a line is a regular note value, each item after that represents a dot placed after the previous note.
 						// Only durations less than a whole note are tested because whole note durations have some tricky rules.
 
-            if (el.duration < 1 && durations.indexOf(el.duration) === -1 && el.duration !== 0) {
+						if (el.duration < 1 && durations.indexOf(el.duration) === -1 && el.duration !== 0) {
 							if (!el.rest || el.rest.type !== 'spacer')
 								warn("Duration not representable: " + line.substring(startI, i), line, i);
 						}
 
 						multilineVars.addFormattingOptions(el, tune.formatting, 'note');
-						tuneBuilder.appendElement('note', startOfLine+startI, startOfLine+i, el);
+						var succeeded = tuneBuilder.appendElement('note', startOfLine+startI, startOfLine+i, el);
+						if (!succeeded) {
+							this.startNewLine()
+							tuneBuilder.appendElement('note', startOfLine+startI, startOfLine+i, el);
+						}
 						multilineVars.measureNotEmpty = true;
 						el = {};
 					}
@@ -608,23 +615,38 @@ var letter_to_chord = function(line, i) {
 			chord[1] = chord[1].substring(1);
 			chord[2] = 'right';
 		} else if (chord[0] > 0 && chord[1].length > 0 && chord[1][0] === '@') {
-			// @-15,5.7
-			chord[1] = chord[1].substring(1);
-			var x = tokenizer.getFloat(chord[1]);
-			if (x.digits === 0)
-				warn("Missing first position in absolutely positioned annotation.", line , i);
-			chord[1] = chord[1].substring(x.digits);
-			if (chord[1][0] !== ',')
-				warn("Missing comma absolutely positioned annotation.", line , i);
-			chord[1] = chord[1].substring(1);
-			var y = tokenizer.getFloat(chord[1]);
-			if (y.digits === 0)
-				warn("Missing second position in absolutely positioned annotation.", line , i);
-			chord[1] = chord[1].substring(y.digits);
-			var ws = tokenizer.skipWhiteSpace(chord[1]);
-			chord[1] = chord[1].substring(ws);
-			chord[2] = null;
-			chord[3] = { x: x.value, y: y.value };
+		      // @-15,5.7		
+		      chord[1] = chord[1].substring(1);
+		      var x = tokenizer.getFloat(chord[1]);
+		      if (x.digits === 0){
+			warn("Missing first position in absolutely positioned annotation.", line, i);
+			chord[1] = chord[1].replace("@","");
+			chord[2] = 'above';
+			return chord;
+		      }
+		      chord[1] = chord[1].substring(x.digits);
+		      if (chord[1][0] !== ','){
+			warn("Missing comma absolutely positioned annotation.", line, i);
+			chord[1] = chord[1].replace("@","");
+			chord[2] = 'above';
+			return chord;
+		      }
+		      chord[1] = chord[1].substring(1);
+		      var y = tokenizer.getFloat(chord[1]);
+		      if (y.digits === 0){
+			warn("Missing second position in absolutely positioned annotation.", line, i);
+			chord[1] = chord[1].replace("@","");
+			chord[2] = 'above';
+			return chord;
+		      }
+		      chord[1] = chord[1].substring(y.digits);
+		      var ws = tokenizer.skipWhiteSpace(chord[1]);
+		      chord[1] = chord[1].substring(ws);
+		      chord[2] = null;
+		      chord[3] = {
+			x: x.value,
+			y: y.value
+		      };	
 		} else {
 			if (multilineVars.freegchord !== true) {
 				chord[1] = chord[1].replace(/([ABCDEFG0-9])b/g, "$1♭");
@@ -670,7 +692,11 @@ var letter_to_grace =  function(line, i) {
 				note.duration = note.duration / (multilineVars.default_length * 8);
 				if (acciaccatura)
 					note.acciaccatura = true;
-				gracenotes.push(note);
+				if (note.rest) {
+					// don't allow rests inside gracenotes
+					warn("Rests not allowed as grace notes '" + gra[1][ii] + "' while parsing grace note", line, i);
+				} else
+					gracenotes.push(note);
 
 				if (inTie) {
 					note.endTie = true;
@@ -927,7 +953,7 @@ MusicParser.prototype.startNewLine = function() {
 	var params = { startChar: -1, endChar: -1};
 	if (multilineVars.partForNextLine.title)
 		params.part = multilineVars.partForNextLine;
-	params.clef = multilineVars.currentVoice && multilineVars.staves[multilineVars.currentVoice.staffNum].clef !== undefined ? parseCommon.clone(multilineVars.staves[multilineVars.currentVoice.staffNum].clef) : parseCommon.clone(multilineVars.clef);
+	params.clef = multilineVars.currentVoice && multilineVars.staves[multilineVars.currentVoice.staffNum].clef !== undefined ? Object.assign({},multilineVars.staves[multilineVars.currentVoice.staffNum].clef) : Object.assign({},multilineVars.clef);
 	var scoreTranspose = multilineVars.currentVoice ? multilineVars.currentVoice.scoreTranspose : 0;
 	params.key = parseKeyVoice.standardKey(multilineVars.key.root+multilineVars.key.acc+multilineVars.key.mode, multilineVars.key.root, multilineVars.key.acc, scoreTranspose);
 	params.key.mode = multilineVars.key.mode;
@@ -997,6 +1023,12 @@ MusicParser.prototype.startNewLine = function() {
 			params.style = multilineVars.currentVoice.style;
 		if (multilineVars.currentVoice.transpose)
 			params.clef.transpose = multilineVars.currentVoice.transpose;
+		params.currentVoice = multilineVars.currentVoice
+		var voices = Object.keys(multilineVars.voices)
+		for (var mv = 0; mv < voices.length; mv++) {
+			if (params.currentVoice.staffNum === multilineVars.voices[voices[mv]].staffNum && params.currentVoice.index === multilineVars.voices[voices[mv]].index)
+				params.currentVoiceName = voices[mv]
+		}
 	}
 	var isFirstVoice = multilineVars.currentVoice === undefined || (multilineVars.currentVoice.staffNum ===  0 && multilineVars.currentVoice.index ===  0);
 	if (multilineVars.barNumbers === 0 && isFirstVoice && multilineVars.currBarNumber !== 1)