Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
9404313
dsp: satdiff-dsp crate (step 1 of SatDiff): SatComp saturator + out g…
thomchantra Nov 14, 2026
4f51ba9
dsp: satdiff scope pushes three layers (output, limiter input, limite…
thomchantra Nov 14, 2026
a8e2976
plugin: satdiff-plugin (step 1 of SatDiff): VST3 thomchantraSatDf / C…
thomchantra Nov 14, 2026
5d4d8dc
docs: SatDiff in the inventory and the foundation file layout (alpha,…
thomchantra Nov 14, 2026
e1f79b5
dsp: Curve::even_half / from_even_half (Y-mirror counterpart of odd_h…
thomchantra Nov 14, 2026
12436df
params: satdiff gets the pass-1 controls as live host parameters with…
thomchantra Nov 14, 2026
f8120b9
gui: SatDiff editor first pass to the pass-1 mock (372 x 688): header…
thomchantra Nov 14, 2026
cf8b06a
gui: SatDiff editor tuned to pass-2 feedback: panel width matches Sat…
thomchantra Nov 14, 2026
707e8f6
gui: draw view mirror fix (dragging the derived half of an odd / even…
thomchantra Nov 14, 2026
cb7da13
gui: the shape selector is drawn inverted (filled) while scene B is a…
thomchantra Nov 14, 2026
4f72eb6
dsp: SatDiff step 2, the phase section. Phase rotator (y = x cos t + …
thomchantra Nov 14, 2026
7f1eb92
dsp: diffusor SPREAD, 100 stages, STAGES as a percentage, COLOR MIX. …
thomchantra Nov 15, 2026
ae28466
gui: SatDiff colour section to the new layout. Full-width fx row (ena…
thomchantra Nov 15, 2026
da87290
gui: colour slots regroup by parameter count (three slots, the first …
thomchantra Nov 15, 2026
8a4fe02
dsp: SatDiff step 3, TILE. Curve gets a tile field (0 flat, 1 mirror …
thomchantra Nov 15, 2026
a12c996
dsp: no thump when the shaper changes (SatDiff). Switching shape chan…
thomchantra Nov 15, 2026
dc3017a
dsp: TILE on the factory shapers, and the input meter reads the satur…
thomchantra Nov 15, 2026
eca172d
gui: the shaper plot reflects TILE (it syncs its table with the tiled…
thomchantra Nov 15, 2026
85a6577
dsp: no sub-20 Hz bump when BIAS (or DRIVE) moves, and the input mete…
thomchantra Nov 15, 2026
72b7a86
dsp: SatDiff step 5, waveshaper scenes and MORPH. DiffParams carries …
thomchantra Nov 15, 2026
5f3087e
gui: SatDiff scenes and the morph toggle. Params: Shape B (slot 44), …
thomchantra Nov 15, 2026
a62d6ac
satdiff: A | B is a view switch only, the morph group decides what is…
thomchantra Nov 15, 2026
458b2f3
gui: SatDiff colour section pass 3. The fx dropdown shrinks to the fi…
thomchantra Nov 15, 2026
30ca9c5
dsp: Curve with 30 points, curve handles and linear segments (SatDiff…
thomchantra Nov 15, 2026
1686d80
gui: SatDiff draw editor, step 4. 30 points (15 per half in the odd /…
thomchantra Nov 15, 2026
b3009b7
satdiff: pass-4 feedback, the parts that were settled. Segmented mete…
thomchantra Nov 15, 2026
164f444
satdiff: IN GAIN replaces SAT GAIN (sat gain was in effect a second o…
thomchantra Nov 15, 2026
516e975
dsp: the full colour fx roster, PHASER, FLANGER and RINGMOD next to t…
thomchantra Nov 15, 2026
ec9573e
gui: the fx dropdown offers all four types and each relabels the colo…
thomchantra Nov 15, 2026
e44a4b3
dsp: every scene has its own waveshaper module. Scene B gets its own …
thomchantra Nov 15, 2026
7470f25
gui: the waveshaper module follows the A | B switch: DRIVE, ASYM, HPF…
thomchantra Nov 15, 2026
8857299
dsp: FREQ SHIFT, a fifth colour fx: a single-sideband (Bode-style) fr…
thomchantra Nov 15, 2026
aabd40e
dsp: the colour fx's output is tapped as mid (L+R)/2 and side (L-R)/2…
thomchantra Nov 15, 2026
838aa86
ui kit: taper mode 3, a bipolar log (symmetric around 0 at the centre…
thomchantra Nov 15, 2026
90c5c3b
gui: pass-4 feedback + FREQ SHIFT. The colour section is reordered: t…
thomchantra Nov 15, 2026
e6f4eb1
dsp: output HPF and the wide-band fx filter. OUT HP is a 24 dB/oct (4…
thomchantra Nov 15, 2026
82a2699
gui: the bottom row's third cell is the output HPF (top: HPF label wi…
thomchantra Nov 15, 2026
26db5f3
ui: ScrollClock, a read position for scrolling views of a ring filled…
thomchantra Nov 15, 2026
e2d1388
gui: every transient scope (SatComp, SatXComp, SatLim, SatDiff) scrol…
thomchantra Nov 15, 2026
79fc33b
ui: Glide, a continuous display of a value the audio thread publishes…
thomchantra Nov 15, 2026
eedc031
gui: every block-published animation goes through Glide, the fix for …
thomchantra Nov 15, 2026
aa41f2e
linux: vendor baseview with fixes for the frozen-REAPER-UI hang (seen…
thomchantra Nov 15, 2026
2144a7b
linux: the GL swap interval defaults to off on Linux / X11 (baseview …
thomchantra Nov 15, 2026
e6f4220
dsp: MeterRing, the animation values of every engine per 2 ms bucket …
thomchantra Nov 15, 2026
b9d212d
gui: every moving element reads MeterReader, an audio-time replay of …
thomchantra Nov 15, 2026
9d7b003
ui kit: a value the editor writes is shown at once, not when the host…
thomchantra Nov 15, 2026
823c5ef
test: the SatDiff curve-handle smoke starts with the shaper already C…
thomchantra Nov 15, 2026
4863831
params: to_dsp_over, a parameter snapshot that includes what the edit…
thomchantra Nov 15, 2026
4916c46
gui: the viewports follow the mouse. The waveshaper plot (drive, bias…
thomchantra Nov 15, 2026
5b9541b
docs: FOUNDATION gets the Linux gotchas of 2026-11-15: the frozen-REA…
thomchantra Nov 15, 2026
2a814ff
tools: plugbench, an offline benchmark host (CLAP for the SatComp fam…
thomchantra Nov 15, 2026
d0dbbce
tools: plugbench loads VST3. A hand-written host over the raw COM vta…
thomchantra Nov 16, 2026
f0750dc
docs: FOUNDATION documents plugbench's VST3 host: the IConnectionPoin…
thomchantra Nov 16, 2026
9a847b3
tools: xbench, a DSP-level timing and audio-regression harness for Sa…
thomchantra Nov 16, 2026
91830eb
satxcomp-dsp: the crossover and each band's Confine only run the biqu…
thomchantra Nov 16, 2026
9d0e159
satxcomp-dsp: a band skips its Confine filter while its saturator is …
thomchantra Nov 16, 2026
50b2cf3
tools: xbench gets a hard-compression variant (every band always redu…
thomchantra Nov 16, 2026
f0f747d
satcomp-dsp: the compressor skips an `ln` and an `exp` when they cann…
thomchantra Nov 16, 2026
bf3e936
docs: FOUNDATION records the SatXComp optimisation (identity-section …
thomchantra Nov 16, 2026
7c494ef
tools: satbench, a saturator-only timing and audio-regression harness…
thomchantra Nov 16, 2026
76a498c
tools: satbench gets shape-switching variants (odd <-> asymmetric sha…
thomchantra Nov 16, 2026
49a31f5
satcomp-dsp: the halfband stages (the oversampling of every saturator…
thomchantra Nov 16, 2026
d13775d
satcomp-dsp: the saturator skips the even-part oversampling chain for…
thomchantra Nov 16, 2026
20ef38f
satcomp-dsp: the saturator's DC tracker (SatDiff's dc_comp) evaluates…
thomchantra Nov 16, 2026
daa6480
docs: FOUNDATION records the saturator audit (halfband rewrite, odd-s…
thomchantra Nov 16, 2026
8db5dde
tools: plugbench gets PLUGBENCH_CASE=text to run only the cases whose…
thomchantra Nov 16, 2026
1db00e9
gui: 20-point draw view with an EVEN tool in SatComp / SatXComp / Sat…
thomchantra Nov 16, 2026
827cd66
satdiff: factory bank from the owner's eight presets, About copy, sca…
thomchantra Nov 16, 2026
64f8534
release: version bump for 0.5.3: SatComp 0.5.3, SatXComp 0.1.1, SatLi…
thomchantra Nov 16, 2026
9ac08bf
gui: clicking the plug-in title reopens the About page on the tab it …
thomchantra Nov 16, 2026
5eeac77
gui: SatComp compressor plot gets an adjustable floor/ceiling, dashed…
thomchantra Nov 16, 2026
426d550
manuals: signal-flow flowcharts and exploded-view hero annotations, a…
thomchantra Nov 16, 2026
d0cb04a
docs: new screenshots (docs/screenshots, alpha PNG with the window sh…
thomchantra Nov 16, 2026
c55ae53
SatDiff embeds its manual (OPEN MANUAL on About); SatComp 0.5.3 chang…
thomchantra Nov 16, 2026
f953efa
release plumbing: SatDiff in the CI plan and zip names; an all-in-one…
thomchantra Nov 16, 2026
b03fc4e
docs: release notes for v0.5.3 (SatDiff debut, UI pass, plot, suite d…
thomchantra Nov 16, 2026
bf3b91b
ci: the SatComp UI golden is enforced on macOS only (a hash of float-…
thomchantra Nov 16, 2026
89bde19
release: a suite release attaches only the suite files (3 zips, macOS…
thomchantra Nov 17, 2026
3ce33cf
ui: three new colour schemes (Canary, Drabberry, Citrus Mint), 30 in …
thomchantra Nov 17, 2026
0aa2e94
ui: plug-in icons drawn from the logo SVGs' filled shapes instead of …
thomchantra Nov 17, 2026
db36bb0
ui: SatLim icon built from SatComp's box and one bracket mirrored int…
thomchantra Nov 17, 2026
5cfcb5e
docs: SatXComp manual says the window scale is a dropdown (PDF rebuil…
thomchantra Nov 17, 2026
b5bf171
ci: the suite job also runs on branch / PR builds (named v<SatComp ve…
thomchantra Nov 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 47 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
run: sudo apt-get update && sudo apt-get install -y libx11-xcb-dev libxcb-icccm4-dev libxcb-dri2-0-dev libgl1-mesa-dev libx11-dev libxcursor-dev libasound2-dev
- name: Tests
working-directory: rust
run: cargo test --locked
run: cargo test --locked --no-fail-fast

# which plug-ins this run bundles: a plain v* tag (and branch / PR builds) = every plug-in that exists in the workspace,
# a <plugin>-v* tag = just that plug-in
Expand All @@ -43,6 +43,7 @@ jobs:
list='["satcomp"'
[ -d rust/satxcomp-plugin ] && list="$list,\"satxcomp\""
[ -d rust/satlim-plugin ] && list="$list,\"satlim\""
[ -d rust/satdiff-plugin ] && list="$list,\"satdiff\""
[ -d rust/sateq-plugin ] && list="$list,\"sateq\""
list="$list]"
;;
Expand Down Expand Up @@ -88,7 +89,7 @@ jobs:
run: |
# zip name = <Display>-<plug-in version from its Cargo.toml>-<platform>; the plug-in's own version, not the tag
plugin="${{ matrix.plugin }}"
case "$plugin" in satcomp) disp=SatComp ;; satxcomp) disp=SatXComp ;; satlim) disp=SatLim ;; sateq) disp=SatEQ ;; esac
case "$plugin" in satcomp) disp=SatComp ;; satxcomp) disp=SatXComp ;; satlim) disp=SatLim ;; satdiff) disp=SatDiff ;; sateq) disp=SatEQ ;; esac
ver=$(grep -m1 '^version' "rust/${plugin}-plugin/Cargo.toml" | sed 's/.*"\(.*\)".*/\1/')
# zip layout mirrors the install folders: VST3/<plugin>.vst3, CLAP/<plugin>.clap, INSTALL.txt, LICENSE (+ the manual on the macOS job)
mkdir -p dist/VST3 dist/CLAP
Expand All @@ -114,9 +115,43 @@ jobs:
*.zip
*.pdf

release:
if: startsWith(github.ref, 'refs/tags/')
# the all-in-one files of a whole-suite release (a plain v* tag): one zip per platform with every plug-in and the joint manual,
# the joint manual PDF on its own, and a macOS installer (.pkg, all users). Built from the per-plug-in zips of the bundle job by docs/install/make-suite.sh.
suite:
# every build except a single-plug-in tag, so the suite files can be checked from a branch / PR run before tagging
if: ${{ !startsWith(github.ref_name, 'satxcomp-v') && !startsWith(github.ref_name, 'satlim-v') && !startsWith(github.ref_name, 'sateq-v') }}
needs: bundle
strategy:
fail-fast: false
matrix:
include:
- { runner: macos-latest, name: macOS-universal }
- { runner: ubuntu-latest, name: Windows-x64 }
- { runner: ubuntu-latest, name: Linux-x64 }
runs-on: ${{ matrix.runner }}
steps:
- uses: actions/checkout@v4
- uses: actions/download-artifact@v4
with:
path: zips
merge-multiple: true
- name: Joint-manual tool (pdfunite)
run: |
if [ "$RUNNER_OS" = macOS ]; then brew install poppler; else sudo apt-get install -y poppler-utils; fi
- name: Suite
run: |
# the suite is versioned like SatComp: the release tag on a tag build, else SatComp's version with -dev
if [[ "$GITHUB_REF" == refs/tags/v* ]]; then ver="$GITHUB_REF_NAME"
else ver="v$(grep -m1 '^version' rust/satcomp-plugin/Cargo.toml | sed 's/.*"\(.*\)".*/\1/')-dev"; fi
docs/install/make-suite.sh "${{ matrix.name }}" "$ver" zips out
- uses: actions/upload-artifact@v4
with:
name: suite-${{ matrix.name }}
path: out/*

release:
if: ${{ startsWith(github.ref, 'refs/tags/') && !cancelled() && needs.bundle.result == 'success' && (needs.suite.result == 'success' || needs.suite.result == 'skipped') }}
needs: [bundle, suite]
runs-on: ubuntu-latest
permissions:
contents: write
Expand All @@ -126,10 +161,18 @@ jobs:
with:
path: artifacts
merge-multiple: true
# a whole-suite release (plain v* tag) attaches only the suite files: 3 zips, the macOS .pkg and the joint manual.
# A <plugin>-v* tag has no suite files, so its own zip is kept.
- name: Keep only the suite files on a suite release
run: |
if ls artifacts/SatComp-Suite-* >/dev/null 2>&1; then
find artifacts -maxdepth 1 -type f ! -name 'SatComp-Suite-*' -delete
fi
- uses: softprops/action-gh-release@v2
with:
files: |
artifacts/*.zip
artifacts/*.pkg
artifacts/*.pdf
# notes come from docs/releases/<tag>.md (falls back to generated notes when there is no file)
body_path: ${{ hashFiles(format('docs/releases/{0}.md', github.ref_name)) != '' && format('docs/releases/{0}.md', github.ref_name) || '' }}
Expand Down
6 changes: 4 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ docs/referenceJSFX/
docs/crashlogs/
docs/internal/
/Presets/
!docs/screenshot.png
!docs/screenshots/*.png
docs/manual/.build/
docs/feedbacknotes/
wavtest/
screencaps/
screencaps/
vst/
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
# SatComp

Three saturator-based dynamics plug-ins in one black-and-white (or any colour you like) monospace UI. Made with bricking intentions.
A waveshaping-saturator-infused plug-ins suite: a compressor, a 4-band compressor, a clipper / limiter and a phase diffusor. Made with bricking intentions.

| Plug-in | Version | What |
|---|---|---|
| [**SatComp**](#satcomp) | 0.5.2 | waveshaping saturator, compressor and a 2-stage 3-band EQ |
| [**SatXComp**](#satxcomp) | 0.1.0 | 4-band multiband compressor with a saturator per band and a 5-band EQ |
| [**SatLim**](#satlim) | 0.1.0 | saturator into an oversampled clipper and a true-peak brickwall limiter |
| [**SatComp**](#satcomp) | 0.5.3 | waveshaping saturator, compressor and a 2-stage 3-band EQ |
| [**SatXComp**](#satxcomp) | 0.1.1 | 4-band multiband compressor with a saturator per band and a 5-band EQ |
| [**SatLim**](#satlim) | 0.1.1 | saturator into an oversampled clipper and a true-peak brickwall limiter |
| [**SatDiff**](#satdiff) | 0.1.0 | A/B waveshaper saturator with morph, a phase rotator and colour effects |

VST3 and CLAP for macOS (Apple silicon and Intel), Windows and Linux (experimental: see Install). Free, GPL-3.0-or-later.

## SatComp

A waveshaping saturator with a compressor and a 2-stage 3-band EQ. Give the compressor more spice to squash.

![SatComp](docs/screenshot.png)
![SatComp](docs/screenshots/satcomp.png)

- **Saturator:** 15 shapers including a **Custom** one you draw yourself (pencil icon), drive, bias, ASYM (how much of the even-order part each shaper keeps, so lopsided curves do not drag DC into the signal), HP/LP split, tone, sat mix, SAT GAIN with auto-match, 1x/2x/4x oversampling.
- **Sidechain:** external key from a second stereo input, with gain, HP and LP on the key and a SOLO to listen to it.
Expand All @@ -23,16 +24,17 @@ A waveshaping saturator with a compressor and a 2-stage 3-band EQ. Give the comp
- **Output limiter:** a true-peak brickwall at -0.2 dBTP, on by default (LIM), with about 2 ms of latency that is always reported to the host.
- **Metering and tools:** output meter, gain-reduction meter, post-saturator level meter, GAIN MATCH, DELTA monitor, plain BYPASS.
- **Waveform scope:** click the icon in the corner of the compressor plot for a half or full wave view of the output with the gain reduction stacked on top (transient meter).
- **Compressor plot:** the CEIL and FLOOR labels rescale it (up to +18 dB, so a clipped signal shows past a dashed 0 dB line), and the curve itself is draggable: the line above the threshold sets the ratio, the line below it the threshold.
- **Presets:** save and load your own, step through them, six Drums factory presets included. A name wrapped in asterisks (`*NAME*`) means the preset has been modified.

## SatXComp

A 4-band compressor with a waveshaping saturator on every band and a 5-band EQ. For surgical baking: split the signal, then drive each band to taste.

![SatXComp](docs/screenshot-satxcomp.png)
![SatXComp](docs/screenshots/satxcomp.png)

- **Four bands** (LO, ML, MH, HI) split by three Linkwitz-Riley crossovers, each with a 12, 24, 48 or 96 dB slope. Drag the crossover lines in the spectrum or use the XOV sliders. The bands sum flat.
- **Per band:** a saturator (same 15 shapers, custom curves with a symmetry tool, band-limited so it only adds harmonics inside the band), a compressor, SOLO and DELTA, and its own SAT GAIN auto-match.
- **Per band:** a saturator (same 15 shapers, custom curves with ODD and EVEN mirror tools, band-limited so it only adds harmonics inside the band), a compressor, SOLO and DELTA, and its own SAT GAIN auto-match.
- **Compressor modes per band:** DWNWARD (the plain compressor), UPWARD (lifts what is below the threshold, up to RANGE) or UP/DWN (both).
- **Sidechain:** the external key is split across the bands, so it ducks like a dynamic EQ; KEY MIX blends it with the band's own level.
- **Spectrum viewport:** the output over the dry signal. The accent colour shows where the compressor took gain away, its inverse where gain was added. Each band handle sits at the threshold with a bar for the gain reduction below it, the gain increase above it, and the in/out difference on top.
Expand All @@ -43,21 +45,32 @@ A 4-band compressor with a waveshaping saturator on every band and a 5-band EQ.

A 2-stage clipper/limiter with a waveshaping saturator. When you need to nuke it from orbit.

![SatLim](docs/screenshot-satlim.png)
<img src="docs/screenshots/satlim.png" alt="SatLim" width="420">

- **Chain:** saturator (x1 to x8 oversampling) into a hard **CLIP** at the ceiling, then a true-peak brickwall limiter, then OUT GAIN. The output gain is after the limiter on purpose.
- **THRESHOLD** is the input level that lands on the ceiling: lowering it chews the signal deeper. **CLIP** exposes and bricks more transients, **RELEASE** trades density against distortion.
- **L.AHEAD** on gives a lookahead true-peak limiter; off gives a zero-latency one that follows sample peaks. The **TRU.PK** readout is an 8x true peak either way.
- **Transient scope** shows the output with what the limiter removed (solid) and what the clipper removed (hatched) stacked on top; the GR meter splits the same way.
- Auto-matched SAT GAIN, DELTA (what the clipper and limiter removed), plain BYPASS and six factory presets.

## SatDiff

A waveshaper saturator with phase colouring effects. Dedicated to sweet saturated sounds.

<img src="docs/screenshots/satdiff.png" alt="SatDiff" width="340">

- **Two saturators, A and B:** each scene has its own shaper, drawable curve (up to 30 points with bendable segments), tile, drive, bias, HPF / LPF, tone and ASYM. **MORPH** blends them: a static crossfade, or a compressor-style detector that moves the blend with the input level (shape A on silence, shape B on loud peaks).
- **TILE** folds or repeats the curve so BIAS walks through copies of it.
- **PHASE** rotator and a colour slot, before or after the saturators: diffusor, phaser, flanger, ring mod or frequency shifter, with COLOR MIX.
- **Output:** a 24 dB per octave HPF with mid / side switches (side only is a mono sub), IN and OUT gain, a true-peak limiter, level-match on the SAT readout, plain BYPASS and eight factory presets.

## Shared

- **27 colour schemes, each with a light mode, plus your own:** click the logo for the next scheme, double-click it for light/dark, right-click for the list. The **Preferences** tab (About page) has the mode switch, a scheme list with swatches, 11 fonts, a custom theme editor with a colour picker, and SET AS DEFAULT for new instances. User themes are saved in `~/Library/Application Support/SatComp/themes.json` (`%APPDATA%\SatComp\themes.json` on Windows).
- **30 colour schemes, each with a light mode, plus your own:** click the logo for the next scheme, double-click it for light/dark, right-click for the list. The **Preferences** tab (About page) has the mode switch, a scheme list with swatches, 11 fonts, a custom theme editor with a colour picker, and SET AS DEFAULT for new instances. User themes are saved in `~/Library/Application Support/SatComp/themes.json` (`%APPDATA%\SatComp\themes.json` on Windows).
- Resizable window (100% to 250%). Double-click any slider to reset it. Click the title for an About page with the signal flow, Preferences and the changelog.

## Install
Download the zip for your plug-in and system from the [Releases](../../releases) page. Inside are `VST3/` and `CLAP/` folders that mirror the install locations, an `INSTALL.txt` and the plug-in's manual (PDF; the manuals are also in `docs/manual/`). Copy the bundle (`satcomp`, `satxcomp` or `satlim`) to:
Download from the [Releases](../../releases) page: `SatComp-Suite-<version>-<platform>.zip` holds all four plug-ins and a joint manual (macOS also has a `.pkg` installer that puts them in place for all users; the joint manual is also attached on its own). Inside are `VST3/` and `CLAP/` folders that mirror the install locations, an `INSTALL.txt` and the manual (PDF; the per-plug-in manuals are also in `docs/manual/`). Copy the bundle (`satcomp`, `satxcomp`, `satlim` or `satdiff`) to:

| | macOS | Windows |
|---|---|---|
Expand Down
Loading
Loading