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/pannable.h"
  33 #include "ardour/speakers.h"
  34
  35 #include "panner2d.h"
  36 #include "keyboard.h"
  37 #include "gui_thread.h"
  38
  39 #include "i18n.h"
  40
  41 using namespace std;
  42 using namespace Gtk;
  43 using namespace ARDOUR;
  44 using namespace PBD;
  45 using Gtkmm2ext::Keyboard;
  46
  47 Panner2d::Target::Target (const AngularVector& a, const char *txt)
  48         : position (a)
  49         , text (txt)
  50         , _selected (false)
  51 {
  52 }
  53
  54 Panner2d::Target::~Target ()
  55 {
  56 }
  57
  58 void
  59 Panner2d::Target::set_text (const char* txt)
  60 {
  61         text = txt;
  62 }
  63
  64 Panner2d::Panner2d (boost::shared_ptr<Panner> p, int32_t h)
  65         : panner (p), width (0), height (h)
  66 {
  67         panner->StateChanged.connect (connections, invalidator (*this), boost::bind (&Panner2d::handle_state_change, this), gui_context());
  68
  69         panner->pannable()->pan_azimuth_control->Changed.connect (connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
  70         panner->pannable()->pan_width_control->Changed.connect (connections, invalidator(*this), boost::bind (&Panner2d::handle_position_change, this), gui_context());
  71
  72         drag_target = 0;
  73         set_events (Gdk::BUTTON_PRESS_MASK|Gdk::BUTTON_RELEASE_MASK|Gdk::POINTER_MOTION_MASK);
  74 }
  75
  76 Panner2d::~Panner2d()
  77 {
  78         for (Targets::iterator i = targets.begin(); i != targets.end(); ++i) {
  79                 delete *i;
  80         }
  81 }
  82
  83 void
  84 Panner2d::reset (uint32_t n_inputs)
  85 {
  86         uint32_t nouts = panner->out().n_audio();
  87
  88         /* pucks */
  89
  90         while (pucks.size() < n_inputs) {
  91                 add_puck ("", AngularVector());
  92         }
  93
  94         if (pucks.size() > n_inputs) {
  95                 for (uint32_t i = pucks.size(); i < n_inputs; ++i) {
  96                         delete pucks[i];
  97                 }
  98
  99                 pucks.resize (n_inputs);
 100         }
 101
 102         switch (n_inputs) {
 103         case 0:
 104                 break;
 105
 106         case 1:
 107                 pucks[0]->set_text ("");
 108                 break;
 109
 110         case 2:
 111                 pucks[0]->set_text ("R");
 112                 pucks[1]->set_text ("L");
 113                 break;
 114
 115         default:
 116                 for (uint32_t i = 0; i < n_inputs; ++i) {
 117                         char buf[64];
 118                         snprintf (buf, sizeof (buf), "%" PRIu32, i + 1);
 119                         pucks[i]->set_text (buf);
 120                 }
 121                 break;
 122         }
 123
 124         for (uint32_t i = 0; i < n_inputs; ++i) {
 125                 pucks[i]->position = panner->signal_position (i);
 126         }
 127
 128         /* add all outputs */
 129
 130         while (targets.size() < nouts) {
 131                 add_target (AngularVector());
 132         }
 133
 134         if (targets.size() > nouts) {
 135                 for (uint32_t i = nouts; i < targets.size(); ++i) {
 136                         delete targets[i];
 137                 }
 138
 139                 targets.resize (nouts);
 140         }
 141
 142         for (Targets::iterator x = targets.begin(); x != targets.end(); ++x) {
 143                 (*x)->visible = false;
 144         }
 145
 146         vector<Speaker>& speakers (panner->get_speakers()->speakers());
 147
 148         for (uint32_t n = 0; n < nouts; ++n) {
 149                 char buf[16];
 150
 151                 snprintf (buf, sizeof (buf), "%d", n+1);
 152                 targets[n]->set_text (buf);
 153                 targets[n]->position = speakers[n].angles();
 154                 targets[n]->visible = true;
 155         }
 156
 157         queue_draw ();
 158 }
 159
 160 void
 161 Panner2d::on_size_allocate (Gtk::Allocation& alloc)
 162 {
 163         width = alloc.get_width();
 164         height = alloc.get_height();
 165
 166         /* our idea of our width/height must be "square
 167          */
 168
 169         if (height > 100) {
 170                 width -= 20;
 171                 height -= 20;
 172         }
 173
 174         dimen = min (width, height);
 175
 176         DrawingArea::on_size_allocate (alloc);
 177 }
 178
 179 int
 180 Panner2d::add_puck (const char* text, const AngularVector& a)
 181 {
 182         Target* puck = new Target (a, text);
 183         pucks.push_back (puck);
 184         puck->visible = true;
 185
 186         return 0;
 187 }
 188
 189 int
 190 Panner2d::add_target (const AngularVector& a)
 191 {
 192         Target* target = new Target (a, "");
 193         targets.push_back (target);
 194         target->visible = true;
 195         queue_draw ();
 196
 197         return targets.size() - 1;
 198 }
 199
 200 void
 201 Panner2d::handle_state_change ()
 202 {
 203         queue_draw ();
 204 }
 205
 206 void
 207 Panner2d::handle_position_change ()
 208 {
 209         uint32_t n;
 210
 211         for (uint32_t i = 0; i < pucks.size(); ++i) {
 212                 pucks[i]->position = panner->signal_position (i);
 213         }
 214
 215         vector<Speaker>& speakers (panner->get_speakers()->speakers());
 216
 217         for (n = 0; n < targets.size(); ++n) {
 218                 targets[n]->position = speakers[n].angles();
 219         }
 220
 221         queue_draw ();
 222 }
 223
 224 void
 225 Panner2d::move_puck (int which, const AngularVector& a)
 226 {
 227         if (which >= int (targets.size())) {
 228                 return;
 229         }
 230
 231         targets[which]->position = a;
 232         queue_draw ();
 233 }
 234
 235 Panner2d::Target *
 236 Panner2d::find_closest_object (gdouble x, gdouble y, int& which) const
 237 {
 238         Target *closest = 0;
 239         Target *candidate;
 240         float distance;
 241         float best_distance = FLT_MAX;
 242         int pwhich;
 243
 244         which = 0;
 245         pwhich = 0;
 246
 247         for (Targets::const_iterator i = pucks.begin(); i != pucks.end(); ++i, ++pwhich) {
 248                 candidate = *i;
 249
 250                 CartesianVector c;
 251
 252                 candidate->position.cartesian (c);
 253                 cart_to_gtk (c);
 254
 255                 distance = sqrt ((c.x - x) * (c.x - x) +
 256                                  (c.y - y) * (c.y - y));
 257
 258                 if (distance < best_distance) {
 259                         closest = candidate;
 260                         best_distance = distance;
 261                         which = pwhich;
 262                 }
 263         }
 264
 265         if (best_distance > 20) { // arbitrary
 266                 return 0;
 267         }
 268
 269         return closest;
 270 }
 271
 272 bool
 273 Panner2d::on_motion_notify_event (GdkEventMotion *ev)
 274 {
 275         gint x, y;
 276         GdkModifierType state;
 277
 278         if (ev->is_hint) {
 279                 gdk_window_get_pointer (ev->window, &x, &y, &state);
 280         } else {
 281                 x = (int) floor (ev->x);
 282                 y = (int) floor (ev->y);
 283                 state = (GdkModifierType) ev->state;
 284         }
 285
 286         return handle_motion (x, y, state);
 287 }
 288 bool
 289 Panner2d::on_expose_event (GdkEventExpose *event)
 290 {
 291         gint x, y;
 292         cairo_t* cr;
 293
 294         cr = gdk_cairo_create (get_window()->gobj());
 295
 296         cairo_set_line_width (cr, 1.0);
 297
 298         cairo_rectangle (cr, event->area.x, event->area.y, event->area.width, event->area.height);
 299         if (!panner->bypassed()) {
 300                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 1.0);
 301         } else {
 302                 cairo_set_source_rgba (cr, 0.1, 0.1, 0.1, 0.2);
 303         }
 304         cairo_fill_preserve (cr);
 305         cairo_clip (cr);
 306
 307         if (height > 100) {
 308                 cairo_translate (cr, 10.0, 10.0);
 309         }
 310
 311         /* horizontal line of "crosshairs" */
 312
 313         cairo_set_source_rgb (cr, 0.0, 0.1, 0.7);
 314         cairo_move_to (cr, 0.5, height/2.0+0.5);
 315         cairo_line_to (cr, width+0.5, height/2+0.5);
 316         cairo_stroke (cr);
 317
 318         /* vertical line of "crosshairs" */
 319
 320         cairo_move_to (cr, width/2+0.5, 0.5);
 321         cairo_line_to (cr, width/2+0.5, height+0.5);
 322         cairo_stroke (cr);
 323
 324         /* the circle on which signals live */
 325
 326         cairo_arc (cr, width/2, height/2, dimen/2, 0, 2.0 * M_PI);
 327         cairo_stroke (cr);
 328
 329         if (!panner->bypassed()) {
 330                 float arc_radius;
 331
 332                 cairo_select_font_face (cr, "sans", CAIRO_FONT_SLANT_NORMAL, CAIRO_FONT_WEIGHT_NORMAL);
 333
 334                 if (height < 100) {
 335                         cairo_set_font_size (cr, 10);
 336                         arc_radius = 2.0;
 337                 } else {
 338                         cairo_set_font_size (cr, 16);
 339                         arc_radius = 4.0;
 340                 }
 341
 342                 for (Targets::iterator i = pucks.begin(); i != pucks.end(); ++i) {
 343
 344                         Target* puck = *i;
 345
 346                         if (puck->visible) {
 347                                 /* redraw puck */
 348
 349                                 CartesianVector c;
 350
 351                                 puck->position.cartesian (c);
 352                                 cart_to_gtk (c);
 353
 354                                 x = (gint) floor (c.x);
 355                                 y = (gint) floor (c.y);
 356
 357                                 /* XXX need to shift circles so that they are centered on the circle */
 358
 359                                 cairo_arc (cr, x, y, arc_radius, 0, 2.0 * M_PI);
 360                                 cairo_set_source_rgb (cr, 0.8, 0.2, 0.1);
 361                                 cairo_close_path (cr);
 362                                 cairo_fill (cr);
 363
 364                                 cairo_move_to (cr, x + 6, y + 6);
 365
 366                                 char buf[256];
 367                                 snprintf (buf, sizeof (buf), "%s:%d", puck->text.c_str(), (int) lrint (puck->position.azi));
 368                                 cairo_show_text (cr, buf);
 369                         }
 370                 }
 371
 372                 /* redraw any visible targets */
 373
 374                 int n = 0;
 375
 376                 for (Targets::iterator i = targets.begin(); i != targets.end(); ++i) {
 377                         Target *target = *i;
 378                         char buf[256];
 379                         ++n;
 380
 381                         if (target->visible) {
 382
 383                                 CartesianVector c;
 384
 385                                 target->position.cartesian (c);
 386                                 cart_to_gtk (c);
 387
 388                                 x = (int) floor (c.x);
 389                                 y = (int) floor (c.y);
 390
 391                                 snprintf (buf, sizeof (buf), "%d", n);
 392
 393                                 cairo_set_source_rgb (cr, 0.0, 0.8, 0.1);
 394                                 cairo_rectangle (cr, x-2, y-2, 4, 4);
 395                                 cairo_fill (cr);
 396                                 cairo_move_to (cr, x+6, y+6);
 397                                 cairo_show_text (cr, buf);
 398
 399                         }
 400                 }
 401         }
 402
 403         cairo_destroy (cr);
 404
 405         return true;
 406 }
 407
 408 bool
 409 Panner2d::on_button_press_event (GdkEventButton *ev)
 410 {
 411         GdkModifierType state;
 412
 413         if (ev->type == GDK_2BUTTON_PRESS && ev->button == 1) {
 414                 return false;
 415         }
 416
 417         switch (ev->button) {
 418         case 1:
 419         case 2:
 420                 if ((drag_target = find_closest_object (ev->x, ev->y, drag_index)) != 0) {
 421                         drag_target->set_selected (true);
 422                 }
 423
 424                 drag_x = (int) floor (ev->x);
 425                 drag_y = (int) floor (ev->y);
 426                 state = (GdkModifierType) ev->state;
 427
 428                 return handle_motion (drag_x, drag_y, state);
 429                 break;
 430
 431         default:
 432                 break;
 433         }
 434
 435         return false;
 436 }
 437
 438 bool
 439 Panner2d::on_button_release_event (GdkEventButton *ev)
 440 {
 441         gint x, y;
 442         GdkModifierType state;
 443         bool ret = false;
 444
 445         switch (ev->button) {
 446         case 1:
 447                 x = (int) floor (ev->x);
 448                 y = (int) floor (ev->y);
 449                 state = (GdkModifierType) ev->state;
 450
 451                 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
 452
 453                         for (Targets::iterator i = pucks.begin(); i != pucks.end(); ++i) {
 454                                 //Target* puck = i->second;
 455                                 /* XXX DO SOMETHING TO SET PUCK BACK TO "normal" */
 456                         }
 457
 458                         queue_draw ();
 459                         PuckMoved (-1);
 460                         ret = true;
 461
 462                 } else {
 463                         ret = handle_motion (x, y, state);
 464                 }
 465
 466                 drag_target = 0;
 467                 break;
 468
 469         case 2:
 470                 x = (int) floor (ev->x);
 471                 y = (int) floor (ev->y);
 472                 state = (GdkModifierType) ev->state;
 473
 474                 if (Keyboard::modifier_state_contains (state, Keyboard::TertiaryModifier)) {
 475                         toggle_bypass ();
 476                         ret = true;
 477                 } else {
 478                         ret = handle_motion (x, y, state);
 479                 }
 480
 481                 drag_target = 0;
 482                 break;
 483
 484         case 3:
 485                 break;
 486
 487         }
 488
 489         return ret;
 490 }
 491
 492 gint
 493 Panner2d::handle_motion (gint evx, gint evy, GdkModifierType state)
 494 {
 495         if (drag_target == 0) {
 496                 return false;
 497         }
 498
 499         if ((state & (GDK_BUTTON1_MASK|GDK_BUTTON2_MASK)) == 0) {
 500                 return false;
 501         }
 502
 503
 504         if (state & GDK_BUTTON1_MASK && !(state & GDK_BUTTON2_MASK)) {
 505                 CartesianVector c;
 506                 bool need_move = false;
 507
 508                 drag_target->position.cartesian (c);
 509                 cart_to_gtk (c);
 510
 511                 if ((evx != c.x) || (evy != c.y)) {
 512                         need_move = true;
 513                 }
 514
 515                 if (need_move) {
 516                         CartesianVector cp (evx, evy, 0.0);
 517
 518                         /* canonicalize position */
 519
 520                         gtk_to_cart (cp);
 521
 522                         /* position actual signal on circle */
 523
 524                         clamp_to_circle (cp.x, cp.y);
 525
 526                         /* generate an angular representation and set drag target (GUI) position */
 527
 528                         cp.angular (drag_target->position); /* sets drag target position */
 529
 530                         double degree_fract = drag_target->position.azi / 360.0;
 531
 532                         panner->set_position (degree_fract);
 533                 }
 534         }
 535
 536         return true;
 537 }
 538
 539 void
 540 Panner2d::cart_to_gtk (CartesianVector& c) const
 541 {
 542         /* "c" uses a coordinate space that is:
 543
 544            center = 0.0
 545            dimension = 2.0 * 2.0
 546            so max values along each axis are -1..+1
 547
 548            GTK uses a coordinate space that is:
 549
 550            top left = 0.0
 551            dimension = width * height
 552            so max values along each axis are 0,width and
 553            0,height
 554         */
 555
 556         const uint32_t hoffset = (width - dimen)/2;
 557         const uint32_t voffset = (height - dimen)/2;
 558
 559         c.x = hoffset + ((dimen / 2) * (c.x + 1));
 560         c.y = voffset + ((dimen / 2) * (1 - c.y));
 561
 562         /* XXX z-axis not handled - 2D for now */
 563 }
 564
 565 void
 566 Panner2d::gtk_to_cart (CartesianVector& c) const
 567 {
 568         c.x = ((c.x / (dimen / 2.0)) - 1.0);
 569         c.y = -((c.y / (dimen / 2.0)) - 1.0);
 570
 571         /* XXX z-axis not handled - 2D for now */
 572 }
 573
 574 void
 575 Panner2d::clamp_to_circle (double& x, double& y)
 576 {
 577         double azi, ele;
 578         double z = 0.0;
 579
 580         PBD::cart_to_azi_ele (x, y, z, azi, ele);
 581         PBD::azi_ele_to_cart (azi, ele, x, y, z);
 582 }
 583
 584 void
 585 Panner2d::toggle_bypass ()
 586 {
 587         panner->set_bypassed (!panner->bypassed());
 588 }
 589
 590 Panner2dWindow::Panner2dWindow (boost::shared_ptr<Panner> p, int32_t h, uint32_t inputs)
 591         : ArdourDialog (_("Panner (2D)"))
 592         , widget (p, h)
 593         , bypass_button (_("Bypass"))
 594 {
 595         widget.set_name ("MixerPanZone");
 596
 597         set_title (_("Panner"));
 598         widget.set_size_request (h, h);
 599
 600         bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
 601
 602         button_box.set_spacing (6);
 603         button_box.pack_start (bypass_button, false, false);
 604
 605         spinner_box.set_spacing (6);
 606         left_side.set_spacing (6);
 607
 608         left_side.pack_start (button_box, false, false);
 609         left_side.pack_start (spinner_box, false, false);
 610
 611         bypass_button.show ();
 612         button_box.show ();
 613         spinner_box.show ();
 614         left_side.show ();
 615
 616         hpacker.set_spacing (6);
 617         hpacker.set_border_width (12);
 618         hpacker.pack_start (widget, false, false);
 619         hpacker.pack_start (left_side, false, false);
 620         hpacker.show ();
 621
 622         get_vbox()->pack_start (hpacker);
 623         reset (inputs);
 624         widget.show ();
 625 }
 626
 627 void
 628 Panner2dWindow::reset (uint32_t n_inputs)
 629 {
 630         widget.reset (n_inputs);
 631
 632 #if 0
 633         while (spinners.size() < n_inputs) {
 634                 // spinners.push_back (new Gtk::SpinButton (widget.azimuth (spinners.size())));
 635                 //spinner_box.pack_start (*spinners.back(), false, false);
 636                 //spinners.back()->set_digits (4);
 637                 spinners.back()->show ();
 638         }
 639
 640         while (spinners.size() > n_inputs) {
 641                 spinner_box.remove (*spinners.back());
 642                 delete spinners.back();
 643                 spinners.erase (--spinners.end());
 644         }
 645 #endif
 646 }
 647
 648 void
 649 Panner2dWindow::bypass_toggled ()
 650 {
 651         bool view = bypass_button.get_active ();
 652         bool model = widget.get_panner()->bypassed ();
 653
 654         if (model != view) {
 655                 widget.get_panner()->set_bypassed (view);
 656         }
 657 }