truce_driver/

lib.rs

//! Headless driver for truce plugins.
//!
//! Instantiate a plugin, feed it scripted audio + events for a fixed
//! duration, capture the output. Used by:
//!
//! - **Tests** via [`truce-test`](../truce_test) - adds assertion
//!   helpers on top of the captured [`DriverResult`].
//! - **The standalone host's offline-render path** -
//!   `cargo truce run --no-playback` parses CLI flags into an
//!   [`InputSource::Buffer`] + [`Script`], runs [`PluginDriver`],
//!   writes the captured audio out as WAV.
//! - **Plugin authors writing custom `main.rs` bins** - batch CI
//!   renders, demo audio generation, preset rendering pipelines.
//!
//! No cpal, no midir, no live-audio plumbing. The driver does:
//!
//! 1. `P::create()` → `init()` → `reset()` → param `set_sample_rate`
//!    + `snap_smoothers`.
//! 2. Apply `state_file` bytes via `plugin.load_state(...)`.
//! 3. Run the `setup` closure (`&mut Plugin`).
//! 4. Loop blocks: pull script events into the block window, run
//!    `plugin.process(...)`, append the output.
//! 5. Capture meters / output events / per-block snapshots
//!    according to [`CaptureSpec`].
//!
//! See [`PluginDriver`] for the builder surface.
//!
//! ```ignore
//! use std::time::Duration;
//! use truce_driver::{InputSource, PluginDriver};
//!
//! let result = PluginDriver::<MyPlugin>::new()
//!     .sample_rate(48_000.0)
//!     .duration(Duration::from_secs(2))
//!     .input(InputSource::Constant(0.5))
//!     .set_param(MyParamId::Gain, 0.7)
//!     .script(|s| {
//!         s.note_on(60, 0.8);
//!         s.wait_ms(500);
//!         s.note_off(60);
//!     })
//!     .run();
//! ```

use std::path::PathBuf;
use std::time::Duration;

use truce_core::buffer::RawBufferScratch;
#[cfg(feature = "wav")]
use truce_core::cast::sample_rate_u32;
use truce_core::cast::{len_u32, sample_count_usize};
use truce_core::events::{Event, EventBody, EventList, TransportInfo};
use truce_core::export::PluginExport;
use truce_core::info::PluginCategory;
use truce_core::plugin::Plugin;
use truce_core::process::ProcessContext;
use truce_params::Params;

// ---------------------------------------------------------------------------
// InputSource
// ---------------------------------------------------------------------------

/// What audio gets fed into the plugin's input bus each block.
///
/// `Silence` is the default. Effects with smoothers / lookahead /
/// modulators usually want one of the non-silent variants to reach
/// steady state during the run.
#[derive(Default)]
pub enum InputSource {
    /// Zero on every channel for the whole run.
    #[default]
    Silence,
    /// Constant DC: every sample is `value` on every channel.
    Constant(f32),
    /// Channel-major buffer (`bufs[ch][frame]`). Length must be
    /// `>= total_frames`; shorter buffers panic at run-time. The
    /// channel count must match the driver's `channels`.
    Buffer(Vec<Vec<f32>>),
    /// `(frame_idx, sample_rate) -> sample`. Same value goes into
    /// every channel. Useful for sweeps / noise / generators.
    Generator(Box<dyn FnMut(usize, f64) -> f32>),
}

// ---------------------------------------------------------------------------
// TransportSpec
// ---------------------------------------------------------------------------

/// Transport state visible to the plugin's `ProcessContext`.
#[derive(Clone)]
pub struct TransportSpec {
    pub bpm: f64,
    pub playing: bool,
    pub position_beats: f64,
    pub time_signature: (u8, u8),
}

impl Default for TransportSpec {
    fn default() -> Self {
        Self {
            bpm: 120.0,
            playing: false,
            position_beats: 0.0,
            time_signature: (4, 4),
        }
    }
}

// ---------------------------------------------------------------------------
// MeterCapture / CaptureSpec
// ---------------------------------------------------------------------------

#[derive(Clone, Copy, Default)]
pub enum MeterCapture {
    None,
    /// One snapshot at end-of-run.
    #[default]
    Final,
    /// One snapshot per process block (post-process).
    PerBlock,
}

#[derive(Clone, Copy)]
pub struct CaptureSpec {
    /// Capture the rendered audio. Default true - turning it off
    /// means `DriverResult::output` is empty (use case: a meter-only
    /// run that doesn't care about audio).
    pub audio: bool,
    pub meters: MeterCapture,
    /// Capture events the plugin emits via `ProcessContext::output_events`.
    pub output_events: bool,
    /// Capture each block's `(param_id, plain_value)` map. Off by
    /// default; tests that need it opt in.
    pub block_snapshots: bool,
}

