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
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

use amm_internal::amm_prelude::*;
use amm_macros::{JsonDeserialize, JsonSerialize};
#[cfg(target_arch = "wasm32")]
use wasm_bindgen::prelude::*;

/// Represents the symbol used to designate a clef.
///
/// Note that the same symbol can be used for different clef types.
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, JsonDeserialize, JsonSerialize)]
pub enum ClefSymbol {
  /// ![G Clef](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/g-clef.png)
  #[default]
  GClef,
  /// ![C Clef](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/c-clef.png)
  CClef,
  /// ![F Clef](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/f-clef.png)
  FClef,
}

/// Designates the meaning of a clef.
///
/// A clef is used to determine the pitches for the notes on a staff.
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, JsonDeserialize, JsonSerialize)]
pub enum ClefType {
  /// Designates that pitch G4 is located on the second line from the bottom of the staff.
  #[default]
  Treble,
  /// Designates that pitch F3 is located on the second line from the top of the staff.
  Bass,
  /// Designates that pitch G4 is located on the bottom line of the staff.
  FrenchViolin,
  /// Designates that pitch F3 is located on the top line of the staff.
  Subbass,
  /// Designates that pitch C4 is located on the second line from the top of the staff.
  Tenor,
  /// Designates that pitch C4 is located on the middle line of the staff.
  Alto,
  /// Designates that pitch C4 is located on the bottom line of the staff.
  Soprano,
  /// Designates that pitch C4 is located on the second line from the bottom of the staff.
  MezzoSoprano,
  /// Designates that pitch C4 is located on the top line of the staff.
  Baritone,
}

/// Represents a clef which is used to determine the pitches for the notes on a staff.
#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, JsonDeserialize, JsonSerialize)]
pub struct Clef {
  /// The symbol used to designate the clef.
  pub symbol: ClefSymbol,
  /// The meaning of the clef.
  pub clef_type: ClefType,
}

#[cfg_attr(target_arch = "wasm32", wasm_bindgen)]
impl Clef {
  /// Creates a new clef with the given type and optional symbol.
  ///
  /// If the `symbol` parameter is `None`, the most common symbol for the
  /// given `clef_type` will be used instead.
  #[must_use]
  pub fn new(clef_type: ClefType, symbol: Option<ClefSymbol>) -> Self {
    Self {
      symbol: match clef_type {
        ClefType::Treble | ClefType::FrenchViolin => ClefSymbol::GClef,
        ClefType::Bass | ClefType::Subbass => ClefSymbol::FClef,
        ClefType::Tenor | ClefType::Alto | ClefType::Soprano | ClefType::MezzoSoprano => ClefSymbol::CClef,
        ClefType::Baritone => symbol.unwrap_or(ClefSymbol::CClef),
      },
      clef_type,
    }
  }
}

impl core::fmt::Display for ClefSymbol {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(
      f,
      "{}",
      match self {
        Self::GClef => "G-Clef",
        Self::CClef => "C-Clef",
        Self::FClef => "F-Clef",
      }
    )
  }
}

#[cfg(feature = "print")]
impl core::fmt::Display for ClefType {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(
      f,
      "{}",
      match self {
        Self::Treble => "Treble",
        Self::Bass => "Bass",
        Self::FrenchViolin => "French Violin",
        Self::Subbass => "Subbass",
        Self::Tenor => "Tenor",
        Self::Alto => "Alto",
        Self::Soprano => "Soprano",
        Self::MezzoSoprano => "Mezzo Soprano",
        Self::Baritone => "Baritone",
      }
    )
  }
}

#[cfg(feature = "print")]
impl core::fmt::Display for Clef {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    write!(f, "{}", self.clef_type)
  }
}