Meters: peak hold and clip indication options, click to reset, peak readout

crates/mix/src/meter.rs

@@ -9,6 +9,9 @@ pub struct StripMeter {
     pub peak: [f32; 2],
     /// Every channel of the strip (or of the main mix).
     pub peaks: Vec<f32>,
+    /// The highest of `peaks`: what the clip indicator and peak readout watch, so a surround
+    /// strip clips on any channel, not only on the two its stereo bars show.
+    pub peak_all: f32,
     /// Gain reduction of the first dynamics insert, dB.
     pub gain_reduction_db: f32,
     pub plugin_failures: PluginFailures,
@@ -19,6 +22,7 @@ impl StripMeter {
     pub fn copy_from(&mut self, o: &StripMeter) {
         self.peak = o.peak;
         self.peaks.clone_from(&o.peaks);
+        self.peak_all = o.peak_all;
         self.gain_reduction_db = o.gain_reduction_db;
         self.plugin_failures = o.plugin_failures;
     }
@@ -31,13 +35,15 @@ impl StripMeter {
             // The strip's format changed (a document edit): earlier channels no longer line up.
             self.peaks.clone_from(&o.peaks);
             self.peak = o.peak;
+            self.peak_all = o.peak_all;
         } else {
             for (p, q) in self.peaks.iter_mut().zip(&o.peaks) {
                 *p = max_level(*p, *q);
             }
             for (p, q) in self.peak.iter_mut().zip(o.peak) {
                 *p = max_level(*p, q);
             }
+            self.peak_all = max_level(self.peak_all, o.peak_all);
         }
         self.gain_reduction_db = max_level(self.gain_reduction_db, o.gain_reduction_db);
         self.plugin_failures = o.plugin_failures;
@@ -48,6 +54,7 @@ impl StripMeter {
     pub fn reset_levels(&mut self) {
         self.peak = [0.0; 2];
         self.peaks.iter_mut().for_each(|p| *p = 0.0);
+        self.peak_all = 0.0;
         self.gain_reduction_db = 0.0;
     }
 
@@ -60,6 +67,7 @@ impl StripMeter {
         }
         let last = self.peaks.len().saturating_sub(1);
         self.peak = [self.peaks.first().copied().unwrap_or(0.0), self.peaks.get(1.min(last)).copied().unwrap_or(0.0)];
+        self.peak_all = self.peaks.iter().copied().fold(0.0, f32::max);
         self.gain_reduction_db = gr;
     }
 }

crates/mix/src/tests.rs

@@ -1208,3 +1208,26 @@ fn gain_ramp_matches_converting_both_ends_every_sample() {
         }
     }
 }
+
+#[test]
+fn a_surround_strip_reports_its_loudest_channel_for_the_clip_light() {
+    let mut s = Session::default();
+    s.outputs[0].format = ChannelFormat::Surround51;
+    let t = s.add_track(TrackKind::Audio, ChannelFormat::Surround51, None);
+    // L, R quiet; LFE (channel 3) over full scale.
+    let chans: Vec<Vec<f32>> = (0..6).map(|c| vec![if c == 3 { 1.2 } else { 0.1 }; 4800]).collect();
+    s.pool.insert(SourceId(901), Arc::new(SourceAudio::new(AudioBuffer { sample_rate: 48_000, channels: chans })));
+    let id = s.new_clip_id();
+    s.track_mut(t).unwrap().playlist_mut().unwrap().clips.push(Clip::audio(id, "lfe", SourceId(901), 0, 0, 4800));
+    let mut eng = MixEngine::new(48_000.0, 512);
+    let mut out = vec![vec![0.0; 512]; 6];
+    eng.render(&s, 0, 512, &mut out);
+    let m = &eng.meters[&t];
+    assert!(m.peak[0] < 0.2 && m.peak[1] < 0.2, "{m:?}");
+    assert!((m.peak_all - 1.2).abs() < 1e-3, "{m:?}");
+    assert!((eng.main_meter.peak_all - 1.2).abs() < 1e-3, "the main meter too: {:?}", eng.main_meter);
+    let mut acc = StripMeter::default();
+    acc.accumulate(m);
+    acc.accumulate(&StripMeter { peaks: vec![0.0; m.peaks.len()], ..StripMeter::default() });
+    assert_eq!(acc.peak_all, m.peak_all, "kept until taken");
+}

