m8_files/instruments/
sampler.rs

1use crate::instruments::common::*;
2use crate::reader::*;
3use crate::version::*;
4use crate::writer::Writer;
5use num_enum::IntoPrimitive;
6use num_enum::TryFromPrimitive;
7
8use super::dests;
9use super::CommandPack;
10
11#[repr(u8)]
12#[allow(non_camel_case_types)]
13#[derive(IntoPrimitive, TryFromPrimitive, PartialEq, Copy, Clone, Default, Debug)]
14pub enum SamplePlayMode {
15    #[default]
16    FWD,
17    REV,
18    FWDLOOP,
19    REVLOOP,
20    FWD_PP,
21    REV_PP,
22    OSC,
23    OSC_REV,
24    OSC_PP,
25}
26
27#[derive(PartialEq, Debug, Clone)]
28pub struct Sampler {
29    pub number: u8,
30    pub name: String,
31    pub transpose: bool,
32    pub table_tick: u8,
33    pub synth_params: SynthParams,
34
35    pub sample_path: String,
36    pub play_mode: SamplePlayMode,
37    pub slice: u8,
38    pub start: u8,
39    pub loop_start: u8,
40    pub length: u8,
41    pub degrade: u8,
42}
43
44#[rustfmt::skip] // Keep constats with important order vertical for maintenance
45const SAMPLER_FX_COMMANDS : [&'static str; CommandPack::BASE_INSTRUMENT_COMMAND_COUNT + 1] = [
46    "VOL",
47    "PIT",
48    "FIN",
49    "PLY",
50    "STA",
51    "LOP",
52    "LEN",
53    "DEG",
54    "FLT",
55    "CUT",
56    "RES",
57    "AMP",
58    "LIM",
59    "PAN",
60    "DRY",
61
62    "SCH",
63    "SDL",
64    "SRV",
65
66    // EXTRA command
67    "SLI"
68];
69
70#[rustfmt::skip] // Keep constats with important order vertical for maintenance
71const DESTINATIONS : [&'static str; 14] = [
72    dests::OFF,
73    dests::VOLUME,
74    dests::PITCH,
75
76    "LOOP ST",
77    "LENGTH",
78    dests::DEGRADE,
79    dests::CUTOFF,
80    dests::RES,
81    dests::AMP,
82    dests::PAN,
83    dests::MOD_AMT,
84    dests::MOD_RATE,
85    dests::MOD_BOTH,
86    dests::MOD_BINV,
87];
88
89impl Sampler {
90    pub const MOD_OFFSET: usize = 29;
91
92    pub fn command_name(&self, _ver: Version) -> &'static [&'static str] {
93        &SAMPLER_FX_COMMANDS
94    }
95
96    pub fn destination_names(&self, _ver: Version) -> &'static [&'static str] {
97        &DESTINATIONS
98    }
99
100    pub fn write(&self, ver: Version, w: &mut Writer) {
101        let pos = w.pos();
102        w.write_string(&self.name, 12);
103        w.write(TranspEq::from(ver, self.transpose, self.synth_params.associated_eq).into());
104        w.write(self.table_tick);
105        w.write(self.synth_params.volume);
106        w.write(self.synth_params.pitch);
107        w.write(self.synth_params.fine_tune);
108
109        w.write(self.play_mode.into());
110        w.write(self.slice);
111        w.write(self.start);
112        w.write(self.loop_start);
113        w.write(self.length);
114        w.write(self.degrade);
115
116        self.synth_params.write(ver, w, Sampler::MOD_OFFSET);
117
118        w.seek(pos + 0x56);
119        w.write_string(&self.sample_path, 128);
120    }
121
122    pub fn from_reader(
123        ver: Version,
124        reader: &mut Reader,
125        start_pos: usize,
126        number: u8,
127        version: Version,
128    ) -> M8Result<Self> {
129        let name = reader.read_string(12);
130
131        let transp_eq = TranspEq::from_version(ver, reader.read());
132        let table_tick = reader.read();
133        let volume = reader.read();
134        let pitch = reader.read();
135        let fine_tune = reader.read();
136
137        let play_mode = reader.read();
138        let slice = reader.read();
139        let start = reader.read();
140        let loop_start = reader.read();
141        let length = reader.read();
142        let degrade = reader.read();
143
144        let synth_params = if version.at_least(3, 0) {
145            SynthParams::from_reader3(
146                ver,
147                reader,
148                volume,
149                pitch,
150                fine_tune,
151                transp_eq.eq,
152                Sampler::MOD_OFFSET,
153            )?
154        } else {
155            SynthParams::from_reader2(reader, volume, pitch, fine_tune)?
156        };
157
158        reader.set_pos(start_pos + 0x57);
159        let sample_path = reader.read_string(128);
160
161        Ok(Sampler {
162            number,
163            name,
164            transpose: transp_eq.transpose,
165            table_tick,
166            synth_params,
167
168            sample_path,
169            play_mode: play_mode
170                .try_into()
171                .map_err(|_| ParseError(format!("Invalid play mode")))?,
172            slice,
173            start,
174            loop_start,
175            length,
176            degrade,
177        })
178    }
179}
m8_files/instruments/sampler.rs

m8_files/instruments/
sampler.rs
