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     $Id: globals.cc 935 2006-09-29 21:39:39Z paul $
  19 */
  20
  21 #include <cstdio> // Needed so that libraptor (included in lrdf) won't complain
  22 #include <sys/stat.h>
  23 #include <sys/types.h>
  24 #include <unistd.h>
  25 #include <fcntl.h>
  26 #include <locale.h>
  27
  28 #ifdef VST_SUPPORT
  29 #include <fst.h>
  30 #endif
  31
  32 #include <lrdf.h>
  33
  34 #include <pbd/error.h>
  35 #include <pbd/id.h>
  36 #include <pbd/strsplit.h>
  37
  38 #include <midi++/port.h>
  39 #include <midi++/port_request.h>
  40 #include <midi++/manager.h>
  41 #include <midi++/mmc.h>
  42
  43 #include <ardour/ardour.h>
  44 #include <ardour/audio_library.h>
  45 #include <ardour/configuration.h>
  46 #include <ardour/plugin_manager.h>
  47 #include <ardour/audiosource.h>
  48 #include <ardour/utils.h>
  49 #include <ardour/session.h>
  50 #include <ardour/control_protocol_manager.h>
  51
  52 #ifdef HAVE_LIBLO
  53 #include <ardour/osc.h>
  54 #endif
  55
  56 #include <ardour/mix.h>
  57
  58 #if defined (__APPLE__)
  59        #include <Carbon/Carbon.h> // For Gestalt
  60 #endif
  61
  62 #include "i18n.h"
  63
  64 ARDOUR::Configuration* ARDOUR::Config = 0;
  65 ARDOUR::AudioLibrary* ARDOUR::Library = 0;
  66
  67 #ifdef HAVE_LIBLO
  68 ARDOUR::OSC* ARDOUR::osc = 0;
  69 #endif
  70
  71 using namespace ARDOUR;
  72 using namespace std;
  73 using namespace PBD;
  74
  75 MIDI::Port *default_mmc_port = 0;
  76 MIDI::Port *default_mtc_port = 0;
  77 MIDI::Port *default_midi_port = 0;
  78
  79 Change ARDOUR::StartChanged = ARDOUR::new_change ();
  80 Change ARDOUR::LengthChanged = ARDOUR::new_change ();
  81 Change ARDOUR::PositionChanged = ARDOUR::new_change ();
  82 Change ARDOUR::NameChanged = ARDOUR::new_change ();
  83 Change ARDOUR::BoundsChanged = Change (0); // see init(), below
  84
  85 #ifdef HAVE_LIBLO
  86 static int
  87 setup_osc ()
  88 {
  89         /* no real cost to creating this object, and it avoids
  90            conditionals anywhere that uses it
  91         */
  92
  93         osc = new OSC (Config->get_osc_port());
  94
  95         if (Config->get_use_osc ()) {
  96                 return osc->start ();
  97         } else {
  98                 return 0;
  99         }
 100 }
 101 #endif
 102
 103 static int
 104 setup_midi ()
 105 {
 106         std::map<string,Configuration::MidiPortDescriptor*>::iterator i;
 107         int nports;
 108
 109         if ((nports = Config->midi_ports.size()) == 0) {
 110                 warning << _("no MIDI ports specified: no MMC or MTC control possible") << endmsg;
 111                 return 0;
 112         }
 113
 114         for (i = Config->midi_ports.begin(); i != Config->midi_ports.end(); ++i) {
 115                 Configuration::MidiPortDescriptor* port_descriptor;
 116
 117                 port_descriptor = (*i).second;
 118
 119                 MIDI::PortRequest request (port_descriptor->device,
 120                                            port_descriptor->tag,
 121                                            port_descriptor->mode,
 122                                            port_descriptor->type);
 123
 124                 if (request.status != MIDI::PortRequest::OK) {
 125                         error << string_compose(_("MIDI port specifications for \"%1\" are not understandable."), port_descriptor->tag) << endmsg;
 126                         continue;
 127                 }
 128
 129                 MIDI::Manager::instance()->add_port (request);
 130
 131                 nports++;
 132         }
 133
 134         if (nports > 1) {
 135
 136                 /* More than one port, so try using specific names for each port */
 137
 138                 map<string,Configuration::MidiPortDescriptor *>::iterator i;
 139
 140                 if (Config->get_mmc_port_name() != N_("default")) {
 141                         default_mmc_port =  MIDI::Manager::instance()->port (Config->get_mmc_port_name());
 142                 }
 143
 144                 if (Config->get_mtc_port_name() != N_("default")) {
 145                         default_mtc_port =  MIDI::Manager::instance()->port (Config->get_mtc_port_name());
 146                 }
 147
 148                 if (Config->get_midi_port_name() != N_("default")) {
 149                         default_midi_port =  MIDI::Manager::instance()->port (Config->get_midi_port_name());
 150                 }
 151
 152                 /* If that didn't work, just use the first listed port */
 153
 154                 if (default_mmc_port == 0) {
 155                         default_mmc_port = MIDI::Manager::instance()->port (0);
 156                 }
 157
 158                 if (default_mtc_port == 0) {
 159                         default_mtc_port = MIDI::Manager::instance()->port (0);
 160                 }
 161
 162                 if (default_midi_port == 0) {
 163                         default_midi_port = MIDI::Manager::instance()->port (0);
 164                 }
 165
 166         } else {
 167
 168                 /* Only one port described, so use it for both MTC and MMC */
 169
 170                 default_mmc_port = MIDI::Manager::instance()->port (0);
 171                 default_mtc_port = default_mmc_port;
 172                 default_midi_port = default_mmc_port;
 173         }
 174
 175         if (default_mmc_port == 0) {
 176                 warning << string_compose (_("No MMC control (MIDI port \"%1\" not available)"), Config->get_mmc_port_name())
 177                         << endmsg;
 178                 return 0;
 179         }
 180
 181         if (default_mtc_port == 0) {
 182                 warning << string_compose (_("No MTC support (MIDI port \"%1\" not available)"), Config->get_mtc_port_name())
 183                         << endmsg;
 184         }
 185
 186         if (default_midi_port == 0) {
 187                 warning << string_compose (_("No MIDI parameter support (MIDI port \"%1\" not available)"), Config->get_midi_port_name())
 188                         << endmsg;
 189         }
 190
 191         return 0;
 192 }
 193
 194 void
 195 setup_hardware_optimization (bool try_optimization)
 196 {
 197         bool generic_mix_functions = true;
 198
 199         if (try_optimization) {
 200
 201 #if defined (ARCH_X86) && defined (BUILD_SSE_OPTIMIZATIONS)
 202
 203                 unsigned int use_sse = 0;
 204
 205 #ifndef USE_X86_64_ASM
 206                 asm volatile (
 207                                  "mov $1, %%eax\n"
 208                                  "pushl %%ebx\n"
 209                                  "cpuid\n"
 210                                  "popl %%ebx\n"
 211                                  "andl $33554432, %%edx\n"
 212                                  "movl %%edx, %0\n"
 213                              : "=m" (use_sse)
 214                              :
 215                          : "%eax", "%ecx", "%edx", "memory");
 216 #else
 217
 218                 asm volatile (
 219                                  "movq $1, %%rax\n"
 220                                  "pushq %%rbx\n"
 221                                  "cpuid\n"
 222                                  "popq %%rbx\n"
 223                                  "andq $33554432, %%rdx\n"
 224                                  "movq %%rdx, %0\n"
 225                              : "=m" (use_sse)
 226                              :
 227                          : "%rax", "%rcx", "%rdx", "memory");
 228
 229 #endif /* USE_X86_64_ASM */
 230
 231                 if (use_sse) {
 232                         info << "Using SSE optimized routines" << endmsg;
 233
 234                         // SSE SET
 235                         Session::compute_peak                   = x86_sse_compute_peak;
 236                         Session::apply_gain_to_buffer   = x86_sse_apply_gain_to_buffer;
 237                         Session::mix_buffers_with_gain  = x86_sse_mix_buffers_with_gain;
 238                         Session::mix_buffers_no_gain    = x86_sse_mix_buffers_no_gain;
 239
 240                         generic_mix_functions = false;
 241
 242                 }
 243
 244 #elif defined (__APPLE__) && defined (BUILD_VECLIB_OPTIMIZATIONS)
 245                 long sysVersion = 0;
 246
 247                 if (noErr != Gestalt(gestaltSystemVersion, &sysVersion))
 248                         sysVersion = 0;
 249
 250                 if (sysVersion >= 0x00001040) { // Tiger at least
 251                         Session::compute_peak           = veclib_compute_peak;
 252                         Session::apply_gain_to_buffer   = veclib_apply_gain_to_buffer;
 253                         Session::mix_buffers_with_gain  = veclib_mix_buffers_with_gain;
 254                         Session::mix_buffers_no_gain    = veclib_mix_buffers_no_gain;
 255
 256                         generic_mix_functions = false;
 257
 258                         info << "Apple VecLib H/W specific optimizations in use" << endmsg;
 259                 }
 260 #endif
 261         }
 262
 263         if (generic_mix_functions) {
 264
 265                 Session::compute_peak                   = compute_peak;
 266                 Session::apply_gain_to_buffer   = apply_gain_to_buffer;
 267                 Session::mix_buffers_with_gain  = mix_buffers_with_gain;
 268                 Session::mix_buffers_no_gain    = mix_buffers_no_gain;
 269
 270                 info << "No H/W specific optimizations in use" << endmsg;
 271         }
 272 }
 273
 274 int
 275 ARDOUR::init (bool use_vst, bool try_optimization)
 276 {
 277         extern void setup_enum_writer ();
 278
 279         (void) bindtextdomain(PACKAGE, LOCALEDIR);
 280
 281         PBD::ID::init ();
 282
 283         setup_enum_writer ();
 284
 285         lrdf_init();
 286         Library = new AudioLibrary;
 287
 288         Config = new Configuration;
 289
 290         if (Config->load_state ()) {
 291                 return -1;
 292         }
 293
 294         Config->set_use_vst (use_vst);
 295
 296         if (setup_midi ()) {
 297                 return -1;
 298         }
 299
 300 #ifdef HAVE_LIBLO
 301         if (setup_osc ()) {
 302                 return -1;
 303         }
 304 #endif
 305
 306 #ifdef VST_SUPPORT
 307         if (Config->get_use_vst() && fst_init ()) {
 308                 return -1;
 309         }
 310 #endif
 311
 312         setup_hardware_optimization (try_optimization);
 313
 314         /* singleton - first object is "it" */
 315         new PluginManager ();
 316
 317         /* singleton - first object is "it" */
 318         new ControlProtocolManager ();
 319         ControlProtocolManager::instance().discover_control_protocols (Session::control_protocol_path());
 320
 321         XMLNode* node;
 322         if ((node = Config->control_protocol_state()) != 0) {
 323                 ControlProtocolManager::instance().set_state (*node);
 324         }
 325
 326         BoundsChanged = Change (StartChanged|PositionChanged|LengthChanged);
 327
 328         return 0;
 329 }
 330
 331 int
 332 ARDOUR::cleanup ()
 333 {
 334         delete Library;
 335         lrdf_cleanup ();
 336         delete &ControlProtocolManager::instance();
 337         return 0;
 338 }
 339
 340
 341 microseconds_t
 342 ARDOUR::get_microseconds ()
 343 {
 344         /* XXX need JACK to export its functionality */
 345
 346         struct timeval now;
 347         gettimeofday (&now, 0);
 348         return now.tv_sec * 1000000ULL + now.tv_usec;
 349 }
 350
 351 ARDOUR::Change
 352 ARDOUR::new_change ()
 353 {
 354         Change c;
 355         static uint32_t change_bit = 1;
 356
 357         /* catch out-of-range */
 358         if (!change_bit)
 359         {
 360                 fatal << _("programming error: ")
 361                         << "change_bit out of range in ARDOUR::new_change()"
 362                         << endmsg;
 363                 /*NOTREACHED*/
 364         }
 365
 366         c = Change (change_bit);
 367         change_bit <<= 1;       // if it shifts too far, change_bit == 0
 368
 369         return c;
 370 }
 371
 372 string
 373 ARDOUR::get_ardour_revision ()
 374 {
 375         return "$Rev$";
 376 }
 377
 378 string
 379 ARDOUR::get_user_ardour_path ()
 380 {
 381         string path;
 382         char* envvar;
 383
 384         if ((envvar = getenv ("HOME")) == 0 || strlen (envvar) == 0) {
 385                 return "/";
 386         }
 387
 388         path = envvar;
 389         path += "/.ardour2/";
 390
 391         /* create it if necessary */
 392
 393         if (g_mkdir_with_parents (path.c_str (), 0755)) {
 394                 throw exception ();
 395         }
 396
 397         return path;
 398 }
 399
 400 string
 401 ARDOUR::get_system_data_path ()
 402 {
 403         string path;
 404
 405         char *envvar;
 406
 407         if ((envvar = getenv ("ARDOUR_DATA_PATH")) != 0) {
 408                 path = envvar;
 409         } else {
 410                 path += DATA_DIR;
 411                 path += "/ardour2/";
 412         }
 413
 414         return path;
 415 }
 416
 417 string
 418 ARDOUR::get_system_module_path ()
 419 {
 420         string path;
 421         char *envvar;
 422
 423         if ((envvar = getenv ("ARDOUR_MODULE_PATH")) != 0) {
 424                 path = envvar;
 425         } else {
 426                 path += MODULE_DIR;
 427                 path += "/ardour2/";
 428         }
 429
 430         return path;
 431 }
 432
 433 static string
 434 find_file (string name, string dir, string subdir = "")
 435 {
 436         string path;
 437         char* envvar = getenv("ARDOUR_PATH");
 438
 439         /* 1st attempt: any directory in ARDOUR_PATH */
 440
 441         if (envvar != 0) {
 442
 443                 vector<string> split_path;
 444
 445                 split (envvar, split_path, ':');
 446
 447                 for (vector<string>::iterator i = split_path.begin(); i != split_path.end(); ++i) {
 448                         path = *i;
 449                         path += "/" + name;
 450                         if (access (path.c_str(), R_OK) == 0) {
 451                                 // cerr << "Using file " << path << " found in ARDOUR_PATH." << endl;
 452                                 return path;
 453                         }
 454                 }
 455         }
 456
 457         /* 2nd attempt: ~/.ardour/ */
 458
 459         path = get_user_ardour_path();
 460
 461         if (subdir.length()) {
 462                 path += subdir + "/";
 463         }
 464
 465         path += name;
 466         if (access (path.c_str(), R_OK) == 0) {
 467                 return path;
 468         }
 469
 470         /* 3rd attempt: dir/... */
 471
 472         path = dir;
 473         path += "/ardour2/";
 474
 475         if (subdir.length()) {
 476                 path += subdir + "/";
 477         }
 478
 479         path += name;
 480
 481         if (access (path.c_str(), R_OK) == 0) {
 482                 return path;
 483         }
 484
 485         return "";
 486 }
 487
 488 string
 489 ARDOUR::find_config_file (string name)
 490 {
 491         char* envvar;
 492
 493         if ((envvar = getenv("ARDOUR_CONFIG_PATH")) == 0) {
 494                 envvar = CONFIG_DIR;
 495         }
 496
 497         return find_file (name, envvar);
 498 }
 499
 500 string
 501 ARDOUR::find_data_file (string name, string subdir)
 502 {
 503         char* envvar;
 504         if ((envvar = getenv("ARDOUR_DATA_PATH")) == 0) {
 505                 envvar = DATA_DIR;
 506         }
 507
 508         return find_file (name, envvar, subdir);
 509 }
 510
 511 ARDOUR::LocaleGuard::LocaleGuard (const char* str)
 512 {
 513         old = strdup (setlocale (LC_NUMERIC, NULL));
 514         if (strcmp (old, str)) {
 515                 setlocale (LC_NUMERIC, str);
 516         }
 517 }
 518
 519 ARDOUR::LocaleGuard::~LocaleGuard ()
 520 {
 521         setlocale (LC_NUMERIC, old);
 522         free ((char*)old);
 523 }
 524
 525 ARDOUR::OverlapType
 526 ARDOUR::coverage (nframes_t sa, nframes_t ea,
 527                   nframes_t sb, nframes_t eb)
 528 {
 529         /* OverlapType returned reflects how the second (B)
 530            range overlaps the first (A).
 531
 532            The diagrams show various relative placements
 533            of A and B for each OverlapType.
 534
 535            Notes:
 536               Internal: the start points cannot coincide
 537               External: the start and end points can coincide
 538               Start: end points can coincide
 539               End: start points can coincide
 540
 541            XXX Logically, Internal should disallow end
 542            point equality.
 543         */
 544
 545         /*
 546              |--------------------|   A
 547                   |------|            B
 548                 |-----------------|   B
 549
 550
 551              "B is internal to A"
 552
 553         */
 554 #ifdef OLD_COVERAGE
 555         if ((sb >= sa) && (eb <= ea)) {
 556 #else
 557         if ((sb > sa) && (eb <= ea)) {
 558 #endif
 559                 return OverlapInternal;
 560         }
 561
 562         /*
 563              |--------------------|   A
 564            ----|                      B
 565            -----------------------|   B
 566            --|                        B
 567
 568              "B overlaps the start of A"
 569
 570         */
 571
 572         if ((eb >= sa) && (eb <= ea)) {
 573                 return OverlapStart;
 574         }
 575         /*
 576              |---------------------|  A
 577                    |----------------- B
 578              |----------------------- B
 579                                    |- B
 580
 581             "B overlaps the end of A"
 582
 583         */
 584         if ((sb >= sa) && (sb <= ea)) {
 585                 return OverlapEnd;
 586         }
 587         /*
 588              |--------------------|     A
 589            --------------------------  B
 590              |-----------------------  B
 591             ----------------------|    B
 592              |--------------------|    B
 593
 594
 595            "B overlaps all of A"
 596         */
 597         if ((sa >= sb) && (sa <= eb) && (ea <= eb)) {
 598                 return OverlapExternal;
 599         }
 600
 601         return OverlapNone;
 602 }
 603
 604 /* not sure where to put these */
 605
 606 template<class T>
 607 std::istream& int_to_type (std::istream& o, T& hf) {
 608         int val;
 609         o >> val;
 610         hf = (T) val;
 611         return o;
 612 }
 613
 614 std::istream& operator>>(std::istream& o, HeaderFormat& var) { return int_to_type<HeaderFormat> (o, var); }
 615 std::istream& operator>>(std::istream& o, SampleFormat& var) { return int_to_type<SampleFormat> (o, var); }
 616 std::istream& operator>>(std::istream& o, AutoConnectOption& var) { return int_to_type<AutoConnectOption> (o, var); }
 617 std::istream& operator>>(std::istream& o, MonitorModel& var) { return int_to_type<MonitorModel> (o, var); }
 618 std::istream& operator>>(std::istream& o, EditMode& var) { return int_to_type<EditMode> (o, var); }
 619 std::istream& operator>>(std::istream& o, SoloModel& var) { return int_to_type<SoloModel> (o, var); }
 620 std::istream& operator>>(std::istream& o, LayerModel& var) { return int_to_type<LayerModel> (o, var); }
 621 std::istream& operator>>(std::istream& o, CrossfadeModel& var) { return int_to_type<CrossfadeModel> (o, var); }
 622 std::istream& operator>>(std::istream& o, SlaveSource& var) { return int_to_type<SlaveSource> (o, var); }
 623 std::istream& operator>>(std::istream& o, ShuttleBehaviour& var) { return int_to_type<ShuttleBehaviour> (o, var); }
 624 std::istream& operator>>(std::istream& o, ShuttleUnits& var) { return int_to_type<ShuttleUnits> (o, var); }
 625