a slew of as-yet incomplete work to get VCA solo+mute closer to working
[ardour.git] / gtk2_ardour / vca_master_strip.cc
1 /*
2     Copyright (C) 2016 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
19 #include "pbd/convert.h"
20
21 #include "ardour/rc_configuration.h"
22 #include "ardour/session.h"
23 #include "ardour/vca.h"
24 #include "ardour/vca_manager.h"
25
26 #include "gtkmm2ext/keyboard.h"
27
28 #include "gui_thread.h"
29 #include "floating_text_entry.h"
30 #include "tooltips.h"
31 #include "vca_master_strip.h"
32
33 #include "i18n.h"
34
35 using namespace ARDOUR;
36 using namespace ARDOUR_UI_UTILS;
37 using namespace Gtkmm2ext;
38 using namespace Gtk;
39 using namespace PBD;
40 using std::string;
41
42 VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
43         : AxisView (s)
44         , _vca (v)
45         , gain_meter (s, 250)
46         , context_menu (0)
47 {
48         gain_meter.set_controls (boost::shared_ptr<Route>(),
49                                  boost::shared_ptr<PeakMeter>(),
50                                  boost::shared_ptr<Amp>(),
51                                  _vca->gain_control());
52
53         solo_button.set_name ("solo button");
54         set_tooltip (solo_button, _("Solo slaves"));
55         solo_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::solo_release), false);
56
57         mute_button.set_name ("mute button");
58         mute_button.set_text (_("M"));
59         set_tooltip (mute_button, _("Mute slaves"));
60         mute_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::mute_release), false);
61
62         hide_button.set_icon (ArdourIcon::CloseCross);
63         set_tooltip (&hide_button, _("Hide this VCA strip"));
64
65         assign_button.set_name (X_("vca assign"));
66         set_tooltip (assign_button, _("Click to assign a VCA Master to this VCA"));
67         assign_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vca_button_release), false);
68
69         hide_button.signal_clicked.connect (sigc::mem_fun(*this, &VCAMasterStrip::hide_clicked));
70
71         width_hide_box.pack_start (number_label, true, true);
72         width_hide_box.pack_end (hide_button, false, true);
73
74         solo_mute_box.set_spacing (2);
75         solo_mute_box.pack_start (mute_button, true, true);
76         solo_mute_box.pack_start (solo_button, true, true);
77
78         number_label.set_text (to_string (v->number(), std::dec));
79         number_label.set_elements((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text|ArdourButton::Inactive));
80         number_label.set_no_show_all ();
81         number_label.set_name ("generic button");
82         number_label.set_alignment (.5, .5);
83         number_label.set_fallthrough_to_parent (true);
84
85         name_button.signal_button_press_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::name_button_press), false);
86
87         top_padding.set_size_request (-1, 16); /* must match height in GroupTabs::set_size_request() */
88         bottom_padding.set_size_request (-1, 50); /* this one is a hack. there's no trivial way to compute it */
89
90         global_vpacker.set_border_width (1);
91         global_vpacker.set_spacing (0);
92
93         global_vpacker.pack_start (top_padding, false, false);
94         global_vpacker.pack_start (width_hide_box, false, false);
95         global_vpacker.pack_start (name_button, false, false);
96         global_vpacker.pack_start (vertical_padding, true, true);
97         global_vpacker.pack_start (solo_mute_box, false, false);
98         global_vpacker.pack_start (gain_meter, false, false);
99         global_vpacker.pack_start (assign_button, false, false);
100         global_vpacker.pack_start (bottom_padding, false, false);
101
102         global_frame.add (global_vpacker);
103         global_frame.set_shadow_type (Gtk::SHADOW_IN);
104         global_frame.set_name ("BaseFrame");
105
106         add (global_frame);
107
108         global_vpacker.show ();
109         global_frame.show ();
110         top_padding.show ();
111         bottom_padding.show ();
112         vertical_padding.show ();
113         hide_button.show ();
114         number_label.show ();
115         width_hide_box.show ();
116         name_button.show ();
117         gain_meter.show ();
118         solo_mute_box.show_all ();
119         assign_button.show ();
120
121         /* force setting of visible selected status */
122
123         _selected = true;
124         set_selected (false);
125         set_solo_text ();
126         update_vca_display ();
127         update_vca_name ();
128
129         _vca->PropertyChanged.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::vca_property_changed, this, _1), gui_context());
130
131         _vca->solo_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::solo_changed, this), gui_context());
132         _vca->mute_control()->Changed.connect (vca_connections, invalidator (*this), boost::bind (&VCAMasterStrip::mute_changed, this), gui_context());
133
134         _vca->gain_control()->MasterStatusChange.connect (vca_connections,
135                                                   invalidator (*this),
136                                                   boost::bind (&VCAMasterStrip::update_vca_display, this),
137                                                   gui_context());
138 }
139
140 void
141 VCAMasterStrip::update_vca_display ()
142 {
143         VCAList vcas (_session->vca_manager().vcas());
144         string label;
145
146         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
147                 if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
148                         if (!label.empty()) {
149                                 label += ' ';
150                         }
151                         label += to_string ((*v)->number(), std::dec);
152                 }
153         }
154
155         if (label.empty()) {
156                 label = _("-vca-");
157                 assign_button.set_active_state (Gtkmm2ext::Off);
158         } else {
159                 assign_button.set_active_state (Gtkmm2ext::ExplicitActive);
160         }
161
162         assign_button.set_text (label);
163 }
164
165 string
166 VCAMasterStrip::name() const
167 {
168         return _vca->name();
169 }
170
171 void
172 VCAMasterStrip::hide_clicked ()
173 {
174 }
175
176 bool
177 VCAMasterStrip::width_button_pressed (GdkEventButton* ev)
178 {
179         return false;
180 }
181
182 void
183 VCAMasterStrip::set_selected (bool yn)
184 {
185         AxisView::set_selected (yn);
186
187         if (_selected) {
188                 global_frame.set_shadow_type (Gtk::SHADOW_ETCHED_OUT);
189                 global_frame.set_name ("MixerStripSelectedFrame");
190         } else {
191                 global_frame.set_shadow_type (Gtk::SHADOW_IN);
192                 global_frame.set_name ("MixerStripFrame");
193         }
194
195         global_frame.queue_draw ();
196 }
197
198 bool
199 VCAMasterStrip::solo_release (GdkEventButton*)
200 {
201         std::cerr << "VCA solo release, from " << _vca->solo_control()->get_value() << std::endl;
202         _vca->solo_control()->set_value (_vca->solo_control()->get_value() ? 0.0 : 1.0, Controllable::NoGroup);
203         return true;
204 }
205
206 bool
207 VCAMasterStrip::mute_release (GdkEventButton*)
208 {
209         _vca->mute_control()->set_value (_vca->mute_control()->get_value() ? 0.0 : 1.0, Controllable::NoGroup);
210         return true;
211 }
212
213 void
214 VCAMasterStrip::set_solo_text ()
215 {
216         if (Config->get_solo_control_is_listen_control ()) {
217                 switch (Config->get_listen_position()) {
218                 case AfterFaderListen:
219                         solo_button.set_text (_("A"));
220                         break;
221                 case PreFaderListen:
222                         solo_button.set_text (_("P"));
223                         break;
224                         }
225         } else {
226                 solo_button.set_text (_("S"));
227         }
228 }
229
230 void
231 VCAMasterStrip::mute_changed ()
232 {
233         if (_vca->mute_control()->muted()) {
234                 mute_button.set_active_state (ExplicitActive);
235         } else {
236                 mute_button.set_active_state (Gtkmm2ext::Off);
237         }
238 }
239
240 void
241 VCAMasterStrip::solo_changed ()
242 {
243         if (_vca->solo_control()->soloed()) {
244                 solo_button.set_active_state (ExplicitActive);
245         } else {
246                 solo_button.set_active_state (Gtkmm2ext::Off);
247         }
248 }
249
250 void
251 VCAMasterStrip::vca_menu_toggle (CheckMenuItem* menuitem, uint32_t n)
252 {
253         boost::shared_ptr<VCA> vca = _session->vca_manager().vca_by_number (n);
254
255         if (!menuitem->get_active()) {
256                 if (!vca) {
257                         /* null VCA means drop all VCA assignments */
258                         vca_unassign ();
259                 } else {
260                         _vca->gain_control()->remove_master (vca->gain_control());
261                 }
262         } else {
263                 if (vca) {
264                         _vca->gain_control()->add_master (vca->gain_control());
265                 }
266         }
267 }
268
269 void
270 VCAMasterStrip::vca_unassign ()
271 {
272         _vca->gain_control()->clear_masters ();
273 }
274
275 bool
276 VCAMasterStrip::vca_button_release (GdkEventButton* ev)
277 {
278         using namespace Gtk::Menu_Helpers;
279
280         if (!_session) {
281                 return false;
282         }
283
284         /* primary click only */
285
286         if (ev->button != 1) {
287                 return false;
288         }
289
290         VCAList vcas (_session->vca_manager().vcas());
291
292         if (vcas.empty()) {
293                 /* XXX should probably show a message saying "No VCA masters" */
294                 return true;
295         }
296
297         Menu* menu = new Menu;
298         MenuList& items = menu->items();
299
300         items.push_back (MenuElem (_("Unassign"), sigc::mem_fun (*this, &VCAMasterStrip::vca_unassign)));
301
302         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
303
304                 if (*v == _vca) {
305                         /* no self-mastering */
306                         continue;
307                 }
308
309                 items.push_back (CheckMenuElem ((*v)->name()));
310                 CheckMenuItem* item = dynamic_cast<CheckMenuItem*> (&items.back());
311                 if (_vca->gain_control()->slaved_to ((*v)->gain_control())) {
312                         item->set_active (true);
313                 }
314                 item->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VCAMasterStrip::vca_menu_toggle), item, (*v)->number()));
315         }
316
317         menu->popup (1, ev->time);
318
319         return true;
320 }
321
322 bool
323 VCAMasterStrip::name_button_press (GdkEventButton* ev)
324 {
325         if (ev->button == 1 && ev->type == GDK_2BUTTON_PRESS) {
326                 Gtk::Window* win = dynamic_cast<Gtk::Window*>(get_toplevel());
327                 FloatingTextEntry* fte = new FloatingTextEntry (win, _vca->name());
328                 fte->use_text.connect (sigc::mem_fun (*this, &VCAMasterStrip::finish_name_edit));
329                 fte->present ();
330                 return true;
331         }
332
333         if (Keyboard::is_context_menu_event (ev)) {
334                 if (!context_menu) {
335                         build_context_menu ();
336                 }
337                 context_menu->popup (1, ev->time);
338                 return true;
339         }
340
341         return false;
342 }
343
344 void
345 VCAMasterStrip::finish_name_edit (std::string str)
346 {
347         _vca->set_name (str);
348 }
349
350 void
351 VCAMasterStrip::vca_property_changed (PropertyChange const & what_changed)
352 {
353         if (what_changed.contains (ARDOUR::Properties::name)) {
354                 update_vca_name ();
355         }
356 }
357
358 void
359 VCAMasterStrip::update_vca_name ()
360 {
361         name_button.set_text (short_version (_vca->name(), 8));
362 }
363
364 void
365 VCAMasterStrip::build_context_menu ()
366 {
367         using namespace Gtk::Menu_Helpers;
368         context_menu = new Menu;
369         MenuList& items = context_menu->items();
370         items.push_back (MenuElem (_("Remove")));
371 }