spectrs 0.2.1

Fast spectrogram creation library
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
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
mod common;

use anyhow::Result;
use common::{cleanup_test_dir, create_complex_test_wav, create_test_wav, setup_test_dir};
use spectrs::io::audio::read_audio_file_mono;
use spectrs::spectrogram::mel::{MelScale, convert_to_mel, par_convert_to_mel};
use spectrs::spectrogram::stft::{SpectrogramType, par_compute_spectrogram};

#[test]
fn test_convert_to_mel_basic() -> Result<()> {
    // Create a simple spectrogram
    let sr = 16000;
    let duration = 1.0;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    // Convert to mel
    let n_mels = 40;
    let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Check dimensions
    assert_eq!(mel_spec.len(), n_mels);
    assert_eq!(mel_spec[0].len(), spec[0].len());

    // Check that values are non-negative
    for mel_bin in &mel_spec {
        for &value in mel_bin {
            assert!(value >= 0.0);
        }
    }

    Ok(())
}

#[test]
fn test_convert_to_mel_htk_vs_slaney() -> Result<()> {
    let sr = 16000;
    let duration = 0.5;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    let n_mels = 40;

    // Convert using HTK
    let mel_spec_htk = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Convert using Slaney
    let mel_spec_slaney = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::Slaney);

    // Both should have same shape
    assert_eq!(mel_spec_htk.len(), mel_spec_slaney.len());
    assert_eq!(mel_spec_htk[0].len(), mel_spec_slaney[0].len());

    // Values should be different (different mel scales)
    let mut differences = 0;
    for i in 0..mel_spec_htk.len() {
        for j in 0..mel_spec_htk[0].len() {
            if (mel_spec_htk[i][j] - mel_spec_slaney[i][j]).abs() > 0.001 {
                differences += 1;
            }
        }
    }

    // Should have some differences
    assert!(differences > 0);

    Ok(())
}

#[test]
fn test_convert_to_mel_different_n_mels() -> Result<()> {
    let sr = 16000;
    let duration = 0.5;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    let n_mels_values = vec![20, 40, 80, 128];

    for n_mels in n_mels_values {
        let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

        // Check dimensions match
        assert_eq!(mel_spec.len(), n_mels);
        assert_eq!(mel_spec[0].len(), spec[0].len());
    }

    Ok(())
}

#[test]
fn test_convert_to_mel_with_frequency_range() -> Result<()> {
    let sr = 16000;
    let duration = 0.5;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    let n_mels = 40;

    // Default range (0 to Nyquist)
    let mel_spec_default = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Custom range (300 Hz to 4000 Hz)
    let f_min = 300.0;
    let f_max = 4000.0;
    let mel_spec_custom = convert_to_mel(
        &spec,
        sr,
        n_fft,
        n_mels,
        Some(f_min),
        Some(f_max),
        MelScale::HTK,
    );

    // Both should have same shape
    assert_eq!(mel_spec_default.len(), mel_spec_custom.len());
    assert_eq!(mel_spec_default[0].len(), mel_spec_custom[0].len());

    // Values should be different due to different frequency ranges
    let mut differences = 0;
    for i in 0..mel_spec_default.len() {
        for j in 0..mel_spec_default[0].len() {
            if (mel_spec_default[i][j] - mel_spec_custom[i][j]).abs() > 0.001 {
                differences += 1;
            }
        }
    }

    assert!(differences > 0);

    Ok(())
}

#[test]
fn test_convert_to_mel_from_file() -> Result<()> {
    let test_dir = setup_test_dir()?;
    let audio_path = test_dir.join("test_mel.wav");

    // Create test file
    create_test_wav(&audio_path, 1.0, 16000, 1, 16)?;

    // Read audio
    let (samples, sr) = read_audio_file_mono(&audio_path)?;

    // Compute spectrogram
    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    // Convert to mel
    let n_mels = 40;
    let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Verify dimensions
    assert_eq!(mel_spec.len(), n_mels);
    assert!(mel_spec[0].len() > 0);

    cleanup_test_dir(&test_dir)?;
    Ok(())
}

