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 string
  64 legalize_for_path (const string& str)
  65 {
  66         string::size_type pos;
  67         string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
  68         string legal;
  69
  70         legal = str;
  71         pos = 0;
  72
  73         while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
  74                 legal.replace (pos, 1, "_");
  75                 pos += 1;
  76         }
  77
  78         return string (legal);
  79 }
  80
  81 string
  82 bump_name_once (const std::string& name, char delimiter)
  83 {
  84         string::size_type delim;
  85         string newname;
  86
  87         if ((delim = name.find_last_of (delimiter)) == string::npos) {
  88                 newname  = name;
  89                 newname += delimiter;
  90                 newname += "1";
  91         } else {
  92                 int isnumber = 1;
  93                 const char *last_element = name.c_str() + delim + 1;
  94                 for (size_t i = 0; i < strlen(last_element); i++) {
  95                         if (!isdigit(last_element[i])) {
  96                                 isnumber = 0;
  97                                 break;
  98                         }
  99                 }
 100
 101                 errno = 0;
 102                 int32_t version = strtol (name.c_str()+delim+1, (char **)NULL, 10);
 103
 104                 if (isnumber == 0 || errno != 0) {
 105                         // last_element is not a number, or is too large
 106                         newname  = name;
 107                         newname  += delimiter;
 108                         newname += "1";
 109                 } else {
 110                         char buf[32];
 111
 112                         snprintf (buf, sizeof(buf), "%d", version+1);
 113
 114                         newname  = name.substr (0, delim+1);
 115                         newname += buf;
 116                 }
 117         }
 118
 119         return newname;
 120
 121 }
 122
 123 bool
 124 could_be_a_valid_path (const string& path)
 125 {
 126         vector<string> posix_dirs;
 127         vector<string> dos_dirs;
 128         string testpath;
 129
 130         split (path, posix_dirs, '/');
 131         split (path, dos_dirs, '\\');
 132
 133         /* remove the last component of each */
 134
 135         posix_dirs.erase (--posix_dirs.end());
 136         dos_dirs.erase (--dos_dirs.end());
 137
 138         if (G_DIR_SEPARATOR == '/') {
 139                 for (vector<string>::iterator x = posix_dirs.begin(); x != posix_dirs.end(); ++x) {
 140                         testpath = Glib::build_filename (testpath, *x);
 141                         cerr << "Testing " << testpath << endl;
 142                         if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
 143                                 return false;
 144                         }
 145                 }
 146         }
 147
 148         if (G_DIR_SEPARATOR == '\\') {
 149                 testpath = "";
 150                 for (vector<string>::iterator x = dos_dirs.begin(); x != dos_dirs.end(); ++x) {
 151                         testpath = Glib::build_filename (testpath, *x);
 152                         cerr << "Testing " << testpath << endl;
 153                         if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
 154                                 return false;
 155                         }
 156                 }
 157         }
 158
 159         return true;
 160 }
 161
 162
 163 XMLNode *
 164 find_named_node (const XMLNode& node, string name)
 165 {
 166         XMLNodeList nlist;
 167         XMLNodeConstIterator niter;
 168         XMLNode* child;
 169
 170         nlist = node.children();
 171
 172         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 173
 174                 child = *niter;
 175
 176                 if (child->name() == name) {
 177                         return child;
 178                 }
 179         }
 180
 181         return 0;
 182 }
 183
 184 int
 185 cmp_nocase (const string& s, const string& s2)
 186 {
 187         string::const_iterator p = s.begin();
 188         string::const_iterator p2 = s2.begin();
 189
 190         while (p != s.end() && p2 != s2.end()) {
 191                 if (toupper(*p) != toupper(*p2)) {
 192                         return (toupper(*p) < toupper(*p2)) ? -1 : 1;
 193                 }
 194                 ++p;
 195                 ++p2;
 196         }
 197
 198         return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
 199 }
 200
 201 int
 202 touch_file (string path)
 203 {
 204         int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
 205         if (fd >= 0) {
 206                 close (fd);
 207                 return 0;
 208         }
 209         return 1;
 210 }
 211
 212 string
 213 region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 214 {
 215         path = PBD::basename_nosuffix (path);
 216
 217         if (strip_channels) {
 218
 219                 /* remove any "?R", "?L" or "?[a-z]" channel identifier */
 220
 221                 string::size_type len = path.length();
 222
 223                 if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 224                     (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 225
 226                         path = path.substr (0, path.length() - 2);
 227                 }
 228         }
 229
 230         if (add_channel_suffix) {
 231
 232                 path += '%';
 233
 234                 if (total > 2) {
 235                         path += (char) ('a' + this_one);
 236                 } else {
 237                         path += (char) (this_one == 0 ? 'L' : 'R');
 238                 }
 239         }
 240
 241         return path;
 242 }
 243
 244 bool
 245 path_is_paired (string path, string& pair_base)
 246 {
 247         string::size_type pos;
 248
 249         /* remove any leading path */
 250
 251         if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
 252                 path = path.substr(pos+1);
 253         }
 254
 255         /* remove filename suffixes etc. */
 256
 257         if ((pos = path.find_last_of ('.')) != string::npos) {
 258                 path = path.substr (0, pos);
 259         }
 260
 261         string::size_type len = path.length();
 262
 263         /* look for possible channel identifier: "?R", "%R", ".L" etc. */
 264
 265         if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 266             (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 267
 268                 pair_base = path.substr (0, len-2);
 269                 return true;
 270
 271         }
 272
 273         return false;
 274 }
 275
 276 string
 277 path_expand (string path)
 278 {
 279         if (path.empty()) {
 280                 return path;
 281         }
 282
 283         /* tilde expansion */
 284
 285         if (path[0] == '~') {
 286                 if (path.length() == 1) {
 287                         return Glib::get_home_dir();
 288                 }
 289
 290                 if (path[1] == '/') {
 291                         path.replace (0, 1, Glib::get_home_dir());
 292                 } else {
 293                         /* can't handle ~roger, so just leave it */
 294                 }
 295         }
 296
 297         /* now do $VAR substitution, since wordexp isn't reliable */
 298
 299         regex_t compiled_pattern;
 300         const int nmatches = 100;
 301         regmatch_t matches[nmatches];
 302
 303         if (regcomp (&compiled_pattern, "\\$([a-zA-Z_][a-zA-Z0-9_]*|\\{[a-zA-Z_][a-zA-Z0-9_]*\\})", REG_EXTENDED)) {
 304                 cerr << "bad regcomp\n";
 305                 return path;
 306         }
 307
 308         while (true) {
 309
 310                 if (regexec (&compiled_pattern, path.c_str(), nmatches, matches, 0)) {
 311                         break;
 312                 }
 313
 314                 /* matches[0] gives the entire match */
 315
 316                 string match = path.substr (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so);
 317
 318                 /* try to get match from the environment */
 319
 320                 if (match[1] == '{') {
 321                         /* ${FOO} form */
 322                         match = match.substr (2, match.length() - 3);
 323                 }
 324
 325                 char* matched_value = getenv (match.c_str());
 326
 327                 if (matched_value) {
 328                         path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, matched_value);
 329                 } else {
 330                         path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, string());
 331                 }
 332
 333                 /* go back and do it again with whatever remains after the
 334                  * substitution
 335                  */
 336         }
 337
 338         regfree (&compiled_pattern);
 339
 340         /* canonicalize */
 341
 342         char buf[PATH_MAX+1];
 343
 344         if (realpath (path.c_str(), buf)) {
 345                 return buf;
 346         } else {
 347                 return string();
 348         }
 349 }
 350
 351 string
 352 search_path_expand (string path)
 353 {
 354         if (path.empty()) {
 355                 return path;
 356         }
 357
 358         vector<string> s;
 359         vector<string> n;
 360
 361         split (path, s, ':');
 362
 363         for (vector<string>::iterator i = s.begin(); i != s.end(); ++i) {
 364                 string exp = path_expand (*i);
 365                 if (!exp.empty()) {
 366                         n.push_back (exp);
 367                 }
 368         }
 369
 370         string r;
 371
 372         for (vector<string>::iterator i = n.begin(); i != n.end(); ++i) {
 373                 if (!r.empty()) {
 374                         r += ':';
 375                 }
 376                 r += *i;
 377         }
 378
 379         return r;
 380 }
 381
 382 #if __APPLE__
 383 string
 384 CFStringRefToStdString(CFStringRef stringRef)
 385 {
 386         CFIndex size =
 387                 CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
 388                 kCFStringEncodingUTF8);
 389             char *buf = new char[size];
 390
 391         std::string result;
 392
 393         if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
 394             result = buf;
 395         }
 396         delete [] buf;
 397         return result;
 398 }
 399 #endif // __APPLE__
 400
 401 void
 402 compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 403 {
 404         double step;
 405
 406         step = 1.0/(nframes-1);
 407
 408         in[0] = 0.0f;
 409
 410         for (framecnt_t i = 1; i < nframes - 1; ++i) {
 411                 in[i] = in[i-1] + step;
 412         }
 413
 414         in[nframes-1] = 1.0;
 415
 416         const float pan_law_attenuation = -3.0f;
 417         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 418
 419         for (framecnt_t n = 0; n < nframes; ++n) {
 420                 float inVal = in[n];
 421                 float outVal = 1 - inVal;
 422                 out[n] = outVal * (scale * outVal + 1.0f - scale);
 423                 in[n] = inVal * (scale * inVal + 1.0f - scale);
 424         }
 425 }
 426
 427 EditMode
 428 string_to_edit_mode (string str)
 429 {
 430         if (str == _("Splice")) {
 431                 return Splice;
 432         } else if (str == _("Slide")) {
 433                 return Slide;
 434         } else if (str == _("Lock")) {
 435                 return Lock;
 436         }
 437         fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
 438         /*NOTREACHED*/
 439         return Slide;
 440 }
 441
 442 const char*
 443 edit_mode_to_string (EditMode mode)
 444 {
 445         switch (mode) {
 446         case Slide:
 447                 return _("Slide");
 448
 449         case Lock:
 450                 return _("Lock");
 451
 452         default:
 453         case Splice:
 454                 return _("Splice");
 455         }
 456 }
 457
 458 SyncSource
 459 string_to_sync_source (string str)
 460 {
 461         if (str == _("MIDI Timecode") || str == _("MTC")) {
 462                 return MTC;
 463         }
 464
 465         if (str == _("MIDI Clock")) {
 466                 return MIDIClock;
 467         }
 468
 469         if (str == _("JACK")) {
 470                 return JACK;
 471         }
 472
 473         fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
 474         /*NOTREACHED*/
 475         return JACK;
 476 }
 477
 478 /** @param sh Return a short version of the string */
 479 const char*
 480 sync_source_to_string (SyncSource src, bool sh)
 481 {
 482         switch (src) {
 483         case JACK:
 484                 return _("JACK");
 485
 486         case MTC:
 487                 if (sh) {
 488                         return _("MTC");
 489                 } else {
 490                         return _("MIDI Timecode");
 491                 }
 492
 493         case MIDIClock:
 494                 return _("MIDI Clock");
 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 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 MeterFalloffMedium:
 511                 return METER_FALLOFF_MEDIUM;
 512         case MeterFalloffFast:
 513                 return METER_FALLOFF_FAST;
 514         case MeterFalloffFaster:
 515                 return METER_FALLOFF_FASTER;
 516         case MeterFalloffFastest:
 517                 return METER_FALLOFF_FASTEST;
 518         default:
 519                 return METER_FALLOFF_FAST;
 520         }
 521 }
 522
 523 MeterFalloff
 524 meter_falloff_from_float (float val)
 525 {
 526         if (val == METER_FALLOFF_OFF) {
 527                 return MeterFalloffOff;
 528         }
 529         else if (val <= METER_FALLOFF_SLOWEST) {
 530                 return MeterFalloffSlowest;
 531         }
 532         else if (val <= METER_FALLOFF_SLOW) {
 533                 return MeterFalloffSlow;
 534         }
 535         else if (val <= METER_FALLOFF_MEDIUM) {
 536                 return MeterFalloffMedium;
 537         }
 538         else if (val <= METER_FALLOFF_FAST) {
 539                 return MeterFalloffFast;
 540         }
 541         else if (val <= METER_FALLOFF_FASTER) {
 542                 return MeterFalloffFaster;
 543         }
 544         else {
 545                 return MeterFalloffFastest;
 546         }
 547 }
 548
 549 AutoState
 550 ARDOUR::string_to_auto_state (std::string str)
 551 {
 552         if (str == X_("Off")) {
 553                 return Off;
 554         } else if (str == X_("Play")) {
 555                 return Play;
 556         } else if (str == X_("Write")) {
 557                 return Write;
 558         } else if (str == X_("Touch")) {
 559                 return Touch;
 560         }
 561
 562         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
 563         /*NOTREACHED*/
 564         return Touch;
 565 }
 566
 567 string
 568 ARDOUR::auto_state_to_string (AutoState as)
 569 {
 570         /* to be used only for XML serialization, no i18n done */
 571
 572         switch (as) {
 573         case Off:
 574                 return X_("Off");
 575                 break;
 576         case Play:
 577                 return X_("Play");
 578                 break;
 579         case Write:
 580                 return X_("Write");
 581                 break;
 582         case Touch:
 583                 return X_("Touch");
 584         }
 585
 586         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
 587         /*NOTREACHED*/
 588         return "";
 589 }
 590
 591 AutoStyle
 592 ARDOUR::string_to_auto_style (std::string str)
 593 {
 594         if (str == X_("Absolute")) {
 595                 return Absolute;
 596         } else if (str == X_("Trim")) {
 597                 return Trim;
 598         }
 599
 600         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
 601         /*NOTREACHED*/
 602         return Trim;
 603 }
 604
 605 string
 606 ARDOUR::auto_style_to_string (AutoStyle as)
 607 {
 608         /* to be used only for XML serialization, no i18n done */
 609
 610         switch (as) {
 611         case Absolute:
 612                 return X_("Absolute");
 613                 break;
 614         case Trim:
 615                 return X_("Trim");
 616                 break;
 617         }
 618
 619         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
 620         /*NOTREACHED*/
 621         return "";
 622 }
 623
 624 std::string
 625 bool_as_string (bool yn)
 626 {
 627         return (yn ? "yes" : "no");
 628 }
 629
 630 bool
 631 string_is_affirmative (const std::string& str)
 632 {
 633         /* to be used only with XML data - not intended to handle user input */
 634
 635         if (str.empty ()) {
 636                 return false;
 637         }
 638
 639         /* the use of g_strncasecmp() is solely to get around issues with
 640          * charsets posed by trying to use C++ for the same
 641          * comparison. switching a std::string to its lower- or upper-case
 642          * version has several issues, but handled by default
 643          * in the way we desire when doing it in C.
 644          */
 645
 646         return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length())) ||
 647                 (!g_strncasecmp(str.c_str(), "true", str.length()));
 648 }
 649
 650 const char*
 651 native_header_format_extension (HeaderFormat hf, const DataType& type)
 652 {
 653         if (type == DataType::MIDI) {
 654                 return ".mid";
 655         }
 656
 657         switch (hf) {
 658         case BWF:
 659                 return ".wav";
 660         case WAVE:
 661                 return ".wav";
 662         case WAVE64:
 663                 return ".w64";
 664         case CAF:
 665                 return ".caf";
 666         case AIFF:
 667                 return ".aif";
 668         case iXML:
 669                 return ".ixml";
 670         case RF64:
 671                 return ".rf64";
 672         }
 673
 674         fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
 675         /*NOTREACHED*/
 676         return ".wav";
 677 }
 678
 679 bool
 680 matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
 681 {
 682         string bws = basename_nosuffix (path);
 683         struct dirent* dentry;
 684         struct stat statbuf;
 685         DIR* dead;
 686         bool ret = false;
 687
 688         if ((dead = ::opendir (dir.c_str())) == 0) {
 689                 error << string_compose (_("cannot open directory %1 (%2)"), dir, strerror (errno)) << endl;
 690                 return false;
 691         }
 692
 693         while ((dentry = ::readdir (dead)) != 0) {
 694
 695                 /* avoid '.' and '..' */
 696
 697                 if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
 698                     (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
 699                         continue;
 700                 }
 701
 702                 string fullpath = Glib::build_filename (dir, dentry->d_name);
 703
 704                 if (::stat (fullpath.c_str(), &statbuf)) {
 705                         continue;
 706                 }
 707
 708                 if (!S_ISREG (statbuf.st_mode)) {
 709                         continue;
 710                 }
 711
 712                 string bws2 = basename_nosuffix (dentry->d_name);
 713
 714                 if (bws2 == bws) {
 715                         ret = true;
 716                         break;
 717                 }
 718         }
 719
 720         ::closedir (dead);
 721         return ret;
 722 }
 723
 724 uint32_t
 725 how_many_dsp_threads ()
 726 {
 727         /* CALLER MUST HOLD PROCESS LOCK */
 728
 729         int num_cpu = hardware_concurrency();
 730         int pu = Config->get_processor_usage ();
 731         uint32_t num_threads = max (num_cpu - 1, 2); // default to number of cpus minus one, or 2, whichever is larger
 732
 733         if (pu < 0) {
 734                 /* pu is negative: use "pu" less cores for DSP than appear to be available
 735                  */
 736
 737                 if (-pu < num_cpu) {
 738                         num_threads = num_cpu + pu;
 739                 }
 740
 741         } else if (pu == 0) {
 742
 743                 /* use all available CPUs
 744                  */
 745
 746                 num_threads = num_cpu;
 747
 748         } else {
 749                 /* use "pu" cores, if available
 750                  */
 751
 752                 num_threads = min (num_cpu, pu);
 753         }
 754
 755         return num_threads;
 756 }
 757
 758 double gain_to_slider_position_with_max (double g, double max_gain)
 759 {
 760         return gain_to_slider_position (g * 2.0/max_gain);
 761 }
 762
 763 double slider_position_to_gain_with_max (double g, double max_gain)
 764 {
 765         return slider_position_to_gain (g * max_gain/2.0);
 766 }
 767
 768 /** @return true if files a and b have the same inode */
 769 bool
 770 inodes_same (const string& a, const string& b)
 771 {
 772         struct stat bA;
 773         int const rA = stat (a.c_str(), &bA);
 774         struct stat bB;
 775         int const rB = stat (b.c_str(), &bB);
 776
 777         return (rA == 0 && rB == 0 && bA.st_ino == bB.st_ino);
 778 }
 779
 780 extern "C" {
 781         void c_stacktrace() { stacktrace (cerr); }
 782 }