staff 0.11.0

Music theory library with midi, notes, chords, scales, and more
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

//! Format trait to adjust `fmt::Display` output

use crate::{midi::MidiNote, set::IntervalSet, Chord, Interval};
use core::fmt;
use core::fmt::{Display, Write};

/// ```
/// use staff::{midi, Chord, Format};
///
/// let chord = Chord::minor(midi!(C, 4));
/// let s = format!("{}", chord.into_fmt().show_octave(true));
/// assert_eq!(s, "C4m")
/// ```
pub trait Format {
    fn into_fmt(self) -> Formatter<Self>
    where
        Self: Sized,
    {
        Formatter {
            t: self,
            show_octave: false,
        }
    }

    fn fmt_with_octave(&self, f: &mut fmt::Formatter, show_octave: bool) -> fmt::Result;
}

impl<T: Format> Format for &T {
    fn fmt_with_octave(&self, f: &mut fmt::Formatter, show_octave: bool) -> fmt::Result {
        (*self).fmt_with_octave(f, show_octave)
    }
}

pub struct Formatter<T> {
    t: T,
    show_octave: bool,
}

impl<T> Formatter<T> {
    pub fn show_octave(mut self, show_octave: bool) -> Self {
        self.show_octave = show_octave;
        self
    }
}

impl<T: Format> fmt::Display for Formatter<T> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        self.t.fmt_with_octave(f, self.show_octave)
    }
}

impl Format for MidiNote {
    fn fmt_with_octave(&self, f: &mut fmt::Formatter, show_octave: bool) -> fmt::Result {
        self.pitch().fmt(f)?;

        if show_octave {
            self.octave().fmt(f)
        } else {
            Ok(())
        }
    }
}

impl Format for Chord {
    fn fmt_with_octave(&self, f: &mut fmt::Formatter, show_octave: bool) -> fmt::Result {
        self.root.fmt_with_octave(f, show_octave)?;

        let mut intervals: IntervalSet = self.clone().intervals().collect();

        if intervals.maybe_remove(Interval::MAJOR_THIRD).is_none() {
            if intervals.maybe_remove(Interval::MINOR_THIRD).is_some() {
                f.write_char('m')?
            } else if intervals.maybe_remove(Interval::MAJOR_SECOND).is_some() {
                f.write_str("sus2")?
            } else if intervals.maybe_remove(Interval::PERFECT_FOURTH).is_some() {
                f.write_str("sus4")?
            }
        }

        let mut has_fifth = true;
        if intervals.maybe_remove(Interval::TRITONE).is_some() {
            f.write_str("b5")?
        } else if intervals.maybe_remove(Interval::PERFECT_FIFTH).is_none() {
            has_fifth = false;
        }

        if intervals.maybe_remove(Interval::MINOR_SEVENTH).is_some() {
            if intervals.maybe_remove(Interval::MAJOR_NINTH).is_some() {
                if intervals.maybe_remove(Interval::MINOR_ELEVENTH).is_some() {
                    if intervals.maybe_remove(Interval::MINOR_THIRTEENTH).is_some() {
                        f.write_str("13")?
                    } else {
                        f.write_str("11")?
                    }
                } else {
                    f.write_str("9")?
                }
            } else {
                f.write_str("7")?
            }
        } else if intervals.maybe_remove(Interval::MAJOR_SEVENTH).is_some() {
            if intervals.maybe_remove(Interval::MAJOR_NINTH).is_some() {
                if intervals.maybe_remove(Interval::MAJOR_ELEVENTH).is_some() {
                    if intervals.maybe_remove(Interval::MAJOR_THIRTEENTH).is_some() {
                        f.write_str("maj13")?
                    } else {
                        f.write_str("maj11")?
                    }
                } else {
                    f.write_str("maj9")?
                }
            } else {
                f.write_str("maj7")?
            }
        }

        if let Some(bass) = self.bass {
            f.write_char('/')?;
            bass.fmt_with_octave(f, show_octave)?;
        }

        if !intervals.maybe_remove(Interval::UNISON).is_some() {
            f.write_str("(no root)")?
        }

        if !has_fifth {
            f.write_str("(no5)")?
        }

        for alteration in intervals {
            write!(f, "(add{})", alteration)?;
        }

        Ok(())
    }
}