move vca assignment up to the Route level (from GainControl)
[ardour.git] / libs / ardour / vca.cc
index 7580d5794a69a1617bb58c9cdf5d01bb00df4817..8c4fe260ecc289342578442a6fc4602671cc6556 100644 (file)
 /*
-    Copyright (C) 2016 Paul Davis
+  Copyright (C) 2016 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 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.
+  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.
+  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 "ardour/automation_control.h"
 #include "ardour/gain_control.h"
+#include "ardour/rc_configuration.h"
 #include "ardour/route.h"
+#include "ardour/session.h"
 #include "ardour/vca.h"
 
+#include "i18n.h"
+
 using namespace ARDOUR;
 using namespace PBD;
 using std::string;
 
-VCA::VCA (Session& s, const string& n)
-       : SessionHandleRef (s)
-       , name (n)
-       , _control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
+gint VCA::next_number = 1;
+string VCA::xml_node_name (X_("VCA"));
+
+string
+VCA::default_name_template ()
+{
+       return _("VCA %n");
+}
+
+int
+VCA::next_vca_number ()
 {
+       /* recall that atomic_int_add() returns the value before the add. We
+        * start at one, then next one will be two etc.
+        */
+       return g_atomic_int_add (&next_number, 1);
 }
 
 void
-VCA::set_value (double val, Controllable::GroupControlDisposition gcd)
+VCA::set_next_vca_number (uint32_t n)
+{
+       g_atomic_int_set (&next_number, n);
+}
+
+uint32_t
+VCA::get_next_vca_number ()
+{
+       return g_atomic_int_get (&next_number);
+}
+
+VCA::VCA (Session& s,  uint32_t num, const string& name)
+       : Stripable (s, name)
+       , Automatable (s)
+       , _number (num)
+       , _gain_control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
+       , _solo_requested (false)
+       , _mute_requested (false)
+{
+}
+
+int
+VCA::init ()
+{
+       _solo_control.reset (new VCASoloControllable (X_("solo"), shared_from_this()));
+       _mute_control.reset (new VCAMuteControllable (X_("mute"), shared_from_this()));
+
+       add_control (_gain_control);
+       add_control (_solo_control);
+       add_control (_mute_control);
+
+       return 0;
+}
+
+VCA::~VCA ()
+{
+       DropReferences (); /* emit signal */
+}
+
+uint32_t
+VCA::remote_control_id () const
+{
+       return 9999999 + _number;
+}
+
+XMLNode&
+VCA::get_state ()
 {
-       _control->set_value (val, gcd);
+       XMLNode* node = new XMLNode (xml_node_name);
+       node->add_property (X_("name"), _name);
+       node->add_property (X_("number"), _number);
+       node->add_property (X_("soloed"), (_solo_requested ? X_("yes") : X_("no")));
+       node->add_property (X_("muted"), (_mute_requested ? X_("yes") : X_("no")));
+
+       node->add_child_nocopy (_gain_control->get_state());
+       node->add_child_nocopy (get_automation_xml_state());
+
+       return *node;
+}
+
+int
+VCA::set_state (XMLNode const& node, int version)
+{
+       XMLProperty const* prop;
+
+       if ((prop = node.property ("name")) != 0) {
+               set_name (prop->value());
+       }
+
+       if ((prop = node.property ("number")) != 0) {
+               _number = atoi (prop->value());
+       }
+
+       XMLNodeList const &children (node.children());
+       for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
+               if ((*i)->name() == Controllable::xml_node_name) {
+                       XMLProperty* prop = (*i)->property ("name");
+                       if (prop && prop->value() == X_("gaincontrol")) {
+                               _gain_control->set_state (**i, version);
+                       }
+               }
+       }
+
+       return 0;
+}
+
+void
+VCA::add_solo_target (boost::shared_ptr<Route> r)
+{
+       Glib::Threads::RWLock::WriterLock lm (solo_lock);
+       solo_targets.push_back (r);
+       r->DropReferences.connect_same_thread (solo_connections, boost::bind (&VCA::solo_target_going_away, this, boost::weak_ptr<Route> (r)));
+}
+
+void
+VCA::remove_solo_target (boost::shared_ptr<Route> r)
+{
+       Glib::Threads::RWLock::WriterLock lm (solo_lock);
+       solo_targets.remove (r);
+}
+
+void
+VCA::solo_target_going_away (boost::weak_ptr<Route> wr)
+{
+       boost::shared_ptr<Route> r (wr.lock());
+       if (!r) {
+               return;
+       }
+       remove_solo_target (r);
+}
+
+void
+VCA::set_solo (bool yn)
+{
+       {
+               Glib::Threads::RWLock::ReaderLock lm (solo_lock);
+
+               if (yn == _solo_requested) {
+                       return;
+               }
+
+               if (solo_targets.empty()) {
+                       return;
+               }
+
+               boost::shared_ptr<RouteList> rl (new RouteList (solo_targets));
+
+               if (Config->get_solo_control_is_listen_control()) {
+                       _session.set_listen (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
+               } else {
+                       _session.set_solo (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
+               }
+       }
+
+       _solo_requested = yn;
+}
+
+void
+VCA::add_mute_target (boost::shared_ptr<Route> r)
+{
+       Glib::Threads::RWLock::WriterLock lm (mute_lock);
+       mute_targets.push_back (r);
+       r->DropReferences.connect_same_thread (mute_connections, boost::bind (&VCA::mute_target_going_away, this, boost::weak_ptr<Route> (r)));
+}
+
+void
+VCA::remove_mute_target (boost::shared_ptr<Route> r)
+{
+       Glib::Threads::RWLock::WriterLock lm (mute_lock);
+       mute_targets.remove (r);
+}
+
+void
+VCA::mute_target_going_away (boost::weak_ptr<Route> wr)
+{
+       boost::shared_ptr<Route> r (wr.lock());
+       if (!r) {
+               return;
+       }
+       remove_mute_target (r);
+}
+
+void
+VCA::set_mute (bool yn)
+{
+       {
+               Glib::Threads::RWLock::ReaderLock lm (mute_lock);
+               if (yn == _mute_requested) {
+                       return;
+               }
+
+               boost::shared_ptr<RouteList> rl (new RouteList (mute_targets));
+               _session.set_mute (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
+       }
+
+       _mute_requested = yn;
+}
+
+bool
+VCA::soloed () const
+{
+       return _solo_requested;
+}
+
+bool
+VCA::muted () const
+{
+       return _mute_requested;
+}
+
+VCA::VCASoloControllable::VCASoloControllable (string const & name, boost::shared_ptr<VCA> vca)
+       : AutomationControl (vca->session(), Evoral::Parameter (SoloAutomation), ParameterDescriptor (Evoral::Parameter (SoloAutomation)),
+                            boost::shared_ptr<AutomationList>(), name)
+       , _vca (vca)
+{
+}
+
+void
+VCA::VCASoloControllable::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
+{
+       if (writable()) {
+               _set_value (val, gcd);
+       }
+}
+
+void
+VCA::VCASoloControllable::_set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
+{
+       boost::shared_ptr<VCA> vca = _vca.lock();
+       if (!vca) {
+               return;
+       }
+
+       vca->set_solo (val >= 0.5);
+
+       AutomationControl::set_value (val, gcd);
+}
+
+void
+VCA::VCASoloControllable::set_value_unchecked (double val)
+{
+       /* used only by automation playback */
+       _set_value (val, Controllable::NoGroup);
 }
 
 double
-VCA::get_value() const
+VCA::VCASoloControllable::get_value() const
+{
+       boost::shared_ptr<VCA> vca = _vca.lock();
+       if (!vca) {
+               return 0.0;
+       }
+
+       return vca->soloed() ? 1.0 : 0.0;
+}
+
+/*----*/
+
+VCA::VCAMuteControllable::VCAMuteControllable (string const & name, boost::shared_ptr<VCA> vca)
+       : AutomationControl (vca->session(), Evoral::Parameter (MuteAutomation), ParameterDescriptor (Evoral::Parameter (MuteAutomation)),
+                            boost::shared_ptr<AutomationList>(), name)
+       , _vca (vca)
 {
-       return _control->get_value();
 }
 
 void
-VCA::add (boost::shared_ptr<Route> r)
+VCA::VCAMuteControllable::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 {
-       boost::dynamic_pointer_cast<GainControl>(r->gain_control())->set_master (_control);
+       if (writable()) {
+               _set_value (val, gcd);
+       }
 }
 
 void
-VCA::remove (boost::shared_ptr<Route> r)
+VCA::VCAMuteControllable::_set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 {
-       boost::shared_ptr<GainControl> route_gain = boost::dynamic_pointer_cast<GainControl>(r->gain_control());
-       boost::shared_ptr<GainControl> current_master = route_gain->master();
+       boost::shared_ptr<VCA> vca = _vca.lock();
 
-       if (current_master == _control) {
-               route_gain->set_master (boost::shared_ptr<GainControl>());
+       if (!vca) {
+               return;
        }
+
+       vca->set_mute (val >= 0.5);
+
+       AutomationControl::set_value (val, gcd);
+}
+
+void
+VCA::VCAMuteControllable::set_value_unchecked (double val)
+{
+       /* used only by automation playback */
+       _set_value (val, Controllable::NoGroup);
+}
+
+double
+VCA::VCAMuteControllable::get_value() const
+{
+       boost::shared_ptr<VCA> vca = _vca.lock();
+       if (!vca) {
+               return 0.0;
+       }
+
+       return vca->muted() ? 1.0 : 0.0;
 }