NeuralAmpModeler-rs 3.0.0

An opinionated, high-performance Neural Amp Modeler (NAM) client and core implementation in Rust for Linux/PipeWire and CLAP plugins.
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Fábio Henrique de Lima Silva (fhl.bsb@gmail.com) All rights reserved.

use super::*;
use crate::math::common::AlignedVec;
use crate::models::wavenet::{
    Conv1dDyn, DenseLayerDyn, WAVENET_MAX_NUM_FRAMES, WaveNetLayerArrayDyn, WaveNetLayerDyn,
    WaveNetLayerState, WaveNetModelDyn,
};

const TEST_KERNEL: usize = 3;
const TEST_DILATION: usize = 2;
const CH_FULL: usize = 8;
const CH_SLIM: usize = 4;

fn make_conv1d(in_ch: usize, out_ch: usize) -> Conv1dDyn {
    let kernel = TEST_KERNEL;
    let num_blocks = out_ch.div_ceil(4);
    let weights_len = num_blocks * 4 * in_ch * kernel;
    let mut weights = AlignedVec::new(weights_len, 0.0f32)
        .expect("allocation should succeed for test-sized buffers");
    for i in 0..weights_len {
        weights[i] = (i + 1) as f32;
    }
    let mut bias =
        AlignedVec::new(out_ch, 0.0f32).expect("allocation should succeed for test-sized buffers");
    for i in 0..out_ch {
        bias[i] = (i + 100) as f32;
    }
    Conv1dDyn {
        weights,
        bias,
        do_bias: true,
        dilation: TEST_DILATION,
        in_ch,
        out_ch,
        num_blocks,
        interleave_width: 4,
        kernel,
    }
}

fn make_dense(in_ch: usize, out_ch: usize) -> DenseLayerDyn {
    let mut weights = AlignedVec::new(in_ch * out_ch, 0.0f32)
        .expect("allocation should succeed for test-sized buffers");
    for in_c in 0..in_ch {
        for out_c in 0..out_ch {
            weights[in_c * out_ch + out_c] = ((in_c * out_ch + out_c) as f32) + 1.0;
        }
    }
    let mut bias =
        AlignedVec::new(out_ch, 0.0f32).expect("allocation should succeed for test-sized buffers");
    for i in 0..out_ch {
        bias[i] = (i + 200) as f32;
    }
    DenseLayerDyn {
        in_ch,
        out_ch,
        weights,
        bias,
        do_bias: true,
    }
}

fn make_wavenet_layer(ch: usize) -> WaveNetLayerDyn {
    let conv1d = make_conv1d(ch, ch);
    let input_mixin = make_dense(1, ch);
    let one_by_one = make_dense(ch, ch);
    WaveNetLayerDyn::new(ch, conv1d, input_mixin, one_by_one).unwrap()
}

