2 Copyright (C) 2016 Paul Davis
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)
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
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.
19 #ifndef __ardour_solo_control_h__
20 #define __ardour_solo_control_h__
24 #include <boost/shared_ptr.hpp>
26 #include "ardour/slavable_automation_control.h"
27 #include "ardour/libardour_visibility.h"
35 class LIBARDOUR_API SoloControl : public SlavableAutomationControl
38 SoloControl (Session& session, std::string const & name, Soloable& soloable, Muteable& m);
40 double get_value () const;
41 double get_save_value() const { return self_soloed(); }
43 bool can_solo() const;
45 /* Export additional API so that objects that only get access
46 * to a Controllable/AutomationControl can do more fine-grained
47 * operations with respect to solo. Obviously, they would need
48 * to dynamic_cast<SoloControl> first.
50 * Solo state is not representable by a single scalar value,
51 * so set_value() and get_value() is not enough.
53 * This means that the Controllable is technically
54 * asymmetric. It is possible to call ::set_value (0.0) to
55 * disable (self)solo, and then call ::get_value() and get a
56 * return of 1.0 because the control is soloed by
57 * upstream/downstream or a master.
60 void mod_solo_by_others_upstream (int32_t delta);
61 void mod_solo_by_others_downstream (int32_t delta);
63 /* API to check different aspects of solo substate
66 bool self_soloed () const {
69 bool soloed_by_masters () const {
70 return get_masters_value();
72 bool soloed_by_self_or_masters () const {
73 return self_soloed() || get_masters_value ();
75 bool soloed_by_others () const {
76 return _soloed_by_others_downstream || _soloed_by_others_upstream || get_masters_value ();
78 uint32_t soloed_by_others_upstream () const {
79 return _soloed_by_others_upstream;
81 uint32_t soloed_by_others_downstream () const {
82 return _soloed_by_others_downstream;
84 bool soloed() const { return self_soloed() || soloed_by_others(); }
86 /* The session object needs to respond to solo
87 changes, but to do so accurately it needs to know if we transition
88 into or out of solo. The normal Changed signal doesn't make that
92 int32_t transitioned_into_solo () const { return _transition_into_solo; }
94 void clear_all_solo_state ();
96 int set_state (XMLNode const&, int);
97 XMLNode& get_state ();
100 void actually_set_value (double, PBD::Controllable::GroupControlDisposition group_override);
101 void master_changed (bool from_self, GroupControlDisposition, boost::weak_ptr<AutomationControl> m);
102 void pre_remove_master (boost::shared_ptr<AutomationControl>);
103 void post_add_master (boost::shared_ptr<AutomationControl>);
109 uint32_t _soloed_by_others_upstream;
110 uint32_t _soloed_by_others_downstream;
111 int32_t _transition_into_solo;
113 void set_self_solo (bool yn);
114 void set_mute_master_solo ();
119 #endif /* __libardour_solo_control_h__ */