Skip to content

feat: add unplayed frame attribute to mx::api #402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
webern merged 1 commit into from
Aug 18, 2026
Merged

feat: add unplayed frame attribute to mx::api #402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/include/mx/api/ChordData.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ class FrameData

int stringCount;
int fretCount;
// What to display above a string without a frame note, such as "x" for a muted string.
std::optional<std::string> unplayed;
int firstFret;
bool isFirstFretSpecified;
std::vector<FrameNoteData> notes;
Expand All @@ -185,6 +187,7 @@ class FrameData
MXAPI_EQUALS_BEGIN(FrameData)
MXAPI_EQUALS_MEMBER(stringCount)
MXAPI_EQUALS_MEMBER(fretCount)
MXAPI_EQUALS_MEMBER(unplayed)
MXAPI_EQUALS_MEMBER(firstFret)
MXAPI_EQUALS_MEMBER(isFirstFretSpecified)
MXAPI_EQUALS_MEMBER(notes)
Expand Down
2 changes: 1 addition & 1 deletion src/private/mx/api/ChordData.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ FrameNoteData::FrameNoteData()
{
}

FrameData::FrameData() : stringCount{6}, fretCount{4}, firstFret{1}, isFirstFretSpecified{false}, notes{}
FrameData::FrameData() : stringCount{6}, fretCount{4}, unplayed{}, firstFret{1}, isFirstFretSpecified{false}, notes{}
{
}

Expand Down
4 changes: 4 additions & 0 deletions src/private/mx/impl/DirectionReader.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1428,6 +1428,10 @@ void DirectionReader::parseHarmony(const core::Harmony &inHarmony, const core::H
const auto &frame = *inHarmony.frame();
chord.frameData.stringCount = frame.frameStrings();
chord.frameData.fretCount = frame.frameFrets();
if (frame.unplayed().has_value())
{
chord.frameData.unplayed = *frame.unplayed();
}

if (frame.firstFret().has_value())
{
Expand Down
4 changes: 4 additions & 0 deletions src/private/mx/impl/DirectionWriter.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1699,6 +1699,10 @@ std::vector<core::MusicDataChoice> DirectionWriter::createHarmonyElements(int in
core::Frame frame{};
frame.setFrameStrings(chordIter->frameData.stringCount);
frame.setFrameFrets(chordIter->frameData.fretCount);
if (chordIter->frameData.unplayed.has_value())
{
frame.setUnplayed(chordIter->frameData.unplayed);
}

if (chordIter->frameData.isFirstFretSpecified)
{
Expand Down
19 changes: 19 additions & 0 deletions src/private/mxtest/api/HarmonyExtrasApiTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,25 @@ TEST(harmonyInversionRoundTrip, HarmonyExtrasApi)

T_END;

TEST(harmonyFrameUnplayedRoundTrip, HarmonyExtrasApi)
{
auto score = makeScoreWithChord();
auto &chord = chordOf(score);
chord.root = Step::c;
chord.chordKind = ChordKind::major;
chord.hasFrameData = true;
chord.frameData.unplayed = "x";

const auto xml = mxtest::toXml(score);
CHECK(xml.find("unplayed=\"x\"") != std::string::npos);

const auto out = mxtest::roundTrip(score);
CHECK(out.parts.front().measures.front().staves.front().directions.front().chords.front().frameData.unplayed ==
std::optional<std::string>{"x"});
}

T_END;

TEST(harmonyFunctionRoundTrip, HarmonyExtrasApi)
{
auto score = makeScoreWithChord();
Expand Down
Loading