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