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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

use super::note::NoteModificationType;
use crate::context::{generate_id, Dynamic};
use amm_internal::amm_prelude::*;
use amm_macros::{JsonDeserialize, JsonSerialize, ModOrder};

/// Represents a type of modification to a chord.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, ModOrder, JsonDeserialize, JsonSerialize)]
pub enum ChordModificationType {
  /// ![Accent](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/accent.png)
  #[default]
  Accent,
  /// ![Arpeggiate](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/arpeggiate.png)
  Arpeggiate,
  /// ![Detached Legato](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/detached-legato.png)
  DetachedLegato,
  /// ![Down Bow](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/down-bow.png)
  DownBow,
  /// Represents a dynamic change that only affects the current chord.
  Dynamic { dynamic: Dynamic },
  /// ![Fermata](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/fermata.png)
  Fermata,
  /// ![Fingernails](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/fingernails.png)
  Fingernails,
  /// ![Half Muted](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/half-muted.png)
  HalfMuted,
  /// Open: <span class="smufl">&#xE5EB;</span>
  ///
  /// Half: <span class="smufl">&#xE5E9;</span>
  ///
  /// Closed: <span class="smufl">&#xE5E8;</span>
  HarmonMute { open: bool, half: bool },
  /// ![Heel](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/heel.png)
  Heel,
  /// ![Marcato](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/accent.png)
  Marcato,
  /// ![Non-Arpeggiate](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/non-arpeggiate.png)
  NonArpeggiate,
  /// ![Open](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/open.png)
  Open,
  /// ![Pizzicato](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/snap-pizzicato.png)
  Pizzicato,
  /// ![Sforzando](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/sfz.png)
  Sforzando,
  /// ![Smear](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/smear.png)
  Smear,
  /// ![Soft Accent](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/soft-accent.png)
  SoftAccent,
  /// ![Spiccato](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/spiccato.png)
  Spiccato,
  /// ![Staccato](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/staccato.png)
  Staccato,
  /// ![Staccatissimo](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/staccatissimo.png)
  Staccatissimo,
  /// ![Stress](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/stress.png)
  Stress,
  /// ![Tenuto](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/tenuto.png)
  Tenuto,
  /// ![Tie](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/tied.png)
  Tie,
  /// ![Toe](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/toe.png)
  Toe,
  /// ![Tremolo](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/tremolo.png)
  Tremolo { relative_speed: u8 },
  /// ![Unstress](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/unstress.png)
  Unstress,
  /// ![Upbow](https://hedgetechllc.github.io/amm-sdk/amm_sdk/images/up-bow.png)
  UpBow,
}

/// Represents a modification to a chord.
#[derive(Debug, Default, Eq, JsonDeserialize, JsonSerialize)]
pub struct ChordModification {
  /// The unique identifier for this modification.
  id: usize,
  /// The type of chord modification.
  pub r#type: ChordModificationType,
}

impl ChordModification {
  /// Creates a new chord modification based on the given type.
  #[must_use]
  pub fn new(r#type: ChordModificationType) -> Self {
    Self {
      id: generate_id(),
      r#type,
    }
  }

