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 (prop->value() == "yes");
 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         : Processor(s, name, PostFader)
 707 {
 708         //set_name_old_auto (name);
 709         set_name (name);
 710
 711         _linked = false;
 712         _link_direction = SameDirection;
 713         _bypassed = false;
 714 }
 715
 716 Panner::~Panner ()
 717 {
 718 }
 719
 720 void
 721 Panner::set_linked (bool yn)
 722 {
 723         if (yn != _linked) {
 724                 _linked = yn;
 725                 _session.set_dirty ();
 726                 LinkStateChanged (); /* EMIT SIGNAL */
 727         }
 728 }
 729
 730 void
 731 Panner::set_link_direction (LinkDirection ld)
 732 {
 733         if (ld != _link_direction) {
 734                 _link_direction = ld;
 735                 _session.set_dirty ();
 736                 LinkStateChanged (); /* EMIT SIGNAL */
 737         }
 738 }
 739
 740
 741 void
 742 Panner::set_bypassed (bool yn)
 743 {
 744         if (yn != _bypassed) {
 745                 _bypassed = yn;
 746                 StateChanged ();
 747         }
 748 }
 749
 750
 751 void
 752 Panner::reset (uint32_t nouts, uint32_t npans)
 753 {
 754         uint32_t n;
 755         bool changed = false;
 756         bool do_not_and_did_not_need_panning = ((nouts < 2) && (outputs.size() < 2));
 757
 758         /* if new and old config don't need panning, or if
 759            the config hasn't changed, we're done.
 760         */
 761
 762         if (do_not_and_did_not_need_panning ||
 763             ((nouts == outputs.size()) && (npans == _streampanners.size()))) {
 764                 return;
 765         }
 766
 767         n = _streampanners.size();
 768         clear_panners ();
 769
 770         if (n != npans) {
 771                 changed = true;
 772         }
 773
 774         n = outputs.size();
 775         outputs.clear ();
 776
 777         if (n != nouts) {
 778                 changed = true;
 779         }
 780
 781         if (nouts < 2) {
 782                 /* no need for panning with less than 2 outputs */
 783                 goto send_changed;
 784         }
 785
 786         switch (nouts) {
 787         case 0:
 788                 /* XXX: this can never happen */
 789                 break;
 790
 791         case 1:
 792                 /* XXX: this can never happen */
 793                 fatal << _("programming error:")
 794                       << X_("Panner::reset() called with a single output")
 795                       << endmsg;
 796                 /*NOTREACHED*/
 797                 break;
 798
 799         case 2: // line
 800                 outputs.push_back (Output (0, 0));
 801                 outputs.push_back (Output (1.0, 0));
 802
 803                 for (n = 0; n < npans; ++n) {
 804                         _streampanners.push_back (new EqualPowerStereoPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 805                 }
 806                 break;
 807
 808         case 3: // triangle
 809                 outputs.push_back (Output  (0.5, 0));
 810                 outputs.push_back (Output  (0, 1.0));
 811                 outputs.push_back (Output  (1.0, 1.0));
 812
 813                 for (n = 0; n < npans; ++n) {
 814                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 815                 }
 816
 817                 break;
 818
 819         case 4: // square
 820                 outputs.push_back (Output  (0, 0));
 821                 outputs.push_back (Output  (1.0, 0));
 822                 outputs.push_back (Output  (1.0, 1.0));
 823                 outputs.push_back (Output  (0, 1.0));
 824
 825                 for (n = 0; n < npans; ++n) {
 826                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 827                 }
 828
 829                 break;
 830
 831         case 5: //square+offcenter center
 832                 outputs.push_back (Output  (0, 0));
 833                 outputs.push_back (Output  (1.0, 0));
 834                 outputs.push_back (Output  (1.0, 1.0));
 835                 outputs.push_back (Output  (0, 1.0));
 836                 outputs.push_back (Output  (0.5, 0.75));
 837
 838                 for (n = 0; n < npans; ++n) {
 839                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 840                 }
 841
 842                 break;
 843
 844         default:
 845                 /* XXX horrible placement. FIXME */
 846                 for (n = 0; n < nouts; ++n) {
 847                         outputs.push_back (Output (0.1 * n, 0.1 * n));
 848                 }
 849
 850                 for (n = 0; n < npans; ++n) {
 851                         _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
 852                 }
 853
 854                 break;
 855         }
 856
 857         for (std::vector<StreamPanner*>::iterator x = _streampanners.begin(); x != _streampanners.end(); ++x) {
 858                 (*x)->update ();
 859         }
 860
 861         /* force hard left/right panning in a common case: 2in/2out
 862         */
 863
 864         if (npans == 2 && outputs.size() == 2) {
 865
 866                 /* Do this only if we changed configuration, or our configuration
 867                    appears to be the default set up (center).
 868                 */
 869
 870                 float left;
 871                 float right;
 872
 873                 _streampanners.front()->get_position (left);
 874                 _streampanners.back()->get_position (right);
 875
 876                 if (changed || ((left == 0.5) && (right == 0.5))) {
 877
 878                         _streampanners.front()->set_position (0.0);
 879                         _streampanners.front()->pan_control()->list()->reset_default (0.0);
 880
 881                         _streampanners.back()->set_position (1.0);
 882                         _streampanners.back()->pan_control()->list()->reset_default (1.0);
 883
 884                         changed = true;
 885                 }
 886         }
 887
 888   send_changed:
 889         if (changed) {
 890                 Changed (); /* EMIT SIGNAL */
 891         }
 892
 893         return;
 894 }
 895
 896 void
 897 Panner::remove (uint32_t which)
 898 {
 899         vector<StreamPanner*>::iterator i;
 900         for (i = _streampanners.begin(); i != _streampanners.end() && which; ++i, --which) {}
 901
 902         if (i != _streampanners.end()) {
 903                 delete *i;
 904                 _streampanners.erase (i);
 905         }
 906 }
 907
 908
 909 /** Remove all our StreamPanners */
 910 void
 911 Panner::clear_panners ()
 912 {
 913         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
 914                 delete *i;
 915         }
 916
 917         _streampanners.clear ();
 918 }
 919
 920 void
 921 Panner::set_automation_style (AutoStyle style)
 922 {
 923         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
 924                 ((AutomationList*)(*i)->pan_control()->list().get())->set_automation_style (style);
 925         }
 926         _session.set_dirty ();
 927 }
 928
 929 void
 930 Panner::set_automation_state (AutoState state)
 931 {
 932         for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
 933                 ((AutomationList*)(*i)->pan_control()->list().get())->set_automation_state (state);
 934         }
 935         _session.set_dirty ();
 936 }
 937
 938 AutoState
 939 Panner::automation_state () const
 940 {
 941         if (!empty()) {
 942                 return ((AutomationList*)_streampanners.front()->pan_control()->list().get())->automation_state ();
 943         } else {
 944                 return Off;
 945         }
 946 }
 947
 948 AutoStyle
 949 Panner::automation_style () const
 950 {
 951         if (!empty()) {
 952                 return ((AutomationList*)_streampanners.front()->pan_control()->list().get())->automation_style ();
 953         } else {
 954                 return Absolute;
 955         }
 956 }
 957
 958
 959 struct PanPlugins {
 960     string name;
 961     uint32_t nouts;
 962     StreamPanner* (*factory)(Panner&, Evoral::Parameter);
 963 };
 964
 965 PanPlugins pan_plugins[] = {
 966         { EqualPowerStereoPanner::name, 2, EqualPowerStereoPanner::factory },
 967         { Multi2dPanner::name, 3, Multi2dPanner::factory },
 968         { string (""), 0, 0 }
 969 };
 970
 971 XMLNode&
 972 Panner::get_state (void)
 973 {
 974         return state (true);
 975 }
 976
 977 XMLNode&
 978 Panner::state (bool full)
 979 {
 980         XMLNode& node = Processor::state(full);
 981
 982         node.add_property ("type", "panner");
 983
 984         char buf[32];
 985
 986         node.add_property (X_("linked"), (_linked ? "yes" : "no"));
 987         node.add_property (X_("link_direction"), enum_2_string (_link_direction));
 988         node.add_property (X_("bypassed"), (bypassed() ? "yes" : "no"));
 989
 990         for (vector<Panner::Output>::iterator o = outputs.begin(); o != outputs.end(); ++o) {
 991                 XMLNode* onode = new XMLNode (X_("Output"));
 992                 snprintf (buf, sizeof (buf), "%.12g", (*o).x);
 993                 onode->add_property (X_("x"), buf);
 994                 snprintf (buf, sizeof (buf), "%.12g", (*o).y);
 995                 onode->add_property (X_("y"), buf);
 996                 node.add_child_nocopy (*onode);
 997         }
 998
 999         for (vector<StreamPanner*>::const_iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1000                 node.add_child_nocopy ((*i)->state (full));
1001         }
1002
1003
1004         return node;
1005 }
1006
1007 int
1008 Panner::set_state (const XMLNode& node)
1009 {
1010         XMLNodeList nlist;
1011         XMLNodeConstIterator niter;
1012         const XMLProperty *prop;
1013         uint32_t i;
1014         uint32_t num_panners = 0;
1015         StreamPanner* sp;
1016         LocaleGuard lg (X_("POSIX"));
1017
1018         clear_panners ();
1019
1020         Processor::set_state(node);
1021
1022         ChanCount ins = ChanCount::ZERO;
1023         ChanCount outs = ChanCount::ZERO;
1024
1025         // XXX: this might not be necessary anymore
1026         outputs.clear ();
1027
1028         if ((prop = node.property (X_("linked"))) != 0) {
1029                 set_linked (prop->value() == "yes");
1030         }
1031
1032
1033         if ((prop = node.property (X_("bypassed"))) != 0) {
1034                 set_bypassed (prop->value() == "yes");
1035         }
1036
1037         if ((prop = node.property (X_("link_direction"))) != 0) {
1038                 LinkDirection ld; /* here to provide type information */
1039                 set_link_direction (LinkDirection (string_2_enum (prop->value(), ld)));
1040         }
1041
1042         nlist = node.children();
1043
1044         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1045                 if ((*niter)->name() == X_("Output")) {
1046
1047                         float x, y;
1048
1049                         prop = (*niter)->property (X_("x"));
1050                         sscanf (prop->value().c_str(), "%g", &x);
1051
1052                         prop = (*niter)->property (X_("y"));
1053                         sscanf (prop->value().c_str(), "%g", &y);
1054
1055                         outputs.push_back (Output (x, y));
1056                 }
1057         }
1058
1059         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1060
1061                 if ((*niter)->name() == X_("StreamPanner")) {
1062
1063                         if ((prop = (*niter)->property (X_("type")))) {
1064
1065                                 for (i = 0; pan_plugins[i].factory; ++i) {
1066                                         if (prop->value() == pan_plugins[i].name) {
1067
1068
1069                                                 /* note that we assume that all the stream panners
1070                                                    are of the same type. pretty good
1071                                                    assumption, but it's still an assumption.
1072                                                 */
1073
1074                                                 sp = pan_plugins[i].factory (*this, Evoral::Parameter(PanAutomation, 0, num_panners));
1075                                                 num_panners++;
1076
1077                                                 if (sp->set_state (**niter) == 0) {
1078                                                         _streampanners.push_back (sp);
1079                                                 }
1080
1081                                                 break;
1082                                         }
1083                                 }
1084
1085
1086                                 if (!pan_plugins[i].factory) {
1087                                         error << string_compose (_("Unknown panner plugin \"%1\" found in pan state - ignored"),
1088                                                           prop->value())
1089                                               << endmsg;
1090                                 }
1091
1092                         } else {
1093                                 error << _("panner plugin node has no type information!")
1094                                       << endmsg;
1095                                 return -1;
1096                         }
1097
1098                 }
1099         }
1100
1101         reset (outputs.size (), num_panners);
1102         /* don't try to do old-school automation loading if it wasn't marked as existing */
1103
1104         if ((prop = node.property (X_("automation")))) {
1105
1106                 /* automation path is relative */
1107
1108                 automation_path = Glib::build_filename(_session.automation_dir(), prop->value ());
1109         }
1110
1111         return 0;
1112 }
1113
1114 bool
1115 Panner::touching () const
1116 {
1117         for (vector<StreamPanner*>::const_iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1118                 if (((AutomationList*)(*i)->pan_control()->list().get())->touching ()) {
1119                         return true;
1120                 }
1121         }
1122
1123         return false;
1124 }
1125
1126 void
1127 Panner::set_position (float xpos, StreamPanner& orig)
1128 {
1129         float xnow;
1130         float xdelta ;
1131         float xnew;
1132
1133         orig.get_position (xnow);
1134         xdelta = xpos - xnow;
1135
1136         if (_link_direction == SameDirection) {
1137
1138                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1139                         if (*i == &orig) {
1140                                 (*i)->set_position (xpos, true);
1141                         } else {
1142                                 (*i)->get_position (xnow);
1143                                 xnew = min (1.0f, xnow + xdelta);
1144                                 xnew = max (0.0f, xnew);
1145                                 (*i)->set_position (xnew, true);
1146                         }
1147                 }
1148
1149         } else {
1150
1151                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1152                         if (*i == &orig) {
1153                                 (*i)->set_position (xpos, true);
1154                         } else {
1155                                 (*i)->get_position (xnow);
1156                                 xnew = min (1.0f, xnow - xdelta);
1157                                 xnew = max (0.0f, xnew);
1158                                 (*i)->set_position (xnew, true);
1159                         }
1160                 }
1161         }
1162 }
1163
1164 void
1165 Panner::set_position (float xpos, float ypos, StreamPanner& orig)
1166 {
1167         float xnow, ynow;
1168         float xdelta, ydelta;
1169         float xnew, ynew;
1170
1171         orig.get_position (xnow, ynow);
1172         xdelta = xpos - xnow;
1173         ydelta = ypos - ynow;
1174
1175         if (_link_direction == SameDirection) {
1176
1177                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1178                         if (*i == &orig) {
1179                                 (*i)->set_position (xpos, ypos, true);
1180                         } else {
1181                                 (*i)->get_position (xnow, ynow);
1182
1183                                 xnew = min (1.0f, xnow + xdelta);
1184                                 xnew = max (0.0f, xnew);
1185
1186                                 ynew = min (1.0f, ynow + ydelta);
1187                                 ynew = max (0.0f, ynew);
1188
1189                                 (*i)->set_position (xnew, ynew, true);
1190                         }
1191                 }
1192
1193         } else {
1194
1195                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1196                         if (*i == &orig) {
1197                                 (*i)->set_position (xpos, ypos, true);
1198                         } else {
1199                                 (*i)->get_position (xnow, ynow);
1200
1201                                 xnew = min (1.0f, xnow - xdelta);
1202                                 xnew = max (0.0f, xnew);
1203
1204                                 ynew = min (1.0f, ynow - ydelta);
1205                                 ynew = max (0.0f, ynew);
1206
1207                                 (*i)->set_position (xnew, ynew, true);
1208                         }
1209                 }
1210         }
1211 }
1212
1213 void
1214 Panner::set_position (float xpos, float ypos, float zpos, StreamPanner& orig)
1215 {
1216         float xnow, ynow, znow;
1217         float xdelta, ydelta, zdelta;
1218         float xnew, ynew, znew;
1219
1220         orig.get_position (xnow, ynow, znow);
1221         xdelta = xpos - xnow;
1222         ydelta = ypos - ynow;
1223         zdelta = zpos - znow;
1224
1225         if (_link_direction == SameDirection) {
1226
1227                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1228                         if (*i == &orig) {
1229                                 (*i)->set_position (xpos, ypos, zpos, true);
1230                         } else {
1231                                 (*i)->get_position (xnow, ynow, znow);
1232
1233                                 xnew = min (1.0f, xnow + xdelta);
1234                                 xnew = max (0.0f, xnew);
1235
1236                                 ynew = min (1.0f, ynow + ydelta);
1237                                 ynew = max (0.0f, ynew);
1238
1239                                 znew = min (1.0f, znow + zdelta);
1240                                 znew = max (0.0f, znew);
1241
1242                                 (*i)->set_position (xnew, ynew, znew, true);
1243                         }
1244                 }
1245
1246         } else {
1247
1248                 for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
1249                         if (*i == &orig) {
1250                                 (*i)->set_position (xpos, ypos, true);
1251                         } else {
1252                                 (*i)->get_position (xnow, ynow, znow);
1253
1254                                 xnew = min (1.0f, xnow - xdelta);
1255                                 xnew = max (0.0f, xnew);
1256
1257                                 ynew = min (1.0f, ynow - ydelta);
1258                                 ynew = max (0.0f, ynew);
1259
1260                                 znew = min (1.0f, znow + zdelta);
1261                                 znew = max (0.0f, znew);
1262
1263                                 (*i)->set_position (xnew, ynew, znew, true);
1264                         }
1265                 }
1266         }
1267 }
1268
1269 void
1270 Panner::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, nframes_t nframes, gain_t gain_coeff)
1271 {
1272         if (outbufs.count().n_audio() == 0) {
1273                 // Don't want to lose audio...
1274                 assert(inbufs.count().n_audio() == 0);
1275                 return;
1276         }
1277
1278         // We shouldn't be called in the first place...
1279         assert(!bypassed());
1280         assert(!empty());
1281
1282
1283         if (outbufs.count().n_audio() == 1) {
1284
1285                 AudioBuffer& dst = outbufs.get_audio(0);
1286
1287                 if (gain_coeff == 0.0f) {
1288
1289                         /* only one output, and gain was zero, so make it silent */
1290
1291                         dst.silence (nframes);
1292
1293                 } else if (gain_coeff == 1.0f){
1294
1295                         /* mix all buffers into the output */
1296
1297                         // copy the first
1298                         dst.read_from(inbufs.get_audio(0), nframes);
1299
1300                         // accumulate starting with the second
1301                         if (inbufs.count().n_audio() > 0) {
1302                                 BufferSet::audio_iterator i = inbufs.audio_begin();
1303                                 for (++i; i != inbufs.audio_end(); ++i) {
1304                                         dst.accumulate_from(*i, nframes);
1305                                 }
1306                         }
1307
1308                 } else {
1309
1310                         /* mix all buffers into the output, scaling them all by the gain */
1311
1312                         // copy the first
1313                         dst.read_from(inbufs.get_audio(0), nframes);
1314
1315                         // accumulate (with gain) starting with the second
1316                         if (inbufs.count().n_audio() > 0) {
1317                                 BufferSet::audio_iterator i = inbufs.audio_begin();
1318                                 for (++i; i != inbufs.audio_end(); ++i) {
1319                                         dst.accumulate_with_gain_from(*i, nframes, gain_coeff);
1320                                 }
1321                         }
1322
1323                 }
1324
1325                 return;
1326         }
1327
1328         /* the terrible silence ... */
1329         for (BufferSet::audio_iterator i = outbufs.audio_begin(); i != outbufs.audio_end(); ++i) {
1330                 i->silence(nframes);
1331         }
1332
1333         BufferSet::audio_iterator i = inbufs.audio_begin();
1334
1335         for (vector<StreamPanner*>::iterator pan = _streampanners.begin(); pan != _streampanners.end() && i != inbufs.audio_end(); ++pan, ++i) {
1336                 (*pan)->distribute (*i, outbufs, gain_coeff, nframes);
1337         }
1338 }
1339
1340 void
1341 Panner::run_out_of_place (BufferSet& inbufs, BufferSet& outbufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes)
1342 {
1343         if (outbufs.count().n_audio() == 0) {
1344                 // Failing to deliver audio we were asked to deliver is a bug
1345                 assert(inbufs.count().n_audio() == 0);
1346                 return;
1347         }
1348
1349         // We shouldn't be called in the first place...
1350         assert(!bypassed());
1351         assert(!empty());
1352
1353         // If we shouldn't play automation defer to distribute_no_automation
1354         if ( !( automation_state() & Play ||
1355                          ((automation_state() & Touch) && !touching()) ) ) {
1356
1357                 // Speed quietning
1358                 gain_t gain_coeff = 1.0;
1359                 if (fabsf(_session.transport_speed()) > 1.5f) {
1360                         gain_coeff = speed_quietning;
1361                 }
1362
1363                 distribute_no_automation(inbufs, outbufs, nframes, gain_coeff);
1364                 return;
1365         }
1366
1367         // Otherwise.. let the automation flow, baby
1368
1369         if (outbufs.count().n_audio() == 1) {
1370
1371                 AudioBuffer& dst = outbufs.get_audio(0);
1372
1373                 // FIXME: apply gain automation?
1374
1375                 // copy the first
1376                 dst.read_from(inbufs.get_audio(0), nframes);
1377
1378                 // accumulate starting with the second
1379                 BufferSet::audio_iterator i = inbufs.audio_begin();
1380                 for (++i; i != inbufs.audio_end(); ++i) {
1381                         dst.accumulate_from(*i, nframes);
1382                 }
1383
1384                 return;
1385         }
1386
1387         // More than 1 output, we should have 1 panner for each input
1388         //assert(_streampanners.size() == inbufs.count().n_audio());
1389
1390         /* the terrible silence ... */
1391         for (BufferSet::audio_iterator i = outbufs.audio_begin(); i != outbufs.audio_end(); ++i) {
1392                 i->silence(nframes);
1393         }
1394
1395         BufferSet::audio_iterator i = inbufs.audio_begin();
1396         for (vector<StreamPanner*>::iterator pan = _streampanners.begin(); pan != _streampanners.end(); ++pan, ++i) {
1397                 (*pan)->distribute_automated (*i, outbufs, start_frame, end_frame, nframes, _session.pan_automation_buffer());
1398         }
1399 }
1400
1401 /* old school automation handling */
1402
1403 /*
1404 void
1405 Panner::set_name (string str)
1406 {
1407         automation_path = Glib::build_filename(_session.automation_dir(),
1408                 _session.snap_name() + "-pan-" + legalize_for_path (str) + ".automation");
1409 }
1410 */
1411
1412 int
1413 Panner::load ()
1414 {
1415         char line[128];
1416         uint32_t linecnt = 0;
1417         float version;
1418         vector<StreamPanner*>::iterator sp;
1419         LocaleGuard lg (X_("POSIX"));
1420
1421         if (automation_path.length() == 0) {
1422                 return 0;
1423         }
1424
1425         if (access (automation_path.c_str(), F_OK)) {
1426                 return 0;
1427         }
1428
1429         ifstream in (automation_path.c_str());
1430
1431         if (!in) {
1432                 error << string_compose (_("cannot open pan automation file %1 (%2)"),
1433                                   automation_path, strerror (errno))
1434                       << endmsg;
1435                 return -1;
1436         }
1437
1438         sp = _streampanners.begin();
1439
1440         while (in.getline (line, sizeof(line), '\n')) {
1441
1442                 if (++linecnt == 1) {
1443                         if (memcmp (line, X_("version"), 7) == 0) {
1444                                 if (sscanf (line, "version %f", &version) != 1) {
1445                                         error << string_compose(_("badly formed version number in pan automation event file \"%1\""), automation_path) << endmsg;
1446                                         return -1;
1447                                 }
1448                         } else {
1449                                 error << string_compose(_("no version information in pan automation event file \"%1\" (first line = %2)"),
1450                                                  automation_path, line) << endmsg;
1451                                 return -1;
1452                         }
1453
1454                         continue;
1455                 }
1456
1457                 if (strlen (line) == 0 || line[0] == '#') {
1458                         continue;
1459                 }
1460
1461                 if (strcmp (line, "begin") == 0) {
1462
1463                         if (sp == _streampanners.end()) {
1464                                 error << string_compose (_("too many panner states found in pan automation file %1"),
1465                                                   automation_path)
1466                                       << endmsg;
1467                                 return -1;
1468                         }
1469
1470                         if ((*sp)->load (in, automation_path, linecnt)) {
1471                                 return -1;
1472                         }
1473
1474                         ++sp;
1475                 }
1476         }
1477
1478         return 0;
1479 }