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 #define __STDC_FORMAT_MACROS 1
  25 #include <stdint.h>
  26
  27 #include <cstdio> /* for sprintf */
  28 #include <cstring>
  29 #include <cmath>
  30 #include <cctype>
  31 #include <cstring>
  32 #include <cerrno>
  33 #include <iostream>
  34 #include <sys/types.h>
  35 #include <sys/stat.h>
  36 #include <sys/time.h>
  37 #include <fcntl.h>
  38 #include <unistd.h>
  39
  40 #ifdef HAVE_WORDEXP
  41 #include <wordexp.h>
  42 #endif
  43
  44 #include "pbd/error.h"
  45 #include "pbd/stacktrace.h"
  46 #include "pbd/xml++.h"
  47 #include "pbd/basename.h"
  48 #include "ardour/utils.h"
  49
  50 #include "i18n.h"
  51
  52 using namespace ARDOUR;
  53 using namespace std;
  54 using namespace PBD;
  55 using Glib::ustring;
  56
  57 ustring
  58 legalize_for_path (ustring str)
  59 {
  60         ustring::size_type pos;
  61         ustring legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
  62         ustring legal;
  63
  64         legal = str;
  65         pos = 0;
  66
  67         while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
  68                 legal.replace (pos, 1, "_");
  69                 pos += 1;
  70         }
  71
  72         return legal;
  73 }
  74
  75 string
  76 bump_name_once (const std::string& name, char delimiter)
  77 {
  78         string::size_type delim;
  79         string newname;
  80
  81         if ((delim = name.find_last_of (delimiter)) == string::npos) {
  82                 newname  = name;
  83                 newname += delimiter;
  84                 newname += "1";
  85         } else {
  86                 int isnumber = 1;
  87                 const char *last_element = name.c_str() + delim + 1;
  88                 for (size_t i = 0; i < strlen(last_element); i++) {
  89                         if (!isdigit(last_element[i])) {
  90                                 isnumber = 0;
  91                                 break;
  92                         }
  93                 }
  94
  95                 errno = 0;
  96                 long int version = strtol (name.c_str()+delim+1, (char **)NULL, 10);
  97
  98                 if (isnumber == 0 || errno != 0) {
  99                         // last_element is not a number, or is too large
 100                         newname  = name;
 101                         newname  += delimiter;
 102                         newname += "1";
 103                 } else {
 104                         char buf[32];
 105
 106                         snprintf (buf, sizeof(buf), "%ld", version+1);
 107
 108                         newname  = name.substr (0, delim+1);
 109                         newname += buf;
 110                 }
 111         }
 112
 113         return newname;
 114
 115 }
 116
 117 XMLNode *
 118 find_named_node (const XMLNode& node, string name)
 119 {
 120         XMLNodeList nlist;
 121         XMLNodeConstIterator niter;
 122         XMLNode* child;
 123
 124         nlist = node.children();
 125
 126         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 127
 128                 child = *niter;
 129
 130                 if (child->name() == name) {
 131                         return child;
 132                 }
 133         }
 134
 135         return 0;
 136 }
 137
 138 int
 139 cmp_nocase (const string& s, const string& s2)
 140 {
 141         string::const_iterator p = s.begin();
 142         string::const_iterator p2 = s2.begin();
 143
 144         while (p != s.end() && p2 != s2.end()) {
 145                 if (toupper(*p) != toupper(*p2)) {
 146                         return (toupper(*p) < toupper(*p2)) ? -1 : 1;
 147                 }
 148                 ++p;
 149                 ++p2;
 150         }
 151
 152         return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
 153 }
 154
 155 int
 156 touch_file (ustring path)
 157 {
 158         int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
 159         if (fd >= 0) {
 160                 close (fd);
 161                 return 0;
 162         }
 163         return 1;
 164 }
 165
 166 ustring
 167 region_name_from_path (ustring path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 168 {
 169         path = PBD::basename_nosuffix (path);
 170
 171         if (strip_channels) {
 172
 173                 /* remove any "?R", "?L" or "?[a-z]" channel identifier */
 174
 175                 ustring::size_type len = path.length();
 176
 177                 if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 178                     (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 179
 180                         path = path.substr (0, path.length() - 2);
 181                 }
 182         }
 183
 184         if (add_channel_suffix) {
 185
 186                 path += '%';
 187
 188                 if (total > 2) {
 189                         path += (char) ('a' + this_one);
 190                 } else {
 191                         path += (char) (this_one == 0 ? 'L' : 'R');
 192                 }
 193         }
 194
 195         return path;
 196 }
 197
 198 bool
 199 path_is_paired (ustring path, ustring& pair_base)
 200 {
 201         ustring::size_type pos;
 202
 203         /* remove any leading path */
 204
 205         if ((pos = path.find_last_of ('/')) != string::npos) {
 206                 path = path.substr(pos+1);
 207         }
 208
 209         /* remove filename suffixes etc. */
 210
 211         if ((pos = path.find_last_of ('.')) != string::npos) {
 212                 path = path.substr (0, pos);
 213         }
 214
 215         ustring::size_type len = path.length();
 216
 217         /* look for possible channel identifier: "?R", "%R", ".L" etc. */
 218
 219         if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
 220             (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
 221
 222                 pair_base = path.substr (0, len-2);
 223                 return true;
 224
 225         }
 226
 227         return false;
 228 }
 229
 230 ustring
 231 path_expand (ustring path)
 232 {
 233 #ifdef HAVE_WORDEXP
 234         /* Handle tilde and environment variable expansion in session path */
 235         string ret = path;
 236
 237         wordexp_t expansion;
 238         switch (wordexp (path.c_str(), &expansion, WRDE_NOCMD|WRDE_UNDEF)) {
 239         case 0:
 240                 break;
 241         default:
 242                 error << string_compose (_("illegal or badly-formed string used for path (%1)"), path) << endmsg;
 243                 goto out;
 244         }
 245
 246         if (expansion.we_wordc > 1) {
 247                 error << string_compose (_("path (%1) is ambiguous"), path) << endmsg;
 248                 goto out;
 249         }
 250
 251         ret = expansion.we_wordv[0];
 252   out:
 253         wordfree (&expansion);
 254         return ret;
 255
 256 #else
 257         return path;
 258 #endif
 259 }
 260
 261 #if defined(HAVE_COREAUDIO) || defined(HAVE_AUDIOUNITS)
 262 string
 263 CFStringRefToStdString(CFStringRef stringRef)
 264 {
 265         CFIndex size =
 266                 CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
 267                 kCFStringEncodingUTF8);
 268             char *buf = new char[size];
 269
 270         std::string result;
 271
 272         if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
 273             result = buf;
 274         }
 275         delete [] buf;
 276         return result;
 277 }
 278 #endif // HAVE_COREAUDIO
 279
 280 void
 281 compute_equal_power_fades (nframes_t nframes, float* in, float* out)
 282 {
 283         double step;
 284
 285         step = 1.0/(nframes-1);
 286
 287         in[0] = 0.0f;
 288
 289         for (nframes_t i = 1; i < nframes - 1; ++i) {
 290                 in[i] = in[i-1] + step;
 291         }
 292
 293         in[nframes-1] = 1.0;
 294
 295         const float pan_law_attenuation = -3.0f;
 296         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 297
 298         for (nframes_t n = 0; n < nframes; ++n) {
 299                 float inVal = in[n];
 300                 float outVal = 1 - inVal;
 301                 out[n] = outVal * (scale * outVal + 1.0f - scale);
 302                 in[n] = inVal * (scale * inVal + 1.0f - scale);
 303         }
 304 }
 305
 306 EditMode
 307 string_to_edit_mode (string str)
 308 {
 309         if (str == _("Splice Edit")) {
 310                 return Splice;
 311         } else if (str == _("Slide Edit")) {
 312                 return Slide;
 313         } else if (str == _("Lock Edit")) {
 314                 return Lock;
 315         }
 316         fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
 317         /*NOTREACHED*/
 318         return Slide;
 319 }
 320
 321 const char*
 322 edit_mode_to_string (EditMode mode)
 323 {
 324         switch (mode) {
 325         case Slide:
 326                 return _("Slide Edit");
 327
 328         case Lock:
 329                 return _("Lock Edit");
 330
 331         default:
 332         case Splice:
 333                 return _("Splice Edit");
 334         }
 335 }
 336
 337 SyncSource
 338 string_to_sync_source (string str)
 339 {
 340         if (str == _("MIDI Timecode")) {
 341                 return MTC;
 342         }
 343
 344         if (str == _("MIDI Clock")) {
 345                 return MIDIClock;
 346         }
 347
 348         if (str == _("JACK")) {
 349                 return JACK;
 350         }
 351
 352         fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
 353         /*NOTREACHED*/
 354         return JACK;
 355 }
 356
 357 const char*
 358 sync_source_to_string (SyncSource src)
 359 {
 360         switch (src) {
 361         case JACK:
 362                 return _("JACK");
 363
 364         case MTC:
 365                 return _("MIDI Timecode");
 366
 367         case MIDIClock:
 368                 return _("MIDI Clock");
 369         }
 370         /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
 371         return _("JACK");
 372 }
 373
 374 float
 375 meter_falloff_to_float (MeterFalloff falloff)
 376 {
 377         switch (falloff) {
 378         case MeterFalloffOff:
 379                 return METER_FALLOFF_OFF;
 380         case MeterFalloffSlowest:
 381                 return METER_FALLOFF_SLOWEST;
 382         case MeterFalloffSlow:
 383                 return METER_FALLOFF_SLOW;
 384         case MeterFalloffMedium:
 385                 return METER_FALLOFF_MEDIUM;
 386         case MeterFalloffFast:
 387                 return METER_FALLOFF_FAST;
 388         case MeterFalloffFaster:
 389                 return METER_FALLOFF_FASTER;
 390         case MeterFalloffFastest:
 391                 return METER_FALLOFF_FASTEST;
 392         default:
 393                 return METER_FALLOFF_FAST;
 394         }
 395 }
 396
 397 MeterFalloff
 398 meter_falloff_from_float (float val)
 399 {
 400         if (val == METER_FALLOFF_OFF) {
 401                 return MeterFalloffOff;
 402         }
 403         else if (val <= METER_FALLOFF_SLOWEST) {
 404                 return MeterFalloffSlowest;
 405         }
 406         else if (val <= METER_FALLOFF_SLOW) {
 407                 return MeterFalloffSlow;
 408         }
 409         else if (val <= METER_FALLOFF_MEDIUM) {
 410                 return MeterFalloffMedium;
 411         }
 412         else if (val <= METER_FALLOFF_FAST) {
 413                 return MeterFalloffFast;
 414         }
 415         else if (val <= METER_FALLOFF_FASTER) {
 416                 return MeterFalloffFaster;
 417         }
 418         else {
 419                 return MeterFalloffFastest;
 420         }
 421 }
 422
 423 AutoState
 424 ARDOUR::string_to_auto_state (std::string str)
 425 {
 426         if (str == X_("Off")) {
 427                 return Off;
 428         } else if (str == X_("Play")) {
 429                 return Play;
 430         } else if (str == X_("Write")) {
 431                 return Write;
 432         } else if (str == X_("Touch")) {
 433                 return Touch;
 434         }
 435
 436         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
 437         /*NOTREACHED*/
 438         return Touch;
 439 }
 440
 441 string
 442 ARDOUR::auto_state_to_string (AutoState as)
 443 {
 444         /* to be used only for XML serialization, no i18n done */
 445
 446         switch (as) {
 447         case Off:
 448                 return X_("Off");
 449                 break;
 450         case Play:
 451                 return X_("Play");
 452                 break;
 453         case Write:
 454                 return X_("Write");
 455                 break;
 456         case Touch:
 457                 return X_("Touch");
 458         }
 459
 460         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
 461         /*NOTREACHED*/
 462         return "";
 463 }
 464
 465 AutoStyle
 466 ARDOUR::string_to_auto_style (std::string str)
 467 {
 468         if (str == X_("Absolute")) {
 469                 return Absolute;
 470         } else if (str == X_("Trim")) {
 471                 return Trim;
 472         }
 473
 474         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
 475         /*NOTREACHED*/
 476         return Trim;
 477 }
 478
 479 string
 480 ARDOUR::auto_style_to_string (AutoStyle as)
 481 {
 482         /* to be used only for XML serialization, no i18n done */
 483
 484         switch (as) {
 485         case Absolute:
 486                 return X_("Absolute");
 487                 break;
 488         case Trim:
 489                 return X_("Trim");
 490                 break;
 491         }
 492
 493         fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
 494         /*NOTREACHED*/
 495         return "";
 496 }
 497
 498 std::string
 499 bool_as_string (bool yn)
 500 {
 501         return (yn ? "yes" : "no");
 502 }
 503
 504 bool
 505 string_is_affirmative (const std::string& str)
 506 {
 507         /* to be used only with XML data - not intended to handle user input */
 508
 509         return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length()));
 510 }
 511
 512 extern "C" {
 513         void c_stacktrace() { stacktrace (cerr); }
 514 }