mtrack 0.12.0

A multitrack audio and MIDI player for live performances.
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

// Copyright (C) 2026 Michael Wilson <mike@mdwn.dev>
//
// This program is free software: you can redistribute it and/or modify it under
// the terms of the GNU General Public License as published by the Free Software
// Foundation, version 3.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with
// this program. If not, see <https://www.gnu.org/licenses/>.
//
use serde::{Deserialize, Serialize};

/// A YAML representation of a track.
#[derive(Deserialize, Clone, Serialize)]
pub struct Track {
    /// The name of the track.
    name: String,
    /// The file associated with the track.
    file: String,
    /// The file channel of the track to use.
    file_channel: Option<u16>,
}

impl Track {
    /// Creates a new track config.
    pub fn new(name: String, file: &str, file_channel: Option<u16>) -> Track {
        Track {
            name,
            file: file.to_string(),
            file_channel,
        }
    }

    /// Gets the name of the track.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Gets the file associated with the track.
    pub fn file(&self) -> &str {
        &self.file
    }

    /// Gets the file channel of the track to use.
    pub fn file_channel(&self) -> Option<u16> {
        self.file_channel
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use config::{Config, File, FileFormat};

    #[test]
    fn new_with_channel() {
        let t = Track::new("vocals".to_string(), "vocals.wav", Some(1));
        assert_eq!(t.name(), "vocals");
        assert_eq!(t.file(), "vocals.wav");
        assert_eq!(t.file_channel(), Some(1));
    }

    #[test]
    fn new_without_channel() {
        let t = Track::new("drums".to_string(), "drums.wav", None);
        assert_eq!(t.name(), "drums");
        assert_eq!(t.file(), "drums.wav");
        assert_eq!(t.file_channel(), None);
    }

    #[test]
    fn deserialize_with_channel() {
        let yaml = r#"
name: guitar
file: guitar.wav
file_channel: 2
"#;
        let t: Track = Config::builder()
            .add_source(File::from_str(yaml, FileFormat::Yaml))
            .build()
            .unwrap()
            .try_deserialize()
            .unwrap();
        assert_eq!(t.name(), "guitar");
        assert_eq!(t.file(), "guitar.wav");
        assert_eq!(t.file_channel(), Some(2));
    }

    #[test]
    fn deserialize_without_channel() {
        let yaml = r#"
name: bass
file: bass.wav
"#;
        let t: Track = Config::builder()
            .add_source(File::from_str(yaml, FileFormat::Yaml))
            .build()
            .unwrap()
            .try_deserialize()
            .unwrap();
        assert_eq!(t.name(), "bass");
        assert_eq!(t.file(), "bass.wav");
        assert_eq!(t.file_channel(), None);
    }

    #[test]
    fn clone_preserves_all_fields() {
        let t = Track::new("vocals".to_string(), "vocals.wav", Some(3));
        let cloned = t.clone();
        assert_eq!(cloned.name(), "vocals");
        assert_eq!(cloned.file(), "vocals.wav");
        assert_eq!(cloned.file_channel(), Some(3));
    }

    #[test]
    fn serialize_roundtrip() {
        let t = Track::new("keys".to_string(), "keys.wav", Some(5));
        let serialized = crate::util::to_yaml_string(&t).unwrap();
        let deserialized: Track = config::Config::builder()
            .add_source(config::File::from_str(
                &serialized,
                config::FileFormat::Yaml,
            ))
            .build()
            .unwrap()
            .try_deserialize()
            .unwrap();
        assert_eq!(deserialized.name(), "keys");
        assert_eq!(deserialized.file(), "keys.wav");
        assert_eq!(deserialized.file_channel(), Some(5));
    }

    #[test]
    fn serialize_roundtrip_no_channel() {
        let t = Track::new("click".to_string(), "click.wav", None);
        let serialized = crate::util::to_yaml_string(&t).unwrap();
        let deserialized: Track = config::Config::builder()
            .add_source(config::File::from_str(
                &serialized,
                config::FileFormat::Yaml,
            ))
            .build()
            .unwrap()
            .try_deserialize()
            .unwrap();
        assert_eq!(deserialized.name(), "click");
        assert_eq!(deserialized.file(), "click.wav");
        assert_eq!(deserialized.file_channel(), None);
    }
}