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/pathscanner.h"
  27
  28 #include "ardour/filesystem_paths.h"
  29
  30 #include "device_info.h"
  31
  32 #include "i18n.h"
  33
  34 using namespace Mackie;
  35 using namespace PBD;
  36 using namespace ARDOUR;
  37 using std::string;
  38 using std::vector;
  39
  40 std::map<std::string,DeviceInfo> DeviceInfo::device_info;
  41
  42 DeviceInfo::DeviceInfo()
  43         : _strip_cnt (8)
  44         , _extenders (0)
  45         , _has_two_character_display (true)
  46         , _has_master_fader (true)
  47         , _has_segmented_display (false)
  48         , _has_timecode_display (true)
  49         , _has_global_controls (true)
  50         , _has_jog_wheel (true)
  51         , _has_touch_sense_faders (true)
  52         , _uses_logic_control_buttons (false)
  53         , _uses_ipmidi (false)
  54         , _name (X_("Mackie Control Universal Pro"))
  55 {
  56         mackie_control_buttons ();
  57 }
  58
  59 DeviceInfo::~DeviceInfo()
  60 {
  61 }
  62
  63 void
  64 DeviceInfo::mackie_control_buttons ()
  65 {
  66         _global_buttons.clear ();
  67         shared_buttons ();
  68
  69         _global_buttons[Button::Edit] = GlobalButtonInfo ("edit", "none", 0x33);
  70
  71         _global_buttons[Button::F9] = GlobalButtonInfo ("F9", "none", 0x3e);
  72         _global_buttons[Button::F10] = GlobalButtonInfo ("F10", "none", 0x3f);
  73         _global_buttons[Button::F11] = GlobalButtonInfo ("F11", "none", 0x40);
  74         _global_buttons[Button::F12] = GlobalButtonInfo ("F12", "none", 0x41);
  75         _global_buttons[Button::F13] = GlobalButtonInfo ("F13", "none", 0x42);
  76         _global_buttons[Button::F14] = GlobalButtonInfo ("F14", "none", 0x43);
  77         _global_buttons[Button::F15] = GlobalButtonInfo ("F15", "none", 0x44);
  78         _global_buttons[Button::F16] = GlobalButtonInfo ("F16", "none", 0x45);
  79         _global_buttons[Button::Ctrl] = GlobalButtonInfo ("ctrl", "modifiers", 0x46);
  80         _global_buttons[Button::Option] = GlobalButtonInfo ("option", "modifiers", 0x47);
  81         _global_buttons[Button::Snapshot] = GlobalButtonInfo ("snapshot", "modifiers", 0x48);
  82         _global_buttons[Button::Shift] = GlobalButtonInfo ("shift", "modifiers", 0x49);
  83         _global_buttons[Button::Read] = GlobalButtonInfo ("read", "automation", 0x4a);
  84         _global_buttons[Button::Write] = GlobalButtonInfo ("write", "automation", 0x4b);
  85         _global_buttons[Button::Undo] = GlobalButtonInfo ("undo", "functions", 0x4c);
  86         _global_buttons[Button::Save] = GlobalButtonInfo ("save", "automation", 0x4d);
  87         _global_buttons[Button::Touch] = GlobalButtonInfo ("touch", "automation", 0x4e);
  88         _global_buttons[Button::Redo] = GlobalButtonInfo ("redo", "functions", 0x4f);
  89         _global_buttons[Button::FdrGroup] = GlobalButtonInfo ("fader group", "functions", 0x50);
  90         _global_buttons[Button::ClearSolo] = GlobalButtonInfo ("clear solo", "functions", 0x51);
  91         _global_buttons[Button::Cancel] = GlobalButtonInfo ("cancel", "functions", 0x52);
  92         _global_buttons[Button::Marker] = GlobalButtonInfo ("marker", "functions", 0x53);
  93         _global_buttons[Button::Mixer] = GlobalButtonInfo ("mixer", "transport", 0x54);
  94         _global_buttons[Button::FrmLeft] = GlobalButtonInfo ("frm left", "transport", 0x55);
  95         _global_buttons[Button::FrmRight] = GlobalButtonInfo ("frm right", "transport", 0x56);
  96         _global_buttons[Button::End] = GlobalButtonInfo ("end", "transport", 0x57);
  97         _global_buttons[Button::PunchIn] = GlobalButtonInfo ("punch in", "transport", 0x58);
  98         _global_buttons[Button::PunchOut] = GlobalButtonInfo ("punch out", "transport", 0x59);
  99         _global_buttons[Button::Loop] = GlobalButtonInfo ("loop", "transport", 0x59);
 100         _global_buttons[Button::Home] = GlobalButtonInfo ("home", "transport", 0x5a);
 101
 102         _strip_buttons[Button::FaderTouch] = StripButtonInfo (0xe0, "fader touch");
 103 }
 104
 105 void
 106 DeviceInfo::logic_control_buttons ()
 107 {
 108         _global_buttons.clear ();
 109         shared_buttons ();
 110
 111         _global_buttons[Button::View] = GlobalButtonInfo ("view", "view", 0x33);
 112
 113         _global_buttons[Button::MidiTracks] = GlobalButtonInfo ("miditracks", "view", 0x3e);
 114         _global_buttons[Button::Inputs] = GlobalButtonInfo ("inputs", "view", 0x3f);
 115         _global_buttons[Button::AudioTracks] = GlobalButtonInfo ("audiotracks", "view", 0x40);
 116         _global_buttons[Button::AudioInstruments] = GlobalButtonInfo ("audio instruments", "view", 0x41);
 117         _global_buttons[Button::Aux] = GlobalButtonInfo ("aux", "view", 0x42);
 118         _global_buttons[Button::Busses] = GlobalButtonInfo ("busses", "view", 0x43);
 119         _global_buttons[Button::Outputs] = GlobalButtonInfo ("outputs", "view", 0x44);
 120         _global_buttons[Button::User] = GlobalButtonInfo ("user", "view", 0x45);
 121         _global_buttons[Button::Shift] = GlobalButtonInfo ("shift", "modifiers", 0x46);
 122         _global_buttons[Button::Option] = GlobalButtonInfo ("option", "modifiers", 0x47);
 123         _global_buttons[Button::Ctrl] = GlobalButtonInfo ("ctrl", "modifiers", 0x48);
 124         _global_buttons[Button::CmdAlt] = GlobalButtonInfo ("cmdalt", "modifiers", 0x49);
 125         _global_buttons[Button::Read] = GlobalButtonInfo ("read", "automation", 0x4a);
 126         _global_buttons[Button::Write] = GlobalButtonInfo ("write", "automation", 0x4b);
 127         _global_buttons[Button::Trim] = GlobalButtonInfo ("trim", "automation", 0x4c);
 128         _global_buttons[Button::Touch] = GlobalButtonInfo ("touch", "functions", 0x4d);
 129         _global_buttons[Button::Latch] = GlobalButtonInfo ("latch", "functions", 0x4e);
 130         _global_buttons[Button::Grp] = GlobalButtonInfo ("group", "functions", 0x4f);
 131         _global_buttons[Button::Save] = GlobalButtonInfo ("save", "functions", 0x50);
 132         _global_buttons[Button::Undo] = GlobalButtonInfo ("undo", "functions", 0x51);
 133         _global_buttons[Button::Cancel] = GlobalButtonInfo ("cancel", "transport", 0x52);
 134         _global_buttons[Button::Enter] = GlobalButtonInfo ("enter right", "transport", 0x53);
 135         _global_buttons[Button::Marker] = GlobalButtonInfo ("marker", "transport", 0x54);
 136         _global_buttons[Button::Nudge] = GlobalButtonInfo ("nudge", "transport", 0x55);
 137         _global_buttons[Button::Loop] = GlobalButtonInfo ("cycle", "transport", 0x56);
 138         _global_buttons[Button::Drop] = GlobalButtonInfo ("drop", "transport", 0x57);
 139         _global_buttons[Button::Replace] = GlobalButtonInfo ("replace", "transport", 0x58);
 140         _global_buttons[Button::Click] = GlobalButtonInfo ("click", "transport", 0x59);
 141         _global_buttons[Button::Solo] = GlobalButtonInfo ("solo", "transport", 0x5a);
 142
 143         _strip_buttons[Button::FaderTouch] = StripButtonInfo (0x68, "fader touch");
 144 }
 145
 146 void
 147 DeviceInfo::shared_buttons ()
 148 {
 149         _global_buttons[Button::Track] = GlobalButtonInfo ("track", "assignment", 0x28);
 150         _global_buttons[Button::Send] = GlobalButtonInfo ("send", "assignment", 0x29);
 151         _global_buttons[Button::Pan] = GlobalButtonInfo ("pan", "assignment", 0x2a);
 152         _global_buttons[Button::Plugin] = GlobalButtonInfo ("plugin", "assignment", 0x2b);
 153         _global_buttons[Button::Eq] = GlobalButtonInfo ("eq", "assignment", 0x2c);
 154         _global_buttons[Button::Dyn] = GlobalButtonInfo ("dyn", "assignment", 0x2d);
 155         _global_buttons[Button::Left] = GlobalButtonInfo ("left", "bank", 0x2e);
 156         _global_buttons[Button::Right] = GlobalButtonInfo ("right", "bank", 0x2f);
 157         _global_buttons[Button::ChannelLeft] = GlobalButtonInfo ("channelleft", "bank", 0x30);
 158         _global_buttons[Button::ChannelRight] = GlobalButtonInfo ("channelright", "bank", 0x31);
 159         _global_buttons[Button::Flip] = GlobalButtonInfo ("flip", "none", 0x32);
 160
 161         _global_buttons[Button::NameValue] = GlobalButtonInfo ("name/value", "display", 0x34);
 162         _global_buttons[Button::TimecodeBeats] = GlobalButtonInfo ("timecode/beats", "display", 0x35);
 163         _global_buttons[Button::F1] = GlobalButtonInfo ("F1", "none", 0x36);
 164         _global_buttons[Button::F2] = GlobalButtonInfo ("F2", "none", 0x37);
 165         _global_buttons[Button::F3] = GlobalButtonInfo ("F3", "none", 0x38);
 166         _global_buttons[Button::F4] = GlobalButtonInfo ("F4", "none", 0x39);
 167         _global_buttons[Button::F5] = GlobalButtonInfo ("F5", "none", 0x3a);
 168         _global_buttons[Button::F6] = GlobalButtonInfo ("F6", "none", 0x3b);
 169         _global_buttons[Button::F7] = GlobalButtonInfo ("F7", "none", 0x3c);
 170         _global_buttons[Button::F8] = GlobalButtonInfo ("F8", "none", 0x3d);
 171
 172         _global_buttons[Button::Rewind] = GlobalButtonInfo ("rewind", "transport", 0x5b);
 173         _global_buttons[Button::Ffwd] = GlobalButtonInfo ("ffwd", "transport", 0x5c);
 174         _global_buttons[Button::Stop] = GlobalButtonInfo ("stop", "transport", 0x5d);
 175         _global_buttons[Button::Play] = GlobalButtonInfo ("play", "transport", 0x5e);
 176         _global_buttons[Button::Record] = GlobalButtonInfo ("record", "transport", 0x5f);
 177         _global_buttons[Button::CursorUp] = GlobalButtonInfo ("cursor up", "cursor", 0x60);
 178         _global_buttons[Button::CursorDown] = GlobalButtonInfo ("cursor down", "cursor", 0x61);
 179         _global_buttons[Button::CursorLeft] = GlobalButtonInfo ("cursor left", "cursor", 0x62);
 180         _global_buttons[Button::CursorRight] = GlobalButtonInfo ("cursor right", "cursor", 0x63);
 181         _global_buttons[Button::Zoom] = GlobalButtonInfo ("zoom", "none", 0x64);
 182         _global_buttons[Button::Scrub] = GlobalButtonInfo ("scrub", "none", 0x65);
 183         _global_buttons[Button::UserA] = GlobalButtonInfo ("user a", "user", 0x66);
 184         _global_buttons[Button::UserB] = GlobalButtonInfo ("user b", "user", 0x67);
 185
 186         _strip_buttons[Button::RecEnable] = StripButtonInfo (0x0, "recenable");
 187         _strip_buttons[Button::Solo] = StripButtonInfo (0x08, "solo");
 188         _strip_buttons[Button::Mute] = StripButtonInfo (0x10, "mute");
 189         _strip_buttons[Button::Select] = StripButtonInfo (0x18, "select");
 190         _strip_buttons[Button::VSelect] = StripButtonInfo (0x20, "vselect");
 191 }
 192
 193 int
 194 DeviceInfo::set_state (const XMLNode& node, int /* version */)
 195 {
 196         const XMLProperty* prop;
 197         const XMLNode* child;
 198
 199         if (node.name() != "MackieProtocolDevice") {
 200                 return -1;
 201         }
 202
 203         /* name is mandatory */
 204
 205         if ((child = node.child ("Name")) != 0) {
 206                 if ((prop = child->property ("value")) != 0) {
 207                         _name = prop->value();
 208                 } else {
 209                         return -1;
 210                 }
 211         }
 212
 213         if ((child = node.child ("Strips")) != 0) {
 214                 if ((prop = child->property ("value")) != 0) {
 215                         if ((_strip_cnt = atoi (prop->value())) == 0) {
 216                                 _strip_cnt = 8;
 217                         }
 218                 }
 219         }
 220
 221         if ((child = node.child ("Extenders")) != 0) {
 222                 if ((prop = child->property ("value")) != 0) {
 223                         if ((_extenders = atoi (prop->value())) == 0) {
 224                                 _extenders = 0;
 225                         }
 226                 }
 227         }
 228
 229         if ((child = node.child ("TwoCharacterDisplay")) != 0) {
 230                 if ((prop = child->property ("value")) != 0) {
 231                         _has_two_character_display = string_is_affirmative (prop->value());
 232                 }
 233         }
 234
 235         if ((child = node.child ("MasterFader")) != 0) {
 236                 if ((prop = child->property ("value")) != 0) {
 237                         _has_master_fader = string_is_affirmative (prop->value());
 238                 }
 239         }
 240
 241         if ((child = node.child ("DisplaySegments")) != 0) {
 242                 if ((prop = child->property ("value")) != 0) {
 243                         _has_segmented_display = string_is_affirmative (prop->value());
 244                 }
 245         }
 246
 247         if ((child = node.child ("TimecodeDisplay")) != 0) {
 248                 if ((prop = child->property ("value")) != 0) {
 249                         _has_timecode_display = string_is_affirmative (prop->value());
 250                 }
 251         }
 252
 253         if ((child = node.child ("GlobalControls")) != 0) {
 254                 if ((prop = child->property ("value")) != 0) {
 255                         _has_global_controls = string_is_affirmative (prop->value());
 256                 }
 257         }
 258
 259         if ((child = node.child ("JogWheel")) != 0) {
 260                 if ((prop = child->property ("value")) != 0) {
 261                         _has_jog_wheel = string_is_affirmative (prop->value());
 262                 }
 263         }
 264
 265         if ((child = node.child ("TouchSenseFaders")) != 0) {
 266                 if ((prop = child->property ("value")) != 0) {
 267                         _has_touch_sense_faders = string_is_affirmative (prop->value());
 268                 }
 269         }
 270
 271         if ((child = node.child ("UsesIPMIDI")) != 0) {
 272                 if ((prop = child->property ("value")) != 0) {
 273                         _uses_ipmidi = string_is_affirmative (prop->value());
 274                 }
 275         }
 276
 277         if ((child = node.child ("LogicControlButtons")) != 0) {
 278                 if ((prop = child->property ("value")) != 0) {
 279                         _uses_logic_control_buttons = string_is_affirmative (prop->value());
 280
 281                         if (_uses_logic_control_buttons) {
 282                                 logic_control_buttons();
 283                         } else {
 284                                 mackie_control_buttons ();
 285                         }
 286                 }
 287         }
 288
 289         if ((child = node.child ("Buttons")) != 0) {
 290                 XMLNodeConstIterator i;
 291                 const XMLNodeList& nlist (child->children());
 292
 293                 for (i = nlist.begin(); i != nlist.end(); ++i) {
 294                         if ((*i)->name() == "GlobalButton") {
 295                                 if ((prop = (*i)->property ("name")) != 0) {
 296                                         int id = Button::name_to_id (prop->value());
 297                                         if (id >= 0) {
 298                                                 Button::ID bid = (Button::ID) id;
 299                                                 if ((prop = (*i)->property ("id")) != 0) {
 300                                                         int val = strtol (prop->value().c_str(), 0, 0);
 301                                                         std::map<Button::ID,GlobalButtonInfo>::iterator b = _global_buttons.find (bid);
 302                                                         if (b != _global_buttons.end()) {
 303                                                                 b->second.id = val;
 304
 305                                                                 if ((prop = (*i)->property ("label")) != 0) {
 306                                                                         b->second.label = prop->value();
 307                                                                 }
 308                                                         }
 309                                                 }
 310                                         }
 311
 312                                 }
 313
 314                         } else if ((*i)->name() == "StripButton") {
 315                                 if ((prop = (*i)->property ("name")) != 0) {
 316                                         int id = Button::name_to_id (prop->value());
 317                                         if (id >= 0) {
 318                                                 Button::ID bid = (Button::ID) id;
 319                                                 if ((prop = (*i)->property ("baseid")) != 0) {
 320                                                         int val = strtol (prop->value().c_str(), 0, 0);
 321                                                         std::map<Button::ID,StripButtonInfo>::iterator b = _strip_buttons.find (bid);
 322                                                         if (b != _strip_buttons.end()) {
 323                                                                 b->second.base_id = val;
 324                                                         }
 325                                                 }
 326                                         }
 327
 328                                 }
 329
 330                         }
 331                 }
 332         }
 333
 334         return 0;
 335 }
 336
 337 const string&
 338 DeviceInfo::name() const
 339 {
 340         return _name;
 341 }
 342
 343 uint32_t
 344 DeviceInfo::strip_cnt() const
 345 {
 346         return _strip_cnt;
 347 }
 348
 349 uint32_t
 350 DeviceInfo::extenders() const
 351 {
 352         return _extenders;
 353 }
 354
 355 bool
 356 DeviceInfo::has_master_fader() const
 357 {
 358         return _has_master_fader;
 359 }
 360
 361 bool
 362 DeviceInfo::has_two_character_display() const
 363 {
 364         return _has_two_character_display;
 365 }
 366
 367 bool
 368 DeviceInfo::has_segmented_display() const
 369 {
 370         return _has_segmented_display;
 371 }
 372
 373 bool
 374 DeviceInfo::has_timecode_display () const
 375 {
 376         return _has_timecode_display;
 377 }
 378
 379 bool
 380 DeviceInfo::uses_ipmidi () const
 381 {
 382         return _uses_ipmidi;
 383 }
 384
 385 bool
 386 DeviceInfo::has_global_controls () const
 387 {
 388         return _has_global_controls;
 389 }
 390
 391 bool
 392 DeviceInfo::has_jog_wheel () const
 393 {
 394         return _has_jog_wheel;
 395 }
 396
 397 bool
 398 DeviceInfo::has_touch_sense_faders () const
 399 {
 400         return _has_touch_sense_faders;
 401 }
 402
 403 static const char * const devinfo_env_variable_name = "ARDOUR_MCP_PATH";
 404 static const char* const devinfo_dir_name = "mcp";
 405 static const char* const devinfo_suffix = ".device";
 406
 407 static sys::path
 408 system_devinfo_search_path ()
 409 {
 410         bool devinfo_path_defined = false;
 411         sys::path spath_env (Glib::getenv (devinfo_env_variable_name, devinfo_path_defined));
 412
 413         if (devinfo_path_defined) {
 414                 return spath_env;
 415         }
 416
 417         SearchPath spath (system_data_search_path());
 418         spath.add_subdirectory_to_paths(devinfo_dir_name);
 419
 420         // just return the first directory in the search path that exists
 421         SearchPath::const_iterator i = std::find_if(spath.begin(), spath.end(), sys::exists);
 422
 423         if (i == spath.end()) return sys::path();
 424
 425         return *i;
 426 }
 427
 428 static sys::path
 429 user_devinfo_directory ()
 430 {
 431         sys::path p(user_config_directory());
 432         p /= devinfo_dir_name;
 433
 434         return p;
 435 }
 436
 437 static bool
 438 devinfo_filter (const string &str, void */*arg*/)
 439 {
 440         return (str.length() > strlen(devinfo_suffix) &&
 441                 str.find (devinfo_suffix) == (str.length() - strlen (devinfo_suffix)));
 442 }
 443
 444 void
 445 DeviceInfo::reload_device_info ()
 446 {
 447         DeviceInfo di;
 448         vector<string> s;
 449         vector<string *> *devinfos;
 450         PathScanner scanner;
 451         SearchPath spath (system_devinfo_search_path());
 452         spath += user_devinfo_directory ();
 453
 454         devinfos = scanner (spath.to_string(), devinfo_filter, 0, false, true);
 455         device_info.clear ();
 456
 457         if (!devinfos) {
 458                 error << "No MCP device info files found using " << spath.to_string() << endmsg;
 459                 std::cerr << "No MCP device info files found using " << spath.to_string() << std::endl;
 460                 return;
 461         }
 462
 463         if (devinfos->empty()) {
 464                 error << "No MCP device info files found using " << spath.to_string() << endmsg;
 465                 std::cerr << "No MCP device info files found using " << spath.to_string() << std::endl;
 466                 return;
 467         }
 468
 469         for (vector<string*>::iterator i = devinfos->begin(); i != devinfos->end(); ++i) {
 470                 string fullpath = *(*i);
 471
 472                 XMLTree tree;
 473
 474
 475                 if (!tree.read (fullpath.c_str())) {
 476                         continue;
 477                 }
 478
 479                 XMLNode* root = tree.root ();
 480                 if (!root) {
 481                         continue;
 482                 }
 483
 484                 if (di.set_state (*root, 3000) == 0) { /* version is ignored for now */
 485                         device_info[di.name()] = di;
 486                 }
 487         }
 488
 489         delete devinfos;
 490 }
 491
 492 std::ostream& operator<< (std::ostream& os, const Mackie::DeviceInfo& di)
 493 {
 494         os << di.name() << ' '
 495            << di.strip_cnt() << ' '
 496            << di.extenders() << ' '
 497                 ;
 498         return os;
 499 }