aura_params/

types.rs

use std::sync::atomic::{AtomicBool, AtomicI64, AtomicU32, AtomicU64, Ordering};

use crate::info::ParamInfo;
use crate::sample::Float;
use crate::smooth::{Smoother, SmoothingStyle};

/// Atomic f64 - wraps `AtomicU64` with f64 load/store.
pub struct AtomicF64 {
    bits: AtomicU64,
}

impl AtomicF64 {
    pub fn new(value: f64) -> Self {
        Self {
            bits: AtomicU64::new(value.to_bits()),
        }
    }

    #[inline]
    pub fn load(&self) -> f64 {
        f64::from_bits(self.bits.load(Ordering::Relaxed))
    }

    #[inline]
    pub fn store(&self, value: f64) {
        self.bits.store(value.to_bits(), Ordering::Relaxed);
    }
}

/// A continuous floating-point parameter.
pub struct FloatParam {
    pub info: ParamInfo,
    /// Base value (host automation / UI / state). Not including mod.
    value: AtomicF64,
    /// Mono modulation offset from the host (CLAP `PARAM_MOD`). DSP
    /// smoothers track [`Self::effective_target`]; host `get` stays on base.
    mod_amount: AtomicF64,
    pub smoother: Smoother,
}

impl FloatParam {
    #[must_use]
    pub fn new(info: ParamInfo, smoothing: SmoothingStyle) -> Self {
        let default = info.default_plain;
        // Surface a mis-ordered or non-finite range (a `Linear { min: 6,
        // max: -60 }` typo) at construction, where it's obvious, rather than
        // as a `clamp` panic on the first host automation write. The derive
        // already rejects `min >= max` at compile time; this covers direct
        // `FloatParam::new` callers. `set_value` normalizes the bounds so it
        // never panics even in release, where this assert is compiled out.
        let (lo, hi) = (info.range.min(), info.range.max());
        debug_assert!(
            lo.is_finite() && hi.is_finite() && lo <= hi,
            "FloatParam range bounds must be finite and ordered (min <= max); \
             got [{lo}, {hi}] - check the `range = \"...\"` attribute"
        );
        // Contain the default as `set_value` contains writes. A NaN or
        // out-of-range default (a hand-rolled `FloatParam::new` caller -
        // the derive rejects both at compile time) would otherwise ship
        // DSP at a value the host can't display and mutate it on the first
        // save/restore round-trip. debug_assert catches it in dev; release
        // clamps for containment.
        debug_assert!(
            default.is_finite() && default >= lo.min(hi) && default <= lo.max(hi),
            "FloatParam default {default} is outside range [{lo}, {hi}] or non-finite"
        );
        let default = if default.is_finite() {
            default.clamp(lo.min(hi), lo.max(hi))
        } else {
            lo.min(hi)
        };
        let smoother = Smoother::new(smoothing);
        smoother.snap(default);
        Self {
            info,
            value: AtomicF64::new(default),
            mod_amount: AtomicF64::new(0.0),
            smoother,
        }
    }

    /// Set the plain **base** value (host automation and state restore).
    /// Does not clear modulation — mod is independent.
    ///
    /// Drop non-finite writes and clamp to the declared range, so a
    /// corrupt or hostile value can't latch a NaN into the smoother.
    #[inline]
    pub fn set_value(&self, v: f64) {
        if !v.is_finite() {
            return;
        }
        // Normalize the bounds before clamping: `f64::clamp` panics if
        // `min > max`, and `range.min()`/`max()` return the stored fields,
        // so a mis-ordered range would otherwise panic on every write (on
        // whatever thread the host calls the setter from). `new` debug-
        // asserts the ordering; this keeps release safe regardless.
        let (lo, hi) = (self.info.range.min(), self.info.range.max());
        self.value.store(v.clamp(lo.min(hi), lo.max(hi)));
    }

    /// Set mono modulation offset (CLAP `PARAM_MOD` amount). Non-finite → 0.
    #[inline]
    pub fn set_mod_amount(&self, amount: f64) {
        let a = if amount.is_finite() { amount } else { 0.0 };
        self.mod_amount.store(a);
    }

    /// Current mono modulation offset.
    #[inline]
    #[must_use]
    pub fn mod_amount(&self) -> f64 {
        self.mod_amount.load()
    }

    /// DSP target: `clamp(base + mod)` into the param range.
    #[inline]
    #[must_use]
    pub fn effective_target(&self) -> f64 {
        let (a, b) = (self.info.range.min(), self.info.range.max());
        let (lo, hi) = (a.min(b), a.max(b));
        (self.value.load() + self.mod_amount.load()).clamp(lo, hi)
    }

