libs/ardour/ardour/utils.h

   1 /*
   2     Copyright (C) 1999 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_utils_h__
  21 #define __ardour_utils_h__
  22
  23 #ifdef WAF_BUILD
  24 #include "libardour-config.h"
  25 #endif
  26
  27 #include <iostream>
  28 #include <string>
  29 #include <cmath>
  30
  31 #include "boost/shared_ptr.hpp"
  32
  33 #if __APPLE__
  34 #include <CoreFoundation/CoreFoundation.h>
  35 #endif /* __APPLE__ */
  36
  37 #include "ardour/ardour.h"
  38 #include "ardour/data_type.h"
  39 #include "ardour/dB.h"
  40 #include "ardour/types.h"
  41
  42 #include "ardour/libardour_visibility.h"
  43
  44 class XMLNode;
  45
  46 namespace ARDOUR {
  47
  48 class Route;
  49 class Track;
  50
  51 LIBARDOUR_API std::string legalize_for_path (const std::string& str);
  52 LIBARDOUR_API std::string legalize_for_universal_path (const std::string& str);
  53 LIBARDOUR_API std::string legalize_for_uri (const std::string& str);
  54 LIBARDOUR_API std::string legalize_for_path_2X (const std::string& str);
  55 LIBARDOUR_API XMLNode* find_named_node (const XMLNode& node, std::string name);
  56 LIBARDOUR_API std::string bool_as_string (bool);
  57
  58 static inline float f_max(float x, float a) {
  59         x -= a;
  60         x += fabsf (x);
  61         x *= 0.5f;
  62         x += a;
  63
  64         return (x);
  65 }
  66
  67 LIBARDOUR_API std::string bump_name_once(const std::string& s, char delimiter);
  68 LIBARDOUR_API std::string bump_name_number(const std::string& s);
  69
  70 LIBARDOUR_API int cmp_nocase (const std::string& s, const std::string& s2);
  71 LIBARDOUR_API int cmp_nocase_utf8 (const std::string& s1, const std::string& s2);
  72
  73 LIBARDOUR_API std::string region_name_from_path (std::string path, bool strip_channels, bool add_channel_suffix = false, uint32_t total = 0, uint32_t this_one = 0);
  74 LIBARDOUR_API bool path_is_paired (std::string path, std::string& pair_base);
  75
  76 LIBARDOUR_API void compute_equal_power_fades (ARDOUR::framecnt_t nframes, float* in, float* out);
  77
  78 LIBARDOUR_API const char* sync_source_to_string (ARDOUR::SyncSource src, bool sh = false);
  79 LIBARDOUR_API ARDOUR::SyncSource string_to_sync_source (std::string str);
  80
  81 LIBARDOUR_API const char* edit_mode_to_string (ARDOUR::EditMode);
  82 LIBARDOUR_API ARDOUR::EditMode string_to_edit_mode (std::string);
  83
  84 #undef  OLD_GAIN_MATH
  85 #define OLD_GAIN_MATH
  86
  87 static inline double
  88 gain_to_slider_position (ARDOUR::gain_t g)
  89 {
  90         if (g == 0) return 0;
  91
  92 #ifndef OLD_GAIN_MATH
  93         /* Power Law With Exponential Cutoff 2D, fit to data from TC Spectra
  94            console (image of fader gradations
  95
  96            y = C * x(-T) * exp(-x/K)
  97
  98            C =  8.2857630370864188E-01
  99            T = -5.1526743785019269E-01
 100            K =  7.8990885960495589E+00
 101
 102          */
 103
 104         return 8.2857630370864188E-01 * pow(g,5.1526743785019269E-01) * exp (-g/7.8990885960495589E+00);
 105 #else
 106         return pow((6.0*log(g)/log(2.0)+192.0)/198.0, 8.0);
 107 #endif
 108 }
 109
 110 static inline ARDOUR::gain_t
 111 slider_position_to_gain (double pos)
 112 {
 113         if (pos == 0.0) {
 114                 return 0.0;
 115         }
 116
 117 #ifndef OLD_GAIN_MATH
 118         /* 5th order polynomial function fit to data from a TC Spectra console
 119            fader (image of fader gradations).
 120
 121            y = a + bx1 + cx2 + dx3 + fx4 + gx5
 122
 123            a = -1.1945480381045521E-02
 124            b =  1.5809476525537265E+00
 125            c = -1.5850710838966151E+01
 126            d =  6.1643128605961991E+01
 127            f = -8.5525246160607693E+01
 128            g =  4.1312725896188283E+01
 129
 130         */
 131
 132         double p = pos;
 133         double g = -1.1945480381045521E-02;
 134
 135         g +=  1.5809476525537265E+00 * pos;
 136         pos *= p;
 137         g += -1.5850710838966151E+01 * pos;
 138         pos *= p;
 139         g += 6.1643128605961991E+01 * pos;
 140         pos *= p;
 141         g += -8.5525246160607693E+01 * pos;
 142         pos *= p;
 143         g += 4.1312725896188283E+01 * pos;
 144
 145         return g;
 146 #else
 147         /* XXX Marcus writes: this doesn't seem right to me. but i don't have a better answer ... */
 148         if (pos == 0.0) return 0;
 149         return pow (2.0,(sqrt(sqrt(sqrt(pos)))*198.0-192.0)/6.0);
 150 #endif
 151 }
 152 #undef OLD_GAIN_MATH
 153
 154 LIBARDOUR_API double gain_to_slider_position_with_max (double g, double max_gain = 2.0);
 155 LIBARDOUR_API double slider_position_to_gain_with_max (double g, double max_gain = 2.0);
 156
 157 /* I don't really like hard-coding these falloff rates here
 158  * Probably should use a map of some kind that could be configured
 159  * These rates are db/sec.
 160 */
 161
 162 #define METER_FALLOFF_OFF       0.0f
 163 #define METER_FALLOFF_SLOWEST   6.6f  // BBC standard
 164 #define METER_FALLOFF_SLOW      8.6f  // BBC standard, EBU  24dB / 2.8sec
 165 #define METER_FALLOFF_SLOWISH   12.0f // DIN  20dB / 1.7 sec
 166 #define METER_FALLOFF_MODERATE  13.3f // EBU-PPM, IRT PPM-   20dB / 1.5 sec
 167 #define METER_FALLOFF_MEDIUM    20.0f
 168 #define METER_FALLOFF_FAST      32.0f
 169
 170 LIBARDOUR_API float meter_falloff_to_float (ARDOUR::MeterFalloff);
 171 LIBARDOUR_API ARDOUR::MeterFalloff meter_falloff_from_float (float);
 172 LIBARDOUR_API float meter_falloff_to_db_per_sec (float);
 173
 174 LIBARDOUR_API const char* native_header_format_extension (ARDOUR::HeaderFormat, const ARDOUR::DataType& type);
 175 LIBARDOUR_API bool matching_unsuffixed_filename_exists_in (const std::string& dir, const std::string& name);
 176
 177 LIBARDOUR_API uint32_t how_many_dsp_threads ();
 178
 179 template<typename T> boost::shared_ptr<ControlList> route_list_to_control_list (boost::shared_ptr<RouteList> rl, boost::shared_ptr<T> (Stripable::*get_control)() const) {
 180         boost::shared_ptr<ControlList> cl (new ControlList);
 181         for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
 182                 boost::shared_ptr<AutomationControl> ac = ((*r).get()->*get_control)();
 183                 if (ac) {
 184                         cl->push_back (ac);
 185                 }
 186         }
 187         return cl;
 188 }
 189
 190 #if __APPLE__
 191 LIBARDOUR_API std::string CFStringRefToStdString(CFStringRef stringRef);
 192 #endif // __APPLE__
 193
 194 } //namespave
 195
 196 #endif /* __ardour_utils_h__ */