libs/ardour/ardour/slavable_automation_control.h

   1 /*
   2     Copyright (C) 2016 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 __ardour_slavable_automation_control_h__
  21 #define __ardour_slavable_automation_control_h__
  22
  23 #include "ardour/automation_control.h"
  24 #include "ardour/libardour_visibility.h"
  25
  26 namespace ARDOUR {
  27
  28 class LIBARDOUR_API SlavableAutomationControl : public AutomationControl
  29 {
  30     public:
  31         SlavableAutomationControl(ARDOUR::Session&,
  32                                   const Evoral::Parameter&                  parameter,
  33                                   const ParameterDescriptor&                desc,
  34                                   boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
  35                                   const std::string&                        name="",
  36                                   PBD::Controllable::Flag                   flags=PBD::Controllable::Flag (0)
  37                 );
  38
  39         virtual ~SlavableAutomationControl ();
  40
  41         double get_value () const;
  42
  43         void add_master (boost::shared_ptr<AutomationControl>, bool loading);
  44         void remove_master (boost::shared_ptr<AutomationControl>);
  45         void clear_masters ();
  46         bool slaved_to (boost::shared_ptr<AutomationControl>) const;
  47         bool slaved () const;
  48         double get_masters_value () const {
  49                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  50                 return get_masters_value_locked ();
  51         }
  52
  53         bool get_masters_curve (framepos_t s, framepos_t e, float* v, framecnt_t l) const {
  54                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  55                 return get_masters_curve_locked (s, e, v, l);
  56         }
  57         virtual bool get_masters_curve_locked (framepos_t, framepos_t, float*, framecnt_t) const;
  58
  59         bool masters_curve_multiply (framepos_t, framepos_t, float*, framecnt_t) const;
  60
  61         /* for toggled/boolean controls, returns a count of the number of
  62            masters currently enabled. For other controls, returns zero.
  63         */
  64         int32_t   get_boolean_masters () const;
  65
  66         std::vector<PBD::ID> masters () const;
  67
  68         PBD::Signal0<void> MasterStatusChange;
  69
  70         void use_saved_master_ratios ();
  71
  72         int set_state (XMLNode const&, int);
  73         XMLNode& get_state();
  74
  75         bool find_next_event (double n, double e, Evoral::ControlEvent& ev) const
  76         {
  77                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  78                 return find_next_event_locked (n, e, ev);
  79         }
  80
  81         bool find_next_event_locked (double now, double end, Evoral::ControlEvent& next_event) const;
  82
  83     protected:
  84
  85         class MasterRecord {
  86           public:
  87                 MasterRecord (boost::shared_ptr<AutomationControl> gc, double r)
  88                         : _master (gc)
  89                         , _yn (false)
  90                 {}
  91
  92                 boost::shared_ptr<AutomationControl> master() const { return _master; }
  93
  94                 /* for boolean/toggled controls, we store a boolean value to
  95                  * indicate if this master returned true/false (1.0/0.0) from
  96                  * ::get_value() after its most recent change.
  97                  */
  98
  99                 bool yn() const { return _yn; }
 100                 void set_yn (bool yn) { _yn = yn; }
 101
 102                 PBD::ScopedConnection connection;
 103
 104          private:
 105                 boost::shared_ptr<AutomationControl> _master;
 106                 /* holds most recently seen master value for boolean/toggle controls */
 107                 bool   _yn;
 108         };
 109
 110         mutable Glib::Threads::RWLock master_lock;
 111         typedef std::map<PBD::ID,MasterRecord> Masters;
 112         Masters _masters;
 113         std::map<boost::weak_ptr<AutomationControl>, PBD::ScopedConnection> masters_connections;
 114
 115         void   master_going_away (boost::weak_ptr<AutomationControl>);
 116         double get_value_locked() const;
 117         void   actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
 118         void   update_boolean_masters_records (boost::shared_ptr<AutomationControl>);
 119
 120         virtual void   master_changed (bool from_self, GroupControlDisposition gcd, boost::shared_ptr<AutomationControl>);
 121         virtual double get_masters_value_locked () const;
 122         virtual void   pre_remove_master (boost::shared_ptr<AutomationControl>) {}
 123         virtual void   post_add_master (boost::shared_ptr<AutomationControl>) {}
 124
 125         XMLNode* _masters_node; /* used to store master ratios in ::set_state() for later use */
 126 };
 127
 128 } // namespace ARDOUR
 129
 130 #endif /* __ardour_slavable_automation_control_h__ */