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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
// Copyright (c) 2024 Melody Madeline Lyons
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.
use fmod_sys::*;
use lanyard::Utf8CStr;
use std::mem::MaybeUninit;
use crate::Guid;
use crate::studio::{AdvancedSettings, Bus, EventDescription, SoundInfo, System, Vca};
use crate::{FmodResultExt, Result};
impl System {
/// Retrieves a loaded [`Bus`].
///
/// This function allows you to retrieve a handle for any bus in the global mixer.
///
/// `path_or_id` may be a path, such as `bus:/SFX/Ambience`, or an ID string, such as `{d9982c58-a056-4e6c-b8e3-883854b4bffb}`.
///
/// Note that path lookups will only succeed if the strings bank has been loaded.
pub fn get_bus(&self, path_or_id: &Utf8CStr) -> Result<Bus> {
let mut bus = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetBus(self.inner.as_ptr(), path_or_id.as_ptr(), &raw mut bus)
.to_result()?;
Ok(Bus::from_ffi(bus))
}
}
/// Retrieves a loaded [`Bus`].
///
/// This function allows you to retrieve a handle for any bus in the global mixer.
pub fn get_bus_by_id(&self, id: Guid) -> Result<Bus> {
let mut bus = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetBusByID(self.inner.as_ptr(), &id.into(), &raw mut bus)
.to_result()?;
Ok(Bus::from_ffi(bus))
}
}
/// Retrieves an [`EventDescription`].
///
/// This function allows you to retrieve a handle to any loaded event description.
///
/// `path+or_id` may be a path, such as `event:/UI/Cancel` or `snapshot:/IngamePause`, or an ID string, such as `{2a3e48e6-94fc-4363-9468-33d2dd4d7b00}`.
///
/// Note that path lookups will only succeed if the strings bank has been loaded.
pub fn get_event(&self, path_or_id: &Utf8CStr) -> Result<EventDescription> {
let mut event = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetEvent(self.inner.as_ptr(), path_or_id.as_ptr(), &raw mut event)
.to_result()?;
Ok(EventDescription::from_ffi(event))
}
}
/// Retrieves an [`EventDescription`].
///
/// This function allows you to retrieve a handle to any loaded event description.
pub fn get_event_by_id(&self, id: Guid) -> Result<EventDescription> {
let mut event = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetEventByID(self.inner.as_ptr(), &id.into(), &raw mut event)
.to_result()?;
Ok(EventDescription::from_ffi(event))
}
}
/// Retrieves a loaded VCA.
///
/// This function allows you to retrieve a handle for any VCA in the global mixer.
///
/// `path_or_id` may be a path, such as `vca:/MyVCA`, or an ID string, such as `{d9982c58-a056-4e6c-b8e3-883854b4bffb`}.
///
/// Note that path lookups will only succeed if the strings bank has been loaded.
pub fn get_vca(&self, path_or_id: &Utf8CStr) -> Result<Vca> {
let mut vca = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetVCA(self.inner.as_ptr(), path_or_id.as_ptr(), &raw mut vca)
.to_result()?;
Ok(Vca::from_ffi(vca))
}
}
/// Retrieves a loaded VCA.
///
/// This function allows you to retrieve a handle for any VCA in the global mixer.
pub fn get_vca_by_id(&self, id: Guid) -> Result<Vca> {
let mut vca = std::ptr::null_mut();
unsafe {
FMOD_Studio_System_GetVCAByID(self.inner.as_ptr(), &id.into(), &raw mut vca)
.to_result()?;
Ok(Vca::from_ffi(vca))
}
}
/// Retrieves advanced settings.
pub fn get_advanced_settings(&self) -> Result<AdvancedSettings> {
let mut advanced_settings = MaybeUninit::zeroed();
unsafe {
FMOD_Studio_System_GetAdvancedSettings(
self.inner.as_ptr(),
advanced_settings.as_mut_ptr(),
)
.to_result()?;
let advanced_settings = AdvancedSettings::from_ffi(advanced_settings.assume_init());
Ok(advanced_settings)
}
}
/// Retrieves information for loading a sound from the audio table.
///
/// The [`SoundInfo`] structure contains information to be passed to [`crate::System::create_sound`] (which will create a parent sound),
/// along with a subsound index to be passed to [`crate::Sound::get_sub_sound`] once the parent sound is loaded.
///
/// The user is expected to call [`crate::System::create_sound`] with the given information.
/// It is up to the user to combine in any desired loading flags, such as [`FMOD_CREATESTREAM`], [`FMOD_CREATECOMPRESSEDSAMPLE`] or [`FMOD_NONBLOCKING`] with the flags in [`FMOD_STUDIO_SOUND_INFO::mode`].
///
/// When the banks have been loaded via [`System::load_bank_memory`], the mode will be returned as [`FMOD_OPENMEMORY_POINT`].
/// This won't work with the default [`FMOD_CREATESAMPLE`] mode.
/// For memory banks, you should add in the [`FMOD_CREATECOMPRESSEDSAMPLE`] or [`FMOD_CREATESTREAM`] flag, or remove [`FMOD_OPENMEMORY_POINT`] and add [`FMOD_OPENMEMORY`] to decompress the sample into a new allocation.
///
/// # Safety
///
/// The returned [`SoundInfo`] structure has an unbounded lifetime as it is hard to represent. You MUST constrain its lifetime as quickly as possible.
pub unsafe fn get_sound_info<'a>(&self, key: &Utf8CStr) -> Result<SoundInfo<'a>> {
let mut sound_info = MaybeUninit::zeroed();
unsafe {
FMOD_Studio_System_GetSoundInfo(
self.inner.as_ptr(),
key.as_ptr(),
sound_info.as_mut_ptr(),
)
.to_result()?;
let sound_info = SoundInfo::from_ffi(sound_info.assume_init());
Ok(sound_info)
}
}
}