src/wx/controls.cc

   1 /*
   2     Copyright (C) 2018-2021 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
  22 #include "check_box.h"
  23 #include "content_view.h"
  24 #include "controls.h"
  25 #include "dcpomatic_button.h"
  26 #include "film_viewer.h"
  27 #include "markers_panel.h"
  28 #include "playhead_to_frame_dialog.h"
  29 #include "playhead_to_timecode_dialog.h"
  30 #include "static_text.h"
  31 #include "wx_util.h"
  32 #include "lib/content_factory.h"
  33 #include "lib/cross.h"
  34 #include "lib/dcp_content.h"
  35 #include "lib/examine_content_job.h"
  36 #include "lib/job.h"
  37 #include "lib/job_manager.h"
  38 #include "lib/player_video.h"
  39 #include "lib/scope_guard.h"
  40 #include <dcp/cpl.h>
  41 #include <dcp/dcp.h>
  42 #include <dcp/reel.h>
  43 #include <dcp/reel_picture_asset.h>
  44 #include <dcp/warnings.h>
  45 LIBDCP_DISABLE_WARNINGS
  46 #include <wx/listctrl.h>
  47 #include <wx/progdlg.h>
  48 #include <wx/tglbtn.h>
  49 #include <wx/wx.h>
  50 LIBDCP_ENABLE_WARNINGS
  51
  52
  53 using std::cout;
  54 using std::dynamic_pointer_cast;
  55 using std::exception;
  56 using std::list;
  57 using std::make_pair;
  58 using std::shared_ptr;
  59 using std::string;
  60 using std::weak_ptr;
  61 using boost::optional;
  62 #if BOOST_VERSION >= 106100
  63 using namespace boost::placeholders;
  64 #endif
  65 using namespace dcpomatic;
  66
  67
  68 Controls::Controls(wxWindow* parent, FilmViewer& viewer, bool editor_controls)
  69         : wxPanel (parent)
  70         , _markers (new MarkersPanel(this, viewer))
  71         , _slider (new wxSlider(this, wxID_ANY, 0, 0, 4096))
  72         , _viewer (viewer)
  73         , _rewind_button (new Button(this, wxT("|<")))
  74         , _back_button (new Button(this, wxT("<")))
  75         , _forward_button (new Button(this, wxT(">")))
  76         , _frame_number (new StaticText(this, wxT("")))
  77         , _timecode (new StaticText(this, wxT("")))
  78         , _timer (this)
  79 {
  80         _v_sizer = new wxBoxSizer (wxVERTICAL);
  81         SetSizer (_v_sizer);
  82
  83         auto view_options = new wxBoxSizer (wxHORIZONTAL);
  84         if (editor_controls) {
  85                 _outline_content = new CheckBox (this, _("Outline content"));
  86                 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
  87                 _eye = new wxChoice (this, wxID_ANY);
  88                 _eye->Append (_("Left"));
  89                 _eye->Append (_("Right"));
  90                 _eye->SetSelection (0);
  91                 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
  92                 _jump_to_selected = new CheckBox (this, _("Jump to selected content"));
  93                 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
  94         }
  95
  96         _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
  97
  98         auto h_sizer = new wxBoxSizer (wxHORIZONTAL);
  99
 100         auto time_sizer = new wxBoxSizer (wxVERTICAL);
 101         time_sizer->Add (_frame_number, 0, wxEXPAND);
 102         time_sizer->Add (_timecode, 0, wxEXPAND);
 103
 104         h_sizer->Add (_rewind_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
 105         h_sizer->Add (time_sizer, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
 106         h_sizer->Add (_back_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
 107         h_sizer->Add (_forward_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
 108
 109         _button_sizer = new wxBoxSizer (wxHORIZONTAL);
 110         h_sizer->Add (_button_sizer, 0, wxEXPAND);
 111
 112         {
 113                 auto box = new wxBoxSizer (wxVERTICAL);
 114                 box->Add (_markers, 0, wxEXPAND);
 115                 box->Add (_slider, 0, wxEXPAND);
 116                 h_sizer->Add (box, 1, wxEXPAND);
 117         }
 118
 119         _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
 120
 121 #ifdef __WXGTK3__
 122         _frame_number->SetMinSize (wxSize(100, -1));
 123         _rewind_button->SetMinSize (wxSize(48, -1));
 124         _back_button->SetMinSize (wxSize(48, -1));
 125         _forward_button->SetMinSize (wxSize(48, -1));
 126 #else
 127         _frame_number->SetMinSize (wxSize (84, -1));
 128         _rewind_button->SetMinSize (wxSize (32, -1));
 129         _back_button->SetMinSize (wxSize (32, -1));
 130         _forward_button->SetMinSize (wxSize (32, -1));
 131 #endif
 132
 133         if (_eye) {
 134                 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
 135         }
 136         if (_outline_content) {
 137                 _outline_content->bind(&Controls::outline_content_changed, this);
 138         }
 139
 140         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,    boost::bind(&Controls::slider_moved,    this, false));
 141         _slider->Bind           (wxEVT_SCROLL_PAGEUP,        boost::bind(&Controls::slider_moved,    this, true));
 142         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,      boost::bind(&Controls::slider_moved,    this, true));
 143         _slider->Bind           (wxEVT_SCROLL_THUMBRELEASE,  boost::bind(&Controls::slider_released, this));
 144         _rewind_button->Bind    (wxEVT_LEFT_DOWN,            boost::bind(&Controls::rewind_clicked,  this, _1));
 145         _back_button->Bind      (wxEVT_LEFT_DOWN,            boost::bind(&Controls::back_clicked,    this, _1));
 146         _forward_button->Bind   (wxEVT_LEFT_DOWN,            boost::bind(&Controls::forward_clicked, this, _1));
 147         _frame_number->Bind     (wxEVT_LEFT_DOWN,            boost::bind(&Controls::frame_number_clicked, this));
 148         _timecode->Bind         (wxEVT_LEFT_DOWN,            boost::bind(&Controls::timecode_clicked, this));
 149         if (_jump_to_selected) {
 150                 _jump_to_selected->bind(&Controls::jump_to_selected_clicked, this);
 151                 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
 152         }
 153
 154         viewer.Started.connect (boost::bind(&Controls::started, this));
 155         viewer.Stopped.connect (boost::bind(&Controls::stopped, this));
 156
 157         Bind (wxEVT_TIMER, boost::bind(&Controls::update_position, this));
 158         _timer.Start (80, wxTIMER_CONTINUOUS);
 159
 160         set_film(viewer.film());
 161
 162         setup_sensitivity ();
 163
 164         JobManager::instance()->ActiveJobsChanged.connect (
 165                 bind (&Controls::active_jobs_changed, this, _2)
 166                 );
 167
 168         _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
 169         config_changed (Config::OTHER);
 170 }
 171
 172 void
 173 Controls::config_changed (int)
 174 {
 175         setup_sensitivity ();
 176 }
 177
 178
 179 void
 180 Controls::started ()
 181 {
 182         setup_sensitivity ();
 183 }
 184
 185
 186 void
 187 Controls::stopped ()
 188 {
 189         setup_sensitivity ();
 190 }
 191
 192
 193 void
 194 Controls::update_position ()
 195 {
 196         if (!_slider_being_moved && !_viewer.pending_idle_get()) {
 197                 update_position_label ();
 198                 update_position_slider ();
 199         }
 200 }
 201
 202
 203 void
 204 Controls::eye_changed ()
 205 {
 206         _viewer.set_eyes(_eye->GetSelection() == 0 ? Eyes::LEFT : Eyes::RIGHT);
 207 }
 208
 209
 210 void
 211 Controls::outline_content_changed ()
 212 {
 213         _viewer.set_outline_content(_outline_content->GetValue());
 214 }
 215
 216
 217 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
 218 void
 219 Controls::slider_moved (bool page)
 220 {
 221         if (!_film) {
 222                 return;
 223         }
 224
 225         if (!page && !_slider_being_moved) {
 226                 /* This is the first event of a drag; stop playback for the duration of the drag */
 227                 _viewer.suspend();
 228                 _slider_being_moved = true;
 229         }
 230
 231         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 232         t = t.round (_film->video_frame_rate());
 233         /* Ensure that we hit the end of the film at the end of the slider.  In particular, we
 234            need to do an accurate seek in case there isn't a keyframe near the end.
 235         */
 236         bool accurate = false;
 237         if (t >= _film->length ()) {
 238                 t = _film->length() - _viewer.one_video_frame();
 239                 accurate = true;
 240         }
 241         _viewer.seek(t, accurate);
 242         update_position_label ();
 243 }
 244
 245
 246 void
 247 Controls::slider_released ()
 248 {
 249         /* Restart after a drag */
 250         _viewer.resume();
 251         _slider_being_moved = false;
 252 }
 253
 254
 255 void
 256 Controls::update_position_slider ()
 257 {
 258         if (!_film) {
 259                 _slider->SetValue (0);
 260                 return;
 261         }
 262
 263         auto const len = _film->length ();
 264
 265         if (len.get ()) {
 266                 int const new_slider_position = 4096 * _viewer.position().get() / len.get();
 267                 if (new_slider_position != _slider->GetValue()) {
 268                         _slider->SetValue (new_slider_position);
 269                 }
 270         }
 271 }
 272
 273
 274 void
 275 Controls::update_position_label ()
 276 {
 277         if (!_film) {
 278                 checked_set (_frame_number, wxT("0"));
 279                 checked_set (_timecode, wxT("0:0:0.0"));
 280                 return;
 281         }
 282
 283         double const fps = _film->video_frame_rate ();
 284         /* Count frame number from 1 ... not sure if this is the best idea */
 285         checked_set(_frame_number, wxString::Format (wxT("%ld"), lrint(_viewer.position().seconds() * fps) + 1));
 286         checked_set(_timecode, time_to_timecode(_viewer.position(), fps));
 287 }
 288
 289
 290 void
 291 Controls::active_jobs_changed (optional<string> j)
 292 {
 293         _active_job = j;
 294         setup_sensitivity ();
 295 }
 296
 297
 298 DCPTime
 299 Controls::nudge_amount (wxKeyboardState& ev)
 300 {
 301         auto amount = _viewer.one_video_frame();
 302
 303         if (ev.ShiftDown() && !ev.ControlDown()) {
 304                 amount = DCPTime::from_seconds (1);
 305         } else if (!ev.ShiftDown() && ev.ControlDown()) {
 306                 amount = DCPTime::from_seconds (10);
 307         } else if (ev.ShiftDown() && ev.ControlDown()) {
 308                 amount = DCPTime::from_seconds (60);
 309         }
 310
 311         return amount;
 312 }
 313
 314
 315 void
 316 Controls::rewind_clicked (wxMouseEvent& ev)
 317 {
 318         _viewer.seek(DCPTime(), true);
 319         ev.Skip();
 320 }
 321
 322
 323 void
 324 Controls::back_frame ()
 325 {
 326         _viewer.seek_by(-_viewer.one_video_frame(), true);
 327 }
 328
 329
 330 void
 331 Controls::forward_frame ()
 332 {
 333         _viewer.seek_by(_viewer.one_video_frame(), true);
 334 }
 335
 336
 337 void
 338 Controls::back_clicked (wxKeyboardState& ev)
 339 {
 340         _viewer.seek_by(-nudge_amount(ev), true);
 341 }
 342
 343
 344 void
 345 Controls::forward_clicked (wxKeyboardState& ev)
 346 {
 347         _viewer.seek_by(nudge_amount(ev), true);
 348 }
 349
 350
 351 void
 352 Controls::setup_sensitivity ()
 353 {
 354         /* examine content is the only job which stops the viewer working */
 355         bool const active_job = _active_job && *_active_job != "examine_content";
 356         bool const c = _film && !_film->content().empty() && !active_job;
 357
 358         _slider->Enable (c);
 359         _rewind_button->Enable (c);
 360         _back_button->Enable (c);
 361         _forward_button->Enable (c);
 362         if (_outline_content) {
 363                 _outline_content->Enable (c);
 364         }
 365         _frame_number->Enable (c);
 366         _timecode->Enable (c);
 367         if (_jump_to_selected) {
 368                 _jump_to_selected->Enable (c);
 369         }
 370
 371         if (_eye) {
 372                 _eye->Enable (c && _film->three_d ());
 373         }
 374 }
 375
 376
 377 void
 378 Controls::timecode_clicked ()
 379 {
 380         auto dialog = make_wx<PlayheadToTimecodeDialog>(this, _viewer.position(), _film->video_frame_rate());
 381
 382         if (dialog->ShowModal() == wxID_OK) {
 383                 _viewer.seek(dialog->get(), true);
 384         }
 385 }
 386
 387
 388 void
 389 Controls::frame_number_clicked ()
 390 {
 391         auto dialog = make_wx<PlayheadToFrameDialog>(this, _viewer.position(), _film->video_frame_rate());
 392
 393         if (dialog->ShowModal() == wxID_OK) {
 394                 _viewer.seek(dialog->get(), true);
 395         }
 396 }
 397
 398
 399 void
 400 Controls::jump_to_selected_clicked ()
 401 {
 402         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
 403 }
 404
 405
 406 void
 407 Controls::set_film (shared_ptr<Film> film)
 408 {
 409         if (_film == film) {
 410                 return;
 411         }
 412
 413         _film = film;
 414
 415         _markers->set_film (_film);
 416
 417         if (_film) {
 418                 _film_change_connection = _film->Change.connect (boost::bind(&Controls::film_change, this, _1, _2));
 419         }
 420
 421         setup_sensitivity ();
 422
 423         update_position_slider ();
 424         update_position_label ();
 425 }
 426
 427
 428 shared_ptr<Film>
 429 Controls::film () const
 430 {
 431         return _film;
 432 }
 433
 434
 435 void
 436 Controls::film_change (ChangeType type, Film::Property p)
 437 {
 438         if (type == ChangeType::DONE) {
 439                 if (p == Film::Property::CONTENT) {
 440                         setup_sensitivity ();
 441                         update_position_label ();
 442                         update_position_slider ();
 443                 } else if (p == Film::Property::THREE_D) {
 444                         setup_sensitivity ();
 445                 }
 446         }
 447 }
 448
 449
 450 void
 451 Controls::seek (int slider)
 452 {
 453         _slider->SetValue (slider);
 454         slider_moved (false);
 455         slider_released ();
 456 }