gtk2_ardour/streamview.cc

   1 /*
   2     Copyright (C) 2001, 2006 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 #include <cmath>
  20
  21 #include <gtkmm.h>
  22
  23 #include <gtkmm2ext/gtk_ui.h>
  24
  25 #include "ardour/playlist.h"
  26 #include "ardour/region.h"
  27 #include "ardour/source.h"
  28 #include "ardour/diskstream.h"
  29 #include "ardour/track.h"
  30 #include "ardour/session.h"
  31
  32 #include "streamview.h"
  33 #include "region_view.h"
  34 #include "route_time_axis.h"
  35 #include "canvas-waveview.h"
  36 #include "canvas-simplerect.h"
  37 #include "region_selection.h"
  38 #include "selection.h"
  39 #include "public_editor.h"
  40 #include "ardour_ui.h"
  41 #include "rgb_macros.h"
  42 #include "gui_thread.h"
  43 #include "utils.h"
  44
  45 using namespace std;
  46 using namespace ARDOUR;
  47 using namespace PBD;
  48 using namespace Editing;
  49
  50 StreamView::StreamView (RouteTimeAxisView& tv, ArdourCanvas::Group* group)
  51         : _trackview (tv)
  52         , owns_canvas_group(group == 0)
  53         , _background_group (new ArdourCanvas::Group (*_trackview.canvas_background()))
  54         , canvas_group(group ? group : new ArdourCanvas::Group(*_trackview.canvas_display()))
  55         , _samples_per_unit (_trackview.editor().get_current_zoom ())
  56         , rec_updating(false)
  57         , rec_active(false)
  58         , use_rec_regions (tv.editor().show_waveforms_recording ())
  59         , region_color(_trackview.color())
  60         , stream_base_color(0xFFFFFFFF)
  61         , _layers (1)
  62         , _layer_display (Overlaid)
  63         , height(tv.height)
  64         , last_rec_data_frame(0)
  65 {
  66         /* set_position() will position the group */
  67
  68         canvas_rect = new ArdourCanvas::SimpleRect (*_background_group);
  69         canvas_rect->property_x1() = 0.0;
  70         canvas_rect->property_y1() = 0.0;
  71         canvas_rect->property_x2() = _trackview.editor().get_physical_screen_width ();
  72         canvas_rect->property_y2() = (double) tv.current_height();
  73         canvas_rect->raise(1); // raise above tempo lines
  74
  75         canvas_rect->property_outline_what() = (guint32) (0x2|0x8);  // outline RHS and bottom
  76
  77         canvas_rect->signal_event().connect (sigc::bind (
  78                         sigc::mem_fun (_trackview.editor(), &PublicEditor::canvas_stream_view_event),
  79                         canvas_rect, &_trackview));
  80
  81         if (_trackview.is_track()) {
  82                 _trackview.track()->DiskstreamChanged.connect (*this, boost::bind (&StreamView::diskstream_changed, this), gui_context());
  83                 _trackview.get_diskstream()->RecordEnableChanged.connect (*this, boost::bind (&StreamView::rec_enable_changed, this), gui_context());
  84
  85                 _trackview.session()->TransportStateChange.connect (*this, boost::bind (&StreamView::transport_changed, this), gui_context());
  86                 _trackview.session()->TransportLooped.connect (*this, boost::bind (&StreamView::transport_looped, this), gui_context());
  87                 _trackview.session()->RecordStateChanged.connect (*this, boost::bind (&StreamView::sess_rec_enable_changed, this), gui_context());
  88         }
  89
  90         ColorsChanged.connect (sigc::mem_fun (*this, &StreamView::color_handler));
  91 }
  92
  93 StreamView::~StreamView ()
  94 {
  95         undisplay_diskstream ();
  96
  97         delete canvas_rect;
  98
  99         if (owns_canvas_group) {
 100                 delete canvas_group;
 101         }
 102 }
 103
 104 void
 105 StreamView::attach ()
 106 {
 107         if (_trackview.is_track()) {
 108                 display_diskstream (_trackview.get_diskstream());
 109         }
 110 }
 111
 112 int
 113 StreamView::set_position (gdouble x, gdouble y)
 114 {
 115         canvas_group->property_x() = x;
 116         canvas_group->property_y() = y;
 117         return 0;
 118 }
 119
 120 int
 121 StreamView::set_height (double h)
 122 {
 123         /* limit the values to something sane-ish */
 124         if (h < 10.0 || h > 1000.0) {
 125                 return -1;
 126         }
 127
 128         if (canvas_rect->property_y2() == h) {
 129                 return 0;
 130         }
 131
 132         height = h;
 133         canvas_rect->property_y2() = height;
 134         update_contents_height ();
 135
 136         HeightChanged ();
 137
 138         return 0;
 139 }
 140
 141 int
 142 StreamView::set_samples_per_unit (gdouble spp)
 143 {
 144         RegionViewList::iterator i;
 145
 146         if (spp < 1.0) {
 147                 return -1;
 148         }
 149
 150         _samples_per_unit = spp;
 151
 152         for (i = region_views.begin(); i != region_views.end(); ++i) {
 153                 (*i)->set_samples_per_unit (spp);
 154         }
 155
 156         for (vector<RecBoxInfo>::iterator xi = rec_rects.begin(); xi != rec_rects.end(); ++xi) {
 157                 RecBoxInfo &recbox = (*xi);
 158
 159                 gdouble xstart = _trackview.editor().frame_to_pixel (recbox.start);
 160                 gdouble xend = _trackview.editor().frame_to_pixel (recbox.start + recbox.length);
 161
 162                 recbox.rectangle->property_x1() = xstart;
 163                 recbox.rectangle->property_x2() = xend;
 164         }
 165
 166         update_coverage_frames ();
 167
 168         return 0;
 169 }
 170
 171 void
 172 StreamView::add_region_view (boost::weak_ptr<Region> wr)
 173 {
 174         boost::shared_ptr<Region> r (wr.lock());
 175         if (!r) {
 176                 return;
 177         }
 178
 179         add_region_view_internal (r, true);
 180
 181         if (_layer_display == Stacked) {
 182                 update_contents_height ();
 183         }
 184 }
 185
 186 void
 187 StreamView::remove_region_view (boost::weak_ptr<Region> weak_r)
 188 {
 189         ENSURE_GUI_THREAD (*this, &StreamView::remove_region_view, weak_r)
 190
 191         boost::shared_ptr<Region> r (weak_r.lock());
 192
 193         if (!r) {
 194                 return;
 195         }
 196
 197         for (list<RegionView *>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 198                 if (((*i)->region()) == r) {
 199                         RegionView* rv = *i;
 200                         region_views.erase (i);
 201                         cerr << "Deleting RV for " << r->name() << " @ " << r << endl;
 202                         delete rv;
 203                         break;
 204                 }
 205         }
 206 }
 207
 208 void
 209 StreamView::undisplay_diskstream ()
 210 {
 211         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end() ; ) {
 212                 RegionViewList::iterator next = i;
 213                 ++next;
 214                 delete *i;
 215                 i = next;
 216         }
 217
 218         region_views.clear();
 219 }
 220
 221 void
 222 StreamView::display_diskstream (boost::shared_ptr<Diskstream> ds)
 223 {
 224         playlist_switched_connection.disconnect();
 225         playlist_switched (ds);
 226         ds->PlaylistChanged.connect (playlist_switched_connection, boost::bind (&StreamView::playlist_switched, this, boost::weak_ptr<Diskstream> (ds)), gui_context());
 227 }
 228
 229 void
 230 StreamView::layer_regions()
 231 {
 232         // In one traversal of the region view list:
 233         // - Build a list of region views sorted by layer
 234         // - Remove invalid views from the actual region view list
 235         RegionViewList copy;
 236         list<RegionView*>::iterator i, tmp;
 237         for (i = region_views.begin(); i != region_views.end(); ) {
 238                 tmp = i;
 239                 tmp++;
 240
 241                 if (!(*i)->is_valid()) {
 242                         delete *i;
 243                         region_views.erase (i);
 244                         i = tmp;
 245                         continue;
 246                 } else {
 247                         (*i)->enable_display(true);
 248                 }
 249
 250                 if (copy.size() == 0) {
 251                         copy.push_front((*i));
 252                         i = tmp;
 253                         continue;
 254                 }
 255
 256                 RegionViewList::iterator k = copy.begin();
 257                 RegionViewList::iterator l = copy.end();
 258                 l--;
 259
 260                 if ((*i)->region()->layer() <= (*k)->region()->layer()) {
 261                         copy.push_front((*i));
 262                         i = tmp;
 263                         continue;
 264                 } else if ((*i)->region()->layer() >= (*l)->region()->layer()) {
 265                         copy.push_back((*i));
 266                         i = tmp;
 267                         continue;
 268                 }
 269
 270                 for (RegionViewList::iterator j = copy.begin(); j != copy.end(); ++j) {
 271                         if ((*j)->region()->layer() >= (*i)->region()->layer()) {
 272                                 copy.insert(j, (*i));
 273                                 break;
 274                         }
 275                 }
 276
 277                 i = tmp;
 278         }
 279
 280         // Fix canvas layering by raising each to the top in the sorted order.
 281         for (RegionViewList::iterator i = copy.begin(); i != copy.end(); ++i) {
 282                 (*i)->get_canvas_group()->raise_to_top ();
 283         }
 284 }
 285
 286 void
 287 StreamView::playlist_layered (boost::weak_ptr<Diskstream> wds)
 288 {
 289         boost::shared_ptr<Diskstream> ds (wds.lock());
 290
 291         if (!ds) {
 292                 return;
 293         }
 294
 295         /* update layers count and the y positions and heights of our regions */
 296         if (ds->playlist()) {
 297                 _layers = ds->playlist()->top_layer() + 1;
 298         }
 299
 300         if (_layer_display == Stacked) {
 301                 update_contents_height ();
 302                 update_coverage_frames ();
 303         } else {
 304                 /* layering has probably been modified. reflect this in the canvas. */
 305                 layer_regions();
 306         }
 307 }
 308
 309 void
 310 StreamView::playlist_switched (boost::weak_ptr<Diskstream> wds)
 311 {
 312         boost::shared_ptr<Diskstream> ds (wds.lock());
 313
 314         if (!ds) {
 315                 return;
 316         }
 317
 318         /* disconnect from old playlist */
 319
 320         playlist_connections.drop_connections ();
 321         undisplay_diskstream ();
 322
 323         /* update layers count and the y positions and heights of our regions */
 324         _layers = ds->playlist()->top_layer() + 1;
 325         update_contents_height ();
 326         update_coverage_frames ();
 327
 328         ds->playlist()->set_explicit_relayering (_layer_display == Stacked);
 329
 330         /* draw it */
 331
 332         redisplay_diskstream ();
 333
 334         /* catch changes */
 335
 336         ds->playlist()->LayeringChanged.connect (playlist_connections, boost::bind (&StreamView::playlist_layered, this, boost::weak_ptr<Diskstream>(ds)), gui_context());
 337         ds->playlist()->RegionAdded.connect (playlist_connections, ui_bind (&StreamView::add_region_view, this, _1), gui_context());
 338         ds->playlist()->RegionRemoved.connect (playlist_connections, ui_bind (&StreamView::remove_region_view, this, _1), gui_context());
 339         // ds->playlist()->ContentsChanged.connect (playlist_connections, boost::bind (&StreamView::redisplay_diskstream, this), gui_context());
 340 }
 341
 342 void
 343 StreamView::diskstream_changed ()
 344 {
 345         boost::shared_ptr<Track> t;
 346
 347         if ((t = _trackview.track()) != 0) {
 348                 Gtkmm2ext::UI::instance()->call_slot (boost::bind (&StreamView::display_diskstream, this, t->diskstream()));
 349         } else {
 350                 Gtkmm2ext::UI::instance()->call_slot (boost::bind (&StreamView::undisplay_diskstream, this));
 351         }
 352 }
 353
 354 void
 355 StreamView::apply_color (Gdk::Color& color, ColorTarget target)
 356
 357 {
 358         list<RegionView *>::iterator i;
 359
 360         switch (target) {
 361         case RegionColor:
 362                 region_color = color;
 363                 for (i = region_views.begin(); i != region_views.end(); ++i) {
 364                         (*i)->set_color (region_color);
 365                 }
 366                 break;
 367
 368         case StreamBaseColor:
 369                 stream_base_color = RGBA_TO_UINT (
 370                         color.get_red_p(), color.get_green_p(), color.get_blue_p(), 255);
 371                 canvas_rect->property_fill_color_rgba() = stream_base_color;
 372                 break;
 373         }
 374 }
 375
 376 void
 377 StreamView::region_layered (RegionView* rv)
 378 {
 379         /* don't ever leave it at the bottom, since then it doesn't
 380            get events - the  parent group does instead ...
 381         */
 382         rv->get_canvas_group()->raise (rv->region()->layer());
 383 }
 384
 385 void
 386 StreamView::rec_enable_changed ()
 387 {
 388         setup_rec_box ();
 389 }
 390
 391 void
 392 StreamView::sess_rec_enable_changed ()
 393 {
 394         setup_rec_box ();
 395 }
 396
 397 void
 398 StreamView::transport_changed()
 399 {
 400         setup_rec_box ();
 401 }
 402
 403 void
 404 StreamView::transport_looped()
 405 {
 406         // to force a new rec region
 407         rec_active = false;
 408         Gtkmm2ext::UI::instance()->call_slot (boost::bind (&StreamView::setup_rec_box, this));
 409 }
 410
 411 void
 412 StreamView::update_rec_box ()
 413 {
 414         if (rec_active && rec_rects.size() > 0) {
 415                 /* only update the last box */
 416                 RecBoxInfo & rect = rec_rects.back();
 417                 nframes_t at = _trackview.get_diskstream()->current_capture_end();
 418                 double xstart;
 419                 double xend;
 420
 421                 switch (_trackview.track()->mode()) {
 422
 423                 case NonLayered:
 424                 case Normal:
 425                         rect.length = at - rect.start;
 426                         xstart = _trackview.editor().frame_to_pixel (rect.start);
 427                         xend = _trackview.editor().frame_to_pixel (at);
 428                         break;
 429
 430                 case Destructive:
 431                         rect.length = 2;
 432                         xstart = _trackview.editor().frame_to_pixel (_trackview.get_diskstream()->current_capture_start());
 433                         xend = _trackview.editor().frame_to_pixel (at);
 434                         break;
 435                 }
 436
 437                 rect.rectangle->property_x1() = xstart;
 438                 rect.rectangle->property_x2() = xend;
 439         }
 440 }
 441
 442 RegionView*
 443 StreamView::find_view (boost::shared_ptr<const Region> region)
 444 {
 445         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 446
 447                 if ((*i)->region() == region) {
 448                         return *i;
 449                 }
 450         }
 451         return 0;
 452 }
 453
 454 uint32_t
 455 StreamView::num_selected_regionviews () const
 456 {
 457         uint32_t cnt = 0;
 458
 459         for (list<RegionView*>::const_iterator i = region_views.begin(); i != region_views.end(); ++i) {
 460                 if ((*i)->get_selected()) {
 461                         ++cnt;
 462                 }
 463         }
 464         return cnt;
 465 }
 466
 467 void
 468 StreamView::foreach_regionview (sigc::slot<void,RegionView*> slot)
 469 {
 470         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 471                 slot (*i);
 472         }
 473 }
 474
 475 void
 476 StreamView::foreach_selected_regionview (sigc::slot<void,RegionView*> slot)
 477 {
 478         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 479                 if ((*i)->get_selected()) {
 480                         slot (*i);
 481                 }
 482         }
 483 }
 484
 485 void
 486 StreamView::set_selected_regionviews (RegionSelection& regions)
 487 {
 488         bool selected;
 489
 490         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 491
 492                 selected = false;
 493
 494                 for (RegionSelection::iterator ii = regions.begin(); ii != regions.end(); ++ii) {
 495                         if (*i == *ii) {
 496                                 selected = true;
 497                                 break;
 498                         }
 499                 }
 500
 501                 (*i)->set_selected (selected);
 502         }
 503 }
 504
 505 void
 506 StreamView::get_selectables (nframes_t start, nframes_t end, double top, double bottom, list<Selectable*>& results)
 507 {
 508         layer_t min_layer = 0;
 509         layer_t max_layer = 0;
 510
 511         if (_layer_display == Stacked) {
 512                 double const c = child_height ();
 513                 min_layer = _layers - ((bottom - _trackview.y_position()) / c);
 514                 max_layer = _layers - ((top - _trackview.y_position()) / c);
 515         }
 516
 517         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 518
 519                 bool layer_ok = true;
 520
 521                 if (_layer_display == Stacked) {
 522                         layer_t const l = (*i)->region()->layer ();
 523                         layer_ok = (min_layer <= l && l <= max_layer);
 524                 }
 525
 526                 if ((*i)->region()->coverage (start, end) != OverlapNone && layer_ok) {
 527                         results.push_back (*i);
 528                 }
 529         }
 530 }
 531
 532 void
 533 StreamView::get_inverted_selectables (Selection& sel, list<Selectable*>& results)
 534 {
 535         for (list<RegionView*>::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 536                 if (!sel.regions.contains (*i)) {
 537                         results.push_back (*i);
 538                 }
 539         }
 540 }
 541
 542 /** @return height of a child region view, depending on stacked / overlaid mode */
 543 double
 544 StreamView::child_height () const
 545 {
 546         if (_layer_display == Stacked) {
 547                 return height / _layers;
 548         }
 549
 550         return height;
 551 }
 552
 553 void
 554 StreamView::update_contents_height ()
 555 {
 556         const double h = child_height ();
 557
 558         for (RegionViewList::iterator i = region_views.begin(); i != region_views.end(); ++i) {
 559                 switch (_layer_display) {
 560                 case Overlaid:
 561                         (*i)->set_y (0);
 562                         break;
 563                 case Stacked:
 564                         (*i)->set_y (height - ((*i)->region()->layer() + 1) * h);
 565                         break;
 566                 }
 567
 568                 (*i)->set_height (h);
 569         }
 570
 571         for (vector<RecBoxInfo>::iterator i = rec_rects.begin(); i != rec_rects.end(); ++i) {
 572                 i->rectangle->property_y2() = height - 1.0;
 573         }
 574 }
 575
 576 void
 577 StreamView::set_layer_display (LayerDisplay d)
 578 {
 579         _layer_display = d;
 580         update_contents_height ();
 581         update_coverage_frames ();
 582         _trackview.get_diskstream()->playlist()->set_explicit_relayering (_layer_display == Stacked);
 583 }
 584
 585 void
 586 StreamView::update_coverage_frames ()
 587 {
 588         for (RegionViewList::iterator i = region_views.begin (); i != region_views.end (); ++i) {
 589                 (*i)->update_coverage_frames (_layer_display);
 590         }
 591 }