Compare commits

..

16 Commits

Author SHA1 Message Date
Mikkeli Matlock abc9ea8b4f feat: live operating-point fill + -6 dB refs on the gain curve
Add a per-channel input_level meter (post pre-gain, peak-with-decay) and use it
to shade the gain curve: a translucent fill under the curve from the floor up to
the current input, its right edge riding the curve (width = input, height =
output), plus a dot at the operating point. Add -6 dBFS reference lines on both
axes with a tick label.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-26 21:19:16 +09:00
Mikkeli Matlock 45735f71f7 feat: bipolar mid-bulge low-curve anchored at silence and the knee
Rework Low Curve from a one-sided saturating bend into a bipolar mid-bulge: the
low region is anchored at BOTH the silence floor and the knee, Low Slope tilts
the straight line between them, and Low Curve (-1..1) bows that line in the
middle (4*t*(1-t), peak +/-12 dB) without moving either endpoint. Positive
bulges up (boost the quiet middle), negative down (suppress). Still serial.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-26 21:19:04 +09:00
Mikkeli Matlock a4c542b2d9 feat: serial low-level shaper (Low Slope + Low Curve) before the compressor
Add a per-channel below-threshold shaper composed in series ahead of the comp:
gain = low_shape(level) + comp(level + low_shape(level)). The compressor's
threshold now sees the shaped level, so a Low Slope boost lifts quiet material
up into compression (and a cut pulls it out). Anchored at the -60 dB silence
floor. Low Curve bends the shaper toward a bounded saturation so the serial
composition doesn't blow up (0 = straight line).

gain_computer split into comp_gain_db + low_gain_db and composed; shared with
the editor gain-curve display. Slider order rearranged to read in signal order
(pre-gain -> low shaper -> compressor -> output). Defaults (slope 1, curve 0)
reproduce the plain compressor; 17 tests pass.

Known: the bipolar behaviour isn't final yet (milestone commit).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-26 00:53:40 +09:00
Mikkeli Matlock 123703d34d feat: raise max knee width to 30 dB
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-25 15:24:17 +09:00
Mikkeli Matlock b1477f7ec6 feat: static gain-curve display for the selected channel
Add editor/gain_curve.rs: a square panel beside the scrolling plot showing the
channel transfer (out vs in, -60..0 dB) for whichever channel the plot tab
selects. Plots the full wet path — out = (in + pre_gain) + gain_reduction + makeup
— using the shared Compressor::gain_computer (now pub) so it matches the DSP and
the GR meter. Unity-reference diagonal + threshold marker; mix not folded in.

Update README structure/status to reflect the editor/ widget module and the
completed Stage 6 visualisers.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-25 15:24:08 +09:00
Mikkeli Matlock a8be2179c3 feat: ceiling-hit markers as top-edge ticks on the rolling plot
Flag each plot bucket with whether the output limiter hit the ceiling
(limiter GR > 0.1 dB), carried through ScopeRing as a per-bucket hit field and
folded into history columns. The editor draws a short red tick at the top of any
hit column (one column wide, so runs merge into segments and a lone hit is a
dot); nothing otherwise. Global marker, shown on every channel tab.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 22:16:33 +09:00
Mikkeli Matlock 42c5f7dcd2 feat: per-channel dry/wet mix (parallel compression) replacing bypass
Replace the per-channel bypass toggle with a smoothed dry/wet `mix` (0..100%,
default 100%). The blend is applied at the compressor output:
  out = delayed_input * ((1 - mix) + mix * wet_gain)
Dry and wet share the same delayed input, so it's phase-aligned (parallel
compression, no comb filtering). mix=0 is bit-identical to the old bypass.

The detector now runs even at mix 0, so the GR meter shows the wet gain
reduction regardless of mix, while the level/plot out trace reads the mixed
output. "Bands at 0% = simple full-band comp via All" still holds.

Update README + parameter docs (bypass -> mix).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 19:25:38 +09:00
Mikkeli Matlock eee94379bc docs: note the crossover automation caveat (editor-only lo<=hi limit)
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 16:57:20 +09:00
Mikkeli Matlock 3aeb09957a feat: draggable crossover handles with dynamic lo<=hi limit
Replace the two plain crossover sliders with a horizontal log-frequency strip
(LOW/MID/HIGH) and two draggable handles, plus number boxes (double-click to
type). Handles and boxes enforce a dynamic limit so lo/mid never crosses
mid/hi, on top of each param's own range. Lives in the editor/ widget module.

Known limitation: the lo<=hi limit is editor-only, so host automation can write
the two params past each other (briefly inverting the mid band). The DSP clamps
to monotonic, but FL's automation can misbehave once inverted. Left as-is.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 16:55:30 +09:00
Mikkeli Matlock 514fd964f6 fix: freeze the scope when the transport is stopped
FL keeps calling process() with silence while stopped/paused, so the scope
scrolled silence instead of holding. Gate the plot's bucket advance on
context.transport().playing, so it freezes on stop/pause and resumes on play.
Bar meters still fall to silence as before. Update README thread-safety notes
for the ScopeRing feed and transport gating.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 16:25:08 +09:00
Mikkeli Matlock 9a60b0ea72 feat: decouple plot resolution from frame rate via a 200 Hz ring buffer
Feed the scrolling plot from a lock-free SPSC ScopeRing instead of sampling one
atomic per egui frame, so horizontal resolution is set by the audio-clocked
bucket rate (~200 Hz) rather than the ~60 fps repaint. process() accumulates a
bucket every sample_rate/BUCKET_HZ samples (peak-preserving, spanning blocks)
and pushes it; the editor drains all new buckets each frame and folds them into
PLOT_N columns. Fast transients between frames are no longer dropped, and the
plot is now audio-clocked (freezes on pause, falls to silence on stop/reset).

