@coderline/alphatab 1.3.0-alpha.439 → 1.3.0-alpha.477

package/README.md

@@ -1,42 +1,39 @@
 # AlphaTab
-[![Official Site](https://img.shields.io/badge/site-alphatab.net-blue.svg)](https://alphatab.net)
+
+[![Official Site](https://img.shields.io/badge/site-alphatab.net-blue.svg)](https://www.alphatab.net/)
+[![Documentation](https://img.shields.io/badge/docs-alphatab.net-blue.svg)](https://www.alphatab.net/docs/introduction)
 [![License MPL-2.0](https://img.shields.io/badge/license-MPL--2.0-green.svg)](https://www.mozilla.org/en-US/MPL/2.0/)
 [![Twitter](https://img.shields.io/badge/twitter-alphaTabMusic-blue.svg)](https://twitter.com/alphaTabMusic)
 [![Facebook](https://img.shields.io/badge/facebook-alphaTabMusic-blue.svg)](https://facebook.com/alphaTabMusic)
+[![Build](https://github.com/CoderLine/alphaTab/workflows/Build/badge.svg?branch=develop)](https://github.com/CoderLine/alphaTab/actions/workflows/build.yml)
 
 alphaTab is a cross platform music notation and guitar tablature rendering library. You can use alphaTab within your own website or application to load and display music sheets from data sources like Guitar Pro or the built in markup language named alphaTex.
 
 ![alphaTab](img/banner.png?raw=true "alphaTab")
 
-# Getting Started
-
-To get started follow our guides and tutorials at: 
+## Getting Started
 
-* https://www.alphatab.net/docs/introduction
-* https://www.alphatab.net/docs/tutorials
+To get started follow our guides and tutorials at:
 
-## Build Status
+* <https://www.alphatab.net/docs/introduction>
+* <https://www.alphatab.net/docs/tutorials>
 
-&nbsp; | &nbsp;
---- | ---
-**Build** | ![Build](https://github.com/CoderLine/alphaTab/workflows/Build/badge.svg?branch=develop)
-**Documentation** | [![Documentation](https://img.shields.io/badge/docs-master-brightgreen.svg)](https://www.alphatab.net/)
+## Features
 
-# Features
-alphaTab mostly focuses on web based platforms allowing music notation to be embedded into websites and browser based apps but is designed to be used also from various other platforms like .net and Android either as a platform native integration or through runtime specific JavaScript engines. 
+alphaTab mostly focuses on web based platforms allowing music notation to be embedded into websites and browser based apps but is also designed to be used on various other platforms like .net and Android either as a platform native integration or through runtime specific JavaScript engines.
 
 alphaTab can load music notation from various sources like Guitar Pro 3-7, AlphaTex and MusicXML (experimental) and render them into beautiful music sheets right within your browser (or application). Using a built in midi synthesizer named alphaSynth the music sheets can also be played in your browser.
 
-* load GuitarPro 3-5, GuitarPro 6, Guitar Pro 7, AlphaTex or MusicXML (experimental)
-* render as SVG or Raster Graphics (raster graphics depends on platform: HTML5 canvas, GDI+, SkiaSharp, Android Canvas)...
-* display single or multiple instruments as standard music notation and guitar tablatures consisting of song information, repeats, alternate endings, guitar tunints, clefs, key signatures, time signatures, notes, rests, accidentals, drum tabs, piano grand staff, tied notes, grace notes, dead notes, ghost notes, markers, tempos, lyrics, chords, vibratos, dynamics, tap/slap/pop, fade-in, let-ring, palm-mute, string bends, whammy bar, tremolo picking, strokes, slides, trills, pick strokes, tuplets, fingering, triplet feels,...
-* adapt to your responsive design by dynamic resizing
-* play the music sheet via built-in Midi+SoundFont2 Synthesizer (output depends on platform: HTML5 Web Audio, NAudio, Android AudioTrack)
+* Load GuitarPro 3-5, GuitarPro 6, Guitar Pro 7, AlphaTex or MusicXML (experimental)
+* Render as SVG or Raster Graphics (raster graphics depends on platform: HTML5 canvas, GDI+, SkiaSharp, Android Canvas)...
+* Display single or multiple instruments as standard music notation and guitar tablatures consisting of song information, repeats, alternate endings, guitar tunints, clefs, key signatures, time signatures, notes, rests, accidentals, drum tabs, piano grand staff, tied notes, grace notes, dead notes, ghost notes, markers, tempos, lyrics, chords, vibratos, dynamics, tap/slap/pop, fade-in, let-ring, palm-mute, string bends, whammy bar, tremolo picking, strokes, slides, trills, pick strokes, tuplets, fingering, triplet feels,...
+* Adapt to your responsive design by dynamic resizing
+* Play the music sheet via built-in Midi+SoundFont2 Synthesizer (output depends on platform: HTML5 Web Audio, NAudio, Android AudioTrack)
 
-# Officially Supported Platforms
+## Officially Supported Platforms
 
- Platform | Support | Availability |
-----------|---------|-------|
+ Platform | Support | Availability
+----------|---------|--------------
 Browsers using `script` includes (UMD) | Full experience including low level APIs, Background Workers, Audio Playback, SVG and HTML5 rendering. UI level integration for user interaction and automatic resizing. | 1.0-latest
 Node.js using `require` (UMD) | Access to all low level APIs and SVG rendering | 1.0-latest
 .net standard 2.0 | Access to all low level APIs and multiple render engines (SVG, GDI+, SkiaSharp) | 1.0-latest
@@ -48,7 +45,7 @@ Node.js using `import` (ESM) | Access to all low level APIs and SVG rendering |
 .net6.0-windows (WinForms) | Full experience including low level APIs, Background Workers, Audio Playback (through NAudio), SVG and HTML5 rendering. UI level integration for user interaction and automatic resizing. Reduced UI level integration related to transparency and animations. | 1.3 (pre-release :warning:)
 Android (Kotlin) | Full experience including low level APIs, Background Workers, Audio Playback, Android Canvas and SVG rendering. UI level integration for user interaction and automatic resizing. Reduced UI level integration related to transparency and animations. | 1.3 (pre-release :warning:)
 
-# Thanks to...
+## Thanks to...
 
 ... our friends of BrowserStack for a free plan. This allows me to test alphaTab on all browsers on all operating systems. Only with this I can ensure that alphaTab is shown to all your visitors as expected.
 
@@ -63,6 +60,6 @@ Android (Kotlin) | Full experience including low level APIs, Background Workers,
 Copyright © 2000-2022 JetBrains s.r.o. JetBrains and the JetBrains logo are registered trademarks of JetBrains s.r.o.
 </p>
 
-... to [Bernhard Schelling](https://github.com/schellingb/TinySoundFont) the author of TinySoundFont and [Steve Folta](https://github.com/stevefolta/SFZero) the author of SFZero for providing the core of the synthesis engine.
+... [Bernhard Schelling](https://github.com/schellingb/TinySoundFont) the author of TinySoundFont and [Steve Folta](https://github.com/stevefolta/SFZero) the author of SFZero for providing the core of the synthesis engine.
 
-... to all you people using alphaTab providing new feature ideas and bug reports.
+... all you people using alphaTab providing new feature ideas and bug reports.

package/dist/alphaTab.d.ts

@@ -1864,7 +1864,7 @@ declare class Track {
     percussionArticulations: InstrumentArticulation[];
     ensureStaveCount(staveCount: number): void;
     addStaff(staff: Staff): void;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     applyLyrics(lyrics: Lyrics[]): void;
 }
 
@@ -2205,7 +2205,7 @@ declare class Voice {
     private chain;
     addGraceBeat(beat: Beat): void;
     getBeatAtPlaybackStart(playbackStart: number): Beat | null;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     calculateDuration(): number;
 }
 
@@ -2265,7 +2265,7 @@ declare class Bar {
     get masterBar(): MasterBar;
     get isEmpty(): boolean;
     addVoice(voice: Voice): void;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     calculateDuration(): number;
 }
 
@@ -2402,7 +2402,7 @@ declare class Staff {
      * For some percussion instruments this number might vary.
      */
     standardNotationLineCount: number;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     addChord(chordId: string, chord: Chord): void;
     hasChord(chordId: string): boolean;
     getChord(chordId: string): Chord | null;
@@ -3147,14 +3147,14 @@ declare class Note {
     get displayValueWithoutBend(): number;
     get hasQuarterToneOffset(): boolean;
     addBendPoint(point: BendPoint): void;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     private static readonly MaxOffsetForSameLineSearch;
     static nextNoteOnSameLine(note: Note): Note | null;
     static findHammerPullDestination(note: Note): Note | null;
     static findTieOrigin(note: Note): Note | null;
     private static NoteIdLookupKey;
     private _noteIdBag;
-    chain(sharedDataBag: Map<string, unknown>): void;
+    chain(sharedDataBag?: Map<string, unknown> | null): void;
     /**
      * @internal
      */
@@ -3610,7 +3610,7 @@ declare class Beat {
     private calculateDuration;
     updateDurations(): void;
     finishTuplet(): void;
-    finish(settings: Settings, sharedDataBag: Map<string, unknown>): void;
+    finish(settings: Settings, sharedDataBag?: Map<string, unknown> | null): void;
     /**
      * Checks whether the current beat is timewise before the given beat.
      * @param beat
@@ -3625,7 +3625,7 @@ declare class Beat {
     isAfter(beat: Beat): boolean;
     hasNoteOnString(noteString: number): boolean;
     getNoteWithRealValue(noteRealValue: number): Note | null;
-    chain(sharedDataBag: Map<string, unknown>): void;
+    chain(sharedDataBag?: Map<string, unknown> | null): void;
 }
 
 /**
@@ -3786,6 +3786,12 @@ declare class MidiTickLookup {
      * @returns The time in midi ticks at which the masterbar is played the first time or 0 if the masterbar is not contained
      */
     getMasterBarStart(bar: MasterBar): number;
+    /**
+     * Gets the start time in midi ticks for a given beat at which the masterbar is played the first time.
+     * @param beat The beat to find the time period for.
+     * @returns The time in midi ticks at which the beat is played the first time or 0 if the beat is not contained
+     */
+    getBeatStart(beat: Beat): number;
     /**
      * Adds a new {@link MasterBarTickLookup} to the lookup table.
      * @param masterBar The item to add.