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.
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"
34 #include "gui_thread.h"
36 #include "ardour/delivery.h"
37 #include "ardour/session.h"
38 #include "ardour/panner.h"
39 #include "ardour/route.h"
44 using namespace ARDOUR;
46 using namespace Gtkmm2ext;
49 const int PannerUI::pan_bar_height = 30;
51 PannerUI::PannerUI (Session* s)
54 , hAdjustment(0.0, 0.0, 0.0)
55 , vAdjustment(0.0, 0.0, 0.0)
56 , panning_viewport(hAdjustment, vAdjustment)
57 , panning_up_arrow (Gtk::ARROW_UP, Gtk::SHADOW_OUT)
58 , panning_down_arrow (Gtk::ARROW_DOWN, Gtk::SHADOW_OUT)
59 , panning_link_button (_("link"))
60 , pan_automation_style_button ("")
61 , pan_automation_state_button ("")
65 ignore_toggle = false;
69 in_pan_update = false;
71 pan_automation_style_button.set_name ("MixerAutomationModeButton");
72 pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");
74 ARDOUR_UI::instance()->set_tip (pan_automation_state_button, _("Pan automation mode"));
75 ARDOUR_UI::instance()->set_tip (pan_automation_style_button, _("Pan automation type"));
77 //set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);
78 //set_size_request_to_display_given_text (pan_automation_style_button, X_("0"), 2, 2);
80 panning_viewport.set_name (X_("BaseFrame"));
82 ARDOUR_UI::instance()->set_tip (panning_link_button,
83 _("panning link control"));
84 ARDOUR_UI::instance()->set_tip (panning_link_direction_button,
85 _("panning link direction"));
87 pan_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
88 pan_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
90 pan_automation_style_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_style_button_event), false);
91 pan_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);
93 panning_link_button.set_name (X_("PanningLinkButton"));
94 panning_link_direction_button.set_name (X_("PanningLinkDirectionButton"));
96 panning_link_box.pack_start (panning_link_button, true, true);
97 panning_link_box.pack_start (panning_link_direction_button, true, true);
98 panning_link_box.pack_start (pan_automation_state_button, true, true);
100 /* the pixmap will be reset at some point, but the key thing is that
101 we need a pixmap in the button just to get started.
103 panning_link_direction_button.add (*(manage (new Image (get_xpm("forwardblarrow.xpm")))));
105 panning_link_direction_button.signal_clicked().connect
106 (sigc::mem_fun(*this, &PannerUI::panning_link_direction_clicked));
108 panning_link_button.signal_button_press_event().connect
109 (sigc::mem_fun(*this, &PannerUI::panning_link_button_press), false);
110 panning_link_button.signal_button_release_event().connect
111 (sigc::mem_fun(*this, &PannerUI::panning_link_button_release), false);
113 panning_up.set_border_width (3);
114 panning_down.set_border_width (3);
115 panning_up.add (panning_up_arrow);
116 panning_down.add (panning_down_arrow);
117 panning_up.set_name (X_("PanScrollerBase"));
118 panning_down.set_name (X_("PanScrollerBase"));
119 panning_up_arrow.set_name (X_("PanScrollerArrow"));
120 panning_down_arrow.set_name (X_("PanScrollerArrow"));
122 pan_vbox.set_spacing (2);
123 pan_vbox.pack_start (panning_viewport, Gtk::PACK_SHRINK);
124 pan_vbox.pack_start (panning_link_box, Gtk::PACK_SHRINK);
126 pack_start (pan_vbox, true, true);
135 PannerUI::set_panner (boost::shared_ptr<Panner> p)
137 connections.drop_connections ();
139 delete pan_astyle_menu;
142 delete pan_astate_menu;
154 _panner->Changed.connect (connections, boost::bind (&PannerUI::panner_changed, this), gui_context());
155 _panner->LinkStateChanged.connect (connections, boost::bind (&PannerUI::update_pan_linkage, this), gui_context());
156 _panner->StateChanged.connect (connections, boost::bind (&PannerUI::update_pan_state, this), gui_context());
161 update_pan_sensitive ();
162 update_pan_linkage ();
163 pan_automation_state_changed ();
165 #if WHERE_DOES_THIS_LIVE
166 pan_bar_packer.show();
167 panning_viewport.show();
169 panning_up_arrow.show();
171 panning_down_arrow.show();
173 panning_link_button.show();
174 panning_link_direction_button.show();
175 panning_link_box.show();
176 pan_automation_style_button.show();
177 pan_automation_state_button.show();
183 PannerUI::build_astate_menu ()
185 using namespace Menu_Helpers;
187 if (pan_astate_menu == 0) {
188 pan_astate_menu = new Menu;
189 pan_astate_menu->set_name ("ArdourContextMenu");
191 pan_astate_menu->items().clear ();
194 pan_astate_menu->items().push_back (MenuElem (_("Manual"), sigc::bind (
195 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
197 pan_astate_menu->items().push_back (MenuElem (_("Play"), sigc::bind (
198 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
200 pan_astate_menu->items().push_back (MenuElem (_("Write"), sigc::bind (
201 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
202 (AutoState) Write)));
203 pan_astate_menu->items().push_back (MenuElem (_("Touch"), sigc::bind (
204 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
205 (AutoState) Touch)));
210 PannerUI::build_astyle_menu ()
212 using namespace Menu_Helpers;
214 if (pan_astyle_menu == 0) {
215 pan_astyle_menu = new Menu;
216 pan_astyle_menu->set_name ("ArdourContextMenu");
218 pan_astyle_menu->items().clear();
221 pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
222 pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
225 boost::shared_ptr<PBD::Controllable>
226 PannerUI::get_controllable()
228 return pan_bars[0]->get_controllable();
232 PannerUI::panning_link_button_press (GdkEventButton*)
238 PannerUI::panning_link_button_release (GdkEventButton*)
240 if (!ignore_toggle) {
241 _panner->set_linked (!_panner->linked());
247 PannerUI::panning_link_direction_clicked()
249 switch (_panner->link_direction()) {
250 case Panner::SameDirection:
251 _panner->set_link_direction (Panner::OppositeDirection);
254 _panner->set_link_direction (Panner::SameDirection);
260 PannerUI::update_pan_linkage ()
262 ENSURE_GUI_THREAD (*this, &PannerUI::update_pan_linkage)
264 bool x = _panner->linked();
265 bool bx = panning_link_button.get_active();
269 ignore_toggle = true;
270 panning_link_button.set_active (x);
271 ignore_toggle = false;
274 panning_link_direction_button.set_sensitive (x);
276 switch (_panner->link_direction()) {
277 case Panner::SameDirection:
278 panning_link_direction_button.set_image (*(manage (new Image (get_xpm ("forwardblarrow.xpm")))));
281 panning_link_direction_button.set_image (*(manage (new Image (get_xpm("revdblarrow.xpm")))));
287 PannerUI::set_width (Width w)
291 panning_link_button.set_label (_("link"));
294 panning_link_button.set_label (_("L"));
302 PannerUI::~PannerUI ()
304 for (vector<Adjustment*>::iterator i = pan_adjustments.begin(); i != pan_adjustments.end(); ++i) {
308 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
315 delete pan_astyle_menu;
316 delete pan_astate_menu;
321 PannerUI::panner_changed ()
323 ENSURE_GUI_THREAD (*this, &PannerUI::panner_changed)
329 PannerUI::update_pan_state ()
331 /* currently nothing to do */
332 // ENSURE_GUI_THREAD (*this, &PannerUI::update_panner_state)
336 PannerUI::setup_pan ()
342 uint32_t const nouts = _panner->nouts();
343 uint32_t const npans = _panner->npanners();
345 if (int32_t (nouts) == _current_nouts && int32_t (npans) == _current_npans) {
349 _current_nouts = nouts;
350 _current_npans = npans;
352 if (nouts == 0 || nouts == 1) {
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 ();
364 /* stick something into the panning viewport so that it redraws */
366 EventBox* eb = manage (new EventBox());
367 panning_viewport.remove ();
368 panning_viewport.add (*eb);
369 panning_viewport.show_all ();
371 } else if (nouts == 2) {
373 vector<Adjustment*>::size_type asz;
375 while (!pan_adjustments.empty()) {
376 delete pan_bars.back();
377 pan_bars.pop_back ();
378 delete pan_adjustments.back();
379 pan_adjustments.pop_back ();
385 while ((asz = pan_adjustments.size()) < npans) {
390 /* initialize adjustment with 0.0 (L) or 1.0 (R) for the first and second panners,
391 which serves as a default, otherwise use current value */
393 rx = _panner->pan_control( asz)->get_value();
397 } else if (asz == 0) {
399 } else if (asz == 1) {
405 pan_adjustments.push_back (new Adjustment (x, 0, 1.0, 0.005, 0.05));
406 bc = new PannerBar (*pan_adjustments[asz],
407 boost::static_pointer_cast<PBD::Controllable>( _panner->pan_control( asz )) );
409 /* now set adjustment with current value of panner, then connect the signals */
410 pan_adjustments.back()->set_value(rx);
411 pan_adjustments.back()->signal_value_changed().connect (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_adjustment_changed), (uint32_t) asz));
413 _panner->pan_control( asz )->Changed.connect (connections, boost::bind (&PannerUI::pan_value_changed, this, (uint32_t) asz), gui_context());
415 bc->set_name ("PanSlider");
416 bc->set_shadow_type (Gtk::SHADOW_NONE);
418 boost::shared_ptr<AutomationControl> ac = _panner->pan_control (asz);
421 bc->StartGesture.connect (sigc::mem_fun (*ac, &AutomationControl::start_touch));
422 bc->StopGesture.connect (sigc::mem_fun (*ac, &AutomationControl::stop_touch));
426 snprintf (buf, sizeof (buf), _("panner for channel %zu"), asz + 1);
427 ARDOUR_UI::instance()->set_tip (bc->event_widget(), buf);
429 bc->event_widget().signal_button_release_event().connect
430 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_button_event), (uint32_t) asz));
432 bc->set_size_request (-1, pan_bar_height);
434 pan_bars.push_back (bc);
435 pan_bar_packer.pack_start (*bc, false, false);
438 /* now that we actually have the pan bars,
439 set their sensitivity based on current
443 update_pan_sensitive ();
445 panning_viewport.remove ();
446 panning_viewport.add (pan_bar_packer);
447 panning_viewport.show_all ();
452 panner = new Panner2d (_panner, 61);
453 panner->set_name ("MixerPanZone");
456 panner->signal_button_press_event().connect
457 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_button_event), (uint32_t) 0), false);
460 update_pan_sensitive ();
461 panner->reset (npans);
463 big_window->reset (npans);
465 panner->set_size_request (-1, 61);
467 /* and finally, add it to the panner frame */
469 panning_viewport.remove ();
470 panning_viewport.add (*panner);
471 panning_viewport.show_all ();
476 PannerUI::pan_button_event (GdkEventButton* ev, uint32_t which)
478 switch (ev->button) {
480 if (panner && ev->type == GDK_2BUTTON_PRESS) {
482 big_window = new Panner2dWindow (_panner, 400, _panner->npanners());
491 pan_menu = manage (new Menu);
492 pan_menu->set_name ("ArdourContextMenu");
494 build_pan_menu (which);
495 pan_menu->popup (1, ev->time);
502 return false; // what's wrong with gcc?
506 PannerUI::build_pan_menu (uint32_t which)
508 using namespace Menu_Helpers;
509 MenuList& items (pan_menu->items());
513 items.push_back (CheckMenuElem (_("Mute")));
515 /* set state first, connect second */
517 (dynamic_cast<CheckMenuItem*> (&items.back()))->set_active (_panner->streampanner(which).muted());
518 (dynamic_cast<CheckMenuItem*> (&items.back()))->signal_toggled().connect
519 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_mute), which));
521 items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
522 bypass_menu_item = static_cast<CheckMenuItem*> (&items.back());
524 /* set state first, connect second */
526 bypass_menu_item->set_active (_panner->bypassed());
527 bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));
529 items.push_back (MenuElem (_("Reset"), sigc::bind (sigc::mem_fun (*this, &PannerUI::pan_reset), which)));
530 items.push_back (SeparatorElem());
531 items.push_back (MenuElem (_("Reset all"), sigc::mem_fun (*this, &PannerUI::pan_reset_all)));
535 PannerUI::pan_mute (uint32_t which)
537 StreamPanner& sp = _panner->streampanner(which);
538 sp.set_muted (!sp.muted());
542 PannerUI::pan_bypass_toggle ()
544 if (bypass_menu_item && (_panner->bypassed() != bypass_menu_item->get_active())) {
545 _panner->set_bypassed (!_panner->bypassed());
550 PannerUI::pan_reset (uint32_t which)
552 _panner->reset_streampanner (which);
556 PannerUI::pan_reset_all ()
558 _panner->reset_to_default ();
562 PannerUI::effective_pan_display ()
564 if (_panner->empty()) {
568 switch (_panner->nouts()) {
575 update_pan_bars (true);
579 //panner->move_puck (pan_value (v, right), 0.5);
585 PannerUI::pan_changed (void *src)
591 switch (_panner->npanners()) {
593 panning_link_direction_button.set_sensitive (false);
594 panning_link_button.set_sensitive (false);
597 panning_link_direction_button.set_sensitive (false);
598 panning_link_button.set_sensitive (false);
601 panning_link_direction_button.set_sensitive (true);
602 panning_link_button.set_sensitive (true);
605 uint32_t nouts = _panner->nouts();
614 /* bring pan bar state up to date */
615 update_pan_bars (false);
619 // panner->move_puck (pan_value (pans[0], pans[1]), 0.5);
625 PannerUI::pan_adjustment_changed (uint32_t which)
627 if (!in_pan_update && which < _panner->npanners()) {
629 float val = pan_adjustments[which]->get_value ();
630 float const xpos = _panner->pan_control(which)->get_value();
632 /* add a kinda-sorta detent for the middle */
634 if (val != 0.5 && Panner::equivalent (val, 0.5)) {
635 /* this is going to be reentrant, so just
639 in_pan_update = true;
640 pan_adjustments[which]->set_value (0.5);
641 in_pan_update = false;
645 if (!Panner::equivalent (val, xpos)) {
647 _panner->pan_control(which)->set_value (val);
649 the panner objects have no access to the session,
650 so do this here. ick.
652 _session->set_dirty();
658 PannerUI::pan_value_changed (uint32_t which)
660 ENSURE_GUI_THREAD (*this, &PannerUI::pan_value_changed, which)
662 if (_panner->npanners() > 1 && which < _panner->npanners()) {
664 float val = pan_adjustments[which]->get_value ();
666 _panner->streampanner(which).get_position (xpos);
668 if (!Panner::equivalent (val, xpos)) {
669 in_pan_update = true;
670 pan_adjustments[which]->set_value (xpos);
671 in_pan_update = false;
677 PannerUI::update_pan_bars (bool only_if_aplay)
680 vector<Adjustment*>::iterator i;
682 in_pan_update = true;
684 /* this runs during automation playback, and moves the bar controllers
688 for (i = pan_adjustments.begin(), n = 0; i != pan_adjustments.end(); ++i, ++n) {
692 boost::shared_ptr<AutomationList> alist (_panner->streampanner(n).pan_control()->alist());
694 if (!alist->automation_playback()) {
699 _panner->streampanner(n).get_effective_position (xpos);
700 val = (*i)->get_value ();
702 if (!Panner::equivalent (val, xpos)) {
703 (*i)->set_value (xpos);
707 in_pan_update = false;
711 PannerUI::update_pan_sensitive ()
713 bool const sensitive = !(_panner->mono()) && !(_panner->automation_state() & Play);
715 switch (_panner->nouts()) {
720 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
721 (*i)->set_sensitive (sensitive);
726 panner->set_sensitive (sensitive);
729 big_window->set_sensitive (sensitive);
736 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
738 using namespace Menu_Helpers;
740 if (ev->type == GDK_BUTTON_RELEASE) {
744 switch (ev->button) {
746 if (pan_astate_menu == 0) {
747 build_astate_menu ();
749 pan_astate_menu->popup (1, ev->time);
759 PannerUI::pan_automation_style_button_event (GdkEventButton *ev)
761 if (ev->type == GDK_BUTTON_RELEASE) {
765 switch (ev->button) {
767 if (pan_astyle_menu == 0) {
768 build_astyle_menu ();
770 pan_astyle_menu->popup (1, ev->time);
779 PannerUI::pan_automation_style_changed ()
781 ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_style_changed)
785 pan_automation_style_button.set_label (astyle_string(_panner->automation_style()));
788 pan_automation_style_button.set_label (short_astyle_string(_panner->automation_style()));
794 PannerUI::pan_automation_state_changed ()
796 ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_state_changed)
802 pan_automation_state_button.set_label (astate_string(_panner->automation_state()));
805 pan_automation_state_button.set_label (short_astate_string(_panner->automation_state()));
809 /* when creating a new session, we get to create busses (and
810 sometimes tracks) with no outputs by the time they get
814 if (_panner->empty()) {
818 x = (_panner->streampanner(0).pan_control()->alist()->automation_state() != Off);
820 if (pan_automation_state_button.get_active() != x) {
821 ignore_toggle = true;
822 pan_automation_state_button.set_active (x);
823 ignore_toggle = false;
826 update_pan_sensitive ();
828 /* start watching automation so that things move */
830 pan_watching.disconnect();
833 pan_watching = ARDOUR_UI::RapidScreenUpdate.connect (sigc::mem_fun (*this, &PannerUI::effective_pan_display));
838 PannerUI::astate_string (AutoState state)
840 return _astate_string (state, false);
844 PannerUI::short_astate_string (AutoState state)
846 return _astate_string (state, true);
850 PannerUI::_astate_string (AutoState state, bool shrt)
856 sstr = (shrt ? "M" : _("M"));
859 sstr = (shrt ? "P" : _("P"));
862 sstr = (shrt ? "T" : _("T"));
865 sstr = (shrt ? "W" : _("W"));
873 PannerUI::astyle_string (AutoStyle style)
875 return _astyle_string (style, false);
879 PannerUI::short_astyle_string (AutoStyle style)
881 return _astyle_string (style, true);
885 PannerUI::_astyle_string (AutoStyle style, bool shrt)
890 /* XXX it might different in different languages */
892 return (shrt ? _("Abs") : _("Abs"));
897 PannerUI::set_mono (bool yn)
899 _panner->set_mono (yn);
900 update_pan_sensitive ();