dasp-rs 0.4.0

Pure-Rust digital audio signal processing: I/O, STFT/CQT, spectral & MIR features, pitch, and music/phonetics notation.
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
use ndarray::Array1;
use crate::utils::notation;

/// Converts frequencies in Hz to Western musical note names.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
///
/// # Returns
/// Returns a `Vec<String>` containing note names (e.g., "C4", "G#5").
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![261.63, 329.63];
/// let notes = hz_to_note(&freqs);
/// assert_eq!(notes, vec!["C4", "E4"]);
/// ```
pub fn hz_to_note(frequencies: &[f32]) -> Vec<String> {
    frequencies.iter().map(|&f| {
        let midi = hz_to_midi(&[f])[0];
        midi_to_note(&[midi], None)[0].clone()
    }).collect()
}

/// Converts frequencies in Hz to MIDI note numbers.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
///
/// # Returns
/// Returns a `Vec<f32>` containing MIDI note numbers (A4 = 440 Hz = MIDI 69).
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![440.0];
/// let midi = hz_to_midi(&freqs);
/// assert_eq!(midi, vec![69.0]);
/// ```
pub fn hz_to_midi(frequencies: &[f32]) -> Vec<f32> {
    frequencies.iter().map(|&f| 12.0 * (f / 440.0).log2() + 69.0).collect()
}

/// Converts frequencies in Hz to Hindustani svara notation.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `abbr` - Optional flag for abbreviated notation (defaults to false)
///
/// # Returns
/// Returns a `Vec<String>` containing Hindustani svara names (e.g., "S", "R1" or "Shadjam", "Shuddha Rishabham").
///
/// # Examples
/// ```no_run
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![261.63, 293.66];
/// let svaras = hz_to_svara_h(&freqs, 261.63, Some(true));
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn hz_to_svara_h(frequencies: &[f32], sa: f32, abbr: Option<bool>) -> Vec<String> {
    let abbr = abbr.unwrap_or(false);
    let midi_sa = hz_to_midi(&[sa])[0];
    let midi_notes = hz_to_midi(frequencies);
    let svara_names = if abbr {
        vec!["S", "R1", "R2", "G1", "G2", "M1", "M2", "P", "D1", "D2", "N1", "N2"]
    } else {
        vec!["Shadjam", "Shuddha Rishabham", "Chatushruti Rishabham",
             "Shuddha Gandharam", "Sadharana Gandharam", "Shuddha Madhyamam",
             "Prati Madhyamam", "Panchamam", "Shuddha Dhaivatam", "Chatushruti Dhaivatam",
             "Shuddha Nishadam", "Kaisiki Nishadam"]
    };
    midi_notes.iter().map(|&m| {
        let degree = ((m - midi_sa + 0.5).round() as i32 % 12 + 12) % 12;
        svara_names[degree as usize].to_string()
    }).collect()
}

/// Converts frequencies in Hz to Carnatic svara notation based on a melakarta raga.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `mela` - Optional melakarta raga index (1-72, defaults to 29, Dheerashankarabharanam)
///
/// # Returns
/// Returns a `Vec<String>` containing Carnatic svara names (e.g., "S", "R2").
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![261.63, 293.66];
/// let svaras = hz_to_svara_c(&freqs, 261.63, None);
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn hz_to_svara_c(frequencies: &[f32], sa: f32, mela: Option<usize>) -> Vec<String> {
    let mela = mela.unwrap_or(29);
    let degrees = notation::mela_to_degrees(mela);
    let midi_sa = hz_to_midi(&[sa])[0];
    let midi_notes = hz_to_midi(frequencies);
    midi_notes.iter().map(|&m| {
        let semitone = ((m - midi_sa + 0.5).round() as i32 % 12 + 12) % 12;
        let idx = degrees.iter().position(|&d| d == semitone as usize).unwrap_or(0);
        let (base, variant) = svara_parts(idx, degrees[idx]);
        format!("{base}{variant}")
    }).collect()
}

