-
Notifications
You must be signed in to change notification settings - Fork 24
/
lib.rs
561 lines (482 loc) · 17.7 KB
/
lib.rs
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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use std::io::Error as IoError;
use std::time::Duration;
#[macro_use]
extern crate log;
extern crate hidapi;
use ab_glyph::{FontRef, PxScale};
use hidapi::{HidApi, HidDevice, HidError};
extern crate image;
use image::{DynamicImage, ImageBuffer, ImageError, Rgb};
pub mod images;
use crate::images::{apply_transform, encode_jpeg};
pub use crate::images::{Colour, ImageOptions};
pub mod info;
pub use info::*;
use imageproc::drawing::draw_text_mut;
use std::str::FromStr;
use thiserror::Error;
/// StreamDeck object
pub struct StreamDeck {
kind: Kind,
device: HidDevice,
}
/// Helper object for filtering device connections
#[cfg(feature = "structopt")]
#[derive(structopt::StructOpt)]
pub struct Filter {
#[structopt(long, default_value="0fd9", parse(try_from_str=u16_parse_hex), env="USB_VID")]
/// USB Device Vendor ID (VID) in hex
pub vid: u16,
#[structopt(long, default_value="0063", parse(try_from_str=u16_parse_hex), env="USB_PID")]
/// USB Device Product ID (PID) in hex
pub pid: u16,
#[structopt(long, env = "USB_SERIAL")]
/// USB Device Serial
pub serial: Option<String>,
}
fn u16_parse_hex(s: &str) -> Result<u16, std::num::ParseIntError> {
u16::from_str_radix(s, 16)
}
#[derive(Debug, Error)]
pub enum Error {
#[error(transparent)]
Hid(#[from] HidError),
#[error(transparent)]
Io(#[from] IoError),
#[error(transparent)]
Image(#[from] ImageError),
#[error("invalid image size")]
InvalidImageSize,
#[error("invalid key index")]
InvalidKeyIndex,
#[error("unrecognised pid")]
UnrecognisedPID,
#[error("unsupported input")]
UnsupportedInput,
#[error("no data")]
NoData,
}
pub struct DeviceImage {
data: Vec<u8>,
}
impl DeviceImage {
/// Constructs [DeviceImage] from a byte array
pub fn from_bytes(data: Vec<u8>) -> Self {
Self::from(data)
}
}
impl From<Vec<u8>> for DeviceImage {
fn from(data: Vec<u8>) -> Self {
Self { data }
}
}
/// Device USB Product Identifiers (PIDs)
pub mod pids {
pub const ORIGINAL: u16 = 0x0060;
pub const ORIGINAL_V2: u16 = 0x006d;
pub const MINI: u16 = 0x0063;
pub const XL: u16 = 0x006c;
pub const MK2: u16 = 0x0080;
pub const REVISED_MINI: u16 = 0x0090;
pub const PLUS: u16 = 0x0084;
}
impl StreamDeck {
/// Connect to a streamdeck device
pub fn connect(vid: u16, pid: u16, serial: Option<String>) -> Result<StreamDeck, Error> {
// Create new API
let api = HidApi::new()?;
StreamDeck::connect_with_hid(&api, vid, pid, serial)
}
/// Connect to a streamdeck device with an already initialise HidApi instance
pub fn connect_with_hid(
api: &HidApi,
vid: u16,
pid: u16,
serial: Option<String>,
) -> Result<StreamDeck, Error> {
// Match info based on PID
let kind = match pid {
pids::ORIGINAL => Kind::Original,
pids::MINI => Kind::Mini,
pids::ORIGINAL_V2 => Kind::OriginalV2,
pids::XL => Kind::Xl,
pids::MK2 => Kind::Mk2,
pids::REVISED_MINI => Kind::RevisedMini,
pids::PLUS => Kind::Plus,
_ => return Err(Error::UnrecognisedPID),
};
debug!("Device info: {:?}", kind);
// Attempt to connect to device
let device = match &serial {
Some(s) => api.open_serial(vid, pid, s),
None => api.open(vid, pid),
}?;
// Return streamdeck object
Ok(StreamDeck { device, kind })
}
/// Fetch the connected device kind
///
/// This can be used to retrieve related device information such as
/// images sizes and modes
pub fn kind(&self) -> Kind {
self.kind
}
/// Fetch the device manufacturer string
pub fn manufacturer(&mut self) -> Result<String, Error> {
let s = self.device.get_manufacturer_string()?;
Ok(s.unwrap())
}
/// Fetch the device product string
pub fn product(&mut self) -> Result<String, Error> {
let s = self.device.get_product_string()?;
Ok(s.unwrap())
}
/// Fetch the device serial
pub fn serial(&mut self) -> Result<String, Error> {
let s = self.device.get_serial_number_string()?;
Ok(s.unwrap())
}
/// Fetch the device firmware version
pub fn version(&mut self) -> Result<String, Error> {
let mut buff = [0u8; 17];
buff[0] = if self.kind.is_v2() { 0x05 } else { 0x04 };
let _s = self.device.get_feature_report(&mut buff)?;
let offset = if self.kind.is_v2() { 6 } else { 5 };
Ok(std::str::from_utf8(&buff[offset..]).unwrap().to_string())
}
/// Reset the connected device
pub fn reset(&mut self) -> Result<(), Error> {
let mut cmd = [0u8; 17];
if self.kind.is_v2() {
cmd[..2].copy_from_slice(&[0x03, 0x02]);
} else {
cmd[..2].copy_from_slice(&[0x0b, 0x63]);
}
self.device.send_feature_report(&cmd)?;
Ok(())
}
/// Set the device display brightness (in percent)
pub fn set_brightness(&mut self, brightness: u8) -> Result<(), Error> {
let mut cmd = [0u8; 17];
let brightness = brightness.min(100);
if self.kind.is_v2() {
cmd[..3].copy_from_slice(&[0x03, 0x08, brightness]);
} else {
cmd[..6].copy_from_slice(&[0x05, 0x55, 0xaa, 0xd1, 0x01, brightness]);
}
self.device.send_feature_report(&cmd)?;
Ok(())
}
/// Set blocking mode
///
/// See: `read_buttons` for discussion of this functionality
pub fn set_blocking(&mut self, blocking: bool) -> Result<(), Error> {
self.device.set_blocking_mode(blocking)?;
Ok(())
}
/// Probe for connected devices.
///
/// Returns a list of results,
/// each containing the device kind and PID or an error if the PID is unrecognised
pub fn probe() -> Result<Vec<Result<(Kind, u16), Error>>, Error> {
let api = HidApi::new()?;
let mut available_devices = vec![];
for device in api.device_list() {
if device.vendor_id() == 0x0fd9 {
let deck = match device.product_id() {
pids::MK2 => Ok((Kind::Mk2, pids::MK2)),
pids::XL => Ok((Kind::Xl, pids::XL)),
pids::ORIGINAL_V2 => Ok((Kind::OriginalV2, pids::ORIGINAL_V2)),
pids::ORIGINAL => Ok((Kind::Original, pids::ORIGINAL)),
pids::MINI => Ok((Kind::Mini, pids::MINI)),
pids::PLUS => Ok((Kind::Plus, pids::PLUS)),
_ => Err(Error::UnrecognisedPID)
};
available_devices.push(deck);
}
}
Ok(available_devices)
}
/// Fetch button states
///
/// In blocking mode this will wait until a report packet has been received
/// (or the specified timeout has elapsed). In non-blocking mode this will return
/// immediately with a zero vector if no data is available
pub fn read_buttons(&mut self, timeout: Option<Duration>) -> Result<Vec<u8>, Error> {
let mut cmd = [0u8; 36];
let keys = self.kind.keys() as usize;
let offset = self.kind.key_data_offset();
match timeout {
Some(t) => self
.device
.read_timeout(&mut cmd[..keys + offset + 1], t.as_millis() as i32)?,
None => self.device.read(&mut cmd[..keys + offset + 1])?,
};
if cmd[0] == 0 {
return Err(Error::NoData);
}
if self.kind == Kind::Plus {
//If the second byte is not 0, a dial or the touchscreen was used, we don't support that here
//This would write to indices which represent buttons and thus create faulty output
if cmd[1] != 0 {
return Err(Error::UnsupportedInput);
}
}
let mut out = vec![0u8; keys];
match self.kind.key_direction() {
KeyDirection::RightToLeft => {
for (i, val) in out.iter_mut().enumerate() {
// In right-to-left mode(original Streamdeck) the first key has index 1,
// so we don't add the +1 here.
*val = cmd[offset + self.translate_key_index(i as u8)? as usize];
}
}
KeyDirection::LeftToRight => {
out[0..keys].copy_from_slice(&cmd[1 + offset..1 + offset + keys]);
}
}
Ok(out)
}
/// Fetch image size for the connected device
pub fn image_size(&self) -> (usize, usize) {
self.kind.image_size()
}
/// Convert an image into the device dependent format
fn convert_image(&self, image: Vec<u8>) -> Result<DeviceImage, Error> {
// Check image dimensions
if image.len() != self.kind.image_size_bytes() {
return Err(Error::InvalidImageSize);
}
let image = match self.kind.image_mode() {
ImageMode::Bmp => image,
ImageMode::Jpeg => {
let (w, h) = self.kind.image_size();
encode_jpeg(&image, w, h)?
}
};
Ok(DeviceImage { data: image })
}
/// Set a button to the provided RGB colour
pub fn set_button_rgb(&mut self, key: u8, colour: &Colour) -> Result<(), Error> {
let mut image = vec![0u8; self.kind.image_size_bytes()];
let colour_order = self.kind.image_colour_order();
for i in 0..image.len() {
match i % 3 {
0 => {
image[i] = match colour_order {
ColourOrder::BGR => colour.b,
ColourOrder::RGB => colour.r,
}
}
1 => image[i] = colour.g,
2 => {
image[i] = match colour_order {
ColourOrder::BGR => colour.r,
ColourOrder::RGB => colour.b,
}
}
_ => unreachable!(),
};
}
self.write_button_image(key, &self.convert_image(image)?)?;
Ok(())
}
/// Set a button to the provided image
pub fn set_button_image(&mut self, key: u8, image: DynamicImage) -> Result<(), Error> {
let image = apply_transform(image, self.kind.image_rotation(), self.kind.image_mirror());
let mut data = image.into_rgb8().into_vec();
if matches!(self.kind.image_colour_order(), ColourOrder::BGR) {
rgb_to_bgr(&mut data);
}
self.write_button_image(key, &self.convert_image(data)?)
}
/// Sets a button to the provided text.
/// Will break text over \n linebreaks
pub fn set_button_text(
&mut self,
key: u8,
font: &FontRef,
pos: &TextPosition,
text: &str,
opts: &TextOptions,
) -> Result<(), Error> {
let (width, height) = self.kind.image_size();
let background = Rgb([opts.background.r, opts.background.g, opts.background.b]);
let colour = Rgb([opts.foreground.r, opts.foreground.g, opts.foreground.b]);
let mut image = ImageBuffer::from_pixel(width as u32, height as u32, background);
match pos {
TextPosition::Absolute { x, y } => {
let mut y = *y;
text.to_string().split("\n").for_each(|txt| {
draw_text_mut(&mut image, colour, *x, y, opts.scale, font, txt);
y += (opts.scale.y * opts.line_height).round() as i32;
});
}
}
self.set_button_image(key, DynamicImage::ImageRgb8(image))
}
/// Set a button to the provided image file
pub fn set_button_file(
&mut self,
key: u8,
image: &str,
opts: &ImageOptions,
) -> Result<(), Error> {
self.write_button_image(key, &self.load_image(image, opts)?)
}
/// Load an image file into the device specific representation
pub fn load_image(&self, image: &str, opts: &ImageOptions) -> Result<DeviceImage, Error> {
let (x, y) = self.kind.image_size();
let rotate = self.kind.image_rotation();
let mirror = self.kind.image_mirror();
let image = images::load_image(
image,
x,
y,
rotate,
mirror,
opts,
self.kind.image_colour_order(),
)?;
self.convert_image(image)
}
/// Transforms a key from zero-indexed left-to-right into the device-correct coordinate system
fn translate_key_index(&self, key: u8) -> Result<u8, Error> {
if key > self.kind.keys() {
return Err(Error::InvalidKeyIndex);
}
let mapped = match self.kind.key_direction() {
// All but the original Streamdeck already have correct coordinates
KeyDirection::LeftToRight => key + self.kind.key_index_offset(),
// The original Streamdeck uses 1-indexed right-to-left
KeyDirection::RightToLeft => {
let cols = self.kind.key_columns() as u8;
let col = key % cols;
let row = key / cols;
row * cols + cols - col
}
};
Ok(mapped)
}
/// Writes an image to a button
/// Image at this point in correct dimensions and in device native colour order.
pub fn write_button_image(&mut self, key: u8, image: &DeviceImage) -> Result<(), Error> {
let image = &image.data;
let key = self.translate_key_index(key)?;
let mut buf = vec![0u8; self.kind.image_report_len()];
let base = self.kind.image_base();
let hdrlen = self.kind.image_report_header_len();
match self.kind {
Kind::Original => {
// Original Streamdeck uses static lengths, not the dynamically sized protocol on the
// later versions. First packet contains the initial 7749 bytes.
self.write_image_header(&mut buf, key, 1, false, 0);
let start = hdrlen + base.len();
buf[hdrlen..start].copy_from_slice(base);
buf[start..start + 7749].copy_from_slice(&image[0..7749]);
self.device.write(&buf)?;
// Second packet contains the last 7803 bytes
self.write_image_header(&mut buf, key, 2, true, 0);
buf[hdrlen..hdrlen + 7803].copy_from_slice(&image[7749..15552]);
self.device.write(&buf)?;
Ok(())
}
_ => {
let mut sequence = 0;
let mut offset = 0;
let maxdatalen = buf.len() - hdrlen;
while offset < image.len() {
let mut take = (image.len() - offset).min(maxdatalen);
let mut start = hdrlen;
if sequence == 0 && !base.is_empty() {
trace!("outputting base");
buf[start..start + base.len()].copy_from_slice(base);
// Recalculate take with the smaller room
take = (image.len() - offset).min(maxdatalen - base.len());
start += base.len();
}
let is_last = take == image.len() - offset;
self.write_image_header(&mut buf, key, sequence, is_last, take);
buf[start..start + take].copy_from_slice(&image[offset..offset + take]);
trace!(
"outputting image chunk [{}..{}[ in [{}..{}[, sequence {}{}",
offset,
offset + take,
start,
start + take,
sequence,
if is_last { " (last)" } else { "" },
);
self.device.write(&buf)?;
sequence += 1;
offset += take;
}
Ok(())
}
}
}
/// Writes the image report header to the given buffer
fn write_image_header(
&self,
buf: &mut [u8],
key: u8,
sequence: u16,
is_last: bool,
payload_len: usize,
) {
if self.kind.is_v2() {
buf[0] = 0x02;
buf[1] = 0x07;
buf[2] = key;
buf[3] = if is_last { 1 } else { 0 };
buf[4..6].copy_from_slice(&(payload_len as u16).to_le_bytes());
buf[6..8].copy_from_slice(&sequence.to_le_bytes());
} else {
buf[0] = 0x02;
buf[1] = 0x01;
buf[2..4].copy_from_slice(&sequence.to_le_bytes());
buf[4] = if is_last { 1 } else { 0 };
buf[5] = key;
}
}
}
/// TextPosition is how to position text via set_button_text
pub enum TextPosition {
/// Absolute positioning
Absolute { x: i32, y: i32 },
}
/// Text Options provide values for text buttons
pub struct TextOptions {
foreground: Colour,
background: Colour,
scale: PxScale,
line_height: f32,
}
impl TextOptions {
pub fn new(foreground: Colour, background: Colour, scale: PxScale, line_height: f32) -> Self {
TextOptions {
foreground,
background,
scale,
line_height,
}
}
}
impl Default for TextOptions {
/// default is white text on a black background, with 15 pixel high text
/// and 1.1x the line height.
fn default() -> Self {
TextOptions {
foreground: Colour::from_str("FFFFFF").unwrap(),
background: Colour::from_str("000000").unwrap(),
scale: PxScale { x: 15.0, y: 15.0 },
line_height: 1.1,
}
}
}
// Convert RGB image data to BGR
fn rgb_to_bgr(data: &mut Vec<u8>) {
for chunk in data.chunks_exact_mut(3) {
chunk.swap(0, 2);
}
}