abcjs 6.0.0-beta.9 → 6.0.2

package/src/write/abc_create_note_head.js

@@ -0,0 +1,107 @@
+var glyphs = require('./abc_glyphs');
+var RelativeElement = require('./abc_relative_element');
+
+var createNoteHead = function(abselem, c, pitchelem, options) {
+	if (!options) options = {};
+	var dir = (options.dir !== undefined) ? options.dir : null;
+	var headx = (options.headx !== undefined) ? options.headx : 0;
+	var extrax = (options.extrax !== undefined) ? options.extrax : 0;
+	var flag = (options.flag !== undefined) ? options.flag : null;
+	var dot = (options.dot !== undefined) ? options.dot : 0;
+	var dotshiftx = (options.dotshiftx !== undefined) ? options.dotshiftx : 0;
+	var scale = (options.scale !== undefined) ? options.scale : 1;
+	var accidentalSlot = (options.accidentalSlot !== undefined) ? options.accidentalSlot : [];
+	var shouldExtendStem = (options.shouldExtendStem !== undefined) ? options.shouldExtendStem : false;
+	var printAccidentals = (options.printAccidentals !== undefined) ? options.printAccidentals : true;
+
+		// TODO scale the dot as well
+		var pitch = pitchelem.verticalPos;
+		var notehead;
+		var accidentalshiftx = 0;
+		var newDotShiftX = 0;
+		var extraLeft = 0;
+		if (c === undefined)
+			abselem.addFixed(new RelativeElement("pitch is undefined", 0, 0, 0, {type:"debug"}));
+		else if (c==="") {
+			notehead = new RelativeElement(null, 0, 0, pitch);
+		} else {
+			var shiftheadx = headx;
+			if (pitchelem.printer_shift) {
+				var adjust = (pitchelem.printer_shift==="same")?1:0;
+				shiftheadx = (dir==="down")?-glyphs.getSymbolWidth(c)*scale+adjust:glyphs.getSymbolWidth(c)*scale-adjust;
+			}
+			var opts = {scalex:scale, scaley: scale, thickness: glyphs.symbolHeightInPitches(c)*scale, name: pitchelem.name };
+			notehead = new RelativeElement(c, shiftheadx, glyphs.getSymbolWidth(c)*scale, pitch, opts);
+			notehead.stemDir = dir;
+			if (flag) {
+				var pos = pitch+((dir==="down")?-7:7)*scale;
+				// if this is a regular note, (not grace or tempo indicator) then the stem will have been stretched to the middle line if it is far from the center.
+				if (shouldExtendStem) {
+					if (dir==="down" && pos > 6)
+						pos = 6;
+					if (dir==="up" && pos < 6)
+						pos = 6;
+				}
+				//if (scale===1 && (dir==="down")?(pos>6):(pos<6)) pos=6;
+				var xdelta = (dir==="down")?headx:headx+notehead.w-0.6;
+				abselem.addRight(new RelativeElement(flag, xdelta, glyphs.getSymbolWidth(flag)*scale, pos, {scalex:scale, scaley: scale}));
+			}
+			newDotShiftX = notehead.w+dotshiftx-2+5*dot;
+			for (;dot>0;dot--) {
+				var dotadjusty = (1-Math.abs(pitch)%2); //PER: take abs value of the pitch. And the shift still happens on ledger lines.
+				abselem.addRight(new RelativeElement("dots.dot", notehead.w+dotshiftx-2+5*dot, glyphs.getSymbolWidth("dots.dot"), pitch+dotadjusty));
+			}
+		}
+		if (notehead)
+			notehead.highestVert = pitchelem.highestVert;
+
+		if (printAccidentals && pitchelem.accidental) {
+			var symb;
+			switch (pitchelem.accidental) {
+				case "quartersharp":
+					symb = "accidentals.halfsharp";
+					break;
+				case "dblsharp":
+					symb = "accidentals.dblsharp";
+					break;
+				case "sharp":
+					symb = "accidentals.sharp";
+					break;
+				case "quarterflat":
+					symb = "accidentals.halfflat";
+					break;
+				case "flat":
+					symb = "accidentals.flat";
+					break;
+				case "dblflat":
+					symb = "accidentals.dblflat";
+					break;
+				case "natural":
+					symb = "accidentals.nat";
+			}
+			// if a note is at least a sixth away, it can share a slot with another accidental
+			var accSlotFound = false;
+			var accPlace = extrax;
+			for (var j = 0; j < accidentalSlot.length; j++) {
+				if (pitch - accidentalSlot[j][0] >= 6) {
+					accidentalSlot[j][0] = pitch;
+					accPlace = accidentalSlot[j][1];
+					accSlotFound = true;
+					break;
+				}
+			}
+			if (accSlotFound === false) {
+				accPlace -= (glyphs.getSymbolWidth(symb)*scale+2);
+				accidentalSlot.push([pitch,accPlace]);
+				accidentalshiftx = (glyphs.getSymbolWidth(symb)*scale+2);
+			}
+			var h = glyphs.symbolHeightInPitches(symb);
+			abselem.addExtra(new RelativeElement(symb, accPlace, glyphs.getSymbolWidth(symb), pitch, {scalex:scale, scaley: scale, top: pitch+h/2, bottom: pitch-h/2}));
+			extraLeft = glyphs.getSymbolWidth(symb) / 2; // TODO-PER: We need a little extra width if there is an accidental, but I'm not sure why it isn't the full width of the accidental.
+		}
+
+		return { notehead: notehead, accidentalshiftx: accidentalshiftx, dotshiftx: newDotShiftX, extraLeft: extraLeft };
+
+	};
+
+module.exports = createNoteHead;