    /// Internal: raw **base** target at `f64` (host UI / state). DSP
    /// paths use [`Self::effective_target`] via the smoother helpers.
    #[doc(hidden)]
    #[inline]
    pub fn raw_target(&self) -> f64 {
        self.value.load()
    }

    /// Internal: next smoother step at `f32` toward effective target.
    #[doc(hidden)]
    #[inline]
    pub fn raw_smoothed_next(&self) -> f32 {
        self.smoother.next(self.effective_target())
    }

    /// Internal: current smoother value at `f32`.
    #[doc(hidden)]
    #[inline]
    pub fn raw_smoothed_current(&self) -> f32 {
        self.smoother.current()
    }

    /// Internal: advance the smoother by `out.len()` samples.
    #[doc(hidden)]
    #[inline]
    pub fn raw_smoothed_next_into(&self, out: &mut [f32]) {
        self.smoother.next_into(self.effective_target(), out);
    }

    /// Internal: advance the smoother by `n_samples` and return final value.
    #[doc(hidden)]
    #[inline]
    pub fn raw_smoothed_next_after(&self, n_samples: usize) -> f32 {
        self.smoother.next_after(self.effective_target(), n_samples)
    }

    /// Read the value rounded to the nearest non-negative `usize`.
    /// Use this for discrete-range params consumed as array indices.
    /// Negatives, NaN, and infinities saturate at `0` / `usize::MAX`.
    #[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
    #[inline]
    pub fn value_usize(&self) -> usize {
        let v = self.value.load().round();
        if v <= 0.0 { 0 } else { v as usize }
    }

    /// Read the value rounded to the nearest `i32`. Out-of-range
    /// values saturate at `i32::MIN` / `i32::MAX`; NaN → 0.
    #[allow(clippy::cast_possible_truncation)]
    #[inline]
    pub fn value_i32(&self) -> i32 {
        self.value.load().round() as i32
    }

    /// Read the value rounded to the nearest `u8`. Negatives clamp to
    /// `0`; values above `255` saturate at `u8::MAX`; NaN → 0.
    #[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
    #[inline]
    pub fn value_u8(&self) -> u8 {
        let v = self.value.load().round();
        if v <= 0.0 {
            0
        } else if v >= 255.0 {
            255
        } else {
            v as u8
        }
    }

    /// True when the smoother is mid-step toward a new target.
    /// Inverse of [`Smoother::is_converged`].
    ///
    /// Use to branch in `process()` between a constant-gain fast
    /// path (smoothers at target, gain identical across the whole
    /// block, one `gain_block` per channel) and the envelope slow
    /// path (`read_into` + per-sample envelope + `chunks_mut`).
    /// `SmoothingStyle::None` always reports `false` here, so the
    /// fast path is unconditional for plugins that disable
    /// smoothing.
    ///
    /// ```ignore
    /// if !self.params.gain.is_smoothing() && !self.params.pan.is_smoothing() {
    ///     // fast path: gain is constant for the whole block.
    /// } else {
    ///     // slow path: envelope precompute + chunked apply.
    /// }
    /// ```
    #[inline]
    #[must_use]
    pub fn is_smoothing(&self) -> bool {
        !self.smoother.is_converged(self.effective_target())
    }

    /// Parameter ID.
    pub fn id(&self) -> u32 {
        self.info.id
    }
}

/// Precision-routed read accessors for [`FloatParam`] at `f32`.
///
/// The plugin prelude (`aura::prelude` / `aura::prelude32`) imports
/// this trait via `pub use … as _;`, so plugin code reads:
///
/// ```ignore
/// use aura::prelude::*;
/// let gain = self.params.gain.read();   // f32 - no annotation needed
/// ```
///
/// The trait's methods shadow nothing - `FloatParam` has no inherent
/// `read` / `value` / `current`, so name resolution picks the one
/// (and only one) trait that's in scope. Importing `prelude64`
/// instead brings [`FloatParamReadF64`] into scope and the same
/// source resolves to `f64`. Importing **both** preludes is a
/// compile error (`multiple applicable items in scope`) - which is
/// the right error for a file that hasn't committed to a precision.
pub trait FloatParamReadF32 {
    /// Next smoothed value. Call once per sample in `process()`.
    #[must_use]
    fn read(&self) -> f32;

    /// Fill `out` with the next `out.len()` smoothed samples; advance
    /// the smoother by `out.len()` (not by the slice's capacity).
    /// One atomic load + one atomic store amortized over the whole
    /// slice. The right primitive when chunking `process()`'s block
    /// dynamically:
    ///
    /// ```ignore
    /// let mut delay = [0.0_f32; MAX_BLOCK];
    /// while offset < total {
    ///     let n = (total - offset).min(MAX_BLOCK);
    ///     self.params.delay.read_into(&mut delay[..n]);
    ///     // ... consume delay[..n] for n samples ...
    ///     offset += n;
    /// }
    /// ```
    fn read_into(&self, out: &mut [f32]);

