@coderline/alphatab 1.3.0-alpha.870 → 1.3.0-alpha.873

package/dist/alphaTab.d.ts

@@ -5614,80 +5614,97 @@ declare class Environment {
 }
 
 /**
- * Represents the time period, for which all bars of a {@link MasterBar} are played.
+ * Represents the time period, for which one or multiple {@link Beat}s are played
  */
-declare class MasterBarTickLookup {
+declare class BeatTickLookup {
+    private _highlightedBeats;
     /**
-     * Gets or sets the start time in midi ticks at which the MasterBar is played.
+     * Gets or sets the start time in midi ticks at which the given beat is played.
      */
     start: number;
     /**
-     * Gets or sets the end time in midi ticks at which the MasterBar is played.
+     * Gets or sets the end time in midi ticks at which the given beat is played.
      */
     end: number;
     /**
-     * Gets or sets the current tempo when the MasterBar is played.
+     * Gets or sets a list of all beats that should be highlighted when
+     * the beat of this lookup starts playing. This might not mean
+     * the beats start at this position.
      */
-    tempo: number;
+    highlightedBeats: Beat[];
     /**
-     * Gets or sets the MasterBar which is played.
+     * Gets the next BeatTickLookup which comes after this one and is in the same
+     * MasterBarTickLookup.
      */
-    masterBar: MasterBar;
+    nextBeat: BeatTickLookup | null;
     /**
-     * Gets or sets the list of {@link BeatTickLookup} object which define the durations
-     * for all {@link Beats} played within the period of this MasterBar.
+     * Gets the preivous BeatTickLookup which comes before this one and is in the same
+     * MasterBarTickLookup.
      */
-    beats: BeatTickLookup[];
+    previousBeat: BeatTickLookup | null;
     /**
-     * Gets or sets the {@link MasterBarTickLookup} of the next masterbar in the {@link Score}
+     * Gets the tick duration of this lookup.
      */
-    nextMasterBar: MasterBarTickLookup | null;
+    get duration(): number;
+    constructor(start: number, end: number);
     /**
-     * Performs the neccessary finalization steps after all information was written.
+     * Marks the given beat as highlighed as part of this lookup.
+     * @param beat The beat to add.
      */
-    finish(): void;
+    highlightBeat(beat: Beat): void;
     /**
-     * Adds a new {@link BeatTickLookup} to the list of played beats during this MasterBar period.
-     * @param beat
+     * Looks for the first visible beat which starts at this lookup so it can be used for cursor placement.
+     * @param visibleTracks The visible tracks.
+     * @returns The first beat which is visible according to the given tracks or null.
      */
-    addBeat(beat: BeatTickLookup): void;
+    getVisibleBeatAtStart(visibleTracks: Set<number>): Beat | null;
 }
 
 /**
- * Represents the time period, for which a {@link Beat} is played.
+ * Represents the time period, for which all bars of a {@link MasterBar} are played.
  */
-declare class BeatTickLookup {
-    private _highlightedBeats;
+declare class MasterBarTickLookup {
     /**
-     * Gets or sets the index of the lookup within the parent MasterBarTickLookup.
+     * Gets or sets the start time in midi ticks at which the MasterBar is played.
      */
-    index: number;
+    start: number;
     /**
-     * Gets or sets the parent MasterBarTickLookup to which this beat lookup belongs to.
+     * Gets or sets the end time in midi ticks at which the MasterBar is played.
      */
-    masterBar: MasterBarTickLookup;
+    end: number;
     /**
-     * Gets or sets the start time in midi ticks at which the given beat is played.
+     * Gets or sets the current tempo when the MasterBar is played.
      */
-    start: number;
+    tempo: number;
     /**
-     * Gets or sets the end time in midi ticks at which the given beat is played.
+     * Gets or sets the MasterBar which is played.
      */
-    end: number;
+    masterBar: MasterBar;
+    firstBeat: BeatTickLookup | null;
+    lastBeat: BeatTickLookup | null;
     /**
-     * Gets or sets the beat which is played.
+     * Inserts `newNextBeat` after `currentBeat` in the linked list of items and updates.
+     * the `firstBeat` and `lastBeat` respectively too.
+     * @param currentBeat The item in which to insert the new item afterwards
+     * @param newBeat The new item to insert
      */
-    beat: Beat;
+    private insertAfter;
     /**
-     * Gets or sets whether the beat is the placeholder beat for an empty bar.
+       * Inserts `newNextBeat` before `currentBeat` in the linked list of items and updates.
+       * the `firstBeat` and `lastBeat` respectively too.
+       * @param currentBeat The item in which to insert the new item afterwards
+       * @param newBeat The new item to insert
+       */
+    private insertBefore;
+    /**
+     * Gets or sets the {@link MasterBarTickLookup} of the next masterbar in the {@link Score}
      */
-    isEmptyBar: boolean;
+    nextMasterBar: MasterBarTickLookup | null;
     /**
-     * Gets or sets a list of all beats that should be highlighted when
-     * the beat of this lookup starts playing.
+     * Adds a new beat to this masterbar following the slicing logic required by the MidiTickLookup.
+     * @returns The first item of the chain which was affected.
      */
-    beatsToHighlight: Beat[];
-    highlightBeat(beat: Beat): void;
+    addBeat(beat: Beat, start: number, duration: number): void;
 }
 
 /**
@@ -5696,38 +5713,66 @@ declare class BeatTickLookup {
  */
 declare class MidiTickLookupFindBeatResult {
     /**
-     * Gets or sets the beat that is currently played.
-     */
-    get currentBeat(): Beat;
-    /**
-     * Gets or sets the beat that will be played next.
+     * Gets or sets the beat that is currently played and used for the start
+     * position of the cursor animation.
      */
-    get nextBeat(): Beat | null;
+    beat: Beat;
     /**
-     * Gets or sets the duration in milliseconds how long this beat is playing.
+     * Gets or sets the parent MasterBarTickLookup to which this beat lookup belongs to.
      */
-    duration: number;
+    masterBar: MasterBarTickLookup;
     /**
-     * Gets or sets the duration in midi ticks for how long this tick lookup is valid
-     * starting at the `currentBeatLookup.start`
+     * Gets or sets the related beat tick lookup.
      */
-    tickDuration: number;
+    beatLookup: BeatTickLookup;
     /**
-     * Gets or sets the beats ot highlight along the current beat.
+     * Gets or sets the beat that will be played next.
      */
-    beatsToHighlight: Beat[];
+    nextBeat: MidiTickLookupFindBeatResult | null;
     /**
-     * Gets or sets the underlying beat lookup which
-     * was used for building this MidiTickLookupFindBeatResult.
+     * Gets or sets the duration in midi ticks how long this lookup is valid.
      */
-    currentBeatLookup: BeatTickLookup;
+    tickDuration: number;
     /**
-     * Gets or sets the beat lookup for the next beat.
+     * Gets or sets the duration in milliseconds how long this lookup is valid.
      */
-    nextBeatLookup: BeatTickLookup | null;
+    duration: number;
+    get start(): number;
+    get end(): number;
+    constructor(masterBar: MasterBarTickLookup);
 }
 /**
  * This class holds all information about when {@link MasterBar}s and {@link Beat}s are played.
+ *
+ * On top level it is organized into {@link MasterBarTickLookup} objects indicating the
+ * master bar start and end times. This information is used to highlight the currently played bars
+ * and it gives access to the played beats in this masterbar and their times.
+ *
+ * The {@link BeatTickLookup} are then the slices into which the masterbar is separated by the voices and beats
+ * of all tracks. An example how things are organized:
+ *
+ * Time (eighths):  | 01 | 02 | 03 | 04 | 05 | 06 | 07 | 08 | 09 | 10 | 11 | 12 | 13 | 14 | 15 | 16 |
+ *
+ * Track 1:         |        B1         |        B2         |    B3   |    B4   |    B5   |    B6   |
+ * Track 2:         |                  B7                   |         B7        | B9 | B10| B11| B12|
+ * Track 3:         |                                      B13                                      |
+ *
+ * Lookup:          |        L1         |        L2         |    L3    |   L4   | L5 | L6 | L7 | L8 |
+ * Active Beats:
+ * - L1             B1,B7,B13
+ * - L2                                 B2,B7,B13
+ * - L3                                                      B3,B7,B13
+ * - L4                                                                 B4,B7,B13
+ * - L5                                                                          B5,B9,B13
+ * - L6                                                                               B5,B10,B13
+ * - L7                                                                                    B6,B11,B13
+ * - L8                                                                                         B6,B12,B13
+ *
+ * Then during playback we build out of this list {@link MidiTickLookupFindBeatResult} objects which are sepcific
+ * to the visible tracks displayed. This is required because if only Track 2 is displayed we cannot use the the
+ * Lookup L1 alone to determine the start and end of the beat cursor. In this case we will derive a
+ * MidiTickLookupFindBeatResult which holds for Time 01 the lookup L1 as start and L3 as end. This will be used
+ * both for the cursor and beat highlighting.
  */
 declare class MidiTickLookup {
     private _currentMasterBar;
@@ -5742,22 +5787,27 @@ declare class MidiTickLookup {
      * @internal
      */
     readonly masterBars: MasterBarTickLookup[];
-    /**
-     * Performs the neccessary finalization steps after all information was written.
-     * @internal
-     */
-    finish(): void;
     /**
      * Finds the currently played beat given a list of tracks and the current time.
-     * @param tracks The tracks in which to search the played beat for.
+     * @param trackLookup The tracks indices in which to search the played beat for.
      * @param tick The current time in midi ticks.
      * @returns The information about the current beat or null if no beat could be found.
      */
-    findBeat(tracks: Track[], tick: number, currentBeatHint?: MidiTickLookupFindBeatResult | null): MidiTickLookupFindBeatResult | null;
+    findBeat(trackLookup: Set<number>, tick: number, currentBeatHint?: MidiTickLookupFindBeatResult | null): MidiTickLookupFindBeatResult | null;
     private findBeatFast;
+    private fillNextBeat;
     private findBeatSlow;
+    /**
+     * Finds the beat at a given tick position within the known master bar.
+     * @param masterBar
+     * @param currentStartLookup
+     * @param tick
+     * @param visibleTracks
+     * @param fillNext
+     * @returns
+     */
+    private findBeatInMasterBar;
     private createResult;
-    private findNextBeat;
     private findMasterBar;
     /**
      * Gets the {@link MasterBarTickLookup} for a given masterbar at which the masterbar is played the first time.
@@ -5782,11 +5832,7 @@ declare class MidiTickLookup {
      * @param masterBar The item to add.
      */
     addMasterBar(masterBar: MasterBarTickLookup): void;
-    /**
-     * Adds the given {@link BeatTickLookup} to the current {@link MidiTickLookup}.
-     * @param beat The lookup to add.
-     */
-    addBeat(beat: BeatTickLookup): void;
+    addBeat(beat: Beat, start: number, duration: number): void;
 }
 
 /**
@@ -6369,6 +6415,7 @@ declare class ActiveBeatsChangedEventArgs {
 declare class AlphaTabApiBase<TSettings> {
     private _startTime;
     private _trackIndexes;
+    private _trackIndexLookup;
     private _isDestroyed;
     /**
      * Gets the UI facade to use for interacting with the user interface.
@@ -6823,7 +6870,6 @@ declare class MidiFileGenerator {
     private _settings;
     private _handler;
     private _currentTempo;
-    private _currentBarRepeatLookup;
     private _programsPerChannel;
     /**
      * Gets a lookup object which can be used to quickly find beats and bars