forward port 2.X changes up to and including rev 6909
[ardour.git] / libs / ardour / utils.cc
index 9adc7c72cd39f2cac11afc9f38634516570dec60..a7d5b960f82c2beb31fe05d7fca3a2ab8022ac1e 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2003 Paul Davis 
+    Copyright (C) 2000-2003 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
+#define __STDC_FORMAT_MACROS 1
+#include <stdint.h>
+
 #include <cstdio> /* for sprintf */
+#include <cstring>
 #include <cmath>
 #include <cctype>
-#include <string>
+#include <cstring>
 #include <cerrno>
 #include <iostream>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <sys/time.h>
 #include <fcntl.h>
-#include <unistd.h>
+#include <dirent.h>
+#include <errno.h>
+
+#include <glibmm/miscutils.h>
 
 #ifdef HAVE_WORDEXP
 #include <wordexp.h>
 #endif
 
-#include <pbd/error.h>
-#include <pbd/xml++.h>
-#include <ardour/utils.h>
+#include "pbd/error.h"
+#include "pbd/stacktrace.h"
+#include "pbd/xml++.h"
+#include "pbd/basename.h"
+#include "ardour/utils.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
+using Glib::ustring;
 
-void
-elapsed_time_to_str (char *buf, uint32_t seconds)
-
-{
-       uint32_t days;
-       uint32_t hours;
-       uint32_t minutes;
-       uint32_t s;
-
-       s = seconds;
-       days = s / (3600 * 24);
-       s -= (days * 3600 * 24);
-       hours = s / 3600;
-       s -= (hours * 3600);
-       minutes = s / 60;
-       s -= minutes * 60;
-       
-       if (days) {
-               snprintf (buf, sizeof (buf), "%" PRIu32 " day%s %" PRIu32 " hour%s", 
-                        days, 
-                        days > 1 ? "s" : "",
-                        hours,
-                        hours > 1 ? "s" : "");
-       } else if (hours) {
-               snprintf (buf, sizeof (buf), "%" PRIu32 " hour%s %" PRIu32 " minute%s", 
-                        hours, 
-                        hours > 1 ? "s" : "",
-                        minutes,
-                        minutes > 1 ? "s" : "");
-       } else if (minutes) {
-               snprintf (buf, sizeof (buf), "%" PRIu32 " minute%s", 
-                        minutes,
-                        minutes > 1 ? "s" : "");
-       } else if (s) {
-               snprintf (buf, sizeof (buf), "%" PRIu32 " second%s", 
-                        seconds,
-                        seconds > 1 ? "s" : "");
-       } else {
-               snprintf (buf, sizeof (buf), "no time");
-       }
-}
-
-string 
-legalize_for_path (string str)
+ustring
+legalize_for_path (ustring str)
 {
-       string::size_type pos;
-       string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
-       string legal;
+       ustring::size_type pos;
+       ustring legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
+       ustring legal;
 
        legal = str;
        pos = 0;
@@ -104,11 +75,46 @@ legalize_for_path (string str)
        return legal;
 }
 
-ostream&
-operator<< (ostream& o, const BBT_Time& bbt)
+string 
+bump_name_once (const std::string& name, char delimiter)
 {
-       o << bbt.bars << '|' << bbt.beats << '|' << bbt.ticks;
-       return o;
+       string::size_type delim;
+       string newname;
+
+       if ((delim = name.find_last_of (delimiter)) == string::npos) {
+               newname  = name;
+               newname += delimiter;
+               newname += "1";
+       } else {
+               int isnumber = 1;
+               const char *last_element = name.c_str() + delim + 1;
+               for (size_t i = 0; i < strlen(last_element); i++) {
+                       if (!isdigit(last_element[i])) {
+                               isnumber = 0;
+                               break;
+                       }
+               }
+
+               errno = 0;
+               int32_t version = strtol (name.c_str()+delim+1, (char **)NULL, 10);
+
+               if (isnumber == 0 || errno != 0) {
+                       // last_element is not a number, or is too large
+                       newname  = name;
+                       newname  += delimiter;
+                       newname += "1";
+               } else {
+                       char buf[32];
+
+                       snprintf (buf, sizeof(buf), "%d", version+1);
+
+                       newname  = name.substr (0, delim+1);
+                       newname += buf;
+               }
+       }
+
+       return newname;
+
 }
 
 XMLNode *