Drop the per-frame plot_* atomics (the per-channel lamp now reads the decayed
bar level). Also fix the area fill: render it as a strip of per-segment convex
quads instead of one concave polygon, which egui fan-filled from a corner and
left stray triangles.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 14:53:00 +09:00
Mikkeli Matlock fe4033b772 feat: translucent area fill under the in/out plot traces
Draw a translucent area from each level line down to the plot baseline so the
input and output traces read more clearly. The gain-reduction trace stays a
plain line (it hangs from the 0 dB line, where a fill would read oddly).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 05:03:30 +09:00
Mikkeli Matlock 0c2e1597a1 feat: per-channel ceiling lamps in the meter widget
Replace the single global ceiling lamp with one lamp per channel cluster.
Each latches when that channel's output reaches 0 dBFS (a hot/over warning,
handy when pre-gain drives a band); the ALL channel additionally lights on a
real output-limiter catch. Same latch/hold/click-to-clear behavior, now per
channel.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 05:02:39 +09:00
Mikkeli Matlock eb2499bad3 refactor: split editor.rs into editor/ widget modules
Move the egui editor from a single editor.rs into an editor/ module: mod.rs
(aggregator: create(), EditorState, layout, placeholder slider columns),
meter.rs (|L|GR|R| meters + ceiling lamp, owns MeterState), and plot.rs
(rolling in/out/GR plot, owns PlotState + PlotHistory). Each visualiser owns
its GUI state; the aggregator composes them. No behavior change.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-24 05:01:50 +09:00
Mikkeli Matlock 3ae860188e docs: restore planned editor/widgets layout as a future UI-redesign target
Keep the widget-module breakdown (meter/plot/gain_curve/crossover) documented
as the intended split for when editor.rs is redesigned, clearly marked as
deferred rather than current.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-23 23:17:51 +09:00
Mikkeli Matlock 411b27fcf3 docs: update README for Stage 6 metering, pre-gain, and module split
Reflect actual code: per-channel pre-gain drive in signal flow + params,
makeup range -24..+24, lib.rs split into params/editor/meters, lock-free
atomic meters (not a mutex), and Stage 6 progress (|L|GR|R| meters, latching
ceiling lamp, rolling in/out/GR plot). Overview/Goals unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-23 09:56:31 +09:00
11 changed files with 1150 additions and 519 deletions
+67 -34
View File
@@ -34,12 +34,12 @@ Built with **Rust** + **NIH-plug** (VST3 + CLAP output) + **egui** for the UI.
``` ```
Input Input
└─ Crossover filterbank (Linkwitz-Riley LR4 @ each crossover freq) └─ Crossover filterbank (Linkwitz-Riley LR4 @ each crossover freq)
├─ Band 1 (low) → look-ahead delay → compressor VCA → gain stage ─┐ (bypassable) ├─ Band 1 (low) → pre-gain → look-ahead delay → compressor VCA → makeup ─┐ (dry/wet mix)
├─ Band 2 (mid) → look-ahead delay → compressor VCA → gain stage ─┤ (bypassable) ├─ Band 2 (mid) → pre-gain → look-ahead delay → compressor VCA → makeup ─┤ (dry/wet mix)
└─ Band 3 (high) → look-ahead delay → compressor VCA → gain stage ─┤ (bypassable) └─ Band 3 (high) → pre-gain → look-ahead delay → compressor VCA → makeup ─┤ (dry/wet mix)
Sum of bands ◄──────────────────────────────────────────────------┘ Sum of bands ◄─────────────────────────────────────────────────────------┘
└─ 'All' channel → look-ahead delay → compressor VCA → gain stage └─ 'All' channel → pre-gain → look-ahead delay → compressor VCA → makeup
└─ output brickwall limiter (true-peak, 4x oversampled) → output └─ output brickwall limiter (true-peak, 4x oversampled) → output
``` ```
@@ -62,15 +62,16 @@ a first-class mode, not an afterthought.
- Bands sum phase-coherently to flat **magnitude** (the sum is an all-pass; lower bands get an all-pass at each later crossover to match phase — not a bit-exact time-domain null) - Bands sum phase-coherently to flat **magnitude** (the sum is an all-pass; lower bands get an all-pass at each later crossover to match phase — not a bit-exact time-domain null)
- Crossover frequencies are user-adjustable parameters - Crossover frequencies are user-adjustable parameters
### Per-Band Compressor ### Per-Band Compressor
- **Pre-gain (drive)**: scales the band *before* the detector, so it pushes harder into compression and feeds the sum/limiter hotter — a mild "compressed semi-distortion" without a dedicated saturator. Applied in the wiring (the compressor itself is untouched). Pairs with makeup for full input/output gain-staging
- Level detection: switchable peak / RMS (RMS window currently hardcoded small; can be exposed later) - Level detection: switchable peak / RMS (RMS window currently hardcoded small; can be exposed later)
- Gain computer: threshold, ratio, soft knee - Gain computer: threshold, ratio, soft knee
- Attack / release envelopes (logarithmic ballistics) - Attack / release envelopes (logarithmic ballistics)
- Makeup gain per band - Makeup gain per band (24…+24 dB — attenuates as well as boosts)
- Look-ahead: circular delay buffer on the audio path; detector reads ahead - Look-ahead: circular delay buffer on the audio path; detector reads ahead
### 'All' Aggregate Channel ### 'All' Aggregate Channel
- Structurally **identical to a per-band compressor** — reuse the same comp/lim code/params, just fed the summed signal instead of a filtered band - Structurally **identical to a per-band compressor** — reuse the same comp/lim code/params, just fed the summed signal instead of a filtered band
- Runs after the three bands are summed, before the output brickwall limiter - Runs after the three bands are summed, before the output brickwall limiter
- Bands are individually bypassable; with all three bypassed the (phase-coherent) crossover sum equals the dry input, so the 'All' channel alone acts as a full-band comp/lim - Bands have a per-channel dry/wet **mix** (parallel compression); at 0% (or all three dry) the (phase-coherent) crossover sum equals the dry input, so the 'All' channel alone acts as a full-band comp/lim
- Has its own look-ahead; the plugin reports a single **constant** total latency (the fixed band + 'All' look-ahead), set once — see Latency below - Has its own look-ahead; the plugin reports a single **constant** total latency (the fixed band + 'All' look-ahead), set once — see Latency below
### Output Limiter ### Output Limiter
- Brickwall, ceiling = 0 dBFS or user-defined (`output_ceiling`). Look-ahead + sliding-max peak detection + a ceiling clamp guarantee the output never exceeds the ceiling - Brickwall, ceiling = 0 dBFS or user-defined (`output_ceiling`). Look-ahead + sliding-max peak detection + a ceiling clamp guarantee the output never exceeds the ceiling
@@ -85,21 +86,29 @@ a first-class mode, not an afterthought.
## Parameters ## Parameters
### Global ### Global
- `input_gain` — pre-gain before filterbank (dB)
- `output_ceiling` — brickwall ceiling (dBFS, default 0.0) - `output_ceiling` — brickwall ceiling (dBFS, default 0.0)
- `limiter_release_ms` — output limiter release time - `limiter_release_ms` — output limiter release time
- `look_ahead_ms` — look-ahead time (05 ms). Reported latency is **constant** (the max look-ahead); the knob only moves the detector tap within that fixed delay, so it is safe to adjust during playback (changing reported latency mid-stream crashes some hosts, FL included) - `look_ahead_ms` — look-ahead time (05 ms). Reported latency is **constant** (the max look-ahead); the knob only moves the detector tap within that fixed delay, so it is safe to adjust during playback (changing reported latency mid-stream crashes some hosts, FL included)
- `crossover_low_hz` — low/mid crossover frequency - `crossover_low_hz` — low/mid crossover frequency
- `crossover_high_hz` — mid/high crossover frequency - `crossover_high_hz` — mid/high crossover frequency
> **Crossover automation caveat:** the lo ≤ hi limit is enforced in the **editor only** (the two
> are independent params). Host automation writes them directly, so it can drive lo past hi and
> momentarily invert the mid band. The DSP clamps to a monotonic split so it won't break audio,
> but FL's automation can misbehave once inverted. Not fixed by design — just don't automate the
> two across each other.
### Per-Channel Compressor (× 4: low, mid, high, **all** — one `#[nested]` params struct reused) ### Per-Channel Compressor (× 4: low, mid, high, **all** — one `#[nested]` params struct reused)
- `pre_gain_db` — drive into the compressor (24…+36 dB, smoothed)
- `detection` — peak / RMS level detection - `detection` — peak / RMS level detection
- `low_slope` — low-level shaper slope at the silence floor (1 = unity, >1 fans up/boost, <1 fans down/cut). **Serial**: reshapes the level *before* the threshold, so a boost can lift quiet material up into compression
- `low_curve` — bends the low shaper toward a bounded saturation (0% = straight line) so the serial composition doesn't run away
- `threshold_db` - `threshold_db`
- `ratio` — 1.0 (off) to ∞ (limiting) - `ratio` — 1.0 (off) to ∞ (limiting)
- `knee_db` — soft knee width
- `attack_ms` - `attack_ms`
- `release_ms` - `release_ms`
- `knee_db`soft knee width - `makeup_db`makeup gain (24…+24 dB)
- `makeup_gain_db` - `mix` — per-channel dry/wet mix (parallel compression); 0% = dry (a clean bypass), 100% = fully processed. Bands at 0% → simple full-band comp via the 'all' channel
- `bypass` — per-channel bypass (bypassing low+mid+high = simple full-band comp via the 'all' channel)
The 'all' channel uses the same struct so its UI and DSP are identical to a band; it just sits after the band sum. The 'all' channel uses the same struct so its UI and DSP are identical to a band; it just sits after the band sum.
--- ---
@@ -110,24 +119,37 @@ Target layout (✅ = exists today; the rest is planned):
``` ```
src/ src/
lib.rs # ✅ Plugin trait + Params + egui editor (all inline for now) lib.rs # ✅ Plugin trait + DSP wiring + process()
params.rs # (planned) split Params out of lib.rs params.rs # ✅ Params structs, defaults, build_settings()
editor.rs # ✅ egui editor: meter panel + rolling plot (drawn via Painter) + slider columns
meters.rs # ✅ lock-free Meters (atomics): decayed bar values + raw plot feed
dsp/ dsp/
mod.rs # ✅ module declarations mod.rs # ✅ module declarations
compressor.rs # ✅ full-band comp: peak/RMS detector, gain computer, ballistics, look-ahead delay compressor.rs # ✅ full-band comp: peak/RMS detector, gain computer, ballistics, look-ahead delay
crossover.rs # ✅ LR4 3-band filterbank with all-pass phase compensation crossover.rs # ✅ LR4 3-band filterbank with all-pass phase compensation
biquad.rs # ✅ generic biquad (Transposed Direct Form II) biquad.rs # ✅ generic biquad (Transposed Direct Form II)
limiter.rs # ✅ look-ahead brickwall limiter (sample-peak; true-peak pending) limiter.rs # ✅ look-ahead brickwall limiter (true-peak via oversampler)
delay.rs # (planned) look-ahead delay (currently inside compressor.rs / limiter.rs)
oversampler.rs # ✅ 4x polyphase oversampler for true-peak detection (detection-only) oversampler.rs # ✅ 4x polyphase oversampler for true-peak detection (detection-only)
editor/
mod.rs # (planned) egui editor split out of lib.rs
widgets/
gain_curve.rs # (planned) custom egui Widget: gain curve display
band_meter.rs # (planned) per-band gain reduction meter
level_meter.rs# (planned) input/output level meter
``` ```
The editor lives in an `editor/` module — one file per visualiser widget (each owns its GUI
state), with `mod.rs` as the aggregator/layout. Drawn directly with egui's `Painter`.
```
src/
editor/
mod.rs # aggregator: create(), EditorState, layout, placeholder slider columns
meter.rs # |L | GR | R| level + gain-reduction bars + per-channel ceiling lamp
plot.rs # rolling in/out/GR scope (200 Hz ring feed) + ceiling-hit markers
crossover.rs # log-freq strip with draggable crossover handles + number boxes
gain_curve.rs # static gain-curve display (out vs in) for the selected channel
```
Remaining UI work: replace the placeholder per-channel slider columns in `mod.rs` with the real
layout.
Deferred until the redesign — no need to split prematurely while the layout is still a placeholder.
--- ---
## Build Steps ## Build Steps
@@ -176,12 +198,13 @@ is essential — without it FL silently skips a plugin it has seen before.)
Work through these stages in order — each stage produces a loadable, audible plugin. Work through these stages in order — each stage produces a loadable, audible plugin.
**Status (2026-06-19):** Stages 14 done — the full signal chain works: 3-band LR4 crossover → **Status (2026-06-25):** Stages 14 done — the full signal chain works: 3-band LR4 crossover →
per-band compressors (peak/RMS) → 'All' channel → **true-peak brickwall limiter** (4× oversampled per-band pre-gain + compressors (peak/RMS) → per-channel dry/wet mix → 'All' channel → **true-peak
detection), with a basic 4-column UI. **Next: split `params.rs`/`editor/` out of `lib.rs`, then brickwall limiter** (4× oversampled detection). `lib.rs` is split into `params.rs`, `meters.rs`, and
Stage 6 visualisers (meters, gain curve).** DSP is in `src/dsp/` (`biquad.rs`, `crossover.rs`, an `editor/` widget module. Stage 6 visualisers are essentially complete: per-channel **|L | GR | R|
`compressor.rs`, `limiter.rs`, `oversampler.rs`); params and the egui editor are still inline in meters** + **per-channel ceiling lamps**, a **rolling in/out/GR plot** (200 Hz ring feed, flow-speed,
`src/lib.rs`. ceiling-hit markers), **draggable crossover handles**, and a **static gain-curve display**. **Next:
replace the placeholder slider columns with the real UI layout.**
### Stage 1 — Skeleton plugin ✅ ### Stage 1 — Skeleton plugin ✅
- [x] NIH-plug "passthrough" compiling and loading in DAW - [x] NIH-plug "passthrough" compiling and loading in DAW
@@ -211,13 +234,15 @@ Stage 6 visualisers (meters, gain curve).** DSP is in `src/dsp/` (`biquad.rs`, `
### Stage 5 — Basic egui UI *(basic version done early)* ### Stage 5 — Basic egui UI *(basic version done early)*
- [x] Add `nih_plug_egui` editor - [x] Add `nih_plug_egui` editor
- [x] Sliders for all current parameters (`ParamSlider` grid) - [x] Sliders for all current parameters (`ParamSlider` grid)
- [ ] Per-band bypass toggles *(partial — single-band bypass present; per-band arrives with Stage 3)* - [x] Per-channel dry/wet mix (parallel compression; replaced the bypass toggle)
- [x] Confirm UI controls update DSP in real time - [x] Confirm UI controls update DSP in real time
### Stage 6 — Custom visualisations ### Stage 6 — Custom visualisations
- [ ] `level_meter.rs` — input/output RMS + peak meters - [x] Per-channel level meters (output level, `|L | GR | R|` cluster)
- [ ] `band_meter.rs` — per-band gain reduction meters (vertical bars) - [x] Per-channel gain-reduction meters (vertical bars) + latching ceiling lamp
- [ ] `gain_curve.rs` — static gain curve display per band (threshold/ratio/knee) - [x] Rolling in/out/gain-reduction plot (per-channel tabs, flow-speed selector)
- [ ] Draggable crossover handles on a frequency display - [x] Static gain-curve display (out vs in; includes pre-gain + makeup) for the selected channel
- [x] Draggable crossover handles on a log-frequency display (with number boxes)
- [ ] Replace the placeholder slider columns with the real UI
--- ---
## Key Implementation Notes ## Key Implementation Notes
@@ -240,8 +265,16 @@ far below audibility. We therefore do **not** set the register ourselves or flus
NIH-plug provides `Smoother` — use it for all gain/threshold params to avoid zipper noise. NIH-plug provides `Smoother` — use it for all gain/threshold params to avoid zipper noise.
### Thread safety ### Thread safety
Params are atomics. The editor and audio thread communicate only through params and Params are atomics. The editor and audio thread communicate only through params and a shared
`Arc<Mutex<...>>` meter data. Never pass DSP state to the UI directly. `Arc<Meters>` (`meters.rs`) — never a mutex on the audio path. Two lock-free feeds, both gated on
the editor being open:
- **Bar meters** — decayed atomic scalars, one store per block; the editor reads them each frame.
- **Scrolling plot** — a single-producer/single-consumer `ScopeRing` of buckets clocked at
~200 Hz, so the plot's horizontal resolution is decoupled from the ~60 fps repaint. The editor
drains all new buckets each frame. The scope is **transport-gated** (advances only while playing)
so it freezes rather than scrolling silence when the host is stopped/paused.
Never pass DSP state to the UI directly.
### VST3 licensing ### VST3 licensing
You must accept Steinberg's VST3 SDK licence before distributing VST3 binaries. You must accept Steinberg's VST3 SDK licence before distributing VST3 binaries.
+103 -27
View File
@@ -26,6 +26,16 @@ const MAX_CHANNELS: usize = 2;
/// ~ -240 dBFS; keeps `log10` away from zero without affecting audible levels. /// ~ -240 dBFS; keeps `log10` away from zero without affecting audible levels.
const LEVEL_EPS: f32 = 1e-12; const LEVEL_EPS: f32 = 1e-12;
/// Silence-floor anchor for the below-threshold shaping: at/below this level the gain change is 0
/// (silence stays silence), and the low region fans up/down from here toward the threshold. Matches
/// the editor gain-curve's display floor.
const LOW_ANCHOR_DB: f32 = -60.0;
/// Max bulge (dB) the low-shaper curvature adds at the MIDDLE of the low region, at `|low_curve|`=1.
/// Bipolar: positive bulges up (boost the quiet middle), negative bulges down (suppress). Zero at
/// both ends (silence floor and the knee), so it never moves those anchors.
const LOW_BULGE_MAX_DB: f32 = 12.0;
/// Hardcoded RMS averaging window (one-pole time constant). Deliberately small; can be /// Hardcoded RMS averaging window (one-pole time constant). Deliberately small; can be
/// promoted to a parameter later. /// promoted to a parameter later.
const RMS_WINDOW_MS: f32 = 5.0; const RMS_WINDOW_MS: f32 = 5.0;
@@ -40,6 +50,11 @@ pub struct CompressorSettings {
pub threshold_db: f32, pub threshold_db: f32,
pub ratio: f32, pub ratio: f32,
pub knee_db: f32, pub knee_db: f32,
/// Low shaper slope at the silence floor (1 = unity; >1 fans up/boost, <1 fans down/cut).
/// Reshapes the level the compressor sees (serial), anchored at the floor.
pub low_slope: f32,
/// Low shaper curvature, 0..1 (0 = straight line, 1 = max bend toward bounded saturation).
pub low_curve: f32,
/// One-pole coefficient for the attack ramp (see [`Compressor::time_to_coef`]). /// One-pole coefficient for the attack ramp (see [`Compressor::time_to_coef`]).
pub attack_coef: f32, pub attack_coef: f32,
/// One-pole coefficient for the release ramp. /// One-pole coefficient for the release ramp.
@@ -50,7 +65,9 @@ pub struct CompressorSettings {
pub lookahead_samples: usize, pub lookahead_samples: usize,
/// `true` = RMS detection (running power average), `false` = naive sample peak. /// `true` = RMS detection (running power average), `false` = naive sample peak.
pub use_rms: bool, pub use_rms: bool,
pub bypass: bool, /// Dry/wet blend, 0..=1. 1 = fully compressed (incl. makeup), 0 = dry passthrough (bypass).
/// Parallel: dry and wet share the same delayed input, so the mix is phase-aligned.
pub mix: f32,
} }
pub struct Compressor { pub struct Compressor {
@@ -67,7 +84,8 @@ pub struct Compressor {
mean_sq: f32, mean_sq: f32,
rms_coef: f32, rms_coef: f32,
/// Smooth decoupled peak-detector state, expressed as dB of **attenuation** (>= 0). /// Smooth decoupled peak-detector state, in dB of attenuation (signed: usually >= 0, but can go
/// negative = boost when `low_slope < 1`). The `max()` recurrence makes cut fast / boost slow.
y1: f32, // release branch (peak-with-decay) y1: f32, // release branch (peak-with-decay)
yl: f32, // attack-smoothed output yl: f32, // attack-smoothed output
} }
@@ -129,24 +147,56 @@ impl Compressor {
} }
} }
/// Static compressor curve. Returns gain reduction in dB (<= 0) for an input `level_db`. /// Pure compressor transfer (threshold / ratio / quadratic soft knee). Returns gain reduction
/// Quadratic soft knee of width `knee_db`, centred on `threshold_db`. /// in dB (<= 0) for an input `level_db`.
fn gain_computer(level_db: f32, threshold_db: f32, ratio: f32, knee_db: f32) -> f32 { fn comp_gain_db(level_db: f32, threshold_db: f32, ratio: f32, knee_db: f32) -> f32 {
let slope = 1.0 / ratio - 1.0; // <= 0 for ratio >= 1 let slope = 1.0 / ratio - 1.0; // <= 0 for ratio >= 1
let over = level_db - threshold_db; let over = level_db - threshold_db;
if knee_db > 0.0 && 2.0 * over.abs() <= knee_db { if knee_db > 0.0 && 2.0 * over.abs() <= knee_db {
// Inside the knee: a parabola joining the two regions with a continuous slope.
let x = over + knee_db * 0.5; // 0..knee let x = over + knee_db * 0.5; // 0..knee
slope * x * x / (2.0 * knee_db) slope * x * x / (2.0 * knee_db)
} else if over > 0.0 { } else if over > 0.0 {
// Above the knee (also covers the hard-knee case): linear region.
slope * over slope * over
} else { } else {
0.0 0.0
} }
} }
/// Low-level shaper gain in dB. Anchored at BOTH the silence floor ([`LOW_ANCHOR_DB`]) and the
/// knee (threshold). `low_slope` tilts the straight line between those anchors (1 = unity);
/// `low_curve` (-1..1) bulges that line in the middle without moving either endpoint — positive
/// bulges up (boost the quiet middle), negative down (suppress). Reshapes the level the
/// compressor then sees.
fn low_gain_db(level_db: f32, threshold_db: f32, low_slope: f32, low_curve: f32) -> f32 {
let d = level_db - LOW_ANCHOR_DB;
if d <= 0.0 {
return 0.0;
}
let span = (threshold_db - LOW_ANCHOR_DB).max(1.0); // floor -> threshold width
let t = (d / span).min(1.0); // normalized position, clamped at the knee
// Straight line anchored at the floor (t=0 -> 0) and the knee (t=1 -> (slope-1)*span).
let slope_line = (low_slope - 1.0) * span * t;
// Bipolar bulge: 0 at both ends, peaks (4·t·(1-t) = 1) at the middle.
let bulge = low_curve * LOW_BULGE_MAX_DB * 4.0 * t * (1.0 - t);
slope_line + bulge
}
/// Full static curve, **serial**: the low shaper reshapes the level, then the compressor's
/// threshold sees the shaped level. Returns total gain in dB (signed: negative = cut, positive
/// = boost). `gain = low + comp(level + low)`. Shared with the editor's gain-curve display —
/// single source of truth.
pub fn gain_computer(
level_db: f32,
threshold_db: f32,
ratio: f32,
knee_db: f32,
low_slope: f32,
low_curve: f32,
) -> f32 {
let low = Self::low_gain_db(level_db, threshold_db, low_slope, low_curve);
low + Self::comp_gain_db(level_db + low, threshold_db, ratio, knee_db)
}
/// The plugin's fixed reported latency in samples (the constant audio delay). /// The plugin's fixed reported latency in samples (the constant audio delay).
pub fn latency(&self) -> u32 { pub fn latency(&self) -> u32 {
self.fixed_delay as u32 self.fixed_delay as u32
@@ -188,18 +238,22 @@ impl Compressor {
peak = peak.max(self.delay[ch][det_pos].abs()); peak = peak.max(self.delay[ch][det_pos].abs());
} }
// 4) Gain computer + ballistics. On bypass we keep the delay aligned (so toggling // 4) Gain computer + ballistics. The detector ALWAYS runs (even at mix 0) so metering
// bypass doesn't shift timing) but apply unity gain and no makeup. // reflects the wet gain reduction regardless of the dry/wet blend.
let gain_lin = if set.bypass { // RMS = running mean of the linked squared level over a fixed window. Updated whenever
1.0 // active (regardless of mode) so switching peak<->RMS is seamless.
} else {
// RMS = running mean of the linked squared level over a fixed window. Updated
// whenever active (regardless of mode) so switching peak<->RMS is seamless.
self.mean_sq = self.rms_coef * self.mean_sq + (1.0 - self.rms_coef) * peak * peak; self.mean_sq = self.rms_coef * self.mean_sq + (1.0 - self.rms_coef) * peak * peak;
let detector = if set.use_rms { self.mean_sq.sqrt() } else { peak }; let detector = if set.use_rms { self.mean_sq.sqrt() } else { peak };
let level_db = 20.0 * (detector + LEVEL_EPS).log10(); let level_db = 20.0 * (detector + LEVEL_EPS).log10();
// Desired attenuation in dB, as a positive quantity. // Desired attenuation in dB, as a positive quantity.
let target = -Self::gain_computer(level_db, set.threshold_db, set.ratio, set.knee_db); let target = -Self::gain_computer(
level_db,
set.threshold_db,
set.ratio,
set.knee_db,
set.low_slope,
set.low_curve,
);
// Smooth, decoupled peak detector (Giannoulis eq. 1718) on the attenuation: // Smooth, decoupled peak detector (Giannoulis eq. 1718) on the attenuation:
// y1 = max(target, release-smoothed y1) (fast up / slow down "peak hold") // y1 = max(target, release-smoothed y1) (fast up / slow down "peak hold")
@@ -207,13 +261,14 @@ impl Compressor {
self.y1 = target.max(set.release_coef * self.y1 + (1.0 - set.release_coef) * target); self.y1 = target.max(set.release_coef * self.y1 + (1.0 - set.release_coef) * target);
self.yl = set.attack_coef * self.yl + (1.0 - set.attack_coef) * self.y1; self.yl = set.attack_coef * self.yl + (1.0 - set.attack_coef) * self.y1;
let total_db = set.makeup_db - self.yl; let wet_gain = 10.0f32.powf((set.makeup_db - self.yl) / 20.0);
10.0f32.powf(total_db / 20.0)
};
// 5) Output = delayed input (always `fixed_delay` old) * gain. // 5) Dry/wet mix (parallel compression). Both paths use the same delayed input, so the
// blend is phase-aligned. mix = 0 -> dry passthrough (clean bypass), mix = 1 -> wet.
let mix = set.mix.clamp(0.0, 1.0);
let blend = (1.0 - mix) + mix * wet_gain;
for ch in 0..n { for ch in 0..n {
output[ch] = self.delay[ch][out_pos] * gain_lin; output[ch] = self.delay[ch][out_pos] * blend;
} }
// 6) Advance the write head. // 6) Advance the write head.
@@ -241,20 +296,41 @@ mod tests {
makeup_db: 0.0, makeup_db: 0.0,
lookahead_samples: 0, lookahead_samples: 0,
use_rms: false, use_rms: false,
bypass: false, mix: 1.0,
low_slope: 1.0,
low_curve: 0.0,
} }
} }
#[test] #[test]
fn below_threshold_is_untouched() { fn below_threshold_is_untouched() {
// -30 dB input, -20 dB threshold -> no reduction. // -30 dB input, -20 dB threshold -> no reduction.
assert_eq!(Compressor::gain_computer(-30.0, -20.0, 4.0, 6.0), 0.0); assert_eq!(Compressor::gain_computer(-30.0, -20.0, 4.0, 6.0, 1.0, 0.0), 0.0);
}
#[test]
fn low_shaper_serial_slope_and_bipolar_bulge() {
let thr = -18.0;
// Serial slope-only (no curve): boost lifts -30 by 30 dB to 0 dB -> 18 dB over threshold,
// comp pulls back (1/4 - 1)*18 = -13.5 -> net 16.5.
assert_close(Compressor::gain_computer(-30.0, thr, 4.0, 0.0, 2.0, 0.0), 16.5, 1e-3);
// Cut (slope 0.5) -> -15 dB; shaped to -45, still below threshold -> net -15.
assert_close(Compressor::gain_computer(-30.0, thr, 4.0, 0.0, 0.5, 0.0), -15.0, 1e-3);
// Curvature is a BIPOLAR bulge at the middle of the low region (unity slope here).
let mid = -39.0; // middle of [-60, -18]
let flat = Compressor::gain_computer(mid, thr, 4.0, 0.0, 1.0, 0.0);
let up = Compressor::gain_computer(mid, thr, 4.0, 0.0, 1.0, 1.0);
let down = Compressor::gain_computer(mid, thr, 4.0, 0.0, 1.0, -1.0);
assert!(up > flat && flat > down, "bipolar bulge expected: {down} < {flat} < {up}");
// Endpoints are unaffected by curvature (silence anchored).
assert_close(Compressor::gain_computer(-60.0, thr, 4.0, 0.0, 1.0, 1.0), 0.0, 1e-6);
} }
#[test] #[test]
fn above_knee_follows_ratio() { fn above_knee_follows_ratio() {
// 10 dB over threshold at 4:1 -> output only 2.5 dB over -> 7.5 dB reduction. // 10 dB over threshold at 4:1 -> output only 2.5 dB over -> 7.5 dB reduction.
let r = Compressor::gain_computer(-10.0, -20.0, 4.0, 0.0); let r = Compressor::gain_computer(-10.0, -20.0, 4.0, 0.0, 1.0, 0.0);
assert_close(r, -7.5, 1e-4); assert_close(r, -7.5, 1e-4);
} }
@@ -263,11 +339,11 @@ mod tests {
// At the upper knee edge the soft-knee and linear formulas must agree. // At the upper knee edge the soft-knee and linear formulas must agree.
let (t, ratio, knee) = (0.0, 4.0, 6.0); let (t, ratio, knee) = (0.0, 4.0, 6.0);
let edge = t + knee / 2.0; let edge = t + knee / 2.0;
let knee_val = Compressor::gain_computer(edge, t, ratio, knee); let knee_val = Compressor::gain_computer(edge, t, ratio, knee, 1.0, 0.0);
let linear_val = (1.0 / ratio - 1.0) * (edge - t); let linear_val = (1.0 / ratio - 1.0) * (edge - t);
assert_close(knee_val, linear_val, 1e-4); assert_close(knee_val, linear_val, 1e-4);
// At the lower edge there is still no reduction. // At the lower edge there is still no reduction.
assert_close(Compressor::gain_computer(t - knee / 2.0, t, ratio, knee), 0.0, 1e-6); assert_close(Compressor::gain_computer(t - knee / 2.0, t, ratio, knee, 1.0, 0.0), 0.0, 1e-6);
} }
#[test] #[test]
@@ -336,7 +412,7 @@ mod tests {
for &l in &[0usize, d / 2, d] { for &l in &[0usize, d / 2, d] {
comp.reset(); comp.reset();
let mut set = settings(0.0, 1.0, 0.0); let mut set = settings(0.0, 1.0, 0.0);
set.bypass = true; // unity gain -> isolate the delay behaviour set.mix = 0.0; // dry passthrough -> isolate the delay behaviour
set.lookahead_samples = l; set.lookahead_samples = l;
let mut out = [0.0f32]; let mut out = [0.0f32];
-394
View File
@@ -1,394 +0,0 @@
//! egui editor.
//!
//! Placeholder control layout for now — Stage 6 will keep adding visualisers (a rolling
//! reduction/in/out plot next, then a gain-curve view and draggable crossover handles) and
//! eventually replace the slider columns. Built to stay usable meanwhile: a resizable window with
//! a vertical scroll area so every control is reachable at any size, global controls in a
//! label|slider grid, and the four channels (low/mid/high/all) side by side.
//!
//! Meters: a per-channel `|L | GR | R|` cluster (output level left/right + mono gain reduction in
//! the middle) plus a latching ceiling lamp, fed by the lock-free [`Meters`] state the audio
//! thread publishes each block.
use nih_plug::prelude::*;
use nih_plug_egui::{
create_egui_editor,
egui::{self, pos2, vec2, Align2, Color32, CornerRadius, CursorIcon, FontId, Painter, Rect, Sense, Stroke, Vec2},
resizable_window::ResizableWindow,
widgets,
};
use std::sync::atomic::Ordering;
use std::sync::Arc;
use crate::meters::{Meters, NUM_CHANNELS};
use crate::params::{Codename206Params, CompressorParams};
use crate::Codename206;
/// Bottom of the level meter's dB scale (top is 0 dBFS).
const METER_FLOOR_DB: f32 = -60.0;
/// Full-scale of the gain-reduction meter (bar fills downward from the top).
const GR_FULL_DB: f32 = 24.0;
/// Limiter gain reduction (dB) above which the ceiling lamp latches on.
const LAMP_TRIGGER_DB: f32 = 0.1;
/// How long the ceiling lamp stays lit after the most recent catch (seconds).
const LAMP_HOLD_S: f64 = 3.0;
/// Height of the meter panel.
const METER_PANEL_H: f32 = 130.0;
/// Height of the scrolling-plot panel.
const PLOT_PANEL_H: f32 = 150.0;
/// Number of frames held in the scrolling-plot history (~a few seconds at ~60 fps).
const PLOT_N: usize = 256;
const COLOR_IN: Color32 = Color32::from_rgb(90, 170, 235);
const COLOR_OUT: Color32 = Color32::from_rgb(90, 200, 110);
const COLOR_GR: Color32 = Color32::from_rgb(240, 150, 60);
/// Rolling history for the in/out/GR plot — kept for ALL channels at once (cheap: ~12 KB), so
/// switching the selected tab shows that channel's existing history rather than restarting blank.
/// It's a per-channel ring sampled once per GUI frame (wall-clock, not sample-accurate).
struct PlotHistory {
in_db: [[f32; PLOT_N]; NUM_CHANNELS],
out_db: [[f32; PLOT_N]; NUM_CHANNELS],
gr_db: [[f32; PLOT_N]; NUM_CHANNELS],
write: usize,
len: usize,
}
impl Default for PlotHistory {
fn default() -> Self {
Self {
in_db: [[METER_FLOOR_DB; PLOT_N]; NUM_CHANNELS],
out_db: [[METER_FLOOR_DB; PLOT_N]; NUM_CHANNELS],
gr_db: [[0.0; PLOT_N]; NUM_CHANNELS],
write: 0,
len: 0,
}
}
}
impl PlotHistory {
/// Append one frame of (in_db, out_db, gr_db) per channel.
fn push(&mut self, samples: &[(f32, f32, f32); NUM_CHANNELS]) {
for i in 0..NUM_CHANNELS {
self.in_db[i][self.write] = samples[i].0;
self.out_db[i][self.write] = samples[i].1;
self.gr_db[i][self.write] = samples[i].2;
}
self.write = (self.write + 1) % PLOT_N;
self.len = (self.len + 1).min(PLOT_N);
}
}
/// GUI-side editor state (not persisted): ceiling-lamp latch, selected plot channel, plot history,
/// and the time-based scroll cadence (flow speed = how many seconds span the plot width).
struct EditorState {
/// egui time (seconds) of the most recent ceiling catch, while the lamp is latched on.
/// `None` = lamp off (never caught, expired, or dismissed by a click).
ceiling_trigger: Option<f64>,
/// Channel shown in the plot (0..NUM_CHANNELS: low/mid/high/all).
selected: usize,
history: PlotHistory,
/// Seconds of history shown across the full plot width — the flow speed (smaller = faster).
window_s: f64,
/// egui time of the last column pushed to the history ring (the cadence clock).
last_push: f64,
/// Per-channel max accumulator (in_db, out_db, gr_db) for the column currently being built.
acc: [(f32, f32, f32); NUM_CHANNELS],
}
impl Default for EditorState {
fn default() -> Self {
Self {
ceiling_trigger: None,
selected: 0,
history: PlotHistory::default(),
window_s: 5.0,
last_push: 0.0,
acc: [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS],
}
}
}
/// Build the plugin editor over shared handles to the params and meter state.
pub(crate) fn create(params: Arc<Codename206Params>, meters: Arc<Meters>) -> Option<Box<dyn Editor>> {
let egui_state = params.editor_state.clone();
create_egui_editor(
params.editor_state.clone(),
EditorState::default(),
|_, _| {},
move |egui_ctx, setter, state| {
// Keep frames coming so the meters animate and the lamp can time out while open.
egui_ctx.request_repaint();
// One column of controls for a single compressor channel.
let band_col = |ui: &mut egui::Ui, title: &str, p: &CompressorParams| {
ui.strong(title);
ui.label("Pre-gain");
ui.add(widgets::ParamSlider::for_param(&p.pre_gain_db, setter));
ui.add(widgets::ParamSlider::for_param(&p.detection, setter));
ui.label("Threshold");
ui.add(widgets::ParamSlider::for_param(&p.threshold_db, setter));
ui.label("Ratio");
ui.add(widgets::ParamSlider::for_param(&p.ratio, setter));
ui.label("Knee");
ui.add(widgets::ParamSlider::for_param(&p.knee_db, setter));
ui.label("Attack");
ui.add(widgets::ParamSlider::for_param(&p.attack_ms, setter));
ui.label("Release");
ui.add(widgets::ParamSlider::for_param(&p.release_ms, setter));
ui.label("Makeup");
ui.add(widgets::ParamSlider::for_param(&p.makeup_db, setter));
ui.add(widgets::ParamSlider::for_param(&p.bypass, setter));
};
// Resizable window; vertical scroll so every control stays reachable even when the
// window is small. (Placeholder layout — Stage 6 will replace it.)
ResizableWindow::new("editor")
.min_size(Vec2::new(480.0, 320.0))
.show(egui_ctx, egui_state.as_ref(), |ui| {
egui::ScrollArea::vertical().show(ui, |ui| {
ui.heading(Codename206::NAME);
draw_meters(ui, &meters, state);
ui.separator();
draw_plot(ui, &meters, state);
ui.separator();
// Global controls stacked vertically so they never overflow sideways.
egui::Grid::new("globals").num_columns(2).show(ui, |ui| {
ui.label("Xover Lo/Mid");
ui.add(widgets::ParamSlider::for_param(&params.crossover_low_hz, setter));
ui.end_row();
ui.label("Xover Mid/Hi");
ui.add(widgets::ParamSlider::for_param(&params.crossover_high_hz, setter));
ui.end_row();
ui.label("Look-ahead");
ui.add(widgets::ParamSlider::for_param(&params.look_ahead_ms, setter));
ui.end_row();
ui.label("Ceiling");
ui.add(widgets::ParamSlider::for_param(&params.output_ceiling_db, setter));
ui.end_row();
ui.label("Lim Release");
ui.add(widgets::ParamSlider::for_param(&params.limiter_release_ms, setter));
ui.end_row();
});
ui.separator();
ui.columns(4, |cols| {
band_col(&mut cols[0], "LOW", &params.low);
band_col(&mut cols[1], "MID", &params.mid);
band_col(&mut cols[2], "HIGH", &params.high);
band_col(&mut cols[3], "ALL", &params.all);
});
});
});
},
)
}
/// Draw the meter panel: one channel group per column as `|L | GR | R|` (output level left/right,
/// mono gain reduction in the middle), plus the latching ceiling lamp driven by the limiter.
fn draw_meters(ui: &mut egui::Ui, meters: &Meters, state: &mut EditorState) {
let labels = ["LOW", "MID", "HIGH", "ALL"];
let now = ui.ctx().input(|i| i.time);
let (rect, _) =
ui.allocate_exact_size(vec2(ui.available_width(), METER_PANEL_H), Sense::hover());
let p = ui.painter_at(rect);
p.rect_filled(rect, CornerRadius::ZERO, Color32::from_rgb(20, 20, 24));
let top = rect.top() + 10.0;
let bottom = rect.bottom() - 18.0; // leave a row for the labels
let cell_w = rect.width() / NUM_CHANNELS as f32;
// Three bars per cluster now, so they're narrower than the old two-bar layout.
let bar_w = (cell_w * 0.17).min(14.0);
let gap = (cell_w * 0.05).min(5.0);
for i in 0..NUM_CHANNELS {
let cell_left = rect.left() + i as f32 * cell_w;
let group_w = bar_w * 3.0 + gap * 2.0;
let bx = cell_left + (cell_w - group_w) * 0.5;
// L / R output level (upward); colour warns as it nears 0 dBFS.
let l_db = util::gain_to_db(meters.level_l[i].load(Ordering::Relaxed));
let r_db = util::gain_to_db(meters.level_r[i].load(Ordering::Relaxed));
let l_frac = ((l_db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
let r_frac = ((r_db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
// Mono gain reduction (downward from the top).
let gr_db = meters.gain_reduction_db[i].load(Ordering::Relaxed);
let gr_frac = (gr_db / GR_FULL_DB).clamp(0.0, 1.0);
v_bar(&p, bx, bar_w, top, bottom, l_frac, level_color(l_db), false);
v_bar(&p, bx + bar_w + gap, bar_w, top, bottom, gr_frac, Color32::from_rgb(240, 150, 60), true);
v_bar(&p, bx + 2.0 * (bar_w + gap), bar_w, top, bottom, r_frac, level_color(r_db), false);
p.text(
pos2(cell_left + cell_w * 0.5, rect.bottom() - 2.0),
Align2::CENTER_BOTTOM,
labels[i],
FontId::proportional(12.0),
Color32::from_gray(200),
);
}
// Ceiling lamp (top-right): latches on when the limiter catches a peak, then holds. It clears
// after LAMP_HOLD_S or when clicked. Re-arms while limiting is ongoing.
if meters.limiter_gr_db.load(Ordering::Relaxed) > LAMP_TRIGGER_DB {
state.ceiling_trigger = Some(now);
}
let center = pos2(rect.right() - 14.0, rect.top() + 14.0);
let lamp_rect = Rect::from_center_size(center, vec2(22.0, 22.0));
let resp = ui
.interact(lamp_rect, ui.id().with("ceiling_lamp"), Sense::click())
.on_hover_cursor(CursorIcon::PointingHand)
.on_hover_text("Ceiling reached — click to clear");
if resp.clicked() {
state.ceiling_trigger = None;
}
// Expire the latch once the hold time has passed.
if let Some(t) = state.ceiling_trigger {
if now - t >= LAMP_HOLD_S {
state.ceiling_trigger = None;
}
}
let lamp = if state.ceiling_trigger.is_some() {
Color32::from_rgb(255, 40, 40)
} else {
Color32::from_rgb(40, 12, 12)
};
p.circle_filled(center, 7.0, lamp);
p.text(
pos2(center.x - 14.0, center.y),
Align2::RIGHT_CENTER,
"CEILING",
FontId::proportional(11.0),
Color32::from_gray(180),
);
}
/// Draw the scrolling in/out/gain-reduction plot for the selected channel, plus the channel tabs.
/// History for all channels is sampled every frame (wall-clock), so it scrolls continuously while
/// the editor is open regardless of which tab is shown.
fn draw_plot(ui: &mut egui::Ui, meters: &Meters, state: &mut EditorState) {
let now = ui.ctx().input(|i| i.time);
// (Re)initialise the cadence clock on first use or after a long gap (e.g. tab hidden).
if state.last_push <= 0.0 || now - state.last_push > state.window_s {
state.last_push = now;
}
// Accumulate this frame's block peaks into the column currently being built.
for i in 0..NUM_CHANNELS {
let in_db = util::gain_to_db(meters.plot_in[i].load(Ordering::Relaxed));
let out_db = util::gain_to_db(meters.plot_out[i].load(Ordering::Relaxed));
let gr = meters.plot_gr[i].load(Ordering::Relaxed);
state.acc[i].0 = state.acc[i].0.max(in_db);
state.acc[i].1 = state.acc[i].1.max(out_db);
state.acc[i].2 = state.acc[i].2.max(gr);
}
// Emit columns on a fixed time grid so the window length stays accurate regardless of the
// frame rate. The while loop is bounded by PLOT_N thanks to the resync above.
let dt_col = state.window_s / PLOT_N as f64;
let mut pushed = false;
while now - state.last_push >= dt_col {
state.history.push(&state.acc);
state.last_push += dt_col;
pushed = true;
}
if pushed {
state.acc = [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS];
}
// Channel tabs + flow-speed selector + legend.
let labels = ["LOW", "MID", "HIGH", "ALL"];
let speeds = [2.0f64, 5.0, 15.0, 45.0];
ui.horizontal(|ui| {
ui.label("Plot:");
for (i, l) in labels.iter().enumerate() {
ui.selectable_value(&mut state.selected, i, *l);
}
ui.separator();
ui.label("Speed:");
let mut speed_changed = false;
for &w in &speeds {
if ui.selectable_value(&mut state.window_s, w, format!("{w:.0}s")).changed() {
speed_changed = true;
}
}
if speed_changed {
// Cadence changed: start the history fresh so the time axis is consistent.
state.history = PlotHistory::default();
state.acc = [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS];
state.last_push = now;
}
ui.separator();
ui.colored_label(COLOR_IN, "in");
ui.colored_label(COLOR_OUT, "out");
ui.colored_label(COLOR_GR, "GR");
});
let (rect, _) =
ui.allocate_exact_size(vec2(ui.available_width(), PLOT_PANEL_H), Sense::hover());
let p = ui.painter_at(rect);
p.rect_filled(rect, CornerRadius::ZERO, Color32::from_rgb(16, 16, 20));
let (top, bottom, left, right) =
(rect.top() + 4.0, rect.bottom() - 4.0, rect.left() + 4.0, rect.right() - 4.0);
let width = right - left;
let y_for_db = |db: f32| -> f32 {
let frac = ((db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
bottom - frac * (bottom - top)
};
// Gridlines (dB).
for &g in &[0.0f32, -12.0, -24.0, -48.0] {
let y = y_for_db(g);
p.line_segment([pos2(left, y), pos2(right, y)], Stroke::new(1.0, Color32::from_gray(40)));
p.text(
pos2(left + 2.0, y),
Align2::LEFT_BOTTOM,
format!("{g:.0}"),
FontId::proportional(9.0),
Color32::from_gray(90),
);
}
let c = state.selected.min(NUM_CHANNELS - 1);
let (write, len) = (state.history.write, state.history.len);
if len >= 2 {
let draw_series = |series: &[f32; PLOT_N], to_db: &dyn Fn(f32) -> f32, color: Color32| {
let mut pts = Vec::with_capacity(len);
for k in 0..len {
let idx = (write + PLOT_N - len + k) % PLOT_N;
let pos = (PLOT_N - len + k) as f32 / (PLOT_N - 1) as f32; // newest hugs the right
pts.push(pos2(left + pos * width, y_for_db(to_db(series[idx]))));
}
p.add(egui::Shape::line(pts, Stroke::new(1.5, color)));
};
draw_series(&state.history.in_db[c], &|db| db, COLOR_IN);
draw_series(&state.history.out_db[c], &|db| db, COLOR_OUT);
// GR hangs from the 0 dB line: a reduction of X dB is drawn at the -X gridline.
draw_series(&state.history.gr_db[c], &|gr| -gr, COLOR_GR);
}
}
/// Draw a vertical bar within `[top, bottom]`. `frac` is 0..1; `from_top` fills downward from the
/// top (gain reduction) instead of upward from the bottom (level).
fn v_bar(p: &Painter, x: f32, w: f32, top: f32, bottom: f32, frac: f32, fill: Color32, from_top: bool) {
let track = Color32::from_rgb(34, 34, 40);
p.rect_filled(Rect::from_min_max(pos2(x, top), pos2(x + w, bottom)), CornerRadius::ZERO, track);
let h = (bottom - top) * frac.clamp(0.0, 1.0);
let filled = if from_top {
Rect::from_min_max(pos2(x, top), pos2(x + w, top + h))
} else {
Rect::from_min_max(pos2(x, bottom - h), pos2(x + w, bottom))
};
p.rect_filled(filled, CornerRadius::ZERO, fill);
}
/// Level-bar colour: green below -6 dB, yellow approaching, red near 0 dBFS.
fn level_color(db: f32) -> Color32 {
if db >= -1.0 {
Color32::from_rgb(235, 70, 60)
} else if db >= -6.0 {
Color32::from_rgb(230, 200, 70)
} else {
Color32::from_rgb(90, 200, 110)
}
}
+141
View File
@@ -0,0 +1,141 @@
//! Draggable crossover handles — replaces the two plain crossover sliders.
//!
//! A horizontal log-frequency strip split into LOW / MID / HIGH by two draggable handles, plus a
//! number box per crossover (double-click to type an exact value). The handles enforce a dynamic
//! limit: lo/mid can never exceed mid/hi (and vice-versa), on top of each param's own range.
use nih_plug::prelude::*;
use nih_plug_egui::egui::{
self, pos2, vec2, Align2, Color32, CornerRadius, DragValue, FontId, Painter, Rect, Sense, Stroke,
};
use crate::params::Codename206Params;
/// Height of the handle strip.
const GRAPH_H: f32 = 54.0;
/// Displayed frequency axis (log), independent of the params' own ranges.
const DISP_MIN_HZ: f32 = 20.0;
const DISP_MAX_HZ: f32 = 20_000.0;
fn log_span() -> f32 {
DISP_MAX_HZ.ln() - DISP_MIN_HZ.ln()
}
fn fmt_hz(hz: f32) -> String {
if hz >= 1000.0 {
format!("{:.2} kHz", hz / 1000.0)
} else {
format!("{:.0} Hz", hz)
}
}
pub(super) fn draw(ui: &mut egui::Ui, params: &Codename206Params, setter: &ParamSetter) {
let lo = params.crossover_low_hz.value();
let hi = params.crossover_high_hz.value();
// Each param's own min/max (normalized 0/1 map to the range ends).
let lo_min = params.crossover_low_hz.preview_plain(0.0);
let lo_max = params.crossover_low_hz.preview_plain(1.0);
let hi_min = params.crossover_high_hz.preview_plain(0.0);
let hi_max = params.crossover_high_hz.preview_plain(1.0);
// Dynamic limits so the two never cross: lo <= hi.
let lo_upper = lo_max.min(hi);
let hi_lower = hi_min.max(lo);
ui.label("Crossover");
let (rect, _) =
ui.allocate_exact_size(vec2(ui.available_width(), GRAPH_H), Sense::hover());
let p = ui.painter_at(rect);
let (left, right, top, bottom) =
(rect.left() + 2.0, rect.right() - 2.0, rect.top() + 2.0, rect.bottom() - 2.0);
let width = right - left;
let x_for = |hz: f32| left + (hz.max(1.0).ln() - DISP_MIN_HZ.ln()) / log_span() * width;
let xlo = x_for(lo);
let xhi = x_for(hi);
// Three band regions.
p.rect_filled(Rect::from_min_max(pos2(left, top), pos2(xlo, bottom)), CornerRadius::ZERO, Color32::from_rgb(28, 38, 52));
p.rect_filled(Rect::from_min_max(pos2(xlo, top), pos2(xhi, bottom)), CornerRadius::ZERO, Color32::from_rgb(30, 48, 36));
p.rect_filled(Rect::from_min_max(pos2(xhi, top), pos2(right, bottom)), CornerRadius::ZERO, Color32::from_rgb(52, 38, 30));
let band_label = |cx: f32, t: &str| {
p.text(pos2(cx, top + 2.0), Align2::CENTER_TOP, t, FontId::proportional(11.0), Color32::from_gray(160));
};
band_label((left + xlo) * 0.5, "LOW");
band_label((xlo + xhi) * 0.5, "MID");
band_label((xhi + right) * 0.5, "HIGH");
handle(ui, &p, setter, "xover_lo", xlo, lo, &params.crossover_low_hz, lo_min, lo_upper, left, width, top, bottom, Color32::from_rgb(120, 170, 230));
handle(ui, &p, setter, "xover_hi", xhi, hi, &params.crossover_high_hz, hi_lower, hi_max, left, width, top, bottom, Color32::from_rgb(230, 150, 120));
// Number boxes (double-click to type). Clamped to the same dynamic limits.
ui.horizontal(|ui| {
ui.label("Lo/Mid");
let mut v = lo as f64;
if ui
.add(DragValue::new(&mut v).range(lo_min as f64..=lo_upper as f64).speed(0.5).suffix(" Hz"))
.changed()
{
set_clamped(setter, &params.crossover_low_hz, v as f32, lo_min, lo_upper);
}
ui.add_space(16.0);
ui.label("Mid/Hi");
let mut v = hi as f64;
if ui
.add(DragValue::new(&mut v).range(hi_lower as f64..=hi_max as f64).speed(2.0).suffix(" Hz"))
.changed()
{
set_clamped(setter, &params.crossover_high_hz, v as f32, hi_lower, hi_max);
}
});
}
/// One draggable vertical handle. Drives `param` from the pointer's x (log-frequency), clamped to
/// `[min, max]` (which already encodes the dynamic lo<=hi limit), with proper begin/end gestures.
#[allow(clippy::too_many_arguments)]
fn handle(
ui: &egui::Ui,
p: &Painter,
setter: &ParamSetter,
id_salt: &str,
x: f32,
hz: f32,
param: &FloatParam,
min: f32,
max: f32,
left: f32,
width: f32,
top: f32,
bottom: f32,
color: Color32,
) {
let hit = Rect::from_min_max(pos2(x - 5.0, top), pos2(x + 5.0, bottom));
let resp = ui
.interact(hit, ui.id().with(id_salt), Sense::drag())
.on_hover_cursor(egui::CursorIcon::ResizeHorizontal);
if resp.drag_started() {
setter.begin_set_parameter(param);
}
if resp.dragged() {
if let Some(pos) = resp.interact_pointer_pos() {
let frac = ((pos.x - left) / width).clamp(0.0, 1.0);
let new = (DISP_MIN_HZ.ln() + frac * log_span()).exp().clamp(min, max);
setter.set_parameter(param, new);
}
}
if resp.drag_stopped() {
setter.end_set_parameter(param);
}
let col = if resp.dragged() || resp.hovered() { Color32::WHITE } else { color };
p.line_segment([pos2(x, top), pos2(x, bottom)], Stroke::new(2.0, col));
p.text(pos2(x, bottom - 1.0), Align2::CENTER_BOTTOM, fmt_hz(hz), FontId::proportional(10.0), Color32::from_gray(220));
}
/// Set a param to `value` clamped to `[min, max]`, wrapped in its own gesture (for the number box).
fn set_clamped(setter: &ParamSetter, param: &FloatParam, value: f32, min: f32, max: f32) {
setter.begin_set_parameter(param);
setter.set_parameter(param, value.clamp(min, max));
setter.end_set_parameter(param);
}
+106
View File
@@ -0,0 +1,106 @@
//! Static gain-curve display: output level vs input level for the channel currently selected in
//! the plot. Plots the wet transfer `out = (in + pre_gain) + gain_reduction(...) + makeup` (mix not
//! folded in; output clamped at 0 dBFS), plus a live **operating-point fill** under the curve up to
//! the channel's current input level — its right edge rides the curve (width = input, height = out).
use nih_plug::prelude::util;
use nih_plug_egui::egui::{self, pos2, vec2, Align2, Color32, CornerRadius, FontId, Sense, Stroke};
use std::sync::atomic::Ordering;
use crate::dsp::compressor::Compressor;
use crate::meters::Meters;
use crate::params::Codename206Params;
/// Side length of the square plot.
const CURVE_SIZE: f32 = 150.0;
/// dB extent of both axes (bottom/left = FLOOR_DB, top/right = 0 dBFS).
const FLOOR_DB: f32 = -60.0;
pub(super) fn draw(ui: &mut egui::Ui, params: &Codename206Params, selected: usize, meters: &Meters) {
let labels = ["LOW", "MID", "HIGH", "ALL"];
let ch = selected.min(3);
let cp = match ch {
0 => &params.low,
1 => &params.mid,
2 => &params.high,
_ => &params.all,
};
let pre = cp.pre_gain_db.value();
let threshold = cp.threshold_db.value();
let ratio = cp.ratio.value();
let knee = cp.knee_db.value();
let low_slope = cp.low_slope.value();
let low_curve = cp.low_curve.value();
let makeup = cp.makeup_db.value();
ui.label(format!("Curve: {}", labels[ch]));
let (rect, _) = ui.allocate_exact_size(vec2(CURVE_SIZE, CURVE_SIZE), Sense::hover());
let p = ui.painter_at(rect);
p.rect_filled(rect, CornerRadius::ZERO, Color32::from_rgb(16, 16, 20));
let inset = 2.0;
let (left, right, top, bottom) =
(rect.left() + inset, rect.right() - inset, rect.top() + inset, rect.bottom() - inset);
let w = right - left;
let h = bottom - top;
let x_for = |db: f32| left + (db - FLOOR_DB) / -FLOOR_DB * w;
let y_for = |db: f32| bottom - (db - FLOOR_DB) / -FLOOR_DB * h;
// -6 dBFS reference lines on both axes.
let g6 = Color32::from_gray(38);
let x6 = x_for(-6.0);
let y6 = y_for(-6.0);
p.line_segment([pos2(x6, top), pos2(x6, bottom)], Stroke::new(1.0, g6));
p.line_segment([pos2(left, y6), pos2(right, y6)], Stroke::new(1.0, g6));
// Unity reference (out = in), bottom-left to top-right.
p.line_segment([pos2(left, bottom), pos2(right, top)], Stroke::new(1.0, Color32::from_gray(45)));
// Threshold marker on the input axis — shifted left by pre-gain (the comp sees in + pre).
let tx = x_for((threshold - pre).clamp(FLOOR_DB, 0.0));
p.line_segment([pos2(tx, top), pos2(tx, bottom)], Stroke::new(1.0, Color32::from_rgb(80, 60, 45)));
// Full wet transfer: drive into the comp, then makeup. (Mix not folded in.)
let n = 96;
let mut pts = Vec::with_capacity(n + 1);
for i in 0..=n {
let in_db = FLOOR_DB + (i as f32 / n as f32) * -FLOOR_DB; // external input, -60..0
let driven = in_db + pre;
let gr = Compressor::gain_computer(driven, threshold, ratio, knee, low_slope, low_curve); // signed dB
let out_db = (driven + gr + makeup).clamp(FLOOR_DB, 0.0);
pts.push(pos2(x_for(in_db), y_for(out_db)));
}
// Operating-point fill: shade under the curve from the floor up to the current input level.
let driven_now = util::gain_to_db(meters.input_level[ch].load(Ordering::Relaxed));
let ext_in = (driven_now - pre).clamp(FLOOR_DB, 0.0); // external input -> curve x
let x_now = x_for(ext_in);
let fill_col = Color32::from_rgba_unmultiplied(120, 200, 160, 45);
for seg in pts.windows(2) {
let a = seg[0];
let mut b = seg[1];
if a.x >= x_now {
break;
}
if b.x > x_now {
let f = ((x_now - a.x) / (b.x - a.x)).clamp(0.0, 1.0); // clip the last quad at x_now
b = pos2(x_now, a.y + (b.y - a.y) * f);
}
p.add(egui::Shape::convex_polygon(
vec![pos2(a.x, bottom), a, b, pos2(b.x, bottom)],
fill_col,
Stroke::NONE,
));
}
p.add(egui::Shape::line(pts, Stroke::new(1.6, Color32::from_rgb(120, 200, 160))));
// Operating-point dot, on the curve at the current input.
let driven = ext_in + pre;
let gr = Compressor::gain_computer(driven, threshold, ratio, knee, low_slope, low_curve);
let out_op = (driven + gr + makeup).clamp(FLOOR_DB, 0.0);
p.circle_filled(pos2(x_now, y_for(out_op)), 3.0, Color32::from_rgb(235, 240, 235));
// Corner dB ticks + the -6 dB reference.
p.text(pos2(left + 1.0, top + 1.0), Align2::LEFT_TOP, "0", FontId::proportional(9.0), Color32::from_gray(90));
p.text(pos2(left + 1.0, bottom - 1.0), Align2::LEFT_BOTTOM, "-60", FontId::proportional(9.0), Color32::from_gray(90));
p.text(pos2(x6 + 2.0, bottom - 1.0), Align2::LEFT_BOTTOM, "-6", FontId::proportional(9.0), Color32::from_gray(80));
}
+143
View File
@@ -0,0 +1,143 @@
//! Per-channel level + gain-reduction meters, each with its own latching ceiling/over lamp.
//!
//! Each channel is a `|L | GR | R|` cluster (output level left/right, mono gain reduction in the
//! middle) topped by a lamp. The lamp latches when the channel's output reaches 0 dBFS (a hot /
//! "over" warning — useful when pre-gain drives a band hard); for the ALL channel it also lights
//! when the output limiter is actually catching peaks. It holds, then clears after `LAMP_HOLD_S`
//! or on a click. Fed by the lock-free [`Meters`] state the audio thread publishes each block.
use nih_plug::prelude::*;
use nih_plug_egui::egui::{
self, pos2, vec2, Align2, Color32, CornerRadius, CursorIcon, FontId, Painter, Rect, Sense,
};
use std::sync::atomic::Ordering;
use super::METER_FLOOR_DB;
use crate::meters::{Meters, NUM_CHANNELS};
/// Full-scale of the gain-reduction bar (fills downward from the top).
const GR_FULL_DB: f32 = 24.0;
/// Output level (dBFS) at/above which a channel's lamp latches on.
const OVER_DB: f32 = 0.0;
/// Limiter gain reduction (dB) above which the ALL channel's lamp also latches on.
const LAMP_TRIGGER_DB: f32 = 0.1;
/// How long a lamp stays lit after the most recent trigger (seconds).
const LAMP_HOLD_S: f64 = 3.0;
/// Height of the meter panel.
const METER_PANEL_H: f32 = 140.0;
/// GUI-side state for the meter panel: one lamp latch per channel.
pub(super) struct MeterState {
/// egui time (seconds) of each channel's most recent lamp trigger, while latched on.
/// `None` = lamp off (never triggered, expired, or dismissed by a click).
ceiling_trigger: [Option<f64>; NUM_CHANNELS],
}
impl Default for MeterState {
fn default() -> Self {
Self { ceiling_trigger: [None; NUM_CHANNELS] }
}
}
/// Draw the meter panel: a `|L | GR | R|` cluster + a latching over/ceiling lamp per channel.
pub(super) fn draw(ui: &mut egui::Ui, meters: &Meters, state: &mut MeterState) {
let labels = ["LOW", "MID", "HIGH", "ALL"];
let now = ui.ctx().input(|i| i.time);
let (rect, _) =
ui.allocate_exact_size(vec2(ui.available_width(), METER_PANEL_H), Sense::hover());
let p = ui.painter_at(rect);
p.rect_filled(rect, CornerRadius::ZERO, Color32::from_rgb(20, 20, 24));
let top = rect.top() + 22.0; // leave a row at the top for the lamps
let bottom = rect.bottom() - 18.0; // and a row at the bottom for the labels
let cell_w = rect.width() / NUM_CHANNELS as f32;
// Three bars per cluster, so they're narrower than a two-bar layout.
let bar_w = (cell_w * 0.17).min(14.0);
let gap = (cell_w * 0.05).min(5.0);
for i in 0..NUM_CHANNELS {
let cell_left = rect.left() + i as f32 * cell_w;
let group_w = bar_w * 3.0 + gap * 2.0;
let bx = cell_left + (cell_w - group_w) * 0.5;
// L / R output level (upward); colour warns as it nears 0 dBFS.
let l_db = util::gain_to_db(meters.level_l[i].load(Ordering::Relaxed));
let r_db = util::gain_to_db(meters.level_r[i].load(Ordering::Relaxed));
let l_frac = ((l_db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
let r_frac = ((r_db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
// Mono gain reduction (downward from the top).
let gr_db = meters.gain_reduction_db[i].load(Ordering::Relaxed);
let gr_frac = (gr_db / GR_FULL_DB).clamp(0.0, 1.0);
v_bar(&p, bx, bar_w, top, bottom, l_frac, level_color(l_db), false);
v_bar(&p, bx + bar_w + gap, bar_w, top, bottom, gr_frac, Color32::from_rgb(240, 150, 60), true);
v_bar(&p, bx + 2.0 * (bar_w + gap), bar_w, top, bottom, r_frac, level_color(r_db), false);
p.text(
pos2(cell_left + cell_w * 0.5, rect.bottom() - 2.0),
Align2::CENTER_BOTTOM,
labels[i],
FontId::proportional(12.0),
Color32::from_gray(200),
);
// Per-channel lamp: latch on output reaching 0 dBFS; the ALL channel also latches when the
// output limiter is catching peaks (the true master-ceiling event).
let over_db = l_db.max(r_db);
let mut triggered = over_db >= OVER_DB;
if i == NUM_CHANNELS - 1 {
triggered |= meters.limiter_gr_db.load(Ordering::Relaxed) > LAMP_TRIGGER_DB;
}
if triggered {
state.ceiling_trigger[i] = Some(now);
}
let lamp_center = pos2(cell_left + cell_w * 0.5, rect.top() + 11.0);
let lamp_rect = Rect::from_center_size(lamp_center, vec2(18.0, 18.0));
let resp = ui
.interact(lamp_rect, ui.id().with(("ceiling_lamp", i)), Sense::click())
.on_hover_cursor(CursorIcon::PointingHand)
.on_hover_text("Output reached 0 dBFS — click to clear");
if resp.clicked() {
state.ceiling_trigger[i] = None;
}
if let Some(t) = state.ceiling_trigger[i] {
if now - t >= LAMP_HOLD_S {
state.ceiling_trigger[i] = None;
}
}
let lamp = if state.ceiling_trigger[i].is_some() {
Color32::from_rgb(255, 40, 40)
} else {
Color32::from_rgb(40, 12, 12)
};
p.circle_filled(lamp_center, 5.0, lamp);
}
}
/// Draw a vertical bar within `[top, bottom]`. `frac` is 0..1; `from_top` fills downward from the
/// top (gain reduction) instead of upward from the bottom (level).
fn v_bar(p: &Painter, x: f32, w: f32, top: f32, bottom: f32, frac: f32, fill: Color32, from_top: bool) {
let track = Color32::from_rgb(34, 34, 40);
p.rect_filled(Rect::from_min_max(pos2(x, top), pos2(x + w, bottom)), CornerRadius::ZERO, track);
let h = (bottom - top) * frac.clamp(0.0, 1.0);
let filled = if from_top {
Rect::from_min_max(pos2(x, top), pos2(x + w, top + h))
} else {
Rect::from_min_max(pos2(x, bottom - h), pos2(x + w, bottom))
};
p.rect_filled(filled, CornerRadius::ZERO, fill);
}
/// Level-bar colour: green below -6 dB, yellow approaching, red near 0 dBFS.
fn level_color(db: f32) -> Color32 {
if db >= -1.0 {
Color32::from_rgb(235, 70, 60)
} else if db >= -6.0 {
Color32::from_rgb(230, 200, 70)
} else {
Color32::from_rgb(90, 200, 110)
}
}
+116
View File
@@ -0,0 +1,116 @@
//! egui editor: assembly + control layout.
//!
//! The aggregator. Builds the editor window and lays out the heading, the meter panel
//! ([`meter`]), the rolling plot ([`plot`]), and the (placeholder) per-channel slider columns.
//! Each visualiser owns its GUI state and drawing in its submodule; this module wires them
//! together and holds the shared [`EditorState`]. When the UI is redesigned the slider columns
//! get replaced and the visualisers stay as self-contained widgets.
use nih_plug::prelude::*;
use nih_plug_egui::{
create_egui_editor,
egui::{self, Vec2},
resizable_window::ResizableWindow,
widgets,
};
use std::sync::Arc;
use crate::meters::Meters;
use crate::params::{Codename206Params, CompressorParams};
use crate::Codename206;
mod crossover;
mod gain_curve;
mod meter;
mod plot;
/// Bottom of the dB scale shared by the meters and the plot (top is 0 dBFS).
const METER_FLOOR_DB: f32 = -60.0;
/// GUI-side editor state (not persisted): the per-widget state for the meter panel and the plot.
#[derive(Default)]
struct EditorState {
meter: meter::MeterState,
plot: plot::PlotState,
}
/// Build the plugin editor over shared handles to the params and meter state.
pub(crate) fn create(params: Arc<Codename206Params>, meters: Arc<Meters>) -> Option<Box<dyn Editor>> {
let egui_state = params.editor_state.clone();
create_egui_editor(
params.editor_state.clone(),
EditorState::default(),
|_, _| {},
move |egui_ctx, setter, state| {
// Keep frames coming so the meters animate and the lamp can time out while open.
egui_ctx.request_repaint();
// One column of controls for a single compressor channel (placeholder layout).
let band_col = |ui: &mut egui::Ui, title: &str, p: &CompressorParams| {
// Roughly in signal order: input drive -> low shaper -> compressor -> output.
ui.strong(title);
ui.label("Pre-gain");
ui.add(widgets::ParamSlider::for_param(&p.pre_gain_db, setter));
ui.add(widgets::ParamSlider::for_param(&p.detection, setter));
ui.label("Low Slope");
ui.add(widgets::ParamSlider::for_param(&p.low_slope, setter));
ui.label("Low Curve");
ui.add(widgets::ParamSlider::for_param(&p.low_curve, setter));
ui.label("Threshold");
ui.add(widgets::ParamSlider::for_param(&p.threshold_db, setter));
ui.label("Ratio");
ui.add(widgets::ParamSlider::for_param(&p.ratio, setter));
ui.label("Knee");
ui.add(widgets::ParamSlider::for_param(&p.knee_db, setter));
ui.label("Attack");
ui.add(widgets::ParamSlider::for_param(&p.attack_ms, setter));
ui.label("Release");
ui.add(widgets::ParamSlider::for_param(&p.release_ms, setter));
ui.label("Makeup");
ui.add(widgets::ParamSlider::for_param(&p.makeup_db, setter));
ui.label("Mix");
ui.add(widgets::ParamSlider::for_param(&p.mix, setter));
};
// Resizable window; vertical scroll so every control stays reachable even when the
// window is small. (Placeholder layout — the redesign will replace the slider columns.)
ResizableWindow::new("editor")
.min_size(Vec2::new(480.0, 320.0))
.show(egui_ctx, egui_state.as_ref(), |ui| {
egui::ScrollArea::vertical().show(ui, |ui| {
ui.heading(Codename206::NAME);
meter::draw(ui, &meters, &mut state.meter);
ui.separator();
// Gain curve (left, square) beside the scrolling plot (right, fills the rest).
let selected = state.plot.selected;
ui.horizontal_top(|ui| {
ui.vertical(|ui| gain_curve::draw(ui, &params, selected, &meters));
ui.vertical(|ui| plot::draw(ui, &meters, &mut state.plot));
});
ui.separator();
crossover::draw(ui, &params, setter);
ui.separator();
// Global controls stacked vertically so they never overflow sideways.
egui::Grid::new("globals").num_columns(2).show(ui, |ui| {
ui.label("Look-ahead");
ui.add(widgets::ParamSlider::for_param(&params.look_ahead_ms, setter));
ui.end_row();
ui.label("Ceiling");
ui.add(widgets::ParamSlider::for_param(&params.output_ceiling_db, setter));
ui.end_row();
ui.label("Lim Release");
ui.add(widgets::ParamSlider::for_param(&params.limiter_release_ms, setter));
ui.end_row();
});
ui.separator();
ui.columns(4, |cols| {
band_col(&mut cols[0], "LOW", &params.low);
band_col(&mut cols[1], "MID", &params.mid);
band_col(&mut cols[2], "HIGH", &params.high);
band_col(&mut cols[3], "ALL", &params.all);
});
});
});
},
)
}
+226
View File
@@ -0,0 +1,226 @@
//! Rolling input/output/gain-reduction plot with per-channel tabs and a flow-speed selector.
//!
//! Histories for all four channels run continuously (cheap), so switching tabs shows that
//! channel's existing history. It's fed by draining the audio thread's scope ring
//! ([`Meters::scope`], clocked at `BUCKET_HZ`), so the horizontal resolution is set by the bucket
//! rate rather than the editor frame rate. Buckets are folded into `PLOT_N` columns
//! (peak-preserving); `window_s` (the flow speed) sets how many buckets span each column.
use nih_plug::prelude::*;
use nih_plug_egui::egui::{self, pos2, vec2, Align2, Color32, CornerRadius, FontId, Rect, Sense, Stroke};
use super::METER_FLOOR_DB;
use crate::meters::{Meters, BUCKET_HZ, NUM_CHANNELS};
/// Height of the plot panel.
const PLOT_PANEL_H: f32 = 150.0;
/// Number of columns held in the history ring.
const PLOT_N: usize = 256;
const COLOR_IN: Color32 = Color32::from_rgb(90, 170, 235);
const COLOR_OUT: Color32 = Color32::from_rgb(90, 200, 110);
const COLOR_GR: Color32 = Color32::from_rgb(240, 150, 60);
/// Rolling history for all channels: a per-channel ring of (in_db, out_db, gr_db) columns.
struct PlotHistory {
in_db: [[f32; PLOT_N]; NUM_CHANNELS],
out_db: [[f32; PLOT_N]; NUM_CHANNELS],
gr_db: [[f32; PLOT_N]; NUM_CHANNELS],
/// Per-column flag: the output limiter hit the ceiling somewhere in this column.
hit: [bool; PLOT_N],
write: usize,
len: usize,
}
impl Default for PlotHistory {
fn default() -> Self {
Self {
in_db: [[METER_FLOOR_DB; PLOT_N]; NUM_CHANNELS],
out_db: [[METER_FLOOR_DB; PLOT_N]; NUM_CHANNELS],
gr_db: [[0.0; PLOT_N]; NUM_CHANNELS],
hit: [false; PLOT_N],
write: 0,
len: 0,
}
}
}
impl PlotHistory {
/// Append one column of (in_db, out_db, gr_db) per channel, plus the ceiling-hit flag.
fn push(&mut self, samples: &[(f32, f32, f32); NUM_CHANNELS], hit: bool) {
for i in 0..NUM_CHANNELS {
self.in_db[i][self.write] = samples[i].0;
self.out_db[i][self.write] = samples[i].1;
self.gr_db[i][self.write] = samples[i].2;
}
self.hit[self.write] = hit;
self.write = (self.write + 1) % PLOT_N;
self.len = (self.len + 1).min(PLOT_N);
}
}
/// GUI-side state for the plot: selected channel, history ring, ring-drain cursor, and the
/// column being assembled from drained buckets.
pub(super) struct PlotState {
/// Channel shown in the plot (0..NUM_CHANNELS: low/mid/high/all). Also drives the gain curve.
pub(super) selected: usize,
history: PlotHistory,
/// Seconds of history shown across the full plot width — the flow speed (smaller = faster).
window_s: f64,
/// Read position into the scope ring; `None` until the first frame (then starts at "now").
cursor: Option<u64>,
/// Per-channel max accumulator (in_db, out_db, gr_db) for the column currently being built.
col_acc: [(f32, f32, f32); NUM_CHANNELS],
/// Ceiling-hit flag accumulated for the column currently being built.
col_hit: bool,
/// Buckets folded into the current column so far (fractional — a column may span <1 bucket).
col_fill: f64,
}
impl Default for PlotState {
fn default() -> Self {
Self {
selected: 0,
history: PlotHistory::default(),
window_s: 5.0,
cursor: None,
col_acc: [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS],
col_hit: false,
col_fill: 0.0,
}
}
}
/// Draw the scrolling in/out/gain-reduction plot for the selected channel, plus the channel tabs
/// and flow-speed selector. History for all channels advances every frame regardless of the tab.
pub(super) fn draw(ui: &mut egui::Ui, meters: &Meters, state: &mut PlotState) {
// Buckets that make up one column at the current flow speed (may be fractional).
let buckets_per_col = (state.window_s * BUCKET_HZ as f64 / PLOT_N as f64).max(1e-6);
// Drain every bucket produced since the last frame (audio-clocked), folding them into columns.
// A fresh cursor starts at "now" so we don't replay stale buckets.
{
let w0 = meters.scope.write_index();
let cursor = state.cursor.get_or_insert(w0);
let history = &mut state.history;
let col_acc = &mut state.col_acc;
let col_hit = &mut state.col_hit;
let col_fill = &mut state.col_fill;
meters.scope.drain(cursor, |in_lin, out_lin, gr_db, hit| {
for ch in 0..NUM_CHANNELS {
col_acc[ch].0 = col_acc[ch].0.max(util::gain_to_db(in_lin[ch]));
col_acc[ch].1 = col_acc[ch].1.max(util::gain_to_db(out_lin[ch]));
col_acc[ch].2 = col_acc[ch].2.max(gr_db[ch]);
}
*col_hit |= hit > 0.5;
*col_fill += 1.0;
while *col_fill >= buckets_per_col {
history.push(col_acc, *col_hit);
*col_acc = [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS];
*col_hit = false;
*col_fill -= buckets_per_col;
}
});
}
// Channel tabs + flow-speed selector + legend.
let labels = ["LOW", "MID", "HIGH", "ALL"];
let speeds = [2.0f64, 5.0, 15.0, 45.0];
ui.horizontal(|ui| {
ui.label("Plot:");
for (i, l) in labels.iter().enumerate() {
ui.selectable_value(&mut state.selected, i, *l);
}
ui.separator();
ui.label("Speed:");
let mut speed_changed = false;
for &w in &speeds {
if ui.selectable_value(&mut state.window_s, w, format!("{w:.0}s")).changed() {
speed_changed = true;
}
}
if speed_changed {
// Cadence changed: start the history fresh so the time axis is consistent.
state.history = PlotHistory::default();
state.col_acc = [(METER_FLOOR_DB, METER_FLOOR_DB, 0.0); NUM_CHANNELS];
state.col_hit = false;
state.col_fill = 0.0;
}
ui.separator();
ui.colored_label(COLOR_IN, "in");
ui.colored_label(COLOR_OUT, "out");
ui.colored_label(COLOR_GR, "GR");
});
let (rect, _) =
ui.allocate_exact_size(vec2(ui.available_width(), PLOT_PANEL_H), Sense::hover());
let p = ui.painter_at(rect);
p.rect_filled(rect, CornerRadius::ZERO, Color32::from_rgb(16, 16, 20));
let (top, bottom, left, right) =
(rect.top() + 4.0, rect.bottom() - 4.0, rect.left() + 4.0, rect.right() - 4.0);
let width = right - left;
let y_for_db = |db: f32| -> f32 {
let frac = ((db - METER_FLOOR_DB) / -METER_FLOOR_DB).clamp(0.0, 1.0);
bottom - frac * (bottom - top)
};
// Gridlines (dB).
for &g in &[0.0f32, -12.0, -24.0, -48.0] {
let y = y_for_db(g);
p.line_segment([pos2(left, y), pos2(right, y)], Stroke::new(1.0, Color32::from_gray(40)));
p.text(
pos2(left + 2.0, y),
Align2::LEFT_BOTTOM,
format!("{g:.0}"),
FontId::proportional(9.0),
Color32::from_gray(90),
);
}
let c = state.selected.min(NUM_CHANNELS - 1);
let (write, len) = (state.history.write, state.history.len);
if len >= 2 {
let draw_series = |series: &[f32; PLOT_N], to_db: &dyn Fn(f32) -> f32, color: Color32, fill: bool| {
let mut pts = Vec::with_capacity(len);
for k in 0..len {
let idx = (write + PLOT_N - len + k) % PLOT_N;
let pos = (PLOT_N - len + k) as f32 / (PLOT_N - 1) as f32; // newest hugs the right
pts.push(pos2(left + pos * width, y_for_db(to_db(series[idx]))));
}
if fill {
// Fill as a strip of per-segment convex quads down to the baseline. A single
// concave polygon mis-tessellates in egui (it fans from one corner, leaving stray
// triangles), so build convex pieces — one box per time unit — instead.
let fill_col = Color32::from_rgba_unmultiplied(color.r(), color.g(), color.b(), 40);
for seg in pts.windows(2) {
let (a, b) = (seg[0], seg[1]);
p.add(egui::Shape::convex_polygon(
vec![pos2(a.x, bottom), pos2(a.x, a.y), pos2(b.x, b.y), pos2(b.x, bottom)],
fill_col,
Stroke::NONE,
));
}
}
p.add(egui::Shape::line(pts, Stroke::new(1.5, color)));
};
draw_series(&state.history.in_db[c], &|db| db, COLOR_IN, true);
draw_series(&state.history.out_db[c], &|db| db, COLOR_OUT, true);
// GR hangs from the 0 dB line: a reduction of X dB is drawn at the -X gridline.
draw_series(&state.history.gr_db[c], &|gr| -gr, COLOR_GR, false);
// Ceiling-hit markers: a short red tick at the TOP for any column where the output limiter
// hit the ceiling (global — shown on every channel's view). One column wide, so runs of
// hits merge into a continuous segment and a lone hit is just a dot. Nothing otherwise.
let dx = width / (PLOT_N - 1) as f32;
let marker = Color32::from_rgb(235, 45, 45);
for k in 0..len {
let idx = (write + PLOT_N - len + k) % PLOT_N;
if state.history.hit[idx] {
let pos = (PLOT_N - len + k) as f32 / (PLOT_N - 1) as f32;
let x = left + pos * width;
p.rect_filled(Rect::from_min_max(pos2(x, top), pos2(x + dx, top + 3.0)), CornerRadius::ZERO, marker);
}
}
}
}
+86 -17
View File
@@ -40,8 +40,22 @@ struct Codename206 {
/// Per-sample decay factor for the meter peak-hold (computed from the sample rate; raised to /// Per-sample decay factor for the meter peak-hold (computed from the sample rate; raised to
/// the block length when applied once per block in `process`). /// the block length when applied once per block in `process`).
meter_decay_weight: f32, meter_decay_weight: f32,
/// Per-channel max accumulators for the plot bucket currently being built (in/out linear, GR
/// dB). Persist across blocks since a bucket spans many samples.
scope_in: [f32; 4],
scope_out: [f32; 4],
scope_gr: [f32; 4],
/// Max output-limiter gain reduction seen in the current bucket (for the ceiling-hit marker).
scope_hit: f32,
/// Samples accumulated into the current bucket, and the bucket length (= sample_rate / BUCKET_HZ).
scope_samples: usize,
scope_bucket_len: usize,
} }
/// Limiter gain reduction (dB) above which a plot bucket is flagged as hitting the ceiling.
const CEILING_HIT_GR_DB: f32 = 0.1;
impl Default for Codename206 { impl Default for Codename206 {
fn default() -> Self { fn default() -> Self {
Self { Self {
@@ -52,6 +66,12 @@ impl Default for Codename206 {
limiter: Limiter::new(), limiter: Limiter::new(),
meters: Arc::new(Meters::default()), meters: Arc::new(Meters::default()),
meter_decay_weight: 1.0, meter_decay_weight: 1.0,
scope_in: [0.0; 4],
scope_out: [0.0; 4],
scope_gr: [0.0; 4],
scope_hit: 0.0,
scope_samples: 0,
scope_bucket_len: 1,
} }
} }
} }
@@ -115,6 +135,10 @@ impl Plugin for Codename206 {
self.meter_decay_weight = self.meter_decay_weight =
0.25f64.powf((self.sample_rate as f64 * METER_DECAY_MS / 1000.0).recip()) as f32; 0.25f64.powf((self.sample_rate as f64 * METER_DECAY_MS / 1000.0).recip()) as f32;
// Plot bucket length: emit a scope bucket every ~1/BUCKET_HZ seconds.
self.scope_bucket_len =
((self.sample_rate / meters::BUCKET_HZ as f32).round() as usize).max(1);
for comp in &mut self.comps { for comp in &mut self.comps {
comp.prepare(self.sample_rate, channels, MAX_LOOKAHEAD_MS); comp.prepare(self.sample_rate, channels, MAX_LOOKAHEAD_MS);
} }
@@ -140,15 +164,21 @@ impl Plugin for Codename206 {
comp.reset(); comp.reset();
} }
self.limiter.reset(); self.limiter.reset();
// Transport restart / sample-rate change: drop stale meter values to silence. // Transport restart / sample-rate change: drop stale meter values to silence and discard
// the in-flight plot bucket.
self.meters.clear(); self.meters.clear();
self.scope_in = [0.0; 4];
self.scope_out = [0.0; 4];
self.scope_gr = [0.0; 4];
self.scope_hit = 0.0;
self.scope_samples = 0;
} }
fn process( fn process(
&mut self, &mut self,
buffer: &mut Buffer, buffer: &mut Buffer,
_aux: &mut AuxiliaryBuffers, _aux: &mut AuxiliaryBuffers,
_context: &mut impl ProcessContext<Self>, context: &mut impl ProcessContext<Self>,
) -> ProcessStatus { ) -> ProcessStatus {
let lookahead = self.lookahead_samples(); let lookahead = self.lookahead_samples();
@@ -175,10 +205,13 @@ impl Plugin for Codename206 {
// Only do the (cheap) metering work when the editor is actually open. // Only do the (cheap) metering work when the editor is actually open.
let metering = self.params.editor_state.is_open(); let metering = self.params.editor_state.is_open();
// The host keeps calling process() with silence while stopped/paused (FL does), so the
// scope is gated on the transport actually playing — otherwise it would scroll silence.
let playing = context.transport().playing;
let num_samples = buffer.samples(); let num_samples = buffer.samples();
let mut lvl_l = [0.0f32; meters::NUM_CHANNELS]; let mut lvl_l = [0.0f32; meters::NUM_CHANNELS];
let mut lvl_r = [0.0f32; meters::NUM_CHANNELS]; let mut lvl_r = [0.0f32; meters::NUM_CHANNELS];
let mut inp = [0.0f32; meters::NUM_CHANNELS]; // mono input peak (for the scrolling plot) let mut inp = [0.0f32; meters::NUM_CHANNELS]; // mono input level (detector / gain-curve x)
let mut gr = [0.0f32; meters::NUM_CHANNELS]; let mut gr = [0.0f32; meters::NUM_CHANNELS];
let mut lim_gr = 0.0f32; let mut lim_gr = 0.0f32;
@@ -212,16 +245,28 @@ impl Plugin for Codename206 {
band_in[b][ch] *= pre; band_in[b][ch] *= pre;
} }
band_set[b].makeup_db = band_params[b].makeup_db.smoothed.next(); band_set[b].makeup_db = band_params[b].makeup_db.smoothed.next();
band_set[b].mix = band_params[b].mix.smoothed.next();
band_set[b].low_slope = band_params[b].low_slope.smoothed.next();
band_set[b].low_curve = band_params[b].low_curve.smoothed.next();
self.comps[b].process(&band_in[b][..n], &mut band_out[b][..n], &band_set[b]); self.comps[b].process(&band_in[b][..n], &mut band_out[b][..n], &band_set[b]);
for ch in 0..n { for ch in 0..n {
summed[ch] += band_out[b][ch]; summed[ch] += band_out[b][ch];
} }
if metering { if metering {
inp[b] = inp[b].max(band_in[b][0].abs().max(band_in[b][r].abs())); let in_mono = band_in[b][0].abs().max(band_in[b][r].abs());
lvl_l[b] = lvl_l[b].max(band_out[b][0].abs()); let out_l = band_out[b][0].abs();
lvl_r[b] = lvl_r[b].max(band_out[b][r].abs()); let out_r = band_out[b][r].abs();
gr[b] = gr[b] // Wet gain reduction (what the comp computes), independent of the mix.
.max(if band_set[b].bypass { 0.0 } else { self.comps[b].gain_reduction_db() }); let g = self.comps[b].gain_reduction_db();
inp[b] = inp[b].max(in_mono);
lvl_l[b] = lvl_l[b].max(out_l);
lvl_r[b] = lvl_r[b].max(out_r);
gr[b] = gr[b].max(g);
if playing {
self.scope_in[b] = self.scope_in[b].max(in_mono);
self.scope_out[b] = self.scope_out[b].max(out_l.max(out_r));
self.scope_gr[b] = self.scope_gr[b].max(g);
}
} }
} }
@@ -231,18 +276,45 @@ impl Plugin for Codename206 {
summed[ch] *= all_pre; summed[ch] *= all_pre;
} }
all_set.makeup_db = self.params.all.makeup_db.smoothed.next(); all_set.makeup_db = self.params.all.makeup_db.smoothed.next();
all_set.mix = self.params.all.mix.smoothed.next();
all_set.low_slope = self.params.all.low_slope.smoothed.next();
all_set.low_curve = self.params.all.low_curve.smoothed.next();
self.comps[ALL].process(&summed[..n], &mut out_frame[..n], &all_set); self.comps[ALL].process(&summed[..n], &mut out_frame[..n], &all_set);
// Output brickwall limiter. // Output brickwall limiter.
self.limiter.process(&out_frame[..n], &mut lim_frame[..n], ceiling, limiter_release); self.limiter.process(&out_frame[..n], &mut lim_frame[..n], ceiling, limiter_release);
if metering { if metering {
inp[ALL] = inp[ALL].max(summed[0].abs().max(summed[r].abs())); let in_mono = summed[0].abs().max(summed[r].abs());
lvl_l[ALL] = lvl_l[ALL].max(out_frame[0].abs()); let out_l = out_frame[0].abs();
lvl_r[ALL] = lvl_r[ALL].max(out_frame[r].abs()); let out_r = out_frame[r].abs();
gr[ALL] = gr[ALL] let g = self.comps[ALL].gain_reduction_db();
.max(if all_set.bypass { 0.0 } else { self.comps[ALL].gain_reduction_db() }); inp[ALL] = inp[ALL].max(in_mono);
lvl_l[ALL] = lvl_l[ALL].max(out_l);
lvl_r[ALL] = lvl_r[ALL].max(out_r);
gr[ALL] = gr[ALL].max(g);
lim_gr = lim_gr.max(self.limiter.gain_reduction_db()); lim_gr = lim_gr.max(self.limiter.gain_reduction_db());
// Only advance the scope while the transport is playing, so it freezes (rather than
// scrolling silence) when the host is paused/stopped but still calling process().
if playing {
self.scope_in[ALL] = self.scope_in[ALL].max(in_mono);
self.scope_out[ALL] = self.scope_out[ALL].max(out_l.max(out_r));
self.scope_gr[ALL] = self.scope_gr[ALL].max(g);
self.scope_hit = self.scope_hit.max(self.limiter.gain_reduction_db());
// Emit a plot bucket every scope_bucket_len samples (~BUCKET_HZ).
self.scope_samples += 1;
if self.scope_samples >= self.scope_bucket_len {
let hit = if self.scope_hit > CEILING_HIT_GR_DB { 1.0 } else { 0.0 };
self.meters.scope.push(&self.scope_in, &self.scope_out, &self.scope_gr, hit);
self.scope_in = [0.0; meters::NUM_CHANNELS];
self.scope_out = [0.0; meters::NUM_CHANNELS];
self.scope_gr = [0.0; meters::NUM_CHANNELS];
self.scope_hit = 0.0;
self.scope_samples = 0;
}
}
} }
for ch in 0..n { for ch in 0..n {
@@ -258,11 +330,8 @@ impl Plugin for Codename206 {
for i in 0..meters::NUM_CHANNELS { for i in 0..meters::NUM_CHANNELS {
meters::decay_store(&self.meters.level_l[i], lvl_l[i], w); meters::decay_store(&self.meters.level_l[i], lvl_l[i], w);
meters::decay_store(&self.meters.level_r[i], lvl_r[i], w); meters::decay_store(&self.meters.level_r[i], lvl_r[i], w);
meters::decay_store(&self.meters.input_level[i], inp[i], w);
meters::decay_store(&self.meters.gain_reduction_db[i], gr[i], w); meters::decay_store(&self.meters.gain_reduction_db[i], gr[i], w);
// Raw block peaks for the scrolling plot (editor keeps its own history).
meters::store_instant(&self.meters.plot_in[i], inp[i]);
meters::store_instant(&self.meters.plot_out[i], lvl_l[i].max(lvl_r[i]));
meters::store_instant(&self.meters.plot_gr[i], gr[i]);
} }
meters::decay_store(&self.meters.limiter_gr_db, lim_gr, w); meters::decay_store(&self.meters.limiter_gr_db, lim_gr, w);
} }
+121 -32
View File
@@ -1,37 +1,41 @@
//! Lock-free meter state shared from the audio thread to the editor. //! Lock-free meter state shared from the audio thread to the editor.
//! //!
//! `process()` is the single writer (one store per value per block — decimated, not per sample); //! Two feeds, both written by `process()` (single producer) and read by the editor (single
//! the editor is the single reader (once per frame). All access is wait-free via atomics, so the //! consumer), all wait-free:
//! realtime thread never blocks. Values are plain scalars (no streaming history yet) — enough for //!
//! the per-channel level + gain-reduction bars and the ceiling lamp. //! * **Bar meters** — decayed scalars per channel ([`Meters::level_l`] etc.), one store per block.
//! * **Scrolling plot** — a [`ScopeRing`] of raw buckets clocked at [`BUCKET_HZ`] (independent of
//! the GUI frame rate), so the plot's horizontal resolution isn't capped by the ~60 fps repaint.
use nih_plug::prelude::AtomicF32; use nih_plug::prelude::AtomicF32;
use std::sync::atomic::Ordering; use std::sync::atomic::{AtomicU64, Ordering};
/// Metered channels: low, mid, high, then the 'All' aggregate — same order as the compressors. /// Metered channels: low, mid, high, then the 'All' aggregate — same order as the compressors.
pub const NUM_CHANNELS: usize = 4; pub const NUM_CHANNELS: usize = 4;
/// Rate the audio thread emits plot buckets at (Hz). Sets the plot's max horizontal resolution,
/// decoupled from the editor frame rate. ~5 ms per bucket.
pub const BUCKET_HZ: u32 = 200;
/// Buckets buffered between GUI drains. At [`BUCKET_HZ`] this is ~2.5 s of slack — far more than
/// the frame interval needs; if the GUI ever stalls longer, the oldest buckets are dropped.
const RING_N: usize = 512;
pub struct Meters { pub struct Meters {
/// Left output level per channel as a **linear** peak. Peak-with-decay. /// Left output level per channel as a **linear** peak. Peak-with-decay.
pub level_l: [AtomicF32; NUM_CHANNELS], pub level_l: [AtomicF32; NUM_CHANNELS],
/// Right output level per channel (== left for mono signals). Stored separately so the planned /// Right output level per channel (== left for mono signals).
/// `|L|GR|R|` layout is a pure editor change; the current bars render `max(L, R)`.
pub level_r: [AtomicF32; NUM_CHANNELS], pub level_r: [AtomicF32; NUM_CHANNELS],
/// Mono **input** level per channel (post pre-gain = what the compressor detects). Drives the
/// gain-curve operating-point fill. Peak-with-decay.
pub input_level: [AtomicF32; NUM_CHANNELS],
/// Compressor gain reduction per channel in **dB (>= 0)**. Mono by design — detection is /// Compressor gain reduction per channel in **dB (>= 0)**. Mono by design — detection is
/// stereo-linked, so the same gain applies to both channels. /// stereo-linked, so the same gain applies to both channels.
pub gain_reduction_db: [AtomicF32; NUM_CHANNELS], pub gain_reduction_db: [AtomicF32; NUM_CHANNELS],
/// Output limiter gain reduction in **dB (>= 0)** — drives the ceiling lamp. /// Output limiter gain reduction in **dB (>= 0)** — feeds the ALL channel's ceiling lamp.
pub limiter_gr_db: AtomicF32, pub limiter_gr_db: AtomicF32,
/// Bucket stream feeding the scrolling in/out/GR plot.
// --- Scrolling plot feed: instantaneous block peaks, NOT decayed. The editor samples these pub scope: ScopeRing,
// each frame into its own history ring. Per channel: input level (entering the compressor),
// output level, and gain reduction.
/// Mono input level per channel (linear peak, post pre-gain, pre-compressor).
pub plot_in: [AtomicF32; NUM_CHANNELS],
/// Mono output level per channel (linear peak, post-compressor).
pub plot_out: [AtomicF32; NUM_CHANNELS],
/// Gain reduction per channel in dB (>= 0).
pub plot_gr: [AtomicF32; NUM_CHANNELS],
} }
impl Default for Meters { impl Default for Meters {
@@ -39,37 +43,29 @@ impl Default for Meters {
Self { Self {
level_l: std::array::from_fn(|_| AtomicF32::new(0.0)), level_l: std::array::from_fn(|_| AtomicF32::new(0.0)),
level_r: std::array::from_fn(|_| AtomicF32::new(0.0)), level_r: std::array::from_fn(|_| AtomicF32::new(0.0)),
input_level: std::array::from_fn(|_| AtomicF32::new(0.0)),
gain_reduction_db: std::array::from_fn(|_| AtomicF32::new(0.0)), gain_reduction_db: std::array::from_fn(|_| AtomicF32::new(0.0)),
limiter_gr_db: AtomicF32::new(0.0), limiter_gr_db: AtomicF32::new(0.0),
plot_in: std::array::from_fn(|_| AtomicF32::new(0.0)), scope: ScopeRing::default(),
plot_out: std::array::from_fn(|_| AtomicF32::new(0.0)),
plot_gr: std::array::from_fn(|_| AtomicF32::new(0.0)),
} }
} }
} }
impl Meters { impl Meters {
/// Zero every meter. Called from the plugin's `reset()` (transport restart / sample-rate /// Zero the bar meters. Called from the plugin's `reset()` (transport restart / sample-rate
/// change) so the display starts from silence rather than stale values. Real-time safe. /// change) so the bars start from silence. The plot ring is left alone — it's continuous and
/// reflects the new (silent) buckets as they arrive. Real-time safe.
pub fn clear(&self) { pub fn clear(&self) {
for i in 0..NUM_CHANNELS { for i in 0..NUM_CHANNELS {
self.level_l[i].store(0.0, Ordering::Relaxed); self.level_l[i].store(0.0, Ordering::Relaxed);
self.level_r[i].store(0.0, Ordering::Relaxed); self.level_r[i].store(0.0, Ordering::Relaxed);
self.input_level[i].store(0.0, Ordering::Relaxed);
self.gain_reduction_db[i].store(0.0, Ordering::Relaxed); self.gain_reduction_db[i].store(0.0, Ordering::Relaxed);
self.plot_in[i].store(0.0, Ordering::Relaxed);
self.plot_out[i].store(0.0, Ordering::Relaxed);
self.plot_gr[i].store(0.0, Ordering::Relaxed);
} }
self.limiter_gr_db.store(0.0, Ordering::Relaxed); self.limiter_gr_db.store(0.0, Ordering::Relaxed);
} }
} }
/// Store an instantaneous value (no smoothing) — used for the scrolling-plot feed, which the
/// editor smooths/decimates on its own.
pub fn store_instant(meter: &AtomicF32, value: f32) {
meter.store(value, Ordering::Relaxed);
}
/// Update a meter atomic with a new block value using peak-hold-with-decay: jump instantly to a /// Update a meter atomic with a new block value using peak-hold-with-decay: jump instantly to a
/// louder value, ease back down by `decay_weight` (0..1, closer to 1 = slower fall). Keeps meters /// louder value, ease back down by `decay_weight` (0..1, closer to 1 = slower fall). Keeps meters
/// from flickering while staying responsive to transients. /// from flickering while staying responsive to transients.
@@ -82,3 +78,96 @@ pub fn decay_store(meter: &AtomicF32, block_value: f32, decay_weight: f32) {
}; };
meter.store(next, Ordering::Relaxed); meter.store(next, Ordering::Relaxed);
} }
/// Lock-free single-producer/single-consumer ring of plot buckets. Each bucket holds a per-channel
/// (input level, output level, gain reduction) triple. The producer (audio thread) appends with
/// [`push`](ScopeRing::push); the consumer (GUI) reads new buckets with [`drain`](ScopeRing::drain),
/// tracking its own cursor. Per-field atomics avoid tearing; the consumer leaves one slot of margin
/// from the slot being written, so it never races the producer. If the consumer falls more than the
/// ring behind, the oldest buckets are silently dropped (a visual gap at worst).
pub struct ScopeRing {
/// `slot * NUM_CHANNELS + ch`, indexed by `bucket_index % RING_N`.
in_lin: Vec<AtomicF32>,
out_lin: Vec<AtomicF32>,
gr_db: Vec<AtomicF32>,
/// Per-bucket (not per-channel) flag: `1.0` if the output limiter hit the ceiling in this
/// bucket, else `0.0`. Indexed by `bucket_index % RING_N`.
hit: Vec<AtomicF32>,
/// Monotonic count of buckets ever written.
write: AtomicU64,
}
impl Default for ScopeRing {
fn default() -> Self {
let make = || (0..RING_N * NUM_CHANNELS).map(|_| AtomicF32::new(0.0)).collect();
Self {
in_lin: make(),
out_lin: make(),
gr_db: make(),
hit: (0..RING_N).map(|_| AtomicF32::new(0.0)).collect(),
write: AtomicU64::new(0),
}
}
}
impl ScopeRing {
/// Producer (audio thread): append one bucket of per-channel (in_lin, out_lin, gr_db).
pub fn push(
&self,
in_lin: &[f32; NUM_CHANNELS],
out_lin: &[f32; NUM_CHANNELS],
gr_db: &[f32; NUM_CHANNELS],
hit: f32,
) {
let w = self.write.load(Ordering::Relaxed); // producer is the sole writer of `write`
let slot = w as usize % RING_N;
let base = slot * NUM_CHANNELS;
for ch in 0..NUM_CHANNELS {
self.in_lin[base + ch].store(in_lin[ch], Ordering::Relaxed);
self.out_lin[base + ch].store(out_lin[ch], Ordering::Relaxed);
self.gr_db[base + ch].store(gr_db[ch], Ordering::Relaxed);
}
self.hit[slot].store(hit, Ordering::Relaxed);
// Publish the bucket: the Release pairs with the consumer's Acquire so the stores above are
// visible before the new count.
self.write.store(w + 1, Ordering::Release);
}
/// Consumer (GUI): call `on_bucket` for each bucket in `*cursor..write`, advancing `cursor`.
/// Skips ahead (dropping oldest) if the consumer fell more than the ring behind.
pub fn drain(
&self,
cursor: &mut u64,
mut on_bucket: impl FnMut(&[f32; NUM_CHANNELS], &[f32; NUM_CHANNELS], &[f32; NUM_CHANNELS], f32),
) {
let w = self.write.load(Ordering::Acquire);
if *cursor > w {
*cursor = w; // counter went backwards (shouldn't happen) — resync
}
// Stay one slot clear of the slot currently being written.
let oldest = w.saturating_sub((RING_N - 1) as u64);
if *cursor < oldest {
*cursor = oldest;
}
let mut in_buf = [0.0f32; NUM_CHANNELS];
let mut out_buf = [0.0f32; NUM_CHANNELS];
let mut gr_buf = [0.0f32; NUM_CHANNELS];
while *cursor < w {
let slot = *cursor as usize % RING_N;
let base = slot * NUM_CHANNELS;
for ch in 0..NUM_CHANNELS {
in_buf[ch] = self.in_lin[base + ch].load(Ordering::Relaxed);
out_buf[ch] = self.out_lin[base + ch].load(Ordering::Relaxed);
gr_buf[ch] = self.gr_db[base + ch].load(Ordering::Relaxed);
}
let hit = self.hit[slot].load(Ordering::Relaxed);
on_bucket(&in_buf, &out_buf, &gr_buf, hit);
*cursor += 1;
}
}
/// Current write high-water mark (for a fresh consumer to start from "now").
pub fn write_index(&self) -> u64 {
self.write.load(Ordering::Acquire)
}
}
+31 -5
View File
@@ -68,14 +68,22 @@ pub struct CompressorParams {
pub ratio: FloatParam, pub ratio: FloatParam,
#[id = "knee"] #[id = "knee"]
pub knee_db: FloatParam, pub knee_db: FloatParam,
/// Low shaper slope at the silence floor (1 = unity; >1 fans up/boost, <1 fans down/cut).
#[id = "lowslope"]
pub low_slope: FloatParam,
/// Low shaper curvature (1..1): bipolar mid-bulge, 0 = straight. +bulges up (boost quiet
/// middle), bulges down (suppress). Endpoints (silence + knee) stay fixed.
#[id = "lowcurve"]
pub low_curve: FloatParam,
#[id = "attack"] #[id = "attack"]
pub attack_ms: FloatParam, pub attack_ms: FloatParam,
#[id = "release"] #[id = "release"]
pub release_ms: FloatParam, pub release_ms: FloatParam,
#[id = "makeup"] #[id = "makeup"]
pub makeup_db: FloatParam, pub makeup_db: FloatParam,
#[id = "bypass"] /// Dry/wet mix (parallel compression). 100% = fully processed, 0% = dry (a clean bypass).
pub bypass: BoolParam, #[id = "mix"]
pub mix: FloatParam,
} }
impl Default for Codename206Params { impl Default for Codename206Params {
@@ -163,10 +171,23 @@ impl Default for CompressorParams {
s.split(':').next().and_then(|x| x.trim().parse::<f32>().ok()) s.split(':').next().and_then(|x| x.trim().parse::<f32>().ok())
})), })),
knee_db: FloatParam::new("Knee", 6.0, FloatRange::Linear { min: 0.0, max: 24.0 }) knee_db: FloatParam::new("Knee", 6.0, FloatRange::Linear { min: 0.0, max: 30.0 })
.with_unit(" dB") .with_unit(" dB")
.with_value_to_string(formatters::v2s_f32_rounded(1)), .with_value_to_string(formatters::v2s_f32_rounded(1)),
low_slope: FloatParam::new(
"Low Slope",
1.0,
FloatRange::Skewed { min: 0.5, max: 3.0, factor: FloatRange::skew_factor(-1.0) },
)
.with_smoother(SmoothingStyle::Linear(20.0))
.with_value_to_string(formatters::v2s_f32_rounded(2)),
low_curve: FloatParam::new("Low Curve", 0.0, FloatRange::Linear { min: -1.0, max: 1.0 })
.with_smoother(SmoothingStyle::Linear(20.0))
.with_value_to_string(formatters::v2s_f32_percentage(0))
.with_string_to_value(formatters::s2v_f32_percentage()),
attack_ms: FloatParam::new( attack_ms: FloatParam::new(
"Attack", "Attack",
10.0, 10.0,
@@ -188,7 +209,10 @@ impl Default for CompressorParams {
.with_unit(" dB") .with_unit(" dB")
.with_value_to_string(formatters::v2s_f32_rounded(1)), .with_value_to_string(formatters::v2s_f32_rounded(1)),
bypass: BoolParam::new("Bypass", false), mix: FloatParam::new("Mix", 1.0, FloatRange::Linear { min: 0.0, max: 1.0 })
.with_smoother(SmoothingStyle::Linear(20.0))
.with_value_to_string(formatters::v2s_f32_percentage(0))
.with_string_to_value(formatters::s2v_f32_percentage()),
} }
} }
} }
@@ -203,11 +227,13 @@ pub fn build_settings(
threshold_db: p.threshold_db.value(), threshold_db: p.threshold_db.value(),
ratio: p.ratio.value(), ratio: p.ratio.value(),
knee_db: p.knee_db.value(), knee_db: p.knee_db.value(),
low_slope: p.low_slope.value(),
low_curve: p.low_curve.value(),
attack_coef: Compressor::time_to_coef(p.attack_ms.value(), sample_rate), attack_coef: Compressor::time_to_coef(p.attack_ms.value(), sample_rate),
release_coef: Compressor::time_to_coef(p.release_ms.value(), sample_rate), release_coef: Compressor::time_to_coef(p.release_ms.value(), sample_rate),
makeup_db: 0.0, makeup_db: 0.0,
lookahead_samples: lookahead, lookahead_samples: lookahead,
use_rms: p.detection.value() == DetectionMode::Rms, use_rms: p.detection.value() == DetectionMode::Rms,
bypass: p.bypass.value(), mix: p.mix.value(),
} }
} }