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

//! Baking of compute-intensive processes (reflections, pathing).
//!
//! Simulating reflections or pathing in real-time is very compute-intensive.
//! Bakers allow you to precompute these simulations beforehand.
//!
//! Baked data is stored in a [`ProbeBatch`], which can then be added to and used by a [`Simulator`].
//!
//! ## Available bakers
//!
//! - [`ReflectionsBaker`]: Precomputes how sound propagates from sources to listeners via reflections.
//!   Real-time reflection simulation (see [`ReflectionEffect`]) is very compute-intensive,
//!   so this baker lets you precompute reflections throughout a scene offline.
//!
//! - [`PathBaker`]: Precomputes pathing data, an alternative simulation method that finds
//!   the shortest unoccluded paths from sources to listeners by traveling between probes.
//!   Pathing requires probe generation (see [`PathEffect`]) and is typically baked offline.

use std::sync::Mutex;

#[cfg(doc)]
use crate::effect::pathing::PathEffect;
#[cfg(doc)]
use crate::effect::reflections::ReflectionEffect;
#[cfg(doc)]
use crate::probe::ProbeBatch;
#[cfg(doc)]
use crate::simulation::Simulator;

static BAKE_LOCK: Mutex<()> = Mutex::new(());

mod baked_data;
pub use baked_data::*;

mod error;
pub use error::*;

pub mod pathing;
pub use pathing::{PathBakeParams, PathBaker};

pub mod reflections;
pub use reflections::{ReflectionsBakeFlags, ReflectionsBakeParams, ReflectionsBaker};

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

    #[test]
    fn test_bakers() {
        // Run test cases sequentially to avoid BakeError::BakeInProgress.
        pathing::tests::test_bake();
        reflections::tests::test_bake();
    }
}