fn make_wavenet_array(
    in_ch: usize,
    ch: usize,
    head: usize,
    dilations: &[usize],
) -> WaveNetLayerArrayDyn {
    let rechannel = make_dense(in_ch, ch);
    let num_layers = dilations.len();
    let mut layers = Vec::with_capacity(num_layers);
    let mut states = Vec::with_capacity(num_layers);
    for (alloc_num, &d) in dilations.iter().enumerate() {
        let mut layer = make_wavenet_layer(ch);
        layer.conv1d.dilation = d;
        let rf = (TEST_KERNEL - 1) * d;
        states.push(WaveNetLayerState::new(ch, rf, alloc_num).unwrap());
        layers.push(layer);
    }
    let head_rechannel = make_dense(ch, head);
    let receptive_field_size: usize = dilations.iter().map(|&d| (TEST_KERNEL - 1) * d).sum();
    let block_size = ch;
    WaveNetLayerArrayDyn {
        in_ch,
        cond: 1,
        ch,
        k: TEST_KERNEL,
        head,
        layers,
        states,
        rechannel,
        head_rechannel,
        array_outputs: AlignedVec::new(ch * WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        head_accum: AlignedVec::new(ch * WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        head_outputs: AlignedVec::new(head * WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        receptive_field_size,
        block_size,
        block_buffer: AlignedVec::new(block_size * WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        effective_layers: num_layers,
    }
}

fn make_full_model(ch: usize, head: usize) -> WaveNetModelDyn {
    let dilations = [1, 2, 4];
    let array1 = make_wavenet_array(1, ch, head, &dilations);
    let array2 = make_wavenet_array(ch, head, 1, &dilations);
    let rf = array1.receptive_field_size.max(array2.receptive_field_size);
    WaveNetModelDyn {
        ch,
        k: TEST_KERNEL,
        head,
        arrays: vec![array1, array2],
        head_scale: 0.02,
        receptive_field_size: rf,
        condition_dsp: None,
        condition_dsp_output: AlignedVec::new(WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        post_stack_head: None,
        head_output_scratch: AlignedVec::new(WAVENET_MAX_NUM_FRAMES, 0.0)
            .expect("allocation should succeed for test-sized buffers"),
        prewarm_on_reset: true,
    }
}

// =====================================================================
// slice_conv1d tests
// =====================================================================

#[test]
fn test_slice_conv1d_dims() {
    let conv = make_conv1d(CH_FULL, CH_FULL);
    let sliced = slice_conv1d(&conv, CH_SLIM, CH_SLIM).unwrap();
    assert_eq!(sliced.in_ch, CH_SLIM);
    assert_eq!(sliced.out_ch, CH_SLIM);
    assert_eq!(sliced.kernel, TEST_KERNEL);
    assert_eq!(sliced.dilation, TEST_DILATION);
    assert!(sliced.do_bias);
    assert_eq!(sliced.num_blocks, CH_SLIM.div_ceil(4));
    assert_eq!(
        sliced.weights.len(),
        sliced.num_blocks * 4 * CH_SLIM * TEST_KERNEL
    );
    assert_eq!(sliced.bias.len(), CH_SLIM);
}

#[test]
fn test_slice_conv1d_weights_match() {
    let conv = make_conv1d(CH_FULL, CH_FULL);
    let sliced = slice_conv1d(&conv, CH_SLIM, CH_SLIM).unwrap();

    for b in 0..sliced.num_blocks {
        for k in 0..TEST_KERNEL {
            for in_c in 0..CH_SLIM {
                let src_idx = ((b * TEST_KERNEL + k) * CH_FULL + in_c) * 4;
                let dst_idx = ((b * TEST_KERNEL + k) * CH_SLIM + in_c) * 4;
                assert_eq!(
                    &sliced.weights[dst_idx..dst_idx + 4],
                    &conv.weights[src_idx..src_idx + 4],
                    "mismatch at block={} k={} in_c={}",
                    b,
                    k,
                    in_c
                );
            }
        }
    }
}

#[test]
fn test_slice_conv1d_bias_match() {
    let conv = make_conv1d(CH_FULL, CH_FULL);
    let sliced = slice_conv1d(&conv, CH_SLIM, CH_SLIM).unwrap();
    assert_eq!(&sliced.bias[..CH_SLIM], &conv.bias[..CH_SLIM]);
}

#[test]
#[should_panic(expected = "slice_conv1d: new_in_ch")]
fn test_slice_conv1d_bigger_in_ch_panics() {
    let conv = make_conv1d(CH_FULL, CH_FULL);
    slice_conv1d(&conv, CH_FULL + 1, CH_FULL).unwrap();
}

#[test]
#[should_panic(expected = "slice_conv1d: new_out_ch")]
fn test_slice_conv1d_bigger_out_ch_panics() {
    let conv = make_conv1d(CH_FULL, CH_FULL);
    slice_conv1d(&conv, CH_FULL, CH_FULL + 1).unwrap();
}

// =====================================================================
// slice_dense tests
// =====================================================================

#[test]
fn test_slice_dense_dims() {
    let dense = make_dense(CH_FULL, CH_FULL);
    let sliced = slice_dense(&dense, CH_SLIM, CH_SLIM).unwrap();
    assert_eq!(sliced.in_ch, CH_SLIM);
    assert_eq!(sliced.out_ch, CH_SLIM);
    assert_eq!(sliced.do_bias, dense.do_bias);
    assert_eq!(sliced.weights.len(), CH_SLIM * CH_SLIM);
    assert_eq!(sliced.bias.len(), CH_SLIM);
}

#[test]
fn test_slice_dense_weights_match() {
    let dense = make_dense(CH_FULL, CH_FULL);
    let sliced = slice_dense(&dense, CH_SLIM, CH_SLIM).unwrap();

    for in_c in 0..CH_SLIM {
        for out_c in 0..CH_SLIM {
            let src_idx = in_c * CH_FULL + out_c;
            let dst_idx = in_c * CH_SLIM + out_c;
            assert_eq!(
                sliced.weights[dst_idx], dense.weights[src_idx],
                "mismatch at in_c={} out_c={}",
                in_c, out_c
            );
        }
    }
}

#[test]
fn test_slice_dense_bias_match() {
    let dense = make_dense(CH_FULL, CH_FULL);
    let sliced = slice_dense(&dense, CH_SLIM, CH_SLIM).unwrap();
    assert_eq!(&sliced.bias[..CH_SLIM], &dense.bias[..CH_SLIM]);
}

#[test]
fn test_slice_dense_asymmetric() {
    let dense = make_dense(8, 12);
    let sliced = slice_dense(&dense, 4, 6).unwrap();
    assert_eq!(sliced.in_ch, 4);
    assert_eq!(sliced.out_ch, 6);
    assert_eq!(sliced.weights.len(), 24);
    assert_eq!(sliced.bias.len(), 6);
    for in_c in 0..4usize {
        for out_c in 0..6usize {
            assert_eq!(
                sliced.weights[in_c * 6 + out_c],
                dense.weights[in_c * 12 + out_c]
            );
        }
    }
}

#[test]
#[should_panic(expected = "slice_dense: new_in_ch")]
fn test_slice_dense_bigger_in_ch_panics() {
    let dense = make_dense(CH_FULL, CH_FULL);
    slice_dense(&dense, CH_FULL + 1, CH_FULL).unwrap();
}

// =====================================================================
// slice_wavenet_layer tests
// =====================================================================

#[test]
fn test_slice_wavenet_layer_dims() {
    let layer = make_wavenet_layer(CH_FULL);
    let sliced = slice_wavenet_layer(&layer, CH_SLIM).unwrap();

    assert_eq!(sliced.conv1d.in_ch, CH_SLIM);
    assert_eq!(sliced.conv1d.out_ch, CH_SLIM);
    assert_eq!(sliced.input_mixin.in_ch, 1);
    assert_eq!(sliced.input_mixin.out_ch, CH_SLIM);
    assert_eq!(sliced.one_by_one.in_ch, CH_SLIM);
    assert_eq!(sliced.one_by_one.out_ch, CH_SLIM);
    assert_eq!(sliced.scratch_mixin.len(), CH_SLIM * WAVENET_MAX_NUM_FRAMES);
    assert_eq!(sliced.scratch_conv.len(), CH_SLIM * WAVENET_MAX_NUM_FRAMES);
}

#[test]
fn test_slice_wavenet_layer_weights_preserved() {
    let layer = make_wavenet_layer(CH_FULL);
    let sliced = slice_wavenet_layer(&layer, CH_SLIM).unwrap();

    let conv_sliced = slice_conv1d(&layer.conv1d, CH_SLIM, CH_SLIM).unwrap();
    let mixin_sliced = slice_dense(&layer.input_mixin, 1, CH_SLIM).unwrap();
    let obo_sliced = slice_dense(&layer.one_by_one, CH_SLIM, CH_SLIM).unwrap();

    assert_eq!(&*sliced.conv1d.weights, &*conv_sliced.weights);
    assert_eq!(&*sliced.input_mixin.weights, &*mixin_sliced.weights);
    assert_eq!(&*sliced.one_by_one.weights, &*obo_sliced.weights);
}

// =====================================================================
// slice_wavenet_array tests
// =====================================================================

#[test]
fn test_slice_wavenet_array_dims() {
    let dilations = [1, 2, 4];
    let array = make_wavenet_array(1, CH_FULL, 4, &dilations);
    let mut alloc_num = 0;
    let sliced = slice_wavenet_array(&array, 1, CH_SLIM, &mut alloc_num).unwrap();

    assert_eq!(sliced.in_ch, 1);
    assert_eq!(sliced.ch, CH_SLIM);
    assert_eq!(sliced.head, 4);
    assert_eq!(sliced.cond, 1);
    assert_eq!(sliced.layers.len(), 3);
    assert_eq!(sliced.states.len(), 3);
    assert_eq!(sliced.rechannel.in_ch, 1);
    assert_eq!(sliced.rechannel.out_ch, CH_SLIM);
    assert_eq!(sliced.head_rechannel.in_ch, CH_SLIM);
    assert_eq!(sliced.head_rechannel.out_ch, 4);
    assert_eq!(sliced.array_outputs.len(), CH_SLIM * WAVENET_MAX_NUM_FRAMES);
    assert_eq!(sliced.head_accum.len(), CH_SLIM * WAVENET_MAX_NUM_FRAMES);
    assert_eq!(sliced.block_size, CH_SLIM);
    assert_eq!(sliced.effective_layers, 3);
}

#[test]
fn test_slice_wavenet_array_preserves_weights() {
    let dilations = [1, 2, 4];
    let array = make_wavenet_array(1, CH_FULL, 4, &dilations);
    let mut alloc_num = 0;
    let sliced = slice_wavenet_array(&array, 1, CH_SLIM, &mut alloc_num).unwrap();

    let rec_expected = slice_dense(&array.rechannel, 1, CH_SLIM).unwrap();
    assert_eq!(&*sliced.rechannel.weights, &*rec_expected.weights);

    for (i, (orig, slic)) in array.layers.iter().zip(sliced.layers.iter()).enumerate() {
        let conv_expected = slice_conv1d(&orig.conv1d, CH_SLIM, CH_SLIM).unwrap();
        assert_eq!(
            &*slic.conv1d.weights, &*conv_expected.weights,
            "conv1d mismatch at layer {}",
            i
        );
    }

    let head_expected = slice_dense(&array.head_rechannel, CH_SLIM, 4).unwrap();
    assert_eq!(&*sliced.head_rechannel.weights, &*head_expected.weights);
}

// =====================================================================
// slice_wavenet_model / slice_channels tests
// =====================================================================

#[test]
fn test_slice_wavenet_model_dims() {
    let model = make_full_model(CH_FULL, CH_SLIM);
    let sliced = slice_wavenet_model(&model, CH_SLIM).unwrap();

    assert_eq!(sliced.ch, CH_SLIM);
    assert_eq!(sliced.head, CH_SLIM);
    assert_eq!(sliced.k, TEST_KERNEL);
    assert_eq!(sliced.head_scale, 0.02);
    assert_eq!(sliced.arrays.len(), 2);

    assert_eq!(sliced.arrays[0].ch, CH_SLIM);
    assert_eq!(sliced.arrays[0].in_ch, 1);
    assert_eq!(sliced.arrays[1].ch, CH_SLIM);
    assert_eq!(sliced.arrays[1].in_ch, CH_SLIM);
    assert_eq!(sliced.arrays[0].effective_layers, 3);
    assert_eq!(sliced.arrays[1].effective_layers, 3);
}

#[test]
fn test_slice_wavenet_model_through_method() {
    let model = make_full_model(CH_FULL, CH_SLIM);
    let sliced = model.slice_channels(CH_SLIM).unwrap();
    assert_eq!(sliced.ch, CH_SLIM);
    assert_eq!(sliced.arrays.len(), 2);
    assert_eq!(sliced.arrays[0].ch, CH_SLIM);
    assert_eq!(sliced.arrays[1].ch, CH_SLIM);
}

#[test]
fn test_slice_wavenet_model_preserves_inference_shape() {
    let mut model = make_full_model(CH_FULL, CH_SLIM);
    let sliced = slice_wavenet_model(&model, CH_SLIM).unwrap();

    model.prewarm();

    let input = vec![0.5f32; 64];
    let mut output_full = vec![0.0f32; 64];
    let mut output_slim = vec![0.0f32; 64];

    model.process(&input, &mut output_full);

    let mut sliced_mut = sliced;
    sliced_mut.prewarm();
    sliced_mut.process(&input, &mut output_slim);

    assert_eq!(output_full.len(), output_slim.len());
}

#[test]
#[should_panic(expected = "slice_wavenet_model: new_ch must be > 0")]
fn test_slice_wavenet_model_zero_ch_panics() {
    let model = make_full_model(CH_FULL, CH_SLIM);
    slice_wavenet_model(&model, 0).unwrap();
}

#[test]
#[should_panic(expected = "slice_wavenet_model: new_ch")]
fn test_slice_wavenet_model_too_large_ch_panics() {
    let model = make_full_model(CH_FULL, CH_SLIM);
    slice_wavenet_model(&model, CH_FULL + 1).unwrap();
}

#[test]
fn test_slice_wavenet_model_arrays_different_ch() {
    let model = make_full_model(8, 4);
    let sliced = slice_wavenet_model(&model, 4).unwrap();
    assert_eq!(sliced.ch, 4);
    assert_eq!(sliced.arrays[0].ch, 4);
    assert_eq!(sliced.arrays[0].in_ch, 1);
    assert_eq!(sliced.arrays[1].ch, 4);
    assert_eq!(sliced.arrays[1].in_ch, 4);
}

#[test]
#[should_panic(expected = "exceeds minimum array channel count")]
fn test_slice_wavenet_model_exceeds_min_array_ch_panics() {
    let model = make_full_model(8, 4);
    slice_wavenet_model(&model, 5).unwrap();
}