abcjs 6.2.3 → 6.4.0

package/src/write/layout/staff-group.js

@@ -19,7 +19,7 @@ function checkLastBarX(voices) {
 	}
 }
 
-var layoutStaffGroup = function (spacing, renderer, debug, staffGroup, leftEdge) {
+var layoutStaffGroup = function (spacing, minPadding, debug, staffGroup, leftEdge) {
 	var epsilon = 0.0000001; // Fudging for inexactness of floating point math.
 	var spacingunits = 0; // number of times we will have ended up using the spacing distance (as opposed to fixed width distances)
 	var minspace = 1000; // a big number to start off with - used to find out what the smallest space between two notes is -- GD 2014.1.7
@@ -82,7 +82,7 @@ var layoutStaffGroup = function (spacing, renderer, debug, staffGroup, leftEdge)
 			var topVoice = (lastTopVoice !== undefined && currentvoices[lastTopVoice].voicenumber !== v.voicenumber) ? currentvoices[lastTopVoice] : undefined;
 			if (!isSameStaff(v, topVoice))
 				topVoice = undefined;
-			var voicechildx = layoutVoiceElements.layoutOneItem(x, spacing, v, renderer.minPadding, topVoice);
+			var voicechildx = layoutVoiceElements.layoutOneItem(x, spacing, v, minPadding, topVoice);
 			var dx = voicechildx - x;
 			if (dx > 0) {
 				x = voicechildx; //update x

package/src/write/layout/voice-elements.js

@@ -96,7 +96,7 @@ VoiceElement.shiftRight = function (dx, voice) {
 
 // call when spacingduration has been updated
 VoiceElement.updateNextX = function (x, spacing, voice) {
-	voice.nextx = x + (spacing * Math.sqrt(voice.spacingduration * 8));
+	voice.nextx = x + (spacing * this.getSpacingUnits(voice));
 };
 
 VoiceElement.updateIndices = function (voice) {

package/src/write/layout/voice.js

@@ -36,7 +36,7 @@ function moveDecorations(beam) {
 			var top = yAtNote(child, beam);
 			for (var i = 0; i < child.children.length; i++) {
 				var el = child.children[i];
-				if (el.klass === 'ornament') {
+				if (el.klass === 'ornament' && el.position !== 'below') {
 					if (el.bottom - padding < top) {
 						var distance = top - el.bottom + padding; // Find the distance that it needs to move and add a little margin so the element doesn't touch the beam.
 						el.bottom += distance;

package/src/write/renderer.js

@@ -103,6 +103,7 @@ Renderer.prototype.initVerticalSpace = function () {
 		parts: 11.33, // Set the vertical space above a new part.
 		slurHeight: 1.0, // Set the slur height factor.
 		staffSeparation: 61.33, // Do not put a staff system closer than <unit> from the previous system.
+		staffTopMargin: 0,
 		stemHeight: 26.67 + 10, // Set the stem height.
 		subtitle: 3.78, // Set the vertical space above the subtitle.
 		systemStaffSeparation: 48, // Do not place the staves closer than <unit> inside a system. * This values applies to all staves when in the tune header. Otherwise, it applies to the next staff
@@ -157,6 +158,8 @@ Renderer.prototype.setVerticalSpace = function (formatting) {
 		this.spacing.title = formatting.titlespace * 4 / 3;
 	if (formatting.sysstaffsep !== undefined)
 		this.spacing.systemStaffSeparation = formatting.sysstaffsep * 4 / 3;
+	if (formatting.stafftopmargin !== undefined)
+		this.spacing.staffTopMargin = formatting.stafftopmargin * 4 / 3;
 	if (formatting.subtitlespace !== undefined)
 		this.spacing.subtitle = formatting.subtitlespace * 4 / 3;
 	if (formatting.topspace !== undefined)

package/src/write/svg.js

@@ -211,6 +211,36 @@ Svg.prototype.text = function (text, attr, target) {
 	return el;
 };
 
+Svg.prototype.richTextLine = function (phrases, x, y, klass, anchor, target) {
+	var el = document.createElementNS(svgNS, 'text');
+	el.setAttribute("stroke", "none");
+	el.setAttribute("class", klass);
+	el.setAttribute("x", x);
+	el.setAttribute("y", y);
+	el.setAttribute("text-anchor", anchor);
+	el.setAttribute("dominant-baseline", "middle");
+
+	for (var i = 0; i < phrases.length; i++) {
+		var phrase = phrases[i]
+		var tspan = document.createElementNS(svgNS, 'tspan');
+		var attrs = Object.keys(phrase.attrs)
+		for (var j = 0; j < attrs.length; j++) {
+			var value = phrase.attrs[attrs[j]]
+			if (value !== '')
+				tspan.setAttribute(attrs[j], value)
+		}
+		tspan.textContent = phrase.content;
+
+		el.appendChild(tspan);
+	}
+
+	if (target)
+		target.appendChild(el);
+	else
+		this.append(el);
+	return el;
+}
+
 Svg.prototype.guessWidth = function (text, attr) {
 	var svg = this.createDummySvg();
 	var el = this.text(text, attr, svg);

package/temp.txt

@@ -0,0 +1,3 @@
+
+    
+

package/types/index.d.ts

@@ -48,14 +48,14 @@ declare module 'abcjs' {
 
 	export type FormatAttributes = "titlefont" | "gchordfont" | "composerfont" | "footerfont" | "headerfont" | "historyfont" | "infofont" |
 		"measurefont" | "partsfont" | "repeatfont" | "subtitlefont" | "tempofont" | "textfont" | "voicefont" | "tripletfont" | "vocalfont" |
-		"wordsfont" | "annotationfont" | "scale" | "partsbox" | "freegchord" | "fontboxpadding" | "stretchlast" | "tablabelfont" | "tabnumberfont" | "tabgracefont";
+		"wordsfont" | "annotationfont" | "scale" | "partsbox" | "freegchord" | "fontboxpadding" | "stretchlast" | "tablabelfont" | "tabnumberfont" | "tabgracefont" | 'stafftopmargin';
 
 	export type MidiCommands = "nobarlines" | "barlines" | "beataccents" | "nobeataccents" | "droneon" | "droneoff" | "noportamento" | "channel" | "c" |
 		"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" |
-		"drone" | "bassprog" | "chordprog" | "drummap" | "portamento" | "expand" | "grace" | "trim" | "drum" | "chordname";
+		"drone" | "drummap" | "portamento" | "expand" | "grace" | "trim" | "drum" | "chordname";
 
 	export type StemDirection = 'up' | 'down' | 'auto' | 'none';
 
@@ -262,6 +262,7 @@ declare module 'abcjs' {
 	}
 
 	export interface AbcVisualParams {
+		accentAbove?: boolean;
 		add_classes?: boolean;
 		afterParsing?: AfterParsing;
 		ariaLabel?: string;
@@ -291,10 +292,12 @@ declare module 'abcjs' {
 		selectTypes?: boolean | Array<DragTypes>;
 		showDebug?: Array<"grid" | "box">;
 		staffwidth?: number;
+		stafftopmargin?: number;
 		startingTune?: number;
 		stop_on_warning?: boolean;
 		tablature?: Array<Tablature>;
 		textboxpadding?: number;
+		timeBasedLayout?: { minPadding?:number, minWidth?:number, align?: 'left'|'center'};
 		viewportHorizontal?: boolean;
 		viewportVertical?: boolean;
 		visualTranspose?: number;
@@ -317,8 +320,8 @@ declare module 'abcjs' {
 	export interface EditorSynth {
 		synthControl?: SynthObjectController;
 		el: Selector;
-		cursorControl: CursorControl;
-		options: SynthOptions;
+		cursorControl?: CursorControl;
+		options?: SynthOptions;
 	}
 
 	export interface EditorOptions {
@@ -336,7 +339,7 @@ declare module 'abcjs' {
 	// Audio
 	export interface NoteMapTrackItem {
 		pitch: number;
-		instrument: number;
+		instrument: string;
 		start: number;
 		end: number;
 		startChar: number;
@@ -360,6 +363,7 @@ declare module 'abcjs' {
 		drum?: string;
 		drumBars?: number;
 		drumIntro?: number;
+		drumOff?: boolean;
 		program?: number;
 		midiTranspose?: number;
 		visualTranspose?: number;
@@ -368,6 +372,13 @@ declare module 'abcjs' {
 		defaultQpm?: number;
 		chordsOff?: boolean;
 		detuneOctave?: boolean;
+
+		swing?: number;
+		bassprog?: number;
+		bassvol?: number;
+		chordprog?: number;
+		chordvol?: number;
+		gchord?: string;
 }
 
 	export interface SynthVisualOptions {
@@ -553,6 +564,7 @@ declare module 'abcjs' {
 		subtitlespace?: number;
 		sysstaffsep?: number;
 		systemsep?: number;
+		stafftopmargin?: number;
 		textspace?: number;
 		titleformat?: string;
 		titleleft?: boolean;
@@ -776,8 +788,10 @@ declare module 'abcjs' {
 		el_type: "note";
 		startChar: number;
 		endChar: number;
+		duration: number;
+		pitches?: Array<any>; // TODO-PER
+		rest?: { type: 'rest' | 'spacer' | 'invisible' | 'invisible-multimeasure' | 'multimeasure', text? : number};
 	}
-
 	export type VoiceItem = VoiceItemClef | VoiceItemBar | VoiceItemGap | VoiceItemKey | VoiceItemMeter | VoiceItemMidi | VoiceItemOverlay | VoiceItemPart | VoiceItemScale | VoiceItemStem | VoiceItemStyle | VoiceItemTempo | VoiceItemTranspose | VoiceItemNote;
 
 	export interface TuneLine {
@@ -804,26 +818,59 @@ declare module 'abcjs' {
 			text: TextFieldProperties;
 		};
 		staff?: Array<{
-					barNumber?: number;
-					brace: BracePosition;
-					bracket: BracePosition;
-					clef?: ClefProperties;
-					connectBarLines: BracePosition;
-					gchordfont: Font;
-					tripletfont: Font;
-					vocalfont: Font;
-					key?: KeySignature;
-					meter?: Meter;
-					spacingAbove?: number;
-					spacingBelow?: number;
-					stafflines?: number;
-					staffscale?: number;
-					title?: Array<string>;
-					voices?: Array<Array<VoiceItem>>;
-			}>
+			clef?: ClefProperties;
+			key?: KeySignature;
+			meter?: Meter;
+			voices?: Array<Array<VoiceItem>>;
+		}>;
+		staffGroup?: {
+			barNumber?: number;
+			brace?: BracePosition;
+			bracket?: BracePosition;
+			connectBarLines?: BracePosition;
+			gchordfont?: Font;
+			tripletfont?: Font;
+			vocalfont?: Font;
+			spacingAbove?: number;
+			spacingBelow?: number;
+			stafflines?: number;
+			staffscale?: number;
+			title?: Array<string>;
+			height?:number;
+			line?: number;
+			startx?:number;
+			w?:number;
+			gridStart?:number;
+			gridEnd?:number;
+		};
 		vskip?: number;
 	}
 
+	export interface Selectable {
+		absEl: AbsoluteElement;
+		isDraggable: boolean;
+		staffPos: {
+			height: number;
+			top: number;
+			zero: number;
+		}
+		svgEl: SVGElement;
+	}
+
+	export interface SelectableReturn {
+		index: number;
+		classes: Array<string>;
+		element: Selectable;
+		analysis: {
+			staffPos: number;
+			name: string;
+			voice: number;
+			line: number;
+			measure: number;
+			selectableElement: HTMLElement;
+		}
+	}
+
 	export interface TuneObject {
 		formatting: Formatting;
 		engraver?: EngraverController;
@@ -832,6 +879,7 @@ declare module 'abcjs' {
 		metaText: MetaText;
 		metaTextInfo: MetaTextInfo;
 		version: string;
+		warnings?: Array<string>;
 
 		getTotalTime: NumberFunction;
 		getTotalBeats: NumberFunction;
@@ -846,25 +894,18 @@ declare module 'abcjs' {
 		getElementFromChar: (charPos: number) => VoiceItem | null;
 		millisecondsPerMeasure: (bpm?: number) => number;
 		setTiming: (bpm?: number, measuresOfDelay? : number) => void;
+		setupEvents: (startingDelay: number, timeDivider:number, startingBpm: number, warp?: number) => Array<NoteTimingEvent>;
 		setUpAudio: (options: SynthOptions) => AudioTracks;
 		makeVoicesArray: () => Array<Selectable[]>
 		deline: () => Array<TuneLine>;
+		findSelectableElement: (target: HTMLElement) => SelectableReturn | null;
+		getSelectableArray: () => Array<Selectable>
 		lineBreaks?: Array<number>;
 		visualTranspose?: number;
 	}
 
 	export type TuneObjectArray = [TuneObject]
 
-	export interface Selectable {
-		absEl: AbsoluteElement;
-		isDraggable: boolean;
-		staffPos: {
-			height: number;
-			top: number;
-			zero: number;
-		}
-	}
-
 	export interface AbcElem {
 		el_type: string; //TODO enumerate these
 		abselem: AbsoluteElement;
@@ -1026,10 +1067,30 @@ declare module 'abcjs' {
 		loaded: Array<string>;
 	}
 
-	export interface AudioTrack {
-		cmd: AudioTrackCommand;
-		[param: string]: any; // TODO - make this a union
+	export interface AudioTrackProgramItem {
+		cmd: 'program';
+		channel: number;
+		instrument: number;
+	}
+
+	export interface AudioTrackNoteItem {
+		cmd: 'note';
+		duration: number;
+		endChar: number;
+		endType?: "staccato"|"tenuto";
+		gap: number;
+		instrument: number;
+		pitch: number;
+		start: number;
+		startChar: number;
+		volume: number;
 	}
+	export interface AudioTrackTextItem {
+		cmd: 'text';
+		type: 'name';
+		text: string;
+	}
+	export type AudioTrack = Array<AudioTrackProgramItem|AudioTrackNoteItem|AudioTrackTextItem>
 
 	export interface AudioTracks {
 		tempo: number;
@@ -1101,6 +1162,8 @@ declare module 'abcjs' {
 
 	export function renderAbc(target: Selector, code: string, params?: AbcVisualParams): TuneObjectArray
 
+	export function tuneMetrics(code: string, params?: AbcVisualParams): Array<{sections: Array<{left: number, measureWidths:Array<number>, total: number}>}>
+
 	export function parseOnly(abc: string, params?: AbcVisualParams) : TuneObjectArray
 
 	//
@@ -1157,6 +1220,7 @@ declare module 'abcjs' {
 		stop(): number
 		download(): string // returns audio buffer in wav format as a reference to a blob
 		getIsRunning(): boolean
+		getAudioBuffer(): AudioBuffer | undefined
 	}
 
 	export interface SynthInitResponse {
@@ -1188,6 +1252,45 @@ declare module 'abcjs' {
 		appendNote(trackNumber: number, pitch: number, durationInMeasures: number, volume: number, cents: number): void
 	}
 
+	export interface MidiRenderer {
+		setTempo(bpm: number): void
+		setGlobalInfo(bpm: number, name: string, key:KeySignature, time:MeterFraction): void
+		startTrack(): void
+		endTrack(): void
+		setText(type: string, text: string):void
+		setInstrument(instrument: number):void
+		setChannel(channel:number, pan?: number):void
+		startNote(pitch:number, loudness:number, cents?:number):void
+		endNote(pitch:number):void
+		addRest(length:number):void
+
+		getData():string
+		embed(parent:Element, noplayer:boolean):void
+	}
+
+	export interface SynthControlOptions {
+		ac?: AudioContext;
+		afterResume?: () => void;
+		loopHandler?: (ev: any) => Promise<void>;
+		restartHandler?: (ev: any) => Promise<void>;
+		playHandler?: (ev: any) => Promise<void>;
+		playPromiseHandler?: (ev: any) => Promise<void>;
+		progressHandler?: (ev: any) => Promise<void>;
+		warpHandler?: (ev: any) => Promise<void>;
+		hasClock?: boolean;
+		repeatTitle?: string;
+		repeatAria?: string;
+		restartTitle?: string;
+		restartAria?: string;
+		playTitle?: string;
+		playAria?: string;
+		randomTitle?: string;
+		randomAria?: string;
+		warpTitle?: string;
+		warpAria?: string;
+		bpm?: string;
+	}
+
 	export namespace synth {
 		let instrumentIndexToName: [string]
 		let pitchToNoteName: [string]
@@ -1198,10 +1301,11 @@ declare module 'abcjs' {
 		export function supportsAudio(): boolean
 		export function registerAudioContext(ac?: AudioContext): boolean
 		export function activeAudioContext(): AudioContext
-		export function CreateSynthControl(element: Selector, options: AbcVisualParams): AudioControl
+		export function CreateSynthControl(element: Selector, options?: SynthControlOptions): AudioControl
 		export function getMidiFile(source: string | TuneObject, options?: MidiFileOptions): MidiFile;
 		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches | undefined, milliSecondsPerMeasure: number, soundFontUrl? : string, debugCallback?: (message: string) => void): Promise<void>;
 		export function sequence(visualObj: TuneObject, options: AbcVisualParams): AudioSequence
+		export function midiRenderer(): MidiRenderer
 	}
 
 	//
@@ -1219,7 +1323,7 @@ declare module 'abcjs' {
 	export function numberOfTunes(abc: string) : number;
 	export function extractMeasures(abc: string) : Array<MeasureList>;
 	
-	export function strTranspose(originalAbc: string, visualObj: TuneObject, steps: number): string;
+	export function strTranspose(originalAbc: string, visualObj: TuneObjectArray, steps: number): string;
 
 	//
 	// Glyph

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.2.3';
+var version = '6.4.0';
 
 module.exports = version;

package/.github/workflows/tests.yml

@@ -1,29 +0,0 @@
-name: Tests
-
-on: [push, pull_request]
-
-jobs:
-  Jest:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Cache node modules
-        uses: actions/cache@v2
-        env:
-          cache-name: cache-node-modules
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
-
-      - name: Install Dependencies
-        run: npm install --color="always"
-
-      - name: Install Dependencies
-        run: npm test -- --colors
-
-