    /// Advance the smoother by `n_samples` in one call, returning
    /// only the final value. Use for **block-rate** DSP - hard
    /// gates, mode switches, anything that needs one smoothed value
    /// per audio block. Pass `buffer.num_samples()` to keep the
    /// smoother's wall-clock convergence time matching the smoother
    /// declaration (`smooth = "exp(20)"` then actually settles in
    /// ~20 ms instead of ~20 blocks). One atomic load + one atomic
    /// store; the per-sample envelope is skipped.
    #[must_use]
    fn read_after(&self, n_samples: usize) -> f32;

    /// Current smoothed value without advancing.
    #[must_use]
    fn current(&self) -> f32;

    /// Raw target value (post-`set_normalized` / host automation),
    /// not the smoothed output. Use [`Self::read`] / [`Self::current`]
    /// in the DSP loop.
    #[must_use]
    fn value(&self) -> f32;
}

/// Precision-routed read accessors for [`FloatParam`] at `f64`. See
/// [`FloatParamReadF32`] for the contract.
pub trait FloatParamReadF64 {
    #[must_use]
    fn read(&self) -> f64;
    /// f64 view of [`FloatParamReadF32::read_into`]; one widen per
    /// slot on top of the same one-atomic-pair fast path.
    fn read_into(&self, out: &mut [f64]);
    /// f64 view of [`FloatParamReadF32::read_after`]; one widen
    /// on top of the same one-atomic-pair fast path.
    #[must_use]
    fn read_after(&self, n_samples: usize) -> f64;
    #[must_use]
    fn current(&self) -> f64;
    #[must_use]
    fn value(&self) -> f64;
}

impl FloatParamReadF32 for FloatParam {
    #[inline]
    fn read(&self) -> f32 {
        self.raw_smoothed_next()
    }

    #[inline]
    fn read_into(&self, out: &mut [f32]) {
        self.raw_smoothed_next_into(out);
    }

    #[inline]
    fn read_after(&self, n_samples: usize) -> f32 {
        self.raw_smoothed_next_after(n_samples)
    }

    #[inline]
    fn current(&self) -> f32 {
        self.raw_smoothed_current()
    }

    #[inline]
    fn value(&self) -> f32 {
        f32::from_f64(self.raw_target())
    }
}

impl FloatParamReadF64 for FloatParam {
    #[inline]
    fn read(&self) -> f64 {
        f64::from(self.raw_smoothed_next())
    }

    #[inline]
    fn read_into(&self, out: &mut [f64]) {
        // Reuse the f32 fill via a transient stack scratch sized to
        // the largest chunk a plugin typically passes (cap to 1024 -
        // beyond that the caller almost certainly wants `read` per
        // sample), widening each slot to f64.
        const SCRATCH: usize = 1024;
        let mut scratch = [0.0_f32; SCRATCH];
        let mut remaining = out;
        while !remaining.is_empty() {
            let take = remaining.len().min(SCRATCH);
            self.raw_smoothed_next_into(&mut scratch[..take]);
            for (dst, &src) in remaining[..take].iter_mut().zip(&scratch[..take]) {
                *dst = f64::from(src);
            }
            remaining = &mut remaining[take..];
        }
    }

    #[inline]
    fn read_after(&self, n_samples: usize) -> f64 {
        f64::from(self.raw_smoothed_next_after(n_samples))
    }

    #[inline]
    fn current(&self) -> f64 {
        f64::from(self.raw_smoothed_current())
    }

    #[inline]
    fn value(&self) -> f64 {
        self.raw_target()
    }
}

/// A boolean parameter.
pub struct BoolParam {
    pub info: ParamInfo,
    value: AtomicBool,
}

impl BoolParam {
    /// # Panics
    ///
    /// Panics if `info.default_plain` isn't exactly `0.0` or `1.0`.
    /// Bool params have no halfway value; the derive emits `0.0` /
    /// `1.0` only, so this fires only when a user constructs a
    /// `BoolParam` from hand-rolled `ParamInfo`.
    #[must_use]
    pub fn new(info: ParamInfo) -> Self {
        let default = match info.default_plain {
            0.0 => false,
            1.0 => true,
            other => panic!(
                "BoolParam '{}' default {} must be exactly 0.0 (false) \
                 or 1.0 (true) - bool params have no halfway value",
                info.name, other,
            ),
        };
        Self {
            info,
            value: AtomicBool::new(default),
        }
    }

    pub fn value(&self) -> bool {
        self.value.load(Ordering::Relaxed)
    }

    pub fn set_value(&self, v: bool) {
        self.value.store(v, Ordering::Relaxed);
    }

    pub fn id(&self) -> u32 {
        self.info.id
    }
}