impl Default for CaptureSpec {
    /// Audio + final meters captured; output events + block snapshots
    /// off. Anything else is rarely the right starting point for a
    /// driver test.
    fn default() -> Self {
        Self {
            audio: true,
            meters: MeterCapture::Final,
            output_events: false,
            block_snapshots: false,
        }
    }
}

// ---------------------------------------------------------------------------
// Script
// ---------------------------------------------------------------------------

/// Sample-accurate sequence of events fed to the plugin during a
/// run. Cursor advances via `wait_ms` / `wait_samples`; events
/// land at the current cursor position.
#[derive(Default, Clone)]
pub struct Script {
    /// `(sample_offset, body)` - sorted by offset on `run`.
    events: Vec<(usize, EventBody)>,
    cursor_samples: usize,
    sample_rate: f64,
}

impl Script {
    pub fn note_on(&mut self, note: u8, velocity: f32) {
        self.push(EventBody::NoteOn {
            group: 0,
            channel: 0,
            note,
            velocity: truce_core::midi::denorm_7bit(velocity),
        });
    }

    pub fn note_off(&mut self, note: u8) {
        self.push(EventBody::NoteOff {
            group: 0,
            channel: 0,
            note,
            velocity: 0,
        });
    }

    pub fn cc(&mut self, cc: u8, value: f32) {
        self.push(EventBody::ControlChange {
            group: 0,
            channel: 0,
            cc,
            value: truce_core::midi::denorm_7bit(value),
        });
    }

    pub fn pitch_bend(&mut self, normalized: f32) {
        self.push(EventBody::PitchBend {
            group: 0,
            channel: 0,
            value: truce_core::midi::denorm_pitch_bend(normalized),
        });
    }

    pub fn channel_pressure(&mut self, value: f32) {
        self.push(EventBody::ChannelPressure {
            group: 0,
            channel: 0,
            pressure: truce_core::midi::denorm_7bit(value),
        });
    }

    /// Set a parameter to a normalized [0.0, 1.0] value, sample-
    /// accurate at the cursor's offset. The plugin sees a
    /// `ParamChange` event in its event list - same delivery path
    /// CLAP / VST3 / AU automation lanes use.
    pub fn set_param(&mut self, id: impl Into<u32>, normalized: f64) {
        self.push(EventBody::ParamChange {
            id: id.into(),
            value: normalized,
        });
    }

    /// Push an arbitrary `EventBody` at the current cursor - escape
    /// hatch for events `Script` doesn't have a typed helper for.
    pub fn raw(&mut self, body: EventBody) {
        self.push(body);
    }

    /// Advance the cursor by `ms` milliseconds at the run's sample
    /// rate. Resolves correctly only after `Script::sample_rate` is
    /// filled in by `PluginDriver::run` - call sites can rely on the
    /// driver wiring it before scanning the script.
    ///
    /// `wait_ms(0)` is *almost always* a copy-paste artifact and
    /// trips a `debug_assert` in dev builds. If you genuinely want
    /// "schedule the next event at the current cursor", that's the
    /// implicit default - drop the call. If you want a typed no-op
    /// for clarity (e.g. mirroring a user-supplied delay variable
    /// that *can* be zero), use `wait_samples(0)` which doesn't
    /// trip the assertion.
    //
    // `ms as f64` for sample-rate math; ms in script wait calls is
    // bounded by test runtime, far below 2^52.
    #[allow(clippy::cast_precision_loss)]
    pub fn wait_ms(&mut self, ms: u64) {
        debug_assert!(
            ms != 0,
            "wait_ms(0) is a no-op - drop the call, or use wait_samples(0) if you mean it"
        );
        let sr = if self.sample_rate > 0.0 {
            self.sample_rate
        } else {
            44_100.0
        };
        let samples_f = (sr * ms as f64) / 1000.0;
        let samples = sample_count_usize(samples_f);
        self.cursor_samples = self.cursor_samples.saturating_add(samples);
    }

    /// Advance the cursor by `n` samples.
    pub fn wait_samples(&mut self, n: usize) {
        self.cursor_samples += n;
    }

    fn push(&mut self, body: EventBody) {
        self.events.push((self.cursor_samples, body));
    }
}

// ---------------------------------------------------------------------------
// DriverResult
// ---------------------------------------------------------------------------

