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->set_property (X_("number"), *i);
  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                         uint32_t n;
  76                         if ((*i)->get_property (X_("number"), n)) {
  77                                 _masters.insert (n);
  78                         }
  79                 }
  80         }
  81
  82         return 0;
  83 }
  84
  85
  86 /* Gain, solo & mute are currently the only controls that are
  87  * automatically slaved to the master's own equivalent controls.
  88  */
  89
  90 static AutomationType auto_slave_types[] = {
  91         GainAutomation,
  92         SoloAutomation,
  93         MuteAutomation,
  94         NullAutomation
  95 };
  96
  97 int
  98 Slavable::do_assign (VCAManager* manager)
  99 {
 100         std::vector<boost::shared_ptr<VCA> > vcas;
 101
 102         {
 103                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
 104
 105                 for (std::set<uint32_t>::const_iterator i = _masters.begin(); i != _masters.end(); ++i) {
 106                         boost::shared_ptr<VCA> v = manager->vca_by_number (*i);
 107                         if (v) {
 108                                 vcas.push_back (v);
 109                         } else {
 110                                 warning << string_compose (_("Master #%1 not found, assignment lost"), *i) << endmsg;
 111                         }
 112                 }
 113         }
 114
 115         /* now that we've released the lock, we can do the assignments */
 116
 117         if (!vcas.empty()) {
 118
 119                 for (std::vector<boost::shared_ptr<VCA> >::iterator v = vcas.begin(); v != vcas.end(); ++v) {
 120                         assign (*v, true);
 121                 }
 122
 123                 for (uint32_t n = 0; auto_slave_types[n] != NullAutomation; ++n) {
 124
 125                         boost::shared_ptr<SlavableAutomationControl> slave;
 126
 127                         slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (auto_slave_types[n]));
 128
 129                         if (slave) {
 130                                 slave->use_saved_master_ratios ();
 131                         }
 132                 }
 133         }
 134
 135         assign_connection.disconnect ();
 136
 137         return 0;
 138 }
 139
 140 void
 141 Slavable::assign (boost::shared_ptr<VCA> v, bool loading)
 142 {
 143         assert (v);
 144         {
 145                 Glib::Threads::RWLock::WriterLock lm (master_lock);
 146                 if (assign_controls (v, loading) == 0) {
 147                         _masters.insert (v->number());
 148                 }
 149
 150                 /* Do NOT use ::unassign() because it will store a
 151                  * boost::shared_ptr<VCA> in the functor, leaving a dangling ref to the
 152                  * VCA.
 153                  */
 154
 155
 156                 v->Drop.connect_same_thread (unassign_connections, boost::bind (&Slavable::weak_unassign, this, boost::weak_ptr<VCA>(v)));
 157                 v->DropReferences.connect_same_thread (unassign_connections, boost::bind (&Slavable::weak_unassign, this, boost::weak_ptr<VCA>(v)));
 158         }
 159
 160         AssignmentChange (v, true);
 161 }
 162
 163 void
 164 Slavable::weak_unassign (boost::weak_ptr<VCA> v)
 165 {
 166         boost::shared_ptr<VCA> sv (v.lock());
 167         if (sv) {
 168                 unassign (sv);
 169         }
 170 }
 171
 172 void
 173 Slavable::unassign (boost::shared_ptr<VCA> v)
 174 {
 175         {
 176                 Glib::Threads::RWLock::WriterLock lm (master_lock);
 177
 178                 (void) unassign_controls (v);
 179                 if (v) {
 180                         _masters.erase (v->number());
 181                 } else {
 182                         _masters.clear ();
 183                 }
 184         }
 185         AssignmentChange (v, false);
 186 }
 187
 188 int
 189 Slavable::assign_controls (boost::shared_ptr<VCA> vca, bool loading)
 190 {
 191         boost::shared_ptr<SlavableAutomationControl> slave;
 192         boost::shared_ptr<AutomationControl> master;
 193
 194         for (uint32_t n = 0; auto_slave_types[n] != NullAutomation; ++n) {
 195
 196                 slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (auto_slave_types[n]));
 197                 master = vca->automation_control (auto_slave_types[n]);
 198
 199                 if (slave && master) {
 200                         slave->add_master (master, loading);
 201                 }
 202         }
 203
 204         return 0;
 205 }
 206
 207 int
 208 Slavable::unassign_controls (boost::shared_ptr<VCA> vca)
 209 {
 210         boost::shared_ptr<SlavableAutomationControl> slave;
 211         boost::shared_ptr<AutomationControl> master;
 212
 213         for (uint32_t n = 0; auto_slave_types[n] != NullAutomation; ++n) {
 214
 215                 slave = boost::dynamic_pointer_cast<SlavableAutomationControl> (automation_control (auto_slave_types[n]));
 216
 217                 if (!vca) {
 218                         /* unassign from all */
 219                         if (slave) {
 220                                 slave->clear_masters ();
 221                         }
 222                 } else {
 223                         master = vca->automation_control (auto_slave_types[n]);
 224                         if (slave && master) {
 225                                 slave->remove_master (master);
 226                         }
 227                 }
 228         }
 229
 230         return 0;
 231 }