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