/usr/share/mixxx/controllers/common-hid-packet-parser.js is in mixxx-data 2.0.0~dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 | // Common HID script debugging function. Just to get logging with 'HID' prefix.
HIDDebug = function (message) { print("HID " + message); }
// HID Bit Vector Class
//
// Collection of bits in one parsed packet field. These objects are
// created by HIDPacket addControl and addOutput and should not be
// created manually.
function HIDBitVector () {
this.size = 0;
this.bits = new Object();
}
// Return bit offset based on bitmask
HIDBitVector.prototype.getOffset = function(bitmask) {
for (var i=0;i<32;i++)
if ( (1&bitmask>>i)!=0 )
return i;
return 0;
}
// Add a control bitmask to the HIDBitVector
HIDBitVector.prototype.addBitMask = function(group,name,bitmask) {
var bit = new Object();
bit.type = "button";
bit.packet = undefined;
bit.id = group+"."+name;
bit.group = group;
bit.name = name;
bit.mapped_group = undefined;
bit.mapped_name = undefined;
bit.bitmask = bitmask;
bit.bitmask = bitmask;
bit.bit_offset = this.getOffset(bitmask);
bit.callback = undefined;
bit.value = undefined;
bit.auto_repeat = undefined;
bit.auto_repeat_interval = undefined;
this.bits[bit.id] = bit;
}
// Add a Output control bitmask to the HIDBitVector
HIDBitVector.prototype.addOutputMask = function(group,name,bitmask) {
var bit = new Object();
bit.type = "output";
bit.packet = undefined;
bit.id = group+"."+name;
bit.group = group;
bit.name = name;
bit.mapped_group = undefined;
bit.mapped_name = undefined;
bit.bitmask = bitmask;
bit.bit_offset = this.getOffset(bitmask);
bit.callback = undefined;
bit.value = undefined;
bit.toggle = undefined;
this.bits[bit.id] = bit;
}
// HID Modifiers object
//
// Wraps all defined modifiers to one object with uniform API.
// Don't call directly, this is available as HIDController.modifiers
function HIDModifierList() {
this.modifiers = Object();
this.callbacks = Object();
}
// Add a new modifier to controller.
HIDModifierList.prototype.add = function(name) {
if (name in this.modifiers) {
HIDDebug("Modifier already defined: " + name);
return;
}
this.modifiers[name] = undefined;
}
// Set modifier value
HIDModifierList.prototype.set = function(name,value) {
if ((!name in this.modifiers)) {
HIDDebug("Unknown modifier: " + name);
return;
}
this.modifiers[name] = value;
if (name in this.callbacks) {
var callback = this.callbacks[name];
callback(value);
}
}
// Get modifier value
HIDModifierList.prototype.get = function(name) {
if (!(name in this.modifiers)) {
HIDDebug("Unknown modifier: " + name);
return false;
}
return this.modifiers[name];
}
// Set modifier callback (update function after modifier state changes)
HIDModifierList.prototype.setCallback = function(name,callback) {
if ((!name in this.modifiers)) {
HIDDebug("Unknonwn modifier: " + name);
return;
}
this.callbacks[name] = callback;
}
//
// HID Packet object
//
// One HID input/output packet to register to HIDController
// name name of packet
// header list of bytes to match from beginning of packet
// length packet length
// callback function to call when this packet type is input
// and is received. If packet callback is set, the
// packet is not parsed by delta functions.
// callback is not meaningful for output packets
function HIDPacket(name,header,length,callback) {
this.name = name;
this.header = header;
this.length = length;
this.callback = callback;
this.groups = new Object();
// Size of various 'pack' values in bytes
this.packSizes = { b: 1, B: 1, h: 2, H: 2, i: 4, I: 4 };
this.signedPackFormats = [ "b", "h", "i"];
}
// Pack a field value to the packet.
// Can only pack bits and byte values, patches welcome.
HIDPacket.prototype.pack = function(packet,field) {
var value = 0;
if (!(field.pack in this.packSizes)) {
HIDDebug("ERROR parsing packed value: invalid pack format " + field.pack);
return;
}
var bytes = this.packSizes[field.pack];
var signed = false;
if (this.signedPackFormats.indexOf(field.pack)!=-1)
signed = true;
if (field.type=="bitvector") {
// TODO - fix multi byte bit vector outputs
if (bytes>1) {
HIDDebug("ERROR: packing multibyte bit vectors not yet supported");
return;
}
for (bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
packet.data[field.offset] = packet.data[field.offset] | bit.value;
}
return;
}
value = (field.value!=undefined) ? field.value : 0;
if (value<field.min || value>field.max) {
HIDDebug("ERROR " + field.id + " packed value out of range: " + value);
return;
}
for (var byte_index=0;byte_index<bytes;byte_index++) {
var index = field.offset+byte_index;
if (signed) {
if (value>=0) {
packet.data[index] = (value>>(byte_index*8)) & 255;
} else {
packet.data[index] = 255 - ((-(value+1)>>(byte_index*8)) & 255);
}
} else {
packet.data[index] = (value>>(byte_index*8)) & 255;
}
}
}
// Parse and return field value matching the 'pack' field from field attributes.
// Valid values are:
// b signed byte
// B unsigned byte
// h signed short
// H unsigned short
// i signed integer
// I unsigned integer
HIDPacket.prototype.unpack = function(data,field) {
var value = 0;
if (!(field.pack in this.packSizes)) {
HIDDebug("ERROR parsing packed value: invalid pack format " + field.pack);
return;
}
var bytes = this.packSizes[field.pack];
var signed = false;
if (this.signedPackFormats.indexOf(field.pack)!=-1)
signed = true;
for (field_byte=0;field_byte<bytes;field_byte++) {
if (data[field.offset+field_byte]==255 && field_byte==4)
value += 0;
else
value += data[field.offset+field_byte] * Math.pow(2,(field_byte*8));
}
if (signed) {
var max_value = Math.pow(2,bytes*8);
var split = max_value/2-1;
if (value>split)
value = value-max_value;
}
return value;
}
// Find HID packet group matching name.
// Create group if create is true
HIDPacket.prototype.getGroup = function(name,create) {
if (this.groups==undefined)
this.groups = new Object();
if (name in this.groups)
return this.groups[name];
if (!create)
return undefined;
this.groups[name] = new Object();
return this.groups[name];
}
// Lookup HID packet field matching given offset and pack type
// Returns undefined if no patching field can be found.
HIDPacket.prototype.getFieldByOffset = function(offset,pack) {
if (!(pack in this.packSizes)) {
HIDDebug("Unknown pack string " + pack);
return undefined;
}
var end_offset = offset + this.packSizes[pack];
if (end_offset>this.length) {
HIDDebug("Invalid offset+pack range " +
offset + "-" + end_offset +
" for " + this.length + " byte packet"
);
return undefined;
}
var group = undefined;
var field = undefined;
for (var group_name in this.groups) {
group = this.groups[group_name];
for (var field_id in group) {
field = group[field_id];
// Same field offset
if (field.offset==offset)
return field;
// 7-8 8-9
// Offset for smaller packet inside multibyte field
if (field.offset<offset && field.end_offset>=end_offset)
return field;
// Packet offset starts inside field, may overflow
if (field.offset<offset && field.end_offset>offset)
return field;
// Packet start before field, ends or overflows field
if (field.offset>offset && field.offset<end_offset)
return field;
}
}
return undefined;
}
// Return a field by group and name from the packet,
// Returns undefined if field could not be found
HIDPacket.prototype.getField = function(group,name) {
var field_id = group+"."+name;
if (!(group in this.groups)) {
HIDDebug("PACKET " + this.name + " group not found " + group);
return undefined;
}
var control_group = this.groups[group];
if (field_id in control_group)
return control_group[field_id];
// Lookup for bit fields in bitvector matching field name
for (var group_name in this.groups) {
var control_group = this.groups[group_name];
for (field_name in control_group) {
var field = control_group[field_name];
if (field==undefined || field.type!="bitvector")
continue
for (bit_name in field.value.bits) {
var bit = field.value.bits[bit_name];
if (bit.id==field_id) {
return field;
}
}
}
}
// Field not found
return undefined;
}
// Return reference to a bit in a bitvector field
HIDPacket.prototype.lookupBit = function(group,name) {
var field = this.getField(group,name);
if (field==undefined) {
HIDDebug("Bitvector match not found: "+group+"."+name);
return undefined;
}
var bit_id = group+"."+name;
for (bit_name in field.value.bits) {
var bit = field.value.bits[bit_name];
if (bit.id==bit_id)
return bit;
}
HIDDebug("BUG: bit not found after successful field lookup");
return undefined;
}
// Remove a control registered. Normally not needed
HIDPacket.prototype.removeControl = function(group,name) {
var control_group = this.getGroup(group);
if (!(name in control_group)) {
HIDDebug("Field not in control group " + group + ": " + name);
return;
}
delete control_group[name];
}
// Register a numeric value to parse from input packet
// Parameters:
// group control group name
// name name of the field
// offset field offset inside packet (bytes)
// pack control packing format for unpack()
// bitmask bitmask size, undefined for byte(s) controls
// NOTE: Parsing bitmask with multiple bits is not supported yet.
// isEncoder indicates if this is an encoder which should be wrapped and delta reported
// callback callback function to apply to the field value, or undefined for no callback
//
HIDPacket.prototype.addControl = function(group,name,offset,pack,bitmask,isEncoder) {
var control_group = this.getGroup(group,true);
var bitvector = undefined;
if (control_group==undefined) {
HIDDebug("ERROR creating HID packet group " + group);
return;
}
if (!(pack in this.packSizes)) {
HIDDebug("Unknown pack value " + pack);
return;
}
var field = this.getFieldByOffset(offset,pack);
if (field!=undefined) {
if (bitmask==undefined) {
HIDDebug("ERROR registering offset " +offset+ " pack " + pack);
HIDDebug(
"ERROR trying to overwrite non-bitmask control " + group + " " + name
);
return;
}
bitvector = field.value;
bitvector.addBitMask(group,name,bitmask);
return;
}
field = new Object();
field.packet = undefined;
field.id = group+"."+name;
field.group = group;
field.name = name;
field.mapped_group = undefined;
field.mapped_name = undefined;
field.pack = pack;
field.offset = offset;
field.end_offset = offset + this.packSizes[field.pack];
field.bitmask = bitmask;
field.isEncoder = isEncoder;
field.callback = undefined;
field.soft_takeover = false;
field.ignored = false;
field.auto_repeat = undefined;
field.auto_repeat_interval = undefined;
var packet_max_value = Math.pow(2,this.packSizes[field.pack]*8);
if (this.signedPackFormats.indexOf(pack)!=-1) {
field.min = 0 - (packet_max_value/2)+1;
field.max = (packet_max_value/2)-1;
} else {
field.min = 0;
field.max = packet_max_value-1;
}
if (bitmask==undefined || bitmask==packet_max_value) {
field.type = "control";
field.value = undefined;
field.delta = 0;
field.mindelta = 0;
} else {
if (this.signedPackFormats.indexOf(pack)!=-1) {
HIDDebug("ERROR registering bitvector: signed fields not supported");
return;
}
// Create a new bitvector field and add the bit to that
// TODO - accept controls with bitmask < packet_max_value
field_name = "bitvector_" + offset;
field.type = "bitvector";
field.name = field_name;
field.id = group+"."+field_name;
bitvector = new HIDBitVector(field.max);
bitvector.size = field.max;
bitvector.addBitMask(group,name,bitmask);
field.value = bitvector;
field.delta = undefined;
field.soft_takeover = undefined;
field.mindelta = undefined;
}
// Add the new field to the packet
control_group[field.id] = field;
}
// Register a Output control field or Output control bit to output packet
// Output control field:
// Output field with no bitmask, controls Output with multiple values
// Output control bit:
// Output with with bitmask, controls Output with a single bit
//
// It is recommended to define callbacks after packet creationg with
// setCallback instead of adding it directly here. But you can do it.
HIDPacket.prototype.addOutput = function(group,name,offset,pack,bitmask,callback) {
var control_group = this.getGroup(group,true);
var field = undefined;
var bitvector = undefined;
var field_id = group+"."+name;
if (control_group==undefined) {
return;
}
if (!(pack in this.packSizes)) {
HIDDebug("ERROR: unknown Output control pack value " + pack);
return;
}
// Check if we are adding a Output bit to existing bitvector
field = this.getFieldByOffset(offset,pack);
if (field!=undefined) {
if (bitmask==undefined) {
HIDDebug(
"ERROR: overwrite non-bitmask control " + group+"."+name
);
return;
}
bitvector = field.value;
bitvector.addOutputMask(group,name,bitmask);
return;
}
field = new Object();
field.id = field_id;
field.group = group;
field.name = name;
field.mapped_group = undefined;
field.mapped_name = undefined;
field.pack = pack;
field.offset = offset;
field.end_offset = offset + this.packSizes[field.pack];
field.bitmask = bitmask;
field.callback = callback;
field.toggle = undefined;
var packet_max_value = Math.pow(2,this.packSizes[field.pack]*8);
if (this.signedPackFormats.indexOf(pack)!=-1) {
field.min = 0 - (packet_max_value/2)+1;
field.max = (packet_max_value/2)-1;
} else {
field.min = 0;
field.max = packet_max_value-1;
}
if (bitmask==undefined || bitmask==packet_max_value) {
field.type = "output";
field.value = undefined;
field.delta = undefined;
field.mindelta = undefined;
} else {
// Create new Output bitvector control field, add bit to it
// rewrite name to use bitvector instead
field_name = "bitvector_" + offset;
field.type = "bitvector";
field.id = group+"."+field_name;
field.name = field_name;
bitvector = new HIDBitVector();
bitvector.size = field.max;
bitvector.addOutputMask(group,name,bitmask);
field.value = bitvector;
field.delta = undefined;
field.mindelta = undefined;
}
// Add Output to HID packet
control_group[field.id] = field;
}
// Register a callback to field or a bit vector bit.
// Does not make sense for Output fields but you can do that.
HIDPacket.prototype.setCallback = function(group,name,callback) {
var field = this.getField(group,name);
var field_id = group+"."+name;
if (callback==undefined) {
HIDDebug("Callback to add was undefined for " + field_id);
return;
}
if (field==undefined) {
HIDDebug("setCallback: field for " +field_id+ " not found"
);
return;
}
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
if (bit_id!=field_id)
continue;
bit.callback = callback;
return;
}
HIDDebug("ERROR: BIT NOT FOUND " + field_id);
} else {
field.callback = callback;
}
}
// Set 'ignored' flag for field to given value (true or false)
// If field is ignored, it is not reported in 'delta' objects.
HIDPacket.prototype.setIgnored = function(group,name,ignored) {
var field = this.getField(group,name);
if (field==undefined) {
HIDDebug("ERROR setting ignored flag for " + group +" " + name);
return;
}
field.ignored = ignored;
}
// Adjust field's minimum delta value.
// Input value changes smaller than this are not reported in delta
HIDPacket.prototype.setMinDelta = function(group,name,mindelta) {
field = this.getField(group,name);
if (field==undefined) {
HIDDebug("ERROR adjusting mindelta for " + group +" " + name);
return;
}
if (field.type=="bitvector") {
HIDDebug("ERROR setting mindelta for bitvector packet does not make sense");
return;
}
field.mindelta = mindelta;
}
// Parse bitvector field values, returning object with the named bits set.
// Value must be a valid unsigned byte to parse, with enough bits.
// Returns list of modified bits (delta)
HIDPacket.prototype.parseBitVector = function(field,value) {
var bits = new Object();
var bit;
var new_value;
for (var bit_id in field.value.bits) {
bit = field.value.bits[bit_id];
new_value = (bit.bitmask&value)>>bit.bit_offset;
if (bit.value!=undefined && bit.value!=new_value)
bits[bit_id] = bit;
bit.value = new_value;
}
return bits;
}
// Parse input packet fields from data.
// Data is expected to be a Packet() received from HID device.
// Returns list of changed fields with new value.
// BitVectors are returned as bits you can iterate separately.
HIDPacket.prototype.parse = function(data) {
var field_changes = new Object();
var group;
var group_name;
var field;
var field_name;
var field_id;
var bit;
var bit_value;
for (group_name in this.groups) {
group = this.groups[group_name];
for (field_id in group) {
field = group[field_id];
if (field==undefined)
continue;
var value = this.unpack(data,field);
if (value == undefined) {
HIDDebug("Error parsing packet field value for " + field_id);
return;
}
if (field.type=="bitvector") {
// Bitvector deltas are checked in parseBitVector
var changed_bits = this.parseBitVector(field,value);
for (bit_name in changed_bits)
field_changes[bit_name] = changed_bits[bit_name];
} else if (field.type=="control") {
if (field.value==value && field.mindelta!=undefined)
continue;
if (field.ignored || field.value==undefined) {
field.value = value;
continue;
}
if (field.isEncoder) {
if (field.value==field.max && value==field.min) {
change = 1;
field.delta = 1;
} else if (value==field.max && field.value==field.min) {
change = 1;
field.delta = -1;
} else {
change = 1;
field.delta = value-field.value;
}
field.value = value;
} else {
var change = Math.abs(value-field.value);
field.delta = value-field.value;
}
if (field.mindelta==undefined || change>field.mindelta) {
field_changes[field.name] = field;
field.value = value;
}
}
}
}
return field_changes;
}
// Send this HID packet to device.
// First the header bytes are copied to beginning of packet, then
// field object values are packed to the HID packet according to the
// field type.
HIDPacket.prototype.send = function() {
var offset = 0;
var i;
var packet = new Packet(this.length);
for (header_byte=0;header_byte<this.header.length;header_byte++) {
packet.data[header_byte] = this.header[header_byte];
}
for (var group_name in this.groups) {
var group = this.groups[group_name];
for (var field_name in group) {
var field = group[field_name];
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
}
}
this.pack(packet,field);
}
}
//var packet_string = "";
//for (d in packet.data) {
// if (packet.data[d] < 0x10) {
// packet_string += "0";
// }
// packet_string += packet.data[d].toString(16) + " ";
//}
//HIDDebug("packet: " + packet_string);
controller.send(packet.data, packet.length, 0);
}
//
// HID Controller Class
//
// HID Controller with packet parser
// Global attributes include:
//
// initialized by default false, you should set this to true when
// controller is found and everything is OK
// activeDeck by default undefined, used to map the virtual deck
// names 'deck','deck1' and 'deck2' to actual [ChannelX]
// isScratchEnabled set to true, when button 'jog_touch' is active
// buttonStates valid state values for buttons, should contain fields
// released (default 0) and pressed (default 1)
// LEDColors possible Output colors named, must contain 'off' value
// deckOutputColors Which colors to use for each deck. Default 'on' for first
// four decks. Values are like {1: 'red', 2: 'green' }
// and must reference valid OutputColors fields.
// OutputUpdateInterval By default undefined. If set, it's a value for timer
// executed every n ms to update Outputs with updateOutputs()
// modifiers Reference to HIDModifierList object
// toggleButtons List of button names you wish to act as 'toggle', i.e.
// pressing the button and releasing toggles state of the
// control and does not set it off again when released.
//
// Scratch variables (initialized with 'common' defaults, you can override):
// scratchintervalsPerRev Intervals value for scratch_enable
// scratchRPM RPM value for scratch_enable
// scratchAlpha Alpha value for scratch_enable
// scratchBeta Beta value for scratch_enable
// scratchRampOnEnable If 'ramp' is used when enabling scratch
// scratchRampOnDisable If 'ramp' is used when disabling scratch
function HIDController () {
this.initialized = false;
this.activeDeck = undefined;
this.InputPackets = new Object();
this.OutputPackets = new Object();
// Default input control packet name: can be modified for controllers
// which can swap modes (wiimote for example)
this.defaultPacket = "control";
// Callback functions called by deck switching. Undefined by default
this.disconnectDeck = undefined;
this.connectDeck = undefined;
// Scratch parameter defaults for this.scratchEnable function
// override for custom control
this.isScratchEnabled = false;
this.scratchintervalsPerRev = 128;
this.scratchRPM = 33+1/3;
this.scratchAlpha = 1.0/8;
this.scratchBeta = this.scratchAlpha /32;
this.scratchRampOnEnable = false;
this.scratchRampOnDisable = false;
// Button states available
this.buttonStates = { released: 0, pressed: 1};
// Output color values to send
this.LEDColors = {off: 0x0, on: 0x7f};
// Toggle buttons
this.toggleButtons = [ "play", "pfl", "keylock", "quantize", "reverse", "slip_enabled",
"group_[Channel1]_enable", "group_[Channel2]_enable",
"group_[Channel3]_enable", "group_[Channel4]_enable" ];
// Override to set specific colors for multicolor button Output per deck
this.deckOutputColors = {1: "on", 2: "on", 3: "on", 4: "on"};
// Mapping of automatic deck switching with deckSwitch function
this.virtualDecks = ["deck","deck1","deck2","deck3","deck4"];
this.deckSwitchMap = { 1: 2, 2: 1, 3: 4, 4: 3, undefined: 1 };
// Standard target groups available in mixxx. This is used by
// HID packet parser to recognize group parameters we should
// try sending to mixxx.
this.valid_groups = [
"[Channel1]","[Channel2]","[Channel3]","[Channel4]",
"[Sampler1]","[Sampler2]","[Sampler3]","[Sampler4]",
"[Sampler5]","[Sampler6]","[Sampler7]","[Sampler8]",
"[Master]", "[PreviewDeck1]", "[Effects]","[Playlist]","[Flanger]",
"[Microphone]", "[EffectRack1_EffectUnit1]", "[EffectRack1_EffectUnit2]",
"[EffectRack1_EffectUnit3]", "[EffectRack1_EffectUnit4]",
"[InternalClock]" ];
// Set to value in ms to update Outputs periodically
this.OutputUpdateInterval = undefined;
this.modifiers = new HIDModifierList();
this.scalers = new Object();
this.timers = new Object();
this.auto_repeat_interval = 100;
}
// Function to close the controller object cleanly
HIDController.prototype.close = function() {
for (var name in this.timers) {
var timer = this.timers[name];
if (timer==undefined)
continue;
engine.stopTimer(timer);
this.timers[name] = undefined;
}
}
// Initialize our packet data and callbacks. This does not seem to
// work when executed from here, but we keep a stub just in case.
HIDController.prototype.initializePacketData = function() { }
// Return deck number from deck name. Deck name can't be virtual deck name
// in this function call.
HIDController.prototype.resolveDeck = function(group) {
if (group==undefined)
return undefined;
var result = group.match(/\[Channel[0-9]+\]/);
if (!result)
return undefined;
var str = group.replace(/\[Channel/,"");
return str.substring(0,str.length-1);
}
// Return the group name from given deck number.
HIDController.prototype.resolveDeckGroup = function(deck) {
if (deck==undefined)
return undefined;
return "[Channel"+deck+"]";
}
// Map virtual deck names to real deck group. If group is already
// a real mixxx group value, just return it as it without mapping.
HIDController.prototype.resolveGroup = function(group) {
var channel_name = /\[Channel[0-9]+\]/;
if (group!=undefined && group.match(channel_name) )
return group;
if (this.valid_groups.indexOf(group)!=-1) {
return group;
}
if (group=="deck" || group==undefined) {
if (this.activeDeck==undefined)
return undefined;
return "[Channel" + this.activeDeck + "]";
}
if (this.activeDeck==1 || this.activeDeck==2) {
if (group=="deck1") return "[Channel1]";
if (group=="deck2") return "[Channel2]";
}
if (this.activeDeck==3 || this.activeDeck==4) {
if (group=="deck1") return "[Channel3]";
if (group=="deck2") return "[Channel4]";
}
return undefined;
}
// Find Output control matching give group and name
// Returns undefined if output field can't be found.
HIDController.prototype.getOutputField = function(m_group,m_name) {
for (var packet_name in this.OutputPackets) {
var packet = this.OutputPackets[packet_name];
for (var group_name in packet.groups) {
var group = packet.groups[group_name];
for (var field_name in group) {
var field = group[field_name];
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
if (bit.mapped_group==m_group && bit.mapped_name==m_name)
return bit;
if (bit.group==m_group && bit.name==m_name)
return bit;
}
continue;
}
if (field.mapped_group==m_group && field.mapped_name==m_name)
return field;
if (field.group==m_group && field.name==m_name)
return field;
}
}
}
return undefined;
}
// Find input packet matching given name.
// Returns undefined if input packet name is not registered.
HIDController.prototype.getInputPacket = function(name) {
if (!(name in this.InputPackets))
return undefined;
return this.InputPackets[name];
}
// Find output packet matching given name
// Returns undefined if output packet name is not registered.
HIDController.prototype.getOutputPacket = function(name) {
if (!(name in this.OutputPackets))
return undefined;
return this.OutputPackets[name];
}
// Set input packet callback afterwards
HIDController.prototype.setPacketCallback = function(packet,callback) {
var input_packet = this.getInputPacket(packet);
input_packet.callback = callback;
}
// Register packet field's callback.
// If packet has callback, it is still parsed but no field processing is done,
// callback is called directly after unpacking fields from packet.
HIDController.prototype.setCallback = function(packet,group,name,callback) {
var input_packet = this.getInputPacket(packet);
if (input_packet==undefined) {
HIDDebug("Input packet not found " + packet);
return;
}
input_packet.setCallback(group,name,callback);
}
// Register scaling function for a control name
// This does not check if given control name is valid
HIDController.prototype.setScaler = function(name,callback) {
if (name in this.scalers)
return;
this.scalers[name] = callback;
}
// Lookup scaling function for control
// Returns undefined if function is not registered.
HIDController.prototype.getScaler = function(name,callback) {
if (!(name in this.scalers))
return undefined;
return this.scalers[name];
}
// Change type of a previously defined field to modifier and register it
HIDController.prototype.linkModifier = function(group,name,modifier) {
var packet = this.getInputPacket(this.defaultPacket);
if (packet==undefined) {
HIDDebug(
"ERROR creating modifier: input packet "+this.defaultPacket+" not found"
);
return;
}
var bit_id = group+"."+name;
var field = packet.lookupBit(group,name);
if (field==undefined) {
HIDDebug("BIT field not found: " + bit_id);
return;
}
field.group = "modifiers";
field.name = modifier;
this.modifiers.set(modifier);
}
// TODO - implement unlinking of modifiers
HIDController.prototype.unlinkModifier = function(group,name,modifier) {
HIDDebug("Unlinking of modifiers not yet implemented");
}
// Link a previously declared HID control to actual mixxx control
HIDController.prototype.linkControl = function(group,name,m_group,m_name,callback) {
var field;
var packet = this.getInputPacket(this.defaultPacket);
if (packet==undefined) {
HIDDebug("ERROR creating modifier: input packet "+this.defaultPacket+" not found");
return;
}
field = packet.getField(group,name);
if (field==undefined) {
HIDDebug("Field not found: " + group+"."+name);
return;
}
if (field.type=="bitvector") {
field = packet.lookupBit(group,name);
if (field==undefined) {
HIDDebug("bit not found: " + group+"."+name);
return;
}
}
field.mapped_group = m_group;
field.mapped_name = m_name;
if (callback!=undefined)
field.callback = callback;
}
// TODO - implement unlinking of controls
HIDController.prototype.unlinkControl = function(group,name) {
}
// Register HID input packet type to controller.
// Input packets can be responses from device to queries, or control
// data details. The default control data packet must be named in
// variable this.defaultPacket to allow automatic processing.
HIDController.prototype.registerInputPacket = function(packet) {
var name;
// Find modifiers and other special cases from packet fields
for (var group_name in packet.groups) {
var group = packet.groups[group_name];
for (var field_name in group) {
var field = group[field_name];
field.packet = packet;
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
bit.packet = packet;
if (bit.group=="modifiers")
this.modifiers.add(bit.name);
}
} else {
if (field.group=="modifiers")
this.modifiers.add(field.name);
}
}
}
this.InputPackets[packet.name] = packet;
}
// Register HID output packet type to controller
// There are no special Output control output packets, just register Outputs to any
// valid packet and we detect them here.
// This module only supports sending bitvector values and byte fields to device.
// If you need other data structures, patches are welcome, or you can just do it
// manually in your script without registering the packet.
HIDController.prototype.registerOutputPacket = function(packet) {
this.OutputPackets[packet.name] = packet;
// Link packet to all fields
for (var group_name in packet.groups) {
var group = packet.groups[group_name];
for (var field_name in group) {
var field = group[field_name];
field.packet = packet;
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
bit.packet = packet;
}
}
}
}
}
// Parse a received input packet fields with "unpack" calls to fields
// Calls packet callback and returns, if packet callback was defined
// Calls processIncomingPacket and processes automated events there.
// If defined, calls processDelta for results after processing automated fields
HIDController.prototype.parsePacket = function(data,length) {
var packet;
var changed_data;
if (this.InputPackets==undefined) {
return;
}
for (var name in this.InputPackets) {
packet = this.InputPackets[name];
if (packet.length!=length) {
continue;
}
// Check for packet header match against data
for (var header_byte=0;header_byte<packet.header.length;header_byte++) {
if (packet.header[header_byte]!=data[header_byte]) {
packet=undefined;
break;
}
}
if (packet==undefined)
continue;
changed_data = packet.parse(data);
if (packet.callback!=undefined) {
packet.callback(packet,changed_data);
return;
}
// Process named group controls
if (packet.name==this.defaultPacket)
this.processIncomingPacket(packet,changed_data);
// Process generic changed_data packet, if callback is defined
if (this.processDelta!=undefined)
this.processDelta(packet,changed_data);
if (this.postProcessDelta!=undefined)
this.postProcessDelta(packet,changed_data);
return;
}
HIDDebug("Received unknown packet of " + length + " bytes");
for (var i in data) HIDDebug("BYTE " + data[i]);
}
// Process the modified field values (delta) from input packet fields for
// input control packet, if packet name is in this.defaultPacket.
//
// Button field processing:
// - Sets modifiers from buttons
// - Calls button callbacks, if defined
// - Finally tries to run matching engine.setValue() function for buttons
// in default mixxx groups, honoring toggleButtons and other button
// details. Not done if a callback was defined for button.
//
// Control field processing
// - Calls scaling functions for control fields, if defined for field.
// Scaling function for encoders (isEncoder attribute is true) scales
// field delta instead of raw value.
// - Calls callback functions for control fields, if defined for field
// - Finally tries run matching engine.setValue() function for control
// fields in default mixxx groups. Not done if a callback was defined.
HIDController.prototype.processIncomingPacket = function(packet,delta) {
var field;
for (var name in delta) {
if (this.ignoredControlChanges!=undefined
&& this.ignoredControlChanges.indexOf(name) != -1)
continue;
field = delta[name];
if (field.type=="button")
this.processButton(field);
else if (field.type=="control")
this.processControl(field);
else
HIDDebug("Unknown field " + field.name + " type " + field.type);
}
}
// Get active group for this field
HIDController.prototype.getActiveFieldGroup = function(field) {
if (field.mapped_group!=undefined) {
return this.resolveGroup(field.mapped_group);
}
group = field.group;
if (group==undefined) {
if (this.activeDeck!=undefined)
return "[Channel" + this.activeDeck + "]";
}
if (this.valid_groups.indexOf(group)!=-1) {
//HIDDebug("Resolving group " + group);
return this.resolveGroup(group);
}
return group;
}
// Get active control name from field
HIDController.prototype.getActiveFieldControl = function(field) {
if (field.mapped_name!=undefined)
return field.mapped_name;
return field.name;
}
// Process given button field, triggering events
HIDController.prototype.processButton = function(field) {
var control;
var value;
var group = this.getActiveFieldGroup(field);
var control = this.getActiveFieldControl(field);
if (group==undefined) {
HIDDebug("processButton: Could not resolve group from "
+ field.group + " " + field.mapped_group + " "
+ field.name + " " + field.mapped_name
);
return;
}
if (group=="modifiers") {
if (field.value!=0)
this.modifiers.set(control,true);
else
this.modifiers.set(control,false);
return;
}
if (field.auto_repeat) {
timer_id = "auto_repeat_" + field.id;
if (field.value) {
this.startAutoRepeatTimer(timer_id,field.auto_repeat_interval);
} else {
this.stopAutoRepeatTimer(timer_id);
}
}
if (field.callback!=undefined) {
field.callback(field);
return;
}
if (control=="jog_touch") {
if (group!=undefined) {
if (field.value==this.buttonStates.pressed)
this.enableScratch(group,true);
else
this.enableScratch(group,false);
}
return;
}
if (this.toggleButtons.indexOf(control)!=-1) {
if (field.value==this.buttonStates.released)
return;
if (engine.getValue(group,control)) {
if (control=="play")
engine.setValue(group,"stop",true);
else
engine.setValue(group,control,false);
} else {
engine.setValue(group,control,true);
}
return;
}
if (field.auto_repeat && field.value==this.buttonStates.pressed) {
HIDDebug("Callback for " + field.group);
engine.setValue(group,control,field.auto_repeat(field));
} else if (engine.getValue(group,control)==false) {
engine.setValue(group,control,true);
} else {
engine.setValue(group,control,false);
}
}
// Process given control field, triggering events
HIDController.prototype.processControl = function(field) {
var value;
var group = this.getActiveFieldGroup(field);
var control = this.getActiveFieldControl(field);
if (group==undefined) {
HIDDebug("processControl: Could not resolve group from "
+ field.group + " " + field.mapped_group + " "
+ field.name + " " + field.mapped_name
);
return;
}
if (field.callback!=undefined) {
value = field.callback(field);
return;
}
if (group=="modifiers") {
this.modifiers.set(control,field.value);
return;
}
if (control=="jog_wheel") {
// Handle jog wheel scratching transparently
this.jog_wheel(field);
return;
}
// Call value scaler if defined and send mixxx signal
value = field.value;
scaler = this.getScaler(control);
if (field.isEncoder) {
var field_delta = field.delta;
if (scaler!=undefined)
field_delta = scaler(group,control,field_delta);
engine.setValue(group,control,field_delta);
} else {
if (scaler!=undefined) {
value = scaler(group,control,value);
// See the Traktor S4 script for how to use this. If the scaler function has this
// parameter set to true, we use the effects-engine setParameter call instead of
// setValue.
if (scaler.useSetParameter) {
engine.setParameter(group, control, value);
return;
}
}
engine.setValue(group,control,value);
}
}
// Toggle control state from toggle button
HIDController.prototype.toggle = function(group,control,value) {
if (value==this.buttonStates.released)
return;
var status = (engine.getValue(group,control)==true) ? false : true;
engine.setValue(group,control,status);
}
// Toggle play/pause state
HIDController.prototype.togglePlay = function(group,field) {
if (field.value==this.buttonStates.released)
return;
var status = (engine.getValue(group,"play")) ? false : true;
if (!status)
engine.setValue(group,"stop",true);
else
engine.setValue(group,"play",true);
}
// Processing of the 'jog_touch' special button name, which is used to detect
// when scratching should be enabled.
// Deck is resolved from group with 'resolveDeck'
// Enabling scratching (press 'jog_touch' button)
// Sets the internal 'isScratchEnabled' attribute to true, and calls scratchEnable
// with the scratch attributes (see class defination)
//
// Disabling scratching (release 'jog_touch' button)
// Sets the internal 'isScratchEnabled attribute to false, and calls scratchDisable
// to end scratching mode
HIDController.prototype.enableScratch = function(group,status) {
var deck = this.resolveDeck(group);
if (status) {
this.isScratchEnabled = true;
engine.scratchEnable(deck,
this.scratchintervalsPerRev,
this.scratchRPM,
this.scratchAlpha,
this.scratchBeta,
this.rampedScratchEnable
);
if (this.enableScratchCallback!=undefined) this.enableScratchCallback(true);
} else {
this.isScratchEnabled = false;
engine.scratchDisable(deck,this.rampedScratchDisable);
if (this.enableScratchCallback!=undefined) this.enableScratchCallback(false);
}
}
// Default jog scratching function. Used to handle jog move events from special
// input control field called 'jog_wheel'. Handles both 'scratch' and 'jog' mixxx
// functions, depending on isScratchEnabled value above (see enableScratch())
//
// Since most controllers require value scaling for jog and scratch functions,
// you are warned if following scaling function names are not registered:
//
// jog
// Scaling function from 'jog_wheel' for rate bend events with mixxx 'jog'
// function. Should return value range suitable for 'jog', whatever you
// wish it to do.
// jog_scratch
// Scaling function from 'jog_wheel' for scratch movements with mixxx
// 'scratchTick' function. Should return -1,0,1 or small ranges of integers
// both negative and positive values.
//
HIDController.prototype.jog_wheel = function(field) {
var scaler = undefined;
var active_group = this.getActiveFieldGroup(field);
var value = undefined;
if (field.isEncoder)
value = field.delta;
else
value = field.value;
if (this.isScratchEnabled) {
var deck = this.resolveDeck(active_group);
if (deck==undefined)
return;
scaler = this.getScaler("jog_scratch");
if (scaler!=undefined)
value = scaler(active_group,"jog_scratch",value);
else
HIDDebug("WARNING non jog_scratch scaler, you likely want one");
engine.scratchTick(deck,value);
} else {
if (active_group==undefined)
return;
scaler = this.getScaler("jog");
if (scaler!=undefined)
value = scaler(active_group,"jog",value);
else
HIDDebug("WARNING non jog scaler, you likely want one");
engine.setValue(active_group,"jog",value);
}
}
HIDController.prototype.stopAutoRepeatTimer = function(timer_id) {
if (this.timers[timer_id]) {
engine.stopTimer(this.timers[timer_id]);
delete this.timers[timer_id];
} else {
//HIDDebug("No such autorepeat timer: " + timer_id);
}
}
// Toggle field autorepeat on or off
HIDController.prototype.setAutoRepeat = function(group,name,callback,interval) {
var packet = this.getInputPacket(this.defaultPacket);
var field = packet.getField(group,name);
if (field!=undefined && field.type=="bitvector")
var field = packet.lookupBit(group,name);
if (field==undefined) {
HIDDebug("setAutoRepeat: field not found " +group+"."+name);
return;
}
field.auto_repeat = callback;
if (interval)
field.auto_repeat_interval = interval;
else
field.auto_repeat_interval = controller.auto_repeat_interval;
if (callback)
callback(field);
}
// Callback for auto repeat timer to send again the values for
// buttons and controls marked as 'auto_repeat'
// Timer must be defined from actual controller side, because of
// callback call namespaces and 'this' reference
HIDController.prototype.autorepeatTimer = function() {
var group_name;
var group;
var field;
var field_name;
var bit_name;
var bit;
var packet = this.InputPackets[this.defaultPacket];
for (group_name in packet.groups) {
group = packet.groups[group_name];
for (field_name in group) {
field = group[field_name];
if (field.type!="bitvector") {
if (field.auto_repeat)
this.processControl(field);
continue
}
for (bit_name in field.value.bits) {
bit = field.value.bits[bit_name];
if (bit.auto_repeat)
this.processButton(bit);
}
}
}
}
// Toggle active deck and update virtual output field control mappings
HIDController.prototype.switchDeck = function(deck) {
var packet;
var field;
var group;
var controlgroup;
if (deck==undefined) {
if (this.activeDeck==undefined) {
deck = 1;
} else {
// This is unusable: num_decks has always minimum 4 decks
// var totalDecks = engine.getValue("[Master]","num_decks");
// deck = (this.activeDeck+1) % totalDecks;
deck = this.deckSwitchMap[this.activeDeck];
if (deck==undefined)
deck=1;
}
}
new_group = this.resolveDeckGroup(deck);
HIDDebug("Switching to deck " + deck + " group " + new_group);
if (this.disconnectDeck!=undefined)
this.disconnectDeck();
for (var packet_name in this.OutputPackets) {
packet = this.OutputPackets[packet_name];
var send_packet = false;
for (var group_name in packet.groups) {
var group = packet.groups[group_name];
for (var field_name in group) {
field = group[field_name];
if (field.type=="bitvector") {
for (var bit_id in field.value.bits) {
var bit = field.value.bits[bit_id];
if (this.virtualDecks.indexOf(bit.mapped_group)==-1)
continue;
send_packet = true;
controlgroup = this.resolveGroup(bit.mapped_group);
engine.connectControl(controlgroup,bit.mapped_name,bit.mapped_callback,true);
engine.connectControl(new_group,bit.mapped_name,bit.mapped_callback);
var value = engine.getValue(new_group,bit.mapped_name);
HIDDebug("BIT "+bit.group+"."+bit.name + " value " + value);
if (value)
this.setOutput(
bit.group,bit.name,
this.LEDColors[this.deckOutputColors[deck]]
)
else
this.setOutput(
bit.group,bit.name,
this.LEDColors.off
)
}
continue;
}
// Only move outputs of virtual decks
if (this.virtualDecks.indexOf(field.mapped_group)==-1)
continue;
send_packet = true;
controlgroup = this.resolveGroup(field.mapped_group);
engine.connectControl(controlgroup,field.mapped_name,field.mapped_callback,true);
engine.connectControl(new_group,field.mapped_name,field.mapped_callback);
var value = engine.getValue(new_group,field.mapped_name);
if (value)
this.setOutput(
field.group,field.name,
this.LEDColors[this.deckOutputColors[deck]]
)
else
this.setOutput(
field.group,field.name,
this.LEDColors.off
)
}
}
}
this.activeDeck = deck;
if (this.connectDeck!=undefined)
this.connectDeck();
}
// Link a virtual HID Output to mixxx control
HIDController.prototype.linkOutput = function(group,name,m_group,m_name,callback) {
var controlgroup = undefined;
var field = this.getOutputField(group,name);
if (field==undefined) {
HIDDebug("Linked output not found: " + group+"."+name);
return;
}
if (field.mapped_group!=undefined) {
HIDDebug("Output already linked: " + field.mapped_group);
return;
}
controlgroup = this.resolveGroup(m_group);
field.mapped_group = m_group;
field.mapped_name = m_name;
field.mapped_callback = callback;
engine.connectControl(controlgroup,m_name,callback);
if (engine.getValue(controlgroup,m_name))
this.setOutput(m_group,m_name,"on");
else
this.setOutput(m_group,m_name,"off");
}
// Unlink a virtual HID Output from mixxx control
HIDController.prototype.unlinkOutput = function(group,name,callback) {
var field = this.getOutputField(group,name);
var controlgroup;
if (field==undefined) {
HIDDebug("Unlinked output not found: " + group+"."+name);
return;
}
if (field.mapped_group==undefined || field.mapped_name==undefined) {
HIDDebug("Unlinked output not mapped: " + group+"."+name);
return;
}
controlgroup = this.resolveGroup(field.mapped_group);
engine.connectControl(controlgroup,field.mapped_name,callback,true);
field.mapped_group = undefined;
field.mapped_name = undefined;
field.mapped_callback = undefined;
}
// Set output state to given value
HIDController.prototype.setOutput = function(group,name,value,send_packet) {
var field = this.getOutputField(group,name);
if (field==undefined) {
HIDDebug("setOutput: unknown field: " + group+"."+name);
return;
}
field.value = value<<field.bit_offset;
field.toggle = value<<field.bit_offset;
if (send_packet)
field.packet.send();
}
// Set Output to toggle between two values. Reset with setOutput(name,'off')
HIDController.prototype.setOutputToggle = function(group,name,toggle_value) {
var field = this.getOutputField(group,name);
if (field==undefined) {
HIDDebug("setOutputToggle: unknown field " +group+"."+name);
return;
}
field.value = toggle_value<<field.bit_offset;
field.toggle = toggle_value<<field.bit_offset;
field.packet.send();
}
// Manual packing test functions
//var packet = new HIDPacket("test",[0x1,0x2],6);
//var field;
//packet.addOutput("test","ushort",2,"H");
//packet.addOutput("test","short",4,"h");
//field = packet.getField("test","ushort");
//print("FIELD " + field.id + " MIN " + field.min + " MAX " + field.max);
//field.value = 1024;
//field = packet.getField("test","short");
//field.value = -32767;
//print("FIELD " + field.id + " MIN " + field.min + " MAX " + field.max);
//var out = { "length": packet.length, "data": []};
//for (var i=0;i<packet.header.length;i++) {
// out.data[i] = i;
//}
//for (var group_name in packet.groups) {
// var group = packet.groups[group_name];
// for (var field_name in group) {
// var field = group[field_name];
// print("PACKING " + field.id);
// packet.pack(out,field);
// }
//}
//for (var i=0;i<out.length;i++) { print("BYTE " +i+ " VALUE " +out.data[i]); }
|