a better fix for CUE/TOC string escaping: if the text is not Latin-1 already, reject...
[ardour.git] / libs / ardour / utils.cc
index 6f8586648d6063548baae92e337151108050d51d..1c52a6f6384e49141186c2a5369f01b6ec12fb78 100644 (file)
 #include "libardour-config.h"
 #endif
 
-#define __STDC_FORMAT_MACROS 1
 #include <stdint.h>
 
 #include <cstdio> /* for sprintf */
 #include <cstring>
+#include <climits>
+#include <cstdlib>
 #include <cmath>
 #include <cctype>
 #include <cstring>
 #include <fcntl.h>
 #include <dirent.h>
 #include <errno.h>
+#include <regex.h>
 
 #include <glibmm/miscutils.h>
+#include <glibmm/fileutils.h>
 
-#ifdef HAVE_WORDEXP
-#include <wordexp.h>
-#endif
-
+#include "pbd/cpus.h"
 #include "pbd/error.h"
 #include "pbd/stacktrace.h"
 #include "pbd/xml++.h"
 #include "pbd/basename.h"
+#include "pbd/strsplit.h"
+#include "pbd/replace_all.h"
+
 #include "ardour/utils.h"
+#include "ardour/rc_configuration.h"
 
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
-using Glib::ustring;
 
-ustring
-legalize_for_path (ustring str)
+string
+legalize_for_path (const string& str)
 {
-       ustring::size_type pos;
-       ustring legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
-       ustring legal;
+       string::size_type pos;
+       string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
+       string legal;
 
        legal = str;
        pos = 0;
 
-       while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
+       while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
                legal.replace (pos, 1, "_");
                pos += 1;
        }
 
-       return legal;
+       return string (legal);
 }
 
-string 
+string
 bump_name_once (const std::string& name, char delimiter)
 {
        string::size_type delim;
@@ -117,6 +120,46 @@ bump_name_once (const std::string& name, char delimiter)
 
 }
 
+bool
+could_be_a_valid_path (const string& path)
+{
+        vector<string> posix_dirs;
+        vector<string> dos_dirs;
+        string testpath;
+
+        split (path, posix_dirs, '/');
+        split (path, dos_dirs, '\\');
+
+        /* remove the last component of each */
+
+        posix_dirs.erase (--posix_dirs.end());
+        dos_dirs.erase (--dos_dirs.end());
+
+        if (G_DIR_SEPARATOR == '/') {
+                for (vector<string>::iterator x = posix_dirs.begin(); x != posix_dirs.end(); ++x) {
+                        testpath = Glib::build_filename (testpath, *x);
+                        cerr << "Testing " << testpath << endl;
+                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
+                                return false;
+                        }
+                }
+        }
+
+        if (G_DIR_SEPARATOR == '\\') {
+                testpath = "";
+                for (vector<string>::iterator x = dos_dirs.begin(); x != dos_dirs.end(); ++x) {
+                        testpath = Glib::build_filename (testpath, *x);
+                        cerr << "Testing " << testpath << endl;
+                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
+                                return false;
+                        }
+                }
+        }
+
+        return true;
+}
+
+
 XMLNode *
 find_named_node (const XMLNode& node, string name)
 {
@@ -156,7 +199,7 @@ cmp_nocase (const string& s, const string& s2)
 }
 
 int
-touch_file (ustring path)
+touch_file (string path)
 {
        int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
        if (fd >= 0) {
@@ -166,8 +209,8 @@ touch_file (ustring path)
        return 1;
 }
 
-ustring
-region_name_from_path (ustring path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
+string
+region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 {
        path = PBD::basename_nosuffix (path);
 
@@ -175,7 +218,7 @@ region_name_from_path (ustring path, bool strip_channels, bool add_channel_suffi
 
                /* remove any "?R", "?L" or "?[a-z]" channel identifier */
 
-               ustring::size_type len = path.length();
+               string::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])))) {
@@ -199,13 +242,13 @@ region_name_from_path (ustring path, bool strip_channels, bool add_channel_suffi
 }
 
 bool
-path_is_paired (ustring path, ustring& pair_base)
+path_is_paired (string path, string& pair_base)
 {
-       ustring::size_type pos;
+       string::size_type pos;
 
        /* remove any leading path */
 
-       if ((pos = path.find_last_of ('/')) != string::npos) {
+       if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
                path = path.substr(pos+1);
        }
 
@@ -215,7 +258,7 @@ path_is_paired (ustring path, ustring& pair_base)
                path = path.substr (0, pos);
        }
 
-       ustring::size_type len = path.length();
+       string::size_type len = path.length();
 
        /* look for possible channel identifier: "?R", "%R", ".L" etc. */
 
@@ -230,38 +273,113 @@ path_is_paired (ustring path, ustring& pair_base)
        return false;
 }
 
