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;
47 using namespace ARDOUR_UI_UTILS;
49 using Gtkmm2ext::Keyboard;
51 static const int large_size_threshold = 100;
52 static const int large_border_width = 25;
53 static const int small_border_width = 8;
55 Panner2d::Target::Target (const AngularVector& a, const char *txt)
62 Panner2d::Target::~Target ()
67 Panner2d::Target::set_text (const char* txt)
72 Panner2d::Panner2d (boost::shared_ptr<PannerShell> p, int32_t h)
74 , position (AngularVector (0.0, 0.0), "")
78 , have_elevation (false)
81 panner_shell->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2d::handle_state_change, this), gui_context());
83 panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
86 set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
88 handle_state_change ();
89 handle_position_change ();
94 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
100 Panner2d::reset (uint32_t n_inputs)
102 uint32_t nouts = panner_shell->panner()->out().n_audio();
106 while (signals.size() < n_inputs) {
107 add_signal ("", AngularVector());
110 if (signals.size() > n_inputs) {
111 for (uint32_t i = signals.size(); i < n_inputs; ++i) {
115 signals.resize (n_inputs);
120 for (uint32_t i = 0; i < n_inputs; ++i) {
121 signals[i]->position = panner_shell->panner()->signal_position (i);
124 /* add all outputs */
126 while (speakers.size() < nouts) {
127 add_speaker (AngularVector());
130 if (speakers.size() > nouts) {
131 for (uint32_t i = nouts; i < speakers.size(); ++i) {
135 speakers.resize (nouts);
138 for (Targets::iterator x = speakers.begin(); x != speakers.end(); ++x) {
139 (*x)->visible = false;
142 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
144 for (uint32_t n = 0; n < nouts; ++n) {
147 snprintf (buf, sizeof (buf), "%d", n+1);
148 speakers[n]->set_text (buf);
149 speakers[n]->position = the_speakers[n].angles();
150 speakers[n]->visible = true;
157 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
159 width = alloc.get_width();
160 height = alloc.get_height();
162 if (height > large_size_threshold) {
163 border = large_border_width;
165 border = small_border_width;
168 radius = min (width, height);
171 radius = rint(radius) + .5;
173 hoffset = max ((double) (width - height), border);
174 voffset = max ((double) (height - width), border);
176 hoffset = rint(hoffset / 2.0);
177 voffset = rint(voffset / 2.0);
179 DrawingArea::on_size_allocate (alloc);
183 Panner2d::add_signal (const char* text, const AngularVector& a)
185 Target* signal = new Target (a, text);
186 signals.push_back (signal);
187 signal->visible = true;
193 Panner2d::add_speaker (const AngularVector& a)
195 Target* speaker = new Target (a, "");
196 speakers.push_back (speaker);
197 speaker->visible = true;
200 return speakers.size() - 1;
204 Panner2d::handle_state_change ()
206 panner_connections.drop_connections();
207 if (!panner_shell->panner()) {
211 panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
213 set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
214 set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
215 bool elev = have_elevation;
216 have_elevation = (p == params.end()) ? false : true;
217 if (elev != have_elevation) {
218 handle_position_change();
224 Panner2d::label_signals ()
226 uint32_t sz = signals.size();
233 signals[0]->set_text ("");
237 signals[0]->set_text (_("L"));
238 signals[1]->set_text (_("R"));
242 for (uint32_t i = 0; i < sz; ++i) {
244 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
245 signals[i]->set_text (buf);
252 Panner2d::handle_position_change ()
255 double w = panner_shell->pannable()->pan_width_control->get_value();
257 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
258 panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
260 for (uint32_t i = 0; i < signals.size(); ++i) {
261 signals[i]->position = panner_shell->panner()->signal_position (i);
264 if (w * last_width <= 0) {
271 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
273 for (n = 0; n < speakers.size(); ++n) {
274 speakers[n]->position = the_speakers[n].angles();
281 Panner2d::move_signal (int which, const AngularVector& a)
283 if (which >= int (speakers.size())) {
287 speakers[which]->position = a;
292 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
297 float best_distance = FLT_MAX;
300 /* start with the position itself */
302 PBD::AngularVector dp = position.position;
303 if (!have_elevation) dp.ele = 0;
304 dp.azi = 270 - dp.azi;
308 best_distance = sqrt ((c.x - x) * (c.x - x) +
309 (c.y - y) * (c.y - y));
312 #if 0 // TODO signal grab -> change width, not position
313 for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
316 candidate->position.cartesian (c);
319 distance = sqrt ((c.x - x) * (c.x - x) +
320 (c.y - y) * (c.y - y));
322 if (distance < best_distance) {
324 best_distance = distance;
331 if (height > large_size_threshold) {
333 if (best_distance > 30) { // arbitrary
338 if (best_distance > 10) { // arbitrary
343 /* if we didn't find a signal close by, check the speakers */
346 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
348 PBD::AngularVector sp = candidate->position;
349 sp.azi = 270 -sp.azi;
354 distance = sqrt ((c.x - x) * (c.x - x) +
355 (c.y - y) * (c.y - y));
357 if (distance < best_distance) {
359 best_distance = distance;
363 if (height > large_size_threshold) {
365 if (best_distance < 30) { // arbitrary
372 if (best_distance < 10) { // arbitrary
384 Panner2d::set_send_drawing_mode (bool onoff)
386 if (_send_mode != onoff) {
393 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
396 GdkModifierType state;
399 gdk_window_get_pointer (ev->window, &x, &y, &state);
401 x = (int) floor (ev->x);
402 y = (int) floor (ev->y);
403 state = (GdkModifierType) ev->state;
406 if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
410 return handle_motion (x, y, state);
414 Panner2d::on_expose_event (GdkEventExpose *event)
418 bool small = (height <= large_size_threshold);
419 const double diameter = radius*2.0;
421 cr = gdk_cairo_create (get_window()->gobj());
425 cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
430 rgba_p_from_style("SendStripBase", &r, &g, &b, "fg");
432 if (!panner_shell->bypassed()) {
433 cairo_set_source_rgba (cr, r, g, b, 1.0);
435 cairo_set_source_rgba (cr, r, g, b , 0.2);
437 cairo_fill_preserve (cr);
440 /* offset to give us some border */
442 cairo_translate (cr, hoffset, voffset);
444 cairo_set_line_width (cr, 1.0);
446 /* horizontal line of "crosshairs" */
448 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
449 cairo_move_to (cr, 0.0, radius);
450 cairo_line_to (cr, diameter, radius);
453 /* vertical line of "crosshairs" */
455 cairo_move_to (cr, radius, 0);
456 cairo_line_to (cr, radius, diameter);
459 /* the circle on which signals live */
461 cairo_set_line_width (cr, 1.5);
462 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 1.0);
463 cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
466 for (uint32_t rad = 15; rad < 90; rad += 15) {
467 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
469 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
471 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.8);
474 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
478 if (!panner_shell->bypassed()) {
479 /* convention top == front ^= azimuth == .5 (same as stereo/mono panners) */
481 if (signals.size() > 1) {
482 /* arc to show "diffusion" */
484 double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
485 double position_angle = panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
488 cairo_translate (cr, radius, radius);
489 cairo_rotate (cr, M_PI / 2.0);
490 cairo_rotate (cr, position_angle - (width_angle/2.0));
491 cairo_move_to (cr, 0, 0);
492 cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
493 cairo_close_path (cr);
494 if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
496 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.45);
499 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.45);
507 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
512 cairo_set_font_size (cr, 10);
518 PBD::AngularVector dp = position.position;
519 if (!have_elevation) dp.ele = 0;
520 dp.azi = 270 - dp.azi;
525 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
526 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.85);
527 cairo_fill_preserve (cr);
528 cairo_set_source_rgba (cr, 1.0, 0.905, 0.905, 0.85);
533 if (signals.size() > 0) {
534 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
537 if (signal->visible) {
539 /* TODO check for overlap - multiple src at same position
540 * -> visualize it properly
542 PBD::AngularVector sp = signal->position;
543 if (!have_elevation) sp.ele = 0;
549 cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
550 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.75);
551 cairo_fill_preserve (cr);
552 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 0.8);
555 if (!small && !signal->text.empty()) {
556 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, .9);
557 /* the +/- adjustments are a hack to try to center the text in the circle
558 * TODO use pango get_pixel_size() -- see mono_panner.cc
561 cairo_move_to (cr, c.x - 1, c.y + 1);
563 cairo_move_to (cr, c.x - 4, c.y + 4);
565 cairo_show_text (cr, signal->text.c_str());
575 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
576 Target *speaker = *i;
580 if (speaker->visible) {
582 PBD::AngularVector sp = speaker->position;
588 snprintf (buf, sizeof (buf), "%d", n);
590 /* stroke out a speaker shape */
592 cairo_move_to (cr, c.x, c.y);
594 cairo_rotate (cr, -(sp.azi/360.0) * (2.0 * M_PI));
596 cairo_scale (cr, 0.8, 0.8);
598 cairo_scale (cr, 1.2, 1.2);
600 cairo_rel_line_to (cr, 4, -2);
601 cairo_rel_line_to (cr, 0, -7);
602 cairo_rel_line_to (cr, 5, +5);
603 cairo_rel_line_to (cr, 5, 0);
604 cairo_rel_line_to (cr, 0, 5);
605 cairo_rel_line_to (cr, -5, 0);
606 cairo_rel_line_to (cr, -5, +5);
607 cairo_rel_line_to (cr, 0, -7);
608 cairo_close_path (cr);
609 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
614 cairo_set_font_size (cr, 16);
616 /* move the text in just a bit */
618 AngularVector textpos (speaker->position.azi + 270.0, speaker->position.ele, 0.85);
620 textpos.cartesian (c);
622 cairo_move_to (cr, c.x, c.y);
623 cairo_show_text (cr, buf);
636 Panner2d::on_button_press_event (GdkEventButton *ev)
638 GdkModifierType state;
643 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
649 switch (ev->button) {
655 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
657 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
660 drag_target->set_selected (true);
664 state = (GdkModifierType) ev->state;
665 return handle_motion (ev->x, ev->y, state);
676 Panner2d::on_button_release_event (GdkEventButton *ev)
679 GdkModifierType state;
682 switch (ev->button) {
684 x = (int) floor (ev->x);
685 y = (int) floor (ev->y);
686 state = (GdkModifierType) ev->state;
687 ret = handle_motion (x, y, state);
692 x = (int) floor (ev->x);
693 y = (int) floor (ev->y);
694 state = (GdkModifierType) ev->state;
696 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
700 ret = handle_motion (x, y, state);
715 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
717 if (drag_target == 0) {
721 if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
728 if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
730 bool need_move = false;
732 drag_target->position.cartesian (c);
735 if ((evx != c.x) || (evy != c.y)) {
740 CartesianVector cp (evx, evy, 0.0);
744 if (!have_elevation) {
745 clamp_to_circle (cp.x, cp.y);
747 av.azi = fmod(270 - av.azi, 360);
748 if (drag_target == &position) {
749 double degree_fract = av.azi / 360.0;
750 panner_shell->panner()->set_position (degree_fract);
753 /* sphere projection */
754 sphere_project (cp.x, cp.y, cp.z);
756 double r2d = 180.0 / M_PI;
757 av.azi = r2d * atan2(cp.y, cp.x);
758 av.ele = r2d * asin(cp.z);
759 av.azi = fmod(270 - av.azi, 360);
761 if (drag_target == &position) {
762 double azi_fract = av.azi / 360.0;
763 double ele_fract = av.ele / 90.0;
764 panner_shell->panner()->set_position (azi_fract);
765 panner_shell->panner()->set_elevation (ele_fract);
775 Panner2d::on_scroll_event (GdkEventScroll* ev)
777 switch (ev->direction) {
779 case GDK_SCROLL_RIGHT:
780 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
783 case GDK_SCROLL_DOWN:
784 case GDK_SCROLL_LEFT:
785 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
792 Panner2d::cart_to_gtk (CartesianVector& c) const
794 /* cartesian coordinate space:
796 dimension = 2.0 * 2.0
797 increasing y moves up
798 so max values along each axis are -1..+1
800 GTK uses a coordinate space that is:
802 dimension = (radius*2.0) * (radius*2.0)
803 increasing y moves down
805 const double diameter = radius*2.0;
807 c.x = diameter * ((c.x + 1.0) / 2.0);
808 /* extra subtraction inverts the y-axis to match "increasing y moves down" */
809 c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
813 Panner2d::gtk_to_cart (CartesianVector& c) const
815 const double diameter = radius*2.0;
816 c.x = ((c.x / diameter) * 2.0) - 1.0;
817 c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
821 Panner2d::sphere_project (double& x, double& y, double& z)
836 Panner2d::clamp_to_circle (double& x, double& y)
841 PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
842 PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
846 Panner2d::toggle_bypass ()
848 panner_shell->set_bypassed (!panner_shell->bypassed());
851 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
852 : ArdourWindow (_("Panner (2D)"))
854 , bypass_button (_("Bypass"))
855 , width_adjustment (0, -100, 100, 1, 5, 0)
856 , width_spinner (width_adjustment)
858 widget.set_name ("MixerPanZone");
860 set_title (_("Panner"));
861 widget.set_size_request (h, h);
863 bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
864 width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
866 p->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
867 /* needed for the width-spinbox in the main window */
868 p->PannableChanged.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::pannable_handler, this), gui_context());
869 p->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
872 button_box.set_spacing (6);
873 button_box.pack_start (bypass_button, false, false);
875 left_side.set_spacing (6);
877 left_side.pack_start (button_box, false, false);
879 Gtk::Label* l = manage (new Label (
880 p->panner()->describe_parameter(PanWidthAutomation),
881 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
882 spinner_box.pack_start (*l, false, false);
883 spinner_box.pack_start (width_spinner, false, false);
884 left_side.pack_start (spinner_box, false, false);
887 bypass_button.show ();
889 width_spinner.show ();
893 hpacker.set_spacing (6);
894 hpacker.set_border_width (12);
895 hpacker.pack_start (widget, false, false);
896 hpacker.pack_start (left_side, false, false);
907 Panner2dWindow::reset (uint32_t n_inputs)
909 widget.reset (n_inputs);
913 Panner2dWindow::bypass_toggled ()
915 bool view = bypass_button.get_active ();
916 bool model = widget.get_panner_shell()->bypassed ();
919 widget.get_panner_shell()->set_bypassed (view);
923 Panner2dWindow::width_changed ()
925 float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
926 float view = width_spinner.get_value() / 100.0;
928 widget.get_panner_shell()->panner()->set_width (view);
933 Panner2dWindow::pannable_handler ()
935 panvalue_connections.drop_connections();
936 widget.get_panner_shell()->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
941 Panner2dWindow::set_bypassed ()
943 bool view = bypass_button.get_active ();
944 bool model = widget.get_panner_shell()->bypassed ();
946 bypass_button.set_active(model);
949 set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
950 set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
951 if (p == params.end()) {
952 spinner_box.set_sensitive(false);
954 spinner_box.set_sensitive(true);
959 Panner2dWindow::set_width ()
961 // rounding of spinbox is different from slider -- TODO use slider
962 float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
963 float view = (width_spinner.get_value());
965 width_spinner.set_value (model);
970 Panner2dWindow::on_key_press_event (GdkEventKey* event)
972 return relay_key_press (event, &PublicEditor::instance());
976 Panner2dWindow::on_key_release_event (GdkEventKey*)