/// An integer parameter.
pub struct IntParam {
    pub info: ParamInfo,
    value: AtomicI64,
}

impl IntParam {
    /// # Panics
    ///
    /// Panics if `info.default_plain` is non-finite or doesn't
    /// round-trip through `i64`. The cast `f64 as i64` saturates
    /// silently - `default_plain = -1.0` lands on `-1` (fine), but
    /// `default_plain = 1e30` saturates to `i64::MAX` and `f64::NAN`
    /// becomes `0`. The derive populates `default_plain` from
    /// `#[param(default = ...)]`; a user-supplied float there is a
    /// programmer error, not a runtime condition we should
    /// silently absorb.
    // `truncated as f64 == default` is the integer round-trip
    // exactness check - epsilon would defeat its purpose. The
    // `as i64` truncation is the round-trip's whole point.
    #[allow(
        clippy::float_cmp,
        clippy::cast_possible_truncation,
        clippy::cast_precision_loss
    )]
    #[must_use]
    pub fn new(info: ParamInfo) -> Self {
        let default = info.default_plain;
        assert!(
            default.is_finite(),
            "IntParam '{}' default {} is not finite",
            info.name,
            default,
        );
        let truncated = default as i64;
        assert!(
            truncated as f64 == default,
            "IntParam '{}' default {} doesn't round-trip through i64 \
             - supply an integer-valued default in the derive attribute",
            info.name,
            default,
        );
        let (lo, hi) = (info.range.min() as i64, info.range.max() as i64);
        assert!(
            truncated >= lo && truncated <= hi,
            "IntParam '{}' default {} is outside range [{}, {}]",
            info.name,
            truncated,
            lo,
            hi,
        );
        Self {
            info,
            value: AtomicI64::new(truncated),
        }
    }

    pub fn value(&self) -> i64 {
        self.value.load(Ordering::Relaxed)
    }

    /// Read the value widened to `f32`. Useful when an int param feeds
    /// a per-sample DSP loop that runs in `f32`.
    #[allow(clippy::cast_precision_loss)]
    #[inline]
    pub fn value_f32(&self) -> f32 {
        self.value.load(Ordering::Relaxed) as f32
    }

    /// Read the value widened to `f64`.
    #[allow(clippy::cast_precision_loss)]
    #[inline]
    pub fn value_f64(&self) -> f64 {
        self.value.load(Ordering::Relaxed) as f64
    }

    /// Read the value as a non-negative `usize`. Negatives clamp to 0;
    /// values above `usize::MAX` saturate.
    #[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
    #[inline]
    pub fn value_usize(&self) -> usize {
        let v = self.value.load(Ordering::Relaxed);
        if v <= 0 { 0 } else { v as usize }
    }

    /// Read the value clamped to `i32` range.
    #[allow(clippy::cast_possible_truncation)]
    #[inline]
    pub fn value_i32(&self) -> i32 {
        self.value
            .load(Ordering::Relaxed)
            .clamp(i64::from(i32::MIN), i64::from(i32::MAX)) as i32
    }

    /// Read the value clamped to `u8` range (`0..=255`).
    #[allow(clippy::cast_sign_loss, clippy::cast_possible_truncation)]
    #[inline]
    pub fn value_u8(&self) -> u8 {
        self.value.load(Ordering::Relaxed).clamp(0, 255) as u8
    }

    /// Set the value, clamped to the declared range - symmetric with
    /// `FloatParam::set_value`. A corrupt preset or hostile automation
    /// value (`i64::MAX` into a `[0, 8]` param) must not reach the plugin,
    /// where it could index out of range and panic the audio thread. The
    /// bounds are normalized so a mis-ordered range can't panic `clamp`.
    #[allow(clippy::cast_possible_truncation)]
    pub fn set_value(&self, v: i64) {
        let (lo, hi) = (self.info.range.min() as i64, self.info.range.max() as i64);
        self.value
            .store(v.clamp(lo.min(hi), lo.max(hi)), Ordering::Relaxed);
    }

    pub fn id(&self) -> u32 {
        self.info.id
    }
}

/// Trait for enums used as parameters.
pub trait ParamEnum: crate::__private::Sealed + Clone + Copy + Send + Sync + 'static {
    fn from_index(index: usize) -> Self;
    fn to_index(&self) -> usize;
    fn name(&self) -> &'static str;
    fn variant_count() -> usize;
    fn variant_names() -> &'static [&'static str];
}

/// An enum parameter.
pub struct EnumParam<E: ParamEnum> {
    pub info: ParamInfo,
    value: AtomicU32,
    _phantom: std::marker::PhantomData<E>,
}

