@coderline/alphatab-monaco 1.7.0-alpha.1626 → 1.7.0-alpha.1627

package/dist/types/alphatab/src/synth/BackingTrackPlayer.d.ts

@@ -1,53 +0,0 @@
-import type { IEventEmitterOfT } from "./../EventEmitter";
-import type { MidiFile } from "./../midi/MidiFile";
-import type { BackingTrack } from "./../model/BackingTrack";
-import type { Score } from "./../model/Score";
-import { AlphaSynthBase } from "./AlphaSynth";
-import type { BackingTrackSyncPoint } from "./IAlphaSynth";
-import type { ISynthOutput } from "./ISynthOutput";
-/**
- * A synth output for playing backing tracks.
- * @public
- */
-export interface IBackingTrackSynthOutput extends ISynthOutput {
-    /**
-     * An event fired when the playback time changes. The time is in absolute milliseconds.
-     */
-    readonly timeUpdate: IEventEmitterOfT<number>;
-    /**
-     * The total duration of the backing track in milliseconds.
-     */
-    readonly backingTrackDuration: number;
-    /**
-     * The playback rate at which the output should playback.
-     */
-    playbackRate: number;
-    /**
-     * The volume at which the output should play (0-1)
-     */
-    masterVolume: number;
-    /**
-     * Instructs the output to seek to the given time position.
-     * @param time The absolute time in milliseconds.
-     */
-    seekTo(time: number): void;
-    /**
-     * Instructs the output to load the given backing track.
-     * @param backingTrack The backing track to load.
-     */
-    loadBackingTrack(backingTrack: BackingTrack): void;
-}
-/**
- * @internal
- */
-export declare class BackingTrackPlayer extends AlphaSynthBase {
-    private _backingTrackOutput;
-    constructor(backingTrackOutput: IBackingTrackSynthOutput, bufferTimeInMilliseconds: number);
-    protected updateMasterVolume(value: number): void;
-    protected updatePlaybackSpeed(value: number): void;
-    protected onSampleRequest(): void;
-    loadMidiFile(midi: MidiFile): void;
-    protected updateTimePosition(timePosition: number, isSeek: boolean): void;
-    loadBackingTrack(score: Score): void;
-    updateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void;
-}

package/dist/types/alphatab/src/synth/ExternalMediaPlayer.d.ts

@@ -1,55 +0,0 @@
-import { type IBackingTrackSynthOutput, BackingTrackPlayer } from "./BackingTrackPlayer";
-/**
- * A custom handler for integrating alphaTab with an external media source.
- * @public
- */
-export interface IExternalMediaHandler {
-    /**
-     * The total duration of the backing track in milliseconds.
-     */
-    readonly backingTrackDuration: number;
-    /**
-     * The playback rate at which the output should playback.
-     */
-    playbackRate: number;
-    /**
-     * The volume at which the output should play (0-1)
-     */
-    masterVolume: number;
-    /**
-     * Instructs the output to seek to the given time position.
-     * @param time The absolute time in milliseconds.
-     */
-    seekTo(time: number): void;
-    /**
-     * Instructs the external media to start the playback.
-     */
-    play(): void;
-    /**
-     * Instructs the external media to pause the playback.
-     */
-    pause(): void;
-}
-/**
- * A output handling the playback via an external media.
- * @public
- */
-export interface IExternalMediaSynthOutput extends IBackingTrackSynthOutput {
-    /**
-     * The handler to which the media control will be delegated.
-     */
-    handler: IExternalMediaHandler | undefined;
-    /**
-     * Updates the playback position from the external media source.
-     * @param currentTime The current time in the external media.
-     */
-    updatePosition(currentTime: number): void;
-}
-/**
- * @internal
- */
-export declare class ExternalMediaPlayer extends BackingTrackPlayer {
-    get handler(): IExternalMediaHandler | undefined;
-    set handler(value: IExternalMediaHandler | undefined);
-    constructor(bufferTimeInMilliseconds: number);
-}

package/dist/types/alphatab/src/synth/IAlphaSynth.d.ts

