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