/// Captured audio + metadata + plugin instance from a
/// [`PluginDriver`] run.
///
/// Holds the post-run plugin instance (`plugin: P`) so post-run
/// assertions can read params or custom state directly. As a side
/// effect, `DriverResult: !Send` whenever `P: !Send` - which is
/// true for plugins built via `truce::plugin!` (the generated
/// `Plugin` alias is `unsafe impl Send` only conditionally on its
/// inner `Params` type). Test code rarely cares; document if you
/// hit it.
pub struct DriverResult<P: PluginExport> {
    /// Channel-major output: `output[ch][frame]`. Empty when
    /// `CaptureSpec::audio == false`.
    pub output: Vec<Vec<f32>>,
    pub sample_rate: f64,
    pub block_size: usize,
    pub total_frames: usize,

    /// Final-or-per-block meter readings.
    pub meters: MeterReadings,

    /// Output events emitted by the plugin. Offsets are absolute
    /// (cumulative across blocks). Empty unless
    /// `CaptureSpec::output_events`.
    pub output_events: Vec<Event>,

    /// Per-block param snapshots (one Vec per block), each entry
    /// `(param_id, plain_value)`. Empty unless
    /// `CaptureSpec::block_snapshots`.
    pub block_snapshots: Vec<Vec<(u32, f64)>>,

    /// Post-run plugin instance. Read params or custom state from
    /// here when writing assertions over the final state.
    pub plugin: P,
}

#[derive(Default)]
pub enum MeterReadings {
    #[default]
    None,
    Final(Vec<(u32, f32)>),
    PerBlock(Vec<Vec<(u32, f32)>>),
}

#[cfg(feature = "wav")]
impl<P: PluginExport> DriverResult<P> {
    /// Write the captured audio as a 32-bit float WAV. Available
    /// when the `wav` feature is enabled. Convenience shim around
    /// `hound`; if you need a different sample format, drive `hound`
    /// yourself off `result.output` / `result.sample_rate`.
    ///
    /// # Errors
    ///
    /// Returns `InvalidData` if no audio was captured (the driver
    /// was run with `CaptureSpec::audio == false`), or any I/O /
    /// encoder error from `hound` while creating / writing the file.
    pub fn write_wav(&self, path: impl AsRef<std::path::Path>) -> std::io::Result<()> {
        if self.output.is_empty() {
            return Err(std::io::Error::new(
                std::io::ErrorKind::InvalidData,
                "no audio captured (CaptureSpec::audio was false)",
            ));
        }
        // Channel counts are < u16::MAX in practice (typical: 1-8);
        // sample rate goes through `cast::sample_rate_u32` which
        // debug-asserts the (positive, ≤ u32::MAX) preconditions.
        #[allow(clippy::cast_possible_truncation)]
        let spec = hound::WavSpec {
            channels: self.output.len() as u16,
            sample_rate: sample_rate_u32(self.sample_rate),
            bits_per_sample: 32,
            sample_format: hound::SampleFormat::Float,
        };
        let mut wav = hound::WavWriter::create(path, spec).map_err(io_err)?;
        for frame in 0..self.total_frames {
            for ch in &self.output {
                wav.write_sample(ch[frame]).map_err(io_err)?;
            }
        }
        wav.finalize().map_err(io_err)?;
        Ok(())
    }
}

#[cfg(feature = "wav")]
fn io_err(e: hound::Error) -> std::io::Error {
    std::io::Error::other(e)
}

// ---------------------------------------------------------------------------
// PluginDriver builder
// ---------------------------------------------------------------------------

type SetupFn<P> = Box<dyn FnOnce(&mut P, &SetupContext)>;

/// Context passed to the [`PluginDriver::setup`] closure. Carries the
/// driver state that's been *resolved* by the time setup runs - in
/// particular the auto-detected channel count, which would otherwise
/// be invisible to the closure (the user's `&mut P` doesn't know).
///
/// Test code that needs to size scratch buffers, validate bus layouts,
/// or branch on stereo-vs-mono before the first process block reads
/// these fields directly:
///
/// ```ignore
/// PluginDriver::<MyPlugin>::new()
///     .setup(|plugin, ctx| {
///         assert_eq!(ctx.channels, 2, "stereo run expected");
///         plugin.scratch = vec![0.0; ctx.block_size * ctx.channels];
///     })
///     .run();
/// ```
#[derive(Clone, Copy, Debug)]
pub struct SetupContext {
    /// Channels per audio bus that the driver will run with. Either
    /// the value passed to [`PluginDriver::channels`] or the
    /// auto-resolved default from `P::bus_layouts()[0]`.
    pub channels: usize,
    /// Sample rate the upcoming process loop will use.
    pub sample_rate: f64,
    /// Block size the upcoming process loop will use.
    pub block_size: usize,
}

