change Session::convert_to_frames_at() to Session::convert_to_frames() to reflect...
[ardour.git] / libs / ardour / panner.cc
index 5b33eaf1f559cbaf8c7349377ce7aaff5ae4c40c..cb2ad8dd4a127aa04ed76869f311380eaa9d52c4 100644 (file)
@@ -1,3 +1,4 @@
+
 /*
     Copyright (C) 2004 Paul Davis
 
@@ -17,7 +18,6 @@
 
 */
 
-#define __STDC_FORMAT_MACROS 1
 #include <inttypes.h>
 
 #include <cmath>
@@ -33,6 +33,8 @@
 
 #include <glibmm.h>
 
+#include "pbd/cartesian.h"
+#include "pbd/convert.h"
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 #include "pbd/xml++.h"
@@ -48,6 +50,7 @@
 #include "ardour/runtime_functions.h"
 #include "ardour/buffer_set.h"
 #include "ardour/audio_buffer.h"
+#include "ardour/vbap.h"
 
 #include "i18n.h"
 
@@ -60,31 +63,26 @@ using namespace PBD;
 float Panner::current_automation_version_number = 1.0;
 
 string EqualPowerStereoPanner::name = "Equal Power Stereo";
-string Multi2dPanner::name = "Multiple (2D)";
 
 /* this is a default mapper of control values to a pan position
    others can be imagined.
 */
 
-static pan_t direct_control_to_pan (double fract)
+static double direct_control_to_stereo_pan (double fract)
 {
-       return fract;
+       return BaseStereoPanner::lr_fract_to_azimuth (fract);
 }
 
 StreamPanner::StreamPanner (Panner& p, Evoral::Parameter param)
        : parent (p)
+        , _control (new PanControllable (parent.session(), _("direction"), this, param))
 {
        assert (param.type() != NullAutomation);
 
        _muted = false;
        _mono = false;
 
-       /* get our AutomationControl from our parent Panner, creating it if required */
-       _control = boost::dynamic_pointer_cast<AutomationControl> (parent.control (param, true));
-
-       _x = 0.5;
-       _y = 0.5;
-       _z = 0.5;
+        p.add_control (_control);
 }
 
 StreamPanner::~StreamPanner ()
@@ -100,15 +98,48 @@ StreamPanner::set_mono (bool yn)
        }
 }
 
+double
+StreamPanner::PanControllable::lower () const
+{
+        switch (parameter().id()) {
+        case 200: /* width */
+                return -1.0;
+        default:
+                return 0.0;
+        }
+}
+
 void
-Panner::PanControllable::set_value (double val)
+StreamPanner::PanControllable::set_value (double val)
 {
-       panner.streampanner (parameter().id()).set_position (direct_control_to_pan (val));
-       AutomationControl::set_value(val);
+        Panner& p (streampanner->get_parent());
+        switch (parameter().id()) {
+        case 100:
+                /* position */
+                val = max (min (val, 1.0), 0.0);
+                if (p.set_stereo_pan (val, p.width_control()->get_value())) {
+                        AutomationControl::set_value(val);
+                }
+                break;
+
+        case 200:
+                /* width */
+                val = max (min (val, 1.0), -1.0);
+                if (p.set_stereo_pan (p.direction_control()->get_value(), val)) {
+                        AutomationControl::set_value(val);
+                }
+                break;
+
+        default:
+                streampanner->set_position (AngularVector (direct_control_to_stereo_pan (val), 0.0));
+                AutomationControl::set_value(val);
+                break;
+        }
+
 }
 
 double
-Panner::PanControllable::get_value (void) const
+StreamPanner::PanControllable::get_value (void) const
 {
        return AutomationControl::get_value();
 }
@@ -123,47 +154,14 @@ StreamPanner::set_muted (bool yn)
 }
 
 void