package/src/write/abc_create_time_signature.js

@@ -1,29 +1,11 @@
 //    abc_create_time_signature.js
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) and Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 var AbsoluteElement = require('./abc_absolute_element');
 var glyphs = require('./abc_glyphs');
 var RelativeElement = require('./abc_relative_element');
 
-var createTimeSignature;
-
-(function() {
-	"use strict";
-
-	createTimeSignature = function(elem, tuneNumber) {
+var createTimeSignature = function(elem, tuneNumber) {
+		elem.el_type = "timeSignature";
 		var abselem = new AbsoluteElement(elem,0,10, 'staff-extra time-signature', tuneNumber);
 		if (elem.type === "specified") {
 			var x = 0;
@@ -69,6 +51,5 @@ var createTimeSignature;
 		}
 		return abselem;
 	};
-})();
 
 module.exports = createTimeSignature;

package/src/write/abc_crescendo_element.js

@@ -1,62 +1,15 @@
 //    abc_crescendo_element.js: Definition of the CrescendoElem class.
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) and Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-var sprintf = require('./sprintf');
 
 var CrescendoElem = function CrescendoElem(anchor1, anchor2, dir, positioning) {
+	this.type = "CrescendoElem";
 	this.anchor1 = anchor1; // must have a .x and a .parent property or be null (means starts at the "beginning" of the line - after keysig)
 	this.anchor2 = anchor2; // must have a .x property or be null (means ends at the end of the line)
 	this.dir = dir; // either "<" or ">"
 	if (positioning === 'above')
-		this.dynamicHeightAbove = 4;
+		this.dynamicHeightAbove = 6;
 	else
-		this.dynamicHeightBelow = 4;
+		this.dynamicHeightBelow = 6;
 	this.pitch = undefined; // This will be set later
 };
 
-CrescendoElem.prototype.setUpperAndLowerElements = function(positionY) {
-	if (this.dynamicHeightAbove)
-		this.pitch = positionY.dynamicHeightAbove;
-	else
-		this.pitch = positionY.dynamicHeightBelow;
-};
-
-CrescendoElem.prototype.draw = function (renderer) {
-	if (this.pitch === undefined)
-		window.console.error("Crescendo Element y-coordinate not set.");
-	var y = renderer.calcY(this.pitch) + 4; // This is the top pixel to use (it is offset a little so that it looks good with the volume marks.)
-	var height = 8;
-	if (this.dir === "<") {
-		this.drawLine(renderer, y+height/2, y, y+height/2, y+height);
-	} else {
-		this.drawLine(renderer, y, y+height/2, y+height, y+height/2);
-	}
-};
-
-CrescendoElem.prototype.drawLine = function (renderer, y1, y2, y3, y4) {
-	// TODO-PER: This is just a quick hack to make the dynamic marks not crash if they are mismatched. See the slur treatment for the way to get the beginning and end.
-	var left = this.anchor1 ? this.anchor1.x : 0;
-	var right = this.anchor2 ? this.anchor2.x : 800;
-
-	var type = this.dir === "<" ? "crescendo" : "diminuendo";
-	var pathString = sprintf("M %f %f L %f %f M %f %f L %f %f",
-		left, y1, right, y2, left, y3, right, y4);
-	renderer.controller.currentAbsEl = { tuneNumber: renderer.controller.engraver.tuneNumber, elemset: [], abcelem: { el_type: type, startChar: -1, endChar: -1 }};
-	var el = renderer.printPath({path:pathString, stroke:"#000000", 'class': renderer.addClasses('dynamics decoration')});
-	renderer.controller.currentAbsEl.elemset.push(el);
-};
-
 module.exports = CrescendoElem;

