feat(importer): read TablEdit (.tef) files

README.md

@@ -2,7 +2,7 @@
 
 **Music notation, rendered as a first-class SDK.**
 
-alphaTab renders interactive sheet music and guitar tablature from Guitar Pro, MusicXML, Capella and alphaTex files, and plays it back with a built-in synthesizer or in sync with your own audio and video. One TypeScript core ships for the web, .NET and Android, with no runtime dependencies and TypeScript types included. Open source since 2010.
+alphaTab renders interactive sheet music and guitar tablature from Guitar Pro, MusicXML, Capella, TablEdit and alphaTex files, and plays it back with a built-in synthesizer or in sync with your own audio and video. One TypeScript core ships for the web, .NET and Android, with no runtime dependencies and TypeScript types included. Open source since 2010.
 
 [![npm](https://img.shields.io/npm/v/@coderline/alphatab?label=npm)](https://www.npmjs.com/package/@coderline/alphatab)
 [![npm downloads](https://img.shields.io/npm/dm/@coderline/alphatab?label=downloads)](https://www.npmjs.com/package/@coderline/alphatab)
@@ -29,7 +29,7 @@ alphaTab renders interactive sheet music and guitar tablature from Guitar Pro, M
 
 | | Formats |
 |---|---|
-| **Reads** | Guitar Pro 3–8 (`.gp3` `.gp4` `.gp5` `.gpx` `.gp`), MusicXML (`.xml` `.musicxml` `.mxl`), Capella (`.capx`), [alphaTex](https://alphatab.net/docs/alphatex/introduction) |
+| **Reads** | Guitar Pro 3–8 (`.gp3` `.gp4` `.gp5` `.gpx` `.gp`), MusicXML (`.xml` `.musicxml` `.mxl`), Capella (`.capx`), TablEdit (`.tef`), [alphaTex](https://alphatab.net/docs/alphatex/introduction) |
 | **Writes** | Guitar Pro 7+ (`.gp`), alphaTex, MIDI, audio (PCM samples) |
 
 ## Quick start

packages/alphatab/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@coderline/alphatab",
     "version": "1.10.0",
-    "description": "Render and play interactive sheet music and guitar tablature from Guitar Pro, MusicXML, Capella and alphaTex, in the browser, Node.js, .NET and Android.",
+    "description": "Render and play interactive sheet music and guitar tablature from Guitar Pro, MusicXML, Capella, TablEdit and alphaTex, in the browser, Node.js, .NET and Android.",
     "keywords": [
         "music-notation",
         "sheet-music",

packages/alphatab/src/Environment.ts

@@ -7,6 +7,7 @@ import { Gp7To8Importer } from '@coderline/alphatab/importer/Gp7To8Importer';
 import { GpxImporter } from '@coderline/alphatab/importer/GpxImporter';
 import { MusicXmlImporter } from '@coderline/alphatab/importer/MusicXmlImporter';
 import type { ScoreImporter } from '@coderline/alphatab/importer/ScoreImporter';
+import { TablEditImporter } from '@coderline/alphatab/importer/TablEditImporter';
 import { LayoutMode } from '@coderline/alphatab/LayoutMode';
 import { Logger } from '@coderline/alphatab/Logger';
 import type { Font } from '@coderline/alphatab/model/Font';
@@ -22,9 +23,7 @@ import { SkiaCanvas } from '@coderline/alphatab/platform/skia/SkiaCanvas';
 import { CssFontSvgCanvas } from '@coderline/alphatab/platform/svg/CssFontSvgCanvas';
 import { AlphaSynthWebWorker } from '@coderline/alphatab/platform/worker/AlphaSynthWebWorker';
 import { AlphaTabWebWorker } from '@coderline/alphatab/platform/worker/AlphaTabWebWorker';
-import type {
-    IAlphaTabWorkerGlobalScope
-} from '@coderline/alphatab/platform/worker/AlphaTabWorkerProtocol';
+import type { IAlphaTabWorkerGlobalScope } from '@coderline/alphatab/platform/worker/AlphaTabWorkerProtocol';
 import { type BarRendererFactory, EffectBandMode } from '@coderline/alphatab/rendering/BarRendererFactory';
 import { alternateEndingsEffectInfo } from '@coderline/alphatab/rendering/effects/AlternateEndingsEffectInfo';
 import { barNumberEffectInfo } from '@coderline/alphatab/rendering/effects/BarNumberEffectInfo';
@@ -35,6 +34,10 @@ import { chordsEffectInfo } from '@coderline/alphatab/rendering/effects/ChordsEf
 import { crescendoEffectInfo } from '@coderline/alphatab/rendering/effects/CrescendoEffectInfo';
 import { directionsEffectInfo } from '@coderline/alphatab/rendering/effects/DirectionsEffectInfo';
 import { dynamicsEffectInfo } from '@coderline/alphatab/rendering/effects/DynamicsEffectInfo';
+import {
+    hammerPullLabelEffectInfo,
+    slideLabelEffectInfo
+} from '@coderline/alphatab/rendering/effects/EffectSlurLabelEffectInfo';
 import { fadeEffectInfo } from '@coderline/alphatab/rendering/effects/FadeEffectInfo';
 import { fermataEffectInfo } from '@coderline/alphatab/rendering/effects/FermataEffectInfo';
 import { fingeringEffectInfo } from '@coderline/alphatab/rendering/effects/FingeringEffectInfo';
@@ -58,7 +61,6 @@ import { createSlightNoteVibratoEffectInfo } from '@coderline/alphatab/rendering
 import { sustainPedalEffectInfo } from '@coderline/alphatab/rendering/effects/SustainPedalEffectInfo';
 import { tabWhammyEffectInfo } from '@coderline/alphatab/rendering/effects/TabWhammyEffectInfo';
 import { tapEffectInfo } from '@coderline/alphatab/rendering/effects/TapEffectInfo';
-import { hammerPullLabelEffectInfo, slideLabelEffectInfo } from '@coderline/alphatab/rendering/effects/EffectSlurLabelEffectInfo';
 import { tempoEffectInfo } from '@coderline/alphatab/rendering/effects/TempoEffectInfo';
 import { textEffectInfo } from '@coderline/alphatab/rendering/effects/TextEffectInfo';
 import { trillEffectInfo } from '@coderline/alphatab/rendering/effects/TrillEffectInfo';
@@ -404,6 +406,7 @@ export class Environment {
             new Gp7To8Importer(),
             new MusicXmlImporter(),
             new CapellaImporter(),
+            new TablEditImporter(),
             new AlphaTexImporter()
         ];
     }

packages/alphatab/src/importer/AlphaTexImporter.ts

@@ -300,7 +300,10 @@ export class AlphaTexImporter extends ScoreImporter implements IAlphaTexImporter
         }
         for (const [sustainPedal, beat] of this._state.sustainPedalToBeat) {
             if (sustainPedal.ratioPosition < 1) {
-                sustainPedal.ratioPosition = ModelUtils.tickToRatioPosition(beat.voice.bar.masterBar, beat.playbackStart);
+                sustainPedal.ratioPosition = ModelUtils.tickToRatioPosition(
+                    beat.voice.bar.masterBar,
+                    beat.playbackStart
+                );
             }
         }
         return this._state.score;
@@ -718,7 +721,10 @@ export class AlphaTexImporter extends ScoreImporter implements IAlphaTexImporter
 
                     if (node.noteString) {
                         const percussionNoteString: number = node.noteString!.value;
-                        if (percussionNoteString < 1 || percussionNoteString > this._state.currentStaff!.tuning.length) {
+                        if (
+                            percussionNoteString < 1 ||
+                            percussionNoteString > this._state.currentStaff!.tuning.length
+                        ) {
                             this.addSemanticDiagnostic({
                                 code: AlphaTexDiagnosticCode.AT208,
                                 message: `Note string is out of range. Available range: 1-${this._state.currentStaff!.tuning.length}`,

packages/alphatab/src/importer/BinaryStylesheet.ts

@@ -1,10 +1,11 @@
-import { type HeaderFooterStyle, type Score, ScoreSubElement } from '@coderline/alphatab/model/Score';
+import { AlphaTabError, AlphaTabErrorType } from '@coderline/alphatab/AlphaTabError';
+import { GpBinaryHelpers } from '@coderline/alphatab/importer/Gp3To5Importer';
 import { ByteBuffer } from '@coderline/alphatab/io/ByteBuffer';
 import { IOHelper } from '@coderline/alphatab/io/IOHelper';
-import { GpBinaryHelpers } from '@coderline/alphatab/importer/Gp3To5Importer';
+import type { IWriteable } from '@coderline/alphatab/io/IWriteable';
 import { BendPoint } from '@coderline/alphatab/model/BendPoint';
-import { Bounds } from '@coderline/alphatab/rendering/utils/Bounds';
 import { Color } from '@coderline/alphatab/model/Color';
+import { ModelUtils } from '@coderline/alphatab/model/ModelUtils';
 import {
     BarNumberDisplay,
     type BracketExtendMode,
@@ -13,10 +14,9 @@ import {
     TrackNamePolicy,
     TuningDisplayMode
 } from '@coderline/alphatab/model/RenderStylesheet';
-import type { IWriteable } from '@coderline/alphatab/io/IWriteable';
-import { AlphaTabError, AlphaTabErrorType } from '@coderline/alphatab/AlphaTabError';
-import { ModelUtils } from '@coderline/alphatab/model/ModelUtils';
+import { type HeaderFooterStyle, type Score, ScoreSubElement } from '@coderline/alphatab/model/Score';
 import { TextAlign } from '@coderline/alphatab/platform/ICanvas';
+import { Bounds } from '@coderline/alphatab/rendering/utils/Bounds';
 
 /**
  * @internal
@@ -625,7 +625,7 @@ export class BinaryStylesheet {
                 binaryStylesheet.addValue('Global/TuningDisplayMode', 0, DataType.Integer);
                 break;
         }
-        
+
         const writer = ByteBuffer.withCapacity(128);
         binaryStylesheet.writeTo(writer);
         return writer.toArray();

packages/alphatab/src/importer/CapellaImporter.ts

@@ -1,14 +1,11 @@
+import { CapellaParser } from '@coderline/alphatab/importer/CapellaParser';
 import { ScoreImporter } from '@coderline/alphatab/importer/ScoreImporter';
 import { UnsupportedFormatError } from '@coderline/alphatab/importer/UnsupportedFormatError';
-
-import type { Score } from '@coderline/alphatab/model/Score';
-
+import { IOHelper } from '@coderline/alphatab/io/IOHelper';
 import { Logger } from '@coderline/alphatab/Logger';
-
-import { ZipReader } from '@coderline/alphatab/zip/ZipReader';
+import type { Score } from '@coderline/alphatab/model/Score';
 import type { ZipEntry } from '@coderline/alphatab/zip/ZipEntry';
-import { IOHelper } from '@coderline/alphatab/io/IOHelper';
-import { CapellaParser } from '@coderline/alphatab/importer/CapellaParser';
+import { ZipReader } from '@coderline/alphatab/zip/ZipReader';
 
 /**
  * This ScoreImporter can read Capella (cap/capx) files.

packages/alphatab/src/importer/CapellaParser.ts

@@ -1,4 +1,5 @@
 import { UnsupportedFormatError } from '@coderline/alphatab/importer/UnsupportedFormatError';
+import { Logger } from '@coderline/alphatab/Logger';
 import { AccentuationType } from '@coderline/alphatab/model/AccentuationType';
 import { Automation, AutomationType } from '@coderline/alphatab/model/Automation';
 import { Bar, BarLineStyle } from '@coderline/alphatab/model/Bar';
@@ -7,25 +8,23 @@ import { Chord } from '@coderline/alphatab/model/Chord';
 import { Clef } from '@coderline/alphatab/model/Clef';
 import { CrescendoType } from '@coderline/alphatab/model/CrescendoType';
 import { Duration } from '@coderline/alphatab/model/Duration';
+import { DynamicValue } from '@coderline/alphatab/model/DynamicValue';
+import { Fermata, FermataType } from '@coderline/alphatab/model/Fermata';
+import type { KeySignature } from '@coderline/alphatab/model/KeySignature';
 import { MasterBar } from '@coderline/alphatab/model/MasterBar';
+import { ModelUtils } from '@coderline/alphatab/model/ModelUtils';
 import { Note } from '@coderline/alphatab/model/Note';
+import { Ottavia } from '@coderline/alphatab/model/Ottavia';
 import { Score } from '@coderline/alphatab/model/Score';
 import type { Staff } from '@coderline/alphatab/model/Staff';
 import { Track } from '@coderline/alphatab/model/Track';
 import { VibratoType } from '@coderline/alphatab/model/VibratoType';
 import { Voice } from '@coderline/alphatab/model/Voice';
+import { TextAlign } from '@coderline/alphatab/platform/ICanvas';
+import { BeamDirection } from '@coderline/alphatab/rendering/utils/BeamDirection';
 import type { Settings } from '@coderline/alphatab/Settings';
 import { XmlDocument } from '@coderline/alphatab/xml/XmlDocument';
-
 import type { XmlNode } from '@coderline/alphatab/xml/XmlNode';
-import { BeamDirection } from '@coderline/alphatab/rendering/utils/BeamDirection';
-import { TextAlign } from '@coderline/alphatab/platform/ICanvas';
-import { ModelUtils } from '@coderline/alphatab/model/ModelUtils';
-import { Logger } from '@coderline/alphatab/Logger';
-import { Fermata, FermataType } from '@coderline/alphatab/model/Fermata';
-import { DynamicValue } from '@coderline/alphatab/model/DynamicValue';
-import { Ottavia } from '@coderline/alphatab/model/Ottavia';
-import type { KeySignature } from '@coderline/alphatab/model/KeySignature';
 
 /**
  * @internal
@@ -500,7 +499,13 @@ export class CapellaParser {
                 break;
         }
     }
-    private _parseVoices(staffId: string, staff: Staff, systemElement: XmlNode, firstBarIndex: number, element: XmlNode) {
+    private _parseVoices(
+        staffId: string,
+        staff: Staff,
+        systemElement: XmlNode,
+        firstBarIndex: number,
+        element: XmlNode
+    ) {
         let voiceIndex = 0;
         for (const c of element.childElements()) {
             switch (c.localName) {

packages/alphatab/src/importer/Gp7To8Importer.ts

@@ -1,17 +1,14 @@
 import { BinaryStylesheet } from '@coderline/alphatab/importer/BinaryStylesheet';
 import { GpifParser } from '@coderline/alphatab/importer/GpifParser';
+import { LayoutConfiguration } from '@coderline/alphatab/importer/LayoutConfiguration';
 import { PartConfiguration } from '@coderline/alphatab/importer/PartConfiguration';
 import { ScoreImporter } from '@coderline/alphatab/importer/ScoreImporter';
 import { UnsupportedFormatError } from '@coderline/alphatab/importer/UnsupportedFormatError';
-
-import type { Score } from '@coderline/alphatab/model/Score';
-
+import { IOHelper } from '@coderline/alphatab/io/IOHelper';
 import { Logger } from '@coderline/alphatab/Logger';
-
-import { ZipReader } from '@coderline/alphatab/zip/ZipReader';
+import type { Score } from '@coderline/alphatab/model/Score';
 import type { ZipEntry } from '@coderline/alphatab/zip/ZipEntry';
-import { IOHelper } from '@coderline/alphatab/io/IOHelper';
-import { LayoutConfiguration } from '@coderline/alphatab/importer/LayoutConfiguration';
+import { ZipReader } from '@coderline/alphatab/zip/ZipReader';
 
 /**
  * This ScoreImporter can read Guitar Pro 7 and 8 (gp) files.
@@ -66,10 +63,10 @@ export class Gp7To8Importer extends ScoreImporter {
         // the score information as XML we need to parse.
         Logger.trace(this.name, 'Start Parsing score.gpif');
         const gpifParser: GpifParser = new GpifParser();
-        gpifParser.loadAsset = (fileName) => {
-            if(entryLookup.has(fileName)) {
+        gpifParser.loadAsset = fileName => {
+            if (entryLookup.has(fileName)) {
                 return entryLookup.get(fileName)!.data;
-            };
+            }
             return undefined;
         };
         gpifParser.parseXml(xml, this.settings);
@@ -78,7 +75,10 @@ export class Gp7To8Importer extends ScoreImporter {
 
         if (binaryStylesheetData) {
             Logger.trace(this.name, 'Start Parsing BinaryStylesheet');
-            const stylesheet: BinaryStylesheet = new BinaryStylesheet(binaryStylesheetData, this.settings.importer.maxDecodingBufferSize);
+            const stylesheet: BinaryStylesheet = new BinaryStylesheet(
+                binaryStylesheetData,
+                this.settings.importer.maxDecodingBufferSize
+            );
             stylesheet.apply(score);
             Logger.trace(this.name, 'BinaryStylesheet parsed');
         }

packages/alphatab/src/importer/GpifParser.ts

@@ -2817,8 +2817,7 @@ export class GpifParser {
                 if (isPercussion) {
                     staff.stringTuning.tunings = [0, 0, 0, 0, 0, 0];
                 } else {
-                    const fallback =
-                        staff.index === 0 ? Tuning.getDefaultTuningFor(6) : Tuning.getDefaultTuningFor(5);
+                    const fallback = staff.index === 0 ? Tuning.getDefaultTuningFor(6) : Tuning.getDefaultTuningFor(5);
                     if (fallback !== null) {
                         staff.stringTuning.tunings = fallback.tunings.slice();
                         staff.stringTuning.name = fallback.name;

packages/alphatab/src/importer/GpxImporter.ts

@@ -1,13 +1,13 @@
 import { BinaryStylesheet } from '@coderline/alphatab/importer/BinaryStylesheet';
 import { GpifParser } from '@coderline/alphatab/importer/GpifParser';
 import { GpxFileSystem } from '@coderline/alphatab/importer/GpxFileSystem';
+import { LayoutConfiguration } from '@coderline/alphatab/importer/LayoutConfiguration';
 import { PartConfiguration } from '@coderline/alphatab/importer/PartConfiguration';
 import { ScoreImporter } from '@coderline/alphatab/importer/ScoreImporter';
-import type { Score } from '@coderline/alphatab/model/Score';
-import { Logger } from '@coderline/alphatab/Logger';
 import { UnsupportedFormatError } from '@coderline/alphatab/importer/UnsupportedFormatError';
 import { IOHelper } from '@coderline/alphatab/io/IOHelper';
-import { LayoutConfiguration } from '@coderline/alphatab/importer/LayoutConfiguration';
+import { Logger } from '@coderline/alphatab/Logger';
+import type { Score } from '@coderline/alphatab/model/Score';
 
 /**
  * This ScoreImporter can read Guitar Pro 6 (gpx) files.
@@ -70,7 +70,10 @@ export class GpxImporter extends ScoreImporter {
 
         if (binaryStylesheetData) {
             Logger.trace(this.name, 'Start Parsing BinaryStylesheet');
-            const binaryStylesheet: BinaryStylesheet = new BinaryStylesheet(binaryStylesheetData, this.settings.importer.maxDecodingBufferSize);
+            const binaryStylesheet: BinaryStylesheet = new BinaryStylesheet(
+                binaryStylesheetData,
+                this.settings.importer.maxDecodingBufferSize
+            );
             binaryStylesheet.apply(score);
             Logger.trace(this.name, 'BinaryStylesheet parsed');
         }

packages/alphatab/src/importer/LayoutConfiguration.ts

@@ -1,7 +1,7 @@
+import type { PartConfiguration } from '@coderline/alphatab/importer/PartConfiguration';
 import { ByteBuffer } from '@coderline/alphatab/io/ByteBuffer';
 import { IOHelper } from '@coderline/alphatab/io/IOHelper';
 import type { Score } from '@coderline/alphatab/model/Score';
-import type { PartConfiguration } from '@coderline/alphatab/importer/PartConfiguration';
 
 // PartConfiguration File Format Notes.
 // Based off Guitar Pro 8

packages/alphatab/src/importer/MusicXmlImporter.ts

@@ -24,7 +24,7 @@ import { Clef } from '@coderline/alphatab/model/Clef';
 import { Direction } from '@coderline/alphatab/model/Direction';
 import { Duration } from '@coderline/alphatab/model/Duration';
 import { DynamicValue } from '@coderline/alphatab/model/DynamicValue';
-import { FermataType, Fermata } from '@coderline/alphatab/model/Fermata';
+import { Fermata, FermataType } from '@coderline/alphatab/model/Fermata';
 import { Fingers } from '@coderline/alphatab/model/Fingers';
 import { GolpeType } from '@coderline/alphatab/model/GolpeType';
 import { GraceType } from '@coderline/alphatab/model/GraceType';
@@ -3084,11 +3084,7 @@ export class MusicXmlImporter extends ScoreImporter {
 
         // on a staff with tuning, string and pitch define the tab position of a note written without fret
         // (e.g. dead notes written by Guitar Pro 5)
-        if (
-            !note.isStringed &&
-            (note.isDead || !note.isPercussion) &&
-            note.beat.voice.bar.staff.tuning.length > 0
-        ) {
+        if (!note.isStringed && (note.isDead || !note.isPercussion) && note.beat.voice.bar.staff.tuning.length > 0) {
             const fret = this._calculatePitchedNoteValue(note) - note.stringTuning;
             if (fret >= 0) {
                 note.fret = fret;

packages/alphatab/src/importer/ScoreImporter.ts

@@ -1,4 +1,4 @@
-import { ThrowingReadable, type IReadable } from '@coderline/alphatab/io/IReadable';
+import { type IReadable, ThrowingReadable } from '@coderline/alphatab/io/IReadable';
 import { Score } from '@coderline/alphatab/model/Score';
 import type { Settings } from '@coderline/alphatab/Settings';