libs/ardour/rc_configuration.cc

   1 /*
   2     Copyright (C) 1999-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <unistd.h>
  21 #include <cstdio> /* for snprintf, grrr */
  22
  23 #include <glib.h>
  24 #include <glib/gstdio.h> /* for g_stat() */
  25 #include <glibmm/miscutils.h>
  26
  27 #include "pbd/failed_constructor.h"
  28 #include "pbd/xml++.h"
  29 #include "pbd/filesystem.h"
  30 #include "pbd/file_utils.h"
  31
  32 #include "midi++/manager.h"
  33
  34 #include "ardour/ardour.h"
  35 #include "ardour/rc_configuration.h"
  36 #include "ardour/audio_diskstream.h"
  37 #include "ardour/control_protocol_manager.h"
  38 #include "ardour/filesystem_paths.h"
  39
  40 #include "i18n.h"
  41
  42 using namespace ARDOUR;
  43 using namespace std;
  44 using namespace PBD;
  45
  46 /* this is global so that we do not have to indirect through an object pointer
  47    to reference it.
  48 */
  49
  50 namespace ARDOUR {
  51     float speed_quietning = 0.251189; // -12dB reduction for ffwd or rewind
  52 }
  53
  54 RCConfiguration::RCConfiguration ()
  55         :
  56 /* construct variables */
  57 #undef  CONFIG_VARIABLE
  58 #undef  CONFIG_VARIABLE_SPECIAL
  59 #define CONFIG_VARIABLE(Type,var,name,value) var (name,value),
  60 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) var (name,value,mutator),
  61 #include "ardour/rc_configuration_vars.h"
  62 #undef  CONFIG_VARIABLE
  63 #undef  CONFIG_VARIABLE_SPECIAL
  64         _control_protocol_state (0)
  65 {
  66 }
  67
  68
  69 RCConfiguration::~RCConfiguration ()
  70 {
  71         for (list<XMLNode*>::iterator i = _midi_port_states.begin(); i != _midi_port_states.end(); ++i) {
  72                 delete *i;
  73         }
  74
  75         delete _control_protocol_state;
  76 }
  77
  78 int
  79 RCConfiguration::load_state ()
  80 {
  81         sys::path system_rc_file;
  82         struct stat statbuf;
  83
  84         /* load system configuration first */
  85
  86         if (find_file_in_search_path (ardour_search_path() + system_config_search_path(), "ardour_system.rc", system_rc_file)) {
  87                 string rcfile = system_rc_file.to_string();
  88
  89                 /* stupid XML Parser hates empty files */
  90
  91                 if (g_stat (rcfile.c_str(), &statbuf)) {
  92                         return -1;
  93                 }
  94
  95                 if (statbuf.st_size != 0) {
  96                         info << string_compose (_("Loading system configuration file %1"), rcfile) << endl;
  97
  98                         XMLTree tree;
  99                         if (!tree.read (rcfile.c_str())) {
 100                                 error << string_compose(_("%1: cannot read system configuration file \"%2\""), PROGRAM_NAME, rcfile) << endmsg;
 101                                 return -1;
 102                         }
 103
 104                         if (set_state (*tree.root(), Stateful::current_state_version)) {
 105                                 error << string_compose(_("%1: system configuration file \"%2\" not loaded successfully."), PROGRAM_NAME, rcfile) << endmsg;
 106                                 return -1;
 107                         }
 108                 } else {
 109                         error << string_compose (_("your system %1 configuration file is empty. This probably means that there as an error installing %1"), PROGRAM_NAME) << endmsg;
 110                 }
 111         }
 112
 113         /* now load configuration file for user */
 114
 115         sys::path user_rc_file;
 116
 117         if (find_file_in_search_path (ardour_search_path() + user_config_directory(), "ardour.rc", user_rc_file)) {
 118                 string rcfile = user_rc_file.to_string();
 119
 120                 /* stupid XML parser hates empty files */
 121
 122                 if (g_stat (rcfile.c_str(), &statbuf)) {
 123                         return -1;
 124                 }
 125
 126                 if (statbuf.st_size != 0) {
 127                         info << string_compose (_("Loading user configuration file %1"), rcfile) << endl;
 128
 129                         XMLTree tree;
 130                         if (!tree.read (rcfile)) {
 131                                 error << string_compose(_("%1: cannot read configuration file \"%2\""), PROGRAM_NAME, rcfile) << endmsg;
 132                                 return -1;
 133                         }
 134
 135                         if (set_state (*tree.root(), Stateful::current_state_version)) {
 136                                 error << string_compose(_("%1: user configuration file \"%2\" not loaded successfully."), PROGRAM_NAME, rcfile) << endmsg;
 137                                 return -1;
 138                         }
 139                 } else {
 140                         warning << string_compose (_("your %1 configuration file is empty. This is not normal."), PROGRAM_NAME) << endmsg;
 141                 }
 142         }
 143
 144         return 0;
 145 }
 146
 147 int
 148 RCConfiguration::save_state()
 149 {
 150         try
 151         {
 152                 sys::create_directories (user_config_directory ());
 153         }
 154         catch (const sys::filesystem_error& ex)
 155         {
 156                 error << "Could not create user configuration directory" << endmsg;
 157                 return -1;
 158         }
 159
 160         sys::path rcfile_path(user_config_directory());
 161
 162         rcfile_path /= "ardour.rc";
 163         const string rcfile = rcfile_path.to_string();
 164
 165         // this test seems bogus?
 166         if (!rcfile.empty()) {
 167                 XMLTree tree;
 168                 tree.set_root (&get_state());
 169                 if (!tree.write (rcfile.c_str())){
 170                         error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
 171                         return -1;
 172                 }
 173         }
 174
 175         return 0;
 176 }
 177
 178 void
 179 RCConfiguration::add_instant_xml(XMLNode& node)
 180 {
 181         Stateful::add_instant_xml (node, user_config_directory ());
 182 }
 183
 184 XMLNode*
 185 RCConfiguration::instant_xml(const string& node_name)
 186 {
 187         return Stateful::instant_xml (node_name, user_config_directory ());
 188 }
 189
 190
 191 XMLNode&
 192 RCConfiguration::get_state ()
 193 {
 194         XMLNode* root;
 195         LocaleGuard lg (X_("POSIX"));
 196
 197         root = new XMLNode("Ardour");
 198
 199         MIDI::Manager* mm = MIDI::Manager::instance();
 200
 201         if (mm) {
 202                 boost::shared_ptr<const MIDI::Manager::PortList> ports = mm->get_midi_ports();
 203
 204                 for (MIDI::Manager::PortList::const_iterator i = ports->begin(); i != ports->end(); ++i) {
 205                         root->add_child_nocopy((*i)->get_state());
 206                 }
 207         }
 208
 209         root->add_child_nocopy (get_variables ());
 210
 211         if (_extra_xml) {
 212                 root->add_child_copy (*_extra_xml);
 213         }
 214
 215         root->add_child_nocopy (ControlProtocolManager::instance().get_state());
 216
 217         return *root;
 218 }
 219
 220 XMLNode&
 221 RCConfiguration::get_variables ()
 222 {
 223         XMLNode* node;
 224         LocaleGuard lg (X_("POSIX"));
 225
 226         node = new XMLNode ("Config");
 227
 228 #undef  CONFIG_VARIABLE
 229 #undef  CONFIG_VARIABLE_SPECIAL
 230 #define CONFIG_VARIABLE(type,var,Name,value) \
 231         var.add_to_node (*node);
 232 #define CONFIG_VARIABLE_SPECIAL(type,var,Name,value,mutator) \
 233         var.add_to_node (*node);
 234 #include "ardour/rc_configuration_vars.h"
 235 #undef  CONFIG_VARIABLE
 236 #undef  CONFIG_VARIABLE_SPECIAL
 237
 238         return *node;
 239 }
 240
 241 int
 242 RCConfiguration::set_state (const XMLNode& root, int /*version*/)
 243 {
 244         if (root.name() != "Ardour") {
 245                 return -1;
 246         }
 247
 248         XMLNodeList nlist = root.children();
 249         XMLNodeConstIterator niter;
 250         XMLNode *node;
 251
 252         for (list<XMLNode*>::iterator i = _midi_port_states.begin(); i != _midi_port_states.end(); ++i) {
 253                 delete *i;
 254         }
 255
 256         _midi_port_states.clear ();
 257
 258         Stateful::save_extra_xml (root);
 259
 260         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 261
 262                 node = *niter;
 263
 264                 if (node->name() == "Config") {
 265                         set_variables (*node);
 266                 } else if (node->name() == ControlProtocolManager::state_node_name) {
 267                         _control_protocol_state = new XMLNode (*node);
 268                 } else if (node->name() == MIDI::Port::state_node_name) {
 269                         _midi_port_states.push_back (new XMLNode (*node));
 270                 }
 271         }
 272
 273         Diskstream::set_disk_io_chunk_frames (minimum_disk_io_bytes.get() / sizeof (Sample));
 274
 275         return 0;
 276 }
 277
 278 void
 279 RCConfiguration::set_variables (const XMLNode& node)
 280 {
 281 #undef  CONFIG_VARIABLE
 282 #undef  CONFIG_VARIABLE_SPECIAL
 283 #define CONFIG_VARIABLE(type,var,name,value) \
 284         if (var.set_from_node (node)) { \
 285                 ParameterChanged (name);                  \
 286         }
 287 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
 288         if (var.set_from_node (node)) {    \
 289                 ParameterChanged (name);                     \
 290         }
 291
 292 #include "ardour/rc_configuration_vars.h"
 293 #undef  CONFIG_VARIABLE
 294 #undef  CONFIG_VARIABLE_SPECIAL
 295
 296 }
 297 void
 298 RCConfiguration::map_parameters (boost::function<void (std::string)>& functor)
 299 {
 300 #undef  CONFIG_VARIABLE
 301 #undef  CONFIG_VARIABLE_SPECIAL
 302 #define CONFIG_VARIABLE(type,var,name,value)                 functor (name);
 303 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) functor (name);
 304 #include "ardour/rc_configuration_vars.h"
 305 #undef  CONFIG_VARIABLE
 306 #undef  CONFIG_VARIABLE_SPECIAL
 307 }