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 "pbd/gstdio_compat.h"
  25 #include <glibmm/miscutils.h>
  26
  27 #include "pbd/xml++.h"
  28 #include "pbd/file_utils.h"
  29 #include "pbd/replace_all.h"
  30
  31 #include "ardour/audioengine.h"
  32 #include "ardour/disk_reader.h"
  33 #include "ardour/disk_writer.h"
  34 #include "ardour/control_protocol_manager.h"
  35 #include "ardour/filesystem_paths.h"
  36 #include "ardour/port.h"
  37 #include "ardour/rc_configuration.h"
  38 #include "ardour/session_metadata.h"
  39 #include "ardour/types_convert.h"
  40
  41 #include "pbd/i18n.h"
  42
  43 using namespace ARDOUR;
  44 using namespace std;
  45 using namespace PBD;
  46
  47 /* this is global so that we do not have to indirect through an object pointer
  48    to reference it.
  49 */
  50
  51 namespace ARDOUR {
  52     float speed_quietning = 0.251189; // -12dB reduction for ffwd or rewind
  53 }
  54
  55 static const char* user_config_file_name = "config";
  56 static const char* system_config_file_name = "system_config";
  57
  58 RCConfiguration::RCConfiguration ()
  59         :
  60 /* construct variables */
  61 #undef  CONFIG_VARIABLE
  62 #undef  CONFIG_VARIABLE_SPECIAL
  63 #define CONFIG_VARIABLE(Type,var,name,value) var (name,value),
  64 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) var (name,value,mutator),
  65 #include "ardour/rc_configuration_vars.h"
  66 #undef  CONFIG_VARIABLE
  67 #undef  CONFIG_VARIABLE_SPECIAL
  68         _control_protocol_state (0)
  69 {
  70 }
  71
  72 RCConfiguration::~RCConfiguration ()
  73 {
  74         delete _control_protocol_state;
  75 }
  76
  77 int
  78 RCConfiguration::load_state ()
  79 {
  80         std::string rcfile;
  81         GStatBuf statbuf;
  82
  83         /* load system configuration first */
  84
  85         if (find_file (ardour_config_search_path(), system_config_file_name, 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) << endmsg;
  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 was an error installing %1"), PROGRAM_NAME) << endmsg;
 108                 }
 109         }
 110
 111         /* now load configuration file for user */
 112
 113         if (find_file (ardour_config_search_path(), user_config_file_name, 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) << endmsg;
 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         const std::string rcfile = Glib::build_filename (user_config_directory(), user_config_file_name);
 146
 147         // this test seems bogus?
 148         if (!rcfile.empty()) {
 149                 XMLTree tree;
 150                 tree.set_root (&get_state());
 151                 if (!tree.write (rcfile.c_str())){
 152                         error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
 153                         return -1;
 154                 }
 155         }
 156
 157         return 0;
 158 }
 159
 160 void
 161 RCConfiguration::add_instant_xml(XMLNode& node)
 162 {
 163         Stateful::add_instant_xml (node, user_config_directory ());
 164 }
 165
 166 XMLNode*
 167 RCConfiguration::instant_xml(const string& node_name)
 168 {
 169         return Stateful::instant_xml (node_name, user_config_directory ());
 170 }
 171
 172
 173 XMLNode&
 174 RCConfiguration::get_state ()
 175 {
 176         XMLNode* root;
 177
 178         root = new XMLNode("Ardour");
 179
 180         root->add_child_nocopy (get_variables ());
 181
 182         root->add_child_nocopy (SessionMetadata::Metadata()->get_user_state());
 183
 184         if (_extra_xml) {
 185                 root->add_child_copy (*_extra_xml);
 186         }
 187
 188         root->add_child_nocopy (ControlProtocolManager::instance().get_state());
 189
 190         return *root;
 191 }
 192
 193 XMLNode&
 194 RCConfiguration::get_variables ()
 195 {
 196         XMLNode* node;
 197
 198         node = new XMLNode ("Config");
 199
 200 #undef  CONFIG_VARIABLE
 201 #undef  CONFIG_VARIABLE_SPECIAL
 202 #define CONFIG_VARIABLE(type,var,Name,value) \
 203         var.add_to_node (*node);
 204 #define CONFIG_VARIABLE_SPECIAL(type,var,Name,value,mutator) \
 205         var.add_to_node (*node);
 206 #include "ardour/rc_configuration_vars.h"
 207 #undef  CONFIG_VARIABLE
 208 #undef  CONFIG_VARIABLE_SPECIAL
 209
 210         return *node;
 211 }
 212
 213 int
 214 RCConfiguration::set_state (const XMLNode& root, int version)
 215 {
 216         if (root.name() != "Ardour") {
 217                 return -1;
 218         }
 219
 220         XMLNodeList nlist = root.children();
 221         XMLNodeConstIterator niter;
 222         XMLNode *node;
 223
 224         Stateful::save_extra_xml (root);
 225
 226         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 227
 228                 node = *niter;
 229
 230                 if (node->name() == "Config") {
 231                         set_variables (*node);
 232                 } else if (node->name() == "Metadata") {
 233                         SessionMetadata::Metadata()->set_state (*node, version);
 234                 } else if (node->name() == ControlProtocolManager::state_node_name) {
 235                         _control_protocol_state = new XMLNode (*node);
 236                 }
 237         }
 238
 239         DiskReader::set_chunk_frames (minimum_disk_read_bytes.get() / sizeof (Sample));
 240         DiskWriter::set_chunk_frames (minimum_disk_write_bytes.get() / sizeof (Sample));
 241
 242         return 0;
 243 }
 244
 245 void
 246 RCConfiguration::set_variables (const XMLNode& node)
 247 {
 248 #undef  CONFIG_VARIABLE
 249 #undef  CONFIG_VARIABLE_SPECIAL
 250 #define CONFIG_VARIABLE(type,var,name,value) \
 251         if (var.set_from_node (node)) { \
 252                 ParameterChanged (name);                  \
 253         }
 254 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
 255         if (var.set_from_node (node)) {    \
 256                 ParameterChanged (name);                     \
 257         }
 258
 259 #include "ardour/rc_configuration_vars.h"
 260 #undef  CONFIG_VARIABLE
 261 #undef  CONFIG_VARIABLE_SPECIAL
 262
 263 }
 264 void
 265 RCConfiguration::map_parameters (boost::function<void (std::string)>& functor)
 266 {
 267 #undef  CONFIG_VARIABLE
 268 #undef  CONFIG_VARIABLE_SPECIAL
 269 #define CONFIG_VARIABLE(type,var,name,value)                 functor (name);
 270 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) functor (name);
 271 #include "ardour/rc_configuration_vars.h"
 272 #undef  CONFIG_VARIABLE
 273 #undef  CONFIG_VARIABLE_SPECIAL
 274 }
 275