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