fix possible deadlock replacing processor state.
[ardour.git] / libs / ardour / monitor_processor.cc
index 51bd30a389bff38807f8ca6ea33ccc634fd8ba3f..e5c58009af764fccd9b0f6e3302039ca8e8b4779 100644 (file)
@@ -1,9 +1,28 @@
+/*
+    Copyright (C) 2010 Paul Davis
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
 #include "pbd/convert.h"
 #include "pbd/error.h"
+#include "pbd/locale_guard.h"
 #include "pbd/xml++.h"
 
 #include "ardour/amp.h"
-#include "ardour/dB.h"
 #include "ardour/debug.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/monitor_processor.h"
@@ -15,30 +34,72 @@ using namespace ARDOUR;
 using namespace PBD;
 using namespace std;
 
+/* specialize for bool because of set_value() semantics */
+
+namespace ARDOUR {
+       template<> void MPControl<bool>::set_value (double v, PBD::Controllable::GroupControlDisposition gcd) {
+                bool newval = fabs (v) >= 0.5;
+                if (newval != _value) {
+                        _value = newval;
+                        Changed (true, gcd); /* EMIT SIGNAL */
+                }
+        }
+}
+
 MonitorProcessor::MonitorProcessor (Session& s)
         : Processor (s, X_("MonitorOut"))
+        , solo_cnt (0)
+        , _monitor_active (false)
+
+        , _dim_all_ptr (new MPControl<bool> (false, _("monitor dim"), Controllable::Toggle))
+        , _cut_all_ptr (new MPControl<bool> (false, _("monitor cut"), Controllable::Toggle))
+        , _mono_ptr (new MPControl<bool> (false, _("monitor mono"), Controllable::Toggle))
+        , _dim_level_ptr (new MPControl<volatile gain_t>
+                         /* default is -12dB, range is -20dB to 0dB */
+                          (dB_to_coefficient(-12.0), _("monitor dim level"), Controllable::Flag (0),
+                          dB_to_coefficient(-20.0), dB_to_coefficient (0.0)))
+        , _solo_boost_level_ptr (new MPControl<volatile gain_t>
+                                /* default is 0dB, range is 0dB to +20dB */
+                                 (dB_to_coefficient(0.0), _("monitor solo boost level"), Controllable::Flag (0),
+                                 dB_to_coefficient(0.0), dB_to_coefficient(10.0)))
+        , _dim_all_control (_dim_all_ptr)
+        , _cut_all_control (_cut_all_ptr)
+        , _mono_control (_mono_ptr)
+        , _dim_level_control (_dim_level_ptr)
+        , _solo_boost_level_control (_solo_boost_level_ptr)
+
+        , _dim_all (*_dim_all_ptr)
+        , _cut_all (*_cut_all_ptr)
+        , _mono (*_mono_ptr)
+        , _dim_level (*_dim_level_ptr)
+        , _solo_boost_level (*_solo_boost_level_ptr)
+
 {
-        solo_cnt = 0;
-        _cut_all = false;
-        _dim_all = false;
-        _dim_level = 0.2;
-        _solo_boost_level = 1.0;
+}
+
+MonitorProcessor::~MonitorProcessor ()
+{
+        allocate_channels (0);
 }
 
 void
 MonitorProcessor::allocate_channels (uint32_t size)
 {
         while (_channels.size() > size) {
-                if (_channels.back().soloed) {
+                if (_channels.back()->soloed) {
                         if (solo_cnt > 0) {
                                 --solo_cnt;
                         }
                 }
+                ChannelRecord* cr = _channels.back();
                 _channels.pop_back();
+                delete cr;
         }
 
+        uint32_t n = _channels.size() + 1;
+
         while (_channels.size() < size) {
-                _channels.push_back (ChannelRecord());
+                _channels.push_back (new ChannelRecord (n));
         }
 }
 
@@ -51,7 +112,7 @@ MonitorProcessor::set_state (const XMLNode& node, int version)
                 return ret;
         }
 