enum StateSource {
    Blob(Vec<u8>),
    File(PathBuf),
}

pub struct PluginDriver<P: PluginExport> {
    sample_rate: f64,
    channels: Option<usize>,
    block_size: usize,
    duration: Duration,

    transport: TransportSpec,
    input: InputSource,
    script: Script,

    /// Pending state source. Either an in-memory blob (set directly by
    /// callers that already have the bytes) or a path to read at
    /// `run()` time. Reading is deferred so a builder that's
    /// constructed but never `.run()`-ed doesn't touch the disk, and
    /// I/O errors surface alongside the rest of the run rather than
    /// inside an unrelated builder method.
    state_source: Option<StateSource>,
    /// Manifest dir for `state_file` path resolution. Set by callers
    /// that pass a relative path; absolute paths bypass.
    manifest_dir: PathBuf,
    /// `.set_param(id, v)` shortcuts - applied after state load,
    /// before the `setup` closure.
    param_overrides: Vec<(u32, f64)>,
    /// `&mut P` closure run after state load + param overrides.
    setup: Option<SetupFn<P>>,

    capture: CaptureSpec,
}

impl<P: PluginExport> Default for PluginDriver<P> {
    fn default() -> Self {
        Self::new()
    }
}

impl<P: PluginExport> PluginDriver<P> {
    #[must_use]
    pub fn new() -> Self {
        Self {
            sample_rate: 44_100.0,
            channels: None,
            block_size: 512,
            duration: Duration::from_secs(1),
            transport: TransportSpec::default(),
            input: InputSource::Silence,
            script: Script::default(),
            state_source: None,
            manifest_dir: std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")),
            param_overrides: Vec::new(),
            setup: None,
            capture: CaptureSpec::default(),
        }
    }

    #[must_use]
    pub fn sample_rate(mut self, sr: f64) -> Self {
        self.sample_rate = sr;
        self
    }
    #[must_use]
    pub fn channels(mut self, n: usize) -> Self {
        self.channels = Some(n);
        self
    }
    #[must_use]
    pub fn block_size(mut self, n: usize) -> Self {
        self.block_size = n;
        self
    }
    #[must_use]
    pub fn duration(mut self, d: Duration) -> Self {
        self.duration = d;
        self
    }

    #[must_use]
    pub fn transport(mut self, t: TransportSpec) -> Self {
        self.transport = t;
        self
    }
    #[must_use]
    pub fn bpm(mut self, bpm: f64) -> Self {
        self.transport.bpm = bpm;
        self
    }
    #[must_use]
    pub fn playing(mut self, playing: bool) -> Self {
        self.transport.playing = playing;
        self
    }

    #[must_use]
    pub fn input(mut self, source: InputSource) -> Self {
        self.input = source;
        self
    }

    /// Build a script via a closure. Each `set_param` / `note_on`
    /// / etc. lands at the cursor's current sample offset; `wait_ms`
    /// advances the cursor.
    //
    // `usize as f64` for the sample-offset rescale. Test runs hold
    // counts well below 2^52.
    #[allow(clippy::cast_precision_loss)]
    #[must_use]
    pub fn script(mut self, f: impl FnOnce(&mut Script)) -> Self {
        // If a previous `.script` call already populated events at a
        // different SR (because `.sample_rate(...)` was called in
        // between two `.script` calls), rescale both the cursor and
        // the existing event offsets to the current SR before
        // appending. The previous shape just overwrote
        // `script.sample_rate` and treated the pre-existing offsets
        // as the new SR's, silently shifting "100 ms at 44.1 kHz"
        // (4410 samples) to "91.875 ms at 48 kHz" once the new SR
        // was painted onto the stale cursor.
        //
        // The single-`.script` case (the common one) is handled by
        // the run-time rescale at `run()` - both safety nets are
        // needed so any builder ordering produces correct offsets.
        let old_sr = self.script.sample_rate;
        let new_sr = self.sample_rate;
        if old_sr > 0.0 && (old_sr - new_sr).abs() > f64::EPSILON {
            let scale = new_sr / old_sr;
            self.script.cursor_samples =
                sample_count_usize(((self.script.cursor_samples as f64) * scale).round());
            for (off, _) in &mut self.script.events {
                *off = sample_count_usize(((*off as f64) * scale).round());
            }
        }
        self.script.sample_rate = new_sr;
        f(&mut self.script);
        self
    }

