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