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 panner_shell->panner()->SignalPositionChanged.connect (panconnect, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
206 set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
207 set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
208 bool elev = have_elevation;
209 have_elevation = (p == params.end()) ? false : true;
210 if (elev != have_elevation) {
211 handle_position_change();
217 Panner2d::label_signals ()
219 uint32_t sz = signals.size();
226 signals[0]->set_text ("");
230 signals[0]->set_text (_("L"));
231 signals[1]->set_text (_("R"));
235 for (uint32_t i = 0; i < sz; ++i) {
237 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
238 signals[i]->set_text (buf);
245 Panner2d::handle_position_change ()
248 double w = panner_shell->pannable()->pan_width_control->get_value();
250 if (have_elevation) {
251 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
252 panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
254 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0, 0);
257 for (uint32_t i = 0; i < signals.size(); ++i) {
258 signals[i]->position = panner_shell->panner()->signal_position (i);
261 if (w * last_width <= 0) {
268 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
270 for (n = 0; n < speakers.size(); ++n) {
271 speakers[n]->position = the_speakers[n].angles();
278 Panner2d::move_signal (int which, const AngularVector& a)
280 if (which >= int (speakers.size())) {
284 speakers[which]->position = a;
289 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
294 float best_distance = FLT_MAX;
297 /* start with the position itself */
299 position.position.cartesian (c);
301 best_distance = sqrt ((c.x - x) * (c.x - x) +
302 (c.y - y) * (c.y - y));
305 #if 0 // TODO signal grab -> change width, not position
306 for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
309 candidate->position.cartesian (c);
312 distance = sqrt ((c.x - x) * (c.x - x) +
313 (c.y - y) * (c.y - y));
315 if (distance < best_distance) {
317 best_distance = distance;
324 if (height > large_size_threshold) {
326 if (best_distance > 30) { // arbitrary
331 if (best_distance > 10) { // arbitrary
336 /* if we didn't find a signal close by, check the speakers */
339 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
342 candidate->position.cartesian (c);
345 distance = sqrt ((c.x - x) * (c.x - x) +
346 (c.y - y) * (c.y - y));
348 if (distance < best_distance) {
350 best_distance = distance;
354 if (height > large_size_threshold) {
356 if (best_distance < 30) { // arbitrary
363 if (best_distance < 10) { // arbitrary
375 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
378 GdkModifierType state;
381 gdk_window_get_pointer (ev->window, &x, &y, &state);
383 x = (int) floor (ev->x);
384 y = (int) floor (ev->y);
385 state = (GdkModifierType) ev->state;
388 if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
392 return handle_motion (x, y, state);
396 Panner2d::on_expose_event (GdkEventExpose *event)
400 bool small = (height <= large_size_threshold);
401 const double diameter = radius*2.0;
403 cr = gdk_cairo_create (get_window()->gobj());
407 cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
408 if (!panner_shell->bypassed()) {
409 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 1.0);
411 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 0.2);
413 cairo_fill_preserve (cr);
416 /* offset to give us some border */
418 cairo_translate (cr, hoffset, voffset);
420 cairo_set_line_width (cr, 1.0);
422 /* horizontal line of "crosshairs" */
424 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
425 cairo_move_to (cr, 0.0, rint(radius) - .5);
426 cairo_line_to (cr, diameter, rint(radius) - .5);
429 /* vertical line of "crosshairs" */
431 cairo_move_to (cr, rint(radius) - .5, 0);
432 cairo_line_to (cr, rint(radius) - .5, diameter);
435 /* the circle on which signals live */
437 cairo_set_line_width (cr, 1.5);
438 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 1.0);
439 cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
442 for (uint32_t rad = 15; rad < 90; rad += 15) {
443 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
445 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
447 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.8);
450 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
454 if (!panner_shell->bypassed()) {
456 if (signals.size() > 1) {
457 /* arc to show "diffusion" */
459 double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
460 double position_angle = (2 * M_PI) - panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
463 cairo_translate (cr, radius, radius);
464 cairo_rotate (cr, position_angle - (width_angle/2.0));
465 cairo_move_to (cr, 0, 0);
466 cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
467 cairo_close_path (cr);
468 if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
470 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.45);
473 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.45);
481 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
486 cairo_set_font_size (cr, 10);
492 position.position.cartesian (c);
496 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
497 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.85);
498 cairo_fill_preserve (cr);
499 cairo_set_source_rgba (cr, 1.0, 0.905, 0.905, 0.85);
504 if (signals.size() > 1) {
505 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
508 if (signal->visible) {
510 /* TODO check for overlap - multiple src at same position
511 * -> visualize it properly
513 PBD::AngularVector sp = signal->position;
514 if (!have_elevation) sp.ele = 0;
519 cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
520 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.75);
521 cairo_fill_preserve (cr);
522 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 0.8);
525 if (!small && !signal->text.empty()) {
526 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, .9);
527 /* the +/- adjustments are a hack to try to center the text in the circle
528 * TODO use pango get_pixel_size() -- see mono_panner.cc
531 cairo_move_to (cr, c.x - 1, c.y + 1);
533 cairo_move_to (cr, c.x - 4, c.y + 4);
535 cairo_show_text (cr, signal->text.c_str());
545 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
546 Target *speaker = *i;
550 if (speaker->visible) {
554 speaker->position.cartesian (c);
557 snprintf (buf, sizeof (buf), "%d", n);
559 /* stroke out a speaker shape */
561 cairo_move_to (cr, c.x, c.y);
563 cairo_rotate (cr, -(speaker->position.azi/360.0) * (2.0 * M_PI));
565 cairo_scale (cr, 0.8, 0.8);
567 cairo_scale (cr, 1.2, 1.2);
569 cairo_rel_line_to (cr, 4, -2);
570 cairo_rel_line_to (cr, 0, -7);
571 cairo_rel_line_to (cr, 5, +5);
572 cairo_rel_line_to (cr, 5, 0);
573 cairo_rel_line_to (cr, 0, 5);
574 cairo_rel_line_to (cr, -5, 0);
575 cairo_rel_line_to (cr, -5, +5);
576 cairo_rel_line_to (cr, 0, -7);
577 cairo_close_path (cr);
578 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
583 cairo_set_font_size (cr, 16);
585 /* move the text in just a bit */
587 AngularVector textpos (speaker->position.azi, speaker->position.ele, 0.85);
588 textpos.cartesian (c);
590 cairo_move_to (cr, c.x, c.y);
591 cairo_show_text (cr, buf);
604 Panner2d::on_button_press_event (GdkEventButton *ev)
606 GdkModifierType state;
611 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
617 switch (ev->button) {
623 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
625 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
628 drag_target->set_selected (true);
632 state = (GdkModifierType) ev->state;
633 return handle_motion (ev->x, ev->y, state);
644 Panner2d::on_button_release_event (GdkEventButton *ev)
647 GdkModifierType state;
650 switch (ev->button) {
652 x = (int) floor (ev->x);
653 y = (int) floor (ev->y);
654 state = (GdkModifierType) ev->state;
655 ret = handle_motion (x, y, state);
660 x = (int) floor (ev->x);
661 y = (int) floor (ev->y);
662 state = (GdkModifierType) ev->state;
664 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
668 ret = handle_motion (x, y, state);
683 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
685 if (drag_target == 0) {
689 if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
696 if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
698 bool need_move = false;
700 drag_target->position.cartesian (c);
703 if ((evx != c.x) || (evy != c.y)) {
708 CartesianVector cp (evx, evy, 0.0);
712 if (!have_elevation) {
713 clamp_to_circle (cp.x, cp.y);
715 if (drag_target == &position) {
716 double degree_fract = av.azi / 360.0;
717 panner_shell->panner()->set_position (degree_fract);
720 /* sphere projection */
721 sphere_project (cp.x, cp.y, cp.z);
723 double r2d = 180.0 / M_PI;
724 av.azi = r2d * atan2(cp.y, cp.x);
725 av.ele = r2d * asin(cp.z);
727 if (drag_target == &position) {
728 double azi_fract = av.azi / 360.0;
729 double ele_fract = av.ele / 90.0;
730 panner_shell->panner()->set_position (azi_fract);
731 panner_shell->panner()->set_elevation (ele_fract);
741 Panner2d::on_scroll_event (GdkEventScroll* ev)
743 switch (ev->direction) {
745 case GDK_SCROLL_RIGHT:
746 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
749 case GDK_SCROLL_DOWN:
750 case GDK_SCROLL_LEFT:
751 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
758 Panner2d::cart_to_gtk (CartesianVector& c) const
760 /* cartesian coordinate space:
762 dimension = 2.0 * 2.0
763 increasing y moves up
764 so max values along each axis are -1..+1
766 GTK uses a coordinate space that is:
768 dimension = (radius*2.0) * (radius*2.0)
769 increasing y moves down
771 const double diameter = radius*2.0;
773 c.x = diameter * ((c.x + 1.0) / 2.0);
774 /* extra subtraction inverts the y-axis to match "increasing y moves down" */
775 c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
779 Panner2d::gtk_to_cart (CartesianVector& c) const
781 const double diameter = radius*2.0;
782 c.x = ((c.x / diameter) * 2.0) - 1.0;
783 c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
787 Panner2d::sphere_project (double& x, double& y, double& z)
802 Panner2d::clamp_to_circle (double& x, double& y)
807 PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
808 PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
812 Panner2d::toggle_bypass ()
814 panner_shell->set_bypassed (!panner_shell->bypassed());
817 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
818 : ArdourWindow (_("Panner (2D)"))
820 , bypass_button (_("Bypass"))
821 , width_adjustment (0, -100, 100, 1, 5, 0)
822 , width_spinner (width_adjustment)
824 widget.set_name ("MixerPanZone");
826 set_title (_("Panner"));
827 widget.set_size_request (h, h);
829 bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
830 width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
832 p->pannable()->pan_width_control->Changed.connect (connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
833 p->Changed.connect (connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
835 button_box.set_spacing (6);
836 button_box.pack_start (bypass_button, false, false);
838 left_side.set_spacing (6);
840 left_side.pack_start (button_box, false, false);
842 Gtk::Label* l = manage (new Label (
843 p->panner()->describe_parameter(PanWidthAutomation),
844 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
845 spinner_box.pack_start (*l, false, false);
846 spinner_box.pack_start (width_spinner, false, false);
847 left_side.pack_start (spinner_box, false, false);
850 bypass_button.show ();
852 width_spinner.show ();
856 hpacker.set_spacing (6);
857 hpacker.set_border_width (12);
858 hpacker.pack_start (widget, false, false);
859 hpacker.pack_start (left_side, false, false);
870 Panner2dWindow::reset (uint32_t n_inputs)
872 widget.reset (n_inputs);
876 Panner2dWindow::bypass_toggled ()
878 bool view = bypass_button.get_active ();
879 bool model = widget.get_panner_shell()->bypassed ();
882 widget.get_panner_shell()->set_bypassed (view);
886 Panner2dWindow::width_changed ()
888 float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
889 float view = width_spinner.get_value() / 100.0;
891 widget.get_panner_shell()->panner()->set_width (view);
896 Panner2dWindow::set_bypassed ()
898 bool view = bypass_button.get_active ();
899 bool model = widget.get_panner_shell()->bypassed ();
901 bypass_button.set_active(model);
904 set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
905 set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
906 if (p == params.end()) {
907 spinner_box.set_sensitive(false);
909 spinner_box.set_sensitive(true);
914 Panner2dWindow::set_width ()
916 // rounding of spinbox is different from slider -- TODO use slider
917 float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
918 float view = (width_spinner.get_value());
920 width_spinner.set_value (model);
925 Panner2dWindow::on_key_press_event (GdkEventKey* event)
927 return relay_key_press (event, &PublicEditor::instance());
931 Panner2dWindow::on_key_release_event (GdkEventKey*)