abcjs 6.1.7 → 6.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abcjs",
-  "version": "6.1.7",
+  "version": "6.1.9",
   "description": "Renderer for abc music notation",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -44,16 +44,16 @@
   },
   "homepage": "https://abcjs.net",
   "devDependencies": {
-    "@babel/core": "7.20.2",
+    "@babel/core": "7.20.12",
     "@babel/preset-env": "7.20.2",
     "@tarp/require": "1.4.3",
-    "babel-loader": "9.1.0",
+    "babel-loader": "9.1.2",
     "chai": "4.3.7",
-    "concurrently": "7.5.0",
+    "concurrently": "7.6.0",
     "http-server": "14.1.1",
-    "mocha": "10.1.0",
+    "mocha": "10.2.0",
     "opener": "1.5.2",
-    "vuepress": "2.0.0-beta.26",
+    "vuepress": "2.0.0-beta.60",
     "vuex": "4.1.0",
     "webpack-bundle-analyzer": "4.7.0",
     "webpack-cli": "4.10.0"

package/src/data/abc_tune.js

@@ -399,6 +399,8 @@ var Tune = function() {
 
 				var voices = group.voices;
 				for (var v = 0; v < voices.length; v++) {
+					if (voices[v].staff && voices[v].staff.isTabStaff)
+						continue;
 					var noteFound = false;
 					if (!voicesArr[v])
 						voicesArr[v] = [];

package/src/midi/abc_midi_create.js

@@ -36,8 +36,14 @@ var create;
 						var pan = 0;
 						if (options.pan && options.pan.length > i)
 							pan = options.pan[i];
-						midi.setChannel(event.channel, pan);
-						midi.setInstrument(event.instrument);
+						if (event.instrument === 128) {
+							// If we're using the percussion voice, change to Channel 10
+							midi.setChannel(9, pan);
+							midi.setInstrument(0);
+						} else {
+							midi.setChannel(event.channel, pan);
+							midi.setInstrument(event.instrument);
+						}
 						break;
 					case 'note':
 						var gapLengthInBeats = event.gap * beatsPerSecond;

package/src/parse/abc_parse.js

@@ -78,6 +78,7 @@ var Parse = function() {
 			this.hasMainTitle = false;
 			this.default_length = 0.125;
 			this.clef = { type: 'treble', verticalPos: 0 };
+			this.octave = 0;
 			this.next_note_duration = 0;
 			this.start_new_line = true;
 			this.is_in_header = true;

package/src/parse/abc_parse_key_voice.js

@@ -408,6 +408,16 @@ var parseKeyVoice = {};
 					multilineVars.clef.staffscale = tokens[0].floatt;
 					tokens.shift();
 					break;
+				case "octave":
+					tokens.shift();
+					if (tokens.length === 0) { warn("Expected = after octave", str, 0); return ret; }
+					token = tokens.shift();
+					if (token.token !== "=") { warn("Expected = after octave", str, token.start); break; }
+					if (tokens.length === 0) { warn("Expected parameter after octave=", str, 0); return ret; }
+					if (tokens[0].type !== 'number') { warn("Expected number after octave", str, tokens[0].start); break; }
+					multilineVars.octave = tokens[0].intt;
+					tokens.shift();
+					break;
 				case "style":
 					tokens.shift();
 					if (tokens.length === 0) { warn("Expected = after style", str, 0); return ret; }
@@ -716,7 +726,6 @@ var parseKeyVoice = {};
 						addNextTokenToVoiceInfo(id, 'staffscale', 'number');
 						break;
 					case 'octave':
-						// TODO-PER: This is accepted, but not implemented, yet.
 						addNextTokenToVoiceInfo(id, 'octave', 'number');
 						break;
 					case 'volume':

package/src/parse/abc_parse_music.js

@@ -724,7 +724,7 @@ var legalAccents = [
 	"slide", "marcato",
 	"upbow", "downbow", "/", "//", "///", "////", "trem1", "trem2", "trem3", "trem4",
 	"turnx", "invertedturn", "invertedturnx", "trill(", "trill)", "arpeggio", "xstem", "mark", "umarcato",
-	"style=normal", "style=harmonic", "style=rhythm", "style=x", "style=triangle"
+	"style=normal", "style=harmonic", "style=rhythm", "style=x", "style=triangle", "D.C.alcoda", "D.C.alfine", "D.S.alcoda", "D.S.alfine", "editorial", "courtesy"
 ];
 
 var volumeDecorations = [
@@ -1128,6 +1128,7 @@ var getCoreNote = function(line, index, el, canHaveBrokenRhythm) {
 			case 'g':
 				if (state === 'startSlur' || state === 'sharp2' || state === 'flat2' || state === 'pitch') {
 					el.pitch = pitches[line.charAt(index)];
+					el.pitch += 7 * (multilineVars.currentVoice && multilineVars.currentVoice.octave !== undefined ? multilineVars.currentVoice.octave : multilineVars.octave);
 					el.name = line.charAt(index);
 					if (el.accidental)
 						el.name = accMap[el.accidental] + el.name;

package/src/parse/abc_transpose.js

@@ -51,7 +51,15 @@ transpose.keySignature = function(multilineVars, keyName, root, acc, localTransp
 		keyName = keyName.substr(2);
 	} else
 		keyName = keyName.substr(1);
-	var index = keyIndex[baseKey] + multilineVars.localTranspose;
+	var thisKeyIndex = keyIndex[baseKey]
+	var recognized = thisKeyIndex !== undefined
+	if (!recognized) {
+		// Either the key sig is "none" or we don't recognize it. Either way we don't change it, and we assume key of C for the purposes of this calculation.
+		thisKeyIndex = 0
+		baseKey = "C"
+		keyName = ""
+	}
+	var index = thisKeyIndex + multilineVars.localTranspose;
 	while (index < 0) index += 12;
 	if (index > 11) index = index % 12;
 	var newKeyName = (keyName[0] === 'm' ? newKeyMinor[index] : newKey[index]);
@@ -87,7 +95,10 @@ transpose.keySignature = function(multilineVars, keyName, root, acc, localTransp
 		multilineVars.localTransposeVerticalMovement = distance + Math.floor(multilineVars.localTranspose / 12) * 7;
 	else
 		multilineVars.localTransposeVerticalMovement = distance + Math.ceil(multilineVars.localTranspose / 12) * 7;
-	return { accidentals: newKeySig, root: newKeyName[0], acc: newKeyName.length > 1 ? newKeyName[1] : "" };
+	if (recognized)
+		return { accidentals: newKeySig, root: newKeyName[0], acc: newKeyName.length > 1 ? newKeyName[1] : "" };
+	else
+		return { accidentals: [], root: root, acc: acc };
 };
 
 transpose.chordName = function(multilineVars, chord) {
@@ -145,7 +156,7 @@ var accidentals3 = {
 	"1": "^",
 	"2": "^^"
 };
-var count = 0
+//var count = 0
 transpose.note = function(multilineVars, el) {
 	// the "el" that is passed in has el.name, el.accidental, and el.pitch. "pitch" is the vertical position (0=middle C)
 	// localTranspose is the number of half steps

package/src/synth/abc_midi_sequencer.js

@@ -6,7 +6,7 @@ var parseCommon = require("../parse/abc_common");
 (function() {
 	"use strict";
 
-	var measureLength;
+	var measureLength = 1; // This should be set by the meter, but just in case that is missing, we'll take a guess.
 	// The abc is provided to us line by line. It might have repeats in it. We want to re arrange the elements to
 	// be an array of voices with all the repeats embedded, and no lines. Then it is trivial to go through the events
 	// one at a time and turn it into midi.

package/src/synth/pitches-to-perc.js

@@ -55,6 +55,18 @@ var pitchMap = {
 	n13: "=b",
 	s13: "^b",
 	x13: "b",
+	f14: "_c'",
+	n14: "=c'",
+	s14: "^c'",
+	x14: "c'",
+	f15: "_d'",
+	n15: "=d'",
+	s15: "^d'",
+	x15: "d'",
+	f16: "_e'",
+	n16: "=e'",
+	s16: "^e'",
+	x16: "e'",
 }
 
 function pitchesToPerc(pitchObj) {

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

@@ -103,7 +103,7 @@ function handleChordNotes(self, notes) {
 
 function noteToNumber(self, note, stringNumber, secondPosition , firstSize) {
   var strings = self.strings;
-  note.checkKeyAccidentals(self.accidentals) ;
+  note.checkKeyAccidentals(self.accidentals, self.measureAccidentals) ;
   if (secondPosition) {
     strings = secondPosition;
   }
@@ -131,6 +131,22 @@ function noteToNumber(self, note, stringNumber, secondPosition , firstSize) {
 }
 
 function toNumber(self, note) {
+  if (note.isAltered || note.natural) {
+    var acc;
+    if (note.isFlat) {
+      if (note.isDouble)
+        acc = "__"
+      else
+        acc = "_"  
+    } else if (note.isSharp) {
+      if (note.isDouble)
+        acc = "^^"
+      else
+        acc = "^"  
+    } else if (note.natural)
+      acc = "="
+    self.measureAccidentals[note.name.toUpperCase()] = acc  
+  }
   var num = null;
   var str = 0;
   var lowestString = self.strings[self.strings.length - 1];
@@ -254,6 +270,7 @@ function StringPatterns(plugin) {
     // override default
     this.highestNote = highestNote;
   }
+  this.measureAccidentals = {}
   this.capo = 0;
   if (capo) {
     this.capo = capo;

package/src/tablatures/instruments/tab-note.js

@@ -115,7 +115,18 @@ TabNote.prototype.isLowerThan = function (note) {
   return false;
 };
 
-TabNote.prototype.checkKeyAccidentals = function(accidentals) {
+TabNote.prototype.checkKeyAccidentals = function(accidentals, measureAccidentals) {
+  if (this.isAltered || this.natural)
+    return
+  if (measureAccidentals[this.name.toUpperCase()]) {
+    switch (measureAccidentals[this.name.toUpperCase()]) {
+      case "__": this.acc = -2; return;
+      case "_": this.acc = -1; return;
+      case "=": this.acc = 0; return;
+      case "^": this.acc = 1; return;
+      case "^^": this.acc = 2; return;
+    }
+  }  
   if (accidentals) {
     var curNote = this.name;
     for (var iii = 0; iii < accidentals.length; iii++) {

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

@@ -27,6 +27,8 @@ function cloneAbsolute(absSrc) {
     if (returned.abcelem.el_type === "note")
       returned.abcelem.el_type = 'tabNumber';
   }
+  // TODO-PER: This fixes the classes because the element isn't created at the right time.
+  absSrc.cloned = returned
   return returned;
 }
 
@@ -226,6 +228,7 @@ TabAbsoluteElements.prototype.build = function (plugin,
         }
         break;
       case 'bar':
+        plugin.semantics.strings.measureAccidentals = {}
         var lastBar = false;
         if (ii === source.children.length-1) {
           // used for final line bar drawing

package/src/tablatures/tab-renderer.js

@@ -228,6 +228,7 @@ TabRenderer.prototype.doLayout = function () {
   for (var ii = 0; ii < nbVoices; ii++) {
     var tabVoice = new VoiceElement(0, 0);
     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;
     tabVoice.staff = staffGroupInfos;

package/src/test/abc_parser_lint.js

@@ -61,7 +61,7 @@ var ParserLint = function() {
 		"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"
+		"mark", "marcato", "umarcato", "D.C.alcoda", "D.C.alfine", "D.S.alcoda", "D.S.alfine", "editorial", "courtesy"
 	] } };
 
 	var tempoProperties =  {

package/src/write/abc_decoration.js

@@ -143,12 +143,12 @@ var Decoration = function Decoration() {
 			}
 			return y;
 		}
-		function textDecoration(text, placement) {
+		function textDecoration(text, placement, anchor) {
 			var y = getPlacement(placement);
 			var textFudge = 2;
 			var textHeight = 5;
 			// TODO-PER: Get the height of the current font and use that for the thickness.
-			abselem.addFixedX(new RelativeElement(text, width/2, 0, y+textFudge, {type:"decoration", klass: 'ornament', thickness: 3}));
+			abselem.addFixedX(new RelativeElement(text, width/2, 0, y+textFudge, {type:"decoration", klass: 'ornament', thickness: 3, anchor: anchor}));
 
 			incrementPlacement(placement, textHeight);
 		}
@@ -205,11 +205,27 @@ var Decoration = function Decoration() {
 				case "5":
 				case "D.C.":
 				case "D.S.":
-					textDecoration(decoration[i], positioning);
+					textDecoration(decoration[i], positioning, 'middle');
+					hasOne = true;
+					break;
+				case "D.C.alcoda":
+					textDecoration("D.C. al coda", positioning, 'left');
+					hasOne = true;
+					break;
+				case "D.C.alfine":
+					textDecoration("D.C. al fine", positioning, 'left');
+					hasOne = true;
+					break;
+				case "D.S.alcoda":
+					textDecoration("D.S. al coda", positioning, 'left');
+					hasOne = true;
+					break;
+				case "D.S.alfine":
+					textDecoration("D.S. al fine", positioning, 'left');
 					hasOne = true;
 					break;
 				case "fine":
-					textDecoration("FINE", positioning);
+					textDecoration("FINE", positioning, 'middle');
 					hasOne = true;
 					break;
 				case "+":

package/src/write/abc_relative_element.js

@@ -13,6 +13,7 @@ var RelativeElement = function RelativeElement(c, dx, w, pitch, opt) {
 	this.pitch2 = opt.pitch2;
 	this.linewidth = opt.linewidth;
 	this.klass = opt.klass;
+	this.anchor = opt.anchor ? opt.anchor : 'middle'
 	this.top = pitch;
 	if (this.pitch2 !== undefined && this.pitch2 > this.top) this.top = this.pitch2;
 	this.bottom = pitch;

package/src/write/classes.js

@@ -79,6 +79,10 @@ Classes.prototype.generate = function (c) {
 		return "";
 	var ret = [];
 	if (c && c.length > 0) ret.push(c);
+	if (c === "tab-number") // TODO-PER-HACK! straighten out the tablature
+		return ret.join(' ')
+	if (c === "text instrument-name")
+		return "abcjs-text abcjs-instrument-name"	
 	if (this.lineNumber !== null) ret.push("l"+this.lineNumber);
 	if (this.measureNumber !== null) ret.push("m"+this.measureNumber);
 	if (this.measureNumber !== null) ret.push("mm"+this.measureTotal()); // measureNumber is null between measures so this is still the test for measureTotal

package/src/write/draw/absolute.js

@@ -32,6 +32,14 @@ function drawAbsolute(renderer, params, bartop, selectables, staffPos) {
 	}
 	var g = elementGroup.endGroup(klass, params.type);
 	if (g) {
+		// TODO-PER-HACK! This corrects the classes because the tablature is not being created at the right time.
+		if (params.cloned) {
+			params.cloned.overrideClasses = g.className.baseVal
+		}
+		if (params.overrideClasses) {
+			var type = g.classList && g.classList.length > 0 ? g.classList[0] + ' ' : ''
+			g.setAttribute("class", type + params.overrideClasses)
+		}
 		if (isTempo) {
 			params.startChar = params.abcelem.startChar;
 			params.endChar = params.abcelem.endChar;

package/src/write/draw/relative.js

@@ -46,7 +46,7 @@ function drawRelativeElement(renderer, params, bartop) {
 			break;
 		case "decoration":
 			// The +6 is to compensate for the placement of text in svg: to be on the same row as symbols, the y-coord needs to compensate for the center line.
-			params.graphelem = renderText(renderer, { x: params.x, y: y+6, text: params.c, type: 'annotationfont', klass: renderer.controller.classes.generate("annotation"), anchor: "middle", centerVertically: true, dim: params.dim}, false);
+			params.graphelem = renderText(renderer, { x: params.x, y: y+6, text: params.c, type: 'annotationfont', klass: renderer.controller.classes.generate("annotation"), anchor: params.anchor, centerVertically: true, dim: params.dim}, false);
 			break;
 		case "text":
 			params.graphelem = renderText(renderer, { x: params.x, y: y, text: params.c, type: 'annotationfont', klass: renderer.controller.classes.generate("annotation"), anchor: "start", centerVertically: params.centerVertically, dim: params.dim, lane: params.getLane(), name: "annotation"}, false);

package/src/write/selection.js

@@ -15,9 +15,9 @@ function setupSelection(engraver, svgs) {
 		}
 	}
 	for (var i = 0; i < svgs.length; i++) {
-		svgs[i].addEventListener('touchstart', mouseDown.bind(engraver));
-		svgs[i].addEventListener('touchmove', mouseMove.bind(engraver));
-		svgs[i].addEventListener('touchend', mouseUp.bind(engraver));
+		svgs[i].addEventListener('touchstart', mouseDown.bind(engraver), {passive: true});
+		svgs[i].addEventListener('touchmove', mouseMove.bind(engraver), {passive: true});
+		svgs[i].addEventListener('touchend', mouseUp.bind(engraver), {passive: true});
 		svgs[i].addEventListener('mousedown', mouseDown.bind(engraver));
 		svgs[i].addEventListener('mousemove', mouseMove.bind(engraver));
 		svgs[i].addEventListener('mouseup', mouseUp.bind(engraver));

package/types/index.d.ts

@@ -68,7 +68,8 @@ declare module 'abcjs' {
 		"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"
+		"mark" | "marcato" | "umarcato" |
+		"D.C.alcoda" | "D.C.alfine" | "D.S.alcoda" | "D.S.alfine" | "editorial" | "courtesy"
 
 	//
 	// Basic types
@@ -157,19 +158,54 @@ declare module 'abcjs' {
 
 	export type MidiParam = Array<string|number>;
 
-	export type MidiGracePitches = Array<{instrument: string; pitch: number; volume: number; cents?: number}>;
+	export type MidiGracePitches = Array<{instrument: number; pitch: number; volume: number; cents?: number; durationInMeasures: number}>;
 
 	export interface MidiPitch {
-		instrument: string;
+		instrument: number;
 		pitch: number;
 		duration: number;
 		volume: number;
-		cents?: number
+		cents?: number;
+		start: number;
+		gap: number;
 	}
 
 	export type MidiPitches = Array<MidiPitch>;
 
-	export type AbsoluteElement = any; // TODO
+	export interface AbsoluteElement {
+		abcelem : AbcElem;
+		bottom : number;
+		children : Array<RelativeElement>
+		duration : number;
+		durationClass : number;
+		elemset : Array<SVGElement>
+		extra : Array<RelativeElement>
+		extraw : number;
+		fixed : {w: number, t: number, b: number}
+		heads : Array<RelativeElement>
+		invisible : boolean;
+		minspacing : number;
+		notePositions : Array<{x:number; y:number;}>
+		right : Array<RelativeElement>
+		specialY : Array<{
+			chordHeightAbove : number;
+			chordHeightBelow : number;
+			dynamicHeightAbove : number;
+			dynamicHeightBelow : number;
+			endingHeightAbove : number;
+			lyricHeightAbove : number;
+			lyricHeightBelow : number;
+			partHeightAbove : number;
+			tempoHeightAbove : number;
+			volumeHeightAbove : number;
+			volumeHeightBelow : number;
+		}>
+		top : number;
+		tuneNumber : number;
+		type : "symbol" | "tempo" | "part" | "rest" | "note" | "bar" | "staff-extra clef" | "staff-extra key-signature" | "staff-extra time-signature";
+		w : number;
+		x : number;
+	}
 
 	export type AbstractEngraver = any;
 
@@ -340,7 +376,7 @@ declare module 'abcjs' {
 		millisecondsPerMeasure: number;
 		type: NoteTimingEventType;
 
-		elements?: Array<HTMLElement>;
+		elements?: Array<Array<HTMLElement>>;
 		endChar?: number;
 		endCharArray?: Array<number>;
 		endX?: number;
@@ -349,6 +385,7 @@ declare module 'abcjs' {
 		line?: number;
 		measureNumber?: number;
 		midiPitches?: MidiPitches;
+		midiGraceNotePitches?: MidiGracePitches;
 		startChar?: number;
 		startCharArray?: Array<number>;
 		top?: number;
@@ -781,21 +818,32 @@ declare module 'abcjs' {
 	}
 
 	export interface AbcElem {
-		el_type: string //TODO enumerate these
-		abselem: any;
+		el_type: string; //TODO enumerate these
+		abselem: AbsoluteElement;
 		beambr?: number;
-		chord?: Array<any>
-		decoration: Array<any>
+		chord?: Array<{name: string; position: ChordPlacement}>
+		decoration: Array<string> //TODO enumerate these
 		duration: number
 		endBeam?: boolean
 		endSlur?: number
 		endTriplet?: true
-		gracenotes?: Array<any>
-		lyric?: Array<any>
+		gracenotes?: Array<{duration: number; name:string; pitch: number; verticalPosition: number;}>
+		lyric?: Array<{syllable: string; divider: ' ' | '-' | '_';}>
 		noStem?: boolean
-		pitches?: Array<any>
+		midiPitches?: MidiPitches;
+		midiGraceNotePitches?: MidiGracePitches;
+		pitches?: Array<{
+			pitch: number;
+			name: string;
+			startSlur?: Array<{label: number}>;
+			endSlur?: Array<number>;
+			startTie?: {};
+			endTie?: boolean;
+			verticalPos: number;
+			highestVert: number;
+		}>
 		positioning?: any
-		rest?: any
+		rest?: {"type": "rest"}
 		startBeam?: boolean
 		startTriplet?: number
 		tripletMultiplier?: number
@@ -1086,8 +1134,8 @@ declare module 'abcjs' {
 
 	export interface SynthObjectController {
 		disable(isDisabled: boolean): void
-		setTune(visualObj: TuneObject, userAction: boolean, audioParams?: any): Promise<SynthInitResponse>
-		load(selector: string, cursorControl?: any, visualOptions?: SynthVisualOptions): void
+		setTune(visualObj: TuneObject, userAction: boolean, audioParams?: SynthOptions): Promise<SynthInitResponse>
+		load(selector: string, cursorControl?: CursorControl | null, visualOptions?: SynthVisualOptions): void
 		play(): void
 		pause(): void
 		toggleLoop(): void

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.1.7';
+var version = '6.1.9';
 
 module.exports = version;