src/wx/controls.cc

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