package/src/write/abc_decoration.js

@@ -1,20 +1,4 @@
 // abc_decoration.js: Creates a data structure suitable for printing a line of abc
-// Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) & Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-/*global window */
 
 var DynamicDecoration = require('./abc_dynamic_decoration');
 var CrescendoElem = require('./abc_crescendo_element');
@@ -22,12 +6,7 @@ var glyphs = require('./abc_glyphs');
 var RelativeElement = require('./abc_relative_element');
 var TieElem = require('./abc_tie_element');
 
-var Decoration;
-
-(function() {
-	"use strict";
-
-	Decoration = function Decoration() {
+var Decoration = function Decoration() {
 		this.startDiminuendoX = undefined;
 		this.startCrescendoX = undefined;
 		this.minTop = 12;	// TODO-PER: this is assuming a 5-line staff. Pass that info in.
@@ -66,15 +45,15 @@ var Decoration;
 				if (glyphs.getSymbolAlign(symbol)!=="center") {
 					deltaX -= (glyphs.getSymbolWidth(symbol)/2);
 				}
-				abselem.addChild(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), yPos));
+				abselem.addFixedX(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), yPos));
 			}
 			if (decoration[i]==="slide" && abselem.heads[0]) {
 				var yPos2 = abselem.heads[0].pitch;
 				yPos2 -= 2; // TODO-PER: not sure what this fudge factor is.
 				var blank1 = new RelativeElement("", -roomtaken-15, 0, yPos2-1);
 				var blank2 = new RelativeElement("", -roomtaken-5, 0, yPos2+1);
-				abselem.addChild(blank1);
-				abselem.addChild(blank2);
+				abselem.addFixedX(blank1);
+				abselem.addFixedX(blank2);
 				voice.addOther(new TieElem({ anchor1: blank1, anchor2: blank2, fixedY: true}));
 			}
 		}
@@ -129,7 +108,7 @@ var Decoration;
 			deltaX += (dir === 'down') ? -5 : 3;
 			for (var i = 0; i < count; i++) {
 				placement -= 1;
-				abselem.addChild(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), placement));
+				abselem.addFixedX(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), placement));
 			}
 		}
 
@@ -168,7 +147,7 @@ var Decoration;
 			var textFudge = 2;
 			var textHeight = 5;
 			// TODO-PER: Get the height of the current font and use that for the thickness.
-			abselem.addChild(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}));
 
 			incrementPlacement(placement, textHeight);
 		}
@@ -180,7 +159,7 @@ var Decoration;
 			var height = glyphs.symbolHeightInPitches(symbol) + 1; // adding a little padding so nothing touches.
 			var y = getPlacement(placement);
 			y = (placement === 'above') ? y + height/2 : y - height/2;// Center the element vertically.
-			abselem.addChild(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), y, { klass: 'ornament', thickness: glyphs.symbolHeightInPitches(symbol) }));
+			abselem.addFixedX(new RelativeElement(symbol, deltaX, glyphs.getSymbolWidth(symbol), y, { klass: 'ornament', thickness: glyphs.symbolHeightInPitches(symbol) }));
 
 			incrementPlacement(placement, height);
 		}
@@ -346,6 +325,4 @@ var Decoration;
 		leftDecoration(decoration, abselem, roomtaken);
 	};
 
-})();
-
 module.exports = Decoration;

package/src/write/abc_dynamic_decoration.js