impl<E: ParamEnum> EnumParam<E> {
    /// # Panics
    ///
    /// Panics if `info.default_plain` is non-finite, negative, or
    /// `>= E::variant_count()`. The cast `f64 as u32` saturates
    /// silently - a user-supplied `#[param(default = -1)]` would
    /// land on variant 0 without any signal that the default was
    /// invalid. Validate up front so the bug surfaces at plugin
    /// construction time.
    // `f64::from(idx) == default` is the integer round-trip
    // exactness check - epsilon would defeat its purpose. The
    // `as u32` truncation is the round-trip's whole point.
    #[allow(
        clippy::float_cmp,
        clippy::cast_possible_truncation,
        clippy::cast_sign_loss
    )]
    #[must_use]
    pub fn new(info: ParamInfo) -> Self {
        let default = info.default_plain;
        let count = E::variant_count();
        assert!(
            default.is_finite(),
            "EnumParam '{}' default {} is not finite",
            info.name,
            default,
        );
        assert!(
            default >= 0.0,
            "EnumParam '{}' default {} is negative; enum variants are \
             0-indexed",
            info.name,
            default,
        );
        let idx = default as u32;
        assert!(
            f64::from(idx) == default,
            "EnumParam '{}' default {} is non-integer; supply a 0-indexed \
             variant index",
            info.name,
            default,
        );
        assert!(
            (idx as usize) < count,
            "EnumParam '{}' default {} is out of range; only {} variant(s) \
             defined",
            info.name,
            idx,
            count,
        );
        Self {
            info,
            value: AtomicU32::new(idx),
            _phantom: std::marker::PhantomData,
        }
    }

    pub fn value(&self) -> E {
        // u32 → usize widens on 64-bit, narrows nowhere we ship to;
        // the lint trips because `usize` is target-dependent.
        #[allow(clippy::cast_possible_truncation)]
        let idx = self.value.load(Ordering::Relaxed) as usize;
        E::from_index(idx)
    }

    pub fn set_value(&self, v: E) {
        // Enum variant indices come from `ParamEnum::to_index`, whose
        // valid range is `0..variant_count()`; truncation past `u32::MAX`
        // would mean a > 4-billion-variant enum.
        #[allow(clippy::cast_possible_truncation)]
        let idx = v.to_index() as u32;
        self.value.store(idx, Ordering::Relaxed);
    }

    pub fn set_index(&self, idx: u32) {
        // Clamp to the enum's valid range. A preset saved with a wider
        // enum (a since-shrunk v1) restores an out-of-range index through
        // here; stored verbatim, `value()` / `from_index` read it as the
        // first variant while `get_normalized` clamps to the last, so audio
        // and display disagree. Clamp to the last variant - matching
        // `ParamRange::Enum::normalize`'s clamp - so they stay consistent.
        // `variant_count()` is >= 1 for any `ParamEnum`; `saturating_sub`
        // guards the underflow regardless.
        #[allow(clippy::cast_possible_truncation)]
        let max = (E::variant_count() as u32).saturating_sub(1);
        self.value.store(idx.min(max), Ordering::Relaxed);
    }

    pub fn index(&self) -> u32 {
        self.value.load(Ordering::Relaxed)
    }

    pub fn id(&self) -> u32 {
        self.info.id
    }

    /// Format a plain value (index as f64) to the variant name string.
    ///
    /// Associated function - the dispatch is purely on `E`, no instance
    /// state is read. The `#[derive(Params)]` macro calls it as
    /// `<EnumParam<E>>::format_by_index(value)` so the field type
    /// supplies `E`.
    #[must_use]
    pub fn format_by_index(value: f64) -> String {
        // `value` is a normalized f64 in `[0, count - 1]`; the round
        // → usize cast is bounded by the variant count.
        #[allow(clippy::cast_possible_truncation, clippy::cast_sign_loss)]
        let idx = value.round() as usize;
        E::from_index(idx).name().to_string()
    }
}

// ---------------------------------------------------------------------------
// MeterSlot
// ---------------------------------------------------------------------------

/// A meter slot with an auto-assigned ID.
///
/// Declare in your params struct with `#[meter]`:
/// ```ignore
/// #[derive(Params)]
/// pub struct MyParams {
///     #[meter]
///     pub meter_left: MeterSlot,
/// }
/// ```
///
/// `id` is `pub` so the `#[derive(Params)]` macro can construct a
/// `MeterSlot { id: <auto-assigned> }` directly without going through
/// a `pub fn new(id)` constructor that would let user code mint
/// arbitrary slots and break the auto-assignment contract.
pub struct MeterSlot {
    #[doc(hidden)]
    pub id: u32,
}

impl MeterSlot {
    #[must_use]
    pub fn id(&self) -> u32 {
        self.id
    }
}

impl From<MeterSlot> for u32 {
    fn from(m: MeterSlot) -> u32 {
        m.id
    }
}