    /// Set a parameter to a normalized [0, 1] value before the run
    /// starts. Equivalent to a `setup(|p| p.params().set_normalized(id, v))`
    /// closure but written as one builder call. Multiple `.set_param`
    /// calls compose; they run in declaration order, before the
    /// `.setup` closure (if any).
    ///
    /// For automation *during* a run, use `.script(|s| s.set_param(...))`,
    /// which emits a sample-accurate `ParamChange` event the plugin
    /// processes inline.
    #[must_use]
    pub fn set_param(mut self, id: impl Into<u32>, normalized: f64) -> Self {
        self.param_overrides.push((id.into(), normalized));
        self
    }

    /// Anchor for `state_file` relative paths. Defaults to the
    /// process CWD; callers from `truce-test` override it with the
    /// test crate's `CARGO_MANIFEST_DIR` via the `screenshot!`-style
    /// macro pattern (see `truce-test`'s wrapping macro).
    #[must_use]
    pub fn manifest_dir(mut self, dir: impl Into<PathBuf>) -> Self {
        self.manifest_dir = dir.into();
        self
    }

    /// Mutate the plugin between init/reset+state-load and the
    /// first process block. Use when the test needs more than
    /// param tweaks - load arbitrary fields, drive a warmup
    /// `process()` call to populate meters / lookahead, etc.
    ///
    /// Composes with `state_file` (state loads first) and
    /// `set_param` (shortcuts apply first); the closure runs last.
    ///
    /// The closure receives a [`SetupContext`] with the resolved
    /// channel count, sample rate, and block size - exactly what the
    /// upcoming process loop will use. Channel resolution happens
    /// before setup runs, so a closure that allocates per-channel
    /// scratch can size correctly without re-querying `P::bus_layouts`.
    #[must_use]
    pub fn setup<F: FnOnce(&mut P, &SetupContext) + 'static>(mut self, f: F) -> Self {
        self.setup = Some(Box::new(f));
        self
    }

    /// Apply an in-memory `.pluginstate` blob via
    /// `plugin.load_state(&bytes)` at the same lifecycle point as
    /// [`Self::state_file`] (after init/reset, before `set_param`
    /// shortcuts and `setup`). Use when the test already has the
    /// bytes in hand and doesn't want a temp file round-trip.
    #[must_use]
    pub fn state_blob(mut self, bytes: Vec<u8>) -> Self {
        self.state_source = Some(StateSource::Blob(bytes));
        self
    }

    /// Read a `.pluginstate` file (the standalone host's `Cmd+S`
    /// save format) and apply it via `plugin.load_state(&bytes)`
    /// after init/reset and before any `set_param` overrides /
    /// `setup` closure. Path is resolved relative to
    /// `manifest_dir`, or used as-is if absolute.
    ///
    /// I/O is deferred to `.run()`. The builder records the path; a
    /// missing or unreadable file panics at run time with the resolved
    /// path in the message, alongside other run-time failures, rather
    /// than from inside this method.
    #[must_use]
    pub fn state_file(mut self, path: impl Into<PathBuf>) -> Self {
        let raw = path.into();
        let resolved = if raw.is_absolute() {
            raw
        } else {
            self.manifest_dir.join(&raw)
        };
        self.state_source = Some(StateSource::File(resolved));
        self
    }

    #[must_use]
    pub fn capture_audio(mut self, on: bool) -> Self {
        self.capture.audio = on;
        self
    }
    #[must_use]
    pub fn capture_meters(mut self, m: MeterCapture) -> Self {
        self.capture.meters = m;
        self
    }
    #[must_use]
    pub fn capture_output_events(mut self, on: bool) -> Self {
        self.capture.output_events = on;
        self
    }
    #[must_use]
    pub fn capture_block_snapshots(mut self, on: bool) -> Self {
        self.capture.block_snapshots = on;
        self
    }

    /// Drive the plugin and return the captured result.
    ///
    /// # Panics
    ///
    /// Panics if a `state_file(...)` path cannot be read. Plugin
    /// `init` / `reset` / `process` / `restore_values` panics propagate
    /// unchanged so the underlying failure surfaces with its original
    /// stack rather than being wrapped.
    //
    // The driver loop widens `usize`-counted sample offsets and
    // `i64` transport positions to `f64`. Driver test runs are
    // bounded well below 2^52 frames.
    //
    // Sequential block-driving pipeline: setup → per-block loop →
    // result assembly. Extracting `prepare_script_events` and
    // `fill_input_block` already split out the largest reusable seams;
    // further extraction would force a 20+ field context struct that
    // hides exactly the linear control flow that makes this readable.
    #[allow(clippy::cast_precision_loss, clippy::too_many_lines)]
    #[must_use]
    pub fn run(mut self) -> DriverResult<P> {
        // Build + activate.
        let mut plugin = P::create();
        plugin.init();
        plugin.reset(self.sample_rate, self.block_size);
        plugin.params().set_sample_rate(self.sample_rate);
        plugin.params().snap_smoothers();

        // 1. State load (if any). Reads from disk here rather than at
        // builder time, so the I/O failure (if any) surfaces as a
        // run-time panic at the same lifecycle stage as smoother /
        // process panics.
        let state_bytes =
            match self.state_source.take() {
                Some(StateSource::Blob(b)) => Some(b),
                Some(StateSource::File(path)) => Some(std::fs::read(&path).unwrap_or_else(|e| {
                    panic!("state_file: failed to read {}: {e}", path.display())
                })),
                None => None,
            };
        if let Some(bytes) = state_bytes.as_deref()
            && let Err(e) = plugin.load_state(bytes)
        {
            eprintln!("truce-driver: load_state failed: {e}");
        }

        // 2. Param overrides (the `.set_param(...)` shortcuts).
        for (id, value) in &self.param_overrides {
            plugin.params().set_normalized(*id, *value);
        }
        plugin.params().snap_smoothers();

        // Resolve channel count *before* the setup closure runs so the
        // closure's `SetupContext` can expose it. The previous order
        // (setup first, channels after) meant a setup closure that
        // wanted to size scratch buffers had to re-query `P::bus_layouts`
        // by hand, which silently disagreed with the driver's auto-pick
        // when callers later passed `.channels(...)`.
        let channels = self.channels.unwrap_or_else(|| {
            let layouts = P::bus_layouts();
            let layout = &layouts[0];
            let outs = layout.total_output_channels() as usize;
            if outs > 0 { outs } else { 2 }
        });

        // 3. Setup closure (most general). Receives the resolved
        // `SetupContext` so it can size per-channel state, branch on
        // mono/stereo, etc.
        if let Some(f) = self.setup.take() {
            let ctx = SetupContext {
                channels,
                sample_rate: self.sample_rate,
                block_size: self.block_size,
            };
            f(&mut plugin, &ctx);
        }

        let is_effect = P::info().category == PluginCategory::Effect;
        let total_frames = sample_count_usize(self.duration.as_secs_f64() * self.sample_rate);

        // Capture buffers.
        let mut output: Vec<Vec<f32>> = if self.capture.audio {
            (0..channels)
                .map(|_| Vec::with_capacity(total_frames))
                .collect()
        } else {
            Vec::new()
        };
        let mut output_events_capture: Vec<Event> = Vec::new();
        let mut per_block_meters: Vec<Vec<(u32, f32)>> = Vec::new();
        let mut block_snapshots: Vec<Vec<(u32, f64)>> = Vec::new();

        // Pre-resolve input source into per-block chunks. For
        // Buffer / Generator we lazy-fill per block; for Constant
        // we just produce a single fill-value to broadcast.
        let constant_value: Option<f32> = match &self.input {
            InputSource::Constant(v) => Some(*v),
            InputSource::Silence => Some(0.0),
            _ => None,
        };

        let script_events = prepare_script_events(&mut self.script, self.sample_rate, total_frames);

        // Transport tracker.
        let mut transport_pos_beats = self.transport.position_beats;
        let beats_per_second = self.transport.bpm / 60.0;

        let meter_ids: Vec<u32> = plugin.params().meter_ids();

        // Validate `InputSource::Buffer` shape up front so a mismatched
        // channel count panics before the run starts (rather than
        // mid-loop after capture buffers have been partially built).
        if let InputSource::Buffer(bufs) = &self.input {
            assert_eq!(
                bufs.len(),
                channels,
                "InputSource::Buffer channel count {} doesn't match driver channels {channels}",
                bufs.len(),
            );
        }

        // Pre-allocate per-block scratch outside the loop. Reusing the
        // buffers keeps the hot loop allocation-free for `Silence` /
        // `Constant` / `Buffer` and reduces per-block work for
        // `Generator`.
        let mut out_bufs: Vec<Vec<f32>> = (0..channels)
            .map(|_| vec![0.0f32; self.block_size])
            .collect();
        let mut in_bufs: Vec<Vec<f32>> = if is_effect {
            (0..channels)
                .map(|_| vec![0.0f32; self.block_size])
                .collect()
        } else {
            Vec::new()
        };

        let mut cursor = 0usize;
        let mut event_list = EventList::with_capacity(script_events.len().min(256));
        // Hoisted out of the loop and reused - `EventList::default()`
        // does the `EVENT_LIST_PREALLOC` reservation, so re-constructing
        // it per block re-allocates on the first push.
        let mut output_events_block = EventList::default();

        // Routes the offline-render loop through the same
        // `RawBufferScratch::build` helper every format wrapper uses,
        // so `Plugin::Sample = f64` plugins (prelude64) get widening
        // scratch transparently. For `Sample = f32` it's still
        // zero-copy through the host f32 slices.
        let mut scratch: RawBufferScratch<<P as Plugin>::Sample> = RawBufferScratch::default();
        scratch.ensure_capacity(in_bufs.len(), out_bufs.len(), self.block_size);
        let mut in_ptrs: Vec<*const f32> = Vec::with_capacity(in_bufs.len());
        let mut out_ptrs: Vec<*mut f32> = Vec::with_capacity(out_bufs.len());
        while cursor < total_frames {
            let block_len = self.block_size.min(total_frames - cursor);

            // Resize scratch to `block_len` (cheap: identical size on
            // every iteration except the final tail block).
            for b in &mut out_bufs {
                b.clear();
                b.resize(block_len, 0.0);
            }

            // Pull events that fall inside [cursor, cursor+block_len).
            // Reuses the same `EventList` across the offline-render
            // loop instead of constructing a fresh one each block.
            event_list.clear();
            for (off, body) in &script_events {
                if *off >= cursor && *off < cursor + block_len {
                    event_list.push(Event {
                        sample_offset: len_u32(*off - cursor),
                        body: *body,
                    });
                }
            }

            if is_effect {
                fill_input_block(
                    &mut in_bufs,
                    &mut self.input,
                    constant_value,
                    cursor,
                    block_len,
                    self.sample_rate,
                );
            }

            // Mirror `in_bufs` / `out_bufs` into raw pointer arrays for
            // `RawBufferScratch::build`. Cheap (a handful of pointers
            // per block) and keeps the conversion-aware path single-sourced.
            in_ptrs.clear();
            out_ptrs.clear();
            for b in &in_bufs {
                in_ptrs.push(b.as_ptr());
            }
            for b in &mut out_bufs {
                out_ptrs.push(b.as_mut_ptr());
            }
            let block_u32 = len_u32(block_len);
            let num_in_u32 = len_u32(in_ptrs.len());
            let num_out_u32 = len_u32(out_ptrs.len());
            // SAFETY: pointers borrowed from `in_bufs` / `out_bufs`
            // which outlive `audio`; each `Vec<f32>` was resized to
            // `block_len` above.
            let mut audio = unsafe {
                scratch.build(
                    in_ptrs.as_ptr(),
                    out_ptrs.as_mut_ptr(),
                    num_in_u32,
                    num_out_u32,
                    block_u32,
                    P::supports_in_place(),
                )
            };

            // Transport snapshot for this block.
            let transport_info = TransportInfo {
                playing: self.transport.playing,
                tempo: self.transport.bpm,
                time_sig_num: self.transport.time_signature.0,
                time_sig_den: self.transport.time_signature.1,
                position_seconds: cursor as f64 / self.sample_rate,
                position_beats: transport_pos_beats,
                bar_start_beats: 0.0,
                ..Default::default()
            };
            output_events_block.clear();
            let mut ctx = ProcessContext::new(
                &transport_info,
                self.sample_rate,
                block_len,
                &mut output_events_block,
            );

            plugin.process(&mut audio, &event_list, &mut ctx);
            let _ = audio;
            // Narrow rendered f64 output back into the f32 `out_bufs`
            // when the plugin's `Sample = f64`. No-op otherwise.
            // SAFETY: same pointers + counts as the `build` call above.
            unsafe {
                scratch.finish_widening_f32(out_ptrs.as_mut_ptr(), num_out_u32, block_u32);
            }

            // Capture audio. `out_bufs` is reused across iterations,
            // so we copy out rather than consuming.
            if self.capture.audio {
                for (ch, buf) in out_bufs.iter().enumerate() {
                    output[ch].extend_from_slice(buf);
                }
            }

            // Capture output events with absolute offsets. Use
            // `saturating_add` so a long run (~24h at 48 kHz puts
            // `cursor` past `u32::MAX`) clamps the offset rather than
            // wrapping. The captured offsets are still informative
            // up to that point and clamped beyond rather than
            // silently mis-attributed to early frames.
            if self.capture.output_events {
                let cursor_u32 = u32::try_from(cursor).unwrap_or(u32::MAX);
                for ev in output_events_block.iter() {
                    let mut e = *ev;
                    e.sample_offset = e.sample_offset.saturating_add(cursor_u32);
                    output_events_capture.push(e);
                }
            }

            // Capture per-block meters / param snapshots.
            if matches!(self.capture.meters, MeterCapture::PerBlock) {
                per_block_meters.push(
                    meter_ids
                        .iter()
                        .map(|id| (*id, plugin.get_meter(*id)))
                        .collect(),
                );
            }
            if self.capture.block_snapshots {
                let infos = plugin.params().param_infos();
                block_snapshots.push(
                    infos
                        .iter()
                        .map(|pi| (pi.id, plugin.params().get_plain(pi.id).unwrap_or(0.0)))
                        .collect(),
                );
            }

            // Advance transport.
            if self.transport.playing {
                let block_seconds = block_len as f64 / self.sample_rate;
                transport_pos_beats += block_seconds * beats_per_second;
            }

            cursor += block_len;
        }

        let meters = match self.capture.meters {
            MeterCapture::None => MeterReadings::None,
            MeterCapture::Final => MeterReadings::Final(
                meter_ids
                    .iter()
                    .map(|id| (*id, plugin.get_meter(*id)))
                    .collect(),
            ),
            MeterCapture::PerBlock => MeterReadings::PerBlock(per_block_meters),
        };

        DriverResult {
            output,
            sample_rate: self.sample_rate,
            block_size: self.block_size,
            total_frames,
            meters,
            output_events: output_events_capture,
            block_snapshots,
            plugin,
        }
    }
}

