fmod1 0.1.0

Rust wrapper for FMOD low-level API
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

//! Rust wrapper for FMOD 1.10.20

#![feature(decl_macro)]

#[macro_use] extern crate bitflags;

extern crate num_traits;

pub use num_traits::FromPrimitive;

pub use fmod_sys as ll;

#[cfg(target_os = "linux")]
#[link(name = "fmod")] unsafe extern "C" {}

#[cfg(target_os = "windows")]
#[link(name = "fmod64_vc")] unsafe extern "C" {}

////////////////////////////////////////////////////////////////////////////////
//  modules                                                                   //
////////////////////////////////////////////////////////////////////////////////

pub mod channel;
pub mod channel_control;
pub mod channel_group;
pub mod dsp;
pub mod reverb3d;
pub mod sound;
pub mod sound_group;
pub mod system;

pub use self::channel::Channel;
pub use self::channel_control::ChannelControl;
pub use self::channel_group::{ChannelGroup, ChannelGroupRef};
pub use self::dsp::{Dsp, DspRef};
pub use self::reverb3d::Reverb3d;
pub use self::sound::{Sound, SoundRef};
pub use self::sound_group::SoundGroup;
pub use self::system::System;
// private modules
mod types;
pub use self::types::{Channelmask, CpuUsage, Delay, DebugFlags, DriverState,
  Error, Guid, ListenerAttributes, Mode, PluginHandle, Plugintype, SoundRam,
  Speaker, Speakermode, Timeunit};

/// Version in FMOD headers used to generate bindings.
///
/// The version is a 32 bit hexadecimal value formated as 16:8:8, with the upper
/// 16 bits being the product version, the middle 8 bits being the major version
/// and the bottom 8 bits being the minor version.
pub const FMOD_VERSION             : u32 = ll::FMOD_VERSION;
pub const CODEC_WAVEFORMAT_VERSION : u32 = ll::FMOD_CODEC_WAVEFORMAT_VERSION;
pub const MAX_CHANNEL_WIDTH        : u32 = ll::FMOD_MAX_CHANNEL_WIDTH;
pub const MAX_SYSTEMS              : u32 = ll::FMOD_MAX_SYSTEMS;
pub const MAX_LISTENERS            : u32 = ll::FMOD_MAX_LISTENERS;
pub const OUTPUT_PLUGIN_VERSION    : u32 = ll::FMOD_OUTPUT_PLUGIN_VERSION;
pub const PLUGIN_SDK_VERSION       : u32 = ll::FMOD_PLUGIN_SDK_VERSION;
/// Version in FMOD headers used to generate bindings
pub static FMOD_VERSION_STRING : std::sync::LazyLock <String> =
  std::sync::LazyLock::new (|| version_string (FMOD_VERSION));

pub (crate) macro fmod_result {
  ($e:expr) => {{
    match $e {
      $crate::ll::FMOD_RESULT_FMOD_OK => Ok (()),
      err => Err ($crate::Error::from_ll (err))
    }
  }}
}

pub mod vector {
  use crate::ll;
  pub const fn from_ll (vector : ll::FMOD_VECTOR) -> [f32; 3] {
    [vector.x, vector.y, vector.z]
  }
  pub const fn to_ll (vector : [f32; 3]) -> ll::FMOD_VECTOR {
    ll::FMOD_VECTOR { x: vector[0], y: vector[1], z: vector[2] }
  }
}

pub (crate) fn version_string (fmod_version : u32) -> String {
  format!("{:x}.{:x}.{:x}",
    (fmod_version & 0xffff_0000) >> 16,
    (fmod_version & 0x0000_ff00) >> 8,
    (fmod_version & 0x0000_00ff))
}