@coderline/alphatab 1.6.0-alpha.1428 → 1.6.0-alpha.1432

package/dist/alphaTab.d.ts

@@ -3014,6 +3014,155 @@ declare enum AlphaTabSystemExclusiveEvents {
     Rest = 1
 }
 
+/**
+ * This importer can parse alphaTex markup into a score structure.
+ */
+declare class AlphaTexImporter extends ScoreImporter {
+    private static readonly Eof;
+    private _trackChannel;
+    private _score;
+    private _currentTrack;
+    private _currentStaff;
+    private _barIndex;
+    private _voiceIndex;
+    private _input;
+    private _ch;
+    private _curChPos;
+    private _line;
+    private _col;
+    private _lastValidSpot;
+    private _sy;
+    private _syData;
+    private _allowNegatives;
+    private _allowFloat;
+    private _allowTuning;
+    private _currentDuration;
+    private _currentDynamics;
+    private _currentTuplet;
+    private _lyrics;
+    private _staffHasExplicitDisplayTransposition;
+    private _staffHasExplicitTuning;
+    private _staffTuningApplied;
+    private _percussionArticulationNames;
+    private _sustainPedalToBeat;
+    private _slurs;
+    private _articulationValueToIndex;
+    private _accidentalMode;
+    private _syncPoints;
+    logErrors: boolean;
+    get name(): string;
+    initFromString(tex: string, settings: Settings): void;
+    readScore(): Score;
+    private syncPoints;
+    private syncPoint;
+    private error;
+    private errorMessage;
+    /**
+     * Initializes the song with some required default values.
+     * @returns
+     */
+    private createDefaultScore;
+    private newTrack;
+    /**
+     * Converts a clef string into the clef value.
+     * @param str the string to convert
+     * @returns the clef value
+     */
+    private parseClefFromString;
+    /**
+     * Converts a clef tuning into the clef value.
+     * @param i the tuning value to convert
+     * @returns the clef value
+     */
+    private parseClefFromInt;
+    private parseTripletFeelFromString;
+    private parseTripletFeelFromInt;
+    /**
+     * Converts a keysignature string into the assocciated value.
+     * @param str the string to convert
+     * @returns the assocciated keysignature value
+     */
+    private parseKeySignature;
+    private parseKeySignatureType;
+    /**
+     * Reads, saves, and returns the next character of the source stream.
+     */
+    private nextChar;
+    /**
+     * Saves the current position, line, and column.
+     * All parsed data until this point is assumed to be valid.
+     */
+    private saveValidSpot;
+    /**
+     * Reads, saves, and returns the next terminal symbol.
+     */
+    private newSy;
+    private readNumberOrName;
+    /**
+     * Checks if the given character is a valid letter for a name.
+     * (no control characters, whitespaces, numbers or dots)
+     */
+    private static isNameLetter;
+    private static isTerminal;
+    private static isWhiteSpace;
+    private isDigit;
+    /**
+     * Reads a string from the stream.
+     * @returns the read string.
+     */
+    private readName;
+    private metaData;
+    headerFooterStyle(element: ScoreSubElement): void;
+    private parseTrackNamePolicy;
+    private parseTrackNameMode;
+    private parseTrackNameOrientation;
+    private handleStaffMeta;
+    private handleAccidentalMode;
+    private makeCurrentStaffPitched;
+    /**
+     * Encodes a given string to a shorthand text form without spaces or special characters
+     */
+    private static toArticulationId;
+    private applyPercussionStaff;
+    private chordProperties;
+    private bars;
+    private trackStaffMeta;
+    private handleNewVoice;
+    private beginStaff;
+    private trackProperties;
+    private staffProperties;
+    private bar;
+    private newBar;
+    private beat;
+    private beatDuration;
+    private beatEffects;
+    /**
+     * Tries to apply a beat effect to the given beat.
+     * @returns true if a effect could be applied, otherwise false
+     */
+    private applyBeatEffect;
+    private parseBracketExtendMode;
+    private parseFermataFromString;
+    private parseClefOttavaFromString;
+    private getChordId;
+    private static applyTuplet;
+    private isNoteText;
+    private note;
+    private noteEffects;
+    private harmonicValue;
+    private toFinger;
+    private parseDuration;
+    private parseBendStyle;
+    private parseBendType;
+    private barMeta;
+    private parseBarLineStyle;
+    private parseSimileMarkFromString;
+    private handleDirections;
+    private readTempoAutomation;
+    private applyAlternateEnding;
+    private parseWhammyType;
+}
+
 /**
  * Automations are used to change the behaviour of a song.
  * @cloneable
@@ -3092,17 +3241,48 @@ declare class BackingTrack {
  * Rerpresents a point to sync the alphaTab time axis with an external backing track.
  */
 declare class BackingTrackSyncPoint {
-    tick: number;
-    data: SyncPointData;
-    constructor(tick: number, data: SyncPointData);
-}
-
-declare class BackingTrackSyncPointWithTime {
-    alphaTabTick: number;
-    alphaTabTime: number;
-    modifiedTempo: number;
-    millisecondOffset: number;
-    constructor(tick: number, time: number, modifiedTempo: number, millisecondOffset: number);
+    /**
+     * The index of the masterbar to which this sync point belongs to.
+     * @remarks
+     * This property is purely informative for external use like in editors.
+     * It has no impact to the synchronization itself.
+     */
+    masterBarIndex: number;
+    /**
+     * The occurence of the masterbar to which this sync point belongs to. The occurence
+     * is 0-based and increases with every repeated play of a masterbar (e.g. on repeats or jumps).
+     * @remarks
+     * This property is purely informative for external use like in editors.
+     * It has no impact to the synchronization itself.
+     */
+    masterBarOccurence: number;
+    /**
+     * The BPM the synthesizer has at the exact tick position of this sync point.
+     */
+    synthBpm: number;
+    /**
+     * The millisecond time position of the synthesizer when this sync point is reached.
+     */
+    synthTime: number;
+    /**
+     * The midi tick position of the synthesizer when this sync point is reached.
+     */
+    synthTick: number;
+    /**
+     * The millisecond time in the external media marking the synchronization point.
+     */
+    syncTime: number;
+    /**
+     * The BPM the song will have virtually after this sync point to align the external media time axis
+     * with the one from the synthesizer.
+     */
+    syncBpm: number;
+    /**
+     * Updates the synchronization BPM that will apply after this sync point.
+     * @param nextSyncPointSynthTime The synthesizer time of the next sync point after this one.
+     * @param nextSyncPointSyncTime The synchronization time of the next sync point after this one.
+     */
+    updateSyncBpm(nextSyncPointSynthTime: number, nextSyncPointSyncTime: number): void;
 }
 
 /**
@@ -3180,6 +3360,11 @@ declare class Bar {
      * Whether this bar is fully empty (not even having rests).
      */
     get isEmpty(): boolean;
