libs/ardour/slavable.cc

   1 /*
   2     Copyright (C) 2016 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <vector>
  21
  22 #include <glibmm/threads.h>
  23
  24 #include "pbd/convert.h"
  25 #include "pbd/error.h"
  26 #include "pbd/xml++.h"
  27
  28 #include "ardour/slavable.h"
  29 #include "ardour/slavable_automation_control.h"
  30 #include "ardour/vca.h"
  31 #include "ardour/vca_manager.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace PBD;
  36 using namespace ARDOUR;
  37
  38 std::string Slavable::xml_node_name = X_("Slavable");
  39 PBD::Signal1<void,VCAManager*> Slavable::Assign; /* signal sent once
  40                                                   * assignment is possible */
  41
  42 Slavable::Slavable ()
  43 {
  44         Assign.connect_same_thread (assign_connection, boost::bind (&Slavable::do_assign, this, _1));
  45 }
  46
  47 XMLNode&
  48 Slavable::get_state () const
  49 {
  50         XMLNode* node = new XMLNode (xml_node_name);
  51         XMLNode* child;
  52
  53         Glib::Threads::RWLock::ReaderLock lm (master_lock);
  54         for (std::set<uint32_t>::const_iterator i = _masters.begin(); i != _masters.end(); ++i) {
  55                 child = new XMLNode (X_("Master"));
  56                 child->add_property (X_("number"), to_string (*i, std::dec));
  57                 node->add_child_nocopy (*child);
  58         }
  59
  60         return *node;
  61 }
  62
  63 int
  64 Slavable::set_state (XMLNode const& node, int version)
  65 {
  66         if (node.name() != xml_node_name) {
  67                 return -1;
  68         }
  69
  70         XMLNodeList const& children (node.children());
  71         Glib::Threads::RWLock::WriterLock lm (master_lock);
  72
  73         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
  74                 if ((*i)->name() == X_("Master")) {
  75                         XMLProperty const* prop = (*i)->property (X_("number"));
  76                         if (prop) {
  77                                 uint32_t n = atoi (prop->value());
  78                                 _masters.insert (n);
  79                         }
  80                 }
  81         }
  82
  83         return 0;
  84 }
  85
  86
  87 int
  88 Slavable::do_assign (VCAManager* manager)
  89 {
  90         std::vector<boost::shared_ptr<VCA> > vcas;
  91
  92         {
  93                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  94
  95                 for (std::set<uint32_t>::const_iterator i = _masters.begin(); i != _masters.end(); ++i) {
  96                         boost::shared_ptr<VCA> v = manager->vca_by_number (*i);
  97                         if (v) {
  98                                 vcas.push_back (v);
  99                         } else {
 100                                 warning << string_compose (_("Master #%1 not found, assignment lost"), *i) << endmsg;
 101                         }
 102                 }
 103         }
 104
 105         /* now that we've released the lock, we can do the assignments */
 106
 107         for (std::vector<boost::shared_ptr<VCA> >::iterator v = vcas.begin(); v != vcas.end(); ++v) {
 108                 assign (*v);
 109         }
 110
 111         assign_connection.disconnect ();
 112
 113         return 0;
 114 }
 115
 116 void
 117 Slavable::assign (boost::shared_ptr<VCA> v)
 118 {
 119         assert (v);
 120         {
 121                 Glib::Threads::RWLock::WriterLock lm (master_lock);
 122                 if (assign_controls (v) == 0) {
 123                         _masters.insert (v->number());
 124                 }
 125
 126                 /* Do NOT use ::unassign() because it will store a
 127                  * boost::shared_ptr<VCA> in the functor, leaving a dangling ref to the
 128                  * VCA.
 129                  */
 130
 131
 132                 v->Drop.connect_same_thread (unassign_connections, boost::bind (&Slavable::weak_unassign, this, boost::weak_ptr<VCA>(v)));
 133                 v->DropReferences.connect_same_thread (unassign_connections, boost::bind (&Slavable::weak_unassign, this, boost::weak_ptr<VCA>(v)));
 134         }
 135
 136         AssignmentChange (v, true);
 137 }
 138
 139 void
 140 Slavable::weak_unassign (boost::weak_ptr<VCA> v)
 141 {
 142         boost::shared_ptr<VCA> sv (v.lock());
 143         if (sv) {
 144                 unassign (sv);
 145         }
 146 }
 147
 148 void
 149 Slavable::unassign (boost::shared_ptr<VCA> v)
 150 {
 151         {
 152                 Glib::Threads::RWLock::WriterLock lm (master_lock);
 153
 154                 (void) unassign_controls (v);
 155                 if (v) {
 156                         _masters.erase (v->number());
 157                 } else {
 158                         _masters.clear ();
 159                 }
 160         }
 161         AssignmentChange (v, false);
 162 }
 163
 164 /* Gain, solo & mute are currently the only controls that are
 165  * automatically slaved to the master's own equivalent controls.
 166  */
 167
 168 static AutomationType auto_slave_types[] = {
 169         GainAutomation,
 170         SoloAutomation,
 171         MuteAutomation,
 172         NullAutomation
 173 };
 174
 175 int
 176 Slavable::assign_controls (boost::shared_ptr<VCA> vca)
 177 {
 178         boost::shared_ptr<SlavableAutomationControl> slave;
 179         boost::shared_ptr<AutomationControl> master;
 180
 181         for (uint32_t n = 0; auto_slave_types[n] != NullAutomation; ++n) {
 182
 183                 slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (auto_slave_types[n]));
 184                 master = vca->automation_control (auto_slave_types[n]);
 185
 186                 if (slave && master) {
 187                         slave->add_master (master);
 188                 }
 189         }
 190
 191         return 0;
 192 }
 193
 194 int
 195 Slavable::unassign_controls (boost::shared_ptr<VCA> vca)
 196 {
 197         boost::shared_ptr<SlavableAutomationControl> slave;
 198         boost::shared_ptr<AutomationControl> master;
 199
 200         for (uint32_t n = 0; auto_slave_types[n] != NullAutomation; ++n) {
 201
 202                 slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (auto_slave_types[n]));
 203
 204                 if (!vca) {
 205                         /* unassign from all */
 206                         if (slave) {
 207                                 slave->clear_masters ();
 208                         }
 209                 } else {
 210                         master = vca->automation_control (auto_slave_types[n]);
 211                         if (slave && master) {
 212                                 slave->remove_master (master);
 213                         }
 214                 }
 215         }
 216
 217         return 0;
 218 }