docs(player): the catalog is a package, not an unfinished port - #25
Merged
Conversation
The Generators section described a port from Deckard stalled at tier 1, with two tiers
'not yet ported'. That stopped being true when @spacedevin/deck-synths shipped from this
repo — all 33 voices are here, patch and matrixFm included.
Says what is actually left instead: this package still carries its own gameBoyDmg,
gbaDirectSound and basicOsc, and they are not interchangeable with the catalog's copies
because these return { stopTime, disconnects } for the caller to prune while the catalog's
self-clean with a wall-clock setTimeout. That return contract is what makes
renderDeckToBuffer and the Node tests work — a timer means nothing inside an
OfflineAudioContext — so consolidating means retrofitting all 33 first.
Also corrects the out-of-scope line: voice implementations are out of scope here because
they live in the sibling package, not because catalogs are forbidden.
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.
The Generators section still described a source-level port from Deckard that stalled at tier 1, with two tiers marked
not yet ported. That stopped being true when@spacedevin/deck-synthsshipped from this repo in #23 — all 33 voices are here now,patchandmatrixFmincluded.Replaces the tier table with what is actually left:
This package still carries its own
gameBoyDmg,gbaDirectSoundandbasicOscundersrc/generators/, and they are not drop-in interchangeable with the catalog's copies. These return{ stopTime, disconnects }and let the caller prune; the catalog's voices self-clean with a wall-clocksetTimeout. That return contract is precisely what makesrenderDeckToBufferand the Node tests possible — a timer has no meaning inside anOfflineAudioContext— so consolidating means retrofitting all 33 voices to it first and moving the timer policy to the host's call site.Writing that down matters because the next person to look at this will otherwise assume the two sets of voices are equivalent and swap them.
Also corrects the out-of-scope bullet: voice implementations are out of scope here because they live in the sibling package, not because instrument catalogs are forbidden.
Docs only. Player suite 46/46.