crates/playback/src/tests.rs

@@ -113,8 +113,11 @@ fn reusable_meter_snapshot_updates_and_drops_stale_tracks() {
     let keep = TrackId(1);
     let stale = TrackId(2);
     let mut source = MeterSnapshot::default();
-    source.tracks.insert(keep, StripMeter { peak: [0.5, 0.25], peaks: vec![0.5, 0.25], gain_reduction_db: 3.0, ..StripMeter::default() });
+    source
+        .tracks
+        .insert(keep, StripMeter { peak: [0.5, 0.25], peaks: vec![0.5, 0.25], peak_all: 0.9, gain_reduction_db: 3.0, ..StripMeter::default() });
     source.main.peaks = vec![0.75, 0.5];
+    source.main.peak_all = 0.75;
     let mut out = MeterSnapshot::default();
     out.tracks.insert(stale, StripMeter::default());
     copy_meter_snapshot(&source, &mut out);
@@ -223,9 +226,10 @@ fn a_take_without_new_blocks_still_drops_deleted_tracks() {
 
 #[test]
 fn a_channel_count_change_takes_the_new_stereo_peaks() {
-    let mut acc = StripMeter { peak: [0.9, 0.9], peaks: vec![0.9], ..StripMeter::default() };
-    acc.accumulate(&StripMeter { peak: [0.9, 0.0], peaks: vec![0.9, 0.0], ..StripMeter::default() });
-    assert_eq!(acc.peak, [0.9, 0.0]);
+    let mut acc = StripMeter { peak: [0.9, 0.9], peaks: vec![0.9], peak_all: 0.9, ..StripMeter::default() };
+    acc.accumulate(&StripMeter { peak: [0.2, 0.0], peaks: vec![0.2, 0.0], peak_all: 0.2, ..StripMeter::default() });
+    assert_eq!(acc.peak, [0.2, 0.0]);
+    assert_eq!(acc.peak_all, 0.2, "a peak from the old layout doesn't stay in the clip light's reading");
 }
 
 #[test]
@@ -235,8 +239,9 @@ fn gain_reduction_keeps_its_maximum_until_taken() {
         acc.accumulate(&StripMeter { peak: [0.1, 0.1], peaks: vec![0.1], gain_reduction_db: gr, ..StripMeter::default() });
     }
     assert_eq!(acc.gain_reduction_db, 9.0);
+    acc.peak_all = 0.7;
     acc.reset_levels();
-    assert_eq!((acc.gain_reduction_db, acc.peak, acc.peaks.len()), (0.0, [0.0; 2], 1));
+    assert_eq!((acc.gain_reduction_db, acc.peak, acc.peak_all, acc.peaks.len()), (0.0, [0.0; 2], 0.0, 1));
 }
 
 #[test]

crates/ui-egui/src/app.rs

@@ -387,7 +387,7 @@ impl SoundApp {
         if self.meters_live() {
             let hz = if self.ui.window == MainWindow::Mix { 60 } else { 30 };
             ctx.request_repaint_after(std::time::Duration::from_millis(1000 / hz));
-        } else if self.meters.values().any(|m| m.level[0] > 0.0001) {
+        } else if self.meters.values().chain([&self.main_meter]).any(|m| crate::meters::settling(m, &self.ui.meters)) {
             ctx.request_repaint_after(std::time::Duration::from_millis(80));
         } else if !self.pending_shots.is_empty() || !self.synthetic.is_empty() {
             ctx.request_repaint();

crates/ui-egui/src/app/audio.rs

@@ -1,4 +1,4 @@
-use super::{MeterDisplay, OutputTrouble, Player, SoundApp, Trouble};
+use super::{OutputTrouble, Player, SoundApp, Trouble};
 
 impl SoundApp {
     /// Whether the meters are live: while playing, and while armed or input-monitored tracks are heard.
@@ -124,30 +124,3 @@ impl SoundApp {
         self.player = Some(Player::with_config(self.engine.session_arc(), &self.ui.audio));
     }
 }
-
-pub(super) fn feed_meter(d: &mut MeterDisplay, peak: [f32; 2], gr: f32, dt: f32) {
-    // Instant attack, ~26 dB/s release, 2 s peak hold.
-    let fall = 10f32.powf(-26.0 * dt / 20.0);
-    for c in 0..2 {
-        let v = peak.get(c).copied().unwrap_or(0.0);
-        let lvl = d.level.get(c).copied().unwrap_or(0.0);
-        let nv = if v >= lvl { v } else { (lvl * fall).max(v) };
-        if let Some(x) = d.level.get_mut(c) {
-            *x = if nv < 1e-5 { 0.0 } else { nv };
-        }
-        if v >= d.hold.get(c).copied().unwrap_or(0.0) {
-            if let Some(h) = d.hold.get_mut(c) {
-                *h = v;
-            }
-            d.hold_age = 0.0;
-        }
-        if v >= 1.0 {
-            d.clip = true;
-        }
-    }
-    d.hold_age += dt;
-    if d.hold_age > 2.0 {
-        d.hold = d.level;
-    }
-    d.gr = if gr > d.gr { gr } else { d.gr * fall };
-}

crates/ui-egui/src/app/commands.rs

@@ -35,6 +35,7 @@ impl SoundApp {
                 }
                 if id == "track.clear_clip_indicators" {
                     self.meters.values_mut().chain([&mut self.main_meter]).for_each(|m| m.clip = false);
+                    crate::meters::forget_readings(&mut self.meter_snapshot);
                 }
                 Ok(v)
             }

crates/ui-egui/src/app/playback.rs

@@ -1,4 +1,3 @@
-use super::audio::feed_meter;
 use super::plugins::failed_plugin_status;
 use super::{Gesture, MainWindow, MeterDisplay, Range, Samples, SoundApp, TrackId, TransportRequest, json};
 
@@ -415,19 +414,24 @@ impl SoundApp {
                 p.take_meters(&mut self.meter_snapshot);
                 self.last_meter_poll = now;
             }
+            // Stopped meters fall below, once per frame: their hold times run on `dt`.
+            let live = self.meters_live();
             let snap = &self.meter_snapshot;
             for (id, m) in &snap.tracks {
                 let d = self.meters.entry(*id).or_default();
-                feed_meter(d, m.peak, m.gain_reduction_db, dt);
+                if live {
+                    crate::meters::feed(d, &crate::meters::Reading::of(m), dt, &self.ui.meters);
+                }
                 if m.plugin_failures.count != d.plugin_failures {
                     d.plugin_failures = m.plugin_failures.count;
                     if let Some(msg) = failed_plugin_status(self.engine.session(), *id, m.plugin_failures.last) {
                         self.ui.status = msg;
                     }
                 }
             }
-            let main = snap.main.peak;
-            feed_meter(&mut self.main_meter, main, 0.0, dt);
+            if live {
+                crate::meters::feed(&mut self.main_meter, &crate::meters::Reading::of(&snap.main), dt, &self.ui.meters);
+            }
             if ended {
                 self.stop_play();
             }
@@ -446,10 +450,11 @@ impl SoundApp {
             }
         }
         if !self.meters_live() {
+            let silence = crate::meters::Reading::default();
             for d in self.meters.values_mut() {
-                feed_meter(d, [0.0, 0.0], 0.0, dt);
+                crate::meters::feed(d, &silence, dt, &self.ui.meters);
             }
-            feed_meter(&mut self.main_meter, [0.0, 0.0], 0.0, dt);
+            crate::meters::feed(&mut self.main_meter, &silence, dt, &self.ui.meters);
         }
     }
 }

