ffmml 0.1.0

Famicon (a.k.a. NES) Flavored Music Macro Language
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

use crate::{
    comment::CommentsOrWhitespaces,
    types::{Int, NoteEnvelope, PitchEnvelope, Timbres, Vibrato, VolumeEnvelope},
};
use std::collections::BTreeMap;
use textparse::{
    components::{Char, Empty, Str},
    Parse, Parser, Span,
};

#[derive(Debug, Default, Clone)]
pub struct Macros {
    pub volumes: BTreeMap<MacroNumber, VolumeMacro>,
    pub timbres: BTreeMap<MacroNumber, TimbreMacro>,
    pub pitches: BTreeMap<MacroNumber, PitchMacro>,
    pub arpeggios: BTreeMap<MacroNumber, ArpeggioMacro>,
    pub vibratos: BTreeMap<MacroNumber, VibratoMacro>,
}

impl Macros {
    pub fn parse(&mut self, parser: &mut Parser) -> Option<()> {
        while parser.peek_char() == Some('@') {
            if let Some(m) = parser.parse::<VolumeMacro>() {
                self.volumes.insert(m.number(), m);
            } else if let Some(m) = parser.parse::<TimbreMacro>() {
                self.timbres.insert(m.number(), m);
            } else if let Some(m) = parser.parse::<PitchMacro>() {
                self.pitches.insert(m.number(), m);
            } else if let Some(m) = parser.parse::<ArpeggioMacro>() {
                self.arpeggios.insert(m.number(), m);
            } else if let Some(m) = parser.parse::<VibratoMacro>() {
                self.vibratos.insert(m.number(), m);
            } else {
                return None;
            }
            let _: CommentsOrWhitespaces = parser.parse()?;
        }
        Some(())
    }
}

#[derive(Debug, Clone, Copy, Span, Parse)]
pub struct MacroNumber(Int<0, 127>);

impl PartialEq for MacroNumber {
    fn eq(&self, other: &Self) -> bool {
        self.0.get() == other.0.get()
    }
}

impl Eq for MacroNumber {}

impl PartialOrd for MacroNumber {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        self.0.get().partial_cmp(&other.0.get())
    }
}

impl Ord for MacroNumber {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.0.get().cmp(&other.0.get())
    }
}

#[derive(Debug, Clone, Span, Parse)]
struct MacroKey<Prefix> {
    _at: Char<'@'>,
    _prefix: Prefix,
    number: MacroNumber,
    _space0: CommentsOrWhitespaces,
    _equal: Char<'='>,
    _space1: CommentsOrWhitespaces,
}

#[derive(Debug, Clone, Span, Parse)]
pub struct VolumeMacro {
    key: MacroKey<Char<'v'>>,
    envelope: VolumeEnvelope,
}

impl VolumeMacro {
    pub fn number(&self) -> MacroNumber {
        self.key.number
    }

    pub fn envelope(&self) -> &VolumeEnvelope {
        &self.envelope
    }
}

#[derive(Debug, Clone, Span, Parse)]
pub struct PitchMacro {
    key: MacroKey<Str<'E', 'P'>>,
    envelope: PitchEnvelope,
}

impl PitchMacro {
    pub fn number(&self) -> MacroNumber {
        self.key.number
    }

    pub fn envelope(&self) -> &PitchEnvelope {
        &self.envelope
    }
}

#[derive(Debug, Clone, Span, Parse)]
pub struct ArpeggioMacro {
    key: MacroKey<Str<'E', 'N'>>,
    envelope: NoteEnvelope,
}

impl ArpeggioMacro {
    pub fn number(&self) -> MacroNumber {
        self.key.number
    }

    pub fn envelope(&self) -> &NoteEnvelope {
        &self.envelope
    }
}

#[derive(Debug, Clone, Span, Parse)]
pub struct TimbreMacro {
    key: MacroKey<Empty>,
    timbres: Timbres,
}

impl TimbreMacro {
    pub fn number(&self) -> MacroNumber {
        self.key.number
    }

    pub fn timbres(&self) -> &Timbres {
        &self.timbres
    }
}

#[derive(Debug, Clone, Span, Parse)]
pub struct VibratoMacro {
    key: MacroKey<Str<'M', 'P'>>,
    vibrato: Vibrato,
}

impl VibratoMacro {
    pub fn number(&self) -> MacroNumber {
        self.key.number
    }

    pub fn vibrato(&self) -> &Vibrato {
        &self.vibrato
    }
}