2 Copyright (C) 2000-2003 Paul Davis
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.
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.
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.
21 #include "libardour-config.h"
26 #include <cstdio> /* for sprintf */
35 #include <sys/types.h>
43 #include <glibmm/miscutils.h>
44 #include <glibmm/fileutils.h>
47 #include "pbd/error.h"
48 #include "pbd/stacktrace.h"
49 #include "pbd/xml++.h"
50 #include "pbd/basename.h"
51 #include "pbd/strsplit.h"
52 #include "pbd/replace_all.h"
54 #include "ardour/utils.h"
55 #include "ardour/rc_configuration.h"
59 using namespace ARDOUR;
63 /** take an arbitrary string as an argument, and return a version of it
64 * suitable for use as a path (directory/folder name). This is the Ardour 3.X
65 * and later version of this code. It defines a very small number
66 * of characters that are not allowed in a path on any of our target
67 * filesystems, and replaces any instances of them with an underscore.
71 legalize_for_path (const string& str)
73 string::size_type pos;
74 string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
77 /* this is the one place in Ardour where we need to iterate across
78 * potential multibyte characters, and thus we need Glib::ustring
84 while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
85 legal.replace (pos, 1, "_");
89 return string (legal);
92 /** take an arbitrary string as an argument, and return a version of it
93 * suitable for use as a path (directory/folder name). This is the Ardour 2.X
94 * version of this code, which used an approach that came to be seen as
95 * problematic: defining the characters that were allowed and replacing all
96 * others with underscores. See legalize_for_path() for the 3.X and later
101 legalize_for_path_2X (const string& str)
103 string::size_type pos;
104 string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
107 /* this is the one place in Ardour where we need to iterate across
108 * potential multibyte characters, and thus we need Glib::ustring
114 while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
115 legal.replace (pos, 1, "_");
119 return string (legal);
123 bump_name_once (const std::string& name, char delimiter)
125 string::size_type delim;
128 if ((delim = name.find_last_of (delimiter)) == string::npos) {
130 newname += delimiter;
134 const char *last_element = name.c_str() + delim + 1;
135 for (size_t i = 0; i < strlen(last_element); i++) {
136 if (!isdigit(last_element[i])) {
143 int32_t version = strtol (name.c_str()+delim+1, (char **)NULL, 10);
145 if (isnumber == 0 || errno != 0) {
146 // last_element is not a number, or is too large
148 newname += delimiter;
153 snprintf (buf, sizeof(buf), "%d", version+1);
155 newname = name.substr (0, delim+1);
165 find_named_node (const XMLNode& node, string name)
168 XMLNodeConstIterator niter;
171 nlist = node.children();
173 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
177 if (child->name() == name) {
186 cmp_nocase (const string& s, const string& s2)
188 string::const_iterator p = s.begin();
189 string::const_iterator p2 = s2.begin();
191 while (p != s.end() && p2 != s2.end()) {
192 if (toupper(*p) != toupper(*p2)) {
193 return (toupper(*p) < toupper(*p2)) ? -1 : 1;
199 return (s2.size() == s.size()) ? 0 : (s.size() < s2.size()) ? -1 : 1;
203 touch_file (string path)
205 int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
214 region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
216 path = PBD::basename_nosuffix (path);
218 if (strip_channels) {
220 /* remove any "?R", "?L" or "?[a-z]" channel identifier */
222 string::size_type len = path.length();
224 if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
225 (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
227 path = path.substr (0, path.length() - 2);
231 if (add_channel_suffix) {
236 path += (char) ('a' + this_one);
238 path += (char) (this_one == 0 ? 'L' : 'R');
246 path_is_paired (string path, string& pair_base)
248 string::size_type pos;
250 /* remove any leading path */
252 if ((pos = path.find_last_of (G_DIR_SEPARATOR)) != string::npos) {
253 path = path.substr(pos+1);
256 /* remove filename suffixes etc. */
258 if ((pos = path.find_last_of ('.')) != string::npos) {
259 path = path.substr (0, pos);
262 string::size_type len = path.length();
264 /* look for possible channel identifier: "?R", "%R", ".L" etc. */
266 if (len > 3 && (path[len-2] == '%' || path[len-2] == '?' || path[len-2] == '.') &&
267 (path[len-1] == 'R' || path[len-1] == 'L' || (islower (path[len-1])))) {
269 pair_base = path.substr (0, len-2);
278 path_expand (string path)
284 /* tilde expansion */
286 if (path[0] == '~') {
287 if (path.length() == 1) {
288 return Glib::get_home_dir();
291 if (path[1] == '/') {
292 path.replace (0, 1, Glib::get_home_dir());
294 /* can't handle ~roger, so just leave it */
298 /* now do $VAR substitution, since wordexp isn't reliable */
300 regex_t compiled_pattern;
301 const int nmatches = 100;
302 regmatch_t matches[nmatches];
304 if (regcomp (&compiled_pattern, "\\$([a-zA-Z_][a-zA-Z0-9_]*|\\{[a-zA-Z_][a-zA-Z0-9_]*\\})", REG_EXTENDED)) {
305 cerr << "bad regcomp\n";
311 if (regexec (&compiled_pattern, path.c_str(), nmatches, matches, 0)) {
315 /* matches[0] gives the entire match */
317 string match = path.substr (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so);
319 /* try to get match from the environment */
321 if (match[1] == '{') {
323 match = match.substr (2, match.length() - 3);
326 char* matched_value = getenv (match.c_str());
329 path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, matched_value);
331 path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, string());
334 /* go back and do it again with whatever remains after the
339 regfree (&compiled_pattern);
343 char buf[PATH_MAX+1];
345 if (realpath (path.c_str(), buf)) {
353 search_path_expand (string path)
362 split (path, s, ':');
364 for (vector<string>::iterator i = s.begin(); i != s.end(); ++i) {
365 string exp = path_expand (*i);
373 for (vector<string>::iterator i = n.begin(); i != n.end(); ++i) {
385 CFStringRefToStdString(CFStringRef stringRef)
388 CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
389 kCFStringEncodingUTF8);
390 char *buf = new char[size];
394 if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingUTF8)) {
403 compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
407 step = 1.0/(nframes-1);
411 for (framecnt_t i = 1; i < nframes - 1; ++i) {
412 in[i] = in[i-1] + step;
417 const float pan_law_attenuation = -3.0f;
418 const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
420 for (framecnt_t n = 0; n < nframes; ++n) {
422 float outVal = 1 - inVal;
423 out[n] = outVal * (scale * outVal + 1.0f - scale);
424 in[n] = inVal * (scale * inVal + 1.0f - scale);
429 string_to_edit_mode (string str)
431 if (str == _("Splice")) {
433 } else if (str == _("Slide")) {
435 } else if (str == _("Lock")) {
438 fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
444 edit_mode_to_string (EditMode mode)
460 string_to_sync_source (string str)
462 if (str == _("MIDI Timecode") || str == _("MTC")) {
466 if (str == _("MIDI Clock")) {
470 if (str == _("JACK")) {
474 fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
479 /** @param sh Return a short version of the string */
481 sync_source_to_string (SyncSource src, bool sh)
491 return _("MIDI Timecode");
498 return _("MIDI Clock");
504 /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
509 meter_falloff_to_float (MeterFalloff falloff)
512 case MeterFalloffOff:
513 return METER_FALLOFF_OFF;
514 case MeterFalloffSlowest:
515 return METER_FALLOFF_SLOWEST;
516 case MeterFalloffSlow:
517 return METER_FALLOFF_SLOW;
518 case MeterFalloffMedium:
519 return METER_FALLOFF_MEDIUM;
520 case MeterFalloffFast:
521 return METER_FALLOFF_FAST;
522 case MeterFalloffFaster:
523 return METER_FALLOFF_FASTER;
524 case MeterFalloffFastest:
525 return METER_FALLOFF_FASTEST;
527 return METER_FALLOFF_FAST;
532 meter_falloff_from_float (float val)
534 if (val == METER_FALLOFF_OFF) {
535 return MeterFalloffOff;
537 else if (val <= METER_FALLOFF_SLOWEST) {
538 return MeterFalloffSlowest;
540 else if (val <= METER_FALLOFF_SLOW) {
541 return MeterFalloffSlow;
543 else if (val <= METER_FALLOFF_MEDIUM) {
544 return MeterFalloffMedium;
546 else if (val <= METER_FALLOFF_FAST) {
547 return MeterFalloffFast;
549 else if (val <= METER_FALLOFF_FASTER) {
550 return MeterFalloffFaster;
553 return MeterFalloffFastest;
558 ARDOUR::string_to_auto_state (std::string str)
560 if (str == X_("Off")) {
562 } else if (str == X_("Play")) {
564 } else if (str == X_("Write")) {
566 } else if (str == X_("Touch")) {
570 fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
576 ARDOUR::auto_state_to_string (AutoState as)
578 /* to be used only for XML serialization, no i18n done */
594 fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
600 ARDOUR::string_to_auto_style (std::string str)
602 if (str == X_("Absolute")) {
604 } else if (str == X_("Trim")) {
608 fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
614 ARDOUR::auto_style_to_string (AutoStyle as)
616 /* to be used only for XML serialization, no i18n done */
620 return X_("Absolute");
627 fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
633 bool_as_string (bool yn)
635 return (yn ? "yes" : "no");
639 native_header_format_extension (HeaderFormat hf, const DataType& type)
641 if (type == DataType::MIDI) {
662 fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
668 matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
670 string bws = basename_nosuffix (path);
671 struct dirent* dentry;
676 if ((dead = ::opendir (dir.c_str())) == 0) {
677 error << string_compose (_("cannot open directory %1 (%2)"), dir, strerror (errno)) << endl;
681 while ((dentry = ::readdir (dead)) != 0) {
683 /* avoid '.' and '..' */
685 if ((dentry->d_name[0] == '.' && dentry->d_name[1] == '\0') ||
686 (dentry->d_name[2] == '\0' && dentry->d_name[0] == '.' && dentry->d_name[1] == '.')) {
690 string fullpath = Glib::build_filename (dir, dentry->d_name);
692 if (::stat (fullpath.c_str(), &statbuf)) {
696 if (!S_ISREG (statbuf.st_mode)) {
700 string bws2 = basename_nosuffix (dentry->d_name);
713 how_many_dsp_threads ()
715 /* CALLER MUST HOLD PROCESS LOCK */
717 int num_cpu = hardware_concurrency();
718 int pu = Config->get_processor_usage ();
719 uint32_t num_threads = max (num_cpu - 1, 2); // default to number of cpus minus one, or 2, whichever is larger
722 /* pu is negative: use "pu" less cores for DSP than appear to be available
726 num_threads = num_cpu + pu;
729 } else if (pu == 0) {
731 /* use all available CPUs
734 num_threads = num_cpu;
737 /* use "pu" cores, if available
740 num_threads = min (num_cpu, pu);
746 double gain_to_slider_position_with_max (double g, double max_gain)
748 return gain_to_slider_position (g * 2.0/max_gain);
751 double slider_position_to_gain_with_max (double g, double max_gain)
753 return slider_position_to_gain (g * max_gain/2.0);
757 void c_stacktrace() { stacktrace (cerr); }