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_mute_control_h__
20 #define __ardour_mute_control_h__
24 #include <boost/shared_ptr.hpp>
26 #include "ardour/slavable_automation_control.h"
28 #include "ardour/mute_master.h"
29 #include "ardour/libardour_visibility.h"
36 class LIBARDOUR_API MuteControl : public SlavableAutomationControl
39 MuteControl (Session& session, std::string const& name, Muteable&);
41 double get_value () const;
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 mute. Obviously, they would need
46 * to dynamic_cast<MuteControl> first.
48 * Mute state is not representable by a single scalar value,
49 * so set_value() and get_value() is not enough.
51 * This means that the Controllable is technically
52 * asymmetric. It is possible to call ::set_value (0.0) to
53 * turn off mute, and then call ::get_value() and get a
54 * return of 1.0 because the control is affected by
55 * upstream/downstream or a master.
59 bool muted_by_self () const;
60 bool muted_by_masters () const;
61 bool muted_by_self_or_masters () const {
62 return muted_by_self() || muted_by_masters ();
65 bool muted_by_others_soloing () const;
67 void set_mute_points (MuteMaster::MutePoint);
68 MuteMaster::MutePoint mute_points () const;
71 void master_changed (bool, PBD::Controllable::GroupControlDisposition, boost::shared_ptr<AutomationControl>);
72 void actually_set_value (double, PBD::Controllable::GroupControlDisposition group_override);
74 void pre_remove_master (boost::shared_ptr<AutomationControl>);
75 void post_add_master (boost::shared_ptr<AutomationControl>);
83 #endif /* __libardour_mute_control_h__ */