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