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 int
 195 ARDOUR::init (bool use_vst, bool try_optimization)
 196 {
 197         bool generic_mix_functions = true;
 198
 199         (void) bindtextdomain(PACKAGE, LOCALEDIR);
 200
 201         PBD::ID::init ();
 202
 203         lrdf_init();
 204         Library = new AudioLibrary;
 205
 206         Config = new Configuration;
 207
 208         if (Config->load_state ()) {
 209                 return -1;
 210         }
 211
 212         Config->set_use_vst (use_vst);
 213
 214         if (setup_midi ()) {
 215                 return -1;
 216         }
 217
 218 #ifdef HAVE_LIBLO
 219         if (setup_osc ()) {
 220                 return -1;
 221         }
 222 #endif
 223
 224 #ifdef VST_SUPPORT
 225         if (Config->get_use_vst() && fst_init ()) {
 226                 return -1;
 227         }
 228 #endif
 229
 230         if (try_optimization) {
 231
 232 #if defined (ARCH_X86) && defined (BUILD_SSE_OPTIMIZATIONS)
 233
 234                 unsigned int use_sse = 0;
 235
 236 #ifndef USE_X86_64_ASM
 237                 asm volatile (
 238                                  "mov $1, %%eax\n"
 239                                  "pushl %%ebx\n"
 240                                  "cpuid\n"
 241                                  "popl %%ebx\n"
 242                                  "andl $33554432, %%edx\n"
 243                                  "movl %%edx, %0\n"
 244                              : "=m" (use_sse)
 245                              :
 246                          : "%eax", "%ecx", "%edx", "memory");
 247 #else
 248
 249                 asm volatile (
 250                                  "movq $1, %%rax\n"
 251                                  "pushq %%rbx\n"
 252                                  "cpuid\n"
 253                                  "popq %%rbx\n"
 254                                  "andq $33554432, %%rdx\n"
 255                                  "movq %%rdx, %0\n"
 256                              : "=m" (use_sse)
 257                              :
 258                          : "%rax", "%rcx", "%rdx", "memory");
 259
 260 #endif /* USE_X86_64_ASM */
 261
 262                 if (use_sse) {
 263                         cerr << "Enabling SSE optimized routines" << endl;
 264
 265                         // SSE SET
 266                         Session::compute_peak                   = x86_sse_compute_peak;
 267                         Session::apply_gain_to_buffer   = x86_sse_apply_gain_to_buffer;
 268                         Session::mix_buffers_with_gain  = x86_sse_mix_buffers_with_gain;
 269                         Session::mix_buffers_no_gain    = x86_sse_mix_buffers_no_gain;
 270
 271                         generic_mix_functions = false;
 272
 273                 }
 274
 275 #elif defined (__APPLE__) && defined (BUILD_VECLIB_OPTIMIZATIONS)
 276                 long sysVersion = 0;
 277
 278                 if (noErr != Gestalt(gestaltSystemVersion, &sysVersion))
 279                         sysVersion = 0;
 280
 281                 if (sysVersion >= 0x00001040) { // Tiger at least
 282                         Session::compute_peak           = veclib_compute_peak;
 283                         Session::apply_gain_to_buffer   = veclib_apply_gain_to_buffer;
 284                         Session::mix_buffers_with_gain  = veclib_mix_buffers_with_gain;
 285                         Session::mix_buffers_no_gain    = veclib_mix_buffers_no_gain;
 286
 287                         generic_mix_functions = false;
 288
 289                         info << "Apple VecLib H/W specific optimizations in use" << endmsg;
 290                 }
 291 #endif
 292         }
 293
 294         if (generic_mix_functions) {
 295
 296                 Session::compute_peak                   = compute_peak;
 297                 Session::apply_gain_to_buffer   = apply_gain_to_buffer;
 298                 Session::mix_buffers_with_gain  = mix_buffers_with_gain;
 299                 Session::mix_buffers_no_gain    = mix_buffers_no_gain;
 300
 301                 info << "No H/W specific optimizations in use" << endmsg;
 302         }
 303
 304         /* singleton - first object is "it" */
 305         new PluginManager ();
 306
 307         /* singleton - first object is "it" */
 308         new ControlProtocolManager ();
 309         ControlProtocolManager::instance().discover_control_protocols (Session::control_protocol_path());
 310
 311         XMLNode* node;
 312         if ((node = Config->control_protocol_state()) != 0) {
 313                 ControlProtocolManager::instance().set_state (*node);
 314         }
 315
 316         BoundsChanged = Change (StartChanged|PositionChanged|LengthChanged);
 317
 318         return 0;
 319 }
 320
 321 int
 322 ARDOUR::cleanup ()
 323 {
 324         delete Library;
 325         lrdf_cleanup ();
 326         delete &ControlProtocolManager::instance();
 327         return 0;
 328 }
 329
 330
 331 microseconds_t
 332 ARDOUR::get_microseconds ()
 333 {
 334         /* XXX need JACK to export its functionality */
 335
 336         struct timeval now;
 337         gettimeofday (&now, 0);
 338         return now.tv_sec * 1000000ULL + now.tv_usec;
 339 }
 340
 341 ARDOUR::Change
 342 ARDOUR::new_change ()
 343 {
 344         Change c;
 345         static uint32_t change_bit = 1;
 346
 347         /* catch out-of-range */
 348         if (!change_bit)
 349         {
 350                 fatal << _("programming error: ")
 351                         << "change_bit out of range in ARDOUR::new_change()"
 352                         << endmsg;
 353                 /*NOTREACHED*/
 354         }
 355
 356         c = Change (change_bit);
 357         change_bit <<= 1;       // if it shifts too far, change_bit == 0
 358
 359         return c;
 360 }
 361
 362 string
 363 ARDOUR::get_ardour_revision ()
 364 {
 365         return "$Rev$";
 366 }
 367
 368 string
 369 ARDOUR::get_user_ardour_path ()
 370 {
 371         string path;
 372         char* envvar;
 373
 374         if ((envvar = getenv ("HOME")) == 0 || strlen (envvar) == 0) {
 375                 return "/";
 376         }
 377
 378         path = envvar;
 379         path += "/.ardour2/";
 380
 381         /* create it if necessary */
 382
 383         if (g_mkdir_with_parents (path.c_str (), 0755)) {
 384                 throw exception ();
 385         }
 386
 387         return path;
 388 }
 389
 390 string
 391 ARDOUR::get_system_data_path ()
 392 {
 393         string path;
 394
 395         path += DATA_DIR;
 396         path += "/ardour2/";
 397
 398         return path;
 399 }
 400
 401 string
 402 ARDOUR::get_system_module_path ()
 403 {
 404         string path;
 405
 406         path += MODULE_DIR;
 407         path += "/ardour2/";
 408
 409         return path;
 410 }
 411
 412 static string
 413 find_file (string name, string dir, string subdir = "")
 414 {
 415         string path;
 416         char* envvar = getenv("ARDOUR_PATH");
 417
 418         /* 1st attempt: any directory in ARDOUR_PATH */
 419
 420         if (envvar != 0) {
 421
 422                 vector<string> split_path;
 423
 424                 split (envvar, split_path, ':');
 425
 426                 for (vector<string>::iterator i = split_path.begin(); i != split_path.end(); ++i) {
 427                         path = *i;
 428                         path += "/" + name;
 429                         if (access (path.c_str(), R_OK) == 0) {
 430                                 // cerr << "Using file " << path << " found in ARDOUR_PATH." << endl;
 431                                 return path;
 432                         }
 433                 }
 434         }
 435
 436         /* 2nd attempt: ~/.ardour/ */
 437
 438         path = get_user_ardour_path();
 439
 440         if (subdir.length()) {
 441                 path += subdir + "/";
 442         }
 443
 444         path += name;
 445         if (access (path.c_str(), R_OK) == 0) {
 446                 return path;
 447         }
 448
 449         /* 3rd attempt: dir/... */
 450
 451         path = dir;
 452         path += "/ardour2/";
 453
 454         if (subdir.length()) {
 455                 path += subdir + "/";
 456         }
 457
 458         path += name;
 459
 460         if (access (path.c_str(), R_OK) == 0) {
 461                 return path;
 462         }
 463
 464         return "";
 465 }
 466
 467 string
 468 ARDOUR::find_config_file (string name)
 469 {
 470         char* envvar;
 471
 472         if ((envvar = getenv("ARDOUR_CONFIG_PATH")) == 0) {
 473                 envvar = CONFIG_DIR;
 474         }
 475
 476         return find_file (name, envvar);
 477 }
 478
 479 string
 480 ARDOUR::find_data_file (string name, string subdir)
 481 {
 482         char* envvar;
 483         if ((envvar = getenv("ARDOUR_DATA_PATH")) == 0) {
 484                 envvar = DATA_DIR;
 485         }
 486
 487         return find_file (name, envvar, subdir);
 488 }
 489
 490 ARDOUR::LocaleGuard::LocaleGuard (const char* str)
 491 {
 492         old = strdup (setlocale (LC_NUMERIC, NULL));
 493         if (strcmp (old, str)) {
 494                 setlocale (LC_NUMERIC, str);
 495         }
 496 }
 497
 498 ARDOUR::LocaleGuard::~LocaleGuard ()
 499 {
 500         setlocale (LC_NUMERIC, old);
 501         free ((char*)old);
 502 }
 503
 504 ARDOUR::OverlapType
 505 ARDOUR::coverage (nframes_t sa, nframes_t ea,
 506                   nframes_t sb, nframes_t eb)
 507 {
 508         /* OverlapType returned reflects how the second (B)
 509            range overlaps the first (A).
 510
 511            The diagrams show various relative placements
 512            of A and B for each OverlapType.
 513
 514            Notes:
 515               Internal: the start points cannot coincide
 516               External: the start and end points can coincide
 517               Start: end points can coincide
 518               End: start points can coincide
 519
 520            XXX Logically, Internal should disallow end
 521            point equality.
 522         */
 523
 524         /*
 525              |--------------------|   A
 526                   |------|            B
 527                 |-----------------|   B
 528
 529
 530              "B is internal to A"
 531
 532         */
 533 #ifdef OLD_COVERAGE
 534         if ((sb >= sa) && (eb <= ea)) {
 535 #else
 536         if ((sb > sa) && (eb <= ea)) {
 537 #endif
 538                 return OverlapInternal;
 539         }
 540
 541         /*
 542              |--------------------|   A
 543            ----|                      B
 544            -----------------------|   B
 545            --|                        B
 546
 547              "B overlaps the start of A"
 548
 549         */
 550
 551         if ((eb >= sa) && (eb <= ea)) {
 552                 return OverlapStart;
 553         }
 554         /*
 555              |---------------------|  A
 556                    |----------------- B
 557              |----------------------- B
 558                                    |- B
 559
 560             "B overlaps the end of A"
 561
 562         */
 563         if ((sb >= sa) && (sb <= ea)) {
 564                 return OverlapEnd;
 565         }
 566         /*
 567              |--------------------|     A
 568            --------------------------  B
 569              |-----------------------  B
 570             ----------------------|    B
 571              |--------------------|    B
 572
 573
 574            "B overlaps all of A"
 575         */
 576         if ((sa >= sb) && (sa <= eb) && (ea <= eb)) {
 577                 return OverlapExternal;
 578         }
 579
 580         return OverlapNone;
 581 }
 582
 583 /* not sure where to put these */
 584
 585 template<class T>
 586 std::istream& int_to_type (std::istream& o, T& hf) {
 587         int val;
 588         o >> val;
 589         hf = (T) val;
 590         return o;
 591 }
 592
 593 std::istream& operator>>(std::istream& o, HeaderFormat& var) { return int_to_type<HeaderFormat> (o, var); }
 594 std::istream& operator>>(std::istream& o, SampleFormat& var) { return int_to_type<SampleFormat> (o, var); }
 595 std::istream& operator>>(std::istream& o, AutoConnectOption& var) { return int_to_type<AutoConnectOption> (o, var); }
 596 std::istream& operator>>(std::istream& o, MonitorModel& var) { return int_to_type<MonitorModel> (o, var); }
 597 std::istream& operator>>(std::istream& o, EditMode& var) { return int_to_type<EditMode> (o, var); }
 598 std::istream& operator>>(std::istream& o, SoloModel& var) { return int_to_type<SoloModel> (o, var); }
 599 std::istream& operator>>(std::istream& o, LayerModel& var) { return int_to_type<LayerModel> (o, var); }
 600 std::istream& operator>>(std::istream& o, CrossfadeModel& var) { return int_to_type<CrossfadeModel> (o, var); }
 601 std::istream& operator>>(std::istream& o, SlaveSource& var) { return int_to_type<SlaveSource> (o, var); }
 602 std::istream& operator>>(std::istream& o, ShuttleBehaviour& var) { return int_to_type<ShuttleBehaviour> (o, var); }
 603 std::istream& operator>>(std::istream& o, ShuttleUnits& var) { return int_to_type<ShuttleUnits> (o, var); }
 604