abcjs 6.1.9 → 6.2.0

package/src/synth/note-to-midi.js

@@ -0,0 +1,50 @@
+var accidentals = {
+	"__": -2,
+	"_": -1,
+	"_/": -0.5,
+	"=": 0,
+	"": 0,
+	"^/": 0.5,
+	"^": 1,
+	"^^": 2
+}
+
+var notesInOrder = ['C', '-', 'D', '-', 'E', 'F', '-', 'G', '-', 'A', '-', 'B', 'c', '-', 'd', '-', 'e', 'f', '-', 'g', '-', 'a', '-', 'b']
+
+function noteToMidi(note) {
+	var reg = note.match(/([_^\/]*)([ABCDEFGabcdefg])(,*)('*)/)
+	if (reg && reg.length === 5) {
+		var acc = accidentals[reg[1]]
+		var pitch = notesInOrder.indexOf(reg[2])
+		var octave = reg[4].length - reg[3].length
+		return 48 + pitch + acc + octave * 12;
+	}
+	return 0;
+}
+
+function midiToNote(midi) {
+	midi = parseInt(midi, 10) // TODO-PER: not sure how to handle quarter sharps and flats, so strip them for now.
+	var octave = Math.floor(midi / 12)
+	var pitch = midi % 12
+	var name = notesInOrder[pitch]
+	if (name === '-') {
+		name = '^' + notesInOrder[pitch-1]
+	}
+	
+	if (octave > 4) {
+		name = name.toLowerCase()
+		octave -= 5
+		while (octave > 0) {
+			name += "'"
+			octave--
+		}
+	} else {
+		while (octave < 4) {
+			name += ','
+			octave++
+		}
+	}	
+	return name
+}
+
+module.exports = {noteToMidi: noteToMidi, midiToNote: midiToNote};

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

@@ -5,7 +5,6 @@ var StringTablature = require('../string-tablature');
 var TabCommon = require('../../tab-common');
 var TabRenderer = require('../../tab-renderer');
 var GuitarPatterns = require('./guitar-patterns');
-var setGuitarFonts = require('./guitar-fonts');
 
 /**
 * upon init mainly store provided instances for later usage
@@ -32,7 +31,6 @@ Plugin.prototype.init = function (abcTune, tuneNumber, params) {
 Plugin.prototype.render = function (renderer, line, staffIndex) {
   if (this._super.inError) return;
   if (this.tablature.bypass(line)) return;
-  setGuitarFonts(this.abcTune);
   var rndrer = new TabRenderer(this, renderer, line, staffIndex);
   rndrer.doLayout();
 };

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

@@ -1,3 +1,4 @@
+const {noteToMidi} = require('../../synth/note-to-midi');
 var TabNote = require('./tab-note');
 var TabNotes = require('./tab-notes');
 
@@ -93,7 +94,10 @@ function sameString(self, chord) {
 function handleChordNotes(self, notes) {
   var retNotes = [];
   for (var iiii = 0; iiii < notes.length; iiii++) {
-    var note = new TabNote.TabNote(notes[iiii].name);
+    if (notes[iiii].endTie)
+      continue;
+    var note = new TabNote.TabNote(notes[iiii].name, self.clefTranspose);
+    note.checkKeyAccidentals(self.accidentals, self.measureAccidentals)
     var curPos = toNumber(self, note);
     retNotes.push(curPos);
   }
@@ -147,26 +151,23 @@ function toNumber(self, note) {
       acc = "="
     self.measureAccidentals[note.name.toUpperCase()] = acc  
   }
-  var num = null;
-  var str = 0;
-  var lowestString = self.strings[self.strings.length - 1];
-  var lowestNote = new TabNote.TabNote(lowestString[0]);
-  if (note.isLowerThan(lowestNote) ) {
-    return {
-      num: "?",
-      str: self.strings.length - 1,
-      note: note,
-      error: note.emit() + ': unexpected note for instrument' 
-    };
-  }
-  while (str < self.strings.length) {
-    num = noteToNumber(self, note, str);
-    if (num) {
-      return num;
+  for (var i = self.stringPitches.length-1; i >= 0; i--) {
+    if (note.pitch + note.pitchAltered >= self.stringPitches[i]) {
+      var num = note.pitch + note.pitchAltered - self.stringPitches[i]
+      if (note.quarter === '^') num -= 0.5
+      else if (note.quarter === "v") num += 0.5
+      return {
+        num: Math.round(num),
+        str: self.stringPitches.length-1-i, // reverse the strings because string 0 is on the bottom
+        note: note
+      }
     }
-    str++;
   }
-  return null; // not found
+  return {
+    num: "?",
+    str: self.stringPitches.length-1,
+    note: note,
+  };
 }
 
 StringPatterns.prototype.stringToPitch = function (stringNumber) {
@@ -198,13 +199,16 @@ StringPatterns.prototype.notesToNumber = function (notes, graces) {
         error = retNotes.error;
       }
     } else {
-      note = new TabNote.TabNote(notes[0].name);
-      number = toNumber(this, note);
-      if (number) {
-        retNotes.push(number);
-      } else {
-        invalidNumber(retNotes, note);
-        error = retNotes.error;
+      if (!notes[0].endTie) {
+        note = new TabNote.TabNote(notes[0].name, this.clefTranspose);
+        note.checkKeyAccidentals(this.accidentals, this.measureAccidentals)
+        number = toNumber(this, note);
+        if (number) {
+          retNotes.push(number);
+        } else {
+          invalidNumber(retNotes, note);
+          error = retNotes.error;
+        }
       }
     }
   }  
@@ -213,7 +217,8 @@ StringPatterns.prototype.notesToNumber = function (notes, graces) {
   if (graces) {
     retGraces = [];
     for (var iiii = 0; iiii < graces.length; iiii++) {
-      note = new TabNote.TabNote(graces[iiii].name);
+      note = new TabNote.TabNote(graces[iiii].name, this.clefTranspose);
+      note.checkKeyAccidentals(this.accidentals, this.measureAccidentals)
       number = toNumber(this, note);
       if (number) {
         retGraces.push(number);
@@ -232,7 +237,14 @@ StringPatterns.prototype.notesToNumber = function (notes, graces) {
 };
 
 StringPatterns.prototype.toString = function () {
-  return this.tuning.join('').replaceAll(',', '').toUpperCase();
+  var arr = []
+  for (var i = 0; i < this.tuning.length; i++) {
+    var str = this.tuning[i].replaceAll(',', '').replaceAll("'", '').toUpperCase();
+    if (str[0] === '_') str = str[1] + 'b '
+    else if (str[0] === '^') str = str[1] + "# "
+    arr.push(str)
+  }
+  return arr.join('');
 };
 
 StringPatterns.prototype.tabInfos = function (plugin) {
@@ -275,7 +287,13 @@ function StringPatterns(plugin) {
   if (capo) {
     this.capo = capo;
   }
+  this.transpose = plugin.transpose ? plugin.transpose : 0
   this.tuning = tuning;
+  this.stringPitches = []
+  for (var i = 0; i < this.tuning.length; i++) {
+    var pitch = noteToMidi(this.tuning[i]) + this.capo
+    this.stringPitches.push(pitch)
+  }
   if (this.capo > 0) {
     this.capoTuning = buildCapo(this);
   }

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

@@ -1,3 +1,5 @@
+var {noteToMidi, midiToNote} = require('../../synth/note-to-midi');
+
 /**
  * 
  * Note structure for Tabs
@@ -6,9 +8,12 @@
 var notes = ['A', 'B', 'C', 'D', 'E', 'F', 'G'];
 
 
-function TabNote(note) {
+function TabNote(note, clefTranspose) {
+  var pitch = noteToMidi(note)
+  if (clefTranspose)
+    pitch += clefTranspose
+  var newNote = midiToNote(pitch);
   var isFlat = false;
-  var newNote = note;
   var isSharp = false;
   var isAltered = false;
   var natural = null;
@@ -54,9 +59,11 @@ function TabNote(note) {
       newNote = note.slice(1);
     }
   }
-  var hasComma = (note.match(/,/g) || []).length;
-  var hasQuote = (note.match(/'/g) || []).length;
+  var hasComma = (newNote.match(/,/g) || []).length;
+  var hasQuote = (newNote.match(/'/g) || []).length;
 
+  this.pitch = pitch
+  this.pitchAltered = 0
   this.name = newNote;
   this.acc = acc;
   this.isSharp = isSharp;
@@ -76,6 +83,7 @@ function TabNote(note) {
 function cloneNote(self) {
   var newNote = self.name;
   var newTabNote = new TabNote(newNote);
+  newTabNote.pitch = self.pitch;
   newTabNote.hasComma = self.hasComma;
   newTabNote.isLower = self.isLower;
   newTabNote.isQuoted = self.isQuoted;
@@ -86,33 +94,11 @@ function cloneNote(self) {
   return newTabNote;
 } 
 TabNote.prototype.sameNoteAs = function (note) {
-  if ((this.name == note.name) &&
-    (this.hasComma == note.hasComma) &&
-    (this.isLower == note.isLower) &&
-    (this.isQuoted == note.isQuoted) &&
-    (this.isSharp == note.isSharp) &&
-    (this.isFlat == note.isFlat)) {
-    return true;
-  } else {
-    return false;
-  }
+  return note.pitch === this.pitch
 };
 
 TabNote.prototype.isLowerThan = function (note) {
-  var noteComparator = ['C','D','E','F','G','A','B'];
-  if (this.hasComma > note.hasComma) return true;
-  if (note.hasComma > this.hasComma) return false;
-  if (this.isQuoted > note.isQuoted) return false;
-  if (note.isQuoted > this.isQuoted) return true;
-  if (this.isLower) {
-    if (!note.isLower) return false;
-  } else {
-    if (note.isLower) return true;
-  }
-  var noteName = note.name[0].toUpperCase();
-  var thisName = this.name[0].toUpperCase();
-  if (noteComparator.indexOf(thisName) < noteComparator.indexOf(noteName)) return true;
-  return false;
+  return note.pitch > this.pitch
 };
 
 TabNote.prototype.checkKeyAccidentals = function(accidentals, measureAccidentals) {
@@ -120,14 +106,13 @@ TabNote.prototype.checkKeyAccidentals = function(accidentals, measureAccidentals
     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;
+      case "__": this.acc = -2; this.pitchAltered = -2; return;
+      case "_": this.acc = -1; this.pitchAltered = -1; return;
+      case "=": this.acc = 0; this.pitchAltered = 0; return;
+      case "^": this.acc = 1; this.pitchAltered = 1; return;
+      case "^^": this.acc = 2; this.pitchAltered = 2; return;
     }
-  }  
-  if (accidentals) {
+  } else if (accidentals) {
     var curNote = this.name;
     for (var iii = 0; iii < accidentals.length; iii++) {
       var curAccidentals = accidentals[iii];
@@ -135,10 +120,12 @@ TabNote.prototype.checkKeyAccidentals = function(accidentals, measureAccidentals
         if (curAccidentals.acc == 'flat') {
           this.acc = -1;
           this.isKeyFlat = true;
+          this.pitchAltered = -1
         }
         if (curAccidentals.acc == 'sharp') {
           this.acc = +1;
           this.isKeySharp = true;
+          this.pitchAltered = 1
         }
       }
     }
@@ -163,77 +150,13 @@ TabNote.prototype.getAccidentalEquiv = function () {
 
 
 TabNote.prototype.nextNote = function () {
-  var newTabNote = cloneNote(this);
-
-  if (!this.isSharp && !this.isKeySharp ) {
-    if (this.name != 'E' && this.name != 'B') {
-      newTabNote.isSharp = true;
-      return newTabNote;
-    }
-  } else {
-    // cleanup
-    newTabNote.isSharp = false; 
-    newTabNote.isKeySharp = false; 
-  }
-  var noteIndex = notes.indexOf(this.name);
-  if (noteIndex == notes.length - 1) {
-    noteIndex = 0;
-  } else {
-    noteIndex++;
-  }
-  newTabNote.name = notes[noteIndex];
-  if (newTabNote.name == 'C') {
-    if (newTabNote.hasComma > 0) {
-      newTabNote.hasComma--;
-    } else {
-      if (!newTabNote.isLower) {
-        newTabNote.isLower = true;
-      } else {
-        newTabNote.isQuoted = true;
-      }
-    }
-  }
-  return newTabNote;
+  var note = midiToNote(this.pitch+1+this.pitchAltered)
+  return new TabNote(note)
 };
 
 TabNote.prototype.prevNote = function () {
-  var newTabNote = cloneNote(this);
-
-  if (this.isSharp) {
-    newTabNote.isSharp = false;
-    return newTabNote;
-  }
-  var noteIndex = notes.indexOf(this.name);
-  if (noteIndex == 0) {
-    noteIndex = notes.length - 1;
-  } else {
-    noteIndex--;
-  }
-  newTabNote.name = notes[noteIndex];
-  if (newTabNote.name == 'B') {
-    if (newTabNote.isLower) {
-      newTabNote.hasComma = 1;
-    } else {
-      if (newTabNote.hasComma > 0) {
-        newTabNote.hasComma++;
-      } else {
-        if (newTabNote.isQuoted > 0) {
-          newTabNote.isQuoted -= 1;
-        } else {
-          newTabNote.isLower = true;
-        }
-      }
-    }
-  }
-  if (this.isFlat) {
-    newTabNote.isFlat = false;
-    return newTabNote;
-  } else {
-    if (this.name != 'E' && this.name != 'B') {
-      newTabNote.isSharp = true;
-    }
-  }
-  return newTabNote;
+  var note = midiToNote(this.pitch-1+this.pitchAltered)
+  return new TabNote(note)
 };
 
 TabNote.prototype.emitNoAccidentals = function (  ) {

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

@@ -3,7 +3,6 @@ var StringTablature = require('../string-tablature');
 var TabCommon = require('../../tab-common');
 var TabRenderer = require('../../tab-renderer');
 var ViolinPatterns = require('./violin-patterns');
-var setViolinFonts = require('./violin-fonts');
 
 
 /**
@@ -30,7 +29,6 @@ Plugin.prototype.init = function (abcTune, tuneNumber, params) {
 Plugin.prototype.render = function (renderer, line, staffIndex) {
   if (this._super.inError) return;
   if (this.tablature.bypass(line)) return;
-  setViolinFonts(this.abcTune);
   var rndrer = new TabRenderer(this, renderer, line, staffIndex);
   rndrer.doLayout();
 };

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

@@ -1,9 +1,8 @@
 /**
  * Tablature Absolute elements factory
  */
-var AbsoluteElement = require('../write/abc_absolute_element');
-var RelativeElement = require('../write/abc_relative_element');
-var Transposer = require('./transposer');
+var AbsoluteElement = require('../write/creation/elements/absolute-element');
+var RelativeElement = require('../write/creation/elements/relative-element');
 
 function isObject(a) { return a != null && a.constructor === Object; }
 function cloneObject(dest, src) {
@@ -144,20 +143,6 @@ function graceInRest( absElem ) {
   return null;
 }
 
-function checkTransposition(plugin, transposer ,pitches, graceNotes) {
-  if (plugin.transpose) {
-    //transposer.transpose(plugin.transpose);
-    for (var jj = 0; jj < pitches.length; jj++) {
-      pitches[jj] = transposer.transposeNote(pitches[jj]);
-    }
-    if (graceNotes) {
-      for (var kk = 0; kk < graceNotes.length; kk++) {
-        graceNotes[kk] = transposer.transposeNote(graceNotes[kk]);
-      }
-    }
-  }
-}
-
 function convertToNumber(plugin, pitches, graceNotes) {
   var tabPos = plugin.semantics.notesToNumber(pitches, graceNotes);
   if (tabPos.error) {
@@ -196,7 +181,6 @@ TabAbsoluteElements.prototype.build = function (plugin,
   var staffSize = getInitialStaffSize(staffAbsolute);
   var source = staffAbsolute[staffIndex+voiceIndex];
   var dest = staffAbsolute[staffSize+staffIndex+voiceIndex];
-  var transposer = null;
   var tabPos = null;
   var defNote = null;
   if (source.children[0].abcelem.el_type != 'clef') {
@@ -214,18 +198,14 @@ TabAbsoluteElements.prototype.build = function (plugin,
     // }
     if ( (absChild.isClef) ) {
       dest.children.push(buildTabAbsolute(plugin, absX, relX));
+      if (absChild.abcelem.type.indexOf('-8') >= 0) plugin.semantics.strings.clefTranspose = -12
+      if (absChild.abcelem.type.indexOf('+8') >= 0) plugin.semantics.strings.clefTranspose = 12
     }
     switch (absChild.type) {
       case 'staff-extra key-signature':
         // refresh key accidentals
         this.accidentals = absChild.abcelem.accidentals;
         plugin.semantics.strings.accidentals = this.accidentals;
-        if (plugin.transpose) {
-          transposer = new Transposer(
-            absChild.abcelem.accidentals,
-            plugin.transpose 
-          );
-        }
         break;
       case 'bar':
         plugin.semantics.strings.measureAccidentals = {}
@@ -258,8 +238,6 @@ TabAbsoluteElements.prototype.build = function (plugin,
       case 'rest':
         var restGraces = graceInRest(absChild);
         if (restGraces) {
-          // check transpose
-          checkTransposition(plugin, transposer, null, restGraces);
           // to number conversion 
           tabPos = convertToNumber(plugin, null, restGraces);
           if (tabPos.error) return;
@@ -274,9 +252,7 @@ TabAbsoluteElements.prototype.build = function (plugin,
         abs.lyricDim = lyricsDim(absChild);
         var pitches = absChild.abcelem.pitches;
         var graceNotes = absChild.abcelem.gracenotes;
-        // check transpose
         abs.type = 'tabNumber';
-        checkTransposition(plugin, transposer, pitches, graceNotes);
         // to number conversion 
         tabPos = convertToNumber(plugin, pitches, graceNotes);   
         if (tabPos.error) return;
@@ -302,9 +278,11 @@ TabAbsoluteElements.prototype.build = function (plugin,
           var tabNoteRelative = buildRelativeTabNote(plugin, abs.x+absChild.heads[ll].dx, defNote, curNote, false);
           abs.children.push(tabNoteRelative);
         }
-        defNote.abselem = abs;
-        tabVoice.push(defNote);
-        dest.children.push(abs);
+        if (defNote.notes.length > 0) {
+          defNote.abselem = abs;
+          tabVoice.push(defNote);
+          dest.children.push(abs);
+        }
         break;
     }
   }

package/src/tablatures/tab-renderer.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-debugger */
-var VoiceElement = require('../write/abc_voice_element');
+var VoiceElement = require('../write/creation/elements/voice-element');
 var TabAbsoluteElements = require('./tab-absolute-elements');
-var spacing = require('../write/abc_spacing');
+var spacing = require('../write/helpers/spacing');
 
 function initSpecialY() {
   return {

package/src/test/abc_parser_lint.js

@@ -318,7 +318,7 @@ var ParserLint = function() {
 	var midiProperties = {
 		cmd: { type: 'string', Enum: [
 			"nobarlines", "barlines", "beataccents", "nobeataccents", "droneon", "droneoff", "noportamento", "channel", "c",
-			"drumon", "drumoff", "fermatafixed", "fermataproportional", "gchordon", "gchordoff", "bassvol", "chordvol",
+			"drumon", "drumoff", "fermatafixed", "fermataproportional", "gchordon", "gchordoff", "bassvol", "chordvol", "bassprog", "chordprog",
 			"controlcombo", "temperamentnormal", "gchord", "ptstress", "beatmod", "deltaloudness", "drumbars", "pitchbend",
 			"gracedivider", "makechordchannels", "randomchordattack", "chordattack", "stressmodel", "transpose",
 			"rtranspose", "volinc", "program", "ratio", "snt", "bendvelocity", "control", "temperamentlinear", "beat", "beatstring",
@@ -335,6 +335,7 @@ var ParserLint = function() {
 		field: "el_type",
 		types: [
 			{ value: "clef", properties: appendPositioning(clefProperties) },
+			{ value: "color", properties: { color: {type: "string", optional: true } } },
 			{ value: "bar", properties: prependPositioning(barProperties) },
 			{ value: "gap", properties: { type: "number", optional: true } },	// staffbreak
 			{ value: "key", properties: appendPositioning(keyProperties) },
@@ -462,9 +463,11 @@ var ParserLint = function() {
 			infospace: { type: "number", optional: true },
 //					landscape: { type: "boolean", optional: true },
 			jazzchords: { type: "boolean", optional: true },
+			germanAlphabet: { type: "boolean", optional: true },
 			leftmargin: { type: "number", optional: true },
 			linesep: { type: "number", optional: true },
 			lineskipfac: { type: "number", optional: true },
+			lineThickness: { type: "number", optional: true },
 			map: { type: "string", optional: true },
 			maxshrink: { type: "number", optional: true },
 			maxstaffsep: { type: "number", optional: true },
@@ -741,14 +744,14 @@ var ParserLint = function() {
 	this.lint = function(tune, warnings) {
 		var ret = JSONSchema.validate(tune, musicSchema);
 		var err = "";
-		parseCommon.each(ret.errors, function(e) {
+		ret.errors.forEach(function(e) {
 			err += e.property + ": " + e.message + "\n";
 		});
 		var out = ret.output.join("\n");
 
 		var warn = warnings === undefined ? "No errors" : warnings.join('\n');
-		warn = parseCommon.gsub(warn, '<span style="text-decoration:underline;font-size:1.3em;font-weight:bold;">', '$$$$');
-		warn = parseCommon.gsub(warn, '</span>', '$$$$');
+		warn = warn.replace(/<span style="text-decoration:underline;font-size:1.3em;font-weight:bold;">/g, '$$$$$$$$');
+		warn = warn.replace(/<\/span>/g, '$$$$$$$$');
 		return "Error:------\n" + err + "\nObj:-------\n" + out + "\nWarn:------\n" + warn;
 	};
 };

package/src/write/README.md

@@ -0,0 +1,31 @@
+# Architecture of the engraver
+
+The engraver code is handled here. This accepts the output of the parser and does three things:
+
+* Creates an SVG
+* Adds data to the parser input
+* Makes the visual elements interactive
+
+## Steps
+
+There are separate passes and sub-passes to the processing. The separate passes match the subfolder organization here.
+
+They are:
+
+### Element Creation
+
+The structure passed in from the parser is traversed and all elements are created. An element consists of two parts:
+
+* The Absolute Element: a visual piece of music that is always moved together. For instance, in the key signature of D, the absolute element is an object that contains two sharp symbols. The absolute element has an X- and Y- position in the SVG, and an array of Relative Elements.
+
+* Relative Element: These are always attached to an absolute element. They have a relative position to the absolute element and consist of all the glyphs needed. For instance, a dotted eighth note of Bb that is trilled is an absolute element that contains an array of relative elements consisting of a trill, a flat sign, a filled note head, a stem, a flag, and a dot.
+
+Each of these elements is a separate object, created with `new` and placed in the structure passed in from the parser.
+
+### Layout
+
+After all the elements are created the size of all of them are known, so the layout process begins. There are separate layout algorithms for the horizontal and the vertical positioning. 
+
+### Drawing
+
+After the layout is finished, it is a rote process to draw the music. All decisions have been made. The structure is then traversed and each element is created in the SVG.