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
 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, dimen/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                 CartesianVector c;
 507                 bool need_move = false;
 508
 509                 drag_target->position.cartesian (c);
 510                 cart_to_gtk (c);
 511
 512                 if ((evx != c.x) || (evy != c.y)) {
 513                         need_move = true;
 514                 }
 515
 516                 if (need_move) {
 517                         CartesianVector cp (evx, evy, 0.0);
 518
 519                         /* canonicalize position */
 520
 521                         gtk_to_cart (cp);
 522
 523                         /* position actual signal on circle */
 524
 525                         clamp_to_circle (cp.x, cp.y);
 526
 527                         /* generate an angular representation and set drag target (GUI) position */
 528
 529                         cp.angular (drag_target->position); /* sets drag target position */
 530
 531                         double degree_fract = drag_target->position.azi / 360.0;
 532
 533                         panner->set_position (degree_fract);
 534                 }
 535         }
 536
 537         return true;
 538 }
 539
 540 bool
 541 Panner2d::on_scroll_event (GdkEventScroll* ev)
 542 {
 543         switch (ev->direction) {
 544         case GDK_SCROLL_UP:
 545         case GDK_SCROLL_RIGHT:
 546                 panner->set_position (panner->pannable()->pan_azimuth_control->get_value() - 1.0/360.0);
 547                 break;
 548
 549         case GDK_SCROLL_DOWN:
 550         case GDK_SCROLL_LEFT:
 551                 panner->set_position (panner->pannable()->pan_azimuth_control->get_value() + 1.0/360.0);
 552                 break;
 553         }
 554         return true;
 555 }
 556
 557 void
 558 Panner2d::cart_to_gtk (CartesianVector& c) const
 559 {
 560         /* "c" uses a coordinate space that is:
 561
 562            center = 0.0
 563            dimension = 2.0 * 2.0
 564            so max values along each axis are -1..+1
 565
 566            GTK uses a coordinate space that is:
 567
 568            top left = 0.0
 569            dimension = width * height
 570            so max values along each axis are 0,width and
 571            0,height
 572         */
 573
 574         const uint32_t hoffset = (width - dimen)/2;
 575         const uint32_t voffset = (height - dimen)/2;
 576
 577         c.x = hoffset + ((dimen / 2) * (c.x + 1));
 578         c.y = voffset + ((dimen / 2) * (1 - c.y));
 579
 580         /* XXX z-axis not handled - 2D for now */
 581 }
 582
 583 void
 584 Panner2d::gtk_to_cart (CartesianVector& c) const
 585 {
 586         c.x = ((c.x / (dimen / 2.0)) - 1.0);
 587         c.y = -((c.y / (dimen / 2.0)) - 1.0);
 588
 589         /* XXX z-axis not handled - 2D for now */
 590 }
 591
 592 void
 593 Panner2d::clamp_to_circle (double& x, double& y)
 594 {
 595         double azi, ele;
 596         double z = 0.0;
 597
 598         PBD::cart_to_azi_ele (x, y, z, azi, ele);
 599         PBD::azi_ele_to_cart (azi, ele, x, y, z);
 600 }
 601
 602 void
 603 Panner2d::toggle_bypass ()
 604 {
 605         panner->set_bypassed (!panner->bypassed());
 606 }
 607
 608 Panner2dWindow::Panner2dWindow (boost::shared_ptr<Panner> p, int32_t h, uint32_t inputs)
 609         : ArdourDialog (_("Panner (2D)"))
 610         , widget (p, h)
 611         , bypass_button (_("Bypass"))
 612 {
 613         widget.set_name ("MixerPanZone");
 614
 615         set_title (_("Panner"));
 616         widget.set_size_request (h, h);
 617
 618         bypass_button.signal_toggled().connect (sigc::mem_fun (*this, &Panner2dWindow::bypass_toggled));
 619
 620         button_box.set_spacing (6);
 621         button_box.pack_start (bypass_button, false, false);
 622
 623         spinner_box.set_spacing (6);
 624         left_side.set_spacing (6);
 625
 626         left_side.pack_start (button_box, false, false);
 627         left_side.pack_start (spinner_box, false, false);
 628
 629         bypass_button.show ();
 630         button_box.show ();
 631         spinner_box.show ();
 632         left_side.show ();
 633
 634         hpacker.set_spacing (6);
 635         hpacker.set_border_width (12);
 636         hpacker.pack_start (widget, false, false);
 637         hpacker.pack_start (left_side, false, false);
 638         hpacker.show ();
 639
 640         get_vbox()->pack_start (hpacker);
 641         reset (inputs);
 642         widget.show ();
 643 }
 644
 645 void
 646 Panner2dWindow::reset (uint32_t n_inputs)
 647 {
 648         widget.reset (n_inputs);
 649
 650 #if 0
 651         while (spinners.size() < n_inputs) {
 652                 // spinners.push_back (new Gtk::SpinButton (widget.azimuth (spinners.size())));
 653                 //spinner_box.pack_start (*spinners.back(), false, false);
 654                 //spinners.back()->set_digits (4);
 655                 spinners.back()->show ();
 656         }
 657
 658         while (spinners.size() > n_inputs) {
 659                 spinner_box.remove (*spinners.back());
 660                 delete spinners.back();
 661                 spinners.erase (--spinners.end());
 662         }
 663 #endif
 664 }
 665
 666 void
 667 Panner2dWindow::bypass_toggled ()
 668 {
 669         bool view = bypass_button.get_active ();
 670         bool model = widget.get_panner()->bypassed ();
 671
 672         if (model != view) {
 673                 widget.get_panner()->set_bypassed (view);
 674         }
 675 }