-        const XMLProperty* prop;
+        XMLProperty const * prop;
 
         if ((prop = node.property (X_("type"))) == 0) {
                 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings have no type information"))
@@ -70,16 +131,16 @@ MonitorProcessor::set_state (const XMLNode& node, int version)
                       << endmsg;
                 return -1;
         }
-        
+
         allocate_channels (atoi (prop->value()));
 
         if ((prop = node.property (X_("dim-level"))) != 0) {
-                double val = atof (prop->value());
+                gain_t val = atof (prop->value());
                 _dim_level = val;
         }
 
         if ((prop = node.property (X_("solo-boost-level"))) != 0) {
-                double val = atof (prop->value());
+                gain_t val = atof (prop->value());
                 _solo_boost_level = val;
         }
 
@@ -112,19 +173,19 @@ MonitorProcessor::set_state (const XMLNode& node, int version)
                                       << endmsg;
                                 return -1;
                         }
-                        
+
                         if (chn >= _channels.size()) {
                                 error << string_compose (X_("programming error: %1"), X_("MonitorProcessor XML settings has an illegal channel count"))
                                       << endmsg;
                                 return -1;
                         }
-                        ChannelRecord& cr (_channels[chn]);
+                        ChannelRecord& cr (*_channels[chn]);
 
                         if ((prop = (*i)->property ("cut")) != 0) {
                                 if (string_is_affirmative (prop->value())){
-                                        cr.cut = 0.0f;
+                                        cr.cut = GAIN_COEFF_ZERO;
                                 } else {
-                                        cr.cut = 1.0f;
+                                        cr.cut = GAIN_COEFF_UNITY;
                                 }
                         }
 
@@ -147,40 +208,42 @@ MonitorProcessor::set_state (const XMLNode& node, int version)
                         }
                 }
         }
-        
+
         /* reset solo cnt */
 
         solo_cnt = 0;
 
