feat: expose writtenKey for transposing instruments (v1.2.0) - #3
Conversation
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.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
8857240 to
14459f9
Compare
There was a problem hiding this comment.
💡 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".
| "shortname": "Alto Rec.", | ||
| "type": "pitched", | ||
| "premium": true, | ||
| "writtenKey": "F" |
There was a problem hiding this comment.
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 👍 / 👎.
Adds an optional
writtenKeyto transposing instruments: the key their parts are usually written in (Bbfor a clarinet,Ffor a horn), spelled like the OMRtransposeKey(^[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-metasync-public(flat/music!446, ED-1222). 26 instruments carry a key, premium variants included.v1.2.0tag 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.