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
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Embree ray tracing.

use crate::context::Context;
use crate::error::{to_option_error, SteamAudioError};

/// Application-wide state for the Embree ray tracer.
///
/// An Embree device must be created before using any of Steam Audio’s Embree ray tracing functionality.
#[derive(Debug)]
pub struct EmbreeDevice(audionimbus_sys::IPLEmbreeDevice);

impl EmbreeDevice {
    /// Creates a new Embree device for ray tracing.
    ///
    /// # Errors
    ///
    /// Returns [`SteamAudioError`] if device creation fails.
    pub fn try_new(context: &Context) -> Result<Self, SteamAudioError> {
        let mut embree_device = Self(std::ptr::null_mut());

        let embree_device_settings: *mut audionimbus_sys::IPLEmbreeDeviceSettings =
            std::ptr::null_mut();

        let status = unsafe {
            audionimbus_sys::iplEmbreeDeviceCreate(
                context.raw_ptr(),
                embree_device_settings,
                embree_device.raw_ptr_mut(),
            )
        };

        if let Some(error) = to_option_error(status) {
            return Err(error);
        }

        Ok(embree_device)
    }

    /// Returns the raw FFI pointer to the underlying Embree device.
    ///
    /// This is intended for internal use and advanced scenarios.
    pub const fn raw_ptr(&self) -> audionimbus_sys::IPLEmbreeDevice {
        self.0
    }

    /// Returns a mutable reference to the raw FFI pointer.
    ///
    /// This is intended for internal use and advanced scenarios.
    pub const fn raw_ptr_mut(&mut self) -> &mut audionimbus_sys::IPLEmbreeDevice {
        &mut self.0
    }
}

impl Drop for EmbreeDevice {
    fn drop(&mut self) {
        unsafe { audionimbus_sys::iplEmbreeDeviceRelease(&raw mut self.0) }
    }
}

unsafe impl Send for EmbreeDevice {}
unsafe impl Sync for EmbreeDevice {}

impl Clone for EmbreeDevice {
    /// Retains an additional reference to the Embree device.
    ///
    /// The returned [`EmbreeDevice`] shares the same underlying Steam Audio object.
    fn clone(&self) -> Self {
        // SAFETY: The device will not be destroyed until all references are released.
        Self(unsafe { audionimbus_sys::iplEmbreeDeviceRetain(self.0) })
    }
}

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

    #[test]
    fn test_clone() {
        let context = Context::default();
        let Ok(device) = EmbreeDevice::try_new(&context) else {
            // Device not available
            return;
        };
        let clone = device.clone();
        assert_eq!(device.raw_ptr(), clone.raw_ptr());
        drop(device);
        assert!(!clone.raw_ptr().is_null());
    }
}