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
|
/*
* Copyright (C) 2018 Mark Hills <mark@xwax.org>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License version 2 for more details.
*
* You should have received a copy of the GNU General Public License
* version 2 along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
*/
/*
* Specialised functions for the Novation Dicer controller
*
* The Dicer is a standard MIDI device, with buttons on input and the
* corresponding LEDs on output. A single MIDI device consists of two
* units, one for each turntable.
*
* Each unit has 5 buttons, but there are three 'pages' of buttons
* controlled in the firmware, and then a shift mode for each. So we
* see the full MIDI device as 60 possible buttons.
*/
#include <stdlib.h>
#include "controller.h"
#include "debug.h"
#include "deck.h"
#include "dicer.h"
#include "midi.h"
#include "realtime.h"
#define NBUTTONS 5
#define CUE 0
#define LOOP 1
#define ROLL 2
#ifdef DEBUG
static const char *actions[] = {
"CUE",
"LOOP",
"ROLL"
};
#endif
/* LED states */
typedef unsigned char led_t;
#define ON 0x1
#define PRESSED 0x2
#define SYNCED 0x4
struct dicer {
struct midi midi;
struct deck *left, *right;
led_t left_led[NBUTTONS], right_led[NBUTTONS];
char obuf[180];
size_t ofill;
};
/*
* Add a deck to the dicer or pair of dicer
*
* Return: -1 if the deck could not be added, otherwise zero
*/
static int add_deck(struct controller *c, struct deck *k)
{
struct dicer *d = c->local;
debug("%p add deck %p", d, k);
if (d->left != NULL && d->right != NULL)
return -1;
if (d->left == NULL) {
d->left = k;
} else {
d->right = k;
}
return 0;
}
/*
* Write a MIDI command sequence which would bring the given LED
* up-to-date
*
* Return: n, or -1 if not enough buffer space
* Post: if buffer space is available, n bytes are written to buf
*/
static ssize_t led_cmd(led_t led, char *buf, size_t len,
bool right, unsigned char action,
bool shift, unsigned char button)
{
if (len < 3)
return -1;
assert(action <= ROLL);
buf[0] = (right ? 0x9d : 0x9a) + action;
assert(button < NBUTTONS);
buf[1] = (shift ? 0x41 : 0x3c) + button;
/* The Dicer allows us to use any colour in any mode. For
* simplicity, we tie the colour to the mode at this layer */
switch (action) {
case CUE:
buf[2] = 0x00;
break;
case LOOP:
buf[2] = 0x70;
break;
case ROLL:
buf[2] = 0x40;
break;
default:
abort();
}
if (led & ON)
buf[2] += 0xa;
if (led & PRESSED)
buf[2] += 0x5;
debug("compiling LED command: %02hhx %02hhx %02hhx",
buf[0], buf[1], buf[2]);
return 3;
}
/*
* Push control code for a particular output LED
*
* Return: n, or -1 if not enough buffer space
* Post: if buf is large enough, LED is synced and n bytes are written
*/
static ssize_t sync_one_led(led_t *led, char *buf, size_t len,
bool right, unsigned char button)
{
unsigned int a;
size_t t;
if (*led & SYNCED)
return 0;
debug("syncing LED: %s %d", right ? "right" : "left", button);
/* For simplicify we light all LEDs in all modes the same:
* (cue, loop, roll) x (shift, non-shift) */
t = 0;
for (a = 0; a <= ROLL; a++) {
ssize_t z;
z = led_cmd(*led, buf, len, right, a, false, button);
if (z == -1)
return -1;
buf += z;
len -= z;
t += z;
z = led_cmd(*led, buf, len, right, a, true, button);
if (z == -1)
return -1;
buf += z;
len -= z;
t += z;
}
*led |= SYNCED;
return t;
}
/*
* Return: number of bytes written to the buffer
*/
static size_t sync_one_dicer(led_t led[NBUTTONS], bool right,
char *buf, size_t len)
{
size_t n, t;
t = 0;
for (n = 0; n < NBUTTONS; n++) {
ssize_t z;
z = sync_one_led(&led[n], buf, len, right, n);
if (z == -1) {
debug("output buffer full; expect incorrect LEDs");
break;
}
buf += z;
len -= z;
t += z;
}
return t;
}
/*
* Write a MIDI command sequence to sync all hardware LEDs with the
* state held in memory.
*
* The Dicer first appears to only have five output LEDs on two
* controllers. But there are three modes for each, and then shift
* on/off modes: total (5 * 2 * 3 * 2) = 60
*/
static void sync_all_leds(struct dicer *d)
{
size_t w;
char *buf;
size_t len;
buf = d->obuf + d->ofill;
len = sizeof(d->obuf) - d->ofill;
/* Top-up the buffer, even if not empty */
w = sync_one_dicer(d->left_led, false, buf, len);
buf += w;
len -= w;
d->ofill += w;
w = sync_one_dicer(d->right_led, true, buf, len);
buf += w;
len -= w;
d->ofill += w;
if (d->ofill > 0) {
ssize_t z;
debug("writing %zd bytes of MIDI command", d->ofill);
z = midi_write(&d->midi, d->obuf, d->ofill);
if (z == -1)
return;
if (z < d->ofill)
memmove(d->obuf, d->obuf + z, z);
d->ofill -= z;
}
}
/*
* Modify state flags of an LED
*
* Post: *led is updated with the new flags
*/
static void set_led(led_t *led, unsigned char set, unsigned char clear)
{
led_t n;
n = (*led & ~clear) | set;
if (n != *led)
*led = n & ~SYNCED;
}
/*
* Act on an event, and update the given LED status
*/
static void event_decoded(struct deck *d, led_t led[NBUTTONS],
unsigned char action, bool shift,
unsigned char button, bool on)
{
/* Always toggle the LED status */
if (on) {
set_led(&led[button], PRESSED, 0);
} else {
set_led(&led[button], 0, PRESSED);
}
/* FIXME: We assume that we are the only operator of the cue
* points; we should change the LEDs via a callback from deck */
if (shift && on) {
deck_unset_cue(d, button);
set_led(&led[button], 0, ON);
}
if (shift)
return;
if (action == CUE && on) {
deck_cue(d, button);
set_led(&led[button], ON, 0);
}
if (action == LOOP) {
if (on) {
deck_punch_in(d, button);
set_led(&led[button], ON, 0);
} else {
deck_punch_out(d);
}
}
}
/*
* Process an event from the device, given the MIDI control codes
*/
static void event(struct dicer *d, unsigned char buf[3])
{
struct deck *deck;
led_t *led;
unsigned char action, button;
bool on, shift;
/* Ignore signal that the second controller is (un)plugged */
if (buf[0] == 0xba && buf[1] == 0x11 && (buf[2] == 0x0 || buf[2] == 0x08))
return;
switch (buf[0]) {
case 0x9a:
case 0x9b:
case 0x9c:
deck = d->left;
led = d->left_led;
action = buf[0] - 0x9a;
break;
case 0x9d:
case 0x9e:
case 0x9f:
deck = d->right;
led = d->right_led;
action = buf[0] - 0x9d;
break;
default:
abort();
}
if (deck == NULL) /* no deck assigned to this unit */
return;
switch (buf[1]) {
case 0x3c:
case 0x3d:
case 0x3e:
case 0x3f:
case 0x40:
button = buf[1] - 0x3c;
shift = false;
break;
case 0x41:
case 0x42:
case 0x43:
case 0x44:
case 0x45:
button = buf[1] - 0x41;
shift = true;
break;
default:
abort();
}
switch (buf[2]) {
case 0x00:
on = false;
break;
case 0x7f:
on = true;
break;
default:
abort();
}
debug("%s button %s%hhd %s, deck %p",
actions[action],
shift ? "SHIFT-" : "",
button, on ? "ON" : "OFF",
deck);
event_decoded(deck, led, action, shift, button, on);
}
static ssize_t pollfds(struct controller *c, struct pollfd *pe, size_t z)
{
struct dicer *d = c->local;
return midi_pollfds(&d->midi, pe, z);
}
/*
* Handler in the realtime thread, which polls on both input
* and output
*/
static int realtime(struct controller *c)
{
struct dicer *d = c->local;
for (;;) {
unsigned char buf[3];
ssize_t z;
z = midi_read(&d->midi, buf, sizeof buf);
if (z == -1)
return -1;
if (z == 0)
break;
debug("got event");
event(d, buf);
}
sync_all_leds(d);
return 0;
}
static void clear(struct controller *c)
{
struct dicer *d = c->local;
size_t n;
debug("%p", d);
/* FIXME: Uses non-blocking functionality really intended
* for realtime; no guarantee buffer is emptied */
for (n = 0; n < NBUTTONS; n++) {
set_led(&d->left_led[n], 0, ON);
set_led(&d->right_led[n], 0, ON);
}
sync_all_leds(d);
midi_close(&d->midi);
free(c->local);
}
static struct controller_ops dicer_ops = {
.add_deck = add_deck,
.pollfds = pollfds,
.realtime = realtime,
.clear = clear,
};
int dicer_init(struct controller *c, struct rt *rt, const char *hw)
{
size_t n;
struct dicer *d;
debug("init %p from %s", c, hw);
d = malloc(sizeof *d);
if (d == NULL) {
perror("malloc");
return -1;
}
if (midi_open(&d->midi, hw) == -1)
goto fail;
d->left = NULL;
d->right = NULL;
d->ofill = 0;
for (n = 0; n < NBUTTONS; n++) {
d->left_led[n] = 0;
d->right_led[n] = 0;
}
if (controller_init(c, &dicer_ops, d, rt) == -1)
goto fail_midi;
return 0;
fail_midi:
midi_close(&d->midi);
fail:
free(d);
return -1;
}
|