/// Sort the script's events by sample offset, rescale them if the
/// driver's sample rate differs from the script's build-time rate, and
/// warn loudly about events scheduled past `total_frames`.
///
/// A builder order like `.script(...).sample_rate(48000).run()` would
/// otherwise emit events at offsets computed against the old SR -
/// `wait_ms(100)` produced `4410` at 44100 Hz but the run uses 48000,
/// putting "100ms" at 91.875ms instead.
// usize → f64 widening on sample offsets - driver test runs are
// bounded well below 2^52 frames.
#[allow(clippy::cast_precision_loss)]
fn prepare_script_events(
    script: &mut Script,
    sample_rate: f64,
    total_frames: usize,
) -> Vec<(usize, EventBody)> {
    let build_sr = script.sample_rate;
    if build_sr > 0.0 && (build_sr - sample_rate).abs() > f64::EPSILON {
        let scale = sample_rate / build_sr;
        for (off, _) in &mut script.events {
            *off = sample_count_usize(((*off as f64) * scale).round());
        }
    }
    script.sample_rate = sample_rate;
    script.events.sort_by_key(|(off, _)| *off);

    let dropped = script
        .events
        .iter()
        .filter(|(off, _)| *off >= total_frames)
        .count();
    if dropped > 0 {
        eprintln!(
            "[truce-driver] warning: {dropped} script event(s) scheduled past \
             total_frames ({total_frames}) - they will not be delivered. Check \
             `.duration(...)` vs `wait_ms`/`wait_samples` calls in your script."
        );
    }
    std::mem::take(&mut script.events)
}