-ustring
-path_expand (ustring path)
+string
+path_expand (string path)
 {
-#ifdef HAVE_WORDEXP
-       /* Handle tilde and environment variable expansion in session path */
-       string ret = path;
+        if (path.empty()) {
+                return path;
+        }
 
-       wordexp_t expansion;
-       switch (wordexp (path.c_str(), &expansion, WRDE_NOCMD|WRDE_UNDEF)) {
-       case 0:
-               break;
-       default:
-               error << string_compose (_("illegal or badly-formed string used for path (%1)"), path) << endmsg;
-               goto out;
+        /* tilde expansion */
+
+        if (path[0] == '~') {
+                if (path.length() == 1) {
+                        return Glib::get_home_dir();
+                }
+
+                if (path[1] == '/') {
+                        path.replace (0, 1, Glib::get_home_dir());
+                } else {
+                        /* can't handle ~roger, so just leave it */
+                }
+        }
+
+       /* now do $VAR substitution, since wordexp isn't reliable */
+
+       regex_t compiled_pattern;
+       const int nmatches = 100;
+       regmatch_t matches[nmatches];
+       
+       if (regcomp (&compiled_pattern, "\\$([a-zA-Z_][a-zA-Z0-9_]*|\\{[a-zA-Z_][a-zA-Z0-9_]*\\})", REG_EXTENDED)) {
+                cerr << "bad regcomp\n";
+                return path;
+        }
+
+       while (true) { 
+
+               if (regexec (&compiled_pattern, path.c_str(), nmatches, matches, 0)) {
+                       break;
+               }
+               
+               /* matches[0] gives the entire match */
+               
+               string match = path.substr (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so);
+               
+               /* try to get match from the environment */
+
+                if (match[1] == '{') {
+                        /* ${FOO} form */
+                        match = match.substr (2, match.length() - 3);
+                }
+
+               char* matched_value = getenv (match.c_str());
+
+               if (matched_value) {
+                       path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, matched_value);
+               } else {
+                       path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, string());
+                }
+
+               /* go back and do it again with whatever remains after the
+                * substitution 
+                */
        }
 
-       if (expansion.we_wordc > 1) {
-               error << string_compose (_("path (%1) is ambiguous"), path) << endmsg;
-               goto out;
+       regfree (&compiled_pattern);
+
+       /* canonicalize */
+
+       char buf[PATH_MAX+1];
+
+       if (realpath (path.c_str(), buf)) {
+               return buf;
+       } else {
+               return string();
        }
+}
 
-       ret = expansion.we_wordv[0];
-  out:
-       wordfree (&expansion);
-       return ret;
+string
+search_path_expand (string path)
+{
+        if (path.empty()) {
+                return path;
+        }
 
-#else
-       return path;
-#endif
+       vector<string> s;
+       vector<string> n;
+
+       split (path, s, ':');
+
+       for (vector<string>::iterator i = s.begin(); i != s.end(); ++i) {
+               string exp = path_expand (*i);
+               if (!exp.empty()) {
+                       n.push_back (exp);
+               }
+       }
+
+       string r;
+
+       for (vector<string>::iterator i = n.begin(); i != n.end(); ++i) {
+               if (!r.empty()) {
+                       r += ':';
+               }
+               r += *i;
+       }
+
+       return r;
 }
 
