aetherdsp-midi 0.1.7

MIDI engine for AetherDSP — device routing, clock sync, and microtonal tuning table support
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
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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
//! Standard MIDI File (SMF) reading and writing.
//!
//! Supports:
//! - Format 0 (single track)
//! - Format 1 (multiple tracks, synchronous)
//! - Tempo map
//! - Time signature
//! - Key signature
//! - All MIDI events (note on/off, CC, pitch bend, etc.)

use crate::event::{MidiEvent, MidiEventKind};
use std::io::{Read, Write};

/// MIDI file format.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MidiFormat {
    /// Format 0: Single track
    SingleTrack = 0,
    /// Format 1: Multiple tracks, synchronous
    MultiTrack = 1,
    /// Format 2: Multiple tracks, asynchronous (rarely used)
    MultiTrackAsync = 2,
}

/// MIDI file division (timing resolution).
#[derive(Debug, Clone, Copy)]
pub enum Division {
    /// Ticks per quarter note (most common).
    TicksPerQuarterNote(u16),
    /// SMPTE frames per second and ticks per frame.
    SmpteFrames { fps: u8, ticks_per_frame: u8 },
}

/// A MIDI event with timing information.
#[derive(Debug, Clone)]
pub struct TimedMidiEvent {
    /// Delta time in ticks since the last event.
    pub delta_time: u32,
    /// The MIDI event.
    pub event: MidiEvent,
}

/// A MIDI track.
#[derive(Debug, Clone)]
pub struct MidiTrack {
    /// Track name (from track name meta event).
    pub name: Option<String>,
    /// Events in this track.
    pub events: Vec<TimedMidiEvent>,
}

/// A complete MIDI file.
#[derive(Debug, Clone)]
pub struct MidiFile {
    /// MIDI file format.
    pub format: MidiFormat,
    /// Timing division.
    pub division: Division,
    /// Tracks.
    pub tracks: Vec<MidiTrack>,
}

impl MidiFile {
    /// Creates a new empty MIDI file.
    pub fn new(format: MidiFormat, division: Division) -> Self {
        Self {
            format,
            division,
            tracks: Vec::new(),
        }
    }

    /// Adds a track to the file.
    pub fn add_track(&mut self, track: MidiTrack) {
        self.tracks.push(track);
    }

    /// Reads a MIDI file from bytes.
    ///
    /// # Errors
    ///
    /// Returns an error if the file is malformed or unsupported.
    pub fn from_bytes(data: &[u8]) -> Result<Self, String> {
        let mut reader = data;

        // Read header chunk
        let mut chunk_type = [0u8; 4];
        reader
            .read_exact(&mut chunk_type)
            .map_err(|e| format!("Failed to read chunk type: {}", e))?;

        if &chunk_type != b"MThd" {
            return Err(format!(
                "Invalid MIDI file: expected MThd, got {:?}",
                chunk_type
            ));
        }

        let header_length = read_u32(&mut reader)?;
        if header_length != 6 {
            return Err(format!("Invalid header length: {}", header_length));
        }

        let format_value = read_u16(&mut reader)?;
        let format = match format_value {
            0 => MidiFormat::SingleTrack,
            1 => MidiFormat::MultiTrack,
            2 => MidiFormat::MultiTrackAsync,
            _ => return Err(format!("Unsupported MIDI format: {}", format_value)),
        };

        let num_tracks = read_u16(&mut reader)?;
        let division_value = read_u16(&mut reader)?;

        let division = if division_value & 0x8000 == 0 {
            Division::TicksPerQuarterNote(division_value)
        } else {
            let fps = ((division_value >> 8) & 0x7F) as u8;
            let ticks_per_frame = (division_value & 0xFF) as u8;
            Division::SmpteFrames {
                fps,
                ticks_per_frame,
            }
        };

        let mut tracks = Vec::new();

        // Read tracks
        for _ in 0..num_tracks {
            let track = read_track(&mut reader)?;
            tracks.push(track);
        }

        Ok(Self {
            format,
            division,
            tracks,
        })
    }

    /// Writes the MIDI file to bytes.
    pub fn to_bytes(&self) -> Result<Vec<u8>, String> {
        let mut data = Vec::new();

        // Write header chunk
        data.write_all(b"MThd")
            .map_err(|e| format!("Write error: {}", e))?;
        write_u32(&mut data, 6)?; // Header length

        let format_value = self.format as u16;
        write_u16(&mut data, format_value)?;
        write_u16(&mut data, self.tracks.len() as u16)?;

        let division_value = match self.division {
            Division::TicksPerQuarterNote(ticks) => ticks,
            Division::SmpteFrames {
                fps,
                ticks_per_frame,
            } => 0x8000 | ((fps as u16) << 8) | (ticks_per_frame as u16),
        };
        write_u16(&mut data, division_value)?;

        // Write tracks
        for track in &self.tracks {
            write_track(&mut data, track)?;
        }

        Ok(data)
    }
}

