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/convert.h"
  22 #include "pbd/compose.h"
  23
  24 #include "ardour/boost_debug.h"
  25 #include "ardour/debug.h"
  26 #include "ardour/automation_control.h"
  27 #include "ardour/automation_list.h"
  28 #include "ardour/pannable.h"
  29 #include "ardour/panner.h"
  30 #include "ardour/pan_controllable.h"
  31 #include "ardour/session.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         , _auto_style (Absolute)
  49         , _has_state (false)
  50         , _responding_to_control_auto_state_change (0)
  51 {
  52         //boost_debug_shared_ptr_mark_interesting (this, "pannable");
  53
  54         add_control (pan_azimuth_control);
  55         add_control (pan_elevation_control);
  56         add_control (pan_width_control);
  57         add_control (pan_frontback_control);
  58         add_control (pan_lfe_control);
  59
  60         /* all controls change state together */
  61
  62         pan_azimuth_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  63         pan_elevation_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  64         pan_width_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  65         pan_frontback_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  66         pan_lfe_control->alist()->automation_state_changed.connect_same_thread (*this, boost::bind (&Pannable::control_auto_state_changed, this, _1));
  67
  68         pan_azimuth_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  69         pan_elevation_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  70         pan_width_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  71         pan_frontback_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  72         pan_lfe_control->Changed.connect_same_thread (*this, boost::bind (&Pannable::value_changed, this));
  73 }
  74
  75 Pannable::~Pannable ()
  76 {
  77         DEBUG_TRACE (DEBUG::Destruction, string_compose ("pannable @ %1 destructor\n", this));
  78 }
  79
  80 void
  81 Pannable::control_auto_state_changed (AutoState new_state)
  82 {
  83         if (_responding_to_control_auto_state_change) {
  84                 return;
  85         }
  86
  87         _responding_to_control_auto_state_change++;
  88
  89         pan_azimuth_control->set_automation_state (new_state);
  90         pan_width_control->set_automation_state (new_state);
  91         pan_elevation_control->set_automation_state (new_state);
  92         pan_frontback_control->set_automation_state (new_state);
  93         pan_lfe_control->set_automation_state (new_state);
  94
  95         _responding_to_control_auto_state_change--;
  96
  97         _auto_state = new_state;
  98         automation_state_changed (new_state);  /* EMIT SIGNAL */
  99 }
 100
 101 void
 102 Pannable::set_panner (boost::shared_ptr<Panner> p)
 103 {
 104         _panner = p;
 105 }
 106
 107 void
 108 Pannable::value_changed ()
 109 {
 110         _session.set_dirty ();
 111 }
 112
 113 void
 114 Pannable::set_automation_state (AutoState state)
 115 {
 116         if (state != _auto_state) {
 117                 _auto_state = state;
 118
 119                 const Controls& c (controls());
 120
 121                 for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 122                         boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 123                         if (ac) {
 124                                 ac->alist()->set_automation_state (state);
 125                         }
 126                 }
 127
 128                 session().set_dirty ();
 129                 automation_state_changed (_auto_state);
 130         }
 131 }
 132
 133 void
 134 Pannable::set_automation_style (AutoStyle style)
 135 {
 136         if (style != _auto_style) {
 137                 _auto_style = style;
 138
 139                 const Controls& c (controls());
 140
 141                 for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 142                         boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 143                         if (ac) {
 144                                 ac->alist()->set_automation_style (style);
 145                         }
 146                 }
 147
 148                 session().set_dirty ();
 149                 automation_style_changed ();
 150         }
 151 }
 152
 153 void
 154 Pannable::start_touch (double when)
 155 {
 156         const Controls& c (controls());
 157
 158         for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 159                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 160                 if (ac) {
 161                         ac->alist()->start_touch (when);
 162                 }
 163         }
 164         g_atomic_int_set (&_touching, 1);
 165 }
 166
 167 void
 168 Pannable::stop_touch (bool mark, double when)
 169 {
 170         const Controls& c (controls());
 171
 172         for (Controls::const_iterator ci = c.begin(); ci != c.end(); ++ci) {
 173                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
 174                 if (ac) {
 175                         ac->alist()->stop_touch (mark, when);
 176                 }
 177         }
 178         g_atomic_int_set (&_touching, 0);
 179 }
 180
 181 XMLNode&
 182 Pannable::get_state ()
 183 {
 184         return state (true);
 185 }
 186
 187 XMLNode&
 188 Pannable::state (bool /*full*/)
 189 {
 190         LocaleGuard lg;
 191         XMLNode* node = new XMLNode (X_("Pannable"));
 192
 193         node->add_child_nocopy (pan_azimuth_control->get_state());
 194         node->add_child_nocopy (pan_width_control->get_state());
 195         node->add_child_nocopy (pan_elevation_control->get_state());
 196         node->add_child_nocopy (pan_frontback_control->get_state());
 197         node->add_child_nocopy (pan_lfe_control->get_state());
 198
 199         node->add_child_nocopy (get_automation_xml_state ());
 200
 201         return *node;
 202 }
 203
 204 int
 205 Pannable::set_state (const XMLNode& root, int version)
 206 {
 207         if (root.name() != X_("Pannable")) {
 208                 warning << string_compose (_("Pannable given XML data for %1 - ignored"), root.name()) << endmsg;
 209                 return -1;
 210         }
 211
 212         const XMLNodeList& nlist (root.children());
 213         XMLNodeConstIterator niter;
 214
 215         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 216                 if ((*niter)->name() == Controllable::xml_node_name) {
 217                         XMLProperty const * prop = (*niter)->property (X_("name"));
 218
 219                         if (!prop) {
 220                                 continue;
 221                         }
 222
 223                         if (prop->value() == pan_azimuth_control->name()) {
 224                                 pan_azimuth_control->set_state (**niter, version);
 225                         } else if (prop->value() == pan_width_control->name()) {
 226                                 pan_width_control->set_state (**niter, version);
 227                         } else if (prop->value() == pan_elevation_control->name()) {
 228                                 pan_elevation_control->set_state (**niter, version);
 229                         } else if (prop->value() == pan_frontback_control->name()) {
 230                                 pan_frontback_control->set_state (**niter, version);
 231                         } else if (prop->value() == pan_lfe_control->name()) {
 232                                 pan_lfe_control->set_state (**niter, version);
 233                         }
 234
 235                 } else if ((*niter)->name() == Automatable::xml_node_name) {
 236                         set_automation_xml_state (**niter, PanAzimuthAutomation);
 237
 238                 } else {
 239                         XMLProperty const * prop;
 240
 241                         /* old school (alpha1-6) XML info */
 242
 243                         if ((*niter)->name() == X_("azimuth")) {
 244                                 prop = (*niter)->property (X_("value"));
 245                                 if (prop) {
 246                                         pan_azimuth_control->set_value (atof (prop->value()), Controllable::NoGroup);
 247                                 }
 248                         } else if ((*niter)->name() == X_("width")) {
 249                                 prop = (*niter)->property (X_("value"));
 250                                 if (prop) {
 251                                         pan_width_control->set_value (atof (prop->value()), Controllable::NoGroup);
 252                                 }
 253                         } else if ((*niter)->name() == X_("elevation")) {
 254                                 prop = (*niter)->property (X_("value"));
 255                                 if (prop) {
 256                                         pan_elevation_control->set_value (atof (prop->value()), Controllable::NoGroup);
 257                                 }
 258                         } else if ((*niter)->name() == X_("frontback")) {
 259                                 prop = (*niter)->property (X_("value"));
 260                                 if (prop) {
 261                                         pan_frontback_control->set_value (atof (prop->value()), Controllable::NoGroup);
 262                                 }
 263                         } else if ((*niter)->name() == X_("lfe")) {
 264                                 prop = (*niter)->property (X_("value"));
 265                                 if (prop) {
 266                                         pan_lfe_control->set_value (atof (prop->value()), Controllable::NoGroup);
 267                                 }
 268                         }
 269                 }
 270         }
 271
 272         _has_state = true;
 273
 274         return 0;
 275 }
 276
 277 string
 278 Pannable::value_as_string (boost::shared_ptr<const AutomationControl> ac) const
 279 {
 280         boost::shared_ptr<Panner> p = panner ();
 281
 282         if (p) {
 283                 return p->value_as_string (ac);
 284         }
 285
 286         return Automatable::value_as_string (ac);
 287 }