gtk2_ardour/port_matrix_grid.cc

   1 /*
   2     Copyright (C) 2002-2009 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 <iostream>
  21 #include <cairo/cairo.h>
  22 #include "ardour/bundle.h"
  23 #include "ardour/types.h"
  24 #include "port_matrix_grid.h"
  25 #include "port_matrix.h"
  26 #include "port_matrix_body.h"
  27 #include "keyboard.h"
  28
  29 using namespace std;
  30 using Gtkmm2ext::Keyboard;
  31
  32 PortMatrixGrid::PortMatrixGrid (PortMatrix* m, PortMatrixBody* b)
  33         : PortMatrixComponent (m, b),
  34           _dragging (false),
  35           _drag_valid (false),
  36           _moved (false)
  37 {
  38
  39 }
  40
  41 void
  42 PortMatrixGrid::compute_dimensions ()
  43 {
  44         if (_matrix->visible_columns()) {
  45                 _width = group_size (_matrix->visible_columns()) * grid_spacing ();
  46         } else {
  47                 _width = 0;
  48         }
  49
  50         if (_matrix->visible_rows()) {
  51                 _height = group_size (_matrix->visible_rows()) * grid_spacing ();
  52         } else {
  53                 _height = 0;
  54         }
  55 }
  56
  57
  58 void
  59 PortMatrixGrid::render (cairo_t* cr)
  60 {
  61         set_source_rgb (cr, background_colour());
  62         cairo_rectangle (cr, 0, 0, _width, _height);
  63         cairo_fill (cr);
  64
  65         PortGroup::BundleList const & row_bundles = _matrix->visible_rows()->bundles();
  66         PortGroup::BundleList const & column_bundles = _matrix->visible_columns()->bundles();
  67
  68         uint32_t x = 0;
  69
  70         /* VERTICAL GRID LINES */
  71
  72         set_source_rgb (cr, grid_colour());
  73         uint32_t N = 0;
  74
  75         for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {
  76
  77                 cairo_set_line_width (cr, thick_grid_line_width());
  78                 cairo_move_to (cr, x, 0);
  79                 cairo_line_to (cr, x, _height);
  80                 cairo_stroke (cr);
  81
  82                 if (!_matrix->show_only_bundles()) {
  83                         cairo_set_line_width (cr, thin_grid_line_width());
  84                         for (uint32_t j = 0; j < _matrix->count_of_our_type ((*i)->bundle->nchannels()); ++j) {
  85                                 x += grid_spacing ();
  86                                 cairo_move_to (cr, x, 0);
  87                                 cairo_line_to (cr, x, _height);
  88                                 cairo_stroke (cr);
  89                         }
  90
  91                 } else {
  92
  93                         x += grid_spacing ();
  94
  95                 }
  96
  97                 ++N;
  98         }
  99
 100         uint32_t y = 0;
 101
 102         /* HORIZONTAL GRID LINES */
 103
 104         N = 0;
 105         for (PortGroup::BundleList::const_iterator i = row_bundles.begin(); i != row_bundles.end(); ++i) {
 106
 107                 cairo_set_line_width (cr, thick_grid_line_width());
 108                 cairo_move_to (cr, 0, y);
 109                 cairo_line_to (cr, _width, y);
 110                 cairo_stroke (cr);
 111
 112                 if (!_matrix->show_only_bundles()) {
 113                         cairo_set_line_width (cr, thin_grid_line_width());
 114                         for (uint32_t j = 0; j < _matrix->count_of_our_type ((*i)->bundle->nchannels()); ++j) {
 115                                 y += grid_spacing ();
 116                                 cairo_move_to (cr, 0, y);
 117                                 cairo_line_to (cr, _width, y);
 118                                 cairo_stroke (cr);
 119                         }
 120
 121                 } else {
 122
 123                         y += grid_spacing ();
 124
 125                 }
 126
 127                 ++N;
 128         }
 129
 130         /* ASSOCIATION INDICATORS and NON-CONNECTABLE INDICATORS */
 131
 132         /* we draw a grey square in a matrix box if the two ports that intersect at that box
 133            cannot be connected because they are of different types (MIDI vs. audio)
 134         */
 135
 136         uint32_t bx = 0;
 137         uint32_t by = 0;
 138
 139         if (_matrix->show_only_bundles()) {
 140
 141                 for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {
 142                         by = 0;
 143
 144                         for (PortGroup::BundleList::const_iterator j = row_bundles.begin(); j != row_bundles.end(); ++j) {
 145
 146                                 PortMatrixNode::State s = _matrix->get_association (PortMatrixNode (
 147                                                                                    ARDOUR::BundleChannel ((*j)->bundle, 0),
 148                                                                                    ARDOUR::BundleChannel ((*i)->bundle, 0)
 149                                                                                    ));
 150                                 switch (s) {
 151                                 case PortMatrixNode::ASSOCIATED:
 152                                         draw_association_indicator (cr, bx, by);
 153                                         break;
 154                                 case PortMatrixNode::PARTIAL:
 155                                         draw_association_indicator (cr, bx, by, 0.5);
 156                                         break;
 157                                 default:
 158                                         break;
 159                                 }
 160
 161                                 by += grid_spacing();
 162                         }
 163
 164                         bx += grid_spacing();
 165
 166                 }
 167
 168         } else {
 169
 170                 for (PortGroup::BundleList::const_iterator i = column_bundles.begin(); i != column_bundles.end(); ++i) {
 171                         by = 0;
 172
 173                         for (PortGroup::BundleList::const_iterator j = row_bundles.begin(); j != row_bundles.end(); ++j) {
 174
 175                                 x = bx;
 176                                 for (uint32_t k = 0; k < (*i)->bundle->nchannels().n_total(); ++k) {
 177
 178                                         y = by;
 179                                         for (uint32_t l = 0; l < (*j)->bundle->nchannels().n_total(); ++l) {
 180
 181                                                 if (!_matrix->should_show ((*i)->bundle->channel_type(k)) || !_matrix->should_show ((*j)->bundle->channel_type(l))) {
 182                                                         continue;
 183                                                 }
 184
 185                                                 ARDOUR::BundleChannel c[2];
 186                                                 c[_matrix->column_index()] = ARDOUR::BundleChannel ((*i)->bundle, k);
 187                                                 c[_matrix->row_index()] = ARDOUR::BundleChannel ((*j)->bundle, l);
 188
 189                                                 if (c[0].bundle->channel_type (c[0].channel) != c[1].bundle->channel_type (c[1].channel)) {
 190                                                         /* these two channels are of different types */
 191                                                         draw_non_connectable_indicator (cr, x, y);
 192                                                 } else {
 193                                                         /* these two channels might be associated */
 194                                                         PortMatrixNode::State const s = _matrix->get_state (c);
 195
 196                                                         switch (s) {
 197                                                         case PortMatrixNode::ASSOCIATED:
 198                                                                 draw_association_indicator (cr, x, y);
 199                                                                 break;
 200
 201                                                         case PortMatrixNode::NOT_ASSOCIATED:
 202                                                                 break;
 203
 204                                                         default:
 205                                                                 break;
 206                                                         }
 207                                                 }
 208
 209                                                 y += grid_spacing();
 210                                         }
 211
 212                                         x += grid_spacing();
 213                                 }
 214
 215                                 by += _matrix->count_of_our_type ((*j)->bundle->nchannels()) * grid_spacing();
 216                         }
 217
 218                         bx += _matrix->count_of_our_type ((*i)->bundle->nchannels()) * grid_spacing();
 219                 }
 220         }
 221 }
 222
 223 void
 224 PortMatrixGrid::draw_association_indicator (cairo_t* cr, uint32_t x, uint32_t y, double p)
 225 {
 226         set_source_rgba (cr, association_colour(), 0.5);
 227
 228         cairo_arc (
 229                 cr,
 230                 x + grid_spacing() / 2,
 231                 y + grid_spacing() / 2,
 232                 (grid_spacing() - (2 * connection_indicator_pad())) / 2,
 233                 0,
 234                 p * 2 * M_PI
 235                 );
 236
 237         cairo_fill (cr);
 238 }
 239
 240 void
 241 PortMatrixGrid::draw_empty_square (cairo_t* cr, uint32_t x, uint32_t y)
 242 {
 243         set_source_rgb (cr, background_colour());
 244         cairo_rectangle (
 245                 cr,
 246                 x + thick_grid_line_width(),
 247                 y + thick_grid_line_width(),
 248                 grid_spacing() - 2 * thick_grid_line_width(),
 249                 grid_spacing() - 2 * thick_grid_line_width()
 250                 );
 251         cairo_fill (cr);
 252 }
 253
 254 /** Draw a square to indicate that two channels in a matrix cannot be associated
 255  *  with each other.
 256  */
 257 void
 258 PortMatrixGrid::draw_non_connectable_indicator (cairo_t* cr, uint32_t x, uint32_t y)
 259 {
 260         set_source_rgb (cr, non_connectable_colour ());
 261         cairo_rectangle (
 262                 cr,
 263                 x + thick_grid_line_width(),
 264                 y + thick_grid_line_width(),
 265                 grid_spacing() - 2 * thick_grid_line_width(),
 266                 grid_spacing() - 2 * thick_grid_line_width()
 267                 );
 268         cairo_fill (cr);
 269 }
 270
 271 PortMatrixNode
 272 PortMatrixGrid::position_to_node (double x, double y) const
 273 {
 274         return PortMatrixNode (
 275                 position_to_channel (y, x, _matrix->visible_rows()),
 276                 position_to_channel (x, y, _matrix->visible_columns())
 277                 );
 278 }
 279
 280 void
 281 PortMatrixGrid::button_press (double x, double y, int b, uint32_t t, guint)
 282 {
 283         ARDOUR::BundleChannel const px = position_to_channel (x, y, _matrix->visible_columns());
 284         ARDOUR::BundleChannel const py = position_to_channel (y, x, _matrix->visible_rows());
 285
 286         if (b == 1) {
 287
 288                 _dragging = true;
 289                 _drag_valid = (px.bundle && py.bundle);
 290
 291                 _moved = false;
 292                 _drag_start_x = x / grid_spacing ();
 293                 _drag_start_y = y / grid_spacing ();
 294
 295         } else if (b == 3) {
 296
 297                 _matrix->popup_menu (px, py, t);
 298
 299         }
 300 }
 301
 302 void
 303 PortMatrixGrid::set_association (PortMatrixNode node, bool s)
 304 {
 305         if (_matrix->show_only_bundles()) {
 306
 307                 for (uint32_t i = 0; i < node.column.bundle->nchannels().n_total(); ++i) {
 308                         for (uint32_t j = 0; j < node.row.bundle->nchannels().n_total(); ++j) {
 309
 310                                 if (!_matrix->should_show (node.column.bundle->channel_type(i)) || !_matrix->should_show (node.row.bundle->channel_type(j))) {
 311                                         continue;
 312                                 }
 313
 314                                 ARDOUR::BundleChannel c[2];
 315                                 c[_matrix->column_index()] = ARDOUR::BundleChannel (node.column.bundle, i);
 316                                 c[_matrix->row_index()] = ARDOUR::BundleChannel (node.row.bundle, j);
 317                                 _matrix->set_state (c, s && (i == j));
 318                         }
 319                 }
 320
 321         } else {
 322
 323                 if (node.row.bundle && node.column.bundle) {
 324
 325                         ARDOUR::BundleChannel c[2];
 326                         c[_matrix->row_index()] = node.row;
 327                         c[_matrix->column_index()] = node.column;
 328                         _matrix->set_state (c, s);
 329                 }
 330         }
 331 }
 332
 333 void
 334 PortMatrixGrid::button_release (double x, double y, int b, uint32_t /*t*/, guint s)
 335 {
 336         if (b == 1) {
 337
 338                 if (x != -1) {
 339
 340                         if (_dragging && _moved) {
 341
 342                                 if (_drag_valid) {
 343                                         list<PortMatrixNode> const p = nodes_on_line (_drag_start_x, _drag_start_y, _drag_x, _drag_y);
 344
 345                                         if (!p.empty()) {
 346                                                 PortMatrixNode::State const s = _matrix->get_association (p.front());
 347                                                 for (list<PortMatrixNode>::const_iterator i = p.begin(); i != p.end(); ++i) {
 348                                                         set_association (*i, toggle_state (s));
 349                                                 }
 350                                         }
 351                                 }
 352
 353                         } else {
 354
 355                                 if (Keyboard::modifier_state_equals (s, Keyboard::PrimaryModifier)) {
 356                                         /* associate/disassociate things diagonally down and right until we run out */
 357                                         PortMatrixNode::State s = (PortMatrixNode::State) 0;
 358                                         while (1) {
 359                                                 PortMatrixNode const n = position_to_node (x, y);
 360                                                 if (n.row.bundle && n.column.bundle) {
 361                                                         if (s == (PortMatrixNode::State) 0) {
 362                                                                 s = _matrix->get_association (n);
 363                                                         }
 364                                                         set_association (n, toggle_state (s));
 365                                                 } else {
 366                                                         break;
 367                                                 }
 368                                                 x += grid_spacing ();
 369                                                 y += grid_spacing ();
 370                                         }
 371
 372                                 } else {
 373
 374                                         PortMatrixNode const n = position_to_node (x, y);
 375                                         if (n.row.bundle && n.column.bundle) {
 376                                                 PortMatrixNode::State const s = _matrix->get_association (n);
 377                                                 set_association (n, toggle_state (s));
 378                                         }
 379                                 }
 380                         }
 381
 382                         require_render ();
 383                 }
 384
 385                 _body->queue_draw ();
 386         }
 387
 388         _dragging = false;
 389 }
 390
 391
 392 void
 393 PortMatrixGrid::draw_extra (cairo_t* cr)
 394 {
 395         set_source_rgba (cr, mouseover_line_colour(), 0.3);
 396         cairo_set_line_width (cr, mouseover_line_width());
 397
 398         list<PortMatrixNode> const m = _body->mouseover ();
 399
 400         for (list<PortMatrixNode>::const_iterator i = m.begin(); i != m.end(); ++i) {
 401
 402                 double const x = component_to_parent_x (channel_to_position (i->column, _matrix->visible_columns()) * grid_spacing()) + grid_spacing() / 2;
 403                 double const y = component_to_parent_y (channel_to_position (i->row, _matrix->visible_rows()) * grid_spacing()) + grid_spacing() / 2;
 404
 405                 if (i->row.bundle && i->column.bundle) {
 406
 407                         cairo_move_to (cr, x, y);
 408                         if (_matrix->arrangement() == PortMatrix::LEFT_TO_BOTTOM) {
 409                                 cairo_line_to (cr, component_to_parent_x (0), y);
 410                         } else if (_matrix->arrangement() == PortMatrix::TOP_TO_RIGHT) {
 411                                 cairo_line_to (cr, _parent_rectangle.get_x() + _parent_rectangle.get_width(), y);
 412                         }
 413                         cairo_stroke (cr);
 414
 415                         cairo_move_to (cr, x, y);
 416                         if (_matrix->arrangement() == PortMatrix::LEFT_TO_BOTTOM) {
 417                                 cairo_line_to (cr, x, _parent_rectangle.get_y() + _parent_rectangle.get_height());
 418                         } else if (_matrix->arrangement() == PortMatrix::TOP_TO_RIGHT) {
 419                                 cairo_line_to (cr, x, component_to_parent_y (0));
 420                         }
 421                         cairo_stroke (cr);
 422                 }
 423         }
 424
 425         if (_dragging && _drag_valid && _moved) {
 426
 427                 list<PortMatrixNode> const p = nodes_on_line (_drag_start_x, _drag_start_y, _drag_x, _drag_y);
 428
 429                 if (!p.empty()) {
 430
 431                         bool const s = toggle_state (_matrix->get_association (p.front()));
 432
 433                         for (list<PortMatrixNode>::const_iterator i = p.begin(); i != p.end(); ++i) {
 434                                 if (s) {
 435                                         draw_association_indicator (
 436                                                 cr,
 437                                                 component_to_parent_x (channel_to_position (i->column, _matrix->visible_columns()) * grid_spacing ()),
 438                                                 component_to_parent_y (channel_to_position (i->row, _matrix->visible_rows()) * grid_spacing ())
 439                                                 );
 440                                 } else {
 441                                         draw_empty_square (
 442                                                 cr,
 443                                                 component_to_parent_x (channel_to_position (i->column, _matrix->visible_columns()) * grid_spacing ()),
 444                                                 component_to_parent_y (channel_to_position (i->row, _matrix->visible_rows()) * grid_spacing ())
 445                                                 );
 446                                 }
 447                         }
 448                 }
 449
 450                 set_source_rgba (cr, association_colour (), 0.3);
 451
 452                 cairo_move_to (
 453                         cr,
 454                         component_to_parent_x (_drag_start_x * grid_spacing() + grid_spacing() / 2),
 455                         component_to_parent_y (_drag_start_y * grid_spacing() + grid_spacing() / 2)
 456                         );
 457
 458                 cairo_line_to (
 459                         cr,
 460                         component_to_parent_x (_drag_x * grid_spacing() + grid_spacing() / 2),
 461                         component_to_parent_y (_drag_y * grid_spacing() + grid_spacing() / 2)
 462                         );
 463
 464                 cairo_stroke (cr);
 465
 466         }
 467 }
 468
 469 void
 470 PortMatrixGrid::mouseover_changed (list<PortMatrixNode> const & old)
 471 {
 472         queue_draw_for (old);
 473         queue_draw_for (_body->mouseover());
 474 }
 475
 476 void
 477 PortMatrixGrid::motion (double x, double y)
 478 {
 479         _body->set_mouseover (position_to_node (x, y));
 480
 481         int const px = x / grid_spacing ();
 482         int const py = y / grid_spacing ();
 483
 484         if (_dragging && !_moved && ( (px != _drag_start_x || py != _drag_start_x) )) {
 485                 _moved = true;
 486         }
 487
 488         if (_dragging && _drag_valid && _moved) {
 489                 _drag_x = px;
 490                 _drag_y = py;
 491                 _body->queue_draw ();
 492         }
 493 }
 494
 495 void
 496 PortMatrixGrid::queue_draw_for (list<PortMatrixNode> const &n)
 497 {
 498         for (list<PortMatrixNode>::const_iterator i = n.begin(); i != n.end(); ++i) {
 499
 500                 if (i->row.bundle) {
 501
 502                         double const y = channel_to_position (i->row, _matrix->visible_rows()) * grid_spacing ();
 503                         _body->queue_draw_area (
 504                                 _parent_rectangle.get_x(),
 505                                 component_to_parent_y (y),
 506                                 _parent_rectangle.get_width(),
 507                                 grid_spacing()
 508                                 );
 509                 }
 510
 511                 if (i->column.bundle) {
 512
 513                         double const x = channel_to_position (i->column, _matrix->visible_columns()) * grid_spacing ();
 514
 515                         _body->queue_draw_area (
 516                                 component_to_parent_x (x),
 517                                 _parent_rectangle.get_y(),
 518                                 grid_spacing(),
 519                                 _parent_rectangle.get_height()
 520                                 );
 521                 }
 522         }
 523 }
 524
 525 double
 526 PortMatrixGrid::component_to_parent_x (double x) const
 527 {
 528         return x - _body->xoffset() + _parent_rectangle.get_x();
 529 }
 530
 531 double
 532 PortMatrixGrid::parent_to_component_x (double x) const
 533 {
 534         return x + _body->xoffset() - _parent_rectangle.get_x();
 535 }
 536
 537 double
 538 PortMatrixGrid::component_to_parent_y (double y) const
 539 {
 540         return y - _body->yoffset() + _parent_rectangle.get_y();
 541 }
 542
 543 double
 544 PortMatrixGrid::parent_to_component_y (double y) const
 545 {
 546         return y + _body->yoffset() - _parent_rectangle.get_y();
 547 }
 548
 549 list<PortMatrixNode>
 550 PortMatrixGrid::nodes_on_line (int x0, int y0, int x1, int y1) const
 551 {
 552         list<PortMatrixNode> p;
 553
 554         bool const steep = abs (y1 - y0) > abs (x1 - x0);
 555         if (steep) {
 556                 int tmp = x0;
 557                 x0 = y0;
 558                 y0 = tmp;
 559
 560                 tmp = y1;
 561                 y1 = x1;
 562                 x1 = tmp;
 563         }
 564
 565         if (x0 > x1) {
 566                 int tmp = x0;
 567                 x0 = x1;
 568                 x1 = tmp;
 569
 570                 tmp = y0;
 571                 y0 = y1;
 572                 y1 = tmp;
 573         }
 574
 575         int dx = x1 - x0;
 576         int dy = abs (y1 - y0);
 577
 578         double err = 0;
 579         double derr = double (dy) / dx;
 580
 581         int y = y0;
 582         int const ystep = y0 < y1 ? 1 : -1;
 583
 584         for (int x = x0; x <= x1; ++x) {
 585                 if (steep) {
 586                         PortMatrixNode n = position_to_node (y * grid_spacing (), x * grid_spacing ());
 587                         if (n.row.bundle && n.column.bundle) {
 588                                 p.push_back (n);
 589                         }
 590                 } else {
 591                         PortMatrixNode n = position_to_node (x * grid_spacing (), y * grid_spacing ());
 592                         if (n.row.bundle && n.column.bundle) {
 593                                 p.push_back (n);
 594                         }
 595                 }
 596
 597                 err += derr;
 598
 599                 if (err >= 0.5) {
 600                         y += ystep;
 601                         err -= 1;
 602                 }
 603         }
 604
 605         return p;
 606 }
 607
 608 bool
 609 PortMatrixGrid::toggle_state (PortMatrixNode::State s) const
 610 {
 611         return (s == PortMatrixNode::NOT_ASSOCIATED || s == PortMatrixNode::PARTIAL);
 612 }