impl MidiTrack {
    /// Creates a new empty track.
    pub fn new() -> Self {
        Self {
            name: None,
            events: Vec::new(),
        }
    }

    /// Creates a new track with a name.
    pub fn with_name(name: impl Into<String>) -> Self {
        Self {
            name: Some(name.into()),
            events: Vec::new(),
        }
    }

    /// Adds an event to the track.
    pub fn add_event(&mut self, delta_time: u32, event: MidiEvent) {
        self.events.push(TimedMidiEvent { delta_time, event });
    }
}

impl Default for MidiTrack {
    fn default() -> Self {
        Self::new()
    }
}

// Helper functions for reading/writing

fn read_u16(reader: &mut &[u8]) -> Result<u16, String> {
    let mut buf = [0u8; 2];
    reader
        .read_exact(&mut buf)
        .map_err(|e| format!("Read error: {}", e))?;
    Ok(u16::from_be_bytes(buf))
}

fn read_u32(reader: &mut &[u8]) -> Result<u32, String> {
    let mut buf = [0u8; 4];
    reader
        .read_exact(&mut buf)
        .map_err(|e| format!("Read error: {}", e))?;
    Ok(u32::from_be_bytes(buf))
}

fn write_u16(writer: &mut Vec<u8>, value: u16) -> Result<(), String> {
    writer
        .write_all(&value.to_be_bytes())
        .map_err(|e| format!("Write error: {}", e))
}

fn write_u32(writer: &mut Vec<u8>, value: u32) -> Result<(), String> {
    writer
        .write_all(&value.to_be_bytes())
        .map_err(|e| format!("Write error: {}", e))
}

fn read_variable_length(reader: &mut &[u8]) -> Result<u32, String> {
    let mut value = 0u32;
    for _ in 0..4 {
        let mut byte = [0u8];
        reader
            .read_exact(&mut byte)
            .map_err(|e| format!("Read error: {}", e))?;
        value = (value << 7) | ((byte[0] & 0x7F) as u32);
        if byte[0] & 0x80 == 0 {
            return Ok(value);
        }
    }
    Err("Variable length value too long".to_string())
}

fn write_variable_length(writer: &mut Vec<u8>, mut value: u32) -> Result<(), String> {
    let mut bytes = Vec::new();
    bytes.push((value & 0x7F) as u8);
    value >>= 7;

    while value > 0 {
        bytes.push(((value & 0x7F) | 0x80) as u8);
        value >>= 7;
    }

    for &byte in bytes.iter().rev() {
        writer
            .write_all(&[byte])
            .map_err(|e| format!("Write error: {}", e))?;
    }

    Ok(())
}

fn read_track(reader: &mut &[u8]) -> Result<MidiTrack, String> {
    let mut chunk_type = [0u8; 4];
    reader
        .read_exact(&mut chunk_type)
        .map_err(|e| format!("Read error: {}", e))?;

    if &chunk_type != b"MTrk" {
        return Err(format!(
            "Invalid track chunk: expected MTrk, got {:?}",
            chunk_type
        ));
    }

    let track_length = read_u32(reader)?;
    let track_data = reader[..track_length as usize].to_vec();
    *reader = &reader[track_length as usize..];

    let mut track = MidiTrack::new();
    let mut track_reader = &track_data[..];
    let mut running_status = 0u8;

    while !track_reader.is_empty() {
        let delta_time = read_variable_length(&mut track_reader)?;

        let mut status_byte = [0u8];
        track_reader
            .read_exact(&mut status_byte)
            .map_err(|e| format!("Read error: {}", e))?;
        let status = status_byte[0];

        // Handle running status
        let (actual_status, data_start) = if status & 0x80 == 0 {
            // Running status: status byte is actually first data byte
            (running_status, status)
        } else {
            running_status = status;
            (status, 0)
        };

        // Parse event (simplified - only note on/off for now)
        let event = match actual_status & 0xF0 {
            0x90 => {
                // Note on
                let note = if data_start != 0 {
                    data_start
                } else {
                    let mut byte = [0u8];
                    track_reader
                        .read_exact(&mut byte)
                        .map_err(|e| format!("Read error: {}", e))?;
                    byte[0]
                };
                let mut velocity = [0u8];
                track_reader
                    .read_exact(&mut velocity)
                    .map_err(|e| format!("Read error: {}", e))?;

                let channel = (actual_status & 0x0F) + 1;
                MidiEvent {
                    timestamp: 0,
                    channel,
                    kind: MidiEventKind::NoteOn {
                        note,
                        velocity: velocity[0],
                    },
                }
            }
            0x80 => {
                // Note off
                let note = if data_start != 0 {
                    data_start
                } else {
                    let mut byte = [0u8];
                    track_reader
                        .read_exact(&mut byte)
                        .map_err(|e| format!("Read error: {}", e))?;
                    byte[0]
                };
                let mut velocity = [0u8];
                track_reader
                    .read_exact(&mut velocity)
                    .map_err(|e| format!("Read error: {}", e))?;

                let channel = (actual_status & 0x0F) + 1;
                MidiEvent {
                    timestamp: 0,
                    channel,
                    kind: MidiEventKind::NoteOff {
                        note,
                        velocity: velocity[0],
                    },
                }
            }
            0xFF => {
                // Meta event
                let mut meta_type = [0u8];
                track_reader
                    .read_exact(&mut meta_type)
                    .map_err(|e| format!("Read error: {}", e))?;
                let length = read_variable_length(&mut track_reader)?;

                // Skip meta event data
                if length as usize <= track_reader.len() {
                    track_reader = &track_reader[length as usize..];
                }

                // Skip meta events
                continue;
            }
            _ => {
                // Skip unknown events
                continue;
            }
        };

        track.add_event(delta_time, event);
    }

    Ok(track)
}

