libs/surfaces/mackie/device_profile.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 <cerrno>
  21 #include <cstdlib>
  22 #include <cstring>
  23 #include <glibmm/miscutils.h>
  24
  25 #include "pbd/xml++.h"
  26 #include "pbd/error.h"
  27 #include "pbd/pathscanner.h"
  28 #include "pbd/replace_all.h"
  29
  30 #include "ardour/filesystem_paths.h"
  31
  32 #include "mackie_control_protocol.h"
  33 #include "device_profile.h"
  34
  35 #include "i18n.h"
  36
  37 using namespace Mackie;
  38 using namespace PBD;
  39 using namespace ARDOUR;
  40 using std::string;
  41 using std::vector;
  42
  43 std::map<std::string,DeviceProfile> DeviceProfile::device_profiles;
  44
  45 DeviceProfile::DeviceProfile (const string& n)
  46         : _name (n)
  47 {
  48 }
  49
  50 DeviceProfile::~DeviceProfile()
  51 {
  52 }
  53
  54 static const char * const devprofile_env_variable_name = "ARDOUR_MCP_PATH";
  55 static const char* const devprofile_dir_name = "mcp";
  56 static const char* const devprofile_suffix = ".profile";
  57
  58 static sys::path
  59 system_devprofile_search_path ()
  60 {
  61         bool devprofile_path_defined = false;
  62         sys::path spath_env (Glib::getenv (devprofile_env_variable_name, devprofile_path_defined));
  63
  64         if (devprofile_path_defined) {
  65                 return spath_env;
  66         }
  67
  68         SearchPath spath (system_data_search_path());
  69         spath.add_subdirectory_to_paths(devprofile_dir_name);
  70
  71         // just return the first directory in the search path that exists
  72         SearchPath::const_iterator i = std::find_if(spath.begin(), spath.end(), sys::exists);
  73
  74         if (i == spath.end()) return sys::path();
  75
  76         return *i;
  77 }
  78
  79 static sys::path
  80 user_devprofile_directory ()
  81 {
  82         sys::path p(user_config_directory());
  83         p /= devprofile_dir_name;
  84
  85         return p;
  86 }
  87
  88 static bool
  89 devprofile_filter (const string &str, void */*arg*/)
  90 {
  91         return (str.length() > strlen(devprofile_suffix) &&
  92                 str.find (devprofile_suffix) == (str.length() - strlen (devprofile_suffix)));
  93 }
  94
  95 void
  96 DeviceProfile::reload_device_profiles ()
  97 {
  98         DeviceProfile dp;
  99         vector<string> s;
 100         vector<string *> *devprofiles;
 101         PathScanner scanner;
 102         SearchPath spath (system_devprofile_search_path());
 103         spath += user_devprofile_directory ();
 104
 105         devprofiles = scanner (spath.to_string(), devprofile_filter, 0, false, true);
 106         device_profiles.clear ();
 107
 108         if (!devprofiles) {
 109                 error << "No MCP device info files found using " << spath.to_string() << endmsg;
 110                 return;
 111         }
 112
 113         if (devprofiles->empty()) {
 114                 error << "No MCP device info files found using " << spath.to_string() << endmsg;
 115                 return;
 116         }
 117
 118         for (vector<string*>::iterator i = devprofiles->begin(); i != devprofiles->end(); ++i) {
 119                 string fullpath = *(*i);
 120
 121                 XMLTree tree;
 122
 123                 if (!tree.read (fullpath.c_str())) {
 124                         continue;
 125                 }
 126
 127                 XMLNode* root = tree.root ();
 128                 if (!root) {
 129                         continue;
 130                 }
 131
 132                 if (dp.set_state (*root, 3000) == 0) { /* version is ignored for now */
 133                         dp.set_path (fullpath);
 134                         device_profiles[dp.name()] = dp;
 135                 }
 136         }
 137
 138         delete devprofiles;
 139 }
 140
 141 int
 142 DeviceProfile::set_state (const XMLNode& node, int /* version */)
 143 {
 144         const XMLProperty* prop;
 145         const XMLNode* child;
 146
 147         if (node.name() != "MackieDeviceProfile") {
 148                 return -1;
 149         }
 150
 151         /* name is mandatory */
 152
 153         if ((child = node.child ("Name")) == 0 || (prop = child->property ("value")) == 0) {
 154                 return -1;
 155         } else {
 156                 _name = prop->value();
 157         }
 158
 159         if ((child = node.child ("Buttons")) != 0) {
 160                 XMLNodeConstIterator i;
 161                 const XMLNodeList& nlist (child->children());
 162
 163                 for (i = nlist.begin(); i != nlist.end(); ++i) {
 164
 165                         if ((*i)->name() == "Button") {
 166
 167                                 if ((prop = (*i)->property ("name")) == 0) {
 168                                         error << string_compose ("Button without name in device profile \"%1\" - ignored", _name) << endmsg;
 169                                         continue;
 170                                 }
 171
 172                                 int id = Button::name_to_id (prop->value());
 173                                 if (id < 0) {
 174                                         error << string_compose ("Unknow button ID \"%1\"", prop->value()) << endmsg;
 175                                         continue;
 176                                 }
 177
 178                                 Button::ID bid = (Button::ID) id;
 179
 180                                 ButtonActionMap::iterator b = _button_map.find (bid);
 181
 182                                 if (b == _button_map.end()) {
 183                                         b = _button_map.insert (_button_map.end(), std::pair<Button::ID,ButtonActions> (bid, ButtonActions()));
 184                                 }
 185
 186                                 if ((prop = (*i)->property ("plain")) != 0) {
 187                                         b->second.plain = prop->value ();
 188                                 }
 189                                 if ((prop = (*i)->property ("control")) != 0) {
 190                                         b->second.control = prop->value ();
 191                                 }
 192                                 if ((prop = (*i)->property ("shift")) != 0) {
 193                                         b->second.shift = prop->value ();
 194                                 }
 195                                 if ((prop = (*i)->property ("option")) != 0) {
 196                                         b->second.option = prop->value ();
 197                                 }
 198                                 if ((prop = (*i)->property ("cmdalt")) != 0) {
 199                                         b->second.cmdalt = prop->value ();
 200                                 }
 201                                 if ((prop = (*i)->property ("shiftcontrol")) != 0) {
 202                                         b->second.shiftcontrol = prop->value ();
 203                                 }
 204                         }
 205                 }
 206         }
 207
 208         return 0;
 209 }
 210
 211 XMLNode&
 212 DeviceProfile::get_state () const
 213 {
 214         XMLNode* node = new XMLNode ("MackieDeviceProfile");
 215         XMLNode* child = new XMLNode ("Name");
 216
 217         child->add_property ("value", _name);
 218         node->add_child_nocopy (*child);
 219
 220         if (_button_map.empty()) {
 221                 return *node;
 222         }
 223
 224         XMLNode* buttons = new XMLNode ("Buttons");
 225         node->add_child_nocopy (*buttons);
 226
 227         for (ButtonActionMap::const_iterator b = _button_map.begin(); b != _button_map.end(); ++b) {
 228                 XMLNode* n = new XMLNode ("Button");
 229
 230                 n->add_property ("name", Button::id_to_name (b->first));
 231
 232                 if (!b->second.plain.empty()) {
 233                         n->add_property ("plain", b->second.plain);
 234                 }
 235                 if (!b->second.control.empty()) {
 236                         n->add_property ("control", b->second.control);
 237                 }
 238                 if (!b->second.shift.empty()) {
 239                         n->add_property ("shift", b->second.shift);
 240                 }
 241                 if (!b->second.option.empty()) {
 242                         n->add_property ("option", b->second.option);
 243                 }
 244                 if (!b->second.cmdalt.empty()) {
 245                         n->add_property ("cmdalt", b->second.cmdalt);
 246                 }
 247                 if (!b->second.shiftcontrol.empty()) {
 248                         n->add_property ("shiftcontrol", b->second.shiftcontrol);
 249                 }
 250
 251                 buttons->add_child_nocopy (*n);
 252         }
 253
 254         return *node;
 255 }
 256
 257 string
 258 DeviceProfile::get_button_action (Button::ID id, int modifier_state) const
 259 {
 260         ButtonActionMap::const_iterator i = _button_map.find (id);
 261
 262         if (i == _button_map.end()) {
 263                 return string();
 264         }
 265
 266         if (modifier_state == MackieControlProtocol::MODIFIER_CONTROL) {
 267                 return i->second.control;
 268         } else if (modifier_state == MackieControlProtocol::MODIFIER_SHIFT) {
 269                 return i->second.shift;
 270         } else if (modifier_state == MackieControlProtocol::MODIFIER_OPTION) {
 271                 return i->second.option;
 272         } else if (modifier_state == MackieControlProtocol::MODIFIER_CMDALT) {
 273                 return i->second.cmdalt;
 274         } else if (modifier_state == (MackieControlProtocol::MODIFIER_CONTROL|MackieControlProtocol::MODIFIER_SHIFT)) {
 275                 return i->second.shiftcontrol;
 276         }
 277
 278         return i->second.plain;
 279 }
 280
 281 void
 282 DeviceProfile::set_button_action (Button::ID id, int modifier_state, const string& act)
 283 {
 284         ButtonActionMap::iterator i = _button_map.find (id);
 285
 286         if (i == _button_map.end()) {
 287                 i = _button_map.insert (std::make_pair (id, ButtonActions())).first;
 288         }
 289
 290         string action (act);
 291         replace_all (action, "<Actions>/", "");
 292
 293         if (modifier_state == MackieControlProtocol::MODIFIER_CONTROL) {
 294                 i->second.control = action;
 295         } else if (modifier_state == MackieControlProtocol::MODIFIER_SHIFT) {
 296                 i->second.shift = action;
 297         } else if (modifier_state == MackieControlProtocol::MODIFIER_OPTION) {
 298                 i->second.option = action;
 299         } else if (modifier_state == MackieControlProtocol::MODIFIER_CMDALT) {
 300                 i->second.cmdalt = action;
 301         } else if (modifier_state == (MackieControlProtocol::MODIFIER_CONTROL|MackieControlProtocol::MODIFIER_SHIFT)) {
 302                 i->second.shiftcontrol = action;
 303         }
 304
 305         if (modifier_state == 0) {
 306                 i->second.plain = action;
 307         }
 308
 309         save ();
 310 }
 311
 312 const string&
 313 DeviceProfile::name() const
 314 {
 315         return _name;
 316 }
 317
 318 void
 319 DeviceProfile::set_path (const string& p)
 320 {
 321         _path = p;
 322 }
 323
 324 /* XXX copied from libs/ardour/utils.cc */
 325
 326 static string
 327 legalize_for_path (const string& str)
 328 {
 329         string::size_type pos;
 330         string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
 331         string legal;
 332
 333         legal = str;
 334         pos = 0;
 335
 336         while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
 337                 legal.replace (pos, 1, "_");
 338                 pos += 1;
 339         }
 340
 341         return string (legal);
 342 }
 343
 344
 345 void
 346 DeviceProfile::save ()
 347 {
 348         sys::path fullpath = user_devprofile_directory();
 349
 350         if (g_mkdir_with_parents (fullpath.to_string().c_str(), 0755) < 0) {
 351                 error << string_compose(_("Session: cannot create user MCP profile folder \"%1\" (%2)"), fullpath.to_string(), strerror (errno)) << endmsg;
 352                 return;
 353         }
 354
 355         fullpath /= legalize_for_path (_name) + ".profile";
 356
 357         XMLTree tree;
 358         tree.set_root (&get_state());
 359
 360         if (!tree.write (fullpath.to_string())) {
 361                 error << string_compose ("MCP profile not saved to %1", fullpath.to_string()) << endmsg;
 362         }
 363 }
 364