/// Maps a scale-degree position and chromatic degree to a Carnatic
/// (svara base, variant suffix) pair.
fn svara_parts(idx: usize, degree: usize) -> (&'static str, &'static str) {
    let base = match idx {
        1..=3 => "R", 4..=6 => "G", 7 => "M", 8 => "P", 9..=11 => "D", 12..=14 => "N", _ => "S",
    };
    let variant = match degree % 12 {
        1 | 5 | 8 => "1", 2 | 6 | 9 => "2", 3 | 7 | 10 => "3", _ => "",
    };
    (base, variant)
}

/// Converts frequencies in Hz to Functional Just System (FJS) notation.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
/// * `fmin` - Optional minimum frequency (defaults to 16.35 Hz, C0)
/// * `unison` - Optional unison interval ratio (defaults to 1.0)
///
/// # Returns
/// Returns a `Vec<String>` containing FJS note names (e.g., "C4 1/1").
///
/// # Examples
/// ```no_run
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![261.63];
/// let fjs = hz_to_fjs(&freqs).compute();
/// assert_eq!(fjs, vec!["C4 1/1"]);
/// ```
pub fn hz_to_fjs(frequencies: &[f32]) -> HzToFjsBuilder<'_> {
    HzToFjsBuilder { frequencies, fmin: 16.35, unison: 1.0 }
}

/// Builder for [`hz_to_fjs`].
#[derive(Debug, Clone)]
pub struct HzToFjsBuilder<'a> {
    frequencies: &'a [f32],
    fmin: f32,
    unison: f32,
}

impl HzToFjsBuilder<'_> {
    /// Set the minimum reference frequency in Hz (default: 16.35, C0).
    #[must_use]
    pub fn fmin(mut self, fmin: f32) -> Self {
        self.fmin = fmin;
        self
    }

    /// Set the unison interval ratio (default: 1.0).
    #[must_use]
    pub fn unison(mut self, unison: f32) -> Self {
        self.unison = unison;
        self
    }

    /// Produce FJS note names.
    pub fn compute(self) -> Vec<String> {
        hz_to_fjs_impl(self.frequencies, self.fmin, self.unison)
    }
}

fn hz_to_fjs_impl(frequencies: &[f32], fmin: f32, unison: f32) -> Vec<String> {
    frequencies.iter().map(|&f| {
        let octaves = (f / fmin).log2().floor();
        let interval = f / (fmin * 2.0f32.powf(octaves)) / unison;
        let ratio = notation::interval_to_fjs(interval, Some(1.0));
        format!("C{} {}", octaves as i32, ratio)
    }).collect()
}

/// Converts MIDI note numbers to frequencies in Hz.
///
/// # Arguments
/// * `notes` - Array of MIDI note numbers
///
/// # Returns
/// Returns a `Vec<f32>` containing frequencies in Hz (A4 = MIDI 69 = 440 Hz).
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let midi = vec![69.0];
/// let freqs = midi_to_hz(&midi);
/// assert_eq!(freqs, vec![440.0]);
/// ```
pub fn midi_to_hz(notes: &[f32]) -> Vec<f32> {
    notes.iter().map(|&n| 440.0 * 2.0f32.powf((n - 69.0) / 12.0)).collect()
}

/// Converts MIDI note numbers to Western musical note names.
///
/// # Arguments
/// * `midi` - Array of MIDI note numbers
/// * `octave` - Optional flag to include octave number (defaults to true)
///
/// # Returns
/// Returns a `Vec<String>` containing note names (e.g., "C4", "G#").
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let midi = vec![60.0, 61.0];
/// let notes = midi_to_note(&midi, None);
/// assert_eq!(notes, vec!["C4", "C#4"]);
/// ```
pub fn midi_to_note(midi: &[f32], octave: Option<bool>) -> Vec<String> {
    let note_names = ["C", "C#", "D", "D#", "E", "F", "F#", "G", "G#", "A", "A#", "B"];
    midi.iter().map(|&m| {
        let note_idx = (m.round() as usize) % 12;
        let oct = if octave.unwrap_or(true) { format!("{}", (m.round() as i32 - 12) / 12) } else { String::new() };
        format!("{}{}", note_names[note_idx], oct)
    }).collect()
}

