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

use crate::cell_note::CellNote;
use alloc::format;
use alloc::string::ToString;
use core::fmt::*;
use serde::{Deserialize, Serialize};

/// A typical pattern slot
#[derive(Serialize, Deserialize, Copy, Clone, Eq, Hash, PartialEq)]
#[repr(C)]
pub struct PatternSlot {
    pub note: CellNote,
    pub instrument: Option<usize>,
    pub volume: u8,
    pub effect_type: u8,
    pub effect_parameter: u8,
}

impl Default for PatternSlot {
    fn default() -> Self {
        PatternSlot {
            note: CellNote::Empty,
            instrument: None,
            volume: 0,
            effect_type: 0,
            effect_parameter: 0,
        }
    }
}

impl Debug for PatternSlot {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result {
        let v = if self.volume == 0 {
            '-'
        } else {
            core::char::from_digit(u32::from(self.volume & 0x0f), 16).unwrap()
        };
        let ninstr = if let Some(instr) = self.instrument {
            format!("{:>2X}", instr)
        } else {
            "  ".to_string()
        };
        write!(
            f,
            "[{:?} {} {:>1}{} {}{:02X}]",
            self.note,
            ninstr,
            self.volume_letter(),
            v,
            self.effect_letter(),
            self.effect_parameter
        )
    }
}

impl PatternSlot {
    pub fn has_arpeggio(&self) -> bool {
        self.effect_type == 0 && self.effect_parameter != 0
    }

    pub fn has_delay(&self) -> bool {
        self.effect_type == 0xE && (self.effect_parameter >> 4) == 0xD
    }

    pub fn has_retrigger_empty(&self) -> bool {
        self.effect_type == 0xE && self.effect_parameter == 0x90
    }
    pub fn has_tone_portamento(&self) -> bool {
        self.effect_type == 3 || self.effect_type == 5 || self.volume >> 4 == 0x0F
    }

    pub fn has_vibrato(&self) -> bool {
        self.effect_type == 4 || self.effect_type == 6 || self.volume >> 4 == 0x0B
    }

    pub fn has_volume_slide(&self) -> bool {
        self.effect_type == 5
            || self.effect_type == 6
            || self.effect_type == 0xA
            || (self.effect_type == 0xE && (self.effect_parameter >> 4) == 0xA)
            || (self.effect_type == 0xE && (self.effect_parameter >> 4) == 0xB)
    }

    pub fn volume_letter(&self) -> char {
        match self.volume >> 4 {
            0x0 => '-',
            0x1 => '0',
            0x2 => '1',
            0x3 => '2',
            0x4 => '3',
            0x5 => '4',
            0x6 => '-',
            0x7 => '+',
            0x8 => 'D',
            0x9 => 'U',
            0xA => 'S',
            0xB => 'V',
            0xC => 'P',
            0xD => 'L',
            0xE => 'R',
            0xF => 'M',
            _ => ' ',
        }
    }

    pub fn effect_letter(&self) -> char {
        match self.effect_type {
            0x0 => '0',
            0x1 => '1',
            0x2 => '2',
            0x3 => '3',
            0x4 => '4',
            0x5 => '5',
            0x6 => '6',
            0x7 => '7',
            0x8 => '8',
            0x9 => '9',
            0xA => 'A',
            0xB => 'B',
            0xC => 'C',
            0xD => 'D',
            0xE => 'E',
            0xF => 'F',
            0x10 => 'G',
            0x11 => 'H',
            0x12 => 'I',
            0x13 => 'J',
            0x14 => 'K',
            0x15 => 'L',
            0x16 => 'M',
            0x17 => 'N',
            0x18 => 'O',
            0x19 => 'P',
            0x1A => 'Q',
            0x1B => 'R',
            0x1C => 'S',
            0x1D => 'T',
            0x1E => 'U',
            0x1F => 'V',
            0x20 => 'W',
            0x21 => 'X',
            _ => '0',
        }
    }
}