2 Copyright (C) 1999-2006 Paul Davis
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.
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.
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.
21 #include <cstdio> /* for snprintf, grrr */
24 #include <glib/gstdio.h> /* for g_stat() */
25 #include <glibmm/miscutils.h>
27 #include <pbd/failed_constructor.h>
28 #include <pbd/xml++.h>
29 #include <pbd/filesystem.h>
30 #include <pbd/file_utils.h>
32 #include <midi++/manager.h>
34 #include <ardour/ardour.h>
35 #include <ardour/configuration.h>
36 #include <ardour/audio_diskstream.h>
37 #include <ardour/control_protocol_manager.h>
38 #include <ardour/filesystem_paths.h>
42 using namespace ARDOUR;
46 /* this is global so that we do not have to indirect through an object pointer
51 float speed_quietning = 0.251189; // -12dB reduction for ffwd or rewind
54 Configuration::Configuration ()
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/configuration_vars.h"
62 #undef CONFIG_VARIABLE
63 #undef CONFIG_VARIABLE_SPECIAL
66 current_owner (ConfigVariableBase::Default)
68 _control_protocol_state = 0;
71 Configuration::~Configuration ()
76 Configuration::set_current_owner (ConfigVariableBase::Owner owner)
78 current_owner = owner;
82 Configuration::load_state ()
86 sys::path system_rc_file;
89 /* load system configuration first */
91 if ( find_file_in_search_path (ardour_search_path() + system_config_search_path(),
92 "ardour_system.rc", system_rc_file) )
97 string rcfile = system_rc_file.to_string();
99 /* stupid XML Parser hates empty files */
101 if (g_stat (rcfile.c_str(), &statbuf)) {
105 if (statbuf.st_size != 0) {
106 cerr << string_compose (_("loading system configuration file %1"), rcfile) << endl;
108 if (!tree.read (rcfile.c_str())) {
109 error << string_compose(_("Ardour: cannot read system configuration file \"%1\""), rcfile) << endmsg;
113 current_owner = ConfigVariableBase::System;
115 if (set_state (*tree.root())) {
116 error << string_compose(_("Ardour: system configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
120 error << _("your system Ardour configuration file is empty. This probably means that there as an error installing Ardour") << endmsg;
124 /* now load configuration file for user */
126 sys::path user_rc_file;
128 if (find_file_in_search_path (ardour_search_path() + user_config_directory(),
129 "ardour.rc", user_rc_file))
133 string rcfile = user_rc_file.to_string();
135 /* stupid XML parser hates empty files */
137 if (g_stat (rcfile.c_str(), &statbuf)) {
141 if (statbuf.st_size != 0) {
142 cerr << string_compose (_("loading user configuration file %1"), rcfile) << endl;
144 if (!tree.read (rcfile)) {
145 error << string_compose(_("Ardour: cannot read configuration file \"%1\""), rcfile) << endmsg;
149 current_owner = ConfigVariableBase::Config;
151 if (set_state (*tree.root())) {
152 error << string_compose(_("Ardour: user configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
156 warning << _("your Ardour configuration file is empty. This is not normal.") << endmsg;
161 error << "Ardour: could not find configuration file (ardour.rc), canvas will look broken." << endmsg;
167 Configuration::save_state()
173 sys::create_directories (user_config_directory ());
175 catch (const sys::filesystem_error& ex)
177 error << "Could not create user configuration directory" << endmsg;
181 sys::path rcfile_path(user_config_directory());
183 rcfile_path /= "ardour.rc";
184 const string rcfile = rcfile_path.to_string();
186 // this test seems bogus?
187 if (rcfile.length()) {
188 tree.set_root (&get_state());
189 if (!tree.write (rcfile.c_str())){
190 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
199 Configuration::add_instant_xml(XMLNode& node)
201 Stateful::add_instant_xml (node, user_config_directory ());
205 Configuration::instant_xml(const string& node_name)
207 return Stateful::instant_xml (node_name, user_config_directory ());
212 Configuration::save_config_options_predicate (ConfigVariableBase::Owner owner)
214 /* only save things that were in the config file to start with */
215 return owner & ConfigVariableBase::Config;
219 Configuration::get_state ()
222 LocaleGuard lg (X_("POSIX"));
224 root = new XMLNode("Ardour");
226 MIDI::Manager::PortMap::const_iterator i;
227 const MIDI::Manager::PortMap& ports = MIDI::Manager::instance()->get_midi_ports();
229 for (i = ports.begin(); i != ports.end(); ++i) {
230 root->add_child_nocopy(i->second->get_state());
233 root->add_child_nocopy (get_variables (sigc::mem_fun (*this, &Configuration::save_config_options_predicate), "Config"));
236 root->add_child_copy (*_extra_xml);
239 root->add_child_nocopy (ControlProtocolManager::instance().get_state());
245 Configuration::get_variables (sigc::slot<bool,ConfigVariableBase::Owner> predicate, std::string which_node)
248 LocaleGuard lg (X_("POSIX"));
250 node = new XMLNode(which_node);
252 #undef CONFIG_VARIABLE
253 #undef CONFIG_VARIABLE_SPECIAL
254 #define CONFIG_VARIABLE(type,var,Name,value) \
255 if (node->name() == "Config") { if (predicate (var.owner())) { var.add_to_node (*node); }}
256 #define CONFIG_VARIABLE_SPECIAL(type,var,Name,value,mutator) \
257 if (node->name() == "Config") { if (predicate (var.owner())) { var.add_to_node (*node); }}
258 #include "ardour/configuration_vars.h"
259 #undef CONFIG_VARIABLE
260 #undef CONFIG_VARIABLE_SPECIAL
266 Configuration::set_state (const XMLNode& root)
268 if (root.name() != "Ardour") {
272 XMLNodeList nlist = root.children();
273 XMLNodeConstIterator niter;
276 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
280 if (node->name() == "MIDI-port") {
284 MIDI::Port::Descriptor desc (*node);
285 map<string,XMLNode>::iterator x;
286 if ((x = midi_ports.find (desc.tag)) != midi_ports.end()) {
287 midi_ports.erase (x);
289 midi_ports.insert (pair<string,XMLNode>(desc.tag,*node));
292 catch (failed_constructor& err) {
293 warning << _("ill-formed MIDI port specification in ardour rcfile (ignored)") << endmsg;
296 } else if (node->name() == "Config") {
298 set_variables (*node, ConfigVariableBase::Config);
300 } else if (node->name() == "Extra") {
301 _extra_xml = new XMLNode (*node);
303 } else if (node->name() == ControlProtocolManager::state_node_name) {
304 _control_protocol_state = new XMLNode (*node);
308 Diskstream::set_disk_io_chunk_frames (minimum_disk_io_bytes.get() / sizeof (Sample));
314 Configuration::set_variables (const XMLNode& node, ConfigVariableBase::Owner owner)
316 #undef CONFIG_VARIABLE
317 #undef CONFIG_VARIABLE_SPECIAL
318 #define CONFIG_VARIABLE(type,var,name,value) \
319 if (var.set_from_node (node, owner)) { \
320 ParameterChanged (name); \
322 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
323 if (var.set_from_node (node, owner)) { \
324 ParameterChanged (name); \
327 #include "ardour/configuration_vars.h"
328 #undef CONFIG_VARIABLE
329 #undef CONFIG_VARIABLE_SPECIAL
333 Configuration::map_parameters (sigc::slot<void,const char*> theSlot)
335 #undef CONFIG_VARIABLE
336 #undef CONFIG_VARIABLE_SPECIAL
337 #define CONFIG_VARIABLE(type,var,name,value) theSlot (name);
338 #define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) theSlot (name);
339 #include "ardour/configuration_vars.h"
340 #undef CONFIG_VARIABLE
341 #undef CONFIG_VARIABLE_SPECIAL
344 bool ConfigVariableBase::show_stores = false;
347 ConfigVariableBase::set_show_stored_values (bool yn)
353 ConfigVariableBase::show_stored_value (const string& str)
356 cerr << "Config variable " << _name << " stored as " << str << endl;
361 ConfigVariableBase::notify ()
363 // placeholder for any debugging desired when a config variable is modified
367 ConfigVariableBase::miss ()
369 // placeholder for any debugging desired when a config variable
370 // is set but to the same value as it already has