abcjs 6.2.2 → 6.3.0

package/types/index.d.ts

@@ -71,6 +71,8 @@ declare module 'abcjs' {
 		"mark" | "marcato" | "umarcato" |
 		"D.C.alcoda" | "D.C.alfine" | "D.S.alcoda" | "D.S.alfine" | "editorial" | "courtesy"
 
+	export type TablatureInstrument = 'guitar' | 'mandolin' | 'fiddle' | 'violin' | '';
+
 	//
 	// Basic types
 	//
@@ -251,13 +253,23 @@ declare module 'abcjs' {
 		minSpacingLimit?: number;
 	}
 
+	export interface Tablature {
+		instrument?: TablatureInstrument,
+		capo?: number
+		label?: string,
+		tuning?: Array<string>,
+		highestNote?: string,
+	}
+
 	export interface AbcVisualParams {
+		accentAbove?: boolean;
 		add_classes?: boolean;
 		afterParsing?: AfterParsing;
 		ariaLabel?: string;
 		clickListener?: ClickListener;
 		dragColor?: string;
 		dragging?: boolean;
+		expandToWidest?: boolean;
 		foregroundColor?: string;
 		format?: { [attr in FormatAttributes]?: any };
 		header_only?: boolean;
@@ -282,6 +294,7 @@ declare module 'abcjs' {
 		staffwidth?: number;
 		startingTune?: number;
 		stop_on_warning?: boolean;
+		tablature?: Array<Tablature>;
 		textboxpadding?: number;
 		viewportHorizontal?: boolean;
 		viewportVertical?: boolean;
@@ -305,8 +318,8 @@ declare module 'abcjs' {
 	export interface EditorSynth {
 		synthControl?: SynthObjectController;
 		el: Selector;
-		cursorControl: CursorControl;
-		options: SynthOptions;
+		cursorControl?: CursorControl;
+		options?: SynthOptions;
 	}
 
 	export interface EditorOptions {
@@ -324,7 +337,7 @@ declare module 'abcjs' {
 	// Audio
 	export interface NoteMapTrackItem {
 		pitch: number;
-		instrument: number;
+		instrument: string;
 		start: number;
 		end: number;
 		startChar: number;
@@ -399,7 +412,7 @@ declare module 'abcjs' {
 	//
 
 	// renderAbc
-	interface NoteTimingEvent {
+	export interface NoteTimingEvent {
 		milliseconds: number;
 		millisecondsPerMeasure: number;
 		type: NoteTimingEventType;
@@ -421,6 +434,11 @@ declare module 'abcjs' {
 		measureStart?: boolean;
 	}
 
+	// make an alias for backwards compatibility
+	export interface TimingEvent extends NoteTimingEvent {
+
+	}
+
 	export interface PercMapElement {
 		sound: number;
 		noteHead: NoteHeadType;
@@ -571,6 +589,7 @@ declare module 'abcjs' {
 		wordsfont: Font;
 	}
 
+	// Caution: The contents of this object may change at any time. If you reference this, be sure you retest for each abcjs release.
 	export interface EngraverController {
 		classes: any;
 		dragColor: string;
@@ -679,6 +698,7 @@ declare module 'abcjs' {
 
 	export interface VoiceItemBar {
 		el_type: "bar";
+		type: 'bar_dbl_repeat' | 'bar_right_repeat' | 'bar_left_repeat' |'bar_invisible' | 'bar_thick_thin' | 'bar_thin_thin' | 'bar_thin' | 'bar_thin_thick';
 		barNumber?: number;
 		chord?: Array<ChordProperties>;
 		decoration: Array<Decorations>;
@@ -827,8 +847,10 @@ 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>;
 		lineBreaks?: Array<number>;
 		visualTranspose?: number;
 	}
@@ -913,22 +935,6 @@ declare module 'abcjs' {
 		endTimings: Array<LineEndInfo>;
 	}
 
-	export interface TimingEvent {
-		type: "event";
-		milliseconds: number;
-		millisecondsPerMeasure: number;
-		line: number;
-		measureNumber: number;
-		top: number;
-		height: number;
-		left: number;
-		width: number;
-		elements: Array< HTMLElement>;
-		startCharArray: Array<number>;
-		endCharArray: Array<number>;
-		midiPitches: MidiPitches
-	}
-
 	export interface TimingCallbacksPosition {
 		top: number;
 		left: number;
@@ -1022,11 +1028,31 @@ 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;
 		instrument: number;
@@ -1068,9 +1094,11 @@ declare module 'abcjs' {
 	// TimingCallbacks
 	export type BeatCallback = (beatNumber: number, totalBeats: number, totalTime: number, position: TimingCallbacksPosition, debugInfo: TimingCallbacksDebug) => void;
 
-	export type EventCallback = (event: TimingEvent) => void;
+	type EventCallbackReturn = "continue" | Promise<"continue"> | undefined
+
+	export type EventCallback = (event: NoteTimingEvent | null) => EventCallbackReturn;
 
-	export type LineEndCallback = (info : LineEndInfo, event: TimingEvent, details: LineEndDetails) => void;
+	export type LineEndCallback = (info : LineEndInfo, event: NoteTimingEvent, details: LineEndDetails) => void;
 
 	// Editor
 	export type OnChange = (editor: Editor) => void;
@@ -1125,6 +1153,7 @@ declare module 'abcjs' {
 		pause(shouldPause: boolean): void;
 		millisecondsPerMeasure(): number;
 		pauseMidi(shouldPause: boolean): void;
+		fireChanged():void;
 	}
 
 	//
@@ -1149,6 +1178,8 @@ declare module 'abcjs' {
 		seek(position: number, units?: ProgressUnit): void
 		stop(): number
 		download(): string // returns audio buffer in wav format as a reference to a blob
+		getIsRunning(): boolean
+		getAudioBuffer(): AudioBuffer | undefined
 	}
 
 	export interface SynthInitResponse {
@@ -1180,6 +1211,22 @@ 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 namespace synth {
 		let instrumentIndexToName: [string]
 		let pitchToNoteName: [string]
@@ -1192,8 +1239,9 @@ declare module 'abcjs' {
 		export function activeAudioContext(): AudioContext
 		export function CreateSynthControl(element: Selector, options: AbcVisualParams): AudioControl
 		export function getMidiFile(source: string | TuneObject, options?: MidiFileOptions): MidiFile;
-		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches | undefined, milliSecondsPerMeasure: number): Promise<void>;
+		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
 	}
 
 	//

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.2.2';
+var version = '6.3.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
-
-

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

@@ -1,48 +0,0 @@
-/*
-Emit tab for Guitar staff
-*/
-var StringTablature = require('../string-tablature');
-var TabCommon = require('../../tab-common');
-var TabRenderer = require('../../tab-renderer');
-var GuitarPatterns = require('./guitar-patterns');
-
-/**
-* upon init mainly store provided instances for later usage
-* @param {*} abcTune  the parsed tune AST tree
-*  @param {*} tuneNumber  the parsed tune AST tree
-* @param {*} params  complementary args provided to Tablature Plugin
-*/
-Plugin.prototype.init = function (abcTune, tuneNumber, params) {
-  var _super = new TabCommon(abcTune, tuneNumber, params);
-  this._super = _super;
-  this.abcTune = abcTune;
-  this.linePitch = 3;
-  this.nbLines = 6;
-  this.isTabBig = true;
-  this.capo = params.capo;
-  this.transpose = params.visualTranspose;
-  this.tablature = new StringTablature(this.nbLines,
-    this.linePitch);
-
-  var semantics = new GuitarPatterns(this);
-  this.semantics = semantics;
-};
-
-Plugin.prototype.render = function (renderer, line, staffIndex) {
-  if (this._super.inError) return;
-  if (this.tablature.bypass(line)) return;
-  var rndrer = new TabRenderer(this, renderer, line, staffIndex);
-  rndrer.doLayout();
-};
-
-function Plugin() {}
-
-//
-// Tablature plugin definition
-//
-var AbcGuitarTab = function () {
-  return { name: 'GuitarTab', tablature: Plugin };
-};
-
-
-module.exports = AbcGuitarTab;

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

@@ -1,23 +0,0 @@
-var StringPatterns = require('../string-patterns');
-
-function ViolinPatterns(plugin) {
-  this.tuning = plugin._super.params.tuning;
-  if (!this.tuning) {
-    this.tuning = ['G,', 'D', 'A', 'e'];
-  }
-  plugin.tuning = this.tuning;
-  this.strings = new StringPatterns(plugin);
-}
-
-ViolinPatterns.prototype.notesToNumber = function (notes, graces) {
-  var converter = this.strings;
-  return converter.notesToNumber(notes, graces);
-};
-
-ViolinPatterns.prototype.stringToPitch = function (stringNumber) {
-  var converter = this.strings;
-  return converter.stringToPitch(stringNumber);
-};
-
-
-module.exports = ViolinPatterns;