2 Copyright (C) 2002 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.
25 #include <gtkmm/menu.h>
27 #include "gtkmm2ext/gtk_ui.h"
29 #include "pbd/error.h"
30 #include "pbd/cartesian.h"
31 #include "ardour/panner.h"
32 #include "ardour/panner_shell.h"
33 #include "ardour/pannable.h"
34 #include "ardour/speakers.h"
38 #include "gui_thread.h"
40 #include "public_editor.h"
46 using namespace ARDOUR;
48 using Gtkmm2ext::Keyboard;
50 static const int large_size_threshold = 100;
51 static const int large_border_width = 25;
52 static const int small_border_width = 8;
54 Panner2d::Target::Target (const AngularVector& a, const char *txt)
61 Panner2d::Target::~Target ()
66 Panner2d::Target::set_text (const char* txt)
71 Panner2d::Panner2d (boost::shared_ptr<PannerShell> p, int32_t h)
73 , position (AngularVector (0.0, 0.0), "")
77 , have_elevation (false)
79 panner_shell->Changed.connect (connections, invalidator (*this), boost::bind (&Panner2d::handle_state_change, this), gui_context());
81 panner_shell->panner()->SignalPositionChanged.connect (panconnect, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
84 set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
86 handle_state_change ();
87 handle_position_change ();
92 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
98 Panner2d::reset (uint32_t n_inputs)
100 uint32_t nouts = panner_shell->panner()->out().n_audio();
104 while (signals.size() < n_inputs) {
105 add_signal ("", AngularVector());
108 if (signals.size() > n_inputs) {
109 for (uint32_t i = signals.size(); i < n_inputs; ++i) {
113 signals.resize (n_inputs);
118 for (uint32_t i = 0; i < n_inputs; ++i) {
119 signals[i]->position = panner_shell->panner()->signal_position (i);
122 /* add all outputs */
124 while (speakers.size() < nouts) {
125 add_speaker (AngularVector());
128 if (speakers.size() > nouts) {
129 for (uint32_t i = nouts; i < speakers.size(); ++i) {
133 speakers.resize (nouts);
136 for (Targets::iterator x = speakers.begin(); x != speakers.end(); ++x) {
137 (*x)->visible = false;
140 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
142 for (uint32_t n = 0; n < nouts; ++n) {
145 snprintf (buf, sizeof (buf), "%d", n+1);
146 speakers[n]->set_text (buf);
147 speakers[n]->position = the_speakers[n].angles();
148 speakers[n]->visible = true;
155 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
157 width = alloc.get_width();
158 height = alloc.get_height();
160 if (height > large_size_threshold) {
161 border = large_border_width;
163 border = small_border_width;
166 radius = min (width, height);
170 hoffset = max ((double) (width - height), border);
171 voffset = max ((double) (height - width), border);
173 hoffset = rint(hoffset / 2.0);
174 voffset = rint(voffset / 2.0);
176 DrawingArea::on_size_allocate (alloc);
180 Panner2d::add_signal (const char* text, const AngularVector& a)
182 Target* signal = new Target (a, text);
183 signals.push_back (signal);
184 signal->visible = true;
190 Panner2d::add_speaker (const AngularVector& a)
192 Target* speaker = new Target (a, "");
193 speakers.push_back (speaker);
194 speaker->visible = true;
197 return speakers.size() - 1;
201 Panner2d::handle_state_change ()
203 panconnect.drop_connections();
204 if (!panner_shell->panner()) {
205 /* we should really self-destruct the UI here
206 * -> * PannerUI::set_panner() -> delete
212 panner_shell->panner()->SignalPositionChanged.connect (panconnect, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
214 set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
215 set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
216 bool elev = have_elevation;
217 have_elevation = (p == params.end()) ? false : true;
218 if (elev != have_elevation) {
219 handle_position_change();
225 Panner2d::label_signals ()
227 uint32_t sz = signals.size();
234 signals[0]->set_text ("");
238 signals[0]->set_text (_("L"));
239 signals[1]->set_text (_("R"));
243 for (uint32_t i = 0; i < sz; ++i) {
245 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
246 signals[i]->set_text (buf);
253 Panner2d::handle_position_change ()
256 double w = panner_shell->pannable()->pan_width_control->get_value();
258 if (have_elevation) {
259 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
260 panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
262 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0, 0);
265 for (uint32_t i = 0; i < signals.size(); ++i) {
266 signals[i]->position = panner_shell->panner()->signal_position (i);
269 if (w * last_width <= 0) {
276 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
278 for (n = 0; n < speakers.size(); ++n) {
279 speakers[n]->position = the_speakers[n].angles();
286 Panner2d::move_signal (int which, const AngularVector& a)
288 if (which >= int (speakers.size())) {
292 speakers[which]->position = a;
297 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
302 float best_distance = FLT_MAX;
305 /* start with the position itself */
307 position.position.cartesian (c);
309 best_distance = sqrt ((c.x - x) * (c.x - x) +
310 (c.y - y) * (c.y - y));
313 #if 0 // TODO signal grab -> change width, not position
314 for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
317 candidate->position.cartesian (c);
320 distance = sqrt ((c.x - x) * (c.x - x) +
321 (c.y - y) * (c.y - y));
323 if (distance < best_distance) {
325 best_distance = distance;
332 if (height > large_size_threshold) {
334 if (best_distance > 30) { // arbitrary
339 if (best_distance > 10) { // arbitrary
344 /* if we didn't find a signal close by, check the speakers */
347 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
350 candidate->position.cartesian (c);
353 distance = sqrt ((c.x - x) * (c.x - x) +
354 (c.y - y) * (c.y - y));
356 if (distance < best_distance) {
358 best_distance = distance;
362 if (height > large_size_threshold) {
364 if (best_distance < 30) { // arbitrary
371 if (best_distance < 10) { // arbitrary
383 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
386 GdkModifierType state;
389 gdk_window_get_pointer (ev->window, &x, &y, &state);
391 x = (int) floor (ev->x);
392 y = (int) floor (ev->y);
393 state = (GdkModifierType) ev->state;
396 if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
400 return handle_motion (x, y, state);
404 Panner2d::on_expose_event (GdkEventExpose *event)
408 bool small_size = (height <= large_size_threshold);
409 const double diameter = radius*2.0;
411 cr = gdk_cairo_create (get_window()->gobj());
415 cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
416 if (!panner_shell->bypassed()) {
417 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 1.0);
419 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 0.2);
421 cairo_fill_preserve (cr);
424 /* offset to give us some border */
426 cairo_translate (cr, hoffset, voffset);
428 cairo_set_line_width (cr, 1.0);
430 /* horizontal line of "crosshairs" */
432 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
433 cairo_move_to (cr, 0.0, rint(radius) - .5);
434 cairo_line_to (cr, diameter, rint(radius) - .5);
437 /* vertical line of "crosshairs" */
439 cairo_move_to (cr, rint(radius) - .5, 0);
440 cairo_line_to (cr, rint(radius) - .5, diameter);
443 /* the circle on which signals live */
445 cairo_set_line_width (cr, 1.5);
446 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 1.0);
447 cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
450 for (uint32_t rad = 15; rad < 90; rad += 15) {
451 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
453 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
455 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.8);
458 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
462 if (!panner_shell->bypassed()) {
464 if (signals.size() > 1) {
465 /* arc to show "diffusion" */
467 double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
468 double position_angle = (2 * M_PI) - panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
471 cairo_translate (cr, radius, radius);
472 cairo_rotate (cr, position_angle - (width_angle/2.0));
473 cairo_move_to (cr, 0, 0);
474 cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
475 cairo_close_path (cr);
476 if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
478 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.45);
481 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.45);
489 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
494 cairo_set_font_size (cr, 10);
500 position.position.cartesian (c);
504 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
505 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.85);
506 cairo_fill_preserve (cr);
507 cairo_set_source_rgba (cr, 1.0, 0.905, 0.905, 0.85);
512 if (signals.size() > 1) {
513 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
516 if (signal->visible) {
518 /* TODO check for overlap - multiple src at same position
519 * -> visualize it properly
521 PBD::AngularVector sp = signal->position;
522 if (!have_elevation) sp.ele = 0;
527 cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
528 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.75);
529 cairo_fill_preserve (cr);
530 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 0.8);
533 if (!small_size && !signal->text.empty()) {
534 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, .9);
535 /* the +/- adjustments are a hack to try to center the text in the circle
536 * TODO use pango get_pixel_size() -- see mono_panner.cc
539 cairo_move_to (cr, c.x - 1, c.y + 1);
541 cairo_move_to (cr, c.x - 4, c.y + 4);
543 cairo_show_text (cr, signal->text.c_str());
553 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
554 Target *speaker = *i;
558 if (speaker->visible) {
562 speaker->position.cartesian (c);
565 snprintf (buf, sizeof (buf), "%d", n);
567 /* stroke out a speaker shape */
569 cairo_move_to (cr, c.x, c.y);
571 cairo_rotate (cr, -(speaker->position.azi/360.0) * (2.0 * M_PI));
573 cairo_scale (cr, 0.8, 0.8);
575 cairo_scale (cr, 1.2, 1.2);
577 cairo_rel_line_to (cr, 4, -2);
578 cairo_rel_line_to (cr, 0, -7);
579 cairo_rel_line_to (cr, 5, +5);
580 cairo_rel_line_to (cr, 5, 0);
581 cairo_rel_line_to (cr, 0, 5);
582 cairo_rel_line_to (cr, -5, 0);
583 cairo_rel_line_to (cr, -5, +5);
584 cairo_rel_line_to (cr, 0, -7);
585 cairo_close_path (cr);
586 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
591 cairo_set_font_size (cr, 16);
593 /* move the text in just a bit */
595 AngularVector textpos (speaker->position.azi, speaker->position.ele, 0.85);
596 textpos.cartesian (c);
598 cairo_move_to (cr, c.x, c.y);
599 cairo_show_text (cr, buf);
612 Panner2d::on_button_press_event (GdkEventButton *ev)
614 GdkModifierType state;
619 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
625 switch (ev->button) {
631 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
633 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
636 drag_target->set_selected (true);
640 state = (GdkModifierType) ev->state;
641 return handle_motion (ev->x, ev->y, state);
652 Panner2d::on_button_release_event (GdkEventButton *ev)
655 GdkModifierType state;
658 switch (ev->button) {
660 x = (int) floor (ev->x);
661 y = (int) floor (ev->y);
662 state = (GdkModifierType) ev->state;
663 ret = handle_motion (x, y, state);
668 x = (int) floor (ev->x);
669 y = (int) floor (ev->y);
670 state = (GdkModifierType) ev->state;
672 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
676 ret = handle_motion (x, y, state);
691 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
693 if (drag_target == 0) {
697 if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
704 if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
706 bool need_move = false;
708 drag_target->position.cartesian (c);
711 if ((evx != c.x) || (evy != c.y)) {
716 CartesianVector cp (evx, evy, 0.0);
720 if (!have_elevation) {
721 clamp_to_circle (cp.x, cp.y);
723 if (drag_target == &position) {
724 double degree_fract = av.azi / 360.0;
725 panner_shell->panner()->set_position (degree_fract);
728 /* sphere projection */
729 sphere_project (cp.x, cp.y, cp.z);
731 double r2d = 180.0 / M_PI;
732 av.azi = r2d * atan2(cp.y, cp.x);
733 av.ele = r2d * asin(cp.z);
735 if (drag_target == &position) {
736 double azi_fract = av.azi / 360.0;
737 double ele_fract = av.ele / 90.0;
738 panner_shell->panner()->set_position (azi_fract);
739 panner_shell->panner()->set_elevation (ele_fract);
749 Panner2d::on_scroll_event (GdkEventScroll* ev)
751 switch (ev->direction) {
753 case GDK_SCROLL_RIGHT:
754 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
757 case GDK_SCROLL_DOWN:
758 case GDK_SCROLL_LEFT:
759 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
766 Panner2d::cart_to_gtk (CartesianVector& c) const
768 /* cartesian coordinate space:
770 dimension = 2.0 * 2.0
771 increasing y moves up
772 so max values along each axis are -1..+1
774 GTK uses a coordinate space that is:
776 dimension = (radius*2.0) * (radius*2.0)
777 increasing y moves down
779 const double diameter = radius*2.0;
781 c.x = diameter * ((c.x + 1.0) / 2.0);
782 /* extra subtraction inverts the y-axis to match "increasing y moves down" */
783 c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
787 Panner2d::gtk_to_cart (CartesianVector& c) const
789 const double diameter = radius*2.0;
790 c.x = ((c.x / diameter) * 2.0) - 1.0;
791 c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
795 Panner2d::sphere_project (double& x, double& y, double& z)
810 Panner2d::clamp_to_circle (double& x, double& y)
815 PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
816 PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
820 Panner2d::toggle_bypass ()
822 panner_shell->set_bypassed (!panner_shell->bypassed());
825 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
826 : ArdourWindow (_("Panner (2D)"))
828 , bypass_button (_("Bypass"))
829 , width_adjustment (0, -100, 100, 1, 5, 0)
830 , width_spinner (width_adjustment)
832 widget.set_name ("MixerPanZone");
834 set_title (_("Panner"));
835 widget.set_size_request (h, h);
837 bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
838 width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
840 p->pannable()->pan_width_control->Changed.connect (connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
841 p->Changed.connect (connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
843 button_box.set_spacing (6);
844 button_box.pack_start (bypass_button, false, false);
846 left_side.set_spacing (6);
848 left_side.pack_start (button_box, false, false);
850 Gtk::Label* l = manage (new Label (
851 p->panner()->describe_parameter(PanWidthAutomation),
852 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
853 spinner_box.pack_start (*l, false, false);
854 spinner_box.pack_start (width_spinner, false, false);
855 left_side.pack_start (spinner_box, false, false);
858 bypass_button.show ();
860 width_spinner.show ();
864 hpacker.set_spacing (6);
865 hpacker.set_border_width (12);
866 hpacker.pack_start (widget, false, false);
867 hpacker.pack_start (left_side, false, false);
878 Panner2dWindow::reset (uint32_t n_inputs)
880 widget.reset (n_inputs);
884 Panner2dWindow::bypass_toggled ()
886 bool view = bypass_button.get_active ();
887 bool model = widget.get_panner_shell()->bypassed ();
890 widget.get_panner_shell()->set_bypassed (view);
894 Panner2dWindow::width_changed ()
896 float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
897 float view = width_spinner.get_value() / 100.0;
899 widget.get_panner_shell()->panner()->set_width (view);
904 Panner2dWindow::set_bypassed ()
906 bool view = bypass_button.get_active ();
907 bool model = widget.get_panner_shell()->bypassed ();
909 bypass_button.set_active(model);
912 set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
913 set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
914 if (p == params.end()) {
915 spinner_box.set_sensitive(false);
917 spinner_box.set_sensitive(true);
922 Panner2dWindow::set_width ()
924 // rounding of spinbox is different from slider -- TODO use slider
925 float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
926 float view = (width_spinner.get_value());
928 width_spinner.set_value (model);
933 Panner2dWindow::on_key_press_event (GdkEventKey* event)
935 return relay_key_press (event, &PublicEditor::instance());
939 Panner2dWindow::on_key_release_event (GdkEventKey*)