/// Converts MIDI note numbers to Hindustani svara notation.
///
/// # Arguments
/// * `midi` - Array of MIDI note numbers
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `abbr` - Optional flag for abbreviated notation (defaults to false)
/// * `octave` - Optional flag to include octave number (defaults to false)
///
/// # Returns
/// Returns a `Vec<String>` containing Hindustani svara names with optional octave.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let midi = vec![60.0, 62.0];
/// let svaras = midi_to_svara_h(&midi, 261.63).abbr(true).compute();
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn midi_to_svara_h(midi: &[f32], sa: f32) -> MidiToSvaraHBuilder<'_> {
    MidiToSvaraHBuilder { midi, sa, abbr: false, octave: false }
}

/// Builder for [`midi_to_svara_h`].
#[derive(Debug, Clone)]
pub struct MidiToSvaraHBuilder<'a> {
    midi: &'a [f32],
    sa: f32,
    abbr: bool,
    octave: bool,
}

impl MidiToSvaraHBuilder<'_> {
    /// Use abbreviated svara names (default: false).
    #[must_use]
    pub fn abbr(mut self, abbr: bool) -> Self {
        self.abbr = abbr;
        self
    }

    /// Append octave numbers (default: false).
    #[must_use]
    pub fn octave(mut self, octave: bool) -> Self {
        self.octave = octave;
        self
    }

    /// Produce Hindustani svara names.
    pub fn compute(self) -> Vec<String> {
        midi_to_svara_h_impl(self.midi, self.sa, self.abbr, self.octave)
    }
}

fn midi_to_svara_h_impl(midi: &[f32], sa: f32, abbr: bool, octave: bool) -> Vec<String> {
    let midi_sa = hz_to_midi(&[sa])[0];
    let svara_names = if abbr {
        vec!["S", "R1", "R2", "G1", "G2", "M1", "M2", "P", "D1", "D2", "N1", "N2"]
    } else {
        vec!["Shadjam", "Shuddha Rishabham", "Chatushruti Rishabham",
             "Shuddha Gandharam", "Sadharana Gandharam", "Shuddha Madhyamam",
             "Prati Madhyamam", "Panchamam", "Shuddha Dhaivatam", "Chatushruti Dhaivatam",
             "Shuddha Nishadam", "Kaisiki Nishadam"]
    };
    midi.iter().map(|&m| {
        let degree = ((m - midi_sa + 0.5).round() as i32 % 12 + 12) % 12;
        let oct = if octave { format!("{}", (m - midi_sa).round() as i32 / 12) } else { String::new() };
        format!("{}{}", svara_names[degree as usize], oct)
    }).collect()
}

/// Converts MIDI note numbers to Carnatic svara notation based on a melakarta raga.
///
/// # Arguments
/// * `midi` - Array of MIDI note numbers
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `mela` - Optional melakarta raga index (1-72, defaults to 29)
/// * `abbr` - Optional flag for abbreviated notation (defaults to false)
///
/// # Returns
/// Returns a `Vec<String>` containing Carnatic svara names.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let midi = vec![60.0, 62.0];
/// let svaras = midi_to_svara_c(&midi, 261.63).abbr(true).compute();
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn midi_to_svara_c(midi: &[f32], sa: f32) -> MidiToSvaraCBuilder<'_> {
    MidiToSvaraCBuilder { midi, sa, mela: 29, abbr: false }
}

/// Builder for [`midi_to_svara_c`].
#[derive(Debug, Clone)]
pub struct MidiToSvaraCBuilder<'a> {
    midi: &'a [f32],
    sa: f32,
    mela: usize,
    abbr: bool,
}

