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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
use byteorder::{BigEndian, WriteBytesExt};
use formats::*;
use messages::*;
use std::io::Write;
use std::{fs, io, path};

/// `ghakuf`'s SMF builder.
///
/// This builds SMF by Message enums and write out. Message enum consists of MetaEvent, MidiEvent, SysExEvent, and TrackChange. You can use running status if you want. At track change, you should use not only MetaEvent::EndOfTrack message, but also TrackChange message.
///
/// # Examples
///
/// ```
/// use ghakuf::messages::*;
/// use ghakuf::writer::*;
/// use std::path;
///
/// let path = path::Path::new("tests/writer_doctest.mid");
/// let tempo: u32 = 60 * 1000000 / 102; //bpm:102
/// let mut messages: Vec<Message> = vec![
///     Message::MetaEvent {
///         delta_time: 0,
///         event: MetaEvent::SetTempo,
///         data: [(tempo >> 16) as u8, (tempo >> 8) as u8, tempo as u8].to_vec(),
///     },
///     Message::MetaEvent {
///         delta_time: 0,
///         event: MetaEvent::EndOfTrack,
///         data: Vec::new(),
///     },
///     Message::TrackChange,
///     Message::MidiEvent {
///         delta_time: 0,
///         event: MidiEvent::NoteOn { ch: 0, note: 0x3c, velocity: 0x7f },
///     },
///     Message::MidiEvent {
///         delta_time: 192,
///         event: MidiEvent::NoteOn { ch: 0, note: 0x40, velocity: 0 },
///     },
///     Message::MetaEvent {
///         delta_time: 0,
///         event: MetaEvent::EndOfTrack,
///         data: Vec::new(),
///     }
/// ];
///
/// let mut writer = Writer::new();
/// writer.running_status(true);
/// for message in &messages {
///     writer.push(&message);
/// }
/// writer.write(&path);
/// ```
pub struct Writer<'a> {
    messages: Vec<&'a Message>,
    format: Format,
    time_base: u16,
    running_status: bool,
}
impl<'a> Writer<'a> {
    /// Builds Writer with initial value.
    ///
    /// | Writer's member | type | initial value |
    /// |:---|:---|:---|
    /// | messages | Vec\<&'a ghakuf::messages::Message\> | Vec::new() |
    /// | format | ghakuf::formats::Format | ghakuf::formats::Format::F1 |
    /// | time_base | u16 | 480 |
    /// | running_status | bool | false |
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::writer::Writer;
    ///
    /// let writer: Writer = Writer::new();
    /// ```
    pub fn new() -> Writer<'a> {
        Writer {
            messages: Vec::new(),
            format: Format::F1,
            time_base: 480,
            running_status: false,
        }
    }
    /// Returns keeping messages by borrowing.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::messages::Message;
    /// use ghakuf::writer::Writer;
    ///
    /// let message = Message::TrackChange;
    /// let mut writer: Writer = Writer::new();
    /// writer.push(&message);
    /// assert_eq!(*writer.messages(), vec![&message]);
    /// ```
    pub fn messages(&self) -> &Vec<&'a Message> {
        &self.messages
    }
    /// Pushes message to writer.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::messages::{Message, MidiEvent};
    /// use ghakuf::writer::Writer;
    ///
    /// let message = Message::MidiEvent {
    ///     delta_time: 0,
    ///     event: MidiEvent::NoteOn { ch: 0, note: 0x40, velocity: 0 },
    /// };
    /// let mut writer: Writer = Writer::new();
    /// writer.push(&message);
    /// ```
    pub fn push(&mut self, message: &'a Message) {
        self.messages.push(message);
    }
    /// Removes message from writer.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::messages::{Message, MetaEvent, MidiEvent};
    /// use ghakuf::writer::Writer;
    ///
    /// let mut messages_a: Vec<Message> = vec![
    ///     Message::MidiEvent {
    ///         delta_time: 0,
    ///         event: MidiEvent::NoteOn { ch: 0, note: 0x40, velocity: 0 },
    ///     },
    ///     Message::TrackChange,
    ///     Message::MetaEvent {
    ///         delta_time: 0,
    ///         event: MetaEvent::EndOfTrack,
    ///         data: Vec::new(),
    ///     }
    /// ];
    /// let mut writer: Writer = Writer::new();
    /// for message in &messages_a {
    ///     writer.push(&message);
    /// }
    /// writer.remove(1);
    /// assert_eq!(*writer.messages()[0], Message::MidiEvent {
    ///     delta_time: 0,
    ///     event: MidiEvent::NoteOn { ch: 0, note: 0x40, velocity: 0 },
    /// });
    /// assert_eq!(*writer.messages()[1], Message::MetaEvent {
    ///     delta_time: 0,
    ///     event: MetaEvent::EndOfTrack,
    ///     data: Vec::new(),
    /// });
    /// ```
    pub fn remove(&mut self, index: usize) -> &'a Message {
        self.messages.remove(index)
    }
    /// Sets SMF format value (Format 0, Format 1 or Format 2) by formats::Format::*.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::writer::Writer;
    ///
    /// let mut writer: Writer = Writer::new();
    /// writer.format(0);
    /// ```
    pub fn format(&mut self, format: u16) -> &mut Writer<'a> {
        self.format = Format::new(format);
        self
    }
    /// Sets SMF time base value.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::writer::Writer;
    ///
    /// let mut writer: Writer = Writer::new();
    /// writer.time_base(960);
    /// ```
    pub fn time_base(&mut self, time_base: u16) -> &mut Writer<'a> {
        self.time_base = time_base;
        self
    }
    /// Sets bool value whether you adopt running statusor not.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::writer::Writer;
    ///
    /// let mut writer: Writer = Writer::new();
    /// writer.running_status(true);
    /// ```
    pub fn running_status(&mut self, running_status: bool) -> &mut Writer<'a> {
        self.running_status = running_status;
        self
    }
    /// Writes out SMF messages you stored.
    ///
    /// # Examples
    ///
    /// ```
    /// use ghakuf::messages::*;
    /// use ghakuf::writer::*;
    /// use std::path;
    ///
    /// let path = path::Path::new("tests/writer_write_doctest.mid");
    /// let tempo: u32 = 60 * 1000000 / 102; //bpm:102
    /// let mut messages: Vec<Message> = vec![
    ///     Message::MetaEvent {
    ///         delta_time: 0,
    ///         event: MetaEvent::SetTempo,
    ///         data: [(tempo >> 16) as u8, (tempo >> 8) as u8, tempo as u8].to_vec(),
    ///     },
    ///     Message::MetaEvent {
    ///         delta_time: 0,
    ///         event: MetaEvent::EndOfTrack,
    ///         data: Vec::new(),
    ///     },
    ///     Message::TrackChange,
    ///     Message::MidiEvent {
    ///         delta_time: 0,
    ///         event: MidiEvent::NoteOn { ch: 0, note: 0x3c, velocity: 0x7f },
    ///     },
    ///     Message::MetaEvent {
    ///         delta_time: 0,
    ///         event: MetaEvent::EndOfTrack,
    ///         data: Vec::new(),
    ///     }
    /// ];
    ///
    /// let mut writer = Writer::new();
    /// for message in &messages {
    ///     writer.push(&message);
    /// }
    /// writer.write(&path);
    /// ```
    pub fn write(&self, path: &path::Path) -> Result<(), io::Error> {
        info!("start writing at {:?}", path);
        let mut file = io::BufWriter::new(
            fs::OpenOptions::new()
                .write(true)
                .truncate(true)
                .create(true)
                .open(path)?,
        );
        file.write(Tag::Header.binary())?;
        file.write(&[0, 0, 0, 6])?;
        file.write(&self.format.binary())?;
        file.write_u16::<BigEndian>(self.track_number())?;
        file.write_u16::<BigEndian>(self.time_base)?;
        let mut track_len_filo = self.track_len_filo();
        if self.messages.len() > 0 && *self.messages[0] != Message::TrackChange {
            file.write(&Message::TrackChange.binary())?;
            file.write_u32::<BigEndian>(track_len_filo.pop().unwrap() as u32)?;
        }
        let mut pre_status_byte: Option<u8> = None;
        for message in &self.messages {
            match **message {
                Message::TrackChange => {
                    file.write(&Message::TrackChange.binary())?;
                    file.write_u32::<BigEndian>(track_len_filo.pop().unwrap() as u32)?;
                    pre_status_byte = None;
                    info!("wrote track change");
                }
                Message::MidiEvent {
                    delta_time,
                    ref event,
                    ..
                } => {
                    let delta_time = VLQ::new(delta_time);
                    let tmp_status_byte = (*event).status_byte();
                    match pre_status_byte {
                        Some(pre_status_byte) if pre_status_byte == tmp_status_byte => {
                            let tmp_message = message.binary();
                            file.write(&tmp_message[0..delta_time.len()])?;
                            file.write(&message.binary()[delta_time.len() + 1..])?;
                            info!("wrote some message with running status");
                        }
                        _ => {
                            file.write(&message.binary())?;
                            info!("wrote some message");
                            if self.running_status {
                                pre_status_byte = Some(tmp_status_byte);
                            }
                        }
                    };
                }
                _ => {
                    file.write(&message.binary())?;
                    info!("wrote some message");
                }
            }
        }
        Ok(file.flush()?)
    }
    fn track_len_filo(&self) -> Vec<usize> {
        // First In Last Out
        let mut tracks_len: Vec<usize> = vec![0];
        let mut pre_status_byte: Option<u8> = None;
        for message in &self.messages {
            match **message {
                Message::TrackChange => {
                    tracks_len.insert(0, 0);
                    pre_status_byte = None;
                }
                Message::MidiEvent { ref event, .. } => {
                    tracks_len[0] += message.len();
                    let tmp_status_byte = (*event).status_byte();
                    match pre_status_byte {
                        Some(pre_status_byte) if pre_status_byte == tmp_status_byte => {
                            tracks_len[0] -= 1;
                        }
                        _ => {
                            if self.running_status {
                                pre_status_byte = Some(tmp_status_byte);
                            }
                        }
                    };
                }
                _ => {
                    tracks_len[0] += message.len();
                }
            }
        }
        tracks_len
    }
    fn track_number(&self) -> u16 {
        let mut number = if self.messages.len() > 0 && *self.messages[0] != Message::TrackChange {
            1
        } else {
            0
        };
        for message in &self.messages {
            number += match **message {
                Message::TrackChange => 1,
                _ => 0,
            };
        }
        number
    }
}