-StreamPanner::set_position (float xpos, bool link_call)
-{
-       if (!link_call && parent.linked()) {
-               parent.set_position (xpos, *this);
-       }
-
-       if (_x != xpos) {
-               _x = xpos;
-               update ();
-               Changed ();
-               _control->Changed ();
-       }
-}
-
-void
-StreamPanner::set_position (float xpos, float ypos, bool link_call)
-{
-       if (!link_call && parent.linked()) {
-               parent.set_position (xpos, ypos, *this);
-       }
-
-       if (_x != xpos || _y != ypos) {
-               _x = xpos;
-               _y = ypos;
-               update ();
-               Changed ();
-               _control->Changed ();
-       }
-}
-
-void
-StreamPanner::set_position (float xpos, float ypos, float zpos, bool link_call)
+StreamPanner::set_position (const AngularVector& av, bool link_call)
 {
        if (!link_call && parent.linked()) {
-               parent.set_position (xpos, ypos, zpos, *this);
+               parent.set_position (av, *this);
        }
 
-       if (_x != xpos || _y != ypos || _z != zpos) {
-               _x = xpos;
-               _y = ypos;
-               _z = zpos;
+       if (_angles != av) {
+               _angles = av;
                update ();
                Changed ();
                _control->Changed ();
@@ -171,7 +169,7 @@ StreamPanner::set_position (float xpos, float ypos, float zpos, bool link_call)
 }
 
 int
-StreamPanner::set_state (const XMLNode& node, int /*version*/)
+StreamPanner::set_state (const XMLNode& node, int version)
 {
        const XMLProperty* prop;
        XMLNodeConstIterator iter;
@@ -184,18 +182,29 @@ StreamPanner::set_state (const XMLNode& node, int /*version*/)
                set_mono (string_is_affirmative (prop->value()));
        }
 
+       for (XMLNodeConstIterator iter = node.children().begin(); iter != node.children().end(); ++iter) {              
+                if ((*iter)->name() == Controllable::xml_node_name) {
+                       if ((prop = (*iter)->property ("name")) != 0 && prop->value() == "direction") {
+                               _control->set_state (**iter, version);
+                       } 
+                }
+        }
+
        return 0;
 }
 
-void
-StreamPanner::add_state (XMLNode& node)
+XMLNode&
+StreamPanner::get_state ()
 {
-       node.add_property (X_("muted"), (muted() ? "yes" : "no"));
-       node.add_property (X_("mono"), (_mono ? "yes" : "no"));
+        XMLNode* node = new XMLNode (X_("StreamPanner"));
+       node->add_property (X_("muted"), (muted() ? "yes" : "no"));
+       node->add_property (X_("mono"), (_mono ? "yes" : "no"));
+       node->add_child_nocopy (_control->get_state ());
+        return *node;
 }
 
 void
-StreamPanner::distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
+StreamPanner::distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes)
 {
        if (_mono) {
                /* we're in mono mode, so just pan the input to all outputs equally */
@@ -211,7 +220,7 @@ StreamPanner::distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff,
 
 void
 StreamPanner::distribute_automated (AudioBuffer& src, BufferSet& obufs,
-                                   nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers)
+                                   framepos_t start, framepos_t end, pframes_t nframes, pan_t** buffers)
 {
        if (_mono) {
                /* we're in mono mode, so just pan the input to all outputs equally */
@@ -251,7 +260,7 @@ BaseStereoPanner::load (istream& in, string path, uint32_t& linecnt)
        _control->list()->clear ();
 
        while (in.getline (line, sizeof (line), '\n')) {
-               nframes_t when;
+               framepos_t when;
                double value;
 
                ++linecnt;
@@ -260,7 +269,7 @@ BaseStereoPanner::load (istream& in, string path, uint32_t& linecnt)
                        break;
                }
 
-               if (sscanf (line, "%" PRIu32 " %lf", &when, &value) != 2) {
+               if (sscanf (line, "%" PRIu64 " %lf", &when, &value) != 2) {
                        warning << string_compose(_("badly formatted pan automation event record at line %1 of %2 (ignored) [%3]"), linecnt, path, line) << endmsg;
                        continue;
                }
@@ -276,7 +285,7 @@ BaseStereoPanner::load (istream& in, string path, uint32_t& linecnt)
 }
 
 void
-BaseStereoPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
+BaseStereoPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, pframes_t nframes)
 {
        assert(obufs.count().n_audio() == 2);
 
@@ -299,8 +308,8 @@ BaseStereoPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t g
                /* we've moving the pan by an appreciable amount, so we must
                   interpolate over 64 frames or nframes, whichever is smaller */
 
-               nframes_t const limit = min ((nframes_t)64, nframes);
-               nframes_t n;
+               pframes_t const limit = min ((pframes_t) 64, nframes);
+               pframes_t n;
 
                delta = -(delta / (float) (limit));
 
@@ -356,8 +365,8 @@ BaseStereoPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t g
                /* we're moving the pan by an appreciable amount, so we must
                   interpolate over 64 frames or nframes, whichever is smaller */
 
-               nframes_t const limit = min ((nframes_t)64, nframes);
-               nframes_t n;
+               pframes_t const limit = min ((pframes_t) 64, nframes);
+               pframes_t n;
 
                delta = -(delta / (float) (limit));
 
@@ -430,10 +439,12 @@ EqualPowerStereoPanner::update ()
           overhead.
        */
 
-       /* x == 0 => hard left
-          x == 1 => hard right
+       /* x == 0 => hard left = 180.0 degrees
+          x == 1 => hard right = 0.0 degrees
        */
 
+       double _x = BaseStereoPanner::azimuth_to_lr_fract (_angles.azi);
+
        float const panR = _x;
        float const panL = 1 - panR;
 
@@ -443,13 +454,13 @@ EqualPowerStereoPanner::update ()
        desired_left = panL * (scale * panL + 1.0f - scale);
        desired_right = panR * (scale * panR + 1.0f - scale);
 
-       effective_x = _x;
+       _effective_angles = _angles;
        //_control->set_value(x);
 }
 
 void
 EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet& obufs,
-                                                nframes_t start, nframes_t end, nframes_t nframes,
+                                                framepos_t start, framepos_t end, pframes_t nframes,
                                                 pan_t** buffers)
 {
        assert (obufs.count().n_audio() == 2);
@@ -471,7 +482,7 @@ EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet&
        /* store effective pan position. do this even if we are muted */
 
        if (nframes > 0) {
-               effective_x = buffers[0][nframes-1];
+               _effective_angles.azi = BaseStereoPanner::lr_fract_to_azimuth (buffers[0][nframes-1]);
        }
 
        if (_muted) {
@@ -485,7 +496,7 @@ EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet&
        const float pan_law_attenuation = -3.0f;
        const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 
-       for (nframes_t n = 0; n < nframes; ++n) {
+       for (pframes_t n = 0; n < nframes; ++n) {
 
                float const panR = buffers[0][n];
                float const panL = 1 - panR;
@@ -499,7 +510,7 @@ EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet&
        dst = obufs.get_audio(0).data();
        pbuf = buffers[0];
 
-       for (nframes_t n = 0; n < nframes; ++n) {
+       for (pframes_t n = 0; n < nframes; ++n) {
                dst[n] += src[n] * pbuf[n];
        }
 
@@ -510,7 +521,7 @@ EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet&
        dst = obufs.get_audio(1).data();
        pbuf = buffers[1];
 
-       for (nframes_t n = 0; n < nframes; ++n) {
+       for (pframes_t n = 0; n < nframes; ++n) {
                dst[n] += src[n] * pbuf[n];
        }
 
@@ -518,7 +529,7 @@ EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet&
 }
 
 StreamPanner*
-EqualPowerStereoPanner::factory (Panner& parent, Evoral::Parameter param)
+EqualPowerStereoPanner::factory (Panner& parent, Evoral::Parameter param, Speakers& /* ignored */)
 {
        return new EqualPowerStereoPanner (parent, param);
 }
@@ -532,49 +543,27 @@ EqualPowerStereoPanner::get_state (void)
 XMLNode&
 EqualPowerStereoPanner::state (bool /*full_state*/)
 {
-       XMLNode* root = new XMLNode ("StreamPanner");
-       char buf[64];
-       LocaleGuard lg (X_("POSIX"));
-
-       snprintf (buf, sizeof (buf), "%.12g", _x);
-       root->add_property (X_("x"), buf);
-       root->add_property (X_("type"), EqualPowerStereoPanner::name);
-
-       // XXX: dont save automation here... its part of the automatable panner now.
-
-       StreamPanner::add_state (*root);
-
-       root->add_child_nocopy (_control->get_state ());
-
-       return *root;
+       XMLNode& root (StreamPanner::get_state ());
+       root.add_property (X_("type"), EqualPowerStereoPanner::name);
+       return root;
 }
 
 int
 EqualPowerStereoPanner::set_state (const XMLNode& node, int version)
 {
-       const XMLProperty* prop;
        LocaleGuard lg (X_("POSIX"));
 
-       if ((prop = node.property (X_("x")))) {
-               const float pos = atof (prop->value().c_str());
-               set_position (pos, true);
-       }
-
        StreamPanner::set_state (node, version);
 
        for (XMLNodeConstIterator iter = node.children().begin(); iter != node.children().end(); ++iter) {
 
-               if ((*iter)->name() == X_("Controllable")) {
-                       if ((prop = (*iter)->property("name")) != 0 && prop->value() == "panner") {
-                               _control->set_state (**iter, version);
-                       }
-
-               } else if ((*iter)->name() == X_("Automation")) {
-
+                if ((*iter)->name() == X_("Automation")) {
+                        
                        _control->alist()->set_state (*((*iter)->children().front()), version);
-
+                        
                        if (_control->alist()->automation_state() != Off) {
-                               set_position (_control->list()->eval (parent.session().transport_frame()));
+                               double degrees = BaseStereoPanner::lr_fract_to_azimuth (_control->list()->eval (parent.session().transport_frame()));
+                               set_position (AngularVector (degrees, 0.0));
                        }
                }
        }
@@ -582,193 +571,9 @@ EqualPowerStereoPanner::set_state (const XMLNode& node, int version)
        return 0;
 }
 
-/*----------------------------------------------------------------------*/
-
-Multi2dPanner::Multi2dPanner (Panner& p, Evoral::Parameter param)
-       : StreamPanner (p, param)
-{
-       update ();
-}
-
-Multi2dPanner::~Multi2dPanner ()
-{
-}
-
-void
-Multi2dPanner::update ()
-{
-       static const float BIAS = FLT_MIN;
-       uint32_t i;
-       uint32_t const nouts = parent.nouts ();
-       float dsq[nouts];
-       float f, fr;
-       vector<pan_t> pans;
-
-       f = 0.0f;
-
-       for (i = 0; i < nouts; i++) {
-               dsq[i] = ((_x - parent.output(i).x) * (_x - parent.output(i).x) + (_y - parent.output(i).y) * (_y - parent.output(i).y) + BIAS);
-               if (dsq[i] < 0.0) {
-                       dsq[i] = 0.0;
-               }
-               f += dsq[i] * dsq[i];
-       }
-#ifdef __APPLE__
-       // terrible hack to support OSX < 10.3.9 builds
-       fr = (float) (1.0 / sqrt((double)f));
-#else
-       fr = 1.0 / sqrtf(f);
-#endif
-       for (i = 0; i < nouts; ++i) {
-               parent.output(i).desired_pan = 1.0f - (dsq[i] * fr);
-       }
-
-       effective_x = _x;
-}
-
-void
-Multi2dPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
-{
-       Sample* dst;
-       pan_t pan;
-
-       if (_muted) {
-               return;
-       }
-
-       Sample* const src = srcbuf.data();
-
-       uint32_t const N = parent.nouts ();
-       for (uint32_t n = 0; n < N; ++n) {
-               Panner::Output& o = parent.output (n);
-
-               dst = obufs.get_audio(n).data();
-
-#ifdef CAN_INTERP
-               if (fabsf ((delta = (left_interp - desired_left))) > 0.002) { // about 1 degree of arc
-
-                       /* interpolate over 64 frames or nframes, whichever is smaller */
-
-                       nframes_t limit = min ((nframes_t)64, nframes);
-                       nframes_t n;
-
-                       delta = -(delta / (float) (limit));
-
-                       for (n = 0; n < limit; n++) {
-                               left_interp = left_interp + delta;
-                               left = left_interp + 0.9 * (left - left_interp);
-                               dst[n] += src[n] * left * gain_coeff;
-                       }
-
-                       pan = left * gain_coeff;
-                       mix_buffers_with_gain(dst+n,src+n,nframes-n,pan);
-
-               } else {
-
-#else
-                       pan = o.desired_pan;
-
-                       if ((pan *= gain_coeff) != 1.0f) {
-
-                               if (pan != 0.0f) {
-                                       mix_buffers_with_gain(dst,src,nframes,pan);
-                               }
-                               
-                       } else {
-                                       mix_buffers_no_gain(dst,src,nframes);
-                       }
-#endif
-#ifdef CAN_INTERP
-               }
-#endif
-       }
-
-       return;
-}
-
-void
-Multi2dPanner::do_distribute_automated (AudioBuffer& /*src*/, BufferSet& /*obufs*/,
-                                       nframes_t /*start*/, nframes_t /*end*/, nframes_t /*nframes*/,
-                                       pan_t** /*buffers*/)
-{
-       if (_muted) {
-               return;
-       }
-
-       /* what ? */
-
-       return;
-}
-
-StreamPanner*
-Multi2dPanner::factory (Panner& p, Evoral::Parameter param)
-{
-       return new Multi2dPanner (p, param);
-}
-
-int
-Multi2dPanner::load (istream& /*in*/, string /*path*/, uint32_t& /*linecnt*/)
-{
-       return 0;
-}
-
-XMLNode&
-Multi2dPanner::get_state (void)
-{
-       return state (true);
-}
-
-XMLNode&
-Multi2dPanner::state (bool /*full_state*/)
-{
-       XMLNode* root = new XMLNode ("StreamPanner");
-       char buf[64];
-       LocaleGuard lg (X_("POSIX"));
-
-       snprintf (buf, sizeof (buf), "%.12g", _x);
-       root->add_property (X_("x"), buf);
-       snprintf (buf, sizeof (buf), "%.12g", _y);
-       root->add_property (X_("y"), buf);
-       root->add_property (X_("type"), Multi2dPanner::name);
-
-       /* XXX no meaningful automation yet */
-
-       return *root;
-}
-
-int
-Multi2dPanner::set_state (const XMLNode& node, int /*version*/)
-{
-       const XMLProperty* prop;
-       float newx,newy;
-       LocaleGuard lg (X_("POSIX"));
-
-       newx = -1;
-       newy = -1;
-
-       if ((prop = node.property (X_("x")))) {
-               newx = atof (prop->value().c_str());
-       }
-
-       if ((prop = node.property (X_("y")))) {
-               newy = atof (prop->value().c_str());
-       }
-
-       if (_x < 0 || _y < 0) {
-               error << _("badly-formed positional data for Multi2dPanner - ignored")
-                     << endmsg;
-               return -1;
-       }
-
-       set_position (newx, newy);
-       return 0;
-}
-
-/*---------------------------------------------------------------------- */
-
 Panner::Panner (string name, Session& s)
        : SessionObject (s, name)
-       , Automatable (s)
+        , Automatable (s)
 {
        //set_name_old_auto (name);
        set_name (name);
@@ -826,16 +631,20 @@ Panner::reset_to_default ()
        }
 
        if (outputs.size() == 2) {
+               AngularVector a;
                switch (_streampanners.size()) {
                case 1:
-                       _streampanners.front()->set_position (0.5);
+                       a.azi = 90.0; /* "front" or "top", in degrees */
+                       _streampanners.front()->set_position (a);
                        _streampanners.front()->pan_control()->list()->reset_default (0.5);
                        return;
                        break;
                case 2:
-                       _streampanners.front()->set_position (0.0);
+                       a.azi = 180.0; /* "left", in degrees */
+                       _streampanners.front()->set_position (a);
                        _streampanners.front()->pan_control()->list()->reset_default (0.0);
-                       _streampanners.back()->set_position (1.0);
+                       a.azi = 0.0; /* "right", in degrees */
+                       _streampanners.back()->set_position (a);
                        _streampanners.back()->pan_control()->list()->reset_default (1.0);
                        return;
                default:
@@ -847,13 +656,15 @@ Panner::reset_to_default ()
        vector<StreamPanner*>::iterator p;
 
        for (o = outputs.begin(), p = _streampanners.begin(); o != outputs.end() && p != _streampanners.end(); ++o, ++p) {
-               (*p)->set_position ((*o).x, (*o).y);
+               (*p)->set_position ((*o).position);
        }
 }
 
 void
 Panner::reset_streampanner (uint32_t which)
 {
+       AngularVector a;
+
        if (which >= _streampanners.size() || which >= outputs.size()) {
                return;
        }
@@ -867,16 +678,19 @@ Panner::reset_streampanner (uint32_t which)
                switch (_streampanners.size()) {
                case 1:
                        /* stereo out, 1 stream, default = middle */
-                       _streampanners.front()->set_position (0.5);
+                       a.azi = 90.0; /* "front" or "top", in degrees */
+                       _streampanners.front()->set_position (a);
                        _streampanners.front()->pan_control()->list()->reset_default (0.5);
                        break;
                case 2:
                        /* stereo out, 2 streams, default = hard left/right */
                        if (which == 0) {
-                               _streampanners.front()->set_position (0.0);
+                               a.azi = 180.0; /* "left", in degrees */
+                               _streampanners.front()->set_position (a);
                                _streampanners.front()->pan_control()->list()->reset_default (0.0);
                        } else {
-                               _streampanners.back()->set_position (1.0);
+                               a.azi = 0.0; /* "right", in degrees */
+                               _streampanners.back()->set_position (a);
                                _streampanners.back()->pan_control()->list()->reset_default (1.0);
                        }
                        break;
@@ -884,7 +698,7 @@ Panner::reset_streampanner (uint32_t which)
                return;
 
        default:
-               _streampanners[which]->set_position (outputs[which].x, outputs[which].y);
+               _streampanners[which]->set_position (outputs[which].position);
        }
 }
 
@@ -946,60 +760,18 @@ Panner::reset (uint32_t nouts, uint32_t npans)
                break;
 
        case 2: // line
-               outputs.push_back (Output (0, 0));
-               outputs.push_back (Output (1.0, 0));
-
+               outputs.push_back (Output (AngularVector (180.0, 0.0)));
+               outputs.push_back (Output (AngularVector (0.0, 0,0)));
                for (n = 0; n < npans; ++n) {
                        _streampanners.push_back (new EqualPowerStereoPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
                }
                break;
 
-       case 3: // triangle
-               outputs.push_back (Output  (0.5, 0));
-               outputs.push_back (Output  (0, 1.0));
-               outputs.push_back (Output  (1.0, 1.0));
-
-               for (n = 0; n < npans; ++n) {
-                       _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
-               }
-
-               break;
-
-       case 4: // square
-               outputs.push_back (Output  (0, 0));
-               outputs.push_back (Output  (1.0, 0));
-               outputs.push_back (Output  (1.0, 1.0));
-               outputs.push_back (Output  (0, 1.0));
-
-               for (n = 0; n < npans; ++n) {
-                       _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
-               }
-
-               break;
-
-       case 5: //square+offcenter center
-               outputs.push_back (Output  (0, 0));
-               outputs.push_back (Output  (1.0, 0));
-               outputs.push_back (Output  (1.0, 1.0));
-               outputs.push_back (Output  (0, 1.0));
-               outputs.push_back (Output  (0.5, 0.75));
-
-               for (n = 0; n < npans; ++n) {
-                       _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
-               }
-
-               break;
-
        default:
-               /* XXX horrible placement. FIXME */
-               for (n = 0; n < nouts; ++n) {
-                       outputs.push_back (Output (0.1 * n, 0.1 * n));
-               }
-
+               setup_speakers (nouts);
                for (n = 0; n < npans; ++n) {
-                       _streampanners.push_back (new Multi2dPanner (*this, Evoral::Parameter(PanAutomation, 0, n)));
+                       _streampanners.push_back (new VBAPanner (*this, Evoral::Parameter(PanAutomation, 0, n), _session.get_speakers()));
                }
-
                break;
        }
 
@@ -1007,6 +779,8 @@ Panner::reset (uint32_t nouts, uint32_t npans)
                (*x)->update ();
        }
 
+        setup_meta_controls ();
+
        /* must emit Changed here, otherwise the changes to the pan_control below raise further
           signals which the GUI is not prepared for until it has seen the Changed here.
        */
@@ -1021,23 +795,45 @@ Panner::reset (uint32_t nouts, uint32_t npans)
        if (npans == 2 && outputs.size() == 2) {
 
                /* Do this only if we changed configuration, or our configuration
-                  appears to be the default set up (center).
+                  appears to be the default set up (zero degrees)
                */
 
-               float left;
-               float right;
+               AngularVector left;
+               AngularVector right;
 
-               _streampanners.front()->get_position (left);
-               _streampanners.back()->get_position (right);
+               left = _streampanners.front()->get_position ();
+               right = _streampanners.back()->get_position ();
 
-               if (changed || ((left == 0.5) && (right == 0.5))) {
+               if (changed || ((left.azi == 0.0) && (right.azi == 0.0))) {
 
-                       _streampanners.front()->set_position (0.0);
+                       _streampanners.front()->set_position (AngularVector (180.0, 0.0));
                        _streampanners.front()->pan_control()->list()->reset_default (0.0);
 
-                       _streampanners.back()->set_position (1.0);
+                       _streampanners.back()->set_position (AngularVector (0.0, 0.0));
                        _streampanners.back()->pan_control()->list()->reset_default (1.0);
                }
+
+       } else if (npans > 1 && outputs.size() > 2) {
+
+               /* 2d panning: spread signals equally around a circle */
+
+               double degree_step = 360.0 / nouts;
+               double deg;
+
+               /* even number of signals? make sure the top two are either side of "top".
+                  otherwise, just start at the "top" (90.0 degrees) and rotate around
+               */
+
+               if (npans % 2) {
+                       deg = 90.0 - degree_step;
+               } else {
+                       deg = 90.0;
+               }
+
+               for (std::vector<StreamPanner*>::iterator x = _streampanners.begin(); x != _streampanners.end(); ++x) {
+                       (*x)->set_position (AngularVector (deg, 0.0));
+                       deg += degree_step;
+               }
        }
 }
 
@@ -1114,12 +910,12 @@ Panner::automation_style () const
 struct PanPlugins {
     string name;
     uint32_t nouts;
-    StreamPanner* (*factory)(Panner&, Evoral::Parameter);
+    StreamPanner* (*factory)(Panner&, Evoral::Parameter, Speakers&);
 };
 
 PanPlugins pan_plugins[] = {
        { EqualPowerStereoPanner::name, 2, EqualPowerStereoPanner::factory },
-       { Multi2dPanner::name, 3, Multi2dPanner::factory },
+       { VBAPanner::name, 3, VBAPanner::factory },
        { string (""), 0, 0 }
 };
 
@@ -1139,21 +935,14 @@ Panner::state (bool full)
        node->add_property (X_("linked"), (_linked ? "yes" : "no"));
        node->add_property (X_("link_direction"), enum_2_string (_link_direction));
        node->add_property (X_("bypassed"), (bypassed() ? "yes" : "no"));
-
-       for (vector<Panner::Output>::iterator o = outputs.begin(); o != outputs.end(); ++o) {
-               XMLNode* onode = new XMLNode (X_("Output"));
-               snprintf (buf, sizeof (buf), "%.12g", (*o).x);
-               onode->add_property (X_("x"), buf);
-               snprintf (buf, sizeof (buf), "%.12g", (*o).y);
-               onode->add_property (X_("y"), buf);
-               node->add_child_nocopy (*onode);
-       }
+        snprintf (buf, sizeof (buf), "%zd", outputs.size());
+        node->add_property (X_("outputs"), buf);
 
        for (vector<StreamPanner*>::const_iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
                node->add_child_nocopy ((*i)->state (full));
        }
 
-       node->add_child_nocopy (get_automation_xml_state ());
+        node->add_child_nocopy (get_automation_xml_state ());
 
        return *node;
 }
@@ -1161,7 +950,7 @@ Panner::state (bool full)
 int
 Panner::set_state (const XMLNode& node, int version)
 {
-       XMLNodeList nlist;
+       XMLNodeList nlist = node.children ();
        XMLNodeConstIterator niter;
        const XMLProperty *prop;
        uint32_t i;
@@ -1181,7 +970,6 @@ Panner::set_state (const XMLNode& node, int version)
                set_linked (string_is_affirmative (prop->value()));
        }
 
-
        if ((prop = node.property (X_("bypassed"))) != 0) {
                set_bypassed (string_is_affirmative (prop->value()));
        }
@@ -1191,22 +979,38 @@ Panner::set_state (const XMLNode& node, int version)
                set_link_direction (LinkDirection (string_2_enum (prop->value(), ld)));
        }
 
-       nlist = node.children();
-
-       for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() == X_("Output")) {
-
-                       float x, y;
-
-                       prop = (*niter)->property (X_("x"));
-                       sscanf (prop->value().c_str(), "%g", &x);
-
-                       prop = (*niter)->property (X_("y"));
-                       sscanf (prop->value().c_str(), "%g", &y);
-
-                       outputs.push_back (Output (x, y));
-               }
-       }
+        if ((prop = node.property (X_("outputs"))) != 0) {
+                uint32_t n = atoi (prop->value());
+
+                while (n--) {
+                        AngularVector a; // value is irrelevant
+                        outputs.push_back (Output (a));
+                }
+
+        } else {
+                
+                /* old school */
+
+                for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
+                        if ((*niter)->name() == X_("Output")) {
+                                
+                                AngularVector a;
+                                
+                                if ((prop = (*niter)->property (X_("azimuth")))) {
+                                        sscanf (prop->value().c_str(), "%lg", &a.azi);
+                                } else if ((prop = (*niter)->property (X_("x")))) {
+                                        /* old school cartesian */
+                                        a.azi = BaseStereoPanner::lr_fract_to_azimuth (atof (prop->value().c_str()));
+                                }
+                                
+                                if ((prop = (*niter)->property (X_("elevation")))) {
+                                        sscanf (prop->value().c_str(), "%lg", &a.ele);
+                                }
+                                
+                                outputs.push_back (Output (a));
+                        }
+                }
+        }
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 
@@ -1223,18 +1027,17 @@ Panner::set_state (const XMLNode& node, int version)
                                                   assumption, but it's still an assumption.
                                                */
 
-                                               sp = pan_plugins[i].factory (*this, Evoral::Parameter(PanAutomation, 0, num_panners));
+                                               sp = pan_plugins[i].factory (*this, Evoral::Parameter(PanAutomation, 0, num_panners), _session.get_speakers ());
                                                num_panners++;
 
                                                if (sp->set_state (**niter, version) == 0) {
                                                        _streampanners.push_back (sp);
-                                               }
+                                                }
 
                                                break;
                                        }
                                }
 