-#if defined(HAVE_COREAUDIO) || defined(HAVE_AUDIOUNITS)
+#if __APPLE__
 string
 CFStringRefToStdString(CFStringRef stringRef)
 {
@@ -278,10 +396,10 @@ CFStringRefToStdString(CFStringRef stringRef)
        delete [] buf;
        return result;
 }
-#endif // HAVE_COREAUDIO
+#endif // __APPLE__
 
 void
-compute_equal_power_fades (nframes_t nframes, float* in, float* out)
+compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 {
        double step;
 
@@ -289,7 +407,7 @@ compute_equal_power_fades (nframes_t nframes, float* in, float* out)
 
        in[0] = 0.0f;
 
-       for (nframes_t i = 1; i < nframes - 1; ++i) {
+       for (framecnt_t i = 1; i < nframes - 1; ++i) {
                in[i] = in[i-1] + step;
        }
 
@@ -298,7 +416,7 @@ compute_equal_power_fades (nframes_t nframes, float* in, float* out)
        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) {
+       for (framecnt_t n = 0; n < nframes; ++n) {
                float inVal = in[n];
                float outVal = 1 - inVal;
                out[n] = outVal * (scale * outVal + 1.0f - scale);
@@ -340,7 +458,7 @@ edit_mode_to_string (EditMode mode)
 SyncSource
 string_to_sync_source (string str)
 {
-       if (str == _("MIDI Timecode")) {
+       if (str == _("MIDI Timecode") || str == _("MTC")) {
                return MTC;
        }
 
@@ -357,15 +475,20 @@ string_to_sync_source (string str)
        return JACK;
 }
 
+/** @param sh Return a short version of the string */
 const char*
-sync_source_to_string (SyncSource src)
+sync_source_to_string (SyncSource src, bool sh)
 {
        switch (src) {
        case JACK:
                return _("JACK");
 
        case MTC:
-               return _("MIDI Timecode");
+               if (sh) {
+                       return _("MTC");
+               } else {
+                       return _("MIDI Timecode");
+               }
 
        case MIDIClock:
                return _("MIDI Clock");
@@ -509,7 +632,19 @@ 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()));
+       if (str.empty ()) {
+               return false;
+       }
+
+       /* the use of g_strncasecmp() is solely to get around issues with
+        * charsets posed by trying to use C++ for the same
+        * comparison. switching a std::string to its lower- or upper-case
+        * version has several issues, but handled by default
+        * in the way we desire when doing it in C.
+        */
+
+       return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length())) ||
+               (!g_strncasecmp(str.c_str(), "true", str.length()));
 }
 
 const char*
@@ -518,7 +653,7 @@ native_header_format_extension (HeaderFormat hf, const DataType& type)
         if (type == DataType::MIDI) {
                 return ".mid";
         }
-        
+
         switch (hf) {
         case BWF:
                 return ".wav";
@@ -554,28 +689,28 @@ matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
                 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;
@@ -586,6 +721,50 @@ matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
         return ret;
 }
 
+uint32_t
+how_many_dsp_threads ()
+{
+        /* CALLER MUST HOLD PROCESS LOCK */
+
+        int num_cpu = hardware_concurrency();
+        int pu = Config->get_processor_usage ();
+        uint32_t num_threads = max (num_cpu - 1, 2); // default to number of cpus minus one, or 2, whichever is larger
+
+        if (pu < 0) {
+                /* pu is negative: use "pu" less cores for DSP than appear to be available
+                 */
+
+                if (-pu < num_cpu) {
+                        num_threads = num_cpu + pu;
+                }
+
+        } else if (pu == 0) {
+
+                /* use all available CPUs
+                 */
+
+                num_threads = num_cpu;
+
+        } else {
+                /* use "pu" cores, if available
+                 */
+
+                num_threads = min (num_cpu, pu);
+        }
+
+        return num_threads;
+}
+
+double gain_to_slider_position_with_max (double g, double max_gain)
+{
+        return gain_to_slider_position (g * 2.0/max_gain);
+}
+
+double slider_position_to_gain_with_max (double g, double max_gain)
+{
+       return slider_position_to_gain (g * max_gain/2.0);
+}
+
 extern "C" {
        void c_stacktrace() { stacktrace (cerr); }
 }