libfmod 2.222.6

A library wrapper for integrating FMOD Engine in Rust applications.
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
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

use std::fs::File;
use std::io::Read;
use std::thread::sleep;
use std::time::Duration;

use libfmod::{Error, Init, LoadBank, SpeakerMode, StopMode, Studio, StudioInit};

#[test]
fn test_simple_events() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;

    let master =
        studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    let strings = studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let sfx = studio.load_bank_file("./tests/data/Build/Desktop/SFX.bank", LoadBank::NORMAL)?;

    let ambience_event = studio.get_event("event:/events/1")?;
    let ambience = ambience_event.create_instance()?;

    let cancellation_event = studio.get_event("event:/events/2")?;
    let cancellation = cancellation_event.create_instance()?;

    let explosion_event = studio.get_event("event:/events/1")?;
    explosion_event.load_sample_data()?;

    for step in 0..5 {
        match step {
            0 => {
                ambience.start()?;
            }
            2 => {
                let explosion = explosion_event.create_instance()?;
                explosion.start()?;
                explosion.release()?;
            }
            3 => {
                cancellation.start()?;
            }
            4 => {
                ambience.stop(StopMode::AllowFadeout)?;
            }
            _ => {}
        }
        studio.update()?;
        sleep(Duration::from_secs(1));
    }

    sfx.unload()?;
    strings.unload()?;
    master.unload()?;

    studio.release()
}

#[test]
fn test_bank_loading_from_memory() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    let master =
        studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    let strings = studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let mut sfx_file = File::open("./tests/data/Build/Desktop/SFX.bank").unwrap();
    let mut buffer = Vec::new();
    sfx_file.read_to_end(&mut buffer).unwrap();
    let sfx = studio.load_bank_memory(&buffer, LoadBank::NORMAL)?;
    let my_event = studio.get_event("event:/events/1")?;
    let event = my_event.create_instance()?;
    event.start()?;
    for _ in 0..5 {
        studio.update()?;
        sleep(Duration::from_millis(500));
    }
    sfx.unload()?;
    strings.unload()?;
    master.unload()?;
    studio.release()
}

#[test]
fn test_get_bank_path() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    let strings = studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;

    let path = strings.get_path()?;
    assert_eq!(path, "bank:/Master.strings");

    studio.release()
}

#[test]
fn test_get_parameter_label_by_name() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    let banks = [
        "./tests/data/Build/Desktop/Master.strings.bank",
        "./tests/data/Build/Desktop/SFX.bank",
    ];
    for bank in banks {
        studio.load_bank_file(bank, LoadBank::NORMAL)?;
    }
    let event = studio.get_event("event:/events/1")?;
    let (label, len) = event.get_parameter_label_by_name("UserParameter", 0, 10)?;
    assert_eq!(label, "Value A", "label");
    assert_eq!(len, 8, "C string length");
    studio.release()
}

#[test]
fn test_get_event_path() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    studio.load_bank_file("./tests/data/Build/Desktop/SFX.bank", LoadBank::NORMAL)?;
    let event = studio.get_event("event:/events/1")?;

    let path = event.get_path()?;
    assert_eq!(path, "event:/events/1");

    studio.release()
}

#[test]
fn test_get_vca_path() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let vca = studio.get_vca("vca:/Environment")?;

    let path = vca.get_path()?;
    assert_eq!(path, "vca:/Environment");
    assert!(vca.is_valid());

    studio.release()
}

#[test]
fn test_get_bus_path() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let bus = studio.get_bus("bus:/MyGroup/New Return")?;

    let path = bus.get_path()?;
    assert_eq!(path, "bus:/MyGroup/New Return");

    studio.release()
}

#[test]
fn test_lookup_path() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    let strings = studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let strings_id = strings.get_id()?;

    let path = studio.lookup_path(strings_id)?;
    assert_eq!(path, "bank:/Master.strings");

    studio.release()
}

#[test]
fn test_banks_list() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let banks_count = studio.get_bank_count()?;
    let banks = studio.get_bank_list(banks_count)?; // take all
    let banks: Vec<String> = banks.iter().map(|bank| bank.get_path().unwrap()).collect();

    assert_eq!(banks_count, 2);
    assert_eq!(
        banks,
        vec![
            "bank:/Master".to_string(),
            "bank:/Master.strings".to_string(),
        ]
    );

    studio.release()
}

#[test]
fn test_bank_events_list() -> Result<(), Error> {
    let studio = Studio::create()?;
    let system = studio.get_core_system()?;
    system.set_software_format(None, Some(SpeakerMode::Quad), None)?;
    studio.initialize(1024, StudioInit::NORMAL, Init::NORMAL, None)?;
    studio.load_bank_file("./tests/data/Build/Desktop/Master.bank", LoadBank::NORMAL)?;
    studio.load_bank_file(
        "./tests/data/Build/Desktop/Master.strings.bank",
        LoadBank::NORMAL,
    )?;
    let sfx = studio.load_bank_file("./tests/data/Build/Desktop/SFX.bank", LoadBank::NORMAL)?;
    let count = sfx.get_event_count()?;
    let events = sfx.get_event_list(3)?; // take first 3
    let events: Vec<String> = events
        .iter()
        .map(|event| event.get_path().unwrap())
        .collect();

    assert_eq!(count, 2);
    assert_eq!(
        events,
        vec!["event:/events/1".to_string(), "event:/events/2".to_string()]
    );

    studio.release()
}