/*
- 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
+
+#include <stdint.h>
+
#include <cstdio> /* for sprintf */
+#include <cstring>
+#include <climits>
+#include <cstdlib>
#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>
-
-#ifdef HAVE_WORDEXP
-#include <wordexp.h>
+#ifndef COMPILER_MSVC
+#include <dirent.h>
#endif
+#include <errno.h>
+#include <regex.h>
+
+#include "pbd/gstdio_compat.h"
+
+#include <glibmm/miscutils.h>
+#include <glibmm/fileutils.h>
+
+#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 <pbd/error.h>
-#include <pbd/xml++.h>
-#include <ardour/utils.h>
+#include "ardour/utils.h"
+#include "ardour/rc_configuration.h"
#include "i18n.h"
using namespace std;
using namespace PBD;
-void
-elapsed_time_to_str (char *buf, uint32_t seconds)
-
+static string
+replace_chars (const string& str, const string& illegal_chars)
{
- 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::size_type pos;
+ Glib::ustring legal;
+
+ /* this is the one place in Ardour where we need to iterate across
+ * potential multibyte characters, and thus we need Glib::ustring
+ */
+
+ legal = str;
+ pos = 0;
+
+ while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
+ legal.replace (pos, 1, "_");
+ pos += 1;
}
+
+ return string (legal);
+}
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a very small number of characters
+ * that are not allowed in a path on the build target filesystem (basically,
+ * POSIX or Windows) and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended only to legalize for the filesystem that Ardour
+ * is running on. Export should use legalize_for_universal_path() since
+ * the goal there is to be legal across filesystems.
+ */
+string
+ARDOUR::legalize_for_path (const string& str)
+{
+ return replace_chars (str, "/\\");
+}
+
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a small number
+ * of characters that are not allowed in a path on any of our target
+ * filesystems, and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended to create paths that should be legal on
+ * ANY filesystem.
+ */
+string
+ARDOUR::legalize_for_universal_path (const string& str)
+{
+ return replace_chars (str, "<>:\"/\\|?*");
+}
+
+/** Legalize for a URI path component. This is like
+ * legalize_for_universal_path, but stricter, disallowing spaces and hash.
+ * This avoids %20 escapes in URIs, but probably needs work to be more strictly
+ * correct.
+ */
+string
+ARDOUR::legalize_for_uri (const string& str)
+{
+ return replace_chars (str, "<>:\"/\\|?* #");
}
-string
-legalize_for_path (string str)
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 2.X
+ * version of this code, which used an approach that came to be seen as
+ * problematic: defining the characters that were allowed and replacing all
+ * others with underscores. See legalize_for_path() for the 3.X and later
+ * version.
+ */
+
+string
+ARDOUR::legalize_for_path_2X (const string& str)
{
string::size_type pos;
string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
- string legal;
+ Glib::ustring legal;
+
+ /* this is the one place in Ardour where we need to iterate across
+ * potential multibyte characters, and thus we need Glib::ustring
+ */
legal = str;
pos = 0;
pos += 1;
}
- return legal;
+ return string (legal);
}
-ostream&
-operator<< (ostream& o, const BBT_Time& bbt)
+string
+ARDOUR::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;
+
+}
+
+string
+ARDOUR::bump_name_number (const std::string& name)
+{
+ size_t pos = name.length();
+ size_t num = 0;
+ bool have_number = false;
+ while (pos > 0 && isdigit(name.at(--pos))) {
+ have_number = true;
+ num = pos;
+ }
+
+ string newname;
+ if (have_number) {
+ int32_t seq = strtol (name.c_str() + num, (char **)NULL, 10);
+ char buf[32];
+ snprintf (buf, sizeof(buf), "%d", seq + 1);
+ newname = name.substr (0, num);
+ newname += buf;
+ } else {
+ newname = name;
+ newname += "1";
+ }
+
+ return newname;
}
XMLNode *
-find_named_node (const XMLNode& node, string name)
+ARDOUR::find_named_node (const XMLNode& node, string name)
{
XMLNodeList nlist;
XMLNodeConstIterator niter;
}
int
-cmp_nocase (const string& s, const string& s2)
+ARDOUR::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;
++p;
++p2;
}
-
+
return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
}
int
-tokenize_fullpath (string fullpath, string& path, string& name)
+ARDOUR::cmp_nocase_utf8 (const string& s1, const string& s2)
{
- 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;
-}
+ const char *cstr1 = s1.c_str();
+ const char *cstr2 = s2.c_str();
+ gchar *cstr1folded = NULL;
+ gchar *cstr2folded = NULL;
+ int retval;
+
+ if (!g_utf8_validate (cstr1, -1, NULL) ||
+ !g_utf8_validate (cstr2, -1, NULL)) {
+ // fall back to comparing ASCII
+ return g_ascii_strcasecmp (cstr1, cstr2);
+ }
-int
-touch_file (string path)
-{
- int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
- if (fd >= 0) {
- close (fd);
- return 0;
+ cstr1folded = g_utf8_casefold (cstr1, -1);
+ cstr2folded = g_utf8_casefold (cstr2, -1);
+
+ if (cstr1folded && cstr2folded) {
+ retval = strcmp (cstr1folded, cstr2folded);
+ } else {
+ // this shouldn't happen, make the best of it
+ retval = g_ascii_strcasecmp (cstr1, cstr2);
}
- return 1;
-}
-uint32_t long
-get_uid()
-{
- struct timeval tv;
- gettimeofday(&tv, 0);
+ if (cstr1folded) {
+ g_free (cstr1folded);
+ }
- return (uint32_t long) tv.tv_sec * 1000000 + tv.tv_usec;
+ if (cstr2folded) {
+ g_free (cstr2folded);
+ }
+
+ return retval;
}
string
-placement_as_string (Placement p)
+ARDOUR::region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
{
- switch (p) {
- case PreFader:
- return _("pre");
- default: /* to get g++ to realize we have all the cases covered */
- case PostFader:
- return _("post");
+ path = PBD::basename_nosuffix (path);
+
+ if (strip_channels) {
+
+ /* remove any "?R", "?L" or "?[a-z]" channel identifier */
+
+ 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])))) {
+
+ 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
+ARDOUR::path_is_paired (string path, string& pair_base)
{
string::size_type pos;
- /* remove filename suffixes etc. */
-
+ /* remove any leading path */
+
+ if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
+ path = path.substr(pos+1);
+ }
+
+ /* 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] == '?') &&
+
+ /* 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;
+}
+#if __APPLE__
string
-path_expand (string path)
+ARDOUR::CFStringRefToStdString(CFStringRef stringRef)
{
-#ifdef HAVE_WORDEXP
- /* Handle tilde and environment variable expansion in session path */
- string ret = path;
+ 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 // __APPLE__
+
+void
+ARDOUR::compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
+{
+ double step;
+
+ step = 1.0/(nframes-1);
+
+ in[0] = 0.0f;
+
+ for (framecnt_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 (framecnt_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
+ARDOUR::string_to_edit_mode (string str)
+{
+ if (str == _("Splice")) {
+ return Splice;
+ } else if (str == _("Slide")) {
+ return Slide;
+ } else if (str == _("Ripple")) {
+ return Ripple;
+ } else if (str == _("Lock")) {
+ return Lock;
+ }
+ fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
+ abort(); /*NOTREACHED*/
+ return Slide;
+}
+
+const char*
+ARDOUR::edit_mode_to_string (EditMode mode)
+{
+ switch (mode) {
+ case Slide:
+ return _("Slide");
+
+ case Lock:
+ return _("Lock");
+
+ case Ripple:
+ return _("Ripple");
- 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;
+ case Splice:
+ return _("Splice");
}
+}
- if (expansion.we_wordc > 1) {
- error << string_compose (_("path (%1) is ambiguous"), path) << endmsg;
- goto out;
+SyncSource
+ARDOUR::string_to_sync_source (string str)
+{
+ if (str == _("MIDI Timecode") || str == _("MTC")) {
+ return MTC;
}
- ret = expansion.we_wordv[0];
- out:
- wordfree (&expansion);
- return ret;
+ if (str == _("MIDI Clock")) {
+ return MIDIClock;
+ }
-#else
- return path;
-#endif
+ if (str == _("JACK")) {
+ return Engine;
+ }
+
+ if (str == _("LTC")) {
+ return LTC;
+ }
+
+ fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
+ abort(); /*NOTREACHED*/
+ return Engine;
+}
+
+/** @param sh Return a short version of the string */
+const char*
+ARDOUR::sync_source_to_string (SyncSource src, bool sh)
+{
+ switch (src) {
+ case Engine:
+ /* no other backends offer sync for now ... deal with this if we
+ * ever have to.
+ */
+ return _("JACK");
+
+ case MTC:
+ if (sh) {
+ return _("MTC");
+ } else {
+ return _("MIDI Timecode");
+ }
+
+ case MIDIClock:
+ if (sh) {
+ return _("M-Clock");
+ } else {
+ return _("MIDI Clock");
+ }
+
+ case LTC:
+ return _("LTC");
+ }
+ /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
+ return _("JACK");
+}
+
+float
+ARDOUR::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 MeterFalloffSlowish:
+ return METER_FALLOFF_SLOWISH;
+ case MeterFalloffMedium:
+ return METER_FALLOFF_MEDIUM;
+ case MeterFalloffModerate:
+ return METER_FALLOFF_MODERATE;
+ case MeterFalloffFast:
+ case MeterFalloffFaster: // backwards compat enum MeterFalloff
+ case MeterFalloffFastest:
+ default:
+ return METER_FALLOFF_FAST;
+ }
+}
+
+MeterFalloff
+ARDOUR::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_SLOWISH) {
+ return MeterFalloffSlowish;
+ }
+ else if (val <= METER_FALLOFF_MODERATE) {
+ return MeterFalloffModerate;
+ }
+ else if (val <= METER_FALLOFF_MEDIUM) {
+ return MeterFalloffMedium;
+ }
+ else {
+ return MeterFalloffFast;
+ }
}
+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;
+ abort(); /*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;
+ abort(); /*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;
+ abort(); /*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;
+ abort(); /*NOTREACHED*/
+ return "";
+}
+
+std::string
+bool_as_string (bool yn)
+{
+ return (yn ? "yes" : "no");
+}
+
+const char*
+ARDOUR::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:
+ case RF64_WAV:
+ case MBWF:
+ return ".rf64";
+ }
+
+ fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
+ abort(); /*NOTREACHED*/
+ return ".wav";
+}
+
+bool
+ARDOUR::matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
+{
+ string bws = basename_nosuffix (path);
+ struct dirent* dentry;
+ GStatBuf 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 (g_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;
+}
+
+uint32_t
+ARDOUR::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
+ARDOUR::gain_to_slider_position_with_max (double g, double max_gain)
+{
+ return gain_to_slider_position (g * 2.0/max_gain);
+}
+
+double
+ARDOUR::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); }
+}