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

package/dist/alphaTab.js

@@ -1,5 +1,5 @@
 /*!
- * alphaTab v1.6.0-alpha.1421 (develop, build 1421)
+ * alphaTab v1.6.0-alpha.1428 (develop, build 1428)
  *
  * Copyright © 2025, Daniel Kuschny and Contributors, All rights reserved.
  *
@@ -1424,7 +1424,7 @@
              */
             this.modifiedTempo = 0;
             /**
-             * 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.
              */
             this.millisecondOffset = 0;
@@ -7305,6 +7305,61 @@
                 this.tracks[i].finish(settings, sharedDataBag);
             }
         }
+        /**
+         * Applies the given list of {@link FlatSyncPoint} to this song.
+         * @param syncPoints The list of sync points to apply.
+         * @since 1.6.0
+         */
+        applyFlatSyncPoints(syncPoints) {
+            for (const b of this.masterBars) {
+                b.syncPoints = undefined;
+            }
+            for (const syncPoint of syncPoints) {
+                const automation = new Automation();
+                automation.ratioPosition = Math.min(1, Math.max(0, syncPoint.barPosition));
+                automation.type = AutomationType.SyncPoint;
+                automation.syncPointValue = new SyncPointData();
+                automation.syncPointValue.modifiedTempo = syncPoint.modifiedTempo;
+                automation.syncPointValue.millisecondOffset = syncPoint.millisecondOffset;
+                automation.syncPointValue.barOccurence = syncPoint.barOccurence;
+                if (syncPoint.barIndex < this.masterBars.length) {
+                    this.masterBars[syncPoint.barIndex].addSyncPoint(automation);
+                }
+            }
+            for (const b of this.masterBars) {
+                if (b.syncPoints) {
+                    b.syncPoints.sort((a, b) => {
+                        const occurence = a.syncPointValue.barOccurence - b.syncPointValue.barOccurence;
+                        if (occurence !== 0) {
+                            return occurence;
+                        }
+                        return a.ratioPosition - b.ratioPosition;
+                    });
+                }
+            }
+        }
+        /**
+         * Exports all sync points in this song to a {@link FlatSyncPoint} list.
+         * @since 1.6.0
+         */
+        exportFlatSyncPoints() {
+            const syncPoints = [];
+            for (const masterBar of this.masterBars) {
+                const masterBarSyncPoints = masterBar.syncPoints;
+                if (masterBarSyncPoints) {
+                    for (const syncPoint of masterBarSyncPoints) {
+                        syncPoints.push({
+                            barIndex: masterBar.index,
+                            barOccurence: syncPoint.syncPointValue.barOccurence,
+                            barPosition: syncPoint.ratioPosition,
+                            millisecondOffset: syncPoint.syncPointValue.millisecondOffset,
+                            modifiedTempo: syncPoint.syncPointValue.modifiedTempo
+                        });
+                    }
+                }
+            }
+            return syncPoints;
+        }
     }
 
     /**
@@ -13613,6 +13668,7 @@
         XmlNodeType[XmlNodeType["CDATA"] = 3] = "CDATA";
         XmlNodeType[XmlNodeType["Document"] = 4] = "Document";
         XmlNodeType[XmlNodeType["DocumentType"] = 5] = "DocumentType";
+        XmlNodeType[XmlNodeType["Comment"] = 6] = "Comment";
     })(XmlNodeType || (XmlNodeType = {}));
     class XmlNode {
         constructor() {
@@ -14189,7 +14245,7 @@
                             this.indent();
                             for (const child of xml.childNodes) {
                                 // skip text nodes in case of multiple children
-                                if (child.nodeType === XmlNodeType.Element) {
+                                if (child.nodeType === XmlNodeType.Element || child.nodeType === XmlNodeType.Comment) {
                                     this.writeNode(child);
                                 }
                             }
@@ -14220,6 +14276,9 @@
                 case XmlNodeType.DocumentType:
                     this.write(`<!DOCTYPE ${xml.value}>`);
                     break;
+                case XmlNodeType.Comment:
+                    this.write(`<!-- ${xml.value} -->`);
+                    break;
             }
         }
         unindend() {
@@ -16816,7 +16875,7 @@
      * Internal Range: 1 per quarter note
      */
     GpifParser.BendPointValueFactor = 1 / 25.0;
-    // test have shown that Guitar Pro seem to always work with 44100hz for the frame offsets,
+    // tests have shown that Guitar Pro seem to always work with 44100hz for the frame offsets,
     // they are NOT using the sample rate of the input file. 
     // Downsampling a 44100hz ogg to 8000hz and using it in as audio track resulted in the same frame offset when placing sync points.
     GpifParser.SampleRate = 44100;
@@ -22625,6 +22684,8 @@
                 }
             }
             state.syncPointIndex = 0;