  /// Creates a new chord modification based on the given
  /// note modification type.
  ///
  /// Many note modifications have direct corresponding
  /// chord modifications, and this function provides a
  /// convenient way to convert between the two.
  ///
  /// Returns `None` if the note modification type does
  /// not have a corresponding chord modification type.
  #[must_use]
  pub fn from_note_modification(r#type: &NoteModificationType) -> Option<Self> {
    match *r#type {
      NoteModificationType::Accent => Some(ChordModificationType::Accent),
      NoteModificationType::DetachedLegato => Some(ChordModificationType::DetachedLegato),
      NoteModificationType::DownBow => Some(ChordModificationType::DownBow),
      NoteModificationType::Dynamic { dynamic } => Some(ChordModificationType::Dynamic { dynamic }),
      NoteModificationType::Fermata => Some(ChordModificationType::Fermata),
      NoteModificationType::Fingernails => Some(ChordModificationType::Fingernails),
      NoteModificationType::HalfMuted => Some(ChordModificationType::HalfMuted),
      NoteModificationType::HarmonMute { open, half } => Some(ChordModificationType::HarmonMute { open, half }),
      NoteModificationType::Heel => Some(ChordModificationType::Heel),
      NoteModificationType::Marcato => Some(ChordModificationType::Marcato),
      NoteModificationType::Open => Some(ChordModificationType::Open),
      NoteModificationType::Pizzicato => Some(ChordModificationType::Pizzicato),
      NoteModificationType::Sforzando => Some(ChordModificationType::Sforzando),
      NoteModificationType::Smear => Some(ChordModificationType::Smear),
      NoteModificationType::SoftAccent => Some(ChordModificationType::SoftAccent),
      NoteModificationType::Spiccato => Some(ChordModificationType::Spiccato),
      NoteModificationType::Staccato => Some(ChordModificationType::Staccato),
      NoteModificationType::Staccatissimo => Some(ChordModificationType::Staccatissimo),
      NoteModificationType::Stress => Some(ChordModificationType::Stress),
      NoteModificationType::Tenuto => Some(ChordModificationType::Tenuto),
      NoteModificationType::Toe => Some(ChordModificationType::Toe),
      NoteModificationType::Tremolo { relative_speed } => Some(ChordModificationType::Tremolo { relative_speed }),
      NoteModificationType::Unstress => Some(ChordModificationType::Unstress),
      NoteModificationType::UpBow => Some(ChordModificationType::UpBow),
      _ => None,
    }
    .map(|mod_type| Self {
      id: generate_id(),
      r#type: mod_type,
    })
  }

  /// Returns the unique identifier for this modification.
  #[must_use]
  pub fn get_id(&self) -> usize {
    self.id
  }
}

impl Clone for ChordModification {
  fn clone(&self) -> Self {
    Self {
      id: generate_id(),
      r#type: self.r#type,
    }
  }
}

impl PartialEq for ChordModification {
  fn eq(&self, other: &Self) -> bool {
    self.r#type == other.r#type
  }
}

impl Ord for ChordModification {
  fn cmp(&self, other: &Self) -> core::cmp::Ordering {
    self.r#type.cmp(&other.r#type)
  }
}

impl PartialOrd for ChordModification {
  fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
    Some(self.cmp(other))
  }
}

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

#[cfg(feature = "print")]
impl core::fmt::Display for ChordModificationType {
  fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
    match self {
      Self::Accent => write!(f, "Accent"),
      Self::Arpeggiate => write!(f, "Arpeggiate"),
      Self::DetachedLegato => write!(f, "Detached Legato"),
      Self::DownBow => write!(f, "Down Bow"),
      Self::Dynamic { dynamic } => write!(f, "Dynamic: {dynamic}"),
      Self::Fermata => write!(f, "Fermata"),
      Self::Fingernails => write!(f, "Fingernails"),
      Self::HalfMuted => write!(f, "Half Muted"),
      Self::HarmonMute { open, half } => write!(
        f,
        "Harmon Mute: {}{}",
        if *half { "Half-" } else { "Fully " },
        if *open { "Open" } else { "Closed" },
      ),
      Self::Heel => write!(f, "Heel"),
      Self::Marcato => write!(f, "Marcato"),
      Self::NonArpeggiate => write!(f, "Non-Arpeggiate"),
      Self::Open => write!(f, "Open"),
      Self::Pizzicato => write!(f, "Pizzicato"),
      Self::Sforzando => write!(f, "Sforzando"),
      Self::Smear => write!(f, "Smear"),
      Self::SoftAccent => write!(f, "Soft Accent"),
      Self::Spiccato => write!(f, "Spiccato"),
      Self::Staccato => write!(f, "Staccato"),
      Self::Staccatissimo => write!(f, "Staccatissimo"),
      Self::Stress => write!(f, "Stress"),
      Self::Tenuto => write!(f, "Tenuto"),
      Self::Tie => write!(f, "Tied"),
      Self::Toe => write!(f, "Toe"),
      Self::Tremolo { relative_speed } => write!(f, "Tremolo: {relative_speed}x speed"),
      Self::Unstress => write!(f, "Unstress"),
      Self::UpBow => write!(f, "Up Bow"),
    }
  }
}