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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2026 Fábio Henrique de Lima Silva (fhl.bsb@gmail.com) All rights reserved.

use super::*;

/// Scalar reference for `_cond_to_scale_shift` — computes
/// `scale_shift[o] = bias[o] + Σ weight[o*cond_sz + i] * cond[i]`.
fn cond_to_scale_shift_ref(
    weights: &[f32],
    bias: &[f32],
    condition: &[f32],
    channels: usize,
    cond_size: usize,
    shift: bool,
    groups: u32,
) -> Vec<f32> {
    let g = groups as usize;
    let ch_per_group = channels / g;
    let cond_per_group = cond_size / g;
    let out_per_group = if shift {
        ch_per_group * 2
    } else {
        ch_per_group
    };
    let mut out = vec![0.0f32; channels * 2];

    for grp in 0..g {
        let cond_slice = &condition[grp * cond_per_group..(grp + 1) * cond_per_group];
        let w_offset = grp * out_per_group * cond_per_group;

        for row in 0..out_per_group {
            let global_out = if row < ch_per_group {
                grp * ch_per_group + row
            } else {
                channels + grp * ch_per_group + (row - ch_per_group)
            };
            let mut sum = bias[global_out];
            let w_start = w_offset + row * cond_per_group;
            for i in 0..cond_per_group {
                sum += weights[w_start + i] * cond_slice[i];
            }
            out[global_out] = sum;
        }
    }
    out
}

/// Scalar reference for per-channel modulation.
fn apply_modulation_ref(input: &[f32], scale_shift: &[f32]) -> Vec<f32> {
    let ch = input.len();
    let scale = &scale_shift[..ch];
    let shift = &scale_shift[ch..ch * 2];
    input
        .iter()
        .enumerate()
        .map(|(c, &v)| v * scale[c] + shift[c])
        .collect()
}

#[test]
fn test_film_config_default() {
    let config = FiLMConfig::default();
    assert!(!config.active);
    assert!(config.shift);
    assert_eq!(config.groups, 1);
}

#[test]
fn test_film_config_custom() {
    let config = FiLMConfig {
        active: true,
        shift: false,
        groups: 4,
    };
    assert!(config.active);
    assert!(!config.shift);
    assert_eq!(config.groups, 4);
}

