gtk2_ardour/region_view.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
  20 #include <cmath>
  21 #include <cassert>
  22 #include <algorithm>
  23
  24 #include <gtkmm.h>
  25
  26 #include <gtkmm2ext/gtk_ui.h>
  27 #include "pbd/stacktrace.h"
  28
  29 #include "ardour/playlist.h"
  30 #include "ardour/audioregion.h"
  31 #include "ardour/audiosource.h"
  32 #include "ardour/audio_diskstream.h"
  33 #include "ardour/session.h"
  34
  35 #include "ardour_ui.h"
  36 #include "streamview.h"
  37 #include "region_view.h"
  38 #include "automation_region_view.h"
  39 #include "route_time_axis.h"
  40 #include "simplerect.h"
  41 #include "simpleline.h"
  42 #include "waveview.h"
  43 #include "public_editor.h"
  44 #include "region_editor.h"
  45 #include "ghostregion.h"
  46 #include "route_time_axis.h"
  47 #include "utils.h"
  48 #include "rgb_macros.h"
  49 #include "gui_thread.h"
  50
  51 #include "i18n.h"
  52
  53 using namespace std;
  54 using namespace ARDOUR;
  55 using namespace PBD;
  56 using namespace Editing;
  57 using namespace ArdourCanvas;
  58
  59 static const int32_t sync_mark_width = 9;
  60
  61 PBD::Signal1<void,RegionView*> RegionView::RegionViewGoingAway;
  62
  63 RegionView::RegionView (ArdourCanvas::Group*              parent,
  64                         TimeAxisView&                     tv,
  65                         boost::shared_ptr<ARDOUR::Region> r,
  66                         double                            spu,
  67                         Gdk::Color const &                basic_color)
  68         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false,
  69                             TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
  70                                                           TimeAxisViewItem::ShowNameHighlight| TimeAxisViewItem::ShowFrame))
  71         , _region (r)
  72         , sync_mark(0)
  73         , sync_line(0)
  74         , editor(0)
  75         , current_visible_sync_position(0.0)
  76         , valid(false)
  77         , _enable_display(false)
  78         , _pixel_width(1.0)
  79         , in_destructor(false)
  80         , wait_for_data(false)
  81         , _time_converter(r->session().tempo_map(), r->position())
  82 {
  83         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), ui_bind (&RegionView::remove_ghost, this, _1), gui_context());
  84 }
  85
  86 RegionView::RegionView (const RegionView& other)
  87         : sigc::trackable(other)
  88         , TimeAxisViewItem (other)
  89         , _time_converter(other._time_converter)
  90 {
  91         /* derived concrete type will call init () */
  92
  93         _region = other._region;
  94         current_visible_sync_position = other.current_visible_sync_position;
  95         valid = false;
  96         _pixel_width = other._pixel_width;
  97
  98         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), ui_bind (&RegionView::remove_ghost, this, _1), gui_context());
  99 }
 100
 101 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
 102         : sigc::trackable(other)
 103         , TimeAxisViewItem (other)
 104         , _time_converter(other._time_converter)
 105 {
 106         /* this is a pseudo-copy constructor used when dragging regions
 107            around on the canvas.
 108         */
 109
 110         /* derived concrete type will call init () */
 111
 112         _region = other_region;
 113         current_visible_sync_position = other.current_visible_sync_position;
 114         valid = false;
 115         _pixel_width = other._pixel_width;
 116
 117         GhostRegion::CatchDeletion.connect (*this, invalidator (*this), ui_bind (&RegionView::remove_ghost, this, _1), gui_context());
 118 }
 119
 120 RegionView::RegionView (ArdourCanvas::Group*         parent,
 121                         TimeAxisView&                tv,
 122                         boost::shared_ptr<ARDOUR::Region> r,
 123                         double                       spu,
 124                         Gdk::Color const &           basic_color,
 125                                                 bool recording,
 126                         TimeAxisViewItem::Visibility visibility)
 127         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, visibility)
 128         , _region (r)
 129         , sync_mark(0)
 130         , sync_line(0)
 131         , editor(0)
 132         , current_visible_sync_position(0.0)
 133         , valid(false)
 134         , _enable_display(false)
 135         , _pixel_width(1.0)
 136         , in_destructor(false)
 137         , wait_for_data(false)
 138         , _time_converter(r->session().tempo_map(), r->position())
 139 {
 140 }
 141
 142 void
 143 RegionView::init (Gdk::Color const & basic_color, bool wfd)
 144 {
 145         editor        = 0;
 146         valid         = true;
 147         in_destructor = false;
 148         wait_for_data = wfd;
 149         sync_mark     = 0;
 150         sync_line     = 0;
 151         sync_mark     = 0;
 152         sync_line     = 0;
 153
 154         compute_colors (basic_color);
 155
 156         if (name_highlight) {
 157                 name_highlight->set_data ("regionview", this);
 158                 name_highlight->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
 159
 160                 frame_handle_start->set_data ("regionview", this);
 161                 frame_handle_start->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_start, this));
 162
 163                 frame_handle_end->set_data ("regionview", this);
 164                 frame_handle_end->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_frame_handle_event), frame_handle_end, this));
 165
 166                 frame_handle_start->raise_to_top();
 167                 frame_handle_end->raise_to_top();
 168         }
 169
 170         if (name_pixbuf) {
 171                 name_pixbuf->set_data ("regionview", this);
 172                 name_pixbuf->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_event), name_pixbuf, this));
 173         }
 174
 175         if (wfd) {
 176                 _enable_display = true;
 177         }
 178
 179         set_height (trackview.current_height());
 180
 181         _region->PropertyChanged.connect (*this, invalidator (*this), ui_bind (&RegionView::region_changed, this, _1), gui_context());
 182
 183         group->signal_event().connect (sigc::bind (sigc::mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_event), group, this));
 184
 185         set_colors ();
 186
 187         ColorsChanged.connect (sigc::mem_fun (*this, &RegionView::color_handler));
 188
 189         /* XXX sync mark drag? */
 190 }
 191
 192 RegionView::~RegionView ()
 193 {
 194         in_destructor = true;
 195
 196         for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
 197                 delete *g;
 198         }
 199
 200         for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
 201                 delete *i;
 202         }
 203
 204         delete editor;
 205 }
 206
 207 gint
 208 RegionView::_lock_toggle (ArdourCanvas::Item*, GdkEvent* ev, void* arg)
 209 {
 210         switch (ev->type) {
 211         case GDK_BUTTON_RELEASE:
 212                 static_cast<RegionView*>(arg)->lock_toggle ();
 213                 return TRUE;
 214                 break;
 215         default:
 216                 break;
 217         }
 218         return FALSE;
 219 }
 220
 221 void
 222 RegionView::lock_toggle ()
 223 {
 224         _region->set_locked (!_region->locked());
 225 }
 226
 227 void
 228 RegionView::region_changed (const PropertyChange& what_changed)
 229 {
 230         ENSURE_GUI_THREAD (*this, &RegionView::region_changed, what_changed);
 231
 232         if (what_changed.contains (ARDOUR::bounds_change)) {
 233                 region_resized (what_changed);
 234                 region_sync_changed ();
 235         }
 236         if (what_changed.contains (ARDOUR::Properties::muted)) {
 237                 region_muted ();
 238         }
 239         if (what_changed.contains (ARDOUR::Properties::opaque)) {
 240                 region_opacity ();
 241         }
 242         if (what_changed.contains (ARDOUR::Properties::name)) {
 243                 region_renamed ();
 244         }
 245         if (what_changed.contains (ARDOUR::Properties::sync_position)) {
 246                 region_sync_changed ();
 247         }
 248         if (what_changed.contains (ARDOUR::Properties::locked)) {
 249                 region_locked ();
 250         }
 251 }
 252
 253 void
 254 RegionView::region_locked ()
 255 {
 256         /* name will show locked status */
 257         region_renamed ();
 258 }
 259
 260 void
 261 RegionView::region_resized (const PropertyChange& what_changed)
 262 {
 263         double unit_length;
 264
 265         if (what_changed.contains (ARDOUR::Properties::position)) {
 266                 set_position (_region->position(), 0);
 267                 _time_converter.set_origin(_region->position());
 268         }
 269
 270         PropertyChange s_and_l;
 271         s_and_l.add (ARDOUR::Properties::start);
 272         s_and_l.add (ARDOUR::Properties::length);
 273
 274         if (what_changed.contains (s_and_l)) {
 275
 276                 set_duration (_region->length(), 0);
 277
 278                 unit_length = _region->length() / samples_per_unit;
 279
 280                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 281
 282                         (*i)->set_duration (unit_length);
 283
 284                 }
 285         }
 286 }
 287
 288 void
 289 RegionView::reset_width_dependent_items (double pixel_width)
 290 {
 291         TimeAxisViewItem::reset_width_dependent_items (pixel_width);
 292         _pixel_width = pixel_width;
 293 }
 294
 295 void
 296 RegionView::region_muted ()
 297 {
 298         set_frame_color ();
 299         region_renamed ();
 300 }
 301
 302 void
 303 RegionView::region_opacity ()
 304 {
 305         set_frame_color ();
 306 }
 307
 308 void
 309 RegionView::raise_to_top ()
 310 {
 311         _region->raise_to_top ();
 312 }
 313
 314 void
 315 RegionView::lower_to_bottom ()
 316 {
 317         _region->lower_to_bottom ();
 318 }
 319
 320 bool
 321 RegionView::set_position (nframes64_t pos, void* /*src*/, double* ignored)
 322 {
 323         double delta;
 324         bool ret;
 325
 326         if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
 327                 return false;
 328         }
 329
 330         if (ignored) {
 331                 *ignored = delta;
 332         }
 333
 334         if (delta) {
 335                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 336                         (*i)->group->move (delta, 0.0);
 337                 }
 338         }
 339
 340         return ret;
 341 }
 342
 343 void
 344 RegionView::set_samples_per_unit (gdouble spu)
 345 {
 346         TimeAxisViewItem::set_samples_per_unit (spu);
 347
 348         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 349                 (*i)->set_samples_per_unit (spu);
 350                 (*i)->set_duration (_region->length() / samples_per_unit);
 351         }
 352
 353         region_sync_changed ();
 354 }
 355
 356 bool
 357 RegionView::set_duration (nframes64_t frames, void *src)
 358 {
 359         if (!TimeAxisViewItem::set_duration (frames, src)) {
 360                 return false;
 361         }
 362
 363         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 364                 (*i)->set_duration (_region->length() / samples_per_unit);
 365         }
 366
 367         return true;
 368 }
 369
 370 void
 371 RegionView::set_colors ()
 372 {
 373         TimeAxisViewItem::set_colors ();
 374
 375         if (sync_mark) {
 376                 sync_mark->property_fill_color_rgba() = fill_color;
 377                 sync_line->property_fill_color_rgba() = fill_color;
 378         }
 379 }
 380
 381 void
 382 RegionView::set_frame_color ()
 383 {
 384         if (_region->opaque()) {
 385                 fill_opacity = 130;
 386         } else {
 387                 fill_opacity = 60;
 388         }
 389
 390         TimeAxisViewItem::set_frame_color ();
 391 }
 392
 393 void
 394 RegionView::fake_set_opaque (bool yn)
 395 {
 396        if (yn) {
 397                fill_opacity = 130;
 398        } else {
 399                fill_opacity = 60;
 400        }
 401
 402        set_frame_color ();
 403 }
 404
 405 void
 406 RegionView::show_region_editor ()
 407 {
 408         if (editor == 0) {
 409                 editor = new RegionEditor (trackview.session(), region());
 410         }
 411
 412         editor->present ();
 413         editor->show_all();
 414 }
 415
 416 void
 417 RegionView::hide_region_editor()
 418 {
 419         if (editor) {
 420                 editor->hide_all ();
 421         }
 422 }
 423
 424 Glib::ustring
 425 RegionView::make_name () const
 426 {
 427         Glib::ustring str;
 428
 429         // XXX nice to have some good icons for this
 430
 431         if (_region->locked()) {
 432                 str += '>';
 433                 str += _region->name();
 434                 str += '<';
 435         } else if (_region->position_locked()) {
 436                 str += '{';
 437                 str += _region->name();
 438                 str += '}';
 439         } else {
 440                 str = _region->name();
 441         }
 442
 443         if (_region->muted()) {
 444                 str = string ("!") + str;
 445         }
 446
 447         return str;
 448 }
 449
 450 void
 451 RegionView::region_renamed ()
 452 {
 453         Glib::ustring str = make_name ();
 454
 455         set_item_name (str, this);
 456         set_name_text (str);
 457         reset_width_dependent_items (_pixel_width);
 458 }
 459
 460 void
 461 RegionView::region_sync_changed ()
 462 {
 463         int sync_dir;
 464         nframes_t sync_offset;
 465
 466         sync_offset = _region->sync_offset (sync_dir);
 467
 468         if (sync_offset == 0) {
 469                 /* no need for a sync mark */
 470                 if (sync_mark) {
 471                         sync_mark->hide();
 472                         sync_line->hide ();
 473                 }
 474                 return;
 475         }
 476
 477         if (!sync_mark) {
 478
 479                 /* points set below */
 480
 481                 sync_mark = new ArdourCanvas::Polygon (*group);
 482                 sync_mark->property_fill_color_rgba() = fill_color;
 483
 484                 sync_line = new ArdourCanvas::Line (*group);
 485                 sync_line->property_fill_color_rgba() = fill_color;
 486                 sync_line->property_width_pixels() = 1;
 487         }
 488
 489         /* this has to handle both a genuine change of position, a change of samples_per_unit,
 490            and a change in the bounds of the _region->
 491          */
 492
 493         if (sync_offset == 0) {
 494
 495                 /* no sync mark - its the start of the region */
 496
 497                 sync_mark->hide();
 498                 sync_line->hide ();
 499
 500         } else {
 501
 502                 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
 503
 504                         /* no sync mark - its out of the bounds of the region */
 505
 506                         sync_mark->hide();
 507                         sync_line->hide ();
 508
 509                 } else {
 510
 511                         /* lets do it */
 512
 513                         Points points;
 514
 515                         //points = sync_mark->property_points().get_value();
 516
 517                         double offset = sync_offset / samples_per_unit;
 518                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 519                         points.push_back (Gnome::Art::Point (offset + ((sync_mark_width-1)/2), 1));
 520                         points.push_back (Gnome::Art::Point (offset, sync_mark_width - 1));
 521                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 522                         sync_mark->property_points().set_value (points);
 523                         sync_mark->show ();
 524
 525                         points.clear ();
 526                         points.push_back (Gnome::Art::Point (offset, 0));
 527                         points.push_back (Gnome::Art::Point (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
 528
 529                         sync_line->property_points().set_value (points);
 530                         sync_line->show ();
 531                 }
 532         }
 533 }
 534
 535 void
 536 RegionView::move (double x_delta, double y_delta)
 537 {
 538         if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
 539                 return;
 540         }
 541
 542         get_canvas_group()->move (x_delta, y_delta);
 543
 544         /* note: ghosts never leave their tracks so y_delta for them is always zero */
 545
 546         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 547                 (*i)->group->move (x_delta, 0.0);
 548         }
 549 }
 550
 551 void
 552 RegionView::remove_ghost_in (TimeAxisView& tv)
 553 {
 554         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 555                 if (&(*i)->trackview == &tv) {
 556                         delete *i;
 557                         break;
 558                 }
 559         }
 560 }
 561
 562 void
 563 RegionView::remove_ghost (GhostRegion* ghost)
 564 {
 565         if (in_destructor) {
 566                 return;
 567         }
 568
 569         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 570                 if (*i == ghost) {
 571                         ghosts.erase (i);
 572                         break;
 573                 }
 574         }
 575 }
 576
 577 uint32_t
 578 RegionView::get_fill_color ()
 579 {
 580         return fill_color;
 581 }
 582
 583 void
 584 RegionView::set_height (double h)
 585 {
 586         TimeAxisViewItem::set_height(h);
 587
 588         if (sync_line) {
 589                 Points points;
 590                 int sync_dir;
 591                 nframes_t sync_offset;
 592                 sync_offset = _region->sync_offset (sync_dir);
 593                 double offset = sync_offset / samples_per_unit;
 594
 595                 points.push_back (Gnome::Art::Point (offset, 0));
 596                 points.push_back (Gnome::Art::Point (offset, h - NAME_HIGHLIGHT_SIZE));
 597                 sync_line->property_points().set_value (points);
 598         }
 599
 600         for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin(); i != _coverage_frames.end(); ++i) {
 601                 (*i)->property_y2() = h + 1;
 602         }
 603 }
 604
 605 /** Remove old coverage frames and make new ones, if we're in a LayerDisplay mode
 606  *  which uses them. */
 607 void
 608 RegionView::update_coverage_frames (LayerDisplay d)
 609 {
 610         /* remove old coverage frames */
 611         for (list<ArdourCanvas::SimpleRect*>::iterator i = _coverage_frames.begin (); i != _coverage_frames.end (); ++i) {
 612                 delete *i;
 613         }
 614
 615         _coverage_frames.clear ();
 616
 617         if (d != Stacked) {
 618                 /* don't do coverage frames unless we're in stacked mode */
 619                 return;
 620         }
 621
 622         boost::shared_ptr<Playlist> pl (_region->playlist ());
 623         if (!pl) {
 624                 return;
 625         }
 626
 627         nframes_t const position = _region->first_frame ();
 628         nframes_t t = position;
 629         nframes_t const end = _region->last_frame ();
 630
 631         ArdourCanvas::SimpleRect* cr = 0;
 632         bool me = false;
 633
 634         uint32_t const color = frame->property_fill_color_rgba ();
 635         uint32_t const base_alpha = UINT_RGBA_A (color);
 636
 637         while (t < end) {
 638
 639                 t++;
 640
 641                 /* is this region is on top at time t? */
 642                 bool const new_me = (pl->top_unmuted_region_at (t) == _region);
 643
 644                 /* finish off any old rect, if required */
 645                 if (cr && me != new_me) {
 646                         cr->property_x2() = trackview.editor().frame_to_pixel (t - position);
 647                 }
 648
 649                 /* start off any new rect, if required */
 650                 if (cr == 0 || me != new_me) {
 651                         cr = new ArdourCanvas::SimpleRect (*group);
 652                         _coverage_frames.push_back (cr);
 653                         cr->property_x1() = trackview.editor().frame_to_pixel (t - position);
 654                         cr->property_y1() = 1;
 655                         cr->property_y2() = _height + 1;
 656                         cr->property_outline_pixels() = 0;
 657                         /* areas that will be played get a lower alpha */
 658                         uint32_t alpha = base_alpha;
 659                         if (new_me) {
 660                                 alpha /= 2;
 661                         }
 662                         cr->property_fill_color_rgba () = UINT_RGBA_CHANGE_A (color, alpha);
 663                 }
 664
 665                 t = pl->find_next_region_boundary (t, 1);
 666                 me = new_me;
 667         }
 668
 669         if (cr) {
 670                 /* finish off the last rectangle */
 671                 cr->property_x2() = trackview.editor().frame_to_pixel (end - position);
 672         }
 673
 674         frame_handle_start->raise_to_top ();
 675         frame_handle_end->raise_to_top ();
 676 }