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         _frame_number->SetMinSize (wxSize (84, -1));
 108         _rewind_button->SetMinSize (wxSize (32, -1));
 109         _back_button->SetMinSize (wxSize (32, -1));
 110         _forward_button->SetMinSize (wxSize (32, -1));
 111
 112         if (_eye) {
 113                 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
 114         }
 115         if (_outline_content) {
 116                 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
 117         }
 118
 119         _slider->Bind           (wxEVT_SCROLL_THUMBTRACK,    boost::bind(&Controls::slider_moved,    this, false));
 120         _slider->Bind           (wxEVT_SCROLL_PAGEUP,        boost::bind(&Controls::slider_moved,    this, true));
 121         _slider->Bind           (wxEVT_SCROLL_PAGEDOWN,      boost::bind(&Controls::slider_moved,    this, true));
 122         _slider->Bind           (wxEVT_SCROLL_CHANGED,       boost::bind(&Controls::slider_released, this));
 123         _rewind_button->Bind    (wxEVT_LEFT_DOWN,            boost::bind(&Controls::rewind_clicked,  this, _1));
 124         _back_button->Bind      (wxEVT_LEFT_DOWN,            boost::bind(&Controls::back_clicked,    this, _1));
 125         _forward_button->Bind   (wxEVT_LEFT_DOWN,            boost::bind(&Controls::forward_clicked, this, _1));
 126         _frame_number->Bind     (wxEVT_LEFT_DOWN,            boost::bind(&Controls::frame_number_clicked, this));
 127         _timecode->Bind         (wxEVT_LEFT_DOWN,            boost::bind(&Controls::timecode_clicked, this));
 128         if (_jump_to_selected) {
 129                 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
 130                 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
 131         }
 132
 133         _viewer->PositionChanged.connect (boost::bind(&Controls::position_changed, this));
 134         _viewer->Started.connect (boost::bind(&Controls::started, this));
 135         _viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
 136
 137         set_film (_viewer->film());
 138
 139         setup_sensitivity ();
 140
 141         JobManager::instance()->ActiveJobsChanged.connect (
 142                 bind (&Controls::active_jobs_changed, this, _2)
 143                 );
 144
 145         _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
 146         config_changed (Config::OTHER);
 147 }
 148
 149 void
 150 Controls::config_changed (int)
 151 {
 152         setup_sensitivity ();
 153 }
 154
 155 void
 156 Controls::started ()
 157 {
 158         setup_sensitivity ();
 159 }
 160
 161 void
 162 Controls::stopped ()
 163 {
 164         setup_sensitivity ();
 165 }
 166
 167 void
 168 Controls::position_changed ()
 169 {
 170         if (!_slider_being_moved) {
 171                 update_position_label ();
 172                 update_position_slider ();
 173         }
 174 }
 175
 176 void
 177 Controls::eye_changed ()
 178 {
 179         _viewer->set_eyes (_eye->GetSelection() == 0 ? EYES_LEFT : EYES_RIGHT);
 180 }
 181
 182 void
 183 Controls::outline_content_changed ()
 184 {
 185         _viewer->set_outline_content (_outline_content->GetValue());
 186 }
 187
 188 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
 189 void
 190 Controls::slider_moved (bool page)
 191 {
 192         if (!_film) {
 193                 return;
 194         }
 195
 196         if (!page && !_slider_being_moved) {
 197                 /* This is the first event of a drag; stop playback for the duration of the drag */
 198                 _was_running_before_slider = _viewer->stop ();
 199                 _slider_being_moved = true;
 200         }
 201
 202         DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
 203         t = t.round (_film->video_frame_rate());
 204         /* Ensure that we hit the end of the film at the end of the slider */
 205         if (t >= _film->length ()) {
 206                 t = _film->length() - _viewer->one_video_frame();
 207         }
 208         _viewer->seek (t, false);
 209         update_position_label ();
 210 }
 211
 212 void
 213 Controls::slider_released ()
 214 {
 215         if (_was_running_before_slider) {
 216                 /* Restart after a drag */
 217                 _viewer->start ();
 218         }
 219         _slider_being_moved = false;
 220 }
 221
 222 void
 223 Controls::update_position_slider ()
 224 {
 225         if (!_film) {
 226                 _slider->SetValue (0);
 227                 return;
 228         }
 229
 230         DCPTime const len = _film->length ();
 231
 232         if (len.get ()) {
 233                 int const new_slider_position = 4096 * _viewer->position().get() / len.get();
 234                 if (new_slider_position != _slider->GetValue()) {
 235                         _slider->SetValue (new_slider_position);
 236                 }
 237         }
 238 }
 239
 240 void
 241 Controls::update_position_label ()
 242 {
 243         if (!_film) {
 244                 _frame_number->SetLabel ("0");
 245                 _timecode->SetLabel ("0:0:0.0");
 246                 return;
 247         }
 248
 249         double const fps = _film->video_frame_rate ();
 250         /* Count frame number from 1 ... not sure if this is the best idea */
 251         _frame_number->SetLabel (wxString::Format (wxT("%ld"), lrint (_viewer->position().seconds() * fps) + 1));
 252         _timecode->SetLabel (time_to_timecode (_viewer->position(), fps));
 253 }
 254
 255 void
 256 Controls::active_jobs_changed (optional<string> j)
 257 {
 258         _active_job = j;
 259         setup_sensitivity ();
 260 }
 261
 262 DCPTime
 263 Controls::nudge_amount (wxKeyboardState& ev)
 264 {
 265         DCPTime amount = _viewer->one_video_frame ();
 266
 267         if (ev.ShiftDown() && !ev.ControlDown()) {
 268                 amount = DCPTime::from_seconds (1);
 269         } else if (!ev.ShiftDown() && ev.ControlDown()) {
 270                 amount = DCPTime::from_seconds (10);
 271         } else if (ev.ShiftDown() && ev.ControlDown()) {
 272                 amount = DCPTime::from_seconds (60);
 273         }
 274
 275         return amount;
 276 }
 277
 278 void
 279 Controls::rewind_clicked (wxMouseEvent& ev)
 280 {
 281         _viewer->seek (DCPTime(), true);
 282         ev.Skip();
 283 }
 284
 285 void
 286 Controls::back_frame ()
 287 {
 288         _viewer->seek_by (-_viewer->one_video_frame(), true);
 289 }
 290
 291 void
 292 Controls::forward_frame ()
 293 {
 294         _viewer->seek_by (_viewer->one_video_frame(), true);
 295 }
 296
 297 void
 298 Controls::back_clicked (wxKeyboardState& ev)
 299 {
 300         _viewer->seek_by (-nudge_amount(ev), true);
 301 }
 302
 303 void
 304 Controls::forward_clicked (wxKeyboardState& ev)
 305 {
 306         _viewer->seek_by (nudge_amount(ev), true);
 307 }
 308
 309 void
 310 Controls::setup_sensitivity ()
 311 {
 312         /* examine content is the only job which stops the viewer working */
 313         bool const active_job = _active_job && *_active_job != "examine_content";
 314         bool const c = _film && !_film->content().empty() && !active_job;
 315
 316         _slider->Enable (c);
 317         _rewind_button->Enable (c);
 318         _back_button->Enable (c);
 319         _forward_button->Enable (c);
 320         if (_outline_content) {
 321                 _outline_content->Enable (c);
 322         }
 323         _frame_number->Enable (c);
 324         _timecode->Enable (c);
 325         if (_jump_to_selected) {
 326                 _jump_to_selected->Enable (c);
 327         }
 328
 329         if (_eye) {
 330                 _eye->Enable (c && _film->three_d ());
 331         }
 332 }
 333
 334 void
 335 Controls::timecode_clicked ()
 336 {
 337         PlayheadToTimecodeDialog* dialog = new PlayheadToTimecodeDialog (this, _film->video_frame_rate ());
 338         if (dialog->ShowModal() == wxID_OK) {
 339                 _viewer->seek (dialog->get(), true);
 340         }
 341         dialog->Destroy ();
 342 }
 343
 344 void
 345 Controls::frame_number_clicked ()
 346 {
 347         PlayheadToFrameDialog* dialog = new PlayheadToFrameDialog (this, _film->video_frame_rate ());
 348         if (dialog->ShowModal() == wxID_OK) {
 349                 _viewer->seek (dialog->get(), true);
 350         }
 351         dialog->Destroy ();
 352 }
 353
 354 void
 355 Controls::jump_to_selected_clicked ()
 356 {
 357         Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
 358 }
 359
 360 void
 361 Controls::set_film (shared_ptr<Film> film)
 362 {
 363         if (_film == film) {
 364                 return;
 365         }
 366
 367         _film = film;
 368         _film_change_connection = _film->Change.connect (boost::bind(&Controls::film_change, this, _1, _2));
 369
 370         setup_sensitivity ();
 371
 372         update_position_slider ();
 373         update_position_label ();
 374 }
 375
 376 shared_ptr<Film>
 377 Controls::film () const
 378 {
 379         return _film;
 380 }
 381
 382 void
 383 Controls::film_change (ChangeType type, Film::Property p)
 384 {
 385         if (type == CHANGE_TYPE_DONE && p == Film::CONTENT) {
 386                 setup_sensitivity ();
 387                 update_position_label ();
 388                 update_position_slider ();
 389         }
 390 }