Skip to content
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

Jump to bottom

message names and message objects are a mess #1141

Open
baconpaul opened this issue Aug 18, 2024 · 2 comments
Open

message names and message objects are a mess #1141

baconpaul opened this issue Aug 18, 2024 · 2 comments
Labels
Code Refactoring General code refactoring and cleanup issues like names, unused variables, warnings, fixme

Comments

@baconpaul
Copy link
Contributor

the a2s and s2a ones are fine but

all the c2s and s2c messages and associated objects have incoherent names.

easy to fix/refactor in clion so do it one day, with a rubric for how to create names, which you add as a comment.
@baconpaul baconpaul added the Code Refactoring General code refactoring and cleanup issues like names, unused variables, warnings, fixme label Aug 18, 2024
@baconpaul
Copy link
Contributor Author

Probably do at same time as #1111

baconpaul added a commit to baconpaul/shortcircuit-xt that referenced this issue Aug 20, 2024
@baconpaul
Async and Message Naming Rubric
8043059 
1. Make setState (which sends an UpdatEngine to the serialization
   thread) wait for the unstream to complete to correctly
   meet the plugin api requirement of synchronous set state.
   Closes surge-synthesizer#1157

2. Add a rubric for how message names should be set, and start
   a few, but not many. Addresses surge-synthesizer#1141. Did a partial merge since
   I had started but the new name had only been applied to set engine
   state and didn't want conflict pain in the future.
@baconpaul baconpaul mentioned this issue Aug 20, 2024
Merged
baconpaul added a commit that referenced this issue Aug 20, 2024
@baconpaul
Async and Message Naming Rubric (#1160)
2273203 
1. Make setState (which sends an UpdatEngine to the serialization
   thread) wait for the unstream to complete to correctly
   meet the plugin api requirement of synchronous set state.
   Closes #1157

2. Add a rubric for how message names should be set, and start
   a few, but not many. Addresses #1141. Did a partial merge since
   I had started but the new name had only been applied to set engine
   state and didn't want conflict pain in the future.
baconpaul added a commit to baconpaul/shortcircuit-xt that referenced this issue Aug 28, 2024
@baconpaul
More work on message name coherence
93a033e 
This continues the march to clean up 18 months of message names with
no rubric rhyme or reason. but its tedious work so stalled out a
bit furhter down. Addresses surge-synthesizer#1141
@baconpaul baconpaul mentioned this issue Aug 28, 2024
Merged
baconpaul added a commit that referenced this issue Aug 28, 2024
@baconpaul
More work on message name coherence (#1212)
149b953 
This continues the march to clean up 18 months of message names with
no rubric rhyme or reason. but its tedious work so stalled out a
bit furhter down. Addresses #1141
@baconpaul
Copy link
Contributor Author

While in there clean up associated sample set name

Screenshot 2024-08-30 at 9 49 22 AM

Red box is Sample which itself contains channel, bitrate, bitdepth, etc and sample data.
Green box is the variant playback information currently called AssociatedSample. It hasa Sample
Blue box is the set of variantes in the zone, currently called AssociatedSampleSet. It hasa vector of AssociatedSamples

AssociatedSampleSet is a terrible name since its not a set.
AssociatedSample is an OK name but VariantData would be better.
Image
So probably "SingleVariantData" and "Variants" would be the right names

baconpaul added a commit to baconpaul/shortcircuit-xt that referenced this issue Aug 31, 2024
@baconpaul
Rename AssociatedSampleEtc to VariantEtc in Zone
ebf02ea 
Zone.h now has two classes Variants and SingleVariant, which
used to be called AssociatedSampleSet and AssociatedSample

Variants now has a member .variants rather than .samples

It streams as "variants" rather than "samples" (but unstreams
as either for backwards compat)

maxSamplePerZone is now maxVariantsPerZone

Addresses surge-synthesizer#1141
@baconpaul baconpaul mentioned this issue Aug 31, 2024
Merged
baconpaul added a commit that referenced this issue Aug 31, 2024
@baconpaul
Rename AssociatedSampleEtc to VariantEtc in Zone (#1230)
286b6f7 
Zone.h now has two classes Variants and SingleVariant, which
used to be called AssociatedSampleSet and AssociatedSample

Variants now has a member .variants rather than .samples

It streams as "variants" rather than "samples" (but unstreams
as either for backwards compat)

maxSamplePerZone is now maxVariantsPerZone

Addresses #1141
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Code Refactoring General code refactoring and cleanup issues like names, unused variables, warnings, fixme
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@baconpaul