fix import/embed with "sequence files" option
[ardour2.git] / gtk2_ardour / panner_ui.cc
blob1974f72821de57975f93a62cdd3dff7910e88774
1 /*
2 Copyright (C) 2004 Paul Davis
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.
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.
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.
19 #include <limits.h>
21 #include <ardour/io.h>
22 #include <ardour/dB.h>
23 #include <gtkmm2ext/utils.h>
24 #include <gtkmm2ext/stop_signal.h>
25 #include <gtkmm2ext/barcontroller.h>
26 #include <midi++/manager.h>
27 #include <pbd/fastlog.h>
29 #include "ardour_ui.h"
30 #include "panner_ui.h"
31 #include "panner2d.h"
32 #include "utils.h"
33 #include "panner.h"
34 #include "gui_thread.h"
36 #include <ardour/session.h>
37 #include <ardour/panner.h>
38 #include <ardour/route.h>
40 #include "i18n.h"
42 using namespace ARDOUR;
43 using namespace PBD;
44 using namespace Gtkmm2ext;
45 using namespace Gtk;
46 using namespace sigc;
48 const int PannerUI::pan_bar_height = 30;
50 PannerUI::PannerUI (Session& s)
51 : _session (s),
52 hAdjustment(0.0, 0.0, 0.0),
53 vAdjustment(0.0, 0.0, 0.0),
54 panning_viewport(hAdjustment, vAdjustment),
55 panning_up_arrow (Gtk::ARROW_UP, Gtk::SHADOW_OUT),
56 panning_down_arrow (Gtk::ARROW_DOWN, Gtk::SHADOW_OUT),
57 panning_link_button (_("link")),
58 pan_automation_style_button (""),
59 pan_automation_state_button ("")
61 ignore_toggle = false;
62 pan_menu = 0;
63 pan_astate_menu = 0;
64 pan_astyle_menu = 0;
65 in_pan_update = false;
67 pan_automation_style_button.set_name ("MixerAutomationModeButton");
68 pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");
70 ARDOUR_UI::instance()->tooltips().set_tip (pan_automation_state_button, _("Pan automation mode"));
71 ARDOUR_UI::instance()->tooltips().set_tip (pan_automation_style_button, _("Pan automation type"));
73 //set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);
74 //set_size_request_to_display_given_text (pan_automation_style_button, X_("0"), 2, 2);
76 pan_bar_packer.set_size_request (-1, 61);
77 panning_viewport.set_size_request (-1, 61);
78 panning_viewport.set_name (X_("BaseFrame"));
80 ARDOUR_UI::instance()->tooltips().set_tip (panning_link_button,
81 _("panning link control"));
82 ARDOUR_UI::instance()->tooltips().set_tip (panning_link_direction_button,
83 _("panning link direction"));
85 pan_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
86 pan_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
88 pan_automation_style_button.signal_button_press_event().connect (mem_fun(*this, &PannerUI::pan_automation_style_button_event), false);
89 pan_automation_state_button.signal_button_press_event().connect (mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);
91 panning_link_button.set_name (X_("PanningLinkButton"));
92 panning_link_direction_button.set_name (X_("PanningLinkDirectionButton"));
94 panning_link_box.pack_start (panning_link_button, true, true);
95 panning_link_box.pack_start (panning_link_direction_button, true, true);
96 panning_link_box.pack_start (pan_automation_state_button, true, true);
98 /* the pixmap will be reset at some point, but the key thing is that
99 we need a pixmap in the button just to get started.
101 panning_link_direction_button.add (*(manage (new Image (get_xpm("forwardblarrow.xpm")))));
103 panning_link_direction_button.signal_clicked().connect
104 (mem_fun(*this, &PannerUI::panning_link_direction_clicked));
106 panning_link_button.signal_button_press_event().connect
107 (mem_fun(*this, &PannerUI::panning_link_button_press), false);
108 panning_link_button.signal_button_release_event().connect
109 (mem_fun(*this, &PannerUI::panning_link_button_release), false);
111 panning_up.set_border_width (3);
112 panning_down.set_border_width (3);
113 panning_up.add (panning_up_arrow);
114 panning_down.add (panning_down_arrow);
115 panning_up.set_name (X_("PanScrollerBase"));
116 panning_down.set_name (X_("PanScrollerBase"));
117 panning_up_arrow.set_name (X_("PanScrollerArrow"));
118 panning_down_arrow.set_name (X_("PanScrollerArrow"));
120 pan_vbox.set_spacing (2);
121 pan_vbox.pack_start (panning_viewport, Gtk::PACK_SHRINK);
122 pan_vbox.pack_start (panning_link_box, Gtk::PACK_SHRINK);
124 pack_start (pan_vbox, true, true);
126 panner = 0;
128 set_width(Narrow);
131 void
132 PannerUI::set_io (boost::shared_ptr<IO> io)
134 connections.clear ();
136 if (pan_astyle_menu) {
137 delete pan_astyle_menu;
138 pan_astyle_menu = 0;
141 if (pan_astate_menu) {
142 delete pan_astate_menu;
143 pan_astate_menu = 0;
146 _io = io;
148 connections.push_back (_io->panner().Changed.connect (mem_fun(*this, &PannerUI::panner_changed)));
149 connections.push_back (_io->panner().LinkStateChanged.connect (mem_fun(*this, &PannerUI::update_pan_linkage)));
150 connections.push_back (_io->panner().StateChanged.connect (mem_fun(*this, &PannerUI::update_pan_state)));
152 if (panner) {
153 delete panner;
154 panner = 0;
157 setup_pan ();
159 pan_changed (0);
160 update_pan_sensitive ();
161 update_pan_linkage ();
162 pan_automation_state_changed ();
165 void
166 PannerUI::build_astate_menu ()
168 using namespace Menu_Helpers;
170 if (pan_astate_menu == 0) {
171 pan_astate_menu = new Menu;
172 pan_astate_menu->set_name ("ArdourContextMenu");
173 } else {
174 pan_astate_menu->items().clear ();
177 pan_astate_menu->items().push_back (MenuElem (_("Manual"),
178 bind (mem_fun (_io->panner(), &Panner::set_automation_state), (AutoState) Off)));
179 pan_astate_menu->items().push_back (MenuElem (_("Play"),
180 bind (mem_fun (_io->panner(), &Panner::set_automation_state), (AutoState) Play)));
181 pan_astate_menu->items().push_back (MenuElem (_("Write"),
182 bind (mem_fun (_io->panner(), &Panner::set_automation_state), (AutoState) Write)));
183 pan_astate_menu->items().push_back (MenuElem (_("Touch"),
184 bind (mem_fun (_io->panner(), &Panner::set_automation_state), (AutoState) Touch)));
188 void
189 PannerUI::build_astyle_menu ()
191 using namespace Menu_Helpers;
193 if (pan_astyle_menu == 0) {
194 pan_astyle_menu = new Menu;
195 pan_astyle_menu->set_name ("ArdourContextMenu");
196 } else {
197 pan_astyle_menu->items().clear();
200 pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
201 pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
204 PBD::Controllable*
205 PannerUI::get_controllable()
207 if (pan_bars.empty()) {
208 return 0;
211 return pan_bars[0]->get_controllable();
214 bool
215 PannerUI::panning_link_button_press (GdkEventButton* ev)
217 return true;
220 bool
221 PannerUI::panning_link_button_release (GdkEventButton* ev)
223 if (!ignore_toggle) {
224 _io->panner().set_linked (!_io->panner().linked());
226 return true;
229 void
230 PannerUI::panning_link_direction_clicked()
232 switch (_io->panner().link_direction()) {
233 case Panner::SameDirection:
234 _io->panner().set_link_direction (Panner::OppositeDirection);
235 break;
236 default:
237 _io->panner().set_link_direction (Panner::SameDirection);
238 break;
242 void
243 PannerUI::update_pan_linkage ()
245 ENSURE_GUI_THREAD(mem_fun(*this, &PannerUI::update_pan_linkage));
247 bool x = _io->panner().linked();
248 bool bx = panning_link_button.get_active();
250 if (x != bx) {
252 ignore_toggle = true;
253 panning_link_button.set_active (x);
254 ignore_toggle = false;
257 panning_link_direction_button.set_sensitive (x);
259 switch (_io->panner().link_direction()) {
260 case Panner::SameDirection:
261 panning_link_direction_button.set_image (*(manage (new Image (get_xpm ("forwardblarrow.xpm")))));
262 break;
263 default:
264 panning_link_direction_button.set_image (*(manage (new Image (get_xpm("revdblarrow.xpm")))));
265 break;
269 void
270 PannerUI::set_width (Width w)
272 switch (w) {
273 case Wide:
274 panning_link_button.set_label (_("link"));
275 break;
276 case Narrow:
277 panning_link_button.set_label (_("L"));
278 break;
281 _width = w;
285 PannerUI::~PannerUI ()
287 for (vector<Adjustment*>::iterator i = pan_adjustments.begin(); i != pan_adjustments.end(); ++i) {
288 delete (*i);
291 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
292 delete (*i);
295 if (panner) {
296 delete panner;
299 if (pan_menu) {
300 delete pan_menu;
303 if (pan_astyle_menu) {
304 delete pan_astyle_menu;
307 if (pan_astate_menu) {
308 delete pan_astate_menu;
313 void
314 PannerUI::panner_changed ()
316 ENSURE_GUI_THREAD (mem_fun(*this, &PannerUI::panner_changed));
317 setup_pan ();
318 pan_changed (0);
321 void
322 PannerUI::update_pan_state ()
324 /* currently nothing to do */
325 // ENSURE_GUI_THREAD (mem_fun(*this, &PannerUI::update_panner_state));
328 void
329 PannerUI::setup_pan ()
331 uint32_t nouts = _io->n_outputs ();
333 if (nouts == 0 || nouts == 1) {
335 while (!pan_adjustments.empty()) {
336 delete pan_bars.back();
337 pan_bars.pop_back ();
338 delete pan_adjustments.back();
339 pan_adjustments.pop_back ();
342 /* stick something into the panning viewport so that it redraws */
344 EventBox* eb = manage (new EventBox());
345 panning_viewport.remove ();
346 panning_viewport.add (*eb);
347 panning_viewport.show_all ();
349 } else if (nouts == 2) {
351 vector<Adjustment*>::size_type asz;
352 uint32_t npans = _io->panner().size();
354 while (!pan_adjustments.empty()) {
355 delete pan_bars.back();
356 pan_bars.pop_back ();
357 delete pan_adjustments.back();
358 pan_adjustments.pop_back ();
361 while ((asz = pan_adjustments.size()) < npans) {
363 float x, rx;
364 PannerBar* bc;
366 /* initialize adjustment with 0.0 (L) or 1.0 (R) for the first and second panners,
367 which serves as a default, otherwise use current value */
369 _io->panner()[asz]->get_position (rx);
371 if (npans == 1) {
372 x = 0.5;
373 } else if (asz == 0) {
374 x = 0.0;
375 } else if (asz == 1) {
376 x = 1.0;
377 } else {
378 x = rx;
381 pan_adjustments.push_back (new Adjustment (x, 0, 1.0, 0.05, 0.1));
382 bc = new PannerBar (*pan_adjustments[asz], _io->panner()[asz]->control());
384 /* now set adjustment with current value of panner, then connect the signals */
385 pan_adjustments.back()->set_value(rx);
386 pan_adjustments.back()->signal_value_changed().connect (bind (mem_fun(*this, &PannerUI::pan_adjustment_changed), (uint32_t) asz));
388 _io->panner()[asz]->Changed.connect (bind (mem_fun(*this, &PannerUI::pan_value_changed), (uint32_t) asz));
391 bc->set_name ("PanSlider");
392 bc->set_shadow_type (Gtk::SHADOW_NONE);
394 bc->StartGesture.connect (bind (mem_fun (*_io, &IO::start_pan_touch), (uint32_t) asz));
395 bc->StopGesture.connect (bind (mem_fun (*_io, &IO::end_pan_touch), (uint32_t) asz));
397 char buf[64];
398 snprintf (buf, sizeof (buf), _("panner for channel %zu"), asz + 1);
399 ARDOUR_UI::instance()->tooltips().set_tip (bc->event_widget(), buf);
401 bc->event_widget().signal_button_release_event().connect
402 (bind (mem_fun(*this, &PannerUI::pan_button_event), (uint32_t) asz));
404 bc->set_size_request (-1, pan_bar_height);
406 pan_bars.push_back (bc);
407 pan_bar_packer.pack_start (*bc, false, false);
410 /* now that we actually have the pan bars,
411 set their sensitivity based on current
412 automation state.
415 update_pan_sensitive ();
417 panning_viewport.remove ();
418 panning_viewport.add (pan_bar_packer);
419 panning_viewport.show_all ();
421 } else {
423 if (panner == 0) {
424 panner = new Panner2d (_io->panner(), 61);
425 panner->set_name ("MixerPanZone");
426 panner->show ();
429 update_pan_sensitive ();
430 panner->reset (_io->n_inputs());
431 panner->set_size_request (-1, 61);
433 /* and finally, add it to the panner frame */
435 panning_viewport.remove ();
436 panning_viewport.add (*panner);
437 panning_viewport.show_all ();
441 bool
442 PannerUI::pan_button_event (GdkEventButton* ev, uint32_t which)
444 switch (ev->button) {
445 case 3:
446 if (pan_menu == 0) {
447 pan_menu = manage (new Menu);
448 pan_menu->set_name ("ArdourContextMenu");
450 build_pan_menu (which);
451 pan_menu->popup (1, ev->time);
452 return true;
453 break;
454 default:
455 return false;
458 return false; // what's wrong with gcc?
461 void
462 PannerUI::build_pan_menu (uint32_t which)
464 using namespace Menu_Helpers;
465 MenuList& items (pan_menu->items());
467 items.clear ();
469 items.push_back (CheckMenuElem (_("Mute")));
471 /* set state first, connect second */
473 (dynamic_cast<CheckMenuItem*> (&items.back()))->set_active (_io->panner()[which]->muted());
474 (dynamic_cast<CheckMenuItem*> (&items.back()))->signal_toggled().connect
475 (bind (mem_fun(*this, &PannerUI::pan_mute), which));
477 items.push_back (CheckMenuElem (_("Bypass"), mem_fun(*this, &PannerUI::pan_bypass_toggle)));
478 bypass_menu_item = static_cast<CheckMenuItem*> (&items.back());
480 /* set state first, connect second */
482 bypass_menu_item->set_active (_io->panner().bypassed());
483 bypass_menu_item->signal_toggled().connect (mem_fun(*this, &PannerUI::pan_bypass_toggle));
485 items.push_back (MenuElem (_("Reset"), bind (mem_fun(*this, &PannerUI::pan_reset), which)));
486 items.push_back (SeparatorElem());
487 items.push_back (MenuElem (_("Reset all"), mem_fun (*this, &PannerUI::pan_reset_all)));
490 void
491 PannerUI::pan_mute (uint32_t which)
493 StreamPanner* sp = _io->panner()[which];
494 sp->set_muted (!sp->muted());
497 void
498 PannerUI::pan_bypass_toggle ()
500 if (bypass_menu_item && (_io->panner().bypassed() != bypass_menu_item->get_active())) {
501 _io->panner().set_bypassed (!_io->panner().bypassed());
505 void
506 PannerUI::pan_reset (uint32_t which)
508 _io->panner().reset_streampanner (which);
511 void
512 PannerUI::pan_reset_all ()
514 _io->panner().reset_to_default ();
517 void
518 PannerUI::effective_pan_display ()
520 if (_io->panner().empty()) {
521 return;
524 switch (_io->n_outputs()) {
525 case 0:
526 case 1:
527 /* relax */
528 break;
530 case 2:
531 update_pan_bars (true);
532 break;
534 default:
535 //panner->move_puck (pan_value (v, right), 0.5);
536 break;
540 void
541 PannerUI::pan_changed (void *src)
543 if (src == this) {
544 return;
547 switch (_io->panner().size()) {
548 case 0:
549 panning_link_direction_button.set_sensitive (false);
550 panning_link_button.set_sensitive (false);
551 return;
552 case 1:
553 panning_link_direction_button.set_sensitive (false);
554 panning_link_button.set_sensitive (false);
555 break;
556 default:
557 panning_link_direction_button.set_sensitive (true);
558 panning_link_button.set_sensitive (true);
561 uint32_t nouts = _io->n_outputs();
563 switch (nouts) {
564 case 0:
565 case 1:
566 /* relax */
567 break;
569 case 2:
570 /* bring pan bar state up to date */
571 update_pan_bars (false);
572 break;
574 default:
575 // panner->move_puck (pan_value (pans[0], pans[1]), 0.5);
576 break;
580 void
581 PannerUI::pan_adjustment_changed (uint32_t which)
583 if (!in_pan_update && which < _io->panner().size()) {
585 float xpos;
586 float val = pan_adjustments[which]->get_value ();
587 _io->panner()[which]->get_position (xpos);
589 /* add a kinda-sorta detent for the middle */
591 if (val != 0.5 && Panner::equivalent (val, 0.5)) {
592 /* this is going to be reentrant, so just
593 return after it.
596 in_pan_update = true;
597 pan_adjustments[which]->set_value (0.5);
598 in_pan_update = false;
599 return;
602 if (!Panner::equivalent (val, xpos)) {
604 _io->panner()[which]->set_position (val);
605 /* XXX
606 the panner objects have no access to the session,
607 so do this here. ick.
609 _session.set_dirty();
614 void
615 PannerUI::pan_value_changed (uint32_t which)
617 ENSURE_GUI_THREAD (bind (mem_fun(*this, &PannerUI::pan_value_changed), which));
619 if (_io->n_outputs() > 1 && which < _io->panner().size()) {
620 float xpos;
621 float val = pan_adjustments[which]->get_value ();
623 _io->panner()[which]->get_position (xpos);
625 if (!Panner::equivalent (val, xpos)) {
626 in_pan_update = true;
627 pan_adjustments[which]->set_value (xpos);
628 in_pan_update = false;
633 void
634 PannerUI::update_pan_bars (bool only_if_aplay)
636 uint32_t n;
637 vector<Adjustment*>::iterator i;
639 in_pan_update = true;
641 /* this runs during automation playback, and moves the bar controllers
642 and/or pucks around.
645 for (i = pan_adjustments.begin(), n = 0; i != pan_adjustments.end(); ++i, ++n) {
646 float xpos, val;
648 if (only_if_aplay) {
649 AutomationList& alist (_io->panner()[n]->automation());
651 if (!alist.automation_playback()) {
652 continue;
656 _io->panner()[n]->get_effective_position (xpos);
657 val = (*i)->get_value ();
659 if (!Panner::equivalent (val, xpos)) {
660 (*i)->set_value (xpos);
664 in_pan_update = false;
667 void
668 PannerUI::pan_printer (char *buf, uint32_t len, Adjustment* adj)
670 float val = adj->get_value();
672 if (val == 0.0f) {
673 snprintf (buf, len, X_("L"));
674 } else if (val == 1.0f) {
675 snprintf (buf, len, X_("R"));
676 } else if (Panner::equivalent (val, 0.5f)) {
677 snprintf (buf, len, X_("C"));
678 } else {
679 /* don't print anything */
680 buf[0] = '\0';
684 void
685 PannerUI::update_pan_sensitive ()
687 bool sensitive = !(_io->panner().automation_state() & Play);
689 switch (_io->n_outputs()) {
690 case 0:
691 case 1:
692 break;
693 case 2:
694 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
695 (*i)->set_sensitive (sensitive);
697 break;
698 default:
699 if (panner) {
700 panner->set_sensitive (sensitive);
702 break;
706 gint
707 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
709 using namespace Menu_Helpers;
711 if (ev->type == GDK_BUTTON_RELEASE) {
712 return TRUE;
715 switch (ev->button) {
716 case 1:
717 if (pan_astate_menu == 0) {
718 build_astate_menu ();
720 pan_astate_menu->popup (1, ev->time);
721 break;
722 default:
723 break;
726 return TRUE;
729 gint
730 PannerUI::pan_automation_style_button_event (GdkEventButton *ev)
732 if (ev->type == GDK_BUTTON_RELEASE) {
733 return TRUE;
736 switch (ev->button) {
737 case 1:
738 if (pan_astyle_menu == 0) {
739 build_astyle_menu ();
741 pan_astyle_menu->popup (1, ev->time);
742 break;
743 default:
744 break;
746 return TRUE;
749 void
750 PannerUI::pan_automation_style_changed ()
752 ENSURE_GUI_THREAD(mem_fun(*this, &PannerUI::pan_automation_style_changed));
754 switch (_width) {
755 case Wide:
756 pan_automation_style_button.set_label (astyle_string(_io->panner().automation_style()));
757 break;
758 case Narrow:
759 pan_automation_style_button.set_label (short_astyle_string(_io->panner().automation_style()));
760 break;
764 void
765 PannerUI::pan_automation_state_changed ()
767 ENSURE_GUI_THREAD(mem_fun(*this, &PannerUI::pan_automation_state_changed));
769 bool x;
771 switch (_width) {
772 case Wide:
773 pan_automation_state_button.set_label (astate_string(_io->panner().automation_state()));
774 break;
775 case Narrow:
776 pan_automation_state_button.set_label (short_astate_string(_io->panner().automation_state()));
777 break;
780 /* when creating a new session, we get to create busses (and
781 sometimes tracks) with no outputs by the time they get
782 here.
785 if (_io->panner().empty()) {
786 return;
789 x = (_io->panner().front()->automation().automation_state() != Off);
791 if (pan_automation_state_button.get_active() != x) {
792 ignore_toggle = true;
793 pan_automation_state_button.set_active (x);
794 ignore_toggle = false;
797 update_pan_sensitive ();
799 /* start watching automation so that things move */
801 pan_watching.disconnect();
803 if (x) {
804 pan_watching = ARDOUR_UI::RapidScreenUpdate.connect (mem_fun (*this, &PannerUI::effective_pan_display));
808 string
809 PannerUI::astate_string (AutoState state)
811 return _astate_string (state, false);
814 string
815 PannerUI::short_astate_string (AutoState state)
817 return _astate_string (state, true);
820 string
821 PannerUI::_astate_string (AutoState state, bool shrt)
823 string sstr;
825 switch (state) {
826 case Off:
827 sstr = (shrt ? "M" : _("M"));
828 break;
829 case Play:
830 sstr = (shrt ? "P" : _("P"));
831 break;
832 case Touch:
833 sstr = (shrt ? "T" : _("T"));
834 break;
835 case Write:
836 sstr = (shrt ? "W" : _("W"));
837 break;
840 return sstr;
843 string
844 PannerUI::astyle_string (AutoStyle style)
846 return _astyle_string (style, false);
849 string
850 PannerUI::short_astyle_string (AutoStyle style)
852 return _astyle_string (style, true);
855 string
856 PannerUI::_astyle_string (AutoStyle style, bool shrt)
858 if (style & Trim) {
859 return _("Trim");
860 } else {
861 /* XXX it might different in different languages */
863 return (shrt ? _("Abs") : _("Abs"));