-
                                if (!pan_plugins[i].factory) {
                                        error << string_compose (_("Unknown panner plugin \"%1\" found in pan state - ignored"),
                                                          prop->value())
@@ -1250,7 +1053,10 @@ Panner::set_state (const XMLNode& node, int version)
                }
        }
 
+        setup_meta_controls ();
+
        reset (outputs.size (), num_panners);
+
        /* don't try to do old-school automation loading if it wasn't marked as existing */
 
        if ((prop = node.property (X_("automation")))) {
@@ -1265,7 +1071,7 @@ Panner::set_state (const XMLNode& node, int version)
                        set_automation_xml_state (**niter, Evoral::Parameter (PanAutomation));
                }
        }
-       
+
        return 0;
 }
 
@@ -1282,122 +1088,21 @@ Panner::touching () const
 }
 
 void
-Panner::set_position (float xpos, StreamPanner& orig)
-{
-       float xnow;
-       float xdelta ;
-       float xnew;
-
-       orig.get_position (xnow);
-       xdelta = xpos - xnow;
-
-       if (_link_direction == SameDirection) {
-
-               for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
-                       if (*i == &orig) {
-                               (*i)->set_position (xpos, true);
-                       } else {
-                               (*i)->get_position (xnow);
-                               xnew = min (1.0f, xnow + xdelta);
-                               xnew = max (0.0f, xnew);
-                               (*i)->set_position (xnew, true);
-                       }
-               }
-
-       } else {
-
-               for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
-                       if (*i == &orig) {
-                               (*i)->set_position (xpos, true);
-                       } else {
-                               (*i)->get_position (xnow);
-                               xnew = min (1.0f, xnow - xdelta);
-                               xnew = max (0.0f, xnew);
-                               (*i)->set_position (xnew, true);
-                       }
-               }
-       }
-}
-
-void
-Panner::set_position (float xpos, float ypos, StreamPanner& orig)
-{
-       float xnow, ynow;
-       float xdelta, ydelta;
-       float xnew, ynew;
-
-       orig.get_position (xnow, ynow);
-       xdelta = xpos - xnow;
-       ydelta = ypos - ynow;
-
-       if (_link_direction == SameDirection) {
-
-               for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
-                       if (*i == &orig) {
-                               (*i)->set_position (xpos, ypos, true);
-                       } else {
-                               (*i)->get_position (xnow, ynow);
-
-                               xnew = min (1.0f, xnow + xdelta);
-                               xnew = max (0.0f, xnew);
-
-                               ynew = min (1.0f, ynow + ydelta);
-                               ynew = max (0.0f, ynew);
-
-                               (*i)->set_position (xnew, ynew, true);
-                       }
-               }
-
-       } else {
-
-               for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
-                       if (*i == &orig) {
-                               (*i)->set_position (xpos, ypos, true);
-                       } else {
-                               (*i)->get_position (xnow, ynow);
-
-                               xnew = min (1.0f, xnow - xdelta);
-                               xnew = max (0.0f, xnew);
-
-                               ynew = min (1.0f, ynow - ydelta);
-                               ynew = max (0.0f, ynew);
-
-                               (*i)->set_position (xnew, ynew, true);
-                       }
-               }
-       }
-}
-
-void
-Panner::set_position (float xpos, float ypos, float zpos, StreamPanner& orig)
+Panner::set_position (const AngularVector& a, StreamPanner& orig)
 {
-       float xnow, ynow, znow;
-       float xdelta, ydelta, zdelta;
-       float xnew, ynew, znew;
+       AngularVector delta;
+       AngularVector new_position;
 
-       orig.get_position (xnow, ynow, znow);
-       xdelta = xpos - xnow;
-       ydelta = ypos - ynow;
-       zdelta = zpos - znow;
+       delta = orig.get_position() - a;
 
        if (_link_direction == SameDirection) {
 
                for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
                        if (*i == &orig) {
-                               (*i)->set_position (xpos, ypos, zpos, true);
+                               (*i)->set_position (a, true);
                        } else {
-                               (*i)->get_position (xnow, ynow, znow);
-
-                               xnew = min (1.0f, xnow + xdelta);
-                               xnew = max (0.0f, xnew);
-
-                               ynew = min (1.0f, ynow + ydelta);
-                               ynew = max (0.0f, ynew);
-
-                               znew = min (1.0f, znow + zdelta);
-                               znew = max (0.0f, znew);
-
-                               (*i)->set_position (xnew, ynew, znew, true);
+                               new_position = (*i)->get_position() + delta;
+                               (*i)->set_position (new_position, true);
                        }
                }
 
@@ -1405,27 +1110,17 @@ Panner::set_position (float xpos, float ypos, float zpos, StreamPanner& orig)
 
                for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
                        if (*i == &orig) {
-                               (*i)->set_position (xpos, ypos, true);
+                               (*i)->set_position (a, true);
                        } else {
-                               (*i)->get_position (xnow, ynow, znow);
-
-                               xnew = min (1.0f, xnow - xdelta);
-                               xnew = max (0.0f, xnew);
-
-                               ynew = min (1.0f, ynow - ydelta);
-                               ynew = max (0.0f, ynew);
-
-                               znew = min (1.0f, znow + zdelta);
-                               znew = max (0.0f, znew);
-
-                               (*i)->set_position (xnew, ynew, znew, true);
+                               new_position = (*i)->get_position() - delta;
+                               (*i)->set_position (new_position, true);
                        }
                }
        }
 }
 
 void
