libs/ardour/ardour/pannable.h

   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 #ifndef __libardour_pannable_h__
  21 #define __libardour_pannable_h__
  22
  23 #include <string>
  24
  25 #include <boost/shared_ptr.hpp>
  26
  27 #include "pbd/stateful.h"
  28 #include "evoral/Parameter.hpp"
  29
  30 #include "ardour/automatable.h"
  31 #include "ardour/session_handle.h"
  32
  33 namespace ARDOUR {
  34
  35 class Session;
  36 class AutomationControl;
  37 class Panner;
  38
  39 class LIBARDOUR_API Pannable : public PBD::Stateful, public Automatable, public SessionHandleRef
  40 {
  41 public:
  42         Pannable (Session& s);
  43         ~Pannable ();
  44
  45         boost::shared_ptr<AutomationControl> pan_azimuth_control;
  46         boost::shared_ptr<AutomationControl> pan_elevation_control;
  47         boost::shared_ptr<AutomationControl> pan_width_control;
  48         boost::shared_ptr<AutomationControl> pan_frontback_control;
  49         boost::shared_ptr<AutomationControl> pan_lfe_control;
  50
  51         boost::shared_ptr<Panner> panner() const { return _panner.lock(); }
  52         void set_panner(boost::shared_ptr<Panner>);
  53
  54         Session& session() { return _session; }
  55
  56         void set_automation_state (AutoState);
  57         AutoState automation_state() const { return _auto_state; }
  58         PBD::Signal1<void, AutoState> automation_state_changed;
  59
  60         bool automation_playback() const {
  61                 return (_auto_state & Play) || ((_auto_state & (Touch | Latch)) && !touching());
  62         }
  63         bool automation_write () const {
  64                 return ((_auto_state & Write) || ((_auto_state & (Touch | Latch)) && touching()));
  65         }
  66
  67         std::string value_as_string (boost::shared_ptr<const AutomationControl>) const;
  68
  69         void start_touch (double when);
  70         void stop_touch (double when);
  71         bool touching() const { return g_atomic_int_get (const_cast<gint*>(&_touching)); }
  72         bool writing() const { return _auto_state == Write; }
  73         bool touch_enabled() const { return _auto_state & (Touch | Latch); }
  74
  75         XMLNode& get_state ();
  76         int set_state (const XMLNode&, int version);
  77
  78         bool has_state() const { return _has_state; }
  79
  80 protected:
  81         virtual XMLNode& state ();
  82
  83         boost::weak_ptr<Panner> _panner;
  84         AutoState _auto_state;
  85         gint      _touching;
  86         bool      _has_state;
  87         uint32_t  _responding_to_control_auto_state_change;
  88
  89         void control_auto_state_changed (AutoState);
  90
  91 private:
  92         void value_changed ();
  93 };
  94
  95 } // namespace
  96
  97 #endif /* __libardour_pannable_h__ */