abcjs 6.0.3 → 6.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "abcjs",
-  "version": "6.0.3",
+  "version": "6.0.4",
   "description": "Renderer for abc music notation",
   "main": "index.js",
   "types": "types/index.d.ts",

package/src/parse/abc_parse.js

@@ -224,6 +224,7 @@ var Parse = function() {
 		var replace = false;
 		var addWord = function(i) {
 			var word = parseCommon.strip(words.substring(last_divider, i));
+			word = word.replace(/\\([-_*|~])/g, '$1')
 			last_divider = i+1;
 			if (word.length > 0) {
 				if (replace)
@@ -237,34 +238,44 @@ var Parse = function() {
 			}
 			return false;
 		};
+		var escNext = false;
 		for (var i = 0; i < words.length; i++) {
-			switch (words.charAt(i)) {
+			switch (words[i]) {
 				case ' ':
 				case '\x12':
 					addWord(i);
 					break;
 				case '-':
-					if (!addWord(i) && word_list.length > 0) {
+					if (!escNext && !addWord(i) && word_list.length > 0) {
 						parseCommon.last(word_list).divider = '-';
 						word_list.push({skip: true, to: 'next'});
 					}
 					break;
 				case '_':
-					addWord(i);
-					word_list.push({skip: true, to: 'slur'});
+					if (!escNext) {
+						addWord(i);
+						word_list.push({skip: true, to: 'slur'});
+					}
 					break;
 				case '*':
-					addWord(i);
-					word_list.push({skip: true, to: 'next'});
+					if (!escNext) {
+						addWord(i);
+						word_list.push({skip: true, to: 'next'});
+					}
 					break;
 				case '|':
-					addWord(i);
-					word_list.push({skip: true, to: 'bar'});
+					if (!escNext) {
+						addWord(i);
+						word_list.push({skip: true, to: 'bar'});
+					}
 					break;
 				case '~':
-					replace = true;
+					if (!escNext) {
+						replace = true;
+					}
 					break;
 			}
+			escNext = words[i] === '\\'
 		}
 
 		var inSlur = false;

package/src/parse/abc_parse_music.js

@@ -732,7 +732,7 @@ var volumeDecorations = [
 ];
 
 var dynamicDecorations = [
-	"crescendo(", "crescendo)", "diminuendo(", "diminuendo)"
+	"crescendo(", "crescendo)", "diminuendo(", "diminuendo)", "glissando(", "glissando)"
 ];
 
 var accentPseudonyms = [

package/src/synth/abc_midi_flattener.js

@@ -630,7 +630,7 @@ var pitchesToPerc = require('./pitches-to-perc');
 					if (name && percmap[name])
 						actualPitch = percmap[name].sound;
 				}
-				var p = { cmd: 'note', pitch: actualPitch, volume: velocity, start: timeToRealTime(elem.time), duration: durationRounded(note.duration), instrument: currentInstrument };
+				var p = { cmd: 'note', pitch: actualPitch, volume: velocity, start: timeToRealTime(elem.time), duration: durationRounded(note.duration), instrument: currentInstrument, startChar: elem.elem.startChar, endChar: elem.elem.endChar};
 				p = adjustForMicroTone(p);
 				if (elem.gracenotes) {
 					p.duration = p.duration / 2;

package/src/synth/create-note-map.js

@@ -29,6 +29,10 @@ var createNoteMap = function(sequence) {
 							end: Math.round((ev.start + len - gap) * 1000000)/1000000,
 							volume: ev.volume
 						};
+						if (ev.startChar)
+							obj.startChar = ev.startChar;
+						if (ev.endChar)
+							obj.endChar = ev.endChar;
 						if (ev.style)
 							obj.style = ev.style;
 						if (ev.cents)

package/src/test/abc_parser_lint.js

@@ -57,7 +57,7 @@ var ParserLint = function() {
 		"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)",
+		"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",

package/src/write/abc_abstract_engraver.js

@@ -390,6 +390,13 @@ AbstractEngraver.prototype.createABCElement = function(isFirstStaff, isSingleLin
 		var beamelem = new BeamElem(this.stemHeight * this.voiceScale, this.stemdir, this.flatBeams, elems[0]);
 		if (hint) beamelem.setHint();
 		for (var i = 0; i < elems.length; i++) {
+			// Do a first pass to figure out the stem direction before creating the notes, so that staccatos and other decorations can be placed correctly.
+			beamelem.runningDirection(elems[i])
+		}
+		beamelem.setStemDirection()
+		var tempStemDir = this.stemdir
+		this.stemdir = beamelem.stemsUp ? 'up' : 'down'
+		for (i = 0; i < elems.length; i++) {
 			var elem = elems[i];
 			var abselem = this.createNote(elem, true, isSingleLineStaff, voice);
 			abselemset.push(abselem);
@@ -402,6 +409,7 @@ AbstractEngraver.prototype.createABCElement = function(isFirstStaff, isSingleLin
 		}
 		beamelem.calcDir();
 		voice.addBeam(beamelem);
+		this.stemdir = tempStemDir
 		return abselemset;
 	};
 
@@ -1004,6 +1012,10 @@ AbstractEngraver.prototype.createBarLine = function (voice, elem, isFirstStaff)
   // Add a little space to the left of the bar line so that nothing can crowd it.
 	abselem.extraw -= 5;
 
+	if (elem.chord !== undefined) {
+		var ret3 = addChord(this.getTextSize, abselem, elem, 0, 0, 0, false);
+	}
+
 	return abselem;
 
 };

package/src/write/abc_beam_element.js

@@ -42,6 +42,15 @@ var BeamElem = function BeamElem(stemHeight, type, flat, firstElement) {
 		this.hint = true;
 	};
 
+	BeamElem.prototype.runningDirection = function (abcelem) {
+		var pitch = abcelem.averagepitch;
+		if (pitch === undefined) return; // don't include elements like spacers in beams
+		this.total = Math.round(this.total+pitch);
+		if (!this.count)
+			this.count = 0;
+		this.count++
+	};
+
 	BeamElem.prototype.add = function(abselem) {
 		var pitch = abselem.abcelem.averagepitch;
 		if (pitch === undefined) return; // don't include elements like spacers in beams
@@ -62,6 +71,21 @@ var BeamElem = function BeamElem(stemHeight, type, flat, firstElement) {
 		this.beams.push(beam);
 	};
 
+	BeamElem.prototype.setStemDirection = function() {
+		// Have to figure this out before the notes are placed because placing the notes also places the decorations.
+		this.average = calcAverage(this.total, this.count);
+		if (this.forceup) {
+			this.stemsUp = true;
+		} else if (this.forcedown) {
+			this.stemsUp = false;
+		} else {
+			var middleLine = 6;	// hardcoded 6 is B
+			this.stemsUp = this.average < middleLine; // true is up, false is down;
+		}
+		delete this.count;
+		this.total = 0;
+	};
+
 	BeamElem.prototype.calcDir = function() {
 		this.average = calcAverage(this.total, this.elems.length);
 		if (this.forceup) {

package/src/write/abc_decoration.js

@@ -2,6 +2,7 @@
 
 var DynamicDecoration = require('./abc_dynamic_decoration');
 var CrescendoElem = require('./abc_crescendo_element');
+var GlissandoElem = require('./abc_glissando_element');
 var glyphs = require('./abc_glyphs');
 var RelativeElement = require('./abc_relative_element');
 var TieElem = require('./abc_tie_element');
@@ -277,6 +278,7 @@ var Decoration = function Decoration() {
 	Decoration.prototype.dynamicDecoration = function(voice, decoration, abselem, positioning) {
 		var diminuendo;
 		var crescendo;
+		var glissando;
 		for (var i=0;i<decoration.length; i++) {
 			switch(decoration[i]) {
 				case "diminuendo(":
@@ -295,6 +297,14 @@ var Decoration = function Decoration() {
 					crescendo = { start: this.startCrescendoX, stop: abselem};
 					this.startCrescendoX = undefined;
 					break;
+				case "glissando(":
+					this.startGlissandoX = abselem;
+					glissando = undefined;
+					break;
+				case "glissando)":
+					glissando = { start: this.startGlissandoX, stop: abselem};
+					this.startGlissandoX = undefined;
+					break;
 			}
 		}
 		if (diminuendo) {
@@ -303,6 +313,9 @@ var Decoration = function Decoration() {
 		if (crescendo) {
 			voice.addOther(new CrescendoElem(crescendo.start, crescendo.stop, "<", positioning));
 		}
+		if (glissando) {
+			voice.addOther(new GlissandoElem(glissando.start, glissando.stop));
+		}
 	};
 
 	Decoration.prototype.createDecoration = function(voice, decoration, pitch, width, abselem, roomtaken, dir, minPitch, positioning, hasVocals) {

package/src/write/abc_glissando_element.js

@@ -0,0 +1,7 @@
+var GlissandoElem = function GlissandoElem(anchor1, anchor2) {
+	this.type = "GlissandoElem";
+	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)
+};
+
+module.exports = GlissandoElem;

package/src/write/draw/glissando.js

@@ -0,0 +1,75 @@
+var sprintf = require('./sprintf');
+var printPath = require('./print-path');
+var roundNumber = require("./round-number");
+
+function drawGlissando(renderer, params, selectables) {
+	if (!params.anchor1 || !params.anchor2 || !params.anchor1.heads || !params.anchor2.heads || params.anchor1.heads.length === 0 || params.anchor2.heads.length === 0)
+		window.console.error("Glissando Element not set.");
+
+	var margin = 4;
+	var leftY = renderer.calcY(params.anchor1.heads[0].pitch)
+	var rightY = renderer.calcY(params.anchor2.heads[0].pitch)
+	var leftX = params.anchor1.x + params.anchor1.w/2
+	var rightX = params.anchor2.x + params.anchor2.w/2
+	var len = lineLength(leftX, leftY, rightX, rightY)
+	var marginLeft = params.anchor1.w/2 + margin
+	var marginRight = params.anchor2.w/2 + margin
+	var s = slope(leftX, leftY, rightX, rightY)
+	var leftYAdj = getY(leftY, s, marginLeft)
+	var rightYAdj = getY(rightY, s, -marginRight)
+	var num = numSquigglies(len-marginLeft-marginRight)
+
+	var el = drawSquiggly(renderer, leftX+marginLeft, leftYAdj, num, s)
+	selectables.wrapSvgEl({el_type: "glissando", startChar: -1, endChar: -1}, el);
+	return [el];
+}
+
+function lineLength(leftX, leftY, rightX, rightY) {
+	// The length from notehead center to notehead center.
+	var w = rightX - leftX
+	var h = rightY - leftY
+	return Math.sqrt(w*w + h*h)
+}
+
+function slope(leftX, leftY, rightX, rightY) {
+	return (rightY-leftY) / (rightX - leftX)
+}
+
+function getY(y, slope, xOfs) {
+	return roundNumber(y + (xOfs)*slope);
+}
+
+function numSquigglies(length) {
+	var endLen = 5; // The width of the end - that is, the non repeating part
+	return Math.max(2, Math.floor((length - endLen*2) / 6));
+}
+
+var leftStart = [[3.5, -4.8]]
+var right = [[1.5, -1], [.3, -.3], [-3.5, 3.8]]
+var leftEnd = [[-1.5, 2]]
+var top = [[3, 4], [3, -4]]
+var bottom = [[-3, 4], [-3, -4]]
+
+function segment(arr, slope) {
+	var ret = "";
+	for (var i = 0; i < arr.length; i++) {
+		ret += 'l' + arr[i][0] + ' ' + getY(arr[i][1], slope, arr[i][0])
+	}
+	return ret
+}
+
+var drawSquiggly = function(renderer, x, y, num, slope) {
+	var p = sprintf("M %f %f", x, y);
+	p += segment(leftStart, slope)
+	var i
+	for (i = 0; i < num; i++) {
+		p+=segment(top, slope)
+	}
+	p += segment(right, slope)
+	for ( i = 0; i < num; i++)
+		p+=segment(bottom, slope)
+	p+=segment(leftEnd, slope) + 'z'
+	return printPath(renderer, {path:p, highlight: "stroke", stroke:renderer.foregroundColor, 'class': renderer.controller.classes.generate('decoration'), "data-name": "glissando"});
+}
+
+module.exports = drawGlissando;

package/src/write/draw/voice.js

@@ -1,3 +1,4 @@
+var drawGlissando = require('./glissando');
 var drawCrescendo = require('./crescendo');
 var drawDynamics = require('./dynamics');
 var drawTriplet = require('./triplet');
@@ -67,6 +68,9 @@ function drawVoice(renderer, params, bartop, selectables, staffPos) {
 			renderer.controller.classes.incrMeasure();
 		} else {
 			switch (child.type) {
+				case "GlissandoElem":
+					child.elemset = drawGlissando(renderer, child, selectables);
+					break;
 				case "CrescendoElem":
 					child.elemset = drawCrescendo(renderer, child, selectables);
 					break;

package/src/write/top-text.js

@@ -32,7 +32,7 @@ function TopText(metaText, metaTextInfo, formatting, lines, width, isPrint, padd
 		this.rows.push({move: spacing.composer});
 		if (metaText.rhythm && metaText.rhythm.length > 0) {
 			var noMove = !!(metaText.composer || metaText.origin);
-			addTextIf(this.rows, { marginLeft: paddingLeft, text: metaText.rhythm, font: 'infofont', klass: 'meta-top rhythm', absElemType: "rhythm", noMove: true, info: metaTextInfo.rhythm, name: "rhythm"}, getTextSize);
+			addTextIf(this.rows, { marginLeft: paddingLeft, text: metaText.rhythm, font: 'infofont', klass: 'meta-top rhythm', absElemType: "rhythm", noMove: noMove, info: metaTextInfo.rhythm, name: "rhythm"}, getTextSize);
 		}
 		var composerLine = "";
 		if (metaText.composer) composerLine += metaText.composer;

package/types/index.d.ts

@@ -64,7 +64,7 @@ declare module 'abcjs' {
 	export type Decorations = "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)" |
+		"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" |
@@ -73,13 +73,13 @@ declare module 'abcjs' {
 	//
 	// Basic types
 	//
-	export type Selector = String | HTMLElement
+	export type Selector = string | HTMLElement
 
 	type NumberFunction = () => number;
 
 	export interface MeterFraction {
-		num: string;
-		den?: string;
+		num: number;
+		den?: number;
 	}
 
 	export interface ClefProperties {
@@ -261,6 +261,8 @@ declare module 'abcjs' {
 		instrument: number;
 		start: number;
 		end: number;
+		startChar: number;
+		endChar: number;
 		volume: number;
 		style?: string;
 		cents?: number;
@@ -904,7 +906,7 @@ declare module 'abcjs' {
 
 	export interface AudioTrack {
 		cmd: AudioTrackCommand;
-		[param: any]; // TODO - make this a union
+		[param: string]: any; // TODO - make this a union
 	}
 
 	export interface AudioTracks {
@@ -1042,7 +1044,7 @@ declare module 'abcjs' {
 
 	export interface SynthObjectController {
 		disable(isDisabled: boolean): void
-		setTune(visualObj: TuneObject, userAction: Boolean, audioParams?: AbcVisualParams): Promise<SynthInitResponse>
+		setTune(visualObj: TuneObject, userAction: boolean, audioParams?: any): Promise<SynthInitResponse>
 		load(selector: string, cursorControl?: any, visualOptions?: SynthVisualOptions): void
 		play(): void
 		pause(): void
@@ -1054,7 +1056,9 @@ declare module 'abcjs' {
 	}
 
 	export interface SynthSequenceClass {
-		// TODO
+		addTrack(): AudioTrack
+		setInstrument(trackNumber: number, instrumentNumber: number): void
+		appendNote(trackNumber: number, pitch: number, durationInMeasures: number, volume: number, cents: number): void
 	}
 
 	export namespace synth {
@@ -1068,7 +1072,7 @@ declare module 'abcjs' {
 		export function registerAudioContext(ac?: AudioContext): boolean
 		export function activeAudioContext(): AudioContext
 		export function CreateSynthControl(element: Selector, options: AbcVisualParams): AudioControl
-		export function getMidiFile(source: String | TuneObject, options?: MidiFileOptions): MidiFile;
+		export function getMidiFile(source: string | TuneObject, options?: MidiFileOptions): MidiFile;
 		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches, milliSecondsPerMeasure: number): Promise<void>;
 		export function sequence(visualObj: TuneObject, options: AbcVisualParams): AudioSequence
 	}

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.0.3';
+var version = '6.0.4';
 
 module.exports = version;

package/temp.txt

@@ -1,16 +0,0 @@
-    Fix unhandled rejection if there is a problem with an input note when creating notes.
-
-    put the height of ties/slurs in the line height calculation
-
-    Add transposition tests.
-
-    Add example of reusing created synth buffers.
-
-    Measurements that used "px" were reporting a warning.
-
-    Add quote to be escaped in chord.
-
-    Fix example in docs on creating a drum rhythm
-
-    Fix bass note in jazz chord when it contains a sharp or flat
-