impl MidiToSvaraCBuilder<'_> {
    /// Set the melakarta raga index (default: 29).
    #[must_use]
    pub fn mela(mut self, mela: usize) -> Self {
        self.mela = mela;
        self
    }

    /// Use abbreviated svara names (default: false).
    #[must_use]
    pub fn abbr(mut self, abbr: bool) -> Self {
        self.abbr = abbr;
        self
    }

    /// Produce Carnatic svara names.
    pub fn compute(self) -> Vec<String> {
        midi_to_svara_c_impl(self.midi, self.sa, self.mela, self.abbr)
    }
}

fn midi_to_svara_c_impl(midi: &[f32], sa: f32, mela: usize, abbr: bool) -> Vec<String> {
    let degrees = notation::mela_to_degrees(mela);
    let midi_sa = hz_to_midi(&[sa])[0];
    midi.iter().map(|&m| {
        let semitone = ((m - midi_sa + 0.5).round() as i32 % 12 + 12) % 12;
        let idx = degrees.iter().position(|&d| d == semitone as usize).unwrap_or(0);
        let (base, variant) = svara_parts(idx, degrees[idx]);
        if abbr { format!("{base}{variant}") } else { notation::mela_to_svara(mela).compute()[idx].clone() }
    }).collect()
}

/// Converts note names to frequencies in Hz.
///
/// # Arguments
/// * `note` - Array of note names (e.g., "C4", "G#5")
///
/// # Returns
/// Returns a `Vec<f32>` containing frequencies in Hz.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let notes = vec!["C4", "E4"];
/// let freqs = note_to_hz(&notes);
/// assert!(freqs[0] > 261.0 && freqs[0] < 262.0);
/// ```
pub fn note_to_hz(note: &[&str]) -> Vec<f32> {
    note.iter().map(|&n| {
        let midi = note_to_midi(&[n], None)[0];
        midi_to_hz(&[midi])[0]
    }).collect()
}

/// Converts note names to MIDI note numbers.
///
/// # Arguments
/// * `note` - Array of note names (e.g., "C4", "G#5")
/// * `round_midi` - Optional flag to round MIDI numbers (defaults to true)
///
/// # Returns
/// Returns a `Vec<f32>` containing MIDI note numbers.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let notes = vec!["C4", "C#4"];
/// let midi = note_to_midi(&notes, None);
/// assert_eq!(midi, vec![60.0, 61.0]);
/// ```
pub fn note_to_midi(note: &[&str], round_midi: Option<bool>) -> Vec<f32> {
    let note_map = [("C", 0), ("C#", 1), ("Db", 1), ("D", 2), ("D#", 3), ("Eb", 3), ("E", 4), ("F", 5), ("F#", 6), ("Gb", 6), ("G", 7), ("G#", 8), ("Ab", 8), ("A", 9), ("A#", 10), ("Bb", 10), ("B", 11)];
    note.iter().map(|&n| {
        let (note_part, octave_part) = n.split_at(n.find(|c: char| c.is_ascii_digit()).unwrap_or(n.len()));
        let note_val = note_map.iter().find(|&&(name, _)| name == note_part).map_or(0, |&(_, val)| val) as f32;
        let octave = octave_part.parse::<i32>().unwrap_or(4);
        let midi = note_val + (octave + 1) as f32 * 12.0;
        if round_midi.unwrap_or(true) { midi.round() } else { midi }
    }).collect()
}

/// Converts note names to Hindustani svara notation.
///
/// # Arguments
/// * `notes` - Array of note names (e.g., "C4", "D4")
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `abbr` - Optional flag for abbreviated notation (defaults to false)
///
/// # Returns
/// Returns a `Vec<String>` containing Hindustani svara names.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let notes = vec!["C4", "D4"];
/// let svaras = note_to_svara_h(&notes, 261.63, Some(true));
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn note_to_svara_h(notes: &[&str], sa: f32, abbr: Option<bool>) -> Vec<String> {
    let midi = note_to_midi(notes, Some(true));
    hz_to_svara_h(&midi_to_hz(&midi), sa, abbr)
}

