Skip to content

feat: expose writtenKey for transposing instruments (v1.2.0) - #3

Merged
gierschv merged 2 commits into
masterfrom
feat/written-key
Sep 28, 2026
Merged

gierschv merged 2 commits into
masterfrom
feat/written-key

Conversation

@gierschv

Copy link
Copy Markdown
Member

Adds an optional writtenKey to transposing instruments: the key their parts are usually written in (Bb for a clarinet, F for a horn), spelled like the OMR transposeKey (^[A-G](b|#)?$). Concert-pitch instruments, octave transposers included (piccolo, guitar, contrabass), carry none.

  • src/types.ts, schema, README: new optional field.
  • data/: regenerated from instruments-meta sync-public (flat/music!446, ED-1222). 26 instruments carry a key, premium variants included.
  • The regeneration also picks up the Behind Bars family order from ED-1193 (woodwinds first), which had not been published yet. That's why the data diff is large.
  • Version bumped to 1.2.0. Publishing happens on the v1.2.0 tag after merge.

Consumers: Opuscan Mac (and later Windows) read the written key for the OMR review's "how is this part printed?" question, replacing their hardcoded tables.

Add an optional `writtenKey` to each transposing instrument: the key its
parts are usually written in (`Bb` for a clarinet, `F` for a horn), spelled
like the OMR `transposeKey`. Concert-pitch instruments, octave transposers
included (piccolo, guitar, contrabass), carry none.

Data regenerated from instruments-meta (getWrittenKey, ED-1222), which
also picks up the Behind Bars family order from ED-1193.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-28T15:32:02.935371Z 4a7e5b6 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@gierschv
gierschv merged commit 6fb613d into master Sep 28, 2026
4 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 4a7e5b6bae

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread data/instruments.json
"shortname": "Alto Rec.",
"type": "pitched",
"premium": true,
"writtenKey": "F"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Omit writtenKey for the concert-pitch alto recorder

When processing an alto-recorder part, this reports an F transposition even though modern alto recorder notation is written at sounding (concert) pitch; “in F” describes its fingering/lowest note rather than a notation transposition. This contradicts the new contract that concert-pitch instruments omit writtenKey, so OMR consumers using the field to interpret how the part is printed can transpose these scores incorrectly. Remove this property from the base catalog and its localized copies.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant