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"
36 #include "canvas/colors.h"
40 #include "gui_thread.h"
41 #include "rgb_macros.h"
43 #include "public_editor.h"
44 #include "ui_config.h"
50 using namespace ARDOUR;
51 using namespace ARDOUR_UI_UTILS;
53 using Gtkmm2ext::Keyboard;
55 Panner2d::ColorScheme Panner2d::colors;
56 bool Panner2d::have_colors = false;
58 static const int large_size_threshold = 100;
59 static const int large_border_width = 25;
60 static const int small_border_width = 8;
62 Panner2d::Target::Target (const AngularVector& a, const char *txt)
69 Panner2d::Target::~Target ()
74 Panner2d::Target::set_text (const char* txt)
79 Panner2d::Panner2d (boost::shared_ptr<PannerShell> p, int32_t h)
81 , position (AngularVector (0.0, 0.0), "")
85 , have_elevation (false)
93 UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &Panner2d::color_handler));
95 panner_shell->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2d::handle_state_change, this), gui_context());
97 panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
100 set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
102 handle_state_change ();
103 handle_position_change ();
106 Panner2d::~Panner2d()
108 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
111 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
117 Panner2d::set_colors ()
119 // TODO get all colors from theme, resolve dups
120 colors.background = UIConfiguration::instance().color ("mono panner bg");
121 colors.crosshairs = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0
122 colors.signalcircle_border = 0x84c5e1ff; // 0.517, 0.772, 0.882, 1.0
123 colors.signalcircle = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0 // also used with a = 0.9
124 colors.diffusion = 0x4884a973; // 0.282, 0.517, 0.662, 0.45
125 colors.diffusion_inv = 0xff6b6b73; // 1.0, 0.419, 0.419, 0.45
126 colors.pos_outline = 0xffe7e7d9; // 1.0, 0.905, 0.905, 0.85
127 colors.pos_fill = 0xff6b6bd9; // 1.0, 0.419, 0.419, 0.85
128 colors.signal_outline = 0x84c5e1cc; // 0.517, 0.772, 0.882, 0.8
129 colors.signal_fill = 0x4884a9bf; // 0.282, 0.517, 0.662, 0.75
130 colors.speaker_fill = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0
131 colors.text = 0x84c5e1e6; // 0.517, 0.772, 0.882, 0.9
135 Panner2d::color_handler ()
142 Panner2d::reset (uint32_t n_inputs)
144 uint32_t nouts = panner_shell->panner()->out().n_audio();
148 while (signals.size() < n_inputs) {
149 add_signal ("", AngularVector());
152 if (signals.size() > n_inputs) {
153 for (uint32_t i = signals.size(); i < n_inputs; ++i) {
157 signals.resize (n_inputs);
162 for (uint32_t i = 0; i < n_inputs; ++i) {
163 signals[i]->position = panner_shell->panner()->signal_position (i);
166 /* add all outputs */
168 while (speakers.size() < nouts) {
169 add_speaker (AngularVector());
172 if (speakers.size() > nouts) {
173 for (uint32_t i = nouts; i < speakers.size(); ++i) {
177 speakers.resize (nouts);
180 for (Targets::iterator x = speakers.begin(); x != speakers.end(); ++x) {
181 (*x)->visible = false;
184 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
186 for (uint32_t n = 0; n < nouts; ++n) {
189 snprintf (buf, sizeof (buf), "%d", n+1);
190 speakers[n]->set_text (buf);
191 speakers[n]->position = the_speakers[n].angles();
192 speakers[n]->visible = true;
199 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
201 width = alloc.get_width();
202 height = alloc.get_height();
204 if (height > large_size_threshold) {
205 border = large_border_width;
207 border = small_border_width;
210 radius = min (width, height);
213 radius = rint(radius) + .5;
215 hoffset = max ((double) (width - height), border);
216 voffset = max ((double) (height - width), border);
218 hoffset = rint(hoffset / 2.0);
219 voffset = rint(voffset / 2.0);
221 DrawingArea::on_size_allocate (alloc);
225 Panner2d::add_signal (const char* text, const AngularVector& a)
227 Target* signal = new Target (a, text);
228 signals.push_back (signal);
229 signal->visible = true;
235 Panner2d::add_speaker (const AngularVector& a)
237 Target* speaker = new Target (a, "");
238 speakers.push_back (speaker);
239 speaker->visible = true;
242 return speakers.size() - 1;
246 Panner2d::handle_state_change ()
248 panner_connections.drop_connections();
249 if (!panner_shell->panner()) {
253 panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
255 set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
256 set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
257 bool elev = have_elevation;
258 have_elevation = (p == params.end()) ? false : true;
259 if (elev != have_elevation) {
260 handle_position_change();
266 Panner2d::label_signals ()
268 uint32_t sz = signals.size();
275 signals[0]->set_text ("");
279 signals[0]->set_text (S_("Panner|L"));
280 signals[1]->set_text (S_("Panner|R"));
284 for (uint32_t i = 0; i < sz; ++i) {
286 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
287 signals[i]->set_text (buf);
294 Panner2d::handle_position_change ()
297 double w = panner_shell->pannable()->pan_width_control->get_value();
299 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
300 panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
302 for (uint32_t i = 0; i < signals.size(); ++i) {
303 signals[i]->position = panner_shell->panner()->signal_position (i);
306 if (w * last_width <= 0) {
313 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
315 for (n = 0; n < speakers.size(); ++n) {
316 speakers[n]->position = the_speakers[n].angles();
323 Panner2d::move_signal (int which, const AngularVector& a)
325 if (which >= int (speakers.size())) {
329 speakers[which]->position = a;
334 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
339 float best_distance = FLT_MAX;
342 /* start with the position itself */
344 PBD::AngularVector dp = position.position;
345 if (!have_elevation) dp.ele = 0;
346 dp.azi = 270 - dp.azi;
350 best_distance = sqrt ((c.x - x) * (c.x - x) +
351 (c.y - y) * (c.y - y));
354 #if 0 // TODO signal grab -> change width, not position
355 for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
358 candidate->position.cartesian (c);
361 distance = sqrt ((c.x - x) * (c.x - x) +
362 (c.y - y) * (c.y - y));
364 if (distance < best_distance) {
366 best_distance = distance;
373 if (height > large_size_threshold) {
375 if (best_distance > 30) { // arbitrary
380 if (best_distance > 10) { // arbitrary
385 /* if we didn't find a signal close by, check the speakers */
388 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
390 PBD::AngularVector sp = candidate->position;
391 sp.azi = 270 -sp.azi;
396 distance = sqrt ((c.x - x) * (c.x - x) +
397 (c.y - y) * (c.y - y));
399 if (distance < best_distance) {
401 best_distance = distance;
405 if (height > large_size_threshold) {
407 if (best_distance < 30) { // arbitrary
414 if (best_distance < 10) { // arbitrary
426 Panner2d::set_send_drawing_mode (bool onoff)
428 if (_send_mode != onoff) {
435 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
438 GdkModifierType state;
441 gdk_window_get_pointer (ev->window, &x, &y, &state);
443 x = (int) floor (ev->x);
444 y = (int) floor (ev->y);
445 state = (GdkModifierType) ev->state;
448 if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
452 return handle_motion (x, y, state);
455 #define CSSRGBA(CL) \
456 cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(CL), UINT_RGBA_G_FLT(CL), UINT_RGBA_B_FLT(CL), UINT_RGBA_A_FLT(CL));
458 #define CSSRGB(CL, A) \
459 cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(CL), UINT_RGBA_G_FLT(CL), UINT_RGBA_B_FLT(CL), A);
461 Panner2d::on_expose_event (GdkEventExpose *event)
465 bool xsmall = (height <= large_size_threshold);
466 const double diameter = radius*2.0;
468 cr = gdk_cairo_create (get_window()->gobj());
472 cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
474 uint32_t bg = colors.background;
476 bg = UIConfiguration::instance().color ("send bg");
479 if (!panner_shell->bypassed()) {
484 cairo_fill_preserve (cr);
487 /* offset to give us some border */
489 cairo_translate (cr, hoffset, voffset);
491 cairo_set_line_width (cr, 1.0);
493 /* horizontal line of "crosshairs" */
495 CSSRGBA(colors.crosshairs);
496 cairo_move_to (cr, 0.0, radius);
497 cairo_line_to (cr, diameter, radius);
500 /* vertical line of "crosshairs" */
502 cairo_move_to (cr, radius, 0);
503 cairo_line_to (cr, radius, diameter);
506 /* the circle on which signals live */
508 cairo_set_line_width (cr, 1.5);
509 CSSRGBA(colors.signalcircle_border);
510 cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
513 for (uint32_t rad = 15; rad < 90; rad += 15) {
514 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
516 CSSRGBA(colors.signalcircle);
518 CSSRGB(colors.signalcircle, 0.9);
521 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
525 if (!panner_shell->bypassed()) {
526 /* convention top == front ^= azimuth == .5 (same as stereo/mono panners) */
528 if (signals.size() > 1) {
529 /* arc to show "diffusion" */
531 double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
532 double position_angle = panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
535 cairo_translate (cr, radius, radius);
536 cairo_rotate (cr, M_PI / 2.0);
537 cairo_rotate (cr, position_angle - (width_angle/2.0));
538 cairo_move_to (cr, 0, 0);
539 cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
540 cairo_close_path (cr);
541 if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
543 CSSRGBA(colors.diffusion);
546 CSSRGBA(colors.diffusion_inv);
554 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
559 cairo_set_font_size (cr, 10);
565 PBD::AngularVector dp = position.position;
566 if (!have_elevation) dp.ele = 0;
567 dp.azi = 270 - dp.azi;
572 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
573 CSSRGBA(colors.pos_fill);
574 cairo_fill_preserve (cr);
575 CSSRGBA(colors.pos_outline);
580 if (signals.size() > 0) {
581 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
584 if (signal->visible) {
586 /* TODO check for overlap - multiple src at same position
587 * -> visualize it properly
589 PBD::AngularVector sp = signal->position;
590 if (!have_elevation) sp.ele = 0;
596 cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
597 CSSRGBA(colors.signal_fill);
598 cairo_fill_preserve (cr);
599 CSSRGBA(colors.signal_outline);
602 if (!xsmall && !signal->text.empty()) {
603 CSSRGBA(colors.text);
604 /* the +/- adjustments are a hack to try to center the text in the circle
605 * TODO use pango get_pixel_size() -- see mono_panner.cc
608 cairo_move_to (cr, c.x - 1, c.y + 1);
610 cairo_move_to (cr, c.x - 4, c.y + 4);
612 cairo_show_text (cr, signal->text.c_str());
622 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
623 Target *speaker = *i;
627 if (speaker->visible) {
629 PBD::AngularVector sp = speaker->position;
635 snprintf (buf, sizeof (buf), "%d", n);
637 /* stroke out a speaker shape */
639 cairo_move_to (cr, c.x, c.y);
641 cairo_rotate (cr, -(sp.azi/360.0) * (2.0 * M_PI));
643 cairo_scale (cr, 0.8, 0.8);
645 cairo_scale (cr, 1.2, 1.2);
647 cairo_rel_line_to (cr, 4, -2);
648 cairo_rel_line_to (cr, 0, -7);
649 cairo_rel_line_to (cr, 5, +5);
650 cairo_rel_line_to (cr, 5, 0);
651 cairo_rel_line_to (cr, 0, 5);
652 cairo_rel_line_to (cr, -5, 0);
653 cairo_rel_line_to (cr, -5, +5);
654 cairo_rel_line_to (cr, 0, -7);
655 cairo_close_path (cr);
656 CSSRGBA(colors.speaker_fill);
661 cairo_set_font_size (cr, 16);
663 /* move the text in just a bit */
665 AngularVector textpos (speaker->position.azi + 270.0, speaker->position.ele, 0.85);
667 textpos.cartesian (c);
669 cairo_move_to (cr, c.x, c.y);
670 cairo_show_text (cr, buf);
683 Panner2d::on_button_press_event (GdkEventButton *ev)
685 GdkModifierType state;
690 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
696 switch (ev->button) {
702 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
704 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
707 drag_target->set_selected (true);
711 state = (GdkModifierType) ev->state;
712 return handle_motion (ev->x, ev->y, state);
723 Panner2d::on_button_release_event (GdkEventButton *ev)
726 GdkModifierType state;
729 switch (ev->button) {
731 x = (int) floor (ev->x);
732 y = (int) floor (ev->y);
733 state = (GdkModifierType) ev->state;
734 ret = handle_motion (x, y, state);
739 x = (int) floor (ev->x);
740 y = (int) floor (ev->y);
741 state = (GdkModifierType) ev->state;
743 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
747 ret = handle_motion (x, y, state);
762 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
764 if (drag_target == 0) {
768 if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
775 if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
777 bool need_move = false;
779 drag_target->position.cartesian (c);
782 if ((evx != c.x) || (evy != c.y)) {
787 CartesianVector cp (evx, evy, 0.0);
791 if (!have_elevation) {
792 clamp_to_circle (cp.x, cp.y);
794 av.azi = fmod(270 - av.azi, 360);
795 if (drag_target == &position) {
796 double degree_fract = av.azi / 360.0;
797 panner_shell->panner()->set_position (degree_fract);
800 /* sphere projection */
801 sphere_project (cp.x, cp.y, cp.z);
803 double r2d = 180.0 / M_PI;
804 av.azi = r2d * atan2(cp.y, cp.x);
805 av.ele = r2d * asin(cp.z);
806 av.azi = fmod(270 - av.azi, 360);
808 if (drag_target == &position) {
809 double azi_fract = av.azi / 360.0;
810 double ele_fract = av.ele / 90.0;
811 panner_shell->panner()->set_position (azi_fract);
812 panner_shell->panner()->set_elevation (ele_fract);
822 Panner2d::on_scroll_event (GdkEventScroll* ev)
824 switch (ev->direction) {
826 case GDK_SCROLL_RIGHT:
827 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
830 case GDK_SCROLL_DOWN:
831 case GDK_SCROLL_LEFT:
832 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
839 Panner2d::cart_to_gtk (CartesianVector& c) const
841 /* cartesian coordinate space:
843 dimension = 2.0 * 2.0
844 increasing y moves up
845 so max values along each axis are -1..+1
847 GTK uses a coordinate space that is:
849 dimension = (radius*2.0) * (radius*2.0)
850 increasing y moves down
852 const double diameter = radius*2.0;
854 c.x = diameter * ((c.x + 1.0) / 2.0);
855 /* extra subtraction inverts the y-axis to match "increasing y moves down" */
856 c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
860 Panner2d::gtk_to_cart (CartesianVector& c) const
862 const double diameter = radius*2.0;
863 c.x = ((c.x / diameter) * 2.0) - 1.0;
864 c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
868 Panner2d::sphere_project (double& x, double& y, double& z)
883 Panner2d::clamp_to_circle (double& x, double& y)
888 PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
889 PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
893 Panner2d::toggle_bypass ()
895 panner_shell->set_bypassed (!panner_shell->bypassed());
898 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
899 : ArdourWindow (_("Panner (2D)"))
901 , bypass_button (_("Bypass"))
902 , width_adjustment (0, -100, 100, 1, 5, 0)
903 , width_spinner (width_adjustment)
905 widget.set_name ("MixerPanZone");
907 set_title (_("Panner"));
908 widget.set_size_request (h, h);
910 bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
911 width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
913 p->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
914 /* needed for the width-spinbox in the main window */
915 p->PannableChanged.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::pannable_handler, this), gui_context());
916 p->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
919 button_box.set_spacing (6);
920 button_box.pack_start (bypass_button, false, false);
922 left_side.set_spacing (6);
924 left_side.pack_start (button_box, false, false);
926 Gtk::Label* l = manage (new Label (
927 p->panner()->describe_parameter(PanWidthAutomation),
928 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
929 spinner_box.pack_start (*l, false, false);
930 spinner_box.pack_start (width_spinner, false, false);
931 left_side.pack_start (spinner_box, false, false);
934 bypass_button.show ();
936 width_spinner.show ();
940 hpacker.set_spacing (6);
941 hpacker.set_border_width (12);
942 hpacker.pack_start (widget, false, false);
943 hpacker.pack_start (left_side, false, false);
954 Panner2dWindow::reset (uint32_t n_inputs)
956 widget.reset (n_inputs);
960 Panner2dWindow::bypass_toggled ()
962 bool view = bypass_button.get_active ();
963 bool model = widget.get_panner_shell()->bypassed ();
966 widget.get_panner_shell()->set_bypassed (view);
970 Panner2dWindow::width_changed ()
972 float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
973 float view = width_spinner.get_value() / 100.0;
975 widget.get_panner_shell()->panner()->set_width (view);
980 Panner2dWindow::pannable_handler ()
982 panvalue_connections.drop_connections();
983 widget.get_panner_shell()->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
988 Panner2dWindow::set_bypassed ()
990 bool view = bypass_button.get_active ();
991 bool model = widget.get_panner_shell()->bypassed ();
993 bypass_button.set_active(model);
996 set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
997 set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
998 if (p == params.end()) {
999 spinner_box.set_sensitive(false);
1001 spinner_box.set_sensitive(true);
1006 Panner2dWindow::set_width ()
1008 // rounding of spinbox is different from slider -- TODO use slider
1009 float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
1010 float view = (width_spinner.get_value());
1011 if (model != view) {
1012 width_spinner.set_value (model);
1017 Panner2dWindow::on_key_press_event (GdkEventKey* event)
1019 return relay_key_press (event, this);
1023 Panner2dWindow::on_key_release_event (GdkEventKey*)