#[test]
fn test_convert_to_mel_complex_signal() -> Result<()> {
    let test_dir = setup_test_dir()?;
    let audio_path = test_dir.join("test_mel_complex.wav");

    // Create complex test file
    create_complex_test_wav(&audio_path, 1.0, 16000, 1, 16)?;

    // Read audio
    let (samples, sr) = read_audio_file_mono(&audio_path)?;

    // Compute spectrogram
    let n_fft = 1024;
    let hop_length = 256;
    let win_length = 512;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    // Convert to mel
    let n_mels = 80;
    let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Check that multiple mel bins have energy
    let mut bins_with_energy = 0;
    for mel_bin in &mel_spec {
        let max_value = mel_bin.iter().copied().fold(f32::NEG_INFINITY, f32::max);
        if max_value > 0.1 {
            bins_with_energy += 1;
        }
    }

    assert!(bins_with_energy > 5);

    cleanup_test_dir(&test_dir)?;
    Ok(())
}

#[test]
fn test_convert_to_mel_energy_conservation() -> Result<()> {
    // Test that mel conversion doesn't create energy out of nowhere
    let sr = 16000;
    let duration = 0.5;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    // Calculate total energy in original spectrogram
    let total_energy_orig: f32 = spec
        .iter()
        .map(|freq_bin| freq_bin.iter().sum::<f32>())
        .sum();

    // Convert to mel
    let n_mels = 40;
    let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

    // Calculate total energy in mel spectrogram
    let total_energy_mel: f32 = mel_spec
        .iter()
        .map(|mel_bin| mel_bin.iter().sum::<f32>())
        .sum();

    // Mel spectrogram should have similar total energy (within reasonable tolerance)
    // Note: Exact conservation depends on filter bank normalization
    assert!(total_energy_mel > 0.0);
    assert!(total_energy_orig > 0.0);

    Ok(())
}

#[test]
fn test_convert_to_mel_different_sample_rates() -> Result<()> {
    let test_dir = setup_test_dir()?;

    let sample_rates = vec![8000, 16000, 22050, 44100];

    for sr in sample_rates {
        let audio_path = test_dir.join(format!("test_mel_{}.wav", sr));
        create_test_wav(&audio_path, 0.5, sr, 1, 16)?;

        let (samples, read_sr) = read_audio_file_mono(&audio_path)?;
        assert_eq!(read_sr, sr);

        let n_fft = 512;
        let hop_length = 160;
        let win_length = 400;

        let spec = par_compute_spectrogram(
            &samples,
            n_fft,
            hop_length,
            win_length,
            false,
            SpectrogramType::Power,
        );

        let n_mels = 40;
        let mel_spec = convert_to_mel(&spec, sr, n_fft, n_mels, None, None, MelScale::HTK);

        // Verify it worked
        assert_eq!(mel_spec.len(), n_mels);
        assert!(mel_spec[0].len() > 0);
    }

    cleanup_test_dir(&test_dir)?;
    Ok(())
}

#[test]
fn test_convert_to_mel_magnitude_vs_power() -> Result<()> {
    let sr = 16000;
    let duration = 0.5;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    // Power spectrogram
    let spec_power = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    // Magnitude spectrogram
    let spec_magnitude = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Magnitude,
    );

    let n_mels = 40;

    // Convert both to mel
    let mel_spec_power = convert_to_mel(&spec_power, sr, n_fft, n_mels, None, None, MelScale::HTK);
    let mel_spec_magnitude = convert_to_mel(
        &spec_magnitude,
        sr,
        n_fft,
        n_mels,
        None,
        None,
        MelScale::HTK,
    );

    // Both should have same shape
    assert_eq!(mel_spec_power.len(), mel_spec_magnitude.len());
    assert_eq!(mel_spec_power[0].len(), mel_spec_magnitude[0].len());

    // Values should be different (power vs magnitude)
    let mut differences = 0;
    for i in 0..mel_spec_power.len() {
        for j in 0..mel_spec_power[0].len() {
            if (mel_spec_power[i][j] - mel_spec_magnitude[i][j]).abs() > 0.001 {
                differences += 1;
            }
        }
    }

    assert!(differences > 0);

    Ok(())
}

