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