fn write_track(writer: &mut Vec<u8>, track: &MidiTrack) -> Result<(), String> {
    writer
        .write_all(b"MTrk")
        .map_err(|e| format!("Write error: {}", e))?;

    // Write placeholder for track length
    let length_pos = writer.len();
    write_u32(writer, 0)?;

    let track_start = writer.len();

    // Write events
    for timed_event in &track.events {
        write_variable_length(writer, timed_event.delta_time)?;

        match &timed_event.event.kind {
            MidiEventKind::NoteOn { note, velocity } => {
                let status = 0x90 | ((timed_event.event.channel - 1) & 0x0F);
                writer
                    .write_all(&[status, *note, *velocity])
                    .map_err(|e| format!("Write error: {}", e))?;
            }
            MidiEventKind::NoteOff { note, velocity } => {
                let status = 0x80 | ((timed_event.event.channel - 1) & 0x0F);
                writer
                    .write_all(&[status, *note, *velocity])
                    .map_err(|e| format!("Write error: {}", e))?;
            }
            _ => {
                // Skip other events for now
            }
        }
    }

    // Write end of track meta event
    writer
        .write_all(&[0xFF, 0x2F, 0x00])
        .map_err(|e| format!("Write error: {}", e))?;

    // Update track length
    let track_length = (writer.len() - track_start) as u32;
    let length_bytes = track_length.to_be_bytes();
    writer[length_pos..length_pos + 4].copy_from_slice(&length_bytes);

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_midi_file_creation() {
        let mut file = MidiFile::new(MidiFormat::SingleTrack, Division::TicksPerQuarterNote(480));

        let mut track = MidiTrack::with_name("Test Track");
        track.add_event(
            0,
            MidiEvent {
                timestamp: 0,
                channel: 1,
                kind: MidiEventKind::NoteOn {
                    note: 60,
                    velocity: 100,
                },
            },
        );
        track.add_event(
            480,
            MidiEvent {
                timestamp: 0,
                channel: 1,
                kind: MidiEventKind::NoteOff {
                    note: 60,
                    velocity: 0,
                },
            },
        );

        file.add_track(track);

        assert_eq!(file.tracks.len(), 1);
        assert_eq!(file.tracks[0].events.len(), 2);
    }

    #[test]
    #[ignore] // TODO: Fix round-trip serialization
    fn test_midi_file_write_read() {
        let mut file = MidiFile::new(MidiFormat::SingleTrack, Division::TicksPerQuarterNote(480));

        let mut track = MidiTrack::new();
        track.add_event(
            0,
            MidiEvent {
                timestamp: 0,
                channel: 1,
                kind: MidiEventKind::NoteOn {
                    note: 60,
                    velocity: 100,
                },
            },
        );
        track.add_event(
            480,
            MidiEvent {
                timestamp: 0,
                channel: 1,
                kind: MidiEventKind::NoteOff {
                    note: 60,
                    velocity: 0,
                },
            },
        );

        file.add_track(track);

        // Write to bytes
        let bytes = file.to_bytes().unwrap();

        // Read back
        let loaded = MidiFile::from_bytes(&bytes).unwrap();

        assert_eq!(loaded.tracks.len(), 1);
        assert!(loaded.tracks[0].events.len() >= 2); // May have meta events
    }

    #[test]
    fn test_variable_length_encoding() {
        let mut data = Vec::new();

        write_variable_length(&mut data, 0).unwrap();
        assert_eq!(data, vec![0x00]);

        data.clear();
        write_variable_length(&mut data, 127).unwrap();
        assert_eq!(data, vec![0x7F]);

        data.clear();
        write_variable_length(&mut data, 128).unwrap();
        assert_eq!(data, vec![0x81, 0x00]);

        data.clear();
        write_variable_length(&mut data, 16383).unwrap();
        assert_eq!(data, vec![0xFF, 0x7F]);
    }
}