libs/ardour/curve.cc

   1 /*
   2     Copyright (C) 2001-2007 Paul Davis
   3
   4     Contains ideas derived from "Constrained Cubic Spline Interpolation"
   5     by CJC Kruger (www.korf.co.uk/spline.pdf).
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation; either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20
  21 */
  22
  23 #include <iostream>
  24 #include <float.h>
  25 #include <cmath>
  26 #include <climits>
  27 #include <cfloat>
  28 #include <cmath>
  29
  30 #include <glibmm/thread.h>
  31 #include <sigc++/bind.h>
  32
  33 #include "ardour/curve.h"
  34 #include "ardour/automation_event.h"
  35
  36 #include "i18n.h"
  37
  38 using namespace std;
  39 using namespace ARDOUR;
  40 using namespace sigc;
  41 using namespace PBD;
  42
  43 Curve::Curve (const AutomationList& al)
  44         : _dirty (true)
  45         , _list (al)
  46 {
  47         _list.Dirty.connect(mem_fun(*this, &Curve::on_list_dirty));
  48 }
  49
  50 void
  51 Curve::solve ()
  52 {
  53         uint32_t npoints;
  54
  55         if (!_dirty) {
  56                 return;
  57         }
  58
  59         if ((npoints = _list.events().size()) > 2) {
  60
  61                 /* Compute coefficients needed to efficiently compute a constrained spline
  62                    curve. See "Constrained Cubic Spline Interpolation" by CJC Kruger
  63                    (www.korf.co.uk/spline.pdf) for more details.
  64                 */
  65
  66                 double x[npoints];
  67                 double y[npoints];
  68                 uint32_t i;
  69                 AutomationList::EventList::const_iterator xx;
  70
  71                 for (i = 0, xx = _list.events().begin(); xx != _list.events().end(); ++xx, ++i) {
  72                         x[i] = (double) (*xx)->when;
  73                         y[i] = (double) (*xx)->value;
  74                 }
  75
  76                 double lp0, lp1, fpone;
  77
  78                 lp0 =(x[1] - x[0])/(y[1] - y[0]);
  79                 lp1 = (x[2] - x[1])/(y[2] - y[1]);
  80
  81                 if (lp0*lp1 < 0) {
  82                         fpone = 0;
  83                 } else {
  84                         fpone = 2 / (lp1 + lp0);
  85                 }
  86
  87                 double fplast = 0;
  88
  89                 for (i = 0, xx = _list.events().begin(); xx != _list.events().end(); ++xx, ++i) {
  90
  91                         double xdelta;   /* gcc is wrong about possible uninitialized use */
  92                         double xdelta2;  /* ditto */
  93                         double ydelta;   /* ditto */
  94                         double fppL, fppR;
  95                         double fpi;
  96
  97                         if (i > 0) {
  98                                 xdelta = x[i] - x[i-1];
  99                                 xdelta2 = xdelta * xdelta;
 100                                 ydelta = y[i] - y[i-1];
 101                         }
 102
 103                         /* compute (constrained) first derivatives */
 104
 105                         if (i == 0) {
 106
 107                                 /* first segment */
 108
 109                                 fplast = ((3 * (y[1] - y[0]) / (2 * (x[1] - x[0]))) - (fpone * 0.5));
 110
 111                                 /* we don't store coefficients for i = 0 */
 112
 113                                 continue;
 114
 115                         } else if (i == npoints - 1) {
 116
 117                                 /* last segment */
 118
 119                                 fpi = ((3 * ydelta) / (2 * xdelta)) - (fplast * 0.5);
 120
 121                         } else {
 122
 123                                 /* all other segments */
 124
 125                                 double slope_before = ((x[i+1] - x[i]) / (y[i+1] - y[i]));
 126                                 double slope_after = (xdelta / ydelta);
 127
 128                                 if (slope_after * slope_before < 0.0) {
 129                                         /* slope changed sign */
 130                                         fpi = 0.0;
 131                                 } else {
 132                                         fpi = 2 / (slope_before + slope_after);
 133                                 }
 134
 135                         }
 136
 137                         /* compute second derivative for either side of control point `i' */
 138
 139                         fppL = (((-2 * (fpi + (2 * fplast))) / (xdelta))) +
 140                                 ((6 * ydelta) / xdelta2);
 141
 142                         fppR = (2 * ((2 * fpi) + fplast) / xdelta) -
 143                                 ((6 * ydelta) / xdelta2);
 144
 145                         /* compute polynomial coefficients */
 146
 147                         double b, c, d;
 148
 149                         d = (fppR - fppL) / (6 * xdelta);
 150                         c = ((x[i] * fppL) - (x[i-1] * fppR))/(2 * xdelta);
 151
 152                         double xim12, xim13;
 153                         double xi2, xi3;
 154
 155                         xim12 = x[i-1] * x[i-1];  /* "x[i-1] squared" */
 156                         xim13 = xim12 * x[i-1];   /* "x[i-1] cubed" */
 157                         xi2 = x[i] * x[i];        /* "x[i] squared" */
 158                         xi3 = xi2 * x[i];         /* "x[i] cubed" */
 159
 160                         b = (ydelta - (c * (xi2 - xim12)) - (d * (xi3 - xim13))) / xdelta;
 161
 162                         /* store */
 163
 164                         (*xx)->coeff[0] = y[i-1] - (b * x[i-1]) - (c * xim12) - (d * xim13);
 165                         (*xx)->coeff[1] = b;
 166                         (*xx)->coeff[2] = c;
 167                         (*xx)->coeff[3] = d;
 168
 169                         fplast = fpi;
 170                 }
 171
 172         }
 173
 174         _dirty = false;
 175 }
 176
 177 bool
 178 Curve::rt_safe_get_vector (double x0, double x1, float *vec, int32_t veclen)
 179 {
 180         Glib::Mutex::Lock lm(_list.lock(), Glib::TRY_LOCK);
 181
 182         if (!lm.locked()) {
 183                 return false;
 184         } else {
 185                 _get_vector (x0, x1, vec, veclen);
 186                 return true;
 187         }
 188 }
 189
 190 void
 191 Curve::get_vector (double x0, double x1, float *vec, int32_t veclen)
 192 {
 193         Glib::Mutex::Lock lm(_list.lock());
 194         _get_vector (x0, x1, vec, veclen);
 195 }
 196
 197 void
 198 Curve::_get_vector (double x0, double x1, float *vec, int32_t veclen)
 199 {
 200         double rx, dx, lx, hx, max_x, min_x;
 201         int32_t i;
 202         int32_t original_veclen;
 203         int32_t npoints;
 204
 205         if ((npoints = _list.events().size()) == 0) {
 206                 for (i = 0; i < veclen; ++i) {
 207                         vec[i] = _list.default_value();
 208                 }
 209                 return;
 210         }
 211
 212         /* events is now known not to be empty */
 213
 214         max_x = _list.events().back()->when;
 215         min_x = _list.events().front()->when;
 216
 217         lx = max (min_x, x0);
 218
 219         if (x1 < 0) {
 220                 x1 = _list.events().back()->when;
 221         }
 222
 223         hx = min (max_x, x1);
 224
 225         original_veclen = veclen;
 226
 227         if (x0 < min_x) {
 228
 229                 /* fill some beginning section of the array with the
 230                    initial (used to be default) value
 231                 */
 232
 233                 double frac = (min_x - x0) / (x1 - x0);
 234                 int32_t subveclen = (int32_t) floor (veclen * frac);
 235
 236                 subveclen = min (subveclen, veclen);
 237
 238                 for (i = 0; i < subveclen; ++i) {
 239                         vec[i] = _list.events().front()->value;
 240                 }
 241
 242                 veclen -= subveclen;
 243                 vec += subveclen;
 244         }
 245
 246         if (veclen && x1 > max_x) {
 247
 248                 /* fill some end section of the array with the default or final value */
 249
 250                 double frac = (x1 - max_x) / (x1 - x0);
 251
 252                 int32_t subveclen = (int32_t) floor (original_veclen * frac);
 253
 254                 float val;
 255
 256                 subveclen = min (subveclen, veclen);
 257
 258                 val = _list.events().back()->value;
 259
 260                 i = veclen - subveclen;
 261
 262                 for (i = veclen - subveclen; i < veclen; ++i) {
 263                         vec[i] = val;
 264                 }
 265
 266                 veclen -= subveclen;
 267         }
 268
 269         if (veclen == 0) {
 270                 return;
 271         }
 272
 273         if (npoints == 1 ) {
 274
 275                 for (i = 0; i < veclen; ++i) {
 276                         vec[i] = _list.events().front()->value;
 277                 }
 278                 return;
 279         }
 280
 281
 282         if (npoints == 2) {
 283
 284                 /* linear interpolation between 2 points */
 285
 286                 /* XXX I'm not sure that this is the right thing to
 287                    do here. but its not a common case for the envisaged
 288                    uses.
 289                 */
 290
 291                 if (veclen > 1) {
 292                         dx = (hx - lx) / (veclen - 1) ;
 293                 } else {
 294                         dx = 0; // not used
 295                 }
 296
 297                 double slope = (_list.events().back()->value - _list.events().front()->value)/
 298                         (_list.events().back()->when - _list.events().front()->when);
 299                 double yfrac = dx*slope;
 300
 301                 vec[0] = _list.events().front()->value + slope * (lx - _list.events().front()->when);
 302
 303                 for (i = 1; i < veclen; ++i) {
 304                         vec[i] = vec[i-1] + yfrac;
 305                 }
 306
 307                 return;
 308         }
 309
 310         if (_dirty) {
 311                 solve ();
 312         }
 313
 314         rx = lx;
 315
 316         if (veclen > 1) {
 317
 318                 dx = (hx - lx) / veclen;
 319
 320                 for (i = 0; i < veclen; ++i, rx += dx) {
 321                         vec[i] = multipoint_eval (rx);
 322                 }
 323         }
 324 }
 325
 326 double
 327 Curve::unlocked_eval (double x)
 328 {
 329         // I don't see the point of this...
 330
 331         if (_dirty) {
 332                 solve ();
 333         }
 334
 335         return _list.unlocked_eval (x);
 336 }
 337
 338 double
 339 Curve::multipoint_eval (double x)
 340 {
 341         pair<AutomationList::EventList::const_iterator,AutomationList::EventList::const_iterator> range;
 342
 343         AutomationList::LookupCache& lookup_cache = _list.lookup_cache();
 344
 345         if ((lookup_cache.left < 0) ||
 346             ((lookup_cache.left > x) ||
 347              (lookup_cache.range.first == _list.events().end()) ||
 348              ((*lookup_cache.range.second)->when < x))) {
 349
 350                 ControlEvent cp (x, 0.0);
 351
 352                 lookup_cache.range = equal_range (_list.events().begin(), _list.events().end(), &cp, AutomationList::time_comparator);
 353         }
 354
 355         range = lookup_cache.range;
 356
 357         /* EITHER
 358
 359            a) x is an existing control point, so first == existing point, second == next point
 360
 361            OR
 362
 363            b) x is between control points, so range is empty (first == second, points to where
 364                to insert x)
 365
 366         */
 367
 368         if (range.first == range.second) {
 369
 370                 /* x does not exist within the list as a control point */
 371
 372                 lookup_cache.left = x;
 373
 374                 if (range.first == _list.events().begin()) {
 375                         /* we're before the first point */
 376                         // return default_value;
 377                         _list.events().front()->value;
 378                 }
 379
 380                 if (range.second == _list.events().end()) {
 381                         /* we're after the last point */
 382                         return _list.events().back()->value;
 383                 }
 384
 385                 double x2 = x * x;
 386                 ControlEvent* ev = *range.second;
 387
 388                 return ev->coeff[0] + (ev->coeff[1] * x) + (ev->coeff[2] * x2) + (ev->coeff[3] * x2 * x);
 389         }
 390
 391         /* x is a control point in the data */
 392         /* invalidate the cached range because its not usable */
 393         lookup_cache.left = -1;
 394         return (*range.first)->value;
 395 }
 396
 397 extern "C" {
 398
 399 void
 400 curve_get_vector_from_c (void *arg, double x0, double x1, float* vec, int32_t vecsize)
 401 {
 402         static_cast<Curve*>(arg)->get_vector (x0, x1, vec, vecsize);
 403 }
 404
 405 }