src/wx/timeline.cc

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