dhvani 1.0.0

Core audio engine — buffers, DSP, resampling, mixing, analysis, and capture for Rust
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

# Contributing to Dhvani

Thank you for considering contributing to dhvani. This guide will help you get started.

## Getting started

```bash
git clone https://github.com/MacCracken/dhvani
cd dhvani
make check   # runs fmt + clippy + test + audit
```

## Development workflow

| Command | What it does |
|---------|-------------|
| `make check` | Full CI locally (fmt, clippy, test, audit) |
| `make fmt` | Check formatting |
| `make clippy` | Lint with `-D warnings` |
| `make test` | Run all tests |
| `make bench` | Run benchmarks |
| `make doc` | Build docs |
| `cargo test --no-default-features` | Verify scalar fallback (no SIMD) |

## What to contribute

- Bug fixes with regression tests
- New DSP effects (biquad-based, reverb variants, dynamics processing)
- SIMD kernel optimizations (SSE2/AVX2/NEON)
- Platform support (audio backends, OS-specific features)
- Documentation improvements and examples
- Benchmark improvements

## Code style

- `cargo fmt` — required, checked in CI
- `cargo clippy -- -D warnings` — zero warnings
- Explicit types on public API boundaries
- Doc comments (`///`) on all public types and functions
- Minimal dependencies — prefer pure Rust over C bindings
- `#[non_exhaustive]` on public enums
- `#[serde(default)]` on parameter structs for forward compatibility

## Project layout

```
src/
├── lib.rs              # Crate root, public API
├── error.rs            # NadaError enum
├── buffer/             # AudioBuffer, mixing, resampling, format conversion
├── dsp/                # Biquad, EQ, reverb, delay, compressor, limiter, de-esser, panner, oscillator, LFO, envelope, noise reduction
├── analysis/           # FFT, STFT, EBU R128 loudness, dynamics, chromagram, onset detection, waveform
├── clock/              # Sample-accurate transport clock
├── midi/               # MIDI 1.0/2.0 types, voice management, routing, translation
├── graph/              # RT-safe audio graph (AudioNode, ExecutionPlan, GraphProcessor)
├── meter/              # Lock-free peak metering (AtomicU32)
├── simd/               # Platform SIMD kernels (SSE2, AVX2, NEON)
├── capture/            # PipeWire audio capture/output, ring-buffer recording (feature-gated)
├── ffi.rs              # C-compatible AudioBuffer API
└── tests/              # Integration, property-based, and serde tests
```

## Adding a new DSP effect

1. Create `src/dsp/your_effect.rs` with the effect struct and `process(&mut AudioBuffer)` method
2. Add `pub mod your_effect;` and re-exports in `src/dsp/mod.rs`
3. Add unit tests in the module (silence passthrough, known-signal verification, parameter edge cases)
4. Add a benchmark in `benches/dsp.rs`
5. If the effect has SIMD-friendly inner loops, add kernels in `src/simd/`

## Commit messages

- Use imperative mood: "add reverb effect" not "added reverb effect"
- Keep subject under 72 characters
- Reference issues where applicable: "fix #42: handle zero-length buffers"

## Pull requests

- One logical change per PR
- Include tests for new functionality
- Update docs if the public API changes
- All CI checks must pass (fmt, clippy, test, audit, deny)

## Versioning

Dhvani uses `day.month` SemVer (e.g., `0.22.3`). Version bumps are managed by maintainers.

## License

By contributing, you agree that your contributions will be licensed under AGPL-3.0-only.