Repository navigation
feat: tablature staff tuning in mx::api - #469
Merged
Merged
Conversation
webern
added
feature
5 tasks done
webern
marked this pull request as ready for review
October 29, 2026 07:10
webern
changed the title
<staff-details> kept <staff-lines> but dropped every <staff-tuning>, so a guitar tab came back with its lines and no record of what the strings are tuned to. StaffData gains staffTunings, a list of the new StaffTuningData (line, step, alter, cents, octave). Like staffLines, it is set on the measure whose attributes carry the staff-details. The reader fills it and the writer emits the tunings between staff-lines and staff-size. The tuning-step, tuning-alter and tuning-octave translation is shared with the existing scordatura reader and writer through TuningFunctions.h, with no change to scordatura behavior or diagnostics. musuite/testTablature1.xml, testTablature2.xml and testTablature3.xml now round-trip and are pinned in the baseline.
webern
force-pushed
the
m/mxdev-stafftune
branch
from
October 30, 2026 08:15
6dd2e37 to
67358c1
Compare
webern
added a commit
that referenced
this pull request
Nov 1, 2026
## Summary The barline documentation in the schema (complexType `barline`) says the location attribute must match where the barline occurs in the musical data, and that a left barline "should be the first element in the measure, aside from the print, bookmark, and link elements." `MeasureWriter` broke both halves of that: - A left barline was written ahead of the measure's `<print>`. It now follows the `<print>` (and still precedes `<attributes>`). - A `location="middle"` barline was written at the end of the measure. It is now written when the write position reaches its tick: before a `<backup>`/`<forward>` that moves past it, and after one that lands on it. A middle barline whose tick no note reaches is still written at the end. Right barlines and barlines with no location are written where they were before. No api change. This also resolves the old TODO in `MeasureWriter.cpp` about barlines landing in the wrong place. Two corpus files now round-trip and are pinned: - lysuite/ly46b_MidmeasureBarline.xml - musetrainer/Bella_Ciao.xml (also relies on the harmony print-frame change in #467) The left-barline change removes a reorder from 7 of the 16 corpus files that have `<print>` followed by a left barline; the rest still fail for other reasons. Known limits, none of which occur in the corpus: a source that puts a middle barline after a `<backup>` gets it written in the earlier voice at the same tick (valid, not byte-identical), and a middle barline at the very end of a multi-voice measure is written before the `<backup>`. ## Testing - [x] New `MeasureWriterTest` cases: left barline after print, left barline without print, middle barline at its tick, after a forward, before a backup, unspecified location stays last, and a middle barline no note reaches is written once at the end - [x] `make api-test` passes (6212 assertions in 723 test cases) - [x] `make api-roundtrip` passes, 447 of 447 pinned files - [x] `make api-roundtrip-discover`: 447 pass, against 445 on the commit below; no file lost its pass - [x] `make fmt-check` passes ## References - Stacked on #469 - Related to #208 (api round-trip pass-list coverage)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<staff-details>kept<staff-lines>but dropped every<staff-tuning>, so a guitar tab cameback with its lines and no record of what the strings are tuned to.
StaffDatagainsstaffTunings, a list of the newStaffTuningData(line, step, alter, cents,octave). Like
staffLines, it is set on the measure whose attributes carry the staff-details andis not carried forward to later measures. The reader honours the
numberattribute on<staff-details>, and reads a<staff-details>that holds only tunings. The writer emits thetunings between
<staff-lines>and<staff-size>, as the schema orders them.The tuning-step / tuning-alter / tuning-octave translation is shared with the existing scordatura
reader and writer through a small header-only helper (
TuningFunctions.h), with no change toscordatura behavior or diagnostics. A separate
StaffTuningDatatype rather than reusingAccordData: a staff tuning has a required line, an accord an optional string number.musuite/testTablature1.xml,testTablature2.xmlandtestTablature3.xmlnow round-trip and arepinned in the baseline.
lysuite/ly71e_TabStaves.xmlandrecsuite/BrookeWestSample.xmllosetheir tuning differences but still fail on other staff-details content (staff-type, capo,
show-frets, line-detail), which is not modeled here.
Testing
MeasureDataTestcases: tuning round trip, alter and cents, tunings without staff-lines,two staves; new
MeasureWriterTestcase for the written<staff-tuning>make api-testpasses (6195 assertions in 716 test cases)make api-roundtrippasses, 445 of 445 pinned filesmake api-roundtrip-discover: 445 pass, no file that passed before now failsCMAKE_UNITY_BUILD_BATCH_SIZE=0) of themxtarget compilesmake fmt-checkpassesReferences