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

use crate::ChannelRequirement;

/// Errors that can occur when applying audio effects.
#[derive(Debug, PartialEq, Eq)]
pub enum EffectError {
    /// Input buffer has wrong number of channels.
    InvalidInputChannels {
        expected: ChannelRequirement,
        actual: u32,
    },

    /// Output buffer has wrong number of channels.
    InvalidOutputChannels {
        expected: ChannelRequirement,
        actual: u32,
    },
}

impl std::error::Error for EffectError {}

impl std::fmt::Display for EffectError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Self::InvalidInputChannels { expected, actual } => {
                write!(
                    f,
                    "invalid number of input channels: expected {expected}, got {actual}",
                )
            }
            Self::InvalidOutputChannels { expected, actual } => {
                write!(
                    f,
                    "invalid number of output channels: expected {expected}, got {actual}",
                )
            }
        }
    }
}

/// Error returned when the requested number of channels exceeds the maximum set during effect creation.
#[derive(Debug, Clone, PartialEq)]
pub struct NumChannelsExceedsMaxError {
    pub requested: u32,
    pub max: u32,
}

impl std::error::Error for NumChannelsExceedsMaxError {}

impl std::fmt::Display for NumChannelsExceedsMaxError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(
            f,
            "requested {} channels, but maximum is {} (set during effect creation)",
            self.requested, self.max
        )
    }
}

/// Error returned when the requested impulse response size exceeds the maximum set during effect creation.
#[derive(Debug, Clone, PartialEq)]
pub struct ImpulseResponseSizeExceedsMaxError {
    pub requested: u32,
    pub max: u32,
}

impl std::error::Error for ImpulseResponseSizeExceedsMaxError {}

impl std::fmt::Display for ImpulseResponseSizeExceedsMaxError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(
            f,
            "requested impulse response size of {}, but maximum is {} (set during effect creation)",
            self.requested, self.max
        )
    }
}