@@ -137,7 +143,7 @@ cmp_nocase (const string& s, const string& s2)
 {
        string::const_iterator p = s.begin();
        string::const_iterator p2 = s2.begin();
-       
+
        while (p != s.end() && p2 != s2.end()) {
                if (toupper(*p) != toupper(*p2)) {
                        return (toupper(*p) < toupper(*p2)) ? -1 : 1;
@@ -145,38 +151,12 @@ cmp_nocase (const string& s, const string& s2)
                ++p;
                ++p2;
        }
-       
-       return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
-}
 
-int
-tokenize_fullpath (string fullpath, string& path, string& name)
-{
-       string::size_type m = fullpath.find_last_of("/");
-       
-       if (m == string::npos) {
-               path = fullpath;
-               name = fullpath;
-               return 1;
-       }
-
-       // does it look like just a directory?
-       if (m == fullpath.length()-1) {
-               return -1;
-       }
-       path = fullpath.substr(0, m+1);
-       
-       string::size_type n = fullpath.find(".ardour", m);
-       // no .ardour?
-       if (n == string::npos) {
-               return -1;
-       }
-       name = fullpath.substr(m+1, n - m - 1);
-       return 1;
+       return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
 }
 
 int
-touch_file (string path)
+touch_file (ustring path)
 {
        int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
        if (fd >= 0) {
@@ -186,53 +166,72 @@ touch_file (string path)
        return 1;
 }
 
-uint32_t long
-get_uid()
+ustring
+region_name_from_path (ustring path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 {
-       struct timeval tv;
-       gettimeofday(&tv, 0);
+       path = PBD::basename_nosuffix (path);
 
-       return (uint32_t long) tv.tv_sec * 1000000 + tv.tv_usec;
-}
+       if (strip_channels) {
 
-string
-placement_as_string (Placement p)
-{
-       switch (p) {
-       case PreFader:
-               return _("pre");
-       default: /* to get g++ to realize we have all the cases covered */
-       case PostFader:
-               return _("post");
+               /* remove any "?R", "?L" or "?[a-z]" channel identifier */
+
+               ustring::size_type len = path.length();
+
+               if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
+                   (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
+
+                       path = path.substr (0, path.length() - 2);
+               }
+       }
+
+       if (add_channel_suffix) {
+
+               path += '%';
+
+               if (total > 2) {
+                       path += (char) ('a' + this_one);
+               } else {
+                       path += (char) (this_one == 0 ? 'L' : 'R');
+               }
        }
+
+       return path;
 }
 
-string
-region_name_from_path (string path)
+bool
+path_is_paired (ustring path, ustring& pair_base)
 {
-       string::size_type pos;
+       ustring::size_type pos;
+
+       /* remove any leading path */
+
+       if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
+               path = path.substr(pos+1);
+       }
+
+       /* remove filename suffixes etc. */
 
-       /* remove filename suffixes etc. */
-       
        if ((pos = path.find_last_of ('.')) != string::npos) {
                path = path.substr (0, pos);
        }
 
-       /* remove any "?R", "?L" or "?[a-z]" channel identifier */
-       
-       string::size_type len = path.length();
-       
-       if (len > 3 && (path[len-2] == '%' || path[len-2] == '?') && 
+       ustring::size_type len = path.length();
+
+       /* look for possible channel identifier: "?R", "%R", ".L" etc. */
+
+       if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
            (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
-               
-               path = path.substr (0, path.length() - 2);
+
+               pair_base = path.substr (0, len-2);
+               return true;
+
        }
 
-       return path;
-}      
+       return false;
+}
 
-string
-path_expand (string path)
+ustring
+path_expand (ustring path)
 {
 #ifdef HAVE_WORDEXP
        /* Handle tilde and environment variable expansion in session path */
@@ -257,8 +256,336 @@ path_expand (string path)
        wordfree (&expansion);
        return ret;
 
-#else 
+#else
        return path;
 #endif
 }
 
+#if defined(HAVE_COREAUDIO) || defined(HAVE_AUDIOUNITS)
+string
+CFStringRefToStdString(CFStringRef stringRef)
+{
+       CFIndex size =
+               CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
+               kCFStringEncodingUTF8);
+           char *buf = new char[size];
+
+       std::string result;
+
+       if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
+           result = buf;
+       }
+       delete [] buf;
+       return result;
+}
+#endif // HAVE_COREAUDIO
+
+void
+compute_equal_power_fades (nframes_t nframes, float* in, float* out)
+{
+       double step;
+
+       step = 1.0/(nframes-1);
+
+       in[0] = 0.0f;
+
+       for (nframes_t i = 1; i < nframes - 1; ++i) {
+               in[i] = in[i-1] + step;
+       }
+
+       in[nframes-1] = 1.0;
+
+       const float pan_law_attenuation = -3.0f;
+       const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
+
+       for (nframes_t n = 0; n < nframes; ++n) {
+               float inVal = in[n];
+               float outVal = 1 - inVal;
+               out[n] = outVal * (scale * outVal + 1.0f - scale);
+               in[n] = inVal * (scale * inVal + 1.0f - scale);
+       }
+}
+
+EditMode
+string_to_edit_mode (string str)
+{
+       if (str == _("Splice")) {
+               return Splice;
+       } else if (str == _("Slide")) {
+               return Slide;
+       } else if (str == _("Lock")) {
+               return Lock;
+       }
+       fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
+       /*NOTREACHED*/
+       return Slide;
+}
+
+const char*
+edit_mode_to_string (EditMode mode)
+{
+       switch (mode) {
+       case Slide:
+               return _("Slide");
+
+       case Lock:
+               return _("Lock");
+
+       default:
+       case Splice:
+               return _("Splice");
+       }
+}
+
+SyncSource
+string_to_sync_source (string str)
+{
+       if (str == _("MIDI Timecode")) {
+               return MTC;
+       }
+
+       if (str == _("MIDI Clock")) {
+               return MIDIClock;
+       }
+
+       if (str == _("JACK")) {
+               return JACK;
+       }
+
+       fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
+       /*NOTREACHED*/
+       return JACK;
+}
+
+const char*
+sync_source_to_string (SyncSource src)
+{
+       switch (src) {
+       case JACK:
+               return _("JACK");
+
+       case MTC:
+               return _("MIDI Timecode");
+
+       case MIDIClock:
+               return _("MIDI Clock");
+       }
+       /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
+       return _("JACK");
+}
+
+float
+meter_falloff_to_float (MeterFalloff falloff)
+{
+       switch (falloff) {
+       case MeterFalloffOff:
+               return METER_FALLOFF_OFF;
+       case MeterFalloffSlowest:
+               return METER_FALLOFF_SLOWEST;
+       case MeterFalloffSlow:
+               return METER_FALLOFF_SLOW;
+       case MeterFalloffMedium:
+               return METER_FALLOFF_MEDIUM;
+       case MeterFalloffFast:
+               return METER_FALLOFF_FAST;
+       case MeterFalloffFaster:
+               return METER_FALLOFF_FASTER;
+       case MeterFalloffFastest:
+               return METER_FALLOFF_FASTEST;
+       default:
+               return METER_FALLOFF_FAST;
+       }
+}
+
+MeterFalloff
+meter_falloff_from_float (float val)
+{
+       if (val == METER_FALLOFF_OFF) {
+               return MeterFalloffOff;
+       }
+       else if (val <= METER_FALLOFF_SLOWEST) {
+               return MeterFalloffSlowest;
+       }
+       else if (val <= METER_FALLOFF_SLOW) {
+               return MeterFalloffSlow;
+       }
+       else if (val <= METER_FALLOFF_MEDIUM) {
+               return MeterFalloffMedium;
+       }
+       else if (val <= METER_FALLOFF_FAST) {
+               return MeterFalloffFast;
+       }
+       else if (val <= METER_FALLOFF_FASTER) {
+               return MeterFalloffFaster;
+       }
+       else {
+               return MeterFalloffFastest;
+       }
+}
+
+AutoState
+ARDOUR::string_to_auto_state (std::string str)
+{
+       if (str == X_("Off")) {
+               return Off;
+       } else if (str == X_("Play")) {
+               return Play;
+       } else if (str == X_("Write")) {
+               return Write;
+       } else if (str == X_("Touch")) {
+               return Touch;
+       }
+
+       fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
+       /*NOTREACHED*/
+       return Touch;
+}
+
+string
+ARDOUR::auto_state_to_string (AutoState as)
+{
+       /* to be used only for XML serialization, no i18n done */
+
+       switch (as) {
+       case Off:
+               return X_("Off");
+               break;
+       case Play:
+               return X_("Play");
+               break;
+       case Write:
+               return X_("Write");
+               break;
+       case Touch:
+               return X_("Touch");
+       }
+
+       fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
+       /*NOTREACHED*/
+       return "";
+}
+
+AutoStyle
+ARDOUR::string_to_auto_style (std::string str)
+{
+       if (str == X_("Absolute")) {
+               return Absolute;
+       } else if (str == X_("Trim")) {
+               return Trim;
+       }
+
+       fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
+       /*NOTREACHED*/
+       return Trim;
+}
+
+string
+ARDOUR::auto_style_to_string (AutoStyle as)
+{
+       /* to be used only for XML serialization, no i18n done */
+
+       switch (as) {
+       case Absolute:
+               return X_("Absolute");
+               break;
+       case Trim:
+               return X_("Trim");
+               break;
+       }
+
+       fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
+       /*NOTREACHED*/
+       return "";
+}
+
+std::string
+bool_as_string (bool yn)
+{
+       return (yn ? "yes" : "no");
+}
+
+bool
+string_is_affirmative (const std::string& str)
+{
+       /* to be used only with XML data - not intended to handle user input */
+
+       return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length()));
+}
+
+const char*
+native_header_format_extension (HeaderFormat hf, const DataType& type)
+{
+        if (type == DataType::MIDI) {
+                return ".mid";
+        }
+        
+        switch (hf) {
+        case BWF:
+                return ".wav";
+        case WAVE:
+                return ".wav";
+        case WAVE64:
+                return ".w64";
+        case CAF:
+                return ".caf";
+        case AIFF:
+                return ".aif";
+        case iXML:
+                return ".ixml";
+        case RF64:
+                return ".rf64";
+        }
+
+        fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
+        /*NOTREACHED*/
+        return ".wav";
+}
+
+bool
+matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
+{
+        string bws = basename_nosuffix (path);
+       struct dirent* dentry;
+       struct stat statbuf;
+       DIR* dead;
+        bool ret = false;
+
+        if ((dead = ::opendir (dir.c_str())) == 0) {
+                error << string_compose (_("cannot open directory %1 (%2)"), dir, strerror (errno)) << endl;
+                return false;
+        }
+        
+        while ((dentry = ::readdir (dead)) != 0) {
+                
+                /* avoid '.' and '..' */
+                
+                if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
+                    (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
+                        continue;
+                }
+        
+                string fullpath = Glib::build_filename (dir, dentry->d_name);
+
+                if (::stat (fullpath.c_str(), &statbuf)) {
+                        continue;
+                }
+                
+                if (!S_ISREG (statbuf.st_mode)) {
+                        continue;
+                }
+
+                string bws2 = basename_nosuffix (dentry->d_name);
+                
+                if (bws2 == bws) {
+                        ret = true;
+                        break;
+                }
+        }
+
+        ::closedir (dead);
+        return ret;
+}
+
+extern "C" {
+       void c_stacktrace() { stacktrace (cerr); }
+}