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