audionimbus 0.14.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

#[cfg(feature = "bevy")]
use bevy::prelude::{GlobalTransform, Mat4};

/// A `ROWSxCOLS` matrix of type T elements.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct Matrix<T, const ROWS: usize, const COLS: usize> {
    /// Matrix elements, in row-major order.
    pub elements: [[T; COLS]; ROWS],
}

impl Matrix<f32, 3, 3> {
    pub const IDENTITY: Self = Self {
        elements: [[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]],
    };
}

impl Default for Matrix<f32, 3, 3> {
    fn default() -> Self {
        Self::IDENTITY
    }
}

impl Matrix<f32, 4, 4> {
    pub const IDENTITY: Self = Self {
        elements: [
            [1.0, 0.0, 0.0, 0.0],
            [0.0, 1.0, 0.0, 0.0],
            [0.0, 0.0, 1.0, 0.0],
            [0.0, 0.0, 0.0, 1.0],
        ],
    };
}

impl Default for Matrix<f32, 4, 4> {
    fn default() -> Self {
        Self::IDENTITY
    }
}

impl<T, const ROWS: usize, const COLS: usize> Matrix<T, ROWS, COLS> {
    /// Creates a new matrix.
    pub const fn new(elements: [[T; COLS]; ROWS]) -> Self {
        Self { elements }
    }
}

impl From<Matrix<f32, 4, 4>> for audionimbus_sys::IPLMatrix4x4 {
    fn from(matrix: Matrix<f32, 4, 4>) -> Self {
        Self {
            elements: matrix.elements,
        }
    }
}

impl From<&Matrix<f32, 4, 4>> for audionimbus_sys::IPLMatrix4x4 {
    fn from(matrix: &Matrix<f32, 4, 4>) -> Self {
        Self {
            elements: matrix.elements,
        }
    }
}

pub type Matrix3 = Matrix<f32, 3, 3>;
pub type Matrix4 = Matrix<f32, 4, 4>;

#[cfg(feature = "bevy")]
impl From<GlobalTransform> for Matrix4 {
    fn from(global_transform: GlobalTransform) -> Self {
        Self::from(global_transform.to_matrix())
    }
}

#[cfg(feature = "bevy")]
impl From<Mat4> for Matrix4 {
    fn from(matrix: Mat4) -> Self {
        Self::new(matrix.to_cols_array_2d())
    }
}

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

    #[test]
    fn test_matrix3x3_identity() {
        let m = Matrix::<f32, 3, 3>::IDENTITY;

        #[rustfmt::skip]
        assert_eq!(
            m,
            Matrix {
                elements: [
                    [1.0, 0.0, 0.0],
                    [0.0, 1.0, 0.0],
                    [0.0, 0.0, 1.0],
                ]
            }
        );
    }

    #[test]
    fn test_matrix4x4_identity() {
        let m = Matrix::<f32, 4, 4>::IDENTITY;

        #[rustfmt::skip]
        assert_eq!(
            m,
            Matrix {
                elements: [
                    [1.0, 0.0, 0.0, 0.0],
                    [0.0, 1.0, 0.0, 0.0],
                    [0.0, 0.0, 1.0, 0.0],
                    [0.0, 0.0, 0.0, 1.0],
                ]
            }
        );
    }

    #[test]
    fn test_matrix_new() {
        let elements = [[1.0, 2.0], [3.0, 4.0]];
        let m = Matrix::new(elements);

        #[rustfmt::skip]
        assert_eq!(
            m,
            Matrix {
                elements: [
                    [1.0, 2.0],
                    [3.0, 4.0],
                ]
            }
        );
    }

    #[test]
    fn test_matrix4x4_default() {
        let m = Matrix::<f32, 4, 4>::default();
        assert_eq!(m, Matrix::<f32, 4, 4>::IDENTITY);
    }
}