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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
#![macro_use]
use super::event::*;
use super::event_stream::*;
use super::filter_trait::*;

/// Collections of filters that are run either in sequence or in parallel.
///
/// See the [Chain!] and [Fork!] macros.
pub struct FilterChain<'a> {
    // lifetime: https://www.reddit.com/r/rust/comments/30ehed/why_must_this_reference_have_a_static_lifetime/
    filters: Vec<Box<dyn FilterTrait + 'a>>,
    connection: ConnectionType,
}

impl<'a> FilterChain<'a> {
    pub fn new(connection: ConnectionType, filters: Vec<Box<dyn FilterTrait + 'a>>) -> Self {
        FilterChain { filters, connection, }
    }

    fn run_chain(&self, evs: &mut EventStream, method: &dyn Fn(&Box<dyn FilterTrait + 'a>, &mut EventStream)) {
        // Run each filter consequetively. Since they mutate evs, this
        // means each filter is run on top of the changes of the previous.
        for f in self.filters.iter() {
            method(&f, evs);
        }
    }

    fn run_fork(&self, evs: &mut EventStream, method: &dyn Fn(&Box<dyn FilterTrait + 'a>, &mut EventStream)) {
        // Run each filter over the original evs and gather all events
        // into a single EventStream.
        // TODO allocate full size of events_out
        // TODO don't clone for first/last filter (can do when running last) ...
        // TODO ... or repeat evs filters.size times, and run on each slice.
        let mut events_out = Vec::<Event>::new();
        for f in self.filters.iter() {
            let mut evs_this = evs.clone();
            method(&f, &mut evs_this);
            events_out.extend(evs_this);
        }
        evs.clear();
        evs.extend(events_out);
        evs.dedup();
    }
}

fn run_single<'a>(f: &Box<dyn FilterTrait + 'a>, evs: &mut EventStream) {
    f.run(evs)
}
fn run_inverse_single<'a>(f: &Box<dyn FilterTrait + 'a>, evs: &mut EventStream) {
    f.run_inverse(evs)
}

impl<'a> FilterTrait for FilterChain<'a> {
    fn run(&self, evs: &mut EventStream) {
        match self.connection {
            ConnectionType::Chain => self.run_chain(evs, &run_single),
            ConnectionType::Fork => self.run_fork(evs, &run_single),
        }
    }

    fn run_inverse(&self, evs: &mut EventStream) {
        match self.connection {
            ConnectionType::Chain => self.run_fork(evs, &run_inverse_single),
            ConnectionType::Fork => self.run_chain(evs, &run_inverse_single),
        }
    }

    fn run_init(&self, evs: &mut EventStream) {
        for f in self.filters.iter() {
            f.run_init(evs);
        }
    }

    fn run_exit(&self, evs: &mut EventStream) {
        for f in self.filters.iter() {
            f.run_exit(evs);
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum ConnectionType {
    Chain,
    Fork,
}

// Connecting filters

/// Adds multiple filters in a chain.
///
/// This means that each filter is run in sequence. When filtering,
/// this means each event needs to be let through by each of the filters.
///
/// # Examples
///
/// ```
/// # #[macro_use] extern crate rmididings;
/// # use rmididings::proc::*;
/// # fn main() {
/// let chain = Chain!(ChannelFilter(1), KeyFilter(60));
///
/// let ev1 = NoteOnEvent(0,0,60,20);
/// let ev2 = NoteOnEvent(0,0,61,20);
/// let ev3 = NoteOnEvent(0,1,60,20);
/// let ev4 = NoteOnEvent(0,1,61,20);
///
/// let mut evs = EventStream::from(vec![&ev1, &ev2, &ev3, &ev4]);
/// chain.run(&mut evs);
///
/// assert_eq!(evs, ev3);
/// # }
/// ```
///
/// TODO test inverse
#[macro_export]
macro_rules! Chain {
    ( $($f:expr),+ ) => (
        FilterChain::new(
            ConnectionType::Chain,
            vec!( $(Box::new($f)),+ )
        )
    )
}

/// Adds multiple filters in parallel.
///
/// Each event is passed to each of the filters, they are run in parallel.
/// At the end of the filter chain, duplicate events are filtered out.
///
/// # Examples
///
/// ```
/// # #[macro_use] extern crate rmididings;
/// # use rmididings::proc::*;
/// # fn main() {
/// let chain = Fork!(ChannelFilter(1), KeyFilter(60));
///
/// let ev1 = NoteOnEvent(0,0,60,20);
/// let ev2 = NoteOnEvent(0,0,61,20);
/// let ev3 = NoteOnEvent(0,1,60,20);
/// let ev4 = NoteOnEvent(0,1,61,20);
///
/// let mut evs = EventStream::from(vec![&ev1, &ev2, &ev3, &ev4]);
/// chain.run(&mut evs);
///
/// assert_eq!(evs, vec![ev3, ev4, ev1]);
/// # }
/// ```
///
/// TODO test inverse
#[macro_export]
macro_rules! Fork {
    ( $($f:expr),+ ) => (
        FilterChain::new(
            ConnectionType::Fork,
            vec!( $(Box::new($f)),+ )
        )
    )
}

#[macro_export]
macro_rules! define_filter {
    ($(#[$meta:meta])* $name:ident ( $($args:ty),* ) $item:item) => {
        $(#[$meta])*
        pub struct $name($(pub $args),*);

        impl $name {
            $item
        }

        impl FilterTrait for $name {
            fn run(&self, evs: &mut EventStream) {
                evs.retain(|ev| self.filter_single(&ev));
            }

            fn run_inverse(&self, evs: &mut EventStream) {
                evs.retain(|ev| !self.filter_single(&ev));
            }
        }
    }
}

#[macro_export]
macro_rules! define_modifier {
    ($(#[$meta:meta])* $name:ident ( $($args:ty),* ) $item:item) => {
        $(#[$meta])*
        pub struct $name($(pub $args),*);

        impl $name {
            $item
        }

        impl FilterTrait for $name {
            fn run(&self, evs: &mut EventStream) {
                for ev in evs.iter_mut() {
                    self.modify_single(ev);
                }
            }
        }
    }
}

#[macro_export]
macro_rules! define_generator {
    ($(#[$meta:meta])* $name:ident ( $($args:ty),* ) $item:item) => {
        $(#[$meta])*
        pub struct $name($(pub $args),*);

        impl $name {
            $item
        }

        impl FilterTrait for $name {
            fn run(&self, evs: &mut EventStream) {
                if evs.is_empty() { return; }

                // Generate new event
                let new_ev = self.generate_single();
                // Replace each event, keeping port and channel.
                for ev in evs.iter_mut() {
                    let mut this_new_ev = new_ev.clone();
                    if let Some(port) = ev.port() {
                        this_new_ev.set_port(port);
                    }
                    if let Some(channel) = ev.channel() {
                        this_new_ev.set_channel(channel);
                    }
                    *ev = this_new_ev;
                }
                evs.dedup();
            }
        }
    }
}