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