fmod-oxide 0.2.1

Zero cost bindings to FMOD and FMOD Studio
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

// 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 std::ffi::c_int;

use crate::{ChannelMask, Dsp, SpeakerMode};
use crate::{FmodResultExt, Result};

impl Dsp {
    /// Sets the PCM input format this [`Dsp`] will receive when processing.
    ///
    /// Setting the number of channels on a unit will force either a down or up mix to that channel count before processing the [`Dsp`] read/process callback.
    pub fn set_channel_format(
        &self,
        channel_mask: ChannelMask,
        channel_count: c_int,
        source_speaker_mode: SpeakerMode,
    ) -> Result<()> {
        unsafe {
            FMOD_DSP_SetChannelFormat(
                self.inner.as_ptr(),
                channel_mask.into(),
                channel_count,
                source_speaker_mode.into(),
            )
            .to_result()
        }
    }

    /// Retrieves the PCM input format this [`Dsp`] will receive when processing.
    pub fn get_channel_format(&self) -> Result<(ChannelMask, c_int, SpeakerMode)> {
        let mut channel_mask = 0;
        let mut channel_count = 0;
        let mut source_speaker_mode = 0;
        unsafe {
            FMOD_DSP_GetChannelFormat(
                self.inner.as_ptr(),
                &raw mut channel_mask,
                &raw mut channel_count,
                &raw mut source_speaker_mode,
            )
            .to_result()?;
        }
        let source_speaker_mode = source_speaker_mode.try_into()?;
        Ok((channel_mask.into(), channel_count, source_speaker_mode))
    }

    /// Retrieves the output format this [`Dsp`] will produce when processing based on the input specified.
    pub fn get_output_channel_format(
        &self,
        in_mask: ChannelMask,
        in_channels: c_int,
        in_speaker_mode: SpeakerMode,
    ) -> Result<(ChannelMask, c_int, SpeakerMode)> {
        let mut out_mask = 0;
        let mut out_channels = 0;
        let mut out_speaker_mode = 0;
        unsafe {
            FMOD_DSP_GetOutputChannelFormat(
                self.inner.as_ptr(),
                in_mask.into(),
                in_channels,
                in_speaker_mode.into(),
                &raw mut out_mask,
                &raw mut out_channels,
                &raw mut out_speaker_mode,
            )
            .to_result()?;
        }
        let out_speaker_mode = out_speaker_mode.try_into()?;
        Ok((out_mask.into(), out_channels, out_speaker_mode))
    }
}