PluginInfo::type added to copy constructor. But why is the copy constructor defined...
[ardour.git] / libs / ardour / utils.cc
index 2d9fccf9d74691c289f52171b9b5c1c5dd8768d3..98b51cb5786be34d9922d65ef1ea4a724c69d9ac 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <cstdio> /* for sprintf */
 #include <cmath>
 #include <cctype>
-#include <string>
+#include <cstring>
 #include <cerrno>
 #include <iostream>
 #include <sys/types.h>
 #endif
 
 #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)
@@ -85,13 +88,13 @@ elapsed_time_to_str (char *buf, uint32_t seconds)
        }
 }
 
-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;
 
@@ -103,6 +106,45 @@ legalize_for_path (string str)
        return legal;
 }
 
+string bump_name_once(std::string name)
+{
+       string::size_type period;
+       string newname;
+
+       if ((period = name.find_last_of ('.')) == string::npos) {
+               newname  = name;
+               newname += ".1";
+       } else {
+               int isnumber = 1;
+               const char *last_element = name.c_str() + period + 1;
+               for (size_t i = 0; i < strlen(last_element); i++) {
+                       if (!isdigit(last_element[i])) {
+                               isnumber = 0;
+                               break;
+                       }
+               }
+
+               errno = 0;
+               long int version = strtol (name.c_str()+period+1, (char **)NULL, 10);
+
+               if (isnumber == 0 || errno != 0) {
+                       // last_element is not a number, or is too large
+                       newname  = name;
+                       newname += ".1";
+               } else {
+                       char buf[32];
+
+                       snprintf (buf, sizeof(buf), "%ld", version+1);
+               
+                       newname  = name.substr (0, period+1);
+                       newname += buf;
+               }
+       }
+
+       return newname;
+
+}
+
 ostream&
 operator<< (ostream& o, const BBT_Time& bbt)
 {
@@ -175,7 +217,7 @@ tokenize_fullpath (string fullpath, string& path, string& name)
 }
 
 int
-touch_file (string path)
+touch_file (ustring path)
 {
        int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
        if (fd >= 0) {
@@ -185,31 +227,42 @@ 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');
+               }
        }
-}
 
-string
-region_name_from_path (string path)
+       return path;
+}      
+
+bool
+path_is_paired (ustring path, ustring& pair_base)
 {
-       string::size_type pos;
+       ustring::size_type pos;
 
        /* remove filename suffixes etc. */
        
@@ -217,21 +270,23 @@ region_name_from_path (string path)
                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;
-}      
+       } 
 
-string
-path_expand (string path)
+       return false;
+}
+
+ustring
+path_expand (ustring path)
 {
 #ifdef HAVE_WORDEXP
        /* Handle tilde and environment variable expansion in session path */
@@ -261,3 +316,280 @@ path_expand (string 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 Edit")) {
+               return Splice;
+       } else if (str == _("Slide Edit")) {
+               return Slide;
+       } else if (str == _("Lock Edit")) {
+               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 Edit");
+
+       case Lock:
+               return _("Lock Edit");
+
+       default:
+       case Splice:
+               return _("Splice Edit");
+       }
+}
+
+SlaveSource
+string_to_slave_source (string str)
+{
+       if (str == _("Internal")) {
+               return None;
+       }
+       
+       if (str == _("MTC")) {
+               return MTC;
+       }
+
+       if (str == _("JACK")) {
+               return JACK;
+       }
+
+       fatal << string_compose (_("programming error: unknown slave source string \"%1\""), str) << endmsg;
+       /*NOTREACHED*/
+       return None;
+}
+
+const char*
+slave_source_to_string (SlaveSource src)
+{
+       switch (src) {
+       case JACK:
+               return _("JACK");
+
+       case MTC:
+               return _("MTC");
+               
+       default:
+       case None:
+               return _("Internal");
+               
+       }
+}
+
+/* I don't really like hard-coding these falloff rates here
+ * Probably should use a map of some kind that could be configured
+ * These rates are db/sec.
+*/
+
+#define METER_FALLOFF_OFF     0.0f
+#define METER_FALLOFF_SLOWEST 6.6f // BBC standard
+#define METER_FALLOFF_SLOW    8.6f // BBC standard
+#define METER_FALLOFF_MEDIUM  20.0f
+#define METER_FALLOFF_FAST    32.0f
+#define METER_FALLOFF_FASTER  46.0f
+#define METER_FALLOFF_FASTEST 70.0f
+
+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;
+       }
+}
+
+float
+meter_hold_to_float (MeterHold hold)
+{
+       switch (hold) {
+       case MeterHoldOff:
+               return 0.0f;
+       case MeterHoldShort:
+               return 40.0f;
+       case MeterHoldMedium:
+               return 100.0f;
+       case MeterHoldLong:
+       default:
+               return 200.0f;
+       }
+}
+
+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 "";
+}
+
+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()));
+}
+
+extern "C" {
+       void c_stacktrace() { stacktrace (cerr); }
+}