libs/surfaces/mackie/device_info.cc

   1 /*
   2         Copyright (C) 2006,2007 John Anderson
   3         Copyright (C) 2012 Paul Davis
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the Free Software
  17         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <cstdlib>
  21 #include <cstring>
  22 #include <glibmm/miscutils.h>
  23
  24 #include "pbd/xml++.h"
  25 #include "pbd/error.h"
  26 #include "pbd/file_utils.h"
  27 #include "pbd/convert.h"
  28 #include "pbd/stl_delete.h"
  29
  30 #include "ardour/filesystem_paths.h"
  31
  32 #include "device_info.h"
  33
  34 #include "i18n.h"
  35
  36 using namespace PBD;
  37 using namespace ARDOUR;
  38 using namespace ArdourSurface;
  39 using namespace Mackie;
  40
  41 using std::string;
  42 using std::vector;
  43
  44 std::map<std::string,DeviceInfo> DeviceInfo::device_info;
  45
  46 DeviceInfo::DeviceInfo()
  47         : _strip_cnt (8)
  48         , _extenders (0)
  49         , _has_two_character_display (true)
  50         , _has_master_fader (true)
  51         , _has_timecode_display (true)
  52         , _has_global_controls (true)
  53         , _has_jog_wheel (true)
  54         , _has_touch_sense_faders (true)
  55         , _uses_logic_control_buttons (false)
  56         , _uses_ipmidi (false)
  57         , _no_handshake (false)
  58         , _has_meters (true)
  59         , _name (X_("Mackie Control Universal Pro"))
  60 {
  61         mackie_control_buttons ();
  62 }
  63
  64 DeviceInfo::~DeviceInfo()
  65 {
  66 }
  67
  68 GlobalButtonInfo&
  69 DeviceInfo::get_global_button(Button::ID id)
  70 {
  71         GlobalButtonsInfo::iterator it;
  72
  73         it = _global_buttons.find (id);
  74
  75         return it->second;
  76 }
  77
  78 std::string&
  79 DeviceInfo::get_global_button_name(Button::ID id)
  80 {
  81         GlobalButtonsInfo::iterator it;
  82
  83         it = _global_buttons.find (id);
  84         if (it == _global_buttons.end ()) {
  85                 _global_button_name = "";
  86                 return _global_button_name;
  87         } else {
  88                 return it->second.label;
  89         }
  90 }
  91
  92 void
  93 DeviceInfo::mackie_control_buttons ()
  94 {
  95         _global_buttons.clear ();
  96         shared_buttons ();
  97
  98         _global_buttons[Button::UserA] = GlobalButtonInfo ("Rear Panel User Switch 1", "user", 0x66);
  99         _global_buttons[Button::UserB] = GlobalButtonInfo ("Rear Panel User Switch 2", "user", 0x67);
 100
 101         //TODO Implement "rear panel external control": a connection for a resistive
 102         //TODO element expression pedal . Message: 0xb0 0x2e 0xVV where 0xVV = external
 103         //TODO controller position value (0x00 to 0x7f)
 104
 105         _strip_buttons[Button::RecEnable] = StripButtonInfo (0x0, "Rec");
 106 }
 107
 108 void
 109 DeviceInfo::logic_control_buttons ()
 110 {
 111         _global_buttons.clear ();
 112         shared_buttons ();
 113
 114         _global_buttons[Button::UserA] = GlobalButtonInfo ("User Switch A", "user", 0x66);
 115         _global_buttons[Button::UserB] = GlobalButtonInfo ("User Switch B", "user", 0x67);
 116
 117         _strip_buttons[Button::RecEnable] = StripButtonInfo (0x0, "Rec/Rdy");
 118 }
 119
 120 void
 121 DeviceInfo::shared_buttons ()
 122 {
 123         _global_buttons[Button::Track] = GlobalButtonInfo ("Track", "assignment", 0x28);
 124         _global_buttons[Button::Send] = GlobalButtonInfo ("Send", "assignment", 0x29);
 125         _global_buttons[Button::Pan] = GlobalButtonInfo ("Pan/Surround", "assignment", 0x2a);
 126         _global_buttons[Button::Plugin] = GlobalButtonInfo ("Plugin", "assignment", 0x2b);
 127         _global_buttons[Button::Eq] = GlobalButtonInfo ("Eq", "assignment", 0x2c);
 128         _global_buttons[Button::Dyn] = GlobalButtonInfo ("Instrument", "assignment", 0x2d);
 129
 130         _global_buttons[Button::Left] = GlobalButtonInfo ("Bank Left", "bank", 0x2e);
 131         _global_buttons[Button::Right] = GlobalButtonInfo ("Bank Right", "bank", 0x2f);
 132         _global_buttons[Button::ChannelLeft] = GlobalButtonInfo ("Channel Left", "bank", 0x30);
 133         _global_buttons[Button::ChannelRight] = GlobalButtonInfo ("Channel Right", "bank", 0x31);
 134         _global_buttons[Button::Flip] = GlobalButtonInfo ("Flip", "assignment", 0x32);
 135         _global_buttons[Button::View] = GlobalButtonInfo ("Global View", "global view", 0x33);
 136
 137         _global_buttons[Button::NameValue] = GlobalButtonInfo ("Name/Value", "display", 0x34);
 138         _global_buttons[Button::TimecodeBeats] = GlobalButtonInfo ("Timecode/Beats", "display", 0x35);
 139
 140         _global_buttons[Button::F1] = GlobalButtonInfo ("F1", "function select", 0x36);
 141         _global_buttons[Button::F2] = GlobalButtonInfo ("F2", "function select", 0x37);
 142         _global_buttons[Button::F3] = GlobalButtonInfo ("F3", "function select", 0x38);
 143         _global_buttons[Button::F4] = GlobalButtonInfo ("F4", "function select", 0x39);
 144         _global_buttons[Button::F5] = GlobalButtonInfo ("F5", "function select", 0x3a);
 145         _global_buttons[Button::F6] = GlobalButtonInfo ("F6", "function select", 0x3b);
 146         _global_buttons[Button::F7] = GlobalButtonInfo ("F7", "function select", 0x3c);
 147         _global_buttons[Button::F8] = GlobalButtonInfo ("F8", "function select", 0x3d);
 148
 149         _global_buttons[Button::MidiTracks] = GlobalButtonInfo ("MIDI Tracks", "global view", 0x3e);
 150         _global_buttons[Button::Inputs] = GlobalButtonInfo ("Inputs", "global view", 0x3f);
 151         _global_buttons[Button::AudioTracks] = GlobalButtonInfo ("Audio Tracks", "global view", 0x40);
 152         _global_buttons[Button::AudioInstruments] = GlobalButtonInfo ("Audio Instruments", "global view", 0x41);
 153         _global_buttons[Button::Aux] = GlobalButtonInfo ("Aux", "global view", 0x42);
 154         _global_buttons[Button::Busses] = GlobalButtonInfo ("Busses", "global view", 0x43);
 155         _global_buttons[Button::Outputs] = GlobalButtonInfo ("Outputs", "global view", 0x44);
 156         _global_buttons[Button::User] = GlobalButtonInfo ("User", "global view", 0x45);
 157
 158         _global_buttons[Button::Shift] = GlobalButtonInfo ("Shift", "modifiers", 0x46);
 159         _global_buttons[Button::Option] = GlobalButtonInfo ("Option", "modifiers", 0x47);
 160         _global_buttons[Button::Ctrl] = GlobalButtonInfo ("Ctrl", "modifiers", 0x48);
 161         _global_buttons[Button::CmdAlt] = GlobalButtonInfo ("Cmd/Alt", "modifiers", 0x49);
 162
 163         _global_buttons[Button::Read] = GlobalButtonInfo ("Read/Off", "automation", 0x4a);
 164         _global_buttons[Button::Write] = GlobalButtonInfo ("Write", "automation", 0x4b);
 165         _global_buttons[Button::Trim] = GlobalButtonInfo ("Trim", "automation", 0x4c);
 166         _global_buttons[Button::Touch] = GlobalButtonInfo ("Touch", "automation", 0x4d);
 167         _global_buttons[Button::Latch] = GlobalButtonInfo ("Latch", "automation", 0x4e);
 168         _global_buttons[Button::Grp] = GlobalButtonInfo ("Group", "automation", 0x4f);
 169
 170         _global_buttons[Button::Save] = GlobalButtonInfo ("Save", "utilities", 0x50);
 171         _global_buttons[Button::Undo] = GlobalButtonInfo ("Undo", "utilities", 0x51);
 172         _global_buttons[Button::Cancel] = GlobalButtonInfo ("Cancel", "utilities", 0x52);
 173         _global_buttons[Button::Enter] = GlobalButtonInfo ("Enter", "utilities", 0x53);
 174
 175         _global_buttons[Button::Marker] = GlobalButtonInfo ("Marker", "transport", 0x54);
 176         _global_buttons[Button::Nudge] = GlobalButtonInfo ("Nudge", "transport", 0x55);
 177         _global_buttons[Button::Loop] = GlobalButtonInfo ("Cycle", "transport", 0x56);
 178         _global_buttons[Button::Drop] = GlobalButtonInfo ("Drop", "transport", 0x57);
 179         _global_buttons[Button::Replace] = GlobalButtonInfo ("Replace", "transport", 0x58);
 180         _global_buttons[Button::Click] = GlobalButtonInfo ("Click", "transport", 0x59);
 181         _global_buttons[Button::ClearSolo] = GlobalButtonInfo ("Solo", "transport", 0x5a);
 182
 183         _global_buttons[Button::Rewind] = GlobalButtonInfo ("Rewind", "transport", 0x5b);
 184         _global_buttons[Button::Ffwd] = GlobalButtonInfo ("Fast Fwd", "transport", 0x5c);
 185         _global_buttons[Button::Stop] = GlobalButtonInfo ("Stop", "transport", 0x5d);
 186         _global_buttons[Button::Play] = GlobalButtonInfo ("Play", "transport", 0x5e);
 187         _global_buttons[Button::Record] = GlobalButtonInfo ("Record", "transport", 0x5f);
 188
 189         _global_buttons[Button::CursorUp] = GlobalButtonInfo ("Cursor Up", "cursor", 0x60);
 190         _global_buttons[Button::CursorDown] = GlobalButtonInfo ("Cursor Down", "cursor", 0x61);
 191         _global_buttons[Button::CursorLeft] = GlobalButtonInfo ("Cursor Left", "cursor", 0x62);
 192         _global_buttons[Button::CursorRight] = GlobalButtonInfo ("Cursor Right", "cursor", 0x63);
 193         _global_buttons[Button::Zoom] = GlobalButtonInfo ("Zoom", "cursor", 0x64);
 194         _global_buttons[Button::Scrub] = GlobalButtonInfo ("Scrub", "cursor", 0x65);
 195
 196         _strip_buttons[Button::Solo] = StripButtonInfo (0x08, "Solo");
 197         _strip_buttons[Button::Mute] = StripButtonInfo (0x10, "Mute");
 198         _strip_buttons[Button::Select] = StripButtonInfo (0x18, "Select");
 199         _strip_buttons[Button::VSelect] = StripButtonInfo (0x20, "V-Select");
 200
 201         _strip_buttons[Button::FaderTouch] = StripButtonInfo (0x68, "Fader Touch");
 202
 203         _global_buttons[Button::MasterFaderTouch] = GlobalButtonInfo ("Master Fader Touch", "master", 0x70);
 204 }
 205
 206 int
 207 DeviceInfo::set_state (const XMLNode& node, int /* version */)
 208 {
 209         const XMLProperty* prop;
 210         const XMLNode* child;
 211
 212         if (node.name() != "MackieProtocolDevice") {
 213                 return -1;
 214         }
 215
 216         /* name is mandatory */
 217         if ((child = node.child ("Name")) != 0) {
 218                 if ((prop = child->property ("value")) != 0) {
 219                         _name = prop->value();
 220                 } else {
 221                         return -1;
 222                 }
 223         }
 224
 225         /* strip count is mandatory */
 226         if ((child = node.child ("Strips")) != 0) {
 227                 if ((prop = child->property ("value")) != 0) {
 228                         if ((_strip_cnt = atoi (prop->value().c_str())) == 0) {
 229                                 _strip_cnt = 8;
 230                         }
 231                 }
 232         } else {
 233                 return -1;
 234         }
 235
 236         if ((child = node.child ("Extenders")) != 0) {
 237                 if ((prop = child->property ("value")) != 0) {
 238                         if ((_extenders = atoi (prop->value().c_str())) == 0) {
 239                                 _extenders = 0;
 240                         }
 241                 }
 242         }
 243
 244         if ((child = node.child ("TwoCharacterDisplay")) != 0) {
 245                 if ((prop = child->property ("value")) != 0) {
 246                         _has_two_character_display = string_is_affirmative (prop->value());
 247                 }
 248         }
 249
 250         if ((child = node.child ("MasterFader")) != 0) {
 251                 if ((prop = child->property ("value")) != 0) {
 252                         _has_master_fader = string_is_affirmative (prop->value());
 253                 }
 254         }
 255
 256         if ((child = node.child ("TimecodeDisplay")) != 0) {
 257                 if ((prop = child->property ("value")) != 0) {
 258                         _has_timecode_display = string_is_affirmative (prop->value());
 259                 }
 260         } else {
 261                 _has_timecode_display = false;
 262         }
 263
 264         if ((child = node.child ("GlobalControls")) != 0) {
 265                 if ((prop = child->property ("value")) != 0) {
 266                         _has_global_controls = string_is_affirmative (prop->value());
 267                 }
 268         } else {
 269                 _has_global_controls = false;
 270         }
 271
 272         if ((child = node.child ("JogWheel")) != 0) {
 273                 if ((prop = child->property ("value")) != 0) {
 274                         _has_jog_wheel = string_is_affirmative (prop->value());
 275                 }
 276         } else {
 277                 _has_jog_wheel = false;
 278         }
 279
 280         if ((child = node.child ("TouchSenseFaders")) != 0) {
 281                 if ((prop = child->property ("value")) != 0) {
 282                         _has_touch_sense_faders = string_is_affirmative (prop->value());
 283                 }
 284         } else {
 285                 _has_touch_sense_faders = false;
 286         }
 287
 288         if ((child = node.child ("UsesIPMIDI")) != 0) {
 289                 if ((prop = child->property ("value")) != 0) {
 290                         _uses_ipmidi = string_is_affirmative (prop->value());
 291                 }
 292         } else {
 293                 _uses_ipmidi = false;
 294         }
 295
 296         if ((child = node.child ("NoHandShake")) != 0) {
 297                 if ((prop = child->property ("value")) != 0) {
 298                         _no_handshake = string_is_affirmative (prop->value());
 299                 }
 300         } else {
 301                 _no_handshake = false;
 302         }
 303
 304         if ((child = node.child ("HasMeters")) != 0) {
 305                 if ((prop = child->property ("value")) != 0) {
 306                         _has_meters = string_is_affirmative (prop->value());
 307                 }
 308         } else {
 309                 _has_meters = true;
 310         }
 311
 312         if ((child = node.child ("LogicControlButtons")) != 0) {
 313                 if ((prop = child->property ("value")) != 0) {
 314                         _uses_logic_control_buttons = string_is_affirmative (prop->value());
 315
 316                         if (_uses_logic_control_buttons) {
 317                                 logic_control_buttons();
 318                         } else {
 319                                 mackie_control_buttons ();
 320                         }
 321                 }
 322         }
 323
 324         if ((child = node.child ("Buttons")) != 0) {
 325                 XMLNodeConstIterator i;
 326                 const XMLNodeList& nlist (child->children());
 327
 328                 for (i = nlist.begin(); i != nlist.end(); ++i) {
 329                         if ((*i)->name() == "GlobalButton") {
 330                                 if ((prop = (*i)->property ("name")) != 0) {
 331                                         int id = Button::name_to_id (prop->value());
 332                                         if (id >= 0) {
 333                                                 Button::ID bid = (Button::ID) id;
 334                                                 if ((prop = (*i)->property ("id")) != 0) {
 335                                                         int val = strtol (prop->value().c_str(), 0, 0);
 336                                                         std::map<Button::ID,GlobalButtonInfo>::iterator b = _global_buttons.find (bid);
 337                                                         if (b != _global_buttons.end()) {
 338                                                                 b->second.id = val;
 339
 340                                                                 if ((prop = (*i)->property ("label")) != 0) {
 341                                                                         b->second.label = prop->value();
 342                                                                 }
 343                                                         }
 344                                                 }
 345                                         }
 346
 347                                 }
 348
 349                         } else if ((*i)->name() == "StripButton") {
 350                                 if ((prop = (*i)->property ("name")) != 0) {
 351                                         int id = Button::name_to_id (prop->value());
 352                                         if (id >= 0) {
 353                                                 Button::ID bid = (Button::ID) id;
 354                                                 if ((prop = (*i)->property ("baseid")) != 0) {
 355                                                         int val = strtol (prop->value().c_str(), 0, 0);
 356                                                         std::map<Button::ID,StripButtonInfo>::iterator b = _strip_buttons.find (bid);
 357                                                         if (b != _strip_buttons.end()) {
 358                                                                 b->second.base_id = val;
 359                                                         }
 360                                                 }
 361                                         }
 362
 363                                 }
 364
 365                         }
 366                 }
 367         }
 368
 369         return 0;
 370 }
 371
 372 const string&
 373 DeviceInfo::name() const
 374 {
 375         return _name;
 376 }
 377
 378 uint32_t
 379 DeviceInfo::strip_cnt() const
 380 {
 381         return _strip_cnt;
 382 }
 383
 384 uint32_t
 385 DeviceInfo::extenders() const
 386 {
 387         return _extenders;
 388 }
 389
 390 bool
 391 DeviceInfo::has_master_fader() const
 392 {
 393         return _has_master_fader;
 394 }
 395
 396 bool
 397 DeviceInfo::has_meters() const
 398 {
 399         return _has_meters;
 400 }
 401
 402 bool
 403 DeviceInfo::has_two_character_display() const
 404 {
 405         return _has_two_character_display;
 406 }
 407
 408 bool
 409 DeviceInfo::has_timecode_display () const
 410 {
 411         return _has_timecode_display;
 412 }
 413
 414 bool
 415 DeviceInfo::uses_ipmidi () const
 416 {
 417         return _uses_ipmidi;
 418 }
 419
 420 bool
 421 DeviceInfo::has_global_controls () const
 422 {
 423         return _has_global_controls;
 424 }
 425
 426 bool
 427 DeviceInfo::has_jog_wheel () const
 428 {
 429         return _has_jog_wheel;
 430 }
 431
 432 bool
 433 DeviceInfo::no_handshake () const
 434 {
 435         return _no_handshake;
 436 }
 437
 438 bool
 439 DeviceInfo::has_touch_sense_faders () const
 440 {
 441         return _has_touch_sense_faders;
 442 }
 443
 444 static const char * const devinfo_env_variable_name = "ARDOUR_MCP_PATH";
 445 static const char* const devinfo_dir_name = "mcp";
 446 static const char* const devinfo_suffix = ".device";
 447
 448 static Searchpath
 449 devinfo_search_path ()
 450 {
 451         bool devinfo_path_defined = false;
 452         std::string spath_env (Glib::getenv (devinfo_env_variable_name, devinfo_path_defined));
 453
 454         if (devinfo_path_defined) {
 455                 return spath_env;
 456         }
 457
 458         Searchpath spath (ardour_data_search_path());
 459         spath.add_subdirectory_to_paths(devinfo_dir_name);
 460
 461         return spath;
 462 }
 463
 464 static bool
 465 devinfo_filter (const string &str, void* /*arg*/)
 466 {
 467         return (str.length() > strlen(devinfo_suffix) &&
 468                 str.find (devinfo_suffix) == (str.length() - strlen (devinfo_suffix)));
 469 }
 470
 471 void
 472 DeviceInfo::reload_device_info ()
 473 {
 474         DeviceInfo di;
 475         vector<string> s;
 476         vector<string> devinfos;
 477         Searchpath spath (devinfo_search_path());
 478
 479         find_files_matching_filter (devinfos, spath, devinfo_filter, 0, false, true);
 480         device_info.clear ();
 481
 482         if (devinfos.empty()) {
 483                 error << "No MCP device info files found using " << spath.to_string() << endmsg;
 484                 std::cerr << "No MCP device info files found using " << spath.to_string() << std::endl;
 485                 return;
 486         }
 487
 488         for (vector<string>::iterator i = devinfos.begin(); i != devinfos.end(); ++i) {
 489                 string fullpath = *i;
 490
 491                 XMLTree tree;
 492
 493                 if (!tree.read (fullpath.c_str())) {
 494                         continue;
 495                 }
 496
 497                 XMLNode* root = tree.root ();
 498                 if (!root) {
 499                         continue;
 500                 }
 501
 502                 if (di.set_state (*root, 3000) == 0) { /* version is ignored for now */
 503                         device_info[di.name()] = di;
 504                 }
 505         }
 506 }
 507
 508 std::ostream& operator<< (std::ostream& os, const Mackie::DeviceInfo& di)
 509 {
 510         os << di.name() << ' '
 511            << di.strip_cnt() << ' '
 512            << di.extenders() << ' '
 513                 ;
 514         return os;
 515 }