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/>.
23 #include "film_viewer.h"
25 #include "playhead_to_timecode_dialog.h"
26 #include "playhead_to_frame_dialog.h"
27 #include "content_view.h"
28 #include "static_text.h"
29 #include "check_box.h"
30 #include "dcpomatic_button.h"
31 #include "lib/job_manager.h"
32 #include "lib/player_video.h"
33 #include "lib/dcp_content.h"
35 #include "lib/examine_content_job.h"
36 #include "lib/content_factory.h"
37 #include "lib/cross.h"
41 #include <dcp/reel_picture_asset.h>
43 #include <wx/tglbtn.h>
44 #include <wx/listctrl.h>
45 #include <wx/progdlg.h>
53 using boost::optional;
54 using std::shared_ptr;
56 using std::dynamic_pointer_cast;
57 #if BOOST_VERSION >= 106100
58 using namespace boost::placeholders;
60 using namespace dcpomatic;
63 Controls::Controls (wxWindow* parent, shared_ptr<FilmViewer> viewer, bool editor_controls)
65 , _slider (new wxSlider(this, wxID_ANY, 0, 0, 4096))
67 , _slider_being_moved (false)
68 , _outline_content (0)
70 , _jump_to_selected (0)
71 , _rewind_button (new Button(this, wxT("|<")))
72 , _back_button (new Button(this, wxT("<")))
73 , _forward_button (new Button(this, wxT(">")))
74 , _frame_number (new StaticText(this, wxT("")))
75 , _timecode (new StaticText(this, wxT("")))
78 _v_sizer = new wxBoxSizer (wxVERTICAL);
81 auto view_options = new wxBoxSizer (wxHORIZONTAL);
82 if (editor_controls) {
83 _outline_content = new CheckBox (this, _("Outline content"));
84 view_options->Add (_outline_content, 0, wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
85 _eye = new wxChoice (this, wxID_ANY);
86 _eye->Append (_("Left"));
87 _eye->Append (_("Right"));
88 _eye->SetSelection (0);
89 view_options->Add (_eye, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
90 _jump_to_selected = new CheckBox (this, _("Jump to selected content"));
91 view_options->Add (_jump_to_selected, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER_VERTICAL, DCPOMATIC_SIZER_GAP);
94 _v_sizer->Add (view_options, 0, wxALL, DCPOMATIC_SIZER_GAP);
96 auto h_sizer = new wxBoxSizer (wxHORIZONTAL);
98 auto time_sizer = new wxBoxSizer (wxVERTICAL);
99 time_sizer->Add (_frame_number, 0, wxEXPAND);
100 time_sizer->Add (_timecode, 0, wxEXPAND);
102 h_sizer->Add (_rewind_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
103 h_sizer->Add (time_sizer, 0, wxEXPAND);
104 h_sizer->Add (_back_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
105 h_sizer->Add (_forward_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 2);
107 _button_sizer = new wxBoxSizer (wxHORIZONTAL);
108 h_sizer->Add (_button_sizer, 0, wxEXPAND);
110 h_sizer->Add (_slider, 1, wxEXPAND);
112 _v_sizer->Add (h_sizer, 0, wxEXPAND | wxALL, 6);
115 _frame_number->SetMinSize (wxSize(100, -1));
116 _rewind_button->SetMinSize (wxSize(48, -1));
117 _back_button->SetMinSize (wxSize(48, -1));
118 _forward_button->SetMinSize (wxSize(48, -1));
120 _frame_number->SetMinSize (wxSize (84, -1));
121 _rewind_button->SetMinSize (wxSize (32, -1));
122 _back_button->SetMinSize (wxSize (32, -1));
123 _forward_button->SetMinSize (wxSize (32, -1));
127 _eye->Bind (wxEVT_CHOICE, boost::bind (&Controls::eye_changed, this));
129 if (_outline_content) {
130 _outline_content->Bind (wxEVT_CHECKBOX, boost::bind (&Controls::outline_content_changed, this));
133 _slider->Bind (wxEVT_SCROLL_THUMBTRACK, boost::bind(&Controls::slider_moved, this, false));
134 _slider->Bind (wxEVT_SCROLL_PAGEUP, boost::bind(&Controls::slider_moved, this, true));
135 _slider->Bind (wxEVT_SCROLL_PAGEDOWN, boost::bind(&Controls::slider_moved, this, true));
136 _slider->Bind (wxEVT_SCROLL_THUMBRELEASE, boost::bind(&Controls::slider_released, this));
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 ());
147 viewer->Started.connect (boost::bind(&Controls::started, this));
148 viewer->Stopped.connect (boost::bind(&Controls::stopped, this));
150 Bind (wxEVT_TIMER, boost::bind(&Controls::update_position, this));
151 _timer.Start (80, wxTIMER_CONTINUOUS);
153 set_film (viewer->film());
155 setup_sensitivity ();
157 JobManager::instance()->ActiveJobsChanged.connect (
158 bind (&Controls::active_jobs_changed, this, _2)
161 _config_changed_connection = Config::instance()->Changed.connect (bind(&Controls::config_changed, this, _1));
162 config_changed (Config::OTHER);
166 Controls::config_changed (int)
168 setup_sensitivity ();
175 setup_sensitivity ();
182 setup_sensitivity ();
187 Controls::update_position ()
189 auto viewer = _viewer.lock ();
194 if (!_slider_being_moved && !viewer->pending_idle_get()) {
195 update_position_label ();
196 update_position_slider ();
202 Controls::eye_changed ()
204 auto viewer = _viewer.lock ();
209 viewer->set_eyes (_eye->GetSelection() == 0 ? Eyes::LEFT : Eyes::RIGHT);
214 Controls::outline_content_changed ()
216 auto viewer = _viewer.lock ();
221 viewer->set_outline_content (_outline_content->GetValue());
225 /** @param page true if this was a PAGEUP/PAGEDOWN event for which we won't receive a THUMBRELEASE */
227 Controls::slider_moved (bool page)
229 auto viewer = _viewer.lock ();
230 if (!_film || !viewer) {
234 if (!page && !_slider_being_moved) {
235 /* This is the first event of a drag; stop playback for the duration of the drag */
237 _slider_being_moved = true;
240 DCPTime t (_slider->GetValue() * _film->length().get() / 4096);
241 t = t.round (_film->video_frame_rate());
242 /* Ensure that we hit the end of the film at the end of the slider. In particular, we
243 need to do an accurate seek in case there isn't a keyframe near the end.
245 bool accurate = false;
246 if (t >= _film->length ()) {
247 t = _film->length() - viewer->one_video_frame();
250 viewer->seek (t, accurate);
251 update_position_label ();
255 "playback-seeked %s", t.timecode(_film->video_frame_rate()).c_str()
262 Controls::slider_released ()
264 auto viewer = _viewer.lock ();
269 /* Restart after a drag */
271 _slider_being_moved = false;
276 Controls::update_position_slider ()
279 _slider->SetValue (0);
283 auto viewer = _viewer.lock ();
288 auto const len = _film->length ();
291 int const new_slider_position = 4096 * viewer->position().get() / len.get();
292 if (new_slider_position != _slider->GetValue()) {
293 _slider->SetValue (new_slider_position);
300 Controls::update_position_label ()
303 checked_set (_frame_number, wxT("0"));
304 checked_set (_timecode, wxT("0:0:0.0"));
308 auto viewer = _viewer.lock ();
313 double const fps = _film->video_frame_rate ();
314 /* Count frame number from 1 ... not sure if this is the best idea */
315 checked_set (_frame_number, wxString::Format (wxT("%ld"), lrint (viewer->position().seconds() * fps) + 1));
316 checked_set (_timecode, time_to_timecode (viewer->position(), fps));
321 Controls::active_jobs_changed (optional<string> j)
324 setup_sensitivity ();
329 Controls::nudge_amount (wxKeyboardState& ev)
331 auto viewer = _viewer.lock ();
336 auto amount = viewer->one_video_frame ();
338 if (ev.ShiftDown() && !ev.ControlDown()) {
339 amount = DCPTime::from_seconds (1);
340 } else if (!ev.ShiftDown() && ev.ControlDown()) {
341 amount = DCPTime::from_seconds (10);
342 } else if (ev.ShiftDown() && ev.ControlDown()) {
343 amount = DCPTime::from_seconds (60);
351 Controls::rewind_clicked (wxMouseEvent& ev)
353 auto viewer = _viewer.lock ();
355 viewer->seek (DCPTime(), true);
362 Controls::back_frame ()
364 auto viewer = _viewer.lock ();
366 viewer->seek_by (-viewer->one_video_frame(), true);
372 Controls::forward_frame ()
374 auto viewer = _viewer.lock ();
376 viewer->seek_by (viewer->one_video_frame(), true);
382 Controls::back_clicked (wxKeyboardState& ev)
384 auto viewer = _viewer.lock ();
386 viewer->seek_by (-nudge_amount(ev), true);
392 Controls::forward_clicked (wxKeyboardState& ev)
394 auto viewer = _viewer.lock ();
396 viewer->seek_by (nudge_amount(ev), true);
402 Controls::setup_sensitivity ()
404 /* examine content is the only job which stops the viewer working */
405 bool const active_job = _active_job && *_active_job != "examine_content";
406 bool const c = _film && !_film->content().empty() && !active_job;
409 _rewind_button->Enable (c);
410 _back_button->Enable (c);
411 _forward_button->Enable (c);
412 if (_outline_content) {
413 _outline_content->Enable (c);
415 _frame_number->Enable (c);
416 _timecode->Enable (c);
417 if (_jump_to_selected) {
418 _jump_to_selected->Enable (c);
422 _eye->Enable (c && _film->three_d ());
428 Controls::timecode_clicked ()
430 auto viewer = _viewer.lock ();
435 auto dialog = new PlayheadToTimecodeDialog (this, viewer->position(), _film->video_frame_rate());
436 if (dialog->ShowModal() == wxID_OK) {
437 viewer->seek (dialog->get(), true);
444 Controls::frame_number_clicked ()
446 auto viewer = _viewer.lock ();
451 auto dialog = new PlayheadToFrameDialog (this, viewer->position(), _film->video_frame_rate());
452 if (dialog->ShowModal() == wxID_OK) {
453 viewer->seek (dialog->get(), true);
460 Controls::jump_to_selected_clicked ()
462 Config::instance()->set_jump_to_selected (_jump_to_selected->GetValue ());
467 Controls::set_film (shared_ptr<Film> film)
476 _film_change_connection = _film->Change.connect (boost::bind(&Controls::film_change, this, _1, _2));
479 setup_sensitivity ();
481 update_position_slider ();
482 update_position_label ();
487 Controls::film () const
494 Controls::film_change (ChangeType type, Film::Property p)
496 if (type == ChangeType::DONE) {
497 if (p == Film::Property::CONTENT) {
498 setup_sensitivity ();
499 update_position_label ();
500 update_position_slider ();
501 } else if (p == Film::Property::THREE_D) {
502 setup_sensitivity ();
509 Controls::seek (int slider)
511 _slider->SetValue (slider);
512 slider_moved (false);