consistent use of context-menu popups
[ardour.git] / gtk2_ardour / control_slave_ui.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 <string>
20
21 #include <gtkmm/menu.h>
22
23 #include "pbd/convert.h"
24
25 #include "ardour/session.h"
26 #include "ardour/stripable.h"
27 #include "ardour/types.h"
28 #include "ardour/vca.h"
29 #include "ardour/vca_manager.h"
30
31 #include "gtkmm2ext/gtk_ui.h"
32 #include "gtkmm2ext/utils.h"
33
34 #include "ardour_button.h"
35 #include "control_slave_ui.h"
36 #include "gui_thread.h"
37
38 #include "pbd/i18n.h"
39
40 using namespace ARDOUR;
41 using namespace Gtk;
42 using std::string;
43
44 ControlSlaveUI::ControlSlaveUI (Session* s)
45         : SessionHandlePtr (s)
46         , initial_button (ArdourButton::default_elements)
47         , context_menu (0)
48 {
49         set_no_show_all (true);
50
51         Gtkmm2ext::UI::instance()->set_tip (*this, _("VCA Assign"));
52
53         initial_button.set_no_show_all (true);
54         initial_button.set_name (X_("vca assign"));
55         initial_button.set_text (_("-VCAs-"));
56         initial_button.show ();
57         initial_button.add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
58         initial_button.signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &ControlSlaveUI::vca_button_release), 0), false);
59
60         pack_start (initial_button, true, true);
61 }
62
63 ControlSlaveUI::~ControlSlaveUI ()
64 {
65         delete context_menu;
66 }
67
68 void
69 ControlSlaveUI::set_stripable (boost::shared_ptr<Stripable> s)
70 {
71         connections.drop_connections ();
72
73         stripable = s;
74
75         if (stripable) {
76                 boost::shared_ptr<GainControl> ac = stripable->gain_control();
77                 assert (ac);
78
79                 ac->MasterStatusChange.connect (connections,
80                                                 invalidator (*this),
81                                                 boost::bind (&ControlSlaveUI::update_vca_display, this),
82                                                 gui_context());
83
84                 stripable->DropReferences.connect (connections, invalidator (*this), boost::bind (&ControlSlaveUI::set_stripable, this, boost::shared_ptr<Stripable>()), gui_context());
85         }
86
87         update_vca_display ();
88 }
89
90 void
91 ControlSlaveUI::update_vca_display ()
92 {
93         if (!_session || _session->deletion_in_progress()) {
94                 return;
95         }
96
97         VCAList vcas (_session->vca_manager().vcas());
98         bool any = false;
99
100         Gtkmm2ext::container_clear (*this);
101         master_connections.drop_connections ();
102
103         if (stripable) {
104                 for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
105                         if (stripable->gain_control()->slaved_to ((*v)->gain_control())) {
106                                 add_vca_button (*v);
107                                 any = true;
108                         }
109                 }
110         }
111
112         if (!any) {
113                 pack_start (initial_button, true, true);
114         }
115
116         show ();
117 }
118
119 void
120 ControlSlaveUI::vca_menu_toggle (Gtk::CheckMenuItem* menuitem, uint32_t n)
121 {
122         boost::shared_ptr<VCA> vca = _session->vca_manager().vca_by_number (n);
123
124         if (!vca) {
125                 return;
126         }
127
128         boost::shared_ptr<Slavable> sl = boost::dynamic_pointer_cast<Slavable> (stripable);
129
130         if (!sl) {
131                 return;
132         }
133
134         if (!menuitem->get_active()) {
135                 sl->unassign (vca);
136         } else {
137                 sl->assign (vca, false);
138         }
139 }
140
141 void
142 ControlSlaveUI::unassign_all ()
143 {
144         boost::shared_ptr<Slavable> sl = boost::dynamic_pointer_cast<Slavable> (stripable);
145
146         if (!sl) {
147                 return;
148         }
149
150         sl->unassign (boost::shared_ptr<VCA>());
151 }
152
153 bool
154 ControlSlaveUI::specific_vca_button_release (GdkEventButton* ev, uint32_t n)
155 {
156         return vca_button_release  (ev, n);
157 }
158
159 bool
160 ControlSlaveUI::vca_button_release (GdkEventButton* ev, uint32_t n)
161 {
162         using namespace Gtk::Menu_Helpers;
163
164         if (!_session) {
165                 return false;
166         }
167
168         /* primary click only */
169
170         if (ev->button != 1) {
171                 return false;
172         }
173
174         if (!stripable) {
175                 /* no route - nothing to do */
176                 return false;
177         }
178
179         VCAList vcas (_session->vca_manager().vcas());
180
181         if (vcas.empty()) {
182                 /* the button should not have been visible under these conditions */
183                 return true;
184         }
185
186         delete context_menu;
187         context_menu = new Menu;
188         MenuList& items = context_menu->items();
189         bool slaved = false;
190
191         for (VCAList::iterator v = vcas.begin(); v != vcas.end(); ++v) {
192
193                 boost::shared_ptr<GainControl> gcs = stripable->gain_control();
194                 boost::shared_ptr<GainControl> gcm = (*v)->gain_control();
195
196                 if (gcs == gcm) {
197                         /* asked to slave to self. not ok */
198                         continue;
199                 }
200
201                 if (gcm->slaved_to (gcs)) {
202                         /* master is already slaved to slave */
203                         continue;
204                 }
205
206                 items.push_back (CheckMenuElem ((*v)->name()));
207                 Gtk::CheckMenuItem* item = dynamic_cast<Gtk::CheckMenuItem*> (&items.back());
208
209                 if (gcs->slaved_to (gcm)) {
210                         item->set_active (true);
211                         slaved = true;
212                 }
213
214                 item->signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &ControlSlaveUI::vca_menu_toggle), item, (*v)->number()));
215         }
216
217         if (slaved) {
218                 items.push_back (MenuElem (_("Unassign All"), sigc::mem_fun (*this, &ControlSlaveUI::unassign_all)));
219         }
220
221         if (!items.empty()) {
222                 context_menu->popup (ev->button, ev->time);
223         }
224
225         return true;
226 }
227
228 void
229 ControlSlaveUI::add_vca_button (boost::shared_ptr<VCA> vca)
230 {
231         ArdourButton* vca_button = manage (new ArdourButton (ArdourButton::default_elements));
232
233         vca_button->set_no_show_all (true);
234         vca_button->set_name (X_("vca assign"));
235         vca_button->add_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK);
236         vca_button->signal_button_release_event().connect (sigc::bind (sigc::mem_fun (*this, &ControlSlaveUI::specific_vca_button_release), vca->number()), false);
237         vca_button->set_text (PBD::to_string (vca->number(), std::dec));
238         vca_button->set_fixed_colors (vca->presentation_info().color(), vca->presentation_info().color ());
239
240         vca->presentation_info().PropertyChanged.connect (master_connections, invalidator (*this), boost::bind (&ControlSlaveUI::master_property_changed, this, _1), gui_context());
241
242         pack_start (*vca_button);
243         vca_button->show ();
244 }
245
246 void
247 ControlSlaveUI::master_property_changed (PBD::PropertyChange const& /* what_changed */)
248 {
249         update_vca_display ();
250 }