libs/ardour/utils.cc

   1 /*
   2     Copyright (C) 2000-2003 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 <stdint.h>
  25
  26 #include <cstdio> /* for sprintf */
  27 #include <cstring>
  28 #include <climits>
  29 #include <cstdlib>
  30 #include <cmath>
  31 #include <cctype>
  32 #include <cstring>
  33 #include <cerrno>
  34 #include <iostream>
  35 #include <sys/types.h>
  36 #include <sys/stat.h>
  37 #include <sys/time.h>
  38 #include <fcntl.h>
  39 #ifndef COMPILER_MSVC
  40 #include <dirent.h>
  41 #endif
  42 #include <errno.h>
  43 #include <regex.h>
  44
  45 #include <glibmm/miscutils.h>
  46 #include <glibmm/fileutils.h>
  47
  48 #include "pbd/cpus.h"
  49 #include "pbd/error.h"
  50 #include "pbd/stacktrace.h"
  51 #include "pbd/xml++.h"
  52 #include "pbd/basename.h"
  53 #include "pbd/strsplit.h"
  54 #include "pbd/replace_all.h"
  55
  56 #include "ardour/utils.h"
  57 #include "ardour/rc_configuration.h"
  58
  59 #include "i18n.h"
  60
  61 using namespace ARDOUR;
  62 using namespace std;
  63 using namespace PBD;
  64
  65 static string
  66 replace_chars (const string& str, const string& illegal_chars)
  67 {
  68         string::size_type pos;
  69         Glib::ustring legal;
  70
  71         /* this is the one place in Ardour where we need to iterate across
  72          * potential multibyte characters, and thus we need Glib::ustring
  73          */
  74
  75         legal = str;
  76         pos = 0;
  77
  78         while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
  79                 legal.replace (pos, 1, "_");
  80                 pos += 1;
  81         }
  82
  83         return string (legal);
  84 }
  85 /** take an arbitrary string as an argument, and return a version of it
  86  * suitable for use as a path (directory/folder name). This is the Ardour 3.X
  87  * and later version of this code. It defines a very small number of characters
  88  * that are not allowed in a path on the build target filesystem (basically,
  89  * POSIX or Windows) and replaces any instances of them with an underscore.
  90  *
  91  * NOTE: this is intended only to legalize for the filesystem that Ardour
  92  * is running on. Export should use legalize_for_universal_path() since
  93  * the goal there is to be legal across filesystems.
  94  */
  95 string
  96 ARDOUR::legalize_for_path (const string& str)
  97 {
  98         return replace_chars (str, "/\\");
  99 }
 100
 101 /** take an arbitrary string as an argument, and return a version of it
 102  * suitable for use as a path (directory/folder name). This is the Ardour 3.X
 103  * and later version of this code. It defines a small number
 104  * of characters that are not allowed in a path on any of our target
 105  * filesystems, and replaces any instances of them with an underscore.
 106  *
 107  * NOTE: this is intended to create paths that should be legal on
 108  * ANY filesystem.
 109  */
 110 string
 111 ARDOUR::legalize_for_universal_path (const string& str)
 112 {
 113         return replace_chars (str, "<>:\"/\\|?*");
 114 }
 115
 116 /** Legalize for a URI path component.  This is like
 117  * legalize_for_universal_path, but stricter, disallowing spaces and hash.
 118  * This avoids %20 escapes in URIs, but probably needs work to be more strictly
 119  * correct.
 120  */
 121 string
 122 ARDOUR::legalize_for_uri (const string& str)
 123 {
 124         return replace_chars (str, "<>:\"/\\|?* #");
 125 }
 126
 127 /** take an arbitrary string as an argument, and return a version of it
 128  * suitable for use as a path (directory/folder name). This is the Ardour 2.X
 129  * version of this code, which used an approach that came to be seen as
 130  * problematic: defining the characters that were allowed and replacing all
 131  * others with underscores. See legalize_for_path() for the 3.X and later
 132  * version.
 133  */
 134
 135 string
 136 ARDOUR::legalize_for_path_2X (const string& str)
 137 {
 138         string::size_type pos;
 139         string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
 140         Glib::ustring legal;
 141
 142         /* this is the one place in Ardour where we need to iterate across
 143          * potential multibyte characters, and thus we need Glib::ustring
 144          */
 145
 146         legal = str;
 147         pos = 0;
 148
 149         while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
 150                 legal.replace (pos, 1, "_");
 151                 pos += 1;
 152         }
 153
 154         return string (legal);
 155 }
 156
 157 string
 158 ARDOUR::bump_name_once (const std::string& name, char delimiter)
 159 {
 160         string::size_type delim;
 161         string newname;
 162
 163         if ((delim = name.find_last_of (delimiter)) == string::npos) {
 164                 newname  = name;
 165                 newname += delimiter;
 166                 newname += "1";
 167         } else {
 168                 int isnumber = 1;
 169                 const char *last_element = name.c_str() + delim + 1;
 170                 for (size_t i = 0; i < strlen(last_element); i++) {
 171                         if (!isdigit(last_element[i])) {
 172                                 isnumber = 0;
 173                                 break;
 174                         }
 175                 }
 176
 177                 errno = 0;
 178                 int32_t version = strtol (name.c_str()+delim+1, (char **)NULL, 10);
 179
 180                 if (isnumber == 0 || errno != 0) {
 181                         // last_element is not a number, or is too large
 182                         newname  = name;
 183                         newname  += delimiter;
 184                         newname += "1";
 185                 } else {
 186                         char buf[32];
 187
 188                         snprintf (buf, sizeof(buf), "%d", version+1);
 189
 190                         newname  = name.substr (0, delim+1);
 191                         newname += buf;
 192                 }
 193         }
 194
 195         return newname;
 196
 197 }
 198
 199 string
 200 ARDOUR::bump_name_number (const std::string& name)
 201 {
 202         size_t pos = name.length();
 203         size_t num = 0;
 204         bool have_number = false;
 205         while (pos > 0 && isdigit(name.at(--pos))) {
 206                 have_number = true;
 207                 num = pos;
 208         }
 209
 210         string newname;
 211         if (have_number) {
 212                 int32_t seq = strtol (name.c_str() + num, (char **)NULL, 10);
 213                 char buf[32];
 214                 snprintf (buf, sizeof(buf), "%d", seq + 1);
 215                 newname = name.substr (0, num);
 216                 newname += buf;
 217         } else {
 218                 newname = name;
 219                 newname += "1";
 220         }
 221
 222         return newname;
 223 }
 224
 225 XMLNode *
 226 ARDOUR::find_named_node (const XMLNode& node, string name)
 227 {
 228         XMLNodeList nlist;
 229         XMLNodeConstIterator niter;
 230         XMLNode* child;
 231
 232         nlist = node.children();
 233
 234         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 235
 236                 child = *niter;
 237
 238                 if (child->name() == name) {
 239                         return child;
 240                 }
 241         }
 242
 243         return 0;
 244 }
 245
 246 int
 247 ARDOUR::cmp_nocase (const string& s, const string& s2)
 248 {
 249         string::const_iterator p = s.begin();
 250         string::const_iterator p2 = s2.begin();
 251
 252         while (p != s.end() && p2 != s2.end()) {
 253                 if (toupper(*p) != toupper(*p2)) {
 254                         return (toupper(*p) < toupper(*p2)) ? -1 : 1;
 255                 }
 256                 ++p;
 257                 ++p2;
 258         }
 259
 260         return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
 261 }
 262
 263 int
 264 ARDOUR::cmp_nocase_utf8 (const string& s1, const string& s2)
 265 {
 266         const char *cstr1 = s1.c_str();
 267         const char *cstr2 = s2.c_str();
 268         gchar *cstr1folded = NULL;
 269         gchar *cstr2folded = NULL;
 270         int retval;
 271
 272         if (!g_utf8_validate (cstr1, -1, NULL) ||
 273                 !g_utf8_validate (cstr2, -1, NULL)) {
 274                 // fall back to comparing ASCII
 275                 return g_ascii_strcasecmp (cstr1, cstr2);
 276         }
 277
 278         cstr1folded = g_utf8_casefold (cstr1, -1);
 279         cstr2folded = g_utf8_casefold (cstr2, -1);
 280
 281         if (cstr1folded && cstr2folded) {
 282                 retval = strcmp (cstr1folded, cstr2folded);
 283         } else {
 284                 // this shouldn't happen, make the best of it
 285                 retval = g_ascii_strcasecmp (cstr1, cstr2);
 286         }
 287
 288         if (cstr1folded) {
 289                 g_free (cstr1folded);
 290         }
 291
 292         if (cstr2folded) {
 293                 g_free (cstr2folded);
 294         }
 295
 296         return retval;
 297 }
 298
 299 string
 300 ARDOUR::region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 301 {
 302         path = PBD::basename_nosuffix (path);
 303
 304         if (strip_channels) {
 305
 306                 /* remove any "?R", "?L" or "?[a-z]" channel identifier */
 307
 308                 string::size_type len = path.length();
 309
 310                 if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 311                     (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 312
 313                         path = path.substr (0, path.length() - 2);
 314                 }
 315         }
 316
 317         if (add_channel_suffix) {
 318
 319                 path += '%';
 320
 321                 if (total > 2) {
 322                         path += (char) ('a' + this_one);
 323                 } else {
 324                         path += (char) (this_one == 0 ? 'L' : 'R');
 325                 }
 326         }
 327
 328         return path;
 329 }
 330
 331 bool
 332 ARDOUR::path_is_paired (string path, string& pair_base)
 333 {
 334         string::size_type pos;
 335
 336         /* remove any leading path */
 337
 338         if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
 339                 path = path.substr(pos+1);
 340         }
 341
 342         /* remove filename suffixes etc. */
 343
 344         if ((pos = path.find_last_of ('.')) != string::npos) {
 345                 path = path.substr (0, pos);
 346         }
 347
 348         string::size_type len = path.length();
 349
 350         /* look for possible channel identifier: "?R", "%R", ".L" etc. */
 351
 352         if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 353             (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 354
 355                 pair_base = path.substr (0, len-2);
 356                 return true;
 357
 358         }
 359
 360         return false;
 361 }
 362
 363 #if __APPLE__
 364 string
 365 ARDOUR::CFStringRefToStdString(CFStringRef stringRef)
 366 {
 367         CFIndex size =
 368                 CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
 369                 kCFStringEncodingUTF8);
 370             char *buf = new char[size];
 371
 372         std::string result;
 373
 374         if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
 375             result = buf;
 376         }
 377         delete [] buf;
 378         return result;
 379 }
 380 #endif // __APPLE__
 381
 382 void
 383 ARDOUR::compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 384 {
 385         double step;
 386
 387         step = 1.0/(nframes-1);
 388
 389         in[0] = 0.0f;
 390
 391         for (framecnt_t i = 1; i < nframes - 1; ++i) {
 392                 in[i] = in[i-1] + step;
 393         }
 394
 395         in[nframes-1] = 1.0;
 396
 397         const float pan_law_attenuation = -3.0f;
 398         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 399
 400         for (framecnt_t n = 0; n < nframes; ++n) {
 401                 float inVal = in[n];
 402                 float outVal = 1 - inVal;
 403                 out[n] = outVal * (scale * outVal + 1.0f - scale);
 404                 in[n] = inVal * (scale * inVal + 1.0f - scale);
 405         }
 406 }
 407
 408 EditMode
 409 ARDOUR::string_to_edit_mode (string str)
 410 {
 411         if (str == _("Splice")) {
 412                 return Splice;
 413         } else if (str == _("Slide")) {
 414                 return Slide;
 415         } else if (str == _("Ripple")) {
 416                 return Ripple;
 417         } else if (str == _("Lock")) {
 418                 return Lock;
 419         }
 420         fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
 421         abort(); /*NOTREACHED*/
 422         return Slide;
 423 }
 424
 425 const char*
 426 ARDOUR::edit_mode_to_string (EditMode mode)
 427 {
 428         switch (mode) {
 429         case Slide:
 430                 return _("Slide");
 431
 432         case Lock:
 433                 return _("Lock");
 434
 435         case Ripple:
 436                 return _("Ripple");
 437
 438         default:
 439         case Splice:
 440                 return _("Splice");
 441         }
 442 }
 443
 444 SyncSource
 445 ARDOUR::string_to_sync_source (string str)
 446 {
 447         if (str == _("MIDI Timecode") || str == _("MTC")) {
 448                 return MTC;
 449         }
 450
 451         if (str == _("MIDI Clock")) {
 452                 return MIDIClock;
 453         }
 454
 455         if (str == _("JACK")) {
 456                 return Engine;
 457         }
 458
 459         if (str == _("LTC")) {
 460                 return LTC;
 461         }
 462
 463         fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
 464         abort(); /*NOTREACHED*/
 465         return Engine;
 466 }
 467
 468 /** @param sh Return a short version of the string */
 469 const char*
 470 ARDOUR::sync_source_to_string (SyncSource src, bool sh)
 471 {
 472         switch (src) {
 473         case Engine:
 474                 /* no other backends offer sync for now ... deal with this if we
 475                  * ever have to.
 476                  */
 477                 return _("JACK");
 478
 479         case MTC:
 480                 if (sh) {
 481                         return _("MTC");
 482                 } else {
 483                         return _("MIDI Timecode");
 484                 }
 485
 486         case MIDIClock:
 487                 if (sh) {
 488                         return _("M-Clock");
 489                 } else {
 490                         return _("MIDI Clock");
 491                 }
 492
 493         case LTC:
 494                 return _("LTC");
 495         }
 496         /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
 497         return _("JACK");
 498 }
 499
 500 float
 501 ARDOUR::meter_falloff_to_float (MeterFalloff falloff)
 502 {
 503         switch (falloff) {
 504         case MeterFalloffOff:
 505                 return METER_FALLOFF_OFF;
 506         case MeterFalloffSlowest:
 507                 return METER_FALLOFF_SLOWEST;
 508         case MeterFalloffSlow:
 509                 return METER_FALLOFF_SLOW;
 510         case MeterFalloffSlowish:
 511                 return METER_FALLOFF_SLOWISH;
 512         case MeterFalloffMedium:
 513                 return METER_FALLOFF_MEDIUM;
 514         case MeterFalloffModerate:
 515                 return METER_FALLOFF_MODERATE;
 516         case MeterFalloffFast:
 517         case MeterFalloffFaster:  // backwards compat enum MeterFalloff
 518         case MeterFalloffFastest:
 519         default:
 520                 return METER_FALLOFF_FAST;
 521         }
 522 }
 523
 524 MeterFalloff
 525 ARDOUR::meter_falloff_from_float (float val)
 526 {
 527         if (val == METER_FALLOFF_OFF) {
 528                 return MeterFalloffOff;
 529         }
 530         else if (val <= METER_FALLOFF_SLOWEST) {
 531                 return MeterFalloffSlowest;
 532         }
 533         else if (val <= METER_FALLOFF_SLOW) {
 534                 return MeterFalloffSlow;
 535         }
 536         else if (val <= METER_FALLOFF_SLOWISH) {
 537                 return MeterFalloffSlowish;
 538         }
 539         else if (val <= METER_FALLOFF_MODERATE) {
 540                 return MeterFalloffModerate;
 541         }
 542         else if (val <= METER_FALLOFF_MEDIUM) {
 543                 return MeterFalloffMedium;
 544         }
 545         else {
 546                 return MeterFalloffFast;
 547         }
 548 }
 549
 550 AutoState
 551 ARDOUR::string_to_auto_state (std::string str)
 552 {
 553         if (str == X_("Off")) {
 554                 return Off;
 555         } else if (str == X_("Play")) {
 556                 return Play;
 557         } else if (str == X_("Write")) {
 558                 return Write;
 559         } else if (str == X_("Touch")) {
 560                 return Touch;
 561         }
 562
 563         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
 564         abort(); /*NOTREACHED*/
 565         return Touch;
 566 }
 567
 568 string
 569 ARDOUR::auto_state_to_string (AutoState as)
 570 {
 571         /* to be used only for XML serialization, no i18n done */
 572
 573         switch (as) {
 574         case Off:
 575                 return X_("Off");
 576                 break;
 577         case Play:
 578                 return X_("Play");
 579                 break;
 580         case Write:
 581                 return X_("Write");
 582                 break;
 583         case Touch:
 584                 return X_("Touch");
 585         }
 586
 587         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
 588         abort(); /*NOTREACHED*/
 589         return "";
 590 }
 591
 592 AutoStyle
 593 ARDOUR::string_to_auto_style (std::string str)
 594 {
 595         if (str == X_("Absolute")) {
 596                 return Absolute;
 597         } else if (str == X_("Trim")) {
 598                 return Trim;
 599         }
 600
 601         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
 602         abort(); /*NOTREACHED*/
 603         return Trim;
 604 }
 605
 606 string
 607 ARDOUR::auto_style_to_string (AutoStyle as)
 608 {
 609         /* to be used only for XML serialization, no i18n done */
 610
 611         switch (as) {
 612         case Absolute:
 613                 return X_("Absolute");
 614                 break;
 615         case Trim:
 616                 return X_("Trim");
 617                 break;
 618         }
 619
 620         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
 621         abort(); /*NOTREACHED*/
 622         return "";
 623 }
 624
 625 std::string
 626 bool_as_string (bool yn)
 627 {
 628         return (yn ? "yes" : "no");
 629 }
 630
 631 const char*
 632 ARDOUR::native_header_format_extension (HeaderFormat hf, const DataType& type)
 633 {
 634         if (type == DataType::MIDI) {
 635                 return ".mid";
 636         }
 637
 638         switch (hf) {
 639         case BWF:
 640                 return ".wav";
 641         case WAVE:
 642                 return ".wav";
 643         case WAVE64:
 644                 return ".w64";
 645         case CAF:
 646                 return ".caf";
 647         case AIFF:
 648                 return ".aif";
 649         case iXML:
 650                 return ".ixml";
 651         case RF64:
 652         case RF64_WAV:
 653         case MBWF:
 654                 return ".rf64";
 655         }
 656
 657         fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
 658         abort(); /*NOTREACHED*/
 659         return ".wav";
 660 }
 661
 662 bool
 663 ARDOUR::matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
 664 {
 665         string bws = basename_nosuffix (path);
 666         struct dirent* dentry;
 667         struct stat statbuf;
 668         DIR* dead;
 669         bool ret = false;
 670
 671         if ((dead = ::opendir (dir.c_str())) == 0) {
 672                 error << string_compose (_("cannot open directory %1 (%2)"), dir, strerror (errno)) << endl;
 673                 return false;
 674         }
 675
 676         while ((dentry = ::readdir (dead)) != 0) {
 677
 678                 /* avoid '.' and '..' */
 679
 680                 if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
 681                     (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
 682                         continue;
 683                 }
 684
 685                 string fullpath = Glib::build_filename (dir, dentry->d_name);
 686
 687                 if (::stat (fullpath.c_str(), &statbuf)) {
 688                         continue;
 689                 }
 690
 691                 if (!S_ISREG (statbuf.st_mode)) {
 692                         continue;
 693                 }
 694
 695                 string bws2 = basename_nosuffix (dentry->d_name);
 696
 697                 if (bws2 == bws) {
 698                         ret = true;
 699                         break;
 700                 }
 701         }
 702
 703         ::closedir (dead);
 704         return ret;
 705 }
 706
 707 uint32_t
 708 ARDOUR::how_many_dsp_threads ()
 709 {
 710         /* CALLER MUST HOLD PROCESS LOCK */
 711
 712         int num_cpu = hardware_concurrency();
 713         int pu = Config->get_processor_usage ();
 714         uint32_t num_threads = max (num_cpu - 1, 2); // default to number of cpus minus one, or 2, whichever is larger
 715
 716         if (pu < 0) {
 717                 /* pu is negative: use "pu" less cores for DSP than appear to be available
 718                  */
 719
 720                 if (-pu < num_cpu) {
 721                         num_threads = num_cpu + pu;
 722                 }
 723
 724         } else if (pu == 0) {
 725
 726                 /* use all available CPUs
 727                  */
 728
 729                 num_threads = num_cpu;
 730
 731         } else {
 732                 /* use "pu" cores, if available
 733                  */
 734
 735                 num_threads = min (num_cpu, pu);
 736         }
 737
 738         return num_threads;
 739 }
 740
 741 double
 742 ARDOUR::gain_to_slider_position_with_max (double g, double max_gain)
 743 {
 744         return gain_to_slider_position (g * 2.0/max_gain);
 745 }
 746
 747 double
 748 ARDOUR::slider_position_to_gain_with_max (double g, double max_gain)
 749 {
 750         return slider_position_to_gain (g * max_gain/2.0);
 751 }
 752
 753 extern "C" {
 754         void c_stacktrace() { stacktrace (cerr); }
 755 }