-        for (vector<ChannelRecord>::const_iterator x = _channels.begin(); x != _channels.end(); ++x) {
-                if (x->soloed) {
+        for (vector<ChannelRecord*>::const_iterator x = _channels.begin(); x != _channels.end(); ++x) {
+                if ((*x)->soloed) {
                         solo_cnt++;
                 }
         }
-        
-        return 0;
+
+       update_monitor_state ();
+       return 0;
 }
 
 XMLNode&
 MonitorProcessor::state (bool full)
 {
+       LocaleGuard lg;
         XMLNode& node (Processor::state (full));
         char buf[64];
 
        /* this replaces any existing "type" property */
 
        node.add_property (X_("type"), X_("monitor"));
-        
-        snprintf (buf, sizeof(buf), "%.12g", _dim_level);
+
+        snprintf (buf, sizeof(buf), "%.12g", _dim_level.val());
         node.add_property (X_("dim-level"), buf);
 
-        snprintf (buf, sizeof(buf), "%.12g", _solo_boost_level);
+        snprintf (buf, sizeof(buf), "%.12g", _solo_boost_level.val());
         node.add_property (X_("solo-boost-level"), buf);
 
         node.add_property (X_("cut-all"), (_cut_all ? "yes" : "no"));
         node.add_property (X_("dim-all"), (_dim_all ? "yes" : "no"));
         node.add_property (X_("mono"), (_mono ? "yes" : "no"));
-        
+
         uint32_t limit = _channels.size();
 
         snprintf (buf, sizeof (buf), "%u", limit);
@@ -189,17 +252,17 @@ MonitorProcessor::state (bool full)
         XMLNode* chn_node;
         uint32_t chn = 0;
 
-        for (vector<ChannelRecord>::const_iterator x = _channels.begin(); x != _channels.end(); ++x, ++chn) {
+        for (vector<ChannelRecord*>::const_iterator x = _channels.begin(); x != _channels.end(); ++x, ++chn) {
                 chn_node = new XMLNode (X_("Channel"));
 
                 snprintf (buf, sizeof (buf), "%u", chn);
                 chn_node->add_property ("id", buf);
 
-                chn_node->add_property (X_("cut"), x->cut == 1.0 ? "no" : "yes");
-                chn_node->add_property (X_("invert"), x->polarity == 1.0 ? "no" : "yes");
-                chn_node->add_property (X_("dim"), x->dim ? "yes" : "no");
-                chn_node->add_property (X_("solo"), x->soloed ? "yes" : "no");
-                
+                chn_node->add_property (X_("cut"), (*x)->cut == GAIN_COEFF_UNITY ? "no" : "yes");
+                chn_node->add_property (X_("invert"), (*x)->polarity == GAIN_COEFF_UNITY ? "no" : "yes");
+                chn_node->add_property (X_("dim"), (*x)->dim ? "yes" : "no");
+                chn_node->add_property (X_("solo"), (*x)->soloed ? "yes" : "no");
+
                 node.add_child_nocopy (*chn_node);
         }
 
@@ -207,55 +270,40 @@ MonitorProcessor::state (bool full)
 }
 
 void
-MonitorProcessor::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*end_frame*/, nframes_t nframes, bool /*result_required*/)
+MonitorProcessor::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool /*result_required*/)
 {
         uint32_t chn = 0;
         gain_t target_gain;
         gain_t dim_level_this_time = _dim_level;
-        gain_t global_cut = (_cut_all ? 0.0f : 1.0f);
-        gain_t global_dim = (_dim_all ? dim_level_this_time : 1.0f);
+        gain_t global_cut = (_cut_all ? GAIN_COEFF_ZERO : GAIN_COEFF_UNITY);
+        gain_t global_dim = (_dim_all ? dim_level_this_time : GAIN_COEFF_UNITY);
         gain_t solo_boost;
 
         if (_session.listening() || _session.soloing()) {
                 solo_boost = _solo_boost_level;
         } else {
-                solo_boost = 1.0;
+                solo_boost = GAIN_COEFF_UNITY;
         }
 
         for (BufferSet::audio_iterator b = bufs.audio_begin(); b != bufs.audio_end(); ++b) {
 
                 /* don't double-scale by both track dim and global dim coefficients */
 
-                gain_t dim_level = (global_dim == 1.0 ? (_channels[chn].dim ? dim_level_this_time : 1.0) : 1.0);
+                gain_t dim_level = (global_dim == GAIN_COEFF_UNITY ? (_channels[chn]->dim ? dim_level_this_time : GAIN_COEFF_UNITY) : GAIN_COEFF_UNITY);
 
-                if (_channels[chn].soloed) {
-                        target_gain = _channels[chn].polarity * _channels[chn].cut * dim_level * global_cut * global_dim * solo_boost;
+                if (_channels[chn]->soloed) {
+                        target_gain = _channels[chn]->polarity * _channels[chn]->cut * dim_level * global_cut * global_dim * solo_boost;
                 } else {
                         if (solo_cnt == 0) {
-                                target_gain = _channels[chn].polarity * _channels[chn].cut * dim_level * global_cut * global_dim * solo_boost;
+                                target_gain = _channels[chn]->polarity * _channels[chn]->cut * dim_level * global_cut * global_dim * solo_boost;
                         } else {
-                                target_gain = 0.0;
+                                target_gain = GAIN_COEFF_ZERO;
                         }
                 }
 
-                DEBUG_TRACE (DEBUG::Monitor, 
-                             string_compose("channel %1 sb %2 gc %3 gd %4 cd %5 dl %6 cp %7 cc %8 cs %9 sc %10 TG %11\n", 
-                                            chn, 
-                                            solo_boost,
-                                            global_cut,
-                                            global_dim,
-                                            _channels[chn].dim,
-                                            dim_level,
-                                            _channels[chn].polarity,
-                                            _channels[chn].cut,
-                                            _channels[chn].soloed,
-                                            solo_cnt,
-                                            target_gain));
-                
-                if (target_gain != _channels[chn].current_gain || target_gain != 1.0f) {
-
-                        Amp::apply_gain (*b, nframes, _channels[chn].current_gain, target_gain);
-                        _channels[chn].current_gain = target_gain;
+                if (target_gain != _channels[chn]->current_gain || target_gain != GAIN_COEFF_UNITY) {
+
+                        _channels[chn]->current_gain = Amp::apply_gain (*b, _session.nominal_frame_rate(), nframes, _channels[chn]->current_gain, target_gain);
                 }
 
                 ++chn;
@@ -266,14 +314,14 @@ MonitorProcessor::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*e
 
                 /* chn is now the number of channels, use as a scaling factor when mixing
                  */
-                gain_t scale = 1.0/chn;
+                gain_t scale = 1.f / (float)chn;
                 BufferSet::audio_iterator b = bufs.audio_begin();
                 AudioBuffer& ab (*b);
                 Sample* buf = ab.data();
 
                 /* scale the first channel */
 
-                for (nframes_t n = 0; n < nframes; ++n) {
+                for (pframes_t n = 0; n < nframes; ++n) {
                         buf[n] *= scale;
                 }
 
@@ -283,7 +331,7 @@ MonitorProcessor::run (BufferSet& bufs, sframes_t /*start_frame*/, sframes_t /*e
                 for (; b != bufs.audio_end(); ++b) {
                         AudioBuffer& ob (*b);
                         Sample* obuf = ob.data ();
-                        for (nframes_t n = 0; n < nframes; ++n) {
+                        for (pframes_t n = 0; n < nframes; ++n) {
                                 buf[n] += obuf[n] * scale;
                         }
                 }
@@ -307,70 +355,78 @@ MonitorProcessor::configure_io (ChanCount in, ChanCount out)
         return Processor::configure_io (in, out);
 }
 
-bool 
-MonitorProcessor::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+bool
+MonitorProcessor::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 {
-        return in == out;
+       out = in;
+       return true;
 }
 
 void
 MonitorProcessor::set_polarity (uint32_t chn, bool invert)
 {
-        if (invert) {
-                _channels[chn].polarity = -1.0f;
-        } else {
-                _channels[chn].polarity = 1.0f;
-        }
-}       
+       if (invert) {
+               _channels[chn]->polarity = -1.0f;
+       } else {
+               _channels[chn]->polarity = 1.0f;
+       }
+       update_monitor_state ();
+}
 
 void
 MonitorProcessor::set_dim (uint32_t chn, bool yn)
 {
-        _channels[chn].dim = yn;
+       _channels[chn]->dim = yn;
+       update_monitor_state ();
 }
 
 void
 MonitorProcessor::set_cut (uint32_t chn, bool yn)
 {
-        if (yn) {
-                _channels[chn].cut = 0.0f;
-        } else {
-                _channels[chn].cut = 1.0f;
-        }
+       if (yn) {
+               _channels[chn]->cut = GAIN_COEFF_ZERO;
+       } else {
+               _channels[chn]->cut = GAIN_COEFF_UNITY;
+       }
+       update_monitor_state ();
 }
 
 void
 MonitorProcessor::set_solo (uint32_t chn, bool solo)
 {
-        if (solo != _channels[chn].soloed) {
-                _channels[chn].soloed = solo;
-                
-                if (solo) {
-                        solo_cnt++;
-                } else {
-                        if (solo_cnt > 0) {
-                                solo_cnt--;
-                        }
-                }
-        }
+       if (solo != _channels[chn]->soloed) {
+               _channels[chn]->soloed = solo;
+
+               if (solo) {
+                       solo_cnt++;
+               } else {
+                       if (solo_cnt > 0) {
+                               solo_cnt--;
+                       }
+               }
+       }
+       update_monitor_state ();
 }
 
 void
 MonitorProcessor::set_mono (bool yn)
 {
-        _mono = yn;
+       _mono = yn;
+       update_monitor_state ();
 }
 
 void
 MonitorProcessor::set_cut_all (bool yn)
 {
-        _cut_all = yn;
+       _cut_all = yn;
+       update_monitor_state ();
 }
 
 void
 MonitorProcessor::set_dim_all (bool yn)
 {
-        _dim_all = yn;
+       _dim_all = yn;
+       update_monitor_state ();
 }
 
 bool
@@ -379,42 +435,30 @@ MonitorProcessor::display_to_user () const
         return false;
 }
 
-void
-MonitorProcessor::set_dim_level (gain_t val)
-{
-        _dim_level = val;
-}
-
-void
-MonitorProcessor::set_solo_boost_level (gain_t val)
-{
-        _solo_boost_level = val;
-}
-
-bool 
+bool
 MonitorProcessor::soloed (uint32_t chn) const
 {
-        return _channels[chn].soloed;
+        return _channels[chn]->soloed;
 }
 
 
-bool 
+bool
 MonitorProcessor::inverted (uint32_t chn) const
 {
-        return _channels[chn].polarity < 0.0f;
+        return _channels[chn]->polarity < 0.0f;
 }
 
 
-bool 
+bool
 MonitorProcessor::cut (uint32_t chn) const
 {
-        return _channels[chn].cut == 0.0f;
+        return _channels[chn]->cut == GAIN_COEFF_ZERO;
 }
 
-bool 
+bool
 MonitorProcessor::dimmed (uint32_t chn) const
 {
-        return _channels[chn].dim;
+        return _channels[chn]->dim;
 }
 
 bool
@@ -434,3 +478,82 @@ MonitorProcessor::cut_all () const
 {
         return _cut_all;
 }
+
+void
+MonitorProcessor::update_monitor_state ()
+{
+       bool en = false;
+
+       if (_cut_all || _dim_all || _mono) {
+               en = true;
+       }
+
+       const uint32_t nchans = _channels.size();
+       for (uint32_t i = 0; i < nchans && !en; ++i) {
+               if (cut (i) || dimmed (i) || soloed (i) || inverted (i)) {
+                       en = true;
+                       break;
+               }
+       }
+
+       if (_monitor_active != en) {
+               _monitor_active = en;
+               _session.MonitorChanged();
+       }
+}
+
+boost::shared_ptr<Controllable>
+MonitorProcessor::channel_cut_control (uint32_t chn) const
+{
+        if (chn < _channels.size()) {
+                return _channels[chn]->cut_control;
+        }
+        return boost::shared_ptr<Controllable>();
+}
+
+boost::shared_ptr<Controllable>
+MonitorProcessor::channel_dim_control (uint32_t chn) const
+{
+        if (chn < _channels.size()) {
+                return _channels[chn]->dim_control;
+        }
+        return boost::shared_ptr<Controllable>();
+}
+
+boost::shared_ptr<Controllable>
+MonitorProcessor::channel_polarity_control (uint32_t chn) const
+{
+        if (chn < _channels.size()) {
+                return _channels[chn]->polarity_control;
+        }
+        return boost::shared_ptr<Controllable>();
+}
+
+boost::shared_ptr<Controllable>
+MonitorProcessor::channel_solo_control (uint32_t chn) const
+{
+        if (chn < _channels.size()) {
+                return _channels[chn]->soloed_control;
+        }
+        return boost::shared_ptr<Controllable>();
+}
+
+MonitorProcessor::ChannelRecord::ChannelRecord (uint32_t chn)
+       : current_gain (GAIN_COEFF_UNITY)
+       , cut_ptr (new MPControl<gain_t> (1.0, string_compose (_("cut control %1"), chn), PBD::Controllable::GainLike))
+       , dim_ptr (new MPControl<bool> (false, string_compose (_("dim control"), chn), PBD::Controllable::Toggle))
+       , polarity_ptr (new MPControl<gain_t> (1.0, string_compose (_("polarity control"), chn), PBD::Controllable::Toggle, -1, 1))
+       , soloed_ptr (new MPControl<bool> (false, string_compose (_("solo control"), chn), PBD::Controllable::Toggle))
+
+       , cut_control (cut_ptr)
+       , dim_control (dim_ptr)
+       , polarity_control (polarity_ptr)
+       , soloed_control (soloed_ptr)
+
+       , cut (*cut_ptr)
+       , dim (*dim_ptr)
+       , polarity (*polarity_ptr)
+       , soloed (*soloed_ptr)
+{
+
+}