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