don't throw an exception if /home/paul is not writable
[ardour2.git] / libs / ardour / globals.cc
blob5b6c3286e1e153ba1e66eb824e2262054589d0e5
1 /*
2 Copyright (C) 2000 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.
20 #include <cstdio> // Needed so that libraptor (included in lrdf) won't complain
21 #include <sys/stat.h>
22 #include <sys/types.h>
23 #include <sys/time.h>
24 #include <sys/resource.h>
25 #include <unistd.h>
26 #include <fcntl.h>
27 #include <errno.h>
29 #ifdef VST_SUPPORT
30 #include <fst.h>
31 #endif
33 #ifdef HAVE_AUDIOUNITS
34 #include <ardour/audio_unit.h>
35 #endif
37 #ifdef __SSE__
38 #include <xmmintrin.h>
39 #endif
41 #include <glibmm/fileutils.h>
42 #include <glibmm/miscutils.h>
44 #include <lrdf.h>
46 #include <pbd/error.h>
47 #include <pbd/id.h>
48 #include <pbd/strsplit.h>
49 #include <pbd/fpu.h>
50 #include <pbd/pathscanner.h>
52 #include <midi++/port.h>
53 #include <midi++/manager.h>
54 #include <midi++/mmc.h>
56 #include <ardour/ardour.h>
57 #include <ardour/analyser.h>
58 #include <ardour/audio_library.h>
59 #include <ardour/configuration.h>
60 #include <ardour/profile.h>
61 #include <ardour/plugin_manager.h>
62 #include <ardour/audiosource.h>
63 #include <ardour/utils.h>
64 #include <ardour/session.h>
65 #include <ardour/source_factory.h>
66 #include <ardour/control_protocol_manager.h>
68 #ifdef HAVE_LIBLO
69 #include <ardour/osc.h>
70 #endif
72 #include <ardour/mix.h>
74 #if defined (__APPLE__)
75 #include <Carbon/Carbon.h> // For Gestalt
76 #endif
78 #include "i18n.h"
80 ARDOUR::Configuration* ARDOUR::Config = 0;
81 ARDOUR::RuntimeProfile* ARDOUR::Profile = 0;
82 ARDOUR::AudioLibrary* ARDOUR::Library = 0;
84 #ifdef HAVE_LIBLO
85 ARDOUR::OSC* ARDOUR::osc = 0;
86 #endif
88 using namespace ARDOUR;
89 using namespace std;
90 using namespace PBD;
92 MIDI::Port *ARDOUR::default_mmc_port = 0;
93 MIDI::Port *ARDOUR::default_mtc_port = 0;
94 MIDI::Port *ARDOUR::default_midi_port = 0;
96 Change ARDOUR::StartChanged = ARDOUR::new_change ();
97 Change ARDOUR::LengthChanged = ARDOUR::new_change ();
98 Change ARDOUR::PositionChanged = ARDOUR::new_change ();
99 Change ARDOUR::NameChanged = ARDOUR::new_change ();
100 Change ARDOUR::BoundsChanged = Change (0); // see init(), below
102 sigc::signal<void,std::string> ARDOUR::BootMessage;
104 #ifdef HAVE_LIBLO
105 static int
106 setup_osc ()
108 /* no real cost to creating this object, and it avoids
109 conditionals anywhere that uses it
112 osc = new OSC (Config->get_osc_port());
114 if (Config->get_use_osc ()) {
115 BootMessage (_("Starting OSC"));
116 return osc->start ();
117 } else {
118 return 0;
122 #endif
125 ARDOUR::setup_midi ()
127 if (Config->midi_ports.size() == 0) {
128 warning << _("no MIDI ports specified: no MMC or MTC control possible") << endmsg;
129 return 0;
132 BootMessage (_("Configuring MIDI ports"));
134 for (std::map<string,XMLNode>::iterator i = Config->midi_ports.begin(); i != Config->midi_ports.end(); ++i) {
135 MIDI::Manager::instance()->add_port (i->second);
138 MIDI::Port* first;
139 const MIDI::Manager::PortMap& ports = MIDI::Manager::instance()->get_midi_ports();
141 if (ports.size() > 1) {
143 first = ports.begin()->second;
145 /* More than one port, so try using specific names for each port */
147 if (Config->get_mmc_port_name() != N_("default")) {
148 default_mmc_port = MIDI::Manager::instance()->port (Config->get_mmc_port_name());
151 if (Config->get_mtc_port_name() != N_("default")) {
152 default_mtc_port = MIDI::Manager::instance()->port (Config->get_mtc_port_name());
155 if (Config->get_midi_port_name() != N_("default")) {
156 default_midi_port = MIDI::Manager::instance()->port (Config->get_midi_port_name());
159 /* If that didn't work, just use the first listed port */
161 if (default_mmc_port == 0) {
162 default_mmc_port = first;
165 if (default_mtc_port == 0) {
166 default_mtc_port = first;
169 if (default_midi_port == 0) {
170 default_midi_port = first;
173 } else if (ports.size() == 1) {
175 first = ports.begin()->second;
177 /* Only one port described, so use it for both MTC and MMC */
179 default_mmc_port = first;
180 default_mtc_port = default_mmc_port;
181 default_midi_port = default_mmc_port;
184 if (default_mmc_port == 0) {
185 warning << string_compose (_("No MMC control (MIDI port \"%1\" not available)"), Config->get_mmc_port_name())
186 << endmsg;
187 return 0;
191 if (default_mtc_port == 0) {
192 warning << string_compose (_("No MTC support (MIDI port \"%1\" not available)"), Config->get_mtc_port_name())
193 << endmsg;
196 if (default_midi_port == 0) {
197 warning << string_compose (_("No MIDI parameter support (MIDI port \"%1\" not available)"), Config->get_midi_port_name())
198 << endmsg;
201 return 0;
204 void
205 setup_hardware_optimization (bool try_optimization)
207 bool generic_mix_functions = true;
209 if (try_optimization) {
211 FPU fpu;
213 #if defined (ARCH_X86) && defined (BUILD_SSE_OPTIMIZATIONS)
215 if (fpu.has_sse()) {
217 info << "Using SSE optimized routines" << endmsg;
219 // SSE SET
220 Session::compute_peak = x86_sse_compute_peak;
221 Session::find_peaks = x86_sse_find_peaks;
222 Session::apply_gain_to_buffer = x86_sse_apply_gain_to_buffer;
223 Session::mix_buffers_with_gain = x86_sse_mix_buffers_with_gain;
224 Session::mix_buffers_no_gain = x86_sse_mix_buffers_no_gain;
226 generic_mix_functions = false;
230 #elif defined (__APPLE__) && defined (BUILD_VECLIB_OPTIMIZATIONS)
231 long sysVersion = 0;
233 if (noErr != Gestalt(gestaltSystemVersion, &sysVersion))
234 sysVersion = 0;
236 if (sysVersion >= 0x00001040) { // Tiger at least
237 Session::compute_peak = veclib_compute_peak;
238 Session::find_peaks = veclib_find_peaks;
239 Session::apply_gain_to_buffer = veclib_apply_gain_to_buffer;
240 Session::mix_buffers_with_gain = veclib_mix_buffers_with_gain;
241 Session::mix_buffers_no_gain = veclib_mix_buffers_no_gain;
243 generic_mix_functions = false;
245 info << "Apple VecLib H/W specific optimizations in use" << endmsg;
247 #endif
249 /* consider FPU denormal handling to be "h/w optimization" */
251 setup_fpu ();
254 if (generic_mix_functions) {
256 Session::compute_peak = compute_peak;
257 Session::find_peaks = find_peaks;
258 Session::apply_gain_to_buffer = apply_gain_to_buffer;
259 Session::mix_buffers_with_gain = mix_buffers_with_gain;
260 Session::mix_buffers_no_gain = mix_buffers_no_gain;
262 info << "No H/W specific optimizations in use" << endmsg;
267 static void
268 lotsa_files_please ()
270 struct rlimit rl;
272 if (getrlimit (RLIMIT_NOFILE, &rl) == 0) {
274 rl.rlim_cur = rl.rlim_max;
276 if (setrlimit (RLIMIT_NOFILE, &rl) != 0) {
277 if (rl.rlim_cur == RLIM_INFINITY) {
278 error << _("Could not set system open files limit to \"unlimited\"") << endmsg;
279 } else {
280 error << string_compose (_("Could not set system open files limit to %1"), rl.rlim_cur) << endmsg;
282 } else {
283 if (rl.rlim_cur == RLIM_INFINITY) {
284 info << _("Removed open file count limit. Excellent!") << endmsg;
285 } else {
286 info << string_compose (_("%1 will be limited to %2 open files"), PROGRAM_NAME, rl.rlim_cur) << endmsg;
289 } else {
290 error << string_compose (_("Could not get system open files limit (%1)"), strerror (errno)) << endmsg;
295 ARDOUR::init (bool use_vst, bool try_optimization)
297 extern void setup_enum_writer ();
299 (void) bindtextdomain(PACKAGE, LOCALEDIR);
301 setup_enum_writer ();
303 // allow ardour the absolute maximum number of open files
304 lotsa_files_please ();
306 lrdf_init();
307 Library = new AudioLibrary;
309 BootMessage (_("Loading configuration"));
311 Config = new Configuration;
313 if (Config->load_state ()) {
314 return -1;
317 Config->set_use_vst (use_vst);
319 Profile = new RuntimeProfile;
321 if (setup_midi ()) {
322 return -1;
325 #ifdef HAVE_LIBLO
326 if (setup_osc ()) {
327 return -1;
329 #endif
331 #ifdef VST_SUPPORT
332 if (Config->get_use_vst() && fst_init (0)) {
333 return -1;
335 #endif
337 #ifdef HAVE_AUDIOUNITS
338 AUPluginInfo::load_cached_info ();
339 #endif
341 /* Make VAMP look in our library ahead of anything else */
343 char *p = getenv ("VAMP_PATH");
344 string vamppath = VAMP_DIR;
345 if (p) {
346 vamppath += ':';
347 vamppath += p;
349 setenv ("VAMP_PATH", vamppath.c_str(), 1);
352 setup_hardware_optimization (try_optimization);
354 SourceFactory::init ();
355 Analyser::init ();
357 /* singleton - first object is "it" */
358 new PluginManager ();
360 /* singleton - first object is "it" */
361 new ControlProtocolManager ();
362 ControlProtocolManager::instance().discover_control_protocols (Session::control_protocol_path());
364 XMLNode* node;
365 if ((node = Config->control_protocol_state()) != 0) {
366 ControlProtocolManager::instance().set_state (*node);
369 BoundsChanged = Change (StartChanged|PositionChanged|LengthChanged);
371 return 0;
375 ARDOUR::cleanup ()
377 delete Library;
378 lrdf_cleanup ();
379 delete &ControlProtocolManager::instance();
380 #ifdef VST_SUPPORT
381 fst_exit ();
382 #endif
383 return 0;
387 microseconds_t
388 ARDOUR::get_microseconds ()
390 return (microseconds_t) jack_get_time ();
393 ARDOUR::Change
394 ARDOUR::new_change ()
396 Change c;
397 static uint32_t change_bit = 1;
399 /* catch out-of-range */
400 if (!change_bit)
402 fatal << _("programming error: ")
403 << "change_bit out of range in ARDOUR::new_change()"
404 << endmsg;
405 /*NOTREACHED*/
408 c = Change (change_bit);
409 change_bit <<= 1; // if it shifts too far, change_bit == 0
411 return c;
414 string
415 ARDOUR::get_ardour_revision ()
417 return "$Rev$";
420 string
421 ARDOUR::get_user_ardour_path ()
423 string path;
425 path = Glib::get_home_dir();
427 if (path.empty()) {
428 return "/";
431 path += "/.ardour2/";
433 /* create it if necessary */
435 if (g_mkdir_with_parents (path.c_str (), 0755)) {
436 cerr << "\n\n\nYour home folder is not writable (Ardour cannot create its settings folder there). Please fix this before running Ardour again."
437 << endl;
438 _exit (1);
441 return path;
444 string
445 ARDOUR::get_system_data_path ()
447 string path;
449 char *envvar;
451 if ((envvar = getenv ("ARDOUR_DATA_PATH")) != 0) {
452 path = envvar;
453 } else {
454 path += DATA_DIR;
455 path += "/ardour2/";
458 return path;
461 string
462 ARDOUR::get_system_module_path ()
464 string path;
465 char *envvar;
467 if ((envvar = getenv ("ARDOUR_MODULE_PATH")) != 0) {
468 path = envvar;
469 } else {
470 path += MODULE_DIR;
471 path += "/ardour2/";
474 return path;
477 static string
478 find_file (string name, string dir, string subdir = "")
480 string path;
481 char* envvar = getenv("ARDOUR_PATH");
483 /* 1st attempt: any directory in ARDOUR_PATH */
485 if (envvar != 0) {
487 vector<string> split_path;
489 split (envvar, split_path, ':');
491 for (vector<string>::iterator i = split_path.begin(); i != split_path.end(); ++i) {
492 path = *i;
493 path += "/" + name;
494 if (Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
495 // cerr << "Using file " << path << " found in ARDOUR_PATH." << endl;
496 return path;
501 /* 2nd attempt: ~/.ardour/ */
503 path = get_user_ardour_path();
505 if (subdir.length()) {
506 path = Glib::build_filename (path, subdir);
509 path = Glib::build_filename (path, name);
511 if (Glib::file_test (path.c_str(), Glib::FILE_TEST_EXISTS)) {
512 return path;
515 if (dir.length()) {
516 /* 3rd attempt: dir/... */
518 path = dir;
519 path += "/ardour2/";
521 if (subdir.length()) {
522 path += subdir + "/";
525 path += name;
527 if (access (path.c_str(), R_OK) == 0) {
528 return path;
532 return "";
535 static bool sae_binding_filter (const string& str, void* arg)
537 /* Not a dotfile, has a prefix before a period, suffix is ".bindings" and contains -sae- */
539 return str[0] != '.' && str.length() > 13 && str.find (".bindings") == (str.length() - 9)
540 && str.find ("SAE-") != string::npos;
543 static bool binding_filter (const string& str, void* arg)
545 /* Not a dotfile, has a prefix before a period, suffix is ".bindings" */
547 return str[0] != '.' && str.length() > 9 && str.find (".bindings") == (str.length() - 9);
550 void
551 ARDOUR::find_bindings_files (map<string,string>& files)
553 PathScanner scanner;
554 vector<string*> *found;
555 string full_path;
557 /* XXX building path, so separators are fixed */
559 full_path = get_user_ardour_path ();
560 full_path += ':';
561 full_path = get_system_data_path ();
563 if (getenv ("ARDOUR_SAE")) {
564 found = scanner (full_path, sae_binding_filter, 0, false, true);
565 } else {
566 found = scanner (full_path, binding_filter, 0, false, true);
569 if (!found) {
570 return;
573 for (vector<string*>::iterator x = found->begin(); x != found->end(); ++x) {
574 string path = *(*x);
575 pair<string,string> namepath;
576 namepath.second = path;
577 path = Glib::path_get_basename (path);
578 namepath.first = path.substr (0, path.find_first_of ('.'));
580 files.insert (namepath);
581 delete *x;
584 delete found;
587 string
588 ARDOUR::find_config_file (string name)
590 const char* envvar;
592 if ((envvar = getenv("ARDOUR_CONFIG_PATH")) == 0) {
593 envvar = CONFIG_DIR;
596 return find_file (name, envvar);
599 string
600 ARDOUR::find_data_file (string name, string subdir)
602 const char* envvar;
603 if ((envvar = getenv("ARDOUR_DATA_PATH")) == 0) {
604 envvar = DATA_DIR;
607 return find_file (name, envvar, subdir);
610 void
611 ARDOUR::setup_fpu ()
613 if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
614 // valgrind doesn't understand this assembler stuff
615 // September 10th, 2007
616 return;
619 #if defined(ARCH_X86) && defined(USE_XMMINTRIN)
621 int MXCSR;
622 FPU fpu;
624 /* XXX use real code to determine if the processor supports
625 DenormalsAreZero and FlushToZero
628 if (!fpu.has_flush_to_zero() && !fpu.has_denormals_are_zero()) {
629 return;
632 MXCSR = _mm_getcsr();
634 switch (Config->get_denormal_model()) {
635 case DenormalNone:
636 MXCSR &= ~(_MM_FLUSH_ZERO_ON|0x8000);
637 break;
639 case DenormalFTZ:
640 if (fpu.has_flush_to_zero()) {
641 MXCSR |= _MM_FLUSH_ZERO_ON;
643 break;
645 case DenormalDAZ:
646 MXCSR &= ~_MM_FLUSH_ZERO_ON;
647 if (fpu.has_denormals_are_zero()) {
648 MXCSR |= 0x8000;
650 break;
652 case DenormalFTZDAZ:
653 if (fpu.has_flush_to_zero()) {
654 if (fpu.has_denormals_are_zero()) {
655 MXCSR |= _MM_FLUSH_ZERO_ON | 0x8000;
656 } else {
657 MXCSR |= _MM_FLUSH_ZERO_ON;
660 break;
663 _mm_setcsr (MXCSR);
665 #endif
668 ARDOUR::OverlapType
669 ARDOUR::coverage (nframes_t sa, nframes_t ea,
670 nframes_t sb, nframes_t eb)
672 /* OverlapType returned reflects how the second (B)
673 range overlaps the first (A).
675 The diagrams show various relative placements
676 of A and B for each OverlapType.
678 Notes:
679 Internal: the start points cannot coincide
680 External: the start and end points can coincide
681 Start: end points can coincide
682 End: start points can coincide
684 XXX Logically, Internal should disallow end
685 point equality.
689 |--------------------| A
690 |------| B
691 |-----------------| B
694 "B is internal to A"
697 #ifdef OLD_COVERAGE
698 if ((sb >= sa) && (eb <= ea)) {
699 #else
700 if ((sb > sa) && (eb <= ea)) {
701 #endif
702 return OverlapInternal;
706 |--------------------| A
707 ----| B
708 -----------------------| B
709 --| B
711 "B overlaps the start of A"
715 if ((eb >= sa) && (eb <= ea)) {
716 return OverlapStart;
719 |---------------------| A
720 |----------------- B
721 |----------------------- B
722 |- B
724 "B overlaps the end of A"
727 if ((sb >= sa) && (sb <= ea)) {
728 return OverlapEnd;
731 |--------------------| A
732 -------------------------- B
733 |----------------------- B
734 ----------------------| B
735 |--------------------| B
738 "B overlaps all of A"
740 if ((sa >= sb) && (sa <= eb) && (ea <= eb)) {
741 return OverlapExternal;
744 return OverlapNone;
747 string
748 ARDOUR::translation_kill_path ()
750 return Glib::build_filename (get_user_ardour_path(), ".love_is_the_language_of_audio");
753 bool
754 ARDOUR::translations_are_disabled ()
756 /* if file does not exist, we don't translate (bundled ardour only) */
757 return Glib::file_test (translation_kill_path(), Glib::FILE_TEST_EXISTS) == false;
760 /* not sure where to put these */
762 template<class T>
763 std::istream& int_to_type (std::istream& o, T& hf) {
764 int val;
765 o >> val;
766 hf = (T) val;
767 return o;
770 std::istream& operator>>(std::istream& o, HeaderFormat& var) { return int_to_type<HeaderFormat> (o, var); }
771 std::istream& operator>>(std::istream& o, SampleFormat& var) { return int_to_type<SampleFormat> (o, var); }
772 std::istream& operator>>(std::istream& o, AutoConnectOption& var) { return int_to_type<AutoConnectOption> (o, var); }
773 std::istream& operator>>(std::istream& o, MonitorModel& var) { return int_to_type<MonitorModel> (o, var); }
774 std::istream& operator>>(std::istream& o, RemoteModel& var) { return int_to_type<RemoteModel> (o, var); }
775 std::istream& operator>>(std::istream& o, EditMode& var) { return int_to_type<EditMode> (o, var); }
776 std::istream& operator>>(std::istream& o, SoloModel& var) { return int_to_type<SoloModel> (o, var); }
777 std::istream& operator>>(std::istream& o, LayerModel& var) { return int_to_type<LayerModel> (o, var); }
778 std::istream& operator>>(std::istream& o, CrossfadeModel& var) { return int_to_type<CrossfadeModel> (o, var); }
779 std::istream& operator>>(std::istream& o, SlaveSource& var) { return int_to_type<SlaveSource> (o, var); }
780 std::istream& operator>>(std::istream& o, ShuttleBehaviour& var) { return int_to_type<ShuttleBehaviour> (o, var); }
781 std::istream& operator>>(std::istream& o, ShuttleUnits& var) { return int_to_type<ShuttleUnits> (o, var); }
782 std::istream& operator>>(std::istream& o, SmpteFormat& var) { return int_to_type<SmpteFormat> (o, var); }
783 std::istream& operator>>(std::istream& o, DenormalModel& var) { return int_to_type<DenormalModel> (o, var); }