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
  25 namespace ARDOUR {
  26
  27 class SlavableAutomationControl : public AutomationControl
  28 {
  29     public:
  30         SlavableAutomationControl(ARDOUR::Session&,
  31                           const Evoral::Parameter&                  parameter,
  32                           const ParameterDescriptor&                desc,
  33                           boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
  34                           const std::string&                        name="");
  35
  36         double get_value () const;
  37
  38         void add_master (boost::shared_ptr<AutomationControl>);
  39         void remove_master (boost::shared_ptr<AutomationControl>);
  40         void clear_masters ();
  41         bool slaved_to (boost::shared_ptr<AutomationControl>) const;
  42         bool slaved () const;
  43         double get_masters_value () const {
  44                 Glib::Threads::RWLock::ReaderLock lm (master_lock);
  45                 return get_masters_value_locked ();
  46         }
  47
  48         std::vector<PBD::ID> masters () const;
  49
  50         PBD::Signal0<void> MasterStatusChange;
  51
  52     protected:
  53
  54         class MasterRecord {
  55           public:
  56                 MasterRecord (boost::shared_ptr<AutomationControl> gc, double r)
  57                         : _master (gc)
  58                         , _ratio (r)
  59                 {}
  60
  61                 boost::shared_ptr<AutomationControl> master() const { return _master; }
  62
  63                 /* for boolean/toggled controls, we store a boolean value to
  64                  * indicate if this master returned true/false (1.0/0.0) from
  65                  * ::get_value() after its most recent change.
  66                  */
  67
  68                 bool yn() const { return _yn; }
  69                 void set_yn (bool yn) { _yn = yn; }
  70
  71                 /* for non-boolean/non-toggled controls, we store a ratio that
  72                  * connects the value of the master with the value of this
  73                  * slave. See comments in the source for more details on how
  74                  * this is computed and used.
  75                  */
  76
  77                 double ratio () const { return _ratio; }
  78                 void reset_ratio (double r) { _ratio = r; }
  79
  80                 PBD::ScopedConnection connection;
  81
  82          private:
  83                 boost::shared_ptr<AutomationControl> _master;
  84                 union {
  85                         double _ratio;
  86                         bool   _yn;
  87                 };
  88         };
  89
  90         mutable Glib::Threads::RWLock master_lock;
  91         typedef std::map<PBD::ID,MasterRecord> Masters;
  92         Masters _masters;
  93         PBD::ScopedConnectionList masters_connections;
  94
  95         void   master_going_away (boost::weak_ptr<AutomationControl>);
  96         double get_value_locked() const;
  97         void   actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
  98         void   update_boolean_masters_records (boost::shared_ptr<AutomationControl>);
  99         int32_t   get_boolean_masters () const;
 100
 101         virtual void   master_changed (bool from_self, GroupControlDisposition gcd, boost::shared_ptr<AutomationControl>);
 102         virtual void   recompute_masters_ratios (double val) { /* do nothing by default */}
 103         virtual double get_masters_value_locked () const;
 104         virtual void   pre_remove_master (boost::shared_ptr<AutomationControl>) {}
 105         virtual void   post_add_master (boost::shared_ptr<AutomationControl>) {}
 106
 107
 108 };
 109
 110 } // namespace ARDOUR
 111
 112 #endif /* __ardour_slavable_automation_control_h__ */