Refactoring round 10 covers everything since round 9 (808e1ee): 110
commits with about 47 000 new lines, nearly all of them sound, sound
FX, instruments, patterns and songs. Behaviour is unchanged.
Duplicate code (jscpd over src, 50 tokens, TypeScript only, measured
on 808e1ee and here alike: 47 clones / 426 lines before, 33 / 245
after; round 9 itself ended at 22 / 160 by this count):
- PreviewParams (new, editor/soundfx) is the header's parameter bar
of the Sound FX and the Instrument tab: values, defaults, fields
and the voices a moved field reaches. Both tabs had it line for
line.
- fxWorklet: an Effect base runs the bit crusher, phaser, flanger,
limiter, LFO and bus shifter, a Source base the pitch player and
the Chip. Start is the one wait for a voice's first sample, which
four processors wrote out each.
- nodes/shared has checkPort, detachedPort, fxParamsPort and
letRingPort. The Play and Stop nodes of sounds, notes, patterns and
songs spelled each port out, up to five times.
- parameterValues builds both Sound FX parameters and Instrument
parameters, which differed in name and text only.
- SetLoopCommand sets the ruler loop of a pattern or a song. It
replaces SetPatternLoopCommand and SetSongLoopCommand.
- addLink in music/routing is the one rule for a link that both the
song routing and the Master routing keep.
- eqCurves works out each band and their sum for the EQ tab, which
did that in its drawing code. It replaces eqCurveDb, which only a
test called.
- Smaller ones: the eight neighbour directions of a tile cell, and
drawFloatingBox for the shadowed box of Popup and FloatWindow.
- Left on purpose: Play pattern and Play song stay two parallel node
definitions, and the smaller clones under ten lines stay.
Architecture:
- SoundLibrary.ts goes from 2897 to 2188 lines. What a stage of a
sound FX becomes as Web Audio nodes, and how the knobs of a playing
voice move, is now viewport/fxNodes.ts. None of it keeps state of
the library.
Dead code (TS language service, references per export and member):
- soundRefIds, LFO_SHAPE_INDEX, TREMOLO_ROWS, VIBRATO_ROWS and
REVERB_ROWS had no reader. The four routing node defs are
registered without an unused exported name.
- soundFileOf and portTypeOf were called by tests only. The tests
now ask findSound and portOf, which the editor uses. DRY moves
from src into the one test that uses it.
- 51 values used only in their own file lose their `export`. Types
and the node catalogues stay exported.
- Kept on purpose: neighboursOf is the cell by cell reading the
indexed neighboursIn is checked against, and PitchShifter.latency
is the test's one view of how late the shifter is.
Comments and docs:
- Seven comments told history ("no longer", "any more", "as
before", "of before #354"). Nine comment blocks ran far past the
line width. Proof that this changed no code: the bundle was md5
identical, and the touched tests and e2e modules were identical
after esbuild.
- README: sound FX, instrument, pattern, song and bus in the asset
list, the pages Instruments, Patterns and Songs, 1919 checks.
- Wiki: see its own commit.
Tests:
Gate (melektaus-atx) 274 files, 4236 tests, CHECK EXIT 0
e2e 34, 64, 65 ALL PASSED, 180 checks
Unit, touched areas 16 files, 804 tests
No check was added, the e2e sum stays at 1919. Counter-checks, each
put back by copy and compared with cmp:
- addLink without the loop rule: 2 tests fail, one per routing.
- eqCurves with the sum of the last band only: 1 test fails.
- Start in the worklet never waiting: e2e 34 fails in exactly the
four checks that hang on a voice's first sample (Flanger, Tremolo,
Chip, a pitched note planned ahead).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A sound FX or an instrument had a 5-Band-EQ with fixed bands and a
Filter with one band. The Parametric EQ holds up to ten bands of any
type, and a double-click on the node opens an editor that draws the
curve they make together.
- The bands are a list on the node (`bands`): type, frequency, gain,
Q and slope. A hand-edited project is held to the editor's ranges
and to ten bands.
- Each band compiles to the existing `pass` stage, so the audio core
is unchanged. A peak or a shelf at 0 dB is left out.
- The curve is worked out in `parametricEq.ts` with the biquad
formulas of the Web Audio spec, so the editor draws what is heard.
- The editor is a window that floats over the editor without a
backdrop, so the tab's Play stays usable. A double-click adds a
peak, a drag moves a band, the wheel turns its Q, a right-click
removes it. Fields below the curve set the picked band. It opens in
the middle of the screen and moves by its title bar.
- A drag or a scrub writes the node as a preview and makes one undo
step on release. The panels hear of the preview once a frame, and
the window lays itself out only when one of its texts changes.
- The area under the curve is filled as one shape for each side of
0 dB. As a single shape it crossed itself and came apart.
- The curve works out each band's coefficients once and adds the sum
up from the bands. A drag took 295 ms of script time in a profile
before and 64 ms after.
Decided on my own:
- Bands are added by a double-click, so a single click can let go of
the picked band without adding one.
- The cuts are labelled "Low cut" and "High cut" as in an EQ, not
"High-pass" and "Low-pass" as on the Filter.
- The bands have no input, so no parameter or Envelope moves them.
Tests:
- Unit parametric-eq (new) and soundfx: 69 green. Counter-probe with
no stages emitted: the compile test red. Counter-probe with one
fill shape: the fill test red.
- e2e 34 (melektaus-atx): ALL PASSED, 96 checks (3 new).
- Counter-probe e2e: no stages emitted, the playing check red.
- Gate (melektaus-atx): CHECK EXIT 0, 274 files, 4230 tests.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>