impl From<&MeterSlot> for u32 {
    fn from(m: &MeterSlot) -> u32 {
        m.id
    }
}

// ---------------------------------------------------------------------------
// AudioTap
// ---------------------------------------------------------------------------

use std::sync::atomic::AtomicUsize;

/// Default ring capacity in samples for [`AudioTap::default`] - two
/// typical 2048-point analyzer FFT windows' worth of headroom so a
/// slightly late UI drain doesn't lose a whole frame.
pub const DEFAULT_TAP_CAPACITY: usize = 4096;

/// Lock-free single-producer/single-consumer sample tap for the audio
/// → UI analyzer path (audio→UI sample ring).
///
/// The audio thread [`push`](Self::push)es raw samples every
/// `process()` call; the UI/editor thread [`drain`](Self::drain)s them
/// once per frame. Both sides use plain atomics only - no locks, no
/// allocation on the producer side - so `push` is safe to call from a
/// realtime audio callback (`agal/skills/00-core/audio-thread-boundary.md`).
///
/// Declare with `#[skip]` like any other DSP↔UI shared field the
/// derive default-initializes:
///
/// ```ignore
/// #[derive(Params)]
/// pub struct AnalyzerParams {
///     #[skip]
///     pub spectrum_tap: AudioTap,
/// }
/// ```
///
/// The editor reaches it through the concrete `Arc<Self::Params>`
/// `PluginLogic::editor()` already receives (capture it into the
/// build/sync closures) - not through the `dyn Params` trait, since a
/// raw sample ring isn't part of the host-automatable parameter
/// surface. FFT / spectrum math stays product-side (`lx-analysis`,
/// see G16); this type only moves raw samples across the thread
/// boundary.
///
/// Single-producer / single-consumer is a caller contract, not
/// enforced by the type: only the audio thread may call `push`, only
/// the UI/editor thread may call `drain`.
///
/// On overflow (producer outruns the consumer), the oldest unread
/// samples are silently overwritten - the tap never blocks and never
/// grows, matching the audio thread's no-alloc/no-lock constraint.
/// Need a non-default capacity? `#[skip]` fields only require
/// `Default`, so wrap in a newtype with its own `Default` impl calling
/// [`AudioTap::new`].
pub struct AudioTap {
    buf: Box<[AtomicU32]>,
    /// Total samples ever pushed (monotonic; wraps at `usize::MAX`).
    write: AtomicUsize,
    /// Total samples ever drained (monotonic; wraps at `usize::MAX`).
    read: AtomicUsize,
}

impl AudioTap {
    /// New tap with the given capacity in samples. `0` is treated as
    /// `1` - a zero-length ring can't hold a sample.
    #[must_use]
    pub fn new(capacity: usize) -> Self {
        let capacity = capacity.max(1);
        Self {
            buf: (0..capacity).map(|_| AtomicU32::new(0)).collect(),
            write: AtomicUsize::new(0),
            read: AtomicUsize::new(0),
        }
    }

    /// Ring capacity in samples.
    #[must_use]
    pub fn capacity(&self) -> usize {
        self.buf.len()
    }

    /// Push samples from the audio thread. Never allocates, never
    /// blocks; overwrites the oldest unread samples on overflow.
    pub fn push(&self, samples: &[f32]) {
        let cap = self.buf.len();
        let mut write = self.write.load(Ordering::Relaxed);
        for &s in samples {
            self.buf[write % cap].store(s.to_bits(), Ordering::Relaxed);
            write = write.wrapping_add(1);
        }
        self.write.store(write, Ordering::Release);
    }

    /// Drain every sample pushed since the last `drain`, oldest first.
    /// Call from the UI/editor thread. Returns fewer samples than were
    /// pushed since the last drain if the producer overflowed the ring
    /// in the meantime - the overwritten samples are simply gone.
    #[must_use]
    pub fn drain(&self) -> Vec<f32> {
        let cap = self.buf.len();
        let write = self.write.load(Ordering::Acquire);
        let read = self.read.load(Ordering::Relaxed);
        let available = write.wrapping_sub(read).min(cap);
        let start = write.wrapping_sub(available);
        let mut out = Vec::with_capacity(available);
        for i in 0..available {
            let idx = start.wrapping_add(i) % cap;
            out.push(f32::from_bits(self.buf[idx].load(Ordering::Relaxed)));
        }
        self.read.store(write, Ordering::Release);
        out
    }
}

