1 /*
2 * Copyright (C) 2005-2006 Nick Mainsbridge <mainsbridge@gmail.com>
3 * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
4 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
5 * Copyright (C) 2006-2007 Doug McLain <doug@nostar.net>
6 * Copyright (C) 2006-2012 David Robillard <d@drobilla.net>
7 * Copyright (C) 2006 Sampo Savolainen <v2@iki.fi>
8 * Copyright (C) 2008-2012 Carl Hetherington <carl@carlh.net>
9 * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
10 * Copyright (C) 2014-2015 Tim Mayberry <mojofunk@gmail.com>
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 */
26
27 #include <limits.h>
28
29 #include <gtkmm2ext/utils.h>
30
31 #include "pbd/fastlog.h"
32
33 #include "ardour/pannable.h"
34 #include "ardour/panner.h"
35 #include "ardour/panner_shell.h"
36 #include "ardour/session.h"
37
38 #include "widgets/tooltips.h"
39
40 #include "gain_meter.h"
41 #include "panner_ui.h"
42 #include "panner2d.h"
43 #include "gui_thread.h"
44 #include "stereo_panner.h"
45 #include "timers.h"
46 #include "mono_panner.h"
47 #include "ui_config.h"
48
49 #include "pbd/i18n.h"
50
51 using namespace std;
52 using namespace ARDOUR;
53 using namespace PBD;
54 using namespace Gtkmm2ext;
55 using namespace Gtk;
56
PannerUI(Session * s)57 PannerUI::PannerUI (Session* s)
58 : _current_nouts (-1)
59 , _current_nins (-1)
60 , _current_uri ("")
61 , _send_mode (false)
62 , pan_automation_state_button ("")
63 , _panner_list()
64 {
65 set_session (s);
66
67 pan_menu = 0;
68 pan_astate_menu = 0;
69 pan_astyle_menu = 0;
70 in_pan_update = false;
71 _stereo_panner = 0;
72 _mono_panner = 0;
73 _ignore_width_change = false;
74 _ignore_position_change = false;
75
76 pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");
77
78 ArdourWidgets::set_tooltip (pan_automation_state_button, _("Pan automation mode"));
79
80 //set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);
81
82 pan_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
83
84 pan_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);
85
86 pan_vbox.set_spacing (2);
87 pack_start (pan_vbox, true, true);
88
89 twod_panner = 0;
90 big_window = 0;
91
92 set_width(Narrow);
93 }
94
95 void
set_panner(boost::shared_ptr<PannerShell> ps,boost::shared_ptr<Panner> p)96 PannerUI::set_panner (boost::shared_ptr<PannerShell> ps, boost::shared_ptr<Panner> p)
97 {
98 /* note that the panshell might not change here (i.e. ps == _panshell)
99 */
100
101 connections.drop_connections ();
102
103 delete pan_astyle_menu;
104 pan_astyle_menu = 0;
105
106 delete pan_astate_menu;
107 pan_astate_menu = 0;
108
109 _panshell = ps;
110 _panner = p;
111
112 delete twod_panner;
113 twod_panner = 0;
114
115 delete big_window;
116 big_window = 0;
117
118 delete _stereo_panner;
119 _stereo_panner = 0;
120
121 delete _mono_panner;
122 _mono_panner = 0;
123
124 if (!_panner) {
125 return;
126 }
127
128 _panshell->Changed.connect (connections, invalidator (*this), boost::bind (&PannerUI::panshell_changed, this), gui_context());
129
130 /* new panner object, force complete reset of panner GUI
131 */
132
133 _current_nouts = 0;
134 _current_nins = 0;
135
136 setup_pan ();
137 update_pan_sensitive ();
138 pan_automation_state_changed ();
139 }
140
141 void
build_astate_menu()142 PannerUI::build_astate_menu ()
143 {
144 using namespace Menu_Helpers;
145
146 if (pan_astate_menu == 0) {
147 pan_astate_menu = new Menu;
148 pan_astate_menu->set_name ("ArdourContextMenu");
149 } else {
150 pan_astate_menu->items().clear ();
151 }
152
153 boost::shared_ptr<Pannable> pannable = _panshell->pannable();
154
155 pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Off),
156 sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) ARDOUR::Off)));
157 pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Play),
158 sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Play)));
159 pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Write),
160 sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Write)));
161 pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Touch),
162 sigc::bind (sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Touch)));
163 pan_astate_menu->items().push_back (MenuElem (GainMeterBase::astate_string (ARDOUR::Latch),
164 sigc::bind ( sigc::mem_fun (pannable.get(), &Pannable::set_automation_state), (AutoState) Latch)));
165
166 }
167
168 void
build_astyle_menu()169 PannerUI::build_astyle_menu ()
170 {
171 using namespace Menu_Helpers;
172
173 if (pan_astyle_menu == 0) {
174 pan_astyle_menu = new Menu;
175 pan_astyle_menu->set_name ("ArdourContextMenu");
176 } else {
177 pan_astyle_menu->items().clear();
178 }
179
180 pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
181 pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
182 }
183
184 void
on_size_allocate(Allocation & a)185 PannerUI::on_size_allocate (Allocation& a)
186 {
187 HBox::on_size_allocate (a);
188 }
189
190 void
set_width(Width w)191 PannerUI::set_width (Width w)
192 {
193 _width = w;
194 }
195
~PannerUI()196 PannerUI::~PannerUI ()
197 {
198 delete twod_panner;
199 delete big_window;
200 delete pan_menu;
201 delete pan_astyle_menu;
202 delete pan_astate_menu;
203 delete _stereo_panner;
204 delete _mono_panner;
205 }
206
207 void
panshell_changed()208 PannerUI::panshell_changed ()
209 {
210 set_panner (_panshell, _panshell->panner());
211 setup_pan ();
212 }
213
214 void
setup_pan()215 PannerUI::setup_pan ()
216 {
217 int const nouts = _panner ? _panner->out().n_audio() : -1;
218 int const nins = _panner ? _panner->in().n_audio() : -1;
219
220 assert (_panshell);
221
222 if (nouts == _current_nouts
223 && nins == _current_nins
224 && _current_uri == _panshell->panner_gui_uri()
225 )
226 {
227 return;
228 }
229
230 _current_nins = nins;
231 _current_nouts = nouts;
232 _current_uri = _panshell->panner_gui_uri();
233
234 container_clear (pan_vbox);
235
236 delete twod_panner;
237 twod_panner = 0;
238 delete _stereo_panner;
239 _stereo_panner = 0;
240 delete _mono_panner;
241 _mono_panner = 0;
242
243 if (!_panner) {
244 delete big_window;
245 big_window = 0;
246 return;
247 }
248
249 const float scale = std::max (1.f, UIConfiguration::instance().get_ui_scale());
250
251 if (_current_uri == "http://ardour.org/plugin/panner_2in2out#ui")
252 {
253 delete big_window;
254 big_window = 0;
255
256 boost::shared_ptr<Pannable> pannable = _panner->pannable();
257
258 _stereo_panner = new StereoPanner (_panshell);
259 _stereo_panner->set_size_request (-1, 5 * ceilf(7.f * scale));
260 _stereo_panner->set_send_drawing_mode (_send_mode);
261 pan_vbox.pack_start (*_stereo_panner, false, false);
262
263 boost::shared_ptr<AutomationControl> ac;
264
265 ac = pannable->pan_azimuth_control;
266 _stereo_panner->StartPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
267 boost::weak_ptr<AutomationControl> (ac)));
268 _stereo_panner->StopPositionGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
269 boost::weak_ptr<AutomationControl>(ac)));
270
271 ac = pannable->pan_width_control;
272 _stereo_panner->StartWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
273 boost::weak_ptr<AutomationControl> (ac)));
274 _stereo_panner->StopWidthGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
275 boost::weak_ptr<AutomationControl>(ac)));
276 _stereo_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
277 }
278 else if (_current_uri == "http://ardour.org/plugin/panner_1in2out#ui"
279 || _current_uri == "http://ardour.org/plugin/panner_balance#ui")
280 {
281 delete big_window;
282 big_window = 0;
283 boost::shared_ptr<Pannable> pannable = _panner->pannable();
284 boost::shared_ptr<AutomationControl> ac = pannable->pan_azimuth_control;
285
286 _mono_panner = new MonoPanner (_panshell);
287
288 _mono_panner->StartGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
289 boost::weak_ptr<AutomationControl> (ac)));
290 _mono_panner->StopGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
291 boost::weak_ptr<AutomationControl>(ac)));
292
293 _mono_panner->signal_button_release_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event));
294
295 _mono_panner->set_size_request (-1, 5 * ceilf(7.f * scale));
296 _mono_panner->set_send_drawing_mode (_send_mode);
297
298 update_pan_sensitive ();
299 pan_vbox.pack_start (*_mono_panner, false, false);
300 }
301 else if (_current_uri == "http://ardour.org/plugin/panner_vbap#ui")
302 {
303 if (!twod_panner) {
304 twod_panner = new Panner2d (_panshell, rintf(61.f * scale));
305 twod_panner->set_name ("MixerPanZone");
306 twod_panner->show ();
307 twod_panner->signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_button_event), false);
308 }
309
310 update_pan_sensitive ();
311 twod_panner->reset (nins);
312 if (big_window) {
313 big_window->reset (nins);
314 }
315 twod_panner->set_size_request (-1, rintf(61.f * scale));
316 twod_panner->set_send_drawing_mode (_send_mode);
317
318 /* and finally, add it to the panner frame */
319
320 pan_vbox.pack_start (*twod_panner, false, false);
321 }
322 else
323 {
324 /* stick something into the panning viewport so that it redraws */
325 EventBox* eb = manage (new EventBox());
326 pan_vbox.pack_start (*eb, false, false);
327
328 delete big_window;
329 big_window = 0;
330 }
331
332 pan_vbox.show_all ();
333 }
334
335 void
set_send_drawing_mode(bool onoff)336 PannerUI::set_send_drawing_mode (bool onoff)
337 {
338 if (_stereo_panner) {
339 _stereo_panner->set_send_drawing_mode (onoff);
340 } else if (_mono_panner) {
341 _mono_panner->set_send_drawing_mode (onoff);
342 } else if (twod_panner) {
343 twod_panner->set_send_drawing_mode (onoff);
344 }
345 _send_mode = onoff;
346 }
347
348 void
start_touch(boost::weak_ptr<AutomationControl> wac)349 PannerUI::start_touch (boost::weak_ptr<AutomationControl> wac)
350 {
351 boost::shared_ptr<AutomationControl> ac = wac.lock();
352 if (!ac) {
353 return;
354 }
355 ac->start_touch (ac->session().transport_sample());
356 }
357
358 void
stop_touch(boost::weak_ptr<AutomationControl> wac)359 PannerUI::stop_touch (boost::weak_ptr<AutomationControl> wac)
360 {
361 boost::shared_ptr<AutomationControl> ac = wac.lock();
362 if (!ac) {
363 return;
364 }
365 ac->stop_touch (ac->session().transport_sample());
366 }
367
368 bool
pan_button_event(GdkEventButton * ev)369 PannerUI::pan_button_event (GdkEventButton* ev)
370 {
371 switch (ev->button) {
372 case 1:
373 if (twod_panner && ev->type == GDK_2BUTTON_PRESS) {
374 if (!big_window) {
375 big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
376 }
377 big_window->show ();
378 return true;
379 }
380 break;
381
382 case 3:
383 if (pan_menu == 0) {
384 pan_menu = new Menu;
385 pan_menu->set_name ("ArdourContextMenu");
386 }
387 build_pan_menu ();
388 pan_menu->popup (1, ev->time);
389 return true;
390 break;
391 default:
392 return false;
393 }
394
395 return false; // what's wrong with gcc?
396 }
397
398 void
build_pan_menu()399 PannerUI::build_pan_menu ()
400 {
401 using namespace Menu_Helpers;
402 MenuList& items (pan_menu->items());
403
404 items.clear ();
405
406 items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
407 bypass_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());
408
409 /* set state first, connect second */
410
411 bypass_menu_item->set_active (_panshell->bypassed());
412 bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));
413
414 if (!_panshell->bypassed()) {
415 items.push_back (MenuElem (_("Reset"), sigc::mem_fun (*this, &PannerUI::pan_reset)));
416 items.push_back (MenuElem (_("Edit..."), sigc::mem_fun (*this, &PannerUI::pan_edit)));
417 }
418
419 if (_send_mode) {
420 items.push_back (SeparatorElem());
421 items.push_back (CheckMenuElem (_("Link send and main panner"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
422 send_link_menu_item = static_cast<Gtk::CheckMenuItem*> (&items.back());
423 send_link_menu_item->set_active (_panshell->is_linked_to_route ());
424 send_link_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_link_toggle));
425 } else {
426 send_link_menu_item = NULL;
427 }
428
429 if (_panner_list.size() > 1 && !_panshell->bypassed()) {
430 RadioMenuItem::Group group;
431 items.push_back (SeparatorElem());
432
433 _suspend_menu_callbacks = true;
434 for (std::map<std::string,std::string>::const_iterator p = _panner_list.begin(); p != _panner_list.end(); ++p) {
435 items.push_back (RadioMenuElem (group, p->second,
436 sigc::bind(sigc::mem_fun (*this, &PannerUI::pan_set_custom_type), p->first)));
437 RadioMenuItem* i = dynamic_cast<RadioMenuItem *> (&items.back ());
438 i->set_active (_panshell->current_panner_uri() == p->first);
439 }
440 _suspend_menu_callbacks = false;
441 }
442 }
443
444 void
pan_bypass_toggle()445 PannerUI::pan_bypass_toggle ()
446 {
447 if (bypass_menu_item && (_panshell->bypassed() != bypass_menu_item->get_active())) {
448 _panshell->set_bypassed (!_panshell->bypassed());
449 }
450 }
451
452 void
pan_link_toggle()453 PannerUI::pan_link_toggle ()
454 {
455 if (send_link_menu_item && (_panshell->is_linked_to_route() != send_link_menu_item->get_active())) {
456 _panshell->set_linked_to_route (!_panshell->is_linked_to_route());
457 }
458 }
459
460 void
pan_edit()461 PannerUI::pan_edit ()
462 {
463 if (_panshell->bypassed()) {
464 return;
465 }
466 if (_mono_panner) {
467 _mono_panner->edit ();
468 } else if (_stereo_panner) {
469 _stereo_panner->edit ();
470 } else if (twod_panner) {
471 if (!big_window) {
472 big_window = new Panner2dWindow (_panshell, 400, _panner->in().n_audio());
473 }
474 big_window->show ();
475 }
476 }
477
478 void
pan_reset()479 PannerUI::pan_reset ()
480 {
481 if (_panshell->bypassed()) {
482 return;
483 }
484 _panner->reset ();
485 }
486
487 void
pan_set_custom_type(std::string uri)488 PannerUI::pan_set_custom_type (std::string uri) {
489 if (_suspend_menu_callbacks) return;
490 _panshell->select_panner_by_uri(uri);
491 }
492
493 void
effective_pan_display()494 PannerUI::effective_pan_display ()
495 {
496 if (_stereo_panner) {
497 _stereo_panner->queue_draw ();
498 } else if (_mono_panner) {
499 _mono_panner->queue_draw ();
500 } else if (twod_panner) {
501 twod_panner->queue_draw ();
502 }
503 }
504
505 void
update_pan_sensitive()506 PannerUI::update_pan_sensitive ()
507 {
508 bool const sensitive = !(_panner->pannable()->automation_state() & Play);
509
510 pan_vbox.set_sensitive (sensitive);
511
512 if (big_window) {
513 big_window->set_sensitive (sensitive);
514 }
515 }
516
517 gint
pan_automation_state_button_event(GdkEventButton * ev)518 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
519 {
520 using namespace Menu_Helpers;
521
522 if (ev->type == GDK_BUTTON_RELEASE) {
523 return TRUE;
524 }
525
526 switch (ev->button) {
527 case 1:
528 if (pan_astate_menu == 0) {
529 build_astate_menu ();
530 }
531 pan_astate_menu->popup (1, ev->time);
532 break;
533 default:
534 break;
535 }
536
537 return TRUE;
538 }
539
540 void
pan_automation_state_changed()541 PannerUI::pan_automation_state_changed ()
542 {
543 boost::shared_ptr<Pannable> pannable (_panner->pannable());
544 pan_automation_state_button.set_label (GainMeterBase::short_astate_string(pannable->automation_state()));
545
546 bool x = (pannable->automation_state() != ARDOUR::Off);
547
548 if (pan_automation_state_button.get_active() != x) {
549 pan_automation_state_button.set_active (x);
550 }
551
552 update_pan_sensitive ();
553 }
554
555 void
show_width()556 PannerUI::show_width ()
557 {
558 }
559
560 void
width_adjusted()561 PannerUI::width_adjusted ()
562 {
563 }
564
565 void
show_position()566 PannerUI::show_position ()
567 {
568 }
569
570 void
position_adjusted()571 PannerUI::position_adjusted ()
572 {
573 }
574
575 void
set_available_panners(std::map<std::string,std::string> p)576 PannerUI::set_available_panners(std::map<std::string,std::string> p)
577 {
578 _panner_list = p;
579 }
580