use redesigned Route and VCA object architecture/API
[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 "tooltips.h"
27 #include "vca_master_strip.h"
28 #include "gui_thread.h"
29
30 #include "i18n.h"
31
32 using namespace ARDOUR;
33 using namespace ARDOUR_UI_UTILS;
34 using namespace Gtkmm2ext;
35 using namespace Gtk;
36 using std::string;
37
38 VCAMasterStrip::VCAMasterStrip (Session* s, boost::shared_ptr<VCA> v)
39         : AxisView (s)
40         , _vca (v)
41         , gain_meter (s, 250)
42         , wide (true)
43 {
44         gain_meter.set_controls (boost::shared_ptr<Route>(),
45                                  boost::shared_ptr<PeakMeter>(),
46                                  boost::shared_ptr<Amp>(),
47                                  _vca->gain_control());
48
49         solo_button.set_name ("solo button");
50         set_tooltip (solo_button, _("Solo slaves"));
51         solo_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::solo_release), false);
52
53         mute_button.set_name ("mute button");
54         set_tooltip (mute_button, _("Mute slaves"));
55         mute_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::mute_release), false);
56
57         hide_button.set_icon (ArdourIcon::CloseCross);
58         set_tooltip (&hide_button, _("Hide this VCA strip"));
59
60         width_button.set_icon (ArdourIcon::StripWidth);
61         set_tooltip (width_button, _("Click to toggle the width of this VCA strip."));
62
63         assign_button.set_name (X_("vca assign"));
64         set_tooltip (assign_button, _("Click to assign a VCA Master to this VCA"));
65         assign_button.signal_button_release_event().connect (sigc::mem_fun (*this, &VCAMasterStrip::vca_button_release), false);
66
67         width_button.signal_button_press_event().connect (sigc::mem_fun(*this, &VCAMasterStrip::width_button_pressed), false);
68         hide_button.signal_clicked.connect (sigc::mem_fun(*this, &VCAMasterStrip::hide_clicked));
69
70         width_hide_box.set_spacing (2);
71         width_hide_box.pack_start (width_button, false, true);
72         width_hide_box.pack_start (number_label, true, true);
73         width_hide_box.pack_end (hide_button, false, true);
74
75         solo_mute_box.set_spacing (2);
76         solo_mute_box.pack_start (mute_button, true, true);
77         solo_mute_box.pack_start (solo_button, true, true);
78
79         number_label.set_text (PBD::to_string (v->number(), std::dec));
80         number_label.set_elements((ArdourButton::Element)(ArdourButton::Edge|ArdourButton::Body|ArdourButton::Text|ArdourButton::Inactive));
81         number_label.set_no_show_all ();
82         number_label.set_name ("tracknumber label");
83         number_label.set_fixed_colors (0x80808080, 0x80808080);
84         number_label.set_alignment (.5, .5);
85         number_label.set_fallthrough_to_parent (true);
86
87         name_button.set_text (_vca->name());
88         active_button.set_text ("active");
89
90         top_padding.set_size_request (-1, 16); /* must match height in GroupTabs::set_size_request() */
91         bottom_padding.set_size_request (-1, 50); /* this one is a hack. there's no trivial way to compute it */
92
93         global_vpacker.set_border_width (1);
94         global_vpacker.set_spacing (0);
95
96         global_vpacker.pack_start (top_padding, false, false);
97         global_vpacker.pack_start (width_hide_box, false, false);
98         global_vpacker.pack_start (active_button, false, false);
99         global_vpacker.pack_start (name_button, false, false);
100         global_vpacker.pack_start (vertical_padding, true, true);
101         global_vpacker.pack_start (solo_mute_box, false, false);
102         global_vpacker.pack_start (gain_meter, false, false);
103         global_vpacker.pack_start (assign_button, false, false);
104         global_vpacker.pack_start (bottom_padding, false, false);
105
106         global_frame.add (global_vpacker);
107         global_frame.set_shadow_type (Gtk::SHADOW_IN);
108         global_frame.set_name ("BaseFrame");
109
110         add (global_frame);
111
112         global_vpacker.show ();
113         global_frame.show ();
114         top_padding.show ();
115         bottom_padding.show ();
116         vertical_padding.show ();
117         width_hide_box.show_all ();
118         active_button.show_all ();
119         name_button.show_all ();
120         gain_meter.show_all ();
121         solo_mute_box.show_all ();
122         assign_button.show ();
123
124         /* force setting of visible selected status */
125
126         _selected = true;
127         set_selected (false);
128         set_width (true);
129         update_vca_display ();
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()->VCAStatusChange.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)) {
148                         if (!label.empty()) {
149                                 label += ' ';
150                         }
151                         label += PBD::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         _vca->solo_control()->set_value (_vca->soloed() ? 0.0 : 1.0, PBD::Controllable::NoGroup);
202         return true;
203 }
204
205 bool
206 VCAMasterStrip::mute_release (GdkEventButton*)
207 {
208         _vca->mute_control()->set_value (_vca->muted() ? 0.0 : 1.0, PBD::Controllable::NoGroup);
209         return true;
210 }
211
212 void
213 VCAMasterStrip::set_solo_text ()
214 {
215         if (wide) {
216                 if (Config->get_solo_control_is_listen_control ()) {
217                         switch (Config->get_listen_position()) {
218                         case AfterFaderListen:
219                                 solo_button.set_text (_("AFL"));
220                                 break;
221                         case PreFaderListen:
222                                 solo_button.set_text (_("PFL"));
223                                 break;
224                         }
225                 } else {
226                         solo_button.set_text (_("Solo"));
227                 }
228         } else {
229                 if (Config->get_solo_control_is_listen_control ()) {
230                         switch (Config->get_listen_position()) {
231                         case AfterFaderListen:
232                                 solo_button.set_text (_("A"));
233                                 break;
234                         case PreFaderListen:
235                                 solo_button.set_text (_("P"));
236                                 break;
237                         }
238                 } else {
239                         solo_button.set_text (_("S"));
240                 }
241         }
242 }
243
244 void
245 VCAMasterStrip::set_width (bool w)
246 {
247         wide = w;
248
249         if (wide) {
250                 mute_button.set_text (_("Mute"));
251         } else {
252                 mute_button.set_text (_("m"));
253         }
254
255         set_solo_text ();
256 }
257
258 void
259 VCAMasterStrip::mute_changed ()
260 {
261         if (_vca->muted()) {
262                 mute_button.set_active_state (ExplicitActive);
263         } else {
264                 mute_button.set_active_state (Gtkmm2ext::Off);
265         }
266 }
267
268 void
269 VCAMasterStrip::solo_changed ()
270 {
271         if (_vca->soloed()) {
272                 solo_button.set_active_state (ExplicitActive);
273         } else {
274                 solo_button.set_active_state (Gtkmm2ext::Off);
275         }
276 }
277
278 void
279 VCAMasterStrip::vca_menu_toggle (CheckMenuItem* menuitem, uint32_t n)
280 {
281         boost::shared_ptr<VCA> vca = _session->vca_manager().vca_by_number (n);
282
283         if (!menuitem->get_active()) {
284                 if (!vca) {
285                         /* null VCA means drop all VCA assignments */
286                         vca_unassign ();
287                 } else {
288                         _vca->gain_control()->remove_master (vca);
289                 }
290         } else {
291                 if (vca) {
292                         _vca->gain_control()->add_master (vca);
293                 }
294         }
295 }
296
297 void
298 VCAMasterStrip::vca_unassign ()
299 {
300         _vca->gain_control()->clear_masters ();
301 }
302
303 bool
304 VCAMasterStrip::vca_button_release (GdkEventButton* ev)
305 {
306         using namespace Gtk::Menu_Helpers;
307
308         if (!_session) {
309                 return false;
310         }
311
312         /* primary click only */
313
314         if (ev->button != 1) {
315                 return false;
316         }
317
318         VCAList vcas (_session->vca_manager().vcas());
319
320         if (vcas.empty()) {
321                 /* XXX should probably show a message saying "No VCA masters" */
322                 return true;
323         }
324
325         Menu* menu = new Menu;
326         MenuList& items = menu->items();
327
328         items.push_back (MenuElem (_("Unassign"), sigc::mem_fun (*this, &VCAMasterStrip::vca_unassign)));
329
330         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
331
332                 if (*v == _vca) {
333                         /* no self-mastering */
334                         continue;
335                 }
336
337                 items.push_back (CheckMenuElem ((*v)->name()));
338                 CheckMenuItem* item = dynamic_cast<CheckMenuItem*> (&items.back());
339                 if (_vca->gain_control()->slaved_to (*v)) {
340                         item->set_active (true);
341                 }
342                 item->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &VCAMasterStrip::vca_menu_toggle), item, (*v)->number()));
343         }
344
345         menu->popup (1, ev->time);
346
347         return true;
348 }