ptcrab 0.1.0

A pure-Rust alternative to the official pxtone 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

use std::ops::{Div, Mul};

//--------------------------------------------------------------------------------------------------

/// Volume ratio where a value of 128 = 100% volume.
#[derive(Clone, Copy, Debug, PartialEq)]
#[repr(transparent)]
pub struct Volume(i32);

impl Volume {
    /// Converts from volume ratio.
    pub fn approx_from_ratio(ratio: f32) -> Self {
        Self::from((128. * ratio) as i32)
    }

    /// Returns volume value as [`i32`].
    pub const fn as_value(&self) -> i32 {
        self.0
    }
    /// Returns volume as a ratio.
    pub fn as_ratio(&self) -> f32 {
        (self.0 as f32) / 128.
    }
}

impl From<i32> for Volume {
    fn from(value: i32) -> Self {
        Self(value)
    }
}

impl Default for Volume {
    fn default() -> Self {
        Self::from(128)
    }
}

impl Mul<f32> for Volume {
    type Output = Self;

    fn mul(self, rhs: f32) -> Self::Output {
        Self::approx_from_ratio(self.as_ratio() * rhs)
    }
}
impl Div<f32> for Volume {
    type Output = Self;

    fn div(self, rhs: f32) -> Self::Output {
        Self::approx_from_ratio(self.as_ratio() / rhs)
    }
}