/// Converts note names to Carnatic svara notation.
///
/// # Arguments
/// * `notes` - Array of note names (e.g., "C4", "D4")
/// * `Sa` - Frequency of the tonic (Sa) in Hz
/// * `mela` - Optional melakarta raga index (1-72, defaults to 29)
/// * `abbr` - Optional flag for abbreviated notation (defaults to false)
///
/// # Returns
/// Returns a `Vec<String>` containing Carnatic svara names.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let notes = vec!["C4", "D4"];
/// let svaras = note_to_svara_c(&notes, 261.63, None);
/// assert_eq!(svaras, vec!["S", "R2"]);
/// ```
pub fn note_to_svara_c(notes: &[&str], sa: f32, mela: Option<usize>) -> Vec<String> {
    let midi = note_to_midi(notes, Some(true));
    hz_to_svara_c(&midi_to_hz(&midi), sa, mela)
}

/// Converts frequencies in Hz to mel scale.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
/// * `htk` - Optional flag for HTK formula (defaults to false)
///
/// # Returns
/// Returns a `Vec<f32>` containing mel values.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![440.0];
/// let mels = hz_to_mel(&freqs, None);
/// ```
pub fn hz_to_mel(frequencies: &[f32], htk: Option<bool>) -> Vec<f32> {
    if htk.unwrap_or(false) {
        frequencies.iter().map(|&f| 2595.0 * (1.0 + f / 700.0).log10()).collect()
    } else {
        frequencies.iter().map(|&f| 1125.0 * (1.0 + f / 700.0).ln()).collect()
    }
}

/// Converts frequencies in Hz to octave numbers.
///
/// # Arguments
/// * `frequencies` - Array of frequencies in Hz
/// * `tuning` - Optional tuning adjustment in semitones (defaults to 0.0)
///
/// # Returns
/// Returns a `Vec<f32>` containing octave numbers (A4 = 440 Hz = octave 4).
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = vec![440.0];
/// let octs = hz_to_octs(&freqs, None);
/// assert_eq!(octs, vec![4.0]);
/// ```
pub fn hz_to_octs(frequencies: &[f32], tuning: Option<f32>) -> Vec<f32> {
    let tune = tuning.unwrap_or(0.0);
    frequencies.iter().map(|&f| (f / (440.0 * 2.0f32.powf(tune / 12.0))).log2() + 4.0).collect()
}

/// Converts mel values to frequencies in Hz.
///
/// # Arguments
/// * `mels` - Array of mel values
/// * `htk` - Optional flag for HTK formula (defaults to false)
///
/// # Returns
/// Returns a `Vec<f32>` containing frequencies in Hz.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let mels = vec![1125.0];
/// let freqs = mel_to_hz(&mels, None);
/// ```
pub fn mel_to_hz(mels: &[f32], htk: Option<bool>) -> Vec<f32> {
    if htk.unwrap_or(false) {
        mels.iter().map(|&m| 700.0 * (10.0f32.powf(m / 2595.0) - 1.0)).collect()
    } else {
        mels.iter().map(|&m| 700.0 * (m / 1125.0).exp() - 700.0).collect()
    }
}

/// Converts octave numbers to frequencies in Hz.
///
/// # Arguments
/// * `octs` - Array of octave numbers
/// * `tuning` - Optional tuning adjustment in semitones (defaults to 0.0)
/// * `_bins_per_octave` - Optional bins per octave (unused, defaults to None)
///
/// # Returns
/// Returns a `Vec<f32>` containing frequencies in Hz.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let octs = vec![4.0];
/// let freqs = octs_to_hz(&octs, None);
/// assert_eq!(freqs, vec![440.0]);
/// ```
pub fn octs_to_hz(octs: &[f32], tuning: Option<f32>) -> Vec<f32> {
    let tune = tuning.unwrap_or(0.0);
    octs.iter().map(|&o| 440.0 * 2.0f32.powf(o - 4.0 + tune / 12.0)).collect()
}