crates/ui-egui/src/edit_window/header.rs

@@ -23,7 +23,9 @@ pub(super) fn track_header(app: &mut SoundApp, ui: &mut Ui, track: &Track, head:
     voice_row(app, ui, track, head);
     field_row(app, ui, track, head, head_bg);
     let md = app.meters.get(&id).copied().unwrap_or_default();
-    header_meter(ui, Rect::from_min_max(pos2(head.max.x - 8.0, head.min.y + 1.0), pos2(head.max.x, head.max.y - 1.5)), &md, track.channels() >= 2);
+    let mr = Rect::from_min_max(pos2(head.max.x - 8.0, head.min.y + 1.0), pos2(head.max.x, head.max.y - 1.5));
+    header_meter(ui, mr, &md, track.channels() >= 2);
+    crate::meters::interact(app, ui, mr, crate::meters::MeterTarget::Track(id));
 }
 
 /// Drag the bottom edge of the header to resize the track (snaps to the height presets).
@@ -432,7 +434,7 @@ fn header_meter(ui: &Ui, r: Rect, md: &crate::MeterDisplay, stereo: bool) {
     let body = inner.with_min_y(clip.max.y + 1.0);
     let n = if stereo { 2 } else { 1 };
     let w = (body.width() - (n - 1) as f32) / n as f32;
-    let (amber, red) = (meter_pos(-12.0), meter_pos(-3.0));
+    let (amber, red) = (meter_pos(crate::meters::YELLOW_FROM_DB), meter_pos(crate::meters::RED_FROM_DB));
     for ch in 0..n {
         let bar = Rect::from_min_size(pos2(body.min.x + ch as f32 * (w + 1.0), body.min.y), vec2(w, body.height()));
         let y = |f: f32| bar.max.y - bar.height() * f;
@@ -444,7 +446,7 @@ fn header_meter(ui: &Ui, r: Rect, md: &crate::MeterDisplay, stereo: bool) {
             }
         }
         let hv = level_pos(md.hold[ch]);
-        if hv > 0.01 {
+        if hv > 0.01 && hv > lv + 0.002 {
             p.hline(bar.x_range(), y(hv), Stroke::new(1.0, if hv > red { t.meter_red } else { t.meter_yellow }));
         }
     }

crates/ui-egui/src/lib.rs

@@ -24,6 +24,7 @@ pub mod fonts;
 pub mod icons;
 pub mod import;
 pub mod menus;
+pub mod meters;
 pub mod mix_window;
 pub mod palette;
 pub mod panels;
@@ -142,6 +143,8 @@ pub struct UiState {
     pub window_size: [f32; 2],
     pub window_maximized: bool,
     pub ui_scale: f32,
+    /// Meter peak hold, clip indication and release (`ui.meters`).
+    pub meters: meters::MeterPrefs,
 }
 
 impl Default for UiState {
@@ -203,6 +206,7 @@ impl Default for UiState {
             window_size: [1600.0, 1000.0],
             window_maximized: false,
             ui_scale: 1.0,
+            meters: meters::MeterPrefs::default(),
         }
     }
 }
