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