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