+            state.modifiedTempo =
+                state.syncPoints.length > 0 ? state.syncPoints[0].modifiedTempo : state.currentTempo;
         }
         currentTimePositionToTickPosition(timePosition) {
             const state = this._currentState;
@@ -38486,6 +38547,7 @@
                     value.playbackSpeed = this._playbackSpeed;
                     value.isLooping = this._isLooping;
                     value.midiEventsPlayedFilter = this._midiEventsPlayedFilter;
+                    this.ready.trigger();
                 }
                 else {
                     newUnregister.push(value.ready.on(() => {
@@ -43846,6 +43908,9 @@
             const audioElement = document.createElement('audio');
             audioElement.style.display = 'none';
             document.body.appendChild(audioElement);
+            audioElement.addEventListener('seeked', () => {
+                this.updatePosition();
+            });
             audioElement.addEventListener('timeupdate', () => {
                 this.updatePosition();
             });
@@ -60941,9 +61006,9 @@
             print(`build date: ${VersionInfo.date}`);
         }
     }
-    VersionInfo.version = '1.6.0-alpha.1421';
-    VersionInfo.date = '2025-05-22T19:50:36.984Z';
-    VersionInfo.commit = '0b4cd7b2a2c0d244d65c0c0c5254fe4814976bc4';
+    VersionInfo.version = '1.6.0-alpha.1428';
+    VersionInfo.date = '2025-05-29T00:44:50.954Z';
+    VersionInfo.commit = 'fa81a14da248f229511867324cee663ea70a72b3';
 
     /**
      * A factory for custom layout engines.
@@ -61856,18 +61921,24 @@
         writeDom(parent, score) {
             const gpif = parent.addElement('GPIF');
             // just some values at the time this was implemented,
-            gpif.addElement('GPVersion').innerText = '7';
+            gpif.addElement('GPVersion').innerText = '8.1.3';
             const gpRevision = gpif.addElement('GPRevision');
-            gpRevision.innerText = '7';
-            gpRevision.attributes.set('required', '12021');
-            gpRevision.attributes.set('recommended', '12023');
-            gpRevision.innerText = '12025';
-            gpif.addElement('Encoding').addElement('EncodingDescription').innerText = 'GP7';
+            gpRevision.attributes.set('required', '12024');
+            gpRevision.attributes.set('recommended', '13000');
+            gpRevision.innerText = '13007';
+            const encoding = gpif.addElement('Encoding');
+            encoding.addElement('EncodingDescription').innerText = 'GP8';
+            const alphaTabComment = new XmlNode();
+            alphaTabComment.nodeType = XmlNodeType.Comment;
+            alphaTabComment.value = `Written by alphaTab ${VersionInfo.version} (${VersionInfo.commit})`;
+            encoding.addChild(alphaTabComment);
             this.writeScoreNode(gpif, score);
             this.writeMasterTrackNode(gpif, score);
+            this.writeBackingTrackNode(gpif, score);
             this.writeAudioTracksNode(gpif, score);
             this.writeTracksNode(gpif, score);
             this.writeMasterBarsNode(gpif, score);
+            this.writeAssets(gpif, score);
             const bars = gpif.addElement('Bars');
             const voices = gpif.addElement('Voices');
             const beats = gpif.addElement('Beats');
@@ -61890,6 +61961,42 @@
                 }
             }
         }
+        writeAssets(parent, score) {
+            if (!score.backingTrack?.rawAudioFile) {
+                return;
+            }
+            const assets = parent.addElement('Assets');
+            const asset = assets.addElement('Asset');
+            asset.attributes.set('id', this.backingTrackAssetId);
+            this.backingTrackAssetFileName = 'Content/Assets/backing-track';
+            asset.addElement('EmbeddedFilePath').setCData(this.backingTrackAssetFileName);
+        }
+        writeBackingTrackNode(parent, score) {
+            if (!score.backingTrack?.rawAudioFile) {
+                return;
+            }
+            const backingTrackNode = parent.addElement('BackingTrack');
+            const backingTrackAssetId = '0';
+            this.backingTrackAssetId = backingTrackAssetId;
+            backingTrackNode.addElement('IconId').innerText = '21';
+            backingTrackNode.addElement('Color').innerText = '0 0 0';
+            backingTrackNode.addElement('Name').setCData('Audio Track');
+            backingTrackNode.addElement('ShortName').setCData('a.track');
+            backingTrackNode.addElement('PlaybackState').innerText = 'Default';
+            backingTrackNode.addElement('Enabled').innerText = 'true';
+            backingTrackNode.addElement('Source').innerText = 'Local';
+            backingTrackNode.addElement('AssetId').innerText = backingTrackAssetId;
+            const channelStrip = backingTrackNode.addElement('ChannelStrip');
+            channelStrip.addElement('Parameters').innerText =
+                '0.500000 0.500000 0.500000 0.500000 0.500000 0.500000 0.500000 0.500000 0.500000 0.000000 0.500000 0.500000 0.800000 0.500000 0.500000 0.500000';
+            channelStrip.addElement('YouTubeVideoUrl').innerText = '';
+            channelStrip.addElement('Filter').innerText = '6';
+            channelStrip.addElement('FramesPerPixel').innerText = '400';
+            const framePadding = this.backingTrackFramePadding !== undefined ? this.backingTrackFramePadding : 0;
+            backingTrackNode.addElement('FramePadding').innerText = `${framePadding}`;
+            backingTrackNode.addElement('Semitones').innerText = '0';
+            backingTrackNode.addElement('Cents').innerText = '0';
+        }
         writeNoteNode(parent, note) {
             const noteNode = parent.addElement('Note');
             noteNode.attributes.set('id', note.id.toString());
@@ -62546,6 +62653,11 @@
                     initialTempoAutomation.addElement('Text').innerText = score.tempoLabel;
                 }
             }
+            const initialSyncPoint = score.masterBars[0].syncPoints
+                ? score.masterBars[0].syncPoints.find(p => p.ratioPosition === 0 && p.syncPointValue.barOccurence === 0)
+                : undefined;
+            const millisecondPadding = initialSyncPoint ? initialSyncPoint.syncPointValue.millisecondOffset : 0;
+            this.backingTrackFramePadding = (-1 * ((millisecondPadding / 1000) * GpifWriter.SampleRate)) | 0;
             for (const mb of score.masterBars) {
                 for (const automation of mb.tempoAutomations) {
                     const tempoAutomation = automations.addElement('Automation');
@@ -62559,6 +62671,25 @@
                         tempoAutomation.addElement('Text').innerText = automation.text;
                     }
                 }
+                if (mb.syncPoints) {
+                    for (const syncPoint of mb.syncPoints) {
+                        const syncPointAutomation = automations.addElement('Automation');
+                        syncPointAutomation.addElement('Type').innerText = 'SyncPoint';
+                        syncPointAutomation.addElement('Linear').innerText = 'false';
+                        syncPointAutomation.addElement('Bar').innerText = mb.index.toString();
+                        syncPointAutomation.addElement('Position').innerText = syncPoint.ratioPosition.toString();
+                        syncPointAutomation.addElement('Visible').innerText = 'true';
+                        const value = syncPointAutomation.addElement('Value');
+                        value.addElement('BarIndex').innerText = mb.index.toString();
+                        value.addElement('BarOccurrence').innerText = syncPoint.syncPointValue.barOccurence.toString();
+                        value.addElement('ModifiedTempo').innerText = syncPoint.syncPointValue.modifiedTempo.toString();
+                        value.addElement('OriginalTempo').innerText = score.tempo.toString();
+                        const frameOffset = (((syncPoint.syncPointValue.millisecondOffset - millisecondPadding) / 1000) *
+                            GpifWriter.SampleRate) |
+                            0;
+                        value.addElement('FrameOffset').innerText = frameOffset.toString();
+                    }
+                }
             }
         }
         writeAudioTracksNode(parent, score) {
@@ -63209,6 +63340,10 @@
             voiceNode.addElement('Beats').innerText = voice.beats.map(v => v.id).join(' ');
         }
     }
+    // tests have shown that Guitar Pro seem to always work with 44100hz for the frame offsets,
+    // they are NOT using the sample rate of the input file.
+    // Downsampling a 44100hz ogg to 8000hz and using it in as audio track resulted in the same frame offset when placing sync points.
+    GpifWriter.SampleRate = 44100;
     GpifWriter.MidiProgramInfoLookup = new Map([
         [0, new GpifMidiProgramInfo(GpifIconIds.Piano, 'Acoustic Piano')],
         [1, new GpifMidiProgramInfo(GpifIconIds.Piano, 'Acoustic Piano')],
@@ -64946,11 +65081,11 @@
     }
 
     /**
-     * This ScoreExporter can write Guitar Pro 7 (gp) files.
+     * This ScoreExporter can write Guitar Pro 7+ (gp) files.
      */
     class Gp7Exporter extends ScoreExporter {
         get name() {
-            return 'Guitar Pro 7';
+            return 'Guitar Pro 7-8';
         }
         writeScore(score) {
             Logger.debug(this.name, 'Writing data entries');
@@ -64967,6 +65102,9 @@
             fileSystem.writeEntry(new ZipEntry('Content/PartConfiguration', partConfiguration));
             fileSystem.writeEntry(new ZipEntry('Content/LayoutConfiguration', layoutConfiguration));
             fileSystem.writeEntry(new ZipEntry('Content/score.gpif', IOHelper.stringToBytes(gpifXml)));
+            if (gpifWriter.backingTrackAssetFileName) {
+                fileSystem.writeEntry(new ZipEntry(gpifWriter.backingTrackAssetFileName, score.backingTrack.rawAudioFile));
+            }
             fileSystem.end();
         }
     }