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                 error << string_compose (_("programming error: realpath(%1) failed, errcode %2"), path, errno) << endmsg;
 348                 return path;
 349         }
 350 }
 351
 352 #if __APPLE__
 353 string
 354 CFStringRefToStdString(CFStringRef stringRef)
 355 {
 356         CFIndex size =
 357                 CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
 358                 kCFStringEncodingUTF8);
 359             char *buf = new char[size];
 360
 361         std::string result;
 362
 363         if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
 364             result = buf;
 365         }
 366         delete [] buf;
 367         return result;
 368 }
 369 #endif // __APPLE__
 370
 371 void
 372 compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 373 {
 374         double step;
 375
 376         step = 1.0/(nframes-1);
 377
 378         in[0] = 0.0f;
 379
 380         for (framecnt_t i = 1; i < nframes - 1; ++i) {
 381                 in[i] = in[i-1] + step;
 382         }
 383
 384         in[nframes-1] = 1.0;
 385
 386         const float pan_law_attenuation = -3.0f;
 387         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 388
 389         for (framecnt_t n = 0; n < nframes; ++n) {
 390                 float inVal = in[n];
 391                 float outVal = 1 - inVal;
 392                 out[n] = outVal * (scale * outVal + 1.0f - scale);
 393                 in[n] = inVal * (scale * inVal + 1.0f - scale);
 394         }
 395 }
 396
 397 EditMode
 398 string_to_edit_mode (string str)
 399 {
 400         if (str == _("Splice")) {
 401                 return Splice;
 402         } else if (str == _("Slide")) {
 403                 return Slide;
 404         } else if (str == _("Lock")) {
 405                 return Lock;
 406         }
 407         fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
 408         /*NOTREACHED*/
 409         return Slide;
 410 }
 411
 412 const char*
 413 edit_mode_to_string (EditMode mode)
 414 {
 415         switch (mode) {
 416         case Slide:
 417                 return _("Slide");
 418
 419         case Lock:
 420                 return _("Lock");
 421
 422         default:
 423         case Splice:
 424                 return _("Splice");
 425         }
 426 }
 427
 428 SyncSource
 429 string_to_sync_source (string str)
 430 {
 431         if (str == _("MIDI Timecode") || str == _("MTC")) {
 432                 return MTC;
 433         }
 434
 435         if (str == _("MIDI Clock")) {
 436                 return MIDIClock;
 437         }
 438
 439         if (str == _("JACK")) {
 440                 return JACK;
 441         }
 442
 443         fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
 444         /*NOTREACHED*/
 445         return JACK;
 446 }
 447
 448 /** @param sh Return a short version of the string */
 449 const char*
 450 sync_source_to_string (SyncSource src, bool sh)
 451 {
 452         switch (src) {
 453         case JACK:
 454                 return _("JACK");
 455
 456         case MTC:
 457                 if (sh) {
 458                         return _("MTC");
 459                 } else {
 460                         return _("MIDI Timecode");
 461                 }
 462
 463         case MIDIClock:
 464                 return _("MIDI Clock");
 465         }
 466         /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
 467         return _("JACK");
 468 }
 469
 470 float
 471 meter_falloff_to_float (MeterFalloff falloff)
 472 {
 473         switch (falloff) {
 474         case MeterFalloffOff:
 475                 return METER_FALLOFF_OFF;
 476         case MeterFalloffSlowest:
 477                 return METER_FALLOFF_SLOWEST;
 478         case MeterFalloffSlow:
 479                 return METER_FALLOFF_SLOW;
 480         case MeterFalloffMedium:
 481                 return METER_FALLOFF_MEDIUM;
 482         case MeterFalloffFast:
 483                 return METER_FALLOFF_FAST;
 484         case MeterFalloffFaster:
 485                 return METER_FALLOFF_FASTER;
 486         case MeterFalloffFastest:
 487                 return METER_FALLOFF_FASTEST;
 488         default:
 489                 return METER_FALLOFF_FAST;
 490         }
 491 }
 492
 493 MeterFalloff
 494 meter_falloff_from_float (float val)
 495 {
 496         if (val == METER_FALLOFF_OFF) {
 497                 return MeterFalloffOff;
 498         }
 499         else if (val <= METER_FALLOFF_SLOWEST) {
 500                 return MeterFalloffSlowest;
 501         }
 502         else if (val <= METER_FALLOFF_SLOW) {
 503                 return MeterFalloffSlow;
 504         }
 505         else if (val <= METER_FALLOFF_MEDIUM) {
 506                 return MeterFalloffMedium;
 507         }
 508         else if (val <= METER_FALLOFF_FAST) {
 509                 return MeterFalloffFast;
 510         }
 511         else if (val <= METER_FALLOFF_FASTER) {
 512                 return MeterFalloffFaster;
 513         }
 514         else {
 515                 return MeterFalloffFastest;
 516         }
 517 }
 518
 519 AutoState
 520 ARDOUR::string_to_auto_state (std::string str)
 521 {
 522         if (str == X_("Off")) {
 523                 return Off;
 524         } else if (str == X_("Play")) {
 525                 return Play;
 526         } else if (str == X_("Write")) {
 527                 return Write;
 528         } else if (str == X_("Touch")) {
 529                 return Touch;
 530         }
 531
 532         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
 533         /*NOTREACHED*/
 534         return Touch;
 535 }
 536
 537 string
 538 ARDOUR::auto_state_to_string (AutoState as)
 539 {
 540         /* to be used only for XML serialization, no i18n done */
 541
 542         switch (as) {
 543         case Off:
 544                 return X_("Off");
 545                 break;
 546         case Play:
 547                 return X_("Play");
 548                 break;
 549         case Write:
 550                 return X_("Write");
 551                 break;
 552         case Touch:
 553                 return X_("Touch");
 554         }
 555
 556         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
 557         /*NOTREACHED*/
 558         return "";
 559 }
 560
 561 AutoStyle
 562 ARDOUR::string_to_auto_style (std::string str)
 563 {
 564         if (str == X_("Absolute")) {
 565                 return Absolute;
 566         } else if (str == X_("Trim")) {
 567                 return Trim;
 568         }
 569
 570         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
 571         /*NOTREACHED*/
 572         return Trim;
 573 }
 574
 575 string
 576 ARDOUR::auto_style_to_string (AutoStyle as)
 577 {
 578         /* to be used only for XML serialization, no i18n done */
 579
 580         switch (as) {
 581         case Absolute:
 582                 return X_("Absolute");
 583                 break;
 584         case Trim:
 585                 return X_("Trim");
 586                 break;
 587         }
 588
 589         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
 590         /*NOTREACHED*/
 591         return "";
 592 }
 593
 594 std::string
 595 bool_as_string (bool yn)
 596 {
 597         return (yn ? "yes" : "no");
 598 }
 599
 600 bool
 601 string_is_affirmative (const std::string& str)
 602 {
 603         /* to be used only with XML data - not intended to handle user input */
 604
 605         if (str.empty ()) {
 606                 return false;
 607         }
 608
 609         /* the use of g_strncasecmp() is solely to get around issues with
 610          * charsets posed by trying to use C++ for the same
 611          * comparison. switching a std::string to its lower- or upper-case
 612          * version has several issues, but handled by default
 613          * in the way we desire when doing it in C.
 614          */
 615
 616         return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length()));
 617 }
 618
 619 const char*
 620 native_header_format_extension (HeaderFormat hf, const DataType& type)
 621 {
 622         if (type == DataType::MIDI) {
 623                 return ".mid";
 624         }
 625
 626         switch (hf) {
 627         case BWF:
 628                 return ".wav";
 629         case WAVE:
 630                 return ".wav";
 631         case WAVE64:
 632                 return ".w64";
 633         case CAF:
 634                 return ".caf";
 635         case AIFF:
 636                 return ".aif";
 637         case iXML:
 638                 return ".ixml";
 639         case RF64:
 640                 return ".rf64";
 641         }
 642
 643         fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
 644         /*NOTREACHED*/
 645         return ".wav";
 646 }
 647
 648 bool
 649 matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
 650 {
 651         string bws = basename_nosuffix (path);
 652         struct dirent* dentry;
 653         struct stat statbuf;
 654         DIR* dead;
 655         bool ret = false;
 656
 657         if ((dead = ::opendir (dir.c_str())) == 0) {
 658                 error << string_compose (_("cannot open directory %1 (%2)"), dir, strerror (errno)) << endl;
 659                 return false;
 660         }
 661
 662         while ((dentry = ::readdir (dead)) != 0) {
 663
 664                 /* avoid '.' and '..' */
 665
 666                 if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
 667                     (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
 668                         continue;
 669                 }
 670
 671                 string fullpath = Glib::build_filename (dir, dentry->d_name);
 672
 673                 if (::stat (fullpath.c_str(), &statbuf)) {
 674                         continue;
 675                 }
 676
 677                 if (!S_ISREG (statbuf.st_mode)) {
 678                         continue;
 679                 }
 680
 681                 string bws2 = basename_nosuffix (dentry->d_name);
 682
 683                 if (bws2 == bws) {
 684                         ret = true;
 685                         break;
 686                 }
 687         }
 688
 689         ::closedir (dead);
 690         return ret;
 691 }
 692
 693 uint32_t
 694 how_many_dsp_threads ()
 695 {
 696         /* CALLER MUST HOLD PROCESS LOCK */
 697
 698         int num_cpu = hardware_concurrency();
 699         int pu = Config->get_processor_usage ();
 700         uint32_t num_threads = max (num_cpu - 1, 2); // default to number of cpus minus one, or 2, whichever is larger
 701
 702         if (pu < 0) {
 703                 /* pu is negative: use "pu" less cores for DSP than appear to be available
 704                  */
 705
 706                 if (-pu < num_cpu) {
 707                         num_threads = num_cpu + pu;
 708                 }
 709
 710         } else if (pu == 0) {
 711
 712                 /* use all available CPUs
 713                  */
 714
 715                 num_threads = num_cpu;
 716
 717         } else {
 718                 /* use "pu" cores, if available
 719                  */
 720
 721                 num_threads = min (num_cpu, pu);
 722         }
 723
 724         return num_threads;
 725 }
 726
 727 double gain_to_slider_position_with_max (double g, double max_gain)
 728 {
 729         return gain_to_slider_position (g * 2.0/max_gain);
 730 }
 731
 732 double slider_position_to_gain_with_max (double g, double max_gain)
 733 {
 734         return slider_position_to_gain (g * max_gain/2.0);
 735 }
 736
 737 extern "C" {
 738         void c_stacktrace() { stacktrace (cerr); }
 739 }