+    /**
+     * Whether this bar has any changes applied which are not related to the voices in it.
+     * (e.g. new key signatures)
+     */
+    get hasChanges(): boolean;
     /**
      * Whether this bar is empty or has only rests.
      */
@@ -6341,6 +6526,7 @@ export declare class Environment {
      * @partial
      */
     private static printPlatformInfo;
+    /* Excluded from this release type: prepareForPostMessage */
 }
 
 export declare namespace exporter {
@@ -6492,13 +6678,7 @@ declare interface FlatSyncPoint {
      */
     barOccurence: number;
     /**
-     * The modified tempo at which the cursor should move (aka. the tempo played within the external audio track).
-     * This information is used together with normal tempo changes to calculate how much faster/slower the
-     * cursor playback is performed to align with the audio track.
-     */
-    modifiedTempo: number;
-    /**
-     * The uadio offset marking the position within the audio track in milliseconds.
+     * The audio offset marking the position within the audio track in milliseconds.
      * This information is used to regularly sync (or on seeking) to match a given external audio time axis with the internal time axis.
      */
     millisecondOffset: number;
@@ -7644,7 +7824,8 @@ export declare namespace importer {
     export {
         ScoreImporter,
         ScoreLoader,
-        UnsupportedFormatError
+        UnsupportedFormatError,
+        AlphaTexImporter
     }
 }
 
@@ -8658,6 +8839,12 @@ declare class MasterBar {
      * @json_ignore
      */
     index: number;
+    /**
+     * Whether the masterbar is has any changes applied to it (e.g. tempo changes, time signature changes etc)
+     * The first bar is always considered changed due to initial setup of values. It does not consider
+     * elements like whether the tempo really changes to the previous bar.
+     */
+    get hasChanges(): boolean;
     /**
      * The key signature used on all bars.
      * @deprecated Use key signatures on bar level
@@ -9271,7 +9458,11 @@ declare class MidiFileGenerator {
      * @returns The generated sync points for usage in the backing track playback.
      */
     static generateSyncPoints(score: Score): BackingTrackSyncPoint[];
+    /* Excluded from this release type: buildModifiedTempoLookup */
     private static playThroughSong;
+    private static processBarTime;
+    private static processBarTimeWithSyncPoints;
+    private static processBarTimeNoSyncPoints;
     private static toChannelShort;
     private generateMasterBar;
     private generateBar;
@@ -9415,7 +9606,7 @@ declare class MidiFileSequencerTempoChange {
 declare class MidiSequencerState {
     tempoChanges: MidiFileSequencerTempoChange[];
     tempoChangeIndex: number;
-    syncPoints: BackingTrackSyncPointWithTime[];
+    syncPoints: BackingTrackSyncPoint[];
     firstProgramEventPerChannel: Map<number, SynthEvent>;
     firstTimeSignatureNumerator: number;
     firstTimeSignatureDenominator: number;
@@ -12923,6 +13114,13 @@ declare abstract class ScoreLayout {
  * available importers
  */
 declare class ScoreLoader {
+    /**
+     * Loads the given alphaTex string.
+     * @param tex The alphaTex string.
+     * @param settings The settings to use for parsing.
+     * @returns The parsed {@see Score}.
+     */
+    static loadAlphaTex(tex: string, settings?: Settings): Score;
     /**
      * Loads a score asynchronously from the given datasource
      * @param path the source path to load the binary file from
@@ -13656,12 +13854,6 @@ declare class SyncPointData {
      * Indicates for which repeat occurence this sync point is valid (e.g. 0 on the first time played, 1 on the second time played)
      */
     barOccurence: number;
-    /**
-     * The modified tempo at which the cursor should move (aka. the tempo played within the external audio track).
-     * This information is used together with normal tempo changes to calculate how much faster/slower the
-     * cursor playback is performed to align with the audio track.
-     */
-    modifiedTempo: number;
     /**
      * The audio offset marking the position within the audio track in milliseconds.
      * This information is used to regularly sync (or on seeking) to match a given external audio time axis with the internal time axis.