Fix logic so that soloing a bus does not mute things that feed it.
[ardour.git] / libs / ardour / panner.cc
index 993cbe39f84c39e9072a70744d58dae789f787d2..d3ce72679a6513d6898d0776e84d265c859e7291 100644 (file)
@@ -61,41 +61,48 @@ 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
+/* 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 pan_t direct_control_to_pan (double fract)
+{
        return fract;
 }
 
-
-//static double direct_pan_to_control (pan_t val) {
-//     return val;
-//}
-
 StreamPanner::StreamPanner (Panner& p, Evoral::Parameter param)
        : parent (p)
 {
-       assert(param.type() != NullAutomation);
+       assert (param.type() != NullAutomation);
 
        _muted = false;
+       _mono = false;
 
-       _control = boost::dynamic_pointer_cast<AutomationControl>( parent.control( param, true ) );
+       /* 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;
+       _x = 0.5;
+       _y = 0.5;
+       _z = 0.5;
 }
 
 StreamPanner::~StreamPanner ()
 {
 }
 
+void
+StreamPanner::set_mono (bool yn)
+{
+       if (yn != _mono) {
+               _mono = yn;
+               StateChanged ();
+       }
+}
+
 void
 Panner::PanControllable::set_value (float val)
 {
-       panner.streampanner(parameter().id()).set_position (direct_control_to_pan (val));
+       panner.streampanner (parameter().id()).set_position (direct_control_to_pan (val));
        AutomationControl::set_value(val);
 }
 
@@ -121,8 +128,8 @@ StreamPanner::set_position (float xpos, bool link_call)
                parent.set_position (xpos, *this);
        }
 
-       if (x != xpos) {
-               x = xpos;
+       if (_x != xpos) {
+               _x = xpos;
                update ();
                Changed ();
                _control->Changed ();
@@ -136,10 +143,9 @@ StreamPanner::set_position (float xpos, float ypos, bool link_call)
                parent.set_position (xpos, ypos, *this);
        }
 
-       if (x != xpos || y != ypos) {
-
-               x = xpos;
-               y = ypos;
+       if (_x != xpos || _y != ypos) {
+               _x = xpos;
+               _y = ypos;
                update ();
                Changed ();
        }
@@ -152,17 +158,17 @@ StreamPanner::set_position (float xpos, float ypos, float zpos, bool link_call)
                parent.set_position (xpos, ypos, zpos, *this);
        }
 
-       if (x != xpos || y != ypos || z != zpos) {
-               x = xpos;
-               y = ypos;
-               z = zpos;
+       if (_x != xpos || _y != ypos || _z != zpos) {
+               _x = xpos;
+               _y = ypos;
+               _z = zpos;
                update ();
                Changed ();
        }
 }
 
 int
-StreamPanner::set_state (const XMLNode& node, int version)
+StreamPanner::set_state (const XMLNode& node, int /*version*/)
 {
        const XMLProperty* prop;
        XMLNodeConstIterator iter;
@@ -171,6 +177,10 @@ StreamPanner::set_state (const XMLNode& node, int version)
                set_muted (string_is_affirmative (prop->value()));
        }
 
+       if ((prop = node.property (X_("mono")))) {
+               set_mono (string_is_affirmative (prop->value()));
+       }
+       
        return 0;
 }
 
@@ -178,8 +188,42 @@ void
 StreamPanner::add_state (XMLNode& node)
 {
        node.add_property (X_("muted"), (muted() ? "yes" : "no"));
+       node.add_property (X_("mono"), (_mono ? "yes" : "no"));
+}
+
+void
+StreamPanner::distribute (AudioBuffer& src, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
+{
+       if (_mono) {
+               /* we're in mono mode, so just pan the input to all outputs equally */
+               int const N = parent.nouts ();
+               for (int i = 0; i < N; ++i) {
+                       mix_buffers_with_gain (obufs.get_audio(i).data(), src.data(), nframes, gain_coeff);
+               }
+       } else {
+               /* normal mode, call the `real' distribute method */
+               do_distribute (src, obufs, gain_coeff, nframes);
+       }
 }
 
+void
+StreamPanner::distribute_automated (AudioBuffer& src, BufferSet& obufs,
+                                   nframes_t start, nframes_t end, nframes_t nframes, pan_t** buffers)
+{
+       if (_mono) {
+               /* we're in mono mode, so just pan the input to all outputs equally */
+               int const N = parent.nouts ();
+               for (int i = 0; i < N; ++i) {
+                       mix_buffers_with_gain (obufs.get_audio(i).data(), src.data(), nframes, 1.0);
+               }
+       } else {
+               /* normal mode, call the `real' distribute method */
+               do_distribute_automated (src, obufs, start, end, nframes, buffers);
+       }
+       
+}
+
+
 /*---------------------------------------------------------------------- */
 
 BaseStereoPanner::BaseStereoPanner (Panner& p, Evoral::Parameter param)
@@ -225,7 +269,7 @@ BaseStereoPanner::load (istream& in, string path, uint32_t& linecnt)
 }
 
 void
-BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
+BaseStereoPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
 {
        assert(obufs.count().n_audio() == 2);
 
@@ -245,9 +289,10 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
        if (fabsf ((delta = (left - desired_left))) > 0.002) { // about 1 degree of arc
 
-               /* interpolate over 64 frames or nframes, whichever is smaller */
+               /* we've moving the pan by an appreciable amount, so we must
+                  interpolate over 64 frames or nframes, whichever is smaller */
 
-               nframes_t limit = min ((nframes_t)64, nframes);
+               nframes_t const limit = min ((nframes_t)64, nframes);
                nframes_t n;
 
                delta = -(delta / (float) (limit));
@@ -258,6 +303,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
                        dst[n] += src[n] * left * gain_coeff;
                }
 
+               /* then pan the rest of the buffer; no need for interpolation for this bit */
+
                pan = left * gain_coeff;
 
                mix_buffers_with_gain (dst+n,src+n,nframes-n,pan);
@@ -271,6 +318,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
                        if (pan != 0.0f) {
 
+                               /* pan is 1 but also not 0, so we must do it "properly" */
+
                                mix_buffers_with_gain(dst,src,nframes,pan);
 
                                /* mark that we wrote into the buffer */
@@ -281,6 +330,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
                } else {
 
+                       /* pan is 1 so we can just copy the input samples straight in */
+
                        mix_buffers_no_gain(dst,src,nframes);
 
                        /* mark that we wrote into the buffer */
@@ -295,9 +346,10 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
        if (fabsf ((delta = (right - desired_right))) > 0.002) { // about 1 degree of arc
 
-               /* interpolate over 64 frames or nframes, whichever is smaller */
+               /* we're moving the pan by an appreciable amount, so we must
+                  interpolate over 64 frames or nframes, whichever is smaller */
 
-               nframes_t limit = min ((nframes_t)64, nframes);
+               nframes_t const limit = min ((nframes_t)64, nframes);
                nframes_t n;
 
                delta = -(delta / (float) (limit));
@@ -308,6 +360,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
                        dst[n] += src[n] * right * gain_coeff;
                }
 
+               /* then pan the rest of the buffer, no need for interpolation for this bit */
+
                pan = right * gain_coeff;
 
                mix_buffers_with_gain(dst+n,src+n,nframes-n,pan);
@@ -323,6 +377,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
                        if (pan != 0.0f) {
 
+                               /* pan is not 1 but also not 0, so we must do it "properly" */
+                               
                                mix_buffers_with_gain(dst,src,nframes,pan);
 
                                /* XXX it would be nice to mark the buffer as written to */
@@ -330,6 +386,8 @@ BaseStereoPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain
 
                } else {
 
+                       /* pan is 1 so we can just copy the input samples straight in */
+                       
                        mix_buffers_no_gain(dst,src,nframes);
 
                        /* XXX it would be nice to mark the buffer as written to */
@@ -358,9 +416,9 @@ void
 EqualPowerStereoPanner::update ()
 {
        /* it would be very nice to split this out into a virtual function
-          that can be accessed from BaseStereoPanner and used in distribute_automated().
+          that can be accessed from BaseStereoPanner and used in do_distribute_automated().
 
-          but the place where its used in distribute_automated() is a tight inner loop,
+          but the place where its used in do_distribute_automated() is a tight inner loop,
           and making "nframes" virtual function calls to compute values is an absurd
           overhead.
        */
@@ -369,25 +427,25 @@ EqualPowerStereoPanner::update ()
           x == 1 => hard right
        */
 
-       float panR = x;
-       float panL = 1 - panR;
+       float const panR = _x;
+       float const panL = 1 - panR;
 
-       const float pan_law_attenuation = -3.0f;
-       const float scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
+       float const pan_law_attenuation = -3.0f;
+       float const scale = 2.0f - 4.0f * powf (10.0f,pan_law_attenuation/20.0f);
 
        desired_left = panL * (scale * panL + 1.0f - scale);
        desired_right = panR * (scale * panR + 1.0f - scale);
 
-       effective_x = x;
+       effective_x = _x;
        //_control->set_value(x);
 }
 
 void
-EqualPowerStereoPanner::distribute_automated (AudioBuffer& srcbuf, BufferSet& obufs,
-                                             nframes_t start, nframes_t end, nframes_t nframes,
-                                             pan_t** buffers)
+EqualPowerStereoPanner::do_distribute_automated (AudioBuffer& srcbuf, BufferSet& obufs,
+                                                nframes_t start, nframes_t end, nframes_t nframes,
+                                                pan_t** buffers)
 {
-       assert(obufs.count().n_audio() == 2);
+       assert (obufs.count().n_audio() == 2);
 
        Sample* dst;
        pan_t* pbuf;
@@ -398,7 +456,7 @@ EqualPowerStereoPanner::distribute_automated (AudioBuffer& srcbuf, BufferSet& ob
        if (!_control->list()->curve().rt_safe_get_vector (start, end, buffers[0], nframes)) {
                /* fallback */
                if (!_muted) {
-                       distribute (srcbuf, obufs, 1.0, nframes);
+                       do_distribute (srcbuf, obufs, 1.0, nframes);
                }
                return;
        }
@@ -422,8 +480,8 @@ EqualPowerStereoPanner::distribute_automated (AudioBuffer& srcbuf, BufferSet& ob
 
        for (nframes_t n = 0; n < nframes; ++n) {
 
-               float panR = buffers[0][n];
-               float panL = 1 - panR;
+               float const panR = buffers[0][n];
+               float const panL = 1 - panR;
 
                buffers[0][n] = panL * (scale * panL + 1.0f - scale);
                buffers[1][n] = panR * (scale * panR + 1.0f - scale);
@@ -471,7 +529,7 @@ EqualPowerStereoPanner::state (bool /*full_state*/)
        char buf[64];
        LocaleGuard lg (X_("POSIX"));
 
-       snprintf (buf, sizeof (buf), "%.12g", x);
+       snprintf (buf, sizeof (buf), "%.12g", _x);
        root->add_property (X_("x"), buf);
        root->add_property (X_("type"), EqualPowerStereoPanner::name);
 
@@ -496,18 +554,18 @@ EqualPowerStereoPanner::set_state (const XMLNode& node, int version)
                set_position (pos, true);
        }
 
-       StreamPanner::set_state (node);
+       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);
+                               _control->set_state (**iter, version);
                        }
 
                } else if ((*iter)->name() == X_("Automation")) {
 
-                       _control->alist()->set_state (*((*iter)->children().front()));
+                       _control->alist()->set_state (*((*iter)->children().front()), version);
 
                        if (_control->alist()->automation_state() != Off) {
                                set_position (_control->list()->eval (parent.session().transport_frame()));
@@ -535,7 +593,7 @@ Multi2dPanner::update ()
 {
        static const float BIAS = FLT_MIN;
        uint32_t i;
-       uint32_t nouts = parent.outputs.size();
+       uint32_t const nouts = parent.nouts ();
        float dsq[nouts];
        float f, fr;
        vector<pan_t> pans;
@@ -543,7 +601,7 @@ Multi2dPanner::update ()
        f = 0.0f;
 
        for (i = 0; i < nouts; i++) {
-               dsq[i] = ((x - parent.outputs[i].x) * (x - parent.outputs[i].x) + (y - parent.outputs[i].y) * (y - parent.outputs[i].y) + BIAS);
+               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;
                }
@@ -556,19 +614,17 @@ Multi2dPanner::update ()
        fr = 1.0 / sqrtf(f);
 #endif
        for (i = 0; i < nouts; ++i) {
-               parent.outputs[i].desired_pan = 1.0f - (dsq[i] * fr);
+               parent.output(i).desired_pan = 1.0f - (dsq[i] * fr);
        }
 
-       effective_x = x;
+       effective_x = _x;
 }
 
 void
-Multi2dPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
+Multi2dPanner::do_distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_coeff, nframes_t nframes)
 {
        Sample* dst;
        pan_t pan;
-       vector<Panner::Output>::iterator o;
-       uint32_t n;
 
        if (_muted) {
                return;
@@ -576,8 +632,9 @@ Multi2dPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_co
 
        Sample* const src = srcbuf.data();
 
-
-       for (n = 0, o = parent.outputs.begin(); o != parent.outputs.end(); ++o, ++n) {
+       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();
 
@@ -603,13 +660,14 @@ Multi2dPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_co
                } else {
 
 #else
-                       pan = (*o).desired_pan;
+                       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);
                        }
@@ -623,9 +681,9 @@ Multi2dPanner::distribute (AudioBuffer& srcbuf, BufferSet& obufs, gain_t gain_co
 }
 
 void
-Multi2dPanner::distribute_automated (AudioBuffer& /*src*/, BufferSet& /*obufs*/,
-                                    nframes_t /*start*/, nframes_t /*end*/, nframes_t /*nframes*/,
-                                    pan_t** /*buffers*/)
+Multi2dPanner::do_distribute_automated (AudioBuffer& /*src*/, BufferSet& /*obufs*/,
+                                       nframes_t /*start*/, nframes_t /*end*/, nframes_t /*nframes*/,
+                                       pan_t** /*buffers*/)
 {
        if (_muted) {
                return;
@@ -661,9 +719,9 @@ Multi2dPanner::state (bool /*full_state*/)
        char buf[64];
        LocaleGuard lg (X_("POSIX"));
 
-       snprintf (buf, sizeof (buf), "%.12g", x);
+       snprintf (buf, sizeof (buf), "%.12g", _x);
        root->add_property (X_("x"), buf);
-       snprintf (buf, sizeof (buf), "%.12g", y);
+       snprintf (buf, sizeof (buf), "%.12g", _y);
        root->add_property (X_("y"), buf);
        root->add_property (X_("type"), Multi2dPanner::name);
 
@@ -673,7 +731,7 @@ Multi2dPanner::state (bool /*full_state*/)
 }
 
 int
-Multi2dPanner::set_state (const XMLNode& node, int version)
+Multi2dPanner::set_state (const XMLNode& node, int /*version*/)
 {
        const XMLProperty* prop;
        float newx,newy;
@@ -690,7 +748,7 @@ Multi2dPanner::set_state (const XMLNode& node, int version)
                newy = atof (prop->value().c_str());
        }
 
-       if (x < 0 || y < 0) {
+       if (_x < 0 || _y < 0) {
                error << _("badly-formed positional data for Multi2dPanner - ignored")
                      << endmsg;
                return -1;
@@ -712,6 +770,7 @@ Panner::Panner (string name, Session& s)
        _linked = false;
        _link_direction = SameDirection;
        _bypassed = false;
+       _mono = false;
 }
 
 Panner::~Panner ()
@@ -823,6 +882,12 @@ Panner::reset_streampanner (uint32_t which)
        }
 }
 
+/**
+ *    Reset the panner with a given number of outs and panners (and hence inputs)
+ *
+ *    \param nouts Number of outputs.
+ *    \param npans Number of panners.
+ */
 void
 Panner::reset (uint32_t nouts, uint32_t npans)
 {
@@ -830,8 +895,6 @@ Panner::reset (uint32_t nouts, uint32_t npans)
        bool changed = false;
        bool do_not_and_did_not_need_panning = ((nouts < 2) && (outputs.size() < 2));
 
-       cout << "Reset panner for " << nouts << " " << npans << "\n";
-
        /* if new and old config don't need panning, or if
           the config hasn't changed, we're done.
        */
@@ -857,7 +920,10 @@ Panner::reset (uint32_t nouts, uint32_t npans)
 
        if (nouts < 2) {
                /* no need for panning with less than 2 outputs */
-               goto send_changed;
+               if (changed) {
+                       Changed (); /* EMIT SIGNAL */
+               }
+               return;
        }
 
        switch (nouts) {
@@ -935,6 +1001,14 @@ Panner::reset (uint32_t nouts, uint32_t npans)
                (*x)->update ();
        }
 
+       /* 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.
+       */
+       
+       if (changed) {
+               Changed (); /* EMIT SIGNAL */
+       }
+
        /* force hard left/right panning in a common case: 2in/2out
        */
 
@@ -957,17 +1031,8 @@ Panner::reset (uint32_t nouts, uint32_t npans)
 
                        _streampanners.back()->set_position (1.0);
                        _streampanners.back()->pan_control()->list()->reset_default (1.0);
-
-                       changed = true;
                }
        }
-
-  send_changed:
-       if (changed) {
-               Changed (); /* EMIT SIGNAL */
-       }
-
-       return;
 }
 
 void
@@ -1154,7 +1219,7 @@ Panner::set_state (const XMLNode& node, int version)
                                                sp = pan_plugins[i].factory (*this, Evoral::Parameter(PanAutomation, 0, num_panners));
                                                num_panners++;
 
-                                               if (sp->set_state (**niter) == 0) {
+                                               if (sp->set_state (**niter, version) == 0) {
                                                        _streampanners.push_back (sp);
                                                }
 
@@ -1557,3 +1622,16 @@ Panner::load ()
 
        return 0;
 }
+
+void
+Panner::set_mono (bool yn)
+{
+       if (yn != _mono) {
+               _mono = yn;
+               StateChanged ();
+       }
+
+       for (vector<StreamPanner*>::iterator i = _streampanners.begin(); i != _streampanners.end(); ++i) {
+               (*i)->set_mono (yn);
+       }
+}