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

//! Reflections and reverb simulation runner.

use super::super::configuration::SimulationConfiguration;
use super::super::error::{SimulationErrorEvent, SimulationErrorSender};
use super::super::simulation::{Simulation, SimulationSharedInputs, SimulationThread};
use super::super::source::{Listener, Source, SourceParameters};
use super::super::system_set::SpatialAudioSet;
use super::{Runner, Spawn, SyncFrame, ToRunner};
use crate::sealed::Sealed;
use crate::simulation::{
    DirectCompatible, PathingCompatible, Reflections, SimulationInputs, SimulationParameters,
};
use crate::wiring::{ReflectionsReverbFrame, SimulationStepError, SourceWithInputs};
use bevy::prelude::{
    App, Entity, GlobalTransform, IntoScheduleConfigs, PostUpdate, Query, Res, Resource, With,
    World, resource_exists,
};
use bevy::transform::TransformSystems;
use std::ops::{Deref, DerefMut};

/// Runner for reflections and listener-centric reverb simulation.
pub struct RunnerReflectionsReverb;

impl Sealed for RunnerReflectionsReverb {}
impl Runner for RunnerReflectionsReverb {
    type SimulationType = Reflections;
}

impl ToRunner for Reflections {
    type Runner = RunnerReflectionsReverb;
}

impl<C> Spawn<C> for RunnerReflectionsReverb
where
    C: SimulationConfiguration<Reflections = Reflections>,
    (): DirectCompatible<<C as SimulationConfiguration>::Direct>
        + PathingCompatible<<C as SimulationConfiguration>::Pathing>,
{
    fn spawn(world: &mut World) {
        let error_sender = world.resource::<SimulationErrorSender>().0.clone();

        let runner = world
            .resource_mut::<Simulation<C>>()
            .spawn_reflections_reverb(move |error: SimulationStepError| {
                let _ = error_sender.try_send(SimulationErrorEvent {
                    thread: SimulationThread::ReflectionsReverb,
                    error,
                });
            });

        world.insert_resource(ReflectionsReverbSimulation::<C>(runner));
    }
}

impl<C> SyncFrame<C> for RunnerReflectionsReverb
where
    C: SimulationConfiguration<Reflections = Reflections>,
{
    fn add_systems(app: &mut App) {
        app.add_systems(
            PostUpdate,
            sync_reflections_reverb_frame::<C>
                .run_if(resource_exists::<ReflectionsReverbSimulation<C>>)
                .after(TransformSystems::Propagate)
                .in_set(SpatialAudioSet::SyncFrames),
        );
    }
}

/// Publishes a new frame to the reflections-reverb thread, including the listener source when one
/// is present.
#[allow(clippy::type_complexity)]
fn sync_reflections_reverb_frame<C>(
    query: Query<(&GlobalTransform, &Source<C>, Option<&SourceParameters<C>>), With<Listener>>,
    simulation: Res<Simulation<C>>,
    reflections_reverb: Res<ReflectionsReverbSimulation<C>>,
    shared_inputs: Res<SimulationSharedInputs<C>>,
) where
    C: SimulationConfiguration<Reflections = Reflections>,
{
    let listener = query
        .iter()
        .next()
        .map(
            |(global_transform, source, simulation_parameters)| SourceWithInputs {
                source: source.0.clone(),
                simulation_inputs: SimulationInputs {
                    source: (*global_transform).into(),
                    parameters: simulation_parameters
                        .map_or_else(SimulationParameters::default, |params| params.0.clone()),
                },
            },
        );

    reflections_reverb.set_input(ReflectionsReverbFrame {
        sources: simulation.sources.clone(),
        listener,
        shared_inputs: shared_inputs.0.clone(),
    });
}

/// Resource wrapping a [`wiring::ReflectionsReverbSimulation`](crate::wiring::ReflectionsReverbSimulation).
#[derive(Resource)]
pub struct ReflectionsReverbSimulation<C: SimulationConfiguration>(
    pub  crate::wiring::ReflectionsReverbSimulation<
        Entity,
        C::Direct,
        C::Pathing,
        C::ReflectionEffect,
    >,
);

impl<C: SimulationConfiguration> Deref for ReflectionsReverbSimulation<C> {
    type Target = crate::wiring::ReflectionsReverbSimulation<
        Entity,
        C::Direct,
        C::Pathing,
        C::ReflectionEffect,
    >;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl<C: SimulationConfiguration> DerefMut for ReflectionsReverbSimulation<C> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}