libs/ardour/panner.cc

   1 /*
   2     Copyright (C) 2004 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 #define __STDC_FORMAT_MACROS 1
  21 #include <inttypes.h>
  22
  23 #include <cmath>
  24 #include <cerrno>
  25 #include <fstream>
  26 #include <cstdlib>
  27 #include <string>
  28 #include <cstdio>
  29 #include <locale.h>
  30 #include <unistd.h>
  31 #include <float.h>
  32
  33 #include <glibmm.h>
  34
  35 #include "pbd/error.h"
  36 #include "pbd/failed_constructor.h"
  37 #include "pbd/xml++.h"
  38 #include "pbd/enumwriter.h"
  39
  40 #include "evoral/Curve.hpp"
  41
  42 #include "ardour/session.h"
  43 #include "ardour/panner.h"
  44 #include "ardour/utils.h"
  45 #include "ardour/audio_buffer.h"
  46
  47 #include "ardour/runtime_functions.h"
  48 #include "ardour/buffer_set.h"
  49 #include "ardour/audio_buffer.h"
  50
  51 #include "i18n.h"
  52
  53 #include "pbd/mathfix.h"
  54
  55 using namespace std;
  56 using namespace ARDOUR;
  57 using namespace PBD;
  58
  59 float Panner::current_automation_version_number = 1.0;
  60
  61 string EqualPowerStereoPanner::name = "Equal Power Stereo";
  62 string Multi2dPanner::name = "Multiple (2D)";
  63
  64 /* this is a default mapper of  control values to a pan position
  65    others can be imagined.
  66 */
  67
  68 static pan_t direct_control_to_pan (double fract) {
  69         return fract;
  70 }
  71
  72
  73 //static double direct_pan_to_control (pan_t val) {
  74 //      return val;
  75 //}
  76
  77 StreamPanner::StreamPanner (Panner& p, Evoral::Parameter param)
  78         : parent (p)
  79 {
  80         assert(param.type() != NullAutomation);
  81
  82         _muted = false;
  83
  84         _control = boost::dynamic_pointer_cast<AutomationControl>( parent.control( param, true ) );
  85
  86         x = 0.5;
  87         y = 0.5;
  88         z = 0.5;
  89 }
  90
  91 StreamPanner::~StreamPanner ()
  92 {
  93 }
  94
  95 void
  96 Panner::PanControllable::set_value (float val)
  97 {
  98         panner.streampanner(parameter().id()).set_position (direct_control_to_pan (val));
  99         AutomationControl::set_value(val);
 100 }
 101
 102 float
 103 Panner::PanControllable::get_value (void) const
 104 {
 105         return AutomationControl::get_value();
 106 }
 107
 108 void
 109 StreamPanner::set_muted (bool yn)
 110 {
 111         if (yn != _muted) {
 112                 _muted = yn;
 113                 StateChanged ();
 114         }
 115 }
 116
 117 void
 118 StreamPanner::set_position (float xpos, bool link_call)
 119 {
 120         if (!link_call && parent.linked()) {
 121                 parent.set_position (xpos, *this);
 122         }
 123
 124         if (x != xpos) {
 125                 x = xpos;
 126                 update ();
 127                 Changed ();
 128                 _control->Changed ();
 129         }
 130 }
 131
 132 void
 133 StreamPanner::set_position (float xpos, float ypos, bool link_call)
 134 {
 135         if (!link_call && parent.linked()) {
 136                 parent.set_position (xpos, ypos, *this);
 137         }
 138
 139         if (x != xpos || y != ypos) {
 140
 141                 x = xpos;
 142                 y = ypos;
 143                 update ();
 144                 Changed ();
 145         }
 146 }
 147
 148 void
 149 StreamPanner::set_position (float xpos, float ypos, float zpos, bool link_call)
 150 {
 151         if (!link_call && parent.linked()) {
 152                 parent.set_position (xpos, ypos, zpos, *this);
 153         }
 154
 155         if (x != xpos || y != ypos || z != zpos) {
 156                 x = xpos;
 157                 y = ypos;
 158                 z = zpos;
 159                 update ();
 160                 Changed ();
 161         }
 162 }
 163
 164 int
 165 StreamPanner::set_state (const XMLNode& node)
 166 {
 167         const XMLProperty* prop;
 168         XMLNodeConstIterator iter;
 169
 170         if ((prop = node.property (X_("muted")))) {
 171                 set_muted (string_is_affirmative (prop->value()));
 172         }
 173
 174         return 0;
 175 }
 176
 177 void
 178 StreamPanner::add_state (XMLNode& node)
 179 {
 180         node.add_property (X_("muted"), (muted() ? "yes" : "no"));
 181 }
 182
 183 /*---------------------------------------------------------------------- */
 184
 185 BaseStereoPanner::BaseStereoPanner (Panner& p, Evoral::Parameter param)
 186         : StreamPanner (p, param)
 187 {
 188 }
 189
 190 BaseStereoPanner::~BaseStereoPanner ()
 191 {
 192 }
 193
 194 int
 195 BaseStereoPanner::load (istream& in, string path, uint32_t& linecnt)
 196 {
 197         char line[128];
 198         LocaleGuard lg (X_("POSIX"));
 199
 200         _control->list()->clear ();
 201
 202         while (in.getline (line, sizeof (line), '\n')) {
 203                 nframes_t when;
 204                 double value;
 205
 206                 ++linecnt;
 207
 208                 if (strcmp (line, "end") == 0) {
 209                         break;
 210                 }
 211
 212                 if (sscanf (line, "%" PRIu32 " %lf", &when, &value) != 2) {
 213                         warning << string_compose(_("badly formatted pan automation event record at line %1 of %2 (ignored) [%3]"), linecnt, path, line) << endmsg;
 214                         continue;
 215                 }
 216
 217                 _control->list()->fast_simple_add (when, value);
 218         }
 219
 220         /* now that we are done loading */
 221
 222         ((AutomationList*)_control->list().get())->StateChanged ();
 223
 224         return 0;
 225 }
 226
 227 void
 228 BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
 229 {
 230         assert(obufs.count().n_audio() == 2);
 231
 232         pan_t delta;
 233         Sample* dst;
 234         pan_t pan;
 235
 236         if (_muted) {
 237                 return;
 238         }
 239
 240         Sample* const src = srcbuf.data();
 241
 242         /* LEFT */
 243
 244         dst = obufs.get_audio(0).data();
 245
 246         if (fabsf ((delta = (left - desired_left))) > 0.002) { // about 1 degree of arc
 247
 248                 /* interpolate over 64 frames or nframes, whichever is smaller */
 249
 250                 nframes_t limit = min ((nframes_t)64, nframes);
 251                 nframes_t n;
 252
 253                 delta = -(delta / (float) (limit));
 254
 255                 for (n = 0; n < limit; n++) {
 256                         left_interp = left_interp + delta;
 257                         left = left_interp + 0.9 * (left - left_interp);
 258                         dst[n] += src[n] * left * gain_coeff;
 259                 }
 260
 261                 pan = left * gain_coeff;
 262
 263                 mix_buffers_with_gain (dst+n,src+n,nframes-n,pan);
 264
 265         } else {
 266
 267                 left = desired_left;
 268                 left_interp = left;
 269
 270                 if ((pan = (left * gain_coeff)) != 1.0f) {
 271
 272                         if (pan != 0.0f) {
 273
 274                                 mix_buffers_with_gain(dst,src,nframes,pan);
 275
 276                                 /* mark that we wrote into the buffer */
 277
 278                                 // obufs[0] = 0;
 279
 280                         }
 281
 282                 } else {
 283
 284                         mix_buffers_no_gain(dst,src,nframes);
 285
 286                         /* mark that we wrote into the buffer */
 287
 288                         // obufs[0] = 0;
 289                 }
 290         }
 291
 292         /* RIGHT */
 293
 294         dst = obufs.get_audio(1).data();
 295
 296         if (fabsf ((delta = (right - desired_right))) > 0.002) { // about 1 degree of arc
 297
 298                 /* interpolate over 64 frames or nframes, whichever is smaller */
 299
 300                 nframes_t limit = min ((nframes_t)64, nframes);
 301                 nframes_t n;
 302
 303                 delta = -(delta / (float) (limit));
 304
 305                 for (n = 0; n < limit; n++) {
 306                         right_interp = right_interp + delta;
 307                         right = right_interp + 0.9 * (right - right_interp);
 308                         dst[n] += src[n] * right * gain_coeff;
 309                 }
 310
 311                 pan = right * gain_coeff;
 312
 313                 mix_buffers_with_gain(dst+n,src+n,nframes-n,pan);
 314
 315                 /* XXX it would be nice to mark the buffer as written to */
 316
 317         } else {
 318
 319                 right = desired_right;
 320                 right_interp = right;
 321
 322                 if ((pan = (right * gain_coeff)) != 1.0f) {
 323
 324                         if (pan != 0.0f) {
 325
 326                                 mix_buffers_with_gain(dst,src,nframes,pan);
 327
 328                                 /* XXX it would be nice to mark the buffer as written to */
 329                         }
 330
 331                 } else {
 332
 333                         mix_buffers_no_gain(dst,src,nframes);
 334
 335                         /* XXX it would be nice to mark the buffer as written to */
 336                 }
 337         }
 338 }
 339
 340 /*---------------------------------------------------------------------- */
 341
 342 EqualPowerStereoPanner::EqualPowerStereoPanner (Panner& p, Evoral::Parameter param)
 343         : BaseStereoPanner (p, param)
 344 {
 345         update ();
 346
 347         left = desired_left;
 348         right = desired_right;
 349         left_interp = left;
 350         right_interp = right;
 351 }
 352
 353 EqualPowerStereoPanner::~EqualPowerStereoPanner ()
 354 {
 355 }
 356
 357 void
 358 EqualPowerStereoPanner::update ()
 359 {
 360         /* it would be very nice to split this out into a virtual function
 361            that can be accessed from BaseStereoPanner and used in distribute_automated().
 362
 363            but the place where its used in distribute_automated() is a tight inner loop,
 364            and making "nframes" virtual function calls to compute values is an absurd
 365            overhead.
 366         */
 367
 368         /* x == 0 => hard left
 369            x == 1 => hard right
 370         */
 371
 372         float panR = x;
 373         float panL = 1 - panR;
 374
 375         const float pan_law_attenuation = -3.0f;
 376         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 377
 378         desired_left = panL * (scale * panL + 1.0f - scale);
 379         desired_right = panR * (scale * panR + 1.0f - scale);
 380
 381         effective_x = x;
 382         //_control->set_value(x);
 383 }
 384
 385 void
 386 EqualPowerStereoPanner::distribute_automated (AudioBuffer& srcbuf, BufferSet& obufs,
 387                                               nframes_t start, nframes_t end, nframes_t nframes,
 388                                               pan_t** buffers)
 389 {
 390         assert(obufs.count().n_audio() == 2);
 391
 392         Sample* dst;
 393         pan_t* pbuf;
 394         Sample* const src = srcbuf.data();
 395
 396         /* fetch positional data */
 397
 398         if (!_control->list()->curve().rt_safe_get_vector (start, end, buffers[0], nframes)) {
 399                 /* fallback */
 400                 if (!_muted) {
 401                         distribute (srcbuf, obufs, 1.0, nframes);
 402                 }
 403                 return;
 404         }
 405
 406         /* store effective pan position. do this even if we are muted */
 407
 408         if (nframes > 0) {
 409                 effective_x = buffers[0][nframes-1];
 410         }
 411
 412         if (_muted) {
 413                 return;
 414         }
 415
 416         /* apply pan law to convert positional data into pan coefficients for
 417            each buffer (output)
 418         */
 419
 420         const float pan_law_attenuation = -3.0f;
 421         const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 422
 423         for (nframes_t n = 0; n < nframes; ++n) {
 424
 425                 float panR = buffers[0][n];
 426                 float panL = 1 - panR;
 427
 428                 buffers[0][n] = panL * (scale * panL + 1.0f - scale);
 429                 buffers[1][n] = panR * (scale * panR + 1.0f - scale);
 430         }
 431
 432         /* LEFT */
 433
 434         dst = obufs.get_audio(0).data();
 435         pbuf = buffers[0];
 436
 437         for (nframes_t n = 0; n < nframes; ++n) {
 438                 dst[n] += src[n] * pbuf[n];
 439         }
 440
 441         /* XXX it would be nice to mark the buffer as written to */
 442
 443         /* RIGHT */
 444
 445         dst = obufs.get_audio(1).data();
 446         pbuf = buffers[1];
 447
 448         for (nframes_t n = 0; n < nframes; ++n) {
 449                 dst[n] += src[n] * pbuf[n];
 450         }
 451
 452         /* XXX it would be nice to mark the buffer as written to */
 453 }
 454
 455 StreamPanner*
 456 EqualPowerStereoPanner::factory (Panner& parent, Evoral::Parameter param)
 457 {
 458         return new EqualPowerStereoPanner (parent, param);
 459 }
 460
 461 XMLNode&
 462 EqualPowerStereoPanner::get_state (void)
 463 {
 464         return state (true);
 465 }
 466
 467 XMLNode&
 468 EqualPowerStereoPanner::state (bool /*full_state*/)
 469 {
 470         XMLNode* root = new XMLNode ("StreamPanner");
 471         char buf[64];
 472         LocaleGuard lg (X_("POSIX"));
 473
 474         snprintf (buf, sizeof (buf), "%.12g", x);
 475         root->add_property (X_("x"), buf);
 476         root->add_property (X_("type"), EqualPowerStereoPanner::name);
 477
 478         // XXX: dont save automation here... its part of the automatable panner now.
 479
 480         StreamPanner::add_state (*root);
 481
 482         root->add_child_nocopy (_control->get_state ());
 483
 484         return *root;
 485 }
 486
 487 int
 488 EqualPowerStereoPanner::set_state (const XMLNode& node)
 489 {
 490         const XMLProperty* prop;
 491         float pos;
 492         LocaleGuard lg (X_("POSIX"));
 493
 494         if ((prop = node.property (X_("x")))) {
 495                 pos = atof (prop->value().c_str());
 496                 set_position (pos, true);
 497         }
 498
 499         StreamPanner::set_state (node);
 500
 501         for (XMLNodeConstIterator iter = node.children().begin(); iter != node.children().end(); ++iter) {
 502
 503                 if ((*iter)->name() == X_("Controllable")) {
 504                         if ((prop = (*iter)->property("name")) != 0 && prop->value() == "panner") {
 505                                 _control->set_state (**iter);
 506                         }
 507
 508                 } else if ((*iter)->name() == X_("Automation")) {
 509
 510                         _control->alist()->set_state (*((*iter)->children().front()));
 511
 512                         if (_control->alist()->automation_state() != Off) {
 513                                 set_position (_control->list()->eval (parent.session().transport_frame()));
 514                         }
 515                 }
 516         }
 517
 518         return 0;
 519 }
 520
 521 /*----------------------------------------------------------------------*/
 522
 523 Multi2dPanner::Multi2dPanner (Panner& p, Evoral::Parameter param)
 524         : StreamPanner (p, param)
 525 {
 526         update ();
 527 }
 528
 529 Multi2dPanner::~Multi2dPanner ()
 530 {
 531 }
 532
 533 void
 534 Multi2dPanner::update ()
 535 {
 536         static const float BIAS = FLT_MIN;
 537         uint32_t i;
 538         uint32_t nouts = parent.outputs.size();
 539         float dsq[nouts];
 540         float f, fr;
 541         vector<pan_t> pans;
 542
 543         f = 0.0f;
 544
 545         for (i = 0; i < nouts; i++) {
 546                 dsq[i] = ((x - parent.outputs[i].x) * (x - parent.outputs[i].x) + (y - parent.outputs[i].y) * (y - parent.outputs[i].y) + BIAS);
 547                 if (dsq[i] < 0.0) {
 548                         dsq[i] = 0.0;
 549                 }
 550                 f += dsq[i] * dsq[i];
 551         }
 552 #ifdef __APPLE__
 553         // terrible hack to support OSX < 10.3.9 builds
 554         fr = (float) (1.0 / sqrt((double)f));
 555 #else
 556         fr = 1.0 / sqrtf(f);
 557 #endif
 558         for (i = 0; i < nouts; ++i) {
 559                 parent.outputs[i].desired_pan = 1.0f - (dsq[i] * fr);
 560         }
 561
 562         effective_x = x;
 563 }
 564
 565 void
 566 Multi2dPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
 567 {
 568         Sample* dst;
 569         pan_t pan;
 570         vector<Panner::Output>::iterator o;
 571         uint32_t n;
 572
 573         if (_muted) {
 574                 return;
 575         }
 576
 577         Sample* const src = srcbuf.data();
 578
 579
 580         for (n = 0, o = parent.outputs.begin(); o != parent.outputs.end(); ++o, ++n) {
 581
 582                 dst = obufs.get_audio(n).data();
 583
 584 #ifdef CAN_INTERP
 585                 if (fabsf ((delta = (left_interp - desired_left))) > 0.002) { // about 1 degree of arc
 586
 587                         /* interpolate over 64 frames or nframes, whichever is smaller */
 588
 589                         nframes_t limit = min ((nframes_t)64, nframes);
 590                         nframes_t n;
 591
 592                         delta = -(delta / (float) (limit));
 593
 594                         for (n = 0; n < limit; n++) {
 595                                 left_interp = left_interp + delta;
 596                                 left = left_interp + 0.9 * (left - left_interp);
 597                                 dst[n] += src[n] * left * gain_coeff;
 598                         }
 599
 600                         pan = left * gain_coeff;
 601                         mix_buffers_with_gain(dst+n,src+n,nframes-n,pan);
 602
 603                 } else {
 604
 605 #else
 606                         pan = (*o).desired_pan;
 607
 608                         if ((pan *= gain_coeff) != 1.0f) {
 609
 610                                 if (pan != 0.0f) {
 611                                         mix_buffers_with_gain(dst,src,nframes,pan);
 612                                 }
 613                         } else {
 614                                         mix_buffers_no_gain(dst,src,nframes);
 615                         }
 616 #endif
 617 #ifdef CAN_INTERP
 618                 }
 619 #endif
 620         }
 621
 622         return;
 623 }
 624
 625 void
 626 Multi2dPanner::distribute_automated (AudioBuffer& /*src*/, BufferSet& /*obufs*/,
 627                                      nframes_t /*start*/, nframes_t /*end*/, nframes_t /*nframes*/,
 628                                      pan_t** /*buffers*/)
 629 {
 630         if (_muted) {
 631                 return;
 632         }
 633
 634         /* what ? */
 635
 636         return;
 637 }
 638
 639 StreamPanner*
 640 Multi2dPanner::factory (Panner& p, Evoral::Parameter param)
 641 {
 642         return new Multi2dPanner (p, param);
 643 }
 644
 645 int
 646 Multi2dPanner::load (istream& /*in*/, string /*path*/, uint32_t& /*linecnt*/)
 647 {
 648         return 0;
 649 }
 650
 651 XMLNode&
 652 Multi2dPanner::get_state (void)
 653 {
 654         return state (true);
 655 }
 656
 657 XMLNode&
 658 Multi2dPanner::state (bool /*full_state*/)
 659 {
 660         XMLNode* root = new XMLNode ("StreamPanner");
 661         char buf[64];
 662         LocaleGuard lg (X_("POSIX"));
 663
 664         snprintf (buf, sizeof (buf), "%.12g", x);
 665         root->add_property (X_("x"), buf);
 666         snprintf (buf, sizeof (buf), "%.12g", y);
 667         root->add_property (X_("y"), buf);
 668         root->add_property (X_("type"), Multi2dPanner::name);
 669
 670         /* XXX no meaningful automation yet */
 671
 672         return *root;
 673 }
 674
 675 int
 676 Multi2dPanner::set_state (const XMLNode& node)
 677 {
 678         const XMLProperty* prop;
 679         float newx,newy;
 680         LocaleGuard lg (X_("POSIX"));
 681
 682         newx = -1;
 683         newy = -1;
 684
 685         if ((prop = node.property (X_("x")))) {
 686                 newx = atof (prop->value().c_str());
 687         }
 688
 689         if ((prop = node.property (X_("y")))) {
 690                 newy = atof (prop->value().c_str());
 691         }
 692
 693         if (x < 0 || y < 0) {
 694                 error << _("badly-formed positional data for Multi2dPanner - ignored")
 695                       << endmsg;
 696                 return -1;
 697         }
 698
 699         set_position (newx, newy);
 700         return 0;
 701 }
 702
 703 /*---------------------------------------------------------------------- */
 704
 705 Panner::Panner (string name, Session& s)
 706         : SessionObject (s, name)
 707         , AutomatableControls (s)
 708 {
 709         //set_name_old_auto (name);
 710         set_name (name);
 711
 712         _linked = false;
 713         _link_direction = SameDirection;
 714         _bypassed = false;
 715 }
 716
 717 Panner::~Panner ()
 718 {
 719 }
 720
 721 void
 722 Panner::set_linked (bool yn)
 723 {
 724         if (yn != _linked) {
 725                 _linked = yn;
 726                 _session.set_dirty ();
 727                 LinkStateChanged (); /* EMIT SIGNAL */
 728         }
 729 }
 730
 731 void
 732 Panner::set_link_direction (LinkDirection ld)
 733 {
 734         if (ld != _link_direction) {
 735                 _link_direction = ld;
 736                 _session.set_dirty ();
 737                 LinkStateChanged (); /* EMIT SIGNAL */
 738         }
 739 }
 740
 741
 742 void
 743 Panner::set_bypassed (bool yn)
 744 {
 745         if (yn != _bypassed) {
 746                 _bypassed = yn;
 747                 StateChanged ();
 748         }
 749 }
 750
 751
 752 void
 753 Panner::reset_to_default ()
 754 {
 755         vector<float> positions;
 756
 757         switch (outputs.size()) {
 758         case 0:
 759         case 1:
 760                 return;
 761         }
 762
 763         if (outputs.size() == 2) {
 764                 switch (_streampanners.size()) {
 765                 case 1:
 766                         _streampanners.front()->set_position (0.5);
 767                         _streampanners.front()->pan_control()->list()->reset_default (0.5);
 768                         return;
 769                         break;
 770                 case 2:
 771                         _streampanners.front()->set_position (0.0);
 772                         _streampanners.front()->pan_control()->list()->reset_default (0.0);
 773                         _streampanners.back()->set_position (1.0);
 774                         _streampanners.back()->pan_control()->list()->reset_default (1.0);
 775                         return;
 776                 default:
 777                         break;
 778                 }
 779         }
 780
 781         vector<Output>::iterator o;
 782         vector<StreamPanner*>::iterator p;
 783
 784         for (o = outputs.begin(), p = _streampanners.begin(); o != outputs.end() && p != _streampanners.end(); ++o, ++p) {
 785                 (*p)->set_position ((*o).x, (*o).y);
 786         }
 787 }
 788
 789 void
 790 Panner::reset_streampanner (uint32_t which)
 791 {
 792         if (which >= _streampanners.size() || which >= outputs.size()) {
 793                 return;
 794         }
 795
 796         switch (outputs.size()) {
 797         case 0:
 798         case 1:
 799                 return;
 800
 801         case 2:
 802                 switch (_streampanners.size()) {
 803                 case 1:
 804                         /* stereo out, 1 stream, default = middle */
 805                         _streampanners.front()->set_position (0.5);
 806                         _streampanners.front()->pan_control()->list()->reset_default (0.5);
 807                         break;
 808                 case 2:
 809                         /* stereo out, 2 streams, default = hard left/right */
 810                         if (which == 0) {
 811                                 _streampanners.front()->set_position (0.0);
 812                                 _streampanners.front()->pan_control()->list()->reset_default (0.0);
 813                         } else {
 814                                 _streampanners.back()->set_position (1.0);
 815                                 _streampanners.back()->pan_control()->list()->reset_default (1.0);
 816                         }
 817                         break;
 818                 }
 819                 return;
 820
 821         default:
 822                 _streampanners[which]->set_position (outputs[which].x, outputs[which].y);
 823         }
 824 }
 825
 826 void
 827 Panner::reset (uint32_t nouts, uint32_t npans)
 828 {
 829         uint32_t n;
 830         bool changed = false;
 831         bool do_not_and_did_not_need_panning = ((nouts < 2) && (outputs.size() < 2));
 832
 833         /* if new and old config don't need panning, or if
 834            the config hasn't changed, we're done.
 835         */
 836
 837         if (do_not_and_did_not_need_panning ||
 838             ((nouts == outputs.size()) && (npans == _streampanners.size()))) {
 839                 return;
 840         }
 841
 842         n = _streampanners.size();
 843         clear_panners ();
 844
 845         if (n != npans) {
 846                 changed = true;
 847         }
 848
 849         n = outputs.size();
 850         outputs.clear ();
 851
 852         if (n != nouts) {
 853                 changed = true;
 854         }
 855
 856         if (nouts < 2) {
 857                 /* no need for panning with less than 2 outputs */
 858                 goto send_changed;
 859         }
 860
 861         switch (nouts) {
 862         case 0:
 863                 /* XXX: this can never happen */
 864                 break;
 865
 866         case 1:
 867                 /* XXX: this can never happen */
 868                 fatal << _("programming error:")
 869                       << X_("Panner::reset() called with a single output")
 870                       << endmsg;
 871                 /*NOTREACHED*/
 872                 break;
 873
 874         case 2: // line
 875                 outputs.push_back (Output (0, 0));
 876                 outputs.push_back (Output (1.0, 0));
 877
 878                 for (n = 0; n < npans; ++n) {
 879                         _streampanners.push_back (new EqualPowerStereoPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 880                 }
 881                 break;
 882
 883         case 3: // triangle
 884                 outputs.push_back (Output  (0.5, 0));
 885                 outputs.push_back (Output  (0, 1.0));
 886                 outputs.push_back (Output  (1.0, 1.0));
 887
 888                 for (n = 0; n < npans; ++n) {
 889                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 890                 }
 891
 892                 break;
 893
 894         case 4: // square
 895                 outputs.push_back (Output  (0, 0));
 896                 outputs.push_back (Output  (1.0, 0));
 897                 outputs.push_back (Output  (1.0, 1.0));
 898                 outputs.push_back (Output  (0, 1.0));
 899
 900                 for (n = 0; n < npans; ++n) {
 901                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 902                 }
 903
 904                 break;
 905
 906         case 5: //square+offcenter center
 907                 outputs.push_back (Output  (0, 0));
 908                 outputs.push_back (Output  (1.0, 0));
 909                 outputs.push_back (Output  (1.0, 1.0));
 910                 outputs.push_back (Output  (0, 1.0));
 911                 outputs.push_back (Output  (0.5, 0.75));
 912
 913                 for (n = 0; n < npans; ++n) {
 914                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 915                 }
 916
 917                 break;
 918
 919         default:
 920                 /* XXX horrible placement. FIXME */
 921                 for (n = 0; n < nouts; ++n) {
 922                         outputs.push_back (Output (0.1 * n, 0.1 * n));
 923                 }
 924
 925                 for (n = 0; n < npans; ++n) {
 926                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 927                 }
 928
 929                 break;
 930         }
 931
 932         for (std::vector<StreamPanner*>::iterator x = _streampanners.begin(); x != _streampanners.end(); ++x) {
 933                 (*x)->update ();
 934         }
 935
 936         /* force hard left/right panning in a common case: 2in/2out
 937         */
 938
 939         if (npans == 2 && outputs.size() == 2) {
 940
 941                 /* Do this only if we changed configuration, or our configuration
 942                    appears to be the default set up (center).
 943                 */
 944
 945                 float left;
 946                 float right;
 947
 948                 _streampanners.front()->get_position (left);
 949                 _streampanners.back()->get_position (right);
 950
 951                 if (changed || ((left == 0.5) && (right == 0.5))) {
 952
 953                         _streampanners.front()->set_position (0.0);
 954                         _streampanners.front()->pan_control()->list()->reset_default (0.0);
 955
 956                         _streampanners.back()->set_position (1.0);
 957                         _streampanners.back()->pan_control()->list()->reset_default (1.0);
 958
 959                         changed = true;
 960                 }
 961         }
 962
 963   send_changed:
 964         if (changed) {
 965                 Changed (); /* EMIT SIGNAL */
 966         }
 967
 968         return;
 969 }
 970
 971 void
 972 Panner::remove (uint32_t which)
 973 {
 974         vector<StreamPanner*>::iterator i;
 975         for (i = _streampanners.begin(); i != _streampanners.end() && which; ++i, --which) {}
 976
 977         if (i != _streampanners.end()) {
 978                 delete *i;
 979                 _streampanners.erase (i);
 980         }
 981 }
 982
 983
 984 /** Remove all our StreamPanners */
 985 void
 986 Panner::clear_panners ()
 987 {
 988         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
 989                 delete *i;
 990         }
 991
 992         _streampanners.clear ();
 993 }
 994
 995 void
 996 Panner::set_automation_style (AutoStyle style)
 997 {
 998         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
 999                 ((AutomationList*)(*i)->pan_control()->list().get())->set_automation_style (style);
1000         }
1001         _session.set_dirty ();
1002 }
1003
1004 void
1005 Panner::set_automation_state (AutoState state)
1006 {
1007         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1008                 ((AutomationList*)(*i)->pan_control()->list().get())->set_automation_state (state);
1009         }
1010         _session.set_dirty ();
1011 }
1012
1013 AutoState
1014 Panner::automation_state () const
1015 {
1016         boost::shared_ptr<AutomationList> l;
1017         if (!empty()) {
1018                 boost::shared_ptr<AutomationControl> control = _streampanners.front()->pan_control();
1019                 if (control) {
1020                         l = boost::dynamic_pointer_cast<AutomationList>(control->list());
1021                 }
1022         }
1023
1024         return l ? l->automation_state() : Off;
1025 }
1026
1027 AutoStyle
1028 Panner::automation_style () const
1029 {
1030         boost::shared_ptr<AutomationList> l;
1031         if (!empty()) {
1032                 boost::shared_ptr<AutomationControl> control = _streampanners.front()->pan_control();
1033                 if (control) {
1034                         l = boost::dynamic_pointer_cast<AutomationList>(control->list());
1035                 }
1036         }
1037
1038         return l ? l->automation_style() : Absolute;
1039 }
1040
1041 struct PanPlugins {
1042     string name;
1043     uint32_t nouts;
1044     StreamPanner* (*factory)(Panner&, Evoral::Parameter);
1045 };
1046
1047 PanPlugins pan_plugins[] = {
1048         { EqualPowerStereoPanner::name, 2, EqualPowerStereoPanner::factory },
1049         { Multi2dPanner::name, 3, Multi2dPanner::factory },
1050         { string (""), 0, 0 }
1051 };
1052
1053 XMLNode&
1054 Panner::get_state (void)
1055 {
1056         return state (true);
1057 }
1058
1059 XMLNode&
1060 Panner::state (bool full)
1061 {
1062         XMLNode* node = new XMLNode ("Panner");
1063
1064         char buf[32];
1065
1066         node->add_property (X_("linked"), (_linked ? "yes" : "no"));
1067         node->add_property (X_("link_direction"), enum_2_string (_link_direction));
1068         node->add_property (X_("bypassed"), (bypassed() ? "yes" : "no"));
1069
1070         for (vector<Panner::Output>::iterator o = outputs.begin(); o != outputs.end(); ++o) {
1071                 XMLNode* onode = new XMLNode (X_("Output"));
1072                 snprintf (buf, sizeof (buf), "%.12g", (*o).x);
1073                 onode->add_property (X_("x"), buf);
1074                 snprintf (buf, sizeof (buf), "%.12g", (*o).y);
1075                 onode->add_property (X_("y"), buf);
1076                 node->add_child_nocopy (*onode);
1077         }
1078
1079         for (vector<StreamPanner*>::const_iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1080                 node->add_child_nocopy ((*i)->state (full));
1081         }
1082
1083
1084         return *node;
1085 }
1086
1087 int
1088 Panner::set_state (const XMLNode& node)
1089 {
1090         XMLNodeList nlist;
1091         XMLNodeConstIterator niter;
1092         const XMLProperty *prop;
1093         uint32_t i;
1094         uint32_t num_panners = 0;
1095         StreamPanner* sp;
1096         LocaleGuard lg (X_("POSIX"));
1097
1098         clear_panners ();
1099
1100         ChanCount ins = ChanCount::ZERO;
1101         ChanCount outs = ChanCount::ZERO;
1102
1103         // XXX: this might not be necessary anymore
1104         outputs.clear ();
1105
1106         if ((prop = node.property (X_("linked"))) != 0) {
1107                 set_linked (string_is_affirmative (prop->value()));
1108         }
1109
1110
1111         if ((prop = node.property (X_("bypassed"))) != 0) {
1112                 set_bypassed (string_is_affirmative (prop->value()));
1113         }
1114
1115         if ((prop = node.property (X_("link_direction"))) != 0) {
1116                 LinkDirection ld; /* here to provide type information */
1117                 set_link_direction (LinkDirection (string_2_enum (prop->value(), ld)));
1118         }
1119
1120         nlist = node.children();
1121
1122         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1123                 if ((*niter)->name() == X_("Output")) {
1124
1125                         float x, y;
1126
1127                         prop = (*niter)->property (X_("x"));
1128                         sscanf (prop->value().c_str(), "%g", &x);
1129
1130                         prop = (*niter)->property (X_("y"));
1131                         sscanf (prop->value().c_str(), "%g", &y);
1132
1133                         outputs.push_back (Output (x, y));
1134                 }
1135         }
1136
1137         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1138
1139                 if ((*niter)->name() == X_("StreamPanner")) {
1140
1141                         if ((prop = (*niter)->property (X_("type")))) {
1142
1143                                 for (i = 0; pan_plugins[i].factory; ++i) {
1144                                         if (prop->value() == pan_plugins[i].name) {
1145
1146
1147                                                 /* note that we assume that all the stream panners
1148                                                    are of the same type. pretty good
1149                                                    assumption, but it's still an assumption.
1150                                                 */
1151
1152                                                 sp = pan_plugins[i].factory (*this, Evoral::Parameter(PanAutomation, 0, num_panners));
1153                                                 num_panners++;
1154
1155                                                 if (sp->set_state (**niter) == 0) {
1156                                                         _streampanners.push_back (sp);
1157                                                 }
1158
1159                                                 break;
1160                                         }
1161                                 }
1162
1163
1164                                 if (!pan_plugins[i].factory) {
1165                                         error << string_compose (_("Unknown panner plugin \"%1\" found in pan state - ignored"),
1166                                                           prop->value())
1167                                               << endmsg;
1168                                 }
1169
1170                         } else {
1171                                 error << _("panner plugin node has no type information!")
1172                                       << endmsg;
1173                                 return -1;
1174                         }
1175
1176                 }
1177         }
1178
1179         reset (outputs.size (), num_panners);
1180         /* don't try to do old-school automation loading if it wasn't marked as existing */
1181
1182         if ((prop = node.property (X_("automation")))) {
1183
1184                 /* automation path is relative */
1185
1186                 automation_path = Glib::build_filename(_session.automation_dir(), prop->value ());
1187         }
1188
1189         return 0;
1190 }
1191
1192 bool
1193 Panner::touching () const
1194 {
1195         for (vector<StreamPanner*>::const_iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1196                 if (((AutomationList*)(*i)->pan_control()->list().get())->touching ()) {
1197                         return true;
1198                 }
1199         }
1200
1201         return false;
1202 }
1203
1204 void
1205 Panner::set_position (float xpos, StreamPanner& orig)
1206 {
1207         float xnow;
1208         float xdelta ;
1209         float xnew;
1210
1211         orig.get_position (xnow);
1212         xdelta = xpos - xnow;
1213
1214         if (_link_direction == SameDirection) {
1215
1216                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1217                         if (*i == &orig) {
1218                                 (*i)->set_position (xpos, true);
1219                         } else {
1220                                 (*i)->get_position (xnow);
1221                                 xnew = min (1.0f, xnow + xdelta);
1222                                 xnew = max (0.0f, xnew);
1223                                 (*i)->set_position (xnew, true);
1224                         }
1225                 }
1226
1227         } else {
1228
1229                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1230                         if (*i == &orig) {
1231                                 (*i)->set_position (xpos, true);
1232                         } else {
1233                                 (*i)->get_position (xnow);
1234                                 xnew = min (1.0f, xnow - xdelta);
1235                                 xnew = max (0.0f, xnew);
1236                                 (*i)->set_position (xnew, true);
1237                         }
1238                 }
1239         }
1240 }
1241
1242 void
1243 Panner::set_position (float xpos, float ypos, StreamPanner& orig)
1244 {
1245         float xnow, ynow;
1246         float xdelta, ydelta;
1247         float xnew, ynew;
1248
1249         orig.get_position (xnow, ynow);
1250         xdelta = xpos - xnow;
1251         ydelta = ypos - ynow;
1252
1253         if (_link_direction == SameDirection) {
1254
1255                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1256                         if (*i == &orig) {
1257                                 (*i)->set_position (xpos, ypos, true);
1258                         } else {
1259                                 (*i)->get_position (xnow, ynow);
1260
1261                                 xnew = min (1.0f, xnow + xdelta);
1262                                 xnew = max (0.0f, xnew);
1263
1264                                 ynew = min (1.0f, ynow + ydelta);
1265                                 ynew = max (0.0f, ynew);
1266
1267                                 (*i)->set_position (xnew, ynew, true);
1268                         }
1269                 }
1270
1271         } else {
1272
1273                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1274                         if (*i == &orig) {
1275                                 (*i)->set_position (xpos, ypos, true);
1276                         } else {
1277                                 (*i)->get_position (xnow, ynow);
1278
1279                                 xnew = min (1.0f, xnow - xdelta);
1280                                 xnew = max (0.0f, xnew);
1281
1282                                 ynew = min (1.0f, ynow - ydelta);
1283                                 ynew = max (0.0f, ynew);
1284
1285                                 (*i)->set_position (xnew, ynew, true);
1286                         }
1287                 }
1288         }
1289 }
1290
1291 void
1292 Panner::set_position (float xpos, float ypos, float zpos, StreamPanner& orig)
1293 {
1294         float xnow, ynow, znow;
1295         float xdelta, ydelta, zdelta;
1296         float xnew, ynew, znew;
1297
1298         orig.get_position (xnow, ynow, znow);
1299         xdelta = xpos - xnow;
1300         ydelta = ypos - ynow;
1301         zdelta = zpos - znow;
1302
1303         if (_link_direction == SameDirection) {
1304
1305                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1306                         if (*i == &orig) {
1307                                 (*i)->set_position (xpos, ypos, zpos, true);
1308                         } else {
1309                                 (*i)->get_position (xnow, ynow, znow);
1310
1311                                 xnew = min (1.0f, xnow + xdelta);
1312                                 xnew = max (0.0f, xnew);
1313
1314                                 ynew = min (1.0f, ynow + ydelta);
1315                                 ynew = max (0.0f, ynew);
1316
1317                                 znew = min (1.0f, znow + zdelta);
1318                                 znew = max (0.0f, znew);
1319
1320                                 (*i)->set_position (xnew, ynew, znew, true);
1321                         }
1322                 }
1323
1324         } else {
1325
1326                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1327                         if (*i == &orig) {
1328                                 (*i)->set_position (xpos, ypos, true);
1329                         } else {
1330                                 (*i)->get_position (xnow, ynow, znow);
1331
1332                                 xnew = min (1.0f, xnow - xdelta);
1333                                 xnew = max (0.0f, xnew);
1334
1335                                 ynew = min (1.0f, ynow - ydelta);
1336                                 ynew = max (0.0f, ynew);
1337
1338                                 znew = min (1.0f, znow + zdelta);
1339                                 znew = max (0.0f, znew);
1340
1341                                 (*i)->set_position (xnew, ynew, znew, true);
1342                         }
1343                 }
1344         }
1345 }
1346
1347 void
1348 Panner::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, nframes_t nframes, gain_t gain_coeff)
1349 {
1350         if (outbufs.count().n_audio() == 0) {
1351                 // Don't want to lose audio...
1352                 assert(inbufs.count().n_audio() == 0);
1353                 return;
1354         }
1355
1356         // We shouldn't be called in the first place...
1357         assert(!bypassed());
1358         assert(!empty());
1359
1360
1361         if (outbufs.count().n_audio() == 1) {
1362
1363                 AudioBuffer& dst = outbufs.get_audio(0);
1364
1365                 if (gain_coeff == 0.0f) {
1366
1367                         /* only one output, and gain was zero, so make it silent */
1368
1369                         dst.silence (nframes);
1370
1371                 } else if (gain_coeff == 1.0f){
1372
1373                         /* mix all buffers into the output */
1374
1375                         // copy the first
1376                         dst.read_from(inbufs.get_audio(0), nframes);
1377
1378                         // accumulate starting with the second
1379                         if (inbufs.count().n_audio() > 0) {
1380                                 BufferSet::audio_iterator i = inbufs.audio_begin();
1381                                 for (++i; i != inbufs.audio_end(); ++i) {
1382                                         dst.merge_from(*i, nframes);
1383                                 }
1384                         }
1385
1386                 } else {
1387
1388                         /* mix all buffers into the output, scaling them all by the gain */
1389
1390                         // copy the first
1391                         dst.read_from(inbufs.get_audio(0), nframes);
1392
1393                         // accumulate (with gain) starting with the second
1394                         if (inbufs.count().n_audio() > 0) {
1395                                 BufferSet::audio_iterator i = inbufs.audio_begin();
1396                                 for (++i; i != inbufs.audio_end(); ++i) {
1397                                         dst.accumulate_with_gain_from(*i, nframes, gain_coeff);
1398                                 }
1399                         }
1400
1401                 }
1402
1403                 return;
1404         }
1405
1406         /* the terrible silence ... */
1407         for (BufferSet::audio_iterator i = outbufs.audio_begin(); i != outbufs.audio_end(); ++i) {
1408                 i->silence(nframes);
1409         }
1410
1411         BufferSet::audio_iterator i = inbufs.audio_begin();
1412
1413         for (vector<StreamPanner*>::iterator pan = _streampanners.begin(); pan != _streampanners.end() && i != inbufs.audio_end(); ++pan, ++i) {
1414                 (*pan)->distribute (*i, outbufs, gain_coeff, nframes);
1415         }
1416 }
1417
1418 void
1419 Panner::run (BufferSet& inbufs, BufferSet& outbufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
1420 {
1421         if (outbufs.count().n_audio() == 0) {
1422                 // Failing to deliver audio we were asked to deliver is a bug
1423                 assert(inbufs.count().n_audio() == 0);
1424                 return;
1425         }
1426
1427         // We shouldn't be called in the first place...
1428         assert(!bypassed());
1429         assert(!empty());
1430
1431         // If we shouldn't play automation defer to distribute_no_automation
1432         if (!(automation_state() & Play || ((automation_state() & Touch) && !touching()))) {
1433
1434                 // Speed quietning
1435                 gain_t gain_coeff = 1.0;
1436
1437                 if (fabsf(_session.transport_speed()) > 1.5f) {
1438                         gain_coeff = speed_quietning;
1439                 }
1440
1441                 distribute_no_automation (inbufs, outbufs, nframes, gain_coeff);
1442                 return;
1443         }
1444
1445         // Otherwise.. let the automation flow, baby
1446
1447         if (outbufs.count().n_audio() == 1) {
1448
1449                 AudioBuffer& dst = outbufs.get_audio(0);
1450
1451                 // FIXME: apply gain automation?
1452
1453                 // copy the first
1454                 dst.read_from(inbufs.get_audio(0), nframes);
1455
1456                 // accumulate starting with the second
1457                 BufferSet::audio_iterator i = inbufs.audio_begin();
1458                 for (++i; i != inbufs.audio_end(); ++i) {
1459                         dst.merge_from(*i, nframes);
1460                 }
1461
1462                 return;
1463         }
1464
1465         // More than 1 output, we should have 1 panner for each input
1466         //assert(_streampanners.size() == inbufs.count().n_audio());
1467
1468         /* the terrible silence ... */
1469         for (BufferSet::audio_iterator i = outbufs.audio_begin(); i != outbufs.audio_end(); ++i) {
1470                 i->silence(nframes);
1471         }
1472
1473         BufferSet::audio_iterator i = inbufs.audio_begin();
1474         for (vector<StreamPanner*>::iterator pan = _streampanners.begin(); pan != _streampanners.end(); ++pan, ++i) {
1475                 (*pan)->distribute_automated (*i, outbufs, start_frame, end_frame, nframes, _session.pan_automation_buffer());
1476         }
1477 }
1478
1479 /* old school automation handling */
1480
1481 /*
1482 void
1483 Panner::set_name (string str)
1484 {
1485         automation_path = Glib::build_filename(_session.automation_dir(),
1486                 _session.snap_name() + "-pan-" + legalize_for_path (str) + ".automation");
1487 }
1488 */
1489
1490 int
1491 Panner::load ()
1492 {
1493         char line[128];
1494         uint32_t linecnt = 0;
1495         float version;
1496         vector<StreamPanner*>::iterator sp;
1497         LocaleGuard lg (X_("POSIX"));
1498
1499         if (automation_path.length() == 0) {
1500                 return 0;
1501         }
1502
1503         if (access (automation_path.c_str(), F_OK)) {
1504                 return 0;
1505         }
1506
1507         ifstream in (automation_path.c_str());
1508
1509         if (!in) {
1510                 error << string_compose (_("cannot open pan automation file %1 (%2)"),
1511                                   automation_path, strerror (errno))
1512                       << endmsg;
1513                 return -1;
1514         }
1515
1516         sp = _streampanners.begin();
1517
1518         while (in.getline (line, sizeof(line), '\n')) {
1519
1520                 if (++linecnt == 1) {
1521                         if (memcmp (line, X_("version"), 7) == 0) {
1522                                 if (sscanf (line, "version %f", &version) != 1) {
1523                                         error << string_compose(_("badly formed version number in pan automation event file \"%1\""), automation_path) << endmsg;
1524                                         return -1;
1525                                 }
1526                         } else {
1527                                 error << string_compose(_("no version information in pan automation event file \"%1\" (first line = %2)"),
1528                                                  automation_path, line) << endmsg;
1529                                 return -1;
1530                         }
1531
1532                         continue;
1533                 }
1534
1535                 if (strlen (line) == 0 || line[0] == '#') {
1536                         continue;
1537                 }
1538
1539                 if (strcmp (line, "begin") == 0) {
1540
1541                         if (sp == _streampanners.end()) {
1542                                 error << string_compose (_("too many panner states found in pan automation file %1"),
1543                                                   automation_path)
1544                                       << endmsg;
1545                                 return -1;
1546                         }
1547
1548                         if ((*sp)->load (in, automation_path, linecnt)) {
1549                                 return -1;
1550                         }
1551
1552                         ++sp;
1553                 }
1554         }
1555
1556         return 0;
1557 }