@@ -226,8 +230,13 @@ pub fn fit_window_to_screen(ctx: &egui::Context) {
 pub struct MeterDisplay {
     pub level: [f32; 2],
     pub hold: [f32; 2],
-    pub hold_age: f32,
+    /// Seconds since each side's hold was last raised.
+    pub hold_age: [f32; 2],
     pub clip: bool,
+    /// Seconds since the signal last clipped (for timed clip indication).
+    pub clip_age: f32,
+    /// The highest sample peak since the meter was last reset (the numeric peak readout).
+    pub max_peak: f32,
     pub gr: f32,
     /// [`soundcraft_mix::PluginFailures::count`] as last seen.
     pub plugin_failures: u32,

crates/ui-egui/src/menus.rs

@@ -75,6 +75,8 @@ pub const UI_COMMANDS: &[(&str, &str, &str, Option<&str>)] = &[
     ("ui.bounce_dialog", "Bounce Mix…", "", None),
     ("ui.set", "Set UI State", "", None),
     ("ui.theme", "Appearance", "", None),
+    ("ui.meters", "Meter Options", "", None),
+    ("ui.meters.reset", "Reset Meter Peaks and Clips", "", None),
 ];
 
 /// Extra catalog mappings handled by the UI layer.
@@ -518,6 +520,11 @@ pub fn run_ui_command(app: &mut SoundApp, id: &str, p: &Value) -> Option<Result<
     if id == "ui.audio_device" {
         return Some(crate::windows::audio_device_command(app, p));
     }
+    match id {
+        "ui.meters" => return Some(crate::meters::prefs_command(app, p)),
+        "ui.meters.reset" => return Some(crate::meters::reset_command(app, p)),
+        _ => {}
+    }
     // Menu clicks never get here: Setup › Playback Engine / Hardware open the window
     // (`MENU_WINDOWS`). A programmatic call applies the open device instead.
     if matches!(id, "setup.playback_engine" | "setup.hardware") {