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

use super::super::simulation::SourceWithInputs;
use super::{SimulationStep, SimulationStepError, SourceEntries};
use crate::effect::PathEffectParams;
use crate::ray_tracing::RayTracer;
use crate::simulation::{
    DirectCompatible, Pathing, ReflectionEffectCompatible, ReflectionsCompatible,
    SimulationFlagsProvider, SimulationSharedInputs, Simulator,
};
use std::collections::HashMap;
use std::hash::Hash;
use std::marker::PhantomData;

/// Runs pathing simulation.
pub struct PathingStep<SourceId, T, D, R, RE>
where
    T: RayTracer,
{
    /// The [`Simulator`] used by the step.
    simulator: Simulator<T, D, R, Pathing, RE>,
    _source_id: PhantomData<fn() -> SourceId>,
}

impl<T, D, R, RE> PathingStep<(), T, D, R, RE>
where
    T: RayTracer,
{
    /// Creates a new pathing simulation step.
    pub fn new<SourceId>(
        simulator: Simulator<T, D, R, Pathing, RE>,
    ) -> PathingStep<SourceId, T, D, R, RE> {
        PathingStep {
            simulator,
            _source_id: PhantomData,
        }
    }
}

impl<SourceId, T, D, R, RE, I> SimulationStep<I> for PathingStep<SourceId, T, D, R, RE>
where
    T: 'static + RayTracer,
    D: 'static + Send + Sync + DirectCompatible<D> + SimulationFlagsProvider,
    R: 'static + Send + Sync + ReflectionsCompatible<R> + SimulationFlagsProvider,
    RE: 'static + Send + Sync + ReflectionEffectCompatible<R, RE>,
    (): DirectCompatible<D> + ReflectionsCompatible<R>,
    SourceId: 'static + Clone + Send + Sync + Hash + Eq,
    I: AsPathingInput<SourceId, D, R, Pathing, RE>,
{
    type Output = HashMap<SourceId, PathEffectParams>;
    type Error = SimulationStepError;

    fn run(&mut self, frame: &I, output: &mut Self::Output) -> Result<(), Self::Error> {
        let input = frame.as_pathing_input();

        self.simulator
            .set_shared_pathing_inputs(input.shared_inputs)?;

        for (
            _,
            SourceWithInputs {
                source,
                simulation_inputs,
            },
        ) in input.sources
        {
            source.set_pathing_inputs(simulation_inputs)?;
        }

        self.simulator.run_pathing()?;

        for (id, SourceWithInputs { source, .. }) in input.sources.iter() {
            output.insert(id.clone(), source.get_pathing_outputs()?);
        }

        Ok(())
    }
}

/// Pathing simulation inputs.
#[derive(Debug)]
pub struct PathingInput<'a, SourceId, D, R, P, RE>
where
    RE: ReflectionEffectCompatible<R, RE>,
{
    /// The spatial audio sources whose paths to simulate.
    pub sources: &'a SourceEntries<SourceId, D, R, P, RE>,
    /// Shared simulation inputs applying to all sources.
    pub shared_inputs: &'a SimulationSharedInputs<D, R, P>,
}

/// Implemented by any type that can produce a [`PathingInput`] view.
pub trait AsPathingInput<SourceId, D, R, P, RE>
where
    RE: ReflectionEffectCompatible<R, RE>,
{
    /// Returns a view of this type as [`PathingInput`].
    fn as_pathing_input(&self) -> PathingInput<'_, SourceId, D, R, P, RE>;
}

/// Owned input for pathing simulation.
pub struct PathingInputOwned<SourceId, D, R, P, RE>
where
    RE: ReflectionEffectCompatible<R, RE>,
{
    /// The spatial audio sources whose paths to simulate.
    pub sources: Vec<(SourceId, SourceWithInputs<D, R, P, RE>)>,
    /// Shared simulation inputs applying to all sources.
    pub shared_inputs: SimulationSharedInputs<D, R, P>,
}

impl<SourceId, D, R, P, RE> AsPathingInput<SourceId, D, R, P, RE>
    for PathingInputOwned<SourceId, D, R, P, RE>
where
    RE: ReflectionEffectCompatible<R, RE>,
{
    fn as_pathing_input(&self) -> PathingInput<'_, SourceId, D, R, P, RE> {
        PathingInput {
            sources: self.sources.as_slice(),
            shared_inputs: &self.shared_inputs,
        }
    }
}