abcjs 6.3.0 → 6.4.0

package/src/write/layout/set-upper-and-lower-elements.js

@@ -87,6 +87,8 @@ var setUpperAndLowerElements = function (renderer, staffGroup) {
 			if (addedSpace > 0)
 				staff.top += addedSpace;
 		}
+		staff.top += renderer.spacing.staffTopMargin / spacing.STEP
+
 		lastStaffBottom = 2 - staff.bottom; // the staff starts at position 2 and the bottom variable is negative. Therefore to find out how large the bottom is, we reverse the sign of the bottom, and add the 2 in.
 
 		// Now we need a little margin on the top, so we'll just throw that in.

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/temp.txt

@@ -1,50 +1,3 @@
-## Features
 
-### Tablature
-* Add tab feature `hideTabSymbol`
-* Add 5-string tab named "fiveString"
-* Make "mandolin" and "fiddle" synonyms for "violin" in tablature.
+    
 
-### Synth
-* change the default synth control options for "play" and "progress" to be true
-* expose the MIDI creator function
-* Add a `getIsRunning()` function to enable play/pause
-* allow passing in soundfont and debug callback when playing an event directly.
-
-### Rich Text
-* allow up to 9 custom fonts in `%%setfont`
-* for rich text fields, escape two dollar signs 
-* allow rich text in all non-music fields 
-* give all non-music fields a unique class
-
-### Miscellaneous
-* add abcjs-notehead class to note heads; 
-* add `accentAbove` parameter
-* handle numbered tune names in the reverser
-* support reversing tune names with ", a" and ", an", with a variable amount of whitespace and case-insensitive
-* Add Glissando Synonyms
-* Put start and end char on slurs so they can be selected.
-* Add `expandToWidest` option
-
-## Bugs
-* fix placement of tab staff when there is no label
-* fix font placement bugs
-* remove spurious quotes in font name in svg attribute
-* Fix the name of the `abcjs-tab-number` class
-* fix crash when skipping a staff when creating tablature
-* Fix tab staff height when there is a label
-* Fix for crash when rendering multiple tab staves
-* Offset breath mark to the right
-* Center text when using `expandToWidest` set true
-* fix placement of triangle notehead
-* `afterParsing` now works with line wrapping.
-* Add paddingleft to the size of the SVG - it was cut off if the padding was larger than the default.
-* Guard against crash when the synth note wasn't loaded.
-* protect against spurious mouse click in selection
-* Fix bug in Firefox that cuts off the last line of the SVG
-
-## Documentation
-* add missing typescript types
-* fix synth control types
-* fixed some typescript types in the TimingCallbacks
-* TimingEvent is now NoteTimingEvent

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';
 
@@ -292,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;
@@ -361,6 +363,7 @@ declare module 'abcjs' {
 		drum?: string;
 		drumBars?: number;
 		drumIntro?: number;
+		drumOff?: boolean;
 		program?: number;
 		midiTranspose?: number;
 		visualTranspose?: number;
@@ -369,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 {
@@ -554,6 +564,7 @@ declare module 'abcjs' {
 		subtitlespace?: number;
 		sysstaffsep?: number;
 		systemsep?: number;
+		stafftopmargin?: number;
 		textspace?: number;
 		titleformat?: string;
 		titleleft?: boolean;
@@ -777,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 {
@@ -805,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;
@@ -833,6 +879,7 @@ declare module 'abcjs' {
 		metaText: MetaText;
 		metaTextInfo: MetaTextInfo;
 		version: string;
+		warnings?: Array<string>;
 
 		getTotalTime: NumberFunction;
 		getTotalBeats: NumberFunction;
@@ -851,22 +898,14 @@ declare module 'abcjs' {
 		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;
@@ -1123,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
 
 	//
@@ -1227,6 +1268,29 @@ declare module 'abcjs' {
 		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]
@@ -1237,7 +1301,7 @@ 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
@@ -1259,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.3.0';
+var version = '6.4.0';
 
 module.exports = version;