src/wx/timeline.cc

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   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 "film_editor.h"
  21 #include "timeline.h"
  22 #include "timeline_time_axis_view.h"
  23 #include "timeline_reels_view.h"
  24 #include "timeline_labels_view.h"
  25 #include "timeline_video_content_view.h"
  26 #include "timeline_audio_content_view.h"
  27 #include "timeline_subtitle_content_view.h"
  28 #include "content_panel.h"
  29 #include "wx_util.h"
  30 #include "lib/film.h"
  31 #include "lib/playlist.h"
  32 #include "lib/image_content.h"
  33 #include "lib/timer.h"
  34 #include "lib/audio_content.h"
  35 #include "lib/subtitle_content.h"
  36 #include <wx/graphics.h>
  37 #include <boost/weak_ptr.hpp>
  38 #include <boost/foreach.hpp>
  39 #include <list>
  40 #include <iostream>
  41
  42 using std::list;
  43 using std::cout;
  44 using std::max;
  45 using boost::shared_ptr;
  46 using boost::weak_ptr;
  47 using boost::dynamic_pointer_cast;
  48 using boost::bind;
  49 using boost::optional;
  50
  51 Timeline::Timeline (wxWindow* parent, ContentPanel* cp, shared_ptr<Film> film)
  52         : wxPanel (parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxFULL_REPAINT_ON_RESIZE)
  53         , _content_panel (cp)
  54         , _film (film)
  55         , _time_axis_view (new TimelineTimeAxisView (*this, 64))
  56         , _reels_view (new TimelineReelsView (*this, 32))
  57         , _labels_view (new TimelineLabelsView (*this))
  58         , _tracks (0)
  59         , _left_down (false)
  60         , _down_view_position (0)
  61         , _first_move (false)
  62         , _menu (this)
  63         , _snap (true)
  64 {
  65 #ifndef __WXOSX__
  66         SetDoubleBuffered (true);
  67 #endif
  68
  69         Bind (wxEVT_PAINT,      boost::bind (&Timeline::paint,       this));
  70         Bind (wxEVT_LEFT_DOWN,  boost::bind (&Timeline::left_down,   this, _1));
  71         Bind (wxEVT_LEFT_UP,    boost::bind (&Timeline::left_up,     this, _1));
  72         Bind (wxEVT_RIGHT_DOWN, boost::bind (&Timeline::right_down,  this, _1));
  73         Bind (wxEVT_MOTION,     boost::bind (&Timeline::mouse_moved, this, _1));
  74         Bind (wxEVT_SIZE,       boost::bind (&Timeline::resized,     this));
  75
  76         film_changed (Film::CONTENT);
  77
  78         SetMinSize (wxSize (640, tracks() * track_height() + 96));
  79
  80         _tracks_position = Position<int> (_labels_view->bbox().width, 8);
  81
  82         _film_changed_connection = film->Changed.connect (bind (&Timeline::film_changed, this, _1));
  83         _film_content_changed_connection = film->ContentChanged.connect (bind (&Timeline::film_content_changed, this, _2, _3));
  84 }
  85
  86 void
  87 Timeline::paint ()
  88 {
  89         wxPaintDC dc (this);
  90
  91         wxGraphicsContext* gc = wxGraphicsContext::Create (dc);
  92         if (!gc) {
  93                 return;
  94         }
  95
  96         gc->SetAntialiasMode (wxANTIALIAS_DEFAULT);
  97
  98         BOOST_FOREACH (shared_ptr<TimelineView> i, _views) {
  99
 100                 shared_ptr<TimelineContentView> ic = dynamic_pointer_cast<TimelineContentView> (i);
 101
 102                 /* Find areas of overlap */
 103                 list<dcpomatic::Rect<int> > overlaps;
 104                 BOOST_FOREACH (shared_ptr<TimelineView> j, _views) {
 105                         shared_ptr<TimelineContentView> jc = dynamic_pointer_cast<TimelineContentView> (j);
 106                         /* No overlap with non-content views, views no different tracks, audio views or non-active views */
 107                         if (!ic || !jc || i == j || ic->track() != jc->track() || ic->track().get_value_or(2) >= 2 || !ic->active() || !jc->active()) {
 108                                 continue;
 109                         }
 110
 111                         optional<dcpomatic::Rect<int> > r = j->bbox().intersection (i->bbox());
 112                         if (r) {
 113                                 overlaps.push_back (r.get ());
 114                         }
 115                 }
 116
 117                 i->paint (gc, overlaps);
 118         }
 119
 120         delete gc;
 121 }
 122
 123 void
 124 Timeline::film_changed (Film::Property p)
 125 {
 126         if (p == Film::CONTENT || p == Film::REEL_TYPE || p == Film::REEL_LENGTH) {
 127                 ensure_ui_thread ();
 128                 recreate_views ();
 129         } else if (p == Film::CONTENT_ORDER) {
 130                 Refresh ();
 131         }
 132 }
 133
 134 void
 135 Timeline::recreate_views ()
 136 {
 137         shared_ptr<const Film> film = _film.lock ();
 138         if (!film) {
 139                 return;
 140         }
 141
 142         _views.clear ();
 143         _views.push_back (_time_axis_view);
 144         _views.push_back (_reels_view);
 145         _views.push_back (_labels_view);
 146
 147         BOOST_FOREACH (shared_ptr<Content> i, film->content ()) {
 148                 if (dynamic_pointer_cast<VideoContent> (i)) {
 149                         _views.push_back (shared_ptr<TimelineView> (new TimelineVideoContentView (*this, i)));
 150                 }
 151
 152                 shared_ptr<AudioContent> ac = dynamic_pointer_cast<AudioContent> (i);
 153                 if (ac && !ac->audio_mapping().mapped_output_channels().empty ()) {
 154                         _views.push_back (shared_ptr<TimelineView> (new TimelineAudioContentView (*this, i)));
 155                 }
 156
 157                 shared_ptr<SubtitleContent> sc = dynamic_pointer_cast<SubtitleContent> (i);
 158                 if (sc && sc->has_subtitles ()) {
 159                         _views.push_back (shared_ptr<TimelineView> (new TimelineSubtitleContentView (*this, sc)));
 160                 }
 161         }
 162
 163         assign_tracks ();
 164         setup_pixels_per_second ();
 165         Refresh ();
 166 }
 167
 168 void
 169 Timeline::film_content_changed (int property, bool frequent)
 170 {
 171         ensure_ui_thread ();
 172
 173         if (property == AudioContentProperty::AUDIO_STREAMS) {
 174                 recreate_views ();
 175         } else if (!frequent) {
 176                 setup_pixels_per_second ();
 177                 Refresh ();
 178         }
 179 }
 180
 181 void
 182 Timeline::assign_tracks ()
 183 {
 184         for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 185                 shared_ptr<TimelineContentView> c = dynamic_pointer_cast<TimelineContentView> (*i);
 186                 if (c) {
 187                         c->unset_track ();
 188                 }
 189         }
 190
 191         for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 192                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 193                 if (!cv) {
 194                         continue;
 195                 }
 196
 197                 if (dynamic_pointer_cast<TimelineVideoContentView> (*i)) {
 198                         /* Video on track 0 */
 199                         cv->set_track (0);
 200                         _tracks = max (_tracks, 1);
 201                         continue;
 202                 } else if (dynamic_pointer_cast<TimelineSubtitleContentView> (*i)) {
 203                         /* Subtitles on track 1 */
 204                         cv->set_track (1);
 205                         _tracks = max (_tracks, 2);
 206                         continue;
 207                 }
 208
 209                 /* Audio on tracks 2 and up */
 210                 int t = 2;
 211
 212                 shared_ptr<Content> content = cv->content();
 213                 DCPTimePeriod content_period (content->position(), content->end());
 214
 215                 while (true) {
 216                         TimelineViewList::iterator j = _views.begin();
 217                         while (j != _views.end()) {
 218                                 shared_ptr<TimelineAudioContentView> test = dynamic_pointer_cast<TimelineAudioContentView> (*j);
 219                                 if (!test) {
 220                                         ++j;
 221                                         continue;
 222                                 }
 223
 224                                 shared_ptr<Content> test_content = test->content();
 225
 226                                 if (test && test->track() && test->track().get() == t) {
 227                                         if (content_period.overlaps (DCPTimePeriod(test_content->position(), test_content->end()))) {
 228                                                 /* we have an overlap on track `t' */
 229                                                 ++t;
 230                                                 break;
 231                                         }
 232                                 }
 233
 234                                 ++j;
 235                         }
 236
 237                         if (j == _views.end ()) {
 238                                 /* no overlap on `t' */
 239                                 break;
 240                         }
 241                 }
 242
 243                 cv->set_track (t);
 244                 _tracks = max (_tracks, t + 1);
 245         }
 246
 247         _time_axis_view->set_y (tracks() * track_height() + 64);
 248         _reels_view->set_y (tracks() * track_height() + 32);
 249 }
 250
 251 int
 252 Timeline::tracks () const
 253 {
 254         return _tracks;
 255 }
 256
 257 void
 258 Timeline::setup_pixels_per_second ()
 259 {
 260         shared_ptr<const Film> film = _film.lock ();
 261         if (!film || film->length() == DCPTime ()) {
 262                 return;
 263         }
 264
 265         _pixels_per_second = static_cast<double>(width() - tracks_position().x * 2) / film->length().seconds ();
 266 }
 267
 268 shared_ptr<TimelineView>
 269 Timeline::event_to_view (wxMouseEvent& ev)
 270 {
 271         /* Search backwards through views so that we find the uppermost one first */
 272         TimelineViewList::reverse_iterator i = _views.rbegin();
 273         Position<int> const p (ev.GetX(), ev.GetY());
 274         while (i != _views.rend() && !(*i)->bbox().contains (p)) {
 275                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 276                 ++i;
 277         }
 278
 279         if (i == _views.rend ()) {
 280                 return shared_ptr<TimelineView> ();
 281         }
 282
 283         return *i;
 284 }
 285
 286 void
 287 Timeline::left_down (wxMouseEvent& ev)
 288 {
 289         shared_ptr<TimelineView> view = event_to_view (ev);
 290         shared_ptr<TimelineContentView> content_view = dynamic_pointer_cast<TimelineContentView> (view);
 291
 292         _down_view.reset ();
 293
 294         if (content_view) {
 295                 _down_view = content_view;
 296                 _down_view_position = content_view->content()->position ();
 297         }
 298
 299         for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 300                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 301                 if (!cv) {
 302                         continue;
 303                 }
 304
 305                 if (!ev.ShiftDown ()) {
 306                         cv->set_selected (view == *i);
 307                 }
 308         }
 309
 310         if (content_view && ev.ShiftDown ()) {
 311                 content_view->set_selected (!content_view->selected ());
 312         }
 313
 314         _left_down = true;
 315         _down_point = ev.GetPosition ();
 316         _first_move = false;
 317
 318         if (_down_view) {
 319                 /* Pre-compute the points that we might snap to */
 320                 for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 321                         shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 322                         if (!cv || cv == _down_view || cv->content() == _down_view->content()) {
 323                                 continue;
 324                         }
 325
 326                         _start_snaps.push_back (cv->content()->position());
 327                         _end_snaps.push_back (cv->content()->position());
 328                         _start_snaps.push_back (cv->content()->end());
 329                         _end_snaps.push_back (cv->content()->end());
 330
 331                         BOOST_FOREACH (DCPTime i, cv->content()->reel_split_points()) {
 332                                 _start_snaps.push_back (i);
 333                         }
 334                 }
 335
 336                 /* Tell everyone that things might change frequently during the drag */
 337                 _down_view->content()->set_change_signals_frequent (true);
 338         }
 339 }
 340
 341 void
 342 Timeline::left_up (wxMouseEvent& ev)
 343 {
 344         _left_down = false;
 345
 346         if (_down_view) {
 347                 _down_view->content()->set_change_signals_frequent (false);
 348                 _content_panel->set_selection (_down_view->content ());
 349         }
 350
 351         set_position_from_event (ev);
 352
 353         /* Clear up up the stuff we don't do during drag */
 354         assign_tracks ();
 355         setup_pixels_per_second ();
 356         Refresh ();
 357
 358         _start_snaps.clear ();
 359         _end_snaps.clear ();
 360 }
 361
 362 void
 363 Timeline::mouse_moved (wxMouseEvent& ev)
 364 {
 365         if (!_left_down) {
 366                 return;
 367         }
 368
 369         set_position_from_event (ev);
 370 }
 371
 372 void
 373 Timeline::right_down (wxMouseEvent& ev)
 374 {
 375         shared_ptr<TimelineView> view = event_to_view (ev);
 376         shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (view);
 377         if (!cv) {
 378                 return;
 379         }
 380
 381         if (!cv->selected ()) {
 382                 clear_selection ();
 383                 cv->set_selected (true);
 384         }
 385
 386         _menu.popup (_film, selected_content (), selected_views (), ev.GetPosition ());
 387 }
 388
 389 void
 390 Timeline::maybe_snap (DCPTime a, DCPTime b, optional<DCPTime>& nearest_distance) const
 391 {
 392         DCPTime const d = a - b;
 393         if (!nearest_distance || d.abs() < nearest_distance.get().abs()) {
 394                 nearest_distance = d;
 395         }
 396 }
 397
 398 void
 399 Timeline::set_position_from_event (wxMouseEvent& ev)
 400 {
 401         if (!_pixels_per_second) {
 402                 return;
 403         }
 404
 405         double const pps = _pixels_per_second.get ();
 406
 407         wxPoint const p = ev.GetPosition();
 408
 409         if (!_first_move) {
 410                 /* We haven't moved yet; in that case, we must move the mouse some reasonable distance
 411                    before the drag is considered to have started.
 412                 */
 413                 int const dist = sqrt (pow (p.x - _down_point.x, 2) + pow (p.y - _down_point.y, 2));
 414                 if (dist < 8) {
 415                         return;
 416                 }
 417                 _first_move = true;
 418         }
 419
 420         if (!_down_view) {
 421                 return;
 422         }
 423
 424         DCPTime new_position = _down_view_position + DCPTime::from_seconds ((p.x - _down_point.x) / pps);
 425
 426         if (_snap) {
 427
 428                 DCPTime const new_end = new_position + _down_view->content()->length_after_trim();
 429                 /* Signed `distance' to nearest thing (i.e. negative is left on the timeline,
 430                    positive is right).
 431                 */
 432                 optional<DCPTime> nearest_distance;
 433
 434                 /* Find the nearest snap point */
 435
 436                 BOOST_FOREACH (DCPTime i, _start_snaps) {
 437                         maybe_snap (i, new_position, nearest_distance);
 438                 }
 439
 440                 BOOST_FOREACH (DCPTime i, _end_snaps) {
 441                         maybe_snap (i, new_end, nearest_distance);
 442                 }
 443
 444                 if (nearest_distance) {
 445                         /* Snap if it's close; `close' means within a proportion of the time on the timeline */
 446                         if (nearest_distance.get().abs() < DCPTime::from_seconds ((width() / pps) / 64)) {
 447                                 new_position += nearest_distance.get ();
 448                         }
 449                 }
 450         }
 451
 452         if (new_position < DCPTime ()) {
 453                 new_position = DCPTime ();
 454         }
 455
 456         _down_view->content()->set_position (new_position);
 457
 458         shared_ptr<Film> film = _film.lock ();
 459         DCPOMATIC_ASSERT (film);
 460         film->set_sequence (false);
 461 }
 462
 463 void
 464 Timeline::force_redraw (dcpomatic::Rect<int> const & r)
 465 {
 466         RefreshRect (wxRect (r.x, r.y, r.width, r.height), false);
 467 }
 468
 469 shared_ptr<const Film>
 470 Timeline::film () const
 471 {
 472         return _film.lock ();
 473 }
 474
 475 void
 476 Timeline::resized ()
 477 {
 478         setup_pixels_per_second ();
 479 }
 480
 481 void
 482 Timeline::clear_selection ()
 483 {
 484         for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 485                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 486                 if (cv) {
 487                         cv->set_selected (false);
 488                 }
 489         }
 490 }
 491
 492 TimelineContentViewList
 493 Timeline::selected_views () const
 494 {
 495         TimelineContentViewList sel;
 496
 497         for (TimelineViewList::const_iterator i = _views.begin(); i != _views.end(); ++i) {
 498                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 499                 if (cv && cv->selected()) {
 500                         sel.push_back (cv);
 501                 }
 502         }
 503
 504         return sel;
 505 }
 506
 507 ContentList
 508 Timeline::selected_content () const
 509 {
 510         ContentList sel;
 511         TimelineContentViewList views = selected_views ();
 512
 513         for (TimelineContentViewList::const_iterator i = views.begin(); i != views.end(); ++i) {
 514                 sel.push_back ((*i)->content ());
 515         }
 516
 517         return sel;
 518 }
 519
 520 void
 521 Timeline::set_selection (ContentList selection)
 522 {
 523         for (TimelineViewList::iterator i = _views.begin(); i != _views.end(); ++i) {
 524                 shared_ptr<TimelineContentView> cv = dynamic_pointer_cast<TimelineContentView> (*i);
 525                 if (cv) {
 526                         cv->set_selected (find (selection.begin(), selection.end(), cv->content ()) != selection.end ());
 527                 }
 528         }
 529 }