alphaTab v1.2.3

[Danielku15]

1.2.3

Even though this is "only" a patch release, there is plenty of stuff to discover.🥳🎉

This release aims to ship all improvements and bugfixes done as part of 1.3 already in 1.2 to keep the 1.3 theme of official Android and iOS Native support.

A big "Thank You" to all people contributing to alphaTab through reporting bugs, bringing in feature ideas and contributing code changes to alphaTab!

Highlights of this release

New Features 💡

• [General] ES6 module flavor build of alphaTab. (Issue: "Cannot read properties of null (reading 'src')" exception thrown when using alphaTab in Javascript module #666, PR: Add ES6 module compilation #678)
• [General] New Event whenever the playback range changes. (Issue: Selection Event #732, PR: Added event for changed playback ranges. #782)
• [General] New Event for obtaining the currently played beats across all tracks and voices. (Issue: Expose the actively played beats through new event #722, PR: Add new event to obtain currently active beats. #878)

• [File Formats] Unicode Characters support in alphaTex. (Issue: AlphaTex not supporting multi-bytes characters in lyrics #579, PR: Add unicode support to alphaTex #580)
• [File Formats] Alternate Endings support in alphaTex. (Issue: Alternative endings for alphaTex #671, PR: alphaTex Alternate Endings #791) Thanks @jonaro00 for this contribution.
• [File Formats] Minor Key Signature support in alphaTex. (Issue: Minor Keys in AlphaTex #875, PR: Add minor keys #880) Thanks @jonaro00 for this contribution.
• [File Formats] Brush Stroke and arpeggio support to alphaTex. (Issue: Add brushes to alphaTex #505, PR: Add brushes and arpeggio to alphaTex #799) Thanks @jonaro00 for this contribution.

• [Rendering] New Options for disabling cursor animations and element highlighting (Issue: Can anything be done about Crackling/Static ocassionally when playing? #558, PR: Browser optimizations  #644)

• [Rendering] Allow the use of multiple font families with fallbacks. (Issue: Web installation causes error on Google Chrome / Ubuntu #546, PR: Allow multiple font families and adapted font loading checks #953)

• [Audio] Use AudioWorklets for audio playback when available. (Issue: Use AudioWorklets for synthesizer #480, PR: Use HTML5 AudioWorklet beside ScriptProcessor for passing audio. #642)

• [Audio] Expose MidiTickLookup for manual lookup of elements by a given midi position. (Discussion: Selection Event #732, Commit: e8b5850)

Improvements 🚀

• [General] Improved WebPack support. We are not yet at 100% to support everything properly (mainly due to missing features in WebPack like AudioWorklets) but things are getting better. We plan to ship some extended examples over at https://github.com/CoderLine/alphaTabSamplesWeb soon.
• [General] Improved Node.js support. (Issue: AlphaTab should be available on node.js #542, PR: Handle node.js environment correctly #544)
• [General] Improved module exports to have better TypeScript compatibility. (Issue: Unable to Use Models in Typescript Project #682, PR: Rework exports to allow using classes in type hints #684)
• [General] Allow dynamic changing of the display of cursors and the cursor colors. (Issue: Enable / disable cursor after alphaTab is loaded #876, PR: Enable / disable cursor after alphaTab is loaded #899)
• [General] More exposed low-level APIs. (Issue: Make ISynthOutput implementations public again.  #897, PR: Expose some more APIs #956)
• [General] Allow dynamic change of the transposition pitches. (Issue: transpositionPitches doesn't work on the fly (dynamically) #896, PR: Update transposition pitches not only on score change #957)

• [Rendering] Render half-note rhythm notation stems different (Issue: Rhythm Notation of half notes must be drawn different to quarter notes #602, PR: Adjusted rendering of half note rhythm stem #605, Discussion: Tab-only mode does not show time duration for whole note #601)
• [Rendering] Avoid grace notes sticking fully to the previous note (Issue: Grace notes should have some padding in front of them #604, PR: Use always width from layout for registering layout info #606)
• [Rendering] Use of native browser smooth scrolling (Issue: Can anything be done about Crackling/Static ocassionally when playing? #558, PR: Browser optimizations  #644)
• [Rendering] Improved element positioning to reduce browser CPU load (Issue: Can anything be done about Crackling/Static ocassionally when playing? #558, PR: Browser optimizations  #644)
• [Rendering] Reduced CPU load on cursor placement (Issue: Can anything be done about Crackling/Static ocassionally when playing? #558, PR: Try to respect current and known next beat on cursor changes. #645)
• [Rendering] Added Virtualized Display of Rendered Partials (Issue: Create native Android integration #532, PR: Add Lazy Rendering  #689)

• [Audio] Avoid delayed audio settings due to buffering (Issue: Setting update becomes laggy #657, PR: Clear buffered samples on audio settings change #686)
• [Audio] Configurable audio buffer size (Issue: Setting updates cut out the playback #736, PR: Make audio buffer configurable #788)
• [Audio] Improved WebAudio context suspend/resume handling (Issue: Improve WebPack Support (Step 1) #760, PR: Improve handling of audio context and related promise handling #768)

Bug Fixes 🕷️

• [General] Fixed wrong decoding of Colors (Issue: Unsupported format for color #387, PR: 543) Thanks @kyledecot for this contribution.
• [General] Fixed wrong Score model when not sending it through serializer (Issue: Score model wrong without sending it through serializer #551, PR: Fixed model inconsistencies without serialization #610)
• [General] Fixed bad detection of note positions (Issue: Bad detection of a note selection on BeatBounds #744, PR: Fix findNoteAtPos logic #746) Thanks @gallegretti for this contribution.
• [General] Allow loading of alphaTab/Skia in Avalonia (Issue: SkiaCanvas constructor fails in WASM (Avalonia UI) #774, PR: Drop manual loading of native Skia lib #789)
• [General] Fix beat removeNote function keeping stringLookup reference (Issue Beat RemoveNote function not working correctly #932, PR: Fix beat removeNote function keeping stringLookup reference #933) Thanks @gallegretti for this contribution.

• [File Formats] Allow Sections to start with a rest in alphaTex (Issue: alphaTex rest after section tag causes parsing error #683, PR: Ensure we don't interpret note symbols as section text #685)
• [File Formats] Errornous Slur handling and improved repeat group calculation (Issue: MusicXML loading error (slurred notes relevant) #865, PR: Fix MusicXML Slurs and Reworked Repeats #898)
• [File Formats] Tempo changes on first bar not handled correctly (Issue: Wrong tempo for first measure in MusicXML file format. #988, PR: Handle first MasterBar Tempo changes correctly #994)
• [File Formats] Ensure Correct Vibrato audio for GP5 files (Issue: Vibrato does not play for more than one bar #1011, PR: Generate vibrato on tied notes like displayed #1014)

• [Rendering] Prevent double printing dialogs/events (Issue: Render related events should not fire on initial empty render #844, PR: Clear various settings during print to avoid double print. #846)
• [Rendering] Corrected wrong placement of key signatures (Issue: #-sign on wrong bass clef line in a G major scale #872, PR: Fix key signature glyph placement #881)
• [Rendering] Corrected wrong placement of brush strokes (Issue: TabBrushGlyph have Bug: when 6str Note heighter than 5str Will happen #935, PR: Select note for brushes based on strings not note-height #955)
• [Rendering] Inability to place the cursor on some beats upon clicking (Issue: Inability to place the cursor on some beats upon clicking #959, PR: Ensure correct BoundsLookup state #960)

• [Audio] Prevent invalid playback ranges when selecting reverse (Issue: Able to make invalid Selection #733, PR: Fix wrong comparison of start/end in reverse selection scenarios #783)
• [Audio] Corrected timesignature generation causing metronome behavior (Issue: Metronome only works on first beat #567, PR: Corrected timesignature generation  #574)
• [Audio] Ensure Player is fully destroyed with the rest of alphaTab (Issue: Web audio stuck after api.destroy() #594, PR: Fully destroy alphaTab player #595)
• [Audio] Reworked playback of count-in and individual notes and beats (Issue: playNote() and playBeat() issues #758, PR: Rework state handling of one-time-midi #787)
• [Audio] Cursor Snaps/Jumps to Next Bar (Issue: Respect correct duration of tick lookup result for caching #976, PR: Cursor Snaps/Jumps to Next Bar #888)

Maintenance 👷‍♂️

• [General] TypeScript upgrade, use override
• [General] Update of Dev and Runtime Dependencies to latest versions.
• [File Formats] AlphaTexImporter corrections and simplifications (PR: AlphaTexImporter corrections and simplifications #852) Thanks @jonaro00 for this contribution.
• [Rendering] Update Visual Test Suite to use Free Fonts (Issue: Update Visual Test Suite to use Free Fonts #559, PR: Update Visual Test Suite to use Free Fonts #560)

All Changes

Issues: v1.2.3

Full Changelog: v1.2.2...v1.2.3

---

This discussion was created from the release alphaTab v1.2.3.

[jonaro00]

@Danielku15 Awesome! 🥳
I can start writing documentation for my alphaTex additions now. Should I PR them to the website's main or develop branch?

[Danielku15]

You can write the docs anytime against the develop branch. I will then merge relevant bits into main. 😉

[goodgame365]

very good