@@ -1,48 +1,14 @@
 //    abc_dynamic_decoration.js: Definition of the DynamicDecoration class.
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) and Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-var spacing = require('./abc_spacing');
 
 var DynamicDecoration = function DynamicDecoration(anchor, dec, position) {
+	this.type = "DynamicDecoration";
 	this.anchor = anchor;
 	this.dec = dec;
 	if (position === 'below')
-		this.volumeHeightBelow = 5;
+		this.volumeHeightBelow = 6;
 	else
-		this.volumeHeightAbove = 5;
+		this.volumeHeightAbove = 6;
 	this.pitch = undefined; // This will be set later
 };
 
-DynamicDecoration.prototype.setUpperAndLowerElements = function(positionY) {
-	if (this.volumeHeightAbove)
-		this.pitch = positionY.volumeHeightAbove;
-	else
-		this.pitch = positionY.volumeHeightBelow;
-};
-
-DynamicDecoration.prototype.draw = function(renderer) {
-	if (this.pitch === undefined)
-		window.console.error("Dynamic Element y-coordinate not set.");
-	var scalex = 1;
-	var scaley = 1;
-	var self = this;
-	var ret = renderer.wrapInAbsElem({el_type: "dynamic-decoration", startChar: -1, endChar: -1, decoration: this.dec}, 'abcjs-decoration', function () {
-		var el = renderer.printSymbol(self.anchor.x, self.pitch, self.dec, scalex, scaley, renderer.addClasses('decoration'));
-		return el;
-	});
-};
-
 module.exports = DynamicDecoration;

package/src/write/abc_ending_element.js

@@ -1,22 +1,7 @@
 //    abc_ending_element.js: Definition of the EndingElement class.
-//    Copyright (C) 2010-2020 Gregory Dyke (gregdyke at gmail dot com) and Paul Rosen
-//
-//    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
-//    documentation files (the "Software"), to deal in the Software without restriction, including without limitation
-//    the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
-//    to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-//
-//    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-//
-//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
-//    BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-//    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-//    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-var sprintf = require('./sprintf');
 
 var EndingElem = function EndingElem(text, anchor1, anchor2) {
+	this.type = "EndingElem";
 	this.text = text; // text to be displayed top left
 	this.anchor1 = anchor1; // must have a .x property or be null (means starts at the "beginning" of the line - after keysig)
 	this.anchor2 = anchor2; // must have a .x property or be null (means ends at the end of the line)
@@ -24,45 +9,4 @@ var EndingElem = function EndingElem(text, anchor1, anchor2) {
 	this.pitch = undefined; // This will be set later
 };
 
-EndingElem.prototype.setUpperAndLowerElements = function(positionY) {
-	this.pitch = positionY.endingHeightAbove - 2;
-};
-
-EndingElem.prototype.draw = function (renderer, linestartx, lineendx) {
-	if (this.pitch === undefined)
-		window.console.error("Ending Element y-coordinate not set.");
-	var y = renderer.calcY(this.pitch);
-	var height = 20;
-	var pathString = '';
-
-	if (this.anchor1) {
-		linestartx = this.anchor1.x+this.anchor1.w;
-		pathString += sprintf("M %f %f L %f %f ",
-			linestartx, y, linestartx, y+height);
-	}
-
-	if (this.anchor2) {
-		lineendx = this.anchor2.x;
-		pathString += sprintf("M %f %f L %f %f ",
-			lineendx, y, lineendx, y+height);
-	}
-
-	pathString += sprintf("M %f %f L %f %f ",
-		linestartx, y, lineendx, y);
-
-	var self = this;
-	var g;
-	var ret = renderer.wrapInAbsElem({el_type: "ending", startChar: -1, endChar: -1}, 'abcjs-ending', function () {
-
-		renderer.createElemSet({klass: renderer.addClasses("ending")});
-		renderer.printPath({path: pathString, stroke: "#000000", fill: "#000000"}, { history: 'ignore'});
-		if (self.anchor1)
-			renderer.renderText({x: linestartx + 5, y: renderer.calcY(self.pitch - 0.5), text: self.text, type: 'repeatfont', klass: 'ending', anchor: "start", noClass: true, history: 'ignore'});
-		g = renderer.closeElemSet();
-		renderer.controller.recordHistory(g, false);
-		return g;
-	});
-	return g;
-};
-
 module.exports = EndingElem;