abcjs 6.1.8 → 6.2.0

package/types/index.d.ts

@@ -51,7 +51,7 @@ declare module 'abcjs' {
 		"wordsfont" | "annotationfont" | "scale" | "partsbox" | "freegchord" | "fontboxpadding" | "stretchlast" | "tablabelfont" | "tabnumberfont" | "tabgracefont";
 
 	export type MidiCommands = "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" |
@@ -68,7 +68,8 @@ declare module 'abcjs' {
 		"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" |
-		"mark" | "marcato" | "umarcato"
+		"mark" | "marcato" | "umarcato" |
+		"D.C.alcoda" | "D.C.alfine" | "D.S.alcoda" | "D.S.alfine" | "editorial" | "courtesy"
 
 	//
 	// Basic types
@@ -157,19 +158,80 @@ declare module 'abcjs' {
 
 	export type MidiParam = Array<string|number>;
 
-	export type MidiGracePitches = Array<{instrument: string; pitch: number; volume: number; cents?: number}>;
+	export type MidiGracePitches = Array<{instrument: number; pitch: number; volume: number; cents?: number; durationInMeasures: number}>;
 
 	export interface MidiPitch {
-		instrument: string;
+		instrument: number;
 		pitch: number;
 		duration: number;
 		volume: number;
-		cents?: number
+		cents?: number;
+		start: number;
+		gap: number;
 	}
 
 	export type MidiPitches = Array<MidiPitch>;
 
-	export type AbsoluteElement = any; // TODO
+	export interface RelativeElement {
+		x: number;
+		c: string;
+		dx: number;
+		w: number;
+		pitch: number;
+		pitch2?: number;
+		scaleX: number;
+		scaleY: number;
+		type: string;
+		name: string;
+		linewidth?: number;
+		klass?: string;
+		anchor?: "start" | "middle" | "end";
+		top: number;
+		bottom: number;
+		dim?: number;
+		position?: number;
+		realWidth?: number;
+		partHeightAbove?: number;
+		chordHeightAbove?: number;
+		chordHeightBelow?: number;
+		lyricHeightAbove?: number;
+		lyricHeightBelow?: number;
+	}
+
+	export interface AbsoluteElement {
+		abcelem : AbcElem;
+		bottom : number;
+		children : Array<RelativeElement>
+		duration : number;
+		durationClass : number;
+		elemset : Array<SVGElement>
+		extra : Array<RelativeElement>
+		extraw : number;
+		fixed : {w: number, t: number, b: number}
+		heads : Array<RelativeElement>
+		invisible : boolean;
+		minspacing : number;
+		notePositions : Array<{x:number; y:number;}>
+		right : Array<RelativeElement>
+		specialY : Array<{
+			chordHeightAbove : number;
+			chordHeightBelow : number;
+			dynamicHeightAbove : number;
+			dynamicHeightBelow : number;
+			endingHeightAbove : number;
+			lyricHeightAbove : number;
+			lyricHeightBelow : number;
+			partHeightAbove : number;
+			tempoHeightAbove : number;
+			volumeHeightAbove : number;
+			volumeHeightBelow : number;
+		}>
+		top : number;
+		tuneNumber : number;
+		type : "symbol" | "tempo" | "part" | "rest" | "note" | "bar" | "staff-extra clef" | "staff-extra key-signature" | "staff-extra time-signature";
+		w : number;
+		x : number;
+	}
 
 	export type AbstractEngraver = any;
 
@@ -197,11 +259,13 @@ declare module 'abcjs' {
 		dragColor?: string;
 		dragging?: boolean;
 		foregroundColor?: string;
-		format?: { [attr: FormatAttributes]: any };
+		format?: { [attr in FormatAttributes]: any };
 		header_only?: boolean;
 		initialClef?: boolean;
 		jazzchords?: boolean;
+		germanAlphabet?: boolean;
 		lineBreaks?: Array<number>;
+		lineThickness?: number;
 		minPadding?: number;
 		oneSvgPerLine?: boolean;
 		paddingbottom?: number;
@@ -340,7 +404,7 @@ declare module 'abcjs' {
 		millisecondsPerMeasure: number;
 		type: NoteTimingEventType;
 
-		elements?: Array<HTMLElement>;
+		elements?: Array<Array<HTMLElement>>;
 		endChar?: number;
 		endCharArray?: Array<number>;
 		endX?: number;
@@ -349,6 +413,7 @@ declare module 'abcjs' {
 		line?: number;
 		measureNumber?: number;
 		midiPitches?: MidiPitches;
+		midiGraceNotePitches?: MidiGracePitches;
 		startChar?: number;
 		startCharArray?: Array<number>;
 		top?: number;
@@ -760,7 +825,7 @@ declare module 'abcjs' {
 		getPickupLength: NumberFunction;
 		getKeySignature: () => KeySignature;
 		getElementFromChar: (charPos: number) => VoiceItem | null;
-		millisecondsPerMeasure: NumberFunction;
+		millisecondsPerMeasure: (bpm?: number) => number;
 		setTiming: (bpm?: number, measuresOfDelay? : number) => void;
 		setUpAudio: (options: SynthOptions) => AudioTracks;
 		makeVoicesArray: () => Array<Selectable[]>
@@ -781,21 +846,32 @@ declare module 'abcjs' {
 	}
 
 	export interface AbcElem {
-		el_type: string //TODO enumerate these
-		abselem: any;
+		el_type: string; //TODO enumerate these
+		abselem: AbsoluteElement;
 		beambr?: number;
-		chord?: Array<any>
-		decoration: Array<any>
+		chord?: Array<{name: string; position: ChordPlacement}>
+		decoration: Array<string> //TODO enumerate these
 		duration: number
 		endBeam?: boolean
 		endSlur?: number
 		endTriplet?: true
-		gracenotes?: Array<any>
-		lyric?: Array<any>
+		gracenotes?: Array<{duration: number; name:string; pitch: number; verticalPosition: number;}>
+		lyric?: Array<{syllable: string; divider: ' ' | '-' | '_';}>
 		noStem?: boolean
-		pitches?: Array<any>
+		midiPitches?: MidiPitches;
+		midiGraceNotePitches?: MidiGracePitches;
+		pitches?: Array<{
+			pitch: number;
+			name: string;
+			startSlur?: Array<{label: number}>;
+			endSlur?: Array<number>;
+			startTie?: {};
+			endTie?: boolean;
+			verticalPos: number;
+			highestVert: number;
+		}>
 		positioning?: any
-		rest?: any
+		rest?: {"type": "rest"}
 		startBeam?: boolean
 		startTriplet?: number
 		tripletMultiplier?: number
@@ -865,7 +941,7 @@ declare module 'abcjs' {
 		ev: NoteTimingEvent;
 		endMs: number;
 		offMs: number;
-		offPs: number;
+		offPx: number;
 		gapMs: number;
 		gapPx: number;
 	}
@@ -1086,15 +1162,16 @@ declare module 'abcjs' {
 
 	export interface SynthObjectController {
 		disable(isDisabled: boolean): void
-		setTune(visualObj: TuneObject, userAction: boolean, audioParams?: any): Promise<SynthInitResponse>
-		load(selector: string, cursorControl?: any, visualOptions?: SynthVisualOptions): void
+		setTune(visualObj: TuneObject, userAction: boolean, audioParams?: SynthOptions): Promise<SynthInitResponse>
+		load(selector: Selector, cursorControl?: CursorControl | null, visualOptions?: SynthVisualOptions): void
 		play(): void
 		pause(): void
 		toggleLoop(): void
 		restart(): void
 		setProgress(ev: number): void
-		setWarp(percent: number): void
+		setWarp(percent: number): Promise<void>
 		download(fName: string): void
+		getAudioBuffer(): AudioBuffer | undefined
 	}
 
 	export interface SynthSequenceClass {
@@ -1115,7 +1192,7 @@ 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, milliSecondsPerMeasure: number): Promise<void>;
+		export function playEvent(pitches: MidiPitches, graceNotes: MidiGracePitches | undefined, milliSecondsPerMeasure: number): Promise<void>;
 		export function sequence(visualObj: TuneObject, options: AbcVisualParams): AudioSequence
 	}
 

package/version.js

@@ -1,3 +1,3 @@
-var version = '6.1.8';
+var version = '6.2.0';
 
 module.exports = version;

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

@@ -1,19 +0,0 @@
-
-/**
- * Dedicated fonts for violin tabs
- */
-
-/**
- * Set here the fonts used by renderer/drawer 
- * for the violin plugin
- * @param {} tune 
- */
-// eslint-disable-next-line no-unused-vars
-function setGuitarFonts(tune) {
-  /* enhance or change instrument fonts here */
-  // tune.formatting.tabnumberfont = { face: "\"Times New Roman\"", size: 9, weight: "normal", style: "normal", decoration: "none" };
-  // tune.formatting.tabgracefont = { face: "\"Times New Roman\"", size: 7, weight: "normal", style: "normal", decoration: "none" };
-}
-
-module.exports = setGuitarFonts;
-

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

@@ -1,19 +0,0 @@
-
-/**
- * Dedicated fonts for violin tabs
- */
-
-/**
- * Set here the fonts used by renderer/drawer 
- * for the violin plugin
- * @param {} tune 
- */
-// eslint-disable-next-line no-unused-vars
-function setViolinFonts(tune) {
-  /* enhance or change instrument fonts here */
-  // tune.formatting.tabnumberfont = { face: "\"Times New Roman\"", size: 9, weight: "normal", style: "normal", decoration: "none" };
-  // tune.formatting.tabgracefont = { face: "\"Times New Roman\"", size: 7, weight: "normal", style: "normal", decoration: "none" };
-}
-
-module.exports = setViolinFonts;
-

package/src/tablatures/transposer.js

@@ -1,110 +0,0 @@
-/**
- *
- * generic transposer
- *
- */
-var TabNote = require('./instruments/tab-note');
-
-
-
-function buildAccEquiv(acc,note) {
-  var equiv = note.getAccidentalEquiv();
-  if (acc.note.toUpperCase() == equiv.name.toUpperCase()) {
-    equiv.isSharp = false;
-    equiv.isFlat = false;
-    return equiv;
-  }
-  return note;
-}
-
-function adjustNoteToKey(acc, note) {
-  if (acc.acc == 'sharp') {
-    if (note.isFlat) {
-      return buildAccEquiv(acc, note);
-    } else if (note.isSharp) {
-      if (acc.note.toUpperCase() == note.name.toUpperCase()) {
-        note.isSharp = false;
-        note.isKeySharp = true;
-      } else {
-        if (acc.note.toUpperCase() == note.name.toUpperCase()) {
-          note.natural = true;
-        }
-      }
-    }
-  } else if (acc.acc == 'flat') {
-    if (note.isSharp) {
-      return buildAccEquiv(acc, note);
-    } else if (note.isFlat) {
-      if (acc.note.toUpperCase() == note.name.toUpperCase()) {
-        note.isFlat = false;
-        note.isKeyFlat = true;
-      }
-    } else {
-      if (acc.note.toUpperCase() == note.name.toUpperCase()) {
-        note.natural = true;
-      }
-    }
-  }
-  return note;
-}
-
-
-function replaceNote(self, newNote, start, end) {
-  if (self.lastEnd) {
-    while (start > self.lastEnd) {
-      self.updatedSrc.push(self.abcSrc[self.lastEnd]);
-      self.lastEnd++;
-    }
-  }
-  var nNote = newNote.split('');
-  for (var ii = 0; ii < nNote.length; ii++) {
-    self.updatedSrc.push(nNote[ii]);
-  }
-  var curPos = start + ii;
-  while (end >= curPos) {
-    self.updatedSrc.push(nNote[curPos]);
-    curPos++;
-  }
-  self.lastEnd = end;
-}
-
-
-function checkKeys(self, note) {
-  var accs = self.transposedKey;
-  for (var ii = 0; ii < accs.length; ii++) {
-    note = adjustNoteToKey(accs[ii], note);
-  }
-  return note;
-}
-
-Transposer.prototype.transposeNote = function (note) {
-  var returned = note;
-  var curNote = new TabNote.TabNote(returned.name);
-  if (this.transposeBy > 0) {
-    for (var ii = 0; ii < this.transposeBy; ii++) {
-      curNote = checkKeys(this,curNote.nextNote());
-    }  
-    
-  } else if ( this.transposeBy < 0) {
-    for (var jj = this.transposeBy; jj < 0; jj++) {
-      curNote = checkKeys(this,curNote.prevNote());
-    }
-  }
-  returned.name = curNote.emit();
-  return returned;
-};
-
-Transposer.prototype.upgradeSource = function (note, startChar, endChar ) {
-  var n = new TabNote.TabNote(note.name);
-  var newNote = n.emit();
-  replaceNote(this, newNote, startChar, endChar-1);
-};
-
-function Transposer(transposedKey , transposeBy ) {
-  this.transposeBy = transposeBy;
-  this.transposedKey = transposedKey;
-  this.lastEnd = this.kEnd+1;
-}
-
-
-module.exports = Transposer;