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         if (editor) {
 183                 delete editor;
 184         }
 185 }
 186
 187 gint
 188 RegionView::_lock_toggle (ArdourCanvas::Item* item, GdkEvent* ev, void* arg)
 189 {
 190         switch (ev->type) {
 191         case GDK_BUTTON_RELEASE:
 192                 static_cast<RegionView*>(arg)->lock_toggle ();
 193                 return TRUE;
 194                 break;
 195         default:
 196                 break;
 197         }
 198         return FALSE;
 199 }
 200
 201 void
 202 RegionView::lock_toggle ()
 203 {
 204         _region->set_locked (!_region->locked());
 205 }
 206
 207 void
 208 RegionView::region_changed (Change what_changed)
 209 {
 210         ENSURE_GUI_THREAD (bind (mem_fun(*this, &RegionView::region_changed), what_changed));
 211
 212         if (what_changed & BoundsChanged) {
 213                 region_resized (what_changed);
 214                 region_sync_changed ();
 215         }
 216         if (what_changed & Region::MuteChanged) {
 217                 region_muted ();
 218         }
 219         if (what_changed & Region::OpacityChanged) {
 220                 region_opacity ();
 221         }
 222         if (what_changed & ARDOUR::NameChanged) {
 223                 region_renamed ();
 224         }
 225         if (what_changed & Region::SyncOffsetChanged) {
 226                 region_sync_changed ();
 227         }
 228         /*
 229            this should not be needed now that only playlist can change layering
 230         */
 231         /*
 232         if (what_changed & Region::LayerChanged) {
 233                 // this is handled by the playlist i believe
 234                 //region_layered ();
 235         }
 236         */
 237         if (what_changed & Region::LockChanged) {
 238                 region_locked ();
 239         }
 240 }
 241
 242 void
 243 RegionView::region_locked ()
 244 {
 245         /* name will show locked status */
 246         region_renamed ();
 247 }
 248
 249 void
 250 RegionView::region_resized (Change what_changed)
 251 {
 252         double unit_length;
 253
 254         if (what_changed & ARDOUR::PositionChanged) {
 255                 set_position (_region->position(), 0);
 256         }
 257
 258         if (what_changed & Change (StartChanged|LengthChanged)) {
 259
 260                 set_duration (_region->length(), 0);
 261
 262                 unit_length = _region->length() / samples_per_unit;
 263
 264                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 265
 266                         (*i)->set_duration (unit_length);
 267
 268                 }
 269         }
 270 }
 271
 272 void
 273 RegionView::reset_width_dependent_items (double pixel_width)
 274 {
 275         TimeAxisViewItem::reset_width_dependent_items (pixel_width);
 276         _pixel_width = pixel_width;
 277
 278         /*for (AutomationChildren::iterator i = _automation_children.begin();
 279                         i != _automation_children.end(); ++i) {
 280                 i->second->reset_width_dependent_items(pixel_width);
 281         }*/
 282 }
 283
 284 void
 285 RegionView::region_layered ()
 286 {
 287         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*>(&get_time_axis_view());
 288         assert(rtv);
 289         //rtv->view()->region_layered (this);
 290 }
 291
 292 void
 293 RegionView::region_muted ()
 294 {
 295         set_frame_color ();
 296         region_renamed ();
 297 }
 298
 299 void
 300 RegionView::region_opacity ()
 301 {
 302         set_frame_color ();
 303 }
 304
 305 void
 306 RegionView::raise_to_top ()
 307 {
 308         _region->raise_to_top ();
 309 }
 310
 311 void
 312 RegionView::lower_to_bottom ()
 313 {
 314         _region->lower_to_bottom ();
 315 }
 316
 317 bool
 318 RegionView::set_position (nframes_t pos, void* src, double* ignored)
 319 {
 320         double delta;
 321         bool ret;
 322
 323         if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
 324                 return false;
 325         }
 326
 327         if (ignored) {
 328                 *ignored = delta;
 329         }
 330
 331         if (delta) {
 332                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 333                         (*i)->group->move (delta, 0.0);
 334                 }
 335
 336                 for (AutomationChildren::iterator i = _automation_children.begin();
 337                                 i != _automation_children.end(); ++i) {
 338                         i->second->get_canvas_group()->move(delta, 0.0);
 339                 }
 340         }
 341
 342         return ret;
 343 }
 344
 345 void
 346 RegionView::set_samples_per_unit (gdouble spu)
 347 {
 348         TimeAxisViewItem::set_samples_per_unit (spu);
 349
 350         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 351                 (*i)->set_samples_per_unit (spu);
 352                 (*i)->set_duration (_region->length() / samples_per_unit);
 353         }
 354
 355         region_sync_changed ();
 356 }
 357
 358 bool
 359 RegionView::set_duration (nframes_t frames, void *src)
 360 {
 361         if (!TimeAxisViewItem::set_duration (frames, src)) {
 362                 return false;
 363         }
 364
 365         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 366                 (*i)->set_duration (_region->length() / samples_per_unit);
 367         }
 368
 369         return true;
 370 }
 371
 372 void
 373 RegionView::compute_colors (Gdk::Color& basic_color)
 374 {
 375         TimeAxisViewItem::compute_colors (basic_color);
 376 }
 377
 378 void
 379 RegionView::set_colors ()
 380 {
 381         TimeAxisViewItem::set_colors ();
 382
 383         if (sync_mark) {
 384                 sync_mark->property_fill_color_rgba() = fill_color;
 385                 sync_line->property_fill_color_rgba() = fill_color;
 386         }
 387 }
 388
 389 void
 390 RegionView::set_frame_color ()
 391 {
 392         if (_region->opaque()) {
 393                 fill_opacity = 130;
 394         } else {
 395                 fill_opacity = 60;
 396         }
 397
 398         TimeAxisViewItem::set_frame_color ();
 399 }
 400
 401 void
 402 RegionView::fake_set_opaque (bool yn)
 403 {
 404        if (yn) {
 405                fill_opacity = 130;
 406        } else {
 407                fill_opacity = 60;
 408        }
 409
 410        set_frame_color ();
 411 }
 412
 413 void
 414 RegionView::hide_region_editor()
 415 {
 416         if (editor) {
 417                 editor->hide_all ();
 418         }
 419 }
 420
 421 Glib::ustring
 422 RegionView::make_name () const
 423 {
 424         Glib::ustring str;
 425
 426         // XXX nice to have some good icons for this
 427
 428         if (_region->locked()) {
 429                 str += '>';
 430                 str += _region->name();
 431                 str += '<';
 432         } else if (_region->position_locked()) {
 433                 str += '{';
 434                 str += _region->name();
 435                 str += '}';
 436         } else {
 437                 str = _region->name();
 438         }
 439
 440         if (_region->muted()) {
 441                 str = string ("!") + str;
 442         }
 443
 444         return str;
 445 }
 446
 447 void
 448 RegionView::region_renamed ()
 449 {
 450         Glib::ustring str = make_name ();
 451
 452         set_item_name (str, this);
 453         set_name_text (str);
 454         reset_width_dependent_items (_pixel_width);
 455 }
 456
 457 void
 458 RegionView::region_sync_changed ()
 459 {
 460         int sync_dir;
 461         nframes_t sync_offset;
 462
 463         sync_offset = _region->sync_offset (sync_dir);
 464
 465         if (sync_offset == 0) {
 466                 /* no need for a sync mark */
 467                 if (sync_mark) {
 468                         sync_mark->hide();
 469                         sync_line->hide ();
 470                 }
 471                 return;
 472         }
 473
 474         if (!sync_mark) {
 475
 476                 /* points set below */
 477
 478                 sync_mark =  new ArdourCanvas::Polygon (*group);
 479                 sync_mark->property_fill_color_rgba() = fill_color;
 480
 481                 sync_line = new ArdourCanvas::Line (*group);
 482                 sync_line->property_fill_color_rgba() = fill_color;
 483                 sync_line->property_width_pixels() = 1;
 484         }
 485
 486         /* this has to handle both a genuine change of position, a change of samples_per_unit,
 487            and a change in the bounds of the _region->
 488          */
 489
 490         if (sync_offset == 0) {
 491
 492                 /* no sync mark - its the start of the region */
 493
 494                 sync_mark->hide();
 495                 sync_line->hide ();
 496
 497         } else {
 498
 499                 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
 500
 501                         /* no sync mark - its out of the bounds of the region */
 502
 503                         sync_mark->hide();
 504                         sync_line->hide ();
 505
 506                 } else {
 507
 508                         /* lets do it */
 509
 510                         Points points;
 511
 512                         //points = sync_mark->property_points().get_value();
 513
 514                         double offset = sync_offset / samples_per_unit;
 515                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 516                         points.push_back (Gnome::Art::Point (offset + ((sync_mark_width-1)/2), 1));
 517                         points.push_back (Gnome::Art::Point (offset, sync_mark_width - 1));
 518                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 519                         sync_mark->property_points().set_value (points);
 520                         sync_mark->show ();
 521
 522                         points.clear ();
 523                         points.push_back (Gnome::Art::Point (offset, 0));
 524                         points.push_back (Gnome::Art::Point (offset, trackview.current_height() - NAME_HIGHLIGHT_SIZE));
 525
 526                         sync_line->property_points().set_value (points);
 527                         sync_line->show ();
 528                 }
 529         }
 530 }
 531
 532 void
 533 RegionView::move (double x_delta, double y_delta)
 534 {
 535         if (!_region->can_move() || (x_delta == 0 && y_delta == 0)) {
 536                 return;
 537         }
 538
 539         get_canvas_group()->move (x_delta, y_delta);
 540
 541         /* note: ghosts never leave their tracks so y_delta for them is always zero */
 542
 543         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 544                 (*i)->group->move (x_delta, 0.0);
 545         }
 546
 547         for (AutomationChildren::iterator i = _automation_children.begin();
 548                         i != _automation_children.end(); ++i) {
 549                 i->second->get_canvas_group()->move(x_delta, 0.0);
 550         }
 551 }
 552
 553 void
 554 RegionView::remove_ghost_in (TimeAxisView& tv)
 555 {
 556         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 557                 if (&(*i)->trackview == &tv) {
 558                         delete *i;
 559                         break;
 560                 }
 561         }
 562 }
 563
 564 void
 565 RegionView::remove_ghost (GhostRegion* ghost)
 566 {
 567         if (in_destructor) {
 568                 return;
 569         }
 570
 571         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 572                 if (*i == ghost) {
 573                         ghosts.erase (i);
 574                         break;
 575                 }
 576         }
 577 }
 578
 579 uint32_t
 580 RegionView::get_fill_color ()
 581 {
 582         return fill_color;
 583 }
 584
 585 void
 586 RegionView::set_height (double 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 }