fix a bad transition in the transportFSM.
[ardour.git] / libs / ardour / vca.cc
index 2d1fbdec8fa929764ff0417d30821b1b9960a11d..f867da48c8c1b50cf2cc50996fb74e1639f32984 100644 (file)
@@ -1,39 +1,41 @@
 /*
-  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 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.
-*/
+ * Copyright (C) 2016-2017 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2017 Robin Gareus <robin@gareus.org>
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 #include "pbd/convert.h"
 
 #include "ardour/automation_control.h"
+#include "ardour/debug.h"
 #include "ardour/gain_control.h"
 #include "ardour/monitor_control.h"
 #include "ardour/rc_configuration.h"
-#include "ardour/record_enable_control.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
 #include "ardour/vca.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
 using std::string;
 
-gint VCA::next_number = 1;
+Glib::Threads::Mutex VCA::number_lock;
+int32_t VCA::next_number = 1;
 string VCA::xml_node_name (X_("VCA"));
 
 string
@@ -42,31 +44,33 @@ VCA::default_name_template ()
        return _("VCA %n");
 }
 
-int
+int32_t
 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);
+       /* we could use atomic inc here, but elsewhere we need more complete
+          mutex semantics, so we have to do it here also.
+       */
+       Glib::Threads::Mutex::Lock lm (number_lock);
+       return next_number++;
 }
 
 void
-VCA::set_next_vca_number (uint32_t n)
+VCA::set_next_vca_number (int32_t n)
 {
-       g_atomic_int_set (&next_number, n);
+       Glib::Threads::Mutex::Lock lm (number_lock);
+       next_number = n;
 }
 
-uint32_t
+int32_t
 VCA::get_next_vca_number ()
 {
-       return g_atomic_int_get (&next_number);
+       Glib::Threads::Mutex::Lock lm (number_lock);
+       return next_number;
 }
 
-VCA::VCA (Session& s,  uint32_t num, const string& name)
-       : Stripable (s, name)
+VCA::VCA (Session& s, int32_t num, const string& name)
+       : Stripable (s, name, PresentationInfo (num, PresentationInfo::VCA))
        , Muteable (s, name)
