amm_sdk 0.4.0

Abstract Music Manipulation (AMM) Rust SDK
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

use amm_internal::amm_prelude::*;
use amm_macros::{JsonDeserialize, JsonSerialize};

/// Represents a dynamic marking in music notation.
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, JsonDeserialize, JsonSerialize)]
pub enum Dynamic {
  /// ![Forte](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/forte.png)
  ///
  /// The magnitude of the dynamic marking is specified by the `u8` value.
  /// For example, `Forte(3)` represents a dynamic marking of `fff`.
  Forte(u8),
  #[default]
  /// ![Mezzo Forte](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/mezzo-forte.png)
  MezzoForte,
  /// ![Mezzo Piano](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/mezzo-piano.png)
  MezzoPiano,
  /// ![Piano](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/piano.png)
  ///
  /// The magnitude of the dynamic marking is specified by the `u8` value.
  /// For example, `Piano(3)` represents a dynamic marking of `ppp`.
  Piano(u8),
}

impl Dynamic {
  /// Returns the relative loudness of the dynamic marking in the range `[0.0, 1.0]`.
  #[must_use]
  pub fn value(&self) -> f32 {
    match *self {
      Self::Piano(magnitude) => (0.5 - (0.1 * f32::from(magnitude))).max(0.05),
      Self::MezzoPiano => 0.45,
      Self::MezzoForte => 0.55,
      Self::Forte(magnitude) => (0.5 + (0.1 * f32::from(magnitude))).min(1.0),
    }
  }
}

#[cfg(feature = "print")]
impl core::fmt::Display for Dynamic {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    match *self {
      Self::Piano(magnitude) => write!(f, "{}", "p".repeat(usize::from(magnitude))),
      Self::MezzoPiano => write!(f, "mp"),
      Self::MezzoForte => write!(f, "mf"),
      Self::Forte(magnitude) => write!(f, "{}", "f".repeat(usize::from(magnitude))),
    }
  }
}