xmrs 0.10.3

A library to edit SoundTracker data with pleasure
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

/// Original XM Pattern Slot
use crate::cell_note::CellNote;
use crate::import::patternslot::PatternSlot;
use crate::pitch::Pitch;
use bincode::error::DecodeError;

use alloc::vec::Vec;

impl PatternSlot {
    pub fn load_xm(src: &[u8]) -> Result<(&[u8], PatternSlot), DecodeError> {
        let mut dst: [u8; 5] = [0; 5];
        let mut i = 0;
        let mut j = 0;

        let note = src[i];
        i += 1;
        if note & 0b1000_0000 != 0 {
            dst[j] = if note & 0b0000_0001 != 0 {
                i += 1;
                src[i - 1]
            } else {
                0
            };
            j += 1;
            dst[j] = if note & 0b0000_0010 != 0 {
                i += 1;
                src[i - 1]
            } else {
                0
            };
            j += 1;
            dst[j] = if note & 0b0000_0100 != 0 {
                i += 1;
                src[i - 1]
            } else {
                0
            };
            j += 1;
            dst[j] = if note & 0b0000_1000 != 0 {
                i += 1;
                src[i - 1]
            } else {
                0
            };
            j += 1;
            dst[j] = if note & 0b0001_0000 != 0 {
                i += 1;
                src[i - 1]
            } else {
                0
            };
        } else {
            dst[j] = note;
            j += 1;
            dst[j] = src[i];
            i += 1;
            j += 1;
            dst[j] = src[i];
            i += 1;
            j += 1;
            dst[j] = src[i];
            i += 1;
            j += 1;
            dst[j] = src[i];
            i += 1;
        }

        Ok((
            &src[i..],
            PatternSlot {
                note: {
                    if dst[0] == 97 {
                        // Special case: we don't want to use 97,
                        // because we want more octaves...
                        CellNote::KeyOff
                    } else if dst[0] == 0 {
                        // Special case: we don't want to use 0, so
                        // pitches start at 1 in XM. 0 = empty cell.
                        CellNote::Empty
                    } else {
                        match Pitch::try_from(dst[0] - 1) {
                            Ok(p) => CellNote::Play(p),
                            Err(_) => CellNote::Empty,
                        }
                    }
                },
                instrument: {
                    if dst[1] != 0 {
                        Some(dst[1] as usize - 1)
                    } else {
                        None
                    }
                },
                volume: dst[2],
                effect_type: dst[3],
                effect_parameter: dst[4],
            },
        ))
    }

    pub fn save_xm_unpack(&self) -> Vec<u8> {
        let mut bytes: [u8; 5] = [0; 5];
        bytes[0] = cell_note_to_xm_byte(&self.note);
        bytes[1] = {
            if let Some(instr) = self.instrument {
                (instr + 1) as u8
            } else {
                0
            }
        };
        bytes[2] = self.volume;
        bytes[3] = self.effect_type;
        bytes[4] = self.effect_parameter;
        bytes.to_vec()
    }

    pub fn save_xm(&self) -> Vec<u8> {
        let mut bytes: [u8; 5] = [0; 5];
        bytes[0] = cell_note_to_xm_byte(&self.note);
        bytes[1] = {
            if let Some(instr) = self.instrument {
                (instr + 1) as u8
            } else {
                0
            }
        };
        bytes[2] = self.volume;
        bytes[3] = self.effect_type;
        bytes[4] = self.effect_parameter;

        let mut dst: [u8; 5] = [0; 5];
        let mut pack_bits = 0;
        let mut i = 1;
        if bytes[0] > 0 {
            pack_bits |= 0b0001;
            dst[i] = bytes[0];
            i += 1;
        } // note
        if bytes[1] > 0 {
            pack_bits |= 0b0010;
            dst[i] = bytes[1];
            i += 1;
        } // instrument
        if bytes[2] > 0 {
            pack_bits |= 0b0100;
            dst[i] = bytes[2];
            i += 1;
        } // volume
        if bytes[3] > 0 {
            pack_bits |= 0b1000;
            dst[i] = bytes[3];
            i += 1;
        } // effect type

        if pack_bits == 15 {
            // first four bits set? no packing needed.
            return bytes.to_vec();
        }

        if bytes[4] > 0 {
            pack_bits |= 16;
            dst[i] = bytes[4];
            i += 1;
        } // effect parameter
        dst[0] = pack_bits | 0b1000_0000;
        dst[0..i].to_vec()
    }
}

/// Encode a `CellNote` to XM's note-byte convention.
///
/// XM's note byte uses `0` = empty, `1..=96` = pitch (one-based, so
/// the byte is `pitch.value() + 1`), `97` = key-off. The format
/// has no representation for note-cut or note-fade — those events
/// can only enter the pattern via effects, so when encountered in
/// a `CellNote::NoteCut` or `NoteFade` we emit `0` (empty note),
/// preserving the rest of the cell unchanged.
fn cell_note_to_xm_byte(n: &CellNote) -> u8 {
    match n {
        CellNote::Empty => 0,
        CellNote::Play(p) => p.value() + 1,
        CellNote::KeyOff => 97,
        CellNote::NoteCut | CellNote::NoteFade => 0,
    }
}