/// Converts an A4 frequency to a tuning offset in semitones.
///
/// # Arguments
/// * `A4` - Frequency of A4 in Hz
/// * `_bins_per_octave` - Optional bins per octave (unused, defaults to None)
///
/// # Returns
/// Returns a `f32` representing the tuning offset from 440 Hz in semitones.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let tuning = a4_to_tuning(432.0);
/// assert!(tuning < 0.0);
/// ```
pub fn a4_to_tuning(a4: f32) -> f32 {
    12.0 * (a4 / 440.0).log2()
}

/// Converts a tuning offset in semitones to an A4 frequency.
///
/// # Arguments
/// * `tuning` - Tuning offset in semitones
/// * `_bins_per_octave` - Optional bins per octave (unused, defaults to None)
///
/// # Returns
/// Returns a `f32` representing the A4 frequency in Hz.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let a4 = tuning_to_a4(-0.317667);
/// assert!(a4 > 431.0 && a4 < 433.0);
/// ```
pub fn tuning_to_a4(tuning: f32) -> f32 {
    440.0 * 2.0f32.powf(tuning / 12.0)
}

/// Generates FFT frequency bins.
///
/// # Arguments
/// * `sr` - Optional sample rate in Hz (defaults to 44100)
/// * `n_fft` - Optional FFT size (defaults to 2048)
///
/// # Returns
/// Returns a `Vec<f32>` containing frequency bins from 0 to Nyquist (sr/2).
///
/// # Examples
/// ```
/// use dasp_rs::util::fft_frequencies;
/// let freqs = fft_frequencies().n_fft(4).compute();
/// assert_eq!(freqs, vec![0.0, 11025.0, 22050.0]);
/// ```
pub fn fft_frequencies() -> FftFrequenciesBuilder {
    FftFrequenciesBuilder { sr: 44100, n_fft: 2048 }
}

/// Builder for [`fft_frequencies`].
#[derive(Debug, Clone)]
pub struct FftFrequenciesBuilder {
    sr: u32,
    n_fft: usize,
}

impl FftFrequenciesBuilder {
    /// Set the sample rate in Hz (default: 44100).
    #[must_use]
    pub fn sample_rate(mut self, sr: u32) -> Self {
        self.sr = sr;
        self
    }

    /// Set the FFT size (default: 2048).
    #[must_use]
    pub fn n_fft(mut self, n_fft: usize) -> Self {
        self.n_fft = n_fft;
        self
    }

    /// Produce the FFT bin frequencies (0 to Nyquist).
    pub fn compute(self) -> Vec<f32> {
        fft_frequencies_impl(self.sr, self.n_fft)
    }
}

pub(crate) fn fft_frequencies_impl(sr: u32, n_fft: usize) -> Vec<f32> {
    Array1::linspace(0.0, sr as f32 / 2.0, n_fft / 2 + 1).to_vec()
}

/// Generates Constant-Q Transform (CQT) frequency bins.
///
/// # Arguments
/// * `n_bins` - Number of frequency bins
/// * `fmin` - Optional minimum frequency in Hz (defaults to 32.70, C1)
///
/// # Returns
/// Returns a `Vec<f32>` containing CQT frequency bins.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = cqt_frequencies(3, None);
/// ```
pub fn cqt_frequencies(n_bins: usize, fmin: Option<f32>) -> Vec<f32> {
    let fmin = fmin.unwrap_or(32.70);
    let bins_per_octave = 12;
    (0..n_bins).map(|k| fmin * 2.0f32.powf(k as f32 / bins_per_octave as f32)).collect()
}