/// FiLM with `groups=1, shift=true` — identity scale + zero shift.
#[test]
fn test_film_process_identity_shift() {
    let cond_size = 4;
    let channels = 8;
    let config = FiLMConfig {
        active: true,
        shift: true,
        groups: 1,
    };

    // weights: 16 rows (8 scale + 8 shift) × 4 cond
    let mut weights = vec![0.0f32; channels * 2 * cond_size];
    // Set scale weights to produce scale[c] = 1.0 via identity mapping
    for c in 0..channels {
        weights[c * cond_size + (c % cond_size)] = 1.0;
    }
    let bias = vec![0.0f32; channels * 2];

    let mut layer = FiLMLayer::load(config, cond_size, channels, weights, bias).unwrap();

    // All-ones condition so every scale[c] = Σ weight[c, i] * 1.0 = 1.0
    let condition = vec![1.0f32; cond_size];
    let mut input = vec![2.0f32, 3.0, 5.0, 7.0, 11.0, 13.0, 17.0, 19.0];
    let expected_input = input.clone();

    unsafe { layer.process(&mut input, &condition) };

    // Identity scale (≈1.0) + zero shift → output ≈ input
    for c in 0..channels {
        assert!(
            (input[c] - expected_input[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected_input[c],
            input[c]
        );
    }
}

/// FiLM with `groups=1, shift=false` — scale-only.
#[test]
fn test_film_process_scale_only() {
    let cond_size = 3;
    let channels = 8;
    let config = FiLMConfig {
        active: true,
        shift: false,
        groups: 1,
    };

    // weights: 8 rows (scale only) × 3 cond
    let mut weights = vec![0.0f32; channels * cond_size];
    // Diagonal: scale[c] = condition[c % 3] * 2.0
    for c in 0..channels {
        weights[c * cond_size + (c % cond_size)] = 2.0;
    }
    let bias = vec![0.1f32; channels]; // small bias

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![0.5f32, 0.25, 0.125];
    let mut input = vec![1.0f32; channels];

    // Reference: scale = W * cond + b
    let ref_scale_shift =
        cond_to_scale_shift_ref(&weights, &bias, &condition, channels, cond_size, false, 1);
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}

/// FiLM with `groups=2, shift=true`.
#[test]
fn test_film_process_groups_shift() {
    let cond_size = 6;
    let channels = 8;
    let groups = 2u32;
    let config = FiLMConfig {
        active: true,
        shift: true,
        groups,
    };

    let g = groups as usize;
    let ch_per_group = channels / g;
    let cond_per_group = cond_size / g;
    let out_per_group = ch_per_group * 2; // shift=true → 2×

    // Build weights: group0 → inputs 0..3, group1 → inputs 3..6
    let total_w = g * out_per_group * cond_per_group;
    let mut weights = vec![0.0f32; total_w];
    let mut bias = vec![0.0f32; channels * 2];

    // Scale each group's output to be 2× its condition slice
    for grp in 0..g {
        let w_offset = grp * out_per_group * cond_per_group;
        for row in 0..out_per_group {
            let w_start = w_offset + row * cond_per_group;
            for ic in 0..cond_per_group {
                weights[w_start + ic] = 2.0;
            }
            let global_out = if row < ch_per_group {
                grp * ch_per_group + row
            } else {
                channels + grp * ch_per_group + (row - ch_per_group)
            };
            bias[global_out] = 0.5;
        }
    }

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![1.0f32, 2.0, 3.0, 4.0, 5.0, 6.0];
    let mut input = vec![0.5f32; channels];

    let ref_scale_shift = cond_to_scale_shift_ref(
        &weights, &bias, &condition, channels, cond_size, true, groups,
    );
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-4,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}

/// FiLM with odd channel count (3, A2-nano).
#[test]
fn test_film_process_odd_channels() {
    let cond_size = 3;
    let channels = 3;
    let config = FiLMConfig {
        active: true,
        shift: true,
        groups: 1,
    };

    let mut weights = vec![0.0f32; channels * 2 * cond_size];
    // Group 0: scale = cond[0] * 2, shift = cond[0] * 0.1
    for c in 0..channels {
        weights[c * cond_size + (c % cond_size)] = 2.0;
        weights[(channels + c) * cond_size + (c % cond_size)] = 0.1;
    }
    let bias = vec![0.0f32; channels * 2];

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![0.5f32, 0.25, 0.125];
    let mut input = vec![0.5f32, 1.0, 1.5];

    let ref_scale_shift =
        cond_to_scale_shift_ref(&weights, &bias, &condition, channels, cond_size, true, 1);
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}

/// Verify `scale_shift_buf` is zeroed in the shift region when
/// `shift == false`, so the modulation step produces correct results.
#[test]
fn test_film_shift_buffer_zeroed_when_shift_false() {
    let cond_size = 2;
    let channels = 4;
    let config = FiLMConfig {
        active: true,
        shift: false,
        groups: 1,
    };

    let weights = vec![1.0f32; channels * cond_size];
    let bias = vec![0.0f32; channels];

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![2.0f32, 3.0];
    let mut input = vec![1.0f32; channels];

    // Pre-fill shift region with garbage to ensure it gets zeroed
    for c in channels..channels * 2 {
        // SAFETY: buffer is pre-allocated via load()
        layer.scale_shift_buf[c] = 999.0;
    }

    unsafe { layer.process(&mut input, &condition) };

    // Shift region must be zero
    for c in channels..channels * 2 {
        assert_eq!(layer.scale_shift_buf[c], 0.0);
    }
}

/// F10 regression: FiLM with cond_size=2 (> 1) and groups=1, shift=true.
/// Exercises the debug_assert guard added in E1.2 with properly sized condition.
#[test]
fn test_film_process_cond_size_greater_than_1() {
    let cond_size = 2;
    let channels = 4;
    let config = FiLMConfig {
        active: true,
        shift: true,
        groups: 1,
    };

    let mut weights = vec![0.0f32; channels * 2 * cond_size];
    for c in 0..channels {
        weights[c * cond_size + (c % cond_size)] = 1.0;
        weights[(channels + c) * cond_size + (c % cond_size)] = 0.5;
    }
    let bias = vec![0.0f32; channels * 2];

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![0.25f32, 0.75];
    let mut input = vec![1.0f32, 2.0, 3.0, 4.0];

    let ref_scale_shift =
        cond_to_scale_shift_ref(&weights, &bias, &condition, channels, cond_size, true, 1);
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}

/// F10 regression: FiLM with cond_size=2 (> 1) and groups=2, shift=true.
/// Exercises group-based indexing in cond_to_scale_shift with cond_size > 1.
#[test]
fn test_film_process_cond_size_2_groups_2() {
    let cond_size = 2;
    let channels = 4;
    let groups = 2u32;
    let config = FiLMConfig {
        active: true,
        shift: true,
        groups,
    };

    let g = groups as usize;
    let ch_per_group = channels / g;
    let cond_per_group = cond_size / g;
    let out_per_group = ch_per_group * 2;
    let total_w = g * out_per_group * cond_per_group;

    let mut weights = vec![0.0f32; total_w];
    let mut bias = vec![0.0f32; channels * 2];

    for grp in 0..g {
        let w_offset = grp * out_per_group * cond_per_group;
        for row in 0..out_per_group {
            let w_start = w_offset + row * cond_per_group;
            for ic in 0..cond_per_group {
                weights[w_start + ic] = 1.5;
            }
            let global_out = if row < ch_per_group {
                grp * ch_per_group + row
            } else {
                channels + grp * ch_per_group + (row - ch_per_group)
            };
            bias[global_out] = 0.1;
        }
    }

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![0.5f32, 0.5];
    let mut input = vec![1.0f32; channels];

    let ref_scale_shift = cond_to_scale_shift_ref(
        &weights, &bias, &condition, channels, cond_size, true, groups,
    );
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}

/// F10 regression: FiLM with cond_size=4, groups=4, shift=false (scale-only).
/// Exercises cond_per_group = 1 with cond_size > 1.
#[test]
fn test_film_process_cond_size_4_groups_4_scale_only() {
    let cond_size = 4;
    let channels = 4;
    let groups = 4u32;
    let config = FiLMConfig {
        active: true,
        shift: false,
        groups,
    };

    let g = groups as usize;
    let ch_per_group = channels / g;
    let cond_per_group = cond_size / g;
    let out_per_group = ch_per_group;
    let total_w = g * out_per_group * cond_per_group;

    let mut weights = vec![0.0f32; total_w];
    let mut bias = vec![0.0f32; channels];

    for grp in 0..g {
        let w_offset = grp * out_per_group * cond_per_group;
        for row in 0..out_per_group {
            let w_start = w_offset + row * cond_per_group;
            for ic in 0..cond_per_group {
                weights[w_start + ic] = 2.0;
            }
            let global_out = grp * ch_per_group + row;
            bias[global_out] = 0.5;
        }
    }

    let mut layer =
        FiLMLayer::load(config, cond_size, channels, weights.clone(), bias.clone()).unwrap();

    let condition = vec![0.1f32, 0.2, 0.3, 0.4];
    let mut input = vec![1.0f32; channels];

    let ref_scale_shift = cond_to_scale_shift_ref(
        &weights, &bias, &condition, channels, cond_size, false, groups,
    );
    let expected = apply_modulation_ref(&input, &ref_scale_shift);

    unsafe { layer.process(&mut input, &condition) };

    // Shift region must be zero when shift=false
    for c in channels..channels * 2 {
        assert_eq!(layer.scale_shift_buf[c], 0.0);
    }

    for c in 0..channels {
        assert!(
            (input[c] - expected[c]).abs() < 1e-5,
            "channel {}: expected {}, got {}",
            c,
            expected[c],
            input[c]
        );
    }
}