Fix some capitalisation in the preferences dialog.
[ardour.git] / gtk2_ardour / panner2d.cc
1 /*
2     Copyright (C) 2002 Paul Davis
3
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.
8
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.
13
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.
17
18 */
19
20 #include <cmath>
21 #include <climits>
22 #include <string.h>
23
24 #include <cairo.h>
25 #include <gtkmm/menu.h>
26
27 #include "gtkmm2ext/gtk_ui.h"
28
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"
35
36 #include "panner2d.h"
37 #include "keyboard.h"
38 #include "gui_thread.h"
39 #include "utils.h"
40 #include "public_editor.h"
41
42 #include "i18n.h"
43
44 using namespace std;
45 using namespace Gtk;
46 using namespace ARDOUR;
47 using namespace PBD;
48 using Gtkmm2ext::Keyboard;
49
50 static const int large_size_threshold = 100;
51 static const int large_border_width = 25;
52 static const int small_border_width = 8;
53
54 Panner2d::Target::Target (const AngularVector& a, const char *txt)
55         : position (a)
56         , text (txt)
57         , _selected (false)
58 {
59 }
60
61 Panner2d::Target::~Target ()
62 {
63 }
64
65 void
66 Panner2d::Target::set_text (const char* txt)
67 {
68         text = txt;
69 }
70
71 Panner2d::Panner2d (boost::shared_ptr<PannerShell> p, int32_t h)
72 : panner_shell (p)
73         , position (AngularVector (0.0, 0.0), "")
74         , width (0)
75         , height (h)
76         , last_width (0)
77         , have_elevation (false)
78 {
79         panner_shell->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2d::handle_state_change, this), gui_context());
80
81         panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
82
83         drag_target = 0;
84         set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
85
86         handle_state_change ();
87         handle_position_change ();
88 }
89
90 Panner2d::~Panner2d()
91 {
92         for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
93                 delete *i;
94         }
95 }
96
97 void
98 Panner2d::reset (uint32_t n_inputs)
99 {
100         uint32_t nouts = panner_shell->panner()->out().n_audio();
101
102         /* signals */
103
104         while (signals.size() < n_inputs) {
105                 add_signal ("", AngularVector());
106         }
107
108         if (signals.size() > n_inputs) {
109                 for (uint32_t i = signals.size(); i < n_inputs; ++i) {
110                         delete signals[i];
111                 }
112
113                 signals.resize (n_inputs);
114         }
115
116         label_signals ();
117
118         for (uint32_t i = 0; i < n_inputs; ++i) {
119                 signals[i]->position = panner_shell->panner()->signal_position (i);
120         }
121
122         /* add all outputs */
123
124         while (speakers.size() < nouts) {
125                 add_speaker (AngularVector());
126         }
127
128         if (speakers.size() > nouts) {
129                 for (uint32_t i = nouts; i < speakers.size(); ++i) {
130                         delete speakers[i];
131                 }
132
133                 speakers.resize (nouts);
134         }
135
136         for (Targets::iterator x = speakers.begin(); x != speakers.end(); ++x) {
137                 (*x)->visible = false;
138         }
139
140         vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
141
142         for (uint32_t n = 0; n < nouts; ++n) {
143                 char buf[16];
144
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;
149         }
150
151         queue_draw ();
152 }
153
154 void
155 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
156 {
157         width = alloc.get_width();
158         height = alloc.get_height();
159
160         if (height > large_size_threshold) {
161                 border = large_border_width;
162         } else {
163                 border = small_border_width;
164         }
165
166         radius = min (width, height);
167         radius -= border;
168         radius /= 2;
169         radius = rint(radius) + .5;
170
171         hoffset = max ((double) (width - height), border);
172         voffset = max ((double) (height - width), border);
173
174         hoffset = rint(hoffset / 2.0);
175         voffset = rint(voffset / 2.0);
176
177         DrawingArea::on_size_allocate (alloc);
178 }
179
180 int
181 Panner2d::add_signal (const char* text, const AngularVector& a)
182 {
183         Target* signal = new Target (a, text);
184         signals.push_back (signal);
185         signal->visible = true;
186
187         return 0;
188 }
189
190 int
191 Panner2d::add_speaker (const AngularVector& a)
192 {
193         Target* speaker = new Target (a, "");
194         speakers.push_back (speaker);
195         speaker->visible = true;
196         queue_draw ();
197
198         return speakers.size() - 1;
199 }
200
201 void
202 Panner2d::handle_state_change ()
203 {
204         panner_connections.drop_connections();
205         if (!panner_shell->panner()) {
206                 return;
207         }
208
209         panner_shell->panner()->SignalPositionChanged.connect (panner_connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
210
211         set<Evoral::Parameter> params = panner_shell->panner()->what_can_be_automated();
212         set<Evoral::Parameter>::iterator p = params.find(PanElevationAutomation);
213         bool elev = have_elevation;
214         have_elevation = (p == params.end()) ? false : true;
215         if (elev != have_elevation) {
216                 handle_position_change();
217         }
218         queue_draw ();
219 }
220
221 void
222 Panner2d::label_signals ()
223 {
224         uint32_t sz = signals.size();
225
226         switch (sz) {
227                 case 0:
228                         break;
229
230                 case 1:
231                         signals[0]->set_text ("");
232                         break;
233
234                 case 2:
235                         signals[0]->set_text (_("L"));
236                         signals[1]->set_text (_("R"));
237                         break;
238
239                 default:
240                         for (uint32_t i = 0; i < sz; ++i) {
241                                 char buf[64];
242                                 snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
243                                 signals[i]->set_text (buf);
244                         }
245                         break;
246         }
247 }
248
249 void
250 Panner2d::handle_position_change ()
251 {
252         uint32_t n;
253         double w = panner_shell->pannable()->pan_width_control->get_value();
254
255         position.position = AngularVector (panner_shell->pannable()->pan_azimuth_control->get_value() * 360.0,
256                         panner_shell->pannable()->pan_elevation_control->get_value() * 90.0);
257
258         for (uint32_t i = 0; i < signals.size(); ++i) {
259                 signals[i]->position = panner_shell->panner()->signal_position (i);
260         }
261
262         if (w * last_width <= 0) {
263                 /* changed sign */
264                 label_signals ();
265         }
266
267         last_width = w;
268
269         vector<Speaker>& the_speakers (panner_shell->panner()->get_speakers()->speakers());
270
271         for (n = 0; n < speakers.size(); ++n) {
272                 speakers[n]->position = the_speakers[n].angles();
273         }
274
275         queue_draw ();
276 }
277
278 void
279 Panner2d::move_signal (int which, const AngularVector& a)
280 {
281         if (which >= int (speakers.size())) {
282                 return;
283         }
284
285         speakers[which]->position = a;
286         queue_draw ();
287 }
288
289 Panner2d::Target *
290 Panner2d::find_closest_object (gdouble x, gdouble y, bool& is_signal)
291 {
292         Target *closest = 0;
293         Target *candidate;
294         float distance;
295         float best_distance = FLT_MAX;
296         CartesianVector c;
297
298         /* start with the position itself */
299
300         PBD::AngularVector dp = position.position;
301         if (!have_elevation) dp.ele = 0;
302         dp.azi = 270 - dp.azi;
303         dp.cartesian (c);
304
305         cart_to_gtk (c);
306         best_distance = sqrt ((c.x - x) * (c.x - x) +
307                         (c.y - y) * (c.y - y));
308         closest = &position;
309
310 #if 0 // TODO signal grab -> change width, not position
311         for (Targets::const_iterator i = signals.begin(); i != signals.end(); ++i) {
312                 candidate = *i;
313
314                 candidate->position.cartesian (c);
315                 cart_to_gtk (c);
316
317                 distance = sqrt ((c.x - x) * (c.x - x) +
318                                 (c.y - y) * (c.y - y));
319
320                 if (distance < best_distance) {
321                         closest = candidate;
322                         best_distance = distance;
323                 }
324         }
325 #endif
326
327         is_signal = true;
328
329         if (height > large_size_threshold) {
330                 /* "big" */
331                 if (best_distance > 30) { // arbitrary
332                         closest = 0;
333                 }
334         } else {
335                 /* "small" */
336                 if (best_distance > 10) { // arbitrary
337                         closest = 0;
338                 }
339         }
340
341         /* if we didn't find a signal close by, check the speakers */
342
343         if (!closest) {
344                 for (Targets::const_iterator i = speakers.begin(); i != speakers.end(); ++i) {
345                         candidate = *i;
346                         PBD::AngularVector sp = candidate->position;
347                         sp.azi = 270 -sp.azi;
348                         CartesianVector c;
349                         sp.cartesian (c);
350                         cart_to_gtk (c);
351
352                         distance = sqrt ((c.x - x) * (c.x - x) +
353                                         (c.y - y) * (c.y - y));
354
355                         if (distance < best_distance) {
356                                 closest = candidate;
357                                 best_distance = distance;
358                         }
359                 }
360
361                 if (height > large_size_threshold) {
362                         /* "big" */
363                         if (best_distance < 30) { // arbitrary
364                                 is_signal = false;
365                         } else {
366                                 closest = 0;
367                         }
368                 } else {
369                         /* "small" */
370                         if (best_distance < 10) { // arbitrary
371                                 is_signal = false;
372                         } else {
373                                 closest = 0;
374                         }
375                 }
376         }
377
378         return closest;
379 }
380
381 bool
382 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
383 {
384         gint x, y;
385         GdkModifierType state;
386
387         if (ev->is_hint) {
388                 gdk_window_get_pointer (ev->window, &x, &y, &state);
389         } else {
390                 x = (int) floor (ev->x);
391                 y = (int) floor (ev->y);
392                 state = (GdkModifierType) ev->state;
393         }
394
395         if (ev->state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) {
396                 did_move = true;
397         }
398
399         return handle_motion (x, y, state);
400 }
401
402 bool
403 Panner2d::on_expose_event (GdkEventExpose *event)
404 {
405         CartesianVector c;
406         cairo_t* cr;
407         bool small = (height <= large_size_threshold);
408         const double diameter = radius*2.0;
409
410         cr = gdk_cairo_create (get_window()->gobj());
411
412         /* background */
413
414         cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
415         if (!panner_shell->bypassed()) {
416                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 1.0);
417         } else {
418                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 0.2);
419         }
420         cairo_fill_preserve (cr);
421         cairo_clip (cr);
422
423         /* offset to give us some border */
424
425         cairo_translate (cr, hoffset, voffset);
426
427         cairo_set_line_width (cr, 1.0);
428
429         /* horizontal line of "crosshairs" */
430
431         cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
432         cairo_move_to (cr, 0.0, radius);
433         cairo_line_to (cr, diameter, radius);
434         cairo_stroke (cr);
435
436         /* vertical line of "crosshairs" */
437
438         cairo_move_to (cr, radius, 0);
439         cairo_line_to (cr, radius, diameter);
440         cairo_stroke (cr);
441
442         /* the circle on which signals live */
443
444         cairo_set_line_width (cr, 1.5);
445         cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 1.0);
446         cairo_arc (cr, radius, radius, radius, 0.0, 2.0 * M_PI);
447         cairo_stroke (cr);
448
449         for (uint32_t rad = 15; rad < 90; rad += 15) {
450                 cairo_set_line_width (cr, .5 + (float)rad / 150.0);
451                 if (rad == 45) {
452                         cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
453                 } else {
454                         cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.8);
455                 }
456                 cairo_new_path (cr);
457                 cairo_arc (cr, radius, radius, radius * sin(M_PI * (float) rad / 180.0), 0, 2.0 * M_PI);
458                 cairo_stroke (cr);
459         }
460
461         if (!panner_shell->bypassed()) {
462                 /* convention top == front ^= azimuth == .5 (same as stereo/mono panners) */
463
464                 if (signals.size() > 1) {
465                         /* arc to show "diffusion" */
466
467                         double width_angle = fabs (panner_shell->pannable()->pan_width_control->get_value()) * 2 * M_PI;
468                         double position_angle = panner_shell->pannable()->pan_azimuth_control->get_value() * 2 * M_PI;
469
470                         cairo_save (cr);
471                         cairo_translate (cr, radius, radius);
472                         cairo_rotate (cr, M_PI / 2.0);
473                         cairo_rotate (cr, position_angle - (width_angle/2.0));
474                         cairo_move_to (cr, 0, 0);
475                         cairo_arc_negative (cr, 0, 0, radius, width_angle, 0.0);
476                         cairo_close_path (cr);
477                         if (panner_shell->pannable()->pan_width_control->get_value() >= 0.0) {
478                                 /* normal width */
479                                 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.45);
480                         } else {
481                                 /* inverse width */
482                                 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.45);
483                         }
484                         cairo_fill (cr);
485                         cairo_restore (cr);
486                 }
487
488                 double arc_radius;
489
490                 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
491
492                 if (small) {
493                         arc_radius = 4.0;
494                 } else {
495                         cairo_set_font_size (cr, 10);
496                         arc_radius = 12.0;
497                 }
498
499                 /* draw position */
500
501                 PBD::AngularVector dp = position.position;
502                 if (!have_elevation) dp.ele = 0;
503                 dp.azi = 270 - dp.azi;
504                 dp.cartesian (c);
505                 cart_to_gtk (c);
506
507                 cairo_new_path (cr);
508                 cairo_arc (cr, c.x, c.y, arc_radius + 1.0, 0, 2.0 * M_PI);
509                 cairo_set_source_rgba (cr, 1.0, 0.419, 0.419, 0.85);
510                 cairo_fill_preserve (cr);
511                 cairo_set_source_rgba (cr, 1.0, 0.905, 0.905, 0.85);
512                 cairo_stroke (cr);
513
514                 /* signals */
515
516                 if (signals.size() > 0) {
517                         for (Targets::iterator i = signals.begin(); i != signals.end(); ++i) {
518                                 Target* signal = *i;
519
520                                 if (signal->visible) {
521
522                                         /* TODO check for overlap - multiple src at same position
523                                          * -> visualize it properly
524                                          */
525                                         PBD::AngularVector sp = signal->position;
526                                         if (!have_elevation) sp.ele = 0;
527                                         sp.azi += 270.0;
528                                         sp.cartesian (c);
529                                         cart_to_gtk (c);
530
531                                         cairo_new_path (cr);
532                                         cairo_arc (cr, c.x, c.y, arc_radius, 0, 2.0 * M_PI);
533                                         cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 0.75);
534                                         cairo_fill_preserve (cr);
535                                         cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, 0.8);
536                                         cairo_stroke (cr);
537
538                                         if (!small && !signal->text.empty()) {
539                                                 cairo_set_source_rgba (cr, 0.517, 0.772, 0.882, .9);
540                                                 /* the +/- adjustments are a hack to try to center the text in the circle
541                                                  * TODO use pango get_pixel_size() -- see mono_panner.cc
542                                                  */
543                                                 if (small) {
544                                                         cairo_move_to (cr, c.x - 1, c.y + 1);
545                                                 } else {
546                                                         cairo_move_to (cr, c.x - 4, c.y + 4);
547                                                 }
548                                                 cairo_show_text (cr, signal->text.c_str());
549                                         }
550                                 }
551                         }
552                 }
553
554                 /* speakers */
555
556                 int n = 0;
557
558                 for (Targets::iterator i = speakers.begin(); i != speakers.end(); ++i) {
559                         Target *speaker = *i;
560                         char buf[256];
561                         ++n;
562
563                         if (speaker->visible) {
564
565                                 PBD::AngularVector sp = speaker->position;
566                                 sp.azi += 270.0;
567                                 CartesianVector c;
568                                 sp.cartesian (c);
569                                 cart_to_gtk (c);
570
571                                 snprintf (buf, sizeof (buf), "%d", n);
572
573                                 /* stroke out a speaker shape */
574
575                                 cairo_move_to (cr, c.x, c.y);
576                                 cairo_save (cr);
577                                 cairo_rotate (cr, -(sp.azi/360.0) * (2.0 * M_PI));
578                                 if (small) {
579                                         cairo_scale (cr, 0.8, 0.8);
580                                 } else {
581                                         cairo_scale (cr, 1.2, 1.2);
582                                 }
583                                 cairo_rel_line_to (cr, 4, -2);
584                                 cairo_rel_line_to (cr, 0, -7);
585                                 cairo_rel_line_to (cr, 5, +5);
586                                 cairo_rel_line_to (cr, 5, 0);
587                                 cairo_rel_line_to (cr, 0, 5);
588                                 cairo_rel_line_to (cr, -5, 0);
589                                 cairo_rel_line_to (cr, -5, +5);
590                                 cairo_rel_line_to (cr, 0, -7);
591                                 cairo_close_path (cr);
592                                 cairo_set_source_rgba (cr, 0.282, 0.517, 0.662, 1.0);
593                                 cairo_fill (cr);
594                                 cairo_restore (cr);
595
596                                 if (!small) {
597                                         cairo_set_font_size (cr, 16);
598
599                                         /* move the text in just a bit */
600
601                                         AngularVector textpos (speaker->position.azi + 270.0, speaker->position.ele, 0.85);
602
603                                         textpos.cartesian (c);
604                                         cart_to_gtk (c);
605                                         cairo_move_to (cr, c.x, c.y);
606                                         cairo_show_text (cr, buf);
607                                 }
608
609                         }
610                 }
611         }
612
613         cairo_destroy (cr);
614
615         return true;
616 }
617
618 bool
619 Panner2d::on_button_press_event (GdkEventButton *ev)
620 {
621         GdkModifierType state;
622         int x;
623         int y;
624         bool is_signal;
625
626         if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
627                 return false;
628         }
629
630         did_move = false;
631
632         switch (ev->button) {
633         case 1:
634         case 2:
635                 x = ev->x - hoffset;
636                 y = ev->y - voffset;
637
638                 if ((drag_target = find_closest_object (x, y, is_signal)) != 0) {
639                         if (!is_signal) {
640                                 panner_shell->panner()->set_position (drag_target->position.azi/360.0);
641                                 drag_target = 0;
642                         } else {
643                                 drag_target->set_selected (true);
644                         }
645                 }
646
647                 state = (GdkModifierType) ev->state;
648                 return handle_motion (ev->x, ev->y, state);
649                 break;
650
651         default:
652                 break;
653         }
654
655         return false;
656 }
657
658 bool
659 Panner2d::on_button_release_event (GdkEventButton *ev)
660 {
661         gint x, y;
662         GdkModifierType state;
663         bool ret = false;
664
665         switch (ev->button) {
666         case 1:
667                 x = (int) floor (ev->x);
668                 y = (int) floor (ev->y);
669                 state = (GdkModifierType) ev->state;
670                 ret = handle_motion (x, y, state);
671                 drag_target = 0;
672                 break;
673
674         case 2:
675                 x = (int) floor (ev->x);
676                 y = (int) floor (ev->y);
677                 state = (GdkModifierType) ev->state;
678
679                 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
680                         toggle_bypass ();
681                         ret = true;
682                 } else {
683                         ret = handle_motion (x, y, state);
684                 }
685
686                 drag_target = 0;
687                 break;
688
689         case 3:
690                 break;
691
692         }
693
694         return ret;
695 }
696
697 gint
698 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
699 {
700         if (drag_target == 0) {
701                 return false;
702         }
703
704         if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
705                 return false;
706         }
707
708         evx -= hoffset;
709         evy -= voffset;
710
711         if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
712                 CartesianVector c;
713                 bool need_move = false;
714
715                 drag_target->position.cartesian (c);
716                 cart_to_gtk (c);
717
718                 if ((evx != c.x) || (evy != c.y)) {
719                         need_move = true;
720                 }
721
722                 if (need_move) {
723                         CartesianVector cp (evx, evy, 0.0);
724                         AngularVector av;
725                         gtk_to_cart (cp);
726
727                         if (!have_elevation) {
728                                 clamp_to_circle (cp.x, cp.y);
729                                 cp.angular (av);
730                                 av.azi = fmod(270 - av.azi, 360);
731                                 if (drag_target == &position) {
732                                         double degree_fract = av.azi / 360.0;
733                                         panner_shell->panner()->set_position (degree_fract);
734                                 }
735                         } else {
736                                 /* sphere projection */
737                                 sphere_project (cp.x, cp.y, cp.z);
738
739                                 double r2d = 180.0 / M_PI;
740                                 av.azi = r2d * atan2(cp.y, cp.x);
741                                 av.ele = r2d * asin(cp.z);
742                                 av.azi = fmod(270 - av.azi, 360);
743
744                                 if (drag_target == &position) {
745                                         double azi_fract = av.azi / 360.0;
746                                         double ele_fract = av.ele / 90.0;
747                                         panner_shell->panner()->set_position (azi_fract);
748                                         panner_shell->panner()->set_elevation (ele_fract);
749                                 }
750                         }
751                 }
752         }
753
754         return true;
755 }
756
757 bool
758 Panner2d::on_scroll_event (GdkEventScroll* ev)
759 {
760         switch (ev->direction) {
761         case GDK_SCROLL_UP:
762         case GDK_SCROLL_RIGHT:
763                 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
764                 break;
765
766         case GDK_SCROLL_DOWN:
767         case GDK_SCROLL_LEFT:
768                 panner_shell->panner()->set_position (panner_shell->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
769                 break;
770         }
771         return true;
772 }
773
774 void
775 Panner2d::cart_to_gtk (CartesianVector& c) const
776 {
777         /* cartesian coordinate space:
778               center = 0.0
779               dimension = 2.0 * 2.0
780               increasing y moves up
781               so max values along each axis are -1..+1
782
783            GTK uses a coordinate space that is:
784               top left = 0.0
785               dimension = (radius*2.0) * (radius*2.0)
786               increasing y moves down
787         */
788         const double diameter = radius*2.0;
789
790         c.x = diameter * ((c.x + 1.0) / 2.0);
791         /* extra subtraction inverts the y-axis to match "increasing y moves down" */
792         c.y = diameter - (diameter * ((c.y + 1.0) / 2.0));
793 }
794
795 void
796 Panner2d::gtk_to_cart (CartesianVector& c) const
797 {
798         const double diameter = radius*2.0;
799         c.x = ((c.x / diameter) * 2.0) - 1.0;
800         c.y = (((diameter - c.y) / diameter) * 2.0) - 1.0;
801 }
802
803 void
804 Panner2d::sphere_project (double& x, double& y, double& z)
805 {
806         double r, r2;
807         r2 = x * x + y * y;
808         if (r2 < 1.0) {
809                 z = sqrt (1.0 - r2);
810         } else {
811                 r = sqrt (r2);
812                 x = x / r;
813                 y = y / r;
814                 z = 0.0;
815         }
816 }
817
818 void
819 Panner2d::clamp_to_circle (double& x, double& y)
820 {
821         double azi, ele;
822         double z = 0.0;
823         double l;
824         PBD::cartesian_to_spherical (x, y, z, azi, ele, l);
825         PBD::spherical_to_cartesian (azi, ele, 1.0, x, y, z);
826 }
827
828 void
829 Panner2d::toggle_bypass ()
830 {
831         panner_shell->set_bypassed (!panner_shell->bypassed());
832 }
833
834 Panner2dWindow::Panner2dWindow (boost::shared_ptr<PannerShell> p, int32_t h, uint32_t inputs)
835         : ArdourWindow (_("Panner (2D)"))
836         , widget (p, h)
837         , bypass_button (_("Bypass"))
838         , width_adjustment (0, -100, 100, 1, 5, 0)
839         , width_spinner (width_adjustment)
840 {
841         widget.set_name ("MixerPanZone");
842
843         set_title (_("Panner"));
844         widget.set_size_request (h, h);
845
846         bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
847         width_spinner.signal_changed().connect (sigc::mem_fun (*this, &Panner2dWindow::width_changed));
848
849         p->Changed.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::set_bypassed, this), gui_context());
850         /* needed for the width-spinbox in the main window */
851         p->PannableChanged.connect (panshell_connections, invalidator (*this), boost::bind (&Panner2dWindow::pannable_handler, this), gui_context());
852         p->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
853
854
855         button_box.set_spacing (6);
856         button_box.pack_start (bypass_button, false, false);
857
858         left_side.set_spacing (6);
859
860         left_side.pack_start (button_box, false, false);
861
862         Gtk::Label* l = manage (new Label (
863                                 p->panner()->describe_parameter(PanWidthAutomation),
864                                 Gtk::ALIGN_LEFT, Gtk::ALIGN_CENTER, false));
865         spinner_box.pack_start (*l, false, false);
866         spinner_box.pack_start (width_spinner, false, false);
867         left_side.pack_start (spinner_box, false, false);
868
869         l->show ();
870         bypass_button.show ();
871         button_box.show ();
872         width_spinner.show ();
873         spinner_box.show ();
874         left_side.show ();
875
876         hpacker.set_spacing (6);
877         hpacker.set_border_width (12);
878         hpacker.pack_start (widget, false, false);
879         hpacker.pack_start (left_side, false, false);
880         hpacker.show ();
881
882         add (hpacker);
883         reset (inputs);
884         set_width();
885         set_bypassed();
886         widget.show ();
887 }
888
889 void
890 Panner2dWindow::reset (uint32_t n_inputs)
891 {
892         widget.reset (n_inputs);
893 }
894
895 void
896 Panner2dWindow::bypass_toggled ()
897 {
898         bool view = bypass_button.get_active ();
899         bool model = widget.get_panner_shell()->bypassed ();
900
901         if (model != view) {
902                 widget.get_panner_shell()->set_bypassed (view);
903         }
904 }
905 void
906 Panner2dWindow::width_changed ()
907 {
908         float model = widget.get_panner_shell()->pannable()->pan_width_control->get_value();
909         float view  = width_spinner.get_value() / 100.0;
910         if (model != view) {
911                 widget.get_panner_shell()->panner()->set_width (view);
912         }
913 }
914
915 void
916 Panner2dWindow::pannable_handler ()
917 {
918         panvalue_connections.drop_connections();
919         widget.get_panner_shell()->pannable()->pan_width_control->Changed.connect (panvalue_connections, invalidator(*this), boost::bind (&Panner2dWindow::set_width, this), gui_context());
920         set_width();
921 }
922
923 void
924 Panner2dWindow::set_bypassed ()
925 {
926         bool view = bypass_button.get_active ();
927         bool model = widget.get_panner_shell()->bypassed ();
928         if (model != view) {
929                 bypass_button.set_active(model);
930         }
931
932         set<Evoral::Parameter> params = widget.get_panner_shell()->panner()->what_can_be_automated();
933         set<Evoral::Parameter>::iterator p = params.find(PanWidthAutomation);
934         if (p == params.end()) {
935                 spinner_box.set_sensitive(false);
936         } else {
937                 spinner_box.set_sensitive(true);
938         }
939 }
940
941 void
942 Panner2dWindow::set_width ()
943 {
944         // rounding of spinbox is different from slider -- TODO use slider
945         float model = (widget.get_panner_shell()->pannable()->pan_width_control->get_value() * 100.0);
946         float view  = (width_spinner.get_value());
947         if (model != view) {
948                 width_spinner.set_value (model);
949         }
950 }
951
952 bool
953 Panner2dWindow::on_key_press_event (GdkEventKey* event)
954 {
955         return relay_key_press (event, &PublicEditor::instance());
956 }
957
958 bool
959 Panner2dWindow::on_key_release_event (GdkEventKey*)
960 {
961         return true;
962 }