libs/ardour/ardour/solo_control.h

   1 /*
   2     Copyright (C) 2016 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __ardour_solo_control_h__
  20 #define __ardour_solo_control_h__
  21
  22 #include <string>
  23
  24 #include <boost/shared_ptr.hpp>
  25
  26 #include "ardour/slavable_automation_control.h"
  27 #include "ardour/libardour_visibility.h"
  28
  29 namespace ARDOUR {
  30
  31 class Session;
  32 class Soloable;
  33 class Muteable;
  34
  35 class LIBARDOUR_API SoloControl : public SlavableAutomationControl
  36 {
  37   public:
  38         SoloControl (Session& session, std::string const & name, Soloable& soloable, Muteable& m);
  39
  40         double get_value () const;
  41
  42         bool can_solo() const;
  43
  44         /* Export additional API so that objects that only get access
  45          * to a Controllable/AutomationControl can do more fine-grained
  46          * operations with respect to solo. Obviously, they would need
  47          * to dynamic_cast<SoloControl> first.
  48          *
  49          * Solo state is not representable by a single scalar value,
  50          * so set_value() and get_value() is not enough.
  51          *
  52          * This means that the Controllable is technically
  53          * asymmetric. It is possible to call ::set_value (0.0) to
  54          * disable (self)solo, and then call ::get_value() and get a
  55          * return of 1.0 because the control is soloed by
  56          * upstream/downstream or a master.
  57          */
  58
  59         void mod_solo_by_others_upstream (int32_t delta);
  60         void mod_solo_by_others_downstream (int32_t delta);
  61
  62         /* API to check different aspects of solo substate
  63          */
  64
  65         bool self_soloed () const {
  66                 return _self_solo;
  67         }
  68         bool soloed_by_masters () const {
  69                 return get_masters_value();
  70         }
  71         bool soloed_by_self_or_masters () const {
  72                 return self_soloed() || get_masters_value ();
  73         }
  74         bool soloed_by_others () const {
  75                 return _soloed_by_others_downstream || _soloed_by_others_downstream || get_masters_value ();
  76         }
  77         uint32_t soloed_by_others_upstream () const {
  78                 return _soloed_by_others_upstream;
  79         }
  80         uint32_t soloed_by_others_downstream () const {
  81                 return _soloed_by_others_downstream;
  82         }
  83         bool soloed() const { return self_soloed() || soloed_by_others(); }
  84
  85         /* The session object needs to respond to solo
  86            changes, but to do so accurately it needs to know if we transition
  87            into or out of solo. The normal Changed signal doesn't make that
  88            possible.
  89         */
  90
  91         int32_t transitioned_into_solo () const { return _transition_into_solo; }
  92
  93         void clear_all_solo_state ();
  94
  95         int set_state (XMLNode const&, int);
  96         XMLNode& get_state ();
  97
  98   protected:
  99         void actually_set_value (double, PBD::Controllable::GroupControlDisposition group_override);
 100         void master_changed (bool from_self, GroupControlDisposition, boost::shared_ptr<AutomationControl> m);
 101         void pre_remove_master (boost::shared_ptr<AutomationControl>);
 102         void post_add_master (boost::shared_ptr<AutomationControl>);
 103
 104   private:
 105         Soloable& _soloable;
 106         Muteable& _muteable;
 107         bool      _self_solo;
 108         uint32_t  _soloed_by_others_upstream;
 109         uint32_t  _soloed_by_others_downstream;
 110         int32_t   _transition_into_solo;
 111
 112         void set_self_solo (bool yn);
 113         void set_mute_master_solo ();
 114 };
 115
 116 } /* namespace */
 117
 118 #endif /* __libardour_solo_control_h__ */