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/barcontroller.h>
25 #include "midi++/manager.h"
26 #include "pbd/fastlog.h"
28 #include "ardour_ui.h"
29 #include "panner_ui.h"
33 #include "gui_thread.h"
35 #include "ardour/delivery.h"
36 #include "ardour/session.h"
37 #include "ardour/panner.h"
38 #include "ardour/route.h"
43 using namespace ARDOUR;
45 using namespace Gtkmm2ext;
48 const int PannerUI::pan_bar_height = 30;
50 PannerUI::PannerUI (Session* s)
53 , hAdjustment(0.0, 0.0, 0.0)
54 , vAdjustment(0.0, 0.0, 0.0)
55 , panning_viewport(hAdjustment, vAdjustment)
56 , panning_up_arrow (Gtk::ARROW_UP, Gtk::SHADOW_OUT)
57 , panning_down_arrow (Gtk::ARROW_DOWN, Gtk::SHADOW_OUT)
58 , panning_link_button (_("link"))
59 , pan_automation_style_button ("")
60 , pan_automation_state_button ("")
64 ignore_toggle = false;
68 in_pan_update = false;
70 pan_automation_style_button.set_name ("MixerAutomationModeButton");
71 pan_automation_state_button.set_name ("MixerAutomationPlaybackButton");
73 ARDOUR_UI::instance()->set_tip (pan_automation_state_button, _("Pan automation mode"));
74 ARDOUR_UI::instance()->set_tip (pan_automation_style_button, _("Pan automation type"));
76 //set_size_request_to_display_given_text (pan_automation_state_button, X_("O"), 2, 2);
77 //set_size_request_to_display_given_text (pan_automation_style_button, X_("0"), 2, 2);
79 panning_viewport.set_name (X_("BaseFrame"));
81 ARDOUR_UI::instance()->set_tip (panning_link_button,
82 _("panning link control"));
83 ARDOUR_UI::instance()->set_tip (panning_link_direction_button,
84 _("panning link direction"));
86 pan_automation_style_button.unset_flags (Gtk::CAN_FOCUS);
87 pan_automation_state_button.unset_flags (Gtk::CAN_FOCUS);
89 pan_automation_style_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_style_button_event), false);
90 pan_automation_state_button.signal_button_press_event().connect (sigc::mem_fun(*this, &PannerUI::pan_automation_state_button_event), false);
92 panning_link_button.set_name (X_("PanningLinkButton"));
93 panning_link_direction_button.set_name (X_("PanningLinkDirectionButton"));
95 panning_link_box.pack_start (panning_link_button, true, true);
96 panning_link_box.pack_start (panning_link_direction_button, true, true);
97 panning_link_box.pack_start (pan_automation_state_button, true, true);
99 /* the pixmap will be reset at some point, but the key thing is that
100 we need a pixmap in the button just to get started.
102 panning_link_direction_button.add (*(manage (new Image (get_xpm("forwardblarrow.xpm")))));
104 panning_link_direction_button.signal_clicked().connect
105 (sigc::mem_fun(*this, &PannerUI::panning_link_direction_clicked));
107 panning_link_button.signal_button_press_event().connect
108 (sigc::mem_fun(*this, &PannerUI::panning_link_button_press), false);
109 panning_link_button.signal_button_release_event().connect
110 (sigc::mem_fun(*this, &PannerUI::panning_link_button_release), false);
112 panning_up.set_border_width (3);
113 panning_down.set_border_width (3);
114 panning_up.add (panning_up_arrow);
115 panning_down.add (panning_down_arrow);
116 panning_up.set_name (X_("PanScrollerBase"));
117 panning_down.set_name (X_("PanScrollerBase"));
118 panning_up_arrow.set_name (X_("PanScrollerArrow"));
119 panning_down_arrow.set_name (X_("PanScrollerArrow"));
121 pan_vbox.set_spacing (2);
122 pan_vbox.pack_start (panning_viewport, Gtk::PACK_SHRINK);
123 pan_vbox.pack_start (panning_link_box, Gtk::PACK_SHRINK);
125 pack_start (pan_vbox, true, true);
134 PannerUI::set_panner (boost::shared_ptr<Panner> p)
136 connections.drop_connections ();
138 delete pan_astyle_menu;
141 delete pan_astate_menu;
153 _panner->Changed.connect (connections, invalidator (*this), boost::bind (&PannerUI::panner_changed, this), gui_context());
154 _panner->LinkStateChanged.connect (connections, invalidator (*this), boost::bind (&PannerUI::update_pan_linkage, this), gui_context());
155 _panner->StateChanged.connect (connections, invalidator (*this), boost::bind (&PannerUI::update_pan_state, this), gui_context());
160 update_pan_sensitive ();
161 update_pan_linkage ();
162 pan_automation_state_changed ();
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");
174 pan_astate_menu->items().clear ();
177 pan_astate_menu->items().push_back (MenuElem (_("Manual"), sigc::bind (
178 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
180 pan_astate_menu->items().push_back (MenuElem (_("Play"), sigc::bind (
181 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
183 pan_astate_menu->items().push_back (MenuElem (_("Write"), sigc::bind (
184 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
185 (AutoState) Write)));
186 pan_astate_menu->items().push_back (MenuElem (_("Touch"), sigc::bind (
187 sigc::mem_fun (_panner.get(), &Panner::set_automation_state),
188 (AutoState) Touch)));
193 PannerUI::build_astyle_menu ()
195 using namespace Menu_Helpers;
197 if (pan_astyle_menu == 0) {
198 pan_astyle_menu = new Menu;
199 pan_astyle_menu->set_name ("ArdourContextMenu");
201 pan_astyle_menu->items().clear();
204 pan_astyle_menu->items().push_back (MenuElem (_("Trim")));
205 pan_astyle_menu->items().push_back (MenuElem (_("Abs")));
208 boost::shared_ptr<PBD::Controllable>
209 PannerUI::get_controllable()
211 return pan_bars[0]->get_controllable();
215 PannerUI::panning_link_button_press (GdkEventButton*)
221 PannerUI::panning_link_button_release (GdkEventButton*)
223 if (!ignore_toggle) {
224 _panner->set_linked (!_panner->linked());
230 PannerUI::panning_link_direction_clicked()
232 switch (_panner->link_direction()) {
233 case Panner::SameDirection:
234 _panner->set_link_direction (Panner::OppositeDirection);
237 _panner->set_link_direction (Panner::SameDirection);
243 PannerUI::update_pan_linkage ()
245 ENSURE_GUI_THREAD (*this, &PannerUI::update_pan_linkage)
247 bool const x = _panner->linked();
248 bool const bx = panning_link_button.get_active();
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 (_panner->link_direction()) {
260 case Panner::SameDirection:
261 panning_link_direction_button.set_image (*(manage (new Image (get_xpm ("forwardblarrow.xpm")))));
264 panning_link_direction_button.set_image (*(manage (new Image (get_xpm("revdblarrow.xpm")))));
270 PannerUI::set_width (Width w)
274 panning_link_button.set_label (_("link"));
277 panning_link_button.set_label (_("L"));
285 PannerUI::~PannerUI ()
287 for (vector<Adjustment*>::iterator i = pan_adjustments.begin(); i != pan_adjustments.end(); ++i) {
291 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
298 delete pan_astyle_menu;
299 delete pan_astate_menu;
304 PannerUI::panner_changed ()
306 ENSURE_GUI_THREAD (*this, &PannerUI::panner_changed)
312 PannerUI::update_pan_state ()
314 /* currently nothing to do */
315 // ENSURE_GUI_THREAD (*this, &PannerUI::update_panner_state)
319 PannerUI::setup_pan ()
325 uint32_t const nouts = _panner->nouts();
326 uint32_t const npans = _panner->npanners();
328 if (int32_t (nouts) == _current_nouts && int32_t (npans) == _current_npans) {
332 _pan_control_connections.drop_connections ();
333 for (uint32_t i = 0; i < _panner->npanners(); ++i) {
334 connect_to_pan_control (i);
337 _current_nouts = nouts;
338 _current_npans = npans;
340 if (nouts == 0 || nouts == 1) {
342 while (!pan_adjustments.empty()) {
343 delete pan_bars.back();
344 pan_bars.pop_back ();
345 delete pan_adjustments.back();
346 pan_adjustments.pop_back ();
352 /* stick something into the panning viewport so that it redraws */
354 EventBox* eb = manage (new EventBox());
355 panning_viewport.remove ();
356 panning_viewport.add (*eb);
357 panning_viewport.show_all ();
359 } else if (nouts == 2) {
361 vector<Adjustment*>::size_type asz;
363 while (!pan_adjustments.empty()) {
364 delete pan_bars.back();
365 pan_bars.pop_back ();
366 delete pan_adjustments.back();
367 pan_adjustments.pop_back ();
373 while ((asz = pan_adjustments.size()) < npans) {
378 /* initialize adjustment with 0.0 (L) or 1.0 (R) for the first and second panners,
379 which serves as a default, otherwise use current value */
381 rx = _panner->pan_control( asz)->get_value();
385 } else if (asz == 0) {
387 } else if (asz == 1) {
393 pan_adjustments.push_back (new Adjustment (x, 0, 1.0, 0.005, 0.05));
394 bc = new PannerBar (*pan_adjustments[asz],
395 boost::static_pointer_cast<PBD::Controllable>( _panner->pan_control( asz )) );
397 /* now set adjustment with current value of panner, then connect the signals */
398 pan_adjustments.back()->set_value(rx);
399 pan_adjustments.back()->signal_value_changed().connect (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_adjustment_changed), (uint32_t) asz));
400 connect_to_pan_control (asz);
402 bc->set_name ("PanSlider");
403 bc->set_shadow_type (Gtk::SHADOW_NONE);
405 boost::shared_ptr<AutomationControl> ac = _panner->pan_control (asz);
408 bc->StartGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::start_touch),
409 boost::weak_ptr<AutomationControl> (ac)));
410 bc->StopGesture.connect (sigc::bind (sigc::mem_fun (*this, &PannerUI::stop_touch),
411 boost::weak_ptr<AutomationControl>(ac)));
415 snprintf (buf, sizeof (buf), _("panner for channel %zu"), asz + 1);
416 ARDOUR_UI::instance()->set_tip (bc->event_widget(), buf);
418 bc->event_widget().signal_button_release_event().connect
419 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_button_event), (uint32_t) asz));
421 bc->set_size_request (-1, pan_bar_height);
423 pan_bars.push_back (bc);
424 pan_bar_packer.pack_start (*bc, false, false);
427 /* now that we actually have the pan bars,
428 set their sensitivity based on current
432 update_pan_sensitive ();
434 panning_viewport.remove ();
435 panning_viewport.add (pan_bar_packer);
436 panning_viewport.show_all ();
441 twod_panner = new Panner2d (_panner, 61);
442 twod_panner->set_name ("MixerPanZone");
443 twod_panner->show ();
445 twod_panner->signal_button_press_event().connect
446 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_button_event), (uint32_t) 0), false);
449 update_pan_sensitive ();
450 twod_panner->reset (npans);
452 big_window->reset (npans);
454 twod_panner->set_size_request (-1, 61);
456 /* and finally, add it to the panner frame */
458 panning_viewport.remove ();
459 panning_viewport.add (*twod_panner);
460 panning_viewport.show_all ();
465 PannerUI::start_touch (boost::weak_ptr<AutomationControl> wac)
467 boost::shared_ptr<AutomationControl> ac = wac.lock();
471 ac->start_touch (ac->session().transport_frame());
475 PannerUI::stop_touch (boost::weak_ptr<AutomationControl> wac)
477 boost::shared_ptr<AutomationControl> ac = wac.lock();
481 ac->stop_touch (false, ac->session().transport_frame());
485 PannerUI::pan_button_event (GdkEventButton* ev, uint32_t which)
487 switch (ev->button) {
489 if (twod_panner && ev->type == GDK_2BUTTON_PRESS) {
491 big_window = new Panner2dWindow (_panner, 400, _panner->npanners());
500 pan_menu = manage (new Menu);
501 pan_menu->set_name ("ArdourContextMenu");
503 build_pan_menu (which);
504 pan_menu->popup (1, ev->time);
511 return false; // what's wrong with gcc?
515 PannerUI::build_pan_menu (uint32_t which)
517 using namespace Menu_Helpers;
518 MenuList& items (pan_menu->items());
522 items.push_back (CheckMenuElem (_("Mute")));
524 /* set state first, connect second */
526 (dynamic_cast<CheckMenuItem*> (&items.back()))->set_active (_panner->streampanner(which).muted());
527 (dynamic_cast<CheckMenuItem*> (&items.back()))->signal_toggled().connect
528 (sigc::bind (sigc::mem_fun(*this, &PannerUI::pan_mute), which));
530 items.push_back (CheckMenuElem (_("Bypass"), sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle)));
531 bypass_menu_item = static_cast<CheckMenuItem*> (&items.back());
533 /* set state first, connect second */
535 bypass_menu_item->set_active (_panner->bypassed());
536 bypass_menu_item->signal_toggled().connect (sigc::mem_fun(*this, &PannerUI::pan_bypass_toggle));
538 items.push_back (MenuElem (_("Reset"), sigc::bind (sigc::mem_fun (*this, &PannerUI::pan_reset), which)));
539 items.push_back (SeparatorElem());
540 items.push_back (MenuElem (_("Reset all"), sigc::mem_fun (*this, &PannerUI::pan_reset_all)));
544 PannerUI::pan_mute (uint32_t which)
546 StreamPanner& sp = _panner->streampanner(which);
547 sp.set_muted (!sp.muted());
551 PannerUI::pan_bypass_toggle ()
553 if (bypass_menu_item && (_panner->bypassed() != bypass_menu_item->get_active())) {
554 _panner->set_bypassed (!_panner->bypassed());
559 PannerUI::pan_reset (uint32_t which)
561 _panner->reset_streampanner (which);
565 PannerUI::pan_reset_all ()
567 _panner->reset_to_default ();
571 PannerUI::effective_pan_display ()
573 if (_panner->empty()) {
577 switch (_panner->nouts()) {
584 update_pan_bars (true);
588 //panner->move_puck (pan_value (v, right), 0.5);
594 PannerUI::pan_changed (void *src)
600 switch (_panner->npanners()) {
602 panning_link_direction_button.set_sensitive (false);
603 panning_link_button.set_sensitive (false);
606 panning_link_direction_button.set_sensitive (false);
607 panning_link_button.set_sensitive (false);
610 panning_link_direction_button.set_sensitive (_panner->linked ());
611 panning_link_button.set_sensitive (true);
614 uint32_t const nouts = _panner->nouts();
623 /* bring pan bar state up to date */
624 update_pan_bars (false);
628 // panner->move_puck (pan_value (pans[0], pans[1]), 0.5);
634 PannerUI::pan_adjustment_changed (uint32_t which)
636 if (!in_pan_update && which < _panner->npanners()) {
638 float val = pan_adjustments[which]->get_value ();
639 float const xpos = _panner->pan_control(which)->get_value();
641 /* add a kinda-sorta detent for the middle */
643 if (val != 0.5 && Panner::equivalent (val, 0.5)) {
644 /* this is going to be reentrant, so just
648 in_pan_update = true;
649 pan_adjustments[which]->set_value (0.5);
650 in_pan_update = false;
654 if (!Panner::equivalent (val, xpos)) {
656 _panner->pan_control(which)->set_value (val);
658 the panner objects have no access to the session,
659 so do this here. ick.
661 _session->set_dirty();
667 PannerUI::pan_value_changed (uint32_t which)
669 ENSURE_GUI_THREAD (*this, &PannerUI::pan_value_changed, which)
675 _panner->streampanner(which).get_position (x, y);
677 in_pan_update = true;
678 twod_panner->move_puck (which, x, y);
679 in_pan_update = false;
681 } else if (_panner->npanners() > 0 && which < _panner->npanners()) {
683 float val = pan_adjustments[which]->get_value ();
685 _panner->streampanner(which).get_position (xpos);
687 if (!Panner::equivalent (val, xpos)) {
688 in_pan_update = true;
689 pan_adjustments[which]->set_value (xpos);
690 in_pan_update = false;
696 PannerUI::update_pan_bars (bool only_if_aplay)
699 vector<Adjustment*>::iterator i;
701 in_pan_update = true;
703 /* this runs during automation playback, and moves the bar controllers
707 for (i = pan_adjustments.begin(), n = 0; i != pan_adjustments.end(); ++i, ++n) {
711 boost::shared_ptr<AutomationList> alist (_panner->streampanner(n).pan_control()->alist());
713 if (!alist->automation_playback()) {
718 _panner->streampanner(n).get_effective_position (xpos);
719 val = (*i)->get_value ();
721 if (!Panner::equivalent (val, xpos)) {
722 (*i)->set_value (xpos);
726 in_pan_update = false;
730 PannerUI::update_pan_sensitive ()
732 bool const sensitive = !(_panner->mono()) && !(_panner->automation_state() & Play);
734 switch (_panner->nouts()) {
739 for (vector<PannerBar*>::iterator i = pan_bars.begin(); i != pan_bars.end(); ++i) {
740 (*i)->set_sensitive (sensitive);
745 twod_panner->set_sensitive (sensitive);
748 big_window->set_sensitive (sensitive);
755 PannerUI::pan_automation_state_button_event (GdkEventButton *ev)
757 using namespace Menu_Helpers;
759 if (ev->type == GDK_BUTTON_RELEASE) {
763 switch (ev->button) {
765 if (pan_astate_menu == 0) {
766 build_astate_menu ();
768 pan_astate_menu->popup (1, ev->time);
778 PannerUI::pan_automation_style_button_event (GdkEventButton *ev)
780 if (ev->type == GDK_BUTTON_RELEASE) {
784 switch (ev->button) {
786 if (pan_astyle_menu == 0) {
787 build_astyle_menu ();
789 pan_astyle_menu->popup (1, ev->time);
798 PannerUI::pan_automation_style_changed ()
800 ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_style_changed)
804 pan_automation_style_button.set_label (astyle_string(_panner->automation_style()));
807 pan_automation_style_button.set_label (short_astyle_string(_panner->automation_style()));
813 PannerUI::pan_automation_state_changed ()
815 ENSURE_GUI_THREAD (*this, &PannerUI::pan_automation_state_changed)
821 pan_automation_state_button.set_label (astate_string(_panner->automation_state()));
824 pan_automation_state_button.set_label (short_astate_string(_panner->automation_state()));
828 /* when creating a new session, we get to create busses (and
829 sometimes tracks) with no outputs by the time they get
833 if (_panner->empty()) {
837 x = (_panner->streampanner(0).pan_control()->alist()->automation_state() != Off);
839 if (pan_automation_state_button.get_active() != x) {
840 ignore_toggle = true;
841 pan_automation_state_button.set_active (x);
842 ignore_toggle = false;
845 update_pan_sensitive ();
847 /* start watching automation so that things move */
849 pan_watching.disconnect();
852 pan_watching = ARDOUR_UI::RapidScreenUpdate.connect (sigc::mem_fun (*this, &PannerUI::effective_pan_display));
857 PannerUI::astate_string (AutoState state)
859 return _astate_string (state, false);
863 PannerUI::short_astate_string (AutoState state)
865 return _astate_string (state, true);
869 PannerUI::_astate_string (AutoState state, bool shrt)
875 sstr = (shrt ? "M" : _("M"));
878 sstr = (shrt ? "P" : _("P"));
881 sstr = (shrt ? "T" : _("T"));
884 sstr = (shrt ? "W" : _("W"));
892 PannerUI::astyle_string (AutoStyle style)
894 return _astyle_string (style, false);
898 PannerUI::short_astyle_string (AutoStyle style)
900 return _astyle_string (style, true);
904 PannerUI::_astyle_string (AutoStyle style, bool shrt)
909 /* XXX it might different in different languages */
911 return (shrt ? _("Abs") : _("Abs"));
916 PannerUI::set_mono (bool yn)
918 _panner->set_mono (yn);
919 update_pan_sensitive ();
924 PannerUI::connect_to_pan_control (uint32_t i)
926 _panner->pan_control(i)->Changed.connect (
927 _pan_control_connections, invalidator (*this), boost::bind (&PannerUI::pan_value_changed, this, i), gui_context ()