/// Generates mel-scale frequency bins.
///
/// # Arguments
/// * `n_mels` - Number of mel bins (default: 128)
/// * `fmin` - Minimum frequency in Hz (default: 0.0)
/// * `fmax` - Maximum frequency in Hz (default: 11025.0)
///
/// # Returns
/// Returns a `Vec<f32>` containing mel-scale frequency bins.
///
/// # Examples
/// ```
/// use dasp_rs::util::mel_frequencies;
/// let freqs = mel_frequencies().n_mels(3).compute();
/// ```
pub fn mel_frequencies() -> MelFrequenciesBuilder {
    MelFrequenciesBuilder { n_mels: 128, fmin: 0.0, fmax: 11025.0 }
}

/// Builder for [`mel_frequencies`].
#[derive(Debug, Clone)]
pub struct MelFrequenciesBuilder {
    n_mels: usize,
    fmin: f32,
    fmax: f32,
}

impl MelFrequenciesBuilder {
    /// Set the number of mel bins (default: 128).
    #[must_use]
    pub fn n_mels(mut self, n_mels: usize) -> Self {
        self.n_mels = n_mels;
        self
    }

    /// Set the minimum frequency in Hz (default: 0.0).
    #[must_use]
    pub fn fmin(mut self, fmin: f32) -> Self {
        self.fmin = fmin;
        self
    }

    /// Set the maximum frequency in Hz (default: 11025.0).
    #[must_use]
    pub fn fmax(mut self, fmax: f32) -> Self {
        self.fmax = fmax;
        self
    }

    /// Produce the mel-scale bin frequencies.
    pub fn compute(self) -> Vec<f32> {
        mel_frequencies_impl(self.n_mels, self.fmin, self.fmax)
    }
}

pub(crate) fn mel_frequencies_impl(n_mels: usize, fmin: f32, fmax: f32) -> Vec<f32> {
    let min_mel = hz_to_mel(&[fmin], None)[0];
    let max_mel = hz_to_mel(&[fmax], None)[0];
    let mel_steps = Array1::linspace(min_mel, max_mel, n_mels);
    mel_to_hz(&mel_steps.to_vec(), None)
}

/// Generates tempo-related frequency bins.
///
/// # Arguments
/// * `n_bins` - Number of frequency bins
/// * `hop_length` - Optional hop length in samples (defaults to 512)
/// * `sr` - Optional sample rate in Hz (defaults to 44100)
///
/// # Returns
/// Returns a `Vec<f32>` containing tempo frequencies in beats per minute (BPM).
///
/// # Examples
/// ```
/// use dasp_rs::util::tempo_frequencies;
/// let freqs = tempo_frequencies(3).compute();
/// ```
pub fn tempo_frequencies(n_bins: usize) -> TempoFrequenciesBuilder {
    TempoFrequenciesBuilder { n_bins, hop_length: 512, sr: 44100 }
}

/// Builder for [`tempo_frequencies`].
#[derive(Debug, Clone)]
pub struct TempoFrequenciesBuilder {
    n_bins: usize,
    hop_length: usize,
    sr: u32,
}

impl TempoFrequenciesBuilder {
    /// Set the hop length in samples (default: 512).
    #[must_use]
    pub fn hop_length(mut self, hop_length: usize) -> Self {
        self.hop_length = hop_length;
        self
    }

    /// Set the sample rate in Hz (default: 44100).
    #[must_use]
    pub fn sample_rate(mut self, sr: u32) -> Self {
        self.sr = sr;
        self
    }

    /// Produce the tempo bin frequencies in BPM.
    pub fn compute(self) -> Vec<f32> {
        tempo_frequencies_impl(self.n_bins, self.hop_length, self.sr)
    }
}

pub(crate) fn tempo_frequencies_impl(n_bins: usize, hop_length: usize, sr: u32) -> Vec<f32> {
    let frame_rate = sr as f32 / hop_length as f32;
    Array1::linspace(0.0, frame_rate / 2.0, n_bins).mapv(|f| f * 60.0).to_vec()
}

