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 crate::buttonstate::{ButtonStates, Buttons};
use crate::channelstate::ChannelState;
use crate::commands::SystemInfoCommand;
use crate::commands::SystemInfoCommand::SupportsDCPCategory;
use crate::commands::{Command, HardwareInfoCommand};
use crate::dcp::DCPCategory;
use crate::error::{CommandError, ConnectError};
use crate::routing::InputDevice;
use byteorder::{ByteOrder, LittleEndian, ReadBytesExt, WriteBytesExt};
use enumset::EnumSet;
use goxlr_types::{
ChannelName, EffectKey, EncoderName, FaderName, FirmwareVersions, MicrophoneParamKey,
MicrophoneType, VersionNumber,
};
use log::{debug, info};
use rusb::Error::Pipe;
use rusb::{
Device, DeviceDescriptor, DeviceHandle, Direction, GlobalContext, Language, Recipient,
RequestType, UsbContext,
};
use std::io::{Cursor, Write};
use std::thread::sleep;
use std::time::Duration;
#[derive(Debug)]
pub struct GoXLR<T: UsbContext> {
handle: DeviceHandle<T>,
device: Device<T>,
device_descriptor: DeviceDescriptor,
timeout: Duration,
language: Language,
command_count: u16,
device_is_claimed: bool,
}
pub const SUPER_DEBUG: bool = false;
pub const VID_GOXLR: u16 = 0x1220;
pub const PID_GOXLR_MINI: u16 = 0x8fe4;
pub const PID_GOXLR_FULL: u16 = 0x8fe0;
impl GoXLR<GlobalContext> {
pub fn open() -> Result<Self, ConnectError> {
let mut error = ConnectError::DeviceNotFound;
for device in rusb::devices()?.iter() {
if let Ok(descriptor) = device.device_descriptor() {
if descriptor.vendor_id() == VID_GOXLR
&& (descriptor.product_id() == PID_GOXLR_FULL
|| descriptor.product_id() == PID_GOXLR_MINI)
{
match device.open() {
Ok(handle) => return GoXLR::from_device(handle, descriptor),
Err(e) => error = e.into(),
}
}
}
}
Err(error)
}
}
impl<T: UsbContext> GoXLR<T> {
pub fn from_device(
mut handle: DeviceHandle<T>,
device_descriptor: DeviceDescriptor,
) -> Result<Self, ConnectError> {
let device = handle.device();
let timeout = Duration::from_secs(1);
info!("Connected to possible GoXLR device at {:?}", device);
let languages = handle.read_languages(timeout)?;
let language = languages
.get(0)
.ok_or(ConnectError::DeviceNotGoXLR)?
.to_owned();
let _ = dbg!(handle.set_active_configuration(1));
let device_is_claimed = handle.claim_interface(0).is_ok();
let mut goxlr = Self {
handle,
device,
device_descriptor,
timeout,
language,
command_count: 0,
device_is_claimed,
};
let result = goxlr.write_control(1, 0, 0, &[]);
debug!("Activating Vendor Interface..");
goxlr.read_control(0, 0, 0, 24)?;
if result == Err(Pipe) {
info!("Attempting to initialise device..");
if device_is_claimed {
goxlr.handle.release_interface(0)?;
}
goxlr.handle.set_auto_detach_kernel_driver(true)?;
if !goxlr.handle.claim_interface(0).is_ok() {
return Err(ConnectError::DeviceNotClaimed);
}
goxlr.write_class_control(1, 0x0100, 0x2900, &[0x80, 0xbb, 0x00, 0x00])?;
goxlr.handle.release_interface(0)?;
goxlr.handle.reset()?;
return Err(ConnectError::DeviceNeedsReboot);
}
debug!("Handling initial request");
goxlr.read_control(3, 0, 0, 1040)?;
Ok(goxlr)
}
pub fn usb_device_descriptor(&self) -> &DeviceDescriptor {
&self.device_descriptor
}
pub fn usb_device_manufacturer(&self) -> Result<String, rusb::Error> {
self.handle.read_manufacturer_string(
self.language,
&self.device_descriptor,
Duration::from_millis(100),
)
}
pub fn usb_device_product_name(&self) -> Result<String, rusb::Error> {
self.handle.read_product_string(
self.language,
&self.device_descriptor,
Duration::from_millis(100),
)
}
pub fn usb_device_is_claimed(&self) -> bool {
self.device_is_claimed
}
pub fn usb_device_has_kernel_driver_active(&self) -> Result<bool, rusb::Error> {
self.handle.kernel_driver_active(0)
}
pub fn usb_bus_number(&self) -> u8 {
self.device.bus_number()
}
pub fn usb_address(&self) -> u8 {
self.device.address()
}
pub fn read_control(
&mut self,
request: u8,
value: u16,
index: u16,
length: usize,
) -> Result<Vec<u8>, rusb::Error> {
let mut buf = vec![0; length];
let response_length = self.handle.read_control(
rusb::request_type(Direction::In, RequestType::Vendor, Recipient::Interface),
request,
value,
index,
&mut buf,
self.timeout,
)?;
buf.truncate(response_length);
Ok(buf)
}
pub fn write_control(
&mut self,
request: u8,
value: u16,
index: u16,
data: &[u8],
) -> Result<(), rusb::Error> {
self.handle.write_control(
rusb::request_type(Direction::Out, RequestType::Vendor, Recipient::Interface),
request,
value,
index,
data,
self.timeout,
)?;
Ok(())
}
fn write_class_control(
&mut self,
request: u8,
value: u16,
index: u16,
data: &[u8],
) -> Result<(), rusb::Error> {
self.handle.write_control(
rusb::request_type(Direction::Out, RequestType::Class, Recipient::Interface),
request,
value,
index,
data,
self.timeout,
)?;
Ok(())
}
pub fn request_data(&mut self, command: Command, body: &[u8]) -> Result<Vec<u8>, rusb::Error> {
if command == Command::ResetCommandIndex {
self.command_count = 0;
} else {
if self.command_count >= u16::MAX {
let _ = self.request_data(Command::ResetCommandIndex, &[])?;
}
self.command_count += 1;
}
let command_index = self.command_count;
let mut full_request = vec![0; 16];
LittleEndian::write_u32(&mut full_request[0..4], command.command_id());
LittleEndian::write_u16(&mut full_request[4..6], body.len() as u16);
LittleEndian::write_u16(&mut full_request[6..8], command_index);
full_request.extend(body);
if SUPER_DEBUG {
debug!("Sending Request.. for {:?}", command);
}
self.write_control(2, 0, 0, &full_request)?;
let mut sleep_time = Duration::from_millis(3);
if self.device_descriptor.product_id() == PID_GOXLR_MINI {
sleep_time = Duration::from_millis(10);
}
sleep(sleep_time);
if SUPER_DEBUG {
debug!("Reading Response..");
}
let mut response = vec![];
for i in 0 .. 20 {
let response_value = self.read_control(3, 0, 0, 1040);
if response_value == Err(Pipe) {
if i < 2 {
debug!("Response not arrived yet for {:?}, sleeping and retrying (Attempt {} of 20)", command, i + 1);
sleep(sleep_time);
continue;
} else {
debug!("Failed to receive response (Attempt 20 of 20), possible Dead GoXLR?");
return Err(response_value.err().unwrap());
}
}
if response_value.is_err() {
let err = response_value.err().unwrap();
debug!("Error Occured during packet read: {}", err);
return Err(err);
}
let mut response_header = response_value.unwrap();
response = response_header.split_off(16);
let response_length = LittleEndian::read_u16(&response_header[4..6]);
let response_command_index = LittleEndian::read_u16(&response_header[6..8]);
debug_assert!(response.len() == response_length as usize);
debug_assert!(response_command_index == command_index);
break;
}
Ok(response)
}
pub fn supports_dcp_category(&mut self, category: DCPCategory) -> Result<bool, rusb::Error> {
let mut out = [0; 2];
LittleEndian::write_u16(&mut out, category.id());
let result = self.request_data(Command::SystemInfo(SupportsDCPCategory), &out)?;
Ok(LittleEndian::read_u16(&result) == 1)
}
pub fn get_system_info(&mut self) -> Result<(), rusb::Error> {
let _result =
self.request_data(Command::SystemInfo(SystemInfoCommand::FirmwareVersion), &[])?;
Ok(())
}
pub fn get_firmware_version(&mut self) -> Result<FirmwareVersions, CommandError> {
let result = self.request_data(
Command::GetHardwareInfo(HardwareInfoCommand::FirmwareVersion),
&[],
)?;
let mut cursor = Cursor::new(result);
let firmware_packed = cursor.read_u32::<LittleEndian>()?;
let firmware_build = cursor.read_u32::<LittleEndian>()?;
let firmware = VersionNumber(
firmware_packed >> 12,
(firmware_packed >> 8) & 0xF,
firmware_packed & 0xFF,
firmware_build,
);
let _unknown = cursor.read_u32::<LittleEndian>()?;
let fpga_count = cursor.read_u32::<LittleEndian>()?;
let dice_build = cursor.read_u32::<LittleEndian>()?;
let dice_packed = cursor.read_u32::<LittleEndian>()?;
let dice = VersionNumber(
(dice_packed >> 20) & 0xF,
(dice_packed >> 12) & 0xFF,
dice_packed & 0xFFF,
dice_build,
);
Ok(FirmwareVersions {
firmware,
fpga_count,
dice,
})
}
pub fn get_serial_number(&mut self) -> Result<(String, String), CommandError> {
let result = self.request_data(
Command::GetHardwareInfo(HardwareInfoCommand::SerialNumber),
&[],
)?;
let serial_slice = &result[..24];
let serial_len = serial_slice
.iter()
.position(|&c| c == 0)
.unwrap_or(serial_slice.len()) as usize;
let serial_number = String::from_utf8_lossy(&serial_slice[..serial_len]).to_string();
let date_slice = &result[24..];
let date_len = date_slice
.iter()
.position(|&c| c == 0)
.unwrap_or(date_slice.len()) as usize;
let manufacture_date = String::from_utf8_lossy(&date_slice[..date_len]).to_string();
Ok((serial_number, manufacture_date))
}
pub fn set_fader(&mut self, fader: FaderName, channel: ChannelName) -> Result<(), rusb::Error> {
self.request_data(Command::SetFader(fader), &[channel as u8, 0x00, 0x00, 0x00])?;
Ok(())
}
pub fn set_volume(&mut self, channel: ChannelName, volume: u8) -> Result<(), rusb::Error> {
self.request_data(Command::SetChannelVolume(channel), &[volume])?;
Ok(())
}
pub fn set_encoder_value(
&mut self,
encoder: EncoderName,
value: u8,
) -> Result<(), rusb::Error> {
self.request_data(Command::SetEncoderValue(encoder), &[value])?;
Ok(())
}
pub fn set_encoder_mode(
&mut self,
encoder: EncoderName,
mode: u8,
resolution: u8
) -> Result<(), rusb::Error> {
self.request_data(Command::SetEncoderMode(encoder), &[mode, resolution])?;
Ok(())
}
pub fn set_channel_state(
&mut self,
channel: ChannelName,
state: ChannelState,
) -> Result<(), rusb::Error> {
self.request_data(Command::SetChannelState(channel), &[state.id()])?;
Ok(())
}
pub fn set_button_states(&mut self, data: [ButtonStates; 24]) -> Result<(), rusb::Error> {
self.request_data(Command::SetButtonStates(), &data.map(|state| state as u8))?;
Ok(())
}
pub fn set_button_colours(&mut self, data: [u8; 328]) -> Result<(), rusb::Error> {
self.request_data(Command::SetColourMap(), &data)?;
Ok(())
}
pub fn set_button_colours_1_3_40(&mut self, data: [u8; 520]) -> Result<(), rusb::Error> {
self.request_data(Command::SetColourMap(), &data)?;
Ok(())
}
pub fn set_fader_display_mode(
&mut self,
fader: FaderName,
gradient: bool,
meter: bool,
) -> Result<(), rusb::Error> {
let gradient_byte: u8 = if gradient { 0x01 } else { 0x00 };
let meter_byte: u8 = if meter { 0x01 } else { 0x00 };
self.request_data(
Command::SetFaderDisplayMode(fader),
&[gradient_byte, meter_byte],
)?;
Ok(())
}
pub fn set_fader_scribble(
&mut self,
fader: FaderName,
data: [u8; 1024],
) -> Result<(), rusb::Error> {
self.request_data(Command::SetScribble(fader), &data)?;
Ok(())
}
pub fn set_routing(
&mut self,
input_device: InputDevice,
data: [u8; 22],
) -> Result<(), rusb::Error> {
self.request_data(Command::SetRouting(input_device), &data)?;
Ok(())
}
pub fn set_microphone_gain(
&mut self,
microphone_type: MicrophoneType,
gain: u16,
) -> Result<(), CommandError> {
let mut gain_value = [0; 4];
LittleEndian::write_u16(&mut gain_value[2..], gain);
self.set_mic_param(&[
(
MicrophoneParamKey::MicType,
match microphone_type.has_phantom_power() {
true => [0x01, 0x00, 0x00, 0x00],
false => [0x00, 0x00, 0x00, 0x00],
},
),
(microphone_type.get_gain_param(), gain_value),
])?;
Ok(())
}
pub fn get_microphone_level(&mut self) -> Result<u16, rusb::Error> {
let result = self.request_data(Command::GetMicrophoneLevel, &[])?;
Ok(LittleEndian::read_u16(&result))
}
pub fn set_effect_values(&mut self, effects: &[(EffectKey, i32)]) -> Result<(), CommandError> {
let mut data = Vec::with_capacity(effects.len() * 8);
let mut cursor = Cursor::new(&mut data);
for (key, value) in effects {
cursor.write_u32::<LittleEndian>(*key as u32)?;
cursor.write_i32::<LittleEndian>(*value)?;
}
self.request_data(Command::SetEffectParameters, &data)?;
Ok(())
}
pub fn set_mic_param(
&mut self,
params: &[(MicrophoneParamKey, [u8; 4])]
) -> Result<(), CommandError> {
let mut data = Vec::with_capacity(params.len() * 8);
let mut cursor = Cursor::new(&mut data);
for (key, value) in params {
cursor.write_u32::<LittleEndian>(*key as u32)?;
cursor.write_all(value)?;
}
self.request_data(Command::SetMicrophoneParameters, &data)?;
Ok(())
}
pub fn get_button_states(&mut self) -> Result<(EnumSet<Buttons>, [u8; 4], [i8; 4]), rusb::Error> {
let result = self.request_data(Command::GetButtonStates, &[])?;
let mut pressed = EnumSet::empty();
let mut mixers = [0; 4];
let mut encoders = [0; 4];
let button_states = LittleEndian::read_u32(&result[0..4]);
mixers[0] = result[8];
mixers[1] = result[9];
mixers[2] = result[10];
mixers[3] = result[11];
encoders[0] = result[4] as i8;
encoders[1] = result[5] as i8;
encoders[2] = result[6] as i8;
encoders[3] = result[7] as i8;
for button in EnumSet::<Buttons>::all() {
if button_states & (1 << button as u8) != 0 {
pressed.insert(button);
}
}
Ok((pressed, mixers, encoders))
}
pub fn await_interrupt(&mut self, duration: Duration) -> bool {
let mut buffer = [0u8; 6];
let message = self.handle.read_interrupt(0x81, &mut buffer, duration);
if message.is_err() {
println!("Error Reading Interrupt..");
}
matches!(
message,
Ok(_)
)
}
}