* libardour uses ARDOUR::nframes_t and ARDOUR::nframes64_t explicitly in headers
[ardour.git] / libs / ardour / globals.cc
1 /*
2     Copyright (C) 2000 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 #ifdef WAF_BUILD
21 #include "libardour-config.h"
22 #endif
23
24 #include <cstdio> // Needed so that libraptor (included in lrdf) won't complain
25 #include <sys/stat.h>
26 #include <sys/types.h>
27 #include <sys/time.h>
28 #include <sys/resource.h>
29 #include <unistd.h>
30 #include <fcntl.h>
31 #include <errno.h>
32
33 #ifdef VST_SUPPORT
34 #include <fst.h>
35 #endif
36
37 #ifdef HAVE_AUDIOUNITS
38 #include "ardour/audio_unit.h"
39 #endif
40
41 #ifdef __SSE__
42 #include <xmmintrin.h>
43 #endif
44
45 #include <glibmm/fileutils.h>
46 #include <glibmm/miscutils.h>
47
48 #include <lrdf.h>
49
50 #include "pbd/error.h"
51 #include "pbd/id.h"
52 #include "pbd/strsplit.h"
53 #include "pbd/fpu.h"
54 #include "pbd/file_utils.h"
55 #include "pbd/enumwriter.h"
56
57 #include "midi++/port.h"
58 #include "midi++/manager.h"
59 #include "midi++/mmc.h"
60
61 #include "ardour/analyser.h"
62 #include "ardour/ardour.h"
63 #include "ardour/audio_library.h"
64 #include "ardour/audioengine.h"
65 #include "ardour/audiosource.h"
66 #include "ardour/control_protocol_manager.h"
67 #include "ardour/debug.h"
68 #include "ardour/filesystem_paths.h"
69 #include "ardour/mix.h"
70 #include "ardour/plugin_manager.h"
71 #include "ardour/profile.h"
72 #include "ardour/rc_configuration.h"
73 #include "ardour/runtime_functions.h"
74 #include "ardour/session.h"
75 #include "ardour/source_factory.h"
76 #include "ardour/utils.h"
77
78 #if defined (__APPLE__)
79        #include <Carbon/Carbon.h> // For Gestalt
80 #endif
81
82 #include "i18n.h"
83
84 ARDOUR::RCConfiguration* ARDOUR::Config = 0;
85 ARDOUR::RuntimeProfile* ARDOUR::Profile = 0;
86 ARDOUR::AudioLibrary* ARDOUR::Library = 0;
87
88 using namespace ARDOUR;
89 using namespace std;
90 using namespace PBD;
91
92 uint64_t ARDOUR::debug_bits = 0x0;
93
94 MIDI::Port *ARDOUR::default_mmc_port = 0;
95 MIDI::Port *ARDOUR::default_mtc_port = 0;
96 MIDI::Port *ARDOUR::default_midi_port = 0;
97 MIDI::Port *ARDOUR::default_midi_clock_port = 0;
98
99 Change ARDOUR::StartChanged = ARDOUR::new_change ();
100 Change ARDOUR::LengthChanged = ARDOUR::new_change ();
101 Change ARDOUR::PositionChanged = ARDOUR::new_change ();
102 Change ARDOUR::NameChanged = ARDOUR::new_change ();
103 Change ARDOUR::BoundsChanged = Change (0); // see init(), below
104
105 compute_peak_t          ARDOUR::compute_peak = 0;
106 find_peaks_t            ARDOUR::find_peaks = 0;
107 apply_gain_to_buffer_t  ARDOUR::apply_gain_to_buffer = 0;
108 mix_buffers_with_gain_t ARDOUR::mix_buffers_with_gain = 0;
109 mix_buffers_no_gain_t   ARDOUR::mix_buffers_no_gain = 0;
110
111 sigc::signal<void,std::string> ARDOUR::BootMessage;
112
113 void
114 ARDOUR::debug_print (const char* prefix, std::string str)
115 {
116         cerr << prefix << ": " << str;
117 }
118
119 void
120 ARDOUR::set_debug_bits (uint64_t bits)
121 {
122         debug_bits = bits;
123 }
124
125 int
126 ARDOUR::setup_midi ()
127 {
128         if (Config->midi_ports.size() == 0) {
129                 //warning << _("no MIDI ports specified: no MMC or MTC control possible") << endmsg;
130                 return 0;
131         }
132
133         BootMessage (_("Configuring MIDI ports"));
134
135         for (std::map<string,XMLNode>::iterator i = Config->midi_ports.begin(); i != Config->midi_ports.end(); ++i) {
136                 MIDI::Manager::instance()->add_port (i->second);
137         }
138
139         MIDI::Port* first;
140         const MIDI::Manager::PortMap& ports = MIDI::Manager::instance()->get_midi_ports();
141
142         if (ports.size() > 1) {
143
144                 first = ports.begin()->second;
145
146                 /* More than one port, so try using specific names for each port */
147
148                 if (Config->get_mmc_port_name() != N_("control")) {
149                         default_mmc_port =  MIDI::Manager::instance()->port (Config->get_mmc_port_name());
150                 }
151
152                 if (Config->get_mtc_port_name() != N_("control")) {
153                         default_mtc_port =  MIDI::Manager::instance()->port (Config->get_mtc_port_name());
154                 }
155
156                 if (Config->get_midi_port_name() != N_("control")) {
157                         default_midi_port =  MIDI::Manager::instance()->port (Config->get_midi_port_name());
158                 }
159
160                 if (Config->get_midi_clock_port_name() != N_("control")) {
161                         default_midi_port =  MIDI::Manager::instance()->port (Config->get_midi_clock_port_name());
162                 }
163
164                 /* If that didn't work, just use the first listed port */
165
166                 if (default_mmc_port == 0) {
167                         default_mmc_port = first;
168                 }
169
170                 if (default_mtc_port == 0) {
171                         default_mtc_port = first;
172                 }
173
174                 if (default_midi_port == 0) {
175                         default_midi_port = first;
176                 }
177
178                 if (default_midi_clock_port == 0) {
179                         default_midi_clock_port = first;
180                 }
181
182         } else if (ports.size() == 1) {
183
184                 first = ports.begin()->second;
185
186                 /* Only one port described, so use it for both MTC and MMC */
187
188                 default_mmc_port = first;
189                 default_mtc_port = default_mmc_port;
190                 default_midi_port = default_mmc_port;
191                 default_midi_clock_port = default_mmc_port;
192         }
193
194         if (default_mmc_port == 0) {
195                 warning << string_compose (_("No MMC control (MIDI port \"%1\" not available)"), Config->get_mmc_port_name())
196                         << endmsg;
197                 return 0;
198         }
199
200
201         if (default_mtc_port == 0) {
202                 warning << string_compose (_("No MTC support (MIDI port \"%1\" not available)"), Config->get_mtc_port_name())
203                         << endmsg;
204         }
205
206         if (default_midi_port == 0) {
207                 warning << string_compose (_("No MIDI parameter support (MIDI port \"%1\" not available)"), Config->get_midi_port_name())
208                         << endmsg;
209         }
210
211         if (default_midi_clock_port == 0) {
212                 warning << string_compose (_("No MIDI Clock support (MIDI port \"%1\" not available)"), Config->get_midi_clock_port_name())
213                         << endmsg;
214         }
215
216         return 0;
217 }
218
219 void
220 setup_hardware_optimization (bool try_optimization)
221 {
222         bool generic_mix_functions = true;
223
224         if (try_optimization) {
225
226                 FPU fpu;
227
228 #if defined (ARCH_X86) && defined (BUILD_SSE_OPTIMIZATIONS)
229
230                 if (fpu.has_sse()) {
231
232                         info << "Using SSE optimized routines" << endmsg;
233
234                         // SSE SET
235                         compute_peak          = x86_sse_compute_peak;
236                         find_peaks            = x86_sse_find_peaks;
237                         apply_gain_to_buffer  = x86_sse_apply_gain_to_buffer;
238                         mix_buffers_with_gain = x86_sse_mix_buffers_with_gain;
239                         mix_buffers_no_gain   = x86_sse_mix_buffers_no_gain;
240
241                         generic_mix_functions = false;
242
243                 }
244
245 #elif defined (__APPLE__) && defined (BUILD_VECLIB_OPTIMIZATIONS)
246                 long sysVersion = 0;
247
248                 if (noErr != Gestalt(gestaltSystemVersion, &sysVersion))
249                         sysVersion = 0;
250
251                 if (sysVersion >= 0x00001040) { // Tiger at least
252                         compute_peak           = veclib_compute_peak;
253                         find_peaks             = veclib_find_peaks;
254                         apply_gain_to_buffer   = veclib_apply_gain_to_buffer;
255                         mix_buffers_with_gain  = veclib_mix_buffers_with_gain;
256                         mix_buffers_no_gain    = veclib_mix_buffers_no_gain;
257
258                         generic_mix_functions = false;
259
260                         info << "Apple VecLib H/W specific optimizations in use" << endmsg;
261                 }
262 #endif
263
264                 /* consider FPU denormal handling to be "h/w optimization" */
265
266                 setup_fpu ();
267         }
268
269         if (generic_mix_functions) {
270
271                 compute_peak          = default_compute_peak;
272                 find_peaks            = default_find_peaks;
273                 apply_gain_to_buffer  = default_apply_gain_to_buffer;
274                 mix_buffers_with_gain = default_mix_buffers_with_gain;
275                 mix_buffers_no_gain   = default_mix_buffers_no_gain;
276
277                 info << "No H/W specific optimizations in use" << endmsg;
278         }
279 }
280
281 static void
282 lotsa_files_please ()
283 {
284         struct rlimit rl;
285
286         if (getrlimit (RLIMIT_NOFILE, &rl) == 0) {
287
288                 rl.rlim_cur = rl.rlim_max;
289
290                 if (setrlimit (RLIMIT_NOFILE, &rl) != 0) {
291                         if (rl.rlim_cur == RLIM_INFINITY) {
292                                 error << _("Could not set system open files limit to \"unlimited\"") << endmsg;
293                         } else {
294                                 error << string_compose (_("Could not set system open files limit to %1"), rl.rlim_cur) << endmsg;
295                         }
296                 } else {
297                         if (rl.rlim_cur == RLIM_INFINITY) {
298                                 info << _("Removed open file count limit. Excellent!") << endmsg;
299                         } else {
300                                 info << string_compose (_("Ardour will be limited to %1 open files"), rl.rlim_cur) << endmsg;
301                         }
302                 }
303         } else {
304                 error << string_compose (_("Could not get system open files limit (%1)"), strerror (errno)) << endmsg;
305         }
306 }
307
308 int
309 ARDOUR::init (bool use_vst, bool try_optimization)
310 {
311         if (!Glib::thread_supported())
312                 Glib::thread_init();
313
314         PBD::ID::init ();
315
316         extern void setup_enum_writer ();
317
318         (void) bindtextdomain(PACKAGE, LOCALEDIR);
319
320         /* provide a state version for the few cases that need it and are not
321            driven by reading state from disk (e.g. undo/redo)
322         */
323
324         Stateful::current_state_version = CURRENT_SESSION_FILE_VERSION;
325
326         setup_enum_writer ();
327
328         // allow ardour the absolute maximum number of open files
329         lotsa_files_please ();
330
331         lrdf_init();
332         Library = new AudioLibrary;
333
334         BootMessage (_("Loading configuration"));
335
336         Config = new RCConfiguration;
337
338         if (Config->load_state ()) {
339                 return -1;
340         }
341
342         Config->set_use_vst (use_vst);
343
344         Profile = new RuntimeProfile;
345
346
347 #ifdef VST_SUPPORT
348         if (Config->get_use_vst() && fst_init (0)) {
349                 return -1;
350         }
351 #endif
352
353 #ifdef HAVE_AUDIOUNITS
354         AUPluginInfo::load_cached_info ();
355 #endif
356
357         /* Make VAMP look in our library ahead of anything else */
358
359         char *p = getenv ("VAMP_PATH");
360         string vamppath = VAMP_DIR;
361         if (p) {
362                 vamppath += ':';
363                 vamppath += p;
364         }
365         setenv ("VAMP_PATH", vamppath.c_str(), 1);
366
367
368         setup_hardware_optimization (try_optimization);
369
370         SourceFactory::init ();
371         Analyser::init ();
372
373         /* singleton - first object is "it" */
374         new PluginManager ();
375
376         BoundsChanged = Change (StartChanged|PositionChanged|LengthChanged);
377
378         return 0;
379 }
380
381 void
382 ARDOUR::init_post_engine ()
383 {
384         ControlProtocolManager::instance().discover_control_protocols ();
385
386         XMLNode* node;
387         if ((node = Config->control_protocol_state()) != 0) {
388                 ControlProtocolManager::instance().set_state (*node, Stateful::loading_state_version);
389         }
390 }
391
392 int
393 ARDOUR::cleanup ()
394 {
395         delete Library;
396         lrdf_cleanup ();
397         delete &ControlProtocolManager::instance();
398 #ifdef VST_SUPPORT
399         fst_exit ();
400 #endif
401         return 0;
402 }
403
404 ARDOUR::Change
405 ARDOUR::new_change ()
406 {
407         Change c;
408         static uint32_t change_bit = 1;
409
410         /* catch out-of-range */
411         if (!change_bit)
412         {
413                 fatal << _("programming error: ")
414                         << "change_bit out of range in ARDOUR::new_change()"
415                         << endmsg;
416                 /*NOTREACHED*/
417         }
418
419         c = Change (change_bit);
420         change_bit <<= 1;       // if it shifts too far, change_bit == 0
421
422         return c;
423 }
424
425 string
426 ARDOUR::get_ardour_revision ()
427 {
428         return "$Rev$";
429 }
430
431 void
432 ARDOUR::find_bindings_files (map<string,string>& files)
433 {
434         vector<sys::path> found;
435         SearchPath spath = ardour_search_path() + user_config_directory() + system_config_search_path();
436
437         if (getenv ("ARDOUR_SAE")) {
438                 Glib::PatternSpec pattern("*SAE-*.bindings");
439                 find_matching_files_in_search_path (spath, pattern, found);
440         } else {
441                 Glib::PatternSpec pattern("*.bindings");
442                 find_matching_files_in_search_path (spath, pattern, found);
443         }
444
445         if (found.empty()) {
446                 return;
447         }
448
449         for (vector<sys::path>::iterator x = found.begin(); x != found.end(); ++x) {
450                 sys::path path = *x;
451                 pair<string,string> namepath;
452                 namepath.second = path.to_string();
453                 namepath.first = path.leaf().substr (0, path.leaf().find_first_of ('.'));
454                 files.insert (namepath);
455         }
456 }
457
458 bool
459 ARDOUR::no_auto_connect()
460 {
461         return getenv ("ARDOUR_NO_AUTOCONNECT") != 0;
462 }
463
464 void
465 ARDOUR::setup_fpu ()
466 {
467
468         if (getenv ("ARDOUR_RUNNING_UNDER_VALGRIND")) {
469                 // valgrind doesn't understand this assembler stuff
470                 // September 10th, 2007
471                 return;
472         }
473
474 #if defined(ARCH_X86) && defined(USE_XMMINTRIN)
475
476         int MXCSR;
477         FPU fpu;
478
479         /* XXX use real code to determine if the processor supports
480            DenormalsAreZero and FlushToZero
481         */
482
483         if (!fpu.has_flush_to_zero() && !fpu.has_denormals_are_zero()) {
484                 return;
485         }
486
487         MXCSR  = _mm_getcsr();
488
489         switch (Config->get_denormal_model()) {
490         case DenormalNone:
491                 MXCSR &= ~(_MM_FLUSH_ZERO_ON|0x8000);
492                 break;
493
494         case DenormalFTZ:
495                 if (fpu.has_flush_to_zero()) {
496                         MXCSR |= _MM_FLUSH_ZERO_ON;
497                 }
498                 break;
499
500         case DenormalDAZ:
501                 MXCSR &= ~_MM_FLUSH_ZERO_ON;
502                 if (fpu.has_denormals_are_zero()) {
503                         MXCSR |= 0x8000;
504                 }
505                 break;
506
507         case DenormalFTZDAZ:
508                 if (fpu.has_flush_to_zero()) {
509                         if (fpu.has_denormals_are_zero()) {
510                                 MXCSR |= _MM_FLUSH_ZERO_ON | 0x8000;
511                         } else {
512                                 MXCSR |= _MM_FLUSH_ZERO_ON;
513                         }
514                 }
515                 break;
516         }
517
518         _mm_setcsr (MXCSR);
519
520 #endif
521 }
522
523 ARDOUR::OverlapType
524 ARDOUR::coverage (nframes_t sa, nframes_t ea,
525                   nframes_t sb, nframes_t eb)
526 {
527         /* OverlapType returned reflects how the second (B)
528            range overlaps the first (A).
529
530            The diagrams show various relative placements
531            of A and B for each OverlapType.
532
533            Notes:
534               Internal: the start points cannot coincide
535               External: the start and end points can coincide
536               Start: end points can coincide
537               End: start points can coincide
538
539            XXX Logically, Internal should disallow end
540            point equality.
541         */
542
543         /*
544              |--------------------|   A
545                   |------|            B
546                 |-----------------|   B
547
548
549              "B is internal to A"
550
551         */
552 #ifdef OLD_COVERAGE
553         if ((sb >= sa) && (eb <= ea)) {
554 #else
555         if ((sb > sa) && (eb <= ea)) {
556 #endif
557                 return OverlapInternal;
558         }
559
560         /*
561              |--------------------|   A
562            ----|                      B
563            -----------------------|   B
564            --|                        B
565
566              "B overlaps the start of A"
567
568         */
569
570         if ((eb >= sa) && (eb <= ea)) {
571                 return OverlapStart;
572         }
573         /*
574              |---------------------|  A
575                    |----------------- B
576              |----------------------- B
577                                    |- B
578
579             "B overlaps the end of A"
580
581         */
582         if ((sb > sa) && (sb <= ea)) {
583                 return OverlapEnd;
584         }
585         /*
586              |--------------------|     A
587            --------------------------  B
588              |-----------------------  B
589             ----------------------|    B
590              |--------------------|    B
591
592
593            "B overlaps all of A"
594         */
595         if ((sa >= sb) && (sa <= eb) && (ea <= eb)) {
596                 return OverlapExternal;
597         }
598
599         return OverlapNone;
600 }
601