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