-       , Automatable (s)
        , _number (num)
        , _gain_control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
 {
@@ -77,8 +81,6 @@ VCA::init ()
 {
        _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
        _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
-       _recenable_control.reset (new RecordEnableControl (_session, X_("recenable"), *this));
-       _monitor_control.reset (new MonitorControl (_session, X_("monitoring"), *this));
 
        add_control (_gain_control);
        add_control (_solo_control);
@@ -89,21 +91,39 @@ VCA::init ()
 
 VCA::~VCA ()
 {
-       DropReferences (); /* emit signal */
+       DEBUG_TRACE (DEBUG::Destruction, string_compose ("delete VCA %1\n", number()));
+       {
+               Glib::Threads::Mutex::Lock lm (_control_lock);
+               for (Controls::const_iterator li = _controls.begin(); li != _controls.end(); ++li) {
+                       boost::dynamic_pointer_cast<AutomationControl>(li->second)->drop_references ();
+               }
+       }
+       {
+               Glib::Threads::Mutex::Lock lm (number_lock);
+               if (_number == next_number - 1) {
+                       /* this was the "last" VCA added, so rewind the next number so
+                        * that future VCAs get numbered as intended
+                        */
+                       next_number--;
+               }
+       }
 }
 
-uint32_t
-VCA::remote_control_id () const
+string
+VCA::full_name() const
 {
-       return 9999999 + _number;
+       /* name() is never empty - default is VCA %n */
+       return string_compose (_("VCA %1 : %2"), _number, name());
 }
 
 XMLNode&
 VCA::get_state ()
 {
        XMLNode* node = new XMLNode (xml_node_name);
-       node->add_property (X_("name"), _name);
-       node->add_property (X_("number"), _number);
+       node->set_property (X_("name"), name());
+       node->set_property (X_("number"), _number);
+
+       node->add_child_nocopy (_presentation_info.get_state());
 
        node->add_child_nocopy (_gain_control->get_state());
        node->add_child_nocopy (_solo_control->get_state());
@@ -118,37 +138,36 @@ VCA::get_state ()
 int
 VCA::set_state (XMLNode const& node, int version)
 {
-       XMLProperty const* prop;
+       Stripable::set_state (node, version);
 
-       if ((prop = node.property ("name")) != 0) {
-               set_name (prop->value());
+       std::string str;
+       if (node.get_property ("name", str)) {
+               set_name (str);
        }
 
-       if ((prop = node.property ("number")) != 0) {
-               _number = atoi (prop->value());
-       }
+       node.get_property ("number", _number);
 
        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) {
+                       if (!(*i)->get_property ("name", str)) {
                                continue;
                        }
 
-                       if (prop->value() == _gain_control->name()) {
+                       if (str == _gain_control->name()) {
                                _gain_control->set_state (**i, version);
                        }
-                       if (prop->value() == _solo_control->name()) {
+                       if (str == _solo_control->name()) {
                                _solo_control->set_state (**i, version);
                        }
-                       if (prop->value() == _mute_control->name()) {
+                       if (str == _mute_control->name()) {
                                _mute_control->set_state (**i, version);
                        }
                } else if ((*i)->name() == Slavable::xml_node_name) {
                        Slavable::set_state (**i, version);
+               } else if ((*i)->name() == Automatable::xml_node_name) {
+                       set_automation_xml_state (**i, Evoral::Parameter(NullAutomation));
                }
        }
 
@@ -161,64 +180,52 @@ VCA::clear_all_solo_state ()
        _solo_control->clear_all_solo_state ();
 }
 
-int
-VCA::assign_controls (boost::shared_ptr<VCA> vca)
-{
-       boost::shared_ptr<SlavableAutomationControl> slave;
-       boost::shared_ptr<AutomationControl> master;
-       AutomationType types[] = {
-               GainAutomation,
-               SoloAutomation,
-               MuteAutomation,
-               RecEnableAutomation,
-               MonitoringAutomation,
-               NullAutomation
-       };
-
-       for (uint32_t n = 0; types[n] != NullAutomation; ++n) {
-
-               slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (types[n]));
-               master = vca->automation_control (types[n]);
-
-               if (slave && master) {
-                       slave->add_master (master);
-               }
-       }
+MonitorState
+VCA::monitoring_state () const
+{
+       /* XXX this has to get more complex but not clear how */
+       return MonitoringInput;
+}
 
-       return 0;
+bool
+VCA::slaved () const
+{
+       if (!_gain_control) {
+               return false;
+       }
+       /* just test one particular control, not all of them */
+       return _gain_control->slaved ();
 }
 
-int
-VCA::unassign_controls (boost::shared_ptr<VCA> vca)
-{
-       boost::shared_ptr<SlavableAutomationControl> slave;
-       boost::shared_ptr<AutomationControl> master;
-       AutomationType types[] = {
-               GainAutomation,
-               SoloAutomation,
-               MuteAutomation,
-               RecEnableAutomation,
-               MonitoringAutomation,
-               NullAutomation
-       };
-
-       for (uint32_t n = 0; types[n] != NullAutomation; ++n) {
-
-               slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (types[n]));
-               if (!vca) {
-                       /* unassign from all */
-                       slave->clear_masters ();
-               } else {
-                       slave->remove_master (master);
-               }
+bool
+VCA::slaved_to (boost::shared_ptr<VCA> vca) const
+{
+       if (!vca || !_gain_control) {
+               return false;
        }
 
-       return 0;
+       /* just test one particular control, not all of them */
+
+       return _gain_control->slaved_to (vca->gain_control());
 }
 
-MonitorState
-VCA::monitoring_state () const
+void
+VCA::assign (boost::shared_ptr<VCA> v)
 {
-       /* XXX this has to get more complex but not clear how */
-       return MonitoringInput;
+       /* prevent recursive assignments */
+       if (assigned_to (_session.vca_manager_ptr (), v)) {
+               warning << _("Master assignment inored to prevent recursion") << endmsg;
+               return;
+       }
+       Slavable::assign (v);
+}
+
+SlavableControlList
+VCA::slavables () const
+{
+       SlavableControlList rv;
+       rv.push_back (_gain_control);
+       rv.push_back (_mute_control);
+       rv.push_back (_solo_control);
+       return rv;
 }