libs/ardour/pannable.cc

   1 /*
   2     Copyright (C) 2011 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 "pbd/error.h"
  21 #include "pbd/compose.h"
  22
  23 #include "ardour/boost_debug.h"
  24 #include "ardour/debug.h"
  25 #include "ardour/automation_control.h"
  26 #include "ardour/automation_list.h"
  27 #include "ardour/pannable.h"
  28 #include "ardour/panner.h"
  29 #include "ardour/pan_controllable.h"
  30 #include "ardour/session.h"
  31 #include "ardour/value_as_string.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace std;
  36 using namespace PBD;
  37 using namespace ARDOUR;
  38
  39 Pannable::Pannable (Session& s)
  40         : Automatable (s)
  41         , SessionHandleRef (s)
  42         , pan_azimuth_control (new PanControllable (s, "", this, PanAzimuthAutomation))
  43         , pan_elevation_control (new PanControllable (s, "", this, PanElevationAutomation))
  44         , pan_width_control (new PanControllable (s, "", this, PanWidthAutomation))
  45         , pan_frontback_control (new PanControllable (s, "", this, PanFrontBackAutomation))
  46         , pan_lfe_control (new PanControllable (s, "", this, PanLFEAutomation))
  47         , _auto_state (Off)
  48         , _has_state (false)
  49         , _responding_to_control_auto_state_change (0)
  50 {
  51         //boost_debug_shared_ptr_mark_interesting (this, "pannable");
  52
  53         add_control (pan_azimuth_control);
  54         add_control (pan_elevation_control);
  55         add_control (pan_width_control);
  56         add_control (pan_frontback_control);
  57         add_control (pan_lfe_control);
  58
  59         /* all controls change state together */
  60
  61         pan_azimuth_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  62         pan_elevation_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  63         pan_width_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  64         pan_frontback_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  65         pan_lfe_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  66
  67         pan_azimuth_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  68         pan_elevation_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  69         pan_width_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  70         pan_frontback_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  71         pan_lfe_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  72 }
  73
  74 Pannable::~Pannable ()
  75 {
  76         DEBUG_TRACE (DEBUG::Destruction, string_compose ("pannable @ %1 destructor\n", this));
  77 }
  78
  79 void
  80 Pannable::control_auto_state_changed (AutoState new_state)
  81 {
  82         if (_responding_to_control_auto_state_change) {
  83                 return;
  84         }
  85
  86         _responding_to_control_auto_state_change++;
  87
  88         pan_azimuth_control->set_automation_state (new_state);
  89         pan_width_control->set_automation_state (new_state);
  90         pan_elevation_control->set_automation_state (new_state);
  91         pan_frontback_control->set_automation_state (new_state);
  92         pan_lfe_control->set_automation_state (new_state);
  93
  94         _responding_to_control_auto_state_change--;
  95
  96         _auto_state = new_state;
  97         automation_state_changed (new_state);  /* EMIT SIGNAL */
  98 }
  99
 100 void
 101 Pannable::set_panner (boost::shared_ptr<Panner> p)
 102 {
 103         _panner = p;
 104 }
 105
 106 void
 107 Pannable::value_changed ()
 108 {
 109         if (!has_state ()) {
 110                 // prevent the GUI from resetting panners
 111                 // e.g. when switching to aux-sends and back.
 112                 _has_state = true;
 113         }
 114
 115         _session.set_dirty ();
 116 }
 117
 118 void
 119 Pannable::set_automation_state (AutoState state)
 120 {
 121         if (state != _auto_state) {
 122                 _auto_state = state;
 123
 124                 const Controls& c (controls());
 125
 126                 for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 127                         boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 128                         if (ac) {
 129                                 ac->alist()->set_automation_state (state);
 130                         }
 131                 }
 132
 133                 session().set_dirty ();
 134                 automation_state_changed (_auto_state);
 135         }
 136 }
 137
 138 void
 139 Pannable::start_touch (double when)
 140 {
 141         const Controls& c (controls());
 142
 143         for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 144                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 145                 if (ac) {
 146                         ac->alist()->start_touch (when);
 147                 }
 148         }
 149         g_atomic_int_set (&_touching, 1);
 150 }
 151
 152 void
 153 Pannable::stop_touch (double when)
 154 {
 155         const Controls& c (controls());
 156
 157         for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 158                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 159                 if (ac) {
 160                         ac->alist()->stop_touch (when);
 161                 }
 162         }
 163         g_atomic_int_set (&_touching, 0);
 164 }
 165
 166 XMLNode&
 167 Pannable::get_state ()
 168 {
 169         return state ();
 170 }
 171
 172 XMLNode&
 173 Pannable::state ()
 174 {
 175         XMLNode* node = new XMLNode (X_("Pannable"));
 176
 177         node->add_child_nocopy (pan_azimuth_control->get_state());
 178         node->add_child_nocopy (pan_width_control->get_state());
 179         node->add_child_nocopy (pan_elevation_control->get_state());
 180         node->add_child_nocopy (pan_frontback_control->get_state());
 181         node->add_child_nocopy (pan_lfe_control->get_state());
 182
 183         node->add_child_nocopy (get_automation_xml_state ());
 184
 185         return *node;
 186 }
 187
 188 int
 189 Pannable::set_state (const XMLNode& root, int version)
 190 {
 191         if (root.name() != X_("Pannable")) {
 192                 warning << string_compose (_("Pannable given XML data for %1 - ignored"), root.name()) << endmsg;
 193                 return -1;
 194         }
 195
 196         const XMLNodeList& nlist (root.children());
 197         XMLNodeConstIterator niter;
 198
 199         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 200                 if ((*niter)->name() == Controllable::xml_node_name) {
 201                         std::string control_name;
 202
 203                         if (!(*niter)->get_property (X_("name"), control_name)) {
 204                                 continue;
 205                         }
 206
 207                         if (control_name == pan_azimuth_control->name()) {
 208                                 pan_azimuth_control->set_state (**niter, version);
 209                         } else if (control_name == pan_width_control->name()) {
 210                                 pan_width_control->set_state (**niter, version);
 211                         } else if (control_name == pan_elevation_control->name()) {
 212                                 pan_elevation_control->set_state (**niter, version);
 213                         } else if (control_name == pan_frontback_control->name()) {
 214                                 pan_frontback_control->set_state (**niter, version);
 215                         } else if (control_name == pan_lfe_control->name()) {
 216                                 pan_lfe_control->set_state (**niter, version);
 217                         }
 218
 219                 } else if ((*niter)->name() == Automatable::xml_node_name) {
 220                         set_automation_xml_state (**niter, PanAzimuthAutomation);
 221
 222                 } else {
 223                         /* old school (alpha1-6) XML info */
 224
 225                         float val;
 226                         if ((*niter)->name() == X_("azimuth")) {
 227                                 if ((*niter)->get_property (X_("value"), val)) {
 228                                         pan_azimuth_control->set_value (val, Controllable::NoGroup);
 229                                 }
 230                         } else if ((*niter)->name() == X_("width")) {
 231                                 if ((*niter)->get_property (X_("value"), val)) {
 232                                         pan_width_control->set_value (val, Controllable::NoGroup);
 233                                 }
 234                         } else if ((*niter)->name() == X_("elevation")) {
 235                                 if ((*niter)->get_property (X_("value"), val)) {
 236                                         pan_elevation_control->set_value (val, Controllable::NoGroup);
 237                                 }
 238                         } else if ((*niter)->name() == X_("frontback")) {
 239                                 if ((*niter)->get_property (X_("value"), val)) {
 240                                         pan_frontback_control->set_value (val, Controllable::NoGroup);
 241                                 }
 242                         } else if ((*niter)->name() == X_("lfe")) {
 243                                 if ((*niter)->get_property (X_("value"), val)) {
 244                                         pan_lfe_control->set_value (val, Controllable::NoGroup);
 245                                 }
 246                         }
 247                 }
 248         }
 249
 250         _has_state = true;
 251
 252         return 0;
 253 }
 254
 255 string
 256 Pannable::value_as_string (boost::shared_ptr<const AutomationControl> ac) const
 257 {
 258         boost::shared_ptr<Panner> p = panner ();
 259
 260         if (p) {
 261                 return p->value_as_string (ac);
 262         }
 263
 264         return ARDOUR::value_as_string(ac->desc(), ac->get_value());
 265 }