1 /*
2  * Copyright (C) 2016 Paul Davis <paul@linuxaudiosystems.com>
3  * Copyright (C) 2016 Tim Mayberry <mojofunk@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  */
19 
20 #include "ardour/debug.h"
21 #include "ardour/mute_master.h"
22 #include "ardour/session.h"
23 #include "ardour/solo_isolate_control.h"
24 
25 #include "pbd/i18n.h"
26 
27 using namespace ARDOUR;
28 using namespace std;
29 using namespace PBD;
30 
SoloIsolateControl(Session & session,std::string const & name,Soloable & s)31 SoloIsolateControl::SoloIsolateControl (Session& session, std::string const & name, Soloable& s)
32 	: SlavableAutomationControl (session, SoloIsolateAutomation, ParameterDescriptor (SoloIsolateAutomation),
33 	                             boost::shared_ptr<AutomationList>(new AutomationList(Evoral::Parameter(SoloIsolateAutomation))),
34 	                             name)
35 	, _soloable (s)
36 	, _solo_isolated (false)
37 	, _solo_isolated_by_upstream (0)
38 {
39 	_list->set_interpolation (Evoral::ControlList::Discrete);
40 	/* isolate changes must be synchronized by the process cycle */
41 	set_flag (Controllable::RealTime);
42 }
43 
44 void
master_changed(bool from_self,PBD::Controllable::GroupControlDisposition gcd,boost::weak_ptr<AutomationControl>)45 SoloIsolateControl::master_changed (bool from_self, PBD::Controllable::GroupControlDisposition gcd, boost::weak_ptr<AutomationControl>)
46 {
47 	if (!_soloable.can_solo()) {
48 		return;
49 	}
50 
51 	bool master_soloed;
52 
53 	{
54 		Glib::Threads::RWLock::ReaderLock lm (master_lock);
55 		master_soloed = (bool) get_masters_value_locked ();
56 	}
57 
58 	/* Master is considered equivalent to an upstream solo control, not
59 	 * direct control over self-soloed.
60 	 */
61 
62 	mod_solo_isolated_by_upstream (master_soloed ? 1 : -1);
63 
64 	/* no need to call AutomationControl::master_changed() since it just
65 	   emits Changed() which we already did in mod_solo_by_others_upstream()
66 	*/
67 }
68 
69 void
mod_solo_isolated_by_upstream(int32_t delta)70 SoloIsolateControl::mod_solo_isolated_by_upstream (int32_t delta)
71 {
72 	bool old = solo_isolated ();
73 	DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 mod_solo_isolated_by_upstream cur: %2 d: %3\n",
74 	                                          name(), _solo_isolated_by_upstream, delta));
75 
76 	if (delta < 0) {
77 		if (_solo_isolated_by_upstream >= (uint32_t) abs(delta)) {
78 			_solo_isolated_by_upstream += delta;
79 		} else {
80 			_solo_isolated_by_upstream = 0;
81 		}
82 	} else {
83 		_solo_isolated_by_upstream += delta;
84 	}
85 
86 	if (solo_isolated() != old) {
87 		Changed (false, Controllable::NoGroup); /* EMIT SIGNAL */
88 	}
89 }
90 
91 void
actually_set_value(double val,PBD::Controllable::GroupControlDisposition gcd)92 SoloIsolateControl::actually_set_value (double val, PBD::Controllable::GroupControlDisposition gcd)
93 {
94 	if (!_soloable.can_solo()) {
95 		return;
96 	}
97 
98 	set_solo_isolated (val, gcd);
99 
100 	/* this sets the Evoral::Control::_user_value for us, which will
101 	   be retrieved by AutomationControl::get_value (), and emits Changed
102 	*/
103 
104 	AutomationControl::actually_set_value (val, gcd);
105 }
106 
107 void
set_solo_isolated(bool yn,Controllable::GroupControlDisposition group_override)108 SoloIsolateControl::set_solo_isolated (bool yn, Controllable::GroupControlDisposition group_override)
109 {
110 	if (!_soloable.can_solo()) {
111 		return;
112 	}
113 
114 	bool changed = false;
115 
116 	if (yn) {
117 		if (_solo_isolated == false) {
118 			changed = true;
119 		}
120 		_solo_isolated = true;
121 	} else {
122 		if (_solo_isolated == true) {
123 			_solo_isolated = false;
124 			changed = true;
125 		}
126 	}
127 
128 	if (!changed) {
129 		return;
130 	}
131 
132 	_soloable.push_solo_isolate_upstream (yn ? 1 : -1);
133 
134 	/* XXX should we back-propagate as well? (April 2010: myself and chris goddard think not) */
135 
136 	Changed (true, group_override); /* EMIT SIGNAL */
137 }
138 
139 
140 double
get_value() const141 SoloIsolateControl::get_value () const
142 {
143 	if (slaved()) {
144 		return solo_isolated() || get_masters_value ();
145 	}
146 
147 	if (_list && boost::dynamic_pointer_cast<AutomationList>(_list)->automation_playback()) {
148 		// Playing back automation, get the value from the list
149 		return AutomationControl::get_value();
150 	}
151 
152 	return solo_isolated ();
153 }
154 
155 int
set_state(XMLNode const & node,int version)156 SoloIsolateControl::set_state (XMLNode const & node, int version)
157 {
158 	if (SlavableAutomationControl::set_state(node, version)) {
159 		return -1;
160 	}
161 
162 	node.get_property ("solo-isolated", _solo_isolated);
163 	return 0;
164 }
165 
166 XMLNode&
get_state()167 SoloIsolateControl::get_state ()
168 {
169 	XMLNode& node (SlavableAutomationControl::get_state());
170 	node.set_property (X_("solo-isolated"), _solo_isolated);
171 	return node;
172 }
173