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
use crate::launchkey::bitmap::LaunchkeyBitmap;
use crate::launchkey::colors::{Color, ColorPaletteIndex};
use crate::launchkey::constants::{
LaunchKeySku, BITMAP_HEADER_BYTE, BUTTON_BRIGHTNESS_OVERRIDE_CHANNEL, CC_CH7,
CONFIGURE_DISPLAY_COMMAND, CUSTOM_COLOR_COMMAND, DISABLE_DRUM_DAW_MODE, ENABLE_DRUM_DAW_MODE,
ENCODER_MODE_CC, FADER_MODE_CC, PAD_MODE_CC, SET_SCREEN_TEXT_COMMAND, SYSEX_TERMINATOR,
};
use crate::launchkey::modes::encoder_mode::EncoderMode;
use crate::launchkey::modes::fader_mode::FaderMode;
use crate::launchkey::modes::pad_mode::PadMode;
use crate::launchkey::surface::buttons::{Brightness, LaunchKeyButton};
use crate::launchkey::surface::display::{
Arrangement, ContextualDisplayTarget, DisplayConfig, DisplayTarget, GlobalDisplayTarget,
};
use crate::launchkey::surface::pads::{LEDMode, PadInMode};
use std::ops::Deref;
/// Represents a high-level Launchkey command that can be converted into a MIDI message.
/// These are used to control pads, buttons, displays, and other device features.
#[derive(Debug, Clone)]
pub enum LaunchkeyCommand {
SetDrumDAWMode(bool),
SetPadMode(PadMode),
SetEncoderMode(EncoderMode),
SetFaderMode(FaderMode),
SetButtonBrightness {
launch_key_button: LaunchKeyButton,
brightness: Brightness,
},
SetPadColor {
pad_in_mode: PadInMode,
mode: LEDMode,
color_palette_index: ColorPaletteIndex,
},
SetPadCustomColor {
pad_in_mode: PadInMode,
color: Color,
},
SetScreenTextGlobal {
target: GlobalDisplayTarget,
arrangement: Arrangement,
},
SetScreenTextContextual {
target: ContextualDisplayTarget,
text: String,
},
SendScreenBitmap {
target: GlobalDisplayTarget,
bitmap: Box<LaunchkeyBitmap>,
},
}
impl LaunchkeyCommand {
/// Converts the [`LaunchkeyCommand`] into a MIDI byte sequence appropriate for the specific SKU.
pub(crate) fn as_bytes(&self, sku: &LaunchKeySku) -> Vec<u8> {
let header = sku.sys_ex_header();
match self {
LaunchkeyCommand::SetDrumDAWMode(enable) => {
if *enable {
ENABLE_DRUM_DAW_MODE.into()
} else {
DISABLE_DRUM_DAW_MODE.into()
}
}
LaunchkeyCommand::SetPadMode(mode) => vec![CC_CH7, PAD_MODE_CC, mode.to_value()],
LaunchkeyCommand::SetEncoderMode(mode) => {
vec![CC_CH7, ENCODER_MODE_CC, mode.to_value()]
}
LaunchkeyCommand::SetFaderMode(mode) => vec![CC_CH7, FADER_MODE_CC, mode.to_value()],
LaunchkeyCommand::SetButtonBrightness {
launch_key_button,
brightness,
} => {
vec![
BUTTON_BRIGHTNESS_OVERRIDE_CHANNEL,
(*launch_key_button).to_value(),
brightness.value(),
]
}
// Commands for pad LEDs
LaunchkeyCommand::SetPadColor {
pad_in_mode,
mode,
color_palette_index,
} => {
let channel = mode.to_midi_channel(*pad_in_mode);
vec![
channel,
(*pad_in_mode).to_index(),
color_palette_index.as_u8(),
]
}
LaunchkeyCommand::SetPadCustomColor { pad_in_mode, color } => {
let mut data = header.to_vec();
data.extend_from_slice(&[
CUSTOM_COLOR_COMMAND.0,
CUSTOM_COLOR_COMMAND.1,
(*pad_in_mode).to_index(),
color.r.into(),
color.g.into(),
color.b.into(),
]);
data.push(SYSEX_TERMINATOR);
data
}
// Commands for screen control
LaunchkeyCommand::SetScreenTextGlobal {
target,
arrangement,
} => {
let mut data: Vec<u8> = Vec::new();
// Start with configuring the display for the arrangement
data.extend(self.configure_display(
(*target).into(),
DisplayConfig::Arrangement(arrangement.clone()),
sku,
));
// Handle different arrangement types
match arrangement {
Arrangement::NameValue(name, value) => {
data.extend(self.set_screen_text(
(*target).into(),
0,
name.to_string(),
sku,
));
data.extend(self.set_screen_text(
(*target).into(),
1,
value.to_string(),
sku,
));
}
Arrangement::TitleNameValue(title, name, value) => {
data.extend(self.set_screen_text(
(*target).into(),
0,
title.to_string(),
sku,
));
data.extend(self.set_screen_text(
(*target).into(),
1,
name.to_string(),
sku,
));
data.extend(self.set_screen_text(
(*target).into(),
2,
value.to_string(),
sku,
));
}
Arrangement::TitleEightNames(title, names) => {
data.extend(self.set_screen_text(
(*target).into(),
0,
title.to_string(),
sku,
));
for (i, name) in names.iter().enumerate() {
data.extend(self.set_screen_text(
(*target).into(),
(i + 1) as u8,
name.to_string(),
sku,
));
}
}
Arrangement::NameNumericValue(name) => {
data.extend(self.set_screen_text(
(*target).into(),
0,
name.to_string(),
sku,
));
}
}
// Finalize with configuring the display for triggering
data.extend(self.configure_display((*target).into(), DisplayConfig::Trigger, sku));
data
}
LaunchkeyCommand::SetScreenTextContextual { target, text } => {
self.set_screen_text((*target).into(), 0, text.to_string(), sku)
}
LaunchkeyCommand::SendScreenBitmap { target, bitmap } => {
let mut data = header.to_vec();
data.extend_from_slice(&[BITMAP_HEADER_BYTE, (*target).into()]);
data.extend_from_slice(bitmap.deref().as_ref());
data.push(SYSEX_TERMINATOR);
data
}
}
}
/// Internal helper to create a SysEx message configuring the screen for a target and config.
fn configure_display(
&self,
target: DisplayTarget,
config: DisplayConfig,
sku: &LaunchKeySku,
) -> Vec<u8> {
let mut data = sku.sys_ex_header().to_vec();
data.extend_from_slice(&[
CONFIGURE_DISPLAY_COMMAND,
target.into(),
config.clone().into(),
]);
data.push(SYSEX_TERMINATOR);
data
}
/// Internal helper to create a SysEx message that sets text on a specific display field.
fn set_screen_text(
&self,
target: DisplayTarget,
field: u8,
text: String,
sku: &LaunchKeySku,
) -> Vec<u8> {
let mut data = sku.sys_ex_header().to_vec();
data.extend_from_slice(&[SET_SCREEN_TEXT_COMMAND, target.into(), field]);
data.extend(text.as_bytes());
data.push(SYSEX_TERMINATOR);
data
}
}