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 song could clip at the output without anyone noticing: a track and a
sound item at +12 dB each add up to +24 dB. The Song tab now shows how
loud each track and the whole song are, and a fixed limiter behind the
master keeps every sample under -1 dBFS in the editor and in the game.
- Each track head has a stereo meter up its right edge. The head is
190 px wide instead of 176.
- Out sits in the corner above the heads, with the loudest peak since
Play in dB. In the tab header it made the row too wide for a 1280 px
window, and the inspector lost its fields.
- The meters read AnalyserNodes beside the buses, one per side after a
channel splitter, so a peak panned hard is not halved. They are tapped
only while the song plays and its tab is shown.
- A clip lamp lights past 0 dBFS and stays through Stop. The next Play
or a click on the meter puts it out.
- The meter of a track that mute or solo keeps from being heard is grey.
- Music always plays through a bus of its own, with or without a sound
FX. That bus is what Out measures.
- The limiter is the one from #326 and needs the FX worklet. Until that
is loaded the master goes straight out.
- It is 5 ms late. latency() counts that in, so the playhead and the
alignment of a recorded take follow it.
- Unit tests build SoundLibrary without the limiter, as their wiring
checks follow every node of a voice.
- Out shows "-inf" while nothing was loud. The UI font has no infinity
sign, which the font test found.
Tests:
- Unit meter-view 8 new, sound-library 112 (2 new), 3 counter-tests
each red
- e2e 65 (melektaus-atx): ALL PASSED, 55 checks (3 new). Out wrote
+16.6 dB, behind the limiter the loudest sample was 0.8913
- Gate (melektaus-atx): 272 files, 4209 tests, one red in the font
test. Fixed after it, then the font and meter tests ran green.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>