#[test]
fn test_convert_to_mel_vs_par_convert_to_mel() -> Result<()> {
    // Test that sequential and parallel versions produce identical results
    let sr = 22050;
    let duration = 2.0;
    let num_samples = (duration * sr as f32) as usize;

    // Create a complex signal with multiple frequencies
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| {
            let t_sec = t as f32 / sr as f32;
            (t_sec * 440.0 * 2.0 * std::f32::consts::PI).sin() * 0.5
                + (t_sec * 880.0 * 2.0 * std::f32::consts::PI).sin() * 0.3
                + (t_sec * 1320.0 * 2.0 * std::f32::consts::PI).sin() * 0.2
        })
        .collect();

    let n_fft = 2048;
    let hop_length = 512;
    let win_length = 2048;

    // Create spectrogram
    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        true,
        SpectrogramType::Power,
    );

    let n_mels = 128;
    let f_min = Some(0.0);
    let f_max = Some((sr / 2) as f32);

    // Test with both mel scales
    for mel_scale in [MelScale::Slaney, MelScale::HTK] {
        // Sequential version
        let mel_spec_seq = convert_to_mel(&spec, sr, n_fft, n_mels, f_min, f_max, mel_scale);

        // Parallel version
        let mel_spec_par = par_convert_to_mel(&spec, sr, n_fft, n_mels, f_min, f_max, mel_scale);

        // Verify dimensions match
        assert_eq!(mel_spec_seq.len(), mel_spec_par.len());
        assert_eq!(mel_spec_seq[0].len(), mel_spec_par[0].len());

        // Verify values are identical (allowing for small floating point errors)
        let tolerance = 1e-6;
        for i in 0..mel_spec_seq.len() {
            for j in 0..mel_spec_seq[0].len() {
                let diff = (mel_spec_seq[i][j] - mel_spec_par[i][j]).abs();
                assert!(
                    diff < tolerance,
                    "Mismatch at [{},{}] for {:?}: seq={}, par={}, diff={}",
                    i,
                    j,
                    mel_scale,
                    mel_spec_seq[i][j],
                    mel_spec_par[i][j],
                    diff
                );
            }
        }
    }

    Ok(())
}

#[test]
fn test_par_convert_to_mel_basic() -> Result<()> {
    // Test that par_convert_to_mel works correctly on a basic example
    let sr = 16000;
    let duration = 1.0;
    let num_samples = (duration * sr as f32) as usize;
    let samples: Vec<f32> = (0..num_samples)
        .map(|t| (t as f32 * 440.0 * 2.0 * std::f32::consts::PI / sr as f32).sin())
        .collect();

    let n_fft = 512;
    let hop_length = 160;
    let win_length = 400;

    let spec = par_compute_spectrogram(
        &samples,
        n_fft,
        hop_length,
        win_length,
        false,
        SpectrogramType::Power,
    );

    let mel_spec = par_convert_to_mel(
        &spec,
        sr,
        n_fft,
        40,
        Some(0.0),
        Some(8000.0),
        MelScale::Slaney,
    );

    // Check dimensions
    assert_eq!(mel_spec.len(), 40);
    assert!(mel_spec[0].len() > 0);

    // Check non-negativity
    for mel_bin in &mel_spec {
        for &value in mel_bin {
            assert!(
                value >= 0.0,
                "Mel spectrogram values should be non-negative"
            );
        }
    }

    // Check that some energy exists
    let total_energy: f32 = mel_spec.iter().flatten().sum();
    assert!(
        total_energy > 0.0,
        "Mel spectrogram should have some energy"
    );

    Ok(())
}