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