libs/ardour/vca.cc

   1 /*
   2   Copyright (C) 2016 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify it
   5   under the terms of the GNU General Public License as published by the Free
   6   Software Foundation; either version 2 of the License, or (at your option)
   7   any later version.
   8
   9   This program is distributed in the hope that it will be useful, but WITHOUT
  10   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12   for more details.
  13
  14   You should have received a copy of the GNU General Public License along
  15   with this program; if not, write to the Free Software Foundation, Inc.,
  16   675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include "pbd/convert.h"
  20
  21 #include "ardour/automation_control.h"
  22 #include "ardour/gain_control.h"
  23 #include "ardour/rc_configuration.h"
  24 #include "ardour/route.h"
  25 #include "ardour/session.h"
  26 #include "ardour/vca.h"
  27
  28 #include "i18n.h"
  29
  30 using namespace ARDOUR;
  31 using namespace PBD;
  32 using std::string;
  33
  34 gint VCA::next_number = 1;
  35 string VCA::xml_node_name (X_("VCA"));
  36
  37 string
  38 VCA::default_name_template ()
  39 {
  40         return _("VCA %n");
  41 }
  42
  43 int
  44 VCA::next_vca_number ()
  45 {
  46         /* recall that atomic_int_add() returns the value before the add. We
  47          * start at one, then next one will be two etc.
  48          */
  49         return g_atomic_int_add (&next_number, 1);
  50 }
  51
  52 void
  53 VCA::set_next_vca_number (uint32_t n)
  54 {
  55         g_atomic_int_set (&next_number, n);
  56 }
  57
  58 uint32_t
  59 VCA::get_next_vca_number ()
  60 {
  61         return g_atomic_int_get (&next_number);
  62 }
  63
  64 VCA::VCA (Session& s,  uint32_t num, const string& name)
  65         : Stripable (s, name)
  66         , Automatable (s)
  67         , _number (num)
  68         , _gain_control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
  69         , _solo_requested (false)
  70         , _mute_requested (false)
  71 {
  72 }
  73
  74 int
  75 VCA::init ()
  76 {
  77         _solo_control.reset (new VCASoloControllable (X_("solo"), shared_from_this()));
  78         _mute_control.reset (new VCAMuteControllable (X_("mute"), shared_from_this()));
  79
  80         add_control (_gain_control);
  81         add_control (_solo_control);
  82         add_control (_mute_control);
  83
  84         return 0;
  85 }
  86
  87 VCA::~VCA ()
  88 {
  89         DropReferences (); /* emit signal */
  90 }
  91
  92 uint32_t
  93 VCA::remote_control_id () const
  94 {
  95         return 9999999 + _number;
  96 }
  97
  98 XMLNode&
  99 VCA::get_state ()
 100 {
 101         XMLNode* node = new XMLNode (xml_node_name);
 102         node->add_property (X_("name"), _name);
 103         node->add_property (X_("number"), _number);
 104         node->add_property (X_("soloed"), (_solo_requested ? X_("yes") : X_("no")));
 105         node->add_property (X_("muted"), (_mute_requested ? X_("yes") : X_("no")));
 106
 107         node->add_child_nocopy (_gain_control->get_state());
 108         node->add_child_nocopy (get_automation_xml_state());
 109
 110         return *node;
 111 }
 112
 113 int
 114 VCA::set_state (XMLNode const& node, int version)
 115 {
 116         XMLProperty const* prop;
 117
 118         if ((prop = node.property ("name")) != 0) {
 119                 set_name (prop->value());
 120         }
 121
 122         if ((prop = node.property ("number")) != 0) {
 123                 _number = atoi (prop->value());
 124         }
 125
 126         XMLNodeList const &children (node.children());
 127         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
 128                 if ((*i)->name() == Controllable::xml_node_name) {
 129                         XMLProperty* prop = (*i)->property ("name");
 130                         if (prop && prop->value() == X_("gaincontrol")) {
 131                                 _gain_control->set_state (**i, version);
 132                         }
 133                 }
 134         }
 135
 136         return 0;
 137 }
 138
 139 void
 140 VCA::add_solo_mute_target (boost::shared_ptr<Route> r)
 141 {
 142         Glib::Threads::RWLock::WriterLock lm (solo_mute_lock);
 143         solo_mute_targets.push_back (r);
 144         r->DropReferences.connect_same_thread (solo_mute_connections, boost::bind (&VCA::solo_mute_target_going_away, this, boost::weak_ptr<Route> (r)));
 145 }
 146
 147 void
 148 VCA::remove_solo_mute_target (boost::shared_ptr<Route> r)
 149 {
 150         Glib::Threads::RWLock::WriterLock lm (solo_mute_lock);
 151         solo_mute_targets.remove (r);
 152 }
 153
 154 void
 155 VCA::solo_mute_target_going_away (boost::weak_ptr<Route> wr)
 156 {
 157         boost::shared_ptr<Route> r (wr.lock());
 158         if (!r) {
 159                 return;
 160         }
 161
 162         Glib::Threads::RWLock::WriterLock lm (solo_mute_lock);
 163         solo_mute_targets.remove (r);
 164 }
 165
 166 void
 167 VCA::set_solo (bool yn)
 168 {
 169         {
 170                 Glib::Threads::RWLock::ReaderLock lm (solo_mute_lock);
 171
 172                 if (yn == _solo_requested) {
 173                         return;
 174                 }
 175
 176                 if (solo_mute_targets.empty()) {
 177                         return;
 178                 }
 179
 180                 boost::shared_ptr<RouteList> rl (new RouteList (solo_mute_targets));
 181
 182                 if (Config->get_solo_control_is_listen_control()) {
 183                         _session.set_listen (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
 184                 } else {
 185                         _session.set_solo (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
 186                 }
 187         }
 188
 189         _solo_requested = yn;
 190 }
 191
 192 void
 193 VCA::set_mute (bool yn)
 194 {
 195         {
 196                 Glib::Threads::RWLock::ReaderLock lm (solo_mute_lock);
 197                 if (yn == _mute_requested) {
 198                         return;
 199                 }
 200
 201                 boost::shared_ptr<RouteList> rl (new RouteList (solo_mute_targets));
 202                 _session.set_mute (rl, yn, Session::rt_cleanup, Controllable::NoGroup);
 203         }
 204
 205         _mute_requested = yn;
 206 }
 207
 208 bool
 209 VCA::soloed () const
 210 {
 211         return _solo_requested;
 212 }
 213
 214 bool
 215 VCA::muted () const
 216 {
 217         return _mute_requested;
 218 }
 219
 220 VCA::VCASoloControllable::VCASoloControllable (string const & name, boost::shared_ptr<VCA> vca)
 221         : AutomationControl (vca->session(), Evoral::Parameter (SoloAutomation), ParameterDescriptor (Evoral::Parameter (SoloAutomation)),
 222                              boost::shared_ptr<AutomationList>(), name)
 223         , _vca (vca)
 224 {
 225 }
 226
 227 void
 228 VCA::VCASoloControllable::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 229 {
 230         if (writable()) {
 231                 _set_value (val, gcd);
 232         }
 233 }
 234
 235 void
 236 VCA::VCASoloControllable::_set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 237 {
 238         boost::shared_ptr<VCA> vca = _vca.lock();
 239         if (!vca) {
 240                 return;
 241         }
 242
 243         vca->set_solo (val >= 0.5);
 244
 245         AutomationControl::set_value (val, gcd);
 246 }
 247
 248 void
 249 VCA::VCASoloControllable::set_value_unchecked (double val)
 250 {
 251         /* used only by automation playback */
 252         _set_value (val, Controllable::NoGroup);
 253 }
 254
 255 double
 256 VCA::VCASoloControllable::get_value() const
 257 {
 258         boost::shared_ptr<VCA> vca = _vca.lock();
 259         if (!vca) {
 260                 return 0.0;
 261         }
 262
 263         return vca->soloed() ? 1.0 : 0.0;
 264 }
 265
 266 /*----*/
 267
 268 VCA::VCAMuteControllable::VCAMuteControllable (string const & name, boost::shared_ptr<VCA> vca)
 269         : AutomationControl (vca->session(), Evoral::Parameter (MuteAutomation), ParameterDescriptor (Evoral::Parameter (MuteAutomation)),
 270                              boost::shared_ptr<AutomationList>(), name)
 271         , _vca (vca)
 272 {
 273 }
 274
 275 void
 276 VCA::VCAMuteControllable::set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 277 {
 278         if (writable()) {
 279                 _set_value (val, gcd);
 280         }
 281 }
 282
 283 void
 284 VCA::VCAMuteControllable::_set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
 285 {
 286         boost::shared_ptr<VCA> vca = _vca.lock();
 287
 288         if (!vca) {
 289                 return;
 290         }
 291
 292         vca->set_mute (val >= 0.5);
 293
 294         AutomationControl::set_value (val, gcd);
 295 }
 296
 297 void
 298 VCA::VCAMuteControllable::set_value_unchecked (double val)
 299 {
 300         /* used only by automation playback */
 301         _set_value (val, Controllable::NoGroup);
 302 }
 303
 304 double
 305 VCA::VCAMuteControllable::get_value() const
 306 {
 307         boost::shared_ptr<VCA> vca = _vca.lock();
 308         if (!vca) {
 309                 return 0.0;
 310         }
 311
 312         return vca->muted() ? 1.0 : 0.0;
 313 }