/// Generates Fourier tempo frequency bins.
///
/// # Arguments
/// * `sr` - Optional sample rate in Hz (defaults to 44100)
///
/// # Returns
/// Returns a `Vec<f32>` containing tempo frequencies in BPM with fixed parameters.
///
/// # Examples
/// ```
/// use dasp_rs::util::*;
/// use dasp_rs::types::*;
/// let freqs = fourier_tempo_frequencies(None);
/// ```
pub fn fourier_tempo_frequencies(sr: Option<u32>) -> Vec<f32> {
    let sr = sr.unwrap_or(44100);
    let hop_length = 512;
    let n_bins = 256;
    let frame_rate = sr as f32 / hop_length as f32;
    Array1::linspace(0.0, frame_rate / 2.0, n_bins).mapv(|f| f * 60.0).to_vec()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn approx_eq(a: f32, b: f32) -> bool {
        (a - b).abs() < 1e-4
    }

    #[test]
    fn midi_and_hz_conversions_round_trip() {
        let notes = vec![60.0, 69.0];
        let freqs = midi_to_hz(&notes);
        assert!(approx_eq(freqs[0], 261.62555));
        assert!(approx_eq(freqs[1], 440.0));
        let back = hz_to_midi(&freqs);
        assert!(approx_eq(back[0], 60.0));
        assert!(approx_eq(back[1], 69.0));
    }

    #[test]
    fn note_name_conversions_match_expectations() {
        let midi = vec![60.0, 61.0, 72.0];
        let names = midi_to_note(&midi, None);
        assert_eq!(names, vec!["C4", "C#4", "C5"]);

        let back = note_to_midi(&["C4", "C#4", "C5"], None);
        assert_eq!(back, midi);

        let freqs = note_to_hz(&["A4", "C5"]);
        assert!(approx_eq(freqs[0], 440.0));
        assert!(freqs[1] > 520.0 && freqs[1] < 525.0);
    }

    #[test]
    fn mel_and_hz_conversions_are_inverse() {
        let hz = vec![0.0, 440.0, 22050.0];
        let mels = hz_to_mel(&hz, None);
        let back = mel_to_hz(&mels, None);
        for (orig, recon) in hz.iter().zip(back.iter()) {
            let tol = 1e-4 * orig.abs().max(1.0);
            assert!((orig - recon).abs() <= tol);
        }
    }

    #[test]
    fn cqt_and_fft_frequencies_generate_expected_bins() {
        let cqt = cqt_frequencies(3, Some(32.7));
        assert_eq!(cqt.len(), 3);
        assert!(approx_eq(cqt[0], 32.7));
        assert!(cqt[1] > cqt[0]);

        let fft = fft_frequencies_impl(44_100, 4);
        assert_eq!(fft, vec![0.0, 11_025.0, 22_050.0]);
    }

    #[test]
    fn tempo_and_fourier_bins_have_expected_scale() {
        let tempo = tempo_frequencies_impl(3, 512, 44_100);
        assert_eq!(tempo.len(), 3);
        assert!(approx_eq(tempo[0], 0.0));
        assert!(tempo[2] > tempo[1]);

        let fourier = fourier_tempo_frequencies(Some(44_100));
        assert_eq!(fourier.len(), 256);
        assert!(fourier.first().unwrap().abs() < 1e-6);
        // Last bin is the frame-rate Nyquist in BPM: (44100/512)/2 * 60 ≈ 2584.
        assert!(fourier.last().unwrap() > &2500.0);
    }

    #[test]
    fn tuning_and_octave_conversions_match() {
        let tuning = a4_to_tuning(432.0);
        assert!(tuning < 0.0);
        let a4 = tuning_to_a4(tuning);
        assert!(approx_eq(a4, 432.0));

        let octs = hz_to_octs(&[440.0], None);
        assert!(approx_eq(octs[0], 4.0));
        let freqs = octs_to_hz(&octs, None);
        assert!(approx_eq(freqs[0], 440.0));
    }
}