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