qualia_audio/features/tonal/
chord.rs1use crate::types::AudioError;
16
17#[derive(Debug, Clone, Copy, PartialEq, Eq)]
19pub enum ChordQuality {
20 Major,
21 Minor,
22 Diminished,
23}
24
25#[derive(Debug, Clone, Copy, PartialEq)]
27pub struct ChordEstimate {
28 pub root_pc: u8,
30 pub quality: ChordQuality,
31 pub score: f32,
33}
34
35const TEMPLATES: [(ChordQuality, usize, usize); 3] = [
37 (ChordQuality::Major, 4, 7),
38 (ChordQuality::Minor, 3, 7),
39 (ChordQuality::Diminished, 3, 6),
40];
41
42pub fn estimate_chord(
51 hpcp: &[f32],
52 assumes_12tet: bool,
53 min_score: f32,
54) -> Result<Option<ChordEstimate>, AudioError> {
55 if hpcp.is_empty() {
56 return Err(AudioError::InvalidParameter);
57 }
58 if !assumes_12tet || hpcp.len() < 12 {
59 return Ok(None);
60 }
61 let frame = &hpcp[..12];
62
63 let total: f32 = frame.iter().map(|v| v.max(0.0)).sum();
64 if total <= 0.0 {
65 return Ok(None);
66 }
67
68 let mut best = ChordEstimate {
69 root_pc: 0,
70 quality: ChordQuality::Major,
71 score: 0.0,
72 };
73 for root in 0usize..12 {
74 for (quality, third, fifth) in TEMPLATES {
75 let e = frame[root].max(0.0)
76 + frame[(root + third) % 12].max(0.0)
77 + frame[(root + fifth) % 12].max(0.0);
78 let score = e / total;
79 if score > best.score {
80 best = ChordEstimate {
81 root_pc: root as u8,
82 quality,
83 score,
84 };
85 }
86 }
87 }
88
89 if best.score < min_score {
90 Ok(None) } else {
92 Ok(Some(best))
93 }
94}
95
96#[cfg(test)]
97mod tests {
98 use super::*;
99
100 #[test]
102 fn c_e_g_is_c_major() {
103 let mut hpcp = [0.0f32; 12];
104 hpcp[0] = 1.0; hpcp[4] = 1.0; hpcp[7] = 1.0; let est = estimate_chord(&hpcp, true, 0.8)
108 .expect("chord")
109 .expect("some chord");
110 assert_eq!(est.root_pc, 0);
111 assert_eq!(est.quality, ChordQuality::Major);
112 assert!(est.score > 0.99, "score = {}", est.score);
113 }
114
115 #[test]
117 fn a_c_e_is_a_minor() {
118 let mut hpcp = [0.0f32; 12];
119 hpcp[9] = 1.0; hpcp[0] = 1.0; hpcp[4] = 1.0; let est = estimate_chord(&hpcp, true, 0.8)
123 .expect("chord")
124 .expect("some chord");
125 assert_eq!(est.root_pc, 9);
126 assert_eq!(est.quality, ChordQuality::Minor);
127 }
128
129 #[test]
131 fn b_d_f_is_b_diminished() {
132 let mut hpcp = [0.0f32; 12];
133 hpcp[11] = 1.0; hpcp[2] = 1.0; hpcp[5] = 1.0; let est = estimate_chord(&hpcp, true, 0.8)
137 .expect("chord")
138 .expect("some chord");
139 assert_eq!(est.root_pc, 11);
140 assert_eq!(est.quality, ChordQuality::Diminished);
141 }
142
143 #[test]
145 fn flat_abstains() {
146 let hpcp = [1.0f32; 12];
147 assert!(estimate_chord(&hpcp, true, 0.8).expect("chord").is_none());
148 }
149
150 #[test]
152 fn non_12tet_abstains() {
153 let mut hpcp = [0.0f32; 12];
154 hpcp[0] = 1.0;
155 hpcp[4] = 1.0;
156 hpcp[7] = 1.0;
157 assert!(estimate_chord(&hpcp, false, 0.8).expect("chord").is_none());
158 }
159
160 #[test]
161 fn rejects_empty() {
162 assert_eq!(
163 estimate_chord(&[], true, 0.8),
164 Err(AudioError::InvalidParameter)
165 );
166 }
167}