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) {
114 Panner2d::set_colors ()
116 // TODO get all colors from theme, resolve dups
117 colors.background = UIConfiguration::instance().color ("mono panner bg");
118 colors.crosshairs = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0
119 colors.signalcircle_border = 0x84c5e1ff; // 0.517, 0.772, 0.882, 1.0
120 colors.signalcircle = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0 // also used with a = 0.9
121 colors.diffusion = 0x4884a973; // 0.282, 0.517, 0.662, 0.45
122 colors.diffusion_inv = 0xff6b6b73; // 1.0, 0.419, 0.419, 0.45
123 colors.pos_outline = 0xffe7e7d9; // 1.0, 0.905, 0.905, 0.85
124 colors.pos_fill = 0xff6b6bd9; // 1.0, 0.419, 0.419, 0.85
125 colors.signal_outline = 0x84c5e1cc; // 0.517, 0.772, 0.882, 0.8
126 colors.signal_fill = 0x4884a9bf; // 0.282, 0.517, 0.662, 0.75
127 colors.speaker_fill = 0x4884a9ff; // 0.282, 0.517, 0.662, 1.0
128 colors.text = 0x84c5e1e6; // 0.517, 0.772, 0.882, 0.9
132 Panner2d::color_handler ()
139 Panner2d::reset (uint32_t n_inputs)
141 uint32_t nouts = panner_shell->panner()->out().n_audio();
145 while (signals.size() < n_inputs) {
146 add_signal ("", AngularVector());
149 if (signals.size() > n_inputs) {
150 for (uint32_t i = signals.size(); i < n_inputs; ++i) {
154 signals.resize (n_inputs);
159 for (uint32_t i = 0; i < n_inputs; ++i) {
160 signals[i]->position = panner_shell->panner()->signal_position (i);
163 /* add all outputs */
165 while (speakers.size() < nouts) {
166 add_speaker (AngularVector());
169 if (speakers.size() > nouts) {
170 for (uint32_t i = nouts; i < speakers.size(); ++i) {
174 speakers.resize (nouts);
177 for (Targets::iterator x = speakers.begin(); x != speakers.end(); ++x) {
178 (*x)->visible = false;
181 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
183 for (uint32_t n = 0; n < nouts; ++n) {
186 snprintf (buf, sizeof (buf), "%d", n+1);
187 speakers[n]->set_text (buf);
188 speakers[n]->position = the_speakers[n].angles();
189 speakers[n]->visible = true;
196 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
198 width = alloc.get_width();
199 height = alloc.get_height();
201 if (height > large_size_threshold) {
202 border = large_border_width;
204 border = small_border_width;
207 radius = min (width, height);
210 radius = rint(radius) + .5;
212 hoffset = max ((double) (width - height), border);
213 voffset = max ((double) (height - width), border);
215 hoffset = rint(hoffset / 2.0);
216 voffset = rint(voffset / 2.0);
218 DrawingArea::on_size_allocate (alloc);
222 Panner2d::add_signal (const char* text, const AngularVector& a)
224 Target* signal = new Target (a, text);
225 signals.push_back (signal);
226 signal->visible = true;
232 Panner2d::add_speaker (const AngularVector& a)
234 Target* speaker = new Target (a, "");
235 speakers.push_back (speaker);
236 speaker->visible = true;
239 return speakers.size() - 1;
243 Panner2d::handle_state_change ()
245 panner_connections.drop_connections();
246 if (!panner_shell->panner()) {
250 panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
252 set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
253 set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
254 bool elev = have_elevation;
255 have_elevation = (p == params.end()) ? false : true;
256 if (elev != have_elevation) {
257 handle_position_change();
263 Panner2d::label_signals ()
265 uint32_t sz = signals.size();
272 signals[0]->set_text ("");
276 signals[0]->set_text (S_("Panner|L"));
277 signals[1]->set_text (S_("Panner|R"));
281 for (uint32_t i = 0; i < sz; ++i) {
283 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
284 signals[i]->set_text (buf);
291 Panner2d::handle_position_change ()
294 double w = panner_shell->pannable()->pan_width_control->get_value();
296 position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
297 panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
299 for (uint32_t i = 0; i < signals.size(); ++i) {
300 signals[i]->position = panner_shell->panner()->signal_position (i);
303 if (w * last_width <= 0) {
310 vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
312 for (n = 0; n < speakers.size(); ++n) {
313 speakers[n]->position = the_speakers[n].angles();
320 Panner2d::move_signal (int which, const AngularVector& a)
322 if (which >= int (speakers.size())) {
326 speakers[which]->position = a;
331 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
336 float best_distance = FLT_MAX;
339 /* start with the position itself */
341 PBD::AngularVector dp = position.position;
342 if (!have_elevation) dp.ele = 0;
343 dp.azi = 270 - dp.azi;
347 best_distance = sqrt ((c.x - x) * (c.x - x) +
348 (c.y - y) * (c.y - y));
351 #if 0 // TODO signal grab -> change width, not position
352 for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
355 candidate->position.cartesian (c);
358 distance = sqrt ((c.x - x) * (c.x - x) +
359 (c.y - y) * (c.y - y));
361 if (distance < best_distance) {
363 best_distance = distance;
370 if (height > large_size_threshold) {
372 if (best_distance > 30) { // arbitrary
377 if (best_distance > 10) { // arbitrary
382 /* if we didn't find a signal close by, check the speakers */
385 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
387 PBD::AngularVector sp = candidate->position;
388 sp.azi = 270 -sp.azi;
393 distance = sqrt ((c.x - x) * (c.x - x) +
394 (c.y - y) * (c.y - y));
396 if (distance < best_distance) {
398 best_distance = distance;
402 if (height > large_size_threshold) {
404 if (best_distance < 30) { // arbitrary
411 if (best_distance < 10) { // arbitrary
423 Panner2d::set_send_drawing_mode (bool onoff)
425 if (_send_mode != onoff) {
432 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
435 GdkModifierType state;
438 gdk_window_get_pointer (ev->window, &x, &y, &state);
440 x = (int) floor (ev->x);
441 y = (int) floor (ev->y);
442 state = (GdkModifierType) ev->state;
445 if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
449 return handle_motion (x, y, state);
452 #define CSSRGBA(CL) \
453 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));
455 #define CSSRGB(CL, A) \
456 cairo_set_source_rgba (cr, UINT_RGBA_R_FLT(CL), UINT_RGBA_G_FLT(CL), UINT_RGBA_B_FLT(CL), A);
458 Panner2d::on_expose_event (GdkEventExpose *event)
462 bool xsmall = (height <= large_size_threshold);
463 const double diameter = radius*2.0;
465 cr = gdk_cairo_create (get_window()->gobj());
469 cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
471 uint32_t bg = colors.background;
473 bg = UIConfiguration::instance().color ("send bg");
476 if (!panner_shell->bypassed()) {
481 cairo_fill_preserve (cr);
484 /* offset to give us some border */
486 cairo_translate (cr, hoffset, voffset);
488 cairo_set_line_width (cr, 1.0);
490 /* horizontal line of "crosshairs" */
492 CSSRGBA(colors.crosshairs);
493 cairo_move_to (cr, 0.0, radius);
494 cairo_line_to (cr, diameter, radius);
497 /* vertical line of "crosshairs" */
499 cairo_move_to (cr, radius, 0);
500 cairo_line_to (cr, radius, diameter);
503 /* the circle on which signals live */
505 cairo_set_line_width (cr, 1.5);
506 CSSRGBA(colors.signalcircle_border);
507 cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
510 for (uint32_t rad = 15; rad < 90; rad += 15) {
511 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
513 CSSRGBA(colors.signalcircle);
515 CSSRGB(colors.signalcircle, 0.9);
518 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
522 if (!panner_shell->bypassed()) {
523 /* convention top == front ^= azimuth == .5 (same as stereo/mono panners) */
525 if (signals.size() > 1) {
526 /* arc to show "diffusion" */
528 double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
529 double position_angle = panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
532 cairo_translate (cr, radius, radius);
533 cairo_rotate (cr, M_PI / 2.0);
534 cairo_rotate (cr, position_angle - (width_angle/2.0));
535 cairo_move_to (cr, 0, 0);
536 cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
537 cairo_close_path (cr);
538 if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
540 CSSRGBA(colors.diffusion);
543 CSSRGBA(colors.diffusion_inv);
551 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
556 cairo_set_font_size (cr, 10);
562 PBD::AngularVector dp = position.position;
563 if (!have_elevation) dp.ele = 0;
564 dp.azi = 270 - dp.azi;
569 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
570 CSSRGBA(colors.pos_fill);
571 cairo_fill_preserve (cr);
572 CSSRGBA(colors.pos_outline);
577 if (signals.size() > 0) {
578 for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
581 if (signal->visible) {
583 /* TODO check for overlap - multiple src at same position
584 * -> visualize it properly
586 PBD::AngularVector sp = signal->position;
587 if (!have_elevation) sp.ele = 0;
593 cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
594 CSSRGBA(colors.signal_fill);
595 cairo_fill_preserve (cr);
596 CSSRGBA(colors.signal_outline);
599 if (!xsmall && !signal->text.empty()) {
600 CSSRGBA(colors.text);
601 /* the +/- adjustments are a hack to try to center the text in the circle
602 * TODO use pango get_pixel_size() -- see mono_panner.cc
605 cairo_move_to (cr, c.x - 1, c.y + 1);
607 cairo_move_to (cr, c.x - 4, c.y + 4);
609 cairo_show_text (cr, signal->text.c_str());
619 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
620 Target *speaker = *i;
624 if (speaker->visible) {
626 PBD::AngularVector sp = speaker->position;
632 snprintf (buf, sizeof (buf), "%d", n);
634 /* stroke out a speaker shape */
636 cairo_move_to (cr, c.x, c.y);
638 cairo_rotate (cr, -(sp.azi/360.0) * (2.0 * M_PI));
640 cairo_scale (cr, 0.8, 0.8);
642 cairo_scale (cr, 1.2, 1.2);
644 cairo_rel_line_to (cr, 4, -2);
645 cairo_rel_line_to (cr, 0, -7);
646 cairo_rel_line_to (cr, 5, +5);
647 cairo_rel_line_to (cr, 5, 0);
648 cairo_rel_line_to (cr, 0, 5);
649 cairo_rel_line_to (cr, -5, 0);
650 cairo_rel_line_to (cr, -5, +5);
651 cairo_rel_line_to (cr, 0, -7);
652 cairo_close_path (cr);
653 CSSRGBA(colors.speaker_fill);
658 cairo_set_font_size (cr, 16);
660 /* move the text in just a bit */
662 AngularVector textpos (speaker->position.azi + 270.0, speaker->position.ele, 0.85);
664 textpos.cartesian (c);
666 cairo_move_to (cr, c.x, c.y);
667 cairo_show_text (cr, buf);
680 Panner2d::on_button_press_event (GdkEventButton *ev)
682 GdkModifierType state;
687 if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
693 switch (ev->button) {
699 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
701 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
704 drag_target->set_selected (true);
708 state = (GdkModifierType) ev->state;
709 return handle_motion (ev->x, ev->y, state);
720 Panner2d::on_button_release_event (GdkEventButton *ev)
723 GdkModifierType state;
726 switch (ev->button) {
728 x = (int) floor (ev->x);
729 y = (int) floor (ev->y);
730 state = (GdkModifierType) ev->state;
731 ret = handle_motion (x, y, state);
736 x = (int) floor (ev->x);
737 y = (int) floor (ev->y);
738 state = (GdkModifierType) ev->state;
740 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
744 ret = handle_motion (x, y, state);
759 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
761 if (drag_target == 0) {
765 if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
772 if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
774 bool need_move = false;
776 drag_target->position.cartesian (c);
779 if ((evx != c.x) || (evy != c.y)) {
784 CartesianVector cp (evx, evy, 0.0);
788 if (!have_elevation) {
789 clamp_to_circle (cp.x, cp.y);
791 av.azi = fmod(270 - av.azi, 360);
792 if (drag_target == &position) {
793 double degree_fract = av.azi / 360.0;
794 panner_shell->panner()->set_position (degree_fract);
797 /* sphere projection */
798 sphere_project (cp.x, cp.y, cp.z);
800 double r2d = 180.0 / M_PI;
801 av.azi = r2d * atan2(cp.y, cp.x);
802 av.ele = r2d * asin(cp.z);
803 av.azi = fmod(270 - av.azi, 360);
805 if (drag_target == &position) {
806 double azi_fract = av.azi / 360.0;
807 double ele_fract = av.ele / 90.0;
808 panner_shell->panner()->set_position (azi_fract);
809 panner_shell->panner()->set_elevation (ele_fract);
819 Panner2d::on_scroll_event (GdkEventScroll* ev)
821 switch (ev->direction) {
823 case GDK_SCROLL_RIGHT:
824 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
827 case GDK_SCROLL_DOWN:
828 case GDK_SCROLL_LEFT:
829 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
836 Panner2d::cart_to_gtk (CartesianVector& c) const
838 /* cartesian coordinate space:
840 dimension = 2.0 * 2.0
841 increasing y moves up
842 so max values along each axis are -1..+1
844 GTK uses a coordinate space that is:
846 dimension = (radius*2.0) * (radius*2.0)
847 increasing y moves down
849 const double diameter = radius*2.0;
851 c.x = diameter * ((c.x + 1.0) / 2.0);
852 /* extra subtraction inverts the y-axis to match "increasing y moves down" */
853 c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
857 Panner2d::gtk_to_cart (CartesianVector& c) const
859 const double diameter = radius*2.0;
860 c.x = ((c.x / diameter) * 2.0) - 1.0;
861 c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
865 Panner2d::sphere_project (double& x, double& y, double& z)
880 Panner2d::clamp_to_circle (double& x, double& y)
885 PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
886 PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
890 Panner2d::toggle_bypass ()
892 panner_shell->set_bypassed (!panner_shell->bypassed());
895 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
896 : ArdourWindow (_("Panner (2D)"))
898 , bypass_button (_("Bypass"))
899 , width_adjustment (0, -100, 100, 1, 5, 0)
900 , width_spinner (width_adjustment)
902 widget.set_name ("MixerPanZone");
904 set_title (_("Panner"));
905 widget.set_size_request (h, h);
907 bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
908 width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
910 p->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
911 /* needed for the width-spinbox in the main window */
912 p->PannableChanged.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::pannable_handler, this), gui_context());
913 p->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
916 button_box.set_spacing (6);
917 button_box.pack_start (bypass_button, false, false);
919 left_side.set_spacing (6);
921 left_side.pack_start (button_box, false, false);
923 Gtk::Label* l = manage (new Label (
924 p->panner()->describe_parameter(PanWidthAutomation),
925 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
926 spinner_box.pack_start (*l, false, false);
927 spinner_box.pack_start (width_spinner, false, false);
928 left_side.pack_start (spinner_box, false, false);
931 bypass_button.show ();
933 width_spinner.show ();
937 hpacker.set_spacing (6);
938 hpacker.set_border_width (12);
939 hpacker.pack_start (widget, false, false);
940 hpacker.pack_start (left_side, false, false);
951 Panner2dWindow::reset (uint32_t n_inputs)
953 widget.reset (n_inputs);
957 Panner2dWindow::bypass_toggled ()
959 bool view = bypass_button.get_active ();
960 bool model = widget.get_panner_shell()->bypassed ();
963 widget.get_panner_shell()->set_bypassed (view);
967 Panner2dWindow::width_changed ()
969 float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
970 float view = width_spinner.get_value() / 100.0;
972 widget.get_panner_shell()->panner()->set_width (view);
977 Panner2dWindow::pannable_handler ()
979 panvalue_connections.drop_connections();
980 widget.get_panner_shell()->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
985 Panner2dWindow::set_bypassed ()
987 bool view = bypass_button.get_active ();
988 bool model = widget.get_panner_shell()->bypassed ();
990 bypass_button.set_active(model);
993 set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
994 set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
995 if (p == params.end()) {
996 spinner_box.set_sensitive(false);
998 spinner_box.set_sensitive(true);
1003 Panner2dWindow::set_width ()
1005 // rounding of spinbox is different from slider -- TODO use slider
1006 float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
1007 float view = (width_spinner.get_value());
1008 if (model != view) {
1009 width_spinner.set_value (model);
1014 Panner2dWindow::on_key_press_event (GdkEventKey* event)
1016 return relay_key_press (event, &PublicEditor::instance());
1020 Panner2dWindow::on_key_release_event (GdkEventKey*)