@@ -1,271 +0,0 @@
-import type { MidiFile } from "./../midi/MidiFile";
-import type { PlaybackRange } from "./PlaybackRange";
-import type { PlayerState } from "./PlayerState";
-import type { PlayerStateChangedEventArgs } from "./PlayerStateChangedEventArgs";
-import type { PlaybackRangeChangedEventArgs } from "./PlaybackRangeChangedEventArgs";
-import type { PositionChangedEventArgs } from "./PositionChangedEventArgs";
-import type { IEventEmitter, IEventEmitterOfT } from "./../EventEmitter";
-import type { LogLevel } from "./../LogLevel";
-import type { MidiEventsPlayedEventArgs } from "./MidiEventsPlayedEventArgs";
-import type { MidiEventType } from "./../midi/MidiEvent";
-import type { ISynthOutput } from "./ISynthOutput";
-import type { Score } from "./../model/Score";
-/**
- * Rerpresents a point to sync the alphaTab time axis with an external backing track.
- * @public
- */
-export declare class BackingTrackSyncPoint {
-    /**
-     * 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;
-}
-/**
- * The public API interface for interacting with the synthesizer.
- * @public
- */
-export interface IAlphaSynth {
-    /**
-     * Gets or sets whether the synthesizer is ready for interaction. (output and worker are initialized)
-     */
-    readonly isReady: boolean;
-    /**
-     * Gets or sets whether the synthesizer is ready for playback. (output, worker are initialized, soundfont and midi are loaded)
-     */
-    readonly isReadyForPlayback: boolean;
-    /**
-     * Gets the current player state.
-     */
-    readonly state: PlayerState;
-    /**
-     * Gets or sets the loging level.
-     */
-    logLevel: LogLevel;
-    /**
-     * Gets or sets the current master volume as percentage. (range: 0.0-3.0, default 1.0)
-     */
-    masterVolume: number;
-    /**
-     * Gets or sets the metronome volume. (range: 0.0-3.0, default 0.0)
-     */
-    metronomeVolume: number;
-    /**
-     * Gets or sets the current playback speed as percentage. (range: 0.125-8.0, default: 1.0)
-     */
-    playbackSpeed: number;
-    /**
-     * Gets or sets the position within the song in midi ticks.
-     */
-    tickPosition: number;
-    /**
-     * Gets or sets the position within the song in milliseconds.
-     */
-    timePosition: number;
-    /**
-     * The information about the main song loaded (does not account for "one time midis" or "count in").
-     */
-    readonly loadedMidiInfo?: PositionChangedEventArgs;
-    /**
-     * The latest time information of the played song.
-     */
-    readonly currentPosition: PositionChangedEventArgs;
-    /**
-     * Gets or sets the range of the song that should be played. Set this to null
-     * to play the whole song.
-     */
-    playbackRange: PlaybackRange | null;
-    /**
-     * Gets or sets whether the playback should automatically restart after it finished.
-     */
-    isLooping: boolean;
-    /**
-     * Gets or sets volume of the metronome during count-in. (range: 0.0-3.0, default 0.0 - no count in)
-     * @since 1.1.0
-     */
-    countInVolume: number;
-    /**
-     * Gets or sets the midi events which will trigger the `midiEventsPlayed` event.
-     */
-    midiEventsPlayedFilter: MidiEventType[];
-    /**
-     * Gets the output used by alphaSynth.
-     */
-    readonly output: ISynthOutput;
-    /**
-     * Destroys the synthesizer and all related components
-     * @since 0.9.6
-     */
-    destroy(): void;
-    /**
-     * Starts the playback if possible
-     * @returns true if the playback was started, otherwise false. Reasons for not starting can be that the player is not ready or already playing.
-     */
-    play(): boolean;
-    /**
-     * Pauses the playback if was running
-     */
-    pause(): void;
-    /**
-     * Starts the playback if possible, pauses the playback if was running
-     */
-    playPause(): void;
-    /**
-     * Stopps the playback
-     */
-    stop(): void;
-    /**
-     * Stops any ongoing playback and plays the given midi file instead.
-     * @param midi The midi file to play
-     */
-    playOneTimeMidiFile(midi: MidiFile): void;
-    /**
-     * Loads a soundfont from the given data
-     * @param data a byte array to load the data from
-     * @param append Whether to fully replace or append the data from the given soundfont.
-     */
-    loadSoundFont(data: Uint8Array, append: boolean): void;
-    /**
-     * Resets all loaded soundfonts as if they were not loaded.
-     */
-    resetSoundFonts(): void;
-    /**
-     * Loads the given midi file structure.
-     * @param midi
-     */
-    loadMidiFile(midi: MidiFile): void;
-    /**
-     * Loads the synchronization information from the given score (used for backing tracks and external media).
-     * @param score
-     */
-    loadBackingTrack(score: Score): void;
-    /**
-     * Updates the points used to synchronize the backing track with the synthesized audio for correct cursor placement.
-     * @param syncPoints
-     */
-    updateSyncPoints(syncPoints: BackingTrackSyncPoint[]): void;
-    /**
-     * Applies the given transposition pitches to be used during playback.
-     * @param transpositionPitches a map defining the transposition pitches for midi channel.
-     */
-    applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
-    /**
-     * Sets the transposition pitch of a given channel. This pitch is additionally applied beside the
-     * ones applied already via {@link applyTranspositionPitches}.
-     * @param channel The channel number
-     * @param semitones The number of semitones to apply as pitch offset.
-     */
-    setChannelTranspositionPitch(channel: number, semitones: number): void;
-    /**
-     * Sets the mute state of a channel.
-     * @param channel The channel number
-     * @param mute true if the channel should be muted, otherwise false.
-     */
-    setChannelMute(channel: number, mute: boolean): void;
-    /**
-     * Resets the mute/solo state of all channels
-     */
-    resetChannelStates(): void;
-    /**
-     * Gets the solo state of a channel.
-     * @param channel The channel number
-     * @param solo true if the channel should be played solo, otherwise false.
-     */
-    setChannelSolo(channel: number, solo: boolean): void;
-    /**
-     * Gets or sets the current and initial volume of the given channel.
-     * @param channel The channel number.
-     * @param volume The volume of of the channel (0.0-1.0)
-     */
-    setChannelVolume(channel: number, volume: number): void;
-    /**
-     * This event is fired when the player is ready to be interacted with.
-     */
-    readonly ready: IEventEmitter;
-    /**
-     * This event is fired when all required data for playback is loaded and ready.
-     */
-    readonly readyForPlayback: IEventEmitter;
-    /**
-     * This event is fired when the playback of the whole song finished.
-     * @eventProperty
-     */
-    readonly finished: IEventEmitter;
-    /**
-     * This event is fired when the SoundFont needed for playback was loaded.
-     * @eventProperty
-     */
-    readonly soundFontLoaded: IEventEmitter;
-    /**
-     * This event is fired when the loading of the SoundFont failed.
-     * @eventProperty
-     */
-    readonly soundFontLoadFailed: IEventEmitterOfT<Error>;
-    /**
-     * This event is fired when the Midi file needed for playback was loaded.
-     * @eventProperty
-     */
-    readonly midiLoaded: IEventEmitterOfT<PositionChangedEventArgs>;
-    /**
-     * This event is fired when the loading of the Midi file failed.
-     * @eventProperty
-     */
-    readonly midiLoadFailed: IEventEmitterOfT<Error>;
-    /**
-     * This event is fired when the playback state changed.
-     * @eventProperty
-     */
-    readonly stateChanged: IEventEmitterOfT<PlayerStateChangedEventArgs>;
-    /**
-     * This event is fired when the current playback position of/ the song changed.
-     * @eventProperty
-     */
-    readonly positionChanged: IEventEmitterOfT<PositionChangedEventArgs>;
-    /**
-     * The event is fired when certain midi events were sent to the audio output device for playback.
-     * @eventProperty
-     */
-    readonly midiEventsPlayed: IEventEmitterOfT<MidiEventsPlayedEventArgs>;
-    /**
-     * The event is fired when the playback range within the player was updated.
-     * @eventProperty
-     */
-    readonly playbackRangeChanged: IEventEmitterOfT<PlaybackRangeChangedEventArgs>;
-}

package/dist/types/alphatab/src/synth/IAudioExporter.d.ts

@@ -1,127 +0,0 @@
-import type { MidiFile } from "./../midi/MidiFile";
-import type { BackingTrackSyncPoint } from "./IAlphaSynth";
-import type { PlaybackRange } from "./PlaybackRange";
-/**
- * The options controlling how to export the audio.
- * @public
- */
-export declare class AudioExportOptions {
-    /**
-     * The soundfonts to load and use for generating the audio.
-     * If not provided, the already loaded soundfonts of the synthesizer will be used.
-     * If no existing synthesizer is initialized, the generated audio might not contain any hearable audio.
-     */
-    soundFonts?: Uint8Array[];
-    /**
-     * The output sample rate.
-     * @default `44100`
-     */
-    sampleRate: number;
-    /**
-     * Whether to respect sync point information during export.
-     * @default `true`
-     * @remarks
-     * If the song contains sync point information for synchronization with an external media,
-     * this option allows controlling whether the synthesized audio is aligned with these points.
-     *
-     * This is useful when mixing the exported audio together with external media, keeping the same timing.
-     *
-     * Disable this option if you want the original/exact timing as per music sheet in the exported audio.
-     */
-    useSyncPoints: boolean;
-    /**
-     * The current master volume as percentage. (range: 0.0-3.0, default 1.0)
-     */
-    masterVolume: number;
-    /**
-     * The metronome volume. (range: 0.0-3.0, default 0.0)
-     */
-    metronomeVolume: number;
-    /**
-     * The range of the song that should be exported. Set this to null
-     * to play the whole song.
-     */
-    playbackRange?: PlaybackRange;
-    /**
-     * The volume for individual tracks as percentage (range: 0.0-3.0).
-     * @remarks
-     * The key is the track index, and the value is the relative volume.
-     * The configured volume (as per data model) still applies, this is an additional volume control.
-     * If no custom value is set, 100% is used.
-     * No values from the currently active synthesizer are applied.
-     *
-     * The meaning of the key changes when used with AlphaSynth directly, in this case the key is the midi channel .
-     */
-    trackVolume: Map<number, number>;
-    /**
-     * The additional semitone pitch transpose to apply for individual tracks.
-     * @remarks
-     * The key is the track index, and the value is the number of semitones to apply.
-     * No values from the currently active synthesizer are applied.
-     *
-     * The meaning of the key changes when used with AlphaSynth directly, in this case the key is the midi channel .
-     */
-    trackTranspositionPitches: Map<number, number>;
-}
-/**
- * Represents a single chunk of audio produced.
- * @public
- */
-export declare class AudioExportChunk {
-    /**
-     * The generated samples for the requested chunk.
-     */
-    samples: Float32Array;
-    /**
-     * The current time position within the song in milliseconds.
-     */
-    currentTime: number;
-    /**
-     * The total length of the song in milliseconds.
-     */
-    endTime: number;
-    /**
-     * The current time position within the song in midi ticks.
-     */
-    currentTick: number;
-    /**
-     * The total length of the song in midi ticks.
-     */
-    endTick: number;
-}
-/**
- * A exporter which can be used to obtain the synthesized audio for custom processing.
- * @public
- */
-export interface IAudioExporter extends Disposable {
-    /**
-     * Renders the next chunk of audio and provides it as result.
-     *
-     * @param milliseconds The rough number of milliseconds that should be synthesized and exported as chunk.
-     * @returns The requested chunk holding the samples and time information.
-     * If the song completed playback `undefined` is returned indicating the end.
-     * The provided audio might not be exactly the requested number of milliseconds as the synthesizer internally
-     * uses a fixed block size of 64 samples for synthesizing audio. Depending on the sample rate
-     * slightly longer audio is contained in the result.
-     *
-     * When the song ends, the chunk might contain less than the requested duration.
-     */
-    render(milliseconds: number): Promise<AudioExportChunk | undefined>;
-    destroy(): void;
-}
-/**
- * This is the internal worker interface implemented by IAudioExporters and consists
- * of the internal APIs needed to spawn new exporters. Its mainly used to simplify
- * the public API visible when using exporters.
- * @public
- */
-export interface IAudioExporterWorker extends IAudioExporter {
-    /**
-     * Initializes the worker.
-     * @param options The options to use
-     * @param midi The midi file to load
-     * @param syncPoints The sync points of the song (if any)
-     * @param transpositionPitches The initial transposition pitches for the midi file.
-     */
-    initialize(options: AudioExportOptions, midi: MidiFile, syncPoints: BackingTrackSyncPoint[], transpositionPitches: Map<number, number>): Promise<void>;
-}

package/dist/types/alphatab/src/synth/IAudioSampleSynthesizer.d.ts

@@ -1,126 +0,0 @@
-import type { Hydra } from "./soundfont/Hydra";
-import type { SynthEvent } from "./synthesis/SynthEvent";
-/**
- * Classes implementing this interface can act as main audio synthesis engine
- * within alphaSynth.
- * @internal
- */
-export interface IAudioSampleSynthesizer {
-    /**
-     * The master volume to produce.
-     */
-    masterVolume: number;
-    /**
-     * The volume of metronome ticks.
-     */
-    metronomeVolume: number;
-    /**
-     * The output sample rate which is produced.
-     */
-    readonly outSampleRate: number;
-    /**
-     * The current tempo according to the processed midi events (used for metronome event generation)
-     */
-    readonly currentTempo: number;
-    /**
-     * The current time signature numerator according to the processed midi events  (used for metronome event generation)
-     */
-    readonly timeSignatureNumerator: number;
-    /**
-     * The current time signature denominator according to the processed midi events  (used for metronome event generation)
-     */
-    readonly timeSignatureDenominator: number;
-    /**
-     * The number of voices which are currently active in the syntheiszer and still producing audio.
-     */
-    readonly activeVoiceCount: number;
-    /**
-     * Ensures for all active notes a note-off is issued to stop playing the keys.
-     * @param immediate Whether the stop should happen immediately or with sustain->release.
-     */
-    noteOffAll(immediate: boolean): void;
-    /**
-     * Stop all playing notes immediatly and reset all channel parameters but keeps user
-     * defined settings
-     */
-    resetSoft(): void;
-    /**
-     * Resets all loaded presets.
-     */
-    resetPresets(): void;
-    /**
-     * Loads the presets from the given SoundFont hydra structure.
-     * @param hydra  The SoundFont hydra structure.
-     * @param instrumentPrograms The used instrument programs to load the samples for.
-     * @param percussionKeys The instrument keys used.
-     * @param append Whether the presets should be appended or whether they should replace all loaded ones.
-     */
-    loadPresets(hydra: Hydra, instrumentPrograms: Set<number>, percussionKeys: Set<number>, append: boolean): void;
-    /**
-     * Configures the channel used to generate metronome sounds.
-     * @param metronomeVolume The volume for the channel.
-     */
-    setupMetronomeChannel(metronomeVolume: number): void;
-    /**
-     * Synthesizes the given number of samples without producing an output (e.g. on seeking)
-     * @param sampleCount The number of samples to synthesize.
-     */
-    synthesizeSilent(sampleCount: number): void;
-    /**
-     * Processes the given synth event.
-     * @param synthEvent The synth event.
-     */
-    dispatchEvent(synthEvent: SynthEvent): void;
-    /**
-     * Synthesizes the given number of samples into the provided output buffer.
-     * @param buffer The buffer to fill.
-     * @param bufferPos The offset in the buffer to start writing into.
-     * @param sampleCount The number of samples to synthesize.
-     */
-    synthesize(buffer: Float32Array, bufferPos: number, sampleCount: number): SynthEvent[];
-    /**
-     * Applies the given transposition pitches used for general pitch changes that should be applied to the song.
-     * Used for general transpositions applied to the file.
-     * @param transpositionPitches A map defining for a given list of midi channels the number of semitones that should be adjusted.
-     */
-    applyTranspositionPitches(transpositionPitches: Map<number, number>): void;
-    /**
-     * Sets the transposition pitch of a given channel. This pitch is additionally applied beside the
-     * ones applied already via {@link applyTranspositionPitches}.
-     * @param channel The channel number
-     * @param semitones The number of semitones to apply as pitch offset.
-     */
-    setChannelTranspositionPitch(channel: number, semitones: number): void;
-    /**
-     * Sets the mute state of a channel.
-     * @param channel The channel number
-     * @param mute true if the channel should be muted, otherwise false.
-     */
-    channelSetMute(channel: number, mute: boolean): void;
-    /**
-     * Gets the solo state of a channel.
-     * @param channel The channel number
-     * @param solo true if the channel should be played solo, otherwise false.
-     */
-    channelSetSolo(channel: number, solo: boolean): void;
-    /**
-     * Resets the mute/solo state of all channels
-     */
-    resetChannelStates(): void;
-    /**
-     * Gets or sets the current and initial volume of the given channel.
-     * @param channel The channel number.
-     * @param volume The volume of of the channel (0.0-1.0)
-     */
-    channelSetMixVolume(channel: number, volume: number): void;
-    /**
-     * Checks whether the synth has loaded the samples for a given midi program.
-     * @param program The program to check.
-     */
-    hasSamplesForProgram(program: number): boolean;
-    /**
-     * Checks whether the synth has loaded the samples for a given percussion key.
-     * @param key The midi key defining the percussion instrument.
-     */
-    hasSamplesForPercussion(key: number): boolean;
-}