/// Refill effect-input scratch for one block. Constant / Silence
/// collapse to a per-channel memset; Buffer slice-copies; Generator
/// computes into the first channel then broadcasts to the rest, which
/// saves `(N-1) × block_len` closure calls per block.
fn fill_input_block(
    in_bufs: &mut [Vec<f32>],
    input: &mut InputSource,
    constant_value: Option<f32>,
    cursor: usize,
    block_len: usize,
    sample_rate: f64,
) {
    for b in in_bufs.iter_mut() {
        b.resize(block_len, 0.0);
    }
    if let Some(v) = constant_value {
        for b in in_bufs {
            b.fill(v);
        }
        return;
    }
    match input {
        InputSource::Buffer(bufs) => {
            for (dst, src) in in_bufs.iter_mut().zip(bufs.iter()) {
                let start = cursor.min(src.len());
                let end = (cursor + block_len).min(src.len());
                let copied = end - start;
                dst[..copied].copy_from_slice(&src[start..end]);
                // Pad the tail past `src` with zeros if the
                // user-supplied buffer ran short.
                for s in &mut dst[copied..] {
                    *s = 0.0;
                }
            }
        }
        InputSource::Generator(g) => {
            if let Some((first, rest)) = in_bufs.split_first_mut() {
                for (i, slot) in first.iter_mut().enumerate() {
                    *slot = g(cursor + i, sample_rate);
                }
                for ch in rest {
                    ch.copy_from_slice(first);
                }
            }
        }
        // Silence / Constant always come paired with a `Some` in
        // `constant_value`, handled by the early-return above.
        InputSource::Silence | InputSource::Constant(_) => {
            for b in in_bufs {
                b.fill(0.0);
            }
        }
    }
}