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