libs/ardour/ardour/solo_isolate_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_isolate_control_h__
  20 #define __ardour_solo_isolate_control_h__
  21
  22 #include <string>
  23
  24 #include <boost/shared_ptr.hpp>
  25
  26 #include "ardour/libardour_visibility.h"
  27
  28 class XMLNode;
  29
  30 namespace ARDOUR {
  31
  32 class Session;
  33 class Soloable;
  34 class Muteable;
  35
  36 class LIBARDOUR_API SoloIsolateControl : public SlavableAutomationControl
  37 {
  38   public:
  39         SoloIsolateControl (Session& session, std::string const & name, Soloable& soloable, Muteable& m);
  40
  41         double get_value () const;
  42
  43         /* Export additional API so that objects that only get access
  44          * to a Controllable/AutomationControl can do more fine-grained
  45          * operations with respect to solo isolate. Obviously, they would need
  46          * to dynamic_cast<SoloControl> first.
  47          *
  48          * Solo Isolate state is not representable by a single scalar value,
  49          * so set_value() and get_value() is not enough.
  50          *
  51          * This means that the Controllable is technically
  52          * asymmetric. It is possible to call ::set_value (0.0) to
  53          * disable (self)solo, and then call ::get_value() and get a
  54          * return of 1.0 because the control is isolated by
  55          * upstream/downstream or a master.
  56          */
  57
  58         void mod_solo_isolated_by_upstream (int32_t delta);
  59
  60         /* API to check different aspects of solo isolate substate
  61          */
  62
  63         uint32_t solo_isolated_by_upstream () const {
  64                 return _solo_isolated_by_upstream;
  65         }
  66         bool self_solo_isolated () const {
  67                 return _solo_isolated;
  68         }
  69         bool solo_isolated() const { return self_solo_isolated() || solo_isolated_by_upstream(); }
  70
  71         int set_state (XMLNode const&, int);
  72         XMLNode& get_state ();
  73
  74   protected:
  75         void master_changed (bool from_self, PBD::Controllable::GroupControlDisposition gcd);
  76         void actually_set_value (double, PBD::Controllable::GroupControlDisposition group_override);
  77
  78   private:
  79         Soloable&      _soloable;
  80         Muteable&      _muteable;
  81         bool           _solo_isolated;
  82         uint32_t       _solo_isolated_by_upstream;
  83
  84         void set_solo_isolated (bool yn, Controllable::GroupControlDisposition group_override);
  85
  86 };
  87
  88 } /* namespace */
  89
  90 #endif /* __libardour_solo_isolate_control_h__ */