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

use super::{
    calc, hz_from_mel, letter_octave_from_mel, perc_from_mel, scaled_perc_from_mel, step_from_mel,
    Hz, Letter, LetterOctave, Octave, Perc, ScaleWeight, ScaledPerc, Step, DEFAULT_SCALE_WEIGHT,
};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
use std::ops::{Add, Div, Mul, Neg, Rem, Sub};

/// Mel value representation
///     - based on the Mel scale coined by Stevens, Volkmann and Newman in 1937.
#[derive(Debug, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Mel(pub calc::Mel);

impl Mel {
    /// Return the unit value of the Mel struct.
    #[inline]
    pub fn mel(self) -> calc::Mel {
        let Mel(mel) = self;
        mel
    }

    /// Convert to hz.
    #[inline]
    pub fn hz(self) -> calc::Hz {
        hz_from_mel(self.mel())
    }

    /// Convert to a Hz struct.
    #[inline]
    pub fn to_hz(self) -> Hz {
        Hz(self.hz())
    }

    /// Convert to (Letter, Octave) tuple.
    #[inline]
    pub fn letter_octave(self) -> (Letter, Octave) {
        letter_octave_from_mel(self.mel())
    }

    /// Convert to Letter.
    #[inline]
    pub fn letter(self) -> Letter {
        let (letter, _) = self.letter_octave();
        letter
    }

    /// Convert to Octave.
    #[inline]
    pub fn octave(self) -> Octave {
        let (_, octave) = self.letter_octave();
        octave
    }

    /// Convert to LetterOctave struct with the closest pitch.
    #[inline]
    pub fn to_letter_octave(self) -> LetterOctave {
        let (letter, octave) = self.letter_octave();
        LetterOctave(letter, octave)
    }

    /// Convert to a percentage of the human hearing range.
    #[inline]
    pub fn perc(self) -> calc::Perc {
        perc_from_mel(self.mel())
    }

    /// Convert to a Perc struct.
    #[inline]
    pub fn to_perc(self) -> Perc {
        Perc(self.perc())
    }

    /// Convert to a scaled percentage of the human hearing range with a given weight.
    #[inline]
    pub fn scaled_perc_with_weight(self, weight: ScaleWeight) -> calc::Perc {
        scaled_perc_from_mel(self.mel(), weight)
    }

    /// Convert to a scaled percentage of the human hearing range.
    #[inline]
    pub fn scaled_perc(self) -> calc::Perc {
        self.scaled_perc_with_weight(DEFAULT_SCALE_WEIGHT)
    }

    /// Convert to a scaled percentage of the human hearing range with a given weight.
    #[inline]
    pub fn to_scaled_perc_with_weight(self, weight: ScaleWeight) -> ScaledPerc {
        ScaledPerc(self.scaled_perc_with_weight(weight), weight)
    }

    /// Convert to a scaled percentage of the human hearing range.
    #[inline]
    pub fn to_scaled_perc(self) -> ScaledPerc {
        self.to_scaled_perc_with_weight(DEFAULT_SCALE_WEIGHT)
    }

    /// Convert to the unit value of a Step.
    #[inline]
    pub fn step(self) -> calc::Step {
        step_from_mel(self.mel())
    }

    /// Convert to a Step struct.
    #[inline]
    pub fn to_step(self) -> Step {
        Step(self.step())
    }
}

impl Add for Mel {
    type Output = Mel;
    #[inline]
    fn add(self, rhs: Mel) -> Mel {
        Mel(self.mel() + rhs.mel())
    }
}

impl Sub for Mel {
    type Output = Mel;
    #[inline]
    fn sub(self, rhs: Mel) -> Mel {
        Mel(self.mel() - rhs.mel())
    }
}

impl Mul for Mel {
    type Output = Mel;
    #[inline]
    fn mul(self, rhs: Mel) -> Mel {
        Mel(self.mel() * rhs.mel())
    }
}

impl Div for Mel {
    type Output = Mel;
    #[inline]
    fn div(self, rhs: Mel) -> Mel {
        Mel(self.mel() / rhs.mel())
    }
}

impl Rem for Mel {
    type Output = Mel;
    #[inline]
    fn rem(self, rhs: Mel) -> Mel {
        Mel(self.mel() % rhs.mel())
    }
}

impl Neg for Mel {
    type Output = Mel;
    #[inline]
    fn neg(self) -> Mel {
        Mel(-self.mel())
    }
}

impl PartialEq for Mel {
    #[inline]
    fn eq(&self, other: &Mel) -> bool {
        self.mel() == other.mel()
    }
}

impl Eq for Mel {}

impl PartialOrd for Mel {
    #[inline]
    fn partial_cmp(&self, other: &Mel) -> Option<Ordering> {
        self.mel().partial_cmp(&other.mel())
    }
}

impl Ord for Mel {
    #[inline]
    fn cmp(&self, other: &Mel) -> Ordering {
        self.partial_cmp(other).unwrap()
    }
}