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>);
  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
  49         virtual void automation_run (framepos_t start, pframes_t nframes);
  50
  51         double get_masters_value () const {
  52                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  53                 return get_masters_value_locked ();
  54         }
  55
  56         /* factor out get_masters_value() */
  57         double reduce_by_masters (double val, bool ignore_automation_state = false) const {
  58                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  59                 return reduce_by_masters_locked (val, ignore_automation_state);
  60         }
  61
  62         bool get_masters_curve (framepos_t s, framepos_t e, float* v, framecnt_t l) const {
  63                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  64                 return get_masters_curve_locked (s, e, v, l);
  65         }
  66
  67         /* for toggled/boolean controls, returns a count of the number of
  68            masters currently enabled. For other controls, returns zero.
  69         */
  70         int32_t   get_boolean_masters () const;
  71
  72         std::vector<PBD::ID> masters () const;
  73
  74         PBD::Signal0<void> MasterStatusChange;
  75
  76         void use_saved_master_ratios ();
  77
  78         int set_state (XMLNode const&, int);
  79         XMLNode& get_state();
  80
  81         bool find_next_event (double n, double e, Evoral::ControlEvent& ev) const
  82         {
  83                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  84                 return find_next_event_locked (n, e, ev);
  85         }
  86
  87         bool find_next_event_locked (double now, double end, Evoral::ControlEvent& next_event) const;
  88
  89 protected:
  90
  91         class MasterRecord {
  92         public:
  93                 MasterRecord (boost::weak_ptr<AutomationControl> gc, double vc, double vm)
  94                         : _master (gc)
  95                         , _yn (false)
  96                         , _val_ctrl (vc)
  97                         , _val_master (vm)
  98                 {}
  99
 100                 boost::shared_ptr<AutomationControl> master() const { assert(_master.lock()); return _master.lock(); }
 101
 102                 double val_ctrl () const { return _val_ctrl; }
 103                 double val_master () const { return _val_master; }
 104
 105                 double val_master_inv () const { return _val_master == 0 ? 0 : 1.0 / _val_master; }
 106                 double master_ratio () const { return _val_master == 0 ? 0 : master()->get_value() / _val_master; }
 107
 108                 int set_state (XMLNode const&, int);
 109
 110                 /* for boolean/toggled controls, we store a boolean value to
 111                  * indicate if this master returned true/false (1.0/0.0) from
 112                  * ::get_value() after its most recent change.
 113                  */
 114
 115                 bool yn() const { return _yn; }
 116                 void set_yn (bool yn) { _yn = yn; }
 117
 118                 PBD::ScopedConnection changed_connection;
 119                 PBD::ScopedConnection dropped_connection;
 120
 121   private:
 122                 boost::weak_ptr<AutomationControl> _master;
 123                 /* holds most recently seen master value for boolean/toggle controls */
 124                 bool   _yn;
 125
 126                 /* values at time of assignment */
 127                 double _val_ctrl;
 128                 double _val_master;
 129         };
 130
 131         mutable Glib::Threads::RWLock master_lock;
 132         typedef std::map<PBD::ID,MasterRecord> Masters;
 133         Masters _masters;
 134
 135         void   master_going_away (boost::weak_ptr<AutomationControl>);
 136         double get_value_locked() const;
 137         void   actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
 138         void   update_boolean_masters_records (boost::shared_ptr<AutomationControl>);
 139
 140         virtual bool get_masters_curve_locked (framepos_t, framepos_t, float*, framecnt_t) const;
 141         bool masters_curve_multiply (framepos_t, framepos_t, float*, framecnt_t) const;
 142
 143         virtual double reduce_by_masters_locked (double val, bool) const;
 144         virtual double scale_automation_callback (double val, double ratio) const;
 145
 146         virtual bool handle_master_change (boost::shared_ptr<AutomationControl>);
 147         virtual bool boolean_automation_run_locked (framepos_t start, pframes_t len);
 148         bool boolean_automation_run (framepos_t start, pframes_t len);
 149
 150         virtual void   master_changed (bool from_self, GroupControlDisposition gcd, boost::weak_ptr<AutomationControl>);
 151         virtual double get_masters_value_locked () const;
 152         virtual void   pre_remove_master (boost::shared_ptr<AutomationControl>) {}
 153         virtual void   post_add_master (boost::shared_ptr<AutomationControl>) {}
 154
 155         XMLNode* _masters_node; /* used to store master ratios in ::set_state() for later use */
 156 };
 157
 158 } // namespace ARDOUR
 159
 160 #endif /* __ardour_slavable_automation_control_h__ */