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/debug.h"
  23 #include "ardour/gain_control.h"
  24 #include "ardour/monitor_control.h"
  25 #include "ardour/rc_configuration.h"
  26 #include "ardour/route.h"
  27 #include "ardour/session.h"
  28 #include "ardour/vca.h"
  29
  30 #include "pbd/i18n.h"
  31
  32 using namespace ARDOUR;
  33 using namespace PBD;
  34 using std::string;
  35
  36 Glib::Threads::Mutex VCA::number_lock;
  37 int32_t VCA::next_number = 1;
  38 string VCA::xml_node_name (X_("VCA"));
  39
  40 string
  41 VCA::default_name_template ()
  42 {
  43         return _("VCA %n");
  44 }
  45
  46 int32_t
  47 VCA::next_vca_number ()
  48 {
  49         /* we could use atomic inc here, but elsewhere we need more complete
  50            mutex semantics, so we have to do it here also.
  51         */
  52         Glib::Threads::Mutex::Lock lm (number_lock);
  53         return next_number++;
  54 }
  55
  56 void
  57 VCA::set_next_vca_number (int32_t n)
  58 {
  59         Glib::Threads::Mutex::Lock lm (number_lock);
  60         next_number = n;
  61 }
  62
  63 int32_t
  64 VCA::get_next_vca_number ()
  65 {
  66         Glib::Threads::Mutex::Lock lm (number_lock);
  67         return next_number;
  68 }
  69
  70 VCA::VCA (Session& s, int32_t num, const string& name)
  71         : Stripable (s, name, PresentationInfo (num, PresentationInfo::VCA))
  72         , Muteable (s, name)
  73         , Automatable (s)
  74         , _number (num)
  75         , _gain_control (new GainControl (s, Evoral::Parameter (GainAutomation), boost::shared_ptr<AutomationList> ()))
  76 {
  77 }
  78
  79 int
  80 VCA::init ()
  81 {
  82         _solo_control.reset (new SoloControl (_session, X_("solo"), *this, *this));
  83         _mute_control.reset (new MuteControl (_session, X_("mute"), *this));
  84
  85         add_control (_gain_control);
  86         add_control (_solo_control);
  87         add_control (_mute_control);
  88
  89         return 0;
  90 }
  91
  92 VCA::~VCA ()
  93 {
  94         DEBUG_TRACE (DEBUG::Destruction, string_compose ("delete VCA %1\n", number()));
  95         {
  96                 Glib::Threads::Mutex::Lock lm (number_lock);
  97                 if (_number == next_number - 1) {
  98                         /* this was the "last" VCA added, so rewind the next number so
  99                          * that future VCAs get numbered as intended
 100                          */
 101                         next_number--;
 102                 }
 103         }
 104 }
 105
 106 string
 107 VCA::full_name() const
 108 {
 109         /* name() is never empty - default is VCA %n */
 110         return string_compose (_("VCA %1 : %2"), _number, name());
 111 }
 112
 113 XMLNode&
 114 VCA::get_state ()
 115 {
 116         XMLNode* node = new XMLNode (xml_node_name);
 117         node->add_property (X_("name"), _name);
 118         node->add_property (X_("number"), _number);
 119
 120         node->add_child_nocopy (_presentation_info.get_state());
 121
 122         node->add_child_nocopy (_gain_control->get_state());
 123         node->add_child_nocopy (_solo_control->get_state());
 124         node->add_child_nocopy (_mute_control->get_state());
 125         node->add_child_nocopy (get_automation_xml_state());
 126
 127         node->add_child_nocopy (Slavable::get_state());
 128
 129         return *node;
 130 }
 131
 132 int
 133 VCA::set_state (XMLNode const& node, int version)
 134 {
 135         XMLProperty const* prop;
 136
 137         Stripable::set_state (node, version);
 138
 139         if ((prop = node.property ("name")) != 0) {
 140                 set_name (prop->value());
 141         }
 142
 143         if ((prop = node.property ("number")) != 0) {
 144                 _number = atoi (prop->value());
 145         }
 146
 147         XMLNodeList const &children (node.children());
 148         for (XMLNodeList::const_iterator i = children.begin(); i != children.end(); ++i) {
 149                 if ((*i)->name() == Controllable::xml_node_name) {
 150
 151                         XMLProperty* prop = (*i)->property ("name");
 152
 153                         if (!prop) {
 154                                 continue;
 155                         }
 156
 157                         if (prop->value() == _gain_control->name()) {
 158                                 _gain_control->set_state (**i, version);
 159                         }
 160                         if (prop->value() == _solo_control->name()) {
 161                                 _solo_control->set_state (**i, version);
 162                         }
 163                         if (prop->value() == _mute_control->name()) {
 164                                 _mute_control->set_state (**i, version);
 165                         }
 166                 } else if ((*i)->name() == Slavable::xml_node_name) {
 167                         Slavable::set_state (**i, version);
 168                 }
 169         }
 170
 171         return 0;
 172 }
 173
 174 void
 175 VCA::clear_all_solo_state ()
 176 {
 177         _solo_control->clear_all_solo_state ();
 178 }
 179
 180 MonitorState
 181 VCA::monitoring_state () const
 182 {
 183         /* XXX this has to get more complex but not clear how */
 184         return MonitoringInput;
 185 }
 186
 187 bool
 188 VCA::slaved () const
 189 {
 190         if (!_gain_control) {
 191                 return false;
 192         }
 193         /* just test one particular control, not all of them */
 194         return _gain_control->slaved ();
 195 }
 196
 197 bool
 198 VCA::slaved_to (boost::shared_ptr<VCA> vca) const
 199 {
 200         if (!vca || !_gain_control) {
 201                 return false;
 202         }
 203
 204         /* just test one particular control, not all of them */
 205
 206         return _gain_control->slaved_to (vca->gain_control());
 207 }