impl Default for AudioTap {
    fn default() -> Self {
        Self::new(DEFAULT_TAP_CAPACITY)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::info::{ParamFlags, ParamUnit, ParamValueKind};
    use crate::range::ParamRange;

    fn info(name: &'static str, range: ParamRange, default_plain: f64) -> ParamInfo {
        ParamInfo {
            id: 0,
            name,
            short_name: name,
            group: "",
            range,
            default_plain,
            flags: ParamFlags::AUTOMATABLE,
            unit: ParamUnit::None,
            kind: ParamValueKind::Float,
            midi_map: None,
            midi_channel: None,
        }
    }

    #[derive(Clone, Copy)]
    enum E4 {
        A,
        B,
        C,
        D,
    }
    impl crate::__private::Sealed for E4 {}
    impl ParamEnum for E4 {
        fn from_index(i: usize) -> Self {
            match i {
                0 => Self::A,
                1 => Self::B,
                2 => Self::C,
                _ => Self::D,
            }
        }
        fn to_index(&self) -> usize {
            *self as usize
        }
        fn name(&self) -> &'static str {
            match self {
                Self::A => "A",
                Self::B => "B",
                Self::C => "C",
                Self::D => "D",
            }
        }
        fn variant_count() -> usize {
            4
        }
        fn variant_names() -> &'static [&'static str] {
            &["A", "B", "C", "D"]
        }
    }

    #[test]
    fn enum_param_accepts_in_range_default() {
        let p: EnumParam<E4> = EnumParam::new(info("Mode", ParamRange::Enum { count: 4 }, 2.0));
        assert_eq!(p.index(), 2);
    }

    #[test]
    #[should_panic(expected = "negative")]
    fn enum_param_rejects_negative_default() {
        let _: EnumParam<E4> = EnumParam::new(info("Mode", ParamRange::Enum { count: 4 }, -1.0));
    }

    #[test]
    fn enum_param_set_index_clamps_out_of_range() {
        // A preset saved with a wider (5-variant) enum restores index 4
        // into this 4-variant enum. It must clamp to the last variant so
        // `value()` (audio) and the normalized read (display) agree - not
        // play the first variant while `normalize` clamps to the last.
        let p: EnumParam<E4> = EnumParam::new(info("Mode", ParamRange::Enum { count: 4 }, 0.0));
        p.set_index(4);
        assert_eq!(p.index(), 3, "out-of-range index clamps to last variant");
        assert!(matches!(p.value(), E4::D));
        p.set_index(1000);
        assert_eq!(p.index(), 3);
    }

    #[test]
    #[should_panic(expected = "out of range")]
    fn enum_param_rejects_overflow_default() {
        let _: EnumParam<E4> = EnumParam::new(info("Mode", ParamRange::Enum { count: 4 }, 99.0));
    }

    #[test]
    #[should_panic(expected = "non-integer")]
    fn enum_param_rejects_fractional_default() {
        let _: EnumParam<E4> = EnumParam::new(info("Mode", ParamRange::Enum { count: 4 }, 1.5));
    }

    #[test]
    fn int_param_accepts_negative_default() {
        let p = IntParam::new(info("N", ParamRange::Discrete { min: -10, max: 10 }, -3.0));
        assert_eq!(p.value(), -3);
    }

    #[test]
    #[should_panic(expected = "round-trip")]
    fn int_param_rejects_fractional_default() {
        let _ = IntParam::new(info("N", ParamRange::Discrete { min: 0, max: 10 }, 1.5));
    }

    #[test]
    #[should_panic(expected = "outside range")]
    fn int_param_rejects_out_of_range_default() {
        let _ = IntParam::new(info("N", ParamRange::Discrete { min: 0, max: 5 }, 10.0));
    }

    #[test]
    fn int_param_set_value_clamps_to_range() {
        // A corrupt preset restoring a wild value must not land out of range
        // (symmetric with FloatParam::set_value); the derive stores
        // `value.round() as i64`, so i64::MAX is a realistic input.
        let p = IntParam::new(info("N", ParamRange::Discrete { min: 0, max: 8 }, 0.0));
        p.set_value(i64::MAX);
        assert_eq!(p.value(), 8, "clamps above max");
        p.set_value(-1000);
        assert_eq!(p.value(), 0, "clamps below min");
        p.set_value(5);
        assert_eq!(p.value(), 5, "in-range value stored as-is");
    }

    fn float(min: f64, max: f64) -> FloatParam {
        FloatParam::new(
            info("Gain", ParamRange::Linear { min, max }, 0.0),
            SmoothingStyle::None,
        )
    }

    #[test]
    #[allow(clippy::float_cmp)] // clamp / dropped-write yields the exact stored value
    fn float_set_value_drops_non_finite() {
        let p = float(-60.0, 6.0);
        p.set_value(-12.0);
        p.set_value(f64::NAN);
        assert_eq!(p.raw_target(), -12.0, "NaN write is dropped");
        p.set_value(f64::INFINITY);
        assert_eq!(p.raw_target(), -12.0, "infinite write is dropped");
    }

    #[test]
    #[allow(clippy::float_cmp)] // clamp yields the exact range bound
    fn float_set_value_clamps_to_range() {
        let p = float(-60.0, 6.0);
        p.set_value(1e308);
        assert_eq!(p.raw_target(), 6.0, "clamps above max");
        p.set_value(-1e308);
        assert_eq!(p.raw_target(), -60.0, "clamps below min");
    }

    /// A mis-ordered range (`min > max`) is a bug caught at construction in
    /// debug builds - loud and early, not a `clamp` panic buried in a
    /// host-automation callback.
    #[cfg(debug_assertions)]
    #[test]
    #[should_panic(expected = "ordered")]
    fn float_new_debug_asserts_misordered_range() {
        let _ = FloatParam::new(
            info(
                "Bad",
                ParamRange::Linear {
                    min: 6.0,
                    max: -60.0,
                },
                0.0,
            ),
            SmoothingStyle::None,
        );
    }

    /// In release the construction assert is compiled out, so `set_value`
    /// must still not panic on a mis-ordered range: it normalizes the clamp
    /// bounds. (`f64::clamp` would panic on `min > max`.)
    #[cfg(not(debug_assertions))]
    #[test]
    fn float_set_value_survives_misordered_range() {
        let p = FloatParam::new(
            info(
                "Bad",
                ParamRange::Linear {
                    min: 6.0,
                    max: -60.0,
                },
                0.0,
            ),
            SmoothingStyle::None,
        );
        p.set_value(1000.0); // must not panic
        let v = p.raw_target();
        assert!(
            (-60.0..=6.0).contains(&v),
            "clamped to the normalized interval"
        );
    }

    #[test]
    fn audio_tap_push_drain_round_trip() {
        let tap = AudioTap::new(8);
        tap.push(&[1.0, 2.0, 3.0]);
        assert_eq!(tap.drain(), vec![1.0, 2.0, 3.0]);
        // Fully drained: nothing left until the next push.
        assert_eq!(tap.drain(), Vec::<f32>::new());
    }

    #[test]
    fn audio_tap_multiple_pushes_before_drain() {
        let tap = AudioTap::new(8);
        tap.push(&[1.0, 2.0]);
        tap.push(&[3.0, 4.0]);
        assert_eq!(tap.drain(), vec![1.0, 2.0, 3.0, 4.0]);
    }

    #[test]
    fn audio_tap_overflow_drops_oldest_never_blocks() {
        let tap = AudioTap::new(4);
        // Push more than capacity in one go: only the last 4 survive.
        tap.push(&[1.0, 2.0, 3.0, 4.0, 5.0, 6.0]);
        assert_eq!(tap.drain(), vec![3.0, 4.0, 5.0, 6.0]);
    }

    #[test]
    fn audio_tap_overflow_across_pushes_between_drains() {
        let tap = AudioTap::new(4);
        tap.push(&[1.0, 2.0, 3.0]);
        // Consumer hasn't drained yet; producer keeps going and wraps.
        tap.push(&[4.0, 5.0, 6.0]);
        // Ring holds 4: the oldest 2 (1.0, 2.0) were overwritten.
        assert_eq!(tap.drain(), vec![3.0, 4.0, 5.0, 6.0]);
    }

    #[test]
    fn audio_tap_default_uses_default_capacity() {
        assert_eq!(AudioTap::default().capacity(), DEFAULT_TAP_CAPACITY);
    }

    #[test]
    fn audio_tap_zero_capacity_clamped_to_one() {
        let tap = AudioTap::new(0);
        assert_eq!(tap.capacity(), 1);
        tap.push(&[7.0, 8.0]);
        assert_eq!(
            tap.drain(),
            vec![8.0],
            "only the last sample survives a 1-slot ring"
        );
    }

    #[test]
    fn float_mod_is_non_destructive() {
        let p = FloatParam::new(
            info("Gain", ParamRange::Linear { min: 0.0, max: 1.0 }, 0.5),
            SmoothingStyle::None,
        );
        assert!((p.raw_target() - 0.5).abs() < 1e-12);
        p.set_mod_amount(0.25);
        assert!((p.raw_target() - 0.5).abs() < 1e-12);
        assert!((p.effective_target() - 0.75).abs() < 1e-12);
        p.set_mod_amount(0.0);
        assert!((p.effective_target() - 0.5).abs() < 1e-12);
    }

    #[test]
    fn float_mod_clamps_to_range() {
        let p = FloatParam::new(
            info("Gain", ParamRange::Linear { min: 0.0, max: 1.0 }, 0.5),
            SmoothingStyle::None,
        );
        p.set_value(0.9);
        p.set_mod_amount(0.5); // would be 1.4
        assert!((p.effective_target() - 1.0).abs() < 1e-12);
    }
}