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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
// 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, Utf8CString};
use std::{
ffi::{c_float, c_int},
mem::MaybeUninit,
};
use crate::studio::{ParameterDescription, ParameterID, System, get_string_out_size};
use crate::{FmodResultExt, Result};
impl System {
/// Retrieves a global parameter value by unique identifier.
///
/// The second tuple field is the final value of the parameter after applying adjustments due to automation, modulation, seek speed, and parameter velocity to value.
/// This is calculated asynchronously when the Studio system updates.
pub fn get_parameter_by_id(&self, id: ParameterID) -> Result<(c_float, c_float)> {
let mut value = 0.0;
let mut final_value = 0.0;
unsafe {
FMOD_Studio_System_GetParameterByID(
self.inner.as_ptr(),
id.into(),
&raw mut value,
&raw mut final_value,
)
.to_result()?;
}
Ok((value, final_value))
}
/// Sets a global parameter value by unique identifier.
pub fn set_parameter_by_id(
&self,
id: ParameterID,
value: c_float,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_System_SetParameterByID(
self.inner.as_ptr(),
id.into(),
value,
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Sets a global parameter value by unique identifier, looking up the value label.
///
/// If the specified label is not found, [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned.
/// This lookup is case sensitive.
pub fn set_parameter_by_id_with_label(
&self,
id: ParameterID,
label: &Utf8CStr,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_System_SetParameterByIDWithLabel(
self.inner.as_ptr(),
id.into(),
label.as_ptr(),
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Sets multiple global parameter values by unique identifier.
///
/// If any ID is set to all zeroes then the corresponding value will be ignored.
///
/// # Panics
///
/// This function will panic if `ids.len()` != `values.len()`.
pub fn set_parameters_by_ids(
&self,
ids: &[ParameterID], // TODO fmod says that the size of this must range from 1-32. do we need to enforce this?
values: &mut [c_float], // TODO is this &mut correct? does fmod perform any writes?
ignore_seek_speed: bool,
) -> Result<()> {
// TODO don't panic, return result
assert_eq!(ids.len(), values.len());
unsafe {
FMOD_Studio_System_SetParametersByIDs(
self.inner.as_ptr(),
ids.as_ptr().cast(),
values.as_mut_ptr(),
ids.len() as c_int,
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Retrieves a global parameter value by name.
///
/// The second tuple field is the final value of the parameter after applying adjustments due to automation, modulation, seek speed, and parameter velocity to value.
/// This is calculated asynchronously when the Studio system updates.
pub fn get_parameter_by_name(&self, name: &Utf8CStr) -> Result<(c_float, c_float)> {
let mut value = 0.0;
let mut final_value = 0.0;
unsafe {
FMOD_Studio_System_GetParameterByName(
self.inner.as_ptr(),
name.as_ptr(),
&raw mut value,
&raw mut final_value,
)
.to_result()?;
}
Ok((value, final_value))
}
/// Sets a global parameter value by name.
pub fn set_parameter_by_name(
&self,
name: &Utf8CStr,
value: c_float,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_System_SetParameterByName(
self.inner.as_ptr(),
name.as_ptr(),
value,
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Sets a global parameter value by name, looking up the value label.
///
/// If the specified label is not found, [`FMOD_RESULT::FMOD_ERR_EVENT_NOTFOUND`] is returned. This lookup is case sensitive.
pub fn set_parameter_by_name_with_label(
&self,
name: &Utf8CStr,
label: &Utf8CStr,
ignore_seek_speed: bool,
) -> Result<()> {
unsafe {
FMOD_Studio_System_SetParameterByNameWithLabel(
self.inner.as_ptr(),
name.as_ptr(),
label.as_ptr(),
ignore_seek_speed.into(),
)
.to_result()
}
}
/// Retrieves a global parameter by name or path.
///
/// `name` can be the short name (such as `Wind`) or the full path (such as `parameter:/Ambience/Wind`).
/// Path lookups will only succeed if the strings bank has been loaded.
pub fn get_parameter_description_by_name(
&self,
name: &Utf8CStr,
) -> Result<ParameterDescription> {
let mut description = MaybeUninit::zeroed();
unsafe {
FMOD_Studio_System_GetParameterDescriptionByName(
self.inner.as_ptr(),
name.as_ptr(),
description.as_mut_ptr(),
)
.to_result()?;
let description = ParameterDescription::from_ffi(description.assume_init());
Ok(description)
}
}
/// Retrieves a global parameter by ID.
pub fn get_parameter_description_by_id(&self, id: ParameterID) -> Result<ParameterDescription> {
let mut description = MaybeUninit::zeroed();
unsafe {
FMOD_Studio_System_GetParameterDescriptionByID(
self.inner.as_ptr(),
id.into(),
description.as_mut_ptr(),
)
.to_result()?;
let description = ParameterDescription::from_ffi(description.assume_init());
Ok(description)
}
}
/// Retrieves the number of global parameters.
pub fn parameter_description_count(&self) -> Result<c_int> {
let mut count = 0;
unsafe {
FMOD_Studio_System_GetParameterDescriptionCount(self.inner.as_ptr(), &raw mut count)
.to_result()?;
}
Ok(count)
}
/// Retrieves a list of global parameters.
pub fn get_parameter_description_list(&self) -> Result<Vec<ParameterDescription>> {
let expected_count = self.parameter_description_count()?;
let mut count = 0;
let mut list = vec![MaybeUninit::zeroed(); expected_count as usize];
unsafe {
FMOD_Studio_System_GetParameterDescriptionList(
self.inner.as_ptr(),
// bank is repr transparent and has the same layout as *mut FMOD_STUDIO_BANK, so this cast is ok
list.as_mut_ptr()
.cast::<FMOD_STUDIO_PARAMETER_DESCRIPTION>(),
list.capacity() as c_int,
&raw mut count,
)
.to_result()?;
debug_assert_eq!(count, expected_count);
let list = list
.into_iter()
.map(|uninit| {
let description = uninit.assume_init();
ParameterDescription::from_ffi(description)
})
.collect();
Ok(list)
}
}
/// Retrieves a global parameter label by name or path.
///
/// `name` can be the short name (such as `Wind`) or the full path (such as `parameter:/Ambience/Wind`).
/// Path lookups will only succeed if the strings bank has been loaded.
pub fn get_parameter_label_by_name(
&self,
name: &Utf8CStr,
label_index: c_int,
) -> Result<Utf8CString> {
get_string_out_size(|path, size, ret| unsafe {
FMOD_Studio_System_GetParameterLabelByName(
self.inner.as_ptr(),
name.as_ptr(),
label_index,
path,
size,
ret,
)
})
}
/// Retrieves a global parameter label by ID.
pub fn get_parameter_label_by_id(
&self,
id: ParameterID,
label_index: c_int,
) -> Result<Utf8CString> {
get_string_out_size(|path, size, ret| unsafe {
FMOD_Studio_System_GetParameterLabelByID(
self.inner.as_ptr(),
id.into(),
label_index,
path,
size,
ret,
)
})
}
}