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 "streamview.h"
  35 #include "region_view.h"
  36 #include "route_time_axis.h"
  37 #include "simplerect.h"
  38 #include "simpleline.h"
  39 #include "waveview.h"
  40 #include "public_editor.h"
  41 #include "region_editor.h"
  42 #include "ghostregion.h"
  43 #include "route_time_axis.h"
  44 #include "utils.h"
  45 #include "rgb_macros.h"
  46 #include "gui_thread.h"
  47 #include "ardour_ui.h"
  48
  49 #include "i18n.h"
  50
  51 using namespace sigc;
  52 using namespace ARDOUR;
  53 using namespace PBD;
  54 using namespace Editing;
  55 using namespace ArdourCanvas;
  56
  57 static const int32_t sync_mark_width = 9;
  58
  59 sigc::signal<void,RegionView*> RegionView::RegionViewGoingAway;
  60
  61 RegionView::RegionView (ArdourCanvas::Group* parent,
  62                         TimeAxisView&        tv,
  63                         boost::shared_ptr<ARDOUR::Region> r,
  64                         double               spu,
  65                         Gdk::Color&          basic_color
  66                                                 )
  67         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), false,
  68                             TimeAxisViewItem::Visibility (TimeAxisViewItem::ShowNameText|
  69                                                           TimeAxisViewItem::ShowNameHighlight|
  70                                                           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           , _pixel_width(1.0)
  78           , _height(1.0)
  79           , in_destructor(false)
  80           , wait_for_data(false)
  81 {
  82 }
  83
  84 RegionView::RegionView (const RegionView& other)
  85         : TimeAxisViewItem (other)
  86 {
  87         /* derived concrete type will call init () */
  88
  89         _region = other._region;
  90         current_visible_sync_position = other.current_visible_sync_position;
  91         valid = false;
  92         _pixel_width = other._pixel_width;
  93         _height = other._height;
  94 }
  95
  96 RegionView::RegionView (const RegionView& other, boost::shared_ptr<Region> other_region)
  97         : TimeAxisViewItem (other)
  98 {
  99         /* this is a pseudo-copy constructor used when dragging regions
 100            around on the canvas.
 101         */
 102
 103         /* derived concrete type will call init () */
 104
 105         _region = other_region;
 106         current_visible_sync_position = other.current_visible_sync_position;
 107         valid = false;
 108         _pixel_width = other._pixel_width;
 109         _height = other._height;
 110 }
 111
 112 RegionView::RegionView (ArdourCanvas::Group*         parent,
 113                         TimeAxisView&                tv,
 114                         boost::shared_ptr<ARDOUR::Region> r,
 115                         double                       spu,
 116                         Gdk::Color&                  basic_color,
 117                                                 bool recording,
 118                         TimeAxisViewItem::Visibility visibility)
 119         : TimeAxisViewItem (r->name(), *parent, tv, spu, basic_color, r->position(), r->length(), recording, visibility)
 120         , _region (r)
 121         , sync_mark(0)
 122         , sync_line(0)
 123         , editor(0)
 124         , current_visible_sync_position(0.0)
 125         , valid(false)
 126         , _pixel_width(1.0)
 127         , _height(1.0)
 128         , in_destructor(false)
 129         , wait_for_data(false)
 130 {
 131 }
 132
 133 void
 134 RegionView::init (Gdk::Color& basic_color, bool wfd)
 135 {
 136         editor        = 0;
 137         valid         = true;
 138         in_destructor = false;
 139         _height       = 0;
 140         wait_for_data = wfd;
 141         sync_mark     = 0;
 142         sync_line     = 0;
 143
 144         compute_colors (basic_color);
 145
 146         if (name_highlight) {
 147                 name_highlight->set_data ("regionview", this);
 148                 name_highlight->signal_event().connect (bind (mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_name_highlight_event), name_highlight, this));
 149         }
 150
 151         if (name_text) {
 152                 name_text->set_data ("regionview", this);
 153         }
 154
 155         reset_width_dependent_items ((double) _region->length() / samples_per_unit);
 156
 157         set_height (trackview.current_height());
 158
 159         _region->StateChanged.connect (mem_fun(*this, &RegionView::region_changed));
 160
 161         group->signal_event().connect (bind (mem_fun (PublicEditor::instance(), &PublicEditor::canvas_region_view_event), group, this));
 162
 163         set_colors ();
 164
 165         ColorsChanged.connect (mem_fun (*this, &RegionView::color_handler));
 166         /* XXX sync mark drag? */
 167 }
 168
 169 RegionView::~RegionView ()
 170 {
 171         in_destructor = true;
 172
 173         for (vector<GhostRegion*>::iterator g = ghosts.begin(); g != ghosts.end(); ++g) {
 174                 delete *g;
 175         }
 176
 177         if (editor) {
 178                 delete editor;
 179         }
 180 }
 181
 182 gint
 183 RegionView::_lock_toggle (ArdourCanvas::Item* item, GdkEvent* ev, void* arg)
 184 {
 185         switch (ev->type) {
 186         case GDK_BUTTON_RELEASE:
 187                 static_cast<RegionView*>(arg)->lock_toggle ();
 188                 return TRUE;
 189                 break;
 190         default:
 191                 break;
 192         }
 193         return FALSE;
 194 }
 195
 196 void
 197 RegionView::lock_toggle ()
 198 {
 199         _region->set_locked (!_region->locked());
 200 }
 201
 202 void
 203 RegionView::region_changed (Change what_changed)
 204 {
 205         ENSURE_GUI_THREAD (bind (mem_fun(*this, &RegionView::region_changed), what_changed));
 206
 207         if (what_changed & BoundsChanged) {
 208                 region_resized (what_changed);
 209                 region_sync_changed ();
 210         }
 211         if (what_changed & Region::MuteChanged) {
 212                 region_muted ();
 213         }
 214         if (what_changed & Region::OpacityChanged) {
 215                 region_opacity ();
 216         }
 217         if (what_changed & ARDOUR::NameChanged) {
 218                 region_renamed ();
 219         }
 220         if (what_changed & Region::SyncOffsetChanged) {
 221                 region_sync_changed ();
 222         }
 223         if (what_changed & Region::LayerChanged) {
 224                 // this is handled by the playlist i believe
 225                 //region_layered ();
 226         }
 227         if (what_changed & Region::LockChanged) {
 228                 region_locked ();
 229         }
 230 }
 231
 232 void
 233 RegionView::region_locked ()
 234 {
 235         /* name will show locked status */
 236         region_renamed ();
 237 }
 238
 239 void
 240 RegionView::region_resized (Change what_changed)
 241 {
 242         double unit_length;
 243
 244         if (what_changed & ARDOUR::PositionChanged) {
 245                 set_position (_region->position(), 0);
 246         }
 247
 248         if (what_changed & Change (StartChanged|LengthChanged)) {
 249
 250                 set_duration (_region->length(), 0);
 251
 252                 unit_length = _region->length() / samples_per_unit;
 253
 254                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 255
 256                         (*i)->set_duration (unit_length);
 257
 258                 }
 259         }
 260 }
 261
 262 void
 263 RegionView::reset_width_dependent_items (double pixel_width)
 264 {
 265         TimeAxisViewItem::reset_width_dependent_items (pixel_width);
 266         _pixel_width = pixel_width;
 267 }
 268
 269 void
 270 RegionView::region_layered ()
 271 {
 272         RouteTimeAxisView *rtv = dynamic_cast<RouteTimeAxisView*>(&get_time_axis_view());
 273         assert(rtv);
 274         //rtv->view()->region_layered (this);
 275 }
 276
 277 void
 278 RegionView::region_muted ()
 279 {
 280         set_frame_color ();
 281         region_renamed ();
 282 }
 283
 284 void
 285 RegionView::region_opacity ()
 286 {
 287         set_frame_color ();
 288 }
 289
 290 void
 291 RegionView::raise ()
 292 {
 293         _region->raise ();
 294 }
 295
 296 void
 297 RegionView::raise_to_top ()
 298 {
 299         _region->raise_to_top ();
 300 }
 301
 302 void
 303 RegionView::lower ()
 304 {
 305         _region->lower ();
 306 }
 307
 308 void
 309 RegionView::lower_to_bottom ()
 310 {
 311         _region->lower_to_bottom ();
 312 }
 313
 314 bool
 315 RegionView::set_position (nframes_t pos, void* src, double* ignored)
 316 {
 317         double delta;
 318         bool ret;
 319
 320         if (!(ret = TimeAxisViewItem::set_position (pos, this, &delta))) {
 321                 return false;
 322         }
 323
 324         if (ignored) {
 325                 *ignored = delta;
 326         }
 327
 328         if (delta) {
 329                 for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 330                         (*i)->group->move (delta, 0.0);
 331                 }
 332         }
 333
 334         return ret;
 335 }
 336
 337 void
 338 RegionView::set_samples_per_unit (gdouble spu)
 339 {
 340         TimeAxisViewItem::set_samples_per_unit (spu);
 341
 342         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 343                 (*i)->set_samples_per_unit (spu);
 344                 (*i)->set_duration (_region->length() / samples_per_unit);
 345         }
 346
 347         region_sync_changed ();
 348 }
 349
 350 bool
 351 RegionView::set_duration (nframes_t frames, void *src)
 352 {
 353         if (!TimeAxisViewItem::set_duration (frames, src)) {
 354                 return false;
 355         }
 356
 357         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 358                 (*i)->set_duration (_region->length() / samples_per_unit);
 359         }
 360
 361         return true;
 362 }
 363
 364 void
 365 RegionView::compute_colors (Gdk::Color& basic_color)
 366 {
 367         TimeAxisViewItem::compute_colors (basic_color);
 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 = 0;
 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 = 0;
 400        }
 401
 402        set_frame_color ();
 403 }
 404
 405 void
 406 RegionView::hide_region_editor()
 407 {
 408         if (editor) {
 409                 editor->hide_all ();
 410         }
 411 }
 412
 413 void
 414 RegionView::region_renamed ()
 415 {
 416         string str;
 417
 418         if (_region->locked()) {
 419                 str += '>';
 420                 str += _region->name();
 421                 str += '<';
 422         } else {
 423                 str = _region->name();
 424         }
 425
 426         if (_region->speed_mismatch (trackview.session().frame_rate())) {
 427                 str = string ("*") + str;
 428         }
 429
 430         if (_region->muted()) {
 431                 str = string ("!") + str;
 432         }
 433
 434         set_item_name (str, this);
 435         set_name_text (str);
 436         reset_width_dependent_items (_pixel_width);
 437 }
 438
 439 void
 440 RegionView::region_sync_changed ()
 441 {
 442         int sync_dir;
 443         nframes_t sync_offset;
 444
 445         sync_offset = _region->sync_offset (sync_dir);
 446
 447         if (sync_offset == 0) {
 448                 /* no need for a sync mark */
 449                 if (sync_mark) {
 450                         sync_mark->hide();
 451                         sync_line->hide ();
 452                 }
 453                 return;
 454         }
 455
 456         if (!sync_mark) {
 457
 458                 /* points set below */
 459
 460                 sync_mark =  new ArdourCanvas::Polygon (*group);
 461                 sync_mark->property_fill_color_rgba() = fill_color;
 462
 463                 sync_line = new ArdourCanvas::Line (*group);
 464                 sync_line->property_fill_color_rgba() = fill_color;
 465                 sync_line->property_width_pixels() = 1;
 466         }
 467
 468         /* this has to handle both a genuine change of position, a change of samples_per_unit,
 469            and a change in the bounds of the _region->
 470          */
 471
 472         if (sync_offset == 0) {
 473
 474                 /* no sync mark - its the start of the region */
 475
 476                 sync_mark->hide();
 477                 sync_line->hide ();
 478
 479         } else {
 480
 481                 if ((sync_dir < 0) || ((sync_dir > 0) && (sync_offset > _region->length()))) {
 482
 483                         /* no sync mark - its out of the bounds of the region */
 484
 485                         sync_mark->hide();
 486                         sync_line->hide ();
 487
 488                 } else {
 489
 490                         /* lets do it */
 491
 492                         Points points;
 493
 494                         //points = sync_mark->property_points().get_value();
 495
 496                         double offset = sync_offset / samples_per_unit;
 497                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 498                         points.push_back (Gnome::Art::Point (offset + ((sync_mark_width-1)/2), 1));
 499                         points.push_back (Gnome::Art::Point (offset, sync_mark_width - 1));
 500                         points.push_back (Gnome::Art::Point (offset - ((sync_mark_width-1)/2), 1));
 501                         sync_mark->property_points().set_value (points);
 502                         sync_mark->show ();
 503
 504                         points.clear ();
 505                         points.push_back (Gnome::Art::Point (offset, 0));
 506                         points.push_back (Gnome::Art::Point (offset, _height - NAME_HIGHLIGHT_SIZE));
 507
 508                         sync_line->property_points().set_value (points);
 509                         sync_line->show ();
 510                 }
 511         }
 512 }
 513
 514 void
 515 RegionView::move (double x_delta, double y_delta)
 516 {
 517         if (_region->locked() || (x_delta == 0 && y_delta == 0)) {
 518                 return;
 519         }
 520
 521         get_canvas_group()->move (x_delta, y_delta);
 522
 523         /* note: ghosts never leave their tracks so y_delta for them is always zero */
 524
 525         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 526                 (*i)->group->move (x_delta, 0.0);
 527         }
 528 }
 529
 530 void
 531 RegionView::remove_ghost (GhostRegion* ghost)
 532 {
 533         if (in_destructor) {
 534                 return;
 535         }
 536
 537         for (vector<GhostRegion*>::iterator i = ghosts.begin(); i != ghosts.end(); ++i) {
 538                 if (*i == ghost) {
 539                         ghosts.erase (i);
 540                         break;
 541                 }
 542         }
 543 }
 544
 545 uint32_t
 546 RegionView::get_fill_color ()
 547 {
 548         return fill_color;
 549 }
 550
 551 void
 552 RegionView::set_height (double h)
 553 {
 554         if (sync_line) {
 555                 Points points;
 556                 int sync_dir;
 557                 nframes_t sync_offset;
 558                 sync_offset = _region->sync_offset (sync_dir);
 559                 double offset = sync_offset / samples_per_unit;
 560
 561                 points.push_back (Gnome::Art::Point (offset, 0));
 562                 points.push_back (Gnome::Art::Point (offset, h - NAME_HIGHLIGHT_SIZE));
 563                 sync_line->property_points().set_value (points);
 564         }
 565 }