naad 1.2.5

naad — Audio synthesis primitives: oscillators, filters, envelopes, modulation, wavetables, effects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

//! # naad — Audio Synthesis Primitives
//!
//! **naad** (Sanskrit: primordial sound/vibration) provides foundational audio
//! synthesis building blocks: oscillators, filters, envelopes, wavetables,
//! modulation, delay lines, effects, noise generators, and tuning utilities.
//!
//! Part of the AGNOS ecosystem. Consumed by **dhvani** (sound engine) and
//! **svara** (music composition).
//!
//! ## Architecture
//!
//! All processing methods work on contiguous `&mut [f32]` slices. Hot-path
//! methods (`next_sample`, `process_sample`) are `#[inline]` for cross-crate
//! optimization. Buffer methods (`fill_buffer`, `process_buffer`) iterate
//! over slices, enabling SIMD auto-vectorization when compiled with
//! appropriate target features (`-C target-cpu=native`).
//!
//! dhvani (the sound engine) handles buffer alignment and SIMD dispatch.
//! naad provides the scalar reference implementations.
//!
//! ## Quick Start
//!
//! ```rust
//! use naad::oscillator::{Oscillator, Waveform};
//! use naad::envelope::Adsr;
//! use naad::filter::{BiquadFilter, FilterType};
//!
//! // Create a 440 Hz sine oscillator
//! let mut osc = Oscillator::new(Waveform::Sine, 440.0, 44100.0).unwrap();
//!
//! // Create an ADSR envelope
//! let mut env = Adsr::new(0.01, 0.1, 0.7, 0.3).unwrap();
//!
//! // Create a low-pass filter at 2kHz
//! let mut filter = BiquadFilter::new(FilterType::LowPass, 44100.0, 2000.0, 0.707).unwrap();
//!
//! // Generate a sample
//! env.gate_on();
//! let sample = osc.next_sample() * env.next_value();
//! let filtered = filter.process_sample(sample);
//! ```
//!
//! ## Feature Flags
//!
//! - `default` — All core primitives (oscillators, filters, envelopes, effects, dynamics, EQ, reverb, voice, mod matrix, panning, smoothing, tuning, noise, delay, wavetable, dsp_util)
//! - `synthesis` — Synthesis algorithm modules (subtractive, FM, drum, formant, additive, vocoder, granular, physical modeling)
//! - `acoustics` — Room simulation, convolution reverb, binaural, FDN, analysis, ambisonics (via goonj)
//! - `logging` — Enable tracing-subscriber for structured logging output
//! - `full` — All features enabled
//!
//! ## API Conventions
//!
//! These conventions apply uniformly across the crate. Knowing them up front
//! avoids surprises when wiring naad into a host (dhvani, svara, etc.).
//!
//! ### Encapsulation
//!
//! - **Stateful types with non-trivial invariants** (e.g. [`oscillator::Oscillator`],
//!   [`filter::BiquadFilter`], [`wavetable::Wavetable`]) keep their fields **private**
//!   and expose validated setters. Modifying state requires a constructor or a
//!   typed mutator — there is no way to silently break the invariant.
//! - **Parameter structs** that are pure value-bags read directly by their owning
//!   type (e.g. [`dynamics::Compressor::threshold_db`], [`envelope::Adsr::sustain_level`])
//!   keep `pub` fields. They are documented when modifying them bypasses
//!   constructor-time clamping; callers may set arbitrary `f32` values and
//!   accept whatever output the algorithm produces.
//!
//! Rule of thumb: if changing a field requires recomputing cached coefficients
//! or affects internal state coupling, it is private. If it only feeds a
//! direct read in the next-sample loop, it may be `pub`.
//!
//! ### Constructor return types
//!
//! - **Constructors that validate `sample_rate`, `frequency`, or other
//!   range-restricted inputs return [`Result`]**. Examples:
//!   [`oscillator::Oscillator::new`], [`filter::BiquadFilter::new`],
//!   [`envelope::Adsr::new`].
//! - **Constructors that only clamp inputs (e.g. amplitude to `0..=1`) are
//!   infallible** — they take any `f32` and store the clamped result.
//!   Examples: [`dynamics::LevelDetector::new`], [`smoothing::ParamSmoother::new`].
//! - **Index-based mutators (`set_operator_freq`, `set_band_gain`)** that may
//!   receive an out-of-range index return `Option<()>` or `Result<()>` so
//!   callers can detect — and not silently ignore — bad indices.

pub mod delay;
pub mod dsp_util;
pub mod dynamics;
pub mod effects;
pub mod envelope;
pub mod eq;
pub mod error;
pub mod filter;
pub mod mod_matrix;
pub mod modulation;
pub mod noise;
pub mod oscillator;
pub mod panning;
pub mod reverb;
pub mod smoothing;
pub mod tuning;
pub mod voice;
pub mod wavetable;

#[cfg(feature = "synthesis")]
pub mod synth;

#[cfg(feature = "acoustics")]
pub mod acoustics;

pub use error::{NaadError, Result};

/// Flush denormal floating-point values to zero.
///
/// Denormal (subnormal) floats cause 10-100x slowdowns on x86 processors.
/// Call this on filter state variables and feedback paths to prevent
/// performance degradation when signals decay to near-zero.
#[inline]
#[must_use]
pub fn flush_denormal(x: f32) -> f32 {
    // A float is denormal if its exponent bits are all zero but mantissa is non-zero.
    // Threshold: f32::MIN_POSITIVE (1.175e-38) is the smallest normal f32.
    if x.abs() < f32::MIN_POSITIVE { 0.0 } else { x }
}