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

use libfmod::ffi::{
    FMOD_CHANNELCONTROL_DSP_HEAD, FMOD_CHANNELCONTROL_DSP_TAIL, FMOD_DEFAULT, FMOD_INIT_NORMAL,
};
use libfmod::{DspConnectionType, DspParameterFft, DspType, Error, System};

/// This unit produces an echo on the sound and fades out at the desired rate.
#[test]
fn test_dsp_effect_to_channel() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let sound = system.create_sound("./tests/data/Assets/1.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, None, false)?;
    let echo = system.create_dsp_by_type(DspType::Echo)?;
    channel.add_dsp(0, echo)?;
    while channel.is_playing()? {
        // do something else
    }
    system.release()
}

/// This dsp simply analyzes the signal and provides spectrum information back.
#[test]
fn test_fft_dsp() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let sound = system.create_sound("./tests/data/Assets/2.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, None, false)?;
    let dsp = system.create_dsp_by_type(DspType::Fft)?;
    channel.add_dsp(0, dsp)?;
    while channel.is_playing()? {}
    let fft = DspParameterFft::try_from(dsp)?;

    assert_eq!(fft.spectrum.len(), 2);
    assert_eq!(fft.length, 2048);
    assert_eq!(fft.spectrum[0].len(), 2048);
    assert_eq!(fft.spectrum[1].len(), 2048);

    system.release()
}

#[test]
fn test_fft_from_type_mismatched_dsp() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let sound = system.create_sound("./tests/data/Assets/1.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, None, false)?;
    let echo_dsp = system.create_dsp_by_type(DspType::Echo)?;
    channel.add_dsp(0, echo_dsp)?;
    let fft = DspParameterFft::try_from(echo_dsp);
    assert_eq!(
        "trying get FFT from DSP which not FFT",
        format!("{}", fft.err().unwrap())
    );

    system.release()
}

#[test]
fn test_dps_description_name() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let description = system.get_dsp_info_by_type(DspType::Echo)?;
    let bytes = description.name.map(|char| char as u8).to_vec();
    let name = String::from_utf8(bytes[..9].to_vec());

    assert_eq!(name, Ok("FMOD Echo".to_string()));

    system.release()
}

#[test]
fn test_channels_dsp() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let reverb = system.create_dsp_by_type(DspType::Sfxreverb)?;
    let master = system.get_master_channel_group()?;
    let tail = master.get_dsp(FMOD_CHANNELCONTROL_DSP_TAIL)?;
    tail.add_input(reverb, DspConnectionType::Send)?;
    reverb.set_active(true)?;

    let sound = system.create_sound("./tests/data/Assets/2.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, Some(master), true)?;
    let head = channel.get_dsp(FMOD_CHANNELCONTROL_DSP_HEAD)?;
    reverb.add_input(head, DspConnectionType::Send)?;

    channel.set_paused(false)?;
    while channel.is_playing()? {
        // do something else
    }

    system.release()
}

#[test]
fn test_controlling_mix_level() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let reverb = system.create_dsp_by_type(DspType::Sfxreverb)?;
    let sound = system.create_sound("./tests/data/Assets/1.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, None, true)?;
    let head = channel.get_dsp(FMOD_CHANNELCONTROL_DSP_HEAD)?;
    let connection = reverb.add_input(head, DspConnectionType::Send)?;
    connection.set_mix(0.0)?;

    system.release()
}

#[test]
fn test_output_pan_matrix() -> Result<(), Error> {
    let system = System::create()?;
    system.init(512, FMOD_INIT_NORMAL, None)?;

    let sound = system.create_sound("./tests/data/Assets/2.ogg", FMOD_DEFAULT, None)?;
    let channel = system.play_sound(sound, None, true)?;
    let head = channel.get_dsp(FMOD_CHANNELCONTROL_DSP_HEAD)?;

    let mut matrix = [
        0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0,
    ];

    let (_, connection) = head.get_output(0)?;
    connection.set_mix_matrix(Some(matrix.as_mut_ptr()), 4, 4, None)?;
    // get mix matrix TODO
    system.release()
}