audionimbus 0.13.0

A safe wrapper around Steam Audio that provides spatial audio capabilities with realistic occlusion, reverb, and HRTF effects, accounting for physical attributes and scene geometry.
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

/// The acoustic properties of a surface.
///
/// You can specify the acoustic material properties of each triangle, although typically many triangles will share a common material.
///
/// The acoustic material properties are specified for three frequency bands with center frequencies of 400 Hz, 2.5 KHz, and 15 KHz.
#[derive(Copy, Clone, PartialEq, Debug)]
pub struct Material {
    /// Fraction of sound energy absorbed at low, middle, high frequencies.
    ///
    /// Between 0.0 and 1.0.
    pub absorption: [f32; 3],

    /// Fraction of sound energy scattered in a random direction on reflection.
    ///
    /// Between 0.0 (pure specular) and 1.0 (pure diffuse).
    pub scattering: f32,

    /// Fraction of sound energy transmitted through at low, middle, high frequencies.
    ///
    /// Between 0.0 and 1.0. Only used for direct occlusion calculations.
    pub transmission: [f32; 3],
}

impl Default for Material {
    fn default() -> Self {
        Self::GENERIC
    }
}

impl Material {
    pub const GENERIC: Self = Self {
        absorption: [0.10, 0.20, 0.30],
        scattering: 0.05,
        transmission: [0.100, 0.050, 0.030],
    };

    pub const BRICK: Self = Self {
        absorption: [0.03, 0.04, 0.07],
        scattering: 0.05,
        transmission: [0.015, 0.015, 0.015],
    };

    pub const CONCRETE: Self = Self {
        absorption: [0.05, 0.07, 0.08],
        scattering: 0.05,
        transmission: [0.015, 0.002, 0.001],
    };

    pub const CERAMIC: Self = Self {
        absorption: [0.01, 0.02, 0.02],
        scattering: 0.05,
        transmission: [0.060, 0.044, 0.011],
    };

    pub const GRAVEL: Self = Self {
        absorption: [0.60, 0.70, 0.80],
        scattering: 0.05,
        transmission: [0.031, 0.012, 0.008],
    };

    pub const CARPET: Self = Self {
        absorption: [0.24, 0.69, 0.73],
        scattering: 0.05,
        transmission: [0.020, 0.005, 0.003],
    };

    pub const GLASS: Self = Self {
        absorption: [0.06, 0.03, 0.02],
        scattering: 0.05,
        transmission: [0.060, 0.044, 0.011],
    };

    pub const PLASTER: Self = Self {
        absorption: [0.12, 0.06, 0.04],
        scattering: 0.05,
        transmission: [0.056, 0.056, 0.004],
    };

    pub const WOOD: Self = Self {
        absorption: [0.11, 0.07, 0.06],
        scattering: 0.05,
        transmission: [0.070, 0.014, 0.005],
    };

    pub const METAL: Self = Self {
        absorption: [0.20, 0.07, 0.06],
        scattering: 0.05,
        transmission: [0.200, 0.025, 0.010],
    };

    pub const ROCK: Self = Self {
        absorption: [0.13, 0.20, 0.24],
        scattering: 0.05,
        transmission: [0.015, 0.002, 0.001],
    };
}

impl From<Material> for audionimbus_sys::IPLMaterial {
    fn from(material: Material) -> Self {
        Self {
            absorption: material.absorption,
            scattering: material.scattering,
            transmission: material.transmission,
        }
    }
}

impl From<&audionimbus_sys::IPLMaterial> for Material {
    fn from(material: &audionimbus_sys::IPLMaterial) -> Self {
        Self {
            absorption: material.absorption,
            scattering: material.scattering,
            transmission: material.transmission,
        }
    }
}

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

    #[test]
    fn test_material_default() {
        let m = Material::default();
        assert_eq!(m.absorption, Material::GENERIC.absorption);
        assert_eq!(m.scattering, Material::GENERIC.scattering);
        assert_eq!(m.transmission, Material::GENERIC.transmission);
    }

    #[test]
    fn test_all_material_presets_valid() {
        let materials = [
            Material::GENERIC,
            Material::BRICK,
            Material::CONCRETE,
            Material::CERAMIC,
            Material::GRAVEL,
            Material::CARPET,
            Material::GLASS,
            Material::PLASTER,
            Material::WOOD,
            Material::METAL,
            Material::ROCK,
        ];

        for material in materials {
            // Check absorption values are in range [0, 1].
            for &absorption in &material.absorption {
                assert!(
                    (0.0..=1.0).contains(&absorption),
                    "invalid absorption value: {}",
                    absorption
                );
            }

            // Check scattering is in range [0, 1].
            assert!(material.scattering >= 0.0 && material.scattering <= 1.0);

            // Check transmission values are in range [0, 1].
            for &transmission in &material.transmission {
                assert!(
                    (0.0..=1.0).contains(&transmission),
                    "invalid transmission value: {}",
                    transmission
                );
            }
        }
    }
}