-Panner::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, nframes_t nframes, gain_t gain_coeff)
+Panner::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, pframes_t nframes, gain_t gain_coeff)
 {
        if (outbufs.count().n_audio() == 0) {
                // Don't want to lose audio...
@@ -1496,7 +1191,7 @@ Panner::distribute_no_automation (BufferSet& inbufs, BufferSet& outbufs, nframes
 }
 
 void
-Panner::run (BufferSet& inbufs, BufferSet& outbufs, framepos_t start_frame, framepos_t end_frame, nframes_t nframes)
+Panner::run (BufferSet& inbufs, BufferSet& outbufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
 {
        if (outbufs.count().n_audio() == 0) {
                // Failing to deliver audio we were asked to deliver is a bug
@@ -1670,3 +1365,188 @@ Panner::value_as_string (double v)
 
        return "";
 }
+
+void
+Panner::setup_speakers (uint32_t nouts)
+{
+       switch (nouts) {
+       case 3:
+               /* top, bottom kind-of-left & bottom kind-of-right */
+               outputs.push_back (AngularVector (90.0, 0.0));
+               outputs.push_back (AngularVector (215.0, 0,0));
+               outputs.push_back (AngularVector (335.0, 0,0));
+               break;
+       case 4:
+               /* clockwise from top left */
+               outputs.push_back (AngularVector (135.0, 0.0));
+               outputs.push_back (AngularVector (45.0, 0.0));
+               outputs.push_back (AngularVector (335.0, 0.0));
+               outputs.push_back (AngularVector (215.0, 0.0));
+               break;
+
+       default: 
+       {
+               double degree_step = 360.0 / nouts;
+               double deg;
+               uint32_t n;
+
+               /* even number of speakers? make sure the top two are either side of "top".
+                  otherwise, just start at the "top" (90.0 degrees) and rotate around
+               */
+
+               if (nouts % 2) {
+                       deg = 90.0 - degree_step;
+               } else {
+                       deg = 90.0;
+               }
+               for (n = 0; n < nouts; ++n, deg += degree_step) {
+                       outputs.push_back (Output (AngularVector (deg, 0.0)));
+               }
+       }
+       }
+
+       Speakers& speakers (_session.get_speakers());
+                        
+       speakers.clear_speakers ();
+
+       for (vector<Output>::iterator o = outputs.begin(); o != outputs.end(); ++o) {
+               speakers.add_speaker ((*o).position);
+       }
+}
+
+void
+Panner::set_stereo_width (double val)
+{
+        boost::shared_ptr<AutomationControl> dc = direction_control();
+        if (dc) {
+                dc->set_value (val);
+        }
+}
+
+void
+Panner::set_stereo_position (double val)
+{
+        boost::shared_ptr<AutomationControl> wc = width_control();
+        if (wc) {
+                wc->set_value (val);
+        }
+}
+
+bool
+Panner::set_stereo_pan (double direction_as_lr_fract, double width)
+{
+        AngularVector p (BaseStereoPanner::lr_fract_to_azimuth (direction_as_lr_fract), 0.0);
+        /* width parameter ranges from -1..+1 with 0.0 at center. we want 0..+1 plus knowing
+           whether its "reversed" (i.e. left signal pans right and right signal pans left).
+           full width = 180 degrees
+        */
+        double spread = 2.0 * fabs(width/2.0) * 180.0; 
+        double l_pos = p.azi + (spread/2.0);  /* more left is "increasing degrees" */
+        double r_pos = p.azi - (spread/2.0);  /* more right is "decreasing degrees" */
+        bool move_left = true;
+        bool move_right = true;
+        int l_index = 0;
+        int r_index = 1;
+
+        assert (_streampanners.size() > 1);
+
+        if (width < 0.0) {
+                swap (l_index, r_index);
+        }
+
+        l_pos = max (min (l_pos, 180.0), 0.0);
+        r_pos = max (min (r_pos, 180.0), 0.0);
+
+        /* if the new left position is less than or equal to 180 (hard left) and the left panner
+           is already there, we're not moving the left signal. 
+        */
+
+        if (l_pos >= 180.0 &&_streampanners[l_index]->get_position().azi == 180.0) {
+                move_left = false;
+        }
+
+        /* if the new right position is less than or equal to zero (hard right) and the right panner
+           is already there, we're not moving the right signal. 
+        */
+        
+        if (r_pos <= 0.0 && _streampanners[r_index]->get_position().azi == 0.0) {
+                move_right = false;
+        }
+
+        if (move_left && move_right) {
+                _streampanners[l_index]->set_position (AngularVector (l_pos, 0.0));
+                _streampanners[r_index]->set_position (AngularVector (r_pos, 0.0));
+        }
+
+        return move_left && move_right;
+}
+
+void
+Panner::setup_meta_controls ()
+{
+        if (_streampanners.size() != 2 || outputs.size() != 2) {
+                return;
+        }
+
+        /* 2 signals to 2 outputs: provide "classic" controls for easier manipulation.
+           
+           The ID numbers used here don't really matter that much, because Parameters are scoped by owner,
+           but they keep us out of the ordinary range of pan-related parameters.
+        */
+        
+        Evoral::Parameter lr_param (PanAutomation, 0, 100);
+        Evoral::Parameter width_param (PanAutomation, 0, 200);
+        boost::shared_ptr<AutomationControl> dc = automation_control (lr_param);
+        boost::shared_ptr<AutomationControl> wc = automation_control (width_param);
+
+        if (dc) {
+               /* reset parent StreamPanner as the current one may have been deleted */
+               boost::shared_ptr<StreamPanner::PanControllable> p = boost::dynamic_pointer_cast<StreamPanner::PanControllable> (dc);
+               assert (p);
+               p->streampanner = _streampanners.front ();
+       } else {
+                dc.reset (new StreamPanner::PanControllable (_session, _("lr"), _streampanners.front(), lr_param));
+                add_control (dc);
+        }
+        
+        if (wc) {
+               /* reset parent as above */
+               boost::shared_ptr<StreamPanner::PanControllable> p = boost::dynamic_pointer_cast<StreamPanner::PanControllable> (wc);
+               assert (p);
+               p->streampanner = _streampanners.front ();
+       } else {
+                wc.reset (new StreamPanner::PanControllable (_session, _("width"), _streampanners.front(), width_param));
+                add_control (wc);
+        }
+
+        dc->set_value (0.5);
+        wc->set_value (1.0); // full width
+}
+
+string
+Panner::describe_parameter (Evoral::Parameter param)
+{
+        if (param.type() == PanAutomation) {
+                switch (param.id()) {
+                case 100:
+                        return "Pan:position";
+                case 200:
+                        return "Pan:width";
+                default:
+                        if (_streampanners.size() == 2) {
+                                switch (param.id()) {
+                                case 0:
+                                        return "Pan L";
+                                default:
+                                        return "Pan R";
+                                }
+                        } else {
+                                stringstream ss;
+                                ss << "Pan " << param.id() + 1;
+                                return ss.str ();
+                        }
+                }
+        }
+
+        return Automatable::describe_parameter (param);
+}