2 Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
22 #include "check_box.h"
23 #include "content_view.h"
25 #include "dcpomatic_button.h"
26 #include "film_viewer.h"
27 #include "playhead_to_frame_dialog.h"
28 #include "playhead_to_timecode_dialog.h"
29 #include "static_text.h"
31 #include "lib/content_factory.h"
32 #include "lib/cross.h"
33 #include "lib/dcp_content.h"
34 #include "lib/examine_content_job.h"
36 #include "lib/job_manager.h"
37 #include "lib/player_video.h"
41 #include <dcp/reel_picture_asset.h>
42 #include <dcp/warnings.h>
43 LIBDCP_DISABLE_WARNINGS
44 #include <wx/listctrl.h>
45 #include <wx/progdlg.h>
46 #include <wx/tglbtn.h>
48 LIBDCP_ENABLE_WARNINGS
52 using std::dynamic_pointer_cast;
56 using std::shared_ptr;
59 using boost::optional;
60 #if BOOST_VERSION >= 106100
61 using namespace boost::placeholders;
63 using namespace dcpomatic;
66 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
68 , _slider (new wxSlider(this, wxID_ANY, 0, 0, 4096))
70 , _slider_being_moved (false)
71 , _outline_content (0)
73 , _jump_to_selected (0)
74 , _rewind_button (new Button(this, wxT("|<")))
75 , _back_button (new Button(this, wxT("<")))
76 , _forward_button (new Button(this, wxT(">")))
77 , _frame_number (new StaticText(this, wxT("")))
78 , _timecode (new StaticText(this, wxT("")))
81 _v_sizer = new wxBoxSizer (wxVERTICAL);
84 auto view_options = new wxBoxSizer (wxHORIZONTAL);
85 if (editor_controls) {
86 _outline_content = new CheckBox (this, _("Outline content"));
87 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
88 _eye = new wxChoice (this, wxID_ANY);
89 _eye->Append (_("Left"));
90 _eye->Append (_("Right"));
91 _eye->SetSelection (0);
92 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
93 _jump_to_selected = new CheckBox (this, _("Jump to selected content"));
94 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
97 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
99 auto h_sizer = new wxBoxSizer (wxHORIZONTAL);
101 auto time_sizer = new wxBoxSizer (wxVERTICAL);
102 time_sizer->Add (_frame_number, 0, wxEXPAND);
103 time_sizer->Add (_timecode, 0, wxEXPAND);
105 h_sizer->Add (_rewind_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
106 h_sizer->Add (time_sizer, 0, wxEXPAND);
107 h_sizer->Add (_back_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
108 h_sizer->Add (_forward_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
110 _button_sizer = new wxBoxSizer (wxHORIZONTAL);
111 h_sizer->Add (_button_sizer, 0, wxEXPAND);
113 h_sizer->Add (_slider, 1, wxEXPAND);
115 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
118 _frame_number->SetMinSize (wxSize(100, -1));
119 _rewind_button->SetMinSize (wxSize(48, -1));
120 _back_button->SetMinSize (wxSize(48, -1));
121 _forward_button->SetMinSize (wxSize(48, -1));
123 _frame_number->SetMinSize (wxSize (84, -1));
124 _rewind_button->SetMinSize (wxSize (32, -1));
125 _back_button->SetMinSize (wxSize (32, -1));
126 _forward_button->SetMinSize (wxSize (32, -1));
130 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
132 if (_outline_content) {
133 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
136 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&Controls::slider_moved, this, false));
137 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&Controls::slider_moved, this, true));
138 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&Controls::slider_moved, this, true));
139 _slider->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&Controls::slider_released, this));
140 _rewind_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::rewind_clicked, this, _1));
141 _back_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::back_clicked, this, _1));
142 _forward_button->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::forward_clicked, this, _1));
143 _frame_number->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::frame_number_clicked, this));
144 _timecode->Bind (wxEVT_LEFT_DOWN, boost::bind(&Controls::timecode_clicked, this));
145 if (_jump_to_selected) {
146 _jump_to_selected->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::jump_to_selected_clicked, this));
147 _jump_to_selected->SetValue (Config::instance()->jump_to_selected ());
150 viewer->Started.connect (boost::bind(&Controls::started, this));
151 viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
153 Bind (wxEVT_TIMER, boost::bind(&Controls::update_position, this));
154 _timer.Start (80, wxTIMER_CONTINUOUS);
156 set_film (viewer->film());
158 setup_sensitivity ();
160 JobManager::instance()->ActiveJobsChanged.connect (
161 bind (&Controls::active_jobs_changed, this, _2)
164 _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
165 config_changed (Config::OTHER);
169 Controls::config_changed (int)
171 setup_sensitivity ();
178 setup_sensitivity ();
185 setup_sensitivity ();
190 Controls::update_position ()
192 auto viewer = _viewer.lock ();
197 if (!_slider_being_moved && !viewer->pending_idle_get()) {
198 update_position_label ();
199 update_position_slider ();
205 Controls::eye_changed ()
207 auto viewer = _viewer.lock ();
212 viewer->set_eyes (_eye->GetSelection() == 0 ? Eyes::LEFT : Eyes::RIGHT);
217 Controls::outline_content_changed ()
219 auto viewer = _viewer.lock ();
224 viewer->set_outline_content (_outline_content->GetValue());
228 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
230 Controls::slider_moved (bool page)
232 auto viewer = _viewer.lock ();
233 if (!_film || !viewer) {
237 if (!page && !_slider_being_moved) {
238 /* This is the first event of a drag; stop playback for the duration of the drag */
240 _slider_being_moved = true;
243 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
244 t = t.round (_film->video_frame_rate());
245 /* Ensure that we hit the end of the film at the end of the slider. In particular, we
246 need to do an accurate seek in case there isn't a keyframe near the end.
248 bool accurate = false;
249 if (t >= _film->length ()) {
250 t = _film->length() - viewer->one_video_frame();
253 viewer->seek (t, accurate);
254 update_position_label ();
259 Controls::slider_released ()
261 auto viewer = _viewer.lock ();
266 /* Restart after a drag */
268 _slider_being_moved = false;
273 Controls::update_position_slider ()
276 _slider->SetValue (0);
280 auto viewer = _viewer.lock ();
285 auto const len = _film->length ();
288 int const new_slider_position = 4096 * viewer->position().get() / len.get();
289 if (new_slider_position != _slider->GetValue()) {
290 _slider->SetValue (new_slider_position);
297 Controls::update_position_label ()
300 checked_set (_frame_number, wxT("0"));
301 checked_set (_timecode, wxT("0:0:0.0"));
305 auto viewer = _viewer.lock ();
310 double const fps = _film->video_frame_rate ();
311 /* Count frame number from 1 ... not sure if this is the best idea */
312 checked_set (_frame_number, wxString::Format (wxT("%ld"), lrint (viewer->position().seconds() * fps) + 1));
313 checked_set (_timecode, time_to_timecode (viewer->position(), fps));
318 Controls::active_jobs_changed (optional<string> j)
321 setup_sensitivity ();
326 Controls::nudge_amount (wxKeyboardState& ev)
328 auto viewer = _viewer.lock ();
333 auto amount = viewer->one_video_frame ();
335 if (ev.ShiftDown() && !ev.ControlDown()) {
336 amount = DCPTime::from_seconds (1);
337 } else if (!ev.ShiftDown() && ev.ControlDown()) {
338 amount = DCPTime::from_seconds (10);
339 } else if (ev.ShiftDown() && ev.ControlDown()) {
340 amount = DCPTime::from_seconds (60);
348 Controls::rewind_clicked (wxMouseEvent& ev)
350 auto viewer = _viewer.lock ();
352 viewer->seek (DCPTime(), true);
359 Controls::back_frame ()
361 auto viewer = _viewer.lock ();
363 viewer->seek_by (-viewer->one_video_frame(), true);
369 Controls::forward_frame ()
371 auto viewer = _viewer.lock ();
373 viewer->seek_by (viewer->one_video_frame(), true);
379 Controls::back_clicked (wxKeyboardState& ev)
381 auto viewer = _viewer.lock ();
383 viewer->seek_by (-nudge_amount(ev), true);
389 Controls::forward_clicked (wxKeyboardState& ev)
391 auto viewer = _viewer.lock ();
393 viewer->seek_by (nudge_amount(ev), true);
399 Controls::setup_sensitivity ()
401 /* examine content is the only job which stops the viewer working */
402 bool const active_job = _active_job && *_active_job != "examine_content";
403 bool const c = _film && !_film->content().empty() && !active_job;
406 _rewind_button->Enable (c);
407 _back_button->Enable (c);
408 _forward_button->Enable (c);
409 if (_outline_content) {
410 _outline_content->Enable (c);
412 _frame_number->Enable (c);
413 _timecode->Enable (c);
414 if (_jump_to_selected) {
415 _jump_to_selected->Enable (c);
419 _eye->Enable (c && _film->three_d ());
425 Controls::timecode_clicked ()
427 auto viewer = _viewer.lock ();
432 auto dialog = new PlayheadToTimecodeDialog (this, viewer->position(), _film->video_frame_rate());
433 if (dialog->ShowModal() == wxID_OK) {
434 viewer->seek (dialog->get(), true);
441 Controls::frame_number_clicked ()
443 auto viewer = _viewer.lock ();
448 auto dialog = new PlayheadToFrameDialog (this, viewer->position(), _film->video_frame_rate());
449 if (dialog->ShowModal() == wxID_OK) {
450 viewer->seek (dialog->get(), true);
457 Controls::jump_to_selected_clicked ()
459 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
464 Controls::set_film (shared_ptr<Film> film)
473 _film_change_connection = _film->Change.connect (boost::bind(&Controls::film_change, this, _1, _2));
476 setup_sensitivity ();
478 update_position_slider ();
479 update_position_label ();
484 Controls::film () const
491 Controls::film_change (ChangeType type, Film::Property p)
493 if (type == ChangeType::DONE) {
494 if (p == Film::Property::CONTENT) {
495 setup_sensitivity ();
496 update_position_label ();
497 update_position_slider ();
498 } else if (p == Film::Property::THREE_D) {
499 setup_sensitivity ();
506 Controls::seek (int slider)
508 _slider->SetValue (slider);
509 slider_moved (false);