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
// 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_int, c_uint};
use crate::{Dsp, PluginType, System, get_string};
use crate::{FmodResultExt, Result};
impl System {
/// Specify a base search path for plugins so they can be placed somewhere else than the directory of the main executable.
pub fn set_plugin_path(&self, path: &Utf8CStr) -> Result<()> {
unsafe { FMOD_System_SetPluginPath(self.inner.as_ptr(), path.as_ptr()).to_result() }
}
/// Loads an FMOD (DSP, Output or Codec) plugin from file.
///
/// Once loaded DSP plugins can be used via `System::createDSPByPlugin`, output plugins can be use via `System::setOutputByPlugin` and codec plugins will be used automatically.
///
/// When opening a file each codec tests whether it can support the file format in priority order.
///
/// The format of the plugin is dependant on the operating system:
/// - Windows / UWP / Xbox One: .dll
/// - Linux / Android: .so
/// - Macintosh: .dylib
/// - PS4: .prx
///
/// # Safety
///
/// THIS CALLS INTO NON-RUST CODE! There is no guarantee that the plugin is safe to load, use, or unload.
pub unsafe fn load_plugin(&self, filename: &Utf8CStr, priority: c_uint) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_LoadPlugin(
self.inner.as_ptr(),
filename.as_ptr(),
&raw mut handle,
priority,
)
.to_result()?;
}
Ok(handle)
}
/// Unloads an FMOD (DSP, Output or Codec) plugin.
pub fn unload_plugin(&self, handle: c_uint) -> Result<()> {
unsafe { FMOD_System_UnloadPlugin(self.inner.as_ptr(), handle).to_result() }
}
/// Retrieves the number of nested plugins from the selected plugin.
///
/// Most plugins contain a single definition, in which case the count is 1, however some have a list of definitions.
/// his function returns the number of plugins that have been defined.
///
/// See the DSP Plug-in API guide for more information.
pub fn get_nested_plugin_count(&self, handle: c_uint) -> Result<c_int> {
let mut count = 0;
unsafe {
FMOD_System_GetNumNestedPlugins(self.inner.as_ptr(), handle, &raw mut count)
.to_result()?;
}
Ok(count)
}
/// Retrieves the handle of a nested plugin.
///
/// This function is used to iterate handles for plugins that have a list of definitions.
///
/// Most plugins contain a single definition.
/// If this is the case, only index 0 is valid, and the returned handle is the same as the handle passed in.
///
/// See the DSP Plug-in API guide for more information.
pub fn get_nested_plugin(&self, handle: c_uint, index: c_int) -> Result<c_uint> {
let mut nested_handle = 0;
unsafe {
FMOD_System_GetNestedPlugin(self.inner.as_ptr(), handle, index, &raw mut nested_handle)
.to_result()?;
}
Ok(nested_handle)
}
/// Retrieves the number of loaded plugins.
pub fn get_plugin_count(&self, kind: PluginType) -> Result<c_int> {
let mut count = 0;
unsafe {
FMOD_System_GetNumPlugins(self.inner.as_ptr(), kind.into(), &raw mut count)
.to_result()?;
}
Ok(count)
}
/// Retrieves the handle of a plugin based on its type and relative index.
///
/// All plugins whether built in or loaded can be enumerated using this and [`System::get_plugin_count`].
pub fn get_plugin_handle(&self, kind: PluginType, index: c_int) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_GetPluginHandle(self.inner.as_ptr(), kind.into(), index, &raw mut handle)
.to_result()?;
}
Ok(handle)
}
/// Retrieves information for the selected plugin.
pub fn get_plugin_info(&self, handle: c_uint) -> Result<(PluginType, Utf8CString, c_uint)> {
let mut plugin_type = 0;
let mut version = 0;
let name = get_string(|name| unsafe {
FMOD_System_GetPluginInfo(
self.inner.as_ptr(),
handle,
&raw mut plugin_type,
name.as_mut_ptr().cast(),
name.len() as c_int,
&raw mut version,
)
})?;
let plugin_type = plugin_type.try_into()?;
Ok((plugin_type, name, version))
}
/// Selects an output type given a plugin handle.
pub fn set_output_by_plugin(&self, handle: c_uint) -> Result<()> {
unsafe { FMOD_System_SetOutputByPlugin(self.inner.as_ptr(), handle).to_result() }
}
/// Retrieves the plugin handle for the currently selected output type.
pub fn get_output_by_plugin(&self) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_GetOutputByPlugin(self.inner.as_ptr(), &raw mut handle).to_result()?;
}
Ok(handle)
}
/// Create a DSP object given a plugin handle.
///
/// A DSP object is a module that can be inserted into the mixing graph to allow sound filtering or sound generation.
/// See the DSP architecture guide for more information.
///
/// A handle can come from a newly loaded plugin with `System::loadPlugin` or an existing plugin with `System::getPluginHandle`.
///
/// DSPs must be attached to the DSP graph before they become active, either via `ChannelControl::addDSP` or `DSP::addInput`.
pub fn create_dsp_by_plugin(&self, handle: c_uint) -> Result<Dsp> {
let mut dsp = std::ptr::null_mut();
unsafe {
FMOD_System_CreateDSPByPlugin(self.inner.as_ptr(), handle, &raw mut dsp).to_result()?;
Ok(Dsp::from_ffi(dsp))
}
}
/// Retrieve the description structure for a pre-existing DSP plugin.
// this is safe, but dereferencing the pointer is not
pub fn get_dsp_info_by_plugin(&self, handle: c_uint) -> Result<*const FMOD_DSP_DESCRIPTION> {
let mut dsp_description = std::ptr::null();
unsafe {
FMOD_System_GetDSPInfoByPlugin(self.inner.as_ptr(), handle, &raw mut dsp_description)
.to_result()?;
}
Ok(dsp_description)
}
/// Register a Codec plugin description structure for later use.
///
/// To create an instances of this plugin use `System::create_sound` and `System::create_stream`.
///
/// When opening a file each Codec tests whether it can support the file format in priority order.
/// The priority for each `FMOD_SOUND_TYPE` are as follows:
/// - `FMOD_SOUND_TYPE_FSB` : 250
/// - `FMOD_SOUND_TYPE_XMA` : 250
/// - `FMOD_SOUND_TYPE_AT9` : 250
/// - `FMOD_SOUND_TYPE_VORBIS` : 250
/// - `FMOD_SOUND_TYPE_OPUS` : 250
/// - `FMOD_SOUND_TYPE_FADPCM` : 250
/// - `FMOD_SOUND_TYPE_WAV` : 600
/// - `FMOD_SOUND_TYPE_OGGVORBIS` : 800
/// - `FMOD_SOUND_TYPE_AIFF` : 1000
/// - `FMOD_SOUND_TYPE_FLAC` : 1100
/// - `FMOD_SOUND_TYPE_MOD` : 1200
/// - `FMOD_SOUND_TYPE_S3M` : 1300
/// - `FMOD_SOUND_TYPE_XM` : 1400
/// - `FMOD_SOUND_TYPE_IT` : 1500
/// - `FMOD_SOUND_TYPE_MIDI` : 1600
/// - `FMOD_SOUND_TYPE_DLS` : 1700
/// - `FMOD_SOUND_TYPE_ASF` : 1900
/// - `FMOD_SOUND_TYPE_AUDIOQUEUE` : 2200
/// - `FMOD_SOUND_TYPE_MEDIACODEC` : 2250
/// - `FMOD_SOUND_TYPE_MPEG` : 2400
/// - `FMOD_SOUND_TYPE_PLAYLIST` : 2450
/// - `FMOD_SOUND_TYPE_RAW` : 2500
/// - `FMOD_SOUND_TYPE_USER` : 2600
/// - `FMOD_SOUND_TYPE_MEDIA_FOUNDATION` : 2600
///
/// XMA, AT9, Vorbis, Opus and FADPCM are supported through the FSB format, and therefore have the same priority as FSB.
///
/// Media Foundation is supported through the User codec, and therefore has the same priority as User.
///
/// Raw and User are only accesible if `FMOD_OPENRAW` or `FMOD_OPENUSER` is specified as the mode in `System::create_sound`.
///
/// # Safety
///
/// This function provides no gaurdrails or safe API for registering a codec.
/// It can call into non-rust external code.
/// Codec descriptions are intended to be retrieved from a plugin's C API, so it's not feasible to provide a safe API for this function.
pub unsafe fn register_codec(
&self,
description: *mut FMOD_CODEC_DESCRIPTION,
priority: c_uint,
) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_RegisterCodec(self.inner.as_ptr(), description, &raw mut handle, priority)
.to_result()?;
}
Ok(handle)
}
/// Register a DSP plugin description structure for later use.
///
/// To create an instances of this plugin use `System::createDSPByPlugin`.
///
/// # Safety
///
/// This function provides no gaurdrails or safe API for registering a plugin.
/// It can call into non-rust external code.
/// Dsp descriptions are intended to be retrieved from a plugin's C API, so it's not feasible to provide a safe API for this function.
pub unsafe fn register_plugin(
&self,
dsp_description: *mut FMOD_DSP_DESCRIPTION,
) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_RegisterDSP(self.inner.as_ptr(), dsp_description, &raw mut handle)
.to_result()?;
}
Ok(handle)
}
/// Register an Output plugin description structure for later use.
///
/// To select this plugin for output use `System::setOutputByPlugin`.
///
/// # Safety
///
/// This function provides no gaurdrails or safe API for registering an output.
/// It can call into non-rust external code.
/// Output descriptions are intended to be retrieved from a plugin's C API, so it's not feasible to provide a safe API for this function.
pub unsafe fn register_output(
&self,
description: *mut FMOD_OUTPUT_DESCRIPTION,
) -> Result<c_uint> {
let mut handle = 0;
unsafe {
FMOD_System_RegisterOutput(self.inner.as_ptr(), description, &raw mut handle)
.to_result()?;
}
Ok(handle)
}
}